Represents a unit vector in three-dimensional space. More...

#include <UnitTangent.h>

Inheritance diagram for MEAL::UnitTangent:

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

void	set_vector (Vector< 3, double > direction)
	Set the direction of the unit vector.

void	set_vector (const Vector< 3, Estimate< double > > &direction)
	Set the direction of the unit vector with error.

Vector< 3, double >	get_basis (unsigned i)
	Get the basis vector.

Public Member Functions inherited from MEAL::Evaluable< Vector< 3, double > >
	Evaluable ()
	Default constructor.

	Evaluable (const Evaluable &copy)
	Copy constructor.

Evaluable &	operator= (const Evaluable &copy)
	Assignment operator.

Vector< 3, double >	evaluate (std::vector< Vector< 3, double > > *grad=0) const
	Return the Jones matrix and its gradient.

EstimateTraits< Vector< 3, double > >::type	estimate () const
	Return the Jones Estimate matrix.

Public Member Functions inherited from MEAL::Function
	Function ()
	Default constructor.

	Function (const Function &model)
	Copy constructor.

Function &	operator= (const Function &model)
	Assignment operator.

virtual	~Function ()
	Virtual destructor.

virtual Function *	clone () const
	Clone.

virtual void	copy (const Function *model)
	Does the work for operator =.

virtual TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to access this instance.

virtual void	parse (const std::string &text)
	Parses the values of model parameters and fit flags from a string.

virtual void	print (std::string &text) const
	Prints the values of model parameters and fit flags to a string.

virtual std::string	get_description () const
	Return the description of the class.

unsigned	get_nparam () const
	Return the number of parameters.

std::string	get_param_name (unsigned index) const
	Return the name of the specified parameter.

std::string	get_param_description (unsigned index) const
	Return the description of the specified parameter.

double	get_param (unsigned index) const
	Return the value of the specified parameter.

void	set_param (unsigned index, double value)
	Set the value of the specified parameter.

double	get_variance (unsigned index) const
	Return the variance of the specified parameter.

void	set_variance (unsigned index, double value)
	Set the variance of the specified parameter.

bool	get_infit (unsigned index) const
	Return true if parameter at index is to be fitted.

void	set_infit (unsigned index, bool flag)
	Set flag for parameter at index to be fitted.

void	set_argument (unsigned dimension, Argument *axis)
	Set the independent variable of the specified dimension.

Estimate< double >	get_Estimate (unsigned index) const
	Return an Estimate of the specified parameter.

void	set_Estimate (unsigned index, const Estimate< double > &param)
	Set the Estimate of the specified parameter.

void	set_verbose (bool)
	Set the verbosity of this instance.

bool	get_verbose () const
	Get the verbosity of this instance.

void	set_evaluation_changed (bool _changed=true)
	Set true if the Function evaluation has changed.

bool	get_evaluation_changed () const
	Return true if the Function evaluation has changed.

const ParameterPolicy *	get_parameter_policy () const
	Provide access to the parameter_policy attribute.

bool	has_parameter_policy () const
	Some wrappers may not have a parameter policy.

virtual void	print_parameters (std::string &text, const std::string &separator) const
	Prints the values of model parameters and fit flags to a string.

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

Protected Member Functions inherited from MEAL::Evaluable< Vector< 3, double > >
void	calculate (Evaluable eval, Vector< 3, double > &result, std::vector< Vector< 3, double > > grad)
	Use the calculate method of another Evaluable instance.

void	copy_evaluation_policy (const Evaluable *other)

Protected Member Functions inherited from MEAL::Function
void	copy_evaluation_changed (const Function &model)
	Copy the evaluation changed state of another model instance.

void	copy_parameter_policy (const Function *)
	Copy the parameter policy of another instance.

void	set_parameter_policy (ParameterPolicy *policy)
	Set the parameter policy.

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

void	__dereference (bool auto_delete=true) const

Protected Attributes
Vector< 3, double >	basis [3]
	The current basis.

Protected Attributes inherited from MEAL::Evaluable< Vector< 3, double > >
Reference::To< EvaluationPolicy< Vector< 3, double > > >	evaluation_policy
	The policy for managing function evaluation.

Protected Attributes inherited from MEAL::Function
Reference::To< ParameterPolicy >	parameter_policy
	The policy for managing function parameters.

Reference::To< ArgumentPolicy >	argument_policy
	The policy for managing function arguments.

bool	set_parameter_policy_context
	Set the parameter policy context.

bool	this_verbose
	The verbosity of this instance.

Additional Inherited Members
Public Types inherited from MEAL::Evaluable< Vector< 3, double > >
typedef Vector< 3, double >	Result
	The return type of the evaluate method.

Public Types inherited from MEAL::Function
enum	Attribute { ParameterCount, Evaluation }
	Function attributes that require the attention of Composite models. More...

Static Public Member Functions inherited from MEAL::Function
template<class Model >
static Model *	load (const std::string &filename)
	Construct a new Model instance from a file.

static Function *	load_Function (const std::string &filename)
	Construct a new Function instance from a file.

static Function *	factory (const std::string &text)
	Construct a new Function instance from a string. More...

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
Callback< Attribute >	changed
	Callback executed when a Function Attribute has been changed.

Static Public Attributes inherited from MEAL::Evaluable< Vector< 3, double > >
static const char *	Name
	The name of the class.

Static Public Attributes inherited from MEAL::Function
static bool	verbose = false
	Verbosity flag.

static bool	very_verbose = false
	Low-level verbosity flag.

static bool	check_zero = false
	When set, some Functions will throw an Error if they evaluate to zero.

static bool	check_variance = false
	When set, some Functions will throw an Error if input variance <= 0.

static bool	cache_results = false
	When set, use the Cached evaluation policy and callbacks.

Detailed Description

Represents a unit vector in three-dimensional space.

This model of a unit vector solves the gimbal lock issue by redefining the basis as it moves. At any point, the coordinates of the vector are defined by (0,0). A step in the any of the two possible directions is defined as a step in the plane that is tangent to the unit sphere.

After such a step, when the evaluate method is called, the vector is renormalized, the unit vectors in the tangent plane are redefined, and the coordinates are reset to (0,0).

When choosing the new unit vectors in the tangent plane, the direction to the most distant axis (in Cartesian coordinates) is used to define the first direction.

Note that, in this representation, it is impossible to rotate the unit vector by more than 90 degrees in one step. This should also provide some stability during modelling.

Member Function Documentation

◆ calculate()

void MEAL::UnitTangent::calculate	(	Vector< 3, double > &	result,
		std::vector< Vector< 3, double > > *	grad
	)

protectedvirtual

Calculate the Vector and its gradient.

Calculate the Jones matrix and its gradient.

Implements MEAL::Evaluable< Vector< 3, double > >.

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

UnitTangent.h
UnitTangent.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ calculate()