#include <MHO_MixedPolYShift.hh>

Inheritance diagram for hops::MHO_MixedPolYShift:

Public Member Functions
	MHO_MixedPolYShift ()

virtual	~MHO_MixedPolYShift ()

void	SetPhaseOffset (const double &offset)
	Setter for phase offset applied to Y pol. 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 phase offset for mixed polarization data in-place (to Y-pol). More...

virtual bool	ExecuteOutOfPlace (const visibility_type in, visibility_type out) override
	Copies input visibility data and executes in-place operation. More...

virtual bool	InitializeInPlace (visibility_type *in) override
	Initializes in-place for mixed polarization phase shift. More...

virtual bool	InitializeOutOfPlace (const visibility_type in, visibility_type out) override
	Initializes out-of-place operation for mixed polarization phase shift operation. 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_MixedPolYShift.

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

Date: Fri Oct 11 01:53:13 PM EDT 2024

Constructor & Destructor Documentation

◆ MHO_MixedPolYShift()

hops::MHO_MixedPolYShift::MHO_MixedPolYShift ( )

◆ ~MHO_MixedPolYShift()

hops::MHO_MixedPolYShift::~MHO_MixedPolYShift ( )

virtual

Member Function Documentation

◆ ExecuteInPlace()

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

overrideprotectedvirtual

Applies a phase offset for mixed polarization data in-place (to Y-pol).

Parameters

in	Input visibility_type object to apply phase offset.

Returns: True if successful, false if input is nullptr.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ ExecuteOutOfPlace()

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

overrideprotectedvirtual

Copies input visibility data and executes in-place operation.

Parameters

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

Returns: Boolean result of ExecuteInPlace operation on copied output data.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeInPlace()

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

overrideprotectedvirtual

Initializes in-place for mixed polarization phase shift.

Parameters

in	Input visibility_type pointer.

Returns: True if initialization is successful.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeOutOfPlace()

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

overrideprotectedvirtual

Initializes out-of-place operation for mixed polarization phase shift operation.

Parameters

in	Input visibility_type data pointer
out	Output visibility_type data pointer

Returns: True if initialization is successful

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ SetPhaseOffset()

void hops::MHO_MixedPolYShift::SetPhaseOffset ( const double & offset )

inline

Setter for phase offset applied to Y pol.

Parameters

offset the phase offset value

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

◆ ~MHO_MixedPolYShift()

Member Function Documentation

◆ ExecuteInPlace()

◆ ExecuteOutOfPlace()

◆ InitializeInPlace()

◆ InitializeOutOfPlace()

◆ SetPhaseOffset()