#include <MHO_MixedSidebandNormFX.hh>

Inheritance diagram for hops::MHO_MixedSidebandNormFX:

Public Member Functions
	MHO_MixedSidebandNormFX ()

virtual	~MHO_MixedSidebandNormFX ()

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 using ExecuteOutOfPlace and copies result back to input. More...

virtual bool	ExecuteOutOfPlace (const XArgType in, XArgType out) override
	Executes out-of-place processing for mixed sideband data. More...

virtual bool	InitializeInPlace (XArgType *in) override
	Initializes in-place data by copying from temporary out-of-place data. More...

virtual bool	InitializeOutOfPlace (const XArgType in, XArgType out) override
	Initializes out-of-place processing for mixed sideband data. 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_MixedSidebandNormFX.

implements a subset of the functionality found in norm_fx.c, mainly the transform from frequency to delay space – this implementation is closer to the original since it preserves the extra padding factor (8x), which is later followed by a factor of 2 sub-sampling. The original motivation for this extra computation appears to be lost.

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_MixedSidebandNormFX::XArgType = visibility_type

protected

Constructor & Destructor Documentation

◆ MHO_MixedSidebandNormFX()

hops::MHO_MixedSidebandNormFX::MHO_MixedSidebandNormFX ( )

◆ ~MHO_MixedSidebandNormFX()

hops::MHO_MixedSidebandNormFX::~MHO_MixedSidebandNormFX ( )

virtual

Member Function Documentation

◆ ExecuteInPlace()

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

overrideprotectedvirtual

Executes in-place operation using ExecuteOutOfPlace and copies result back to input.

Parameters

in	Input data of type XArgType*

Returns: Status of execution as bool

Note: This is a virtual function.

Implements hops::MHO_NormFX.

◆ ExecuteOutOfPlace()

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

overrideprotectedvirtual

Executes out-of-place processing for mixed sideband data.

Parameters

in	Input data buffer of type XArgType
out	Output data buffer of type XArgType

Returns: Boolean indicating success or failure of the operation.

Note: This is a virtual function.

Implements hops::MHO_NormFX.

◆ InitializeInPlace()

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

overrideprotectedvirtual

Initializes in-place data by copying from temporary out-of-place data.

Parameters

in	Input pointer to XArgType object.

Returns: Boolean indicating success of initialization.

Note: This is a virtual function.

Implements hops::MHO_NormFX.

◆ InitializeOutOfPlace()

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

overrideprotectedvirtual

Initializes out-of-place processing for mixed sideband data.

Parameters

in	Input data buffer
out	Output data buffer

Returns: True if initialization is successful, false otherwise

Note: This is a virtual function.

Implements hops::MHO_NormFX.

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

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ XArgType

Constructor & Destructor Documentation

◆ MHO_MixedSidebandNormFX()

◆ ~MHO_MixedSidebandNormFX()

Member Function Documentation

◆ ExecuteInPlace()

◆ ExecuteOutOfPlace()

◆ InitializeInPlace()

◆ InitializeOutOfPlace()