Outputs¶

Chosen by "type" in outputs.

Type	What it is
`heightmap`	Writes the generated heights as a float32 GeoTIFF, with a raster base's projection.
`crater_list`	Writes the generated and manual craters as CSV or JSON.
`boulder_list`	Writes every boulder the layers placed, models and relief alike, as CSV or JSON.
`boulder_models`	Writes the boulders placed as 3D models on the ground: as a glTF scene (.glb, or .gltf with a .bin) drawing each shape once per boulder, as OBJ (.obj with an .mtl) with one object per boulder, or as one merged STL mesh (.stl).
`albedo`	Writes the albedo as a float32 GeoTIFF of one band or three (red, green, blue).
`mesh`	Writes the whole body, from six cube faces: a mesh as glTF (.glb or .gltf), OBJ (.obj) or STL (.stl), or a Gaskell ICQ shape model in kilometres (.icq), whose Q is cells_per_face.
`terrain_mesh`	Writes the generated heights as a triangle mesh, a vertex per cell with data, as glTF (.glb or .gltf), OBJ (.obj) or STL (.stl), in the frame boulder models are written in.
`materials`	Writes the material map as a float32 GeoTIFF of five bands: the share of soil, sand, dust, bedrock and rock at each cell.
`photometry`	Writes the Hapke parameters the materials mix to as a float32 GeoTIFF of four bands: single-scattering albedo, b, c and roughness in degrees.

`heightmap`¶

Writes the generated heights as a float32 GeoTIFF, with a raster base's projection.

