Table of Contents  ▸  List of Commands  ▸  Filtering  ▸  correlate

◀  convolve_fft    |    cross_correlation  ▶

correlate

Built-in command

Arguments:

• [mask],_boundary_conditions,_is_normalized={ 0 | 1 },_channel_mode,_xcenter,_ycenter,_zcenter,_xstride>0,_ystride>0,_zstride>0,_xdilation,_ydilation,_zdilation,_xoffset,_yoffset,_zoffset,_xsize>=0,_ysize>=0,_zsize>=0

Description:

Correlate selected images by specified mask.

boundary_conditions can be { 0:dirichlet | 1:neumann | 2:periodic | 3:mirror }.
channel_mode can be { 0:all | 1:one-for-one | 2:partial sum | 3:full sum }.

Default values:

boundary_conditions=1, is_normalized=0, channel_mode=1, xcenter=ycenter=zcenter=-1, xstride=ystride=zstride=1, xdilation=ydilation=zdilation=1,xoffset=yoffset=zoffset=0 and xsize=ysize=zsize=(input_size/stride).

Examples of use:

• Example #1

Command: image.jpg (0,1,0;1,-4,1;0,1,0) correlate[-2] [-1] keep[-2]

• Example #2