# plane_calibration_config

Python API: `depthai_nodes.node.support_plane_calibrator.plane_calibration_config`

Plane-fitting and attempt settings for `SupportPlaneCalibrator`.

## Classes

### PlaneCalibrationConfig

Plane-fitting and attempt settings for `SupportPlaneCalibrator`.

The settings are fixed at build.

Raises

 * `TypeError`: If a field has the wrong type.
 * `ValueError`: If a field is not finite or out of range.

#### Attributes

##### check_distance_mm

Largest distance, in millimeters, of a point from a verified plane for it to count as on the plane in a plane verification's
on-plane ratio. Separate from RANSAC's `distance_threshold_mm`. Must be positive.

##### distance_threshold_mm

Largest distance of a RANSAC inlier from the plane, in millimeters. Must be positive.

##### max_calibration_attempts

Point clouds fitted in one calibration attempt, not Starts, before an attempt without candidates ends `FAILED`. At least 1, or
`None` to search until stopped.

##### max_camera_height_mm

Largest distance, in millimeters, from the camera down to a plane that passes the level test. Positive and at least
`min_camera_height_mm`, or `None` for no bound.

##### max_gravity_angle_deg

Largest angle between a plane normal and the direction opposing gravity, from 0 up to but excluding 90.

##### max_plane_passes

Planes extracted from one point cloud. At least 1.

##### merge_distance_threshold_mm

Largest offset difference, in millimeters, at which two parallel candidates count as one plane. Must be positive.

##### min_camera_height_mm

Smallest distance, in millimeters, from the camera down to a plane that passes the level test, for a camera mounted at a known
height. Positive, or `None` for no bound.

##### min_inlier_count

Smallest number of points a plane must hold, however small the cloud. Counted after downsampling, so one point stands for about
one `voxel_size_mm` square of a surface. At least 1.

##### min_inlier_ratio

Smallest share of the cloud a plane must hold, from 0 to 1.

##### min_on_plane_ratio

Smallest on-plane ratio, from 0 to 1, at which a plane verification accepts a plane that passes the level test. Separate from
`min_inlier_ratio`, which applies to fitting.

##### ransac_max_iterations

RANSAC iterations per plane. At least 1.

##### ransac_sample_points

Points sampled per RANSAC iteration. At least 3.

##### voxel_size_mm

Downsampling voxel size in millimeters. Must be positive.
