Operator LinkProperties

Operator Library: Parameters

This operator offers read access to the properties of the connected link. The link properties are available as read-only operator parameters.

The benefit of this operator is that the reference and translate operators of the Parameters library can use the link parameters for incorporating them into formulas. For example, in some formulas you may need to incorporate the link parallelism; by using this operator, the parallelism can be detected. This way, the formulas can automatically adapt to the current link configuration.

A general introduction into library Parameters you find in Library Parameters.

[Important] Availability

To use the LinkProperties operator, you need either an Expert license, a Parameter Module license, or the VisualApplets 4 license.

I/O Properties

Property Value
Operator Type O
Input Link I, Image data input
Output Link O, Image data output

Supported Link Format

Link Parameter Input Link I Output Link O
Bit Width [1, 64]1 as I
Arithmetic {unsigned, signed} as I
Parallelism any as I
Kernel Columns any as I
Kernel Rows any as I
Img Protocol {VALT_IMAGE2D, VALT_LINE1D, VALT_PIXEL0D, VALT_SIGNAL} as I
Color Format any as I
Color Flavor any as I
Max. Img Width any as I
Max. Img Height any as I

1

The range of the input bit width is [1, 64]. For signed inputs, the range is [2, 64]. For unsigned color inputs, the range is [3, 63] and for signed color, the range is [6, 63].

Parameters

Protocol
Type static write parameter
Default VALT_IMAGE2D
Range {VALT_IMAGE2D,VALT_LINE1D,VALT_PIXEL0D,VALT_SIGNAL}

Allows access to link property Protocol. Possible values are VALT_IMAGE2D,VALT_LINE1D,VALT_PIXEL0D,VALT_SIGNAL.

ColorFormat
Type static write parameter
Default VAF_GRAY
Range {VAF_GRAY,VAF_COLOR,VAF_NONE,VAF_UNDEFINED}

Allows access to link property ColorFormat. Possible values are VAF_GRAY,VAF_COLOR,VAF_NONE,VAF_UNDEFINED.

ColorFlavor
Type static write parameter
Default FL_NONE
Range {FL_NONE,FL_RGB,FL_HSI,FL_YUV,FL_LAB,FL_XYZ,FL_HSL,FL_HSV,FL_YCrCb}

Allows access to link property ColorFlavor. Possible values are FL_NONE, FL_RGB, FL_HSI, FL_YUV, FL_LAB, FL_XYZ, FL_HSL, FL_HSV, FL_YCrCb.

Arithmetic
Type static write parameter
Default UNSIGNED
Range {SIGNED,UNSIGNED}

Allows access to link property Arithmetic. Possible values are SIGNED and UNSIGNED.

BitWidth
Type static write parameter
Default 1
Range

Allows access to link property BitWidth.

Parallelism
Type static write parameter
Default 1
Range

Allows access to link property Parallelism.

KernelRows
Type static write parameter
Default 1
Range

Allows access to link property KernelRows.

KernelColumns
Type static write parameter
Default 1
Range

Allows access to link property KernelColumns.

MaxImgWidth
Type static write parameter
Default 1024
Range

Allows access to link property MaxImgWidth.

MaxImgHeight
Type static write parameter
Default 1024
Range

Allows access to link property MaxImgHeight.