Description
The AddToSIPSMosaic process adds HIPS sources to an existing raster mosaic using the process parameters.
Update
The SIPS mosaic to update.
Inputs
One or more HIPS track lines.
Outputs
An updated SIPS mosaic.
Command Line Syntax
carisbatch --run AddToSIPSMosaic
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short key | Description | Can repeat | Notes
|
Common Options | ||||
--mosaic-engine | m | The mosaic engine used to generate the output mosaic. • 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 • GEOCODER: Uses GeoCoder functionality from UNH | FALSE | This must be explicitly specified. |
--blending | The method used to blend pixels together. • WEIGHTED: Blend overlapping pixels based on a weighted average value • HIGHEST: Use only the highest-weighted pixel in the output, no blending • OVERWRITE: Use the last input pixel value in the output, no blending The default value is WEIGHTED. | FALSE | ||
--weighting | The method used to weight pixels across a single ping. • SWATH: Weighting is based on sonar geometry where nadir has a low weight, off-nadir has the highest weight, and a decay function is used to decrease weighting out to the swath edge • FIXED: All values are weighted equally across the ping (primarily for SAS imagery The default value is SWATH. | FALSE | ||
MosaicEngine = SIPS_BACKSCATTER Options | ||||
--avg | A number specifying the number of across track samples to include in the moving average filter. Use a moving average filter to remove the angular response of sediment from the imagery. | FALSE | ||
--beam-pattern-file | If set, applies a Beam Pattern by setting the path to the beam pattern file. If not set, no Beam Pattern is applied. | FALSE | ||
--beam-pattern-file-operation | If the beam pattern file selected already exists, sets the file operations on the existing file. • UPDATE: Updates the file with the new line information, can accumulate many lines over many surveys • OVERWRITE: Overwrites the existing file with a new file from the current lines • USE_EXISTING: Uses the existing file and does no new Beam Pattern updating/creation The default value is UPDATE. | FALSE | Used only with Beam Pattern File set. | |
--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 angle 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 | ||
--filter | -f | A number limiting the final compensated intensities in the mosaic to a minimum/maximum range. Supported units: dB. | FALSE | |
--sound-velocity | A number specifying the sound velocity values set by the user applied during slant range correction. Using this option will override the use of Surface Sound Speed. Valid range is 1400 to 1600. Supported units: metres/seconds. | FALSE | ||
MosaicEngine = SIPS_SIDESCAN Options | ||||
--channel | Select the data channel to read for processing. • BOTH: Both channels • PORT: Port channel • STARBOARD: Starboard channel The default value is BOTH. | FALSE | ||
--beam-pattern | Apply beam pattern correction. • NONE: No beam pattern will be applied • BOTH: Beam pattern will be applied to both port and starboard • PORT: Beam pattern will be applied to port only • STARBOARD: Beam pattern will be applied to starboard only The default value is NONE. | FALSE | ||
--beam-pattern-file | The path to the beam pattern file. Only applicable if Beam Pattern is not set to NONE. | FALSE | ||
--gain | A number 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. The default value is 4. The valid range is 1 or greater. Supported units: dB. | FALSE | ||
--tvg | A number 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. The default value is 30. The valid range is 1 or greater. Supported units: dB. | FALSE | ||
--gain- normalization | A number specifying the number of pings used to set the window size for the moving-average window filter. The default value is 20. The valid range is 1 or greater. | FALSE | ||
--despeckle | 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. The valid range is 10 to 90 percent. | FALSE | ||
--ratio | A number specifying the across-track distance to altitude ratio minimum/maximum which imagery is clipped (i.e. nadir and swath edge filter, respectively). • <Minimum> - The minimum across-track distance to altitude ratio to filter by. • <Maximum> - The maximum across-track distance to altitude ratio to filter by. The default value is 0. | FALSE | ||
--ratio-limit | A number limiting the Across-track/Altitude Ratio ratio filter to a minimum/maximum range. • <Minimum> - The minimum limit for the across-track distance to altitude ratio filter. • <Maximum> - The maximum limit for the across-track distance to altitude ratio filter. The default value is 0. Supported units: metres. | FALSE | ||
--across-distance-limit | A number limiting the across-track distance from nadir to a minimum/maximum range. • <Minimum> - The minimum distance from nadir. • <Maximum> - The maximum distance from nadir. The default value is 0. Supported units: metres. | FALSE | ||
--filter | f | A number limiting the final compensated intensities in the mosaic to a minimum/maximum range. • <MinValue> - A number specifying the range's lower bound. • <MaxValue> - A number specifying the range's upper bound. Supported units: dB. | FALSE | |
--extrapolate-time | A number to set extrapolate heading/motion data for the specified time interval. The default value is 0. Supported units: seconds | FALSE | ||
--registration-bathy | If set, registers the imagery using co-acquired bathymetry. Only applicable if the lines contain processed bathymetry. | FALSE | ||
--gyro-source | The heading source to be used for processing. • AUTO: Use the first of Towfish gyro, then Ship gyro, then Course Made Good • CMG: Course made good, calculated from position • SHIP: Ship gyro sensor • FISH: Towfish gyro sensor The default value is AUTO. | FALSE | ||
--smooth-gyro | If set, applies smoothing coefficients to the gyro data. | FALSE | ||
--sound-velocity | A number to set the sound velocity applied during slant range correction. The default value is 1500 m/s. Supported units: metres/second. | FALSE | ||
--altitude-offset | A number to set an offset for the altitude data in time/height. • <Time> - The time offset for the altitude data. • <Height> - The height offset for the altitude data. The default value is 0. Supported units: seconds/metres. | FALSE | ||
MosaicEngine = GEOCODER Options | ||||
--channel | Select the data channel to read for processing. • BOTH: Both channels • PORT: Port channel • STARBOARD: Starboard channel The default value is BOTH. | FALSE | ||
--imagery | The type of imagery to be process. • BEAM_AVERAGE: Beam average data will be processed • SIDE_SCAN: Side scan data will be processed • TIME_SERIES: Time series data will be processed The default value is TIME_SERIES. | FALSE | ||
--auto-resolution | If set, automatically determines best resolution based on data density. This overrides the Resolution parameter. | FALSE | ||
-disable-anti-alias | if set, disables application of anti-aliasing during imagery correction. | FALSE | ||
--gain | If set, applies an automatic time-varying gain correction. | FALSE | ||
--tvg | If set, applies an automatic time-varying gain correction. | FALSE | ||
--avg | Apply an angle-varying gain correction using a moving-average window across-track. • NONE: No AVG correction is applied. • FLAT: Apply a flat normalization curve to the imagery. • TREND: Apply a non-linear normalization curve to the imagery. • ADAPTIVE: Apply FLAT or TREND based on slope of the intensity. The default value is NONE. | FALSE | ||
--avg-window-size | The window size in pixels used for AVG correction. | FALSE | ||
--despeckle | Apply despeckle to the mosaic. • NONE: • WEAK: • MODERATE: • STRONG: • VERY_STRONG: The default value is NONE. | FALSE | ||
-nadir-angle | Set angle across-track from directly below the transducer (0 degrees) to set how much data is included in the mosaic. <Minimum> - The minimum angle from nadir. <Maximum> - The maximum angle from nadir. Supported units: degrees. | FALSE | ||
--filter | f | A number limiting the final compensated intensities in the mosaic to a minimum/maximum range. • <MinValue> - A number specifying the range's lower bound. <MaxValue> - A number specifying the range's upper bound. Supported units: dB. | FALSE | |
--surface | The path to the surface used to compute the local bottom slope used in the GeoCoder calculations of real incidence angle and ensonified area. The default elevation band will be used. | FALSE | ||
--smooth-gyro | If set, applies smoothing coefficients to the gyro data. | FALSE | ||
Example
To use this command refer to the following example.
Example | ||
Objective | To add sources to an existing SIPS Mosaic. | |
Description | Command Line Syntax | |
The mosaic engine used is SIPS side scan. | --mosaic-engine SIPS_SS | |
Both channels will be processed. | --channel BOTH | |
The intensity will be filtered to +/-200 dB. | --intensity -200.0dB 200.0dB | |
The input files is Demo.hips located at D:\Data. The HIPS file URI filters for the vessel named “Voyager” and day 2015-044 and line 1344_20080926_202553_Voyager. | file:///D:/Data/Demo.hips?Vessel=Voyager;Day=2015-044;Line=1344_20080926_202553_Voyager | |
The output file will be named ss_mosaic.csar located at D:\BatchSample. | D:\BatchSample\ss_mosaic.csar | |
Command Line |
| |
Outcome | Line 1344_20080926_202553_Voyager is added to the existing mosaic. | |
Extra Notes | N/A | |