DatasetMetadata-1.0/vo-dml/DatasetMetadata-1.0-GL.vo-dml.xml

<?xml version="1.0" encoding="UTF-8"?>
<vo-dml:model xmlns:vo-dml="http://www.ivoa.net/xml/VODML/v1.0">
  <name>ds</name>
  <description>
This document provides a data model describing the structure and content of generic Dataset metadata for the IVOA.  This is a high-level model which is to be referenced and extended by other models describing specific types of Datasets and Data products.  In this document, we specify the generic Dataset, as well as an ObservationDataset model which covers the class of Datasets which are derived from an Observation.  At the time of this writing, there is no formal Observation-Experiment model for the IVOA, so we include a hypothetical Observation-Experiment model to serve as a placeholder. 

</description>
  <title>IVOA Dataset Metadata Model</title>
  <author>Mark Cresitello-Dittmar, Francois Bonnarel, Omar Laurino, Gerard Lemson, Mireille Louys, Arnold Rots, Doug Tody, and the IVOA Data Model Working Group.</author>
  <version>1.0</version>
  <previousVersion>0.x</previousVersion>
  <lastModified>2016-01-10T13:33:19</lastModified>
  <import>
    <name>ivoa</name>
    <url>http://volute.g-vo.org/svn/trunk/projects/dm/vo-dml/models/ivoa/IVOA.vo-dml.xml</url>
    <documentationURL>http://volute.g-vo.org/svn/trunk/projects/dm/vo-dml/models/ivoa/IVOA.html</documentationURL>
  </import>
  <import>
    <name>char</name>
    <url>http://volute.g-vo.org/svn/trunk/projects/dm/vo-dml/models/characterization/Characterization.vo-dml.xml</url>
    <documentationURL>http://volute.g-vo.org/svn/trunk/projects/dm/vo-dml/models/characterization/Characterization.html</documentationURL>
  </import>
  <import>
    <name>stc</name>
    <url>file:///data/vao/staff/mcd/docs/models/dm/vo-dml/models/STC2/prototype/STCPrototype-2.0.vo-dml.xml</url>
    <documentationURL>file:///data/vao/staff/mcd/docs/models/dm/vo-dml/models/STC2/prototype/STCPrototype-2.0.html</documentationURL>
  </import>

  <package>
    <vodml-id>experiment</vodml-id>
    <name>experiment</name>
    <description>
The Observation Experiment model refers to several elements related to an Observation and its configuration.  As of the time of this writing, there is no IVOA recommendation for a general Observation data model.  The Provenance data model, in progress, will define the pattern for describing the relation between actions and results, and how to record these in datasets.  In lieu of these standards, this document defines a straw-man Observation model.  

The Observation is modeled as a type of 'Experiment', with some basic structure defined to provide metadata about the observation target and configuration.  The product, or 'result' of the Observation is zero or more ObsDataset objects.  This pattern is inspired by, and compatible with the Simulation Data Model, where a 'Simulation' can be considered another form of 'Experiment' or perhaps even another form of 'Observation'.

</description>
    <objectType>
      <vodml-id>experiment.Bandpass</vodml-id>
      <name>Bandpass</name>
      <description>
Describes the spectral range of the observation.  The value may be expressed in terms 
of general spectral bands, or specific bandpass names.  If multiple bands are covered, the value
may be a comma delimited combination of appropriate bands.  If expressed as general bands,
the value(s) must be selected from the enumerated set given by the SpectralBand type.  There is
no controlled vocabulary for bandpass names as the list is too long to enumerate.  Effort should
be made to use highly recognized bandpass names (eg: "U","V","B","R","I", "H-alpha").
This field corresponds to both the Coverage.Spectral and Coverage.Spectral.Bandpass fields of
the Resource Metadata document.

</description>
      <extends>
        <vodml-ref>ds:experiment.ObservingElement</vodml-ref>
      </extends>
    </objectType>

    <objectType>
      <vodml-id>experiment.Observation</vodml-id>
      <name>Observation</name>
      <description>

</description>
      <attribute>
        <vodml-id>experiment.Observation.observationID</vodml-id>
        <name>observationID</name>
        <description>
Internal ID determined by the data provide to uniquely identify the observation within the institution or entity performing the observation.

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <collection>
        <vodml-id>experiment.Observation.target</vodml-id>
        <name>target</name>
        <description>
The target of the observation.  The content of this object may vary greatly depending on the goals and nature of the observation.  For example the 'target' could be a galaxy, stellar object, planet, or calibration source.   As such, we allow the BaseTarget class here, and permit users to define and use more content rich flavors according to their needs.

