HOPS
HOPS class reference
Public Member Functions | List of all members
hops::MHO_AdhocPhaseCorrectionBuilder Class Reference

Class MHO_AdhocPhaseCorrectionBuilder. More...

#include <MHO_AdhocPhaseCorrectionBuilder.hh>

Inheritance diagram for hops::MHO_AdhocPhaseCorrectionBuilder:
[legend]

Public Member Functions

 MHO_AdhocPhaseCorrectionBuilder (MHO_OperatorToolbox *toolbox, MHO_ContainerStore *cstore=nullptr, MHO_ParameterStore *pstore=nullptr)
 
 MHO_AdhocPhaseCorrectionBuilder (MHO_OperatorToolbox *toolbox, MHO_FringeData *fdata)
 
virtual ~MHO_AdhocPhaseCorrectionBuilder ()
 
virtual bool Build () override
 Constructs and registers a MHO_AdhocPhaseCorrection operator. More...
 
- Public Member Functions inherited from hops::MHO_OperatorBuilder
 MHO_OperatorBuilder (MHO_OperatorToolbox *toolbox, MHO_ContainerStore *cstore=nullptr, MHO_ParameterStore *pstore=nullptr)
 
 MHO_OperatorBuilder (MHO_OperatorToolbox *toolbox, MHO_FringeData *fdata)
 
virtual ~MHO_OperatorBuilder ()
 
void SetAttributes (const mho_json &attr)
 Setter for attributes. More...
 
void SetConditions (const mho_json &cond)
 Setter for applicability conditions. More...
 
void SetContainerStore (MHO_ContainerStore *cstore)
 Setter for container store. More...
 
void SetFormat (const mho_json &format)
 Setter for format. More...
 
void SetFringeData (MHO_FringeData *fdata)
 Setter for fringe data. More...
 
void SetParameterStore (MHO_ParameterStore *pstore)
 Setter for parameter store. More...
 
void SetToolbox (MHO_OperatorToolbox *toolbox)
 Setter for toolbox. More...
 

Additional Inherited Members

- Protected Member Functions inherited from hops::MHO_OperatorBuilder
std::vector< std::string > ExtractAllStationIdentifiers () const
 
std::vector< std::string > GetMatchingStationIdentifiers () const
 
virtual bool IsConfigurationOk ()
 Function IsConfigurationOk provided for derived class to validate fAttributes against fFormat and/or fConditions but the default implementation tries to check a few things. More...
 
bool StationMatchesCurrentBaseline (const std::string &station_id) const
 
bool StationMatchesRole (const std::string &station_id, const std::string &role) const
 
- Protected Attributes inherited from hops::MHO_OperatorBuilder
mho_json fAttributes
 
mho_json fConditions
 
MHO_ContainerStorefContainerStore
 
mho_json fFormat
 
MHO_FringeDatafFringeData
 
MHO_OperatorToolboxfOperatorToolbox
 
MHO_ParameterStorefParameterStore
 

Detailed Description

Class MHO_AdhocPhaseCorrectionBuilder.

Builds a MHO_AdhocPhaseCorrection operator from control-file parameters.

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

Triggered by an 'adhoc_phase <algorithm_type>' compound statement in the control file. The algorithm_type string selects the correction mode: "sinewave" -> AdhocPhaseMode::SINEWAVE "polynomial" -> AdhocPhaseMode::POLYNOMIAL "file" -> AdhocPhaseMode::PHYLE

Auxiliary scalar parameters consumed from the parameter store: /control/config/adhoc_tref (real, seconds from scan start) /control/station/<ref_id or rem_id>/adhoc_period (real, seconds) /control/station/<ref_id or rem_id>/adhoc_amp (real, degrees – converted to radians internally) (units?) /control/station/<ref_id or rem_id>/adhoc_poly (list_real, degrees/s^n – converted to radians/s^n) (units?)

Per-station file parameters consumed from the parameter store (no generic parameters): /control/station/<ref_id>/adhoc_file (string, ref-station specific override) /control/station/<rem_id>/adhoc_file (string, rem-station specific override) /control/station/<ref_id>/adhoc_file_chans /control/station/<rem_id>/adhoc_file_chans

Constructor & Destructor Documentation

◆ MHO_AdhocPhaseCorrectionBuilder() [1/2]

hops::MHO_AdhocPhaseCorrectionBuilder::MHO_AdhocPhaseCorrectionBuilder ( MHO_OperatorToolbox toolbox,
MHO_FringeData fdata 
)
inline

◆ MHO_AdhocPhaseCorrectionBuilder() [2/2]

hops::MHO_AdhocPhaseCorrectionBuilder::MHO_AdhocPhaseCorrectionBuilder ( MHO_OperatorToolbox toolbox,
MHO_ContainerStore cstore = nullptr,
MHO_ParameterStore pstore = nullptr 
)
inline

◆ ~MHO_AdhocPhaseCorrectionBuilder()

virtual hops::MHO_AdhocPhaseCorrectionBuilder::~MHO_AdhocPhaseCorrectionBuilder ( )
inlinevirtual

Member Function Documentation

◆ Build()

bool hops::MHO_AdhocPhaseCorrectionBuilder::Build ( )
overridevirtual

Constructs and registers a MHO_AdhocPhaseCorrection operator.

Returns
true on success, false if required data or parameters are missing.

Implements hops::MHO_OperatorBuilder.


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