Photometry Data Model

Table of Contents

1.     model: PhotDM
2.     Packages and Types
2.1     [root package]
2.1.1     objectType:Access
2.1.2     objectType:AsinhZeroPoint
2.1.3     objectType:LinearFlux
2.1.4     objectType:MagnitudeSystem
2.1.5     objectType:PhotCal
2.1.6     objectType:PhotometricSystem
2.1.7     objectType:PhotometryFilter
2.1.8     dataType:PhysicalQuantity
2.1.9     dataType:PhysicalQuantityDouble
2.1.10     dataType:PhysicalQuantityInt
2.1.11     objectType:PogsonZeroPoint
2.1.12     dataType:S_Bounds
2.1.13     dataType:S_Coverage
2.1.14     dataType:S_Location
2.1.15     objectType:Source
2.1.16     objectType:SpectralAxis
2.1.17     objectType:TransmissionCurve
2.1.18     dataType:Unit
2.1.19     objectType:ZeroPoint
3.     vodml-id-s
4.     Imported Models
4.1     ivoa

1. Model: Photometry Data Model (PhotDM)

Authors :
Date : 2020-06-08T10:01:35
Version : 1.1
Abstract : This is the data model for Photometric Calibration ...
Diagram : The following diagram has been generated from the model using the GraphViz tool.
The classes and packages in the diagram can be clicked and are mapped to the descriptions of the corresponding element elsewhere in the document.

2.Model contents: Packages and Types

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.

2.1 [root package]

Model PhotDM
Object types Access AsinhZeroPoint LinearFlux MagnitudeSystem PhotCal PhotometricSystem PhotometryFilter PogsonZeroPoint Source SpectralAxis TransmissionCurve ZeroPoint
Data types PhysicalQuantity PhysicalQuantityDouble PhysicalQuantityInt S_Bounds S_Coverage S_Location Unit

2.1.1 objectType: Access

vodml-id Access
description TODO : Missing description : please, update your UML model asap.
attributes
name feature value
Reference type ivoa:anyURI
vodml-id Access.Reference
multiplicity 1
description uri to the effective transmission curve NB this description applies to the inherited access atttribute on TransmissionCurve, not really to the one on the base class.
Format type ivoa:string
vodml-id Access.Format
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
Size type ivoa:real
vodml-id Access.Size
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.

2.1.2 objectType: AsinhZeroPoint

vodml-id AsinhZeroPoint
description TODO : Missing description : please, update your UML model asap.
extends ZeroPoint [PhotDM:ZeroPoint]
attributes
name feature value
softeningCoefficient type ivoa:real
vodml-id AsinhZeroPoint.softeningCoefficient
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.

2.1.3 objectType: LinearFlux

vodml-id LinearFlux
description TODO : Missing description : please, update your UML model asap.
extends ZeroPoint [PhotDM:ZeroPoint]

2.1.4 objectType: MagnitudeSystem

vodml-id MagnitudeSystem
description TODO : Missing description : please, update your UML model asap.
attributes
name feature value
type type ivoa:string
vodml-id MagnitudeSystem.type
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.
referenceSpectrum type ivoa:string
vodml-id MagnitudeSystem.referenceSpectrum
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.
compositions
name feature value
source type Source [PhotDM:Source]
vodml-id MagnitudeSystem.source
multiplicity 0..*
isOrdered false
description TODO : Missing description : please, update your UML model asap.

2.1.5 objectType: PhotCal

vodml-id PhotCal
description TODO : Missing description : please, update your UML model asap.
attributes
name feature value
uniqueIdentifier type ivoa:string
vodml-id PhotCal.uniqueIdentifier
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
references
name feature value
photometryFilter type PhotometryFilter [PhotDM:PhotometryFilter]
vodml-id PhotCal.photometryFilter
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
compositions
name feature value
magnitudeSystem type MagnitudeSystem [PhotDM:MagnitudeSystem]
vodml-id PhotCal.magnitudeSystem
multiplicity 1
isOrdered false
description TODO : Missing description : please, update your UML model asap.
zeroPoint type ZeroPoint [PhotDM:ZeroPoint]
vodml-id PhotCal.zeroPoint
multiplicity 1
isOrdered false
description TODO : Missing description : please, update your UML model asap.

2.1.6 objectType: PhotometricSystem

