welltestpy.data.CoordinatesVar
- class CoordinatesVar(lat, lon, symbol='[Lat,Lon]', units='[deg,deg]', description='Coordinates given in degree-North and degree-East')[source]
Bases:
Variable
Variable class special for coordinates.
- Parameters
lat (
int
orfloat
ornumpy.ndarray
) – Lateral values of the coordinates.lon (
int
orfloat
ornumpy.ndarray
) – Longitutional values of the coordinates.symbole (
str
, optional) – Name of the Variable. Default:"[Lat,Lon]"
units (
str
, optional) – Units of the Variable. Default:"[deg,deg]"
description (
str
, optional) – Description of the Variable. Default:"Coordinates given in degree-North and degree-East"
Notes
Here the variable name is fix set to
"coordinates"
.lat
andlon
should have the same shape.- Attributes
Methods
__call__
([value])Call a variable.
save
([path, name])Save a variable to file.
- __call__(value=None)
Call a variable.
Here you can set a new value or you can get the value of the variable.
- Parameters
value (
int
orfloat
ornumpy.ndarray
,)optional – Value of the Variable. Default:
None
- Returns
value – Value of the Variable.
- Return type
int
orfloat
ornumpy.ndarray
- save(path='', name=None)
Save a variable to file.
This writes the variable to a csv file.
- Parameters
Notes
The file will get the suffix
".var"
.
- property value
Value.
- Type
int
orfloat
ornumpy.ndarray