Pulsar::ColdPlasmaHistory Class Reference

Stores parameters used to correct Faraday rotation in each Integration. More...

#include <ColdPlasmaHistory.h>

Inheritance diagram for Pulsar::ColdPlasmaHistory:

Public Member Functions
	ColdPlasmaHistory (const char *name)
	Default constructor.
	ColdPlasmaHistory (const ColdPlasmaHistory &extension)
	Copy constructor.
const ColdPlasmaHistory &	operator= (const ColdPlasmaHistory &extension)
	Assignment operator. More...
	~ColdPlasmaHistory ()
	Destructor.
void	set_measure (double measure)
	Set the correction measure. More...
double	get_measure () const
	Get the correction measure. More...
void	set_reference_wavelength (double metres)
	Set the reference wavelength in metres.
double	get_reference_wavelength () const
	Get the reference wavelength.
void	set_reference_frequency (double MHz)
	Set the reference frequency in MHz.
double	get_reference_frequency () const
	Get the reference frequency. More...
Public Member Functions inherited from Pulsar::Integration::Extension
	Extension (const char *name)
	Construct with a name.
virtual	~Extension ()
	Destructor.
virtual Extension *	clone () const =0
	Return a new copy-constructed instance identical to this instance.
virtual TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to access this instance.
virtual void	integrate (const Integration *subint)
	Integrate information from another Integration.
virtual void	update (const Integration *subint)
	Update information based on the provided Integration.
std::string	get_extension_name () const
	Return the name of the Extension.
virtual std::string	get_short_name () const
	Return an abbreviated name that can be typed relatively quickly.
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
double	measure
	The correction measure.
double	reference_wavelength
	The reference wavelength in metres.
Protected Attributes inherited from Pulsar::Integration::Extension
std::string	extension_name
	Extension name - useful when debugging.

Additional Inherited Members
Static Public Member Functions inherited from Pulsar::Integration::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::Integration::Extension
const Archive *	get_parent (const Integration *subint) const
	Provide Extension derived classes with access to parent Archive.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Stores parameters used to correct Faraday rotation in each Integration.

Member Function Documentation

get_measure()

double Pulsar::ColdPlasmaHistory::get_measure

(

)

const

Get the correction measure.

Get the rotation measure.

get_reference_frequency()

double Pulsar::ColdPlasmaHistory::get_reference_frequency

(

)

const

Get the reference frequency.

Get the reference frequency in MHz.

Referenced by Pulsar::Dedispersed::apply(), and Pulsar::DeFaradayed::apply().

operator=()

const Pulsar::ColdPlasmaHistory & Pulsar::ColdPlasmaHistory::operator=

(

const ColdPlasmaHistory &

extension

)

Assignment operator.

Operator =.

References measure, and reference_wavelength.

Referenced by ColdPlasmaHistory(), Pulsar::Dedisperse::Dedisperse(), Pulsar::DeFaraday::DeFaraday(), Pulsar::Dedisperse::operator=(), and Pulsar::DeFaraday::operator=().

set_measure()

void Pulsar::ColdPlasmaHistory::set_measure

(

double

measure

)

Set the correction measure.

Set the rotation measure.

---

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

• ColdPlasmaHistory.h
• ColdPlasmaHistory.C