CLI Reference

The following reference covers all subcommands and flags you can pass to the cassini program.

cassini process

Generate a map from a single LiDAR file. The process subcommand takes the path to the LiDAR file to process as an argument:

Windows

cassini process path\to\my\tile.laz

macOS

cassini process ./path/to/my/tile.laz

Linux

cassini process ./path/to/my/tile.laz

Flags

--output-dir or -o

Type: string
Default: tile

The output directory for the processed LiDAR file.

--skip-vector or -s

Type: boolean

The --skip-vector flag will skip the vector processing stage of the pipeline. No file will be downloaded from OpenStreetMap and no vector features will be drawn on the map (roads, lakes…).

cassini lidar

Run only the LiDAR processing step for a single tile. The lidar subcommand takes the path to the LiDAR file to process as an argument:

Windows

cassini lidar path\to\my\tile.laz

macOS

cassini lidar ./path/to/my/tile.laz

Linux

cassini lidar ./path/to/my/tile.laz

Flags

--output-dir or -o

Type: string
Default: lidar

The output directory for the processed LiDAR file.

cassini render

Run only the map rendering step for a single tile. The render subcommand takes the path to the directory containing the output of the LiDAR processing step as an argument:

Windows

cassini render path\lidar\step\output\directory

macOS

cassini render ./path/to/lidar/step/output/directory

Linux

cassini render ./path/to/lidar/step/output/directory

Flags

--output-dir or -o

Type: string
Default: tile

The output directory for the processed tile.

--neighbors or -n

Type: string[]

A list of directories containing the output of the LiDAR processing step for neighboring tiles (see this post).

--skip-vector or -s

Type: boolean

The --skip-vector flag will skip the vector processing stage of the pipeline. No file will be downloaded from OpenStreetMap and no vector features will be drawn on the map (roads, lakes…).

cassini batch

Process multiple LiDAR files at once. The batch subcommand takes the path to the directory containing the LiDAR files to process as an argument. This argument is optional, its default value is in:

cassini batch

Flags

--output-dir or -o

Type: string
Default: out

The output directory for the processed LiDAR files.

--threads or -t

Type: number
Default: 3

In batch mode, you can specify the number of threads used by Cassini to parallelize the work.

cassini batch --threads 6

--skip-lidar

Type: boolean

The --skip-lidar flag will skip the LiDAR processing stage of the pipeline. It will only work if you allready ran cassini once with the same input files, as it will reuse some temp files.

--skip-vector

Type: boolean

The --skip-vector flag will skip the vector processing stage of the pipeline. No file will be downloaded from OpenStreetMap and no vector features will be drawn on the map (roads, lakes…).

cassini config

Output a default config.json file, that you can edit to modify the map rendering parameters.

cassini config

{
  "yellow_threshold": 0.5,
  "green_threshold_1": 0.2,
  "green_threshold_2": 1.0,
  "green_threshold_3": 2.0,
  "cliff_threshold_1": 45.0,
  "cliff_threshold_2": 55.0,
  "dpi_resolution": 600.0
}

cassini help

Print a help message:

A software that generates highly accurate topographic maps from LiDAR data. See documentation: https://cassini-map.com. GDAL and PDAL must be installed on the system for this program to work.

Usage: cassini [COMMAND]

Commands:
  process         Generate a map from a single LiDAR file
  lidar           Run only the LiDAR processing step for a single tile
  render          Run only the map generation step for a single tile
  batch           Process multiple LiDAR files at once
  config          Output a default config.json file
  help            Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help (see more with '--help')
  -V, --version  Print version

The help message is olso printed if cassini is called without any arguments.

Common flags

--help or -h

Same than cassini help or cassini

--version or -V

Print the cassini version

cassini 0.4.0