</description>
        <datatype>
          <vodml-ref>ds:experiment.BaseTarget</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </collection>
      <collection>
        <vodml-id>experiment.Observation.obsConfig</vodml-id>
        <name>obsConfig</name>
        <description>
Observation configuration metadata, provides information about who, where, and how the observation was conducted.

</description>
        <datatype>
          <vodml-ref>ds:experiment.ObsConfig</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </collection>
      <collection>
        <vodml-id>experiment.Observation.proposal</vodml-id>
        <name>proposal</name>
        <description>
Identifies any proposal related to the observation.  This field may be used to gather all observations and products related to a particular proposal.

</description>
        <datatype>
          <vodml-ref>ds:experiment.Proposal</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </collection>
      <collection>
        <vodml-id>experiment.Observation.result</vodml-id>
        <name>result</name>
        <description>
The result of an observation is zero or more Observation Datasets.

</description>
        <datatype>
          <vodml-ref>ds:dataset.ObsDataset</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>-1</maxOccurs>
        </multiplicity>
      </collection>
    </objectType>

    <objectType>
      <vodml-id>experiment.Proposal</vodml-id>
      <name>Proposal</name>
      <description>
Metadata related to the proposal or document which spawned the observation.

</description>
      <attribute>
        <vodml-id>experiment.Proposal.identifier</vodml-id>
        <name>identifier</name>
        <description>
Tag used to uniquely identify a particular proposal within the institution or entity.

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
    </objectType>

    <objectType abstract="true">
      <vodml-id>experiment.ObservingElement</vodml-id>
      <name>ObservingElement</name>
      <description>
Abstract base class for defining observation parameters.  Each subclass of ObservationElement pertains to a particular 'domain' of the observation setup,  e.g. the Facility, or the Instrument, and may have additional structure to provide all relevant metadata in that domain.

</description>
      <attribute>
        <vodml-id>experiment.ObservingElement.name</vodml-id>
        <name>name</name>
        <description>
The name attribute identifies the particular instance of the ObservingElement. e.g. the Facility name.

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
    </objectType>

    <objectType>
      <vodml-id>experiment.Instrument</vodml-id>
      <name>Instrument</name>
      <description>
Identifies the instrument used to create the data.  (RM:Collection.Instrument)  This can 
be a specific instrument name, general type or something else, such as a program in the case of
theoretical data.  We restrict this field to a single value.

</description>
      <extends>
        <vodml-ref>ds:experiment.ObservingElement</vodml-ref>
      </extends>
    </objectType>

    <objectType>
      <vodml-id>experiment.Target</vodml-id>
      <name>Target</name>
      <description>
General purpose Target object.
</description>
      <extends>
        <vodml-ref>ds:experiment.BaseTarget</vodml-ref>
      </extends>
      <attribute>
        <vodml-id>experiment.Target.objectClass</vodml-id>
        <name>objectClass</name>
        <description>
General classification or type of the target.  This field supports the discovery of data pertaining to a common class.  e.g. "Star", "Galaxy", "AGN".  At the time of this writing, there is no IVOA recommended vocabulary for this field.  The SIMBAD and NED databases use defined vocabularies for astronomical object classifications which may serve as the basis for such.
</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
    </objectType>

    <objectType abstract="true">
      <vodml-id>experiment.BaseTarget</vodml-id>
      <name>BaseTarget</name>
      <description>
Abstract base class for the Target object tree.  The target object provides identifying metadata related to the subject or goal of the experiment.  For an Observational experiment, this would typically be an astronomical object.  The BaseTarget class defines high-level identifying information, and must be extended for particular classes of Target which may define additional  characteristics.

</description>
      <attribute>
        <vodml-id>experiment.BaseTarget.name</vodml-id>
        <name>name</name>
        <description>
The target name.  The primary purpose of this field is to provide the user with a recognizable identity of the particular subject or goal.  However, since this may be a query-able field in data discovery protocols, care should be taken to use values which follow conventions for the domain appropriate for the data.  For an astronomical object, this may be a name suitable for use within a domain-specific resolution service.  Simulated data might also use this sort of name (if simulating a particular object), or a more generic term such as "G2V star". 

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>experiment.BaseTarget.description</vodml-id>
        <name>description</name>
        <description>
Free form description of target.

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>experiment.BaseTarget.position</vodml-id>
        <name>position</name>
        <description>
This field provides the spatial location of the target.  The value is an STC Position object which supports all required dimensionality and coordinate frame specification needs.  In the context of an Astronomical Target, this field gives the nominal RA and Dec location for the target.  For example, the catalog position of the source.
 
</description>
        <datatype>
          <vodml-ref>stc:Position</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
    </objectType>

    <objectType>
      <vodml-id>experiment.AstroTarget</vodml-id>
      <name>AstroTarget</name>
      <description>
