COM object EvVariableAcoustic

EvApplication > EvFileCollection > EvFile > EvVariablesCollection > EvVariableBase As EvVariableAcoustic

 

View the COM map and the COM summary.

The EvVariableAcoustic object gives access to information on and actions with an acoustic variable in an EV file. You can also use the EvVariableBase object to gain access to further information on and actions for the variable.

The EvFile.Variables[] property lists all the variables in an EV file and is an EvVariablesCollection.

The EvFileset.Variables[] property that lists all variables in a fileset in an EV file and is an EvVariablesCollection.

The EvVariableAcoustic classes, methods and properties are also used by EvVariableVirtual especially when dealing virtual variables.

Some EvVariableAcoustic methods and properties can also be used by EvVariableBase especially when dealing with other Echoview variables.

EvVariableAcoustic classes:

Properties

EvVariableAcoustic methods and properties:

AsVariableBase
AsVariableAcoustic
AsVariableVirtual
AddVariable
ClassifyBottom
ClassifyRegion
Create3DFishTracks
Create3DSingleTargets
CreateCurtain
CreateLineRelativeRegion
DataType
DetectFishTracks
DetectSchools
DetectSurface
DetectSurfaceFromLine
ExportComplexData
ExportComplexDataForRegion
ExportData
ExportDataForRegion
ExportEchogramToImage
ExportEVD
ExportEVDRange
ExportFishTracksByCells
ExportFishTracksByCellsAll
ExportFishTracksByRegions
ExportFishTracksByRegionsAll
ExportFrequencyDistributionByCells
ExportFrequencyDistributionByCellsAll
ExportFrequencyDistributionByRegions
ExportFrequencyDistributionByRegionsAll
ExportFrequencyDistributionByRegionsByCells
ExportFrequencyDistributionByRegionsByCellsAll
ExportFrequencyDistributionBySingleRegion
ExportGeoreferencedSamples
ExportGeoreferencedSamplesByRegions
ExportGeoreferencedSamplesForRegion
ExportHAC
ExportICESCSVByCells
ExportICESCSVRegionClassesByCells
ExportICESCSVByRegionClassesByCellsAll
ExportIntegrationByCells
ExportIntegrationByCellsAll
ExportIntegrationByRegions
ExportIntegrationByRegionsAll
ExportIntegrationByRegionsByCells
ExportIntegrationByRegionsByCellsAll
ExportIntegrationBySingleRegionByCells
ExportLine
ExportQPSSD
ExportRegionsLog
ExportRegionsLogAll
ExportSettings
ExportSingleTargetsByCells
ExportSingleTargetsByCellsAll
ExportSingleTargetsByRegions
ExportSingleTargetsByRegionsAll
ExportSingleTargetsByRegionsByCells
ExportSingleTargetsByRegionsByCellsAll
ExportSingleTargetWidebandFrequencyResponse
ExportSingleTargetWidebandFrequencyResponseByRegions
ExportSingleTargetWidebandFrequencyResponseByRegionsAll
ExportSingleTargetWidebandFrequencyResponseForRegion
ExportTrackToImage
ExportUnderlyingData
ExportVegetation
GoToPing
GoToPingRange
GoToRegion
MaxStopRange
MeasurementCount
MinStartRange
Name
PickLine
PingMode
PositionVariable
Properties
Useable
VariableType

Description

AsVariableBase

AsVariableBase()

Summary

Determines if the variable is a base variable. All variables come under the base variable grouping so this method will always return EvVariableBase.

Parameters

None.

Return

EvVariableBase.

AsVariableAcoustic

AsVariableAcoustic()

Summary

Determines if the variable is an acoustic variable.

Parameters

None.

Return
  • EvVariableAcoustic when the variable is an acoustic variable.
  • Null when the variable is not an acoustic variable.
AsVariableVirtual

AsVariableVirtual()

Summary

Determines if the variable is a virtual variable.

Parameters

None.

Return
  • EvVariableVirtual when the variable is a virtual variable.
  • Null when the variable is not a virtual variable.

AddVariable

AddVariable (EOperator Operator)

Summary

Create a virtual variable (this includes virtual lines). The type of operator is specified by the enum EOperator. The resulting virtual variable is an EvVariableBase object.

Parameters
  • EOperator
  • Specifies an operator using an enum from EOperator.
  • See also: Enum issue under VBS.
Return
  • EvVariableBase when the virtual variable is created.
  • Null when the variable is not created.
Example

This code snippet demonstrates:

  Dim oEchoviewCom: Set oEchoviewCom = CreateObject("EchoviewCom.EvApplication")
  Dim oEvFile: Set oEvFile = oEchoviewCom.OpenFile("c:\Echoview script tests\temp.ev")
  Dim oSvVar: Set oSvVar = oEvFile.Variables.FindByName("Sv raw pings T1")

  If oSvVar Is Nothing Then
      MsgBox "Failed to find 'Sv raw pings T1'."
      WScript Quit
  End If

  Dim iVar

  For iVar = 0 To oEvFile.Variables.Count - 1
    Dim oVar: Set oVar = oEvFile.Variables(iVar).AddVariable(91)

    If oVar Is Nothing Then
      MsgBox "Failed to create variable on " + oEvFile.Variables(iVar).Name
    ElseIf Not oVar.AsVariableVirtual Is Nothing Then
        If Not oVar.SetOperand(1, oSvVar) Then
          MsgBox "Failed to set operand on " + oVar.Name
        End If
    End If
  Next
  
ClassifyBottom

ClassifyBottom (string Name, int FirstPing, int LastPing, boolean ShowOnIntegram)

Summary

Runs a bottom classification on an Sv variable, and can display the bottom points integram on the Sv echogram.

Notes:

  • You are required to manually specify bottom classification settings for the Variable Properties dialog box and the EV File Properties dialog box. Refer to Configuring a bottom classification for more information. These settings are not currently supported by Echoview COM in this release.
Parameters
  • Name
  • Name of the bottom points variable.
  • FirstPing, LastPing
  • The default values are -1, -1 for the whole echogram.
  • ShowOnIntegram
  • True to show the bottom classification integram. The default is False.
Return

True if a bottom classification is successful.

Note: There may be legitimate reasons for an unsuccessful bottom classification.

Example


ClassifyRegion

ClassifyRegion (EvRegion Region)

Summary

Apply a classification-by-rule to the specified region(s) in the acoustic variable.

Notes:

Parameters
  • Region
  • The region specified by EvRegion. When no region is specified, Echoview classifies all regions in the acoustic variable.
    Note: When multiple regions have the same name, the first one found is used.
Return

Returns the number of regions changed (by the classification). Returns zero for no regions changed.

Example
option explicit
MsgBox "Echoview COM Classify all Regions"
Dim EvApp
Set EvApp = CreateObject("EchoviewCom.EvApplication")
Dim EvFile
Set EvFile = EvApp.EvFiles.Item(0)
Dim Var: Set Var = EvFile.Variables.FindByName("Sv pings").AsVariableAcoustic()
If Var Is Nothing Then
     MsgBox "Failed to find variable"
    ' Classify all regions
    Dim numRegions
    numRegions = Var.ClassifyRegion(Nothing)
    MsgBox "Number of regions classified: " & numRegions
