SXXXXXXX_RadarDataReader/doc/English-manual.md

English

User Manual - Radar Data Reader & Processor

1. Introduction

This manual provides a comprehensive guide to using the Radar Data Reader & Processor application. The application is designed to solve two main problems:

1. Provide a controlled, user-friendly interface for running the g_reconvert.exe command-line utility.
2. Offer a powerful tool for inspecting, analyzing, and extracting data from the generated binary .out files.

2. System Requirements

• A Python 3 environment.
• Required Python libraries (mainly numpy).
• The g_reconvert.exe executable must be accessible on the system. The application is a wrapper and depends on this file for its conversion functionality.

3. Initial Setup

On first launch, the application creates a config/config.json file in its directory. It is critical to configure the application correctly before use.

1. Start the application.
2. Navigate to the "REC to OUT Converter" tab.
3. Click the "g_reconverter Advanced Config..." button.
4. In the new window, the first field is "Executable Path". Click "Browse..." and select the exact location of your g_reconvert.exe file.
5. Click "Save & Close".

Without this step, the conversion feature will not work.

4. Interface Guide

The main interface consists of:

• Menu Bar: Contains options for managing export profiles and exiting the application.
• Tabs:
  • OUT Processor: For analyzing and exporting data from .out files.
  • REC to OUT Converter: For converting .rec files to .out.
• Log Console: Shows real-time status, error, and debug messages from the application and the C++ process.
• Status Bar: Indicates the current application state (e.g., "Ready", "Processing...").

5. Use Case 1: Converting a .rec sequence to an .out file

This process uses the "REC to OUT Converter" tab.

1. Select Input File: Click "Browse..." next to "First .rec File" and select the first file of your sequence (e.g., data_001.rec).
2. Set File Count: In the "Number of Files (/n)" field, set the total number of .rec files that make up the sequence.
3. Choose Output Directory: In "Output Directory," select the folder where you want the .out file to be saved. You can use "Browse..." to find it or "Open..." to open the selected folder in your file explorer.
4. Verify Generated Filename: The "Generated Filename" field will automatically display the name of the .out file that will be created.
5. (Optional) Advanced Configuration: If needed, click "g_reconverter Advanced Config..." to modify the parameters passed to g_reconvert.exe. For the meaning of each option, refer to the specific documentation for g_reconvert.exe.
6. Start Conversion: Click "Convert REC to OUT". The process will begin, and the Log Console will display the output from g_reconvert.exe. The status bar will indicate "Processing...".
7. Result: Upon completion, if the conversion was successful, the "Process Generated .out File ->" button will become active. Clicking it will automatically switch the application to the "OUT Processor" tab and load the newly created file, ready for analysis.

6. Use Case 2: Analyzing an .out file and Exporting Data

This process uses the "OUT Processor" tab.

1. Select Input File: Click "Browse..." and select the .out file you want to analyze.
2. Configure Output:
   • Output Directory: Choose the folder to save the exported files (CSV/JSON).
   • Base Filename: Enter a base name for the output files (e.g., flight_analysis_1). The extension will be added automatically.
3. Choose Formats and Profiles:
   • Check "Generate .csv file" and/or "Generate .json file" to enable the desired formats.
   • For each format, select an Export Profile from the dropdown menu. The "Default" profile is available initially. To create custom profiles, see section 7.
4. Start Processing: Click "Process .out File". The application will begin reading and parsing the file.
5. Monitor Progress:
   • The progress bar and the "Progress" and "Batches Found" fields in the "Live Data & Progress" section will update in real-time.
   • You can stop the process at any time by clicking "Stop".
6. Result: Upon completion, you will find the exported files (e.g., flight_analysis_1.csv and/or flight_analysis_1.json) in the specified output directory.

7. Advanced Management: The Export Profile Editor

To access the editor, go to File -> Manage Export Profiles....

• Left Pane (Profiles):

  • Use the dropdown to select an existing profile.
  • New: Creates a new, empty profile.
  • Delete: Deletes the currently selected profile.

• Middle Pane (Available Fields):

  • Displays a tree of all data fields the application can extract, mirroring the data structure of the .out file.
  • Fields marked with (Enum) can be translated.
  • To add a field, select it here and click the >> button.

• Right Pane (Selected Fields for Profile):

  • Shows the fields selected for the current profile.
  • >>: Adds the selected field from the left tree.
  • <<: Removes the selected field from this list.
  • Up/Down: Moves a selected field up or down in the export order.
  • "Translate" Column: This column is key to data readability. If a field can be translated (e.g., an operating mode), you will see a checkbox icon (☐ or ☑). By clicking directly on this cell, you can toggle the translation.
    • ☑ (Enabled): In the exported file, the numeric value will be replaced by its name (e.g., 15 -> STT_MASTER_MODE).
    • ☐ (Disabled): The raw numeric value will be exported.

• Saving: Click "Save & Close" to save all changes. If you close the window without saving, you will be prompted to save any unsaved changes.

8. Frequently Asked Questions (FAQ)

• Q: Why is the "Convert REC to OUT" button disabled or not working?

  • A: Most likely, you have not set the correct path to g_reconvert.exe. Follow the instructions in the "Initial Setup" section.

• Q: The application shows a "Failed to parse block" error in the console. What does it mean?

  • A: This indicates that the .out file may be corrupt, incomplete, or in a slightly different format than the parser expects. The process will continue by attempting to parse subsequent blocks.

• Q: How can I add a field that I don't see in the "Available Fields" tree?

  • A: This requires a source code modification. You will need to:
    1. Add the corresponding structure in the radar_data_reader/core/data_structures.py file.
    2. Implement the parsing logic for that structure in radar_data_reader/core/struct_parser.py.

• Q: What do all the options in the "g_reconverter Advanced Configuration" window mean?

  • A: Those options correspond directly to the command-line arguments of g_reconvert.exe. This GUI only acts as a wrapper to build them. For a detailed explanation of each flag, please consult the official documentation for g_reconvert.exe.