mlDicomFrameSelectionTools.h File Reference

Header file of tool functions for the extraction and handling of information of specific DICOM frames. More...

#include "MLDicomToMLToolsSystem.h"
#include <mlModuleIncludes.h>
#include <DCMTree_Lib.h>

Go to the source code of this file.

Classes
struct	ml::DicomToMLTools::FrameSpecificTags
	Helper structure to store a z, t, u position of a frame in a structured multi-frame tree, and a tag belonging to that frame. More...
struct	ml::DicomToMLTools::PositionSpecificDouble
	Helper structure to store a z, t, u position with an associated double value. More...

Namespaces
namespace	ml
	Main documentation file for ML users and developers.
namespace	ml::DicomToMLTools
	Tool functions for the extraction and handling of information of specific DICOM frames.

Typedefs
typedef std::vector< FrameSpecificTags >	ml::DicomToMLTools::FrameSpecificTagsVector
	Often used std::vector type of FrameSpecificTag elements.
typedef std::vector< PositionSpecificDouble >	ml::DicomToMLTools::PositionSpecificDoubleVector
	Often used std::vector type of PositionSpecificDouble elements.

Enumerations
enum	ml::DicomToMLTools::VoxelDoubleOperations { ml::DicomToMLTools::Copy = 0 , ml::DicomToMLTools::Add , ml::DicomToMLTools::Multiply }
	Defines some modes how a (voxel) value can be manipulated with a double value. More...
enum	{ ml::DicomToMLTools::NumberOfVoxelDoubleOperations = Multiply + 1 }
	Number of available VoxelDoubleOperations. More...

Functions
MLDICOM_TO_ML_TOOLS_EXPORT FrameSpecificTagsVector	ml::DicomToMLTools::getFrameSpecificTagSet (const DCMTree::Const_StructuredMFPtr &smfTree, const std::vector< DCMTree::RawTagId > &tagIds)
	Returns an entry for each frame and each tag id from tagIds in which any tagId can be found and store the corresponding z, t, and u location in the entry as well as the found pointer to the tag.
MLDICOM_TO_ML_TOOLS_EXPORT FrameSpecificTagsVector	ml::DicomToMLTools::getFrameSpecificTags (const DCMTree::Const_StructuredMFPtr &smfTree, DCMTree::RawTagId tagId)
	Returns an entry for each frame in which a tag with id tagId can be found and store the corresponding z, t, and u location in the entry as well as the found pointer to the tag.
MLDICOM_TO_ML_TOOLS_EXPORT size_t	ml::DicomToMLTools::convertToFrameSpecificDoubles (const FrameSpecificTagsVector &frameSpecificTags, PositionSpecificDoubleVector &frameSpecificDoubles)
	Converts first entries of each entries in FrameSpecificTagsVector to a PositionSpecificDoubleVector object.
MLDICOM_TO_ML_TOOLS_EXPORT bool	ml::DicomToMLTools::applyFrameSpecificOperation (const VoxelDoubleOperations &operationMode, const SubImage &srcSubImage, SubImage &dstSubImage, const PositionSpecificDoubleVector &positionDoubles, const VoxelDoubleOperations dummyOperationMode=Copy, const MLdouble dummyOperationValue=0.0, PositionSpecificDoubleVector *valueFreePositions=nullptr, bool isOldMultiFrameDICOM=false)
	Copy voxels from overlapping regions of srcSubImage to dstSubImage and apply the operationMode if for the z, t, u position of the slice an entry can be found in positionDoubles whose double value can be used for modification.
MLDICOM_TO_ML_TOOLS_EXPORT const FrameSpecificTags *	ml::DicomToMLTools::getFrameSpecificTagsSet (const FrameSpecificTagsVector &tagSet, MLint z, MLint t, MLint u)
	Returns pointer to the first occurrence of a FrameSpecificTags entry which has the given z, t, and u positions or nullptr if not found.
MLDICOM_TO_ML_TOOLS_EXPORT bool	ml::DicomToMLTools::isVolumeCovered (const PositionSpecificDoubleVector &positions, const SubImageBox &volume)
	Returns true if the (z,t,u) positions in positions cover all (z,t,u) slices in volume, otherwise false is returned.
MLDICOM_TO_ML_TOOLS_EXPORT bool	ml::DicomToMLTools::getPositionSpecificDoubleProperties (const PositionSpecificDoubleVector &positions, double &rangeMin, double &rangeMax, bool &hasFractionalParts)
	Returns some properties of the double values in valuePositions, the minimum / maximum range, and whether any value is a non integer one.

Variables
MLDICOM_TO_ML_TOOLS_EXPORT const char *const	ml::DicomToMLTools::VoxelDoubleOperationsStrings [NumberOfVoxelDoubleOperations]
	Strings according to VoxelDoubleOperations.

Detailed Description

Header file of tool functions for the extraction and handling of information of specific DICOM frames.

Author

Wolf Spindler

Date

2013-11-29

Definition in file mlDicomFrameSelectionTools.h.