-
Notifications
You must be signed in to change notification settings - Fork 32
/
Copy path2-create-stac-catalog-python.html
1436 lines (1158 loc) · 54.7 KB
/
2-create-stac-catalog-python.html
1
2
3
4
5
6
7
8
9
10
11
12
13
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h1 id="Create-a-Basic-STAC-Catalog-Using-PySTAC">Create a Basic STAC Catalog Using PySTAC<a class="anchor-link" href="#Create-a-Basic-STAC-Catalog-Using-PySTAC">¶</a></h1>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>In the <a href="/en/tutorials/1-read-stac-python/index.html">previous tutorial</a>, you learned how to use <a href="https://pystac.readthedocs.io/en/stable/index.html#">PySTAC</a> to read an existing STAC Catalog. In this tutorial, you will learn how to create your own STAC Catalog (also using PySTAC). By the end, you will have a basic STAC Catalog created.</p>
<p>In the following tutorials, you will learn to add additional STAC components and functionality to the basic STAC Catalog you create here. The experience you gain from this tutorial along with the extensive <a href="https://pystac.readthedocs.io/en/latest/api.html">PySTAC documentation</a> will allow you to create your own STAC Catalog on a different dataset.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Dependencies">Dependencies<a class="anchor-link" href="#Dependencies">¶</a></h2><p>If you need to install pystac, rasterio, or pystac, uncomment the lines below and run the cell.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [1]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="c1"># ! pip install pystac</span>
<span class="c1"># ! pip install rasterio</span>
<span class="c1"># ! pip install shapely</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Import-Packages-and-Store-Data">Import Packages and Store Data<a class="anchor-link" href="#Import-Packages-and-Store-Data">¶</a></h2><p>To begin, import the packages and classes that you need to access data and work with STAC Catalogs in Python.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [2]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">rasterio</span>
<span class="kn">import</span> <span class="nn">urllib.request</span>
<span class="kn">import</span> <span class="nn">pystac</span>
<span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timezone</span>
<span class="kn">from</span> <span class="nn">shapely.geometry</span> <span class="kn">import</span> <span class="n">Polygon</span><span class="p">,</span> <span class="n">mapping</span>
<span class="kn">from</span> <span class="nn">tempfile</span> <span class="kn">import</span> <span class="n">TemporaryDirectory</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>To give us some material to work with, let's download a single image from the <a href="https://spacenet.ai/sn5-challenge/">SpaceNet 5 Challenge</a>. We will use a temporary directory to save our single-Item STAC.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [3]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="c1"># Set temporary directory to store source data</span>
<span class="n">tmp_dir</span> <span class="o">=</span> <span class="n">TemporaryDirectory</span><span class="p">()</span>
<span class="n">img_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tmp_dir</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s1">'image.tif'</span><span class="p">)</span>
<span class="c1"># Fetch and store data</span>
<span class="n">url</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'https://spacenet-dataset.s3.amazonaws.com/'</span>
<span class="s1">'spacenet/SN5_roads/train/AOI_7_Moscow/MS/'</span>
<span class="s1">'SN5_roads_train_AOI_7_Moscow_MS_chip996.tif'</span><span class="p">)</span>
<span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlretrieve</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">img_path</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="prompt output_prompt">Out[3]:</div>
<div class="output_text output_subarea output_execute_result">
<pre>('/var/folders/73/z5lbqv_s6l7fcfx464_pn8p80000gn/T/tmp17i4icyl/image.tif',
<http.client.HTTPMessage at 0x116ffa710>)</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>We want to create a STAC Catalog. Take a look at the <a href="https://pystac.readthedocs.io/en/stable/api/catalog.html">Catalog documentation</a> to see what information you need to create our PySTAC <code>Catalog</code> instance.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Create-the-STAC-Catalog">Create the STAC Catalog<a class="anchor-link" href="#Create-the-STAC-Catalog">¶</a></h2><p>Start by first creating the catalog and only populating the required arguments: the ID and description. The remaining arguments will be added to the catalog further along in the tutorial.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [4]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">catalog</span> <span class="o">=</span> <span class="n">pystac</span><span class="o">.</span><span class="n">Catalog</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="s1">'tutorial-catalog'</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s1">'This catalog is a basic demonstration catalog utilizing a scene from SpaceNet 5.'</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>The catalog now exists. Take a look inside.</p>
<p>In the Introduction to STAC lesson on this site, you learned about the three main components of the STAC Specification and the possible relations between them all. Based on what you learned and what we have done so far, do you think your catalog has any children or items? Let's take a look:</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [5]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">catalog</span><span class="o">.</span><span class="n">get_children</span><span class="p">()))</span>
<span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">catalog</span><span class="o">.</span><span class="n">get_items</span><span class="p">()))</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="prompt"></div>
<div class="output_subarea output_stream output_stdout output_text">
<pre>[]
[]
</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>Since we have not added them, there are no children or items in the catalog yet. We need to add these components.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h3 id="JSON-Progress-Check">JSON Progress Check<a class="anchor-link" href="#JSON-Progress-Check">¶</a></h3><p>Throughout this tutorial, we will be checking in on the STAC components we are creating using <code>to_dict()</code> to see how the STAC JSON is shaping up. Let's take a look at the catalog we just created.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [6]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">catalog</span><span class="o">.</span><span class="n">to_dict</span><span class="p">(),</span> <span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">))</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="prompt"></div>
<div class="output_subarea output_stream output_stdout output_text">
<pre>{
"type": "Catalog",
"id": "tutorial-catalog",
"stac_version": "1.0.0",
"description": "This catalog is a basic demonstration catalog utilizing a scene from SpaceNet 5.",
"links": []
}
</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Create-a-STAC-Item">Create a STAC Item<a class="anchor-link" href="#Create-a-STAC-Item">¶</a></h2><p>Now that the catalog exists, we can populate it. Let's create a STAC Item to represent the image we saved in the temporary directory. Again, take a look at the <a href="https://pystac.readthedocs.io/en/stable/api/item.html#pystac-item">PySTAC Documentation for an Item</a> to see what you need to supply.</p>
<p>For creating this item, you will populate all the attributes at once.</p>
<p>Let's collect the information we need for each attribute.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h3 id="Collect-the-Item's-geometry-and-bbox">Collect the Item's <code>geometry</code> and <code>bbox</code><a class="anchor-link" href="#Collect-the-Item's-geometry-and-bbox">¶</a></h3><p>Using <a href="https://rasterio.readthedocs.io/en/stable/">rasterio</a>, we can extract the image's bounding box and geometry metadata.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [7]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="k">def</span> <span class="nf">get_bbox_and_footprint</span><span class="p">(</span><span class="n">raster</span><span class="p">):</span>
<span class="k">with</span> <span class="n">rasterio</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">raster</span><span class="p">)</span> <span class="k">as</span> <span class="n">r</span><span class="p">:</span>
<span class="n">bounds</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">bounds</span>
<span class="n">bbox</span> <span class="o">=</span> <span class="p">[</span><span class="n">bounds</span><span class="o">.</span><span class="n">left</span><span class="p">,</span> <span class="n">bounds</span><span class="o">.</span><span class="n">bottom</span><span class="p">,</span> <span class="n">bounds</span><span class="o">.</span><span class="n">right</span><span class="p">,</span> <span class="n">bounds</span><span class="o">.</span><span class="n">top</span><span class="p">]</span>
<span class="n">footprint</span> <span class="o">=</span> <span class="n">Polygon</span><span class="p">([</span>
<span class="p">[</span><span class="n">bounds</span><span class="o">.</span><span class="n">left</span><span class="p">,</span> <span class="n">bounds</span><span class="o">.</span><span class="n">bottom</span><span class="p">],</span>
<span class="p">[</span><span class="n">bounds</span><span class="o">.</span><span class="n">left</span><span class="p">,</span> <span class="n">bounds</span><span class="o">.</span><span class="n">top</span><span class="p">],</span>
<span class="p">[</span><span class="n">bounds</span><span class="o">.</span><span class="n">right</span><span class="p">,</span> <span class="n">bounds</span><span class="o">.</span><span class="n">top</span><span class="p">],</span>
<span class="p">[</span><span class="n">bounds</span><span class="o">.</span><span class="n">right</span><span class="p">,</span> <span class="n">bounds</span><span class="o">.</span><span class="n">bottom</span><span class="p">]</span>
<span class="p">])</span>
<span class="k">return</span> <span class="p">(</span><span class="n">bbox</span><span class="p">,</span> <span class="n">mapping</span><span class="p">(</span><span class="n">footprint</span><span class="p">))</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [8]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="c1"># Run the function and print out the results</span>
<span class="n">bbox</span><span class="p">,</span> <span class="n">footprint</span> <span class="o">=</span> <span class="n">get_bbox_and_footprint</span><span class="p">(</span><span class="n">img_path</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"bbox: "</span><span class="p">,</span> <span class="n">bbox</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"footprint: "</span><span class="p">,</span> <span class="n">footprint</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="prompt"></div>
<div class="output_subarea output_stream output_stdout output_text">
<pre>bbox: [37.6616853489879, 55.73478197572927, 37.66573047610874, 55.73882710285011]
footprint: {'type': 'Polygon', 'coordinates': (((37.6616853489879, 55.73478197572927), (37.6616853489879, 55.73882710285011), (37.66573047610874, 55.73882710285011), (37.66573047610874, 55.73478197572927), (37.6616853489879, 55.73478197572927)),)}
</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h3 id="Collect-the-Item-datetime">Collect the Item <code>datetime</code><a class="anchor-link" href="#Collect-the-Item-datetime">¶</a></h3><p>To obtain the datetime property for our Item from the image, we will use <a href="https://docs.python.org/3/library/datetime.html#datetime.datetime.now">datetime.now()</a>.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [9]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">datetime_utc</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">(</span><span class="n">tz</span><span class="o">=</span><span class="n">timezone</span><span class="o">.</span><span class="n">utc</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h3 id="Populate-pystac.Item">Populate <code>pystac.Item</code><a class="anchor-link" href="#Populate-pystac.Item">¶</a></h3>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [10]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">item</span> <span class="o">=</span> <span class="n">pystac</span><span class="o">.</span><span class="n">Item</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="s1">'local-image'</span><span class="p">,</span>
<span class="n">geometry</span><span class="o">=</span><span class="n">footprint</span><span class="p">,</span>
<span class="n">bbox</span><span class="o">=</span><span class="n">bbox</span><span class="p">,</span>
<span class="n">datetime</span><span class="o">=</span><span class="n">datetime_utc</span><span class="p">,</span>
<span class="n">properties</span><span class="o">=</span><span class="p">{})</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>Now we have our first Item.</p>
<p>However, the item has not been added to our catalog yet. Therefore, when you run the following cell, you can see that the Item does not have a parent yet:</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [11]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">get_parent</span><span class="p">()</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="prompt"></div>
<div class="output_subarea output_stream output_stdout output_text">
<pre>True
</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h3 id="Add-the-Item-to-the-Catalog">Add the Item to the Catalog<a class="anchor-link" href="#Add-the-Item-to-the-Catalog">¶</a></h3>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [12]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">catalog</span><span class="o">.</span><span class="n">add_item</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="prompt output_prompt">Out[12]:</div>
<div class="output_html rendered_html output_subarea output_execute_result">
<style>
.pystac-summary {
cursor: pointer;
display:list-item;
}
.pystac-key {
color: rgb(0, 128, 0);
font-weight: 700;
}
.pystac-key-value {
display: inline-block;
margin: 0px 0.5em 0px 0px;
}
</style>
<div class="jp-RenderedJSON jp-mod-trusted jp-OutputArea-output">
<div class="container" style="line-height: normal;">
<ul style="padding: 0px; margin: 0px; list-style: none; display: block;">
<li style="overflow-wrap: break-word; padding-left: 2.125em; text-indent: -0.5em;">
<span class="pystac-key pystac-key-value">rel</span>
<span style="color: rgb(186, 33, 33);">"item"</span>
</li>
<li style="overflow-wrap: break-word; padding-left: 2.125em; text-indent: -0.5em;">
<span class="pystac-key pystac-key-value">href</span>
<span style="color: rgb(186, 33, 33);">None</span>
</li>
<li style="overflow-wrap: break-word; padding-left: 2.125em; text-indent: -0.5em;">
<span class="pystac-key pystac-key-value">type</span>
<span style="color: rgb(186, 33, 33);">"application/json"</span>
</li>
</ul>
</div>
</div></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h3 id="Visualize-the-Catalog-Relationship">Visualize the Catalog Relationship<a class="anchor-link" href="#Visualize-the-Catalog-Relationship">¶</a></h3>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>Now that we have added the item to the catalog, we can see it link to it’s parent (which is the catalog).</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [13]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">item</span><span class="o">.</span><span class="n">get_parent</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="prompt output_prompt">Out[13]:</div>
<div class="output_html rendered_html output_subarea output_execute_result">
<style>
.pystac-summary {
cursor: pointer;
display:list-item;
}
.pystac-key {
color: rgb(0, 128, 0);
font-weight: 700;
}
.pystac-key-value {
display: inline-block;
margin: 0px 0.5em 0px 0px;
}
</style>
<div class="jp-RenderedJSON jp-mod-trusted jp-OutputArea-output">
<div class="container" style="line-height: normal;">
<ul style="padding: 0px; margin: 0px; list-style: none; display: block;">
<li style="overflow-wrap: break-word; padding-left: 2.125em; text-indent: -0.5em;">
<span class="pystac-key pystac-key-value">type</span>
<span style="color: rgb(186, 33, 33);">"Catalog"</span>
</li>
<li style="overflow-wrap: break-word; padding-left: 2.125em; text-indent: -0.5em;">
<span class="pystac-key pystac-key-value">id</span>
<span style="color: rgb(186, 33, 33);">"tutorial-catalog"</span>
</li>
<li style="overflow-wrap: break-word; padding-left: 2.125em; text-indent: -0.5em;">
<span class="pystac-key pystac-key-value">stac_version</span>
<span style="color: rgb(186, 33, 33);">"1.0.0"</span>
</li>
<li style="overflow-wrap: break-word; padding-left: 2.125em; text-indent: -0.5em;">
<span class="pystac-key pystac-key-value">description</span>
<span style="color: rgb(186, 33, 33);">"This catalog is a basic demonstration catalog utilizing a scene from SpaceNet 5."</span>
</li>
<li><details>
<summary class="pystac-summary">
<span class="pystac-key">links</span>
<span style="padding-left: 0.5em; color: rgb(64, 128, 128); font-style: italic;">[] 1 items</span>
</summary>
<ul style="margin: 0px; padding: 0px 0px 0px 1.75em; list-style: none; display: block;">
<li><details>
<summary class="pystac-summary"><span class="pystac-key">0</span></summary>
<ul style="margin: 0px; padding: 0px 0px 0px 1.75em; list-style: none; display: block;">
<li style="overflow-wrap: break-word; padding-left: 2.125em; text-indent: -0.5em;">
<span class="pystac-key pystac-key-value">rel</span>
<span style="color: rgb(186, 33, 33);">"item"</span>
</li>
<li style="overflow-wrap: break-word; padding-left: 2.125em; text-indent: -0.5em;">
<span class="pystac-key pystac-key-value">href</span>
<span style="color: rgb(186, 33, 33);">None</span>
</li>
<li style="overflow-wrap: break-word; padding-left: 2.125em; text-indent: -0.5em;">
<span class="pystac-key pystac-key-value">type</span>
<span style="color: rgb(186, 33, 33);">"application/json"</span>
</li>
</ul>
</details></li>
</ul>
</details></li>
</ul>
</div>
</div></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>You can also visualize the architecture of the STAC Catalog by using the <code>describe()</code> method. As a reminder, <strong>be careful</strong> when using it on large catalogs, as it will walk the entire tree of the STAC.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [14]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">catalog</span><span class="o">.</span><span class="n">describe</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="prompt"></div>
<div class="output_subarea output_stream output_stdout output_text">
<pre>* <Catalog id=tutorial-catalog>
* <Item id=local-image>
</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Add-STAC-Assets">Add STAC Assets<a class="anchor-link" href="#Add-STAC-Assets">¶</a></h2><p>We’ve created an item, but there aren’t any assets associated with it. Let’s create one. As always, take a look at the <a href="https://pystac.readthedocs.io/en/stable/api/asset.html#pystac-asset">PySTAC API Documentation</a> to see what components are needed to create an Asset.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [15]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="c1"># Add Asset and all its information to Item </span>
<span class="n">item</span><span class="o">.</span><span class="n">add_asset</span><span class="p">(</span>
<span class="n">key</span><span class="o">=</span><span class="s1">'image'</span><span class="p">,</span>
<span class="n">asset</span><span class="o">=</span><span class="n">pystac</span><span class="o">.</span><span class="n">Asset</span><span class="p">(</span>
<span class="n">href</span><span class="o">=</span><span class="n">img_path</span><span class="p">,</span>
<span class="n">media_type</span><span class="o">=</span><span class="n">pystac</span><span class="o">.</span><span class="n">MediaType</span><span class="o">.</span><span class="n">GEOTIFF</span>
<span class="p">)</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h4 id="JSON-Progress-Check">JSON Progress Check<a class="anchor-link" href="#JSON-Progress-Check">¶</a></h4><p>Run <code>to_dict()</code> on the STAC Item we created. Notice the asset is now set:</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [16]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">to_dict</span><span class="p">(),</span> <span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">))</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="prompt"></div>
<div class="output_subarea output_stream output_stdout output_text">
<pre>{
"type": "Feature",
"stac_version": "1.0.0",
"id": "local-image",
"properties": {
"datetime": "2023-10-18T03:10:18.923211Z"
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
37.6616853489879,
55.73478197572927
],
[
37.6616853489879,
55.73882710285011
],
[
37.66573047610874,
55.73882710285011
],
[
37.66573047610874,
55.73478197572927
],
[
37.6616853489879,
55.73478197572927
]
]
]
},
"links": [
{
"rel": "root",
"href": null,
"type": "application/json"
},
{
"rel": "parent",
"href": null,
"type": "application/json"
}
],
"assets": {
"image": {
"href": "/var/folders/73/z5lbqv_s6l7fcfx464_pn8p80000gn/T/tmp17i4icyl/image.tif",
"type": "image/tiff; application=geotiff"
}
},
"bbox": [
37.6616853489879,
55.73478197572927,
37.66573047610874,
55.73882710285011
],
"stac_extensions": []
}
</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>Note that the link href properties are null. The empty href links are OK for now, as we’re working with the STAC in memory. Next, we will write the Catalog out and set those HREFs.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Save-the-Catalog">Save the Catalog<a class="anchor-link" href="#Save-the-Catalog">¶</a></h2><p>As the JSON above indicates, there are no HREFs set on these in-memory items. PySTAC uses the <code>self</code> link on STAC objects to track where the file lives. Because we haven’t set them, they evaluate to <code>None</code>:</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [17]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="n">catalog</span><span class="o">.</span><span class="n">get_self_href</span><span class="p">()</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">get_self_href</span><span class="p">()</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="prompt"></div>
<div class="output_subarea output_stream output_stdout output_text">
<pre>True
True
</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h3 id="Set-the-Catalog's-HREFs">Set the Catalog's HREFs<a class="anchor-link" href="#Set-the-Catalog's-HREFs">¶</a></h3>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>In order to set the HREFs, we can use <code>normalize_hrefs</code>. <a href="https://pystac.readthedocs.io/en/stable/api/pystac.html?highlight=normalize_hrefs#pystac.Catalog.normalize_hrefs">This method</a> will create a normalized set of HREFs for each STAC object in the catalog, according to the recommendations from the <a href="https://github.com/radiantearth/stac-spec/blob/v0.8.1/best-practices.md#catalog-layout">best practices document</a> on how to lay out a catalog.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [18]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">catalog</span><span class="o">.</span><span class="n">normalize_hrefs</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tmp_dir</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"stac"</span><span class="p">))</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>Now that we’ve normalized to a root directory (the temporary directory), we see that the <code>self</code> links are set:</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [19]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="s2">"Catalog HREF: "</span><span class="p">,</span> <span class="n">catalog</span><span class="o">.</span><span class="n">get_self_href</span><span class="p">())</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"Item HREF: "</span><span class="p">,</span> <span class="n">item</span><span class="o">.</span><span class="n">get_self_href</span><span class="p">())</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="prompt"></div>
<div class="output_subarea output_stream output_stdout output_text">
<pre>Catalog HREF: /var/folders/73/z5lbqv_s6l7fcfx464_pn8p80000gn/T/tmp17i4icyl/stac/catalog.json
Item HREF: /var/folders/73/z5lbqv_s6l7fcfx464_pn8p80000gn/T/tmp17i4icyl/stac/local-image/local-image.json
</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>We can now call <a href="https://pystac.readthedocs.io/en/stable/api/pystac.html?highlight=normalize_hrefs#pystac.Catalog.save"><code>save</code></a> on the catalog, which will recursively save all the STAC objects to their respective self HREFs.</p>
<p>Save requires a <code>CatalogType</code> to be set. You can review the <a href="https://pystac.readthedocs.io/en/stable/api/pystac.html?highlight=CatalogType#catalogtype">PySTAC API Documentation</a> to learn about each <code>CatalogType</code>.</p>
<p>Here, we will be creating a ‘self-contained catalog.' This type is one that is designed for portability. Users may want to download an online catalog from and be able to use it on their local computer, so all links need to be relative.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h3 id="Save-the-Catalog:-Self-Contained">Save the Catalog: Self Contained<a class="anchor-link" href="#Save-the-Catalog:-Self-Contained">¶</a></h3>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [20]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">catalog</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">catalog_type</span><span class="o">=</span><span class="n">pystac</span><span class="o">.</span><span class="n">CatalogType</span><span class="o">.</span><span class="n">SELF_CONTAINED</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
</div><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>Take a look at the temporary directory to see the catalog and item.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="prompt input_prompt">In [21]:</div>
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="o">!</span>ls<span class="w"> </span><span class="o">{</span>tmp_dir.name<span class="o">}</span>/stac/*
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="prompt"></div>
<div class="output_subarea output_stream output_stdout output_text">
<pre>/var/folders/73/z5lbqv_s6l7fcfx464_pn8p80000gn/T/tmp17i4icyl/stac/catalog.json
/var/folders/73/z5lbqv_s6l7fcfx464_pn8p80000gn/T/tmp17i4icyl/stac/local-image:
local-image.json
</pre>
</div>
</div>
</div>
</div>