Class MHO_SamplerLabeler. More...
#include <MHO_SamplerLabeler.hh>
Inheritance diagram for hops::MHO_SamplerLabeler< XArrayType >:
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 () | |
| virtual void | SetArgs (const XArrayType *in, XArrayType *out) |
| Setter for args. More... | |
| virtual 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... | |
| 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 (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... | |
| virtual bool | ExecuteOutOfPlace (const XArrayType *in, XArrayType *out) override |
| Copies input array and executes in-place operation on output. More... | |
| virtual bool | InitializeInPlace (XArrayType *in) override |
| Initializes in-place mapping for channel labels to sampler indices. More... | |
| virtual bool | InitializeOutOfPlace (const XArrayType *, XArrayType *) override |
| Initializes output array in-place from input array. More... | |
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.
- Date
- Wed Dec 13 16:55:25 2023 -0500
Constructor & Destructor Documentation
◆ MHO_SamplerLabeler()
template<typename XArrayType >
|
inline |
◆ ~MHO_SamplerLabeler()
template<typename XArrayType >
|
inlinevirtual |
Member Function Documentation
◆ ExecuteInPlace()
template<typename XArrayType >
|
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 >.
◆ ExecuteOutOfPlace()
template<typename XArrayType >
|
inlineoverrideprotectedvirtual |
Copies input array and executes in-place operation on output.
- Parameters
-
in Const reference to input XArrayType out Reference to output XArrayType
- Returns
- Result of ExecuteInPlace operation on out
- Note
- This is a virtual function.
Implements hops::MHO_UnaryOperator< XArrayType >.
◆ InitializeInPlace()
template<typename XArrayType >
|
inlineoverrideprotectedvirtual |
Initializes in-place mapping for channel labels to sampler indices.
- Parameters
-
in Input XArrayType pointer for initializing in-place.
- Returns
- True if initialization is successful, false otherwise.
- Note
- This is a virtual function.
Implements hops::MHO_UnaryOperator< XArrayType >.
◆ InitializeOutOfPlace()
template<typename XArrayType >
|
inlineoverrideprotectedvirtual |
Initializes output array in-place from input array.
- Parameters
-
!in Const reference to input XArrayType !out Reference to output XArrayType
- Returns
- Boolean indicating success of initialization
- Note
- This is a virtual function.
Implements hops::MHO_UnaryOperator< XArrayType >.
◆ SetReferenceStationSamplerChannelSets()
template<typename XArrayType >
|
inline |
Setter for reference station sampler channel sets.
- Parameters
-
channel_sets Input vector of string channel set names
◆ SetRemoteStationSamplerChannelSets()
template<typename XArrayType >
|
inline |
Setter for remote station sampler channel sets.
- Parameters
-
channel_sets Input vector of strings representing channel sets
The documentation for this class was generated from the following file:
