Pulsar::ProfileStats Class Reference

Computes pulse profile statistics. More...

#include <ProfileStats.h>

Inheritance diagram for Pulsar::ProfileStats:

Classes
class	Interface
	Profile statistics text interface. More...

Public Member Functions
	ProfileStats (const Profile *profile=0)
	Default constructor.
	ProfileStats (const ProfileStats &)
	Copy constructor.
	~ProfileStats ()
	Destructor.
ProfileStats *	clone () const
	Clone operator.
void	set_include_estimator (ProfileWeightFunction *)
	The algorithm used to find the included phase bins.
ProfileWeightFunction *	get_include_estimator () const
void	set_exclude_estimator (ProfileWeightFunction *)
	The algorithm used to find the excluded phase bins.
ProfileWeightFunction *	get_exclude_estimator () const
void	set_profile (const Profile *)
	Set the Profile from which statistics will be derived.
void	set_Profile (const Profile *profile)
void	set_integration (const Integration *)
	Set the Integration from which additional metadata can be obtained.
void	set_Integration (const Integration *subint)
Integration *	get_Integration () const
void	select_profile (const Profile *)
	Set the Profile that defines the baseline and on-pulse regions.
void	deselect_onpulse (const Profile *profile, float threshold)
	Deselect onpulse phase bins in profile that fall below threshold.
void	set_onpulse_estimator (ProfileWeightFunction *)
	The algorithm used to find the on-pulse phase bins.
ProfileWeightFunction *	get_onpulse_estimator () const
void	set_baseline_estimator (ProfileWeightFunction *)
	The algorithm used to find the off-pulse phase bins.
void	set_regions (const PhaseWeight &pulse, const PhaseWeight &baseline)
	Set the on-pulse and baseline regions.
void	get_regions (PhaseWeight &pulse, PhaseWeight &base) const
	Set the on-pulse and baseline regions.
unsigned	get_onpulse_nbin () const
	Get the number of phase bins in the on pulse window.
bool	get_onpulse (unsigned ibin) const
	Return true if the specified phase bin is in the on pulse window.
void	set_onpulse (unsigned ibin, bool)
	Set if the specified phase bin is in the on pulse window.
unsigned	get_baseline_nbin () const
	Get the number of phase bins in the baseline window.
bool	get_baseline (unsigned ibin) const
	Return true if the specified phase bin is in the baseline window.
Estimate< double >	get_total (bool subtract_baseline=true) const
	Returns the total flux of the on-pulse phase bins.
Estimate< double >	get_baseline_variance () const
	Returns the variance of the baseline.
PhaseWeight *	get_onpulse ()
	Return the on-pulse phase bin mask.
PhaseWeight *	get_baseline ()
	Return the off-pulse baseline mask.
PhaseWeight *	get_all ()
	Return the all pulse phase bin mask.
void	set_snratio_estimator (SNRatioEstimator *)
	The algorithm used to estimate the signal-to-noise ratio.
SNRatioEstimator *	get_snratio_estimator () const
void	set_snr_estimator (const std::string &name)
	Set the signal-to-noise ratio estimator.
double	get_snr () const
	Get the signal-to-noise ratio.
TextInterface::Parser *	get_snr_interface ()
	Get the text interface of the signal-to-noise ratio estimator.
void	set_width_estimator (WidthEstimator *)
	The algorithm used to estimate the pulse width.
WidthEstimator *	get_width_estimator () const
void	set_pulse_width_estimator (const std::string &name)
	Set the pulse width estimator.
::Phase::Value	get_pulse_width () const
	Get the pulse width.
TextInterface::Parser *	get_pulse_width_interface ()
	Get the text interface of the pulse width estimator.
TextInterface::Parser *	get_interface ()
	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
Public Member Functions inherited from Pulsar::HasBaselineEstimator
	HasBaselineEstimator ()
	Default constructor.
	HasBaselineEstimator (const HasBaselineEstimator &)
	Copy constructor.
	~HasBaselineEstimator ()
	Destructor.
ProfileWeightFunction *	get_baseline_estimator () const
	Get the algorithm used to find the off-pulse phase bins.
bool	has_baseline_estimator () const
	Return true if baseline estimator is set.

Static Public Member Functions
static unsigned	get_instance_count ()
	Get the number of ProfileStats instances in existence.
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
void	build () const
	Computes the phase bin masks.
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 statistics will be derived.
Reference::To< const Integration, false >	integration
	The Integration from which additional metadata can be obtained.
Reference::To< ProfileWeightFunction >	onpulse_estimator
	The algorithm used to find the on-pulse phase bins.
Reference::To< SNRatioEstimator >	snratio_estimator
	The algorithm used to compute the signal-to-noise ratio.
Reference::To< WidthEstimator >	width_estimator
	The algorithm used to estimate the pulse width.
bool	regions_set = false
	True when the onpulse and baseline regions have been set.
Reference::To< PhaseWeight >	onpulse = new PhaseWeight
	The on-pulse phase bin mask.
Reference::To< PhaseWeight >	baseline = new PhaseWeight
	The off-pulse baseline mask.
Reference::To< PhaseWeight >	all = new PhaseWeight
	All phase bins (subject to include and exclude)
Estimate< double >	baseline_variance
	The variance of the total intensity baseline.
Reference::To< ProfileWeightFunction >	include_estimator
	The algorithm used to find the included phase bins.
Reference::To< PhaseWeight >	include
	The included phase bin mask.
Reference::To< ProfileWeightFunction >	exclude_estimator
	The algorithm used to find the excluded phase bins.
Reference::To< PhaseWeight >	exclude
	The excluded phase bin mask.

Detailed Description

Computes pulse profile statistics.

Member Function Documentation

get_all()

Pulsar::PhaseWeight * Pulsar::ProfileStats::get_all

(

)

Return the all pulse phase bin mask.

Return the off-pulse baseline mask.

References all, and build().

Referenced by Pulsar::ProfileStats::Interface::Interface().

select_profile()

void Pulsar::ProfileStats::select_profile

(

const Profile *

set_profile

)

Set the Profile that defines the baseline and on-pulse regions.

Set the Profile from which baseline and onpulse mask will be selected.

It is assumed that all subsequent Profile instances passed to set_profile will have the same phase as set_profile

References build(), profile, regions_set, set_profile(), and Pulsar::Profile::verbose.

set_baseline_estimator()

void Pulsar::ProfileStats::set_baseline_estimator ( ProfileWeightFunction * est )

virtual

The algorithm used to find the off-pulse phase bins.

Reimplemented from Pulsar::HasBaselineEstimator.

References Pulsar::HasBaselineEstimator::HasBaselineEstimator(), onpulse_estimator, regions_set, Pulsar::HasBaselineEstimator::set_baseline_estimator(), Pulsar::Profile::verbose, and width_estimator.

Referenced by ProfileStats().

set_exclude_estimator()

void Pulsar::ProfileStats::set_exclude_estimator

(

ProfileWeightFunction *

est

)

The algorithm used to find the excluded phase bins.

The algorithm used to find the bins to exclude.

References exclude_estimator, regions_set, and Pulsar::Profile::verbose.

Referenced by Pulsar::ProfileStats::Interface::Interface().

set_include_estimator()

void Pulsar::ProfileStats::set_include_estimator

(

ProfileWeightFunction *

est

)

The algorithm used to find the included phase bins.

The algorithm used to find the bins to include.

References include_estimator, regions_set, and Pulsar::Profile::verbose.

Referenced by Pulsar::ProfileStats::Interface::Interface().

---

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

• ProfileStats.h
• ProfileStats.C