Pulsar::ProfileWeightFunction Class Reference

PhaseWeight algorithms that receive an input Profile. More...

#include <ProfileWeightFunction.h>

Inheritance diagram for Pulsar::ProfileWeightFunction:

Public Member Functions
	ProfileWeightFunction ()
	Default constructor.
	ProfileWeightFunction (const ProfileWeightFunction &)
	Copy constructor.
virtual ProfileWeightFunction *	clone () const =0
	Return a copy constructed instance of self.
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.
virtual PhaseWeight *	operate (const Profile *)
	Convenience interface.
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

Static Public Member Functions
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
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

Protected Attributes
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.

Detailed Description

PhaseWeight algorithms that receive an input Profile.

Member Function Documentation

calculate()

virtual void Pulsar::ProfileWeightFunction::calculate ( PhaseWeight * weight )

protectedpure virtual

Derived classes implement the PhaseWeight calculation.

Implemented in PeakConsecutive, Pulsar::BaselineStatic, Pulsar::BaselineWindow, Pulsar::IterativeBaseline, Pulsar::OnPulseThreshold, Pulsar::PeakConsecutive, Pulsar::ProfileWeightStatic, Pulsar::RiseFall, and RiseFall.

Referenced by get_weight().

clone()

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

pure virtual

Return a copy constructed instance of self.

Implements Pulsar::PhaseWeightFunction.

Implemented in PeakConsecutive, Pulsar::BaselineEstimator, Pulsar::BaselineStatic, Pulsar::BaselineWindow, Pulsar::ExponentialBaseline, Pulsar::GaussianBaseline, Pulsar::IQRBaseline, Pulsar::LastHarmonic, Pulsar::OnPulseEstimator, Pulsar::OnPulseThreshold, Pulsar::PeakConsecutive, Pulsar::PeakCumulative, and Pulsar::ProfileWeightStatic.

References include, and ProfileWeightFunction().

get_weight()

void Pulsar::ProfileWeightFunction::get_weight ( PhaseWeight * weight )

virtual

Returns a PhaseWeight with the Profile attribute set.

Implements Pulsar::PhaseWeightFunction.

References calculate(), and profile.

Referenced by Pulsar::FluctSpectStats< ProfileType, ProfileStatsType >::build(), Pulsar::SimPolnTiming::extrapolate_benefit(), Pulsar::DeltaPA::get(), and operate().

operate()

Pulsar::PhaseWeight * Pulsar::ProfileWeightFunction::operate ( const Profile * _profile )

virtual

Convenience interface.

Reimplemented in Pulsar::BaselineEstimator.

References get_weight(), Reference::To< class Type, bool active >::release(), and set_Profile().

Referenced by Pulsar::Profile::baseline(), Pulsar::BaselineEstimator::operate(), and Pulsar::FluxPlot::prepare().

set_Profile()

void Pulsar::ProfileWeightFunction::set_Profile ( const Profile * _profile )

virtual

Set the Profile from which the PhaseWeight will be derived.

Reimplemented in PeakConsecutive, Pulsar::LastHarmonic, Pulsar::PeakConsecutive, Pulsar::PeakCumulative, and Pulsar::ProfileWeightStatic.

References profile.

Referenced by Pulsar::FluctSpectStats< ProfileType, ProfileStatsType >::build(), Pulsar::SimPolnTiming::extrapolate_benefit(), Pulsar::DeltaPA::get(), Pulsar::RiseFall::get_rise_fall(), and operate().

---

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

• ProfileWeightFunction.h
• ProfileWeightFunction.C