#include <mlDirectDicomImportDPLImporter.h>

Inheritance diagram for ml::DirectDicomImportDPLImporter:

Public Member Functions
	DirectDicomImportDPLImporter (DirectDicomImport &ddiOp)
	Constructor using a DirectDicomImport instance associated with.
	~DirectDicomImportDPLImporter () override
	Destructor.
void	appendFields (FieldContainer &fieldContainer) override
void	handleNotification (Field &field) override
	Handles all field changes related to fields created in appendDPLArgumentFields().
virtual bool	scanRecursively () const
	Returns true if settings require a recursive directory scan, otherwise it returns false for a flat scan.
virtual bool	decomposeMultiFrames () const
	Returns true if (DICOM multi-frame) files shall be decomposed to single frames during imports, otherwise false.
virtual bool	copyFullFunctionalGroupSequences () const
	Returns true if functional group sequences shall fully be copied during enhanced multi-frame decompositions, otherwise false.
void	import (const FileListTools::FileList &fileList) override
EnumField &	getDplSpecialProcessorsFld () const
	Provides access to some fields used outside.
DirectDicomImportDPLLogger &	getDPLLogger ()
	Returns the used DPL logger instance.
Public Member Functions inherited from ml::DirectDicomImportImporterBase
	DirectDicomImportImporterBase (DirectDicomImport &ddiOp)
	Constructor using a DirectDicomImport instance associated with.
	~DirectDicomImportImporterBase () override
	Destructor.
void	updateProgressIndicator (const std::string &info, float percState) override
void	_updateConsole (bool fullUpdate=true) override
virtual DicomConfigurableMessageFilterBaseRefCountedPtr	getMessageCollector () const
	Privides access to the message collector of the internally referenced DDI instance.
Public Member Functions inherited from ml::ProgressLogger
	ProgressLogger (std::stringstream outputStream=nullptr, NotifyField intCheckField=nullptr, StringField *statusField=nullptr, bool useRichTextCoding=true)
virtual	~ProgressLogger ()
	Destructor.
void	setAutoNewLineTermination (bool on)
	Enable/disable automatic newline termination of logged messages.
bool	isAutoNewLineTerminationOn () const
	Returns enabled/disabled automatic newline termination of logged messages.
virtual bool	messageHook (const ProgressLogger &, MLMessageType, const std::string , const std::string , MLErrorCode , const std::string , unsigned int *)
void	logAnyMessage (std::string msg, unsigned int formatFlags=NoFlags)
	Log any string into the console.
void	logFatalError (const std::string &func, MLErrorCode err, const std::string &reason)
void	logError (const std::string &func, MLErrorCode err, const std::string &reason)
	See logFatalError() for details.
void	logWarning (const std::string &func, MLErrorCode err, const std::string &reason)
	See logFatalError() for details.
void	logInfo (const std::string &func, const std::string &reason="")
void	logFullFatalError (const std::string &func, MLErrorCode err, const std::string &reason)
void	logFullError (const std::string &func, MLErrorCode err, const std::string &reason)
	See logFullFatalError() for details.
void	logFullWarning (const std::string &func, MLErrorCode err, const std::string &reason)
	See logFullFatalError() for details.
void	logFullInfo (const std::string &func, const std::string &reason)
bool	getRichTextCodingFlag () const
void	setRichTextCodingFlag (bool useRichTextCoding)
	See getRichTextCodingFlag() for details.
bool	getUpdateProgressDuringInterruptChecksFlag () const
void	setUpdateProgressDuringInterruptChecksFlag (bool callUpdateProgressDuringInterruptChecks)
	See getUpdateProgressDuringInterruptChecksFlag() for details.
void	setStatusUpdateTimeIntervalInSeconds (double checkIntervalInSeconds)
double	getStatusUpdateTimeIntervalInSeconds () const
void	setCheckTimeIntervalInSeconds (double checkIntervalInSeconds)
double	getCheckTimeIntervalInSeconds () const
	Returns the currently set interrupt check time interval.
void	setInterruptCheckFunction (InterruptCheckFunc checkFunc, void *userData)
InterruptCheckFunc	getInterruptCheckFunction () const
	Returns the currently set function for interrupt checks.
void *	getInterruptCheckFunctionUserData () const
	Returns the currently set user data pointer for interrupt checks.
