synthpic2.recipe.process_conditions.variabilities

Module for the Variability class.

Module Contents

Classes

Variability	Variability class.
UniformlyRandomLocationInMeasurementVolume	Return a uniformly random coordinate location inside the MeasurementVolume.
UniformDistribution3dHomogeneous	Return a uniform distribution of 3-tuples, each with identical elements.
UniformDistributionNdHomogeneous	Return a uniform distribution of n-tuples, each with identical elements. If n=1,
LogNormal3dHomogeneous	Return a log-normal distribution of 3-tuples, each with identical elements.
Constant	Return a constant.

class synthpic2.recipe.process_conditions.variabilities.Variability

Bases: abc.ABC

Variability class.

__attrs_post_init__() → None

abstract __call__() → Any

_parse_attributes() → None

Parse string attributes that include a set.

class synthpic2.recipe.process_conditions.variabilities.UniformlyRandomLocationInMeasurementVolume

Bases: Variability

Return a uniformly random coordinate location inside the MeasurementVolume.

__call__() → Tuple[float, float, float]

class synthpic2.recipe.process_conditions.variabilities.UniformDistribution3dHomogeneous

Bases: Variability

Return a uniform distribution of 3-tuples, each with identical elements.

location: float

scale: float

__call__() → tuple[float, float, float]

class synthpic2.recipe.process_conditions.variabilities.UniformDistributionNdHomogeneous

Bases: Variability

Return a uniform distribution of n-tuples, each with identical elements. If n=1, returns a float.

location: float

scale: float

num_dimensions: int = 1

__call__() → float | tuple[float, Ellipsis]

class synthpic2.recipe.process_conditions.variabilities.LogNormal3dHomogeneous

Bases: Variability

Return a log-normal distribution of 3-tuples, each with identical elements.

# pylint: disable=line-too-long see https://numpy.org/doc/stable/reference/random/generated/numpy.random.lognormal.html

mean = log(geometric_mean) sigma = log(geometric_standard_deviation)

geometric_mean: float

geometric_standard_deviation: float

min: float

max: float

__call__() → Tuple[float, float, float]

class synthpic2.recipe.process_conditions.variabilities.Constant

Bases: Variability

Return a constant.

value: Any

__call__() → Any