EVExportEchogramToImage: Export an Echoview acoustic variable to an image file

View source: R/EVExportEchogramToImage.R

EVExportEchogramToImageR Documentation

Export an Echoview acoustic variable to an image file

Description

This function exports an Echoview acoustic variable to an image file.

Usage

EVExportEchogramToImage(
  EVFile,
  acoVarName,
  filePath,
  heightInPixels,
  pingRange = c(-1, -1)
)

Arguments

EVFile

Echoview file COM object

acoVarName

The acoustic variable name to export

filePath

Path and filename for the resulting image file. The image type is controlled here by specifying the desired extension, e.g. *.jpg

heightInPixels

Vertical resolution of exported image in pixels. NB Echoview requires a 25 pixel minimum vertical resolution

pingRange

=c(-1,1) Optional ping range over which to export the Echoview line object. Default is to export the lien for all pings

Details

The following image types are available: *.bmp, *.jpg, *.jpeg, *.png, *.tif, *.tiff.

Value

List of length two [1] Boolean flag indicating success or failure of export, and [1] message vector


AustralianAntarcticDivision/EchoviewR documentation built on Aug. 21, 2023, 6:56 p.m.