geolime.objects.grid_api

Classes:

Grid2D(metadata)

Grid3D(metadata)

Data:

List

The central part of internal API.

Functions:

create_grid_2d(origin, n_dim, cell_size[, angle])

Create a 2D grid from mesh parameters.

create_grid_3d(origin, n_dim, cell_size[, angle])

Create a 3D grid from mesh parameters.

grid_2d_from_bounds(origin, extent, cell_size)

Create a 2D grid from mesh bounds and cell size.

grid_3d_from_bounds(origin, extent, cell_size)

Create a 3D grid from mesh bounds and cell size.
geolime.objects.grid_api.create_grid_2d(origin: List[float], n_dim: List[float], cell_size: List[float], angle: List[float] = [0.0, 0.0, 0.0])

Create a 2D grid from mesh parameters.

Parameters

  • origin (List[float]) – Origin coordinates, bottom-left corner of the cell

  • n_dim (List[float]) – Mesh size array

  • cell_size (List[float]) – Cell size array

  • angle (type) – Rotation angle

Returns

GeoLime object 2D grid

Return type

type

geolime.objects.grid_api.create_grid_3d(origin: List[float], n_dim: List[float], cell_size: List[float], angle: List[float] = [0.0, 0.0, 0.0])

Create a 3D grid from mesh parameters.

Parameters

  • origin (List[float]) – Origin coordinates, bottom-left corner of the cell

  • n_dim (List[float]) – Mesh size array

  • cell_size (List[float]) – Cell size array

  • angle (type) – Rotation angle

Returns

GeoLime object 3D grid

Return type

type

geolime.objects.grid_api.grid_2d_from_bounds(origin: List[float], extent: List[float], cell_size: List[float], angle: List[float] = [0.0, 0.0, 0.0]) → geolime.objects.grid.Grid2D

Create a 2D grid from mesh bounds and cell size.

Parameters

  • origin (List[float]) – Origin coordinates

  • extent (List[float]) – Extent coordinates

  • cell_size (List[float]) – Cell size array

  • angle (List[float]) – Rotation angle

Returns

GeoLime object 2D grid

Return type

Grid2D

geolime.objects.grid_api.grid_3d_from_bounds(origin: List[float], extent: List[float], cell_size: List[float], angle: List[float] = [0.0, 0.0, 0.0]) → geolime.objects.grid.Grid3D

Create a 3D grid from mesh bounds and cell size.

Parameters

  • origin (List[float]) – Origin coordinates

  • extent (List[float]) – Extent coordinates

  • cell_size (List[float]) – Cell size array

  • angle (List[float]) – Angles of the grid

Returns

GeoLime object 2D grid

Return type

Grid3D