DICOMFileListFilter¶
-
MLModule
¶ genre FileMain
author Wolf Spindler
package FMEstable/ReleaseMeVis
dll MLFileListTools
definition MLFileListTools.def see also FileListFilterPlugin
,FileDirectory
keywords file
,find
,search
,scan
,look
,quest
,retrieve
,list
,directory
,recursively
,filter
,tag
,trees
,DICOM
,DCM
,scan
,classify
,property
,value
Purpose¶
DICOMFileListFilter
searches files containing DICOM information in the directory Directory Path
. It currently supports pure DICOM, DCM/Tif, and .mlimage files containing DICOM information. Files with more specific information can be found by connecting one or multiple FileListFilterPlugin
module(s) which can be configured to filter file names and DICOM tags. The found result files are displayed in Found File Names
either as relative or absolute paths.
Suppressing file types in Suppressed Files and Suffixes
can exclude a number files from the check for DICOM information to improve scan speed.
Input Fields¶
fileListFilterPlugins¶
-
name:
fileListFilterPlugins
, type:
MLBase
¶ Her a single
FileListFilterPlugin
or a concatenated list them can be connected to filter out files with specific file names or DICOM tag properties. For details about possible filter options seeFileListFilterPlugin
.
Parameter Fields¶
Field Index¶
Create Relative Paths : Bool |
Search In Sub Directories : Bool |
DCM/Tiffs : Bool |
Start Search : Trigger |
Directory Path : String |
Status : String |
Found File Names : String |
Stop : Trigger |
isScanning : Bool |
Suppressed Files and Suffixes : String |
Log File Scan Messages : Bool |
|
mlmages : Bool |
|
Pure DICOMs : Bool |
Visible Fields¶
Directory Path¶
-
name:
directoryPath
, type:
String
¶ The path to the directory which shall be scanned for files containing DICOM information.
Create Relative Paths¶
-
name:
createRelativePaths
, type:
Bool
, default:
FALSE
¶ If enabled (default is false) then file names are shown as relative paths in
Found File Names
, otherwise as absolute ones.
Search In Sub Directories¶
-
name:
searchInSubDirectories
, type:
Bool
, default:
TRUE
¶ If enabled (default is true) then
Directory Path
is scanned recursively, otherwise only a flat scan is performed.
Pure DICOMs¶
-
name:
searchPureDICOMs
, type:
Bool
, default:
TRUE
¶ If enabled then pure DICOM files are included in the file search, otherwise they are not shown in
Found File Names
.
DCM/Tiffs¶
-
name:
searchDCMTiffs
, type:
Bool
, default:
TRUE
¶ If enabled then also DCM/Tiff files are included in the file search, otherwise they are not shown in
Found File Names
.
mlmages¶
-
name:
searchMLImages
, type:
Bool
, default:
TRUE
¶ If enabled then also .mlimage files are included in the file search, otherwise they are not shown in
Found File Names
.
Log File Scan Messages¶
-
name:
logFileScanMessages
, type:
Bool
, default:
FALSE
¶ If enabled then messages from file scanner are posted to the ML error handler (and therefore usually in the MeVisLab console), if disabled then the scan process is performed silently. Note that all files must be opened to check whether they contain DICOM information; non-DICOM like files will generate error messages if that is tried. Therefore this flag usually should be disabled; however, a few DICOM files contain errors and then it might be useful to enable this flag for diagnostic purposes.
Suppressed Files and Suffixes¶
-
name:
suppressedFilesAndSuffixes
, type:
String
, default:
.7z .bmp .db .DDI-SMF-TreeCacheFile.dcm entries .exe .gipl .gvr .hdr .inf .iv .img .jpg .mhd .mlab .mllut .mnc .log .lsm .lst .obj .off .pic .png .pnm .nii .nrrd .rar .raw .sdt .spr .svn-base .tiff .txt .txt~ .vti .vtk .xml .zip .zraw all-wcprops DIRFILE DICOMDIR README ReadMe Readme
¶ Since DICOM files usually do not have a specific file suffix, they always must be opened expensively to determine whether they contain DICOM information or not. Suffixes of files which shall not be opened can be specified in
Suppressed Files and Suffixes
to improve the speed of the scan process. It is a space separated list of suppressed suffixes and files. File suffixes must be denoted with a leading ‘.’.
Start Search¶
-
name:
startSearch
, type:
Trigger
¶ Starts the file search process in the directory
Directory Path
.
Stop¶
-
name:
stop
, type:
Trigger
¶ Breaks an ongoing file search which was started with
Start Search
.
Found File Names¶
-
name:
foundFileNames
, type:
String
, persistent:
no
¶ The list of files containing DICOM information is shown in this field. Dependent on
Create Relative Paths
they are shown as paths relative toDirectory Path
or as absolute path.