COM object EvVariableAcousticProperties

EvApplication > EvFileCollection > EvFile > EvVariablesCollection >EvVariableBase As EvVariableAcoustic > EvVariableAcousticProperties

- OR -

EvApplication > EvFileCollection > EvFile > EvVariablesCollection >EvVariableBase As EvVariableVirtual > EvVariableAcousticProperties


View the COM map and the COM summary.

The EvVariableAcousticProperties object gives you access to information about the variable properties of the acoustic variable via the EvVariableAcoustic.Properties property.

EvVariableAcousticProperties classes:

Analysis
AttenuatedSignal
BeamSelect
BeamSubset
Calibration
ConvolutionCells
Data
DataRangeBitmap
Display
FilterTargets
Generator
GlcmTexture
Grid
ImpulseNoiseRemoval
KovesiDenoising
Mask
MuiltibeamBackgroundRemoval
PingSubset
Resample
SingleTargetDetectionDualBeamParameters
SingleTargetDetectionParameters
SingleTargetDetectionSplitBeamParameters
SingleTargetDetectionWidebandParameters
TransientNoiseRemoval

Note: Echoview COM scripting support is limited. However, wider support via scripting is available through the command interface.

Description

Analysis

EvAnalysis (read-only) Analysis

Summary

Allows access to settings on the Analysis page of the Variable Properties dialog box for the acoustic variable, via the EvAnalysis object.

Return

EvAnalysis

Example

See EvAnalysis

AttenuatedSignal

EvAttenuatedSignal (read-only) AttenuatedSignal

Summary

Allows access to settings on the Attenuated Signal Removal page of the Variable Properties dialog box of the virtual variable, via the EvAttenuatedSignal object.

Return

EvAttenuatedSignal

If the variable is not an Attenuated Single virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Example

EvAttenuatedSignal example.

BeamSelect

EvBeamSelect (read-only) BeamSelect

Summary

Allows access to Beam number on the Beam Select page of the Variable Properties dialog box of the virtual variable, via the EvBeamSelect object.

Return

EvBeamSelect

If the variable is not a Beam select virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Example

See EvBeamSelect.

BeamSubset

EvBeamSubset (read-only) BeamSubset

Summary

Allows access to Range(s) on the Beam Subset page of the Variable Properties dialog box of the virtual variable, via the EvBeamSubset object.

Return

EvBeamSubset

If the variable is not a Beam subset virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Example

See EvBeamSubset.

Calibration

EvCalibration (read-only) Calibration

Summary

Allows access to calibration settings available on the Calibration page of the Variable Properties dialog box for the acoustic variable, via the EvCalibration object.

Return

EvCalibration

Example

EvCalibration example.

ConvolutionCells

EvConvolutionCellsCollection (read-only) ConvolutionCells

See EvConvolutionCellsCollection object.

Summary

Allows access to settings on the Convolution page of the Variable Properties dialog box for the acoustic virtual variable, via the EvConvolutionCellsCollection object. The collection object accesses the number of cells in the convolution kernel and the values for kernel.

Return

EvConvolutionCellsCollection

If the variable is not a convolution virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Data

EvData (read-only) Data

Summary

Allows access to settings on the Data page of the Variable Properties dialog box for the acoustic variable, via the EvData object.

Return

EvData

Example

See EvData.

DataRangeBitmap

EvDataRangeBitmap (read-only) DataRangeBitmap

Summary

Allows access to settings on the DataRangeBitmap page of the Variable Properties dialog box for the acoustic virtual variable, via the EvDataRangeBitmap object.

Return

EvDataRangeBitmap

If the variable is not a Data range bitmap virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Display

EvDisplay (read-only) Display

Summary

Allows access to settings on the Echogram Display page of the Variable Properties dialog box for the acoustic variable, via the EvDisplay object.

Return

EvDisplay

FilterTargets

EvFilterTargets (read-only) FilterTargets

Summary

Allows access to settings on the Filter Targets page of the Variable Properties dialog box for the acoustic variable, via the EvFilterTargets object.

Return

EvFilterTargets

If the variable is not a single targets virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Example

Wideband example

Generator

EvGenerator (read-only) Generator

Summary

Allows access to settings on the Generator page of the Variable Properties dialog box for the acoustic virtual variable, via the EvGenerator object.

Return

EvGenerator

If the variable is not a Data generator virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

GlcmTexture

EvGlcmTexture (read-only) GlcmTexture

Summary

Allows access to settings on the GLCM Texture page of the Variable Properties dialog box for the acoustic virtual variable, via the EvGlcmTexture object.

Return

EvGlcmTexture

If the variable is not a GLCM texture feature virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Grid

EvGrid (read-only) Grid

Summary

Allows access to settings on the Grid page of the Variable Properties dialog box for the acoustic variable, via the EvGrid object.

