Skip to content

eyepy.data

load(name)

Load sample data.

Parameters:

Name Type Description Default
name str

Name of the sample data to load. Available options are: - 'drusen_patient': Sample data with many drusen. - 'healthy_OS': Healthy left eye volume. - 'healthy_OD': Healthy right eye volume. - 'healthy_OS_Angio': Healthy left eye OCT Angiography. - 'healthy_OD_Angio': Healthy right eye OCT Angiography.

 required

Returns:

Type Description
EyeVolume

ep.EyeVolume: The loaded eye volume data.
Source code in src/eyepy/data/__init__.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def load(name: str) -> ep.EyeVolume:
    """Load sample data.

    Args:
        name: Name of the sample data to load.
            Available options are:
            - 'drusen_patient': Sample data with many drusen.
            - 'healthy_OS': Healthy left eye volume.
            - 'healthy_OD': Healthy right eye volume.
            - 'healthy_OS_Angio': Healthy left eye OCT Angiography.
            - 'healthy_OD_Angio': Healthy right eye OCT Angiography.

    Returns:
        ep.EyeVolume: The loaded eye volume data.
    """
    url, import_func = SAMPLE_DATA[name]
    file_ext = Path(url).suffix
    data_path = EYEPY_DATA_DIR / name

    if file_ext == '.zip':
        # ZIP file: extract if not already extracted
        if not data_path.is_dir():
            download_path = EYEPY_DATA_DIR / (name + '.zip')
            urllib.request.urlretrieve(url, download_path)
            with zipfile.ZipFile(download_path, 'r') as zip_ref:
                zip_ref.extractall(EYEPY_DATA_DIR)
            download_path.unlink()
        # Assume XML inside extracted folder for zip samples
        return import_func(data_path / 'metaclean.xml')
    else:
        # Direct file (e.g., .vol): download if not present
        if not data_path.exists():
            urllib.request.urlretrieve(url, data_path)
        return import_func(data_path)