CorrelationListCommand Class

Compares the images in a list with all the areas of the same dimensions in an image and finds those portions that match according to the measure of correlation. This method is only available in the Document/Medical toolkits.

Object Model

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public class CorrelationListCommand : Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

'Declaration
 
Public Class CorrelationListCommand 
   Inherits Leadtools.ImageProcessing.RasterCommand
   Implements Leadtools.ImageProcessing.IRasterCommand

'Usage
 
Dim instance As CorrelationListCommand

public sealed class CorrelationListCommand : Leadtools.ImageProcessing.IRasterCommand

function Leadtools.ImageProcessing.Core.CorrelationListCommand()

public ref class CorrelationListCommand : public Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

Remarks

This method compares the images in a list with all the areas of the same dimensions in image and finds those areas that match according to the measure of correlation.
All the list images must have the same dimensions. The dimensions must be less than or equal to the image dimensions.
Correlation is a measure of association (resemblance) between two images. It varies from 0 (zero resemblance) to 100 (perfect resemblance).
This method updates the Points parameter with the point of origin for those areas of the image where the resemblance with an image in the list is greater than the value of Threshold. It also updates ListIndex with the index of that image.
For example:
1. Select images of the objects for which you want to look and put them in a list
  For example:
2. Select an image that contains the objects for which you are searching.
  For example:
3. Set XStep = 1, YStep = 1 and Threshold = 90 then run the command
4. Points array will be updated with the point of origin (top-left) for each area of the image where the correlation with an image in the list is greater than the correlation Threshold. The height and width of the rectangles are the same as for list images.
5. The result
This method supports 12 and 16-bit grayscale and 48 and 64-bit color images. Support for 12 and 16-bit grayscale and 48 and 64-bit color images is available only in the Document/Medical toolkits.
If the image has a region, this method works only on the region. If the image does not have a region, this method works on the entire image.
This method does not support signed data images.
This command does not support 32-bit grayscale images.

In Silverlight and Windows Phone versions of LEADTOOLS, this image processing command will fail if the image data for the RasterImage object is stored internally using a Silverlight WriteableBitmap object. For more information, refer to Image Processing Command Limitations in Silverlight.

Example

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub CorrelationListCommandExample()
   ' Load an image
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim image As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"))

   Dim command As CorrelationListCommand = New CorrelationListCommand()
   Dim copyRectangle As CopyRectangleCommand = New CopyRectangleCommand()

   Dim rc_cor As LeadRect = New LeadRect(327, 378, 22, 28)
   copyRectangle.Rectangle = rc_cor
   copyRectangle.Run(image)
   command.CorrelationImage = copyRectangle.DestinationImage.Clone()

   rc_cor = New LeadRect(283, 378, 22, 28)
   copyRectangle.Rectangle = rc_cor
   copyRectangle.Run(image)
   command.CorrelationImage.AddPage(copyRectangle.DestinationImage.Clone())

   Dim points(30) As LeadPoint
   Dim listIndex(30) As Integer

   command.Points = points
   command.ListIndex = listIndex
   command.Threshold = 90
   command.XStep = 1
   command.YStep = 1
   command.Run(image)

End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

public void CorrelationListCommandExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

      RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"));

      CorrelationListCommand command = new CorrelationListCommand();
      CopyRectangleCommand copyRectangle = new CopyRectangleCommand();

      LeadRect rc_cor = new LeadRect(327, 378, 22, 28);
      copyRectangle.Rectangle = rc_cor;
      copyRectangle.Run(image);
      command.CorrelationImage = copyRectangle.DestinationImage.Clone();

      rc_cor = new LeadRect(283, 378, 22, 28);
      copyRectangle.Rectangle = rc_cor;
      copyRectangle.Run(image);
      command.CorrelationImage.AddPage(copyRectangle.DestinationImage.Clone());

      command.Points = new LeadPoint[30];
      command.ListIndex = new int[30];
      command.Threshold = 90;
      command.XStep = 1;
      command.YStep = 1;
      command.Run(image);

   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

