Raw Recorder

Overview

The Raw Recorder allows to record MUDPI/RTMS streams and extract image data from these raw recordings. The Raw Recorder consists of two tools, a capture tool and an extractor tool.

Raw Recorder Capture Tool

The Raw Recorder Capture Tool rtctkRawRecorderCapture allows the capture of raw traffic from any interface. It allows setting a time limit on the capture and filtering by multicast address and port.

Usage

$ rtctkRawRecorderCapture --help
rtctkRawRecorderCapture - record raw RTMS streams
Options:
  --help                  show help message
  --capture-time arg (=0) Duration in seconds for the capture. A value of zero
                          disables the automatic stop.
  --interface arg         The network interface to listen on
  --multicast-address arg Filter for multicast address (optional)
  --multicast-port arg    Filter for multicast port (optional)
  --output-directory arg  Directory where the resulting files should be stored

The only arguments that must be passed are the interface to use for the capture and the output directory.

Example

The following must be run as root together with an appropriate network interface, i.e. change eth0 to a valid value:

# rtctkRawRecorderCapture --interface eth0 --capture-time 60 \
    --output-directory /tmp/recording

Note

Currently the capture time has the following restriction: The recorder will only exit once it matches a packet after the capture time has elapsed. This packet will not be part of the recording, but will cause the recording to stop and the application to exit.

Raw Recorder Extractor Tool

The extractor tool rtctkRawRecorderExtractor allows to extract the image data from the raw capture. It can combine multiple RTMS payload packets to a single image and store them as a fits image. This depends on the support of the camera used. If a camera is not supported, a “generic” camera can be used to store the data from the packets as a FITS binary table.

Usage

$ rtctkRawRecorderExtractor --help
Rtctk Raw Recorder for MUDPI
Usage: rtctkRawRecorderExtractor [OPTIONS]

Options:
-h,--help                   Print this help message and exit
--version                   Display program version information and exit
--input-file TEXT:FILE REQUIRED
                            File to convert
--output-directory TEXT:DIR REQUIRED
                            Directory where FITS files shoud be outputted after extraction.
--camera,--camera-model TEXT
                            Camera model. Use value "list" to print supported models.
--sampleid-start INT        Ignore sampleids lower than the given sampleid.
--sampleid-stop INT         Ignore sampleids bigger than the given sampleid.
--timestamp-start INT       Ignore packets with timestamps before the given timestamp. (Nanoseconds TAI)
--timestamp-stop INT        Ignore packets with timestamps after the given timestamp. (Nanoseconds TAI)
--extract-timestamps        Save timestamps to FITS keywords
--extract-sampleids         Save sampleids to FITS keywords
--split-output              Export one FITS file per sample, instead of all data in one FITS file
--verbose                   Print more log messages

The required arguments are the input file and the output directory. The camera model option can be used to list all supported cameras. It is also possible to restrict the time period (using the MUDPI timestamp) and the sample ids that should be considered during the extraction.

Example

$ rtctkRawRecorderExtractor --input-file /tmp/recording/recording.pcap \
    --sampleid-start 10 --sampleid-stop 100 \
    --output-directory /tmp/recording-converted/