Processing templates in SDK

Overview

Apply advanced processing to purchased geospatial data.

Shared templates

Single-item processes

Single-item template classes represent processes that require a single STAC item. All single-item process template classes extend the SingleItemJobTemplate class.

Subclasses

Class name	Process ID	Process
`DetectionAircraftOI`	`detection-aircraft-oi`	Aircraft detection
`DetectionBuildingsSpacept`	`detection-buildings-spacept`	Building detection
`DetectionCarsOI`	`detection-cars-oi`	Car detection
`DetectionShadowsSpacept`	`detection-shadows-spacept`	Shadow detection
`DetectionShipsAirbus`	`detection-ships-airbus`	Ship detection
`DetectionStorageTanksAirbus`	`detection-storage-tanks-airbus`	Storage tank detection
`DetectionTreesSpacept`	`detection-trees-spacept`	Tree detection
`DetectionTrucksOI`	`detection-trucks-oi`	Truck detection
`DetectionWindTurbinesAirbus`	`detection-wind-turbines-airbus`	Wind turbine detection
`Pansharpening` Has more attributes, see its class.	`pansharpening`	Pansharpening
`UpsamplingNS`	`upsampling-ns`	Upsampling
`UpsamplingNSSentinel`	`upsampling-ns-sentinel`	Upsampling (Sentinel-2)

Attributes

Attribute Description

Attribute	Description
`title`	str The title of the output objects: STAC item and STAC collection.
`item`	pystac.Item The STAC item to process.

title

str

The title of the output objects: STAC item and STAC collection.

item

pystac.Item

The STAC item to process.

1
from up42 import processing_templates
2

3
# Select an item
4
stac_item_id = "68567134-27ad-7bd7-4b65-d61adb11fc78"
5

6
# Get the item from the STAC client
7
UP42_client = up42.stac_client()
8
stac_item = next(UP42_client.get_items(stac_item_id))
9

10
# Instanitate a DetectionTreesSpacept template
11
job_template = processing_templates.DetectionTreesSpacept(
12
  title="Detect trees over UK",
13
  item=stac_item,
14
)

Multi-item processes

These classes are deprecated and will be removed in 3.0.0. Use the DetectionChangeSimularity class.

Multi-item template classes represent processes that require more than one STAC item. All multi-item process template classes extend the MultiItemJobTemplate class.

Subclasses

Class name	Process ID	Process
`DetectionChangeSpacept`	`detection-change-spacept`	Change detection by Spacept
`DetectionChangePleiadesHyperverge`	`detection-change-pleiades-hyperverge`	Infrastructure change detection (Pléiades)
`DetectionChangeSPOTHyperverge`	`detection-change-spot-hyperverge`	Infrastructure change detection (SPOT)

Attributes

Attribute Description

Attribute	Description
`title`	str The title of the output objects: STAC item and STAC collection.
`item`	List[pystac.Item] The STAC items to process.

title

str

The title of the output objects: STAC item and STAC collection.

item

List[pystac.Item]

The STAC items to process.

1
from up42 import processing_templates
2

3
# Select multiple items
4
stac_item1_id = "68567134-27ad-7bd7-4b65-d61adb11fc78"
5
stac_item2_id = "c3de9ed8-f6e5-4bb5-a157-f6430ba756da"
6

7
# Get the items from the STAC client
8
UP42_client = up42.stac_client()
9
stac_item1 = next(UP42_client.get_items(stac_item1_id))
10
stac_item2 = next(UP42_client.get_items(stac_item2_id))
11

12
# Instantiate a DetectionChangeSpacept template
13
job_template = processing_templates.DetectionChangeSpacept(
14
  title="Detect changes",
15
  items=[stac_item1, stac_item2],
16
)

Class: SimularityJobTemplate

A data class that represents a template for the Simularity processes. Extends the JobTemplate class.

Subclasses

Class name Process ID Process

CoregistrationSimularity coregistration-simularity Coregistration

Class name	Process ID	Process
`CoregistrationSimularity`	`coregistration-simularity`	Coregistration
`DetectionChangeSimularity` Has more attributes, see its class.	`detection-change-simularity`	Change detection by Simularity

DetectionChangeSimularity

Has more attributes, see its class.

detection-change-simularity

Change detection by Simularity

Attributes

Attribute Description

Attribute	Description
`title`	str The title of the output objects: STAC item and STAC collection.
`source_item`	pystac.Item The source STAC item.
`reference_item`	pystac.Item The reference STAC item. The positional accuracy of the source image will be improved against this reference.

title

str

The title of the output objects: STAC item and STAC collection.

source_item

pystac.Item

The source STAC item.

reference_item

pystac.Item

