boofcv.abst.fiducial.calib.ConfigECoCheckDetector 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.abst.fiducial.calib;

import boofcv.alg.fiducial.calib.ecocheck.ECoCheckDetector;
import boofcv.misc.BoofMiscOps;
import boofcv.struct.Configuration;

/**
 * Configuration for detecting ECoCheck markers. These markers are chessboard patterns with marker ID and cell ID
 * encoded in the white spaces. Intended for use in multi camera calibration. The number of unique markers and their
 * shapes is required to known before a marker can be detected as the encoding changes based on these values.
 *
 * @see ECoCheckDetector
 *
 * @author Peter Abeles
 */
public class ConfigECoCheckDetector implements Configuration {

	/** Number of times it will sample the side a square when determining the binarization threshold */
	public int sampleCountSides = 5;

	/** Describes how to detect the chessboard */
	public final ConfigChessboardX chessboard = new ConfigChessboardX();

	@Override public void checkValidity() {
		BoofMiscOps.checkTrue(sampleCountSides>0, "sampleCountSides must be greater than zero");
		chessboard.checkValidity();
	}

	public ConfigECoCheckDetector setTo( ConfigECoCheckDetector src ) {
		this.sampleCountSides = src.sampleCountSides;
		this.chessboard.setTo(src.chessboard);
		return this;
	}
}