Purpose

MultiFileVolumeListSEGOutput is dedicated to display contents of MultiFileVolumes which contain DICOM segments. It tries to determine indexes to other volumes in the possibly connected MultiFileVolumeList, which may be the source image for the currently selected segment. It has outputs where the currently selected image or segment can be taken from, and tabs which show the corresponding segment and image information. It also provides configurable input settings and connector to get access to MultiFileVolumes from different sources; the typical way is to use the inputAccessConnector with enabled Use Base Input as source where a DirectDicomImport module is connected which has imported a list of volumes and possible SEG modality data.

Important: It is recommended that the used MultiFileVolumeList is built in such a way that it only contains one segment per volume. This usually can be configured with appropriate settings in, for example, DirectDicomImport. MultiFileVolumeListSEGOutput is built that it expects one DICOM segment per volume.

Windows

Default Panel

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

Input Fields

inputAccessConnector

name: inputAccessConnector, type: MLBase

see MultiFileVolumeListImageOutput.inputAccessConnector

inputMessageFilterPlugin

name: inputMessageFilterPlugin, type: MLBase

see MultiFileVolumeListImageOutput.inputMessageFilterPlugin

Output Fields

output0

name: output0, type: Image

If the currently selected volume is of an image type then the ML image representation of that volume is provided at this connector, even if it is not a DICOM segmentation. It will be invalid if the imported volume is not of an image type or if it is invalid for other reasons. A valid DICOM segmentation at the output is indicated by a value >= 1 in Segment Number.

see also MultiFileVolumeListImageOutput.output0

output1

name: output1, type: Image

see MultiFileVolumeListImageOutput.output1

outputCurrentSegmentTree

name: outputCurrentSegmentTree, type: MLBase

The entry of the Segment Sequence (0062,0002) corresponding to the currently selected segment volume or an empty DCMTree if invalid. Note that the DCMTree at this connector is only a section of a larger DCMTree and does not represent a valid DICOM object.

outputAccessConnector

name: outputAccessConnector, type: MLBase

see MultiFileVolumeListBaseOutput.outputAccessConnector

Parameter Fields

Visible Fields

Use Base Input

name: useBaseInput, type: Bool, default: TRUE

see MultiFileVolumeListImageOutput.useBaseInput

Load Result Cache

name: loadResultCache, type: Trigger

Loads a volume list from cached result volume.

see also MultiFileVolumeListImageOutput.loadResultCache

Auto Load Result Cache

name: autoLoadResultCache, type: Bool, default: FALSE

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

see also MultiFileVolumeListImageOutput.autoLoadResultCache

Cache File Path

name: cacheFilePath, type: String

File containing a list of cached image volumes.

see also MultiFileVolumeListImageOutput.cacheFilePath

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, output0, output1, and outputCurrentSegmentTree.

see also MultiFileVolumeListImageOutput.outVolIdx

Number of volumes

name: numVolumes, type: Integer, default: 0

This read-only field shows number of available volumes.

see also MultiFileVolumeListImageOutput.numVolumes

Volume Info Dump

name: volumeInfoDump, type: String, persistent: no

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

see also MultiFileVolumeListImageOutput.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, too short values clamp the tag dump at the specified number of tags; this is typically indicated with “… tag list shortened and not shown completely” at the end of the dump.

see also MultiFileVolumeListImageOutput.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 MultiFileVolumeListImageOutput.dumpPrivateTagValues

Num shown binary bytes

name: numShownBinaryEntries, type: Integer, default: 8

Number of shown entries of binary tags.

see also MultiFileVolumeListImageOutput.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 MultiFileVolumeListImageOutput.annotate

Filter

name: regExLineFilter, type: String

see 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 MultiFileVolumeListImageOutput.tagDump

Ext X

name: extX, type: Integer, default: 0

This read-only field shows the x-extent of the currently selected volume.

see also MultiFileVolumeListImageOutput.extX

Ext Y

name: extY, type: Integer, default: 0

This read-only field shows the y-extent of the currently selected volume.

see also MultiFileVolumeListImageOutput.extY

Ext Z

name: extZ, type: Integer, default: 0

This read-only field shows the z-extent of the currently selected volume.

see also MultiFileVolumeListImageOutput.extZ

Ext C

name: extC, type: Integer, default: 0

This read-only field shows the color-extent of the currently selected volume.

see also MultiFileVolumeListImageOutput.extC

Ext T

name: extT, type: Integer, default: 0

This read-only field shows the time-extent of the currently selected volume.

see also MultiFileVolumeListImageOutput.extT

Ext U

name: extU, type: Integer, default: 0

This read-only field shows the u-extent of the currently selected volume.

see also MultiFileVolumeListImageOutput.extU

Num Vol Voxels

name: numVolVoxels, type: Integer, default: 0

This read-only field shows number of voxels of the currently selected volume.

see also MultiFileVolumeListImageOutput.numVolVoxels

Data Type

name: dataType, type: String

This read-only field contains the voxel data type of the currently selected volume.

see also MultiFileVolumeListImageOutput.dataType

Min Vox Val

name: minVoxVal, type: Double, default: 0

This read-only field shows the minimum voxel value in the currently selected volume.

see also MultiFileVolumeListImageOutput.minVoxVal

Max Vox Val

name: maxVoxVal, type: Double, default: 0

This read-only field shows the maximum voxel value in the currently selected volume.

see also MultiFileVolumeListImageOutput.maxVoxVal

First Volume Index Derived From

name: firstVolumeIndexDerivedFrom, type: Integer, persistent: no

The module tries to determine the volume(s) (or to be more precise: the frames) from which the image has been derived. If this or these volumes are also part of the volume list connected to the input of this module, then First Volume Index Derived From shows the volume index of the first of these volumes. Note that no, one or multiple of such volumes can exist. The default is -1 if no volume has been found. See also Volume Indexes Derived From.

