paidiverpy.investigation_layer

paidiverpy.investigation_layer#

__init__.py for position_layer module.

Submodules#

Classes#

InvestigationLayer

Investigation layer class.

Package Contents#

class paidiverpy.investigation_layer.InvestigationLayer(plots: list[Any] | str, config_params: dict[str, Any] | paidiverpy.config.config_params.ConfigParams | None = None, config_file_path: str | None = None, config: paidiverpy.config.configuration.Configuration | None = None, metadata: paidiverpy.metadata_parser.MetadataParser | None = None, images: paidiverpy.images_layer.ImagesLayer | None = None, paidiverpy: paidiverpy.Paidiverpy | None = None, step_order: int | None = None, step_name: str | None = None, logger: logging.Logger | None = None, raise_error: bool = False, verbose: int = 2, plot_metadata: pandas.DataFrame | None = None)[source]#

Bases: paidiverpy.Paidiverpy

Investigation layer class.

This class processes the images in the position layer.

Parameters:

  • plots (list | str) – The plots to generate.

  • config_params (dict | ConfigParams, optional) – The configuration parameters. It can contain the following keys / attributes: - input_path (str): The path to the input files. - output_path (str): The path to the output files. - metadata_path (str): The path to the metadata file. - metadata_type (str): The type of the metadata file. - track_changes (bool): Whether to track changes. - n_jobs (int): The number of n_jobs.

  • config_file_path (str) – The path to the configuration file.

  • config (Configuration) – The configuration object.

  • metadata (MetadataParser) – The metadata object.

  • images (ImagesLayer) – The images object.

  • paidiverpy (Paidiverpy) – The paidiverpy object.

  • step_name (str) – The name of the step.

  • parameters (dict) – The parameters for the step.

  • config_index (int) – The index of the configuration.

  • logger (logging.Logger) – The logger object.

  • raise_error (bool) – Whether to raise an error.

  • verbose (int) – verbose level (0 = none, 1 = errors/warnings, 2 = info).

  • plot_metadata (pd.DataFrame) – The metadata for the plots.

run() → None[source]#

Run the investigation layer.

plot_trimmed_photos(new_metadata: pandas.DataFrame) → None[source]#

Plot the trimmed photos.

Parameters:

new_metadata (pd.DataFrame) – The new metadata.

plot_polygons() → None[source]#

Plot the polygons.

plot_brightness_hist(metadata: pandas.DataFrame) → None[source]#

Plot the images.

Parameters:

metadata (pd.DataFrame) – The metadata with the images.