 |
SCENE C++ API
2.0.31
|
|
SCENE C++ API
2.0.31
|
Interface to read and write settings for processing. More...
#include <lsprocesssettings.h>
Inheritance diagram for LSProcessSettings:Public Types | |
| enum | Colorization : uint8_t { NO_COLORIZATION, COLORIZE_SCANS, LASER_ILUMINATED_HDR } |
| Options for the colorization of scans. More... | |
Public Member Functions | |
| LSResult::Result | setDarkScanPointFilter (const bool filterState) |
| The dark scan point filter removes points based on a minimum reflectance value. More... | |
| bool | getDarkScanPointFilter () const |
| Get the state of dark scan point filter. More... | |
| LSResult::Result | setFilterReflectanceThreshold (const int reflectance) |
| The reflectance threshold value indicates the minimum reflectance value a scan point must have. More... | |
| int | getFilterReflectanceThreshold () const |
| Get reflectance threshold. More... | |
| LSResult::Result | setColorization (Colorization colorization) |
| During processing, it is possible to apply color to each point based on the pictures taken by the scanner. More... | |
| Colorization | getColorization () const |
| Get colorization method. More... | |
| LSResult::Result | setDistanceFilter (const bool filterState) |
| The distance filter simply removes scan points which are outside of a distance range which is defined by the minimum and maximum distance. More... | |
| bool | getDistanceFilter () const |
| Get the state of distance filter. More... | |
| LSResult::Result | setFilterMinimumDistance (const double distanceValue) |
| Specify the minimum distance in meters for the distance filter. More... | |
| double | getFilterMinimumDistance () const |
| Get minimum distance in meters. More... | |
| LSResult::Result | setFilterMaximumDistance (const double distanceValue) |
| Specify the maximum distance in meters of the distance filter. More... | |
| double | getFilterMaximumDistance () const |
| Get maximum distance in meters. More... | |
| LSResult::Result | setEdgeArtifactFilter (const bool filterState) |
| The edge artifact filter is especially useful to remove artifacts at the edges of objects. More... | |
| bool | getEdgeArtifactFilter () const |
| Get the state of Edge Artifact Filter. More... | |
| LSResult::Result | setStrayFilter (const bool filterState) |
| The Stray Point Filter checks if the 2D grid cell of a scan point contains a sufficient percentage of points with a distance similar to the scan point itself. More... | |
| bool | getStrayFilter () const |
| Get the state of Stray Point Filter. More... | |
| LSResult::Result | setStrayFilterGridSize (const int gridSize) |
| The size of the surrounding area used for comparison. More... | |
| int | getStrayFilterGridSize () const |
| Get the Size of grid. More... | |
| LSResult::Result | setStrayFilterDistance (const double strayDistance) |
| A scan point is counted if the difference in distance is smaller than the Distance Threshold. More... | |
| double | getStrayFilterDistance () const |
| Get the Stray Distance. More... | |
| LSResult::Result | setStrayFilterAllocation (const double allocationPercentage) |
| If at least the percentage of scan points indicated by the Allocation Threshold in the surrounding area is also within this distance threshold, the scan point remains in the scan. More... | |
| double | getStrayFilterAllocation () const |
| Get the Allocation Threshold. More... | |
| LSResult::Result | setSphereDetection (const bool filterState) |
| SCENE can find spheres in the scans during processing. More... | |
| bool | getSphereDetection () const |
| Get the state of sphere detection. More... | |
| LSResult::Result | setActiveSphereRadii (const std::vector< double > &radiiVector) |
| Set the list of active sphere radii in meters.The active sphere radii are used during processing when searching for spheres is active. More... | |
| std::vector< double > | getActiveSphereRadii () const |
| Get the list of active sphere radii in meters. More... | |
| LSResult::Result | setCheckboardsDetection (const bool filterState) |
| SCENE can find checkerboard targets in the scans during processing. More... | |
| bool | getCheckboardsDetection () const |
| Get the state of checkerboard target detection. More... | |
| LSResult::Result | setPlaneDetection (const bool filterState) |
| SCENE can find planes in the scans during processing. More... | |
| bool | getPlaneDetection () const |
| Get the state of planes detection. More... | |
| LSResult::Result | setMarkerDetection (const bool filterState) |
| SCENE can find Freestyle markers in the scans during processing. More... | |
| bool | getMarkerDetection () const |
| Get the state of Freestyle marker detection. More... | |
| LSResult::Result | setCreatePointClouds (const bool creationState) |
| If enabled, a scan point cloud for each scan will be created as last part of the processing. More... | |
| bool | getCreatePointClouds () const |
| Get the state of point cloud creation. More... | |
| Public Member Functions inherited from LSAttributeContainer | |
| LSString | getTypeName () const |
| Gets the type name of this instance. More... | |
| LSString | getName () const |
| Gets the name of the container. More... | |
| LSResult::Result | setName (LSString name) |
| Sets the name of the container. More... | |
| LSString | getUuid () const |
| Returns the unique id of the container. More... | |
| LSString | assignUuid () |
| Assigns a unique id to the container if the container does not not yet have a unique id. More... | |
| unsigned int | getNumAttributes () const |
| Get the number of attributes in the container. More... | |
| LSString | getAttributeName (unsigned int index) const |
| Get the name of an attribute in the container. More... | |
| unsigned int | getAttributeIndex (LSString name) const |
| Get the index of an attribute in the container. More... | |
| LSAttribute | getAttribute (unsigned int index) const |
| Get an attribute based on its index. More... | |
| LSAttribute | getAttribute (LSString name) const |
| Get an attribute based on its name. More... | |
| LSResult::Result | setAttribute (unsigned int index, const LSAttribute &attribute) |
| Set an attribute based on its index. More... | |
| LSResult::Result | setAttribute (LSString name, const LSAttribute &attribute) |
| Set an attribute based on its name. More... | |
| LSResult::Result | addCustomAttribute (LSString name, const LSAttribute &attribute) |
| Add a new custom attribute to the container. More... | |
| bool | removeCustomAttribute (LSString name) |
| Remove a custom attribute from the container. More... | |
| unsigned int | getNumFields () const |
| Returns the number of fields in the container. More... | |
| ref_ptr< LSAttributeContainer > | getField (unsigned int index) const |
| Returns the field at position n in the container. More... | |
| ref_ptr< LSAttributeContainer > | getField (const LSString &name) const |
| Returns the field with the given name. More... | |
| LSResult::Result | addField (const LSString &name, const LSString &typeName, ref_ptr< LSAttributeContainer > &fieldOut) |
| Add a field to the container. More... | |
| bool | rmField (const LSString &name) |
| Removes the field with a given name from the container. More... | |
Static Public Member Functions | |
| static ref_ptr< LSProcessSettings > | create () |
| Creates a new settings object based on a copy of the current SCENE settings. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from LSRefType | |
| void | ref () const |
| Increments the internal reference counter. More... | |
| void | unref () const |
| Decrements the internal reference counter. More... | |
Interface to read and write settings for processing.
An LSProcessSettings object can be used as additional parameter for processScan() to specify the processing settings.
|
strong |
|
static |
Creates a new settings object based on a copy of the current SCENE settings.
This instance can then be used as a parameter when running processScan().
| LSResult::Result setDarkScanPointFilter | ( | const bool | filterState | ) |
The dark scan point filter removes points based on a minimum reflectance value.
| filterState |
|
| bool getDarkScanPointFilter | ( | ) | const |
Get the state of dark scan point filter.
For more information please see setDarkScanPointFilter().
| LSResult::Result setFilterReflectanceThreshold | ( | const int | reflectance | ) |
The reflectance threshold value indicates the minimum reflectance value a scan point must have.
| reflectance | Minimum reflectance value |
| int getFilterReflectanceThreshold | ( | ) | const |
Get reflectance threshold.
For more information please see setFilterReflectanceThreshold().
| LSResult::Result setColorization | ( | Colorization | colorization | ) |
During processing, it is possible to apply color to each point based on the pictures taken by the scanner.
| colorization | Enum containing the method of colorization. |
| Colorization getColorization | ( | ) | const |
Get colorization method.
For more information please see setColorization().
| LSResult::Result setDistanceFilter | ( | const bool | filterState | ) |
The distance filter simply removes scan points which are outside of a distance range which is defined by the minimum and maximum distance.
| filterState |
|
| bool getDistanceFilter | ( | ) | const |
Get the state of distance filter.
For more information please see setDistanceFilter().
| LSResult::Result setFilterMinimumDistance | ( | const double | distanceValue | ) |
Specify the minimum distance in meters for the distance filter.
For more information please see setDistanceFilter().
| distanceValue | Minimum distance in meters |
| double getFilterMinimumDistance | ( | ) | const |
Get minimum distance in meters.
For more information please see setFilterMinimumDistance().
| LSResult::Result setFilterMaximumDistance | ( | const double | distanceValue | ) |
Specify the maximum distance in meters of the distance filter.
For more information please see setDistanceFilter().
| distanceValue | Maximum distance in meters |
| double getFilterMaximumDistance | ( | ) | const |
Get maximum distance in meters.
For more information please see setFilterMinimumDistance().
| LSResult::Result setEdgeArtifactFilter | ( | const bool | filterState | ) |
The edge artifact filter is especially useful to remove artifacts at the edges of objects.
| filterState |
|
| bool getEdgeArtifactFilter | ( | ) | const |
Get the state of Edge Artifact Filter.
For more information please see setEdgeArtifactFilter().
| LSResult::Result setStrayFilter | ( | const bool | filterState | ) |
The Stray Point Filter checks if the 2D grid cell of a scan point contains a sufficient percentage of points with a distance similar to the scan point itself.
| filterState |
|
| bool getStrayFilter | ( | ) | const |
Get the state of Stray Point Filter.
For more information please see setStrayFilter().
| LSResult::Result setStrayFilterGridSize | ( | const int | gridSize | ) |
The size of the surrounding area used for comparison.
For each scan point of the scan the filter takes the valid scan points of this surrounding area and counts how many of them are at a distance to the scanner which is approximately the same as the distance of the scan point currently being checked. For more information please see setStrayFilter().
| gridSize | Size of grid |
| int getStrayFilterGridSize | ( | ) | const |
Get the Size of grid.
For more information please see setStrayFilterGridSize().
| LSResult::Result setStrayFilterDistance | ( | const double | strayDistance | ) |
A scan point is counted if the difference in distance is smaller than the Distance Threshold.
For more information please see setStrayFilter().
| strayDistance | Distance in meters |
| double getStrayFilterDistance | ( | ) | const |
Get the Stray Distance.
For more information please see setStrayFilterDistance().
| LSResult::Result setStrayFilterAllocation | ( | const double | allocationPercentage | ) |
If at least the percentage of scan points indicated by the Allocation Threshold in the surrounding area is also within this distance threshold, the scan point remains in the scan.
Otherwise it is removed. For more information please see setStrayFilter().
| allocationPercentage | Percentage of scan points |
| double getStrayFilterAllocation | ( | ) | const |
Get the Allocation Threshold.
For more information please see setStrayFilterAllocation().
| LSResult::Result setSphereDetection | ( | const bool | filterState | ) |
SCENE can find spheres in the scans during processing.
| filterState |
|
| bool getSphereDetection | ( | ) | const |
Get the state of sphere detection.
For more information please see setSphereDetection().
| LSResult::Result setActiveSphereRadii | ( | const std::vector< double > & | radiiVector | ) |
Set the list of active sphere radii in meters.The active sphere radii are used during processing when searching for spheres is active.
For more information please see setSphereDetection().
| radiiVector | Vector of double values corresponding to the radii of active spheres |
| std::vector<double> getActiveSphereRadii | ( | ) | const |
Get the list of active sphere radii in meters.
For more information please see setActiveSphereRadii().
| LSResult::Result setCheckboardsDetection | ( | const bool | filterState | ) |
SCENE can find checkerboard targets in the scans during processing.
| filterState |
|
| bool getCheckboardsDetection | ( | ) | const |
Get the state of checkerboard target detection.
For more information please see setCheckboardsDetection().
| LSResult::Result setPlaneDetection | ( | const bool | filterState | ) |
SCENE can find planes in the scans during processing.
| filterState |
|
| bool getPlaneDetection | ( | ) | const |
Get the state of planes detection.
For more information please see setPlaneDetection().
| LSResult::Result setMarkerDetection | ( | const bool | filterState | ) |
SCENE can find Freestyle markers in the scans during processing.
| filterState |
|
| bool getMarkerDetection | ( | ) | const |
Get the state of Freestyle marker detection.
For more information please see setMarkerDetection().
| LSResult::Result setCreatePointClouds | ( | const bool | creationState | ) |
If enabled, a scan point cloud for each scan will be created as last part of the processing.
| creationState |
|
| bool getCreatePointClouds | ( | ) | const |
Get the state of point cloud creation.
For more information please see setCreatePointClouds().
