ns-export

usage: ns-export [-h] {pointcloud,tsdf,poisson,marching-cubes,cameras}

subcommands

{pointcloud,tsdf,poisson,marching-cubes,cameras}

Possible choices: pointcloud, tsdf, poisson, marching-cubes, cameras

Sub-commands:

pointcloud

Export NeRF as a point cloud.

ns-export pointcloud [-h] --load-config PATH --output-dir PATH
                     [--num-points INT] [--remove-outliers {True,False}]
                     [--estimate-normals {True,False}]
                     [--depth-output-name STR] [--rgb-output-name STR]
                     [--use-bounding-box {True,False}]
                     [--bounding-box-min FLOAT FLOAT FLOAT]
                     [--bounding-box-max FLOAT FLOAT FLOAT]
                     [--num-rays-per-batch INT] [--std-ratio FLOAT]

arguments

--load-config

Path to the config YAML file. (required)

--output-dir

Path to the output directory. (required)

--num-points

Number of points to generate. May result in less if outlier removal is used. (default: 1000000)

--remove-outliers

Possible choices: True, False

Remove outliers from the point cloud. (default: True)

--estimate-normals

Possible choices: True, False

Estimate normals for the point cloud. (default: False)

--depth-output-name

Name of the depth output. (default: depth)

--rgb-output-name

Name of the RGB output. (default: rgb)

--use-bounding-box

Possible choices: True, False

Only query points within the bounding box (default: True)

--bounding-box-min

Minimum of the bounding box, used if use_bounding_box is True. (default: -1 -1 -1)

--bounding-box-max

Maximum of the bounding box, used if use_bounding_box is True. (default: 1 1 1)

--num-rays-per-batch

Number of rays to evaluate per batch. Decrease if you run out of memory. (default: 32768)

--std-ratio

Threshold based on STD of the average distances across the point cloud to remove outliers. (default: 10.0)

tsdf

Export a mesh using TSDF processing.

ns-export tsdf [-h] --load-config PATH --output-dir PATH
               [--downscale-factor INT] [--depth-output-name STR]
               [--rgb-output-name STR] [--resolution INT|{INT [INT ...]}]
               [--batch-size INT] [--use-bounding-box {True,False}]
               [--bounding-box-min FLOAT FLOAT FLOAT]
               [--bounding-box-max FLOAT FLOAT FLOAT]
               [--texture-method {tsdf,nerf}] [--px-per-uv-triangle INT]
               [--unwrap-method {xatlas,custom}] [--num-pixels-per-side INT]
               [--target-num-faces {None}|INT]

arguments

--load-config

Path to the config YAML file. (required)

--output-dir

Path to the output directory. (required)

--downscale-factor

Downscale the images starting from the resolution used for training. (default: 2)

--depth-output-name

Name of the depth output. (default: depth)

--rgb-output-name

Name of the RGB output. (default: rgb)

--resolution

Resolution of the TSDF volume or [x, y, z] resolutions individually. (default: 128 128 128)

--batch-size

How many depth images to integrate per batch. (default: 10)

--use-bounding-box

Possible choices: True, False

Whether to use a bounding box for the TSDF volume. (default: True)

--bounding-box-min

Minimum of the bounding box, used if use_bounding_box is True. (default: -1 -1 -1)

--bounding-box-max

Minimum of the bounding box, used if use_bounding_box is True. (default: 1 1 1)

--texture-method

Possible choices: tsdf, nerf

Method to texture the mesh with. Either ‘tsdf’ or ‘nerf’. (default: nerf)

--px-per-uv-triangle

Number of pixels per UV triangle. (default: 4)

--unwrap-method

Possible choices: xatlas, custom

The method to use for unwrapping the mesh. (default: xatlas)

--num-pixels-per-side

If using xatlas for unwrapping, the pixels per side of the texture image. (default: 2048)

--target-num-faces

Target number of faces for the mesh to texture. (default: 50000)

poisson

Export a mesh using poisson surface reconstruction.

ns-export poisson [-h] --load-config PATH --output-dir PATH [--num-points INT]
                  [--remove-outliers {True,False}] [--depth-output-name STR]
                  [--rgb-output-name STR]
                  [--normal-method {open3d,model_output}]
                  [--normal-output-name STR] [--save-point-cloud {True,False}]
                  [--use-bounding-box {True,False}]
                  [--bounding-box-min FLOAT FLOAT FLOAT]
                  [--bounding-box-max FLOAT FLOAT FLOAT]
                  [--num-rays-per-batch INT]
                  [--texture-method {point_cloud,nerf}]
                  [--px-per-uv-triangle INT] [--unwrap-method {xatlas,custom}]
                  [--num-pixels-per-side INT] [--target-num-faces {None}|INT]
                  [--std-ratio FLOAT]

arguments

--load-config

Path to the config YAML file. (required)

--output-dir

Path to the output directory. (required)

--num-points

Number of points to generate. May result in less if outlier removal is used. (default: 1000000)

--remove-outliers

Possible choices: True, False

Remove outliers from the point cloud. (default: True)

--depth-output-name

Name of the depth output. (default: depth)

--rgb-output-name

Name of the RGB output. (default: rgb)

--normal-method

Possible choices: open3d, model_output

Method to estimate normals with. (default: model_output)

--normal-output-name

Name of the normal output. (default: normals)

--save-point-cloud

Possible choices: True, False

Whether to save the point cloud. (default: False)

--use-bounding-box

Possible choices: True, False

Only query points within the bounding box (default: True)

--bounding-box-min

Minimum of the bounding box, used if use_bounding_box is True. (default: -1 -1 -1)

--bounding-box-max

Minimum of the bounding box, used if use_bounding_box is True. (default: 1 1 1)

--num-rays-per-batch

Number of rays to evaluate per batch. Decrease if you run out of memory. (default: 32768)

--texture-method

Possible choices: point_cloud, nerf

Method to texture the mesh with. Either ‘point_cloud’ or ‘nerf’. (default: nerf)

--px-per-uv-triangle

Number of pixels per UV triangle. (default: 4)

--unwrap-method

Possible choices: xatlas, custom

The method to use for unwrapping the mesh. (default: xatlas)

--num-pixels-per-side

If using xatlas for unwrapping, the pixels per side of the texture image. (default: 2048)

--target-num-faces

Target number of faces for the mesh to texture. (default: 50000)

--std-ratio

Threshold based on STD of the average distances across the point cloud to remove outliers. (default: 10.0)

marching-cubes

NOT YET IMPLEMENTED Export a mesh using marching cubes.

ns-export marching-cubes [-h] --load-config PATH --output-dir PATH

arguments

--load-config

Path to the config YAML file. (required)

--output-dir

Path to the output directory. (required)

cameras

Export camera poses to a .json file.

ns-export cameras [-h] --load-config PATH --output-dir PATH

arguments

--load-config

Path to the config YAML file. (required)

--output-dir

Path to the output directory. (required)