MeVisLab Toolbox Reference
ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters Struct Reference

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

#include <mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h>

Public Member Functions

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

Public Attributes

float startPercentage
 The percentage value of the progress bar which is updated when this method starts (for example to 0.3). More...
 
float percentageRange
 The range incrementally stepped through while this method is executed, for example 0.5. More...
 
bool usedDPLAnon
 If enabled the DPL will anonymize the created output DICOM tree, otherwise not. More...
 
bool usedDPLremovePrivateMFSQTag
 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). More...
 
bool usedDPLforceOrthogonalWorldMatrix
 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. More...
 
bool usedAllowMixedPixelTypes
 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. More...
 
bool usedDecomposeTo3DVolumes
 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. More...
 
DicomToMLTools::CalculateMinMaxFromDicomModes usedMinMaxScanMode
 Provides the mode how the min/max voxel values for images are calculated. More...
 
bool processSetNGoSeries
 If enabled then a Siemens setNGo postprocessing is applied to created MultiFileVolumes. More...
 
bool processSetNGoSeriesOnly
 If enabled then only Siemens setNGo series are created as result MultiFileVolumes, all others are dropped. More...
 
bool copyPrivateTopLevelSourceTags
 If enabled then private tags from source frames are copied to created SMF trees, otherwise they are skipped. More...
 
DicomConfigurableMessageFilterBaseRefCountedPtr dcmMsgCollector
 The message collector to be used for importing if not nullptr. More...
 

Detailed Description

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

Definition at line 30 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.

Constructor & Destructor Documentation

◆ ConversionParameters()

ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters::ConversionParameters ( DicomConfigurableMessageFilterBaseRefCountedPtr  dcmMsgCollectorPtr)
inline

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

Definition at line 33 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.

Member Data Documentation

◆ copyPrivateTopLevelSourceTags

bool ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters::copyPrivateTopLevelSourceTags

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 105 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.

◆ dcmMsgCollector

DicomConfigurableMessageFilterBaseRefCountedPtr ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters::dcmMsgCollector

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

Definition at line 108 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.

◆ percentageRange

float ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters::percentageRange

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 58 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.

◆ processSetNGoSeries

bool ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters::processSetNGoSeries

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

Definition at line 95 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.

◆ processSetNGoSeriesOnly

bool ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters::processSetNGoSeriesOnly

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

Definition at line 98 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.

◆ startPercentage

float ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters::startPercentage

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

Definition at line 50 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.

◆ usedAllowMixedPixelTypes

bool ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters::usedAllowMixedPixelTypes

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 84 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.

◆ usedDecomposeTo3DVolumes

bool ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters::usedDecomposeTo3DVolumes

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 89 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.

◆ usedDPLAnon

bool ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters::usedDPLAnon

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

Definition at line 61 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.

◆ usedDPLforceOrthogonalWorldMatrix

bool ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters::usedDPLforceOrthogonalWorldMatrix

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 72 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.

◆ usedDPLremovePrivateMFSQTag

bool ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters::usedDPLremovePrivateMFSQTag

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 66 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.

◆ usedMinMaxScanMode

DicomToMLTools::CalculateMinMaxFromDicomModes ml::DirectDicomImportDPLImageToMultiFileVolume::ConversionParameters::usedMinMaxScanMode

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

Definition at line 92 of file mlDirectDicomImportDPLImageToMultiFileVolumeParameters.h.


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