diff --git a/Specifications/Surface-Temperature/PFS.md b/Specifications/Surface-Temperature/PFS.md index 2507866..68a0f1e 100644 --- a/Specifications/Surface-Temperature/PFS.md +++ b/Specifications/Surface-Temperature/PFS.md @@ -7,25 +7,26 @@ subtitle: Surface Temperature ## Document History -| Version | Date | Description of Change | Author | -| :--------------------- | :------------------------------------------ | :----------------------------------------------------------- | :--------------------------------------- | -| 0.0.2 | 23.03.2017 | Zero Draft based on materials provided by Geoscience Australia and the USGS in particular. | Ross | -| | 16.04.2017 | Included document history; | | -| 1.0.0 | 18.04.2017 | Revised to: - Formatting and structure - Included guidance section | Lewis | -| 1.0.1 | 18.04.2017 | Merged ‘geometric source’ and ‘geometric method’ elements. | Lewis | -| 2.0 | 25.08.2017 | Incorporated first round of revisions following feedback from the UK and others. | Lewis | -| 2.1 | 06.09.2017 | Feedback from ESA; removed reference to bands (1.10) as these are not relevant to ST; Feedback on 1.13 included to the effect that ST algorithm may not be supplied at Threshold level. Added qualifying notes to 2.7,2.8. | Lewis | -| 3.0 | 05.12.2017 | Feedback during the teleconference. | Lewis | -| 3.1 | 22.12.2017 | Feedback during and after (emails) the teleconference (05/12/2017) included. | Siqueira | -| 3.2 | 01.08.2018 | Outcome from LSI-VC-6 meeting addressed: *Surface Brightness Temperature (SBT) is not needed as a CARD4L product – there is no clear user base. The Surface Temperature (ST) PFS will be retained, with references to SBT removed in the next update cycle."* Therefore, ST became the minimum requirement (threshold) for CARD4L ST PFS. | Siqueira | -| 3.3 | 21.01.2019 | Feedback from ESA and USGS self-assessment included. Added Annex 1 containing examples (provided by USGS and ESA) on selected requirements. | Siqueira | -| 3.3.1 | 06.02.2019 | Final draft shared with LSI-VC list and LSI-VC-7 meeting participants seeking support for document endorsement at the LSI-VC-7 meeting. | Siqueira | -| 3.3.1 | 20.02.2019 | Comments and suggestions from LSI-VC-7 meeting (minutes) and feedback from USGS incorporated. | Siqueira | -| 3.3.2 | 28.02.2019 | Formatting and verbiage updates for consistency. | Metzger | -| 4.0 | 02.03.2019 | Version endorsed at LSI-VC7 meeting (14Feb 2019) | LSI-VC | -| 4.1 | 26.06.2019 | Added self-assessment columns | Bontje | -| 4.2 | 04.09.2019 | Requirement 3.2 (Corrections for Atmosphere and Emissivity) rewording - agreed at LSI-VC8 meeting. | Siqueira | -| 4.3 4.4 5.0 | 08.05.2020 25.05.2020 08.06.2020 | This review cycle considers feedback received from USGS and ESA after the formal self-assessment for Surface Temperature products (Landsat and Sentinel-2). Minor editorial changes were done throughout the document. Requirements 1.2, 1.14, 1.16 and 2.1 have been updated. Feedback from USGS added (email: 21/05/2020). Tech edit. | Siqueira Siqueira Bontje, Labahn | +| Version | Date | Description of Change | Author | +| :------ | :------------------------ | :----------------------------------------------------------- | :------------- | +| 0.0.2 | 23.03.2017 16.04.2017 | Zero Draft based on materials provided by Geoscience Australia and the USGS in particular. Included document history; | Ross | +| 1.0.0 | 18.04.2017 | Revised to: - Formatting and structure - Included guidance section | Lewis | +| 1.0.1 | 18.04.2017 | Merged ‘geometric source’ and ‘geometric method’ elements. | Lewis | +| 2.0 | 25.08.2017 | Incorporated first round of revisions following feedback from the UK and others. | Lewis | +| 2.1 | 06.09.2017 | Feedback from ESA; removed reference to bands (1.10) as these are not relevant to ST; Feedback on 1.13 included to the effect that ST algorithm may not be supplied at Threshold level. Added qualifying notes to 2.7,2.8. | Lewis | +| 3.0 | 05.12.2017 | Feedback during the teleconference. | Lewis | +| 3.1 | 22.12.2017 | Feedback during and after (emails) the teleconference (05/12/2017) included. | Siqueira | +| 3.2 | 01.08.2018 | Outcome from LSI-VC-6 meeting addressed: *Surface Brightness Temperature (SBT) is not needed as a CARD4L product – there is no clear user base. The Surface Temperature (ST) PFS will be retained, with references to SBT removed in the next update cycle."* Therefore, ST became the minimum requirement (threshold) for CARD4L ST PFS. | Siqueira | +| 3.3 | 21.01.2019 | Feedback from ESA and USGS self-assessment included. Added Annex 1 containing examples (provided by USGS and ESA) on selected requirements. | Siqueira | +| 3.3.1 | 06.02.2019 | Final draft shared with LSI-VC list and LSI-VC-7 meeting participants seeking support for document endorsement at the LSI-VC-7 meeting. | Siqueira | +| 3.3.1 | 20.02.2019 | Comments and suggestions from LSI-VC-7 meeting (minutes) and feedback from USGS incorporated. | Siqueira | +| 3.3.2 | 28.02.2019 | Formatting and verbiage updates for consistency. | Metzger | +| 4.0 | 02.03.2019 | Version endorsed at LSI-VC7 meeting (14 Feb 2019) | LSI-VC | +| 4.1 | 26.06.2019 | Added self-assessment columns | Bontje | +| 4.2 | 04.09.2019 | Requirement 3.2 (Corrections for Atmosphere and Emissivity) rewording - agreed at LSI-VC8 meeting. | Siqueira | +| 4.3 | 08.05.2020 | This review cycle considers feedback received from USGS and ESA after the formal self-assessment for Surface Temperature products (Landsat and Sentinel-2). Minor editorial changes were done throughout the document. Requirements 1.2, 1.14, 1.16 and 2.1 have been updated. | Siqueira | +| 4.4 | 25.05.2020 | Feedback from USGS added (email: 21/05/2020). | Siqueira | +| 5.0 | 08.06.2020 | Tech edit. | Bontje, Labahn | ## Contributing Authors diff --git a/Specifications/Surface-Temperature/annex-1-card4l-requirement-examples.md b/Specifications/Surface-Temperature/annex-1-card4l-requirement-examples.md index b929145..78d7980 100644 --- a/Specifications/Surface-Temperature/annex-1-card4l-requirement-examples.md +++ b/Specifications/Surface-Temperature/annex-1-card4l-requirement-examples.md @@ -1,54 +1,339 @@ - -# Annex 1 – CARD4L Requirement Examples (Surface Temperature) -## General Metadata - -|**#**|**Item**|**Example 1**|**Example 2**| -| :-: | :-: | :-: | :-: | -|**1.1**|**Traceability**|

