CorrelationCommand Class

Summary

This command compares the correlation image(or part of the correlation image) with all the areas of the same dimensions in the image to be searched (the Run method image) and finds those portions that match according to the measure of correlation. This command is available in the Document/Medical Toolkits.

Syntax

Objective-C

C++/CLI

Java

Python

public class CorrelationCommand : RasterCommand

@interface LTCorrelationCommand : LTRasterCommand

public class CorrelationCommand 
    extends RasterCommand

public ref class CorrelationCommand : public RasterCommand

class CorrelationCommand(RasterCommand):

Remarks

This command compares the correlation image (or part of the correlation image) with all the areas of the same dimensions in the image to be searched and finds those portions that match according to the measure of correlation. Correlation is a measure of association (resemblance) between two images. It varies from 0 (zero resemblance) to 100 (perfect resemblance). This command updates the Points property (or the points parameter of the Constructor) with the point of origin for those areas of the image to be searched where the resemblance with the correlation image (or part of the correlation image) is greater than the threshold. The correlation image dimensions must be less than or equal to the dimensions of the image to be searched.
For example:
1. Select an image of the object for which you want to look. Put it in the CorrelationImage property (or the correlationImage parameter of the constructor). For example:
2. Select an image that contains the image you wish to search and put it in the affected image. For example:
3. Call CorrelationCommand.
4. The command will update the Points array property (or the points parameter of the Constructor) with the point of origin (top-left) for each area of the image to be searched where the correlation with the correlation image is greater than the correlation threshold. The height and width of the rectangles are the same as for the correlation image.
5. The result is:
This command supports 12 and 16-bit grayscale and 48 and 64-bit color images. Support for 12-bit and 16-bit grayscale and 48-bit and 64-bit color images is available only in the Document/Medical toolkits.
This command does not support 32-bit grayscale images.
All images must be signed or unsigned.

For more information, refer to Introduction to Image Processing With LEADTOOLS.

Example

Run the CorrelationCommand on an image and applies the correlation filter.

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Core; 
 
public void CorrelationCommandExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "clean.tif")); 
 
   // Prepare the command 
   RasterImage DstImage = image.Clone(); 
   CorrelationCommand command = new CorrelationCommand(); 
   command.CorrelationImage = DstImage; 
   command.Threshold = 70; 
   command.XStep = 1; 
   command.YStep = 1; 
   command.Points = new LeadPoint[90]; 
   //Apply the correlation filter. 
   command.Run(image); 
 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.IOException; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.imageprocessing.core.*; 
 
 
public void correlationCommandExample() { 
 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   final String outputFilePath = combine(LEAD_VARS_IMAGES_DIR, "Result.jpg"); 
 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.setThrowExceptionsOnInvalidImages(true); 
 
   RasterImage image = codecs.load(combine(LEAD_VARS_IMAGES_DIR, "clean.tif")); 
 
   // Prepeare the command 
   RasterImage dstImage = image.clone(); 
   CorrelationCommand command = new CorrelationCommand(); 
   command.setCorrelationImage(dstImage); 
   command.setThreshold(70); 
   command.setXStep(1); 
   command.setYStep(1); 
   command.setPoints(new LeadPoint[90]); 
 
   // Apply the correlation filter 
   command.run(image); 
   codecs.save(image, outputFilePath, RasterImageFormat.TIF, 0); 
 
   assertTrue(new File(outputFilePath).exists()); 
   System.out.println("File saved to: " + outputFilePath); 
 
}