CARIS Batch Utility : HIPS Processes : Create SIPS Beam Pattern
 

Create SIPS Beam Pattern

Description

The CreateSIPSBeamPattern process creates a beam pattern file that will be used to apply a correction to remove acoustic artifacts from the imagery caused by imperfections in the sonar.

Inputs

One or more HIPS track lines.

Outputs

The beam pattern file.

Command Line Syntax

carisbatch --run CreateSIPSBeamPattern

Options

The following table describes the parameters available for this process.

Parameter

 

Long

Short

Description

Can Repeat

Notes

 

Common Options

--processing-buffer-time

B

If set, applies a buffer of extra data, specified in seconds, at the beginning and end of lines to avoid data loss. If not set or buffer size of 0 seconds is applied, data will be processed without the buffer.

The default value is 0.

Supported units: seconds

FALSE

--mosaic-engine

m

The mosaic engine used to generate the output beam pattern. One of:

SIPS_BACKSCATTER: SIPS Backscatter engine processes multibeam backscatter data referenced by HIPS data

SIPS_SIDESCAN: SIPS Side Scan engine processes side scan data converted into HIPS format

This must be explicitly specified.

MosaicEngine = SIPS_BACKSCATTER Options

--beam-pattern-file-operation

If the beam pattern file selected already exists, sets the file operations on the existing file. One of:

UPDATE: Update - Updates the file with the new line information, can accumulate many lines over many surveys

OVERWRITE: Overwrite - Overwrites the existing file with a new file from the current lines.

The default value is UPDATE.

Cannot be used without BeamPatternFile set.

FALSE

--local-absorption

A number specifying correction for transmission loss using temperature and salinity values.

<Temperature> - The temperature value in degrees Celsius.

<Salinity> - The salinity value in parts per thousand.

The default value is 8.00 35.00 respectively.

FALSE

--nadir-angle-t1

Set Transducer 1 angles across-track from directly below the transducer (0 degrees) to set how much data is included in the beam pattern file/mosaic.

<Port> - The port side angle from transducer nadir.

<Starboard> - The starboard side angle from transducer nadir.

If not set, the default value is 90. Supported units: degrees.

FALSE

--nadir-angle-t2

Set Transducer 2 angles across-track from directly below the transducer (0 degrees) to set how much data is included in the beam pattern file/mosaic.

<Port> - The port side angle from transducer nadir.

<Starboard> - The starboard side angle from transducer nadir.

If not set, the default value is 90. Supported units: degrees.

FALSE

--surface

The path to the surface used to compute the local bottom slope used in the calculations of real incidence angle and ensonified area. The default elevation band will be used.

If not set the default value is to use the processed bathymetry.

FALSE

MosaicEngine = SIPS_SIDESCAN Options

 

None