Skip to content

Commit

Permalink
Merge pull request #13 from ESA-PhiLab/fix_links_readme
Browse files Browse the repository at this point in the history 
Fix links readme
  • Loading branch information
@sirbastiano
sirbastiano authored Aug 2, 2023
2 parents 08b7774 + 570d8d0 commit 4a04faa
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,24 +29,24 @@ NB: What we call raw data in this project are Sentinel-2 data generated by the d
<li><a href="#content-of-the-repository">Content of the repository</a></li>
<li><a href="#installation">Installation</a>
<ul>
<li><a href="#create-the-PyRawS-environment">Create the PyRawS environment</a></li>
<li><a href="#create-the-pyraws-environment">Create the PyRawS environment</a></li>
<li><a href="#set-up-for-coregistration-study">Set-up-for-coregistration-study</a></li>
<li><a href="#data-directory">Data directory</a></li>
</ul>
<li><a href="#PyRawS-databases">PyRawS databases</a></li>
<li><a href="#pyraws-databases">PyRawS databases</a></li>
<li><a href="#raw-events-and-raw-granules">Raw events and Raw granules</a></li>
<li><a href="#quickstart">Quickstart</a>
<ul>
<li><a href="#open-a-raw-event-from-path">Open a Raw event from PATH.</a></li>
<li><a href="#open-a-raw-event-from-database">Open a Raw event from database.</a></li>
<li><a href="#show-raw-granules-information-of-a-raw-event">Show Raw granules information of a Raw event</a></li>
<li><a href="#access-a-rawgranule-pixels">Access a Raw_granule pixels</a></li>
<li><a href="#get-a-single-rawgranule-from-a-rawevent">Get a single Raw_granule from a Raw_event</a></li>
<li><a href="#superimpose-rawgranule-bands">Superimpose Raw_granule bands</a></li>
<li><a href="#how-to-perform-the-coarse-coregisteration-of-rawgranules">How to perform the coarse coregisteration of Raw_granules</a></li>
<li><a href="#how-to-get-coordinates-of-a-raw-granule-band">How to get the coordinates of a Raw granule band</a></li>
<li><a href="#rawevent-database-metadata">Raw_event: database metadata</a></li>
<li><a href="#export-a-rawgranule-to-tif">Export a Raw_granule to TIF</a></li>
<li><a href="#access-a-raw_granule-pixels">Access a Raw_granule pixels</a></li>
<li><a href="#get-a-single-raw_granule-from-a-raw_event">Get a single Raw_granule from a Raw_event</a></li>
<li><a href="#superimpose-raw_granule-bands">Superimpose Raw_granule bands</a></li>
<li><a href="#how-to-perform-the-coarse-coregisteration-of-raw_granules">How to perform the coarse coregisteration of Raw_granules</a></li>
<li><a href="#how-to-get-the-coordinates-of-a-raw-granule-band">How to get the coordinates of a Raw granule band</a></li>
<li><a href="#raw_event-database-metadata">Raw_event: database metadata</a></li>
<li><a href="#export-a-raw_granule-to-tif">Export a Raw_granule to TIF</a></li>
</ul>
</li>
<li><a href="#glossary">Glossary</a></li>
Expand Down Expand Up @@ -323,7 +323,7 @@ raw_granule_0.show_granule_info()
granule_0_info_dict=raw_granule_0.get_granule_info()
```

### Access a Raw\_granule pixels
### Access a Raw_granule pixels
To visualize the values of an `Raw_data` object, it is possible to return it as a [PyTorch](https://pytorch.org/) tensor. However, since the different bands have different resolutions, depending on the bands that we want to shape as a tensor, it is necessary to upsample/downsample some of them to adapt them to the band with higher/smaller resolution. The next code snippet will open the `Etna_00` with bands `B02` (10 m), `B8A` (20 m), `B11` (20 m), get the granule with index 1, and will return the first two bands in the collection as tensor by performing upsample.

```py
Expand Down Expand Up @@ -597,37 +597,37 @@ raw_granule_0.export_to_tif(save_path=output_tif_folder)
```

## Glossary
* ### Coarse coregistration
### Coarse coregistration
Lightweight spatial coregistration method optimized for onboard-satellite applications. It simply shifts the various bands of a fixed factor that depends only on the bands, the satellite and detector number.

* ### Sentinel-2 L0 data
### Sentinel-2 L0 data
Sentinel-2 data at `level-0` (`L0`) are data that are transmitted to Ground from Sentinel-2 satellites. The `L0` format is compressed to diminish downlink bandwidth requirements. For more information, refer to the [Sentinel-2 Products Specification Document](https://sentinel.esa.int/documents/247904/685211/sentinel-2-products-specification-document)

* ### Sentinel-2 Raw data
In the frame of this project, the [Sentinel-2 Raw](#sentinel-2-raw-data) represents a particular product in the Sentinel-2 processing chain that matches a decompressed version of [Sentinel-2 L0 data](sentinel-2-l0-data) with additional metadata that are produced on ground. Once decompressed, `Sentinel-2 Raw data` are the data available on Ground that better emulate the one produced by Sentinel-2 detectors with the exception of the effects due to compression and onboard equalization, which are not compensated at this stage. Therefore, `Sentinel-2 raw data` are those exploited in this project. For more information, refer to the [Sentinel-2 Products Specification Document](https://sentinel.esa.int/documents/247904/685211/sentinel-2-products-specification-document). <br>
### Sentinel-2 Raw data
In the frame of this project, the [Sentinel-2 Raw](#sentinel-2-raw-data) represents a particular product in the Sentinel-2 processing chain that matches a decompressed version of [Sentinel-2 L0 data](#sentinel-2-l0-data) with additional metadata that are produced on ground. Once decompressed, `Sentinel-2 Raw data` are the data available on Ground that better emulate the one produced by Sentinel-2 detectors with the exception of the effects due to compression and onboard equalization, which are not compensated at this stage. Therefore, `Sentinel-2 raw data` are those exploited in this project. For more information, refer to the [Sentinel-2 Products Specification Document](https://sentinel.esa.int/documents/247904/685211/sentinel-2-products-specification-document). <br>
**N.B**: the nomenclature ```raw data``` and its location in the Sentinel-2 processing chain is specific for this project only.

* ### Sentinel-2 Raw granule
A `granule` is the image acquired by a Sentinel-2 detector during a single acquisition lasting 3.6 s. Granules are defined at [L0](#sentinel-2-raw-data) level. However, since the processing perfomed on the ground between L0 and raw data does not alter the image content (with the exception of the decompression process) but just provide additional metadata, granules are defined also at [Sentinel-2 Raw](#sentinel-2-raw-data) level.
### Sentinel-2 Raw granule
A `granule` is the image acquired by a Sentinel-2 detector during a single acquisition lasting 3.6 s. Granules are defined at [L0](#sentinel-2-l0-data) level. However, since the processing perfomed on the ground between L0 and raw data does not alter the image content (with the exception of the decompression process) but just provide additional metadata, granules are defined also at [Sentinel-2 Raw](#sentinel-2-raw-data) level.
Given the pushbroom nature of the Sentinel-2 sensor, bands do not look at the same area at [Raw](#sentinel-2-raw-data) level. For more information, refer to the [Sentinel-2 Products Specification Document](https://sentinel.esa.int/documents/247904/685211/sentinel-2-products-specification-document)

* ### Sentinel-2 Raw event
[Sentinel-2 Raw data](#sentinel-2-raw-data) are produced by decompressing [Sentinel-2 L0 data](sentinel-2-raw-data). To download L0 data, it is necessary to specify one polygon that surrounds a particular area-of-interest. This leads to download all those [Sentinel-2 Raw granules](#sentinel-2-raw-granule) whose reference band intersects the specified polygon. Such collection is a `Raw-event`. Each `Raw-event` matches one of the `ID_event` entry of the database. <br>
### Sentinel-2 Raw event
[Sentinel-2 Raw data](#sentinel-2-raw-data) are produced by decompressing [Sentinel-2 L0 data](#sentinel-2-l0-data). To download L0 data, it is necessary to specify one polygon that surrounds a particular area-of-interest. This leads to download all those [Sentinel-2 Raw granules](#sentinel-2-raw-granule) whose reference band intersects the specified polygon. Such collection is a `Raw-event`. Each `Raw-event` matches one of the `ID_event` entry of the database. <br>
For each `Raw-event`, we do not provide all the collection of [Sentinel-2 Raw granules](#sentinel-2-Raw-granule), but only the set of [Raw data useful granules](#raw-data-useful-granule) and [Raw data complementary granules](#Raw-data-complementary-granule). For an intuitive example, please, check [Raw events and granules](#raw-events-and-raw-granules).

* ### Sentinel-2 L1C data
### Sentinel-2 L1C data
The `Level 1-C` (`L1C`) is one format for `Sentinel-2` data. To convert [Sentinel-2 Raw data](#sentinel-2-raw-data) to `L1C` data, numerous processing steps are applied to correct defects, including bands coregistration, ortho-rectification, decompression, noise-suppression and other. For more information, refer to the [Sentinel-2 Products Specification Document](https://sentinel.esa.int/documents/247904/685211/sentinel-2-products-specification-document).

* ### Sentinel-2 L1C event
### Sentinel-2 L1C event
Same concept for [Sentinel-2 Raw events](#sentinel-2-raw-event) but applied on [Sentinel-2 L1C data](#sentinel-2-l1c-data).

* ### Sentinel-2 L1C tile
### Sentinel-2 L1C tile
The `Sentinel-2 L1C tile` is the minimum `L1C` product that can be downloaded.

* ### Raw complementary granule
### Raw complementary granule
Given a certain set of bands of interest `[Bx,By,...,Bz]`, `Raw complementarey granules` are the granules adjacents at [Raw-useful-granules](#raw-useful-granule) that that can be used to fill missing pixels of `[By,...,Bz]` bands due to their coregistration with respecto the band `Bx`. For an intuitive example, please, check [Raw events and granules](#raw-events-and-raw-granules).

* ### Raw useful granule
### Raw useful granule
Given a certain set of bands of interest `[Bx,By,...,Bz]`, where `Bx` is the first band in the set, an `Raw useful granule` is one of the collection of [Sentinel-2 Raw granules](#sentinel-2-raw-granule) that compose a [Sentinel-2 Raw event](#sentinel-2-raw-event) whose band `Bx` include (or intersects) a certain area of interest (e.g., an eruption or an area covered by a fire). For an intuitive example, please, check [Raw data events and granules](#raw-events-and-raw-granules).

## Contributing
Expand Down

0 comments on commit 4a04faa

Please sign in to comment.