COM object EvVariableVirtual

EvApplication > EvFile > EvVariablesCollection > EvVariableBase As EvVariableVirtual

View the Echoview COM object hierarchy and the Echoview summary of COM objects.

The EvVariableVirtual object gives access to information on and actions for a virtual 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 following EvVariableVirtual methods and properties are detailed below

Methods

Properties

AsVariableBase
AsVariableAcoustic
AsVariableVirtual

ClassifyRegion
CreateLineRelativeRegion
CreateCurtin
Create3DFishTracks
Create3DSingleTargets
DetectFishTracks
DetectSchools
DetectSurface
DetectSurfaceFromLine
PickLine

ExportData
ExportLine
ExportEVE
ExportHAC
ExportUnderlyingData
ExportEchogramToImage

ExportIntegrationByRegions
ExportIntegrationByRegionsAll
ExportIntegrationByCells
ExportIntegrationByCellsAll
ExportIntegrationByRegionsByCells
ExportIntegrationByRegionsByCellsAll
ExportIntegrationBySingleRegionByCells

ExportFishTracksByCells
ExportFishTracksByCellsAll
ExportFishTracksByRegions
ExportFishTracksByRegionsAll

ExportDataForRegion

ExportSingleTargetsByCells
ExportSingleTargetsByCellsAll
ExportSingleTargetsByRegions
ExportSingleTargetsByRegionsAll
ExportSingleTargetsByRegionsByCells
ExportSingleTargetsByRegionsByCellsAll

ExportFrequencyDistributionByCells
ExportFrequencyDistributionByCellsAll
ExportFrequencyDistributionByRegions
ExportFrequencyDistributionByRegionsAll
ExportFrequencyDistributionByRegionsByCells
ExportFrequencyDistributionByRegionsByCellsAll
ExportFrequencyDistributionBySingleRegion

ExportGeoreferencedSamples
ExportGeoreferencedSamplesForRegion

SetFullName

DataType
FullName
MaxStopRange
MinStartRange
MeasurementCount
Name
PingMode
Properties
PositionVariable
ShortName
Useable
VariableType

OperatorType
OperatorName

EvVariableVirtual implements the following methods and properties:

EvVariableVariable methods

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.

ClassifyRegion

ClassifyRegion (EvRegion Region)

Summary

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

Notes:

Classification rules are specified for the EV file on the Classifcation page of the EV File Properties dialog box. Region classes for classification are specified on the Classes page of the EV File Properties dialog box.
See also EvRegion.Classify.

Parameters

Region
The region specified by EvRegion. When no region is specified, Echoview classifies all regions in the acoustic variable.

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

See EvVariable.Acoustic.CreateCurtain

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.

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 schools 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.

ExportData

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

Summary

Export the data in the echogram. See also:

Export file formats: Data
Notes and example for EvVariableBase.ExportData

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

If successful.

ExportLine

