Универсальный пакет для синтеза изображений srhimages
Программа srhimages
предоставляет функции для синтеза радиоизображений из данных Сибирского Радиогелиографа (SRH).
Установка
Код Сергея Анфиногентова работает на python 3.10 до 3.12, код Марии Глобы - только на 3.10! Поэтому желательно устанавливать именно 3.10. Для расчётов на удалённых машинах может быть допустимо установить любую версию питона. При расчётах через Dask желательно так же использовать 3.10.
conda env create -n srhsynth python=3.10
conda activate srhsynth
pip install -U "srhimages[all] @ git+https://git.iszf.irk.ru/fedenev/srhimages"
# или [globa], [anfinogentov] вместо [all], чтобы выбрать только конкретный расчётный код
Если производится свежая установка с использованием расчётного кода Марии Глобы, то требуется обновить данные CASA:
python3 -m casaconfig --update-all
Использование уже установленного окружения на сервере ИСЗФ
conda activate /opt/miniconda3/envs/srhsynth/
Интерфейс командной строки
srhimages create_synth_tasks --help
srhimages run_computation --help
Использование в своих скриптах
import srhimages
help(srhimages.create_synth_tasks)
help(srhimages.run_computation)
Запуск интерфейса в браузере
srhimages-standalone
Описание команд и принципы работы
Расчётные задачи
Программа работает в парадигме так называемых расчётных задач ("tasks"). Каждая из задач представляет собой Python-словарь или его JSON-представление и описывает, из каких данных (сырых файлов и сканов внутри них) должно получиться итоговое изображение, куда оно будет сохранено и с какими параметрами синтезировано.
Актуальная спецификация формата расчётной задачи есть в исходном коде в формате jsonschema
. Спецификация API для работы с амплитудно-фазовыми калибровками антенн находится в репозитории badary-services.
Интерфейс программы:
-
server_calibrate(task_list, algorithm, save_to=None, search_window="15min")
-
Назначение: Обрабатывает список некалиброванных задач, чтобы назначить им калибровки, предоставленные командой SRH и находящиеся на API-сервере.
-
Аргументы:
-
task_list
: Список задач для вычисления или путь к файлу JSON с списком задач. -
algorithm
: "globa" или "anfinogentov". -
save_to
(необязательно): Путь к файлу JSON для сохранения списка задач. -
search_window
(необязательно): Временное окно (-search_window/2, +search_window/2), в котором серверная калибровка считается допустимой для использования. По умолчанию: "15min".
-
-
Возвращает:
-
calibrated_tasks
: Список задач с доступным объектом ["gains"] в каждой из них, если соответствующие серверные калибровки были найдены, в противном случае – задачи, которые были переданы изначально.
-
-
-
create_synth_tasks(time1, time2=None, cadence="15min", frequencies="all", resample_from=None, save_to=None, average_width=20, average_unit="scans", average_position="after", average_mode = "visibilities", output_polarizations="IV", naxis=512, cdelt=4.9, clean_disk=True, compressed=True, smooth_gains=False)
-
Назначение: Создает список (некалиброванных) задач по синтезу радиоизображений с телескопа.
-
Аргументы:
- time1 (str): Время начала наблюдения в формате 'ГГГГ-ММ-ДД ЧЧ:ММ:СС'.
- time2 (str или None, опционально): Время окончания в том же формате.
- cadence (str, опционально): Временной интервал между каждым наблюдением в формате "NNmin" или "NNs". По умолчанию "15min".
- frequencies (list(int) или str, опционально): Список частот для наблюдения в МГц или "all" в виде строки, или диапазон вида "3000-5000", или список вида [3000, "6000-8000", "SRH1224"].
- resample_from (list или str): Список задач или путь к файлу, содержащему список задач в формате JSON, откуда брать калибровки. Доступные частоты в списке resample должны совпадать с запрошенными пользователем частотами.
- save_to (str, опционально): Путь к json файлу для сохранения списка задач.
- average_width (int или float, опционально): Количество сканов или секунд для усреднения. По умолчанию 20.
- average_unit (str, опционально): Может быть 'scans' или 'seconds'. По умолчанию 'scans'.
- average_position (str, опционально): Временное окно для усреднения. Может быть 'after', 'before' или 'center'. По умолчанию 'after'.
- average_mode (str, опционально): Режим усреднения. Может быть 'visibilities', 'gridding' или 'images'. По умолчанию 'visibilities'.
- output_polarizations (str, опционально): Может быть 'IV' или 'RL'.
- naxis (int, опционально): Количество пикселей вдоль каждой оси выходного изображения. По умолчанию 512.
- cdelt (float, опционально): Размер каждого пикселя в угловых секундах. По умолчанию 4.9 для СРГ.
- clean_disk (bool, опционально): Флаг для включения/выключения очистки "грязного" изображения. По умолчанию True.
- compressed (bool, опционально): Флаг для включения/выключения сжатия FITS выходного изображения. По умолчанию True.
- smooth_gains (bool, опционально): Предпочтение сплайн-интерполяции калибровок вместо ближайших соседей при передискретизации. Используйте True для калибровок за весь день.
-
Возвращает:
- Список задач синтеза (каждая задача – Python dict), например, для отправки на кластер или для локального вычисления.
-
-
run_computation(task_list, algorithm, cache_dir="./images/raw/", out_dir="./images/out/", ftp_server="ftp.rao.istp.ac.ru", n_threads=5, calibrate="prefer_server", calibrated_save_to=None, calibrations_search_window="15min", skip_clean=False, input_dir = None, cluster_object="local")
-
Назначение:task_listСинтезирует изображения из переданного списка задач(не важно, калиброванногоlist илинет). Аргументы:
в формате JSON.
str): Список задач для вычисления или путь к файлуtask_listJSON, содержащему списокомзадач.-
algorithm
(str): "globa"orили "anfinogentov". -
cache_dir
(необязательно)str): Директория для хранения загруженных сырыхFITS-файловс видностями SRH, которые будут загружаться с сервераСРГ. -
out_dir
(необязательно)str): Директория для сохранения синтезированных изображений. -
HTTPS (начинается со схемы https://).ftp_server
(необязательно)str): АдресFTPсервера для загрузки файлов. По умолчаниюбез схемы,загрузка осуществляется с использованиемHTTPS. -
n_threads
(необязательно)int): Количество потоков для вычислений (по умолчанию:5). -
calibrate
(str): "prefer_server" или "from_scratch".(прПо умолчанинудительнаяюлокальная калибровка)"prefer_server". -
По умолчанию None.
progress_save_to (str, опционcalibrated_save_toеобязательно): Путь к json файлуJSONдля сохранения результирующего списка задач (на отснове исходного спискалиброванныхзадач). -
calibrations_search_window
(str, опционеобязательно): Временное окно (-search_window/2, +search_window/2), в которомсервернаякалибровка с сервера считается допуействимтельнойдля использования. По умолчанию: "15min". -
skip_postprocessing (bool, опционально): Пропустить выравнивание и сглаживание амплитуды/фазы усилений для антенн СРГ. По умолчанию False, True не рекоskip_cleanбмендуетсяз. -
skip_images (bool, опциона
тельно): Только откалибровать (извыполнить постображенботку) задачияи не выполнять этап CLEAN и синтезаизображений. По умолчанию: False. -
input_dir
(str, опционеобязательно): Директория, содержащая входные файлы, в случае, если SRH NASSRHсмонтирован там. Обычно она равна None. -
cluster_object
(str или object): Тип кластерного объектакдля использовастерания для вычислений, 'local' для локальных вычислений (по умолчанию:'local') и 'badary' для кластера в Бадарах. Другие варианты включают передачу полюбьзоговательскипах объекта,овкоторыйDask.distributedпринимает метод .map,(например,объект Dask SSHCluster, и тSSHCluster).д.
-
Вrun_id (str, озвпционально): Префикс строки для Redis для хращнения прогрессает:results: Вызадачисленныерезультаты на основе(и списка задач) во время вычисления. По умолчанию None, что приведёт к случайной строке.
- results: Список задач с результатами вычислений, либо с ошибками.
- Если
task_list
–является строкаой или объектом pathlib.Path,список задачн будет загруженв формкатек JSONиз передфанного путийл. Этапы работы программы:- Загружает
исхнеодбработанные файлы с FTP сервера вкэш-директорию кэша. - Калибрует задачи, используя серверные калибровки или локально.
СинПостезирует изображенботка калия,бровокисвыпользуняетсялметокальныйдом,кластерили указработанныйм Сергеем Анфиногентовым.- Все ошиб
ъект кластера. Еслиобъектcluster_objectне 'local', он использует указанный объект кластера дляв вычислений.ях Вбудут случохраненыошибкив воя вычислений выводится стек трассировки и переданныем объекте или сохраненыспв результиска задач с парамующетром"error"файле
- Загружает
Возвращает:
Примечанияе:
Пример использования
import srhimages
time1, time2 = "2024-06-01 02:00:00", "2024-06-01 02:00:05"
frequencies = [2800, 3000]
task_list = srhimages.create_synth_tasks(time1, time2, cadence="3s", frequencies=frequencies, save_to="synth_1.json",
average_width=5, average_unit="seconds", average_mode = "visibilities", average_position="after",
output_polarizations = "IV", naxis=512, cdelt=4.9, clean_disk=True,
compressed=True)
results = srhimages.run_computation("./synth_1.json", "globa", calibrated_save_to="./synth_2.json")
# результаты появятся в каталоге ./images/out
Загрузка калибровок на сервер
from srhimages.calibrations import CalibrationsApi
import json
with open("synth_2.json", "r") as fp:
calibrated_tasks = json.load(fp)
cal_api = CalibrationsApi(password="...")
for task in calibrated_tasks:
cal_api.create(task["gains"])