COM object EvSingleTargetDetectionParameters

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

 

View the COM map and the COM summary.

The EvSingleTargetDetectionParameters object provides access to single target detection settings on the Single Target Detection page of the Variable Properties dialog box for the acoustic variable via the EvVariableAcousticProperties.SingleTargetDetectionParameters property.

EvSingleTargetDetectionParameters properties:

ExcludeAboveLine
ExcludeBelowLine
MaximumPulseLength
MinimumPulseLength
PLDL
TsThreshold

 

Description

ExcludeAboveLine

string ExcludeAboveLine

Summary

Get or set the Exclude targets above line setting under the Line Exclusion section of the Single Target Detection page of the Variable Properties dialog box.

Example
      Dim sFile: sFile = "C:\Temp\tmp.EV"
      Dim sVar: sVar = "single beam m1"
      
      Const eOperatorSingleTargetDetectionSingleBeamMethod2 = 74
      Const eOperatorSingleTargetDetectionSingleBeamMethod1 = 115 
      
      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 If 
      Dim eType: eType = oVar.Operator 
      If Not (eType = eOperatorSingleTargetDetectionSingleBeamMethod2 Or _ 
         eType = eOperatorSingleTargetDetectionSingleBeamMethod1) Then 
        MsgBox "'" & sVar & "' is not a Single 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

This example works around a known Enum issue under VBS.

ExcludeBelowLine

string ExcludeBelowLine

Summary

Get or set the Exclude targets below line setting under the Line Exclusion section of the Single Target Detection page of the Variable Properties dialog box.

Example

Refer to the single target detection parameters example.

MaximumPulseLength

double MaximumPulseLength

Summary

Get or set the Maximum normalized pulse length setting under the General parameters section of the Single Target Detection page of the Variable Properties dialog box.

Example

Refer to the single target detection parameters example.

MinimumPulseLength

double MinimumPulseLength

Summary

Get or set the Minimum normalized pulse length setting under the General parameters section of the Single Target Detection page of the Variable Properties dialog box.

Example

Refer to the single target detection parameters example.

PLDL

double PLDL

Summary

Get or set the Pulse length determination level (dB) setting under the General parameters section of the Single Target Detection page of the Variable Properties dialog box.

Example

Refer to the single target detection parameters example.

TsThreshold

double TsThreshold

Summary

Get or set the TS threshold (dB) setting under the General parameters section of the Single Target Detection page of the Variable Properties dialog box.

Example

Refer to the single target detection parameters example.

 

Note:

See also

Scripting with COM objects
COM object hierarchy