sample_property

Returns the value of a property at locations on a geometry. Values can be interpolated from the closest geometric components.

Inputs

geometry

The geometry on which to sample.

locations

An array containing the locations on the geometry, for example, the output from get_closest_locations. For 2D arrays of locations, use sample_property_2D.

default

Connect a value node of the same type as the property. This value is returned by default if unsuccessful, for example, if the property does not exist or a location is not valid.

property

The name of the property.

method

How to return values between components:

• interpolated returns the average value of the property at the nearest components, weighted by distance.
• from_closest returns the value of the property at the nearest component.

Outputs

sampled_data

An array containing the values of the property at the locations.

success

A matching array of Booleans. If an element is false, then either the property does not exist or the corresponding location is not valid. In such cases, the corresponding element of the sampled_data array is the default value.