Pulsar::BaselineEstimator Class Reference

ProfileWeight algorithms that compute profile baselines. More...

#include <BaselineEstimator.h>

Inheritance diagram for Pulsar::BaselineEstimator:

Public Member Functions
	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 Attributes
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 ()
Protected Member Functions inherited from Pulsar::ProfileWeightFunction
virtual void	calculate (PhaseWeight *weight)=0
	Derived classes implement the PhaseWeight calculation.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

ProfileWeight algorithms that compute profile baselines.

Member Function Documentation

clone()

virtual BaselineEstimator * Pulsar::BaselineEstimator::clone ( ) const

pure virtual

Return a copy constructed instance of self.

Implements Pulsar::ProfileWeightFunction.

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

References BaselineEstimator().

operate()

Pulsar::PhaseWeight * Pulsar::BaselineEstimator::operate ( const Profile * profile )

virtual

Convenience interface.

Reimplemented from Pulsar::ProfileWeightFunction.

References Pulsar::ProfileWeightFunction::operate(), and Pulsar::ProfileWeightFunction::profile.

Referenced by baseline(), Pulsar::SquareWave::get_mask(), and operator()().

---

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

• BaselineEstimator.h
• BaselineEstimator.C