Class MHO_DoubleSidebandChannelLabeler. More...

#include <MHO_DoubleSidebandChannelLabeler.hh>

Inheritance diagram for hops::MHO_DoubleSidebandChannelLabeler< XArrayType >:

Public Member Functions
	MHO_DoubleSidebandChannelLabeler ()

virtual	~MHO_DoubleSidebandChannelLabeler ()

void	SetTolerance (double tol)
	Setter for tolerance - in (MHz) when checking if channels share a sky freq. More...

Public Member Functions inherited from hops::MHO_UnaryOperator< XArrayType >
	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 XArrayType in, XArrayType out)
	Setter for args. More...

virtual void	SetArgs (XArrayType *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 (XArrayType *in) override
	Function ExecuteInPlace labels LSB/USB channel pairs as "double sideband" channels if they share and edge. More...

virtual bool	ExecuteOutOfPlace (const XArrayType in, XArrayType out) override
	Copies input array to output and executes in-place operation on output. More...

virtual bool	InitializeInPlace (XArrayType *in) override
	Initializes XArrayType in-place and returns success. More...

virtual bool	InitializeOutOfPlace (const XArrayType , XArrayType ) override
	Initializes output array in-place from input array. More...

Additional Inherited Members
Protected Attributes inherited from hops::MHO_UnaryOperator< XArrayType >
bool	fInPlace

std::tuple< XArrayType * >	fInPlaceArgs

std::tuple< const XArrayType , XArrayType >	fOutOfPlaceArgs

Detailed Description

template<typename XArrayType>
class hops::MHO_DoubleSidebandChannelLabeler< XArrayType >

Class MHO_DoubleSidebandChannelLabeler.

Detects adjacent LSB/USB channels pairs which share the same sky-frequency and bandwidth. These are then marked as 'double-sideband' channels so they can recieve the legacy treatment.

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

Date: Thu Jun 1 13:20:19 2023 -0400

Constructor & Destructor Documentation

◆ MHO_DoubleSidebandChannelLabeler()

template<typename XArrayType >

hops::MHO_DoubleSidebandChannelLabeler< XArrayType >::MHO_DoubleSidebandChannelLabeler ( )

inline

◆ ~MHO_DoubleSidebandChannelLabeler()

template<typename XArrayType >

virtual hops::MHO_DoubleSidebandChannelLabeler< XArrayType >::~MHO_DoubleSidebandChannelLabeler ( )

inlinevirtual

Member Function Documentation

◆ ExecuteInPlace()

template<typename XArrayType >

virtual bool hops::MHO_DoubleSidebandChannelLabeler< XArrayType >::ExecuteInPlace ( XArrayType * in )

inlineoverrideprotectedvirtual

Function ExecuteInPlace labels LSB/USB channel pairs as "double sideband" channels if they share and edge.

Parameters

in	(XArrayType*)

Returns: Return value (bool)

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< XArrayType >.

◆ ExecuteOutOfPlace()

template<typename XArrayType >

virtual bool hops::MHO_DoubleSidebandChannelLabeler< XArrayType >::ExecuteOutOfPlace	(	const XArrayType *	in,
		XArrayType *	out
	)

inlineoverrideprotectedvirtual

Copies input array to output and executes in-place operation on output.

Parameters

in	Const reference to input XArrayType
out	Reference to output XArrayType

Returns: Result of ExecuteInPlace operation on out

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< XArrayType >.

◆ InitializeInPlace()

template<typename XArrayType >

virtual bool hops::MHO_DoubleSidebandChannelLabeler< XArrayType >::InitializeInPlace ( XArrayType * in )

inlineoverrideprotectedvirtual

Initializes XArrayType in-place and returns success.

Parameters

in	Pointer to XArrayType object to initialize.

Returns: True if initialization was successful, false otherwise.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< XArrayType >.

◆ InitializeOutOfPlace()

template<typename XArrayType >

virtual bool hops::MHO_DoubleSidebandChannelLabeler< XArrayType >::InitializeOutOfPlace	(	const XArrayType *	,
		XArrayType *
	)

inlineoverrideprotectedvirtual

Initializes output array in-place from input array.

Parameters

!in	Const reference to input XArrayType
!out	Reference to output XArrayType

Returns: Boolean indicating success of initialization

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< XArrayType >.

◆ SetTolerance()

template<typename XArrayType >

void hops::MHO_DoubleSidebandChannelLabeler< XArrayType >::SetTolerance ( double tol )

inline

Setter for tolerance - in (MHz) when checking if channels share a sky freq.

Parameters

tol	New tolerance value to use when checking if channels share a sky frequency.

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

MHO_DoubleSidebandChannelLabeler.hh

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<typename XArrayType> class hops::MHO_DoubleSidebandChannelLabeler< XArrayType >

Constructor & Destructor Documentation

◆ MHO_DoubleSidebandChannelLabeler()

◆ ~MHO_DoubleSidebandChannelLabeler()

Member Function Documentation

◆ ExecuteInPlace()

◆ ExecuteOutOfPlace()

◆ InitializeInPlace()

◆ InitializeOutOfPlace()

◆ SetTolerance()

template<typename XArrayType>
class hops::MHO_DoubleSidebandChannelLabeler< XArrayType >