- Title: CADIP
- Identifier: https://home.rs-python.eu/cadip-stac-extension/v1.4.0/schema.json
- Field Name Prefix: cadip
- Scope: Item, Assets
- Extension Maturity Classification: Pilot
- Owner: @vprivat-ads
This document explains the CADIP Extension to the SpatioTemporal Asset Catalog (STAC) specification. Allows to describe Copernicus CADIP sessions from Acquisition Ground Stations as STAC items.
- Examples:
- Item example: Shows the basic usage of the extension in a STAC Item
- JSON Schema
- Changelog
| Field Name | Type | Description |
|---|---|---|
| externalIds[scheme=cadip] | string (uuid) | REQUIRED. UUID for the Session instance within the CADIP |
| cadip:acquisition_id | string / number | REQUIRED. Acquisition id code as from the acquisition plan |
| cadip:num_channels | number | This is the number of channels for the session (1, 2, 3, 4) |
| cadip:station_id | string | Parameter for distinguishing acquisition station. |
| cadip:station_unit_id | string | 2 digit X-band station unit ID |
| cadip:antenna_id | string | Identification of the antenna used |
| cadip:front_end_id | string | FEP identifier. Usually each Station used two acquisition chains |
| cadip:planned_data_start | datetime | Planned Date/Time start of the downlink as extracted from SAPF file |
| cadip:planned_data_stop | datetime | Planned Date/Time stop of the downlink as extracted from SAPF file |
| cadip:retransfer | boolean | Flags whether the session corresponds to a retransfer |
| cadip:antenna_status_ok | boolean | Determines the quality of the acquired pass at Antenna level |
| cadip:front_end_status_ok | boolean | Determines the quality of the acquired pass at FEP level |
| cadip:downlink_status_ok | boolean | Overall status of downlink |
| cadip:delivery_push_ok | boolean | Determines the evaluation of the data dissemination to the DDP |
Universally unique identifier (UUID). It is a local identifier for the Session instance within the CADIP, assigned by the service managing it. This property makes use of the Additional Identifiers extension.
Acquisition id code as from the acquisition plan. This information can be used by the Processing facility to correlate the status of the acquisition with the Acquisition plan if available to the Processing facility
This is the number of channels for the session. Allowed values are: 1, 2, 3, 4.
Parameter for distinguishing acquisition station. Example values:
- INS_ (for SSC Inuvik)
- KSE_ (for SSC Esrange)
- PAR_ (for SSC Punta Arenas)
2 digit X-band station unit ID, that can be used to identify different configurations at station level, if needed (default is 00 if only one configuration is present or the parameter is not needed)
Identification of the antenna used.
Front-End processor (FEP) identifier. Usually each Station used two acquisition chains (one nominal and one in backup). Each acquisition chain contain a FEP ID. This can be used by the station to trace which demodulator was used for a particular dump.
Planned Date/Time start of the downlink as extracted from SAPF file.
Planned Date/Time stop of the downlink as extracted from SAPF file.
Flags whether the session corresponds to a retransfer.
It is set to the value depending on the quality of the acquired pass at Antenna level.
It is set to the value depending on the quality of the acquired pass at Front-End processor by evaluating FER vs. admitted thresholds.
Overall status of downlink: “false” status shall be used if a problem has been encountered during the downlink as a warning for potential data loss or data corruption (in any case processing should be initiated since the problem may not effect science data or telemetry).
It is set to the value depending on the evaluation of the data dissemination to the DDP: “false” status shall be used if a problem has been encountered during the transfer of a DSDB file from the station to the DDP.
| Field Name | Type | Description |
|---|---|---|
| externalIds[scheme=cadip] | string (uuid) | REQUIRED. UUID for the DSDB File instance within the CADIP |
| cadip:channel | number | REQUIRED. This is the channel (1, 2, 3, 4) |
| cadip:block_number | number | REQUIRED. DSDB numbering, always starting from 1 in each session |
| cadip:final_block | boolean | REQUIRED. Set to true if it corresponds to the final file for the session |
| cadip:retransfer | boolean | Flags whether the data file is part of a retransfer |
Universally unique identifier (UUID). Local identifier for the DSDB File instance within the CADIP, assigned by the service managing it. This property makes use of the Additional Identifiers extension.
This is the channel. Allowed values are: 1, 2, 3, 4.
This is the DSDB numbering, always starting from 1 in each session.
BlockNumber shall corresponds to the DSDB numbering. It is related to each channel of the session.
Set to true if it corresponds to the final file for the session.
Flags whether the data file is part of a retransfer.
All contributions are subject to the STAC Specification Code of Conduct. For contributions, please follow the STAC specification contributing guide Instructions for running tests are copied here for convenience.
The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid.
To run tests locally, you'll need npm, which is a standard part of any node.js installation.
First you'll need to install everything with npm once. Just navigate to the root of this repository and on your command line run:
npm installThen to check markdown formatting and test the examples against the JSON schema, you can run:
npm testThis will spit out the same texts that you see online, and you can then go and fix your markdown or examples.
If the tests reveal formatting problems with the examples, you can fix them with:
npm run format-examples
This project is funded by the EU and ESA.