Structure of the project

The source files of the project are currently only divided into include (for the header files) and src (for the implementation), both folders contain 49 or 50 files respectively. With !91 (merged) even more files will get added to the project. With the growing project it might get cumbersome to get an overview of the project and the dependencies. Therefore refining the structure of the project might be useful.

added discussion enhancement refactoring suggestion labels

A first proposal (discussed with @d.kilic):

+-- main.cpp
+-- petrack.h/.cpp
+-- player.h/.cpp
+-- ui
|   +-- main-windows
|   |   +-- colorPlot.h/.cpp
|   |   +-- analysePlot.h/.cpp (still needed?)
|   |   +-- view.h/.cpp
|   |   +-- control.ui
|   |   +-- control.h/.cpp
|   +-- helper
|   |   +-- qtColorTriangle.h/.cpp
|   +-- dialogs
|   |   +-- stereoWidget.h/.cpp
|   |   +-- colorRangeWidget.h/.cpp
|   |   +-- colorMarkerWidget.h/.cpp
|   |   +-- codeMarkerWidget.h/.cpp
|   |   +-- multiColorMarkerWidget.h/.cpp
|   |   +-- codeMarker.ui
|   |   +-- colorMarker.ui
|   |   +-- colorRange.ui
|   |   +-- multiColorMarker.ui
|   |   +-- stereo.ui
|   +-- visualization
|   |   +-- colorMarkerItem.h/.cpp
|   |   +-- codeMarkerItem.h/.cpp
|   |   +-- multiColorMarkerItem.h/.cpp
|   |   +-- backgroundItem.h/.cpp
|   |   +-- imageItem.h/.cpp
|   |   +-- logoItem.h/.cpp
|   |   +-- gridItem.h/.cpp
|   |   +-- coordItem.h/.cpp
|   |   +-- trackerItem.h/.cpp
|   |   +-- recognitionRoiItem.h/.cpp
|   |   +-- trackingRoiItem.h/.cpp
|   |   +-- stereoItem.h/.cpp
+-- general
|   +-- helper.h/.cpp
|   +-- vector.h/.cpp
+-- IO
|   +-- IO.h/.cpp
|   +-- animation.h/.cpp (should be renamed)
+-- calibration
|   +-- autoCalib.h/.cpp (should be renamed: intrinsic)
|   +-- stereoContext.h/.cpp
|   +-- extraCalibration.h/.cpp
+-- filter
|   +-- filter.h/.cpp
|   +-- blurFilter.h/.cpp
|   +-- brightContrastFilter.h/.cpp
|   +-- borderFilter.h/.cpp
|   +-- backgroundFilter.h/.cpp
|   +-- calibFilter.h/.cpp
|   +-- calibStereoFilter.h/.cpp
|   +-- swapFilter.h/.cpp
+-- recognition
|   +-- recognition.h/.cpp
|   +-- ellipse.h/.cpp
|   +-- person.h/.cpp (rename)
|   +-- markerCasern.h/.cpp
|   +-- markerJapan.h/.cpp
|   +-- markerHermes.h/.cpp
+-- tracking
|   +-- tracker.h/.cpp (split into smaller parts [future])
|   +-- trackerReal.h/.cpp

To discuss:

• structure ok?
• keep splitting of header and source files?

Small comment: avifiles aren't mentioned, because they are part of our submodule.

changed milestone to %1.0.0 - old

@t.arens has proposed to instead use a feature-based grouping. I have tried to come up with such a file structure (open for comments, especially on naming)

This is with all new files and has a line for each file (not header+source together as above); This excludes tests, but they would just mirror the structure of the main source directory

Click to expand

