Application reference#
apx_log2apx#
Welcome to astropix-analysis 0.0.1+g266a123
Copyright (C) 2025, the astropix team.
astropix-analysis comes with ABSOLUTELY NO WARRANTY.
This is free software, and you are welcome to redistribute it under certain
conditions. See the LICENSE file for details.
Visit https://github.com/AstroPix/astropix-analysis for more information.
usage: apx_log2apx.py [-h]
[--loglevel {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}]
infiles [infiles ...]
Astropix log file file converter.
This application allows to convert one or more .log legacy text files in
binary format.
positional arguments:
infiles path to the input file(s)
options:
-h, --help show this help message and exit
--loglevel {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}
logging level (default: DEBUG)
apx_monitor#
Welcome to astropix-analysis 0.0.1+g266a123
Copyright (C) 2025, the astropix team.
astropix-analysis comes with ABSOLUTELY NO WARRANTY.
This is free software, and you are welcome to redistribute it under certain
conditions. See the LICENSE file for details.
Visit https://github.com/AstroPix/astropix-analysis for more information.
usage: apx_monitor.py [-h]
[--loglevel {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}]
[--refresh REFRESH] [--group GROUP] [--port PORT]
Monitor Astropix readouts over a UDP socket.
options:
-h, --help show this help message and exit
--loglevel {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}
logging level (default: DEBUG)
--refresh REFRESH refresh interval in seconds (default: 0.5)
multicast options:
--group GROUP multicast group (default: 127.0.0.1)
--port PORT multicast port (default: 5007)
apx_playback#
Welcome to astropix-analysis 0.0.1+g266a123
Copyright (C) 2025, the astropix team.
astropix-analysis comes with ABSOLUTELY NO WARRANTY.
This is free software, and you are welcome to redistribute it under certain
conditions. See the LICENSE file for details.
Visit https://github.com/AstroPix/astropix-analysis for more information.
usage: apx_playback.py [-h]
[--loglevel {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}]
[--start START] [--nohits]
infile
Astropix binary data file playback application.
This application allows to playback a single .apx file and have the decoded hits
pretty-printed on the terminal for debug purposes, along with detailed output
from the decoding process.
positional arguments:
infile path to the input file
options:
-h, --help show this help message and exit
--loglevel {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}
logging level (default: DEBUG)
--start START start from a given readout id (default: 0)
--nohits Do not print the decoded hits (default: False)
apx_process#
Welcome to astropix-analysis 0.0.1+g266a123
Copyright (C) 2025, the astropix team.
astropix-analysis comes with ABSOLUTELY NO WARRANTY.
This is free software, and you are welcome to redistribute it under certain
conditions. See the LICENSE file for details.
Visit https://github.com/AstroPix/astropix-analysis for more information.
usage: apx_process.py [-h]
[--loglevel {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}]
--format {csv,ecsv,fits,hdf5}
[--columns COLUMNS [COLUMNS ...]]
infiles [infiles ...]
Astropix binary data file processing.
This application allows to process one or more .apx binary files, decode the
readouts to extract the hits, and save the latter in a variety of different
formats (('csv', 'ecsv', 'fits', 'hdf5')) amenable to offline analysis.
positional arguments:
infiles path to the input file(s)
options:
-h, --help show this help message and exit
--loglevel {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}
logging level (default: DEBUG)
--format {csv,ecsv,fits,hdf5}
output data format (default: None)
--columns COLUMNS [COLUMNS ...]
columns selected for the output file (default: None)
apx_udprec#
Welcome to astropix-analysis 0.0.1+g266a123
Copyright (C) 2025, the astropix team.
astropix-analysis comes with ABSOLUTELY NO WARRANTY.
This is free software, and you are welcome to redistribute it under certain
conditions. See the LICENSE file for details.
Visit https://github.com/AstroPix/astropix-analysis for more information.
usage: apx_udprec.py [-h]
[--loglevel {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}]
[--group GROUP] [--port PORT]
Receive Astropix readouts over a UDP socket.
options:
-h, --help show this help message and exit
--loglevel {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}
logging level (default: DEBUG)
multicast options:
--group GROUP multicast group (default: 127.0.0.1)
--port PORT multicast port (default: 5007)
apx_udpsend#
Welcome to astropix-analysis 0.0.1+g266a123
Copyright (C) 2025, the astropix team.
astropix-analysis comes with ABSOLUTELY NO WARRANTY.
This is free software, and you are welcome to redistribute it under certain
conditions. See the LICENSE file for details.
Visit https://github.com/AstroPix/astropix-analysis for more information.
usage: apx_udpsend.py [-h]
[--loglevel {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}]
[--sleep SLEEP] [--group GROUP] [--port PORT]
infile
Read Astropix readouts from a file and multicast them over a UDP socket.
positional arguments:
infile path to the input file
options:
-h, --help show this help message and exit
--loglevel {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}
logging level (default: DEBUG)
--sleep SLEEP sleep time between readouts (s) (default: 1.0)
multicast options:
--group GROUP multicast group (default: 127.0.0.1)
--port PORT multicast port (default: 5007)