Pulsar::PhaseWeightModifier Class Reference

PhaseWeight algorithms that receive an input PhaseWeight. More...

#include <PhaseWeightModifier.h>

Inheritance diagram for Pulsar::PhaseWeightModifier:

Public Member Functions
virtual void	set_weight (const PhaseWeight *)
	Set the PhaseWeight from which the PhaseWeight will be derived.
virtual void	get_weight (PhaseWeight *weight)
	Returns a PhaseWeight.
void	operator() (PhaseWeight *)
	Inplace operator.
TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to configure this instance.
Public Member Functions inherited from Pulsar::PhaseWeightFunction
virtual PhaseWeightFunction *	clone () const =0
	Return a copy constructed instance of self.
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
virtual void	calculate (PhaseWeight *)=0
	Derived classes implement the PhaseWeight calculation.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
Reference::To< const PhaseWeight >	input_weight
	The PhaseWeight from which the PhaseWeight will be derived.

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

PhaseWeight algorithms that receive an input PhaseWeight.

Member Function Documentation

calculate()

virtual void Pulsar::PhaseWeightModifier::calculate ( PhaseWeight * )

protectedpure virtual

Derived classes implement the PhaseWeight calculation.

Implemented in Pulsar::ConvertIsolated, Pulsar::MaskSmooth, and Pulsar::PhaseWeightShift.

Referenced by get_weight().

get_interface()

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

virtual

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

Implements Pulsar::PhaseWeightFunction.

get_weight()

void Pulsar::PhaseWeightModifier::get_weight ( PhaseWeight * weight )

virtual

Returns a PhaseWeight.

Returns a PhaseWeight with the Weight attribute set.

Implements Pulsar::PhaseWeightFunction.

References calculate(), and input_weight.

Referenced by operator()().

---

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

• PhaseWeightModifier.h
• PhaseWeightModifier.C