HOPS
HOPS class reference
Public Member Functions | Protected Member Functions | List of all members
hops::MHO_ManualChannelDelayCorrection Class Reference

Class MHO_ManualChannelDelayCorrection. More...

#include <MHO_ManualChannelDelayCorrection.hh>

Inheritance diagram for hops::MHO_ManualChannelDelayCorrection:
[legend]

Public Member Functions

 MHO_ManualChannelDelayCorrection ()
 
virtual ~MHO_ManualChannelDelayCorrection ()
 
void SetChannelToPCDelayMap (const std::map< std::string, double > &map)
 Setter for channel to pc_delay map. More...
 
void SetPolarization (const std::string &pol)
 Setter for polarization (associated with these delay corrections) More...
 
void SetStationIdentifier (std::string station_id)
 Setter for station identifier. More...
 
- Public Member Functions inherited from hops::MHO_UnaryOperator< visibility_type >
 MHO_UnaryOperator ()
 
virtual ~MHO_UnaryOperator ()
 
virtual bool Execute () override
 Executes operation using provided arguments and return type. More...
 
virtual bool Execute () override=0
 Function Execute. More...
 
virtual bool Initialize () override
 Initializes the system using in-place or out-of-place arguments. More...
 
virtual bool Initialize () override=0
 Function Initialize. More...
 
 MHO_Operator ()
 
virtual void SetArgs (const visibility_type *in, visibility_type *out)
 Setter for args. More...
 
virtual void SetArgs (visibility_type *in)
 Setter for args. More...
 
- Public Member Functions inherited from hops::MHO_Operator
 MHO_Operator ()
 
virtual ~MHO_Operator ()
 
std::string GetName () const
 Getter for operator name. More...
 
virtual double Priority () const
 Get the the priority field value. More...
 
void SetName (std::string name)
 Setter for operator name. More...
 
virtual void SetPriority (const double &priority)
 Setter for operator priority (determines order of execution within a operator category) More...
 

Protected Member Functions

virtual bool ExecuteInPlace (visibility_type *in) override
 Applies manual channel delay corrections in-place for reference or remote station. More...
 
virtual bool ExecuteOutOfPlace (const visibility_type *in, visibility_type *out) override
 Copies input visibility data and executes in-place correction. More...
 
virtual bool InitializeInPlace (visibility_type *in) override
 Initializes in-place visibility_type pointer. More...
 
virtual bool InitializeOutOfPlace (const visibility_type *in, visibility_type *out) override
 Initializes out-of-place visibility data from input data. More...
 

Additional Inherited Members

- Protected Attributes inherited from hops::MHO_UnaryOperator< visibility_type >
bool fInPlace
 
std::tuple< visibility_type * > fInPlaceArgs
 
std::tuple< const visibility_type *, visibility_type * > fOutOfPlaceArgs
 

Detailed Description

Class MHO_ManualChannelDelayCorrection.

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Thu Jan 27 10:36:00 2022 -0500

Constructor & Destructor Documentation

◆ MHO_ManualChannelDelayCorrection()

hops::MHO_ManualChannelDelayCorrection::MHO_ManualChannelDelayCorrection ( )

◆ ~MHO_ManualChannelDelayCorrection()

hops::MHO_ManualChannelDelayCorrection::~MHO_ManualChannelDelayCorrection ( )
virtual

Member Function Documentation

◆ ExecuteInPlace()

bool hops::MHO_ManualChannelDelayCorrection::ExecuteInPlace ( visibility_type in)
overrideprotectedvirtual

Applies manual channel delay corrections in-place for reference or remote station.

Parameters
inInput visibility data containing channel axes.
Returns
True if successful, false otherwise.
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ ExecuteOutOfPlace()

bool hops::MHO_ManualChannelDelayCorrection::ExecuteOutOfPlace ( const visibility_type in,
visibility_type out 
)
overrideprotectedvirtual

Copies input visibility data and executes in-place correction.

Parameters
inInput visibility_type data to be copied.
out(visibility_type*)
Returns
Result of ExecuteInPlace operation on out parameter.
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeInPlace()

bool hops::MHO_ManualChannelDelayCorrection::InitializeInPlace ( visibility_type in)
overrideprotectedvirtual

Initializes in-place visibility_type pointer.

Parameters
inInput visibility_type pointer to initialize
Returns
True if initialization succeeds
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeOutOfPlace()

bool hops::MHO_ManualChannelDelayCorrection::InitializeOutOfPlace ( const visibility_type in,
visibility_type out 
)
overrideprotectedvirtual

Initializes out-of-place visibility data from input data.

Parameters
inConst pointer to input visibility_type data.
out(visibility_type*)
Returns
Boolean indicating success (always true).
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ SetChannelToPCDelayMap()

void hops::MHO_ManualChannelDelayCorrection::SetChannelToPCDelayMap ( const std::map< std::string, double > &  map)
inline

Setter for channel to pc_delay map.

Parameters
mapInput map of channel labels and corresponding pc_delays

◆ SetPolarization()

void hops::MHO_ManualChannelDelayCorrection::SetPolarization ( const std::string &  pol)
inline

Setter for polarization (associated with these delay corrections)

Parameters
polInput polarization string

◆ SetStationIdentifier()

void hops::MHO_ManualChannelDelayCorrection::SetStationIdentifier ( std::string  station_id)
inline

Setter for station identifier.

Parameters
station_idmk4 id of type std::string

station_id is treated as follows: 1-char => mk4 id 2-char => 2char station code


The documentation for this class was generated from the following files: