API docs by Redocly

SlideRule OpenAPI Specification (v5.4.2)

Download OpenAPI specification:

License: BSD 3-Clause

APIs to process Earth science datasets in the cloud. Most endpoints are public though some require authorization and payload signing. Endpoints are grouped by series, which indentifies the endpoint's underlying implementation.

a-series

immediate ASCII text response typically formatted as json

Arbitrary Code Execution

Execute user supplied lua code

Authorizations:
(OAuth2SignatureAuth)
Request Body schema: text/plain
string

Lua code to execute on the server

Responses

Asset Metadata Service

Pass-through to Asset Metadata Service API

Request Body schema: application/json
object

See AMS specification for details

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Assets

Lists available assets, drivers, and rasters

Responses

Response samples

Content type
application/json
{
  • "directory": {
    },
  • "drivers": [
    ],
  • "rasters": [
    ]
}

Datetime Conversion

Returns current and converted times in different formats support and used by SlideRule; NOW: if supplied for either input or time then grab the current time CDS: CCSDS 6-byte packet timestamp represented as [, ] days = 2 bytes of days since GPS epoch ms = 4 bytes of milliseconds in the current day GMT: UTC time represented as :::: GPS: milliseconds since GPS epoch January 6, 1980 DATE: UTC time represented as --T::Z

Request Body schema: application/json
number or string or Array of integers

Time value to convert; format depends on 'input' field. For CDS, provide as [day, ms] array.

input
string
Enum: "NOW" "CDS" "GMT" "GPS" "DATE"

Format of the input time value

output
string
Enum: "GPS" "GMT" "DATE"

Desired format of the output time value

Responses

Request samples

Content type
application/json
{
  • "time": 0,
  • "input": "NOW",
  • "output": "GPS"
}

Response samples

Content type
application/json
{
  • "time": 0,
  • "format": "GPS"
}

Defaults

Dump of all system request parameters and their default values

Responses

Response samples

Content type
application/json
{
  • "core": {
    },
  • "cre": {
    },
  • "icesat2": {
    },
  • "gedi": {
    },
  • "swot": {
    },
  • "bathy": {
    }
}

Record Definition

Defines the on-the-wire format and structure for a given record type

Request Body schema: application/json
rectype
string

Responses

Request samples

Content type
application/json
{
  • "rectype": "string"
}

Response samples

Content type
application/json
{
  • "__datasize": 0,
  • "offset": 0,
  • "flags": "LE",
  • "elements": 0,
  • "type": "INT8"
}

Earthdata

Query earth data assets for resources to process

Request Body schema: application/json
object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

short_name
string

CMR short name of the dataset

version
string

Version of the dataset

collection
string

Collection name of the dataset

name_filter
string

Regular expression to match granule name

rgt
integer

Reference ground track

cycle
integer

Orbit cycle number

region
integer

Global region

Responses

Request samples

Content type
application/json
{
  • "samples": {
    },
  • "max_resources": 300,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "short_name": "string",
  • "version": "string",
  • "collection": "string",
  • "name_filter": "string",
  • "rgt": 0,
  • "cycle": 0,
  • "region": 0
}

Response samples

Content type
application/json
[
  • "string"
]

Execute Container Runtime Environment

Execute a user specified docker image

Authorizations:
(OAuth2SignatureAuth)
Request Body schema: application/json
parms
string

Parmeters to pass to the container once it is already running

image
string

Name of the docker image to run

command
string

Command to execute when starting container

Responses

Request samples

Content type
application/json
{
  • "parms": "string",
  • "image": "string",
  • "command": "string"
}

Response samples

Content type
application/json
{ }

GeoSpatial Index Operation

Perform intersection, combination, and split operations on geospatial indexes

Request Body schema: application/json
asset
string

Name of the asset

pole
string
Enum: "north" "south"

Polar projection to use

lat
number

Latitude, -90 to 90

lon
number

Longitude, -180 to 180

x
number

X coordinate in projected space

y
number

Y coordinate in projected space

object

Bounding box for split operation

object

First bounding box for intersect/combine operations

object

Second bounding box for intersect/combine operations

Responses

Request samples

Content type
application/json
{
  • "asset": "string",
  • "pole": "north",
  • "lat": 0,
  • "lon": 0,
  • "x": 0,
  • "y": 0,
  • "span": {
    },
  • "span1": {
    },
  • "span2": {
    }
}

Response samples

Content type
application/json
{
  • "intersect": true,
  • "combine": {
    },
  • "split": {
    },
  • "lat": 0,
  • "lon": 0,
  • "x": 0,
  • "y": 0
}

Health

Application health

Responses

Response samples

Content type
application/json
{
  • "health": true
}

List Containers

List available docker images that can be executed by a user

Authorizations:
(OAuth2SignatureAuth)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Prometheus

Provides application metrics in OpenMetrics Text Format used by Prometheus

Responses

Raster Sampler

Return samples from a raster dataset given a (set of) latitude(s) and longitude(s)

Request Body schema: application/json
coordinates
required
Array of numbers[ items [ 2 .. 3 ] items ]

Array of [longitude, latitude] or [longitude, latitude, height] coordinate pairs to sample

required
object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: -1

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 0

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

read_timeout
integer <int32>
Default: -1

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: -1

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: -1

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

Responses

Request samples

Content type
application/json
{
  • "coordinates": [
    ],
  • "samples": {
    },
  • "max_resources": 300,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": -1,
  • "key_space": 0,
  • "read_timeout": -1,
  • "timeout": -1,
  • "rqst_timeout": -1,
  • "output": {
    },
  • "asset": "string",
  • "datum": "unspecified"
}

Response samples

Content type
application/json
{
  • "samples": [
    ],
  • "errors": [
    ]
}

Raster Subsetter

Return a subset from a raster dataset given an extent

Request Body schema: application/json
extents
required
Array of numbers[ items = 4 items ]

Array of [, , , ] extents to subset

required
object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: -1

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 0

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

read_timeout
integer <int32>
Default: -1

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: -1

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: -1

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

Responses

Request samples

Content type
application/json
{
  • "extents": [
    ],
  • "samples": {
    },
  • "max_resources": 300,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": -1,
  • "key_space": 0,
  • "read_timeout": -1,
  • "timeout": -1,
  • "rqst_timeout": -1,
  • "output": {
    },
  • "asset": "string",
  • "datum": "unspecified"
}

Response samples

Content type
application/json
{
  • "subsets": [
    ],
  • "errors": [
    ]
}

Version

Returns current version and configuration of server

Responses

Response samples

Content type
application/json
{
  • "server": {
    },
  • "property1": {
    },
  • "property2": {
    }
}

x-series

dataframe construction and manipulation

ATL03 Dataframe

Spatially and temporally subsets ATL03 photon cloud with additional filters and ancillary fields (x-series)

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

object

Configuration structure for the 'Surface Fitting' algorithm; when provided the servers will fit a surface to the source photon cloud and return an elevation dataset similar to ATL06

atl03_bckgrd_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'bckgrd_atlas' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

atl03_corr_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geophys_corr' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

object

Configuration structure for the 'Yet Another Photon Classifier' algorithm; when provided the servers will calculate a density score for each photon and include that score in the response data

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

atl03_ph_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'heights' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

object

Configuration for classifying bathymetry photons

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

object

Configuration structure for the 'PhoREAL' algorithm; when provided the servers will calculate canopy metrics on the source photon cloud and return those metrics as a dataset similar to ATL08

pass_invalid
boolean <bool>
Default: false

Boolean flag indicating whether or not extents that fail validation checks are still used and returned in the results

res
number <double>
Default: 20

Step (in meters) of the variable length segments; could also be thought of as the spacing of the segments or the resolution of the segments

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

cnt
integer <int32>
Default: 10

Minimum photon count in the variable length segment for the segment to be processed

ats
number <double>
Default: 20

Minimum along track spread of the photons (in meters) in the variable length segment for the segment to be processed

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

atl03_geo_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geolocation' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

cnf
Array of integers <int32> = 7 items [ items <int32 > ]
Default: ["atl03_low","atl03_medium","atl03_high"]

Confidence level for photon selection, can be supplied as a single value (which means the confidence must be at least that), or a list (which means the confidence must be in the list); note - the confidence can be supplied as strings or as numbers {-2, -1, 0, 1, 2, 3, 4}; [atl03_tep,atl03_not_considered,atl03_background,atl03_within_10m,atl03_low,atl03_medium,atl03_high]

srt
integer <int32>
Default: "dynamic"

Surface reference type: 0-land, 1-ocean, 2-sea ice, 3-land ice, 4-inland water

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

atl08_class
Array of integers <int32> = 5 items [ items <int32 > ]
Default: []

List of ATL08 classifications used to select which photons are used in the processing; [atl08_noise,atl08_ground,atl08_canopy,atl08_top_of_canopy,atl08_unclassified]

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

atl08_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_segments' group of the ATL08 granule to include in the response; supported by atl03x, and phoreal

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

dist_in_seg
boolean <bool>
Default: false

Boolean flag indicating that the units of the len and res are in ATL03 segments (e.g. if true then len=2 is exactly two ATL03 segments which is approximately 40 meters)

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

podppd
integer <uint8>
Default: 1

Pointing/geolocation degradation mask; each bit in the mask represents a pointing/geolocation solution quality assessment to be included; the bits are 0: nominal, 1: pod_degrade, 2: ppd_degrade, 3: podppd_degrade, 4: cal_nominal, 5: cal_pod_degrade, 6: cal_ppd_degrade, 7: cal_podppd_degrade

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

object

Configuration structure for the 'Surface Blanket' algorithm; when provided the servers will calculate a canopy top and ground using the source photon cloud and return those values in the response

len
number <double>
Default: 40

Size (in meters) of the variable length segment

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

quality_ph
Array of integers <int32> = 26 items [ items <int32 > ]
Default: ["atl03_quality_nominal"]

Quality classification based on an ATL03 algorithms that attempt to identify instrumental artifacts, can be supplied as a single value (which means the classification must be exactly that), or a list (which means the classification must be in the list); [atl03_quality_nominal,atl03_quality_afterpulse,atl03_quality_impulse_response,atl03_quality_tep,atl03_quality_noise_burst,atl03_quality_noise_streak,atl03_quality_tx_part_sat,atl03_quality_tx_part_sat_afterpulse,atl03_quality_tx_part_sat_ir_effect,atl03_quality_tx_part_sat_burst,atl03_quality_tx_part_sat_streak,atl03_quality_tx_full_sat,atl03_quality_tx_full_sat_afterpulse,atl03_quality_tx_full_sat_ir_effect,atl03_quality_tx_full_sat_burst,atl03_quality_tx_full_sat_streak]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "fit": {
    },
  • "atl03_bckgrd_fields": [
    ],
  • "atl03_corr_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "yapc": {
    },
  • "resource": "string",
  • "atl03_ph_fields": [
    ],
  • "atl24": {
    },
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "phoreal": {
    },
  • "pass_invalid": false,
  • "res": 20,
  • "proj": "auto",
  • "cnt": 10,
  • "ats": 20,
  • "region_mask": {
    },
  • "atl03_geo_fields": [
    ],
  • "poly": [
    ],
  • "node_timeout": 600,
  • "cnf": [
    ],
  • "srt": "dynamic",
  • "key_space": 18446744073709552000,
  • "atl08_class": [ ],
  • "read_timeout": 600,
  • "atl08_fields": [
    ],
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "dist_in_seg": false,
  • "asset": "string",
  • "podppd": 1,
  • "datum": "unspecified",
  • "als": {
    },
  • "len": 40,
  • "spots": [
    ],
  • "quality_ph": [
    ]
}

ATL06 Dataframe

Spatially and temporally subsets ATL06 granules elevations with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

atl06_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_ice_segments' group of the ATL06 granule to include in the response; supported by atl06x

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "atl06_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "spots": [
    ]
}

ATL08 Dataframe

Spatially and temporally subsets ATL08 granules vegetation metrics with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

use_abs_h
boolean <bool>
Default: false

Read absolute (instead of relative) height metrics; i.e. return ellipsoidal elevations instead of relief measurements

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

te_quality_filter
integer <int8>
Default: 0

Filter out low quality terrain photons when calculating metrics

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

atl08_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_segments' group of the ATL08 granule to include in the response

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

can_quality_filter
integer <int8>
Default: 0

Filter out low quality canopy photons when calculating metrics

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "resource": "string",
  • "resources": [
    ],
  • "use_abs_h": false,
  • "cluster_size_hint": 0,
  • "te_quality_filter": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "read_timeout": 600,
  • "atl08_fields": [
    ],
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "spots": [
    ],
  • "can_quality_filter": 0
}

ATL13 Dataframe

Spatially and temporally subsets ATL13 granule lake metrics with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

object

Configuration structure for the 'atl13x' dataset construction

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "atl13": {
    },
  • "spots": [
    ]
}

ATL24 Dataframe

Spatially and temporally subsets ATL24 granule bathemtry data with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

object

Configuration structure for the 'atl24x' dataset construction

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "resource": "string",
  • "atl24": {
    },
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "spots": [
    ]
}

Bathymetry Dataframe

Generate custom bathymetry data using parameters supplied in the request (x-series)

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

min_dem_delta
number <double>
Default: -100

Maximum negative vertical distance of photon from ATL03 DEM to include in bathymetry processing

max_dem_delta
number <double>
Default: 50

Maximum positive vertical distance of photon from ATL03 DEM to include in bathymetry processing

object

Configuration structure for the 'Surface Fitting' algorithm; when provided the servers will fit a surface to the source photon cloud and return an elevation dataset similar to ATL06

atl03_bckgrd_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'bckgrd_atlas' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

atl03_corr_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geophys_corr' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

asset09
string <binary>
Default: "icesat2"

Asset identifier to use when reading wind speed from ATL09; when left blank the server will do the right thing

object

Configuration structure that controls performing and including an uncertainty calculation for each bathymetry photon

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

object

Configuration structure for the 'Yet Another Photon Classifier' algorithm; when provided the servers will calculate a density score for each photon and include that score in the response data

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

atl03_ph_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'heights' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

object

Configuration for classifying bathymetry photons

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

object

Configuration structure for the 'PhoREAL' algorithm; when provided the servers will calculate canopy metrics on the source photon cloud and return those metrics as a dataset similar to ATL08

pass_invalid
boolean <bool>
Default: false

Boolean flag indicating whether or not extents that fail validation checks are still used and returned in the results

res
number <double>
Default: 20

Step (in meters) of the variable length segments; could also be thought of as the spacing of the segments or the resolution of the segments

min_geoid_delta
number <double>
Default: -100

Maximum negative vertical distance of photon from ATL03 geoid (sea level) to include in bathymetry processing

max_geoid_delta
number <double>
Default: 50

Maximum positive vertical distance of photon from ATL03 geoid (sea level) to include in bathymetry processing

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

cnt
integer <int32>
Default: 10

Minimum photon count in the variable length segment for the segment to be processed

ats
number <double>
Default: 20

Minimum along track spread of the photons (in meters) in the variable length segment for the segment to be processed

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

object

Configuration structure that controls the calculation and inclusion of the sea surface height at each photon

atl03_geo_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geolocation' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

cnf
Array of integers <int32> = 7 items [ items <int32 > ]
Default: ["atl03_low","atl03_medium","atl03_high"]

Confidence level for photon selection, can be supplied as a single value (which means the confidence must be at least that), or a list (which means the confidence must be in the list); note - the confidence can be supplied as strings or as numbers {-2, -1, 0, 1, 2, 3, 4}; [atl03_tep,atl03_not_considered,atl03_background,atl03_within_10m,atl03_low,atl03_medium,atl03_high]

srt
integer <int32>
Default: "dynamic"

Surface reference type: 0-land, 1-ocean, 2-sea ice, 3-land ice, 4-inland water

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

generate_ndwi
boolean <bool>
Default: false

Boolean indicating that the server should calculate and include an NDWI value for each photon

atl08_class
Array of integers <int32> = 5 items [ items <int32 > ]
Default: []

List of ATL08 classifications used to select which photons are used in the processing; [atl08_noise,atl08_ground,atl08_canopy,atl08_top_of_canopy,atl08_unclassified]

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

atl08_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_segments' group of the ATL08 granule to include in the response; supported by atl03x, and phoreal

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Configuration structure that controls performing refraction correction on the subaqueous bathymetry photons

use_bathy_mask
boolean <bool>
Default: true

Boolean controlling the use of the global bathymetry mask; if enabled all input granules will be subsetted to the bathymetry mask prior to any other subsetting

object

Versioning, ground track, and date information pulled from the granule processed; output only

dist_in_seg
boolean <bool>
Default: false

Boolean flag indicating that the units of the len and res are in ATL03 segments (e.g. if true then len=2 is exactly two ATL03 segments which is approximately 40 meters)

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

podppd
integer <uint8>
Default: 1

Pointing/geolocation degradation mask; each bit in the mask represents a pointing/geolocation solution quality assessment to be included; the bits are 0: nominal, 1: pod_degrade, 2: ppd_degrade, 3: podppd_degrade, 4: cal_nominal, 5: cal_pod_degrade, 6: cal_ppd_degrade, 7: cal_podppd_degrade

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

object

Configuration structure for the 'Surface Blanket' algorithm; when provided the servers will calculate a canopy top and ground using the source photon cloud and return those values in the response

len
number <double>
Default: 40

Size (in meters) of the variable length segment

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

ph_in_extent
integer <int32>
Default: 8192

Hard coded number of photons to include in the variable length segment; overrides 'len' and 'res' parameters

quality_ph
Array of integers <int32> = 26 items [ items <int32 > ]
Default: ["atl03_quality_nominal"]

Quality classification based on an ATL03 algorithms that attempt to identify instrumental artifacts, can be supplied as a single value (which means the classification must be exactly that), or a list (which means the classification must be in the list); [atl03_quality_nominal,atl03_quality_afterpulse,atl03_quality_impulse_response,atl03_quality_tep,atl03_quality_noise_burst,atl03_quality_noise_streak,atl03_quality_tx_part_sat,atl03_quality_tx_part_sat_afterpulse,atl03_quality_tx_part_sat_ir_effect,atl03_quality_tx_part_sat_burst,atl03_quality_tx_part_sat_streak,atl03_quality_tx_full_sat,atl03_quality_tx_full_sat_afterpulse,atl03_quality_tx_full_sat_ir_effect,atl03_quality_tx_full_sat_burst,atl03_quality_tx_full_sat_streak]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "min_dem_delta": -100,
  • "max_dem_delta": 50,
  • "fit": {
    },
  • "atl03_bckgrd_fields": [
    ],
  • "atl03_corr_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "asset09": "icesat2",
  • "uncertainty": {
    },
  • "atl09_fields": [
    ],
  • "yapc": {
    },
  • "resource": "string",
  • "atl03_ph_fields": [
    ],
  • "atl24": {
    },
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "phoreal": {
    },
  • "pass_invalid": false,
  • "res": 20,
  • "min_geoid_delta": -100,
  • "max_geoid_delta": 50,
  • "proj": "auto",
  • "cnt": 10,
  • "ats": 20,
  • "region_mask": {
    },
  • "surface": {
    },
  • "atl03_geo_fields": [
    ],
  • "poly": [
    ],
  • "node_timeout": 600,
  • "cnf": [
    ],
  • "srt": "dynamic",
  • "key_space": 18446744073709552000,
  • "generate_ndwi": false,
  • "atl08_class": [ ],
  • "read_timeout": 600,
  • "atl08_fields": [
    ],
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "refraction": {
    },
  • "use_bathy_mask": true,
  • "granule": {
    },
  • "dist_in_seg": false,
  • "asset": "string",
  • "podppd": 1,
  • "datum": "unspecified",
  • "als": {
    },
  • "len": 40,
  • "spots": [
    ],
  • "ph_in_extent": 8192,
  • "quality_ph": [
    ]
}

CASALS 1B Dataframe

Spatially and temporally subsets CASALS 1B waveforms (x-series)

Request Body schema: application/json
object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

anc_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields from the source granules to include in response

Responses

Request samples

Content type
application/json
{
  • "samples": {
    },
  • "max_resources": 300,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "anc_fields": [
    ]
}

GEDI 1B Dataframe

Spatially and temporally subsets waveforms from multiple GEDI 1B granules with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

degrade_filter
boolean <bool>
Default: false

Filter for degraded data; when enabled, degraded returns are not included in the response

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

beam
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; deprecated, use 'beams'; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Versioning and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

degrade_flag
integer <int32>
Default: 0

Flag for filtering degraded data (only source data that matches flag value is included); deprecated, use 'degrade_filter'

anc_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields from the source granules to include in the response

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "max_resources": 300,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "degrade_filter": false,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "beam": [
    ],
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "degrade_flag": 0,
  • "anc_fields": [
    ]
}

GEDI 2A Dataframe

Spatially and temporally subsets elevations from multiple GEDI 2A granules with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

l2_quality_flag
integer <int32>
Default: 0

Flag for level 2 low quality data (only source data that matches flag value is included); deprecated, use 'l2_quality_filter'

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

l2_quality_filter
boolean <bool>
Default: false

Filter for level 2 low quality data; when enabled, low quality returns are not included in the response

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

surface_filter
boolean <bool>
Default: false

Filter for surface data; when enabled, only surface returns are included in the response

degrade_filter
boolean <bool>
Default: false

Filter for degraded data; when enabled, degraded returns are not included in the response

surface_flag
integer <int32>
Default: 0

Flag for surface data (only source data that matches flag value is included); deprecated, use 'surface_filter'

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

beam
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; deprecated, use 'beams'; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Versioning and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

degrade_flag
integer <int32>
Default: 0

Flag for filtering degraded data (only source data that matches flag value is included); deprecated, use 'degrade_filter'

anc_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields from the source granules to include in the response

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "l2_quality_flag": 0,
  • "max_resources": 300,
  • "l2_quality_filter": false,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "surface_filter": false,
  • "degrade_filter": false,
  • "surface_flag": 0,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "beam": [
    ],
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "degrade_flag": 0,
  • "anc_fields": [
    ]
}

GEDI 4A Dataframe

Spatially and temporally subsets above ground biomass density from multiple GEDI 4A granules with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

l2_quality_flag
integer <int32>
Default: 0

Flag for level 2 low quality data (only source data that matches flag value is included); deprecated, use 'l2_quality_filter'

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

l2_quality_filter
boolean <bool>
Default: false

Filter for level 2 low quality data; when enabled, low quality returns are not included in the response

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

l4_quality_flag
integer <int32>
Default: 0

Flag for level 4 low quality data (only source data that matches flag value is included); deprecated, use 'l4_quality_filter'

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

l4_quality_filter
boolean <bool>
Default: false

Filter for level 4 low quality data; when enabled, low quality returns are not included in the response

surface_filter
boolean <bool>
Default: false

Filter for surface data; when enabled, only surface returns are included in the response

degrade_filter
boolean <bool>
Default: false

Filter for degraded data; when enabled, degraded returns are not included in the response

surface_flag
integer <int32>
Default: 0

Flag for surface data (only source data that matches flag value is included); deprecated, use 'surface_filter'

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

beam
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; deprecated, use 'beams'; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Versioning and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

degrade_flag
integer <int32>
Default: 0

Flag for filtering degraded data (only source data that matches flag value is included); deprecated, use 'degrade_filter'

anc_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields from the source granules to include in the response

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "l2_quality_flag": 0,
  • "max_resources": 300,
  • "l2_quality_filter": false,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "l4_quality_flag": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "l4_quality_filter": false,
  • "surface_filter": false,
  • "degrade_filter": false,
  • "surface_flag": 0,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "beam": [
    ],
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "degrade_flag": 0,
  • "anc_fields": [
    ]
}

H5Coro Dataframe

Read values from an HDF5 object using an H5Coro dataframe reader

Request Body schema: application/json
object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

y
string <binary>

The 'h5x' dataframe column to identify as the y coordinate

startrow
integer <int64>
Default: 0

The first row to start reading from in a multi-dimensional dataset (or starting element if there is only one dimension)

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

time
string <binary>

The 'h5x' dataframe column to identify as the time

index
string <binary>

The 'h5x' dataframe column to identify as the index

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

numrows
integer <int64>
Default: -1

The number of rows to read when reading from a multi-dimensional dataset (or number of elements if there is only one dimension); if ALL_ROWS selected, it will read from the startrow to the end of the dataset

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

crs
string <binary>

Coordinate reference system to attach to the resulting dataframe when 'h5x' is used to build a dataframe from an HDF5 granule

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

groups
Array of strings <binary> [ items <binary > ]

The groups to pull from when 'h5x' is reading variables to build the dataframe

z
string <binary>

The 'h5x' dataframe column to identify as the z coordinate

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

variables
Array of strings <binary> [ items <binary > ]

The variables to read when 'h5x' is building the dataframe; each variable becomes a column in the dataframe

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

x
string <binary>

The 'h5x' dataframe column to identify as the x coordinate

col
integer <int64>
Default: 0

The column to read from the dataset for a multi-dimensional dataset; if there are more than two dimensions, all remaining dimensions are flattened out when returned; if the variable has more than one column, then by default the first column is read, if all columns are wanted, then set col=-1 and the result will be a flattened array of all of the data

Responses

Request samples

Content type
application/json
{
  • "samples": {
    },
  • "y": "string",
  • "startrow": 0,
  • "max_resources": 300,
  • "time": "string",
  • "index": "string",
  • "resource": "string",
  • "numrows": -1,
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "crs": "string",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "groups": [
    ],
  • "z": "string",
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "variables": [
    ],
  • "asset": "string",
  • "datum": "unspecified",
  • "x": "string",
  • "col": 0
}

p-series

custom stream processing

ATL06-SR

Generates ATL06 elevations using user supplied processing parameters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

object

Configuration structure for the 'Surface Fitting' algorithm; when provided the servers will fit a surface to the source photon cloud and return an elevation dataset similar to ATL06

atl03_bckgrd_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'bckgrd_atlas' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

atl03_corr_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geophys_corr' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

object

Configuration structure for the 'Yet Another Photon Classifier' algorithm; when provided the servers will calculate a density score for each photon and include that score in the response data

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

atl03_ph_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'heights' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

object

Configuration for classifying bathymetry photons

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

object

Configuration structure for the 'PhoREAL' algorithm; when provided the servers will calculate canopy metrics on the source photon cloud and return those metrics as a dataset similar to ATL08

pass_invalid
boolean <bool>
Default: false

Boolean flag indicating whether or not extents that fail validation checks are still used and returned in the results

res
number <double>
Default: 20

Step (in meters) of the variable length segments; could also be thought of as the spacing of the segments or the resolution of the segments

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

cnt
integer <int32>
Default: 10

Minimum photon count in the variable length segment for the segment to be processed

ats
number <double>
Default: 20

Minimum along track spread of the photons (in meters) in the variable length segment for the segment to be processed

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

atl03_geo_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geolocation' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

H_min_win
number <double>
Default: 3

Minimum vertical window used by the Surface Fitting algorithm when fitting a line to the photons in a segment; deprecated, use fit.H_min_win

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

cnf
Array of integers <int32> = 7 items [ items <int32 > ]
Default: ["atl03_low","atl03_medium","atl03_high"]

Confidence level for photon selection, can be supplied as a single value (which means the confidence must be at least that), or a list (which means the confidence must be in the list); note - the confidence can be supplied as strings or as numbers {-2, -1, 0, 1, 2, 3, 4}; [atl03_tep,atl03_not_considered,atl03_background,atl03_within_10m,atl03_low,atl03_medium,atl03_high]

srt
integer <int32>
Default: "dynamic"

Surface reference type: 0-land, 1-ocean, 2-sea ice, 3-land ice, 4-inland water

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

sigma_r_max
number <double>
Default: 5

Maximum robust dispersion used by the Surface Fitting algorithm when fitting a line to the photons in a segment; deprecated, use fit.sigma_r_max

atl08_class
Array of integers <int32> = 5 items [ items <int32 > ]
Default: []

List of ATL08 classifications used to select which photons are used in the processing; [atl08_noise,atl08_ground,atl08_canopy,atl08_top_of_canopy,atl08_unclassified]

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

atl08_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_segments' group of the ATL08 granule to include in the response; supported by atl03x, and phoreal

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

dist_in_seg
boolean <bool>
Default: false

Boolean flag indicating that the units of the len and res are in ATL03 segments (e.g. if true then len=2 is exactly two ATL03 segments which is approximately 40 meters)

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

podppd
integer <uint8>
Default: 1

Pointing/geolocation degradation mask; each bit in the mask represents a pointing/geolocation solution quality assessment to be included; the bits are 0: nominal, 1: pod_degrade, 2: ppd_degrade, 3: podppd_degrade, 4: cal_nominal, 5: cal_pod_degrade, 6: cal_ppd_degrade, 7: cal_podppd_degrade

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

maxi
integer <int32>
Default: 5

Maximum number of iterations for the Surface Fitting algorithm to run when fitting a line to the photons in a segment; deprecated, use the fit.maxi field

object

Configuration structure for the 'Surface Blanket' algorithm; when provided the servers will calculate a canopy top and ground using the source photon cloud and return those values in the response

len
number <double>
Default: 40

Size (in meters) of the variable length segment

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

quality_ph
Array of integers <int32> = 26 items [ items <int32 > ]
Default: ["atl03_quality_nominal"]

Quality classification based on an ATL03 algorithms that attempt to identify instrumental artifacts, can be supplied as a single value (which means the classification must be exactly that), or a list (which means the classification must be in the list); [atl03_quality_nominal,atl03_quality_afterpulse,atl03_quality_impulse_response,atl03_quality_tep,atl03_quality_noise_burst,atl03_quality_noise_streak,atl03_quality_tx_part_sat,atl03_quality_tx_part_sat_afterpulse,atl03_quality_tx_part_sat_ir_effect,atl03_quality_tx_part_sat_burst,atl03_quality_tx_part_sat_streak,atl03_quality_tx_full_sat,atl03_quality_tx_full_sat_afterpulse,atl03_quality_tx_full_sat_ir_effect,atl03_quality_tx_full_sat_burst,atl03_quality_tx_full_sat_streak]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "fit": {
    },
  • "atl03_bckgrd_fields": [
    ],
  • "atl03_corr_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "yapc": {
    },
  • "resource": "string",
  • "atl03_ph_fields": [
    ],
  • "atl24": {
    },
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "phoreal": {
    },
  • "pass_invalid": false,
  • "res": 20,
  • "proj": "auto",
  • "cnt": 10,
  • "ats": 20,
  • "region_mask": {
    },
  • "atl03_geo_fields": [
    ],
  • "poly": [
    ],
  • "H_min_win": 3,
  • "node_timeout": 600,
  • "cnf": [
    ],
  • "srt": "dynamic",
  • "key_space": 18446744073709552000,
  • "sigma_r_max": 5,
  • "atl08_class": [ ],
  • "read_timeout": 600,
  • "atl08_fields": [
    ],
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "dist_in_seg": false,
  • "asset": "string",
  • "podppd": 1,
  • "datum": "unspecified",
  • "maxi": 5,
  • "als": {
    },
  • "len": 40,
  • "spots": [
    ],
  • "quality_ph": [
    ]
}

ATL06-SR Parallel

Generates ATL06 elevations using user supplied processing parameters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

object

Configuration structure for the 'Surface Fitting' algorithm; when provided the servers will fit a surface to the source photon cloud and return an elevation dataset similar to ATL06

atl03_bckgrd_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'bckgrd_atlas' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

atl03_corr_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geophys_corr' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

object

Configuration structure for the 'Yet Another Photon Classifier' algorithm; when provided the servers will calculate a density score for each photon and include that score in the response data

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

atl03_ph_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'heights' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

object

Configuration for classifying bathymetry photons

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

object

Configuration structure for the 'PhoREAL' algorithm; when provided the servers will calculate canopy metrics on the source photon cloud and return those metrics as a dataset similar to ATL08

pass_invalid
boolean <bool>
Default: false

Boolean flag indicating whether or not extents that fail validation checks are still used and returned in the results

res
number <double>
Default: 20

Step (in meters) of the variable length segments; could also be thought of as the spacing of the segments or the resolution of the segments

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

cnt
integer <int32>
Default: 10

Minimum photon count in the variable length segment for the segment to be processed

ats
number <double>
Default: 20

Minimum along track spread of the photons (in meters) in the variable length segment for the segment to be processed

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

atl03_geo_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geolocation' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

H_min_win
number <double>
Default: 3

Minimum vertical window used by the Surface Fitting algorithm when fitting a line to the photons in a segment; deprecated, use fit.H_min_win

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

cnf
Array of integers <int32> = 7 items [ items <int32 > ]
Default: ["atl03_low","atl03_medium","atl03_high"]

Confidence level for photon selection, can be supplied as a single value (which means the confidence must be at least that), or a list (which means the confidence must be in the list); note - the confidence can be supplied as strings or as numbers {-2, -1, 0, 1, 2, 3, 4}; [atl03_tep,atl03_not_considered,atl03_background,atl03_within_10m,atl03_low,atl03_medium,atl03_high]

srt
integer <int32>
Default: "dynamic"

Surface reference type: 0-land, 1-ocean, 2-sea ice, 3-land ice, 4-inland water

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

