This document is for OpenStructure version 2.4, the latest version is 2.7 !

Supported Image File Formats

CCP4

Format used by the ccp4 software package.

  • Recognized file extensions: .ccp4, .map

  • Recognized based on content: yes

  • File import: yes

  • File export: yes

class ost.io.CCP4(normalize_on_save=false, endianess_on_save=OST_LOCAL_ENDIAN)
Parameters:
  • normalize_on_save (bool) – Determines whether to renormalize image upon saving.

  • endianess_on_save (ost.io.Endianess) – Byte order for saving.

DAT

Simple binary format for square images.

  • Recognized file extensions: .dat, .img

  • Recognized based on content: no

  • File import: yes

  • File export: yes

class ost.io.DAT(normalize_on_save=false, format=OST_DEFAULT_FORMAT, signed=false, endianess=OST_LOCAL_ENDIAN)
Parameters:
  • normalize_on_save (bool) – Determines whether to renormalize image upon saving.

  • format (ost.io.Format) – Data format for loading and saving.

  • signed (bool) – Determines whether data is interpreted as signed or unsigned values during loading and saving.

  • endianess (ost.io.Endianess) – Byte order for loading and saving.

DF3

PovRay Density file format.

  • Recognized file extensions: .df3

  • Recognized based on content: no

  • File import: no

  • File export: yes

class ost.io.DF3(normalize_on_save=false)
Parameters:

normalize_on_save (bool) – Determines whether to renormalize image upon saving.

DM3

Format used by Gatan Inc.’s Digital Micrograph software.

  • Recognized file extensions: .dm3

  • Recognized based on content: yes

  • File import: yes

  • File export: no

class ost.io.DM3

DX

Format used by the OpenDX software package.

  • Recognized file extensions: .dx

  • Recognized based on content: no

  • File import: yes

  • File export: yes

class ost.io.DX(normalize_on_save=false)
Parameters:

normalize_on_save (bool) – Determines whether to renormalize image upon saving.

IPL

Ditabis Micron Image Plate Scanner Format.

  • Recognized file extensions: .ipl

  • Recognized based on content: yes

  • File import: yes

  • File export: yes

class ost.io.IPL(normalize_on_save=false, format=OST_DEFAULT_FORMAT)
Parameters:
  • normalize_on_save (bool) – Determines whether to renormalize image upon saving.

  • format (ost.io.Format) – Data format for loading and saving.

JPK

Format used by JPK Instruments AG’s software (Customized Tiff format).

  • Recognized file extensions: .jpk

  • Recognized based on content: no (jpk files without file extension are recognized as tif)

  • File import: yes

  • File export: yes

class ost.io.JPK(normalize_on_save=indeterminate, format=OST_DEFAULT_FORMAT, signed=false, phasecolor=false, subimage=-1)
Parameters:
  • normalize_on_save (tribool) – Determines whether to renormalize image upon saving.

  • format (ost.io.Format) – Data format for loading and saving.

  • signed (bool) – Determines whether data is interpreted as signed or unsigned values during loading and saving.

  • phasecolor (bool) – Determines whether the phases of complex values are encoded as color information.

  • subimage (int) – Determines which subimage is read from a multi-image jpk (-1 = default image).

MRC

Format used by the MRC software package.

  • Recognized file extensions: .mrc

  • Recognized based on content: yes

  • File import: yes

  • File export: yes

class ost.io.MRC(normalize_on_save=false, subformat=MRC_NEW_FORMAT, endianess_on_save=OST_LOCAL_ENDIAN)
Parameters:
  • normalize_on_save (bool) – Determines whether to renormalize image upon saving.

  • subformat (ost.io.Subformat) – Determines whether old style or new style mrc files should be saved.

  • endianess_on_save (ost.io.Endianess) – Byte order for saving.

class ost.io.Subformat
MRC_AUTO_FORMAT
MRC_OLD_FORMAT
MRC_NEW_FORMAT

Nanoscope

Format used by software from Veeco.

  • Recognized file extensions: .mod

  • Recognized based on content: no

  • File import: yes

  • File export: yes

class ost.io.Nanoscope(subimage=-1)
Parameters:

subimage (int) – Determines which subimage is read from a multi-image nanoscope file (-1 = default image).

PNG

Portable Network Graphic image format.

  • Recognized file extensions: .png

  • Recognized based on content: yes

  • File import: yes

  • File export: yes

class ost.io.PNG(normalize_on_save=false)
Parameters:

normalize_on_save (bool) – Determines whether to renormalize image upon saving.

Situs

Format used by the Situs software package.

  • Recognized file extensions: .situs, .sit

  • Recognized based on content: no

  • File import: yes

  • File export: yes

class ost.io.Situs(normalize_on_save=false)
Parameters:

normalize_on_save (bool) – Determines whether to renormalize image upon saving.

Spider

Format used by the Spider software package.

  • Recognized file extensions: .spi

  • Recognized based on content: no

  • File import: yes

  • File export: yes

class ost.io.Spider(normalize_on_save=false, endianess_on_save=OST_LOCAL_ENDIAN)
Parameters:
  • normalize_on_save (bool) – Determines whether to renormalize image upon saving.

  • endianess_on_save (ost.io.Endianess) – Byte order for saving.

TIF

Tagged Image File Format.

  • Recognized file extensions: .tif, .tiff

  • Recognized based on content: yes

  • File import: yes

  • File export: yes

class ost.io.TIF(normalize_on_save=indeterminate, format=OST_DEFAULT_FORMAT, signed=false, phasecolor=false, subimage=-1)
Parameters:
  • normalize_on_save (tribool) – Determines whether to renormalize image upon saving.

  • format (ost.io.Format) – Data format for loading and saving.

  • signed (bool) – Determines whether data is interpreted as signed or unsigned values during loading and saving.

  • phasecolor (bool) – Determines whether the phases of complex values are encoded as color information.

  • subimage (int) – Determines which subimage is read from a multi-image tif (-1 = default image).

Common parameters

class ost.io.Endianess
OST_BIG_ENDIAN
OST_LITTLE_ENDIAN
OST_VAX_DATA
OST_LOCAL_ENDIAN
class ost.io.Format
OST_BIT8_FORMAT
OST_BIT16_FORMAT
OST_BIT32_FORMAT
OST_FLOAT_FORMAT
OST_DOUBLE_FORMAT
OST_DEFAULT_FORMAT

Search

Enter search terms or a module, class or function name.

Contents

Documentation is available for the following OpenStructure versions:

dev / 2.7 / 2.6 / 2.5 / (Currently viewing 2.4) / 2.3.1 / 2.3 / 2.2 / 2.1 / 2.0 / 1.9 / 1.8 / 1.7.1 / 1.7 / 1.6 / 1.5 / 1.4 / 1.3 / 1.2 / 1.11 / 1.10 / 1.1

This documentation is still under heavy development!
If something is missing or if you need the C++ API description in doxygen style, check our old documentation for further information.