Package boofcv.factory.fiducial

Class FactoryFiducial

java.lang.Object

boofcv.factory.fiducial.FactoryFiducial

public class FactoryFiducial
extends Object

Factory for creating fiducial detectors which implement FiducialDetector.

Constructor Summary

Constructors

Constructor	Description
FactoryFiducial()

Method Summary

Modifier and Type	Method	Description
static <T extends ImageGray<T>> AztecCodePreciseDetector<T>	aztec(@Nullable ConfigAztecCode config, Class<T> imageType)	Returns an Aztec Code detector
static <T extends ImageGray<T>> CalibrationFiducialDetector<T>	calibChessboardB(@Nullable ConfigChessboardBinary config, ConfigGridDimen dimen, Class<T> imageType)	Chessboard detector based on binary images.
static <T extends ImageGray<T>> CalibrationFiducialDetector<T>	calibChessboardX(@Nullable ConfigChessboardX config, ConfigGridDimen dimen, Class<T> imageType)	Chessboard detector which searches for x-corners.
static <T extends ImageGray<T>> CalibrationFiducialDetector<T>	calibCircleHexagonalGrid(@Nullable ConfigCircleHexagonalGrid config, ConfigGridDimen configDimen, Class<T> imageType)
static <T extends ImageGray<T>> CalibrationFiducialDetector<T>	calibCircleRegularGrid(@Nullable ConfigCircleRegularGrid config, ConfigGridDimen configDimen, Class<T> imageType)
static <T extends ImageGray<T>> CalibrationFiducialDetector<T>	calibSquareGrid(@Nullable ConfigSquareGrid config, ConfigGridDimen configDimen, Class<T> imageType)	Wrapper around square-grid calibration detector.
static <T extends ImageGray<T>> ECoCheck_to_FiducialDetector<T>	ecocheck(@Nullable ConfigECoCheckDetector configDetector, ConfigECoCheckMarkers configMarkers, Class<T> imageType)	Creates a new ECoCheckDetector.
static <T extends ImageGray<T>> MicroQrCodePreciseDetector<T>	microqr(@Nullable ConfigMicroQrCode config, Class<T> imageType)	Returns a Micro QR Code detector
static <T extends ImageGray<T>> MicroQrCodeDetectorPnP<T>	microqr3D(@Nullable ConfigMicroQrCode config, Class<T> imageType)
static <T extends ImageGray<T>> QrCodePreciseDetector<T>	qrcode(@Nullable ConfigQrCode config, Class<T> imageType)	Returns a QR Code detector
static <T extends ImageGray<T>> QrCodeDetectorPnP<T>	qrcode3D(@Nullable ConfigQrCode config, Class<T> imageType)	QR Code but with the ability to estimate it's 3D pose using PnP.
static <T extends ImageGray<T>> Uchiya_to_FiducialDetector<T>	randomDots(ConfigUchiyaMarker config, Class<T> imageType)	Creates detector for random dot markers using Uchiya Marker approach.
static <T extends ImageGray<T>> SquareBinary_to_FiducialDetector<T>	squareBinary(ConfigFiducialBinary configFiducial, @Nullable ConfigThreshold configThreshold, Class<T> imageType)	Detector for square binary based fiducials.
static <T extends ImageGray<T>> SquareHamming_to_FiducialDetector<T>	squareHamming(ConfigHammingMarker configMarkers, @Nullable ConfigFiducialHammingDetector configDetector, Class<T> imageType)	Detector for square binary based fiducials.
static <T extends ImageGray<T>> SquareImage_to_FiducialDetector<T>	squareImage(@Nullable ConfigFiducialImage configFiducial, @Nullable ConfigThreshold configThreshold, Class<T> imageType)	Detector for square image based fiducials.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FactoryFiducial

public FactoryFiducial()

Method Details

squareBinary

public static <T extends ImageGray<T>>
SquareBinary_to_FiducialDetector<T> squareBinary(ConfigFiducialBinary configFiducial,
 @Nullable
 @Nullable ConfigThreshold configThreshold,
 Class<T> imageType)

Detector for square binary based fiducials.

Parameters:

configFiducial - Description of the fiducial. Can't be null.

configThreshold - Threshold for binary image. null for default.

imageType - Type of image it's processing

Returns:

FiducialDetector

See Also:

• DetectFiducialSquareBinary for a description of this fiducial type.

squareHamming

public static <T extends ImageGray<T>>
SquareHamming_to_FiducialDetector<T> squareHamming(ConfigHammingMarker configMarkers,
 @Nullable
 @Nullable ConfigFiducialHammingDetector configDetector,
 Class<T> imageType)

Detector for square binary based fiducials.

Parameters:

configMarkers - Describes the markers it will detect.

configDetector - (Optional) Describes how it will detect the markers.

imageType - Type of image it's processing

Returns:

FiducialDetector

See Also:

• DetectFiducialSquareBinary for a description of this fiducial type.

squareImage

