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
Updated HIPS track lines and project file.
Command Line Syntax
carisbatch --run CreateSIPSBeamPattern --mosaic-engine <value> [options] <inputs>
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short | Description | Can Repeat | Notes
|
Common Options | ||||
--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 | FALSE | This must be explicitly specified. |
--beam-pattern-file | b | The path to the beam pattern file. | FALSE | 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 --beam-pattern-file set. | FALSE | ||
--s7k-compensated-data | Teledyne Reson s7k format can store Beam Average and Time Series data in raw and compensated intensity datagrams. When this option is set the mosaic will use compensated data from any line containing it and if not found the line will not be used in the mosaic. | 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 values are 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. The default values are 90 90. The valid range is -20 to 100. | 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. The default values are 90 90. The valid range is -20 to 100. | 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 | |||
Example
To use this command, refer to the following example.
Example | ||
Objective | To remove acoustic artifacts from a HIPS track line. | |
Description | Command Line Syntax | |
The mosaic engine to use is SIPS_BACKSCATTER. | --mosaic-engine SIPS_BACKSCATTER | |
The beam pattern file operation is OVERWRITE. | --beam-pattern-file-operation OVERWRITE | |
The input HIPS track line file is named input.hips is located at C:\temp\input\. The HIPS file URI filters for the vessel named “sample” and the day 2000-001 | C:\temp\input\ | |
The output beam pattern file is named outputBeamPattern.bbp and is located at C:\Temp\ | C:\Temp\outputBeamPattern.bbp | |
Command Line |
| |
Outcome | A beam pattern file is created. | |
Extra Notes | N/A | |