:py:mod:`mnp.evaluation.subselection_output` ============================================ .. py:module:: mnp.evaluation.subselection_output .. autodoc2-docstring:: mnp.evaluation.subselection_output :allowtitles: Module Contents --------------- Classes ~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`SubselectionOutput ` - .. autodoc2-docstring:: mnp.evaluation.subselection_output.SubselectionOutput :summary: * - :py:obj:`Table ` - .. autodoc2-docstring:: mnp.evaluation.subselection_output.Table :summary: * - :py:obj:`DetailedTable ` - .. autodoc2-docstring:: mnp.evaluation.subselection_output.DetailedTable :summary: * - :py:obj:`SummaryTable ` - .. autodoc2-docstring:: mnp.evaluation.subselection_output.SummaryTable :summary: * - :py:obj:`SubselectionMap ` - * - :py:obj:`KeyPopulationsCountMap ` - .. autodoc2-docstring:: mnp.evaluation.subselection_output.KeyPopulationsCountMap :summary: * - :py:obj:`AssignedSpeciesMap ` - .. autodoc2-docstring:: mnp.evaluation.subselection_output.AssignedSpeciesMap :summary: * - :py:obj:`HotSpotsMap ` - .. autodoc2-docstring:: mnp.evaluation.subselection_output.HotSpotsMap :summary: * - :py:obj:`LandTypeMap ` - .. autodoc2-docstring:: mnp.evaluation.subselection_output.LandTypeMap :summary: * - :py:obj:`QGisLayers ` - Functions ~~~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`identify_land_types_per_species ` - .. autodoc2-docstring:: mnp.evaluation.subselection_output.identify_land_types_per_species :summary: * - :py:obj:`add_output_to_subselection ` - .. autodoc2-docstring:: mnp.evaluation.subselection_output.add_output_to_subselection :summary: API ~~~ .. py:class:: SubselectionOutput(output_path: str) :canonical: mnp.evaluation.subselection_output.SubselectionOutput Bases: :py:obj:`abc.ABC` .. autodoc2-docstring:: mnp.evaluation.subselection_output.SubselectionOutput .. rubric:: Initialization .. autodoc2-docstring:: mnp.evaluation.subselection_output.SubselectionOutput.__init__ .. py:method:: create() :canonical: mnp.evaluation.subselection_output.SubselectionOutput.create :abstractmethod: .. autodoc2-docstring:: mnp.evaluation.subselection_output.SubselectionOutput.create .. py:method:: to_file() :canonical: mnp.evaluation.subselection_output.SubselectionOutput.to_file :abstractmethod: .. autodoc2-docstring:: mnp.evaluation.subselection_output.SubselectionOutput.to_file .. py:class:: Table(output_path) :canonical: mnp.evaluation.subselection_output.Table Bases: :py:obj:`mnp.evaluation.subselection_output.SubselectionOutput` .. autodoc2-docstring:: mnp.evaluation.subselection_output.Table .. rubric:: Initialization .. autodoc2-docstring:: mnp.evaluation.subselection_output.Table.__init__ .. py:method:: create() :canonical: mnp.evaluation.subselection_output.Table.create :abstractmethod: .. autodoc2-docstring:: mnp.evaluation.subselection_output.Table.create .. py:method:: to_file() :canonical: mnp.evaluation.subselection_output.Table.to_file .. autodoc2-docstring:: mnp.evaluation.subselection_output.Table.to_file .. py:class:: DetailedTable(subselection_evaluation: mnp.evaluation.subselection_evaluation.SubselectionEvaluation, species_models: weakref.ReferenceType, output_path: str) :canonical: mnp.evaluation.subselection_output.DetailedTable Bases: :py:obj:`mnp.evaluation.subselection_output.Table` .. autodoc2-docstring:: mnp.evaluation.subselection_output.DetailedTable .. rubric:: Initialization .. autodoc2-docstring:: mnp.evaluation.subselection_output.DetailedTable.__init__ .. py:method:: add_to_table_data(master_dict: dict, species_obj: mnp.species_models.species_model.SpeciesModel) :canonical: mnp.evaluation.subselection_output.DetailedTable.add_to_table_data .. autodoc2-docstring:: mnp.evaluation.subselection_output.DetailedTable.add_to_table_data .. py:method:: create() :canonical: mnp.evaluation.subselection_output.DetailedTable.create .. autodoc2-docstring:: mnp.evaluation.subselection_output.DetailedTable.create .. py:class:: SummaryTable(detailed_table: mnp.evaluation.subselection_output.DetailedTable, output_path: str) :canonical: mnp.evaluation.subselection_output.SummaryTable Bases: :py:obj:`mnp.evaluation.subselection_output.Table` .. autodoc2-docstring:: mnp.evaluation.subselection_output.SummaryTable .. rubric:: Initialization .. autodoc2-docstring:: mnp.evaluation.subselection_output.SummaryTable.__init__ .. py:attribute:: name :canonical: mnp.evaluation.subselection_output.SummaryTable.name :value: 'summary_table.csv' .. autodoc2-docstring:: mnp.evaluation.subselection_output.SummaryTable.name .. py:method:: create() :canonical: mnp.evaluation.subselection_output.SummaryTable.create .. autodoc2-docstring:: mnp.evaluation.subselection_output.SummaryTable.create .. py:class:: SubselectionMap(geospatial_profile: rasterio.profiles.DefaultGTiffProfile, output_path: str = '') :canonical: mnp.evaluation.subselection_output.SubselectionMap Bases: :py:obj:`mnp.evaluation.subselection_output.SubselectionOutput` .. py:method:: create() :canonical: mnp.evaluation.subselection_output.SubselectionMap.create :abstractmethod: .. autodoc2-docstring:: mnp.evaluation.subselection_output.SubselectionMap.create .. py:method:: to_file() :canonical: mnp.evaluation.subselection_output.SubselectionMap.to_file .. autodoc2-docstring:: mnp.evaluation.subselection_output.SubselectionMap.to_file .. py:class:: KeyPopulationsCountMap(geospatial_profile: rasterio.profiles.DefaultGTiffProfile, subselection_evaluation: mnp.evaluation.subselection_evaluation.SubselectionEvaluation, species_models: weakref.ReferenceType, output_path: str = '') :canonical: mnp.evaluation.subselection_output.KeyPopulationsCountMap Bases: :py:obj:`mnp.evaluation.subselection_output.SubselectionMap` .. autodoc2-docstring:: mnp.evaluation.subselection_output.KeyPopulationsCountMap .. rubric:: Initialization .. autodoc2-docstring:: mnp.evaluation.subselection_output.KeyPopulationsCountMap.__init__ .. py:attribute:: content :canonical: mnp.evaluation.subselection_output.KeyPopulationsCountMap.content :value: 'key population count' .. autodoc2-docstring:: mnp.evaluation.subselection_output.KeyPopulationsCountMap.content .. py:method:: create() :canonical: mnp.evaluation.subselection_output.KeyPopulationsCountMap.create .. autodoc2-docstring:: mnp.evaluation.subselection_output.KeyPopulationsCountMap.create .. py:class:: AssignedSpeciesMap(subselection_evaluation: mnp.evaluation.subselection_evaluation.SubselectionEvaluation, parameters: mnp.config.MNPParameters, land_types: dict, output_path: str = '') :canonical: mnp.evaluation.subselection_output.AssignedSpeciesMap Bases: :py:obj:`mnp.evaluation.subselection_output.SubselectionMap` .. autodoc2-docstring:: mnp.evaluation.subselection_output.AssignedSpeciesMap .. rubric:: Initialization .. autodoc2-docstring:: mnp.evaluation.subselection_output.AssignedSpeciesMap.__init__ .. py:attribute:: content :canonical: mnp.evaluation.subselection_output.AssignedSpeciesMap.content :value: 'assigned species based on land type' .. autodoc2-docstring:: mnp.evaluation.subselection_output.AssignedSpeciesMap.content .. py:method:: write_explanatory_table() :canonical: mnp.evaluation.subselection_output.AssignedSpeciesMap.write_explanatory_table .. autodoc2-docstring:: mnp.evaluation.subselection_output.AssignedSpeciesMap.write_explanatory_table .. py:method:: create() :canonical: mnp.evaluation.subselection_output.AssignedSpeciesMap.create .. autodoc2-docstring:: mnp.evaluation.subselection_output.AssignedSpeciesMap.create .. py:method:: to_file() :canonical: mnp.evaluation.subselection_output.AssignedSpeciesMap.to_file .. autodoc2-docstring:: mnp.evaluation.subselection_output.AssignedSpeciesMap.to_file .. py:class:: HotSpotsMap(geospatial_profile: rasterio.profiles.DefaultGTiffProfile, assigned_species_map: mnp.evaluation.subselection_output.AssignedSpeciesMap, key_population_count_map: mnp.evaluation.subselection_output.KeyPopulationsCountMap, output_path: str = '') :canonical: mnp.evaluation.subselection_output.HotSpotsMap Bases: :py:obj:`mnp.evaluation.subselection_output.SubselectionMap` .. autodoc2-docstring:: mnp.evaluation.subselection_output.HotSpotsMap .. rubric:: Initialization .. autodoc2-docstring:: mnp.evaluation.subselection_output.HotSpotsMap.__init__ .. py:attribute:: content :canonical: mnp.evaluation.subselection_output.HotSpotsMap.content :value: 'fraction of assigned species with a population reaching at least a key population in size' .. autodoc2-docstring:: mnp.evaluation.subselection_output.HotSpotsMap.content .. py:method:: create() :canonical: mnp.evaluation.subselection_output.HotSpotsMap.create .. autodoc2-docstring:: mnp.evaluation.subselection_output.HotSpotsMap.create .. py:method:: save_qml() :canonical: mnp.evaluation.subselection_output.HotSpotsMap.save_qml .. autodoc2-docstring:: mnp.evaluation.subselection_output.HotSpotsMap.save_qml .. py:method:: to_file() :canonical: mnp.evaluation.subselection_output.HotSpotsMap.to_file .. autodoc2-docstring:: mnp.evaluation.subselection_output.HotSpotsMap.to_file .. py:class:: LandTypeMap(subselection_evaluation: mnp.evaluation.subselection_evaluation.SubselectionEvaluation, land_types: dict, parameters: mnp.config.MNPParameters, output_path: str = '') :canonical: mnp.evaluation.subselection_output.LandTypeMap Bases: :py:obj:`mnp.evaluation.subselection_output.SubselectionOutput` .. autodoc2-docstring:: mnp.evaluation.subselection_output.LandTypeMap .. rubric:: Initialization .. autodoc2-docstring:: mnp.evaluation.subselection_output.LandTypeMap.__init__ .. py:method:: create() :canonical: mnp.evaluation.subselection_output.LandTypeMap.create .. autodoc2-docstring:: mnp.evaluation.subselection_output.LandTypeMap.create .. py:method:: save_qlr() :canonical: mnp.evaluation.subselection_output.LandTypeMap.save_qlr .. autodoc2-docstring:: mnp.evaluation.subselection_output.LandTypeMap.save_qlr .. py:method:: to_file() :canonical: mnp.evaluation.subselection_output.LandTypeMap.to_file .. autodoc2-docstring:: mnp.evaluation.subselection_output.LandTypeMap.to_file .. py:class:: QGisLayers(subselection_evaluation: mnp.evaluation.subselection_evaluation.SubselectionEvaluation, layer_type: str, species_models: weakref.ReferenceType, output_path: str) :canonical: mnp.evaluation.subselection_output.QGisLayers Bases: :py:obj:`mnp.evaluation.subselection_output.SubselectionOutput` .. py:method:: create() :canonical: mnp.evaluation.subselection_output.QGisLayers.create .. autodoc2-docstring:: mnp.evaluation.subselection_output.QGisLayers.create .. py:method:: to_file() :canonical: mnp.evaluation.subselection_output.QGisLayers.to_file .. autodoc2-docstring:: mnp.evaluation.subselection_output.QGisLayers.to_file .. py:function:: identify_land_types_per_species(suitability_indexes: pandas.DataFrame, species_codes: set[str], land_types: dict) :canonical: mnp.evaluation.subselection_output.identify_land_types_per_species .. autodoc2-docstring:: mnp.evaluation.subselection_output.identify_land_types_per_species .. py:function:: add_output_to_subselection(evaluation: mnp.evaluation.subselection_evaluation.SubselectionEvaluation, output_pathway: mnp.preparation.io_pathways.OutputPathway, parameters: mnp.config.MNPParameters, species_models: list[mnp.species_models.species_model.SpeciesModel], land_types: dict[str:sparray]) :canonical: mnp.evaluation.subselection_output.add_output_to_subselection .. autodoc2-docstring:: mnp.evaluation.subselection_output.add_output_to_subselection