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

Class MHO_PolarizationRelabeler. More...

#include <MHO_PolarizationRelabeler.hh>

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

Public Member Functions

 MHO_PolarizationRelabeler ()
 
virtual ~MHO_PolarizationRelabeler ()
 
std::string GetStationIdentifier () const
 
void SetPolarizationSwapPair (std::string pol1, std::string pol2)
 
void SetStationIdentifier (const std::string &id)
 Setter for station identifier. More...
 
void SetStationIdentifiers (const std::vector< std::string > &ids)
 
- 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 - attaches channel labels based on sky frequency or user specified map. 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_PolarizationRelabeler< XArrayType >

Class MHO_PolarizationRelabeler.

Changes the polarization labels of a station (X -> Y) or (R -> L), as applied to pcal data.

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Fri Feb 20 12:24:39 PM EST 2026

Constructor & Destructor Documentation

◆ MHO_PolarizationRelabeler()

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

◆ ~MHO_PolarizationRelabeler()

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

Member Function Documentation

◆ ExecuteInPlace()

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

Function ExecuteInPlace - attaches channel labels based on sky frequency or user specified map.

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

Implements hops::MHO_UnaryOperator< XArrayType >.

◆ GetStationIdentifier()

template<typename XArrayType >
std::string hops::MHO_PolarizationRelabeler< XArrayType >::GetStationIdentifier ( ) const
inline

◆ SetPolarizationSwapPair()

template<typename XArrayType >
void hops::MHO_PolarizationRelabeler< XArrayType >::SetPolarizationSwapPair ( std::string  pol1,
std::string  pol2 
)
inline

◆ SetStationIdentifier()

template<typename XArrayType >
void hops::MHO_PolarizationRelabeler< XArrayType >::SetStationIdentifier ( const std::string &  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

◆ SetStationIdentifiers()

template<typename XArrayType >
void hops::MHO_PolarizationRelabeler< XArrayType >::SetStationIdentifiers ( const std::vector< std::string > &  ids)
inline

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