Variables object

<Variables> is the list of <VariableNames> in an Echoview EV file. There are a number of <VariableTypes> that can used to filter an <ObjectNames> list.

<Variables> supports these <ActionNames>:

A <VariableVirtualObject> supports the Operands <ActionName>.

Where the <ActionName> is unique to the <ObjectName> then the <ObjectName> is redundant.

Note: Supplied examples could be adjusted to suit your EV file, variable and virtual names. See also: Example display conventions.

ActionName Description
AppliedObjects
Syntax

VariableName | AppliedObjects | Argument

Description

Lists all <Objects> upstream in the dataflow and accessible by <VariableName>. The optional <Argument> specifies an <Object> list index and returns that <Object>. The list index begins at zero.

See also Filtering.

Example

Variables can include raw, virtual, transducer and line variables.

> db diff | AppliedObjects
Bottom | Fileset 1: Sv raw pings T1 | Fileset 1: Sv raw pings T2 | Fileset 1: T2 | Threshold offset 1

> db diff | AppliedObjects | 4
Threshold offset 1

Properties
Syntax

VariableName | Properties

VariableName | Properties PropertiesOption

VariableName | Properties PropertyName     - OR -     VariableName | PropertyName

Description

<VariableName | Properties> lists pairs of <PropertyName> and <Value> for the <VariableName>. The list includes both set and default values. You can output other informative filtered lists with PropertiesOptions and <FilterActions>.

Be aware that some <PropertyName> and <Value> pairs may not be applicable to the <VariableObject>.

<NumericalValue> and <TextValue> follow setting values as described.

 

<VariableName | Properties | Name> displays an alphabetically ordered list of <Name>.

<VariableName | Properties | Value> displays a corresponding list of set <Value>.

 

<VariableName| PropertyName> returns specific values of the setting.

 

Mandatory PropertiesOption

The mandatory <PropertiesOption> "=", is used to assign an <Value>.

Example

Assign the specified text to the Notes <Property> for all <Objects> that match sv*. Display the Notes.

> sv* | Notes =| Set all Sv notes to The quick brown fox jumped over the lazy cow.
> sV* | Notes
Fileset 1: Sv raw pings T1 | Set all Sv notes to The quick brown fox jumped over the lazy cow. |
Fileset 1: Sv raw pings T2 | Set all Sv notes to The quick brown fox jumped over the lazy cow.

Some variable properties may allow a value of None.

Example

Sv variable. Set the Exclude below line to None. Display the Exclude below line.

> Sv raw pings T1 | ExcludeBelowLineOrSurface =| None
> Sv raw pings T1 | ExcludeBelowLineOrSurface
None

Navigating the entire list of all <PropertyNames> can be slow. The interface can display supported <PropertyNames> of an <ObjectName> grouped under a <PageName>.

Supported <PageNames> include:

  Description
Page4dDisplay

Variable Properties settings on the 4D Display page.

Example

> Sv raw pings T1 | Page4dDisplay

PageAlongtrackDisplay

Variable Properties settings on the Alongtrack Display page.

Example

> Sv raw pings T1 | PageAlongtrackDisplay

PageAnalysis

Variable Properties settings on the PageAnalysis page.

Example

> Sv raw pings T1 | PageAnalysis

PageCalibration

Variable Properties settings on the Calibration page.

Example

> Sv raw pings T1 | PageCalibration

PageCruisetrackDisplay

Variable Properties settings on the Cruisetrack Display page.

Example

> Sv raw pings T1 | PageCruisetrackDisplay

PageData

Variable Properties settings on the Data page.

Example

> Sv raw pings T1 | PageData

PageEchogramDisplay

Variable Properties settings on the Echogram display page.

Example

> Sv raw pings T1 | PageEchogramDisplay

PageFilter

Variable Properties settings on the Filter page.

Example

> Sv raw pings T1 | PageFilter

PageGraph

Lists all Graph Properties settings.

Variable Properties settings on the Graph page are associated with the bottom classification graph and ping graph Sv TVG curve.

See also GraphName PropertyOptions associated with the Graph Properties dialog box.

Notes:

  • Not all settings may be applicable for a variable.
  • A Graph Property may be assigned a value. However, the special value for an unset value i.e. -INF, cannot be assigned through the Command interface.
Example

> Sv raw pings T1 | PageGraph

PageGrid

Variable Properties settings on the Grid page.

Example

> Sv raw pings T1 | PageGrid

PageLineDisplay

Properties settings on the Line Display page.

