honeybee_plus.radiance.parameters.rcontrib module¶

Radiance rcontrib Parameters.

class honeybee_plus.radiance.parameters.rcontrib.RcontribParameters(*args, **kwargs)[source]¶

Bases: honeybee_plus.radiance.parameters.rtrace.RtraceParameters

Radiance Parameters for rcontrib command including rtrace parameters.

mod_file¶: [-M file] File path to a file with a list of modifiers (Default: None)

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

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

Usage:

# generate sky matrix with default values rcp = RcontribParameters()

# paramters returns an empty string which means rcontrib will use # default values. print(rcp.to_rad_string()) >

# add modifiers file rcp.mod_file = “c:/ladybug/suns.txt”

# set number of ambient bounces and ambient divisions # these are rtrace (gridbased) paramters rcp.ab = 0 rcp.ad = 10000 rcp.I = True

# check radiance parameters with the new values print(rcp.to_rad_string()) > -ab 0 -ad 10000 -M c:/ladybug/suns.txt -I

# or you can set all the parameter for rtrace based on quality rcp.quality = 1 print(rcp.to_rad_string()) > -aa 0.2 -ab 0 -ad 10000 -M c:/ladybug/suns.txt -I -dc 0.5 -st 0.5 -lw 0.01

-as 2048 -ar 64 -lr 6 -dt 0.25 -dr 1 -ds 0.25 -dp 256

adjust_limit_weight()[source]¶: Adjust lw to be 1/ad if the value is larger than 1/ad.

classmethod direct_studies(mod_file=None, x=None, y=None, output_filename_format=None)[source]¶

Rcontrib parameters for direct studies.

In particular this classmethod will set parameters below:: irradiance_calc (-I) = True ambient_bounces (-ab) = 0 direct_certainty (-dc) = 1 direct_threshold (-dt) = 0 direct_jitter (-dj) = 0 direct_sec_relays (-dr) = 0

freeze()¶

mod_file¶: [-M file] File path to a file with a list of modifiers (Default: None)

output_filename_format¶: [-0 str] output format e.g. %04f.hdr.

unfreeze()¶

x_dimension¶: [-x int] X dimension of an image.

y_dimension¶: [-y int] Y dimension of an image or number of total points in points file.