Pulsar::AuxColdPlasmaMeasures Class Reference

Stores parameters used to correct variable dispersion and birefringence. More...

#include <AuxColdPlasmaMeasures.h>

Inheritance diagram for Pulsar::AuxColdPlasmaMeasures:

Classes
class	Interface
	Text interface to a AuxColdPlasmaMeasures instance. More...

Public Member Functions
	AuxColdPlasmaMeasures ()
	Default constructor.
AuxColdPlasmaMeasures *	clone () const
	Return a newly constructed copy of self.
TextInterface::Parser *	get_interface ()
	Return a text interfaces that can be used to access this instance.
std::string	get_short_name () const
	Return an abbreviated name that can be typed relatively quickly.
void	set_dispersion_measure (double measure)
	Set the difference in dispersion measure.
double	get_dispersion_measure () const
	Get the difference dispersion measure.
void	set_rotation_measure (double measure)
	Set the difference in rotation measure.
double	get_rotation_measure () const
	Get the difference in rotation measure.
Public Member Functions inherited from Pulsar::Integration::Extension
	Extension (const char *name)
	Construct with a name.
virtual	~Extension ()
	Destructor.
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.
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	dispersion_measure = 0.0
	The difference in dispersion measure.
bool	absolute_dispersion_corrected = false
	Flag set when the difference in dispersion is corrected with respect to infinite frequency.
double	rotation_measure = 0.0
	The difference in rotation measure.
bool	absolute_rotation_corrected = false
	Flag set when the difference in rotation is corrected with respect to infinite frequency.
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 variable dispersion and birefringence.

Member Function Documentation

clone()

Pulsar::AuxColdPlasmaMeasures * Pulsar::AuxColdPlasmaMeasures::clone ( ) const

virtual

Return a newly constructed copy of self.

Implements Pulsar::Integration::Extension.

References AuxColdPlasmaMeasures().

get_dispersion_measure()

double Pulsar::AuxColdPlasmaMeasures::get_dispersion_measure

(

)

const

Get the difference dispersion measure.

Get the dispersion measure.

The difference is with respect to Archive::get_dispersion_measure

References dispersion_measure.

Referenced by Pulsar::Integration::get_absolute_dispersion_measure(), Pulsar::Dispersion::get_absolute_measure(), and Pulsar::FITSArchive::unload().

get_interface()

TextInterface::Parser * Pulsar::AuxColdPlasmaMeasures::get_interface ( )

virtual

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

Reimplemented from Pulsar::Integration::Extension.

get_rotation_measure()

double Pulsar::AuxColdPlasmaMeasures::get_rotation_measure

(

)

const

Get the difference in rotation measure.

Get the rotation measure.

The difference is with respect to Archive::get_rotation_measure

References rotation_measure.

Referenced by Pulsar::FaradayRotation::get_absolute_measure(), Pulsar::Integration::get_absolute_rotation_measure(), and Pulsar::FITSArchive::unload().

get_short_name()

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

inlinevirtual

Return an abbreviated name that can be typed relatively quickly.

Reimplemented from Pulsar::Integration::Extension.

set_dispersion_measure()

void Pulsar::AuxColdPlasmaMeasures::set_dispersion_measure

(

double

measure

)

Set the difference in dispersion measure.

Set the dispersion measure.

The difference is with respect to Archive::get_dispersion_measure

References dispersion_measure.

set_rotation_measure()

void Pulsar::AuxColdPlasmaMeasures::set_rotation_measure

(

double

measure

)

Set the difference in rotation measure.

Set the rotation measure.

The difference is with respect to Archive::get_rotation_measure

References rotation_measure.

---

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

• AuxColdPlasmaMeasures.h
• AuxColdPlasmaMeasures.C