hops::MHO_NotchComb Class Reference

Class MHO_NotchComb. More...

#include <MHO_NotchComb.hh>

Inheritance diagram for hops::MHO_NotchComb:

Public Member Functions
	MHO_NotchComb ()
virtual	~MHO_NotchComb ()
double	GetNotchOffset () const
double	GetNotchPeriod () const
double	GetNotchWidth () const
void	SetNotchOffset (double offset)
void	SetNotchPeriod (double period)
void	SetNotchWidth (double width)
void	SetWeights (weight_type *weights)
	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 ()
void	SetArgs (const visibility_type *in, visibility_type *out)
	Setter for args. More...
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...
double	Priority () const
	Get the the priority field value. More...
void	SetName (std::string name)
	Setter for operator name. More...
void	SetPriority (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 filter to channels and spectral points based on defined notches. More...
Protected Member Functions inherited from hops::MHO_UnaryOperator< visibility_type >
virtual bool	ExecuteOutOfPlace (const visibility_type *in, visibility_type *out)
virtual bool	InitializeInPlace (visibility_type *)
virtual bool	InitializeOutOfPlace (const visibility_type *, visibility_type *)

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_NotchComb.

operator which 'notches' out problematic chunks of visiblities in frequency space

Author

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

Date

Tue Apr 2 09:41:24 AM EDT 2024

Constructor & Destructor Documentation

MHO_NotchComb()

hops::MHO_NotchComb::MHO_NotchComb

(

)

~MHO_NotchComb()

hops::MHO_NotchComb::~MHO_NotchComb ( )

virtual

Member Function Documentation

ExecuteInPlace()

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

overrideprotectedvirtual

Applies filter to channels and spectral points based on defined notches.

Parameters

in	Input visibility data containing channel axis and frequency axis.

Returns

True if execution is successful, false otherwise.

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

GetNotchOffset()

double hops::MHO_NotchComb::GetNotchOffset ( ) const

inline

GetNotchPeriod()

double hops::MHO_NotchComb::GetNotchPeriod ( ) const

inline

GetNotchWidth()

double hops::MHO_NotchComb::GetNotchWidth ( ) const

inline

SetNotchOffset()

void hops::MHO_NotchComb::SetNotchOffset ( double  offset )

inline

SetNotchPeriod()

void hops::MHO_NotchComb::SetNotchPeriod ( double  period )

inline

SetNotchWidth()

void hops::MHO_NotchComb::SetNotchWidth ( double  width )

inline

SetWeights()

void hops::MHO_NotchComb::SetWeights ( weight_type *  weights )

inline

Setter for weights.

Parameters

weights

Input weight values of type weight_type

---

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

• MHO_NotchComb.hh
• MHO_NotchComb.cc