DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Private Attributes | List of all members
DPMParametricMapImageModule Class Reference

Class representing the Parametric Map Image Module: More...

+ Inheritance diagram for DPMParametricMapImageModule:

Public Member Functions

 DPMParametricMapImageModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules)
 Constructor. More...
 
 DPMParametricMapImageModule ()
 Constructor.
 
virtual ~DPMParametricMapImageModule ()
 Destructor.
 
virtual void resetRules ()
 Resets rules to their original values.
 
virtual OFString getName () const
 Get name of module ("DPMParametricMapImageModule") More...
 
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 OFCondition getImageType (OFString &value, const signed long pos=0) const
 Get Image Type. More...
 
virtual OFCondition getSamplesPerPixel (Uint16 &value, const signed long pos=0) const
 Get Samples Per Pixel. More...
 
virtual OFCondition getPhotometricInterpretation (OFString &value, const signed long pos=0) const
 Get Photometric Interpretation. More...
 
virtual OFCondition getBitsAllocated (Uint16 &value, const signed long pos=0) const
 Get Bits Allocated. More...
 
virtual OFCondition getBitsStored (Uint16 &value, const signed long pos=0) const
 Get Bits Stored. More...
 
virtual OFCondition getHighBit (Uint16 &value, const signed long pos=0) const
 Get High Bit. More...
 
virtual OFCondition getPresentationLUTShape (OFString &value, const signed long pos=0) const
 Get Presentation LUT Shape. More...
 
virtual OFCondition getLossyImageCompression (OFString &value, const signed long pos=0) const
 Get Lossy Image Compression. More...
 
virtual OFCondition getLossyImageCompressionRatio (OFString &value, const signed long pos=0) const
 Get Lossy Image Compression Ratio. More...
 
virtual OFCondition getLossyImageCompressionMethod (OFString &value, const signed long pos=0) const
 Get Lossy Image Compression Method. More...
 
virtual OFCondition getBurnedInAnnotation (OFString &value, const signed long pos=0) const
 Get Burned In Annotation. More...
 
virtual OFCondition getRecognizableVisualFeatures (OFString &value, const signed long pos=0) const
 Get Recognizable Visual Features. More...
 
virtual OFCondition getContentQualification (OFString &value, const signed long pos=0) const
 Get Content Qualification. More...
 
virtual OFCondition setImageType (const OFString &value, const OFBool checkValue=OFTrue)
 Set Image Type. 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 setPresentationLUTShape (const OFString &value, const OFBool checkValue=OFTrue)
 Set Presentation LUT Shape. More...
 
virtual OFCondition setLossyImageCompression (const OFString &value, const OFBool checkValue=OFTrue)
 Set Lossy Image Compression. More...
 
virtual OFCondition setLossyImageCompressionRatio (const OFString &value, const OFBool checkValue=OFTrue)
 Set Lossy Image Compression Ratio. More...
 
virtual OFCondition setLossyImageCompressionMethod (const OFString &value, const OFBool checkValue=OFTrue)
 Set Lossy Image Compression Method. More...
 
virtual OFCondition setBurnedInAnnotation (const OFString &value, const OFBool checkValue=OFTrue)
 Set Burned In Annotation. More...
 
virtual OFCondition setRecognizableVisualFeatures (const OFString &value, const OFBool checkValue=OFTrue)
 Set Recognizable Visual Features. More...
 
virtual OFCondition setContentQualification (const OFString &value, const OFBool checkValue=OFTrue)
 Set ContentQualification. More...
 
- Public Member Functions inherited from IODModule
 IODModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules)
 Constructor. More...
 
 IODModule ()
 Constructor. More...
 
 IODModule (const IODModule &rhs)
 Copy constructor, creates shallow copy. More...
 
IODModuleoperator= (const IODModule &rhs)
 Assignment operator, creates shallow copy. More...
 
 ~IODModule ()
 Desctructor.
 
- Public Member Functions inherited from IODComponent
 IODComponent (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent=NULL)
 Constructor. More...
 
 IODComponent (IODComponent *parent=NULL)
 Constructor, creates rules and item from scratch. More...
 
IODComponentoperator= (const IODComponent &rhs)
 Assignment operator, copies contained item and rule set from rhs to "this" attribute set. More...
 
 IODComponent (const IODComponent &rhs)
 Copy constructor, copies reference to contained item and rule set to "this" attribute set. More...
 
virtual ~IODComponent ()
 Virtual Destructor.
 
void clearData ()
 Clear all attributes from the data that are handled by this module. More...
 
virtual void inventMissing ()
 Set missing values by inventing "default values". More...
 
OFshared_ptr< IODRulesgetRules ()
 Get rules handled by this module. More...
 
