CARIS BASE Editor : CARIS Batch Utility : BASE Manager 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>

User Interface Command

Join Points

Options

The following table describes the parameters available for this process.

Parameter

 

Long

Short

Description

Can Repeat

Notes

 

--database-name

D

The name of the database server instance containing the inputs.

The input point clouds must be in the specified database.

FALSE

This must be specified explicitly.

--login

L

The node manager login credentials. Specified as either username/password or username/password@hostname.

Omitting @hostname is equivalent to using @localhost.

FALSE

This must be specified explicitly.

--primary-band

m

A string specifying the name of the primary elevation band of the output.

The default value is Depth.

FALSE

--contributor-attribute

C

A string specifying an attribute value to be included in the 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.

TRUE

--output-crs

c

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

For time-dependent coordinate reference systems, the epoch can be specified, typically using the year, as <crs_id>@1997. A fractional year can also be specified, such as <crs_id>@1997.3, if needed. If no epoch is specified, the reference epoch of the coordinate reference system is used.

FALSE

This must be specified explicitly.

--output-vertical-crs

o

A string specifying the vertical coordinate reference 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.

FALSE

--extent

E

The extents that define the window.

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

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

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

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

The unit is assumed to be that of the output's coordinate reference system, unless otherwise specified. When specifying units for 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.

FALSE

This must be specified explicitly.

--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 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 machine is the default user account.

--login dba/sql@localhost

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:

lower-left X: 417854.16

lower-left Y: 5578698.32

upper-right X: 419325.69

upper-right Y: 5579707.37

--extent 417854.16 5578698.32 419325.69 5579707.37

The input files are:

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.

02000002 02000003 02000011

A new file will be created with the file name ServerJoined.csar, in the BatchSample folder, the same folder containing the source files.

D:\BatchSample\ServerJoined.csar

Command Line

carisbatch --run ServerJoinPoints --database-name Database5 --login dba/sql@localhost --output-crs UTM-30N --primary-band Depth --extent 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.

Extra Notes

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