Skip to content

Getting Started

Alba Solsona edited this page Apr 4, 2019 · 51 revisions

The DetEdit repository contains two dataset examples of odontocete acoustic data for testing and learning how to use the interface.

Sample DetEdit files can be found at https://drive.google.com/drive/folders/0B1N3RJM5Uw4ha25lVEhLRF9FMUk

Case study: Sperm whale (Physeter macrocephalus)

The following steps will guide you through an example of sperm whale detections and how to annotate embedded dolphin detections as false positive detections. You can get a quick view of the Editing tools that are available for annotating detections.

  1. Specify your data settings
  2. Launch the interface
  3. Scan bouts of detections
  4. Inspect acoustic parameters from batches of detections
  5. Annotate batches of detections as false positives
  6. Annotate batches of detections as true positives (misidentified)

1. Specify your data settings

An example data setting script to demonstrate the parameters used to annotate sperm whale acoustic data is provided in DetEdit\Settings folder.

Open spermwhaleSettings or use the Command Window in MATLAB as follows:

> edit spermwhaleSettings

and modify the directory tpwsDir corresponding to your folder location:

tpwsDir = 'E:\detEditexamples\Spermwhale_Test_Set'; % identify  folder containing TPWS files

2. Launch the interface

Invoke the interface as follows:

> detEdit(@spermwhaleSettings)

Progress information will be displayed in the Command Window and you will be asked to specify the Starting session, use 1 to start with the first bout.

Once the different panels of the interface are open, you can arrange them as you wish for better visualization.

brushing_typing

3. Scan bouts of detections

Once the interface is open, you can move from one bout to another by using the keyboard shortcut: space

brushing_move_window

4. Inspect acoustic parameters from batches of detections

Select batches of detections using the MATLAB's brushing tool as follows:

  • activate the brush by pressing the panel you want to brush and then press p. Brush button will appear selected.
  • select detections by flagging the area of interest (highlighted in yellow).
  • press u to update window. Selected detections will be highlighted in black, as well as averaged sound pressure waveform and power spectra of the selected batch of detections.
  • press u again to update window and selection is removed.

brushing_highlight

5. Annotate batches of detections as false positives

A specified threshold for peak frequencies and RMS is displayed, which automatically annotates data lower than the specified values as false positive detections.

Annotate batches of detections as false positives using the MATLAB's brushing tool as follows:

  • activate the brush by pressing the panel you want to brush and then press p. Brush button will appear selected.
  • select detections by flagging the area of interest (highlighted in yellow).
  • press r to annotate selection as false positive, detections will be displayed in red as well as averaged sound pressure waveform and power spectra of the annotated detections. Detection times will be automatically saved in the corresponding *FD.mat file.

brushing_redflag

6. Annotate batches of detections as true positives (misidentified)

While brushing for false detections, few detections a the beginning of the bout have been annotated as false. It is possible to reverse the annotation to true positives as follows:

  • activate the brush by pressing the panel you want to brush and then press p. Brush button will appear selected.
  • select detections by flagging the area of interest (highlighted in yellow).
  • press g to annotate selection as true positive, detections will be displayed in blue again. Detection times will be automatically saved again in the corresponding *TD.mat file.

brushing_trueflag

Once the data has been annotated, detections can be cleaned or parsed out into sets using modDet or custom scripts. See End-to-End examples section for more details.

Case study: Dolphins' species

  1. Specify your data settings
  2. Launch the interface
  3. Annotate batches of detections with ID color code

1. Specify your data settings

An example data setting script to demonstrate the parameters used to annotate sperm whale acoustic data is provided in DetEdit\Settings folder.

Open dolphinSettings or use the Command Window in MATLAB as follows:

> edit dolphinSettings

and modify the directory tpwsDir corresponding to your folder location:

tpwsDir = 'E:\detEditexamples\Dolphin_Test_Set'; % identify  folder containing TPWS files

2. Launch the interface

Invoke the interface as follows:

> detEdit(@dolphinSettings)

3. Annotate batches of detections with ID color code

brushing_colors

Clone this wiki locally