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

Contains the classes for Horizontal 2D geometries of fields.

class epygram.geometries.H2DGeometry.H2DGeometry(*args, **kwargs)

Bases: epygram.geometries.D3Geometry.D3Geometry

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

Footprint:

dict(
    attr = dict(
        dimensions = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles grid dimensions.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        geoid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = footprints.stdtypes.FPDict::<<
                    as_dict:: dict()
                >>, 
            info = 'To specify geoid shape; actually used in projected geometries only.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        grid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles description of the horizontal grid.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        name = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Name of geometrical type of representation of points on                       the Globe.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['unstructured', 'reduced_gauss', 'regular_lonlat', 'mercator', 'lambert', 'rotated_reduced_gauss', 'polar_stereographic']),
        ), 
        position_on_horizontal_grid = dict(
            access = 'rwx', 
            alias = set([]), 
            default = '__unknown__', 
            info = 'Position of points w/r to the horizontal.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = str, 
            values = set(['center-left', 'lower-right', 'upper-right', 'lower-center', 'lower-left', 'center-right', 'upper-left', '__unknown__', 'upper-center', 'center']),
        ), 
        structure = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Type of geometry.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['H2D']),
        ), 
        vcoordinate = dict(
            access = 'rwx', 
            alias = set([]), 
            default = None, 
            info = 'Handles vertical geometry parameters.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = epygram.geometries.VGeometry.VGeometry, 
            values = set([]),
        ),
    ), 
    bind = [], 
    info = 'Not documented', 
    only = dict(), 
    priority = dict(
        level = footprints.priorities.PriorityLevel::DEFAULT,
    ),
)

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

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

Handles the geometry for a rectangular Horizontal 2-Dimensions Field. Abstract.

Footprint:

dict(
    attr = dict(
        dimensions = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles grid dimensions.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        geoid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = footprints.stdtypes.FPDict::<<
                    as_dict:: dict()
                >>, 
            info = 'To specify geoid shape; actually used in projected geometries only.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        grid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles description of the horizontal grid.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        name = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Name of geometrical type of representation of points on                       the Globe.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['unstructured', 'academic', 'regular_lonlat', 'mercator', 'lambert', 'polar_stereographic']),
        ), 
        position_on_horizontal_grid = dict(
            access = 'rwx', 
            alias = set([]), 
            default = '__unknown__', 
            info = 'Position of points w/r to the horizontal.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = str, 
            values = set(['center-left', 'lower-right', 'upper-right', 'lower-center', 'lower-left', 'center-right', 'upper-left', '__unknown__', 'upper-center', 'center']),
        ), 
        structure = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Type of geometry.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['H2D']),
        ), 
        vcoordinate = dict(
            access = 'rwx', 
            alias = set([]), 
            default = None, 
            info = 'Handles vertical geometry parameters.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = epygram.geometries.VGeometry.VGeometry, 
            values = set([]),
        ),
    ), 
    bind = [], 
    info = 'Not documented', 
    only = dict(), 
    priority = dict(
        level = footprints.priorities.PriorityLevel::DEFAULT,
    ),
)

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

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

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

Footprint:

dict(
    attr = dict(
        dimensions = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles grid dimensions.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        geoid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = footprints.stdtypes.FPDict::<<
                    as_dict:: dict()
                >>, 
            info = 'To specify geoid shape; actually used in projected geometries only.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        grid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles description of the horizontal grid.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        name = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Name of geometrical type of representation of points on                       the Globe.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['unstructured']),
        ), 
        position_on_horizontal_grid = dict(
            access = 'rwx', 
            alias = set([]), 
            default = '__unknown__', 
            info = 'Position of points w/r to the horizontal.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = str, 
            values = set(['center-left', 'lower-right', 'upper-right', 'lower-center', 'lower-left', 'center-right', 'upper-left', '__unknown__', 'upper-center', 'center']),
        ), 
        structure = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Type of geometry.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['H2D']),
        ), 
        vcoordinate = dict(
            access = 'rwx', 
            alias = set([]), 
            default = None, 
            info = 'Handles vertical geometry parameters.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = epygram.geometries.VGeometry.VGeometry, 
            values = set([]),
        ),
    ), 
    bind = [], 
    info = 'Not documented', 
    only = dict(), 
    priority = dict(
        level = footprints.priorities.PriorityLevel::DEFAULT,
    ),
)

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

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

Handles the geometry for an academic Horizontal 2-Dimensions Field.

Footprint:

dict(
    attr = dict(
        dimensions = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles grid dimensions.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        geoid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = footprints.stdtypes.FPDict::<<
                    as_dict:: dict()
                >>, 
            info = 'To specify geoid shape; actually used in projected geometries only.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        grid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles description of the horizontal grid.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        name = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Name of geometrical type of representation of points on                       the Globe.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['academic']),
        ), 
        position_on_horizontal_grid = dict(
            access = 'rwx', 
            alias = set([]), 
            default = '__unknown__', 
            info = 'Position of points w/r to the horizontal.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = str, 
            values = set(['center-left', 'lower-right', 'upper-right', 'lower-center', 'lower-left', 'center-right', 'upper-left', '__unknown__', 'upper-center', 'center']),
        ), 
        structure = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Type of geometry.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['H2D']),
        ), 
        vcoordinate = dict(
            access = 'rwx', 
            alias = set([]), 
            default = None, 
            info = 'Handles vertical geometry parameters.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = epygram.geometries.VGeometry.VGeometry, 
            values = set([]),
        ),
    ), 
    bind = [], 
    info = 'Not documented', 
    only = dict(), 
    priority = dict(
        level = footprints.priorities.PriorityLevel::DEFAULT,
    ),
)

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

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

