hops::MHO_ManualPolPhaseCorrection Class Reference

Class MHO_ManualPolPhaseCorrection. More...

#include <MHO_ManualPolPhaseCorrection.hh>

Inheritance diagram for hops::MHO_ManualPolPhaseCorrection:

Public Member Functions
	MHO_ManualPolPhaseCorrection ()
virtual	~MHO_ManualPolPhaseCorrection ()
void	SetPCPhaseOffset (const double &pc_phase_offset)
	Setter for pc_phase offset. More...
void	SetPolarization (const std::string &pol)
	Setter for associated polarization. More...
void	SetStationIdentifier (std::string station_id)
	Setter for station identifier. 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 manual phase correction offsets to visibility data in-place for reference or remote stations. More...
virtual bool	ExecuteOutOfPlace (const visibility_type *in, visibility_type *out) override
	Copies input visibility data and executes in-place correction. 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 from input 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_ManualPolPhaseCorrection.

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_ManualPolPhaseCorrection()

hops::MHO_ManualPolPhaseCorrection::MHO_ManualPolPhaseCorrection

(

)

~MHO_ManualPolPhaseCorrection()

hops::MHO_ManualPolPhaseCorrection::~MHO_ManualPolPhaseCorrection ( )

virtual

Member Function Documentation

ExecuteInPlace()

bool hops::MHO_ManualPolPhaseCorrection::ExecuteInPlace ( visibility_type *  in )

overrideprotectedvirtual

Applies manual phase correction offsets to visibility data in-place for reference or remote stations.

Parameters

in	Input visibility_type* containing pol-products and channel labeled visibilities.

Returns

bool indicating successful execution.

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

ExecuteOutOfPlace()

bool hops::MHO_ManualPolPhaseCorrection::ExecuteOutOfPlace ( const visibility_type *  in, visibility_type *  out  )

overrideprotectedvirtual

Copies input visibility data and executes in-place correction.

Parameters

in	Const reference to input visibility_type data.
out	(visibility_type*)

Returns

Result of ExecuteInPlace operation on copied output data.

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

InitializeInPlace()

bool hops::MHO_ManualPolPhaseCorrection::InitializeInPlace ( visibility_type *  in )

overrideprotectedvirtual

Initializes in-place visibility_type pointer.

Parameters

in	Input visibility_type pointer to initialize

Returns

True if initialization is successful

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

InitializeOutOfPlace()

bool hops::MHO_ManualPolPhaseCorrection::InitializeOutOfPlace ( const visibility_type *  in, visibility_type *  out  )

overrideprotectedvirtual

Initializes out-of-place visibility data from input pointer.

Parameters

in	Const pointer to input visibility_type data
out	(visibility_type*)

Returns

Boolean indicating success (always true)

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

SetPCPhaseOffset()

void hops::MHO_ManualPolPhaseCorrection::SetPCPhaseOffset ( const double &  pc_phase_offset )

inline

Setter for pc_phase offset.

Parameters

pc_phase_offset

phase offset value applied to this polarization

SetPolarization()

void hops::MHO_ManualPolPhaseCorrection::SetPolarization ( const std::string &  pol )

inline

Setter for associated polarization.

Parameters

pol	Input polarization string

SetStationIdentifier()

void hops::MHO_ManualPolPhaseCorrection::SetStationIdentifier ( std::string  station_id )

inline

Setter for station identifier.

Parameters

station_id

Two-character MK4 station code as std::string

---

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

• MHO_ManualPolPhaseCorrection.hh
• MHO_ManualPolPhaseCorrection.cc