VTKInputInfos

MLModule
genre VTKAdapters
author MeVis Medical Solutions AG
package MeVisLab/VTK
dll MLVTKAdapters
definition MLVTKAdapters.def
see also Info, VTKOutputSelector
keywords status, input, information

Purpose

VTKInputInfos checks the connected module, if possible it reads some information from it, and then it shows values and settings from that module in the user interface. It is especially useful to get settings and information about VTK classes and objects which are not shown in their module interfaces.With simple field connections these parameters can easily be used to configure other modules. Note that values can be read only read from appropriate connected objects; from other objects they cannot be read and will be reset to defaults (typically 0).

Tips

Usually this module is useful to get some values (such as Scalar Range of a data set) and to connect the read values to another module which needs this information. Typically these connections are established with field connections in module networks.

Windows

Default Panel

../../../Modules/ML/MLVTKAdapters/mhelp/Images/Screenshots/VTKInputInfos._default.png

Input Fields

inputvtkObject

name: inputvtkObject, type: VTKObjectWrapper(MLBase)

A vtkObject or something derived from it.

Parameter Fields

Field Index

Actual Memory Size: Integer Is Primary Cell: Bool Piece: Integer
Bounds: Vector6 Join U: Integer Range Max (piecewiseFunctionRangeMax): Double
Cell Dimension: Integer Join V: Integer Range Max (colorTransferFunctionRangeMax): Double
Cell Type: String Length: Double Range Min (piecewiseFunctionRangeMin): Double
Center: Vector3 Matrix: Matrix Range Min (colorTransferFunctionRangeMin): Double
Clamping (piecewiseFunctionClamping): Integer Max Cell Size: Integer Release Data Flag: Integer
Clamping (colorTransferFunctionClamping): Integer Max Id: Integer Scalar Range: Vector2
Class Name A: String Maximum U: Double Scalar Size: Integer
Class Name W: String Maximum V: Double Scalar Type: String
Clockwise Ordering: Integer Maximum W: Double Scalar Type Max: Double
Connected Object Class: String Minimum U: Double Scalar Type Min: Double
Data Dimension: Integer Minimum V: Double Scale: Integer
Data Object Type: String Minimum W: Double Selected Object Class: String
Data Size: Integer MTime: Integer Size (size): Integer
Data Type Size: Integer Num Cells: Integer Size (piecewiseFunctionSize): Integer
dataType: String Num Consumers: Integer Size (colorTransferFunctionSize): Integer
Debug: Integer Num Edges: Integer Spacing: Vector3
deprecationFieldDoNotUse: Integer Num Faces: Integer Status: String
Derivatives Available: Integer Num Inputs: Integer Total Num Inputs: Integer
Dimension: Integer Num Items: Integer Twist U: Integer
Direction Cosines: Matrix Num Paths: Integer Twist V: Integer
Dragable: Integer Num Pieces: Integer Type: String
Element Component Size: Integer Num Points: Integer Values (piecewiseFunctionValues): String
Extent: IntVector6 Number Of Blocks: Integer Values (colorTransferFunctionValues): String
Extent Type: Integer Number Of Components: Integer Visibility: Integer
GetLength2: Double Number Of Data Sets: Integer XRange Max: Double
Ghost Level: Integer Number Of Groups: Integer XRange Min: Double
GlobalWarningDisplay: Integer Number Of Outputs: Integer YRange Max: Double
Has Meta Data: Integer Number Of Tuples: Integer YRange Min: Double
Is Explicit Cell: Bool Origin: Vector3 ZRange Max: Double
Is Linear: Bool Output Selector: Integer ZRange Min: Double
Is Numeric: Bool Pickable: Integer  

Visible Fields

Output Selector

name: idx, type: Integer, default: -1, minimum: -1, maximum: :field:`numberOfOutputs`

If < 0 then the information shall be read from the connected object itself. If >= 0 then the information is read from an output of the connected object if possible. The OutputSelector’th output is used if available, otherwise no information is read.

Status

name: status, type: String, persistent: no

Shows connection state.

Connected Object Class

name: connectedObjectClass, type: String, persistent: no

Name of the class connected to the input.

Selected Object Class

name: selectedObjectClass, type: String, persistent: no

Name of the class selected by idx.

Number Of Outputs

name: numberOfOutputs, type: Integer, persistent: no

Number of outputs or output ports in case of sources and algorithms.

Num Inputs

