Databases

From Radarwiki

Jump to: navigation, search

Proposed format for submission/exchange of radar database quantities

In the future, our radar observations will be partly or fully processed automatically by a data processing pipeline. We would like to facilitate storage of the relevant findings in a database.

Desirable features of the database include: ability to ingest results of data processing scripts as well as historical data, ability to export to standard formats automatically (e.g., CSV, Planetary Data System), ability to generate SNR tables automatically, ability to generate tables of measurements automatically (e.g, LaTeX).

The text format below is intended to simplify data entry by data analysts and undergraduates (who may not have expertise in database syntax) and to facilitate automatic submissions by data processing scripts or pipelines.

Text files submissions will be checked automatically for correct syntax, with debugging information sent to submitter in case of incorrect syntax.

A script will flag any difference between syntactically correct submissions and existing values in the database. Review of the submission report by a radar expert before insertion into the database will provide some degree of quality control.

Approved submissions will be parsed by a script to generate database insertion commands.

Original text submissions will be stored on a server forever to accommodate/reconcile multiple submissions for the same object, and to allow parsing by different scripts if needed.

Please click here for an example of a short submission (cross-section and polarization ratio information).
Please click here for a more extensive submission (results of shape modeling, spin axis information).
Please click here for an even longer submission.

# Radar Data Text file.
# Format version 1.4.
# Please see notes at the bottom for format rules (filename, date/time, references, and uncertainties).
# Everything after a "#" is a comment.
# Report quantities as field=value, one per line. Order of lines is not important. Enclose strings in "quotes".
# Separate field names and suffixes with a period, as in field.suffix=value
# Undefined fields need not be present in the file.
# Fields marked with (*) will be downloaded from external databases - do not spend time filling out these fields.
# Submit your file as an email to TBD or store in project directory TBD.
#
#-----------------------------------------------------------------------------------------------------------------------------
# Begin data
#-----------------------------------------------------------------------------------------------------------------------------
#
#-----------------------------------------------------------------------------------------------------------------------------
# Field                         Data type       Meaning
#-----------------------------------------------------------------------------------------------------------------------------
#
# Non-radar quantities
#
# [identification]
DESIG                           string          Primary/First provisional designation of asteroid assigned by MPC
NUMBER                          long integer    Number assigned by MPC
NAME                            string          Name assigned by MPC
COMP                            string          Component name in multiple (a for alpha, b for beta, ..., inner to outer)
SUBMITTER                       string          Your email address
PUBLIC				integer         Information in this submission can be made public (1=yes, 0=no)
#
# [magnitude]
HMPC                            float           Absolute magnitude as reported by MPC (*)
GMPC                            float           Slope parameter as reported by MPC (*)
H                               float           Absolute magnitude as reported in peer-reviewed literature
G                               float           Slope parameter as reported in peer-reviewed literature
#
# [taxonomy]
TAXT                            string          Tholen taxonomic type (*)
TAXB                            string          Bus taxonomic type (*)
TAXD                            string          DeMeo taxonomic type (*)
#
# [spin]
PLCDB                           float           Lightcurve estimate of spin period in h from lightcurve database (*)
PLC                             float           Lightcurve estimate of spin period in h from other source
YORP                            float           YORP acceleration in deg/day^2
#
# [heliocentric orbit]
YARKO                           float           Optical astrometry estimate of da/dt in 10^-4 AU/My
#
#-----------------------------------------------------------------------------------------------------------------------------
#
# Radar quantities
#
# [morphology]
ncomp                           integer         Number of components in system (1: single, 2: binary, 3: triple, etc)
tmorph                          string          Taylor morphological type 
amorph                          string          Morphological type from automatic classification algorithm
#
# [image-based dimensions (idim)]
deff                            float           Effective diameter in km (best estimate based on all radar images) 
repoch                          string          MJD or ISO epoch for measurement below (use as many blocks as necessary)
r                               float           Range extent in km
bepoch                          string          MJD or ISO epoch for measurement below (use as many blocks as necessary)
bf				float		Freqency in MHz for measurement below (typically 2380 or 8560)
b                               float           Doppler bandwidth in Hz 
#
# [shape-based dimensions (sdim)]
dequ                            float           Equivalent diameter in km
ex                              float           Extent along principal axis x in km
ey                              float           Extent along principal axis y in km
ez                              float           Extent along principal axis z in km
dx                              float           DEEVE extent along x in km
dy                              float           DEEVE extent along y in km
dz                              float           DEEVE extent along z in km
area                            float           Surface area A in km^2 (facet scale)
vol                             float           Volume in km^3
#
# [spin]                                        
pepoch                          string          MJD or ISO epoch for measurement below (use as many blocks as necessary)
p                               float           Spin period in h (based on radar bandwidth/images/shape) 
#                                               Note: use asymmetric error bars to represent upper limits on spin period
lambda                          float           For PA rotators, spin axis ecliptic longitude in deg (J2000.0)
beta                            float           For PA rotators, spin axis ecliptic latitude in deg (J2000.0)
#
# [reflectivity (refl)]
xepoch                          string          MJD or ISO epoch for measurements below (use as many blocks as necessary)
xf				float		Freqency in MHz for measurements below (typically 2380 or 8560)
xoc                             float           Radar cross-section OC in km^2 
xsc                             float           Radar cross-section OC in km^2 
soc                             float           Radar albedo OC 
ssc                             float           Radar albedo SC 
uc                              float           Circular polarization ratio soc/ssc 
#
# [mutual orbit (morb)]
oepoch                          string          MJD or ISO epoch for orbital elements
a                               double          Semimajor axis in km
ma                              double          Mean anomaly at the epoch in degrees			    
w                               double          Argument of perihelion in degrees (J2000.0)		    
om                              double          Longitude of the ascending node in degrees (J2000.0)	    
i                               double          Inclination to the ecliptic in degrees (J2000.0)	    
e                               double          Orbital eccentricity 					    
n                               double          Mean daily motion (degrees per day)                         
# 
# [heliocentric orbit]
yarkr                           float           Radar+Optical astrometry estimate of da/dt in 10^-4 AU/My
#
# [notes]
notes                           string          Use this field for additional notes 
#                                               Note: notes can be arbitrarily long here, but not in database
#
#-----------------------------------------------------------------------------------------------------------------------------
# End data
#-----------------------------------------------------------------------------------------------------------------------------
#
#-----------------------------------------------------------------------------------------------------------------------------
#
# Format for uncertainties:
#
# The suffix U appended to any field name is used to convey symmetric uncertainties, 
# e.g., r=1, r.U=0.2, for r=1+/-0.2.
# The suffix D appended to any field name is used to convey asymmetric uncertainties.
# If D is defined, the meaning of the U uncertainty (which must also be defined) changes:
# e.g., r=1, r.U=0.2, r.D=0.3, for r=1+0.2-0.3.
# Both U and D values must be positive and in the same units as the relevant quantity.
# You may use U% and D% instead of U and D to convey fractional uncertainties in per cent:
# e.g., r.U%=10 implies 10% fractional uncertainties on r.
# You may use U@ to convey a cone of uncertainty in deg around the nominal spin axis direction:
# e.g., beta.U@=5.
#
#-----------------------------------------------------------------------------------------------------------------------------
#
# Format for references:
#
# The suffix REF appended to any field name is used to convey a peer-reviewed reference or database name:
# e.g., yarkr.REF="Chelsey et al, 2008", PLCDB.REF="LCDB, Feb 2014", ncomp.REF="Taylor, pers.comm.".
# The suffix BIB appended to any field name is used to convey a NASA ADS bibcode:
# e.g., orb.BIB="2006Sci...314.1276O".
# The suffix URL appended to any field name is used to convey a URL (other than a NASA ADS URL):
# e.g., dequ.URL="http://arxiv.org/abs/1301.6655".
# The suffix VER appended to any field name is used to convey a software identifier:
# e.g., amorph.VER="AutoMorph 1.0.2".
#
# A single reference may be provided for groups of quantities (image-based dimensions, shape-based dimensions, reflectivity, 
# mutual orbit) by using the corresponding group name (idim, sdim, refl, and morb) as opposed to individual field names. 
# In that case the reference will be applied to all fields that belong to group AND that are defined in current submission:
# e.g., sdim.BIB="2013Icar..226..323N", sdim.VER="SHAPE 2.7.0".
#
#-----------------------------------------------------------------------------------------------------------------------------
#
# Format for date/time:
#
# You may specify UTC date/time strings in the ISO format (https://en.wikipedia.org/wiki/ISO_8601):
#
# String                        Year Mon  DOY DOM  HR Min Sec
# ----------------------------  ---- ---  --- ---  -- --- ------
# 1996-12-18T12:28:28           1996 Dec   na  18  12  28 28
# 1986-01-18T12                 1986 Jan   na  18  12  00 00
# 1986-01-18T12:19              1986 Jan   na  18  12  19 00
# 1986-01-18T12:19:52.18        1986 Jan   na  18  12  19 52.18
# 1995-08T18:28:12              1995  na  008  na  18  28 12
# 1995-18T                      1995  na  018  na  00  00 00
# 1995T                         1995  na   na  na  na  na na
#
# If the UTC date/time is not available, you may specify a timezone with +hh or -hh
# at the end of the ISO string, e.g., 1986-01-18T12:19:52.18-04
#
# You may also specify date/time strings in the modified julian date (MJD) format:
#
# MJD="51544.0" corresponds to  ISO="2000-01-01T00:00:00.00"
#      
#-----------------------------------------------------------------------------------------------------------------------------
#
# Format for filename:
#
# If you omit the DESIG and NUMBER fields, please name your file according to 
# the (unpacked) MPC designation or asteroid number, followed by extension .rdt:
# e.g., 1999KW4.rdt, 66391.rdt.
# Append a letter when reporting data for the second or third component of a multiple system:
# e.g., 1999KW4b.rdt for 1999 KW4 beta.
#
#-----------------------------------------------------------------------------------------------------------------------------
Personal tools