Ctrl+K

Zonal

Zonal#

Zonal Statistics on Rasters#

Calculate zonal methods.

class gdptools.zonal_gen.ZonalGen(user_data: UserData, zonal_engine: Literal['serial', 'parallel', 'dask'], zonal_writer: Literal['csv'], out_path: str, file_prefix: str, append_date: bool = False, jobs: int = 1)#

Class for aggregating zonal statistics.

Parameters

  • user_data (UserData) –

  • zonal_engine (Literal['serial', 'parallel', 'dask']) –

  • zonal_writer (Literal['csv']) –

  • out_path (str) –

  • file_prefix (str) –

  • append_date (bool) –

  • jobs (int) –

__init__(user_data: UserData, zonal_engine: Literal['serial', 'parallel', 'dask'], zonal_writer: Literal['csv'], out_path: str, file_prefix: str, append_date: bool = False, jobs: int = 1) → None#

__init__ Initialize ZonalGen class.

_extended_summary_

Parameters

  • user_data (UserData) – _description_

  • zonal_engine (ZONAL_ENGINES) – _description_

  • zonal_writer (ZONAL_WRITERS) – _description_

  • out_path (str) – _description_

  • file_prefix (str) – _description_

  • append_date (bool) – _description_. Defaults to False.

  • jobs (int) – _description_. Defaults to 1.

Raises

  • FileNotFoundError – _description_

  • TypeError – _description_

Return type

None

calculate_zonal(categorical: bool = False) → DataFrame#

calculate_zonal Calculates zonal statistics.

_extended_summary_

Parameters

categorical (bool) – _description_. Defaults to False.

Returns

_description_

Return type

pd.DataFrame

Contents