epygram.fields.PointField — Point 0-D Field class

Contains the class to for Point (0D == 1 value) fields.

---

epygram.fields.PointField.gimme_one_point(longitude, latitude, field_args=None, geometry_args=None, vertical_geometry_args=None, geometry_class=<class 'epygram.geometries.UnstructuredGeometry.UnstructuredGeometry'>)

Builds an empty PointField at given (longitude, latitude).

Parameters

• field_args – to be passed to field constructor, e.g. a validity

• geometry_args – to be passed to geometry constructor

• vertical_geometry_args – to be passed to vertical_geometry constructor

• geometry_class – geometry class tu use (default: UnstructuredGeometry)

---

class epygram.fields.PointField.PointField(*args, **kwargs)

Bases: epygram.fields.D3Field.D3Field

0-Dimension (point) field class. A field is defined by its identifier ‘fid’, its data, its geometry, and its validity.

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([‘Point’])

• 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 0x74bef55270a0>]>>.

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).

plotfield(over=(None, None), title='__timerange__', unit=None, datefmt=None, showgrid=True, figsize=None, plot_kwargs=None, legend_kwargs=None, rcparams=None)

Plot a PointField if only it has a time dimension.

Parameters

• over – any existing figure and/or ax to be used for the plot, given as a tuple (fig, ax), with None for missing objects. fig is the frame of the matplotlib figure, containing eventually several subplots (axes); ax is the matplotlib axes on which the drawing is done. When given (is not None), these objects must be coherent, i.e. ax being one of the fig axes.

• title – title of the plot. No title if None, time range if ‘__timerange__’.

• unit – unit for Y axis

• datefmt – date format to use, e.g. “%Y-%m-%d %H:%M:%S %Z”

• showgrid – True/False to show grid or not

• figsize – figure sizes in inches, e.g. (5, 8.5). Default figsize is config.plotsizes.

• plot_kwargs – arguments to be passed to matplotlib.axes.Axes.plot()

• legend_kwargs – arguments to be passed to matplotlib.axes.Axes.legend()

• rcparams – list of (*args, **kwargs) to be passed to pyplot.rc() defaults to [((‘font’,), dict(family=’serif’)),]

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).