Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
Pulsar::SystemCalibrator Class Referenceabstract

PolnCalibrator with estimated calibrator Stokes parameters. More...

#include <SystemCalibrator.h>

Inheritance diagram for Pulsar::SystemCalibrator:
Pulsar::PolnCalibrator Pulsar::Calibrator Reference::Able Reference::HeapTracked Pulsar::PulsarCalibrator Pulsar::ReceptionCalibrator

Classes

class  Unloader
 Unloads Pulsar::SystemCalibrator solution to file. More...

Public Types

typedef Calibration::ReceptionModel::Solver Solver

Public Member Functions

 SystemCalibrator (Archive *archive=0)
 Construct with optional processed calibrator Archive.
 SystemCalibrator (const SystemCalibrator &)
 Copy constructor.
virtual ~SystemCalibrator ()
 Destructor.
virtual void share (SystemCalibrator *other)
 Share reception model and common transformations of other instance.
Calibrator::Info * get_Info () const
 Return the Calibrator information.
void set_name (const std::string &name)
 Set the name associated with this SystemCalibrator instance.
std::string get_name () const
 Get the name associated with this SystemCalibrator instance.
MJD get_epoch () const
 Return the reference epoch of the calibration experiment.
unsigned get_nchan () const
 Get the number of frequency channels.
unsigned get_ndata (unsigned ichan) const
 Get the number of data points in the given frequency channel.
virtual unsigned get_nstate () const
 Get the total number of input polarization states (pulsar and cal)
virtual unsigned get_nstate_pulsar () const
 Get the number of pulsar polarization states in the model.
virtual unsigned get_state_is_pulsar (unsigned istate) const
 Return true if the state index is a pulsar.
virtual bool has_cal () const
 Return true if calibrator (e.g. noise diode) data are incorporated.
virtual Calibrator::Info * new_info_pulsar (unsigned istate) const
 Return a new plot information interface for the specified pulsar state.
void set_refcal_through_frontend (bool flag=true)
 True if noise diode illuminates feed; false if coupled after OMT.
void set_flux_calibrator (const FluxCalibrator *fluxcal)
 Set the flux calibrator solution used to estimate calibrator Stokes.
void set_calibrators (const std::vector< std::string > &filenames)
 Set the calibrator observations to be loaded after first pulsar.
void set_calibrator_preprocessor (Processor *)
 Set the calibrator preprocessor.
virtual void set_calibrator (const Archive *)
 Set the calibrator.
virtual void set_response (MEAL::Complex2 *)
 Set the response (pure Jones) transformation.
void set_previous_solution (const PolnCalibrator *)
 Set the response to a previous solution (for the first guess)
void set_previous_cal (const CalibratorStokes *)
 Set the calibrator Stokes parameters to a previous solution (for the first guess)
void set_response_fixed (const std::vector< unsigned > &)
 Set the response parameters to be held fixed.
virtual void set_response_variation (unsigned iparam, MEAL::Univariate< MEAL::Scalar > *)
 Set the temporal variation function of a specified response parameter.
virtual void set_impurity (MEAL::Real4 *)
 Set the impurity transformation.
virtual void set_projection (VariableTransformationManager *)
 Set the projection transformation.
virtual void set_faraday_rotation (VariableFaradayRotation *)
 Set the ionospheric and interstellar Faraday rotation transformation.
virtual void set_gain (MEAL::Univariate< MEAL::Scalar > *)
 Set the time variation of absolute gain.
virtual void set_diff_gain (MEAL::Univariate< MEAL::Scalar > *)
 Set the time variation of differential gain.
virtual void set_diff_phase (MEAL::Univariate< MEAL::Scalar > *)
 Set the time variation of differential phase.
virtual void add_gain_step (const MJD &)
 Add a step to the gain variations.
virtual void add_diff_gain_step (const MJD &)
 Add a step to the differential gain variations.
virtual void add_diff_phase_step (const MJD &)
 Add a step to the differential phase variations.
virtual void add_step (const MJD &, Calibration::VariableBackend *)
 Add a VariableBackend step at the specified MJD.
void set_step_after_cal (bool val=true)
 Apply time steps afer cals.
bool get_step_after_cal () const
virtual void set_foreach_calibrator (const MEAL::Complex2 *)
virtual void set_stepeach_calibrator (const Calibration::VariableBackend *)
 Set the VariableBackend step to be cloned for each calibrator.
virtual void preprocess (Archive *data)
 Prepare the data for inclusion in the model.
virtual void add_observation (const Archive *data)
 Add the observation to the set of constraints.
virtual void set_normalize_by_invariant (bool flag=true)
 Normalize each pulsar Stokes vector by the mean on-pulse invariant.
virtual void set_normalize_calibrated_by_invariant (bool flag=true)
 Normalize each pulsar Stokes vector by the mean on-pulse invariant.
virtual void add_pulsar (const Archive *data)
 Add the pulsar observation to the set of constraints.
virtual void add_calibrator (const Archive *data)
 Add the calibrator observation to the set of constraints.
virtual void add_calibrator (const ReferenceCalibrator *polncal)
 Add the ReferenceCalibrator observation to the set of constraints.
