Operator ImageStatistics

Operator Library: Debugging

Operator ImageStatistics measures frame properties for whole frame sequences without touching the image data.

[Important] Availability

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

Operator ImageStatistics analyzes image sequences. For analyzing individual images, use operator Operator ImageAnalyzer.

The operator allows to analyze deviations between frames (width, height, size, line gaps, etc.). The operator also provides measurands regarding line rates and frame rates.

In addition, operator ImageStatistics provides data about the utilization of the pipeline capacity (valid fraction, idle fraction, blocked fraction of time in percent).

When an internal counter overflows, a corresponding overflow bit is set in the OverflowMask parameter and the counter halts.

[Important] Runtime Testing

This operator is designed for testing and analyzing your design during runtime: You need to build (synthesize) the design, load it onto the target hardware, and start actual image processing, before you can use the operator for debugging.

The operator is not intended for design simulation within VisualApplets.

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] 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} as I
Color Format any as I
Color Flavor any as I
Max. Img Width any as I
Max. Img Height any as I

Parameters

ClearMode
Type dynamic write parameter
Default ClearWithProcessStart
Range {NoClearing, ClearWithProcessStart, ClearWithProcessReset, SendClearPulse}

This parameter defines the reset behavior for all read parameters.

NoClearing: Values of all read parameters are held. ProcessEnable and ProcessReset have no influcence on these values.

ClearWithProcessStart: Values of read parameters are only cleared with rising edge of ProcessEnable.

ClearWithProcessReset: Values of read parameters are only cleared with rising edge of ProcessReset.

SendClearPulse: On-demand clearing of all read parameter values.

MeasurementPeriod
Type dynamic read parameter
Default 1000
Range [1, 65535]

Time in milliseconds for rate and duty cycle measurements. .

FrameCountWidth
Type static write parameter
Default 24
Range [4, 63]

Sets the bit width of the frame counter (parameter FrameCount).

GapCountWidth
Type static write parameter
Default 20
Range [4, 63]

Sets the bit width of the line gap counters (MinLineGap, MaxLineGap, MeanLineGap, MinLinePeriod, MaxLinePeriod, MeanLinePeriod).

FrameCount
Type dynamic read parameter
Default 0
Range [0, (2^FrameCountWidth) -1]

Counts all images which are terminated with an EndOfFrame. Available only in IMAGE-2D mode.

FramePixelCount
Type dynamic read parameter
Default 0
Range [0, (2^ (ImageWidthBitwidth+ImageHeightBitwidth+4))-1]

Size of the last completed frame in pixels.

MinWidth
Type dynamic read parameter
Default 0
Range [0, (2^(ImageWidthBitwidth+4))-1]

Minimal line width detected in all frames inspected so far (in pixels).

MaxWidth
Type dynamic read parameter
Default 0
Range [0, (2^(ImageWidthBitwidth+4))-1]

Maximal line width detected in all frames inspected so far (in pixels).

MinHeight
Type dynamic read parameter
Default 0
Range [0, (2^(ImageHeightBitwidth+4))-1]

Minimal image height detected in all frames inspected so far (in pixels).

MaxHeight
Type dynamic read parameter
Default 0
Range [0, (2^(ImageHeightBitwidth+4))-1]

Maximal image height detected in all frames inspected so far (in pixels).

MinPixelCount
Type dynamic read parameter
Default 0
Range [0, (2^(ImageWidthBitwidth+ImageHeightBitwidth+4))-1]

Size of smallest frame out of all frames inspected so far (in pixels).

MaxPixelCount
Type dynamic read parameter
Default 0
Range [0, (2^(ImageWidthBitwidth+ImageHeightBitwidth+4))-1]

Size of biggest frame out of all frames inspected so far (in pixels).

MinLineGap
Type dynamic read parameter
Default 0
Range [0, (2^GapCountWidth)-1]

Minimal line gap encountered in all frames inspected so far. Does not include the frame gap between the last line of a 2D image and the first line of the next image.

MaxLineGap
Type dynamic read parameter
Default 0
Range [0, (2^GapCountWidth)-1]

Maximal line gap encountered encountered in all frames inspected so far. Does not include the frame gap between the last line of a 2D image and the first line of the next image.

MinLinePeriod
Type dynamic read parameter
Default 0
Range [0, (2^GapCountWidth)-1]

Minimal line period encountered. A Line period is the number of clock cycles between two line beginnings. A line period thus covers the line width, a single EndOfLine pulse, and the line gap. The frame gap between the last line of a 2D image and the first line of the next image is not included.

MaxLinePeriod
Type dynamic read parameter
Default 0
Range [0, (2^GapCountWidth)-1]

Maximal line period encountered. A Line period is the number of clock cycles between two line beginnings. A line period thus covers the line width, a single EndOfLine pulse, and the line gap. The frame gap between the last line of a 2D image and the first line of the next image is not included.

MeanWidth
Type dynamic read parameter
Default 0
Range [0, (2^(ImageWidthBitwidth+4))-1]

Mean line width during set MeasurementPeriod (in pixels).

MeanLinePeriod
Type dynamic read parameter
Default 0
Range [0, (2^GapCountWidth)-1]

Mean line period during set MeasurementPeriod. A Line period is the number of clock cycles between two line beginnings. A line period thus covers the line width, a single EndOfLine pulse, and the line gap. The frame gap between the last line of a 2D image and the first line of the next image is not included.

MeanLineGap
Type dynamic read parameter
Default 0
Range [0, (2^GapCountWidth)-1]

Mean line gap during set MeasurementPeriod (mean number of clock cycles between two line beginnings).

The frame gap between the last line of a 2D image and the first line of the next image is not included.

MeanLineDutyCycle
Type dynamic read parameter
Default 0
Range [0.0, 100.0]

Mean line duty cycle during set MeasurementPeriod. Defined as MeanWidth divided by MeanLinePeriod.

LineRate
Type dynamic read parameter
Default 0
Range

Line rate in Hertz.

FrameRate
Type dynamic read parameter
Default 0
Range

Frame rate in Hertz.

BlockedFraction
Type dynamic read parameter
Default 0
Range [0.0, 100.0]

Percentage of blocked cycles.

IdleFraction
Type dynamic read parameter
Default 0
Range [0.0, 100.0]

Percentage of idle cycles.

ValidFraction
Type dynamic read parameter
Default 0
Range [0.0, 100.0]

Percentage of valid cycles carrying data.

MaxWidthErrorCount
Type dynamic read parameter
Default 0
Range [0, (2^(ImageWidthBitwidth+4))-1]

Counts up if line width is greater than maximum line width defined on the input link.

MaxHeightErrorCount
Type dynamic read parameter
Default 0
Range [0, (2^( ImageHeightBitwidth+4))-1]

Counts up if image height is greater than maximum image height defined on the input link.

OverflowMask
Type dynamic read parameter
Default 0
Range [0, 4095]

Bit encoded overflow signaling. A set bit indicates an overflow in the following counters:

[0] = FrameCount

[1] = PixelCount

[2] = xPos

[3] = yPos

[4] = LineGap

[6] = MeanLineGap

[8] = BlockedFraction

[10] = ValidFraction

[11] = LineCounter. Invalidates LineRate, MeanWidth, MeanLinePeriod and MeanLineGap.

Examples of Use

The use of operator ImageStatistics is shown in the following examples:

  • 'Image Flow Control'

    Example - For debugging purposes of the designs internal data flow control in hardware and a possible compensation.

  Prev     Level Up     Next  
Content Top Home