Skip to main content

image_selection_algorithm

For selection of images related to patients for upload.

Classes​

ImageSelectionAlgorithm​

class ImageSelectionAlgorithm(    datastructure: DataStructure, **kwargs: Any,):

Algorithm for selecting images related to a patient.

Initialize the algorithm.

Arguments

  • datastructure: The data structure definition
  • patient_ids: The patients for whom to identify a list of images.
  • **kwargs: Additional keyword arguments.

Ancestors​

Variables​

Methods​

modeller​

def modeller(    self, *, context: ProtocolContext, **kwargs: Any,) ‑> NoResultsModellerAlgorithm:

Inherited from:

BaseNonModelAlgorithmFactory.modeller :

Modeller-side of the algorithm.

worker​

def worker(    self, *, context: ProtocolContext, **kwargs: Any,) ‑> bitfount.federated.algorithms.ehr.image_selection_algorithm._WorkerSide:

Inherited from:

BaseNonModelAlgorithmFactory.worker :

Worker-side of the algorithm.

SelectedImageInfo​

class SelectedImageInfo(    *,    path: pathlib.Path,    series_index: int | None = None,    laterality: str | None = None,    acquisition_datetime: str | None = None,    series_description: str | None = None,    modality: str | None = None,    number_of_frames: int | None = None,    manufacturer: str | None = None,    manufacturer_model: str | None = None,):

A file selected for upload, with scan metadata from its datasource row.

Every field but path is optional: the compatible image sources do not all report the same metadata, and any individual file may be missing a value that its source usually provides.

Variables​

  • static acquisition_datetime : str | None
  • static laterality : str | None
  • static manufacturer : str | None
  • static manufacturer_model : str | None
  • static modality : str | None
  • static number_of_frames : int | None
  • static series_description : str | None
  • static series_index : int | None