epygram.geometries.H1DGeometry — Horizontal 1-D Geometry class

Contains the classes for Horizontal 1D geometries of fields.

class epygram.geometries.H1DGeometry.H1DGeometry(*args, **kwargs)[source]

Bases: epygram.geometries.D3Geometry.D3Geometry

Handles the geometry for a Vertical 2-Dimensions Field. Abstract mother class.

Note

This class is managed by footprint.

  • info: Not documented
  • priority: PriorityLevel::DEFAULT (rank=1)

Automatic parameters from the footprint:

  • dimensions (footprints.stdtypes.FPDict) - rxx - Handles grid dimensions.
  • geoid (footprints.stdtypes.FPDict) - rxx - To specify geoid shape; actually used in projected geometries only.
    • Optional. Default is FPDict::<<as_dict:: dict()>>.
  • grid (footprints.stdtypes.FPDict) - rxx - Handles description of the horizontal grid.
  • name (str) - rxx - Name of geometrical type of representation of points on the Globe.
    • Values: set([‘reduced_gauss’, ‘regular_lonlat’, ‘lambert’, ‘rotated_reduced_gauss’, ‘unstructured’, ‘regular_gauss’, ‘mercator’, ‘polar_stereographic’])
  • position_on_horizontal_grid (str) - rwx - Position of points w/r to the horizontal.
    • Optional. Default is ‘__unknown__’.
    • Values: set([‘center-left’, ‘lower-right’, ‘upper-right’, ‘lower-center’, ‘lower-left’, ‘center-right’, ‘upper-left’, ‘__unknown__’, ‘upper-center’, ‘center’])
  • structure (str) - rxx - Type of geometry.
    • Values: set([‘H1D’])
  • vcoordinate (epygram.geometries.VGeometry.VGeometry) - rwx - Handles vertical geometry parameters.
class epygram.geometries.H1DGeometry.H1DRectangularGridGeometry(*args, **kwargs)[source]

Bases: epygram.geometries.H1DGeometry.H1DGeometry, epygram.geometries.D3Geometry.D3RectangularGridGeometry

Handles the geometry for a Verical 1-Dimensions Field for which the surface points come from a rectangular grid. Abstract.

Note

This class is managed by footprint.

  • info: Not documented
  • priority: PriorityLevel::DEFAULT (rank=1)

Automatic parameters from the footprint:

  • dimensions (footprints.stdtypes.FPDict) - rxx - Handles grid dimensions.
  • geoid (footprints.stdtypes.FPDict) - rxx - To specify geoid shape; actually used in projected geometries only.
    • Optional. Default is FPDict::<<as_dict:: dict()>>.
  • grid (footprints.stdtypes.FPDict) - rxx - Handles description of the horizontal grid.
  • name (str) - rxx - Name of geometrical type of representation of points on the Globe.
    • Values: set([‘lambert’, ‘space_view’, ‘mercator’, ‘polar_stereographic’, ‘unstructured’])
  • position_on_horizontal_grid (str) - rwx - Position of points w/r to the horizontal.
    • Optional. Default is ‘__unknown__’.
    • Values: set([‘center-left’, ‘lower-right’, ‘upper-right’, ‘lower-center’, ‘lower-left’, ‘center-right’, ‘upper-left’, ‘__unknown__’, ‘upper-center’, ‘center’])
  • structure (str) - rxx - Type of geometry.
    • Values: set([‘H1D’])
  • vcoordinate (epygram.geometries.VGeometry.VGeometry) - rwx - Handles vertical geometry parameters.
class epygram.geometries.H1DGeometry.H1DUnstructuredGeometry(*args, **kwargs)[source]

Bases: epygram.geometries.H1DGeometry.H1DRectangularGridGeometry, epygram.geometries.D3Geometry.D3UnstructuredGeometry

Handles the geometry for an unstructured Horizontal 1-Dimensions Field.

Note

This class is managed by footprint.

  • info: Not documented
  • priority: PriorityLevel::DEFAULT (rank=1)

Automatic parameters from the footprint:

  • dimensions (footprints.stdtypes.FPDict) - rxx - Handles grid dimensions.
  • geoid (footprints.stdtypes.FPDict) - rxx - To specify geoid shape; actually used in projected geometries only.
    • Optional. Default is FPDict::<<as_dict:: dict()>>.
  • grid (footprints.stdtypes.FPDict) - rxx - Handles description of the horizontal grid.
  • name (str) - rxx - Name of geometrical type of representation of points on the Globe.
    • Values: set([‘unstructured’])
  • position_on_horizontal_grid (str) - rwx - Position of points w/r to the horizontal.
    • Optional. Default is ‘__unknown__’.
    • Values: set([‘center-left’, ‘lower-right’, ‘upper-right’, ‘lower-center’, ‘lower-left’, ‘center-right’, ‘upper-left’, ‘__unknown__’, ‘upper-center’, ‘center’])
  • structure (str) - rxx - Type of geometry.
    • Values: set([‘H1D’])
  • vcoordinate (epygram.geometries.VGeometry.VGeometry) - rwx - Handles vertical geometry parameters.
class epygram.geometries.H1DGeometry.H1DProjectedGeometry(*args, **kwargs)[source]

Bases: epygram.geometries.H1DGeometry.H1DRectangularGridGeometry, epygram.geometries.D3Geometry.D3ProjectedGeometry

Handles the geometry for a Projected Horizontal 1-Dimensions Field.

Note

This class is managed by footprint.

  • info: Not documented
  • priority: PriorityLevel::DEFAULT (rank=1)

Automatic parameters from the footprint:

  • dimensions (footprints.stdtypes.FPDict) - rxx - Handles grid dimensions.
  • geoid (footprints.stdtypes.FPDict) - rxx - To specify geoid shape; actually used in projected geometries only.
    • Optional. Default is FPDict::<<as_dict:: dict()>>.
  • grid (footprints.stdtypes.FPDict) - rxx - Handles description of the horizontal grid.
  • name (str) - rxx - Name of geometrical type of representation of points on the Globe.
    • Values: set([‘lambert’, ‘space_view’, ‘polar_stereographic’, ‘mercator’])
  • position_on_horizontal_grid (str) - rwx - Position of points w/r to the horizontal.
    • Optional. Default is ‘__unknown__’.
    • Values: set([‘center-left’, ‘lower-right’, ‘upper-right’, ‘lower-center’, ‘lower-left’, ‘center-right’, ‘upper-left’, ‘__unknown__’, ‘upper-center’, ‘center’])
  • projection (footprints.stdtypes.FPDict) - rxx - Handles projection information.
  • projtool (str) - rxx - To use pyproj or epygram.myproj.
    • Optional. Default is ‘pyproj’.
  • structure (str) - rxx - Type of geometry.
    • Values: set([‘H1D’])
  • vcoordinate (epygram.geometries.VGeometry.VGeometry) - rwx - Handles vertical geometry parameters.