Pulsar::LastHarmonic Class Reference

Finds the last significant harmonic in a flucuation power spectral density. More...

#include <LastHarmonic.h>

Inheritance diagram for Pulsar::LastHarmonic:

Public Member Functions
	LastHarmonic ()
	Default constructor.
void	set_Profile (const Profile *psd)
	Set the flucuation power spectral density from which the last harmonic will be computed. More...
void	set_threshold (float threshold)
	Set the threshold.
float	get_threshold () const
	Get the threshold.
void	set_consecutive (unsigned consecutive)
	Set the number of consecutive points that must remain above threshold.
unsigned	get_consecutive () const
	Get the number of consecutive points that must remain above threshold.
unsigned	get_last_harmonic () const
	Get the index of the last significant harmonic.
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 ()
const PhaseWeight *	get_baseline () const
void	get_indeces (int &rise, int &fall) const
	Get the harmonic indeces of the rise and fall (rise always equals 1) More...
TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to configure this instance.
LastHarmonic *	clone () const
	Return new copy of self.
Public Member Functions inherited from Pulsar::RiseFall
virtual std::pair< int, int >	get_rise_fall (const Profile *)
	Return the rise and fall as a pair.
Public Member Functions inherited from Pulsar::ProfileWeightFunction
	ProfileWeightFunction ()
	Default constructor.
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	build ()
	Compute the rise and fall of the pulse.
Protected Member Functions inherited from Pulsar::RiseFall
void	calculate (PhaseWeight *weight)
	Set the weights between rise and fall. More...
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
bool	built
	Flag set when the rise and fall are computed.
int	bin_rise
int	bin_fall
Reference::To< BaselineEstimator >	baseline_estimator
	The estimator used to find the off-pulse phase bins.
Reference::To< PhaseWeight >	baseline
	The basline returned by the estimator.
LastSignificant	significant
	The algorithm used to find the last signficant harmonic.
Reference::To< const Profile >	fluctuation_power_spectral_density
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 the last significant harmonic in a flucuation power spectral density.

The last significant harmonic is defined by number of consecutive points above threshold.

This class violates strong behavioural subtyping (aka Liskov Substitution Principle) by inheriting RiseFall, which inherits OnPulseEstimator, which inherits ProfileWeightFunction. It does so only to re-use the machinery of these classes. The Profile object passed to this object is also not a phase-resolved average; it is the squared modulus of the Fouier transform of what we usually call a Profile.

Member Function Documentation

get_indeces()

void Pulsar::LastHarmonic::get_indeces ( int &  rise, int &  fall  ) const

virtual

Get the harmonic indeces of the rise and fall (rise always equals 1)

Return values

rise	bin at which the cumulative power last remains above threshold
fall	bin at which the cumulative power first falls below threshold

Implements Pulsar::RiseFall.

set_Profile()

void Pulsar::LastHarmonic::set_Profile ( const Profile *  psd )

virtual

Set the flucuation power spectral density from which the last harmonic will be computed.

The profile passed to this function should be the flucuation power spectral density; i.e. the squared modulus of the Fourier transform of an average pulse profile

Reimplemented from Pulsar::ProfileWeightFunction.

Referenced by Pulsar::FluctSpectStats< Profile, ProfileStats >::build(), and Pulsar::ProfileShiftFit::choose_nharm().

---

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

• LastHarmonic.h
• LastHarmonic.C