Summary of COM objects

The summary of Echoview COM objects lists the relationship between the COM object and Echoview.

COM object

Description

EvAnalysis

The EvAnalysis object gives you access to settings on the Analysis page of the Variable Properties dialog box of the acoustic variable.

EvApplication

Use EvApplication to access Echoview via COM. All Echoview’s COM automation functionality is begun through this object. Included is COM access to the Command interface.

EvAttenuatedSignal

The EvAttenuatedSignal object accesses and changes the Attenuated Signal Removal page settings of an Attenuated Signal Removal virtual variable.

EvBeamSelect

The EvBeamSelect object accesses and changes the Beam Select page settings of a Beam Select virtual variable.

EvBeamSubset

The EvBeamSubset object accesses and changes the Beam Subset page settings of a Beam Subset virtual variable.

EvCalibration

The EvCalibration object gives you access to settings on the Calibration page of the Variable Properties dialog box

of the acoustic variable.

EvConvolutionCellsCollection

The EvConvolutionCellsCollection object gives you access to settings on the Convolution page of the Variable Properties dialog box of the acoustic virtual variable.

EvData

The EvData object gives you access to settings on the Data page of the Variable Properties dialog box of the acoustic variable.

EvDatafile

The EvDataFile object is used to access information about a data file in an EV file.

EvDataFilesCollection

The EvDataFilesCollection object gives you access to information about and the ability to add and remove data files in an EV file.

EvDataLogger

The EvDataLogger object is used to access information about the data logger used with Echoview during live viewning. The data loggers collection is available through EvApplication.

EvDataLoggersCollection

The EvDataLoggersCollection object access information about the data loggers used with Echoview while live viewing. The collection is available through Evapplication.

EvDataPaths

The EvDataPaths object gives you access to settings under the Data file locations section of the EV File page of the EV File Properties dialog box. This object allows you to seek information on data paths and allows you to add, remove and modify the data paths that Echoview looks for and uses, in an EV file.

EvDataRangeBitmap

The EvDataRangeBitmap object gives you access to settings on the Data Range Bitmap page of the Variable Properties dialog box of the acoustic virtual variable.

EvDisplay

The EvDisplay object gives you access to settings on the Echogram Display page of the Variable Properties dialog box of the acoustic variable.

EvFile

The EvFile object accesses information about, and performs actions on, an EV file.

Supported EV file properties include selected settings on the:

  • Schools page
  • Export page
  • EV file page (Data file locations)
  • Single beam (Line picking algorithm) tab of the Lines and Surfaces page
  • Fish tracks page (Fish track properties)
  • Classes page (Species properties)

Selected settings for these features are also supported:

  • Filesets
  • Lines
  • 3D objects
  • Region classes
  • Regions
  • Variables (Acoustic, Virtual, Position)
  • Transducers (Dataflow object)
  • Scenes (Scene window)

EvFileCollection

The EvFileCollection object governs access to a set of EV files.

EvFileEchogramProperties

The EvFileEchogramProperties object gives you access to the settings under the Echogram Mode section on the Echogram page of the EV File Properties dialog box.

EvFileset

The EvFileset object enables you to get information about the fileset and change aspects of the fileset. This includes the handling of an ECS file (to change calibration settings).

EvFilesetsCollection

The EvFilesetsCollection object accesses information about the set of filesets in an EV file.

EvFileProperties

The EvFileProperties object gives you access to settings on the EV File Properties dialog box.

EvFileExportProperties

The EvFileExportProperties object gives you access to settings on the Export page of the EV File Properties dialog box.

EvFileExportVariable

The EvFileExportVariable object gives you access to analysis variable variables. Set to export or Clear for export.

EvFileExportVariablesCollection

The EvFileExportVariablesCollection object gives you access to the set of analysis variables to export from in an EV file.

EvFilterTargets

The EvFilterTargets object gives you access to the settings on the Filter Targets page of the Variable Properties dialog box for single target variables.

