Skip to content

Latest commit

 

History

History
25 lines (13 loc) · 1.22 KB

epic.analysis.analyse.analyse.md

File metadata and controls

25 lines (13 loc) · 1.22 KB
Raw

function analyse

analyse(dirs: list[Path], config: dict[str, Any]) → None

Generates analysis reports for images.

Generates analysis reports for images located in the given input directories. Reports will be placed in a subdirectory called 'Analysis' that will be created in each input directory and will be in the form of HTML documents generated from a Jupyter Notebook file specified in the EPIC YAML configuration file. The Jupyter Notebook contains the analysis procedure that will be executed for the images while utilising corresponding data generated by EPIC from those images. Other files such as videos, images and excel spreadsheet documents may also be generated in the analysis directory as a result of this.

Args:

  • dirs: A sequence of existing input directories containing images in common image formats (.png, .tiff, etc).
  • config: A loaded EPIC YAML configuration file.

This file was automatically generated via lazydocs.