**Why STC-2.0?**

Version 1 of STC was developed in 2007, prior to the development and adoption of vo-dml modeling practices. As we progress to the development of vo-dml compliant component models, it is necessary to revisit those models which define core content. Additionally, the scope of the STC-1.0 model is very broad, making a complete implementation and development of validators, very difficult. As such it may be prudent to break the content of STC-1.0 into component models itself, which as a group, cover the scope of the original.

This effort will start from first principles with respect to defining a specific project use-case, from which requirements will be drawn, satisfied by the model, and implemented in the use-case. We will make use of the original model to ensure that the coverage of concepts is complete and that the models will be compatible. However, the form and structure may be quite different. This model will use vo-dml modeling practices, and model elements may be structured differently to more efficiently represent the concepts.

**Context and Scope**

Measurement: Describes measured or determined data

- associates the coordinate value with errors

- the coordinate space; axes and domain ranges
- coordinate frames with metadata describing the origin and orientation of the coordinate space
- a general model for specifying coordinate values within the coordinate space
- simple specialized coordinates fro the most common cases
- coordinate systems associating related coordinate frames

- atomic transform operations
- operations which combine operations into sequences; either in series or in parallel
- operations which facilitate dimensional manipulation
- add, delete, duplicate dimensions
- shuffle axis order

domain experts: Jim Bosch (LSST), Ian Evance (SAO); ArnoldRots (retired)

data modeler: MarkCresitelloDittmar

editor(s): MarkCresitelloDittmar

author(s)

- Coords: ArnoldRots, GerardLemson, OmarLaurino
- Trans: ArnoldRots, DavidBerry, StevenCrawford, NadiaDencheva, PerryGreenfield, TimJenness, OmarLaurino, StuartMumford, ErikTollerud
- Meas: ArnoldRots, GerardLemson, OmarLaurino

Many thanks to those who contributed to the quality of the models through review and assessments. In particular,

- MarkusDemleitner - thorough reviews with attention to usability and impact on users/clients of various representations
- AdaNebot - review and assessment in the context of TimeSeries data
- FrancoisBonnarel - review and detailed assessments of Transform model

1) The primary use case for this work is in support of the CubesDM

- focus on N-Dimensional model pixelated image and sparse data cubes;
- General
- knowledge of the pixel and physical domain spaces provided at a high level
- definition of the domain space includes the following criteria
- dimensionality (typically 1,2 or 3 for physical domain), pixel domain may be of any dimension
- axis configuration (for spatial domain which has >1D). The most common configurations for astronomical data are Cartesian and Spherical, but others may be used as well.
- domain range along each axis, typically +/- Inf, but may be limited due to physical constraints (e.g. physical size of a detector, sensitivity limitiations, etc)
- association with additional metadata further describing the nature of the domain space ( Frame ). This is especially true for the Spatial and Temporal domains, but may apply to others as well.
- reference position (location of origin)
- reference frame (orientation of the domain space)
- planetary ephemeris
- equinox

- Pixelated Image Cube
- complete specification of pixel coordinate domain; number of axes, number of pixels per axis
- image axes
- in pixel domain, are a binned coordinate space with integerized values (pixel indexes)
- mapped to various 'physical' coordinate spaces via transform operations
- any combination of pixel axes may be involved in transform to any given 'physical' space
- any pixel axis may be involved in more than one mapping
- mappings often involve multiple steps executed in sequence
- mappings may define a progressive migration in coordinate space (e.g. pixel -> ccd -> detector -> sky -> wcs )
- intermediate stages may or may not be explicitly defined. Therefore, mappings must be stackable in series.

- transform operations should be flexible in covering the n-dimensional space. e.g. Application of Scale operations to 1D, 2D, nD axes.
- pixel axis mappings are typically to a continuous domain, but may also be to a discrete domain such as Polarization state.

- image cubes may have any number of dimensions, but are typically separable into co-dependent axes of 1, 2, or 3 dimensions.
- spatial domain typically 2-3 dimensions
- other domains (time, spectral, polarization), are typically 1 dimensional

- image data value is typically given in a physical domain, but may itself be mapped to other domains

- Sparse Cube
- data axes cover a wide array of physical domains including, but not limited to Spatial, Temporal, Spectral, Polarization,
- individual domains may be represented multiple times in different frames ( ccd, detector, sky; pha, energy )
- data values may have associated errors
- typical error forms include: symmetric( +/- a ), asymmetric( +a:-b ), interval ( a:b ), matrix
- for multi-dimensional: elliptical,
- quality indicators:
- global status, typically numeric
- bit array, where each bit is associated with a particular quality state