EvFishTrackingProperties

 

The EvFishTrackingProperties object gives you access to settings on the Track Detection Properties dialog box.

EvFishTrackingAnglesAndRange

 

The EvFishTrackingAnglesAndRange object gives you access to settings on the Algorithm page of the Track Detection Properties dialog box.

EvFishTrackingWeights

 

The EvFishTrackingWeights object gives you access to settings on the Weights page of the Track Detection Properties dialog box.

EvGenerator

The EvGenerator object gives you access to settings on the Generator page of the Variable Properties dialog box of the acoustic virtual variable.

EvGlcmTexture

The EvGlcmTexture object gives you access to settings on the GLCM Texture page of the Variable Properties dialog box of the acoustic virtual variable.

EvGrid

The EvGrid object provides information about and allows you to set the settings on the Grid page of the Variable Properties dialog box for the acoustic variable.

EvImpulseNoiseRemoval

The EvImpulseNoiseRemoval object gives you access to settings on the Impulse Noise Removal page of the Impulse Noise Removal virtual variable.

EvKovesi

The EvKovesi object gives you access to settings on the Kovesi image denoising page of the Variable Properties dialog box for the acoustic variable.

EvLine

The EvLine object gives you the ability to determine line type, to access or to change line names and the ability to export lines from an EV file.

EvLinesCollection

The EvLinesCollection object gives you information about the number of lines or a line in an EV file and allows you to create or delete editable lines.

EvLineEditable

The EvLineEditable object gives you the ability to access or to change editable line names, and the ability to export or overwrite editable lines from an EV file.

EvLinePickProperties

The EvLinePickProperties object gives you the ability to access editable line settings on the Single beam tab of the Lines and Surfaces page of the EV File Properties dialog box. It is accessed through the EvFileProperties.LinePick property.

EvMask

The EvMask object gives you access to settings on the Mask page of the Variable Properties dialog box of the acoustic virtual variable.

EvMultibeamBackgroundRemoval

The EvMultibeamBackgroundRemoval object gives you access to settings on the Background removal page of the Variable Properties dialog box of the acoustic virtual variable.

EvObject3D

The EvObject3D object gives you the ability access information about 3D objects and to export 3D objects from an EV file.

EvObjects3DCollection

The EvObjects3DCollection object gives you information about the 3D objects in an EV file.

EvPingSubset

The EvPingSubset object gives you access to settings on the Ping subset page of the Variable Properties dialog box of the acoustic virtual variable.

EvPlatform

The EvPlatform object gives you access to settings on the Platform Properties dialog box.

EvPlatformsCollection

The EvPlatformsCollection object gives you information about the platforms in an EV file.

EvRegion

The EvRegion object gives you access to and the ability to modify an Echoview 2D region or 3D region.

EvRegionsCollection

The EvRegionsCollection object gives you access to information about the set of regions defined, and the ability to import region definitions into an EV file.

EvRegionClass

The EvRegionClass object enables you to get information about and modify a region class.

EvRegionClassesCollection

The EvRegionClassesCollection object gives you access to information about and the ability to add and delete a region class.

EvResample

The EvResample object enables you to inspect or set supported settings on the Resample page for any of the (three) variations of the Resample operator.

EvSchoolsDetection2D

The EvSchoolsDetection2D object gives you access to settings on the Schools page of the EV File Properties dialog box of the acoustic variable.

EvSingleTargetDetectionDualBeamParameters

The EvSingleTargetDetectionDualBeamParameters object gives you a access to the Single target detection - dual beam method 1 and method 2 settings Maximum Beam Compensation and Over Axis Angle Threshold on the Single Target Detection page of the Variable Properties dialog box.

Other common single target parameters are accessed via EvSingleTargetDetectionParameters.

Filter Targets page settings are accessed via EvFilterTargets.

EvSingleTargetDetectionParameters