Extension of BaseTarget specialized for astronomical objects.  The AstroTarget defines additional astronomical properties of the target.
</description>
      <extends>
        <vodml-ref>ds:experiment.BaseTarget</vodml-ref>
      </extends>
      <attribute>
        <vodml-id>experiment.AstroTarget.objectClass</vodml-id>
        <name>objectClass</name>
        <description>
General classification or type of the target.  This field supports the discovery of data pertaining to a common class.  e.g. "Star", "Galaxy", "AGN".  At the time of this writing, there is no IVOA recommended vocabulary for this field.  The SIMBAD and NED databases use defined vocabularies for astronomical object classifications which may serve as the basis for such.

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>experiment.AstroTarget.spectralClass</vodml-id>
        <name>spectralClass</name>
        <description>
Spectral class of the object.  As with objectClass, there is no IVOA recommended vocabulary for specifying the spectral class of an object.  There is an IVOA Note on the subject entitled "An encoding system to represent stellar spectral classes in archival databases and catalogs", describing an encoding system which has been adopted by the MAST archive.

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>experiment.AstroTarget.redshift</vodml-id>
        <name>redshift</name>
        <description>
This field gives the canonical redshift of the astronomical object.  It is normally used to store the cosmological redshift of extragalactic objects, although it may also be used to store the observed redshift of Galactic sources if that information is felt by the data provider to be useful.

</description>
        <datatype>
          <vodml-ref>ivoa:real</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>experiment.AstroTarget.varAmpl</vodml-id>
        <name>varAmpl</name>
        <description>
Canonical variability amplitude attributed to the target.

</description>
        <datatype>
          <vodml-ref>ivoa:real</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
    </objectType>

    <objectType>
      <vodml-id>experiment.Facility</vodml-id>
      <name>Facility</name>
      <description>
Name of the facility performing the observation.

</description>
      <extends>
        <vodml-ref>ds:experiment.ObservingElement</vodml-ref>
      </extends>
    </objectType>

    <objectType>
      <vodml-id>experiment.DataSource</vodml-id>
      <name>DataSource</name>
      <description>
Describes the original source of the data in a very general fashion.  In other words, "What sort of observation originally generated the data?"  Suggested values include:
* survey: Survey data typically covers some region of observational parameter space with as complete as possible coverage within that region.
* pointed:  Pointed data of a particular object or field.
* theory:  Theory data, generated based on a theoretical model.
* artificial:  Artificial, or simulated data.  Similar to 'theory', but not necessarily based on a theoretical model.
* custom:  Custom data, as part of a specific research project.

</description>
      <extends>
        <vodml-ref>ds:experiment.ObservingElement</vodml-ref>
      </extends>
    </objectType>

    <objectType>
      <vodml-id>experiment.ObsConfig</vodml-id>
      <name>ObsConfig</name>
      <description>
ObsConfig is a simple container object for all Observation Configuration metadata.  It is modeled as a simple list of observing elements.  Each ObservingElement provides metadata describing a particular domain of the observation setup.  For example, the Facility performing the observation, the Instrument being used, etc.

</description>
      <collection>
        <vodml-id>experiment.ObsConfig.observingElement</vodml-id>
        <name>observingElement</name>
        <description>
Collection of zero or more ObservingElements which define observation parameters.
</description>
        <datatype>
          <vodml-ref>ds:experiment.ObservingElement</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>-1</maxOccurs>
        </multiplicity>
      </collection>
    </objectType>

  </package>


  <package>
    <vodml-id>dataset</vodml-id>
    <name>dataset</name>
    <description>
Dataset Metadata package
</description>
    <enumeration>
      <vodml-id>dataset.DataProductType</vodml-id>
      <name>DataProductType</name>
      <description>
Enumeration identifying the high level classification of a data product.
</description>
      <literal>
        <vodml-id>dataset.DataProductType.cube</vodml-id>
        <name>cube</name>
        <description>
A multidimensional astronomical image of three (3) or more axes.

</description>
      </literal>
      <literal>
        <vodml-id>dataset.DataProductType.image</vodml-id>
        <name>image</name>
        <description>
A two (2) dimensional astronomical image.
</description>
      </literal>
      <literal>
        <vodml-id>dataset.DataProductType.photometry</vodml-id>
        <name>photometry</name>
        <description>
Dataset with spectral coverage with irregular gaps.

</description>
      </literal>
      <literal>
        <vodml-id>dataset.DataProductType.spectrum</vodml-id>
        <name>spectrum</name>
        <description>
Dataset where spectral coverage is the primary attribute, in contiguous bins. e.g. a 1D spectrum or a long slit spectrum.

