COM object EvAnalysis

The EvAnalysis object gives you access to information about settings on the Analysis page of the Variable Properties dialog box of the acoustic or acoustic virtual variable.

EvApplication > EvFileCollection > EvFile > EvVariablesCollection > EvVariableBase As EvVariableAcoustic > EvVariableAcousticProperties > EvAnalysis

- OR -

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

 

View the COM map and the COM summary.

EvAnalysis methods and properties:

BackgroundNoiseAt1m
BadDataHasVolume
ExcludeAbove
ExcludeBelow
ExcludeBadDataRegions
ExcludeBadLineStatusPings
MaximumFrequencyValue
MinimumFrequencyValue
NumberOfFrequencyBins

Note: ExcludeWholeNoDataPings, ExcludeAboveLine and ExcludeBelowLine are deprecated.

 

Description

BackgroundNoiseAt1m

(read-write) double BackgroundNoiseAt1m

Summary

Access or change the value for the setting Background noise at 1m.

BadDataHasVolume

(read-write) boolean BadDataHasVolume

Summary

Access or change the value for the setting Include the volume of no-data samples. For more information refer to About no data.

Example
vEvVariable.AsVariableAcoustic.Properties.Analysis.BadDataHasVolume = true

ExcludeAbove

(read-write) string ExcludeAbove

Summary

For single beam data, access or change the line for Exclude above line. To clear a line use None.

For multibeam data, access or change the value for the setting Exclude above surface. To clear a surface use None.

Parameters

None.

Return

If successful in reading, the string for the line or surface.

If successful in writing, the variable's Analysis page setting is updated.

Example

Exclude Line read, write

MsgBox "SB above: " & vSb.Properties.Analysis.ExcludeAbove

vSb.Properties.Analysis.ExcludeAbove = "line"

Exclude Surface read, write

Msgbox "MB below: " & vMb.Properties.Analysis.ExcludeAbove

vMb.Properties.Analysis.ExcludeAbove = "surface"

ExcludeBelow

(read-write) string ExcludeBelow

Summary

For single beam data, access or change the line for Exclude below line. To clear a line use None.

For multibeam data, access or change the value for the setting Exclude below surface. To clear a surface use None.

Parameters

None.

Return

If successful in reading, the string for the line or surface.

If successful in writing, the variable's Analysis page setting is updated.

Example

Exclude Line read, write

MsgBox "SB above: " & vSb.Properties.Analysis.ExcludeBelow

vSb.Properties.Analysis.ExcludeBelow = "None"

Exclude Surface read, write

Msgbox "MB below: " & vMb.Properties.Analysis.ExcludeBelow

vMb.Properties.Analysis.ExcludeBelow = "surface"

ExcludeBadDataRegions

(read-write) boolean ExcludeBadDataRegions

Summary

Access or change the value for the setting Exclude bad data regions.

ExcludeBadLineStatusPings

(read-write) boolean ExcludeBadLineStatusPings

Summary

Access or change the value for the setting Exclude bad line status pings.

MaximumFrequencyValue

(read-write) double MaximumFrequencyValue

Summary

Access or change the value for the setting Maximum frequency value.

MinimumFrequencyValue

(read-write) double MinimumFrequencyValue

Summary

Access or change the value for the setting Minimum frequency Value.

NumberOfFrequencyBins

(read-write) integer NumberOfFrequencyBins

Summary

Access or change the value for the setting Number of frequency bins.

See also

Scripting with COM objects
COM object hierarchy