The reference STAC item. The positional accuracy of the source image will be improved against this reference.

1
from up42 import processing_templates
2

3
# Select multiple items
4
source_item_id = "68567134-27ad-7bd7-4b65-d61adb11fc78"
5
reference_item_id = "c3de9ed8-f6e5-4bb5-a157-f6430ba756da"
6

7
# Get the items from the STAC client
8
UP42_client = up42.UP42_client()
9
source_item = UP42_client.get_item(source_item_id)
10
reference_item = UP42_client.get_item(reference_item_id)
11

12
# Instantiate a CoregistrationSimularity template
13
job_template = processing_templates.CoregistrationSimularity(
14
  title="Coregistration for images",
15
  source_item=source_item,
16
  reference_item=reference_item,
17
)

Class: DetectionChangeSimularity

A data class that represents a template for the Change detection by Simularity process. Extends the SimularityJobTemplate class.

Attributes

Attribute Description

Attribute	Description
`sensitivity`	int The setting that adjusts the sensitivity to change. The range of allowed values spans from `0` (lowest sensitivity) to `5` (highest sensitivity). The default value is `2`.

sensitivity

int

The setting that adjusts the sensitivity to change. The range of allowed values spans from 0 (lowest sensitivity) to 5 (highest sensitivity). The default value is 2.

1
from up42 import processing_templates
2

3
# Select multiple items
4
source_item_id = "68567134-27ad-7bd7-4b65-d61adb11fc78"
5
reference_item_id = "c3de9ed8-f6e5-4bb5-a157-f6430ba756da"
6

7
# Get the items from the STAC client
8
UP42_client = up42.UP42_client()
9
source_item = UP42_client.get_item(source_item_id)
10
reference_item = UP42_client.get_item(reference_item_id)
11

12
# Instantiate a DetectionChangeSimularity template
13
job_template = processing_templates.DetectionChangeSimularity(
14
  title="Detecting changes over Berlin",
15
  source_item=source_item,
16
  reference_item=reference_item,
17
  sensitivity=4,
18
)

Class: Pansharpening

A data class that represents a template for the Pansharpening process. Extends the class used for single-item processes.

Attributes

Attribute Description

Attribute	Description
`grey_weights`	Optional[List[GreyWeight]] The weight factors by which spatial details of multispectral bands are scaled.

grey_weights

Optional[List[GreyWeight]]

The weight factors by which spatial details of multispectral bands are scaled.

1
from up42 import processing_templates
2

3
# Select an item
4
stac_item_id = "68567134-27ad-7bd7-4b65-d61adb11fc78"
5

6
# Get the item from the STAC client
7
UP42_client = up42.stac_client()
8
stac_item = next(UP42_client.get_items(stac_item_id))
9

10
# Instantiate a Pansharpening template with grey weights
11
job_template = processing_templates.Pansharpening(
12
    title="Pansharpen item",
13
    item=stac_item,
14
    grey_weights=[
15
        processing_templates.GreyWeight(band="red", weight=0.04),
16
        processing_templates.GreyWeight(band="blue", weight=0.9),
17
        processing_templates.GreyWeight(band="green", weight=0.2),
18
    ],
19
)

Class: GreyWeight

A data class that represents the weight factors by which to scale spatial details of multispectral bands.

If not specified, the process uses either sensor-optimized weights or optimal generated weights.
If you specify the weights yourself, you must define at least 3 bands.

Attributes

Attribute Description

Attribute	Description
`band`	str The name of the band from the STAC asset with the `["data", "multispectral"]` roles.
`weight`	float The multiplication value that lets you modulate the influence of multispectral bands on the final image. The range of allowed values spans from `-1` to `1`.

band

str

The name of the band from the STAC asset with the ["data", "multispectral"] roles.

weight

float

The multiplication value that lets you modulate the influence of multispectral bands on the final image. The range of allowed values spans from -1 to 1.

1
from up42 import processing_templates
2

3
# Select an item
4
stac_item_id = "68567134-27ad-7bd7-4b65-d61adb11fc78"
5

6
# Get the item from the STAC client
7
UP42_client = up42.stac_client()
8
stac_item = next(UP42_client.get_items(stac_item_id))
9

10
# Instantiate a Pansharpening template with grey weights
11
job_template = processing_templates.Pansharpening(
12
    title="Pansharpen item",
13
    item=stac_item,
14
    grey_weights=[
15
        processing_templates.GreyWeight(band="red", weight=0.04),
16
        processing_templates.GreyWeight(band="blue", weight=0.9),
17
        processing_templates.GreyWeight(band="green", weight=0.2),
18
    ],
19
)

Learn more

API docs | Processing Console docs | Processing