</description>
      </literal>
      <literal>
        <vodml-id>dataset.DataProductType.timeseries</vodml-id>
        <name>timeseries</name>
        <description>
Dataset presenting some quantity varying as a function of time.  A light curve is a typical example of a timeseries dataset.
</description>
      </literal>
      <literal>
        <vodml-id>dataset.DataProductType.sed</vodml-id>
        <name>sed</name>
        <description>
A spectral energy distribution, an advanced data product often produced by combining data from multiple observations.
</description>
      </literal>
      <literal>
        <vodml-id>dataset.DataProductType.visibility</vodml-id>
        <name>visibility</name>
        <description>
A visibility (radio) dataset. Typically this is instrumental data, and is often a complex object containing multiple files or other substructures.  A visibility dataset may contain data with spatial, spectral, time, and polarization information for each measured visibility.
</description>
      </literal>
      <literal>
        <vodml-id>dataset.DataProductType.event</vodml-id>
        <name>event</name>
        <description>
An event counting dataset (e.g. X-ray). An event dataset may contain data with spatial, spectral, and time information for each measured event. 
</description>
      </literal>
      <literal>
        <vodml-id>dataset.DataProductType.catalog</vodml-id>
        <name>catalog</name>
        <description>
A catalog.

</description>
      </literal>
    </enumeration>

    <enumeration>
      <vodml-id>dataset.CreationType</vodml-id>
      <name>CreationType</name>
      <description>
Enumeration of dataset creation types.
</description>
      <literal>
        <vodml-id>dataset.CreationType.archival</vodml-id>
        <name>archival</name>
        <description>
Indicates that it is one of a collection of datasets generated in a systematic, homogeneous way and is stored statically (or at least versioned).  It will be possible to regenerate this dataset at a later date.  The remaining types imply on-the-fly manipulation.
</description>
      </literal>
      <literal>
        <vodml-id>dataset.CreationType.cutout</vodml-id>
        <name>cutout</name>
        <description>
Indicates that the dataset was created "on-the-fly", by subsetting, but not by modifying values.

</description>
      </literal>
      <literal>
        <vodml-id>dataset.CreationType.filtered</vodml-id>
        <name>filtered</name>
        <description>
May involve excluding data prior to binning into samples, also "on-the-fly"

</description>
      </literal>
      <literal>
        <vodml-id>dataset.CreationType.mosaic</vodml-id>
        <name>mosaic</name>
        <description>
Combines multiple original datasets "on-the-fly"
</description>
      </literal>
      <literal>
        <vodml-id>dataset.CreationType.spectral extraction</vodml-id>
        <name>spectral extraction</name>
        <description>
Has been extracted, for example, from a spectral data cube.

</description>
      </literal>
      <literal>
        <vodml-id>dataset.CreationType.catalog extraction</vodml-id>
        <name>catalog extraction</name>
        <description>
Has been extracted from a catalog.
</description>
      </literal>
    </enumeration>

    <enumeration>
      <vodml-id>dataset.RightsType</vodml-id>
      <name>RightsType</name>
      <description>
Enumeration of access rights levels.

</description>
      <literal>
        <vodml-id>dataset.RightsType.public</vodml-id>
        <name>public</name>
        <description>
unrestricted, public access is allowed, without authentication.
</description>
      </literal>
      <literal>
        <vodml-id>dataset.RightsType.proprietary</vodml-id>
        <name>proprietary</name>
        <description>
only proprietary access is allowed with authentication. 

</description>
      </literal>
      <literal>
        <vodml-id>dataset.RightsType.secure</vodml-id>
        <name>secure</name>
        <description>
authenticated, public access is allowed.
</description>
      </literal>
    </enumeration>

    <enumeration>
      <vodml-id>dataset.SpectralBandType</vodml-id>
      <name>SpectralBandType</name>
      <description>
          TODO : Missing description : please, update your UML model asap.
        </description>
      <literal>
        <vodml-id>dataset.SpectralBandType.Radio</vodml-id>
        <name>Radio</name>
        <description>
λ ≥ 10 mm; ν ≤ 30 GHz
</description>
      </literal>
      <literal>
        <vodml-id>dataset.SpectralBandType.Millimeter</vodml-id>
        <name>Millimeter</name>
        <description>
0.1 mm ≤ λ ≤ 10 mm; 3000 GHz ≥ ν ≥ 30 GHz

</description>
      </literal>
      <literal>
        <vodml-id>dataset.SpectralBandType.Infrared</vodml-id>
        <name>Infrared</name>
        <description>
1 μ ≤ λ ≤ 100 μ
</description>
      </literal>
      <literal>
        <vodml-id>dataset.SpectralBandType.Optical</vodml-id>
        <name>Optical</name>
        <description>
