Skip to content

Commit

Permalink
add information in readme and tutorial files
Browse files Browse the repository at this point in the history
  • Loading branch information
LouisRanjard committed May 15, 2017
1 parent ccf61a9 commit d8c3ec7
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 4 deletions.
8 changes: 7 additions & 1 deletion README.md
@@ -1,5 +1,5 @@
# matlabHTK
## Matlab Interface to HTK for Bioacoustic
## Matlab/Octave Interface to HTK for Bioacoustic

---

Expand All @@ -9,6 +9,12 @@ MatlabHTK uses VOICEBOX speech processing toolbox MATLAB routines to read/write

---

## How to cite

Please use: Ranjard, L., Reed, B. S., Landers, T. J., Rayner, M. J., Friesen, M. R., Sagar, R. L. and Dunphy, B. J. (2016). MatlabHTK: A simple interface for bioacoustic analyses using hidden Markov models. Methods in Ecology and Evolution. doi:10.1111/2041-210X.12688

---

## Function documentation
The calls to HTK functions are _**indicated**_.

Expand Down
5 changes: 5 additions & 0 deletions Tutorial_diving_petrel/tutorial.md
Expand Up @@ -10,8 +10,12 @@ Open Octave or Matlab. Add the matlabHTK function to the Matlab/Octave path and
addpath(genpath('/home/louis/matlabHTK-master')) ;
cd /home/louis/matlabHTK-master/Tutorial_diving_petrel ;
more off;
graphics_toolkit("gnuplot");
```
Use `more off;` in Octave to suppress some unnecessary messages (disable Paging Screen Output).
Depending on how you downloaded the package, you may need to use the path '/home/louis/matlabHTK' instead of '/home/louis/matlabHTK-master'.
For correctly displaying plots in Octave, make sure you are using the gnuplot system `graphics_toolkit("gnuplot");`.


#### Training
Set up and train HMMs for each label found in the manually annotated label files in training directory
Expand All @@ -31,6 +35,7 @@ Plot the recognition results for the label 'diving_petrel'. Input the date and t
plot_Label('./recognition/recording.label','./recognition/recording.wav','diving_petrel',10,'25/09/2014 18:00:00',1);
```


---

 
Expand Down
6 changes: 3 additions & 3 deletions plot_Label.m
Expand Up @@ -10,17 +10,17 @@
end

if nargin<5
timestart = 0;
timestart = datestr(now,'dd/mm/yyyy HH:MM:SS') ;
if nargin<4
% choose bin size in seconds
binsiz = 60 ;
if nargin<3
label = 'diving_petrel' ;
end
end
else
timestart = datenum(timestart,'dd/mm/yyyy HH:MM:SS') ;
end

timestart = datenum(timestart,'dd/mm/yyyy HH:MM:SS') ;

% get the Fs
%tmp = regexprep(filename(end:-1:1),'dirGtxeT.','vaw.','once');
Expand Down

0 comments on commit d8c3ec7

Please sign in to comment.