Small container storing and validating all input and result parameters needed to copy data from a DCMTree given by a DICOMCachedIOFileHandle into a SubImage. More...

#include <mlDicomToMLSubImageCopyParameters.h>

Public Member Functions
	DICOMPixelReadAndCopyParameters (const DICOMCachedIOFileHandle &dcmFileHandleIn, DCMTree::Const_TreePtr alternativeDCMTreeIn, const bool allowMemoryCompatibleColorModelsIn, SubImage &outSubImgIn, DicomMessageCollector &dcmMsgCollectorIn)
	Checks input parameters and validates results.isValid to true member if multi-frame parameters are usable, otherwise to false.

Public Attributes
MLDICOMCachedIOProxies	cacheProxies
	Prevents automatic cache removals during life time of this.

const DICOMCachedIOFileHandle &	dcmFileHandle
	The handle describing the file or URL from which the DICOM information/tree shall be read.

DCMTree::Const_TreePtr	alternativeDCMTree
	For the case that no DICOMCachedIOFileHandle exists, because the DCMTree is only in memory, then the tree can be specified directly here.

const bool	allowMemoryCompatibleColorModels
	If true then some more color models are allowed whose data formats are compatible but which are not correctly displayed.

SubImage &	outSubImg
	Destination SubImage to be filled with data from the multi-frame pixel tag from dcmTree.

DicomMessageCollector &	dcmMsgCollector
	Collects error, info and issue messages (typically related to a handle).

const DICOMPixelReadAndCopyParameterResults	results
	Set of parameters allowing copying from results settings to outSubImg if results.errCode==ML_RESULT_OK, otherwise copying is not possible and further result parameters are invalid.

std::vector< boost::shared_array< unsigned char > >	fileNameFreeFrameDataCache
	A multi-frame pixel data cache for cases where we do not have a file handle and therefore we cannot use to global singleton cache.

Detailed Description

Small container storing and validating all input and result parameters needed to copy data from a DCMTree given by a DICOMCachedIOFileHandle into a SubImage.

Definition at line 68 of file mlDicomToMLSubImageCopyParameters.h.

Constructor & Destructor Documentation

◆ DICOMPixelReadAndCopyParameters()

ml::DicomToMLTools::DICOMPixelReadAndCopyParameters::DICOMPixelReadAndCopyParameters	(	const DICOMCachedIOFileHandle &	dcmFileHandleIn,
		DCMTree::Const_TreePtr	alternativeDCMTreeIn,
		const bool	allowMemoryCompatibleColorModelsIn,
		SubImage &	outSubImgIn,
		DicomMessageCollector &	dcmMsgCollectorIn )

inline

Checks input parameters and validates results.isValid to true member if multi-frame parameters are usable, otherwise to false.

Definition at line 73 of file mlDicomToMLSubImageCopyParameters.h.

Member Data Documentation

◆ allowMemoryCompatibleColorModels

const bool ml::DicomToMLTools::DICOMPixelReadAndCopyParameters::allowMemoryCompatibleColorModels

If true then some more color models are allowed whose data formats are compatible but which are not correctly displayed.

Definition at line 100 of file mlDicomToMLSubImageCopyParameters.h.

◆ alternativeDCMTree

DCMTree::Const_TreePtr ml::DicomToMLTools::DICOMPixelReadAndCopyParameters::alternativeDCMTree

For the case that no DICOMCachedIOFileHandle exists, because the DCMTree is only in memory, then the tree can be specified directly here.

Definition at line 96 of file mlDicomToMLSubImageCopyParameters.h.

◆ cacheProxies

MLDICOMCachedIOProxies ml::DicomToMLTools::DICOMPixelReadAndCopyParameters::cacheProxies

Prevents automatic cache removals during life time of this.

Definition at line 89 of file mlDicomToMLSubImageCopyParameters.h.

◆ dcmFileHandle

const DICOMCachedIOFileHandle& ml::DicomToMLTools::DICOMPixelReadAndCopyParameters::dcmFileHandle

The handle describing the file or URL from which the DICOM information/tree shall be read.

Definition at line 92 of file mlDicomToMLSubImageCopyParameters.h.

◆ dcmMsgCollector

DicomMessageCollector& ml::DicomToMLTools::DICOMPixelReadAndCopyParameters::dcmMsgCollector

Collects error, info and issue messages (typically related to a handle).

Definition at line 106 of file mlDicomToMLSubImageCopyParameters.h.

◆ fileNameFreeFrameDataCache

std::vector<boost::shared_array<unsigned char> > ml::DicomToMLTools::DICOMPixelReadAndCopyParameters::fileNameFreeFrameDataCache

A multi-frame pixel data cache for cases where we do not have a file handle and therefore we cannot use to global singleton cache.

Definition at line 115 of file mlDicomToMLSubImageCopyParameters.h.

◆ outSubImg

SubImage& ml::DicomToMLTools::DICOMPixelReadAndCopyParameters::outSubImg

Destination SubImage to be filled with data from the multi-frame pixel tag from dcmTree.

Definition at line 103 of file mlDicomToMLSubImageCopyParameters.h.

◆ results

const DICOMPixelReadAndCopyParameterResults ml::DicomToMLTools::DICOMPixelReadAndCopyParameters::results

Set of parameters allowing copying from results settings to outSubImg if results.errCode==ML_RESULT_OK, otherwise copying is not possible and further result parameters are invalid.

Definition at line 111 of file mlDicomToMLSubImageCopyParameters.h.

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

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

Public Member Functions

Public Attributes