virtual bool calibrator_match (const Archive *, std::string &reason_for_not_matching)
 Return true if this calibrator can be applied to the data.
virtual void add_epoch (const MJD &epoch)
 Add an observational epoch.
MJD get_start_epoch () const
 Get the epoch of the first observation.
MJD get_end_epoch () const
 Get the epoch of the last observation.
virtual void set_nthread (unsigned nthread)
 Set the number of channels that may be simultaneously solved.
virtual void set_equation_configuration (const std::vector< std::string > &)
 Set the measurement equation configuration options.
virtual bool has_solver () const
 Return true if least squares minimization solvers are available.
virtual const Solver * get_solver (unsigned ichan) const
 Return the solver for the specified channel.
virtual void set_solver (Solver *)
 Set the algorithm used to solve the measurement equation.
virtual Solver * get_solver ()
 Get the algorithm used to solve the measurement equation.
virtual void set_retry_reduced_chisq (float)
 Set the reduced chisq above which the solution will be retried.
virtual void set_invalid_reduced_chisq (float)
 Set the reduced chisq above which a solution will be flagged invalid.
virtual void set_report_projection (bool)
 Report on the projection correction used in add_pulsar method.
virtual void set_report_initial_state (bool flag=true)
 Report on the initial state of the model before fitting.
virtual void set_report_input_data (bool flag=true)
 Report on the data included as constraints before fitting.
virtual void set_report_input_failed (bool flag=true)
 Report on the number of failed attempts to add data.
virtual void set_report_data_and_model (bool flag=true)
 Report on the data and model before and after the fit.
virtual void set_report_total_invariant (bool flag=true)
 Report on the total invariant used to normalize each profile.
void set_cal_outlier_threshold (float f)
 Set the threshold used to reject outliers when computing CAL levels.
float get_cal_outlier_threshold () const
 Get the threshold used to reject outliers when computing CAL levels.
void set_cal_intensity_threshold (float f)
 Set the threshold used to reject CAL observations with no signal.
float get_cal_intensity_threshold () const
 Get the threshold used to reject CAL observations with no signal.
void set_cal_polarization_threshold (float f)
 Set the minimum degree of polarization of CAL observations.
float get_cal_polarization_threshold () const
 Get the minimum degree of polarization of CAL observations.
void set_step_finder (StepFinder *)
 Set the algorithm used to automatically insert steps in response.
StepFinder * get_step_finder ()
 Get the algorithm used to automatically insert steps in response.
virtual void solve ()
 Solve equation for each frequency.
virtual void reset ()
 Reset the response in each frequency to its initial value.
virtual bool get_solved () const
 Get the status of the model.
virtual bool get_valid (unsigned ichan) const
 Return true if the model for the specified channel is valid.
virtual void set_valid (unsigned ichan, bool value, const std::string &reason)
virtual bool has_valid () const
 Returns true if at least one channel returns get_valid == true.
float get_reduced_chisq (unsigned ichan) const
 Get the reduced chisq of the best fit in the specified channel.
virtual void precalibrate (Archive *archive)
 Pre-calibrate the polarization of the given archive.
virtual MEAL::Complex2 * get_transformation (const Archive *data, unsigned isub, unsigned ichan)
 Return the transformation to be used for precalibration.
virtual MEAL::Complex2 * get_transformation (const MJD &epoch, Signal::Source source, unsigned ichan)
 Return the transformation to be used for precalibration.
virtual Archive * new_solution (const std::string &archive_class) const
 Return a Calibrator::new_solution with a CalibratorStokesExtension.
virtual const CalibratorStokes * get_CalibratorStokes () const
 Return the CalibratorStokesExtension.
virtual const Calibration::SignalPath * get_model (unsigned ichan) const
 Return the SignalPath for the specified channel.
virtual bool match (const Archive *, bool throw_exception=true)
 Ensure that the pulsar observation can be added to the data set.
std::string get_mismatch_reason () const
Public Member Functions inherited from Pulsar::PolnCalibrator
 PolnCalibrator (const Archive *archive=0)
 Construct with optional processed calibrator Archive.
 PolnCalibrator (const PolnCalibrator &calibrator)
 Copy constructor.
virtual ~PolnCalibrator ()
 Destructor.
void set_subint (const Index &isub)
 Set the sub-integration index.
virtual void set_response_nchan (unsigned nchan)
 Set the number of frequency channels in the response array.
virtual unsigned get_response_nchan () const
 Get the number of frequency channels in the response array.
virtual Jones< float > get_response (unsigned ichan) const
 Return the system response for the specified channel.
bool has_Receiver () const
 Return true if the Receiver is set.
const Receiver * get_Receiver () const
 Return the Receiver.
void set_Receiver (const Archive *)
 Set the Receiver extension to that of the input Archive.
std::string get_receiver_basis_filename () const
void transformation_resize (unsigned nchan)
bool get_transformation_valid (unsigned ch) const
 Return true if the transformation for the specified channel is valid.
void set_transformation_invalid (unsigned ch, const std::string &reason)
 Set the transformation invalid flag for the specified channel.
