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

Class MHO_LinearDParCorrection. More...

#include <MHO_LinearDParCorrection.hh>

Inheritance diagram for hops::MHO_LinearDParCorrection:
[legend]

Public Member Functions

 MHO_LinearDParCorrection ()
 
virtual ~MHO_LinearDParCorrection ()
 
void SetPolProductSet (std::vector< std::string > &pp_vec)
 Setter for pol product set. More...
 
void SetReferenceParallacticAngle (double p)
 Setter for reference station parallactic angle. More...
 
void SetRemoteParallacticAngle (double p)
 Setter for remote station parallactic angle. 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 ()
 
virtual void SetArgs (const visibility_type *in, visibility_type *out)
 Setter for args. More...
 
virtual 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...
 
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 (visibility_type *in) override
 Applies linear delta-parallactic angle correction to visibility data in-place. More...
 
virtual bool ExecuteOutOfPlace (const visibility_type *in, visibility_type *out) override
 Copies input visibility data and applies the pre-multiplication operation. More...
 
virtual bool InitializeInPlace (visibility_type *in) override
 Initializes in-place visibility_type pointer. More...
 
virtual bool InitializeOutOfPlace (const visibility_type *in, visibility_type *out) override
 Initializes out-of-place visibility data using input visibility_type pointer. More...
 

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

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Wed Feb 7 23:58:10 2024 -0500

Constructor & Destructor Documentation

◆ MHO_LinearDParCorrection()

hops::MHO_LinearDParCorrection::MHO_LinearDParCorrection ( )

◆ ~MHO_LinearDParCorrection()

hops::MHO_LinearDParCorrection::~MHO_LinearDParCorrection ( )
virtual

Member Function Documentation

◆ ExecuteInPlace()

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

Applies linear delta-parallactic angle correction to visibility data in-place.

Parameters
inInput visibility_type* data to be corrected.
Returns
True indicating successful application of correction.
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ ExecuteOutOfPlace()

bool hops::MHO_LinearDParCorrection::ExecuteOutOfPlace ( const visibility_type in,
visibility_type out 
)
overrideprotectedvirtual

Copies input visibility data and applies the pre-multiplication operation.

Parameters
inInput visibility_type data to be copied.
out(visibility_type*)
Returns
True indicating successful execution.
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeInPlace()

bool hops::MHO_LinearDParCorrection::InitializeInPlace ( visibility_type in)
overrideprotectedvirtual

Initializes in-place visibility_type pointer.

Parameters
inPointer to visibility_type object
Returns
True if initialization is successful
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeOutOfPlace()

bool hops::MHO_LinearDParCorrection::InitializeOutOfPlace ( const visibility_type in,
visibility_type out 
)
overrideprotectedvirtual

Initializes out-of-place visibility data using input visibility_type pointer.

Parameters
inConst pointer to input visibility_type data.
out(visibility_type*)
Returns
Boolean indicating success of initialization.
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ SetPolProductSet()

void hops::MHO_LinearDParCorrection::SetPolProductSet ( std::vector< std::string > &  pp_vec)
inline

Setter for pol product set.

Parameters
pp_vecReference to a vector of strings representing the pol product set

◆ SetReferenceParallacticAngle()

void hops::MHO_LinearDParCorrection::SetReferenceParallacticAngle ( double  p)
inline

Setter for reference station parallactic angle.

Parameters
preference station parallactic angle value in degrees

◆ SetRemoteParallacticAngle()

void hops::MHO_LinearDParCorrection::SetRemoteParallacticAngle ( double  p)
inline

Setter for remote station parallactic angle.

Parameters
pvalue for remote station parallactic angle in degrees

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