Skip to content

sc-losrm

Introduction

Perform RM-Synthesis on the line-of-sight data generated by sc-los. As such, sc-los must be run first.

In addition to the per-LoS RM-synthesis data, this script also generates static diagnostic plots.

Outputs


├── scrap-outputs                   # Outputs from sc-los
|   ├── los-data 
│   ├── los-rm-data                 # LoS data outputs generated by sc-losrm
|   |   ├── reg_1.npz
|   |   ├── reg_2.npz
|   |   ├── ...
|   |   ├── reg_n.npz
│   ├── los-rm-data-plots           # LoS data static plots generated.
|   |   ├── reg_1.png
|   |   ├── reg_2.png
|   |   ├── ...
|   |   ├── reg_n.png

The help menu is available using the command:

sc-losrm -h

which results in the output below. However, as the tool is under active development, the help menu may change in the future and should be checked before use using the help command after installation.

usage: sc-losrm [-h] [-id DATA_DIRS [DATA_DIRS ...]] [-od OUTPUT_DIR] [-md MAX_FDEPTH] [--depth-step DEPTH_STEP] [-iters NITERS] [-np] [-nd] [-debug]

________________________________________________________________________________

 Description

 This script takes in I, Q and U data and does the process
 of RM-SYNthesis and RM-CLEAN. It gives these outputs.

 Pickle files containing:
 . 1. The dirty FDF (Faraday Dispersion Funtion / Faraday spectrum)
 . 2. The cleaned FDF
 . 3. Faraday depths used

 These are the keys:
 . depths
 . fdirty
 . fclean
 . rmtf

 Plots of:
 . 4. The dirty and clean FDF and position angle vs wavelength sq and its
 linear squares fit
 . 5. The DATAs RMSF

________________________________________________________________________________

options:
  -h, --help            show this help message and exit
  -id DATA_DIRS [DATA_DIRS ...], --input-dir DATA_DIRS [DATA_DIRS ...]
                        Directory containing the various LoS data files
  -od OUTPUT_DIR, --output-dir OUTPUT_DIR
                        Where to dump the output plots if available
  -md MAX_FDEPTH, --max-fdepth MAX_FDEPTH
                        Maximum Faraday depth. Default is 500
  --depth-step DEPTH_STEP
                        Faraday depth step. Default is 10
  -iters NITERS, --iters NITERS
                        Number of RM clean iterations. Default is 1000
  -np, --no-plot        plots for this data? Default is to plot
  -nd, --no-derotate    Use this switch to NOT derotate the RMTF by the mean lambda squared.
  -debug, --debug       Enable debug mode, will run in serial mode