# {py:mod}`equi7grid.core`

```{py:module} equi7grid.core
```

```{autodoc2-docstring} equi7grid.core
:parser: source.docstrings_parser
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Equi7Tile <equi7grid.core.Equi7Tile>`
  - ```{autodoc2-docstring} equi7grid.core.Equi7Tile
    :parser: source.docstrings_parser
    :summary:
    ```
* - {py:obj}`Equi7TilingSystem <equi7grid.core.Equi7TilingSystem>`
  - ```{autodoc2-docstring} equi7grid.core.Equi7TilingSystem
    :parser: source.docstrings_parser
    :summary:
    ```
* - {py:obj}`Equi7Grid <equi7grid.core.Equi7Grid>`
  - ```{autodoc2-docstring} equi7grid.core.Equi7Grid
    :parser: source.docstrings_parser
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`get_user_equi7grid <equi7grid.core.get_user_equi7grid>`
  - ```{autodoc2-docstring} equi7grid.core.get_user_equi7grid
    :parser: source.docstrings_parser
    :summary:
    ```
* - {py:obj}`get_standard_equi7grid <equi7grid.core.get_standard_equi7grid>`
  - ```{autodoc2-docstring} equi7grid.core.get_standard_equi7grid
    :parser: source.docstrings_parser
    :summary:
    ```
* - {py:obj}`get_equi7grid_from_grid_def <equi7grid.core.get_equi7grid_from_grid_def>`
  - ```{autodoc2-docstring} equi7grid.core.get_equi7grid_from_grid_def
    :parser: source.docstrings_parser
    :summary:
    ```
* - {py:obj}`get_equi7grid_from_file <equi7grid.core.get_equi7grid_from_file>`
  - ```{autodoc2-docstring} equi7grid.core.get_equi7grid_from_file
    :parser: source.docstrings_parser
    :summary:
    ```
* - {py:obj}`allowed_samplings <equi7grid.core.allowed_samplings>`
  - ```{autodoc2-docstring} equi7grid.core.allowed_samplings
    :parser: source.docstrings_parser
    :summary:
    ```
````

### API

````{py:class} Equi7Tile
:canonical: equi7grid.core.Equi7Tile

Bases: {py:obj}`pytileproj.RasterTile`\[{py:obj}`typing.Any`\]

```{autodoc2-docstring} equi7grid.core.Equi7Tile
:parser: source.docstrings_parser
```

````

`````{py:class} Equi7TilingSystem(/, **data: typing.Any)
:canonical: equi7grid.core.Equi7TilingSystem

Bases: {py:obj}`pytileproj.RegularProjTilingSystem`

```{autodoc2-docstring} equi7grid.core.Equi7TilingSystem
:parser: source.docstrings_parser
```

```{rubric} Initialization
```

```{autodoc2-docstring} equi7grid.core.Equi7TilingSystem.__init__
:parser: source.docstrings_parser
```

````{py:method} get_tile_from_name(ftilename: str) -> equi7grid.core.Equi7Tile
:canonical: equi7grid.core.Equi7TilingSystem.get_tile_from_name

```{autodoc2-docstring} equi7grid.core.Equi7TilingSystem.get_tile_from_name
:parser: source.docstrings_parser
```

````

````{py:method} get_tiles_in_geog_bbox(bbox: tuple[float, float, float, float], tiling_id: int | str, *, cover_land: bool = False) -> equi7grid.core.Equi7TileGenerator
:canonical: equi7grid.core.Equi7TilingSystem.get_tiles_in_geog_bbox

```{autodoc2-docstring} equi7grid.core.Equi7TilingSystem.get_tiles_in_geog_bbox
:parser: source.docstrings_parser
```

````

````{py:method} get_tiles_in_geom(proj_geom: pytileproj.ProjGeom, tiling_id: int | str, *, cover_land: bool = False) -> equi7grid.core.Equi7TileGenerator
:canonical: equi7grid.core.Equi7TilingSystem.get_tiles_in_geom

```{autodoc2-docstring} equi7grid.core.Equi7TilingSystem.get_tiles_in_geom
:parser: source.docstrings_parser
```

````

````{py:method} calc_length_distortion(x: float | numpy.ndarray, y: float | numpy.ndarray) -> float | numpy.ndarray
:canonical: equi7grid.core.Equi7TilingSystem.calc_length_distortion

```{autodoc2-docstring} equi7grid.core.Equi7TilingSystem.calc_length_distortion
:parser: source.docstrings_parser
```

