PlanetaryComputerModelFactory.RegisterMosaic Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

PlanetaryComputerModelFactory.cs

Input parameters for registering a new mosaic of STAC items.

public static Azure.Analytics.PlanetaryComputer.RegisterMosaic RegisterMosaic(System.Collections.Generic.IEnumerable<string> collections = default, System.Collections.Generic.IEnumerable<string> ids = default, System.Collections.Generic.IEnumerable<float> boundingBox = default, Azure.Analytics.PlanetaryComputer.GeoJsonGeometry intersects = default, System.Collections.Generic.IDictionary<string,BinaryData> query = default, System.Collections.Generic.IDictionary<string,BinaryData> filter = default, string datetime = default, System.Collections.Generic.IEnumerable<Azure.Analytics.PlanetaryComputer.StacSortExtension> sortBy = default, Azure.Analytics.PlanetaryComputer.FilterLanguage? filterLanguage = default, Azure.Analytics.PlanetaryComputer.MosaicMetadata metadata = default);

static member RegisterMosaic : seq<string> * seq<string> * seq<single> * Azure.Analytics.PlanetaryComputer.GeoJsonGeometry * System.Collections.Generic.IDictionary<string, BinaryData> * System.Collections.Generic.IDictionary<string, BinaryData> * string * seq<Azure.Analytics.PlanetaryComputer.StacSortExtension> * Nullable<Azure.Analytics.PlanetaryComputer.FilterLanguage> * Azure.Analytics.PlanetaryComputer.MosaicMetadata -> Azure.Analytics.PlanetaryComputer.RegisterMosaic

Public Shared Function RegisterMosaic (Optional collections As IEnumerable(Of String) = Nothing, Optional ids As IEnumerable(Of String) = Nothing, Optional boundingBox As IEnumerable(Of Single) = Nothing, Optional intersects As GeoJsonGeometry = Nothing, Optional query As IDictionary(Of String, BinaryData) = Nothing, Optional filter As IDictionary(Of String, BinaryData) = Nothing, Optional datetime As String = Nothing, Optional sortBy As IEnumerable(Of StacSortExtension) = Nothing, Optional filterLanguage As Nullable(Of FilterLanguage) = Nothing, Optional metadata As MosaicMetadata = Nothing) As RegisterMosaic

Parameters

collections

IEnumerable<String>

List of STAC collection IDs to include in the mosaic.

ids

IEnumerable<String>

List of specific STAC item IDs to include in the mosaic.

boundingBox

IEnumerable<Single>

Geographic bounding box to filter items [west, south, east, north].

intersects

GeoJsonGeometry

GeoJSON geometry to spatially filter items by intersection.

query

IDictionary<String,BinaryData>

Query.

filter

IDictionary<String,BinaryData>

Filter.

datetime

String

Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples:

• A date-time: "2018-02-12T23:20:50Z"
• A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
• Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"

Only features that have a temporal property that intersects the value of `datetime` are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.

sortBy

IEnumerable<StacSortExtension>

Criteria for ordering items in the mosaic.

filterLanguage

Nullable<FilterLanguage>

Query language format used in the filter parameter.

metadata

MosaicMetadata

Additional metadata to associate with the mosaic.

Returns

RegisterMosaic

A new RegisterMosaic instance for mocking.