- for multi-dimensional data, associated errors may be separable or correlated

- data axes may be virtual, defined as a mapping from other data axes
- here, the originating space is not pixelated, but an arbitrary space.
- axes involved in a mapping need not be associated with the same physical domain.
- X,Y = Map(x,y,temp); Transform with spatial and thermal dependence

- dimensionality may change between operations

- Physical Data (Observables)
- focus the following domains which are frequently included in astronomical data cubes. Domains: Spatial, Spectral, Temporal, Polarization.
- Spatial
- Cartesian space: chip, detector, sky
- Spherical space: Equatorial, Ecliptic, Galactic, LongLat

- Time
- 1Dimensional: JD, MJD, ISOTime, TimeOffset

- Polarization
- Discrete space: Polarization states (Stokes, Linear, Circular, Vector )

- Spectral
- 1Dimensional: energy, frequency, wavelength

- serialization in YAML of complete WCS metadata, including source/target frames and the various Transform operation sequences between them.
- the generation and passing thereof between two Transform library implementations
- This use case emphasizes the workflow and combination of atomic operations.
- combining operations in parallel to cover the dimension space
- combining operations in series to accomplish multi-stage mappings
- management and direction of axes through the operation sequence, for example:
- duplicate axes x and y to send pair into 2D-Polynomial transforms, generating x',y'; in reverse direction, select axes 3 and 2
- from 4D axis set, send axes 1,3 into operation A, axis 2 into operation B, axis 4 into operation C
- send 2D axis set into 3D operation, adding axis 3 with default value.

- handling of both forward and inverse operations
- for operations with no natural inverse, must be able to assign (optionally) an independent operation spec to be used in that direction.

Examination and implementation of the above cases leads to the following set of requirements distributed through the various STC component models.

- Structure
- [vodml.001] The model shall be vo-dml compliant, producing a validated vo-dml XML description.
- [vodml.002] shall re-use, or refer to, dependent models for objects and concepts already defined in other models
- [vodml.003] shall produce documentation in vo-dml HTML format
- [vodml.004] shall produce documentation in standard PDF format

- Application/Usage
- [user.001] Users should be able to identify and use basic content with minimal specialized information.
- in other words, a generic utility should be able to find and use core elements without knowing a lot about the various extensions and uses of those elements.

- [user.002] When applicable, the model should support usability by simplifying common scenarios.
- i.e. keep common things simple, and complex things possible

- [user.001] Users should be able to identify and use basic content with minimal specialized information.
- Domains
- [dom.001] Shall accommodate the description of data in any observable domain
- [dom.002] Shall provide enhanced/specialized description for data pertaining to * [dom.0002.1] Pixel domain: binned, integerized, n-dimensional domain * [dom.0002.2] Spatial domain: continuous domain, typically in 2-3 dimensional cartesian or spherical spaces * [dom.002.3] Time domain: continuous 1D domain, typically provided in JD, MJD, ISO, or as an Offset from a zero point * [dom.0002.4] Polarization domain: discrete 1D domain of polarization states.

- Measurements
- [meas.001] Shall relate a coordinate value with associated errors
- [meas.002] Shall support multiple error associations per value to describe errors from different sources
- [meas.003] Any specific error source may appear only once
- [meas.004] Errors may be correlated between component values ( ie: may apply to coordinate set as a whole )
- [meas.005] Values associated with different domains may have correlated errors (ie: components of coordinate tuple may refer to different domains, and have non-separable errors)
- [meas.006] Shall support the most common error forms, including, but not limited to: Symmetrical, Asymmetrical, Interval, Elliptical, Matrix
- [meas.007] Shall provide specialized objects related to measurements in the priority domains ( Spatial, Spectral, Temporal, Polarization ); leveraging [user.0002] where possible
- [meas.008] Shall allow for the representation data outside the priority domains

- Coordinates
- Coordinate Spaces:
- [coords.001] Shall facilitate the description of the domain space
- [coords.001.1] Coordinate space shall consist of 1 to N dimensional axes
- [coords.001.2] Shall support the description of axes which are continuous, binned, and discrete in nature
- [coords.001.3] Each dimensional axis shall define the domain range of that axis as appropriate for its nature

- [coords.001] Shall facilitate the description of the domain space
- Coordinate frames:
- [coords.002] Shall facilitate the specification of the nature of the domain, providing additional metadata relevant to the interpretation of coordinates in that domain.