name: numberOfInputs, type: Integer, persistent: no

Number of Inputs of an algorithm or 0 if not available.

Total Num Inputs

name: totalNumberOfInputConnections, type: Integer, persistent: no

Total number of inputs of an algorithm or 0 if not available.

Release Data Flag

name: releaseDataFlag, type: Integer, persistent: no

ReleaseDataFlag of an algorithm or 0 if not available.

MTime

name: mTime, type: Integer, persistent: no

MTime of object or 0 if not available.

Debug

name: debug, type: Integer, persistent: no

Debug flag of object or 0 if not available.

GlobalWarningDisplay

name: globalWarningDisplay, type: Integer, persistent: no

GlobalWarningDisplay flag of object or 0 if not available.

Class Name A

name: classNameA, type: String, persistent: no

ClassNameA of object or ‘’ if not available.

Class Name W

name: classNameW, type: String, persistent: no

ClassNameW of object or ‘’ if not available.

Data Object Type

name: dataObjectType, type: String, persistent: no

Type of data object or 0 if not available:

  • 0 VTK_POLY_DATA
  • 1 VTK_STRUCTURED_POINTS
  • 2 VTK_STRUCTURED_GRID
  • 3 VTK_RECTILINEAR_GRID
  • 4 VTK_UNSTRUCTURED_GRID
  • 5 VTK_PIECEWISE_FUNCTION
  • 6 VTK_IMAGE_DATA
  • 7 VTK_DATA_OBJECT
  • 8 VTK_DATA_SET
  • 9 VTK_POINT_SET
  • 10 VTK_UNIFORM_GRID
  • 11 VTK_COMPOSITE_DATA_SET
  • 12 VTK_MULTIGROUP_DATA_SET
  • 13 VTK_MULTIBLOCK_DATA_SET
  • 14 VTK_HIERARCHICAL_DATA_SET
  • 15 VTK_HIERARCHICAL_BOX_DATA_SET
  • 16 VTK_GENERIC_DATA_SET
  • 17 VTK_HYPER_OCTREE
  • 18 VTK_TEMPORAL_DATA_SET
  • 19 VTK_TABLE
  • 20 VTK_GRAPH
  • 21 VTK_TREE
  • 22 VTK_SELECTION
  • 23 VTK_DIRECTED_GRAPH
  • 24 VTK_UNDIRECTED_GRAPH
  • 25 VTK_MULTIPIECE_DATA_SET
  • 26 VTK_DIRECTED_ACYCLIC_GRAPH
  • 27 VTK_ARRAY_DATA
  • 28 VTK_REEB_GRAPH
  • 29 VTK_UNIFORM_GRID_AMR
  • 30 VTK_NON_OVERLAPPING_AMR
  • 31 VTK_OVERLAPPING_AMR
  • 32 VTK_HYPER_TREE_GRID
  • 33 VTK_MOLECULE
  • 34 VTK_PISTON_DATA_OBJECT
  • 35 VTK_PATH
  • 36 VTK_UNSTRUCTURED_GRID_BASE

Extent Type

name: extentType, type: Integer, persistent: no

Extent type of object or 0 if not available: * 0 = VTK_PIECES_EXTENT 0 * 1 = VTK_3D_EXTENT 1

Scalar Range

name: scalarRange, type: Vector2, persistent: no

The scalar range of the object values or 0 0 if not available.

Scalar Type

name: scalarType, type: String, persistent: no

Type of scalar data object or 0 if not available:

  • 0 = VTK_VOID
  • 1 = VTK_BIT
  • 2 = VTK_CHAR
  • 3 = VTK_UNSIGNED_CHAR
  • 4 = VTK_SHORT
  • 5 = VTK_UNSIGNED_SHORT
  • 6 = VTK_INT
  • 7 = VTK_UNSIGNED_INT
  • 8 = VTK_LONG
  • 9 = VTK_UNSIGNED_LONG
  • 10 = VTK_FLOAT
  • 11 = VTK_DOUBLE
  • 12 = VTK_ID_TYPE
  • 13 = VTK_STRING
  • 14 = VTK_OPAQUE
  • 15 = VTK_SIGNED_CHAR
  • 16 = VTK_LONG_LONG
  • 17 = VTK_UNSIGNED_LONG_LONG
  • 18 = VTK___INT64
  • 19 = VTK_UNSIGNED___INT64

Data Dimension

name: dataDimension, type: Integer, persistent: no