const std::string & get_transformation_invalid_reason (unsigned ichan) const
 Get the reason that the transformation in the specified channel is invalid.
const MEAL::Complex2 * get_transformation (unsigned ichan) const
 Return the transformation for the specified channel.
MEAL::Complex2 * get_transformation (unsigned ichan)
 Return the transformation for the specified channel.
void set_transformation (unsigned ichan, MEAL::Complex2 *)
 Set the transformation for the secified channel.
bool has_covariance () const
 Return true if parameter covariances are stored.
void get_covariance (unsigned ichan, std::vector< double > &) const
 Return the covariance matrix vector for the specified channel.
MEAL::LeastSquares * get_solver (unsigned ichan)
void set_backend_correction (bool f)
 Perform backend corrections before inverting response.
virtual void calibrate (Archive *archive)
 Calibrate the polarization of the given archive.
virtual const Type * get_type () const
 Return the Calibrator::Type of derived class.
unsigned get_nchan (bool build_if_needed) const
 Get the number of frequency channels in the calibrator.
CalibratorExtension * new_Extension () const
 Return a new PolnCalibratorExtension.
void calibration_setup (const Archive *arch)
 Set up done before calibrating an archive.
Public Member Functions inherited from Pulsar::Calibrator
 Calibrator ()
 Default constructor.
virtual ~Calibrator ()
 Destructor.
Archive * new_solution (const std::string &archive_class) const
 Return a new processed calibrator Archive with a CalibratorExtension.
virtual std::string get_filenames () const
 Return a string containing the file information.
const Archive * get_Archive () const
 Return a const reference to the calibrator archive.
bool has_Archive () const
 Return true if the calibrator is constructed from an Archive.
template<class T>
bool is_a () const
Public Member Functions inherited from Reference::Able
 Able (const Able &)
Able & operator= (const Able &)
unsigned get_reference_count () const
Public Member Functions inherited from Reference::HeapTracked
 HeapTracked (const HeapTracked &)
HeapTracked & operator= (const HeapTracked &)
bool __is_on_heap () const

Protected Types

typedef MEAL::Univariate< MEAL::Scalar > UniScalar
typedef Reference::To< Calibration::SourceEstimate > SourceEstimate

Protected Member Functions

void setup_sharing (unsigned ichan)
virtual void prepare (const Archive *data)
 Prepare the model.
virtual void calculate_transformation ()
 Initialize the PolnCalibration::transformation attribute.
void create_model ()
 Create the model array.
virtual void init_model (unsigned ichan)
 Initialize the SignalPath of the specified channel.
virtual void init_estimates (std::vector< SourceEstimate > &, unsigned ibin=0)
 Initialize a vector of SourceEstimate instances.
virtual void print_input_failed (const std::vector< SourceEstimate > &)
 Report on input data failure rates.
virtual void close_input_failed ()
virtual void prepare_calibrator_estimate (Signal::Source)
 Prepare any calibrator estimates.
virtual void create_calibrator_estimate ()
 Create the calibrator estimate.
virtual void copy_calibrator_estimate ()
 Copy the calibrator estimates from sharing partner.
virtual void submit_calibrator_data ()
virtual void submit_calibrator_data (Calibration::CoherencyMeasurementSet &, const Calibration::SourceObservation &)
virtual void integrate_calibrator_data (const Calibration::SourceObservation &)
virtual void integrate_calibrator_solution (const Calibration::SourceObservation &)
virtual void load_calibrators ()
 Load any postponed calibrators and those set by set_calibrators.
virtual void add_pulsar (const Archive *data, unsigned isub)
 Add the data from the specified sub-integration.
virtual void add_pulsar (Calibration::CoherencyMeasurementSet &, const Integration *, unsigned ichan)=0
 Add pulsar data constraints to coherency measurement set.
virtual void integrate_pulsar_data (const Calibration::CoherencyMeasurementSet &)
 add pulsar data to mean estimate used as initial guess
virtual void submit_pulsar_data ()
 add all pulsar data constraints to measurement equation
virtual void submit_pulsar_data (Calibration::CoherencyMeasurementSet &)
 add the given pulsar observations to measurement equation constraints
virtual double get_invariant (Integration *subint, unsigned ichan)=0
 Return the invariant for the specified integration and frequency channel.
virtual void solve_prepare ()
 Prepare the measurement equations for fitting.
void configure (MEAL::Function *equation)
 Configure a measurement equation.
virtual void export_prepare () const =0
 Prepare to export the solution in current state; e.g. for plotting.
bool get_prepared () const
 Get the state of the prepared flag.
Solver * get_solver (unsigned ichan)
 Return the transformation for the specified channel.
void resolve (unsigned ichan)
 Solve the specified channel after copying a good solution from another.
void check_ichan (const char *name, unsigned ichan) const
 ensure that ichan < model.size()
virtual void load_previous ()
 Load any previous solutions.
Protected Member Functions inherited from Pulsar::PolnCalibrator
void setup_transformation () const
 Set up to call calculate_transformation.
float get_weight (unsigned ichan) const
 Return the weight (0 or 1) of the specified channel.