Example

> Sv raw pings T1 | PageLineDisplay

PageLinesOrSurfaces

Properties settings on the Lines page or Surfaces page.

Example

> Sv raw pings T1 | PageLinesOrSurfaces

PageNotes

Properties settings on the Notes page.

Example

> Sv raw pings T1 | PageNotes

PageOperator

Specific virtual variable settings. See Virtual variable pages.

Notes:

  • Virtual variable operands can be displayed but they can't be changed.
  • PageOperator may not list every operator property. You may find missing operator properties by inspecting the output of <VariableName | Properties>.
  • For Multibeam target detection and Multibeam target overlay variables, the Echogram display setting Show input data under targets, is handled under PageOperator.
  • VariablesLine items that are virtual lines support PageOperator which lists virtual line settings.
Example

See BackgroundNoiseRemoval example.

See PingSubset example.

See Virtual line example.

PageRegions

Properties settings on the Regions page.

Example

> Sv raw pings T1 | PageRegions

Notes:

  • When a <PropertyName> is difficult to correlate with a setting name, give the setting a noticeable value to make it easier to locate the correct <PropertyName>.
  • Some virtual variables don't have specific settings and as a result will have no PageOperator.
  • Return for <PropertyName> that specifies a RGB color.
  • Return for <PropertyName> with multiple values.
  • See also: Number handling for an integer property assigned a real value.
  • See also: The ValueOptions description to get enumerated list values associated with certain properties.
Examples

Raw variable and supported <PageNames>.

> Sv raw pings T1 | Page (Shift+Tab)

"Page" matches actions
Properties Page4dDisplay
Properties PageAlongtrackDisplay
Properties PageAnalysis
Properties PageCalibration
Properties PageCruisetrackDisplay
Properties PageData
Properties PageEchogramDisplay
Properties PageFilter
Properties PageGraph
Properties PageGrid
Properties PageLineDisplay
Properties PageLinesOrSurfaces
Properties PageNotes
Properties PageOperator
Properties PageRegions.
>

 

> Sv raw pings T1 | PageEchogramDisplay (ENTER)
AutoDisplayLimits | false |
ColorDisplayMinimum | -92.0 |
ColorDisplayRange | 36.0 |
ColorLegendLabelsAlignment | Left of the color bar |
ColorScheme | EK500 |
DepthColorScheme | Depth |
EchogramBackgroundColor | (128, 128, 128) |
HModePlotOrientation | Head Up |
IntegramAnalysis | Bottom classification |
IntegramBottomVariable | Bottom classification 1 |
IntegramIsLessThanThreshold | false |
IntegramThreshold | -50.0 |
IntegrationLine | None |
IntegrationLineColor | (197, 0, 232) |
LowerDisplayLimit | 999.84 |
MajorAxisAngleColorDisplayRange | 12.0 |
MajorAxisColorScheme | Major-Axis Angle |
MinorAxisAngleColorDisplayRange | 12.0 |
MinorAxisColorScheme | EK500 |
MultibeamFlipHorizontally | false |
MultibeamFlipVertically | false |
MultibeamShowBottom | false |
MultibeamShowDirectionLabels | false |
MultibeamShowTargetClassLabels | true |
MultibeamShowTargetOutlines | false |
MultibeamShowTargetSampleOutlines | true |
NASCColorScheme | NASC and ABC |
SelectionMovement | Stationary |
ShowEchogramColorLegend | true |
SinglebeamEchogramReferenceLine | None |
SinglebeamFlipVertically | false |
UpperDisplayLimit | 0.1 |
UsingPrimaryColorScheme | true
>

Specify a <PropertyName>, interface returns the value.

> dbdiff | gridxaxis
GPSDistanceNmi

Specify a <PropertyName> and <Argument>, and the interface changes the value of the <PropertyName>.

> dBdiff | gridxaxis =| pingnumber
> dBdiff | gridxaxisspacinginPings =| 100

Supported <PageNames> of the Background noise removal variable, Supported <PageOperator> lists settings on the Background Noise Removal page. The VerticalUnits <ValueOptions> list contains Samples, Meters; the example tells us that Samples has been selected. <ContextPingCount> correlates to the setting Horizontal extent (pings). All remaining <VirtualVariablePageProperties> correlate with the setting name.

