Skip to main content

fluid_volume_calculation_algorithm

Algorithm for calculating the Fluid Volume.

Classes​

FluidVolumeCalculationAlgorithm​

class FluidVolumeCalculationAlgorithm(    datastructure: DataStructure,    fluid_volume_include_segmentations: Optional[list[str]] = None,    **kwargs: Any,):

Algorithm for calculating the Fluid Volume and associated metrics.

Arguments

  • datastructure: The data structure to use for the algorithm.
  • fluid_volume_include_segmentations: List of segmentation labels to be used for calculating the Fluid Volume. The logical AND of the masks for these labels will be used to calculate the Fluid Volume. If not provided, the default inclusion labels for the Fluid Volume will be used.

Raises

  • ValueError: If an invalid segmentation label is provided.
  • ValueError: If a segmentation label is provided in both the include and exclude lists.

Ancestors​

Variables​

  • static fields_dict : ClassVar[T_FIELDS_DICT]

Methods​

modeller​

def modeller(    self, *, context: Optional[ProtocolContext] = None, **kwargs: Any,) ‑> NoResultsModellerAlgorithm:

Inherited from:

BaseNonModelAlgorithmFactory.modeller :

Modeller-side of the algorithm.

worker​

def worker(    self,    *,    context: Optional[ProtocolContext] = None,    **kwargs: Any,) ‑> bitfount.federated.algorithms.ophthalmology.fluid_volume_calculation_algorithm._WorkerSide:

Inherited from:

BaseNonModelAlgorithmFactory.worker :

Worker-side of the algorithm.