Skip to content

Latest commit

 

History

History
107 lines (67 loc) · 6.79 KB

README.md

File metadata and controls

107 lines (67 loc) · 6.79 KB
Raw

Iskaffe

Multibeam backscatter quality control.

Description

Iskaffe (Norwegian Bokmål for "iced coffee") is a free and open-source app to help assess the quality of the seafloor backscatter data acquired by multibeam echosounders. The main purpose of this tool is to serve as a development platform to come up with a set of algorithms that assess various aspects of backscatter quality, and define standards of backscatter quality based on the output of those algorithms. While we are currently developping Iskaffe for our own use, we are welcoming co-developers and feedback to help coming up with more widely-applicable algorithms and backscatter quality standards.

Iskaffe uses the CoFFee multibeam data processing toolbox (hence the name). It is coded in MATLAB, but is also available as a standalone application that does not require a MATLAB licence (see the Dependencies and Installing sections).

Iskaffe is still at an early stage of development so it has fewer features and more bugs than you would want. Please be patient. For a starter, its main current limitations are that it does not like loading too many files at a time. Still, the latest release already has some relevant features:

  • Support Kongsberg .all and .kmall formats
  • Detect and alarm when a dataset contains data in more than one acquisition mode
  • Display backscatter, bathymetry, slope, and acquisition mode
  • Find, display, and count "bad" soundings and "bad" pings, for each loaded line
  • Find, display, and count the grid cells where data have not been acquired yet
  • Output analysis results

Getting Started

Dependencies

  • For the source code:
    • MATLAB. The code was developed with version R2020b, but it may work on earlier/later versions.
    • Some MATLAB toolboxes:
      • Mapping Toolbox
      • Image Processing Toolbox
      • Statistics and Machine Learning Toolbox
    • The CoFFee toolbox
  • For the compiled executable: MATLAB Runtime v9.9.
    • Note: if you install the app using the binary installer, the setup wizard will automatically detect whether you have the correct version of MATLAB Runtime installed and, if not, allow you to download and install it then.

Installing

  • For the source code:
    • Clone or download this repository, as well as the repository of CoFFee, onto your machine.
  • For the compiled executable:

Executing program

  • For the source code: Start MATLAB, navigate to the root directory of the Iskaffe code, and type Iskaffe in the Command Window.
    • Note: The first time you run Iskaffe from the source code, you will be prompted to provide the location of a folder containing the CoFFee toolbox. Iskaffe will check if the version of that toolbox is the one with which the app was built. If the version of CoFFee is not the one expected, you will receive a warning letting you know you might experience issues, and recommending you download (or check out) the appropriate version.
  • For the compiled executable: Execute the installed program.
    • Note: The first time you run Iskaffe after installation, it might take a while for the app to appear. Be patient. It will be faster the next times.

Note: At start-up, Iskaffe creates a Iskaffe user folder (normally, C:\Users\USERNAME\Documents\Iskaffe). This folder contains a configuration file for the app, and is the default folder for any exports from the app. This folder or any of its contents can be deleted safely (although if you delete the configuration file, this will reset the app configuration).

Help

Head over to the wiki for documentation (in progress).

If you have any issues, first check the project's Issues to search for a fix. Otherwise, let the authors know by creating a new issue. Ideally, share the Iskaffe log to provide insight in the issue.

For more help, contact the authors.

Past versions and updates

See the releases page for past released versions.

If you want to receive notifications of future releases (recommended), you may create a github account, and on this repository click on 'Watch', then 'Custom', and choose 'Releases'. Verify in your GitHub settings that you are set to receive 'Watching' notifications.

About

Authors and contributors

  • Alexandre Schimel (The Geological Survey of Norway, alexandre.schimel@ngu.no)
  • Margaret Dolan, Shyam Chand, Terje Thorsnes, Lilja Rún Bjarnadóttir (The Geological Survey of Norway)

Copyright

2021-2024

  • Alexandre Schimel (The Geological Survey of Norway)

License

The Iskaffe software and source code is distributed under the MIT License. See LICENSE file for details.

Citation/Credit

An article is in preparation for reference.

Acknowledgments

Iskaffe logo from photo by Talia Anna on Unsplash

See Also

All apps based on CoFFee:

  • Grounds: Elevation Change Analysis
  • Espresso: Multibeam water-column data visualization and processing (private)
  • Iskaffe: Multibeam backscatter quality control

References

None to date.

For developers

See the 'For developers' section on the CoFFee page