sbmlsim.simulation.range
¶
Module handling ranges.
Module Contents¶
Classes¶
Range class. |
|
VectorRange class. |
|
UniformRangeType. |
|
UniformRange class. |
|
DataRange class. |
|
FunctionalRange class. |
|
Define dimension for a scan. |
Attributes¶
- class sbmlsim.simulation.range.Range(sid, name=None)[source]¶
Bases:
sbmlsim.simulation.base.BaseObject
Range class.
The Range class is the base class for the different types of ranges, i.e. UniformRange, VectorRange, FunctionalRange, and DataRange.
- Parameters:
sid (str) –
name (str) –
- class sbmlsim.simulation.range.VectorRange(sid, values, name=None)[source]¶
Bases:
Range
VectorRange class.
The VectorRange describes an ordered collection of real values, listing them explicitly within child value elements.
- Parameters:
sid (str) –
values (Union[List, Tuple, numpy.ndarray]) –
name (str) –
- class sbmlsim.simulation.range.UniformRangeType[source]¶
Bases:
enum.Enum
UniformRangeType.
Attribute type that can take the values linear or log. Determines whether to draw the values logarithmically (with a base of 10) or linearly.
- class sbmlsim.simulation.range.UniformRange(sid, start, end, steps, range_type=UniformRangeType.linear, name=None)[source]¶
Bases:
Range
UniformRange class.
The UniformRange on the preceding page) allows the definition of a Range with uniformly spaced values. The range_type determines whether to draw the values logarithmically (with a base of 10) or linearly.
- Parameters:
sid (str) –
start (float) –
end (float) –
steps (int) –
range_type (UniformRangeType) –
name (str) –
- class sbmlsim.simulation.range.DataRange(sid, source_ref, name=None)[source]¶
Bases:
Range
DataRange class.
The DataRange constructs a range by reference to external data. The sourceRef must point to a DataDescription with a single dimension, whose values are used as the values of the range.
- Parameters:
sid (str) –
source_ref (str) –
name (str) –
- class sbmlsim.simulation.range.FunctionalRange(sid, variables, parameters, math, range, name=None)[source]¶
Bases:
sbmlsim.simulation.calculation.Calculation
,Range
FunctionalRange class.
The FunctionalRange constructs a range through calculations that determine the next value based on the value(s) of other range(s) or model variables. In this it is similar to the ComputeChange element, and shares some of the same child elements (but is not a subclass of ComputeChange).
- Parameters:
sid (str) –
variables (List[sbmlsim.simulation.calculation.Variable]) –
parameters (List[sbmlsim.simulation.calculation.Parameter]) –
math (str) –
range (str) –
name (str) –