Workflows

The tables below list the types and functions available through the Workflows API. For information on how these objects work together, checkout out the Workflows Guide.

Request Access

Workflows is currently in limited release. To request access please contact support@descarteslabs.com.

Geospatial

Feature

Proxy GeoJSON Feature representing a Geometry and a Dict of properties.

FeatureCollection

Proxy GeoJSON FeatureCollection constructed from a sequence of Features.

GeoContext

Proxy scenes.geocontext.GeoContext containing the spatial parameters (AOI, resolution, etc.) to use when loading geospatial data.

Geometry

Proxy GeoJSON Geometry representing a geometry’s type and coordinates.

GeometryCollection

Proxy GeoJSON GeometryCollection constructed from a sequence of Geometries.

Image

Proxy Image; construct with from_id or from_scenes.

ImageCollection

Proxy object representing a stack of Images; typically construct with from_id.

ImageCollectionGroupby

Dict-like object for a grouped ImageCollection.

Kernel

A Kernel is a proxy object holding the kernel when performing a 2-dimensional convolution.

concat

ImageCollection of imgs concatenated to one another, where imgs is a variable number of Image or ImageCollection objects.

conv2d

2-D spatial convolution of an Image or ImageCollection.

load_geojson

Create a Workflows Geometry, GeometryCollection, Feature, or FeatureCollection from a GeoJSON mapping.

load_geojson_file

Create a Workflows Geometry, GeometryCollection, Feature, or FeatureCollection from a GeoJSON file.

where

Returns an Image or ImageCollection with values chosen from x or y depending on condition.

Array

For NumPy functionality that can be used with Array, see Numpy Functions.

Array

Proxy Array representing a multidimensional, homogenous array of fixed-size items.

MaskedArray

Proxy MaskedArray representing a multidimensional, homogenous array of fixed-size items that may have missing or invalid entries.

Primitives

Primitive

Proxy wrapper around a Python primitive type.

Any

Represents a proxy object of an unknown type.

NoneType

Proxy type(None).

Bool

Proxy boolean.

Number

Abstract base class for numeric Proxytypes.

Int

Proxy integer.

Float

Proxy float.

Str

Proxy string.

Containers

Dict

Dict[KeyType, ValueType]: Proxy mapping, from keys of a specific type to values of a specific type.

Tuple

Tuple[item1_type, item2_type, ...]: Proxy sequence of a fixed number of elements of specific types.

List

List[ValueType]: Proxy sequence of any number of elements, all of the same type.

Struct

Struct[{field_name: type, ...}]: Proxy container with named fields of specific types, meant as a helper base class.

zip

Returns a List of Tuple, where each tuple contains the i-th element from each of the arguments.

Datetimes

Datetime

Proxy Datetime object, similar to Python’s datetime.

Timedelta

Proxy Timedelta object, similar to Python’s timedelta.

Function

Function

Function[arg_type, ..., {kwarg: type, ...}, return_type]: Proxy function with args, kwargs, and return values of specific types.

Math

log

Element-wise natural log of an Image or ImageCollection.

log2

Element-wise base 2 log of an Image or ImageCollection.

log10

Element-wise base 10 log of an Image or ImageCollection.

log1p

Element-wise log of 1 + an Image or ImageCollection.

sqrt

Element-wise square root of an Image or ImageCollection.

exp

Element-wise exponential of an Image or ImageCollection.

square

Element-wise square of an Image or ImageCollection.

cos

Element-wise cosine of an Image or ImageCollection.

arccos

Element-wise inverse cosine of an Image or ImageCollection.

sin

Element-wise sine of an Image or ImageCollection.

arcsin

Element-wise inverse sine of an Image or ImageCollection.

tan

Element-wise tangent of an Image or ImageCollection.

arctan

Element-wise inverse tangent of an Image or ImageCollection.

arctan2

Element-wise arc tangent of y/x choosing the quadrant correctly.

Constants

e

e = 2.71828182845904523536028747135266249775724709369995…

inf

Floating point representation of positive infinity.

nan

Floating point representation of Not a Number.

pi

pi = 3.1415926535897932384626433…

Interactive

map

A single MapApp instance that all visualize calls are automatically added to.

Map

Subclass of ipyleaflet.Map with Workflows defaults and extra helper methods.

MapApp

Widget displaying a map, layers, and output logs in a nicer layout.

WorkflowsLayer

Subclass of ipyleaflet.TileLayer for displaying a Workflows Image.

LayerController

An ipyleaflet.WidgetControl for managing WorkflowsLayer.

LayerControllerList

Widget displaying a list of LayerControllerRow widgets for a Map.

ParameterSet

Parameters for a WorkflowsLayer, which updates the layer when new values are assigned.

Parameter

parameter

Create a typed parameter.

Execution

Workflow

A proxy object, and metadata about it.

Job

A Job represents the computation of a proxy object’s graft within a specific environment of parameters.

XYZ

Stores proxy objects to be rendered by an XYZ tile server.

XYZErrorListener

Calls callback functions in a background thread when XYZ errors occur.

compute

Compute a proxy object and wait for its result.

publish

Publish a proxy object as a Workflow.

use

Use like import: load the proxy object of a published Workflow.

Result Types

ImageResult

Result of calling compute on an Image.

