Manages some DPL (DICOM Processing Library) configurations which control sorting and partitioning of imported DICOM frames.
More...
#include <mlFileListToolsDPLConfiguration.h>
|
| DPLConfiguration () |
|
const DPL::Configuration & | getConfig () const |
| Returns the used configuration object. More...
|
|
const std::set< MLuint32 > & | getTagIdSet () const |
| Returns all ids used in the internally defined configuration. More...
|
|
void | setUpDPLConfig (DplConfigs dplUsedConfig, const std::string dplConfigStringFld[4], const std::string &importFilterConfig, const std::string &importFilterProcessingSettings, size_t minNumFramesInVolume, DPL::Logger &logger, DPL::Processor &processor, DPL::SecondPassPartitioningProvider &addedProvider, MLdouble relativeDistanceTolerance, MLdouble absoluteDistanceTolerance, MLdouble positionToleranceMM, const std::string &seriesBasedPreprocessingCondition, std::string force2DPlusTCondition) |
| Sets up the import configuration for a DPL::Processor "processor". More...
|
|
|
static bool | hasUIntSetting (const std::string &str, const std::string &tag, unsigned int &val) |
| Helper function to read last unsigned integer argument after tag from str. More...
|
|
static bool | hasDoubleSetting (const std::string &str, const std::string &tag, double &val) |
| Helper function to read last unsigned integer argument after tag from str. More...
|
|
static bool | hasSingleStringSetting (std::string str, const std::string &tag, std::string &strVal, bool replaceSpaceTags=true) |
| Helper function to read a single string without white spaces after tag from str. More...
|
|
static bool | hasDoubleStringSetting (std::string str, const std::string &tag, std::string &str1Val, std::string &str2Val, bool replaceSpaceTags=true) |
| Helper function to read two space separated strings without white spaces after tag from str. More...
|
|
Manages some DPL (DICOM Processing Library) configurations which control sorting and partitioning of imported DICOM frames.
Definition at line 41 of file mlFileListToolsDPLConfiguration.h.
◆ DplConfigs
Available selectable DPL configurations.
Enumerator |
---|
DPLDefaultConfig | Default configuration (not modifiable)
|
DPLUserConfig1 | 1st modifiable user configuration
|
DPLUserConfig2 | 2nd modifiable user configuration
|
DPLUserConfig3 | 3rd modifiable user configuration
|
NUM_USED_DPL_CONFIGS | |
Definition at line 46 of file mlFileListToolsDPLConfiguration.h.
◆ DPLConfiguration()
ml::FileListTools::DPLConfiguration::DPLConfiguration |
( |
| ) |
|
|
inline |
◆ getConfig()
const DPL::Configuration& ml::FileListTools::DPLConfiguration::getConfig |
( |
| ) |
const |
|
inline |
◆ getTagIdSet()
const std::set<MLuint32>& ml::FileListTools::DPLConfiguration::getTagIdSet |
( |
| ) |
const |
|
inline |
◆ hasDoubleSetting()
static bool ml::FileListTools::DPLConfiguration::hasDoubleSetting |
( |
const std::string & |
str, |
|
|
const std::string & |
tag, |
|
|
double & |
val |
|
) |
| |
|
static |
Helper function to read last unsigned integer argument after tag from str.
- Parameters
-
str | The str in which the last expression like tag + "=%lf" is searched. |
tag | The string searched and which must be followed by "=%lf". |
val | Returns the value after tag + "=" if there is any, otherwise undefined. |
- Returns
- true if in str an expression such as tag + "=%lf" was found and lf could be parsed successfully, otherwise false.
◆ hasDoubleStringSetting()
static bool ml::FileListTools::DPLConfiguration::hasDoubleStringSetting |
( |
std::string |
str, |
|
|
const std::string & |
tag, |
|
|
std::string & |
str1Val, |
|
|
std::string & |
str2Val, |
|
|
bool |
replaceSpaceTags = true |
|
) |
| |
|
static |
Helper function to read two space separated strings without white spaces after tag from str.
- Parameters
-
str | The str in which the last expression like tag + "=%1023s %1023s" is searched. |
tag | The string searched and which must be followed by "=%1023s %1023s". |
str1Val | Returns the value after tag + "=" if there is any, otherwise undefined. The maximum value size read is 1023 characters. |
str2Val | Returns the value after tag + "=" if there is any, otherwise undefined. The maximum value size read is 1023 characters. |
replaceSpaceTags | If true then all appearances of the substring "<sp>" are replaced by single spaces. |
- Returns
- true if in str an expression such as tag + "=%1023s %1023s" was found and "=%1023s %1023s" could be parsed successfully, otherwise false.
◆ hasSingleStringSetting()
static bool ml::FileListTools::DPLConfiguration::hasSingleStringSetting |
( |
std::string |
str, |
|
|
const std::string & |
tag, |
|
|
std::string & |
strVal, |
|
|
bool |
replaceSpaceTags = true |
|
) |
| |
|
static |
Helper function to read a single string without white spaces after tag from str.
- Parameters
-
str | The str in which the last expression like tag + "=%1023s" is searched. |
tag | The string searched and which must be followed by "=%1023s". |
strVal | Returns the value after tag + "=" if there is any, otherwise undefined. The maximum value size read is 1023 characters. |
replaceSpaceTags | If true then all appearances of the substring "<sp>" are replaced by single spaces. |
- Returns
- true if in str an expression such as tag + "=%1023s" was found and "=%1023s" could be parsed successfully, otherwise false.
◆ hasUIntSetting()
static bool ml::FileListTools::DPLConfiguration::hasUIntSetting |
( |
const std::string & |
str, |
|
|
const std::string & |
tag, |
|
|
unsigned int & |
val |
|
) |
| |
|
static |
Helper function to read last unsigned integer argument after tag from str.
- Parameters
-
str | The str in which the last expression like tag + "=%u" is searched. |
tag | The string searched and which must be followed by "=%u". |
val | Returns the value after tag + "=" if there is any, otherwise undefined. |
- Returns
- true if in str an expression such as tag + "=%u" was found and u could be parsed successfully, otherwise false.
◆ setUpDPLConfig()
void ml::FileListTools::DPLConfiguration::setUpDPLConfig |
( |
DplConfigs |
dplUsedConfig, |
|
|
const std::string |
dplConfigStringFld[4], |
|
|
const std::string & |
importFilterConfig, |
|
|
const std::string & |
importFilterProcessingSettings, |
|
|
size_t |
minNumFramesInVolume, |
|
|
DPL::Logger & |
logger, |
|
|
DPL::Processor & |
processor, |
|
|
DPL::SecondPassPartitioningProvider & |
addedProvider, |
|
|
MLdouble |
relativeDistanceTolerance, |
|
|
MLdouble |
absoluteDistanceTolerance, |
|
|
MLdouble |
positionToleranceMM, |
|
|
const std::string & |
seriesBasedPreprocessingCondition, |
|
|
std::string |
force2DPlusTCondition |
|
) |
| |
Sets up the import configuration for a DPL::Processor "processor".
- Parameters
-
dplUsedConfig | The selector for the DplConfiguration to be used for importing (if it is not overridden by a non empty importFilterConfig). |
dplConfigStringFld | The dpl configurations from which can be selected by dplUsedConfig. |
importFilterConfig | If non empty this dpl configuration overrides the selected configuration from dplUsedConfig otherwise this is ignored. |
importFilterProcessingSettings | If non empty these settings are parsed line-wise and override importer settings if any matching ones are found. |
minNumFramesInVolume | The minimum number of frames needed to be composed to a volume. |
logger | The dpl logger in which dpl log messages are sent during import processings. |
processor | The dpl processor which is going to be used for importing DICOM frames. |
addedProvider | A second pass partitioner for the DPL processor which allows splitting of series'. |
relativeDistanceTolerance | The maximum difference between 2 slice distances in percents that does not split up a 3D volume. |
absoluteDistanceTolerance | The maximum difference between 2 slice distances in mm that does not split up a 3D volume. |
positionToleranceMM | Absolute tolerance in mm, added to the previous value to decide if a volume is homogeneous. |
seriesBasedPreprocessingCondition | Official documentation is: Sets the string condition representing if frames of a series should be processed for the series only. If the string is "1" or a condition evaluating to true for the frames of a series, the frames are processed per series. Currently only the value "1" is considered true, all others are considered false. |
force2DPlusTCondition | A DICOM tag condition string; if evaluates to true for the first image in an image set, a 2D+T image set will be created (instead of a 3D or inhomogeneous image). |
◆ DPL_DEFAULT_CONFIG0
const char* const ml::FileListTools::DPLConfiguration::DPL_DEFAULT_CONFIG0 |
|
static |
◆ DPL_DEFAULT_CONFIG1
const char* const ml::FileListTools::DPLConfiguration::DPL_DEFAULT_CONFIG1 |
|
static |
◆ DPL_DEFAULT_CONFIG2
const char* const ml::FileListTools::DPLConfiguration::DPL_DEFAULT_CONFIG2 |
|
static |
◆ DPLUsedConfigNames
The documentation for this class was generated from the following file: