ScArucoDictionary Struct Reference
Public Member Functions | |
| ScArucoDictionary * | sc_aruco_dictionary_from_preset (ScArucoDictionaryPreset preset) |
| void | sc_aruco_dictionary_retain (ScArucoDictionary *dictionary) |
| void | sc_aruco_dictionary_release (ScArucoDictionary *dictionary) |
| ScArucoDictionary * | sc_aruco_dictionary_new (uint32_t marker_size) |
| ScBool | sc_aruco_dictionary_add_marker (ScArucoDictionary *dictionary, uint8_t *marker_bits, uint32_t marker_size) |
Detailed Description
ArUco Symbology Dictionary.
- Since
- 5.30.0
Member Function Documentation
| ScArucoDictionary * sc_aruco_dictionary_from_preset | ( | ScArucoDictionaryPreset | preset | ) |
creates a constant prefilled dictionary
- Parameters
-
preset dictionary preset, identical to the presets available in OpenCV
- Returns
- a pointer to a dictionary, must be freed after use
- Since
- 5.30.0
| void sc_aruco_dictionary_retain | ( | ScArucoDictionary * | dictionary | ) |
Increase reference count of an Aruco dictionary by one.
- Parameters
-
dictionary The Aruco dictionary object. Cannot be null
- Since
- 5.30.0
| void sc_aruco_dictionary_release | ( | ScArucoDictionary * | dictionary | ) |
Decrease reference count of an Aruco dictionary by one.
When the reference count drops to zero, the dictionary is deallocated.
- Parameters
-
dictionary The Aruco dictionary object. May be null
- Since
- 5.30.0
| ScArucoDictionary * sc_aruco_dictionary_new | ( | uint32_t | marker_size | ) |
creates a new aruco dictionary with the specified marker size
- Parameters
-
marker_size size of the markers in the dictionary, e.g. for a 5x5 marker this would be 5
- Returns
- a pointer to the dictionary, must be freed after use
- Since
- 5.30.0
| ScBool sc_aruco_dictionary_add_marker | ( | ScArucoDictionary * | dictionary, |
| uint8_t * | marker_bits, | ||
| uint32_t | marker_size | ||
| ) |
adds an aruco marker to a dictionary. Serialization of dictionaries created or modified using this function is not supported.
- Parameters
-
dictionary pointer to a aruco dictionary, cannot be null marker_bits array of bytes of size marker_size * marker_size, includes the data for the marker and must be either 0 (for black) or 1 (for white). The first element of marker_bits corresponds to the top left corner of the bit matrix, where the last element corresponds to the bottom right corner of the bit matrix. marker_size size of one side of the marker, e.g. for a 5x5 marker it would be 5.
- Returns
- true if the marker was successfully added, false if the marker_bits are of another size than the markers in the dictionary or if the creation of the marker failed
- Since
- 5.30.0
The documentation for this struct was generated from the following file: