mlSMFTreeTools.h File Reference

Tool functions for structured multi-frame trees (SMFTrees). More...

#include "MLDICOMTagsSystem.h"
#include <mlUtilsSystem.h>
#include "mlZTUIndex.h"
#include <DCMTree_Lib.h>

Go to the source code of this file.

Namespaces
namespace	ml
	Main documentation file for ML users and developers.
namespace	ml::DICOMTagTools
	A namespace collecting tools related to DICOM tags and tree tools.

Functions
MLDICOMTags_EXPORT void	ml::DICOMTagTools::getSMFTreeZTUExtent (const DCMTree::StructuredMFPtr smfTree, ZTUIndex &ztu)
	Get extent of the MeVis Structured Multi Frame set of the smfTree in ztu.
MLDICOMTags_EXPORT void	ml::DICOMTagTools::getSMFTreeZTUExtent (const DCMTree::Const_StructuredMFPtr smfTree, ZTUIndex &ztu)
	Get extent of the constanVis Structured Multi Frame set of the constant smfTree in ztu.
MLDICOMTags_EXPORT void	ml::DICOMTagTools::getSMFTreeZTUExtent (DCMTree::TreePtr dcmTree, ZTUIndex &ztu)
	Get extent of the MeVis Structured Multi Frame set of the dcmTree in ztu.
MLDICOMTags_EXPORT void	ml::DICOMTagTools::getSMFTreeZTUExtent (DCMTree::Const_TreePtr dcmTree, ZTUIndex &ztu)
	Get extent of the MeVis Structured Multi Frame set of the constant dcmTree in ztu.
MLDICOMTags_EXPORT DCMTree::Const_StructuredMFPtr	ml::DICOMTagTools::convertDCMToSMFTree (DCMTree::Const_TreePtr dcmTree)
	Convert dcmTree to the returned StructuredSMFTree if possible or throws and DCMtree::Exception.
MLDICOMTags_EXPORT void	ml::DICOMTagTools::extractAllSMFFramesAsDeepCopies (DCMTree::Const_StructuredMFPtr inputSMFTree, std::vector< DCMTree::Const_TreePtr > &frameSet)
	Retrieves all frame trees of the input SMFTree as deep-copies and returns their pointers in frameSet.
MLDICOMTags_EXPORT DCMTree::TreePtr	ml::DICOMTagTools::getSMFTreeFrameTreeAtZTU (DCMTree::Const_StructuredMFPtr smfTree, const ZTUIndex &ztu)
	Returns a deep-copy of DCMTree at frame position (z,t,u) from constant smfTree if it exists or nullptr if not; constant version for non-copied returned tree is not supported in DCMTree::StructuredMF class and is therefore not available here, see also extractAllSMFFramesAsDeepCopy();.
MLDICOMTags_EXPORT DCMTree::TreePtr	ml::DICOMTagTools::getSMFTreeFrameTreeAtZTU (DCMTree::StructuredMFPtr smfTree, const ZTUIndex &ztu)
	Returns the DCMTree at frame position (z,t,u) from non-constant smfTree if it exists or nullptr if not; constant version for non-deep-copied returned tree is not supported in DCMTree::StructuredMF class and is therefore not available here, see also extractAllSMFFramesAsDeepCopy().
MLDICOMTags_EXPORT DCMTree::TreePtr	ml::DICOMTagTools::getSMFTreeFrameTreeAtZTU (DCMTree::TreePtr dcmTree, const ZTUIndex &ztu)
	Returns the DCMTree at frame position (z,t,u) from non-constant dcmTree if it exists or nullptr if not; constant version is not supported in DCMTree::StructuredMF class and is therefore not available here.
MLDICOMTags_EXPORT std::vector< DCMTree::TreePtr >	ml::DICOMTagTools::getIndexedNormalSequenceSubTrees (const DCMTree::TreePtr &parentTree, const std::string &tagIdString, const std::string &sequenceEntriesString, DICOMTagTools::ZTUVector *ztuIndexes=nullptr, bool alsoGetNULLTrees=false)
	Returns a vector of all DCMTree::TreePtrs indexed by sequenceEntriesString and taken from the sequence tag defined by tagIdString.
MLDICOMTags_EXPORT std::vector< DCMTree::TreePtr >	ml::DICOMTagTools::getSMFSubTreeFramesAtZTUTriplePositions (const DCMTree::TreePtr &parentTree, const std::vector< MLuint32 > &ztuTriples, DICOMTagTools::ZTUVector *ztuIndexes=nullptr)
	Builds ztuTriples.size()/3 triples from the indexes in the ztuTriples and returns a vector of all DCMTree::TreePtrs at the triple positions of the MeVis SMF subtrees of parentTree if there is any.
MLDICOMTags_EXPORT std::vector< DCMTree::TreePtr >	ml::DICOMTagTools::getSMFSubTreeZTUFrameSlices (const DCMTree::TreePtr &parentTree, const std::string &zSlicesEntriesList, const std::string &tSlicesEntriesList, const std::string &uSlicesEntriesList, DICOMTagTools::ZTUVector *ztuIndexes=nullptr)
	Returns a vector of DCMTree::TreePtrs of all MeVis SMF subtrees which are described by the combinations of all indexes in the fields [z|t|u]SlicesEntriesList.

Detailed Description

Tool functions for structured multi-frame trees (SMFTrees).

Author

Wolf Spindler

Date

2014-07-08

Definition in file mlSMFTreeTools.h.