require(["esri/layers/pointCloudFilters/PointCloudBitfieldFilter"], (PointCloudBitfieldFilter) => { /* code goes here */ });
import PointCloudBitfieldFilter from "@arcgis/core/layers/pointCloudFilters/PointCloudBitfieldFilter.js";
esri/layers/pointCloudFilters/PointCloudBitfieldFilter
Points can be classified using flags that indicate special characteristics associated with the point like
the direction of the flight or the method used to create the point. The flags are stored as a bit encoded field
and the PointCloudBitfieldFilter can be used to filter points that have certain flags set. Each flag is defined
by its bit position and value. If the flag is set its value is 1, otherwise its value is 0.
The data format of the points determines the bit position of each flag. You can read more about this in the LAS specification v1.4.
For example for the PointCloudLayer used in the
Filter points in a PointCloudLayer the only available flag
is the Scan direction, which is stored on bit position 6. The Scan direction flag has the value 1 only when the point was collected when the direction of the scan
was positive (which means from the left to the right side of the in-track direction). To only show points with
a positive scan direction we can set the requiredSetBit to [6] in the PointCloudBitfieldFilter:
const pointCloudLayer = new PointCloudLayer({
url: "https://tiles.arcgis.com/tiles/Imiq6naek6ZWdour/arcgis/rest/services/PointCloud_urban/SceneServer/",
filters: [{
type: "bitfield",
field: "FLAGS",
requiredSetBits: [6]
}]
});
The field for the PointCloudBitfieldFilter should be set to the field where the flags are stored. For most
datasets this is the FLAGS field.
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 bit positions where the bit value must be | PointCloudBitfieldFilter | ||
An array of bit positions where the bit value must be | PointCloudBitfieldFilter | ||
For PointCloudBitfieldFilter the type is always | PointCloudBitfieldFilter |
Property Details
-
field
InheritedPropertyfield StringInherited from PointCloudFilter -
The field used for applying the filter.
-
An array of bit positions where the bit value must be
0, otherwise the point will not be displayed. Use this property to filter points based on the classification flag stored at that bit position.
-
An array of bit positions where the bit value must be
1, otherwise the point will not be displayed. Use this property to filter points based on the classification flag stored at that bit position.
-
type
Propertytype Stringreadonly -
For PointCloudBitfieldFilter the type is always
bitfield.For PointCloudBitfieldFilter the type is always "bitfield".
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
jsonparameter 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 trueif 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.