vodml-id PhotometricSystem
description TODO : Missing description : please, update your UML model asap.
attributes
name feature value
description type ivoa:string
vodml-id PhotometricSystem.description
multiplicity 0..1
description String representation Photometric system
detectorType type ivoa:integer
vodml-id PhotometricSystem.detectorType
multiplicity 1
description Type of detector (e.g energy or photon counter)
compositions
name feature value
contains type PhotometryFilter [PhotDM:PhotometryFilter]
vodml-id PhotometricSystem.contains
multiplicity 1..*
isOrdered false
description TODO : Missing description : please, update your UML model asap.

2.1.7 objectType: PhotometryFilter

vodml-id PhotometryFilter
description TODO : Missing description : please, update your UML model asap.
referrers PhotCal
attributes
name feature value
fpsIdentifier type ivoa:string
vodml-id PhotometryFilter.fpsIdentifier
multiplicity 1
description IVOA identifier of the Filter Profile Service
identifier type ivoa:string
vodml-id PhotometryFilter.identifier
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
name type ivoa:string
vodml-id PhotometryFilter.name
multiplicity 1
description Filter Name in the instrumental configuration
description type ivoa:string
vodml-id PhotometryFilter.description
multiplicity 1
description Text description of the filter band
bandName type ivoa:string
vodml-id PhotometryFilter.bandName
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
DataValidityFrom type ivoa:datetime
vodml-id PhotometryFilter.DataValidityFrom
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
DataValidityTo type ivoa:datetime
vodml-id PhotometryFilter.DataValidityTo
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
compositions
name feature value
filterTransmissionCurve type TransmissionCurve [PhotDM:TransmissionCurve]
vodml-id PhotometryFilter.filterTransmissionCurve
multiplicity 1
isOrdered false
description TODO : Missing description : please, update your UML model asap.
spectralAxis type SpectralAxis [PhotDM:SpectralAxis]
vodml-id PhotometryFilter.spectralAxis
multiplicity 1
isOrdered false
description TODO : Missing description : please, update your UML model asap.

2.1.8 dataType: PhysicalQuantity

vodml-id PhysicalQuantity
description TODO : Missing description : please, update your UML model asap.
Subclasses in this model PhysicalQuantityDouble PhysicalQuantityInt
attributes
name feature value
unit type Unit [PhotDM:Unit]
vodml-id PhysicalQuantity.unit
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.
UCD type ivoa:string
vodml-id PhysicalQuantity.UCD
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.

2.1.9 dataType: PhysicalQuantityDouble

vodml-id PhysicalQuantityDouble
description TODO : Missing description : please, update your UML model asap.
extends PhysicalQuantity [PhotDM:PhysicalQuantity]
attributes
name feature value
value type ivoa:real
vodml-id PhysicalQuantityDouble.value
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
error type ivoa:real
vodml-id PhysicalQuantityDouble.error
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.

2.1.10 dataType: PhysicalQuantityInt

vodml-id PhysicalQuantityInt
description TODO : Missing description : please, update your UML model asap.
extends PhysicalQuantity [PhotDM:PhysicalQuantity]
attributes
name feature value
value type ivoa:integer
vodml-id PhysicalQuantityInt.value
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
error type ivoa:integer
vodml-id PhysicalQuantityInt.error
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.

2.1.11 objectType: PogsonZeroPoint

vodml-id PogsonZeroPoint
description TODO : Missing description : please, update your UML model asap.
extends ZeroPoint [PhotDM:ZeroPoint]

2.1.12 dataType: S_Bounds

vodml-id S_Bounds
description Could be datatype
attributes
name feature value
extent type ivoa:real
vodml-id S_Bounds.extent
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.
start type ivoa:real
vodml-id S_Bounds.start
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
stop type ivoa:real
vodml-id S_Bounds.stop
multiplicity 1
description TODO : Missing description : please, update your UML model asap.

2.1.13 dataType: S_Coverage

vodml-id S_Coverage
description Not really necessary, pattern to indicate how location and bounds can be used together.
attributes
name feature value
location type S_Location [PhotDM:S_Location]
vodml-id S_Coverage.location
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.
bounds type S_Bounds [PhotDM:S_Bounds]
vodml-id S_Coverage.bounds
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.

2.1.14 dataType: S_Location