Return

EvGrid

Example

See EvGrid.

ImpulseNoiseRemoval

EvImpulseNoiseRemoval (read-only) ImpulseNoiseRemoval

Summary

Allows access to settings on the Impulse Noise Removal page of the Variable Properties dialog box of the virtual variable, via the EvImpulseNoiseRemoval object.

Return

EvImpulseNoiseRemoval

If the variable is not an Impulse noise removal virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Example

See EvImpulseNoiseRemoval.

KovesiDenoising

EvKovesi (read-only) KovesiDenoising

Summary

Allows access to settings on the Kovesi image denoising page of the Variable Properties dialog box for the acoustic virtual variable, via the EvKovesi object.

Return

EvKovesi

If the variable is not a Kovesi image denoising virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Mask

EvMask (read-only) Mask

Summary

Allows access to settings on the Mask page of the Variable Properties dialog box for the acoustic virtual variable, via the EvMask object.

Return

EvMask

If the variable is not a Mask virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

MultibeamBackgroundRemoval

EvMultibeamBackgroundRemoval (read-only) MultibeamBackgroundRemoval

Summary

Allows access to settings on the Background Removal page of the Variable Properties dialog box for the acoustic virtual variable, via the EvMultibeamBackgroundRemoval object.

Return

EvMultibeamBackgroundRemoval

If the variable is not a Multibeam background removal virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

PingSubset

EvPingSubet (read-only) PingSubset

Summary

Allows access to settings on the Ping Subset page of the Variable Properties dialog box for the acoustic virtual variable, via the EvPingsubset object.

Return

EvPingSubset

If the variable is not a Ping subset virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Example

See EvPingSubset.

Resample

EvResample (read-only) Resample

Summary

Allows access to settings on the Resample page of the Variable Properties dialog box for the acoustic virtual variable, via the EvResample object.

Return

EvResample

If the variable is not a Resample virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Example

See EvResample.

SingleTargetDetectionDualBeamParameters

EvSingleTargetDetectionDualBeamParameters
(read-only) SingleTargetDetectionDualBeamParameters

See EvSingleTargetDetectionDualBeamParameters object.

Summary

Allows access to dual beam single target detection settings on the Single Target Detection page of the Variable Properties dialog box for Single target detection dual beam method 1 and 2 variables, via the EvSingleTargetDetectionDualBeamParameters object.

See also (common) SingleTargetDetectionParameters.

Return

EvSingleTargetDetectionDualBeamParameters

If the variable is not a Single target dual beam detection virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Example

Refer to Single target and dual beam detection settings example.

SingleTargetDetectionParameters

EvSingleTargetDetectionParameters (read-only) SingleTargetDetectionParameters

See EvSingleTargetDetectionParameters object.

Summary

Allows access to selected (common) settings on the Single Target Detection page of the Variable Properties dialog box for Single target detection method 1 and 2 variables, via the EvSingleTargetDetectionParameters object.

Return

EvSingleTargetDetectionParameters

If the variable is not a Single target detection virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Example

Refer to Single target detection settings example.

SingleTargetDetectionSplitBeamParameters

EvSingleTargetDetectionSplitBeamParameters
(read-only) SingleTargetDetectionSplitBeamParameters

Summary

Allows you to determine selected split beam single target detection settings on the Single Target Detection page of the Variable Properties dialog box for Single target detection split beam method 1 and 2 variables, via the EvSingleTargetDetectionSplitBeamParameters object.

See also (common) SingleTargetDetectionParameters.

Return

EvSingleTargetDetectionSplitBeamParameters

If the variable is not a Single target split beam detection virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Example

Refer to Single target and split beam detection settings example.

SingleTargetDetectionWidebandParameters

EvSingleTargetDetectionWidebandParameters
(read-only) SingleTargetDetectionWidebandParameters

Summary

Allows you to determine selected single target detection - wideband settings on the Single Target Detection page of the Variable Properties dialog box, via the Ev SingleTargetDetectionWidebandParameters object.

See also (common) SingleTargetDetectionParameters.

Return

EvSingleTargetDetectionWidebandParameters

If the variable is not a Single target detection wideband virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Example

Wideband example.

TransientNoiseRemoval

EvTransientNoiseRemoval (read-only) TransientNoiseRemoval

Summary

Allows access to settings on the Transient Noise Sample Removal page of the Variable Properties dialog box of the virtual variable, via the EvTransientNoiseRemoval object.

Return

EvTransientNoiseRemoval

If the variable is not a Transient noise removal virtual variable, it will return 'Nothing', and an error will be logged to the Echoview scripting log.

Example

See EvTransientNoiseRemoval.

See also

Scripting with COM objects
COM object hierarchy
EvVariableAcoustic
EvVariableBase