fiducial-targets 0.0.1.dev1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. fiducial_targets-0.0.1.dev1/.gitignore +15 -0
  2. fiducial_targets-0.0.1.dev1/CHANGELOG.md +102 -0
  3. fiducial_targets-0.0.1.dev1/LICENSE +190 -0
  4. fiducial_targets-0.0.1.dev1/MANIFEST.in +7 -0
  5. fiducial_targets-0.0.1.dev1/PKG-INFO +155 -0
  6. fiducial_targets-0.0.1.dev1/README.md +118 -0
  7. fiducial_targets-0.0.1.dev1/pyproject.toml +98 -0
  8. fiducial_targets-0.0.1.dev1/src/fiducial/targets/__init__.py +51 -0
  9. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/__init__.py +0 -0
  10. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/apriltag/NOTICE.md +37 -0
  11. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/apriltag/__init__.py +57 -0
  12. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/apriltag/tag16h5.npz +0 -0
  13. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/apriltag/tag25h9.npz +0 -0
  14. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/apriltag/tag36h10.npz +0 -0
  15. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/apriltag/tag36h11.npz +0 -0
  16. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/apriltag/tagCircle21h7.npz +0 -0
  17. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/apriltag/tagCircle49h12.npz +0 -0
  18. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/apriltag/tagCustom48h12.npz +0 -0
  19. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/apriltag/tagStandard41h12.npz +0 -0
  20. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/apriltag/tagStandard52h13.npz +0 -0
  21. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/aruco/NOTICE.md +34 -0
  22. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/aruco/__init__.py +97 -0
  23. fiducial_targets-0.0.1.dev1/src/fiducial/targets/_codes/aruco/arucoDictBytesList.npz +0 -0
  24. fiducial_targets-0.0.1.dev1/src/fiducial/targets/color.py +31 -0
  25. fiducial_targets-0.0.1.dev1/src/fiducial/targets/composites/__init__.py +5 -0
  26. fiducial_targets-0.0.1.dev1/src/fiducial/targets/composites/chessboard_apriltag.py +83 -0
  27. fiducial_targets-0.0.1.dev1/src/fiducial/targets/composites/chessboard_aruco.py +84 -0
  28. fiducial_targets-0.0.1.dev1/src/fiducial/targets/composites/corner_quads.py +48 -0
  29. fiducial_targets-0.0.1.dev1/src/fiducial/targets/geometry.py +38 -0
  30. fiducial_targets-0.0.1.dev1/src/fiducial/targets/groups.py +37 -0
  31. fiducial_targets-0.0.1.dev1/src/fiducial/targets/page_sizes.py +39 -0
  32. fiducial_targets-0.0.1.dev1/src/fiducial/targets/patterns/__init__.py +3 -0
  33. fiducial_targets-0.0.1.dev1/src/fiducial/targets/patterns/apriltag.py +114 -0
  34. fiducial_targets-0.0.1.dev1/src/fiducial/targets/patterns/aruco.py +106 -0
  35. fiducial_targets-0.0.1.dev1/src/fiducial/targets/patterns/centering_disk.py +29 -0
  36. fiducial_targets-0.0.1.dev1/src/fiducial/targets/patterns/checkerboard.py +84 -0
  37. fiducial_targets-0.0.1.dev1/src/fiducial/targets/patterns/circles.py +426 -0
  38. fiducial_targets-0.0.1.dev1/src/fiducial/targets/placements.py +432 -0
  39. fiducial_targets-0.0.1.dev1/src/fiducial/targets/rendering/__init__.py +8 -0
  40. fiducial_targets-0.0.1.dev1/src/fiducial/targets/rendering/primitives.py +335 -0
  41. fiducial_targets-0.0.1.dev1/src/fiducial/targets/rendering/renderer.py +292 -0
  42. fiducial_targets-0.0.1.dev1/src/fiducial/targets/sidecar.py +44 -0
  43. fiducial_targets-0.0.1.dev1/src/fiducial/targets/target.py +203 -0
