NamedGriddedField3

class pyarts3.arts.NamedGriddedField3(*args, **kwargs)

A 4 dimensional gridded set of Numeric data

The grid is a combination of 1 ArrayOfString and 3 Vector

Both the data and the grid may be named

Overview

Method

conj()

See numpy.ndarray.conj

Method

conjugate()

See numpy.ndarray.conjugate

Method

copy()

See numpy.ndarray.copy

Method

cumprod()

See numpy.ndarray.cumprod

Method

cumsum()

See numpy.ndarray.cumsum

Method

diagonal()

See numpy.ndarray.diagonal

Method

fill()

See numpy.ndarray.fill

Method

flatten()

See numpy.ndarray.flatten

Method

max()

See numpy.ndarray.max

Method

mean()

See numpy.ndarray.mean

Method

min()

See numpy.ndarray.min

Method

nonzero()

See numpy.ndarray.nonzero

Method

ok()

Check the field

Method

prod()

See numpy.ndarray.prod

Method

ravel()

See numpy.ndarray.ravel

Method

readxml()

Read variable from file

Method

repeat()

See numpy.ndarray.repeat

Method

reshape()

See numpy.ndarray.reshape

Method

round()

See numpy.ndarray.round

Method

savexml()

Saves variable to file

Method

squeeze()

See numpy.ndarray.squeeze

Method

std()

See numpy.ndarray.std

Method

sum()

See numpy.ndarray.sum

Method

to_dict()

Convert object to dict.

Method

to_xarray()

Create xarray.DataArray from the object.

Method

tolist()

See numpy.ndarray.tolist

Method

trace()

See numpy.ndarray.trace

Method

transpose()

See numpy.ndarray.transpose

Method

var()

See numpy.ndarray.var

Static Method

from_dict()

Create object from dict.

Static Method

from_xarray()

Create object from xarray.DataArray.

Static Method

fromxml()

Create variable from file

Attribute

T

See numpy.ndarray.T.

Attribute

data

The data itself

Attribute

dataname

Name of the data

Attribute

dtype

See numpy.ndarray.dtype.

Attribute

gridnames

The grid names

Attribute

grids

The grid of the data

Attribute

imag

See numpy.ndarray.imag.

Attribute

itemsize

See numpy.ndarray.itemsize.

Attribute

nbytes

See numpy.ndarray.nbytes.

Attribute

ndim

See numpy.ndarray.ndim.

Attribute

real

See numpy.ndarray.real.

Attribute

shape

See numpy.ndarray.shape.

Attribute

size

See numpy.ndarray.size.

Attribute

strides

See numpy.ndarray.strides.

Attribute

value

A ndarray of the object.

Static Data

pyarts3.arts.NamedGriddedField3.dim

4 (int)

Operator

__abs__()

See numpy.ndarray.__abs__

Operator

__add__()

See numpy.ndarray.__add__

Operator

__and__()

See numpy.ndarray.__and__

Operator

__array__()

Allows array() to be called with the object.

Operator

__contains__()

See numpy.ndarray.__contains__

Operator

__divmod__()

See numpy.ndarray.__divmod__

Operator

__eq__()

Overloaded function.

Operator

__floordiv__()

See numpy.ndarray.__floordiv__

Operator

__format__()

__format__(self, arg: str, /) -> str

Operator

__ge__()

See numpy.ndarray.__ge__

Operator

__getitem__()

See numpy.ndarray.__getitem__

Operator

__getstate__()

Helper for pickle.

Operator

__gt__()

See numpy.ndarray.__gt__

Operator

__hash__()

Return hash(self).

Operator

__iadd__()

See numpy.ndarray.__iadd__

Operator

__iand__()

See numpy.ndarray.__iand__

Operator

__ifloordiv__()

See numpy.ndarray.__ifloordiv__

Operator

__imatmul__()

See numpy.ndarray.__imatmul__

Operator

__imod__()

See numpy.ndarray.__imod__

Operator

__imul__()

See numpy.ndarray.__imul__

Operator

__init__()

__init__(self, arg: pyarts3.arts.NamedGriddedField3) -> None

Operator

__ior__()

See numpy.ndarray.__ior__

Operator

__ipow__()

See numpy.ndarray.__ipow__

Operator

__isub__()

See numpy.ndarray.__isub__

Operator

__iter__()

See numpy.ndarray.__iter__

Operator

__itruediv__()

See numpy.ndarray.__itruediv__

Operator

__le__()

See numpy.ndarray.__le__

Operator

__len__()

See numpy.ndarray.__len__

Operator

__lt__()

See numpy.ndarray.__lt__

Operator

__matmul__()

See numpy.ndarray.__matmul__

Operator

__mod__()

See numpy.ndarray.__mod__

Operator

__mul__()

See numpy.ndarray.__mul__

Operator

__ne__()

