GDCM 3.0.24
Public Member Functions | Protected Member Functions | List of all members
gdcm::IconImageFilter Class Reference

IconImageFilter. More...

#include <gdcmIconImageFilter.h>

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 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

◆ IconImageFilter()

gdcm::IconImageFilter::IconImageFilter ( )

◆ ~IconImageFilter()

gdcm::IconImageFilter::~IconImageFilter ( )

Member Function Documentation

◆ Extract()

bool gdcm::IconImageFilter::Extract ( )

Extract all Icon found in File.

Examples
ExtractIconFromFile.cxx.

◆ ExtractIconImages()

void gdcm::IconImageFilter::ExtractIconImages ( )
protected

◆ ExtractVeproIconImages()

void gdcm::IconImageFilter::ExtractVeproIconImages ( )
protected

◆ GetFile() [1/2]

File & gdcm::IconImageFilter::GetFile ( )
inline

◆ GetFile() [2/2]

const File & gdcm::IconImageFilter::GetFile ( ) const
inline

◆ GetIconImage()

IconImage & gdcm::IconImageFilter::GetIconImage ( unsigned int  i) const

◆ GetNumberOfIconImages()

unsigned int gdcm::IconImageFilter::GetNumberOfIconImages ( ) const

Retrieve extract IconImage (need to call Extract first)

Examples
ExtractIconFromFile.cxx.

◆ SetFile()

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: