Skip to content

Commit

Permalink
Help secton updated
Browse files Browse the repository at this point in the history
Worker error tracking - inital
Override console warn and error to send tracking messages (UI & worker)
All results from listWorker are a list
added UUID to worker STATE for tracking
  • Loading branch information
Mattk70 committed Mar 4, 2024
1 parent a5cd35a commit 35ea33b
Show file tree
Hide file tree
Showing 10 changed files with 207 additions and 571 deletions.
2 changes: 1 addition & 1 deletion Help/bugs.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ <h4>Have you hit on a problem, or perhaps you have a suggestion?</h4>
<p>Take a look at what others have been reporting, if you think you have a similar problem or suggestion, add a comment to the thread.</p>

<p> If, on the other hand, you think you've got something new, go on and report an <a href="https://github.com/Mattk70/Chirpity-Electron/issues" target="_blank">issue</a> or start a <a href="https://github.com/Mattk70/Chirpity-Electron/discussions/" target="_blank">discussion</a> - I'll get back to you as soon as I can. </p>
I can't promise I'll make everything right, but I probably won't fix what I don't know about &#x00AF;\\_(ツ)_/&#x00AF; </p><p>Meanwhile, I hope you find Chirpity useful, and happy birding!</p>
I can't promise I'll make everything right, but I probably won't fix what I don't know about &#x00AF;\\_(ツ)_/&#x00AF;<p>Meanwhile, I hope you find Chirpity useful, and happy birding!</p>

</body>
</html>
118 changes: 76 additions & 42 deletions Help/settings.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@

<table class="table table-hover p-1">
<tr>
<td colspan="2" class="text-center text-bg-light"><h5>Predictions</h5></td>
<td colspan="2" class="text-center text-bg-light"><h5>Detections</h5></td>
</tr>
<tr>
<th>Model</th>
<td>Choose the model to use for prediction.
<td>Choose the model to use for detection.
<ul>
<li>
<b>Chirpity</b> will use the native Chirpity model for predictions.
<b>Chirpity</b> will use the native Chirpity model for analysis.
</li>
<li>
<b>BirdNET</b> will use the <a href="https://github.com/kahst/BirdNET-Analyzer" target="_blank">BirdNET</a> model developed by Stefan Kahl et al. from the K. Lisa Yang Center for Conservation Bioacoustics
Expand All @@ -39,10 +40,10 @@
list from the latest file in a batch of files.
For example, if you analyse files from April 22, October 23 and February 24 in a batch, the list for February 24 will be used for the summary.
</p>
<p><b>Nocturnal Birds</b>. This will exclude detections of bird song and the calls of species which do not typically vocalise during the night.
<p><b>Birds</b>. Include detections for all but non-avian classes.
<p><b>Nocturnal Birds</b>. This will exclude detections of bird song and the calls of species which do not typically vocalise during the night.</p>
<p><b>Birds</b>. Include detections for all birds, excluding non-avian classes.
</p>
<p><b>Everything</b>. In addition to birds, show non-bird detections including segments that were considered noise.</p>
<p><b>Everything</b>. In addition to all bird species, show non-bird detections including segments that were considered noise.</p>
<p><b>Custom</b>. Provide a list for the model to use. You may use a different custom list for both BirdNET and Chirpity models. The format for a
custom list file is, as for BirdNET Analyzer's custom lists, "scientific name_common name", with each species on a new line. You can export a starting
list in the correct format from the Help menu, using the "<i>What species are detected?</i>" link.
Expand All @@ -53,34 +54,41 @@
</ol>


</ul>
<p><i>If you wish to see the full list of species used for predictions each model was trained on, check the Help menu > <b>What species are detected?</b></i>.</p>

<p><i>If you wish to see the full list of species used for predictions each model was trained on, check the Help menu &gt; <b>What species are detected?</b></i>.</p>
</td>
</tr>
<tr>
<th>Nocmig Mode</th>
<th>Only analyse night time periods</th>
<td>
Only search for detections at night. Chirpity calculates the end and start of civil twilight for the dates
of the files and the location that is set.
</td>
</tr>
<tr>
<th>Default Location</th>
<td>
<figure class="figure float-end m-3">
<img src="Help/amend file.png"
alt="The context menu accessed from the filename contains options to amend the file's start time and the recording location"
class="rounded figure-img float-end img-fluid">
<figcaption class="figure-caption text-muted text-end">File name context menu.</figcaption>
</figure>
Set the default location to use for calculating the start and end of civil twilight. This setting can be overriden for individual files by assigning a custom location in the filename context menu.
</td>
</tr>
<tr>
<td colspan="2" class="text-center text-bg-light"><h5>System</h5></td>
</tr>
<tr>
<th>Language</th>
<td>Choose the language for the "common name" labels, where translations exist. The translated labels have been obtained from <a href="https://ebird.org/home" target="_blank">eBird</a>.
<ul>
<li>If you wish to apply a new translation, or modify a bird's name you can use a custom list. The will be read from the custom list file and names updated if you select "Custom" from the Language dropdown.
<br /><b>N.B.</b> You cannot change the call type label, this should remain one of (call), (flight call) or (song).
</li>
</ul>

<td>
Choose the language for the "common name" labels, where translations exist. The translated labels have been obtained from <a href="https://ebird.org/home" target="_blank">eBird</a>.
</td>
</tr>
<tr>
<th>Backend</th>
<td>Choose how predictions are calculated on you computer.
<td>This option is only visible when using the Chirpity model. Choose how predictions are calculated on you computer.
<ul>
<li>
<b>CPU</b> will use the CPU for predictions, this is generally faster if you have an integrated
Expand All @@ -103,7 +111,7 @@
</tr>
<tr>
<th>Batch Size</th>
<td>This setting determines the number of three-second audio chunks to process each time a prediction is requested.
<td>This setting determines the number of three-second audio chunks to process for each model request.
Larger values lead to faster processing, especially on long files.
</td>
</tr>
Expand All @@ -115,31 +123,43 @@
</td>
</tr>
<tr>
<td colspan="2" class="text-center text-bg-light"><h5>Location</h5></td>
<td colspan="2" class="text-center text-bg-light"><h5>Audio Preferences</h5></td>
</tr>
<tr>
<th>Default Location</th>
<td><b>Volume Adjustment</b></td>
<td>If your recordings are very quiet, you can increase the loudness of the audio by adding gain. The volume of audio can be increased by up to 50 decibels.</td>
</tr>
<tr>
<td><b>Normalise audio</b></td>
<td>
<figure class="figure float-end m-3">
<img src="Help/amend file.png"
alt="The context menu accessed from the filename contains options to amend the file's start time and the recording location"
class="rounded figure-img float-end img-fluid">
<figcaption class="figure-caption text-muted text-end">File name context menu.</figcaption>
</figure>
Set the default location to use for calculating the start and end of civil twilight. This setting can be overriden for individual files by assigning a custom location in the filename context menu.
If enabled, the levels in the audio file will be normalised. In simple terms, this will maximise the volume range between the quietest and loudest sounds.
The effect will ensure all audio plays at a similar volume, and vocalisations in quiet audio files will be easier to hear.
</td>
</tr>
<tr>
<td colspan="2" class="text-center text-bg-light"><h5>Audio Preferences</h5></td>
<th>High Pass filter</th>
<td> This applies a filter to the audio, removing the sound below the frequency selected.
Intended primarily for recordings made in in urban settings, this will reduce the level of low-frequency hum.
</td>
</tr>
<tr>
<td><b>Volume Adjustment</b></td>
<td>If your recordings are very quiet, you can increase the loudness of the audio by adding gain. The volume of audio can be increased by up to 50 decibels.</td>
<th>Low Shelf filter</th>
<td> This applies an audio filter similar to the High Pass filter, however, rather than simply remove noise, it reduces the volume of low frequency noise.
The advantage of a low shelf filter is that you can reduce the hum, whilst still being able to hear species which have low frequency calls.
You can set the threshold frequency, and the strength of the filter to apply (Attenuation).
</td>
</tr>
<tr>
<td colspan="2" class="text-center text-bg-light"><h6>Audio Export</h6></td>
</tr>
<tr>
<td><b>Format and Bitrate</b></td>
<td>Choose from lossless or lossy formats for the audio clips you export from Chirpity.</td>
</tr>
<tr>
<td><b>Convet to mono</b></td>
<td>Combine stereo tracks to a single channel. This will result in smaller file sizes.</td>
</tr>
<tr>
<th>Decorators</th>
<td>These two options can be used to:
Expand All @@ -158,7 +178,7 @@
</tr>
<tr>
<td><b>Colourmap</b></td>
<td>Choose the colour map for the spectrogram display</td>
<td>Choose the colour theme for the spectrogram display</td>
</tr>
<tr>
<th>Timeline</th>
Expand All @@ -169,39 +189,53 @@
</li>
<li>
<b>Time of Day</b> relies on file timestamps to determine the actual time of detected calls.
If a file's timestamp does not reflect the recording time, the readonig will be inaccurate.
If a file's timestamp does not reflect the recording time, the reading will be inaccurate.
To edit the start time of the current file, set the desired date and time using the filename context menu.
</li>
</ul>
</td>
</tr>

<tr>
<td colspan="2" class="text-center text-bg-warning"><h5>Advanced Features</h5></td>
<td colspan="2" class="text-center text-bg-light"><h5>Advanced</h5></td>
</tr>
<tr>
<th>Send Filtered Audio for Analysis</th>
<td>
By default, the filter settings in the Audio Preferences are just used to modify the audio in the application interface. If you enable this setting,
the modified audio will be used for analysis. This is usually a bad idea, as it impairs the accuracy of the models in most situations. However, if your
recordings have a considerable amount of low frequency noise, it <i>may</i> be that modifying the audio using these filters will improve the models' ability to
make accurate detections.
</td>
</tr>
<tr>
<th>Context Mode</th>
<td> In this mode, Chirpity will use the surrounding context when making predictions. This helps mitigate
<td> This mode is only available for the native Chirpity model. When enabled, the model will use the surrounding context when making predictions. This helps mitigate
against false positive detections.
</td>
</tr>
<tr>
<th>SNR filter</th>
<td>The SNR (Signal to Noise Ratio) filter can only be enabled when using the CPU backend. When enabled, Chirpity will disregard audio segments with no distinct sound event.
<td>This setting is also only avaliable for the native Chirpity model. The SNR (Signal to Noise Ratio) filter can only be enabled when using the CPU backend.
When enabled, Chirpity will disregard audio segments with no distinct sound event.
A stronger signal is required for a prediction to be attempted when higher signal-to-noise values are set.
The purpose is to deliver significant speed gains, however, the setting may cause Chirpity to miss quieter, more distant calls.
</td>
</tr>
<tr>
<th>High Pass filter</th>
<td> This applies a filter to the audio, removing the sound below the frequency selected.
Intended primarily for recordings made in in urban settings, this is desirable to compensate for strong low-frequency noise which is not present in the training data.
<th>Debug mode</th>
<td>
If you have encountered an issue while using Chirpity, you can enable debug mode. When you change this setting, you will need to quit and relaunch the application
for the change to take effect. When launched in debug mode, two windows will open, and each will print debugging information to a console on the right of the window.
This is <b>extremely </b> useful if you want to report a bug - as you can share a screenshot of any errors that appear (these will show up in red in the console).
</td>
</tr>
<tr>
<th>Low Shelf filter</th>
<td> This applies an audio filter similar to the High Pass filter, however, rather than simply remove noise, it reduces the volume of low frequency noise.
You can set the threshold frequency, and the strength of the filter to apply (Attenuation).
Also intended for recordings made in in urban settings, this helps tune the audio to the noise profile of the training data.
<th>Opt out of usage analytics</th>
<td>
Chirpity sends usage information anonymously to an analytics server. This information is used to help understand how people use Chirpity, and try to identify any bugs
or errors. Both help improve the software and prioritise changes for future releases. If you would prefer that Chirpity did not send any usage data, you can disable it here.

