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 |
| |||
Long | Short | Description | Can Repeat | Notes |
--primary-band | m | A string specifying the name of the primary band of the output. This must be the OutputBandName of an IncludeBand. The default value is Depth. | FALSE | |
--resolution | R | A number and unit specifying the resolution of the output raster. 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. |
--include-band | b | The input band name, output band name and type of gridding to be 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. | TRUE | |
--include-band (cont.) | b | Advanced options: • 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. | TRUE | |
--degrees-of-freedom | k | A number used to calculate the degrees of freedom used when 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. | FALSE | |
--anchor | A | The point that defines the output raster anchor position. <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. | FALSE | |
--polygon-type | Y | A string specifying the type of bounding polygon to 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. | FALSE | |
--comments | General comments to be added to the coverage metadata. The default value is an empty string. | FALSE | ||
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 5419732m, based on the coordinate reference system of the input point cloud. | --anchor 314283m 5419732m | |
The resolution will be 2 metres. | --resolution 2m | |
The MEAN operation will run on the Depth band of the input to create a Depth band in the output. | --include-band Depth Depth MEAN | |
The INCLINATION operation will run on the Depth band of the input to create a band named Slope in the output. | --include-band Depth Slope INCLINATION | |
For the calculation of standard deviation, the degrees of freedom is 2. | --degrees-of-freedom 2 | |
The elevation band Depth, populated using the MEAN operation, will be assigned as the primary elevation band. | --primary-band Depth | |
The source surface, pointcloud.csar, is located in the D:\BatchSample directory. | D:\BatchSample\pointcloud.csar | |
The resulting surface will be named gridpoints.csar and stored in the D:\BatchSample directory. | D:\BatchSample\gridpoints.csar | |
Command Line |
| |
Outcome | A new CSAR raster is created in the specified location. | |
Extra Notes | N/A | |