COM object EvSingleTargetDetectionSplitBeamParameters

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

 

View the COM map and the COM summary.

The EvSingleTargetDetectionSplitBeamParameters object provides access to specific split-beam settings on the Single Target Detection page of the Variable Properties dialog box for the acoustic variable via the EvVariableAcousticProperties.SingleTargetDetectionSplitBeamParameters property.

EvSingleTargetDetectionSplitBeamParameters properties:

BeamCompensationModel
MaximumBeamCompensation
MaximumStdDevOfMajorAxisAngles
MaximumStdDevOfMinorAxisAngles

 

Description

BeamCompensationModel

EBeamCompensation BeamCompensationModel

Summary

Get or set the Beam compensation model setting under the Beam compensation section of the Single Target Detection page of the Variable Properties dialog box.

Example

Common single target settings and split beam specific settings. See also: Enum issue under VBS.

Dim sFile: sFile = "C:\Temp\tmp.EV"
Dim sVar: sVar = "split beam m1"
Const eOperatorSingleTargetDetectionSplitBeamMethod2 = 75
Const eOperatorSingleTargetDetectionSplitBeamMethod1 = 114
 
Dim oEchoviewCom: Set oEchoviewCom = CreateObject("EchoviewCom.EvApplication")
Dim oEvFile: Set oEvFile = oEchoviewCom.OpenFile(sFile)
Dim oVar: Set oVar = oEvFile.Variables.FindByName(sVar)
If oVar.AsVariableVirtual Is Nothing Then
    MsgBox "'" & sVar & "' is not a virtual variable"
End IfeType: eType = oVar.Operator
If Not (eType = eOperatorSingleTargetDetectionSplitBeamMethod1 Or _
        eType = eOperatorSingleTargetDetectionSplitBeamMethod2) Then
    MsgBox "'" & sVar & "' is not a Single split beam Target Detection"
    WScript.Quit
End If
Dim oSingle: Set oSingle = oVar.Properties.SingleTargetDetectionParameters
MsgBox "'" & sVar & "' Single Beam parameters:"_
    & " TsThreshold: " & CStr(oSingle.TsThreshold)_
    & " PLDL: " & CStr(oSingle.PLDL)_
    & " MinimumPulseLength: " & CStr(oSingle.MinimumPulseLength)_
    & " MaximumPulseLength: " & CStr(oSingle.MaximumPulseLength)_
    & " ExcludeAboveLine: " & oSingle.ExcludeAboveLine _
    & " ExcludeBelowLine: " & oSingle.ExcludeBelowLine
 
oSingle.ExcludeAboveLine = "Line 1"
MsgBox "'" & sVar & "' ExcludeAboveLine: " & oSingle.ExcludeAboveLine
 
If eType = eOperatorSingleTargetDetectionSplitBeamMethod1 Or _
   eType = eOperatorSingleTargetDetectionSplitBeamMethod2 Then
    Dim oSplit: Set oSplit = oVar.Properties.SingleTargetDetectionSplitBeamParameters
    MsgBox "'" & sVar & "' Split Beam parameters:"_
        & " BeamCompensationModel: " & CStr(oSplit.BeamCompensationModel)_
        & " MaximumBeamCompensation: " & CStr(oSplit.MaximumBeamCompensation)_
        & " MaximumStdDevOfMinorAxisAngles: " & CStr(oSplit.MaximumStdDevOfMinorAxisAngles)_
        & " MaximumStdDevOfMajorAxisAngles: " & CStr(oSplit.MaximumStdDevOfMajorAxisAngles)
End If

MaximumBeamCompensation

double MaximumBeamCompensation

Summary

Get or set the Maximum beam compensation (dB) setting under the Beam compensation section of the Single Target Detection page of the Variable Properties dialog box.

Example

Refer to single target and split beam detection settings example.

MaximumStdDevOfMajorAxisAngles

double MaximumStdDevOfMajorAxisAngles

Summary

Get or set the Maximum standard deviation of Major-axis angles (degrees) setting under the Exclusion section of the Single Target Detection page of the Variable Properties dialog box.

Example

Refer to single target and split beam detection settings example.

MaximumStdDevOfMinorAxisAngles

double MaximumStdDevOfMinorAxisAngles

Summary

Get or set the Maximum standard deviation of Minor-axis angles (degrees) setting under the Exclusion section of the Single Target Detection page of the Variable Properties dialog box.

Example

Refer to single target and split beam detection settings example.

Notes:

See also

Scripting with COM objects
COM object hierarchy