Page tree
Skip to end of metadata
Go to start of metadata

The APIS Service

The Auroral Planetary Imaging and Spectroscopy (APIS) service aims at providing a free and simple access to a database of high-level auroral data, in convenient formats (fits, jpg, pdf), and compatible with virtual observatory (VO) facilities. It is fully described in a dedicated publication and accessible online at : http://apis.obspm.fr

 It consists of :

  • a high level database of planetary auroral spectro-imaging observations. So far, this database includes most of the HST Far-UV observations of the planets and their satellites since 1997.
  • a conditional search interface adapted to the needs of the magnetospheric and atmospheric communities (click on "search for data" within the APIS webpage).
  • the ability to interactively work with the data online through plotting tools developed by the Virtual Observatory (VO) community (such as Aladin, Specview or Cassis).

APIS is fully operational since early 2012 and has been officially acknowledged by the CNRS (french institute of research) in 2015.

Making your data available through APIS

In addition to our internal HST database described above, the APIS search interface is aimed at being able to simultaneously query external databases as well.

To enable the APIS team to include such a connexion, the data provider shall : 

  • provide an access to the data themselves (in fits format) and quicklooks (in jpg and/or pdf formats) each accompanied by a thumbnail (in jpg format).
  • set up an EPN-TAP service to share its data product catalog
  • indicate a scientific responsible for the provided data.

The purpose of this page is to detail the EPN-TAP mandatory fields to be fully compatible with the APIS search interface.

Setting your EPNcore table 

Each data product (fits data, jpg plot, pdf plot etc.) is a granule, and shall thus be described in a single line in the EPNcore.

Example with one HST observation :

granule_uidgranule_gidprocessing_levelobs_idaccess_urlaccess_formatthumbnail_urlDetails
o5g202x4q_x2doriginal_data2o5g202x4qo5g202x4q_x2d.fitsimage/fitso5g202x4q_x2d_small.jpgOriginal data file (CODMAC Level 2: edited)
o5g202x4q_x2d_jpgoriginal_data2o5g202x4qo5g202x4q_x2d.jpgimage/jpgo5g202x4q_x2d_small.jpgJPEG version of original data (web)
o5g202x4q_x2d_pdforiginal_data2o5g202x4qo5g202x4q_x2d.pdfapplication/pdfo5g202x4q_x2d_small.jpgPDF version of original data (print)
o5g202x4q_procprocessed_data3o5g202x4qo5g202x4q_proc.fitsimage/fitso5g202x4q_proc_small.jpgCalibrated data (CODMAC Level 3: calibrated)
o5g202x4q_proc_jpgprocessed_data3o5g202x4qo5g202x4q_proc.jpgimage/jpgo5g202x4q_proc_small.jpgJPEG version of calibrated data (web)
o5g202x4q_proc_pdfprocessed_data3o5g202x4qo5g202x4q_proc.pdfapplication/pdfo5g202x4q_proc_small.jpgPDF version of calibrated data (print)
o5g202x4q_cylcylindrical_projection4o5g202x4q o5g202x4q_cyl.jpgimage/jpgo5g202x4q_cyl_small.jpgCylindrical projection (CODMAC Level 3: resampled)
o5g202x4q_pol_npolar_projection_north4o5g202x4q o5g202x4q_pol_n.jpgimage/jpgo5g202x4q_pol_n_small.jpgNorthern polar projection (CODMAC Level 3: resampled)
o5g202x4q_pol_spolar_projection_south4o5g202x4q o5g202x4q_pol_s.jpgimage/jpgo5g202x4q_pol_s_small.jpgSouthern polar projection (CODMAC Level 3: resampled)

EPNcore Parameters Mandatory for APIS compliance

The other mandatory EPNcore parameters can be set to NULL.

EPNcore parameterContentNotes
granule_uidunique id of the granule 
granule_gidgroup id. For APIS, this represents the data levelpossible values :
  •  cylindric_proj
  •  1D_spectra
  •  processed_data
  •  polar_proj_north
  •  polar_proj_south
  •  original_data