> Background noise removal 1 | Properties page(Shift+Tab)
"Properties page" matches actions
Properties Page4dDisplay
Properties PageAlongtrackDisplay
Properties PageAnalysis
Properties PageCalibration
Properties PageCruisetrackDisplay
Properties PageData
Properties PageEchogramDisplay
Properties PageFilter
Properties PageGraph
Properties PageGrid
Properties PageLineDisplay
Properties PageLinesOrSurfaces
Properties PageNotes
Properties PageOperator
Properties PageRegions.
>

> Background noise removal 1 | PageOperator
ContextPingCount | 1000 |
MaximumNoise | -125.0 |
MinimumSignalToNoiseRatio | 10.0 |
VerticalMeters | 1.0 |
VerticalOverlap | 0 |
VerticalSamples | 5 |
VerticalUnits | Samples
>

Virtual line example.

> VariablesLine
0.2m | Best bottom candidate line pick 1 | Bottom | BottomEVL | Fileset 1: line data depth GPGGA | Threshold offset 1 | Threshold offset 1EchoviewEVL | Vegetation? | Veg from above
> Best bottom candidate line pick 1 | pageoperator
LinePickAlgorithm | BestBottomCandidate |
LinePickBackstepRange | 0.0 |
LinePickDiscriminationLevel | -50.0 |
LinePickMaximumDropouts | 2 |
LinePickMinimumPeakAsymmetry | -1.0 |
LinePickMinimumSv | -70.0 |
LinePickMinimumSvDelta | 15.0 |
LinePickPeakThreshold | -50.0 |
LinePickStartDepth | 5.0 |
LinePickStopDepth | 1000.0 |
LinePickUseBackstep | true |
LinePickWindowRadius | 8
>

See also General example, Extended commands.

ExcludeAboveLineOrSurface
Syntax

VariableName | ExcludeAboveLineOrSurface

Description

Lists the Exclude above line for the <VariableName>.

PropertiesOption

The mandatory <PropertiesOption> "=", is used to assign an <Value> that is a <line> for single beam variables or <surface> for multibeam variables.

Example

> svrawpingst1 | ExcludeAboveLineOrSurface
Threshold offset 1
> svrawpingst1 | ExcludeAboveLineOrSurface =| bottom
> svrawpingst1 | ExcludeAboveLineOrSurface
Bottom

ExcludeBelowLineOrSurface
Syntax

VariableName | ExcludeBelowLineOrSurface

Description

Lists the Exclude below line for the <VariableName>.

PropertiesOption

The mandatory <PropertiesOption> "=", is used to assign an <Value> that is a <line> for single beam variables or <surface> for multibeam variables.

Example

> svrawpingst1 | ExcludeBelowLineOrSurface
Bottom
>

VariableVirtual object

A <VariableVirtualName> object supports the ActionName <Operands> and ActionOption <N>.
Syntax

VariableVirtualName | Operands
VariableVirtualName | Operands N
VariableVirtualName | Operands N =| AnotherVariable

Description

<VariableVirtualName | Operands> displays the <OperandsList> for the <VariablesVirtualObject>. The <OperandsList> for the virtual variable is ordered alphanumerically.

<VariableVirtualName | Operands N> displays an operand of the virtual variable. <N> specifies the operand number, where N=0 corresponds to operand 1 on the Operands page of the virtual variable.

<VariableVirtualName | Operands N =| AnotherVariable> assigns <AnotherVariable> to <Operand N>.

Example

The operands for <dbdiff> and changing <Operand 1> which corresponds to operand 2 on the Operands page of the dB Diff variable.

> dbdiff | operands
AAProcessed data 1 | Fileset 1: Sv raw pings T2
> dbdiff | operands 0
Fileset 1: Sv raw pings T2
> dbdiff | operands 1
AAProcessed data 1
> dbdiff | operands 1 =| Sv raw pings T1
> dbdiff | operands
Fileset 1: Sv raw pings T1 | Fileset 1: Sv raw pings T2
> dbdiff | operands 0
Fileset 1: Sv raw pings T2
> dbdiff | operands 1
Fileset 1: Sv raw pings T1

See also: Examples for extended commands and Example for Only.

<VirtualVariableName> also supports:

Syntax

VirtualVariableName | PageOperator

Syntax

SingleTargetVariableName | CalibrationAssistantPropertiesActionName

SingleTargetVariableName | CalibrationAssistantPropertiesActionName =| Value

Description

Supported Calibration Assistant settings can be accessed through a suitable single target variable.

To list supported Calibration Assistant PropertiesActionNames use: CalibrationAssistant (press Shift+Tab).

See also

Command interface and command syntax
The Console dialog box
PropertiesOptions