#include <MHO_Notches.hh>

Inheritance diagram for hops::MHO_Notches:

Public Member Functions
	MHO_Notches ()

virtual	~MHO_Notches ()

void	SetNotchBoundaries (const std::vector< double > &notch_boundary_list)
	Setter for notch (locations along frequency axis where visibilities are zeroed out) boundaries. More...

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 ()

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 Member Functions
virtual bool	ExecuteInPlace (visibility_type *in) override
	Applies filter to channels and spectral points based on defined notches. More...

virtual bool	ExecuteOutOfPlace (const visibility_type in, visibility_type out) override
	Copies input visibility data and executes in-place processing. More...

virtual bool	InitializeInPlace (visibility_type *in) override
	Initializes MHO_Notches in-place using provided visibility_type pointer. More...

virtual bool	InitializeOutOfPlace (const visibility_type in, visibility_type out) override
	Initializes out-of-place visibility data from input pointer. More...

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

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_Notches()

hops::MHO_Notches::MHO_Notches ( )

◆ ~MHO_Notches()

hops::MHO_Notches::~MHO_Notches ( )

virtual

Member Function Documentation

◆ ExecuteInPlace()

bool hops::MHO_Notches::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 >.

◆ ExecuteOutOfPlace()

bool hops::MHO_Notches::ExecuteOutOfPlace	(	const visibility_type *	in,
		visibility_type *	out
	)

overrideprotectedvirtual

Copies input visibility data and executes in-place processing.

Parameters

in	Const reference to input visibility_type data.
out	(visibility_type*)

Returns: Boolean result of ExecuteInPlace operation on copied output data.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeInPlace()

bool hops::MHO_Notches::InitializeInPlace ( visibility_type * in )

overrideprotectedvirtual

Initializes MHO_Notches in-place using provided visibility_type pointer.

Parameters

in	Pointer to visibility_type for initialization.

Returns: True if initialization is successful.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeOutOfPlace()

bool hops::MHO_Notches::InitializeOutOfPlace	(	const visibility_type *	in,
		visibility_type *	out
	)

overrideprotectedvirtual

Initializes out-of-place visibility data from input pointer.

Parameters

in	Const pointer to input visibility_type data.
out	(visibility_type*)

Returns: Boolean indicating successful initialization.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ SetNotchBoundaries()

void hops::MHO_Notches::SetNotchBoundaries ( const std::vector< double > & notch_boundary_list )

inline

Setter for notch (locations along frequency axis where visibilities are zeroed out) boundaries.

Parameters

notch_boundary_list Input vector of double values, must come in pairs of (lower, upper) representing notch boundaries.

◆ SetWeights()

void hops::MHO_Notches::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:

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MHO_Notches()

◆ ~MHO_Notches()

Member Function Documentation

◆ ExecuteInPlace()

◆ ExecuteOutOfPlace()

◆ InitializeInPlace()

◆ InitializeOutOfPlace()

◆ SetNotchBoundaries()

◆ SetWeights()