epygram.geometries.H2DGeometry — Horizontal 2-D Geometry classes

Contains the classes for Horizontal 2D geometries of fields.

These classes have many methods defined in their parent classes, one shall navigate through inheritance to explore the available methods !

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

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

Handles the geometry for a rectangular Horizontal 2-Dimensions Field. 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.
    • Optional. Default is FPDict::<<as_dict:: dict(ellps = ‘WGS84’,)>>.
  • grid (footprints.stdtypes.FPDict) - rxx - Handles description of the horizontal grid.
  • name (builtins.str) - rxx - Name of geometrical type of representation of points on the Globe.
    • Values: set([‘unstructured’, ‘polar_stereographic’, ‘mercator’, ‘regular_lonlat’, ‘academic’, ‘lambert’])
  • position_on_horizontal_grid (builtins.str) - rwx - Position of points w/r to the horizontal.
    • Optional. Default is ‘__unknown__’.
    • Values: set([‘center’, ‘lower-center’, ‘upper-center’, ‘lower-right’, ‘__unknown__’, ‘upper-right’, ‘lower-left’, ‘center-right’, ‘upper-left’, ‘center-left’])
  • structure (builtins.str) - rxx - Type of geometry.
    • Values: set([‘H2D’])
  • vcoordinate (epygram.geometries.VGeometry.VGeometry) - rwx - Handles vertical geometry parameters.
dimensions

Undocumented footprint attribute

geoid

Undocumented footprint attribute

grid

Undocumented footprint attribute

name

Undocumented footprint attribute

position_on_horizontal_grid

Undocumented footprint attribute

structure

Undocumented footprint attribute

vcoordinate

Undocumented footprint attribute

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

Bases: epygram.geometries.H2DGeometry.H2DRectangularGridGeometry, epygram.geometries.D3Geometry.D3UnstructuredGeometry

Handles the geometry for an unstructured Horizontal 2-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.
    • Optional. Default is FPDict::<<as_dict:: dict(ellps = ‘WGS84’,)>>.
  • grid (footprints.stdtypes.FPDict) - rxx - Handles description of the horizontal grid.
  • name (builtins.str) - rxx - Name of geometrical type of representation of points on the Globe.
    • Values: set([‘unstructured’])
  • position_on_horizontal_grid (builtins.str) - rwx - Position of points w/r to the horizontal.
    • Optional. Default is ‘__unknown__’.
    • Values: set([‘center’, ‘lower-center’, ‘upper-center’, ‘lower-right’, ‘__unknown__’, ‘upper-right’, ‘lower-left’, ‘center-right’, ‘upper-left’, ‘center-left’])
  • structure (builtins.str) - rxx - Type of geometry.
    • Values: set([‘H2D’])
  • vcoordinate (epygram.geometries.VGeometry.VGeometry) - rwx - Handles vertical geometry parameters.
dimensions

Undocumented footprint attribute

geoid

Undocumented footprint attribute

grid

Undocumented footprint attribute

name

Undocumented footprint attribute

position_on_horizontal_grid

Undocumented footprint attribute

structure

Undocumented footprint attribute

vcoordinate

Undocumented footprint attribute

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

Bases: epygram.geometries.H2DGeometry.H2DRectangularGridGeometry, epygram.geometries.D3Geometry.D3AcademicGeometry

Handles the geometry for an academic Horizontal 2-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.
    • Optional. Default is FPDict::<<as_dict:: dict(ellps = ‘WGS84’,)>>.
  • grid (footprints.stdtypes.FPDict) - rxx - Handles description of the horizontal grid.
  • name (builtins.str) - rxx - Name of geometrical type of representation of points on the Globe.
    • Values: set([‘academic’])
  • position_on_horizontal_grid (builtins.str) - rwx - Position of points w/r to the horizontal.
    • Optional. Default is ‘__unknown__’.
    • Values: set([‘center’, ‘lower-center’, ‘upper-center’, ‘lower-right’, ‘__unknown__’, ‘upper-right’, ‘lower-left’, ‘center-right’, ‘upper-left’, ‘center-left’])
  • projection (footprints.stdtypes.FPDict) - rxx - Handles projection information.
  • structure (builtins.str) - rxx - Type of geometry.
    • Values: set([‘H2D’])
  • vcoordinate (epygram.geometries.VGeometry.VGeometry) - rwx - Handles vertical geometry parameters.
dimensions

Undocumented footprint attribute

geoid

Undocumented footprint attribute

grid

Undocumented footprint attribute

name

Undocumented footprint attribute

position_on_horizontal_grid

Undocumented footprint attribute

projection

Undocumented footprint attribute

structure

Undocumented footprint attribute

vcoordinate