vodml-id S_Location
description Could be datatype
attributes
name feature value
value type ivoa:integer
vodml-id S_Location.value
multiplicity 1
description TODO : Missing description : please, update your UML model asap.

2.1.15 objectType: Source

vodml-id Source
description TODO : Missing description : please, update your UML model asap.

2.1.16 objectType: SpectralAxis

vodml-id SpectralAxis
description TODO : Missing description : please, update your UML model asap.
attributes
name feature value
Unit type Unit [PhotDM:Unit]
vodml-id SpectralAxis.Unit
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
CoordSys type ivoa:string
vodml-id SpectralAxis.CoordSys
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
UCD type ivoa:string
vodml-id SpectralAxis.UCD
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.
coverage type S_Coverage [PhotDM:S_Coverage]
vodml-id SpectralAxis.coverage
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.

2.1.17 objectType: TransmissionCurve

vodml-id TransmissionCurve
description TODO : Missing description : please, update your UML model asap.
attributes
name feature value
transmissionCurveSpectrum type ivoa:string
vodml-id TransmissionCurve.transmissionCurveSpectrum
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.
compositions
name feature value
access type Access [PhotDM:Access]
vodml-id TransmissionCurve.access
multiplicity 1
isOrdered false
description TODO : Missing description : please, update your UML model asap.

2.1.18 dataType: Unit

vodml-id Unit
description TODO : Missing description : please, update your UML model asap.
attributes
name feature value
expression type ivoa:string
vodml-id Unit.expression
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
scaleSI type ivoa:real
vodml-id Unit.scaleSI
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
dimEquation type ivoa:string
vodml-id Unit.dimEquation
multiplicity 0..1
description TODO : Missing description : please, update your UML model asap.

2.1.19 objectType: ZeroPoint

vodml-id ZeroPoint
description TODO : Missing description : please, update your UML model asap.
abstract True
Subclasses in this model AsinhZeroPoint LinearFlux PogsonZeroPoint
attributes
name feature value
ZeroPointFlux type PhysicalQuantityDouble [PhotDM:PhysicalQuantityDouble]
vodml-id ZeroPoint.ZeroPointFlux
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
referenceMagnitude type PhysicalQuantityDouble [PhotDM:PhysicalQuantityDouble]
vodml-id ZeroPoint.referenceMagnitude
multiplicity 1
description TODO : Missing description : please, update your UML model asap.
type type ivoa:real
vodml-id ZeroPoint.type
multiplicity 1
description TODO : Missing description : please, update your UML model asap.

3.Element Identifiers/VO-DMLrefs

