aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/chandra_acis.py
blob: 6170b4085144af9b369d824e9e0855dd4cdd4596 (plain)
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
#!/usr/bin/env python3
#
# Copyright (c) 2017 Weitian LI <liweitianux@live.com>
# MIT license
#
# Weitian LI
# 2017-02-06

"""
Determine the Chandra ACIS type for the given observation.

TODO: move these methods to module `acis.py`
"""

import argparse
import subprocess
import re

from setup_pfiles import setup_pfiles


def get_acis_type(filepath):
    """
    Determine the Chandra ACIS type (``I`` or ``S``) according the
    active ACIS chips.

    Parameters
    ----------
    filepath : str
        Path to the input FITS file

    Returns
    -------
    acis_type : str
        ``I`` if ACIS-I, ``S`` if ACIS-S, otherwise, ``ValueError`` raised.
    """
    subprocess.check_call(["punlearn", "dmkeypar"])
    detnam = subprocess.check_output([
        "dmkeypar", "infile=%s" % filepath, "keyword=DETNAM", "echo=yes"
    ]).decode("utf-8").strip()
    if re.match(r"^ACIS-0123", detnam):
        return "I"
    elif re.match(r"^ACIS-[0-6]*7", detnam):
        return "S"
    else:
        raise ValueError("unknown chip combination: %s" % detnam)


def get_chips(filepath, sep=":"):
    """
    Get the corresponding chips of interest according to the active ACIS type.

    Parameters
    ----------
    filepath : str
        Path to the input FITS file
    sep : str, optional
        Separator to join the chip ranges, e.g., 0:3, 0-3

    Returns
    -------
    chips : str
        ``0:3`` if ACIS-I, ``7`` if ACIS-S, otherwise, ``ValueError`` raised.
    """
    acis_type = get_acis_type(filepath)
    if acis_type == "I":
        return sep.join(["0", "3"])
    elif acis_type == "S":
        return "7"
    else:
        raise ValueError("unknown ACIS type")


def main():
    parser = argparse.ArgumentParser(description="Determine Chandra ACIS type")
    parser.add_argument("-b", "--brief", dest="brief",
                        action="store_true", help="Be brief")
    parser.add_argument("infile", help="Input FITS file")
    args = parser.parse_args()

    setup_pfiles(["dmkeypar"])
    acis_type = get_acis_type(args.infile)
    if not args.brief:
        print("ACIS-type:", end=" ")
    print(acis_type)


if __name__ == "__main__":
    main()