0.3 μ ≤ λ ≤ 1 μ

</description>
      </literal>
      <literal>
        <vodml-id>dataset.SpectralBandType.Ultraviolet</vodml-id>
        <name>Ultraviolet</name>
        <description>
100 Å ≤ λ ≤ 3000 Å; 1.2 eV ≤ E ≤ 120 eV

</description>
      </literal>
      <literal>
        <vodml-id>dataset.SpectralBandType.X-ray</vodml-id>
        <name>X-ray</name>
        <description>
0.1 Å ≤ λ ≤ 100 Å; 0.12 keV ≤ E ≤ 120 keV

</description>
      </literal>
      <literal>
        <vodml-id>dataset.SpectralBandType.Gamma-ray</vodml-id>
        <name>Gamma-ray</name>
        <description>
E ≥ 120keV
</description>
      </literal>
    </enumeration>

    <objectType>
      <vodml-id>dataset.DataModel</vodml-id>
      <name>DataModel</name>
      <description>
This object provides specific information regarding the data model and version thereof that a dataset represents.  This information is primarily an aide to (de)serialization of the dataset.  As such, it would better be defined by serialization conventions.  In lieu of such conventions, we include this object and representative serialization examples for the primary file formats VOTable and FITS.

</description>
      <attribute>
        <vodml-id>dataset.DataModel.name</vodml-id>
        <name>name</name>
        <description>
Formatted string providing the name and version of the model document.  The format speficication is "[name]-[version].[subversion]". Each derived model should specifically state the appropriate string for this field.

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.DataModel.prefix</vodml-id>
        <name>prefix</name>
        <description>
Prefix string used in UType string for elements associated with the model.  For IVOA standard models, this will be a predetermined string (e.g. 'stc' or 'spec').  Extended, or user defined content can specify a unique prefix for their own content.

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.DataModel.URL</vodml-id>
        <name>URL</name>
        <description>
URL pointer to the XML schema associated with the model.

</description>
        <datatype>
          <vodml-ref>ivoa:anyURI</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
    </objectType>

    <objectType abstract="true">
      <vodml-id>dataset.Dataset</vodml-id>
      <name>Dataset</name>
      <description>
Abstract object for the generic IVOA Dataset.  It is intended to be useful for any type of data.  Specific dataset models should extend this object, providing detailed definitions and additional content as appropriate for that type of dataset.

</description>
      <attribute>
        <vodml-id>dataset.Dataset.dataProductType</vodml-id>
        <name>dataProductType</name>
        <description>
Describes the high level scientific classification of the data content.  Values are restricted to the DataProductType enumeration set and convey the general idea of the content and organization of
a dataset.

</description>
        <datatype>
          <vodml-ref>ds:dataset.DataProductType</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.Dataset.dataProductSubtype</vodml-id>
        <name>dataProductSubtype</name>
        <description>
Secondary type classification for the dataset.  This field is intended to precisely specify the scientific nature of the data product, possibly in terms relevant only to a specific archive or data collection.  For example, dataProductType='image' could have associated dataProductSubtype="src.image", "bkg.image", "PixelMask", etc.  Values are unrestricted strings.

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <collection>
        <vodml-id>dataset.Dataset.curation</vodml-id>
        <name>curation</name>
        <description>
Provides metadata related to the entity responsible for the curation of the dataset.

</description>
        <datatype>
          <vodml-ref>ds:dataset.Curation</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </collection>
      <collection>
        <vodml-id>dataset.Dataset.dataID</vodml-id>
        <name>dataID</name>
        <description>
DataID provides high level identification metadata for the dataset itself, and any associations with various collections.
</description>
        <datatype>
          <vodml-ref>ds:dataset.DataID</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </collection>
    </objectType>

    <objectType>
      <vodml-id>dataset.DataID</vodml-id>
      <name>DataID</name>
      <description>
The Data Identification object (DataID) stores the dataset identifiers and its membership within larger collections.
        The Dataset IDs in this object must comply with the syntax for dataset identifiers defined in the "IVOA Identifiers" document, including the use of 'stop' characters to identify specific datasets that are not individually in the registry.   e.g., ivo://example.net/aservice?2013/5/2342.
        Much of the content of this object is assembled from various definitions in the IVAO Resource Metadata document.  Here, we provide a brief description of each field for easy reference, along with a notation of its mapping to the Resource Metadata document (RM:field), where the reader may find more detailed information.

</description>
      <attribute>
        <vodml-id>dataset.DataID.title</vodml-id>
        <name>title</name>
        <description>
A free form string giving a title for the dataset.  (RM:Identity.Title)
</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.DataID.datasetID</vodml-id>
        <name>datasetID</name>
        <description>
