DCMTK
Version 3.6.1 20170228
OFFIS DICOM Toolkit
|
Class representing the General Image Module: More...
Public Member Functions | |
IODGeneralImageModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules) | |
Constructor. More... | |
IODGeneralImageModule () | |
Constructor. | |
virtual | ~IODGeneralImageModule () |
Destructor. | |
virtual void | resetRules () |
Resets rules to their original values. | |
virtual OFString | getName () const |
Get name of module. More... | |
virtual OFCondition | getInstanceNumber (OFString &value, const signed long pos=0) |
Get Instance Number. More... | |
virtual OFCondition | getPatientOrientation (OFString &value, const signed long pos=0) |
Get Patient Orientation. More... | |
virtual OFCondition | getContentDate (OFString &value, const signed long pos=0) |
Get Content Date. More... | |
virtual OFCondition | getContentTime (OFString &value, const signed long pos=0) |
Get Content Time. More... | |
virtual OFCondition | getImageType (OFString &value, const signed long pos=0) |
Get Image Type. More... | |
virtual OFCondition | getAcquisitionNumber (OFString &value, const signed long pos=0) |
Get Acquisition Number. More... | |
virtual OFCondition | getAcquisitionDate (OFString &value, const signed long pos=0) |
Get Acquisition Date. More... | |
virtual OFCondition | getAcquisitionTime (OFString &value, const signed long pos=0) |
Get Acquisition Time. More... | |
virtual OFCondition | getAcquisitionDateTime (OFString &value, const signed long pos=0) |
Get Acquisition Date Time. More... | |
virtual OFCondition | getImageComments (OFString &value, const signed long pos=0) |
Get Image Comments. More... | |
virtual OFCondition | getBurnedInAnnotation (OFString &value, const signed long pos=0) |
Get Burned In Annotation. More... | |
virtual OFCondition | getRecognizableVisualFeatures (OFString &value, const signed long pos=0) |
Get Recognizable Visual Features. More... | |
virtual OFCondition | getLossyImageCompression (OFString &value, const signed long pos=0) |
Get Lossy Image Compression. More... | |
virtual OFCondition | getLossyImageCompressionRatio (OFString &value, const signed long pos=0) |
Get Lossy Image Compression. More... | |
virtual OFCondition | getLossyImageCompressionMethod (OFString &value, const signed long pos=0) |
Get Lossy Image Compression Method. More... | |
virtual OFCondition | getPresentationLUTShape (OFString &value, const signed long pos=0) |
Get Presentation LUT Shape. More... | |
virtual OFCondition | getIrradiationEventUID (OFString &value, const signed long pos=0) |
Get Irridation Event UID. More... | |
virtual OFCondition | setInstanceNumber (const OFString &value, const OFBool checkValue=OFTrue) |
Set Instance Number. More... | |
virtual OFCondition | setPatientOrientation (const OFString &value, const OFBool checkValue=OFTrue) |
Set Patient Orientation. More... | |
virtual OFCondition | setContentDate (const OFString &value, const OFBool checkValue=OFTrue) |
Set Content Date. More... | |
virtual OFCondition | setContentTime (const OFString &value, const OFBool checkValue=OFTrue) |
Set Content Time. More... | |
virtual OFCondition | setImageType (const OFString &value, const OFBool checkValue=OFTrue) |
Set Image Type. More... | |
virtual OFCondition | setAcquisitionNumber (const OFString &value, const OFBool checkValue=OFTrue) |
Set Acquisition Number. More... | |
virtual OFCondition | setAcquisitionDate (const OFString &value, const OFBool checkValue=OFTrue) |
Set Acquisition Date. More... | |
virtual OFCondition | setAcquisitionTime (const OFString &value, const OFBool checkValue=OFTrue) |
Set Acquisition Time. More... | |
virtual OFCondition | setAcquisitionDateTime (const OFString &value, const OFBool checkValue=OFTrue) |
Set Acquisition Date Time. More... | |
virtual OFCondition | setImageComments (const OFString &value, const OFBool checkValue=OFTrue) |
Set Image Comments. 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 | 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 | setPresentationLUTShape (const OFString &value, const OFBool checkValue=OFTrue) |
Set Presentation LUT Shape. More... | |
virtual OFCondition | setIrradiationEventUID (const OFString &value, const OFBool checkValue=OFTrue) |
Set Irradiation Event UID. More... | |
![]() | |
IODModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules) | |
Constructor. More... | |
IODModule () | |
Constructor. More... | |
IODModule (const IODModule &rhs) | |
Copy constructor, creates shallow copy. More... | |
IODModule & | operator= (const IODModule &rhs) |
Assignment operator, creates shallow copy. More... | |
~IODModule () | |
Desctructor. | |
![]() | |
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... | |
virtual void | makeOptional () |
Make component optional by turning all attributes requirement types of it to type 3. 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 |
The module's name ("GeneralIamgeModule") | |
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:
Instance Number: (IS, 1, 2) Patient Orientation: (CS, 2, 2) Content Date: (DA, 1, 2C) Content Time: (TM, 1, 2C) Image Type: (CS, 1, 2-n) Acquisition Number (IS, 1, 3) Acquisition Date (DA, 1, 3) Acquisition Time (TM, 1, 3) Acquisition Date Time (DT, 1, 3) Image Comments (LT, 1, 3) Burned In Annotation (CS, 1, 3) Recognizable Visual Features (CS, 1, 3) Lossy Image Compression (CS, 1, 3) Lossy Image Compression Ratio (DS, 1, 3) Lossy Image Compression Method (CS, 1-n, 3) Presentation LUT Shape (CS, 1, 3) Irradiation Event UID (CS, 1-n, 3)
IODGeneralImageModule::IODGeneralImageModule | ( | 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 Acquisition Date.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Acquisition Date Time.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Acquisition Number.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Acquisition Time.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Burned In Annotation.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Content Date.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Content Time.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Image Comments.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Image Type.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Instance Number.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Irridation Event UID.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Lossy Image Compression.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Lossy Image Compression Method.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Lossy Image Compression.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
|
virtual |
Get Patient Orientation.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Presentation LUT Shape.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Recognizable Visual Features.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Set Acquisition Date.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (DA) and VM (1) if enabled |
|
virtual |
Set Acquisition Date Time.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (DT) and VM (1) if enabled |
|
virtual |
Set Acquisition Number.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (IS) and VM (1) if enabled |
|
virtual |
Set Acquisition Time.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (TM) and VM (1) if enabled |
|
virtual |
Set Burned In Annotation.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (CS) and VM (1) if enabled |
|
virtual |
Set Content Date.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (DA) and VM (1) if enabled |
|
virtual |
Set Content Time.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (TM) and VM (1) if enabled |
|
virtual |
Set Image Comments.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (LT) and VM (1) if enabled |
|
virtual |
Set Image Type.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (CS) and VM (2-n) if enabled |
|
virtual |
Set Instance Number.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (IS) and VM (1) if enabled |
|
virtual |
Set Irradiation Event UID.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (CS) and VM (1-n) if enabled |
|
virtual |
Set Lossy Image Compression.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (CS) and VM (1) if enabled |
|
virtual |
Set Lossy Image Compression method.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (CS) and VM (1-n) if enabled |
|
virtual |
Set Lossy Image Compression Ratio.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (DS) and VM (1) if enabled |
|
virtual |
Set Patient Orientation.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (CS) and VM (2) if enabled |
|
virtual |
Set Presentation LUT Shape.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (CS) and VM (1) if enabled |
|
virtual |
Set Recognizable Visual Features.
value | Value to be set (single value only). |
checkValue | Check 'value' for conformance with VR (CS) and VM (1) if enabled |