Sequence Diagrams for stonesoup.tracker.simple Documentation

[PACarniglia]

Hello, I've created a few sequence diagrams to help assist in the readability of some of the more popular and widely developed-upon Stone Soup algorithms here at DRDC - namely, the three tracker classes within stonesoup.tracker.simple. The aim of these diagrams is twofold; one, to increase readability of the code for users trying to understand the mapping of the implemented algorithms into Python code and two, to enable developers to more easily identify locations within the algorithms where optimizations/changes could be made. Sequence diagrams are meant to provide a broad overview of a class to aid in following the "flow" of a particular class and as such are not a detailed overview of each method and are not a replacement for thorough inline documentation. Diagrams of each of these sequence diagrams could be either embedded in the documentation or perhaps linked to open in a separate tab - their large dimensions may make it difficult to embed in the documentation page.

For review, I have attached the three diagrams below. In order, they are the SingleTargetTracker, MultiTargetTracker, and MultiTargetMixtureTracker. I created them using draw.io (https://app.diagrams.net/) Please provide feedback on any errors or improvements to these diagrams you would like to see. If these would be a useful addition to the documentation, I plan to create more for other popular classes.

SingleTargetTracker

MultiTargetTracker

MultiTargetMixtureTracker