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 |
Data model describing Photometric properties for data sets to be used for data calibration, comparison or reprocessing.
|
| Access |
objectType |
Gathers all properties to access a resource : uri, format and size .
|
| Access.format |
attribute |
Format of the accessed resource. Typically : application/fits, application/x-votable+xml, text/csv, text/xml. |
| Access.reference |
attribute |
URI to access the resource. |
| Access.size |
attribute |
Approximate estimated size of the dataset, specified in kilobytes. |
| AsinhZeropoint |
objectType |
Extension of ZeroPoint to describe asinh magnitudes, a.k.a. luptitudes. |
| AsinhZeropoint.softeningParameter |
attribute |
Parameter used to correct the calculation of magnitudes for faint sources. Usually called 'b'. See (Lupton and Gunn et al.
[1999]) for a formal explanation.
|
| Bandwidth |
objectType |
This class is used to characterize the spectral properties of a filter.
|
| Bandwidth.extent |
attribute |
Bandwidth’s extent of the filter , as length of the covered spectral interval , or effective width following appropriate filter
type.
|
| Bandwidth.start |
attribute |
In practice, this could be taken as the minimum value of the filter transmission curve. |
| Bandwidth.stop |
attribute |
In practice, this could be taken as the maximum value of the filter transmission curve. |
| Bandwidth.ucd |
attribute |
Unified Content Description (UCD) string that specifies the nature of the bandwidth object. |
| Bandwidth.unitexpression |
attribute |
Unit string that specifies the spectral unit for this filter. |
| Flux |
objectType |
This class is used to characterize the photometric calibration Flux<—> Magnitude associated to the ZeroPoint used by a PhotCal
instance.
|
| Flux.error |
attribute |
Flux value error corresponding to the reference magnitude value of the calibrating object. |
| Flux.ucd |
attribute |
Unified Content Description (UCD) string that specifies the nature of the flux.
|
| Flux.unitexpression |
attribute |
Unit string that specifies the flux unit.
|
| Flux.value |
attribute |
A flux value. |
| ISOTime |
primitiveType |
Time stamp, represented as a string. This representaion is compliant to the DALI time stamp definition : section 3.3.3 Timestamp
in
https://www.ivoa.net/documents/DALI/20170517/REC-DALI-1.1.pdf
This class derives from the ivoa:datetime class.
It could be inserted in the ivoa: template data model for types in a next version.
|
| LinearFluxZeropoint |
objectType |
Extension of ZeroPoint to describe simple linear flux photometry, commonly used in Radio, Far Infrared and X-ray spectral
ranges. Although not being magnitudes as such, relative linear flux measurements can be included as a special and trivial
case of magnitude.
|
| MagnitudeSystem |
objectType |
A class to describe the Magnitude System used , its type and the reference spectrum attached if present. |
| MagnitudeSystem.referenceSpectrum |
attribute |
Link to the reference spectrum as a URI. |
| MagnitudeSystem.type |
attribute |
Type of magnitude system used to compute the associated zeropoint . Typical values are : VEGAmag, ABmag, STmag .
|
| PhotCal |
objectType |
A class to bind together all photometic calibration reference information: a photometry filter, a certain magnitude system
configuration and a certain zero point object.
|
| PhotCal.identifier |
attribute |
A unique identifier of the Photometry calibration instance within the project and a filterprofile service . Suggested syntax
would be:
Facility/Subcategory/Band/Photometric System Type[/Suffix]
|
| PhotCal.magnitudeSystem |
composition |
ZeroPoint values are given with one computation method corresponding to a defined Magnitude system.
|
| PhotCal.photometryFilter |
reference |
Each PhotCal element is related to one single Filter. Some Filter object may have no calibration registered yet. |
| PhotCal.zeroPoint |
composition |
The ZeroPoint value for the flux to mag translation belongs to a Photcal element and is defined for one Filter element and
one MagnitudeSystem .
|
| PhotometricSystem |
objectType |
The reference photometric system used to interpret photometric measurements. |
| PhotometricSystem.description |
attribute |
This string contains a human readable short-text representation of the photometric system. This will allow client applications
to display textual information to final users.
|
| PhotometricSystem.detectorType |
attribute |
Detector type associated to this photometric system. Possible values are: 0 for Energy counter (amplifiers), 1 for Photon
counter (CCDs, Photomultipliers).
|
| PhotometricSystem.photometryFilter |
composition |
The Photometric information is related to a Photometric system, and gathers filter descriptions, for one or several .
|
| PhotometryFilter |
objectType |
Filter class to store ids, name and properties.
|
| PhotometryFilter.bandname |
attribute |
A standard label representing the spectral band associated to this filter (if any). |
| PhotometryFilter.bandwidth |
composition |
Association to the spectral band-pass of the Filter.
|
| PhotometryFilter.dateValidityFrom |
attribute |
Start time of the time coverage for which this filter configuration is applicable. String time format accepted is ISO8601.
|
| PhotometryFilter.dateValidityTo |
attribute |
End time of the time coverage for which this filter configuration is applicable. String time format accepted is ISO8601.
|
| PhotometryFilter.description |
attribute |
This string contains a verbose human readable label for the filter. This will allow client applications to display textual
information to final users.
|
| PhotometryFilter.fpsidentifier |
attribute |
IVOA identifier of the filter profile service where this photometry filter is registered to be used in the discovery of all
the relevant photometry filter properties.
|
| PhotometryFilter.identifier |
attribute |
This field identifies a filter, in a unique way, within a certain Photometry Filter Profile service.
Example to build this string : Facility/Subcategory/Band[/Suffix] like SDSS/SDSS.G/G
|
| PhotometryFilter.name |
attribute |
A human readable string to represent the filter name. |
| PhotometryFilter.spectralLocation |
composition |
Association to a spectral coordinate value for locating the Filter band-pass. Usually the mean value.
|
| PhotometryFilter.transmissionCurve |
composition |
Link to the Transmission Curve of the Filter, when this is described. |
| PogsonZeropoint |
objectType |
Extension of ZeroPoint to accommodate standard logarithm magnitudes. It has no supplementary attributes but specific conversion
functions.
|
| SpectralLocation |
objectType |
A spectral coordinate value for locating the Filter band-pass. Usually the mean value (for instance in wavelength units).
This class is used to characterize the spectral properties of a filter.
|
| SpectralLocation.ucd |
attribute |
Unified Content Description (UCD) string that specifies the nature of the spectral location for this filter. |
| SpectralLocation.unitexpression |
attribute |
Unit string that specifies the spectral units for this filter. |
| SpectralLocation.value |
attribute |
A spectral coordinate value that can be considered by the data provider as the most representative for this specific filter
bandpass.
In the Optical regime this can represent the effective wavelength, for instance.
|
| TransmissionCurve |
objectType |
A collection of points along the spectral axis to indicate how flux are transmitted by a filter.
The transmission profile can be described by an external file and accessed through the Access instance, or can be stored as
a collection of transmission points stored together in the PhotometryFilter serialized instance.
|
| TransmissionCurve.access |
composition |
Access to an external file containing the set of Transmission Points. |
| TransmissionCurve.transmissionPoint |
composition |
Set of points of the transmission curve. |
| TransmissionPoint |
objectType |
This class is used to represent a point in the transmission function of a Filter.
|
| TransmissionPoint.spectralErrorValue |
attribute |
Error on the spectral coordinate value for the transmission point. |
| TransmissionPoint.spectralValue |
attribute |
Spectral coordinate value for the transmission point. |
| TransmissionPoint.transmissionValue |
attribute |
Transmitted value for the filter at this point of the transmission curve. Usually between 0 and 1.
|
| TransmissionPoint.ucd |
attribute |
Unified Content Description (UCD) string that specifies the nature of the spectral axis in the transmission curve. |
| TransmissionPoint.unit |
attribute |
Unit string that specifies the spectral unit for this filter. |
| TypeOfMagSystem |
enumeration |
The type of System used to compute magnitude for this photometric calibration procedure . |
| TypeOfMagSystem.ABmag |
literal |
AB magnitude system. |
| TypeOfMagSystem.STmag |
literal |
ST magnitude system. |
| TypeOfMagSystem.VEGAmag |
literal |
Magnitude system related to VEGA. |
| UCD |
primitiveType |
Controlled vocabulary to tag measurements in table columns . See UCD IVOA Recommendation .
|
| ZeroPoint |
objectType |
This class is used to characterize a zero point flux obtained during the calibration of a certain photometry filter on a certain
photometric system configuration.
|
| ZeroPoint.flux |
composition |
Points to the flux value associated to this ZeroPoint magnitude.
|
| ZeroPoint.referenceMagnitudeError |
attribute |
Total error estimated on the reference magnitude value whenever applicable.
|
| ZeroPoint.referenceMagnitudeValue |
attribute |
Reference magnitude value of the calibrating object. can be a implemented as a double number to get the maximum precision.
Default value is zero, but sometimes the reference mag measured is slightly above.
|
| ZeroPoint.type |
attribute |
Type describing the way the zeropoint value is defined . Is an integer value : {0=Pogson, 1=Asinh, 2=Linear} corresponding
to zero point definitions.
|
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.