sigma_r_max
number <double>
Default: 5

Maximum robust dispersion used by the Surface Fitting algorithm when fitting a line to the photons in a segment; deprecated, use fit.sigma_r_max

atl08_class
Array of integers <int32> = 5 items [ items <int32 > ]
Default: []

List of ATL08 classifications used to select which photons are used in the processing; [atl08_noise,atl08_ground,atl08_canopy,atl08_top_of_canopy,atl08_unclassified]

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

atl08_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_segments' group of the ATL08 granule to include in the response; supported by atl03x, and phoreal

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

dist_in_seg
boolean <bool>
Default: false

Boolean flag indicating that the units of the len and res are in ATL03 segments (e.g. if true then len=2 is exactly two ATL03 segments which is approximately 40 meters)

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

podppd
integer <uint8>
Default: 1

Pointing/geolocation degradation mask; each bit in the mask represents a pointing/geolocation solution quality assessment to be included; the bits are 0: nominal, 1: pod_degrade, 2: ppd_degrade, 3: podppd_degrade, 4: cal_nominal, 5: cal_pod_degrade, 6: cal_ppd_degrade, 7: cal_podppd_degrade

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

maxi
integer <int32>
Default: 5

Maximum number of iterations for the Surface Fitting algorithm to run when fitting a line to the photons in a segment; deprecated, use the fit.maxi field

object

Configuration structure for the 'Surface Blanket' algorithm; when provided the servers will calculate a canopy top and ground using the source photon cloud and return those values in the response

len
number <double>
Default: 40

Size (in meters) of the variable length segment

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

quality_ph
Array of integers <int32> = 26 items [ items <int32 > ]
Default: ["atl03_quality_nominal"]

Quality classification based on an ATL03 algorithms that attempt to identify instrumental artifacts, can be supplied as a single value (which means the classification must be exactly that), or a list (which means the classification must be in the list); [atl03_quality_nominal,atl03_quality_afterpulse,atl03_quality_impulse_response,atl03_quality_tep,atl03_quality_noise_burst,atl03_quality_noise_streak,atl03_quality_tx_part_sat,atl03_quality_tx_part_sat_afterpulse,atl03_quality_tx_part_sat_ir_effect,atl03_quality_tx_part_sat_burst,atl03_quality_tx_part_sat_streak,atl03_quality_tx_full_sat,atl03_quality_tx_full_sat_afterpulse,atl03_quality_tx_full_sat_ir_effect,atl03_quality_tx_full_sat_burst,atl03_quality_tx_full_sat_streak]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "fit": {
    },
  • "atl03_bckgrd_fields": [
    ],
  • "atl03_corr_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "yapc": {
    },
  • "resource": "string",
  • "atl03_ph_fields": [
    ],
  • "atl24": {
    },
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "phoreal": {
    },
  • "pass_invalid": false,
  • "res": 20,
  • "proj": "auto",
  • "cnt": 10,
  • "ats": 20,
  • "region_mask": {
    },
  • "atl03_geo_fields": [
    ],
  • "poly": [
    ],
  • "H_min_win": 3,
  • "node_timeout": 600,
  • "cnf": [
    ],
  • "srt": "dynamic",
  • "key_space": 18446744073709552000,
  • "sigma_r_max": 5,
  • "atl08_class": [ ],
  • "read_timeout": 600,
  • "atl08_fields": [
    ],
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "dist_in_seg": false,
  • "asset": "string",
  • "podppd": 1,
  • "datum": "unspecified",
  • "maxi": 5,
  • "als": {
    },
  • "len": 40,
  • "spots": [
    ],
  • "quality_ph": [
    ]
}

ATL08 PhoReal Vegetation Metrics

Generates ATL08-like vegetation metrics using user supplied processing parameters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

object

Configuration structure for the 'Surface Fitting' algorithm; when provided the servers will fit a surface to the source photon cloud and return an elevation dataset similar to ATL06

atl03_bckgrd_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'bckgrd_atlas' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

atl03_corr_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geophys_corr' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

object

Configuration structure for the 'Yet Another Photon Classifier' algorithm; when provided the servers will calculate a density score for each photon and include that score in the response data

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

atl03_ph_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'heights' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

object

Configuration for classifying bathymetry photons

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

object

Configuration structure for the 'PhoREAL' algorithm; when provided the servers will calculate canopy metrics on the source photon cloud and return those metrics as a dataset similar to ATL08

pass_invalid
boolean <bool>
Default: false

Boolean flag indicating whether or not extents that fail validation checks are still used and returned in the results

res
number <double>
Default: 20

Step (in meters) of the variable length segments; could also be thought of as the spacing of the segments or the resolution of the segments

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

cnt
integer <int32>
Default: 10

Minimum photon count in the variable length segment for the segment to be processed

ats
number <double>
Default: 20

Minimum along track spread of the photons (in meters) in the variable length segment for the segment to be processed

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

atl03_geo_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geolocation' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

cnf
Array of integers <int32> = 7 items [ items <int32 > ]
Default: ["atl03_low","atl03_medium","atl03_high"]

Confidence level for photon selection, can be supplied as a single value (which means the confidence must be at least that), or a list (which means the confidence must be in the list); note - the confidence can be supplied as strings or as numbers {-2, -1, 0, 1, 2, 3, 4}; [atl03_tep,atl03_not_considered,atl03_background,atl03_within_10m,atl03_low,atl03_medium,atl03_high]

srt
integer <int32>
Default: "dynamic"

Surface reference type: 0-land, 1-ocean, 2-sea ice, 3-land ice, 4-inland water

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

atl08_class
Array of integers <int32> = 5 items [ items <int32 > ]
Default: []

List of ATL08 classifications used to select which photons are used in the processing; [atl08_noise,atl08_ground,atl08_canopy,atl08_top_of_canopy,atl08_unclassified]

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

atl08_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_segments' group of the ATL08 granule to include in the response; supported by atl03x, and phoreal

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

dist_in_seg
boolean <bool>
Default: false

Boolean flag indicating that the units of the len and res are in ATL03 segments (e.g. if true then len=2 is exactly two ATL03 segments which is approximately 40 meters)

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

podppd
integer <uint8>
Default: 1

Pointing/geolocation degradation mask; each bit in the mask represents a pointing/geolocation solution quality assessment to be included; the bits are 0: nominal, 1: pod_degrade, 2: ppd_degrade, 3: podppd_degrade, 4: cal_nominal, 5: cal_pod_degrade, 6: cal_ppd_degrade, 7: cal_podppd_degrade

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

object

Configuration structure for the 'Surface Blanket' algorithm; when provided the servers will calculate a canopy top and ground using the source photon cloud and return those values in the response

len
number <double>
Default: 40

Size (in meters) of the variable length segment

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

quality_ph
Array of integers <int32> = 26 items [ items <int32 > ]
Default: ["atl03_quality_nominal"]

Quality classification based on an ATL03 algorithms that attempt to identify instrumental artifacts, can be supplied as a single value (which means the classification must be exactly that), or a list (which means the classification must be in the list); [atl03_quality_nominal,atl03_quality_afterpulse,atl03_quality_impulse_response,atl03_quality_tep,atl03_quality_noise_burst,atl03_quality_noise_streak,atl03_quality_tx_part_sat,atl03_quality_tx_part_sat_afterpulse,atl03_quality_tx_part_sat_ir_effect,atl03_quality_tx_part_sat_burst,atl03_quality_tx_part_sat_streak,atl03_quality_tx_full_sat,atl03_quality_tx_full_sat_afterpulse,atl03_quality_tx_full_sat_ir_effect,atl03_quality_tx_full_sat_burst,atl03_quality_tx_full_sat_streak]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "fit": {
    },
  • "atl03_bckgrd_fields": [
    ],
  • "atl03_corr_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "yapc": {
    },
  • "resource": "string",
  • "atl03_ph_fields": [
    ],
  • "atl24": {
    },
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "phoreal": {
    },
  • "pass_invalid": false,
  • "res": 20,
  • "proj": "auto",
  • "cnt": 10,
  • "ats": 20,
  • "region_mask": {
    },
  • "atl03_geo_fields": [
    ],
  • "poly": [
    ],
  • "node_timeout": 600,
  • "cnf": [
    ],
  • "srt": "dynamic",
  • "key_space": 18446744073709552000,
  • "atl08_class": [ ],
  • "read_timeout": 600,
  • "atl08_fields": [
    ],
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "dist_in_seg": false,
  • "asset": "string",
  • "podppd": 1,
  • "datum": "unspecified",
  • "als": {
    },
  • "len": 40,
  • "spots": [
    ],
  • "quality_ph": [
    ]
}

ATL08 PhoReal Vegetation Metrics Parallel

Generates ATL08-like vegetation metrics using user supplied processing parameters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

object

Configuration structure for the 'Surface Fitting' algorithm; when provided the servers will fit a surface to the source photon cloud and return an elevation dataset similar to ATL06

atl03_bckgrd_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'bckgrd_atlas' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

atl03_corr_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geophys_corr' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

object

Configuration structure for the 'Yet Another Photon Classifier' algorithm; when provided the servers will calculate a density score for each photon and include that score in the response data

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

atl03_ph_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'heights' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

object

Configuration for classifying bathymetry photons

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

object

Configuration structure for the 'PhoREAL' algorithm; when provided the servers will calculate canopy metrics on the source photon cloud and return those metrics as a dataset similar to ATL08

pass_invalid
boolean <bool>
Default: false

Boolean flag indicating whether or not extents that fail validation checks are still used and returned in the results

res
number <double>
Default: 20

Step (in meters) of the variable length segments; could also be thought of as the spacing of the segments or the resolution of the segments

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

cnt
integer <int32>
Default: 10

Minimum photon count in the variable length segment for the segment to be processed

ats
number <double>
Default: 20

Minimum along track spread of the photons (in meters) in the variable length segment for the segment to be processed

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

atl03_geo_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geolocation' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

cnf
Array of integers <int32> = 7 items [ items <int32 > ]
Default: ["atl03_low","atl03_medium","atl03_high"]

Confidence level for photon selection, can be supplied as a single value (which means the confidence must be at least that), or a list (which means the confidence must be in the list); note - the confidence can be supplied as strings or as numbers {-2, -1, 0, 1, 2, 3, 4}; [atl03_tep,atl03_not_considered,atl03_background,atl03_within_10m,atl03_low,atl03_medium,atl03_high]

srt
integer <int32>
Default: "dynamic"

Surface reference type: 0-land, 1-ocean, 2-sea ice, 3-land ice, 4-inland water

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

atl08_class
Array of integers <int32> = 5 items [ items <int32 > ]
Default: []

List of ATL08 classifications used to select which photons are used in the processing; [atl08_noise,atl08_ground,atl08_canopy,atl08_top_of_canopy,atl08_unclassified]

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

atl08_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_segments' group of the ATL08 granule to include in the response; supported by atl03x, and phoreal

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

dist_in_seg
boolean <bool>
Default: false

Boolean flag indicating that the units of the len and res are in ATL03 segments (e.g. if true then len=2 is exactly two ATL03 segments which is approximately 40 meters)

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

podppd
integer <uint8>
Default: 1