virtual unsigned get_maximum_nchan () const
 Derived classes may be able to shrink the transformation array.
Protected Member Functions inherited from Pulsar::Calibrator
void copy_variation (Calibrator *)
void set_variation (Variation *var)
const Archive * get_calibrator () const
 Provide derived classes with access to the calibrator.
Archive * get_calibrator ()
 Provide derived classes with mutable access to the calibrator.
bool has_calibrator () const
 Return true if the calibrator attribute has been set.
Protected Member Functions inherited from Reference::Able
Handle * __reference (bool active) const
void __dereference (bool auto_delete=true) const

Protected Attributes

bool match_check_nchan
std::string mismatch_reason
Reference::To< SystemCalibrator > partner
 SystemCalibrator with whom common reception model is shared.
std::string instance_name
Reference::Vector< Calibration::SignalPath > model
 The standard calibration model as a function of frequency.
std::vector< std::string > equation_configuration
 Meausrement equation configuration options.
Reference::To< Solver > solver
 The algorithm used to solve the measurement equation.
Reference::To< const FluxCalibrator > flux_calibrator
 The FluxCalibrator solution.
Reference::To< VariableTransformationManager > projection
 The projection transformation (overrides ProjectionCorrection)
Reference::To< VariableFaradayRotation > faraday_rotation
 The ionospheric and interstellar Faraday rotation transformation.
Reference::To< const CalibratorStokes > calibrator_stokes
 The CalibratorStokesExtension of the Archive passed during construction.
Reference::To< MEAL::Complex2 > response
 Response transformation.
std::vector< unsigned > response_fixed
 Indeces of response parameters to be held fixed.
Reference::To< MEAL::Real4 > impurity
 Impurity transformation.
std::map< unsigned, Reference::To< UniScalar > > response_variation
 Temporal variation of response parameters.
Reference::To< UniScalar > gain_variation
 Time variation of absolute gain.
Reference::To< UniScalar > diff_gain_variation
 Time variation of differential gain.
Reference::To< UniScalar > diff_phase_variation
 Time variation of differential phase.
std::vector< MJD > gain_steps
std::vector< MJD > diff_gain_steps
std::vector< MJD > diff_phase_steps
Reference::To< const MEAL::Complex2 > foreach_calibrator
 Transformation cloned for each calibrator observation.
Reference::To< const Calibration::VariableBackend > stepeach_calibrator
 Step in backend response at each calibrator observation.
std::vector< std::ofstream * > input_failed
bool data_submitted
 Flag set when data have been integrated with measurement equation.
std::vector< std::vector< Calibration::SourceObservation > > calibrator_data
 Calibrator data loaded but not submitted or integrated.
Reference::To< StepFinder > step_finder
std::vector< std::vector< Calibration::CoherencyMeasurementSet > > pulsar_data
 Pulsar data loaded but not submitted or integrated.
std::vector< std::string > calibrator_filenames
 The calibrators to be loaded after first pulsar observation.
Reference::To< Processor > calibrator_preprocessor
 The calibrator pre-processor.
std::vector< Reference::To< Calibration::SourceEstimate > > calibrator_estimate
 Uncalibrated estimate of calibrator polarization.
MJD start_epoch
 Epoch of the first observation.
MJD end_epoch
 Epoch of the last observation.
bool step_after_cal
 Apply time step after rather than before cals.
bool normalize_by_invariant
 Normalize pulsar Stokes parameters by the invariant interval.
bool normalize_calibrated_by_invariant = false
 Normalize pulsar Stokes parameters by the invariant interval.
bool solve_in_reverse_channel_order
 Solve measurement equations in reverse channel order.
bool correct_interstellar_Faraday_rotation
 Include a correction for Faraday rotation in the ISM.
bool refcal_through_frontend
 True if noise diode illuminates feed; false if coupled after OMT.
bool guess_physical_calibrator_stokes
 Ensure that first guess of calibrator Stokes parameters is physical.
float retry_chisq
 The maximum reduced chisq before another fit will be attempted.
float invalid_chisq
 The maximum reduced chisq before a fit will be flagged invalid.
bool report_projection
 Report on the projection transformation used in add_pulsar.
bool report_initial_state
 Report the initial state of model before fitting.
bool report_input_data
 Report on the data included as constraints.
bool report_input_failed
 Report the number of input failures.
bool report_data_and_model
 Report on the data and model before and after the fit.
bool report_total_invariant = false
 Report on the total invariant used to normalize each profile.
double cal_outlier_threshold
 Threshold used to reject outliers when computing CAL levels.
double cal_intensity_threshold
 Threshold used to reject CAL observations with no signal.
double cal_polarization_threshold
 Minimum degree of polarization of CAL observations.
BatchQueue queue
 Controls the number of channels that may be simultaneously solved.
unsigned get_data_fail
unsigned get_data_call
Reference::To< const PolnCalibrator > previous
 Previous solution of the frontend from which to copy initial guess.
Reference::To< const CalibratorStokes > previous_cal
 Previous solution of the calibrator Stokes parameters from which to copy initial guess.
