Polarimetric calibrators. More...

#include <PolnCalibrator.h>

Inheritance diagram for Pulsar::PolnCalibrator:

Public Member Functions
	PolnCalibrator (const Archive *archive=0)
	Construct with optional processed calibrator Archive.
	PolnCalibrator (const PolnCalibrator &calibrator)
	Copy constructor.
virtual	~PolnCalibrator ()
	Destructor.
void	set_calibrator (const Archive *archive)
	Set the calibrator archive used to define basic attributes.
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.
virtual bool	has_solver () const
	Return true if least squares minimization solvers are available.
virtual const MEAL::LeastSquares *	get_solver (unsigned ichan) const
	Return the transformation 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.
virtual unsigned	get_nchan () const
	Get the number of frequency channels in the calibrator.
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.
Calibrator::Info *	get_Info () const
	Return plotting information.
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 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.
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 Attributes
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.

Protected Member Functions
void	setup_transformation () const
	Set up to call calculate_transformation.
virtual void	calculate_transformation ()
	Derived classes can create and fill the transformation array.
virtual bool	get_valid (unsigned ichan) const
	Derived classes can add conditions for channel validity.
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
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.

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 ()

Detailed Description

Polarimetric calibrators.

The calibrated archive will have its flux normalized by the calibrator flux, such that the FluxCalibrator class need only multiply the archive by the absolute calibrator flux. Polarimetric calibration does not require a flux calibrator in order to work.

Constructor & Destructor Documentation

◆ PolnCalibrator()

Pulsar::PolnCalibrator::PolnCalibrator ( const Archive * archive = 0 )

Construct with optional processed calibrator Archive.

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

References Pulsar::Calibrator::extension, Pulsar::Calibrator::filenames, poln_extension, and set_calibrator().

Referenced by get_response(), get_response_nchan(), Pulsar::HybridCalibrator::HybridCalibrator(), PolnCalibrator(), Pulsar::ReferenceCalibrator::ReferenceCalibrator(), Pulsar::HybridCalibrator::set_precalibrator(), Pulsar::SystemCalibrator::set_previous_solution(), and setup_transformation().

Member Function Documentation

◆ calculate_transformation()

void Pulsar::PolnCalibrator::calculate_transformation ( )

protectedvirtual

Derived classes can create and fill the transformation array.

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

References covariance, poln_extension, and Pulsar::Calibrator::verbose.

Referenced by setup_transformation().

◆ calibrate()

void Pulsar::PolnCalibrator::calibrate ( Archive * arch )

virtual

Calibrate the polarization of the given archive.

Upon completion, the flux of the archive will be normalized with respect to the flux of the calibrator, such that a FluxCalibrator simply scales the archive by the calibrator flux.

Implements Pulsar::Calibrator.

Reimplemented in Pulsar::DoPCalibrator, Pulsar::ManualPolnCalibrator, and Pulsar::OffPulseCalibrator.

References calibration_setup(), do_backend_correction, Pulsar::Calibrator::filenames, Pulsar::Archive::get(), Pulsar::IntegrationManager::get_Integration(), Pulsar::Archive::get_nchan(), Pulsar::Archive::get_npol(), Pulsar::IntegrationManager::get_nsubint(), get_type(), Pulsar::Profile::get_weight(), Pulsar::Archive::getadd(), Signal::ReferenceFluxDensity, response, Pulsar::Receiver::set_basis_corrected(), Pulsar::Archive::set_poln_calibrated(), Pulsar::Archive::set_scale(), subint, Pulsar::Calibrator::variation, Pulsar::Calibrator::verbose, and Pulsar::IntegrationManager::verbose.

◆ get_Info()

Pulsar::Calibrator::Info * Pulsar::PolnCalibrator::get_Info ( ) const

virtual

Return plotting information.

Reimplemented from Pulsar::Calibrator.

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

Referenced by Pulsar::CorrelationInfo::CorrelationInfo(), and Pulsar::SystemCalibrator::get_Info().

◆ get_maximum_nchan()

unsigned Pulsar::PolnCalibrator::get_maximum_nchan ( ) const

protectedvirtual

Derived classes may be able to shrink the transformation array.

Some calibrators (e.g. HybridCalibrator) may be capable of shrinking the size of the transformation array to match the number of frequency channels in the observation. If this is done, and the next observation to be calibrated has more channels than the first, then the transformation array should be recomputed to match the new frequency resolution.

However, to date, the decision to recompute the transformation array has been based on it having zero size. It is not possible to compare tranformation.size() with get_nchan(), because PolnCalibrator::get_nchan makes the same comparison and returns transformation.size().

Rather than add a new method that must be implemented by all of the derived classes, this new method gives shrink-capable classes the opportunity to communicate this feature.

By default, the method returns zero. Otherwise, it should return the maximum possible size of the transformation array that can be supported.

Reimplemented in Pulsar::HybridCalibrator.

◆ get_nchan()

unsigned Pulsar::PolnCalibrator::get_nchan ( ) const

virtual

Get the number of frequency channels in the calibrator.

Implements Pulsar::Calibrator.

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

References get_nchan().

Referenced by Pulsar::PulsarCalibrator::add_pulsar(), Pulsar::DoPCalibrator::extra(), Pulsar::HybridCalibrator::get_nchan(), get_nchan(), get_solver(), has_covariance(), Pulsar::PulsarCalibrator::setup(), Pulsar::PulsarCalibrator::solve1(), and Pulsar::PulsarCalibrator::update_solution().

◆ get_solver()