Pointing/geolocation degradation mask; each bit in the mask represents a pointing/geolocation solution quality assessment to be included; the bits are 0: nominal, 1: pod_degrade, 2: ppd_degrade, 3: podppd_degrade, 4: cal_nominal, 5: cal_pod_degrade, 6: cal_ppd_degrade, 7: cal_podppd_degrade

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

object

Configuration structure for the 'Surface Blanket' algorithm; when provided the servers will calculate a canopy top and ground using the source photon cloud and return those values in the response

len
number <double>
Default: 40

Size (in meters) of the variable length segment

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

quality_ph
Array of integers <int32> = 26 items [ items <int32 > ]
Default: ["atl03_quality_nominal"]

Quality classification based on an ATL03 algorithms that attempt to identify instrumental artifacts, can be supplied as a single value (which means the classification must be exactly that), or a list (which means the classification must be in the list); [atl03_quality_nominal,atl03_quality_afterpulse,atl03_quality_impulse_response,atl03_quality_tep,atl03_quality_noise_burst,atl03_quality_noise_streak,atl03_quality_tx_part_sat,atl03_quality_tx_part_sat_afterpulse,atl03_quality_tx_part_sat_ir_effect,atl03_quality_tx_part_sat_burst,atl03_quality_tx_part_sat_streak,atl03_quality_tx_full_sat,atl03_quality_tx_full_sat_afterpulse,atl03_quality_tx_full_sat_ir_effect,atl03_quality_tx_full_sat_burst,atl03_quality_tx_full_sat_streak]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "fit": {
    },
  • "atl03_bckgrd_fields": [
    ],
  • "atl03_corr_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "yapc": {
    },
  • "resource": "string",
  • "atl03_ph_fields": [
    ],
  • "atl24": {
    },
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "phoreal": {
    },
  • "pass_invalid": false,
  • "res": 20,
  • "proj": "auto",
  • "cnt": 10,
  • "ats": 20,
  • "region_mask": {
    },
  • "atl03_geo_fields": [
    ],
  • "poly": [
    ],
  • "node_timeout": 600,
  • "cnf": [
    ],
  • "srt": "dynamic",
  • "key_space": 18446744073709552000,
  • "atl08_class": [ ],
  • "read_timeout": 600,
  • "atl08_fields": [
    ],
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "dist_in_seg": false,
  • "asset": "string",
  • "podppd": 1,
  • "datum": "unspecified",
  • "als": {
    },
  • "len": 40,
  • "spots": [
    ],
  • "quality_ph": [
    ]
}

Events

List system events that occur for given duration

Authorizations:
OAuth2
Request Body schema: application/json
type
integer
Default: 1

Bitmask of event types to subscribe to (core.LOG=1, core.TRACE=2, core.TELEMETRY=4, core.ALERT=8)

duration
integer
Default: 600

Seconds to hold connection open; max 600

Responses

Request samples

Content type
application/json
{
  • "type": 1,
  • "duration": 600
}

GEDI 1B Subsetter

Spatially and temporally subsets single GEDI 1B granule waveforms with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

degrade_filter
boolean <bool>
Default: false

Filter for degraded data; when enabled, degraded returns are not included in the response

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

beam
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; deprecated, use 'beams'; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Versioning and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

degrade_flag
integer <int32>
Default: 0

Flag for filtering degraded data (only source data that matches flag value is included); deprecated, use 'degrade_filter'

anc_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields from the source granules to include in the response

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "max_resources": 300,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "degrade_filter": false,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "beam": [
    ],
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "degrade_flag": 0,
  • "anc_fields": [
    ]
}

GEDI 1B Parallel Subsetter

Spatially and temporally subsets waveforms from multiple GEDI 1B granules with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

degrade_filter
boolean <bool>
Default: false

Filter for degraded data; when enabled, degraded returns are not included in the response

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

beam
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; deprecated, use 'beams'; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Versioning and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

degrade_flag
integer <int32>
Default: 0

Flag for filtering degraded data (only source data that matches flag value is included); deprecated, use 'degrade_filter'

anc_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields from the source granules to include in the response

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "max_resources": 300,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "degrade_filter": false,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "beam": [
    ],
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "degrade_flag": 0,
  • "anc_fields": [
    ]
}

GEDI 2A Subsetter

Spatially and temporally subsets single GEDI 2A granule elevations with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

l2_quality_flag
integer <int32>
Default: 0

Flag for level 2 low quality data (only source data that matches flag value is included); deprecated, use 'l2_quality_filter'

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

l2_quality_filter
boolean <bool>
Default: false

Filter for level 2 low quality data; when enabled, low quality returns are not included in the response

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

surface_filter
boolean <bool>
Default: false

Filter for surface data; when enabled, only surface returns are included in the response

degrade_filter
boolean <bool>
Default: false

Filter for degraded data; when enabled, degraded returns are not included in the response

surface_flag
integer <int32>
Default: 0

Flag for surface data (only source data that matches flag value is included); deprecated, use 'surface_filter'

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

beam
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; deprecated, use 'beams'; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Versioning and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

degrade_flag
integer <int32>
Default: 0

Flag for filtering degraded data (only source data that matches flag value is included); deprecated, use 'degrade_filter'

anc_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields from the source granules to include in the response

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "l2_quality_flag": 0,
  • "max_resources": 300,
  • "l2_quality_filter": false,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "surface_filter": false,
  • "degrade_filter": false,
  • "surface_flag": 0,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "beam": [
    ],
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "degrade_flag": 0,
  • "anc_fields": [
    ]
}

GEDI 2A Parallel Subsetter

Spatially and temporally subsets elevations from multiple GEDI 2A granules with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

l2_quality_flag
integer <int32>
Default: 0

Flag for level 2 low quality data (only source data that matches flag value is included); deprecated, use 'l2_quality_filter'

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

l2_quality_filter
boolean <bool>
Default: false

Filter for level 2 low quality data; when enabled, low quality returns are not included in the response

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

surface_filter
boolean <bool>
Default: false

Filter for surface data; when enabled, only surface returns are included in the response

degrade_filter
boolean <bool>
Default: false

Filter for degraded data; when enabled, degraded returns are not included in the response

surface_flag
integer <int32>
Default: 0

Flag for surface data (only source data that matches flag value is included); deprecated, use 'surface_filter'

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

beam
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; deprecated, use 'beams'; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Versioning and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

degrade_flag
integer <int32>
Default: 0

Flag for filtering degraded data (only source data that matches flag value is included); deprecated, use 'degrade_filter'

anc_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields from the source granules to include in the response

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "l2_quality_flag": 0,
  • "max_resources": 300,
  • "l2_quality_filter": false,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "surface_filter": false,
  • "degrade_filter": false,
  • "surface_flag": 0,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "beam": [
    ],
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "degrade_flag": 0,
  • "anc_fields": [
    ]
}

GEDI 4A Subsetter

Spatially and temporally subsets single GEDI 4A granule above ground biomass density with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

l2_quality_flag
integer <int32>
Default: 0

Flag for level 2 low quality data (only source data that matches flag value is included); deprecated, use 'l2_quality_filter'

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

l2_quality_filter
boolean <bool>
Default: false

Filter for level 2 low quality data; when enabled, low quality returns are not included in the response

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

l4_quality_flag
integer <int32>
Default: 0

Flag for level 4 low quality data (only source data that matches flag value is included); deprecated, use 'l4_quality_filter'

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

l4_quality_filter
boolean <bool>
Default: false

Filter for level 4 low quality data; when enabled, low quality returns are not included in the response

surface_filter
boolean <bool>
Default: false

Filter for surface data; when enabled, only surface returns are included in the response

degrade_filter
boolean <bool>
Default: false

Filter for degraded data; when enabled, degraded returns are not included in the response

surface_flag
integer <int32>
Default: 0

Flag for surface data (only source data that matches flag value is included); deprecated, use 'surface_filter'

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

beam
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; deprecated, use 'beams'; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Versioning and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

degrade_flag
integer <int32>
Default: 0

Flag for filtering degraded data (only source data that matches flag value is included); deprecated, use 'degrade_filter'

anc_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields from the source granules to include in the response

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "l2_quality_flag": 0,
  • "max_resources": 300,
  • "l2_quality_filter": false,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "l4_quality_flag": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "l4_quality_filter": false,
  • "surface_filter": false,
  • "degrade_filter": false,
  • "surface_flag": 0,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "beam": [
    ],
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "degrade_flag": 0,
  • "anc_fields": [
    ]
}

GEDI 4A Parallel Subsetter

Spatially and temporally subsets above ground biomass density from multiple GEDI 4A granules with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

l2_quality_flag
integer <int32>
Default: 0

Flag for level 2 low quality data (only source data that matches flag value is included); deprecated, use 'l2_quality_filter'

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

l2_quality_filter
boolean <bool>
Default: false

Filter for level 2 low quality data; when enabled, low quality returns are not included in the response

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

l4_quality_flag
integer <int32>
Default: 0

Flag for level 4 low quality data (only source data that matches flag value is included); deprecated, use 'l4_quality_filter'

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

l4_quality_filter
boolean <bool>
Default: false

Filter for level 4 low quality data; when enabled, low quality returns are not included in the response

surface_filter
boolean <bool>
Default: false

Filter for surface data; when enabled, only surface returns are included in the response

degrade_filter
boolean <bool>
Default: false

Filter for degraded data; when enabled, degraded returns are not included in the response

surface_flag
integer <int32>
Default: 0

Flag for surface data (only source data that matches flag value is included); deprecated, use 'surface_filter'

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

beam
Array of integers <int32> = 8 items [ items <int32 > ]
Default: ["beam0","beam1","beam2","beam3","beam5","beam6","beam8","beam11"]

Laser beams to process; deprecated, use 'beams'; [beam0,beam1,beam2,beam3,beam5,beam6,beam8,beam11]

object

Versioning and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

degrade_flag
integer <int32>
Default: 0

Flag for filtering degraded data (only source data that matches flag value is included); deprecated, use 'degrade_filter'

anc_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields from the source granules to include in the response

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "l2_quality_flag": 0,
  • "max_resources": 300,
  • "l2_quality_filter": false,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "l4_quality_flag": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "l4_quality_filter": false,
  • "surface_filter": false,
  • "degrade_filter": false,
  • "surface_flag": 0,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "beam": [
    ],
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "degrade_flag": 0,
  • "anc_fields": [
    ]
}

H5Coro Dataset Read

Read values from an HDF5 object using an H5Coro streaming dataset reader

Request Body schema: application/json
asset
required
string

Name of the registered asset to read from

resource
required
string

URL of HDF5 file or object

dataset
required
string

Name of the dataset within the HDF5 file

datatype
integer

Data type enumeration (RecordObject::valType_t); defaults to DYNAMIC

col
integer
Default: 0

Column to read from a multi-dimensional dataset

startrow
integer
Default: 0

Starting row for the read

numrows
integer

Number of rows to read; defaults to all rows

id
integer
Default: 0

Integer ID to attach to the returned data

Responses

Request samples

Content type
application/json
{
  • "asset": "string",
  • "resource": "string",
  • "dataset": "string",
  • "datatype": 0,
  • "col": 0,
  • "startrow": 0,
  • "numrows": 0,
  • "id": 0
}

H5Coro File Read

Read values from an HDF5 object using an H5Coro file reader

