Skip to main content

ga_trial_calculation_algorithm_jade

Algorithm for calculating the GA area.

Classes​

GATrialCalculationAlgorithm​

class GATrialCalculationAlgorithm(    ga_area_include_segmentations: Optional[list[str]] = None,    ga_area_exclude_segmentations: Optional[list[str]] = None,    **kwargs: Any,):

Algorithm for calculating the GA Area and associated metrics.

Ancestors​

Methods​

modeller​

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

Inherited from:

GATrialCalculationAlgorithmJade.modeller :

Modeller-side of the algorithm.

worker​

def worker(    self,    **kwargs: Any,) ‑> bitfount.federated.algorithms.ophthalmology.ga_trial_calculation_algorithm_jade._WorkerSide:

Inherited from:

GATrialCalculationAlgorithmJade.worker :

Worker-side of the algorithm.

GATrialCalculationAlgorithmJade​

class GATrialCalculationAlgorithmJade(    ga_area_include_segmentations: Optional[list[str]] = None,    ga_area_exclude_segmentations: Optional[list[str]] = None,    **kwargs: Any,):

Algorithm for calculating the GA Area and associated metrics.

Arguments

  • ga_area_include_segmentations: List of segmentation labels to be used for calculating the GA area. The logical AND of the masks for these labels will be used to calculate the GA area. If not provided, the default inclusion labels for the GA area will be used.
  • ga_area_exclude_segmentations: List of segmentation labels to be excluded from calculating the GA area. If any of these segmentations are present in the axial segmentation masks, that axis will be excluded from the GA area calculation. If not provided, the default exclusion labels for the GA area 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​

Subclasses​

Variables​

  • static fields_dict : ClassVar[T_FIELDS_DICT]

Methods​

modeller​

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

Modeller-side of the algorithm.

worker​

def worker(    self,    **kwargs: Any,) ‑> bitfount.federated.algorithms.ophthalmology.ga_trial_calculation_algorithm_jade._WorkerSide:

Worker-side of the algorithm.