DCMTK  Version 3.6.6
OFFIS DICOM Toolkit
Public Types | Public Member Functions | Static Private Attributes | List of all members
IODImagePixelModule< T > Class Template Reference

Class representing the Image Pixel Module: More...

Public Types

typedef T value_type
 Data type of pixels.
 

Public Member Functions

 IODImagePixelModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules)
 Constructor. More...
 
 IODImagePixelModule ()
 Constructor.
 
virtual ~IODImagePixelModule ()
 Destructor.
 
virtual OFCondition read (DcmItem &source, const OFBool clearOldData=OFTrue)
 Read attributes from given item into this class. More...
 
virtual OFCondition write (DcmItem &destination)
 Write attributes from this class into given item. More...
 
virtual void resetRules ()
 Resets rules to their original values.
 
virtual OFString getName () const
 Get name of module. More...
 
virtual DataType getDataType () const
 Get pixel data type, always returns DataType::INTEGER for this class. More...
 
virtual OFCondition getBitsStored (Uint16 &value, const unsigned long pos=0)
 Get Bits Stored. More...
 
virtual OFCondition getHighBit (Uint16 &value, const unsigned long pos=0)
 Get High Bit. More...
 
virtual OFCondition getPixelRepresentation (Uint16 &value, const unsigned long pos=0)
 Get Pixel Representation. More...
 
virtual OFCondition getPlanarConfiguration (Uint16 &value, const unsigned long pos=0)
 Get Planar Configuration. More...
 
virtual OFCondition getICCProfile (OFVector< Uint8 > &values)
 Get ICC Profile. More...
 
virtual OFCondition setSamplesPerPixel (const Uint16 value, const OFBool checkValue=OFTrue)
 Set Samples per Pixel. More...
 
virtual OFCondition setPhotometricInterpretation (const OFString &value, const OFBool checkValue=OFTrue)
 Set Photometric Interpretation. More...
 
virtual OFCondition setBitsAllocated (const Uint16 value, const OFBool checkValue=OFTrue)
 Set Bits Allocated. More...
 
virtual OFCondition setBitsStored (const Uint16 value, const OFBool checkValue=OFTrue)
 Set Bits Stored. More...
 
virtual OFCondition setHighBit (const Uint16 value, const OFBool checkValue=OFTrue)
 Set High Bit. More...
 
virtual OFCondition setPixelRepresentation (const Uint16 value, const OFBool checkValue=OFTrue)
 Set Pixel Representation. More...
 
virtual OFCondition setPlanarConfiguration (const Uint16 value, const OFBool checkValue=OFTrue)
 Set Planar Configuration. More...
 
virtual OFCondition setICCProfile (const Uint8 *values, const size_t length)
 Set ICC Profile. More...
 

Static Private Attributes

static const OFString m_ModuleName
 This module's name ("ImagePixelModule")
 

Detailed Description

template<typename T>
class IODImagePixelModule< T >

Class representing the Image Pixel Module:

Samples Per Pixel: (US, 1, 1) Photometric Interpretation (CS, 1, 1) Rows: (US, 1, 1) Columns: (US, 1, 1) Bits Allocated: (US, 1, 1) Bits Stored: (US, 1, 1) High Bit: (US, 1, 1) Pixel Representation: (US, 1, 1) Pixel Data is left out for now Planar Configuration: (US, 1, 1C) Pixel Aspect Ratio: (IS, 2, 1C) ICC Profile: (OB, 1, 3)

Constructor & Destructor Documentation

◆ IODImagePixelModule()

template<typename T >
IODImagePixelModule< T >::IODImagePixelModule ( OFshared_ptr< DcmItem item,
OFshared_ptr< IODRules rules 
)

Constructor.

Parameters
itemThe item to be used for data storage. If NULL, the class creates an empty data container.
rulesThe rule set for this class. If NULL, the class creates one from scratch and adds its values.

Member Function Documentation

◆ getBitsStored()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::getBitsStored ( Uint16 &  value,
const unsigned long  pos = 0 
)
virtual

Get Bits Stored.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1)
Returns
EC_Normal if successful, an error code otherwise

◆ getDataType()

