Asset¶
The Asset class enables access to the UP42 assets in the storage. Assets are results of orders or results of jobs with download blocks.
Use an existing asset:
asset = up42.initialize_asset(asset_id="8c2dfb4d-bd35-435f-8667-48aea0dce2da")
Source code in up42/asset.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
|
Attributes¶
info: dict
property
¶
Gets and updates the asset metadata information.
stac_info: Union[dict, None]
property
¶
Gets the storage STAC information for the asset as a FeatureCollection.
One asset can contain multiple STAC items (e.g. the pan- and multispectral images).
Functions¶
download(output_directory=None, unpacking=True)
¶
Downloads the asset. Unpacking the downloaded file will happen as default.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_directory |
Union[str, Path, None]
|
The file output directory, defaults to the current working directory. |
None
|
unpacking |
bool
|
By default the download TGZ/TAR or ZIP archive file will be unpacked. |
True
|
Returns:
Type | Description |
---|---|
List[str]
|
List of the downloaded asset filepaths. |
Source code in up42/asset.py
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
|
update_metadata(title=None, tags=None, **kwargs)
¶
Update the metadata of the asset.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
title |
str
|
The title string to be assigned to the asset. |
None
|
tags |
List[str]
|
A list of tag strings to be assigned to the asset. |
None
|
Returns:
Type | Description |
---|---|
dict
|
The updated asset metadata information |
Source code in up42/asset.py
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
|