---
title: "Settings API"
product: "LumiScan VGR"
component: "lumiscan-vgr"
version: "1.8.4"
display_version: "1.8.4.6"
latest_version: true
language: "en"
url: "https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/settings.html"
---

# Settings API – LumiScan VGR

The Settings API documentation provides a complete reference for all JSON configuration parameters used by LumiScan VGR.

This includes settings for:

- Camera configuration
- Object detection (2D and 3D)
- Robot waypoint settings
- Grip point settings
- Path segment settings
- Symmetry settings
- Cloud processing filters

The complete reference is integrated natively on this site — every configuration class and struct has its own page, listed below. The pages are generated from the Doxygen source documentation of `settings.h`.

## All Settings Pages

- [AutoexposureSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/autoexposure-settings.html)
- [BoxFilterParameter](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/box-filter-parameter.html)
- [CameraSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/camera-settings.html)
- [CloudFilterParameterBase](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/cloud-filter-parameter-base.html)
- [ConcreteCloudFilterParameterBase](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/concrete-cloud-filter-parameter-base.html)
- [CorrectionFeature](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/correction-feature.html)
- [CorrectionSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/correction-settings.html)
- [CorrectionSettings< CAMERA_CORRECTION_TYPE::CLOUD_SCALE >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/correction-settings-camera-correction-type-cloud-scale.html)
- [CorrectionSettings< CAMERA_CORRECTION_TYPE::CLOUD_Z_CALIBRATION >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/correction-settings-camera-correction-type-cloud-z-calibration.html)
- [CorrectionSettings< CAMERA_CORRECTION_TYPE::CLOUD_Z_CALIBRATION >::ImageDistancePair](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/correction-settings-camera-correction-type-cloud-z-calibration-imagedistancepair.html)
- [CorrectionSettingsBase](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/correction-settings-base.html)
- [DepthEstimationSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/depth-estimation-settings.html)
- [Detection2DSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-settings.html)
- [Detection2DStepSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::ADD_INSTANCES_FROM_FILE >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-add-instances-from-file.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::FEATURE_MATCHING >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-feature-matching.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::FILTER_CLASSIFICATION >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-filter-classification.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::REORIENT_ASPECT >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-reorient-aspect.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::REORIENT_CLASSIFICATION >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-reorient-classification.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::ROTATE_ANGLE >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-rotate-angle.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::SCALE >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-scale.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::SCALE_ASPECT >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-scale-aspect.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::SCALE_TO >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-scale-to.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::SET_FULL >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-set-full.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::SET_NETWORK >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-set-network.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::SET_OTHER >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-set-other.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::SET_ROI >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-set-roi.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::SET_ROI_PIPELINE >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-set-roi-pipeline.html)
- [Detection2DStepSettings< OBJ_DET_2D_TYPE::TRANSLATE >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-obj-det-2d-type-translate.html)
- [Detection2DStepSettingsBase](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-2d-step-settings-base.html)
- [Detection3DSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-3d-settings.html)
- [Detection3DSettings< OBJECT_FIT_METHOD::GRIP_FROM_ENVIRONMENT >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-3d-settings-object-fit-method-grip-from-environment.html)
- [Detection3DSettings< OBJECT_FIT_METHOD::LINE_FIT_LONG_AXIS >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-3d-settings-object-fit-method-line-fit-long-axis.html)
- [Detection3DSettings< OBJECT_FIT_METHOD::MIXED_PLANE_FIT >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-3d-settings-object-fit-method-mixed-plane-fit.html)
- [Detection3DSettings< OBJECT_FIT_METHOD::OBJECT_MATCHING >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-3d-settings-object-fit-method-object-matching.html)
- [Detection3DSettings< OBJECT_FIT_METHOD::OBJECT_REFINEMENT >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-3d-settings-object-fit-method-object-refinement.html)
- [Detection3DSettings< OBJECT_FIT_METHOD::PLANE_FIT >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-3d-settings-object-fit-method-plane-fit.html)
- [Detection3DSettings< OBJECT_FIT_METHOD::RANSAC_CYLINDER_FIT >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-3d-settings-object-fit-method-ransac-cylinder-fit.html)
- [Detection3DSettings< OBJECT_FIT_METHOD::RANSAC_PLANE_FIT >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-3d-settings-object-fit-method-ransac-plane-fit.html)
- [Detection3DSettingsBase](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-3d-settings-base.html)
- [Detection3DSettingsGeom](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/detection-3d-settings-geom.html)
- [DistanceToReferencePointParameter](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/distance-to-reference-point-parameter.html)
- [FilteringObject2DParameterBase](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/filtering-object-2d-parameter-base.html)
- [GripPointCorrection](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/grip-point-correction.html)
- [GripPointCorrection::OffsetMap](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/grip-point-correction-offset-map.html)
- [GripPointFilterSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/grip-point-filter-settings.html)
- [GripPointFilterSettings< FILTER_TYPE::Z_AXIS >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/grip-point-filter-settings-filter-type-z-axis.html)
- [GripPointFilterSettingsBase](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/grip-point-filter-settings-base.html)
- [GripPointSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/grip-point-settings.html)
- [ModelTrainingParameters](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/model-training-parameters.html)
- [NetworkSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/network-settings.html)
- [NullSort](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/null-sort.html)
- [ObjectDetectionParameters](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/object-detection-parameters.html)
- [ObjectRefinementParameters](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/object-refinement-parameters.html)
- [ObjectSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/object-settings.html)
- [old_network_description::InputLayout](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/old-network-description-input-layout.html)
- [old_network_description::NetworkDescription](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/old-network-description-network-description.html)
- [old_network_description::OutputLayout](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/old-network-description-output-layout.html)
- [old_network_description::TensorLayout](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/old-network-description-tensor-layout.html)
- [PathSegmentSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/path-segment-settings.html)
- [PipelineSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/pipeline-settings.html)
- [PipelineSystemSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/pipeline-system-settings.html)
- [ProjectSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/project-settings.html)
- [RadiusOutlierRemovalParameters](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/radius-outlier-removal-parameters.html)
- [RecordingSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/recording-settings.html)
- [RecordingSystemSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/recording-system-settings.html)
- [RemoveNaNFilterParameter](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/remove-na-n-filter-parameter.html)
- [RobotSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/robot-settings.html)
- [SortDirection](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/sort-direction.html)
- [SortingBase](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/sorting-base.html)
- [SortingBaseCRTP](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/sorting-base-crtp.html)
- [SortingObject2DParameterBase](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/sorting-object-2d-parameter-base.html)
- [SortPosition](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/sort-position.html)
- [SymmetrySettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/symmetry-settings.html)
- [SymmetrySettings< SYMMETRY_TYPE::ROTATION >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/symmetry-settings-symmetry-type-rotation.html)
- [SymmetrySettingsBase](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/symmetry-settings-base.html)
- [SystemSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/system-settings.html)
- [TopNParameter](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/top-n-parameter.html)
- [Transform](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/transform.html)
- [UserSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/user-settings.html)
- [WaypointSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/waypoint-settings.html)
- [WaypointSettings< WAYPOINT_TYPE::WP_ABSOLUTE >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/waypoint-settings-waypoint-type-wp-absolute.html)
- [WaypointSettings< WAYPOINT_TYPE::WP_CLONE >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/waypoint-settings-waypoint-type-wp-clone.html)
- [WaypointSettings< WAYPOINT_TYPE::WP_GRIP_POINT >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/waypoint-settings-waypoint-type-wp-grip-point.html)
- [WaypointSettings< WAYPOINT_TYPE::WP_RELATIVE >](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/waypoint-settings-waypoint-type-wp-relative.html)
- [WaypointSettingsBase](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/waypoint-settings-base.html)