Class MHO_CircularFieldRotationCorrection. More...

#include <MHO_CircularFieldRotationCorrection.hh>

Inheritance diagram for hops::MHO_CircularFieldRotationCorrection:

Public Member Functions
	MHO_CircularFieldRotationCorrection ()

virtual	~MHO_CircularFieldRotationCorrection ()

void	SetFourfitReferenceTimeVexString (std::string frt_vex_string)
	Setter for fourfit reference time vex string. More...

void	SetPolProductSet (std::vector< std::string > &pp_vec)
	Setter for pol product set. More...

void	SetReferenceMountType (std::string mt)
	Setter for reference station mount type {"no_mount", "cassegrain", "nasmythleft", or "nasmythright"}. More...

void	SetReferenceStationCoordinateData (station_coord_type *ref_data)
	Setter for reference station coordinate data. More...

void	SetRemoteMountType (std::string mt)
	Setter for remote station mount type {"no_mount", "cassegrain", "nasmythleft", or "nasmythright"}. More...

void	SetRemoteStationCoordinateData (station_coord_type *rem_data)
	Setter for remote station coordinate data. 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 a circular field rotation correction to visibility data in-place. More...

virtual bool	ExecuteOutOfPlace (const visibility_type in, visibility_type out) override
	Copies input visibility data and applies pre-multiplication, returning success. 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_CircularFieldRotationCorrection.

Author: J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du

Date: Wed Feb 7 23:58:10 2024 -0500

Constructor & Destructor Documentation

◆ MHO_CircularFieldRotationCorrection()

hops::MHO_CircularFieldRotationCorrection::MHO_CircularFieldRotationCorrection ( )

◆ ~MHO_CircularFieldRotationCorrection()

hops::MHO_CircularFieldRotationCorrection::~MHO_CircularFieldRotationCorrection ( )

virtual

Member Function Documentation

◆ ExecuteInPlace()

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

overrideprotectedvirtual

Applies a circular field rotation correction to visibility data in-place.

Parameters

in	Input visibility_type* data to be corrected.

Returns: bool indicating successful execution.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ ExecuteOutOfPlace()

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

overrideprotectedvirtual

Copies input visibility data and applies pre-multiplication, returning success.

Parameters

in	Const reference to input visibility_type data
out	Reference to output visibility_type data

Returns: Boolean indicating successful execution

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeInPlace()

bool hops::MHO_CircularFieldRotationCorrection::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_CircularFieldRotationCorrection::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 success (always true in current implementation).

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ SetFourfitReferenceTimeVexString()

void hops::MHO_CircularFieldRotationCorrection::SetFourfitReferenceTimeVexString ( std::string frt_vex_string )

inline

Setter for fourfit reference time vex string.

Parameters

frt_vex_string Input vex string representing reference time

◆ SetPolProductSet()

void hops::MHO_CircularFieldRotationCorrection::SetPolProductSet ( std::vector< std::string > & pp_vec )

inline

Setter for pol product set.

Parameters

pp_vec Reference to a vector of strings representing pol product set

◆ SetReferenceMountType()

void hops::MHO_CircularFieldRotationCorrection::SetReferenceMountType ( std::string mt )

inline

Setter for reference station mount type {"no_mount", "cassegrain", "nasmythleft", or "nasmythright"}.

Parameters

mt	reference mount type as string

◆ SetReferenceStationCoordinateData()

void hops::MHO_CircularFieldRotationCorrection::SetReferenceStationCoordinateData ( station_coord_type * ref_data )

inline

Setter for reference station coordinate data.

Parameters

ref_data Input pointer to station_coord_type structure

these data objects (station coords) are not yet used to the fullest extent, but they could be if we want to apply a time-dependant corrections to the pol-product pre-factors

◆ SetRemoteMountType()

void hops::MHO_CircularFieldRotationCorrection::SetRemoteMountType ( std::string mt )

inline

Setter for remote station mount type {"no_mount", "cassegrain", "nasmythleft", or "nasmythright"}.

Parameters

mt	remote mount type as string

◆ SetRemoteStationCoordinateData()

void hops::MHO_CircularFieldRotationCorrection::SetRemoteStationCoordinateData ( station_coord_type * rem_data )

inline

Setter for remote station coordinate data.

Parameters

rem_data Pointer to station_coord_type structure containing remote station coordinates

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

◆ ~MHO_CircularFieldRotationCorrection()

Member Function Documentation

◆ ExecuteInPlace()

◆ ExecuteOutOfPlace()

◆ InitializeInPlace()

◆ InitializeOutOfPlace()

◆ SetFourfitReferenceTimeVexString()

◆ SetPolProductSet()

◆ SetReferenceMountType()

◆ SetReferenceStationCoordinateData()

◆ SetRemoteMountType()

◆ SetRemoteStationCoordinateData()