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

import boofcv.alg.fiducial.qrcode.QrCode;
import boofcv.struct.image.ImageGray;

import java.util.List;

/**
 * High level interface for reading QR Codes from gray scale images
 *
 * @author Peter Abeles
 */
public interface QrCodeDetector> {

	/**
	 * Processes the image and searches for fiducials
	 *
	 * @param image The image being processed
	 */
	void process( T image );

	/**
	 * List of detected fiducials
	 *
	 * @return List of detected QR-Codes. WARNING: Data might be recycled on next call to {@link #process}
	 */
	List getDetections();

	/**
	 * List of likely fiducials that were rejected.
	 *
	 * @return List of rejected candidate QR-Codes. WARNING: Data might be recycled on next call to {@link #process}
	 */
	List getFailures();

	/**
	 * Type of image it can process
	 *
	 * @return input image type
	 */
	Class getImageType();
}