Pulsar::IterativeBaseline Class Reference

Finds a Profile baseline using an interative bounding method. More...

#include <IterativeBaseline.h>

Inheritance diagram for Pulsar::IterativeBaseline:

Public Member Functions
	IterativeBaseline ()
	Default constructor.
	~IterativeBaseline ()
	Destructor.
void	set_initial_baseline (BaselineEstimator *)
	Set the BaselineEstimator used to find the initial baseline.
BaselineEstimator *	get_initial_baseline () const
virtual void	set_threshold (float sigma)
	Set the threshold below which samples are included in the baseline.
float	get_threshold () const
void	set_max_iterations (unsigned iterations)
	Set the maximum number of iterations.
void	set_run_postprocessing (bool f)
bool	get_run_postprocessing () const
Public Member Functions inherited from Pulsar::BaselineEstimator
	BaselineEstimator ()
	Default constructor.
PhaseWeight *	baseline (const Profile *)
	Returns a new PhaseWeight instance.
PhaseWeight *	operator() (const Profile *)
	Returns a new PhaseWeight instance.
PhaseWeight *	operate (const Profile *)
	Convenience interface.
void	set_median_cut (float threshold)
	Cut samples from baseline with median difference over threshold.
virtual BaselineEstimator *	clone () const =0
	Return a copy constructed instance of self.
Public Member Functions inherited from Pulsar::ProfileWeightFunction
	ProfileWeightFunction ()
	Default constructor.
	ProfileWeightFunction (const ProfileWeightFunction &)
	Copy constructor.
virtual void	set_Profile (const Profile *)
	Set the Profile from which the PhaseWeight will be derived.
void	set_include (PhaseWeight *include)
	Include only the specified phase bins for consideration.
void	set_exclude (PhaseWeight *include)
	Exclude the specified phase bins from consideration.
bool	consider (unsigned ibin) const
	Return true if the specified phase bin should be considered.
virtual void	get_weight (PhaseWeight *weight)
	Returns a PhaseWeight with the Profile attribute set.
Public Member Functions inherited from Pulsar::PhaseWeightFunction
virtual TextInterface::Parser *	get_interface ()=0
	Return a text interface that can be used to configure this instance.
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	calculate (PhaseWeight *weight)
	Calculate the PhaseWeight.
virtual void	get_bounds (PhaseWeight *, float &lower, float &upper)=0
	Derived classes must define the bounds.
virtual void	postprocess (PhaseWeight *weight, const Profile *profile)
bool	get_initial_bounds () const
	Provide access to derived classes.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
float	threshold
	The threshold below which samples are included in the baseline.
unsigned	max_iterations
	The maximum number of iterations.
bool	run_postprocessing
	Run the postprocessing algorithm.
Reference::To< BaselineEstimator >	initial_baseline
	The BaselineEstimator used to find the initial baseline.
Protected Attributes inherited from Pulsar::BaselineEstimator
float	median_cut
Protected Attributes inherited from Pulsar::ProfileWeightFunction
Reference::To< const Profile, false >	profile
	The Profile from which the PhaseWeight will be derived.
Reference::To< PhaseWeight >	include
	Included phase bins.
Reference::To< PhaseWeight >	exclude
	Excluded phase bins.

Additional Inherited Members
Static Public Member Functions inherited from Pulsar::ProfileWeightFunction
static ProfileWeightFunction *	factory (const std::string &name_and_parse)
	Construct a new ProfileWeightFunction from a string.
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

Finds a Profile baseline using an interative bounding method.

Member Function Documentation

calculate()

void Pulsar::IterativeBaseline::calculate ( PhaseWeight * weight )

protectedvirtual

Calculate the PhaseWeight.

Implements Pulsar::ProfileWeightFunction.

References Pulsar::ProfileWeightFunction::consider(), Pulsar::ProfileWeightFunction::exclude, get_bounds(), Estimate< typename T, typename U >::get_value(), Pulsar::ProfileWeightFunction::include, initial_baseline, max_iterations, Pulsar::ProfileWeightFunction::profile, run_postprocessing, and Pulsar::Profile::verbose.

get_bounds()

virtual void Pulsar::IterativeBaseline::get_bounds ( PhaseWeight * , float & lower, float & upper )

protectedpure virtual

Derived classes must define the bounds.

Implemented in Pulsar::ExponentialBaseline, Pulsar::GaussianBaseline, and Pulsar::IQRBaseline.

References Pulsar::ProfileWeightFunction::profile.

Referenced by calculate().

set_threshold()

void Pulsar::IterativeBaseline::set_threshold ( float sigma )

virtual

Set the threshold below which samples are included in the baseline.

Reimplemented in Pulsar::ExponentialBaseline, and Pulsar::GaussianBaseline.

References threshold.

Referenced by Pulsar::IQRBaseline::IQRBaseline(), Pulsar::ExponentialBaseline::set_threshold(), and Pulsar::GaussianBaseline::set_threshold().

---

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

• IterativeBaseline.h
• IterativeBaseline.C