Workflows¶

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

Request Access

Workflows is currently in limited release. To request access please make a request through our support portal.

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 `geo.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

`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.

NumPy Functions

Workflows exposes a large chunk of the NumPy API. Either use the workflows.numpy submodule (preferred), or pass Workflows Array or MaskedArray objects into NumPy functions directly.

See NumPy Functions for a full list of available functions.

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.

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…

Parameter

parameter Create a typed parameter.

Conditionals

ifelse An if-else statement: returns true_value if condition is True, otherwise false_value.

Interactive

`map`	A single `MapApp` instance that all `visualize` calls are automatically added to.
`flows`	Browse shared `Workflow` objects (and add them to the map) with a predefined `WorkflowsBrowser` instance.
`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` or `ImageCollection`.
`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.
`PixelInspector`	Display pixel values when clicking on the map.
`WorkflowsBrowser`	Widget displaying a UI for browsing and searching `Workflow` objects, and displaying them on the map.

Widgets

`checkbox`	A checkbox widget, which acts as a `Bool` parameter.
`date`	A date-picker widget, which acts as a `Datetime` parameter.
`input`	A box to type `Str`, `Int`, or `Float` values into.
`select`	A widget (dropdown, radio buttons, etc.) to select a value from a list of options.
`slider`	A slider, which acts as an `Int` or `Float` parameter.

Execution

`Workflow`	A collection of versions of a proxy object, with associated metadata.
`VersionedGraft`	A specific version of a Workflow.
`VizOption`	Construct a VizOption instance.
`Job`	A `Job` represents the computation of a proxy object within a `GeoContext`, with values (arguments) set for any parameters it depends on.
`XYZ`	Stores proxy objects to be rendered by an XYZ tile server.
`XYZLogListener`	Calls callback functions in a background thread when XYZ log records occur.
`inspect`	Quickly compute a proxy object using a low-latency, lower-reliability backend.
`compute`	Compute a proxy object and wait for its result.
`publish`	Publish a proxy object as a `Workflow` with the given version.
`use`	Use like `import`: load the proxy object of a published `Workflow` version.
`wmts_url`	Get the WMTS endpoint which gives access to all workflows accessible to this user.

Sharing

`UserEmail`	The given string is interpreted as a user email
`Organization`	The given string is interpreted as an organization
`AllAuthenticatedUsers`

Output Formats

Workflows exposes a number of serialization formats for results. Use the format argument to compute to specify a format.

Output Formats
- Available Formats
  - PyArrow
  - GeoTIFF
  - JSON
  - MsgPack

Output Destinations

Workflows exposes a number of destinations for results. Use the destination argument to compute to specify a destination.

Output Destinations
- Available Destinations
  - Download
  - Email
  - Catalog

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.
`JobTimeoutError`	Raised when a computation took longer to complete than a specified timeout.
`JobCancelled`	Raised when a job is cancelled.
`JobSerialization`	Raised when job result serialization fails.

gRPC Client

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