Skip to content

Commit 3e9ff61

Browse files
committed
docs: add a section about measurement tables
1 parent cf50acf commit 3e9ff61

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

docs/simbad/simbad.rst

+66
Original file line numberDiff line numberDiff line change
@@ -602,6 +602,72 @@ And the columns in the output can be reset to their default value with
602602
A detailed description on the ways to add fluxes is available in the
603603
:ref:`optical filters` section.
604604

605+
Measurement fields vs. Basic fields
606+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
607+
608+
Some field names start with ``mes``. These denote what SIMBAD calls a
609+
"measurement table". These tables store the history on past measurements of a physical
610+
parameter for each object.
611+
612+
Let's look at the star ``HD 200207`` with the parallax measurements table ``mesplx``:
613+
614+
.. doctest-remote-data::
615+
616+
>>> from astroquery.simbad import Simbad
617+
>>> simbad = Simbad()
618+
>>> simbad.add_votable_fields("mesplx")
619+
>>> hd_200207 = simbad.query_object("HD 200207")
620+
>>> hd_200207[["main_id", "mesplx.plx", "mesplx.plx_err", "mesplx.bibcode"]]
621+
<Table length=5>
622+
main_id mesplx.plx mesplx.plx_err mesplx.bibcode
623+
mas mas
624+
object float32 float32 object
625+
--------- ---------- -------------- -------------------
626+
HD 200207 3.4084 0.0195 2020yCat.1350....0G
627+
HD 200207 3.4552 0.0426 2018yCat.1345....0G
628+
HD 200207 3.35 0.76 1997A&A...323L..49P
629+
HD 200207 3.72 0.62 2007A&A...474..653V
630+
HD 200207 3.25 0.22 2016A&A...595A...2G
631+
632+
This field adds one line per parallax measurement: five articles have measured it
633+
for this star.
634+
635+
If you are only interested in the most precise measure recorded by the SIMBAD team, some
636+
measurements fields have an equivalent in the basic fields. These fields only give one
637+
line per object with the most precise currently known value:
638+
639+
+-------------------+---------------+
640+
| measurement field | basic field |
641+
+===================+===============+
642+
| mesplx | parallax |
643+
+-------------------+---------------+
644+
| mespm | propermotions |
645+
+-------------------+---------------+
646+
| messpt | sp |
647+
+-------------------+---------------+
648+
| mesvelocities | velocity |
649+
+-------------------+---------------+
650+
651+
Here, ``mesplx`` has an equivalent in the basic fields so we could have done:
652+
653+
.. doctest-remote-data::
654+
655+
>>> from astroquery.simbad import Simbad
656+
>>> simbad = Simbad()
657+
>>> simbad.add_votable_fields("parallax")
658+
>>> hd_200207 = simbad.query_object("HD 200207")
659+
>>> hd_200207[["main_id", "plx_value", "plx_err", "plx_bibcode"]]
660+
<Table length=1>
661+
main_id plx_value plx_err plx_bibcode
662+
mas mas
663+
object float64 float32 object
664+
--------- --------- ------- -------------------
665+
HD 200207 3.4084 0.0195 2020yCat.1350....0G
666+
667+
And we only have one line per object with the value selected by SIMBAD's team.
668+
669+
Thus, choosing to add a measurement field or a basic field depends on your goal.
670+
605671
Additional criteria
606672
-------------------
607673

0 commit comments

Comments
 (0)