CoherentDedispersion Class Reference

Record of phase-coherent dispersion removal algorithm. More...

#include <CoherentDedispersion.h>

Inheritance diagram for CoherentDedispersion:

Classes
class	InputChannel
	Coherent dedispersion attributes specific to input frequency channel. More...
class	OutputChannel
	Coherent dedispersion attributes specific to output frequency channel. More...

Public Member Functions
	CoherentDedispersion ()
	Default constructor.
CoherentDedispersion *	clone () const
	Clone method.
TextInterface::Parser *	get_interface ()
	get the text interface
std::string	get_short_name () const
	Return a short name.
Signal::Dimension	get_domain () const
	Domain in which the algorithm operates (time or frequency)
void	set_domain (Signal::Dimension val)
std::string	get_description () const
	Description of the algorithm.
void	set_description (const std::string &val)
double	get_dispersion_measure () const
	Dispersion measure used for coherent dedispersion.
void	set_dispersion_measure (double val)
double	get_doppler_correction () const
	Doppler shift correction applied to frequencies and bandwidths.
void	set_doppler_correction (double val)
int	get_nbit_data () const
	Number of bits used to represent data.
void	set_nbit_data (int nbit)
int	get_nbit_chirp () const
	Number of bits used to represent chirp.
void	set_nbit_chirp (int nbit)
unsigned	get_nchan_input () const
	Number of frequency channels in the input signal.
void	set_nchan_input (unsigned nchan)
const InputChannel &	get_input (unsigned ichan_input) const
InputChannel &	get_input (unsigned ichan_input)
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

Protected Member Functions
void	check_index (unsigned ichan_input) const
	Throw an exception if index is out of range.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
Signal::Dimension	domain
	Domain in which the algorithm operates (time or frequency)
std::string	description
	Description of the algorithm.
double	dispersion_measure
	Dispersion measure used for coherent dedispersion.
double	doppler_correction
	Doppler shift correction applied to frequencies and bandwidths.
int	nbit_data
	Number of bits used to represent data.
int	nbit_chirp
	Number of bits used to represent chirp.
std::vector< InputChannel >	input
	Information specific to each input frequency channel.
Protected Attributes inherited from Pulsar::Archive::Extension
std::string	extension_name
	Extension name - useful when debugging.

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

Record of phase-coherent dispersion removal algorithm.

This class stores information about any phase-coherent dispersion removal performed by the backend, if applicable.

Member Function Documentation

clone()

CoherentDedispersion * CoherentDedispersion::clone ( ) const

virtual

Clone method.

Implements Pulsar::Archive::Extension.

get_interface()

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

virtual

get the text interface

Reimplemented from Pulsar::Archive::Extension.

get_short_name()

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

inlinevirtual

Return a short name.

Reimplemented from Pulsar::Archive::Extension.

---

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

• CoherentDedispersion.h
• CoherentDedispersion.C