Skip to content

Profile Logging Parameters

Todd Schumann edited this page Aug 9, 2018 · 4 revisions

The logging parameters define what SDR Calibrator does with the data and calculations it performs once the test is complete. Note that only the logging parameters for the called test will apply (the save functionality is never called for the dependency tests for any of the built-in tests).

Every test has its own set of logging parameters, which can be found under that test's wiki page. Usually by default, the save parameters are set to False to prevent failed tests from cluttering the test results folder and the plot parameters are set to True so that the tests can be debugged prior to running for an extended period of time. In addition, there are a couple which are common parameters to every test, which are shown here.

Profile Logging Parameters

Note: italicized parameters have default values and can be left unset

  • logging_quiet_mode = False: When set to True, SDR Calibrator will prevent the log messages from being output to the terminal except for errors, warnings, and user inputs for the duration of the test. In some cases, outputting to the terminal buffer can significantly slow the test progress, in which case this may be advantageous. By default, quiet mode is disabled.
  • logging_save_log_file = False: When set to True, the log messages will be output to a file in the save directory. This process is not immediate. Instead, at set points (usually right before intensive portions of the test), the log buffer is dumped to the file to reduce memory. If data is not as expected, the log file can be used to see if there were abnormalities during the test (e.g. the SDR tuned within a division in the scale factors and guessed wrong on which scale factor to use). However, for the longer tests, the log file can easily exceed 10s to 100s of MB which can clutter systems with low diskspace. Additionally, if operating on a system with low memory, the log buffer itself can interfere with the space needed to store the IQ samples coming from the SDR. Therefore, by default, this is disabled.

Parameter Quick-Copy

For convenience, here is a copyable list of parameters in this category

# Logging parameters
#logging_quiet_mode = False
#logging_save_log_file = False

Note: there are usually additional logging parameters for each test.