ivoa-std / SpectrumDM

Spectrum Data Model
1 stars 2 forks source link

UCDs in standard: #7

Open mcdittmar opened 1 year ago

mcdittmar commented 1 year ago

This ticket stems from review of example serialization from DaCHs in working the V1.2 RFE.

Review comments can be found in the DM email archive (here). As noted below, the V1.1 REC has illegal UCDs in the spec.
These should be reviewed and corrected, but not necessarily as part of the V1.2 RFE.

The review noted:

o UCD discrepancies (no comment on legality/correctness, just differences from the spec.)

  • "spec:Spectrum.Curation.PublisherDID": missing specified UCD
  • "spec:Spectrum.Char.SpatialAxis.Coverage.Bounds.Extent": spec="instr.fov" file="phys.angSize;instr.fov"
  • "spec:Spectrum.Char.SpectralAxis.Coverage.Bounds.Extent": spec="instr.bandwidth" file="em.wl;instr.bandwidth"
  • "spec:Spectrum.Length": missing UCD
  • "spec:Spectrum.Char.FluxAxis.Accuracy.StatError": UCD is missing a bit at end. spec has "em.*" which would presumably be "em.wl" in this dataset but file just has "em"
  • "spec:Spectrum.Char.FluxAxis.Accuracy.SysError": ditto
  • "spec:Spectrum.Char.FluxAxis.Accuracy.SysError": ditto
  • "spec:Spectrum.Char.SpectralAxis.Accuracy.StatError": ditto
  • "spec:Spectrum.Char.SpectralAxis.Accuracy.SysError": ditto

With response (edited - seeding discussion/corrections):

 - "spec:Spectrum.Curation.PublisherDID":  missing specified UCD

Well, the UCD given in SpectrumDM is UCD-invalid. Another case for my point that we should stop requiring specific UCDs for columns and params in standards.

I now went for meta.ref.ivoid from https://wiki.ivoa.net/twiki/bin/view/IVOA/ObsCore-1_1-Erratum-1; this could be a good opportunity to update this UCD in SpectrumDM, too (or, even better, make it explicit that the UCDs given in the example are good patterns but not normative).

 - "spec:Spectrum.Char.SpatialAxis.Coverage.Bounds.Extent":  spec="instr.fov"  file="phys.angSize;instr.fov"

Ah... instr.fov is a again invalid. See https://wiki.ivoa.net/twiki/bin/view/IVOA/SSA-1_1-Err-2. I'll not make this UCD-invalid -- perhaps update the spec?

 - "spec:Spectrum.Length": missing UCD

But that's the case in the spec, too? And putting meta.number here or so indeed doesn't seem helpful.

 - "spec:Spectrum.Char.FluxAxis.Accuracy.StatError": UCD is missing a bit at end. spec has "em.*" which would presumably be "em.wl" in this dataset but file just has "em"

The ";em" is fine UCD-wise. Whether it's helpful is another question, and given the "must be one of" on p. 15 of the 1.1 document, I'm in violation of the current spec here (I frankly don't remember whether I did that on purpose all these years ago).

mcdittmar commented 1 year ago

Porting these actions which relate to EXISTING UCDs in the document from Issue #5.

Action List Candidates:

  1. <item handled by Issue #5>
  2. Update UCD Vocabulary reference in Section 3.4. The file currently being referenced is NOT a REC/EN, but appears to be very close to V1.3 of the UCD vocabulary.
  3. Per this comment, add tags to the document which enables validation of the UCDs contained in the document.
  4. Per this wiki page, the UCD mentioned has been updated in V1.1, but the VOTable example did not follow suite. Correct this and add closure statement to the wiki page.