obs_idoriginal data idunique identifier for each observation (Ex with HST : o5g202x4q)
dataproduct_type
  • im for IMAGING
  • sp for SPECTROSCOPIC
  • sc for SPECTRO-IMAGING

sc refers to 'spectral cube'

target_nametarget namethe first letter (only) must be capitalized (Ex : Jupiter)
target_classtarget class (planet, satellite...)

in lowercase.

The list of allowed values is specified in EPNcore documentation.

time_minStart of Observationin Julian days (not in modified Julian days)
time_maxEnd of Observationin Julian days (not in modified Julian days)
time_exp_min in seconds
time_exp_max in seconds
spectral_range_min in Hz. See EPNcore documentation for conversion factors.
spectral_range_max in Hz. See EPNcore documentation for conversion factors.

spectral_sampling_step_min

spectral_resolution_min

 

one of these 2 should be set.

in Hz. See EPNcore documentation for conversion factors.

spectral_sampling_step_max

spectral_resolution_max

 

one of these 2 should be set.

in Hz. See EPNcore documentation for conversion factors.

spatial_frame_type  

phase_min

phase_max

phase anglecan contain the same value
instrument_host_namespacecraft / observatory namethe standard name should be used (Ex : HST)
instrument_nameinstrument namename of the spectro-imager (Ex with HST : STIS or ACS)
measurement_type
  • phot.count;obs.image for IMAGING
  • phot.flux.density;em.UV.100-200nm for SPECTROSCOPIC
 
access_urlURL of the product 
access_formatmime type of the product
  • image/fits

  • image/jpeg

  • application/pdf

access_estsize

estimated file sizein kbyte

thumbnail_url

URL of a thumbnail image with predefined sizejpg 250 pix wide
external_linkLink to a web page providing more details on the granule.
processing_levelCODMAC data level
  • 3 for original_data (= level 1 data for APIS)

  • 4 for processed_data (= level 2 data for APIS)

  • 5 for 1D_spectra (= level 3 data for APIS)

  • 5 for cylindric_proj (= level 3 data for APIS)

  • 5 for polar_proj_north (= level 3 data for APIS)

  • 5 for polar_proj_south (= level 3 data for APIS)

publisher  
bib_reference  
service_title

 APIS

 
target_region Ex: magnetosphere
feature_name
Ex: planetary aurorae
filterimaging filter (spectral filter) or slit configuration (spatial filter)Ex with HST : F25SrF2 for images or 52x0.5 for long-slit spectroscopy
ra  
dec  
release_date  
creation_date  
modification_date  
subobserver_latitude 

in degree

subsolar_latitude 

in degree

subobserver_longitude in degree (IAU system III for Jupiter and Uranus, NULL for Saturn)
subsolar_longitude in degree (IAU system III for Jupiter and Uranus, NULL for Saturn)

target_distance_min

target_distance_max

 

Observer-target distance (in km)

sun_distance_min

sun_distance_min

 

Sun-target distance (in AU)
file_namename of the file that can be downloaded from access_url

Extra Parameters for APIS 

To be fully compliant with APIS, the EPNcore table must be completed with the following mandatory parameters.

APIS extension parameterMandatoryContentNotes
obs_modeyesobserving modeEx with HST : ACCUM or TIME-TAG
detector_nameyesdetectorEx with HST : FUV-MAMA (for STIS) or SBC (for ACS)
opt_elemyesoptical elementEx with HST : G140L (= grating for spectra) or MIRFUV (for images)
detector_orientationyesposition angle of image y axisin degrees, east of north
measurement_unit
yesphysical unit(= bunit in the APIS internal table)
proposal_idyesproposal ID

NULL if non applicable

Ex with HST = ID of HST proposal (unique)

(= proposid in the APIS internal table)

proposal_piyeslast name of principal investigator

