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 |
the algorithm that was responsible for creating the observation; for a DerivedObservation
this is the
algorithm that defines the intended set of members to include
|
| Algorithm.name |
attribute |
common name of the algorithm; the value 'exposure' is reserved for use in SimpleObservation;
TBD: publish a list of acceptable values as a machine-readable vocabulary?
|
| 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.contentReadGroups |
attribute |
list of groups (of users) that are allowed to access the content of this artifact;
this is
applicable when the effective release date is null or in the future (new in CAOM-2.4)
|
| Artifact.contentRelease |
attribute |
timestamp after which content for the plane is public (new in CAOM-2.4);
if set, this value overrides the permission implied by the releaseType and Plane release
dates
|
| 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 |
the primary product type of the artifact; for multi-part artifacts where the parts
have different
types, this is the primary type; for example, if an artifact has a science part and
an auxiliary part, the artifact
should have type science
|
| 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) CaomEntity.metaProducer,
(3) 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)
|
| CaomEntity.metaProducer |
attribute |
identifier for the producer of this entity and child entities with null metaProducer;
(NEW in CAOM-2.4)
The URI should conform to the pattern {organisation}:{software name-version} (for
example: cadc:cfht2caom2-1.1)
and identifies the tools used to produce the metadata. This information is intended
for use by operators to help
diagnose metadata issues.
|
| Chunk |
objectType |
a quantitatively defined subsection of a data array;
the part contains the whole array
|
| Chunk.custom |
composition |
custom WCS description of the data array or subsection thereof; if customAxis index
is null or has a value
above {naxis}, then the custom WCS is metadata only (usually the degenerate case of
one custom pixel)
|
| Chunk.customAxis |
attribute |
index of the custom axis; if set: custom must have a value |
| Chunk.energy |
composition |
spectral WCS description of the data array or subsection thereof; if energyAxis index
is null or has a value
above {naxis}, then the spectral WCS is metadata only (usually the degenerate case
of one spectral pixel)
|
| Chunk.energyAxis |
attribute |
index of the energy axis; if set: energy must have a value |
| Chunk.naxis |
attribute |
number of axes in the data array; value must be in [1,7] since CAOM supports a maximum
of seven axes; furthermore, if naxis has a value, the axis index values 1 to {naxis}
must be assigned
(to positionAxis1, positionAxis2, energyAxis, timeAxis, polarizationAxis, customAxis,
and/or observableAxis)
and each axis index value assigned to those fields must be unique; axis index values
above {naxis} may be
assigned in order to preserve the ordering of metadata-only WCS (see FITS-WCS WCSAXES
defintion for an example
of how this could originate and be used)
|
| Chunk.observable |
composition |
observable description of the data array or subsection thereof; if observableAxis
index is null or has a value
above {naxis}, then the observable axis is metadata only (usually the degenerate case
of one observable for the whole data array)
|
| Chunk.observableAxis |
attribute |
index of the observable axis; if set: observable must have a value |
| Chunk.polarization |
composition |
polarization WCS description of the data array or subsection thereof; if polarizationAxis
index is null or has a value
above {naxis}, then the polarization WCS is metadata only (usually the degenerate
case of one polarization pixel)
|
| Chunk.polarizationAxis |
attribute |
index of the polarization axis; if set: polarization must have a value |
| Chunk.position |
composition |
spatial WCS description of the data array or subsection thereof; if positionAxis1
and positionAxis2 indices are null
or have values above {naxis}, then the spatial WCS is metadata only (usually the degenerate
case of one spatial pixel)
|
| Chunk.positionAxis1 |
attribute |
index of the first position axis; if set: positionAxis2 and position must also have
values
|
| Chunk.positionAxis2 |
attribute |
index of the second position axis; if set: positionAxis1 and position must also have
values
|
| Chunk.productType |
attribute |
the type of content in this chunk, sometimes relative to the type of the artifact |
| Chunk.time |
composition |
temporal WCS description of the data array or subsection thereof; if timeAxis index
is null or has a value
above {naxis}, then the time WCS is metadata only (usually the degenerate case of
one time pixel for the whole data array)
|
| Chunk.timeAxis |
attribute |
index of the time axis; if set: time must have a value |
| CustomAxis |
objectType |
description of a custom coordinate axis (new in CAOM-2.4) |
| CustomAxis.bounds |
attribute |
custom coordinate bounds |
| CustomAxis.ctype |
attribute |
coordinate type code |
| CustomAxis.dimension |
attribute |
number of samples along custom axis |
| 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 |
| DerivedObservation |
objectType |
an observation derived from one or more observations (name and intent changed in CAOM-2.4) |
| DerivedObservation.members |
attribute |
members are the observations grouped together by the algorithm that defines the derivation;
these are the intended components of the composite product -- actual inputs are described
by the provenance;
members may be simple or derived observations (arbitrary heirarchy); a derived observation
made by combining
multiple observations is equivalent to a composite observation (CAOM-2.3 and older);
derived observations with
one or more members may be defined such that they only include a subset of each member
(they are extracted from
the progenitor)
|
| 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.energyBands |
attribute |
standard name of the energy regime(s) included in the data (attribute name
and cardinality changed in CAOM-2.4)
|
| Energy.resolvingPower |
attribute |
median spectral resolving power per pixel |
| Energy.resolvingPowerBounds |
attribute |
range of resolving power within the bounds |
| 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 at the telescope |
| Environment.elevation |
attribute |
angular elevation above horizon [0,90] |
| Environment.humidity |
attribute |
fractional relative humidity [0,1] |
| Environment.seeing |
attribute |
typical atmospheric distortion (full-width-half-max of a point source) |
| Environment.photometric |
attribute |
indicator that flux and/or color calibration is stable |
| Environment.tau |
attribute |
the opacity of the atmosphere [0,1] |
| Environment.wavelengthTau |
attribute |
wavelength at which opacity was measured |
| Instrument |
objectType |
the instrument used to acquire or create the observation; this could be used for both
physical
instruments that acquire data or software that generates it (e.g. simulated 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.sampleSNR |
attribute |
signal:noise ratio for a representative subset of samples (new in CAOM-2.4) |
| Metrics.sourceNumberDensity |
attribute |
number of sources detected per unit area |
| Observable |
objectType |
description of the sample (pixel) values |
| Observable.ucd |
attribute |
Unified Content Descriptor (UCD) that says what kind of quantity is stored |
| 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.metaReadGroups |
attribute |
set of groups with read permission on observation metadata (new in 2.4) |
| 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 |
the type of observation (FITS OBSTYPE keyword); usually OBJECT for intent = science |
| 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 |
| ObservationURI |
primitiveType |
Observation identifier of the form caom:{Observation.collection}/{Observation.observationID} |
| 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 |
the type of content in this part, sometimes relative to the type of the 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.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.custom |
composition |
description of a custom coordinate axis in the data (new in CAOM-2.4);
Since different custom coordinate types can be used with different planes, instances
of
CustomAxis can only be compared sensibly if they have the same coordinate type.
|
| Plane.dataProductType |
attribute |
standard classification of the type of data product; describes the logical data type
for the main artifacts
|
| Plane.dataReadGroups |
attribute |
list of groups (of users) that are allowed to access the data of the plane; this is
applicable when dataRelease is null or in the future (new in CAOM-2.4)
|
| 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.metaReadGroups |
attribute |
list of groups (of users) that are allowed to view the metadata of the plane; this
is
applicable when metaRelease is null or in the future (new in CAOM-2.4)
|
| 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.observable |
composition |
description of the sample (pixel) values; (new in CAOM-2.4)
In previous versions the observable was assumed to be flux or intensity of EM radiation.
|
| 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 |
| PlaneURI |
primitiveType |
Plane identifier of the form caom:{Observation.collection}/{Observation.observationID}/{Plane.productID}
aka {observationURI}/{Plane.productID}
|
| 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 |
circular polarization intensity: |V| |
| PolarizationState.EPOLI |
literal |
elliptical polarization intensity: sqrt(Q^2 + U^2 + V^2) |
| PolarizationState.FPOLI |
literal |
fractional linear polarization: POLI/I |
| PolarizationState.I |
literal |
unpolarized |
| PolarizationState.LL |
literal |
left-left circular |
| PolarizationState.LR |
literal |
left-right cross-circular |
| PolarizationState.NPOLI |
literal |
unpolarized intensity: I - EPOLI |
| PolarizationState.POLA |
literal |
linear polarization angle: 1/2 arctan(U,Q) |
| PolarizationState.POLI |
literal |
linear polarized intensity: sqrt(Q^2 + U^2) |
| PolarizationState.Q |
literal |
Stokes linear Q |
| PolarizationState.RL |
literal |
right-left cross-circular |
| PolarizationState.RR |
literal |
right-right circular |
| PolarizationState.U |
literal |
Stokes linear U |
| PolarizationState.V |
literal |
Stokes circular V |
| PolarizationState.XX |
literal |
X parallel linear |
| PolarizationState.XY |
literal |
XY cross-linear |
| PolarizationState.YX |
literal |
YX cross-linear |
| PolarizationState.YY |
literal |
Y parallel linear |
| 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.resolutionBounds |
attribute |
range of resolution within the bounds |
| 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 |
local identifier for input planes; these are the actual inputs that went into the
product
|
| Provenance.keywords |
attribute |
additional 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 |
dataType |
vocabulary term used in CAOM; this class defines constants for the CAOM
Quality vocabulary (CHANGED from enumeration in CAOM-2.4)
|
| 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 |
the observational requirements specified by the proposal |
| Requirements.flag |
attribute |
flag indicating degree to which requirements were satisfied by the observation |
| 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 |
dataType |
vocabulary term used in CAOM; this class defines constants for the CAOM
Status vocabulary (CHANGED from enumeration in CAOM-2.4)
|
| Target |
objectType |
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.targetID |
attribute |
resolvable target identifier (new in CAOM-2.4);
the targetID URI should be of the form {scheme}:{id} so it can be resolved
(for example: naif:170100)
|
| 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 |
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 |
dataType |
vocabulary term used in CAOM; this class defines constants for the CAOM
TargetType vocabulary (CHANGED from enumeration in CAOM-2.4)
|
| Telescope |
objectType |
the telescope used to acquire the data for an observation |
| 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;
TBD: reference to a standard list of names?
|
| 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.resolutionBounds |
attribute |
range of resolution within the bounds |
| 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 |
a circular region on the sky |
| Shape.center |
attribute |
|
| Circle.radius |
attribute |
|
| Interval |
dataType |
a set of numeric values defined by a lower and upper bound (bounds included: [a,b]) |
| Interval.lower |
attribute |
|
| Interval.upper |
attribute |
|
| MultiPolygon |
dataType |
a region on the sky defined a sequence of points connected by great-circle segments;
each simple polygon is
is terminated by a special type of vertex and multiple simple polygons are permitted
to describe disconnected regions as
a single value
|
| MultiPolygon.vertices |
attribute |
|
| Point |
dataType |
|
| Point.cval1 |
attribute |
|
| Point.cval2 |
attribute |
|
| Polygon |
dataType |
a simple polygon region on the sky defined a sequence of points connected by great-circle
segments
|
| Polygon.points |
attribute |
|
| Polygon.samples |
attribute |
|
| SampledInterval |
dataType |
an interval with (possibly sparse) sub-sampling |
| SampledInterval.lower |
attribute |
|
| SampledInterval.samples |
attribute |
the samples within an interval describe possible holes in the interval; in the simple
case there is
one sample that is identical to the outer interval; samples within an interval are
not allowed to overlap
(TBD: the bounds of adjacent samples may be equal?)
|
| SampledInterval.upper |
attribute |
|
| Shape |
dataType |
|
| Vertex |
dataType |
|
| Vertex.type |
attribute |
|
| wcs |
package |
World Coordinate System (WCS) data types |
| Axis |
dataType |
one-dimensional coordinate axis description |
| Axis.ctype |
attribute |
|
| Axis.cunit |
attribute |
|
| Coord2D |
dataType |
a two-dimensional (pair) of reference coordinates |
| Coord2D.coord1 |
attribute |
|
| Coord2D.coord2 |
attribute |
|
| CoordAxis1D |
dataType |
a one-dimensional coordinate axis: quantity, values, errors; it is usually only necessary
to specify one of the
range, bounds, or function as they describe the world and pixel coordinate coverage
at different levels
of detail and the less detailed description is redundant (exception: when the range
or bounds and function
are both specified, the range/bounds is a subset of the pixels described by the function
and denotes the
valid pixels
|
| CoordAxis1D.axis |
attribute |
description of the quantity |
| CoordAxis1D.bounds |
attribute |
pixel and world coordinate values covered by this axis (min,max of tiles) |
| CoordAxis1D.error |
attribute |
errors |
| CoordAxis1D.function |
attribute |
pixel and world coordinate values covered by this axis (coordinates of every pixel) |
| CoordAxis1D.range |
attribute |
pixel and world coordinate values covered by this axis (min,max) |
| CoordAxis2D |
dataType |
a two-dimensional coordinate axis pair: quantity, values, errors; it is usually only
necessary
to specify one of the range, bounds, or function as they describe the world and pixel
coordinate coverage
at different levels of detail and the less detailed description is redundant (exception:
when the range or
bounds and function are both specified, the range/bounds is a subset of the pixels
described by the function
and denotes the valid pixels
|
| CoordAxis2D.axis1 |
attribute |
first axis of the spatial coordinate system; usually longitude |
| CoordAxis2D.axis2 |
attribute |
second axis of the spatial coordinate system; usually latitude |
| CoordAxis2D.bounds |
attribute |
pixel and world coordinate values covered by this axis (boundary) |
| CoordAxis2D.error1 |
attribute |
position errors on the first axis |
| CoordAxis2D.error2 |
attribute |
position errors on the second axis |
| CoordAxis2D.function |
attribute |
pixel and world coordinate values covered by this axis (coordinates of every pixel |
| CoordAxis2D.range |
attribute |
pixel and world coordinate values covered by this axis (min,max) |
| CoordBounds1D |
dataType |
a one-dimensional sequence of reference coordinate ranges |
| CoordBounds1D.samples |
attribute |
|
| CoordBounds2D |
dataType |
a two-dimensional region in pixel and world coordinates; this can be used to specify
a simple polygon
boundary in pixel and world coordinates
|
| CoordBounds2D.vertices |
attribute |
the vertices of the polygon with implicit segment from the last vertex back to the
first
|
| CoordError |
dataType |
coordinate error from FITS WCS |
| CoordError.rnder |
attribute |
|
| CoordError.syser |
attribute |
|
| CoordFunction1D |
dataType |
a one-dimensional (linear) WCS coordinate transformation function |
| CoordFunction1D.delta |
attribute |
delta in world coordinate value (size of one pixel) |
| CoordFunction1D.dimension |
attribute |
number of pixels along the axis |
| CoordFunction1D.refCoord |
attribute |
the reference pixel and world coordinate values |
| CoordFunction2D |
dataType |
a two-dimensional (linear) WCS coordinate transformation function; this can be used
to compute the world
coordinates of every pixel
|
| CoordFunction2D.cd11 |
attribute |
two-dimensional scale and rotation (CD) matrix (FITS: CD1_1) |
| CoordFunction2D.cd12 |
attribute |
two-dimensional scale and rotation (CD) matrix (FITS: CD1_2) |
| CoordFunction2D.cd21 |
attribute |
two-dimensional scale and rotation (CD) matrix (FITS: CD2_1) |
| CoordFunction2D.cd22 |
attribute |
two-dimensional scale and rotation (CD) matrix (FITS: CD2_2) |
| CoordFunction2D.dimension |
attribute |
number of pixels along each axis of the two-dimensional space (FITS: NAXISi) |
| CoordFunction2D.refCoord |
attribute |
two-dimensional reference pixel and world coordinate values (FITS: CRPIXi, CRVALi) |
| CoordRange1D |
dataType |
a one-dimensional range of reference coordinates |
| CoordRange1D.end |
attribute |
|
| CoordRange1D.start |
attribute |
|
| CoordRange2D |
dataType |
a two-dimensional range of reference coordinates; this can be used to specify an axis-aligned
bounding box
in pixel and world coordinates
|
| CoordRange2D.end |
attribute |
the two-dimensional reference coordinates with maximum longitude and latitude |
| CoordRange2D.start |
attribute |
the two-dimensional reference coordinates with minimum longitude and latitude |
| CustomWCS |
objectType |
one-dimensional pixel and world coordinates describing a non-standard (custom) coordinate
axis
|
| CustomWCS.axis |
attribute |
description of the custom axis |
| Dimension2D |
dataType |
dimension (number of pixels) for a two-dimensional axis |
| Dimension2D.naxis1 |
attribute |
|
| Dimension2D.naxis2 |
attribute |
|
| EnergyTransition |
dataType |
|
| EnergyTransition.species |
attribute |
TODO |
| EnergyTransition.transition |
attribute |
TODO |
| ObservableAxis |
objectType |
an axis in the data (array) that varies by observable rather than coordinate; this
axis is used when
the data array containts values with different meaning in different subsets of the
array (e.g. a row of pixels
with wavelength values and a second row with flux values)
|
| ObservableAxis.dependent |
attribute |
the part of the array containing the observable values |
| ObservableAxis.independent |
attribute |
the part of the array containing coordinate values |
| PolarizationWCS |
objectType |
one-dimensional pixel and world coordinates describing the polarization states |
| PolarizationWCS.axis |
attribute |
description of the polarization axis |
| RefCoord |
dataType |
a reference coordinate with a pixel and cooresponding world coordinate value |
| RefCoord.pix |
attribute |
|
| RefCoord.val |
attribute |
|
| Slice |
dataType |
a one-dimensional subset of a two-dimensional array |
| Slice.axis |
attribute |
description of the values within a the slice |
| Slice.bin |
attribute |
a constant-pixel value in the two-dimensional array that specifies the pixels in the
slice
|
| SpatialWCS |
objectType |
World Coordinate System (WCS) metadata for the position axes |
| SpatialWCS.axis |
attribute |
description of the two-dimensional position axes |
| SpatialWCS.coordsys |
attribute |
name of the coordinate system |
| SpatialWCS.equinox |
attribute |
equinox of the coordinate system |
| SpatialWCS.resolution |
attribute |
effective resolution of the data (FWHM of a point source);
this is usually the value measured at the time of data acquisition
|
| SpectralWCS |
objectType |
|
| SpectralWCS.axis |
attribute |
description of the one-dimensional energy axis |
| SpectralWCS.bandpassName |
attribute |
telescope- or instrument-specific name for the energy band covered by the data; this
is usually
a filter name
|
| SpectralWCS.resolvingPower |
attribute |
ratio of wavelength to resolution (lambda/delta-lambda) |
| SpectralWCS.restfrq |
attribute |
rest frequency of the spectral feature of interest |
| SpectralWCS.restwav |
attribute |
rest wavelength of the spectral feature of interest |
| SpectralWCS.specsys |
attribute |
reference frame for the spectral coordinate |
| SpectralWCS.ssysobs |
attribute |
reference frame that is constant over the range of the non-spectral world coordinates |
| SpectralWCS.ssyssrc |
attribute |
reference frame for the velocity of the source (zsource) |
| SpectralWCS.transition |
attribute |
description of the energy transition observed |
| SpectralWCS.velang |
attribute |
angle of true velocity from tangent to line of sight |
| SpectralWCS.velosys |
attribute |
correction for the observatory's motion with respect to the barycenter |
| SpectralWCS.zsource |
attribute |
redshift of the source (relative to ssyssrc) |
| TemporalWCS |
objectType |
one-dimensional pixel and world coordinates describing the time axis |
| TemporalWCS.axis |
attribute |
description of the time axis |
| TemporalWCS.exposure |
attribute |
duration in time that the instrument was collecting data |
| TemporalWCS.mjdref |
attribute |
base time offset; time coordinate values are relative to this |
| TemporalWCS.resolution |
attribute |
smallest separation in time that can be distinguished |
| TemporalWCS.timesys |
attribute |
time scale for the time coordinates |
| TemporalWCS.trefpos |
attribute |
reference position for the time coordinates |
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.