Example of measurement traceability in metadata:

` `LC08ST

` `Surface Temperature

` `ST

` `

` `none

` `temperature (kelvin)

` `

` `st\_1.3.0

` `2018-11-30T04:47:38Z

Example of measurement uncertainty in metadata:

` `LC08STQA

` `Surface temperature quality band

` `STQA

` `

` `none

` `temperature (kelvin)

` `

` `st\_1.3.0

` `2018-11-30T04:47:38Z

|NA| -|**1.2**|**Metadata Machine Readability**|NA|NA| -|**1.3**|**Data Collection Time**|

Example of scene center time (UTC):

17:23:57.201686Z

|The granule start and end times are contained in the XML metadata:
` `
` `
` `
` `
` `2018-10-07T05:04:50.425838Z
` `2018-10-07T05:07:50.425838Z
` `

` `

` `

` `


Per pixel times are derived using information from the "time\_in.nc" and “indices\_in.nc” datafiles following a prescribed recipe| -|**1.4**|**Geographical Area**|

Example of the bounding coordinates in decimal degrees (WGS84):

` `-99.9109607425

` `-98.0134952569

` `43.3609828699

` `41.9778528562

Example of the corner points in the map projection system (Albers):

|NA| -|**1.5**|**Coordinate Reference System**|