</td>
</tr>
</table>
Expand Down
16 changes: 8 additions & 8 deletions Help/usage.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ <h4 class="text-center bg-dark text-white p-3">Suggested Workflow</h4>
<ol>
<li>Open an audio file or files. There are a three ways to do this:
<ol>
<li>Right-click on the audio file(s) in Windows Explorer and select "Open with" > Chirpity Nocmig</li>
<li>In the Chirpity Nocmig application, select File > Open Audio File or press Ctrl-O and select the
<li>Right-click on the audio file(s) in Windows Explorer and select "Open with" &gt; Chirpity Nocmig</li>
<li>In the Chirpity Nocmig application, select File &gt; Open Audio File or press Ctrl-O and select the
files to open</li>
<li>Drag and drop the files or folders onto the Chirpity Nocmig application</li>
</ol>
Expand Down Expand Up @@ -74,7 +74,7 @@ <h4 class="text-center bg-dark text-white p-3">Suggested Workflow</h4>
If active, Nocmig mode is temporarily disabled for the Analysis of selections.
</li>
<li>
Having determined whether to use Nocmig mode, select &quot;<i>Analyse entire file</i>&quot; from the
Having determined whether to use Nocmig mode, select &quot;<i>Analyse file</i>&quot; from the
<b>Analysis</b> menu. Depending on the file length, this may take several minutes. A progress indicator will
appear as a guide to how long this is likely to take. To stop the analysis at any point, press the
<b>Esc</b>
Expand Down Expand Up @@ -123,7 +123,7 @@ <h5 class="pt-2">Custom "Deep Dive" Detections</h5>
relation
to the call. The window can be moved by dragging it, or you can create a new window by clicking and
dragging out a custom region on the spectrogram. Once you have a new region, select
<span class="material-symbols-outlined">search</span> <b>Analyse</b> from the context menu or <b>Analysis >
<span class="material-symbols-outlined">search</span> <b>Analyse</b> from the context menu or <b>Analysis &gt;
Analyse
selected interval</b> from the menu.
The detections for the selected region appear in an overlay window and can be saved to the results or
Expand All @@ -134,7 +134,7 @@ <h5 class="pt-2">Custom "Deep Dive" Detections</h5>
<h5 class="pt-2">Amending Results</h5>
<ol start="8">
<li>It is possible to remove results from what will be saved by selecting <span
class='delete material-symbols-outlined'>delete_forever</span> <b>Delete Record</b> in the context menu.
class="delete material-symbols-outlined">delete_forever</span> <b>Delete Record</b> in the context menu.
This can be selected on a per-detection basis in the results table, or a per-species basis in the summary.
</li>

Expand All @@ -143,7 +143,7 @@ <h5 class="pt-2">Amending Results</h5>
<h5 class="pt-2">Saving Results</h5>
<ol start="9">
<li>Once the analysis is complete, and after you have made any amendments, you can save the results to a
database by selecting <b>Records > <span class="material-symbols-outlined">archive</span> Save to Archive </b>
database by selecting <b>Records &gt; <span class="material-symbols-outlined">archive</span> Save to Archive </b>
</li>
</ol>

Expand All @@ -160,10 +160,10 @@ <h5 id="reload" class="pt-2">Restoring Results</h5>
<p>From the records menu, you can also browse saved detections by species, and within a date range of your choosing.
Furthermore, you can generate charts of the species detected over time.</p>

<h5 id="reload" class="pt-2">Exporting Results</h5>
<h5 id="export" class="pt-2">Exporting Results</h5>
There are a number of ways to export detections.
<ol>
<li>Save the detections as a label file in Audacity format. Press <b>Ctrl-A</b> or select <b>File > Save
<li>Save the detections as a label file in Audacity format. Press <b>Ctrl-A</b> or select <b>File &gt; Save
Audacity Labels</b> from the menu. By default, the label file will have the same name as the
audio file,with a ".txt" extension.
</li>
Expand Down
3 changes: 3 additions & 0 deletions css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -557,6 +557,9 @@ input[type="range"].vertical {
--bs-offcanvas-width: 450px; /* Change the width as desired */
}

.offcanvas-backdrop {
display: none !important;
}

#settingsMap {
height: 300px;
Expand Down
Loading

0 comments on commit 35ea33b

Please sign in to comment.