Page tree
Skip to end of metadata
Go to start of metadata
Note: from 5 July 2021, these pages are no longer the primary source of the EPN-TAP doc - see instead the IVOA latex source: https://github.com/ivoa-std/EPNTAP


List of EPN-TAP parameters
(refreshed/completed April 2019, Oct 2020, June 2021, Oct 2021) (SE) 

You can use this file to keep track of your service parameters: EPN-TAP_parameters_List_template.xlsx

EPN-TAP

  • EPN-TAP is a VO access protocol dedicated to Planetary Science data. It is based on the TAP mechanism from IVOA, completed with sets of parameters and associated lists of values. In this regard, it is similar to ObsTAP but with a different scope.
  • EPN-TAP version 2 is a major update of the protocol to accommodate larger services and simplify setup and use of data services. All parameters are described here.

Parameters which must be provided

are now clearly identified - those are not only mandatory, they also must provide a value.
They are mostly related to service description and granule identification.

+ See notes below the table.

Thematic extensions

Some science fields will require optional parameters, which need to be used consistently between services addressing the same field. Such extensions have to be designed by sub-groups involved in the corresponding data services, either as providers or users. This includes:

  • Lab spectroscopy: parameters to describe mineralogical samples (and possibly other samples)
  • Solar System objects: covers orbital/rotational parameters, physical properties, and taxonomy
  • APIS: for consistency with APIS service. Contains parameters for observing programs (most parameters are actually included in other extensions)
  • Contributive works / observing programs: enlargement of APIS extension to other data
  • Exoplanets / planetary systems properties
  • Map extension (to be enlarged)
  • Events: covers the VOevent standard and other types of events
  • Particle spectroscopy (to be finalized)
  • Results of planetary 3D modelling run (in progress)
  • Bibliographic entries? May be manageable otherwise, through bibcode / doi interpretation

Support file

You can use this file to keep track of your service parameters: EPN-TAP_parameters_List_template.xlsx


Name

SQL type

Unit

Description

UCD

UCD in Obscore 1.1

(9/5/2017 REC version)

Utype

(tentative) 

Comments

EPNCore mandatory parameters
 (Must be present, possibly empty)
 (bold face: a value is required)




Current value
current but dubious or undefined

— ? : closest sense

_ : N/A in ObsCore

from epntap v2 mixin (aug 2017)
equivalent/close in ObsCore doc 1.1

 

granule_uid

Text


Unique ID in data service

meta.id

meta.id
 Can be alphanum.

granule_gid

Text


Common to granules of same type

meta.id

meta.id
E.g. same map projection, or geometry data products. Can be alphanum.

obs_id

Text


Associates granules derived from the same data

meta.id;obs

meta.idobscore:DataID.observationID E.g. various representations / processing levels. Can be alphanum., may be the ID of original observation.
Keep it simple in intricate situations.

dataproduct_type

Text


Organization of the data product, from enumerated list

meta.code.class

meta.id

Epn.dataProductType

obscore:ObsDataset.dataProductType


target_name

Text


Standard IAU name of target (must match target_class), case sensitive

meta.id;src

meta.id;srcEpn.TargetNameCase sensitive
Services with no target_name do exist

target_class

Text


Type of target, from enumerated list

src.class

src.classEpn.TargetClass

time_min

Double

d

