DCMTK Version 3.6.8
OFFIS DICOM Toolkit
|
Class representing the Real World Value Mapping Functional Group that specifies the mapping of stored values to associated Real World values. More...
Public Member Functions | |
FGRealWorldValueMapping () | |
Constructor, creates empty functional group. | |
virtual | ~FGRealWorldValueMapping () |
Destructor, frees memory. | |
virtual FGBase * | clone () const |
Returns a deep copy of this object. More... | |
virtual DcmFGTypes::E_FGSharedType | getSharedType () const |
Returns that this functional group can be used as both, shared and per-frame. More... | |
virtual void | clearData () |
Clear all data. | |
virtual OFCondition | check () const |
Check whether data of functional group is valid. More... | |
virtual OFCondition | read (DcmItem &item) |
Read functional group from item, must contain the Real World Value Mapping Sequence. More... | |
virtual OFCondition | write (DcmItem &item) |
Writes this functional group to item, i.e. will write the Real World Value Mapping Sequence. More... | |
virtual OFVector< RWVMItem * > & | getRealWorldValueMapping () |
Return references to the various items inside the Real World Value Mapping Sequence. More... | |
virtual int | compare (const FGBase &rhs) const |
Comparison operator that compares the normalized value of this object with a given object of the same type, i.e. the elements within both functional groups (this and rhs parameter) are compared by value! Both objects (this and rhs) need to have the same type (i.e. both FGUnknown) to be comparable. More... | |
RWVMItem (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent=NULL) | |
Constructor. More... | |
RWVMItem (IODComponent *parent=NULL) | |
Constructor. More... | |
RWVMItem (const RWVMItem &rhs) | |
Copy Constructor. More... | |
RWVMItem * | clone () |
Clone this class (perform deep copy) More... | |
virtual | ~RWVMItem () |
Virtual destructor, frees memory. | |
virtual void | resetRules () |
Resets rules to their original values. | |
virtual OFString | getName () const |
Get name of component. More... | |
virtual int | compare (const IODComponent &rhs) const |
Comparison operator that compares the normalized value of this object with a given object of the same type, i.e. the elements within both functional groups (this and rhs parameter) are compared by value! Both objects (this and rhs) need to have the same type (i.e. both FGUnknown) to be comparable. 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 | getRealWorldValueFirstValueMapped (Sint32 &value, const unsigned long pos=0) const |
Get Real World Value First Value Mapped. More... | |
virtual OFCondition | getRealWorldValueLastValueMapped (Sint32 &value, const unsigned long pos=0) const |
Get Real World Value First Value Mapped. More... | |
virtual OFCondition | getDoubleFloatRealWorldValueFirstValueMapped (Float64 &value, const unsigned long pos=0) const |
Get Double Float Real World Value First Value Mapped. More... | |
virtual OFCondition | getDoubleFloatRealWorldValueLastValueMapped (Float64 &value, const unsigned long pos=0) const |
Get Double Float Real World Value Last Value Mapped. More... | |
virtual OFCondition | getRealWorldValueLUTData (Float64 &value, const unsigned long pos=0) const |
Get Real World Value LUT Data. More... | |
virtual OFCondition | getRealWorldValueLUTData (OFVector< Float64 > &values) const |
Get Real World Value LUT Data. More... | |
virtual OFCondition | getLUTExplanation (OFString &value, const signed long pos=0) const |
Get LUT Explanation. More... | |
virtual OFCondition | getLUTLabel (OFString &value, const signed long pos=0) const |
Get LUT Label. More... | |
virtual CodeSequenceMacro & | getMeasurementUnitsCode () |
Get Measurement Units Code Sequence (content) More... | |
virtual OFVector< ContentItemMacro * > & | getEntireQuantityDefinitionSequence () |
Get a reference to the entire ConceptNameCodeSequence, including items exceeding the value multiplicity restriction of "1". More... | |
virtual OFCondition | setRealWorldValueFirstValueMappedUnsigned (const Uint16 value, const OFBool checkValue=OFTrue) |
Set Real World Value First Value Mapped. More... | |
virtual OFCondition | setRealWorldValueFirstValueMappedSigned (const Sint16 &value, const OFBool checkValue=OFTrue) |
Set Real World Value First Value Mapped. More... | |
virtual OFCondition | setRealWorldValueLastValueMappedUnsigned (const Uint16 value, const OFBool checkValue=OFTrue) |
Set Real World Value Last Value Mapped. More... | |
virtual OFCondition | setRealWorldValueLastValueMappedSigned (const Sint16 &value, const OFBool checkValue=OFTrue) |
Set Real World Value Last Value Mapped. More... | |
virtual OFCondition | setDoubleFloatRealWorldValueFirstValueMapped (const Float64 value, const OFBool checkValue=OFTrue) |
Set Double Float Real World Value First Value Mapped. More... | |
virtual OFCondition | setDoubleFloatRealWorldValueLastValueMapped (const Float64 value, const OFBool checkValue=OFTrue) |
Set Double Float Real World Value Last Value Mapped. More... | |
virtual OFCondition | setRealWorldValueIntercept (const Float64 value, const OFBool checkValue=OFTrue) |
Set Real World Value Intercept. More... | |
virtual OFCondition | setRealWorldValueSlope (const Float64 value, const OFBool checkValue=OFTrue) |
Set Real World Value Slope. More... | |
virtual OFCondition | setRealWorldValueLUTData (const OFVector< Float64 > &value, const OFBool checkValue=OFTrue) |
Set Real World Value LUT Data. More... | |
virtual OFCondition | setLUTExplanation (const OFString &value, const OFBool checkValue=OFTrue) |
Set LUT Explanation. More... | |
virtual OFCondition | setLUTLabel (const OFString &value, const OFBool checkValue=OFTrue) |
Set LUT Label. More... | |
![]() | |
FGBase (const DcmFGTypes::E_FGType fgType) | |
Constructor, creates new functional group of given type. More... | |
virtual OFCondition | check () const =0 |
Check whether functional group has valid and complete data. More... | |
virtual OFCondition | read (DcmItem &item)=0 |
Read functional group from given item. More... | |
virtual OFCondition | write (DcmItem &item)=0 |
Write functional group to given item. More... | |
virtual DcmFGTypes::E_FGSharedType | getSharedType () const =0 |
Find out whether functional group is potentially only shared, only per-frame or can be both. More... | |
virtual DcmFGTypes::E_FGType | getType () const |
Return the type of this functional group. More... | |
virtual void | clearData ()=0 |
Clear any data in the group. | |
virtual | ~FGBase () |
Virtual destructor. | |
virtual int | compare (const FGBase &rhs) const =0 |
Comparison operator that compares the normalized value of this object with a given object of the same type, i.e. the elements within both functional groups (this and rhs parameter) are compared by value! Both objects (this and rhs) need to have the same type (e.g. both FGDerivationImage) to be comparable. More... | |
virtual FGBase * | clone () const =0 |
Returns a deep copy of this object. More... | |
Private Attributes | |
OFVector< RWVMItem * > | m_Items |
Items (1-n) of Real World Value Mapping Sequence. | |
CodeSequenceMacro | m_MeasurementUnitsCode |
Measurement Units Code Sequence. | |
OFVector< ContentItemMacro * > | m_QuantityDefinitionSequence |
Quantity Definition Sequence. | |
Static Private Attributes | |
static const OFString | m_ModuleName |
The name of this module ("RealWorldValueMappingItemMacro") | |
Additional Inherited Members | |
![]() | |
virtual OFCondition | getItemFromFGSequence (DcmItem &source, const DcmTagKey &seqKey, const unsigned long itemNum, DcmItem *&result) |
Get the item containing the payload of a functional group sequence, identified by the functional group's sequence key provided and the desired item number. More... | |
virtual OFCondition | getNumItemsFromFGSequence (DcmItem &source, const DcmTagKey &seqKey, unsigned long &result) |
Get number of items in a functional group sequence, identified by the functional group's sequence key. More... | |
virtual OFCondition | createNewFGSequence (DcmItem &destination, const DcmTagKey &seqKey, const unsigned long numItems, DcmItem *&firstItem) |
Create functional group sequence specified by given sequence tag key. More... | |
Class representing the Real World Value Mapping Functional Group that specifies the mapping of stored values to associated Real World values.
Class representing the Real World Value Mapping Item Macro: Attribute name: (VR, VM, Requirement Type) Real World Value First Value Mapped: (US or SS, 1, 1) Real World Value Last Value Mapped: (US or SS, 1, 1) Real World Value Intercept: (FD, 1, 1C) Real World Value Slope: (FD, 1, 1C) Real World Value LUT Data (FD, 1-n, 1C) LUT Explanation (LO, 1, 1) LUT Label (SH, 1, 1) Measurement Units Code Sequence (SQ, 1, 1) Quantity Definition Sequence (SQ, 1, 3)
|
virtual |
Check whether data of functional group is valid.
Implements FGBase.
RWVMItem * FGRealWorldValueMapping::clone | ( | ) |
Clone this class (perform deep copy)
|
virtual |
|
virtual |
Comparison operator that compares the normalized value of this object with a given object of the same type, i.e. the elements within both functional groups (this and rhs parameter) are compared by value! Both objects (this and rhs) need to have the same type (i.e. both FGUnknown) to be comparable.
This function is used in order to decide whether a functional group already exists, or is new. This is used in particular to find out whether a given functional group can be shared (i.e. the same information already exists as shared functional group) or is different from the same shared group. In that case the shared functional group must be distributed into per-frame functional groups, instead. The exact implementation for implementing the comparison is not relevant. However, it must be a comparison by value.
rhs | the right hand side of the comparison |
Implements FGBase.
|
virtual |
Comparison operator that compares the normalized value of this object with a given object of the same type, i.e. the elements within both functional groups (this and rhs parameter) are compared by value! Both objects (this and rhs) need to have the same type (i.e. both FGUnknown) to be comparable.
This function is used in order to decide whether a functional group already exists, or is new. This is used in particular to find out whether a given functional group can be shared (i.e. the same information already exists as shared functional group) or is different from the same shared group. In that case the shared functional group must be distributed into per-frame functional groups, instead. The exact implementation for implementing the comparison is not relevant. However, it must be a comparison by value.
rhs | the right hand side of the comparison |
|
virtual |
Get Double Float Real World Value First Value Mapped.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get Double Float Real World Value Last Value Mapped.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get a reference to the entire ConceptNameCodeSequence, including items exceeding the value multiplicity restriction of "1".
|
virtual |
Get LUT Explanation.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get LUT Label.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
|
virtual |
Get name of component.
|
virtual |
Get Real World Value First Value Mapped.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get Real World Value First Value Mapped.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get Real World Value LUT Data.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1) |
|
virtual |
Get Real World Value LUT Data.
values | Reference to variable in which the values should be stored |
Return references to the various items inside the Real World Value Mapping Sequence.
|
inlinevirtual |
Returns that this functional group can be used as both, shared and per-frame.
Implements FGBase.
References DcmFGTypes::EFGS_BOTH.
|
virtual |
Read functional group from item, must contain the Real World Value Mapping Sequence.
item | The item to read from |
Implements FGBase.
|
virtual |
Read attributes from given item into this class.
source | The source to read from |
clearOldData | If OFTrue, old data is cleared before reading. Otherwise old data is overwritten (or amended) |
FGRealWorldValueMapping::RWVMItem | ( | const RWVMItem & | rhs | ) |
Copy Constructor.
rhs | The item to copy from |
FGRealWorldValueMapping::RWVMItem | ( | IODComponent * | parent = NULL | ) |
Constructor.
parent | The parent of the IOD component (NULL if none or unknown) |
FGRealWorldValueMapping::RWVMItem | ( | OFshared_ptr< DcmItem > | item, |
OFshared_ptr< IODRules > | rules, | ||
IODComponent * | parent = NULL |
||
) |
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. |
parent | The parent of the IOD component (NULL if none or unknown) |
|
virtual |
Set Double Float Real World Value First Value Mapped.
value | Value to be set |
checkValue | Check 'value'. Does nothing, only for consistency with other set() functions. |
|
virtual |
Set Double Float Real World Value Last Value Mapped.
value | Value to be set |
checkValue | Check 'value'. Does nothing, only for consistency with other set() functions. |
|
virtual |
Set LUT Explanation.
value | Value to be set |
checkValue | Check 'value' for conformance with VR (LO) and VM (1) if enabled |
|
virtual |
Set LUT Label.
value | Value to be set |
checkValue | Check 'value' for conformance with VR (SH) and VM (1) if enabled |
|
virtual |
Set Real World Value First Value Mapped.
value | Value to be set. If Pixel Representation is -1 (signed pixel data) value must be -2^15 < value < 2^15-1. Otherwise use setRealWorldValueFirstValueMappedUnsigned(). |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Set Real World Value First Value Mapped.
value | Value to be set. If Pixel Representation is 0 (unsigned pixel data) value must be 0 < value < 2^16. Otherwise use setRealWorldValueFirstValueMappedSigned(). |
checkValue | Check 'value' for conformance with VR (US and VM (1) if enabled |
|
virtual |
Set Real World Value Intercept.
value | Value to be set |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Set Real World Value Last Value Mapped.
value | Value to be set. If Pixel Representation is -1 (signed pixel data) value must be -2^15 < value < 2^15-1. Otherwise use setRealWorldValueLastValueMappedUnsigned(). |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Set Real World Value Last Value Mapped.
value | Value to be set. If Pixel Representation is 0 (unsigned pixel data) value must be 0 < value < 2^16. Otherwise use setRealWorldValueLastValueMappedSigned(). |
checkValue | Check 'value' for conformance with VR (US and VM (1) if enabled |
|
virtual |
Set Real World Value LUT Data.
value | Values to be set |
checkValue | Check 'value' for conformance with VR (FD) and VM (1-n) if enabled |
|
virtual |
Set Real World Value Slope.
value | Value to be set |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Write attributes from this class into given item.
destination | The item to write to |
Implements FGBase.
|
virtual |
Writes this functional group to item, i.e. will write the Real World Value Mapping Sequence.
item | The item to read from |
Implements FGBase.