mnp.species_models.clustering

Module Contents

Classes

ClusteringProcedure	Abstract class for cluster procedures
ClusterLocal
Clustering

API

class mnp.species_models.clustering.ClusteringProcedure(geospatial_profile, output_path: str = '')

Bases: mnp.species_models.species_geo_map.SpeciesGeoMap, abc.ABC

Abstract class for cluster procedures

Initialization

Initialize the clustering procedure.

geospatial_profileGeospatialProfile

profile of the geospatial data

output_pathstr, optional

path to save the results”

abstractmethod run(hsi_array: scipy.sparse.csr_array)

Run the clustering procedure.

hsi_arraysparse.csr_array

HSI array

class mnp.species_models.clustering.ClusterLocal(parameters: mnp.config.MNPParameters, species_code: str)

Bases: mnp.species_models.clustering.ClusteringProcedure

run(hsi_array: scipy.sparse.csr_array)

Run Local clustering procedure

hsi_array: csr_array

A sparse csr_array containing hsi map for this species

class mnp.species_models.clustering.Clustering(parameters: mnp.config.MNPParameters, species_code: str)

Initialization

Class, for holding and running clustering steps/procedures

parameters: MNPParameters

Database dictionary containing all mnp parameters

species_code: str

This species’ code