MultiFileVolumeListDOCOutput¶

MLModule¶

genre	`DICOM, MultiFileVolumeList`
author	`Wolf Spindler`
package	`FMEstable/ReleaseMeVis`
dll	`MLMultiFileVolumeListOutputs`
definition	MLMultiFileVolumeListOutputs.def
see also	`DirectDicomImport`, `MultiFileVolumeListBaseOutput`, `MultiFileVolumeListImageOutput`, `MultiFileVolumeListFIDOutput`, `MultiFileVolumeListRTOutput`, `MultiFileVolumeListSEGOutput`, `MultiFileVolumeListSROutput`, `FileListFilterPlugin`
inherits from	`MultiFileVolumeListBaseOutput`
keywords	`DICOM`, `DCM`, `import`, `load`, `read`, `PDF`, `CDA`, `STL`, `OBJ`, `MTL`

Purpose¶

MultiFileVolumeListDOCOutput extracts encapsulated documents and related information from DICOM files which are connected as MultiFileVolumeList to its input. Currently the following encapsulated objects are supported:

PDF (SOP Class UID 1.2.840.10008.5.1.4.1.1.104.1)
STL (SOP Class UID 1.2.840.10008.5.1.4.1.1.104.2)
CDA (SOP Class UID 1.2.840.10008.5.1.4.1.1.104.3)
OBJ (SOP Class UID 1.2.840.10008.5.1.4.1.1.104.4)
MTL (SOP Class UID 1.2.840.10008.5.1.4.1.1.104.5)

The extracted files are stored in a file given as path. In case of CDA objects the content can also be displayed in a text field.

Windows¶

Default Panel¶

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

Input Fields¶

inputAccessConnector¶

name: inputAccessConnector, type: MLBase¶

see MultiFileVolumeListBaseOutput.inputAccessConnector

inputMessageFilterPlugin¶

name: inputMessageFilterPlugin, type: MLBase¶

see MultiFileVolumeListBaseOutput.inputMessageFilterPlugin

Output Fields¶

outputAccessConnector¶

name: outputAccessConnector, type: MLBase¶

see MultiFileVolumeListBaseOutput.outputAccessConnector

Parameter Fields¶

Field Index¶

`Annotate`: `Bool`	`Full File Name`: `String`	`Tag Dump`: `String`
`Auto Load Result Cache`: `Bool`	`Info`: `String`	`Tag Dump Size`: `Integer`
`Cache File Path`: `String`	`issues`: `String`	`updateBaseOutputInformationDone`: `Trigger`
`Cda Dump`: `String`	`Load Result Cache`: `Trigger`	`updateDOCOutputInformationDone`: `Trigger`
`Document Type Fld`: `Enum`	`Num shown binary bytes`: `Integer`	`Use Base Input`: `Bool`
`Dump Private Tag Values`: `Bool`	`Number of volumes`: `Integer`	`Volume Index`: `Integer`
`File Name`: `String`	`Save Document`: `Trigger`	`Volume Info Dump`: `String`
`Filter`: `String`	`Show CDADump`: `Bool`

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.

Load Result Cache¶

name: loadResultCache, type: Trigger¶: Loads a volume list from cached result volume.

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.

Volume Index¶

name: outVolIdx, type: Integer, default: 0, minimum: -1¶: This read-only field shows the index of the volume currently selected in the volume list.

Number of volumes¶

name: numVolumes, type: Integer, default: 0¶: This read-only field shows number of available volumes.

Volume Info Dump¶

name: volumeInfoDump, type: String, persistent: no¶: Shows a collection of important overview information about the currently selected MultiFileVolume.

Tag Dump Size¶

name: tagDumpSize, type: Integer, default: 10000¶: Maximum number of characters shown in the Tag Dump field. Note that 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 bytes 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 Tag Dump; see that field for more details. Examples:

======================= ==================================
Expression              Description
======================= ==================================
.*                     Matches all string/lines.
.*(0008,0032).*        Matches all lines containing this tag ID.
.*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 a dump of the DICOM tags; if necessary it will be clamped at a size given by Tag Dump Size and the message ‘tag list shortened and not shown completely’ is appended.

Info¶

name: info, type: String, default: No volume available.¶: Shows some important overview information about the currently selected encapsulated document.

Document Type Fld¶

name: documentTypeFld, type: Enum, persistent: no¶: Display the found document type as enumerated value (‘PDF’, ‘CDA’, ‘STL’, ‘OBJ’, ‘MTL’, or ‘Unknown’ in case of unsupported or invalid document type).

Values:

Title	Name
Unknown	Unknown
Pdf	PDF
Cda	CDA
Stl	STL
Obj	OBJ
Mtl	MTL

File Name¶

name: fileName, type: String¶: Destination file name (without suffix) for the document content to be written.

Full File Name¶

name: fullFileName, type: String, persistent: no¶: Absolute name of saved file, filled with _fileNameFld + ‘.’ + suffix of document type.

Save Document¶

name: saveDocument, type: Trigger¶: If touched and tag content is valid, the document is saved in file given by _fileNameFld.

Show CDADump¶

name: showCDADump, type: Bool, default: FALSE¶: If enabled then, in case of CDA files, the cdaDump will display the CDA content as dump.

Cda Dump¶

name: cdaDump, type: String, persistent: no¶: Shows a dump of the a valid CDA file if dumping is enabled in showCDADump.

Hidden Fields¶

issues¶

name: issues, type: String, persistent: no¶

see MultiFileVolumeListBaseOutput.issues

updateBaseOutputInformationDone¶

name: updateBaseOutputInformationDone, type: Trigger¶

see MultiFileVolumeListBaseOutput.updateBaseOutputInformationDone

updateDOCOutputInformationDone¶

name: updateDOCOutputInformationDone, type: Trigger¶