bool previous_loaded = false
 Flag set after previous solutions are loaded.
bool has_pulsar = false
 Flag set after the first pulsar observation is added.
Jones< double > invert_basis
 Transformation that inverts the receptor basis.
std::ofstream invint_out
 File to which total invariant will be written.
Protected Attributes inherited from Pulsar::PolnCalibrator
std::vector< std::vector< double > > covariance
 The array of covariance matrix vectors.
std::vector< Jones< float > > response
 The array of Jones matrices derived from the transformation array.
Reference::To< const PolnCalibratorExtension > poln_extension
 The PolnCalibratorExtension of the Archive passed during construction.
Reference::To< const FeedExtension > feed
 The FeedExtension of the Archive passed during construction.
bool built
 Flag set when response has been built.
unsigned observation_nchan
 The number of frequency channels in the observation to be calibrated.
bool do_backend_correction
 Perform backend corrections before inverting.
Index subint
 The sub-integration from which to construct a solution.
Protected Attributes inherited from Pulsar::Calibrator
Reference::To< Type > type
 The type of the Calibrator.
Reference::To< Variation > variation
 Updates model parameters.
Reference::To< const CalibratorExtension > extension
 The CalibratorExtension of the Archive passed during construction.
std::vector< std::string > filenames
 Filenames of Pulsar::Archives from which instance was created.

Friends

class SystemCalibratorManager
class SystemCalibratorPlotter
class MatrixTemplateMatching

Additional Inherited Members

Static Public Member Functions inherited from Pulsar::Calibrator
static unsigned get_instance_count ()
 Returns the number of Calibrator instances currently in existence.
Static Public Member Functions inherited from Reference::Able
static size_t get_instance_count ()
Static Public Member Functions inherited from Reference::HeapTracked
static void * operator new (size_t size, void *ptr=0)
static void operator delete (void *location, void *ptr)
static void operator delete (void *location)
static size_t get_heap_queue_size ()
Static Public Attributes inherited from Pulsar::PolnCalibrator
static Option< double > minimum_determinant
 Minimum allowable determinant of Jones matrices.
Static Public Attributes inherited from Pulsar::Calibrator
static unsigned verbose = 0
 Verbosity level.
static Pulsar::Option< float > median_smoothing
 Fractional bandwidth of the window used in median filter.
static Pulsar::Option< float > interpolating
 Fractional bandwidth over which interpolation will be performed.
static Pulsar::Option< float > det_threshold
 Tolerance to non-physical values of the coherency matrix.

Detailed Description

PolnCalibrator with estimated calibrator Stokes parameters.

The SystemCalibrator is the virtual base class of polarization calibrators that determine both the instrumental response and the input Stokes parameters of a reference signal (e.g. noise diode).

Each SystemCalibrator instance manages the observations of a single pulsar, its reference source (e.g. noise diode), and a flux calibrator.

Multiple pulsars are managed by multiple SystemCalibrator instances that share a reception model and a common set of polarimetric transformations.

Constructor & Destructor Documentation

◆ SystemCalibrator()

SystemCalibrator::SystemCalibrator ( Archive * archive = 0)

Construct with optional processed calibrator Archive.

If a Archive is provided, and if it contains a SystemCalibratorExtension, then the constructed instance can be used to calibrate other Archive instances.

References cal_intensity_threshold, cal_outlier_threshold, cal_polarization_threshold, data_submitted, faraday_rotation, guess_physical_calibrator_stokes, has_pulsar, invalid_chisq, normalize_by_invariant, projection, refcal_through_frontend, report_data_and_model, report_initial_state, report_input_data, report_input_failed, report_projection, retry_chisq, set_calibrator(), solve_in_reverse_channel_order, and step_after_cal.

Referenced by share(), SystemCalibrator(), and Pulsar::SystemCalibrator::Unloader::unload().

Member Function Documentation

◆ add_calibrator() [1/2]

void SystemCalibrator::add_calibrator ( const Archive * data)
virtual

Add the calibrator observation to the set of constraints.

Add the specified pulsar observation to the set of constraints.

References add_calibrator(), cal_outlier_threshold, calibrator_filenames, Pulsar::Calibrator::get_calibrator(), Pulsar::Archive::get_filename(), get_nchan(), has_pulsar, Pulsar::PolnCalibrator::has_Receiver(), Pulsar::PolnCalibrator::set_Receiver(), Pulsar::Calibrator::type, and Pulsar::Calibrator::verbose.

Referenced by Pulsar::PulsarCalibrator::add_calibrator(), add_calibrator(), add_observation(), and load_calibrators().

◆ add_calibrator() [2/2]

void SystemCalibrator::add_calibrator ( const ReferenceCalibrator * polncal)
virtual

Add the ReferenceCalibrator observation to the set of constraints.

Reimplemented in Pulsar::PulsarCalibrator.

