Separation of Concern

[Agung-Krisna]

Separation of concerns

Separation of concern is important because right now the methods are very long and can contain different algorithm, each conveying different meaning. I want to further simplify it by breaking it into different classes and method. This has proven reduce the lines of code due to the removal of duplicating codes.

Another thing that I see is how related items are being treated as primitives, which leads into primitive obsession. I want to remediate that by encapsulating related items into singular class which can be instantiated using an object.

Long parameter list is also a symptom to lack of objects which can grow and become harder to maintain. Remediation plan for that is by creating sub methods that can reduce the number of parameter required for an object.

Moving on, by performing separation of concerns, development process can be made more streamlined as well as easier to maintain. This is mainly because our future endeavor for expanding the app is on the horizon, so ensuring that the development can be made as clear and as simple as possible is going to be a definite win.

Different concerns

AutoMapper should only have three methods, namely stream_using_cv2, stream_as_image, and generate_raw_outputs. Other methods should be delegated to different classes, according to their purpose.

1. CV2Handler should handle tasks related to CV2 operations, such as calculating and drawing framerate, calculating bottom center, drawing detection boxes, and saving video result.
2. ImageHandler should handle tasks related to the images used, namely the image2d and image3d. It should contain properties such as the image object itself, max height, and total width.
3. HomographicHandler should handle tasks related to homographic transformation, which revolves around loading coordinates and transforming coordinates.
4. Frame is a data class that holds properties such as the frame3d, frame2d, and frame count. Every used frame must be stored within the data class so that other methods can access and modify the same object.
5. TrackerHandler should handle tasks related to tracking detected objects from the ModelInterpreter, it also needs to calculate bottom center automatically rather than processing it on the caller.

Notes on Backward Compatibility

I'm intentionally not removing the previous dot_vision.py and auto_mapper.py. Instead I took an initiative to create a new file to allow real time comparison between the previous version and the new version.

After all changes are accepted, I think it would not be necessary to keep the previous version of the code as all features have been fully recreated in the new version.

[alvinwatner]

Overall, great work Krisna! I know this is taking a lot of pain and sweat, but I bet it will be worth it down the road and we surely learn a lot from this. Just couple more things to be improved, look forward for the update!

[Nick-Achee]

Krishna this is a amazing ⚡️