virtual void makeOptional ()
 Make component optional by turning all attributes requirement types of it to type 3. More...
 
DcmItemgetData ()
 Get the data handled by this module. More...
 
virtual OFCondition check (const OFBool quiet=OFFalse)
 Check whether this component's data satisfies the underlying rules. More...
 
virtual int compare (const IODComponent &rhs) const
 Comparison operator for IOD Components. More...
 

Static Private Attributes

static const OFString m_ModuleName
 The name of this module ("DPMParametricMapImageModule")
 

Additional Inherited Members

- Static Public Member Functions inherited from IODComponent
static OFCondition read (DcmItem &source, IODRules &rules, DcmItem &destination, const OFString &componentName)
 Static helper function that reads attributes from given item into destination item, as determined by the provided rules and component name. More...
 
static OFCondition write (DcmItem &source, IODRules &rules, DcmItem &destination, const OFString &componentName)
 Static helper function that writes attributes from given item into destination item, as determined by the provided rules and component name. More...
 
- Protected Attributes inherited from IODComponent
OFshared_ptr< DcmItemm_Item
 Shared pointer to the data handled by this class. More...
 
OFshared_ptr< IODRulesm_Rules
 Rules describing the attributes governed by this class.
 
IODComponentm_Parent
 The parent component (may be NULL) of this class.
 

Detailed Description

Class representing the Parametric Map Image Module:

ImageType: (CS, 2-n, 1) SamplesPerPixel: (US, 1, 1) PhotometricInterpretation: (CS, 1, 1) BitsAllocated: (US, 1, 1) BitsStored: (US, 1, 1C) HighBit: (US, 1, 1C) PresentationLUTShape: (CS, 1, 1) LossyImageCompression: (CS, 1, 1) LossyImageCompressionRatio: (DS, 1-n, 1C) LossyImageCompressionMethod: (CS, 1-n, 1C) BurnedInAnnotation: (CS, 1, 1) RecognizableVisualFeatures: (CS, 1, 1) ContentQualification: (CS, 1, 1)

Constructor & Destructor Documentation

DPMParametricMapImageModule::DPMParametricMapImageModule ( 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

virtual OFCondition DPMParametricMapImageModule::getBitsAllocated ( Uint16 &  value,
const signed long  pos = 0 
) const
virtual

Get Bits Allocated.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::getBitsStored ( Uint16 &  value,
const signed long  pos = 0 
) const
virtual

Get Bits Stored.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::getBurnedInAnnotation ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Burned In Annotation.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::getContentQualification ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Content Qualification.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::getHighBit ( Uint16 &  value,
const signed long  pos = 0 
) const
virtual

Get High Bit.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::getImageType ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Image Type.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::getLossyImageCompression ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Lossy Image Compression.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::getLossyImageCompressionMethod ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Lossy Image Compression Method.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::getLossyImageCompressionRatio ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Lossy Image Compression Ratio.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFString DPMParametricMapImageModule::getName ( ) const
virtual

Get name of module ("DPMParametricMapImageModule")

Returns
Name of the module ("DPMParametricMapImageModule")

Implements IODComponent.

virtual OFCondition DPMParametricMapImageModule::getPhotometricInterpretation ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Photometric Interpretation.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::getPresentationLUTShape ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Presentation LUT Shape.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::getRecognizableVisualFeatures ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Recognizable Visual Features.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::getSamplesPerPixel ( Uint16 &  value,
const signed long  pos = 0 
) const
virtual

Get Samples Per Pixel.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::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

Reimplemented from IODComponent.

virtual OFCondition DPMParametricMapImageModule::setBitsAllocated ( const Uint16 &  value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Bits Allocated.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (US) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::setBitsStored ( const Uint16 &  value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Bits Stored.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (US) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::setBurnedInAnnotation ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Burned In Annotation.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::setContentQualification ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set ContentQualification.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::setHighBit ( const Uint16 &  value,
const OFBool  checkValue = OFTrue 
)
virtual

Set High Bit.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (US) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::setImageType ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Image Type.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (CS) and VM (2-n) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::setLossyImageCompression ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Lossy Image Compression.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::setLossyImageCompressionMethod ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Lossy Image Compression Method.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (CS) and VM (1-n) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::setLossyImageCompressionRatio ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Lossy Image Compression Ratio.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (DS) and VM (1-n) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::setPhotometricInterpretation ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Photometric Interpretation.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::setPresentationLUTShape ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Presentation LUT Shape.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::setRecognizableVisualFeatures ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Recognizable Visual Features.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::setSamplesPerPixel ( const Uint16 &  value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Samples Per Pixel.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (US) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition DPMParametricMapImageModule::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

Reimplemented from IODComponent.


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


Generated on Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8