hops::MHO_SingleSidebandNormFX Class Reference

Class MHO_SingleSidebandNormFX. More...

#include <MHO_SingleSidebandNormFX.hh>

Inheritance diagram for hops::MHO_SingleSidebandNormFX:

Public Member Functions
	MHO_SingleSidebandNormFX ()
virtual	~MHO_SingleSidebandNormFX ()
Public Member Functions inherited from hops::MHO_NormFX
	MHO_NormFX ()
virtual	~MHO_NormFX ()
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 Types
using	XArgType = visibility_type
Protected Types inherited from hops::MHO_NormFX
using	XArgType = visibility_type

Protected Member Functions
virtual bool	ExecuteInPlace (XArgType *in) override
	Executes in-place operation by temporarily using out-of-place execution and copying results back. More...
virtual bool	ExecuteOutOfPlace (const XArgType *in, XArgType *out) override
	Applies a series of operations including zero-padding, NaN filtering, FFT and cyclic rotation to input visibility data. More...
virtual bool	InitializeInPlace (XArgType *in) override
	Initializes in-place by initializing out-of-place and copying back. More...
virtual bool	InitializeOutOfPlace (const XArgType *in, XArgType *out) override
	Initializes out-of-place processing for Single Sideband (all channels USB or LSB) NormFX using input and output arguments. More...

Additional Inherited Members
Protected Attributes inherited from hops::MHO_NormFX
weight_type *	fWeights
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_SingleSidebandNormFX.

implements a subset of the functionality found in norm_fx.c, mainly the transform from frequency to delay space with a reduced zero padding factor (2x smaller than original implementation) since we only have a single sideband to worry about

Author

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

Date

Fri Jul 9 11:47:00 2021 -0400

Member Typedef Documentation

XArgType

using hops::MHO_SingleSidebandNormFX::XArgType = visibility_type

protected

Constructor & Destructor Documentation

MHO_SingleSidebandNormFX()

hops::MHO_SingleSidebandNormFX::MHO_SingleSidebandNormFX

(

)

~MHO_SingleSidebandNormFX()

hops::MHO_SingleSidebandNormFX::~MHO_SingleSidebandNormFX ( )

virtual

Member Function Documentation

ExecuteInPlace()

bool hops::MHO_SingleSidebandNormFX::ExecuteInPlace ( XArgType *  in )

overrideprotectedvirtual

Executes in-place operation by temporarily using out-of-place execution and copying results back.

Parameters

in	Input argument of type XArgType*

Returns

Status of the operation as a boolean value

Note

This is a virtual function.

Implements hops::MHO_NormFX.

ExecuteOutOfPlace()

bool hops::MHO_SingleSidebandNormFX::ExecuteOutOfPlace ( const XArgType *  in, XArgType *  out  )

overrideprotectedvirtual

Applies a series of operations including zero-padding, NaN filtering, FFT and cyclic rotation to input visibility data.

Parameters

in	Input visibility data
out	Output visibility data after processing

Returns

True if all operations succeed, false otherwise

Note

This is a virtual function.

Implements hops::MHO_NormFX.

InitializeInPlace()

bool hops::MHO_SingleSidebandNormFX::InitializeInPlace ( XArgType *  in )

overrideprotectedvirtual

Initializes in-place by initializing out-of-place and copying back.

Parameters

in	Input argument of type XArgType* to be initialized

Returns

Status of initialization operation as bool

Note

This is a virtual function.

Implements hops::MHO_NormFX.

InitializeOutOfPlace()

bool hops::MHO_SingleSidebandNormFX::InitializeOutOfPlace ( const XArgType *  in, XArgType *  out  )

overrideprotectedvirtual

Initializes out-of-place processing for Single Sideband (all channels USB or LSB) NormFX using input and output arguments.

Parameters

in	Const reference to input XArgType object
out	Reference to output XArgType object

Returns

Boolean indicating successful initialization

Note

This is a virtual function.

Implements hops::MHO_NormFX.

---

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

• MHO_SingleSidebandNormFX.hh
• MHO_SingleSidebandNormFX.cc