Pulsar::PolnCalibratorExtension Class Reference

Stores PolnCalibrator parameters in an Archive instance. More...

#include <PolnCalibratorExtension.h>

Inheritance diagram for Pulsar::PolnCalibratorExtension:

Classes
class	Transformation
	Intermediate storage of MEAL::Complex parameters. More...

Public Member Functions
	PolnCalibratorExtension ()
	Default constructor.
	PolnCalibratorExtension (const PolnCalibratorExtension &)
	Copy constructor.
const PolnCalibratorExtension &	operator= (const PolnCalibratorExtension &)
	Operator =.
	~PolnCalibratorExtension ()
	Destructor.
PolnCalibratorExtension *	clone () const
	Clone method.
TextInterface::Parser *	get_interface ()
	get the text ineterface
	PolnCalibratorExtension (const PolnCalibrator *)
	Construct from a PolnCalibrator instance.
std::string	get_short_name () const override
	Return a short name.
void	set_type (const Calibrator::Type *type) override
	Set the type of the instrumental response parameterization.
void	set_nchan (unsigned nchan) override
	Set the number of frequency channels.
void	remove_chan (unsigned first, unsigned last) override
	Remove the inclusive range of channels.
void	set_weight (unsigned ichan, float weight) override
	Set the weight of the specified channel.
float	get_weight (unsigned ichan) const override
	Get the weight of the specified channel.
unsigned	get_nparam () const
	Get the number of parameters describing each transformation.
void	set_ndim (unsigned)
	Set the number of abscissa / dimensions in the model.
unsigned	get_ndim () const
	Get the number of abscissa / dimensions in the model.
bool	get_has_covariance () const
	Return true if the covariances of the model parameters are available.
void	set_has_covariance (bool)
	Set true when the covariances of the model parameters are available.
bool	get_has_solver () const
	Return true if information about the solution is available.
void	set_has_solver (bool)
	Return true if information about the solution is available.
bool	get_valid (unsigned ichan) const
	Return true if the transformation for the specified channel is valid.
void	set_valid (unsigned ichan, bool valid)
Transformation *	get_transformation (unsigned c)
	Get the transformation for the specified frequency channel.
const Transformation *	get_transformation (unsigned c) const
	Get the transformation for the specified frequency channel.
void	frequency_append (Archive *to, const Archive *from) override
	Append PolnCalibrator Extension data from another Archive.
void	fscrunch (unsigned factor=0)
void	fscrunch_to_nchan (unsigned new_nchan)
Estimate< float >	get_Estimate (unsigned iparam, unsigned ichan) const
void	set_Estimate (unsigned iparam, unsigned ichan, const Estimate< float > &)
Public Member Functions inherited from Pulsar::CalibratorExtension
	CalibratorExtension (const char *name="CalibratorExtension")
	Default constructor.
	CalibratorExtension (const CalibratorExtension &)
	Copy constructor.
const CalibratorExtension &	operator= (const CalibratorExtension &)
	Operator =.
	~CalibratorExtension ()
	Destructor.
void	build (const Calibrator *)
	Construct from a Calibrator instance.
virtual const Calibrator::Type *	get_type () const
	Get the type of the calibrator.
virtual void	set_epoch (const MJD &epoch)
	Set the reference epoch of the calibration experiment.
virtual MJD	get_epoch () const
	Get the reference epoch of the calibration experiment.
virtual unsigned	get_nchan () const
	Get the number of frequency channels.
virtual void	set_centre_frequency (unsigned ichan, double frequency)
	Set the centre frequency of the specified channel.
virtual double	get_centre_frequency (unsigned ichan) const
	Get the centre frequency of the specified channel.
Public Member Functions inherited from Pulsar::HasChannels
	HasChannels (const char *name)
Public Member Functions inherited from Pulsar::Archive::Extension
	Extension (const char *name)
	Construct with a name.
virtual	~Extension ()
	Destructor.
std::string	get_extension_name () const
	Return the name of the Extension.
virtual bool	has_data () const
	Returns true if the Extension contains useful data.
virtual void	resize (unsigned nsubint, unsigned npol=0, unsigned nchan=0, unsigned nbin=0)
	Resize the Extension.
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 Member Functions
void	construct ()
	Construct the response array according to the current attributes.
Protected Member Functions inherited from Pulsar::CalibratorExtension
void	range_check (unsigned ichan, const char *method) const
	Ensure that ichan < get_nchan.
void	frequency_append (const CalibratorExtension *, bool in_order)
	For use by children.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
std::vector< Transformation >	response
	The instrumental response as a function of frequency.
unsigned	nparam = 0
	The number of parameters that describe the transformation.
