Pulsar::SpectralKurtosis Class Reference

Spectral Kurtosis Staticstics calculated during observation. More...

#include <SpectralKurtosis.h>

Inheritance diagram for Pulsar::SpectralKurtosis:

Public Member Functions
	SpectralKurtosis ()
	Default constructor.
	SpectralKurtosis (const SpectralKurtosis &extension)
	Copy constructor.
const SpectralKurtosis &	operator= (const SpectralKurtosis &extension)
	Assignment operator.
	~SpectralKurtosis ()
	Destructor.
SpectralKurtosis *	clone () const
	Clone method.
TextInterface::Parser *	get_interface ()
	Return a text interfaces that can be used to access this instance. More...
std::string	get_short_name () const
	Short name.
const SpectralKurtosis &	operator+= (const SpectralKurtosis &extension)
	Addition operator.
void	set_loader (SpectralKurtosis::Loader *)
	Set the loader used for this integration.
void	resize (unsigned npol, unsigned nchan)
	Resize the extension. More...
void	integrate (const Integration *subint)
	Integrate information from another Integration. More...
void	update (const Integration *subint)
	Update information based on the provided Integration. More...
void	set_npol (unsigned n)
	Set the number of polarizations.
unsigned	get_npol () const
	Get the number of polarizations.
void	set_nchan (unsigned n)
	Set the number of channels.
unsigned	get_nchan () const
	Get the number of channels.
void	set_M (unsigned _M)
	Set the base integration factor used to calculate the SK statistic.
unsigned	get_M () const
	Get the base integration factor used in the SK statistic.
void	set_excision_threshold (unsigned nsigma)
	Set the excision threshold in terms of std deviations.
unsigned	get_excision_threshold () const
	Get the excision threshold in terms of std deviations.
float	get_filtered_sum (unsigned ichan, unsigned ipol) const
	Get the filtered sum of the specified channel and polarization.
void	set_filtered_sum (unsigned ichan, unsigned ipol, float sum)
	Set the filtered sum of the specified channel and polarization.
uint64_t	get_filtered_hits (unsigned ichan) const
	Get the filtered hits of the specified channel and polarization.
void	set_filtered_hits (unsigned ichan, uint64_t hits)
	Set the filtered hits of the specified channel and polarization.
float	get_unfiltered_sum (unsigned ichan, unsigned ipol) const
	Get the unfiltered sum of the specified channel and polarization.
void	set_unfiltered_sum (unsigned ichan, unsigned ipol, float sum)
	Set the unfiltered sum of the specified channel and polarization.
uint64_t	get_unfiltered_hits () const
void	set_unfiltered_hits (uint64_t hits)
void	set_ipol_mean (unsigned ipol)
	Set the polarization for which means will be computed.
unsigned	get_ipol_mean () const
float	get_unfiltered_mean (unsigned ichan) const
	Get the unfiltered mean of the specified channel.
float	get_filtered_mean (unsigned ichan) const
Public Member Functions inherited from Pulsar::Integration::Extension
	Extension (const char *name)
	Construct with a name.
virtual	~Extension ()
	Destructor.
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 Member Functions
void	get_data () const
	Load the integration data from file. More...
void	load ()
void	range_check (unsigned ichan, unsigned ipol, const char *method) const
	Ensure that ichan < nchan and ipol < npol.
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

Protected Attributes
Reference::To< SpectralKurtosis::Loader >	loader
	loads the SK data from file
unsigned	npol = 0
	number of polarizations
unsigned	nchan = 0
	number of channels
unsigned	M = 0
	Number of samples integrated into each atomic SK statistic.
unsigned	nsigma = 0
	Threshold used to excise RFI in SK Detection.
std::vector< float >	filtered_sum
	Average SK statistic for each channel, post f/t scrunch zapping.
std::vector< uint64_t >	filtered_hits
	Hits on filtered average for each channel.
std::vector< float >	unfiltered_sum
	Average SK statistic for each channel formed from block length SK estimates.
uint64_t	unfiltered_hits = 0
	Hits on unfiltered SK statistic, same for each channel/pol.
unsigned	ipol_mean = 0
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 ()

Detailed Description

Spectral Kurtosis Staticstics calculated during observation.

Member Function Documentation

get_data()

void Pulsar::SpectralKurtosis::get_data ( ) const

protected

Load the integration data from file.

Load the SK data from file via the loader, but only do this once

References Pulsar::Integration::verbose.

get_interface()

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

virtual

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

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

Reimplemented from Pulsar::Integration::Extension.

integrate()

void Pulsar::SpectralKurtosis::integrate ( const Integration *  subint )

virtual

Integrate information from another Integration.

Combine SK statistics from another integration.

Reimplemented from Pulsar::Integration::Extension.

References Pulsar::Integration::verbose.

resize()

void Pulsar::SpectralKurtosis::resize	(	unsigned	_npol,
		unsigned	_nchan
	)

Resize the extension.

Resize internal storage for npol and nchan

update()

void Pulsar::SpectralKurtosis::update ( const Integration *  subint )

virtual

Update information based on the provided Integration.

Update parameters from supplied subint

Reimplemented from Pulsar::Integration::Extension.

References M, nchan, npol, nsigma, and Pulsar::Integration::verbose.

---

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

• SpectralKurtosis.h
• SpectralKurtosis.C