Skip to main content

ophthalmology_base_source

Data source for loading ophthalmology files using private-eye.

Classes​

OphthalmologyDataSourceArgs​

class OphthalmologyDataSourceArgs(    modality: OphthalmologyModalityType = None,    match_slo: bool = False,    drop_row_on_missing_slo: bool = False,    minimum_dob: Optional[Union[Date, DateTD]] = None,    maximum_dob: Optional[Union[Date, DateTD]] = None,    minimum_num_bscans: Optional[int] = None,    maximum_num_bscans: Optional[int] = None,):

Arguments for ophthalmology modality data.

More information about the acquisition device types can be found in the DICOM standard supplements 91 and 110.

Arguments

  • modality: The modality of the data. Must be either 'OCT', 'SLO' or None. OCT refers to Optical Coherence Tomography (OCT), typically these are a series of 2D images used to show a cross-section of the tissue layers in the retina (specifically the macula), combined to form a 3D image. SLO refers to Scanning Laser Ophthalmoscope (SLO), typically referred to as an 'en-face' image of the retina (specifically the macula). Defaults to None.
  • match_slo: Only relevant if modality is 'OCT'. Whether to match SLO files to OCT files on a best effort basis. If true, patient name, date of birth and laterality must be an exact match on the OCT and SLO files. Acquistion date and time must be within 24 hours of each other. Defaults to True.
  • drop_row_on_missing_slo: Only relevant if modality is 'OCT' and match_slo is True. Whether to drop the OCT row if the corresponding SLO file is missing i.e. ignore the OCT file. Defaults to False.
  • minimum_dob: The minimum date of birth to consider. If not None, only patients with a date of birth greater than or equal to this value will be considered. Defaults to None.
  • maximum_dob: The maximum date of birth to consider. If not None, only patients with a date of birth less than or equal to this value will be considered. Defaults to None.
  • minimum_num_bscans: The minimum number of B-scans to consider. If not None, only files with a number of B-scans greater than or equal to this value will be considered. Defaults to None.
  • maximum_num_bscans: The maximum number of B-scans to consider. If not None, only files with a number of B-scans less than or equal to this value will be considered. Defaults to None.

Variables​

  • static drop_row_on_missing_slo : bool
  • static match_slo : bool
  • static maximum_dob : Union[Date, DateTD, ForwardRef(None)]
  • static maximum_num_bscans : Optional[int]
  • static minimum_dob : Union[Date, DateTD, ForwardRef(None)]
  • static minimum_num_bscans : Optional[int]
  • static modality : Literal['OCT', 'SLO', None]