Pulsar::CalibratorStokes Class Reference

Stores the Stokes parameters of the reference source. More...

#include <CalibratorStokes.h>

Inheritance diagram for Pulsar::CalibratorStokes:

Public Types
enum	CouplingPoint {   BeforeProjection, BeforeBasis, BeforeFrontend, BeforeIdeal,   BeforeBackend, Unknown }
	The point where the reference source signal is coupled

Public Member Functions
	CalibratorStokes ()
	Default constructor.
	CalibratorStokes (const CalibratorStokes &extension)
	Copy constructor.
const CalibratorStokes &	operator= (const CalibratorStokes &extension)
	Assignment operator.
	~CalibratorStokes ()
	Destructor.
CalibratorStokes *	clone () const
	Clone method.
TextInterface::Parser *	get_interface ()
	Get the text ineterface.
std::string	get_short_name () const
	Return a short name.
void	set_nchan (unsigned nchan)
	Set the number of frequency channels.
unsigned	get_nchan () const
	Get the number of frequency channels.
void	set_coupling_point (CouplingPoint)
	Set the point where the reference source signal is coupled. More...
CouplingPoint	get_coupling_point () const
	The point where the reference source signal is coupled. More...
void	remove_chan (unsigned first, unsigned last)
	Remove the inclusive range of channels.
void	set_valid (unsigned ichan, bool valid)
	Set the validity flag for the specified channel.
bool	get_valid (unsigned ichan) const
	Get the validity flag for the specified channel.
void	set_stokes (unsigned ichan, const Stokes< Estimate< float > > &stokes)
	Set the Stokes parameters of the specified frequency channel.
Stokes< Estimate< float > >	get_stokes (unsigned ichan) const
	Get the Stokes parameters of the specified frequency channel.
unsigned	get_nparam () const
Estimate< float >	get_Estimate (unsigned iparam, unsigned ichan) const
void	set_Estimate (unsigned iparam, unsigned ichan, Estimate< float > &)
void	frequency_append (Archive *to, const Archive *from)
	Append CalibratorStokes 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.
PolnVector *	get_poln (unsigned ichan)
	Interface to StokesVector.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
CouplingPoint	coupling_point
	The point where the reference source signal is coupled. More...
std::vector< Stokes< Estimate< float > > >	stokes
	The Stokes parameters for each frequency channel. More...
Reference::To< PolnVector >	current
Protected Attributes inherited from Pulsar::Archive::Extension
std::string	extension_name
	Extension name - useful when debugging.

Friends
class	CalibratorStokes::Interface

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 the Stokes parameters of the reference source.

This Archive::Extension class provides a simple container for storing the Stokes parameters of the artificial (reference) calibrator source.

Member Function Documentation

get_coupling_point()

CalibratorStokes::CouplingPoint CalibratorStokes::get_coupling_point

(

)

const

The point where the reference source signal is coupled.

Get the name of the point where the reference source signal is coupled.

References coupling_point.

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

set_coupling_point()

void CalibratorStokes::set_coupling_point

(

CouplingPoint

point

)

Set the point where the reference source signal is coupled.

Set the name of the point where the reference source signal is coupled.

References coupling_point.

Member Data Documentation

coupling_point

CouplingPoint Pulsar::CalibratorStokes::coupling_point

protected

The point where the reference source signal is coupled.

On some systems, the reference source (e.g. noise diode) signal is coupled to the astronomy signal after the OMT. Also, when modeling the instrumental response using METM, variable ionospheric Faraday rotation causes variable apparent rotation about the line of sight, which in turn affects the best-fit Stokes parameters of the reference source. Therefore, when using METM, it is best to model the reference source as though coupled after the frontend.

Referenced by CalibratorStokes(), get_coupling_point(), operator=(), and set_coupling_point().

stokes

std::vector< Stokes< Estimate<float> > > Pulsar::CalibratorStokes::stokes

protected

The Stokes parameters for each frequency channel.

Stokes I is used to represent data validity

Referenced by frequency_append(), get_nchan(), get_stokes(), get_valid(), operator=(), range_check(), remove_chan(), set_nchan(), set_stokes(), and set_valid().

---

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

• CalibratorStokes.h
• CalibratorStokes.C