Public Member Functions | Public Attributes | List of all members
crl::multisense::system::ApriltagParams Class Reference

#include <MultiSenseTypes.hh>

Public Member Functions

 ApriltagParams ()
 

Public Attributes

double decode_sharpening
 
std::string family
 
uint8_t max_hamming
 
size_t min_border_width
 
double quad_detection_blur_sigma
 
double quad_detection_decimate
 
bool refine_quad_edges
 

Detailed Description

Class containing parameters for the apriltag fiducial detection algorithm application which may be running on the specifically commissioned MultiSenses.

Example code to set a device's apriltag parameters:

//
// Instantiate a channel connecting to a sensor at the factory default
// IP address
channel = crl::multisense::Channel::Create("10.66.171.21");
channel->setMtu(1500);
//
// Create a instance of ApriltagParams to store the device's params
//
// Set the parameter values
params.family = "tagStandard52h13";
params.max_hamming = 0;
params.min_border_width = 5;
params.refine_quad_edges = false;
params.decode_sharpening = 0.25;
//
// Send the new external calibration to the device
crl::multisense::Status status = channel->setApriltagParams(params));
//
// Check to see if the new network configuration was received
throw std::runtime_error("Unable to set the devices's apriltag params");
}
//
// Destroy the channel instance

Definition at line 3880 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

Constructor & Destructor Documentation

◆ ApriltagParams()

crl::multisense::system::ApriltagParams::ApriltagParams ( )
inline

Default constructor

Definition at line 3926 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

Member Data Documentation

◆ decode_sharpening

double crl::multisense::system::ApriltagParams::decode_sharpening

How much to sharpen the quad before sampling the pixels. After the homography turns the sampled pixels into a perfect square image representing the tag bits, the sharpening is applied bring out the potentially soft edges. 0 to turn off, large values are stronger sharpening, recommended to stay below 1

Definition at line 3923 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ family

std::string crl::multisense::system::ApriltagParams::family

Apriltag family to detect

Definition at line 3883 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ max_hamming

uint8_t crl::multisense::system::ApriltagParams::max_hamming

The maximum hamming correction that will be applied while detecting codes

Definition at line 3886 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ min_border_width

size_t crl::multisense::system::ApriltagParams::min_border_width

Minimum border width that can be considered a valid tag. Used to filter contours based on area and perimeter. Units are in undecimated image pixels. Increasing the value will speed up the detector and may reduce false detection rates at the expense of reducing ability to detect small tags. NOTE: If this value is smaller than the smallest tag border, detector will override with the minimum border width out of the active families in the detector.

   Family border widths for reference:
       tag16h5 : 6 px
       tag25h9 : 7 px
       tag36h11 : 8 px
       tagCircle21h7 : 5 px
       tagCircle49h12 : 5 px
       tagCustom48h12 : 6 px
       tagStandard41h12 : 5 px
       tagStandard52h13 : 6 px

Definition at line 3914 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ quad_detection_blur_sigma

double crl::multisense::system::ApriltagParams::quad_detection_blur_sigma

Sigma of the Gaussian blur applied to the image before quad_detection Specified in full resolution pixels. Kernel size = 4*sigma, rounded up to the next odd number. (<0.5 results in no blur)

Definition at line 3891 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ quad_detection_decimate

double crl::multisense::system::ApriltagParams::quad_detection_decimate

Amount to decimate image before detecting quads. Values < 1.0 (0.5 decimation reduces height/width by half)

Definition at line 3895 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ refine_quad_edges

bool crl::multisense::system::ApriltagParams::refine_quad_edges

Whether or not to refine the edges before attempting to decode

Definition at line 3917 of file Legacy/include/MultiSense/MultiSenseTypes.hh.


The documentation for this class was generated from the following file:
crl::multisense::Status_Ok
static CRL_CONSTEXPR Status Status_Ok
Definition: Legacy/include/MultiSense/MultiSenseTypes.hh:99
crl::multisense::system::ApriltagParams::min_border_width
size_t min_border_width
Definition: Legacy/include/MultiSense/MultiSenseTypes.hh:3914
crl::multisense::Channel::Destroy
static void Destroy(Channel *instanceP)
Definition: Legacy/details/channel.cc:863
crl::multisense::system::ApriltagParams::decode_sharpening
double decode_sharpening
Definition: Legacy/include/MultiSense/MultiSenseTypes.hh:3923
crl::multisense::Channel::setApriltagParams
virtual Status setApriltagParams(const system::ApriltagParams &params)=0
crl::multisense::Channel::setMtu
virtual Status setMtu(int32_t mtu)=0
crl::multisense::system::ApriltagParams::quad_detection_decimate
double quad_detection_decimate
Definition: Legacy/include/MultiSense/MultiSenseTypes.hh:3895
crl::multisense::system::ApriltagParams::max_hamming
uint8_t max_hamming
Definition: Legacy/include/MultiSense/MultiSenseTypes.hh:3886
crl::multisense::Channel::Create
static Channel * Create(const std::string &sensorAddress)
Definition: Legacy/details/channel.cc:817
crl::multisense::system::ApriltagParams::refine_quad_edges
bool refine_quad_edges
Definition: Legacy/include/MultiSense/MultiSenseTypes.hh:3917
crl::multisense::Status
int32_t Status
Definition: Legacy/include/MultiSense/MultiSenseTypes.hh:94
crl::multisense::Channel
Definition: Legacy/include/MultiSense/MultiSenseChannel.hh:69
crl::multisense::system::ApriltagParams::family
std::string family
Definition: Legacy/include/MultiSense/MultiSenseTypes.hh:3883
crl::multisense::system::ApriltagParams::quad_detection_blur_sigma
double quad_detection_blur_sigma
Definition: Legacy/include/MultiSense/MultiSenseTypes.hh:3891
crl::multisense::system::ApriltagParams
Definition: Legacy/include/MultiSense/MultiSenseTypes.hh:3880


multisense_lib
Author(s):
autogenerated on Thu Apr 17 2025 02:49:10