Purpose

MultiFileVolumeListBaseOutput is a base class providing additional information about a single volumes from a MultiFileVolumeList which is connected via the input base field or loaded from a cache file. A DirectDicomImport is a module which has such a Base output field or which can create such cache files. Note that MultiFileVolumeListBaseOutput is rarely used as it is, because derived classes usually provide the same functionality with dedicated support for specific DICOM IODs.

Usage

Connecte a MultiFileVolumeList to the input Base field or load it from a file. The select a volume from the list with the Volume Index.

Windows

Default Panel

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

Input Fields

inputAccessConnector

name: inputAccessConnector, type: MLBase

A connector to a MultiFileVolumeList (a typically one is an output of the DirectDicomImport module) from which a structured report shall be selected.

inputMessageFilterPlugin

name: inputMessageFilterPlugin, type: MLBase

In some situations is may be of interest to suppress messages (errors, or warnings) generated while loading or importing files since the user is aware of their origin and meaning, and because they shadow other messages which might have a higher importance. For this purpose a plugin can be connected to this input which filters out specific messages, for example a DicomConfigurableMessageFilter. If this input is left open then the messages are generated normally.

Output Fields

outputAccessConnector

name: outputAccessConnector, type: MLBase

A convenience output providing the currently used MultiFileVolumeList as MultiFileVolumeListRefCounted pointer; this is especially useful for concatenating multiple MultiFileVolumeListOutput modules or to get access to the used list with python wrappers.

Parameter Fields

Field Index

Annotate: Bool Num Volumes: Integer
autoLoadResultCache: Bool Tag Dump: String
Cache File Path: String Tag Dump Size: Integer
Dump Private Tag Values: Bool updateBaseOutputInformationDone: Trigger
Filter: String Use Base Input: Bool
Issues: String Volume Index: Integer
Load Result Cache: Trigger Volume Info Dump: String
Num shown binary bytes: Integer  

Visible Fields

Use Base Input

name: useBaseInput, type: Bool, default: TRUE

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

Load Result Cache

name: loadResultCache, type: Trigger

Loads a volume list from cached result volume.

Cache File Path

name: cacheFilePath, type: String

File containing a list of cached image volumes.

Volume Index

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

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

Num Volumes

name: numVolumes, type: Integer, default: 0

This read-only field shows number of available volumes.

Issues

name: issues, type: String

This read-only field contains a short description about known issues about the currently selected volume - if there are any.

Volume Info Dump

name: volumeInfoDump, type: String, persistent: no

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

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.

Dump Private Tag Values

name: dumpPrivateTagValues, type: Bool, default: FALSE

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

Num shown binary bytes

name: numShownBinaryEntries, type: Integer, default: 8

Number of shown entries of binary tags.

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.

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.

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).

Hidden Fields

autoLoadResultCache

name: autoLoadResultCache, type: Bool, default: FALSE

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.