finesse.parameter

Classes

GeometricParameter(parameter_info, owner)

Specialised parameter class for variables which are dependencies of ABCD matrices.

Parameter(parameter_info, owner)

ParameterRef(param)

A symbolic instance of a parameter in the model.

parameterproperty(fget, fset, flocked[, doc])

Descriptor class for declaring a simulation parameter.

Functions

bool_parameter(name, description[, units, ...])

A parameter of an element whose value is decribed by a True or False value.

deref(parameter)

Get the Parameter from a ParameterRef or Parameter (no-op).

enum_parameter(name, description, enum[, ...])

A parameter of an element whose value is decribed by a Enum definition.

float_parameter(name, description[, units, ...])

A parameter of an element whose value is decribed by a 64-bit floating point number.

info_parameter(name, description[, units])

Decorator to register an info parameter field in the class.

int_parameter(name, description[, units, ...])

A parameter of an element whose value is decribed by a 64-bit integer number.