Public Member Functions | Protected Member Functions

gdcm::IconImageFilter Class Reference

IconImageFilter This filter will extract icons from a gdcm::File This filter will loop over all known sequence (public and private) that may contains an IconImage and retrieve them. The filter will fails with a value of false if no icon can be found Since it handle both public and private icon type, one should not assume the icon is in uncompress form, some private vendor store private icon in JPEG8/JPEG12. More...

#include <gdcmIconImageFilter.h>

Collaboration diagram for gdcm::IconImageFilter:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 IconImageFilter ()
 ~IconImageFilter ()
bool Extract ()
 Extract all Icon found in File.
FileGetFile ()
const FileGetFile () const
IconImageGetIconImage (unsigned int i) const
unsigned int GetNumberOfIconImages () const
 Retrieve extract IconImage (need to call Extract first).
void SetFile (const File &f)
 Set/Get File.

Protected Member Functions

void ExtractIconImages ()
void ExtractVeproIconImages ()

Detailed Description

IconImageFilter This filter will extract icons from a gdcm::File This filter will loop over all known sequence (public and private) that may contains an IconImage and retrieve them. The filter will fails with a value of false if no icon can be found Since it handle both public and private icon type, one should not assume the icon is in uncompress form, some private vendor store private icon in JPEG8/JPEG12.

Implementation details: This filter supports the following Icons:

Warning:
the icon stored in those private attribute do not conform to definition of Icon Image Sequence (do not simply copy/paste). For example some private icon can be expressed as 12bits pixel, while the DICOM standard only allow 8bits icons.
See also:
ImageReader
Examples:

ExtractIconFromFile.cxx.


Constructor & Destructor Documentation

gdcm::IconImageFilter::IconImageFilter (  ) 
gdcm::IconImageFilter::~IconImageFilter (  ) 

Member Function Documentation

bool gdcm::IconImageFilter::Extract (  ) 

Extract all Icon found in File.

Examples:
ExtractIconFromFile.cxx.
void gdcm::IconImageFilter::ExtractIconImages (  )  [protected]
void gdcm::IconImageFilter::ExtractVeproIconImages (  )  [protected]
File& gdcm::IconImageFilter::GetFile (  )  [inline]
const File& gdcm::IconImageFilter::GetFile (  )  const [inline]
IconImage& gdcm::IconImageFilter::GetIconImage ( unsigned int  i  )  const
unsigned int gdcm::IconImageFilter::GetNumberOfIconImages (  )  const

Retrieve extract IconImage (need to call Extract first).

Examples:
ExtractIconFromFile.cxx.
void gdcm::IconImageFilter::SetFile ( const File f  )  [inline]

Set/Get File.

Examples:
ExtractIconFromFile.cxx.

The documentation for this class was generated from the following file:

Generated on Mon Jul 29 2013 11:24:27 for GDCM by doxygen 1.7.1
SourceForge.net Logo