hops::MHO_InterpolateFringePeak Class Reference

Class MHO_InterpolateFringePeak. More...

#include <MHO_InterpolateFringePeak.hh>

Inheritance diagram for hops::MHO_InterpolateFringePeak:

Public Member Functions
	MHO_InterpolateFringePeak ()
virtual	~MHO_InterpolateFringePeak ()
void	DisableOptimizeClosure ()
	Disables optimize closure. More...
void	EnableOptimizeClosure ()
	Sets optimize closure to true (not used for 'simul' method). More...
virtual bool	Execute () override
	Executes fine peak interpolation and returns success. More...
double	GetDelayRate () const
	Getter for delay rate. More...
double	GetFringeAmplitude () const
	Getter for fringe amplitude. More...
double	GetFringeRate () const
	Getter for fringe rate. More...
double	GetMBDelay () const
	Getter for mbdelay. More...
double	GetSBDelay () const
	Getter for sbdelay. More...
virtual bool	Initialize () override
	Initializes MHO_InterpolateFringePeak object by checking and retrieving necessary data. More...
void	SetDRAxis (const delay_rate_axis_type *dr_ax)
	Setter for dr axis. More...
void	SetMaxBins (int sbd_max, int mbd_max, int dr_max)
	Setter for max bins (location) More...
void	SetMBDAxis (const time_axis_type *mbd_ax)
	Setter for mbd axis. More...
void	SetReferenceFrequency (double ref_freq)
	Setter for reference frequency. More...
void	SetReferenceTimeOffset (double frt_offset)
	Setter for reference time offset. More...
void	SetSBDArray (const visibility_type *sbd_arr)
	Setter for sbd array. More...
void	SetWeights (const weight_type *weights)
	Setter for weights. 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...

Detailed Description

Class MHO_InterpolateFringePeak.

implements fine interpolation about the fringe peak (see interp.c and max555.c code)

Author

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

Date

Thu Apr 13 16:25:38 2023 -0400

Constructor & Destructor Documentation

MHO_InterpolateFringePeak()

hops::MHO_InterpolateFringePeak::MHO_InterpolateFringePeak

(

)

~MHO_InterpolateFringePeak()

virtual hops::MHO_InterpolateFringePeak::~MHO_InterpolateFringePeak ( )

inlinevirtual

Member Function Documentation

DisableOptimizeClosure()

void hops::MHO_InterpolateFringePeak::DisableOptimizeClosure ( )

inline

Disables optimize closure.

EnableOptimizeClosure()

void hops::MHO_InterpolateFringePeak::EnableOptimizeClosure ( )

inline

Sets optimize closure to true (not used for 'simul' method).

Execute()

bool hops::MHO_InterpolateFringePeak::Execute ( )

overridevirtual

Executes fine peak interpolation and returns success.

Returns

True if execution is successful.

Note

This is a virtual function.

Implements hops::MHO_Operator.

GetDelayRate()

double hops::MHO_InterpolateFringePeak::GetDelayRate ( ) const

inline

Getter for delay rate.

Returns

The current delay rate as a double.

GetFringeAmplitude()

double hops::MHO_InterpolateFringePeak::GetFringeAmplitude ( ) const

inline

Getter for fringe amplitude.

Returns

Current fringe amplitude as a double.

GetFringeRate()

double hops::MHO_InterpolateFringePeak::GetFringeRate ( ) const

inline

Getter for fringe rate.

Returns

The current fringe rate as a double.

GetMBDelay()

double hops::MHO_InterpolateFringePeak::GetMBDelay ( ) const

inline

Getter for mbdelay.

Returns

Current multi-band delay as a double.

GetSBDelay()

double hops::MHO_InterpolateFringePeak::GetSBDelay ( ) const

inline

Getter for sbdelay.

Returns

Current value of sbdelay as a double

Initialize()

bool hops::MHO_InterpolateFringePeak::Initialize ( )

overridevirtual

Initializes MHO_InterpolateFringePeak object by checking and retrieving necessary data.

Returns

True if initialization is successful, false otherwise.

Note

This is a virtual function.

Implements hops::MHO_Operator.

SetDRAxis()

void hops::MHO_InterpolateFringePeak::SetDRAxis ( const delay_rate_axis_type *  dr_ax )

inline

Setter for dr axis.

Parameters

dr_ax

Input delay_rate_axis_type data to copy

SetMaxBins()

void hops::MHO_InterpolateFringePeak::SetMaxBins	(	int	sbd_max,
		int	mbd_max,
		int	dr_max
	)

Setter for max bins (location)

Parameters

sbd_max	Set the bin location for the maximum along the Single-Band Delay (SBD) axis .
mbd_max	Set the bin location for the maximum along the Multi-Band Delay (MBD) axis.
dr_max	Set the bin location for the maximum along the Delay Rate (DR) axis.

SetMBDAxis()

void hops::MHO_InterpolateFringePeak::SetMBDAxis ( const time_axis_type *  mbd_ax )

inline

Setter for mbd axis.

Parameters

mbd_ax

Input Multi-Band Delay axis

SetReferenceFrequency()

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

inline

Setter for reference frequency.

Parameters

ref_freq

New reference frequency value in Hertz

SetReferenceTimeOffset()

void hops::MHO_InterpolateFringePeak::SetReferenceTimeOffset ( double  frt_offset )

inline

Setter for reference time offset.

Parameters

frt_offset

New reference time offset value

SetSBDArray()

void hops::MHO_InterpolateFringePeak::SetSBDArray ( const visibility_type *  sbd_arr )

inline

Setter for sbd array.

Parameters

sbd_arr

Input SBD array of type const visibility_type*

SetWeights()

void hops::MHO_InterpolateFringePeak::SetWeights ( const weight_type *  weights )

inline

Setter for weights.

Parameters

weights

Input weights of type const weight_type*

---

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

• MHO_InterpolateFringePeak.hh
• MHO_InterpolateFringePeak.cc