rompy.swan.subcomponents.base.IJ#

pydantic model rompy.swan.subcomponents.base.IJ[source]#

Points in grid indices coordinates.

< [x] [y] >

Note

Coordinates should be given in m when Cartesian coordinates are used or degrees when Spherical coordinates are used (see command COORD).

Examples

In [235]: from rompy.swan.subcomponents.base import IJ

In [236]: points = IJ(i=[0, 0, 5], j=[0, 19, 19])

In [237]: print(points.render())

i=0 j=0
i=0 j=19
i=5 j=19

Show JSON schema
{
   "title": "IJ",
   "description": "Points in grid indices coordinates.\n\n.. code-block:: text\n\n    < [x] [y] >\n\nNote\n----\nCoordinates should be given in m when Cartesian coordinates are used or degrees\nwhen Spherical coordinates are used (see command `COORD`).\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.base import IJ\n    points = IJ(i=[0, 0, 5], j=[0, 19, 19])\n    print(points.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "ij",
         "description": "Model type discriminator",
         "enum": [
            "ij",
            "IJ"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "i": {
         "description": "i-index values",
         "items": {
            "type": "integer"
         },
         "title": "I",
         "type": "array"
      },
      "j": {
         "description": "j-index values",
         "items": {
            "type": "integer"
         },
         "title": "J",
         "type": "array"
      }
   },
   "additionalProperties": false,
   "required": [
      "i",
      "j"
   ]
}

Fields:
Validators:
field i: list[int] [Required]#

i-index values

Validated by:
field j: list[int] [Required]#

j-index values

Validated by:
field model_type: Literal['ij', 'IJ'] = 'ij'#

Model type discriminator

Validated by:
cmd() → str[source]#
validator validate_size  »  all fields[source]#
property size#