End If

CreateLineRelativeRegion

CreateLineRelativeRegion(string RegionName, EvLine Line1, EvLine Line2, int FirstPing, int LastPing)

Summary

Create a line relative region on the current variable.

Parameters
  • RegionName
  • The region name to assign the line relative region to.
  • Line1
  • The EvLine object to assign to Line1.
  • Line2
  • The EvLine object to assign to Line2.
  • FirstPing
  • The first ping for the line relative region.
  • LastPing
  • The last ping for the line relative region.
Return

EvRegion.

CreateCurtain

CreateCurtain(string CurtainName, int FirstPing, int LastPing, int PingSamplingFactor)

Summary

Create a curtain from the the current variable. The current variable determines the type of 3D curtain that is created. Optional parameters allow you to constrain the curtain.

Parameters
  • CurtainName
  • The name to assign to the curtain.
  • FirstPing
  • The first ping for the curtain. This is an optional parameter.
  • LastPing
  • The last ping for the curtain. This is an optional parameter.
  • PingSamplingFactor
  • An optional parameter for the Ping sampling factor to specify the multibeam ping curtains to be created. The default value is 10 - a multibeam curtain for every tenth ping.
Return

EvObject3d.

Example
Dim vEchoviewCom: Set vEchoviewCom = CreateObject("EchoviewCom.EvApplication")
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:\EV files\Multibeam SM2000.EV")
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("magnitude beamformed pings")
vEvVariable.CreateCurtain "Curtain1", 0, 50, 100

Create3DFishTracks

Create3dFishTracks(string GroupName, int FirstPing, int LastPing);

Summary

Create 3D fish tracks from the current variable.

Parameters
  • GroupName
  • The name to assign to the 3D Fish tracks group.
  • FirstPing
  • The first ping for the 3D Fish tracks group.
  • LastPing
  • The last ping for the 3D Fish tracks group.
Return

EvObject3d.

Create3DSingleTargets

Create3dSingleTargets(string TargetsName, int FirstPing, int LastPing)

Summary

Create 3D Single targets from the current variable.

Parameters
  • TargetsName
  • The name for the 3D single targets group.
  • FirstPing
  • The first ping for the 3D Single targets group.
  • LastPing
  • The last ping for the 3D Single targets group.
Return

EvObject3d.

DataType

(read-only) EVariableDataType DataType

Summary

Get the data type that the variable contains. The data type is specified by the enum EVariableDataType.

See also: Enum issue under VBS.

DetectFishTracks

DetectFishTracks(string Class, int FirstPing, int LastPing)

Summary

Detect fish tracks on the current variable.

Parameters
  • Class
  • The class to assign detected fish track regions to.
  • PingStart
  • The ping index to start the detection at.
  • PingStop
  • The ping index to stop the detection at.
Return

None.

DetectSchools

DetectSchools(string Class, int PingStart, int PingStop)

 

Summary

Perform school detection on the current variable.

Note: Before you use DetectSchools you may want to delete regions of a particular class. For more information refer to EvFile.RegionClasses.DeleteRegions.

Parameters
  • Class
  • The class to assign detected regions to.
  • PingStart
  • The ping index to start the detection at.
  • PingStop
  • The ping index to stop the detection at.
Return

Number of schools (this is -1 if the detection failed).

DetectSurface

DetectSurface(string SurfaceName, int FirstPing, int LastPing, double BetweenPingInterpolation)

Summary

Perform bottom surface detection on the multibeam variable

Parameters
  • SurfaceName
  • Name for the detected bottom surface.
  • FirstPing
  • Start bottom surface detection at this ping.
  • LastPing
  • Stop bottom surface detection at this ping.
  • BetweenPingInterpolation
  • Maximum triangulation distance setting.
Return

EvObject3d

DetectSurfaceFromLine

DetectSurfaceFromLine(string SurfaceName, EvLine Line, int FirstPing, int LastPing, double MaxInterpolation, string IntensitySource)

Summary

Create a surface from a line on the current variable.

Parameters
  • SurfaceName
  • The name for the surface.
  • Line
  • The EvLine object to create the surface from.
  • FirstPing
  • The ping to to begin with.
  • LastPing
  • The ping to to end with.
  • MaxInterpolation
  • The value for the Maximum triangulation distance setting.
  • IntensitySource
  • The name for the Intensity color source setting.
Return

EvObject3d.

PickLine

PickLine(string LineName, int FirstPing, int LastPing)

Summary

Pick a line for the current variable.

Parameters
  • LineName
  • The name of line to assign the line pick to.
  • FirstPing
  • The ping to begin the line pick.
  • LastPing
  • The ping to end the line pick.
Return

EvLine.

ExportComplexData

boolean ExportComplexData(string FileName, [integer FirstPing], [integer LastPing])

Summary

Exports complex data from a complex data variable to a *.complex.csv file. A ping subset from the variable can be specified.

Parameters
  • Filename
  • Path and filename for the *.complex.csv file.
  • FirstPing
  • Specifies the first ping of a ping subset.
  • LastPing
  • Specifies the last ping of a ping subset.
Return

True, when successful.

Example
...
' Script
Dim evFile: Set evFile = OpenEvFile("c:\YourFile.EV")

' Export pulse compressed data
Dim pulseCompressedSvVar: Set pulseCompressedSvVar = evFile.Variables.FindByName("Fileset 1: YourVariable")
pulseCompressedSvVar.ExportComplexData OutputPath("sv t1 subset.complex.csv"), 0, 10
...

ExportComplexDataForRegion

boolean ExportComplexDataForRegion(string FileName, EvRegion Region)

Summary

Exports complex data for a region on a complex data variable to a *.complex.csv file.

Parameters
  • Filename
  • Path and filename for the *.complex.csv file.
  • Region
  • a Region is specified through EvRegion.
Return

True, when successful.

Example

For the defintion of "pulseCompressedVar' refer to the ExportComplexData example.

...
Dim evRegionFile: Set evRegionFile = OpenEvFile("c:\YourFile.EV")
Dim pulseCompressedVar: Set pulseCompressedVar = evRegionFile.Variables.FindByName("Fileset 1: Sv pulse compressed wideband pings T1")

'Export complex data for a region
Dim vEvRegionsCollection: Set vEvRegionsCollection = evRegionFile.Regions
Dim vEvRegion: Set vEvRegion = vEvRegionsCollection.FindByName("Region 1")
pulseCompressedVar.ExportDataForRegion OutputPath("ComplexRegionExport.CSV"), vEvRegion
...

ExportData

ExportData(string FileName, int FirstPing, int LastPing)

Summary

Export the data in the echogram. See also:

Parameters
  • FileName
  • The name of file and path to export the data to.
  • StartPing, StopPing
  • These are optional parameters that specify the start ping and the stop ping for the data export.
    The default value for the first ping is -1.
    The default value for the last ping is -1.
Return

True, if successful.

ExportLine

ExportLine(EvLine Line, string FileName, int FirstPing, int LastPing)

Summary

Export the specified line to a .csv file.