- Coordinates:
- [coords.003] Shall identify a location within the coordinate domain space
- [coords.004] Shall be associated with a corresponding coordinate frame providing metadata relevant to the interpretation of the coordinate
- [coords.005] Shall be associated with a particular axis of the coordinate space to provide context for the coordinate and facilitate the application of mapping Transforms
- [coords.006] Shall be complete quantities, including value and units as appropriate
- [coords.007] Shall support the association of atomic coordinates into a multi-dimensional compound grouping

- Coordinate systems:
- [coords.008] Shall provide for encapsulating the description of the entire domain space
- [coords.009] for Pixel domain, this must include the full coordinate space description
- [coords.010] for Physical domains, this must include the Frame specifications, as it is this metadata that is more relevant to users. The coordinate space is typically well defined or implied by the coordinate itself.

- Coordinate Spaces:
- Transforms:
- [trans.001] Shall facilitate the relation of two coordinate frames through a mathematical formula (Transforms)
- [trans.001.1] Shall facilitate the transport of same independent of any actual data

- [trans.002] Shall define a set of atomic Transform operations commonly used in astronomical applications
- [trans.002.1] at a minimum, will accomodate common operations found in FITS images and data cubes, including but not limited to:
- Linear, Matrix, FITS WCS projection, Lookup table, Polynomial (1D and 2D)

- [trans.002.2] shall accommodate and be compatible with established implementation packages AST, and gWCS

- [trans.002.1] at a minimum, will accomodate common operations found in FITS images and data cubes, including but not limited to:
- [trans.003] Shall allow the combination of operations in sequence, to form complex, multi-stage transforms.
- [trans.004] Shall allow the combination of operations in parallel to cover the appropriate domain space
- [trans.005] Shall support bi-directional workflow (forward and inverse), including the explicit assignment of independent operations for types which have no natural inverse.
- [trans.006] Shall provide operations to facilitate a work flow that requires manipulation of the dimensional axes through the process
- [trans.006.1] duplicate axes, e.g. to send axis pair (x,y) into 2 Poly2D operations to form (x',y')
- [trans.006.2] shuffle axis order [x,y,z] => [x,z,y]
- [trans.006.3] add or drop dimensions
- [trans.006.4] allow explicit control of flow in both forward and inverse directions
- [trans.006.4.1] preferential selection of source in reverse direction for duplicated input axes
- [trans.006.4.2] one-to-one axis mappings are not, necessarily, bi-directional

- [trans.001] Shall facilitate the relation of two coordinate frames through a mathematical formula (Transforms)

**Latest Document:**

The current documentation may be found on Volute:

**Volute:**

The current working draft of the document, including all images and source document can be found in the volute repository.. here

**UML Model:**

We also provide an export of the UML specification in XMI format (version 2.4.1), which is compatible with the vo-dml xslt scripts for generating the vo-dml XML representation.

**vo-dml:**

VO-DML XML serialization of the model and corresponding HTML page are here

Significant discussion threads from dm working group mailing list:

STC2 and VO-DML compliance:

Discussion on conflicts between stc2 model and vo-dml rules, specifically regarding the multiplicity of attributes.

- initial discussion in Cube thread
- STC2 Model and VO-DML Issues - spawn to independent thread
- STC2 Model and VO-DML Issues - pickup Dec. entries

- 2017-05-15 version:
- Coords:

- Trans:
- STC transforms/Polynomial distortions - evaluation presentation of Transform model content.

- Meas:

**Serializations:**

- VOTable COOSYS
- this represents a standardized serialization of a Coordinate model SpaceFrame
- COOSYS => SpaceFrame
- COOSYS.system => SpaceFrame.spaceRefFrame
- COOSYS.equinox => SpaceFrame.equinox
- COOSYS.epoch => would map to epoch of a particular measurement set, outside the scope of SpaceFrame
- NOTE: COOSYS lacks the 'refPosition' present in SpaceFrame.. this is on the list as a probable enhancement to COOSYS

- this represents a standardized serialization of a Coordinate model SpaceFrame
- VOTable TIMESYS
- in progress for VOTable 1.4, this is similarly, a standardized serialization of Coordinate model TimeFrame
- TIMESYS => TimeFrame
- TIMESYS.timescale => TimeFrame.timescale
- TIMESYS.refPosition => TimeFrame.refPosition
- TIMESYS.timeorigin => TimeOffset.time0; centralizing this information high in the serialization

