require(["esri/layers/pointCloudFilters/PointCloudReturnFilter"], (PointCloudReturnFilter) => { /* code goes here */ });
import PointCloudReturnFilter from "@arcgis/core/layers/pointCloudFilters/PointCloudReturnFilter.js";
esri/layers/pointCloudFilters/PointCloudReturnFilter
Laser pulses emitted from a lidar system can have several returns depending on the surfaces that they encounter.
The return number is stored within each point in the RETURNS
field. For example, the first return is associated with the highest point
in the landscape. In some cases the laser pulse returns only one point representing the ground.
A PointCloudLayer can be filtered using a PointCloudReturnFilter based on the information
in the RETURNS
field. Points can be filtered using the values in the includedReturns.
For example, to filter points representing the highest features in the landscape, the following filter can be set:
const pointCloudLayer = new PointCloudLayer({
...,
filters: [{
type: "return",
field: "RETURNS",
values: ["firstOfMany", "single"]
}]
});
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
The field used for applying the filter. | PointCloudFilter | ||
An array of return types used to filter points. | PointCloudReturnFilter | ||
For PointCloudReturnFilter the type is always "return". | PointCloudReturnFilter |
Property Details
-
field
InheritedPropertyfield String
Inherited from PointCloudFilter -
The field used for applying the filter.
-
An array of return types used to filter points. Possible values for the return types are:
Value Description firstOfMany
The point was the first to be collected in a series of many returns. last
The last point in a series of many returns or a single point. lastOfMany
The last point in a series of many returns. single
All the points that were collected from laser pulses with a single return. Possible Values:"firstOfMany" |"last" |"lastOfMany" |"single"
-
type
type Stringreadonly
-
For PointCloudReturnFilter the type is always "return".
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | PointCloudFilter | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | PointCloudFilter |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. 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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
InheritedMethodtoJSON(){Object}
Inherited from PointCloudFilter -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.