Parameters
  • Line
  • The name of line to assign the line pick to. The line name is accessed by EvFile.Lines.
  • FileName
  • The name of the file (and path) to export the line to. This is a .csv line export. For a .evl line export refer to EvLine.Export. The value -1 can be used to specify from the start of the line or to the end of the line.
  • FirstPing
  • The ping to begin the line export. The value -1 can be used to specify from the start of the line or to the end of the line.
  • LastPing
  • The ping to end the line export. The value -1 can be used to specify from the start of the line or to the end of the line.
Return

True, if successful.

Examples
Get a line.
Dim EvLine: Set EvLine = EvFile.Lines.FindByName("Line1")
Export the line, assuming you have a variable VarAc.
VarAc.ExportLine(EvLine, "C:\Survey\CSV line export\line export.csv", -1, -1)
Check if the export succeeded (and specify a ping range).
If Not VarAc.ExportLine(EvLine, "C:\Survey\CSV line export\line export 2.csv", 100, 200) Then
   MsgBox "Failed to export to line (2)"
   End If

ExportEVD

boolean ExportEVD(string FileName, EEvdExportCompression CompressionLevel)

Summary

Export variable data to an Echoview Data File Format file.

Parameters
Return

True, if successful.

Example,
Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")

Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("YourEvFile")
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("Fileset1: Sv pings")
vEvVariable.ExportEVD "D:\Exports\SvAtHighestCompression.evd", 1

See also: Enum issue under VBS.

ExportEVDRange

boolean ExportEVDRange(string FileName, EEvdRangeExportMode RangeMode, RangeStart, RangeStop, EEvdExportCompression CompressionLevel)

Summary

Export variable data with the specified measurement/ping range to an Echoview Data File Format file.

Parameters
  • FileName
  • Path and file name for the Echoview Data format file.
  • RangeMode
  • Enum value of EEvdRangeExportMode that specifies the ping or time subset to export.
  • RangeStart
  • Start of the specified measurement. The time is specified in abbreviated ISO 8601 format.
  • RangeStop
  • Stop range of the specified measurement. The time is specified in abbreviated ISO 8601 format.
  • CompressionLevel
  • The EEvdExportCompression enum value represents a Compression Quality.
    • None is 0
    • Highest(Lossless) is 1
    • High is 2
Return

True, if successful.

Example,
Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")
vEchoviewCom.Log("EVD write - ST")
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("c:\YourFolder\YourEVFile.ev")
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("YourVariableName")
'vEvVariable.ExportEVDRange "C:\YourFolder\EVDexport.EVD", 0, 0, 10, 0
vEvVariable.ExportEVDRange "C:\YourFolder\EVDSubsetExport.EVD", 1, CDATE("1999-12-21 20:11:31"), CDATE("1999-12-21 20:11:32"), 0

See also:

Enum issue under VBS.

GoToPingRange Time snippet example for information about the Visual Basic function CDATE.

ExportICESCSVByCells

boolean ExportICESCSVByCells(string FileName, EIcesCsvExportDataValue eDataValue, EIcesCsvExportLogOrigin eLogOrigin, string DataSaCategory)

Summary

Exports SV by Cells data to the ICES CSV file format. Preconfiguration of the Sv echogram, EV File Properties and Transducer Properties is advised. See Exporting ICES CSV data for more information.

Parameters
Return

True, when successful.

Example
...
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:\Temp\YourFile.EV")
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("YourVariable")

'Mean_sv: start, middle, end
vEvVariable.ExportICESCSVByCells "C:\Temp\YourFile_MeanSv_start.CSV", 0, 0, "Deep fish"
vEvVariable.ExportICESCSVByCells "C:\Temp\YourFile_MeanSv_middle.CSV", 0, 1, "Deep fish"
vEvVariable.ExportICESCSVByCells "C:\Temp\YourFile_MeanSv_end.CSV", 0, 2, "Deep fish"

'ABC: start, middle, end
vEvVariable.ExportIcesCSVRegionsByCells "C:\Temp\YourFile_ABC_start.CSV", 2, 0
vEvVariable.ExportIcesCSVRegionsByCells "C:\Temp\YourFile_ABC_middle.CSV", 2, 1
vEvVariable.ExportIcesCSVReginsByCells "C:\Temp\YourFile_ABC_end.CSV", 2, 2

ExportICESCSVRegionClassesByCells

boolean ExportICESCSVRegionClassesByCells(string FileName, EIcesCsvExportDataValue eDataValue, EIcesCsvExportLogOrigin eLogOrigin, [EvRegionClass RegionClass])

Summary

Exports Sv Regions by Region class by Cells data to the ICES CSV file format. The region class of the regions is output as a descriptor of the species in the region. Preconfiguration of the Sv echogram, EV File Properties and Transducer Properties is advised. See Exporting ICES CSV data for more information.

Parameters
Return

True, when successful.

Example
' Constants
eIcesCsvExportDataValueABC  = 1
eIcesCsvExportLogOriginMiddle  = 1

' Script
Dim vEchoviewCom: Set vEchoviewCom = GetObject("", "EchoviewCom.EvApplication")
vEchoviewCom.Log("ICES CSV EXPORT")
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:\YourFolder\YourEVFile.EV")
Dim vEvVariable: Set vEvVariable = vEvFile.Variables.FindByName("Sv Processed 38kHz")
Dim vEvRegionClass: Set vEvRegionClass = vEvFile.RegionClasses.FindByName("Region class 1")

' Export for Region class 1
vEvVariable.ExportICESCSVByRegionClassesByCells "C:\Temp\YourExportFile.CSV", eIcesCsvExportDataValueABC, eIcesCsvExportLogOriginMiddle, vEvRegionClass

' Export for all Region classes
vEvVariable.ExportICESCSVByRegionClassesByCellsAll "C:\Temp\YourExportFile.CSV", eIcesCsvExportDataValueABC, eIcesCsvExportLogOriginMiddle

