Pulsar::ProfileWeightStatic Class Reference

Set the Profile weights to a user-specified value. More...

#include <ProfileWeightStatic.h>

Inheritance diagram for Pulsar::ProfileWeightStatic:

Public Member Functions
TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to configure this instance.
void	set_Profile (const Profile *)
	Set the Profile from which the PhaseWeight will be derived.
ProfileWeightStatic *	clone () const
	Return a copy constructed instance of self.
void	set_range (const Phase::Ranges &r)
	Set the profile phase bins.
Phase::Ranges	get_range () const
Public Member Functions inherited from Pulsar::ProfileWeightFunction
	ProfileWeightFunction ()
	Default constructor.
	ProfileWeightFunction (const ProfileWeightFunction &)
	Copy 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	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
Phase::Ranges	range
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

Set the Profile weights to a user-specified value.

Member Function Documentation

calculate()

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

protectedvirtual

Calculate the PhaseWeight.

Implements Pulsar::ProfileWeightFunction.

References Pulsar::ProfileWeightFunction::profile.

clone()

Pulsar::ProfileWeightStatic * Pulsar::ProfileWeightStatic::clone ( ) const

virtual

Return a copy constructed instance of self.

Implements Pulsar::ProfileWeightFunction.

get_interface()

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

virtual

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

Implements Pulsar::PhaseWeightFunction.

set_Profile()

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

virtual

Set the Profile from which the PhaseWeight will be derived.

Reimplemented from Pulsar::ProfileWeightFunction.

References Pulsar::ProfileWeightFunction::profile.

---

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

• ProfileWeightStatic.h
• ProfileWeightStatic.C