EV File object

<EV File> represents an EV file in the Echoview window. The Command interface interacts with one EV file.

The command syntax is:

> Ev File | ActionName | Argument

If the ActionName is unique to the object then the ObjectName is redundant.

<EV File> supports the following <ActionNames>:

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

ActionName Details
AppliedObjects
Syntax

EV File | AppliedObjects

Description

Lists all <ObjectNames> accessible by the EV file. The optional <Argument> specifies an <ObjectName> list index and returns that <ObjectName>. The list index begins at zero.

See also Filtering.

Example

> Ev File | AppliedObjects
0.2m | AAProcessed data 1 | Background noise removal 1 | Bottom | Bottom classification 1 | BottomEVL | Code 1 | Data range bitmap 1 | dB diff | Fileset 1: angular position raw pings T1 | Fileset 1: angular position raw pings T2 | Fileset 1: heading data GPVTG | Fileset 1: line data depth GPGGA | Fileset 1: position GPS fixes | Fileset 1: position GPS fixes GPGGA | Fileset 1: position GPS fixes GPGLL | Fileset 1: position GPS fixes GPRMC | Fileset 1: Power dB raw pings T1 | Fileset 1: Power dB raw pings T2 | Fileset 1: Sv raw pings T1 | Fileset 1: Sv raw pings T2 | Fileset 1: T1 | Fileset 1: T2 | Fileset 1: TS raw pings T1 | Fileset 1: TS raw pings T2 | Fileset 2: Video data | Fileset 2: Video data (1) | Formula 1 | Ping subset 1 | Processed data 3 | STDM2 | Target samples bitmap 1 | Threshold offset 1 | Threshold offset 1EchoviewEVL | Vegetation? | Veg from above

Properties
Syntax

Ev File | Properties

Ev File | <PropertyName>

Ev File | <PropertyName> <PropertiesOption>

Description

<Ev File | Properties> lists pairs of <PropertyName> and <Value> for many settings on the EV File Properties dialog box. The list includes both set and default values. You can output other informative filtered lists with PropertiesOptions and <FilterActions>.


The list of <NumericalValue> and <TextValue> follow setting values as described.


<Ev File | Properties | Name> displays an alphabetically ordered list of <PropertyName>.

<Ev File | Properties | Value> displays a corresponding list of <PropertyNameValue>.


<Ev File | PropertyName> returns specific values of the setting.


Mandatory PropertiesOption

The mandatory <PropertiesOption> " =" is used to assign a <PropertyNameValue>.

Example

The Sv raw pings T1 variable, listing the Color display minimum and changing its value.

> Fileset 1: Sv raw pings T1 | ColorDisplayMinimum
Fileset 1: Sv raw pings T1 | -100.0
> Fileset 1: Sv raw pings T1 | ColorDisplayMinimum =|-95
> Fileset 1: Sv raw pings T1 | ColorDisplayMinimum
Fileset 1: Sv raw pings T1 | -95.0
>

Some <PropertiesOption> settings are read-only for the console.

Example

> Ev File | LocationOfEvFile =| MyDocuments
ERROR | 'Location Of Ev File' is read-only.

PageName

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

Supported <PageNames> include:

PageName Description

PageBottomClassification

EV File Properties settings on the Bottom Classification page.

Example

> Ev File | PageBottomClassification

PageClasses

EV File Properties settings on the Classes page.

Example

> Ev File | PageClasses

PageEchogram

EV File Properties settings on the Echogram page.

Example

> Ev File | PageEchogram

PageEvFile

EV File Properties settings on the EV File page.

Example

> Ev File | PageEvfile

PageExport

EV File Properties analysis export settings on the Export page. See also PropertiesOptions: Amend items.

Example

> Ev File | PageExport

PageFishTracks

EV File Properties settings on the Fish tracks page.

Example

> Ev File | PageFishTracks

PageLines

EV File Properties line pick settings on the Single beam tab of the Lines and Surfaces page.

Example

> Ev File | PageLines

PageMapping

EV File Properties settings on the Mapping page.

Example

> Ev File | PageMapping

PageNotes

Settings on the Notes page settings for

  • EV File Properties
Examples

> Ev File | PageNotes

PagePingStatus




EV File Properties settings on the Ping Status page.

Example

> Ev File | PagePingStatus

PagePingStatus

EV File Properties settings on the Ping Status page.

Example

> Ev File | PagePingStatus

PageSchools

EV File Properties settings on the Schools page.

Example

> Ev File | PageSchools

PageSurfaces

EV File Properties multibeam surface detection settings on the Multibeam tab of the Lines and Surfaces page.

Example

> Ev File | PageSurfaces

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>.
  • Return for <PropertyName> that specifies a RGB color.
  • Return for setting with multiple values.
  • See also: Number handling for an integer property assigned a real value.
  • Some EV File Properties dialog box settings may not be supported.
  • See also: The ValueOptions description to get enumerated list values associated with certain properties.
PropertiesAction

LocationOfEVFile

Syntax

Ev File | LocationOfEVFile

Ev File | Properties locationOfEVFile

Description

LocationOfEVFile is a read-only PropertiesAction that returns the path of the EV file.

Example

> Ev File | locationOfEVFile
Ev File | D:\Yourfolder\AnotherFolder\YourFileName.EV

Save
Syntax

Ev File | Save | Argument

Description

For an existing EV file, saves the EV file under the existing file path,

For a new EV file, <Save> requires an <Argument>.

<Argument>

EV file name and path.

Example

> Ev File | Save | C:\aFolder\YourEVFile
>

Close
Syntax

Ev File | Close

Ev File | Close Discard

Ev File | Close Save | Argument

Description

Closes the current EV file.

ActionOptions include:

  • Discard
  • Save
Example

> Ev File | close
>

See also

Command interface and command syntax
The Console dialog box
PropertiesOptions