rpict

honeybee-radiance rpict

Commands to run rpict in Radiance.

honeybee-radiance rpict [OPTIONS] COMMAND [ARGS]...

rpict

Run rpict command for an input octree and a view file.

Note that, if an ambient cache file (.amb) is found next to the view file, and it is determined to be valid (with a non-zero size) it will be automatically used within the rpict command.

Args:

octree: Path to octree file.

view: Path to view file.

honeybee-radiance rpict rpict [OPTIONS] OCTREE VIEW

Options

--rad-params <rad_params>

Radiance parameters.

--rad-params-locked <rad_params_locked>

Protected Radiance parameters. These values will overwrite user input rad parameters.

-m, --metric <metric>

Text for the type of metric to be output from the calculation. Choose from: illuminance, irradiance, luminance, radiance.

Default:

'luminance'

-r, --resolution <resolution>

An integer for the maximum dimension of the image in pixels (either width/height depending on the input view angle and type). This will overwrite the -x and -y option in any input radiance parameters if specified. The default value for Radiance is 512 pixels.

-s, --scale-factor <scale_factor>

A number that will be multiplied by the input resolution to scale the dimensions of the output image. This is useful in workflows if one plans to re-scale the image after the ray tracing calculation to improve anti-aliasing.

Default:

1

-o, --output <output>

Path to output file. If a relative path is provided it should be relative to project folder.

--dry-run

A flag to show the command without running it.

Default:

False

Arguments

OCTREE

Required argument

VIEW

Required argument