airsmodel 0.5.14__py3-none-any.whl → 0.5.17__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of airsmodel might be problematic. Click here for more details.
- airs/core/models/model.py +316 -184
- airsmodel-0.5.17.dist-info/METADATA +16 -0
- airsmodel-0.5.17.dist-info/RECORD +7 -0
- airsmodel-0.5.14.dist-info/METADATA +0 -4408
- airsmodel-0.5.14.dist-info/RECORD +0 -7
- {airsmodel-0.5.14.dist-info → airsmodel-0.5.17.dist-info}/WHEEL +0 -0
- {airsmodel-0.5.14.dist-info → airsmodel-0.5.17.dist-info}/top_level.txt +0 -0
airs/core/models/model.py
CHANGED
|
@@ -1,9 +1,104 @@
|
|
|
1
1
|
from datetime import datetime as Datetime
|
|
2
2
|
from enum import Enum
|
|
3
|
-
from typing import Any, Dict, List
|
|
3
|
+
from typing import Annotated, Any, Dict, List, Literal
|
|
4
4
|
|
|
5
5
|
from pydantic import BaseModel, Extra, Field
|
|
6
6
|
|
|
7
|
+
EXPRESSION_DESCRIPTION = "The expression to create the desired band. " + \
|
|
8
|
+
"Can be a band of the data prefaced by its alias (ie 'S2.B05', " + \
|
|
9
|
+
"'S2.B12') or an operation on the bands (ie 'S2.B5 + S2.B8')."
|
|
10
|
+
UNIT_DESCRIPTION = "The unit of the requested band."
|
|
11
|
+
MIN_DESCRIPTION = "A minimum value to clip the band values."
|
|
12
|
+
MAX_DESCRIPTION = "A maximum value to clip the band values."
|
|
13
|
+
RGB_DESCRIPTION = "Which RGB channel the band is used for the preview. " + \
|
|
14
|
+
"Value can be 'RED', 'GREEN' or 'BLUE'."
|
|
15
|
+
CMAP_DESCRIPTION = "The matplotlib color map to use for the preview."
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class ColorMap(str, Enum):
|
|
19
|
+
viridis = "viridis"
|
|
20
|
+
plasma = "plasma"
|
|
21
|
+
inferno = "inferno"
|
|
22
|
+
magma = "magma"
|
|
23
|
+
cividis = "cividis"
|
|
24
|
+
Greys = "Greys"
|
|
25
|
+
Purples = "Purples"
|
|
26
|
+
Blues = "Blues"
|
|
27
|
+
Greens = "Greens"
|
|
28
|
+
Oranges = "Oranges"
|
|
29
|
+
Reds = "Reds"
|
|
30
|
+
YlOrBr = "YlOrBr"
|
|
31
|
+
YlOrRd = "YlOrRd"
|
|
32
|
+
OrRd = "OrRd"
|
|
33
|
+
PuRd = "PuRd"
|
|
34
|
+
RdPu = "RdPu"
|
|
35
|
+
BuPu = "BuPu"
|
|
36
|
+
GnBu = "GnBu"
|
|
37
|
+
PuBu = "PuBu"
|
|
38
|
+
YlGnBu = "YlGnBu"
|
|
39
|
+
PuBuGn = "PuBuGn"
|
|
40
|
+
BuGn = "BuGn"
|
|
41
|
+
YlGn = "YlGn"
|
|
42
|
+
binary = "binary"
|
|
43
|
+
gray = "gray"
|
|
44
|
+
bone = "bone"
|
|
45
|
+
spring = "spring"
|
|
46
|
+
summer = "summer"
|
|
47
|
+
autumn = "autumn"
|
|
48
|
+
winter = "winter"
|
|
49
|
+
cool = "cool"
|
|
50
|
+
hot = "hot"
|
|
51
|
+
rainbow = "rainbow"
|
|
52
|
+
gist_rainbow = "gist_rainbow"
|
|
53
|
+
ocean = "ocean"
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
class RGB(str, Enum):
|
|
57
|
+
RED = 'RED'
|
|
58
|
+
GREEN = 'GREEN'
|
|
59
|
+
BLUE = 'BLUE'
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
class ChunkingStrategy(str, Enum):
|
|
63
|
+
CARROT = 'carrot'
|
|
64
|
+
POTATO = 'potato'
|
|
65
|
+
SPINACH = 'spinach'
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
class SensorFamily(str, Enum):
|
|
69
|
+
OPTIC = "OPTIC"
|
|
70
|
+
RADAR = "RADAR"
|
|
71
|
+
MULTI = "MULTI"
|
|
72
|
+
UNKNOWN = "UNKNOWN"
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
class MimeType(Enum):
|
|
76
|
+
TIFF = "image/tiff"
|
|
77
|
+
XML = "text/xml"
|
|
78
|
+
JPG = "image/jpg"
|
|
79
|
+
PNG = "image/png"
|
|
80
|
+
GIF = "image/gif"
|
|
81
|
+
JSON = "application/json"
|
|
82
|
+
PDF = "application/pdf"
|
|
83
|
+
PVL = "text/pvl"
|
|
84
|
+
TEXT = "text/plain"
|
|
85
|
+
MARKDOWN = "text/markdown"
|
|
86
|
+
GML = "application/gml+xml"
|
|
87
|
+
COG = "image/tiff; application=geotiff; profile=cloud-optimized"
|
|
88
|
+
FLATGEOBUF = "application/vnd.flatgeobuf" # https://github.com/flatgeobuf/flatgeobuf/discussions/112#discussioncomment-4606721 # noqa
|
|
89
|
+
GEOJSON = "application/geo+json"
|
|
90
|
+
GEOPACKAGE = "application/geopackage+sqlite3"
|
|
91
|
+
GEOTIFF = "image/tiff; application=geotiff"
|
|
92
|
+
HDF = "application/x-hdf" # Hierarchical Data Format versions 4 and earlier.
|
|
93
|
+
HDF5 = "application/x-hdf5" # Hierarchical Data Format version 5
|
|
94
|
+
HTML = "text/html"
|
|
95
|
+
JPEG = "image/jpeg"
|
|
96
|
+
JPEG2000 = "image/jp2"
|
|
97
|
+
PARQUET = "application/x-parquet" # https://github.com/opengeospatial/geoparquet/issues/115#issuecomment-1181549523
|
|
98
|
+
KML = "application/vnd.google-earth.kml+xml"
|
|
99
|
+
ZARR = "application/vnd+zarr" # https://github.com/openMetadataInitiative/openMINDS_core/blob/v4/instances/data/contentTypes/zarr.jsonld
|
|
100
|
+
NETCDF = "application/netcdf" # https://github.com/Unidata/netcdf/issues/42#issuecomment-1007618822
|
|
101
|
+
|
|
7
102
|
|
|
8
103
|
class ProcessingLevel(Enum):
|
|
9
104
|
RAW = "RAW"
|
|
@@ -14,9 +109,11 @@ class ProcessingLevel(Enum):
|
|
|
14
109
|
|
|
15
110
|
|
|
16
111
|
class ObservationType(Enum):
|
|
112
|
+
optic = "OPTIC"
|
|
17
113
|
image = "IMAGE"
|
|
18
114
|
radar = "RADAR"
|
|
19
115
|
dem = "DEM"
|
|
116
|
+
other = "OTHER"
|
|
20
117
|
|
|
21
118
|
|
|
22
119
|
class ResourceType(Enum):
|
|
@@ -27,6 +124,7 @@ class ResourceType(Enum):
|
|
|
27
124
|
|
|
28
125
|
|
|
29
126
|
class ItemFormat(Enum):
|
|
127
|
+
adc3 = "adc3"
|
|
30
128
|
shape = "SHAPE"
|
|
31
129
|
dimap = "DIMAP"
|
|
32
130
|
geotiff = "GEOTIFF"
|
|
@@ -67,6 +165,7 @@ class AssetFormat(Enum):
|
|
|
67
165
|
geojson = "GEOJSON"
|
|
68
166
|
cog = "COG"
|
|
69
167
|
zarr = "ZARR"
|
|
168
|
+
gif = "GIF"
|
|
70
169
|
|
|
71
170
|
|
|
72
171
|
class Role(Enum):
|
|
@@ -130,214 +229,247 @@ class CommonBandName(Enum):
|
|
|
130
229
|
lwir12 = "lwir12"
|
|
131
230
|
|
|
132
231
|
|
|
133
|
-
class
|
|
134
|
-
data = "data"
|
|
135
|
-
auxiliary = "auxiliary"
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
class DimensionType(Enum):
|
|
232
|
+
class DimensionType(str, Enum):
|
|
139
233
|
spatial = "spatial"
|
|
140
234
|
temporal = "temporal"
|
|
141
235
|
geometry = "geometry"
|
|
142
236
|
|
|
143
237
|
|
|
144
|
-
class
|
|
145
|
-
|
|
146
|
-
|
|
238
|
+
class HorizontalSpatialDimension(BaseModel):
|
|
239
|
+
axis: str = Field()
|
|
240
|
+
description: str = Field()
|
|
241
|
+
type: Literal[DimensionType.spatial] = DimensionType.spatial.value
|
|
242
|
+
extent: list[float | int] = Field()
|
|
243
|
+
step: float | int | None = Field(default=None)
|
|
244
|
+
reference_system: str | int | Any = Field(default=4326)
|
|
245
|
+
|
|
147
246
|
|
|
247
|
+
class TemporalDimension(BaseModel):
|
|
248
|
+
axis: str = Field()
|
|
249
|
+
description: str = Field()
|
|
250
|
+
type: Literal[DimensionType.temporal] = DimensionType.temporal.value
|
|
251
|
+
extent: list[str] | None = Field(default=None)
|
|
252
|
+
step: str | None = Field(default=None)
|
|
148
253
|
|
|
149
|
-
class Raster(BaseModel):
|
|
150
|
-
type: RasterType
|
|
151
|
-
path: str
|
|
152
|
-
id: str
|
|
153
254
|
|
|
255
|
+
Dimension = Annotated[HorizontalSpatialDimension | TemporalDimension,
|
|
256
|
+
Field(discriminator="type")]
|
|
154
257
|
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
258
|
+
|
|
259
|
+
class VariableType(str, Enum):
|
|
260
|
+
data = "data"
|
|
261
|
+
auxiliary = "auxiliary"
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
class Variable(BaseModel):
|
|
265
|
+
dimensions: list[str] = Field()
|
|
266
|
+
type: VariableType = Field()
|
|
267
|
+
description: str | None = Field(default=None)
|
|
268
|
+
extent: list[float | int | str] = Field()
|
|
269
|
+
unit: str | None = Field(default=None)
|
|
270
|
+
expression: str = Field()
|
|
160
271
|
|
|
161
272
|
|
|
162
273
|
class Indicators(BaseModel):
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
274
|
+
dc3__time_compacity: float = Field(default=None, title="[ARLAS, extension dc3] Indicates whether the temporal extent of the temporal slices (groups) are compact or not compared to the cube temporal extent. Computed as follow: 1-range(group rasters) / range(cube rasters).")
|
|
275
|
+
dc3__spatial_coverage: float = Field(default=None, title="[ARLAS, extension dc3] Indicates the proportion of the region of interest that is covered by the input rasters. Computed as follow: area(intersection(union(rasters),roi)) / area(roi))")
|
|
276
|
+
dc3__group_lightness: float = Field(default=None, title="[ARLAS, extension dc3] Indicates the proportion of non overlapping regions between the different input rasters. Computed as follow: area(intersection(union(rasters),roi)) / sum(area(intersection(raster, roi)))")
|
|
277
|
+
dc3__time_regularity: float = Field(default=None, title="[ARLAS, extension dc3] Indicates the regularity of the extents between the temporal slices (groups). Computed as follow: 1-std(inter group temporal gaps)/avg(inter group temporal gaps)")
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
class ItemReference(BaseModel):
|
|
281
|
+
dc3__collection: str = Field(description="[ARLAS, extension dc3] Name of the collection containing the item")
|
|
282
|
+
dc3__id: str = Field(description="[ARLAS, extension dc3] Item's identifer")
|
|
283
|
+
dc3__alias: str = Field(description="[ARLAS, extension dc3] Product alias (e.g. s2_l2)")
|
|
167
284
|
|
|
168
285
|
|
|
169
|
-
class
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
286
|
+
class ItemGroup(BaseModel):
|
|
287
|
+
dc3__references: list[ItemReference] = Field(title="[ARLAS, extension dc3] The rasters of this group.", min_length=1)
|
|
288
|
+
dc3__datetime: Datetime = Field(title="[ARLAS, extension dc3] The date time of this temporal group.")
|
|
289
|
+
dc3__quality_indicators: Indicators | None = Field(default=None, title="[ARLAS, extension dc3] Set of indicators for estimating the quality of the datacube group. The indicators are group based.")
|
|
173
290
|
|
|
174
291
|
|
|
175
292
|
class Band(BaseModel, extra=Extra.allow):
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
293
|
+
index: int = Field(default=None, ge=1, title="[ARLAS] Band index within the asset, starting at 1")
|
|
294
|
+
asset: str = Field(default=None, title="[ARLAS] Name of the asset, must be present in `item.assets`")
|
|
295
|
+
path_within_asset: str = Field(default=None, title="[ARLAS] If the band is nested within a sub file of the asset (e.g. tgz, zip), then the path within the asset must be provided, undefined otherwise.")
|
|
296
|
+
variable_value_alias: dict[float, str] = Field(default=None, title="[ARLAS] Dictionary of value->alias for bands encoding semantic tags (e.g land cover classification)")
|
|
297
|
+
name: str = Field(title="[STAC] The name of the band (e.g., B01, B8, band2, red).", max_length=300)
|
|
298
|
+
eo__common_name: str = Field(default=None, title="[STAC, extension eo] The name commonly used to refer to the band to make it easier to search for bands across instruments. See the list of accepted common names.")
|
|
299
|
+
description: str = Field(default=None, title="[STAC] Description to fully explain the band. CommonMark 0.29 syntax MAY be used for rich text representation.", max_length=300)
|
|
300
|
+
eo__center_wavelength: float = Field(default=None, title="[STAC, extension eo] The center wavelength of the band, in micrometers (μm).")
|
|
301
|
+
eo__full_width_half_max: float = Field(default=None, title="[STAC, extension eo] Full width at half maximum (FWHM). The width of the band, as measured at half the maximum transmission, in micrometers (μm).")
|
|
302
|
+
eo__solar_illumination: float = Field(default=None, title="[STAC, extension eo] The solar illumination of the band, as measured at half the maximum transmission, in W/m2/micrometers.")
|
|
303
|
+
dc3__quality_indicators: Indicators = Field(default=None, title="[ARLAS, extension dc3] Set of indicators for estimating the quality of the datacube variable (band).")
|
|
304
|
+
dc3__expression: str = Field(default=None, description=EXPRESSION_DESCRIPTION)
|
|
305
|
+
dc3__unit: str = Field(default=None, description=UNIT_DESCRIPTION)
|
|
306
|
+
dc3__min: float = Field(default=None, description=MIN_DESCRIPTION)
|
|
307
|
+
dc3__max: float = Field(default=None, description=MAX_DESCRIPTION)
|
|
308
|
+
dc3__rgb: RGB | None = Field(default=None, description=RGB_DESCRIPTION)
|
|
309
|
+
dc3__cmap: ColorMap | None = Field(default=None, description=CMAP_DESCRIPTION)
|
|
183
310
|
|
|
184
311
|
|
|
185
312
|
class Asset(BaseModel, extra=Extra.allow):
|
|
186
|
-
name: str | None = Field(default=None, title="Asset's name.
|
|
187
|
-
size: int | None = Field(default=None, title="Asset's size in Bytes.")
|
|
188
|
-
href: str | None = Field(default=None, title="Absolute link to the asset object.")
|
|
189
|
-
asset_type: str | None = Field(default=None, title="Type of data (ResourceType)")
|
|
190
|
-
asset_format: str | None = Field(default=None, title="Data format (AssetFormat)")
|
|
191
|
-
storage__requester_pays: bool | None = Field(default=None, title="Is the data requester pays or is it data manager/cloud provider pays. Defaults to false. Whether the requester pays for accessing assets")
|
|
192
|
-
storage__tier: str | None = Field(default=None, title="Cloud Provider Storage Tiers (Standard, Glacier, etc.)")
|
|
193
|
-
storage__platform: str | None = Field(default=None, title="PaaS solutions (ALIBABA, AWS, AZURE, GCP, IBM, ORACLE, OTHER)")
|
|
194
|
-
storage__region: str | None = Field(default=None, title="The region where the data is stored. Relevant to speed of access and inter region egress costs (as defined by PaaS provider)")
|
|
195
|
-
airs__managed: bool | None = Field(default=True, title="Whether the asset is managed by AIRS or not.")
|
|
196
|
-
airs__object_store_bucket: str | None = Field(default=None, title="Object store bucket for the asset object.")
|
|
197
|
-
airs__object_store_key: str | None = Field(default=None, title="Object store key of the asset object.")
|
|
198
|
-
title: str | None = Field(default=None, title="Optional displayed title for clients and users.", max_length=300)
|
|
199
|
-
description: str | None = Field(default=None, title="A description of the Asset providing additional details, such as how it was processed or created. CommonMark 0.29 syntax MAY be used for rich text representation.", max_length=300)
|
|
200
|
-
type: str | None = Field(default=None, title="Optional description of the media type. Registered Media Types are preferred. See MediaType for common media types.", max_length=300)
|
|
201
|
-
roles: List[str] | None = Field(default=None, title="Optional, Semantic roles (i.e. thumbnail, overview, data, metadata) of the asset.", max_length=300)
|
|
202
|
-
extra_fields: Dict[str, Any] | None = Field(default=None, title="Optional, additional fields for this asset. This is used by extensions as a way to serialize and deserialize properties on asset object JSON.")
|
|
203
|
-
gsd: float | None = Field(default=None, title="Ground Sampling Distance (resolution) of the asset")
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
313
|
+
name: str | None = Field(default=None, title="[ARLAS] Asset's name. Must be the same as the key in the `assets` dictionary.", max_length=300)
|
|
314
|
+
size: int | None = Field(default=None, title="[ARLAS] Asset's size in Bytes.")
|
|
315
|
+
href: str | None = Field(default=None, title="[STAC] Absolute link to the asset object.")
|
|
316
|
+
asset_type: str | None = Field(default=None, title="[ARLAS] Type of data (ResourceType)")
|
|
317
|
+
asset_format: str | None = Field(default=None, title="[ARLAS] Data format (AssetFormat)")
|
|
318
|
+
storage__requester_pays: bool | None = Field(default=None, title="[STAC, extension storage]Is the data requester pays or is it data manager/cloud provider pays. Defaults to false. Whether the requester pays for accessing assets")
|
|
319
|
+
storage__tier: str | None = Field(default=None, title="[STAC, extension storage]Cloud Provider Storage Tiers (Standard, Glacier, etc.)")
|
|
320
|
+
storage__platform: str | None = Field(default=None, title="[STAC, extension storage]PaaS solutions (ALIBABA, AWS, AZURE, GCP, IBM, ORACLE, OTHER)")
|
|
321
|
+
storage__region: str | None = Field(default=None, title="[STAC, extension storage]The region where the data is stored. Relevant to speed of access and inter region egress costs (as defined by PaaS provider)")
|
|
322
|
+
airs__managed: bool | None = Field(default=True, title="[ARLAS, extension AIRS] Whether the asset is managed by AIRS or not.")
|
|
323
|
+
airs__object_store_bucket: str | None = Field(default=None, title="[ARLAS, extension AIRS] Object store bucket for the asset object.")
|
|
324
|
+
airs__object_store_key: str | None = Field(default=None, title="[ARLAS, extension AIRS] Object store key of the asset object.")
|
|
325
|
+
title: str | None = Field(default=None, title="[STAC] Optional displayed title for clients and users.", max_length=300)
|
|
326
|
+
description: str | None = Field(default=None, title="[STAC] A description of the Asset providing additional details, such as how it was processed or created. CommonMark 0.29 syntax MAY be used for rich text representation.", max_length=300)
|
|
327
|
+
type: str | None = Field(default=None, title="[STAC] Optional description of the media type. Registered Media Types are preferred. See MediaType for common media types.", max_length=300)
|
|
328
|
+
roles: List[str] | None = Field(default=None, title="[STAC] Optional, Semantic roles (i.e. thumbnail, overview, data, metadata) of the asset.", min_length=1, max_length=300)
|
|
329
|
+
extra_fields: Dict[str, Any] | None = Field(default=None, title="[ARLAS] Optional, additional fields for this asset. This is used by extensions as a way to serialize and deserialize properties on asset object JSON.")
|
|
330
|
+
gsd: float | None = Field(default=None, title="[deprecated, use eo:gsd instead] Ground Sampling Distance (resolution) of the asset")
|
|
331
|
+
eo__gsd: float | None = Field(default=None, title="[STAC, extension eo] Ground Sampling Distance (resolution)")
|
|
332
|
+
eo__bands: List[Band] | None = Field(default=None, title="[STAC, extension eo] An array of available bands where each object is a Band Object. If given, requires at least one band.", )
|
|
333
|
+
sar__instrument_mode: str | None = Field(default=None, title="[STAC, extension sar] The name of the sensor acquisition mode that is commonly used. This should be the short name, if available. For example, WV for \"Wave mode\" of Sentinel-1 and Envisat ASAR satellites.")
|
|
334
|
+
sar__frequency_band: str | None = Field(default=None, title="[STAC, extension sar] The common name for the frequency band to make it easier to search for bands across instruments. See section \"Common Frequency Band Names\" for a list of accepted names.")
|
|
335
|
+
sar__center_frequency: float | None = Field(default=None, title="[STAC, extension sar] The center frequency of the instrument, in gigahertz (GHz).")
|
|
336
|
+
sar__polarizations: str | None = Field(default=None, title="[STAC, extension sar] Any combination of polarizations.")
|
|
337
|
+
sar__product_type: str | None = Field(default=None, title="[STAC, extension sar] The product type, for example SSC, MGD, or SGC")
|
|
338
|
+
sar__resolution_range: float | None = Field(default=None, title="[STAC, extension sar] The range resolution, which is the maximum ability to distinguish two adjacent targets perpendicular to the flight path, in meters (m).")
|
|
339
|
+
sar__resolution_azimuth: float | None = Field(default=None, title="[STAC, extension sar] The azimuth resolution, which is the maximum ability to distinguish two adjacent targets parallel to the flight path, in meters (m).")
|
|
340
|
+
sar__pixel_spacing_range: float | None = Field(default=None, title="[STAC, extension sar] The range pixel spacing, which is the distance between adjacent pixels perpendicular to the flight path, in meters (m). Strongly RECOMMENDED to be specified for products of type GRD.")
|
|
341
|
+
sar__pixel_spacing_azimuth: float | None = Field(default=None, title="[STAC, extension sar] The azimuth pixel spacing, which is the distance between adjacent pixels parallel to the flight path, in meters (m). Strongly RECOMMENDED to be specified for products of type GRD.")
|
|
342
|
+
sar__looks_range: float | None = Field(default=None, title="[STAC, extension sar] Number of range looks, which is the number of groups of signal samples (looks) perpendicular to the flight path.")
|
|
343
|
+
sar__looks_azimuth: float | None = Field(default=None, title="[STAC, extension sar] Number of azimuth looks, which is the number of groups of signal samples (looks) parallel to the flight path.")
|
|
344
|
+
sar__looks_equivalent_number: float | None = Field(default=None, title="[STAC, extension sar] The equivalent number of looks (ENL).")
|
|
345
|
+
sar__observation_direction: str | None = Field(default=None, title="[STAC, extension sar] Antenna pointing direction relative to the flight trajectory of the satellite, either left or right.")
|
|
346
|
+
proj__epsg: int | None = Field(default=None, title="[STAC, extension proj] EPSG code of the datasource.")
|
|
347
|
+
proj__wkt2: str | None = Field(default=None, title="[STAC, extension proj] PROJJSON object representing the Coordinate Reference System (CRS) that the proj:geometry and proj:bbox fields represent.")
|
|
348
|
+
proj__geometry: Any | None = Field(default=None, title="[STAC, extension proj] Defines the footprint of this Item.")
|
|
349
|
+
proj__bbox: List[float] | None = Field(default=None, title="[STAC, extension proj] Bounding box of the Item in the asset CRS in 2 or 3 dimensions.")
|
|
350
|
+
proj__centroid: Any | None = Field(default=None, title="[STAC, extension proj] Coordinates representing the centroid of the Item (in lat/long).")
|
|
351
|
+
proj__shape: List[float] | None = Field(default=None, title="[STAC, extension proj] Number of pixels in Y and X directions for the default grid.")
|
|
352
|
+
proj__transform: List[float] | None = Field(default=None, title="[STAC, extension proj] The affine transformation coefficients for the default grid.")
|
|
225
353
|
|
|
226
354
|
|
|
227
355
|
class Properties(BaseModel, extra=Extra.allow):
|
|
228
|
-
datetime: Datetime | None = Field(default=None, title="datetime associated with this item. If None, a start_datetime and end_datetime must be supplied.")
|
|
229
|
-
start_datetime: Datetime | None = Field(default=None, title="Optional start datetime, part of common metadata. This value will override any start_datetime key in properties.")
|
|
230
|
-
end_datetime: Datetime | None = Field(default=None, title="Optional end datetime, part of common metadata. This value will override any end_datetime key in properties.")
|
|
231
|
-
keywords: List[str] | None = Field(default=None, title="A list of keywords")
|
|
232
|
-
programme: str | None = Field(default=None, title="Name of the programme")
|
|
233
|
-
constellation: str | None = Field(default=None, title="Name of the constellation")
|
|
234
|
-
satellite: str | None = Field(default=None, title="Name of the satellite")
|
|
235
|
-
platform: str | None = Field(default=None, title="Name of the satellite platform")
|
|
236
|
-
instrument: str | None = Field(default=None, title="Name of the instrument")
|
|
237
|
-
sensor: str | None = Field(default=None, title="Name of the sensor")
|
|
238
|
-
sensor_mode: str | None = Field(default=None, title="Mode of the sensor during acquisition")
|
|
239
|
-
sensor_type: str | None = Field(default=None, title="Type of sensor")
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
356
|
+
datetime: Datetime | None = Field(default=None, title="[STAC] datetime associated with this item. If None, a start_datetime and end_datetime must be supplied.")
|
|
357
|
+
start_datetime: Datetime | None = Field(default=None, title="[STAC] Optional start datetime, part of common metadata. This value will override any start_datetime key in properties.")
|
|
358
|
+
end_datetime: Datetime | None = Field(default=None, title="[STAC] Optional end datetime, part of common metadata. This value will override any end_datetime key in properties.")
|
|
359
|
+
keywords: List[str] | None = Field(default=None, title="STAC] A list of keywords")
|
|
360
|
+
programme: str | None = Field(default=None, title="[ARLAS] Name of the programme")
|
|
361
|
+
constellation: str | None = Field(default=None, title="[ARLAS] Name of the constellation")
|
|
362
|
+
satellite: str | None = Field(default=None, title="[ARLAS] Name of the satellite")
|
|
363
|
+
platform: str | None = Field(default=None, title="[ARLAS] Name of the satellite platform")
|
|
364
|
+
instrument: str | None = Field(default=None, title="[ARLAS] Name of the instrument")
|
|
365
|
+
sensor: str | None = Field(default=None, title="[ARLAS] Name of the sensor")
|
|
366
|
+
sensor_mode: str | None = Field(default=None, title="[ARLAS] Mode of the sensor during acquisition")
|
|
367
|
+
sensor_type: str | None = Field(default=None, title="[ARLAS] Type of sensor")
|
|
368
|
+
license: str | None = Field(default=None, title="[STAC] License(s) of the data as SPDX License identifier, SPDX License expression, or other.")
|
|
369
|
+
annotations: str | None = Field(default=None, title="[ARLAS] Human annotations for the item")
|
|
370
|
+
gsd: float | None = Field(default=None, title="[deprecated, use eo:gsd instead] Ground Sampling Distance (resolution)")
|
|
371
|
+
secondary_id: str | None = Field(default=None, title="[ARLAS] Secondary identifier")
|
|
372
|
+
data_type: str | None = Field(default=None, title="[ARLAS] Type of data")
|
|
373
|
+
item_type: str | None = Field(default=None, title="[ARLAS] Type of data (ResourceType)")
|
|
374
|
+
item_format: str | None = Field(default=None, title="[ARLAS] Data format (ItemFormat)")
|
|
375
|
+
main_asset_format: str | None = Field(default=None, title="[ARLAS] Data format of the main asset (AssetFormat)")
|
|
376
|
+
main_asset_name: str | None = Field(default=None, title="[ARLAS] Name of the main asset (AssetFormat)")
|
|
377
|
+
observation_type: str | None = Field(default=None, title="[ARLAS] Type of observation (ObservationType)")
|
|
378
|
+
data_coverage: float | None = Field(default=None, title="[ARLAS] Estimate of data cover")
|
|
379
|
+
water_coverage: float | None = Field(default=None, title="[ARLAS] Estimate of water cover")
|
|
380
|
+
locations: List[str] | None = Field(default=None, title="[ARLAS] List of locations covered by the item")
|
|
381
|
+
create_datetime: int | None = Field(default=None, title="[ARLAS, AIRS]Date of item creation in the catalog, managed by the ARLAS Item Registration Service")
|
|
382
|
+
update_datetime: int | None = Field(default=None, title="[ARLAS, AIRS]Update date of the item in the catalog, managed by the ARLAS Item Registration Service")
|
|
383
|
+
created: int | None = Field(default=None, title="[STAC] Creation date and time of the corresponding STAC entity or Asset (see below), in UTC.")
|
|
384
|
+
updated: int | None = Field(default=None, title="[STAC] Date and time the corresponding STAC entity or Asset (see below) was updated last, in UTC.")
|
|
385
|
+
view__off_nadir: float | None = Field(default=None, title="[STAC, extension view] The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).")
|
|
386
|
+
view__incidence_angle: float | None = Field(default=None, title="[STAC, extension view] The incidence angle is the angle between the vertical (normal) to the intercepting surface and the line of sight back to the satellite at the scene center. Measured in degrees (0-90).")
|
|
387
|
+
view__azimuth: float | None = Field(default=None, title="[STAC, extension view] Viewing azimuth angle. The angle measured from the sub-satellite point (point on the ground below the platform) between the scene center and true north. Measured clockwise from north in degrees (0-360).")
|
|
388
|
+
view__sun_azimuth: float | None = Field(default=None, title="[STAC, extension view] Sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).")
|
|
389
|
+
view__sun_elevation: float | None = Field(default=None, title="[STAC, extension view] Sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90). Negative values indicate the sun is below the horizon, e.g. sun elevation of -10° means the data was captured during nautical twilight.")
|
|
390
|
+
storage__requester_pays: bool | None = Field(default=None, title="[STAC, extension storage] Is the data requester pays or is it data manager/cloud provider pays. Defaults to false. Whether the requester pays for accessing assets")
|
|
391
|
+
storage__tier: str | None = Field(default=None, title="[STAC, extension storage] Cloud Provider Storage Tiers (Standard, Glacier, etc.)")
|
|
392
|
+
storage__platform: str | None = Field(default=None, title="[STAC, extension storage] PaaS solutions (ALIBABA, AWS, AZURE, GCP, IBM, ORACLE, OTHER)")
|
|
393
|
+
storage__region: str | None = Field(default=None, title="[STAC, extension storage] The region where the data is stored. Relevant to speed of access and inter region egress costs (as defined by PaaS provider)")
|
|
394
|
+
eo__cloud_cover: float | None = Field(default=None, title="[STAC, extension eo] Estimate of cloud cover.")
|
|
395
|
+
eo__snow_cover: float | None = Field(default=None, title="[STAC, extension eo] Estimate of snow and ice cover.")
|
|
396
|
+
eo__bands: List[Band] | None = Field(default=None, title="[STAC, extension eo] An array of available bands where each object is a Band Object. If given, requires at least one band.")
|
|
397
|
+
processing__expression: str | None = Field(default=None, title="[STAC, extension processing] An expression or processing chain that describes how the data has been processed. Alternatively, you can also link to a processing chain with the relation type processing-expression (see below).")
|
|
398
|
+
processing__lineage: str | None = Field(default=None, title="[STAC, extension processing] Lineage Information provided as free text information about the how observations were processed or models that were used to create the resource being described NASA ISO.")
|
|
399
|
+
processing__level: str | None = Field(default=None, title="[STAC, extension processing] The name commonly used to refer to the processing level to make it easier to search for product level across collections or items. The short name must be used (only L, not Level).")
|
|
400
|
+
processing__facility: str | None = Field(default=None, title="[STAC, extension processing] The name of the facility that produced the data. For example, Copernicus S1 Core Ground Segment - DPA for product of Sentinel-1 satellites.")
|
|
401
|
+
processing__software: Dict[str, str] | None = Field(default=None, title="[STAC, extension processing] A dictionary with name/version for key/value describing one or more softwares that produced the data.")
|
|
402
|
+
dc3__quality_indicators: Indicators | None = Field(default=None, title="[STAC, extension dc3] Set of indicators for estimating the quality of the datacube based on the composition. The indicators are group based. A cube indicator is the product of its corresponding group indicator.")
|
|
403
|
+
dc3__composition: List[ItemGroup] | None = Field(default=None, title="[STAC, extension dc3] List of item groups used for elaborating the cube temporal slices.")
|
|
404
|
+
dc3__number_of_chunks: int | None = Field(default=None, title="[STAC, extension dc3] Number of chunks (if zarr or similar partitioned format) within the cube.")
|
|
405
|
+
dc3__chunk_weight: int | None = Field(default=None, title="[STAC, extension dc3] Weight of a chunk (number of bytes).")
|
|
406
|
+
dc3__fill_ratio: float | None = Field(default=None, title="[STAC, extension dc3] 1: the cube is full, 0 the cube is empty, in between the cube is partially filled.")
|
|
407
|
+
dc3__overview: dict[str, str] | dict[RGB, str] | None = Field(default=None, title="[STAC, extension dc3] Parameters used to generate the preview. Either contains the matplotlib colormap and the band used, or the mapping between RGB bands and the datacube's bands used.")
|
|
408
|
+
cube__dimensions: Dict[str, Dimension] | None = Field(default=None, title="[STAC, extension cube] Uniquely named dimensions of the datacube.")
|
|
409
|
+
cube__variables: Dict[str, Variable] | None = Field(default=None, title="[STAC, extension cube] Uniquely named variables of the datacube.")
|
|
410
|
+
acq__acquisition_mode: str | None = Field(default=None, title="[STAC, extension acq] The name of the acquisition mode.")
|
|
411
|
+
acq__acquisition_orbit_direction: str | None = Field(default=None, title="[STAC, extension acq] Acquisition orbit direction (ASCENDING or DESCENDING).")
|
|
412
|
+
acq__acquisition_type: str | None = Field(default=None, title="[STAC, extension acq] Acquisition type (STRIP)")
|
|
413
|
+
acq__acquisition_orbit: float | None = Field(default=None, title="[STAC, extension acq] Acquisition orbit")
|
|
414
|
+
acq__across_track: float | None = Field(default=None, title="[STAC, extension acq] Across track angle")
|
|
415
|
+
acq__along_track: float | None = Field(default=None, title="[STAC, extension acq] Along track angle")
|
|
416
|
+
acq__archiving_date: Datetime | None = Field(default=None, title="[STAC, extension acq] Archiving date")
|
|
417
|
+
acq__download_orbit: float | None = Field(default=None, title="[STAC, extension acq] Download orbit")
|
|
418
|
+
acq__request_id: str | None = Field(default=None, title="[STAC, extension acq] Original request identifier")
|
|
419
|
+
acq__quality_average: float | None = Field(default=None, title="[STAC, extension acq] Quality average")
|
|
420
|
+
acq__quality_computation: str | None = Field(default=None, title="[STAC, extension acq] Quality computation")
|
|
421
|
+
acq__receiving_station: str | None = Field(default=None, title="[STAC, extension acq] Receiving station")
|
|
422
|
+
acq__reception_date: Datetime | None = Field(default=None, title="[STAC, extension acq] Reception date")
|
|
423
|
+
acq__spectral_mode: str | None = Field(default=None, title="[STAC, extension acq] Spectral mode")
|
|
424
|
+
sar__instrument_mode: str | None = Field(default=None, title="[STAC, extension sar] The name of the sensor acquisition mode that is commonly used. This should be the short name, if available. For example, WV for \"Wave mode\" of Sentinel-1 and Envisat ASAR satellites.")
|
|
425
|
+
sar__frequency_band: str | None = Field(default=None, title="[STAC, extension sar] The common name for the frequency band to make it easier to search for bands across instruments. See section \"Common Frequency Band Names\" for a list of accepted names.")
|
|
426
|
+
sar__center_frequency: float | None = Field(default=None, title="[STAC, extension sar] The center frequency of the instrument, in gigahertz (GHz).")
|
|
427
|
+
sar__polarizations: str | None = Field(default=None, title="[STAC, extension sar] Any combination of polarizations.")
|
|
428
|
+
sar__product_type: str | None = Field(default=None, title="[STAC, extension sar] The product type, for example SSC, MGD, or SGC")
|
|
429
|
+
sar__resolution_range: float | None = Field(default=None, title="[STAC, extension sar] The range resolution, which is the maximum ability to distinguish two adjacent targets perpendicular to the flight path, in meters (m).")
|
|
430
|
+
sar__resolution_azimuth: float | None = Field(default=None, title="[STAC, extension sar] The azimuth resolution, which is the maximum ability to distinguish two adjacent targets parallel to the flight path, in meters (m).")
|
|
431
|
+
sar__pixel_spacing_range: float | None = Field(default=None, title="[STAC, extension sar] The range pixel spacing, which is the distance between adjacent pixels perpendicular to the flight path, in meters (m). Strongly RECOMMENDED to be specified for products of type GRD.")
|
|
432
|
+
sar__pixel_spacing_azimuth: float | None = Field(default=None, title="[STAC, extension sar] The azimuth pixel spacing, which is the distance between adjacent pixels parallel to the flight path, in meters (m). Strongly RECOMMENDED to be specified for products of type GRD.")
|
|
433
|
+
sar__looks_range: float | None = Field(default=None, title="[STAC, extension sar] Number of range looks, which is the number of groups of signal samples (looks) perpendicular to the flight path.")
|
|
434
|
+
sar__looks_azimuth: float | None = Field(default=None, title="[STAC, extension sar] Number of azimuth looks, which is the number of groups of signal samples (looks) parallel to the flight path.")
|
|
435
|
+
sar__looks_equivalent_number: float | None = Field(default=None, title="[STAC, extension sar] The equivalent number of looks (ENL).")
|
|
436
|
+
sar__observation_direction: str | None = Field(default=None, title="[STAC, extension sar] Antenna pointing direction relative to the flight trajectory of the satellite, either left or right.")
|
|
437
|
+
proj__epsg: int | None = Field(default=None, title="[STAC, extension proj] EPSG code of the datasource.")
|
|
438
|
+
proj__wkt2: str | None = Field(default=None, title="[STAC, extension proj] PROJJSON object representing the Coordinate Reference System (CRS) that the proj:geometry and proj:bbox fields represent.")
|
|
439
|
+
proj__geometry: Any | None = Field(default=None, title="[STAC, extension proj] Defines the footprint of this Item.")
|
|
440
|
+
proj__bbox: List[float] | None = Field(default=None, title="[STAC, extension proj] Bounding box of the Item in the asset CRS in 2 or 3 dimensions.")
|
|
441
|
+
proj__centroid: Any | None = Field(default=None, title="[STAC, extension proj] Coordinates representing the centroid of the Item (in lat/long).")
|
|
442
|
+
proj__shape: List[float] | None = Field(default=None, title="[STAC, extension proj] Number of pixels in Y and X directions for the default grid.")
|
|
443
|
+
proj__transform: List[float] | None = Field(default=None, title="[STAC, extension proj] The affine transformation coefficients for the default grid.")
|
|
444
|
+
generated__has_overview: bool | None = Field(default=False, title="[ARLAS, AIRS] Whether the item has an overview or not.")
|
|
445
|
+
generated__has_thumbnail: bool | None = Field(default=False, title="[ARLAS, AIRS] Whether the item has a thumbnail or not.")
|
|
446
|
+
generated__has_metadata: bool | None = Field(default=False, title="[ARLAS, AIRS] Whether the item has a metadata file or not.")
|
|
447
|
+
generated__has_data: bool | None = Field(default=False, title="[ARLAS, AIRS] Whether the item has a data file or not.")
|
|
448
|
+
generated__has_cog: bool | None = Field(default=False, title="[ARLAS, AIRS] Whether the item has a cog or not.")
|
|
449
|
+
generated__has_zarr: bool | None = Field(default=False, title="[ARLAS, AIRS] Whether the item has a zarr or not.")
|
|
450
|
+
generated__date_keywords: List[str] | None = Field(default=None, title="[ARLAS, AIRS] A list of keywords indicating clues on the date")
|
|
451
|
+
generated__day_of_week: int | None = Field(default=None, title="[ARLAS, AIRS] Day of week.")
|
|
452
|
+
generated__day_of_year: int | None = Field(default=None, title="[ARLAS, AIRS] Day of year.")
|
|
453
|
+
generated__hour_of_day: int | None = Field(default=None, title="[ARLAS, AIRS] Hour of day.")
|
|
454
|
+
generated__minute_of_day: int | None = Field(default=None, title="[ARLAS, AIRS] Minute of day.")
|
|
455
|
+
generated__month: int | None = Field(default=None, title="[ARLAS, AIRS] Month")
|
|
456
|
+
generated__year: int | None = Field(default=None, title="[ARLAS, AIRS] Year")
|
|
457
|
+
generated__season: str | None = Field(default=None, title="[ARLAS, AIRS] Season")
|
|
458
|
+
generated__tltrbrbl: List[List[float]] | None = Field(default=None, title="[ARLAS, AIRS] The coordinates of the top left, top right, bottom right, bottom left corners of the item.")
|
|
459
|
+
generated__band_common_names: List[str] | None = Field(default=None, title="[ARLAS, AIRS] List of the band common names.")
|
|
460
|
+
generated__band_names: List[str] | None = Field(default=None, title="[ARLAS, AIRS] List of the band names.")
|
|
461
|
+
generated__geohash2: str | None = Field(default=None, title="[ARLAS, AIRS] Geohash on the first two characters.")
|
|
462
|
+
generated__geohash3: str | None = Field(default=None, title="[ARLAS, AIRS] Geohash on the first three characters.")
|
|
463
|
+
generated__geohash4: str | None = Field(default=None, title="[ARLAS, AIRS] Geohash on the first four characters.")
|
|
464
|
+
generated__geohash5: str | None = Field(default=None, title="[ARLAS, AIRS] Geohash on the first five characters.")
|
|
333
465
|
|
|
334
466
|
|
|
335
467
|
class Item(BaseModel, extra=Extra.allow):
|
|
336
|
-
collection: str | None = Field(default=None, title="Name of the collection the item belongs to.", max_length=300)
|
|
468
|
+
collection: str | None = Field(default=None, title="[STAC] Name of the collection the item belongs to.", max_length=300)
|
|
337
469
|
catalog: str | None = Field(default=None, title="Name of the catalog the item belongs to.", max_length=300)
|
|
338
|
-
id: str | None = Field(default=None, title="Unique item identifier. Must be unique within the collection.", max_length=300)
|
|
339
|
-
geometry: Dict[str, Any] | None = Field(default=None, title="Defines the full footprint of the asset represented by this item, formatted according to `RFC 7946, section 3.1 (GeoJSON) <https://tools.ietf.org/html/rfc7946>`_")
|
|
340
|
-
bbox: List[float] | None = Field(default=None, title="Bounding Box of the asset represented by this item using either 2D or 3D geometries. The length of the array must be 2*n where n is the number of dimensions. Could also be None in the case of a null geometry.")
|
|
470
|
+
id: str | None = Field(default=None, title="[STAC] Unique item identifier. Must be unique within the collection.", max_length=300)
|
|
471
|
+
geometry: Dict[str, Any] | None = Field(default=None, title="[STAC] Defines the full footprint of the asset represented by this item, formatted according to `RFC 7946, section 3.1 (GeoJSON) <https://tools.ietf.org/html/rfc7946>`_")
|
|
472
|
+
bbox: List[float] | None = Field(default=None, title="[STAC] Bounding Box of the asset represented by this item using either 2D or 3D geometries. The length of the array must be 2*n where n is the number of dimensions. Could also be None in the case of a null geometry.")
|
|
341
473
|
centroid: List[float] | None = Field(default=None, title="Coordinates (lon/lat) of the geometry's centroid.")
|
|
342
|
-
assets: Dict[str, Asset] | None = Field(default=None, title="A dictionary mapping string keys to Asset objects. All Asset values in the dictionary will have their owner attribute set to the created Item.")
|
|
343
|
-
properties: Properties | None = Field(default=None, title="Item properties")
|
|
474
|
+
assets: Dict[str, Asset] | None = Field(default=None, title="[STAC] A dictionary mapping string keys to Asset objects. All Asset values in the dictionary will have their owner attribute set to the created Item.")
|
|
475
|
+
properties: Properties | None = Field(default=None, title="[STAC] Item properties")
|