dicom_info

Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

dicom_info(input_path: str, *, tags: Sequence[str] | None = None, recursive: bool = True, output: str | None = None, output_format: str = 'csv', group_by_series: bool = True, one_file_per_folder: bool = False, dicom_extensions: Set[str] | None = None, include_no_extension: bool = False, num_workers: int | None = None, max_depth: int | None = None) → DataFrame[source]

Extract selected DICOM tags from files or directories.

Parameters:

  • input_path – DICOM directory, single file, or YAML config path.

  • tags – Optional tag names to extract; None uses library defaults.

  • recursive – Walk subdirectories when input_path is a directory.

  • output – Optional path to persist results (format controlled by output_format).

  • output_format – csv, excel, or json when writing output.

  • group_by_series – Read one representative file per series.

  • one_file_per_folder – Sample one DICOM per folder for faster scans.

  • dicom_extensions – Valid extensions when one_file_per_folder is set.

  • include_no_extension – Probe extensionless files via DICOM magic bytes.

  • num_workers – Thread pool size; 1 disables parallelism.

  • max_depth – Maximum directory recursion depth.

Returns:

DataFrame of extracted tag values.

Raises:

HABITAPIError – When pydicom is unavailable or extraction fails.