- in progress for VOTable 1.4, this is similarly, a standardized serialization of Coordinate model TimeFrame
- Externally generated
- jovial: A set of example serializations of various Coordinate and Measurement instances generated by Omar Laurino using his Jovial DSL package
- https://olaurino.gitlab.io/ivoa-dm-examples/0000/01/03/Coords.html
- https://olaurino.gitlab.io/ivoa-dm-examples/0000/01/02/STC-current.html - examples of Measurement and Coords based on earlier versions of the models

- vodml Parser: Notebook developed by Omar Laurino parses vo-dml/Mapping annotation to generate instances of TimeSeries-Cube-Meas-Coord using AstroPy and generates plots of the content using Matplotlib. Note: this was developed and presented in 2017 using earlier drafts of the models. These vary only in detail, and the demo could be updated to the current model suite.
- TDIG: Working project of Time Series as Cube.
- Example serializations have been generated using various annotation syntax to identify the model elements.

- jovial: A set of example serializations of various Coordinate and Measurement instances generated by Omar Laurino using his Jovial DSL package
- Modeler Examples:
- using home grown python code, the modeler has generated example serializations which span all elements of the models. The examples are generated in 3 formats:
- VOTable-1.3 standard syntax; Validates using votlint
- VOTable-1.3 annotated with VO-DML/Mapping syntax; Validates using xmllint to a VOTable-1.3 schema enhanced with an imported VO-DML mapping syntax schema
- XML format; Validates against the model schema
- An internal DOC format; XML/DOM structure representing the instances generated when interpreting the templates.

- using home grown python code, the modeler has generated example serializations which span all elements of the models. The examples are generated in 3 formats:

- TDIG: Working project of Time Series as Cube.
- An ongoing project is underway to enhance SPLAT to load/interpret/analyze TimeSeries data, the tool being enhanced to use new annotations (eg: TIMESYS) to identify and interpret the data automatically.
- Delays in resolving on a standard annotation syntax has delayed progress on this project to fully realize the possibilities. This is a high-priority for upcoming work.

- pyVO: extract_skycoord_from_votable()
- Demonstrated in Paris this product of the hack-a-thon generates AstroPy SkyCoord instances from VOTables using various elements embedded in the VOTable.
- Interrogates a VOTable, identifies key information and uses that to automatically generate instances of SkyCoord.
- UCD: 'pos.eq.ra', 'pos.eq.dec'
- COOSYS.system: "ICRS", "FK4", "FK5"
- COOSYS.equinox

- The COOSYS maps directly to SpaceFrame, and the value of the system
- The UCD 'pos.eq' maps directly to meas:EquatorialPosition; with 'pos.eq.ra|dec' identifying the corresponding attributes (EquatorialPosition.ra|dec) as coordinates coords:Longitude and coords:Latitude.
- This illustrates that even with minimal annotation, this sort of automatic discovery/instantiation can take place. With a defined annotation syntax, this utility could be expanded to generate other AstroPy objects very easily.

- Interrogates a VOTable, identifies key information and uses that to automatically generate instances of SkyCoord.

- Demonstrated in Paris this product of the hack-a-thon generates AstroPy SkyCoord instances from VOTables using various elements embedded in the VOTable.

The Transform model is compatible with three popular and well establised Transform implementation libraries. The table below shows the coverage of the various libraries to the model elements:

- AST: Starlink's Library for Handling World Coordinate Systems in Astronomy. (Python, Perl, Java, and C )
- GWCS: Generalized WCS implementation, with basis in the astropy modeling package. (Python)
- WCSLIB: implements the "World Coordinate System" (WCS) standard in FITS (C, Fortran)

WCS Transform Model Element | AST | GWCS | WCSLIB | |
---|---|---|---|---|

TransformSet | FrameSet | WCS.pipeline | ||

TransNode | WCS.step | |||

Mapping | Mapping | Model | ||

CompoundMap | CmpMap | CompoundModel | ||

ComposeMap | CmpMap | Model composition | ||

ConcatenateMap | CmpMap | Model concatenation | ||

BiDirectionalMap | TranMap | Model | ||

BiDirectionalMap.forwardMap | TranMap.map1 | wcs.forward_transform | ||

BiDirectionalMap.inverseMap | TranMap.map2 | wcs.backward_transform | ||

Permute | PermMap | Mapping | ||

Unit | UnitMap | Identity | ||

Shift | ShiftMap | Shift | lin.h | |

Scale | ZoomMap | Scale | lin.h | |

Rotate2D | Rotation2D | |||

EulerRotation | EulerAngleRotation | |||

Matrix | MatrixMap | |||

Projection | ||||

