ml::DcmDRTIconImageSequenceInterface Class Reference

Class to provide access to DRTIconImageSequence. More...

#include <mlDcmDRTIconImageSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTIconImageSequenceInterface (DRTIconImageSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTIconImageSequenceInterface ()
 Default virtual Destructor.
bool getBitsAllocated (unsigned long idx, MLuint16 &parameter)
bool getBitsAllocated (DRTIconImageSequence::Item &item, MLuint16 &parameter)
std::string getBitsAllocatedTag () const
bool setBitsAllocated (unsigned long idx, MLuint16 &parameter)
bool getBitsStored (unsigned long idx, MLuint16 &parameter)
bool getBitsStored (DRTIconImageSequence::Item &item, MLuint16 &parameter)
std::string getBitsStoredTag () const
bool setBitsStored (unsigned long idx, MLuint16 &parameter)
bool getBluePaletteColorLookupTableDescriptor (unsigned long idx, MLuint16 &parameter)
bool getBluePaletteColorLookupTableDescriptor (DRTIconImageSequence::Item &item, MLuint16 &parameter)
std::string getBluePaletteColorLookupTableDescriptorTag () const
bool setBluePaletteColorLookupTableDescriptor (unsigned long idx, MLuint16 &parameter)
bool getColumns (unsigned long idx, MLuint16 &parameter)
bool getColumns (DRTIconImageSequence::Item &item, MLuint16 &parameter)
std::string getColumnsTag () const
bool setColumns (unsigned long idx, MLuint16 &parameter)
bool getGreenPaletteColorLookupTableDescriptor (unsigned long idx, MLuint16 &parameter)
bool getGreenPaletteColorLookupTableDescriptor (DRTIconImageSequence::Item &item, MLuint16 &parameter)
std::string getGreenPaletteColorLookupTableDescriptorTag () const
bool setGreenPaletteColorLookupTableDescriptor (unsigned long idx, MLuint16 &parameter)
bool getHighBit (unsigned long idx, MLuint16 &parameter)
bool getHighBit (DRTIconImageSequence::Item &item, MLuint16 &parameter)
std::string getHighBitTag () const
bool setHighBit (unsigned long idx, MLuint16 &parameter)
bool getICCProfile (unsigned long idx, int &parameter)
bool getICCProfile (DRTIconImageSequence::Item &item, int &parameter)
std::string getICCProfileTag () const
bool setICCProfile (unsigned long idx, int &parameter)
bool getLargestImagePixelValue (unsigned long idx, MLuint16 &parameter)
bool getLargestImagePixelValue (DRTIconImageSequence::Item &item, MLuint16 &parameter)
std::string getLargestImagePixelValueTag () const
bool setLargestImagePixelValue (unsigned long idx, MLuint16 &parameter)
bool getPhotometricInterpretation (unsigned long idx, std::string &parameter)
bool getPhotometricInterpretation (DRTIconImageSequence::Item &item, std::string &parameter)
std::string getPhotometricInterpretationTag () const
bool setPhotometricInterpretation (unsigned long idx, std::string &parameter)
bool getPixelAspectRatio (unsigned long idx, std::string &parameter)
bool getPixelAspectRatio (DRTIconImageSequence::Item &item, std::string &parameter)
std::string getPixelAspectRatioTag () const
bool setPixelAspectRatio (unsigned long idx, std::string &parameter)
bool getPixelRepresentation (unsigned long idx, MLuint16 &parameter)
bool getPixelRepresentation (DRTIconImageSequence::Item &item, MLuint16 &parameter)
std::string getPixelRepresentationTag () const
bool setPixelRepresentation (unsigned long idx, MLuint16 &parameter)
bool getPlanarConfiguration (unsigned long idx, MLuint16 &parameter)
bool getPlanarConfiguration (DRTIconImageSequence::Item &item, MLuint16 &parameter)
std::string getPlanarConfigurationTag () const
bool setPlanarConfiguration (unsigned long idx, MLuint16 &parameter)
bool getRedPaletteColorLookupTableDescriptor (unsigned long idx, MLuint16 &parameter)
bool getRedPaletteColorLookupTableDescriptor (DRTIconImageSequence::Item &item, MLuint16 &parameter)
std::string getRedPaletteColorLookupTableDescriptorTag () const
bool setRedPaletteColorLookupTableDescriptor (unsigned long idx, MLuint16 &parameter)
bool getRows (unsigned long idx, MLuint16 &parameter)
bool getRows (DRTIconImageSequence::Item &item, MLuint16 &parameter)
std::string getRowsTag () const
bool setRows (unsigned long idx, MLuint16 &parameter)
bool getSamplesPerPixel (unsigned long idx, MLuint16 &parameter)
bool getSamplesPerPixel (DRTIconImageSequence::Item &item, MLuint16 &parameter)
std::string getSamplesPerPixelTag () const
bool setSamplesPerPixel (unsigned long idx, MLuint16 &parameter)
bool getSmallestImagePixelValue (unsigned long idx, MLuint16 &parameter)
bool getSmallestImagePixelValue (DRTIconImageSequence::Item &item, MLuint16 &parameter)
std::string getSmallestImagePixelValueTag () const
bool setSmallestImagePixelValue (unsigned long idx, MLuint16 &parameter)
void setSequence (DRTIconImageSequence *dcmSequence)
 Set the DRTIconImageSequence this interface class provides access to.
