You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

325 lines
22 KiB

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Wed Jul 02 13:16:04 UTC 2025 -->
<title>CharucoBoard (OpenCV 4.12.0 Java documentation)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-07-02">
<meta name="description" content="declaration: package: org.opencv.objdetect, class: CharucoBoard">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language">
<script>
var url = window.location.href;
var pos = url.lastIndexOf('/javadoc/');
url = pos >= 0 ? (url.substring(0, pos) + '/javadoc/mymath.js') : (window.location.origin + '/mymath.js');
var script = document.createElement('script');
script.src = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML,' + url;
document.getElementsByTagName('head')[0].appendChild(script);
</script>
</div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.opencv.objdetect</a></div>
<h1 title="Class CharucoBoard" class="title">Class CharucoBoard</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="Board.html" title="class in org.opencv.objdetect">org.opencv.objdetect.Board</a>
<div class="inheritance">org.opencv.objdetect.CharucoBoard</div>
</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CharucoBoard</span>
<span class="extends-implements">extends <a href="Board.html" title="class in org.opencv.objdetect">Board</a></span></div>
<div class="block">ChArUco board is a planar chessboard where the markers are placed inside the white squares of a chessboard.
The benefits of ChArUco boards is that they provide both, ArUco markers versatility and chessboard corner precision,
which is important for calibration and pose estimation. The board image can be drawn using generateImage() method.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.opencv.core.Size,float,float,org.opencv.objdetect.Dictionary)" class="member-name-link">CharucoBoard</a><wbr>(<a href="../core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;size,
float&nbsp;squareLength,
float&nbsp;markerLength,
<a href="Dictionary.html" title="class in org.opencv.objdetect">Dictionary</a>&nbsp;dictionary)</code></div>
<div class="col-last even-row-color">
<div class="block">CharucoBoard constructor</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.opencv.core.Size,float,float,org.opencv.objdetect.Dictionary,org.opencv.core.Mat)" class="member-name-link">CharucoBoard</a><wbr>(<a href="../core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;size,
float&nbsp;squareLength,
float&nbsp;markerLength,
<a href="Dictionary.html" title="class in org.opencv.objdetect">Dictionary</a>&nbsp;dictionary,
<a href="../core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;ids)</code></div>
<div class="col-last odd-row-color">
<div class="block">CharucoBoard constructor</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CharucoBoard.html" title="class in org.opencv.objdetect">CharucoBoard</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#__fromPtr__(long)" class="member-name-link">__fromPtr__</a><wbr>(long&nbsp;addr)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkCharucoCornersCollinear(org.opencv.core.Mat)" class="member-name-link">checkCharucoCornersCollinear</a><wbr>(<a href="../core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;charucoIds)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">check whether the ChArUco markers are collinear</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../core/MatOfPoint3f.html" title="class in org.opencv.core">MatOfPoint3f</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getChessboardCorners()" class="member-name-link">getChessboardCorners</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">get CharucoBoard::chessboardCorners</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../core/Size.html" title="class in org.opencv.core">Size</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getChessboardSize()" class="member-name-link">getChessboardSize</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLegacyPattern()" class="member-name-link">getLegacyPattern</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMarkerLength()" class="member-name-link">getMarkerLength</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSquareLength()" class="member-name-link">getSquareLength</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLegacyPattern(boolean)" class="member-name-link">setLegacyPattern</a><wbr>(boolean&nbsp;legacyPattern)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">set legacy chessboard pattern.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.opencv.objdetect.Board">Methods inherited from class&nbsp;org.opencv.objdetect.<a href="Board.html" title="class in org.opencv.objdetect">Board</a></h3>
<code><a href="Board.html#generateImage(org.opencv.core.Size,org.opencv.core.Mat)">generateImage</a>, <a href="Board.html#generateImage(org.opencv.core.Size,org.opencv.core.Mat,int)">generateImage</a>, <a href="Board.html#generateImage(org.opencv.core.Size,org.opencv.core.Mat,int,int)">generateImage</a>, <a href="Board.html#getDictionary()">getDictionary</a>, <a href="Board.html#getIds()">getIds</a>, <a href="Board.html#getNativeObjAddr()">getNativeObjAddr</a>, <a href="Board.html#getObjPoints()">getObjPoints</a>, <a href="Board.html#getRightBottomCorner()">getRightBottomCorner</a>, <a href="Board.html#matchImagePoints(java.util.List,org.opencv.core.Mat,org.opencv.core.Mat,org.opencv.core.Mat)">matchImagePoints</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.opencv.core.Size,float,float,org.opencv.objdetect.Dictionary,org.opencv.core.Mat)">
<h3>CharucoBoard</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">CharucoBoard</span><wbr><span class="parameters">(<a href="../core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;size,
float&nbsp;squareLength,
float&nbsp;markerLength,
<a href="Dictionary.html" title="class in org.opencv.objdetect">Dictionary</a>&nbsp;dictionary,
<a href="../core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;ids)</span></div>
<div class="block">CharucoBoard constructor</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>size</code> - number of chessboard squares in x and y directions</dd>
<dd><code>squareLength</code> - squareLength chessboard square side length (normally in meters)</dd>
<dd><code>markerLength</code> - marker side length (same unit than squareLength)</dd>
<dd><code>dictionary</code> - dictionary of markers indicating the type of markers</dd>
<dd><code>ids</code> - array of id used markers
The first markers in the dictionary are used to fill the white chessboard squares.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.opencv.core.Size,float,float,org.opencv.objdetect.Dictionary)">
<h3>CharucoBoard</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">CharucoBoard</span><wbr><span class="parameters">(<a href="../core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;size,
float&nbsp;squareLength,
float&nbsp;markerLength,
<a href="Dictionary.html" title="class in org.opencv.objdetect">Dictionary</a>&nbsp;dictionary)</span></div>
<div class="block">CharucoBoard constructor</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>size</code> - number of chessboard squares in x and y directions</dd>
<dd><code>squareLength</code> - squareLength chessboard square side length (normally in meters)</dd>
<dd><code>markerLength</code> - marker side length (same unit than squareLength)</dd>
<dd><code>dictionary</code> - dictionary of markers indicating the type of markers
The first markers in the dictionary are used to fill the white chessboard squares.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="__fromPtr__(long)">
<h3>__fromPtr__</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="CharucoBoard.html" title="class in org.opencv.objdetect">CharucoBoard</a></span>&nbsp;<span class="element-name">__fromPtr__</span><wbr><span class="parameters">(long&nbsp;addr)</span></div>
</section>
</li>
<li>
<section class="detail" id="setLegacyPattern(boolean)">
<h3>setLegacyPattern</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setLegacyPattern</span><wbr><span class="parameters">(boolean&nbsp;legacyPattern)</span></div>
<div class="block">set legacy chessboard pattern.
Legacy setting creates chessboard patterns starting with a white box in the upper left corner
if there is an even row count of chessboard boxes, otherwise it starts with a black box.
This setting ensures compatibility to patterns created with OpenCV versions prior OpenCV 4.6.0.
See https://github.com/opencv/opencv/issues/23152.
Default value: false.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>legacyPattern</code> - automatically generated</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLegacyPattern()">
<h3>getLegacyPattern</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">getLegacyPattern</span>()</div>
</section>
</li>
<li>
<section class="detail" id="getChessboardSize()">
<h3>getChessboardSize</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../core/Size.html" title="class in org.opencv.core">Size</a></span>&nbsp;<span class="element-name">getChessboardSize</span>()</div>
</section>
</li>
<li>
<section class="detail" id="getSquareLength()">
<h3>getSquareLength</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">float</span>&nbsp;<span class="element-name">getSquareLength</span>()</div>
</section>
</li>
<li>
<section class="detail" id="getMarkerLength()">
<h3>getMarkerLength</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">float</span>&nbsp;<span class="element-name">getMarkerLength</span>()</div>
</section>
</li>
<li>
<section class="detail" id="getChessboardCorners()">
<h3>getChessboardCorners</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../core/MatOfPoint3f.html" title="class in org.opencv.core">MatOfPoint3f</a></span>&nbsp;<span class="element-name">getChessboardCorners</span>()</div>
<div class="block">get CharucoBoard::chessboardCorners</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>automatically generated</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="checkCharucoCornersCollinear(org.opencv.core.Mat)">
<h3>checkCharucoCornersCollinear</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">checkCharucoCornersCollinear</span><wbr><span class="parameters">(<a href="../core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;charucoIds)</span></div>
<div class="block">check whether the ChArUco markers are collinear</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>charucoIds</code> - list of identifiers for each corner in charucoCorners per frame.</dd>
<dt>Returns:</dt>
<dd>bool value, 1 (true) if detected corners form a line, 0 (false) if they do not.
solvePnP, calibration functions will fail if the corners are collinear (true).
The number of ids in charucoIDs should be &lt;= the number of chessboard corners in the board.
This functions checks whether the charuco corners are on a straight line (returns true, if so), or not (false).
Axis parallel, as well as diagonal and other straight lines detected. Degenerate cases:
for number of charucoIDs &lt;= 2,the function returns true.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Generated on 2025-07-02 13:16:04 / OpenCV 4.12.0</small></p>
</footer>
</div>
</div>
</body>
</html>