References cal_intensity_threshold, cal_outlier_threshold, cal_polarization_threshold, calibrator_data, calibrator_match(), check_ichan(), Pulsar::ReferenceCalibrator::clone(), Signal::Coherence, create_model(), flux_calibrator, Signal::FluxCalOff, Signal::FluxCalOn, Pulsar::Calibrator::get_Archive(), Pulsar::Calibrator::get_calibrator(), Pulsar::Integration::get_epoch(), Estimate< typename T, typename U >::get_error(), Pulsar::Archive::get_filename(), Pulsar::IntegrationManager::get_Integration(), Pulsar::ReferenceCalibrator::get_levels(), get_nchan(), Pulsar::Archive::get_npol(), Pulsar::IntegrationManager::get_nsubint(), Pulsar::Archive::get_source(), Pulsar::Archive::get_state(), Pulsar::Archive::get_type(), Estimate< typename T, typename U >::get_value(), Pulsar::Integration::get_weight(), model, Signal::PolnCal, prepare_calibrator_estimate(), response, Pulsar::Calibrator::verbose, and Pulsar::IntegrationManager::verbose.

◆ add_pulsar() [1/3]

virtual void Pulsar::SystemCalibrator::add_pulsar ( Calibration::CoherencyMeasurementSet & ,
const Integration * ,
unsigned ichan )
protectedpure virtual

Add pulsar data constraints to coherency measurement set.

Derived types must define how pulsar data are incorporated

Implemented in Pulsar::PulsarCalibrator, Pulsar::ReceptionCalibrator, and ReceptionCalibrator.

◆ add_pulsar() [2/3]

void SystemCalibrator::add_pulsar ( const Archive * data)
virtual

Add the pulsar observation to the set of constraints.

Add the specified pulsar observation to the set of constraints.

References add_pulsar(), Pulsar::Archive::get_nchan(), Pulsar::IntegrationManager::get_nsubint(), Pulsar::PolnCalibrator::has_Receiver(), prepare(), Pulsar::PolnCalibrator::set_Receiver(), and Pulsar::Calibrator::verbose.

Referenced by add_observation(), Pulsar::PulsarCalibrator::add_pulsar(), add_pulsar(), and add_pulsar().

◆ add_pulsar() [3/3]

void SystemCalibrator::add_pulsar ( const Archive * data,
unsigned isub )
protectedvirtual

Add the data from the specified sub-integration.

Add the specified pulsar observation to the set of constraints.

Reimplemented in Pulsar::PulsarCalibrator.

References Calibration::CoherencyMeasurementSet::add_coordinate(), add_epoch(), add_pulsar(), correct_interstellar_Faraday_rotation, faraday_rotation, Pulsar::Archive::get_centre_frequency(), Error::get_code(), Pulsar::Integration::get_epoch(), Pulsar::Archive::get_filename(), Pulsar::IntegrationManager::get_Integration(), Pulsar::Integration::get_nchan(), Pulsar::Archive::get_rotation_measure(), Pulsar::Archive::get_source(), Pulsar::Integration::get_weight(), model, projection, pulsar_data, report_projection, Calibration::CoherencyMeasurementSet::set_epoch(), Calibration::CoherencyMeasurementSet::set_ichan(), Calibration::CoherencyMeasurementSet::set_identifier(), Calibration::CoherencyMeasurementSet::set_name(), and Pulsar::Calibrator::verbose.

◆ calculate_transformation()

void SystemCalibrator::calculate_transformation ( )
protectedvirtual

Initialize the PolnCalibration::transformation attribute.

Retrieves the transformation from the standard model in each channel

Reimplemented from Pulsar::PolnCalibrator.

References get_nchan(), get_transformation(), get_valid(), model, Pulsar::PolnCalibrator::set_transformation(), and Pulsar::PolnCalibrator::set_transformation_invalid().

◆ calibrator_match()

bool SystemCalibrator::calibrator_match ( const Archive * data,
std::string & reason_for_not_matching )
virtual

Return true if this calibrator can be applied to the data.

Reimplemented in Pulsar::PulsarCalibrator.

References Pulsar::Archive::calibrator_match(), and Pulsar::Calibrator::get_calibrator().

Referenced by add_calibrator(), and precalibrate().

◆ export_prepare()

virtual void Pulsar::SystemCalibrator::export_prepare ( ) const
protectedpure virtual

Prepare to export the solution in current state; e.g. for plotting.

Implemented in Pulsar::PulsarCalibrator, Pulsar::ReceptionCalibrator, and ReceptionCalibrator.

Referenced by get_Info().

◆ get_epoch()

MJD SystemCalibrator::get_epoch ( ) const
virtual

Return the reference epoch of the calibration experiment.

Reimplemented from Pulsar::Calibrator.

References end_epoch, and start_epoch.

Referenced by solve(), Pulsar::PulsarCalibrator::solve1(), and solve_prepare().

◆ get_Info()

Calibrator::Info * SystemCalibrator::get_Info ( ) const
virtual

Return the Calibrator information.

Reimplemented from Pulsar::PolnCalibrator.

References export_prepare(), and Pulsar::PolnCalibrator::get_Info().

◆ get_invariant()

virtual double Pulsar::SystemCalibrator::get_invariant ( Integration * subint,
unsigned ichan )
protectedpure virtual

Return the invariant for the specified integration and frequency channel.

