Faraday rotation transformation. More...

#include <Faraday.h>

Inheritance diagram for Calibration::Faraday:

Public Types
typedef Jones< double >	Return
	enable use with the ColdPlasma template

Public Types inherited from Evaluable< Jones< double > >
typedef Jones< double >	Result

Public Types inherited from MEAL::Function
enum	Attribute

Public Member Functions
	Faraday ()
	Default constructor.

std::string	get_name () const
	Return the name of the class.

void	set_rotation_measure (const Estimate< double > &rotation_measure)
	Set the rotation measure.

Estimate< double >	get_rotation_measure () const
	Get the rotation measure.

void	set_reference_frequency (double MHz)
	Set the reference frequency in MHz.

double	get_reference_frequency () const
	Get the reference frequency in MHz.

void	set_frequency (double MHz)
	Set the frequency in MHz.

double	get_frequency () const
	Get the frequency in MHz.

void	set_reference_wavelength (double metres)
	Set the reference wavelength in metres.

double	get_reference_wavelength () const
	Get the reference wavelength in metres.

void	set_wavelength (double metres)
	Set the wavelength in metres.

double	get_wavelength () const
	Get the wavelength in metres.

void	set_axis (const Vector< 3, double > &axis)
	Set the axis about which the rotation occurs.

double	get_rotation () const
	Get the Faraday rotation angle.

void	set_measure (double rotation_measure)
	Set the rotation measure. More...

double	get_measure () const
	Get the rotation measure. More...

Public Member Functions inherited from MEAL::Complex2
virtual Complex2 *	clone () const

Public Member Functions inherited from Evaluable< Jones< double > >
	Evaluable (const Evaluable &copy)

Evaluable &	operator= (const Evaluable &copy)

Jones< double >	evaluate (std::vector< Jones< double > > *grad=0) const

EstimateTraits< Jones< double > >::type	estimate () const

Public Member Functions inherited from MEAL::Function
	Function (const Function &model)

Function &	operator= (const Function &model)

virtual void	copy (const Function *model)

virtual TextInterface::Parser *	get_interface ()

virtual void	parse (const std::string &text)

virtual void	print (std::string &text) const

virtual std::string	get_description () const

unsigned	get_nparam () const

std::string	get_param_name (unsigned index) const

std::string	get_param_description (unsigned index) const

double	get_param (unsigned index) const

void	set_param (unsigned index, double value)

double	get_variance (unsigned index) const

void	set_variance (unsigned index, double value)

bool	get_infit (unsigned index) const

void	set_infit (unsigned index, bool flag)

void	set_argument (unsigned dimension, Argument *axis)

Estimate< double >	get_Estimate (unsigned index) const

void	set_Estimate (unsigned index, const Estimate< double > &param)

void	set_verbose (bool)

bool	get_verbose () const

void	set_evaluation_changed (bool _changed=true)

bool	get_evaluation_changed () const

const ParameterPolicy *	get_parameter_policy () const

bool	has_parameter_policy () const

virtual void	print_parameters (std::string &text, const std::string &separator) const

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 (Jones< double > &result, std::vector< Jones< double > > *grad)
	Calculate the Jones matrix and its gradient.

Protected Member Functions inherited from Evaluable< Jones< double > >
void	calculate (Evaluable eval, Jones< double > &result, std::vector< Jones< double > > grad)

Protected Member Functions inherited from MEAL::Function
void	copy_evaluation_changed (const Function &model)

void	copy_parameter_policy (const Function *)

void	set_parameter_policy (ParameterPolicy *policy)

Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const

void	__dereference (bool auto_delete=true) const

Protected Attributes
MEAL::Rotation1	rotation
	The Rotation operation.

double	reference_wavelength
	Reference wavelength in metres.

double	wavelength
	Wavelength in metres.

Protected Attributes inherited from Evaluable< Jones< double > >
Reference::To< EvaluationPolicy< Jones< double > > >	evaluation_policy

Protected Attributes inherited from MEAL::Function
Reference::To< ParameterPolicy >	parameter_policy

Reference::To< ArgumentPolicy >	argument_policy

bool	set_parameter_policy_context

bool	this_verbose

Additional Inherited Members
Static Public Member Functions inherited from MEAL::Function
static Model *	load (const std::string &filename)

static Function *	load_Function (const std::string &filename)

static Function *	factory (const std::string &text)

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 ()

Public Attributes inherited from MEAL::Function
	ParameterCount

	Evaluation

Callback< Attribute >	changed

Static Public Attributes inherited from MEAL::Complex2
static const char *	Name

Static Public Attributes inherited from Evaluable< Jones< double > >
static const char *	Name

Static Public Attributes inherited from MEAL::Function
static bool	verbose

static bool	very_verbose

static bool	check_zero

static bool	check_variance

static bool	cache_results

Detailed Description

Faraday rotation transformation.

This class computes the Faraday rotation between two frequencies, as parameterized by the rotation measure.

Member Function Documentation

◆ get_measure()

double Calibration::Faraday::get_measure ( ) const

Get the rotation measure.

This alias enables use of this class with the ColdPlasma template

◆ set_measure()

void Calibration::Faraday::set_measure ( double rm )

Set the rotation measure.

This alias enables use of this class with the ColdPlasma template

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

Faraday.h
Faraday.C

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_measure()

◆ set_measure()