CARIS HIPS and SIPS Help : CARIS Batch Utility : CZMIL Processes : Compare CZMIL To Reference
 

Compare CZMIL To Reference

Description

The CompareCZMILToReference process is used to compare points in CZMIL format to known reference points.

Inputs

CPF data to be analyzed, in the form of one or more CPF files or filtered CPF data.

Outputs

An ASCII file report containing the process input and output information, similar to the content in a process log. This file is created in the CPF lidar folder with a file name + comparetoreference in txt format (20210930T151600_comparetoreference.txt).

Command Line Syntax

carisbatch --run CompareCZMILToReference --reference-points <value> [options] <inputs>

User Interface Command

Compare CPF to Control Points

Options

The following table describes the parameters available for this process.

Parameter

 

Long

Short

Description

Can Repeat

Notes

 

--reference-points

The points used as references when analyzing the input points.

LAS and CSAR point cloud sources are supported.

FALSE

This must be specified explicitly.

--reference-radius

A number and unit specifying the maximum distance from a reference point for it to be relevant.

Any points that are farther from all reference points are excluded from the analysis.

The default value is 1m.

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

FALSE

--vertical-tolerance-filter

Input points with depths that differ from the reference point depths by more than this tolerance are filtered out.

<Minimum> - A number and unit for the minimum depth difference.

If input point depth minus reference point depth is lower than this value, the point is filtered out. The default value is -2m.

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

<Maximum> - A number and unit for the maximum depth difference.

If input point depth minus reference point depth is higher than this value, the point is filtered out. The default value is 2m.

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

FALSE

--x-axis

The range of depth values displayed along the x axis of the scatterplots.

<Minimum> - A number and unit for the minimum depth value displayed.

The default value is 0 m.

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

<Maximum> - A number and unit for the maximum depth value displayed.

The default value is 50 m.

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

FALSE

--y-axis

The range of difference of depths from the reference values displayed along the y axis of the scatterplots.

<Minimum> - A number and unit for the minimum depth difference value displayed.

The default value is -1 m.

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

<Maximum> - A number and unit for the maximum depth difference value displayed.

The default value is 1 m.

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

FALSE

--shallow-image-file

The full path to the image file created for the scatterplot for shallow channel data.

This is created in JPEG format.

FALSE

--deep-image-file

The full path to the image file created for the scatterplot for deep channel data.

This is created in JPEG format.

FALSE

--shallow-image

The image created for the scatterplot for shallow channel data. This is created in JPEG format.

FALSE

--deep-image

The image created for the scatterplot for deep channel data. This is created in JPEG format.

FALSE

--number-of-shallow-points

The number of points from shallow channel data considered in the analysis. Any points that are far from all reference points are ignored and are not included in this count.

FALSE

--number-of-deep-points

The number of points from deep channel data considered in the analysis. Any points that are far from all reference points are ignored and are not included in this count.

FALSE

--number-of-filtered-shallow-points

The number of points from shallow channel data that passed the vertical tolerance filter. These points are close enough to the reference points to have a meaningful comparison.

FALSE

--number-of-filtered-deep-points

The number of points from deep channel data that passed the vertical tolerance filter. These points are close enough to the reference points to have a meaningful comparison.

FALSE

--percentage-of-shallow-points-within-limit

The percentage of filtered shallow channel points that were within the accuracy limits. This is a number between 0 and 1, where 1=100%, 0.5=50%, etc.

FALSE

--percentage-of-deep-points-within-limit

The percentage of filtered deep channel points that were within the accuracy limits. This is a number between 0 and 1, where 1=100%, 0.5=50%, etc.

FALSE

Example

To use this command refer to the following example.

Example

Objective

You need to verify that the CZMIL data meets the accuracy requirements for a project.

Description

Command Line Syntax

The CZMIL data is called InputCZMIL.cpf and is located in the D:\SampleData\CZMIL directory.

D:\SampleData\CZMIL\InputCZMIL.cpf

The CZMIL data will be compared to the Reference.csar point cloud located in the same directory as the input.

--reference-points D:\SampleData\CZMIL\Reference.csar

Points must be within 0.75m from a reference point to be included in the analysis.

--reference-radius 0.75m

Point depths must be within 1m of the reference point depths to be included in the analysis.

--vertical-tolerance-filter -1m 1m

Image files will be created for the scatterplots for both the shallow and deep channel data. The images will be created in the D:\SampleData\CZMIL\Images directory and named ShallowChannelPlot and DeepChannelPlot respectively.

--shallow-image-file D:\SampleData\CZMIL\Images\ShallowChannelPlot.jpg --deep-image-file D:\SampleData\CZMIL\Images\DeepChannelPlot.jpg

Command Line

carisbatch --run CompareCZMILToReference --reference-points D:\SampleData\CZMIL\Reference.csar --reference-radius 0.75m --vertical-tolerance-filter -1m 1m --shallow-image-file D:\SampleData\CZMIL\Images\ShallowChannelPlot.jpg --deep-image-file D:\SampleData\CZMIL\Images\DeepChannelPlot.jpg D:\SampleData\CZMIL\InputCZMIL.cpf

Outcome

An ASCII file is created in the D:\SampleData\CZMIL\Lidar folder containing a report of the depth variations. The scatterplot image files of the variations are created in the D:\SampleData\CZMIL\Images\ directory.

Extra Notes

N/A