If the dataset is registered with an external 'global index service' such as ADS, the publisher may include that identifier here.  This provides a common, persistent identifier for the dataset, and possible access point to follow for information on publications and other related datasets.  Note: the same dataset published at more than one location would have different Curation.publisherDID values, but the same DataID.datasetID.  eg: "ivo://ADS/Sa.CXO?obsid=1234", "ivo://ADS/sh.hut#ngc4151_141"

</description>
        <datatype>
          <vodml-ref>ivoa:anyURI</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.DataID.creatorDID</vodml-id>
        <name>creatorDID</name>
        <description>
The dataset identifier assigned by the creator.  Here, the authority-id of the identifier must be that of the creator.  It is used to identify the original exposure of the dataset in an archive, and will remain static regardless of where the dataset is published.  The creator ID will not necessarily change even if the VO object in question is a cutout or is otherwise further processed.

</description>
        <datatype>
          <vodml-ref>ivoa:anyURI</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.DataID.date</vodml-id>
        <name>date</name>
        <description>
Data processing or creation date (RM:Curation.Date).
</description>
        <datatype>
          <vodml-ref>ivoa:datetime</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.DataID.creator</vodml-id>
        <name>creator</name>
        <description>
A free form string giving the name of the institution or entity which created the dataset.  (RM:Curation.Creator)

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.DataID.collection</vodml-id>
        <name>collection</name>
        <description>
The dataset is associated with zero or more Collections (instrument name, survey name, etc.) .  Each instance is a free form string of a particular collection tag.  The values are generally defined by the creating entity and indicate some degree of compatibility with other data sharing the same Collection properties.  Examples: "WFC", "Sloan", "BFS Spectrograph", "MSX Galactic Plane Survey".

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>-1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.DataID.version</vodml-id>
        <name>version</name>
        <description>
Version assigned by the creator, reflecting the production version of the dataset.  This value should only be changed by the creator, upon the new release of a dataset.  There are no format restrictions or specifications on the versioning scheme.

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.DataID.creationType</vodml-id>
        <name>creationType</name>
        <description>
The dataset creation type describes the nature or genre of the content.  (RM:General.Type).
</description>
        <datatype>
          <vodml-ref>ds:dataset.CreationType</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.DataID.logo</vodml-id>
        <name>logo</name>
        <description>
URL pointer to a graphical logo associated with the creator of the document content.  (RM:Curation.Creator.Logo)
</description>
        <datatype>
          <vodml-ref>ivoa:anyURI</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.DataID.contributor</vodml-id>
        <name>contributor</name>
        <description>
Persons or entities who contributed to the generation of the scientific content of the dataset.  Users of the dataset should include these in subsequent credits and acknowledgements.  Each instance identifies an entity, formatted to the desired acknowledgment expression. (RM:Curation.Contributor)

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>-1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.DataID.observationID</vodml-id>
        <name>observationID</name>
        <description>
Internal ID determined by the data provider to identify the observation from which the dataset was produced.

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
    </objectType>

    <objectType>
      <vodml-id>dataset.Curation</vodml-id>
      <name>Curation</name>
      <description>
The Curation object provides information about the entity responsible for the support of the dataset content.  It is assembled from definitions provided by the IVOA standard document, "Resource Metadata for the Virtual Observatory; Version 1.12"  (Resource Metadata).  Here, we provide a brief description of each field for easy reference, along with a notation of its mapping to the Resource Metadata document (RM:field), where the reader may find more detailed information.
</description>
      <attribute>
        <vodml-id>dataset.Curation.publisher</vodml-id>
        <name>publisher</name>
        <description>
Common name for the entity making the data available.  (RM:Curation.Publisher)

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.Curation.publisherID</vodml-id>
        <name>publisherID</name>
        <description>
