From ac7fbcca6efa73c8f9f8b1cc04a6c8e43d026227 Mon Sep 17 00:00:00 2001 From: Alex Gregor <111502950+alexryangregor@users.noreply.github.com> Date: Tue, 21 Nov 2023 12:25:10 +0100 Subject: [PATCH] Update alert_module.rst Proofreading complete. --- docs/source/modules/dwn/alert_module.rst | 98 ++++++++++++------------ 1 file changed, 49 insertions(+), 49 deletions(-) diff --git a/docs/source/modules/dwn/alert_module.rst b/docs/source/modules/dwn/alert_module.rst index 9d89b7d1a9..0b0cb9cb4d 100644 --- a/docs/source/modules/dwn/alert_module.rst +++ b/docs/source/modules/dwn/alert_module.rst @@ -1,14 +1,14 @@ Deforestation alert analysis ============================ -.. attention:: +.. note:: - To use this module, you must register to the NICFI Planet Labs programme and link your account to Google Earth Engine (GEE) (see :doc:`../../setup/nicfi`). + To use this module, you must register to the NICFI – Planet Lab programme and link your account to Google Earth Engine (GEE) (see :doc:`../../setup/nicfi`). Set up ------ -From the SEPAL app dashboard (the purple :icon:`fa-solid fa-wrench` on the left side), search for and select **Deforestation alert analysis**. +In the SEPAL **Apps** dashboard (the purple :icon:`fa-solid fa-wrench` on the left side), select **Deforestation alert analysis**. .. note:: @@ -67,7 +67,7 @@ Follow this process: - Select a driver in the dropdown list. The module will show the area covered by the driver in blue. If you don't see a background color change, your AOI is not covered. - Select a date range. It can be XX days in the past using **Recent** mode or any time in the past using **Historical** mode. -- Using the slider, filter the minimum size of the alerts from 0 to 100 hectares (0 corresponds to no filter at all). +- Using the slider, filter the minimum size of the alerts from 0 to 100 ha (0 corresponds to no filter at all). .. note:: @@ -111,18 +111,18 @@ Follow this process: GLAD-L ###### -By selecting this alert system, you will use GLAD alerts based on Landsat satellites. +By selecting this alert system, you will use Global Land Analysis and Discovery alerts based on Landsat satellites (GLAD-L). - Since the opening of the Landsat archive in 2008, medium spatial resolution data have been available for use in alert-based applications. Since 2013, two Landsat sensors, the Enhanced Thematic Mapper Plus (ETM+) onboard Landsat 7, and the Operational Land Imager (OLI) onboard Landsat 8, have been systematically acquiring global multispectral observations at a 30 metre spatial resolution. The orbits of the two spacecraft are coordinated to enable potential eight-day repeat coverage globally. Given this cadence, the use of Landsat as a near real-time source of land change information is possible. The data displayed and made available here quantify forest disturbance events for the tropics using ETM+ and OLI data as an input. Daily updates are made for areas where quality land observations are acquired. We define forest cover as 5-metre-tall trees with a canopy closure exceeding 30 percent. An alert is defined as any Landsat pixel that experiences a canopy loss in excess of 50 percent cover. + Since the opening of the Landsat archive in 2008, medium spatial resolution data have been available for use in alert-based applications. Since 2013, two Landsat sensors – the Enhanced Thematic Mapper Plus (ETM+) onboard Landsat 7, and the Operational Land Imager (OLI) onboard Landsat 8 – have been systematically acquiring global multispectral observations at a 30 m spatial resolution. The orbits of the two spacecraft are coordinated to enable potential eight-day repeat coverage globally. Given this cadence, the use of Landsat as a near real-time (NRT) source of land change information is possible. The data displayed and made available here quantify forest disturbance events for the tropics using ETM+ and OLI data as an input. Daily updates are made for areas where quality land observations are acquired. We define forest cover as 5 m-tall trees with a canopy closure exceeding 30 percent. An alert is defined as any Landsat pixel that experiences a canopy loss in excess of 50 percent cover. For more information on these alerts, see the `GLAD forest alert page `__. -Radar for Detecting Deforestation (RADD) -######################################## +RADD +#### .. note:: - RADD alerts only cover the tropical part of Africa and the Americas (for more information, see their documenation). + Radar for Detecting Deforestation (RADD) alerts only cover the tropical part of Africa and the Americas (for more information, see their documenation). By selecting this alert system, you will use RADD alerts. @@ -130,14 +130,14 @@ By selecting this alert system, you will use RADD alerts. More information on these alerts can be found on the `Wageningen University portal `__. -Near real-time (NRT) -#################### +NRT +### .. attention:: - This functionality will remain experimental until the SEPAL team removes the **Beta** status on the near real-time alert creation recipe. + This functionality will remain experimental until the SEPAL team removes the **Beta** status on the **NRT alert creation** recipe. -By selecting this alert system, users will use near real-time alerts provided by the SEPAL recipe on a specific AOI for specific dates. You only need to provide access to the alert asset. +By selecting this alert system, users will use NRT alerts provided by the SEPAL recipe on a specific AOI for specific dates. You only need to provide access to the alert asset. .. note:: @@ -148,11 +148,11 @@ GLAD-S .. attention:: - At the time of writing this article (26 April 2022), only northern regions of South America were covered by the alert system. To see the area in the GEE code editor, go to `this link `__ . + At the time of writing this article (26 April 2022), only northern regions of South America were covered by the alert system. To see the area in the GEE code editor, see `this page `__ . -By selecting this alert system, you will use GLAD alerts based on Sentinel-2 satellites. +By selecting this alert system, you will use GLAD alerts based on Sentinel-2 satellites (GLAD-S). - Loss of primary forest is mapped in near real-time at a 10 metre resolution using Sentinel-2 multispectral data. Cloud, shadow and water are detected in each new Sentinel-2 image and a forest loss algorithm is applied to all remaining clear land observations. The algorithm relies on the spectral data in each new image, in combination with spectral metrics from a baseline period of the previous two years. Confidence is built through repeated loss observations in the consequent images. + Loss of primary forest is mapped in NRT at a 10 m resolution using Sentinel-2 multispectral data. Cloud, shadow and water are detected in each new Sentinel-2 image and a forest loss algorithm is applied to all remaining clear land observations. The algorithm relies on the spectral data in each new image, in combination with spectral metrics from a baseline period of the previous two years. Confidence is built through repeated loss observations in the consequent images. CUSUM ##### @@ -161,7 +161,7 @@ CUSUM This will use the :code:`.tif` output of :doc:`cusum`. -Once you've run the CUSUM module, you'll obtain a three-band :code:`.tif` file. Ingest this file in GEE using the `code editor interface `__. Once the map is available in your assets, you can use it in the module. If you don't find the asset in the list, select the :icon:`fa-solid fa-arrows-rotate` icon to reload your asset list. +Once you've run the **CUSUM** module, you'll obtain a three-band :code:`.tif` file (CUSUM refers to cumulative sum). Ingest this file in GEE using the `code editor interface `__. Once the map is available in your assets, you can use it in the module. If you don't find the asset in the list, select the :icon:`fa-solid fa-arrows-rotate` icon to reload your asset list. .. note:: @@ -199,7 +199,7 @@ The source needs to be a GeoJSON file using the following format: .. note:: - The Vietnamese Forest Department is using a specific alert system that works well. Developed in partnership with JICA, the system generates a GEOjson file every ten days. To see the GEE application, go to `this link `__ (note: content is only available in Vietnamese). + The Vietnamese Forest Department is using a specific alert system that works well. Developed in partnership with Japan International Cooperation Agency (JICA), the system generates a GEOjson file every ten days. To see the GEE application, see `this page `__ (note: content is only available in Vietnamese). RECOVER ####### @@ -211,11 +211,11 @@ Save your work by exporting the already interpreted alerts in :code:`.gpkg` form JJ-FAST ####### -By selecting this alert system, you will use the JJ-FAST alerts based on ALOS PALSAR data. +By selecting this alert system, you will use JJ-FAST alerts based on ALOS PALSAR data (JJ-FAST refers to the JICA-JAXA Forest Early Warning System in the Tropics; JAXA refers to Japan Aerospace Exploration Agency). - The JICA-JAXA Forest Early Warning System in the Tropics (JJ-FAST) can detect deforestation sites with sizes larger than 2 hectares (Version 3.0, as of June 2020). Employing microwave remote sensing technology, detections can be made even under thick cloud cover, which is characteristic for tropical regions, especially during rainy seasons. The system detects deforestation by means of L-band (1.25 MHz) Synthetic Aperture Radar (SAR) data acquired by the PALSAR-2 sensor aboard JAXA’s Advanced Land Observing Satellite 2 (ALOS-2) and provides the positioning information of detected sites to users free of charge via its web service. + JJ-FAST can detect deforestation sites with sizes larger than 2 ha (Version 3.0, as of June 2020). Employing microwave remote sensing technology, detections can be made even under thick cloud cover, which is characteristic for tropical regions, especially during rainy seasons. The system detects deforestation by means of L-band (1.25 MHz) Synthetic Aperture Radar (SAR) data acquired by the PALSAR-2 sensor aboard JAXA’s Advanced Land Observing Satellite 2 (ALOS-2) and provides the positioning information of detected sites to users free of charge via its web service. - With frequent updates for the entire tropical forest belt, approximately every one and a half months, JJ-FAST aims to function as an effective deterrent against illegal deforestation activities when it is utilized for forest monitoring in target countries. + With frequent updates for the entire tropical forest belt – approximately every one and a half months – JJ-FAST aims to function as an effective deterrent against illegal deforestation activities when it is utilized for forest monitoring in target countries. Government forest authorities of tropical countries with large forest inventories are expected to be the main users of JJ-FAST. Since polygons of detected deforestation cannot only be conveniently viewed online, but also downloaded for further geographic information system (GIS) analysis, local authorities are able to effectively identify illegal activities by comparing JJ-FAST detections with available national land use maps and/or concession maps. @@ -231,17 +231,17 @@ Once everything is set, select :btn:`select alerts` and the module will start do Metadata -------- -Select :btn:`` to show the metadata panel, which allows you to validate the alerts identified by the driver using Planet VHR (very high-resolution) imagery. All information about the current alert will be displayed in this table: +Select :btn:`` to show the **Metadata** pane, which allows you to validate alerts identified by the driver using Planet VHR (very high-resolution) imagery. The following information about the current alert will be displayed: -- Alert ID: the ID of the alert -- Geometry edition: a button to trigger geometry edition for one single alert -- Date: the identified date of the deforestation event -- Surface: the deforested surface in hectares -- Coordinates: the coordinates of the centre of the alert -- Review: the visual evaluation performed by the user -- Comments: additional comments on the alert +- **Alert ID**: the ID of the alert +- **Geometry edition**: a button to trigger geometry edition for one single alert +- **Date**: the identified date of the deforestation event +- **Surface**: the deforested surface in hectares +- **Coordinates**: the coordinates of the centre of the alert +- **Review**: the visual evaluation performed by the user +- **Comments**: additional comments on the alert -The following sections will cover the editable fields of this table. +The following subsections of this article will cover the editable fields in the **Metadata** pane. .. thumbnail:: https://raw.githubusercontent.com/sepal-contrib/alert_module/master/doc/img/metadata.png :title: The metadata of the alerts @@ -250,7 +250,7 @@ The following sections will cover the editable fields of this table. Alert ID ^^^^^^^^ -In the upper section, the list of alerts are ordered by size. To access them, use the blue arrows or select the caret to select one in the dropdown menu. Once an alert is selected (represented now in orange on the map), the **Planet** panel will open itself in the upper-right corner of the map and the information associated with the alert will be displayed. +In the upper section, the list of alerts are ordered by size. To access them, use the blue arrows or select the caret to select one in the dropdown menu. Once an alert is selected (represented now in orange on the map), the **Planet** pane will open itself in the upper-right corner of the map and the information associated with the alert will be displayed. .. tip:: @@ -265,7 +265,7 @@ Geometry edition Some drivers perform automatic analysis; sometimes the geometry of the alerts poorly represent what you see in the VHR imagery. By using this module, you can redefine the geometry before exporting your results to perfectly fit the deforested area. -- Select :btn:`edit geometry` to open the edition interface (1). +- Select :btn:`edit geometry` to open the **Editing** interface. - Select :btn:`` to start editing; move the white square to add or remove vertices. - To finish, select :btn:`save` to exit editing mode. @@ -282,19 +282,19 @@ Alternatively: :title: The reset process to cancel edits :group: alert-module -Once editing is complete, select the :btn:`finish edition` button in the **Metadata** panel. +Once editing is complete, select the :btn:`finish edition` button in the **Metadata** pane. Date ^^^^ -If the selected driver embeds the dates of the alerts, this field will be already filled with a meaningful date of a deforestation event; if it does not, use the date found in the file title. +If the selected driver embeds the dates of the alerts, this field will be already completed with a meaningful date of a deforestation event; if it does not, use the date found in the file title. Once the deforestation event is identified, update the date value to reflect what you see in the VHR imagery. Click in the field to use the date selector. Review ^^^^^^ -By default, all alerts are set to :code:`unset`. After interpreting Planet imagery, change the value of the radio "review" from: +By default, all alerts are set to :code:`unset`. After interpreting Planet imagery, change the value of the radio review to: - :code:`yes`: the alert is valid, as well as the date - :code:`no`: the alert is not valid (i.e. no deforestation event) @@ -308,27 +308,27 @@ You can fill out this comment section with any aditional information. There are Export ^^^^^^ -In the lower portion of the **Metadata** panel, there are three exportation buttons; each one will export the alerts and their reviews in a specific format. +In the lower portion of the **Metadata** pane, there are three exportation buttons; each one will export the alerts and their reviews in a specific format. -to .kml -####### +Export as .kml +############## Export alerts as a :code:`.kml` file, readable with Google Earth. Each alert will use its ID as the label. You can export them at the beginning of the review if you want to use Google Earth in the review process. -to .gpkg -######## +Export as .gpkg +############### -Export alerts as a :code:`.gpkg` file, readable by any GIS software. It will embed the geometry and all the properties associated with each feature/alert (including the original geometry). This file can be used to save progress and reused as an input of the process. +Export alerts as a :code:`.gpkg` file, readable by any GIS software. It will embed the geometry and all properties associated with each feature/alert (including the original geometry). This file can be used to save progress and reused as an input of the process. -to .csv -####### +Export as .csv +############## Export alerts as a :code:`.csv` file. The properties of each alert are kept; the file represents each feature using the coordinates (latitude/longitude) of the centre of each alert. Planet imagery -------------- -To interprete the validity of the alert, this module is based on Planet NICFI imagery. +To interprete the validity of the alert, this module is based on NICFI – Planet imagery. Parameters ^^^^^^^^^^ @@ -337,9 +337,9 @@ Parameters This is optional. If nothing is set, the module will use Planet NICFI Level 1 data (monthly mosaics). If you have NICFI Level 2 access, providing your API key will grant you access to daily imagery. -Select :btn:`` to access the **Planet API** interface. In this panel, you can connect to your Planet profile using your credentials or your password. +Select :btn:`` to access the **Planet API** interface. In this pane, you can connect to your Planet profile using your credentials or your password. -- Select credential mode between "credentials" and "API key" +- Select credential mode (between **Credentials" and **API key**) - Set and validate your credentials If the icon is green, you are connected. @@ -390,7 +390,7 @@ Select :btn:`` to change the color of the images from CIR t Level 2 (daily) ^^^^^^^^^^^^^^^ -.. attention:: +.. note:: This option is only available for users that have NICFI Level 2 access. @@ -398,9 +398,9 @@ Level 2 data are daily imagery. When an alert is selected, the module will load .. tip:: - Since multiple images are displayed at once, don't hesitate to play with the layer control to hide and show different scenes. + Since multiple images are displayed at once, don't hesitate to play with the **Layer** control to hide and show different scenes. -Navigate through the images using the buttons in the **Planet navigator**. Use :btn:`` and :btn:`` to move one day at a time into the past or future. Use :btn:`` and :btn:`` to move one month at a time into the past or future). The :btn:`` button will set the closest date from the observation date. +Navigate through the images using the buttons in the **Planet navigator**. Use :btn:`` and :btn:`` to move one day at a time into the past or future. Use :btn:`` and :btn:`` to move one month at a time into the past or future). The :btn:`` button will set the closest date from the observation date. .. thumbnail:: https://raw.githubusercontent.com/sepal-contrib/alert_module/master/doc/img/planet_daily.png :title: Planet daily mosaic displayed in CIR