Container storing parameters needed to copy data from DICOM pixel data into a SubImage. More...

#include <mlDicomToMLSubImageCopyParameters.h>

Public Attributes
DCMTree::Const_TreePtr	dcmTree
	The dcmTree loaded from the file handle and whose pixel tag contents shall be copied to outSubImg.

DCMTree::PixelData	pixelData
	Pointer to normal 2D pixel data in dcmTree, if available, otherwise nullptr.

bool	pixelDataIsAFrameFromMFCache
	If true then the data in pixelData is read from a multi-frame cache and not from a normal DCMTree; this does not mean that mfPixelDataTag will be set!

const DCMTree::MFPixelTag *	mfPixelDataTag
	The multi-frame pixel data tag from dcmTree, if available, which the data shall be copied into outSubImg.

MLDataType	srcPixelDataType
	ML voxel data type of the pixelData or in mfPixelDataTag if available, otherwise ML_INVALID_DATA_TYPE.

bool	isInterleaved
	Describes whether color channel data is packed interleaved as RGB RGB RGB or separated RRR ... GGG ... BBB.

bool	isDICOMBitImg
	True if pixel data is of packed bit image data for example in SEG modality data.

MLint	timeUnrollSteps
	Number of steps to do if frames located after another shall be copied into the ML time dimension.

size_t	dimIdx
	Dimension into which the frames are written, for example 2 for Z, 4 for time, 5 for u.

SubImageBox	readFrameBox
	The SubImageBox region in outSubImage where the first frame shall be copied to.

ImageVector	frameShift
	Shift vector to move readFrameBox between copy of frame n and frame n+1.

MLErrorCode	errorCode
	ML_RESULT_OK if data copying is possible, otherwise an error code describing the reason why not.

Detailed Description

Container storing parameters needed to copy data from DICOM pixel data into a SubImage.

Definition at line 36 of file mlDicomToMLSubImageCopyParameters.h.

Member Data Documentation

◆ dcmTree

DCMTree::Const_TreePtr ml::DicomToMLTools::DICOMPixelReadAndCopyParameterResults::dcmTree

The dcmTree loaded from the file handle and whose pixel tag contents shall be copied to outSubImg.

Definition at line 38 of file mlDicomToMLSubImageCopyParameters.h.

◆ dimIdx

size_t ml::DicomToMLTools::DICOMPixelReadAndCopyParameterResults::dimIdx

Dimension into which the frames are written, for example 2 for Z, 4 for time, 5 for u.

Definition at line 55 of file mlDicomToMLSubImageCopyParameters.h.

◆ errorCode

MLErrorCode ml::DicomToMLTools::DICOMPixelReadAndCopyParameterResults::errorCode

ML_RESULT_OK if data copying is possible, otherwise an error code describing the reason why not.

Definition at line 61 of file mlDicomToMLSubImageCopyParameters.h.

◆ frameShift

ImageVector ml::DicomToMLTools::DICOMPixelReadAndCopyParameterResults::frameShift

Shift vector to move readFrameBox between copy of frame n and frame n+1.

Definition at line 59 of file mlDicomToMLSubImageCopyParameters.h.

◆ isDICOMBitImg

bool ml::DicomToMLTools::DICOMPixelReadAndCopyParameterResults::isDICOMBitImg

True if pixel data is of packed bit image data for example in SEG modality data.

Definition at line 51 of file mlDicomToMLSubImageCopyParameters.h.

◆ isInterleaved

bool ml::DicomToMLTools::DICOMPixelReadAndCopyParameterResults::isInterleaved

Describes whether color channel data is packed interleaved as RGB RGB RGB or separated RRR ... GGG ... BBB.

Definition at line 49 of file mlDicomToMLSubImageCopyParameters.h.

◆ mfPixelDataTag

const DCMTree::MFPixelTag* ml::DicomToMLTools::DICOMPixelReadAndCopyParameterResults::mfPixelDataTag

The multi-frame pixel data tag from dcmTree, if available, which the data shall be copied into outSubImg.

Definition at line 45 of file mlDicomToMLSubImageCopyParameters.h.

◆ pixelData

DCMTree::PixelData ml::DicomToMLTools::DICOMPixelReadAndCopyParameterResults::pixelData

Pointer to normal 2D pixel data in dcmTree, if available, otherwise nullptr.

Definition at line 40 of file mlDicomToMLSubImageCopyParameters.h.

◆ pixelDataIsAFrameFromMFCache

bool ml::DicomToMLTools::DICOMPixelReadAndCopyParameterResults::pixelDataIsAFrameFromMFCache

If true then the data in pixelData is read from a multi-frame cache and not from a normal DCMTree; this does not mean that mfPixelDataTag will be set!

Definition at line 43 of file mlDicomToMLSubImageCopyParameters.h.

◆ readFrameBox

SubImageBox ml::DicomToMLTools::DICOMPixelReadAndCopyParameterResults::readFrameBox

The SubImageBox region in outSubImage where the first frame shall be copied to.

Definition at line 57 of file mlDicomToMLSubImageCopyParameters.h.

◆ srcPixelDataType

MLDataType ml::DicomToMLTools::DICOMPixelReadAndCopyParameterResults::srcPixelDataType

ML voxel data type of the pixelData or in mfPixelDataTag if available, otherwise ML_INVALID_DATA_TYPE.

Definition at line 47 of file mlDicomToMLSubImageCopyParameters.h.

◆ timeUnrollSteps

MLint ml::DicomToMLTools::DICOMPixelReadAndCopyParameterResults::timeUnrollSteps

Number of steps to do if frames located after another shall be copied into the ML time dimension.

Definition at line 53 of file mlDicomToMLSubImageCopyParameters.h.

The documentation for this struct was generated from the following file:

FMEstable/ReleaseMeVis/Projects/DICOM/MLDicomToMLTools/Sources/mlDicomToMLSubImageCopyParameters.h

Public Attributes