Pulsar::FluxCalibratorExtension Class Reference

Flux Calibrator Extension. More...

#include <FluxCalibratorExtension.h>

Inheritance diagram for Pulsar::FluxCalibratorExtension:

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

Public Member Functions
	FluxCalibratorExtension ()
	Default constructor.
	FluxCalibratorExtension (const FluxCalibratorExtension &)
	Copy constructor.
const FluxCalibratorExtension &	operator= (const FluxCalibratorExtension &)
	Operator =.
	~FluxCalibratorExtension ()
	Destructor.
FluxCalibratorExtension *	clone () const
	Clone method.
TextInterface::Parser *	get_interface ()
	Return a text interfaces that can be used to access this instance.
	FluxCalibratorExtension (const FluxCalibrator *)
	Construct from a FluxCalibrator instance.
std::string	get_short_name () const
	Return a short name.
void	set_nchan (unsigned nchan)
	Set the number of frequency channels.
unsigned int	get_nchan (void) const
	Get the number of frequency channels.
void	remove_chan (unsigned first, unsigned last)
	Remove the inclusive range of channels.
Solution *	get_solution (unsigned c)
	Get the solution for the specified frequency channel.
const Solution *	get_solution (unsigned c) const
	Get the solution for the specified frequency channel.
void	set_nreceptor (unsigned nreceptor)
	Set the number of receptors.
unsigned	get_nreceptor () const
	Get the number of receptors.
bool	has_scale () const
	Returns true if scale and gain_ratio data are available.
void	has_scale (bool flag)
unsigned	get_nparam () const
	Get the number of parameters that describe each solution.
Estimate< float >	get_Estimate (unsigned iparam, unsigned ichan) const
	Get the specified parameter for the specified channel.
void	set_Estimate (unsigned iparam, unsigned ichan, const Estimate< float > &)
bool	get_valid (unsigned ichan) const
void	set_valid (unsigned ichan, bool valid)
void	frequency_append (Archive *to, const Archive *from)
	Append FluxCalibrator Extension data from another Archive.
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 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_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.
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 Attributes
unsigned	nreceptor
	The number of receptors.
bool	scale_available
	Flag set if scale and ratio data are available.
std::vector< Solution >	solution
	The flux calibrator solutions as a function of frequency.
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.

Friends
class	FluxCalibrator

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

Detailed Description

Flux Calibrator Extension.

This Extension implements the storage of FluxCalibrator data.

Member Function Documentation

clone()

FluxCalibratorExtension * Pulsar::FluxCalibratorExtension::clone ( ) const

inlinevirtual

Clone method.

Reimplemented from Pulsar::CalibratorExtension.

References FluxCalibratorExtension().

frequency_append()

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

virtual

Append FluxCalibrator Extension data from another Archive.

Reimplemented from Pulsar::CalibratorExtension.

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

get_interface()

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

virtual

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

Reimplemented from Pulsar::CalibratorExtension.

get_nchan()

unsigned Pulsar::FluxCalibratorExtension::get_nchan ( void ) const

virtual

Get the number of frequency channels.

Reimplemented from Pulsar::CalibratorExtension.

References solution.

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

get_short_name()

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

inlinevirtual

Return a short name.

Reimplemented from Pulsar::CalibratorExtension.

remove_chan()

void Pulsar::FluxCalibratorExtension::remove_chan ( unsigned first, unsigned last )

virtual

Remove the inclusive range of channels.

Reimplemented from Pulsar::CalibratorExtension.

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

set_nchan()

void Pulsar::FluxCalibratorExtension::set_nchan ( unsigned nchan )

virtual

Set the number of frequency channels.

Reimplemented from Pulsar::CalibratorExtension.

References Pulsar::CalibratorExtension::set_nchan(), and solution.

Referenced by FluxCalibratorExtension().

set_nreceptor()

void Pulsar::FluxCalibratorExtension::set_nreceptor

(

unsigned

nreceptor

)

Set the number of receptors.

Set the number of frequency channels.

References nreceptor, Pulsar::Archive::Extension::resize(), and solution.

Referenced by FluxCalibratorExtension().

---

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

• FluxCalibratorExtension.h
• FluxCalibratorExtension.C
• FluxCalibratorExt.C