Request Body schema: application/json
asset
required
string

Name of the registered asset to read from

resource
required
string

URL of HDF5 file or object

required
Array of objects

List of datasets to read from the HDF5 file

Responses

Request samples

Content type
application/json
{
  • "asset": "string",
  • "resource": "string",
  • "datasets": [
    ]
}

ATL03 Indexer

Generate spatial/temporal index records for a set of ATL03 granules

Request Body schema: application/json
asset
string
Default: "atlas-local"

Name of the ATL03 asset to index

resources
required
Array of strings

List of HDF5 file or object names to index

timeout
integer
Default: 600

Seconds to wait before timing out

Responses

Request samples

Content type
application/json
{
  • "asset": "atlas-local",
  • "resources": [
    ],
  • "timeout": 600
}

s-series

subsetting standard data products

ATL03 Subsetter

Spatially and temporally subsets single ATL03 photon cloud with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

object

Configuration structure for the 'Surface Fitting' algorithm; when provided the servers will fit a surface to the source photon cloud and return an elevation dataset similar to ATL06

atl03_bckgrd_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'bckgrd_atlas' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

atl03_corr_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geophys_corr' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

object

Configuration structure for the 'Yet Another Photon Classifier' algorithm; when provided the servers will calculate a density score for each photon and include that score in the response data

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

atl03_ph_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'heights' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

object

Configuration for classifying bathymetry photons

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

object

Configuration structure for the 'PhoREAL' algorithm; when provided the servers will calculate canopy metrics on the source photon cloud and return those metrics as a dataset similar to ATL08

pass_invalid
boolean <bool>
Default: false

Boolean flag indicating whether or not extents that fail validation checks are still used and returned in the results

res
number <double>
Default: 20

Step (in meters) of the variable length segments; could also be thought of as the spacing of the segments or the resolution of the segments

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

cnt
integer <int32>
Default: 10

Minimum photon count in the variable length segment for the segment to be processed

ats
number <double>
Default: 20

Minimum along track spread of the photons (in meters) in the variable length segment for the segment to be processed

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

atl03_geo_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geolocation' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

cnf
Array of integers <int32> = 7 items [ items <int32 > ]
Default: ["atl03_low","atl03_medium","atl03_high"]

Confidence level for photon selection, can be supplied as a single value (which means the confidence must be at least that), or a list (which means the confidence must be in the list); note - the confidence can be supplied as strings or as numbers {-2, -1, 0, 1, 2, 3, 4}; [atl03_tep,atl03_not_considered,atl03_background,atl03_within_10m,atl03_low,atl03_medium,atl03_high]

srt
integer <int32>
Default: "dynamic"

Surface reference type: 0-land, 1-ocean, 2-sea ice, 3-land ice, 4-inland water

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

atl08_class
Array of integers <int32> = 5 items [ items <int32 > ]
Default: []

List of ATL08 classifications used to select which photons are used in the processing; [atl08_noise,atl08_ground,atl08_canopy,atl08_top_of_canopy,atl08_unclassified]

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

atl08_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_segments' group of the ATL08 granule to include in the response; supported by atl03x, and phoreal

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

dist_in_seg
boolean <bool>
Default: false

Boolean flag indicating that the units of the len and res are in ATL03 segments (e.g. if true then len=2 is exactly two ATL03 segments which is approximately 40 meters)

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

podppd
integer <uint8>
Default: 1

Pointing/geolocation degradation mask; each bit in the mask represents a pointing/geolocation solution quality assessment to be included; the bits are 0: nominal, 1: pod_degrade, 2: ppd_degrade, 3: podppd_degrade, 4: cal_nominal, 5: cal_pod_degrade, 6: cal_ppd_degrade, 7: cal_podppd_degrade

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

object

Configuration structure for the 'Surface Blanket' algorithm; when provided the servers will calculate a canopy top and ground using the source photon cloud and return those values in the response

len
number <double>
Default: 40

Size (in meters) of the variable length segment

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

quality_ph
Array of integers <int32> = 26 items [ items <int32 > ]
Default: ["atl03_quality_nominal"]

Quality classification based on an ATL03 algorithms that attempt to identify instrumental artifacts, can be supplied as a single value (which means the classification must be exactly that), or a list (which means the classification must be in the list); [atl03_quality_nominal,atl03_quality_afterpulse,atl03_quality_impulse_response,atl03_quality_tep,atl03_quality_noise_burst,atl03_quality_noise_streak,atl03_quality_tx_part_sat,atl03_quality_tx_part_sat_afterpulse,atl03_quality_tx_part_sat_ir_effect,atl03_quality_tx_part_sat_burst,atl03_quality_tx_part_sat_streak,atl03_quality_tx_full_sat,atl03_quality_tx_full_sat_afterpulse,atl03_quality_tx_full_sat_ir_effect,atl03_quality_tx_full_sat_burst,atl03_quality_tx_full_sat_streak]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "fit": {
    },
  • "atl03_bckgrd_fields": [
    ],
  • "atl03_corr_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "yapc": {
    },
  • "resource": "string",
  • "atl03_ph_fields": [
    ],
  • "atl24": {
    },
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "phoreal": {
    },
  • "pass_invalid": false,
  • "res": 20,
  • "proj": "auto",
  • "cnt": 10,
  • "ats": 20,
  • "region_mask": {
    },
  • "atl03_geo_fields": [
    ],
  • "poly": [
    ],
  • "node_timeout": 600,
  • "cnf": [
    ],
  • "srt": "dynamic",
  • "key_space": 18446744073709552000,
  • "atl08_class": [ ],
  • "read_timeout": 600,
  • "atl08_fields": [
    ],
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "dist_in_seg": false,
  • "asset": "string",
  • "podppd": 1,
  • "datum": "unspecified",
  • "als": {
    },
  • "len": 40,
  • "spots": [
    ],
  • "quality_ph": [
    ]
}

ATL03 Parallel Subsetter

Spatially and temporally subsets multiple ATL03 photon clouds with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

object

Configuration structure for the 'Surface Fitting' algorithm; when provided the servers will fit a surface to the source photon cloud and return an elevation dataset similar to ATL06

atl03_bckgrd_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'bckgrd_atlas' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

atl03_corr_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geophys_corr' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

object

Configuration structure for the 'Yet Another Photon Classifier' algorithm; when provided the servers will calculate a density score for each photon and include that score in the response data

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

atl03_ph_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'heights' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

object

Configuration for classifying bathymetry photons

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

object

Configuration structure for the 'PhoREAL' algorithm; when provided the servers will calculate canopy metrics on the source photon cloud and return those metrics as a dataset similar to ATL08

pass_invalid
boolean <bool>
Default: false

Boolean flag indicating whether or not extents that fail validation checks are still used and returned in the results

res
number <double>
Default: 20

Step (in meters) of the variable length segments; could also be thought of as the spacing of the segments or the resolution of the segments

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

cnt
integer <int32>
Default: 10

Minimum photon count in the variable length segment for the segment to be processed

ats
number <double>
Default: 20

Minimum along track spread of the photons (in meters) in the variable length segment for the segment to be processed

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

atl03_geo_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geolocation' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

cnf
Array of integers <int32> = 7 items [ items <int32 > ]
Default: ["atl03_low","atl03_medium","atl03_high"]

Confidence level for photon selection, can be supplied as a single value (which means the confidence must be at least that), or a list (which means the confidence must be in the list); note - the confidence can be supplied as strings or as numbers {-2, -1, 0, 1, 2, 3, 4}; [atl03_tep,atl03_not_considered,atl03_background,atl03_within_10m,atl03_low,atl03_medium,atl03_high]

srt
integer <int32>
Default: "dynamic"

Surface reference type: 0-land, 1-ocean, 2-sea ice, 3-land ice, 4-inland water

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

atl08_class
Array of integers <int32> = 5 items [ items <int32 > ]
Default: []

List of ATL08 classifications used to select which photons are used in the processing; [atl08_noise,atl08_ground,atl08_canopy,atl08_top_of_canopy,atl08_unclassified]

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

atl08_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_segments' group of the ATL08 granule to include in the response; supported by atl03x, and phoreal

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

dist_in_seg
boolean <bool>
Default: false

Boolean flag indicating that the units of the len and res are in ATL03 segments (e.g. if true then len=2 is exactly two ATL03 segments which is approximately 40 meters)

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

podppd
integer <uint8>
Default: 1

Pointing/geolocation degradation mask; each bit in the mask represents a pointing/geolocation solution quality assessment to be included; the bits are 0: nominal, 1: pod_degrade, 2: ppd_degrade, 3: podppd_degrade, 4: cal_nominal, 5: cal_pod_degrade, 6: cal_ppd_degrade, 7: cal_podppd_degrade

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

object

Configuration structure for the 'Surface Blanket' algorithm; when provided the servers will calculate a canopy top and ground using the source photon cloud and return those values in the response

len
number <double>
Default: 40

Size (in meters) of the variable length segment

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

quality_ph
Array of integers <int32> = 26 items [ items <int32 > ]
Default: ["atl03_quality_nominal"]

Quality classification based on an ATL03 algorithms that attempt to identify instrumental artifacts, can be supplied as a single value (which means the classification must be exactly that), or a list (which means the classification must be in the list); [atl03_quality_nominal,atl03_quality_afterpulse,atl03_quality_impulse_response,atl03_quality_tep,atl03_quality_noise_burst,atl03_quality_noise_streak,atl03_quality_tx_part_sat,atl03_quality_tx_part_sat_afterpulse,atl03_quality_tx_part_sat_ir_effect,atl03_quality_tx_part_sat_burst,atl03_quality_tx_part_sat_streak,atl03_quality_tx_full_sat,atl03_quality_tx_full_sat_afterpulse,atl03_quality_tx_full_sat_ir_effect,atl03_quality_tx_full_sat_burst,atl03_quality_tx_full_sat_streak]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "fit": {
    },
  • "atl03_bckgrd_fields": [
    ],
  • "atl03_corr_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "yapc": {
    },
  • "resource": "string",
  • "atl03_ph_fields": [
    ],
  • "atl24": {
    },
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "phoreal": {
    },
  • "pass_invalid": false,
  • "res": 20,
  • "proj": "auto",
  • "cnt": 10,
  • "ats": 20,
  • "region_mask": {
    },
  • "atl03_geo_fields": [
    ],
  • "poly": [
    ],
  • "node_timeout": 600,
  • "cnf": [
    ],
  • "srt": "dynamic",
  • "key_space": 18446744073709552000,
  • "atl08_class": [ ],
  • "read_timeout": 600,
  • "atl08_fields": [
    ],
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "dist_in_seg": false,
  • "asset": "string",
  • "podppd": 1,
  • "datum": "unspecified",
  • "als": {
    },
  • "len": 40,
  • "spots": [
    ],
  • "quality_ph": [
    ]
}

ATL06 Subsetter

Spatially and temporally subsets single ATL06 granule elevations with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

atl06_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_ice_segments' group of the ATL06 granule to include in the response; supported by atl06x

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "atl06_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "spots": [
    ]
}

ATL06 Parallel Subsetter

Spatially and temporally subsets ATL06 granules elevations with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

atl06_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_ice_segments' group of the ATL06 granule to include in the response; supported by atl06x

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "atl06_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "spots": [
    ]
}

