Description
The DetectSIPSSideScanTargets process makes corrected or uncorrected Side Scan Imagery (from HIPS and SIPS track lines) available over GRPC for third party classification, which then passes back the positions from the classified contacts and this process saves them to the HIPS file and creates a PDF report per track line.
Inputs
One or more HIPS track lines.
Outputs
Updated HIPS file and PDF Reports, one per track line
Command Line Syntax
carisbatch --run DetectSIPSSideScanTargets file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001 {options]
Options
Parameter |
| |||
|---|---|---|---|---|
Long | Short key | Description | Can Repeat | Notes
|
--imagery-type | The type of imagery to be sent to the classification process: • UNCORRECTED: Uncorrected - Raw time series data from side scan • CORRECTED: Corrected - Time series data with imagery processing (Beam Pattern, TVG, etc.) applied The default value is UNCORRECTED. | FALSE | ||
--colour-file | The name of the colour map file to use when rendering the raster. | FALSE | Populated from the colour folder in | |
--reverse-colours | If set, the colour map is applied in the reverse order. | FALSE | ||
--pdf-report-output | A PDF report for all contacts identified from the side scan imagery will be stored in the specified folder. • HIPS_FOLDER: HIPS folder- Default folder created in HIPS folder with HIPS data • USER_DEFINED: User-defined - User-defined folder selected by user The default value is HIPS_FOLDER | FALSE | ||
--pdf-report-folder | The path to the PDF Reports output for the contacts per line. | FALSE | Use when PDFReportOutput=HIPS_FOLDER | |
--beam-pattern | Apply beam pattern correction. • NONE: None - No beam pattern will be applied • BOTH: Both - Beam pattern will be applied to both port and starboard • PORT: Port - Beam pattern will be applied to port only • STARBOARD: Starboard - Beam pattern will be applied to starboard only The default value is NONE. | FALSE | ||
--beam-pattern-file | If set, the path to the beam pattern file. Only applicable if BeamPattern is not set to NONE. | FALSE | ||
--gain | If set, numbers specifying the gain correction to apply to the port/starboard side. • <Port> - The port side gain correction value. • <Starboard> - The starboard side gain correction value. If not set, no Gain is applied. The valid range is 1 or greater. Supported units: dB. | FALSE | ||
--tvg | If set, numbers specifying the time-varying gain correction to apply to the port/starboard side. • <Port> - The port side TVG correction value. • <Starboard> - The starboard side TVG correction value. If not set, no TVG is applied. The valid range is 1 or greater. Supported units: dB. | FALSE | ||
--gain-normalization | If set, a number specifying the number of pings used to set the window size for the moving-average window filter. If not set, no Gain Normalization is applied. The valid range is 1 or greater. | FALSE | ||
--despeckle | If set, a number specifying the strength of the despeckle filter as a percentage for despeckling the output mosaic pixels. Pixels are changed to the average of the neighbours if they have an intensity level outside a specified strength compared to the neighbouring intensity levels. If not set, no filtering is applied. The valid range is 10 to 90 percent. | FALSE | ||
--server-address | If set, the address to the target detection server. If not set, localhost:50051 is used. | FALSE | ||
--imagery-folder | If set, the generated side scan images are saved to the specified destination folder. If not set, imagery is not saved. | FALSE | ||
Examples
Example 1 | ||
|---|---|---|
Objective | To create a PDF report of uncorrected imagery, and place it in the default HIPS folder. | |
Description | Command Line Syntax | |
The input file | file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001 | |
Command Line | carisbatch -r DetectSIPSSideScanTargets file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001 | |
Example 2 | ||
|---|---|---|
Objective | To create a PDF report of corrected imagery. | |
Description | Command Line Syntax | |
The type of imagery is time series data with imagery processing applied | --imagery-type CORRECTED | |
The name of the colour map file to use when rendering the raster is copper.cma | --colour-file copper.cma | |
The location for the PDF report is user-defined using the ‑‑ | --pdf-report-output USER-DEFINED | |
The path for the output PDF Reports is | --pdf-report-folder C:\temp\reports\ | |
The input file | file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001 | |
Command Line | carisbatch -r DetectSIPSSideScanTargets --imagery-type CORRECTED --colour-file copper.cma --pdf-report-output USER-DEFINED --pdf-report-folder C:\temp\reports\ file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001 | |
Example 3 | ||
|---|---|---|
Objective | To create a PDF report of corrected imagery with a beam pattern correction applied to the input data. | |
Description | Command Line Syntax | |
The type of imagery is time series data with imagery processing applied | --imagery-type CORRECTED | |
Apply beam pattern correction to both port and starboard | --beam-pattern BOTH | |
The beam pattern file is | --beam-pattern-file D:\Mosaics\bp.bbp | |
The input file | file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001 | |
Command Line | carisbatch -r DetectSIPSSideScanTargets --imagery-type CORRECTED --beam-pattern BOTH --beam-pattern-file D:\Mosaics\bp.bbp file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001 | |