A function that returns a ContinuousField when evaluated. More...
| Header | #include <Continuous |
| Since | Esri |
| Inherits | Esri |
| Inherited By |
Public Functions
| virtual | ~ |
| Esri | abs() const |
| Esri | add( |
| Esri | add(float value) const |
| Esri | ceil() const |
| Esri | clip(const Esri |
| Esri | continuous |
| Esri | divide( |
| Esri | divide(float value) const |
| QFuture | evaluate |
| Esri | floor() const |
| Esri | has |
| Esri | is |
| Esri | is |
| Esri | is |
| Esri | is |
| Esri | is |
| Esri | is |
| Esri | is |
| Esri | is |
| Esri | mask( |
| Esri | multiply( |
| Esri | multiply(float value) const |
| Esri | replace |
| Esri | replace |
| Esri | round() const |
| Esri | subtract( |
| Esri | subtract(float value) const |
| Esri | to |
Static Public Members
| Esri | create( |
Detailed Description
Use evaluateAsync to compute the result of this function.
Results are updated when changes are made to parameters of this function (or to parameters of functions from which it is composed).
Calculations that evaluate to infinity or NaN produce an indeterminate value.
Values are represented as 32-bit floating-point numbers, so arithmetic operations will wrap at the boundaries of this type.
Relevant samples:
- Apply map algebra: Apply map algebra to an elevation raster to floor, mask, and categorize the elevation values into discrete integer-based categories.
See also BooleanFieldFunction, DiscreteFieldFunction, ContinuousField, and evaluateAsync.
Member Function Documentation
[override virtual noexcept] ContinuousFieldFunction::~ContinuousFieldFunction ()
Destructor.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::abs() const
Returns a function that returns the absolute value of this function's field result across its extent.
The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::add(Esri::ArcGISRuntime::ContinuousFieldFunction *otherField ) const
Returns a function that adds, point-wise, this function's field result and another across their spatial intersection.
- otherField - Another continuous field function.
The function result has no data where either of the given fields has no data.
The function result extent is the intersection of the extents of the given fields.
The spatial reference of both fields must be equivalent.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::add(float value) const
Returns a function that adds, point-wise, a value to this function's field result across its extent.
- value - The value to add across the field.
The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::ceil() const
Returns a function that rounds this function's field result, point-wise, upwards to the nearest integer across its extent.
The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::clip(const Esri::ArcGISRuntime::Envelope &extent) const
Returns compose a function that clips this function's field result such that it does not extend beyond the provided extent.
- extent - The extent to clip the field to.
Esri::ArcGISRuntime::ContinuousFieldFunctionType ContinuousFieldFunction::continuousFieldFunctionType () const
Returns the type of the continuous field function.
[static] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::create(Esri::ArcGISRuntime::ContinuousField *result, QObject *parent = nullptr)
Returns a ContinuousFieldFunction with a predefined result.
- result - The predefined function result.
- parent - The optional parent QObject.
Enables a ContinuousField to be used in contexts that expect a ContinuousFieldFunction by setting the result of the function explicitly.
Call evaluateAsync to return the given result.
evaluateAsync returns the given result.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::divide(Esri::ArcGISRuntime::ContinuousFieldFunction *otherField ) const
Returns a function that divides, point-wise, this function's field result by another across their spatial intersection.
- otherField - Another continuous field function.
The function result has no data where either of the given fields has no data.
The function result extent is the intersection of the extents of the given fields.
The spatial reference of both fields must be equivalent.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::divide(float value) const
Returns a function that divides, point-wise, this function's field result by a value across its extent.
- value - The value to divide across the field.
The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
QFuture<Esri::ArcGISRuntime::ContinuousField *> ContinuousFieldFunction::evaluateAsync (QObject *parent = nullptr)
Evaluates the result of the function with an optional parent.
This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::floor() const
Returns a function that rounds this function's field result, point-wise, downwards to the nearest integer across its extent.
The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::BooleanFieldFunction *ContinuousFieldFunction::hasData () const
Returns a function that identifies, point-wise, where this function's field result has data across its extent.
The function result values are true where this function's field result has data and false where it has no data. All values in the result will have data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::BooleanFieldFunction *ContinuousFieldFunction::isGreaterThan (Esri::ArcGISRuntime::ContinuousFieldFunction *otherField ) const
Returns a function that indicates if, point-wise, this function's field result is greater than another.
- otherField - Another continuous field function.
The function result has no data where either of the given fields has no data.
The function result extent is the intersection of the extents of the given fields.
The spatial reference of both fields must be equivalent.
Esri::ArcGISRuntime::BooleanFieldFunction *ContinuousFieldFunction::isGreaterThan (float value) const
Returns a function that indicates if, point-wise, this function's field result is greater than a given value.
- value - The comparison value.
The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::BooleanFieldFunction *ContinuousFieldFunction::isGreaterThanOrEqualTo (Esri::ArcGISRuntime::ContinuousFieldFunction *otherField ) const
Returns a function that indicates if, point-wise, this function's field result is greater than or equal to another.
- otherField - Another continuous field function.
The function result has no data where either of the given fields has no data.
The function result extent is the intersection of the extents of the given fields.
The spatial reference of both fields must be equivalent.
Esri::ArcGISRuntime::BooleanFieldFunction *ContinuousFieldFunction::isGreaterThanOrEqualTo (float value) const
Returns a function that indicates if, point-wise, this function's field result is greater than or equal to a given value.
- value - The comparison value.
The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::BooleanFieldFunction *ContinuousFieldFunction::isLessThan (Esri::ArcGISRuntime::ContinuousFieldFunction *otherField ) const
Returns a function that indicates if, point-wise, this function's field result is less than another.
- otherField - Another continuous field function.
The function result has no data where either of the given fields has no data.
The function result extent is the intersection of the extents of the given fields.
The spatial reference of both fields must be equivalent.
Esri::ArcGISRuntime::BooleanFieldFunction *ContinuousFieldFunction::isLessThan (float value) const
Returns a function that indicates if, point-wise, this function's field result is less than a given value.
- value - The comparison value.
The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::BooleanFieldFunction *ContinuousFieldFunction::isLessThanOrEqualTo (Esri::ArcGISRuntime::ContinuousFieldFunction *otherField ) const
Returns a function that indicates if, point-wise, this function's field result is less than or equal to another.
- otherField - Another continuous field function.
The function result has no data where either of the given fields has no data.
The function result extent is the intersection of the extents of the given fields.
The spatial reference of both fields must be equivalent.
Esri::ArcGISRuntime::BooleanFieldFunction *ContinuousFieldFunction::isLessThanOrEqualTo (float value) const
Returns a function that indicates if, point-wise, this function's field result is less than or equal to a given value.
- value - The comparison value.
The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::mask(Esri::ArcGISRuntime::BooleanFieldFunction *selection) const
Returns a function that applies a mask to this function's field result.
- selection - A selection.
Where the selection is true, values from this function's field result are preserved. Where the selection is false, the field has no data. The function result has no data where this function's field result or the selection has no data.
The function result extent is the intersection of this function's field result and the selection.
The spatial reference of this function's field result and the selection must be equivalent.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::multiply(Esri::ArcGISRuntime::ContinuousFieldFunction *otherField ) const
Returns a function that multiplies, point-wise, this function's field result and another across their spatial intersection.
- otherField - Another continuous field function.
The function result has no data where either of the given fields has no data.
The function result extent is the intersection of the extents of the given fields.
The spatial reference of both fields must be equivalent.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::multiply(float value) const
Returns a function that multiplies, point-wise, this function's field result by a value across its extent.
- value - The value to multiply across the field.
The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::replaceIf (Esri::ArcGISRuntime::BooleanFieldFunction *selection, Esri::ArcGISRuntime::ContinuousFieldFunction *otherField ) const
Returns a function that preserves values from this function's field result or replaces them with values from another.
- selection - A selection.
- otherField - The continuous field function to draw values from when replacing.
Values are replaced point-wise across the spatial intersection of the selection with the union of the two function's field results. Where the selection is true, values from the other field are returned. Where the selection is false, values from this function's field result are returned. The function result has no data where the selection or the selected field has no data.
The function result extent is the intersection of the selection with the union of this function's field result and the other.
The spatial reference of this function's field result, the other, and the selection must be equivalent.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::replaceIf (Esri::ArcGISRuntime::BooleanFieldFunction *selection, float value) const
Returns a function that preserves values from this function's field result or replaces them with a constant value, point-wise across the extent of this function's field result based on a selection.
- selection - A selection.
- value - The float value to be used when replacing.
Values are determined point-wise across the extent of this function's field result based on a selection. Where the selection is true, the specified constant value is returned. Where the selection is false, values from this function's field result are returned. The function result has no data where the selection or this function's field result has no data.
The function result extent is the intersection of the selection with this function's field result.
The spatial reference of this function's field result and the selection must be equivalent.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::round() const
Returns a function that rounds this function's field result, point-wise, to the nearest integer.
Ties are rounded towards the even integer across its extent. The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::subtract(Esri::ArcGISRuntime::ContinuousFieldFunction *otherField ) const
Returns a function that subtracts, point-wise, another field from this function's field result across their spatial intersection.
- otherField - Another continuous field function.
The function result has no data where either of the given fields has no data.
The function result extent is the intersection of the extents of the given fields.
The spatial reference of both fields must be equivalent.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::subtract(float value) const
Returns a function that subtracts, point-wise, a value from this function's field result across its extent.
- value - The value to subtract across the field.
The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::DiscreteFieldFunction *ContinuousFieldFunction::toDiscreteFieldFunction () const
Returns a function that casts, point-wise, float values from this function's field result to integer values across its extent.
Values that are within the representable range of a 32-bit signed integer are rounded to the nearest integer by discarding the fractional part then cast. Values that are not within the representable range of a 32-bit signed integer are clamped to be within the representable range then rounded to the nearest integer by discarding the fractional part then cast. The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
Use floor, round, and ceil to control rounding before casting.