Undocumented footprint attribute

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

Bases: epygram.geometries.H2DGeometry.H2DRectangularGridGeometry, epygram.geometries.D3Geometry.D3RegLLGeometry

Handles the geometry for a Regular Lon/Lat Horizontal 2-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.
    • Optional. Default is FPDict::<<as_dict:: dict(ellps = ‘WGS84’,)>>.
  • grid (footprints.stdtypes.FPDict) - rxx - Handles description of the horizontal grid.
  • name (builtins.str) - rxx - Name of geometrical type of representation of points on the Globe.
    • Values: set([‘regular_lonlat’])
  • position_on_horizontal_grid (builtins.str) - rwx - Position of points w/r to the horizontal.
    • Optional. Default is ‘__unknown__’.
    • Values: set([‘center’, ‘lower-center’, ‘upper-center’, ‘lower-right’, ‘__unknown__’, ‘upper-right’, ‘lower-left’, ‘center-right’, ‘upper-left’, ‘center-left’])
  • structure (builtins.str) - rxx - Type of geometry.
    • Values: set([‘H2D’])
  • vcoordinate (epygram.geometries.VGeometry.VGeometry) - rwx - Handles vertical geometry parameters.
dimensions

Undocumented footprint attribute

geoid

Undocumented footprint attribute

grid

Undocumented footprint attribute

name

Undocumented footprint attribute

position_on_horizontal_grid

Undocumented footprint attribute

structure

Undocumented footprint attribute

vcoordinate

Undocumented footprint attribute

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

Bases: epygram.geometries.H2DGeometry.H2DRectangularGridGeometry, epygram.geometries.D3Geometry.D3ProjectedGeometry

Handles the geometry for a Projected Horizontal 2-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.
    • Optional. Default is FPDict::<<as_dict:: dict(ellps = ‘WGS84’,)>>.
  • grid (footprints.stdtypes.FPDict) - rxx - Handles description of the horizontal grid.
  • name (builtins.str) - rxx - Name of geometrical type of representation of points on the Globe.
    • Values: set([‘polar_stereographic’, ‘mercator’, ‘lambert’, ‘space_view’])
  • position_on_horizontal_grid (builtins.str) - rwx - Position of points w/r to the horizontal.
    • Optional. Default is ‘__unknown__’.
    • Values: set([‘center’, ‘lower-center’, ‘upper-center’, ‘lower-right’, ‘__unknown__’, ‘upper-right’, ‘lower-left’, ‘center-right’, ‘upper-left’, ‘center-left’])
  • projection (footprints.stdtypes.FPDict) - rxx - Handles projection information.
  • structure (builtins.str) - rxx - Type of geometry.
    • Values: set([‘H2D’])
  • vcoordinate (epygram.geometries.VGeometry.VGeometry) - rwx - Handles vertical geometry parameters.
dimensions

Undocumented footprint attribute

geoid

Undocumented footprint attribute

grid

Undocumented footprint attribute

name

Undocumented footprint attribute

position_on_horizontal_grid

Undocumented footprint attribute

projection

Undocumented footprint attribute

structure

Undocumented footprint attribute

vcoordinate

Undocumented footprint attribute

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

Bases: epygram.geometries.H2DGeometry.H2DGeometry, epygram.geometries.D3Geometry.D3GaussGeometry

Handles the geometry for a Global Gauss grid Horizontal 2-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.
    • Optional. Default is FPDict::<<as_dict:: dict(ellps = ‘WGS84’,)>>.
  • grid (footprints.stdtypes.FPDict) - rxx - Handles description of the horizontal grid.
  • name (builtins.str) - rxx - Name of geometrical type of representation of points on the Globe.
    • Values: set([‘reduced_gauss’, ‘rotated_reduced_gauss’, ‘regular_gauss’])
  • position_on_horizontal_grid (builtins.str) - rwx - Position of points w/r to the horizontal.
    • Optional. Default is ‘__unknown__’.
    • Values: set([‘center’, ‘lower-center’, ‘upper-center’, ‘lower-right’, ‘__unknown__’, ‘upper-right’, ‘lower-left’, ‘center-right’, ‘upper-left’, ‘center-left’])
  • structure (builtins.str) - rxx - Type of geometry.
    • Values: set([‘H2D’])
  • vcoordinate (epygram.geometries.VGeometry.VGeometry) - rwx - Handles vertical geometry parameters.
dimensions

Undocumented footprint attribute

geoid

Undocumented footprint attribute

grid

Undocumented footprint attribute

name

Undocumented footprint attribute

position_on_horizontal_grid

Undocumented footprint attribute

structure

Undocumented footprint attribute

vcoordinate

Undocumented footprint attribute