HOPS
HOPS class reference
Public Member Functions | Protected Member Functions | List of all members
hops::MHO_SamplerLabeler< XArrayType > Class Template Reference

Class MHO_SamplerLabeler. More...

#include <MHO_SamplerLabeler.hh>

Inheritance diagram for hops::MHO_SamplerLabeler< XArrayType >:
[legend]

Public Member Functions

 MHO_SamplerLabeler ()
 
virtual ~MHO_SamplerLabeler ()
 
void SetReferenceStationSamplerChannelSets (const std::vector< std::string > &channel_sets)
 Setter for reference station sampler channel sets. More...
 
void SetRemoteStationSamplerChannelSets (const std::vector< std::string > &channel_sets)
 Setter for remote station sampler channel sets. More...
 
- Public Member Functions inherited from hops::MHO_UnaryOperator< XArrayType >
 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 ()
 
void SetArgs (const XArrayType *in, XArrayType *out)
 Setter for args. More...
 
void SetArgs (XArrayType *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...
 
double Priority () const
 Get the the priority field value. More...
 
void SetName (std::string name)
 Setter for operator name. More...
 
void SetPriority (double priority)
 Setter for operator priority (determines order of execution within a operator category) More...
 

Protected Member Functions

virtual bool ExecuteInPlace (XArrayType *in) override
 Function ExecuteInPlace - actual implementation, map channel label (e.g. 'a', 'b', etc.) to sampler index for both reference and remote stations, and attaches label to visibility data. More...
 
- Protected Member Functions inherited from hops::MHO_UnaryOperator< XArrayType >
virtual bool ExecuteOutOfPlace (const XArrayType *in, XArrayType *out)
 
virtual bool InitializeInPlace (XArrayType *)
 
virtual bool InitializeOutOfPlace (const XArrayType *, XArrayType *)
 

Additional Inherited Members

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

Detailed Description

template<typename XArrayType>
class hops::MHO_SamplerLabeler< XArrayType >

Class MHO_SamplerLabeler.

When the 'samplers' keyword is encountered, this operator loops over all channels and inserts a label for each channel which contains the sampler index associated with that channel. This can later be used to look up the station sampler delay (ambiguities) for this channel by the pcal operators e.g.: samplers 4 abcdefgh ijklmnop qrstuvwx yzABCDEF.

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Wed Dec 13 16:55:25 2023 -0500

Constructor & Destructor Documentation

◆ MHO_SamplerLabeler()

template<typename XArrayType >
hops::MHO_SamplerLabeler< XArrayType >::MHO_SamplerLabeler ( )
inline

◆ ~MHO_SamplerLabeler()

template<typename XArrayType >
virtual hops::MHO_SamplerLabeler< XArrayType >::~MHO_SamplerLabeler ( )
inlinevirtual

Member Function Documentation

◆ ExecuteInPlace()

template<typename XArrayType >
virtual bool hops::MHO_SamplerLabeler< XArrayType >::ExecuteInPlace ( XArrayType *  in)
inlineoverrideprotectedvirtual

Function ExecuteInPlace - actual implementation, map channel label (e.g. 'a', 'b', etc.) to sampler index for both reference and remote stations, and attaches label to visibility data.

Parameters
in(XArrayType*)
Returns
Return value (bool)
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< XArrayType >.

◆ SetReferenceStationSamplerChannelSets()

template<typename XArrayType >
void hops::MHO_SamplerLabeler< XArrayType >::SetReferenceStationSamplerChannelSets ( const std::vector< std::string > &  channel_sets)
inline

Setter for reference station sampler channel sets.

Parameters
channel_setsInput vector of string channel set names

◆ SetRemoteStationSamplerChannelSets()

template<typename XArrayType >
void hops::MHO_SamplerLabeler< XArrayType >::SetRemoteStationSamplerChannelSets ( const std::vector< std::string > &  channel_sets)
inline

Setter for remote station sampler channel sets.

Parameters
channel_setsInput vector of strings representing channel sets

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