Pulsar::InterQuartileRange Class Reference

Uses the inter-quartile range to mask bad channels and sub-integrations. More...

#include <InterQuartileRange.h>

Inheritance diagram for Pulsar::InterQuartileRange:

Public Member Functions
unsigned	update_mask (std::vector< float > &mask, std::vector< float > &stat, std::vector< float > &model, unsigned nsubint, unsigned nchan, unsigned npol)
	Smooth the data given in raw, output to smoothed.
void	set_cutoff_threshold (float t)
	Set the cut-off threshold.
void	set_cutoff_threshold_max (float t)
	Set the cut-off threshold for the maximum value.
float	get_cutoff_threshold_max () const
	Get the cut-off threshold for the maximum value.
void	set_cutoff_threshold_min (float t)
	Set the cut-off threshold for the minimum value.
float	get_cutoff_threshold_min () const
	Get the cut-off threshold for the minimum value.
void	set_minimum_slope_median_duty_cycle (float t)
	Set the duty cycle used to find the 'minimum slope median'.
float	get_minimum_slope_median_duty_cycle () const
	Get the duty cycle used to find the 'minimum slope median'.
const std::string &	get_way () const
void	set_way (const std::string &t)
TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to configure this instance.
InterQuartileRange *	clone () const
	Derived types must also define clone method.
Public Member Functions inherited from Pulsar::TimeFrequencyMask
virtual void	set_threshold (float t)
virtual float	get_threshold () const
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
float	cutoff_threshold_max = 1.5
	Fraction of IQR.
float	cutoff_threshold_min = 1.5
float	minimum_slope_median_duty_cycle = 0.0
	Duty cycle used to find the 'minimum slope median'.
std::string	way = "all"
Protected Attributes inherited from Pulsar::TimeFrequencyMask
float	threshold

Additional Inherited Members
Static Public Member Functions inherited from Pulsar::TimeFrequencyMask
static TimeFrequencyMask *	factory (const std::string &name)
	Create a new instance of TimeFrequencyMask based on name.
static const std::vector< TimeFrequencyMask * > &	children ()
	Returns a list of available TimeFrequencyMask children.
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

Detailed Description

Uses the inter-quartile range to mask bad channels and sub-integrations.

Implements an adjustable pair of Tukey's Fences https://en.wikipedia.org/wiki/Outlier#Tukey's_fences

Member Function Documentation

clone()

InterQuartileRange * Pulsar::InterQuartileRange::clone ( ) const

inlinevirtual

Derived types must also define clone method.

Implements Pulsar::TimeFrequencyMask.

get_interface()

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

virtual

Return a text interface that can be used to configure this instance.

Get the text interface to the configuration attributes.

Reimplemented from Pulsar::TimeFrequencyMask.

update_mask()

unsigned Pulsar::InterQuartileRange::update_mask ( std::vector< float > & mask, std::vector< float > & stat, std::vector< float > & model, unsigned nsubint, unsigned nchan, unsigned npol )

virtual

Smooth the data given in raw, output to smoothed.

Both data arrays have dims (nsub, nchan, npol), slow to fast. weight array has dims (nsub, nchan).

Implements Pulsar::TimeFrequencyMask.

References cutoff_threshold_max, and minimum_slope_median_duty_cycle.

---

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

• InterQuartileRange.h
• InterQuartileRange.C