|
DCMTK Version 3.6.9
OFFIS DICOM Toolkit
|
Class representing a Measurement within the Tractography Results IOD. More...
Inheritance diagram for TrcMeasurement:Classes | |
| class | Values |
| Class that holds actual measurement values. More... | |
Public Member Functions | |
| virtual | ~TrcMeasurement () |
| Destructor, frees memory. | |
| virtual OFCondition | get (const size_t trackNumber, CodeSequenceMacro &type, CodeSequenceMacro &units, const Float32 *&measurementData, unsigned long &numMeasurementData, const Uint32 *&pointIndices) |
| Get measurement data for a selected track. | |
| virtual OFCondition | setTrackValues (const size_t trackNumber, const Float32 *measurementValues, const unsigned long &numValues) |
| Set measurement values for a single track. | |
| virtual OFCondition | setTrackValues (const size_t trackNumber, const Float32 *measurementValues, const unsigned long &numValues, const Uint32 *pointIndices) |
| Set measurement values for a single track. | |
| virtual OFCondition | read (DcmItem &source, const OFBool clearOldData=OFTrue) |
| Read attributes from given item into this class. | |
| virtual OFCondition | write (DcmItem &destination) |
| Write attributes from this class into given item. | |
| virtual OFVector< TrcMeasurement::Values * > & | getValues () |
| Get measurement values for all tracks. | |
| virtual CodeSequenceMacro & | getType () |
| Get reference to type of measurement code. | |
| virtual CodeSequenceMacro & | getUnits () |
| Get reference to measurement units code. | |
| virtual void | resetRules () |
| Resets rules to their original values. | |
| virtual OFString | getName () const |
| Get name of component. | |
| virtual void | clearData () |
| Clear all data. | |
| virtual OFBool | checkValuesComplete () |
| Check whether measurement values for all tracks are set. | |
Public Member Functions inherited from IODComponent | |
| IODComponent (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent=NULL) | |
| Constructor. | |
| IODComponent (IODComponent *parent=NULL) | |
| Constructor, creates rules and item from scratch. | |
| IODComponent & | operator= (const IODComponent &rhs) |
| Assignment operator, copies contained item and rule set from rhs to "this" attribute set. | |
| IODComponent (const IODComponent &rhs) | |
| Copy constructor, copies reference to contained item and rule set to "this" attribute set. | |
| virtual | ~IODComponent () |
| Virtual Destructor. | |
| void | clearData () |
| Clear all attributes from the data that are handled by this module. | |
| virtual void | inventMissing () |
| Set missing values by inventing "default values". | |
| OFshared_ptr< IODRules > | getRules () |
| Get rules handled by this module. | |
| virtual void | makeOptional () |
| Make component optional by turning all attributes requirement types of it to type 3. | |
| DcmItem & | getData () |
| Get the data handled by this module. | |
| virtual OFCondition | check (const OFBool quiet=OFFalse) |
| Check whether this component's data satisfies the underlying rules. | |
| virtual int | compare (const IODComponent &rhs) const |
| Comparison operator for IOD Components. | |
| virtual bool | getValueCheckOnWrite () const |
| Get whether attribute value errors will be handled as errors on writing. | |
| virtual void | setValueCheckOnWrite (const OFBool checkValue) |
| Set whether attribute values should be checked on writing, i.e. | |
Static Public Member Functions | |
| static OFCondition | create (const CodeSequenceMacro &measurementCode, const CodeSequenceMacro &measurementUnitCodes, TrcMeasurement *&measurement) |
| Create TrcMeasurement from minimal data. | |
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. | |
| static OFCondition | write (DcmItem &source, IODRules &rules, DcmItem &destination, const OFString &componentName, const OFBool checkValue) |
| Static helper function that writes attributes from given item into destination item, as determined by the provided rules and component name. | |
Protected Member Functions | |
| TrcMeasurement () | |
| Protected constructor, use create() method to create a new track set. | |
Private Attributes | |
| CodeSequenceMacro | m_Type |
| Single item from Concept Name Code Sequence (type of measurement) | |
| CodeSequenceMacro | m_Units |
| Single item from Measurement Units Code Sequence (units of measurement) | |
| OFVector< TrcMeasurement::Values * > | m_Values |
| Items from from Measurement Values Sequence. | |
Friends | |
| class | DcmIODUtil |
| Allow read/write functions in DcmIODUtil to access class internals. | |
Additional Inherited Members | |
Protected Attributes inherited from IODComponent | |
| OFshared_ptr< DcmItem > | m_Item |
| Shared pointer to the data handled by this class. | |
| 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. | |
| OFBool | m_CheckValueOnWrite |
| Denotes whether attribute values should be checked on writing, i.e. | |
Class representing a Measurement within the Tractography Results IOD.
A measurement provides measurement values for all tracks in the related track set. Measurement values can be defined for all points in a track, or only selected point indices.
|
virtual |
Check whether measurement values for all tracks are set.
|
static |
Create TrcMeasurement from minimal data.
| measurementCode | Code describing what is measured. Code must be taken from CID 7263 "Diffusion Tractography Measurement Types" |
| measurementUnitCodes | Code describing the physical unit measured. Code must taken from CID 82 "Measurement Unit" (based on UCUM) |
| measurement | The measurement, if it could be created, NULL otherwise |
References TrcMeasurement().
|
virtual |
Get measurement data for a selected track.
| trackNumber | The track whose measurement data should be retrieved |
| type | Returns the type of measurement |
| units | Returns the units of measurement |
| measurementData | Returns the measurement data values |
| numMeasurementData | Returns the number of measurement values in measurementData |
| pointIndices | Returns the point indices the measurement data values refer to. If they refer to all points in the track, NULL is returned here |
|
virtual |
Get name of component.
Implements IODComponent.
|
virtual |
Get reference to type of measurement code.
|
virtual |
Get reference to measurement units code.
|
virtual |
Get measurement values for all tracks.
|
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) |
Reimplemented from IODComponent.
|
virtual |
Set measurement values for a single track.
Requires measurement value for all points in the track.
| trackNumber | The number of the track to set values for (0 for first track) |
| measurementValues | The measurement values |
| numValues | Number of measurement values in measurementValues, must be equal to number of values in track. |
|
virtual |
Set measurement values for a single track.
Requires list of indices to those points in track for which the measurement values are defined for.
| trackNumber | The number of the track to set values for (0 for first track) |
| measurementValues | The measurement values |
| numValues | Number of measurement values in measurementValues, must be equal or less to number of values in track. |
| pointIndices | Indices of the points in the track that the measurement values apply to. Number of values must be equal to numValues. |
|
virtual |
Write attributes from this class into given item.
| destination | The item to write to |
Reimplemented from IODComponent.