unsigned	ndim = 0
	The number of abscissa / dimensions in the model.
bool	has_covariance = false
	The covariances of the transformation parameters are available.
bool	has_solver = false
	The solver statistics are available.
Protected Attributes inherited from Pulsar::CalibratorExtension
Reference::To< const Calibrator::Type >	type
	Type of the calibrator.
MJD	epoch
	The reference epoch of the calibration experiment.
std::vector< float >	weight
	The weight of each channel.
std::vector< double >	centre_frequency
	The centre frequency of each channel.
Protected Attributes inherited from Pulsar::Archive::Extension
std::string	extension_name
	Extension name - useful when debugging.

Additional Inherited Members
Static Public Member Functions inherited from Pulsar::Archive::Extension
static Extension *	factory (const std::string &name)
	Derived type factory.
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

Stores PolnCalibrator parameters in an Archive instance.

This Archive::Extension implements the storage of PolnCalibrator data.

Member Function Documentation

clone()

PolnCalibratorExtension * Pulsar::PolnCalibratorExtension::clone ( ) const

inlinevirtual

Clone method.

Reimplemented from Pulsar::CalibratorExtension.

References PolnCalibratorExtension().

frequency_append()

void PolnCalibratorExtension::frequency_append ( Archive * to, const Archive * from )

overridevirtual

Append PolnCalibrator Extension data from another Archive.

Reimplemented from Pulsar::CalibratorExtension.

References Pulsar::CalibratorExtension::frequency_append(), Pulsar::Archive::get(), has_covariance, has_solver, Pulsar::in_frequency_order(), nparam, PolnCalibratorExtension(), and response.

fscrunch()

void Pulsar::PolnCalibratorExtension::fscrunch

(

unsigned

nscrunch = 0

)

Parameters

nscrunch

number of neighbouring frequency channels to integrate; if zero, then all channels are integrated into one

get_has_solver()

bool PolnCalibratorExtension::get_has_solver

(

)

const

Return true if information about the solution is available.

Get if the covariances of the transformation parameters.

References has_solver.

Referenced by Pulsar::FITSArchive::unload().

get_interface()

TextInterface::Parser * PolnCalibratorExtension::get_interface ( void )

virtual

get the text ineterface

Get the text interface.

Reimplemented from Pulsar::CalibratorExtension.

get_short_name()

std::string Pulsar::PolnCalibratorExtension::get_short_name ( ) const

inlineoverridevirtual

Return a short name.

Reimplemented from Pulsar::CalibratorExtension.

get_valid()

bool PolnCalibratorExtension::get_valid

(

unsigned

ichan

)

const

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

Get the weight of the specified channel.

References Pulsar::CalibratorExtension::range_check(), and response.

Referenced by get_weight(), Pulsar::PolnCalExtFreqIntegrate::transform(), and Pulsar::FITSArchive::unload().

get_weight()

float PolnCalibratorExtension::get_weight ( unsigned ichan ) const

overridevirtual

Get the weight of the specified channel.

Set the weight of the specified channel.

Reimplemented from Pulsar::CalibratorExtension.

References get_valid().

remove_chan()

void PolnCalibratorExtension::remove_chan ( unsigned first, unsigned last )

overridevirtual

Remove the inclusive range of channels.

Reimplemented from Pulsar::CalibratorExtension.

References Pulsar::CalibratorExtension::remove_chan(), and response.

set_has_solver()

void PolnCalibratorExtension::set_has_solver

(

bool

has

)

Return true if information about the solution is available.

Set if the covariances of the transformation parameters.

References has_solver.

set_nchan()

void PolnCalibratorExtension::set_nchan ( unsigned nchan )

overridevirtual

Set the number of frequency channels.

Reimplemented from Pulsar::CalibratorExtension.

References construct(), response, and Pulsar::CalibratorExtension::set_nchan().

Referenced by operator=(), and Pulsar::PolnCalExtFreqIntegrate::transform().

set_type()

void PolnCalibratorExtension::set_type ( const Calibrator::Type * type )

overridevirtual

Set the type of the instrumental response parameterization.

Reimplemented from Pulsar::CalibratorExtension.

References nparam, and Pulsar::CalibratorExtension::type.

set_weight()

void PolnCalibratorExtension::set_weight ( unsigned ichan, float weight )

overridevirtual

Set the weight of the specified channel.

Reimplemented from Pulsar::CalibratorExtension.

References Pulsar::CalibratorExtension::weight.

---

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

• PolnCalibratorExtension.h
• PolnCalibratorExtension.C
• PolnCalExtFreqIntegrate.C
• PolnCalibratorExtensionUtils.C