Dimension of data or file or 0 if not available.

Num Points

name: numberOfPoints, type: Integer, persistent: no

Number of points in object or 0 if not available.

Num Items

name: numberOfItems, type: Integer, persistent: no

Number of items in a collection or 0 if not available.

Num Cells

name: numberOfCells, type: Integer, persistent: no

Number of cells in object or 0 if not available.

Length

name: length, type: Double, persistent: no

Length of object or 0 if not available.

Bounds

name: bounds, type: Vector6, persistent: no

Bound of object or 0 0 0 0 0 0 if not available.

Center

name: center, type: Vector3, persistent: no

Center of object or 0 0 0 if not available.

Spacing

name: spacing, type: Vector3, persistent: no

Size/spacing of image data voxels or 0 0 0 if not available.

Origin

name: origin, type: Vector3, persistent: no

Position of the origin voxel or 0 0 0 if not available. The voxel origin is considered in the voxel center.

Direction Cosines

name: dirCosines, type: Matrix, persistent: no

Direction cosines provided by some readers or 0 matrix if not available.

Extent

name: ext, type: IntVector6, persistent: no

(Data) Extent of image or 0 0 0 0 0 0 if not available.

Max Cell Size

name: maxCellSize, type: Integer, persistent: no

Maximum cell size of object or 0 if not available.

Actual Memory Size

name: actualMemorySize, type: Integer, persistent: no

Actual memory size of object or 0 if not available.

Piece

name: piece, type: Integer, persistent: no

Piece of object or 0 if not available.

Num Pieces

name: numberOfPieces, type: Integer, persistent: no

Number of pieces in object or 0 if not available.

Ghost Level

name: ghostLevel, type: Integer, persistent: no

Ghost level of object or 0 if not available.

Cell Type

name: cellType, type: String, persistent: no

Cell type of a cell object or 0 if not available.

  • VTK_EMPTY_CELL 0
  • VTK_VERTEX 1
  • VTK_POLY_VERTEX 2
  • VTK_LINE 3
  • VTK_POLY_LINE 4
  • VTK_TRIANGLE 5
  • VTK_TRIANGLE_STRIP 6
  • VTK_POLYGON 7
  • VTK_PIXEL 8
  • VTK_QUAD 9
  • VTK_TETRA 10
  • VTK_VOXEL 11
  • VTK_HEXAHEDRON 12
  • VTK_WEDGE 13
  • VTK_PYRAMID 14
  • VTK_PENTAGONAL_PRISM 15
  • VTK_HEXAGONAL_PRISM 16

// Quadratic, isoparametric cells

  • VTK_QUADRATIC_EDGE 21
  • VTK_QUADRATIC_TRIANGLE 22
  • VTK_QUADRATIC_QUAD 23
  • VTK_QUADRATIC_TETRA 24
  • VTK_QUADRATIC_HEXAHEDRON 25
  • VTK_QUADRATIC_WEDGE 26
  • VTK_QUADRATIC_PYRAMID 27
  • VTK_BIQUADRATIC_QUAD 28
  • VTK_TRIQUADRATIC_HEXAHEDRON 29
  • VTK_QUADRATIC_LINEAR_QUAD 30
  • VTK_QUADRATIC_LINEAR_WEDGE 31
  • VTK_BIQUADRATIC_QUADRATIC_WEDGE 32
  • VTK_BIQUADRATIC_QUADRATIC_HEXAHEDRON 33
  • VTK_BIQUADRATIC_TRIANGLE 34

// Cubic, isoparametric cell

  • VTK_CUBIC_LINE 35

// Special class of cells formed by convex group of points

  • #define VTK_CONVEX_POINT_SET 41

// Higher order cells in parametric form

  • VTK_PARAMETRIC_CURVE 51
  • VTK_PARAMETRIC_SURFACE 52
  • VTK_PARAMETRIC_TRI_SURFACE 53
  • VTK_PARAMETRIC_QUAD_SURFACE 54
  • VTK_PARAMETRIC_TETRA_REGION 55
  • VTK_PARAMETRIC_HEX_REGION 56

// Higher order cells

  • VTK_HIGHER_ORDER_EDGE 60
  • VTK_HIGHER_ORDER_TRIANGLE 61
  • VTK_HIGHER_ORDER_QUAD 62
  • VTK_HIGHER_ORDER_POLYGON 63
  • VTK_HIGHER_ORDER_TETRAHEDRON 64
  • VTK_HIGHER_ORDER_WEDGE 65
  • VTK_HIGHER_ORDER_PYRAMID 66
  • VTK_HIGHER_ORDER_HEXAHEDRON 67

