0% found this document useful (0 votes)

1K views275 pages

CARISBatch Utility Reference Guide

Uploaded by

latni el mehdi

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

1K views275 pages

CARISBatch Utility Reference Guide

Uploaded by

latni el mehdi

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 275

CARIS Batch Utility 4.

Reference Guide
Teledyne CARIS, Inc. Teledyne CARIS EMEA
(Global Headquarters) (Europe, Middle East, Africa)
115 Waggoners Lane Bremvallei 1
Fredericton, NB 5237 LV 's-Hertogenbosch
Canada The Netherlands
E3B 2L4

Phone: 1 506 458-8533

(English/French/Spanish) Phone: +31 (0)73 648 8888
Fax: 1 506 459-3849 Fax: +31 (0)73 648 8889
Email: [email protected] Email: [email protected]
Assistance: [email protected] Assistance: [email protected]
Web site: www.teledynecaris.com

Teledyne CARIS USA Teledyne CARIS Asia Pacific

415 N. Alfred Street PO Box 1580
Alexandria, VA Milton QLD 4064
USA Australia
22314

Phone: 1 703 299-9712 Phone: +61 (0) 7 3719 5132

Fax: 1 703 299-9715 Email: [email protected]
Email: [email protected]

October 2017
Trademarks owned by Teledyne CARIS, Inc.
This is a listing of USPTO-registered trademarks and trademarks owned by Teledyne CARIS, Inc. and
might also be trademarks or registered trademarks in other countries. Please note that laws concerning
use and marking of trademarks or product names vary by country. Consult a local attorney for
additional guidance. Teledyne CARIS, Inc. permits the use of its trademarks and registered trademarks
only where they are used in reference to Teledyne CARIS, Inc. and its products, the markings used are
appropriate to the country or countries of publication, and Teledyne CARIS, Inc. is explicitly
acknowledged as the owner of the mark. Teledyne CARIS, Inc. reserves the right to withdraw this
permission at its sole discretion for any use it feels is inappropriate or adverse to its interests. Teledyne
CARIS, Inc. otherwise prohibits the use of any of its registered symbols, insignia, or other identifying
marks without express written approval. Violations are subject to liability for damages, injunctive relief,
attorney's fees and other penalties.

Not all trademarks used by Teledyne CARIS, Inc. are listed in this document. Failure of a mark to
appear on this page does not mean that Teledyne CARIS, Inc. does not use the mark nor does it mean
that the product is not actively marketed or is not significant within its relevant market. The absence of
a product or service name or logo from this list or the absence of a TM or TM Reg. USPTO notation against
a product or phrase listed below does not constitute a waiver by Teledyne CARIS, Inc. of its trademark
or other intellectual property rights concerning that name or logo.

The following are trademarks or USPTO-registered trademarks of Teledyne CARIS, Inc.:

• Article 76 Module • EAM • LOTS Article 76
• Bathy DataBASE • Engineering Analysis Module • One Feature, One Time
• Bathy DataBASE Server • HIPS • Paper Chart Composer
• BASE Editor • HIPS and SIPS • Paper Chart Editor
• BASE Manager • HPD • Ping-to-Chart
• BDB • HPD Server • Product Editor
• CARIS • Hydrographic Production • Publications Module
• CARIS GIS Database • S-57 Composer
• CARIS Notebook • Limits and Boundaries • SIPS
• CARIS Onboard Module • Source Editor
• ChartServer • LIN • Spatial Fusion
• CPD • LOTS • Spatial Fusion Enterprise
• Core Production Database • LOTS Browser • Teledyne CARIS
• Easy View • LOTS Limits and Boundaries

Those trademarks followed by or footnoted as TM Reg. USPTO later in this document are registered
trademarks of Teledyne CARIS, Inc. in the United States; those followed by or footnoted as TM Reg.
CIPO
are registered trademarks of Teledyne CARIS, Inc. in Canada; those followed by or footnoted as
either TM Reg. USPTO and CIPO or TM Reg. USPTO, CIPO are registered trademarks of Teledyne CARIS, Inc.
in both the United States and Canada; those followed by or footnoted as TM are trademarks or common
law marks of Teledyne CARIS, Inc. in Canada and the United States, and in other countries.

The trademarks and names of other companies and products mentioned herein are the property of
their respective owners.

Copyright owned by Teledyne CARIS, Inc.

All written and image content in this document not protected by the copyrights of others is © Copyright
2011, Teledyne CARIS, Inc. All rights reserved. All reproduction and redistribution is strictly prohibited
without the express prior written consent of Teledyne CARIS, Inc.
Copyright © 2017 Teledyne CARIS, Inc. All rights reserved.
Table of Contents

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Standard Streams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Exit Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

2 Feature Editing Processes . . . . . . . . . . . . . . . . . . . . . . . 15

Add Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Change Feature Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Clip Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Export Features to Shapefile . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Export to WKT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Filter Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Simplify Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Smooth Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

3 BASE Editor Processes . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Add Smoothed Band. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Add to Raster Combine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Add to VR Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Classify Raster Holidays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Clip Raster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Combine to Raster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Contour Raster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Copy to CSAR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Create Soundings from Coverage . . . . . . . . . . . . . . . . . . . . . . . 47
Create VR Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Describe Raster Product. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Difference Coverages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Export Coverage Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Export Coverage to ASCII. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Export Points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Export Raster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Export Raster to STL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Export VR Surface to BAG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Extract Coverage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Fill Raster Holidays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Filter Coverage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Finalize Raster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Finalize VR Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Generalize Raster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Grid Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Import Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Import VR Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

CARIS Batch Utility Reference Guide 5

Join Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Populate VR Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Rebalance Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Remove From VR Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Render Raster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Repair Coverage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Resample Surface To Raster . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Server Add to Raster Combine . . . . . . . . . . . . . . . . . . . . . . . . . 126
Server Combine to Raster . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Server Join Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Shift Elevation Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Smooth Features by Direction Bias . . . . . . . . . . . . . . . . . . . . . 139
Thin Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Tile Raster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Update VR CUBE Disambiguation . . . . . . . . . . . . . . . . . . . . . . 149
Vectorize Raster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Warp Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Warp Raster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

4 Engineering Analysis Processes . . . . . . . . . . . . . . . . . 159

Calculate Coverage Volumes . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Contour Raster by Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

5 Compose Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Assign Sounding SCAMIN Values . . . . . . . . . . . . . . . . . . . . . . 168
Export S-57 Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

6 HIPS Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Add To HIPS Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Add To SIPS Mosaic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Compare HIPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Compute HIPS GPS Tide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Compute HIPS Separation Model . . . . . . . . . . . . . . . . . . . . . . . 186
Compute HIPS TPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Compute SIPS Towfish Navigation. . . . . . . . . . . . . . . . . . . . . . 191
Create HIPS Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Create SIPS Beam Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Create SIPS Mosaic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Detect HIPS Critical Soundings . . . . . . . . . . . . . . . . . . . . . . . . 207
Filter HIPS Attitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Filter Observed Depths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Filter Processed Depths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Import Generic To HIPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Import HIPS From Auxiliary . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Import Multiple Detections To HIPS . . . . . . . . . . . . . . . . . . . . . 230
Import Tide To HIPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Import To HIPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Merge HIPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

6 CARIS Batch Utility Reference Guide

Recompute HIPS Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Remove From HIPS Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Remove From SIPS Mosaic . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Reset HIPS Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Set HIPS Navigation Source. . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Shift HIPS Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Sound Velocity Correct HIPS . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Update HIPS Additional Bathymetry . . . . . . . . . . . . . . . . . . . . . 265
Update Raster CUBE Disambiguation . . . . . . . . . . . . . . . . . . . 266
Update SIPS Contact Positions . . . . . . . . . . . . . . . . . . . . . . . . 267

CARIS Batch Utility Reference Guide 7

8 CARIS Batch Utility Reference Guide
1
Introduction

This chapter describes CARIS command-line processes and the CARIS

Batch utility.

In this chapter...
OVERVIEW .................................................................. 10
STANDARD STREAMS .................................................... 12
EXIT CODES ............................................................... 13
Introduction: Overview

Overview
The CARIS1 Batch utility runs command-line processes on
marine products generated from CARIS applications.
CARIS Batch is installed in the \Bin folder of a CARIS
application. For a complete list of CARIS processes, see “A BATCH
carisbatch.exe, SHOULD TEST THE EXIT CODE. SEE THE
SCRIPT CALLING
FOLLOWING EXAMPLE.” ON PAGE 13.

The basic syntax for carisbatch is shown below:

carisbatch --run <process_name> <parameters> <input> <output>

The -r key or --run parameter is required to run a process.

Processes are bound by the following rules:
• Parameters are identified either by character keys or
parameter names. Keys use a single-hyphen prefix (-h) and
parameter names use a double-hyphen prefix (--help).
• Values are separated from parameters by a space (e.g. -n 6).
• Parameter values with spaces must be enclosed in quotation
marks (e.g. -c "New DSID Comment").
• Process names are not case-sensitive, but parameter names
are. Be careful when entering parameters.

Parameters are case-sensitive. Check the help message to determine

parameter settings.

•
Information about CARIS Batch or individual processes is
available. See the following table.

Parameter

Long Short Description

--help h Print the help, including available options.

Example: carisbatch --run <process_name> --help
--list- l Print the list of available processes.
processes
--run r Run a process.
--recurse u Run the process on all files that match the input
description in any subfolders.
--verbose v Print verbose messages.
--version Print the executable version and copyright information,
including the version of modules.

1. This term is a trademark of Teledyne CARIS, Reg. USPTO and CIPO.

10 CARIS Batch Utility Reference Guide

Introduction: Overview

Input can be either a file or a URI-based data store. Output can

also be to a file or database.
File paths with spaces must be enclosed in quotation marks. For
example, "C:\Directory Name\Sample File". Otherwise, the path
and name can be entered without quotation marks. For example,
C:\DirectoryName\SampleFile.

A universal resource identifier (URI) is required to access a

database.
If BDB™ input is a coverage in a database, it can be specified
with a URI to the coverage:
bdb://user:password@servername/databasename/boid,

where:
• bdb:// identifies a Bathy database
• user:password@servername is the connection string to the BDB
node manager
• databasename/boid is the path to the coverage (CSAR)
For example:
bdb://dba:sql@server2012machine1/databasename/02000001.

Run CARIS Batch CARIS Batch is run from the Command Prompt window. In
order to ensure the environment is setup correctly, you can:
• start the command prompt from the Start menu, CARIS >
(application) (version) > (application) (version) Command
Prompt, or

• start any command prompt and run the environment batch

script in the install directory e.g. C:\Program
Files\CARIS\<application>\<version>\system\caris_env.bat,
or
• start the command prompt from the CARIS utilities toolbar
To use the utilities toolbar, open a CARIS application and go to
View > Toolbars > Utilities. Select Show command prompt from the
toolbar drop down list. Click the play button to run the utility.
1. Open the Command Prompt window.
2. Type carisbatch --run followed by the process and parameters.
3. Press <Enter>
The selected process is run.
The processes available in CARIS Batch differ based on the
application from which the command prompt was launched and
the modules enabled in the application.

CARIS Batch Utility Reference Guide 11

Introduction: Standard Streams

Standard Streams
CARIS Batch uses Standard Output Stream (STDOUT) for
presenting text information in Command Prompt. Information
about processing errors are sent to the Standard Error Stream
(STDERR), which is also displayed in Command Prompt.
The STDOUT stream can be saved to a text file by using the
redirection operator (>). See the following example:
carisbatch.exe -r ProcessName [process options...] > process-output.txt

The STDOUT stream can also be silenced by redirecting it to

nul:
carisbatch.exe -r ProcessName [process options...] > nul

The STDERR stream can be saved to a text file by using the

redirection operator (>). See the following example:
carisbatch.exe -r ProcessName [process options...] 2> process-errors.txt

The STDERR streams can also be silenced by redirecting it to

nul:
carisbatch.exe -r ProcessName [process options...] 2> nul

The STDOUT and STDERR streams can be both redirect to

different files in the same command. See the following example:
carisbatch.exe -r ProcessName [process options...] 2> process-errors.txt >
process-output.txt

The STDOUT and STDERR streams can be both redirected to

same file in the same command. See the following example:
carisbatch.exe -r ProcessName [process options...] 2>&1 > process-all.txt

12 CARIS Batch Utility Reference Guide

Introduction: Exit Codes

Exit Codes
When CARIS Batch terminates, it returns the following values
to the Command Prompt:
• = 0, returns 0 (zero) when there were no processing errors;
• = 1, returns 1 (one) indicating there was a processing error.
A batch script calling carisbatch.exe, should test the exit code.
See the following example.
carisbatch.exe -r ProcessName [process options...]
if %ERRORLEVEL% NEQ 0 (
echo Error in CARIS Batch: %ERRORLEVEL%
exit /B %ERRORLEVEL%
)

CARIS Batch Utility Reference Guide 13

Introduction: Exit Codes

14 CARIS Batch Utility Reference Guide

Feature Editing Processes
2
This chapter describes the processes available for the CARIS Batch
command line tool in Feature Editing.

In this chapter...
ADD FEATURES ........................................................... 16
CHANGE FEATURE ATTRIBUTES ...................................... 18
Change Spatial Attributes ....................... 20
CLIP FEATURES ........................................................... 20
Compare Features....................................... 22
ERASE FEATURES ........................................................ 22
EXPORT FEATURES TO SHAPEFILE .................................. 22
EXPORT TO WKT ........................................................ 23
FILTER FEATURES ........................................................ 24
SIMPLIFY FEATURES ..................................................... 26
SMOOTH FEATURES ...................................................... 28
Feature Editing Processes: Add Features

Add Features
Description The AddFeatures process copies features from the input to the
output.
Inputs Features in a supported format. Shapefiles, GML, HOB, and 000
(S-57 specification) are supported. Note that Shapefiles must be
in CARIS Shapefile Format and use a recognized Shapefile
Coordinate Reference System (CRS).
Outputs Features in HOB format. If a HOB file does not exist, a new one
is created.
Command Line Syntax carisbatch --run AddFeatures [options] <inputs> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--keep-foid k If set, the feature object identifiers (FOIDS) of the input FALSE This option is ignored
are used for the output features when they are unique in if the input is in GML
the output. New FOIDs are always assigned when new or Shapefile format.
features are generated from composite features such as
sounding groups.
When not set, new FOIDs are assigned.
--require-all q If set, the process is cancelled if any of the features FALSE
cannot be added.
--feature- F A string specifying the name of the catalogue that FALSE This must be
catalogue defines the features and attributes in a vector dataset. specified specifically.
One of { list dynamically populated from the catalogue
control file }.
The names of the available catalogues can be accessed
through application via the Object Catalogue
environment variable in Tools > Options. The available
catalogues are controlled by the Catalogue Control file.
An example of a catalogue name is "S-57 ENC 3.1".

16 CARIS Batch Utilities Reference Guide

Feature Editing Processes: Add Features

Example To use this command refer to the following example.

Example

Objective You want to add features to an existing map.

Description Command Line Syntax

Existing FOIDs in the inputs are applied to the output, when possible. --keep-foid
The process will be cancelled if any of the features cannot be added. --require-all
The S-57 ENC 3.1 feature catalogue will be used to add the features --feature-catalogue "S-57 ENC 3.1"
to the output file.
The input file is named Surface10.hob and located at D:\BatchSample\Surface10.hob
D:\BatchSample.
The output file is named AddFeatures.hob and located at D:\BatchSample\AddFeatures.hob
D:\BatchSample.
carisbatch --run AddFeatures --keep-foid --require-all --feature-
Command Line catalogue "S-57 ENC 3.1" D:\BatchSample\Surface10.hob
D:\BatchSample\AddFeatures.hob

Outcome The features in the source file are added to the existing content of the output file.

Extra Notes N/A

CARIS Batch Utilities Reference Guide 17

Feature Editing Processes: Change Feature Attributes

Change Feature Attributes

Description The ChangeFeatureAttributes process modifies all features with
the specified attribute(s) in the input.
Inputs Features in a supported format. HOB and 000 (S-57
specification) are supported.
Outputs Features in HOB format.
Command Line Syntax carisbatch --run ChangeFeatureAttributes --attribute
<acronym> <value> --feature-catalogue <value> [options]
<input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--feature- F A string specifying the name of the catalogue that defines FALSE This must be
catalogue the features and attributes in a vector dataset. One of { list specified for
dynamically populated from the catalogue control file }. HOB input.
The names of the available catalogues can be accessed
through application via the Object Catalogue environment
variable in Tools > Options. The available catalogues are
controlled by the Catalogue Control file. An example of a
catalogue name is "S-57 ENC 3.1".
--attribute a The acronym and new value for a feature attribute. TRUE
<Acronym> - A string specifying the acronym of the attribute.
<Value> - A string specifying the attribute value. One of
{CARIS:UNKNOWN, CARIS:NONE or an actual value}.
• CARIS:UNKNOWN: Unknown - The attribute
requires a value but the value is unknown.
• CARIS:NONE: None - The attribute does not have a
value.
The specified acronym must be present in the specified
FeatureCatalogue. The Acronym must exist as a feature
attribute in the input. The value must be valid for the
specified FeatureCatalogue.
Enumerated and list type attributes will be given by
numerical code. For example, with the default S-57 ENC 3.1
catalogue, enter COLOUR 7 to set grey as the colour of all
features with the COLOUR attribute. To set multiple
attributes, use commas as separators, e.g. CATFOG 3,6,10.
Dates and times are specified in the standard ISO
8601:1988 format. Depending on the specific attribute, the
following formats for dates may be supported:
YYYY-MM-DD, YYYY-MM, YYYY, --MM-DD, --MM. Times
are always reported in UTC in the format
YYYY-MM-DDTHH:MM:SS. See ISO 8601:1988
documentation for more information.

18 CARIS Batch Utilities Reference Guide

Feature Editing Processes: Change Feature Attributes

Example To use this command refer to the following example.

Example

You want to change all coverage features in a given source to be hole type; any coverage
Objective
features that should not be updated have been filtered out of the input as a precursor step.

Description Command Line Syntax

The input has features and attributes defined in the S-57 ENC 3.1 --feature-catalogue "S-57 ENC 3.1"
feature catalogue.
The cvgtyp attribute will be changed from boundary type (0) to hole --attribute cvgtyp 1
type (1).
The input file is named CVRAGE_Type_Boundary.hob and located at D:\BatchSample\CVRAGE_Type_Bound
D:\BatchSample. ary.hob
The output file will be named CVRAGE_Type_Hole.hob and located D:\BatchSample\CVRAGE_Type_Hole.h
at D:\BatchSample. ob
carisbatch --run ChangeFeatureAttributes --feature-catalogue "S-57
Command Line ENC 3.1" --attribute cvgtyp 1 D:\BatchSample\CVRAGE_Type_Boundary.hob
D:\BatchSample\CVRAGE_Type_Hole.hob
A new HOB map is created containing hole-type coverage features; any other features with a
Outcome
cvgtyp attribute would also be affected. All other features are copied over unchanged.

Extra Notes N/A

CARIS Batch Utilities Reference Guide 19

Feature Editing Processes: Clip Features

Clip Features
Description The ClipFeatures process removes the portions of the input
features that are outside the boundaries of a specified clipper. A
clipper is defined by one or more polygons.
This process is intended to work with a clipper having edges that
follow constant latitude or longitude - that is, edges that are
aligned with the X/Y axis of the data.
Inputs Features in a supported format. HOB and 000 (S-57
specification) are supported.
Outputs Features in HOB format.
Command Line Syntax carisbatch --run ClipFeatures --feature-catalogue <value>
--clipper <value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--feature- F A string specifying the name of the catalogue that FALSE This must be
catalogue defines the features and attributes in a vector specified for HOB
dataset. One of { list dynamically populated from the input.
catalogue control file }.
The names of the available catalogues can be
accessed through application via the Object
Catalogue environment variable in Tools > Options.
The available catalogues are controlled by the
Catalogue Control file. An example of a catalogue
name is "S-57 ENC 3.1".
--clipper C The path to the file containing the polygons to use FALSE This must be
for clipping. specified explicitly.
Currently the clipper may be represented by one or
more area features in a specified HOB or 000 (S-57
specification) file.
Clipper area objects can also include interior
boundaries. The interior boundaries will affect how
features are clipped - the parts of features inside the
interior boundaries will be removed as well as the
parts of features outside the exterior boundary.
If an empty file is specified, it will be interpreted as
"no clipping required" and the output will contain all
features in the input.
Lines and points in the given file will be ignored.

20 CARIS Batch Utilities Reference Guide

Feature Editing Processes: Clip Features

Parameter

Can Notes
Long Short Description
Repeat

--mark-closing- c If set, marks closing edges, as required by S-57, to FALSE

edges indicate that area features have been truncated by
the data limit.
Edges are added to areas that are trimmed by the
process to create closed areas. Flagging an added
edge as closing indicates that the edge represents a
dataset limit, such as an S-57 cell border. If the
removal of the data is part of a multi-stage
replacement operation, the closing flag should not
be set as these edges will not be closing edges after
the new data is added.
Edges marked as closing are masked and not
symbolized when the area boundary is being drawn.

Example To use this command refer to the following example.

Example

Objective You want to apply clipping to features in a dataset.

Description Command Line Syntax

The output layer is using the S-57 ENC 3.1 catalogue. --feature-catalogue "S-57 ENC 3.1"
The file containing the clipper polygons is named Clipper.hob and can --clipper D:\BatchSample\Clipper.hob
be found in the BatchSample folder on the D: drive.
Closing edges are to be flagged. --mark-closing-edges
The input file is named InputFeatures.hob and is in the BatchSample D:\BatchSample\InputFeatures.hob
folder on the D: drive.
The output file will be named ClippedFeatures.hob and will be created D:\BatchSample\ClippedFeatures.hob
in the source directory.
carisbatch --run ClipFeatures --feature-catalogue "S-57 ENC 3.1" --
Command Line clipper D:\BatchSample\Clipper.hob --mark-closing-edges
D:\BatchSample\InputFeatures.hob D:\BatchSample\ClippedFeatures.hob
The polygon features in the clipper file are applied to the source data and the clipped features
Outcome
are saved to the new hob file in the specified location.

Extra Notes

CARIS Batch Utilities Reference Guide 21

Feature Editing Processes: Export Features to Shapefile

Export Features to Shapefile

Description The ExportFeaturesToShapefile process exports features to files
in Shapefile format.
Inputs Features in a supported format. HOB and 000 (S-57
specification) are supported.
Outputs A folder where files in Shapefile format will be exported. One
Shapefile will be created for each distinct feature class and
primitive type (line, point, area, etc.) found in the input.
Command Line Syntax carisbatch --run ExportFeaturesToShapefile --feature-catalogue
<value> <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

Example To use this command refer to the following example.

Example

Objective You want to export a HOB file to the Shapefile format.

Description Command Line Syntax

The input has features and attributes defined in the S-57 ENC 3.1 --feature-catalogue "S-57 ENC 3.1"
feature catalogue.
The input HOB file is named polygon.hob and located at D:\BatchSample\polygon.hob
D:\BatchSample.
The output files will be placed in a pre-existing folder called D:\BatchSample\FeatureToShape
FeatureToShape located at D:\BatchSample.
carisbatch --run ExportFeaturesToShapefile --feature-catalogue "S-57
Command Line
ENC 3.1" D:\BatchSample\polygon.hob D:\BatchSample\FeatureToShape

Outcome A shapefile for each of the feature types in the input HOB is created in the designated folder.

Extra Notes N/A

22 CARIS Batch Utilities Reference Guide

Feature Editing Processes: Export to WKT

Export to WKT
Description The ExportToWKT process exports the geometries of features to a
file in Well-Known Text (WKT) format.
Inputs Features in a supported format. HOB and 000 (S-57
specification) are supported.
Outputs Geometries in WKT format.
Command Line Syntax carisbatch --run ExportToWKT [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--feature- F A string specifying the name of the catalogue that FALSE This must be
catalogue defines the features and attributes in a vector dataset. specified for
One of { list dynamically populated from the catalogue HOB input.
control file }.
The names of the available catalogues can be accessed
through application via the Object Catalogue
environment variable in Tools > Options. The available
catalogues are controlled by the Catalogue Control file.
An example of a catalogue name is "S-57 ENC 3.1".

Example To use this command refer to the following example.

Example

Objective You want to export geometry from a HOB file to the WKT format.

Description Command Line Syntax

The input has features and attributes defined in the S-57 ENC 3.1 --feature-catalogue "S-57 ENC 3.1"
feature catalogue.
The input HOB file is named polygon.hob and located at D:\BatchSample\polygon.hob
D:\BatchSample.
The output file will be named ExportToWKT.wkt and located at D:\BatchSample\ExportToWKT.wkt
D:\BatchSample.
carisbatch --run ExportToWKT --feature-catalogue "S-57 ENC 3.1"
Command Line
D:\BatchSample\polygon.hob D:\BatchSample\ExportToWKT.wkt

Outcome A new WKT file is generated.

Extra Notes N/A

CARIS Batch Utilities Reference Guide 23

Feature Editing Processes: Filter Features

Filter Features
Description The FilterFeatures process copies features that pass the criteria
in a rule file from the input to the output.
Inputs Features in a supported format. HOB and 000 (S-57
specification) are supported.
Outputs Features in HOB format.
Command Line Syntax carisbatch --run FilterFeatures --feature-catalogue <value> --
rule-file <value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--feature- F A string specifying the name of the catalogue that defines the FALSE This must be
catalogue features and attributes in a vector dataset. One of { list specified for
dynamically populated from the catalogue control file }. HOB input.
The names of the available catalogues can be accessed
through application via the Object Catalogue environment
variable in Tools > Options. The available catalogues are
controlled by the Catalogue Control file. An example of a
catalogue name is "S-57 ENC 3.1".
--rule-file U The path to the CRFX file containing rules for the selection FALSE This must be
filter. specified
The CRFX file must be one created for selection. Other CRFX explicitly.
files, such as ones to perform deconfliction in
CombineToRaster process, cannot be used for this purpose.
Rules that are not valid for the input are skipped without error.

24 CARIS Batch Utilities Reference Guide

Feature Editing Processes: Filter Features

Example To use this command refer to the following example.

Example

Objective You want to create a filtered selection of features.

Description Command Line Syntax

The input has features and attributes defined in the S-57 ENC 3.1 --feature-catalogue "S-57 ENC 3.1"
feature catalogue.
The rule file is named Filter.crfx and located at D:\BatchSample. --rule-file D:\BatchSample\Filter.crfx
The input file is named Surface10.hob and located at D:\BatchSample\Surface10.hob
D:\BatchSample.
The output file will be named FilterFeatures.hob and located at D:\BatchSample\FilterFeatures.hob
D:\BatchSample.
carisbatch --run FilterFeatures --feature-catalogue "S-57 ENC 3.1"
Command Line --rule-file D:\BatchSample\Filter.crfx D:\BatchSample\Surface10.hob
D:\BatchSample\FilterFeatures.hob

Outcome A new HOB file is created from a filtered subset of the input HOB.

Extra Notes N/A

CARIS Batch Utilities Reference Guide 25

Feature Editing Processes: Simplify Features

Simplify Features
Description The SimplifyFeatures process removes vertices to create simpler
features by applying the Douglas-Peucker algorithm.
Inputs Features in a supported format. HOB and 000 (S-57
specification) are supported.
Outputs Features in HOB format.
Command Line Syntax carisbatch --run SimplifyFeatures --feature-catalogue <value> --
tolerance <value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--feature- F A string specifying the name of the catalogue that defines FALSE This must be
catalogue the features and attributes in a vector dataset. One of specified for HOB
{list dynamically populated from the catalogue control input.
file}.
The names of the available catalogues can be accessed
through application via the Object Catalogue
environment variable in Tools > Options. The available
catalogues are controlled by the Catalogue Control file.
An example of a catalogue name is "S-57 ENC 3.1".
--tolerance T A number and unit specifying the distance that individual FALSE This must be
vertices can be moved when simplifying features. specified explicitly.
Trend lines are used between different vertices along
each feature. If any vertices in the input are farther than
the tolerance from the trend line, more trend lines are
applied over smaller portions of the feature. This process
is repeated until no input vertices are farther than the
tolerance from the set of trend lines. The trend lines are
then used as the output feature.
A tolerance of 0m results in only collinear vertices being
removed. Any larger tolerance value may change the
geometry of the input features.
--scale s A number specifying the scaling to apply to the tolerance FALSE
(1:scale).
The default scale value is 1, such that the tolerance
represents a distance on the ground; the tolerance would
then be a value like 0.5m.
A scale of 1000 would mean that the tolerance
represents a distance on a map at 1:1000 scale; the
tolerance would then be a value like 1mm.

26 CARIS Batch Utilities Reference Guide

Feature Editing Processes: Simplify Features

Example To use this command refer to the following example.

Example

Objective You want to reduce the number of vertices in a line feature.

Description Command Line Syntax

The S-57 ENC 3.1 catalogue is to be used. --feature-catalogue "S-57 ENC 3.1"
Vertices can be no more than 5m from a trend line. --tolerance 5m
The data source is named LineFeatures.hob and is located in the D:\BatchSample\LineFeatures.hob
BatchSample directory, on the D drive.
The simplified line will be saved to SimpliedFeatures.hob in the D:\BatchSample\SimplifiedFeatures.hob
source data location.
carisbatch --run SimplifyFeatures --feature-catalogue "S-57 ENC 3.1"
Command Line --tolerance 5m D:\BatchSample\LineFeatures.hob
D:\BatchSample\SimplifiedFeatures.hob

Outcome A new HOB file is created containing the simplified line feature.

Extra Notes N/A

CARIS Batch Utilities Reference Guide 27

Feature Editing Processes: Smooth Features

Smooth Features
Description The SmoothFeatures process adds vertices to features by applying
a B-spline function.
Inputs Features in a supported format. HOB and 000 (S-57
specification) are supported.
Outputs Features in HOB format.
Command Line Syntax carisbatch --run SmoothFeatures --feature-catalogue <value> --
b-spline-order <value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

Example To use this command refer to the following example.

Example

Objective Contours have been generated and now need to be smoothed.

Description Command Line Syntax

The Bathy DataBASE catalogue is to be used. --feature-catalogue "Bathy DataBASE"

Smoothing is to be applied to a degree of 6. --b-spline-order 6
The data source is named ContourFeatures.hob and is located in the D:\BatchSample\ContourFeatures.hob
BatchSample directory, on the D drive.
The smoothed contours will be saved to a new file named D:\BatchSample\SmoothedContours.hob
SmoothedContours.hob in the data source location.
carisbatch --run SmoothFeatures --feature-catalogue "Bathy DataBASE"
Command Line --b-spline-order 6 D:\BatchSample\ContourFeatures.hob
D:\BatchSample\SmoothedContours.hob

Outcome A new HOB file is created containing the new smoothed contour features.

Extra Notes N/A

28 CARIS Batch Utilities Reference Guide

BASE Editor Processes
3
This chapter describes the processes available for the CARIS Batch
command line tool in BASE Editor™.
BASE Editor Processes:

The following processes are available in the BASE Editor

module.

• ADD SMOOTHED BAND • GENERALIZE RASTER

• ADD TO RASTER COMBINE • GRID POINTS
• ADD TO VR SURFACE • IMPORT POINTS
• CLASSIFY RASTER HOLIDAYS • IMPORT VR SURFACE
• CLIP RASTER • JOIN POINTS
• COMBINE TO RASTER • POPULATE VR SURFACE
• CONTOUR RASTER • REBALANCE POINTS
• COPY TO CSAR • REMOVE FROM VR SURFACE
• CREATE SOUNDINGS FROM • RENDER RASTER
COVERAGE
• CREATE VR SURFACE • REPAIR COVERAGE
• DESCRIBE RASTER PRODUCT • RESAMPLE SURFACE TO RASTER
• DIFFERENCE COVERAGES • SERVER ADD TO RASTER COMBINE
• EXPORT COVERAGE METADATA • SERVER COMBINE TO RASTER
• EXPORT COVERAGE TO ASCII • SERVER JOIN POINTS
• EXPORT POINTS • SHIFT ELEVATION BANDS
• EXPORT RASTER • SMOOTH FEATURES BY DIRECTION
BIAS
• EXPORT RASTER TO STL • THIN POINTS
• EXPORT VR SURFACE TO BAG • TILE RASTER
• EXTRACT COVERAGE • UPDATE VR CUBE DISAMBIGUATION
• FILL RASTER HOLIDAYS • VECTORIZE RASTER
• FILTER COVERAGE • WARP POINTS
• FINALIZE RASTER • WARP RASTER
• FINALIZE VR SURFACE

30 CARIS Batch Utility Reference Guide

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>

Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

Common Options

--method The algoithm applied to produce smoothed elevation FALSE

values.
• LAPLACIAN: Applies 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.
--input-band i A string specifying the name of the input raster band that FALSE This must be
will be classified. specified explicitly.
This must be an elevation band.
--smoothed- A string specifying the name of the output band. FALSE This must be
band If an existing band is specified, values in that band are specified explicitly.
overwritten.

Method = LAPLACIAN Options

--iterations The number of times the local averaging porcess is FALSE

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.

CARIS Batch Utility Reference Guide 31

BASE Editor Processes: Add Smoothed Band

Parameter

Can Notes
Long Short Description
Repeat

Method = EXPAND_SHOALS Options

--radius- The type of radius used for smoothing. FALSE

type • 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.
--radius A number and unit specifying the fixed distance FALSE
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.
--multiplier A number specifying the resolution multiplier component FALSE
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.
--dropoff- A negative number specifying the steepest allowed slope FALSE
slope around shoals.
The default value is -0.125. Values are unitless as they
represent depth value decrease per unit of distance.

To use this command, refer to the following examples.

Example: Expand
Shoals Smoothing

Example

You want to apply smoothing to a surface, expanding the size of shoals with a more gradual
Objective
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 --smoothed-band DepthSmoothed
DepthSmoothed.
A hybrid radius will be used for the smoothing. --radius-type HYBRID
The radius distance is 5m. --radius 5m

32 CARIS Batch Utility Reference Guide

BASE Editor Processes: Add Smoothed Band

Example

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\SmoothSurface.csar
D:\BatchSample directory.
carisbatch --run AddSmoothedBand --method EXPAND_SHOALS --input-band
Depth --smoothed-band DepthSmoothed --radius-type HYBRID --radius 5m
Command Line
--multiplier 4 --dropoff-slope -0.25
D:\BatchSample\SmoothSurface.csar
A new DepthSmoothed band is added to the input surface containing the smoothed elevation
Outcome
values.

Extra Notes N/A

Example: Laplacian
Smoothing

Example

You want to apply smoothing to a surface to elimate unnecessarily deep points and achieve a
Objective
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 --smoothed-band DepthSmoothed
DepthSmoothed.
The algorithm should be applied 30 times. --iterations 30
Smoothing will be applied to the LaplacianSurface.csar coverage in D:\BatchSample\LaplacianSurface.csar
the D:\BatchSample directory.
carisbatch --run AddSmoothedBand --method LAPLACIAN --input-band
Command Line Depth --smoothed-band DepthSmoothed --iterations 30
D:\BatchSample\LaplacianSurface.csar
A new DepthSmoothed band is added to the input surface containing the smoothed elevation
Outcome
values.

Extra Notes N/A

CARIS Batch Utility Reference Guide 33

BASE Editor Processes: Add to Raster Combine

Add to Raster Combine

Description The AddToRasterCombine process adds sources to an existing
combined raster using the combine process parameters stored in
the CSAR metadata. This produces the same result as doing the
original combine with all of the sources.
Inputs The first input must be a CSAR raster surface that was
generated by a local combine process. The second input is one or
more raster surfaces, point clouds and/or variable resolution
surfaces. The second input can include specific named files
and/or folder locations with a wildcard, for example, D:\*.csar.
Datasets that were previously considered for the first input
cannot be specified a second time. The locations can be specified
by file paths or URIs.
Outputs A CSAR raster surface.
Command Line Syntax carisbatch --run AddToRasterCombine [option] <inputs>
<output>
Options The following table describes the parameter available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--recurse u If set, files that match the input description in any FALSE
subfolders are also included.

Example To use this command refer to the following example.

Example

Objective You want to add a source to an existing combined raster.

Description Command Line Syntax

The first input is a raster combine surface named Combined.csar D:\BatchSample\Combined.csar

located at D:\BatchSample.
The newer source raster surface, NewSurface.csar, located at D:\BatchSample\NewSurface.csar
D:\BatchSample, will be added to the existing combine surface.
The output surface will be named UpdatedRaster.csar and saved to D:\BatchSample\UpdatedRaster.csar
the same location as the source files.
carisbatch --run AddToRasterCombine D:\BatchSample\Combined.csar
Command Line
D:\BatchSample\NewSurface.csar D:\BatchSample\UpdatedRaster.csar

Outcome A new combined surface is created in the specified location.

The process results in a new output combined surface whether or not the incorporation of the
Extra Notes
new sources resulted in any new node band values.

34 CARIS Batch Utility Reference Guide

BASE Editor Processes: Add to VR Surface

Add to VR Surface
Description The AddToVRSurface process adds source points to an existing
variable resolution surface using the create process parameters
stored 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 AddToVRSurface [options] <inputs> <update>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--update-type The type of operation to update with new data. FALSE

• RESOLUTION: Update resolution estimates
• SURFACE: Update surface nodes
• BOTH: Update both resolution estimates and surface
nodes.
The default value is BOTH.

Example To use this command refer to the following example.

Example

Objective To add a new dataset to an existing variable resolution surface.

Description Command Line Syntax

Only the surface nodes require updating. --update-type SURFACE

The new HDCS data is referenced by the HIPS project file file:///D:/BatchSample/input/
D:\BatchSample\input\input.hips and was collected by the input.hips?Vessel=SampleVessel;Day=2
SampleVessel vessel on the first day in 2000. 000-001
The new data will be added to VRSurface.csar located at D:\BatchSample\VRSurface.csar
D:\BatchSample.
carisbatch --run AddToVRSurface --update-type SURFACE file:///D:/
Command Line BatchSample/input/input.hips?Vessel=SampleVessel;Day=2000-001
D:\BatchSample\VRSurface.csar

Outcome The existing VR surface is updated to include the new data.

Extra Notes N/A

CARIS Batch Utility Reference Guide 35

BASE Editor Processes: Classify Raster Holidays

Classify Raster Holidays

Description The ClassifyRasterHolidays process assigns each cell in a raster
band as valid data, no data or an interior holiday (hole).
Inputs A raster dataset. The raster must be editable.
Outputs No output is generated. The input raster is modified. A new
band called <InputBand> and Holidays is added.
Command Line Syntax carisbatch --run ClassifyRasterHolidays --input-band <value>
[options] <input>

Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--input-band i A string specifying the name of the input raster band that FALSE This must be
will be classified. specified explicitly.
--classify- y If set, cells outside will be classified as NO-DATA. FALSE
no-data With this option set, every cell inside the raster surface
extents is classified. By default, only the cells inside the
outer boundary of the data in the band are classified.

Example To use this command refer to the following example.

Example

You want to classify every cell within the raster surface as being data, or part of a holiday or
Objective
part of an exterior no data area.

Description Command Line Syntax

Holidays will be classified for the Depth band. --input-band Depth

Exterior no-data values will be populated. --classify-no-data
The source surface, Surface1.csar, is located at D:\BatchSample\Surface1.csar
D:\BatchSample\Surface1.csar.
carisbatch --run ClassifyRasterHolidays --input-band Depth
Command Line --classify-no-data D:\BatchSample\Surface1.csar
D:\BatchSample\Surface12.csar

Outcome A new "Depth and Holidays" band will be created in the raster surface.

Extra Notes N/A

36 CARIS Batch Utility Reference Guide

BASE Editor Processes: Clip Raster

Clip Raster
Description The ClipRaster process exports a defined portion of the input
file.
Inputs A raster dataset. A BDB Server URI can be specified as input.
Outputs A raster in CSAR format.
Command Line Syntax carisbatch --run ClipRaster --extent <value> <input> <output>
Options The following table describes the parameter available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--extent E The extents that define the window. FALSE This must be
<LowerX> - A number specifying the lower left X origin in the specified
coordinate reference system of the output. explicitly.

<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
unprojected data, an angle type unit is required. The order for
unprojected 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.

Example To use this command refer to the following example.

Example

Objective You want to clip a raster in order to export only a portion of the source data.

Description Command Line Syntax

The extents to be included in the new surface are: --extent 417941.63m 5579318.66m
lower-left X: 417941.63 418041.63m 5579418.66m

lower-left Y: 5579318.66
upper-right X: 418041.63
upper-right Y: 5579418.66
The source surface, Surface1.csar is located at D:\BatchSample. D:\BatchSample\Surface1.csar
The output surface will be named Clipped and will be saved to the D:\BatchSample\Clipped.csar
same location as the source file.

Command carisbatch --run ClipRaster --extent 417941.63m 5579318.66m 418041.63m

Line 5579418.66m D:\BatchSample\Surface1.csar D:\BatchSample\Clipped.csar

CARIS Batch Utility Reference Guide 37

BASE Editor Processes: Clip Raster

Example

Outcome A new clipped raster with the specified name will be created in the specified location.

Notes N/A

38 CARIS Batch Utility Reference Guide

BASE Editor Processes: Combine to Raster

Combine to Raster
Description The CombineToRaster process creates a new raster by computing
the value in each raster cell using a logical operation executed
over the points falling within each raster cell. The output raster
is generated with user-specified geographic extents and
resolution.
Inputs Two or more raster surfaces, point clouds and/or variable
resolution surfaces. The locations can be specified by file paths
or URIs.
Outputs A raster surface in CSAR format. The location can be specified
by a file path or a URI.
Command Line Syntax carisbatch --run CombineToRaster --extent <value> --resolution
<value> --output-crs <value> --contributor-attribute <value>
[options] <inputs> <output>

Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--recompute- s If set, values in statistical bands present in the output are FALSE
stats recomputed.
The bands that are recomputed are Density, Mean,
Standard Deviation, Shoal and Deep.
--rule-file U The path to the CRFX file containing rules for conflict FALSE
resolution.
The CRFX file must be one created for deconfliction in the
combine dialog box. Other CRFX files, such as ones to
perform queries on a database, cannot be used for this
purpose.
--override- a If set, the first input point that meets all criteria in the rules is FALSE
ambiguity selected to populate the output cell, even if there are
unresolved conflicts.
--confine- f A string specifying how to consider holes as valid data when FALSE
metadata- applying metadata rules. One of:
rules • POLYGON: Based on bounding polygon
• HOLIDAY: Based on holiday band
If not specified, holes are not considered as valid data when
applying metadata rules.
--recurse u If set, files that match the input description in any subfolders FALSE
are also included.
--use-cell- n If set, the input raster cell centre is used as the position for FALSE
centres the input raster cell.
If this option is specified, true position information in the
input raster surfaces is ignored.

CARIS Batch Utility Reference Guide 39

BASE Editor Processes: Combine to Raster

Parameter

Can Notes
Long Short Description
Repeat

--contributor- C A string specifying an attribute value to be included in the TRUE

attribute Contributor layer.
The Contributor for each node is populated with a list of the
local CSAR metadata values from the source that is
selected to be copied to the output raster surface.
The default value is uri.
--resolution R A number and unit specifying the resolution of the output FALSE This must be
raster. specified
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, explicitly.
mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.
--extent E The extents that define the window. FALSE This must be
<LowerX> - A number specifying the lower left X origin in specified
the coordinate reference system of the output. explicitly.

<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 unprojected data, an angle type unit is
required. The order for unprojected 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.
--polygon- Y A string specifying the type of bounding polygon to FALSE
type generate. One of:
• CONVEX: The convex hull of the data is used for the
polygon.
• BUFFERED: A simplified buffered boundary is used
for the polygon.
The default value is BUFFERED.
--primary- m A string specifying the name of the primary elevation band FALSE
band of the output.
The default value is Depth.
--output-crs c A string specifying the horizontal coordinate reference FALSE This must be
system key of the output. specified
explicitly.
--comments General comments to be added to the coverage metadata FALSE
The default value is an empty string.

40 CARIS Batch Utility Reference Guide

BASE Editor Processes: Combine to Raster

Example To use this command refer to the following example.

Example

Objective You want to combine two raster surfaces into a single raster surface.

Description Command Line Syntax

The output coordinate system is UTM-30N. --output-crs UTM-30N

The resolution of the output surface will be 10 metres. --resolution 10m
The primary elevation band will be labelled Depth. --primary-band Depth
Statistical layers will be recomputed. --recompute-stats
The extents to be included are: --extent 416379.84 5576029.18
• lower-left X: 416379.84 420200.16 5580327.82
• lower-left Y: 5576029.18
• upper-right X: 420200.16
• upper-right Y: 5580327.82
The file, combine_rules.crfx, located at D:\BatchSample, will be used --rule-file
for conflict resolution. D:\BatchSample\combine_rules.crfx
The source surfaces to be combined are Surface1.csar and D:\BatchSample\Surface1.csar
Surface2.csar located at D:\BatchSample. D:\BatchSample\Surface2.csar
The output surface will be named Combined.csar, and saved to the D:\BatchSample\Combined.csar
same location as the source files.
carisbatch --run CombineToRaster --output-crs UTM-30N --resolution
10m --primary-band Depth --recompute-stats --extent 416379.84
Command Line 5576029.18 420200.16 5580327.82 --rule-file
D:\BatchSample\combine_rules.crfx D:\BatchSample\Surface1.csar
D:\BatchSample\Surface2.csar D:\BatchSample\Combined.csar

Outcome A new, combined raster surface is created.

Extra Notes N/A

CARIS Batch Utility Reference Guide 41

BASE Editor Processes: Contour Raster

Contour Raster
Description The ContourRaster process generates isolines to mark areas of
constant value.
Inputs A raster or variable resolution surface dataset.
Outputs A vector file in the specified output format.
Command Line Syntax carisbatch --run ContourRaster --output-format <value> --input-
band <value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Example 1:

Example

Objective You want to create contour lines and depth areas based on a raster surface

Description Command Line Syntax

The band to be contoured is Depth. --input-band Depth

The output format is HOB. --output-format HOB
The feature catalogue name is S-57 ENC 3.1 --feature-catalogue "S-57 ENC 3.1"
The contour feature is DEPCNT. --contour-feature DEPCNT
The level attribute is VALDCO. --level-attribute VALDCO
The data will be contoured between a lower boundary of -100 metres, --range -100m 0m 20m
an upper boundary of 0 metres, with a contour interval of 20 metres
An extra contour level is at a depth of 10m. --level -10m
The polygon feature for the depth areas is DEPARE. The attributes for --polygon-feature DEPARE DRVAL1
the minimum and maximum values of the polygons are DRVAL1 and DRVAL2
DRVAL2, respectively.
The input file is named Surface1.csar and is found in D:\BatchSample\Surface1.csar
D:\BatchSample.

44 CARIS Batch Utility Reference Guide

BASE Editor Processes: Contour Raster

Example

The resulting contour lines will be saved to Contours.hob in the same D:\BatchSample\Contours.hob
location as the source data.
carisbatch -r ContourRaster --input-band Depth --output-format HOB --
feature-catalogue "S-57 ENC 3.1" --contour-feature DEPCNT --level-
Command Line attribute VALDCO --range -100m 0m 20m --level 10m --polygon-feature
DEPARE DRVAL1 DRVAL2 D:\BatchSample\Surface1.csar
D:\BatchSample\Contours.hob
A HOB file, containing the contour lines and depth areas generated by the process, is
Outcome created. Depending on the data, contours are created at depths of 10, 20, 40, 60, 80 and 100
metres

Extra Notes One of either level or range must be specified for the process to run.

Example 2:

Example

Objective You want to create contour lines for a SIPS mosaic.

Description Command Line Syntax

The band to be contoured is Intensity. --input-band Intensity

The output format is HOB. --output-format HOB
The feature catalogue name is Bathy DataBASE. --feature-catalogue "Bathy DataBASE"
The contour feature is isolne. --contour-feature isolne
The level attribute is isoval. --level-attribute isoval
Contours will be created for data at 7dB. --level 7dB
The input file is named SIPS_Mosaic.csar and is found in D:\BatchSample\SIPS_Mosaic.csar
D:\BatchSample.
The resulting contour lines will be saved to SIPS_Contours.hob in the D:\BatchSample\SIPS_Contours.hob
same location as the source data.
carisbatch -r ContourRaster --input-band Intensity --output-format
HOB --feature-catalogue "Bathy DataBASE" --contour-feature isolne --
Command Line
level-attribute isoval --level 7dB D:\BatchSample\SIPS_Mosaic.csar
D:\BatchSample\SIPS_Contours.hob

Outcome A HOB file, containing the contour lines generated by the process, is created.

Extra Notes One of either level or range must be specified for the process to run.

CARIS Batch Utility Reference Guide 45

BASE Editor Processes: Copy to CSAR

Copy to CSAR
Description The CopyToCSAR process copies a raster or point cloud in a
supported format to CSAR format. This operation reorders the
data in the file and removes empty blocks when applicable.
Inputs A point cloud, raster surface or raster image in a supported
format. Certain coordinate reference systems cannot be written
out to CSAR, so BSB and HCRF formats are not supported. A
BDB Server URI can be specified as input.
Outputs A coverage in CSAR format.
Command Line Syntax carisbatch --run CopyToCSAR [options] <input> <output>
Options N/A

Example To use this command refer to the following example.

Example

Objective Copy a point cloud to a CSAR format.

Description Command Line Syntax

The source point cloud, Cloud1.csar, is located at D:\BatchSample. D:\BatchSample\Cloud1.csar

The output CSAR file will be named Copied.csar, and will be saved D:\BatchSample\Copied.csar
to the same location as the input source file.

Command carisbatch --run CopyToCSAR D:\BatchSample\Cloud1.csar

Line D:\BatchSample\Copied.csar

Outcome A new surface, with the specified name, is created in the specified location.

Extra Notes N/A

46 CARIS Batch Utility Reference Guide

BASE Editor Processes: Create Soundings from Coverage

Create Soundings from Coverage

Description The CreateSoundingsFromCoverage process creates sounding
features for a subset of the nodes in a coverage.
Inputs A raster surface or point cloud in a supported format.
Outputs Sounding features in HOB format.
Command Line Syntax carisbatch --run CreateSoundingsFromCoverage --minimum-
distance <value> --input-band <value> --feature-catalogue
<value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--input-band i A string specifying the name of the input band. FALSE This must be
The input band can be any elevation band. specified explicitly.

--minimum- d The minimum distance between sounding features in TRUE

distance the output, in areas of the input with values in the
specified band.
<Radius> - A number and unit specifying the minimum
distance between sounding features.
<MinValue> - A number and unit specifying the
minimum value of the input band to apply this distance.
<MaxValue> - A number and unit specifying the
maximum value of the input band to apply this distance.
At least one radius must be specified.
If CARIS:NONE is used as the <MinValue>, the
minimum value of the data is used. Similarly, if
CARIS:NONE is used as the <MaxValue>, the
maximum value of the data is used.
All values representing elevations are entered using the
convention that up is positive.
The unit must be specified, unless the input band is a
unitless band. Supported units: cable, ch, cm, fm, ft, in,
inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd,
yd, deg and rad.
--scale s A number specifying the scaling to apply to the radius FALSE
(1:scale).
The default scale value is 1, such that the radius
represents the minimum distance between features on
the ground; the radius would then be a value like 5m.
A scale of 1000 would mean that the radius represents
the minimum distance between features on a map at
1:1000 scale; the radius would then be a value like
10mm.

CARIS Batch Utility Reference Guide 47

BASE Editor Processes: Create Soundings from Coverage

Parameter

Can Notes
Long Short Description
Repeat

--selection- B A string specifying how to select which node values are FALSE This must be
bias chosen for the sounding features. specified explicity.
• MIN: Use the minimum node value.
• MAX: Use the maximum node value.
All values representing elevations are considered using
the convention that up is positive.
--apply- a If set, designated soundings from the source of the input FALSE
designated are applied to the output.
--feature- F A string specifying the name of the catalogue that FALSE This must be
catalogue defines the SOUNDG feature and attributes in the specified explicitly.
output dataset. One of { list dynamically populated from
the catalogue control file }.
The catalogue must be in the catalogue control file
specified in Tools > Options > Files and Folders > Files
> Catalogue Control, for example S-57 ENC 3.1. The
default location of the CatalogueControl.xml file is
C:\Program Files\CARIS\<application>\<version>\
system\.
--mapping-file M The path to a file containing rules used to map band FALSE
values to sounding feature attributes.
A mapping file, with BSST extension, can be created in
the application by running the Sounding Selection
command.

Example To use this command refer to the following example.

Example

Objective Create a subset of soundings on a feature layer using data from an existing coverage.

Description Command Line Syntax

The Depth band of the input coverage contains the source elevation --input-band Depth
values.
A radius of 10mm at map scale is to be used to avoid overlapping --minimum-distance 10mm CARIS:NONE
soundings in the output. CARIS:NONE
The selection radius is using a map scale of 1:1000. --scale 1000
The minimum depth values are to be used in areas of conflict. --selection-bias MIN
Designated soundings should be maintained in the output. --apply-designated
The output layer is using the S-57 ENC 3.1 catalogue. --feature-catalogue "S-57 ENC 3.1"
The source point cloud, Cloud1.csar, is located at D:\BatchSample. D:\BatchSample\Cloud1.csar
The soundings will be stored in SoundingSelection.hob and will be D:\BatchSample\SoundingSelection.hob
saved to the same location as the input source file.

48 CARIS Batch Utility Reference Guide

BASE Editor Processes: Create Soundings from Coverage

Example

carisbatch --run CreateSoundingsFromCoverage --minimum-distance 10mm

Command CARIS:NONE CARIS:NONE--input-band Depth --scale 1000 --selection-bias
Line MIN --apply-designated --feature-catalogue "S-57 ENC 3.1"
D:\BatchSample\Cloud1.csar D:\BatchSample\SoundingSelection.hob
New sounding features are created using the elevation values of the source data and saved to
Outcome
a HOB file in the specified location.

Extra Notes N/A

CARIS Batch Utility Reference Guide 49

BASE Editor Processes: Create VR Surface

Create VR Surface
Description The CreateVRSurface process creates an empty variable
resolution CSAR file, setting extents and resolutions based on
provided source data.
Inputs Source points in a point cloud or raster surface in CSAR format,
or one or more HIPS track lines.
Outputs An empty variable resolution CSAR file with a valid resolution
map.
Command Line Syntax carisbatch --run CreateVRSurface --estimation-method <value>
--include-flag <value> [options] <inputs> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--estimation- e Method used to estimate tile resolutions. One of: FALSE This must be specified
method • CALDER_RICE: Estimate resolution based explicitly.
on point density and coverage area.
• CARIS_DENSITY: Estimate resolution based
on point density and distribution.
• RANGE: Assign resolutions based on a list of
value ranges and associated resolution.
--extent E The extents that defines the window. FALSE
<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 unprojected
data, an angle type unit is required. The order for
unprojected 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.
If not set, the extents are computed from input data.

50 CARIS Batch Utility Reference Guide

BASE Editor Processes: Create VR Surface

Parameter

Can Notes
Long Short Description
Repeat

--keep- If set, keeps estimated resolution values instead of FALSE

partial-bins adjusting to give an exact gridding of resolution tiles.
If not set, the default is to adjust resolution estimates
by an exact gridding per tile.
--max-grid- A number specifying the upper limit for the number FALSE
size of rows/columns each resolution tile can support.
The default value is 64. The valid range is 4 to 256.
The value must be larger than the MinGridSize.
--min-grid- A number specifying the lower limit for the number of FALSE
size rows/columns each resolution tile can support.
The default value is 4. The valid range is 4 to 256.
The value must be smaller than the MaxGridSize.
--output-crs c A string specifying the horizontal coordinate FALSE
reference system key of the output.
If not set, the default is to use the reference system
of the first source.
--output- A string specifying the vertical coordinate reference FALSE
vertical-crs system key of the input.
No vertical transformation will be applied even if a
value is specified. This value is only used as
metadata on the output dataset.
The default value is Unknown.
--include-flag A string specifying a status flag to be included for the TRUE This must be explicitly
operation. specified.
• ACCEPTED: Accepted status flag
• EXAMINED: Examined status flag
• OUTSTANDING: Outstanding status flag
• REJECTED: Rejected status flag
• SUPPRESSED: Suppressed status flag

EstimationMethod = CALDER_RICE Options

--area The method used to estimate tile coverage area FALSE

from a set of soundings. One of:
• SOUNDING: Use an area estimate
aggregated from individual sounding depths
• SWATH: Use an area estimate based on
multibeam swath coverage and mean depth
• ELLIPTICAL: Use elliptical fitting to
approximate the area of coverage
• BOX: Use the bounding box of the soundings
in each tile
The default value is SOUNDING.
SWATH is only available on point clouds imported
from HDCS.

CARIS Batch Utility Reference Guide 51

BASE Editor Processes: Create VR Surface

Parameter

Can Notes
Long Short Description
Repeat

--finest- A number specifying the smallest spacing between FALSE

resolution nodes.
The default value is 0.01 m. The valid range is 0 or
greater.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m,
mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd.
-coarsest- A number specifying the largest spacing between FALSE
resolution nodes.
The default value is 1000 m. The valid range is a
value greater than FinestResolution.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m,
mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd.
--supergrid- A number specifying the initial size of resolution FALSE
size tiles.
The default value is 32.0 m. The valid range is
greater than 2 times the FinestResolution.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m,
mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd.
--points-per- A number specifying the target number of points per FALSE
cell cell to use for resolution estimation.
The default value is 20. The valid range is 2 to 1024.
--beam-width A number specifying the assumed width of a beam. FALSE
The default value is 1.0 deg. The valid range is 0 to
90 (non-inclusive). Supported units: degrees.
The value is used to compute area estimates when
using SOUNDING and SWATH methods. It is
ignored by ELLIPTICAL and BOX area estimates.
Supported units: deg and rad.

EstimationMethod = CARIS_Density Options

--finest- A number specifying the smallest spacing between FALSE

resolution nodes.
The default value is 0.01 m.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m,
mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd.
--coarsest- A number specifying the largest spacing between FALSE
resolution nodes.
The default value is 1000 m.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m,
mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd.
--points-per- A number specifying the target number of points per FALSE
cell cell to use for resolution estimation
The default value is 20.

52 CARIS Batch Utility Reference Guide

BASE Editor Processes: Create VR Surface

Parameter

Can Notes
Long Short Description
Repeat

EstimationMethod = RANGE Options

--input-band i A string specifying the name of the input band. FALSE

The value must exist in the first input source. If not,
the primary elevation band of the first input source is
used.
--range-file The path to a file specifying the value ranges and FALSE
associated resolutions.
If no values are provided for RangeTable, this file will
be used to populate the range option. Values are
read as meters.
--range-table A pair of values describing an entry in the range TRUE
table.
<Minimum> - Smallest value of the range being
described.
<Resolution> - Resolution (in meters) to use at the
specified range.
If any ranges are specified, RangeFile will be
ignored. Depth values must be provided as negative
heights.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m,
mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd.
--range- The method used to classify a tile of points as FALSE
method belonging to a range. One of:
• MEAN: Use range containing the average
value of the tile
• MODE: Use range with the highest number
of values in the tile.
• PERCENTILE: Use the range containing a
specific percentile of the data from minimum
value to maximum value.
The default value is PERCENTILE.
--range- The percentile of data within a resolution tile, from FALSE
percentile minimum to maximum, that will be used to select a
range.
The default value is 50. The valid range is 0 to 100.
This option will only be used if RangeMethod is set
to PERCENTILE.

CARIS Batch Utility Reference Guide 53

BASE Editor Processes: Create VR Surface

Example: Calder Rice To use this command refer to the following example.
Estimation Method

Example

To setup a variable resolution coverage suitable to store some near-shore with shallow
Objective
depth and greater data density some offshore with greater depth and lower data density

Description Command Line Syntax

The estimation method for determining tile resolution is CALDER_RICE. --estimation-method CALDER_RICE
The output coordinate reference system is WG84 --output-crs WG84
The area estimation method being used is SOUNDING. --area SOUNDING
The finest resolution is 0.01m --finest-resolution 0.01m
The coarsest resolution is 500m --coarsest-resolution 500m
The supergrid size is 15m --supergrid-size 15m
The number of points per cell to use for resolution estimation is 5. --points-per-cell 5
The width of the beam is 4.3 deg. --beam-width 4.3deg
The input file is named SourceSurface.csar and located at D:\BatchSample\SourceSurface.csar
D:\BatchSample.
The output file will be named CreateVR.csar D:\BatchSample\CreateVR.csar
carisbatch --run CreateVRSurface --estimation-method CALDER_RICE -
-output-crs WG84 --area SOUNDING --finest-resolution 0.01m --
Command Line coarsest-resolution 500m --supergrid-size 15m --points-per-cell 5
--beam-width 4.3deg D:\BatchSample\SourceSurface.csar
D:\BatchSample\CreateVR.csar

Outcome An empty variable resolution surface, with the desired extents and resolution, is created.

Notes N/A

54 CARIS Batch Utility Reference Guide

BASE Editor Processes: Create VR Surface

Example: Range To use this command refer to the following example.

Estimation Method

Example

To create an empty variable resolution surface using a list of value ranges and associated
Objective
resolutions.

Description Command Line Syntax

The estimation method for determining tile resolution is RANGE. --estimation-method RANGE
The output coordinate reference system is WG84 --output-crs WG84
The ranges and their resolutions are: --range-table 0m 1m --range-table
• Depths 0m-49m have a resolution of 1m. 50m 2.5m --range-table 100m 5m
• Depths 50m-99m have a resolution of 2.5m.
• Depths 100m and greater have a resolution of 5m.
The Percentile method will be used for range estimation. --range-method PERCENTILE
The range percentile to be used is 50. --range-percentile 50
The input file is named SourceSurface.csar and located at D:\BatchSample\SourceSurface.csar
D:\BatchSample.
The output file will be named CreateVR.csar D:\BatchSample\CreateVR.csar
carisbatch --run CreateVRSurface --estimation-method RANGE --
output-crs WG84 --range-file D:\BatchSample\Rangefile.txt --range-
Command Line
method PERCENTILE --range-percentile 65
D:\BatchSample\SourceSurface.csar D:\BatchSample\CreateVR.csar

Outcome An empty variable resolution surface, with the desired extents and resolution, is created.

Notes N/A

CARIS Batch Utility Reference Guide 55

BASE Editor Processes: Describe Raster Product

Describe Raster Product

Description The DescribeRasterProduct process allows displaying the
existing raster product templates and their command line
equivalents.
Inputs A file containing raster product templates. The file specified in
Tools > Options for Raster Product Templates is used as the
input.
Outputs Either the list of templates available in the file or the set of
commands to generate the specified raster product.
Command Line Syntax carisbatch --run DescribeRasterProduct [options]

Options The following table describes the parameters available for this
process.

Parameter

Can
Long Short Description Notes
Repeat

--list-templates s Lists the available product templates. FALSE

--template-name t The name of template for which to provide commands. FALSE

Example To use this command refer to the following examples.

Example

Objective You want to view a list of previously created product template files.

Description Command Line Syntax

View a list of previously created product templates. --list-templates

Command Line carisbatch --run DescribeRasterProduct --list-templates

Outcome A list of available product templates is displayed in the command line window.

Extra Notes N/A

Example

Objective You want to know what is in an existing template to be able to use it to create raster surfaces.

Description Command Line Syntax

You want to use the product template file,Template1, previously --template-name Template1
created using the Export Raster Product tool in BASE Editor.

Command Line carisbatch --run DescribeRasterProduct --template-name Template1

56 CARIS Batch Utility Reference Guide

BASE Editor Processes: Describe Raster Product

Example

The RasterProduct process reads the rasterproducttemplate.xml file and provides command
Outcome lines for each of the individual export processes that would be required to generate all output
defined in the template.
The resulting command lines will not have values specified for the options unless they were
Extra Notes defined in the template. Once complete, the commands can either be placed in a batch script
and run in a single transaction, or each command can be run individually in CARIS Batch.

CARIS Batch Utility Reference Guide 57

BASE Editor Processes: Difference Coverages

Difference Coverages
Description The DifferenceCoverages process subtracts the difference file
coverage specified in the options from the input coverage.
Inputs A point cloud or raster surface in a supported format. Certain
coordinate reference systems cannot be written out to CSAR, so
BSB and HCRF formats are not supported. A BDB Server URI
can be specified as input.
Outputs A coverage in CSAR format. The coverage type will be
determined by the type of the input.
Command Line Syntax carisbatch --run DifferenceCoverages --difference-type <value> -
-input-band <value> --difference-file <value> [options] <input>
<output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--difference- d A string specifying the type of coverage specified in the FALSE This must be
type DifferenceFile. One of: specified explicitly.
• RASTER: Raster - A raster surface coverage
• REFERENCEMODEL: Reference Model - A
reference model coverage. This is only available
with Engineering Analysis Module licensing.
--input-band i A string specifying the name of the input band. FALSE This must be
specified explicitly.
--polygon- Y A string specifying the type of bounding polygon to FALSE
type generate. One of:
• CONVEX: Convex - The convex hull of the data
is used for the polygon.
• BUFFERED: Buffered - A simplified buffered
boundary is used for the polygon.
The default value is BUFFERED.
--difference- D A string specifying the path to the coverage containing FALSE This must be
file the values to be subtracted. specified explicitly.
--comments General comments to be added to the coverage FALSE
metadata.
The default value is an empty string.

DifferenceType = Raster

--difference- e A string specifying the band name containing the values FALSE This must be
band to be subtracted. specified explicitly.
DifferenceType = ReferenceModel
--template- n A string specifying the name of a fully defined template FALSE This must be
name in the reference model file. specified explicitly.

58 CARIS Batch Utility Reference Guide

BASE Editor Processes: Difference Coverages

Example To use this command refer to the following example.

Example

Objective You want to compare the differences between two overlapping coverages.

Description Command Line Syntax

The difference type is RASTER. --difference-type RASTER

The input band is Depth. --input-band Depth
The difference file is area1.csar located at D:\BatchSample. --difference-file D:\BatchSample\area1.csar
The difference band is Depth. --difference-band Depth
The source raster surface, area2.csar, is located at D:\BatchSample\area2.csar
D:\BatchSample.
The output surface will be named DifferenceCoverages.csar and D:\BatchSample\DifferenceCoverages.csar
will be saved to D:\BatchSample.
carisbatch --run DifferenceCoverages --difference-type RASTER --input-
Command band Depth --difference-file D:\BatchSample\Area1.csar --difference-
Line band Depth D:\BatchSample\Area2.csar
D:\BatchSample\DifferenceCoverage.csar

Outcome A new difference surface is created.

Extra Notes N/A

CARIS Batch Utility Reference Guide 59

BASE Editor Processes: Export Coverage Metadata

Export Coverage Metadata

Description The ExportCoverageMetadata process writes metadata to an XML
file with a specific profile.
Inputs A point cloud or raster dataset in CSAR or BAG format.
Metadata values supplied as process options are used in the
export instead of existing metadata.
Outputs An XML file containing the exported metadata.
Command Line Syntax carisbatch --run ExportCoverageMetadata --metadata-profile
<value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

Common Options

--profile p A string specifying the profile of the output FALSE This must be
metadata. One of: specified explicitly.
• BAG: Metadata in the BAG profile.
• ISO19115: Metadata in the ISO19115
profile.

ExportMetadataTo = BAG

--uncertainty-type U A string specifying the source of uncertainty data FALSE This must be
stored in the input as per the BAG metadata specified explicitly.
profile. One of:
• STDDEV_RAW: Raw standard deviation
• STDDEV_CUBE: CUBE standard deviation
• PRODUCT_UNCERT: Product uncertainty
• STDDEV_HISTORICAL: Historical standard
deviation
• TPE_AVERAGE: Average total propagated error
• UNKNOWN: Unknown
--abstract a A string containing the description of the output as FALSE This must be
per ISO 19115. specified explicitly.
--status s A string specifying the status of the input as per FALSE This must be
ISO 19115. One of: specified explicitly.
• COMPLETED: Complete
• ARCHIVE: Historical archive
• OBSOLETE: Obsolete
• ONGOING: Ongoing
• PLANNED: Planned
• REQUIRED: Required
• UNDER_DEV: Under development
--vertical-datum D A string specifying the vertical datum of the input FALSE This must be
as per ISO 19115. specified explicitly.

60 CARIS Batch Utility Reference Guide

BASE Editor Processes: Export Coverage Metadata

Parameter

Can Notes
Long Short Description
Repeat

--party-name M A string specifying the name of the responsible FALSE

party as per ISO 19115.
--party-position S A string specifying the position of the responsible FALSE
party as per ISO 19115.
--party-organization o A string specifying the organization of the FALSE
responsible party as per ISO 19115.
--party-role R A string specifying the role of the responsible party FALSE This must be
as per ISO 19115. One of: specified explicitly.
• RESOURCE_PROVIDER: Resource
provider
• CUSTODIAN: Custodian
• OWNER: Owner
• USER: User
• DISTRIBUTOR: Distributor
• ORIGINATOR: Originator
• POINT_OF_CONTACT: Point of contact
• PRINCIPAL_INVESTIGATOR: Principal
investigator
• PROCESSOR: Processor
• PUBLISHER: Publisher
• AUTHOR: Author
--legal-constraints L A string specifying the legal constraints of the FALSE This must be
output as per ISO 19115. One of: specified explicitly.
• COPYRIGHT: Copyright
• PATENT: Patent
• PATENT_PENDING: Patent pending
• TRADEMARK: Trademark
• LICENSE: License
• IP_RIGHTS: Intellectual property rights
• RESTRICTED: Restricted
• OTHER_RESTRICTIONS: Other
restrictions
--other-constraints C A string specifying details of the legal constraints. FALSE This option is
ISO 19115 requires that this option must be set if conditional on
LegalConstraints is set to LegalConstraints.
OTHER_RESTRICTIONS. It is optional otherwise.
--security- A A string specifying the security constraints of the FALSE This must be
constraints output. One of: specified explicitly.
• UNCLASSIFIED: Unclassified
• RESTRICTED: Restricted
• CONFIDENTIAL: Confidential
• SECRET: Secret
• TOP_SECRET: Top secret
--notes N A string specifying notes about the output as per FALSE This must be
ISO 19115. specified explicitly.

CARIS Batch Utility Reference Guide 61

BASE Editor Processes: Export Coverage Metadata

Example To use this command refer to the following example.

Example

You want to export BAG metadata where BAG is the input, BAG metadata is the output, and
Objective
the metadata in the original BAG file is maintained.

Description Command Line Syntax

The profile to save to is BAG. --metadata-profile BAG

The uncertainty data type is unknown. --uncertainty-type UNKNOWN
The status of the source data is ongoing. --status ONGOING
The vertical datum of the surface is Mean Sea Level. --vertical-datum "Mean Sea Level"
The name of the responsible party is John Smith. --party-name "John Smith"
The position of the responsible party is Project Manager. --party-position "Project Manager"
The organization of the responsible party is CARIS. --party-organization CARIS
The role of the responsible party is processor. --party-role PROCESSOR
The source data is legally trademarked. --legal-constraints TRADEMARK
The description of the data is data. --abstract data
Additional notes are included. --notes "Additional notes"
The security constraint of the data is unclassified. --security-constraints UNCLASSIFIED
Metadata is to be exported for the surface, BAG_2Points.bag, located D:\BatchSample\BAG_2Points.bag
in the D:\BatchSample directory.
The resulting metadata will be saved as, Source2PointsBAG.xml, in D:\BatchSample\Source2PointsBAG.xml
the D:\BatchSample directory.
carisbatch --run ExportCoverageMetadata --metadata-profile BAG
--uncertainty-type UNKNOWN --status ONGOING --vertical-datum "Mean
Sea Level" --party-name "John Smith" --party-position "Project
Command Line Manager" --party-organization CARIS --party-role PROCESSOR
--legal-constraints TRADEMARK --abstract data --notes "Additional
notes" --security-constraints UNCLASSIFIED
D:\BatchSample\BAG_2Points.bag D:\BatchSample\Source2PointsBAG.xml

Outcome The metadata of the source surface is exported to an XML file.

Notes N/A

62 CARIS Batch Utility Reference Guide

BASE Editor Processes: Export Coverage to ASCII

Export Coverage to ASCII

Description The ExportCoverageToASCII process exports band values from a
coverage to an ASCII file. The format is essentially CSV but the
user can specify the delimiter to be something other than a
comma.
Inputs A point cloud or raster dataset.
Outputs An ASCII text file.
Command Line Syntax carisbatch --run ExportCoverageToASCII --include-band
<value> --coordinate-format <value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--include- j If set, rejected values in the input are included in the FALSE
rejected output.
--include- a If set, the header is included in the output. FALSE
header
--delimiter d The delimiter character used to delineate columns in FALSE
output.
Single characters are specified directly. For a single
space, use " " or the keyword space. For a tab, use \t or
the keyword tab.
The default value is a comma.
--output-crs c A string specifying the horizontal coordinate reference FALSE
system key of the output.
If specified, the data is transformed.
--coordinate- t A string specifying the format of the coordinates in the FALSE This must be
format output. One of: specified explicitly.
• GROUND: Ground
• LLDG_DMS: Geographic DMS
• LLDG_DMS_NO_FORMAT: Geographic DMS
(no formatting)
• LLDG_DM: Geographic DM
• LLDG_DD: Geographic DD
--coordinate- e A number specifying the decimal precision of the FALSE
precision coordinates in the output.
The default value is 3.

CARIS Batch Utility Reference Guide 63

BASE Editor Processes: Export Coverage to ASCII

Parameter

Can Notes
Long Short Description
Repeat

--include- b The name and precision of a band to include in the TRUE This must be
band output. specified explicitly.
<Name> - A string specifying the name of the band to
include in the output.
<DecimalPrecision> - A number specifying the decimal
precision for floating point numeric values in the output.
Include values in the output from the band in the input,
using the specified precision. The DecimalPrecision is
only used for numeric band types, but must be specified
for all band types.
The ALL keyword is used to include all other bands in
the output in alphabetical order. If the ALL keyword is
used in conjunction with explicit band names, the latter
overrides the options specified with the ALL keyword.
--z-axis- z A string specifying the output Z-axis convention. One of: FALSE
convention • UP: Z axis positive up
• DOWN: Z axis positive down
The default value is DOWN.
--band-filter f A string specifying a filter to apply to input band values. FALSE Values assumed
Supported operators: >, <, =, !=. For example, "Depth > to be using
1". positive UP
convention.
For more information and examples using filters, see
FILTER COVERAGE, or .
--sample s The sample size with its sampling method. FALSE Valid units are
<SampleSize> - A number specifying the output sample Length type units
size. in unitstable.xml.

<SampleMethod> - A string specifying the output

sampling method. One of:
• MIN: Minimum node value which is equivalent to
shoalest when Z down convention applied.
• MAX: Maximum node value which is equivalent
to deepest when Z down convention applied.
The sample size unit must be specified. If the input is a
raster, the sample size must be equivalent to or larger
than the resolution of the input.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi,
mm, nm, usfm, usft, usmi, usnm, usyd, yd.
--elevation- E A string specifying the unit for output elevation values. FALSE Valid units are
unit The value is converted to the specified unit. Length type units
in unitstable.xml.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi,
mm, nm, usfm, usft, usmi, usnm, usyd, yd.
The default value is metres.

64 CARIS Batch Utility Reference Guide

BASE Editor Processes: Export Coverage to ASCII

Parameter

Can Notes
Long Short Description
Repeat

--coordinate- o A string specifying the unit for output coordinates. FALSE

unit The value is converted to the specified unit. The unit is
only applicable when CoordinateFormat is set to
GROUND.
The default value is the unit of the input CRS.
--other-unit x A string specifying the unit for any other scalar band FALSE Valid units are
values. Length type units
The value is converted to the specified unit. in unitstable.xml.

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

Example To use this command refer to the following example.

Example

Objective You want to export a raster surface to an ASCII file.

Description Command Line Syntax

The first line of the file will contain a header. --include-header

Depth band values will be exported with 5 decimal places and Shoal --include-band Depth 5 --include-band
band values will be exported with 2 decimal values. Shoal 2
A filter will be applied to the output so that only points with a Shoal --band-filter "Shoal<20"
band value with a depth of less than 20 metres will be saved.
The coordinate format will be Geographic DMS. --coordinate-format LLDG_DMS
The source surface is Surface5.csar located in the D:\BatchSample D:\BatchSample\Surface5.csar
directory.
The output ASCII file will be created in the D:\BatchSample D:\BatchSample\Shoal20M.txt
directory and named Shoal20M.
carisbatch --run ExportCoverageToASCII --include-header --include-band
Command Depth 5 --include-band Shoal 2 --band-filter "Shoal<20" --coordinate-
Line format LLDG_DMS D:\BatchSample\Surface5.csar
D:\BatchSample\Shoal20M.txt

Outcome A new ASCII file is created in the designated output folder.

If a colour attribute band is selected for export, the colour values will always export as four
Extra Notes
separate columns and in the order red, green, blue, alpha.

CARIS Batch Utility Reference Guide 65

BASE Editor Processes: Export Points

Export Points
Description The ExportPoints process exports band values from one coverage
to a point cloud in a supported format.
Inputs A coverage in a supported format.
Outputs A point cloud dataset in the specified output format.
Command Line Syntax carisbatch --run ExportPoints --output-format <value> [options]
<input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

Common Options

--output- O A string specifying the format in which the output cloud is FALSE This must be
format generated. specified
• LAS: The LASer (LAS) File format. explicitly.
• CSAR: The CSAR cloud format.
Options specific to each format are specified below.

ExportPoints = CSAR

--include- b A string specifying the name of a band to include in the TRUE This must be
band output. specified
The ALL keyword is used to include all bands in the output. explicitly.

--polygon- Y A string specifying the type of bounding polygon to generate. FALSE

type One of:
• CONVEX: The convex hull of the data is used for the
polygon.
• BUFFERED: A simplified buffered boundary is used
for the polygon.
The default value is BUFFERED.
--comments General comments to be added to the coverage metadata. FALSE
The default value is an empty string.

ExportPoints = LAS

--las-version V The LAS format version to output. The value must be one of FALSE This must be
1.0, 1.1, 1.2, 1.3 or 1.4. specified
explicitly.
--point- A number specifying the point record format to use. FALSE
record- The value must be one of 1 through 10. The point format that
format best suits the data will be selected automatically. If set, this
option will override the default behaviour and use the
specified point record.

66 CARIS Batch Utility Reference Guide

BASE Editor Processes: Export Points

Parameter

Can Notes
Long Short Description
Repeat

--include- b The names of the input band and the LAS output. TRUE
band The ALL keyword is used to include all bands in the output.
For the LAS format, this option must be entered as
"ALL:ALL".
<InputName[:Flag]> - A string specifying the name of the
input band to copy to the output. A flag name may be
specified to map an individual flag in the band to a LAS band.
Note: Colons (:) and backslashes (\) in band and flag names
must be escaped with a "\". These characters act as
indicators to separate the band name from the status flag. If
the InputName contains a separator character, a backslash
must be entered before these characters to tell the process to
treat the character as a letter, not a separator. For example, if
the input band were LAS:Flags and you wanted to map the
Overlap flag in that band, you would need to enter
LAS\:Flags:Overlap.
<OutputName> - A string specifying the name of the output
LAS band to include in the output.
• ELEVATION: The Z value of the points.
• INTENSITY: The intensity value is the integer
representation of the pulse return magnitude.
• RETURN_NUMBER: The return number is the pulse
return foe a given output pulse.
• NUMBER_RETURNS: The number of returns is the
total number of returns for a given pulse.
• SCAN_DIRECTION_FLAG: The scan direction flag
denotes the direction at which the scanner mirror was
travelling at the time of the output pulse. A bit value of
1 is a positive scan direction, and a bit value of 0 is a
negative scan direction.
• EDGE_FLIGHT_LINE: The edge of flight line data bit
has a value of 1 only when the point is at the end of a
scan. It is the last point on a given scan line before it
changes direction.
• CLASSIFICATION: This field represents the "class"
attributes of a point. If a point has never been
classified, this byte must be set to zero.
• SCAN_ANGLE: The Scan Angle is a signed short that
represents the rotational position of the emitted laser
pulse with respect to the vertical of the coordinate
system of the data. Down in the data coordinate
system is the 0.0 position. Each increment represents
0.006 degrees. CounterClockwise rotation, as viewed
from the rear of the sensor, facing in the along-track
(positive trajectory) direction, is positive.
• SCANNER_CHANNEL: Scanner channel is used to
indicate the channel (scanner head) of a multi-channel
system. Channel 0 is used for single scanner systems.
Up to four channels are supported (0-3).
• USER_DATA: This field may be used at the user's
discretion.

CARIS Batch Utility Reference Guide 67

BASE Editor Processes: Export Points

Parameter

Can Notes
Long Short Description
Repeat

--include- b (cont.) TRUE

band (cont.) • POINT_SOURCE_ID: This value indicates the file
from which this point originated. LAS files exported
from CARIS BASE Editor will always be set to point
source ID zero.
• GPS_TIME: The GPS time is the double floating point
time tag value at which the point was acquired.
• SYNTHETIC: If set, then this point was created by a
technique other than LIDAR collection such as
digitized from a photogrammetric stereo model or by
traversing a waveform.
• KEY_POINT: If set, this point is considered to be a
model key-point and thus generally should not be
withheld in a thinning algorithm.
• WITHHELD: If set, this point should not be included in
processing (synonymous with Deleted).
• OVERLAP: If set, this point is within the overlap region
of two or more swaths or takes.
• COLOUR: The red, blue, green image channel values
associated with the point.
• NEAR_INFRARED: The near infrared channel
associated with the point.
Overlap and near infrared fields are only available in version
1.4.
--coordinate- A number specifying the decimal precision of the coordinates FALSE
precision in the output.
The default value is 3.
--elevation- A number specifying the decimal precision of the elevation in FALSE
precision the output.
The default value is 3.

To use this command refer to the examples below.

68 CARIS Batch Utility Reference Guide

BASE Editor Processes: Export Points

Example: Surface to
Point Cloud

Example

Objective You want to export band values (points) from a coverage to a point cloud.

Description Command Line Syntax

The output format is CSAR. --output-format CSAR

The depth and shoal attributes of the source surface are to be --include-band Depth --include-band
exported. Shoal
The source surface is Surface5.csar located in the D:\BatchSample D:\BatchSample\Surface5.csar
directory.
The output file will be created in the D:\BatchSample directory and D:\BatchSample\Exportedpoints.csar
named Exportedpoints.csar.
carisbatch --run ExportPoints --output-format CSAR --include-band
Command
Depth --include-band Shoal D:\BatchSample\Surface5.csar
Line
D:\BatchSample\Exportedpoints.csar

Outcome A new point cloud with the specified bands is created in the designated output folder.

Extra Notes N/A

Example: Surface to
LAS

Example

Objective You want to export LAS data from a CSAR point cloud to a LAS format file.

Description Command Line Syntax

The output format is LAS. --output-format LAS

The attribute bands and the status flags from the LAS_Flags band --include-band Return_Number
of the source coverage will be exported and mapped to the LAS Return_Number --include-band
data as follows: Number_Of_Returns Number_Returns --
• The Return_Number band will be mapped to the Return_Number include-band Classification Classification -
band in the output. -include-band LAS_Flags:Scan_Direction
• The Number_Of_Returns band will be mapped to the Scan_Direction_Flag --include-band
Number_Returns band in the output. LAS_Flags:Synthetic Synthetic --include-
• The Classification band will be mapped to the Classification band band LAS_Flags:Withheld Withheld --
in the output. include-band LAS_Flags:Key_Point
• The Scan_Direction LAS status flag will be mapped from the Key_Point --include-band
LAS_Flags band to the Scan_Direction_Flag band in the output. LAS_Flags:Flight_Line_Edge
• The Synthetic LAS status flag will be mapped from the LAS_Flags Edge_Flight_Line --include-band
band to the Sythetic band in the output. LAS_Flags:Overlap Overlap
• The Withheld LAS status flag will be mapped from the LAS_Flags
band to the Withheld band in the output.
• The Key_Point LAS status flag will be mapped from the
LAS_Flags band to the LAS Key_Point band in the output.
• The Flight_Line_Edge LAS status flag will be mapped from the
LAS_Flags band to the Edge_Flight_Line band in the output.
• The Overlap LAS status flag will be mapped from the LAS_Flags
band to the Overlap band in the output.

CARIS Batch Utility Reference Guide 69

BASE Editor Processes: Export Points

Example

The source surface is LASPointCloud.csar located in the D:\BatchSample\LASPointCloud.csar

D:\BatchSample directory.
The output file will be created in the D:\BatchSample directory and D:\BatchSample\OutputCoverage.las
named OutputCoverage.las.
carisbatch -r ExportPoints --output-format LAS --include-band
Return_Number Return_Number --include-band Number_Of_Returns
Number_Returns --include-band Classification Classification --include-
band LAS_Flags:Scan_Direction Scan_Direction_Flag --include-band
Command
LAS_Flags:Synthetic Synthetic --include-band LAS_Flags:Withheld
Line
Withheld --include-band LAS_Flags:Key_Point Key_Point --include-band
LAS_Flags:Flight_Line_Edge Edge_Flight_Line --include-band
LAS_Flags:Overlap Overlap D:\BatchSample\LASPointCloud.csar
D:\BatchSample\OutputCoverage.las
A new LAS file is created. The dataset will include the specified attribute bands as well as
Outcome
bands for each of the LAS status flags that were mapped from the LAS_Flags band.

Extra Notes N/A

70 CARIS Batch Utility Reference Guide

BASE Editor Processes: Export Raster

Export Raster
Description The ExportRaster process exports a raster dataset in one format
to another format. The output raster will have the same
coordinate reference system, geographic extents and values as
the input raster.
Inputs A raster dataset in a supported format.
Outputs A raster dataset in the specified output format.
Command Line Syntax carisbatch --run ExportRaster --output-format <value>
--include-band <value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

Common Options

--output-format O A string specifying the format in which the output is FALSE This must be
generated. One of: specified explicitly.
• BAG: The Bathymetry Attributed Grid raster
surface format.
• ESRI_ASCII: The ESRI ASCII raster surface
format.
• USGS_DEM: The USGS Digital Elevation
Map raster surface format.
• GEOTIFF: The GeoTIFF raster format. This
may be a raster surface or a raster image,
depending on the input.
• PNG: The Portable Network Graphics raster
image format.
• JPEG: The JPEG raster image format, with a
compression factor of 75%.
• CSAR: The CSAR raster format. This may be
a raster surface or a raster image, depending
on the input.
Options specific to each format are specified below.

ExportRasterTo = BAG

--include-band b A string specifying the name of a band to include in FALSE This must be
the output. specified explicitly.
The band must contain elevation data.
--uncertainty t A string specifying the name of the uncertainty band FALSE
in the input.
--compress-level o A number specifying the level of compression FALSE
applied to the output.
The default value is 1. The valid range is 0 to 9, not
compressed to highly compressed.

CARIS Batch Utility Reference Guide 71

BASE Editor Processes: Export Raster

Parameter

Can Notes
Long Short Description
Repeat

Refer to “EXPORT COVERAGE METADATA” ON PAGE 60

for additional BAG metadata profile details.

ExportRasterTo = ESRII ASCII

--include-band b A string specifying the name of a band to include in FALSE This must be
the output. specified explicitly.
--decimal- d A number specifying the decimal precision for FALSE
precision floating point numeric values.
The default value is 3.

ExportRasterTo = USGS_DEM

ExportRasterTo = GEOTIFF

--include-band b A string specifying the name of a band to include in TRUE At least one band
the output. must be specified.
The ALL keyword is used to include all bands in the
output.
--compression C A string specifying the type of compression applied FALSE
to the output GeoTIFF. One of:
• NONE: No compression.
• LZW: Lossless LZW compression.
• DEFLATE: Lossless Deflate compression.
• JPEG: Lossy JPEG compression.
Compression 85%.
The default is LZW, where applicable.
ExportRasterTo = PNG
--include-band b A string specifying the name of a band to include in FALSE This must be
the output. specified explicitly.
ExportRasterTo = JPEG
--include-band b A string specifying the name of a band to include in FALSE This must be
the output. specified explicitly.
ExportRasterTo = CSAR
--include-band b A string specifying the name of a band to include in TRUE At least one band
the output. must be specified.
The ALL keyword is used to include all bands in the
output.

72 CARIS Batch Utility Reference Guide

BASE Editor Processes: Export Raster

Example To use this command refer to the following example.

Example

Objective You want to export a gridded surface to ESRI ASCII format.

Description Command Line Syntax

The output format will be ESRI ASCII. --output-format ESRI_ASCII

The Depth attribute of the source surface is to be exported. --include-band Depth
The source surface is Surface.csar, located in the D:\BatchSample D:\BatchSample\Surface.csar
directory.
The resulting output will be created in the D:\BatchSample directory D:\BatchSample\ESRIASCII_Export.asc
with the name ESRIASCII_Export.asc.
carisbatch --run ExportRaster --output-format ESRI_ASCII --include-
Command
band Depth D:\BatchSample\Surface.csar
Line
D:\BatchSample\ESRIASCII_Export.asc

Outcome The source surface is exported to the selected format according to the options specified.

Extra Notes N/A

CARIS Batch Utility Reference Guide 73

BASE Editor Processes: Export Raster to STL

Export Raster to STL

Description The ExportRasterToSTL process exports raster band values to
the STL format for 3D printing.
Inputs A raster surface in a supported format.
Outputs An STL (STereoLithography) file.
Command Line Syntax carisbatch --run ExportRasterToSTL --include-band <value>
[options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--vertical- V A number specifying the multiplier for each band value. FALSE
exaggeration This must be a positive number. The default value is 1.0.
--include- b A string specifying the name of a band to include in the FALSE This must be
band output. specified explicitly.
The band must contain elevation data.
--scale s A number specifying the scaling to apply to x, y and z FALSE
values (1:scale).
This must be a positive number. The default value is 1.0.
--output-as- o If set, an ASCII output is created. By default, a binary FALSE
ascii output is created.

Example To use this command refer to the following example.

Example

Objective You want to create an STL file from a raster dataset in order to print to a 3D printer.

Description Command Line Syntax

The depth band is included in the output. --include-band Depth

The vertical exaggeration is 2. --vertical-exaggeration 2
The scale of the data is 1:100. --scale 100
The input raster dataset is Surace1.csar. D:\BatchSample\Surface1.csar
The output STL file will be called 3DPrint.stl. D:\BatchSample\3DPrint.stl
carisbatch --run ExportRasterToSTL --include-band Depth --vertical-
Command
exaggeration 2 --scale 100 D:\BatchSample\Surface1.csar
Line
D:\BatchSample\3DPrint.stl

Outcome An STL file containing the exported data is created.

Extra Notes N/A

74 CARIS Batch Utility Reference Guide

BASE Editor Processes: Export VR Surface to BAG

Export VR Surface to BAG

Description The ExportVRSurfaceToBAG process exports a variable resolution
surface to a BAG raster with variable resolution refinement
grids.
Inputs A variable resolution surface.
Outputs A BAG raster with variable resolution refinement grids.
Command Line Syntax carisbatch --run ExportVRSurfaceToBAG --include-band
<value> --uncertainty-type <value> --abstract <value> --status
<value> --vertical-datum <value> --party-role <value> --legal-
constraints <value> --security-constraints <value> --notes
<value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--include-band b A string specifying the name of a band to include in the FALSE This must be
output. specified
The band must contain elevation data. explicitly.

--uncertainty t A string specifying the name of the uncertainty band in FALSE

the input.
If not set, no uncertainty values are exported.
--compression- c A number specifying the level of compression applied to FALSE
level the output.
The default value is 1. The valid range is 0 to 9, not
compressed to highly compressed.
--representative A string specifying the type of value ot use per tile. FALSE
• DEEP - The deepest node in the tile is used.
• MEDIAN - The median node in the tile is used.
• SHOAL - The shoalest node in the tile is used.
The default value is MEDIAN.
--uncertainty- U A string specifying the source of uncertainty data stored FALSE This must be
type in the input as per the BAG metadata profile. One of: specified
• STDDEV_RAW: Raw standard deviation explicitly.
• STDDEV_CUBE: CUBE standard deviation
• PRODUCT_UNCERT: Product uncertainty
• STDDEV_HISTORICAL: Historical standard deviation
• TPE_AVERAGE: Average total propagated error
• UNKNOWN: Unknown
--abstract a A string containing the description of the output as per FALSE This must be
ISO 19115. specified
explicitly.

CARIS Batch Utility Reference Guide 75

BASE Editor Processes: Export VR Surface to BAG

Parameter

Can Notes
Long Short Description
Repeat

--status s A string specifying the status of the input as per ISO FALSE This must be
19115. One of: specified
• COMPLETED: Complete explicitly.
• ARCHIVE: Historical archive
• OBSOLETE: Obsolete
• ONGOING: Ongoing
• PLANNED: Planned
• REQUIRED: Required
• UNDER_DEV: Under development
--vertical-datum D A string specifying the vertical datum of the input as per FALSE This must be
ISO 19115. specified
explicitly.
--party-name M A string specifying the name of the responsible party as FALSE
per ISO 19115.
--party-position S A string specifying the position of the responsible party FALSE
as per ISO 19115.
--party- o A string specifying the organization of the responsible FALSE
organization party as per ISO 19115.
--party-role R A string specifying the role of the responsible party as FALSE This must be
per ISO 19115. One of: specified
• RESOURCE_PROVIDER: Resource provider explicitly.
• CUSTODIAN: Custodian
• OWNER: Owner
• USER: User
• DISTRIBUTOR: Distributor
• ORIGINATOR: Originator
• POINT_OF_CONTACT: Point of contact
• PRINCIPAL_INVESTIGATOR: Principal
investigator
• PROCESSOR: Processor
• PUBLISHER: Publisher
• AUTHOR: Author
--legal- L A string specifying the legal constraints of the output as FALSE This must be
constraints per ISO 19115. One of: specified
• COPYRIGHT: Copyright explicitly.
• PATENT: Patent
• PATENT_PENDING: Patent pending
• TRADEMARK: Trademark
• LICENSE: License
• IP_RIGHTS: Intellectual property rights
• RESTRICTED: Restricted
• OTHER_RESTRICTIONS: Other restrictions
--other- C A string specifying details of the legal constraints. FALSE This option is
constraints ISO 19115 requires that this option must be set if conditional on
LegalConstraints is set to OTHER_RESTRICTIONS. It LegalConstraints.
is optional otherwise.

76 CARIS Batch Utility Reference Guide

BASE Editor Processes: Export VR Surface to BAG

Parameter

Can Notes
Long Short Description
Repeat

--security- A A string specifying the security constraints of the output. FALSE This must be
constraints One of: specified
• UNCLASSIFIED: Unclassified explicitly.
• RESTRICTED: Restricted
• CONFIDENTIAL: Confidential
• SECRET: Secret
• TOP_SECRET: Top secret
--notes N A string specifying notes about the output as per ISO FALSE This must be
19115. specified
explicitly.

Example To use this command refer to the following example.

Example

You want to export a variable resolution surface to a BAG raster surface, using the shoalest
Objective
values from the input as the representative points in the BAG raster.

Description Command Line Syntax

The Depth band is to be included in the output. --include-band Depth

The shoalest node in the tiles is to be used. --representative SHOAL
The raw standard deviation uncertainty type is to be used. --uncertainty-type STDDEV_RAW
The abstract needs to state that the source of the bag was a --abstract "variable resolution surface
variable resolution surface. data"
The status of the source data is completed. --status COMPLETED
The vertical datum of the surface is Mean Sea Level. --vertical-datum "Mean Sea Level"
The name of the responsible party is John Doe. --party-name "John Doe"
The position of the responsible party is Data Analyst. --party-position "Data Analyst"
The organization of the responsible party is Teledyne CARIS. --party-organization "Teledyne CARIS"
The role of the responsible party is author. --party-role AUTHOR
The source data is legally restricted. --legal-constraints RESTRICTED
The security constraint of the data is unclassified. --security-constraints UNCLASSIFIED
An extra note is needed stating, "Quality is fundamental". --notes "Quality is fundamental"
The input VR surface is named VR_Surface.csar and is in the D:\BatchSample\VR_Surface.csar
BatchSample directory on the D: drive.
The output file is to be called BAG_VR.bag and saved to the same D:\BatchSample\BAG_VR.bag
directory as the source surface.

CARIS Batch Utility Reference Guide 77

BASE Editor Processes: Export VR Surface to BAG

Example

carisbatch --run ExportVRSurfaceToBAG --include-band Depth --

representative SHOAL --uncertainty-type STDDEV_RAW --abstract
"variable resolution surface data" --status COMPLETED --vertical-datum
Command "Mean Sea Level" --party-name "John Doe" --party-position "Data
Line Analyst" --party-organization "Teledyne CARIS" --party-role AUTHOR --
legal-constraints RESTRICTED --security-constraints UNCLASSIFIED --
notes "Quality is fundamental" D:\BatchSample\VR_Surface.csar
D:\BatchSample\BAG_VR.bag
A new BAG raster surface is created, with the tiles populated from the shoalest values in the
Outcome
input variable resolution surface.

Extra Notes N/A

78 CARIS Batch Utility Reference Guide

BASE Editor Processes: Extract Coverage

Extract Coverage
Description The ExtractCoverage process extracts a portion of a coverage.
Inputs A point cloud or raster dataset.
Outputs A coverage in CSAR format.
Command Line Syntax carisbatch --run ExtractCoverage --geometry <value> --include-
band <value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--include- b A string specifying the name of a band to include in the TRUE At least one value
band output. must be specified
The ALL keyword is used to include all bands in the explicitly.
output.
--extract- g A string specifying the type of extraction to be performed. FALSE
type One of:
• INCLUSIVE: Inclusive - Copy all data inside the
geometry.
• EXCLUSIVE: Exclusive - Copy all data outside the
geometry.
The default value is INCLUSIVE.
--band-filter f A string specifying a filter to apply to input band values. FALSE Values for elevation
Supported operators: >, <, =, !=. For example, "Depth > bands are
1". assumed to be
using the positive
For more information and examples using filters, see UP convention.
FILTER COVERAGE, or .
--geometry G The geometry with its coordinate reference system. FALSE
<WKT> - A string specifying the shape of the geometry.
<CRS> - A string specifying the horizontal coordinate
reference system key of the geometry.
The geometry can be composed of one or more polygons
that contain one or more holes. The geometry must be
specified as a WKT string.
--polygon- Y A string specifying the type of bounding polygon to FALSE
type generate. One of:
• CONVEX: Convex - The convex hull of the data is
used for the polygon.
• BUFFERED: Buffered - A simplified buffered
boundary is used for the polygon.
The default value is BUFFERED.
--comments General comments to be added to the coverage FALSE
metadata.
The default value is an empty string.

CARIS Batch Utility Reference Guide 79

BASE Editor Processes: Extract Coverage

Example To use this command refer to the following example.

Example

Objective You want to extract a portion of a raster coverage.

Description Command Line Syntax

The depth band will be included in the extracted raster surface. --include-band Depth
A filter will be applied to the output so that only points with a depth --band-filter "Depth>10"
greater than 10 metres will be included.
The geometry of the extracted polygon is defined by the WKT string: --geometry POLYGON
POLYGON ((417005.5403481841800000 ((417005.5403481841800000
5579144.0498767812000000, 416942.8549106763700000 5579144.0498767812000000,
5579003.2347864071000000, 416908.2885466055600000 416942.8549106763700000
5579112.7677087365000000, 417005.5403481841800000 5579003.2347864071000000,
5579144.0498767812000000)). 416908.2885466055600000
The coordinate reference system is UTM-30N. 5579112.7677087365000000,
417005.5403481841800000
5579144.0498767812000000))" UTM-30N
The source surface, Surface1.csar is located at D:\BatchSample. D:\BatchSample\Surface1.csar
The output surface will be named ExtractSurface.csar and will be D:\BatchSample\ExtractSurface.csar
saved to the same location as the source file.
carisbatch --run ExtractCoverage --include-band Depth --band-filter
"Depth>10" --geometry "POLYGON ((417005.5403481841800000
5579144.0498767812000000, 416942.8549106763700000
Command
5579003.2347864071000000, 416908.2885466055600000
Line
5579112.7677087365000000, 417005.5403481841800000
5579144.0498767812000000))" UTM-30N D:\BatchSample\Surface1.csar
D:\BatchSample\ExtractSurface.csar

Outcome A new raster surface is created from the data extracted from the original raster surface.

To generate a string for the geometry, you can select a polygon in the application and export it
Extra Notes
to ASCII through File > Export > Selection > CARIS Well Known Text

80 CARIS Batch Utility Reference Guide

BASE Editor Processes: Fill Raster Holidays

Fill Raster Holidays

Description The FillRasterHolidays process uses the mean of nearby nodes
to fill cells in holidays.
Inputs A raster dataset.
Outputs A raster in CSAR format. Previously empty cells in the input
band are populated based on the process options. A new band
called "<InputBand> Interpolated" is added.
Command Line Syntax carisbatch --run FillRasterHolidays --input-band <value>
[options] <input> <output>

Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--input-band i A string specifying the band that will be updated. FALSE This must be
Any numeric band can be specified. specified explicitly.

--matrix m The criteria that controls how interpolation is performed. FALSE

<Size> - A string specifying the size of the matrix of
input values for each output node. One of:
• 3x3: A 3 x 3 interpolation matrix that considers
one layer of cells around each output cell.
• 5x5: A 5 x 5 interpolation matrix that considers
two layers of cells around each output cell.
<Neighbours> - A number specifying the minimum
number of populated nodes in the input matrix to
calculate an output node.
Each output cell is populated with the average of the
input cells in the matrix if there are at least
<Neighbours> populated cells in the input matrix.
Otherwise, the output cell is left empty. <Neighbours> is
a number between 1 and (<Size>-1), inclusive.
The default values are 3x3 and 6.
--include- b A string specifying the name of a band to include in the TRUE
band output.
The ALL keyword is used to include all other bands in
the output.
--polygon- Y A string specifying the type of bounding polygon to FALSE
type generate. One of:
• CONVEX: The convex hull of the data is used for
the polygon.
• BUFFERED: A simplified buffered boundary is
used for the polygon.
The default value is BUFFERED.

CARIS Batch Utility Reference Guide 81

BASE Editor Processes: Fill Raster Holidays

Example: To use this command refer to the following example.

Example

Objective You want to fill holidays in a raster surface.

Description Command Line Syntax

The input band to be used is Depth. --input-band Depth

A matrix size of 5x5 is to be used. There must be at least 15 cells --matrix 5x5 15
within the matrix area with values in the input in order to calculate a
new output cell.
Mean and Std_Dev are additional bands to be included in the --include-band Mean --include-
interpolated raster surface. band Std_Dev
The bounding polygon type is convex. --polygon-type CONVEX
The source raster surface is Surface_2.csar in the D:\BatchSample D:\BatchSample\Surface_2.csar
directory.
The resulting raster surface will be named FillRasterHolidays.csar D:\BatchSample\FillRasterHolidays.csar
and stored in the D:\BatchSample directory.
carisbatch --run FillRasterHolidays --input-band Depth --matrix 5x5 15
Command
--include-band Mean --include-band Std_Dev --Polygon-type CONVEX
Line
D:\BatchSample\Surface_2.csar D:\BatchSample\FillRasterHolidays.csar
A new raster surface will be created in the specified location with the specified name. The depth
band will be updated to include additional populated cells, based on the rules specified. In
Outcome
addition to the specified bands, a new "Depth Interpolated" band will be created in the output
raster surface.

Notes N/A

82 CARIS Batch Utility Reference Guide

BASE Editor Processes: Filter Coverage

Filter Coverage
Description The FilterCoverage process creates a new coverage with only the
nodes that pass the criteria in an expression.
Inputs A raster in a supported format.
Outputs A raster in CSAR format.
Command Line Syntax carisbatch --run FilterCoverage --include-band <value>
--expression <value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--include-band b A string specifying the name of a band to include in TRUE

the output.
The ALL keyword is used to include all bands in the
output.
--expression e A string specifying a Boolean expression. FALSE
The following operations are supported: AND, OR, +,
-, *, /, ^ (exponent), <, >, =, and != (not equal). For
example, "Depth > 1 AND Std_Dev < 2".

To use this command refer to the following examples.

Example: Filter
Uncertainty Data

Example

Objective You want to identify all valid data with an uncertainty value of less than 1m.

Description Command Line Syntax

The "Depth", "Uncertainty" and "Depth and Holidays" bands will be --include-band Depth --include-band
filtered and the results included in the output. Uncertainty --include-band "Depth and
Holidays"
The filter expression to use is: "Uncertainty < 1m AND \"Depth and --expression "Uncertainty < 1m AND
Holidays\" = 1". \"Depth and Holidays\" = 1"
The source raster is Surface.csar located in the D:\BatchSample D:\BatchSample\Surface.csar
directory.
The resulting surface will be called FilteredData.csar, and located in D:\BatchSample\FilteredData.csar
the D:\BatchSample directory.
carisbatch --run FilterCoverage --include-band Depth --include-band
Command Uncertainty --include-band "Depth and Holidays" --expression
Line "Uncertainty < 1 AND \"Depth and Holidays\" = 1"
"D:\BatchSample\Surface.csar D:\BatchSample\FilteredData.csar

CARIS Batch Utility Reference Guide 83

BASE Editor Processes: Filter Coverage

Example

A new CSAR raster is created with a subset of the data from the specified bands in
Surface.csar. The Uncertainty band is filtered according to the boolean expression to include
Outcome only nodes with an uncertainty of less than 1m, but only where the Depth and Holidays band
was populated with a value of 1. All included bands are also only populated in the locations
where all the values in the specified bands in the input coverage pass the expression filter.

Notes N/A

Example: Filter
Contributor Data

Example

You want to identify all data in a coverage that originated from the CUBE_05m_Final.csar
Objective
dataset.

Description Command Line Syntax

The "Depth" and "Contributor" bands will be filtered and the results --include-band Depth --include-band
included in the output. Contributor
The filter expression to use is: Contributor='file:///C:/Surfaces/ --expression Contributor='file:///C:/
CUBE_05m_Final.csar'. Surfaces/CUBE_05m_Final.csar'
The source raster is CombinedSurface.csar located in the D:\BatchSample\CombinedSurface.csar
D:\BatchSample directory.
The resulting surface will be called ContributorData.csar, and located D:\BatchSample\ContributorData.csar
in the D:\BatchSample directory.
carisbatch --run FilterCoverage --include-band Depth --include-band
Command Contributor --expression Contributor='file:///C:/Surfaces/
Line CUBE_05m_Final.csar' D:\BatchSample\CombinedSurface.csar
D:\BatchSample\ContributorData.csar
A new CSAR raster is created with a subset of the data from the specified bands in
Outcome CombinedSurface.csar. The only nodes in the Depth and Contributor bands that are populated
in the output are the ones with data that originated from the CUBE_05m_Final.csar dataset.

Notes N/A

84 CARIS Batch Utility Reference Guide

BASE Editor Processes: Filter Coverage

Example: Filter LAS

Data

Example

Objective You want to generate a point cloud containing only the data classified as ground or vegetation.

Description Command Line Syntax

The Classification band, originally imported from an LAS dataset, is --include-band Classification
to be included in the output.
To filter classification data values, each string value must be --expression "Classification = 'Ground'
enclosed in single quotes. To filter all terrain data, the following OR Classification = 'Low Vegetation' OR
expression is used: Classification = 'Medium Vegetation' OR
Classification = 'Ground' OR Classification = 'Low Vegetation' OR Classification = 'High Vegetation'"
Classification = 'Medium Vegetation' OR Classification = 'High
Vegetation'
The source raster is LASSurface.csar located in the D:\BatchSample D:\BatchSample\LASSurface.csar
directory.
The resulting surface will be called LASClassificationData.csar, and D:\BatchSample\LASClassificationData.c
located in the D:\BatchSample directory. sar
carisbatch --run FilterCoverage --include-band Classification --
expression "Classification = 'Ground' OR Classification = 'Low
Command
Vegetation' OR Classification = 'Medium Vegetation' OR Classification
Line
= 'High Vegetation'" D:\BatchSample\LASSurface.csar
D:\BatchSample\LASClassificationData.csar

Outcome A point cloud is created containing only the areas classified as ground or vegetation.

Notes N/A

CARIS Batch Utility Reference Guide 85

BASE Editor Processes: Finalize Raster

Finalize Raster
Description The FinalizeRaster process embeds designated soundings into
the primary elevation band of the raster dataset.
Inputs A raster surface.
Outputs A raster surface in CSAR format.
Command Line Syntax carisbatch --run FinalizeRaster [options] <input> <output>

Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--include- b A string specifying the name of a band to include in the TRUE

band output.
The ALL keyword is used to include all other bands in the
output.
--apply- a If set, designated soundings from the source of the input FALSE
designated are applied to the output.
Designated soundings in the source of the input raster
surface override the depth value at their respective
positions in the primary elevation band of the output.
--min- m A number specifying the override value for any Uncertainty FALSE
uncertainty value below this threshold.
--uncertainty- s A string specifying the source of the uncertainty value in FALSE
source the input to include in the output. One of:
• UNCERT: Uncertainty
• STD_DEV: Standard deviation (scaled to 95% CI)
• GREATER: Greater of the two values
--filter f Filter applied to primary elevation band values. FALSE
<MinValue> - A number specifying the lower bound of the
range.
<MaxValue> - A number specifying the upper bound of the
range.
Values falling outside the specified minimum and
maximum range are set to no data. Equivalent cells in
other bands included in the output are also set to no data.
--polygon- Y A string specifying the type of bounding polygon to FALSE
type generate. One of:
• CONVEX: The convex hull of the data is used for
the polygon.
• BUFFERED: A simplified buffered boundary is used
for the polygon.
The default value is BUFFERED.
--comments General comments to be added to the coverage metadata. FALSE
The default value is an empty string.

86 CARIS Batch Utility Reference Guide

BASE Editor Processes: Finalize Raster

Example To use this command refer to the following example.

Example

Objective You want to finalize a raster surface.

Description Command Line Syntax

In addition to the Depth band, all other bands will be included in the --include-band ALL
output.
The designated soundings from the source of the input raster surface --apply-designated
will be applied to the resulting surface.
The data included in the resulting surface must be within the range of --filter -0.5 100
-0.5 metres to 100.0 metres.
The source raster surface is named Surface1.csar located in the D:\BatchSample\Surface1.csar
D:\BatchSample directory.
The resulting raster surface will be called Finalized.csar located in D:\BatchSample\Finalized.csar
the D:\BatchSample directory.
carisbatch --run FinalizeRaster --include-band ALL --apply-designated
Command
--filter -0.5 100 D:\BatchSample\Surface1.csar
Line
D:\BatchSample\Finalized.csar
A new CSAR raster will be created with the same bands as Surface1.csar. The values of the
Depth band in Surface1.csar will be used to filter the values in all bands; no band will have a
Outcome
value in any location that the Depth is less than -0.5 or greater than 100. Designated
soundings from the source of Surface1.csar will also be applied to the Depth values.

Extra Notes N/A

CARIS Batch Utility Reference Guide 87

BASE Editor Processes: Finalize VR Surface

Finalize VR Surface
Description The FinalizeVRSurface process appends designated soundings to
the primary elevation band of a variable resolution surface.
Inputs A variable resolution surface in CSAR format.
Outputs A variable resolution surface in CSAR format.
Command Line Syntax carisbatch --run FinalizeVRSurface [options] <input> <output>

Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--include-band b A string specifying the name of a band to include in the TRUE

output.
The ALL keyword is used to include all other bands in the
output.
--apply- a If set, designated soundings will be retrieved from the FALSE
designated sources used to construct the input surface and appended to
the points of the output.
Designated soundings included in a variable resolution mesh
will, by default, be added to surface triangulations; options
are available to either ignore designated soundings or to
have them suppress non-designated points.
--include- d If set, additional attributes of designated soundings from FALSE
designated- source datasets will be copied into applied designated
bands soundings.
This option only applies if ApplyDesignated is set to true.
--min-uncertainty m A number specifying the override value for any Uncertainty FALSE
value below this threshold.
--uncertainty- s A string specifying the source of the uncertainty value in the FALSE
source input to include in the output. One of:
• UNCERT: Uncertainty
• STD_DEV: Standard deviation (scaled to 95% CI)
• GREATER: Greater of the two values
--filter f Filter applied to primary elevation band values. FALSE
<MinValue> - A number specifying the lower bound of the
range.
<MaxValue> - A number specifying the upper bound of the
range.
Values falling outside the specified minimum and maximum
range are set to no data. Equivalent cells in other bands
included in the output are also set to no data.

88 CARIS Batch Utility Reference Guide

BASE Editor Processes: Finalize VR Surface

Parameter

Can Notes
Long Short Description
Repeat

--polygon-type Y A string specifying the type of bounding polygon to generate. FALSE

One of:
• CONVEX: The convex hull of the data is used for the
polygon.
• BUFFERED: A simplified buffered boundary is used
for the polygon.
The default value is BUFFERED.
--comments General comments to be added to the coverage metadata. FALSE
The default value is an empty string.

Example To use this command refer to the following example.

Example

Objective You want to add designated soundings to a variable resolution surface.

Description Command Line Syntax

The Depth band is to be included in the output. --include-band Depth

Designated soundings are to be retrieved from the sources used to --apply-designated
create the variable resolution surface.
Attributes for designated soundings from the source datasets are to --include-designated-bands
be included.
Any data with an uncertainty less than 0.5 will be assigned this --min-uncertainty 0.5
threshold value.
Uncertainty in the source data will be determined using the --uncertainty-source GREATER
GREATER option.
The input surface is named OriginalVR.csar and is in the D:\BatchSample\OriginalVR.csar
BatchSample directory on the D: drive.
The output surface will be named FinalizedVR.csar and will be in the D:\BatchSample\FinalizedVR.csar
source directory.
carisbatch --run FinalizeVRSurface --include-band Depth --apply-
Command designated --include-designated-bands --min-uncertainty 0.5 --
Line uncertainty-source GREATER D:\BatchSample\OriginalVR.csar
D:\BatchSample\FinalizedVR.csar
A new surface is created in the specified location. This surface will contain the designated
Outcome soundings and their attributes from all datasets used to create the variable resolution surface.
All data with an uncertainty of less than 0.5 will be set as having an uncertainty of 0.5.

Notes

CARIS Batch Utility Reference Guide 89

BASE Editor Processes: Generalize Raster

Generalize Raster
Description The GeneralizeRaster process modifies elevation values to
produce a smoother surface. A 3D double buffering rolling ball
algorithm is applied.
Inputs A raster surface. A BDB Server URI can be specified as input.
Outputs A raster surface in CSAR format. The output will have the same
CRS and approximately the same extents as the input.
Command Line Syntax carisbatch --run GeneralizeRaster --resolution <value> --radius
<value> [options] <input> <output>

Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--include-band b A string specifying the name of a band to include in TRUE

the output.
The ALL keyword is used to include all other bands in
the output.
--resolution R A number and unit specifying the resolution of the FALSE This must be
output raster. specified explicitly.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, Changing the
mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg resolution causes
and rad. the WarpRaster
process to be run.
--radius a A number specifying the radius that can affect an FALSE This must be
output cell. specified explicitly.
Input cells within this radius of an output cell are
considered by the 3D double buffering (rolling ball)
generalization algorithm and may affect the output
cell.
The unit must be specified.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m,
mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg
and rad.
--defocus-radius d A number specifying the radius of the footprint of FALSE This is optional.
shoal input cells.
Shoal input cells are enlarged to this size; this value
must be greater than or equal to the output
resolution. This can be used to represent the
horizontal positioning uncertainty of the shoal values.
If this value is not set, defocusing is not applied.
The unit must be specified.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m,
mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg
and rad.

90 CARIS Batch Utility Reference Guide

BASE Editor Processes: Generalize Raster

Parameter

Can Notes
Long Short Description
Repeat

--apply- g If set, designated soundings from the input will be FALSE

designated applied.
--polygon-type Y A string specifying the type of bounding polygon to FALSE
generate. One of:
• CONVEX: The convex hull of the data is used
for the polygon.
• BUFFERED: A simplified buffered boundary is
used for the polygon.
The default value is BUFFERED.
--comments General comments to be added to the coverage FALSE
metadata.
The default value is an empty string.

Example To use this command refer to the following example.

Example

Objective You want to create a product surface by generalizing an existing raster surface.

Description Command Line Syntax

The generalization radius is 400 metres. --radius 400m

The resolution to be used for the resulting surface is 20 metres. --resolution 20m
Designated soundings are to be retained in the resulting surface. --apply-designated
The source surface is Surface.csar located in the D:\BatchSample D:\BatchSample\Surface.csar
directory.
The resulting surface will be called Generalized.csar, and located in D:\BatchSample\Generalized.csar
the D:\BatchSample directory.
carisbatch --run GeneralizeRaster --radius 400m --resolution 20m
Command
--apply-designated D:\BatchSample\Surface.csar
Line
D:\BatchSample\Generalized.csar

Outcome A new, generalized CSAR raster is created.

Notes N/A

CARIS Batch Utility Reference Guide 91

BASE Editor Processes: Grid Points

Grid Points
Description The GridPoints process creates a CSAR raster from a CSAR
point cloud using a gridding method.
Inputs A point cloud in CSAR format.
Outputs A raster surface in CSAR format.
Command Line Syntax carisbatch --run GridPoints --resolution <value> [options]
<input> <output>

Options The following table describes the parameters available for this
process.

Parameter

Can
Long Short Description Notes
Repeat

--primary- m A string specifying the name of the primary band of the output. FALSE
band This must be the OutputBandName of an IncludeBand.
The default value is Depth.
--resolution R A number and unit specifying the resolution of the output raster. FALSE This must
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, be
usfm, usft, usmi, usnm, usyd, yd, deg and rad. specified
explicitly.
--include- b The input band name, output band name and type of gridding to be TRUE
band performed.
<IncludeBandName> - A string specifying the name of the band in
the input.
<IncludeBandOutputBandName> - A string specifying the name of
the band in the output.
<IncludeBandOperationType> - A string specifying the type of
gridding. One of:
• COUNT: The number of input points in the cell.
• SHOAL: The highest input elevation in the cell, or greatest
value of non-elevations.
• DEEP: The lowest input elevation in the cell, or least value
of non-elevations.
• MEAN: The average input value in the cell.
• STD_DEV: The standard deviation of input values in the
cell. The degrees of freedom option affects this calculation.

92 CARIS Batch Utility Reference Guide

BASE Editor Processes: Grid Points

Parameter

Can
Long Short Description Notes
Repeat

--include- b Advanced options: TRUE

band (cont.) • STD_ERR: The standard deviation of residuals along the Z
axis with respect to the ordinary least squares plane. The
degrees of freedom is the number of input points minus two.
• DIRECTION: The direction of the ordinary least squares
plane. This is in degrees, and is the angle of the vector
<RC_X, RC_Y>. This is a mathematical angle; 0 is east and
the numbers increase counter-clockwise.
• INCLINATION: The inclination of the ordinary least squares
plane. This is in degrees, between -90 and 90. A value of 0
degrees means the plane is parallel to the CRS datum; a
value of 90 degrees means the plane is perpendicular to the
CRS datum. The sign of the inclination is controlled by the
sign of RC_X.
• RC_X: The X coefficient of the ordinary least squares plane
regression.
• RC_Y: The Y coefficient of the ordinary least squares plane
regression.
The advanced options (STD_ERR, DIRECTION, INCLINATION,
RC_X, RC_Y) are only calculated if there are at least 6 input points
in the cell. If the STD_ERR is larger than the STD_DEV, then
STD_ERR is set to be equal to STD_DEV and the other advanced
options are set to 0.
STD_DEV is only calculated if there are more points in the cell than
the number of degrees of freedom.
The input band must be a numeric type band.
--degrees- k A number used to calculate the degrees of freedom used when FALSE
of-freedom calculating standard deviation.
The number, k, gives N - k degrees of freedom, where N is the
number of input points in the cell.
The default value is 1.
--anchor A The point that defines the output raster anchor position. FALSE
<LowerX> - A number and unit specifying the lower left X origin in
the coordinate reference system of the input.
<LowerY> - A number and unit specifying the lower left Y origin in
the coordinate reference system of the input.
The anchor position is a position in the centre of a cell.
HALF_RES is used to calculate a coordinate position for a cell
centre that is half the resolution offset from a multiple of the
resolution, which creates cells that have their lower left corner at a
multiple of the resolution. Typically, the usage in this context is --
anchor HALF_RES HALF_RES.
The default value is 0.0 0.0.

CARIS Batch Utility Reference Guide 93

BASE Editor Processes: Grid Points

Parameter

Can
Long Short Description Notes
Repeat

--polygon- Y A string specifying the type of bounding polygon to generate. One FALSE
type of:
• CONVEX: The convex hull of the data is used for the
polygon.
• BUFFERED: A simplified buffered boundary is used for the
polygon.
The default value is BUFFERED.
--comments General comments to be added to the coverage metadata. FALSE
The default value is an empty string.

Example: To use this command refer to the following example:

Example

Objective You want to create a CSAR raster from a CSAR point cloud.

Description Command Line Syntax

The X anchor position is 314283m and the Y anchor position is --anchor 314283m 5419732m
5419732m, based on the coordinate reference system of the input
point cloud.
The resolution will be 2 metres. --resolution 2m
The MEAN operation will run on the Depth band of the input to --include-band Depth Depth MEAN
create a Depth band in the output.
The INCLINATION operation will run on the Depth band of the input --include-band Depth Slope INCLINATION
to create a band named Slope in the output.
For the calculation of standard deviation, the degrees of freedom is --degrees-of-freedom 2
2.
The elevation band Depth, populated using the MEAN operation, --primary-band Depth
will be assigned as the primary elevation band.
The source surface, pointcloud.csar, is located in the D:\BatchSample\pointcloud.csar
D:\BatchSample directory.
The resulting surface will be named gridpoints.csar and stored in the D:\BatchSample\gridpoints.csar
D:\BatchSample directory.
carisbatch --run GridPoints --anchor 314283m 5419732m --resolution 2m
Command --include-band Depth Depth MEAN --include-band Depth Slope INCLINATION
Line --degrees-of-freedom 2 --primary-band Depth
D:\BatchSample\pointcloud.csar D:\BatchSample\gridpoints.csar

Outcome A new CSAR raster is created in the specified location.

Extra Notes N/A

94 CARIS Batch Utility Reference Guide

BASE Editor Processes: Import Points

Import Points
Description The ImportPoints process creates a CSAR file from input points
in a specified format.
Inputs One or more point datasets in the specified input format.
Outputs A point cloud or raster surface in CSAR format.
Command Line Syntax carisbatch --run ImportPoints --input-format <value> [options]
<inputs> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can
Long Short Description Notes
Repeat

Common Options

--input- i A string specifying the format of the data to import. One FALSE This must be
format of: specified explicitly.
• ASCII: Input points are in ASCII format with user-
specifiable parsing parameters.
• CRS: Input points are in CRS format.
• CSAR: Input points are in CSAR format.
• C_AND_C: Input points are in C&C format.
• GSF: Input points are in GSF format.
• HOB: Input points are in CARIS HOB format.
• HTF: Input points are in HTF format.
• HYD93: Input points are in HYD93 format.
• LAS: Input points are in LAS or LAZ format.
• NTX: Input points are in NTX format.
• RDP: Input points are in RDP format.
--gridding- g A string specifying the gridding method used to FALSE If a gridding method
method generate the output raster. One of: is specified, a raster
• BASIC: Basic weighted mean. is created.
• TPU: Total propagated uncertainty weighted Otherwise, a point
mean. cloud is created.
• SHOAL: Shoalest depth.
• SHOAL_TRUE: Shoalest depth with true
positions.
--resolution R A number and unit specifying the resolution of the FALSE This must be
output raster. specified explicitly if
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, a GriddingMethod is
mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad. applied.

CARIS Batch Utility Reference Guide 95

BASE Editor Processes: Import Points

Parameter

Can
Long Short Description Notes
Repeat

--extent E The extents that define the window. FALSE

<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 unprojected data, an angle type unit
is required. The order for unprojected 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.
If not set, the extents are computed from the input data.
--output-crs c A string specifying the horizontal coordinate reference FALSE
system key of the output.
If specified, the data will be transformed.
--output- o A string specifying the vertical coordinate reference FALSE
vertical-crs system key of the output.
No vertical transformation will be applied even if a value
is specified. This value is only used as metadata on the
output dataset.
--compute- a A string specifying an output band to be computed from TRUE
band the input points. One of:
• SHOAL: Shoalest of all values that contributed to
populating the cell.
• DEEP: Deepest of all values that contributed to
populating the cell.
• DENSITY: Number of points that contributed to
populating the cell.
• MEAN: Mean of all values that contributed to
populating the cell.
• STD_DEV: Standard deviation of all values that
contributed to populating the cell.
--include- b A string specifying the name of a band to include in the TRUE
band output.
The ALL keyword is used to include all other bands in
the output.
--recurse u If set, points in all files that match the input description in FALSE
any subfolders are also imported.
--primary- m A string specifying the name of the primary band of the FALSE
band output.
The default value is Depth.

96 CARIS Batch Utility Reference Guide

BASE Editor Processes: Import Points

Parameter

Can
Long Short Description Notes
Repeat

--temporal- A string specifying the temporal extents of the data. FALSE Temporal extents
extent <SourceStartDate> A string specifying the start date of are automatically
the source data. populated for some
formats, such as
<SourceEndDate> A string specifying the end date of ASCII (if date/time
the source data. fields are present) or
Dates are specified in the standard ISO 8601 extended GSF. These values
date-time format for batch processes, which is YYYY- are overridden in the
MM-DDTHH:MM:SS[.sss]Z, with the time reported in output if values are
UTC. For times not in UTC, it is specified as YYYY-MM- explicitly set through
DDTHH:MM:SS[.sss]{+,-}HH:MM, where the plus or this option.
minus indicates the difference from UTC to the relevant
time zone. See ISO 8601 documentation for more
information.
--anchor A The point that defines the output raster anchor position. FALSE
<LowerX> - A number and unit specifying the lower left
X origin in the coordinate reference system of the
output.
<LowerY> - A number and unit specifying the lower left
Y origin in the coordinate reference system of the
output.
The anchor position is a position in the centre of a cell.
HALF_RES is used to calculate a coordinate position for
a cell centre that is half the resolution offset from a
multiple of the resolution, which creates cells that have
their lower left corner at a multiple of the resolution.
Typically, the usage in this context is --anchor
HALF_RES HALF_RES.
The default value is 0.0 0.0.
--polygon- Y A string specifying the type of bounding polygon to FALSE
type generate. One of:
• CONVEX: The convex hull of the data is used for
the polygon.
• BUFFERED: A simplified buffered boundary is
used for the polygon.
The default value is BUFFERED.
--comments General comments to be added to the coverage FALSE
metadata.
The default value is an empty string.

InputFormat = ASCII Options

--input-crs p A string specifying the horizontal coordinate reference FALSE This must be
system key of the input. specified explicitly.
--info-file s The path to a file that describes the format of the input FALSE This must be
ASCII files. specified explicitly.

CARIS Batch Utility Reference Guide 97

BASE Editor Processes: Import Points

Parameter

Can
Long Short Description Notes
Repeat

InputFormat = CRS Options

--z-axis- z A string specifying the input Z-axis convention. One of: FALSE
convention • UP: Z-axis is positive up.
• DOWN: Z-axis is positive down.
The default value is UP.

InputFormat = CSAR Options

N/A

InputFormat = C_AND_C Options

--input-crs p A string specifying the horizontal coordinate reference FALSE This must be
system key of the input. specified explicitly.
--z-axis- z A string specifying the input Z-axis convention. One of: FALSE
convention • UP: Z-axis is positive up.
• DOWN: Z-axis is positive down.
The default value is UP.

InputFormat = GSF Options

--z-axis- z A string specifying the input Z-axis convention. One of: FALSE
convention • UP: Z-axis is positive up.
• DOWN: Z-axis is positive down.
The default value is UP.

InputFormat = HOB Options

--feature- F A string specifying the name of the catalogue that FALSE This must be
catalogue defines the features and attributes in the input dataset. specified explicitly.
One of {list dynamically populated from the catalogue The default location
control file}. of
The catalogue must be in the catalogue control file CatalogueControl.x
specified in the Tools > Options > Files and Folders > ml file is C:\Program
Files > Catalogue Control, for example S-57 ENC 3.1. Files\CARIS\BASE
Editor\4.2\system\

InputFormat = HTF Options

--input-crs p A string specifying the horizontal coordinate reference FALSE This must be
system key of the input. specified explicitly.
--depth- d A string specifying the name of the attribute containing FALSE This must be
attribute the depth value. specified explicitly.
--depth- s A numeric multiplier used to scale the depth attribute FALSE
scale-factor value.
The default value is 1.0.
--v-uncert- t A string specifying the name of the attribute containing FALSE
attribute the vertical uncertainty value.
--x-coord- x A string specifying the name of the attribute containing FALSE This must be
attribute the X coordinate position. specified explicitly.

98 CARIS Batch Utility Reference Guide

BASE Editor Processes: Import Points

Parameter

Can
Long Short Description Notes
Repeat

--y-coord- y A string specifying the name of the attribute containing FALSE This must be
attribute the Y coordinate position. specified explicitly.
--z-axis- z A string specifying the input Z-axis convention. One of: FALSE
convention • UP: Z-axis is positive up.
• DOWN: Z-axis is positive down.
The default value is UP.

InputFormat = HYD93 Options

InputFormat = LAS Options

--override- p A string specifying the horizontal coordinate reference FALSE

crs system key to override the coordinate reference system
defined in the LAS file.
--override- C The path to a file with classification identifiers and FALSE
classification names.
-file This option is used to import LAS data using a custom
set of classifications rather than the default
classifications defined in the specifications for the LAS
version.
The classification file must be in a text file format, such
as TXT or CSV, and contain two columns, one for the
classification ID number and one for the name of the
classification. The two columns must be separated by a
comma, or one or more spaces. If the data being
imported contains an ID that is not present in the
mapping file, the default classification for the LAS
version will be used for that ID.
--override- M A classification mapping for a single value that overrides TRUE
classification the mapping defined in the LAS standard.
-mapping <Number> - A number specifying the value that is to
have its meaning overridden.
<Name> - The name to associate with this value.
This option is used to import LAS data using a custom
set of classifications rather than the default
classifications defined in the specifications for the LAS
version.
Two mappings cannot be specified for the same
classification ID number.
If an override classification file and override
classification mappings are both specified, only the
mappings are applied.

CARIS Batch Utility Reference Guide 99

BASE Editor Processes: Import Points

Parameter

Can
Long Short Description Notes
Repeat

--use-las- d If set, the extents in the LAS file will be applied. FALSE
extent
--z-axis- z A string specifying the input Z-axis convention. One of: FALSE
convention • UP: Z-axis is positive up.
• DOWN: Z-axis is positive down.
The default value is UP.
--flag- A string specifying how to map the Synthetic LAS flag. FALSE
synthetic One of:
• ACCEPT: Soundings with the Synthetic LAS flag
are set with the status of accepted.
• REJECT: Soundings with the Synthetic LAS flag
are set with the status of rejected.
• DESIGNATE: Soundings with the Synthetic LAS
flag are set with the status of designated.
The default value is ACCEPT.
--flag-key- A string specifying how to map the Key_Point LAS flag. FALSE
point One of:
• ACCEPT: Soundings with the Key_Point LAS
flag are set with the status of accepted.
• REJECT: Soundings with the Key_Point LAS flag
are set with the status of rejected.
• DESIGNATE: Soundings with the Key_Point
LAS flag are set with the status of designated.
The default value is ACCEPT.
--flag-overlap A string specifying how to map the Overlap LAS flag. FALSE
One of:
• ACCEPT: Soundings with the Overlap LAS flag
are set with the status of accepted.
• REJECT: Soundings with the Overlap LAS flag
are set with the status of rejected.
• DESIGNATE: Soundings with the Overlap LAS
flag are set with the status of designated.
The default value is ACCEPT.
--flag- A string specifying how to map the Withheld LAS flag. FALSE
withheld One of:
• ACCEPT: Soundings with the Withheld LAS flag
are set with the status of accepted.
• REJECT: Soundings with the Withheld LAS flag
are set with the status of rejected.
• DESIGNATE: Soundings with the Withheld LAS
flag are set with the status of designated.
The default value is REJECT.

100 CARIS Batch Utility Reference Guide

BASE Editor Processes: Import Points

Parameter

Can
Long Short Description Notes
Repeat

--reference- The timestamp indicating the reference week for GPS FALSE
week Week Time.
Dates are specified in the standard ISO 8601 extended
format for batch processes, which is YYYY-MM-DD or
YYYY-DDD. See ISO 8601 documentation for more
information.
Note that any date/time within the week can be
specified, and the start day of the week will be
calculated by the application.

InputFormat = NTX

--flag- s A string specifying how to apply the Selected NTX flag. FALSE
selected One of:
• ACCEPT: Soundings with the Selected NTX flag
are set with the status of accepted.
• REJECT: Soundings with the Selected NTX flag
are set with the status of rejected.
The default value is ACCEPT.
--flag- d A string specifying how to apply the Suppressed NTX FALSE
suppressed flag. One of:
• ACCEPT: Soundings with the Suppressed NTX
flag are set with the status of accepted.
• REJECT: Soundings with the Suppressed NTX
flag are set with the status of rejected.
The default value is REJECT.
--flag- k A string specifying how to apply the Background NTX FALSE
background flag. One of:
• ACCEPT: Soundings with the Background NTX
flag are set with the status of accepted.
• REJECT: Soundings with the Background NTX
flag are set with the status of rejected.
The default value is REJECT.
--include-3D- t A string specifying the feature code of a 3D symbol to TRUE
symbol include.
The ALL keyword is used to include all 3D symbols.
--z-axis- z A string specifying the input Z-axis convention. One of: FALSE
convention • UP: Z-axis is positive up.
• DOWN: Z-axis is positive down.
The default value is UP.

InputFormat = RDP Options

--z-axis- z A string specifying the input Z-axis convention. One of: FALSE .
convention • UP: Z-axis is positive up.
• DOWN: Z-axis is positive down.
The default value is UP

To use this command refer to the following examples.

CARIS Batch Utility Reference Guide 101

BASE Editor Processes: Import Points

Example 1: ASCII to
Point Cloud

Example

Objective You want to create a CSAR point cloud from input points in an ASCII file.

Description Command Line Syntax

The source data is in the ASCII format. --input-format ASCII

The input coordinate reference system and the output coordinate --input-crs UTM-19N-Nad83 --output-crs
reference system are both UTM-19N-Nad83. UTM-19N-Nad83
The format information file, EastingNorthingDepth.info, is located --info-file
at D:\BatchSample. D:\BatchSample\EastingNorthingDepth.info
The source start and end dates from the source data are to be --temporal-extent "2017-05-
overridden with the following in the output: 10T13:35:00+04:00" "2017-05-
• May 10, 2017, 1:35pm AST 10T16:47:00+04:00"
• May 10, 2017, 4:47pm AST
The input file, Sample.xyz.ascii, is located at D:\BatchSample. D:\BatchSample\Sample.xyz.ascii
The resulting CSAR file will be named ImportedFromASCII.csar D:\BatchSample\ImportedFromASCII.csar
and will be created in the D:\BatchSample directory.
carisbatch --run ImportPoints --input-format ASCII --input-crs UTM-19N-
Nad83 --output-crs UTM-19N-Nad83 --info-file
Command
D:\BatchSample\EastingNorthingDepth.info --temporal-extent "2017-05-
Line
10T13:35:00+04:00" "2017-05-10T16:47:00+04:00"
D:\BatchSample\Sample.xyz.ascii D:\BatchSample\ImportedFromASCII.csar

Outcome A new CSAR point cloud is created in the specified location.

Extra Notes N/A

Example 2: ASCII to
Gridded Raster

Example

You want to create a gridded raster surface CSAR file from multiple input point clouds in the ASCII
Objective
format.

Description Command Line Syntax

The source data is in the ASCII format. --input-format ASCII

The input coordinate system and the output coordinate system --input-crs UTM-19N-Nad83 --output-crs
are both UTM-19N-Nad83. UTM-19N-Nad83
The gridding method is shoalest depth. --gridding-method SHOAL
The resolution of the output raster is 20m. --resolution 20m
The format information file, EastingNorthingDepth.info, is located --info-file
at D:\BatchSample. D:\BatchSample\EastingNorthingDepth.info
In addition to the primary band, Depth, the resulting surface will --compute-band SHOAL --compute-band
have the following computed attributes: Shoal and Standard STD_DEV
deviation.

102 CARIS Batch Utility Reference Guide

BASE Editor Processes: Import Points

Example

The files Survey2.xyz.ascii, Survey3.xyz.ascii and D:\BatchSample\Survey2.xyz.ascii

Survey4.xyz.ascii will all be imported from D:\BatchSample. D:\BatchSample\Survey3.xyz.ascii
D:\BatchSample\Survey4.xyz.ascii
The output will be a single CSAR file named D:\BatchSample\ImportedFromASCII_2.csar
ImportedFromASCII_2.csar created in the D:\BatchSample
directory.
carisbatch --run ImportPoints --input-format ASCII --input-crs UTM-
19N-Nad83 --output-crs UTM-19N-Nad83 --gridding-method SHOAL
Command --resolution 20m --info-file D:\BatchSample\EastingNorthingDepth.info
Line --compute-band SHOAL --compute-band STD_DEV
D:\BatchSample\Survey2.xyz.ascii D:\BatchSample\Survey3.xyz.ascii
D:\BatchSample\Survey4.xyz.ascii D:\BatchSample\ImportedFromASCII_2.csar

Outcome A single raster surface in CSAR format is created in the designated location.

Extra N/A
Notes

Example 3: LAS to Point

Cloud

Example

Objective You want to create a point cloud in CSAR format from a file in LAS format.

Description Command Line Syntax

The input format is LAS. --input-format LAS

All attribute bands from the source data will be included in the --include-band ALL
import.
The import will use the WG84 coordinate reference system (CRS) --override-crs WG84
as there is no CRS specified in the LAS header.
Import data within the extents specified in the LAS header. --use-las-extent
The LAS status flags are to be mapped as follows: --flag-synthetic ACCEPT --flag-key-point
• Synthetic = Accepted DESIGNATED --flag-overlap ACCEPT --
• Key Point = Designated flag-withheld REJECT
• Overlap = Accepted
• Withheld = Rejected
The input file, Sample.las, is located at D:\BatchSample. D:\BatchSample\Sample.las
The resulting CSAR file will be named ImportLAS.csar and will be D:\BatchSample\ImportLAS.csar
created in the D:\BatchSample directory.
carisbatch -r ImportPoints --input-format LAS --include-band ALL --
Command override-crs WG84 --use-las-extent --flag-synthetic ACCEPT --flag-key-
Line point DESIGNATED --flag-overlap ACCEPT --flag-withheld REJECT
D:\BatchSample\Sample.las D:\BatchSample\ImportLAS.csar

Outcome A new point cloud in CSAR format with the LAS flags mapped to the Status band.

Extra Notes N/A

CARIS Batch Utility Reference Guide 103

BASE Editor Processes: Import Points

Example 4: NTX to
Point Cloud

Example

Objective You want to create a point cloud in CSAR format from a file in NTX format.

Description Command Line Syntax

The input format is NTX. --input-format NTX

In addition to accepting Selected NTX soundings (the default --flag-suppressed ACCEPT
behaviour), Suppressed NTX soundings will also be accepted.
All 3D symbols will be included. --include-3D-symbol ALL
The input z-axis convention is positive down. --z-axis-convention DOWN
The following dates are to be output for the source start and end --temporal-extent "2017-05-24T09:27:00Z"
dates: "2017-05-26T13:53:00Z"
• May 24, 2017, 9:27am UTC
• May 26, 2017, 1:53pm UTC
The input file, Sample.ntx, is located at D:\BatchSample. D:\BatchSample\Sample.ntx
The resulting CSAR file will be named ImportNTX.csar and will be D;\BatchSample\ImportNTX.csar
created in the D:\BatchSample directory.
carisbatch --run ImportPoints --input-format NTX --flag-suppressed
Command ACCEPT --include-3D-symbol ALL --z-axis-convention DOWN --temporal-
Line extent "2017-05-24T09:27:00Z" "2017-05-26T13:53:00Z"
D:\BatchSample\Sample.ntx D:\BatchSample\ImportNTX.csar

Outcome A new point cloud in CSAR format is created in the specified location.

Extra Notes N/A

Example 5: Multiple
GSF to Point Cloud

Example

You want to create a point cloud in CSAR format from multiple files in GSF format. The files are
Objective
spread across various sub-folders of a GSF file folder.

Description Command Line Syntax

The input format is GSF. --input-format GSF

Files in sub-folders will be imported. --recurse
All bands in the source data will be imported. --include-band ALL
The input z-axis convention is positive down. --z-axis-convention DOWN
Import all files in the folder and sub-folders of D:\BatchSample\GSF\*.gsf
D:\BatchSample\GSF.
The resulting CSAR file will be named ImportGSF.csar and will be D;\BatchSample\GSF\ImportGSF.csar
created in the D:\BatchSample\GSF directory.

104 CARIS Batch Utility Reference Guide

BASE Editor Processes: Import Points

Example

carisbatch --run ImportPoints --input-format GSF --recurse --include-

Command
band ALL --z-axis-convention DOWN D:\BatchSample\GSF\*.gsf
Line
D:\BatchSample\GSF\ImportGSF.csar
A new point cloud in CSAR format is created in the specified location containing data from all
Outcome
GSF files in the specified source directory and its sub-folders.

Extra Notes N/A

CARIS Batch Utility Reference Guide 105

BASE Editor Processes: Import VR Surface

Import VR Surface
Description The ImportVRSurface process creates a CSAR file from an input
variable resolution surface in a specified format.
Inputs A variable resolution surface in the specified format.
Outputs A variable resolution surface in CSAR format.
Command Line Syntax carisbatch --run ImportVRSurface --input-format <value>
[options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--input-format A string specifying the format of the data to import. FALSE

• BAG: Input is a BAG raster with variable
resolution refinement grids.
BAG 1.6.0 was the first version to introduce support for
variable resolution refinement grids.
--polygon- Y A string specifying the type of bounding polygon to FALSE
type generate. One of:
• CONVEX: The convex hull of the data is used for
the polygon.
• BUFFERED: A simplified buffered boundary is
used for the polygon.
The default value is BUFFERED.
--comments General comments to be added to the coverage FALSE
metadata.
The default value is an empty string.

Example To use this command refer to the following example.

Example

Objective You want to import a BAG raster to create a new variable resolution surface in CSAR format.

Description Command Line Syntax

The input format is BAG. --input-format BAG

A buffered bounding polygon is to be genereated. --polygon-type BUFFERED
The source BAG file is named BAGRaster.bag and is in the D:\BatchSample\BAGRaster.bag
BatchSample directory on the D: dirve.
The output variable resolution surface will be called BAG2VR.csar D:\BatchSample\BAG2VR.csar
and will be saved in the same location as the input surface.

Command carisbatch --run ImportVRSurface --input-format BAG --polygon-type

Line BUFFERED D:\BatchSample\BAGRaster.bag D:\BatchSample\BAG2VR.csar

Outcome A new variable resolution surface is created in CSAR format in the specified location.

106 CARIS Batch Utility Reference Guide

BASE Editor Processes: Import VR Surface

Example

Extra Notes

CARIS Batch Utility Reference Guide 107

BASE Editor Processes: Join Points

Join Points
Description The JoinPoints process creates a new point cloud from the points
in the inputs.
Inputs Two or more point clouds. The locations can be specified by file
paths or URIs.
Outputs A point cloud in CSAR format. The location can be specified by a
file path or a URI.
Command Line Syntax carisbatch --run JoinPoints --output-crs <value> [options]
<inputs> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--primary- m A string specifying the name of the primary elevation FALSE

band band of the output.
The default value is Depth.
--contributor- C A string specifying an attribute value to be included in TRUE
attribute the Contributor layer.
The Contributor for each point is populated with a list of
the local CSAR metadata values from the source that is
copied to the output point cloud.
The default value is uri.
--output-crs c A string specifying the horizontal coordinate reference FALSE This must be
system key of the output. specified explicitly.
--extent E The extents that define the window. FALSE
<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 unprojected data, an angle type unit
is required. The order for unprojected 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.

108 CARIS Batch Utility Reference Guide

BASE Editor Processes: Join Points

Parameter

Can Notes
Long Short Description
Repeat

--polygon- Y A string specifying the type of bounding polygon to FALSE .

type generate. One of:
• CONVEX: The convex hull of the data is used for
the polygon.
• BUFFERED: A simplified buffered boundary is
used for the polygon.
The default value is BUFFERED.
--comments General comments to be added to the coverage FALSE
metadata.
The default value is an empty string.

Example To use this command refer to the following example.

Example

Objective You need to join the data in three point clouds into one new point cloud.

Description Command Line Syntax

The primary elevation band will be Depth. --primary-band Depth

The output coordinate reference system will be UTM 30N. --output-crs UTM-30N
The input files are: D:\BatchSample\Cloud1.csar
D:\BatchSample\Cloud1.csar D:\BatchSample\Cloud2.csar
D:\BatchSample\Cloud3.csar
D:\BatchSample\Cloud2.csar
D:\BatchSample\Cloud3.csar
A new file, with the name Joined.csar, will be created in the D:\BatchSample\Joined.csar
BatchSample folder.
carisbatch --run JoinPoints --primary-band Depth --output-crs UTM-30N
Command
D:\BatchSample\Cloud1.csar D:\BatchSample\Cloud2.csar
Line
D:\BatchSample\Cloud3.csar D:\BatchSample\Joined.csar

Outcome The three input point clouds are joined into a single new point cloud in the location specified.

The resulting point cloud will contain the points and their attributes from the input sources and
Extra Notes
a new automatically generated boundary polygon.

CARIS Batch Utility Reference Guide 109

BASE Editor Processes: Populate VR Surface

Populate VR Surface
Description The PopulateVRSurface process populates an empty variable
resolution csar file with values to treat as a variable resolution
surface, or with interpolated nodes based on one or more
sources. Several node creation options are available.
Update An empty variable resolution surface with a valid resolution
map.
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 based on the input
variable resolution surface in CSAR format.
Command Line Syntax carisbatch --run PopulateVRSurface --population-method
<value> --include-flag <value> [options] <inputs> <update>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--population- P The method used to populate nodes for surface creation. FALSE This must be
method One of: specified
• USE_ORIGINAL: Keep the original source points explicitly.
with no re-sampling
• MEAN: Interpolate points using simple mean
• IDW: Interpolate points using inverse distance
weighting
• UNCERTAINTY: Interpolate points using TPU
weighted mean
• CUBE: Generate hypotheses using CUBE
algorithms
• SELECT: Sample the shoalest or deepest point
per bin
• SWATH_ANGLE: Interpolate points using Swath
Angle weighting
--input-band i A string specifying the name of the input band. FALSE
If not set, the primary elevation band of the source will be
used.
--include-flag A string specifying a status flag to be included for the TRUE This must be
operation. explicitly
• ACCEPTED: Accepted status flag specified.
• EXAMINED: Examined status flag
• OUTSTANDING: Outstanding status flag
• REJECTED: Rejected status flag
• SUPPRESSED: Suppressed status flag
--primary-band m A string specifying the name given to the primary band of FALSE
the output.
The default value is Depth.

110 CARIS Batch Utility Reference Guide

BASE Editor Processes: Populate VR Surface

Parameter

Can Notes
Long Short Description
Repeat

--polygon-type Y A string specifying the type of bounding polygon to FALSE

generate. One of:
• CONVEX: The convex hull of the data is used for
the polygon.
• BUFFERED: A simplified buffered boundary is
used for the polygon.
The default value is BUFFERED.
--keep-up-to-date If set, enables the Keep Up to Date setting. FALSE
--comments General comments to be added to the coverage FALSE
metadata.
The default value is an empty string.

PopulationMethod = MEAN Options

--neighbourhood- The shape of the neighbourhood used to compute the FALSE

shape points in the variable resolution surface. One of:
• SQUARE: Use grid-aligned neighbourhoods
• CIRCLE: Use radius-based neighbourhoods
The default value is SQUARE.
--neighbourhood- The fixed size component, as a distance, of the FALSE
fixed neighbourhood used to compute the points in the variable
resolution surface. This option can be combined with
NeighbourhoodBins.
The default value is 0.0. The value can be any positive
number.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi,
mm, nm, usfm, usft, usmi, usnm, usyd, yd.
--neighbourhood- The bin-size component, as a radius based on a number FALSE
bins of bins, of the neighbourhood used to compute the points
in the variable resolution surface. This option can be
combined with NeighbourhoodFixed.
The default value is 1. The value can be any positive
number.
--minimum- A number specifying the minimum samples for an FALSE
samples interpolation node to be considered valid.
The default value is 1. The value can be any positive
number.

PopulationMethod = IDW Options

--neighbourhood- The shape of the neighbourhood used to compute the FALSE

shape points in the VR surface. One of:
• SQUARE: Use grid-aligned neighbourhoods.
• CIRCLE: Use radius-based neighbourhoods.
The default value is SQUARE.

CARIS Batch Utility Reference Guide 111

BASE Editor Processes: Populate VR Surface

Parameter

Can Notes
Long Short Description
Repeat

--neighbourhood- The fixed size component, as a distance, of the FALSE

fixed neighbourhood used to compute the points in the variable
resolution surface. This option can be combined with
NeighbourhoodBins.
The default value is 0.0. The value can be any positive
number.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi,
mm, nm, usfm, usft, usmi, usnm, usyd, yd.
--neighbourhood- The bin-size component, as a radius based on a number FALSE
bins of bins, of the neighbourhood used to compute the points
in the variable resolution surface. This option can be
combined with NeighbourhoodFixed.
The default value is 1. The value can be any positive
number.
--idw-power A number specifying the exponent to use for inverse FALSE
distance weighting.
The default value is 1.0. The value can be any positive
number.
--minimum- A number specifying the minimum samples for an FALSE
samples interpolation node to be considered valid.
The default value is 1. The value can be any positive
number.

PopulationMethod = UNCERTAINTY Options

112 CARIS Batch Utility Reference Guide

BASE Editor Processes: Populate VR Surface

Parameter

Can Notes
Long Short Description
Repeat

--polygon-type Y A string specifying the type of bounding polygon to FALSE

PopulationMethod = MEAN Options

--neighbourhood- The shape of the neighbourhood used to compute the FALSE

PopulationMethod = IDW Options

--neighbourhood- The shape of the neighbourhood used to compute the FALSE

shape points in the VR surface. One of:
• SQUARE: Use grid-aligned neighbourhoods.
• CIRCLE: Use radius-based neighbourhoods.
The default value is SQUARE.

CARIS Batch Utility Reference Guide 113

BASE Editor Processes: Populate VR Surface

Parameter

Can Notes
Long Short Description
Repeat

--neighbourhood- The fixed size component, as a distance, of the FALSE

PopulationMethod = UNCERTAINTY Options

114 CARIS Batch Utility Reference Guide

Example

Objective You want to populate an empty variable resolution map using the CUBE method.

Description Command Line Syntax

The population method is CUBE. --population-method CUBE

The Density and Locale disambiguation method is being used. --disambiguation-method
DENSITY_AND_LOCALE
The IHO Order being used is S44_1A. --iho-order S44_1A
The trackline data with which to populate the VR map is: file:///D:/ file:///D:/BatchSample/input/
BatchSample/input/input.hips?Vessel=sample;Day=2000-001. input.hips?Vessel=sample;Day=2000-001
The variable resolution map is named VRSurface.csar and is D:\BatchSample\VRSurface.csar
located at D:\BatchSample.

CARIS Batch Utility Reference Guide 117

BASE Editor Processes: Populate VR Surface

Example

carisbatch --run PopulateVRSurface --population-method CUBE --

Command disambiguation-method DENSITY_AND_LOCALE --iho-order S44_1A file:///
Line file:///D:/BatchSample/input/input.hips?Vessel=sample;Day=2000-001
D:\BatchSample\VRSurface.csar

Outcome The source data is added to the variable resolution map to create a variable resolution surface.

Extra Notes N/A

Example: MEAN
Population Method

Example

Objective You want to populate an empty variable resolution map using the MEAN population method.

Description Command Line Syntax

The population method is MEAN. --population-method MEAN

The neighbourhood shape used to compute the points in the VR is --neighbourhood-shape CIRCLE
CIRCLE.
The variable resolution map is named VRSurface.csar and is D:\BatchSample\VRSurface.csar
located at D:\BatchSample.
The input source file containing the points to populate the VR is D:\BatchSample\SourcePoints.csar
SourcePoints.csar and is located at D:\BatchSample.
carisbatch --run PopulateVRSurface --population-method MEAN --
Command
neighbourhood-shape CIRCLE D:\BatchSample\SourcePoints.csar
Line
D:\BatchSample\VRSurface.csar

Outcome The source data is added to the variable resolution map to create a variable resolution surface.

Extra Notes N/A

118 CARIS Batch Utility Reference Guide

BASE Editor Processes: Rebalance Points

Rebalance Points
Description The RebalancePoints process modifies the point cloud to ensure a
more uniform visualization by adjusting which points are shown
at each display level. Note that this may have some performance
impact on processes that are more efficient with the original
distribution, such as selection.
Update A point cloud in CSAR format.
Outputs No output is generated. The input coverage is modified.
Command Line Syntax carisbatch --run RebalancePoints <update>
Options None.

Example To use this command refer to the following example.

Example

Objective You want to display a point cloud in 3D with more uniform detail across the entire coverage.

Description Command Line Syntax

The point cloud to be updated is SampleCloud.csar and is located at D:\BatchSample\SampleCloud.csar

D:\BatchSample.

Command carisbatch --run RebalancePoints D:\BatchSample\SampleCloud.csar

Line

Outcome The point cloud now displays with a more uniform level of detail.

Extra Notes N/A

CARIS Batch Utility Reference Guide 119

BASE Editor 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>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--update- The type of operation to update with new data. One of: FALSE
type • RESOLUTION: Update resolution estimates
• SURFACE: Update surface nodes
• BOTH: Update both resolution estimates and
surface nodes.
The default value is BOTH.

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/
file:///D:/BatchSample/input/ input.hips?Vessel=sample;Day=
input.hips?Vessel=sample;Day=2000-001 2000-001
The VR surface to be updated is VRSurface.csar located at D:\BatchSample\VRSurface.csar
D:\BatchSample.
carisbatch --run RemoveFromVRSurface --update-type SURFACE file:///
Command Line 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

120 CARIS Batch Utility Reference Guide

BASE Editor Processes: Render Raster

Render Raster
Description The RenderRaster process exports a raster band to an image by
converting the values into colours. The output raster will have
the same dimensions, coordinate reference system and
geographic extent as the input.
Inputs A raster dataset with a numeric band.
Outputs A raster image in CSAR format.
Command Line Syntax carisbatch --run RenderRaster --input-band <value> [options]
<input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--input-band i A string specifying the name of the input band. FALSE This must be specified
explicitly.
--colour-file c The name of the colour map file to use when FALSE Default location of
rendering the raster. Colour folder is
The file must be in the directory specified in the C:\ProgramData\CARIS\
Tools > Options > Files and Folders > Folders BASE Editor\4.2\Colour.
> Colour Maps, for example Rainbow.cma.
The default value is "Rainbow.cma".
--colour-range G The values that will map onto the first and last FALSE
colours in the colour map.
<MinValue> - A number specifying the value
that will map onto the first colour in the colour
map.
<MaxValue> - A number specifying the value
that will map onto the last colour in the colour
map.
--reverse-colours R If set, the colour map is applied in the reverse FALSE
order.
--enable-shading e If set, shading is applied.
--shading s The sun shading parameters used when FALSE
rendering the raster.
<AzimuthAngle> - A number specifying the
azimuth angle applied for sun shading in
degrees.
<ElevationAngle> - A number specifying the
elevation angle applied for shading in degrees.
<Exaggeration> - A number specifying the
multiplier for each band value. This must be a
positive number.
The default value is 45.0 45.0 1.0.

CARIS Batch Utility Reference Guide 121

BASE Editor Processes: Render Raster

Parameter

Can Notes
Long Short Description
Repeat

--filter f Filter the input bands by setting those outside FALSE

the specified range to NO-DATA.
<MinValue> - A number specifying the range's
lower bound.
<MaxValue> - A number specifying the range's
upper bound.
--transparency t A number specifying the transparency, as a FALSE
percentage.
The default value is 0, no transparency. 100 is
fully transparent. 0 is fully opaque.

Example To use this command refer to the following example.

Example

Objective You want to export a raster band to an image.

Description Command Line Syntax

The input raster band is depth. --input-band Depth

The 10colours.cma colour map is applied to the output. --colour-file 10colours.cma
Shading is enabled. --enable-shading
For shading, the azimuth angle is 30, the elevation angle is 40 and --shading 30 40 2
the exaggeration is 2.
The source surface, Surface1.csar, is located at D:\BatchSample. D:\BatchSample\Surface1.csar
The resulting CSAR raster will be created in the D:\BatchSample D:\BatchSample\Rendered.csar
directory with the name Rendered.csar.
carisbatch --run RenderRaster --input-band Depth --colour-file
Command
10colours.cma --enable-shading --shading 30 40 2
Line
D:\BatchSample\Surface1.csar D:\BatchSample\Rendered.csar

Outcome A CSAR raster image is created in the specified folder.

Extra Notes N/A

122 CARIS Batch Utility Reference Guide

BASE Editor Processes: Repair Coverage

Repair Coverage
The RepairCoverage process modifies a coverage to fix specified
issues.
Inputs A point cloud.
Outputs A point cloud in CSAR format.
Command Line Syntax carisbatch --run RepairCoverage [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--reindex- If set, the internal indexing of the point cloud will be FALSE
cloud re-created.
This fixes issues caused by duplicate values in the
internal indexing.

Example To use this command refer to the following example.

Example

Objective You want to recreate the internal indexing of a point cloud to remove duplicate index values.

Description Command Line Syntax

The reindex cloud fix will be applied. --reindex-cloud

The input surface is named DuplicateIndexCloud.csar and is in the D:\BatchSample\DuplicateIndexCloud.c
BatchSample directory on the D: drive. sar
The output surface will be named ReindexedCloud.csar and will be in D:\BatchSample\ReindexedCloud.csar
the source directory.
carisbatch --run RepairCoverage --reindex-cloud
Command Line D:\BatchSample\DuplicateIndexCloud.csar
D:\BatchSample\ReindexedCloud.csar

Outcome A new point cloud with fully unique internal indexing values.

Extra Notes N/A

CARIS Batch Utility Reference Guide 123

BASE Editor Processes: Resample Surface To Raster

Resample Surface To Raster

Description The ResampleSurfaceToRaster process creates a fixed resolution
raster surface by interpolating a fixed or variable resolution
surface at a single resolution.
Inputs A surface in CSAR format.
Outputs A raster surface in CSAR format.
Command Line Syntax carisbatch --run ResampleSurfaceToRaster --resolution <value>
[options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--resolution R A number and unit specifying the resolution of the output FALSE This must be
raster. specified
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, explicitly.
nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.
--extent E The extents that defines the window. FALSE
<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 unprojected data, an angle type unit is
required. The order for unprojected 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.
If not set, the cover of the data will be used.
--type The type of interpolation to be performed. One of: FALSE
• LINEAR: Use linear interpolation
• LINEAR_UNCERTAINTY: Use linear interpolation with
uncertainty
• NATURAL_NEIGHBOUR: Use natural neighbour
interpolation
• NATURAL_NEIGHBOUR_UNCERTAINTY: Use natural
neighbour interpolation with uncertainty
The default value is LINEAR.

124 CARIS Batch Utility Reference Guide

BASE Editor Processes: Resample Surface To Raster

Parameter

Can Notes
Long Short Description
Repeat

--minimum- A number specifying the minimum number of neighbours for FALSE

neighbours calculating uncertainty.
The default value is 50. The valid range is 0 or greater.
This is only used when interpolating with uncertainty.
--tautness A list of numbers specifying two tautness values. FALSE
<Tautness1> - Controls the slope of the inflection point on an
exponential curve.
<Tautness2> - Controls the position of the inflection point on
an exponential curve.
The default values are 5.0 and 5.0. Both values must be
provided.
This is only applicable when performing natural neighbour
interpolation.
--grid- The grid linearity style to use when performing natural FALSE
linearity neighbour interpolation. One of:
• LINEAR_ONLY: Always use linear gridding
• NON_LINEAR: Always use non-linear gridding
• NON_LINEAR_EXCEPT_PERIMETER: Use non-linear
gridding except near perimeter, where linear is then
used
The default is LINEAR_ONLY.

Example To use this command refer to the following example.

Example

Objective You want to create a single resolution surface from a variable resolution surface.

Description Command Line Syntax

The output surface will have a resolution of 2m. --resolution 2m

The node values will be calculated using the --type LINEAR_UNCERTAINTY
LINEAR_UNCERTAINTY interpolation method.
A minimum of 10 neighbouring nodes must be populated to --minimum-neighbours 10
interpolate the node values.
The input surface is named VariableResolution.csar and is in the D:\BatchSample\VariableResolution.csa
BatchSample directory on the D: drive. r
The output surface will be named RasterSurface.csar and will be in D:\BatchSample\RasterSurface.csar
the source directory.
carisbatch --run ResampleSurfaceToRaster --resolution 2m --type
LINEAR_UNCERTAINTY --minimum-neighbours 10
Command Line
D:\BatchSample\VariableResolution.csar
D:\BatchSample\RasterSurface.csar
A new single-resolution surface is interpolated from the variable resolution surface and saved
Outcome
to the location specified.

Extra Notes N/A

CARIS Batch Utility Reference Guide 125

BASE Editor Processes: Server Add to Raster Combine

Server Add to Raster Combine

Description The ServerAddToRasterCombine process adds sources to an
existing combined raster using the server combine process
parameters stored in the CSAR metadata. This produces the
same result as doing the original combine with all of the sources.
Inputs The first input must be a CSAR raster surface that was
generated by a server combine process. The second input is one
or more raster surfaces, point clouds and/or variable resolution
surfaces. The inputs can be specified by object BOIDs and/or
CRFX query files. Datasets that were previously considered for
the first input cannot be specified a second time.
Outputs A CSAR raster surface. The location can be specified by a file
path or a URI.
Command Line Syntax carisbatch --run ServerAddToRasterCombine --login <value> --
database-name <value> [options] <inputs> <output>
Options The following table describes the parameters available for this
process.

BASE Editor Processes: Server Combine to Raster

Parameter

Can Notes
Long Short Description
Repeat

--confine- f A string specifying how to consider holes as valid data FALSE

CARIS Batch Utility Reference Guide 129

BASE Editor Processes: Server Combine to Raster

Parameter

Can Notes
Long Short Description
Repeat

--comments General comments to be added to the coverage

metadata.
The default value is an empty string.
--primary-band m A string specifying the name of the primary elevation
band of the output.
The default value is Depth.
--output-crs c A string specifying the horizontal coordinate reference This must be
system key of the output. specified explicitly.

Example To use this command refer to the following example.

Example

You want to combine two raster database surfaces, with specified geographic extents, into a new
Objective
CSAR raster.

Description Command Line Syntax

The user name and password to access the database on the local --login dba/sql@localhost
machine is the default user account.
The source surfaces are located on the Database2 database. --database-name Database2
No-data areas in Holidays bands will be preserved in the output --confine-metadata-rules HOLIDAY
surface if the surface containing the holidays is determined to be
the winner during conflict resolution.
The extents to be included in the new surface are: --extent 418449.0 5579149.5 418849.0
lower-left X: 418449.0 5579549.5

lower-left Y: 5579149.5
upper-right X: 418849.0
upper-right Y: 5579549.5
The resolution of the output surface will be 20 metres. --resolution 20m
The output coordinate system will be UTM-30N. --output-crs UTM-30N
The Contributor layer of the output surface will include the feature --contributor-attribute BOID --contributor-
object ID (BOID), object name (OBJNAM) and source date attribute OBJNAM --contributor-attribute
(SORDAT) attributes. SORDAT
The servercombinerules2.crfx rule file, located at D:\BatchSample, --rule-file
will be used to select winning nodes. D:\BatchSample\servercombinerules2.crfx
The override ambiguity option will be used for other conflicts. --override-ambiguity
The raster surfaces to be combined are called Surface1 and 02000001 02000002
Surface2. The object BOID for each surface is 02000001 and
02000002, respectively.
The resulting CSAR file, named Database_Combined.csar, will be D:\BatchSample\Database_Combined.csar
saved to the D:\BatchSample folder.

130 CARIS Batch Utility Reference Guide

BASE Editor Processes: Server Combine to Raster

Example

carisbatch --run ServerCombineToRaster --login dba/sql@localhost

--database-name Database2 --confine-metadata-rules HOLIDAY --extent
416379.84 5576029.18 420200.16 5580327.82 --rule-file
Command
D:\BatchSample\servercombinerules2.crfx --resolution 20m --output-crs
Line
UTM-30N --contributor-attribute BOID --contributor-attribute OBJNAM
--contributor-attribute SORDAT --override-ambiguity 02000001 02000002
D:\BatchSample\Database_Combined.csar
The surfaces matching the criteria in the input rule file are combined into a single surface and
Outcome
saved to the local machine.

Notes N/A

CARIS Batch Utility Reference Guide 131

BASE Editor Processes: Server Join Points

Server Join Points

Description The ServerJoinPoints process creates a new point cloud from the
points in the inputs.
Inputs Two or more point clouds. The inputs can be specified by object
BOIDs and/or CRFX query files.
Outputs A point cloud in CSAR format. The location can be specified by a
file path or a URI.
Command Line Syntax carisbatch --run ServerJoinPoints --extent <value> --output-crs
<value> --contributor-attribute <value> --login <value> --
database-name <value> [options] <inputs> <output>

Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--database- D The name of the database server instance containing the FALSE This must be
name inputs. specified explicitly.
The input point clouds must be in the specified database.
--login L The node manager login credentials. Specified as either FALSE This must be
username/password or username/password@hostname. specified explicitly.
Omitting @hostname is equivalent to using @localhost.
--primary- m A string specifying the name of the primary elevation band FALSE
band of the output.
The default value is Depth.
--contributor- C A string specifying an attribute value to be included in the TRUE
attribute Contributor layer.
The Contributor for each point is populated with a list of
the object attribute values from the source that is selected
to be copied to the output point cloud.
The default value is boid.
--output-crs c A string specifying the horizontal coordinate reference FALSE This must be
system key of the output. specified explicitly.

132 CARIS Batch Utility Reference Guide

BASE Editor Processes: Server Join Points

Parameter

Can Notes
Long Short Description
Repeat

--extent E The extents that define the window. FALSE This must be
<LowerX> - A number specifying the lower left X origin in specified explicitly.
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 unprojected data, an angle type unit is
required. The order for unprojected 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.
--polygon- Y A string specifying the type of bounding polygon to FALSE
type generate. One of:
• CONVEX: The convex hull of the data is used for
the polygon.
• BUFFERED: A simplified buffered boundary is
used for the polygon.
The default value is BUFFERED.
--comments General comments to be added to the coverage FALSE The default value
metadata. is an empty string.

Example To use this command refer to the following example.

Example

Objective You need to join three database point clouds into one new point cloud.

Description Command Line Syntax

The user name and password to access the database on the local --login dba/sql@localhost
machine is the default user account.
The source surfaces are located on the Database5 database. --database-name Database5
The primary elevation band will be Depth. --primary-band Depth
The output coordinate reference system is UTM 30N. --output-crs UTM-30N
The extents are: --extent 417854.16 5578698.32
lower-left X: 417854.16 419325.69 5579707.37

lower-left Y: 5578698.32
upper-right X: 419325.69
upper-right Y: 5579707.37

CARIS Batch Utility Reference Guide 133

BASE Editor Processes: Server Join Points

Example

The input files are: 02000002 02000003 02000011

D:\BatchSample\Cloud1.csar
D:\BatchSample\Cloud2.csar
D:\BatchSample\Cloud3.csar.
The object BOIDS used to identify the surfaces are 02000002,
02000003, and 02000011.
A new file will be created with the file name ServerJoined.csar, in the D:\BatchSample\ServerJoined.csar
BatchSample folder, the same folder containing the source files.
carisbatch --run ServerJoinPoints --database-name Database5 --login
Command dba/sql@localhost --output-crs UTM-30N --primary-band Depth --extent
Line 417854.16 5578698.32 419325.69 5579707.37 02000002 02000003 02000011
D:\BatchSample\ServerJoined.csar

Outcome The three input point clouds are joined into a single new point cloud in the location specified.

The resulting point cloud will contain the points and their attributes from the input sources and
Extra Notes
a new automatically generated boundary polygon.

134 CARIS Batch Utility Reference Guide

BASE Editor Processes: Shift Elevation Bands

Shift Elevation Bands

Description The ShiftElevationBands process alters elevation band values by
the specified method.
Inputs A point cloud or raster surface.
Outputs A coverage in CSAR format.
Command Line Syntax carisbatch --run ShiftElevationBands --shift-type <value> --
input-band <value> [options] <input> <output>

Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

Common Options

--input-band i A string specifying the name of the input band. TRUE This must be
The values in these elevation bands are to be shifted. specified explicitly.

The ALL keyword is used to shift all elevation bands and

include them in the output.
--include- b A string specifying the name of a band to include in the TRUE
band output.
The ALL keyword is used to include all other bands in the
output, excluding any input bands. The values in these
bands are not shifted.
--shift-type s A string specifying the type of data by which to shift the FALSE This must be
band. One of: specified explicitly.
• ASCII: Shift by an ASCII file.
• TIDE: Shift by a tide file, as well as a date and
time band.
• VALUE: Shift by a single floating point value.
• RASTER: Shift by a raster surface file.
• SPINE: Shift by a SPINE service.
ShiftType specific options are given below.
--output- o A string specifying the vertical coordinate reference FALSE
vertical-crs system key of the output.
--polygon- Y A string specifying the type of bounding polygon to FALSE
type generate. One of:
• CONVEX: The convex hull of the data is used for
the polygon.
• BUFFERED: A simplified buffered boundary is
used for the polygon.
The default value is BUFFERED.
--comments General comments to be added to the coverage FALSE
metadata.
The default value is an empty string.

CARIS Batch Utility Reference Guide 135

BASE Editor Processes: Shift Elevation Bands

Parameter

Can Notes
Long Short Description
Repeat

ShiftType = ASCII Options

--shift-file F The path to the ASCII file containing the shift values. FALSE This must be
specified explicitly.

ShiftType = VALUE Options

--shift-value S A number and unit specifying the single shift value. FALSE This must be
All values representing elevations are entered using the specified explicitly.
convention that up is positive.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi,
mm, nm, usfm, usft, usmi, usnm, usyd, yd.

ShiftType = Tide Options

--shift-file F The path to the tide file. FALSE This must be

specified explicitly.
--date-band d A string specifying the band in the input containing date FALSE This may be a
information. separate band or it
may be encoded
as part of the time
band.
--time-band T A string specifying the band in the input containing time FALSE This must be
information. specified explicitly.

ShiftType = Raster Options

--shift-file F The path to the raster surface file. FALSE This must be
The file can be in BIN format or any other supported specified explicitly.
raster surface format.
--elevation- E A string specifying the band in the shift raster surface FALSE This must be
band containing the elevation values. specified explicitly.
ShiftType = SPINE Options
--username n A string specifying the user name used to log into the FALSE This must be
SPINE web server. specified explicitly.
--password P A string specifying the password used to log into the FALSE This must be
SPINE web server. specified explicitly.
--url U A string specifying the URL of the SPINE web server. FALSE This must be
specified explicitly.
--proxy x A string specifying the proxy used to connect to the FALSE
SPINE web server.
--time t A string specifying the time to request from the SPINE FALSE This must be
web server in UTC. specified explicitly.

136 CARIS Batch Utility Reference Guide

BASE Editor Processes: Shift Elevation Bands

To use this command refer to the following examples.

Example: ASCII Shift

Example

Objective You need to apply a shift to a surface using an ASCII file to control the shift.

Description Command Line Syntax

The ASCII file to be used is called ShiftValues.xyz and is located in --shift-file

the BatchSample directory on the D drive. D:\BatchSample\ShiftValues.xyz
The Depth band will be shifted. --input-band Depth
The output vertical coordinate reference system for the shift will be --output-vertical-crs "NAVD88 height"
NAVD88 height.
The source surface is called Cloud1 and is located in the D:\BatchSample\Cloud1.csar
BatchSample directory, on the D drive.
The resulting file will be named ASCIIShift.csar and will be placed in D:\BatchSample\ASCIIShift.csar
the BatchSample directory on the D drive.
carisbatch --run ShiftElevationBands --shift-type ASCII --shift-file
Command Line D:\BatchSample\ShiftValues.xyz --input-band Depth --output-vertical-
Format crs "NAVD88 height" D:\BatchSample\Cloud1.csar
D:\BatchSample\ASCIIShift.csar

Outcome A new CSAR file, with a shift applied to the specified band, is created.

Extra Notes N/A

Example: Value Shift

Example

Objective You need to shift a surface by a single value.

Description Command Line Syntax

A single shift of 4m will be applied, making the surface 4m less deep. --shift-value 4.0m
The Depth band will be shifted. --input-band Depth
The polygon type is buffered. --polygon-type BUFFERED
The source surface is named Surface1 located in the BatchSample D:\BatchSample\Surface1.csar
directory, on the D drive.
The resulting file will be named ValueShift.csar and will be placed in D:\BatchSample\ValueShift.csar
the BatchSample directory on the D drive.

Command Line

carisbatch --run ShiftElevationBands --shift-type VALUE --shift-value 4.0m --input-

band Depth --polygon-type BUFFERED D:\BatchSample\Surface1.csar
D:\BatchSample\ValueShift.csar

Outcome A new CSAR file is created with a single value shift applied.

The direction of the shift depends on the current application settings for the Z-axis Convention
Extra Notes
attribute.

CARIS Batch Utility Reference Guide 137

BASE Editor Processes: Shift Elevation Bands

Example: Tide Shift

Example

Objective You need to apply tide correction to a raster surface using data from a single tide station.

Description Command Line Syntax

The shift type is Tide. --shift-type TIDE

The input band is Depth. In addition to the Depth, you also need to --input-band Depth --input-band Tide
shift Tide.
The tide file is named 05tide.tid and is located in the BatchSample --shift-file D:\BatchSample\05tide.tid
directory on the D drive.
The date information is contained in the Time attribute layer. --date-band Time
The time information is contained in the Time attribute layer. --time-band Time
The source surface is named tide_surface.csar and is located in the D:\BatchSample\tide_surface.csar
BatchSample directory, on the D drive.
The resulting file will be named TideShifted.csar and will be placed in D:\BatchSample\TideShifted.csar
the BatchSample directory on the D drive.
carisbatch --run ShiftElevationBands --shift-type TIDE --input-band
Command Depth --input-band Tide --date-band Time --time-band Time --shift-file
Line Format D:\BatchSample\05tide.tid D:\BatchSample\tide_surface.csar
D:\BatchSample\TideShifted.csar

Outcome A new CSAR file is created with a tide shift applied to the data.

Extra Notes The source surface to be shifted must contain Date and Time attribute layers.

138 CARIS Batch Utility Reference Guide

BASE Editor Processes: Smooth Features by Direction Bias

Smooth Features by Direction Bias

Description The SmoothFeaturesByDirectionBias process alters line and area
features by applying a direction-biased safe-side smoothing
algorithm.
Inputs Features in a supported format. HOB and 000 (S-57
specification) are supported.
Outputs Features in HOB format.
Command Line Syntax carisbatch --run SmoothFeaturesByDirectionBias --feature-
catalogue <value> --tolerance <value> [options] <input>
<output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--feature- F A string specifying the name of the catalogue that defines FALSE This must be
catalogue the features and attributes in a vector dataset. One of {list specified
dynamically populated from the catalogue control file}. explicitly.
The names of the available catalogues can be accessed
through application via the Object Catalogue environment
variable in Tools > Options. The available catalogues are
controlled by the Catalogue Control file. An example of a
catalogue name is "S-57 ENC 3.1".
The units and z-axis direction of the output are controlled
by the pool of the feature catalogue of the output. If the
input cannot be converted to those units and z-axis
convention, then the values are simply copied from the
input data.
--tolerance T A number and unit specifying the minimum distance FALSE This must be
between vertices. specified
Two components of the smoothing algorithm use this explicitly.
tolerance. Points within this tolerance of each other are
collapsed together, resulting in tiny curves becoming
sharp angles. In addition, safe-side correction
overcompensates to move unsafe components to be
Tolerance/2 on the safe sid of the original line.
This value must be greater than zero.
--maximum- A number and unit specifying the maximum edge length FALSE
edge for input features.
If set, edges longer than this value are subdivided before
smoothing. Also, if set, this value must be greater than
zero.

CARIS Batch Utility Reference Guide 139

BASE Editor Processes: Smooth Features by Direction Bias

Parameter

Can Notes
Long Short Description
Repeat

--convergence A number and unit specifying the minimum smoothing FALSE

required in each iteration for the process to continue.
If set, smoothing ends if none of the changes in an
iteration is larger than this tolerance. This must be a
positive value, or zero.
--iterations The number of smoothing iterations applied. FALSE
If the convergence limit is met before this number of
iterations is run, the operation ends at that time.
This value must be greater than zero.
--scale s A number speficying the scaling applied to distance FALSE
values (1:scale).
This is applied to the --tolerance, --maximum-edge, and
--convergence values. The default scale of 1 requires
those values to be entered as distances on the ground. A
scale of 1000 means these values are distances on a
1:1000 scale map.
A scale of 1 and tolerance of 1m is identical to a scale of
1000 and a tolerance of 1mm.
This value must be greater than zero.
--direction-bias The rules applied when smoothing features. FALSE
<SlopeDirection> A string describing the rule to use for
lines with contour slope attribution.
• DOWN: Lines are smoothed towards lower
elevation.
• UP: Lines are smoothed towards higher elevation.
<Unknown> A string describing the rule to use for lines
without contour slope attribution.
• LEFT: Lines are smoothed towards the left.
• RIGHT: Lines are smoothed towards the right.
• IGNORE: Unattributed lines are ignored.
Contours will only have the contour slope (cntdir) attribute
if they were generated using the Bathy DataBASE
catalogue.
Note: Because the process does not know which
attributes are present in the input data, you must specify a
direction for contours both with and without the slope
attribute.

140 CARIS Batch Utility Reference Guide

BASE Editor Processes: Smooth Features by Direction Bias

To use this command, refer to the following examples.

Example: Bathy
DataBASE Catalogue

Example

Objective You want to smooth a selection of contours generated using the Bathy DataBASE catalogue.

Description Command Line Syntax

The contours were generated using the Bathy DataBASE catalogue. --feature-catalogue "Bathy DataBASE"
Vertices are to be no less than 1m apart. --tolerance 1m
Edges in the selected features are to be no longer than 3m. --maximum-edge 5m
Smoothing will end once points are being moved less than 0.5m. --convergence 0.5m
Points will be smoothed towards the lower elevation. --direction-bias DOWN RIGHT
The source features are stored in Contours.hob and are located in the D:\BatchSample\Contours.hob
D:\BatchSample directory.
The new smoothed features will be saved to SmoothedContours.hob D:\BatchSample\SmoothedContours.ho
in the same directory as the source. b
carisbatch --run SmoothFeaturesByDirectionBias --feature-catalogue
"Bathy DataBASE" --tolerance 1m --maximum-edge 5m --convergence 0.5m
Command Line
--direction-bias DOWN RIGHT D:\BatchSample\Contours.hob
D:\BatchSample\SmoothedContours.hob
The contour line and depth area features are smoothed using a lower-elevation bias and
Outcome
saved to the specified location.

Extra Notes N/A

CARIS Batch Utility Reference Guide 141

BASE Editor Processes: Smooth Features by Direction Bias

Example: S-57
Catalogue

Example

Objective You want to smooth a selection of contours generated using the S-57 ENC 3.1 catalogue.

Description Command Line Syntax

The contours were generated using the S-57 ENC 3.1 catalogue. --feature-catalogue "S-57 ENC 3.1"
Vertices are to be no less than 1m apart. --tolerance 1m
Edges in the selected features are to be no longer than 3m. --maximum-edge 5m
Smoothing will end once points are being moved less than 0.5m. --convergance 0.5m
Points will be smoothed towards the right of the source feature. --direction-bias DOWN RIGHT
The source features are stored in S57Contours.hob and are located in D:\BatchSample\S57Contours.hob
the D:\BatchSample directory.
The new smoothed features will be saved to D:\BatchSample\S57SmoothedContours
S57SmoothedContours.hob in the same directory as the source. .hob
carisbatch --run SmoothFeaturesByDirectionBias --feature-catalogue
"S-57 ENC 3.1" --tolerance 1m --maximum-edge 5m --convergance 0.5m --
Command Line
direction-bias DOWN RIGHT D:\BatchSample\S57Contours.hob
D:\BatchSample\S57SmoothedContours.hob
The contour line and depth area features are smoothed to the right of the source feature and
Outcome
saved to the specified location.

Extra Notes N/A

142 CARIS Batch Utility Reference Guide

BASE Editor Processes: Thin Points

Thin Points
Description The ThinPoints process creates a new point cloud with a subset
of the points from the input.
Inputs A point cloud, variable resolution surface, or raster surface
dataset.
Outputs A point cloud in CSAR format.
Command Line Syntax carisbatch --run ThinPoints --method <value> [options] <input>
<output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

Common Options

--method m The algorithm used to thin points from the input coverage. FALSE
• RANDOM: Deletes a specified percentage of the
points using random sampling.
• MINIMUM_DISTANCE: Deletes points until no two
points are within a specified distance.
• APPLY_BIAS: Only the point with the minimum or
maximum attribute value within its local
neighborhood is kept.
Note: All three methods use deterministic algorithms,
meaning that running the process on the same dataset
multiple times with the same settings will produce the
same output each time.
--include- b A string specifying the name of a band to include in the TRUE
band output.
The ALL keyword is used to include all other bands in the
output.
--polygon- Y A string specifying the type of bounding polygon to FALSE
type generate.
• CONVEX: The convex hull of the data is used for
the polygon.
• BUFFERED: A simplified buffered boundary is
used for the polygon.
The default value is BUFFERED.
--comments General comments to be added to the coverage FALSE
metadata.
The default value is an empty string.

Method = RANDOM Options

--percentage The percentage of points removed. FALSE

This number can be between 0 and 100, where 0
removes no points and 100 removes all points.

CARIS Batch Utility Reference Guide 143

BASE Editor Processes: Thin Points

Parameter

Can Notes
Long Short Description
Repeat

Method = MINIMUM_DISTANCE Options

--minimum- d The minimum distance between points in the output, in FALSE

distance areas of the input with values.
Note that output points could be up to 2x the minimum
distance apart.
--scale s A number specifying the scaling to apply to the radius FALSE
(1:scale).
The default scale value is 1, such that the value
represents the minimum distance between features on the
ground; the radius would then be a value like 5m.
A scale of 1000 would mean that the value represents the
minimum distance between features on a map at 1:1000
scale; the radius would then be a value like 10mm.

Method = APPLY_BIAS Options

--input-band i A string specifying the name of the input band. FALSE

The InputBand must contain numeric values.
--bias B A string specifying how to select which values are chosen. FALSE
• MIN: Points that have the minimum attribute value
in their neighbourhood are kept.
• MAX: Points that have the largest attribute value in
their neighbourhood are kept.
All values representing elevations are considered using
the convention that up is positive.
--minimum- d The minimum idistance between sounding features in the TRUE
distance output, in areas of the input with values in the specified
band.
<Radius> - A number and unit specifying the minimum
distance between sounding features.
<MinValue> - A number and unit specifying the minimum
value of the input band to apply this distance.
<MaxValue> - A number and unit specifying the maxmum
value of the input band to apply this distance.
A least one radius must be specified.
If CARIS:NONE is used as the <MinValue>, the minimum
value of the data is used. Similarly, if CARIS:NONE is
used as the <MaxValue>, the maximum value of the data
is used.
All values representing elevations are entered using the
convention that up is positive.
The unit must be specified, unless the input band is a
unitless band.
Support units: cable, ch, cm, fm, ft, in, inm, km, m, mi,
mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.

144 CARIS Batch Utility Reference Guide

BASE Editor Processes: Thin Points

Parameter

Can Notes
Long Short Description
Repeat

Method = MINIMUM_DISTANCE Options

--minimum- d The minimum distance between points in the output, in FALSE

Method = APPLY_BIAS Options

--input-band i A string specifying the name of the input band. FALSE

CARIS Batch Utility Reference Guide 145

BASE Editor Processes: Thin Points

Parameter

Can Notes
Long Short Description
Repeat

--scale s A number specifying the scaling to apply to the radius FALSE

(1:scale).
The default scale value is 1, such that the radius
represents the minimum distance between features on the
ground; the radius would then be a value like 5m.
A scale of 1000 would mean that the radius represents
the minimum distance betwen features on a map at
1:1000 scale, the radius would then be a value like 10mm.
--apply- a If set, designated soundings from the source of the input FALSE
designated are included to the output.
<MultipleDesignated> A string specifying how to handle
multiple designated soundings closer than the minimum
distance.
• KEEP_ALL: Include all designated soundings to
the output.
• THIN: Thin designated soundings based on the
bias.
<BiasRelevance> A string specifying how to handle
designated soundings and other points closer than the
minimum distance.
• APPLY_BIAS: Points that are selected based on
the bias are included in the output regardless if a
designated sounding is within the radius. The
designated sounding is also included.
• OVERRIDE_BIAS: Designated soundings thin all
points within the radius, removing any points that
otherwise would be selected based on the bias.

To use this command refer to the following examples.

Example: Minimum
Distance

Example

You want to decrease the density of the data in a point cloud using the Minimum Distance
Objective
thinning method.

Description Command Line Syntax

The Minimum Distance thinning method is to be used. --method MINIMUM_DISTANCE

All points closer than 5m will be removed from the output. --minimum-distance 5m CARIS:NONE
CARIS:NONE
The Depth and Shoal bands are to be included in the output. --include-band Depth --include-band
Shoal
The file to be thinned is named DenseCloud.csar and is in the D:\BatchSample\DenseCloud.csar
BatchSample directory on the D: drive.
The thinned point cloud will be called MinDistanceCloud.csar and will D:\BatchSample\MinDistanceCloud.csar
be saved to the same directory as the source.

146 CARIS Batch Utility Reference Guide

BASE Editor Processes: Thin Points

Example

carisbatch --run ThinPoints --method MINIMUM_DISTANCE --minimum-

distance 5m CARIS:NONE CARIS:NONE --include-band Depth --include-band
Command Line
Shoal D:\BatchSample\DenseCloud.csar
D:\BatchSample\MinDistanceCloud.csar
A new, smaller point cloud is created in the specified location containing points no less than
Outcome
15m apart.

Extra Notes N/A

Example: Apply Bias

Example

You want to decrease the file size of a variable resolution surface using the Apply Bias
Objective
thinning method.

Description Command Line Syntax

The Apply Bias thinning method is to be used. --method APPLY_BIAS

The maximum values are to be kept during thinning. --bias MAX
The Shoal band is to be included. --include-band Shoal
Thinning is to be performed on the Elevation band. --input-band Elevation
The following radius and interval values are to be used: --minimum-distance 0.5m 1m 3m --
• 0.5m, 1m, 3m minimum-distance 1m 3.01m 5m --
• 1m, 3.01m, 5m minimum-distance 1.5m 5.01m 7.5m --
• 1.5m, 5.01m, 7.5m minimum-distance 3m 7.51m 10m --
• 3m, 7.51m, 10m minimum-distance 5m 10m
• 5m, 10m, CARIS:NONE CARIS:NONE
A radius of 15m will be used and the full range of elevations present in
the band are to be analyzed.
All designated soundings are to be retained and any regular points --apply-designated KEEP_ALL
within the radius of a designated sounding are to be thinned APPLY_BIAS
according to the bias rule.
The file to be thinned is named DenseVR.csar and is in the D:\BatchSample\DenseVR.csar
BatchSample directory on the D: drive.
The thinned point cloud will be called BiasThinVR.csar and will be D:\BatchSample\BiasThinVR.csar
saved to the same directory as the source.
carisbatch --run ThinPoints --method APPLY_BIAS --bias MAX --include-
band Shoal --input-band Elevation --minimum-distance 0.5m 1m 3m --
minimum-distance 1m 3.01m 5m --minimum-distance 1.5m 5.01m 7.5m --
Command Line
minimum-distance 3m 7.51m 10m --minimum-distance 5m 10m CARIS:NONE --
apply-designated KEEP_ALL APPLY_BIAS D:\BatchSample\DenseVR.csar
D:\BatchSample\BiasThinVR.csar

Outcome A new point cloud is created in the location specified with less dense data.

Extra Notes N/A

CARIS Batch Utility Reference Guide 147

BASE Editor Processes: Tile Raster

Tile Raster
Description The TileRaster process exports a single raster to one or more
raster files based on the defined tiling scheme.
Inputs A raster dataset.
Outputs One or more CSAR raster files. The raster files are named based
on the provided output name, with the row and column of the
tile encoded into the name, such as outputfile2x3 for the tile in
the second row and third column.
Command Line Syntax carisbatch --run TileRaster --size <value> [options] <input>
<output>
Options The following table describes the parameter available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--size S The size of the exported tiles. FALSE This must be

<Width> - A number and unit specifying the width of the specified explicitly.
exported tiles.
<Height> - A number and unit specifying the height of the
exported tiles.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi,
mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.
--buffer B The size of a buffer around exported tiles. FALSE
<XBuffer> - A number and unit specifying the size of the
buffer on the left and right of each tile.
<YBuffer> - A number and unit specifying the size of the
buffer on the top and bottom of each tile.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi,
mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.
The default values are 0m.

Example To use this command refer to the following example.

Example

Objective You want to tile a raster.

Description Command Line Syntax

The size of the exported tiles will be 50 x 50 metre. --size 50m 50m
The source surface, Surface1.csar, is located at D:\BatchSample. D:\BatchSample\Surface1.csar
The output surfaces will be named based on Tiled.csar and will be D:\BatchSample\Tiled.csar
saved to the same location as the source surface.
carisbatch --run TileRaster --size 50m 50m
Command Line
D:\BatchSample\Surface1.csar D:\BatchSample\Tiled.csar

148 CARIS Batch Utility Reference Guide

BASE Editor Processes: Tile Raster

Example

New rasters are created in the specified location, with names like Tiled1x1.csar, where the
Outcome
first number is the row and the second is the column of the tile in the source surface.

Extra Notes N/A

CARIS Batch Utility Reference Guide 149

BASE Editor Processes: Update VR CUBE Disambiguation

Update VR CUBE Disambiguation

Description The UpdateVRCUBEDisambiguation process will update or rerun the
disambiguation method used in variable resolution CUBE
surfaces.
Inputs A variable resolution surface in CSAR format.
Outputs An updated variable resolution surface in CSAR format.
Command Line Syntax carisbatch --run UpdateVRCUBEDisambiguation [options]
<update>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--disambiguation- d The method used to select a hypothesis from a set. One of: FALSE
method • DENSITY: Disambiguate by number of samples.
• LOCALE: Disambiguate by surrounding nodes.
• DENSITY_LOCALE: Disambiguate by a
combination of sample count and surrounding
nodes.
The default value is DENSITY_LOCALE.

Example To use this command refer to the following example.

Example

Objective You want to change the disambiguation method used in a VR CUBE surface.

Description Command Line Syntax

The disambiguation engine to be used is DENSITY. --disambiguation-method DENSITY

The file to be updated is named VRCubeSurface.csar and is in the D:\BatchSample\VRCubeSurface.csar
BatchSample directory on the D: drive.
carisbatch --run UpdateVRCUBEDisambiguation --disambiguation-method
Command Line
DENSITY D:\BatchSample\VRCubeSurface.csar

Outcome The variable resolution surface is updated with the selected disambiguation method.

Extra Notes N/A

150 CARIS Batch Utility Reference Guide

BASE Editor Processes: Vectorize Raster

Vectorize Raster
Description The VectorizeRaster process produces polygons from raster
pixels.
Inputs A raster in a supported format. A BDB Server URI can be
specified as input.
Outputs Area features in HOB format.
Command Line Syntax carisbatch --run VectorizeRaster --input-band <value> --
polygon-feature <value> [options] <input> <output>
Options The following table describes the parameter available for this
process.

Parameter

Can
Long Short Description Notes
Repeat

--input-band i A string specifying the name of the input band. FALSE This must be
specified explicitly.
--feature- F A string specifying the name of the catalogue that defines FALSE This must be
catalogue the features and attributes in a vector dataset. One of specified explicitly.
{list dynamically populated from the catalogue control
file}.
The names of the available catalogues can be accessed
through application via the Object Catalogue
environment variable in Tools > Options. The available
catalogues are controlled by the Catalogue Control file.
An example of a catalogue name is "S-57 ENC 3.1".
The units and z-axis direction of the output are controlled
by the pool of the feature catalogue of the output. If the
input cannot be converted to those units and z-axis
convention, then the values are simply copied from the
input data.
--polygon- P A string specifying the feature acronym of the area object FALSE This must be
feature to be used for the polygons. specified explicitly.
--mode m A string specifying the mode. One of: FALSE
• COVERAGE: Coverage - A polygon is generated
around each set of joined pixels.
• VALUE: Value - A polygon is generated around pixels
with the same value. Only valid for integer scaler type
or string table type bands.
The default value is COVERAGE.
--value- a A string specifying the attribute acronym for the value of FALSE
attribute the polygons.
This is only used when the Mode is set to VALUE.

CARIS Batch Utility Reference Guide 151

BASE Editor Processes: Vectorize Raster

Parameter

Can
Long Short Description Notes
Repeat

--component- A The mapping for one component of the band value to an TRUE
attribute attribute acronym.
<Component> - A string specifying the name of the
component in the vertical-bar separated list of
components.
<Attribute> - A string specifying the attribute acronym for
the value of this component.
It is possible to specify the same component multiple
times, with different attributes, to map the same
component to multiple attributes.
As the raster has been vectorized based on the values in
this band, all nodes in the raster within any given polygon
have the same value for this band.

To use this command refer to the following examples.

Example: Value
Attribute

Example

Objective You want to vectorize seabed areas to represent the data sources in a contributor band.

Description Command Line Syntax

The band to be vectorized is Contributor. --input-band Contributor

The feature catalogue name is S-57 ENC 3.1. --feature-catalogue "S-57 ENC 3.1"
The resulting polygons will be assigned the Coverage (cvrage) object --polygon-feature M_SREL
acronym.
The polygons will be created based on the values in the band. --mode VALUE
The attribute acronym to use for the value of the polygons will be --component-attribute
TXTDSC (Textual Description).
The source surface, CombinedSurface.csar, is located at D:\BatchSample\CombinedSurface.csar
D:\BatchSample.
The resulting features will be saved to the MappedRaster.hob file, D:\BatchSample\MappedRaster.hob
which will be created in the same location as the source surface.
carisbatch.exe --run VectorizeRaster --input-band Contributor --
feature-catalogue "S-57 ENC 3.1" --polygon-feature SBDARE --mode
Command Line
VALUE --component-attribute D:\BatchSample\CombinedSurface.csar
D:\BatchSample\MappedRaster.hob
A HOB file is created containing newly-created SBDARE objects representing the data
sources that contributed to the surface. The TXTDSC attribute of each object will be
Outcome
populated with the name and location of the data source that contributed to the area of the
surface that is represented by each respective feature object.

Extra Notes N/A

152 CARIS Batch Utility Reference Guide

BASE Editor Processes: Vectorize Raster

Example: Component
Attribute

Example

You want to identify the datasets that contributed to a combined surface in a database to
Objective
determine which data is in need of updating.

Description Command Line Syntax

The band to be vectorized is Contributor. --input-band Contributor

The feature catalogue name is S-57 ENC 3.1. --feature-catalogue "S-57 ENC 3.1"
The polygons will be created based on the values in the band. --mode VALUE
The resulting polygons will be assigned the M_SREL (Survey --polygon-feature M_SREL
Reliability) object acronym.
The attribute acronym to use for the value of the polygons will be --component-attribute SUREND
SUREND (Survey Date - End), which will be mapped from the SUREND
SUREND values in the Contributor band.
The source surface, CombinedDBSurface.csar, was extracted to D:\BatchSample\CombinedDBSurface.c
D:\BatchSample. sar
The resulting features will be saved to the SURENDObjects.hob file, D:\BatchSample\SURENDObjects.hob
which will be created in the same location as the source surface.
carisbatch.exe --run VectorizeRaster --input-band Contributor --
feature-catalogue "S-57 ENC 3.1" --mode VALUE --polygon-feature
Command Line M_SREL --value-attribute SUREND SUREND
D:\BatchSample\CombinedDBSurface.csar
D:\BatchSample\SURENDObjects.hob
A HOB file is created containing newly-created M_SREL objects representing the data
sources that contributed to the surface. The SUREND attribute of each object will be
Outcome
populated with the survey end data of each data source that contributed to the area of the
surface that is represented by each respective feature object.

Extra Notes N/A

CARIS Batch Utility Reference Guide 153

BASE Editor Processes: Warp Points

Warp Points
Description The WarpPoints process transforms points to a specified
coordinate reference system.
Inputs A point cloud in a supported format.
Outputs A point cloud in CSAR format.
Command Line Syntax carisbatch --run WarpPoints --output-crs <value> --primary-
band <value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--output-crs c A string specifying the horizontal coordinate FALSE This must be

reference system key of the output. specified explicitly.
--output-vertical- o A string specifying the vertical coordinate reference FALSE
crs system key of the output.
No vertical transformation is applied even if a value is
specified. This value is only used as metadata on the
output dataset.
--primary-band m A string specifying the name of the primary elevation FALSE
band of the output.
This must be the name of an elevation band in the
input.
The default value is the name of primary elevation
band in the input.
--include-band b A string specifying the name of a band to include in TRUE
the output.
The ALL keyword is used to include all bands in the
output.
--polygon-type Y A string specifying the type of bounding polygon to FALSE
generate. One of:
• CONVEX: The convex hull of the data is used
for the polygon.
• BUFFERED: A simplified buffered boundary is
used for the polygon.
The default value is BUFFERED.
--comments General comments to be added to the coverage FALSE
metadata.
The default value is an empty string.

154 CARIS Batch Utility Reference Guide

BASE Editor Processes: Warp Points

Example: To use this command refer to the following example.

Example

Objective You want to transform a point cloud to a specific coordinate system.

Description Command Line Syntax

The coordinate reference system of the output is UTM 29N NAD 83. --output-crs UTM-29N-Nad83

The primary elevation band of the output is the Depth band. --primary-band Depth

The source raster surface is Cloud1.csar located in the D:\BatchSample\Cloud1.csar

D:\BatchSample directory.
The resulting file will be named WarpPoints.csar located in the D:\BatchSample\WarpPoints.csar
D:\BatchSample directory.
carisbatch --run WarpPoints --output-crs UTM-29N-Nad83 --primary-band
Command Line
Depth D:\BatchSample\Cloud1.csar D:\BatchSample\WarpPoints.csar
A CSAR point cloud with the desired coordinate reference system is created in the specified
Outcome
location.

Extra Notes N/A

CARIS Batch Utility Reference Guide 155

BASE Editor Processes: Warp Raster

Warp Raster
Description The WarpRaster process transforms a raster surface to a specified
coordinate reference system.
Inputs A raster surface in a supported format.
Outputs A raster surface in CSAR format.
Command Line Syntax carisbatch --run WarpRaster --primary-band <value> --output-
crs <value> --resolution <value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--output-crs c A string specifying the horizontal coordinate reference FALSE This must be
system key of the output. specified
explicitly.
--output- o A string specifying the vertical coordinate reference system FALSE
vertical-crs key of the output.
No vertical transformation is applied even if a value is
specified. This value is only used as metadata on the
output dataset.

156 CARIS Batch Utility Reference Guide

BASE Editor Processes: Warp Raster

Parameter

Can Notes
Long Short Description
Repeat

--primary- m The name, interpolation method and sampling method of FALSE This must be
band the primary elevation band of the output. specified
<Name> - A string specifying the name of the primary explicitly.
elevation band of the output.
<Interpolation> - A string specifying the interpolation
method. One of:
• BICUBIC: Performs bicubic interpolation, which is
smoother but may take longer than bilinear.
• BICUBIC_KEEP_HOLE: Performs bicubic
interpolation that maintains holes.
• BILINEAR: Performs linear interpolation in one
direction and then the other, resulting in quadratic
interpolation.
• BILINEAR_KEEP_HOLE: Bilinear interpolation that
maintains holes.
• NEAREST_NEIGHBOUR: Uses the nearest point,
averaging if some are equidistant.
• NONE: No interpolation is performed.
<Sampling> - A string specifying the sampling method.
One of:
• MIN: Use the minimum value.
• MAX: Use the maximum value.
• NONE: The interpolation method determines the
value used.
The primary elevation band must be a numeric type band.
All values representing elevations are considered using the
convention that up is positive, so a minimum bias is a
minimum elevation bias; minimum elevation is equivalent
to maximum depth. The value of NONE cannot be
specified for both Interpolation and Sampling parameters.
The default value is the name of primary elevation band in
the input, with no interpolation or sampling.
--resolution R A number and unit specifying the resolution of the output FALSE This must be
raster. specified
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, explicitly.
mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.
--reprojection j The reprojection method to use. One of: FALSE
-method • FAST: Use fast, approximate reprojection.
• EXACT: Use exact reprojection.
The default value is FAST.

Example

Objective You want to transform a raster surface to a specific coordinate reference system.

Description Command Line Syntax

The output coordinate reference system will be EPSG:3395. --output-crs EPSG:3395

The Depth layer will be interpolated using BILINEAR interpretation --primary-band Depth BILINEAR MIN
and sampling set to MIN.
The Std_Dev layer will be interpolated using BILINEAR interpretation --input-band Std_Dev BILINEAR NONE
and sampling set to NONE.
The output resolution will be 3m. --resolution 3m
The FAST reprojection will be used. --reprojection-method FAST
The source raster surface is Surface11.csar located in the D:\BatchSample\Surface11.csar
D:\BatchSample directory.
The resulting file will be named Warped.csar located in the D:\BatchSample\Warped.csar
D:\BatchSample directory.
carisbatch --run WarpRaster --output-crs EPSG:3395 --primary-band
Depth BILINEAR MIN --input-band Std_Dev BILINEAR NONE --resolution 3m
Command Line
--reprojection-method FAST D:\BatchSample\Surface11.csar
D:\BatchSample\Warped.csar

Outcome A new raster surface file, with the specified parameters, is created.

Extra Notes N/A

160 CARIS Batch Utility Reference Guide

Engineering Analysis Processes
4
This chapter describes the processes available for the CARIS Batch
command line tool in CARIS Engineering Analysis Module™.

In this chapter...
CALCULATE COMPARATIVE VOLUMES ............................. 100
CALCULATE COVERAGE VOLUMES ................................. 160
CONTOUR RASTER BY MODEL ...................................... 163
Engineering Analysis Processes: Calculate Comparative Volumes

Calculate Comparative Volumes

Description The CalculateComparativeVolumes process compares elevation
data in two coverages to determine the volume of the difference
between them, where the coverages are above a model threshold.
The difference file coverage specified in the options is subtracted
from the input coverage.
Inputs A point cloud or raster surface in a supported format. A BDB
Server URI can be specified as input.
Outputs A volume results XML file.
Command Line Syntax carisbatch --run CalculateComparativeVolumes
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

Common Options

--model-type m The type of model. FALSE This must be

• FILE: File - A reference model file specified explicitly.
• PLANE: Plane - A single horizontal plane
• NONE: None - No model is considered
Options specific to each model type are specified
below.
--input-band i A string specifying the name of the input band. FALSE This must be
This band must contain elevation values. specified explicitly.

--difference-file D A string specifying the path to the coverage FALSE This must be
containing the values to be subtracted. specified explicitly.
--difference-band e A string specifying the band name in the coverage FALSE This must be
containing the values to be subtracted. specified explicitly.
This band must contain elevation values.
--allowance- g A string specifying the allowance algorithm. FALSE
algorithm • NONE: None - No allowance calculation is
performed
• ALL_TERRAIN: All - The volume of the
difference of the two coverages is calculated
separately with a limiting plane at the
specified elevation and a plane at an
elevation of elevation-allowance. The
difference of the two positive results is
reported as the volume calculated by the
allowance algorithm
• WHERE_ABOVE: Above - The volume in the
allowance region is calculated for any area
where the first coverage is above the second
coverage
The default value is NONE.

160 CARIS Batch Utilities Reference Guide

Engineering Analysis Processes: Calculate Comparative Volumes

Parameter

Can Notes
Long Short Description
Repeat

ModelType = File Options

--model-file d A path to a reference model file. FALSE This must be

CARIS reference models and LandXML reference specified explicitly.
models are supported.
--template-name n A string specifying the name of a fully defined TRUE At least one
template in the reference model file. template or surface
None of the specified templates or surfaces are must be specified.
allowed to overlap. This ensures that the total
volume reported does not double-count any areas.
--surface-name s A string specifying the name of a fully defined TRUE At least one
surface in the reference model file. template or surface
None of the specified templates or surfaces are must be specified.
allowed to overlap. This ensures that the total
volume reported does not double-count any areas.
ModelType = Plane Options
--elevation e A number and unit specifying the elevation of the FALSE This must be
horizontal plane. specified explicitly.
All values representing elevations are entered using
the convention that up is positive.
The unit must be specified. Supported units: cable,
ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft,
usmi, usnm, usyd, and yd.
--allowance-value a A number and unit specifying the size of the FALSE
allowance below the plane.
The allowance must be a positive number, or 0.
The unit must be specified. Supported units: cable,
ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft,
usmi, usnm, usyd, and yd.
The default value is 0.0m.

Example To use this command refer to the following example.

Example

Objective You want to determine the volume difference between two coverages.

Description Command Line Syntax

The model type is FILE. --model-type FILE

The model file is named ReferenceModel.xml and located at --model-file ReferenceModel.xml
D:\BatchSample
The input band is Depth. --input-band Depth
The surfaces to be compared are Initial_Survey.csar and --surface-name Initial_Survey.csar --
Postdredge_Survey.csar. surface-name Postdredge_Survey.csar
The difference file

CARIS Batch Utilities Reference Guide

Engineering Analysis Processes: Calculate Comparative Volumes

Example

The difference band

The input file is named xxx D:\BatchSample
The output file is named ComparativeVolumes.xml D:\BatchSample\ComparativeVolumes.x
ml
carisbatch --run CalculateComparativeVolumes --model-type FILE
Command Line
--model-file ReferenceModel.xml D:\BatchSample\

Outcome A report containing the volume comparisons is created

Extra Notes

162 CARIS Batch Utilities Reference Guide

Engineering Analysis Processes: Calculate Coverage Volumes

Calculate Coverage Volumes

Description The CalculateCoverageVolumes process compares elevation data
in a coverage with a model to determine the volume of the
difference between them.
Inputs A point cloud or raster surface in a supported format. A BDB
Server URI can be specified as input.
Outputs A volume results XML file.
Command Line Syntax carisbatch --run CalculateCoverageVolumes
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

--calculation-type y The type of calculation. One of: FALSE This must be

• HYPERBOLIC: Hyperbolic - Calculate based specified explicitly.
on a smooth model of the terrain with
hyperbolic paraboloids modelling each set of
four points.
• RECTANGULAR: Rectangular - Calculate
based on a stepped model of the terrain with
a rectangular prism representing each node.
Hyperbolic and rectangular volume calculations can
only be used for raster surface inputs.
--model-type m The type of model. One of: FALSE This must be
• FILE: File - A reference model file specified explicitly.
• PLANE: Plane - A single horizontal plane
Options specific to each model type are specified
below.
--input-band i A string specifying the name of the input band. FALSE This must be
This band must contain elevation values. specified explicitly.

CARIS Batch Utilities Reference Guide

Engineering Analysis Processes: Calculate Coverage Volumes

Parameter

Can Notes
Long Short Description
Repeat

--allowance- g A string specifying the allowance algorithm. One of: FALSE

algorithm • NONE: None - No allowance calculation is
performed.
• ALL_TERRAIN: All - The volume of the
terrain between a plane at the specified
elevation and a plane at an elevation of
elevation-allowance is calculated.
• WHERE_ABOVE: Above - The volume of the
terrain between a plane at the specified
elevation and a plane at an elevation of
elevation-allowance is calculated, but only
where the terrain is above the specified
elevation.
• FULL: Full - The volume between a plane at
the specified elevation and a plane at an
elevation of elevation-allowance is
calculated.
The default value is NONE.

ModelType = File Options

--model-file d A path to a reference model file. FALSE This must be

CARIS reference models and LandXML reference specified explicitly.
models are supported.
--template-name n A string specifying the name of a fully defined TRUE At least one
template in the reference model file. template or surface
None of the specified templates or surfaces are must be specified.
allowed to overlap. This ensures that the total
volume reported does not double-count any areas.
--surface-name s A string specifying the name of a fully defined TRUE At least one
surface in the reference model file. template or surface
None of the specified templates or surfaces are must be specified.
allowed to overlap. This ensures that the total
volume reported does not double-count any areas
ModelType = Plane Options
--elevation V A number and unit specifying the elevation of the FALSE This must be
horizontal plane. specified explicitly.
All values representing elevations are entered using
the convention that up is positive.
The unit must be specified. Supported units: cable,
ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft,
usmi, usnm, usyd, and yd.

164 CARIS Batch Utilities Reference Guide

Engineering Analysis Processes: Calculate Coverage Volumes

Parameter

Can Notes
Long Short Description
Repeat

--allowance-value a A number and unit specifying the size of the FALSE

allowance below the plane.
The allowance must be a positive number, or 0.
The unit must be specified. Supported units: cable,
ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft,
usmi, usnm, usyd, and yd.
The default value is 0.0m.

Example To use this command refer to the following example.

Example

Objective You want to compare the volume difference between a coverage and a reference model.

Description Command Line Syntax

The calculation type is HYPERBOLIC. --calculation-type HYPERBOLIC

A reference model file will be used. --model-type FILE
The model file is named ReferenceModel.xml and is located at --model-file
D:\BatchSample. D:\BatchSample\ReferenceModel.xml
The reference model template to use for the calculation is --template-name Template1N
Template1N.
The reference model surface to use for the calculation is Surface1. --surface-name Surface1
The input band is Depth. --input-band Depth
The input file is named RasterSurface.csar and located at D:\BatchSample\RasterSurface.csar
D:\BatchSample.
The output file is named VolumeResults.xml and location at D:\BatchSample\VolumeResults.xml
D:\BatchSample.
carisbatch --run CalculateCoverageVolumes --calculation-type
HYPERBOLIC --model-type FILE ---model-file
Command Line D:\BatchSample\ReferenceModel.xml --template-name Template1N --
surface-name Surface1 --input-band Depth
D:\BatchSample\RasterSurface.csar D:\BatchSample\VolumeResults.xml

Outcome An XML file containing the volume results is created.

The results file can be opened in the application and exported to a text file or as a publication
Extra Notes
using a custom template, if needed.

CARIS Batch Utilities Reference Guide

Engineering Analysis Processes: Contour Raster by Model

Contour Raster by Model

Description The ContourRasterByModel process generates isolines to mark
areas of constant value.
Inputs A raster or variable resolution surface dataset.
Outputs A vector file in the specified output format.
Command Line Syntax Usage: carisbatch --run ContourRasterByModel --output-format
<value> --input-band <value> [options] <input> <output>
Options The following table describes the parameters available for this
process.

Parameter

Can Notes
Long Short Description
Repeat

Common Options
--output-format O A string specifying the format in which the output is FALSE This must be specified
generated. One of: explicitly.
• HOB: The CARIS HOB format.
• DXF: The AutoCAD DXF format.
Options specific to each format are specified below.
--input-band i A string specifying the name of the input band. FALSE This must be specified
The input band can be any numeric band. explicitly.

String table bands like Contributor and

Source_Name are supported, but should only be
used with integer intervals.
--range g The interval and minimum and maximum range of TRUE
values to be considered.
<MinValue> - A number specifying the lower bound
of the range.
<MaxValue> - A number specifying the upper
bound of the range.
<Interval> - The spacing between contour values.
If CARIS:NONE is used as the <MinValue>, the
minimum value of the data is used. Similarly, if
CARIS:NONE is used as the <MaxValue>, the
maximum value of the data is used.
All values representing elevations are entered
using the convention that up is positive.
The unit must be specified, unless the input band is
a unitless band like Density. Supported units: cable,
ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm,
usft, usmi, usnm, usyd, yd, deg and rad.

166 CARIS Batch Utilities Reference Guide

Engineering Analysis Processes: Contour Raster by Model

Parameter

Can Notes
Long Short Description
Repeat

--level L A number specifying a contour level. TRUE

All values representing elevations are entered
using the convention that up is positive.
The unit must be specified, unless the input band is
a unitless band like Density.
Supported units: cable, ch, cm, fm, ft, in, inm, km,
m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd,
deg and rad.
--remove- R If set, exactly collinear points are removed from all FALSE
collinear-points created features.
In a future version, collinear points will never be
created in these features.
--generation- G The generation method, controlling the location of FALSE
method nodes and the extents of the boundary.
• GRID: Generate contours based on nodes
in the centre of each cell, with the contour
boundary around all populated cells.
• TRUE_POSITION: Generate contours
based on nodes in the true positions, with
the contour boundary connecting the true
position locations.
The default is TRUE_POSITION. However, setting
the TRUE_POSITION generation method on a
raster with no true position locations will result in
GRID-based contours.
--template T The URI for a reference model template containing TRUE
horizontal reference model surfaces to be
considered for contour levels.
The format of the URI is
file:///path_to_file?template=template_name, for
example, you would enter the following for
Template 0001 in D:\RefModel.xml:
"file:///
D:\RefModel.xml?template=Template%200001"
More than one template can be specified as a
source for contour levels.
--add-model- V If set, contours are created at the elevation of each FALSE
elevations horizontal reference model surface in each
specified template.
--add- A If set, contours are created at the allowance above FALSE
allowances- the elevation of each horizontal reference model
above surface in each specified template.
--add- W If set, contours are created at the allowance below FALSE
allowances- the elevation of each horizontal reference model
below surface in each specified template.

CARIS Batch Utilities Reference Guide

Engineering Analysis Processes: Contour Raster by Model

Parameter

Can Notes
Long Short Description
Repeat

OutputFormat = HOB
--feature- F A string specifying the name of the catalogue that FALSE This must be specified
catalogue defines the features and attributes in the input explicitly.
dataset. One of {list dynamically populated from the The default location of
catalogue control file}. CatalogueControl.xml
The catalogue must be in the catalogue control file file is C:\Program
specified in Tools > Options > Files and Folders > Files\CARIS\BASE
Files > Catalogue Control, for example S-57 ENC Editor\4.2\system\.
3.1.
--contour- C A string specifying the feature acronym of the line FALSE This must be specified
feature object to be used for contour line features. explicitly.
The specified acronym must be present in the
specified catalogue.
--level-attribute a A string specifying the attribute acronym for the FALSE This must be specified
level of contour line features. explicitly.
--boundary- B A string specifying the feature acronym of the area FALSE This is optional. If it is
feature object to be used for the data boundary. not specified, no
The specified acronym must be present in the boundary features will
specified catalogue. be created in the
output HOB file.
--polygon- P The mapping for polygons created between FALSE
feature successive contour line features.
<AreaObject> - A string specifying the feature
acronym of the area object to be used for the
polygons.
<MinAttribute> - A string specifying the attribute
acronym for the minimum value of bounding
contours.
<MaxAttribute> - A string specifying the attribute
acronym for the maximum value of bounding
contours.
CARIS:NONE can be used for the MinAttribute and/
or MaxAttribute.
OutputFormat = DXF
--boundary- B A string specifying the name of the area object to FALSE This is optional. If it is
name be used for the data boundary. not specified, no
boundary features will
be created in the
output DXF file.
--contour-name C A string specifying the name of the line object to be FALSE This is optional.
used for contour line features.
The default value is Contour.

168 CARIS Batch Utilities Reference Guide

Engineering Analysis Processes: Contour Raster by Model

Example To use this command refer to the following example.

Example

You want to create contours for a raster surface at specific levels, and also for the areas of
Objective
the raster surface that are crossed by the reference model surfaces in a template.

Description Command Line Syntax

The data will be contoured between a lower boundary of -100 metres, --range -100m 0m 10m
an upper boundary of 0 metres, with a contour interval of 10 metres.
An extra contour level is needed at a depth of 5m. --level -5m
The path for the template containing the reference model surfaces is --template file:///
"file:///D:\ReferenceModel.xml?template=Template0001" D:\ReferenceModel.xml?template=Temp
late0001
Contours are to be created for the elevation value of each reference --add-model-elevations
model surface.
The output format is HOB. --output-format HOB
The feature catalogue name is Bathy DataBASE --feature-catalogue "Bathy DataBASE"
The contour feature is DEPCNT. --contour-feature DEPCNT
The level attribute is VALDCO. --level-attribute VALDCO
The polygon feature for the depth areas is DEPARE. The attributes for --polygon-feature DEPARE DRVAL1
the minimum and maximum values of the polygons are DRVAL1 and DRVAL2
DRVAL2, respectively.
A data boundary.is to be generated using the cvrage object acronym. --boundary-feature cvrage
The input band is named Depth. --input-band Depth
The input surface is named RasterSurface.csar and is in the D:\BatchSample\RasterSurface.csar
BatchSample directory on the D: drive.
The output file will be named RefModelContours.hob and will be D:\BatchSample\RefModelContours.hob
saved in the source directory.
carisbatch --run ContourRasterByModel --range -100m 0m 10m --level
-5m --template file:///D:\ReferenceModel.xml?template=Template0001
--add-model-elevations --output-format HOB --feature-catalogue "Bathy
Command Line DataBASE" --contour-feature DEPCNT --level-attribute VALDCO --
polygon-feature DEPARE DRVAL1 DRVAL2 --boundary-feature cvrage --
input-band Depth D:\BatchSample\RasterSurface.csar
D:\BatchSample\RefModelContours.hob
Contours are generated at the specified levels throughout the input, and also for the areas of
Outcome the raster surface that are crossed by the reference model surfaces in the specified template.
The contours are saved to a HOB file in the specified location.

Extra Notes

CARIS Batch Utilities Reference Guide

5
Compose Processes

This chapter describes the processes available for the CARIS Batch
command line tool in the Compose module.

In this chapter...
ASSIGN SOUNDING SCAMIN VALUES........................... 168
EXPORT S-57 PRODUCT ............................................. 170
Compose Processes: Assign Sounding SCAMIN Values

Assign Sounding SCAMIN Values

Description The AssignSoundingScaminValues process calculates minimum
display scale (SCAMIN) values for S-57 sounding features using
specified parameters.
Inputs Features in a supported format. HOB, 000 (S-57 specification)
are supported.
Outputs Features in HOB format with assigned SCAMIN values.
Command Line Syntax carisbatch --run AssignSoundingScaminValues [options]
<inputs> <output>
Options The following table describes the parameters available for this
process.
Parameter

Can
Long Short Description Notes
Repeat

--feature- F A string specifying the name of the catalogue that FALSE This must be
catalogue defines the features and attributes in a vector explicitly specified.
dataset. One of list dynamically populated from the
catalogue control file.
The names of the available catalogues can be
accessed through application via the Object
Catalogue environment variable in Tools > Options.
The available catalogues are controlled by the
Catalogue Control file. An example of a catalogue
name is "S-57 ENC 3.1".
--map-scale M A number specifying the scale of the input map FALSE
(1:scale). This is only needed for HOB format.
This parameter is required when the input is in HOB
format since HOB files do not have a scale. This
parameter is ignored when the input is in S-57
format since S-57 format has a scale.
--scaling- P The path to the file specifying parameters for the FALSE This must be
parameters-file calculation of SCAMIN values. explicitly specified.
Parameters are:
• minimum depth, maximum depth and radius
values for sounding suppression
• scale factors for calculation of SCAMIN values
• optional compilation scale multiplier for calculation
of SCAMIN values
For details, see the Compose support files section in
the Compose module documentation or the sample
files (sdgparm.txt and sdgparm_S-65.txt) included
with the Compose module.

168 CARIS Batch Utilities Reference Guide

Compose Processes: Assign Sounding SCAMIN Values

Example 1 To use this command refer to the following examples.

Example

Objective You want to apply SCAMIN values to soundings in a HOB file.

Description Command Line Syntax

The input has features and attributes defined in the S-57 ENC 3.1 --feature-catalogue "S-57 ENC 3.1"
feature catalogue.
The map scale of the input file is 1:10000 --map-scale 10000
The scaling parameters file is named sdgparm.txt. --scaling-parameters-file sdgparm.txt
The input HOB file is named gb4x0000_in.hob and is located in D:\BatchSample\gb4x0000_in.hob
D:\BatchSample.
The input HOB file is named gb4x0000_out.hob and is located in D:\BatchSample\gb4x0000_out.hob
D:\BatchSample.
Command Line carisbatch --run AssignSoundingScaminValues --feature-catalogue "S-57
ENC 3.1" --map-scale 10000 --scaling-parameters-file sdgparm.txt
D:\BatchSample\gb4x0000_in.hob D:\BatchSample\gb4x0000_out.hob
Outcome SCAMIN values are added to soundings in the input HOB file and saved as a new HOB file.

Extra Notes N/A

Example 2

Example

Objective You want to apply SCAMIN values to soundings in a .000 file.

Description Command Line Syntax

The input has features and attributes defined in the S-57 ENC 3.1 --feature-catalogue "S-57 ENC 3.1"
feature catalogue.
The scaling parameters file is named sdgparm_S-65.txt. --scaling-parameters-file
sdgparm_S-65.txt
The input .000 file is named gb4x0000.000 and is located in D:\BatchSample\gb4x0000.000
D:\BatchSample.
The input HOB file is named gb4x0000_out.hob and is located in D:\BatchSample\gb4x0000.hob
D:\BatchSample.
Command Line carisbatch --run AssignSoundingScaminValues --feature-catalogue "S-57
ENC 3.1" --scaling-parameters-file sdgparm_S-65.txt
D:\BatchSample\gb4x0000.000 D:\BatchSample\gb4x0000.hob
Outcome SCAMIN values are added to soundings in the input .000 file and saved as a new HOB file.

Extra Notes N/A

CARIS Batch Utilities Reference Guide 169

Compose Processes: Export S-57 Product

Export S-57 Product

Description The ExportS57Product process exports an S-57 product.
Update An S-57 product (.prd file) as produced by the Compose module.
Outputs The exported S-57 (.000) file as named in the S-57 product (.prd)
file.
Command Line Syntax carisbatch --run ExportS57Product [options] input
Options The following table describes the parameters available for this
process.
Parameter

Can
Long Short Description Notes
Repeat

--create-new-edition N If set, a new edition will be exported by FALSE Optional.

incrementing the edition number in the product
(.prd) file by one and using that edition number.
--comment-for-dsid C A string specifying a comment for the S-57 data FALSE Optional.
set ID (DSID) that will override the one given in
the product (.prd) file.
--issue-date I A string specifying the issue date for the S-57 FALSE Optional.
data set that will override the one given in the
product (.prd) file.
Dates are specified in the standard ISO 8601
extended format for batch processes, which is
YYYY-MM-DD or YYYY-DDD. See ISO 8601
documentation for more information.

Example 1 To use this command refer to the following examples.

Example

Objective You want to export the current file as a product.

Description Command Line Syntax

The name of the product file is gb4x0000.prd and it is located in D:\BatchSample\gb4x0000.prd

D:\BatchSample.
The issue date for the product is October 5, 2016. --issue-date “2016-10-05”
Command Line carisbatch --run ExportS57Product --issue-date “2016-10-05”
D:\gb4x0000.prd
Outcome The product is exported.

Extra Notes N/A

170 CARIS Batch Utilities Reference Guide

Compose Processes: Export S-57 Product

Example 2

Example

Objective Export a new product with a new edition, comment, and issue date.

Description Command Line Syntax

Create a new edition. --create-new-edition

Define a new DSID comment. -comment-for-dsid "Update beacons and buoys."
Define a new issue date. --issue-date "2016-11-16"
The output product is named gb4x0000.prd and is located D:\BatchSample\gb4x0000.prd
in D:\BatchSample\.
Command Line carisbatch --run ExportS57Product --create-new-edition --comment-for-
dsid "Update beacons and buoys." --issue-date "2016-11-16"
D:\BatchSample\gb4x0000.prd
Outcome A new product using the defined parameters is created.

Extra Notes N/A

CARIS Batch Utilities Reference Guide 171

Compose Processes: Export S-57 Product

172 CARIS Batch Utilities Reference Guide

4
HIPS Processes

This chapter describes the processes available for the CARIS Batch
command line tool in HIPS and SIPS.

ADD TO HIPS GRID ADD TO SIPS MOSAIC

COMPARE HIPS COMPUTE HIPS GPS TIDE
COMPUTE HIPS SEPARATION MODEL COMPUTE HIPS TPU
COMPUTE SIPS TOWFISH CREATE HIPS GRID
NAVIGATION
CREATE SIPS BEAM PATTERN CREATE SIPS MOSAIC
DETECT HIPS CRITICAL SOUNDINGS FILTER HIPS ATTITUDE
FILTER OBSERVED DEPTHS FILTER PROCESSED DEPTHS
IMPORT GENERIC TO HIPS IMPORT HIPS FROM AUXILIARY
IMPORT MULTIPLE DETECTIONS TO IMPORT TIDE TO HIPS
HIPS
IMPORT TO HIPS MERGE HIPS
RECOMPUTE HIPS GRID REMOVE FROM HIPS GRID
REMOVE FROM SIPS MOSAIC RESET HIPS STATUS
SET HIPS NAVIGATION SOURCE SHIFT HIPS NAVIGATION
SOUND VELOCITY CORRECT HIPS UPDATE HIPS ADDITIONAL BATHYMETRY
UPDATE RASTER CUBE UPDATE SIPS CONTACT POSITIONS
DISAMBIGUATION
HIPS Processes: Add To HIPS Grid

Add To HIPS Grid

Description The AddToHIPSGrid process adds HIPS1 track lines to an existing
HIPS surface using the create process parameters stored in the
CSAR metadata.
Update The HIPS surface to update.
Inputs One or more HIPS track lines.
Outputs Updated HIPS surface.
Command Line Syntax carisbatch --run AddToGridHIPS [options] <inputs> <update>
Options None.

Example To use this command, refer to the following example.

Example

Objective To add track lines to an existing surface.

Description Command Line Syntax

The input file is named input.hips and is located at C:\temp\input. The file:///C:/temp/input/
HIPS file URI filters for the vessel named “sample” and day 2000-001. input.hipsVessel=sample;Day=2000-001
The output file is named ExistingHIPSRasterSurface.csar, located at D:\BatchSample\ExistingHIPSRasterSur
D:\BatchSample. face.csar
carisbatch --run AddToHIPSGrid file:///C:/temp/input/
Command Line input.hips?Vessel=sample;Day=2000-001
D:\BatchSample\ExistingHIPSRasterSurface.csar

Outcome The gridded surface is updated with the track line data added to it.

Extra Notes N/A

1. This term is a trademark of Teledyne CARIS, Reg. USPTO.

392 CARIS HIPS and SIPS User Guide

HIPS Processes: Add To SIPS Mosaic

Add To SIPS Mosaic

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

Short Can Notes

Long Description
key repeat

Common Options

--mosaic-engine m The mosaic engine used to generate the output mosaic. FALSE This must
• SIPS_BACKSCATTER: SIPS Backscatter engine be explicitly
processes multibeam backscatter data referenced by specified.
HIPS data
• SIPS_SIDESCAN: SIPS Side Scan engine processes
side scan data converted into HIPS format
• GEOCODER: Uses GeoCoder functionality from UNH
--blending The method used to blend pixels together. FALSE
• 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.
--weighting The method used to weight pixels across a single ping. FALSE
• 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.

MosaicEngine = SIPS_BACKSCATTER Options

--avg A number specifying the number of across track samples to FALSE

include in the moving average filter.
Use a moving average filter to remove the angular response
of sediment from the imagery.
--beam-pattern-file If set, applies a Beam Pattern by setting the path to the FALSE
beam pattern file.
If not set, no Beam Pattern is applied.

CARIS HIPS and SIPS User Guide 393

HIPS Processes: Add To SIPS Mosaic

Parameter

Short Can Notes

Long Description
key repeat

--beam-pattern- If the beam pattern file selected already exists, sets the file FALSE Used only
file-operation operations on the existing file. with Beam
• UPDATE: Updates the file with the new line information, Pattern File
can accumulate many lines over many surveys set.
• 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.
--local-absorption A number specifying correction for transmission loss using FALSE
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.
--nadir-angle-t1 Set Transducer 1 angles across-track from directly below the FALSE
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.
--nadir-angle-t2 Set Transducer 2 angle across-track from directly below the FALSE
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.
--surface The path to the surface used to compute the local bottom FALSE
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.
--filter -f A number limiting the final compensated intensities in the FALSE
mosaic to a minimum/maximum range.
Supported units: dB.
--sound-velocity A number specifying the sound velocity values set by the FALSE
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.

394 CARIS HIPS and SIPS User Guide

HIPS Processes: Add To SIPS Mosaic

Parameter

Short Can Notes

Long Description
key repeat

MosaicEngine = SIPS_SIDESCAN Options

--channel Select the data channel to read for processing. FALSE

• BOTH: Both channels
• PORT: Port channel
• STARBOARD: Starboard channel
The default value is BOTH.
--beam-pattern Apply beam pattern correction. FALSE
• 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.
--beam-pattern-file The path to the beam pattern file. FALSE
Only applicable if Beam Pattern is not set to NONE.
--gain A number specifying the gain correction to apply to the port/ FALSE
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.
--tvg A number specifying the time-varying gain correction to FALSE
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.
--gain- A number specifying the number of pings used to set the FALSE
normalization window size for the moving-average window filter.
The default value is 20. The valid range is 1 or greater.
--despeckle A number specifying the strength of the despeckle filter as a FALSE
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.
--ratio A number specifying the across-track distance to altitude FALSE
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.

CARIS HIPS and SIPS User Guide 395

HIPS Processes: Add To SIPS Mosaic

Parameter

Short Can Notes

Long Description
key repeat

--ratio-limit A number limiting the Across-track/Altitude Ratio ratio filter FALSE

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.
--across-distance- A number limiting the across-track distance from nadir to a FALSE
limit minimum/maximum range.
• <Minimum> - The minimum distance from nadir.
• <Maximum> - The maximum distance from nadir.
The default value is 0. Supported units: metres.
--filter f A number limiting the final compensated intensities in the FALSE
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.
--extrapolate-time A number to set extrapolate heading/motion data for the FALSE
specified time interval.
The default value is 0. Supported units: seconds
--registration- If set, registers the imagery using co-acquired bathymetry. FALSE
bathy Only applicable if the lines contain processed bathymetry.
--gyro-source The heading source to be used for processing. FALSE
• 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.
--smooth-gyro If set, applies smoothing coefficients to the gyro data. FALSE
--sound-velocity A number to set the sound velocity applied during slant FALSE
range correction.
The default value is 1500 m/s. Supported units: metres/
second.
--altitude-offset A number to set an offset for the altitude data in time/height. FALSE
• <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.

396 CARIS HIPS and SIPS User Guide

HIPS Processes: Add To SIPS Mosaic

Parameter

Short Can Notes

Long Description
key repeat

MosaicEngine = GEOCODER Options

--channel Select the data channel to read for processing. FALSE

• BOTH: Both channels
• PORT: Port channel
• STARBOARD: Starboard channel
The default value is BOTH.

‐‐imagery The type of imagery to be process. FALSE

• 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.
--auto-resolution If set, automatically determines best resolution based on FALSE
data density. This overrides the Resolution parameter.
-disable-anti-alias if set, disables application of anti-aliasing during imagery FALSE
correction.
--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- FALSE

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.
--avg-window-size The window size in pixels used for AVG correction. FALSE
--despeckle Apply despeckle to the mosaic. FALSE
• NONE:
• WEAK:
• MODERATE:
• STRONG:
• VERY_STRONG:
The default value is NONE.
-nadir-angle Set angle across-track from directly below the transducer (0 FALSE
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.

CARIS HIPS and SIPS User Guide 397

HIPS Processes: Add To SIPS Mosaic

Parameter

Short Can Notes

Long Description
key repeat

--filter f A number limiting the final compensated intensities in the FALSE

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.
--surface The path to the surface used to compute the local bottom FALSE
slope used in the GeoCoder calculations of real incidence
angle and ensonified area. The default elevation band will be
used.
--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 file:///D:/Data/
filters for the vessel named “Voyager” and day 2015-044 and line Demo.hips?Vessel=Voyager;Day=2015-
1344_20080926_202553_Voyager. 044;Line=1344_20080926_202553_Voya
ger
The output file will be named ss_mosaic.csar located at D:\BatchSample\ss_mosaic.csar
D:\BatchSample.
carisbatch --run AddToSIPSMosaic --mosaic-engine SIPS_SS --channel
Command BOTH --intensity -200.0dB 200.0dB file:///D:/Data/
Line Demo.hips?Vessel=Voyager;Day=2015-
044;Line=1344_20080926_202553_Voyager D:\BatchSample\ss_mosaic.csar

Outcome Line 1344_20080926_202553_Voyager is added to the existing mosaic.

Extra Notes N/A

398 CARIS HIPS and SIPS User Guide

HIPS Processes: Compare HIPS

Compare HIPS
Description The CompareHIPS process is used to compare two HDCS lines.
Inputs Two HIPS track lines.
Outputs None
Command Line Syntax carisbatch --run CompareHIPS --compare <value> [options]
<inputs>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

--compare T The type of HDCS data to compare. One of: TRUE

• ALL: Compare all data.
• BATHYMETRY: Compare bathymetry, includes observed
and processed depths, slant range, TPU, tide, GPS tide,
GPS height, RMS and sonar error.
• NAVIGATION: Compare navigation, includes navigation
and SSS navigation.
• MOTION: Compare auxiliary data, includes gyro, heave,
TrueHeave, pitch, roll, delta draft/subsea depth, speed
over water, surface sound speed.
• SIDESCAN: Compare stored side scan data, including
beam amplitude, sidescan, processed sidescan, towfish
height, towfish depth.
The default value is ALL.
--backscatter- Tolerance to use when comparing backscatter values. FALSE
precision The default value is 0.0000001.
--bathymetry- Tolerance to use when comparing bathymetry values. FALSE
precision
The default value is 0.0000001.
--motion- Tolerance to use when comparing motion values. FALSE
precision
The default value is 0.0000001.
--navigation- Tolerance to use when comparing navigation values. FALSE
precision
The default value is 0.0000001.
--sidescan- Tolerance to use when comparing sidescan values. FALSE
precision The default value is 0.0000001.

Example To use this command, refer to the following example.

Example

Objective To compare data on two HDCS lines.

Description Command Line Syntax

Compares bathymetry between two lines. --compare BATHYMETRY

CARIS HIPS and SIPS User Guide 399

HIPS Processes: Compare HIPS

Example

Compares navigation between two lines. --compare NAVIGATION

The input file is named input.hips and is located at C:\temp\input. The file:///C:/temp/input/
HIPS file URI filters for the vessel named “sample” and day 2000-001 input.hipsVessel=sample;Day=2000-
and line Line_001.. 001;Line=Line_001
The reference file is named input.hips and is located at C:\temp\input. file:///C:/temp/input/
The HIPS file URI filters for the vessel named “sample” and day 2000- input.hipsVessel=sample;Day=2000-
001 and line Line_002. 001;Line=Line_002
carisbatch --run CompareHIPS --compare BATHYMETRY --compare
NAVIGATION file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-
Command Line
001;Line=Line_001 file:///C:/temp/input/
input.hips?Vessel=sample;Day=2000-001;Line=Line_002

Outcome The differences, if any, between the track lines is reported.

Extra Notes N/A

400 CARIS HIPS and SIPS User Guide

HIPS Processes: Compute HIPS GPS Tide

Compute HIPS GPS Tide

Description The ComputeHIPSGPSTide process provides an alternative to
normal tidal observation for reducing soundings to the sounding
datum. A single sounding datum height, or a datum model file
with a grid of datum heights, can be applied with the GPS height
during the computation.
Update One or more HIPS track lines.
Outputs Updated HIPS track lines.
Command Line Syntax carisbatch --run ComputeHIPSGPSTide [options] <update>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

Common Options

--datum- The type of datum separation to apply. FALSE

separation- • FIXED: Fixed Height - A fixed separation is used.
type • MODEL: Datum Model - A sounding datum model is used.
The default value is FIXED.
--smooth- If set, applies smoothing to GPS height. FALSE
height
--dynamic- Type of dynamic heave to be applied. One of. FALSE
heave • NONE: No dynamic heave will be used
• HEAVE: Original heave data will be used
• DELAYED_HEAVE: Delayed heave data will be used.
The default value is NONE.
--MRU- If set, applies remote heave resulting from vessel roll/pitch on an FALSE
remote-heave offset-mounted MRU.
-antenna- If set, applies the offset of the GPS antenna from the reference FALSE
offset point.
--dynamic- If set, applies dynamic draft. Either as a result of interpolating the FALSE
draft draft table from the HIPS Vessel File (HVF) or as stored in HIPS
as time series data.
--waterline Type of waterline offset to apply. FALSE
• NONE: No waterline will be used
• VESSEL: Apply the waterline offset from the HIPS Vessel
File
• REALTIME: Apply the waterline value from the
InstallationParameters.xml file generated by the
converter.
The default value is NONE.

CARIS HIPS and SIPS User Guide 401

HIPS Processes: Compute HIPS GPS Tide

Parameter

Short Can Notes

Long Description
key Repeat

--height- A number specifying the height correction as a static offset to the FALSE
correction GPS antenna.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm,
usfm, usft, usmi, usnm, usyd and yd.
--time-offset A number specifying the time offset to the GPS Height data. FALSE
Supported units: sec, min, hour, day, week.
--output- If set, an ASCII text file (GPSTideComponents.txt) is created in FALSE
components the line folder with all the components extracted/interpolated
during the process.

DatumSeparationType = FIXED Options

--datum-fixed- A number specifying the single value for datum height. FALSE
height The default value is 0.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm,
usfm, usft, usmi, usnm, usyd and yd.
DatumSeparationType = MODEL Options
--datum- The file path to the datum model. FALSE
model-file The datum model can be one of type TIN, raster surface or point
cloud.
--datum- A string specifying the datum model band name. FALSE
model-band Only applicable when DatumModelPath is provided a raster
surface or point cloud in the CSAR format.
--info-file s The path to the file that describes the format of the input ASCII FALSE
files.
This must be set when DatumModelPath is provided an ASCII
XYZ file.
--input-crs p A string specifying the horizontal coordinate reference system FALSE This must
key of the input. be
This must be set when DatumModelPath is provided an ASCII explicitly
XYZ file. set.

Example To use this command, refer to the following example.

Example

To apply a tide correction to HIPS track line data using a single sounding datum height with a
Objective
grid of datum heights.

Description Command Line Syntax

Use a Fixed separation height. --datum-separation-type FIXED

The fixed height is 10 m. --datum-fixed-height 10m
The dynamic heave is set to delayed heave. --dynamic-heave DELAYED_HEAVE
Apply the remote heave resulting from vessel roll/pitch. --mru-remote-heave

402 CARIS HIPS and SIPS User Guide

HIPS Processes: Compute HIPS GPS Tide

Example

Apply the waterline offset from the HIPS vessel file. --waterline VESSEL
The input file is named input.hips and is located at C:\temp\input. The file:///C:/temp/input/
HIPS file URI filters for the vessel named “sample” and day 2000-001. input.hipsVessel=sample;Day=2000-001
carisbatch --run ComputeHIPSGPSTide --datum-separation-type FIXED --
datum-fixed-height 10m --dynamic-heave DELAYED_HEAVE --mru-remote-
Command Line
heave --waterline VESSEL file:///C:/temp/input/
input.hips?Vessel=sample;Day=2000-001

Outcome The selected HIPS track line is updated using with the tide data correction.

Extra Notes N/A

CARIS HIPS and SIPS User Guide 403

HIPS Processes: Compute HIPS Separation Model

Compute HIPS Separation Model

Description The ComputeHIPSSeparationModel process uses HIPS Data with
Tide loaded to create a separation model in CSAR format.
Inputs One or more HIPS track lines.
Outputs A raster surface in CSAR format.
Command Line Syntax carisbatch --run ComputeHIPSSeparationModel [options]
<inputs> <output>
The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

--resolution R A number and unit specifying the resolution of the output FALSE This must
raster. be explicitly
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, specified.
nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.
--smooth-height If set, applies smoothing to GPS height. FALSE
--dynamic- Type of dynamic heave to be applied. One of: FALSE
heave • NONE: No dynamic heave will be used
• HEAVE: Original heave data will be used
• DELAYED_HEAVE: Delayed heave data will be used.
The default value is NONE.
--mru-remote- If set, applies remote heave resulting from vessel roll/pitch on FALSE
heave an offset-mounted MRU.
--antenna-offset If set, applies the offset of the GPS antenna from the FALSE
reference point.
--dynamic-draft If set, applies dynamic draft. Either as a result of interpolating FALSE
the draft table from the HIPS Vessel File (HVF) or as stored in
HIPS as time series data.
--waterline Type of waterline offset to apply. One of: FALSE
• NONE: No waterline will be used.
• VESSEL: Apply the waterline offset from the HIPS
Vessel File.
• REALTIME: Apply the waterline value from the
InstallationParameters.xml file generated by the
converter.
The default value is NONE.
--height- A number specifying the height correction as a static offset to FALSE
correction the GPS antenna.
Supported units: metres.
--time-offset A number specifying the time offset to the GPS Height data. FALSE
Supported units: seconds.

404 CARIS HIPS and SIPS User Guide

HIPS Processes: Compute HIPS Separation Model

Example To use this command, refer to the following example.

Example

Objective To create a separation model in CSAR format using HIPS Data with Tide loaded.

Description Command Line Syntax

The resolution is set to 10m. --resolution 10m

The dynamic heave is set to delayed heave. --dynamic-heave DELAYED_HEAVE
Apply the remote heave resulting from vessel roll/pitch. --mru-remote-heave
The input file is named input.hips and is located at D:\BatchSam- file:///D:\BatchSample/input/
ple\input. The HIPS file URI filters for the vessel named “sample” and input.hips?Vessel=sample;Day=2000-
day 2000-001. 001
The output file is namedseparation_model.csar located at D:\BatchSample\separation_model.csar
D:\BatchSample.
carisbatch --run HIPSSeparationModel --resolution 10m --dynamic-heave
DELAYED_HEAVE --mru-remote-heave file:///D:\BatchSample/input/
Command Line
input.hips?Vessel=sample;Day=2000-001
D:\BatchSample\separation_model.csar

Outcome A separation model is created.

Extra Notes N/A

CARIS HIPS and SIPS User Guide 405

HIPS Processes: Compute HIPS TPU

Compute HIPS TPU

Description The ComputeHIPSTPU process calculates a total depth and position
uncertainty for all soundings from a combination of all
individual error sources via the Total Propagated Uncertainty
(TPU) model.
Updates One or more HIPS track lines.
Outputs Updated HIPS track line.
Command Line Syntax carisbatch --run ComputeHIPSTPU [options] <updates>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

--tide- A number specifying the error value for the tide station. It is FALSE
measured equivalent to the standard deviation of the tide gauge
measurements. The value is Ignored if tide source is real-time.
The default value is 0.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm,
usfm, usft, usmi, usnm, usyd and yd.
--tide-zoning A number specifying the value for the vertical uncertainty in the FALSE
range calculation for a tide zone file.
The default value is 0.
HIPS does not model the TPU for the tide zone. Instead a single
user-defined value may be used here.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm,
usfm, usft, usmi, usnm, usyd and yd.
--sv- A number specifying the value for the uncertainty of inaccuracies in FALSE
measured SVP measurements.
The default value is 0.
Supported units: ft/s, km/h, kn, m/s, mi/h, usft/s and usmi/h.
--sv-surface A number specifying the surface offset value used to account for FALSE
errors in surface sound speed measurements that alter the beam
angle. (This parameter is only applicable to systems that require
accurate surface sound speed measurements.)
The default value is 0.
Supported units: ft/s, km/h, kn, m/s, mi/h, usft/s and usmi/h.
--sweep- A number specifying the maximum uncertainty value for the FALSE
max-heave estimated observed heave of the transducer boom.
The default value is 0.
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm,
usfm, usft, usmi, usnm, usyd and yd.

406 CARIS HIPS and SIPS User Guide

HIPS Processes: Compute HIPS TPU

Parameter

Short Can Notes

Long Description
key Repeat

--sweep- A number specifying the maximum uncertainty value for the FALSE
max-pitch estimated observed pitch of the transducer boom.
The default value is 0.
Supported units: deg and rad.
--sweep- A number specifying the maximum uncertainty value for the FALSE
max-roll estimated observed roll of the transducer boom.
The default value is 0.
Supported units: deg and rad.
--source- Source of the uncertainty values for the sonar. FALSE
sonar • VESSEL: Use the static model value from the vessel
configuration.
• REALTIME: Use the stored real-time value.
The default value is VESSEL.
--source- Source of the uncertainty values for the navigation. FALSE
navigation • VESSEL: Use the static model value from the vessel
configuration.
• REALTIME: Use the stored real-time value.
The default value is VESSEL.
--source- Source of the uncertainty values for the gyro. FALSE
gyro • VESSEL: Use the static model value from the vessel
configuration
• REALTIME: Use the stored real-time value.
The default value is VESSEL.
--source- Source of the uncertainty values for the pitch. FALSE
pitch • VESSEL: Use the static model value from the vessel
configuration.
• REALTIME: Use the stored real-time value.
The default value is VESSEL.
--source-roll Source of the uncertainty values for the roll. FALSE
• VESSEL: Use the static model value from the vessel
configuration.
• REALTIME: Use the stored real-time value.
The default value is VESSEL.
--source- Source of the uncertainty values for the heave. FALSE
heave • VESSEL: Use the static model value from the vessel
configuration.
• HEAVE: Use the stored real-time heave value.
• DELAYED: Use the stored real-time delayed heave value.
The default value is VESSEL.
--source-tide Source of the uncertainty values for the tide. FALSE
• STATIC: Use a static value - comes from the dialog.
• REALTIME: Use the stored real-time value - can be created
by user control when loading tide.
The default value is STATIC.

CARIS HIPS and SIPS User Guide 407

HIPS Processes: Compute HIPS TPU

Example To use this command, refer to the following example.

Example

Objective To calculate the Total Propagated Uncertainty (TPU) in HIPS track line data.

Description Command Line Syntax

The error value for the tide station is 2. --tide-measured 0.1m

The value for vertical uncertainty in the tide zone is set to 0.1m --tide-zoning 0.1m
The surface offset applied is 0.1m/s. --sv-surface 0.1m/s
The stored REALTIME value is used as source for gyro. --source-sonar REALTIME
The updated file is named input.hips and is located at C:\temp\input. file:///C:/temp/input/
The HIPS file URI filters for the vessel named “sample” and day 2000- input.hips?Vessel=sample;Day=2000-
001. 001.\
carisbatch --run ComputeHIPSTPU --tide-measured 0.1m --tide-zoning
Command Line 0.1m --sv-measured 0.1m/s --sv-surface 0.1m/s --source-sonar REALTIME
file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001.

Outcome The line data for day 2000-001is updated by applying total depth and position uncertainty.

Extra Notes N/A

408 CARIS HIPS and SIPS User Guide

HIPS Processes: Compute SIPS Towfish Navigation

Compute SIPS Towfish Navigation

Description The ComputeSIPSTowfishNavigation process computes the
position of a towfish from the ship's navigation using a
horizontal distance and direction from the ship's towpoint to the
towfish.
Update One or more HIPS track lines.
Outputs Updated HIPS track lines.
Command Line Syntax carisbatch --run ComputeSIPSTowfishNavigation [options]
<update>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

--smooth- If set, applies smoothing coefficients to the specified data. TRUE

sensor • GYRO: Gyro - Smooths the gyro data.
• SSSSensor: Side scan sensor depth - Smooths the side scan
sensor depth data.
• SSSCable: Side scan cable out - Smooths the side scan
cable out data.
--use-cmg If set, calculates Course Made Good from the Navigation for FALSE
heading. Otherwise stored gyro is used.
--recompute- If set, recomputes the position of any existing contacts with the new FALSE
contact- navigation.
positions

Example To use this command, refer to the following example.

Example

Objective To compute the position of a towfish from a ship’s navigation data.

Description Command Line Syntax

The gyro data will be smoothed. --smooth-sensor GYRO

The position of existing contacts will be recomputed using new --recompute-contact-positions
navigation data.
The input file is named input.hips and is located at C:\temp\input\. The C:\temp\input\
HIPS file URI filters for the vessel named “sample” and day 2000-001.
carisbatch --run ComputeSIPSTowfishNavigation --smooth-sensor GYRO --recompute-
Command Line
contact-positions file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001

Outcome The data is updated with the computed towfish position data.

Extra Notes N/A

CARIS HIPS and SIPS User Guide 409

HIPS Processes: Create HIPS Grid

Create HIPS Grid

Description The CreateHIPSGrid process creates a raster surface using a
HIPS gridding method.
Inputs One or more HIPS track lines.
Outputs A raster surface in CSAR format.
Command Line Syntax carisbatch --run CreateHIPSGrid --gridding-method <value> --
extent <value> --resolution <value> --output-crs <value>
[options] <inputs> <output>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

Common Options

--gridding-method g The gridding method used to generate the output raster. FALSE This must be
One of: specified
• SHOAL_TRUE: Shoalest Depth True Position - explicitly.
Shoalest depth with true positions
• SWATH_ANGLE: Swath Angle - Beam geometry
weighting
• UNCERTAINTY: Uncertainty - TPU weighting
• CUBE: CUBE - CUBE algorithm
--resolution R A number and unit specifying the resolution of the output FALSE This must be
raster. explicitly
Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, specified.
mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.
--extent E The extents that defines the window. FALSE This must be
<LowerX> - A number specifying the lower left X origin in explicitly
the coordinate reference system of the output. specified.

<LowerY> - A number specifying the lower left Y origin in

410 CARIS HIPS and SIPS User Guide

HIPS Processes: Create HIPS Grid

Parameter

Short Can Notes

Long Description
key Repeat

--output-vertical- o A string specifying the vertical coordinate reference FALSE

crs system key of the output.
No vertical transformation will be applied even if a value
is specified. This value is only used as metadata on the
output dataset.
The default value is Unknown.
--primary-band m A string specifying the name given to the primary band of FALSE
the output.
The default value is Depth.
--compute-band a A string specifying an output band to be computed from TRUE
the input points. One of:
• SHOAL: Shoal - Shoalest of all values that
contributed to populating the cell
• DEEP: Deep - Deepest of all values that
contributed to populating the cell
• DENSITY: Density - Number of points that
contributed to populating the cell
• MEAN: Mean - Mean of all values that contributed
to populating the cell
• STD_DEV: Standard deviation - Standard
deviation of all values that contributed to
populating the cell
--polygon-type Y A string specifying the type of bounding polygon to FALSE
generate.
• CONVEX: The convex hull of the data is used for
the polygon.
• BUFFERED: A simplified buffered boundary is
used for the polygon.
The default value is BUFFERED.
--comments C General comments to be added to the coverage FALSE
metadata.
The default value is an empty string.
--include-flag A string specifying a status flag to be included for the TRUE This must be
operation. One of: explicitly
• ACCEPTED: Accepted status flag specified.
• EXAMINED: Examined status flag
• OUTSTANDING: Outstanding status flag
• REJECTED: Rejected status flag
• SUPPRESSED: Suppressed status flag
--keep-up-to-date U If set, disables Keep Up to Date setting. FALSE

GriddingMethod = SHOAL_TRUE Options

None

CARIS HIPS and SIPS User Guide 411

HIPS Processes: Create HIPS Grid

Parameter

Short Can Notes

Long Description
key Repeat

GriddingMethod = SWATH_ANGLE Options

--max-footprint X A number specifying the maximum area in which a FALSE

sounding can be applied to the surface.
The default value is 9. Value is set in resolution units.
--grazing-angle- G The path to the Grazing Angle Weights file. FALSE
file The defaults is to use the system table if not defined.
--grazing-angle- A pair of values describing an entry in the grazing angle FALSE
table weight table.
<Angle> - Angle in degrees of a specific weight.
<Weight> - Statistical weight of the specified angle.
The default value is to apply full weight from 90 to 75
degrees, 0.01 weight at 15 degrees and 0 weight at 0
degrees.
If set, the value overrides the GrazingAngleFile.

GriddingMethod = UNCERTAINTY Options

--iho-order The IHO S-44 Order to apply. FALSE

412 CARIS HIPS and SIPS User Guide

HIPS Processes: Create HIPS Grid

Parameter

Short Can Notes

Long Description
key Repeat

GriddingMethod = CUBE Options

--iho-order e The IHO S-44 Order to apply. FALSE

• S44_SPECIAL: Predefined S-44 horizontal and
vertical error limits for Special Survey Order
• S44_1A: Predefined S-44 horizontal and vertical
error limits for 1a Survey Order
• S44_1B: Predefined S-44 horizontal and vertical
error limits for 1b Survey Order
• S44_2: Predefined S-44 horizontal and vertical
error limits for 2 Survey Order
• S44_USER: User defined horizontal and vertical
error limits (a,b,horizontal distance limit of depth,
horizontal percentage of depth)
If not set, the default is S44_USER, which requires
IHOLimits and IHOHorzDistLimits to be set.
--iho-limits The IHO S-44 Order 'a' and 'b' error values to be used if FALSE
user defined is chosen.
<a value> - Constant error
<b value> - Depth dependent error
Only applicable if IHO Order is not set or set to
S44_USER.
--disambiguation- The method used to select a hypothesis from a set. One FALSE
method of:
• DENSITY: Density - Disambiguate by number of
samples.
• LOCALE: Locale - Disambiguate by surrounding
nodes.
• DENSITY_LOCALE: Density and Locale -
Disambiguate by a combination of sample count
and surrounding nodes.
The default value is DENSITY_LOCALE.
--cube-config-file The path to a file specifying the XML document FALSE
containing CUBE configuration parameters.
--cube-config- A string specifying the name of the CUBE configuration FALSE
name to be used from the CUBE configuration parameters.
--cube-config- A XML string encoding a set of CUBE configuration FALSE
settings parameters.
If set, overrides the values set in CubeConfigFile and
CubeConfigName.

Example To use this command, refer to the following example.

Example

Objective To create a raster surface using HIPS gridding.

CARIS HIPS and SIPS User Guide 413

HIPS Processes: Create HIPS Grid

Example

Description Command Line Syntax

The surface is created using the swath angle gridding method. --gridding-method SWATH_ANGLE
The extents of the surface are defined by coordinates 500000 --extent 500000 50000000 501000
50000000 501000 50010000. 50010000
The resolution for the output surface is set to 5.0m. --resolution 5.0m
The horizontal coordinate reference system for the surface is set to --output-crs EPSG:32619
EPSG:32619
Data flagged as ACCEPTED will be included in the output surface. --include-flag ACCEPTED
The input HIPS track line is named input.hips and located in the C:/temp/input
C:\temp\input folder.
The output CSAR raster is called raster_surface.csar and located in D:/BatchSample/output/
the D:\BatchSample folder. raster_surface.csar
carisbatch --run CreateHIPSGrid --gridding-method SWATH_ANGLE --resolution 5.0m --
output-crs EPSG:32619 --extent 500000 50000000 501000 50010000 --include-flag
Command Line
ACCEPTED file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001 file:///D:/
BatchSample/output/raster_surface.csar

Outcome A new swath angle surface is created in the specified location.

Extra Notes N/A

414 CARIS HIPS and SIPS User Guide

HIPS Processes: Create SIPS Beam Pattern

Create SIPS Beam Pattern

Description The CreateSIPSBeamPattern process creates a beam pattern file
that will be used to apply a correction to remove acoustic
artifacts from the imagery caused by imperfections in the sonar.
Inputs One or more HIPS track lines.
Outputs Updated HIPS track lines and project file.
Command Line Syntax carisbatch --run CreateSIPSBeamPattern --mosaic-engine
<value> [options] <inputs>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

Common Options

--mosaic- m The mosaic engine used to generate the output beam pattern. FALSE This must
engine One of: be explicitly
• SIPS_BACKSCATTER: SIPS Backscatter engine specified.
processes multibeam backscatter data referenced by
HIPS data
• SIPS_SIDESCAN: SIPS Side Scan engine processes
side scan data converted into HIPS format
--beam- b The path to the beam pattern file. FALSE This must
pattern-file be explicitly
specified.

MosaicEngine = SIPS_BACKSCATTER Options

--beam- If the beam pattern file selected already exists, sets the file FALSE
pattern-file- operations on the existing file. One of:
operation • UPDATE: Update - Updates the file with the new line
information, can accumulate many lines over many
surveys
• OVERWRITE: Overwrite - Overwrites the existing file
with a new file from the current lines.
The default value is UPDATE.
Cannot be used without --beam-pattern-file set.
‐‐s7k‐ Teledyne Reson s7k format can store Beam Average and Time FALSE
compensate Series data in raw and compensated intensity datagrams.
d‐data 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.
--local- A number specifying correction for transmission loss using FALSE
absorption temperature and salinity values.
<Temperature> - The temperature value in degrees Celsius.
<Salinity> - The salinity value in parts per thousand.
The default values are 8.00 35.00, respectively.

CARIS HIPS and SIPS User Guide 415

HIPS Processes: Create SIPS Beam Pattern

Parameter

Short Can Notes

Long Description
key Repeat

--nadir-angle- Set Transducer 1 angles across-track from directly below the FALSE
t1 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.
The default values are 90 90. The valid range is -20 to 100.
--nadir-angle- Set Transducer 2 angles across-track from directly below the FALSE
t2 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.
The default values are 90 90. The valid range is -20 to 100.
--surface The path to the surface used to compute the local bottom slope FALSE
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.

MosaicEngine = SIPS_SIDESCAN Options

None

Example To use this command, refer to the following example.

Example

Objective To remove acoustic artifacts from a HIPS track line.

Description Command Line Syntax

The mosaic engine to use is SIPS_BACKSCATTER. --mosaic-engine SIPS_BACKSCATTER

The beam pattern file operation is OVERWRITE. --beam-pattern-file-operation OVERWRITE
The input HIPS track line file is named input.hips is located at C:\temp\input\
C:\temp\input\. The HIPS file URI filters for the vessel named
“sample” and the day 2000-001
The output beam pattern file is named outputBeamPattern.bbp and C:\Temp\outputBeamPattern.bbp
is located at C:\Temp\
carisbatch --run CreateSIPSBeamPattern --mosaic-engine
SIPS_BACKSCATTER --beam-pattern-file-operation OVERWRITE file:///C:/
Command Line
temp/input/input.hips?Vessel=sample;Day=2000-001
C:\Temp\outputBeamPattern.bbp

Outcome A beam pattern file is created.

Extra Notes N/A

416 CARIS HIPS and SIPS User Guide

Short Can Notes

Long Description
key Repeat

--s7k- Teledyne Reson s7k format can store Beam Average and FALSE
compensated Time Series data in raw and compensated intensity
-data 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.
--r2s- The R2Sonics Multispectral frequency(s) to use when FALSE
multispectral- creating a mosaic.
frequency • 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.
--local- A number specifying correction for transmission loss using FALSE
absorption 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.
--filter-angle- Filters transducer 1 data to a min/max angle. FALSE
t1 <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.
--filter-angle- Filters transducer 2 data to a min/max angle. FALSE
t2 <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.
--surface The path to the surface used to compute the local bottom FALSE
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.
--filter f Filter the input bands by setting those outside the specified FALSE
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.

CARIS HIPS and SIPS User Guide 419

HIPS Processes: Create SIPS Mosaic

Parameter

Short Can Notes

Long Description
key Repeat

--sound- A number specifying the sound velocity values set by the user FALSE
velocity 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.

MosaicEngine = SIPS_SIDESCAN Options

--channel Select the data channel to read for processing. One of: FALSE
• BOTH: Both channels
• PORT: Port channel
• STARBOARD: Starboard channel
The default value is BOTH.
--beam- Apply beam pattern correction. One of: FALSE
pattern • 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.
--beam- The path to the beam pattern file. FALSE
pattern-file Only applicable if BeamPattern is not set to NONE.
--gain Numbers specifying the gain correction to apply to the port/ FALSE
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.
--tvg Numbers specifying the time-varying gain correction to apply FALSE
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.
--gain- A number specifying the number of pings used to set the FALSE
normalization window size for the moving-average window filter.
If not set, no Gain Normalization is applied. The valid range is
1 or greater.
--despeckle A number specifying the strength of the despeckle filter as a FALSE
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.

420 CARIS HIPS and SIPS User Guide

HIPS Processes: Create SIPS Mosaic

Parameter

Short Can Notes

Long Description
key Repeat

--ratio Numbers specifying the across-track distance to altitude ratio FALSE

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.
--ratio-limit Numbers limiting the Across-track/Altitude Ratio ratio filter to FALSE
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.
--across- Numbers limiting the across-track distance from nadir to a FALSE
distance-limit 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.
--filter f Filter the input bands by setting those outside the specified FALSE
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.
--extrapolate- A number to set extrapolate heading/motion data for the FALSE
time specified time interval.
If not set, no extrapolation is done. Supported units: seconds.
--registration- If set, registers the imagery using co-acquired bathymetry. FALSE
bathy Only applicable if the lines contain processed bathymetry.
--gyro-source The heading source to be used for processing. One of: FALSE
• 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.
--smooth-gyro If set, applies smoothing coefficients to the gyro data. FALSE

CARIS HIPS and SIPS User Guide 421

HIPS Processes: Create SIPS Mosaic

Parameter

Short Can Notes

Long Description
key Repeat

--sound- A number to set the sound velocity applied during slant range FALSE
velocity correction.
The default value is 1500 m/s. If not set, the default value is
used.
Supported units: metres/second.
--altitude- Numbers to set offsets for the altitude data in time/height. FALSE
offset <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.

MosaicEngine = GEOCODER Options

--channel Select the data channel to read for processing. One of: FALSE
• BOTH: Both channels
• PORT: Port channel
• STARBOARD: Starboard channel
The default value is BOTH.
--imagery The type of imagery to be processed. One of: FALSE
• 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.
--auto- If set, automatically determines best resolution based on data FALSE
resolution density. This overrides the Resolution parameter.
--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- FALSE
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.
--avg-window- The window size in pixels used for AVG correction. FALSE
size

422 CARIS HIPS and SIPS User Guide

HIPS Processes: Create SIPS Mosaic

Parameter

Short Can Notes

Long Description
key Repeat

--despeckle Apply despeckle to the mosaic. One of: FALSE

• NONE:
• WEAK:
• MODERATE:
• STRONG:
• VERY_STRONG:
The default value is NONE.
--beam- Apply beam pattern correction. FALSE
pattern • 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.
--beam- The path to the beam pattern file. FALSE
pattern-file Only applicable if BeamPattern is not set to NONE.
--nadir-angle Set angles across-track from directly below the transducer (0 FALSE
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.
--filter f Filter the input bands by setting those outside the specified FALSE
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.
--surface The path to the surface used to compute the local bottom FALSE
slope used in the GeoCoder calculations of real incidence
angle and ensonified area. The default elevation band will be
used.
--smooth-gyro If set, applies smoothing coefficients to the gyro data. FALSE

Example To use this command refer to the following example.

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

CARIS HIPS and SIPS User Guide 423

HIPS Processes: Create SIPS Mosaic

Example

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\MosaicSIPS.csar
D:\BatchSample.
carisbatch --run MosaicSIPS --mosaic-engine SIPS_SS --resolution 10m
Command Line --channel PORT --beam-pattern PORT D:\BatchSample\xxx
D:\BatchSample\MosaicSIPS.csar

Outcome A new csar raster mosaic is created.

Extra Notes N/A

424 CARIS HIPS and SIPS User Guide

HIPS Processes: Detect HIPS Critical Soundings

Detect HIPS Critical Soundings

Description The DetectHIPSCriticalSoundings process uses an input raster to
contour in-memory and determine the Shoalest/Deepest
soundings from a HIPS data source within the isolations.
Depending on the options used, each or both can be flagged as
critical soundings in the HIPS data.
Update One or more HIPS track lines.
Outputs Updated HIPS track lines and project file.
Command Line Syntax carisbatch --run DetectHIPSCriticalSoundings --surface <value>
--input-band <value> [options] <update>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

--surface The path to the surface used to calculate the FALSE This must be
threshold. The default elevation band will be used. specified explicitly.
--input-band i A string specifying the name of the input band. FALSE This must be
specified explicitly.
--output-shoal- The type of Shoal sounding status. FALSE
status • NONE: (None) - No Shoal status set.
• DESIGNATED: Designated - Status for
soundings considered to be of special
significance.
• OUTSTANDING: Outstanding - Status for
soundings considered for further
investigation.
• EXAMINED: Examined - Status for soundings
considered investigated.
The default value is DESIGNATED.
--output-deep- A type of Deep sounding status. FALSE
status • NONE: (None) - No Deep status set.
• DESIGNATED: Designated - Status for
soundings considered to be of special
significance.
• OUTSTANDING: Outstanding - Status for
soundings considered for further
investigation.
• EXAMINED: Examined - Status for soundings
considered investigated.
The default value is OUTSTANDING.
--shoal-attributes Name/value pairs representing non-system attributes TRUE
to be set on the detected Shoals.
--deep-attributes Name/value pairs representing non-system attributes TRUE
to be set on the detected Deeps.

CARIS HIPS and SIPS User Guide 425

HIPS Processes: Detect HIPS Critical Soundings

Parameter

Short Can Notes

Long Description
key Repeat

--contour-interval- The method used to contour. FALSE

type • HALF_RESOLUTION: Half Source Resolution
- The interval is a value equal to half the
resolution of the selected surface.
• USER_INTERVAL: User-defined Value -
Applies a set value to use as the contour
interval.
• LEVELS_FILE: Levels File - Applies a depth
list file.
The default value is HALF_RESOLUTION.
--max-isolations Maximum number of isolations allowed to be FALSE
processed.
The default value is 100000.
--radius-filter The type of radius filter to apply. FALSE
• NONE: (None) - No filter applied.
• RADIUS_VALUE: Distance - The filter radius.
• RADIUS_TABLE: Table File - The filter table
file containing minimum/maximum depth
range with applicable radius.
The default value is NONE.

ContourIntervalType = USER_INTERVAL Options

--interval A number specifying a fixed value to use as the FALSE

contour interval.
When ContourIntervalType is set to
USER_INTERVAL, Interval must be set.
ContourIntervalType = LEVELS_FILE Options
--contour-levels- A string specifying the name of a depth list file FALSE
file containing the contour interval/depth pairs.
When ContourIntervalType is set to LEVELS_FILE,
ContourLevelsFile must be set.

RadiusFilter = RADIUS_VALUE Options

--radius-value A number specifying a fixed value to use as the filter FALSE

radius.
When RadiusFilter is set to RADIUS_VALUE,
RadiusValue must be set

RadiusFilter = RADIUS_TABLE Options

--radius-table-file A string specifying the name of a radius table file FALSE

containing the minimum/maximum depth range/
radius pairs.
When RadiusFilter is set to RADIUS_TABLE,
RadiusTableFile must be set.

Example To use this command, refer to the following example.

426 CARIS HIPS and SIPS User Guide

HIPS Processes: Detect HIPS Critical Soundings

Example

Objective To determine the shoalest and deepest soundings in a HIPS data set.

Description Command Line Syntax

Indicates the path to the location of the surface to be used. --surface

The Depth band is included in the filter area. --include-band
Shallowest detected soundings with Designated status will be flagged --output-shoal-status
as critical.
The input surface is named rastersurface.csar located in C:\temp\input
C:\temp\input.
Output is saved to the project file with vessel named “sample” and day C:\temp\input
2000-00 in folder C:\temp\input.
carisbatch --run DetectHIPSCriticalSoundings --surface C:/temp/input/
rastersurface.csar --include-band Depth --output-shoal-status
Command Line
DESIGNATED file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-
001

Outcome Track line data is updated and saved to the project file.

Extra Notes N/A

CARIS HIPS and SIPS User Guide 427

HIPS Processes: Filter HIPS Attitude

Filter HIPS Attitude

Description The FilterHIPSAttitude process allows for attitude filtering in
the HIPS data automatically, line by line.
Update One or more HIPS track lines.
Outputs Updated HIPS track lines.
Command Line Syntax carisbatch --run FilterHIPSAttitude --sensor-type <value>
[options] <update>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

Common Options
--sensor-type S The type of attitude to filter. One of: FALSE This must be specified
• DELAYED_HEAVE: Delayed Heave explicitly.
• DELTA_DRAFT: Delta Draft
• GPS_HEIGHT: GPS Height
• GPS_TIDE: GPS Tide
• GYRO: Gyro
• HEAVE: Heave
• NAVIGATION: Navigation
• SSS_NAVIGATION: Side Scan Navigation
• PITCH: Pitch
• ROLL: Roll
• SURFACE_SOUND_SPEED: Surface
Sound Speed
• SPEED_OVER_WATER: Speed Over Water
• SSS_CABLE_OUT: Side Scan Cable Out
• SSS_GYRO: Side Scan Gyro
• SSS_SENSOR_DEPTH: Side Scan Sensor
Depth
• SSS_SENSOR_HEIGHT: Side Scan Sensor
Height
• TIDE: Tide
--enable- If set, enables filtering of the sensor data. FALSE
filtering
--enable- If set, enables smoothing of the sensor data. FALSE
smoothing
--filter-break- If set, disables interpolation across gaps created by FALSE
interpolation rejecting filtered data. Interpolation is applied by
default.
--filter-type The type of filter/smoothing to apply. One of: FALSE
• MOVING_AVERAGE: Moving Average
• FFT: Fast Fourier
The default value is MOVING_AVERAGE.

428 CARIS HIPS and SIPS User Guide

HIPS Processes: Filter HIPS Attitude

Parameter

Short Can Notes

Long Description
key Repeat

--window- The type of filter window to apply. One of: FALSE

size-type • SECONDS: Use this time range in seconds
for the filter window
• POINTS: Use this time range as a number of
points (samples) for the filter window
When FilterType is set to MOVING_AVERAGE, the
window size is used for averaging the data.
When FilterType is set to FFT, the window size is
used to derive the cut-off frequency that is applied to
all data.
The default value is POINTS.
--threshold A number specifying the multiple of the standard FALSE
deviation, as sigma, for the filter or smooth cut-off.
The default value is 1.

WindowSizeType = SECONDS Options

--window- A number specifying the number of seconds to use FALSE

size-time in the Filter window for Moving Average or Fast
Fourier.
The valid range is 1 or greater.
The default value is 1.

WindowSizeType = POINTS Options

--window- A number specifying the number of points to use in FALSE

size-sample the Filter window for Moving Average or Fast
Fourier.
The valid range is 3 or greater. Only odd numbers
are valid.
The default value is 3.

Example To use this command, refer to the following example.

Example

Objective To automatically filter the attitude in HIPS data, line by line.

Description Command Line Syntax

The type of attitude to filter is GPS_TIDE. --sensor-type GPS_TIDE

The sensor data will be smoothed. --enable smoothing
A Moving Average filter will be applied. --filter-type MOVING_AVERAGE
The filter window will use a time range in seconds. --window-size-type SECONDS
10 seconds will define the filter window size. --window-size 10
The threshold for filtering is set to 3 sigma. --threshold 3

CARIS HIPS and SIPS User Guide 429

HIPS Processes: Filter HIPS Attitude

Example

The input file is named input.hips and is located at C:\temp\input\. The C:\temp\input\
HIPS file URI filters for the vessel named “sample” and the day 2000-
001.
carisbatch --run FilterHIPSAttitude --sensor-type GPS_TIDE --enable-
smoothing --filter-type MOVING_AVERAGE --window-size-type SECONDS --
Command Line
window-size 10 --threshold 3 file:///C:/temp/input/
input.hips?Vessel=sample;Day=2000-001

Outcome HIPS Track lines are updated by attitude filtering.

Extra Notes N/A

430 CARIS HIPS and SIPS User Guide

HIPS Processes: Filter Observed Depths

Filter Observed Depths

Description The FilterObservedDepths process enables line by line,
automatic filtering of the bathymetry in the HIPS data.
Update One or more HIPS track lines.
Outputs Updated HIPS track lines.
Command Line Syntax carisbatch --run FilterObservedDepths --bathymetry-type
<value> [options] <update>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Short Can Notes

Long Description
key Repeat

--missing-port- If set, beams are filtered if beams on each side of the swath FALSE
starboard are rejected. During filtering, only accepted soundings are
examined.
Missing neighbours are beams that are rejected during the
conversion process into HIPS. This occurs if the beam is
disabled in the vessel configuration or if the sonar system
flags the beam as a bad detect in the raw data file.
Soundings filtered after one filter pass are not considered in
the next.
--missing-fore-aft If set, beams are filtered if the adjacent beams in the FALSE
previous and next swath are rejected.
--missing-any-2-of-4 If set, beams are filtered if two of the four neighbouring FALSE
beams are rejected.

BathymetryType = SINGLEBEAM Options

--primary If set, filters primary soundings with difference values FALSE

outside of set threshold limits.
--secondary If set, filters secondary soundings with difference values FALSE
outside of set threshold limits.
--selected If set, filters selected soundings with difference values FALSE
outside of set threshold limits.
--b2b-slope-along- A number specifying the degree value for calculating the FALSE
track-angle slopes from each sounding to the previous and next
sounding. If both slopes exceed the entered value, and are
of opposite sign, then the sounding is filtered.
--b2b-slope-include- If set, includes previously rejected soundings when FALSE
rejected recalculating the slopes during multiple runs of the filter.
--moving-average A number specifying the number of neighbouring soundings FALSE
or time in seconds needed to calculate a mean for each
sounding.
--window-size-type The type of filter window to apply in the moving average FALSE
filter.
• SECONDS: Use this time range in seconds for the
filter window
• POINTS: Use this time range as a number of points
(samples) for the filter window
The default value is POINTS.
--threshold A number specifying the multiple of the standard deviation, FALSE
as sigma, for the moving average filter.
The default value is 1.

Example To use this command, refer to the following example.

Example

Objective To systematically filter the swath or single beam bathymetry in HIPS data, line by line.

434 CARIS HIPS and SIPS User Guide

HIPS Processes: Filter Observed Depths

Example

Description Command Line Syntax

Swath is type of bathymetry to be filtered. --bathy-type SWATH

Filtering will include only data between -100m and 10m. --filter -100m -10m
Beam numbers 1 to10, 50 and 78 will be rejected. --beam-number "1-10 50 78"
Bathymetry flagged 0 will be rejected. --quality 0
Bathymetry flagged 1 will be rejected. --quality 1
Bathymetry flagged 2 will be rejected. --quality 2
The file to update is named input.hips and is located at C:\temp\input\. C:/temp/input/
input.hips?Vessel=sample;Day=2000-
001
carisbatch --run FilterObservedDepths --bathymetry-type SWATH --
filter -100m -10m --beam-number "1-10 50 78" --reject-quality 0 --
Command Line
quality 1 --quality 2 file:///C:/temp/input/
input.hips?Vessel=sample;Day=2000-001

Outcome The data is filtered as specified.

Extra Notes N/A

CARIS HIPS and SIPS User Guide 435

HIPS Processes: Filter Processed Depths

Filter Processed Depths

Description The FilterProcessedDepths process can be done by a Surface or
Polygon. With Surface it uses an input surface and a scaled
standard deviation or uncertainty threshold to reject HIPS data
(HDCS soundings) that fall outside the specified threshold. You
can also filter by a direct threshold amount. With Polygon it uses
a polygon geometry to accept/reject HIPS data (HDCS
soundings) that fall inside/outside the polygon.
Update One or more HIPS track lines.
Outputs Updated HIPS track lines.
Command Line Syntax carisbatch --run FilterProcessedDepths [options] <update>
Options The following table describes the parameters available for this
process.

Parameter

Short Can
Long Description Notes
key Repeat

Common Options

--filter-type The type of filtering to apply to the HDCS ProcessedDepths.

• SURFACE: Surface - a csar surface that covers an area
within the data
• POLYGON: Polygon - a wkt geometry of a polygon
boundary
--protective- A number specifying a protective radius around critical soundings FALSE
radius to protect any neighbouring soundings within the sphere from being
filtered.
If not set, the default is to not filter. The valid range is 0 or greater.
--protective- If set, applies the radius to soundings flagged as Designated during FALSE
radius- filtering.
designated Only applicable if ProtectiveRadius is set.
--protective- If set, applies the radius to soundings flagged as Examined during FALSE
radius- filtering.
examined Only applicable if ProtectiveRadius is set.
--protective- If set, applies the radius to soundings flagged as Outstanding FALSE
radius- during filtering.
outstanding Only applicable if ProtectiveRadius is set.

FilterType = SURFACE Options

--surface The path to the surface used to calculate the threshold. The default FALSE
elevation band will be used.
--include- If set, includes data that was previously rejected by this filter. FALSE
rejected

436 CARIS HIPS and SIPS User Guide

HIPS Processes: Filter Processed Depths

Parameter

Short Can
Long Description Notes
key Repeat

--threshold- A string specifying the Threshold Type according to the surface FALSE
type used as input. If the Surface has standard deviation/uncertainty, set
to a scaled standard deviation or uncertainty threshold, otherwise a
direct threshold amount can be used for any surface. This setting
will reject all soundings that fall outside the specified threshold.
One of:
• STANDARD_DEVIATION: Standard Deviation
• UNCERTAINTY: Uncertainty
• GREATER: Greater of Uncertainty and Standard Deviation
• LESSER: Lesser of Uncertainty and Standard Deviation
• STATIC_VALUE: Static Value
--threshold Value to use when specifying the scalar or static value to apply as a FALSE
threshold in the filter. One of:
• <Scalar> - scalar value to apply to the standard deviation
• <StaticValue> - A number specifying the static threshold
value to apply in the filter
Scalar is used when ThresholdType is not set to STATIC_VALUE.
For the StaticValue, supported units are: cable, ch, cm, fm, ft, in,
inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd.
--reject-no- If set, rejects soundings that are offset from the surface. FALSE
data-
soundings

FilterType = POLYGON Options

--geometry G The geometry with its coordinate reference system. FALSE The
<WKT> - A string specifying the shape of the geometry. geometry
must be
<CRS> - A string specifying the horizontal coordinate reference specified
system key of the geometry. as a WKT
The geometry can be composed of one or more polygons that string.
contain one or more holes. The geometry must be specified as a
WKT string.
--extract- g A string specifying the area for the filtering to be performed. FALSE
type • INCLUSIVE: Inclusive - Filter all data inside the geometry,
including data that touches the geometry.
• EXCLUSIVE: Exclusive - Filter all data outside the
geometry.
The default value is INCLUSIVE.
--accept- If set, set filter logic to accept data, otherwise all filtered data will be FALSE
data rejected.

Example To use this command, refer to the following example.

Example

To reject soundings in a surface that fall outside a specified standard deviation or uncertainty
Objective threshold, or by a direct threshold amount. A polygon can be used to define the area of the
surface to accept or reject soundings) that fall inside/outside the polygon.

CARIS HIPS and SIPS User Guide 437

HIPS Processes: Filter Processed Depths

Example

Description Command Line Syntax

The filtering of processed depths will be applied to a surface. --filter-type SURFACE

Either the uncertainty or standard deviation value will be used, --threshold-type GREATER
whichever is greater.
The threshold value of 2.0 multiplies either the uncertainty or standard --threshold-value 2.0
deviation value, which ever is greater, to arrive at a filter value.
The surface to be filtered is named C:\surface.csar and is located at --surface C:\surface.csar
C:\temp\input\. The HIPS file URI filters for the vessel named
“sample” and the day 2000-001.
carisbatch --run FilterProcessedDepths --filter-type SURFACE --
Command Line surface C:\surface.csar --threshold-type GREATER --threshold-value
2.0 file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001

Outcome The filtered surface is updated.

Extra Notes N/A

438 CARIS HIPS and SIPS User Guide

HIPS Processes: Import Generic To HIPS

Import Generic To HIPS

Description The ImportGenericToHIPS process uses a parser configuration
(*.par) file created in the Generic Data Parser editor and
converts data into HIPS format using that configuration.
Inputs One or more ASCII data files.
Outputs Track lines.
Command Line Syntax carisbatch --run ImportGenericToHIPS
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

--parser-file P The path to the parser configuration file. The file is FALSE
setup to parse any sensor data (other than swath and
sweep bathymetry and side scan imagery) from ASCII
text files and then converted as updates on any line
folders in an existing project.
--input-crs p A string specifying the horizontal coordinate reference FALSE
system key of the input.
The default value is LLDG.
--extent E The extents that defines the window. FALSE
<LowerX> - A number specifying the lower left X origin
in the coordinate reference system of the input.
<LowerY> - A number specifying the lower left Y origin
in the coordinate reference system of the input.
<UpperX> - A number specifying the upper right X
origin in the coordinate reference system of the input.
<UpperY> - A number specifying the upper right Y
origin in the coordinate reference system of the input.
The unit is assumed to be that of the input'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.
--filter f A number specifying the Z values to a min/max range. FALSE
<FilterMin> - The minimum values for imported data.
<FilterMax> - The maximum values for imported data.
The valid range is +/- 15000.
--filter-dup- If set, filters the navigation points to remove duplicate FALSE
navigation points during import.

CARIS HIPS and SIPS User Guide 439

HIPS Processes: Import Generic To HIPS

Example To use this command, refer to the following example.

Example

Objective To import data to HIPS format using a parser file.

Description Command Line Syntax

The parser file is named parser_file.par located at C:\. --parser-file C:\parser_file.par

The input file is ASCII_line.txt located in at C:\. C:\ASCII_line.txt
The output file is C:\temp\input for the vessel named “sample” and the C:/temp/input/
day 2000-001 input.hips?Vessel=sample;Day=2000-
001
carisbatch -run ImportGenericToHIPS --parser-file C:\parser_file.par
Command Line C:\ASCII_line.txt file:///C:/temp/input/
input.hips?Vessel=sample;Day=2000-001

Outcome The data file is converted to HIPS using the settings in the parser file.

Extra Notes N/A

440 CARIS HIPS and SIPS User Guide

HIPS Processes: Import HIPS From Auxiliary

Import HIPS From Auxiliary

Description The ImportHIPSFromAuxiliary process imports various
post-processed formats into HIPS and SIPS projects.
Update HIPS track lines.
Inputs One or more raw data files in a supported format.
Outputs Updated HIPS track lines and project file.
Command Line Syntax carisbatch --run ImportHIPSFromAuxiliary --input-format
<value> [options] <inputs> <update>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

Common Options

--input-format I The format to import. FALSE This must be

• ASCII: ASCII specified explicitly.
• APP_POSMV: Applanix POS MV
• APP_RMS: Applanix RMS
• APP_SBET: Applanix SBET
• NAVLAB: Kongsberg Navlab
• NOVATEL: NovAtel
• PFREEHEAVE: Kongsberg PFreeHeave
• STARFIX: Fugro Starfix
• TERRAPOS: TerraPos
--time-offset A number specifying the time offset. FALSE
The default value is 0.
Supported units: sec, min, hour, day, week.
--time-buffer A number specifying the time buffer to pad data at FALSE
the beginning and end of lines.
The default value is 0.
Supported units: sec, min, hour, day, week.
--maximum-gap A number specifying the maximum allowable time FALSE
between records.
The default value is 2.
Supported units: sec, min, hour, day, week.
--allow-partial a If set, loads data for lines that are only partially FALSE
covered, otherwise skip loading data for that line.

InputFormat = ASCII Options

--navigation If set, includes navigation. FALSE

--gps-height A number specifying the sampling interval to include FALSE
GPS height. A value of 0 will use all data.

CARIS HIPS and SIPS User Guide 441

HIPS Processes: Import HIPS From Auxiliary

Parameter

Short Can Notes

--navigation- A string specifying the name of the navigation FALSE

device device.
--heading-device A string specifying the name of the heading device. FALSE
--heave-device A string specifying the name of the heave device. FALSE
--motion-device A string specifying the name of the motion device. FALSE
--subsea-depth- A string specifying the name of the subsea depth FALSE
device device.
InputFormat = TERRAPOS Options
--navigation If set, includes navigation. FALSE
--gps-height A number specifying the sampling interval for GPS FALSE
height. A value of 0 will use all data.
Supported units: sec, min, hour, day, week.
--navigation-rms A number specifying the sampling interval for FALSE
navigation RMS. A value of 0 will use all data.
Supported units: sec, min, hour, day, week.
--gps-height-rms A number specifying the sampling interval for GPS FALSE
height RMS. A value of 0 will use all data.
Supported units: sec, min, hour, day, week.

Example To use this command, refer to the following example.

Example

Objective To import certain post-processed formats to HIPS data.

Description Command Line Syntax

Terrapos data is being imported. --input-format TERRAPOS

Line for which there is only partial auxiliary data will have that data loaded. --allow-partial navigation
All data will be used. --gps-height 0sec
The input file is named inputPOSMV1.pts located in C:\temp\input\. C:/temp/input/
input.hips?Vessel=sample;Day=
2000-001
C:\temp\input\inputPOSMV1.pts\
carisbatch -run ImportHIPSFromAuxiliary --input-format TERRAPOS --allow-partial --
Command Line navigation --gps-height file 0sec ///C:/temp/input/
input.hips?Vessel=sample;Day=2000-001 C:\temp\input\inputPOSMV1.pts

Outcome The HIPS project data is updated by the imported auxiliary data.

Extra Notes N/A

CARIS HIPS and SIPS User Guide 447

HIPS Processes: Import Multiple Detections To HIPS

Import Multiple Detections To HIPS

Description The ImportMultipleDetectionsToHIPS process will import
additional bottom detections per beam for use in HIPS processes.
Update One or more HIPS track lines.
Outputs Updated HIPS track lines.
Command Line Syntax carisbatch --run ProcessKey [Options] Inputs Outputs

Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

--reject-type Reject detections of the numbered type. For Kongsberg FALSE

systems, setting these flags will override the acquisition
settings. Type 6 and 7 apply to Kongsberg systems only.
• TYPE1: Type 1
• TYPE2: Type 2
• TYPE3: Type 3
• TYPE4: Type 4
• TYPE5: Type 5
• TYPE6: Type 6
• TYPE7: Type 7

Example To use this command, refer to the following example.

Example

Objective To import additional bottom detections per beam for use in HIPS processes.

Description Command Line Syntax

Detections of Type 4 will be rejected. --reject-type TYPE4

Detections of Type 5 will be rejected. --reject-type TYPE5
The input (line data) file is named input.hips and is located at C:\temp\input\input.hips?Vessel=sample
C:\temp\input\. The HIPS file URI filters for the vessel named ;Day=2000-001
“sample” and the day 2000-001.
carisbatch --run ImportMultipleDetectionsToHIPS --reject-type TYPE4 -
Command Line -reject-type TYPE5 file:///C:/temp/input/
input.hips?Vessel=sample;Day=2000-001

Outcome The line data is updated with the tide values.

Extra Notes N/A

448 CARIS HIPS and SIPS User Guide

HIPS Processes: Import Tide To HIPS

Import Tide To HIPS

Description The ImportTideToHIPS process applies tidal observation data.
Update One or more HIPS track lines.
Outputs Updated HIPS track lines.
Command Line Syntax carisbatch --run ImportTideToHIPS --tide-file <value> [options]
<update>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

--interpolation- Apply the tide data to each line from a single tide station FALSE
type (.tid) or Interpolate tide data from multiple tide stations
within a tide zone file (.zdf).
• SINGLE_STATION: Single Station - Single station
interpolation
• MULTI_STATION: Multiple Stations - Multiple
station interpolation
The default value is SINGLE_STATION.
--tide-file The path to the tide station or zone file. FALSE

InterpolationType = MULTI_STATION

--weighted- If set, calculates the weighted average during multiple tide FALSE
average station interpolation.
--compute-errors If set, computes errors during multiple tide station FALSE
interpolation.

Example To use this command, refer to the following example.

Example

Objective To apply tidal observation data to the line data in the HIPS project.

Description Command Line Syntax

Data from single tide station is applied to the line data. --interpolation-type SINGLE_STATION
The tide file is named sampleTide.tid and is located at --tide-file C:\sampleTide.tid
D:\BatchSample.
The input (line data) file is named input.hips and is located at C::/temp/input/
C:\temp\input\. The HIPS file URI filters for the vessel named “sample” input.hips?Vessel=sample;Day=
and the day 2000-001. 2000-001
carisbatch --run ImportTideToHIPS --interpolation-type SINGLE_STATION
Command Line
file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001

Outcome The line data is updated with the tide values.

Extra Notes N/A

CARIS HIPS and SIPS User Guide 449

HIPS Processes: Import To HIPS

Import To HIPS
Description The ImportToHIPS process imports various formats to HIPS and
SIPS.
Inputs Raw sensor data.
Outputs A track line source.
Command Line Syntax carisbatch --run ImportToHIPS --input-format <value> [options]
<inputs> <output>
Options The following table describes the parameters available for this
process.

450 CARIS HIPS and SIPS User Guide

HIPS Processes: Import To HIPS

Parameter

Short Can Notes

Long Description
key Repeat

Common Options

--input-format I A string specifying the format of the data to import. One of: FALSE This must be
• ATLAS_ASD: Atlas ASD specified
• ATLAS_HYDROSWEEPDS: Atlas Hydrosweep explicitly.
• ATLAS_SURF: Atlas SURF SDA
• BATHYSWATH_SXR: Bathyswath raw SXR
• BATHYSWATH_SXI: Bathyswath intermediate SXI
• BATHYSWATH_SXP: Bathyswath processed SXP
• CHIRPSCAN3D: Chirpscan3D BRF
• CMAX: CMAX CMX,CM2,CMP
• CODA: Coda COD
• EDGETECH_260: Edgetech 260
• EDGETECH_JSF: Edgetech JSF
• EDGETECH_MIDAS: Edgetech Midas
• EIVA: EIVA SBD
• ELAC: ELAC XSE
• FAU:FAU, FU2
• FURUNO: Furuno LOG
• GEOACOUSTICS_RDF: GeoAcoustics RDF
• GEOACOUSTICS_RFF: GeoAcoustics RFF
• GSF: Generic Sensor Format GSF
• HAWKEYE: Hawkeye BIN
• HYPACK: Hypack RAW, HSX
• HYPACK_HS2: Hypack HS2
• IMAGENEX: Imagenex 83p, 83m
• KLEIN: Klein SDF
• KONGSBERG: Kongsberg ALL
• KONGSBERG_EA600: Kongsberg EA600 RAW,
DEPTH
• KONGSBERG: Kongsberg KMALL
• KRAKEN: Kraken TIL
• LADS: LADS CAF
• LAS: LAS
• MARINESONICS: Marine Sonics MS TIFF
• PROSAS: PROSAS IMG
• QMIPS: QMIPS DAT
• SCRIPPS: Scripps
• SEABEAM: Seabeam
• SEGY: SEGY
--input-format • SHOALS: SHOALS OUT, HOF, TOF
(Continued) • SPAWAR: SPAWAR DAT
• TELEDYNE: Teledyne TDY
• TELEDYNE_7K: Teledyne S7K
• TELEDYNE_PDS: Teledyne PDS
• UNB: UNB MERGED
• WINFROG: Winfrog RAW
• XTF: Triton XTF

--input-crs p A string specifying the horizontal coordinate reference system FALSE

key of the input.
The default value is LLDG.

CARIS HIPS and SIPS User Guide 451

HIPS Processes: Import To HIPS

Parameter

Short Can Notes

Long Description
key Repeat

--carry-raw- c If set, copies the original data files to the processed data FALSE
data-files folders.
--overwrite If set, specified data will be overwritten. TRUE
• BATHY: Bathymetry
• NAVIGATION: Navigation
• MOTION: Motion
• BACKSCATTER: Backscatter
• SIDE_SCAN: Sidescan
--filter-extent- Filter the navigation data to a specific geographical extent. FALSE
type • PROJECT: Project - Filter to the extents of the
destination project.
• CUSTOM: Custom - Manually set coordinates (min X/
long), (min Y/lat), (max X/long), (max Y/lat) for the
extents of the filter.
--extent E The extents that define the window. FALSE
<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.
This option is only applicable if FilterExtentType is set to
CUSTOM.
--filter f A number specifying the Z values to a min/max range. FALSE
<FilterMin> - The minimum values for imported data.
<FilterMax> - The maximum values for imported data.
The valid range is +/- 15000.
--filter- A number specifying how soundings are filtered by amplitude. FALSE
amplitude- Soundings that fall below the defined percentage of min/max
percent amplitude values will be rejected.
The valid range is 0 to 50.
--filter-angle- Filters transducer 1 data to a min/max angle. FALSE
T1 <MinAngle> - The minimum angle to filter.
<MaxAngle> - The maximum angle to filter.
The valid range is -20 to 100.

452 CARIS HIPS and SIPS User Guide

HIPS Processes: Import To HIPS

Parameter

Short Can Notes

Long Description
key Repeat

--filter-angle- Filters transducer 1 data to a min/max angle. FALSE

T2 <MinAngle> - The minimum angle to filter.
<MaxAngle> - The maximum angle to filter.
The valid range is -20 to 100.
--filter-range Filters soundings by range from the transducer to the FALSE
seafloor.
<MinRange> - The minimum range to filter.
<MaxRange> - The maximum range to filter.
The valid range is 0 to 15000.
--filter-across- Any soundings beyond the specified distance from nadir will FALSE
track-distance be filtered.
<Port> - The port side distance from nadir.
<Starboard> - The starboard side distance from nadir.
If not set, the default is to not filter. The valid range is 0 or
greater. Supported units: metres.
--filter-depth- A number specifying the depth multiplier applied to nadir FALSE
multiplier- depth to determine the Swath distance outside which to filter
data.
The valid range is 0 to 50.
--filter-stat- A number specifying the statistical threshold by which the FALSE
threshold standard deviation should be multiplied by in order to get the
Confidence Interval.
The valid range is 1 to 3.
--filter-stat- A number specifying the statistical filter angle. Cannot be FALSE
sector-angle used with horizontal bin.
The valid range is 0.3 to 9.0.
--filter-stat- A number specifying the statistical filter bin resolution as FALSE
bin- size distance on the ground. Cannot be used with sector angle.
The valid range is 0.03 to 5. This option is only applicable if
FilterStatSectorAngle is not used.

CARIS HIPS and SIPS User Guide 453

HIPS Processes: Import To HIPS

Parameter

Short Can Notes

Long Description
key Repeat

--filter-stat- A number specifying the thinning factor applied to soundings FALSE

thin-factor converted per swath sector. The default value is 4. The
thinning factor uses a power of two reduction control (2, 4, 8,
etc.) so that one of two, one of four, one of eight, etc. One of:
• NONE: None - No thinning is applied
• 2
• 4
• 8
• 16
• 32
• 64
• 128
• 256
This option is only applicable with FilterStatSectorAngle or
FilterStatBinSize. Used with FilterStatDepthComparator.
--filter-stat- A string specifying the thinning equation to compare filtered FALSE
depth- values from bin of data against either the mean or median
comparator value in the bin and retain the closest.
• MEAN: Mean
• MEDIAN: Median
Only applicable with StatisticalThinningFactor.
--filter-keep- If set, converts the filtered data to HDCS. Flags will be set to FALSE
thinned-data rejected.

InputFormat = Atlas_ASD Options

--convert- s If set, the specified side scan frequency is imported. FALSE

side-scan • HIGH: High - High frequency
• LOW: Low - Low frequency
The default is value HIGH.
InputFormat = Atlas_HydrosweepDS Options
--survey-year y A number specifying the Year of the survey for Hydrosweep FALSE
data.
The default is to use the current year. The format is "YYYY".

InputFormat = Atlas_SURF Options

--convert- s If set, converts side scan from SURF data. FALSE

side-scan

454 CARIS HIPS and SIPS User Guide

CARIS HIPS and SIPS User Guide 455

HIPS Processes: Import To HIPS

Parameter

Short Can Notes

Long Description
key Repeat

--sonar- s A string specifying the sonar channel to convert. One of: FALSE
channel • ANALOG: Analog
• EDGETECH_DF: Edgetech DF1000
• EDGETECH_FSU: Edgetech FSIU
• KLEIN_3000: Klein 3000
• EDGETECH_ACI: Edgetech ACI 272T
• RESON_81X: Reson 81xx
• BENTHOS_SIS: Benthos SIS
• ATLAS: Atlas
• EDGETECH_MPX: Edgetech Discover/MPX
• KLEIN_5000: Klein 5000
• SES: SES Multilink
• EDGETECH_4200: Edgetech 4200
• EDGETECH_4100: Edgetech 4100
• BENTHOS_1600: Benthos 1600
The default value is ANALOG.
InputFormat = EDGETECH_260 Options
N/A
InputFormat = EDGETECH_JSF Options
--convert- s The frequency channel to convert. Selecting Auto converts FALSE
side-scan low frequency if it exists, otherwise converts high frequency.
One of:
• NONE: None - No side scan is converted
• AUTO: Auto - Converts low frequency if it exists,
otherwise converts high.
• HIGH: High - High frequency
• LOW: Low - Low frequency
The default value is NONE.
--convert- If set, converts from cable out, otherwise layback is used. FALSE
from-cable-
out
--sensor- Source location for sensor depth. FALSE
depth- • SENSOR: Sensor
location • DISCOVER2: Discover2
The default value is SENSOR.
--sensor- Source location for altitude. FALSE
altitude- • SENSOR: Sensor
location • DISCOVER2: Discover2
The default value is SENSOR.
--convert- b If set, converts JSF bathymetry. FALSE
bathymetry
--output- If set, converts filtered data as Rejected. FALSE
filtered-data
--echo- A number specifying the percentage value to filter Echo FALSE
strength- Strength. If not set, acquisition setting is used.
percent The valid range is 0 to 100.

456 CARIS HIPS and SIPS User Guide

HIPS Processes: Import To HIPS

Parameter

Short Can Notes

Long Description
key Repeat

--quality- A number specifying the percentage value to filter Quality. All FALSE
percent data with a quality percentage below the value set will be
filtered. If not set, acquisition setting is used. One of:
• 50
• 60
• 70
• 80
• 85
• 90
--snr-db n A number specifying the decibel value to filter SNR. Valid FALSE
values are from 0 to 30. If not set, acquisition setting is used.

InputFormat = EDGETECH_MIDAS Options

Short Can Notes

--include- If set, converts side scan data flagged as offline. FALSE

offline
--convert- Convert layback or cableout data. One of: FALSE
layback- • NONE: No layback or cableout converted
cable-out • LAYBACK: Convert layback
• CABLEOUT: Convert cableout
The default value is NONE.
--layback- Multiplier to compute the layback value, if cableout is FALSE
multiplier converted.
The default value is 1.0.
--use-aux- Calculate the sensor depth from this auxiliary field minus the FALSE
value sensor height, if cableout is converted.
The valid range is 1 to 6.
--convert- Convert the vehicle depth as delta draft/subsea depth. One FALSE
vehicle-depth of:
• NONE: No vehicle depth converted
• SENSORDEPTH: Sensor depth field
• AUX1: Auxiliary field number 1
• AUX2: Auxiliary field number 2
• AUX3: Auxiliary field number 3
• AUX4: Auxiliary field number 4
• AUX5: Auxiliary field number 5
• AUX6: Auxiliary field number 6
The default value is NONE.
--timestamps The timestamps read from the bathymetry and side scan FALSE
packets, when the records contained within do not have their
own precise timestamps.
• AUTO: Automatic - Millisecond time fields on the
bathymetry and side scan packets are used to determine
the time for each packet when the records do not contain
precise timestamps.
• PING: Ping Time - Ping time fields on the bathymetry and
side scan packets are used to determine the time for each
packet when the records do not contain precise
timestamps.
The default value is AUTO.
--use-time- If set, synchronizes time stamps for all files in the same FALSE Ignore when
sync folder. timestamps
=PING

Example To use this command, refer to the following example.

Example

Objective To convert data from specific acquisition formats into HIPS file format for processing.

Description Command Line Syntax

CARIS HIPS and SIPS User Guide 471

HIPS Processes: Import To HIPS

Example

The format of the data being converted is Edgetech JSF. --input-format EDGETECH_JSF
Data is filtered to the extents of the project Demo_Project. --filter-extent-type project
Only data between -200m and 10 m will be converted. --filter -200m 10m
Low frequency side scan data will be converted, if it exists. Otherwise --convert-side-scan auto
high frequency side scan.
Any JSF bathymetry in the data will be converted. --convert-bathymetry
Data with quality percentage below 70% will not be converted. --quality-percent 70
The input file is named Raw_Data.jsf and located at c:\temp\inputfiles\Raw_Data.jsf
c:\temp\inputfiles\.
The output file is named Demo_Project and with be saved in D:/Data/HDCS_Data/Demo_Project/
D:\Data\HDCS_Data\. Vessel.hips?Vessel=Voyager;Day=2015
-044
carisbatch --run ImportToHIPS --input-format EDGETECH_JSF --filter-
extent-type project --filter -200m 10m --convert-side-scan auto --
Command Line
convert-bathymetry --quality-percent 70
example
c:\temp\inputfiles\Raw_Data.jsf file:///D:/Data/HDCS_Data/
Demo_Project/Vessel.hips?Vessel=Voyager;Day=2015-044

Outcome Data in specified format is imported to HIPS and SIPS.

From the above command line example:

input-format EDGETECH_JSF is an example of an option for this Import to HIPS
process.
Extra Notes
c:\temp\inputfiles\Raw_Data.jsf file: is an example of the input or raw data file.
D:/Data/HDCS_Data/Demo_Project/Vessel.hips?Vessel=Voyager;Day=2015-
044 is an example of the destination for the converted data.

472 CARIS HIPS and SIPS User Guide

HIPS Processes: Merge HIPS

Merge HIPS
Description The MergeHIPS process converts along track/across track depths
into latitude, longitude, and depth by combining the ship
navigation with the horizontal and vertical offsets from the
HIPS vessel file. This geographically references the sounding
position and depth.
Update One or more HIPS track lines.
Outputs Updated HIPS track lines.
Command Line Syntax carisbatch --run MergeHIPS [options] <update>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

Common Options
--apply-refraction- If set, applies refraction coefficients. FALSE
coeff
--tide The type of tide to be applied during merge. FALSE
• NONE: (None) - No tidal correction will be applied.
• TIDE: Observed/Predicted - Observed tidal
corrections will be applied.
• GPS: GPS - GPS tidal corrections will be applied.
The default value is NONE.
--heave-source The type of heave to be applied during merge. FALSE
• HEAVE: Realtime - Original heave data will
be used.
• DELAYED_HEAVE: Delayed - Delayed
heave data will be used.
The default value is HEAVE.
--beam-shift The type of beam shift to be applied during merge. FALSE
• NONE: (None) - No beam shift will be
applied.
• STATIC: Static - Static beam shifts will be
applied.
• RELATIVE: Relative - Relative beam shifts
will be applied.
The default value is NONE.

CARIS HIPS and SIPS User Guide 473

HIPS Processes: Merge HIPS

Parameter

Short Can Notes

Long Description
key Repeat

--smooth-sensor If set, applies smoothing coefficients to the specified TRUE

data.
• GYRO: Gyro - Smooths the gyro data.
• HEAVE: Heave - Smooths the heave data.
• PITCH: Pitch - Smooths the pitch data.
• ROLL: Roll - Smooths the roll data.
• SOW: Speed over water - Smooths the
speed over water data.
• DELTA_DRAFT: Delta draft - Smooths the
delta draft/subsea depth data.
• GPS_TIDE: GPS tide - Smooths the GPS
tide data.
• TIDE: Tide - Smooths the tide data.

BeamShift = STATIC or RELATIVE Options

--beam-shift-file The path to the beam shift file. FALSE

Example To use this command, refer to the following example.

Example

Objective To geographically reference the sounding position and depth of HIPS track line data.

Description Command Line Syntax

No tidal corrections will be applied. --tide NONE

Delayed heave will be applied. --heave-source DELAYED_HEAVE
Gyro data will be smoothed. --smooth-sensor GYRO
Heave data will be smoothed. --smooth-sensor HEAVE
The input file is named input.hips and is located at C:\temp\input\. The C:\temp\input\
HIPS file URI filters for the vessel named “sample” and the day 2000-
001.
carisbatch --run MergeHIPS --tide NONE --heave-source DELAYED_HEAVE -
Command Line -smooth-sensor GYRO --smooth-sensor HEAVE file:///C:/temp/input/
input.hips?Vessel=sample;Day=2000-001
Depth data now has position reference using the horizontal and vertical offsets from the HIPS
Outcome
vessel file.

Extra Notes N/A

474 CARIS HIPS and SIPS User Guide

HIPS Processes: Recompute HIPS Grid

Recompute HIPS Grid

Description The RecomputeHIPSGrid process re-grids all HIPS sources from an
existing surface using the create process parameters stored in
the CSAR metadata.
Update A raster surface in CSAR format.
Outputs No output is generated. The input raster surface is modified.
Command Line Syntax carisbatch --run RecomputeHIPSGrid [options] <update>
Options None.

Example To use this command, refer to the following example.

Example

Objective To re-grid the HIPS sources in an existing raster surface.

Description Command Line Syntax

The input file is named ExistingHIPSRasterSurface.csar and is D:\ExistingHIPSRasterSurface.csar

located at D:\.

Command Line carisbatch --run RecomputeHIPSGrid D:\ExistingHIPSRasterSurface.csar

The gridded surface is redrawn from its sources using the parameters stored in the CSAR
Outcome
metadata for the surface.

Extra Notes N/A

CARIS HIPS and SIPS User Guide 475

HIPS Processes: Remove From HIPS Grid

Remove From HIPS Grid

Description The RemoveFromHIPSGrid process removes HIPS track lines from
an existing HIPS surface using the process parameters in the
CSAR metadata.
Update The HIPS surface to update.
Inputs One or more HIPS track lines.
Outputs An updated HIPS surface.
Command Line Syntax carisbatch --run RemoveFromHIPSGrid [options] <inputs>
<update>
Options None.

Example To use this command, refer to the following example.

Example

Objective To remove HIPS sources from an existing CSAR raster surface.

Description Command Line Syntax

The input track lines are located at C:\temp\input\. The HIPS file URI C:\temp\input\
filters for the vessel named “sample” and the day 2000-001.
The updated file is named ExistingHIPSRasterSurface.csar located at D:\
D:\. The HIPS file URI filters for the vessel named “sample” and the
day 2000-001.
carisbatch --run RemoveFromHIPSGrid file:///C:/temp/input/
Command Line input.hips?Vessel=sample;Day=2000-001
D:\ExistingHIPSRasterSurface.csar

Outcome The CSAR raster surface is redrawn with the selected track line sources removed.

Extra Notes N/A

476 CARIS HIPS and SIPS User Guide

HIPS Processes: Remove From SIPS Mosaic

Remove From SIPS Mosaic

Description The RemoveFromSIPSMosaic process removes HIPS sources from
an existing raster mosaic using the create process parameters
stored in the CSAR metadata.
Update The SIPS mosaic to update.
Inputs One or more HIPS track lines.
Outputs An updated SIPS mosaic.
Command Line Syntax carisbatch --run RemoveFromSIPSMosaic [options] <inputs>
<outputs>
Options None.

Example To use this command refer to the following example.

Example

Objective To remove HIPS sources from a csar raster mosaic.

Description Command Line Syntax

The input track lines are located at C:\temp\input\. The HIPS file URI C:\temp\input\
filters for the vessel named “sample” and the day 2000-001.
The updated file is named Mosaic.csar and is located at D:\data\. D:\data\Mosaic.csar file:
carisbatch --run RemoveFromSIPSMosaic file:///C:/temp/input/
Command Line
input.hips?Vessel=sample;Day=2000-001 D:\data\Mosaic.csar

Outcome A new CSAR raster mosaic file is created with the selected HIPS track lines data removed.

Extra Notes N/A

CARIS HIPS and SIPS User Guide 477

HIPS Processes: Reset HIPS Status

Reset HIPS Status

Description The ResetHIPSStatus process resets all HIPS data status flags
specified in the process to Accepted.
Update One or more HIPS track lines.
Outputs Updated HIPS track lines.
Command Line Syntax carisbatch --run ResetHIPSStatus [options] <update>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

--status If set, Rejected status specified is set to Accepted. TRUE

• SWATH_SINGLE_BEAM - By Swath/Single
beam
• HYDROGRAPHER - Hydrographer
• TPU - TPU
• AREA_FILTER - Area Filter
• SURFACE_FILTER - Surface Filter
• DEPTH_FILTER - Depth Filter
• DISABLED_BEAM - Disabled Beam
• NAVIGATION_INTERPOLATION - Navigation
with Interpolation
• NAVIGATION_BREAK_INTERPOLATION -
Navigation with Break Interpolation
• ATTITUDE_INTERPOLATION - Attitude with
Interpolation
• ATTITUDE_BREAK_INTERPOLATION -
Attitude with Break Interpolation

Example To use this command, refer to the following example.

Example

Objective To restore the Accepted status flag to all data.

Description Command Line Syntax

Swath or single beam data rejected in the Swath or Single Beam --status SWATH_SINGLE_BEAM
filters or Editors will be reset to Accepted.
Any sounding data rejected in Subset Editor will be reset to Accepted. --status HYDROGRAPHER
The updated files are located in C:\temp\input. The HIPS file URI filters C:\temp\input\
for the vessel named “sample” and the day 2000-001.
carisbatch --run ResetHIPSStatus --status SWATH_SINGLE_BEAM --status
Command Line HYDROGRAPHER file:///C:/temp/input/
input.hips?Vessel=sample;Day=2000-001

Outcome Specified rejected data is reset to Accepted status.

Extra Notes N/A

478 CARIS HIPS and SIPS User Guide

--shift Shift the navigation data in an X and Y direction, FALSE

using the same units. (Longitude Latitude when
geographic).
<X_Longitude> - The X/Longitude shift.
<Y_Latitude> - The Y/Latitude Shift.
The offset has a maximum of 0.016667 in decimal
degrees (geographic) or 1800 metres (ground).
When specifying units for a geographic shift, an angle
type unit is required. Supported units: cable, ch, cm,
fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi,
usnm, usyd, yd, deg and rad.

Example To use this command, refer to the following example.

Example

Objective To shift a selected track line by a specified amount.

Description Command Line Syntax

The data will be shifted 0.001deg X and no shifted in Y direction. --shift 0.001deg 0deg
The updated file is named input.hips and is located at C:\temp\input\
C:\temp\input\. he HIPS file URI filters for the vessel named “sample”
and the day 2000-001.
carisbatch --run ShiftHIPSNavigation --shift 0.001deg 0deg file:///
Command Line
C:/temp/input/input.hips?Vessel=sample;Day=2000-001

Outcome The selected track line or lines are shifted by the set amount.

Extra Notes N/A

CARIS HIPS and SIPS User Guide 481

HIPS Processes: Sound Velocity Correct HIPS

Sound Velocity Correct HIPS

Description The SoundVelocityCorrectHIPS process uses a ray tracing
algorithm to apply the sound velocity profiles.
Inputs One or more HIPS track lines.
Outputs Updated HIPS track lines with depths that are corrected for
sound velocity.
Command Line Syntax carisbatch --run SoundVelocityCorrectHIPS [options] <inputs>
<outputs>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

--algorithm Ray tracing algorithms are available through Teledyne FALSE This must
CARIS or third party. One of: be specified
• CARIS: Caris - All algorithms directly implemented. explicitly.
• KONGSBERG_LIBRARY: Kongsberg Library -
Licensed algorithm coming from library provided by
Kongsberg.
--svp-file The path to the sound velocity file. FALSE
If not set, uses the SVP already loaded in the HIPS data for
the track lines passed to the process.
--profile- Method for selection of which sound velocity profile to apply FALSE
selection-method for each ping, when multiple profiles are available. One of:
• PREVIOUS_IN_TIME: Previous in Time
• NEAREST_IN_TIME: Nearest in Time
• NEAREST_IN_DISTANCE: Nearest in Distance
• NEAREST_IN_DISTANCE_WITHIN: Nearest in
Distance Within Time
• USE_LAST_METHOD: Use Last Method
The default value is PREVIOUS_IN_TIME.
--heave-source Type of heave to be applied during merge. FALSE
• HEAVE: Realtime - Original heave data will be used.
• DELAYED_HEAVE: Delayed - Delayed heave data
will be used.
The default value is HEAVE.
--smooth-sensor If set, applies smoothing coefficients to the specified data. TRUE
• HEAVE: Heave - Smooths the heave data.
• PITCH: Pitch - Smooths the pitch data.
• ROLL: Roll - Smooths the roll data.
• DELTA_DRAFT: Delta draft - Smooths the delta
draft/subsea depth data.

Algorithm = CARIS Options

--ssp If set, surface sound speed (SSP) is not used even when FALSE
available.

482 CARIS HIPS and SIPS User Guide

HIPS Processes: Sound Velocity Correct HIPS

Parameter

Short Can Notes

Long Description
key Repeat

--svc-line FALSE
Algorithm = KONGSBERG_LIBRARY Options
N/A

ProfileSelectionMethod = NEAREST_IN_DISTANCE_WITHIN Options

--nearest- A number specifying the number of hours for use with the FALSE
distance-hours nearest in distance within time profile selection method.
The default value is 1.

SSP Options

--resteer-beam- If set, performs an additional recomputation of the steered FALSE

angles beam angles based on a new surface sound speed that will
be interpolated from the sound velocity profile (compatible
systems are listed in the online help). This is only available
when the Surface Sound Speed is used.
The recorded SSP (known to be incorrect) along with the
sound speed interpolated from SVP (assumed to be
correct), will be used to compute new beam angle data.
Ray-tracing will then proceed without insertion of the SSP
into the SVP. Used only if SSP is applied. For compatible
systems only.

Example To use this command, refer to the following example.

Example

Objective To use ray tracing to apply sound velocity profiles for more accurate soundings data.

Description Command Line Syntax

The CARIS algorithms will be applied. --algorithm CARIS

The sound velocity file is named sampleSVP.svp and is located at C:\. --svp-file C:\sampleSVP.svp
The sound velocity profile to apply is NEAREST_IN_TIME. --profile-selection-method
NEAREST_IN_TIME
Delayed heave data will be applied during sound . --heave-source DELAYED_HEAVE
The heave data will be smoothed. --smooth-heave
The input file is named input.hips and is located at C:\temp\input\. The C:\temp\input\.
HIPS file URI filters for the vessel named “sample” and the day 2000-
001.
carisbatch --run SoundVelocityCorrectHIPS --algorithm CARIS --svp-
Command Line file C:\sampleSVP.svp --profile-selection-method NEAREST_IN_TIME
file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001

Outcome The selected HIPS track line data is sound velocity corrected.

Extra Notes N/A

CARIS HIPS and SIPS User Guide 483

HIPS Processes: Update HIPS Additional Bathymetry

Update HIPS Additional Bathymetry

Description If corrections such as tide, SVP etc., have been applied to project
data during processing, requiring that Merge be re-applied, the
UpdateHIPSAdditionalBathymetry process updates stored
additional bathymetry.
Input One or more HIPS track lines (The additionalBathymetry.csar
accompanies the HIPS Project file for those track lines).
Outputs No output is generated. The additionalBathymetry.csar that
accompanies the HIPS Project is updated, no visual changes.
Command Line Syntax carisbatch --run UpdateHIPSAdditionalBathymetry [options]
<input>
Options None.

Example To use this command, refer to the following example.

Example

Objective To update additional bathymetry data after Merge has been applied.

Description Command Line Syntax

The input file is named input.hips and is located at C:\temp\input\. The C:\temp\input\.
HIPS file URI filters for the vessel named “sample” and the day 2000-
001.
carisbatch -run UpdateHIPSAdditionalBathymetry file:///C:/temp/
Command Line
input/input.hips?Vessel=sample;Day=2000-001

Outcome Merged track lines are updated using Additional bathymetry.

Extra Notes N/A

484 CARIS HIPS and SIPS User Guide

HIPS Processes: Update Raster CUBE Disambiguation

Update Raster CUBE Disambiguation

Description The UpdateRasterCUBEDisambiguation process will change the
disambiguation method used in CUBE surfaces.
Update CUBE raster surface in CSAR format.
Outputs Updated CUBE raster surface in CSAR format.
Command Line Syntax carisbatch --run UpdateRasterCUBEDisambiguation [options]
<update>
Options The following table describes the parameters available for this
process.

Parameter

Short Can Notes

Long Description
key Repeat

--disambiguation- The method used to select a hypothesis from a set. FALSE

method • DENSITY: Density - Disambiguate by number of
samples.
• LOCALE: Locale - Disambiguate by surrounding
nodes.
• DENSITY_LOCALE: Density and Locale -
Disambiguate by a combination of sample count and
surrounding nodes.
The default value is DENSITY_LOCALE.

Example To use this command, refer to the following example.

Example

Objective To change the disambiguation method used in a HIPS raster CUBE surface.

Description Command Line Syntax

The disambiguation engine to use is DENSITY. --disambiguation-method DENSITY

The updated file is named input_CUBE_surface.csar and is located at C:\temp\input_CUBE_surface.csar
C:\temp\input\.
carisbatch --run UpdateRasterCUBEDismbiguation --disambiguation-method DENSITY
Command Line
C:\temp\input_CUBE_surface.csar

Outcome The CUBE surface is updated using an alternate disambiguation method

Extra Notes N/A

CARIS HIPS and SIPS User Guide 485

HIPS Processes: Update SIPS Contact Positions

Update SIPS Contact Positions

Description The UpdateSIPSContactPositions process takes a HIPS Project or
track lines and recomputes all contacts in those lines.
Update One or more HIPS track lines.
Outputs Updated HIPS track lines.
Command Line Syntax carisbatch --run UpdateSIPSContactPositions [options]
<update>
Options None.

Example To use this command, refer to the following example.

Example

Objective To recompute the position of all contacts in a HIPS project or selected lines.

Description Command Line Syntax

The updated file is input.hips located at C:/temp/input/. The HIPS file C:/temp/input/
URI filters for the vessel named “sample” and day 2000-001. input.hips?Vessel=sample;Day=2000-
001
carisbatch -run UpdateSIPSContactPositions file:///C:/temp/input/
Command Line
input.hips?Vessel=sample;Day=2000-001

Outcome Positions of all contacts are recomputed.

Extra Notes N/A

486 CARIS HIPS and SIPS User Guide

HIPS Processes: Update SIPS Contact Positions

CARIS HIPS and SIPS User Guide 487

HIPS Processes: Update SIPS Contact Positions

488 CARIS HIPS and SIPS User Guide

AVP Initial Setup and Game Installation
No ratings yet
AVP Initial Setup and Game Installation
7 pages
Admin S Guide GpsGate
100% (1)
Admin S Guide GpsGate
58 pages
APX15 User Guide
No ratings yet
APX15 User Guide
27 pages
Manual Obd2gps-Smart-Gauge-Ap-6
No ratings yet
Manual Obd2gps-Smart-Gauge-Ap-6
5 pages
Edgetech - 4200FS HD MP DF Side Scan System Towfish User Manual Rev - 1.2
No ratings yet
Edgetech - 4200FS HD MP DF Side Scan System Towfish User Manual Rev - 1.2
50 pages
GBT-Norbit 200kHz WBMS Long Range HYPACK Training Malta PDF
No ratings yet
GBT-Norbit 200kHz WBMS Long Range HYPACK Training Malta PDF
15 pages
360eyes User Guide
No ratings yet
360eyes User Guide
19 pages
6000i User Manual Rev D PDF
No ratings yet
6000i User Manual Rev D PDF
184 pages
Hydrobox Hypack Configuration PDF
No ratings yet
Hydrobox Hypack Configuration PDF
3 pages
09 SLKSLRMLGLGECLScomandman
No ratings yet
09 SLKSLRMLGLGECLScomandman
271 pages
Operating Manual (Deh-6150bt) Eng - Spa
No ratings yet
Operating Manual (Deh-6150bt) Eng - Spa
169 pages
Edge Tech6205s Hardware Manual
No ratings yet
Edge Tech6205s Hardware Manual
97 pages
302 Geophysics Cables
No ratings yet
302 Geophysics Cables
184 pages
POSPac MMS Overview of Changes
No ratings yet
POSPac MMS Overview of Changes
12 pages
19920982863
No ratings yet
19920982863
14 pages
Pelvis and Acetabulum System: Operative Technique
No ratings yet
Pelvis and Acetabulum System: Operative Technique
48 pages
Unit 1 Ict
No ratings yet
Unit 1 Ict
7 pages
Sensor Setting: Date: ......................... Signature
No ratings yet
Sensor Setting: Date: ......................... Signature
1 page
Quickstart Hydrostar and Hypack Seabeam 3000 Rev - D
No ratings yet
Quickstart Hydrostar and Hypack Seabeam 3000 Rev - D
43 pages
Night Owl Connect CMS Manual - English
No ratings yet
Night Owl Connect CMS Manual - English
59 pages
HGS-100NEW - Gas Detection Manual - 2007-11-06 - REV.6
No ratings yet
HGS-100NEW - Gas Detection Manual - 2007-11-06 - REV.6
76 pages
Caris Hips and Sips Vessel Editor
No ratings yet
Caris Hips and Sips Vessel Editor
41 pages
Nemo Analyze Manual
No ratings yet
Nemo Analyze Manual
460 pages
Fortiadc-V6 1 3-Handbook
No ratings yet
Fortiadc-V6 1 3-Handbook
690 pages
Merchant Payment Advice: MPR Date: From Date: To Date
No ratings yet
Merchant Payment Advice: MPR Date: From Date: To Date
2 pages
Gpswox Vehicle Tracker Commands PDF
No ratings yet
Gpswox Vehicle Tracker Commands PDF
1 page
Positive Case
No ratings yet
Positive Case
7 pages
NMap Commands KungFu
No ratings yet
NMap Commands KungFu
1 page
6000i User Manual Rev D
No ratings yet
6000i User Manual Rev D
184 pages
Panasonc DC-TZ90 - BASIC-Operating - Instructions - User - Manual
No ratings yet
Panasonc DC-TZ90 - BASIC-Operating - Instructions - User - Manual
64 pages
RMA V3R2.2 Users Guide
No ratings yet
RMA V3R2.2 Users Guide
398 pages
Verizon Remote Programming Guide P265usermanualmarch16
No ratings yet
Verizon Remote Programming Guide P265usermanualmarch16
2 pages
Total Control
No ratings yet
Total Control
12 pages
Bullet M2 - Network
No ratings yet
Bullet M2 - Network
3 pages
6205S MBESandSSS Software MANUAL
No ratings yet
6205S MBESandSSS Software MANUAL
108 pages
Release Notes - Vissim - 2023.00-05 - EN
No ratings yet
Release Notes - Vissim - 2023.00-05 - EN
12 pages
Paper 105
No ratings yet
Paper 105
6 pages
ILCO FLAT STEEL Key Blank Directory
No ratings yet
ILCO FLAT STEEL Key Blank Directory
10 pages
Sonardyne Ranger 8026 Navigation Computer
No ratings yet
Sonardyne Ranger 8026 Navigation Computer
2 pages
EBD 89 Application Form
No ratings yet
EBD 89 Application Form
29 pages
The Many Facets Of: Surveying
No ratings yet
The Many Facets Of: Surveying
36 pages
SmartJCL - Product Presentation
No ratings yet
SmartJCL - Product Presentation
45 pages
NaviEdit 87
No ratings yet
NaviEdit 87
10 pages
Howto Use Anchor Handling
No ratings yet
Howto Use Anchor Handling
13 pages
Snap Patent
No ratings yet
Snap Patent
21 pages
WatchPower User Manual-20160301
No ratings yet
WatchPower User Manual-20160301
47 pages
Dhanashri Naik Form PDF
No ratings yet
Dhanashri Naik Form PDF
4 pages
dsk6416 TechRef
No ratings yet
dsk6416 TechRef
56 pages
16
No ratings yet
16
13 pages
Scanline Software User Guide: (VERSION 2.1)
No ratings yet
Scanline Software User Guide: (VERSION 2.1)
24 pages
Lekemi GPS Tracker User Manual: English-Deutsch-Italiano
No ratings yet
Lekemi GPS Tracker User Manual: English-Deutsch-Italiano
72 pages
B628 350 LTE CPE Product Description
No ratings yet
B628 350 LTE CPE Product Description
33 pages
GP88s Portable Radio: Service Manual
No ratings yet
GP88s Portable Radio: Service Manual
192 pages
The Windows 7 Boot Process
No ratings yet
The Windows 7 Boot Process
2 pages
Kiosk Mode Setup
100% (1)
Kiosk Mode Setup
2 pages
Auto Clean Help
No ratings yet
Auto Clean Help
194 pages
ChatGPT for Business: Strategies for Success
From Everand
ChatGPT for Business: Strategies for Success
Matthew C. Smith
1/5 (1)
Autocad Raster Design 2012 Getting Started
No ratings yet
Autocad Raster Design 2012 Getting Started
122 pages
Tools and Utilities: On-Line Manual
No ratings yet
Tools and Utilities: On-Line Manual
151 pages
Map Ug
100% (1)
Map Ug
1,856 pages
Python Programming
No ratings yet
Python Programming
601 pages
LabManual CSE32509 01 2024 02 37 12 1054599822
No ratings yet
LabManual CSE32509 01 2024 02 37 12 1054599822
87 pages
How To Get Familiar With Ubuntu Commands: Steps
No ratings yet
How To Get Familiar With Ubuntu Commands: Steps
9 pages
Programming in 'C++'
No ratings yet
Programming in 'C++'
24 pages
Unit - 5 UNIX / Linux - File System Basics: Directory Structure
No ratings yet
Unit - 5 UNIX / Linux - File System Basics: Directory Structure
41 pages
A Basic UNIX Tutorial
No ratings yet
A Basic UNIX Tutorial
44 pages
Operating Systems - CS604 Power Point Slides Lecture 10
No ratings yet
Operating Systems - CS604 Power Point Slides Lecture 10
20 pages
CS2305 Programming Paradigrm
No ratings yet
CS2305 Programming Paradigrm
12 pages
Samsung PDF
No ratings yet
Samsung PDF
30 pages
Vol 1 Chapter 4
No ratings yet
Vol 1 Chapter 4
11 pages
Basic Programming Logic
No ratings yet
Basic Programming Logic
18 pages
Mininet Python API Reference Manual: Generated by Doxygen 1.8.3.1
No ratings yet
Mininet Python API Reference Manual: Generated by Doxygen 1.8.3.1
75 pages
Samsung New
No ratings yet
Samsung New
6 pages
Linux I_231028_124827
No ratings yet
Linux I_231028_124827
11 pages
Unit - 1 Summary CPRGM
No ratings yet
Unit - 1 Summary CPRGM
11 pages
Linux Command Line - From Simple Commands To Advanced Level PDF
100% (2)
Linux Command Line - From Simple Commands To Advanced Level PDF
124 pages
JAVA UNIT-2 Precise Notes
No ratings yet
JAVA UNIT-2 Precise Notes
29 pages
Microsoft Word - Testbook26 - Uva
No ratings yet
Microsoft Word - Testbook26 - Uva
56 pages
Pec Log
No ratings yet
Pec Log
6 pages
Sed Commands
No ratings yet
Sed Commands
8 pages
Mplayer Commands
No ratings yet
Mplayer Commands
11 pages
SBCL User Manual
No ratings yet
SBCL User Manual
172 pages
Think Unix PDF
No ratings yet
Think Unix PDF
299 pages
I/Oinc: Engineering H192 - Computer Programming
No ratings yet
I/Oinc: Engineering H192 - Computer Programming
12 pages
08 - I/O Multiplexing: LT D LLF Ti Select and Poll Functions
No ratings yet
08 - I/O Multiplexing: LT D LLF Ti Select and Poll Functions
32 pages
HPOO Flow Authoring Guide
No ratings yet
HPOO Flow Authoring Guide
186 pages
Using Seed: Using: Jrdseed PQL Sac Resp Jplotresp
No ratings yet
Using Seed: Using: Jrdseed PQL Sac Resp Jplotresp
16 pages
Linux
No ratings yet
Linux
25 pages
Linux Admin 1 Commands
No ratings yet
Linux Admin 1 Commands
36 pages