MeVisLab Toolbox Reference
ml::DcmDRTIconImageSequenceInterface Class Reference

Class to provide access to DRTIconImageSequence. More...

#include <mlDcmDRTIconImageSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTIconImageSequenceInterface ()
 DcmDRTIconImageSequenceInterface (std::vector< DcmDRTIconImageSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTIconImageSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTIconImageSequenceInterface ()
 Default virtual Destructor.
bool getBitsAllocated (unsigned long idx, MLuint16 &parameter) const
bool getBitsAllocated (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string getBitsAllocatedTag () const
bool setBitsAllocated (unsigned long idx, MLuint16 parameter)
bool getBitsStored (unsigned long idx, MLuint16 &parameter) const
bool getBitsStored (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string getBitsStoredTag () const
bool setBitsStored (unsigned long idx, MLuint16 parameter)
bool getBluePaletteColorLookupTableDescriptor (unsigned long idx, MLuint16 &parameter) const
bool getBluePaletteColorLookupTableDescriptor (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string getBluePaletteColorLookupTableDescriptorTag () const
bool setBluePaletteColorLookupTableDescriptor (unsigned long idx, MLuint16 parameter)
bool getColumns (unsigned long idx, MLuint16 &parameter) const
bool getColumns (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string getColumnsTag () const
bool setColumns (unsigned long idx, MLuint16 parameter)
bool getGreenPaletteColorLookupTableDescriptor (unsigned long idx, MLuint16 &parameter) const
bool getGreenPaletteColorLookupTableDescriptor (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string getGreenPaletteColorLookupTableDescriptorTag () const
bool setGreenPaletteColorLookupTableDescriptor (unsigned long idx, MLuint16 parameter)
bool getHighBit (unsigned long idx, MLuint16 &parameter) const
bool getHighBit (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string getHighBitTag () const
bool setHighBit (unsigned long idx, MLuint16 parameter)
bool getICCProfile (unsigned long idx, int &parameter) const
bool getICCProfile (DCMTree::TreePtr item, int &parameter) const
std::string getICCProfileTag () const
bool setICCProfile (unsigned long idx, int parameter)
bool getLargestImagePixelValue (unsigned long idx, MLuint16 &parameter) const
bool getLargestImagePixelValue (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string getLargestImagePixelValueTag () const
bool setLargestImagePixelValue (unsigned long idx, MLuint16 parameter)
bool getPhotometricInterpretation (unsigned long idx, std::string &parameter) const
bool getPhotometricInterpretation (DCMTree::TreePtr item, std::string &parameter) const
std::string getPhotometricInterpretationTag () const
bool setPhotometricInterpretation (unsigned long idx, std::string parameter)
bool getPixelAspectRatio (unsigned long idx, std::string &parameter) const
bool getPixelAspectRatio (DCMTree::TreePtr item, std::string &parameter) const
std::string getPixelAspectRatioTag () const
bool setPixelAspectRatio (unsigned long idx, std::string parameter)
bool getPixelRepresentation (unsigned long idx, MLuint16 &parameter) const
bool getPixelRepresentation (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string getPixelRepresentationTag () const
bool setPixelRepresentation (unsigned long idx, MLuint16 parameter)
bool getPlanarConfiguration (unsigned long idx, MLuint16 &parameter) const
bool getPlanarConfiguration (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string getPlanarConfigurationTag () const
bool setPlanarConfiguration (unsigned long idx, MLuint16 parameter)
bool getRedPaletteColorLookupTableDescriptor (unsigned long idx, MLuint16 &parameter) const
bool getRedPaletteColorLookupTableDescriptor (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string getRedPaletteColorLookupTableDescriptorTag () const
bool setRedPaletteColorLookupTableDescriptor (unsigned long idx, MLuint16 parameter)
bool getRows (unsigned long idx, MLuint16 &parameter) const
bool getRows (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string getRowsTag () const
bool setRows (unsigned long idx, MLuint16 parameter)
bool getSamplesPerPixel (unsigned long idx, MLuint16 &parameter) const
bool getSamplesPerPixel (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string getSamplesPerPixelTag () const
bool setSamplesPerPixel (unsigned long idx, MLuint16 parameter)
bool getSmallestImagePixelValue (unsigned long idx, MLuint16 &parameter) const
bool getSmallestImagePixelValue (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string getSmallestImagePixelValueTag () const
bool setSmallestImagePixelValue (unsigned long idx, MLuint16 parameter)
void setSequence (std::vector< DcmDRTIconImageSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTIconImageSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTIconImageSequenceInterface::Item getItem (const size_t idx) const
DcmDRTIconImageSequenceInterface::Item & addItem ()
void addItem (DcmDRTIconImageSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

std::vector< DcmDRTIconImageSequenceInterface::Item > _itemVec
 Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTIconImageSequence.

Definition at line 43 of file mlDcmDRTIconImageSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTIconImageSequenceInterface() [1/3]

ml::DcmDRTIconImageSequenceInterface::DcmDRTIconImageSequenceInterface ( )
inline

Definition at line 153 of file mlDcmDRTIconImageSequenceInterface.h.

◆ DcmDRTIconImageSequenceInterface() [2/3]

ml::DcmDRTIconImageSequenceInterface::DcmDRTIconImageSequenceInterface ( std::vector< DcmDRTIconImageSequenceInterface::Item > dcmSequence)
inline

Default Constructor.

Definition at line 156 of file mlDcmDRTIconImageSequenceInterface.h.

References _itemVec.

◆ DcmDRTIconImageSequenceInterface() [3/3]

ml::DcmDRTIconImageSequenceInterface::DcmDRTIconImageSequenceInterface ( DCMTree::TreePtrVector treePtrSeq)
inline

Definition at line 158 of file mlDcmDRTIconImageSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTIconImageSequenceInterface()

virtual ml::DcmDRTIconImageSequenceInterface::~DcmDRTIconImageSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 166 of file mlDcmDRTIconImageSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTIconImageSequenceInterface::Item & ml::DcmDRTIconImageSequenceInterface::addItem ( )
inline

Adds a new item to the sequence

Returns
Return the new item which has been added to the sequence

Definition at line 299 of file mlDcmDRTIconImageSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

void ml::DcmDRTIconImageSequenceInterface::addItem ( DcmDRTIconImageSequenceInterface::Item newItem)
inline

Definition at line 304 of file mlDcmDRTIconImageSequenceInterface.h.

References _itemVec.

◆ getBitsAllocated() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getBitsAllocated ( DCMTree::TreePtr item,
MLuint16 & parameter ) const

◆ getBitsAllocated() [2/2]

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

◆ getBitsAllocatedTag()

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

Definition at line 170 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getBitsStored() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getBitsStored ( DCMTree::TreePtr item,
MLuint16 & parameter ) const

◆ getBitsStored() [2/2]

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

◆ getBitsStoredTag()

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

Definition at line 176 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getBluePaletteColorLookupTableDescriptor() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getBluePaletteColorLookupTableDescriptor ( DCMTree::TreePtr item,
MLuint16 & parameter ) const

◆ getBluePaletteColorLookupTableDescriptor() [2/2]

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

◆ getBluePaletteColorLookupTableDescriptorTag()

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

Definition at line 182 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getColumns() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getColumns ( DCMTree::TreePtr item,
MLuint16 & parameter ) const

◆ getColumns() [2/2]

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

◆ getColumnsTag()

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

Definition at line 188 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getGreenPaletteColorLookupTableDescriptor() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getGreenPaletteColorLookupTableDescriptor ( DCMTree::TreePtr item,
MLuint16 & parameter ) const

◆ getGreenPaletteColorLookupTableDescriptor() [2/2]

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

◆ getGreenPaletteColorLookupTableDescriptorTag()

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

Definition at line 194 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getHighBit() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getHighBit ( DCMTree::TreePtr item,
MLuint16 & parameter ) const

◆ getHighBit() [2/2]

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

◆ getHighBitTag()

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

Definition at line 200 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getICCProfile() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getICCProfile ( DCMTree::TreePtr item,
int & parameter ) const

◆ getICCProfile() [2/2]

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

◆ getICCProfileTag()

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

Definition at line 206 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getItem()

DcmDRTIconImageSequenceInterface::Item ml::DcmDRTIconImageSequenceInterface::getItem ( const size_t idx) const
inline

Gets the item at the indicated position.

Returns
The requested item, an empty item when the position is invalid

Definition at line 290 of file mlDcmDRTIconImageSequenceInterface.h.

References _itemVec.

◆ getLargestImagePixelValue() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getLargestImagePixelValue ( DCMTree::TreePtr item,
MLuint16 & parameter ) const

◆ getLargestImagePixelValue() [2/2]

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

◆ getLargestImagePixelValueTag()

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

Definition at line 212 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getNumberOfItems()

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 284 of file mlDcmDRTIconImageSequenceInterface.h.

References _itemVec.

◆ getPhotometricInterpretation() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getPhotometricInterpretation ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getPhotometricInterpretation() [2/2]

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

◆ getPhotometricInterpretationTag()

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

Definition at line 218 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getPixelAspectRatio() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getPixelAspectRatio ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getPixelAspectRatio() [2/2]

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

◆ getPixelAspectRatioTag()

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

Definition at line 224 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getPixelRepresentation() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getPixelRepresentation ( DCMTree::TreePtr item,
MLuint16 & parameter ) const

◆ getPixelRepresentation() [2/2]

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

◆ getPixelRepresentationTag()

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

Definition at line 230 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getPlanarConfiguration() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getPlanarConfiguration ( DCMTree::TreePtr item,
MLuint16 & parameter ) const

◆ getPlanarConfiguration() [2/2]

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

◆ getPlanarConfigurationTag()

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

Definition at line 236 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getRedPaletteColorLookupTableDescriptor() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getRedPaletteColorLookupTableDescriptor ( DCMTree::TreePtr item,
MLuint16 & parameter ) const

◆ getRedPaletteColorLookupTableDescriptor() [2/2]

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

◆ getRedPaletteColorLookupTableDescriptorTag()

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

Definition at line 242 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getRows() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getRows ( DCMTree::TreePtr item,
MLuint16 & parameter ) const

◆ getRows() [2/2]

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

◆ getRowsTag()

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

Definition at line 248 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getSamplesPerPixel() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getSamplesPerPixel ( DCMTree::TreePtr item,
MLuint16 & parameter ) const

◆ getSamplesPerPixel() [2/2]

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

◆ getSamplesPerPixelTag()

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

Definition at line 254 of file mlDcmDRTIconImageSequenceInterface.h.

◆ getSequence()

std::vector< DcmDRTIconImageSequenceInterface::Item > ml::DcmDRTIconImageSequenceInterface::getSequence ( ) const
inline

Return the DRTIconImageSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTIconImageSequence

Definition at line 272 of file mlDcmDRTIconImageSequenceInterface.h.

References _itemVec.

Referenced by DRTIconImageSequenceWrapper::DRTIconImageSequenceWrapper(), and DRTIconImageSequenceWrapper::operator=().

◆ getSmallestImagePixelValue() [1/2]

bool ml::DcmDRTIconImageSequenceInterface::getSmallestImagePixelValue ( DCMTree::TreePtr item,
MLuint16 & parameter ) const

◆ getSmallestImagePixelValue() [2/2]

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

◆ getSmallestImagePixelValueTag()

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

Definition at line 260 of file mlDcmDRTIconImageSequenceInterface.h.

◆ hasSequence()

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

Check if the DRTIconImageSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 278 of file mlDcmDRTIconImageSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTIconImageSequenceInterface::insertItem ( const size_t idx)
inline

Insert an item at the indicated position

Returns
true is the insertion was successful, false if position is invalid

Definition at line 310 of file mlDcmDRTIconImageSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTIconImageSequenceInterface::removeItem ( const size_t idx)
inline

Removes the indicated item from the sequence

Returns
true if the item was deleted successfully, false if the indicated position is invalid

Definition at line 322 of file mlDcmDRTIconImageSequenceInterface.h.

References _itemVec.

◆ setBitsAllocated()

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

◆ setBitsStored()

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

◆ setBluePaletteColorLookupTableDescriptor()

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

◆ setColumns()

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

◆ setGreenPaletteColorLookupTableDescriptor()

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

◆ setHighBit()

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

◆ setICCProfile()

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

◆ setLargestImagePixelValue()

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

◆ setPhotometricInterpretation()

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

◆ setPixelAspectRatio()

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

◆ setPixelRepresentation()

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

◆ setPlanarConfiguration()

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

◆ setRedPaletteColorLookupTableDescriptor()

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

◆ setRows()

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

◆ setSamplesPerPixel()

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

◆ setSequence()

void ml::DcmDRTIconImageSequenceInterface::setSequence ( std::vector< DcmDRTIconImageSequenceInterface::Item > dcmSequence)
inline

Set the DRTIconImageSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTIconImageSequence

Definition at line 266 of file mlDcmDRTIconImageSequenceInterface.h.

References _itemVec.

◆ setSmallestImagePixelValue()

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

Member Data Documentation

◆ _itemVec

std::vector<DcmDRTIconImageSequenceInterface::Item> ml::DcmDRTIconImageSequenceInterface::_itemVec
protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 334 of file mlDcmDRTIconImageSequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTIconImageSequenceInterface(), DcmDRTIconImageSequenceInterface(), getItem(), getNumberOfItems(), getSequence(), hasSequence(), insertItem(), removeItem(), and setSequence().

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