Represents a boost (Hermitian, dichroic) transformation. More...

#include <BoostUnion.h>

Inheritance diagram for MEAL::BoostUnion:
MEAL::Complex2 MEAL::Evaluable< Jones< double > > MEAL::Function Reference::Able Reference::HeapTracked

Public Member Functions

void set_axis (Evaluable< Vector< 3, double > > *)
 Set the model that defines the unit vector.
void set_beta (Evaluable< double > *)
 Set the model that defines the boost parameter.
Vector< 3, double > get_axis () const
 Get the unit-vector along which the boost occurs.
double get_beta () const
 Get the boost parameter, beta.
std::string get_name () const
 Return the name of the class.
Public Member Functions inherited from MEAL::Complex2
virtual Complex2clone () const
 Clone method.
Public Member Functions inherited from MEAL::Evaluable< Jones< double > >
 Evaluable ()
 Default constructor.
Evaluableoperator= (const Evaluable &copy)
 Assignment operator.
Jones< double > evaluate (std::vector< Jones< double > > *grad=0) const
 Return the Jones matrix and its gradient.
EstimateTraits< Jones< 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.
Functionoperator= (const Function &model)
 Assignment operator.
virtual ~Function ()
 Virtual destructor.
virtual void copy (const Function *model)
 Does the work for operator =.
virtual TextInterface::Parserget_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 ParameterPolicyget_parameter_policy () const
 Provide access to the parameter_policy attribute.
ParameterPolicyget_parameter_policy ()
 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 &)
Ableoperator= (const Able &)
unsigned get_reference_count () const
Public Member Functions inherited from Reference::HeapTracked
 HeapTracked (const HeapTracked &)
HeapTrackedoperator= (const HeapTracked &)
bool __is_on_heap () const

Protected Member Functions

void calculate (Jones< double > &result, std::vector< Jones< double > > *)
 Calculate the Jones matrix and its gradient.
Protected Member Functions inherited from MEAL::Evaluable< Jones< double > >
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

Project< Evaluable< Vector< 3, double > > > axis
 The model that defines the axis.
Project< Evaluable< double > > beta
 The boost parameter.
Composite composite
 Composite parameter policy.
Protected Attributes inherited from MEAL::Evaluable< Jones< double > >
Reference::To< EvaluationPolicy< Jones< double > > > evaluation_policy
 The policy for managing function evaluation.
Protected Attributes inherited from MEAL::Function
Reference::To< ParameterPolicyparameter_policy
 The policy for managing function parameters.
Reference::To< ArgumentPolicyargument_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< Jones< double > >
typedef Jones< 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 Functionload_Function (const std::string &filename)
 Construct a new Function instance from a file.
static Functionfactory (const std::string &text)
 Construct a new Function instance 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 ()
Public Attributes inherited from MEAL::Function
Callback< Attributechanged
 Callback executed when a Function Attribute has been changed.
Static Public Attributes inherited from MEAL::Complex2
static const char * Name = "Complex2"
 The name of the class.
Static Public Attributes inherited from MEAL::Evaluable< Jones< 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 boost (Hermitian, dichroic) transformation.

This class represents the boost, $\beta$, along an axis, $\hat m$, defined by a unit vector model.

Member Function Documentation

◆ calculate()

void MEAL::BoostUnion::calculate ( Jones< double > & result,
std::vector< Jones< double > > * grad )
protectedvirtual

Calculate the Jones matrix and its gradient.

Implements MEAL::Evaluable< Jones< double > >.

References axis, beta, MEAL::cosh(), MEAL::Function::get_nparam(), MEAL::sinh(), and MEAL::Function::verbose.

◆ get_name()

string MEAL::BoostUnion::get_name ( ) const
virtual

Return the name of the class.

Implements MEAL::Function.

◆ set_beta()

void MEAL::BoostUnion::set_beta ( Evaluable< double > * _beta)

Set the model that defines the boost parameter.

Set the model that defines the unit vector.

References beta, and composite.


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

Generated using doxygen 1.14.0