boofcv.factory.template.TemplateScoreType Maven / Gradle / Ivy

/*
 * Copyright (c) 2021, Peter Abeles. All Rights Reserved.
 *
 * This file is part of BoofCV (http://boofcv.org).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package boofcv.factory.template;

import boofcv.alg.template.TemplateSumAbsoluteDifference;
import boofcv.alg.template.TemplateSumSquaredError;

/**
 * List of formulas used to score matches in a template.
 *
 * @author Peter Abeles
 */
public enum TemplateScoreType {
	/**
	 * Sum of the absolute difference error.
	 *
	 * error = Sum_(o,u) | I(x,y) - T(x-o,y-u) | 
	 *
	 * @see TemplateSumAbsoluteDifference
	 */
	SUM_ABSOLUTE_DIFFERENCE,
	/**
	 * Sum of the difference squared or Euclidean error squared.
	 *
	 * error = Sum_(o,u) [ I(x,y) - T(x-o,y-u) ]^2 
	 *
	 * @see TemplateSumSquaredError
	 */
	SUM_SQUARE_ERROR,
	/**
	 * 
	 * Normalized Cross Correlation (NCC) error metric. Adds invariance to lighting conditions
	 * but is more expensive to compute.
	 * 
	 *
	 * @see boofcv.alg.template.TemplateNCC
	 */
	NCC,

	/**
	 * 
	 * Correlation error metric. On large images this can be much faster than the other techniques.
	 * 
	 *
	 * @see boofcv.alg.template.TemplateCorrelationFFT
	 */
	CORRELATION,

	/**
	 * Squared Difference normed error
	 *
	 * @see boofcv.alg.template.TemplateSqDiffNormed
	 */
	SQUARED_DIFFERENCE_NORMED,
}