Pulsar::AuxColdPlasma Class Reference

Auxiliary cold plasma dispersion and birefringence corrections. More...

#include <AuxColdPlasma.h>

Inheritance diagram for Pulsar::AuxColdPlasma:

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

Public Member Functions
	AuxColdPlasma ()
	Default constructor.
AuxColdPlasma *	clone () const
	Clone method.
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_model_name (const std::string &name)
std::string	get_dispersion_model_name () const
void	set_dispersion_corrected (bool flag)
bool	get_dispersion_corrected () const
void	set_birefringence_model_name (const std::string &name)
std::string	get_birefringence_model_name () const
void	set_birefringence_corrected (bool flag)
bool	get_birefringence_corrected () const
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.
virtual void	frequency_append (Archive *to, const Archive *from)
	Append data along frequency dimension, if applicable.
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

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 Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const
Protected Attributes inherited from Pulsar::Archive::Extension
std::string	extension_name
	Extension name - useful when debugging.

Detailed Description

Auxiliary cold plasma dispersion and birefringence corrections.

This class stores the names of any models used to compute auxiliary DM and RM, and records if these effects have been corrected.

Member Function Documentation

clone()

AuxColdPlasma * Pulsar::AuxColdPlasma::clone ( ) const

inlinevirtual

Clone method.

Implements Pulsar::Archive::Extension.

References AuxColdPlasma().

get_interface()

TextInterface::Parser * Pulsar::AuxColdPlasma::get_interface ( void )

virtual

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

Reimplemented from Pulsar::Archive::Extension.

get_short_name()

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

inlinevirtual

Return an abbreviated name that can be typed relatively quickly.

Reimplemented from Pulsar::Archive::Extension.

---

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

• AuxColdPlasma.h
• AuxColdPlasma.C