Documentation Center

  • Trial Software
  • Product Updates

step

System object: vision.Mean
Package: vision

Compute mean of input

Syntax

Y = step(H,X)
Y = step(H,X,R)
Y = step(H,X,ROI)
Y = step(H,X,LABEL,LABELNUMBERS)
[Y,FLAG] = step(H,X,ROI)
[Y,FLAG] = step(H,X,LABEL,LABELNUMBERS)

Description

Y = step(H,X) computes the mean of input image elements X. When you set the RunningMean property to true, the output Y corresponds to the mean of the input elements over successive calls to the step method.

Y = step(H,X,R) computes the mean value of the input image elements X over successive calls to the step method, and optionally resets the computation of the running mean based on the value of reset signal, R and the value of the ResetCondition property. To enable this type of processing, set the RunningMean property to true and the ResetInputPort property to true.

Y = step(H,X,ROI) computes the mean of input image elements X within the given region of interest specified by the input ROI. To enable this type of processing, set the ROIProcessing property to true and the ROIForm property to Lines, Rectangles or Binary mask.

Y = step(H,X,LABEL,LABELNUMBERS) computes the mean of the input image elements, X, for the region whose labels are specified in the vector LABELNUMBERS. The regions are defined and labeled in the matrix LABEL. To enable this type of processing, set the ROIProcessing property to true and the ROIForm property to Label matrix.

[Y,FLAG] = step(H,X,ROI) also returns the output FLAG, indicating whether the given region of interest ROI, is within the image bounds. To enable this type of processing, set the ROIProcessing and ValidityOutputPort properties to true and the ROIForm property to Lines, Rectangles or Binary mask.

[Y,FLAG] = step(H,X,LABEL,LABELNUMBERS) also returns the output FLAG which indicates whether the input label numbers are valid. To enable this type of processing, set the ROIProcessing and ValidityOutputPort properties to true and the ROIForm property to Label matrix.

    Note:   The object performs an initialization the first time the step method is executed. This initialization locks nontunable properties and input specifications, such as dimensions, complexity, and data type of the input data. If you change a nontunable property or an input specification, the System object™ issues an error. To change nontunable properties or inputs, you must first call the release method to unlock the object.

Was this topic helpful?