...\PETRACK\SRC
│   analysePlot.cpp
│   analysePlot.h
│   control.cpp
│   control.h
│   control.ui
│   main.cpp
│   petrack.cpp
│   petrack.h
│
├───color
│       colorPlot.cpp
│       colorPlot.h
│       colorRange.ui
│       colorRangeWidget.cpp
│       colorRangeWidget.h
│       qtColorTriangle.cpp
│       qtColorTriangle.h
│
├───coordinate-viz
│       alignmentGridBox.cpp
│       alignmentGridBox.h
│       alignmentGridBox.ui
│       coordItem.cpp
│       coordItem.h
│       gridItem.cpp
│       gridItem.h
│
├───correction
│       correction.cpp
│       correction.h
│       correction.ui
│       frameRange.h
│       plausibility.cpp
│       plausibility.h
│
├───extrinsic
│       coordinateStructs.h
│       coordinateSystemBox.cpp
│       coordinateSystemBox.h
│       coordinateSystemBox.ui
│       extrCalibration.cpp
│       extrCalibration.h
│       extrinsicBox.cpp
│       extrinsicBox.h
│       extrinsicBox.ui
│       extrinsicParameters.h
│       worldImageCorrespondence.h
│
├───filter
│       backgroundFilter.cpp
│       backgroundFilter.h
│       backgroundItem.cpp
│       backgroundItem.h
│       blurFilter.cpp
│       blurFilter.h
│       borderFilter.cpp
│       borderFilter.h
│       brightContrastFilter.cpp
│       brightContrastFilter.h
│       calibFilter.cpp
│       calibFilter.h
│       calibStereoFilter.cpp
│       calibStereoFilter.h
│       filter.cpp
│       filter.h
│       filterBeforeBox.cpp
│       filterBeforeBox.h
│       filterBeforeBox.ui
│       swapFilter.cpp
│       swapFilter.h
│
├───info-dialogues
│       about.ui
│       aboutDialog.cpp
│       aboutDialog.h
│       compilerInformation.h
│       logwindow.cpp
│       logwindow.h
│       logwindow.ui
│
├───intrinsic
│       autoCalib.cpp
│       autoCalib.h
│       intrinsicBox.cpp
│       intrinsicBox.h
│       intrinsicBox.ui
│       intrinsicCameraParams.cpp
│       intrinsicCameraParams.h
│
├───io
│       animation.cpp
│       animation.h
│       autosave.cpp
│       autosave.h
│       autosaveSettings.cpp
│       autosaveSettings.h
│       autosaveSettings.ui
│       IO.cpp
│       IO.h
│
├───mocap
│       editMoCapDialog.cpp
│       editMoCapDialog.h
│       editMoCapDialog.ui
│       moCapController.cpp
│       moCapController.h
│       moCapEditingWidget.cpp
│       moCapEditingWidget.h
│       moCapEditingWidget.ui
│       moCapItem.cpp
│       moCapItem.h
│       moCapPerson.cpp
│       moCapPerson.h
│       moCapPersonMetadata.cpp
│       moCapPersonMetadata.h
│       moCapSelectionWidget.cpp
│       moCapSelectionWidget.h
│       moCapSelectionWidget.ui
│       openMoCapDialog.cpp
│       openMoCapDialog.h
│       openMoCapDialog.ui
│       skeletonTree.cpp
│       skeletonTree.h
│       skeletonTreeFactory.cpp
│       skeletonTreeFactory.h
│
├───recognition
│       codeMarker.ui
│       codeMarkerItem.cpp
│       codeMarkerItem.h
│       codeMarkerWidget.cpp
│       codeMarkerWidget.h
│       colorMarker.ui
│       colorMarkerItem.cpp
│       colorMarkerItem.h
│       colorMarkerWidget.cpp
│       colorMarkerWidget.h
│       ellipse.cpp
│       ellipse.h
│       markerCasern.cpp
│       markerCasern.h
│       markerHermes.cpp
│       markerHermes.h
│       markerJapan.cpp
│       markerJapan.h
│       multiColorMarker.ui
│       multiColorMarkerItem.cpp
│       multiColorMarkerItem.h
│       multiColorMarkerWidget.cpp
│       multiColorMarkerWidget.h
│       person.cpp
│       person.h
│       recognition.cpp
│       recognition.h
│
├───stereo
│       aviFileWriter.cpp
│       aviFileWriter.h
│       stereo.ui
│       stereoAviFile.cpp
│       stereoAviFile.h
│       stereoContext.cpp
│       stereoContext.h
│       stereoItem.cpp
│       stereoItem.h
│       stereoWidget.cpp
│       stereoWidget.h
│
├───tracker
│       tracker.cpp
│       tracker.h
│       trackerItem.cpp
│       trackerItem.h
│       trackerReal.cpp
│       trackerReal.h
│
├───trajectories
│       circularStack.h
│       manualTrackpointMover.cpp
│       manualTrackpointMover.h
│       personStorage.cpp
│       personStorage.h
│
├───ui-lib
│       pdoublespinbox.cpp
│       pdoublespinbox.h
│       pGroupBox.cpp
│       pGroupBox.h
│       pGroupBox.ui
│       pGroupBoxFrame.cpp
│       pGroupBoxFrame.h
│       pGroupBoxFrame.ui
│       pMessageBox.cpp
│       pMessageBox.h
│       pSlider.cpp
│       pSlider.h
│       pspinbox.cpp
│       pspinbox.h
│       roiItem.cpp
│       roiItem.h
│
├───util
│       helper.cpp
│       helper.h
│       logger.h
│       vector.cpp
│       vector.h
│
└───video-display
        imageItem.cpp
        imageItem.h
        logoItem.cpp
        logoItem.h
        player.cpp
        player.h
        view.cpp
        view.h

created branch 146-structure-of-the-project to address this issue

mentioned in merge request !331 (merged)

mentioned in commit 7dcda221

closed with merge request !331 (merged)