ATL13 Subsetter

Spatially and temporally subsets single ATL13 granule lake metrics with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

atl13_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL13 granule to include in the response (e.g. ice_flag); supported by atl13x

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "atl13_fields": [
    ],
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "spots": [
    ]
}

ATL13 Parallel Subsetter

Spatially and temporally subsets multiple ATL13 granule lake metrics with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

object

Configuration structure for the 'atl13x' dataset construction

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "asset": "string",
  • "datum": "unspecified",
  • "atl13": {
    },
  • "spots": [
    ]
}

SWOT L2 Subsetter

Spatially and temporally subsets single SWOT L2 granule with additional filters

Request Body schema: application/json
object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

variables
Array of strings <binary> [ items <binary > ]

Variables to include in response from source granule

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

Responses

Request samples

Content type
application/json
{
  • "samples": {
    },
  • "max_resources": 300,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "variables": [
    ],
  • "asset": "string",
  • "datum": "unspecified"
}

SWOT L2 Parallel Subsetter

Spatially and temporally subsets multiple SWOT L2 granules with additional filters

Request Body schema: application/json
object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

variables
Array of strings <binary> [ items <binary > ]

Variables to include in response from source granule

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

Responses

Request samples

Content type
application/json
{
  • "samples": {
    },
  • "max_resources": 300,
  • "resource": "string",
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "proj": "auto",
  • "region_mask": {
    },
  • "poly": [
    ],
  • "node_timeout": 600,
  • "key_space": 18446744073709552000,
  • "read_timeout": 600,
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "variables": [
    ],
  • "asset": "string",
  • "datum": "unspecified"
}

v-series

summary statistics of standard data products

ATL03 Viewer

Spatially and temporally subsets single ATL03 granule segments with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

object

Configuration structure for the 'Surface Fitting' algorithm; when provided the servers will fit a surface to the source photon cloud and return an elevation dataset similar to ATL06

atl03_bckgrd_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'bckgrd_atlas' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

atl03_corr_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geophys_corr' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

object

Configuration structure for the 'Yet Another Photon Classifier' algorithm; when provided the servers will calculate a density score for each photon and include that score in the response data

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

atl03_ph_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'heights' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

object

Configuration for classifying bathymetry photons

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

object

Configuration structure for the 'PhoREAL' algorithm; when provided the servers will calculate canopy metrics on the source photon cloud and return those metrics as a dataset similar to ATL08

pass_invalid
boolean <bool>
Default: false

Boolean flag indicating whether or not extents that fail validation checks are still used and returned in the results

res
number <double>
Default: 20

Step (in meters) of the variable length segments; could also be thought of as the spacing of the segments or the resolution of the segments

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

cnt
integer <int32>
Default: 10

Minimum photon count in the variable length segment for the segment to be processed

ats
number <double>
Default: 20

Minimum along track spread of the photons (in meters) in the variable length segment for the segment to be processed

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

atl03_geo_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geolocation' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

cnf
Array of integers <int32> = 7 items [ items <int32 > ]
Default: ["atl03_low","atl03_medium","atl03_high"]

Confidence level for photon selection, can be supplied as a single value (which means the confidence must be at least that), or a list (which means the confidence must be in the list); note - the confidence can be supplied as strings or as numbers {-2, -1, 0, 1, 2, 3, 4}; [atl03_tep,atl03_not_considered,atl03_background,atl03_within_10m,atl03_low,atl03_medium,atl03_high]

srt
integer <int32>
Default: "dynamic"

Surface reference type: 0-land, 1-ocean, 2-sea ice, 3-land ice, 4-inland water

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

atl08_class
Array of integers <int32> = 5 items [ items <int32 > ]
Default: []

List of ATL08 classifications used to select which photons are used in the processing; [atl08_noise,atl08_ground,atl08_canopy,atl08_top_of_canopy,atl08_unclassified]

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

atl08_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_segments' group of the ATL08 granule to include in the response; supported by atl03x, and phoreal

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

dist_in_seg
boolean <bool>
Default: false

Boolean flag indicating that the units of the len and res are in ATL03 segments (e.g. if true then len=2 is exactly two ATL03 segments which is approximately 40 meters)

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

podppd
integer <uint8>
Default: 1

Pointing/geolocation degradation mask; each bit in the mask represents a pointing/geolocation solution quality assessment to be included; the bits are 0: nominal, 1: pod_degrade, 2: ppd_degrade, 3: podppd_degrade, 4: cal_nominal, 5: cal_pod_degrade, 6: cal_ppd_degrade, 7: cal_podppd_degrade

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

object

Configuration structure for the 'Surface Blanket' algorithm; when provided the servers will calculate a canopy top and ground using the source photon cloud and return those values in the response

len
number <double>
Default: 40

Size (in meters) of the variable length segment

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

quality_ph
Array of integers <int32> = 26 items [ items <int32 > ]
Default: ["atl03_quality_nominal"]

Quality classification based on an ATL03 algorithms that attempt to identify instrumental artifacts, can be supplied as a single value (which means the classification must be exactly that), or a list (which means the classification must be in the list); [atl03_quality_nominal,atl03_quality_afterpulse,atl03_quality_impulse_response,atl03_quality_tep,atl03_quality_noise_burst,atl03_quality_noise_streak,atl03_quality_tx_part_sat,atl03_quality_tx_part_sat_afterpulse,atl03_quality_tx_part_sat_ir_effect,atl03_quality_tx_part_sat_burst,atl03_quality_tx_part_sat_streak,atl03_quality_tx_full_sat,atl03_quality_tx_full_sat_afterpulse,atl03_quality_tx_full_sat_ir_effect,atl03_quality_tx_full_sat_burst,atl03_quality_tx_full_sat_streak]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "fit": {
    },
  • "atl03_bckgrd_fields": [
    ],
  • "atl03_corr_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "yapc": {
    },
  • "resource": "string",
  • "atl03_ph_fields": [
    ],
  • "atl24": {
    },
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "phoreal": {
    },
  • "pass_invalid": false,
  • "res": 20,
  • "proj": "auto",
  • "cnt": 10,
  • "ats": 20,
  • "region_mask": {
    },
  • "atl03_geo_fields": [
    ],
  • "poly": [
    ],
  • "node_timeout": 600,
  • "cnf": [
    ],
  • "srt": "dynamic",
  • "key_space": 18446744073709552000,
  • "atl08_class": [ ],
  • "read_timeout": 600,
  • "atl08_fields": [
    ],
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "dist_in_seg": false,
  • "asset": "string",
  • "podppd": 1,
  • "datum": "unspecified",
  • "als": {
    },
  • "len": 40,
  • "spots": [
    ],
  • "quality_ph": [
    ]
}

ATL03 Parallel Viewer

Spatially and temporally subsets segments from multiple ATL03 granules with additional filters

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

object

Configuration structure for the 'Surface Fitting' algorithm; when provided the servers will fit a surface to the source photon cloud and return an elevation dataset similar to ATL06

atl03_bckgrd_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'bckgrd_atlas' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

atl03_corr_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geophys_corr' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

object

Configuration structure for the 'Yet Another Photon Classifier' algorithm; when provided the servers will calculate a density score for each photon and include that score in the response data

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

atl03_ph_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'heights' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

object

Configuration for classifying bathymetry photons

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

object

Configuration structure for the 'PhoREAL' algorithm; when provided the servers will calculate canopy metrics on the source photon cloud and return those metrics as a dataset similar to ATL08

pass_invalid
boolean <bool>
Default: false

Boolean flag indicating whether or not extents that fail validation checks are still used and returned in the results

res
number <double>
Default: 20

Step (in meters) of the variable length segments; could also be thought of as the spacing of the segments or the resolution of the segments

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

cnt
integer <int32>
Default: 10

Minimum photon count in the variable length segment for the segment to be processed

ats
number <double>
Default: 20

Minimum along track spread of the photons (in meters) in the variable length segment for the segment to be processed

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

atl03_geo_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geolocation' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

cnf
Array of integers <int32> = 7 items [ items <int32 > ]
Default: ["atl03_low","atl03_medium","atl03_high"]

Confidence level for photon selection, can be supplied as a single value (which means the confidence must be at least that), or a list (which means the confidence must be in the list); note - the confidence can be supplied as strings or as numbers {-2, -1, 0, 1, 2, 3, 4}; [atl03_tep,atl03_not_considered,atl03_background,atl03_within_10m,atl03_low,atl03_medium,atl03_high]

srt
integer <int32>
Default: "dynamic"

Surface reference type: 0-land, 1-ocean, 2-sea ice, 3-land ice, 4-inland water

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

atl08_class
Array of integers <int32> = 5 items [ items <int32 > ]
Default: []

List of ATL08 classifications used to select which photons are used in the processing; [atl08_noise,atl08_ground,atl08_canopy,atl08_top_of_canopy,atl08_unclassified]

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

atl08_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_segments' group of the ATL08 granule to include in the response; supported by atl03x, and phoreal

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Versioning, ground track, and date information pulled from the granule processed; output only

dist_in_seg
boolean <bool>
Default: false

Boolean flag indicating that the units of the len and res are in ATL03 segments (e.g. if true then len=2 is exactly two ATL03 segments which is approximately 40 meters)

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

podppd
integer <uint8>
Default: 1

Pointing/geolocation degradation mask; each bit in the mask represents a pointing/geolocation solution quality assessment to be included; the bits are 0: nominal, 1: pod_degrade, 2: ppd_degrade, 3: podppd_degrade, 4: cal_nominal, 5: cal_pod_degrade, 6: cal_ppd_degrade, 7: cal_podppd_degrade

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

object

Configuration structure for the 'Surface Blanket' algorithm; when provided the servers will calculate a canopy top and ground using the source photon cloud and return those values in the response

len
number <double>
Default: 40

Size (in meters) of the variable length segment

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

quality_ph
Array of integers <int32> = 26 items [ items <int32 > ]
Default: ["atl03_quality_nominal"]

Quality classification based on an ATL03 algorithms that attempt to identify instrumental artifacts, can be supplied as a single value (which means the classification must be exactly that), or a list (which means the classification must be in the list); [atl03_quality_nominal,atl03_quality_afterpulse,atl03_quality_impulse_response,atl03_quality_tep,atl03_quality_noise_burst,atl03_quality_noise_streak,atl03_quality_tx_part_sat,atl03_quality_tx_part_sat_afterpulse,atl03_quality_tx_part_sat_ir_effect,atl03_quality_tx_part_sat_burst,atl03_quality_tx_part_sat_streak,atl03_quality_tx_full_sat,atl03_quality_tx_full_sat_afterpulse,atl03_quality_tx_full_sat_ir_effect,atl03_quality_tx_full_sat_burst,atl03_quality_tx_full_sat_streak]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "fit": {
    },
  • "atl03_bckgrd_fields": [
    ],
  • "atl03_corr_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "atl09_fields": [
    ],
  • "yapc": {
    },
  • "resource": "string",
  • "atl03_ph_fields": [
    ],
  • "atl24": {
    },
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "phoreal": {
    },
  • "pass_invalid": false,
  • "res": 20,
  • "proj": "auto",
  • "cnt": 10,
  • "ats": 20,
  • "region_mask": {
    },
  • "atl03_geo_fields": [
    ],
  • "poly": [
    ],
  • "node_timeout": 600,
  • "cnf": [
    ],
  • "srt": "dynamic",
  • "key_space": 18446744073709552000,
  • "atl08_class": [ ],
  • "read_timeout": 600,
  • "atl08_fields": [
    ],
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "granule": {
    },
  • "dist_in_seg": false,
  • "asset": "string",
  • "podppd": 1,
  • "datum": "unspecified",
  • "als": {
    },
  • "len": 40,
  • "spots": [
    ],
  • "quality_ph": [
    ]
}

