epygram.fields.V2DField — Vertical 2-D Field class

Contains the class that handle a Vertical 2D field.

class epygram.fields.V2DField.V2DField(*args, **kwargs)[source]

Bases: epygram.fields.V2DField.V2DCommonField, epygram.fields.D3Field.D3Field

Vertical 2-Dimension (section) real field class. A field is defined by its identifier ‘fid’, its data, its geometry, and its validity.

At least for now, it is designed somehow like a collection of V1DFields. And so is Geometry.

Note

This class is managed by footprint.

  • info: Not documented

  • priority: PriorityLevel::DEFAULT (rank=1)

Automatic parameters from the footprint:

  • comment (builtins.str) - rwd - Not documented, sorry.

    • Optional. Default is None.

  • fid (footprints.stdtypes.FPDict) - rwx - Not documented, sorry.

  • geometry (epygram.geometries.AbstractGeometry.Geometry) - rxx - Geometry defining the position of the field gridpoints.

  • misc_metadata (footprints.stdtypes.FPDict) - rwd - Not documented, sorry.

    • Optional. Default is FPDict::<<as_dict:: dict()>>.

  • processtype (builtins.str) - rwx - Generating process.

    • Optional. Default is None.

  • spectral_geometry (epygram.geometries.SpectralGeometry.SpectralGeometry) - rxx - For a spectral field, its spectral geometry handles spectral transforms and dimensions.

    • Optional. Default is None.

  • structure (builtins.str) - rxx - Type of Field geometry.

    • Values: set([‘V2D’])

  • units (builtins.str) - rwd - Not documented, sorry.

    • Optional. Default is ‘’.

  • validity (epygram.base.FieldValidityList) - rwx - Validity of the field.

    • Optional. Default is FieldValidityList::<<as_list:: [FieldValidity::<epygram.base.FieldValidity object at 0x74bef5557a60>]>>.

Constructor. See its footprint for arguments.

comment

(see the documentation above for more details).

fid

(see the documentation above for more details).

geometry

Geometry defining the position of the field gridpoints (see the documentation above for more details).

misc_metadata

(see the documentation above for more details).

processtype

Generating process (see the documentation above for more details).

spectral_geometry

For a spectral field, its spectral geometry handles spectral transforms and dimensions (see the documentation above for more details).

structure

Type of Field geometry (see the documentation above for more details).

units

(see the documentation above for more details).

validity

Validity of the field (see the documentation above for more details).