Some dedicated parameters for advanced tag setups when setting pixel data and related tags in DICOM files. More...

#include <mlMLToDicomTagSetUpArguments.h>

Public Types
enum	MapDimensionToFrameIncrement { DoNotModifyIndexVectors = 0 , EnergyWindowVector , DetectorVector , PhaseVector , RotationVector , RRIntervalVector , TimeSlotVector , SliceVector , AngularViewVector , TimeSliceVector , NumMapDimensionToFrameIncrementStrings }
	An enumerator describing how an ML dimension shall be mapped onto an NM tag vector. More...

enum	ImageTypeForFrameIncrementPointer { DoNotModifyImageType = 0 , Static , WholeBody , Dynamic , Gated , Tomo , GatedTomo , ReconTomo , ReconGatedTomo , NumImageTypeForFrameIncrementPointerStrings }
	Image Type(0008,0008), Value 3, see Table C.8-8 of C.8.4.8.1 NM Multi-Frame Attribute Descriptions in DICOM standard. More...

typedef std::map< DCMTree::RawTagId, std::string >	IndexVectorLookUpMap
	A map which assigns index vector strings (separated by backslashes between indexes) to their corresponding raw tag ids. More...

typedef std::vector< DCMTree::RawTagId >	RawIdVector
	An std::vector of DCMTree::RawID items. More...

Public Member Functions
	AdvancedTagSetUpArgs ()
	Default constructor for a defined member initialization. More...

void	adjustNMModalityImageTags (DCMTree::TreePtr dcmTree, const ImageVector &newImageExtents, std::string &issues)
	Modifies NM modality tags related to image extents. More...

Public Attributes
bool	skipOutrangedTSlices
	If true and if the t component in the Vector6Field named "framePosition" is outside the inImg.getExtent().t then the returned SubImageBox is returned empty. More...

bool	skipOutrangedUSlices
	If true and if the u component in the Vector6Field named "framePosition" is outside the inImg.getExtent().u then the returned SubImageBox is returned empty. More...

int	originalNumberOfFrames
	If < 0 then it is expected that adjustNMModalityImageTags determines the NumberOfFrames value from incoming dcmTree; otherwise the value of originalNumberOfFrames (for example if the tag was removed from dcmTree before calling adjustNMModalityImageTags). More...

std::string	originalImageTypeValue3
	If empty then it is expected that adjustNMModalityImageTags determines the value 3 of the ImageType tag from incoming dcmTree; otherwise the value of originalImageTypeValue3 (for example if the tag was removed from dcmTree before calling adjustNMModalityImageTags). More...

ImageTypeForFrameIncrementPointer	imageTypeValue3
	Determines to which DICOM index vector the z-extent is mapped. More...

MapDimensionToFrameIncrement	zDimToIndexVector
	Determines to which DICOM index vector the z-extent is mapped. More...

MapDimensionToFrameIncrement	tDimToIndexVector
	Determines to which DICOM index vector the t-extent is mapped. More...

MapDimensionToFrameIncrement	uDimToIndexVector
	Determines to which DICOM index vector the u-extent is mapped. More...

Static Public Attributes
static const char *const	MapDimensionToFrameIncrementStrings [NumMapDimensionToFrameIncrementStrings]
	Strings corresponding to valid mode enumerators. More...

static const char *const	ImageTypeForFrameIncrementPointerStrings [NumImageTypeForFrameIncrementPointerStrings]
	Strings corresponding to valid mode enumerators. More...

Detailed Description

Some dedicated parameters for advanced tag setups when setting pixel data and related tags in DICOM files.

Container for a number of arguments controlling translation of more complex tag configurations to corresponding appropriate ML configurations (typically for NM DICOM data).

Definition at line 31 of file mlMLToDicomTagSetUpArguments.h.

Member Typedef Documentation

◆ IndexVectorLookUpMap

typedef std::map<DCMTree::RawTagId, std::string> ml::MLToDicomTools::AdvancedTagSetUpArgs::IndexVectorLookUpMap

A map which assigns index vector strings (separated by backslashes between indexes) to their corresponding raw tag ids.

Definition at line 53 of file mlMLToDicomTagSetUpArguments.h.

◆ RawIdVector

typedef std::vector<DCMTree::RawTagId> ml::MLToDicomTools::AdvancedTagSetUpArgs::RawIdVector

An std::vector of DCMTree::RawID items.

Definition at line 56 of file mlMLToDicomTagSetUpArguments.h.

Member Enumeration Documentation

◆ ImageTypeForFrameIncrementPointer

enum ml::MLToDicomTools::AdvancedTagSetUpArgs::ImageTypeForFrameIncrementPointer

Image Type(0008,0008), Value 3, see Table C.8-8 of C.8.4.8.1 NM Multi-Frame Attribute Descriptions in DICOM standard.

Enumerator
DoNotModifyImageType
Static
WholeBody
Dynamic
Gated
Tomo
GatedTomo
ReconTomo
ReconGatedTomo
NumImageTypeForFrameIncrementPointerStrings	No mode but the number of available modes.

