Container for all parameters needed to convert a DPL::Image to MultiFileVolume(s). More...

#include <mlImageToMultiFileVolumeConversionParameters.h>

Public Member Functions
	ImageToMultiFileVolumeConversionParameters ()
	Set up the default values; dcmMsgCollector is automatically created.

	ImageToMultiFileVolumeConversionParameters (DicomConfigurableMessageFilterBaseRefCountedPtr dcmMsgCollectorPtr)
	Set up the default values; dcmMsgCollectorPtr is not allowed to be nullptr.

Public Attributes
float	startPercentage = 0.5f
	The percentage value of the progress bar which is updated when this method starts (for example to 0.3).

float	percentageRange = 0.5f
	The range incrementally stepped through while this method is executed, for example 0.5.

bool	usedDPLAnon = false
	If enabled the DPL will anonymize the created output DICOM tree, otherwise not.

bool	usedDPLremovePrivateMFSQTag = false
	If true then the sequence tag with private multi-frame tag information will be removed from created multi-frame tree before appending it to the image properties, otherwise it will normally be appended (the default).

bool	usedDPLforceOrthogonalWorldMatrix = false
	If enabled then the world matrix is always determined from the first ImageOrientationPatient of the first frame in frame set, otherwise from the first two slices and the difference between first two ImagePositionPatient voxel; default is off.

bool	usedAllowMixedPixelTypes = false
	If enabled then the ML data type determined from the imported frame(s) is checked against the min/max values determined according to the _calcMinMaxDPLFld mode.

bool	usedDecomposeTo3DVolumes = false
	If enabled then volumes with a temporal extent are decomposed to multiple 3D volumes if these 3D volumes are build from different frame sets, otherwise, if false, volumes are composed in time dimension normally.

DicomToMLTools::CalculateMinMaxFromDicomModes	usedMinMaxScanMode = DicomToMLTools::CalculateMinMaxAutomatic
	Provides the mode how the min/max voxel values for images are calculated.

bool	processSetNGoSeries = false
	If enabled then a Siemens setNGo postprocessing is applied to created MultiFileVolumes.

bool	processSetNGoSeriesOnly = false
	If enabled then only Siemens setNGo series are created as result MultiFileVolumes, all others are dropped.

bool	copyPrivateTopLevelSourceTags = true
	If enabled then private tags from source frames are copied to created SMF trees, otherwise they are skipped.

bool	disableDCMTreeNormalization = false
	See DirectDicomImportDPLImporter._disableDCMTreeNormalizationFld for details.

bool	keepTopLevelOfDCMTreeNormalization = true
	See DirectDicomImportDPLImporter._keepTopLevelOfDCMTreeNormalizationFld for details.

bool	autoCreateMissingPrivateCreators = false
	See DirectDicomImportDPLImporter._autoCreateMissingPrivateCreatorsFld for details.

bool	doNotModifySMFTree = false
	See DirectDicomImportDPLImporter._doNotModifySMFTreeFld for details.

DicomConfigurableMessageFilterBaseRefCountedPtr	dcmMsgCollector
	The message collector to be used for importing if not nullptr.

Detailed Description

Container for all parameters needed to convert a DPL::Image to MultiFileVolume(s).

Definition at line 25 of file mlImageToMultiFileVolumeConversionParameters.h.

Constructor & Destructor Documentation

◆ ImageToMultiFileVolumeConversionParameters() [1/2]

ml::ImageToMultiFileVolumeConversionParameters::ImageToMultiFileVolumeConversionParameters ( )

Set up the default values; dcmMsgCollector is automatically created.

◆ ImageToMultiFileVolumeConversionParameters() [2/2]

ml::ImageToMultiFileVolumeConversionParameters::ImageToMultiFileVolumeConversionParameters ( DicomConfigurableMessageFilterBaseRefCountedPtr dcmMsgCollectorPtr )

Set up the default values; dcmMsgCollectorPtr is not allowed to be nullptr.

Member Data Documentation

◆ autoCreateMissingPrivateCreators

bool ml::ImageToMultiFileVolumeConversionParameters::autoCreateMissingPrivateCreators = false

See DirectDicomImportDPLImporter._autoCreateMissingPrivateCreatorsFld for details.

Definition at line 99 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ copyPrivateTopLevelSourceTags

bool ml::ImageToMultiFileVolumeConversionParameters::copyPrivateTopLevelSourceTags = true

If enabled then private tags from source frames are copied to created SMF trees, otherwise they are skipped.

Note that this holds only for files where SMF trees are composed from multiple input files; if original files are reused then private tags are not removed. This also does not remove the created private MeVis tags, because they are essential for the management of the SMF tree.

