public abstract

Inheritance Graph

graph BT
	AbstractImageComparator
	AbstractImageComparator --> ReferenceCounter
	AbstractOnGpuComparator --> AbstractImageComparator
	SimilarPixelCounter --> AbstractImageComparator
	click AbstractImageComparator "classMinSG_1_1ImageCompare_1_1AbstractImageComparator"
	click ReferenceCounter "classUtil_1_1ReferenceCounter"
	click AbstractOnGpuComparator "classMinSG_1_1ImageCompare_1_1AbstractOnGpuComparator"
	click SimilarPixelCounter "classMinSG_1_1ImageCompare_1_1SimilarPixelCounter"

Description

Abstract base class for classes that compare two images to each other. Subclasses implement special algorithms for image comparison.

Author: Benjamin Eikel

Date: 2011-06-14

Public Functions

   
   
  AbstractImageComparator()
   
  ~AbstractImageComparator()
   
bool compare( Rendering::RenderingContext & context, Rendering::Texture * firstTex, Rendering::Texture * secondTex, double & value, Rendering::Texture * resultTex)

Documentation

function
MinSG::ImageCompare::AbstractImageComparator::AbstractImageComparator

public inline
   
   
AbstractImageComparator( )

Defined in MinSG/Ext/ImageCompare/AbstractImageComparator.h:39

function
MinSG::ImageCompare::AbstractImageComparator::~AbstractImageComparator

public inline virtual
   
   
~AbstractImageComparator( )

Defined in MinSG/Ext/ImageCompare/AbstractImageComparator.h:41

function
MinSG::ImageCompare::AbstractImageComparator::compare

public virtual
     
     
bool compare( Rendering::RenderingContext & context,
  Rendering::Texture * firstTex,
  Rendering::Texture * secondTex,
  double & value,
  Rendering::Texture * resultTex
)    

Compare two images to each other. Return a value from [0.0, 1.0], where 1.0 means that the two images are the same.

Parameters

context
Current rendering context.
firstTex
First source image to use for comparison. Must not benullptr.
secondTex
Second source image to use for comparison. Must not benullptr.
value
Result of the image comparison. The interpretation of the value depends on the actual implementation.
resultTex
Resulting texture that contains any kind of difference image specific to the actual implementation. May benullptr.

Returns

trueif the comparison was successful,falseif something went wrong.

Defined in MinSG/Ext/ImageCompare/AbstractImageComparator.h:55