Example of the projected coordinate system info:

|NA| -|**1.6**|**Map Projection**|

Example:

` `

` `

` `UL

` `

` `29.500000

` `45.500000

` `-96.000000

` `23.000000

` `0.000000

` `0.000000

` `

|NA| -|**1.7**|**Geometric Correction Source**|

Example of elevation source:

GLS2000

|The XML wrapper provides the source of the geometric calibration:


` `
` `
` `
` `
` `

` `


| -|**1.8**|**Geometric Accuracy of the Data**|

Example:

9.021

6.864

5.854

|NA| -|**1.9**|**Instrument**|

Example:

LANDSAT\_8

OLI/TIRS\_Combined

|

The XML wrapper provides the instrument details:

` `

` `

` `

` `

` `2016-011A

` `Sentinel-3

` `A

` `

` `Sea and Land Surface Temperature Radiometer

` `Earth Observation

` `

` `

` `

` `

` `

| -|**1.10**|**Spectral Bands**|NA|NA| -|**1.11**|**Sensor Calibration**|

Example:

LC08CPF\_20180101\_20180331\_01.02

|NA| -|**1.12**|**Radiometric Accuracy**|NA|NA| -|**1.13**|**Algorithms**|

Example for Surface Temperature algorithm version:

st\_1.3.0

|NA| -|**1.14**|**Auxiliary Data**|NA|All Auxiliary Datafiles (ADFs) are listed in the XML wrapper:
` `
` `
` `| -|**1.15**|**Processing Chain Provenance**|NA|Processing chain provenance information is stored in the XML wrapper under the following tag:
` `| -|**1.16**|**Data Access**|NA|NA| -|**1.17**|**Overall Data Quality**|NA|Overall data quality information is stored in the XML wrapper under the following tag:
` `| - - -## Per-Pixel Metadata - -|**#**|**Item**|**Example 1**|**Example 2**| -| :-: | :-: | :-: | :-: | -|**2.1**|**Metadata Machine Readability**|NA|NA| -|**2.2**|**No Data**|

Example of the fill\_value specified for each band in metadata:

` `LC08ST

` `Surface Temperature

` `ST

` `

` `none

` `temperature (kelvin)

` `

` `st\_1.3.0

` `2018-11-30T04:47:38Z

|

The "flags\_in.nc" datafile contains per-pixel information on "no / bad data through saturation / incomplete testing etc". The following field has an "unfilled" flag:

` `ushort confidence\_in(rows, columns) ;
` `confidence\_in:flag\_masks = 1US, 2US, 4US, 8US, 16US, 32US, 64US, 128US, 256US, 512US, 1024US, 2048US, 4096US, 8192US, 16384US, 32768US ;
` `confidence\_in:flag\_meanings = "coastline ocean tidal land inland\_water unfilled spare spare cosmetic duplicate day twilight sun\_glint snow summary\_cloud summary\_pointing" ;

| -|**2.3**|**Incomplete Testing**|NA|The "flags\_in.nc" datafile contains per-pixel information on "no / bad data through saturation / incomplete testing etc". The following field has an "unfilled" flag:

` `ushort confidence\_in(rows, columns) ;
` `confidence\_in:flag\_masks = 1US, 2US, 4US, 8US, 16US, 32US, 64US, 128US, 256US, 512US, 1024US, 2048US, 4096US, 8192US, 16384US, 32768US ;
` `confidence\_in:flag\_meanings = "coastline ocean tidal land inland\_water unfilled spare spare cosmetic duplicate day twilight sun\_glint snow summary\_cloud summary\_pointing”;| -|**2.4**|**Saturation**|

Example of RADSATQA band showing the saturation information for the thermal bands used for Surface Temperature calculation:

` `LC08RADSAT

` `saturation mask

` `RADSATQA

` `

` `none