Definition at line 63 of file mlMLToDicomTagSetUpArguments.h.

◆ MapDimensionToFrameIncrement

enum ml::MLToDicomTools::AdvancedTagSetUpArgs::MapDimensionToFrameIncrement

An enumerator describing how an ML dimension shall be mapped onto an NM tag vector.

Enumerator
DoNotModifyIndexVectors	The ML image dimension is not mapped to any index vector.
EnergyWindowVector
DetectorVector
PhaseVector
RotationVector
RRIntervalVector
TimeSlotVector
SliceVector
AngularViewVector
TimeSliceVector
NumMapDimensionToFrameIncrementStrings	No mode but the number of available modes.

Definition at line 36 of file mlMLToDicomTagSetUpArguments.h.

Constructor & Destructor Documentation

◆ AdvancedTagSetUpArgs()

ml::MLToDicomTools::AdvancedTagSetUpArgs::AdvancedTagSetUpArgs ( )

Default constructor for a defined member initialization.

Member Function Documentation

◆ adjustNMModalityImageTags()

void ml::MLToDicomTools::AdvancedTagSetUpArgs::adjustNMModalityImageTags	(	DCMTree::TreePtr	dcmTree,
		const ImageVector &	newImageExtents,
		std::string &	issues
	)

Modifies NM modality tags related to image extents.

Parameters

dcmTree	The DICOM tree to be modified.
newImageExtents	The extent of the NM image pixel data tags to be set.
issues	Unchanged on successful operation of if dcmTree is not of NM modality type; on failures or problems a report string is appended to issues.

Member Data Documentation

◆ ImageTypeForFrameIncrementPointerStrings

const char* const ml::MLToDicomTools::AdvancedTagSetUpArgs::ImageTypeForFrameIncrementPointerStrings[NumImageTypeForFrameIncrementPointerStrings]

static

Strings corresponding to valid mode enumerators.

Definition at line 78 of file mlMLToDicomTagSetUpArguments.h.

◆ imageTypeValue3

ImageTypeForFrameIncrementPointer ml::MLToDicomTools::AdvancedTagSetUpArgs::imageTypeValue3

Determines to which DICOM index vector the z-extent is mapped.

Definition at line 114 of file mlMLToDicomTagSetUpArguments.h.

◆ MapDimensionToFrameIncrementStrings

const char* const ml::MLToDicomTools::AdvancedTagSetUpArgs::MapDimensionToFrameIncrementStrings[NumMapDimensionToFrameIncrementStrings]

static

Strings corresponding to valid mode enumerators.

Definition at line 59 of file mlMLToDicomTagSetUpArguments.h.

◆ originalImageTypeValue3

std::string ml::MLToDicomTools::AdvancedTagSetUpArgs::originalImageTypeValue3

If empty then it is expected that adjustNMModalityImageTags determines the value 3 of the ImageType tag from incoming dcmTree; otherwise the value of originalImageTypeValue3 (for example if the tag was removed from dcmTree before calling adjustNMModalityImageTags).

Definition at line 111 of file mlMLToDicomTagSetUpArguments.h.

◆ originalNumberOfFrames

int ml::MLToDicomTools::AdvancedTagSetUpArgs::originalNumberOfFrames

If < 0 then it is expected that adjustNMModalityImageTags determines the NumberOfFrames value from incoming dcmTree; otherwise the value of originalNumberOfFrames (for example if the tag was removed from dcmTree before calling adjustNMModalityImageTags).

Definition at line 105 of file mlMLToDicomTagSetUpArguments.h.

◆ skipOutrangedTSlices

bool ml::MLToDicomTools::AdvancedTagSetUpArgs::skipOutrangedTSlices

If true and if the t component in the Vector6Field named "framePosition" is outside the inImg.getExtent().t then the returned SubImageBox is returned empty.

Definition at line 95 of file mlMLToDicomTagSetUpArguments.h.

◆ skipOutrangedUSlices

bool ml::MLToDicomTools::AdvancedTagSetUpArgs::skipOutrangedUSlices

If true and if the u component in the Vector6Field named "framePosition" is outside the inImg.getExtent().u then the returned SubImageBox is returned empty.

Definition at line 99 of file mlMLToDicomTagSetUpArguments.h.

◆ tDimToIndexVector

MapDimensionToFrameIncrement ml::MLToDicomTools::AdvancedTagSetUpArgs::tDimToIndexVector

Determines to which DICOM index vector the t-extent is mapped.

Definition at line 120 of file mlMLToDicomTagSetUpArguments.h.

◆ uDimToIndexVector

MapDimensionToFrameIncrement ml::MLToDicomTools::AdvancedTagSetUpArgs::uDimToIndexVector

Determines to which DICOM index vector the u-extent is mapped.

Definition at line 123 of file mlMLToDicomTagSetUpArguments.h.

◆ zDimToIndexVector

MapDimensionToFrameIncrement ml::MLToDicomTools::AdvancedTagSetUpArgs::zDimToIndexVector