ExtractObjectFromList

MLModule
genre Fields
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll MLBase
definition MLBase.def
see also DecomposeBaseList, ComposeBaseList, Counter
keywords Base, BaseList, ListBase, decompose, split, subtract, divide

Purpose

The module ExtractObjectFromList extracts objects from a list derived from ml.BaseList (for example a XMarkerList) identifying them via search parameters (currently only the index in the list).

Its functionality is sort of similar to DecomposeBaseList, but the lists the ExtractObjectFromList module can handle hold only objects of the same type.

Usage

Connect an object derived from ml.BaseList to the input and specify search parameters for the object you want to extract. Verify that the output is valid and connect the output to the operator where the object is needed.

Windows

Default Panel

../../../Modules/ML/MLBase/mhelp/Images/Screenshots/ExtractObjectFromList._default.png

Input Fields

The module has one base input that must be connected to a valid object derived from ml.BaseList. If the input object has an incorrect type, the fied Input list valid will be unchecked and the module will not work.

inList

name: inList, type: MLBase, deprecated name: inBaseList

Output Fields

The module has one output holding the extracted object.

outObject

name: outObject, type: MLBase, deprecated name: outputExtractedObject

Parameter Fields

Visible Fields

Index in Input List

name: posToFind, type: Integer, default: 1

Sets a positive integer k to obtain the element at position k in the filtered list (starting with 1!). Enter a negative integer -k to obtain the element at position (sizeOfInputList - k + 1).

For example, to always obtain the last element of the input list, you have to specify -1 here.

Number of Elements in Input List

name: inputSize, type: Integer, persistent: no

Shows the number of items in the input list.

Input list valid

name: inputValid, type: Bool, persistent: no

Shows whether the input list is valid.

Output valid

name: objectValid, type: Bool, persistent: no

Shows whether the output list is valid.