```

ExportICESCSVByRegionClassesByCellsAll

boolean ExportICESCSVByRegionClassesByCellsAll(string FileName, EIcesCsvExportDataValue eDataValue, EIcesCsvExportLogOrigin eLogOrigin)

Summary

Exports Sv Regions by all Region classes by Cells data to the ICES CSV file format. The region class of the regions is output as a descriptor of the species in the region. Preconfiguration of the Sv echogram, EV File Properties and Transducer Properties is advised. See Exporting ICES CSV data for more information.

Parameters
Return

True, when successful.

Example

Refer to the Example for ExportICESCSVRegionClassesByCells.

ExportHAC

ExportHAC(string FileName, int StartPing, int StopPing, boolean CompressedTuples)

Summary

Export the data from the current variable in the HAC format.

Parameters
  • FileName
  • The path and name of file to export the HAC data to.
  • StartPing
  • Optional integer value for the ping to begin the HAC data export. The default value is -1 and exports from the start of the data.
  • StopPing
  • Optional integer value for the ping to end the HAC data export. The default value is -1 and exports to the end of the data.
  • CompressedTuples
  • Optional selection to export as compressed tuples. The default value is FALSE for uncompressed tuples.
Return

True, if successful.

Example
' Turn on stricter error checking
Option Explicit
' Change these to the appropriate variable name and export path/filename-prefix for your files
Const strAccName = "Sv raw pings T1"
Const strExportBase = "c:\test\hac_export_test-"
         MsgBox "This script assumes you already have one EV file open in Echoview." &
         vbCrLf & "It must contain a variable named '" & strAccName & "'." & vbCrLf &
         vbCrLf & "It will export to files starting with: ' " & strExportBase & "'."
' Connect to Echoview
        Dim EvApp
        Set EvApp = CreateObject("EchoviewCom.EvApplication")
' Get the first EV file of those that are open
Dim EvFile
Set EvFile = EvApp.EvFiles.Item(0)
' Find the variable with the name set above
      Dim AcVar
      Set AcVar = EvFile.Variables.FindByName(strAccName).AsVariableAcoustic()
' Now export to HAC with a variety of settings.
      AcVar.ExportHAC strExportBase & "default"
      AcVar.ExportHAC strExportBase & "startping_only.hac", 100
      AcVar.ExportHAC strExportBase & "stop_ping_only", -1, 20
      AcVar.ExportHAC strExportBase & "compressed_all_pings.hac", -1, -1, True
' Note you can also check the return value of this method, to see if it
' succeeded or not.  You need to use parentheses around the parameters
' when calling something for a return value.
      If Not AcVar.ExportHAC(strExportBase & "start_and_stop_ping.hac", 5, 20) Then
              MsgBox "Error exporting '" & strExportBase & "start_and_stop_ping.hac'.", vbOk + vbError, "Error"
        End If
' Close the EV file
EvApp.CloseFile(EvFile)

ExportQPSSD

ExportQPSSD(string FileName, int StartPing, int StopPing, boolean BelowColorMinTransparent, boolean AboveColorMaxTransparent, boolean NoDataTransparent)

Summary

Export the data from the current variable in the QPS SD format.

Paramenters
  • FileName
  • The path and name of file to export the QPS SD data to.
  • StartPing
  • Optional integer value for the ping to begin the QPS SD data export. The default value is -1 and exports from the start of the data.
  • StopPing
  • Optional integer value for the ping to end the QPS SD data export. The default value is -1 and exports to the end of the data.
  • BelowColorMinTransparent
  • Optional selection to export with Values below the color display minimum set to transparent. The default value is FALSE.
  • AboveColorMaxTransparent
  • Optional selection to export with Values above the color display minimum set to transparent. The default value is FALSE.
  • NoDataTransparent
  • Optional selection to export with No data set to transparent. The default value is TRUE.
Return

TRUE, if successful.

Example
Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")

Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("YourEvFile")
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("Fileset1: Sv raw pings T1")
vEvVariable.ExportQPSSD "D:\Exports\YourFile.sd", 10, -1, True, True, True

ExportEchogramToImage

ExportEchogramToImage(string FileName, int HeightInPixels, int StartPing, int StopPing)

Summary

Export a selection from the acoustic variable echogram as an image.

Note: You can also export an image of a cruise track window or an along track window or a selection on a virtual variable echogram under EvVariableBase.

Parameters
  • FileName
  • The name of file to export data to. The file extension specifies the type of image. Available extensions are: *.bmp, *.jpg, *.jpeg, *.png, *.tif, *.tiff.
  • HeightInPixels
  • Height of the selection in pixels (samples).
  • StartPing
  • Optional start ping of the selection. The default value is -1 and exports from the start of the data.
  • StopPing
  • Optional stop ping the selection. The default value is -1 and exports to the end of the data.
Return

True, if successful.

Example
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:\Yourfile.EV")
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("Sv raw pings T1")
Dim vEvCruiseVariable: Set vEvCruiseVariable = vEvVariablesCollection.FindByName("position GPS fixes")
vEvCruiseVariable.ExportTrackToImage "C:\CruiseTrack Image.JPG", 400, 100
vEvVariable.ExportEchogramToImage "C:\Echogram Image.JPG", 500, 100, 500

ExportUnderlyingData

ExportUnderlyingData(string FileName, int FirstPing, int LastPing)

Summary

Export the underlying data for the current variable.

Parameters
  • FileName
  • The path and name of file to export the underlying data to.
  • FirstPing
  • The ping to begin the underlying data export.
  • LastPing
  • The ping to end the underlying data export.
Return

True, if successful.

ExportVegetation

boolean ExportVegetation(string FileName)

Summary

Export the Vegetation Analysis for the current variable. Note: Vegetation analysis will require the manual configuration of Analysis page Vegetation settings for the acoustic variable.

Parameters
  • FileName
  • The path and name of file to export the vegetation analysis data to.
Return

True, if successful.

Example

 

ExportSettings

ExportSettings(string Filename)

Summary

Export all Variable Properties dialog box settings and their values for the selected variable to a text file.

Parameters
  • FileName
  • The full path of the text file to export to.

Return

True, if successful.

Example
option explicit
Dim vEchoviewCom: Set vEchoviewCom = CreateObject("EchoviewCom.EvApplication")
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:\YourFile.ev")
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("Sv pings")
vEvVariable.ExportSettings("c:\TEMP\SvPingsSettings.txt")

ExportTrackToImage

ExportTrackToImage(string FileName, int WidthInPixels, int HeightInPixels)

Summary

Export the Cruise track or Along track cruise track window as an image.

Note: You can also export an image of a selection from an acoustic variable.

Parameters
  • FileName
  • The name of file to export data to. The file extension specifies the type of image. Available extensions are: *.bmp, *.jpg, *.jpeg, *.png, *.tif, *.tiff.
  • WidthInPixels
  • Width of the window in pixels.
  • HeightInPixels
  • Height of the window in pixels.
Return

True, if successful.

Example

Export an image of a cruise track or an echogram.

ExportIntegrationByRegions

ExportIntegrationByRegions(string FileName, EvRegionClass)

Summary

Export the 'Integration by regions' analysis results for a region class to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.
  • EvRegionClass
  • The region class to constrain the analysis to. If using VBScript, specify 'Nothing' for EvRegionClass to export all region classes.

Note: If a region class is specified only that region class will be exported. When not specified, all region classes are exported.

Return

True, if successful.

ExportIntegrationByRegionsAll

ExportIntegrationByRegionsAll(string FileName)

Summary

Export the 'Integration by regions' analysis results for all region classes to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.

Note: This method is an alternative for languages that do not support the optional parameter in ExportIntegrationByRegions.

Return

True, if successful.

ExportIntegrationByCells

ExportIntegrationByCells(string FileName, EvRegion)

Summary

Export the 'Integration by cells' analysis results for a specified region to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.
  • EvRegion
  • An optional parameter that specifies the region to constrain the analysis to. If using VBScript, specify 'Nothing' for EvRegion to export an analysis of the whole variable.
Return

True, if successful.

ExportIntegrationByCellsAll

ExportIntegrationByCellsAll(string FileName)

Summary

Export the 'Integration by cells' analysis results to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.
Note: This method is an alternative for languages that do not support the optional parameter in ExportIntegrationByCells.
Return

True, if successful.

ExportIntegrationByRegionsByCells

ExportIntegrationByRegionsByCells(string FileName, EvRegionClass )

Summary

Export the 'Integration by regions by cells' analysis results of the specified region class to the given file name.

Parameters
  • FileName
  • The path and name of the file to export the Integration by regions by cells analysis to.
  • EvRegionClass
  • The name of the region class to constrain the analysis to. If using VBScript, specify 'Nothing' for EvRegionClass to export all region classes.

Note: If a region class is specified only that region class will be exported. When not specified, all region classes are exported.

Return

True, if successful.

ExportIntegrationByRegionsByCellsAll

ExportIntegrationByRegionsByCellsAll(string FileName)

Summary

Export the 'Integration by regions by cells' analysis results for all region classes to the given file name.

Parameters
  • FileName
  • The path and name of the file to export the Integration by regions by cells analysis to.

Note: This method is an alternative for languages that do not support the optional parameter in ExportIntegrationByRegionsByCells.

Return

True, if successful.

ExportIntegrationBySingleRegionByCells

ExportIntegrationBySingleRegionByCells(string FileName, EvRegion)

Summary

Export the 'Integration by regions by cells' analysis result for a specified region of an Sv variable to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.
  • EvRegion
  • The region to constrain the analysis to. Note: When multiple regions have the same name, the first one found is used.
Return

True, if successful.

Example
Dim vEchoviewCom: Set vEchoviewCom = CreateObject("EchoviewCom.EvApplication")
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:Temp\biomass.ev")
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("sv split beam pings (channel 3)")
Dim vEvRegionsCollection: Set vEvRegionsCollection = vEvFile.Regions
Dim vEvRegion: Set vEvRegion = vEvRegionsCollection.FindByName("Region2")
vEvVariable.ExportIntegrationBySingleRegionByCells "C:\Temp\Output\integration region.CSV", vEvRegion

Notes:

  • The ":" allows the Dim and Set statements to appear on one line.
  • The last line of this snippet does not assign a script variable to a value or string. It simply directs Echoview to export the integration results for a region to a file, and as a result the brackets () of the method are omitted. Such syntax is a quirk of VbsScript.

ExportFishTracksByCells

ExportFishTracksByCells(string FileName, EvRegionClass)

Summary

Export the 'Fish tracks by cells' analysis results for a specified region class to the given file name.

Parameters
  • FileName
  • The path and name of file to export to.
  • EvRegionClass
  • The region class to constrain the analysis to. If using VBScript, specify 'Nothing' for EvRegionClass to export all region classes.

Note: If a region class is specified only that region class will be exported. When not specified, all region classes are exported.

 
Return

True, if successful.

ExportFishTracksByCellsAll

ExportFishTracksByCellsAll(string FileName)

Summary

Export the 'Fish tracks by cells' analysis results for all region classes to the given file name.

Parameters
  • FileName
  • The path and name of file to export to.

Note: This method is an alternative for languages that do not support the optional parameter in ExportFishTracksByCells.

 
Return

True, if successful.

ExportFishTracksByRegions

ExportFishTracksByRegions(string FileName, EvRegionClass)

Summary

Export the 'Fish tracks by regions' analysis results for a region class to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.
  • EvRegionClass
  • The region class to constrain the analysis to. If using VBScript, specify 'Nothing' for EvRegionClass to export all region classes.

Note: If a region class is specified only that region class will be exported. When not specified, all region classes are exported.

Return

True, if successful.

ExportFishTracksByRegionsAll

ExportFishTracksByRegionsAll(string FileName)

Summary

Export the 'Fish tracks by regions' analysis results for all region classes to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.

Note: This method is an alternative for languages that do not support the optional parameter in ExportFishTracksByRegions.

Return

True, if successful.

ExportDataForRegion

ExportDataForRegion(string FileName, EvRegion)

Summary

Export the data for a region to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.
  • EvRegion
  • The region to constrain the analysis to. Note: When multiple regions have the same name, the first one found is used.
Return

True, if successful.

Note: Exports to a nominated filename with a default .csv extension (if no extension is specified). Other file extensions such as .mat (MATLAB) can be specified.

ExportRegionsLog

ExportRegionsLog(string FileName, EvRegionClass, int FirstPing, int LastPing)

Summary

Export the data for a Regions log book export to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.
  • EvRegionClass
  • The region class to constrain the export to. If using VBScript, specify 'Nothing' for EvRegionClass to export all region classes.
  • FirstPing, LastPing
  • These are optional parameters that specify the first ping and the last ping for the data export.
    The default value for the first ping is -1.
    The default value for the last ping is -1.
Return

True, if successful.

ExportRegionsLogAll

ExportRegionsLogAll (string FileName, int FirstPing, int LastPing)

Summary

Export the data from all classes for a Regions log book export to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.
  • FirstPing, LastPing
  • These are optional parameters that specify the first ping and the last ping for the data export.
    The default value for the first ping is -1.
    The default value for the last ping is -1.
Return

True, if successful.

ExportSingleTargetsByCells

ExportSingleTargetsByCells(string FileName, EvRegion)

Summary

Export the 'Single targets by cells' analysis results for a specified region to the given file name.

Parameters
  • FileName
  • The path and name of file to export to.
  • EvRegion
  • The region to constrain the analysis to. If using VBScript, specify 'Nothing' for EvRegion to export an analysis of the whole variable.
Return

True, if successful.

ExportSingleTargetsByCellsAll

ExportSingleTargetsByCellsAll(string FileName)

Summary

Export the 'Single targets by cells' analysis results for all regions to the given file name.

Parameters
  • FileName
  • The path and name of file to export to.
Note: This method is an alternative for languages that do not support the optional parameter in ExportSingleTargetsByCells.
Return

True, if successful.

ExportSingleTargetsByRegions

ExportSingleTargetsByRegions(string FileName, EvRegionClass)

Summary

Export the 'Single Targets by regions' analysis results for a specified region class to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.
  • EvRegionClass
  • The region class to constrain the analysis to. If using VBScript, specify 'Nothing' for EvRegionClass to export all region classes.

Note: If a region class is specified only that region class will be exported. When not specified, all region classes are exported.

Return

True, if successful.

ExportSingleTargetsByRegionsAll

ExportSingleTargetsByRegionsAll(string FileName)

Summary

Export the 'Single Targets by regions' analysis results for all region classes to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.

Note: This method is an alternative for languages that do not support the optional parameter in ExportSingleTargetsByRegions.

Return

True, if successful.

ExportSingleTargetsByRegionsByCells

ExportSingleTargetsByRegionsByCells(string FileName, EvRegionClass)

Summary

Export the 'Single targets by regions by cells' analysis results of the specified region class to the given file name.

Parameters
  • FileName
  • The path and name of the file to export to.
  • EvRegionClass
  • The name of the region class to constrain the analysis to. If using VBScript, specify 'Nothing' for EvRegionClass to export all region classes.

Note: If a region class is specified only that region class will be exported. When not specified, all region classes are exported.

Return

True, if successful.

ExportSingleTargetsByRegionsByCellsAll

ExportSingleTargetsByRegionsByCellsAll(string FileName)

Summary

Export the 'Single targets by regions by cells' analysis results for all region classes to the given file name.

Parameters
  • FileName
  • The path and name of the file to export to.

Note: This method is an alternative for languages that do not support the optional parameter in ExportSingleTargetsByRegionsByCells.

Return

True, if successful.

ExportSingleTargetWidebandFrequencyResponse

ExportSingleTargetWidebandFrequencyResponse(string FileName, boolean ShowAverage, boolean ShowMinMax, double WindowSize, integer WindowUnit, double MaxTimeDifference, EvVariableAcoustic Variable)

Summary

Export the wideband frequency response (for one TS variable) to the given file name. The TS frequency response is calculated for all overlapping single targets in a Single target detection - Wideband variable. Refer to the Example to see how the Single target detection - wideband variable and the export settings may be specified. The number of single targets affects the export time and file size (which may be too large for some third party applications). ExportSingleTargetWidebandFrequencyResponseForRegion may deliver a shorter export time and a more manageable file size.

This function is available to EvVariableVirtual.

Parameters
  • FileName
  • The path and name of the file to export to.
  • ShowAverage
  • 0 clears Average results. 1 selects Average results.
  • ShowMinMax
  • 0 clears Include min and max. 1 selects Include min and max.
  • WindowSize
  • Specifies the value of the Window Size.
  • WindowUnit
  • 0 is for Meters, 1 is for Pulse Lengths, 2 is for Samples.
  • MaxTimeDifference
  • Specifies the allowed time separation for variable pings relative to reference variable pings. The time value can be 0.0 to 30.0 seconds.
  • Variable
  • Specifies a TS pulse compressed wideband variable for frequency response calculations.
Return

True, if successful.

Example
Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")
vEchoviewCom.Log("Single target wideband frequency response export test")
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:\Temp\EK80FrequencyResponse.ev")
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvSTVariable: Set vEvSTVariable = vEvVariablesCollection.FindByName("Single target detection - wideband 1")
Dim vEvTSVariable1: Set vEvTSVariable1 = vEvVariablesCollection.FindByName("Fileset1: TS pulse compressed wideband pings T1")
vEvSTVariable.ExportSingleTargetWidebandFrequencyResponse "C:\Temp\SingleTargetFrequencyResponse.csv", true, true, 0.4, 0, 1.0, vEvTSVariable1
      

ExportSingleTargetWidebandFrequencyResponseByRegions

ExportSingleTargetWidebandFrequencyResponseByRegions(string FileName, boolean ShowAverage, boolean ShowMinMax, double WindowSize, integer WindowUnit, double MaxTimeDifference, EvVariableAcoustic Variable, [EvRegionClass Regionclass])

Summary

Export the wideband frequency response of regions in a single target detection - wideband variable to a given file name. Specifying a region class can minimize export time and file size.

This function is available to EvVariableVirtual.

Parameters
  • FileName
  • The path and name of the file to export to.
  • ShowAverage
  • 0 clears Average results. 1 selects Average results.
  • ShowMinMax
  • 0 clears Include min and max. 1 selects Include min and max.
  • WindowSize
  • Specifies the value of the Window Size.
  • WindowUnit
  • 0 is for Meters, 1 is for Pulse Lengths, 2 is for Samples.
  • MaxTimeDifference
  • Specifies the allowed time separation for variable pings relative to reference variable pings. The time value can be 0.0 to 30.0 seconds.
  • Variable
  • Specifies a TS pulse compressed wideband variable for frequency response calculations.
  • RegionClass
  • Configures the export of regions with a specified region class through EvRegionClass.
Return

True, if successful.

Example
Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")

Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("Path to your EV file")
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("Single target detection - wideband 1")
Dim vEvVariable2: Set vEvVariable2 = vEvVariablesCollection.FindByName("TS pulse compressed wideband pings T1")
Dim vEvVariable3: Set vEvVariable3 = vEvVariablesCollection.FindByName("TS pulse compressed wideband pings T2")
Dim vEvRegionClassesCollection: Set vEvRegionClassesCollection = vEvFile.RegionClasses
Dim vEvRegionClass: Set vEvRegionClass = vEvRegionClassesCollection.FindByName("Region class 1")

vEvVariable.ExportSingleTargetWidebandFrequencyResponseByRegions "Path for export file", true, false, 0.4, 0, vEvVariable2, vEvRegionClass
vEvVariable.ExportSingleTargetWidebandFrequencyResponseByRegionsAll "Path for export file", true, false, 0.4, 0, 1.0, vEvVariable2
    

ExportSingleTargetWidebandFrequencyResponseByRegionsAll

ExportSingleTargetWidebandFrequencyResponseByRegionsAll(string FileName, boolean ShowAverage, boolean ShowMinMax, double WindowSize, integer WindowUnit, double MaxTimeDifference, EvVariableAcoustic Variable)

Summary

Export the wideband frequency response of all regions in a single target detection - wideband variable to a given file name.

This function is available to EvVariableVirtual.

To reduce export time and file size consider using ExportSingleTargetWidebandFrequencyResponseByRegions or ExportSingleTargetWidebandFrequencyResponseForRegion

.
Parameters
  • FileName
  • The path and name of the file to export to.
  • ShowAverage
  • 0 clears Average results. 1 selects Average results.
  • ShowMinMax
  • 0 clears Include min and max. 1 selects Include min and max.
  • WindowSize
  • Specifies the value of the Window Size.
  • WindowUnit
  • 0 is for Meters, 1 is for Pulse Lengths, 2 is for Samples.
  • MaxTimeDifference
  • Specifies the allowed time separation for variable pings relative to reference variable pings. The time value can be 0.0 to 30.0 seconds.
  • Variable
  • Specifies a TS pulse compressed wideband variable for frequency response calculations.
Return

True, if successful.

Example

Refer to the ExportSingleTargetWidebandFrequencyResponseByRegions example.

ExportSingleTargetWidebandFrequencyResponseForRegion

ExportSingleTargetWidebandFrequencyResponseForRegion(string FileName, boolean ShowAverage, boolean ShowMinMax, double WindowSize, integer WindowUnit, double MaxTimeDifference, EvRegion Region, EvVariableAcoustic Variable)

Summary

Export the wideband frequency response (for one TS variable) to the given file name. The TS frequency response is calculated for all overlapping single targets in a Single target detection - Wideband variable. Refer to the Example to see how the Single target detection - wideband variable and the export settings may be specified.

This function is available to EvVariableVirtual.

Parameters
  • FileName
  • The path and name of the file to export to.
  • ShowAverage
  • 0 clears Average results. 1 selects Average results.
  • ShowMinMax
  • 0 clears Include min and max. 1 selects Include min and max.
  • WindowSize
  • Specifies the value of the Window Size.
  • WindowUnit
  • 0 is for Meters, 1 is for Pulse Lengths, 2 is for Samples.
  • MaxTimeDifference
  • Specifies the allowed time separation for variable pings relative to reference variable pings. The time value can be 0.0 to 30.0 seconds.
  • Region
  • Specify a region via the EvRegion object.
  • Variable
  • Specifies a TS pulse compressed wideband variable for frequency response calculations.
Return

True, if successful.

Example

See the ExportWidebandFrequencyResponse example for context and consider the following snippets:

Dim vEvRegionsCollection: Set vEvRegionsCollection = vEvFile.Regions
Dim vEvSelectedRegion: Set vEvSelectedRegion = vEvRegionsCollection.FindByName("Region 1")
vEvSTVariable.ExportSingleTargetWidebandFrequencyResponseForRegion "C:\Temp\SingleTargetFrequencyResponseRegion.csv", true, true, 0.4, 0, 1.0, vEvSelectedRegion, vEvTSVariable1


ExportFrequencyDistributionByCells

ExportFrequencyDistributionByCells(string FileName, EvRegion)

Summary

Export the 'Frequency distribution by cells' analysis results for a specified region to the given file name.

Parameters
  • FileName
  • The path and name of file to export to.
  • EvRegion
  • The region to constrain the analysis to. If using VBScript, specify 'Nothing' for EvRegion to export an analysis of the whole variable.
Return

True, if successful.

ExportFrequencyDistributionByCellsAll

ExportFrequencyDistributionByCellsAll(string FileName)

Summary

Export the 'Frequency distribution by cells' analysis results for all regions to the given file name.

Parameters
  • FileName
  • The path and name of file to export to.
Note: This method is an alternative for languages that do not support the optional parameter in ExportFrequencyDistributionByCells.
Return

True, if successful.

ExportFrequencyDistributionByRegions

 

ExportFrequencyDistributionByRegions(string FileName, EvRegionClass)

Summary

Export the 'Frequency Distribution by regions' analysis results for a specified region class to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.
  • EvRegionClass
  • The region class to constrain the analysis to. If using VBScript, specify 'Nothing' for EvRegionClass to export all region classes.

Note: If a region class is specified only that region class will be exported. When not specified, all region classes are exported.

Return

True, if successful.

ExportFrequencyDistributionByRegionsAll

 

ExportFrequencyDistributionByRegionsAll(string FileName)

Summary

Export the 'Frequency Distribution by regions' analysis results for all region classes to the given file name.

Parameters
  • FileName
  • The path and name of the file to save results to.

Note: This method is an alternative for languages that do not support the optional parameter in ExportFrequencyDistributionByRegions.

Return

True, if successful.

ExportFrequencyDistributionByRegionsByCells

ExportFrequencyDistributionByRegionsByCells(string FileName, EvRegionClass)

Summary

Export the 'Frequency distribution by regions by cells' analysis results of the specified region class to the given file name.

Parameters
  • FileName
  • The path and name of the file to export to.
  • EvRegionClass
  • The name of the region class to constrain the analysis to. If using VBScript, specify 'Nothing' for EvRegionClass to export all region classes.

Note: If a region class is specified only that region class will be exported. When not specified, all region classes are exported.

Return

True, if successful.

ExportFrequencyDistributionByRegionsByCellsAll

ExportFrequencyDistributionByRegionsByCellsAll(string FileName)

Summary

Export the 'Frequency distribution by regions by cells' analysis results for all region classes to the given file name.

Parameters
  • FileName
  • The path and name of the file to export to.

Note: This method is an alternative for languages that do not support the optional parameter in ExportFrequencyDistributionByRegionsByCells.

Return

True, if successful.

ExportFrequencyDistributionBySingleRegion

ExportFrequencyDistributionBySingleRegion(string FileName, EvRegion)

Summary

Export the 'Frequency distribution by regions' analysis results of a specified region of single target variable to the given file name.

Parameters
  • FileName
  • The path and name of the file to export to.
  • EvRegion
  • The name of the region to constrain the analysis to. Note: When multiple regions have the same name, the first one found is used.
Return

True, if successful.

Example
Dim vEchoviewCom: Set vEchoviewCom = CreateObject("EchoviewCom.EvApplication")
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:Temp\Single Targets Exercise 1.ev")
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("single target detections E1 telegrams T1")
Dim vEvRegionsCollection: Set vEvRegionsCollection = vEvFile.Regions
Dim vEvRegion: Set vEvRegion = vEvRegionsCollection.FindByName("Region1")
vEvVariable.ExportFrequencyDistributionBySingleRegion "C:\Temp\Output\Frequency dist ST region.CSV", vEvRegion

Notes:

  • The ":" allows the Dim and Set statements to appear on one line.
  • The last line of this snippet does not assign a script variable to a value or string. It simply directs Echoview to export the integration results for a region to a file, and as a result the brackets () of the method are omitted. Such syntax is a quirk of VbsScript.

ExportGeoreferencedSamples

ExportGeoreferencedSamples(string FileName, int FirstPing, int LastPing)

Summary

Export the data in a single beam echogram or multibeam echogram as georeferenced samples to a *points.csv or *mb.points.csv file.

Parameters
  • FileName
  • The path and name of the file to export to.
  • FirstPing, LastPing
  • These are optional parameters that specify the first and last ping for the data export.
    The default value for the first ping is -1 and exports from the start of the data.
    The default value for the last ping is -1 and exports to the end of the data.
Return

True, if successful.

Example
       Dim strSbVar: strSbVar = "Sv raw pings T1"
       Dim strMbVar: strMbVar = "Sv pings formed  beams"
       Dim strRegion: strRegion = "Region5"
       Dim strFolder: strFolder = "C:\folder\"
       Dim strEvFile: strEvFile = strFolder &  "EvFile.ev"
       Dim strSbCsv: strSbCsv = strFolder &  "data.sv.points.csv"
       Dim strSbRegionCsv: strSbRegionCsv = strFolder &  "data.points.csv"
       Dim strMbCsv: strMbCsv = strFolder &  "data.sv.mb.points.csv"
       Dim EvApp: Set EvApp =  CreateObject("EchoviewCom.EvApplication")
       Dim EvFile: Set EvFile = EvApp.OpenFile(strEvFile)
       If  EvFile Is Nothing Then
       Msgbox  "Could not open '" & strEvFile & "'"
         WScript.Quit
       End If

       Dim EvSbVar: Set EvSbVar = EvFile.Variables.FindByName(strSbVar).AsVariableAcoustic()
       If EvSbVar Is Nothing Then
       Msgbox  "Acoustic variable '" & strSbVar & "' not found"
         WScript.Quit
       End If
       If Not EvSbVar.ExportGeoreferencedSamples(strSbCsv, 0, 2)  Then
       Msgbox  "Failed to export variable '" & strSbVar & "' to '"  & strSbCsv & "'"
         WScript.Quit
       End If

       Dim EvRegion: Set EvRegion =  EvFile.Regions.FindByName(strRegion)
       If EvRegion Is Nothing Then
       Msgbox  "Region '" & strRegion & "' not found"
         WScript.Quit
       End If
       If Not  EvSbVar.ExportGeoreferencedSamplesForRegion(strSbRegionCsv, EvRegion) Then
       Msgbox  "Failed to export variable '" & strSbVar & "' region  '" & strRegion & "' to '" & strSbRegionCsv &  "'"
         WScript.Quit
       End If

       Dim EvMbVar: Set EvMbVar = EvFile.Variables.FindByName(strMbVar).AsVariableAcoustic()
       If EvMbVar Is Nothing Then
       Msgbox  "Acoustic variable '" & strMbVar & "' not found"
         WScript.Quit
       End If
       If Not EvMbVar.ExportGeoreferencedSamples(strMbCsv, 0, 2)  Then
       Msgbox  "Failed to export variable '" & strMbVar & "' to '"  & strMbCsv & "'"
         WScript.Quit
       End If

ExportGeoreferencedSamplesByRegions

ExportGeoreferencedSamplesByRegions(string FileName, EvRegionClass, int FirstPing, int LastPing)

Summary

Export the data from regions, specified by region class, in a single beam echogram as georeferenced samples to a *points.csv file.

Parameters
  • FileName
  • The path and name of the file to export to.
  • EvRegionClass
  • Specifies the region class or region classes.
  • If using VBScript, specify 'Nothing' for EvRegionClass to export all region classes.
  • Note: If a region class is specified only that region class will be exported. When not specified, all region classes are exported.
  • FirstPing, LastPing
  • These are optional parameters that specify the first and last ping for the data export.
    The default value for the first ping is -1 and exports from the start of the data.
    The default value for the last ping is -1 and exports to the end of the data.
Return

True, if successful.

Example
Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")
Dim vEvFile: Set vEvFile = vEchoviewCom.EvFiles.Item(0)
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("Sv Q1 telegrams T1")
Dim vEvRegionClass: Set vEvRegionClass = vEvFile.RegionClasses.FindByName("Class1")
vEvVariable.ExportGeoreferencedSamplesByRegions "C:\Temp\test.CSV", vEvRegionClass, -1, -1

ExportGeoreferencedSamplesForRegion

ExportGeoreferencedSamplesForRegion(string FileName, EvRegion Region)

Summary

Export the data in a region on a single beam echogram as georeferenced samples to a *points.csv file.

Parameters
  • FileName
  • The path and name of the file to export to.
  • EvRegion
  • The name of the region to export from. Note: When multiple regions have the same name, the first one found is used.
Return

True, if successful.

Example

See Example: ExportGeoreferencedSamples.

GoToPing

boolean GoToPing(ETimeDistanceGridMode Mode, Value)

Summary

Displays a single beam or multibeam echogram centered on the specified ping. This is similar to using Go to: Ping under the Go To dialog box.

This method is available to EvVariableVirtual.

Parameters
  • Mode
  • An ETimeDistanceGridMode enum that is used to specify the Go to mode: Ping, Time, Distance (nmi) or Distance (m).
  • Value
  • Used to specify a ping number, ping time or ping distance. The Go To dialog box discusses accepted ping, time and distance formats.
Return

True when successful.

Examples

Ping snippet

         Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")
                        Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:\Temp\GoToPing.ev")
         Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
         Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("SV T1")
         vEvVariable.GoToPing 4, 100

Time snippet

         vEvVariable.GoToPing 1, CDATE("2006-03-12 8:50:36")

Distance GPS meters snippet

         vEvVariable.GoToPing 5, 6.609


Notes:


GoToPingRange

boolean GoToPingRange(ETimeDistanceGridMode Mode, FirstPing, LastPing, [double StartRange], [double StopRange])

Summary

Displays a ping range on a single beam echogram. This is similar to specifying a ping range under Go to: Ping of the Go To dialog box. Optionally, you can specify the start and stop range of the pings; this is similar to an echogram zoom-in.

This method is available to EvVariableVirtual.

Parameters
  • Mode
  • An ETimeDistanceGridMode enum that is used to specify the Go to mode: Ping, Time, Distance (nmi) or Distance (m).
  • FirstPing
  • Value for the first ping, time, or distance of the ping range. The Go To dialog box discusses accepted ping, time and distance formats.
  • LastPing
  • Value for the last ping, time or distance of the ping range.
  • StartRange
  • Value for the start range of the echogram window, expressed as range in meters. StartRange may be left unspecified; the value defaults to the first sample's range.
  • StopRange
  • Value for the stop range of the echogram window, expresses as range in meters. StopRange may be left unspecified, the value defaults to the last sample's range.
Return

True when successful.

Examples

Ping range with StartRange and StopRange snippet

         Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")
                        Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:\Temp\GoToPing.ev")
         Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
         Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("SV T1")
         vEvVariable.GoToPingRange 4, 11690, 11720, 23.0, 40.0

Time range snippet

         vEvVariable.GoToPingRange 1, CDATE("2006-03-12 08:50:36"), CDATE("2006-03-12 08:50:47")

Distance GPS meters snippet

         vEvVariable.GoToPingRange 5, 6.609, 6.625, 23.9, 40.0


Note: CDATE(YourDateExpresion) is a Visual Basic function that converts YourDateExpression to a date.

GoToRegion

boolean GoToRegion(EvRegion Region)

Summary

Displays a region on a single beam echogram.

This method is available to EvVariableVirtual.

Parameters
  • Region
  • Uses the object EvRegion to specify a region to display on an echogram.
Return

True when successful.

Example
Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:\Temp\GoToPing.ev")
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("SV T1")
Dim vEvRegion: Set vEvRegion = vEvFile.Regions.FindByName("Region 9")
vEvVariable.GoToRegion(vEvRegion)

MaxStopRange

(read-only) double MaxStopRange

Summary

Get the maximum Stop range of all pings in the variable.

Example
option explicit
Dim EvApp Set EvApp = CreateObject("EchoviewCom.EvApplication")
Dim EvFile Set EvFile = EvApp.EvFiles.Item(0)
Dim Var Set Var = EvFile.Variables.FindByName("Sv pings") MsgBox "Minimum Start Range: " & Var.MinStartRange MsgBox "Maximum Stop Range: " & Var.MaxStopRange

MinStartRange

(read-only) double MinStartRange

Summary

Get the minimum Start range of all the pings in the variable.

Example

See MaxStopRange (above).

MeasurementCount

(read-only) int MeasurementCount

Summary

Get the number of pings in the variable.

Name

(read-write) string Name

Summary

Get the name of a variable.

Notes:

  • string FullName is deprecated. The Return is the same as Name.
  • string ShortName is deprecated. The Return is the same as Name.
  • SetFullName can change the Name of an acoustic variable.
Example
Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:\Temp\YourEvFile.ev")
Dim vVariableCollection: Set vVariablecollection=vEvFile.Variables
Dim vVariable: Set vVariable=vVariableCollection.FindByName("Sv pings")

MsgBox  "The variable name is  " + vVariable.Name

PingMode

(read-only) EVariablePingMode PingMode

Summary

Get the ping mode of the pings contained in the variable. The ping mode is specified by the enum EVariablePingMode.

See also: Enum issue under VBS.

Properties

(read-only) EVariableAcousticProperties Properties

Summary

Get the Variable Properties of the current variable using the classes of the EvAcousticVariableProperties object.

PositionVariable

(read-only) PositionVariable

Summary

Get the position variable for the platform.

Useable

(read-only) boolean Useable

Summary

Returns an indication as to whether the variable can be used or not.

  • True if useable.
  • False if not useable.

VariableType

(read-only) VariableType

Summary

Returns an enum representing the type of variable that is represented by this object.

See also

Scripting with COM objects
COM object hierarchy
EvVariableBase
EvVariablesCollection