Skip to main content

Extract OCT and fundus data from proprietary file formats.

Project description

OCT Converter

Python-based tools for reading OCT and fundus data.

Description

In ophthalmology, data acquired from the scanner is often exported in the manufacturer's proprietary file format. OCT-Converter provides python-based tools for extracting images (optical coherence tomography and fundus), as well as associated metadata, from these files.

Supported file formats

  • .fds (Topcon)
  • .fda (Topcon)
  • .e2e (Heidelberg)
  • .img (Zeiss)
  • .oct (Bioptigen)
  • .OCT (Optovue)
  • .dcm (both the standard kind, see Dicom, and Zeiss' obfuscated version, see ZEISSDicom)

Installation

Requires python 3.7 or higher.

pip install oct-converter

Usage

A number of example usage scripts are included in examples/.

Here is an example of reading a .fds file:

from oct_converter.readers import FDS

# An example .fds file can be downloaded from the Biobank website:
# https://biobank.ndph.ox.ac.uk/showcase/refer.cgi?id=30
filepath = '/home/mark/Downloads/eg_oct_fds.fds'
fds = FDS(filepath)

oct_volume = fds.read_oct_volume()  # returns an OCT volume with additional metadata if available
oct_volume.peek(show_contours=True) # plots a montage of the volume, with layer segmentations is available
oct_volume.save('fds_testing.avi')  # save volume as a movie
oct_volume.save('fds_testing.png')  # save volume as a set of sequential images, fds_testing_[1...N].png
oct_volume.save_projection('projection.png') # save 2D projection

fundus_image = fds.read_fundus_image()  # returns a  Fundus image with additional metadata if available
fundus_image.save('fds_testing_fundus.jpg')

Contributions

Are welcome! Here is a development roadmap, including some easy first issues. Please open a new issue to discuss any potential contributions.

Updates

31 January 2023

  • Greatly extended support for extracting metadata from .fda files

18 November 2022

  • Initial support for reading the Zeiss Dicom format.

7 August 2022

  • Contours (layer segmentations) are now extracted from .e2e files.
  • Acquisition date is now extracted from .e2e files.

16 June 2022

  • Initial support for reading Optovue OCTs
  • Laterality is now extracted separately for each OCT/fundus image for .e2e files.
  • More patient info extracted from .e2e files (name, sex, birthdate, patient ID)

24 Aug 2021

  • Reading the Bioptigen .OCT format is now supported

11 June 2021

  • Can now specify whether Zeiss .img data needs to be de-interlaced during reading.

14 May 2021

  • Can save 2D projections of OCT volumes.

30 October 2020

  • Extract fundus and laterality data from .e2e
  • Now attempts to extract additional volumetric data from .e2e files that was previously missed

22 August 2020

  • Experimental support for reading OCT data from .fda files.

14 July 2020

  • Can now read fundus data from .fda files.

Related projects

  • uocte inspired and enabled this project
  • LibE2E and LibOctData provided some additional descriptions of the .e2e file spec
  • eyepy can read HEYEY XML and VOL formats, and eyelab is a tool for annotating this data

Clinical use

We can't guarantee images extracted with OCT-Converter will match those extracted or viewed with the manufacturer's software. Any use in clinical settings is at the user's own risk.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oct_converter-0.5.6.tar.gz (22.3 kB view details)

Uploaded Source

Built Distribution

oct_converter-0.5.6-py3-none-any.whl (29.7 kB view details)

Uploaded Python 3

File details

Details for the file oct_converter-0.5.6.tar.gz.

File metadata

  • Download URL: oct_converter-0.5.6.tar.gz
  • Upload date:
  • Size: 22.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.10

File hashes

Hashes for oct_converter-0.5.6.tar.gz
Algorithm Hash digest
SHA256 7e9897c07367b2f325950e1b35be2ac50ac9421d79b18f104816066ead26cb3a
MD5 95c49ab29ea558a274aba5fa7add8bf9
BLAKE2b-256 d57c25c82d7af8a02d864fcecdbe3aed5e6e0d9771f4489a9628c8685f125b75

See more details on using hashes here.

Provenance

File details

Details for the file oct_converter-0.5.6-py3-none-any.whl.

File metadata

File hashes

Hashes for oct_converter-0.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5b9299470f23e29f095f28e491df7e640f3aa39022b90a6fc44cecac7310824f
MD5 891d6243c41612153ce29056c00e7994
BLAKE2b-256 a6ab1b0f787c7605dd24c3144e69890c8ae3ba62a6d8fbc163fd411d2aefdb9a

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page