Class MHO_MultitonePhaseCorrection. More...

#include <MHO_MultitonePhaseCorrection.hh>

Inheritance diagram for hops::MHO_MultitonePhaseCorrection:

Public Member Functions
	MHO_MultitonePhaseCorrection ()

virtual	~MHO_MultitonePhaseCorrection ()

void	SetMultitonePCData (multitone_pcal_type *pcal)
	Setter for multitone pcdata. More...

void	SetPCPeriod (std::size_t pc_period)
	Setter for phase cal averaging period. More...

void	SetStation (std::string station)
	Setter for station code. More...

void	SetStationMk4ID (std::string station_id)
	Setter for station mk4id. More...

void	SetWeights (weight_type *w)
	Setter for weights. 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 multi-tone phase calibration to visibility data in-place. 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 *) override
	Initializes visibility_type object in-place and checks if fPCData is nullptr. More...

virtual bool	InitializeOutOfPlace (const visibility_type , visibility_type ) override
	Initializes out-of-place visibility data (only if fPCData != nullptr). More...

void	InterpolatePCData (double pcal_minus_visib_toffset)
	Temporally interpolates phase calibration (Pcal) tone phasors. 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_MultitonePhaseCorrection.

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

hops::MHO_MultitonePhaseCorrection::MHO_MultitonePhaseCorrection ( )

◆ ~MHO_MultitonePhaseCorrection()

hops::MHO_MultitonePhaseCorrection::~MHO_MultitonePhaseCorrection ( )

virtual

Member Function Documentation

◆ ExecuteInPlace()

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

overrideprotectedvirtual

Applies multi-tone phase calibration to visibility data in-place.

Parameters

in	Input visibility_type pointer for processing.

Returns: True if execution was successful, false otherwise.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ ExecuteOutOfPlace()

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

overrideprotectedvirtual

Copies input visibility data and executes in-place correction.

Parameters

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

Returns: Result of ExecuteInPlace operation on the copied data.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeInPlace()

virtual bool hops::MHO_MultitonePhaseCorrection::InitializeInPlace ( visibility_type * )

inlineoverrideprotectedvirtual

Initializes visibility_type object in-place and checks if fPCData is nullptr.

Parameters

!in	Pointer to visibility_type object to initialize

Returns: True if initialization successful, false otherwise

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeOutOfPlace()

virtual bool hops::MHO_MultitonePhaseCorrection::InitializeOutOfPlace	(	const visibility_type *	,
		visibility_type *
	)

inlineoverrideprotectedvirtual

Initializes out-of-place visibility data (only if fPCData != nullptr).

Parameters

!in	Input pointer to const visibility_type
!out	Output pointer to visibility_type

Returns: True if initialization succeeds, false otherwise.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InterpolatePCData()

void hops::MHO_MultitonePhaseCorrection::InterpolatePCData ( double pcal_minus_visib_toffset )

protected

Temporally interpolates phase calibration (Pcal) tone phasors.

Parameters

pcal_minus_visib_toffset Time offset between the visibility data start and pcal data start

◆ SetMultitonePCData()

void hops::MHO_MultitonePhaseCorrection::SetMultitonePCData ( multitone_pcal_type * pcal )

Setter for multitone pcdata.

Parameters

pcal	Input pointer to multitone_pcal_type data

◆ SetPCPeriod()

void hops::MHO_MultitonePhaseCorrection::SetPCPeriod ( std::size_t pc_period )

inline

Setter for phase cal averaging period.

Parameters

pc_period the phase cal averaging period in (integer) APs

◆ SetStation()

void hops::MHO_MultitonePhaseCorrection::SetStation ( std::string station )

inline

Setter for station code.

Parameters

station Two-character station code

◆ SetStationMk4ID()

void hops::MHO_MultitonePhaseCorrection::SetStationMk4ID ( std::string station_id )

inline

Setter for station mk4id.

Parameters

station_id New Mk4ID to be set

◆ SetWeights()

void hops::MHO_MultitonePhaseCorrection::SetWeights ( weight_type * w )

inline

Setter for weights.

Parameters

w	Input pointer to weight_type array.

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

◆ ~MHO_MultitonePhaseCorrection()

Member Function Documentation

◆ ExecuteInPlace()

◆ ExecuteOutOfPlace()

◆ InitializeInPlace()

◆ InitializeOutOfPlace()

◆ InterpolatePCData()

◆ SetMultitonePCData()

◆ SetPCPeriod()

◆ SetStation()

◆ SetStationMk4ID()

◆ SetWeights()