PropertiesOptions

Additional <PropertiesOptions> are available to the following objects: Ev File, <VariableName> and <TransducerName>. <PropertiesOptions> is the set of <ActionOptions> to use with a <PropertyName>. <PropertiesOptions> can be used in their simplest form or be used in extended commands with filters. However, be aware that the Command interface only supports the display of a single property for multiple objects or multiple properties for a single object.

PropertiesOptionNames include:

Property settings that return an array of values

<PropertyNames> that return an array of values are displayed as space separated values:

Notes:

Accessing array values

Under the Command interface:

Array items are indexed, the indexing starts at 0. A range of array items is specified by using StartRange... StopRange.

Changing array values

Array values may be changed by dealing with specific items in the array, or you can use <=> to assign a list of values. The assignment of values supports the use of a space or a semi-colon to delimit the array list. The empty string "" indicates no recorded value for the indexed item.

Example: assign with list delimiter as a space or a semi-colon

> Single target detection - split beam (method 2) 1 | HTIBeamPatternCoefficients
Single target detection - split beam (method 2) 1 | 0.00021 -0.545 -0.000083 -0.00677 -0.000424 -0.56 0.00451 -0.00614
> Single target detection - split beam (method 2) 1 | HTIBeamPatternCoefficients = | 0.00000 -0.545 -0.000083 -0.00677 -0.000424 -0.56 0.00451 -0.00614
> Single target detection - split beam (method 2) 1 | HTIBeamPatternCoefficients
Single target detection - split beam (method 2) 1 | 0.0 -0.545 -0.000083 -0.00677 -0.000424 -0.56 0.00451 -0.00614
>

> Single target detection - split beam (method 2) 1 | HTIBeamPatternCoefficients = | 0.00021; -0.545; -0.000083; -0.00677; -0.000424; -0.56; 0.00451; -0.00614
> Single target detection - split beam (method 2) 1 | HTIBeamPatternCoefficients
Single target detection - split beam (method 2) 1 | 0.00021 -0.545 -0.000083 -0.00677 -0.000424 -0.56 0.00451 -0.00614
>

Example: array item, range

Display Ping status colors under a new EV file.

> PingStatusColors ValueDefault
Ev File | Blue Cyan Green Magenta Red Yellow White BlueDark CyanDark GreenDark
>

Get an array

> PingStatusColors
Ev File | Blue Cyan Green Magenta Red Yellow White BlueDark CyanDark GreenDark
>

Specify an array

> PingStatusColors = | Red Yellow Blue Green Cyan Magenta White BlueDark GreenDark CyanDark
> PingStatusColors
Ev File | Red Yellow Blue Green Cyan Magenta White BlueDark GreenDark CyanDark
>

Get an array item

> PingStatusColors 0
Ev File | Red
>

Get a range of items

> PingStatusColors 2..5
Ev File | Blue Green Cyan Magenta
>

Specify an item

> PingStatusColors 3 = | red
> PingStatusColors 2..5
Ev File | Blue Red Cyan Magenta
>

Specify a range of items

> PingStatusColors 2..5 =| Yellow Green Magenta Red
> PingStatusColors 2..5
Ev File | Yellow Green Magenta Red
>

PropertiesOptionName

Details

ValueUnits
Syntax

ObjectName | PropertyName ValueUnits

ObjectName | ValueUnits

Description

<ValueUnits> returns a <PropertyName | Unit> list of the specified and default object Properties setting units for the object.

Example

<t1> Transducer object.

>Azimuth | degrees |
BeamRotation | degrees |
BeamTypeOfTransducer | None |
CalibrationAccuracyEstimate | None |
CalibrationAcquisitionMethod | None |
CalibrationDate | None |
CalibrationProcessingMethod | None |
CreatedByFileSet | None |
Elevation | degrees |
LocationOnPlatform | None |
LocationX | meters |
LocationY | meters |
LocationZ | meters |
Name | None |
NominalFrequency | hertz |
Notes | None |
OrientationMode | None |
PingDutyCycle | None |
TriwaveCorrectionUsed | None
>

EV File Properties dialog box, Schools page, Maximum horizontal linking distance.

> Evfile | SchoolsMaximumHorizontalLinkDistance ValueUnits
Ev File | meters
>

ValueMinimum
Syntax

ObjectName | PropertyNameValueMinimum

ObjectName |ValueMinimum

Description

<ValueMinimum> returns the minimum range of the object Properties as list of <PropertyName | Value> for both user specified and default settings.

Example

<t1> Transducer object.

> t1 | ValueMinimum
Azimuth | 0.0 |
BeamRotation | 0.0 |
BeamTypeOfTransducer | None |
CalibrationAccuracyEstimate | None |
CalibrationAcquisitionMethod | None |
CalibrationDate | None |
CalibrationProcessingMethod | None |
CreatedByFileSet | None |
Elevation | 0.0 |
LocationOnPlatform | None |
LocationX | -100000000.0 |
LocationY | -100000000.0 |
LocationZ | -100000000.0 |
Name | None |
NominalFrequency | 0 |
Notes | None |
OrientationMode | ElevationAzimuth |
PingDutyCycle | None |
TriwaveCorrectionUsed | None
>

