Pulsar::PolnProfileStats Class Reference

Computes polarimetric pulse profile statistics. More...

#include <PolnProfileStats.h>

Inheritance diagram for Pulsar::PolnProfileStats:

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

Public Member Functions
	PolnProfileStats (const PolnProfile *profile=0)
	Default constructor.
	~PolnProfileStats ()
	Destructor.
void	set_avoid_zero_determinant (bool flag=true)
	Avoid on-pulse phase bins with det(rho) close to zero.
void	set_profile (const PolnProfile *)
	Set the PolnProfile from which statistics will be derived.
void	select_profile (const PolnProfile *)
	Set the PolnProfile that defines the baseline and on-pulse regions.
void	select_profile (const Profile *)
	Set the Profile that defines the baseline and on-pulse regions.
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.
ProfileStats *	get_stats ()
	Get the ProfileStats estimator.
const ProfileStats *	get_stats () const
void	set_stats (ProfileStats *s)
	Set the ProfileStats estimator.
Stokes< Estimate< double > >	get_stokes (unsigned ibin) const
	Get the Stokes parameters for the specified phase bin.
Estimate< double >	get_total_intensity () const
	Returns the total flux of the on-pulse phase bins.
Estimate< double >	get_total_polarized () const
	Returns the total polarized flux of the on-pulse phase bins.
Estimate< double >	get_total_polarized_squared () const
	Returns the total squared polarized flux of the on-pulse phase bins.
Estimate< double >	get_total_squared_invariant () const
	Returns the total squared invariant of the on-pulse phase bins.
Estimate< double >	get_total_determinant () const
	Returns the total determinant of the on-pulse phase bins.
Estimate< double >	get_total_linear () const
	Returns the total linearly polarized flux of the on-pulse phase bins.
Estimate< double >	get_total_linear_squared () const
	Returns the total linearly polarized flux squared of the on-pulse phase bins.
Estimate< double >	get_total_circular () const
	Returns the total circularly polarized flux of the on-pulse phase bins.
Estimate< double >	get_total_abs_circular () const
	Returns the total absolute value of circularly polarized flux.
Estimate< double >	get_baseline_variance (unsigned ipol) const
	Returns the variance of the baseline for the specified polarization.
Estimate< double >	get_invariant () const
	Returns the square root of the total squared invariant.
double	get_linear_variance () const
	Returns the vairance of the linearly polarized flux.
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

Protected Member Functions
void	build ()
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
Reference::To< const PolnProfile, false >	profile
	The PolnProfile from which statistics will be derived.
Reference::To< ProfileStats >	stats
	Computes the statistics of a single pulse profile.
bool	regions_set
	True when the onpulse and baseline regions have been set.
bool	avoid_zero_determinant
	True when zero determinant phase bins should be avoided.
Stokes< Estimate< double > >	baseline_variance
	The variance of the total intensity baseline.

Additional Inherited Members
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

Computes polarimetric pulse profile statistics.

Member Function Documentation

build()

void Pulsar::PolnProfileStats::build ( )

protected

Computes the phase bin masks

References avoid_zero_determinant, baseline_variance, get_baseline_variance(), profile, regions_set, stats, and Signal::Stokes.

Referenced by select_profile(), set_profile(), and set_regions().

get_stokes()

Stokes< Estimate< double > > Pulsar::PolnProfileStats::get_stokes

(

unsigned

ibin

)

const

Get the Stokes parameters for the specified phase bin.

Get the Stokes parameters of the specified phase bin.

References get_baseline_variance(), and profile.

Referenced by get_total_squared_invariant(), and Pulsar::FourthMomentStats::separate().

get_total_linear_squared()

Estimate< double > Pulsar::PolnProfileStats::get_total_linear_squared

(

)

const

Returns the total linearly polarized flux squared of the on-pulse phase bins.

Returns the total linearly polarized flux of the on-pulse phase bins.

References profile, regions_set, and stats.

get_total_polarized_squared()

Estimate< double > Pulsar::PolnProfileStats::get_total_polarized_squared

(

)

const

Returns the total squared polarized flux of the on-pulse phase bins.

Returns the total polarized flux of the on-pulse phase bins.

References profile, and stats.

get_total_squared_invariant()

Estimate< double > Pulsar::PolnProfileStats::get_total_squared_invariant

(

)

const

Returns the total squared invariant of the on-pulse phase bins.

Returns the total of the squared invariant of the on-pulse phase bins.

References get_stokes(), profile, and stats.

Referenced by get_invariant(), and get_total_determinant().

select_profile()

void Pulsar::PolnProfileStats::select_profile

(

const PolnProfile *

_profile

)

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

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

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

References build(), profile, and regions_set.

Referenced by PolnProfileStats().

---

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

• PolnProfileStats.h
• PolnProfileStats.C