PointCloudReturnFilter

require(["esri/layers/pointCloudFilters/PointCloudReturnFilter"], function(PointCloudReturnFilter) { /* code goes here */ });
Class: esri/layers/pointCloudFilters/PointCloudReturnFilter
Inheritance: PointCloudReturnFilter PointCloudFilter Accessor
Since: ArcGIS API for JavaScript 4.10

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.

pcl-return-filter

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"]
 }]
});
See also:

Constructors

new PointCloudReturnFilter(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

The field used for applying the filter.

more details
more detailsPointCloudFilter
String[]

An array of return types used to filter points.

more details
more detailsPointCloudReturnFilter
String

For PointCloudReturnFilter the type is always return.

more details
more detailsPointCloudReturnFilter

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

The field used for applying the filter.

includedReturns String[]

An array of return types used to filter points. Possible values for the return types are:

  • 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
type Stringreadonly

For PointCloudReturnFilter the type is always return.

Method Overview

NameReturn TypeSummaryClass
*

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 detailsPointCloudFilter
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsPointCloudFilter

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 Object

A 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:
TypeDescription
*Returns a new instance of this class.
toJSON(){Object}inherited

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...