ExportLine(EvLine Line, string FileName, integer FirstPing, integer 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

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

ExportEVE

ExportEVE(string FileName, boolean ExportPings, boolean ExportFishTracks, boolean ExportCells)

Summary

Export the specified data for the current variable to the Echoview data export .eve format.

Parameters

FileName
The path and name of file to export the .eve data to.
ExportPings
TRUE selects Ping data to export for the current variable.
ExportFishTracks
TRUE selects Fish tracks (for single target variables) data to export for the current variable.
ExportCells
TRUE selects Cell integration data to export for the current variable.

Return

If successful.

Example

Dim EvApp: Set EvApp = CreateObject("EchoviewCom.EvApplication")
 Dim EvFile: Set EvFile = EvApp.OpenFile("C:\TTPs\ek60 2.EV")
 If EvFile Is Nothing Then
     MsgBox "Failed to open EV file"
 Else
     '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
     ' Get the variable
     Dim Var: Set Var = EvFile.Variables.FindByName("Sv raw pings T1")
     If Var Is Nothing Then
         MsgBox "Failed to find variable"
     Else
         Dim VarAc: Set VarAc = Var.AsVariableAcoustic
         If VarAc Is Nothing Then
             MsgBox "Variable is not acoustic"
         Else
             '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
             ' Export the variable
             MsgBox "about to export"
             If Not VarAc.ExportEVE("C:\TTPs\14671\script-output2.eve", true, true, true) Then
                 MsgBox "Failed to export to EVE"
             End If
         End If
     End If
 End If
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 ' Tidy up
 EvApp.CloseFile(EvFile)

ExportHAC

ExportHAC(string FileName, [integer StartPing], [integer 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 all pings.
StopPing
Optional integer value for the ping to end the HAC data export. The default value is -1 and exports all pings.
CompressedTuples
Optional selection to export as compressed tuples. The default value is FALSE for uncompressed tuples.

Return

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)

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

If successful.

ExportEchogramToImage

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

Summary

Export a selection from the virtual 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 an acoustic variable echogram.

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 all pings in the selection.
StopPing
Optional stop ping the selection. The default value is -1 and exports all pings in the selection.

Return

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

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 paramenter in ExportIntegrationByRegions.

Return

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
The region to constrain the analysis to. If using VBScript, specify 'Nothing' for EvRegion to export an analysis of the whole variable.

Return

If successful.

ExportIntegrationByCellsAll

ExportIntegrationByCellsAll(string FileName)

Summary

Export the 'Integration by cells' analysis results for all regions 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 paramenter in ExportIntegrationByCells.

Return

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

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 paramenter in ExportIntegrationByRegionsByCells.

Return

If successful.

ExportIntegrationBySingleRegionByCells

ExportIntegrationBySingleRegionByCells(string FileName, EvRegion)

Summary

Export the 'Integration by regions by cells' analysis result for a specified region of a virtual 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.

Return

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("Resample 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 (resampled) 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

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 paramenter in ExportFishTracksByCells.

Return

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

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 paramenter in ExportFishTracksByRegions.

Return

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.

Return

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.

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

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 paramenter in ExportSingleTargetsByCells.

Return

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

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 paramenter in ExportSingleTargetsByRegions.

Return

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

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 paramenter in ExportSingleTargetsByRegionsByCells.

Return

If successful.

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

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 paramenter in ExportFrequencyDistributionByCells.

Return

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

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 paramenter in ExportFrequencyDistributionByRegions.

Return

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

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 paramenter in ExportFrequencyDistributionByRegionsByCells.

Return

If successful.

ExportFrequencyDistributionBySingleRegion

ExportFrequencyDistributionBySingleRegion(string FileName, EvRegion)

Summary

Export the 'Frequency distribution by regions' analysis results of a specified region of virtual 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.

Return

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("Target method 2")

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

boolean ExportGeoreferencedSamples(string FileName, int StartPing, int StopPing)

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.
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

If successful.

Example

Use AsVariableVirtual to specify the variable and see Example: ExportGeoreferencedSamples

ExportGeoreferencedSamplesForRegion

boolean 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.

Return

If successful.

Example

Use AsVariableVirtual to specify the variable and see Example: ExportGeoreferencedSamples.

SetFullName

SetFullName(string Name)

Summary

Set the full name of this virtual variable.

Parameters

Name
The name the variable is to be given. If this name is not unique in the EV file, an exception will be thrown.

Return

Boolean.

EvVariableVariable properties	Description
DataType	(read-only) EVariableDataType DataType Summary Get the data type that the variable contains. The data type is specified by the enum EVariableDataType.
FullName	(read-only) string FullName Summary Gets the full name of a variable, disregarding any short name.
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 pings in the variable. Example See MaxStopRange (above).
MeasurementCount	(read-only) int MeasurementCount Summary Get the number of pings in the variable.
Name	(read-only) string Name Summary Gets the name of a variable, or the short name if set.
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.
Properties	(read-only) EVariableAcousticProperties Properties Summary Get the acoustic properties of the current variable using the properties of the EvAcousticVariableProperties object.
PositionVariable	(read-only) PositionVariable Summary Get the position variable for the platform.
ShortName	(read-write) string ShortName Summary Gets and sets the short name of a variable.
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.
OperatorType	(read-only) integer OperatorType Summary Get a unique number to identify the type of operator that this variable is created from. Refer to Echoview COM constants for lists of the numbers and operator types.
OperatorName	(read-only) string OperatorName Summary Get the name of the operator that this variable is created from.