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
NumberOfFrequencyBinsNote: ExcludeWholeNoDataPings, ExcludeAboveLine and ExcludeBelowLine are deprecated.
|
Description |
(read-write) double BackgroundNoiseAt1m SummaryAccess or change the value for the setting Background noise at 1m. |
|
(read-write) boolean BadDataHasVolume SummaryAccess or change the value for the setting Include the volume of no-data samples. For more information refer to About no data. ExamplevEvVariable.AsVariableAcoustic.Properties.Analysis.BadDataHasVolume = true |
|
(read-write) string ExcludeAbove SummaryFor 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. ParametersNone. ReturnIf successful in reading, the string for the line or surface. If successful in writing, the variable's Analysis page setting is updated. ExampleExclude 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" |
|
(read-write) string ExcludeBelow SummaryFor 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. ParametersNone. ReturnIf successful in reading, the string for the line or surface. If successful in writing, the variable's Analysis page setting is updated. ExampleExclude 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" |
|
(read-write) boolean ExcludeBadDataRegions SummaryAccess or change the value for the setting Exclude bad data regions. |
|
(read-write) boolean ExcludeBadLineStatusPings SummaryAccess or change the value for the setting Exclude bad line status pings. |
|
(read-write) double MaximumFrequencyValue SummaryAccess or change the value for the setting Maximum frequency value. |
|
(read-write) double MinimumFrequencyValue SummaryAccess or change the value for the setting Minimum frequency Value. |
|
(read-write) integer NumberOfFrequencyBins SummaryAccess or change the value for the setting Number of frequency bins. |