Spatial Analysis API
====================

Spatial modules prepare metric fields, calculate spatial statistics, work with
GeoJSON regions and corridors, and create maps and spatial diagnostic plots.

.. contents:: On this page
   :local:
   :depth: 2

Package Entry Point
-------------------

.. automodule:: spatial_vtk.spatial
   :members:

Calculate
---------

.. automodule:: spatial_vtk.spatial.calculate.prepare_stats
   :members:

.. automodule:: spatial_vtk.spatial.calculate.correlation
   :members:

.. automodule:: spatial_vtk.spatial.calculate.clustering
   :members:

.. automodule:: spatial_vtk.spatial.calculate.pca
   :members:

.. automodule:: spatial_vtk.spatial.calculate.geology
   :members:

.. automodule:: spatial_vtk.spatial.calculate.geojson
   :members:

.. automodule:: spatial_vtk.spatial.calculate.corridors
   :members:

.. automodule:: spatial_vtk.spatial.calculate.geometry
   :members:

.. automodule:: spatial_vtk.spatial.calculate.paths
   :members:

.. automodule:: spatial_vtk.spatial.calculate.patterns
   :members:

.. automodule:: spatial_vtk.spatial.calculate.polygon_edges
   :members:

.. automodule:: spatial_vtk.spatial.calculate.rotation
   :members:

.. automodule:: spatial_vtk.spatial.calculate.settings
   :members:

.. automodule:: spatial_vtk.spatial.calculate.workflow
   :members:

Plots
-----

.. automodule:: spatial_vtk.spatial.plot.correlation
   :members:

.. automodule:: spatial_vtk.spatial.plot.metrics
   :members:

.. automodule:: spatial_vtk.spatial.plot.pca
   :members:

Maps
----

.. automodule:: spatial_vtk.spatial.map.basemaps
   :members:

.. automodule:: spatial_vtk.spatial.map.correlation
   :members:

.. automodule:: spatial_vtk.spatial.map.geojson
   :members:

.. automodule:: spatial_vtk.spatial.map.metrics
   :members:

.. automodule:: spatial_vtk.spatial.map.pca
   :members:

Path Maps
---------

.. automodule:: spatial_vtk.spatial.map.path.corridors
   :members:

.. automodule:: spatial_vtk.spatial.map.path.residuals
   :members: