|
DCMTK
Version 3.6.2
OFFIS DICOM Toolkit
|
Class representing a Track Set within the Tractography Results IOD. More...
Inheritance diagram for TrcTrackSet:Public Member Functions | |
| virtual | ~TrcTrackSet () |
| Destructor, frees memory. | |
| virtual void | resetRules () |
| Resets rules to their original values. | |
| virtual void | inventMissing () |
| Set missing values by inventing "default values". More... | |
| virtual OFString | getName () const |
| Get name of component. More... | |
| virtual void | clearData () |
| Clear all data. | |
| virtual OFCondition | read (DcmItem &source, const OFBool clearOldData=OFTrue) |
| Read attributes from given item into this class. More... | |
| virtual const OFVector< TrcTrack * > & | getTracks () |
| Get Tracks of this Track Set. More... | |
| virtual OFCondition | write (DcmItem &destination) |
| Write attributes from this class into given item. More... | |
| virtual OFCondition | getTrackSetNumber (Uint16 &value, const unsigned long pos=0) const |
| Get Track Set Number (should be 1-n) More... | |
| virtual OFCondition | getTrackSetLabel (OFString &value, const signed long pos=0) const |
| Get Track Set Label. More... | |
| virtual OFCondition | getTrackSetDescription (OFString &value, const signed long pos=0) const |
| Get Track Set Description. More... | |
| virtual CodeWithModifiers & | getTrackSetAnatomy () |
| Get reference to Track Set Anatomical Type Code. More... | |
| virtual OFCondition | getRecommendedDisplayCIELabValue (Uint16 &L, Uint16 &a, Uint16 &b) |
| Get copy of Recommended Display CIELab Value. More... | |
| virtual OFCondition | getRecommendedLineThickness (Float32 &value, const unsigned long pos=0) |
| Get Recommended Line Thickness. More... | |
| virtual OFCondition | getLaterality (TrcTypes::E_TrackSetLaterality &laterality) |
| Get Laterality. More... | |
| virtual OFCondition | findMeasurementsByType (const CodeSequenceMacro &type, OFVector< size_t > &measurementNumbers) |
| Find measurements of a specific type. More... | |
| virtual OFCondition | getMeasurement (const size_t measurementIndex, const TrcMeasurement *&measurement) |
| Get measurement by index. More... | |
| virtual void | getMeasurementInfos (OFVector< OFPair< CodeSequenceMacro, CodeSequenceMacro > > &typesAndUnits) |
| Get descriptive information of all measurements. More... | |
| virtual const OFVector< TrcTracksStatistic * > & | getTrackStatistics () |
| Get access to all statistics defined for the Tracks in this Track Set. More... | |
| virtual const OFVector< TrcTrackSetStatistic * > & | getTrackSetStatistics () |
| Get access to all statistics defined for the Tracks in this Track Set. More... | |
| virtual CodeSequenceMacro & | getDiffusionAcquisitionCode () |
| Get access to diffusion acquisition code. More... | |
| virtual CodeSequenceMacro & | getDiffusionModelCode () |
| Get access to diffusion model code used. More... | |
| virtual OFVector< CodeSequenceMacro * > & | getTrackingAlgorithmIdentification () |
| Get access to tracking algorithm identification codes. More... | |
| size_t | getNumberOfTracks () |
| Returns number of Tracks in Track Set. More... | |
| size_t | getNumberOfTrackSetStatistics () |
| Returns number of Track Set Statistics in Track Set. More... | |
| size_t | getNumberOfTrackStatistics () |
| Returns number of Track Statistics in Track Set. More... | |
| size_t | getNumberOfMeasurements () |
| Returns number of Measurements in Track Set. More... | |
| virtual OFCondition | addTrack (const Float32 *pointData, const size_t numPoints, const Uint16 *recommendedCIELabColors, const size_t numColors, TrcTrack *&result) |
| Add track to Track Set. More... | |
| virtual OFCondition | addMeasurement (const CodeSequenceMacro &measurementCode, const CodeSequenceMacro &measurementUnitCodes, TrcMeasurement *&measurement) |
| Add measurement for this Track Set. More... | |
| virtual OFCondition | addTrackStatistics (const CodeSequenceMacro &typeCode, const CodeSequenceMacro &typeModifierCode, const CodeSequenceMacro &unitsCode, const Float32 *values, const size_t numValues, TrcTracksStatistic *&statistic) |
| Add Track Statistic, i.e. More... | |
| virtual OFCondition | addTrackSetStatistic (const CodeSequenceMacro &typeCode, const CodeSequenceMacro &typeModifierCode, const CodeSequenceMacro &unitsCode, const Float64 value, TrcTrackSetStatistic *&statistic) |
| Add Track Set Statistic, i.e. More... | |
| virtual OFCondition | setTrackSetLabel (const OFString &value, const OFBool checkValue=OFTrue) |
| Set Track Set Label. More... | |
| virtual OFCondition | setTrackSetDescription (const OFString &value, const OFBool checkValue=OFTrue) |
| Set Track Set Description. More... | |
| virtual OFCondition | setRecommendedDisplayCIELabValue (const Uint16 L, const Uint16 a, const Uint16 b) |
| Set Recommended Display CIELab Value. More... | |
| virtual OFCondition | setRecommendedLineThickness (const Float32 &value, const OFBool checkValue=OFTrue) |
| Set Recommended Line Thickness. More... | |
| virtual OFCondition | setLaterality (const TrcTypes::E_TrackSetLaterality value, const OFBool checkValue=OFTrue) |
| Set Laterality. More... | |
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... | |
| 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... | |
| 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 | 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 Public Member Functions | |
| static OFCondition | create (const OFString &trackSetLabel, const OFString &trackSetDescription, const CodeWithModifiers &trackSetAnatomy, const CodeSequenceMacro &trackSetDiffusionModelCode, const CodeSequenceMacro &trackSetAlgorithmIdentification, TrcTrackSet *&trackSet) |
| Create TrcTrackSet object by proving required data. More... | |
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 Member Functions | |
| TrcTrackSet () | |
| Protected constructor, use create() method to create a new Track Set. | |
| OFCondition | readTrackStatistics (DcmItem &source) |
| Reads Track statistics from item into dedicated structures. More... | |
| OFCondition | readTrackSetStatistics (DcmItem &source) |
| Reads Track Set statistics from item into dedicated structures. More... | |
| OFCondition | readTracks (DcmItem &source) |
| Reads Tracks from item into dedicated structures. More... | |
| void | writeTrackStatistics (OFCondition &result, DcmItem &destination) |
| Write Track Statistics to given item. More... | |
| void | writeTrackSetStatistics (OFCondition &result, DcmItem &destination) |
| Write Track Statistics to given item. More... | |
| OFCondition | writeMeasurements (OFCondition &result, DcmItem &destination) |
| Write Measurements to given item. More... | |
| OFCondition | writeTracks (OFCondition &result, DcmItem &destination) |
| Write Tracks to given item. More... | |
| OFCondition | checkMeasurements () |
| Check whether measurements have data for all tracks. More... | |
Private Attributes | |
| OFVector< TrcTrack * > | m_Tracks |
| Data for all tracks (i.e. content of Track Sequence) | |
| CodeWithModifiers | m_Anatomy |
| Anatomy code for this Track Set. | |
| OFVector< TrcMeasurement * > | m_Measurements |
| Measurements for this Track Set. | |
| OFVector< TrcTracksStatistic * > | m_TrackStatistics |
| Statistics for Tracks in this Track Set. | |
| OFVector< TrcTrackSetStatistic * > | m_TrackSetStatistics |
| Statistics for Track Set. | |
| CodeSequenceMacro | m_DiffusionAcquisitionCode |
| Code for diffusion acquisition used for this Track Set. | |
| CodeSequenceMacro | m_DiffusionModelCode |
| Code for diffusion model used for this Track Set. | |
| OFVector< CodeSequenceMacro * > | m_TrackingAlgorithmIdentification |
| Codes for algorithms used to create this Track Set. | |
Friends | |
| class | DcmIODUtil |
Additional Inherited Members | |
Protected Attributes inherited from IODComponent | |
| 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 a Track Set within the Tractography Results IOD.
A Track Set is a set of tracks (really), and might define a measurements and statistics which then must be populated for all tracks in the set.
|
virtual |
Add measurement for this Track Set.
| measurementCode | The type of measurement. DICOM prescribes a code from CID 7263 "Diffusion Tractography Measurement Types" |
| measurementUnitCodes | The physical units of the measured value. DICOM prescribes a code from CID 82 "Units of Measurement". |
| measurement | The created measurement, if successful, NULL otherwise |
|
virtual |
Add track to Track Set.
| pointData | Array of points (x,y,z coordinate for each point) |
| numPoints | Number of points in pointData (i.e. number of point coordinates divided by 3) |
| recommendedCIELabColors | Recommended display color(s) as CIELab values, i.e. L,a,b component(s). There are 3 modes: 1) Single color: All points in track will be colored in that color 2) No color (NULL): Color is not defined on a per-track basis but must be defined on Track Set level 3) One color per point: Colors for all points are provided separately. |
| numColors | Number of colors defined in recommendedCIELabColors (must be either 0, 1 or numPoints) |
| result | Returns the resulting Track if creation was successful, error otherwise |
|
virtual |
Add Track Set Statistic, i.e.
a statistical value computed for the whole Track Set.
| typeCode | The type of statistic, DICOM prescribes code from CID 7263 "Diffusion Tractography Measurement Types". |
| typeModifierCode | The region of interest of this statistic. DICOM prescribes code from CID 7464 "General Region of Interest Measurement Modifiers" |
| unitsCode | The physical units of the measured value. DICOM prescribes a code from CID 82 "Units of Measurement". |
| value | The statistical value |
| statistic | Returns the created statistic, if successful. NULL otherwise |
|
virtual |
Add Track Statistic, i.e.
statistic that is defined once and where a single value must be provided for all tracks.
| typeCode | The type of statistic, DICOM prescribes code from CID 7263 "Diffusion Tractography Measurement Types". |
| typeModifierCode | The region of interest of this statistic. DICOM prescribes code from CID 7464 "General Region of Interest Measurement Modifiers" |
| unitsCode | The physical units of the measured value. DICOM prescribes a code from CID 82 "Units of Measurement". |
| values | The statistical values, one for each track |
| numValues | The number of values in statisticValues (must be equal to number of tracks in this Track Set) |
| statistic | Returns the created statistic, if successful. NULL otherwise |
|
protected |
Check whether measurements have data for all tracks.
|
static |
Create TrcTrackSet object by proving required data.
| trackSetLabel | Label for the Track Set (256 chars max, VR=LO) |
| trackSetDescription | Description for the Track Set (2^32-2 bytes maximum, VR=UT) |
| trackSetAnatomy | Code for the anatomy the Track Set covers. DICOM proposes CID 7710 "Tractography Anatomic Sites" (Baseline) |
| trackSetDiffusionModelCode | Code for diffusion model used for Track Set. DICOM prescribes code from CID 7261 "Diffusion Model Value Types" |
| trackSetAlgorithmIdentification | Algorithm used in order to create Track Set. DICOM prescribes code from CID 7262 "Diffusion Tractography Algorithm Families". |
| trackSet | Returns the created Track Set, if successfull (NULL otherwise) |
|
virtual |
Find measurements of a specific type.
They can be retrieved afterwards by using getMeasurement().
| type | The measurement type to look for |
| measurementNumbers | Returns the measurement indexes that are of specified type. |
|
virtual |
Get access to diffusion acquisition code.
|
virtual |
Get access to diffusion model code used.
|
virtual |
Get Laterality.
| laterality | Reference to the variable in which the value should be stored. If value in dataset is not set at all, LAT_UNKNOWN is returned. If a value is present that is not covered by the standard LAT_ERROR is returned. |
|
virtual |
Get measurement by index.
The index can be identified by using findMeasurementsByType() or getMeasurementInfos()
| measurementIndex | The index of the measurement (starting from 0) |
| measurement | Returns a reference to the measurement requested |
|
virtual |
Get descriptive information of all measurements.
| typesAndUnits | Returns vector of pairs, which each pair holding a code for type of measurement and its physical units. |
|
virtual |
| size_t TrcTrackSet::getNumberOfMeasurements | ( | ) |
Returns number of Measurements in Track Set.
| size_t TrcTrackSet::getNumberOfTracks | ( | ) |
Returns number of Tracks in Track Set.
| size_t TrcTrackSet::getNumberOfTrackSetStatistics | ( | ) |
Returns number of Track Set Statistics in Track Set.
| size_t TrcTrackSet::getNumberOfTrackStatistics | ( | ) |
Returns number of Track Statistics in Track Set.
|
virtual |
Get copy of Recommended Display CIELab Value.
| L | Returns CIELab L value |
| a | Returns CIELab a value |
| b | Returns CIELab b value |
|
virtual |
Get Recommended Line Thickness.
| value | Reference to the variable in which the value should be stored |
| pos | Index of the value to get (0..vm-1) |
|
virtual |
Get access to tracking algorithm identification codes.
Get Tracks of this Track Set.
|
virtual |
Get reference to Track Set Anatomical Type Code.
|
virtual |
Get Track Set Description.
| 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 Track Set Label.
| 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 Track Set Number (should be 1-n)
| value | Reference to variable in which the value should be stored |
| pos | Index of the value to get (0..vm-1) |
|
virtual |
Get access to all statistics defined for the Tracks in this Track Set.
|
virtual |
Get access to all statistics defined for the Tracks in this Track Set.
|
virtual |
Set missing values by inventing "default values".
Automatically called during write() by IODComponent.
Reimplemented from IODComponent.
|
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.
|
protected |
Reads Tracks from item into dedicated structures.
| source | The item to read from, must contain Track Sequence |
|
protected |
Reads Track Set statistics from item into dedicated structures.
| source | The item to read from, must contain Track Statistics Sequence |
|
protected |
Reads Track statistics from item into dedicated structures.
| source | The item to read from, must contain Track Set Statistics Sequence |
|
virtual |
Set Laterality.
| value | Value to be set |
| checkValue | Check 'value' for conformance if enabled. Parameter is not used but present for consistency with other functions. |
|
virtual |
Set Recommended Display CIELab Value.
| L | CIELab L component value |
| a | CIELab a component value |
| b | CIELab b component value |
|
virtual |
Set Recommended Line Thickness.
| value | Value to be set. The units shall be the same as the units of the coordinate system in which the point coordinates are specified. |
| checkValue | Check 'value' for conformance with VR (FL) if enabled |
|
virtual |
Set Track Set Description.
| value | Value to be set (single value only) or "" for no value |
| checkValue | Check 'value' for conformance with VR (UT) and VM (1) if enabled |
|
virtual |
Set Track Set Label.
| value | Value to be set (single value only) or "" for no value |
| checkValue | Check 'value' for conformance with VR (LO) and VM (1) if enabled |
|
virtual |
Write attributes from this class into given item.
| destination | The item to write to |
Reimplemented from IODComponent.
|
protected |
Write Measurements to given item.
| result | Returns EC_Normal if writing was successful, error otherwise or if result has not been EC_Normal when calling |
| destination | The destination item to write to. The Measurements Sequence will be written by this method. |
|
protected |
Write Tracks to given item.
| result | Returns EC_Normal if writing was successful, error otherwise or if result has not been EC_Normal when calling |
| destination | The destination item to write to. The Tracks Sequence will be written by this method. |
|
protected |
Write Track Statistics to given item.
| result | Returns EC_Normal if writing was successful, error otherwise or if result has not been EC_Normal when calling |
| destination | The destination item to write to. The Track Set Statistic Sequence will be written by this method. |
|
protected |
Write Track Statistics to given item.
| result | Returns EC_Normal if writing was successful, error otherwise or if result has not been EC_Normal when calling |
| destination | The destination item to write to. The Track Statistic Sequence will be written by this method. |