The EvSingleTargetDetectionParameters object gives you access to common Single target detection settings Exclude Above Line, Exclude Below line, Maximum Pulse Length, Minimum Pulse length, PLDL and TS Threshold on Single Target Detection page of the Variable Properties dialog box.

Specific split beam parameters are accessed via EvSingleTargetDetectionSplitBeamParameters.

Specific dual beam parameters are accessed via EvSingleTargetDetectionDualBeamParameters.

Specific widebeam parameters are accessed via EvSingleTargetDetectionWidebeamParameters.

Filter Targets page settings are accessed via EvFilterTargets.

EvSingleTargetDetectionSplitBeamParameters

The EvSingleTargetDetectionSplitBeamParameters object gives you a access to the Single target detection - split beam method 1 and method 2 settings Beam Compensation Model, Maximum Beam Compensation, Maximum standard deviation of Minor-axis angles and Maximum standard deviation of Major-axis angles on the Single Target Detection page of the Variable Properties dialog box.

Other common single target parameters are accessed via EvSingleTargetDetectionParameters.

Filter Targets page settings are accessed via EvFilterTargets.

EvSingleTargetDetectionWidebeamParameters

The EvSingleTargetDetectionWidebeamParameters object gives you a access to the Single target detection - Widebeam settings Beam Compensation Model, Maximum Beam Compensation, Maximum standard deviation of Minor-axis angles and Maximum standard deviation of Major-axis angles on the Single Target Detection page of the Variable Properties dialog box.

Other common single target parameters are accessed via EvSingleTargetDetectionParameters.

Filter Targets page settings are accessed via EvFilterTargets.

EvScene

The EvScene object gives you the ability access and export information about scenes in an EV file.

EvScenesCollection

The EvScenesCollection object accesses information about the set of scenes in an EV file.

EvSpecies

The EvSpecies object gives you access to species settings on Species Properties dialog box, which is displayed when you click Properties under the Species section on the Classes page of the EV File Properties dialog box.

EvSpeciesCollection

The EvSpeciesCollection object accesses information about the species in an EV file.

EvTransducer

The EvTransducer object allows you access to selected transducer settings on the General, Location and Orientation pages of the Transducer Properties dialog box. The EvTransducersCollection specifies the transducer.

EvTransducersCollection

The EvTransducersCollection object accesses transducers in an EV file.

EvTransientNoiseRemoval

The EvTransientNoiseRemoval object gives you access to settings on the Transient Noise Removal page of the Transient Noise Removal virtual variable.

EvVariableAcousticProperties

The EvVariableAcousticProperties object gives you access to the variable properties of the acoustic variable.

Available Properties pages include:

  • Analysis
  • Attenuated Signal
  • Beam Select
  • Beam Subset
  • Calibration
  • Convolution Cells
  • Data
  • Data Range Bitmap
  • Display
  • Filter Targets
  • Generator
  • GlcmTexture
  • Grid
  • Impulse Noise Removal
  • Kovesi Denoising
  • Mask
  • (Multibeam) Background removal
  • Ping Subset
  • Resample
  • Single Target Detection Dual Beam Parameters
  • Single Target Detection Parameters
  • Single Target Detection Split Beam Parameters
  • Single Target Detection Wideband Parameters
  • Transient Noise Removal

EvVariableBase

The EvVariableBase object gives access to information on, and actions for, a variable in an EV file.

The EvVariableAcoustic object gives access to information on, and actions for, an acoustic variable in an EV file. EvVariableAcoustic implements many common script methods including create, classify, detect, export and add new virtual variable commands.

The EvVariableVirtual object gives access to information on, and actions for, a virtual variable in an EV file. Many properties and methods available to EvVariableAcoustic are also available to EvVariableVirtual. EvVirtualVariable, alone, offers GetOperand, SetOperand and Operator and OperatorName.

EvVariablesCollection

The EvVariablesCollection object allows you to access the set of variables in an EV file. This includes raw acoustic variables, virtual variables and position variables.

See also

Scripting with COM objects
Echoview COM object hierarchy