#include <MHO_Passband.hh>

Inheritance diagram for hops::MHO_Passband:

Public Member Functions
	MHO_Passband ()

virtual	~MHO_Passband ()

void	SetPassband (const double &first, const double &second)
	Setter for passband. 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
	Checks and excludes specific passbands within each channel of visibility data. 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 visibility_type pointer in-place and returns true. More...

virtual bool	InitializeOutOfPlace (const visibility_type in, visibility_type out) override
	Initializes out-of-place visibility data. 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_Passband.

Selects a chunk of frequency space for inclusion or removal.

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

hops::MHO_Passband::MHO_Passband ( )

◆ ~MHO_Passband()

hops::MHO_Passband::~MHO_Passband ( )

virtual

Member Function Documentation

◆ ExecuteInPlace()

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

overrideprotectedvirtual

Checks and excludes specific passbands within each channel of visibility data.

Parameters

in	Input visibility_type* containing channel axis.

Returns: bool indicating successful exclusion operation.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ ExecuteOutOfPlace()

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

overrideprotectedvirtual

Copies input visibility data and executes in-place processing.

Parameters

in	Input visibility_type data to be copied.
out	(visibility_type*)

Returns: Result of ExecuteInPlace operation on out parameter.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeInPlace()

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

overrideprotectedvirtual

Initializes visibility_type pointer in-place and returns true.

Parameters

in	Pointer to visibility_type that will be initialized in-place.

Returns: Boolean indicating success (always true).

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeOutOfPlace()

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

overrideprotectedvirtual

Initializes out-of-place visibility data.

Parameters

in	Input visibility_type pointer
out	Output visibility_type pointer

Returns: True if initialization is successful.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ SetPassband()

void hops::MHO_Passband::SetPassband	(	const double &	first,
		const double &	second
	)

inline

Setter for passband.

Parameters

first	Lower frequency limit in Hz
second	Upper frequency limit in Hz

if second < first then this operation is an 'exclusion' which tells us this is a chunk of spectrum to cut out, otherwise if first < second, then it is an inclusion, and everything outside will be cut (this is the legacy behavior)

◆ SetWeights()

void hops::MHO_Passband::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_Passband()

◆ ~MHO_Passband()

Member Function Documentation

◆ ExecuteInPlace()

◆ ExecuteOutOfPlace()

◆ InitializeInPlace()

◆ InitializeOutOfPlace()

◆ SetPassband()

◆ SetWeights()