Skip to main content

Extract OCT and fundus data from proprietary file formats.

Project description

OCT file converter

This repository contains code for extracting the raw optical coherence tomography (OCT) and fundus data from manufacturer's proprietary file formats.

Motivation

Research in ophthalmology is often hindered by manufacturer's usage of proprietary data formats for storing their data. For example, until recently, the ~200,000 OCT scans in the UK Biobank project was only available in Topcon's .fds file format, which prevented bulk processing and analysis. The only freely available software that allows these scans to be accessed is uocte, which is written in C++ and is no longer maintained. This repository aims to make available python-based tools for reading these proprietary formats.

Supported file formats

  • .fds (Topcon)
  • .fda (Topcon)
  • .e2e (Heidelberg)
  • .img (Zeiss)
  • .oct (Bioptigen)
  • .dcm

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() # plots a montage of the volume
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!

Updates

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.

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.2.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

oct_converter-0.2-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oct_converter-0.2.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for oct_converter-0.2.tar.gz
Algorithm Hash digest
SHA256 d722968cd3b9db2d73918a02917714abc6084cf4786df2709b9fe5cdafee40e7
MD5 bd95d505bbc97a525ae644f17e4b608c
BLAKE2b-256 c2323bca9ec6246fb03b9bd117a97c9d4bc7875535124d6db80181c8fafb461b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: oct_converter-0.2-py3-none-any.whl
  • Upload date:
  • Size: 15.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for oct_converter-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d34fc7e7e28cc25f6dac895b036564b4867b49d46270670f139619fe4cbe0287
MD5 0d6e11eefe6e24c0cab7fdc92708f44d
BLAKE2b-256 ea09ebe08d7635f089b81c4553d1355eb11e6ab4e2031b4e7e51e7fd5447441e

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