IVOA resource identifier associated with the publisher and registered with an IVOA compliant registry  (eg: ivo://mast.stsci.edu).  Values are to be expressed using the syntax described in "IVOA Identifiers".  (RM:Curation.PublisherID)

</description>
        <datatype>
          <vodml-ref>ivoa:anyURI</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.Curation.publisherDID</vodml-id>
        <name>publisherDID</name>
        <description>
IVOA dataset identifier assigned by the publisher to uniquely identify the dataset within its holdings.  Typically, the basis of this identifier will be the publisher ID.  However, if the publisherchooses to use a 'global index service' such as ADS to obtain persistent identifiers for their datasets, rather than generate their own, that identifier should be used both here and for DataID.datasetID.  Note: this model also defines a creator dataset ID (DataID.creatorDID), these will differ if the publishing entity is not the creator of the dataset.  Values are to be expressed as dataset identifiers using the syntax described in "IVOA Identifiers"
</description>
        <datatype>
          <vodml-ref>ivoa:anyURI</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.Curation.version</vodml-id>
        <name>version</name>
        <description>
Version of the curated dataset, assigned by the publisher.  This is an independent versioning from DataID.version that allows the publisher to track changes to the high level dataset metadata (e.g. curation metadata, identifiers, etc.) without effecting the creator defined dataset version.  The value may be based on the DataID.version (e.g. by adding a sub-version extension), or an independent versioning.  There are no format restrictions on the value.  (RM:Curation.Version)

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.Curation.rights</vodml-id>
        <name>rights</name>
        <description>
Indicates the access privileges to the content.  (RM:Collection.Rights)

</description>
        <datatype>
          <vodml-ref>ds:dataset.RightsType</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.Curation.releaseDate</vodml-id>
        <name>releaseDate</name>
        <description>
Date the curated dataset was last modified.  (RM:Curation.Date)
</description>
        <datatype>
          <vodml-ref>ivoa:datetime</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.Curation.reference</vodml-id>
        <name>reference</name>
        <description>
Zero or more bibliographic or documentation references associated with the dataset.  Each instance provides a single forward link to a major publication which references the dataset.  Values should be expressed as a URL, or bibcode (discernible as a 19 character string beginning with 4 digits). Free text references are allowed, but discouraged.  (RM:General.Source)

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>-1</maxOccurs>
        </multiplicity>
      </attribute>
      <collection>
        <vodml-id>dataset.Curation.contact</vodml-id>
        <name>contact</name>
        <description>
Contact information of the person/entity responsible for the content of the dataset.  We recommend using a generic 'helpdesk' type contact rather than individuals whose information may more easily become obsolete. (RM:Curation.Contact)

</description>
        <datatype>
          <vodml-ref>ds:dataset.Contact</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </collection>
    </objectType>

    <objectType>
      <vodml-id>dataset.Contact</vodml-id>
      <name>Contact</name>
      <description>
Contact information for a person or entity.
</description>
      <attribute>
        <vodml-id>dataset.Contact.name</vodml-id>
        <name>name</name>
        <description>
Name of the contact or entity. (RM:Contact.Name)

</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.Contact.email</vodml-id>
        <name>email</name>
        <description>
E-mail address of the contact. (RM:Contact.Email)
</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
    </objectType>

    <objectType>
      <vodml-id>dataset.Characterisation</vodml-id>
      <name>Characterisation</name>
      <description>
This Characterisation object is a direct extension of the Characterisation object from the IVOA Characterisation Data Model Standard.  This provides a local object which may be contained in a 'composition' relation to other objects of this model (specifically ObsDataset).  This object may be extended and/or modified by specific Dataset models as needed.
        Characterisation provides a broad scale description of the coordinate space occupied by the dataset in each of the axis domains.  This includes axes not directly represented in the dataset 'data', for example, the Time axis of a 2D special image.  As such, there is a strong correlation between Characterisation and Data objects.  In some cases, the values may be directly derived from the Data, in others, they provide supporting metadata about the broader domain.  For example, the Accuracy fields in Characterisation represent typical accuracy for the dataset, while those within Data provide per-data-point errors.   
</description>
      <extends>
        <vodml-ref>char:Char</vodml-ref>
      </extends>
    </objectType>

    <objectType>
      <vodml-id>dataset.Derived</vodml-id>
      <name>Derived</name>
      <description>
The Derived (short for Derived Data) object holds derived information obtained by evaluating or analyzing the contents of the dataset.  The specific content of this object is strongly dependent on the specific type of dataset, so we provide a generic model which may be specialized in other models to define elements appropriate for that type of dataset.

The primary purpose of this object is to provide a common framework in which specific information may be placed to aid in discovery and filtering of datasets in various access protocols.
 
</description>
      <collection>
        <vodml-id>dataset.Derived.derivedElement</vodml-id>
        <name>derivedElement</name>
        <description>
Collection of zero or more DerivedElement objects, each of which provides a specific quantity obtained by analyzing the dataset content.

</description>
        <datatype>
          <vodml-ref>ds:dataset.DerivedElement</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>-1</maxOccurs>
        </multiplicity>
      </collection>
    </objectType>

    <objectType abstract="true">
      <vodml-id>dataset.ObsDataset</vodml-id>
      <name>ObsDataset</name>
      <description>
Abstract object extending Dataset with metadata relevant to datasets derived from Observations.

</description>
      <extends>
        <vodml-ref>ds:dataset.Dataset</vodml-ref>
      </extends>
      <attribute>
        <vodml-id>dataset.ObsDataset.calibLevel</vodml-id>
        <name>calibLevel</name>
        <description>
High level classification for the calibration level of the particular dataset as a whole.  The calibration level concept conveys to the user information on how much data reduction/processing has been applied to the data.  It is up to the data providers to consider how to map their own internal classification to the scale defined here.
Scale:
* 0 - Raw instrumental data, in a proprietary or internal data-provider defined format.
* 1 - Instrumental data in a standard format (FITS, VOTable, etc )
* 2 - Calibrated, science ready data with the instrument signature removed.
* 3 - Enhanced data products like mosaics, resampled or drizzled images, or heavily processed survey fields.  Level 3 data products may represent the combination of data from multiple primary observations.

</description>
        <datatype>
          <vodml-ref>ivoa:integer</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <collection>
        <vodml-id>dataset.ObsDataset.characterisation</vodml-id>
        <name>characterisation</name>
        <description>
Characterisation provides a 'characteristic' view of the coordinate space for the dataset as a whole.
</description>
        <datatype>
          <vodml-ref>ds:dataset.Characterisation</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </collection>
      <collection>
        <vodml-id>dataset.ObsDataset.derived</vodml-id>
        <name>derived</name>
        <description>
Provides a high level summary of certain properties of the dataset.  Its primary purpose is to support high level filtering of datasets during data discovery.

</description>
        <datatype>
          <vodml-ref>ds:dataset.Derived</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </collection>
      <reference>
        <vodml-id>dataset.ObsDataset.target</vodml-id>
        <name>target</name>
        <description>
Reference to a BaseTarget object from Observation.  Provides metadata describing the target of the observation.
</description>
        <datatype>
          <vodml-ref>ds:experiment.BaseTarget</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </reference>
      <reference>
        <vodml-id>dataset.ObsDataset.proposal</vodml-id>
        <name>proposal</name>
        <description>
Reference to Proposal object from Observation.  This object provides metadata identifying any proposal related to the observation which produced the dataset.
</description>
        <datatype>
          <vodml-ref>ds:experiment.Proposal</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </reference>
      <reference>
        <vodml-id>dataset.ObsDataset.obsConfig</vodml-id>
        <name>obsConfig</name>
        <description>
Reference to ObsConfig object from Observation.  This object provides some high-level metadata related to the observation configuration.
</description>
        <datatype>
          <vodml-ref>ds:experiment.ObsConfig</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </reference>
      <reference>
        <vodml-id>dataset.ObsDataset.coordSys</vodml-id>
        <name>coordSys</name>
        <description>
Zero or more references to coordinate system defintions associated with the dataset.  Since multiple data products may contibute to the content of a dataset, this element provides convenient, high-level access to definitions which may be distributed among lower-level objects.  

</description>
        <datatype>
          <vodml-ref>stc:AstroCoordSystem</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>0</minOccurs>
          <maxOccurs>-1</maxOccurs>
        </multiplicity>
      </reference>
    </objectType>

    <objectType abstract="true">
      <vodml-id>dataset.DerivedElement</vodml-id>
      <name>DerivedElement</name>
      <description>
Abstract base for defining derived data elements.  Typically, models for specific data products would extend this object to define various elements appropriate for that model.  For example, the Spectrum model could define signal-to-noise ratio (SNR), or TimeSeries could define period, or variability.  We put no restriction on the DerivedElement content since the result could be a simple value or a complex object.  However, it is recommended that extensions be simple and compact in keeping with the primary intent of use in data discovery.

</description>
    </objectType>

    <objectType>
      <vodml-id>dataset.DerivedScalar</vodml-id>
      <name>DerivedScalar</name>
      <description>
Simple extension of DerivedElement class which can serve many use cases.  Usages of this object in other models to define specific elements should explicitly define the element name, and the process by which the value is determined.

</description>
      <extends>
        <vodml-ref>ds:dataset.DerivedElement</vodml-ref>
      </extends>
      <attribute>
        <vodml-id>dataset.DerivedScalar.name</vodml-id>
        <name>name</name>
        <description>
Name identifying the derived element.
</description>
        <datatype>
          <vodml-ref>ivoa:string</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
      <attribute>
        <vodml-id>dataset.DerivedScalar.value</vodml-id>
        <name>value</name>
        <description>
Value of the derived element.

</description>
        <datatype>
          <vodml-ref>ivoa:quantity.Quantity</vodml-ref>
        </datatype>
        <multiplicity>
          <minOccurs>1</minOccurs>
          <maxOccurs>1</maxOccurs>
        </multiplicity>
      </attribute>
    </objectType>

  </package>

</vo-dml:model>
msdemlei@ari.uni-heidelberg.de	ViewVC Help
Powered by ViewVC 1.1.26