epygram.fields.V1DField — Vertical 1-D Field

Contains the class that handle a Vertical 1D field.

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

Bases: epygram.fields.D3Field._D3CommonField

Vertical 1-Dimension (column) virtual or not 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.

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

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

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

    • Values: set([‘V1D’])

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

    • Optional. Default is ‘’.

Constructor. See its footprint for arguments.

comment

(see the documentation above for more details).

fid

(see the documentation above for more details).

misc_metadata

(see the documentation above for more details).

plotanimation(*args, **kwargs)[source]

Cf. eponymous function of module for arguments.

plotfield(*args, **kwargs)[source]

Interface method to methods plotprofiles() and plotverticalhovmoller(), depending on time dimension (or not).

Cf. these functions for arguments.

plotprofiles(*args, **kwargs)[source]

Cf. eponymous function of module for arguments.

plotverticalhovmoller(*args, **kwargs)[source]

Cf. eponymous function of module for arguments.

structure

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

units

(see the documentation above for more details).

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

Bases: epygram.fields.V1DField.V1DCommonField, epygram.fields.D3Field.D3Field

Vertical 1-Dimension (column) real 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) - rwx - 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([‘V1D’])

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

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

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

Bases: epygram.fields.V1DField.V1DCommonField, epygram.fields.D3Field.D3VirtualField

Vertical 1-Dimension (column) virtual 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.

  • fieldset (epygram.base.FieldSet) - rxx - Set of real fields that can compose the Virtual Field.

    • Optional. Default is FieldSet::<<as_list:: []>>.

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

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

  • resource (epygram.base.Resource) - rxx - Resource in which is stored the fields defined by resource_fids.

    • Optional. Default is None.

  • resource_fids (footprints.stdtypes.FPList) - rxx - Definition of the fields in resource that compose the virtual field.

    • Optional. Default is FPList::<<as_list:: []>>.

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

    • Values: set([‘V1D’])

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

    • Optional. Default is ‘’.

Constructor. See its footprint for arguments.

comment

(see the documentation above for more details).

fid

(see the documentation above for more details).

fieldset

Set of real fields that can compose the Virtual Field (see the documentation above for more details).

misc_metadata

(see the documentation above for more details).

resource

Resource in which is stored the fields defined by resource_fids (see the documentation above for more details).

resource_fids

Definition of the fields in resource that compose the virtual field (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).

Functions

epygram.fields.V1DField.plotprofiles(profiles, over=(None, None), labels=None, fidkey=None, Ycoordinate=None, unit='SI', title=None, logscale=False, ema=False, zoom=None, figsize=(6.0, 9.0), rcparams=None, colors=None, legend_kwargs=None)[source]

To plot a series of profiles. Returns a tuple of matplotlib (Figure, ax).

Parameters

  • profiles – a epygram.base.FieldSet of epygram.fields.V1DField, or a single epygram.fields.V1DField. All profiles are supposed to have the same unit, and the same vertical coordinate.

  • 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, e.g. ax being one of the fig axes.

  • labels – a list of labels for the profiles (same length and same order).

  • fidkey – key of fid for labelling the curve with fid[fidkey]; if None, labels with raw fid.

  • Ycoordinate – label for the Y coordinate.

  • unit – label for X coordinate.

  • title – title for the plot.

  • logscale – to set Y logarithmic scale

  • ema – to make emagram-like plots of Temperature

  • zoom –

    a dict containing optional limits to zoom on the plot.

    Syntax: e.g. {‘ymax’:500, …}.

  • figsize – figure sizes in inches, e.g. (5, 8.5). If None, get the default figsize in config.plotsizes.

  • rcparams –

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

    ((‘figure’,), dict(autolayout=True))]

  • colors – list of matplotlib colors on which to iterate to plot each profile. Cyclic (with varying linestyle) if shorter than the number of profiles.

  • legend_kwargs – kwargs to be passed to matplotlib’s legend()

epygram.fields.V1DField.plotverticalhovmoller(profile, over=(None, None), fidkey=None, Ycoordinate=None, title=None, logscale=False, zoom=None, colorbar='vertical', graphicmode='colorshades', minmax=None, levelsnumber=21, center_cmap_on_0=False, colormap='jet', minmax_in_title=True, contourcolor='k', contourwidth=1, contourlabel=True, datefmt=None, showgrid=True, figsize=(6.0, 9.0), rcparams=None)[source]

Makes a simple vertical Hovmöller plot of the field.

Parameters

  • profile – being a epygram.fields.V1DField

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

  • fidkey – type of fid for entitling the plot with fid[fidkey], if title is None; if None, labels with raw fid.

  • Ycoordinate – label for the Y coordinate.

  • title – title for the plot.

  • logscale – to set Y logarithmic scale

  • zoom –

    a dict containing optional limits to zoom on the plot.

    Syntax: e.g. {‘ymax’:500, …}.

  • colorbar – if False, hide colorbar the plot; else, befines the colorbar orientation, among (‘horizontal’, ‘vertical’). Defaults to ‘vertical’.

  • graphicmode – among (‘colorshades’, ‘contourlines’).

  • minmax –

    defines the min and max values for the plot colorbar.

    Syntax: [min, max]. [0.0, max] also works. Default is min/max of the field.

  • levelsnumber – number of levels for contours and colorbar.

  • center_cmap_on_0 – aligns the colormap center on the value 0.

  • colormap – name of the matplotlib colormap to use.

  • minmax_in_title – if True and minmax is not None, adds min and max values in title

  • contourcolor – color or colormap to be used for ‘contourlines’ graphicmode. It can be either a legal html color name, or a colormap name.

  • contourwidth – width of contours for ‘contourlines’ graphicmode.

  • contourlabel – displays labels on contours.

  • 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). If None, get the default figsize in config.plotsizes.

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

Warning: requires matplotlib.

epygram.fields.V1DField.plotanimation(profile, title='__auto__', repeat=False, interval=1000, **kwargs)[source]

To plot a time-dependent profile as an animation. Returns a matplotlib.animation.FuncAnimation.

Parameters

  • profile – the epygram.fields.V1DField to plot.

  • title – title for the plot. ‘__auto__’ (default) will print the current validity of the time frame.

  • repeat – to repeat animation

  • interval – number of milliseconds between two validities

Other kwargs passed to plotprofiles().