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

Class MHO_PhaseCalibrationTrim. More...

#include <MHO_PhaseCalibrationTrim.hh>

Inheritance diagram for hops::MHO_PhaseCalibrationTrim:
[legend]

Public Member Functions

 MHO_PhaseCalibrationTrim ()
 
virtual ~MHO_PhaseCalibrationTrim ()
 
void SetVisibilities (const visibility_type *vis)
 Setter for visibilities. More...
 
- Public Member Functions inherited from hops::MHO_UnaryOperator< multitone_pcal_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 multitone_pcal_type *in, multitone_pcal_type *out)
 Setter for args. More...
 
virtual void SetArgs (multitone_pcal_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 (multitone_pcal_type *in) override
 Trims and aligns multitone phase calibration data in-place based on visibility data. More...
 
virtual bool ExecuteOutOfPlace (const multitone_pcal_type *in, multitone_pcal_type *out) override
 Copies input multitone_pcal_type and executes in-place trim. More...
 
virtual bool InitializeInPlace (multitone_pcal_type *in) override
 Trims down multitone_pcal_type data for phase calibration in-place. More...
 
virtual bool InitializeOutOfPlace (const multitone_pcal_type *in, multitone_pcal_type *out) override
 Initializes out-of-place phase calibration trim using input and output multitone_pcal_type. More...
 

Additional Inherited Members

- Protected Attributes inherited from hops::MHO_UnaryOperator< multitone_pcal_type >
bool fInPlace
 
std::tuple< multitone_pcal_type * > fInPlaceArgs
 
std::tuple< const multitone_pcal_type *, multitone_pcal_type * > fOutOfPlaceArgs
 

Detailed Description

Class MHO_PhaseCalibrationTrim.

Trims the time range of the pcal data to match that of the visibilities, very minimal implementation. Assumes that the p-cal and visibility data have the same accumulation period (this is true of most sane data) If they did not, then we would need to interpolate between p-cal points to match the visbility gridding (this is not done here)

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Thu Jan 27 10:36:00 2022 -0500

Constructor & Destructor Documentation

◆ MHO_PhaseCalibrationTrim()

hops::MHO_PhaseCalibrationTrim::MHO_PhaseCalibrationTrim ( )

◆ ~MHO_PhaseCalibrationTrim()

hops::MHO_PhaseCalibrationTrim::~MHO_PhaseCalibrationTrim ( )
virtual

Member Function Documentation

◆ ExecuteInPlace()

bool hops::MHO_PhaseCalibrationTrim::ExecuteInPlace ( multitone_pcal_type in)
overrideprotectedvirtual

Trims and aligns multitone phase calibration data in-place based on visibility data.

Parameters
inInput multitone_pcal_type* containing phase calibration data to be trimmed
Returns
bool indicating success or failure of the trimming operation
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< multitone_pcal_type >.

◆ ExecuteOutOfPlace()

bool hops::MHO_PhaseCalibrationTrim::ExecuteOutOfPlace ( const multitone_pcal_type in,
multitone_pcal_type out 
)
overrideprotectedvirtual

Copies input multitone_pcal_type and executes in-place trim.

Parameters
inInput multitone_pcal_type data to be copied
out(multitone_pcal_type*)
Returns
Result of ExecuteInPlace operation on copied data
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< multitone_pcal_type >.

◆ InitializeInPlace()

bool hops::MHO_PhaseCalibrationTrim::InitializeInPlace ( multitone_pcal_type in)
overrideprotectedvirtual

Trims down multitone_pcal_type data for phase calibration in-place.

Parameters
inInput pointer to multitone_pcal_type data.
Returns
True if trimming was successful.
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< multitone_pcal_type >.

◆ InitializeOutOfPlace()

bool hops::MHO_PhaseCalibrationTrim::InitializeOutOfPlace ( const multitone_pcal_type in,
multitone_pcal_type out 
)
overrideprotectedvirtual

Initializes out-of-place phase calibration trim using input and output multitone_pcal_type.

Parameters
inConst reference to input multitone_pcal_type
outReference to output multitone_pcal_type
Returns
Boolean indicating successful initialization
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< multitone_pcal_type >.

◆ SetVisibilities()

void hops::MHO_PhaseCalibrationTrim::SetVisibilities ( const visibility_type vis)
inline

Setter for visibilities.

Parameters
visInput const visibility_type* array containing visibilities

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