ViewshedFunction class final
Evaluates an elevation surface to produce a viewshed, determining which areas are visible and which are not visible to an observer.
Use ContinuousFieldFunction.evaluate to compute the result of this function.
In the resulting viewshed, visible areas have a value of 1, while areas that are not visible have a value of 0.
Results are updated when changes are made to parameters of this function (or to parameters of functions from which it is composed).
The function performs analysis at the full resolution of the data. To perform analysis at the current rendered resolution of scene layers or 3D graphics, use the ExploratoryViewshed tool.
- Inheritance
-
- Object
- ContinuousFieldFunction
- ViewshedFunction
- Available extensions
Constructors
- ViewshedFunction.withContinuousField({required ContinuousField elevation, required ViewshedParameters parameters})
-
Creates a ViewshedFunction.
factory
- ViewshedFunction.withContinuousFieldFunction({required ContinuousFieldFunction elevation, required ViewshedParameters parameters})
-
Creates a ViewshedFunction.
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- parameters ↔ ViewshedParameters
-
Parameters that define properties like observer position and elevation
sampling interval for the ViewshedFunction.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
abs(
) → ContinuousFieldFunction -
Composes a function that returns the absolute value of this function's
field result across its extent.
inherited
-
acos(
) → ContinuousFieldFunction -
Composes a function that returns the arccosine of this function's field
result across its extent.
inherited
-
addOtherField(
ContinuousFieldFunction otherField) → ContinuousFieldFunction -
Composes a function that adds, point-wise, this function's field result
and another across their spatial intersection.
inherited
-
addValue(
double value) → ContinuousFieldFunction -
Composes a function that adds, point-wise, a value to this function's
field result across its extent.
inherited
-
asin(
) → ContinuousFieldFunction -
Composes a function that returns the arcsine of this function's field
result across its extent.
inherited
-
aspect(
) → ContinuousFieldFunction -
Composes a function that returns the aspect of this function's field
result across its extent.
inherited
-
atan(
) → ContinuousFieldFunction -
Composes a function that returns the arctangent of this function's field
result across its extent.
inherited
-
ceil(
) → ContinuousFieldFunction -
Composes a function that rounds this function's field result, point-wise,
upwards to the nearest integer across its extent.
inherited
-
clampOtherFields(
{required ContinuousFieldFunction minField, required ContinuousFieldFunction maxField}) → ContinuousFieldFunction -
Composes a function that clamps, point-wise, this function's field result
between two values drawn from two others.
inherited
-
clampValues(
{required double min, required double max}) → ContinuousFieldFunction -
Composes a function that clamps, point-wise, this function's field result
between two values.
inherited
-
clip(
Envelope extent) → ContinuousFieldFunction -
Composes a function that clips this function's field result such that it
does not extend beyond the provided extent.
inherited
-
cos(
) → ContinuousFieldFunction -
Composes a function that returns the cosine of this function's field
result across its extent.
inherited
-
divideByOtherField(
ContinuousFieldFunction otherField) → ContinuousFieldFunction -
Composes a function that divides, point-wise, this function's field result
by another across their spatial intersection.
inherited
-
divideByValue(
double value) → ContinuousFieldFunction -
Composes a function that divides, point-wise, this function's field result
by a value across its extent.
inherited
-
evaluate(
) → Future< ContinuousField> -
Evaluates the result of the function.
inherited
-
exp(
) → ContinuousFieldFunction -
Composes a function that returns Euler's number (e) raised to this
function's field result across its extent.
inherited
-
exp10(
) → ContinuousFieldFunction -
Composes a function that returns 10 raised to this function's field result
across its extent.
inherited
-
floor(
) → ContinuousFieldFunction -
Composes a function that rounds this function's field result, point-wise,
downwards to the nearest integer across its extent.
inherited
-
hasData(
) → BooleanFieldFunction -
Composes a function that identifies, point-wise, where this function's
field result has data across its extent.
inherited
-
isGreaterThanOrEqualToOtherField(
ContinuousFieldFunction otherField) → BooleanFieldFunction -
Composes a function that indicates if, point-wise, this function's field
result is greater than or equal to another.
inherited
-
isGreaterThanOrEqualToValue(
double value) → BooleanFieldFunction -
Composes a function that indicates if, point-wise, this function's field
result is greater than or equal to a given value.
inherited
-
isGreaterThanOtherField(
ContinuousFieldFunction otherField) → BooleanFieldFunction -
Composes a function that indicates if, point-wise, this function's field
result is greater than another.
inherited
-
isGreaterThanValue(
double value) → BooleanFieldFunction -
Composes a function that indicates if, point-wise, this function's field
result is greater than a given value.
inherited
-
isLessThanOrEqualToOtherField(
ContinuousFieldFunction otherField) → BooleanFieldFunction -
Composes a function that indicates if, point-wise, this function's field
result is less than or equal to another.
inherited
-
isLessThanOrEqualToValue(
double value) → BooleanFieldFunction -
Composes a function that indicates if, point-wise, this function's field
result is less than or equal to a given value.
inherited
-
isLessThanOtherField(
ContinuousFieldFunction otherField) → BooleanFieldFunction -
Composes a function that indicates if, point-wise, this function's field
result is less than another.
inherited
-
isLessThanValue(
double value) → BooleanFieldFunction -
Composes a function that indicates if, point-wise, this function's field
result is less than a given value.
inherited
-
log(
) → ContinuousFieldFunction -
Composes a function that returns the natural logarithm of this function's
field result across its extent.
inherited
-
log10(
) → ContinuousFieldFunction -
Composes a function that returns the common logarithm (base 10) of this
function's field result across its extent.
inherited
-
mask(
BooleanFieldFunction selection) → ContinuousFieldFunction -
Composes a function that applies a mask to this function's field result.
inherited
-
multiplyByOtherField(
ContinuousFieldFunction otherField) → ContinuousFieldFunction -
Composes a function that multiplies, point-wise, this function's field
result and another across their spatial intersection.
inherited
-
multiplyByValue(
double value) → ContinuousFieldFunction -
Composes a function that multiplies, point-wise, this function's field
result by a value across its extent.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
powOtherField(
ContinuousFieldFunction otherField) → ContinuousFieldFunction -
Composes a function that returns this function's field result raised to
powers drawn from another field, point-wise, across their spatial
intersection.
inherited
-
powValue(
double power) → ContinuousFieldFunction -
Composes a function that returns this function's field result raised to a
power across its extent.
inherited
-
reciprocal(
) → ContinuousFieldFunction -
Composes a function that returns the reciprocal of this function's field
result across its extent.
inherited
-
remainderOtherField(
ContinuousFieldFunction otherField) → ContinuousFieldFunction -
Composes 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.
inherited
-
remainderValue(
double divisor) → ContinuousFieldFunction -
Composes a function that applies a remainder operation, point-wise, to
this function's field result.
inherited
-
replaceWithOtherFieldIf(
{required BooleanFieldFunction selection, required ContinuousFieldFunction otherField}) → ContinuousFieldFunction -
Composes a function that preserves values from this function's field
result or replaces them with values from another.
inherited
-
replaceWithValueIf(
{required BooleanFieldFunction selection, required double value}) → ContinuousFieldFunction -
Composes a function that preserves values from this function's field
result or replaces them with a constant value.
inherited
-
round(
) → ContinuousFieldFunction -
Composes a function that rounds this function's field result, point-wise,
to the nearest integer.
inherited
-
sin(
) → ContinuousFieldFunction -
Composes a function that returns the sine of this function's field result
across its extent.
inherited
-
slope(
) → ContinuousFieldFunction -
Composes a function that returns the slope of this function's field result
across its extent.
inherited
-
sqrt(
) → ContinuousFieldFunction -
Composes a function that returns the square root of this function's field
result across its extent.
inherited
-
subtractOtherField(
ContinuousFieldFunction otherField) → ContinuousFieldFunction -
Composes a function that subtracts, point-wise, another field from this
function's field result across their spatial intersection.
inherited
-
subtractValue(
double value) → ContinuousFieldFunction -
Composes a function that subtracts, point-wise, a value from this
function's field result across its extent.
inherited
-
tan(
) → ContinuousFieldFunction -
Composes a function that returns the tangent of this function's field
result across its extent.
inherited
-
toDiscreteFieldFunction(
) → DiscreteFieldFunction -
Composes a function that casts, point-wise, float values from this
function's field result to integer values across its extent.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator *(
Object other) → ContinuousFieldFunction -
Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension
Composes a function that multiplies, point-wise, this function's result byother, using ContinuousFieldFunction.multiplyByValue or ContinuousFieldFunction.multiplyByOtherField. -
operator +(
Object other) → ContinuousFieldFunction -
Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension
Composes a function that adds, point-wise,otherto this function's result, using ContinuousFieldFunction.addValue or ContinuousFieldFunction.addOtherField. -
operator -(
Object other) → ContinuousFieldFunction -
Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension
Composes a function that subtracts, point-wise,otherfrom this function's result, using ContinuousFieldFunction.subtractValue or ContinuousFieldFunction.subtractOtherField. -
operator /(
Object other) → ContinuousFieldFunction -
Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension
Composes a function that divides, point-wise, this function's result byother, using ContinuousFieldFunction.divideByValue or ContinuousFieldFunction.divideByOtherField. -
operator <(
Object other) → BooleanFieldFunction -
Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension
Composes a function that compares, point-wise, this function's result toother, using ContinuousFieldFunction.isLessThanValue or ContinuousFieldFunction.isLessThanOtherField. -
operator <=(
Object other) → BooleanFieldFunction -
Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension
Composes a function that compares, point-wise, this function's result toother, using ContinuousFieldFunction.isLessThanOrEqualToValue or ContinuousFieldFunction.isLessThanOrEqualToOtherField. -
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator >(
Object other) → BooleanFieldFunction -
Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension
Composes a function that compares, point-wise, this function's result toother, using ContinuousFieldFunction.isGreaterThanValue or ContinuousFieldFunction.isGreaterThanOtherField. -
operator >=(
Object other) → BooleanFieldFunction -
Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension
Composes a function that compares, point-wise, this function's result toother, using ContinuousFieldFunction.isGreaterThanOrEqualToValue or ContinuousFieldFunction.isGreaterThanOrEqualToOtherField. -
operator unary-(
) → ContinuousFieldFunction -
Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension
Composes a function that multiplies, point-wise, this function's result by -1.