Class MHO_ComputePlotData. More...

#include <MHO_ComputePlotData.hh>

Public Member Functions
	MHO_ComputePlotData ()

virtual	~MHO_ComputePlotData ()

xpower_amp_type	calc_dr ()
	Calculates delay-rate (dr) function (amplitude vs delay rate) More...

std::string	calc_error_code (const mho_json &plot_dict)
	calcuates the fringe error code More...

void	calc_freqrms (phasor_type &phasors, double coh_avg_phase, double fringe_amp, double total_summed_weights, double snr, double &freqrms_phase, double &freqrms_amp, double &inc_avg_amp_freq)
	Calculates frequency root mean square (phase and amplitude) for given phasors. More...

xpower_amp_type	calc_mbd ()
	Calculates Multi-Band Delay (MBD) function (amplitude vs. mbd) More...

double	calc_phase ()
	Calculates fringe phase using weighted sum and fitted (delay, delay-rate) rotation. More...

std::string	calc_quality_code ()
	calcuates the fringe quality code More...

xpower_amp_type	calc_sbd ()
	Calculates Single Band Delay (SBD) function (amplitude vs. sbd) More...

phasor_type	calc_segs ()
	Calculates and returns time-averaged phasor segments for each channel. More...

void	calc_timerms (phasor_type &phasors, std::size_t nseg, std::size_t apseg, double coh_avg_phase, double fringe_amp, double total_summed_weights, double snr, double &timerms_phase, double &timerms_amp, double &inc_avg_amp)
	Calculates time-domain measurements (phase, amplitude, average) from phasors data. More...

xpower_type	calc_xpower_spec ()
	Calculates and returns the cross-power spectrum for a given SBD array. More...

void	correct_vis ()
	Corrects visibility data by applying fringe solution. More...

void	DisableOptimizeClosure ()
	Disables optimize closure by setting underlying MHO_FringeRotation (fRot) optimizeClosure to false. More...

void	dump_manual_pcmodel (mho_json &plot_dict, int station_flag, std::string pol)

void	dump_multitone_pcmodel (mho_json &plot_dict, int station_flag, std::string pol)

void	DumpInfoToJSON (mho_json &plot_dict)
	Dumps fringe plot data into a JSON object for visualization/consumption by plotting routine. More...

void	EnableOptimizeClosure ()
	Sets optimize closure to true in underlying MHO_FringeRotation (fRot) object. More...

void	Initialize ()
	Initializes member variables by retrieving values from parameter and container stores. More...

void	SetContainerStore (MHO_ContainerStore *cStore)
	Setter for container store. More...

void	SetMBDAnchor (std::string flag)
	Setter for mbd anchor (either: 'sbd' or 'model') More...

void	SetOperatorToolbox (MHO_OperatorToolbox *toolbox)
	Setter for operator toolbox. More...

void	SetParameterStore (MHO_ParameterStore *pStore)
	Setter for parameter store. More...

void	SetVexInfo (const mho_json &vex_info)
	Setter for vex info. More...

Public Attributes
double	fAmp

MHO_ContainerStore *	fContainerStore

MHO_CyclicRotator< xpower_type >	fCyclicRotator

double	fDelayRate

xpower_amp_type	fDRAmpWorkspace

xpower_type	fDRWorkspace

MHO_MultidimensionalFastFourierTransform< xpower_type >	fFFTEngine

xpower_type	fFringe

double	fFringeRate

std::complex< double >	fImagUnit

xpower_amp_type	fMBDAmpWorkspace

std::string	fMBDAnchor

double	fMBDelay

xpower_type	fMBDWorkspace

std::vector< int >	fNLSBAP

std::vector< int >	fNUSBAP

MHO_ParameterStore *	fParamStore

double	fRefFreq

MHO_FringeRotation	fRot

visibility_type *	fSBDArray

std::vector< double >	fSBDBox

double	fSBDelay

std::size_t	fSBDMaxBin

MHO_OperatorToolbox *	fToolbox

double	fTotalSummedWeights

bool	fValid

mho_json	fVexInfo

visibility_type *	fVisibilities

weight_type *	fWeights

Detailed Description

Class MHO_ComputePlotData.

class for computing fringe plot information

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

Date: Mon Apr 24 10:01:21 2023 -0400

Constructor & Destructor Documentation

◆ MHO_ComputePlotData()

hops::MHO_ComputePlotData::MHO_ComputePlotData ( )

◆ ~MHO_ComputePlotData()

virtual hops::MHO_ComputePlotData::~MHO_ComputePlotData ( )

inlinevirtual

Member Function Documentation

◆ calc_dr()

xpower_amp_type hops::MHO_ComputePlotData::calc_dr ( )

Calculates delay-rate (dr) function (amplitude vs delay rate)

Returns: xpower_amp_type representing calculated delay-rate

◆ calc_error_code()

std::string hops::MHO_ComputePlotData::calc_error_code ( const mho_json & plot_dict )

calcuates the fringe error code

◆ calc_freqrms()

