Class MHO_StationDelayCorrection. More...

#include <MHO_StationDelayCorrection.hh>

Inheritance diagram for hops::MHO_StationDelayCorrection:

Public Member Functions
	MHO_StationDelayCorrection ()

virtual	~MHO_StationDelayCorrection ()

void	SetPCDelayOffset (const double &pc_delay_offset)
	Setter for delay offset. 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 phase correction to visibility data for reference or remote station. 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 data. 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_StationDelayCorrection.

operator to apply a station delay to the visibilities

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

hops::MHO_StationDelayCorrection::MHO_StationDelayCorrection ( )

◆ ~MHO_StationDelayCorrection()

hops::MHO_StationDelayCorrection::~MHO_StationDelayCorrection ( )

virtual

Member Function Documentation

◆ ExecuteInPlace()

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

overrideprotectedvirtual

Applies phase correction to visibility data for reference or remote station.

Parameters

in	Input visibility_type* containing pol-products and channels.

Returns: bool indicating successful execution.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ ExecuteOutOfPlace()

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

overrideprotectedvirtual

Copies input visibility data and executes in-place correction.

Parameters

in	Input visibility_type data to be copied.
out	(visibility_type*)

Returns: Result of ExecuteInPlace operation on out parameter.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeInPlace()

bool hops::MHO_StationDelayCorrection::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_StationDelayCorrection::InitializeOutOfPlace	(	const visibility_type *	in,
		visibility_type *	out
	)

overrideprotectedvirtual

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

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_StationDelayCorrection::SetPCDelayOffset ( const double & pc_delay_offset )

inline

Setter for delay offset.

Parameters

pc_delay_offset Time offset between two signals being correlated

◆ SetReferenceFrequency()

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

inline

Setter for reference frequency.

Parameters

ref_freq New reference frequency value in MHz

◆ SetStationIdentifier()

void hops::MHO_StationDelayCorrection::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:

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MHO_StationDelayCorrection()

◆ ~MHO_StationDelayCorrection()

Member Function Documentation

◆ ExecuteInPlace()

◆ ExecuteOutOfPlace()

◆ InitializeInPlace()

◆ InitializeOutOfPlace()

◆ SetPCDelayOffset()

◆ SetReferenceFrequency()

◆ SetStationIdentifier()