Recent Releases of pamguard

pamguard - Version 2.02.17 June 2025

DOI

New Features

Improved Error Trapping and Reporting. Added features to the PAMGuard core data handling to trap any errors in each module and better log them in the PAMGuard log files. When PAMGuard starts, it will automatically analyse the log file from the previous run for errors. If errors are found, then the user will be prompted to send a report to the PAMGuard team via email. See help on log files for further details.

Issue 211. Noise Band Measurement module (the one that uses filter banks). Added features to support other types of frequency band as well as standard octave and third octave. PAMGuard now supports Octave, Third Octave, Deci-decade, Decade, 1/10 Octave, and 1/12 Octave bands.

Issue 211. Noise Monitor Module (the one that used FFT data). Added 1/10 decade, Octave, and Decade bands options. Improved data selection handling.

Issue 215. x.wav Files. Support for duty cycling with .x.wav files from SCRIPPS HARP recorders.

Export function for noise band data to Matlab, R, etc.

Bug Fixes

Issue 207. Marked clicks in click detector not rematching when data reloaded. This was occurring when multiple clicks had the same millisecond time and has now been rectified.

Tethys deployments table. Deployments table in Tethys was showing multiple lines for duty cycled data. Duty cycled data will now display as a single row of data in the Deployments table on the display.

Issue 210. SUD Files. Fixed several issues: support for multi channel files; handling corrupt files; reloading audio data for spectrogram displays in viewer.

Issue 230. Updated SUD reader to handle latest soundtrap firmware that supports accelerometers and magnetometers.

Issue 220. Fixed spectrogram scrolling issues in Spectrogram and FX Time display.

Issue 216. GEBCO Raster map files not loading. Issue now fixed.

Issue 232. Files without dates. Will now correctly process a folder of files without dates. However, you are strongly recommended to have valid dates in your file names.


Release Notes for all versions

- Java
Published by douggillespie 9 months ago

pamguard - Version 2.02.16 March 2025

DOI

New Features

Updates to Tethys Interface

Updates to compatibility with Tethys Server version 3.2 beta 2 and Nilus 3.2. PAMGuard is no longer compatible with Tethys 3.1, the pre-release version.

Added Tethys functionality for the following modules: Whistle Classifier, Detection Group Localiser, Rocca, Click Train Detector, GPL Detector. If the Detection Group Localiser is used with Logger Form annotations, species codes can be taken from the logger form.

Made export of data (Calibrations, Deployments, Detections, and Localisations) available as ‘offline tasks’. This is not useful when running Tethys on a single dataset, since all tasks can be easily performed using ‘Export’ buttons on the main Tethys interface. However, this change means that these export tasks become available to the batch processor (Version 2.0 or above) which can be used to export data from multiple similar datasets without having to personally go into each one individually. See Tethys online help pages and help pages for the Batch processor for details.

Deep Learning Classifier

Better error dialogs to indicate when models are incorrect and when the libraries have not been installed correctly.

DelphinID Whistle classifier support now implemented.

Other

Made click detector offline click event data integrity checking available as offline task, so that this can be run prior to exporting data to Tethys.

Multiple management changes to support batch processing of offline tasks. Compatible with batch processor 2.0.

Added clip display for Deep Learning module.

Added optional display of impulse response function to IIR Filter design dialog in place of the pole-zero diagram.

Added ROCCA graphics, so ROCCA output can be displayed on the spectrogram display.

Bug Fixes

Issue 190. Array Files exported from array manager were not automatically getting the correct file end, making the exported files impossible to use. This is fixed and files will get the correct .paf end.

Issue 167. File counter not resetting when restarting PAMGuard if it was paused during processing of folders of offline files. This has been updated to that a popup menu on the start button will allow you to continue from where you left off, or restart from the beginning.

Issue 165. When re-opening folder selection dialog for processing folders of offline files, the folder name would be added a second time, meaning you got an invalid file path. This has been fixed.

At startup FFT Module checks channel list against incoming channel list from acquisition module and automatically removes channels that were selected in the FFT module, but are not available from the acquisition.

Dealt with issue in Tethys module looking up ITIS species codes where the progress dialog would not close.

