xopto.dataset.render.common module¶

PROBE_REFLECTIVITY(wavelength)¶

RI_AIR(wavelength)¶

prepare_cli(description: str) → argparse.ArgumentParser[source]¶

Prepare argument parser for the rendering calls.

Parameters: description (str) – Description for the command line interface.
Returns: parser
Return type: argparse.ArgumentParser

Note

Command line argument parser instance implements the following arguments:

verbose: bool Turns on verbose mode.

test: bool
Run in test mode.

method: str
Monte Carlo stepping method.

cache: bool
Enables fluence accumulator cache.

output_dir: str
Root directory of the dataset.

cl_device: str
OpenCL device name to use.

cl_index: int
OpenCL device index (zero-based).

fast_math:
Adds common performace-related OpenCL build options -cl-fast-relaxed-math and –cl-mad-enable.

cl-fast-relaxed-math: None
Adds OpenCL build option -cl-fast-relaxed-math.

cl-mad-enable: None
Adds OpenCL build option -cl-mad-enable.

cl-unsafe-math-optimizations: None
Adds OpenCL build option -cl-unsafe-math-optimizations.

cl-finite-math-only: None
Adds OpenCL build option -cl-finite-math-only.

cl-no-signed-zeros: None
Adds OpenCL build option -cl-no-signed-zeros.

process_cli(parser: argparse.ArgumentParser) → dict[source]¶

Process the ArgumentParser instance created with prepare_cli().

Parameters: parser (argparse.ArgumentParser) – Argument parser as returned by the prepare_ci() function.
Returns: kwargs – Keyword arguments from the command line interface as a dict.
Return type: dict

Note

The command line implements the following keyword arguments:

verbose: bool
Turns on verbose mode.

test: bool
Run in test mode.

output_dir: str
Root directory of the dataset.

method: str
Monte Carlo stepping method.

cache: bool
Enables fluence accumulator cache.

cl_device: str
OpenCL device name to use.

cl_index: int
OpenCL device index (zero-based).

cl_build_options: List[str]
A list of OpenCL build options. See ClBuildOption for more details.