const MEAL::LeastSquares * Pulsar::PolnCalibrator::get_solver ( unsigned ichan ) const

virtual

Return the transformation for the specified channel.

Reimplemented in Pulsar::SystemCalibrator.

References Pulsar::PolnCalibratorExtension::Transformation::get_chisq(), get_nchan(), Pulsar::PolnCalibratorExtension::Transformation::get_nfit(), Pulsar::PolnCalibratorExtension::Transformation::get_nfree(), has_solver(), and poln_extension.

◆ get_transformation() [1/2]

MEAL::Complex2 * Pulsar::PolnCalibrator::get_transformation ( unsigned ichan )

Return the transformation for the specified channel.

Return the system response for the specified channel.

References setup_transformation().

◆ get_transformation() [2/2]

const::MEAL::Complex2 * Pulsar::PolnCalibrator::get_transformation ( unsigned ichan ) const

Return the transformation for the specified channel.

Return the system response for the specified channel.

References setup_transformation().

Referenced by Pulsar::PulsarCalibrator::add_pulsar(), Pulsar::DoPCalibrator::extra(), Pulsar::OffPulseCalibrator::extra(), Pulsar::PulsarCalibrator::setup(), Pulsar::PulsarCalibrator::solve1(), and Pulsar::PulsarCalibrator::update_solution().

◆ get_transformation_valid()

bool Pulsar::PolnCalibrator::get_transformation_valid ( unsigned ch ) const

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

Return the system response for the specified channel.

References setup_transformation().

Referenced by Pulsar::PulsarCalibrator::add_pulsar(), Pulsar::PulsarCalibrator::add_pulsar(), Pulsar::DoPCalibrator::extra(), Pulsar::OffPulseCalibrator::extra(), Pulsar::SystemCalibrator::get_CalibratorStokes(), Pulsar::SystemCalibrator::precalibrate(), Pulsar::PulsarCalibrator::setup(), Pulsar::PulsarCalibrator::solve1(), and Pulsar::PulsarCalibrator::update_solution().

◆ get_type()

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

virtual

Return the Calibrator::Type of derived class.

Reimplemented from Pulsar::Calibrator.

References poln_extension, and Pulsar::Calibrator::type.

Referenced by calibrate().

◆ get_valid()

bool Pulsar::PolnCalibrator::get_valid ( unsigned ichan ) const

protectedvirtual

Derived classes can add conditions for channel validity.

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

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

References response.

Referenced by Pulsar::HybridCalibrator::get_valid(), and get_weight().

◆ get_weight()

float Pulsar::PolnCalibrator::get_weight ( unsigned ichan ) const

protectedvirtual

Return the weight (0 or 1) of the specified channel.

Implements Pulsar::Calibrator.

References get_valid().

◆ has_solver()

bool Pulsar::PolnCalibrator::has_solver ( ) const

virtual

Return true if least squares minimization solvers are available.

Reimplemented in Pulsar::SystemCalibrator.

References poln_extension.

Referenced by get_solver().

◆ new_Extension()

Pulsar::CalibratorExtension * Pulsar::PolnCalibrator::new_Extension ( ) const

virtual

Return a new PolnCalibratorExtension.

Implements Pulsar::Calibrator.

References Pulsar::Calibrator::verbose.

◆ set_calibrator()

void Pulsar::PolnCalibrator::set_calibrator ( const Archive * archive )

virtual

Set the calibrator archive used to define basic attributes.

Reimplemented from Pulsar::Calibrator.

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

References built, feed, has_Receiver(), observation_nchan, Pulsar::Calibrator::set_calibrator(), set_Receiver(), and Pulsar::Calibrator::verbose.

Referenced by Pulsar::PulsarCalibrator::match(), PolnCalibrator(), Pulsar::ReferenceCalibrator::set_calibrator(), Pulsar::SystemCalibrator::set_calibrator(), Pulsar::HybridCalibrator::set_precalibrator(), Pulsar::HybridCalibrator::set_reference_observation(), and set_subint().

◆ set_transformation_invalid()

void Pulsar::PolnCalibrator::set_transformation_invalid	(	unsigned	ch,
		const std::string &	reason )

Set the transformation invalid flag for the specified channel.

Return the system response for the specified channel.

References setup_transformation(), and Pulsar::Calibrator::verbose.

Referenced by Pulsar::HybridCalibrator::calculate_transformation(), Pulsar::ReferenceCalibrator::calculate_transformation(), Pulsar::SystemCalibrator::calculate_transformation(), Pulsar::PulsarCalibrator::setup(), and Pulsar::PulsarCalibrator::solve1().

Member Data Documentation

◆ minimum_determinant

Pulsar::Option< double > Pulsar::PolnCalibrator::minimum_determinant

static

Minimum allowable determinant of Jones matrices.

Set this parameter to avoid unstable inversion of matrices with a determinant close to zero by flagging such channels as invalid.

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

PolnCalibrator.h
PolnCalibrator.C
PolnCalibratorInfo.C

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PolnCalibrator()

Member Function Documentation

◆ calculate_transformation()

◆ calibrate()

◆ get_Info()

◆ get_maximum_nchan()

◆ get_nchan()

◆ get_solver()

◆ get_transformation() [1/2]

◆ get_transformation() [2/2]

◆ get_transformation_valid()

◆ get_type()

◆ get_valid()

◆ get_weight()

◆ has_solver()

◆ new_Extension()

◆ set_calibrator()

◆ set_transformation_invalid()

Member Data Documentation

◆ minimum_determinant