Purpose

The MultiFileVolumeListFIDOutput provides an XMarkerList output for a MultiFileVolumeList either from a connected DirectDicomImport module or loaded from a cache file. Other modules providing base connectors containing MultiFileVolumeList outputs of course can also be used as input.

A volume from the connected or loaded list can be selected with Volume Index and if it contains DICOM fiducial objects they are converted to an XMarkerList output. Additional textual information is shown in many fields which allows the inspection of DICOM tags and further volume information.

Windows

Default Panel

../../../Projects/MultiFileVolume/MLMultiFileVolumeListOutputs/Modules/mhelp/Images/Screenshots/MultiFileVolumeListFIDOutput._default.png

Input Fields

inputAccessConnector

name: inputAccessConnector, type: MLBase

The connector to connect MultiFileVolumeListFIDOutput with a DirectDicomImport module. If not connected the volume list can be read from a cache file alternatively. This can be switched with Use Base Input.

see also MultiFileVolumeListBaseOutput.inputAccessConnector

inputMessageFilterPlugin

name: inputMessageFilterPlugin, type: MLBase

see MultiFileVolumeListBaseOutput.inputMessageFilterPlugin

Output Fields

outXMarkerList

name: outXMarkerList, type: MLBase

If the currently selected volume is a DICOM volume and is of modality FID then the fiducial information from that volumes is converted to an XMarkerList provided at this output connector. If it is no DICOM volume of if it does not contain valid or convertible fiducial information then this connector will be invalid.

outputAccessConnector

name: outputAccessConnector, type: MLBase

see MultiFileVolumeListBaseOutput.outputAccessConnector

Parameter Fields

Field Index

Annotate: Bool Num shown binary bytes: Integer Volume Info Dump: String
Auto Load Result Cache: Bool Number of volumes: Integer  
Cache File Path: String Tag Dump: String  
Dump Private Tag Values: Bool Tag Dump Size: Integer  
Filter: String updateBaseOutputInformationDone: Trigger  
Info: String updateFIDOutputInformationDone: Trigger  
issues: String Use Base Input: Bool  
Load Result Cache: Trigger Volume Index: Integer  

Visible Fields

Use Base Input

name: useBaseInput, type: Bool, default: TRUE

If enabled then the volume is read from the DirectDicomImport module connected to the base input; otherwise the specified cache file is read.

see also MultiFileVolumeListBaseOutput.useBaseInput

Load Result Cache

name: loadResultCache, type: Trigger

Loads a volume list from cached result volume.

see also MultiFileVolumeListBaseOutput.loadResultCache

Auto Load Result Cache

name: autoLoadResultCache, type: Bool, default: FALSE

If enabled then the cache file is loaded automatically from file.

Cache File Path

name: cacheFilePath, type: String

File containing a list of cached image volumes.

see also MultiFileVolumeListBaseOutput.cacheFilePath

Volume Index

name: outVolIdx, type: Integer, default: 0, minimum: -1

Sets the index of the volume currently selected in the volume list, -1 -1 invalidates the selected volume and outXMarkerList.

see also MultiFileVolumeListBaseOutput.outVolIdx

Number of volumes

name: numVolumes, type: Integer, default: 0

This read-only field shows number of available volumes.

see also MultiFileVolumeListBaseOutput.numVolumes

Volume Info Dump

name: volumeInfoDump, type: String, persistent: no

Shows a collection of available information about the currently selected volume.

see also MultiFileVolumeListBaseOutput.volumeInfoDump

Tag Dump Size

name: tagDumpSize, type: Integer, default: 10000

Maximum number of characters shown in the ‘Tag Dump’ field. Too large values can degrade performance when viewing the DICOM tag list.

see also MultiFileVolumeListBaseOutput.tagDumpSize

Dump Private Tag Values

name: dumpPrivateTagValues, type: Bool, default: FALSE

If enabled then values of private tags are decoded if decoders are available.

see also MultiFileVolumeListBaseOutput.dumpPrivateTagValues

Num shown binary bytes

name: numShownBinaryEntries, type: Integer, default: 8

Number of shown entries of binary tags.

see also MultiFileVolumeListBaseOutput.numShownBinaryEntries

Annotate

name: annotate, type: Bool, default: FALSE

If enabled then tags are annotated with further descriptive information such as possible types (1=Mandatory, 1C=Conditionally Mandatory, 2=Mandatory, may have zero or one item, 2C=Conditionally Mandatory, but may be empty, 3=Optional) and possible meanings of the tag. Note that no context analysis is performed for that information and therefore all possible and perhaps redundant meanings are shown.

see also MultiFileVolumeListBaseOutput.annotate

Filter

name: regExLineFilter, type: String

If not empty then the regular expression is used to filter all lines of the tag dump. Examples:

Expression Description
.* Matches all paths.
.*logo.* Matches anything containing ‘logo’ (case sensitive)
.*[lL][oO][gG][oO].* Matches anything containing ‘logo’ (case insensitive)
.*.[jJ][pP][gG] Matches anything ending with .jpg where jpg is case insensitive.
.*.JPG|.*.jpg Matches all paths ending with either ‘.jpg’ or with ‘.JPG’.
.*d.* Matches all paths containing at least one digit.
.*[[:digit:]].* Same as above.
.*[[:xdigit:]].* Matches all paths containing at least one hexadecimal digit.
.*l.* Matches all paths containing at least one lower case character.
.*[[:lower:]].* Same as above.
.*u.* Matches all paths containing at least one upper case character.
.*[[:upper:]].* Same as above.
.*s.* Matches all paths containing at least one white space character.
.*[[:space:]].* Same as above.
.*[[:blank:]].* Matches all paths containing at least one non-line-separating whitespace.
.*[[:word:]].* Matches all paths containing at least one word character (alphanumeric characters plus the underscore).
.*[[:w:]].* Same as above.
.*[[:graph:]].* Matches all paths containing at least one graphical character.
.*[5-7].* Matches all paths containing at least one of the digits 5, 6 or 7.

see also MultiFileVolumeListBaseOutput.regExLineFilter

Tag Dump

name: tagDump, type: String, persistent: no

Shows the DICOM tag list of currently selected volume (the dump will be clamped if the tag list is too large).

see also MultiFileVolumeListBaseOutput.tagDump

Info

name: info, type: String, default: No volume available.

Shows the DICOM tag list of currently selected volume (the dump will be clamped if the tag list is too large).

Hidden Fields

issues

name: issues, type: String, persistent: no

see MultiFileVolumeListBaseOutput.issues

updateBaseOutputInformationDone

name: updateBaseOutputInformationDone, type: Trigger

Field which is touched after the completion of updates of all fields belonging to the same class type this field belongs to. Note that derived classes may update their fields later.

see also MultiFileVolumeListBaseOutput.updateBaseOutputInformationDone

updateFIDOutputInformationDone

name: updateFIDOutputInformationDone, type: Trigger

Field which is touched after the completion of updates of all fields belonging to the same class type this field belongs to. Note that derived classes may update their fields later.