1i.band.library(1)           GRASS GIS User's Manual          i.band.library(1)
2
3
4

NAME

6       i.band.library   - Prints available semantic label information used for
7       multispectral data.
8

KEYWORDS

10       general, imagery, semantic label, image collections
11

SYNOPSIS

13       i.band.library
14       i.band.library --help
15       i.band.library [-e]  [pattern=string]    [operation=string]    [--help]
16       [--verbose]  [--quiet]  [--ui]
17
18   Flags:
19       -e
20           Print extended metadata information
21
22       --help
23           Print usage summary
24
25       --verbose
26           Verbose module output
27
28       --quiet
29           Quiet module output
30
31       --ui
32           Force launching GUI dialog
33
34   Parameters:
35       pattern=string
36           Semantic label search pattern (examples: L, S2, .*_2, S2_1)
37
38       operation=string
39           Operation to be performed
40           Options: print
41           Default: print
42

DESCRIPTION

44       i.band.library  prints available band information of multispectral data
45       defined by GRASS GIS. The following multispectral sensors are supported
46       by  default  (other band reference registry files can be added, see be‐
47       low):
48
49       Generic multispectral system:
50
51           •   gen_r Visible red
52
53           •   gen_g Visible green
54
55           •   gen_b Visible blue
56
57           •   gen_pan Visible panchromatic
58
59           •   gen_nir Near infrared
60
61       Landsat-5:
62
63           •   L5_1 Visible (Blue)
64
65           •   L5_2 Visible (Green)
66
67           •   L5_3 Visible (Red)
68
69           •   L5_4 Near-Infrared
70
71           •   L5_5 Short-wave infrared
72
73           •   L5_6 Thermal
74
75           •   L5_7 Short-wave infrared
76
77       Landsat-7:
78
79           •   L7_1 Visible (Blue)
80
81           •   L7_2 Visible (Green)
82
83           •   L7_3 Visible (Red)
84
85           •   L7_4 Near-Infrared
86
87           •   L7_5 Near-Infrared
88
89           •   L7_6 Thermal
90
91           •   L7_7 Mid-Infrared
92
93           •   L7_8 Panchromatic
94
95       Landsat-8:
96
97           •   L8_1 Visible (Coastal/Aerosol)
98
99           •   L8_2 Visible (Blue)
100
101           •   L8_3 Visible (Green)
102
103           •   L8_4 Visible (Red)
104
105           •   L8_5 Near-Infrared
106
107           •   L8_6 SWIR 1
108
109           •   L8_7 SWIR 2
110
111           •   L8_8 Panchromatic
112
113           •   L8_9 Cirrus
114
115           •   L8_10 TIRS 1
116
117           •   L8_11 TIRS 1
118
119       Sentinel-2:
120
121           •   S2_1 Visible (Coastal/Aerosol)
122
123           •   S2_2 Visible (Blue)
124
125           •   S2_3 Visible (Green)
126
127           •   S2_4 Visible (Red)
128
129           •   S2_5 Vegetation Red Edge 1
130
131           •   S2_6 Vegetation Red Edge 2
132
133           •   S2_7 Vegetation Red Edge 3
134
135           •   S2_8 Near-Infrared
136
137           •   S2_8A Narrow Near-Infrared
138
139           •   S2_9 Water vapour
140
141           •   S2_10 SWIR - Cirrus
142
143           •   S2_11 SWIR 1
144
145           •   S2_12 SWIR 2
146
147       Band references to be printed can be filtered by a search  pattern  (or
148       fully defined band reference identifier) which can be specified by pat‐
149       tern option. For pattern syntax see Python  regular  expression  opera‐
150       tions  documentation.  By  default, i.band.library prints all available
151       band references.
152
153       Extended metadata (central wavelength,  spatial  resolution,  etc.)  is
154       printed only when the -e flag is given.
155

Band reference and semantic label relation

157       Band  references are a special case (a subset) of semantic labels.  Any
158       string can be a semantic label but strings identifying specific  remote
159       sensing  platform bands (=band references) can have additional metadata
160       managed by i.band.library.  Specific band reference can be assigned  to
161       a  raster map as a semantic label by r.semantic.label or r.support mod‐
162       ules.
163

NOTES

