COM object EvImpulseNoiseRemoval

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

 

View the COM map and the COM summary.

The EvImpulseNoiseRemoval object gives you access to information about settings on the Impulse Noise Removal page of the Variable Properties dialog box of the acoustic variable via the EvVariableAcousticProperties.ImpulseNoiseRemoval property.

EvImpulseNoiseRemoval properties:

ContextHorizontalSize
ExcludeAboveLine
ExcludeBelowLine
ExcludeThreshold
SampleReplacement
SampleThreshold
SmoothingWindowSize
SmoothingWindowUnits

 

Description

ContextHorizontalSize

Integer ContextHorizontalSize

Summary

Access or specify the value for Horizontal size (pings) on the Impulse Noise Removal page of the virtual variable. The value restricted to odd integers between 3 and 9.

Return

The value for Horizontal size (pings).

Example
Dim vEvVarIn: Set vEvVarIn = vEvFile.Variables.FindByName("Impulse noise removal 1")

MsgBox "ImpulseNoiseRemoval.ContextHorizontalSize: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.ContextHorizontalSize)
vEvVarIn.Properties.ImpulseNoiseRemoval.ContextHorizontalSize = 5
MsgBox "ImpulseNoiseRemoval.ContextHorizontalSize: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.ContextHorizontalSize)

ExcludeAboveLine

String ExcludeAboveLine

Summary

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

Return

Exclude above line name as a string.

Example
Dim vEvVarIn: Set vEvVarIn = vEvFile.Variables.FindByName("Impulse noise removal 1")

MsgBox "ImpulseNoiseRemoval.ExcludeAboveLine: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.ExcludeAboveLine)
vEvVarIn.Properties.ImpulseNoiseRemoval.ExcludeAboveLine = "Line 10m"
MsgBox "ImpulseNoiseRemoval.ExcludeAboveLine: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.ExcludeAboveLine)

          

ExcludeBelowLine

String ExcludeBelowLine

Summary

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

Return

Exclude below line name as a string.

Example

See ExcludeAboveLine example.

ExcludeThreshold

double ExcludeThreshold

Summary

Access or specify the Exclude below threshold (dB at 1m) on the Impulse Noise Removal page of the virtual variable.

Return

The value for Exclude below threshold (dB at 1m).

Example
Dim vEvVarIn: Set vEvVarIn = vEvFile.Variables.FindByName("Impulse noise removal 1")
MsgBox "ImpulseNoiseRemoval.ExcludeThreshold: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.ExcludeThreshold) vEvVarIn.Properties.ImpulseNoiseRemoval.ExcludeThreshold = 3.1 MsgBox "ImpulseNoiseRemoval.ExcludeThreshold: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.ExcludeThreshold)

SampleThreshold

double SampleThreshold

Summary

Accesses or specifies the (Sample) Threshold on the Impulse Noise Removal page of the virtual variable.

Return

The value for the (Sample) Threshold.

Example
Dim vEvVarIn: Set vEvVarIn = vEvFile.Variables.FindByName("Impulse noise removal 1")
MsgBox "ImpulseNoiseRemoval.SampleThreshold: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.SampleThreshold) vEvVarIn.Properties.ImpulseNoiseRemoval.SampleThreshold = 6.1 MsgBox "ImpulseNoiseRemoval.SampleThreshold: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.SampleThreshold)

SampleReplacement

EImpulseNoiseReplacement SampleReplacement

Summary

Accesses or specifies the Noise sample replacement value method on the Impulse Noise Removal page of the virtual variable. The Replacement method is an enum value under EImpulseNoiseReplacement.

Return

Enum under EImpulseNoiseReplacement

Example
Const EImpulseNoiseReplacement_Mean = 1
Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("c:\YourImpulseNoise.EV")
Dim vEvVarIn: Set vEvVarIn = vEvFile.Variables.FindByName("Impulse noise removal 1")
MsgBox "ImpulseNoiseRemoval.SampleReplacement: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.SampleReplacement)
vEvVarIn.Properties.ImpulseNoiseRemoval.SampleReplacement = EImpulseNoiseReplacement_Mean
MsgBox "ImpulseNoiseRemoval.SampleReplacement: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.SampleReplacement)

This example works around a known Enum issue under VBS.

SmoothingWindowSize

double SmoothingWindowSize

Summary

Accesses or specifies the (Smoothing) Vertical window size (units) on the Impulse Noise Removal page of the virtual variable.

Return

The value for the (Smoothing) Vertical window size (units).

Example
Dim vEvVarIn: Set vEvVarIn = vEvFile.Variables.FindByName("Impulse noise removal 1")
MsgBox "ImpulseNoiseRemoval.SmoothingWindowSize: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.SmoothingWindowSize) vEvVarIn.Properties.ImpulseNoiseRemoval.SmoothingWindowSize = 4.1 MsgBox "ImpulseNoiseRemoval.SmoothingWindowSize: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.SmoothingWindowSize)

SmoothingWindowUnits

ESampleOrMeters SmoothingWindowUnits

Summary

Accesses or specifies the (Smoothing) Vertical window units on the Impulse Noise Removal page of the virtual variable using an emum under ESamplesOrMeters.

Return

Enum under ESamplesOrMeters

Example
Const ESamplesOrMeters_Meters = 1
Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("c:\YourImpulseNoise.EV")
Dim vEvVarIn: Set vEvVarIn = vEvFile.Variables.FindByName("Impulse noise removal 1")
MsgBox "ImpulseNoiseRemoval.SmoothingWindowUnits: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.SmoothingWindowUnits) vEvVarIn.Properties.ImpulseNoiseRemoval.SmoothingWindowUnits = ESamplesOrMeters_Meters MsgBox "ImpulseNoiseRemoval.SmoothingWindowUnits: " & CStr(vEvVarIn.Properties.ImpulseNoiseRemoval.SmoothingWindowUnits)

This example works around a known Enum issue under VBS.

See also

Scripting with COM objects
COM object hierarchy