Pulsar::CalibratorExtension Class Reference

Stores Calibrator parameters in an Archive. More...

#include <CalibratorExtension.h>

Inheritance diagram for Pulsar::CalibratorExtension:

Classes
class	Interface
	Text interface to CalibratorExtension extension. More...

Public Member Functions
	CalibratorExtension (const char *name="CalibratorExtension")
	Default constructor.
	CalibratorExtension (const CalibratorExtension &)
	Copy constructor.
const CalibratorExtension &	operator= (const CalibratorExtension &)
	Operator =.
	~CalibratorExtension ()
	Destructor.
CalibratorExtension *	clone () const
	Clone method.
void	build (const Calibrator *)
	Construct from a Calibrator instance.
virtual void	set_type (const Calibrator::Type *type)
	Set the type of the calibrator.
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 void	set_nchan (unsigned nchan)
	Set the number of frequency channels.
virtual unsigned	get_nchan () const
	Get the number of frequency channels.
virtual void	remove_chan (unsigned first, unsigned last)
	Remove the inclusive range of channels.
virtual void	set_weight (unsigned ichan, float weight)
	Set the weight of the specified channel.
virtual float	get_weight (unsigned ichan) const
	Get the weight of the specified channel.
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.
std::string	get_short_name () const
	Return a short name.
TextInterface::Parser *	get_interface ()
	Return a text interfaces that can be used to access this instance.
void	frequency_append (Archive *to, const Archive *from)
	Append Calibrator Extension data from another Archive.
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	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
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 Calibrator parameters in an Archive.

This Archive::Extension class implements the storage of Calibrator data, enabling a calibrator to be constructed from file.

Member Function Documentation

clone()

CalibratorExtension * Pulsar::CalibratorExtension::clone ( ) const

inlinevirtual

Clone method.

Implements Pulsar::Archive::Extension.

Reimplemented in Pulsar::FluxCalibratorExtension, and Pulsar::PolnCalibratorExtension.

References CalibratorExtension().

frequency_append()

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

virtual

Append Calibrator Extension data from another Archive.

Reimplemented from Pulsar::Archive::Extension.

Reimplemented in Pulsar::FluxCalibratorExtension, and Pulsar::PolnCalibratorExtension.

References CalibratorExtension(), frequency_append(), Pulsar::Archive::get(), and Pulsar::in_frequency_order().

Referenced by frequency_append(), Pulsar::FluxCalibratorExtension::frequency_append(), and Pulsar::PolnCalibratorExtension::frequency_append().

get_interface()

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

virtual

Return a text interfaces that can be used to access this instance.

Reimplemented from Pulsar::Archive::Extension.

Reimplemented in Pulsar::FluxCalibratorExtension, and Pulsar::PolnCalibratorExtension.

get_nchan()

unsigned CalibratorExtension::get_nchan ( void ) const

virtual

Get the number of frequency channels.

Implements Pulsar::HasChannels.

Reimplemented in Pulsar::FluxCalibratorExtension.

References weight.

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

get_short_name()

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

inlinevirtual

Return a short name.

Reimplemented from Pulsar::Archive::Extension.

Reimplemented in Pulsar::FluxCalibratorExtension, and Pulsar::PolnCalibratorExtension.

get_weight()

float CalibratorExtension::get_weight ( unsigned ichan ) const

virtual

Get the weight of the specified channel.

Reimplemented in Pulsar::PolnCalibratorExtension.

References range_check(), and weight.

remove_chan()

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

virtual

Remove the inclusive range of channels.

Implements Pulsar::HasChannels.

Reimplemented in Pulsar::FluxCalibratorExtension, and Pulsar::PolnCalibratorExtension.

References centre_frequency, and weight.

Referenced by Pulsar::FluxCalibratorExtension::remove_chan(), and Pulsar::PolnCalibratorExtension::remove_chan().

set_nchan()

void CalibratorExtension::set_nchan ( unsigned nchan )

virtual

Set the number of frequency channels.

Implements Pulsar::HasChannels.

Reimplemented in Pulsar::FluxCalibratorExtension, and Pulsar::PolnCalibratorExtension.

References centre_frequency, and weight.

Referenced by build(), Pulsar::FluxCalibratorExtension::set_nchan(), and Pulsar::PolnCalibratorExtension::set_nchan().

set_type()

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

virtual

Set the type of the calibrator.

Reimplemented in Pulsar::PolnCalibratorExtension.

References type.

Referenced by build().

set_weight()

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

virtual

Set the weight of the specified channel.

Reimplemented in Pulsar::PolnCalibratorExtension.

References range_check(), and weight.

---

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

• CalibratorExtension.h
• CalibratorExtension.C
• CalibratorExtension_build.C