|
|
# Observation Document Structure
|
|
|
|
|
|
An observation document consists of two well defined parts:
|
|
|
1. a description of the observation
|
|
|
2. a list of links to related files
|
|
|
An observation document consists of several well defined parts:
|
|
|
|
|
|
``` yaml
|
|
|
description:
|
|
|
ATMOS_R0_MAX: 30.2
|
|
|
ATMOS_R0_Min: 3.1
|
|
|
.
|
|
|
.
|
|
|
.
|
|
|
links:
|
|
|
l1_files: [obs_id1,...obs_idN]
|
|
|
obs_previews: [obs_id1,...obs_idN]
|
|
|
.
|
|
|
.
|
|
|
.
|
|
|
tags:
|
|
|
quality_estimation: good/bad
|
|
|
possibly_outdated: True/False
|
|
|
|
|
|
```
|
|
|
Below we have further explanations on the aim of the different blocks.
|
|
|
|
|
|
## Observation Description
|
|
|
Below is a list of fields used to describe and distinguish observations. Each key is specified including data type as well as the unit if the value carries physical significance. The extent and mode of these specifications are inspired by the [IVOA Obs-Core data model](http://www.ivoa.net/documents/ObsCore/). The fields specified below pose a common basis on which to describe observations and should be exhaustive enough to cover most use cases at KIS. In certain cases, if instrument-specific parameters need to be specified to categorize observations, these keys may be extended. ***SPECIFYING THESE KEYS IS MANDATORY FOR EVERY OBSERVATION DESCRIPTION***
|
... | ... | @@ -12,4 +30,13 @@ The specification of these keys also implies a certain standard for the header q |
|
|
### Specifications
|
|
|
* [Mandatory Fields for Observation Descriptions](standards_and_references/Mandatory Fields for Observation Descriptions)
|
|
|
* Instrument-Specific Extensions
|
|
|
* [GRIS](standards_and_recommendations/Instrument-Specific Fields for GRIS Observation Descriptions) |
|
|
\ No newline at end of file |
|
|
* [GRIS](standards_and_recommendations/Instrument-Specific Fields for GRIS Observation Descriptions)
|
|
|
|
|
|
## Links
|
|
|
This block contains a lists of ObjectIds linking to specific binary files in GridFS collections. The struchture is as follows:
|
|
|
|
|
|
``` yaml
|
|
|
type_name: [list of object_ds]
|
|
|
```
|
|
|
|
|
|
The `type_name` keys may only be valid binary resource types as defined in the list of [binary resource types](standards_and_references/Resource-Types). This list is extensible by request and gives an impression over what resources the archive can ingest and visualize. |
|
|
\ No newline at end of file |