o SkyProjection | WCSMap | Projection - each alg a separate class | prj.h | |

o SphericalRotation | RotateNative2Celestial,RotateCelestial2Native | sph.h | ||

o SpectralProjection | SpecMap | spx.h | ||

Polynomial1D | PolyMap | Polynomial1D | ||

Polynomial2D | PolyMap | Polynomial2D | ||

Lookup | LutMap | Tabular1D,Tabular2D | tab.h |

Modifying content added by: -- ArnoldRots - 2017-11-07

Rather than proposing a set of shortcut elements for the model, we are transforming it to a list of Astronomical properties which should be supported by the model and the current means of representing them.

Property | Measure | Coordinate | Frame | Description | Notes |

Time | Time | JD | TimeFrame | Time as a Julian Date | |

MJD | TimeFrame | Time as a Modified Julian Date | |||

ISOTime | TimeFrame | Time as a structured string | |||

TimeOffset | TimeFrame | Time as an offset from a zero point | |||

(ra,dec) | EquatorialPosition | Longitude | SpaceFrame | Right Ascension | Coordinate in a spherical space with an equatorial reference frame |

Latitude | SpaceFrame | Declination | |||

(l,b) | GalacticPosition | Longitude | SpaceFrame | Galactic longitude | Coordinate in a spherical space with a galactic reference frame |

Latitude | SpaceFrame | Galactic latitude | |||

(elong,elat) | EclipticPosition | Longitude | SpaceFrame | Ecliptic longitude | Coordinate in a spherical space with a ecliptic reference frame |

Latitude | SpaceFrame | Ecliptic latitude | |||

(long,lat) | Position2D | Longitude | SpaceFrame | Longitude |
Coordinate in a spherical space; any spherical reference frame other than those listed above |

Latitude | SpaceFrame | Latitude | |||

r | Position1D | R | SpaceFrame | Radius | |

(x,y,z) | CartesianPosition | X | SpaceFrame | Cartesian X | Coordinate in a cartesian space; may be combined with any reference frame |

Y | SpaceFrame | Cartesian Y | |||

Z | SpaceFrame | Cartesian Z | |||

Energy | GenericMeasure | Standard1DCoord | none | Spectral data expressed as energy | |

Frequency | GenericMeasure | Standard1DCoord | none | Spectral data expressed as frequency | |

Wavelength | GenericMeasure | Standard1DCoord | none | Spectral data expressed as wavelength | reqs refraction index? |

Polarization | Polarization | PolStokes | none | Polarization states - Stokes | Discrete axis |

PolCircular | none | Polarization states - Circular | |||

PolLinear | none | Polarization states - Linear | |||

PolVector | none | Polarization states - Vector | |||

(pmra,pmdec) | ProperMotion | Longitude | SpaceFrame | Proper motion - Equatorial | Coordinate in spherical space with an equatorial reference frame |

Latitude | SpaceFrame | ||||

(pml,pmb) | ProperMotion | Longitude | SpaceFrame | Proper motion - Galactic | Coordinate in a spherical space with a galactic reference frame |

Latitude | SpaceFrame | ||||

(vx,vy,vz) | Velocity3D | X | SpaceFrame | Cartesian velocity - X | Coordinate in a cartesian space; may be combined with any reference frame |

Y | SpaceFrame | Cartesian velocity - Y | |||

Z | SpaceFrame | Cartesian velocity - Z |

| Type | Description | Constraints |

pmelong | RealQuantity | Proper motion in Ecliptic longitude | These four attributes may appear together and require a spherical space and an ecliptic reference frame |

pmelat | RealQuantity | Proper motion in Ecliptic latitude | |

pmlong | RealQuantity | Proper motion in longitude | These five attributes may appear together and require a spherical space and any spherical reference frame other than the ones specified above |

pmlat | RealQuantity | Proper motion in latitude | |

dircosx | real | Direction cosine along X (unit sphere) | These three attributes may appear together, require a unit sphere space and may be combined with any reference frame |

dircosy | real | Direction cosine along Y (unit sphere) | |

dircosz | real | Direction cosine along Z (unit sphere) | |

redshift | 'z' | ||

redshift | doppler velocity - optical | ||

redshift | doppler velocity - radio | ||

redshift | doppler velocity - relativistic |

This topic: IVOA > WebHome > IvoaDataModel > STC > STC2

Topic revision: r26 - 2020-04-30 - MarkCresitelloDittmar

Copyright © 2008-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.

Ideas, requests, problems regarding TWiki? Send feedback

Ideas, requests, problems regarding TWiki? Send feedback