How rtmilliken/edfbrowser works
Project’s Main Components
• User Interface (UI) Components:
• Main window (main.cpp, mainwindow.cpp/h) which acts as the central UI container.
• Various dialogs and dock widgets such as about_dialog, options_dialog, annotations_dock, jump_dialog, load_montage_dialog, and more.
• Core Data Processing & Conversion Modules:
• Conversion components (e.g., ascii2edf, bdf2edf, biosemi2bdfplus, manscan2edf, emsa2edf, etc.) which implement file format conversions.
• EDF handling libraries (e.g., edflib.c/h, edf_compat, edf_annotations) are responsible for the low-level EDF file processing.
• Filter and signal processing modules (e.g., ecg_filter, filter, filtercurve, fourier, kiss_fft integration, etc.).
• Utility and Supporting Components:
• Utility functions (utils.c/h, utc_date_time) supporting time, file checks, and general computations.
• Third-party libraries such as fidlib and kiss_fft under the third_party directory to provide additional functionalities (e.g., FFT analysis).
File Structure for Architectural Patterns
• Clear separation of UI components (dialogs, dock widgets, main window) and business logic (conversion routines, filtering, signal analysis).
• Each conversion and processing task is implemented as standalone modules (using separate .cpp and .h pairs) which can be depicted as discrete components.
• The integration with third-party libraries (located under third_party) suggests how the system leverages external functionalities for signal processing (e.g., Fourier analysis, file manipulation).
a. Main Components:
• A “Utilities & External Libraries” section for utility functions and the third_party libraries (fidlib and kiss_fft).
b. Relationships and Interactions:
• Link UI components to the core processing modules to indicate that user actions (such as file export or filter adjustment) trigger conversion routines and processing logic.
• That the processing modules depend on both the internal EDF-handling libraries and third-party libraries for specialized tasks like FFT and file I/O.
c. Architectural Patterns and Design Principles:
• Separation of concerns: UI elements are kept separate from business logic, and both are modular.
• Patterns such as Model-View separation inherent in Qt’s structure (widgets for presentation, separate processing routines).
• Document the design such that each conversion or filter is a discrete subsystem that can be independently updated or debugged.
d. Technologies & Frameworks:
• That the project is based on Qt4 (with qmake used to build the UI), and it’s built using GCC/MinGW.
• Integration with C-based libraries (edflib, utility routines) and third-party signal processing (kiss_fft, fidlib).
Elements
• Clear labels for each main component (e.g., “Main Window”, “Conversion Module”, “EDF Library”, “Filter Module”, “Third-Party FFT Library”)