````

````{py:method} get_children_from_name(tilename: str) -> equi7grid.core.Equi7TileGenerator
:canonical: equi7grid.core.Equi7TilingSystem.get_children_from_name

```{autodoc2-docstring} equi7grid.core.Equi7TilingSystem.get_children_from_name
:parser: source.docstrings_parser
```

````

````{py:method} get_parent_from_name(tilename: str) -> equi7grid.core.Equi7Tile
:canonical: equi7grid.core.Equi7TilingSystem.get_parent_from_name

```{autodoc2-docstring} equi7grid.core.Equi7TilingSystem.get_parent_from_name
:parser: source.docstrings_parser
```

````

`````

`````{py:class} Equi7Grid
:canonical: equi7grid.core.Equi7Grid

Bases: {py:obj}`pytileproj.RegularGrid`\[{py:obj}`equi7grid._types.T_co`\]

```{autodoc2-docstring} equi7grid.core.Equi7Grid
:parser: source.docstrings_parser
```

````{py:method} calc_length_distortion_on_ellipsoid(lon: float, lat: float) -> float
:canonical: equi7grid.core.Equi7Grid.calc_length_distortion_on_ellipsoid

```{autodoc2-docstring} equi7grid.core.Equi7Grid.calc_length_distortion_on_ellipsoid
:parser: source.docstrings_parser
```

````

````{py:method} get_tiles_in_geog_bbox(bbox: tuple[float, float, float, float], tiling_id: int | str, *, cover_land: bool = False) -> equi7grid.core.Equi7TileGenerator
:canonical: equi7grid.core.Equi7Grid.get_tiles_in_geog_bbox

```{autodoc2-docstring} equi7grid.core.Equi7Grid.get_tiles_in_geog_bbox
:parser: source.docstrings_parser
```

````

````{py:method} get_tiles_in_geom(proj_geom: pytileproj.ProjGeom, tiling_id: int | str, *, cover_land: bool = False) -> equi7grid.core.Equi7TileGenerator
:canonical: equi7grid.core.Equi7Grid.get_tiles_in_geom

```{autodoc2-docstring} equi7grid.core.Equi7Grid.get_tiles_in_geom
:parser: source.docstrings_parser
```

````

````{py:method} get_tile_from_name(ftilename: str) -> equi7grid.core.Equi7Tile
:canonical: equi7grid.core.Equi7Grid.get_tile_from_name

```{autodoc2-docstring} equi7grid.core.Equi7Grid.get_tile_from_name
:parser: source.docstrings_parser
```

````

`````

````{py:function} get_user_equi7grid(sampling: pytileproj._types.SamplingFloatOrMap, tiling_defs: collections.abc.Mapping[int, pytileproj.RegularTilingDefinition], *, buffered: bool = False, continent_order: list[str] | None = None) -> equi7grid.core.Equi7Grid
:canonical: equi7grid.core.get_user_equi7grid

```{autodoc2-docstring} equi7grid.core.get_user_equi7grid
:parser: source.docstrings_parser
```
````

````{py:function} get_standard_equi7grid(sampling: pytileproj._types.SamplingFloatOrMap, *, buffered: bool = False, continent_order: list[str] | None = None) -> equi7grid.core.Equi7Grid
:canonical: equi7grid.core.get_standard_equi7grid

```{autodoc2-docstring} equi7grid.core.get_standard_equi7grid
:parser: source.docstrings_parser
```
````

````{py:function} get_equi7grid_from_grid_def(json_path: pathlib.Path, sampling: pytileproj._types.SamplingFloatOrMap, *, continent_order: list[str] | None = None) -> equi7grid.core.Equi7Grid
:canonical: equi7grid.core.get_equi7grid_from_grid_def

```{autodoc2-docstring} equi7grid.core.get_equi7grid_from_grid_def
:parser: source.docstrings_parser
```
````

````{py:function} get_equi7grid_from_file(json_path: pathlib.Path) -> equi7grid.core.Equi7Grid
:canonical: equi7grid.core.get_equi7grid_from_file

```{autodoc2-docstring} equi7grid.core.get_equi7grid_from_file
:parser: source.docstrings_parser
```
````

````{py:function} allowed_samplings(tile_size: float) -> list[float]
:canonical: equi7grid.core.allowed_samplings

```{autodoc2-docstring} equi7grid.core.allowed_samplings
:parser: source.docstrings_parser
```
````