ImageCollectionResult

Result of calling compute on an ImageCollection.

GeometryResult

Result of calling compute on a Geometry.

GeometryCollectionResult

Result of calling compute on a GeometryCollection.

FeatureResult

Result of calling compute on a Feature.

FeatureCollectionResult

Result of calling compute on a FeatureCollection.

Exceptions

ProxyTypeError

Raised when an operation is applied to an inappropriate ProxyType, similar to a Python’s TypeError.

JobComputeError

Generic error raised when a job computation fails.

JobOOM

Raised when a job computation runs out of memory.

JobAuth

Raised when a job computation fails due to invalid authentication.

JobInvalid

Raised when a job computation is invalid.

JobInvalidTyping

Raised when a job computation fails due to an operation being applied to an inappropriate type.

JobDeadlineExceeded

Raised when a job takes too long to compute (currently 30 mins).

JobTerminated

Raised when a job computation is terminated before finishing.

JobInterrupt

Raised when a job computation is interrupted before finishing.

TimeoutError

Raised when a computation took longer to complete than a specified timeout.

gRPC Client

Client

Low-level gRPC client for interacting with the Workflows backend.

Numpy Functions

add

Add arguments element-wise.

subtract

Subtract arguments, element-wise.

multiply

Multiply arguments element-wise.

divide

Returns a true division of the inputs, element-wise.

logaddexp

Logarithm of the sum of exponentiations of the inputs.

logaddexp2

Logarithm of the sum of exponentiations of the inputs in base-2.

true_divide

Returns a true division of the inputs, element-wise.

floor_divide

Return the largest integer smaller or equal to the division of the inputs.

negative

Numerical negative, element-wise.

power

First array elements raised to powers from second array, element-wise.

float_power

First array elements raised to powers from second array, element-wise.

remainder

Return element-wise remainder of division.

mod

Return element-wise remainder of division.

exp

Calculate the exponential of all elements in the input array.

exp2

Calculate 2**p for all p in the input array.

log

Natural logarithm, element-wise.

log2

Base-2 logarithm of x.

log10

Return the base 10 logarithm of the input array, element-wise.

log1p

Return the natural logarithm of one plus the input array, element-wise.

expm1

Calculate exp(x) - 1 for all elements in the array.

sqrt

Return the non-negative square-root of an array, element-wise.

square

Return the element-wise square of the input.

cbrt

Return the cube-root of an array, element-wise.

reciprocal

Return the reciprocal of the argument, element-wise.

sin

Trigonometric sine, element-wise.

cos

Cosine element-wise.

tan

Compute tangent element-wise.

arcsin

Inverse sine, element-wise.

arccos

Trigonometric inverse cosine, element-wise.

arctan

Trigonometric inverse tangent, element-wise.

arctan2

Element-wise arc tangent of x1/x2 choosing the quadrant correctly.

sinh

Hyperbolic sine, element-wise.

cosh

Hyperbolic cosine, element-wise.

tanh

Compute hyperbolic tangent element-wise.

arcsinh

Inverse hyperbolic sine element-wise.

arccosh

Inverse hyperbolic cosine, element-wise.

arctanh

Inverse hyperbolic tangent element-wise.

deg2rad

Convert angles from degrees to radians.

rad2deg

Convert angles from radians to degrees.

greater

Return the truth value of (x1 > x2) element-wise.

greater_equal

Return the truth value of (x1 >= x2) element-wise.

less

Return the truth value of (x1 < x2) element-wise.

less_equal

Return the truth value of (x1 =< x2) element-wise.

not_equal

Return (x1 != x2) element-wise.

equal

Return (x1 == x2) element-wise.

logical_and

Compute the truth value of x1 AND x2 element-wise.

logical_or

Compute the truth value of x1 OR x2 element-wise.

logical_xor

Compute the truth value of x1 XOR x2, element-wise.

logical_not

Compute the truth value of NOT x element-wise.

maximum

Element-wise maximum of array elements.

minimum

Element-wise minimum of array elements.

fmax

Element-wise maximum of array elements.

fmin

Element-wise minimum of array elements.

isfinite

Test element-wise for finiteness (not infinity or not Not a Number).

isinf

Test element-wise for positive or negative infinity.

isnan

Test element-wise for NaN and return result as a boolean array.

signbit

Returns element-wise True where signbit is set (less than zero).

copysign

Change the sign of x1 to that of x2, element-wise.

nextafter

Return the next floating-point value after x1 towards x2, element-wise.

spacing

Return the distance between x and the nearest adjacent number.

fmod

Return the element-wise remainder of division.

floor

Return the floor of the input, element-wise.

ceil

Return the ceiling of the input, element-wise.

trunc

Return the truncated value of the input, element-wise.

degrees

Convert angles from radians to degrees.

radians

Convert angles from degrees to radians.

rint

Round elements of the array to the nearest integer.

fabs

Compute the absolute values element-wise.

sign

Returns an element-wise indication of the sign of a number.

absolute

Calculate the absolute value element-wise.

concatenate

Join a sequence of arrays along an existing axis.

transpose

Permute the dimensions of an array.

histogram

Compute the histogram of a set of data.

reshape

Gives a new shape to an array without changing its data.

stack

Join a sequence of arrays along a new axis.