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 |
| |||
Long | Short | Description | Can Repeat | Notes
|
Common Options | ||||
--input-format | i | A string specifying the format of the data to import. One of: • 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. | FALSE | This must be specified explicitly. |
--gridding-method | g | A string specifying the gridding method used to generate the output raster. One of: • BASIC: Basic weighted mean. • TPU: Total propagated uncertainty weighted mean. • SHOAL: Shoalest depth. • SHOAL_TRUE: Shoalest depth with true positions. | FALSE | If a gridding method is specified, a raster is created. Otherwise, a point cloud is created. |
--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 if a GriddingMethod is applied. |
--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. If not set, the extents are computed from the input data. | FALSE | |
--output-crs | c | A string specifying the horizontal coordinate reference system key of the output. If specified, the data will be transformed. | FALSE | |
--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 | |
--compute-band | a | A string specifying an output band to be computed from 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. | TRUE | |
--include-band | b | A string specifying the name of a band to include in the output. The ALL keyword is used to include all other bands in the output. | TRUE | |
--recurse | u | If set, points in all files that match the input description in any subfolders are also imported. | FALSE | |
--primary-band | m | A string specifying the name of the primary band of the output. The default value is Depth. | FALSE | |
--temporal-extent | A string specifying the temporal extents of the data. <SourceStartDate> A string specifying the start date of the source data. <SourceEndDate> A string specifying the end date of the source data. Dates are specified in the standard ISO 8601 extended date-time format for batch processes, which is YYYY-MM-DDTHH:MM:SS[.sss]Z, with the time reported in UTC. For times not in UTC, it is specified as YYYY-MM-DDTHH:MM:SS[.sss]{+,-}HH:MM, where the plus or minus indicate the difference from UTC to the relevant time zone. See ISO 8601 documentation for more information. | FALSE | Temporal extents are automatically populated for some formats, such as ASCII (if date/time fields are present) or GSF. These values are overridden in the output if values are explicitly set through this option. | |
--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 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. | 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 | ||
InputFormat = ASCII Options | ||||
--input-crs | p | A string specifying the horizontal coordinate reference system key of the input. | FALSE | This must be specified explicitly. |
--info-file | s | The path to a file that describes the format of the input ASCII files. | FALSE | This must be specified explicitly. |
InputFormat = CRS Options | ||||
--z-axis-convention | z | A string specifying the input Z-axis convention. One of: • UP: Z-axis is positive up. • DOWN: Z-axis is positive down. The default value is UP. | FALSE | |
InputFormat = CSAR Options | ||||
N/A | ||||
InputFormat = C_AND_C Options | ||||
--input-crs | p | A string specifying the horizontal coordinate reference system key of the input. | FALSE | This must be specified explicitly. |
--z-axis-convention | z | A string specifying the input Z-axis convention. One of: • UP: Z-axis is positive up. • DOWN: Z-axis is positive down. The default value is UP. | FALSE | |
InputFormat = GSF Options | ||||
--z-axis-convention | z | A string specifying the input Z-axis convention. One of: • UP: Z-axis is positive up. • DOWN: Z-axis is positive down. The default value is UP. | FALSE | |
InputFormat = HOB Options | ||||
--feature-catalogue | F | A string specifying the name of the catalogue that defines the features and attributes in the input dataset. One of {list dynamically populated from the catalogue control file}. The catalogue must be in the catalogue control file specified in the Tools > Options > Files and Folders > Files > Catalogue Control, for example S-57 ENC 3.1. | FALSE | This must be specified explicitly. The default location of CatalogueControl.xml file is C:\Program Files\CARIS\BASE Editor\4.2\system\ |
InputFormat = HTF Options | ||||
--input-crs | p | A string specifying the horizontal coordinate reference system key of the input. | FALSE | This must be specified explicitly. |
--depth-attribute | d | A string specifying the name of the attribute containing the depth value. | FALSE | This must be specified explicitly. |
--depth-scale-factor | s | A numeric multiplier used to scale the depth attribute value. The default value is 1.0. | FALSE | |
--v-uncert-attribute | t | A string specifying the name of the attribute containing the vertical uncertainty value. | FALSE | |
--x-coord-attribute | x | A string specifying the name of the attribute containing the X coordinate position. | FALSE | This must be specified explicitly. |
--y-coord-attribute | y | A string specifying the name of the attribute containing the Y coordinate position. | FALSE | This must be specified explicitly. |
--z-axis-convention | z | A string specifying the input Z-axis convention. One of: • UP: Z-axis is positive up. • DOWN: Z-axis is positive down. The default value is UP. | FALSE | |
InputFormat = HYD93 Options | ||||
--input-crs | p | A string specifying the horizontal coordinate reference system key of the input. | FALSE | This must be specified explicitly. |
--z-axis-convention | z | A string specifying the input Z-axis convention. One of: • UP: Z-axis is positive up. • DOWN: Z-axis is positive down. The default value is UP | FALSE | |
InputFormat = LAS Options | ||||
--override-crs | p | A string specifying the horizontal coordinate reference system key to override the coordinate reference system defined in the LAS file. | FALSE | |
--use-las-extent | d | If set, the extents in the LAS file will be applied. | FALSE | |
--z-axis-convention | z | A string specifying the input Z-axis convention. One of: • UP: Z-axis is positive up. • DOWN: Z-axis is positive down. The default value is UP. | FALSE | |
--flag-synthetic | A string specifying how to map the Synthetic LAS flag. 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. | FALSE | ||
--flag-key-point | A string specifying how to map the Key_Point LAS flag. 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. | FALSE | ||
--flag-overlap | A string specifying how to map the Overlap LAS flag. 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. | FALSE | ||
--flag-withheld | A string specifying how to map the Withheld LAS flag. 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. | FALSE | ||
--reference-week | The timestamp indicating the reference week for GPS Week Time. Dates are specified in the standard ISO 8601 extended date-time format for batch processes, which is YYYY-MM-DDTHH:MM:SS[.sss]Z, with the time reported in UTC. For times not in UTC, it is specified as YYYY-MM-DDTHH:MM:SS[.sss]{+,-}HH:MM, where the plus or minus indicate the difference from UTC to the relevant time zone. 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. | FALSE | ||
InputFormat = NTX | ||||
--flag-selected | s | A string specifying how to apply the Selected NTX flag. 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. | FALSE | |
--flag-suppressed | d | A string specifying how to apply the Suppressed NTX 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. | FALSE | |
--flag-background | k | A string specifying how to apply the Background NTX 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. | FALSE | |
--include-3D-symbol | t | A string specifying the feature code of a 3D symbol to include. The ALL keyword is used to include all 3D symbols. | TRUE | |
--z-axis-convention | z | A string specifying the input Z-axis convention. One of: • UP: Z-axis is positive up. • DOWN: Z-axis is positive down. The default value is UP. | FALSE | |
InputFormat = RDP Options | ||||
--z-axis-convention | z | A string specifying the input Z-axis convention. One of: • UP: Z-axis is positive up. • DOWN: Z-axis is positive down. The default value is UP | FALSE | . |
To use this command refer to the following examples.
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. |
| |
The input coordinate reference system and the output coordinate reference system are both UTM‑19N‑Nad83. | --input-crs UTM-19N-Nad83 --output-crs UTM-19N-Nad83 | |
The format information file, EastingNorthingDepth.info, is located at D:\BatchSample. | --info-file D:\BatchSample\EastingNorthingDepth.info | |
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 and will be created in the D:\BatchSample directory. | D:\BatchSample\ImportedFromASCII.csar | |
Command Line |
| |
Outcome | A new CSAR point cloud is created in the specified location. | |
Extra Notes | N/A | |
Example 2: ASCII to Gridded Raster
Example | ||
Objective | You want to create a gridded raster surface CSAR file from multiple input point clouds in the ASCII 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 are both 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 at D:\BatchSample. | --info-file D:\BatchSample\EastingNorthingDepth.info | |
In addition to the primary band, Depth, the resulting surface will have the following computed attributes: Shoal and Standard deviation. | --compute-band SHOAL --compute-band STD_DEV | |
The files Survey2.xyz.ascii, Survey3.xyz.ascii and Survey4.xyz.ascii will all be imported from D:\BatchSample. | D:\BatchSample\Survey2.xyz.ascii D:\BatchSample\Survey3.xyz.ascii D:\BatchSample\Survey4.xyz.ascii | |
The output will be a single CSAR file named ImportedFromASCII_2.csar created in the D:\BatchSample directory. | D:\BatchSample\ImportedFromASCII_2.csar | |
Command Line |
| |
Outcome | A single raster surface in CSAR format is created in the designated location. | |
Extra Notes | N/A | |
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 import. | --include-band ALL | |
The import will use the WG84 coordinate reference system (CRS) as there is no CRS specified in the LAS header. | --override-crs WG84 | |
Import data within the extents specified in the LAS header. | --use-las-extent | |
The LAS status flags are to be mapped as follows: • Synthetic = Accepted • Key Point = Designated • Overlap = Accepted • Withheld = Rejected | --flag-synthetic ACCEPT --flag-key-point DESIGNATED --flag-overlap ACCEPT --flag-withheld REJECT | |
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 created in the D:\BatchSample directory. | D:\BatchSample\ImportLAS.csar | |
Command Line |
| |
Outcome | A new point cloud in CSAR format with the LAS flags mapped to the Status band. | |
Extra Notes | N/A | |
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 behaviour), Suppressed NTX soundings will also be accepted. | --flag-suppressed ACCEPT | |
All 3D symbols will be included. | --include-3D-symbol ALL | |
The input z-axis convention is positive down. | --z-axis-convention UP | |
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 created in the D:\BatchSample directory. | D;\BatchSample\ImportNTX.csar | |
Command Line | carisbatch --run ImportPoints --input-format NTX --flag-suppressed ACCEPT --include-3D-symbol ALL | |
Outcome | A new point cloud in CSAR format is created in the specified location. | |
Extra Notes | N/A | |