public static <T extends ImageGray<T>>
SquareImage_to_FiducialDetector<T> squareImage(@Nullable
 @Nullable ConfigFiducialImage configFiducial,
 @Nullable
 @Nullable ConfigThreshold configThreshold,
 Class<T> imageType)

Detector for square image based fiducials.

For this fiducial to work images need to be added to it. Which is why SquareImage_to_FiducialDetector is returned instead of the more generic FiducialDetector.

Parameters:

configFiducial - Description of the fiducial. null for default.

configThreshold - Threshold for binary image. null for default.

imageType - Type of image it's processing

Returns:

FiducialDetector

See Also:

• DetectFiducialSquareImage for a description of this fiducial type.

calibChessboardB

public static <T extends ImageGray<T>>
CalibrationFiducialDetector<T> calibChessboardB(@Nullable
 @Nullable ConfigChessboardBinary config,
 ConfigGridDimen dimen,
 Class<T> imageType)

Chessboard detector based on binary images. Fast but not as robust as the X-Corner method. Not recommended for fisheye images.

Parameters:

config - Description of the chessboard.

imageType - Type of image it's processing

Returns:

FiducialDetector

calibChessboardX

public static <T extends ImageGray<T>>
CalibrationFiducialDetector<T> calibChessboardX(@Nullable
 @Nullable ConfigChessboardX config,
 ConfigGridDimen dimen,
 Class<T> imageType)

Chessboard detector which searches for x-corners. Very robust but is about 2x to 3x slower on large images than the binary method.

Parameters:

config - Description of the chessboard.

imageType - Type of image it's processing

Returns:

FiducialDetector

calibSquareGrid

public static <T extends ImageGray<T>>
CalibrationFiducialDetector<T> calibSquareGrid(@Nullable
 @Nullable ConfigSquareGrid config,
 ConfigGridDimen configDimen,
 Class<T> imageType)

Wrapper around square-grid calibration detector. Refine with lines is set to true automatically. This isn't being used for calibration, and it's better to use the whole line.

Parameters:

config - Description of the chessboard.

imageType - Type of image it's processing

Returns:

FiducialDetector

calibCircleHexagonalGrid

public static <T extends ImageGray<T>>
CalibrationFiducialDetector<T> calibCircleHexagonalGrid(@Nullable
 @Nullable ConfigCircleHexagonalGrid config,
 ConfigGridDimen configDimen,
 Class<T> imageType)

calibCircleRegularGrid

public static <T extends ImageGray<T>>
CalibrationFiducialDetector<T> calibCircleRegularGrid(@Nullable
 @Nullable ConfigCircleRegularGrid config,
 ConfigGridDimen configDimen,
 Class<T> imageType)

qrcode

public static <T extends ImageGray<T>>
QrCodePreciseDetector<T> qrcode(@Nullable
 @Nullable ConfigQrCode config,
 Class<T> imageType)

Returns a QR Code detector

Parameters:

config - Configuration

imageType - type of input image

Returns:

the detector

aztec

public static <T extends ImageGray<T>>
AztecCodePreciseDetector<T> aztec(@Nullable
 @Nullable ConfigAztecCode config,
 Class<T> imageType)

Returns an Aztec Code detector

Parameters:

config - Configuration

imageType - type of input image

Returns:

the detector

microqr

public static <T extends ImageGray<T>>
MicroQrCodePreciseDetector<T> microqr(@Nullable
 @Nullable ConfigMicroQrCode config,
 Class<T> imageType)

Returns a Micro QR Code detector

Parameters:

config - Configuration

imageType - type of input image

Returns:

the detector

ecocheck

public static <T extends ImageGray<T>>
ECoCheck_to_FiducialDetector<T> ecocheck(@Nullable
 @Nullable ConfigECoCheckDetector configDetector,
 ConfigECoCheckMarkers configMarkers,
 Class<T> imageType)

Creates a new ECoCheckDetector. This will detect chessboard patterns that have been encoded with a marker ID and coordinates of every corner.

Parameters:

configDetector - Configuration for chessboard detector

configMarkers - Configuration for what markers it should search for

Returns:

New detector

qrcode3D

public static <T extends ImageGray<T>>
QrCodeDetectorPnP<T> qrcode3D(@Nullable
 @Nullable ConfigQrCode config,
 Class<T> imageType)

QR Code but with the ability to estimate it's 3D pose using PnP. Implements FiducialDetector.

microqr3D

public static <T extends ImageGray<T>>
MicroQrCodeDetectorPnP<T> microqr3D(@Nullable
 @Nullable ConfigMicroQrCode config,
 Class<T> imageType)

randomDots

public static <T extends ImageGray<T>>
Uchiya_to_FiducialDetector<T> randomDots(ConfigUchiyaMarker config,
 Class<T> imageType)

Creates detector for random dot markers using Uchiya Marker approach.

Parameters:

config - Specifies the configuration. If null then default is used

imageType - Type of input gray scale image

Returns:

The fiducial detector

See Also:

• UchiyaMarkerImageTracker