void	setInterruptCheckField (NotifyField *interruptField=nullptr)
NotifyField *	getInterruptCheckField () const
void	setStatusField (StringField *statusField)
	Set a StringField which always shall be updated with all logged messages; ignored if nullptr.
StringField *	getStatusField () const
virtual bool	wasInterrupted ()
virtual bool	getInterruptedFlag () const
	Returns current state of interruption flag (but does not check for interruption).
virtual void	setInterruptedFlag (bool wasInterrupted)
	Sets current state of interruption flag (but does not check for interruption).
virtual bool	orToInterruptedFlag (bool wasInterrupted)
void	setHadFlags (bool hadFlag)
	Sets all had*Flags to hadFlag.
void	setFatalErrorMessagePrefix (const std::string &msg)
	Set/get prefixes for messages.
void	setErrorMessagePrefix (const std::string &msg)
void	setWarningMessagePrefix (const std::string &msg)
void	setInfoMessagePrefix (const std::string &msg)
std::string	getFatalErrorMessagePrefix () const
std::string	getErrorMessagePrefix () const
std::string	getWarningMessagePrefix () const
std::string	getInfoMessagePrefix () const
bool	hadFatalError () const
	Returns true if any fatal error, error, warning or info was logged; can be reset with corresponding setHad*Flag().
bool	hadError () const
bool	hadWarning () const
bool	hadInfo () const
void	setHadFatalErrorFlag (bool hadFatalErrorFlag)
	Sets the state of the corresponding _had* member; used to clear recent logging states.
void	setHadErrorFlag (bool hadErrorFlag)
void	setHadWarningFlag (bool hadWarningFlag)
void	setHadInfoFlag (bool hadInfoFlag)

Protected Member Functions
DPL parameter determination, either from fields or from connected file filer override values.
const std::string &	_getImportFilterProcessingSettings () const
	Returns the externally provided processing settings for the currently processed volume.
void	_setImportFilterProcessingSettings (const std::string &procSettings)
	Returns the externally provided processing settings for the currently processed volume.
bool	_doArgumentAndOverrideCheck (bool dplFlag, const std::string &overrideName) const
std::vector< DirectDicomImportDPLTagValueProvider::HardOverwriteTag >	_getHardOverwriteTags ()
std::string	_getForce2DPlusTCondition ()
DicomToMLTools::CalculateMinMaxFromDicomModes	_getUsedMinMaxScanMode ()
	Returns the used mode for the min/max calculations from input filters and field settings.
Protected Member Functions inherited from ml::DirectDicomImportImporterBase
virtual MultiFileVolumeList &	_getOutVolumeList ()
Protected Member Functions inherited from ml::ProgressLogger
std::string	_doAutoNewLineTerminate (const std::string &msg) const
	Helper to terminate msg with newline at end according.
virtual bool	_isStopPressed () const

Additional Inherited Members
Public Types inherited from ml::ProgressLogger
enum	FormatFlags { NoFlags = 0 , Bold = 1 , Green = 2 , Yellow = 4 , Red = 8 , Blue = 16 }
	Enumerator describing some formatting flags. More...
typedef bool(*	InterruptCheckFunc) (void *userData)
	Function type to check to for an interruption.
Static Public Member Functions inherited from ml::ProgressLogger
static bool	isPressedField (NotifyField *fieldToCheck)
Static Protected Member Functions inherited from ml::ProgressLogger
static void	_updateProgressIndicatorCB (void *userData, const std::string &info, float state)

Detailed Description

Class handling all DICOM Processor Library Import (DPL) stuff for the DirectDicomImport module

Definition at line 46 of file mlDirectDicomImportDPLImporter.h.

Constructor & Destructor Documentation

◆ DirectDicomImportDPLImporter()

ml::DirectDicomImportDPLImporter::DirectDicomImportDPLImporter ( DirectDicomImport & ddiOp )

Constructor using a DirectDicomImport instance associated with.

◆ ~DirectDicomImportDPLImporter()

ml::DirectDicomImportDPLImporter::~DirectDicomImportDPLImporter ( )

override

Destructor.

Member Function Documentation

◆ _doArgumentAndOverrideCheck()

bool ml::DirectDicomImportDPLImporter::_doArgumentAndOverrideCheck	(	bool	dplFlag,
		const std::string &	overrideName ) const

protected

