DCMTK
Version 3.6.5
OFFIS DICOM Toolkit
|
Class representing an object of the "Tractography Results" object IOD. More...
Public Member Functions | |
virtual OFCondition | import (const OFString &filename, const OFBool readPatient, const OFBool readStudy, const OFBool readFoR=OFFalse, const OFBool readSeries=OFFalse, const OFBool updateCommonInstanceReferences=OFTrue, const OFBool takeOverCharset=OFTrue) |
CAUTION: Parameter order (readFoR and readSeries) changed, and there is a new parameter "takeOverCharset" which per default takes over the charset from the given source file! Take over general information for Patient, Study, Series and/or Frame of Reference from existing file. More... | |
virtual OFCondition | addTrackSet (const OFString &trackSetLabel, const OFString &trackSetDescription, const CodeWithModifiers &anatomyCode, const CodeSequenceMacro &diffusionModelCode, const AlgorithmIdentificationMacro &algoIdentCode, TrcTrackSet *&trackSet) |
Add Track Set to object. More... | |
virtual | ~TrcTractographyResults () |
Destructor, frees memory. | |
virtual OFCondition | saveFile (const OFString &filename, const E_TransferSyntax writeXfer=EXS_LittleEndianExplicit) |
Save current object to given filename. More... | |
virtual OFCondition | writeDataset (DcmItem &dataset) |
Write current object to given item. More... | |
virtual OFCondition | getModality (OFString &value, const signed long pos=0) |
Get Modality (overwrite from DcmIODCommon. More... | |
virtual OFCondition | getContentDate (OFString &value, const signed long pos=0) |
Get Content Date (from Tractography Results Module) More... | |
virtual OFCondition | getContentTime (OFString &value, const signed long pos=0) |
Get Content Time (from Tractography Results Module) More... | |
virtual IODReferences & | getReferencedInstances () |
Get referenced instances (from Tractography Results Module) More... | |
virtual IODEnhGeneralEquipmentModule & | getEquipment () |
Get reference to Equipment information. More... | |
virtual ContentIdentificationMacro & | getContentIdentification () |
Return reference to content identification of this Tractography Results object (from Tractography Results Module) More... | |
virtual size_t | getNumberOfTrackSets () |
Returns number of Track Sets in Tractography Results object. More... | |
virtual OFVector< TrcTrackSet * > & | getTrackSets () |
Return Track Sets (from Tractography Results Module) More... | |
![]() | |
DcmIODCommon () | |
Constructor. | |
DcmIODCommon (const DcmIODCommon &rhs) | |
Copy Constructor. More... | |
OFshared_ptr< IODRules > | getRules () |
Get rules handled by this IOD. More... | |
OFshared_ptr< DcmItem > | getData () |
Get item managed by this IOD. More... | |
IODPatientModule & | getPatient () |
Get Patient Module. More... | |
IODPatientStudyModule & | getPatientStudy () |
Get Patient Study Module. More... | |
IODGeneralStudyModule & | getStudy () |
Get General Study Module. More... | |
IODGeneralEquipmentModule & | getEquipment () |
Get General Equipment Module. More... | |
IODGeneralSeriesModule & | getSeries () |
Get Series Module. More... | |
IODFoRModule & | getFrameOfReference () |
Get Frame of Reference Module. More... | |
IODSOPCommonModule & | getSOPCommon () |
Get SOP Common Module. More... | |
IODCommonInstanceReferenceModule & | getCommonInstanceReference () |
Get Common Instance Reference Module. More... | |
virtual | ~DcmIODCommon () |
Destructor. | |
virtual void | createNewStudy (const OFBool clearEquipment=OFTrue) |
Create new study. More... | |
virtual void | createNewSeries (const OFBool clearFoR=OFTrue) |
Create a new series. More... | |
virtual void | createNewSOPInstance () |
Create a new SOP instance. More... | |
virtual void | ensureInstanceUIDs (const OFBool correctInvalid=OFFalse) |
Make sure that the IOD contains a SOP Instance, Series Instance and Study Instance UID. More... | |
virtual OFCondition | importHierarchy (DcmItem &dataset, const OFBool readPatient, const OFBool readStudy, const OFBool readFoR=OFFalse, const OFBool readSeries=OFFalse, const OFBool takeOverCharset=OFTrue) |
Import common module attributes from dataset but only read Patient, Study, Series and/or Frame of Reference level portions. More... | |
virtual OFCondition | importHierarchy (const OFString &filename, const OFBool readPatient, const OFBool readStudy, const OFBool readFoR=OFFalse, const OFBool readSeries=OFFalse, const OFBool takeOverCharset=OFTrue) |
CAUTION: Parameter order (readFoR and readSeries) changed compared to the old import() function. More... | |
Static Public Member Functions | |
static OFCondition | create (const ContentIdentificationMacro &contentIdentification, const OFString &contentDate, const OFString &contentTime, const IODEnhGeneralEquipmentModule::EquipmentInfo &equipment, const IODReferences &imageReferences, TrcTractographyResults *&result) |
Create new Tractography Results object. More... | |
static OFCondition | loadFile (const OFString &filename, TrcTractographyResults *&tractography) |
Load Tractography Results object from a file. More... | |
static OFCondition | loadDataset (DcmDataset &dataset, TrcTractographyResults *&tractography) |
Load Tractography Results object from dataset object. More... | |
Protected Member Functions | |
TrcTractographyResults () | |
Protected default constructor. More... | |
virtual OFCondition | read (DcmItem &dataset) |
Overwrites DcmIODCommon::read() More... | |
virtual OFCondition | write (DcmItem &dataset) |
Overwrites DcmIODCommon::write() More... | |
virtual void | initIODRules () |
Initialize IOD rules. | |
Private Member Functions | |
void | clearData () |
Clear old data. | |
OFBool | check () |
Check whether Tractography Results object is ready for writing. More... | |
Static Private Member Functions | |
static OFCondition | loadFile (DcmFileFormat &dcmff, const OFString &filename, DcmDataset *&dset) |
Loads file. More... | |
Private Attributes | |
IODEnhGeneralEquipmentModule | m_EnhancedGeneralEquipmentModule |
Enhanced General Equipment Module. | |
TrcTractographyResultsModule | m_TractographyResultsModule |
Tractography Results Module. | |
IODReferences | m_References |
References used when creating Tractography Results objects. More... | |
Class representing an object of the "Tractography Results" object IOD.
|
protected |
Protected default constructor.
Library users should the factory create..() method in order to create an object from scratch
|
virtual |
Add Track Set to object.
If successful, the resulting Track Set can be filled by calling addTrack() (and other methods) on it.
trackSetLabel | Label for this Track Set with a maximum of 256 characters (VR = LO) |
trackSetDescription | Text description for this Track Set with a maximum of 2^32-2 bytes (VR = UT). |
anatomyCode | Code describing the anatomy covered by the Track Set. DICOM proposes a code from CID 7710 "Tractography Anatomic Sites" (Baseline). Laterality can be set later on the resulting Track Set. |
diffusionModelCode | Code describing the diffusion model this Track Set is based on. DICOM proposes a code from CID 7261 "Diffusion Model Value Types" |
algoIdentCode | Code describing the algorithm identification. DICOM prescribes code from CID 7262 "Diffusion Tractography Algorithm Families". A trackset can contain more than one algorithm description. If you want to add more than one description macro, use getTrackSets()->getTrackingAlgorithmIdentification() and add as many as needed to the returned vector. |
trackSet | Returns the resulting Track Set if successful, NULL otherwise. |
|
private |
Check whether Tractography Results object is ready for writing.
|
static |
Create new Tractography Results object.
The resulting object then can be filled by using addTrackSet(). The memory of the resulting Tractography Results object has to be freed by the caller.
contentIdentification | Content identification for this object |
contentDate | The date the content creation started |
contentTime | The time the content creation started |
equipment | Equipment used to produce this object |
imageReferences | References to images that played a role when creating this object. Usually these are MR images that were used to compute the tracks in this object. |
result | Returns the created object if successful, otherwise NULL |
|
virtual |
Get Content Date (from Tractography Results Module)
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 |
Return reference to content identification of this Tractography Results object (from Tractography Results Module)
|
virtual |
Get Content Time (from Tractography Results Module)
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 reference to Equipment information.
|
inlinevirtual |
Get Modality (overwrite from DcmIODCommon.
DICOM enforces "MR" for Tractography Result objects, and thus it is always returned.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get. Not evaluated (here for consistency with other setter functions). |
References EC_Normal.
|
virtual |
Returns number of Track Sets in Tractography Results object.
|
virtual |
Get referenced instances (from Tractography Results Module)
|
virtual |
Return Track Sets (from Tractography Results Module)
|
virtual |
CAUTION: Parameter order (readFoR and readSeries) changed, and there is a new parameter "takeOverCharset" which per default takes over the charset from the given source file! Take over general information for Patient, Study, Series and/or Frame of Reference from existing file.
filename | The filename to read from |
readPatient | If OFTrue, Patient level information is imported |
readStudy | If OFTrue, Study level information is imported |
readFoR | If OFTrue, Frame of Reference information is imported |
readSeries | If OFTrue, Series level information is imported; if OFTrue, readFoR is also set to OFTrue. |
updateCommonInstanceReferences | If OFTrue (default), all references in the Common Instance Reference Module will be updated using the reference data provided earlier in the create() call. The reason is that the study and series information (including UIDs) are likely to change during this call, which requires another sorting of references inside the Common Instance Reference module. |
takeOverCharset | If OFTrue (default), Specific Character Set is taken over from imported dataset. If it's not present or empty (invalid), the attribute will not be present in this class either. |
|
static |
Load Tractography Results object from dataset object.
The memory of the resulting Tractography Results object has to be freed by the caller.
dataset | The dataset to read from |
tractography | The resulting Tractography Results object. NULL if dataset could not be read successfully. |
|
static |
Load Tractography Results object from a file.
The memory of the resulting Tractography Results object has to be freed by the caller.
filename | The file to read from |
tractography | The resulting Tractography Results object. NULL if dataset could not be read successfully. |
|
staticprivate |
Loads file.
dcmff | The file format to load into |
filename | The filename of the file to load |
dset | Pointer to dataset after loading |
|
protectedvirtual |
Overwrites DcmIODCommon::read()
dataset | The dataset to read from |
Reimplemented from DcmIODCommon.
|
virtual |
Save current object to given filename.
filename | The file to write to |
writeXfer | The transfer syntax to be used |
|
protectedvirtual |
Overwrites DcmIODCommon::write()
dataset | The dataset to write to |
Reimplemented from DcmIODCommon.
|
virtual |
Write current object to given item.
dataset | The item to write to |
|
private |
References used when creating Tractography Results objects.
When calling create() in order to create a Tractography Results object, the references provided in the call are used to initialize those in the Common Instance Reference Module as well as the Tractography Results module's Referenced Instance Sequence. However, in the case of Common Instance Reference, the internal reference structure is distinguishes between reference within the same study as "this" object as well as other objects outside this study. If the user calls later importHierarchy() after creation, the study is most likely to change (away from the automatically created new study when calling create() to the imported study information) which requires to re-build the Common Instance Refernence Module's references. Thus, this member is used to store store the references provided by create() for this use case.