Implemented in Pulsar::PulsarCalibrator, Pulsar::ReceptionCalibrator, and ReceptionCalibrator.

References Pulsar::PolnCalibrator::subint.

Referenced by precalibrate().

◆ get_nchan()

unsigned SystemCalibrator::get_nchan ( ) const
virtual

Get the number of frequency channels.

Reimplemented from Pulsar::PolnCalibrator.

References Pulsar::Calibrator::get_calibrator(), Pulsar::Archive::get_nchan(), Pulsar::Calibrator::has_calibrator(), model, and Pulsar::Calibrator::verbose.

Referenced by add_calibrator(), add_calibrator(), calculate_transformation(), create_calibrator_estimate(), create_model(), get_CalibratorStokes(), Pulsar::PulsarCalibrator::get_nchan(), init_estimates(), Pulsar::SystemCalibratorManager::precalibrate(), Pulsar::ReceptionCalibrator::prepare_calibrator_estimate(), Pulsar::SystemCalibratorManager::preprocess(), resolve(), Pulsar::SystemCalibratorManager::setup_sharing(), solve(), Pulsar::ReceptionCalibrator::submit_calibrator_data(), and Pulsar::UnloadJones::unload().

◆ get_nstate()

unsigned SystemCalibrator::get_nstate ( ) const
virtual

Get the total number of input polarization states (pulsar and cal)

Get the total number of input polarization states.

References model.

◆ get_nstate_pulsar()

unsigned SystemCalibrator::get_nstate_pulsar ( ) const
virtual

Get the number of pulsar polarization states in the model.

Reimplemented in Pulsar::PulsarCalibrator, Pulsar::ReceptionCalibrator, and ReceptionCalibrator.

◆ get_solver()

const Calibration::ReceptionModel::Solver * SystemCalibrator::get_solver ( unsigned ichan) const
virtual

Return the solver for the specified channel.

Return the transformation for the specified channel.

Reimplemented from Pulsar::PolnCalibrator.

References check_ichan(), and model.

◆ get_transformation()

MEAL::Complex2 * SystemCalibrator::get_transformation ( const Archive * data,
unsigned isub,
unsigned ichan )
virtual

Return the transformation to be used for precalibration.

Reimplemented in Pulsar::PulsarCalibrator.

References Pulsar::Integration::get_epoch(), Pulsar::IntegrationManager::get_Integration(), get_transformation(), and Pulsar::Archive::get_type().

Referenced by calculate_transformation(), Pulsar::PulsarCalibrator::get_transformation(), get_transformation(), precalibrate(), and submit_pulsar_data().

◆ get_valid()

bool SystemCalibrator::get_valid ( unsigned ichan) const
virtual

Return true if the model for the specified channel is valid.

Reimplemented from Pulsar::PolnCalibrator.

References model.

Referenced by calculate_transformation(), get_reduced_chisq(), has_valid(), init_estimates(), load_calibrators(), precalibrate(), Pulsar::SystemCalibratorManager::precalibrate(), Pulsar::ReceptionCalibrator::prepare_calibrator_estimate(), resolve(), solve(), Pulsar::ReceptionCalibrator::solve_prepare(), solve_prepare(), Pulsar::ReceptionCalibrator::submit_calibrator_data(), and Pulsar::ReceptionCalibrator::valid_mask().

◆ has_solver()

bool SystemCalibrator::has_solver ( ) const
virtual

Return true if least squares minimization solvers are available.

Reimplemented from Pulsar::PolnCalibrator.

◆ init_model()

void SystemCalibrator::init_model ( unsigned ichan)
protectedvirtual

Initialize the SignalPath of the specified channel.

Reimplemented in Pulsar::PulsarCalibrator, Pulsar::ReceptionCalibrator, and ReceptionCalibrator.

References add_diff_gain_step(), add_diff_phase_step(), add_gain_step(), Calibration::ReceptionModel::add_postfit_report(), Calibration::ReceptionModel::add_prefit_report(), diff_gain_variation, diff_phase_variation, faraday_rotation, foreach_calibrator, gain_variation, impurity, model, Pulsar::new_transformation(), partner, projection, refcal_through_frontend, report_data_and_model, report_initial_state, report_input_data, response, response_fixed, response_variation, set_refcal_through_frontend(), solver, stepeach_calibrator, Pulsar::Calibrator::type, and Pulsar::Calibrator::verbose.

Referenced by create_model(), Pulsar::PulsarCalibrator::init_model(), and Pulsar::ReceptionCalibrator::init_model().

◆ integrate_pulsar_data()

virtual void Pulsar::SystemCalibrator::integrate_pulsar_data ( const Calibration::CoherencyMeasurementSet & )
inlineprotectedvirtual

add pulsar data to mean estimate used as initial guess

Reimplemented in Pulsar::ReceptionCalibrator, and ReceptionCalibrator.

Referenced by submit_pulsar_data().

◆ match()

bool SystemCalibrator::match ( const Archive * data,
bool throw_exception = true )
virtual

Ensure that the pulsar observation can be added to the data set.

By default, will throw exception

If the data do not match the calibrator

  • if throw_exception is true, throw an exception
  • otherwise, return false

