hops::MHO_InterpolateSpectralLinePeak Class Reference

Class MHO_InterpolateSpectralLinePeak. More...

#include <MHO_InterpolateSpectralLinePeak.hh>

Inheritance diagram for hops::MHO_InterpolateSpectralLinePeak:

Public Member Functions
	MHO_InterpolateSpectralLinePeak ()
virtual	~MHO_InterpolateSpectralLinePeak ()
virtual bool	Execute () override
	Function Execute. More...
double	GetDelayRate () const
	Fine-interpolated delay rate (sec/sec). More...
double	GetFringeAmplitude () const
	Fringe amplitude normalised by total_summed_weights. More...
double	GetFringePhase () const
	Fringe phase at the peak (radians). More...
double	GetFringeRate () const
	Fine-interpolated fringe rate (Hz) = delay_rate x ref_freq. More...
double	GetPeakSkyFrequencyMHz () const
	Sky frequency of the peak channel (MHz), refined by intra-channel interpolation. More...
double	GetPhaseDelay () const
	Phase delay at the spectral-line frequency (seconds). tau_phase = fringe_phase / (2pi x nu_peak_Hz). NOTE: this is the phase delay, NOT the group delay (which is undefined for a spectrally narrow source). More...
virtual bool	Initialize () override
	Function Initialize. More...
void	SetDRAxis (const delay_rate_axis_type *dr_ax)
	Copy the delay-rate axis from the search operator. More...
void	SetMaxBins (int peak_chan, int peak_dr_bin, int peak_freq_bin)
	Set the coarse peak bin indices obtained from MHO_SpectralLineFringeSearch. More...
void	SetReferenceFrequency (double ref_freq_mhz)
	Reference frequency in MHz (used to compute fringe rate from delay rate). More...
void	SetSpecDRData (const visibility_type *spec_dr_data)
	Set the delay-rate / frequency workspace produced by MHO_SpectralLineFringeSearch. Layout: [1][channel][DR_bin][freq_bin]. More...
void	SetWeights (const weight_type *weights)
	Set the weight array (needed for the total_summed_weights tag). 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...

Detailed Description

Class MHO_InterpolateSpectralLinePeak.

Fine interpolation around the coarse fringe peak for spectral-line data.

Author

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

Date

Operates on the (channel x delay-rate x freq) amplitude surface produced by MHO_SpectralLineFringeSearch. Applies independent parabolic interpolation in the delay-rate and intra-channel frequency dimensions to locate the sub-bin amplitude maximum, then extracts the fringe phase and computes the phase delay.

Outputs:

• delay rate (sec/sec)
• fringe rate (Hz) = delay_rate x ref_freq
• fringe amplitude (normalised by total_summed_weights)
• fringe phase (radians) at the peak
• phase delay (seconds) = fringe_phase / (2pi x nu_peak_Hz)
• peak sky frequency (MHz) - the CHANNEL_AXIS value for the peak channel

Constructor & Destructor Documentation

MHO_InterpolateSpectralLinePeak()

hops::MHO_InterpolateSpectralLinePeak::MHO_InterpolateSpectralLinePeak

(

)

~MHO_InterpolateSpectralLinePeak()

virtual hops::MHO_InterpolateSpectralLinePeak::~MHO_InterpolateSpectralLinePeak ( )

inlinevirtual

Member Function Documentation

Execute()

bool hops::MHO_InterpolateSpectralLinePeak::Execute ( )

overridevirtual

Function Execute.

Returns

Return value (bool)

Note

This is a virtual function.

Implements hops::MHO_Operator.

GetDelayRate()

double hops::MHO_InterpolateSpectralLinePeak::GetDelayRate ( ) const

inline

Fine-interpolated delay rate (sec/sec).

GetFringeAmplitude()

double hops::MHO_InterpolateSpectralLinePeak::GetFringeAmplitude ( ) const

inline

Fringe amplitude normalised by total_summed_weights.

GetFringePhase()

double hops::MHO_InterpolateSpectralLinePeak::GetFringePhase ( ) const

inline

Fringe phase at the peak (radians).

GetFringeRate()

double hops::MHO_InterpolateSpectralLinePeak::GetFringeRate ( ) const

inline

Fine-interpolated fringe rate (Hz) = delay_rate x ref_freq.

GetPeakSkyFrequencyMHz()

double hops::MHO_InterpolateSpectralLinePeak::GetPeakSkyFrequencyMHz ( ) const

inline

Sky frequency of the peak channel (MHz), refined by intra-channel interpolation.

GetPhaseDelay()

double hops::MHO_InterpolateSpectralLinePeak::GetPhaseDelay ( ) const

inline

Phase delay at the spectral-line frequency (seconds). tau_phase = fringe_phase / (2pi x nu_peak_Hz). NOTE: this is the phase delay, NOT the group delay (which is undefined for a spectrally narrow source).

Initialize()

bool hops::MHO_InterpolateSpectralLinePeak::Initialize ( )

overridevirtual

Function Initialize.

Returns

Return value (bool)

Note

This is a virtual function.

Implements hops::MHO_Operator.

SetDRAxis()

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

inline

Copy the delay-rate axis from the search operator.

SetMaxBins()

void hops::MHO_InterpolateSpectralLinePeak::SetMaxBins	(	int	peak_chan,
		int	peak_dr_bin,
		int	peak_freq_bin
	)

Set the coarse peak bin indices obtained from MHO_SpectralLineFringeSearch.

SetReferenceFrequency()

void hops::MHO_InterpolateSpectralLinePeak::SetReferenceFrequency ( double  ref_freq_mhz )

inline

Reference frequency in MHz (used to compute fringe rate from delay rate).

SetSpecDRData()

void hops::MHO_InterpolateSpectralLinePeak::SetSpecDRData ( const visibility_type *  spec_dr_data )

inline

Set the delay-rate / frequency workspace produced by MHO_SpectralLineFringeSearch. Layout: [1][channel][DR_bin][freq_bin].

SetWeights()

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

inline

Set the weight array (needed for the total_summed_weights tag).

---

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

• MHO_InterpolateSpectralLinePeak.hh
• MHO_InterpolateSpectralLinePeak.cc