SODA10Err3 < IVOA

IVOA Web>IvoaDAL>AccessData>SODA>SODA-1_0-Errata>SODA10Err3 (2024-03-15, FrancoisBonnarel) (raw view)

---+ !Server-side Operations for Data Access version 1.0 Proposed Erratum 3: Ambiguous text and wrong VOTable syntax in BAND example

Author: François Bonnarel

Date last changed: 2023-01-23

Date accepted:2023-07-26

---++ Rationale

In section 4.2, the VOTable excerpt given for the BAND PARAM is somewhat ambiguous for the MIN and MAX elements syntax. The values of these elements are single doubles while the  BAND arraysize  attribute is 2. It has to be clarified that the MIN single value applies to  the two elements in the BAND array as well as the MAX single value. This is consistent with a generic rule for MIN/MAX values for  array-valued PARAMs and FIELDS as  described in the VOTable specification starting from version 1.5. PARAMs and FIELDs with "interval" xtype do not apply a specific rule for MIN/MAX interpretration.

In addition the closing tag of the VALUES element is wrongly written <verbatim>/VALUE</verbatim>

instead of <verbatim>/VALUES</verbatim>

This ambiguity orignally described on github in SODA issue #2 (https://github.com/ivoa-std/SODA/issues/2)

---++ Erratum Content

This Erratum proposes following changes.

---++++ Modify text and fix VOTable syntax

In [[http://ivoa.net/documents/SODA/20170517/REC-SODA-1.0.html#tth_sEc4.2][§4.2 "*SODA Service Descriptor from DataLink*"]] of !SODA-1.0, update the BAND  text and example  in

from

<verbatim>
For float-valued intervals (e.g., the standard BAND and TIME parameters), \xmlel{VALUES/MIN} and \xmlel{VALUES/MAX} should be used to communicate the range
of values for which clients can expect to receive data. Example:
<PARAM name="BAND" unit="m" ucd="em.wl;stat.interval"
    datatype="double" arraysize="2"      
    xtype="interval" value="">     
    <DESCRIPTION>The wavelength intervals to be extracted</DESCRIPTION>
    <VALUES>                                                           
      <MIN value="3e-7"/>
      <MAX value="8e-7"/>
    </VALUE>             
  </PARAM>  </verbatim>

to

<verbatim>
For float-valued intervals (e.g., the standard BAND and TIME parameters), \xmlel{VALUES/MIN} and \xmlel{VALUES/MAX} are single values
 which apply to  the two elements in the BAND array, as stated in the VOTable specification starting from version 1.5, and in the DALI specification starting from version 1.2. 
There is no specific rule to apply for parameters with xtype=interval.  Example:
<PARAM name="BAND" unit="m" ucd="em.wl;stat.interval"
    datatype="double" arraysize="2"      
    xtype="interval" value="">     
    <DESCRIPTION>The wavelength intervals to be extracted. MIN (resp. MAX) is the minimal (reps. maximal) value of the two bounds of the interval</DESCRIPTION>
    <VALUES>                                                           
      <MIN value="3e-7"/>
      <MAX value="8e-7"/>
    </VALUES>             
  </PARAM>  </verbatim>

---++ Impact Assessment

Making the text less ambiguous will help implementers to deliver correct values of MIN/MAX elements for intervals.
Fixing the VOTable syntax in an example will make no harm to any service and will avoid implementers writing code delivering incorrect VOTables.

Topic revision: r9 - 2024-03-15 - FrancoisBonnarel

IVOA

Log in or Register

IVOA.net
Wiki Home
WebChanges
WebTopicList
WebStatistics

Twiki Meta & Help
IVOA
Know
Main
Sandbox
TWiki

TWiki intro
TWiki tutorial
User registration
Notify me

Working Groups

Interest Groups

Committees

Stds&Procs

www.ivoa.net
Documents
Events
Members
XML Schema