welltestpy.data.Observation

class Observation(name, observation, time=None, description='Observation')

Bases: object

Class for a observation.

This is a class for time-dependent observations. It has a name and a description.

Parameters

• name (str) – Name of the Variable.

• observation (Variable) – Name of the Variable. Default: "x"

• time (Variable) – Value of the Variable.

• description (str, optional) – Description of the Variable. Default: "Observation"

Attributes

info

Get information about the observation.

kind

str: name of the observation variable.

label

[tuple of] str: symbol in units.

labels

[tuple of] str: symbol in units.

observation

Observed values of the observation.

state

str: String containing state of the observation.

time

Time values of the observation.

units

[tuple of] str: units of the observation.

value

Value of the Observation.

Methods

__call__([observation, time])	Call a variable.
reshape()	Reshape observations to flat array.
save([path, name])	Save an observation to file.

__call__(observation=None, time=None)

Call a variable.

Here you can set a new value or you can get the value of the variable.

Parameters

• observation (scalar, numpy.ndarray, Variable, optional) – New Value for observation. Default: "None"

• time (scalar, numpy.ndarray, Variable, optional) – New Value for time. Default: "None"

Returns

• [tuple of] int or float

• or numpy.ndarray – (time, observation) or observation.

reshape()

Reshape observations to flat array.

save(path='', name=None)

Save an observation to file.

This writes the observation to a csv file.

Parameters

• path (str, optional) – Path where the variable should be saved. Default: ""

• name (str, optional) – Name of the file. If None, the name will be generated by "Obs_"+name. Default: None

Notes

The file will get the suffix ".obs".

property info

Get information about the observation.

Here you can display information about the observation.

property kind

name of the observation variable.

Type

str

property label

symbol in units.

Type

[tuple of] str

property labels

symbol in units.

Type

[tuple of] str

property observation

Observed values of the observation.

int or float or numpy.ndarray

property state

String containing state of the observation.

Either "steady" or "transient".

Type

str

property time

Time values of the observation.

int or float or numpy.ndarray

property units

units of the observation.

Type

[tuple of] str

property value

Value of the Observation.

[tuple of] int or float or numpy.ndarray