:py:mod:`mnp.preparation.aggregate_land_type_map`
=================================================

.. py:module:: mnp.preparation.aggregate_land_type_map

.. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`LandTypeMap <mnp.preparation.aggregate_land_type_map.LandTypeMap>`
     - .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.LandTypeMap
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`aggregate_row <mnp.preparation.aggregate_land_type_map.aggregate_row>`
     - .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.aggregate_row
          :summary:
   * - :py:obj:`aggregate_land_type_map <mnp.preparation.aggregate_land_type_map.aggregate_land_type_map>`
     - .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.aggregate_land_type_map
          :summary:
   * - :py:obj:`read_aggregated_map <mnp.preparation.aggregate_land_type_map.read_aggregated_map>`
     - .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.read_aggregated_map
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`LAND_TYPE_WILDCARD <mnp.preparation.aggregate_land_type_map.LAND_TYPE_WILDCARD>`
     - .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.LAND_TYPE_WILDCARD
          :summary:

API
~~~

.. py:data:: LAND_TYPE_WILDCARD
   :canonical: mnp.preparation.aggregate_land_type_map.LAND_TYPE_WILDCARD
   :value: '*.npz'

   .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.LAND_TYPE_WILDCARD

.. py:function:: aggregate_row(row_array: numpy.array, row_offset: int, land_types: dict, unrecognized_land_type_ids: set, aggregation_factor: int, nodata_array: numpy.array) -> (dict[int, scipy.sparse.dok_array], set)
   :canonical: mnp.preparation.aggregate_land_type_map.aggregate_row

   .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.aggregate_row

.. py:class:: LandTypeMap(land_type_map_path: str, land_type_map_table_path: str, environmentals_folder: str)
   :canonical: mnp.preparation.aggregate_land_type_map.LandTypeMap

   .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.LandTypeMap

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.LandTypeMap.__init__

   .. py:method:: make_geospatial_profile(environmentals_folder: str)
      :canonical: mnp.preparation.aggregate_land_type_map.LandTypeMap.make_geospatial_profile

      .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.LandTypeMap.make_geospatial_profile

   .. py:method:: save_geospatial_profile(output_folder)
      :canonical: mnp.preparation.aggregate_land_type_map.LandTypeMap.save_geospatial_profile

      .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.LandTypeMap.save_geospatial_profile

   .. py:method:: aggregate_multiprocess()
      :canonical: mnp.preparation.aggregate_land_type_map.LandTypeMap.aggregate_multiprocess

      .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.LandTypeMap.aggregate_multiprocess

   .. py:method:: aggregate()
      :canonical: mnp.preparation.aggregate_land_type_map.LandTypeMap.aggregate

      .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.LandTypeMap.aggregate

   .. py:method:: save(output_folder: str)
      :canonical: mnp.preparation.aggregate_land_type_map.LandTypeMap.save

      .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.LandTypeMap.save

.. py:function:: aggregate_land_type_map(folders: dict)
   :canonical: mnp.preparation.aggregate_land_type_map.aggregate_land_type_map

   .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.aggregate_land_type_map

.. py:function:: read_aggregated_map(folders: dict) -> dict[str, scipy.sparse.csr_array]
   :canonical: mnp.preparation.aggregate_land_type_map.read_aggregated_map

   .. autodoc2-docstring:: mnp.preparation.aggregate_land_type_map.read_aggregated_map