@@ -0,0 +1,15 @@
1
+ .claude/
2
+ __pycache__/
3
+ *.py[cod]
4
+ *.egg-info/
5
+ dist/
6
+ build/
7
+ .eggs/
8
+ .venv/
9
+ .env
10
+ .pytest_cache/
11
+ .ruff_cache/
12
+ .coverage
13
+ htmlcov/
14
+ examples/output/
15
+ examples/output_verification/
@@ -0,0 +1,102 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [0.0.1.dev1] — 2026-06-04
9
+
10
+ First public dev release. Versioned to match the sibling
11
+ [`fiducial`](https://pypi.org/project/fiducial/) detection library, with
12
+ which this package converges at v0.1.0.
13
+
14
+ ### Added
15
+
16
+ - **Composition core** — `Target`, `Placement`, `PlacementGroup`. Stack
17
+ pattern groups and ad-hoc placements in the same target frame; mix
18
+ any combination.
19
+ - **Concrete placements** — `CheckerboardSquare`, `CircleDot`, `Ring`
20
+ (Concentric Contrasting Circle / Gatrell), `CenteringDisk`,
21
+ `AprilTagMarker`, `ArucoMarker`, `Axes`, `Caption`.
22
+ - **Patterns** (`fiducial.targets.patterns`):
23
+ - `checkerboard` — `board(...)`, `square(...)`.
24
+ - `circles` — `dot`, `grid` (symmetric / asymmetric / interleaved
25
+ two-radius), `ring`, `ccc`, `ring_grid` (WhyCon-style),
26
+ `concentric_rings`, `origin_marker`.
27
+ - `apriltag` — `marker(...)` and `board(...)` for nine families
28
+ (`tag16h5`, `tag25h9`, `tag36h10`, `tag36h11`, `tagCircle21h7`,
29
+ `tagCircle49h12`, `tagCustom48h12`, `tagStandard41h12`,
30
+ `tagStandard52h13`). Bitmap layout is an independent implementation
31
+ (no upstream code port).
32
+ - `aruco` — `marker(...)` and `board(...)` for the predefined OpenCV
33
+ dictionaries (`DICT_4X4_1000`, `DICT_5X5_1000`, `DICT_6X6_1000`,
34
+ `DICT_7X7_1000`, `DICT_ARUCO_ORIGINAL`, four `DICT_APRILTAG_*`
35
+ aliases).
36
+ - `centering_disk` — `disk(...)` (N-sector centring target, default
37
+ four quadrants).
38
+ - **Composites** (`fiducial.targets.composites`):
39
+ - `chessboard_apriltag` — checkerboard with AprilTags in white
40
+ squares (ChArUco-style placement).
41
+ - `chessboard_aruco` — checkerboard with ArUco markers in white
42
+ squares.
43
+ - `corner_quads` — optional corner-refinement quads for AprilTag
44
+ boards.
45
+ - **Standard footer** — `Target.add_standard_footer(title, parameters)`
46
+ places an axis-orientation reference plus title and parameter
47
+ captions below the content extent, never overlapping ink. The footer
48
+ geometry is recorded in the YAML sidecar.
49
+ - **Content-only bounding box** —
50
+ `Target.bounding_box(include_annotations=False)`.
51
+ - **Rendering** — `CairoRenderer` with explicit `render_pdf`,
52
+ `render_svg`, `render_png` methods. Pure-cairo, mm-accurate via a
53
+ single `Context.scale`. Rendered PDFs carry
54
+ `/ViewerPreferences { /PrintScaling /None }` so viewers default to
55
+ Actual Size / 100 % rather than Fit to Page.
56
+ - **YAML sidecar** via `sidecar.write_sidecar` — bounding box,
57
+ per-placement geometry, per-group keypoints (saddle points for
58
+ chessboards, dot centres for circles, corners for markers), and
59
+ footer metadata.
60
+ - **ID ordering** — board and composite ID assignment matches
61
+ calib.io / OpenCV-aruco convention: ID 0 at the top-left in print
62
+ space, incrementing left-to-right then top-to-bottom.
63
+ - **Page sizes** — ISO 216 A0–A6 with a landscape switch, plus a
64
+ custom-size override. Custom canvases have no landscape mode (swap
65
+ the width/height arguments instead); the `landscape=` flag only
66
+ applies to named paper formats.
67
+ - **`Color`** with named factory methods.
68
+ - **Examples** — per-marker example scripts under `examples/`:
69
+ `apriltag.py`, `aruco.py`, `checkerboard.py`, `circles.py`,
70
+ `composites.py`, `origin_markers.py`, plus
71
+ `print_verification.py` (physical-print ruler + per-marker
72
+ dimension checks) and `_validate_calib_io.py` (visual validation
73
+ against a calib.io-generated reference).
74
+ - **CI workflow** — ruff + pytest on Python 3.10–3.14, x86_64 +
75
+ arm64.
76
+ - **Release workflow** — tag-triggered sdist + wheel build with PyPI
77
+ trusted publishing. Tags are pushed manually; no auto-tagging.
78
+ - **Apache-2.0 license.**
79
+
80
+ ### Packaging
81
+
82
+ - Distribution name: `fiducial-targets`. Import path: `fiducial.targets`
83
+ (same pattern as `opencv-contrib-python` → `cv2`). The wheel writes
84
+ only `fiducial/targets/`; the `fiducial/__init__.py` is provided by
85
+ the sibling `fiducial` distribution.
86
+ - Runtime dependencies: `fiducial>=0.0.1.dev1`, `numpy>=1.24`,
87
+ `pycairo>=1.25`, `pypdf>=4.0`, `pyyaml>=6.0`.
88
+
89
+ ### Notes on attribution
90
+
91
+ The `.npz` files under `src/fiducial/targets/_codes/` are upstream
92
+ code dictionaries:
93
+ - AprilTag families: BSD-2-Clause, from
94
+ [AprilRobotics/apriltag](https://github.com/AprilRobotics/apriltag).
95
+ - ArUco predefined dictionaries: Apache-2.0, from
96
+ [opencv/opencv_contrib](https://github.com/opencv/opencv_contrib).
97
+
98
+ All shipping code (the renderer, the bit decoders, the composition
99
+ machinery) is original to this project. Attribution for the data
100
+ tables is preserved in `NOTICE.md` files alongside each table. Any
101
+ prior port or vendor-tooling code has been removed from the shipping
102
+ surface (the package no longer depends on upstream rendering code).
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 Vistralis Labs
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
@@ -0,0 +1,7 @@
1
+ include LICENSE README.md CHANGELOG.md
2
+ include pyproject.toml
3
+ recursive-include src/fiducial/targets *.py *.npz NOTICE.md
4
+ prune .github
5
+ prune tests
6
+ prune examples
7
+ prune _quarantine
@@ -0,0 +1,155 @@
1
+ Metadata-Version: 2.4
2
+ Name: fiducial-targets
3
+ Version: 0.0.1.dev1
4
+ Summary: Print-ready calibration target generation (chessboards, circle grids, AprilTag, ArUco) with cairo-rendered PDF/SVG/PNG output.
5
+ Project-URL: Homepage, https://vistralis.org/fiducial-targets
6
+ Project-URL: Documentation, https://vistralis.org/fiducial-targets/docs
7
+ Project-URL: Source, https://github.com/vistralis/fiducial-targets
8
+ Project-URL: Issues, https://github.com/vistralis/fiducial-targets/issues
9
+ Project-URL: Changelog, https://github.com/vistralis/fiducial-targets/blob/main/CHANGELOG.md
10
+ Author-email: Vistralis Labs <support@vistralis.org>
11
+ License-Expression: Apache-2.0
12
+ License-File: LICENSE
13
+ Keywords: apriltag,aruco,calibration,chessboard,circle-grid,computer-vision,fiducial,marker-generation,robotics
14
+ Classifier: Development Status :: 3 - Alpha
15
+ Classifier: Intended Audience :: Science/Research
16
+ Classifier: Operating System :: MacOS
17
+ Classifier: Operating System :: POSIX :: Linux
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Programming Language :: Python :: 3.14
24
+ Classifier: Topic :: Scientific/Engineering :: Image Recognition
25
+ Requires-Python: >=3.10
26
+ Requires-Dist: fiducial>=0.0.1.dev1
27
+ Requires-Dist: numpy>=1.24
28
+ Requires-Dist: pycairo>=1.25
29
+ Requires-Dist: pypdf>=4.0
30
+ Requires-Dist: pyyaml>=6.0
31
+ Provides-Extra: dev
32
+ Requires-Dist: pillow>=10.0; extra == 'dev'
33
+ Requires-Dist: pytest-cov; extra == 'dev'
34
+ Requires-Dist: pytest>=8.0; extra == 'dev'
35
+ Requires-Dist: ruff; extra == 'dev'
36
+ Description-Content-Type: text/markdown
37
+
38
+ # fiducial-targets
39
+
40
+ ![CI](https://github.com/vistralis/fiducial-targets/actions/workflows/ci.yml/badge.svg)
41
+ [![PyPI](https://img.shields.io/pypi/v/fiducial-targets)](https://pypi.org/project/fiducial-targets/)
42
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
43
+
44
+ **Print-ready calibration target generation.** A Python library that
45
+ produces millimetre-accurate PDF, SVG, and PNG outputs for chessboards,
46
+ circle grids, AprilTag, ArUco, and arbitrary mixes of the above — with
47
+ a YAML sidecar describing the geometry detectors need.
48
+
49
+ ```bash
50
+ pip install fiducial-targets
51
+ ```
52
+
53
+ Imports live under the `fiducial.targets` namespace (the package ships
54
+ as a subpackage of [`fiducial`](https://pypi.org/project/fiducial/) —
55
+ see *Relationship to `fiducial`* below).
56
+
57
+ ## What ships in v0.0.1.dev1
58
+
59
+ - **`Target` composition** — stack pattern groups and ad-hoc placements
60
+ in the same target frame, in any mix.
61
+ - **Patterns**:
62
+ - `checkerboard` — boards of arbitrary size.
63
+ - `circles` — symmetric / asymmetric grids, interleaved two-radius
64
+ grids, WhyCon-style ring grids, concentric ring patterns, plain
65
+ dots and solid discs.
66
+ - `apriltag` — single markers and boards for nine families
67
+ (`tag16h5`, `tag25h9`, `tag36h10`, `tag36h11`, `tagCircle21h7`,
68
+ `tagCircle49h12`, `tagCustom48h12`, `tagStandard41h12`,
69
+ `tagStandard52h13`). IDs assigned top-down to match calib.io and
70
+ OpenCV-aruco conventions.
71
+ - `aruco` — single markers and boards for the predefined OpenCV
72
+ dictionaries.
73
+ - `centering_disk`, `origin_marker` — CCC origin markers, solid-disc
74
+ origins, four-sector centering disks.
75
+ - **Composites** — chessboard + AprilTag (`chessboard_apriltag`) and
76
+ chessboard + ArUco (`chessboard_aruco`) with markers inset in the
77
+ white squares.
78
+ - **Standard footer** — `Target.add_standard_footer(title, parameters)`
79
+ places an axis-orientation reference plus title and parameter
80
+ captions below the content extent, never overlapping ink.
81
+ - **`CairoRenderer`** with three explicit methods: `render_pdf`,
82
+ `render_svg`, `render_png`. Pure-cairo, mm-accurate via a single
83
+ `Context.scale`.
84
+ - **YAML sidecar** emitted next to every output, with bounding box,
85
+ per-placement geometry, per-group keypoints, and footer metadata.
86
+ - **ISO 216 paper formats** (A0–A6) with a landscape switch and a
87
+ custom-size override.
88
+
89
+ ## Quick start
90
+
91
+ ```python
92
+ from pathlib import Path
93
+ from fiducial.targets import Target, PageSize, CairoRenderer
94
+ from fiducial.targets.patterns import checkerboard, circles
95
+
96
+ target = Target()
97
+ target.add(checkerboard.board(columns=7, rows=6, square_size=25.0))
98
+ target.add(circles.dot(center=(200.0, 50.0), radius=8.0))
99
+ target.add_standard_footer(
100
+ title="Chess 7x6 + auxiliary dot",
101
+ parameters=("square=25mm", "dot r=8mm"),
102
+ )
103
+
104
+ CairoRenderer().render_pdf(target, PageSize.named("A4"), Path("board.pdf"))
105
+ ```
106
+
107
+ All length values are millimetres. Non-mm quantities carry an explicit
108
+ suffix (`_px`, `_pt`).
109
+
110
+ ## Relationship to `fiducial`
111
+
112
+ `fiducial-targets` is the generator half of a two-package split.
113
+ [`fiducial`](https://pypi.org/project/fiducial/) is the application-
114
+ facing detection library — that's where production code lives and
115
+ where the target-description data contract is owned. This package
116
+ generates the printable targets `fiducial` consumes, with a YAML
117
+ sidecar that documents the ground-truth layout.
118
+
119
+ Both packages converge at **v0.1.0**, at which point
120
+ `fiducial-targets` will source its payload dataclasses from `fiducial`
121
+ (no API change on either side; users continue to write
122
+ `from fiducial.targets import ...`).
123
+
124
+ ## Status
125
+
126
+ Early development. The public surface is intentionally small while
127
+ both packages stabilise toward the joint v0.1.0 cut. Expect minor
128
+ imports to shift, but the surfaces named above are the ones intended
129
+ to ship.
130
+
131
+ ## IP / attribution
132
+
133
+ All shipping code is original to this project. The `.npz` data tables
134
+ under `src/fiducial/targets/_codes/` are upstream code dictionaries:
135
+ - AprilTag families: BSD-2-Clause, from
136
+ [AprilRobotics/apriltag](https://github.com/AprilRobotics/apriltag).
137
+ - ArUco predefined dictionaries: Apache-2.0, from
138
+ [opencv/opencv_contrib](https://github.com/opencv/opencv_contrib).
139
+
140
+ Attribution is preserved in `NOTICE.md` files alongside each table.
141
+
142
+ ## Development
143
+
144
+ ```bash
145
+ pip install -e ".[dev]"
146
+ ruff check .
147
+ ruff format --check .
148
+ pytest
149
+ ```
150
+
151
+ ## License
152
+
153
+ Apache-2.0 — see [LICENSE](LICENSE).
154
+
155
+ Copyright (c) 2026 Vistralis Labs.
@@ -0,0 +1,118 @@
1
+ # fiducial-targets
2
+
3
+ ![CI](https://github.com/vistralis/fiducial-targets/actions/workflows/ci.yml/badge.svg)
4
+ [![PyPI](https://img.shields.io/pypi/v/fiducial-targets)](https://pypi.org/project/fiducial-targets/)
5
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
6
+
7
+ **Print-ready calibration target generation.** A Python library that
8
+ produces millimetre-accurate PDF, SVG, and PNG outputs for chessboards,
9
+ circle grids, AprilTag, ArUco, and arbitrary mixes of the above — with
10
+ a YAML sidecar describing the geometry detectors need.
11
+
12
+ ```bash
13
+ pip install fiducial-targets
14
+ ```
15
+
16
+ Imports live under the `fiducial.targets` namespace (the package ships
17
+ as a subpackage of [`fiducial`](https://pypi.org/project/fiducial/) —
18
+ see *Relationship to `fiducial`* below).
19
+
20
+ ## What ships in v0.0.1.dev1
21
+
22
+ - **`Target` composition** — stack pattern groups and ad-hoc placements
23
+ in the same target frame, in any mix.
24
+ - **Patterns**:
25
+ - `checkerboard` — boards of arbitrary size.
26
+ - `circles` — symmetric / asymmetric grids, interleaved two-radius
27
+ grids, WhyCon-style ring grids, concentric ring patterns, plain
28
+ dots and solid discs.
29
+ - `apriltag` — single markers and boards for nine families
30
+ (`tag16h5`, `tag25h9`, `tag36h10`, `tag36h11`, `tagCircle21h7`,
31
+ `tagCircle49h12`, `tagCustom48h12`, `tagStandard41h12`,
32
+ `tagStandard52h13`). IDs assigned top-down to match calib.io and
33
+ OpenCV-aruco conventions.
34
+ - `aruco` — single markers and boards for the predefined OpenCV
35
+ dictionaries.
36
+ - `centering_disk`, `origin_marker` — CCC origin markers, solid-disc
37
+ origins, four-sector centering disks.
38
+ - **Composites** — chessboard + AprilTag (`chessboard_apriltag`) and
39
+ chessboard + ArUco (`chessboard_aruco`) with markers inset in the
40
+ white squares.
41
+ - **Standard footer** — `Target.add_standard_footer(title, parameters)`
42
+ places an axis-orientation reference plus title and parameter
43
+ captions below the content extent, never overlapping ink.
44
+ - **`CairoRenderer`** with three explicit methods: `render_pdf`,
45
+ `render_svg`, `render_png`. Pure-cairo, mm-accurate via a single
46
+ `Context.scale`.
47
+ - **YAML sidecar** emitted next to every output, with bounding box,
48
+ per-placement geometry, per-group keypoints, and footer metadata.
49
+ - **ISO 216 paper formats** (A0–A6) with a landscape switch and a
50
+ custom-size override.
51
+
52
+ ## Quick start
53
+
54
+ ```python
55
+ from pathlib import Path
56
+ from fiducial.targets import Target, PageSize, CairoRenderer
57
+ from fiducial.targets.patterns import checkerboard, circles
58
+
59
+ target = Target()
60
+ target.add(checkerboard.board(columns=7, rows=6, square_size=25.0))
61
+ target.add(circles.dot(center=(200.0, 50.0), radius=8.0))
62
+ target.add_standard_footer(
63
+ title="Chess 7x6 + auxiliary dot",
64
+ parameters=("square=25mm", "dot r=8mm"),
65
+ )
66
+
67
+ CairoRenderer().render_pdf(target, PageSize.named("A4"), Path("board.pdf"))
68
+ ```
69
+
70
+ All length values are millimetres. Non-mm quantities carry an explicit
71
+ suffix (`_px`, `_pt`).
72
+
73
+ ## Relationship to `fiducial`
74
+
75
+ `fiducial-targets` is the generator half of a two-package split.
76
+ [`fiducial`](https://pypi.org/project/fiducial/) is the application-
77
+ facing detection library — that's where production code lives and
78
+ where the target-description data contract is owned. This package
79
+ generates the printable targets `fiducial` consumes, with a YAML
80
+ sidecar that documents the ground-truth layout.
81
+
82
+ Both packages converge at **v0.1.0**, at which point
83
+ `fiducial-targets` will source its payload dataclasses from `fiducial`
84
+ (no API change on either side; users continue to write
85
+ `from fiducial.targets import ...`).
86
+
87
+ ## Status
88
+
89
+ Early development. The public surface is intentionally small while
90
+ both packages stabilise toward the joint v0.1.0 cut. Expect minor
91
+ imports to shift, but the surfaces named above are the ones intended
92
+ to ship.
93
+
94
+ ## IP / attribution
95
+
96
+ All shipping code is original to this project. The `.npz` data tables
97
+ under `src/fiducial/targets/_codes/` are upstream code dictionaries:
98
+ - AprilTag families: BSD-2-Clause, from
99
+ [AprilRobotics/apriltag](https://github.com/AprilRobotics/apriltag).
100
+ - ArUco predefined dictionaries: Apache-2.0, from
101
+ [opencv/opencv_contrib](https://github.com/opencv/opencv_contrib).
102
+
103
+ Attribution is preserved in `NOTICE.md` files alongside each table.
104
+
105
+ ## Development
106
+
107
+ ```bash
108
+ pip install -e ".[dev]"
109
+ ruff check .
110
+ ruff format --check .
111
+ pytest
112
+ ```
113
+
114
+ ## License
115
+
116
+ Apache-2.0 — see [LICENSE](LICENSE).
117
+
118
+ Copyright (c) 2026 Vistralis Labs.