Bathymetry Viewer

Return number of photons in ATL03 granule within a bathymetry mask (s-series)

Request Body schema: application/json
beams
Array of integers <int32> = 6 items [ items <int32 > ]
Default: ["gt1l","gt1r","gt2l","gt2r","gt3l","gt3r"]

List of beams (gt1l, gt1r, gt2l, gt2r, gt3l, gt3r; defaults to all) to process; [gt1l,gt1r,gt2l,gt2r,gt3l,gt3r]

object

Configuration structure that defines raster sampling operations the servers are to perform and append to the results

min_dem_delta
number <double>
Default: -100

Maximum negative vertical distance of photon from ATL03 DEM to include in bathymetry processing

max_dem_delta
number <double>
Default: 50

Maximum positive vertical distance of photon from ATL03 DEM to include in bathymetry processing

object

Configuration structure for the 'Surface Fitting' algorithm; when provided the servers will fit a surface to the source photon cloud and return an elevation dataset similar to ATL06

atl03_bckgrd_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'bckgrd_atlas' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

atl03_corr_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geophys_corr' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

max_resources
integer <int32>
Default: 300

Maximum number of resources that can be processed in a single request; overriding this allows larger regions to be processed but risks crashing the servers

track
integer <int32>
Default: 0

Reference pair track number (1, 2, 3, or 0 to include for all three; defaults to 0) to process; note that when provided, this is combined with the beam selection as a union of the two

asset09
string <binary>
Default: "icesat2"

Asset identifier to use when reading wind speed from ATL09; when left blank the server will do the right thing

object

Configuration structure that controls performing and including an uncertainty calculation for each bathymetry photon

atl09_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the ATL09 granule to include in the response (e.g. low_rate/cal_c); supported by all x-series endpoints

object

Configuration structure for the 'Yet Another Photon Classifier' algorithm; when provided the servers will calculate a density score for each photon and include that score in the response data

resource
string <binary>

A single resource to process; 'resources' should be used instead, even when there is only one resource to process

atl03_ph_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'heights' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

object

Configuration for classifying bathymetry photons

resources
Array of strings <binary> [ items <binary > ]

A list of resources to process (e.g. granule names like 'ATL03_20181019065445_03150111_007_01.h5')

cluster_size_hint
integer <int32>
Default: 0

User supplied hint as to the number of nodes in the cluster; used to influence the way the processing is distributed across the cluster

object

Configuration structure for the 'PhoREAL' algorithm; when provided the servers will calculate canopy metrics on the source photon cloud and return those metrics as a dataset similar to ATL08

pass_invalid
boolean <bool>
Default: false

Boolean flag indicating whether or not extents that fail validation checks are still used and returned in the results

res
number <double>
Default: 20

Step (in meters) of the variable length segments; could also be thought of as the spacing of the segments or the resolution of the segments

min_geoid_delta
number <double>
Default: -100

Maximum negative vertical distance of photon from ATL03 geoid (sea level) to include in bathymetry processing

max_geoid_delta
number <double>
Default: 50

Maximum positive vertical distance of photon from ATL03 geoid (sea level) to include in bathymetry processing

proj
object <x-object>
Default: "auto"

Projection used when subsetting data; in most cases, do not specify and the code will do the right thing; options are ['auto', 'plate_carree', 'north_polar', 'south_polar']

cnt
integer <int32>
Default: 10

Minimum photon count in the variable length segment for the segment to be processed

ats
number <double>
Default: 20

Minimum along track spread of the photons (in meters) in the variable length segment for the segment to be processed

object

GeoJSON structure describing the area of interest; this causes the server to rasterize the supplied area and subset based on the rasterized image

object

Configuration structure that controls the calculation and inclusion of the sea surface height at each photon

atl03_geo_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'geolocation' group of the ATL03 granule to include in the response; supported by atl03x, fit, and phoreal

poly
Array of objects <x-object> [ items <x-object > ]

Polygon of area of interest, defined as a closed set of lat,lon pairs with counter-clockwise winding; in the form of [{'lat': , 'lon': }, ...]

node_timeout
integer <int32>
Default: 600

Maximum duration in seconds for each distributed processing node to finish processing its portion of a request

cnf
Array of integers <int32> = 7 items [ items <int32 > ]
Default: ["atl03_low","atl03_medium","atl03_high"]

Confidence level for photon selection, can be supplied as a single value (which means the confidence must be at least that), or a list (which means the confidence must be in the list); note - the confidence can be supplied as strings or as numbers {-2, -1, 0, 1, 2, 3, 4}; [atl03_tep,atl03_not_considered,atl03_background,atl03_within_10m,atl03_low,atl03_medium,atl03_high]

srt
integer <int32>
Default: "dynamic"

Surface reference type: 0-land, 1-ocean, 2-sea ice, 3-land ice, 4-inland water

key_space
integer <uint64>
Default: 18446744073709552000

Partitions a key space to a processing node; in general a user should not supply this value but rather let the system choose a value (which is the default)

generate_ndwi
boolean <bool>
Default: false

Boolean indicating that the server should calculate and include an NDWI value for each photon

atl08_class
Array of integers <int32> = 5 items [ items <int32 > ]
Default: []

List of ATL08 classifications used to select which photons are used in the processing; [atl08_noise,atl08_ground,atl08_canopy,atl08_top_of_canopy,atl08_unclassified]

read_timeout
integer <int32>
Default: 600

Maximum duration in seconds for an individual I/O read to complete

atl08_fields
Array of strings <binary> [ items <binary > ]

Ancillary fields in the 'land_segments' group of the ATL08 granule to include in the response; supported by atl03x, and phoreal

timeout
integer <int32>
Default: 600

Global setting for maximum duration in seconds for all timeouts associated with a request

rqst_timeout
integer <int32>
Default: 600

Maximum duration in seconds for a request to finish

object

Configuration structure that controls how the results are returned; typically used to write the output as a GeoParquet file

object

Configuration structure that controls performing refraction correction on the subaqueous bathymetry photons

use_bathy_mask
boolean <bool>
Default: true

Boolean controlling the use of the global bathymetry mask; if enabled all input granules will be subsetted to the bathymetry mask prior to any other subsetting

object

Versioning, ground track, and date information pulled from the granule processed; output only

dist_in_seg
boolean <bool>
Default: false

Boolean flag indicating that the units of the len and res are in ATL03 segments (e.g. if true then len=2 is exactly two ATL03 segments which is approximately 40 meters)

asset
string <binary>

The name of a collection of resources; this rarely needs to be specified because the default value for most endpoints are sufficient

podppd
integer <uint8>
Default: 1

Pointing/geolocation degradation mask; each bit in the mask represents a pointing/geolocation solution quality assessment to be included; the bits are 0: nominal, 1: pod_degrade, 2: ppd_degrade, 3: podppd_degrade, 4: cal_nominal, 5: cal_pod_degrade, 6: cal_ppd_degrade, 7: cal_podppd_degrade

datum
object <x-object>
Default: "unspecified"

Vertical datum to use when returning elevation data; not all endpoints support all datums; options are ['ITRF2014', 'ITRF2020', 'EGM08', 'NAVD88']

object

Configuration structure for the 'Surface Blanket' algorithm; when provided the servers will calculate a canopy top and ground using the source photon cloud and return those values in the response

len
number <double>
Default: 40

Size (in meters) of the variable length segment

spots
Array of integers <int32> = 6 items [ items <int32 > ]
Default: [1,2,3,4,5,6]

List of spots (1, 2, 3, 4, 5, 6) to process; this is only supported by the atl03x endpoint; [1,2,3,4,5,6]

ph_in_extent
integer <int32>
Default: 8192

Hard coded number of photons to include in the variable length segment; overrides 'len' and 'res' parameters

quality_ph
Array of integers <int32> = 26 items [ items <int32 > ]
Default: ["atl03_quality_nominal"]

Quality classification based on an ATL03 algorithms that attempt to identify instrumental artifacts, can be supplied as a single value (which means the classification must be exactly that), or a list (which means the classification must be in the list); [atl03_quality_nominal,atl03_quality_afterpulse,atl03_quality_impulse_response,atl03_quality_tep,atl03_quality_noise_burst,atl03_quality_noise_streak,atl03_quality_tx_part_sat,atl03_quality_tx_part_sat_afterpulse,atl03_quality_tx_part_sat_ir_effect,atl03_quality_tx_part_sat_burst,atl03_quality_tx_part_sat_streak,atl03_quality_tx_full_sat,atl03_quality_tx_full_sat_afterpulse,atl03_quality_tx_full_sat_ir_effect,atl03_quality_tx_full_sat_burst,atl03_quality_tx_full_sat_streak]

Responses

Request samples

Content type
application/json
{
  • "beams": [
    ],
  • "samples": {
    },
  • "min_dem_delta": -100,
  • "max_dem_delta": 50,
  • "fit": {
    },
  • "atl03_bckgrd_fields": [
    ],
  • "atl03_corr_fields": [
    ],
  • "max_resources": 300,
  • "track": 0,
  • "asset09": "icesat2",
  • "uncertainty": {
    },
  • "atl09_fields": [
    ],
  • "yapc": {
    },
  • "resource": "string",
  • "atl03_ph_fields": [
    ],
  • "atl24": {
    },
  • "resources": [
    ],
  • "cluster_size_hint": 0,
  • "phoreal": {
    },
  • "pass_invalid": false,
  • "res": 20,
  • "min_geoid_delta": -100,
  • "max_geoid_delta": 50,
  • "proj": "auto",
  • "cnt": 10,
  • "ats": 20,
  • "region_mask": {
    },
  • "surface": {
    },
  • "atl03_geo_fields": [
    ],
  • "poly": [
    ],
  • "node_timeout": 600,
  • "cnf": [
    ],
  • "srt": "dynamic",
  • "key_space": 18446744073709552000,
  • "generate_ndwi": false,
  • "atl08_class": [ ],
  • "read_timeout": 600,
  • "atl08_fields": [
    ],
  • "timeout": 600,
  • "rqst_timeout": 600,
  • "output": {
    },
  • "refraction": {
    },
  • "use_bathy_mask": true,
  • "granule": {
    },
  • "dist_in_seg": false,
  • "asset": "string",
  • "podppd": 1,
  • "datum": "unspecified",
  • "als": {
    },
  • "len": 40,
  • "spots": [
    ],
  • "ph_in_extent": 8192,
  • "quality_ph": [
    ]
}

Response samples

Content type
application/json
{
  • "total_photons": 0,
  • "photons_in_mask": 0,
  • "total_segments": 0,
  • "segments_in_mask": 0,
  • "total_errors": 0
}