Start time (in JD). UTC measured at time_origin location (default is observer's frame)

time.start;obs

time.start;obs.exposure

Char.TimeAxis.Coverage.Bounds.Limits.Interval.StartTime



time_max

Double

d

Stop time (in JD). UTC measured at time_origin location (default is observer's frame)

time.end;obs

time.end;obs.exposure

Char.TimeAxis.Coverage.Bounds.Limits.Interval.StopTime



time_sampling_step_min

Float

s

Min time sampling step

time.resolution;stat.min

time.resolution Epn.Time.Time_sampling_step_min

time_sampling_step_max

Float

s

Max time sampling step

time.resolution;stat.max


Epn.Time.Time_sampling_step_max

time_exp_min

Float

s

Min integration time

time.duration;obs.exposure;stat.min

time.duration;obs.exposureEpn.Time.Time_exp_min

time_exp_max

Float

s

Max integration time

time.duration;obs.exposure;stat.max


Epn.Time.Time_exp_max

spectral_range_min

Float

Hz

Min spectral range (as frequency)

em.freq;stat.min

em.wl;stat.min (always as wl)

Epn.Spectral.Spectral_range_minAlways as frequency

spectral_range_max

Float

Hz

Max spectral range (as frequency)

em.freq;stat.max

em.wl;stat.maxEpn.Spectral.Spectral_range_max

spectral_sampling_step_min

Float

Hz

Min spectral sampling step

em.freq;stat.interval;stat.min

meta.numberEpn.Spectral.Spectral_sampling_step_min

spectral_sampling_step_max

Float

Hz

Max spectral sampling step

em.freq;stat.interval;stat.max

meta.numberEpn.Spectral.Spectral_sampling_step_max

spectral_resolution_min

Float


Min spectral resolution (resolving power)

spect.resolution;stat.min

spect.resolution (relates to resolving power)

Epn.Spectral.Spectral_resolution_min

Now (2019) provides resolving power |(lambda / delta(lambda)| = |f /Df|
How do we accommodate FWHM for filters?

spectral_resolution_max

Float


Max spectral resolution (resolving power)

spect.resolution;stat.max


Epn.Spectral.Spectral_resolution_max

Now (2019) provides resolving power |(lambda / delta(lambda)| = |f /Df|
How do we accommodate FWHM for filters?

c1min

Float

(1)


Min of first coordinate, depends on the frame

see table below

pos.eq.raEpn.Spatial.Spatial_range.c1min

Typo in current mixin (.lonG => .lon

UCDs for cyl and sph coord are from PEN-UCDlist-20210430

c1max

Float

(1)

Max of first coordinate, depends on the frame



Epn.Spatial.Spatial_range.c1max

c2min

Float

(1)


Min of second coordinate, depends on the frame. 


pos.eq.decEpn.Spatial.Spatial_range.c2min

c2max

Float

(1)

Max of second coordinate, depends on the frame



Epn.Spatial.Spatial_range.c2max

c3min

Float

(1)

Min of third coordinate



Epn.Spatial.Spatial_range.c3min

c3max

Float

(1)

Max of third coordinate



Epn.Spatial.Spatial_range.c3max

s_region

spoly

(3)

ObsCore-like footprint in 2D (celestial or body-related frames)

pos.outline;obs.field

pos.outline;obs.fieldobscore:Char.SpatialAxis.Coverage.Support.Area

(was initially instr.fov, to be corrected)
ObsCore value updated (was phys.angArea;obs) to phys.outline, 
then corrected to pos.outline

Must have xtype= adql:REGION to work with TAP
Frame may be identified in q.rd (UNKNOWNFrame).
Use value given in spatial_frame_type - very unclear…
Do we need another param for GIS interface?

c1_resol_min

Float

(2)

Min resolution in first coordinate

(2)

pos.angResolution;stat.minEpn.Spatial.Spatial_resolution.c1_resol_minpos.resolution restored in 2018
In body fixed frame, use pixelscale_min/max for resolution at the surface 

c1_resol_max

Float

(2)

Max resolution in first coordinate

(2)

pos.angResolution;stat.maxEpn.Spatial.Spatial_resolution.c1_resol_max_

c2_resol_min

Float

(2)

Min resolution in second coordinate

(2)


Epn.Spatial.Spatial_resolution.c2_resol_min_

c2_resol_max

Float

(2)

Max resolution in second coordinate

(2)


Epn.Spatial.Spatial_resolution.c2_resol_max_

c3_resol_min

Float

(2)

Min resolution in third coordinate

(2)


Epn.Spatial.Spatial_resolution.c3_resol_minpos.resolution restored in 2018

c3_resol_max

Float

(2)

Max resolution in third coordinate

(2)


Epn.Spatial.Spatial_resolution.c3_resol_maxpos.resolution restored in 2018

spatial_frame_type

Text

(1)


Flavor of coordinate system, defines the nature of coordinates. From enumerated list. Use "none" if undefined

meta.code.class;pos.frame

_

A value is required by DaCHS (query will return errors if empty)
Default value = none

incidence_min

Float

deg

Min incidence angle (solar zenithal angle)

 pos.incidenceAng;stat.min

_Epn.View_angle.Incidence_angle_minUCD for angles included in 2018 

incidence_max

Float

deg

Max incidence angle (solar zenithal angle)

 pos.incidenceAng;stat.max

_Epn.View_angle.Incidence_angle_maxUCD for angles included in 2018

emergence_min

Float

deg

Min emergence angle

 pos.emergenceAng;stat.min

_Epn.View_angle.Emergence_angle_minUCD for angles included in 2018

emergence_max

Float

deg

Max emergence angle

 pos.emergenceAng;stat.max

_Epn.View_angle.Emergence_angle_maxUCD for angles included in 2018

phase_min

Float

deg

Min phase angle

pos.phaseAng;stat.min


Epn.View_angle.Phase_angle_min

phase_max

Float

deg

Max phase angle

pos.phaseAng;stat.max


Epn.View_angle.Phase_angle_max

instrument_host_name

Text


Standard name of the observatory or spacecraft

meta.id;instr.obsty

meta.id;instr.telProvenance.ObsConfig.Facility.name

instrument_name

Text


Standard name of instrument

meta.id;instr

meta.id;instrProvenance.ObsConfig.Instrument.name

measurement_type

Text


UCD(s) defining the data

meta.ucd

meta.ucdEpn.Measurement_typeAdd ;meta.modelled if simulation or model
Add ;stat.uncalib if uncalibrated data - in which case processing_level must be 0 or 1

processing_level

Integer


Dataset-related encoding, or simplified CODMAC calibration level

meta.calibLevel

meta.code;obs.calib

~ obscore:ObsDataset.calibLevel To be replaced by PDS4 values in v2.1?

creation_date

Timestamp

(4)

Date of first entry of this granule

time.creation

time;meta.dataset

modification_date

Timestamp(4)

Date of last modification

time.processing



Used to handle mirroring
UCD value being discussed in 2018

release_date

Timestamp

(4)

Start of public access period (set to creation_date if no proprietary period)

time.release

time.releaseobscore:Curation.releaseDate

The value is in ISO 8601 format reusing this pattern: (“YYYY-MM-DDThh:mm:ss”) If release_date is in the future, the data is proprietary.

service_title

Text


Title of resource = schema name

meta.title



May be used to handle multiservice results

Common optional parameters








access_url

Text


URL of the data file, case sensitive (additional files may be linked through datalink_url). Can point to a script. If present, next 2 parameters must also be present

meta.ref.url;meta.file

meta.ref.urlObs.Access.Reference

Use this to link data!
Could accommodate a datalink with access_format = 'application/x-votable+xml;content=datalink'
(from ObsCore)
- but this is a funny idea…

access_format

Text


RFC 2045 media type (mime), required to be all-lower case 

meta.code.mime

meta.code.mimeObs.Access.Format

access_estsize

Integer

kbyte

Estimate file size in kbyte (with this spelling)

phys.size;meta.file

phys.size;meta.fileObs.Access.Size
access_md5Text
MD5 Hash for the file when available (real file, not script) meta.checksum;meta.file


thumbnail_url

Text


URL of a thumbnail image with predefined size (png ~200 pix, for use in a client only)

meta.ref.url;meta.preview




file_name

Text


Name of the data file only, case sensitive

meta.id;meta.file

meta.title;obs — ?
ObsCore obs_title is for a short free text string describing the granule. Do we want this?
datalink_urlText
Provides links to files or services on the servermeta.ref.url

Associated mime-type is 'application/x-votable+xml;content=datalink'
(from ObsCore)

species

Text


Identifies a chemical species, case sensitive

meta.id;phys.atmol



This is the only case sensitive parameter (with target_name)
messengerText

Vector of measured signal, including electromagnetic 
band, from enumerated list

instr.bandpass


alt_target_nameText
Provides alternative target name(s). Can be a hash listmeta.id;src


target_region

Text


Type of region or feature of interest

meta.id;src;obs.field




feature_name

Text


Secondary name (e.g. standard name of a region of interest)

meta.id;src;obs.field 



publisher

Text


Resource publisher

meta.curation

meta.ref.uri;meta.curation~ obscore:Curation.publisherID

bib_reference

Text


Bibcode or doi preferred; can be a URL or anything else. Refers to the granule

meta.bib

meta.bib

obscore:Curation.referenceBibcode & doi can be completed in TOPCAT
internal_referenceText
Related granule_uid(s) in the current servicemeta.id.cross

Use to link one granule to a set of other granules. To be used only if required - e.g. to solve situations that would otherwise require several tables
external_linkText
Web page providing more details on the granulemeta.ref.url

Link to an individual page in a web site associated to the database, e.g., a planet page in Exoplanets service. This is a way to provide extra granule information which cannot be accommodated in the table.

shapeText

introduces an ascii (ST)MOC, v2 (2D footprint on celestial, spherical, or body-related frames, possibly including time)

pos.outline;obs.field

Must have xtype="MOC" (follow DALI recommendation)

outline doesn't fit definition (refers to a contour)

spatial_coordinate_description

Text


ID of specific coordinate system and version / properties

meta.code.class;pos.frame



~COOSYS, but includes planetary ones
Still TBD, needs to be OGC compliant. Discussion in progress here: EPN-TAP v2: Current discussion topic

spatial_origin

Text


Defines the frame origin

meta.ref;pos.frame




time_refposition

Text


Defines where the time is measured (e. g., ground vs spacecraft). Default is observer's frame

meta.ref;time.scale



target_time is of course always on target.

time_scale

Text


Defaults to UTC in data services - from enumerated list

time.scale




subsolar_longitude_minFloatdegMinimum sub-solar point longitudepos.bodyrc.lon;stat.min

Provided in the most natural body-related coordinate frame, E-handed - seems to require 'body'
subsolar_longitude_maxFloatdegMaximum sub-solar point longitudepos.bodyrc.lon;stat.max

Provided in the most natural body-related coordinate frame, E-handed - seems to require 'body'
subsolar_latitude_minFloatdegMinimum sub-solar point latitudepos.bodyrc.lat;stat.min

_
subsolar_latitude_maxFloatdegMaximum sub-solar point latitudepos.bodyrc.lat;stat.max

_
subobserver_longitude_minFloatdegMinimum sub-observer point longitude (sub-Earth for ground based observations)pos.bodyrc.lon;stat.min

_
subobserver_longitude_maxFloatdegMaximum sub-observer point longitude (sub-Earth for ground based observations)pos.bodyrc.lon;stat.max

_
subobserver_latitude_minFloatdegMinimum sub-observer point latitude (sub-Earth for ground based observations) pos.bodyrc.lat;stat.min

_
subobserver_latitude_maxFloatdegMaximum sub-observer point latitude (sub-Earth for ground based observations) pos.bodyrc.lat;stat.max

_

ra

Float

deg

Right ascension

pos.eq.ra;meta.main



deg only (like ObsCore)

dec

Float

deg

Declination

pos.eq.dec;meta.main




radial_distance_minFloatkmMin distance from observed area to body center pos.distance;pos.bodyrc;stat.min


radial_distance_maxFloatkmMax distance from observed area to body center pos.distance;pos.bodyrc;stat.max


altitude_fromshape_minFloatkmMin altitude of observed area above shape model / DTMpos.bodyrc.alt;stat.min


altitude_fromshape_maxFloatkmMax altitude of observed area above shape model / DTMpos.bodyrc.alt;stat.max


solar_longitude_min

Float

deg

Min Solar longitude Ls (location on orbit / season)

pos.ecliptic.lon;pos.heliocentric;stat.min 




solar_longitude_max

Float

deg

Max Solar longitude Ls (location on orbit / season)

pos.ecliptic.lon;pos.heliocentric;stat.max




local_time_min

Float

h

Min local time at observed region

time.phase;time.period.rotation;stat.min




local_time_max

Float

h

Max local time at observed region

time.phase;time.period.rotation;stat.max 




target_distance_min

Float

km

Min observer-target distance

pos.distance;stat.min




target_distance_max

Float

kmMax observer-target distancepos.distance;stat.max


target_time_min

Timestamp

(4)

Min observing time in target frame

time.start;src



(simplest way to look for coordinated observations)

target_time_max

Timestamp

(4)

Max observing time in target frame

time.end;src




earth_distance_minFloatAUMin Earth-target distancepos.distance;stat.min


earth_distance_maxFloatAUMax Earth-target distance

pos.distance;stat.max




sun_distance_minFloatAUMin Sun-target distancepos.distance;stat.min


sun_distance_maxFloatAUMax Sun-target distancepos.distance;stat.max


Parameters from extensions








obs_modeText
Observing modemeta.code;instr.setup

From APIS + observation extensions (with adapted UCDs)
detector_nameText
Detector namemeta.id;instr.det


opt_elemText
Optical element namemeta.id;instr.param


filterText Identifies filter in use, typically for imagesmeta.id;instr.filter

Informative only, free format (no list, but see http://svo2.cab.inta-csic.es/svo/theory/fps3/). Search can only rely on spectral range, as ObsCore does.
instrument_typeText
type of instrumentmeta.id;instr

Informative only (not a reliable search parameter): free format, no reference list intended.
acquisition_idText
ID of the data file/acquisition in the original archivemeta.id


proposal_idText
Proposal identifiermeta.id;obs.proposal


proposal_piText
Proposal principal investigator

meta.id.PI;obs.proposal




proposal_titleText
Proposal titlemeta.title;obs.proposal


campaignText
Name of the observational campaignmeta.id;obs.proposal


target_descriptionText
Original target keywordsmeta.note;src


proposal_target_nameText
target name as in proposal titlemeta.note;obs.proposal


target_apparent_radiusFloatarcsecApparent radius of the target

phys.angSize;src




north_pole_positionFloatdegNorth pole position angle with respect to celestial north pole

pos.posAng



Group of 5 parameters very specific to APIS.
Name is ~ OK, but actually provides the position angle of the planet axis. Use "orientation" for the image.
target_primary_hemisphereText
Primary observed hemispheremeta.id;obs.field


target_secondary_hemisphereText
Secondary observed hemispheremeta.id;obs.field


platescFloatarcsec/pixpixel angular size or platescale (on sky only)instr.scale


orientationFloatdegPosition angle of image y axis (on sky only)pos.posAng

Provides the direction of the polar axis in the image, counted clockwise from north.
observer_nameText
Observer name

obs.observer;meta.main




observer_instituteText
Observer institutemeta.note


observer_idInteger
Image observer's numeric identifier

meta.id.PI




Group of 5 from PVOL, OK for general use but UCDs have to be changed in PVOL.
meta.pubid in PVOL

observer_codeText
Image observer's service usernamemeta.id.PI

meta.pubcode in PVOL
observer_countryText
Image observer's country of residencemeta.note;obs.observer

meta.pubcountry in PVOL
observer_lonFloatdegObserver's approximate longitudeobs.observer;pos.earth.lon


meta.publon in PVOL
observer_latFloatdegObserver's approximate latitudeobs.observer;pos.earth.lat

meta.publat in PVOL
massFloatkgMass of objectphys.mass

Solar System Objects extension (generic values in catalogues, not observations)
sidereal_rotation_periodFloathObject rotation ratetime.period.rotation


mean_radiusFloatkm
phys.size.radius


equatorial_radiusFloatkm
phys.size.radius


polar_radiusFloatkm
phys.size.radius


diameterFloatkmTarget diameter, or equivalent diameter for binary objectsphys.size.diameter

Used in tnosarecool, not very consistent (use radius?)

semi_major_axis

FloatAU

phys.size.smajAxis




inclinationFloatdegOrbit inclination

src.orbital.inclination




eccentricityFloat
Orbit eccentricity

src.orbital.eccentricity




long_ascFloatdegLongitude of ascending node, J2000.0src.orbital.node


arg_perihelFloatdegArgument of perihelion, J2000.0src.orbital.periastron


mean_anomalyFloatdegMean anomaly at the epochsrc.orbital.meanAnomaly


epochDoubled

Epoch of interest in JD

time.epoch


dynamical_class

Text
Class of small body, from enumerated listmeta.code.class;src


dynamical_typeText
Subdivision of the class, from enumerated listmeta.code.class;src


taxonomy_codeText
Code for target taxonomysrc.class.color

Possible values depend on target type and possibly on service
magnitudeFloatmagAbsolute magnitude. For small bodies, from HG magnitude systemphys.magAbs

Actually depends on service (eg, spectro_planets vs DynAstVO vs tnosarecool).
UCD may include mention of the photometric band.
fluxFloatmJyTarget fluxphot.flux.density


albedoFloat
Target albedophys.albedo


map_projection

Text
ID from enumerated list, or string with parameters (referring to a standard)pos.projection

Map extension

map_height

FloatpixMap size in px

phys.size




map_widthFloatpixMap size in px

phys.size




map_scaleText
Preferably a ratio (e. g., "1:50000")

pos.wcs.scale




pixelscale_minFloatkm/pixMin pixel size on a surface

instr.scale;stat.min




pixelscale_maxFloatkm/pixMax pixel size on a surface

instr.scale;stat.max




particle_spectral_type

Text


From enumerated list

meta.id;phys.particle




particle_spectral_range_min

Float



phys.energy;phys.particle;stat.min

phys.mass;phys.particle;stat.min




particle_spectral_range_max

Float



phys.energy;phys.particle;stat.max

phys.mass;phys.particle;stat.max




particle_spectral_sampling_step_min

Float



spect.resolution;phys.particle;stat.min




particle_spectral_sampling_step_max

Float



spect.resolution;phys.particle;stat.max




particle_spectral_resolution_min

Float



spect.resolution;phys.particle;stat.min




particle_spectral_resolution_max

Float



spect.resolution;phys.particle;stat.max




original_publisher


Text
Refers to the source of the data, e. g.,  in compilations of experimental datameta.note

Experimental spectroscopy + contributive work extensions

producer_name

Text
Data producer name, especially in compilations of experimental datameta.note


producer_institute

Text
Data producer institute, e. g., in compilations of experimental datameta.note


sample_idText
Provides a local ID in an existing catalogue meta.id;src

In addition to target_name

sample_classification

Text
Information related to class, sub-class, species… as hash listmeta.note;phys.composition

This uses standard names for classes… 
sample_descText
Describes the sample, its origin, and possible preparation. Can be a hash listmeta.note


species_inchikeyText

Fixed length string identifying the species. Can be a hash list

meta.id;phys.atmol



Follows IUPAC standard (Heller et al 2015)

data_calibration_desc

Text
Provides information on post-processing. Can be a hash listmeta.note

(preferably to a "comment" parameter)
setup_descText
Describes the experimental setup. Can be a hash listmeta.note

May include Aperture (size of sample measured), etc

geometry_type

Text
Type of observation, from enumerated list. Can be a hash listmeta.note;instr.setup


spectrum_type

Text
Type of spectral observation, from enumerated list TBD. Can be a hash listmeta.note;instr.setup

Alternative to UCD, very detailed

grain_size_min

FloatumMin sample particle size 

phys.size;stat.min




grain_size_maxFloatumMax sample particle size 

phys.size;stat.max




azimuth_minFloatdegMin azimuth angle for illuminationpos.azimuth;stat.min

Check meaning/requirements for <0 values?
UCD added in 2018 (instead of pos.azimuthAng requested - OK)

azimuth_maxFloatdegMax azimuth angle for illuminationpos.azimuth;stat.max

UCD added in 2018

pressure

FloatbarAmbient pressure

phys.pressure



VOunits says: Pascal.

measurement_atmosphere

Text
Describes experimental conditions. "vacuum" for measurements under vacuum

meta.note;phys.pressure




temperatureFloatKAmbient temperature

phys.temperature




event_type

Text

Type of event from enumerated list

meta.code.class



Events extension
If dataproduct_type = ev
UCDs should be provided with the standard

event_statusText

From enumerated list

meta.code.status




event_citeText

From enumerated list

meta.code.status





(1): depending on context (as given by spatial_frame_type), see table below

Longitude and RA range from 0. to 360; Latitude and Dec range from -90. to +90.

For spatial_frame_type = "none": no value is provided, UCD are empty strings (""), and no unit is provided

(2) Spatial resolution parameters have the same unit as spatial coordinate parameters. The associated UCD combine either pos.resolution (if linear) or pos.angResolution (if angular) with secondary stat.min or stat.max

c1: only body and celestial are angular; c2: only cartesian is linear; c3: only spherical is angular


(3): Any contour type that works with ADQL's geometry operators (CONTAINS, INTERSECTS...) is legal here

(4): Timestamps are provided as ISO-8601 String as specified by DALI. On VOtable output, xtype="timestamp" attribute is required.


Frame coordinates UCD/unitscelestialbodycartesiansphericalcylindrical

c1min

pos.eq.ra;stat.min 

pos.bodyrc.lon;stat.min

pos.cartesian.x;stat.min

(in km)

pos.spherical.r;stat.min 

(in m)

pos.cylindrical.r;stat.min 

(in km)

c1maxpos.eq.ra;stat.maxpos.bodyrc.lon;stat.max

pos.cartesian.x;stat.max

(in km)

pos.spherical.r;stat.max 

(in m)

pos.cylindrical.r;stat.max 

(in km)

c2minpos.eq.dec;stat.minpos.bodyrc.lat;stat.min

pos.cartesian.y;stat.min

(in km)

pos.spherical.colat;stat.min

pos.cylindrical.azi;stat.min

c2maxpos.eq.dec;stat.maxpos.bodyrc.lat;stat.max

pos.cartesian.y;stat.max

(in km)

pos.spherical.colat;stat.max

pos.cylindrical.azi;stat.max

c3min

pos.distance;stat.min

(in AU)

pos.bodyrc.alt;stat.min (from surface only, implicitly from reference level)
or
pos.distance;pos.bodyrc;stat.min (from center)?

(in km)

pos.cartesian.z;stat.min

(in km)

pos.spherical.azi;stat.min

pos.cylindrical.z;stat.min

(height, in km)

c3max

pos.distance;stat.max

(in AU)

pos.bodyrc.alt;stat.max (from surface only, implicitly from reference level)
or
pos.distance;pos.bodyrc;stat.max (from center)?

(in km)

pos.cartesian.z;stat.max

(in km)

pos.spherical.azi;stat.max

pos.cylindrical.z;stat.max

(height, in km)

Example table for IDs:

File name-type

granule_uid

granule_gid

obs_id

A-Raw

1

native

A

A-Calib

2

calibrated

A

A-geom

3

geometry

A

A-proj

4

projected

A

B-Raw

5

native

B

B-Calib

6

calibrated

B

B-geom

7

geometry

B

B-proj

8

projected

B 


Syntax


multivalued lists = first entry#second entry#…#last entry, or scalar (with no #)
Values separator = #
No quotes around the list

This can be parsed by ADQL/RegTAP function ivo_hashlist_has like this:
  select * from vvex.epn_core where 1 = ivo_hashlist_has(lower(target_name),'Venus')

Where the lower function is mandatory to handle values possibly containing upper cases (this is implicit on the 2nd argument)

Beware that only complete elements between separators will be found. The provider has to split the string according to expected searches, e.g.:
    Composite Infrared Spectrometer#CIRS
not    Composite Infrared Spectrometer (CIRS)

Parameters supporting multivalued lists include:
dataproduct_type (only when present in the same file; best avoided when possible)
target_name (for different targets only, but only one target can be described in the granule; use alt_target_name for other names of the same target)
alt_target_name
target_class (in association with target_name)
instrument_host_name (e.g. acronym and full name)
instrument_name (e.g. acronym and full name)
measurement_type (when present in the same file)
processing_level (when present in the same file)
bib_reference


NULL and special values:
A standard query on a parameter will not return granules with NULL/void value. E.g. target_name LIKE '%toto%' will only select granules with this value (standard ADQL behavior).
NULL/void has to be tested specifically (e.g., when it means "I don't know") using the IS operator (IS is used only to test the NULL value in ADQL): 

target_name LIKE '%toto%' OR target_name IS NULL

Syntax IS NULL stands for both strings and numerical parameters (the = operator is accepted in this context only by latest DaCHS servers)

No inf, inf, or NaN value in ADQL? At least Inf/-Inf should be there, as per DALI.

UCDs: the above table has been reviewed against the UCD documents, including latest discussions (4/2019). Review against PDS4 and IPDA to be performed.

2018 discussions / conclusions have been included herehttps://wiki.ivoa.net/twiki/bin/view/IVOA/UCDList1dot42017June2018FebRFM

• *_min vs *_max parameters

If only one value is available, it must appear in both fields

• Optional parameters: some of these come in sets that are logically related; if one is present, the related ones must be present also (e.g., 3 access_* parameters)

• Granule_gid: any general indication to providers? I.e.: preview, native, calibrated, geometry… 
A client should be able to display the values present in a service (feasible in TOPCAT)

• Reshuffle previous "service parameters":

  • Mandatory :
    publisher - make it mandatory???
    add publisher_did as in Obscore? (for DaCHS/registry; provides unique ID of service for this publisher/server), with UCD = meta.ref.uri;meta.curation 
  • Optional 
    spatial_coordinate_description  (default = none)
    spatial_origin  (default = body center or SS barycenter? Or observer location)
    time_origin  (default = observer)
    time_scale (default = UTC – no other values allowed in data services? [only in computational services, e.g. ephemeris])
    Same values to be used in registry declaration 

• Call-back parameters / reference

Currently using service_title (= schema name) + granule_uid. 

May use ivoID in the future.

Other parameters

The most recent extra parameters often have names starting in prefix_*, where prefix identify the scope or context (e.g., spase_, vims_, image_, etc). Seems to be a good practice.

Accref is introduced by the EPN-TAP localfile mixin, but not used - in principle not included in TAP response, be may be present anyway. It may be better to hide it also in the portal.


Parameters introducing error bars/uncertainties

Some parameters providing a scalar value X in the EPN-TAP table may be associated with an error bar in a related parameter. This is currently (4/2019) entered as:

In Basecom: Xerr (to be changed when upgrading to mixin version)
In DynAstVO: X_error
In Exoplanets: X_error_min; X_error_max
In planets: X_uncertainty
TNOsarecool: X_sigma_plus, X_sigma_minus (to be changed?)

The associated UCDs start with stat.error; or stat.error;stat.min; & stat.error;stat.max;


Support for PDS3 detached labels (proposal)

Solution with datalink seems OK: data files under access_url and detached labels provided under datalink_url in a link table - although no attempt made to read them from the portal yet (use VIR unpublished service to test this).


Utypes

Need to clean up current doc (2.0). Utypes are = DM fields. They are supposedly used to identify the meaning of parameters and help e.g. tools to grab required quantities - This will not work in some areas though, e. g. with spectral tools as they currently use UCD instead of Utype for this purpose (not many tools appear to actually rely on Utype in fact). See discussion here for usage (a bit old?): http://www.ivoa.net/documents/Notes/UTypesUsage/20130213/NOTE-utypes-usage-1.0-20130213.html

To handle this in practice:

  • Associate each parameter to a specific Utype in EPNCore - all names need to start with the epncore: prefix/namespace.
  • Then map epncore Utype to other DM (find equivalent parameter, or trace back the original templates of EPNCore parameters - often from ObsCore)
  • Reuse Utype from other DM each times it makes sense - TBC: the epncore: namespace is still required (even when using Utypes from other DM)
    This allows tools to handle EPNCore parameters like existing parameters from other DM, i.e., with no specific implementation
    Pb is that small differences in the use of parameters may preclude reusing the same Utype (TBC: does that applies to units also?)
  • Cross our fingers: known Utype (from other DMs) may be usable in existing tools (e.g. a tool supporting Provenance would grab equivalent info in EPN-TAP services transparently)
    Unclear if the use of the namespace makes it more complicated in tools.


Example of V2 with APIS database:

EPNcore Table v2

granule_uidgranule_gidobs_idaccess_urlaccess_formatthumbnail_url
o5g202x4q_x2doriginal_datao5g202x4qo5g202x4q_x2d.fitsimage/fitso5g202x4q_x2d_small.jpg
o5g202x4q_x2d_prevoriginal_data_previewo5g202x4qo5g202x4q_x2d.jpgimage/jpgo5g202x4q_x2d_small.jpg
o5g202x4q_procprocessed_datao5g202x4qo5g202x4q_proc.fitsimage/fitso5g202x4q_proc_small.jpg
o5g202x4q_proc_prevprocessed_data_previewo5g202x4qo5g202x4q_proc.jpgimage/jpgo5g202x4q_proc_small.jpg
o5g202x4q_cylcylindrical_projectiono5g202x4q o5g202x4q_cyl.jpgimage/jpgo5g202x4q_cyl_small.jpg
o5g202x4q_pol_npolar_projection_northo5g202x4q o5g202x4q_pol_n.jpgimage/jpgo5g202x4q_pol_n_small.jpg
o5g202x4q_pol_spolar_projection_southo5g202x4q o5g202x4q_pol_s.jpgimage/jpgo5g202x4q_pol_s_small.jpg
  • No labels

11 Comments

  1. If you have a footprint, e.g.:

    s_region='Polygon -103.649 -32.096 -103.739 -32.097 -103.824 -32.124 -103.909 -32.155 -103.995 -32.149 -103.996 -32.15 -103.998 -32.135 -104.004 -32.103 -104.009 -32.07 -103.917 -32.073 -103.83 -32.049 -103.746 -32.015 -103.66 -32.013 -103.653 -32.06 -103.648 -32.097 -103.649 -32.096'

    getting the min/max coordinates is actually very easy.

    [float(s_region.split(' ')[1:][i]) for i in range(0, len(s_region.split(' ')[1:]), 2)]

    would give you an array of longitudes, and similarly

    [float(s_region.split(' ')[2:][i]) for i in range(0, len(s_region.split(' ')[1:]), 2)]

    will result in array of latitudes.
    Consequently, to get, for instance, maximum latitude, call

    max([float(s_region.split(' ')[2:][i]) for i in range(0, len(s_region.split(' ')[1:]), 2)])

    For an example above this should return -32.013

  2. S_region has the wrong UCD: it should be "pos.outline;obs.field" and not "phys.outline;obs.field".  "phys.outline" has never been legal UCD, but it did appear (incorrectly) in some drafts of ObsCore, which is presumably how it found its way here.

    1. done (from obscore 2016 indeed - all EPN services to be corrected, as well as mixin)

  3. Below is a full list of issues I've found with UCDs and Units in https://www.ivoa.net/documents/EPNTAP/20201027 (note I didn't check the values on this page directly, I don't know whether there are discrepancies).  I have obtained it by passing the supplied unit and UCD strings to the the Ucidy and Unity parsing libraries (thanks to Gregory Mantelet and Norman Gray).  So I believe that all the other UCDs and units are legal.  If there are updates I can easily repeat the exercise.

    From the formatting in the table on this page, it looks like some, but not all, of these items are already known.

    • spectral_sampling_step_min/max:

      • no such UCD "em.freq.step"

    • s_region:
      • "phys.outline" is a typo for "pos.outline" (as noted in previous comment)
    • datalink_url:
      • no such UCD "meta.datalink"
    • target_region, feature_name:
      • these have UCD "obs.field"; obs.field is a (S)econdary UCD, so can't be used on its own
    • campaign:
      • UCD "meta.id;meta.code" not legal, since both meta_id and meta_code are (P)rimary UCDs, so they can't be used together
    • map_projection:
      • no such UCD "pos.projection"
    • particle_spectral_range_min/max:
    • pressure:
      • the unit "bar" is not sanctioned by the VOUnits standard

    Where I've written "no such UCD", I mean no such UCD in either REC-UCDList-1.3 or PEN-UCDList-1.4-20210430. UCDList-1.4 is currently at a late stage of IVOA update/review; it might or might not be too late to propose updates.

    1. update: 

      - spectral_sampling_step_min/max => em.freq;stat.interval;stat.min / max

      - s_region corrected

      - datalink_url => meta.ref.url

       target_region => meta.id;src;obs.field

      - feature_name => meta.id;src;obs.field

      - Campaign => meta.id;obs.proposal

      map_projection: we need either pos.proj (deprecated) or pos.projection

      bar unit: indeed, but current services are made this way. TBD for now

      1. It seems fair enough to keep "bar" if that's the preferred unit for this purpose.

        1. You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.
  4.  VOUnits section 2.7 says "The astronomical unit should be expressed in upper-case, AU, in order to follow legacy practice."

    So it might be better to write "AU" rather than "au" as the units for earth_distance_min/max and sun_distance_min/max.  But I wouldn't say it's required.

    1. Done - unimportant, but I prefer it this way (wink)

  5. One addition to the UCD issues above: Table 2 (the spatial_frame_type-dependent coordinate UCDs) make mention of "pos.radius" which (as noted there) does not exist.  UCDList 1.4 introduces some new UCDs which should probably be used there instead.

    1. Yes, these are the missing UCDs we were expecting. I keep it open for bodyrc Z axis, we have to decide alt or distance from center

  6. Parameter changes:

    Added shape for MOC, including STMOC (optional)

    time_origin => time_refposition (consistency with VOtable TIMESYS)

    waveband => messengers (broader scope)

    sideral_rotation_period => sidereal_rotation_period (was a typo)