ValueMaximum
Syntax

ObjectName | PropertyNameValueMaximum

ObjectName |ValueMaximum

Description

<ValueMaximum> returns the maximum range of the object Properties as list of <PropertyName | Value> for both user specified and default settings.

Example

<t1> Transducer object.

> t1 | ValueMaximum
Azimuth | 359.99 |
BeamRotation | 359.99 |
BeamTypeOfTransducer | None |
CalibrationAccuracyEstimate | None |
CalibrationAcquisitionMethod | None |
CalibrationDate | None |
CalibrationProcessingMethod | None |
CreatedByFileSet | None |
Elevation | 180.0 |
LocationOnPlatform | None |
LocationX | 100000000.0 |
LocationY | 100000000.0 |
LocationZ | 100000000.0 |
Name | None |
NominalFrequency | 10000000 |
Notes | None |
OrientationMode | AlongshipAthwartship |
PingDutyCycle | None |
TriwaveCorrectionUsed | None
>

ValueDefault
Syntax

ObjectName | PropertyName ValueDefault

ObjectName | ValueDefault

Description

Lists the default values of the <ObjectName> Properties dialog box as a <PropertyName | Value> list.

Example

<T1> Transducer object.

>t1 | ValueDefault
Azimuth | 0.0 |
BeamRotation | 0.0 |
BeamTypeOfTransducer | None |
CalibrationAccuracyEstimate | None |
CalibrationAcquisitionMethod | None |
CalibrationDate | 0.0 |
CalibrationProcessingMethod | None |
CreatedByFileSet | None |
Elevation | 0.0 |
LocationOnPlatform | None |
LocationX | 0.0 |
LocationY | 0.0 |
LocationZ | 0.0 |
Name | None |
NominalFrequency | 0 |
Notes | None |
OrientationMode | ElevationAzimuth |
PingDutyCycle | None |
TriwaveCorrectionUsed | None
>

ValueOptions
Syntax

ObjectName | PropertyNameValueOptions

VirtualVariableName | PageOperatorValueOptions

Description

Returns properties whose value is selected from an enumerated list. The return is of the form <PropertyName | Value1 Value2 ... ValueN |>.

The return includes settings where the enumerated list is empty.

Be aware that a property value selected from a <ValueOptions> list may have specific collateral properties.

Example

<T1> Transducer object.

> t1 | ValueOptions
Azimuth | None |
BeamRotation | None |
BeamTypeOfTransducer | None |
CalibrationAccuracyEstimate | None |
CalibrationAcquisitionMethod | None |
CalibrationDate | None |
CalibrationProcessingMethod | None |
CreatedByFileSet | None |
Elevation | None |
LocationOnPlatform | None |
LocationX | None |
LocationY | None |
LocationZ | None |
Name | None |
NominalFrequency | None |
Notes | None |
OrientationMode | ElevationAzimuth AlongshipAthwartship |
PingDutyCycle | None |
TriwaveCorrectionUsed | None
>

Some EV file settings with enumerated values (not shown are ExportAnalysisVariables and PingStatusColors ):

> ev file | ValueOptions

...
BottomClassificationClassAllocationMethod | Elbow, CalinskiHarabasz |
...
BottomClassificationClusterMeasure | CalinskiHarabasz, WithinClusterSumOfSquaresWCSS |
BottomClassificationInterval | Time GPSDistanceNmi VesselLogDistanceNmi PingNumber GPSDistanceM VesselLogDistanceM |
...
EchogramMode | Depth Range |
EchogramMultibeamReplayMode | AsLogged MaxSystem AsSpecified |
...
ExportBiomass | NauticalMilesSquared, Hectares |
...
LinePickAlgorithm | DeltaSv MaximumSv BestBottomCandidate |
...
MappingDatum | WGS84 |
...
SchoolsDistanceMode | VesselLogDistance GPSDistance PingNumber PingTime |
...
WhenEvFileOpened | RestoreLastClose RestoreLastSave OpenTheseWindows
>

Collateral properties for the command interface property <RangeType> for the Ping subset Ranges setting.

> Ping subset 1 | pageoperator
Exclude | false |
RangesInMeters | 0.0- |
RangesInNauticalMiles | 0.0- |
RangesInPings | 0-50 |
RangesInTime | 1970-01= |
RangeType | Meters
>

> ping subset 1 | ValueOptions
...
RangeType | Ping Time Meters NauticalMiles |
...

GraphName*
Syntax

VariableName | Properties GraphNameTitle

VariableName | Properties GraphNameXAxisLabel

