DCMTK
Version 3.6.1 20160216
OFFIS DICOM Toolkit
|
Class representing the General Image Module: More...
Public Member Functions | |
IODImagePixelModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules) | |
Constructor. More... | |
IODImagePixelModule () | |
Constructor. | |
virtual | ~IODImagePixelModule () |
Destructor. | |
virtual void | resetRules () |
Resets rules to their original values. | |
virtual OFString | getName () const |
Get name of module. More... | |
virtual OFCondition | getSamplesPerPixel (Uint16 &value, const signed long pos=0) |
Get Samples per Pixel. More... | |
virtual OFCondition | getPhotometricInterpretation (OFString &value, const signed long pos=0) |
Get Photometric Interpretation. More... | |
virtual OFCondition | getRows (Uint16 &value, const signed long pos=0) |
Get Rows. More... | |
virtual OFCondition | getColumns (Uint16 &value, const signed long pos=0) |
Get Columns. More... | |
virtual OFCondition | getBitsAllocated (Uint16 &value, const signed long pos=0) |
Get Bits Allocated. More... | |
virtual OFCondition | getBitsStored (Uint16 &value, const signed long pos=0) |
Get Bits Stored. More... | |
virtual OFCondition | getHighBit (Uint16 &value, const signed long pos=0) |
Get High Bit. More... | |
virtual OFCondition | getPixelRepresentation (Uint16 &value, const signed long pos=0) |
Get Pixel Representation. More... | |
virtual OFCondition | getPlanarConfiguration (Uint16 &value, const signed long pos=0) |
Get Planar Configuration. More... | |
virtual OFCondition | getPixelAspectRatio (Uint16 &value, const signed long pos=0) |
Get Pixel Aspect Ratio. 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 | setRows (const Uint16 value, const OFBool checkValue=OFTrue) |
Set Rows. More... | |
virtual OFCondition | setColumns (const Uint16 value, const OFBool checkValue=OFTrue) |
Set Columns. 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 | setPixelAspectRatio (const OFString &verticalPixelSize, const OFString &horizontalPixelSize, const OFBool checkValue=OFTrue) |
Set Pixel Aspect Ratio. More... | |
virtual OFCondition | setICCProfile (const Uint8 *values, const size_t length) |
Set ICC Profile. More... | |
![]() | |
IODModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules) | |
Constructor. More... | |
IODModule () | |
Constructor. More... | |
![]() | |
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... | |
IODComponent & | operator= (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< IODRules > | getRules () |
Get rules handled by this module. More... | |
DcmItem & | getData () |
Get the data handled by this module. 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 | 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 |
This module's name ("ImagePixelModule") | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
OFshared_ptr< DcmItem > | m_Item |
Shared pointer to the data handled by this class. More... | |
OFshared_ptr< IODRules > | m_Rules |
Rules describing the attributes governed by this class. | |
IODComponent * | m_Parent |
The parent component (may be NULL) of this class. | |
Class representing the General Image 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)
IODImagePixelModule::IODImagePixelModule | ( | OFshared_ptr< DcmItem > | item, |
OFshared_ptr< IODRules > | rules | ||
) |
Constructor.
item | The item to be used for data storage. If NULL, the class creates an empty data container. |
rules | The rule set for this class. If NULL, the class creates one from scratch and adds its values. |
|
virtual |
Get Bits Allocated.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get Bits Stored.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get Columns.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get High Bit.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get ICC Profile.
values | Reference to variable in which the values should be stored |
|
virtual |
|
virtual |
Get Photometric Interpretation.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get Pixel Aspect Ratio.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get Pixel Representation.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get Planar Configuration.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get Rows.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get Samples per Pixel.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Set Bits Allocated.
value | Reference to variable in which the value should be stored |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Set Bits Stored.
value | Reference to variable in which the value should be stored |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Set Columns.
value | Reference to variable in which the value should be stored |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Set High Bit.
value | Reference to variable in which the value should be stored |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Set ICC Profile.
values | Reference to variable in which the values should be stored |
length | Length of array provided in values parameter |
|
virtual |
Set Photometric Interpretation.
value | Reference to variable in which the value should be stored |
checkValue | Check 'value' for conformance with VR (CS) and VM (1) if enabled |
|
virtual |
Set Pixel Aspect Ratio.
verticalPixelSize | The vertical pixel size (no unit) |
horizontalPixelSize | The horizontal pixel size (no unit) |
checkValue | Check 'value' for conformance with VR (IS) |
|
virtual |
Set Pixel Representation.
value | Reference to variable in which the value should be stored |
checkValue | Check 'value' for conformance with VR (US) and consistency if enabled |
|
virtual |
Set Planar Configuration.
value | Reference to variable in which the value should be stored |
checkValue | Check 'value' for conformance with VR (US) and consistency with other attributes if enabled |
|
virtual |
Set Rows.
value | Reference to variable in which the value should be stored |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
set Samples per Pixel
value | Reference to variable in which the value should be stored |
checkValue | Check 'value' for conformance with VR (US) and VM (1) if enabled |