COM object EvAttenuatedSignal

EvApplication> EvFileCollection > Evfile > EvVariablesCollection > EvVariableBase As EvVariableVirtual > EvVariableAcousticProperties > EvAttenuatedSignal

 

View the COM map and the COM summary.

The EvAttenuatedSignal object gives you access to information about settings on the Attenuated Signal Removal page of the Variable Properties dialog box of the acoustic variable via the EvVariableAcousticProperties.AttenuatedSignal property.

EvAttenuatedSignal properties:

ContextHorizontalSize
ExcludeAboveLine
ExcludeBelowLine
Percentile
SampleReplacement
SampleReplacementPercentile
SampleThreshold

 

Description

ContextHorizontalSize

Integer ContextHorizontalSize

Summary

Access or specify the value for Context window size (pings) on the Attenuated Signal Removal page of the virtual variable. The value restricted to odd integers.

Return

The value for Context window size (pings).

Example
Const EAttenuatedSignalReplacement_Percentile = 1
Dim EvApp: Set EvApp = CreateObject("EchoviewCom.EvApplication")
Dim EvFile: Set EvFile = EvApp.OpenFile("C:\YourEVFile.ev")
Dim vEvVariablesCollection: Set EvVariablesCollection = EvFile.Variables
Dim vEvVariable: Set EvVariable = EvVariablesCollection.FindByName("Attenuated signal 1")
EvVariable.Properties.AttenuatedSignal.ExcludeAboveLine = "200m line"
EvVariable.Properties.AttenuatedSignal.ExcludeBelowLine = "400m line"
EvVariable.Properties.AttenuatedSignal.ContextHorizontalSize = 11
EvVariable.Properties.AttenuatedSignal.Percentile = 55

EvVariable.Properties.AttenuatedSignal.SampleReplacement = 1
EvVariable.Properties.AttenuatedSignal.SampleReplacementPercentile = 20

This example works around the VBS Enum issue.

ExcludeAboveLine

String ExcludeAboveLine

Summary

Access or specify the line for Exclude above on the Attenuated Signal Removal page of the virtual variable. The line name is handled as a string.

Return

Exclude above line name as a string.

Example

AttenuatedSignal example

ExcludeBelowLine

String ExcludeBelowLine

Summary

Access or specify the line for Exclude below on the Attenuated Signal Removal page of the virtual variable. The line name is handled as a string.

Return

Exclude below line name as a string.

Example

AttenuatedSignal example

Percentile

Integer Percentile

Summary

Accesses or specifies the value for (Detection) Percentile on the Attenuated Signal Removal page of the virtual variable.

Return

Value for the (Detection) Percentile.

Example

AttenuatedSignal example

SampleReplacement

EAttenuatedSignalReplacement SampleReplacement

Summary

Accesses or specifies the Replacement value method on the Attenuated Signal Removal page of the virtual variable. The Replacement method is an enum value under EAttenuatedSignalReplacement.

Return

EAttenuatedSignalReplacement

Example

AttenuatedSignal example

See also: Enum issue under VBS.

SampleReplacementPercentile

Integer SampleReplacementPercentile

Summary

Accesses or specifies the (Replacement) Percentile on the Attenuated Signal Removal page of the virtual variable.

Return

Value for the (Replacement) Percentile.

Example

AttenuatedSignal example

SampleThreshold

double SampleThreshold

Summary

Accesses or specifies the (Detection) Threshold on the Attenuated Signal Removal page of the virtual variable.

Return

The value for the (Detection) Threshold.

Example

AttenuatedSignal example

See also

Scripting with COM objects
COM object hierarchy