Processing templates in SDK

Overview

Run advanced processing on tasking and catalog data in your storage.

View repository

Class: JobTemplate

A class for job templates that define the process ID and input validation logic.

Attributes

Attribute Description

Attribute	Description
`process_id`	ClassVar[str] The process ID in a name format.
`workspace_id`	Union[str, base.WorkspaceId] The workspace ID.
`errors`	set[ValidationError] A list of errors populated if the job isn’t valid.

process_id

ClassVar[str]

The process ID in a name format.

workspace_id

Union[str, base.WorkspaceId]

The workspace ID.

errors

set[ValidationError]

A list of errors populated if the job isn’t valid.

Properties

is_valid

Checks if the job is valid. Returns bool:

True: The job is valid.
False: The job isn’t valid.

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
stac_client = up42.stac_client()
8
stac_item = next(stac_client.get_items(stac_item_id))
9

10
# Instanitate a TrueColorConversion template
11
job_template = processing_templates.TrueColorConversion(
12
  title="Imagery over UK",
13
  item=stac_item,
14
)
15

16
# Assert that the job is valid, print errors if not
17
if not job_template.is_valid:
18
  for error in job_template.errors:
19
    print(f"{error}\n")

Methods

execute

Executes the job. Returns Job.

Parameter	Description

1
from up42 import processing_templates
2

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

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

10
# Instanitate a TrueColorConversion template
11
job_template = processing_templates.TrueColorConversion(
12
  title="Imagery over UK",
13
  item=stac_item,
14
)
15

16
# Select a budget
17
budget_id = "a0d443a2-41e8-4995-8b54-a5cc4c448227"
18

19
# Execute the templated job
20
job = job_template.execute(budget_id=budget_id)
21

22
# Define output
23
print(f"Job details for ID: {job.id}")
24
print(f"Process ID:         {job.process_id}")
25
print(f"Status:             {job.status.value}")
26
print(f"Price:              {job.credits or 'N/A'} credits")
27
print(f"Created at:         {job.created}")

Class: SingleItemJobTemplate

A data class for the process templates that require one STAC item as input. Extends the JobTemplate class.

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 TrueColorConversion template
11
job_template = processing_templates.TrueColorConversion(
12
  title="Imagery over UK",
13
  item=stac_item,
14
)

Subclasses

Class name	Process ID	Process
`TrueColorConversion`	`true-color-conversion`	TrueColorConversion

Class: MultiItemJobTemplate

A data class for the process templates that require multiple STAC items as input. Extends the JobTemplate class.

Atributes

Attribute Description

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

title

str

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

items

List[pystac.Item]

The STAC items to process.

Class: SimularityJobTemplate

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

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
)

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

DetectionChangeSimularity

Has more attributes, see its class.

detection-change-simularity

Change detection

Class: DetectionChangeSimularity

A data class that represents a template for the Change detection 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 SingleItemJobTemplate class.

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

Recently selected

Recommended articles

Search results

No results found

Processing templates in SDK

View processes to run using the SDK.

Overview

Class: JobTemplate

Attributes

Properties

is_valid

Methods

execute

Class: SingleItemJobTemplate

Attributes

Subclasses

Class: MultiItemJobTemplate

Atributes

Class: SimularityJobTemplate

Attributes

Subclasses

Class: DetectionChangeSimularity

Attributes

Class: Pansharpening

Attributes

Class: GreyWeight

Attributes

Learn more