NULL if non applicable

(= pr_inv_l in the APIS internal table)

proposal_titleyestitle of proposal

NULL if non applicable

(= propttl1 in the APIS internal table)
platescyesspatial resolution per pixel or platescale in arcsec/pixels
campaignyesname of the observational campaignEx with HST : Saturn - 2005 26 Oct-02 Nov
target_apparent_radiusyesapparent radius of the targetin arcsec
north_pole_positionyesnorth pole position angle with respect to celestial north pole in degree
target_primary_hemisphereyesprimary observed hemisphere

south or north or NULL

target_secondary_hemisphereyessecondary observed hemispheresouth or north or NULL

 

The following ephemeris parameters, also mandatory for a search with the APIS interface, will be added to each external EPNcore database by the APIS team.

APIS extension parametersMandatoryContentNotes
skr_nonly for Saturnprovided by APISMeudon SKR Northern variable phase (IAU SIII does not work for Saturn)
skr_sonly for Saturnprovided by APISMeudon SKR Southern variable phase (IAU SIII does not work for Saturn)
lon_ioonly for Jupiterprovided by APISlongitude of Io in system III  (if Jupiter)
lt_ioonly for Jupiterprovided by APISlocal time of Io  (if Jupiter)
lon_euronly for Jupiterprovided by APISlongitude of Europa in system III (if Jupiter)
lt_euronly for Jupiterprovided by APISlocal time of Europa (if Jupiter)
lon_ganonly for Jupiterprovided by APISlongitude of Ganymede in system III (if Jupiter)
lt_ganonly for Jupiterprovided by APISlocal time of Ganymede (if Jupiter)
lon_calonly for Jupiterprovided by APISlongitude of Callisto in system III (if Jupiter)
lt_calonly for Jupiterprovided by APISlocal time of Callisto (if Jupiter)
lt_mimonly for Jupiterprovided by APISlocal time of Mimas (if Saturn)
lt_enconly for Saturnprovided by APISlocal time of Enceladus (if Saturn)
lt_theonly for Saturnprovided by APISlocal time of Tethys (if Saturn)
lt_dioonly for Saturnprovided by APIS local time of Dione (if Saturn)
lt_rheonly for Saturnprovided by APISlocal time of Rhea (if Saturn)
lt_titonly for Saturnprovided by APISlocal time of Titan (if Saturn)
rs_casonly for Saturnprovided by APISDistance of Cassini to Saturn
lat_casonly for Saturnprovided by APISLatitude of Cassini
lt_casonly for Saturnprovided by APISLocal time of Cassini
rs_galonly for Jupiterprovided by APISDistance of Galileo to Jupiter
lat_galonly for Jupiterprovided by APISLatitude of Galileo
lt_galonly for Jupiterprovided by APISLocal time of Galileo
rs_junonly for Jupiterprovided by APISDistance of Juno to Jupiter
lat_junonly for Jupiterprovided by APISLatitude of Juno
lt_junonly for Jupiterprovided by APISLocal time of Juno

Internal APIS conversion table

The internal APIS table (named apis_data) consists in one line per observation, with several products described in several columns. 

APISMandatoryrelation with EPNcoreComment
idyes arbitrary ID (unique)
calibrated_filenameyesaccess_url for original_data granulerelative path of level 1 data (whether imaging or spectroscopy). FITS format.
calibrated_previewyes

access_url for original_data granule

relative path of level 1 jpg plot (whether imaging or spectroscopy). JPEG format.
processed_filenameyesaccess_url for processed_data granulerelative path of level 2 data (whether imaging or spectroscopy). FITS format.
processed_previewyesaccess_url for processed_data granulerelative path of level 2 jpg plot (whether imaging or spectroscopy). JPEG format.
processed_pdfyesaccess_url for processed_data granulerelative path of level 2 pdf plot (whether imaging or spectroscopy). PDF format.
spectrum_filenamedepends on the provided data levelsaccess_url for 1D_spectra granulerelative path of level 3 data (= 1D spectra, applicable only to spectroscopic observations). FITS format.
spectrum_previewdepends on the provided data levelsaccess_url for  1D_spectra granulerelative path of level 3 jpg plot (= 1D spectra, applicable only to spectroscopic observations). JPEG format.
spectrum_pdfdepends on the provided data levelsaccess_url for  1D_spectra granulerelative path of level 3 pdf plot (= 1D spectra, applicable only to spectroscopic observations). PDF format.