` `bitmap

` `

` `Data Fill Flag (0 = valid data, 1 = invalid data)

` `Band 1 Data Saturation Flag (0 = valid data, 1 = saturated data)

` `Band 2 Data Saturation Flag (0 = valid data, 1 = saturated data)

` `Band 3 Data Saturation Flag (0 = valid data, 1 = saturated data)

` `Band 4 Data Saturation Flag (0 = valid data, 1 = saturated data)

` `Band 5 Data Saturation Flag (0 = valid data, 1 = saturated data)

` `Band 6 Data Saturation Flag (0 = valid data, 1 = saturated data)

` `Band 7 Data Saturation Flag (0 = valid data, 1 = saturated data)

` `N/A

` `Band 9 Data Saturation Flag (0 = valid data, 1 = saturated data)

` `Band 10 Data Saturation Flag (0 = valid data, 1 = saturated data)

` `Band 11 Data Saturation Flag (0 = valid data, 1 = saturated data)

` `

` `LaSRC\_1.3.0

` `2018-11-30T04:47:38Z

|The "flags\_in.nc" datafile contains per-pixel information on "no / bad data through saturation / incomplete testing etc". The following field has an "unfilled" flag:

` `ushort confidence\_in(rows, columns) ;
` `confidence\_in:flag\_masks = 1US, 2US, 4US, 8US, 16US, 32US, 64US, 128US, 256US, 512US, 1024US, 2048US, 4096US, 8192US, 16384US, 32768US ;
` `confidence\_in:flag\_meanings = "coastline ocean tidal land inland\_water unfilled spare spare cosmetic duplicate day twilight sun\_glint snow summary\_cloud summary\_pointing" ;| -|**2.5**|**Cloud**|

Example of PIXELQA showing the bit value for cloud pixels (as well as cloud and cirrus confidence):

` `LC08PQA

` `level-2 pixel quality band

` `PIXELQA

` `

` `none

` `quality/feature classification

` `

` `fill

` `clear

` `water

` `cloud shadow

` `snow

` `cloud

` `cloud confidence

` `cloud confidence

` `cirrus confidence

` `cirrus confidence

` `terrain occlusion

` `unused

` `unused

` `unused

` `unused

` `unused

` `

` `generate\_pixel\_qa\_1.6.0

` `2018-11-30T04:47:38Z

|The "flags\_in.nc" datafile contains all the cloud masking flags
Three fields are relevant: i) cloud\_in; ii) confidence\_in; and iii) bayes\_in

The "cloud\_in" field contains all the individual threshold-based mask:
flag\_masks = 1US, 2US, 4US, 8US, 16US, 32US, 64US, 128U S, 256US, 512US, 1024US, 2048US, 4096US, 8192US, 16384US, 32768US ;
cloud\_in:flag\_meanings = "visible 1.37\_threshold 1.6\_small\_histo gram 1.6\_large\_histogram 2.25\_small\_histogram 2.25\_large\_histogram 11\_spatial\_co herence gross\_cloud thin\_cirrus medium\_high fog\_low\_stratus 11\_12\_view\_differenc e 3.7\_11\_view\_difference thermal\_histogram spare spare"

The "confidence\_in" field contains the "summary\_cloud\_mask" from the most appropriate cloud\_in flags; the value of the bit is 16384US

The "bayes\_in" field contains the "single\_moderate" probabilistic cloud flag; the value of the bit is 2UB| -|**2.6**|**Cloud Shadow**|Please see the cloud shadow part in the example provided in requirement 2.5|NA| -|**2.7**|**Snow/Ice Mask**|Please see the snow part in the example provided in requirement 2.5|NA| -|**2.8**|**Solar and Viewing Geometry**|NA|NA| - - -## Radiometric and Atmospheric Corrections - -|**#**|**Item**|**Example 1**|**Example 2**| -| :-: | :-: | :-: | :-: | -|**3.1**|**Measurement**|NA|NA| -|**3.2**|**Corrections for Atmosphere (and Emissivity in the Case of ST)**|

NA

