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

Class MHO_FringeControlInitialization. More...

#include <MHO_FringeControlInitialization.hh>

Public Member Functions

 MHO_FringeControlInitialization ()
 
virtual ~MHO_FringeControlInitialization ()
 

Static Public Member Functions

static void add_circ_field_rotation_operator (mho_json &statements)
 Adds a predefined correction operator for circular-pol field rotation to the given statements. More...
 
static void add_default_operator_format_def (mho_json &format)
 Adds default operator format definitions to an mho_json object for fringe control initialization. More...
 
static void add_default_operators (mho_json &statements)
 Adds default operators to control statements for MHO fringe control initialization. More...
 
static void add_dpar_sign_correction_operator (mho_json &statements)
 Adds a default correction operator for dpar (delta parallactic angle) to the given statements. More...
 
static void add_polprod_sum_operator (mho_json &statements)
 Adds a default polarization product sum operator to the given statements. More...
 
static bool is_circular_polprod (std::string pp)
 Checks if given polarization product is circular (RR, LL, RL, LR). More...
 
static bool is_linear_polprod (std::string pp)
 Checks if input string represents a linear polarization product. More...
 
static bool need_ion_search (mho_json *control)
 Checks if special ionospheric fringe fitter is needed by searching control statements. More...
 
static void process_control_file (MHO_ParameterStore *paramStore, mho_json &control_format, mho_json &control_statements)
 Process control file and populate applicable statements in parameter store. More...
 

Detailed Description

Class MHO_FringeControlInitialization.

collection of helper functions for fringe fitter start-up

Author
J. Barrettj - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Mon Feb 5 13:59:09 2024 -0500

Constructor & Destructor Documentation

◆ MHO_FringeControlInitialization()

hops::MHO_FringeControlInitialization::MHO_FringeControlInitialization ( )
inline

◆ ~MHO_FringeControlInitialization()

virtual hops::MHO_FringeControlInitialization::~MHO_FringeControlInitialization ( )
inlinevirtual

Member Function Documentation

◆ add_circ_field_rotation_operator()

void hops::MHO_FringeControlInitialization::add_circ_field_rotation_operator ( mho_json statements)
static

Adds a predefined correction operator for circular-pol field rotation to the given statements.

Parameters
statementsReference to a list of JSON statements where the correction operator will be added.
Note
This is a static function.

◆ add_default_operator_format_def()

void hops::MHO_FringeControlInitialization::add_default_operator_format_def ( mho_json format)
static

Adds default operator format definitions to an mho_json object for fringe control initialization.

Parameters
formatReference to an mho_json object where defaults will be added.
Note
This is a static function.

◆ add_default_operators()

void hops::MHO_FringeControlInitialization::add_default_operators ( mho_json statements)
static

Adds default operators to control statements for MHO fringe control initialization.

Parameters
statementsReference to mho_json object where default operators will be added.
Note
This is a static function.

◆ add_dpar_sign_correction_operator()

void hops::MHO_FringeControlInitialization::add_dpar_sign_correction_operator ( mho_json statements)
static

Adds a default correction operator for dpar (delta parallactic angle) to the given statements.

Parameters
statementsReference to mho_json object containing control statements
Note
This is a static function.

◆ add_polprod_sum_operator()

void hops::MHO_FringeControlInitialization::add_polprod_sum_operator ( mho_json statements)
static

Adds a default polarization product sum operator to the given statements.

Parameters
statementsReference to an mho_json object containing control statements.
Note
This is a static function.

◆ is_circular_polprod()

bool hops::MHO_FringeControlInitialization::is_circular_polprod ( std::string  pp)
static

Checks if given polarization product is circular (RR, LL, RL, LR).

Parameters
ppInput polarization product string
Returns
True if circular, false otherwise
Note
This is a static function.

◆ is_linear_polprod()

bool hops::MHO_FringeControlInitialization::is_linear_polprod ( std::string  pp)
static

Checks if input string represents a linear polarization product.

Parameters
ppInput string representing polarization product.
Returns
True if pp is one of predefined linear products, false otherwise.
Note
This is a static function.

◆ need_ion_search()

bool hops::MHO_FringeControlInitialization::need_ion_search ( mho_json control)
static

Checks if special ionospheric fringe fitter is needed by searching control statements.

Parameters
controlInput mho_json object containing control statements
Returns
Boolean indicating whether ion search is needed
Note
This is a static function.

◆ process_control_file()

void hops::MHO_FringeControlInitialization::process_control_file ( MHO_ParameterStore paramStore,
mho_json control_format,
mho_json control_statements 
)
static

Process control file and populate applicable statements in parameter store.

Parameters
paramStorePointer to MHO_ParameterStore object for storing parameters.
control_formatReference to mho_json object for control format definition.
control_statementsReference to mho_json object for applicable control statements.
Note
This is a static function.

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