CARIS HIPS and SIPS : CARIS Batch Utility : Variable Resolution Surface Processes : Remove From VR Surface
 

Remove From VR Surface

Description

The RemoveFromVRSurface process removes source points from an existing variable resolution surface using the process parameters in the CSAR metadata.

Update

The variable resolution surface to update.

Inputs

Source points in a point cloud or raster surface in CSAR format or one or more HIPS track lines.

Outputs

An updated variable resolution surface.

Command Line Syntax

carisbatch --run RemoveFromVRSurface [options] <inputs> <update>

User Interface Command

Remove from Coverage

Options

The following table describes the parameters available for this process.

Parameter

 

Long

Short

Description

Can Repeat

Notes

 

--update-type

The type of operation to update with new data. One of:

RESOLUTION: Update resolution estimates

SURFACE: Update surface nodes

BOTH: Update both resolution estimates and surface nodes.

The default value is BOTH.

FALSE

Example

To use this command refer to the following example.

Example

Objective

A track line that was used to create the VR surface needs to be removed.

Description

Command Line Syntax

Only the surface nodes will be removed from the VR surface.

--update-type SURFACE

The track line data to be removed from the surface is file:///file:///D:/BatchSample/input/input.hips?Vessel=sample;Day=2000-001

file:///D:/BatchSample/input/input.hips?Vessel=sample;Day=2000-001

The VR surface to be updated is VRSurface.csar located at D:\BatchSample.

D:\BatchSample\VRSurface.csar

Command Line

carisbatch --run RemoveFromVRSurface --update-type SURFACE file:///D:/BatchSample/input/input.hips?Vessel=sample;Day=2000-001 D:\BatchSample\VRSurface.csar

Outcome

The specified track line data is removed from the VR surface.

Extra Notes

N/A