Pulsar::dspReduction Class Reference

Stores dspsr data reduction parameters. More...

#include <dspReduction.h>

Inheritance diagram for Pulsar::dspReduction:

Public Member Functions
	dspReduction ()
	Default constructor.
	dspReduction (const dspReduction &extension)
	Copy constructor.
const dspReduction &	operator= (const dspReduction &extension)
	Assignment operator.
	~dspReduction ()
	Destructor.
dspReduction *	clone () const
	Clone method.
TextInterface::Parser *	get_interface ()
	get the text interface
std::string	get_short_name () const
	Return a short name.
std::string	get_software () const
	Get the software information.
void	set_software (const std::string &soft)
	Set the software information.
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

dsp::PhaseSeries parameters
These parameters describe the state of the dsp::PhaseSeries instance from which the Pulsar::Profile data are constructed.
std::string	software
	The software information.
double	scale
	Pulsar::Profiles are normalized by Observation::scale.
double	get_scale () const
	Pulsar::Profiles are normalized by Observation::scale.
void	set_scale (double _scale)
	Pulsar::Profiles are normalized by Observation::scale.

dsp::Input parameters
These parameters describe the state of the dsp::Input from which the raw data was loaded
uint64_t	total_samples
	The total number of time samples.
uint64_t	block_size
	The number of time samples in each block.
uint64_t	overlap
	The number of time samples by which consecutive blocks overlap.
Signal::State	state
	The state of the signal from Input::info.
uint64_t	get_total_samples () const
	The total number of time samples.
void	set_total_samples (uint64_t _total_samples)
	The total number of time samples.
uint64_t	get_block_size () const
	The number of time samples in each block.
void	set_block_size (uint64_t _block_size)
	The number of time samples in each block.
uint64_t	get_overlap () const
	The number of time samples by which consecutive blocks overlap.
void	set_overlap (uint64_t _overlap)
	The number of time samples by which consecutive blocks overlap.
Signal::State	get_state () const
	The state of the signal from Input::info.
void	set_state (Signal::State _state)
	The state of the signal from Input::info.

dsp::Convolution parameters
These parameters describe the state of the dsp::Convolution instance used to process the data.
unsigned	nsamp_fft
	Number of time samples in each FFT.
unsigned	nsamp_overlap_pos
	Number of time samples in wrap-around region, left-hand side.
unsigned	nsamp_overlap_neg
	Number of time samples in wrap-around region, right-hand side.
unsigned	get_nsamp_fft () const
	Number of time samples in each FFT.
void	set_nsamp_fft (unsigned _nsamp_fft)
	Number of time samples in each FFT.
unsigned	get_nsamp_overlap_pos () const
	Number of time samples in wrap-around region, left-hand side.
void	set_nsamp_overlap_pos (unsigned _nsamp_overlap_pos)
	Number of time samples in wrap-around region, left-hand side.
unsigned	get_nsamp_overlap_neg () const
	Number of time samples in wrap-around region, right-hand side.
void	set_nsamp_overlap_neg (unsigned _nsamp_overlap_neg)
	Number of time samples in wrap-around region, right-hand side.

dsp::Filterbank parameters
These parameters describe the state of the dsp::Filterbank instance used to process the data.
unsigned	nchan
	Number of frequency channels.
unsigned	freq_res
	Frequency resolution.
unsigned	time_res
	Time resolution.
unsigned	get_nchan () const
	Number of frequency channels.
void	set_nchan (unsigned _nchan)
	Number of frequency channels.
unsigned	get_freq_res () const
	Frequency resolution.
void	set_freq_res (unsigned _freq_res)
	Frequency resolution.
unsigned	get_time_res () const
	Time resolution.
void	set_time_res (unsigned _time_res)
	Time resolution.

dsp::TScrunch parameters
These parameters describe the state of the dsp::TScrunch instance used to process the data.
unsigned	ScrunchFactor
	Time resolution reduction factor.
unsigned	get_ScrunchFactor () const
	Time resolution reduction factor.
void	set_ScrunchFactor (unsigned _ScrunchFactor)
	Time resolution reduction factor.

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

Stores dspsr data reduction parameters.

This class stores backend information specific to the baseband recording and processing system implemented by dspsr.

Member Function Documentation

clone()

Pulsar::dspReduction * Pulsar::dspReduction::clone ( ) const

virtual

Clone method.

Implements Pulsar::Archive::Extension.

References dspReduction(), and Pulsar::IntegrationManager::verbose.

get_interface()

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

virtual

get the text interface

Reimplemented from Pulsar::Archive::Extension.

get_short_name()

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

inlinevirtual

Return a short name.

Reimplemented from Pulsar::Archive::Extension.

operator=()

const Pulsar::dspReduction & Pulsar::dspReduction::operator=

(

const dspReduction &

extension

)

Assignment operator.

Operator =.

References block_size, dspReduction(), freq_res, nchan, nsamp_fft, nsamp_overlap_neg, nsamp_overlap_pos, overlap, scale, ScrunchFactor, state, time_res, and total_samples.

Referenced by dspReduction().

---

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

• dspReduction.h
• dspReduction.C