Reimplemented in Pulsar::PulsarCalibrator, Pulsar::ReceptionCalibrator, and ReceptionCalibrator.

References Pulsar::Calibrator::get_calibrator(), Pulsar::Archive::get_filename(), Pulsar::Archive::get_source(), Pulsar::Calibrator::has_calibrator(), match(), and Pulsar::Calibrator::verbose.

Referenced by Pulsar::ReceptionCalibrator::match(), match(), and prepare().

◆ new_info_pulsar()

Calibrator::Info * SystemCalibrator::new_info_pulsar ( unsigned istate) const
virtual

Return a new plot information interface for the specified pulsar state.

Retern a new plot information interface for the specified pulsar state.

Reimplemented in Pulsar::ReceptionCalibrator, and ReceptionCalibrator.

◆ precalibrate()

void SystemCalibrator::precalibrate ( Archive * archive)
virtual

Pre-calibrate the polarization of the given archive.

Calibrate the polarization of the given archive.

References calibrator_match(), Pulsar::Integration::expert(), faraday_rotation, Pulsar::Archive::get(), Pulsar::Calibrator::get_calibrator(), Pulsar::Integration::get_epoch(), Pulsar::Archive::get_filename(), Pulsar::IntegrationManager::get_Integration(), get_invariant(), Error::get_message(), Pulsar::Archive::get_nchan(), Pulsar::IntegrationManager::get_nsubint(), get_transformation(), Pulsar::PolnCalibrator::get_transformation_valid(), get_valid(), Pulsar::Archive::getadd(), Pulsar::Integration::getadd(), invint_out, model, normalize_calibrated_by_invariant, preprocess(), projection, Signal::ReferenceFluxDensity, response, Pulsar::Archive::set_faraday_corrected(), Pulsar::Archive::set_poln_calibrated(), Pulsar::Receiver::set_projection_corrected(), Pulsar::Archive::set_scale(), Pulsar::Integration::set_weight(), MEAL::sqrt(), Pulsar::Integration::Expert::transform(), and Pulsar::Calibrator::verbose.

Referenced by Pulsar::SystemCalibratorManager::precalibrate().

◆ prepare_calibrator_estimate()

void SystemCalibrator::prepare_calibrator_estimate ( Signal::Source s)
protectedvirtual

Prepare any calibrator estimates.

Reimplemented in Pulsar::ReceptionCalibrator, and ReceptionCalibrator.

References calibrator_estimate, copy_calibrator_estimate(), create_calibrator_estimate(), partner, and Pulsar::Calibrator::verbose.

Referenced by add_calibrator(), and Pulsar::ReceptionCalibrator::prepare_calibrator_estimate().

◆ set_calibrator()

void SystemCalibrator::set_calibrator ( const Archive * archive)
virtual

Set the calibrator.

Reimplemented from Pulsar::PolnCalibrator.

References calibrator_stokes, Pulsar::Calibrator::extension, and Pulsar::PolnCalibrator::set_calibrator().

Referenced by Pulsar::ReceptionCalibrator::initial_observation(), Pulsar::PulsarCalibrator::set_standard(), and SystemCalibrator().

◆ set_foreach_calibrator()

void SystemCalibrator::set_foreach_calibrator ( const MEAL::Complex2 * x)
virtual

Prepare the data for inclusion in the model Set the transformation to be cloned for each calibrator

References foreach_calibrator.

◆ set_normalize_by_invariant()

void SystemCalibrator::set_normalize_by_invariant ( bool flag = true)
virtual

Normalize each pulsar Stokes vector by the mean on-pulse invariant.

Reimplemented in Pulsar::ReceptionCalibrator, and ReceptionCalibrator.

References normalize_by_invariant.

◆ share()

void SystemCalibrator::share ( SystemCalibrator * other)
virtual

Share reception model and common transformations of other instance.

Common transformations are experienced by all sources.

References partner, and SystemCalibrator().

Referenced by Pulsar::SystemCalibratorManager::manage().

◆ solve_prepare()

void SystemCalibrator::solve_prepare ( )
protectedvirtual

Prepare the measurement equations for fitting.

Reimplemented in Pulsar::ReceptionCalibrator, and ReceptionCalibrator.

References calibrator_estimate, configure(), data_submitted, get_epoch(), Estimate< typename T, typename U >::get_error(), get_ndata(), get_solver(), get_valid(), Estimate< typename T, typename U >::get_value(), invint_out, model, normalize_calibrated_by_invariant, previous_cal, print_input_failed(), report_input_failed, report_total_invariant, MEAL::LeastSquares::set_debug(), submit_pulsar_data(), and Pulsar::Calibrator::verbose.

Referenced by Pulsar::PulsarCalibrator::export_prepare(), solve(), and Pulsar::ReceptionCalibrator::solve_prepare().

◆ submit_calibrator_data()

void SystemCalibrator::submit_calibrator_data ( )
protectedvirtual

Reimplemented in Pulsar::ReceptionCalibrator, and ReceptionCalibrator.

The documentation for this class was generated from the following files:
Generated using doxygen 1.14.0