cylindric_filename

depends on the provided data levelsaccess_url for cylindric_proj granulerelative path of level 3 data (= cylindrical projection, applicable only to images). FITS format.

cylindric_preview

depends on the provided data levelsaccess_url for  cylindric_proj granulerelative path of level 3 jpg plot (= cylindrical projection, applicable only to images). JPEG format.

cylindric_pdf

depends on the provided data levelsaccess_url for  cylindric_proj granulerelative path of level 3 pdf plot (= cylindrical projection, applicable only to images). PDF format.

polar_n_filename

depends on the provided data levelsaccess_url for polar_proj_north granulerelative path of level 3 data (= northern polar projection, applicable only to images). FITS format.

polar_n_preview

depends on the provided data levelsaccess_url for  polar_proj_north granulerelative path of level 3 jpg plot (= northern polar projection, applicable only to images). JPEG format.

polar_n_pdf

depends on the provided data levelsaccess_url for  polar_proj_north granulerelative path of level 3 pdf plot (= northern polar projection, applicable only to images). PDF format.

polar_s_filename

depends on the provided data levelsaccess_url for  polar_proj_south granulerelative path of level 3 data (= southern polar projection, applicable only to images). FITS format.

polar_s_preview

depends on the provided data levelsaccess_url for  polar_proj_south granulerelative path of level 3 jpg plot (= southern polar projection, applicable only to images). JPEG format.

polar_s_pdf

depends on the provided data levelsaccess_url for  polar_proj_south granulerelative path of level 3 pdf plot (= southern polar projection, applicable only to images). PDF format.
telescopyesinstrument_host_nameSpacecraft / observatory name
instrumeyesinstrument_nameinstrument name
targnameyestarget_nametarget name. Uppercase for APIS (ex: JUPITER), Capitalized for EPNcore (ex: Jupiter)
tdateobsno yyyy-mm-dd (in UT time) of the start of the observation
ttimeobsno hh:mm:ss (in UT time) of the start of the observation
datetimeyes

time_min

time_max

yyyy-mm-dd hh:mm:ss (in UT time) of the start of the observation

EPNcore values are in Julian dates

texptimeyes

time_exp_min

time_exp_max 

exposure time in second
obstypeyesdataproduct_type

IMAGING or SPECTROSCOPY or SPECTRO-IMAGING

im, sp or cs for EPNcore

obsmodeyes obs_modePhotometric mode. Example with HST data = ACCUM or TIME-TAG
photmodeno Example with HST data = FUV-MAMA (omit if non applicable)       
detectoryes detector_nameExample with HST data = FUV-MAMA (for STIS) or SBC (for ACS)
opt_elemyes opt_elemExample with HST data = G140L (= grating for spectra) or MIRFUV (for images)
filteryes filterExample with HST data = F25SrF2
orientatyes orientationPosition angle of image y axis (in degrees, east of north)
bandwid 

spectral_resolution_min = 3E18/spectral_step OR

3E18/bandwid

spectral_resolution_max = 3E18/spectral_step OR

3E18/bandwid

spectral bandwidth in Angstroms
cenwave   
specresyes approx. resolving power at central wavelength  in Angstroms
centrwvno central wavelength in Angstroms
minwaveyesspectral_range_min = 3E18/minwavemin wavelength of the spectrum in Angstroms
maxwaveyesspectral_range_max = 3E18/minwavemax wavelength of the spectrum in Angstroms
spectral_stepyes

