vision.calibration.PatternDetector Class

Namespace: vision.calibration

Interface for defining custom planar pattern detectors

Since R2021b

Description

The vision.calibration.PatternDetector class specifies the interface for defining custom planar pattern detectors for the Camera Calibrator and Stereo Camera Calibrator apps, as well as on the MATLAB^® command line.

To define a custom pattern detector, you must construct a class that inherits from the vision.OpenPatternDetectorTemplate class. This is an abstract class that defines the methods and properties for detecting calibration pattern keypoints in the images, invoked during the calibration process, and to generate corresponding points in the world coordinates.

You can define a custom pattern detector for single camera calibration, starting with a template, by typing this command at the MATLAB prompt:

vision.OpenPatternDetectorTemplate("monocular")

You can define a custom pattern detector for stereo camera calibration, starting with a template, by typing the following at the MATLAB prompt:

vision.OpenPatternDetectorTemplate("stereo")

The vision.calibration.PatternDetector class is a handle class.

Class Attributes

Abstract

true

For information on class attributes, see Class Attributes.

Properties

Clients of the PatternDetector class specify these predefined properties.

Name — Pattern detector name

character vector | string scalar

Pattern detector name, specified as a character vector or a string scalar.

WorldUnits — World point units

character vector | string scalar

World point units, specified as a character vector or a string scalar. WorldUnits specifies the unit of measure for the pattern keypoints in world coordinates.

Panel — Properties panel user-defined UI components

uipanel object

Properties panel user-defined UI components for displaying and specifying detector properties, specified as a uipanel object. To set this property, use the propertiesPanel function with a uipanel object, which the PatternDetector invokes.

Methods

Public Methods

Clients of a PatternDetector implement these user-defined functions to define execution of the algorithm. For more information on creating a custom detection pattern, see Camera Calibration Using Custom Planar Calibration Patterns.

generateWorldPoints	Generate world coordinates for planar pattern keypoints
propertiesPanel	Define properties panel for custom pattern detector
drawImageAxesLabels	Display location and orientation of axes labels
detectPatternPoints	Detect calibration pattern keypoints in images

Version History

Introduced in R2021b