Project Information abstract field was not saving / reloading correctly in the configuration file. Fixed.

Small bugs in FX Time display to improve settings pane.

Fix offline file scanning in Acquisition when sub folder button checked / unchecked.

- Java
Published by douggillespie 11 months ago

pamguard - Version 2.02.15 December 2024

Version 2.02.15 December 2024

DOI

First official release for MacOS11+, ARM Processors (Mac version to follow in the comind days)

New Features

Added ability to export click events to the exporter.

Updates to deep learning module to deal with group detections.

New icons and graphical user interface style for Mac.

Bug Fixes

Fixed important timing bug that affected offline analysis when there was a gap in data, causing certain binary files before the gap to be closed with an incorrect end time.

Fixed issue #177 with clip generator dialog always reverting to first available input source.

Removed unnecessary text output from DL classifier module.

Fixed units on spectrogram displays for air based measurements.

Fixed bug in whistle and moan detector graphics that caused whistles with branches to not draw.

- Java
Published by douggillespie about 1 year ago

pamguard - PAMGuard version 2.02.14

Version 2.02.14 October 2024

New Features

Rocca update: Ability to specify whether strong whistle/encounter threshold is applied as an absolute value, or as the difference between the highest and second-highest votes.

Tethys: Export of Group3D Localiser data

Bug Fixes

Ishmael Matched Filter detector. Improved correlation algorithm to use correct data normalisation (and a faster FFT).

Ishamel detector graphics. Improved graphics (spectrogram plugins) to work when scrolling the spectrogram and to have better automatic scaling.

Folder processing: At startup, while PAMGuard catalogues the sound files, a progress bar is shown. This doesn’t change anything, or speed up the process, but does at least let the user know what’s happening (Issue 156).

No sound card ? If no sound cards are present on your computer (or if no headphones are attached, even though a sound card is present) when processing files offline, PAMGuard will still slow the analysis rate as it would if a soundcard were present.

Click Detector click selection on the display. Fixed issue with wrong click being selected when display was highly zoomed in (Issue 158).

File processing. Sometimes only processing last file when reprocessing data (issue 162).

Added ability for exporter to read annotations. Added ability to export CPOD and FPOD data.

Fixed various bugs in CPOD and FPOD displays and importer. Updated CPOD help file.

- Java
Published by douggillespie over 1 year ago

pamguard - PAMGuard Version 2.02.13

Version 2.02.13 August 2024

New Features

Deep Learning Classifier. Major upgrade to support for Deep Learning models in PAMGuard. See online help for details.

Click detector: Remembers locations of displays and doesn’t continually reset them.

Help for Matched Click Classifier.

Project information dialog. This allows capture of essential project information to store with your data. See menu item Settings/Project information.

‘Effort’ management system. New map options allow colouring of track line by ‘effort’ from various other modules. This is currently the acquisition system (so the track will change colour when PAMGuard is running), the binary store system (likely the same as the acquisition) or data from Logger forms. This system will be extended to other modules in the near future.

Added a new exporter which allows users to export data to .mat (MATLAB, Python), .RData (open in R) or .wav files (open in Sonic Visualiser, Audacity etc.) Tethys Database

Many users will be aware that we’re integrating an interface to the Tethys Database into PAMGuard. Some basic features are available for testing. If interested, please contact the PAMGuard support team.

Bug Fixes

Linking clicks to offline clicks table. We had a database that had become corrupted so added code to relink offline clicks to their corresponding clicks from binary data.

Drawing non-acoustic data: Data that were not associated with any hydrophones, e.g. visual sightings in Logger forms were not drawing on the map. This fixed and PAMGuard will use the vessels GPS position as reference.

Lookup tables: fix feature which was causing table entries to repeat.

Click Train Detector: Add exception handlers to avoid errors as PAMGuard stops / restarts.

Group Detection starts and ends: Check data integrity function fixed and now inserts correct times of start and ends of events into database.

Clip generator. Changes to ensure PAMGuard keeps audio data long enough to make clips. In some circumstances data were being discarded too early so clips could not be created.

Acquisition “Skip initial seconds” feature, designed to remove high sample levels e.g. from calibration tones at start of a soundtrap recording was not working with the click detector. This is fixed but replacing all data with 0’s and still sending data. Note that this may lead to artificially low noise measures at the start of a file.

