interface¶
import tensorwaves.interface
Defines top-level interface of tensorwaves.
- DataSample¶
Mapping of variable names to a sequence of data points, used by
Function
.alias of
Mapping
[Union
[int
,str
],numpy.ndarray
]
- class DataTransformer[source]¶
Bases:
abc.ABC
Interface of a data converter.
- abstract transform(dataset: Mapping[Union[int, str], ndarray]) Mapping[Union[int, str], ndarray] [source]¶
Transform a dataset into another dataset.
This changes the keys and values of the input
DataSample
to a specific outputDataSample
structure.
- class Estimator[source]¶
Bases:
abc.ABC
Estimator for discrepancy model and data.
- class FitResult(minimum_valid: bool, execution_time: float, function_calls: int, estimator_value: float, parameter_values: Optional[Dict[str, Union[complex, float]]] = None, parameter_errors: Optional[Dict[str, Union[complex, float]]] = None, iterations: Optional[int] = None, specifics: Optional[Any] = None)[source]¶
Bases:
object
- __eq__(other)¶
Method generated by attrs for class FitResult.
- count_number_of_parameters(complex_twice: bool = False) int [source]¶
Compute the number of free parameters in a
FitResult
.- Parameters
fit_result (FitResult) – Fit result from which to count it’s
parameter_values
.complex_twice (bool) – Count complex-valued parameters twice.
- specifics: Optional[Any]¶
Any additional info provided by the specific optimizer.
An instance returned by one of the implemented optimizers under the
optimizer
module. Currently one of:This way, you can for instance get the
covariance
matrix. See also Covariance matrix.
- class Function[source]¶
Bases:
abc.ABC
Interface of a callable function.
The parameters of the model are separated from the domain variables. This follows the mathematical definition, in which a function defines its domain and parameters. However specific points in the domain are not relevant. Hence while the domain variables are the argument of the evaluation (see
__call__()
), the parameters are controlled via a getter and setter (seeparameters()
). The reason for this separation is to facilitate the events when parameters have changed.
- class Model[source]¶
Bases:
abc.ABC
Interface of a model which can be lambdified into a callable.
- abstract lambdify(backend: Union[str, tuple, dict]) Callable [source]¶
Lambdify the model into a Callable.
- Parameters
backend – Choice of backend for fast evaluations.
The arguments of the Callable are union of the variables and parameters. The return value of the Callable is Any. In theory the return type should be a value type depending on the model. Currently, there no typing support is implemented for this.
- abstract property parameters: Dict[str, Union[complex, float]]¶
Get mapping of parameters to suggested initial values.
- class PhaseSpaceGenerator[source]¶
Bases:
abc.ABC
Abstract class for generating phase space samples.
- abstract generate(size: int, rng: UniformRealNumberGenerator) Tuple[Mapping[Union[int, str], ndarray], ndarray] [source]¶
Generate phase space sample.
- Returns
A
tuple
of aDataSample
(four-momenta) with an event-wise sequence of weights. The four-momenta are arrays of shape \(n \times 4\).
- abstract setup(initial_state_mass: float, final_state_masses: Mapping[int, float]) None [source]¶
Hook for initialization of the
PhaseSpaceGenerator
.Called before any
generate()
calls.- Parameters
initial_state_mass – Mass of the decaying state.
final_state_masses – A mapping of final state IDs to the corresponding masses.