From 503093cc908161581906577f25b46d1c3cd1a32b Mon Sep 17 00:00:00 2001 From: Douglas Gillespie <50671166+douggillespie@users.noreply.github.com> Date: Mon, 24 Jun 2024 13:43:02 +0100 Subject: [PATCH] Updated readme --- README.html | 201 ++++++++++++++++++++++++++++++---------------------- 1 file changed, 117 insertions(+), 84 deletions(-) diff --git a/README.html b/README.html index e30e19e0..de87a55b 100644 --- a/README.html +++ b/README.html @@ -467,14 +467,26 @@ name="_Latest_Version_2.02.08">Version 2.02.11 May 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

+

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.

+ +

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

@@ -497,14 +509,32 @@ as PAMGuard stops / restarts.

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.

+ +

Updated icons to improve display on high definition screens. +

+

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 +lang=EN-US> 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.

@@ -593,8 +623,8 @@ were reading local time, even when set to use UTC.

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.

+

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 @@ -694,8 +724,8 @@ details.   

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.

+

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.

@@ -786,9 +816,9 @@ selections from drop down lists within any form.

 

-

Note that updates have also been made to the Matlab -interface to PAMGuard binary files, which has now also been migrated to GitHub -at https://github.com/PAMGuard/PAMGuardMatlab. +

Note that updates have also been made to the Matlab interface +to PAMGuard binary files, which has now also been migrated to GitHub at https://github.com/PAMGuard/PAMGuardMatlab.

 

@@ -803,8 +833,9 @@ the TF FX display to crash if no data were displayed.

See major release notes for V 2.02.01 below.

-

Bug 495: TD FX display throws NullPointerException -if user has removed all data units and then moves mouse over display area.

+

Bug 495: TD FX display throws +NullPointerException if user has removed all data units and then moves mouse +over display area.

Version 2.02.01 October 2021

@@ -992,8 +1023,9 @@ help.

If you are upgrading from a PAMGuard core release (1.15.xx), PAMGuard Version 2 contains major updates. You should read and -understand the notes listed for Beta Version -2.00.10 before proceeding with installation and use of this version.

+understand the notes listed for Beta +Version 2.00.10 before proceeding with installation and use of this +version.

This version of PAMGuard has been bundled with Java 13 (release 13.0.1). PSFX files generated in previous beta releases (2.xx.xx) @@ -1102,11 +1134,11 @@ understand the notes listed for Beta Version 2.00.10 before proceeding with installation and use of this version.

-

This version of PAMGuard has been bundled with Java 13 (release -13.0.1). PSFX files generated in previous beta releases (2.xx.xx) should be -compatible with this version, and vice-versa. PSF files generated in core -releases (1.15.xx) can be loaded in this version, but will be converted to PSFX -files when PAMGuard exits.

+

This version of PAMGuard has been bundled with Java 13 +(release 13.0.1). PSFX files generated in previous beta releases (2.xx.xx) +should be compatible with this version, and vice-versa. PSF files generated in +core releases (1.15.xx) can be loaded in this version, but will be converted to +PSFX files when PAMGuard exits.

Bug Fixes

@@ -1445,9 +1477,9 @@ Detector display.

1.        This version of PAMGuard has been upgraded to make it compatible -with Java 12. psfx files generated in previous beta releases should be -compatible with this version, and vice-versa.

+lang=EN-US> This version of PAMGuard has been upgraded to make it +compatible with Java 12. psfx files generated in previous beta releases should +be compatible with this version, and vice-versa.

2.        @@ -1527,9 +1559,9 @@ with installation and use of this version.

1.        -Bug 413. Binary file crashing during load, after a system failure. Failure -could cause the file to become corrupt, which caused a crash during subsequent -load

+Bug 413. Binary file crashing during load, after a system failure. +Failure could cause the file to become corrupt, which caused a crash during +subsequent load

2.        @@ -1742,8 +1774,8 @@ with installation and use of this version.

1.        -Bug 338. Problem displaying coastlines and bathymetric contours around the -dateline (+/- 180 longitude) in the map.

+Bug 338. Problem displaying coastlines and bathymetric contours around +the dateline (+/- 180 longitude) in the map.

2.        @@ -2325,14 +2357,14 @@ lang=EN-US> 

1.       -Bug 317. Rocca Module Data Purging. The ROCCA -module was not performing data purging when using classifiers developed for Hawaii/Temperate -Pacific/North Atlantic datasets. This has been corrected.

+Bug 317. Rocca Module Data Purging. The ROCCA module +was not performing data purging when using classifiers developed for +Hawaii/Temperate Pacific/North Atlantic datasets. This has been corrected.

2.       -Bug 320. Pamguard stopped reading Click Detector Event data from database -when target motion analysis information was encountered. Corrected.

+Bug 320. Pamguard stopped reading Click Detector Event data from +database when target motion analysis information was encountered. Corrected.

3.       @@ -2437,9 +2469,9 @@ jar file will be required rather than a new bespoke PAMGuard installation.here.  Plug-in modules can be downloaded from the PAMGuard -website here, but developers are encouraged to host and maintain their own -modules.

+target="_blank">here.  Plug-in modules can be downloaded from the +PAMGuard website here, but developers are encouraged to host and maintain their +own modules.

Modules of interest to the general PAM community will remain as part of the core PAMGuard installation. However, @@ -2466,9 +2498,9 @@ dependencies)