void hops::MHO_ComputePlotData::calc_freqrms	(	phasor_type &	phasors,
		double	coh_avg_phase,
		double	fringe_amp,
		double	total_summed_weights,
		double	snr,
		double &	freqrms_phase,
		double &	freqrms_amp,
		double &	inc_avg_amp_freq
	)

Calculates frequency root mean square (phase and amplitude) for given phasors.

Parameters

phasors	Reference to phasor_type object containing channel data
coh_avg_phase	Coherent average phase in radians
fringe_amp	Fringe amplitude
total_summed_weights	Total summed weights
snr	Signal-to-noise ratio
freqrms_phase	Output: Frequency RMS phase
freqrms_amp	Output: Frequency RMS amplitude
inc_avg_amp_freq	Output: incoherent average amplitude (over frequency)

◆ calc_mbd()

xpower_amp_type hops::MHO_ComputePlotData::calc_mbd ( )

Calculates Multi-Band Delay (MBD) function (amplitude vs. mbd)

Returns: xpower_amp_type representing the calculated MBD.

◆ calc_phase()

double hops::MHO_ComputePlotData::calc_phase ( )

Calculates fringe phase using weighted sum and fitted (delay, delay-rate) rotation.

Returns: fringe phase as a double value.

◆ calc_quality_code()

std::string hops::MHO_ComputePlotData::calc_quality_code ( )

calcuates the fringe quality code

◆ calc_sbd()

xpower_amp_type hops::MHO_ComputePlotData::calc_sbd ( )

Calculates Single Band Delay (SBD) function (amplitude vs. sbd)

Returns: xpower_amp_type containing SBD power spectrum

◆ calc_segs()

phasor_type hops::MHO_ComputePlotData::calc_segs ( )

Calculates and returns time-averaged phasor segments for each channel.

Returns: phasor_type containing calculated phasor segments.

◆ calc_timerms()

void hops::MHO_ComputePlotData::calc_timerms	(	phasor_type &	phasors,
		std::size_t	nseg,
		std::size_t	apseg,
		double	coh_avg_phase,
		double	fringe_amp,
		double	total_summed_weights,
		double	snr,
		double &	timerms_phase,
		double &	timerms_amp,
		double &	inc_avg_amp
	)

Calculates time-domain measurements (phase, amplitude, average) from phasors data.

Parameters

phasors	Input phasor data
nseg	Number of segments in phasors data
apseg	Average phase segment size
coh_avg_phase	Coherent average phase (degrees)
fringe_amp	Fringe amplitude
total_summed_weights	Total summed weights
snr	Signal to Noise Ratio
timerms_phase	Output: Time RMS phase
timerms_amp	Output: Time RMS amplitude
inc_avg_amp	Output: incoherent average amplitude (over time)

◆ calc_xpower_spec()

xpower_type hops::MHO_ComputePlotData::calc_xpower_spec ( )

Calculates and returns the cross-power spectrum for a given SBD array.

Returns: xpower_type containing the calculated cross-power spectrum

◆ correct_vis()

void hops::MHO_ComputePlotData::correct_vis ( )

Corrects visibility data by applying fringe solution.

◆ DisableOptimizeClosure()

void hops::MHO_ComputePlotData::DisableOptimizeClosure ( )

inline

Disables optimize closure by setting underlying MHO_FringeRotation (fRot) optimizeClosure to false.

◆ dump_manual_pcmodel()

void hops::MHO_ComputePlotData::dump_manual_pcmodel	(	mho_json &	plot_dict,
		int	station_flag,
		std::string	pol
	)

◆ dump_multitone_pcmodel()

void hops::MHO_ComputePlotData::dump_multitone_pcmodel	(	mho_json &	plot_dict,
		int	station_flag,
		std::string	pol
	)

◆ DumpInfoToJSON()

void hops::MHO_ComputePlotData::DumpInfoToJSON ( mho_json & plot_dict )

Dumps fringe plot data into a JSON object for visualization/consumption by plotting routine.

Parameters

plot_dict JSON object to store fringe plot data.

◆ EnableOptimizeClosure()

void hops::MHO_ComputePlotData::EnableOptimizeClosure ( )

inline

Sets optimize closure to true in underlying MHO_FringeRotation (fRot) object.

◆ Initialize()

void hops::MHO_ComputePlotData::Initialize ( )

Initializes member variables by retrieving values from parameter and container stores.

◆ SetContainerStore()

void hops::MHO_ComputePlotData::SetContainerStore ( MHO_ContainerStore * cStore )

inline

Setter for container store.

Parameters

cStore Pointer to MHO_ContainerStore object

◆ SetMBDAnchor()

void hops::MHO_ComputePlotData::SetMBDAnchor ( std::string flag )

inline

Setter for mbd anchor (either: 'sbd' or 'model')

Parameters

flag	Flag indicating the MBD anchor type

◆ SetOperatorToolbox()

void hops::MHO_ComputePlotData::SetOperatorToolbox ( MHO_OperatorToolbox * toolbox )

inline

Setter for operator toolbox.

