hops::MHO_DelayRate Class Reference

Class MHO_DelayRate. More...

#include <MHO_DelayRate.hh>

Inheritance diagram for hops::MHO_DelayRate:

Public Member Functions
	MHO_DelayRate ()
virtual	~MHO_DelayRate ()
unsigned int	CalculateSearchSpaceSize (unsigned int input_size)
	Calculates the search space size based on input size. More...
int	GetDelayRateSearchSpaceSize () const
	Getter for delay rate search space size. More...
void	SetReferenceFrequency (double ref_freq)
	Setter for reference frequency. More...
Public Member Functions inherited from hops::MHO_BinaryOperator< visibility_type, weight_type, sbd_type >
	MHO_BinaryOperator ()
virtual	~MHO_BinaryOperator ()
virtual bool	Execute () override
	Executes operation using provided arguments and returns result. More...
virtual bool	Initialize () override
	Initializes the object using arguments from fArgs tuple. More...
virtual void	SetArgs (const visibility_type *in1, const weight_type *in2, sbd_type *out)
	Setter for args, out-of-place operation, in1/in2 unmodified, result stored in out. 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	XArgType1 = visibility_type
using	XArgType2 = weight_type
using	XArgType3 = sbd_type

Protected Member Functions
virtual bool	ExecuteImpl (const XArgType1 *in1, const XArgType2 *in2, XArgType3 *out) override
	Executes MHO_DelayRate operations: zero padding, FFT, cyclic rotation, and interpolation. More...
virtual bool	InitializeImpl (const XArgType1 *in1, const XArgType2 *in2, XArgType3 *out) override
	Initializes MHO_DelayRate with input data and prepares for delay rate calculation. More...

Additional Inherited Members
Protected Attributes inherited from hops::MHO_BinaryOperator< visibility_type, weight_type, sbd_type >
std::tuple< const visibility_type *, const weight_type *, sbd_type * >	fArgs

Detailed Description

Class MHO_DelayRate.

implements the delay rate search

Author

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

Date

Fri Feb 3 15:13:40 2023 -0500

Member Typedef Documentation

XArgType1

using hops::MHO_DelayRate::XArgType1 = visibility_type

protected

XArgType2

using hops::MHO_DelayRate::XArgType2 = weight_type

protected

XArgType3

using hops::MHO_DelayRate::XArgType3 = sbd_type

protected

Constructor & Destructor Documentation

MHO_DelayRate()

hops::MHO_DelayRate::MHO_DelayRate

(

)

~MHO_DelayRate()

hops::MHO_DelayRate::~MHO_DelayRate ( )

virtual

Member Function Documentation

CalculateSearchSpaceSize()

unsigned int hops::MHO_DelayRate::CalculateSearchSpaceSize

(

unsigned int

input_size

)

Calculates the search space size based on input size.

Parameters

input_size

Input size for which to calculate the search space

Returns

Calculated search space size as an unsigned integer

ExecuteImpl()

bool hops::MHO_DelayRate::ExecuteImpl ( const XArgType1 *  in1, const XArgType2 *  in2, XArgType3 *  out  )

overrideprotectedvirtual

Executes MHO_DelayRate operations: zero padding, FFT, cyclic rotation, and interpolation.

Parameters

in1	Input data for interpolation
in2	Input data weights
out	Output padded array

Returns

True if all operations succeed, false otherwise

Note

This is a virtual function.

Implements hops::MHO_BinaryOperator< visibility_type, weight_type, sbd_type >.

GetDelayRateSearchSpaceSize()

int hops::MHO_DelayRate::GetDelayRateSearchSpaceSize ( ) const

inline

Getter for delay rate search space size.

Returns

Delay rate search space size as an integer

InitializeImpl()

bool hops::MHO_DelayRate::InitializeImpl ( const XArgType1 *  in1, const XArgType2 *  in2, XArgType3 *  out  )

overrideprotectedvirtual

Initializes MHO_DelayRate with input data and prepares for delay rate calculation.

Parameters

in1	Input data of type XArgType1
in2	Additional input data of type XArgType2
out	Output workspace of type XArgType3

Returns

True if initialization is successful, false otherwise

Note

This is a virtual function.

Implements hops::MHO_BinaryOperator< visibility_type, weight_type, sbd_type >.

SetReferenceFrequency()

void hops::MHO_DelayRate::SetReferenceFrequency ( double  ref_freq )

inline

Setter for reference frequency.

Parameters

ref_freq

New reference frequency value in Hertz

---

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

• MHO_DelayRate.hh
• MHO_DelayRate.cc