Definition at line 90 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ dcmMsgCollector

DicomConfigurableMessageFilterBaseRefCountedPtr ml::ImageToMultiFileVolumeConversionParameters::dcmMsgCollector

The message collector to be used for importing if not nullptr.

Definition at line 105 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ disableDCMTreeNormalization

bool ml::ImageToMultiFileVolumeConversionParameters::disableDCMTreeNormalization = false

See DirectDicomImportDPLImporter._disableDCMTreeNormalizationFld for details.

Definition at line 93 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ doNotModifySMFTree

bool ml::ImageToMultiFileVolumeConversionParameters::doNotModifySMFTree = false

See DirectDicomImportDPLImporter._doNotModifySMFTreeFld for details.

Definition at line 102 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ keepTopLevelOfDCMTreeNormalization

bool ml::ImageToMultiFileVolumeConversionParameters::keepTopLevelOfDCMTreeNormalization = true

See DirectDicomImportDPLImporter._keepTopLevelOfDCMTreeNormalizationFld for details.

Definition at line 96 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ percentageRange

float ml::ImageToMultiFileVolumeConversionParameters::percentageRange = 0.5f

The range incrementally stepped through while this method is executed, for example 0.5.

The progress then is increased incrementally from percentageStart to percentageStart+percentageRange, thus from 0.3 to 0.8 by a number of steps whose number is determined inside of this method.

Definition at line 43 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ processSetNGoSeries

bool ml::ImageToMultiFileVolumeConversionParameters::processSetNGoSeries = false

If enabled then a Siemens setNGo postprocessing is applied to created MultiFileVolumes.

Definition at line 80 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ processSetNGoSeriesOnly

bool ml::ImageToMultiFileVolumeConversionParameters::processSetNGoSeriesOnly = false

If enabled then only Siemens setNGo series are created as result MultiFileVolumes, all others are dropped.

Definition at line 83 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ startPercentage

float ml::ImageToMultiFileVolumeConversionParameters::startPercentage = 0.5f

The percentage value of the progress bar which is updated when this method starts (for example to 0.3).

Definition at line 35 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ usedAllowMixedPixelTypes

bool ml::ImageToMultiFileVolumeConversionParameters::usedAllowMixedPixelTypes = false

If enabled then the ML data type determined from the imported frame(s) is checked against the min/max values determined according to the _calcMinMaxDPLFld mode.

If different pixel types in the imported frames appear then this data type might be too small to hold all values and must be enlarged. This flag only will have effect to the imported volumes if parting on data type relevant tags is disabled, i.e. HighBit, BitsStored, BitsAllocated, and PixelRepresentation should not be used for parting in the DPL configuration. This is an experimental mode which might not be stable for all configurations and therefore it should only be used on smallest possible subsets of data, for example by using the FileListFilterPlugin.

Definition at line 69 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ usedDecomposeTo3DVolumes

bool ml::ImageToMultiFileVolumeConversionParameters::usedDecomposeTo3DVolumes = false

If enabled then volumes with a temporal extent are decomposed to multiple 3D volumes if these 3D volumes are build from different frame sets, otherwise, if false, volumes are composed in time dimension normally.

Single file multi-frame volumes having temporal extents are not affected.

Definition at line 74 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ usedDPLAnon

bool ml::ImageToMultiFileVolumeConversionParameters::usedDPLAnon = false

If enabled the DPL will anonymize the created output DICOM tree, otherwise not.

Definition at line 46 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ usedDPLforceOrthogonalWorldMatrix

bool ml::ImageToMultiFileVolumeConversionParameters::usedDPLforceOrthogonalWorldMatrix = false

If enabled then the world matrix is always determined from the first ImageOrientationPatient of the first frame in frame set, otherwise from the first two slices and the difference between first two ImagePositionPatient voxel; default is off.

Definition at line 57 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ usedDPLremovePrivateMFSQTag

bool ml::ImageToMultiFileVolumeConversionParameters::usedDPLremovePrivateMFSQTag = false

If true then the sequence tag with private multi-frame tag information will be removed from created multi-frame tree before appending it to the image properties, otherwise it will normally be appended (the default).

Definition at line 51 of file mlImageToMultiFileVolumeConversionParameters.h.

◆ usedMinMaxScanMode

DicomToMLTools::CalculateMinMaxFromDicomModes ml::ImageToMultiFileVolumeConversionParameters::usedMinMaxScanMode = DicomToMLTools::CalculateMinMaxAutomatic

Provides the mode how the min/max voxel values for images are calculated.

Definition at line 77 of file mlImageToMultiFileVolumeConversionParameters.h.

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

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

Public Member Functions

Public Attributes