function CorrelationListCommandExample()
{
   var codecs = new Leadtools.Codecs.RasterCodecs();
   codecs.throwExceptionsOnInvalidImages = true;

   // Load the image
   var srcFileName = "Assets\\Image1.cmp";
   return Tools.AppInstallFolder().getFileAsync(srcFileName).then(function (loadFile) {
      return codecs.loadAsync(Leadtools.LeadStreamFactory.create(loadFile));
   }).then(function (image) {
      // Prepare the command
      with (Leadtools.ImageProcessing.Core) {
         var command = new CorrelationListCommand();
         var copyRectangle = new Leadtools.ImageProcessing.CopyRectangleCommand();

         var rc_cor = Leadtools.LeadRectHelper.create(327, 378, 22, 28);
         copyRectangle.rectangle = rc_cor;
         copyRectangle.run(image);
         command.correlationImage = copyRectangle.destinationImage.clone();

         rc_cor = Leadtools.LeadRectHelper.create(283, 378, 22, 28);
         copyRectangle.rectangle = rc_cor;
         copyRectangle.run(image);
         command.correlationImage.addPage(copyRectangle.destinationImage.clone());

         command.points = new Array();
         //Size the array to 30
         for (var i = 0; i < 30; i++)
            command.points[i] = Leadtools.LeadPointHelper.create(0, 0);

         command.listIndex = new Array();
         //Size the array to 30
         for (var i = 0; i < 30; i++)
            command.listIndex[i] = 0;

         command.threshold = 90;
         command.xStep = 1;
         command.yStep = 1;
         command.run(image);
      }
   });
}

[TestMethod]
public async Task CorrelationListCommandExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;
   // Load the image
   string srcFileName = @"Assets\Image1.cmp";
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   CorrelationListCommand command = new CorrelationListCommand();
   CopyRectangleCommand copyRectangle = new CopyRectangleCommand();

   LeadRect rc_cor = LeadRectHelper.Create(327, 378, 22, 28);
   copyRectangle.Rectangle = rc_cor;
   copyRectangle.Run(image);
   command.CorrelationImage = copyRectangle.DestinationImage.Clone();

   rc_cor = LeadRectHelper.Create(283, 378, 22, 28);
   copyRectangle.Rectangle = rc_cor;
   copyRectangle.Run(image);
   command.CorrelationImage.AddPage(copyRectangle.DestinationImage.Clone());

   command.Points = new LeadPoint[30];
   command.ListIndex = new int[30];
   command.Threshold = 90;
   command.XStep = 1;
   command.YStep = 1;
   command.Run(image);

}

public void CorrelationListCommandExample(RasterImage image, Stream outStream)
{
   CorrelationListCommand command = new CorrelationListCommand();
   CopyRectangleCommand copyRectangle = new CopyRectangleCommand();
   LeadRect rc_cor = new LeadRect(327, 378, 22, 28);
   copyRectangle.Rectangle = rc_cor;
   copyRectangle.Run(image);
   command.CorrelationImage = copyRectangle.DestinationImage.Clone();

   rc_cor = new LeadRect(283, 378, 22, 28);
   copyRectangle.Rectangle = rc_cor;
   copyRectangle.Run(image);
   command.CorrelationImage.AddPage(copyRectangle.DestinationImage.Clone());

   command.Points = new LeadPoint[30];
   command.ListIndex = new int[30];
   command.Threshold = 90;
   command.XStep = 1;
   command.YStep = 1;
   command.Run(image);

   // Save result image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24);
   image.Dispose();
}

Public Sub CorrelationListCommandExample(ByVal image As RasterImage, ByVal outStream As Stream)
   Dim command As CorrelationListCommand = New CorrelationListCommand()
   Dim copyRectangle As CopyRectangleCommand = New CopyRectangleCommand()
   Dim rc_cor As LeadRect = New LeadRect(327, 378, 22, 28)
   copyRectangle.Rectangle = rc_cor
   copyRectangle.Run(image)
   command.CorrelationImage = copyRectangle.DestinationImage.Clone()

   rc_cor = New LeadRect(283, 378, 22, 28)
   copyRectangle.Rectangle = rc_cor
   copyRectangle.Run(image)
   command.CorrelationImage.AddPage(copyRectangle.DestinationImage.Clone())

   command.Points = New LeadPoint(29){}
   command.ListIndex = New Integer(29){}
   command.Threshold = 90
   command.XStep = 1
   command.YStep = 1
   command.Run(image)

   ' Save result image
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24)
   image.Dispose()
End Sub

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

CorrelationListCommand Members
Leadtools.ImageProcessing.Core Namespace
Leadtools.ImageProcessing.Color.IntensityDetectCommand
Leadtools.ImageProcessing.Effects.SpatialFilterCommand
Leadtools.ImageProcessing.Effects.BinaryFilterCommand
MaximumCommand Class
MinimumCommand Class
CorrelationCommand Class