Add object-oriented structure blueprints (DO NOT MERGE)

dolphin-acoustics-vip / artwarp

MATLAB program for automated categorisation of tonal animal sounds

https://github.com/dolphin-acoustics-vip/artwarp/wiki

GNU Lesser General Public License v3.0

6 stars 9 forks source link

Add object-oriented structure blueprints (DO NOT MERGE) #42

Closed lixitrixi closed 1 year ago

lixitrixi commented 1 year ago

I have added several classes to assist in our object-oriented approach to rewriting ARTwarp. There are several points to address with these changes, which I will add as comments.

lixitrixi commented 1 year ago

Please DO NOT MERGE until Michael and Harvard have reviewed my additions, and we have discussed them.

lixitrixi commented 1 year ago

Here are a few key points we should address soon @harvard-tham @michaelstanway

How should we encode contours? It would be best to have a platform-independent format that's easily viewable, perhaps CSV?
By extension, how would we encode a category? a network?

And some general points regarding the new code

My choices for variable names are not final, we should aim to choose the best names for what is being represented
I have not added the "trainer" object we discussed, for now. That aspect of the program is a bit fuzzy and would benefit from some more discussion

olexandr-konovalov commented 1 year ago

@lixitrixi can your work have some tests e.g. unit tests btw? If so that would be great to set up CI - see my start at #43

harvard-tham commented 1 year ago

Hard to tell if this would be the final structure but it would be a good starting point to build from

olexandr-konovalov commented 1 year ago

@harvard-tham if merging, edit PR title to remove "DO NOT MERGE" - it does not make sense then