Correlate (G Dataflow)

Reference to the source image.

Reference to the template.

This image must be an 8-bit image. The center of the template is used as the origin for the correlation.

Reference to the destination image.

Four-element array that contains the left, top, right, and bottom coordinates of the region to process.

The right and bottom values are exclusive and lie outside the region. The node applies the operation to the entire image if optional rectangle is empty or not connected.

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error	error in contains an error
If no error occurred before the node runs, the node begins execution normally. If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.	If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

Reference to the destination.

If image dst is connected, image dst out is the same as image dst. Otherwise, image dst out refers to the image referenced by image. The Correlate node is an 8-bit image that contains the cross-correlation values normalized within the range [0, 255]. A value of 255 indicates a very high correlation and a value of 0 indicates no correlation.

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error	error in contains an error
If no error occurred before the node runs, the node begins execution normally. If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.	If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.