Skip to main content

A library to read Andor SIF file

Project description

# SIF Reader

This package is designed to read Andor SIF image file.

In addition to raw image data, it provides access to the wavelength axis for spectra, and metadata such as exposure time, gain, recording date etc. Image data can be read as a numpy array or as an [xarray](https://xarray.pydata.org/en/stable/) DataArray, which contains the image data as well as the coordinate axes and labels in a single object. For spectra, the spectral axis can be returned as nanometers, wavenumbers or electron volts.

To the best of our knowledge, this is currently the only Python package that can extract wavelength information from .sif files using only pure Python and numpy (i.e. without relying on any Andor dll libraries).

## Requirements numpy (optionally xarray, pytest to run the unit tests)

## Installation Install with pip: ` >pip install sifreader `

## Usage

Open a file and print the metadata:

` >file = SIFFile('my_image.sif') >print(file) <sifreader.sifreader.sifreader.SIFFile object at 0x30f9eecc0> Original Filename: E:\test_sequence.sif Date: Thu May 10 12:01:48 2018 ... `

Read a single or all frames contained in the file as numpy arrays: ` >first_frame = file.read_block(0) >all_frames = file.read_all() `

The horizontal axis is contained in the x_axis member variable. If the file contains a spectrum, the axis will be the wavelength in namometers, otherwise it will contain the pixel numbers: ` >wavelengths = file.x_axis `

### With the optional xarray package

Read all frames in the file as a DataArray: ` >xarr = file.as_xarray() `

For spectra: make a DataArray that contains the photon energy in eV rather than the default wavelength: ` >spectrum_file = SIFFile('my_spectrum.sif') >xarr = spectrum_file.as_xarray('photon_energy') `

One of the nice features of DataArray is the ability to easily select data and plot it: `python spectrum_file.as_xarray().sel(frames=0, wavelength=slice(749.5, 768.2)).plot() `

## Version History

  • 0.2: Added support for wavelength information, xarray exporting and unit tests

  • 0.1: First release

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

sifreader-0.2.4.tar.gz (5.6 kB view details)

Uploaded Source

File details

Details for the file sifreader-0.2.4.tar.gz.

File metadata

  • Download URL: sifreader-0.2.4.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for sifreader-0.2.4.tar.gz
Algorithm Hash digest
SHA256 45a9235e95996a68169c1da1e273c2fbae3ed97865f96ac051650c5a3e63c488
MD5 99902d04a72aa0fb96207835f95f8329
BLAKE2b-256 9d09701d6f40d2b4afa9453cef303e7e015798e6c9dffb8739b24104c923389a

See more details on using hashes here.

Supported by

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