honeybee_radiance_command.options.oconv module

Oconv parameters.

class honeybee_radiance_command.options.oconv.OconvOptions

Bases: OptionCollection

[ -i octree | -b xmin ymin zmin size ][ -n objlim ][ -r maxres ][ -f ][ -w ]

Also see: https://floyd.lbl.gov/radiance/man_html/oconv.1.html

to_file(folder, file_name, mkdir=False)

Write options to a file.

to_radiance()

Translate options to Radiance format.

update_from_string(string)

Update options from a standard radiance string.

If the option is not currently part of the collection, it will be added to additional_options.

additional_options

property b

Scene bounding cube.

The -b option allows the user to give a bounding cube for the scene, starting at xmin ymin zmin and having a side length size. If the cube does not contain all of the surfaces, an error results.

The -b and -i options are mutually exclusive.

property command

Command name.

property f

Frozen octree switch.

The -f option produces a frozen octree containing all the scene information. Normally, only a reference to the scene files is stored in the octree, and changes to those files may invalidate the result. The freeze option is useful when the octree file’s integrity and loading speed is more important than its size, or when the octree is to be relocated to another directory, and is especially useful for creating library objects for the “instance” primitive type. If the input octree is frozen, the output will be also.

property i

Input octree.

property n

Maximum surface set size for each voxel.

The -n option specifies the maximum surface set size for each voxel. Larger numbers result in quicker octree generation, but potentially slower rendering. Smaller values may or may not produce faster renderings, since the default number (6) is close to optimal for most scenes.

property options

Print out list of options.

property r

The -r option specifies the maximum octree resolution. This should be greater than or equal to the ratio of the largest and smallest dimensions in the scene (ie. surface size or distance between surfaces). The default is 16384.

Type:

Maximum octree resolution - default

property slots

Return slots including the ones from the baseclass if any.

property w

on

Type:

Warning messages - default