DecomposeBaseList

MLModule

genre	Fields
status	stable
author	Jan-Martin Kuhnigk
package	MeVisLab/Standard
dll	MLBase
definition	MLBase.def
see also	ComposeBaseList, ExtractObjectFromList, SaveBase, LoadBase
keywords	Base, BaseList, object, list, decompose, split, subtract, divide

Purpose

The module DecomposeBaseList is the counterpart to ComposeBaseList. It allows to extract objects previously composed to (using ComposeBaseList) from ml::BaseList structures identifying them via name, type or id.

A similar module is ExtractObjectFromList, but it can only extract objects from "ordinary" lists that can only hold objects of a single type.

Usage

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

Windows

Default Panel

Input Fields

inList

name: inList, type: MLBase, deprecated name: inputBaseList

The module has one base input that must be connected to a BaseList object. If the input object has incorrect type, the field Input List Valid will be shown as being disabled and the operator will not work.

Output Fields

The module has two base outputs. The outObject holds the extracted object or a null pointer if the search was unsuccessful. The outList always contains a BaseList object holding the rest of the elements from the input list.

Note that this is not the filtered list but simply the input list without the extracted object.

outObject

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

outList

name: outList, type: MLBase, deprecated name: outputRestList

Parameter Fields

Field Index

Filter by ID: Bool	Look for (nameToFind): String
Filter by Name: Bool	Look for (typeToFind): String
Filter by Type: Bool	Number of Elements in Input List: Integer
Global List Index: Integer	objectFound: Bool
Index in Filtered List (starting with 1, negative for reversed order): Integer	Output Valid: Bool
Input List Valid: Bool
Items Found: Integer
Look for (idToFind): Integer

Visible Fields

Filter by ID

name: useId, type: Bool, default: FALSE

If checked, an ID (a positive integer) can be specified in Look for for filtering the items of the input list by their ID. Only an item whose ID is exactly like the one specified here will pass this filter.

Filter by Name

name: useName, type: Bool, default: FALSE

If checked, a string in Look for can be specified for filtering the items of the input list by their names. Only the items whose name contain the specified string as a sub-string will pass this filter. Note that the search is case-sensitive.

Filter by Type

name: useType, type: Bool, default: FALSE

If checked, a string in Look for can be specified for filtering the items of the input list by their type names. Only an item whose type name contains the specified string as a sub-string will pass this filter. Note that the search is case-sensitive.

Look for (idToFind)

name: idToFind, type: Integer, default: 0

If Filter by ID is checked, the object with the given id is filtered.

Look for (nameToFind)

name: nameToFind, type: String

If Filter by Name is checked, the objects with the given name (substring, case-sensitive) is filtered.

Look for (typeToFind)

name: typeToFind, type: String

If Filter by Type is checked, the objects with the given type (substring, case-sensitive) is filtered.

Index in Filtered List (starting with 1, negative for reversed order)

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 (sizeOfFilteredList - k + 1).

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

Global List Index

name: outPos, type: Integer, default: 1

Shows the position of the output object with reference to the input list.

Number of Elements in Input List

name: inputSize, type: Integer, default: 0

Shows the number of elements in the input list.

Input List Valid

name: inputValid, type: Bool, default: FALSE

Shows whether the input list is valid.

Output Valid

name: objectValid, type: Bool, default: FALSE

Shows whether the output list is valid.

Items Found

name: itemsFound, type: Integer, default: 0, deprecated name: noItemsFound

Shows the number of filtered items.

Hidden Fields

objectFound

name: objectFound, type: Bool, default: FALSE