DRTIconImageSequence * getSequence () const
 Return the DRTIconImageSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTIconImageSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTIconImageSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTIconImageSequence::Item * addItem ()
 Return number of items the internal sequence consists of.
bool insertItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
bool removeItem (const unsigned long idx)
 Return number of items the internal sequence consists of.

Protected Attributes

DRTIconImageSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTIconImageSequence.

Definition at line 42 of file mlDcmDRTIconImageSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTIconImageSequenceInterface::DcmDRTIconImageSequenceInterface ( DRTIconImageSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTIconImageSequenceInterface.h.

virtual ml::DcmDRTIconImageSequenceInterface::~DcmDRTIconImageSequenceInterface (  )  [inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTIconImageSequenceInterface.h.

Member Function Documentation

DRTIconImageSequence::Item* ml::DcmDRTIconImageSequenceInterface::addItem (  )  [inline]

Return number of items the internal sequence consists of.

Returns:
Number of items of internal sequence, 0 if internal sequence is NULL.

Definition at line 185 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getBitsAllocated ( DRTIconImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getBitsAllocated ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getBitsAllocatedTag (  )  const [inline]

Definition at line 53 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getBitsStored ( DRTIconImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getBitsStored ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getBitsStoredTag (  )  const [inline]

Definition at line 59 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getBluePaletteColorLookupTableDescriptor ( DRTIconImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getBluePaletteColorLookupTableDescriptor ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getBluePaletteColorLookupTableDescriptorTag (  )  const [inline]

Definition at line 65 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getColumns ( DRTIconImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getColumns ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getColumnsTag (  )  const [inline]

Definition at line 71 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getGreenPaletteColorLookupTableDescriptor ( DRTIconImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getGreenPaletteColorLookupTableDescriptor ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getGreenPaletteColorLookupTableDescriptorTag (  )  const [inline]

Definition at line 77 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getHighBit ( DRTIconImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getHighBit ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getHighBitTag (  )  const [inline]

Definition at line 83 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getICCProfile ( DRTIconImageSequence::Item &  item,
int &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getICCProfile ( unsigned long  idx,
int &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getICCProfileTag (  )  const [inline]

Definition at line 89 of file mlDcmDRTIconImageSequenceInterface.h.

DRTIconImageSequence::Item* ml::DcmDRTIconImageSequenceInterface::getItem ( const unsigned long  idx  )  [inline]

Return number of items the internal sequence consists of.

Returns:
Number of items of internal sequence, 0 if internal sequence is NULL.

Definition at line 176 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getLargestImagePixelValue ( DRTIconImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getLargestImagePixelValue ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getLargestImagePixelValueTag (  )  const [inline]

Definition at line 95 of file mlDcmDRTIconImageSequenceInterface.h.

MLint ml::DcmDRTIconImageSequenceInterface::getNumberOfItems (  )  const [inline]

Return number of items the internal sequence consists of.

Returns:
Number of items of internal sequence, 0 if internal sequence is NULL.

Definition at line 167 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getPhotometricInterpretation ( DRTIconImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getPhotometricInterpretation ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getPhotometricInterpretationTag (  )  const [inline]

Definition at line 101 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getPixelAspectRatio ( DRTIconImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getPixelAspectRatio ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getPixelAspectRatioTag (  )  const [inline]

Definition at line 107 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getPixelRepresentation ( DRTIconImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getPixelRepresentation ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getPixelRepresentationTag (  )  const [inline]

Definition at line 113 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getPlanarConfiguration ( DRTIconImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getPlanarConfiguration ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getPlanarConfigurationTag (  )  const [inline]

Definition at line 119 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getRedPaletteColorLookupTableDescriptor ( DRTIconImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getRedPaletteColorLookupTableDescriptor ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getRedPaletteColorLookupTableDescriptorTag (  )  const [inline]

Definition at line 125 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getRows ( DRTIconImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getRows ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getRowsTag (  )  const [inline]

Definition at line 131 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getSamplesPerPixel ( DRTIconImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getSamplesPerPixel ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getSamplesPerPixelTag (  )  const [inline]

Definition at line 137 of file mlDcmDRTIconImageSequenceInterface.h.

DRTIconImageSequence* ml::DcmDRTIconImageSequenceInterface::getSequence (  )  const [inline]

Return the DRTIconImageSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTIconImageSequence

Definition at line 155 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::getSmallestImagePixelValue ( DRTIconImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::getSmallestImagePixelValue ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTIconImageSequenceInterface::getSmallestImagePixelValueTag (  )  const [inline]

Definition at line 143 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::hasSequence (  )  const [inline]

Check if the DRTIconImageSequence is set.

Returns:
True if internal pointer is set, False else.

Definition at line 161 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::insertItem ( const unsigned long  idx  )  [inline]

Return number of items the internal sequence consists of.

Returns:
Number of items of internal sequence, 0 if internal sequence is NULL.

Definition at line 196 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::removeItem ( const unsigned long  idx  )  [inline]

Return number of items the internal sequence consists of.

Returns:
Number of items of internal sequence, 0 if internal sequence is NULL.

Definition at line 207 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::setBitsAllocated ( unsigned long  idx,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setBitsStored ( unsigned long  idx,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setBluePaletteColorLookupTableDescriptor ( unsigned long  idx,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setColumns ( unsigned long  idx,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setGreenPaletteColorLookupTableDescriptor ( unsigned long  idx,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setHighBit ( unsigned long  idx,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setICCProfile ( unsigned long  idx,
int &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setLargestImagePixelValue ( unsigned long  idx,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setPhotometricInterpretation ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setPixelAspectRatio ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setPixelRepresentation ( unsigned long  idx,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setPlanarConfiguration ( unsigned long  idx,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setRedPaletteColorLookupTableDescriptor ( unsigned long  idx,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setRows ( unsigned long  idx,
MLuint16 &  parameter 
)

bool ml::DcmDRTIconImageSequenceInterface::setSamplesPerPixel ( unsigned long  idx,
MLuint16 &  parameter 
)

void ml::DcmDRTIconImageSequenceInterface::setSequence ( DRTIconImageSequence *  dcmSequence  )  [inline]

Set the DRTIconImageSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTIconImageSequence

Definition at line 149 of file mlDcmDRTIconImageSequenceInterface.h.

bool ml::DcmDRTIconImageSequenceInterface::setSmallestImagePixelValue ( unsigned long  idx,
MLuint16 &  parameter 
)

Member Data Documentation

DRTIconImageSequence* ml::DcmDRTIconImageSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 217 of file mlDcmDRTIconImageSequenceInterface.h.

The documentation for this class was generated from the following file:
Generated on Sat Sep 3 18:39:45 2011 for MeVisLab Toolbox Reference by  doxygen 1.5.8