PointCloudValueFilter
require(["esri/layers/pointCloudFilters/PointCloudValueFilter"], function(PointCloudValueFilter) { /* code goes here */ });
esri/layers/pointCloudFilters/PointCloudValueFilter
Every lidar point can have a classification that defines the type of surface that reflected the laser pulse. The different categories (for example building, high vegetation, ground) are defined using numeric integer codes in the LAS files. The full list of categories including the corresponding codes can be found in the LAS specification.
PointCloudValueFilter is used to filter points based on the category that they belong to. For example, to display only points that belong to vegetation, the following filter can be set on the layer:
const pcLayer = new PointCloudLayer({
url: "https://tiles.arcgis.com/tiles/Imiq6naek6ZWdour/arcgis/rest/services/PointCloud_urban/SceneServer",
filters: [{
type: "value",
field: "CLASS_CODE",
mode: "include",
// values include low, medium and high vegetation
values: [3, 4, 5]
}]
});
Constructors
- new PointCloudValueFilter(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | The name of the class. more details | more details | Accessor | |
String | The field used for applying the filter. more details | more details | PointCloudFilter | |
String | Whether points should be included or excluded from the filter. more details | more details | PointCloudValueFilter | |
String | For PointCloudValueFilter the type is always | more details | PointCloudValueFilter | |
Number[] | An array of numeric values representing the classification codes that the filter should apply. more details | more details | PointCloudValueFilter |
Property Details
The name of the class. The declared class name is formatted as
esri.folder.className
.
The field used for applying the filter.
- modeString
Whether points should be included or excluded from the filter.
Possible values: include | exclude
- Default Value:"exclude"
- typeStringreadonly
For PointCloudValueFilter the type is always
value
.
- valuesNumber[]
An array of numeric values representing the classification codes that the filter should apply.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
* | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | PointCloudFilter | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | PointCloudFilter |
Method Details
- fromJSON(json){*}static
Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input
json
parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameter:json ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
Returns:Type Description * Returns a new instance of this class.
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.