Parameter

Long

Short

Description

Can Repeat

Notes

Common Options

--output-format

O

A string specifying the format in which the output cloud is generated.

• LAS: The LASer (LAS) File format.

• CSAR: The CSAR cloud format.

• FAU: The FAU format.

• GSF: The Generic Sensor Format (GSF).

Options specific to each format are specified below.

FALSE

This must be specified explicitly.

ExportPoints = CSAR

--include-band

b

A string specifying the name of a band to include in the output.

The ALL keyword is used to include all bands in the output.

TRUE

This must be specified explicitly.

--comments

General comments to be added to the coverage metadata.

The default value is an empty string.

FALSE

ExportPoints = FAU

None

ExportPoints = GSF

--time-band

A string specifying the name of the input band containing the time each point was recorded.

This information is used to identify swaths in the source data.

FALSE

This must be specified explicitly.

--beam-order-band

A string specifying the name of the input band used to order the points per profile.

If they are present in the input, it is recommended to use either Beam Number, Beam Angle, or Across Track.

If no band name is provided, position will be used instead, but heading values may be reversed in some scenarios.

Note: The band specified for this option is not included in the output unless it is also specified through the IncludeBand option.

FALSE

--include-band

b

The names of the input band and the GSF output.

<InputName> A string specifying the name of the input band to use in the output. Some attributes will be mapped directly. Others are recomputed.

<OutputName> A string specifying the name of the output GSF band.

• DEPTH: The Z value of the points.

• NOMINAL_DEPTH: The nominal depth value of the points.

• VERTICAL_ERROR: The vertical error value.

• HORIZONTAL_ERROR: The horizontal error value.

• TRAVEL_TIME: The time taken for the ping to return to the sensor.

• BEAM_ANGLE: The sensor angle at which the point was collected.

This setting is optional; if no bands are specified, the default elevation band of the input will automatically be mapped to the DEPTH band in the output.

TRUE

ExportPoints = LAS

--las-version

V

The LAS format version to output. The value must be one of 1.0, 1.1, 1.2, 1.3 or 1.4.

FALSE

This must be specified explicitly.

--point-record-format

A number specifying the point record format to use.

The value must be one of 1 through 10. The point format that best suits the data will be selected automatically. If set, this option will override the default behaviour and use the specified point record.

FALSE

--include-band

b

The names of the input band and the LAS output.

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.

TRUE

--include-band (cont.)

b

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

TRUE

--coordinate-precision

A number specifying the decimal precision of the coordinates in the output.

The default value is 3.

FALSE

--elevation-precision

A number specifying the decimal precision of the elevation in the output.

The default value is 3.

FALSE

--use-gps-week-time

Use GPS Week Time when storing time.

The default is to use Adjusted Standard GPS Time.

FALSE

--override-classification-file

C

The path to a file with classification identifiers and names.

This option is used to export 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.

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.

FALSE

--override-classification-mapping

M

A classification mapping for a single value that overrides the mapping defined in the LAS standard.

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

TRUE

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

--include-band Depth --include-band Shoal

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

D:\BatchSample\Surface5.csar

The output file will be created in the D:\BatchSample directory and named Exportedpoints.csar.

D:\BatchSample\Exportedpoints.csar

Command Line

carisbatch --run ExportPoints --output-format CSAR --include-band Depth --include-band Shoal D:\BatchSample\Surface5.csar 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

Objective

You want to export GSF data from a coverage to a GSF format file.

Description

Command Line Syntax

The output format is GSF.

--output-format GSF

Time data for the points being exported is found in the Time band.

--time-band Time

Beam order is found in the Beam Angle band.

--beam-order-band Beam Angle

The input bands will be mapped to the output file as follows:

Depth > DEPTH

Vert_Uncert > VERTICAL_ERROR

Beam Angle > BEAM_ANGLE

--include-band Depth DEPTH --include-band Vert_Uncert VERTICAL_ERROR --include-band "Beam Angle" BEAM_ANGLE

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

D:\BatchSample\GSF_Data.csar

The output file will be created in the D:\BatchSample directory and named GSF_Export.gsf.

D:\BatchSample\GSF_Export.gsf

Command Line

carisbatch --run ExportPoints --output-format GSF --time-band Time --beam-order-band "Beam Angle" --include-band Depth DEPTH --include-band Vert_Uncert VERTICAL_ERROR --include-band "Beam Angle" BEAM_ANGLE D:\BatchSample\GSF_Data.csar D:\BatchSample\GSF_Export.gsf

Outcome

The data is exported to a new GSF format file with the band values mapped as specified.

Extra Notes

N/A

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 status flags from the LAS_Flags band and the values from the other bands of the source coverage will be exported and mapped to the LAS data as follows:

• The Return_Number band will be mapped to the Return_Number band in the output.

• The Number_Of_Returns band will be mapped to the Number_Returns band in the output.

• The Classification band will be mapped to the Classification band in the output.

• The Scan_Direction LAS status flag will be mapped from the LAS_Flags band to the Scan_Direction_Flag band in the output.

• The Synthetic LAS status flag will be mapped from the LAS_Flags band to the Sythetic band in the output.

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

--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 LAS_Flags:Synthetic Synthetic --include-band LAS_Flags:Withheld 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

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

D:\BatchSample\LASPointCloud.csar

The output file will be created in the D:\BatchSample directory and named OutputCoverage.las.

D:\BatchSample\OutputCoverage.las

Command Line

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 LAS_Flags:Synthetic Synthetic --include-band LAS_Flags:Withheld 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

Outcome

A new LAS file is created. The dataset will include the specified bands as well as bands for each of the LAS status flags that were mapped from the LAS_Flags band.

Extra Notes

N/A