COM object EvTransientNoiseRemoval

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

 

View the COM map and the COM summary.

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

EvTransientNoiseRemoval properties:

ContextHorizontalSize
ContextVerticalSize
ExcludeAboveLine
ExcludeBelowLine
ExcludeThreshold
SampleReplacement
SampleReplacementPercentile
SampleThreshold
SmoothingWindowSize
SmoothingWindowUnits

 

Description

ContextHorizontalSize

Integer ContextHorizontalSize

Summary

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

Return

The value for (Context Window) Horizontal size (pings).

Example
Dim vEvVarTn: Set vEvVarTn = vEvFile.Variables.FindByName("Transient noise removal 1")
MsgBox "TransientNoiseRemoval.ContextHorizontalSize: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.ContextHorizontalSize)
vEvVarTn.Properties.TransientNoiseRemoval.ContextHorizontalSize = 5
MsgBox "TransientNoiseRemoval.ContextHorizontalSize: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.ContextHorizontalSize)

ContextVerticalSize

Integer ContextVerticalSize

Summary

Access or specify the value for (Context Window) Vertical size (samples) on the Transient Noise Removal page of the virtual variable.

Return

The value for (Context Window) Vertical size (samples)).

Example
Dim vEvVarTn: Set vEvVarTn = vEvFile.Variables.FindByName("Transient noise removal 1")
MsgBox "TransientNoiseRemoval.ContextVerticalSize: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.ContextVerticalSize)
vEvVarTn.Properties.TransientNoiseRemoval.ContextVerticalSize = 18
MsgBox "TransientNoiseRemoval.ContextVerticalSize: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.ContextVerticalSize)

ExcludeAboveLine

String ExcludeAboveLine

Summary

Access or specify the line for Exclude above on the Transient 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 "TransientNoiseRemoval.ExcludeAboveLine: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.ExcludeAboveLine)
vEvVarTn.Properties.TransientNoiseRemoval.ExcludeAboveLine = "Line 10m"
MsgBox "TransientNoiseRemoval.ExcludeAboveLine: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.ExcludeAboveLine)

ExcludeBelowLine

String ExcludeBelowLine

Summary

Access or specify the line for Exclude below on the Transient 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 Transient 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("Transient noise removal 1")
MsgBox "TransientNoiseRemoval.ExcludeThreshold: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.ExcludeThreshold)
vEvVarTn.Properties.TransientNoiseRemoval.ExcludeThreshold = 13.1
MsgBox "TransientNoiseRemoval.ExcludeThreshold: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.ExcludeThreshold)

Percentile

Integer Percentile

Summary

Access or specify the (Context Window) Percentile on the Transient Noise Removal page of the virtual variable.

Return

The value for (Context Window) Percentile.

Example
Dim vEvVarIn: Set vEvVarIn = vEvFile.Variables.FindByName("Transient noise removal 1")
MsgBox "TransientNoiseRemoval.Percentile: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.Percentile)
vEvVarTn.Properties.TransientNoiseRemoval.Percentile = 15
MsgBox "TransientNoiseRemoval.Percentile: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.Percentile)

SampleReplacement

EImpulseNoiseReplacement SampleReplacement

Summary

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

Return

Enum under ETransientNoiseReplacement

Example
Const ETransientNoiseReplacement_Median = 1
Dim vEchoviewCom: Set vEchoviewCom = GetObject(, "EchoviewCom.EvApplication")
Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("c:\YourTransientNoise.EV")
Dim vEvVarIn: Set vEvVarIn = vEvFile.Variables.FindByName("Transient noise removal 1")
MsgBox "TransientNoiseRemoval.SampleReplacement: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.SampleReplacement)
vEvVarTn.Properties.TransientNoiseRemoval.SampleReplacement = ETransientNoiseReplacement_Median
MsgBox "TransientNoiseRemoval.SampleReplacement: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.SampleReplacement)

This example works around a known Enum issue under VBS.

SampleReplacementPercentile

Integer SampleReplacementPercentile

Summary

Access or specify the (Sample) Percentile on the Transient Noise Removal page of the virtual variable.

Return

The value for (Sample) Percentile.

Example
Dim vEvVarIn: Set vEvVarIn = vEvFile.Variables.FindByName("Transient noise removal 1")
MsgBox "TransientNoiseRemoval.Percentile: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.Percentile)
vEvVarTn.Properties.TransientNoiseRemoval.Percentile = 15
MsgBox "TransientNoiseRemoval.Percentile: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.Percentile)

SampleThreshold

double SampleThreshold

Summary

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

Return

The value for the (Sample) Threshold.

Example
Dim vEvVarIn: Set vEvVarIn = vEvFile.Variables.FindByName("Transient noise removal 1")
MsgBox "TransientNoiseRemoval.SampleThreshold: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.SampleThreshold)
vEvVarTn.Properties.TransientNoiseRemoval.SampleThreshold = 17.1
MsgBox "TransientNoiseRemoval.SampleThreshold: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.SampleThreshold)

SmoothingWindowSize

double SmoothingWindowSize

Summary

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

Return

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

Example
Dim vEvVarTn: Set vEvVarTn = vEvFile.Variables.FindByName("Transient noise removal 1")
MsgBox "TransientNoiseRemoval.SmoothingWindowSize: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.SmoothingWindowSize) vEvVarTn.Properties.TransientNoiseRemoval.SmoothingWindowSize = 14.1 MsgBox "TransientNoiseRemoval.SmoothingWindowSize: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.SmoothingWindowSize)

SmoothingWindowUnits

ESampleOrMeters SmoothingWindowUnits

Summary

Accesses or specifies the (Smoothing) Vertical window units on the Transient 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:\YourTransientNoise.EV")
Dim vEvVarIn: Set vEvVarIn = vEvFile.Variables.FindByName("Transient noise removal 1")
MsgBox "TransientNoiseRemoval.SmoothingWindowUnits: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.SmoothingWindowUnits) vEvVarTn.Properties.TransientNoiseRemoval.SmoothingWindowUnits = ESamplesOrMeters_Meters MsgBox "TransientNoiseRemoval.SmoothingWindowUnits: " & CStr(vEvVarTn.Properties.TransientNoiseRemoval.SmoothingWindowUnits)

This example works around a known Enum issue under VBS.

See also

Scripting with COM objects
COM object hierarchy