Overloaded function.

Operator

__or__()

See numpy.ndarray.__or__

Operator

__pow__()

See numpy.ndarray.__pow__

Operator

__radd__()

See numpy.ndarray.__radd__

Operator

__rand__()

See numpy.ndarray.__rand__

Operator

__rdivmod__()

See numpy.ndarray.__rdivmod__

Operator

__repr__()

__repr__(self) -> str

Operator

__rfloordiv__()

See numpy.ndarray.__rfloordiv__

Operator

__rmatmul__()

See numpy.ndarray.__rmatmul__

Operator

__rmod__()

See numpy.ndarray.__rmod__

Operator

__rmul__()

See numpy.ndarray.__rmul__

Operator

__ror__()

See numpy.ndarray.__ror__

Operator

__rpow__()

See numpy.ndarray.__rpow__

Operator

__rsub__()

See numpy.ndarray.__rsub__

Operator

__rtruediv__()

See numpy.ndarray.__rtruediv__

Operator

__setitem__()

See numpy.ndarray.__setitem__

Operator

__str__()

__str__(self) -> str

Operator

__truediv__()

See numpy.ndarray.__truediv__

Constructors

__init__(self) → None
__init__(self, name: str = '', data: pyarts3.arts.Tensor4, grid_names: collections.abc.Sequence[str] = ['', '', '', ''], grids: tuple[pyarts3.arts.ArrayOfString, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.Vector]) → None
__init__(self, arg: dict, /) → None
__init__(self) → None
__init__(self, arg: pyarts3.arts.NamedGriddedField3) → None

Methods

conj(self) → object

See numpy.ndarray.conj

conjugate(self) → object

See numpy.ndarray.conjugate

copy(self, order: str = 'C') → object

See numpy.ndarray.copy

cumprod(self, axis: object | None = None, dtype: object | None = None, out: object | None = None) → object

See numpy.ndarray.cumprod

cumsum(self, axis: object | None = None, dtype: object | None = None, out: object | None = None) → object

See numpy.ndarray.cumsum

diagonal(self, offset: object = 0, axis1: object = 0, axis2: object = 1) → object

See numpy.ndarray.diagonal

fill(self, value: object) → object

See numpy.ndarray.fill

flatten(self, order: str = 'C') → object

See numpy.ndarray.flatten

max(self, axis: object | None = None, out: object | None = None, keepdims: object = False) → object

See numpy.ndarray.max

mean(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, keepdims: object = False) → object

See numpy.ndarray.mean

min(self, axis: object | None = None, out: object | None = None, keepdims: object = False) → object

See numpy.ndarray.min

nonzero(self) → object

See numpy.ndarray.nonzero

ok(self) → bool

Check the field

prod(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, keepdims: object = False) → object

See numpy.ndarray.prod

ravel(self, order: object = 'C') → object

See numpy.ndarray.ravel

readxml(self, file: str) → str

Read variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

repeat(self, repeats: object, axis: object | None = None) → object

See numpy.ndarray.repeat

reshape(self, shape: object, order: object = 'C') → object

See numpy.ndarray.reshape

round(self, decimals: object = 0, out: object | None = None) → object

See numpy.ndarray.round

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) → str

Saves variable to file

Parameters:

  • file (str) – The path to which the file is written. Note that several of the options might modify the name or write more files

  • type (str) – Type of file to save. See FileType for options.

  • clobber (bool) – Overwrite existing files or add new file with modified name?

On Error:

Throws RuntimeError for any failure to save

squeeze(self, axis: object | None = None) → object

See numpy.ndarray.squeeze

std(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, ddof: object = 0, keepdims: object = False) → object

See numpy.ndarray.std

sum(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, keepdims: object = False) → object

See numpy.ndarray.sum

to_dict(self) → dict

Convert object to dict.

to_xarray(self) → object

Create xarray.DataArray from the object.

tolist(self) → object

See numpy.ndarray.tolist

trace(self, offset: object = 0, axis1: object = 0, axis2: object = 1, dtype: object | None = None, out: object | None = None) → object

See numpy.ndarray.trace

transpose(self, *axes) → object

See numpy.ndarray.transpose

var(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, ddof: object = 0, keepdims: object = False) → object

See numpy.ndarray.var

Static Methods

from_dict(arg: dict, /) → pyarts3.arts.NamedGriddedField3

Create object from dict.

from_xarray(arg: object, /) → object

Create object from xarray.DataArray.

fromxml(file: str) → pyarts3.arts.NamedGriddedField3

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

T: object

See numpy.ndarray.T.

data: object

The data itself

dataname: String

Name of the data

dtype: object

See numpy.ndarray.dtype.

gridnames: list[str]

The grid names

grids: list[object]

The grid of the data

imag: object

See numpy.ndarray.imag.

itemsize: object

See numpy.ndarray.itemsize.

