JobTask¶
Bases: VizTools
The JobTask class provides access to the result of a specific block in the workflow. Each job contains one or multiple JobTasks, one for each block.
Use an existing jobtask:
jobtask = up42.initialize_jobtask(jobtask_id="3f772637-09aa-4164-bded-692fcd746d20",
job_id="de5806aa-5ef1-4dc9-ab1d-06d7ec1a5021")
Source code in up42/jobtask.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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
|
info: dict
property
¶
Gets and updates the jobtask metadata information.
download_quicklooks(output_directory=None)
¶
Downloads quicklooks of the job task to disk.
After download, can be plotted via jobtask.plot_quicklooks().
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_directory |
Union[str, Path, None]
|
The file output directory, defaults to the current working directory. |
None
|
Returns:
Type | Description |
---|---|
List[str]
|
The quicklooks filepaths. |
Source code in up42/jobtask.py
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
|
download_results(output_directory=None)
¶
Downloads and unpacks the jobtask results. Default download to Desktop.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_directory |
Union[str, Path, None]
|
The file output directory, defaults to the current working directory. |
None
|
Source code in up42/jobtask.py
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 |
|
get_results_json(as_dataframe=False)
¶
Gets the Jobtask results data.json.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
as_dataframe |
bool
|
"fc" for FeatureCollection dict, "df" for GeoDataFrame. |
False
|
Returns:
Type | Description |
---|---|
Union[dict, GeoDataFrame]
|
Json of the results, alternatively geodataframe. |
Source code in up42/jobtask.py
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
|