gaia_access 0.1.4

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
68
69

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

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

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

/// <p>SkyMapper DR2 BestNeighbour table lists each matched Gaia object with its best neighbour in
/// the external catalogue.
/// The cross-match algorithm is not symmetric and searches Gaia sources counterparts in SkyMapper DR2.<br/>
/// The best neighbour is chosen among good neighbours as the one  with the highest value of
/// the figure of merit, which evaluates the ratio between two opposite models/hypotheses:
/// the counterpart candidate is a match or it is found by chance.
/// Good neighbours are nearby objects in the external catalogue whose position is
/// compatible within position errors with the Gaia target.<br/>
/// The cross-match algorithm is positional and exploits the full 5
/// parameters covariance matrix of Gaia astrometric solution when available and the
/// external catalogue positions and position errors. In addition it takes into account the
/// external catalogue environment using the local density.<br/>
/// <br/>
/// Please note that the cross-match algorithm is a trade-off between multiple requirements, in
/// particular between completeness and correctness. It is thus not limited to a simple cone search.<br/>
/// <br/>
/// Reference papers:<br/>
/// </p>
/// <p>DR1-DPACP-17<br/>
/// </p>
/// <p>DR2-DPACP-41<br/>
/// </p>
#[allow(non_camel_case_types)]
pub struct skymapperdr2_best_neighbour;

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

/// The columns in the skymapperdr2_best_neighbour table.
#[allow(non_camel_case_types)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, strum::Display)]
pub enum Col {
    /// Unique Gaia source identifier
    source_id,
    /// Original External Catalogue source identifier
    original_ext_source_id,
    /// Angular Distance between the two sources
    angular_distance,
    /// Number of neighbours in External Catalogue
    number_of_neighbours,
    /// Number of mates in Gaia Catalogue
    number_of_mates,
    /// Cross-match algorithm flag
    xm_flag,
}

impl Column for Col {}

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