This is the beta version of CAOM documentation generated from the VO-DML description of the data model. It is currently missing some classes and descriptions and does not perfectly match the existing implementations.
Authors | : | Patrick Dowler, Canadian Astronomy Data Centre |
Date | : | 2017-01-26T15:00:00 |
Version | : | 2.2 |
Abstract | : | a general purpose data model for use as the core data model of an astronomical data centre |
The following sub-sections present all packages in the model with their types. The packages are listed here in alphabetical order. Each sub-section contains a description of the package and a table containing its various features.
Model | caom2 | |
child package(s) | caom2 | |
Primitive types | uuid |
vodml-id | uuid |
description | represents a 128-bit binary ID in the canonical ascii UUID format |
vodml-id | caom2 | |
description | this package contains the CAOM object types and enumerations | |
parent | caom2 | |
Object types | Algorithm Artifact CaomEntity Chunk CompositeObservation DataQuality Energy Environment Instrument Metrics Observation Part Plane Polarization Position Proposal Provenance Requirements SimpleObservation Target TargetPosition Telescope Time | |
Enumerations | CalibrationLevel DataProductType EnergyBand ObservationIntentType PolarizationState ProductType Quality ReleaseType Status TargetType | |
child package(s) | types wcs |
vodml-id | Algorithm | |||||||||||||||||||||
description | TODO: describe this | |||||||||||||||||||||
|
vodml-id | Artifact | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | a physical product (typically a file) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | CalibrationLevel | ||
description | the degree to which data has been calibrated to remove instrumental effects; issue: there is no way to convey the integer serialised values here | ||
package | caom2 | ||
literals | |||
name | feature | value | |
RAW_INSTRUMENTAL | vodml-id | CalibrationLevel.RAW_INSTRUMENTAL | |
description | raw data in some opaque instrument-specific format | ||
RAW_STANDARD | vodml-id | CalibrationLevel.RAW_STANDARD | |
description | raw data in a common format | ||
CALIBRATED | vodml-id | CalibrationLevel.CALIBRATED | |
description | standard calibration steps have been applied | ||
PRODUCT | vodml-id | CalibrationLevel.PRODUCT | |
description | additional non-standard calibration steps have been applied |
vodml-id | CaomEntity | |||||||||||||||||||||||||||||||||||||||||||
description | base entity class to support persistence; entity attributes are generally set or updated by persistence implementations | |||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | Chunk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | a quantitatively defined subsection of a data array; the part contains the whole array | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | CompositeObservation | |||||||||||||||||||||||||
description | an observation made by combining other observations | |||||||||||||||||||||||||
|
vodml-id | DataProductType | ||
description | a general description of the type or structure of the data; work-around: using the name of the literal to convey the serialised value | ||
package | caom2 | ||
literals | |||
name | feature | value | |
image | vodml-id | DataProductType.IMAGE | |
description | TODO | ||
spectrum | vodml-id | DataProductType.SPECTRUM | |
description | TODO | ||
timeseries | vodml-id | DataProductType.TIMESERIES | |
description | TODO | ||
visibility | vodml-id | DataProductType.VISIBILITY | |
description | TODO | ||
eventlist | vodml-id | DataProductType.EVENTLIST | |
description | TODO | ||
cube | vodml-id | DataProductType.CUBE | |
description | TODO | ||
catalog | vodml-id | DataProductType.CATALOG | |
description | TODO |
vodml-id | DataQuality | |||||||||||||||||||||
description | description of the data quality | |||||||||||||||||||||
|
vodml-id | Energy | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | description of the energy coverage and sampling of the data | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | EnergyBand | ||
description | a general set of energy regions that span the electromagnetic spectrum; work-around: using the name of the literal to convey the serialised value | ||
package | caom2 | ||
literals | |||
name | feature | value | |
Radio | vodml-id | EnergyBand.RADIO | |
description | wavelength greater than ~10mm | ||
Millimeter | vodml-id | EnergyBand.MILLIMETER | |
description | wavelength from 0.1 to 10mm | ||
Infrared | vodml-id | EnergyBand.INFRARED | |
description | wavelength from 1um to 0.1mm | ||
Optical | vodml-id | EnergyBand.OPTICAL | |
description | wavelength from 300nm to 1um | ||
UV | vodml-id | EnergyBand.UV | |
description | wavelength from 100 to 300nm | ||
EUV | vodml-id | EnergyBand.EUV | |
description | wavelength from 10 to 100nm | ||
Xray | vodml-id | EnergyBand.XRAY | |
description | energy from 0.12 to 120keV | ||
Gammaray | vodml-id | EnergyBand.GAMMARAY | |
description | energy greater than ~120keV |
vodml-id | Environment | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | collection of measured quantities that characterise the environment at the time of observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | Instrument | ||||||||||||||||||||||||||||||
description | description of the instrument used to acquire the data | ||||||||||||||||||||||||||||||
|
vodml-id | Metrics | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | collection of measured quantities that describe the content of the data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | Observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | an observation is a single top-level entry in an astronomy data centre | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | ObservationIntentType | ||
description | the intent of the original observer in acquiring this observation; work-around: using the name of the literal to convey the serialised value | ||
package | caom2 | ||
literals | |||
name | feature | value | |
science | vodml-id | ObservationIntentType.SCIENCE | |
description | the intent of this observation was to create science data | ||
calibration | vodml-id | ObservationIntentType.CALIBRATION | |
description | the intent of this observation was to create calibration data |
vodml-id | Part | |||||||||||||||||||||||||||||||||||||||||||||||||||
description | format-specific name of this part; this is typically something like a FITS extension or a file within a container | |||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | Plane | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | a component of an observation that describes one product of the observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | Polarization | ||||||||||||||||||||||||||||||
description | description of polarization measurements included in the data | ||||||||||||||||||||||||||||||
|
vodml-id | PolarizationState | ||
description | a classification of polarization (Stokes states plus other related quantities); work-around: using the name of the literal to convey the serialised value | ||
package | caom2 | ||
literals | |||
name | feature | value | |
I | vodml-id | PolarizationState.I | |
description | TODO | ||
Q | vodml-id | PolarizationState.Q | |
description | TODO | ||
U | vodml-id | PolarizationState.U | |
description | TODO | ||
V | vodml-id | PolarizationState.V | |
description | TODO | ||
RR | vodml-id | PolarizationState.RR | |
description | TODO | ||
LL | vodml-id | PolarizationState.LL | |
description | TODO | ||
RL | vodml-id | PolarizationState.RL | |
description | TODO | ||
LR | vodml-id | PolarizationState.LR | |
description | TODO | ||
XX | vodml-id | PolarizationState.XX | |
description | TODO | ||
YY | vodml-id | PolarizationState.YY | |
description | TODO | ||
XY | vodml-id | PolarizationState.XY | |
description | TODO | ||
YX | vodml-id | PolarizationState.YX | |
description | TODO | ||
POLI | vodml-id | PolarizationState.POLI | |
description | TODO | ||
FPOLI | vodml-id | PolarizationState.FPOLI | |
description | TODO | ||
POLA | vodml-id | PolarizationState.POLA | |
description | TODO | ||
EPOLI | vodml-id | PolarizationState.EPOLI | |
description | TODO | ||
CPOLI | vodml-id | PolarizationState.CPOLI | |
description | TODO | ||
NPOLI | vodml-id | PolarizationState.NPOLI | |
description | TODO |
vodml-id | Position | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | description of the position coverage and sampling of the data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | ProductType | ||
description | a general classification of the content of data files or parts thereof; work-around: using the name of the literal to convey the serialised value | ||
package | caom2 | ||
literals | |||
name | feature | value | |
science | vodml-id | ProductType.SCIENCE | |
description | this is the science data; data values come from extraterrestrial photons | ||
calibration | vodml-id | ProductType.CALIBRATION | |
description | this is calibration data; | ||
info | vodml-id | ProductType.INFO | |
description | the content provides additional information: explanations, logs, etc | ||
preview | vodml-id | ProductType.PREVIEW | |
description | this is non-science preview data | ||
thumbnail | vodml-id | ProductType.THUMBNAIL | |
description | this is a small non-science preview data; small means that this preview is suitable to display in a popup window or with multiple displayed together | ||
noise | vodml-id | ProductType.NOISE | |
description | this is auxiliary data with some measure of the noise; to be used when analysing the science data | ||
weight | vodml-id | ProductType.WEIGHT | |
description | this is auxiliary data which provides weight values; to be used when analysing the science data | ||
auxiliary | vodml-id | ProductType.AUXILIARY | |
description | this is auxiliary data; to be used when analysing the science data |
vodml-id | Proposal | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | description of the science proposal or programme that initiated the observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | Provenance | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | description of how this data was produced | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | Quality | ||
description | a general indicator of data quality; work-around: using the name of the literal to convey the serialised value | ||
package | caom2 | ||
literals | |||
name | feature | value | |
junk | vodml-id | Quality.JUNK | |
description | this data cannot be used for anything |
vodml-id | ReleaseType | ||
description | a flag indicating how an artifact is classified to determine access permissions; work-around: using the name of the literal to convey the serialised value | ||
package | caom2 | ||
literals | |||
name | feature | value | |
data | vodml-id | ReleaseType.DATA | |
description | access permission checks assume the protected item is data | ||
meta | vodml-id | ReleaseType.META | |
description | access permission checks assume the protected item is metadata |
vodml-id | Requirements | |||||||||||||||||||||
description | description of the observational requirements specified by the proposal | |||||||||||||||||||||
|
vodml-id | SimpleObservation | ||||||||||
description | an observation created directly by operating an instrument or process | ||||||||||
|
vodml-id | Status | ||
description | a status flag indicating degree of success; work-around: using the name of the literal to convey the serialised value | ||
package | caom2 | ||
literals | |||
name | feature | value | |
fail | vodml-id | Status.FAIL | |
description | TBD |
vodml-id | Target | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | description of the target of an observation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | TargetPosition | |||||||||||||||||||||||||||||||||||||||
description | description of the intended position of the observation (not the position of the intended or actual target) | |||||||||||||||||||||||||||||||||||||||
|
vodml-id | TargetType | ||
description | the type of target being observed; qualifies target name; work-around: using the name of the literal to convey the serialised value | ||
package | caom2 | ||
literals | |||
name | feature | value | |
object | vodml-id | TargetType.OBJECT | |
description | the target of the observation is an astronomical object | ||
field | vodml-id | TargetType.FIELD | |
description | the target of the observation is a defined region on the sky |
vodml-id | Telescope | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | description of the telescope where an observation was created | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | Time | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | description of the time coverage and sampling of the data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | types | |
description | data types | |
parent | caom2 | |
Data types | Circle Interval Point Polygon Shape SubInterval | |
Parent package | caom2 |
vodml-id | Circle | |||||||||||||||||||||||||
description | [TODO add description!] | |||||||||||||||||||||||||
|
vodml-id | Interval | ||||||||||||||||||||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | Point | ||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||
|
vodml-id | Polygon | |||||||||||||||||||||||||
description | [TODO add description!] | |||||||||||||||||||||||||
|
vodml-id | Shape | |||||||||||||||||||||||||||||||||||||||||||
description | [TODO add description!] | |||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | SubInterval | ||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||
|
vodml-id | wcs | |
description | World Coordinate System (WCS) data types | |
parent | caom2 | |
Object types | ObservableAxis PolarizationWCS SpatialWCS SpectralWCS TemporalWCS | |
Data types | Axis Coord2D CoordAxis1D CoordAxis2D CoordBounds1D CoordBounds2D CoordError CoordFunction1D CoordFunction2D CoordRange1D CoordRange2D Dimension2D EnergyTransition RefCoord Slice | |
Parent package | caom2 |
vodml-id | Axis | ||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||
|
vodml-id | Coord2D | ||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||
|
vodml-id | CoordAxis1D | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | [TODO add description!] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | CoordAxis2D | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | [TODO add description!] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | CoordBounds1D | |||||||||||||||||||||
description | [TODO add description!] | |||||||||||||||||||||
|
vodml-id | CoordBounds2D | |||||||||||||||||||||
description | [TODO add description!] | |||||||||||||||||||||
|
vodml-id | CoordError | ||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||
|
vodml-id | CoordFunction1D | |||||||||||||||||||||||||||||||||||||||
description | [TODO add description!] | |||||||||||||||||||||||||||||||||||||||
|
vodml-id | CoordFunction2D | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | CoordRange1D | ||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||
|
vodml-id | CoordRange2D | ||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||
|
vodml-id | Dimension2D | ||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||
|
vodml-id | EnergyTransition | ||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||
|
vodml-id | ObservableAxis | ||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||
|
vodml-id | PolarizationWCS | |||||||||||||||||||||
description | [TODO add description!] | |||||||||||||||||||||
|
vodml-id | RefCoord | ||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||
|
vodml-id | Slice | ||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||
|
vodml-id | SpatialWCS | ||||||||||||||||||||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | SpectralWCS | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | TemporalWCS | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | [TODO add description!] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vodml-id | feature type | description |
vo-dml:model | a general purpose data model for use as the core data model of an astronomical data centre | |
uuid | primitiveType | represents a 128-bit binary ID in the canonical ascii UUID format |
caom2 | package | this package contains the CAOM object types and enumerations |
Algorithm | objectType | TODO: describe this |
Algorithm.name | attribute | |
Artifact | objectType | a physical product (typically a file) |
Artifact.contentLength | attribute | the size of the resolved artifact; typically file size in bytes) |
Artifact.contentType | attribute | label specifying the format of the resolved artifact; typically a MIME-type |
Artifact.parts | composition | the component parts of this artifact |
Artifact.productType | attribute | TODO: define this |
Artifact.releaseType | attribute | field indicating how access permissions for this artifact are determined |
Artifact.uri | attribute | an identifier that resolves to the storage location of the artifact |
CalibrationLevel | enumeration | the degree to which data has been calibrated to remove instrumental effects; issue: there is no way to convey the integer serialised values here |
CalibrationLevel.CALIBRATED | literal | standard calibration steps have been applied |
CalibrationLevel.PRODUCT | literal | additional non-standard calibration steps have been applied |
CalibrationLevel.RAW_INSTRUMENTAL | literal | raw data in some opaque instrument-specific format |
CalibrationLevel.RAW_STANDARD | literal | raw data in a common format |
CaomEntity | objectType | base entity class to support persistence; entity attributes are generally set or updated by persistence implementations |
CaomEntity.id | attribute | globally unique identifier (primary key) |
CaomEntity.lastModified | attribute | timestamp of last modification of this entity |
CaomEntity.maxLastModified | attribute | maximum timestamp of last modification of this entity and all child entities |
Chunk | objectType | a quantitatively defined subsection of a data array; the part contains the whole array |
Chunk.energy | composition | spectral WCS description of the data array or subsection thereof |
Chunk.energyAxis | attribute | index of the energy axis |
Chunk.naxis | attribute | number of axes in the data array |
Chunk.observable | composition | observable description of the data array or subsection thereof |
Chunk.observableAxis | attribute | index of the observable axis |
Chunk.poslarization | composition | polarization WCS description of the data array or subsection thereof |
Chunk.polarizationAxis | attribute | index of the polarization axis |
Chunk.position | composition | spatial WCS description of the data array or subsection thereof |
Chunk.positionAxis1 | attribute | index of the first position axis |
Chunk.positionAxis2 | attribute | index of the second position axis |
Chunk.productType | attribute | product type where it differs from the parent part |
Chunk.time | composition | temporal WCS description of the data array or subsection thereof |
Chunk.timeAxis | attribute | index of the time axis |
CompositeObservation | objectType | an observation made by combining other observations |
CompositeObservation.members | attribute | members are the observations grouped together by the algorithm that defines the composite |
DataProductType | enumeration | a general description of the type or structure of the data; work-around: using the name of the literal to convey the serialised value |
DataProductType.CATALOG | literal | TODO |
DataProductType.CUBE | literal | TODO |
DataProductType.EVENTLIST | literal | TODO |
DataProductType.IMAGE | literal | TODO |
DataProductType.SPECTRUM | literal | TODO |
DataProductType.TIMESERIES | literal | TODO |
DataProductType.VISIBILITY | literal | TODO |
DataQuality | objectType | description of the data quality |
DataQuality.flag | attribute | flag indicating the data quality |
Energy | objectType | description of the energy coverage and sampling of the data |
Energy.bandpassName | attribute | telescope- and instrument-specific name for the energy band included |
Energy.bounds | attribute | energy bounds that include the data |
Energy.dimension | attribute | number of measurements (pixels) on the energy axis |
Energy.emBand | attribute | standard name of the energy regime included in the data |
Energy.freqSampleSize | attribute | median pixekl size expressed in frequency |
Energy.freqWidth | attribute | width of the bounding interval expressed in frequency |
Energy.resolvingPower | attribute | median spectral resolving power per pixel |
Energy.restwav | attribute | rest wavelength of the target energy transition |
Energy.sampleSize | attribute | median pixel size |
Energy.transition | attribute | target energy transition for this data |
EnergyBand | enumeration | a general set of energy regions that span the electromagnetic spectrum; work-around: using the name of the literal to convey the serialised value |
EnergyBand.EUV | literal | wavelength from 10 to 100nm |
EnergyBand.GAMMARAY | literal | energy greater than ~120keV |
EnergyBand.INFRARED | literal | wavelength from 1um to 0.1mm |
EnergyBand.MILLIMETER | literal | wavelength from 0.1 to 10mm |
EnergyBand.OPTICAL | literal | wavelength from 300nm to 1um |
EnergyBand.RADIO | literal | wavelength greater than ~10mm |
EnergyBand.UV | literal | wavelength from 100 to 300nm |
EnergyBand.XRAY | literal | energy from 0.12 to 120keV |
Environment | objectType | collection of measured quantities that characterise the environment at the time of observation |
Environment.ambientTemp | attribute | ambient temperature (outside or inside the telescope?) |
Environment.elevation | attribute | angular elevation (alt in alt-azimuth?) above horizon |
Environment.humidity | attribute | humidity [0,1] |
Environment.seeing | attribute | typical atmospheric distortion (full-width-half-max of point source) |
Environment.photometric | attribute | indicator that flux and/or color calibration is stable/feasible? |
Environment.tau | attribute | TODO |
Environment.wavelengthTau | attribute | TODO |
Instrument | objectType | description of the instrument used to acquire the data |
Instrument.keywords | attribute | additional keywords that describe the instrument or instrument configuration at the time of observation |
Instrument.name | attribute | common name for the instrument |
Metrics | objectType | collection of measured quantities that describe the content of the data |
Metrics.background | attribute | background level |
Metrics.backgroundStddev | attribute | standard deviation in the background level |
Metrics.fluxDensityLimit | attribute | flux density with a signal:noise ratio of 10 |
Metrics.magLimit | attribute | magnitude with a signal:noise ratio of 10 |
Metrics.sourceNumberDensity | attribute | number of sources detected per unit area |
Observation | objectType | an observation is a single top-level entry in an astronomy data centre |
Observation.algorithm | composition | the algorithm or process that created this observation |
Observation.collection | attribute | the name of the data collection this observation belongs to |
Observation.environment | composition | the environmental conditions at the time of observation |
Observation.instrument | composition | the instrument or detector used to acquire the data |
Observation.intent | attribute | the intent of the original observer in acquiring this data |
Observation.metaRelease | attribute | timestamp after which metadata for the observation instance is public |
Observation.observationID | attribute | the collection-specific identifier for this observation |
Observation.planes | composition | the component planes belonging to this observation |
Observation.Proposal | composition | the science proposal underwhich this observation was created |
Observation.requirements | composition | the observational requirements specified by the observer or proposal |
Observation.sequenceNumber | attribute | a collection-specific sequence number for observations; re-use or reset is collection specific |
Observation.target | composition | the intended target of the observation |
Observation.targetPosition | composition | the intended target position for this observation |
Observation.telescope | composition | the telescope or facility where this observation was created |
Observation.type | attribute | TODO: define this |
ObservationIntentType | enumeration | the intent of the original observer in acquiring this observation; work-around: using the name of the literal to convey the serialised value |
ObservationIntentType.CALIBRATION | literal | the intent of this observation was to create calibration data |
ObservationIntentType.SCIENCE | literal | the intent of this observation was to create science data |
Part | objectType | format-specific name of this part; this is typically something like a FITS extension or a file within a container |
Part.chunks | composition | component chunks that belong to this part |
Part.name | attribute | the name of this part of the artifact; this is typically something like a FITS extension name or number or a filename |
Part.productType | attribute | product type of this part when it differs from the parent artifact |
Plane | objectType | a component of an observation that describes one product of the observation |
Plane.artifacts | composition | the component artifacts belonging to this plane |
Plane.calibrationLevel | attribute | standard classification of the degree to which the data is calibrated |
Plane.dataProductType | attribute | standard classification of the type of data product; describes the logical data type for the main artifacts |
Plane.dataRelease | attribute | timestamp after which data for the plane is public; this dataRelease timestamp applies to all children of the plane and to artifacts with releaseType=data |
Plane.energy | composition | descritpion of the energy(ies) included in the data |
Plane.metaRelease | attribute | timestamp after which metadata for the plane is public; this metaRelease timestamp applies to all children of the plane and to artifacts with releaseType=meta |
Plane.metrics | composition | collection of measured quantities that describe the content of the data |
Plane.polarization | composition | description of the polarization(s) included in the data |
Plane.position | composition | description of the position(s) included in the data |
Plane.productID | attribute | collection- and observationID-specific identifier for this product |
Plane.provenance | composition | description of the provenance of the data |
Plane.quality | composition | flag indicating the quality of the data |
Plane.time | composition | description of the time(s) included in the data |
Polarization | objectType | description of polarization measurements included in the data |
Polarization.dimension | attribute | number of polarization states included |
Polarization.states | attribute | standard polarization states included |
PolarizationState | enumeration | a classification of polarization (Stokes states plus other related quantities); work-around: using the name of the literal to convey the serialised value |
PolarizationState.CPOLI | literal | TODO |
PolarizationState.EPOLI | literal | TODO |
PolarizationState.FPOLI | literal | TODO |
PolarizationState.I | literal | TODO |
PolarizationState.LL | literal | TODO |
PolarizationState.LR | literal | TODO |
PolarizationState.NPOLI | literal | TODO |
PolarizationState.POLA | literal | TODO |
PolarizationState.POLI | literal | TODO |
PolarizationState.Q | literal | TODO |
PolarizationState.RL | literal | TODO |
PolarizationState.RR | literal | TODO |
PolarizationState.U | literal | TODO |
PolarizationState.V | literal | TODO |
PolarizationState.XX | literal | TODO |
PolarizationState.XY | literal | TODO |
PolarizationState.YX | literal | TODO |
PolarizationState.YY | literal | TODO |
Position | objectType | description of the position coverage and sampling of the data |
Position.bounds | attribute | spatial boundary that includes the data |
Position.dimension | attribute | number of separate measurements (pixels) along each axis |
Position.resolution | attribute | median spatial resolution (full-width-half-max) per pixel |
Position.sampleSize | attribute | median pixel size |
Position.timeDependent | attribute | indicates that the observation was taken with non-siderial tracking so the resulting position is time-dependent; this usually explains why no bounds is available |
ProductType | enumeration | a general classification of the content of data files or parts thereof; work-around: using the name of the literal to convey the serialised value |
ProductType.AUXILIARY | literal | this is auxiliary data; to be used when analysing the science data |
ProductType.CALIBRATION | literal | this is calibration data; |
ProductType.INFO | literal | the content provides additional information: explanations, logs, etc |
ProductType.NOISE | literal | this is auxiliary data with some measure of the noise; to be used when analysing the science data |
ProductType.PREVIEW | literal | this is non-science preview data |
ProductType.SCIENCE | literal | this is the science data; data values come from extraterrestrial photons |
ProductType.THUMBNAIL | literal | this is a small non-science preview data; small means that this preview is suitable to display in a popup window or with multiple displayed together |
ProductType.WEIGHT | literal | this is auxiliary data which provides weight values; to be used when analysing the science data |
Proposal | objectType | description of the science proposal or programme that initiated the observation |
Proposal.keywords | attribute | additional keywords that describe the science goals of the proposal |
Proposal.pi | attribute | proper name of the principal investigator |
Proposal.project | attribute | common name of the project this proposal belongs to; typically used for larger or long-running projects that include mutliple proposals |
Proposal.proposalID | attribute | collection-specific identifier for the proposal |
Proposal.title | attribute | title of the proposal |
Provenance | objectType | description of how this data was produced |
Provenance.inputs | attribute | version of the software or process that produced the data |
Provenance.keywords | attribute | addituional keywords that describe the processing; this may include both general descriptive words and those specific to this particular execution of the processing |
Provenance.lastExecuted | attribute | timestamp describing when this process last ran and produced data |
Provenance.name | attribute | collection-specific common name of the process |
Provenance.producer | attribute | common name of the entity (person, institute, etc) responsible for producing the data |
Provenance.project | attribute | name of the project that produced the data; data produced in a uniform way are typically labelled with the same project name |
Provenance.reference | attribute | collection-specific common name of the process |
Provenance.runID | attribute | collection-specific identifier for the processing instance that produced the data; this identifier can typcially be traced in log files or logging systems |
Provenance.version | attribute | version of the software or process that produced the data |
Quality | enumeration | a general indicator of data quality; work-around: using the name of the literal to convey the serialised value |
Quality.JUNK | literal | this data cannot be used for anything |
ReleaseType | enumeration | a flag indicating how an artifact is classified to determine access permissions; work-around: using the name of the literal to convey the serialised value |
ReleaseType.DATA | literal | access permission checks assume the protected item is data |
ReleaseType.META | literal | access permission checks assume the protected item is metadata |
Requirements | objectType | description of the observational requirements specified by the proposal |
Requirements.flag | attribute | flag indicating degree to which requirements were satisfied |
SimpleObservation | objectType | an observation created directly by operating an instrument or process |
Status | enumeration | a status flag indicating degree of success; work-around: using the name of the literal to convey the serialised value |
Status.FAIL | literal | |
Target | objectType | description of the target of an observation |
Target.keywords | attribute | additional keywords that describe the target |
Target.moving | attribute | indicates that the target is a moving object; used for solar system objects but not high proper motion stars |
Target.name | attribute | proper name of the target |
Target.redshift | attribute | cosmological redshift of the target |
Target.standard | attribute | indicates that the target is typically used as a standard (astrometric, photometric, etc) |
Target.type | attribute | type of target; typically used to figure out what the target name means and where to look for additional information about it |
TargetPosition | objectType | description of the intended position of the observation (not the position of the intended or actual target) |
TargetPosition.coordinates | attribute | the coordinates |
TargetPosition.coordsys | attribute | the coordinate system of the coordinates |
TargetPosition.equinox | attribute | the equinox of the coordinates |
TargetType | enumeration | the type of target being observed; qualifies target name; work-around: using the name of the literal to convey the serialised value |
TargetType.FIELD | literal | the target of the observation is a defined region on the sky |
TargetType.OBJECT | literal | the target of the observation is an astronomical object |
Telescope | objectType | description of the telescope where an observation was created |
Telescope.geoLocationX | attribute | x-coordinate of the geocentric location of the telescope at the time of observation (see FITS WCS Paper III) |
Telescope.geoLocationY | attribute | y-coordinate of the geocentric location of the telescope at the time of observation (see FITS WCS Paper III) |
Telescope.geoLocationZ | attribute | z-coordinate of the geocentric location of the telescope at the time of observation (see FITS WCS Paper III) |
Telescope.keywords | attribute | additional keywords that describe the telescope or telscope configuration at the time of observation |
Telescope.name | attribute | common name of the telescope |
Time | objectType | description of the time coverage and sampling of the data |
Time.bounds | attribute | time bounds that include the data |
Time.dimension | attribute | number of measurements (pixels) on the time axis |
Time.exposure | attribute | median exposure time per pixel |
Time.resolution | attribute | median temporal resolution per pixel |
Time.sampleSize | attribute | median pixel size |
types | package | data types |
Circle | dataType | |
Circle.radius | attribute | |
Interval | dataType | |
Interval.lower | attribute | |
Interval.samples | attribute | |
Interval.upper | attribute | |
Interval.width | attribute | |
Point | dataType | |
Point.cval1 | attribute | |
Point.cval2 | attribute | |
Polygon | dataType | |
Polygon.vertices | attribute | |
Shape | dataType | |
Shape.area | attribute | |
Shape.center | attribute | |
Shape.size | attribute | |
SubInterval | dataType | |
SubInterval.lower | attribute | |
SubInterval.upper | attribute | |
wcs | package | World Coordinate System (WCS) data types |
Axis | dataType | |
Axis.ctype | attribute | |
Axis.cunit | attribute | |
Coord2D | dataType | |
Coord2D.coord1 | attribute | |
Coord2D.coord2 | attribute | |
CoordAxis1D | dataType | |
CoordAxis1D.axis | attribute | |
CoordAxis1D.bounds | attribute | |
CoordAxis2D.error | attribute | |
CoordAxis1D.function | attribute | |
CoordAxis1D.range | attribute | |
CoordAxis2D | dataType | |
CoordAxis2D.axis1 | attribute | |
CoordAxis2D.axis2 | attribute | |
CoordAxis2D.bounds | attribute | |
CoordAxis2D.error1 | attribute | |
CoordAxis2D.error2 | attribute | |
CoordAxis2D.function | attribute | |
CoordAxis2D.range | attribute | |
CoordBounds1D | dataType | |
CoordBounds1D.samples | attribute | |
CoordBounds2D | dataType | |
CoordBounds2D.vertices | attribute | |
CoordError | dataType | |
CoordError.crder | attribute | |
CoordError.csyer | attribute | |
CoordFunction1D | dataType | |
CoordFunction1D.delta | attribute | |
CoordFunction1D.dimension | attribute | |
CoordFunction1D.refCoord | attribute | |
CoordFunction2D | dataType | |
CoordFunction2D.cd11 | attribute | |
CoordFunction2D.cd12 | attribute | |
CoordFunction2D.cd21 | attribute | |
CoordFunction2D.cd22 | attribute | |
CoordFunction2D.dimension | attribute | |
CoordFunction2D.refCoord | attribute | |
CoordRange1D | dataType | |
CoordRange1D.end | attribute | |
CoordRange1D.start | attribute | |
CoordRange2D | dataType | |
CoordRange2D.end | attribute | |
CoordRange2D.start | attribute | |
Dimension2D | dataType | |
Dimension2D.naxis1 | attribute | |
Dimension2D.naxis2 | attribute | |
EnergyTransition | dataType | |
EnergyTransition.species | attribute | |
EnergyTransition.transition | attribute | |
ObservableAxis | objectType | |
ObservableAxis.dependent | attribute | |
ObservableAxis.independent | attribute | |
PolarizationWCS | objectType | |
PolarizationWCS.axis | attribute | |
RefCoord | dataType | |
RefCoord.pix | attribute | |
RefCoord.val | attribute | |
Slice | dataType | |
Slice.axis | attribute | |
Slice.bin | attribute | |
SpatialWCS | objectType | |
SpatialWCS.axis | attribute | |
SpatialWCS.coordsys | attribute | |
SpatialWCS.equinox | attribute | |
SpatialWCS.resolution | attribute | |
SpectralWCS | objectType | |
SpectralWCS.axis | attribute | |
SpectralWCS.bandpassName | attribute | |
SpectralWCS.resolvingPower | attribute | |
SpectralWCS.restfrq | attribute | |
SpectralWCS.restwav | attribute | |
SpectralWCS.specsys | attribute | |
SpectralWCS.ssysobs | attribute | |
SpectralWCS.ssyssrc | attribute | |
SpectralWCS.transition | attribute | |
SpectralWCS.velang | attribute | |
SpectralWCS.velosys | attribute | |
SpectralWCS.zsource | attribute | |
TemporalWCS | objectType | |
TemporalWCS.axis | attribute | |
TemporalWCS.exposure | attribute | |
TemporalWCS.mjdref | attribute | |
TemporalWCS.resolution | attribute | |
TemporalWCS.timesys | attribute | |
TemporalWCS.trefpos | attribute |
This section lists the external models imported by the current data model. For each imported model we list URLs to the VO-DML and HTML representations and the prefix used for vodml-ids from inside the model.
Model vodml-id | ivoa |
url | https://volute.g-vo.org/svn/trunk/projects/dm/vo-dml/models/ivoa/IVOA.vo-dml.xml |
documentation url | https://volute.g-vo.org/svn/trunk/projects/dm/vo-dml/models/ivoa/IVOA.html |