psrutils 0.2.7

A crate with a few utilities to facilitate pulsar science projects in rust.
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

use super::PsruError;
use crate::parse_tools::parse_bool;
use crate::parse_tools::parse_f64;

/// Add a constant offset between specified TOAs.
#[derive(Debug)]
pub struct Jump {
    /// What flag was used to id the jump arguments.
    pub jtype: JumpType,

    /// The jump size.
    pub value: f64,

    /// Fitting status.
    pub fit: bool,
}

#[derive(Debug)]
pub enum JumpType {
    Mjd(f64, f64),
    Freq(f64, f64),
    Tel(String),
    Name(String),
    Flag(String, String),
}

impl Jump {
    /// This will parse a jump, which are written on one line. If anything is
    /// missing or malformed, an error is returned.
    pub(crate) fn parse(
        parts: &[&str],
        jumps: &mut Vec<Self>,
    ) -> Result<bool, PsruError> {
        if parts[0] != "JUMP" {
            return Ok(false);
        }

        let es = parts.join(" ");
        let error = || PsruError::IncompleteJump(es.clone());
        if parts.len() < 3 {
            return Err(error());
        }

        let mut parts = parts.iter();
        _ = parts.next();
        let selector = match *parts.next().unwrap() {
            "MJD" => JumpType::Mjd(
                parse_f64(parts.next().ok_or_else(error)?)?,
                parse_f64(parts.next().ok_or_else(error)?)?,
            ),
            "FREQ" => JumpType::Freq(
                parse_f64(parts.next().ok_or_else(error)?)?,
                parse_f64(parts.next().ok_or_else(error)?)?,
            ),
            "TEL" => {
                JumpType::Tel((*parts.next().ok_or_else(error)?).to_string())
            }
            "NAME" => {
                JumpType::Name((*parts.next().ok_or_else(error)?).to_string())
            }

            flag => JumpType::Flag(
                flag.to_string(),
                (*parts.next().ok_or_else(error)?).to_string(),
            ),
        };

        let jump = Self {
            jtype: selector,
            value: parse_f64(parts.next().ok_or_else(error)?)?,
            fit: parse_bool(parts.next().ok_or_else(error)?)?,
        };
        jumps.push(jump);

        Ok(true)
    }

    pub(crate) fn write(&self) -> String {
        let mut line = String::from("JUMP");
        match &self.jtype {
            JumpType::Mjd(v1, v2) => line += &format!("MJD {v1} {v2}"),
            JumpType::Freq(v1, v2) => line += &format!("FREQ {v1} {v2}"),
            JumpType::Tel(id) => line += &format!("TEL {id}"),
            JumpType::Name(name) => line += &format!("NAME {name}"),
            JumpType::Flag(f, v) => line += &format!("{f} {v}"),
        }

        line +=
            &format!(" {} {}", self.value, if self.fit { "1" } else { "0" });

        line
    }
}