nbytes: object

See numpy.ndarray.nbytes.

ndim: object

See numpy.ndarray.ndim.

real: object

See numpy.ndarray.real.

shape: object

See numpy.ndarray.shape.

size: object

See numpy.ndarray.size.

strides: object

See numpy.ndarray.strides.

value: numpy.ndarray

A ndarray of the object.

Operators

__abs__(self) → object

See numpy.ndarray.__abs__

__add__(self, value: object) → object

See numpy.ndarray.__add__

__and__(self, value: object) → object

See numpy.ndarray.__and__

__array__(self, dtype: object | None = None, copy: object | None = None) → object

Allows array() to be called with the object.

__contains__(self, key: object) → object

See numpy.ndarray.__contains__

__divmod__(self, value: object) → object

See numpy.ndarray.__divmod__

__eq__(self, value: pyarts3.arts.NamedGriddedField3) → bool
__eq__(self, value: object) → object

Overloaded function.

  1. __eq__(self, value: pyarts3.arts.NamedGriddedField3) -> bool

Allows self == value

  1. __eq__(self, value: object) -> object

See numpy.ndarray.__eq__

__floordiv__(self, value: object) → object

See numpy.ndarray.__floordiv__

__format__(self, arg: str, /) → str
__ge__(self, value: object) → object

See numpy.ndarray.__ge__

__getitem__(self, key: object) → object

See numpy.ndarray.__getitem__

__getstate__()

Helper for pickle.

__gt__(self, value: object) → object

See numpy.ndarray.__gt__

__hash__()

Return hash(self).

__iadd__(self, value: object) → object

See numpy.ndarray.__iadd__

__iand__(self, value: object) → object

See numpy.ndarray.__iand__

__ifloordiv__(self, value: object) → object

See numpy.ndarray.__ifloordiv__

__imatmul__(self, value: object) → object

See numpy.ndarray.__imatmul__

__imod__(self, value: object) → object

See numpy.ndarray.__imod__

__imul__(self, value: object) → object

See numpy.ndarray.__imul__

__init__(self) → None
__init__(self, name: str = '', data: pyarts3.arts.Tensor4, grid_names: collections.abc.Sequence[str] = ['', '', '', ''], grids: tuple[pyarts3.arts.ArrayOfString, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.Vector]) → None
__init__(self, arg: dict, /) → None
__init__(self) → None
__init__(self, arg: pyarts3.arts.NamedGriddedField3) → None
__ior__(self, value: object) → object

See numpy.ndarray.__ior__

__ipow__(self, value: object) → object

See numpy.ndarray.__ipow__

__isub__(self, value: object) → object

See numpy.ndarray.__isub__

__iter__(self) → object

See numpy.ndarray.__iter__

__itruediv__(self, value: object) → object

See numpy.ndarray.__itruediv__

__le__(self, value: object) → object

See numpy.ndarray.__le__

__len__(self) → object

See numpy.ndarray.__len__

__lt__(self, value: object) → object

See numpy.ndarray.__lt__

__matmul__(self, value: object) → object

See numpy.ndarray.__matmul__

__mod__(self, value: object) → object

See numpy.ndarray.__mod__

__mul__(self, value: object) → object

See numpy.ndarray.__mul__

__ne__(self, value: pyarts3.arts.NamedGriddedField3) → bool
__ne__(self, value: object) → object

Overloaded function.

  1. __ne__(self, value: pyarts3.arts.NamedGriddedField3) -> bool

Allows self != value

  1. __ne__(self, value: object) -> object

See numpy.ndarray.__ne__

__or__(self, value: object) → object

See numpy.ndarray.__or__

__pow__(self, value: object, mod: object | None = None) → object

See numpy.ndarray.__pow__

__radd__(self, value: object) → object

See numpy.ndarray.__radd__

__rand__(self, value: object) → object

See numpy.ndarray.__rand__

__rdivmod__(self, value: object) → object

See numpy.ndarray.__rdivmod__

__repr__(self) → str
__rfloordiv__(self, value: object) → object

See numpy.ndarray.__rfloordiv__

__rmatmul__(self, value: object) → object

See numpy.ndarray.__rmatmul__

__rmod__(self, value: object) → object

See numpy.ndarray.__rmod__

__rmul__(self, value: object) → object

See numpy.ndarray.__rmul__

__ror__(self, value: object) → object

See numpy.ndarray.__ror__

__rpow__(self, value: object, mod: object | None = None) → object

See numpy.ndarray.__rpow__

__rsub__(self, value: object) → object

See numpy.ndarray.__rsub__

__rtruediv__(self, value: object) → object

See numpy.ndarray.__rtruediv__

__setitem__(self, key: object, value: object) → object

See numpy.ndarray.__setitem__

__str__(self) → str
__truediv__(self, value: object) → object

See numpy.ndarray.__truediv__