Scripts enable you to automate tasks in Echoview that you would otherwise perform manually. These tasks range from the creation of Echoview files through to the export of processed data. Using scripts to perform these routine tasks can save you valuable time.
Scripts can be written in a variety of programming languages including Visual Basic, Python, Java, C++, MATLAB or R, to name a few. If you have example code in another language that you would like to share, or for further assistance with any aspect of scripting, please contact us. Please note that our Support team can offer limited assistance with writing scripts in languages beyond Visual Basic or C++.
The Automation module is required to run scripts with Echoview.
A tutorial, 'Introduction to COM scripting', is also available on the Tutorials page.
Below are example scripts provided by Echoview Software, as well as links to code shared by Echoview users on other websites. Think of these as examples of Echoview COM objects and programming-language syntax in action, intended to assist you in writing your own scripts. Note that depending on your computer's settings, clicking on the script links below will either show the script directly in your web browser or it may try to run the script. Use the Right-click > Save… option in your browser to download a script to your computer.
Please contact Echoview Support if you would like us to add a link to example code on your site.
Scripts provided by Echoview
EV script 001 - New EV files for folder of data.vbs (VBScript)
- Create multiple Echoview files by adding data from a folder of raw data files
- Create dialog boxes for user input (to select destination folders etc.)
- Export a line
- Loop actions in Visual Basic (the core of the script – a "For" loop – is on lines 302-327)
EV script 002 - Changing variable properties in multiple variables in multiple EV files.vbs (VBScript)
- Select multiple ev files
- Select multiple variables in each ev file
- Change variable properties (such as grid settings)
- Save and close EV file
EV script 003 - Pick and export lines in all EV files in a folder.vbs (VBScript)
- Open first EV file from nominated folder
- Select multiple variables
- Pick line on each variable
- Export lines to csv format
- Save EV file
- Repeat for all other EV files in nominated folder
EV script 004 - Add new data file locations to all EV files in a folder.vbs (VBScript)
- Open first EV file from nominated folder
- Add a new entry to EV File Properties > EV Files > Data File Locations
- Save EV file
- Repeat for all other EV files in nominated folder
EV script 005 - Update EVI files for all EV files in folders.vbs (VBScript)
- Open first EV file from nominated folder
- Preread all data files in the EV file to regenerate EVI files
- Save EV file
- Repeat for all other EV files in nominated folder
- Repeat for all other EV files in subfolders of nominated folder
EV script 006 - Import, rename and overwrite a line.vbs (VBScript)
- Open a nominated EV file
- Import a line. When lines are imported they are given a default name (e.g. Line n).
- Identify the imported line
- Rename the imported line
- Overwrite an existing line with the imported line
EV script 007 - New EV file using template, detect and export fish tracks (VBScript)
- Create a new EV file from a template
- Add a custom number of data files from a folder
- Detect fish tracks from nominated variable
- Export fish track region analysis
- Save and close EV file
- Repeat for remaining data files
EV script 008 - Add additional virtual variables to existing EV files.vbs (VBScript)
- Open an EV file
- Create a new virtual variable
- Change the operand for an existing variable
- Save and close EV file
EV script 009 - Import additional virtual variables to an existing EV file.vbs (VBScript)
- Open an EV file
- Import virtual variables from another EV file
- Change operands for several variables
- Save and close EV file
EV script 010 - New EV file using template, add data, create lines.py (Python)
- Create a new EV file from a template
- Add all data files in a folder
- Change bottom detection settings
- Create fixed depth and bottom pick lines
- Save and close EV file
EV script 011 - Package EV file and associated data into one volume.m (Matlab)
- Select an EV file
- Identify the data files that have been added to the EV file
- Copy the EV file and data files to a new location
EV script 012 - New file, add data, create line, change settings, export.r (R)
- Open an EV file or create a new file
- Add data files
- Create a fixed depth line and a line pick
- Change variable properties
- Export an integration
- Save and close EV file
EV script 013 - Export echogram images for all EV files in a folder.vbs (VBScript)
- Open a dialog to enter the location of EV files
- Open a dialog to enter a location for saving images
- Export specified variables in every EV file to image files
- Save and close EV file
EV script 014 - Export echogram images for all EV files in a folder.m (Matlab)
- A Matlab translation of EV script 013
EV script 015 - Open and close Echoview.txt (Perl - change extension to .pl after download)
- Open Echoview
- Query Echoview's version number
- Close Echoview
EV script 016 - Combine COM and command interface to change variable properties.vbs (VBScript)
- Open an EV file using COM
- Use the Command interface to find all acoustic variables
- Use the Command interface to change a setting that is not available to COM
- Save and close the EV file using COM
Scripts on other sites shared by Echoview users
Note that Echoview Software accepts no responsibility for scripts shared on other websites.
The R package EchoviewR - a free interface between Echoview and R using COM scripting
- EchoviewR is a free and extensive software package that acts as an interface between R and Echoview, developed by the Australian Antarctic Division.
- A variety of tips and tricks for accessing Echoview's COM using R.
- Analysis approach for Simrad WBAT-mini data collected from Saildrone using Python as described in Levine et al. (2020).
- MATLAB GUI for data processing in Echoview as described in Haris et al. (2021).
- A Python package that combines Echoview interactions and machine learning to generate lines and regions to segment echograms.