template<typename T >
virtual DataType IODImagePixelModule< T >::getDataType ( ) const
virtual

Get pixel data type, always returns DataType::INTEGER for this class.

Returns
The data type of the pixel data

◆ getHighBit()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::getHighBit ( Uint16 &  value,
const unsigned long  pos = 0 
)
virtual

Get High Bit.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1)
Returns
EC_Normal if successful, an error code otherwise

◆ getICCProfile()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::getICCProfile ( OFVector< Uint8 > &  values)
virtual

Get ICC Profile.

Parameters
valuesReference to variable in which the values should be stored
Returns
EC_Normal if successful, an error code otherwise

◆ getName()

template<typename T >
virtual OFString IODImagePixelModule< T >::getName ( ) const
virtual

Get name of module.

Returns
Name of the module ("ImagePixelModule")

◆ getPixelRepresentation()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::getPixelRepresentation ( Uint16 &  value,
const unsigned long  pos = 0 
)
virtual

Get Pixel Representation.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1)
Returns
EC_Normal if successful, an error code otherwise

◆ getPlanarConfiguration()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::getPlanarConfiguration ( Uint16 &  value,
const unsigned long  pos = 0 
)
virtual

Get Planar Configuration.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1)
Returns
EC_Normal if successful, an error code otherwise

◆ read()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::read ( DcmItem source,
const OFBool  clearOldData = OFTrue 
)
virtual

Read attributes from given item into this class.

Parameters
sourceThe source to read from
clearOldDataIf OFTrue, old data is cleared before reading. Otherwise old data is overwritten (or amended)
Returns
EC_Normal if reading was successful, error otherwise

◆ setBitsAllocated()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::setBitsAllocated ( const Uint16  value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Bits Allocated.

Parameters
valueReference to variable in which the value should be stored
checkValueCheck 'value'. Not evaluated (here for consistency with other setter functions).
Returns
EC_Normal if successful, an error code otherwise

◆ setBitsStored()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::setBitsStored ( const Uint16  value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Bits Stored.

Parameters
valueReference to variable in which the value should be stored
checkValueCheck 'value'. Not evaluated (here for consistency with other setter functions).
Returns
EC_Normal if successful, an error code otherwise

◆ setHighBit()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::setHighBit ( const Uint16  value,
const OFBool  checkValue = OFTrue 
)
virtual

Set High Bit.

Parameters
valueReference to variable in which the value should be stored
checkValueCheck 'value'. Not evaluated (here for consistency with other setter functions).
Returns
EC_Normal if successful, an error code otherwise

◆ setICCProfile()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::setICCProfile ( const Uint8 *  values,
const size_t  length 
)
virtual

Set ICC Profile.

Parameters
valuesReference to variable in which the values should be stored
lengthLength of array provided in values parameter
Returns
EC_Normal if successful, an error code otherwise

◆ setPhotometricInterpretation()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::setPhotometricInterpretation ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Photometric Interpretation.

Parameters
valueReference to variable in which the value should be stored
checkValueCheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise

◆ setPixelRepresentation()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::setPixelRepresentation ( const Uint16  value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Pixel Representation.

Parameters
valueReference to variable in which the value should be stored
checkValueCheck 'value' for conformance with VR (US) and consistency if enabled
Returns
EC_Normal if successful, an error code otherwise

◆ setPlanarConfiguration()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::setPlanarConfiguration ( const Uint16  value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Planar Configuration.

Parameters
valueReference to variable in which the value should be stored
checkValueCheck 'value' for conformance with VR (US) and consistency with other attributes if enabled
Returns
EC_Normal if successful, an error code otherwise

◆ setSamplesPerPixel()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::setSamplesPerPixel ( const Uint16  value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Samples per Pixel.

Parameters
valueReference to variable in which the value should be stored
checkValueCheck 'value' for conformance with VR (US) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise

◆ write()

template<typename T >
virtual OFCondition IODImagePixelModule< T >::write ( DcmItem destination)
virtual

Write attributes from this class into given item.

Parameters
destinationThe item to write to
Returns
EC_Normal if writing was successful, error otherwise

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


Generated on Thu Jan 14 2021 for DCMTK Version 3.6.6 by Doxygen 1.8.18