Data reprocessing options. Updated to ensure that the option "Start normally. Note risk of overwriting!" is always available. Also improved code naming binary files to attempt to push them to exact times, rather than a couple of seconds after the hour.

improved code naming binary files to attempt to push them to exact times, rather than a couple of seconds after the hour.

Updated icons to improve display on high definition screens.

SAIL Daq Card. Automatic restart when DAQ card stalls (happening increasingly often with latest Windows updates)

- Java
Published by douggillespie over 1 year ago

pamguard - V2.02.10

Version 2.02.10 January 2024 New Features

Importing modules from other configurations: New options from file menu allowing import of specific modules, or module settings from other configurations. E.g. if you had three similar configurations and had set one of them up with a new detector, or got the click classifier settings set up just right in one of those configurations, you can import the additional modules or the click detector settings easily into the other configurations.

Improved SUD (soundtrap compressed files) file performance when scrolling through audio data in Viewer mode.

Viewer Launch by right clicking on sqlite database and selecting “open with / Pamguard ViewerMode” launcher menu option. Bug Fixes

Logger Forms

Boolean (logical true/false, yes/no) data were not showing correctly in Viewer mode. Now fixed

Data selectors for plotting on map were not working, also fixed

Bearing localizer running offline was not correctly saving updated bearings to the database. Now fixed.

ROCCA Classifier fixes

Allow Rocca to run without classifiers: Fixed bug that threw an error if no classifier files were specified in Rocca Params dialog

Fix memory issue with RoccaContourDataBlocks not being released for garbage collection

Set RoccaContourDataBlock objects to null and stop PamObserver Timer to

force release

Fix problem tracing whistles in Rocca spectrogram pop-up: Whistle and raw data were being cleared before the user had time to trace out the whistle, causing PAMGuard to throw an exception. Both were already being cleared when the pop-up window is closed, so no need to do it here.

DIFAR Module: Bug crashing the module with null pointer errors fixed.

Whistle Detector: Fixed bug which caused the detector to slow to almost zero speed when large complex sounds with many branches were detected.

Click Detector Offline Event Marking: Fixed problem of events not being correctly deleted and also of clicks not being correctly reassigned to different events.

Screen Position: When using multiple monitors, if you move a configuration to a computer with a different monitor layout, the GUI should work out if it’s opening on a screen area which no longer exists and move itself onto the primary monitor.

File Folder Processing: Previous version had a bug which caused files to not always be sorted into the correct order for processing. This caused some instability in some detectors, causing memory leaks when new data arrived with time stamps earlier than already processed data in memory. This is now fixed – files are ow correctly sorted alphabetically by file name, i.e. not including the name of the folder containing the files.

- Java
Published by douggillespie about 2 years ago

pamguard - V2.02.09

Version 2.02.09 June 2023 Bug Fixes

Time zone displays: Fixed some bugs associated with options to have PAMGuard display times in local time, rather than UTC. This was affecting times typed into the scroll bars of displays which were reading local time, even when set to use UTC.

Version 2.02.08 May 2023 Bug Fixes

ROCCA Memory Leak: A memory leak in ROCCA, which mostly occurred when processing large datasets of many offline files, has been fixed.

Data Map: “Scroll To Data” pop-up menu, which didn’t always scroll to the correct place, is now fixed.

Bearing Localiser offline: If reprocessing bearings, the localizer was not correctly loading required raw or FFT data to input to the cross correlation algorithm. This is now fixed so that you can reprocess bearings in viewer mode.

Map files: Added additional exception handlers to handle corrupt map files.

New Features

Restart Options: When you restart processing of offline files, if output data already exist (binary data of within database tables) you will be asked if you want to overwrite the data, cancel, or try to continue from where to left off.

Updated SoundTrap sud file interface so that PAMGuard now extracts and stores the Click Detector settings from the sud files and stores them within the PAMGuard configuration. This does not affect processing, but is important for record keeping.

GPS options to use any valid RMC or GGA string. Not all GPS receivers output their RMC data as GPRMC – e.g. some may output as GNRMC. A new option allows the GPS module to use any string, whatever the first two characters of the string name may be.

