CARIS Batch Utility : BASE Editor Processes : Add Smoothed Band
 

Add Smoothed Band

Description

The AddSmoothedBand process adds a new smoothed elevation band to an existing coverage by applying smoothing operations to an existing elevation band. The Expand Shoals method pushes a distance-decaying value from all shoal points to expand spikes. The Laplacian method iteratively compares every point in the DEM to the weighted average of the surrounding neighbourhood, and raises all points that are deeper than their neighbourhood average.

Update

A raster or variable resolution surface in CSAR format.

Outputs

An updated raster or variable resolution surface in CSAR format.

Command Line Syntax

carisbatch --run AddSmoothedBand [options] <update>

User Interface Command

Add Smoothed Band

Options

The following table describes the parameters available for this process.

Parameter

 

Long

Short

Description

Can Repeat

Notes

 

Common Options

--method

The algorithm applied to produce smoothed elevation values.

LAPLACIAN: Applies Ravi Peters iterative smoothing to the partitioned surface.

RESTRAINED_LAPLACIAN: Applies conservative Ravi Peters iterative smoothing to the partitioned surface.

EXPAND_SHOALS: Expands shoals to limit the steepness of the slope around them, producing a smoother surface.

ROLLING_COIN: Uses disc-based smoothing to generalize around noise, producing a smoother surface.

FALSE

--input-band

i

A string specifying the name of the input raster band that will be classified.

This must be an elevation band.

FALSE

This must be specified explicitly.

--smoothed-band

A string specifying the name of the output band.

If an existing band is specified, values in that band are overwritten.

FALSE

This must be specified explicitly.

Method = LAPLACIAN Options

--iterations

The number of times the local averaging process is applied.

The default value is 20. The value can be any number between 1 and 1000.

The higher the number of iterations, the longer the processing time.

FALSE

Method = RESTRAINED LAPLACIAN Options

--iterations

The number of times the local averaging process is applied.

The default value is 20. The value can be any number between 1 and 1000.

The higher the number of iterations, the longer the processing time.

FALSE

Method = EXPAND_SHOALS Options

--radius-type

The type of radius used for smoothing.

FIXED: A single specified distance is used as the radius.

MULTIPLIER: A multiple of surface resolution is used as the radius.

HYBRID: The sum of a specified distance and a multiple of surface resolution is used as the radius.

The default value is MULTIPLIER. The use of MULTIPLIER and HYBRID are most relevant when smoothing on a variable resolution surface.

FALSE

--radius

A number and unit specifying the fixed distance component of the smoothing radius.

The default value is 0.0m. The value can be any positive number. This value is ignored if RadiusType is MULTIPLIER.

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

FALSE

--multiplier

A number specifying the resolution multiplier component of the smoothing radius.

The default value is 5. The value can be any positive number. This value will be ignored if RadiusType is FIXED.

FALSE

--dropoff-slope

A negative number specifying the steepest allowed slope around shoals.

The default value is -0.125. Values are unitless as they represent depth value decrease per unit of distance.

FALSE

Method = ROLLING_COIN Options

--multiplier

A number specifying the resolution multiplier for the smoothing radius.

The default value is 5. The value can be any positive number.

FALSE

To use this command, refer to the following examples.

Example: Expand Shoals Smoothing

Example

Objective

You want to apply smoothing to a surface, expanding the size of shoals with a more gradual drop-off around them, before later creating smoother, hydrographically safe contours.

Description

Command Line Syntax

The EXPAND_SHOALS smoothing algorithm is to be applied.

--method EXPAND_SHOALS

The Depth band is to be smoothed.

--input-band Depth

The new band in which to store the smoothed values will be called DepthSmoothed.

--smoothed-band DepthSmoothed

A hybrid radius will be used for the smoothing.

--radius-type HYBRID

The radius distance is 5m.

--radius 5m

The resolution multiplier value is 4.

--multiplier 4

The resulting slopes are to be no steeper than -0.25.

--dropoff-slope -0.25

Smoothing will be applied to the SmoothSurface.csar coverage in the D:\BatchSample directory.

D:\BatchSample\SmoothSurface.csar

Command Line

carisbatch --run AddSmoothedBand --method EXPAND_SHOALS --input-band Depth --smoothed-band DepthSmoothed --radius-type HYBRID --radius 5m --multiplier 4 --dropoff-slope -0.25 D:\BatchSample\SmoothSurface.csar

Outcome

A new DepthSmoothed band is added to the input surface containing the smoothed elevation values.

Extra Notes

N/A

Example: Laplacian Smoothing

Example

Objective

You want to apply smoothing to a surface to elimate unnecessarily deep points and achieve a more uniform surface depth while maintaining the shoaler points.

Description

Command Line Syntax

The Laplacian smoothing algorithm is to be applied.

--method LAPLACIAN

The Depth band is to be smoothed.

--input-band Depth

The new band in which to store the smoothed values will be called DepthSmoothed.

--smoothed-band DepthSmoothed

The algorithm should be applied 30 times.

--iterations 30

Smoothing will be applied to the LaplacianSurface.csar coverage in the D:\BatchSample directory.

D:\BatchSample\LaplacianSurface.csar

Command Line

carisbatch --run AddSmoothedBand --method LAPLACIAN --input-band Depth --smoothed-band DepthSmoothed --iterations 30 D:\BatchSample\LaplacianSurface.csar

Outcome

A new DepthSmoothed band is added to the input surface containing the smoothed elevation values.

Extra Notes

N/A