If overrideName is defined as 0 or non 0 in getImportFilterProcessingSettings(), then false or true is returned, respectively. If it is not set then then dplFlag is returned.

◆ _getForce2DPlusTCondition()

std::string ml::DirectDicomImportDPLImporter::_getForce2DPlusTCondition ( )

protected

Determines the force2DPlusTCondition either from input filters or from DPL fields; it is used by the DPL importer as force2DPlusTCondition.

◆ _getHardOverwriteTags()

std::vector< DirectDicomImportDPLTagValueProvider::HardOverwriteTag > ml::DirectDicomImportDPLImporter::_getHardOverwriteTags ( )

protected

Returns a vector of hardOverwrite tags either from input filter settings or from the DPL importer fields.

◆ _getImportFilterProcessingSettings()

const std::string & ml::DirectDicomImportDPLImporter::_getImportFilterProcessingSettings ( ) const

protected

Returns the externally provided processing settings for the currently processed volume.

◆ _getUsedMinMaxScanMode()

DicomToMLTools::CalculateMinMaxFromDicomModes ml::DirectDicomImportDPLImporter::_getUsedMinMaxScanMode ( )

protected

Returns the used mode for the min/max calculations from input filters and field settings.

References ml::FileListTools::DPLConfiguration::NUM_USED_DPL_CONFIGS.

◆ _setImportFilterProcessingSettings()

void ml::DirectDicomImportDPLImporter::_setImportFilterProcessingSettings ( const std::string & procSettings )

protected

Returns the externally provided processing settings for the currently processed volume.

◆ appendFields()

void ml::DirectDicomImportDPLImporter::appendFields ( FieldContainer & fieldContainer )

overridevirtual

Appends all parameter fields related to DPL import to fieldContainer. Usually called in a constructor where notification handling should be deactivated to avoid side effects to handleNotification.

Reimplemented from ml::DirectDicomImportImporterBase.

◆ copyFullFunctionalGroupSequences()

virtual bool ml::DirectDicomImportDPLImporter::copyFullFunctionalGroupSequences ( ) const

virtual

Returns true if functional group sequences shall fully be copied during enhanced multi-frame decompositions, otherwise false.

◆ decomposeMultiFrames()

virtual bool ml::DirectDicomImportDPLImporter::decomposeMultiFrames ( ) const

virtual

Returns true if (DICOM multi-frame) files shall be decomposed to single frames during imports, otherwise false.

◆ getDPLLogger()

DirectDicomImportDPLLogger & ml::DirectDicomImportDPLImporter::getDPLLogger ( )

Returns the used DPL logger instance.

◆ getDplSpecialProcessorsFld()

EnumField & ml::DirectDicomImportDPLImporter::getDplSpecialProcessorsFld ( ) const

Provides access to some fields used outside.

◆ handleNotification()

void ml::DirectDicomImportDPLImporter::handleNotification ( Field & field )

overridevirtual

Handles all field changes related to fields created in appendDPLArgumentFields().

Reimplemented from ml::DirectDicomImportImporterBase.

◆ import()

void ml::DirectDicomImportDPLImporter::import ( const FileListTools::FileList & fileList )

overridevirtual

Builds MultiFileVolume(s) from files provided by fileList.

Parameters

fileList Manager for a map of file names associated with filter attributes.

Implements ml::DirectDicomImportImporterBase.

◆ scanRecursively()

virtual bool ml::DirectDicomImportDPLImporter::scanRecursively ( ) const

virtual

Returns true if settings require a recursive directory scan, otherwise it returns false for a flat scan.

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

FMEstable/ReleaseMeVis/Projects/DICOM/MLDirectDicomImport/Sources/mlDirectDicomImportDPLImporter.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DirectDicomImportDPLImporter()

◆ ~DirectDicomImportDPLImporter()

Member Function Documentation

◆ _doArgumentAndOverrideCheck()

◆ _getForce2DPlusTCondition()

◆ _getHardOverwriteTags()

◆ _getImportFilterProcessingSettings()

◆ _getUsedMinMaxScanMode()

◆ _setImportFilterProcessingSettings()

◆ appendFields()

◆ copyFullFunctionalGroupSequences()

◆ decomposeMultiFrames()

◆ getDPLLogger()

◆ getDplSpecialProcessorsFld()

◆ handleNotification()

◆ import()

◆ scanRecursively()