utils.coords.handshake_size

Import path: earth2studio.utils.coords.handshake_size

View source on GitHub

Documentation

Simple check to see if a coordinate system of a given dimension is a required size

Parameters:

• input_coords (CoordSystem) –

  Input coordinate system to validate

• required_dim (str) –

  Required dimension (name of coordinate)

• required_size (int) –

  Required coordinate system size

Raises:

• KeyError –

  If required dim is not present in input coordinate system

• ValueError –

  If required dimension is not of required size

Note

Presently assumes coordinate system of given dimension is 1D