A function that returns a ContinuousField when evaluated. More...
| Header | #include <Continuous |
| Since | Esri |
| Inherits | Esri |
| Inherited By |
Public Functions
| virtual | ~ |
| Esri | abs() const |
(since Esri Esri | acos() const |
| Esri | add( |
| Esri | add(float value) const |
(since Esri Esri | asin() const |
(since Esri Esri | aspect() const |
(since Esri Esri | atan() const |
| Esri | ceil() const |
(since Esri Esri | clamp( |
(since Esri Esri | clamp(float min, float max) const |
| Esri | clip(const Esri |
| Esri | continuous |
(since Esri Esri | cos() const |
| Esri | divide( |
| Esri | divide(float value) const |
| QFuture | evaluate |
(since Esri Esri | exp10() const |
(since Esri Esri | exp() const |
| Esri | floor() const |
| Esri | has |
| Esri | is |
| Esri | is |
| Esri | is |
| Esri | is |
| Esri | is |
| Esri | is |
| Esri | is |
| Esri | is |
(since Esri Esri | log10() const |
(since Esri Esri | log() const |
| Esri | mask( |
| Esri | multiply( |
| Esri | multiply(float value) const |
(since Esri Esri | pow( |
(since Esri Esri | pow(float power) const |
(since Esri Esri | reciprocal() const |
(since Esri Esri | remainder( |
(since Esri Esri | remainder(float divisor) const |
| Esri | replace |
| Esri | replace |
| Esri | round() const |
(since Esri Esri | sin() const |
(since Esri Esri | slope() const |
(since Esri Esri | sqrt() const |
| Esri | subtract( |
| Esri | subtract(float value) const |
(since Esri Esri | tan() 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:
- Analyze terrain suitability from slope and aspect: Analyze terrain suitability from an elevation raster by deriving slope and aspect.
- 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.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::acos() const
Returns a function that returns the arccosine of this function's field result across its extent.
The function result is the principal value, in radians, of the inverse cosine of the function's field result, so the function result will lie between 0 and pi.
The function result has no data where this function's field result is less than -1 or greater than 1.
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.
This function was introduced in Esri::ArcGISRuntime 300.1.
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.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::asin() const
Returns a function that returns the arcsine of this function's field result across its extent.
The function result is the principal value, in radians, of the inverse sine of the function's field result, so the function result will lie between -pi/2 and pi/2.
The function result has no data where this function's field result is less than -1 or greater than 1.
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.
This function was introduced in Esri::ArcGISRuntime 300.1.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::aspect() const
Returns a function that returns the aspect of this function's field result across its extent.
Aspect identifies the compass direction that the downhill slope faces at each location.
It is expressed in positive degrees from 0 up to but not including 360, measured clockwise from the positive Y axis.
Flat terrain is given an aspect of -1.
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.
This function was introduced in Esri::ArcGISRuntime 300.1.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::atan() const
Returns a function that returns the arctangent of this function's field result across its extent.
The function result is the principal value, in radians, of the inverse tangent of the function's field result, so the function result will lie between -pi/2 and pi/2.
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.
This function was introduced in Esri::ArcGISRuntime 300.1.
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.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::clamp(Esri::ArcGISRuntime::ContinuousFieldFunction *minField , Esri::ArcGISRuntime::ContinuousFieldFunction *maxField ) const
Returns a function that clamps, point-wise, this function's field result between two values drawn from two others.
- minField - The continuous field function to draw lower-bound values from.
- maxField - The continuous field function to draw upper-bound values from.
The function result is min where this function's field result is less than min. The function result is max where this function's field result is greater than max. Otherwise, this function's field result is preserved.
The function result has no data where any of the fields have no data.
The function result has no data where the max is less than the min.
The function result extent equals the intersection of this field with the intersection of the min field and max field.
The spatial reference of all fields must be equivalent.
This function was introduced in Esri::ArcGISRuntime 300.1.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::clamp(float min, float max) const
Returns a function that clamps, point-wise, this function's field result between two values.
- min - The lower-bound value to clamp to.
- max - The upper-bound value to clamp to.
The function result is min where this function's field result is less than min. The function result is max where this function's field result is greater than max. Otherwise, this function's field result is preserved.
The function result has no data where this function's field result has no data.
The function result has no data where max is less than min.
The function result extent equals that of this function's field result.
This function was introduced in Esri::ArcGISRuntime 300.1.
Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::clip(const Esri::ArcGISRuntime::Envelope &extent) const
Returns 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.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::cos() const
Returns a function that returns the cosine of this function's field result across its extent.
The function's field result is in radians.
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.
This function was introduced in Esri::ArcGISRuntime 300.1.
[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.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::exp10() const
Returns a function that returns 10 raised to 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.
This function was introduced in Esri::ArcGISRuntime 300.1.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::exp() const
Returns a function that returns Euler's number (e) raised to 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.
This function was introduced in Esri::ArcGISRuntime 300.1.
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.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::log10() const
Returns a function that returns the common logarithm (base 10) 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 has no data where this function's field result is less than or equal to 0.
The function result extent equals that of this function's field result.
This function was introduced in Esri::ArcGISRuntime 300.1.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::log() const
Returns a function that returns the natural logarithm 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 has no data where this function's field result is less than or equal to 0.
The function result extent equals that of this function's field result.
This function was introduced in Esri::ArcGISRuntime 300.1.
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.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::pow(Esri::ArcGISRuntime::ContinuousFieldFunction *otherField ) const
Returns a function that returns this function's field result raised to powers drawn from another field, point-wise, across their spatial intersection.
- otherField - The continuous field function to draw powers from.
The function result has no data where either of the fields have no data.
The function result has no data where this function's field result is less than or equal to 0.
The function result extent is the intersection of the extents of the given fields.
This function was introduced in Esri::ArcGISRuntime 300.1.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::pow(float power) const
Returns a function that returns this function's field result raised to a power across its extent.
- power - The power to raise by.
The function result has no data where this function's field result has no data.
The function result has no data where this function's field result is less than or equal to 0.
The function result extent equals that of this function's field result.
This function was introduced in Esri::ArcGISRuntime 300.1.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::reciprocal() const
Returns a function that returns the reciprocal 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.
This function was introduced in Esri::ArcGISRuntime 300.1.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::remainder(Esri::ArcGISRuntime::ContinuousFieldFunction *otherField ) const
Returns a function that applies a remainder operation, point-wise, to this function's field result using values from another field as the divisors across their spatial intersection.
- otherField - The continuous field function to draw the divisors from.
The function result has no data where either of the fields have no data.
The function result has no data where the divisor drawn from the other field is zero.
The sign of this function's field result is preserved. For example, 7 remainder 3 (or -3) will result in 1 and -7 remainder 3 (or -3) will result in -1.
The function result extent is the intersection of the extents of the given fields.
The spatial reference of both fields must be equivalent.
This function was introduced in Esri::ArcGISRuntime 300.1.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::remainder(float divisor) const
Returns a function that applies a remainder operation, point-wise, to this function's field result.
- divisor - The divisor.
The function result has no data where this function's field result has no data.
The function result has no data when the divisor is zero.
The sign of this function's field result is preserved. For example, 7 remainder 3 (or -3) will result in 1 and -7 remainder 3 (or -3) will result in -1.
The function result extent equals that of this function's field result.
This function was introduced in Esri::ArcGISRuntime 300.1.
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.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::sin() const
Returns a function that returns the sine of this function's field result across its extent.
The function's field result is in radians.
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.
This function was introduced in Esri::ArcGISRuntime 300.1.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::slope() const
Returns a function that returns the slope of this function's field result across its extent.
Slope identifies the steepness of the terrain at each location, expressed in positive degrees from 0 (flat) to 90.
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.
This function was introduced in Esri::ArcGISRuntime 300.1.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::sqrt() const
Returns a function that returns the square root 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 has no data where this function's field result is less than 0.
The function result extent equals that of this function's field result.
This function was introduced in Esri::ArcGISRuntime 300.1.
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.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::ContinuousFieldFunction *ContinuousFieldFunction::tan() const
Returns a function that returns the tangent of this function's field result across its extent.
The function's field result is in radians.
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.
This function was introduced in Esri::ArcGISRuntime 300.1.
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 converted to an 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 converted to an 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.