Difference between revisions of "Proposals:ImageIO API for GUI Support"

From KitwarePublic
Jump to navigationJump to search
Line 138: Line 138:
* http://www.itk.org/pipermail/insight-users/2008-September/027193.html
* http://www.itk.org/pipermail/insight-users/2008-September/027193.html


Niels Deker
Niels Dekker


* http://www.itk.org/pipermail/insight-users/2008-September/027194.html
* http://www.itk.org/pipermail/insight-users/2008-September/027194.html

Revision as of 13:21, 12 September 2008

ImageIO API for GUI Support

The Need

When building GUI applications based on ITK, it is common to use the ImageFileReader and ImageFileWriter classes, that through the ImageIO Factories are capable of supporting a large number of image file formats.

There are in fact, so many file formats supported, that it is challenging to list them all in the File Dialog of a GUI at the application level.

Current Support

Currently the ImageIO classes support the GUI interfaces by providing the following API

 ArrayOfExtensionsType GetSupportedWriteExtensions() const
 ArrayOfExtensionsType GetSupportedReadExtensions() const
 void AddSupportedWriteExtension( const char * extension  )
 void AddSupportedReadExtension( const char * extension )

Proposed API

Enumeration of Extensions

  • Suggested API for the ImageIO classes
    • unsigned int GetNumberOfExtensions() const;
    • std::string GetNthExtension(unsigned int) const
  • Should this be available for both Reading and Writing ?
    • Maybe as:
      • unsigned int GetNumberOfExtensionsForReading() const;
      • unsigned int GetNumberOfExtensionsForWriting() const;
      • std::string GetNthExtensionForReading(unsigned int) const
      • std::string GetNthExtensionForWriting(unsigned int) const

Challenges

  • How to deal with localization ?
  • Character encoding: Unicode ?

Translation Table for Writing

ImageIO Description Family Extension
AnalyzeImageIO Uncompressed header in binary Analyze .hdr
Uncompressed pixel data in binary Analyze .img
Compressed pixel data in binary Analyze .img.gz
BMPImageIO Uncompressed pixel data in binary with text header BMP .bmp
Uncompressed pixel data in binary with text header BMP .BMP
BioRadImageIO Binary header followed by pixel data in binary BioRad .pic
Brains2MaskImageIO Binary Mask Octree-encoded Brains2 .mask
DICOMImageIO2 Deprecated DICOM none
GDCMImageIO DICOM 2D, 3D and 4D DICOM .dcm
DICOM 2D, 3D and 4D DICOM none
GE4ImageIO Not Available for Writing GE4 none
GE5ImageIO Not Available for Writing GE5 none
GEAwImageIO Not Available for Writing GEAw none
GiplImageIO Uncompressed binary header followed by binary pixel data GIPL .gipl
Gzip Compressed binary header followed by binary pixel data GIPL .gipl.gz
IPLCommonImageIO Base class for GE4, GE5, GEAw, SiemensVision IPL none
JPEGImageIO Compressed pixel data in binary JPEG .jpg
Compressed pixel data in binary JPEG .jpeg
Compressed pixel data in binary JPEG .JPG
Compressed pixel data in binary JPEG .JPEG
LSMImageIO Optional Compression. Binary pixel data LSM .lsm
Optional Compression. Binary pixel data LSM .LSM
MetaImageIO ASCII Text Header MetaImage .mhd
NiftiImageIO Uncompressed pixel data in binary Nifti .img
NrrdImageIO Uncompressed pixel data in binary NRRD .nrrd
PNGImageIO Uncompressed pixel data in binary NRRD .png
RawImageIO Uncompressed pixel data in binary NRRD .raw
SiemensVisionImageIO Uncompressed pixel data in binary NRRD .??
StimulateImageIO Uncompressed pixel data in binary NRRD .??
TIFFImageIO Compressed pixel data in binary NRRD .tiff
VTKImageIO Text header followed by uncompressed pixel data in binary NRRD .vtk

Translation Table for Reading

Feedback

ITK Users/Developers Mailing Lists

Request for Feedback

Niels Dekker

Sean McBride