hops::MHO_ManualPolDelayCorrection Class Reference

Class MHO_ManualPolDelayCorrection. More...

#include <MHO_ManualPolDelayCorrection.hh>

Inheritance diagram for hops::MHO_ManualPolDelayCorrection:

Public Member Functions
	MHO_ManualPolDelayCorrection ()
virtual	~MHO_ManualPolDelayCorrection ()
void	SetPCDelayOffset (const double &pc_delay_offset)
	Setter for pcdelay offset. More...
void	SetPolarization (const std::string &pol)
	Setter for polarization. More...
void	SetReferenceFrequency (double ref_freq)
	Setter for reference frequency. 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 delay offset and calculates phase correction factors for each channel. More...
virtual bool	ExecuteOutOfPlace (const visibility_type *in, visibility_type *out) override
	Copies input visibility data and executes in-place processing. 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_ManualPolDelayCorrection.

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

hops::MHO_ManualPolDelayCorrection::MHO_ManualPolDelayCorrection

(

)

~MHO_ManualPolDelayCorrection()

hops::MHO_ManualPolDelayCorrection::~MHO_ManualPolDelayCorrection ( )

virtual

Member Function Documentation

ExecuteInPlace()

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

overrideprotectedvirtual

Applies manual delay offset and calculates phase correction factors for each channel.

Parameters

in	Input visibility data of type visibility_type.

Returns

True if successful, false otherwise.

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

ExecuteOutOfPlace()

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

overrideprotectedvirtual

Copies input visibility data and executes in-place processing.

Parameters

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

Returns

Boolean result of ExecuteInPlace operation on copied output.

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

InitializeInPlace()

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

overrideprotectedvirtual

Initializes in-place visibility_type pointer.

Parameters

in	Pointer to visibility_type for initialization

Returns

True if successful

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

InitializeOutOfPlace()

bool hops::MHO_ManualPolDelayCorrection::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 successful initialization.

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

SetPCDelayOffset()

void hops::MHO_ManualPolDelayCorrection::SetPCDelayOffset ( const double &  pc_delay_offset )

inline

Setter for pcdelay offset.

Parameters

pc_delay_offset

Time offset to be applied to associated polarization

SetPolarization()

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

inline

Setter for polarization.

Parameters

pol	Input polarization string

SetReferenceFrequency()

void hops::MHO_ManualPolDelayCorrection::SetReferenceFrequency ( double  ref_freq )

inline

Setter for reference frequency.

Parameters

ref_freq

New reference frequency value in MHz

SetStationIdentifier()

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

inline

Setter for station identifier.

Parameters

station_id

mk4 id of type std::string

station_id is treated as follows: 1-char => mk4 id 2-char => 2char station code

---

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

• MHO_ManualPolDelayCorrection.hh
• MHO_ManualPolDelayCorrection.cc