MEAL::NormalizeStokes Class Reference

Normalize Stokes parameters by the invariant interval. More...

#include <NormalizeStokes.h>

Inheritance diagram for MEAL::NormalizeStokes:

Public Member Functions
	NormalizeStokes ()
	Default constructor.
	NormalizeStokes (const NormalizeStokes &)
	Copy constructor.
	~NormalizeStokes ()
	Destructor.
void	set_other (const Estimate< double > &other)
	Set the other term in the denominator.
NormalizeStokes &	operator= (const NormalizeStokes &)
	Assignment operator.
void	normalize (Stokes< Estimate< float > > &stokes)
	Normalize the Stokes parameters by their invariant interval.
void	normalize (Stokes< Estimate< double > > &stokes)
	Normalize the Stokes parameters by their invariant interval.
void	normalize (Stokes< Estimate< double > > &stokes, const Estimate< double > &total_squared_invariant)
	Normalize the Stokes parameters by the total invariant interval.
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 Attributes
Reference::To< Invariant >	invariant
	Calculates the invariant interval and its bias.
Reference::To< ScalarParameter >	other
	The other term in the denominator.
Stokes< ScalarMath >	output
	The output Stokes parameters.

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 ()
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Normalize Stokes parameters by the invariant interval.

This class properly handles the propagation of errors during normalization.

Member Function Documentation

normalize()

void MEAL::NormalizeStokes::normalize

(

Stokes< Estimate< double > > &

stokes

)

Normalize the Stokes parameters by their invariant interval.

Set the scale to be used during conversion.

References invariant, other, and output.

---

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

• NormalizeStokes.h
• NormalizeStokes.C