Handles the geometry for a Regular Lon/Lat Horizontal 2-Dimensions Field.

Footprint:

dict(
    attr = dict(
        dimensions = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles grid dimensions.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        geoid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = footprints.stdtypes.FPDict::<<
                    as_dict:: dict()
                >>, 
            info = 'To specify geoid shape; actually used in projected geometries only.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        grid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles description of the horizontal grid.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        name = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Name of geometrical type of representation of points on                       the Globe.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['regular_lonlat']),
        ), 
        position_on_horizontal_grid = dict(
            access = 'rwx', 
            alias = set([]), 
            default = '__unknown__', 
            info = 'Position of points w/r to the horizontal.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = str, 
            values = set(['center-left', 'lower-right', 'upper-right', 'lower-center', 'lower-left', 'center-right', 'upper-left', '__unknown__', 'upper-center', 'center']),
        ), 
        structure = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Type of geometry.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['H2D']),
        ), 
        vcoordinate = dict(
            access = 'rwx', 
            alias = set([]), 
            default = None, 
            info = 'Handles vertical geometry parameters.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = epygram.geometries.VGeometry.VGeometry, 
            values = set([]),
        ),
    ), 
    bind = [], 
    info = 'Not documented', 
    only = dict(), 
    priority = dict(
        level = footprints.priorities.PriorityLevel::DEFAULT,
    ),
)

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

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

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

Footprint:

dict(
    attr = dict(
        dimensions = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles grid dimensions.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        geoid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = footprints.stdtypes.FPDict::<<
                    as_dict:: dict()
                >>, 
            info = 'To specify geoid shape; actually used in projected geometries only.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        grid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles description of the horizontal grid.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        name = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Name of geometrical type of representation of points on                       the Globe.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['lambert', 'space_view', 'polar_stereographic', 'mercator']),
        ), 
        position_on_horizontal_grid = dict(
            access = 'rwx', 
            alias = set([]), 
            default = '__unknown__', 
            info = 'Position of points w/r to the horizontal.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = str, 
            values = set(['center-left', 'lower-right', 'upper-right', 'lower-center', 'lower-left', 'center-right', 'upper-left', '__unknown__', 'upper-center', 'center']),
        ), 
        projection = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles projection information.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        projtool = dict(
            access = 'rxx', 
            alias = set([]), 
            default = 'pyproj', 
            info = 'To use pyproj or epygram.myproj.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            values = set([]),
        ), 
        structure = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Type of geometry.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['H2D']),
        ), 
        vcoordinate = dict(
            access = 'rwx', 
            alias = set([]), 
            default = None, 
            info = 'Handles vertical geometry parameters.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = epygram.geometries.VGeometry.VGeometry, 
            values = set([]),
        ),
    ), 
    bind = [], 
    info = 'Not documented', 
    only = dict(), 
    priority = dict(
        level = footprints.priorities.PriorityLevel::DEFAULT,
    ),
)

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

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

Handles the geometry for a Global Gauss grid Horizontal 2-Dimensions Field.

Footprint:

dict(
    attr = dict(
        dimensions = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles grid dimensions.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        geoid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = footprints.stdtypes.FPDict::<<
                    as_dict:: dict()
                >>, 
            info = 'To specify geoid shape; actually used in projected geometries only.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        grid = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Handles description of the horizontal grid.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = footprints.stdtypes.FPDict, 
            values = set([]),
        ), 
        name = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Name of geometrical type of representation of points on                       the Globe.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['reduced_gauss', 'rotated_reduced_gauss']),
        ), 
        position_on_horizontal_grid = dict(
            access = 'rwx', 
            alias = set([]), 
            default = '__unknown__', 
            info = 'Position of points w/r to the horizontal.', 
            optional = True, 
            outcast = set([]), 
            remap = dict(), 
            type = str, 
            values = set(['center-left', 'lower-right', 'upper-right', 'lower-center', 'lower-left', 'center-right', 'upper-left', '__unknown__', 'upper-center', 'center']),
        ), 
        structure = dict(
            access = 'rxx', 
            alias = set([]), 
            default = None, 
            info = 'Type of geometry.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            values = set(['H2D']),
        ), 
        vcoordinate = dict(
            access = 'rwx', 
            alias = set([]), 
            default = None, 
            info = 'Handles vertical geometry parameters.', 
            optional = False, 
            outcast = set([]), 
            remap = dict(), 
            type = epygram.geometries.VGeometry.VGeometry, 
            values = set([]),
        ),
    ), 
    bind = [], 
    info = 'Not documented', 
    only = dict(), 
    priority = dict(
        level = footprints.priorities.PriorityLevel::DEFAULT,
    ),
)