.. _field name list: =================================== Data Container Field Name Reference =================================== The following table lists field names that are recognized by `sbpy` when accessing `~sbpy.data.DataClass` objects, i.e., `~sbpy.data.Ephem`, `~sbpy.data.Orbit`, or `~sbpy.data.Phys` objects. Each row of the following table represents one property; for each property it lists its description, acceptable field names, provenance (which `~sbpy.data.DataClass` class should be used to store this object so that `sbpy` uses it properly), and its physical dimension (if any). How do I use this Table? ------------------------ As an example, imagine you are interested in storing an object's right ascension into a `~sbpy.data.DataClass` object. The field names table tells you that you should name the field either ``ra`` or ``RA``, that you should use either a `~sbpy.data.Ephem` or `~sbpy.data.Obs` object to store the data in, and that the field data should be expressed as angles. Based on this information, we can create a `~sbpy.data.Obs` object (presuming that the data were derived from observations): >>> from sbpy.data import Obs >>> import astropy.units as u >>> obs = Obs.from_dict({'ra': [12.345, 12.346, 12.347]*u.deg}) >>> obs['ra'] # doctest: +SKIP Since RA requires an angle as dimension, we use degrees, but we might as well use radians - `sbpy` will convert the units where necessary. RA has an alternative field name (``'RA'``), we can now use that name, too, in order to retrieve the data: >>> obs['RA'] # doctest: +SKIP The field name list is always up to date, but it might not be complete. If you think an important alternative name is missing, please suggest it by opening an issue. However, keep in mind that each alternative field name has to be **unique** and **unambiguous**. The source list is located as ``sbpy.data.Conf.fieldnames`` in ``sbpy/data/__init__.py``. Special Case: Epoch ------------------- Please note that epochs generally have to be provided as `~astropy.time.Time` objects. The advantage of using such objects is that they can be readily transformed into a wide range of formats (e.g., ISO, Julian Date, etc.) and time scales (e.g., UTC, TT, TDB, etc.) Hence, `sbpy` requires that all fields referring to a point in time be provided as `~astropy.time.Time` objects. Field Name List --------------- ======================================================= =================================================================================================================== =========================================================================== ==================== Description Field Names Provenance Dimension ======================================================= =================================================================================================================== =========================================================================== ==================== **Target Identifier** ``targetname``, ``id``, ``Object`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs`, `~sbpy.data.Phys` None **Target Designation** ``desig``, ``designation`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs`, `~sbpy.data.Phys` None **Target Number** ``number`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs`, `~sbpy.data.Phys` None **Target Name** ``name`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs`, `~sbpy.data.Phys` None **Epoch** ``epoch``, ``datetime``, ``Date``, ``date``, ``Time``, ``time`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs` `~astropy.time.Time` **Semi-Major Axis** ``a``, ``sma`` `~sbpy.data.Orbit` length **Eccentricity** ``e``, ``ecc`` `~sbpy.data.Orbit` None **Inclination** ``i``, ``inc``, ``incl`` `~sbpy.data.Orbit` angle **Perihelion Distance** ``q``, ``periheldist`` `~sbpy.data.Orbit` length **Aphelion Distance** ``Q``, ``apheldist`` `~sbpy.data.Orbit` length **Longitude of the Ascending Node** ``Omega``, ``longnode``, ``node`` `~sbpy.data.Orbit` angle **Argument of the Periapsis** ``w``, ``argper`` `~sbpy.data.Orbit` angle **Mean Anomaly** ``M``, ``mean_anom`` `~sbpy.data.Orbit` angle **True Anomaly** ``v``, ``true_anom``, ``true_anomaly`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Arc Length** ``arc``, ``arc_length`` `~sbpy.data.Orbit` angle **Delta-v** ``delta_v``, ``delta-v`` `~sbpy.data.Orbit`, `~sbpy.data.Phys` velocity **Minimum Orbit Intersection Distance wrt Mercury** ``moid_mercury`` `~sbpy.data.Orbit`, `~sbpy.data.Phys` length **Minimum Orbit Intersection Distance wrt Earth** ``moid_earth`` `~sbpy.data.Orbit`, `~sbpy.data.Phys` length **Minimum Orbit Intersection Distance wrt Venus** ``moid_venus`` `~sbpy.data.Orbit`, `~sbpy.data.Phys` length **Minimum Orbit Intersection Distance wrt Mars** ``moid_mars`` `~sbpy.data.Orbit`, `~sbpy.data.Phys` length **Minimum Orbit Intersection Distance wrt Jupiter** ``moid_jupiter`` `~sbpy.data.Orbit`, `~sbpy.data.Phys` length **Minimum Orbit Intersection Distance wrt Saturn** ``moid_saturn`` `~sbpy.data.Orbit`, `~sbpy.data.Phys` length **Minimum Orbit Intersection Distance wrt Uranus** ``moid_uranus`` `~sbpy.data.Orbit`, `~sbpy.data.Phys` length **Minimum Orbit Intersection Distance wrt Neptune** ``moid_neptune`` `~sbpy.data.Orbit`, `~sbpy.data.Phys` length **Tisserand Parameter wrt Jupiter** ``Tj``, ``tj`` `~sbpy.data.Orbit`, `~sbpy.data.Phys` None **MPC Orbit Type** ``mpc_orb_type`` `~sbpy.data.Orbit`, `~sbpy.data.Phys` None **Epoch of Perihelion Passage** ``Tp`` `~sbpy.data.Orbit` `~astropy.time.Time` **Orbital Period** ``P``, ``period`` `~sbpy.data.Orbit`, `~sbpy.data.Phys` time **Heliocentric Distance** ``r``, ``rh``, ``r_hel``, ``heldist`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` length **Heliocentric Radial Velocity** ``r_rate``, ``rh_rate``, ``rdot``, ``r-dot``, ``rhdot``, ``rh-dot`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` velocity **Distance to the Observer** ``delta``, ``Delta``, ``obsdist`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` length **Observer-Target Radial Velocity** ``delta_rate``, ``deltadot``, ``delta-dot``, ``deldot``, ``del-dot`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` velocity **Right Ascension** ``ra``, ``RA`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Declination** ``dec``, ``DEC``, ``Dec`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Right Ascension Rate** ``ra_rate``, ``RA_rate``, ``ra_rates``, ``RA_rates``, ``dRA``, ``dra`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angular velocity **RA*cos(Dec) Rate** ``RA*cos(Dec)_rate``, ``dra cos(dec)``, ``dRA cos(Dec)``, ``dra*cos(dec)``, ``dRA*cos(Dec)`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angular velocity **Declination Rate** ``dec_rate``, ``DEC_rate``, ``Dec_rate``, ``dec_rates``, ``DEC_rates``, ``Dec_rates``, ``dDec``, ``dDEC``, ``ddec`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angular velocity **Proper Motion** ``mu``, ``Proper motion`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angular velocity **Proper Motion Direction** ``Direction``, ``direction`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Solar Phase Angle** ``alpha``, ``phaseangle``, ``Phase``, ``phase`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Solar Elongation Angle** ``elong``, ``solarelong``, ``solarelongation``, ``elongation``, ``Elongation`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **V-band Magnitude** ``V``, ``Vmag`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` magnitude **Heliocentric Ecliptic Longitude** ``hlon``, ``EclLon``, ``ecllon``, ``HelEclLon``, ``helecllon`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Heliocentric Ecliptic Latitude** ``hlat``, ``EclLat``, ``ecllat``, ``HelEclLat``, ``helecllat`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Horizontal Elevation** ``el``, ``EL``, ``elevation``, ``alt``, ``altitude``, ``Altitude`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Horizontal Azimuth** ``az``, ``AZ``, ``azimuth`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Lunar Elongation** ``lunar_elong``, ``elong_moon``, ``elongation_moon``, ``lunar_elongation``, ``lunarelong`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **X State Vector Component** ``x``, ``X``, ``x_vec`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs` length **Y State Vector Component** ``y``, ``Y``, ``y_vec`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs` length **Z State Vector Component** ``z``, ``Z``, ``z_vec`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs` length **X Velocity Vector Component** ``vx``, ``dx``, ``dx/dt`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs` velocity **Y Velocity Vector Component** ``vy``, ``dy``, ``dy/dt`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs` velocity **Z Velocity Vector Component** ``vz``, ``dz``, ``dz/dt`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs` velocity **X heliocentric position vector** ``x_h``, ``X_h`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs` length **Y heliocentric position vector** ``y_h``, ``Y_h`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs` length **Z heliocentric position vector** ``z_h``, ``Z_h`` `~sbpy.data.Orbit`, `~sbpy.data.Ephem`, `~sbpy.data.Obs` length **Comet Total Absolute Magnitude** ``m1``, ``M1`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` magnitude **Comet Nuclear Absolute Magnitude** ``m2``, ``M2`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` magnitude **Total Magnitude Scaling Factor** ``k1``, ``K1`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` None **Nuclear Magnitude Scaling Factor** ``k2``, ``K2`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` None **Phase Coefficient** ``phase_coeff``, ``Phase_coeff`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` None **Information on Solar Presence** ``solar_presence``, ``Solar_presence`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` None **Information on Moon and target status** ``status_flag``, ``Status_flag`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` None **Apparent Right Ascension** ``RA_app``, ``ra_app`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Apparent Declination** ``DEC_app``, ``dec_app`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Azimuth Rate (dAZ*cosE)** ``az_rate``, ``AZ_rate`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angular velocity **Elevation Rate (d(ELV)/dt)** ``el_rate``, ``EL_rate`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angular velocity **Satellite Position Angle** ``sat_pang``, ``Sat_pang`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Local Sidereal Time** ``siderealtime``, ``Siderealtime`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` time **Target Optical Airmass** ``airmass``, ``Airmass`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` None **V Magnitude Extinction** ``vmagex``, ``Vmagex`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` magnitude **Surface Brightness** ``Surfbright``, ``surfbright`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` magnitude/angle^2 **Fraction of Illumination** ``frac_illum``, ``Frac_illum`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` percent **Illumination Defect** ``defect_illum``, ``Defect_illum`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Target-primary angular separation** ``targ_sep``, ``Targ_sep`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Target-primary visibility** ``targ_vis``, ``Targ_vis`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` None **Angular width of target** ``targ_width``, ``Targ_width`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Apparent planetodetic longitude** ``pldetic_long``, ``Pldetic_long`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Apparent planetodetic latitude** ``pldetic_lat``, ``Pldetic_lat`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Apparent planetodetic Solar longitude** ``pltdeticSol_long``, ``PltdeticSol_long`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Apparent planetodetic Solar latitude** ``pltdeticSol_lat``, ``PltdeticSol_lat`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Target sub-solar point position angle** ``subsol_ang``, ``Subsol_ang`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Target sub-solar point angle distance** ``subsol_dist``, ``Subsol_dist`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Target North pole position angle** ``npole_angle``, ``Npole_angle`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Target North pole position distance** ``npole_dist``, ``Npole_dist`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Observation centric ecliptic longitude** ``obs_ecl_long``, ``Obs_ecl_long`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Observation centric ecliptic latitude** ``obs_ecl_lat``, ``Obs_ecl_lat`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **One-way light time** ``lighttime``, ``Lighttime`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` time **Target center velocity wrt Sun** ``vel_sun``, ``Vel_sun`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` velocity **Target center velocity wrt Observer** ``vel_obs``, ``Vel_obs`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` velocity **Lunar illumination** ``lun_illum``, ``Lun_illum`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` percent **Apparent interfering body elongation wrt observer** ``ib_elong``, ``IB_elong`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Interfering body illumination** ``ib_illum``, ``IB_illum`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` percent **Observer primary target angle** ``targ_angle_obs``, ``Targ_angle_obs`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Orbital plane angle** ``orbangle_plane``, ``Orbangle_plane`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` deg **Constellation ID containing target** ``constellation``, ``Constellation`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` None **Target North Pole RA** ``targ_npole_ra``, ``targ_npole_RA`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Target North Pole DEC** ``targ_npole_dec``, ``targ_npole_DEC`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Galactic Longitude** ``glx_long``, ``Glx_long`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Galactic Latitude** ``glx_lat``, ``Glx_lat`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Local apparent solar time** ``solartime`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` None **Observer light time from Earth** ``earthlighttime``, ``Earthlighttime`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` time **3 sigma positional uncertainty RA** ``RA_3sigma``, ``ra_3sigma`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **3 sigma positional uncertainty DEC** ``DEC_3sigma``, ``dec_3sigma`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **3 sigma positional uncertainty semi-major axis** ``sma_3sigma`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **3 sigma positional uncertainty semi-minor axis** ``smi_3sigma`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **3 sigma positional uncertainty position angle** ``posangle_3sigma`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **3 sigma positional uncertainty ellipse area** ``area_3sigma`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angular area **3 sigma positional uncertainty root sum square** ``rss_3sigma`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **3 sigma range uncertainty** ``r_3sigma`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` length **3 sigma range rate uncertainty** ``r_rate_3sigma`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` velocity **3 sigma doppler radar uncertainty at S-band** ``sband_3sigma`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` frequency **3 sigma doppler radar uncertainty at X-band** ``xband_3sigma`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` frequency **3 sigma doppler round-trip delay uncertainty** ``dopdelay_3sigma`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` time **Local apparent hour angle** ``locapp_hourangle`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` time **True phase angle** ``true_phaseangle`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Phase angle bisector longitude** ``pab_long`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Phase angle bisector latitude** ``pab_lat`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Absolute V-band Magnitude** ``abs_V``, ``abs_Vmag`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` magnitude **Satellite X-position** ``sat_X``, ``sat_x`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Satellite Y-position** ``sat_y``, ``sat_Y`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Atmospheric Refraction** ``atm_refraction``, ``refraction`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` angle **Infrared Beaming Parameter** ``eta``, ``Eta`` `~sbpy.data.Ephem`, `~sbpy.data.Obs` None **Temperature** ``temp``, ``Temp``, ``temperature``, ``Temperature`` `~sbpy.data.Phys`, `~sbpy.data.Ephem`, `~sbpy.data.Obs` temperature **Effective Diameter** ``d``, ``D``, ``diam``, ``diameter``, ``Diameter`` `~sbpy.data.Phys` length **Effective Radius** ``R``, ``radius`` `~sbpy.data.Phys` length **Geometric Albedo** ``pv``, ``pV``, ``p_v``, ``p_V``, ``geomalb`` `~sbpy.data.Phys` None **Bond Albedo** ``A``, ``bondalbedo`` `~sbpy.data.Phys` None **Emissivity** ``emissivity``, ``Emissivity`` `~sbpy.data.Phys` None **Absolute Magnitude** ``absmag``, ``H`` `~sbpy.data.Phys`, `~sbpy.data.Ephem`, `~sbpy.data.Orbit` magnitude **Photometric Phase Slope Parameter** ``G``, ``slope`` `~sbpy.data.Phys`, `~sbpy.data.Ephem`, `~sbpy.data.Orbit` None **Molecule Identifier** ``mol_tag``, ``mol_name`` `~sbpy.data.Phys` None **Transition frequency** ``t_freq`` `~sbpy.data.Phys` frequency **Integrated line intensity at 300 K** ``lgint300`` `~sbpy.data.Phys` intensity **Integrated line intensity at designated Temperature** ``intl``, ``lgint`` `~sbpy.data.Phys` intensity **Partition function at 300 K** ``partfn300`` `~sbpy.data.Phys` None **Partition function at designated temperature** ``partfn`` `~sbpy.data.Phys` None **Upper state degeneracy** ``dgup`` `~sbpy.data.Phys` None **Upper level energy in Joules** ``eup_j``, ``eup_J`` `~sbpy.data.Phys` energy **Lower level energy in Joules** ``elo_j``, ``elo_J`` `~sbpy.data.Phys` energy **Degrees of freedom** ``degfr``, ``ndf``, ``degfreedom`` `~sbpy.data.Phys` None **Einstein Coefficient** ``au``, ``eincoeff`` `~sbpy.data.Phys` 1/time **Timescale * r^2** ``beta``, ``beta_factor`` `~sbpy.data.Phys` time * length^2 **Total Number** ``totnum``, ``total_number_nocd`` `~sbpy.data.Phys` None **Column Density from Bockelee Morvan et al. 2004** ``cdensity``, ``col_density`` `~sbpy.data.Phys` 1/length^2 ======================================================= =================================================================================================================== =========================================================================== ====================