165       Semantic label concept is supported  by  temporal  GRASS  modules,  see
166       t.register,  t.rast.list,  t.info  and t.rast.mapcalc modules for exam‐
167       ples.
168
169   Image collections
170       Image collections are the common data type to reference time series  of
171       multi band data. It is used in many frameworks (see Google Earth Engine
172       API for example) to address multi  spectral  satellite  images  series.
173       GRASS  supports  a  multi-band raster layer approach basically with the
174       imagery group concept (i.group). A new semantic label  concept  is  de‐
175       signed in order to support image collections in GRASS GIS.
176
177   Band reference registry files
178       Band  reference  information is stored in JSON files with a pre-defined
179       internal data structure. A minimalistic example is shown below.
180       {
181           "Sentinel2": {
182               "description": "The Sentinel-2 A/B bands",
183               "shortcut": "S2",
184               "instruments": "MultiSpectral Instrument (MSI) optical and infrared",
185               "launched": "23 June 2015 (A); 07 March 2017 (B)",
186               "source": "https://sentinel.esa.int/web/sentinel/missions/sentinel-2",
187               "bands": {
188                   "1": {
189                       "Sentinel 2A" : {
190                           "central wavelength (nm)": 443.9,
191                           "bandwidth (nm)": 27
192                       },
193                       "Sentinel 2B" : {
194                           "central wavelength (nm)": 442.3,
195                           "bandwidth (nm)": 45
196                       },
197                       "spatial resolution (meters)": 60,
198                       "tag": "Visible (Coastal/Aerosol)"
199                   },
200                   "2": {
201                       "Sentinel 2A" : {
202                           "central wavelength (nm)": 496.6,
203                           "bandwidth (nm)": 98
204                       },
205                       "Sentinel 2B" : {
206                           "central wavelength (nm)": 492.1,
207                           "bandwidth (nm)": 98
208                       },
209                       "spatial resolution (meters)": 10,
210                       "tag": "Visible (Blue)"
211                   }
212               }
213           }
214       }
215       Each series starts with an unique identifier  ("Sentinel2"  in  example
216       above).  Required  attributes  are only two: a shortcut and bands. Note
217       that a shortcut must be unique in all band  reference  registry  files.
218       Number  of  other attributes is not defined or even limited (in example
219       above only description and instruments attributes are defined). List of
220       bands is defined by a bands attribute. Each band is defined by an iden‐
221       tifier ("1", "2" in example above). List of attributes describing  each
222       band  is  not pre-defined or limited. In example above each band is de‐
223       scribed by a central wavelength (nm), bandwidth (nm), and a tag.
224
225       Band reference identifier defined by  pattern  option  is  given  by  a
226       shortcut  in order to print band reference information for whole series
227       or by specific shortcut_band identifier.
228
229       System-defined registry files are located in GRASS GIS installation di‐
230       rectory  ($GISBASE/etc/i.band.library).  Note that currently i.band.li‐
231       brary allows managing only system-defined registry files.  Support  for
232       user-defined registry files is planned to be implemented, see KNOWN IS‐
233       SUES section for details.
234

EXAMPLES

236   Print all available band references
237       i.band.library
238       S2_1 Visible (Coastal/Aerosol)
239       S2_2 Visible (Blue)
240       ...
241       L7_1 Visible (Blue)
242       L7_2 Visible (Green)
243       ...
244       L8_1 Visible (Coastal/Aerosol)
245       L8_2 Visible (Blue)
246       ...
247       The module prints band reference and related tag if defined.
248
249   Filter band references by a shortcut
250       Only band identifiers related to Sentinel-2 satellite will be printed.
251       i.band.library pattern=S2
252       S2_1 Visible (Coastal/Aerosol)
253       ...
254       S2_12 SWIR 2
255
256   Filter band references by a regular expression
257       Print all available 2nd bands:
258       i.band.library pattern=.*_2
259       S2_2 Visible (Blue)
260       L7_2 Visible (Green)
261       L8_2 Visible (Blue)
262       ...
263
264   Print extended metadata for specified band identifier
265       Extended metadata related to the first  band  of  Sentinel-2  satellite
266       will be printed.
267       i.band.library -e pattern=S2_1
268       description: The Sentinel-2 A/B bands
269       shortcut: S2
270       instruments: MultiSpectral Instrument (MSI) optical and infrared
271       launched: 23 June 2015 (A); 07 March 2017 (B)
272       source: https://sentinel.esa.int/web/sentinel/missions/sentinel-2
273           band: 1
274               Sentinel 2A:
275                       central wavelength (nm): 443.9
276                       bandwidth (nm): 27
277               Sentinel 2B:
278                       central wavelength (nm): 442.3
279                       bandwidth (nm): 45
280               spatial resolution (meters): 60
281               tag: Visible (Coastal/Aerosol)
282

KNOWN ISSUES

284       i.band.library  has  currently  very  limited  functionality. Only sys‐
285       tem-defined band references are  supported.  The  final  implementation
286       will  support  managing  (add, modify, delete) user-defined band refer‐
287       ences.
288
289       Only very limited number  of  band  references  is  currently  defined,
290       namely  Sentinel-2, Landsat7, and Landsat8 satellites. This will be im‐
291       proved in the near future.
292

REFERENCES

294           •   Google Earth Engine API
295

SEE ALSO

297        r.semantic.label, r.info
298

AUTHORS

300       Martin Landa
301       Development sponsored by mundialis GmbH & Co. KG  (for  the  openEO  EU
302       H2020 grant 776242)
303

SOURCE CODE

305       Available at: i.band.library source code (history)
306
307       Accessed: Saturday Oct 28 18:19:19 2023
308
309       Main  index | Imagery index | Topics index | Keywords index | Graphical
310       index | Full index
311
312       © 2003-2023 GRASS Development Team, GRASS GIS 8.3.1 Reference Manual
313
314
315
316GRASS 8.3.1                                                  i.band.library(1)
Impressum