boofcv.alg.feature.describe.brief.FactoryBriefDefinition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of boofcv-feature Show documentation

BoofCV is an open source Java library for real-time computer vision and robotics applications.

The newest version!

/*
 * 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.alg.feature.describe.brief;

import georegression.struct.point.Point2D_I32;

import java.util.Random;

/**
 * Creates different brief descriptors. The original paper proposed several different configurations. The
 * best one were randomly generated with a gaussian distribution.
 *
 * @author Peter Abeles
 */
public class FactoryBriefDefinition {

	/**
	 * Creates a descriptor by randomly selecting points inside a square region using a Gaussian distribution
	 * with a sigma of (5/2)*radius. This is done exactly as is described in the paper where twice
	 * as many points are sampled as are compared..
	 *
	 * @param rand Random number generator.
	 * @param radius Radius of the square region. width = 2*radius+1.
	 * @param numPairs Number of sample point pairs.
	 * @return Definition of a BRIEF feature.
	 */
	public static BinaryCompareDefinition_I32 gaussian( Random rand, int radius, int numPairs ) {
		BinaryCompareDefinition_I32 ret = new BinaryCompareDefinition_I32(radius, numPairs*2, numPairs);

		double sigma = (2.0*radius + 1.0)/5.0;
		for (int i = 0; i < numPairs; i++) {
			randomGaussian(rand, sigma, radius, ret.samplePoints[i]);
			randomGaussian(rand, sigma, radius, ret.samplePoints[i + numPairs]);

			ret.compare[i].setTo(i, i + numPairs);
		}

		return ret;
	}

	public static BinaryCompareDefinition_I32 gaussian2( Random rand, int radius, int numPairs ) {
		BinaryCompareDefinition_I32 ret = new BinaryCompareDefinition_I32(radius, numPairs, numPairs);

		double sigma = (2.0*radius + 1.0)/5.0;
		for (int i = 0; i < numPairs; i++) {
			randomGaussian(rand, sigma, radius, ret.samplePoints[i]);
			ret.compare[i].setTo(i, rand.nextInt(numPairs));
		}

		return ret;
	}

	/**
	 * Randomly selects a point which is inside a square region using a Gaussian distribution.
	 */
	private static void randomGaussian( Random rand, double sigma, int radius, Point2D_I32 pt ) {

		int x, y;

		do {
			x = (int)(rand.nextGaussian()*sigma);
			y = (int)(rand.nextGaussian()*sigma);
		} while (!(Math.sqrt(x*x + y*y) < radius));

		pt.setTo(x, y);
	}
}