rompy.core.grid.RegularGrid#

pydantic model rompy.core.grid.RegularGrid[source]#

Regular grid in geographic space.

This object provides an abstract representation of a regular grid in some geographic space.

Show JSON schema
{
   "title": "RegularGrid",
   "description": "Regular grid in geographic space.\n\nThis object provides an abstract representation of a regular grid in some\ngeographic space.",
   "type": "object",
   "properties": {
      "grid_type": {
         "const": "regular",
         "default": "regular",
         "description": "Type of grid, must be 'regular'",
         "title": "Grid Type",
         "type": "string"
      },
      "x0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "X coordinate of the grid origin",
         "title": "X0"
      },
      "y0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Y coordinate of the grid origin",
         "title": "Y0"
      },
      "rot": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Rotation angle of the grid in degrees",
         "title": "Rot"
      },
      "dx": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Spacing between grid points in the x direction",
         "title": "Dx"
      },
      "dy": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Spacing between grid points in the y direction",
         "title": "Dy"
      },
      "nx": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Number of grid points in the x direction",
         "title": "Nx"
      },
      "ny": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Number of grid points in the y direction",
         "title": "Ny"
      }
   },
   "additionalProperties": false
}

Fields:
Validators:
field dx: float | None = None#

Spacing between grid points in the x direction

Validated by:
field dy: float | None = None#

Spacing between grid points in the y direction

Validated by:
field grid_type: Literal['regular'] = 'regular'#

Type of grid, must be ‘regular’

Validated by:
field nx: int | None = None#

Number of grid points in the x direction

Validated by:
field ny: int | None = None#

Number of grid points in the y direction

Validated by:
field rot: float | None = 0.0#

Rotation angle of the grid in degrees

Validated by:
field x0: float | None = None#

X coordinate of the grid origin

Validated by:
field y0: float | None = None#

Y coordinate of the grid origin

Validated by:
validator generate  »  all fields[source]#

Generate the grid from the provided parameters.

property x: ndarray#
property xlen#
property y: ndarray#
property ylen#