Cell Dimension

name: cellDimension, type: Integer, persistent: no

Cell dimension of a cell object or 0 if not available.

Num Edges

name: numberOfEdges, type: Integer, persistent: no

Number of edges of a cell object or 0 if not available.

Num Faces

name: numberOfFaces, type: Integer, persistent: no

Number of faces of a cell object or 0 if not available.

Is Explicit Cell

name: isExplicitCell, type: Bool, persistent: no

Non zero if a cell object is explicit or 0 if not or not available.

Is Linear

name: isLinear, type: Bool, persistent: no

Non zero if a cell object is linear or 0 if not or not available.

Is Primary Cell

name: isPrimaryCell, type: Bool, persistent: no

Non zero if a cell object is primary or 0 if not or not available.

Num Paths

name: numberOfPaths, type: Integer, persistent: no

Number of paths in a vtkProp or 0 if not available.

Num Consumers

name: numberOfConsumers, type: Integer, persistent: no

Number of consumers of a vtkProp or 0 if not available.

Visibility

name: visibility, type: Integer, persistent: no

Non zero if vtkProp is visible or 0 if not available.

Pickable

name: pickable, type: Integer, persistent: no

Non zero if vtkProp is pickable or 0 if not available.

Dragable

name: dragable, type: Integer, persistent: no

Non zero if vtkProp is dragable or 0 if not available.

Matrix

name: matrix, type: Matrix, persistent: no

Matrix of a vtkProp or 0 matrix if not available.

XRange Min

name: xRangeMin, type: Double, persistent: no

Minimum of XRange or 0 if not available.

YRange Min

name: yRangeMin, type: Double, persistent: no

Minimum of YRange or 0 if not available.

ZRange Min

name: zRangeMin, type: Double, persistent: no

Minimum of ZRange or 0 if not available.

XRange Max

name: xRangeMax, type: Double, persistent: no

Maximum of XRange or 0 if not available.

YRange Max

name: yRangeMax, type: Double, persistent: no

Maximum of YRange or 0 if not available.

ZRange Max

name: zRangeMax, type: Double, persistent: no

Maximum of ZRange or 0 if not available.

Is Numeric

name: isNumeric, type: Bool, persistent: no

1 if a vtkArray is a numeric array or 0 if not or not available.

Data Size

name: dataSize, type: Integer, persistent: no

Total number of components of a vtkArray or 0 if not available.

Data Type Size

name: dataTypeSize, type: Integer, persistent: no

Size of data type of a vtkArray or 0 if not available.

Element Component Size

name: elementComponentSize, type: Integer, persistent: no

Size of a single component in a tuple of a vtkArray or 0 if not available.

Max Id

name: maxId, type: Integer, persistent: no

Maximum id of a vtkArray or 0 if not available.

Number Of Components

name: numberOfComponents, type: Integer, persistent: no

Number of (array) or data components or 0 if not available.

Number Of Tuples

name: numberOfTuples, type: Integer, persistent: no

Number of tuples in a vtkArray or 0 if not available.

Size (size)

name: size, type: Integer, persistent: no

Total number of all components in all tuples or 0 if not available.

Dimension

name: dimension, type: Integer, persistent: no

The dimension of the parametric function or 0 if not available.

Minimum U

name: minimumU, type: Double, persistent: no

The minimumU value or 0 if not available.

Minimum V

name: minimumV, type: Double, persistent: no

The minimumV value or 0 if not available.

Minimum W

name: minimumW, type: Double, persistent: no

The minimumW value or 0 if not available.

Maximum U

name: maximumU, type: Double, persistent: no

The maximumU value or 0 if not available.

Maximum V

name: maximumV, type: Double, persistent: no

The maximumV value or 0 if not available.

Maximum W

name: maximumW, type: Double, persistent: no

The maximumW value or 0 if not available.

Join U

name: joinU, type: Integer, persistent: no

The joinU value or 0 if not available.

Join V

name: joinV, type: Integer, persistent: no

The joinV value or 0 if not available.

Twist U

name: twistU, type: Integer, persistent: no

The twistU value or 0 if not available.

Twist V

name: twistV, type: Integer, persistent: no

The twistV value or 0 if not available.