VariableName | Properties GraphNameXAxisMinimum

VariableName | Properties GraphNameXAxisMaximum

VariableName | Properties GraphNameYAxisLabel

VariableName | Properties GraphNameYAxisMinimum

VariableName | Properties GraphNameYAxisMinimum

VariableName | Properties FrequencyDistibutionBinCount

GraphName*

Description

PropertyOptions for many graphs Graph Properties dialog box settings: Title, X-axis and Y-axis labels; values for axis Minimum and Maximum limits and Frequency Distribution Bin Count. Specific graph source, labels and axes-limits may be set or read. See also: <VariableName | PageGraph>.

<GraphName> support includes the following graphs:

Note: SingleTargetTsVsDepth can be a graph for a target length data.

Examples

Ping graph title and X-axis minimum value with Sv pings variable as the graph data source.

> Sv pings | GraphPingTitle =| Ping 192

> Sv pings | GraphPingXAxisMinimum =| -120

Frequency distribution graph Bin Count set to 10 that is applied to all variables. The next request for the Frequency distribution graph bin count list, displays a return for variables.

Note: Some listed variables (e.g. GPS fixes, line variables) do not support the frequency distribution graph.

> GraphFrequencyDistributionBinCount =| 10
> GraphFrequencyDistributionBinCount
Bottom | 10 |
Fileset1: line data sounder detected bottom | 10 |
Fileset1: position GPS fixes | 10 |
Fileset1: Sv pings | 10 |
To color 1 | 10 |
XxY statistic 1 | 10

Export
Syntax

ObjectName | Export | YourFilePath

Export | YourFilePath

Description

<Export> directs the Command interface to export the <ObjectName> Properties settings to a specified file path. For more information refer to Ev File, Variable or Transducer object pages.

New text files contain plain text with the following file format. You can view the file in a plain text editor or open as delimited data with headers under Excel. Pre-existing files without a header line are not updated with a header. Each line

Line

Description

Header line

Delimited Column names for subsequent rows of output property data.

Column names:

  • ObjectName
  • Echoview object name.
  • PropertyName
  • EV File Properties name or Variable Properties name.
  • CurrentValue
  • The current value of the property name.
  • Units
  • The units of the property name.
  • MinimumValue
  • The minimum value of the property name.
  • MaximumValue
  • The maximum value of the property name.
  • ValueOptions
  • The available values of the property name. e.g. ValidValue1 ValidValue2 ... ValidValueN
  • DefaultValue
  • The default value of the property name.

Subsequent lines

Each line records delimited values with respect to the column headings described above.

Notes:

  • The file for COM ExportSettings and the Dataflow right-click menu, Export, Settings feature supports VariableName and TransducerName objects.
  • An export for an EV file with many raw and virtual variables can be large with data in more than one section. Use the ObjectName to sort for all properties associated with a variable.
  • The output file text encoding is specified using the Text encoding for output files list.
Example

Part of the output for the command line <Export | YourFilePath>. This command line exports settings for all Ev file, TransducerName and VariableName objects in the EV file.

EV File Properties

ObjectName PropertyName CurrentValue Units MinimumValue MaximumValue ValueOptions DefaultValue
...
Ev File EchogramLineColorBad (255,0,255) (0,0,0) (255,255,255) (255,0,255)
Ev File EchogramLineColorGoodEditable (0,255,0) (0,0,0) (255,255,255) (0,255,0)
Ev File EchogramLineColorGoodRaw (255,255,0) (0,0,0) (255,255,255) (255,255,0)
Ev File EchogramLineColorGoodVirtual (0,255,0) (0,0,0) (255,255,255) (0,255,0)
Ev File EchogramLineColorScheme Default Default
Ev File EchogramLineColorUncertain (0,255,255) (0,0,0) (255,255,255) (0,255,255)
Ev File EchogramLineThickness 1 pixels 1 50 1
Ev File EchogramMode Depth Depth Range Depth Range Depth
...

Variable Properties

ObjectName PropertyName CurrentValue Units MinimumValue MaximumValue ValueOptions DefaultValue
...
Fileset 1: Sv raw pings T1 ColorDisplayMinimum -92.0 -70.0
Fileset 1: Sv raw pings T1 ColorDisplayRange 36.0 0.000001 99999.9 33.0
Fileset 1: Sv raw pings T1 ColorLegendLabelsAlignment LeftOfTheColorBar LeftOfTheColorBar NoLabel LeftOfTheColorBar RightOfTheColorBar NoLabel LeftOfTheColorBar
Fileset 1: Sv raw pings T1 ColorScheme EK500
...

Export all properties for the Copy1 variable to "c:/temp/Copy1Properties.txt".

> Copy1 | Export | "c:/temp/Copy1Properties.txt"

See also

Ev File object
Variable object
Transducer object
Echoview Command interface and command syntax
Console dialog box