honeybee_plus.radiance.parameters.gendaymtx module

Radiance raytracing Parameters.

class honeybee_plus.radiance.parameters.gendaymtx.GendaymtxParameters(*args, **kwargs)

Bases: honeybee_plus.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

Radiance Parameters for grid based analysis.

Read more: https://www.radiance-online.org/learning/documentation/manual-pages/pdfs/gendaymtx.pdf

verbose_report

[-v] A boolean to indicate verbose reporting (Default: True)

remove_header

[-h] A boolean to disable header (Default: False)

only_direct

[-d] A boolean to only generate sun-only matrix (Default: False)

only_sky

[-s] A boolean to only generate sky matrix with no direct sun (Default: False)

rotation

[-r deg] A floating number in degrees that indicates zenith rotation (Default: 0)

sky_density

[-m N] An integer to indicate number of sky patches. Default value of 1 generates 146 sky pacthes.

ground_color

[-g r g b] A tuple of r, g, b values to indicate ground color (Default: 0.2 0.2 0.2)

sky_color

[-c r g b] A tuple of r, g, b values to indicate sky color (Default: 0.960, 1.004, 1.118)

output_format

[-o{f|d}] An integer to indicate binary output format. 0 is double output [d] and 1 is binary float numbers (f). If you’re running Radiance on Windows do not use this option. (Default: None)

output_type

[-O{0|1}] An integr specifies output type. 0 generates the values for visible radiance whereas 1 indicates the results should be total solar radiance.

\* 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 gmtx = GendaymtxParameters()

# check the current values print(gmtx.to_rad_string()) > -v -r 0 -m 1 -of

# ask only for direct sun gmtx.only_direct = True

# check the new values. -d is added. print(gmtx.to_rad_string()) > -v -d -r 0 -m 1 -of

freeze()

ground_color

[-g r g b] A tuple of r, g, b values to indicate ground color (Default: 0.2 0.2 0.2)

only_direct

False)

Type

[-d] A boolean to only generate sun-only matrix (Default

only_sky

[-s] A boolean to only generate sky matrix with no direct sun (Default: False)

output_format

[-o{f|d}] An integer to indicate binary output format. 0 is double output [d] and 1 is binary float numbers (f). If you’re running Radiance on Windows do not use this option. (Default: None)

output_type

[-O{0|1}] An integr specifies output type. 0 generates the values for visible radiance whereas 1 indicates the results should be total solar radiance.

remove_header

False)

Type

[-h] A boolean to disable header (Default

rotation

[-r deg] A floating number in degrees that indicates zenith rotation (Default: 0)

sky_color

[-c r g b] A tuple of r, g, b values to indicate sky color (Default: 0.960, 1.004, 1.118)

sky_density

[-m N] An integer to indicate number of sky patches. Default value of 1 generates 146 sky pacthes.

unfreeze()

verbose_report

True)

Type

[-v] A boolean to indicate verbose reporting (Default