Skip to content

Commit 7d80e6f

Browse files
committed
Add examples of mosaic functionality
1 parent 9468d27 commit 7d80e6f

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

docs/source/cli/examples.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,53 @@ Note: this might take some time and directory must exist::
4545

4646
planet data download --item-type PSScene3Band --limit 3 --dest images-download-directory
4747

48+
Mosaic Examples
49+
---------------
50+
51+
List information for all mosaics you have access to::
52+
53+
planet mosaics list
54+
55+
Note that you may want to parse the JSON that's output into a more human
56+
readable format. The cli does not directly provide options for this, but is
57+
meant to be easily interoperable with other tools, e.g. `jq
58+
<https://stedolan.github.io/jq/>`_. For example, we could output just the name
59+
and date range of each mosaic with::
60+
61+
planet mosaics list | jq -r '.mosaics[] | [.name, .first_acquired, .last_acquired] | @tsv'
62+
63+
Get basic information for a specific mosaic::
64+
65+
planet mosaics info global_monthly_2018_09_mosaic
66+
67+
List the first 10 quads for a mosaic (Omitting the ``--limit`` option will
68+
list all quads. Keep in mind that there may be millions for a global mosaic.)::
69+
70+
planet mosaics search global_monthly_2018_09_mosaic --limit=10
71+
72+
Find all quads inside a particular area of interest::
73+
74+
planet mosaics search global_monthly_2018_09_mosaic --rbox=-95.5,29.6,-95.3,29.8
75+
76+
Note that the format of ``--rbox`` is "xmin,ymin,xmax,ymax", so longitude comes
77+
before latitude.
78+
79+
Get basic information (footprint, etc) for a particular mosaic quad::
80+
81+
planet mosaics quad-info global_monthly_2018_09_mosaic 480-1200
82+
83+
Determine which scenes contributed to a particular mosaic quad::
84+
85+
planet mosaics contribution global_monthly_2018_09_mosaic 480-1200
86+
87+
Download all quads for a mosaic (this is impractical for large mosaics, which
88+
are hundreds of Terabytes in size)::
89+
90+
planet mosaics download <mosaic_name>
91+
92+
Download all quads inside of a rectangular box for a mosaic::
93+
94+
planet mosaics download global_monthly_2018_09_mosaic --rbox=-95.5,29.6,-95.3,29.8
4895

4996
Integration With Other Tools
5097
----------------------------

0 commit comments

Comments
 (0)