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

Class MHO_DoubleSidebandChannelLabeler. More...

#include <MHO_DoubleSidebandChannelLabeler.hh>

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

Public Member Functions

 MHO_DoubleSidebandChannelLabeler ()
 
virtual ~MHO_DoubleSidebandChannelLabeler ()
 
void SetTolerance (double tol)
 Setter for tolerance - in (MHz) when checking if channels share a sky freq. 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 labels LSB/USB channel pairs as "double sideband" channels if they share and edge. 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_DoubleSidebandChannelLabeler< XArrayType >

Class MHO_DoubleSidebandChannelLabeler.

Detects adjacent LSB/USB channels pairs which share the same sky-frequency and bandwidth. These are then marked as 'double-sideband' channels so they can recieve the legacy treatment.

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Thu Jun 1 13:20:19 2023 -0400

Constructor & Destructor Documentation

◆ MHO_DoubleSidebandChannelLabeler()

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

◆ ~MHO_DoubleSidebandChannelLabeler()

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

Member Function Documentation

◆ ExecuteInPlace()

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

Function ExecuteInPlace labels LSB/USB channel pairs as "double sideband" channels if they share and edge.

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

Implements hops::MHO_UnaryOperator< XArrayType >.

◆ SetTolerance()

template<typename XArrayType >
void hops::MHO_DoubleSidebandChannelLabeler< XArrayType >::SetTolerance ( double  tol)
inline

Setter for tolerance - in (MHz) when checking if channels share a sky freq.

Parameters
tolNew tolerance value to use when checking if channels share a sky frequency.

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