Pulsar::OnPulseThreshold Class Reference

Uses the baseline statistics to find on-pulse phase bins. More...

#include <OnPulseThreshold.h>

Inheritance diagram for Pulsar::OnPulseThreshold:

Public Member Functions
	OnPulseThreshold ()
	Default constructor.
void	set_threshold (float threshold)
	Set the threshold.
float	get_threshold () const
	Get the threshold.
void	set_allow_negative (bool)
	Allow negative on-pulse phase bins.
void	set_baseline_estimator (BaselineEstimator *)
	Set the BaselineEstimator used to find the off-pulse phase bins.
const BaselineEstimator *	get_baseline_estimator () const
	Get the BaselineEstimator used to find the off-pulse phase bins.
BaselineEstimator *	get_baseline_estimator ()
void	set_range (int bin_start, int bin_end)
	Set the start and end bins of the search.
TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to configure this instance.
OnPulseThreshold *	clone () const
	Return new copy 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.
virtual PhaseWeight *	operate (const Profile *)
	Convenience interface.
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.
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.
bool	allow_negative
	Take the absolute value.
int	bin_start
	The first bin in the selected range.
int	bin_end
	The last bin in the selected range.
bool	range_specified
	Set true when range is specified.
Reference::To< BaselineEstimator >	baseline_estimator
	The BaselineEstimator used to find the off-pulse phase bins.
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

Uses the baseline statistics to find on-pulse phase bins.

The on-pulse phase bins are those with a value greater than the threshold times the rms of the off-pulse phase bins. Therefore, this class makes use of a BaselineEstimator to find the off-pulse baseline. By default, this is the BaselineWindow class.

Member Function Documentation

calculate()

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

protectedvirtual

Calculate the PhaseWeight.

Retrieve the PhaseWeight.

Implements Pulsar::ProfileWeightFunction.

References allow_negative, baseline_estimator, bin_end, bin_start, Estimate< typename T, typename U >::get_value(), Pulsar::ProfileWeightFunction::profile, range_specified, threshold, and Pulsar::Profile::verbose.

clone()

Pulsar::OnPulseThreshold * Pulsar::OnPulseThreshold::clone ( ) const

virtual

Return new copy of self.

Implements Pulsar::OnPulseEstimator.

References OnPulseThreshold().

get_interface()

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

virtual

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

Implements Pulsar::PhaseWeightFunction.

set_threshold()

void Pulsar::OnPulseThreshold::set_threshold

(

float

threshold

)

Set the threshold.

Set the duty cycle.

References threshold.

---

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

• OnPulseThreshold.h
• OnPulseThreshold.C