Parameter

Long

Short key

Description

Can Repeat

Notes

Common Options

--mosaic-engine

m

The mosaic engine used to generate the output mosaic. 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

• GEOCODER: Uses GeoCoder functionality from UNH

FALSE

This must be explicitly specified.

--resolution

R

A number and unit specifying the resolution of the output raster.

Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.

FALSE

--blending

The method used to blend pixels together. One of:

• 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. One of:

• SIDESCAN: 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 SIDESCAN.

FALSE

--output-crs

c

A string specifying the horizontal coordinate reference system key of the output.

FALSE

--editable

If set, creates an editable mosaic. Extra processing is done to allow for editing of mosaics after creation.

FALSE

Defaults to FALSE.

--extent

E

The extents that defines the window.

<LowerX> - A number specifying the lower left X origin in the coordinate reference system of the output.

<LowerY> - A number specifying the lower left Y origin in the coordinate reference system of the output.

<UpperX> - A number specifying the upper right X origin in the coordinate reference system of the output.

<UpperY> - A number specifying the upper right Y origin in the coordinate reference system of the output.

The unit is assumed to be that of the output's coordinate reference system, unless otherwise specified. When specifying units for un-projected data, an angle type unit is required. The order for un-projected coordinates is longitude followed by latitude. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.

FALSE

MosaicEngine = SIPS_BACKSCATTER Options

--imagery

The type of imagery to be processed.

• BEAM_AVERAGE: Beam average data will be processed

• TIME_SERIES: Time series data will be processed

The default value is BEAM_AVERAGE.

FALSE

--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

If not set, no Beam Pattern is applied.

--beam-pattern-file-operation

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

• 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.

Used only with 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

--r2s-multispectral-frequency

The R2Sonics Multispectral frequency(s) to use when creating a mosaic.

• ALL: All - All frequencies put together as a multispectral mosaic.

• LOW: Low - Lowest frequency only used in resulting mosaic.

• MEDIUM: Medium - Medium frequency only used in resulting mosaic.

• HIGH: High - Highest frequency only used in resulting mosaic.

The default value is ALL.

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

--filter-angle-t1

Filters transducer 1 data to a min/max angle.

<MinAngle> - The minimum angle to filter.

<MaxAngle> - The maximum angle to filter.

The default values are 90.00 90.00. The valid range is -20 to 100.

FALSE

--filter-angle-t2

Filters transducer 2 data to a min/max angle.

<MinAngle> - The minimum angle to filter.

<MaxAngle> - The maximum angle to filter.

The default values are 90.00 90.00. 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 is to use the processed bathymetry.

FALSE

--filter

f

Filter the input bands by setting those outside the specified range to NO-DATA.

<MinValue> - A number specifying the range's lower bound.

<MaxValue> - A number specifying the range's upper bound.

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. One of:

• BOTH: Both channels

• PORT: Port channel

• STARBOARD: Starboard channel

The default value is BOTH.

FALSE

--beam-pattern

Apply beam pattern correction. One of:

• 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 BeamPattern is not set to NONE.

FALSE

--gain

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

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

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

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

--ratio

Numbers 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.

If not set, no clipping is applied.

FALSE

--ratio-limit

Numbers 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.

Only applicable if Ratio is set. Supported units: metres.

FALSE

--across-distance-limit

Numbers limiting the across-track distance from nadir to a minimum/maximum range.

<Minimum> - The minimum distance from nadir.

<Maximum> - The maximum distance from nadir.

If not set, no clipping is applied. Supported units: metres.

FALSE

--filter

f

Filter the input bands by setting those outside the specified range to NO-DATA.

<MinValue> - A number specifying the range's lower bound.

<MaxValue> - A number specifying the range's upper bound.

A number limiting the final compensated intensities in the mosaic to a minimum/maximum range.

Supported units: dB.

FALSE

--extrapolate-time

A number to set extrapolate heading/motion data for the specified time interval.

If not set, no extrapolation is done. 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. One of:

• 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. If not set, the default value is used.

Supported units: metres/second.

FALSE

--altitude-offset

Numbers to set offsets for the altitude data in time/height.

<Time> - The time offset for the altitude data.

<Height> - The height offset for the altitude data.

If not set, no offset is applied. Supported units: seconds/metres.

FALSE

MosaicEngine = GEOCODER Options

--channel

Select the data channel to read for processing. One of:

• BOTH: Both channels

• PORT: Port channel

• STARBOARD: Starboard channel

The default value is BOTH.

FALSE

--imagery

The type of imagery to be processed. One of:

• 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

--anti-alias

If set, applies anti-aliasing during imagery correction.

FALSE

--gain

If set, applies an automatic gain correction.

FALSE

--tvg

If set, applies an automatic time-varying gain correction.

FALSE

Defaults to AUTO.

--avg

Apply an angle-varying gain correction using a moving-average window across-track. One of:

• 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. One of:

• NONE:

• WEAK:

• MODERATE:

• STRONG:

• VERY_STRONG:

The default value is NONE.

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 BeamPattern is not set to NONE.

FALSE

--nadir-angle

Set angles 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

Filter the input bands by setting those outside the specified range to NO-DATA.

<MinValue> - A number specifying the range's lower bound.

<MaxValue> - A number specifying the range's upper bound.

A number limiting the final compensated intensities in the mosaic to a minimum/maximum range.

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

Objective

You want to create a mosaic using Geocoder.

Description

Command Line Syntax

The mosaic engine to use is SIPS side scan.

--mosaic-engine SIPS_SIDESCAN

The resolution is 10 m.

--resolution 10m

The data channel is the port channel.

--channel PORT

Beam correction will be applied.

--beam-pattern PORT

The input file is

D:\BatchSample\

The output file will be named MosaicSIPS.csar and saved to D:\BatchSample.

D:\BatchSample\MosaicSIPS.csar

Command Line

carisbatch --run MosaicSIPS --mosaic-engine SIPS_SS --resolution 10m --channel PORT ‑‑beam-pattern PORT D:\BatchSample\xxx D:\BatchSample\MosaicSIPS.csar

Outcome

A new csar raster mosaic is created.

Extra Notes

N/A