|NA| -|**3.3**|**Measurement Uncertainty**|NA|NA| - -## Geometric Corrections - -|**#**|**Item**|**Example 1**|**Example 2**| -| :-: | :-: | :-: | :-: | -|**4.1**|**Geometric Correction**|NA|NA| +## Annex 1: CARD4L Requirement Examples +### 1. General Metadata +#### 1.1 Traceability + +Example of measurement traceability in metadata: + +```xml + + LC08ST + Surface Temperature + ST + + none + temperature (kelvin) + + st_1.3.0 + 2018-11-30T04:47:38Z + +``` + +Example of measurement uncertainty in metadata: + +```xml + + LC08STQA + Surface temperature quality band + STQA + + none + temperature (kelvin) + + st_1.3.0 + 2018-11-30T04:47:38Z + +``` +#### 1.3 Data Collection Time + +Example of scene center time (UTC): + +```xml +17:23:57.201686Z +``` + +The granule start and end times are contained in the XML metadata: + +```xml + + + + + 2018-10-07T05:04:50.425838Z + 2018-10-07T05:07:50.425838Z + + + + +``` + +Per pixel times are derived using information from the "time_in.nc" and “indices_in.nc” datafiles following a prescribed recipe. + +#### 1.4 Geographical Area + +Example of the bounding coordinates in decimal degrees (WGS84): + +```xml + + -99.9109607425 + -98.0134952569 + 43.3609828699 + 41.9778528562 + +``` + +Example of the corner points in the map projection system (Albers): + +```xml + + +``` + +#### 1.6 Map Projection + +```xml + + + + UL + + 29.500000 + 45.500000 + -96.000000 + 23.000000 + 0.000000 + 0.000000 + + +``` + +#### 1.7 Geometric Correction Source + +Example of elevation source: + +```xml +GLS2000 +``` + +The XML wrapper provides the source of the geometric calibration: + +```xml + + + + + + + + +``` + +#### 1.8 Geometric Accuracy of the Data + +```xml +9.021 +6.864 +5.854 +``` + +#### 1.9 Instrument + +```xml +LANDSAT_8 +OLI/TIRS_Combined +``` + +The XML wrapper provides the instrument details: + +```xml + + + + + 2016-011A + Sentinel-3 + A + + Sea and Land Surface Temperature Radiometer + Earth Observation + + + + + +``` + +#### 1.11 Sensor Calibration + +```xml +LC08CPF_20180101_20180331_01.02 +``` + +#### 1.13 Algorithms + +Example for Surface Temperature algorithm version: + +```xml +st_1.3.0 +``` + +#### 1.14 Auxiliary Data + +All Auxiliary Datafiles (ADFs) are listed in the XML wrapper: + +```xml + + + +``` + +#### 1.15 Processing Chain Provenance + +Processing chain provenance information is stored in the XML wrapper under the following tag: + +```xml + +``` + +#### 1.17 Overall Data Quality + +Overall data quality information is stored in the XML wrapper under the following tag: + +```xml + +``` + +### 2. Per-Pixel Metadata + +#### 2.2 No Data + +Example of the fill_value specified for each band in metadata: + +```xml + + LC08ST + Surface Temperature + ST + + none + temperature (kelvin) + + st_1.3.0 + 2018-11-30T04:47:38Z + +``` + +The "flags_in.nc" datafile contains per-pixel information on "no / bad data through saturation / incomplete testing etc". The following field has an "unfilled" flag: + +```netcdf +ushort confidence_in(rows, columns) ; + confidence_in:flag_masks = 1US, 2US, 4US, 8US, 16US, 32US, 64US, 128US, 256US, 512US, 1024US, 2048US, 4096US, 8192US, 16384US, 32768US ; + confidence_in:flag_meanings = "coastline ocean tidal land inland_water unfilled spare spare cosmetic duplicate day twilight sun_glint snow summary_cloud summary_pointing" ; +``` + +#### 2.3 Incomplete Testing + +The "flags_in.nc" datafile contains per-pixel information on "no / bad data through saturation / incomplete testing etc". The following field has an "unfilled" flag: + +```netcdf +ushort confidence_in(rows, columns) ; + confidence_in:flag_masks = 1US, 2US, 4US, 8US, 16US, 32US, 64US, 128US, 256US, 512US, 1024US, 2048US, 4096US, 8192US, 16384US, 32768US ; + confidence_in:flag_meanings = "coastline ocean tidal land inland_water unfilled spare spare cosmetic duplicate day twilight sun_glint snow summary_cloud summary_pointing”; +``` + +#### 2.4 Saturation + +Example of RADSATQA band showing the saturation information for the thermal bands used for Surface Temperature calculation: + +```xml + + LC08RADSAT + saturation mask + RADSATQA + + none + bitmap + + Data Fill Flag (0 = valid data, 1 = invalid data) + Band 1 Data Saturation Flag (0 = valid data, 1 = saturated data) + Band 2 Data Saturation Flag (0 = valid data, 1 = saturated data) + Band 3 Data Saturation Flag (0 = valid data, 1 = saturated data) + Band 4 Data Saturation Flag (0 = valid data, 1 = saturated data) + Band 5 Data Saturation Flag (0 = valid data, 1 = saturated data) + Band 6 Data Saturation Flag (0 = valid data, 1 = saturated data) + Band 7 Data Saturation Flag (0 = valid data, 1 = saturated data) + N/A + Band 9 Data Saturation Flag (0 = valid data, 1 = saturated data) + Band 10 Data Saturation Flag (0 = valid data, 1 = saturated data) + Band 11 Data Saturation Flag (0 = valid data, 1 = saturated data) + + LaSRC_1.3.0 + 2018-11-30T04:47:38Z + +``` + +The "flags_in.nc" datafile contains per-pixel information on "no / bad data through saturation / incomplete testing etc". The following field has an "unfilled" flag: + +```netcdf +ushort confidence_in(rows, columns) ; + confidence_in:flag_masks = 1US, 2US, 4US, 8US, 16US, 32US, 64US, 128US, 256US, 512US, 1024US, 2048US, 4096US, 8192US, 16384US, 32768US ; + confidence_in:flag_meanings = "coastline ocean tidal land inland_water unfilled spare spare cosmetic duplicate day twilight sun_glint snow summary_cloud summary_pointing" ; +``` + +#### 2.5 Cloud + +Example of PIXELQA showing the bit value for cloud pixels (as well as cloud and cirrus confidence): + +```xml + + LC08PQA + level-2 pixel quality band + PIXELQA + + none + quality/feature classification + + fill + clear + water + cloud shadow + snow + cloud + cloud confidence + cloud confidence + cirrus confidence + cirrus confidence + terrain occlusion + unused + unused + unused + unused + unused + + generate_pixel_qa_1.6.0 + 2018-11-30T04:47:38Z + +``` + +The "flags_in.nc" datafile contains all the cloud masking flags. Three fields are relevant: + +1. cloud_in +2. confidence_in +3. bayes_in + +The "cloud_in" field contains all the individual threshold-based mask: + +```xml +flag_masks = 1US, 2US, 4US, 8US, 16US, 32US, 64US, 128US, 256US, 512US, 1024US, 2048US, 4096US, 8192US, 16384US, 32768US ; +cloud_in:flag_meanings = "visible 1.37_threshold 1.6_small_histogram 1.6_large_histogram 2.25_small_histogram 2.25_large_histogram 11_spatial_coherence gross_cloud thin_cirrus medium_high fog_low_stratus 11_12_view_difference 3.7_11_view_difference thermal_histogram spare spare" +``` + +The "confidence_in" field contains the "summary_cloud_mask" from the most appropriate cloud_in flags; the value of the bit is 16384US. +The "bayes_in" field contains the "single_moderate" probabilistic cloud flag; the value of the bit is 2UB. + +#### 2.6 Cloud Shadow + +Please see the cloud shadow part in the example provided in requirement 2.5 + +#### 2.7 Snow/Ice Mask + +Please see the snow part in the example provided in requirement 2.5 + +### 3. Radiometric and Atmospheric Corrections + +*No examples provided* + +### 4. Geometric Corrections + +*No examples provided*