honeybee_plus.radiance.parameters.oconv module¶

Radiance oconv Parameters.

class honeybee_plus.radiance.parameters.oconv.OconvParameters(*args, **kwargs)[source]¶

Bases: honeybee_plus.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

Radiance Parameters for rcontrib command including rtrace parameters.

frozen¶: [-f] A Boolean to produce “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. (default: True)

resolution¶: [-r] An integer that “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)” (default:16384)

max_set_size¶: [-n] An integer that “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 (Default: 6).

turn_off_warns¶: [-w] A Boolean to suppress warnings (Default: False).

\* For the full list of attributes try self.parameters

\*\* values between []'s indicate Radiance equivalent keys for advanced users

Usage:

# generate default oconv parameters ocvp = OconvParameters()

# default values. print ocvp.to_rad_string() > -f

# add modifiers file ocvp.turn_off_warns = True

# check radiance parameters with the new values print ocvp.to_rad_string() > -f -w

freeze()¶

frozen¶: [-f] A Boolean to produce “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. (default: True)

max_set_size¶: [-n] An integer that “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 (Default: 6).

resolution¶: [-r] An integer that “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)” (default:16384)

turn_off_warns¶

False).

Type: [-w] A Boolean to suppress warnings (Default

unfreeze()¶