search

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
7 stars 10 forks source link

Reformation of the code into classes #32

Open michaelstanway opened 1 year ago

michaelstanway commented 1 year ago

The folder below contains the files which make up ARTwarp arranged by what they are used for. This should be how we group them to rewrite into classes (although it would be good to go through and periodically check that this organisation makes sense). I have also include an Example Class to use as a format and the completed rewrite of the Load_Data functions is also contained (found in Completed_Classes). Take a look and if anyone wants to begin rewriting into classes, ARTwarp_Get_Parameters would be a good beginner function to attempt (found in Run_Categorisation-->Assign_Parameters).

ARTwarp_rewrite.zip

olexandr-konovalov commented 1 year ago

Thanks @michaelstanway - perhaps after completing https://github.com/dolphin-acoustics-vip/artwarp/milestone/1 we need to follow this and start to reorganise it!

michaelstanway commented 1 year ago

Just rewrote the Parameter function into a class. It needs more comments on what each of the parameters mean and do; that is something which can be obtained from the ARTwarp paper on the moodle. Go to the completed classes section to view it (class name: Parameters).

ARTwarp_rewrite.v2.zip

michaelstanway commented 1 year ago

Completed_Classes.zip

olexandr-konovalov commented 1 year ago

@michaelstanway why don't you make a PR?