The following table shows all fully qualified vodml-ids for this data model. It is ordered alphabetically and the identifiers are hyper-linked to the location in the document where the actual element is fully defined.
vodml-id feature type description
vo-dml:model This is the data model for Photometric Calibration ...
Access objectType TODO : Missing description : please, update your UML model asap.
Access.Format attribute TODO : Missing description : please, update your UML model asap.
Access.Reference attribute uri to the effective transmission curve NB this description applies to the inherited access atttribute on TransmissionCurve, not really to the one on the base class.
Access.Size attribute TODO : Missing description : please, update your UML model asap.
AsinhZeroPoint objectType TODO : Missing description : please, update your UML model asap.
AsinhZeroPoint.softeningCoefficient attribute TODO : Missing description : please, update your UML model asap.
LinearFlux objectType TODO : Missing description : please, update your UML model asap.
MagnitudeSystem objectType TODO : Missing description : please, update your UML model asap.
MagnitudeSystem.referenceSpectrum attribute TODO : Missing description : please, update your UML model asap.
MagnitudeSystem.source composition TODO : Missing description : please, update your UML model asap.
MagnitudeSystem.type attribute TODO : Missing description : please, update your UML model asap.
PhotCal objectType TODO : Missing description : please, update your UML model asap.
PhotCal.magnitudeSystem composition TODO : Missing description : please, update your UML model asap.
PhotCal.photometryFilter reference TODO : Missing description : please, update your UML model asap.
PhotCal.uniqueIdentifier attribute TODO : Missing description : please, update your UML model asap.
PhotCal.zeroPoint composition TODO : Missing description : please, update your UML model asap.
PhotometricSystem objectType TODO : Missing description : please, update your UML model asap.
PhotometricSystem.contains composition TODO : Missing description : please, update your UML model asap.
PhotometricSystem.description attribute String representation Photometric system
PhotometricSystem.detectorType attribute Type of detector (e.g energy or photon counter)
PhotometryFilter objectType TODO : Missing description : please, update your UML model asap.
PhotometryFilter.DataValidityFrom attribute TODO : Missing description : please, update your UML model asap.
PhotometryFilter.DataValidityTo attribute TODO : Missing description : please, update your UML model asap.
PhotometryFilter.bandName attribute TODO : Missing description : please, update your UML model asap.
PhotometryFilter.description attribute Text description of the filter band
PhotometryFilter.filterTransmissionCurve composition TODO : Missing description : please, update your UML model asap.
PhotometryFilter.fpsIdentifier attribute IVOA identifier of the Filter Profile Service
PhotometryFilter.identifier attribute TODO : Missing description : please, update your UML model asap.
PhotometryFilter.name attribute Filter Name in the instrumental configuration
PhotometryFilter.spectralAxis composition TODO : Missing description : please, update your UML model asap.
PhysicalQuantity dataType TODO : Missing description : please, update your UML model asap.
PhysicalQuantity.UCD attribute TODO : Missing description : please, update your UML model asap.
PhysicalQuantity.unit attribute TODO : Missing description : please, update your UML model asap.
PhysicalQuantityDouble dataType TODO : Missing description : please, update your UML model asap.
PhysicalQuantityDouble.error attribute TODO : Missing description : please, update your UML model asap.
PhysicalQuantityDouble.value attribute TODO : Missing description : please, update your UML model asap.
PhysicalQuantityInt dataType TODO : Missing description : please, update your UML model asap.
PhysicalQuantityInt.error attribute TODO : Missing description : please, update your UML model asap.
PhysicalQuantityInt.value attribute TODO : Missing description : please, update your UML model asap.
PogsonZeroPoint objectType TODO : Missing description : please, update your UML model asap.
S_Bounds dataType Could be datatype
S_Bounds.extent attribute TODO : Missing description : please, update your UML model asap.
S_Bounds.start attribute TODO : Missing description : please, update your UML model asap.
S_Bounds.stop attribute TODO : Missing description : please, update your UML model asap.
S_Coverage dataType Not really necessary, pattern to indicate how location and bounds can be used together.
S_Coverage.bounds attribute TODO : Missing description : please, update your UML model asap.
S_Coverage.location attribute TODO : Missing description : please, update your UML model asap.
S_Location dataType Could be datatype
S_Location.value attribute TODO : Missing description : please, update your UML model asap.
Source objectType TODO : Missing description : please, update your UML model asap.
SpectralAxis objectType TODO : Missing description : please, update your UML model asap.
SpectralAxis.CoordSys attribute TODO : Missing description : please, update your UML model asap.
SpectralAxis.UCD attribute TODO : Missing description : please, update your UML model asap.
SpectralAxis.Unit attribute TODO : Missing description : please, update your UML model asap.
SpectralAxis.coverage attribute TODO : Missing description : please, update your UML model asap.
TransmissionCurve objectType TODO : Missing description : please, update your UML model asap.
TransmissionCurve.access composition TODO : Missing description : please, update your UML model asap.
TransmissionCurve.transmissionCurveSpectrum attribute TODO : Missing description : please, update your UML model asap.
Unit dataType TODO : Missing description : please, update your UML model asap.
Unit.dimEquation attribute TODO : Missing description : please, update your UML model asap.
Unit.expression attribute TODO : Missing description : please, update your UML model asap.
Unit.scaleSI attribute TODO : Missing description : please, update your UML model asap.
ZeroPoint objectType TODO : Missing description : please, update your UML model asap.
ZeroPoint.ZeroPointFlux attribute TODO : Missing description : please, update your UML model asap.
ZeroPoint.referenceMagnitude attribute TODO : Missing description : please, update your UML model asap.
ZeroPoint.type attribute TODO : Missing description : please, update your UML model asap.

4.Imported Models

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.

4.1 ivoa

Model vodml-id ivoa
url http://www.ivoa.net/xml/VODML/20180519/IVOA-v1.0.vo-dml.xml
documentation url https://volute.g-vo.org/svn/trunk/projects/dm/vo-dml/models/ivoa/vo-dml/IVOA-v1.0.html