Parameters

toolbox Pointer to MHO_OperatorToolbox object

◆ SetParameterStore()

void hops::MHO_ComputePlotData::SetParameterStore ( MHO_ParameterStore * pStore )

inline

Setter for parameter store.

Parameters

pStore Pointer to MHO_ParameterStore object

◆ SetVexInfo()

void hops::MHO_ComputePlotData::SetVexInfo ( const mho_json & vex_info )

inline

Setter for vex info.

Parameters

vex_info Const reference to mho_json object containing VEX information (from root file)

Member Data Documentation

◆ fAmp

double hops::MHO_ComputePlotData::fAmp

◆ fContainerStore

MHO_ContainerStore* hops::MHO_ComputePlotData::fContainerStore

◆ fCyclicRotator

MHO_CyclicRotator< xpower_type > hops::MHO_ComputePlotData::fCyclicRotator

◆ fDelayRate

double hops::MHO_ComputePlotData::fDelayRate

◆ fDRAmpWorkspace

xpower_amp_type hops::MHO_ComputePlotData::fDRAmpWorkspace

◆ fDRWorkspace

xpower_type hops::MHO_ComputePlotData::fDRWorkspace

◆ fFFTEngine

MHO_MultidimensionalFastFourierTransform< xpower_type > hops::MHO_ComputePlotData::fFFTEngine

◆ fFringe

xpower_type hops::MHO_ComputePlotData::fFringe

◆ fFringeRate

double hops::MHO_ComputePlotData::fFringeRate

◆ fImagUnit

std::complex< double > hops::MHO_ComputePlotData::fImagUnit

◆ fMBDAmpWorkspace

xpower_amp_type hops::MHO_ComputePlotData::fMBDAmpWorkspace

◆ fMBDAnchor

std::string hops::MHO_ComputePlotData::fMBDAnchor

◆ fMBDelay

double hops::MHO_ComputePlotData::fMBDelay

◆ fMBDWorkspace

xpower_type hops::MHO_ComputePlotData::fMBDWorkspace

◆ fNLSBAP

std::vector< int > hops::MHO_ComputePlotData::fNLSBAP

◆ fNUSBAP

std::vector< int > hops::MHO_ComputePlotData::fNUSBAP

◆ fParamStore

MHO_ParameterStore* hops::MHO_ComputePlotData::fParamStore

◆ fRefFreq

double hops::MHO_ComputePlotData::fRefFreq

◆ fRot

MHO_FringeRotation hops::MHO_ComputePlotData::fRot

◆ fSBDArray

visibility_type* hops::MHO_ComputePlotData::fSBDArray

◆ fSBDBox

std::vector< double > hops::MHO_ComputePlotData::fSBDBox

◆ fSBDelay

double hops::MHO_ComputePlotData::fSBDelay

◆ fSBDMaxBin

std::size_t hops::MHO_ComputePlotData::fSBDMaxBin

◆ fToolbox

MHO_OperatorToolbox* hops::MHO_ComputePlotData::fToolbox

◆ fTotalSummedWeights

double hops::MHO_ComputePlotData::fTotalSummedWeights

◆ fValid

bool hops::MHO_ComputePlotData::fValid

◆ fVexInfo

mho_json hops::MHO_ComputePlotData::fVexInfo

◆ fVisibilities

visibility_type* hops::MHO_ComputePlotData::fVisibilities

◆ fWeights

weight_type* hops::MHO_ComputePlotData::fWeights

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MHO_ComputePlotData()

◆ ~MHO_ComputePlotData()

Member Function Documentation

◆ calc_dr()

◆ calc_error_code()

◆ calc_freqrms()

◆ calc_mbd()

◆ calc_phase()

◆ calc_quality_code()

◆ calc_sbd()

◆ calc_segs()

◆ calc_timerms()

◆ calc_xpower_spec()

◆ correct_vis()

◆ DisableOptimizeClosure()

◆ dump_manual_pcmodel()

◆ dump_multitone_pcmodel()

◆ DumpInfoToJSON()

◆ EnableOptimizeClosure()

◆ Initialize()

◆ SetContainerStore()

◆ SetMBDAnchor()

◆ SetOperatorToolbox()

◆ SetParameterStore()

◆ SetVexInfo()

Member Data Documentation

◆ fAmp

◆ fContainerStore

◆ fCyclicRotator

◆ fDelayRate

◆ fDRAmpWorkspace

◆ fDRWorkspace

◆ fFFTEngine

◆ fFringe

◆ fFringeRate

◆ fImagUnit

◆ fMBDAmpWorkspace

◆ fMBDAnchor

◆ fMBDelay

◆ fMBDWorkspace

◆ fNLSBAP

◆ fNUSBAP

◆ fParamStore

◆ fRefFreq

◆ fRot

◆ fSBDArray

◆ fSBDBox

◆ fSBDelay

◆ fSBDMaxBin

◆ fToolbox

◆ fTotalSummedWeights

◆ fValid

◆ fVexInfo

◆ fVisibilities

◆ fWeights