spectral_sampling_step_min = 3E18/spectral_step

spectral_sampling_step_max = 3E18/spectral_step

spectral step in Angstroms
last_updateyes last update of the line in the database (yyyy-mm-ddThh:mm:ss)
bunityesmeasurement_unitunit
proposidyesproposal_idExample with HST data = ID of HST proposal (unique)
pr_inv_lyesproposal_pilast name of principal investigator
propttl1yesproposal_titletitle of proposal
tardescr   
originyes Example with HST data = NOAO-IRAF FITS Image Kernel July 2003 (omit if non applicable)
ra_targyesraRight ascencion of the target 
dec_targyesdecDeclination of the target 
platescyesplatescspatial resolution per pixel or platescale (in arcsec/pixels)
dateyes date when the data was written (yyyy-mm-ddThh:mm:ss)
cal_verno calibration pipeline version (omit if non applicable)
rootnameyesobs_idrootname of the dataset (Example with HST : each observation has a unique name in 9 characters)
campaignyescampaignname of the observational campaign (Example with HST : Saturn - 2005 26 Oct-02 Nov)
sunangle   
moonangl   
sun_alt   
subelatyes sub-earth latitude in degree
subslatyes sub-solar latitude in degree
subelonyes sub-earth longitude in degree (system III for Jupiter, Uranus, NULL for Saturn)
subslonyes sub-solar longitude in degree (system III for Jupiter, Uranus, NULL for Saturn)
distsyes target-sun distance 
diste yestarget_distance_min, target_distance_maxtarget-earth distance 
rapyestarget_apparent_radiusapparent radius of the target (in arcsec)
np_posyesnorth_pole_positionnorth pole position angle with respect to celestial north pole in degree
phaseyes

phase_min

phase_max

phase angle
hemis1yestarget_primary_hemisphere

primary observed hemisphere (= South or North)

hemis2yestarget_secondary_hemispheresecondary observed hemisphere (= South or North or maybe NULL)
date_processedyescreation_date

first file writing date (yyyy-mm-ddThh:mm:ss)       

 

modified_at

yesmodification_datefile modification date (yyyy-mm-ddThh:mm:ss)  
skr_nonly for Saturn Meudon SKR Northern variable phase (SIII does not work for Saturn)
skr_sonly for Saturn Meudon SKR Southern variable phase (SIII does not work for Saturn)
lon_ioonly for Jupiter longitude of Io in system III  (if Jupiter)
lt_ioonly for Jupiter local time of Io  (if Jupiter)
lon_euronly for Jupiter longitude of Europa in system III (if Jupiter)
lt_euronly for Jupiter local time of Europa (if Jupiter)
lon_ganonly for Jupiter longitude of Ganymede in system III (if Jupiter)
lt_ganonly for Jupiter local time of Ganymede (if Jupiter)
lon_calonly for Jupiter longitude of Callisto in system III (if Jupiter)
lt_calonly for Jupiter local time of Callisto (if Jupiter)
lt_mimonly for Jupiter local time of Mimas (if Saturn)
lt_enconly for Saturn local time of Enceladus (if Saturn)
lt_theonly for Saturn local time of Tethys (if Saturn)
lt_dioonly for Saturn  local time of Dione (if Saturn)
lt_rheonly for Saturn local time of Rhea (if Saturn)
lt_titonly for Saturn local time of Titan (if Saturn)
rs_casonly for Saturn Distance of Cassini to Saturn
lat_casonly for Saturn Latitude of Cassini
lt_casonly for Saturn Local time of Cassini
rs_galonly for Jupiter Distance of Galileo to Jupiter
lat_galonly for Jupiter Latitude of Galileo
lt_galonly for Jupiter Local time of Galileo
rs_junonly for Jupiter Distance of Juno to Jupiter
lat_junonly for Jupiter Latitude of Juno
lt_junonly for Jupiter Local time of Juno

 

 


  • No labels
Write a comment…