Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
crs94 committed Dec 8, 2017
1 parent ccce996 commit 60d0b5d
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 10 deletions.
4 changes: 2 additions & 2 deletions P2/voicemodule/refresh_signal.m
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
function [record, fs] = refresh_signal(hObject, handles, files, stuff, n, analysis)

% Recover file original name
filename = strrep(files{n}, '.csv', '.wav')
filename = strrep(files{n}, '.csv', '.wav');
filename = strrep(filename, strcat(filesep, 'CSVFiles', filesep), filesep);
[fpath, fname, fext] = fileparts(files{n});
set(handles.textFilename, 'String', strcat(fname, fext));
Expand All @@ -11,7 +11,7 @@

% If the file being analysed is indeed an audio
if analysis
moments = get(stuff, files{n})
moments = get(stuff, files{n});
timemoments = turn_to_time(moments, length(record)/fs);

% Else, if file hasa been analysed already
Expand Down
11 changes: 5 additions & 6 deletions P2/voicemodule2.m
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ function radioAudio_Callback(hObject, eventdata, handles)
set(handles.radioTable, 'Value', 0);
set(handles.buttonRun, 'Enable', 'on');
set([handles.buttonPlot handles.buttonSave], 'Enable', 'off');
% set(handles.buttonSave, 'Enable', 'off');
handles.ext = '*.wav';
end
guidata(hObject, handles);
Expand All @@ -105,7 +104,6 @@ function radioTable_Callback(hObject, eventdata, handles)
set(handles.radioAudio, 'Value', 0);
set(handles.buttonRun, 'Enable', 'off');
set([handles.buttonPlot handles.buttonSave], 'Enable', 'on');
% set(handles.buttonSave, 'Enable', 'on');
handles.ext = '*.csv';
end
guidata(hObject, handles);
Expand Down Expand Up @@ -142,7 +140,7 @@ function buttonSearch_Callback(hObject, eventdata, handles)
end
end

outlet = join_strings(handles.cases, ';');
outlet = join_strings(temp, ';');
set(handles.editSearch, 'String', outlet);

% If an audio will be analysed, Run must be enabled
Expand Down Expand Up @@ -170,7 +168,7 @@ function buttonRun_Callback(hObject, eventdata, handles)

% Analyse each audio provided by the user
for n = 1:length(filename)
file{n} = strcat(pathname, filename{n})
file{n} = strcat(pathname, filename{n});
stuff.put(file{n}, main(file{n}));
end

Expand Down Expand Up @@ -206,7 +204,7 @@ function buttonPlot_Callback(hObject, eventdata, handles)
timeArray(k - 1) = str2num(strrep(temp, ',', '.'));
end
fclose(fileID);
file{n} = content{1}{k}(1:semicollon(1) - 1)
file{n} = content{1}{k}(1:semicollon(1) - 1);

% Fill out stuff hash map with new value
stuff.put(file{n}, timeArray);
Expand All @@ -218,7 +216,8 @@ function buttonPlot_Callback(hObject, eventdata, handles)
guidata(hObject, handles);

end
handles.stuff = plot_stuff(handles.files, handles.stuff, get(handles.radioAudio, 'Value'));
handles.stuff = plot_stuff(handles.files, handles.stuff,...
get(handles.radioAudio, 'Value'));
guidata(hObject, handles);


Expand Down
Binary file modified docs/assets/subvoice.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/voice.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions docs/doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ <h2>Processamento de RGP</h2>
<a name="voice"></a>
<h2>Análise de Voz</h2>

<p>Esta ferramenta extrai os momentos iniciais de cada palavra em um sinal de voz em um arquivo WAV aplicando um <em>threshold</em> no espectro de potência da gravação em questão. Permite remoção de falsos-positivos em um submódulo após a análise computacional do arquivo de áudio.</p>
<p>Esta ferramenta extrai os momentos iniciais de cada palavra em um sinal de voz em um arquivo WAV aplicando um <em>threshold</em> no espectro de potência da gravação em questão. Permite remoção de falsos-positivos em um submódulo após a análise computacional do arquivo de áudio. Caso o arquivo de áudio já tenha sido analisado previamente, também é possível informar ao programa a versão em tabela CSV que contém as informações de análise para, então, verificar a marcação dos momentos.</p>

<p><img src="assets/voice.png" alt="voice analysis" title="'Voice Analysis' Module" /></p>

Expand All @@ -205,7 +205,9 @@ <h2>Análise de Voz</h2>

<p><img src="assets/subvoice.png" alt="moments verification" title="'Moments Verification' Module" /></p>

<p>O nome do arquivo que está sendo analisado é mostrado no topo de uma lista contendo todos os valores obtidos após a análise computacional do arquivo. Estes valores <b>devem</b> ser selecionados (para seleção múltipla, utilize <em>Ctrl/Shift</em>) para serem salvos ao final da verificação. Caso o usuário deseje checar o que foi selecionado, é possível fazê-lo com o botão <code>View Selection</code>. Este botão atualiza o gráfico contendo as marcações dos tempos, colorindo de verde aquilo que foi selecionado pelo usuário.</p>
<p>O nome do arquivo que está sendo analisado é mostrado no topo da janela do módulo. Os valores encontrados com a análise computacional do arquivo de áudio são marcados em vermelho sobre o formato de onda (em azul) do arquivo de som.</p>

<p>Com auxílio das ferramentas no topo da janela é possível aumentar e diminuir o zoom e arrastar o formato de onda de um lado para o outro. Além disso, é possível habilitar e desabilitar a seleção de pontos para a adição e remoção. Para selecionar múltiplo pontos, ative a ferramenta <code>Data Cursor</code> e segure a tecla <em>Alt</em> enquanto clica nos lugares desejados. Para adicionar os lugares marcados à lista de pontos relacionados ao arquivo, basta clicar no ícone <code>+</code>. Para eliminar os lugares selecionados, clique no ícone <code>-</code>.</p>

<p>Uma vez que o usuário esteja satisfeito com o resultado, clica-se no botão <code>Next</code> (ou <code>Save</code>, se não houver mais arquivos para analisar) para atualizar a lista de valores de momentos do arquivo e continuar a análise com o próximo arquivo.</p>

Expand Down

0 comments on commit 60d0b5d

Please sign in to comment.