Calibration::Instrument Class Reference

Phenomenological description of the instrument. More...

#include <Instrument.h>

Inheritance diagram for Calibration::Instrument:
Calibration::BackendFeed MEAL::ProductRule< MEAL::Complex2 > MEAL::GroupRule< class >

Public Member Functions

 Instrument ()
 Default Constructor.
 
 Instrument (const Instrument &s)
 Copy Constructor.
 
const Instrumentoperator= (const Instrument &s)
 Assignment Operator. More...
 
Instrumentclone () const
 Clone operator.
 
 ~Instrument ()
 Destructor.
 
void equal_ellipticities ()
 Model the ellipticities of both receptors using the same value.
 
void independent_ellipticities ()
 Model the ellipticities of the receptors using independent values.
 
MEAL::ScalarParameterget_ellipticities ()
 Return the single model parameter that constrains both ellipticities.
 
bool has_equal_ellipticities () const
 Return true if both ellipticities are constrained by a single parameter.
 
void equal_orientations ()
 Model the orientations of both receptors using the same value.
 
void independent_orientations ()
 
void set_cyclic (bool flag=true)
 Set cyclical limits on the model parameters.
 
void set_constant_orientation (bool)
 Fix the orientation of the frontend.
 
Estimate< double > get_orientation (unsigned ireceptor) const
 Get the orientation, $\theta$, of the specified receptor in radians. More...
 
Estimate< double > get_ellipticity (unsigned ireceptor) const
 Get the ellipticity, $\chi$, of the specified receptor in radians. More...
 
unsigned get_ellipticity_index (unsigned receptor) const
 Get the index of the ellipticity parameter for the specified receptor.
 
void set_orientation (unsigned ireceptor, const Estimate< double > &theta)
 Set the orientation, $\theta$, of the specified receptor in radians. More...
 
void set_ellipticity (unsigned ireceptor, const Estimate< double > &chi)
 Set the ellipticity, $\chi$, of the specified receptor in radians. More...
 
const Feedget_feed () const
 Provide access to the Feed model.
 
Feedget_feed ()
 
std::string get_name () const
 Return the name of the class.
 
- Public Member Functions inherited from Calibration::BackendFeed
 BackendFeed ()
 Default constructor.
 
 BackendFeed (const BackendFeed &s)
 Copy Constructor.
 
const BackendFeedoperator= (const BackendFeed &s)
 Assignment Operator. More...
 
 ~BackendFeed ()
 Destructor.
 
const VariableBackendget_backend () const
 Provide access to the backend model.
 
VariableBackendget_backend ()
 
const MEAL::Complex2get_frontend () const
 Provide access to the frontend model.
 
MEAL::Complex2get_frontend ()
 
- Public Member Functions inherited from MEAL::ProductRule< MEAL::Complex2 >
void operator*= (T *model)
 
std::string get_name () const
 
- Public Member Functions inherited from MEAL::GroupRule< class >
 GroupRule (const GroupRule &meta)
 
GroupRuleoperator= (const GroupRule &meta)
 
void add_model (T *model)
 
void remove_model (T *model)
 
T * get_model (unsigned i)
 
unsigned get_nmodel () const
 
void clear ()
 
void parse (const std::string &text)
 

Protected Attributes

Reference::To< Feedfeed
 Feed model: $\theta_0-1$ and $\chi_0-1$.
 
Reference::To< MEAL::ChainRule< MEAL::Complex2 > > feed_chain
 ChainRule used to bind Feed parameters.
 
Reference::To< MEAL::ScalarParameterellipticities
 ScalarParameter used to bind ellipticities.
 
Reference::To< MEAL::ScalarParameterorientations
 ScalarParameter used to bind orientations.
 

Additional Inherited Members

- Protected Member Functions inherited from Calibration::BackendFeed
void set_frontend (MEAL::Complex2 *)
 
- Protected Member Functions inherited from MEAL::ProductRule< MEAL::Complex2 >
const Result get_identity () const
 
void operate (Result &total, const Result &element)
 
const Result partial (const Result &element) const
 
- Protected Member Functions inherited from MEAL::GroupRule< class >
void print_parameters (std::string &text, const std::string &sep) const
 
void calculate (Result &result, std::vector< Result > *grad)
 
virtual const Result get_identity () const=0
 

Detailed Description

Phenomenological description of the instrument.

The transformation is represented by the product of a SingleAxis transformation and Feed transformation.

Member Function Documentation

◆ get_ellipticity()

Estimate< double > Calibration::Instrument::get_ellipticity ( unsigned  ireceptor) const

Get the ellipticity, $\chi$, of the specified receptor in radians.

Get the ellipticity.

References Estimate< class, class >::get_value().

Referenced by Pulsar::InstrumentInfo::get_param_feed().

◆ get_orientation()

Estimate< double > Calibration::Instrument::get_orientation ( unsigned  ireceptor) const

Get the orientation, $\theta$, of the specified receptor in radians.

Get the orientation.

References Estimate< class, class >::get_value().

Referenced by Pulsar::InstrumentInfo::get_param_feed(), and Pulsar::InstrumentInfo::InstrumentInfo().

◆ operator=()

const Calibration::Instrument & Calibration::Instrument::operator= ( const Instrument s)

Assignment Operator.

Equality Operator.

References feed.

◆ set_ellipticity()

void Calibration::Instrument::set_ellipticity ( unsigned  ireceptor,
const Estimate< double > &  chi 
)

Set the ellipticity, $\chi$, of the specified receptor in radians.

Set the ellipticity.

◆ set_orientation()

void Calibration::Instrument::set_orientation ( unsigned  ireceptor,
const Estimate< double > &  theta 
)

Set the orientation, $\theta$, of the specified receptor in radians.

Set the orientation.

Referenced by Pulsar::SimPolnTiming::one_step().


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

Generated using doxygen 1.8.17