Yael-II/Astrobs-Tools
1
0
Fork 0
mirror of https://codeberg.org/Yael-II/Astrobs-Tools.git synced 2026-03-15 03:16:27 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
d985b82d22274d670819377f75108d1074ad83d0
Astrobs-Tools/Source/astrobs_v1_toolbox.py
Yael-II d985b82d22 added manual input
2024-11-28 23:29:53 +01:00

818 lines
28 KiB
Python
Raw Blame History

"""
* Astrobs Toolbox
* Version 1 - 2024-09-21
@ Yaël Moussouni
@ Observatory of Strasbourg
"""
import numpy as np
import astropy.time as time
import astropy.coordinates as coord
import astropy.units as u
from astropy.table import Table
from astroquery.simbad import Simbad
SPECIAL = ["CALIBRATION", "IGNORE"]
YES = ["YES", "Y", "1"]
ALL = ["ALL", "*"]
DONE = ["DONE", "OK"]
QUIT = ["QUIT", "EXIT", "Q"]
CANCEL = ["CANCEL", "BACK", "UNDO"]
WRITE = ["WRITE", "SAVE"]
READ = ["READ", "OPEN"]
CALIB = ["CALIB", "CALIBRATION"]
SIMBAD = ["SIMBAD", "OBJECT"]
REGION = ["SEARCH", "REGION"]
MANUAL = ["MANUAL", "ADD"]
ST = ["SIDEREAL", "ST"]
SEQ = ["SEQUENCE", "SEQ"]
CHECK = ["CHECK"]
HELP = ["HELP", "H", "?"]
OUT_DIR = "./Output/"
DEFAULT_CONFIG = """# Default config
LOCATION: None
LAT: 0d00m00s
LON: 0d00m00s
SUN_SET: 1970-01-01 12:00:00.000
SUN_SET_CIVIL: 1970-01-01 12:00:00.000
SUN_SET_NAUTICAL: 1970-01-01 12:00:00.000
SUN_SET_ASTRONOMICAL: 1970-01-01 12:00:00.000
SUN_RISE_ASTRONOMICAL: 1970-01-01 12:00:00.000
SUN_RISE_NAUTICAL: 1970-01-01 12:00:00.000
SUN_RISE_CIVIL: 1970-01-01 12:00:00.000
SUN_RISE: 1970-01-01 12:00:00.000
OBS_BEGIN: 1970-01-01 12:00:00.000
OBS_END: 1970-01-01 12:00:00.000
ST_BEGIN: 12h00m0s
ST_END: 12h00m00s
WINDOW_EAST: 0h00m00s
WINDOW_WEST: 23h59m59s
WINDOW_UPPER: 90d00m00s
WINDOW_LOWER: -90d00m00s
"""
COLS = ["seq",
"name",
"main_id",
"ra",
"dec",
"n_exp",
"t_exp",
"st_begin",
"st_end",
"notes"]
UNITS = ["", # SEQ
"", # NAME
"", # MAIN_ID
"h", # RA
"deg", # DEC
"", # N_EXP
"s", # T_EXP
"h", # ST_BEGIN
"deg", # ST_END
""]
TYPES = [np.int_, # SEQ
np.str_("<U64"), # NAME
np.str_("<U64"), # MAIN_ID
coord.angles.core.Angle, # RA
coord.angles.core.Angle, # DEC
np.int_, # N_EXP
u.quantity.Quantity, # T_EXP
coord.angles.core.Angle, # ST_BEGIN
coord.angles.core.Angle, # ST_END
np.str_("<U512")]
def check_window(table: Table,
config: dict,
i: np.int_ = None) -> np.bool_:
"""
This function returns False if any target is outside the observation
window.
@params:
- table: the table of targets to check
- config: the configuration dictionary
- i: if not None, check only the index i of the table
@returns:
- True if all targets are in the observation window
- False if at least one target is outside the observation window.
"""
def check_operation_(line, config):
"""Repeated operation to check all the elements of the table."""
if line["main_id"] in SPECIAL:
return True
if line["ra"] == "":
return True
if line["dec"] == "":
return True
ra = coord.Angle(line["ra"])
dec = coord.Angle(line["dec"])
east = coord.Angle(config["WINDOW_EAST"])
west = coord.Angle(config["WINDOW_WEST"])
upper = coord.Angle(config["WINDOW_UPPER"])
lower = coord.Angle(config["WINDOW_LOWER"])
if east <= west:
if ra < east or ra > west:
print("\033[93m"
+("Warning: The target {} "
"is outside the observation window.").format(
line["name"])
+"\033[0m")
return False
else:
if ra < east and ra > west:
print("\033[93m"
+("Warning: The target {} "
"is outside the observation window.").format(
line["name"])
+"\033[0m")
return False
if dec < lower or dec > upper:
print("\033[93m"
+("Warning: The target {} "
"is outside the observation window.").format(
line["name"])
+"\033[0m")
return False
return True
if i == None:
output = True
for i in range(len(table)):
val = check_operation_(table[i], config)
if val == False:
output = False
return output
else:
return check_operation_(table[i], config)
def create_table(cols: list = COLS,
units: list = UNITS,
types: list = TYPES) -> Table:
"""
This function creates the target table.
@params:
- cals: list of columns
- units: list of units
- type: lust of types
@returns:
- a Table object
"""
return Table(names=cols, dtype=types, units=units)
def select_obj(table: Table,
line: Table,
config: dict) -> Table:
"""
This function interacts with the user to select targets from one table
and append them in another table.
@params:
- table: the target table to modify
- line: a table of targets to choose from
- config: the configuration dictionary
@returns:
- table: the modified table
"""
table_old = table.copy()
for i in range(len(line)):
while line[i]["name"] in line[:i]["name"]:
line[i]["name"] = "*"+line[i]["name"]
line.pprint_all()
answer = "$"
print("\033[32m"
+ ("Select the name of the objects "
"you want to observe (column \"NAME\"):"
"\n(available commands: [name], all, cancel, done)")
+ "\033[0m")
while answer.upper() not in DONE + [""]:
answer = input("\033[32m"
+ "> "
+ "\033[0m")
print("\033[A"
+ "\033[32m"
+ "> "
+ "\033[0m"
+ "\033[C"*len(answer),
end="")
if answer.upper() in DONE + [""]:
print("\033[34m"
+ " - ok"
+ "\033[0m")
elif answer.upper() in CANCEL or answer.upper() in QUIT:
i = 0
while i < len(table):
if table[i]["name"] not in table_old["name"]:
table.remove_row(i)
print("remove {}".format(i))
else: i+= 1
print("")
print("\033[34m"
+ "Operation canceled"
+ "\033[0m")
return table
elif answer in HELP:
print("")
print_help()
elif answer in ALL:
for i in range(len(line)):
name = line[i]["name"]
while name in table["name"]:
name = "*" + name
table.add_row(line[i])
table[-1]["name"] = name
print("\033[34m"
+ " - ok"
+ "\033[0m")
elif answer in line["name"]:
i = np.argwhere(line["name"] == answer)[0][0]
name = line[i]["name"]
while name in table["name"]:
name = "*" + name
table.add_row(line[i])
table[-1]["name"] = name
print("\033[34m"
+ " - ok"
+ "\033[0m")
else:
print("\033[34m"
+ " - not found"
+ "\033[0m")
return table
def add_manual(table: Table,
config: dict,
seq: np.int_ = 0,
name: np.str_ = "",
main_id: np.str_ = "",
ra: coord.angles.core.Angle = None,
dec: coord.angles.core.Angle = None,
n_exp: np.int_ = 0,
t_exp: u.quantity.Quantity = 0*u.s,
obj_begin: coord.angles.core.Angle = None,
obj_end: coord.angles.core.Angle = None,
notes: np.str_ = "") -> Table:
"""
This function allows the user to add manually an entry to the table.
@params
- table: the target table
- config: the configuration dictionary:
- *params: all the parameters of the target to add
@returns
- table: the modified table
"""
while name in table["name"]: name = "*" + name
while seq > 0 and seq in table["seq"]: seq += 1
ra_str = ""
dec_str = ""
obj_begin_str = ""
obj_end_str = ""
if type(ra) == coord.angles.core.Angle:
ra_str = ra.to_string(unit=u.hour)
elif type(ra) == str:
ra_str = ra
if type(dec) == coord.angles.core.Angle:
dec_str = dec.to_string(unit=u.degree)
elif type(dec) == str:
dec_str = dec
if type(obj_begin) == coord.angles.core.Angle:
obj_begin_str = obj_begin.to_string()
elif type(obj_begin) == str:
obj_begin_str = obj_begin
if type(obj_end) == coord.angles.core.Angle:
obj_end_str = obj_end.to_string()
elif type(obj_end) == str:
obj_end_str = obj_end
table.add_row([seq,
name,
main_id,
ra_str,
dec_str,
n_exp,
t_exp.to_value(u.s),
obj_begin_str,
obj_end_str,
notes])
check_window(table, config, -1)
return table
def add_calib(table: Table,
config: dict = None,
seq: np.int_ = 0,
name: np.str_ = "CALIB",
n_exp: np.int_ = 0,
t_exp: u.quantity.Quantity = 0*u.s,
notes: np.str_ = "") -> Table:
"""
Add a calibration line to the table.
@params
- table: the target table
- config: the configuration dictionary:
- *params: all the parameters of the calibration to add
@returns
- table: the modified table
"""
while name in table["name"]:
name = "*" + name
while seq > 0 and seq in table["seq"]:
seq += 1
table.add_row([seq,
name,
"CALIBRATION",
"",
"",
n_exp,
t_exp.to_value(u.s),
"",
"",
notes])
check_window(table, config, -1)
return table
def add_simbad(table: Table,
obj: Table,
config: dict,
seq: np.int_ = 0,
name: np.str_ = "",
n_exp: np.int_ = 0,
t_exp: u.quantity.Quantity = 0*u.s,
obj_begin: coord.angles.core.Angle = None,
obj_end: coord.angles.core.Angle = None,
notes: np.str_ = "") -> Table:
"""
Add a target imported from Simbad using astroquery.Simbad:
@params
- table: the target table
- obj: the table of objects from astroquery.Simbad
- config: the configuration dictionary:
- *params: all the parameters of the target to add
@returns
- table: the modified table
"""
for i in range(len(obj)):
try:
main_id = obj["main_id"][i]
except KeyError:
main_id = obj["MAIN_ID"][i]
if name == "":
name = main_id
while name in table["name"]:
name = "*" + name
while seq > 0 and seq in table["seq"]:
seq += 1
try:
ra = coord.Angle(obj["ra"][i], unit=u.degree)
dec = coord.Angle(obj["dec"][i], unit=u.degree)
except KeyError:
ra = coord.Angle(obj["RA"][i], unit=u.degree)
dec = coord.Angle(obj["DEC"][i], unit=u.degree)
ra_str = ra.to_string(unit=u.hour)
dec_str = dec.to_string(unit=u.degree)
obj_begin_str = ""
obj_end_str = ""
if type(obj_begin) == coord.angles.core.Angle:
obj_begin_str = obj_begin.to_string()
elif type(obj_begin) == str:
obj_begin_str = obj_begin
if type(obj_end) == coord.angles.core.Angle:
obj_end_str = obj_end.to_string()
elif type(obj_end) == str:
obj_end_str = obj_end
table.add_row([seq,
name,
main_id,
ra_str,
dec_str,
n_exp,
t_exp.to_value(u.s),
obj_begin_str,
obj_end_str,
notes])
name = ""
check_window(table, config)
return table
def read_cfg(filename:str,
directory:str = OUT_DIR,
extension:str = ".cfg") -> dict:
"""
Read the configuration file
@params:
- filename: the configuration file name (without extension)
- directory: the directory in which the configuration file is located
- extension: the extension of the configuration file
@returns:
- config: the configuration dictionary
"""
if directory[-1] != "/": directory += "/"
if extension[0] != ".": extension = "." + extension
try:
with open(directory+filename+extension, "r") as file:
params_index = []
params_value = []
for line in file.readlines():
if len(line) > 0:
if line[0] != "#":
params = line.strip().split(": ")
params_index.append(params[0])
params_value.append(params[1])
config = {params_index[i]:params_value[i]
for i in range(len(params_index))}
except:
print("\033[93m"
+ "Warning: No configuration file, using default."
+ "\033[0m")
if True:
file = DEFAULT_CONFIG # file is a string
params_index = []
params_value = []
for line in file.split("\n"):
if len(line) > 0:
if line[0] != "#":
params = line.strip().split(": ")
params_index.append(params[0])
params_value.append(params[1])
config = {params_index[i]:params_value[i]
for i in range(len(params_index))}
return config
def set_st_window(table: Table,
config: dict):
"""
This function computes the sidereal time window of observation for all
targets in the table, assuming an observation around the meridian.
@params:
- table: the target table
- config: the configuration dictionary
@return:
- table: the updated table
"""
before = coord.Angle(config["ST_BEGIN"]) \
- coord.Angle(config["WINDOW_EAST"])
after = coord.Angle(config["WINDOW_WEST"]) \
- coord.Angle(config["ST_END"])
for i in range(len(table)):
if not table[i]["main_id"] in SPECIAL:
table[i]["st_begin"] = (coord.Angle(table[i]["ra"]) \
- before).wrap_at(24*u.h).to_string()
table[i]["st_end"] = (coord.Angle(table[i]["ra"]) \
+ after).wrap_at(24*u.h).to_string()
else:
continue
return table
def set_seq(table: str,
config: dict,
stack: bool = False):
"""
Sets the sequence number of all targets in the table, if the sequence
number has a duplicate or is zero, excluding special id (calib, ...), and
targets with no coordinates.
@params:
- table: the target table
- config: the configuration dictionary
- stack: if True, the first target is indexed with 1 (the last target is indexed with -1, if necessary)
@returns:
- table: the updated table
"""
window_east = coord.Angle(config["WINDOW_EAST"]).degree
window_west = coord.Angle(config["WINDOW_WEST"]).degree
dupl_seq = np.argwhere(
np.unique(table["seq"], return_counts=True)[1] > 1).flatten()
index_dupl = np.argwhere(np.any(
[table["seq"] == dupl_seq[i]
for i in range(len(dupl_seq))], axis=0)).flatten()
index_zero = np.argwhere(
table["seq"] == 0).flatten()
index_special = np.argwhere(np.any(
[table["main_id"] == SPECIAL[i]
for i in range(len(SPECIAL))], axis=0)).flatten()
index_nora = np.argwhere(table["ra"] == "").flatten()
index_yes = np.union1d(index_dupl, index_zero)
index_no = np.union1d(index_special, index_nora)
index = np.setdiff1d(index_yes, index_no)
order_table = table[index]
table["seq"][index] = np.full(len(index), 0)
order_table.add_columns(
[coord.Angle(order_table["ra"]).degree],
names=["RA_DEG"])
if window_east <= window_west:
order_table.sort("RA_DEG")
else :
w1 = np.argwhere(
order_table["RA_DEG"] > (window_east + window_west)/2)
w2 = np.argwhere(
order_table["RA_DEG"] <= (window_east + window_west)/2)
order = np.zeros(len(order_table))
order[w1] = 1
order[w2] = 2
order_table.add_columns(
[order],
names=["ORDER"])
order_table.sort("RA_DEG")
order_table.sort("ORDER")
i = 0
seq = 0
while i < len(order_table):
while seq in table["seq"]:
seq += 1
order_table["seq"][i] = seq
i += 1
seq += 1
table[index] = order_table
table.sort("seq")
while table[0]["seq"] < 0:
table.add_row(table[0])
table.remove_row(0)
if stack:
i = 0
while table[i]["seq"] >= 0:
table[i]["seq"] = i + 1
i += 1
i = -1
while table[i]["seq"] < 0:
table[i]["seq"] = i
i -= 1
return table
def swap(table: Table,
name_1: str,
name_2: str) -> Table:
"""
This function swaps to lines in the table
@params:
- table: the table of targets
- name_1: the name of the first target to swap
- name_2: the name of the second target to swap
@returns:
- table: the updated table
"""
if name_1 not in table["name"] or name_2 not in table["name"]:
print("\033[93m"
+"Warning: {} or {} cannot be found in the table.".format(
name_1,
name_2)
+"\033[0m")
return table
i = 0
seq_1 = 0
seq_2 = 0
while table[i]["name"] not in [name_1, name_2]:
i += 1
seq_1 = table[i]["seq"]
table.add_row(table[i])
j = i + 1
while table[j]["name"] not in [name_1, name_2]:
j += 1
seq_2 = table[j]["seq"]
table[i] = table[j]
table[j] = table[-1]
table[i]["seq"] = seq_1
table[j]["seq"] = seq_2
table.remove_row(-1)
return table
def write_table(table: Table,
config: dict,
filename=None,
extension=".xml",
format_="votable",
directory=OUT_DIR):
"""
Writes the table in a file.
@params:
- table: the table of targets
- config: the configuration dictionary
- filename: the name of the file (if None, YYYY-MM-DD_Location)
- extension: the file extension (default: .xml)
- format_: the format of the file (default: votable)
- directory: the output directory
@returns:
- 0 if the code exited with no issues
"""
data = table.copy()
if directory[-1] != "/": directory += "/"
if extension[0] != ".": extension = "." + extension
if filename == None:
filename = "{}_{}".format(config["OBS_BEGIN"][:10],
config["LOCATION"])
try:
data.write(directory + filename + extension,
format=format_,
overwrite=True)
print("\033[34m"
+ "File saved in the {} directory ".format(directory)
+ "with the name {}".format(filename+extension)
+ "\033[0m")
return 0
except Exception as e:
print("\033[91m"
+ ("Error! File cannot be saved "
"in the {} directory").format(directory)
+ "\033[0m")
return 1
def read_table(filename: str,
table: Table,
config: dict,
extension=".xml",
format_="votable",
directory=OUT_DIR):
"""
Read a table previously stored in a file.
@params:
- filename: the name of the file
- table: the (empty) table in which the file is loaded
- config: the configuration dictionary
- extension: the file extension (default: .xml)
- format_: the format of the file (default: votable)
- directory: the output directory
@returns:
- table: the table with the file loaded
"""
if directory[-1] != "/": directory += "/"
if extension[0] != ".": extension = "." + extension
if filename == None:
filename = "{}_{}".format(config["OBS_BEGIN"][:10],
config["LOCATION"])
try:
data = Table.read(directory + filename + extension,
format=format_)
for i in range(len(data)):
line = data[i]
if "name" in line.columns: name = line["name"]
else: name = "{}_{}".format(filename, i)
if "main_id" in line.columns: main_id = line["main_id"]
else: main_id = name
if "ra" in line.columns:
if "h" not in str(line["ra"]):
ra = coord.Angle("{}d".format(line["ra"])).to_string(unit=u.hour)
else: ra = line["ra"]
else: ra = ""
if "dec" in line.columns:
if "d" not in str(line["dec"]):
dec = coord.Angle("{}d".format(line["dec"])).to_string(unit=u.degree)
else: dec = line["dec"]
else: dec = ""
if "n_exp" in line.columns: n_exp = line["n_exp"]
else: n_exp = 0
if "t_exp" in line.columns: t_exp = line["t_exp"]
else: t_exp = 0.
if "st_begin" in line.columns: st_begin = line["st_begin"]
else: st_begin = ""
if "st_end" in line.columns: st_end = line["st_end"]
else: st_end = ""
if "notes" in line.columns: notes = line["notes"]
else: notes = ""
while name in table["name"]:
name = "*" + name
for col in line.columns:
if col not in COLS:
notes += " & {}: {}".format(col, line[col])
table.add_row({"seq": 0,
"name": name,
"main_id": main_id,
"ra": ra,
"dec": dec,
"n_exp": n_exp,
"t_exp": t_exp,
"st_begin": st_begin,
"st_end": st_end,
"notes": notes})
except Exception as e:
print("\033[91m"
+ ("Error! File cannot be loaded "
"from the {} directory").format(directory)
+ "\033[0m")
return create_table()
return table
def print_help():
hilfe = ("\033[36m"
"Help will be always given to those who ask for it [1].\n"
"Available commands (not case sensitive):\n"
"\t- help, h, ?: show this page\n"
"\t- quit, exit, q: quit the current code "
"(WARNING: this does not save the current state!)\n"
"\t- write, save: write the current table in a file "
"(no options available yet)\n"
"\t- read [filename], open [filename]: "
"loads the file \"filename\" "
"in the current table (no additional options available yet)\n"
"\t- calibration, calib: adds a calibration in the target list\n"
"\t- simbad [object name], object [object name]: "
"add an object from simbad\n"
"\t- search [ra] [dec] [radius], region [ra] [dec] [radius]: "
"search a region centred on the ra/dec coordinates, "
"with a given radius (coordinates should be expressed as "
"12h30m30s, 90d30m30s or 90.555d)\n"
"\t- manual [name] [seq (optional)], "
"add [name] [seq (optional)]: "
"manually add a target (only the name the sequence are "
"available for now)\n"
"\t- sidereal, st: computes the sidereal time for each target\n"
"\t- sequence, seq: computes the sequence order for each "
"target\n"
"\t- check: check if all targets are in the observation field\n"
"\n"
"General actions: \n"
"\t- cancel, back: cancels the current action\n"
"\t- yes, y, 1: yes\n"
"\t- no, n, 0, or anything else: no\n"
"\t- all, *: select all\n"
"\t- done, ok: confirm, save the current state and quit\n"
"\n"
"[1] Pr. Dumbledore, Albus Percival Wulfric Brian, 1992, Hogwarts School of Witchcraft and Wizardry"
"\033[0m")
print(hilfe)
return None
def resolve_input(text: str,
table: Table,
config: dict):
"""
Resolve the input to execute the expected function in an
interactive way
@params:
- text: the input string entered by the user
- table: the table of targets
- config: the configuration dictionary
@returns:
- table: the updated table
"""
swap_table = create_table()
args = text.split(" ")
try:
if args[0].upper() in DONE + ["", " "]:
None
elif args[0].upper() in WRITE: # TODO ajouter args
write_table(table, config)
elif args[0].upper() in READ: # TODO ajouter args
read_table(args[1], swap_table, config)
select_obj(table, swap_table, config)
elif args[0].upper() in SIMBAD:
name = " ".join(args[1:])
obj = Simbad.query_object(name)
swap_table = add_simbad(swap_table, obj, config, name=name)
select_obj(table, swap_table, config)
elif args[0].upper() in REGION:
name = " ".join(args[1]+" "+args[2])
region = coord.SkyCoord(ra=args[1], dec=args[2])
radius = coord.Angle(args[3])
obj = Simbad.query_region(region, radius)
swap_table = add_simbad(swap_table, obj, config)
select_obj(table, swap_table, config)
elif args[0].upper() in MANUAL: # TODO ajouter args
if "-s" in args:
name = args[1]
i = 2
while args[i] != "-s":
name += (" " + args[i])
i+=1
seq = int(args[i+1])
else:
name = " ".join(args[1:])
seq = 0
add_manual(table, config, seq, name)
elif args[0].upper() in CALIB: # TODO ajouter args
add_calib(table, config)
elif args[0].upper() in ST:
set_st_window(table, config)
elif args[0].upper() in SEQ: # FIXME marche bien une fois mais pas deux ??
set_seq(table, config)
elif args[0].upper() in CHECK:
check_window(table, config)
elif args[0].upper() in HELP:
print_help()
elif args[0].upper() in QUIT:
None
else:
print("\033[93m"
+ ("Warning: {} is not recognized "
"as a valid keyword.").format(args[0])
+ "\033[0m")
except Exception as e:
print("\033[91m"
+ "Error: Your operation is not recognized".format(args[0])
+ "\033[0m")
print(e)
return table
Reference in New Issue View Git Blame Copy Permalink