gaia_access 0.2.0

Access the Gaia ESA Archive for astronomical data.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

// This code is generated by generate_code.py, do not modify it manually.

//! This module contains all the known columns in the dr2_neighbourhood table.

use crate::traits::{Column, Table};

/// Users wishing to look up the E/DR3 record for an astrophysical source
/// identified in DR2 must NOT simply extract the record from E/DR3 having
/// the same source identifier.
///
/// As described in the detailed description of attribute designation in
/// GaiaSource it is not guaranteed that the same astronomical source will
/// always have the same source identifier in different Data Releases. Hence
/// the only safe way to compare source records between different Data
/// Releases in general is to check the records of proximal source(s) in the
/// same small part of the sky. This table provides the means to do this via
/// a precomputed crossmatch of such sources, taking into account the proper
/// motions available at E/DR3.
///
/// Within the neighbourhood of a given E/DR3 source there may be none, one
/// or (rarely) several possible counterparts in DR2 indicated by rows in
/// this table. This occasional source confusion is an inevitable
/// consequence of the merging, splitting and deletion of identifiers
/// introduced in previous releases during the DR3 processing and results in
/// no guaranteed one–to–one correspondence in source identifiers between
/// the releases.
///
/// For more details of the procedure used to create this crossmatch, see
/// Chapter [chap:archive] in the online documentation.
#[allow(non_camel_case_types)]
pub struct dr2_neighbourhood;

impl Table for dr2_neighbourhood {
    fn string(&self) -> String {
        "dr2_neighbourhood".to_string()
    }
}

/// The columns in the dr2_neighbourhood table.
#[allow(non_camel_case_types)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, strum::Display)]
pub enum Col {
    /// Source identifier in Gaia DR2
    dr2_source_id,
    /// Source identifier in Gaia E/DR3
    dr3_source_id,
    /// Angular distance between the two sources
    angular_distance,
    /// G band magnitude difference between the sources
    magnitude_difference,
    /// Flag indicating whether E/DR3 coordinates were proper motion corrected
    proper_motion_propagation,
}

impl Column for Col {}

#[cfg(test)]
/// Collects all the known columns in the dr2_neighbourhood table.
pub fn collect_known(map: &mut std::collections::HashMap<String, Vec<String>>) {
    let mut col_strings = Vec::new();
    col_strings.push(Col::dr2_source_id.to_string());
    col_strings.push(Col::dr3_source_id.to_string());
    col_strings.push(Col::angular_distance.to_string());
    col_strings.push(Col::magnitude_difference.to_string());
    col_strings.push(Col::proper_motion_propagation.to_string());
    map.insert(dr2_neighbourhood.string(), col_strings);
}