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.
| 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.contentChecksum |
attribute |
the checksum of the artifact data;
the URI must conform to the pattern {algorithm}:{value}, for example: md5:4be91751541fd804e7207663a0822f56
(NEW in CAOM-2.3)
|
| 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 so it is in the
description of each value
|
| CalibrationLevel.ANALYSIS_PRODUCT |
literal |
(4) : data product from scientific analysis |
| CalibrationLevel.CALIBRATED |
literal |
(2) standard calibration steps have been applied |
| CalibrationLevel.PLANNED |
literal |
(-1) planned data product that does not yet exist |
| CalibrationLevel.PRODUCT |
literal |
(3) additional non-standard calibration steps have been applied |
| CalibrationLevel.RAW_INSTRUMENTAL |
literal |
(0) raw data in some opaque instrument-specific format |
| CalibrationLevel.RAW_STANDARD |
literal |
(1) 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.accMetaChecksum |
attribute |
accumulated checksum of the metadata of this entity and all child entities; (NEW in CAOM-2.3)
The URI must conform to the pattern {algorithm}:{value}, for example: md5:4be91751541fd804e7207663a0822f56.
The accumulated checksum of an entity is computed by accumulating the byte representation of entity checksums
in the following order: (1) the metaChecksum of the current entity, (2) the accMetaChecksum of all child entities
accumulated in order of the child's CaomEntity.id. For an entity with no children, the accMetaChecksum is derived
only from the metaChecksum but it is not equal to it because it is a checksum of that checksum and not a checksum
of the same metadata directly.
|
| CaomEntity.id |
attribute |
globally unique identifier (primary key) |
| CaomEntity.lastModified |
attribute |
timestamp of last modification of this entity; the timestamp is intended to be applied
or updated when the entity is stored
(e.g. in a database)
|
| CaomEntity.maxLastModified |
attribute |
maximum timestamp of last modification of this entity and all child entities;
the timestamp is intended to be applied or updated when the entity is stored
(e.g. in a database)
|
| CaomEntity.metaChecksum |
attribute |
checksum of this entity; (NEW in CAOM-2.3)
The URI must conform to the pattern {algorithm}:{value}, for example: md5:4be91751541fd804e7207663a0822f56.
The checksum of an entity is computed by accumulating byte representation of individual metadata values in
the following order: (1) CaomEntity.id for entities, (2) state fields in alphabetic order (foo.a comes before
foo.b) and using depth-first recursion (foo.abc.x comes before foo.def). Null values are ignored so that the
addition of new fields in future versions will not change/invalidate existing checksums until values are assigned.
Non-null values are converted to bytes as follows.
string: UTF-8 encoded bytes
URI: UTF-8 encoded bytes of string representation
float: IEEE754 single (4 bytes)
double: IEEE754 double (8 bytes)
boolean: convert to single byte, false=0, true=1 (1 bytes)
byte: as-is (1 byte)
short: (2 bytes, network byte order == big endian))
integer: (4 bytes, network byte order == big endian)
long: (8 bytes, network byte order == big endian)
date: truncate time to whole number of seconds and treat as a long (seconds since 1970-01-01 00:00:00 UTC)
|
| 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 |
TODO: define this |
| 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 |
dataType |
vocabulary term used in CAOM; this class defines constants for the CAOM
DataProductType vocabulary which includes all the terms from the IVOA ObsCore
data model plus additional terms used in CAOM and not in ObsCore
(CHANGED in CAOM-2.3)
|
| 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 (barycentric vacuum wavelength) |
| 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.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;
keywords cannot contain the pipe (|) character - it is reserved for use in persistence
systems (e.g. to store all keywords in a single column in a table)
|
| 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 |
TODO: define this |
| 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.creatorID |
attribute |
identifier for this product assigned by the creator;
typically made up of the Observation.collection, Observation.observationID, and Plane.productID
and in the form of an IVOA dataset identifier (NEW in CAOM-2.3)
|
| 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 |
dataType |
this class defines constants for the CAOM ProductType vocabulary
(CHANGED in CAOM-2.3)
|
| 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;
keywords cannot contain the pipe (|) character - it is reserved for use in persistence
systems (e.g. to store all keywords in a single column in a table)
|
| 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;
keywords cannot contain the pipe (|) character - it is reserved for use in persistence
systems (e.g. to store all keywords in a single column in a table)
|
| 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 |
| SegmentType |
enumeration |
code used in CAG description of polygons |
| SegmentType.CLOSE |
literal |
(2) line from previous vertex to last vertex with type MOVE |
| SegmentType.LINE |
literal |
(0) line from previous to this vertex |
| SegmentType.MOVE |
literal |
(1) move from previous to this vertex |
| 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;
keywords cannot contain the pipe (|) character - it is reserved for use in persistence
systems (e.g. to store all keywords in a single column in a table)
|
| 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;
keywords cannot contain the pipe (|) character - it is reserved for use in persistence
systems (e.g. to store all keywords in a single column in a table)
|
| 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 |
| VocabularyTerm |
dataType |
base class of a single term (word) in a vocabulary
(NEW in CAOM-2.3)
|
| VocabularyTerm.namespace |
attribute |
globally unique namespace for the vocabulary |
| VocabularyTerm.term |
attribute |
the word from the vocabulary |
| VocabularyTerm.base |
attribute |
flag indicating of the vocabulary namespace is a base vocabulary |
| types |
package |
data types |
| Circle |
dataType |
|
| Shape.center |
attribute |
|
| Circle.radius |
attribute |
|
| Interval |
dataType |
|
| Interval.lower |
attribute |
|
| Interval.samples |
attribute |
|
| Interval.upper |
attribute |
|
| MultiPolygon |
dataType |
|
| MultiPolygon.vertices |
attribute |
|
| Point |
dataType |
|
| Point.cval1 |
attribute |
|
| Point.cval2 |
attribute |
|
| Polygon |
dataType |
|
| Polygon.points |
attribute |
|
| Polygon.samples |
attribute |
|
| Shape |
dataType |
|
| SubInterval |
dataType |
|
| SubInterval.lower |
attribute |
|
| SubInterval.upper |
attribute |
|
| Vertex |
dataType |
|
| Vertex.type |
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.rnder |
attribute |
|
| CoordError.syser |
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.