Key	Type	Default	Range	Unit	Description
`path`	string	`""`			GeoTIFF file to write; relative paths resolve against the output folder (the CLI's --output-dir), else the configuration's folder.
`compression`	one of `none`, `lzw`, `deflate`, `packbits`	`"lzw"`			Compression of the file; compressed files use the floating-point predictor.
`tile_size`	integer	`256`	[16, inf)	px	Width and height of the file's tiles in pixels; a positive multiple of 16.

region: Grid of square cells the file covers; unset for the base's grid.

Key	Type	Default	Range	Unit	Description
`width`	integer	`513`	[2, 65536]		Columns of the grid.
`height`	integer	`513`	[2, 65536]		Rows of the grid.
`pixel_size`	number	`2.0`	(0, inf)	m	Cell size in metres; on a body, metres along a meridian, the same in degrees of longitude.
`centre_x`	number	`0.0`			Centre of the grid along x in surface coordinates; the longitude in degrees on a body.
`centre_y`	number	`0.0`			Centre of the grid along y in surface coordinates; the latitude in degrees on a body.

Every key with its default

{
    "type": "heightmap",
    "path": "",
    "region": null,
    "compression": "lzw",
    "tile_size": 256
}

Used in: example_ages_fresh, example_ages_steady_state, example_ages_uniform, example_albedo_blast_zone, example_albedo_crater_rays, example_albedo_fresh_crater, example_albedo_moon_site, example_albedo_new_crater and 66 more

`crater_list`¶

Writes the generated and manual craters as CSV or JSON.

Key	Type	Default	Range	Unit	Description
`path`	string	`""`			File to write; relative paths resolve against the output folder (the CLI's --output-dir), else the configuration's folder.
`format`	one of `csv`, `json`	`"csv"`			Format of the file; when not given, .json paths are written as JSON and others as CSV.
`spacing`	number, optional	`null`	(0, inf)	m	Sample spacing in metres the features are listed at, as a heightmap of that pixel size applies them; unset for the region's pixel size. A whole-body list needs it.

region: Grid of square cells the features are listed over; unset for the base's grid, or without a base the whole body on a body.

Key	Type	Default	Range	Unit	Description
`width`	integer	`513`	[2, 65536]		Columns of the grid.
`height`	integer	`513`	[2, 65536]		Rows of the grid.
`pixel_size`	number	`2.0`	(0, inf)	m	Cell size in metres; on a body, metres along a meridian, the same in degrees of longitude.
`centre_x`	number	`0.0`			Centre of the grid along x in surface coordinates; the longitude in degrees on a body.
`centre_y`	number	`0.0`			Centre of the grid along y in surface coordinates; the latitude in degrees on a body.

Every key with its default

{
    "type": "crater_list",
    "path": "",
    "format": "csv",
    "region": null,
    "spacing": null
}

Used in: example_ages_fresh, example_ages_steady_state, example_ages_uniform, example_craters_catalog_and_map, example_craters_manual, example_craters_max_craters, example_craters_profile_complex, example_craters_secondaries and 11 more

`boulder_list`¶

Writes every boulder the layers placed, models and relief alike, as CSV or JSON.

Key	Type	Default	Range	Unit	Description
`path`	string	`""`			File to write; relative paths resolve against the output folder (the CLI's --output-dir), else the configuration's folder.
`format`	one of `csv`, `json`	`"csv"`			Format of the file; when not given, .json paths are written as JSON and others as CSV.
`spacing`	number, optional	`null`	(0, inf)	m	Sample spacing in metres the features are listed at, as a heightmap of that pixel size applies them; unset for the region's pixel size. A whole-body list needs it.

region: Grid of square cells the features are listed over; unset for the base's grid, or without a base the whole body on a body.

Key	Type	Default	Range	Unit	Description
`width`	integer	`513`	[2, 65536]		Columns of the grid.
`height`	integer	`513`	[2, 65536]		Rows of the grid.
`pixel_size`	number	`2.0`	(0, inf)	m	Cell size in metres; on a body, metres along a meridian, the same in degrees of longitude.
`centre_x`	number	`0.0`			Centre of the grid along x in surface coordinates; the longitude in degrees on a body.
`centre_y`	number	`0.0`			Centre of the grid along y in surface coordinates; the latitude in degrees on a body.

Every key with its default

{
    "type": "boulder_list",
    "path": "",
    "format": "csv",
    "region": null,
    "spacing": null
}

Used in: example_boulders_buried, example_boulders_ejecta, example_boulders_exposure, example_boulders_fragments, example_boulders_layer, example_boulders_max_slope, example_boulders_models, example_boulders_patches and 8 more

`boulder_models`¶

Writes the boulders placed as 3D models on the ground: as a glTF scene (.glb, or .gltf with a .bin) drawing each shape once per boulder, as OBJ (.obj with an .mtl) with one object per boulder, or as one merged STL mesh (.stl).

Key	Type	Default	Range	Unit	Description
`path`	string	`""`			File to write, ending in .glb, .gltf, .obj or .stl; relative paths resolve against the output folder (the CLI's --output-dir), else the configuration's folder.
`crease_angle`	number	`60.0`	[0, 180]	deg	Angle in degrees, from 0 to 180: vertices are split where faces meet at more than it, giving sharp edges.
`instanced`	boolean	`true`			Writes each shared shape once and draws it per boulder (glTF instances, OBJ objects); false writes every boulder as its own placed mesh, for tools without instancing.
`spacing`	number, optional	`null`	(0, inf)	m	Sample spacing in metres the features are listed at, as a heightmap of that pixel size applies them; unset for the region's pixel size. A whole-body list needs it.

region: Grid of square cells the features are listed over; unset for the base's grid, or without a base the whole body on a body.

Key	Type	Default	Range	Unit	Description
`width`	integer	`513`	[2, 65536]		Columns of the grid.
`height`	integer	`513`	[2, 65536]		Rows of the grid.
`pixel_size`	number	`2.0`	(0, inf)	m	Cell size in metres; on a body, metres along a meridian, the same in degrees of longitude.
`centre_x`	number	`0.0`			Centre of the grid along x in surface coordinates; the longitude in degrees on a body.
`centre_y`	number	`0.0`			Centre of the grid along y in surface coordinates; the latitude in degrees on a body.

Every key with its default

{
    "type": "boulder_models",
    "path": "",
    "crease_angle": 60.0,
    "instanced": true,
    "region": null,
    "spacing": null
}

Used in: example_boulders_fragments, example_boulders_models, example_boulders_scene, example_boulders_shapes

`albedo`¶

Writes the albedo as a float32 GeoTIFF of one band or three (red, green, blue).

Key	Type	Default	Range	Unit	Description
`path`	string	`""`			GeoTIFF file to write; relative paths resolve against the output folder (the CLI's --output-dir), else the configuration's folder.
`compression`	one of `none`, `lzw`, `deflate`, `packbits`	`"lzw"`			Compression of the file; compressed files use the floating-point predictor.
`tile_size`	integer	`256`	[16, inf)	px	Width and height of the file's tiles in pixels; a positive multiple of 16.

region: Grid of square cells the file covers; unset for the base's grid.

Key	Type	Default	Range	Unit	Description
`width`	integer	`513`	[2, 65536]		Columns of the grid.
`height`	integer	`513`	[2, 65536]		Rows of the grid.
`pixel_size`	number	`2.0`	(0, inf)	m	Cell size in metres; on a body, metres along a meridian, the same in degrees of longitude.
`centre_x`	number	`0.0`			Centre of the grid along x in surface coordinates; the longitude in degrees on a body.
`centre_y`	number	`0.0`			Centre of the grid along y in surface coordinates; the latitude in degrees on a body.

Every key with its default

{
    "type": "albedo",
    "path": "",
    "region": null,
    "compression": "lzw",
    "tile_size": 256
}

Used in: example_albedo_blast_zone, example_albedo_crater_rays, example_albedo_fresh_crater, example_albedo_moon_site, example_albedo_new_crater, example_albedo_oblique_rays, example_albedo_rgb, example_albedo_rocks_and_slopes and 2 more

`mesh`¶

Writes the whole body, from six cube faces: a mesh as glTF (.glb or .gltf), OBJ (.obj) or STL (.stl), or a Gaskell ICQ shape model in kilometres (.icq), whose Q is cells_per_face.

Key	Type	Default	Range	Unit	Description
`path`	string	`""`			File to write, ending in .glb, .gltf, .obj, .stl or .icq; relative paths resolve against the output folder (the CLI's --output-dir), else the configuration's folder.
`cells_per_face`	integer	`128`	[1, 4096]		Quads along each edge of the six cube faces, 1 to 4096; more give a finer mesh, with two triangles per quad.
`spacing`	number, optional	`null`	(0, inf)	m	Sample spacing in metres the heights are evaluated at, which sets the finest features kept; unset uses a quad's side at a face's centre.

Every key with its default

{
    "type": "mesh",
    "path": "",
    "cells_per_face": 128,
    "spacing": null
}

Used in: example_planets_asteroid_body_mesh, example_planets_moon_body_mesh

`terrain_mesh`¶

Writes the generated heights as a triangle mesh, a vertex per cell with data, as glTF (.glb or .gltf), OBJ (.obj) or STL (.stl), in the frame boulder models are written in.

Key	Type	Default	Range	Unit	Description
`path`	string	`""`			File to write, ending in .glb, .gltf, .obj or .stl; relative paths resolve against the output folder (the CLI's --output-dir), else the configuration's folder.

region: Grid of square cells the mesh covers; unset for the base's grid.

Key	Type	Default	Range	Unit	Description
`width`	integer	`513`	[2, 65536]		Columns of the grid.
`height`	integer	`513`	[2, 65536]		Rows of the grid.
`pixel_size`	number	`2.0`	(0, inf)	m	Cell size in metres; on a body, metres along a meridian, the same in degrees of longitude.
`centre_x`	number	`0.0`			Centre of the grid along x in surface coordinates; the longitude in degrees on a body.
`centre_y`	number	`0.0`			Centre of the grid along y in surface coordinates; the latitude in degrees on a body.

Every key with its default

{
    "type": "terrain_mesh",
    "path": "",
    "region": null
}

Used in: example_boulders_scene

`materials`¶

Writes the material map as a float32 GeoTIFF of five bands: the share of soil, sand, dust, bedrock and rock at each cell.

Key	Type	Default	Range	Unit	Description
`path`	string	`""`			GeoTIFF file to write; relative paths resolve against the output folder (the CLI's --output-dir), else the configuration's folder.
`compression`	one of `none`, `lzw`, `deflate`, `packbits`	`"lzw"`			Compression of the file; compressed files use the floating-point predictor.
`tile_size`	integer	`256`	[16, inf)	px	Width and height of the file's tiles in pixels; a positive multiple of 16.

region: Grid of square cells the file covers; unset for the base's grid.

Key	Type	Default	Range	Unit	Description
`width`	integer	`513`	[2, 65536]		Columns of the grid.
`height`	integer	`513`	[2, 65536]		Rows of the grid.
`pixel_size`	number	`2.0`	(0, inf)	m	Cell size in metres; on a body, metres along a meridian, the same in degrees of longitude.
`centre_x`	number	`0.0`			Centre of the grid along x in surface coordinates; the longitude in degrees on a body.
`centre_y`	number	`0.0`			Centre of the grid along y in surface coordinates; the latitude in degrees on a body.

Every key with its default

{
    "type": "materials",
    "path": "",
    "region": null,
    "compression": "lzw",
    "tile_size": 256
}

Used in: example_planets_mars_pavement, example_planets_mars_sand_fill, example_planets_mars_sand_shadows, example_planets_mars_strata, example_planets_mars_ventifacts

`photometry`¶

Writes the Hapke parameters the materials mix to as a float32 GeoTIFF of four bands: single-scattering albedo, b, c and roughness in degrees.

Key	Type	Default	Range	Unit	Description
`path`	string	`""`			GeoTIFF file to write; relative paths resolve against the output folder (the CLI's --output-dir), else the configuration's folder.
`compression`	one of `none`, `lzw`, `deflate`, `packbits`	`"lzw"`			Compression of the file; compressed files use the floating-point predictor.
`tile_size`	integer	`256`	[16, inf)	px	Width and height of the file's tiles in pixels; a positive multiple of 16.

region: Grid of square cells the file covers; unset for the base's grid.

Key	Type	Default	Range	Unit	Description
`width`	integer	`513`	[2, 65536]		Columns of the grid.
`height`	integer	`513`	[2, 65536]		Rows of the grid.
`pixel_size`	number	`2.0`	(0, inf)	m	Cell size in metres; on a body, metres along a meridian, the same in degrees of longitude.
`centre_x`	number	`0.0`			Centre of the grid along x in surface coordinates; the longitude in degrees on a body.
`centre_y`	number	`0.0`			Centre of the grid along y in surface coordinates; the latitude in degrees on a body.

Every key with its default

{
    "type": "photometry",
    "path": "",
    "region": null,
    "compression": "lzw",
    "tile_size": 256
}

Used in: example_planets_mars_pavement, example_planets_mars_sand_fill, example_planets_mars_sand_shadows, example_planets_mars_strata

Outputs¶

heightmap¶

crater_list¶

boulder_list¶

boulder_models¶

albedo¶

mesh¶

terrain_mesh¶

materials¶

photometry¶

`heightmap`¶

`crater_list`¶

`boulder_list`¶

`boulder_models`¶

`albedo`¶

`mesh`¶

`terrain_mesh`¶

`materials`¶

`photometry`¶