Skip to content

Commit ae9dd53

Browse files
authored
Merge pull request #3287 from esdc-esac-esa-int/ESA_euclid_EUCLIDMNGT-1355_delete_xmatch_documentation
EUCLID: delete Xmatch documentation [ci skip]
2 parents 3172b82 + ebf5f4d commit ae9dd53

File tree

1 file changed

+10
-59
lines changed

1 file changed

+10
-59
lines changed

docs/esa/euclid/euclid.rst

Lines changed: 10 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,6 @@ ESA EUCLID TAP+ server provides two access modes: public and authenticated:
6363

6464
* ADQL queries and results are saved in a user private area.
6565

66-
* Cross-match operations: a catalog cross-match operation can be executed.
67-
Cross-match operations results are saved in a user private area.
68-
6966
* Persistence of uploaded tables: a user can upload a table in a private space.
7067
These tables can be used in queries as well as in cross-matches operations.
7168

@@ -109,8 +106,8 @@ observations), the next campaign shall be run in March-April 2025.
109106
opened on the 6th of November 2024, with a first pass on the three Euclid deep fields (EDFN, EDFS and EDFF) as well as
110107
observations on the Lynds Dark Nebula LDN1641.
111108

112-
4. The PDR (Public Data Release) environment of the Euclid science archive holds the public data. Euclid Q1 data will be publicly released on March 19,
113-
2025. The main component of the Q1 data shall contain Level 2 data of a single visit (at the depth of the Euclid Wide
109+
4. The PDR (Public Data Release) environment of the Euclid science archive holds the public data. Euclid Q1 data was publicly released on March 19,
110+
2025. The main component of the Q1 data contains Level 2 data of a single visit (at the depth of the Euclid Wide
114111
Survey) over the Euclid Deep Fields (EDFs): 20 deg\ :sup:`2` of the EDF North, 10 deg\ :sup:`2` of EDF Fornax, and
115112
23 deg\ :sup:`2` of the EDF South. The deep fields will be visited multiple times during the mission.
116113

@@ -1031,60 +1028,14 @@ We can type the following:
10311028
Table 'user_joe.table' updated.
10321029

10331030

1034-
2.8. Cross match
1035-
^^^^^^^^^^^^^^^^
1036-
1037-
It is possible to run a geometric cross-match between the ra/dec coordinates of two tables
1038-
using the crossmatch function provided by the archive. In order to do so, the user must be
1039-
logged in. This is required because the cross match operation will generate a join table
1040-
in the user private area. That table contains the identifiers of both tables and the separation,
1041-
in degrees, between ra/dec coordinates of each source in the first table and its associated
1042-
source in the second table. Later, the table can be used to obtain the actual data from both tables.
1043-
1044-
In order to perform a cross match, both tables must have defined RA and Dec columns
1045-
(ra/dec column flags must be set: see previous section to know how to assign those flags).
1046-
1047-
The following example uploads a table and then, the table is used in a cross match:
1048-
1049-
.. Skipping authentication requiring examples
1050-
.. doctest-skip::
1051-
1052-
>>> from astroquery.esa.euclid import Euclid
1053-
>>> Euclid.login()
1054-
>>> table = file or astropy.table
1055-
>>> Euclid.upload_table(upload_resource=table, table_name='my_sources')
1056-
>>> # the table will be uploaded into the user private space into the database
1057-
>>> # the table can be referenced as <database user schema>.<table_name>
1058-
>>> full_qualified_table_name = 'user_<your_login_name>.my_sources'
1059-
>>> xmatch_table_name = 'xmatch_table'
1060-
>>> Euclid.cross_match(full_qualified_table_name_a=full_qualified_table_name,
1061-
... full_qualified_table_name_b='Eucliddr3.Euclid_source',
1062-
... results_table_name=xmatch_table_name, radius=1.0)
1063-
1064-
1065-
Once you have your cross match finished, you can obtain the results:
1066-
1067-
.. Skipping authentication requiring examples
1068-
.. doctest-skip::
1069-
1070-
>>> from astroquery.esa.euclid import Euclid
1071-
>>> xmatch_table = 'user_<your_login_name>.' + xmatch_table_name
1072-
>>> query = (f"SELECT c.separation*3600 AS separation_arcsec, a.*, b.* FROM Eucliddr3.Euclid_source AS a, "
1073-
... f"{full_qualified_table_name} AS b, {xmatch_table} AS c WHERE c.Euclid_source_source_id = a.source_id AND "
1074-
... f"c.my_sources_my_sources_oid = b.my_sources_oid")
1075-
>>> job = Euclid.launch_job(query=query)
1076-
>>> results = job.get_results()
1077-
1078-
Cross-matching catalogues is one of the most popular operations executed in the Euclid archive.
1079-
1080-
2.9. Tables sharing
1031+
2.8. Tables sharing
10811032
^^^^^^^^^^^^^^^^^^^
10821033

10831034
It is possible to share tables with other users. You have to create a group, populate that
10841035
group with users, and share your table to that group. Then, any user belonging to that group
10851036
will be able to access your shared table in a query.
10861037

1087-
2.9.1. Creating a group
1038+
2.8.1. Creating a group
10881039
^^^^^^^^^^^^^^^^^^^^^^^
10891040

10901041
.. Skipping authentication requiring examples
@@ -1094,7 +1045,7 @@ will be able to access your shared table in a query.
10941045
>>> Euclid.login()
10951046
>>> Euclid.share_group_create(group_name="my_group", description="description")
10961047

1097-
2.9.2. Removing a group
1048+
2.8.2. Removing a group
10981049
^^^^^^^^^^^^^^^^^^^^^^^
10991050

11001051
.. Skipping authentication requiring examples
@@ -1104,7 +1055,7 @@ will be able to access your shared table in a query.
11041055
>>> Euclid.login()
11051056
>>> Euclid.share_group_delete(group_name="my_group")
11061057

1107-
2.9.3. Listing groups
1058+
2.8.3. Listing groups
11081059
^^^^^^^^^^^^^^^^^^^^^
11091060

11101061
.. Skipping authentication requiring examples
@@ -1116,7 +1067,7 @@ will be able to access your shared table in a query.
11161067
>>> for group in groups:
11171068
... print(group.title)
11181069

1119-
2.9.4. Adding users to a group
1070+
2.8.4. Adding users to a group
11201071
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11211072

11221073
.. Skipping authentication requiring examples
@@ -1126,7 +1077,7 @@ will be able to access your shared table in a query.
11261077
>>> Euclid.login()
11271078
>>> Euclid.share_group_add_user(group_name="my_group",user_id="<user_login_name")
11281079

1129-
2.9.5. Removing users from a group
1080+
2.8.5. Removing users from a group
11301081
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11311082

11321083
.. Skipping authentication requiring examples
@@ -1136,7 +1087,7 @@ will be able to access your shared table in a query.
11361087
>>> Euclid.login()
11371088
>>> Euclid.share_group_delete_user(group_name="my_group",user_id="<user_login_name>")
11381089

1139-
2.9.6. Sharing a table to a group
1090+
2.8.6. Sharing a table to a group
11401091
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11411092

11421093
.. Skipping authentication requiring examples
@@ -1148,7 +1099,7 @@ will be able to access your shared table in a query.
11481099
... table_name="user_<user_login_name>.my_table",
11491100
... description="description")
11501101

1151-
2.9.7. Stop sharing a table
1102+
2.8.7. Stop sharing a table
11521103
^^^^^^^^^^^^^^^^^^^^^^^^^^^
11531104

11541105
.. Skipping authentication requiring examples

0 commit comments

Comments
 (0)