see also MultiFileVolumeListImageOutput.firstVolumeIndexDerivedFrom

Volume Indexes Derived From

name: volumeIndexesDerivedFrom, type: String, persistent: no

As described for First Volume Index Derived From the module tries to determine the volume(s) (or to be more precise: the frames) from which the image has been derived. If this or these volumes are also part of the volume list connected to the input of this module, then Volume Indexes Derived From shows a space separated list of all these volumes. The default is empty if no volume has been found. See also First Volume Index Derived From.

see also MultiFileVolumeListImageOutput.volumeIndexesDerivedFrom

First Shared Frame Of Reference Volume Index

name: firstSharedFrameOfReferenceVolumeIndex, type: Integer, persistent: no

The module tries to determine the volume(s) (or to be more precise: the frames) which share the same FrameOfReferenceUID. If this or these volumes are also part of the volume list connected to the input of this module, then First Shared Frame Of Reference Volume Index shows the volume index of the first of these volumes. Note that no, one or multiple of such volumes can exist. The default is -1 if no volume has been found. See also Shared Frame Of Reference Volume Indexes.

see also MultiFileVolumeListImageOutput.firstSharedFrameOfReferenceVolumeIndex

Shared Frame Of Reference Volume Indexes

name: sharedFrameOfReferenceVolumeIndexes, type: String, persistent: no

As described for First Shared Frame Of Reference Volume Index the module tries to determine the volume(s) (or to be more precise: the frames) which share the same FrameOfReferenceUID. If this or these volumes are also part of the volume list connected to the input of this module, then Shared Frame Of Reference Volume Indexes shows a space separated list of all these volumes. The default is empty if no volume has been found. See also First Shared Frame Of Reference Volume Index.

see also MultiFileVolumeListImageOutput.sharedFrameOfReferenceVolumeIndexes

Info

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

Shows a collection of important overview information about the currently selected SEG volume.

Segmentation Type

name: segmentationType, type: String, persistent: no

Output field to provide the value of Segmentation Type tag (0062,0001) of currently selected volume or empty if invalid or empty.

Segmentation Fractional Type

name: segmentationFractionalType, type: String, persistent: no

Output field to provide the value of Segmentation Fractional Type tag (0062,0010) of currently selected volume or empty if invalid or empty.

Maximum Fractional Value

name: maximumFractionalValue, type: String, persistent: no

Output field to provide the value of Maximum Fractional Value tag (0062,000E) of currently selected volume or empty if invalid or empty.

Is Valid Fractional Segmentation

name: isValidFractionalSegmentation, type: Bool, persistent: no

True if the currently selected volume is a Segmentation object of Segmentation Type FRACTIONAL, otherwise false.

Content Label

name: contentLabel, type: String, persistent: no

Output field to provide the value of Content Label tag (0070,0080) of currently selected volume or empty if invalid or empty.

Content Description

name: contentDescription, type: String, persistent: no

Output field to provide the value of Content Description tag (0070,0081) of currently selected volume or empty if invalid or empty.

Content Creators Name

name: contentCreatorsName, type: String, persistent: no

Output field to provide the value of Content Creators’s Name tag (0070,0084) of currently selected volume or empty if invalid or empty.

Derivation Description

name: derivationDescription, type: String, persistent: no

Output field to provide the value of Derivation Description tag (0008,2111) of currently selected volume or empty if invalid or empty.

Referenced Segment Number

name: referencedSegmentNumber, type: Integer, persistent: no

The value of the tag Referenced Segment Number (0062,000B) in the DICOM tags of the currently selected segment volume or -1 if invalid.

Segment Number

name: segmentNumber, type: Integer, persistent: no

The value of the tag Segment Number (0062,0004) in the DICOM tags of the currently selected segment volume or -1 if invalid. A valid DICOM segmentation at output0 is indicated by a value >= 1.

Segment Label

name: segmentLabel, type: String, persistent: no

The value of the tag Segment Label (0062,0005) in the DICOM tags of the currently selected segment volume or empty if invalid.

Segment Description

name: segmentDescription, type: String, persistent: no

The value of the tag Segment Description (0062,0006) in the DICOM tags of the currently selected segment volume or empty if invalid.

Segment Algorithm Type

name: segmentAlgorithmType, type: String, persistent: no

The value of the tag Segment Algorithm Type (0062,0008) in the DICOM tags of the currently selected segment volume or empty if invalid.

Segment Algorithm Name

name: segmentAlgorithmName, type: String, persistent: no

The value of the tag Segment Algorithm Name (0062,0009) in the DICOM tags of the currently selected segment volume or empty if invalid.

Rgb Out

name: rgbOut, type: Color, persistent: no

This is an Red/Green/Blue value triple where each color channel is normalized to [0,1]. It is converted from the values of the tag Recommended Display CIELab Value in the DICOM tags of the currently selected segment volume or is (1,1,1) if invalid. Be aware that this RGB value conversion is only an approximation of intended the CIELab color and should usually not be used for color display of segments. The value of the Recommended Display CIELab Value should be converted with a dedicated converter which takes into account the monitor, display, and perception settings of the current setup.

Color Fields Are Valid

name: rgbAndCIELabValueValid, type: Bool, persistent: no

Enabled if the values of Recommended Display CIELab Value and Rgb Out are valid values from the currently selected segment volume, otherwise disabled.

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 MultiFileVolumeListImageOutput.updateBaseOutputInformationDone

updateImageOutputInformationDone

name: updateImageOutputInformationDone, 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 MultiFileVolumeListImageOutput.updateImageOutputInformationDone

updateSEGOutputInformationDone

name: updateSEGOutputInformationDone, 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.