- Java
Published by douggillespie over 2 years ago

pamguard - V2.02.07

Latest Version 2.02.07 January 2023 Bug Fixes

Use of localization sensor and orientation data for static hydrophones had a bug whereby it would continually ‘forget’ angle offsets applied to static hydrophones in viewer mode. This is now fixed.

Click tool bar: Correctly shows event selection options even if no species classification options are in place.

Fixed Landmarks: Earlier versions were ‘losing’ these every time PAMGuard started or new data were loaded in viewer mode. Now fixed.

ROCCA: Fixed (another) memory leak which caused PAMGuard to crash when processing large data sets with the ROCCA classifier.

Ishmael Modules: Fixed bug which occasionally caused crashes when processing many files offline.

PAMDog: Fixed bug in watchdog program which was trying to start PAMGuard before modules were fully loaded. The watchdog now correctly waits until modules are loaded before attempting to start PAMGuard processing.

New Features

New sound type for simulated sounds which generates random chirps between around 200 and 800Hz, roughly the frequency you’d expect sound from higher frequency baleen whales, such as humpbacks, to vocalise at.

Hiding tool tips. A menu item to permanently turn off all tool tips, or tap the ‘Esc’ key to turn them off for 6 seconds if they are getting in the way, particularly when trying to interact with displays using the mouse.

- Java
Published by douggillespie about 3 years ago

pamguard - V2.02.06c

Interim release with additional simulator for lowish frequency baleen whales (200Hz to 1kHz) Bug fix of static objects.

- Java
Published by douggillespie about 3 years ago

pamguard - V2.02.05

Version 2.02.05 October 2022 Click Train Detector Features and Bug Fixes Features Changes to GUI to make dialog shorter for low DPI screens. Complete rewrite of the classification system to have nested classifiers which can be enabled or disabled. Changes to classification GUI to accommodate the new classification system. Addition of data selectors to the minimum number of clicks accepted by the classifier. This allows the click-by-click classifier and the click train detector to be used to together to improve classification accuracy. Bug fixes Click detection bug fix in kernel which improved click fragmentation. Bug fix to database were JSON data from classifier was being trimmed. Documentation Comprehensive help file including description of the algorithm, screen grabs and examples.

Other Features Help documentation for Backup Manager Help documentation for Matched Click Classifier Database logging of offline tasks (such as click re-classification, bearing calculation, etc.) Data selector for Whistle Classifier module Variable sound output level when using National Instruments devices for sound playback. Speed improvement when processing flac audio files. Bug Fixes Soundtrap DWV import. Will now generate binary files even if DWV file doesn’t exist (which is correct behavior in quiet conditions when no clicks were detected). Spectrogram. Changes to stop occasional crashing when restarting processing of wav files. Sizing of dialogs on ultra high definition monitors so that data fields are sized correctly. Fixed a memory leak in ROCCA Fixed issues with options in Click Detector bearing time display which (when using planar and 3D arrays) allow you to plot relative to the array, the vessel, or North.

- Java
Published by douggillespie over 3 years ago

pamguard - V2.02.03

Version 2.02.03 February 2022

Some minor bug fixes following our migration to GitHub. Note that the older Bug numbers only refer to bugs reported on the SVN site. New bugs and issues are logged on GitHub at https://github.com/PAMGuard/PAMGuard/issues. GitHub issue number are referred to with a # symbol

6 Threading Hydrophone Locator: was not working correctly in the latest release V2.02.02. The problem was particularly apparent in Viewer mode but may have given false array locations in normal mode under some circumstances. This has been fixed

11 Matched Click Classifier: fixed bug which caused crash running in real time. Added template names based on file names.

13 Merging files when offline processing file folders: Had an error introduced in last release which caused it to fail to recognise gaps between files, meaning that some output data (i.e. after a gap) would have an incorrect time stamp. This did not affect data if the ‘merge contiguous files’ option was not selected.

14 Logger forms data were not plotting correctly. This was due to the required data selection functions not being fully implemented. This is now fixed and it should be possible to select what to plot based on selections from drop down lists within any form.

- Java
Published by douggillespie about 4 years ago