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

Class MHO_Passband. More...

#include <MHO_Passband.hh>

Inheritance diagram for hops::MHO_Passband:
[legend]

Public Member Functions

 MHO_Passband ()
 
virtual ~MHO_Passband ()
 
void SetPassband (double first, double second)
 Setter for passband. More...
 
void SetWeights (weight_type *weights)
 Setter for weights. 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 ()
 
void SetArgs (const visibility_type *in, visibility_type *out)
 Setter for args. More...
 
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...
 
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 (visibility_type *in) override
 Checks and excludes specific passbands within each channel of visibility data. More...
 
- Protected Member Functions inherited from hops::MHO_UnaryOperator< visibility_type >
virtual bool ExecuteOutOfPlace (const visibility_type *in, visibility_type *out)
 
virtual bool InitializeInPlace (visibility_type *)
 
virtual bool InitializeOutOfPlace (const visibility_type *, visibility_type *)
 

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_Passband.

Selects a chunk of frequency space for inclusion or removal.

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Tue Apr 2 09:41:24 AM EDT 2024

Constructor & Destructor Documentation

◆ MHO_Passband()

hops::MHO_Passband::MHO_Passband ( )

◆ ~MHO_Passband()

hops::MHO_Passband::~MHO_Passband ( )
virtual

Member Function Documentation

◆ ExecuteInPlace()

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

Checks and excludes specific passbands within each channel of visibility data.

Parameters
inInput visibility_type* containing channel axis.
Returns
bool indicating successful exclusion operation.
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ SetPassband()

void hops::MHO_Passband::SetPassband ( double  first,
double  second 
)
inline

Setter for passband.

Parameters
firstLower frequency limit in Hz
secondUpper frequency limit in Hz

if second < first then this operation is an 'exclusion' which tells us this is a chunk of spectrum to cut out, otherwise if first < second, then it is an inclusion, and everything outside will be cut (this is the legacy behavior)

◆ SetWeights()

void hops::MHO_Passband::SetWeights ( weight_type weights)
inline

Setter for weights.

Parameters
weightsInput weight values of type weight_type

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