Clockwise Ordering

name: clockwiseOrdering, type: Integer, persistent: no

1 if the parametric function is clockwisely ordered or 0 if not or not available.

Derivatives Available

name: derivativesAvailable, type: Integer, persistent: no

1 if the parametric function has derivatives or 0 if not or not available.

Number Of Blocks

name: numberOfBlocks, type: Integer, persistent: no

Number of blocks in the multi block data set or 0 if not available.

Number Of Groups

name: numberOfGroups, type: Integer, persistent: no

Number of groups in the multi groups data set or 0 if not available.

Number Of Data Sets

name: numberOfDataSets, type: Integer, persistent: no

Number of data sets in the first group in the multi groups data set or 0 if not available.

Has Meta Data

name: hasMetaData, type: Integer, persistent: no

Only in future versions, still unused: True (!=0) if the first block has meta data or 0 if not available.

Scalar Size

name: scalarSize, type: Integer, persistent: no

The size of the scalar type or 0 if not available.

Scalar Type Min

name: scalarTypeMin, type: Double, persistent: no

The minimum value the scalar type can hold without overflow or 0 if not available.

Scalar Type Max

name: scalarTypeMax, type: Double, persistent: no

The maximum value the scalar type can hold without overflow or 0 if not available.

Size (piecewiseFunctionSize)

name: piecewiseFunctionSize, type: Integer, persistent: no

Number of data pairs or 0 if not available.

Type

name: piecewiseFunctionType, type: String, persistent: no

Function type or empty if not available.

Range Min (piecewiseFunctionRangeMin)

name: piecewiseFunctionRangeMin, type: Double, persistent: no

Range minimum of function or 0 if not available.

Range Max (piecewiseFunctionRangeMax)

name: piecewiseFunctionRangeMax, type: Double, persistent: no

Range maximum of function or 0 if not available.

Clamping (piecewiseFunctionClamping)

name: piecewiseFunctionClamping, type: Integer, persistent: no

0 if clamping is off, something else if on.

Values (piecewiseFunctionValues)

name: piecewiseFunctionValues, type: String, persistent: no

(X,Value) pairs or empty if not available.

Size (colorTransferFunctionSize)

name: colorTransferFunctionSize, type: Integer, persistent: no

Number of data pairs or 0 if not available.

Range Min (colorTransferFunctionRangeMin)

name: colorTransferFunctionRangeMin, type: Double, persistent: no

Range minimum of function or 0 if not available.

Range Max (colorTransferFunctionRangeMax)

name: colorTransferFunctionRangeMax, type: Double, persistent: no

Range maximum of function or 0 if not available.

Clamping (colorTransferFunctionClamping)

name: colorTransferFunctionClamping, type: Integer, persistent: no

0 if clamping is off, something else if on.

Scale

name: colorTransferFunctionScale, type: Integer, persistent: no

Scale type, linear or logarithmic or 0 if not available.

Values (colorTransferFunctionValues)

name: colorTransferFunctionValues, type: String, persistent: no

(X,Value) pairs or empty if not available.

Hidden Fields

GetLength2

name: GetLength2, type: Double, persistent: no

dataType

name: dataType, type: String, persistent: no

Data type of a vtkArray or 0 if not available. Data types are

  • 0 = VTK_VOID
  • 1 = VTK_BIT
  • 2 = VTK_CHAR
  • 3 = VTK_UNSIGNED_CHAR
  • 4 = VTK_SHORT
  • 5 = VTK_UNSIGNED_SHORT
  • 6 = VTK_INT
  • 7 = VTK_UNSIGNED_INT
  • 8 = VTK_LONG
  • 9 = VTK_UNSIGNED_LONG
  • 10 = VTK_FLOAT
  • 11 = VTK_DOUBLE
  • 12 = VTK_ID_TYPE
  • 13 = VTK_STRING
  • 14 = VTK_OPAQUE
  • 15 = VTK_SIGNED_CHAR
  • 16 = VTK_LONG_LONG
  • 17 = VTK_UNSIGNED_LONG_LONG
  • 18 = VTK___INT64
  • 19 = VTK_UNSIGNED___INT64
  • 20 = VTK_VARIANT
  • 21 = VTK_OBJECT
  • 22 = VTK_UNICODE_STRING

deprecationFieldDoNotUse

name: deprecationFieldDoNotUse, type: Integer, default: 0, deprecated name: numberOfParts