Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Pulsar::Calibrator Class Referenceabstract

Polarization and flux calibrators. More...

#include <Calibrator.h>

Inheritance diagram for Pulsar::Calibrator:
Reference::Able Reference::HeapTracked Pulsar::FluxCalibrator Pulsar::FrontendCorrection Pulsar::IonosphereCalibrator Pulsar::PolnCalibrator Pulsar::HybridCalibrator Pulsar::ManualPolnCalibrator Pulsar::ReferenceCalibrator Pulsar::SystemCalibrator Pulsar::PolarCalibrator Pulsar::SingleAxisCalibrator Pulsar::PulsarCalibrator Pulsar::ReceptionCalibrator Pulsar::DoPCalibrator Pulsar::OffPulseCalibrator

Classes

class  Info
class  Type
class  Variation
 Abstract base of classes that update model parameters. More...

Public Member Functions

 Calibrator ()
 Default constructor.
virtual ~Calibrator ()
 Destructor.
virtual void calibrate (Archive *archive)=0
 Calibrate the Pulsar::Archive.
virtual const Type * get_type () const
 Return the Calibrator::Type of derived class.
virtual unsigned get_nchan () const =0
 Get the number of frequency channels in the calibrator.
virtual float get_weight (unsigned ichan) const =0
 Get the weight associated with the specified channel.
virtual CalibratorExtension * new_Extension () const =0
 Return a new Calibrator Extension.
Archive * new_solution (const std::string &archive_class) const
 Return a new processed calibrator Archive with a CalibratorExtension.
virtual MJD get_epoch () const
 Return the reference epoch of the calibration experiment.
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.
virtual Info * get_Info () const
 Return the Calibrator::Info information.
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

Static Public Member Functions

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

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.

Protected Member Functions

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.
virtual void set_calibrator (const Archive *archive)
 Provide derived classes with 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

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.

Detailed Description

Polarization and flux calibrators.

Member Function Documentation

◆ calibrate()

virtual void Pulsar::Calibrator::calibrate ( Archive * archive)
pure virtual

Calibrate the Pulsar::Archive.

Implemented in FluxCalibrator, Pulsar::DoPCalibrator, Pulsar::FluxCalibrator, Pulsar::FrontendCorrection, Pulsar::IonosphereCalibrator, Pulsar::ManualPolnCalibrator, Pulsar::OffPulseCalibrator, and Pulsar::PolnCalibrator.

Referenced by Pulsar::DoPCalibrator::calibrate(), and Pulsar::OffPulseCalibrator::calibrate().

◆ get_epoch()

MJD Pulsar::Calibrator::get_epoch ( ) const
virtual

Return the reference epoch of the calibration experiment.

Reimplemented in Pulsar::HybridCalibrator, and Pulsar::SystemCalibrator.

References extension.

Referenced by Pulsar::ManualPolnCalibrator::match().

◆ get_Info()

virtual Info * Pulsar::Calibrator::get_Info ( ) const
inlinevirtual

Return the Calibrator::Info information.

By default, derived classes need not necessarily define Info

Reimplemented in FluxCalibrator, Pulsar::DoPCalibrator, Pulsar::FluxCalibrator, Pulsar::PolarCalibrator, Pulsar::PolnCalibrator, Pulsar::SingleAxisCalibrator, and Pulsar::SystemCalibrator.

◆ get_nchan()

virtual unsigned Pulsar::Calibrator::get_nchan ( ) const
pure virtual

Get the number of frequency channels in the calibrator.

Implemented in FluxCalibrator, Pulsar::FluxCalibrator, Pulsar::FrontendCorrection, Pulsar::HybridCalibrator, Pulsar::IonosphereCalibrator, Pulsar::PolnCalibrator, Pulsar::PulsarCalibrator, and Pulsar::SystemCalibrator.

◆ get_type()

const Pulsar::Calibrator::Type * Pulsar::Calibrator::get_type ( ) const
virtual

Return the Calibrator::Type of derived class.

Reimplemented in Pulsar::PolnCalibrator.

References type.

Referenced by Pulsar::FluxCalibrator::add_observation().

◆ get_weight()

virtual float Pulsar::Calibrator::get_weight ( unsigned ichan) const
pure virtual

Get the weight associated with the specified channel.

Implemented in FluxCalibrator, Pulsar::FluxCalibrator, Pulsar::FrontendCorrection, Pulsar::IonosphereCalibrator, and Pulsar::PolnCalibrator.

◆ has_calibrator()

bool Pulsar::Calibrator::has_calibrator ( ) const
protected

Return true if the calibrator attribute has been set.

Provide derived classes with access to the calibrator.

Referenced by Pulsar::FluxCalibrator::add_observation(), Pulsar::ReceptionCalibrator::add_state(), Pulsar::FluxCalibrator::calibration_setup(), Pulsar::FluxCalibrator::create(), Pulsar::SystemCalibrator::get_nchan(), Pulsar::ReceptionCalibrator::match(), Pulsar::SystemCalibrator::match(), and Pulsar::FluxCalibrator::print().

◆ new_Extension()

virtual CalibratorExtension * Pulsar::Calibrator::new_Extension ( ) const
pure virtual

Return a new Calibrator Extension.

Implemented in FluxCalibrator, Pulsar::FluxCalibrator, Pulsar::FrontendCorrection, Pulsar::IonosphereCalibrator, and Pulsar::PolnCalibrator.

Referenced by new_solution().

◆ set_calibrator()

void Pulsar::Calibrator::set_calibrator ( const Archive * archive)
protectedvirtual

Provide derived classes with access to the calibrator.

Reimplemented in Pulsar::PolnCalibrator, Pulsar::ReferenceCalibrator, and Pulsar::SystemCalibrator.

Referenced by Pulsar::FluxCalibrator::add_observation(), Pulsar::FluxCalibrator::FluxCalibrator(), and Pulsar::PolnCalibrator::set_calibrator().

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