Other Changes

-

The installer has been updated to handle -both 64 bit and 32 bit installations. PAMGuard psf files are now registered in -the Windows Registry, so double-clicking on a psf file should run PAMGuard in +

The installer has been updated to handle both +64 bit and 32 bit installations. PAMGuard psf files are now registered in the +Windows Registry, so double-clicking on a psf file should run PAMGuard in normal mode (as opposed to Viewer or Mixed modes). Note that the Windows Registry can only hold a single executable reference for psf files; therefore, for users with multiple installations of PAMGuard, double-clicking on a psf @@ -2607,8 +2639,8 @@ lang=EN-US>3.4.        -Bug 290. Click bearings on spectrogram display plug in -were reversed if the first hydrophone was behind the second hydrophone in the +Bug 290. Click bearings on spectrogram display plug in were +reversed if the first hydrophone was behind the second hydrophone in the configuration. This is now fixed so that it displays the same bearings as the main click detector display.

@@ -2699,10 +2731,10 @@ since V 1.15.03:

1.        -Bug 272. File types: Some File Open / File Save dialogs were allowing -selection of all file types. e.g. Save Configuration As, Section of whistle -classifier training file, Map file Selection, These have now been changed so -that only the correct type of file can be selected.

+Bug 272. File types: Some File Open / File Save dialogs were allowing selection +of all file types. e.g. Save Configuration As, Section of whistle classifier +training file, Map file Selection, These have now been changed so that only the +correct type of file can be selected.

2.        @@ -2935,9 +2967,9 @@ See the help file for details.

lang=EN-US style='font-size:7.0pt;font-family:"Times New Roman",serif'>       Feature Request 45. Click classification settings -export / import. Click classification settings can be exported individually to files -and imported into other click detector configurations. See the help file for -details.

+export / import. Click classification settings can be exported individually to +files and imported into other click detector configurations. See the help file +for details.

3.       @@ -3094,9 +3126,9 @@ option with caution !

5.              -The Open Office Database system has been removed from the list of -available options since it is not reliable. If you require a free database -solution we recommend you use the MySql Community Server The Open Office Database system has been removed from the list of available +options since it is not reliable. If you require a free database solution we +recommend you use the MySql Community Server http://dev.mysql.com/downloads/mysql/

8.              -Bug 230. Click Bearing Display. With a two hydrophone system, -clicks calculated to have a bearing of exactly 180 degrees would be displayed -at 0 degrees on the bearing time display.

+Bug 230. Click Bearing Display. With a two hydrophone +system, clicks calculated to have a bearing of exactly 180 degrees would be +displayed at 0 degrees on the bearing time display.

 

@@ -3205,8 +3237,9 @@ total loss of the PAMGuard configuration in viewer mode and has been rectified. 7.0pt;font-family:"Times New Roman",serif'>     Bug 218. SAIL Acquisition card would hang the system. This has also been fixed.

-

7.    Bug 219. -Problems displaying Offline Click Events in the Viewer map have been fixed.

+

7.    Bug +219. Problems displaying Offline Click Events in the Viewer map have been +fixed.

 

@@ -3288,8 +3321,8 @@ Visual Methods

'Multi Threading' menu item moved from 'Detection' (now 'Settings') to 'File'

-

'Start' and 'Stop' menu items removed. -PAMGuard should be started and stopped using the red and black buttons.

+

'Start' and 'Stop' menu items removed. PAMGuard +should be started and stopped using the red and black buttons.

New Modules

@@ -3357,9 +3390,9 @@ help for details.

Echo Detector and Sperm Whale IPI Computation (Beta only, Sound Measurements Group)

-

These two modules, developed by Brian Miller of the -Australian Antarctic Division can be used to estimate the inter pulse interval -of sperm whale clicks. (No help available)

+

These two modules, developed by Brian Miller of the Australian +Antarctic Division can be used to estimate the inter pulse interval of sperm +whale clicks. (No help available)

 

@@ -3870,11 +3903,11 @@ Symbol'>'Version 1.8.01 Beta February 2010 @@ -4409,9 +4442,9 @@ now been fixed.

Sound Recorder

-

Level meters are shown for the correct channels (after channel -numbering has been changed). Occasional crash due to synchronisation problems -when  multi-threading now fixed.

+

Level meters are shown for the correct channels (after +channel numbering has been changed). Occasional crash due to synchronisation +problems when  multi-threading now fixed.

Whistle Detector

@@ -4685,9 +4718,9 @@ Symbol'>''         -Better drawing of held spectrogram when putting mark rectangles on a spectrogram -display. All panels are now correctly frozen. The rectangle is drawn in red on -the marked panel and in green on other panels.

+
Better drawing of held spectrogram when putting mark rectangles on a +spectrogram display. All panels are now correctly frozen. The rectangle is +drawn in red on the marked panel and in green on other panels.

'         @@ -4703,9 +4736,9 @@ coming in through the ASIO card and back out through its headphone socket

'         Operation will depend on the configuration of individual sound cards and -how they are configured to mix incoming data with data from the PC. This is sometimes -a physical switch on the card and sometimes a software configuration utility -specific to that sound card.

+how they are configured to mix incoming data with data from the PC. This is +sometimes a physical switch on the card and sometimes a software configuration +utility specific to that sound card.

'