Pulsar::ChannelZapMedian Class Reference

Uses a median smoothed spectrum to find birdies and zap them. More...

#include <ChannelZapMedian.h>

Inheritance diagram for Pulsar::ChannelZapMedian:

Public Member Functions
	ChannelZapMedian ()
	Default constructor.
TextInterface::Parser *	get_interface ()
	Get the text interface to the configuration attributes.
void	operator() (Archive *)
	Set up attributes that apply to the whole archive.
void	weight (Integration *integration)
	Set integration weights.
void	set_window_size (unsigned size)
	Set the size of the window over which median will be computed.
unsigned	get_window_size () const
	Get the size of the window over which median will be computed.
void	set_rms_threshold (float t)
	Set the threshold as multiple of the standard deviation.
float	get_rms_threshold () const
	Get the threshold as multiple of the standard deviation.
void	set_madm_threshold (float t)
	Set the threshold as multiple of the median absolute deviation from the median.
float	get_madm_threshold () const
	Get the threshold as multiple of the median absolute deviation from the median.
void	set_iqr_threshold (float t)
	Set the threshold as multiple of the inter-quartile range.
float	get_iqr_threshold () const
	Get the threshold as multiple of the inter-quartile range.
void	set_bybin (bool t)
	Run the algorithm on the spectra of each bin.
bool	get_bybin () const
	Run the algorithm on the spectra of each bin.
void	set_paz_report (bool t)
	Print equivalent paz command on cout.
bool	get_paz_report () const
	Print equivalent paz command on cout.
void	set_from_total (bool t)
	Compute a single zap mask from the total.
bool	get_from_total () const
	Compute a single zap mask from the total.
void	set_expression (const std::string &exp)
	Set the mathematical expression.
std::string	get_expression () const
	Get the mathematical expression.
void	set_statistic (const std::string &)
	Set the profile statistic.
std::string	get_statistic () const
	Get the profile statistic.
Public Member Functions inherited from Pulsar::Weight
	Weight ()
	Default constructor.
void	set_fscrunch (const ScrunchFactor &f)
	Set the frequency scrunch factor.
const ScrunchFactor	get_fscrunch () const
	Get the frequency scrunch factor.
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
unsigned	window_size
	The size of the window over which median will be computed.
float	rms_threshold
	Threshold as a multiple of the standard deviation.
float	madm_threshold
	Threshold as a multiple of the median absolute deviation from the median.
float	iqr_threshold
	Threshold as a multiple of the inter-quartile range.
bool	bybin
	Median smooth the spectra of each bin.
bool	paz_report
	Print the verbose message used by paz.
bool	from_total
	Compute the zap mask from the tscrunched total.
std::vector< bool >	single_mask
	The single mask to apply to every sub-integration.
std::string	expression
	Set the expression to evaluate in each channel (as in psrstat)
Reference::To< Statistics >	stats
	The Statistics estimator used to evaluate the expression.
Reference::To< TextInterface::Parser >	parser
Reference::To< ProfileStatistic >	statistic
	The statistic to be derived from each profile.
Protected Attributes inherited from Pulsar::Weight
ScrunchFactor	fscrunch_factor
	Compute weights from fscrunched clone of data, then apply to original.

Additional Inherited Members
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::Weight
void	copy_weights (const Integration *from, Integration *to)
	Copy the weights from 'from' to 'to'.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Uses a median smoothed spectrum to find birdies and zap them.

Member Function Documentation

get_interface()

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

virtual

Get the text interface to the configuration attributes.

Reimplemented from Pulsar::Weight.

operator()()

void Pulsar::ChannelZapMedian::operator() ( Archive * archive )

virtual

Set up attributes that apply to the whole archive.

Reimplemented from Pulsar::Weight.

References expression, from_total, Pulsar::Integration::set_weight(), single_mask, stats, and weight().

weight()

void Pulsar::ChannelZapMedian::weight ( Integration * integration )

virtual

Set integration weights.

Implements Pulsar::Weight.

References bybin, Pulsar::Integration::clone(), Signal::Coherence, expression, from_total, Pulsar::ProfileAmps::get_amps(), Pulsar::Integration::get_dedispersed(), Pulsar::Integration::get_nbin(), Pulsar::Integration::get_nchan(), Pulsar::Integration::get_npol(), Pulsar::get_Profile(), Pulsar::Integration::get_Profile(), Pulsar::Integration::get_state(), Pulsar::Integration::get_weight(), iqr_threshold, madm_threshold, paz_report, Signal::PPQQ, rms_threshold, Pulsar::Profile::rotate_in_phase_domain, Pulsar::Integration::set_weight(), single_mask, statistic, stats, Pulsar::Integration::verbose, and window_size.

Referenced by operator()().

---

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

• ChannelZapMedian.h
• ChannelZapMedian.C