honeybee.radiance.parameters package

Submodules

honeybee.radiance.parameters.dctimestep module

class honeybee.radiance.parameters.dctimestep.DctimestepParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

freeze()

unfreeze()

honeybee.radiance.parameters.falsecolor module

class honeybee.radiance.parameters.falsecolor.FalsecolorParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

contour_bands = None

-cb

The -cb option produces contour bands instead of lines, where the thickness of the bands is related to the rate of change in the image.

contour_lines = None

-cl

If contour lines are desired rather than just false color, the -cl option can be used. These lines can be placed over another Radiance picture using the -p option.

contour_quant = None

-n

The -n option can be used to change the number of contours (and corresponding legend entries) from the default value of 8.

freeze()

label = None

-l label

A legend is produced for the new image with a label given by the -l option. The default label is “Nits”, which is appropriate for standard Radiance images.

legend_height = None

The -lw and -lh options may be used to change the legend dimensions from the default width and height of 100x200. A value of zero in either eliminates the legend in the output.

legend_width = None

The -lw and -lh options may be used to change the legend dimensions from the default width and height of 100x200. A value of zero in either eliminates the legend in the output.

log = None

-log For a logarithmic rather than a linear mapping, the -log option can be used, where decades is the number of decades below the maximum scale desired.

multiplier = None

The default multiplier is 179, which converts from radiance or irradiance to luminance or illuminance, respectively. A different multiplier can be given with -m to get daylight factors or whatever.

palette = None

The -pal option provides different color palettes for falsecolor. The current choices are spec for the old spectral mapping, hot for a thermal scale, and pm3d for a variation of the default mapping, def.

pic_for_contours = None

-p picture

Contour lines can be placed over another Radiance picture using the -p option.

print_extrema_points = None

-e

The -e option causes extrema points to be printed on the brightest and darkest pixels of the input picture.

scale = None

-s scale

A different scale can be given with the -s option. If the argument given to -s begins with an “a” for “auto,” then the maximum is used for scaling the result. The default multiplier is 179, which converts from radiance or irradiance to luminance or illuminance, respectively.

unfreeze()

honeybee.radiance.parameters.genBsdf module

Radiance rcontrib Parameters.

class honeybee.radiance.parameters.genBsdf.GenbsdfParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

freeze()

geom_unit_excl = None

Exclude geometry in ouput. The accepted inputs for this option are one from (‘meter’,’foot’,’inch’,’centimeter’,’millimeter’)

geom_unit_incl = None

Include geometry in ouput. The accepted inputs for this option are one from (‘meter’,’foot’,’inch’,’centimeter’,’millimeter’)

to_rad_string()

unfreeze()

honeybee.radiance.parameters.gendaylit module

class honeybee.radiance.parameters.gendaylit.GendaylitParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

Gendaylit parameters.

Read more:

http://radsite.lbl.gov/radiance/man_html/gensky.1.html

altitude_azimuth

[-ang] A tuple corresponding to altitude and azimuth angle.This input can be used instead of specifying the monthDayTime.

ground_reflect

[-g rfl] A float number to indicate ground reflectance.

latitude

[-a lat] A float number to indicate site altitude. Negative angle indicates south latitude.

longitude

[-o lon] A float number to indicate site latitude. Negative angle indicates east longitude.

meridian

[-m mer] A float number to indicate site meridian west of

Greenwich.

* For the full list of attributes try self.keys

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

Usage:

altitude_azimuth = None

[-ang] A tuple corresponding to altitude and azimuth angle.This input can be used instead of specifying the monthDayTime.

dir_horz_dif_horz_illum = None

Direct normal luminance and diffuse horizontal illuminance

dir_horz_dif_horz_irrad = None

Direct-horizontal irradiance and diffuse-horizontal irradiance in W/m^2

dir_norm_dif_horz_irrad = None

Direct-normal irradiance and diffuse-horizontal irradiance in W/m^2

freeze()

glob_horz_irrad = None

Global horizontal irradiance

ground_reflect = None

[-g rfl] A float number to indicate ground reflectance

latitude = None

[-a lat] A float number to indicate site altitude. Negative angle indicates south latitude.

longitude = None

[-o lon] A float number to indicate site latitude. Negative angle indicates east longitude.

meridian = None

[-m mer] A float number to indicate site meridian west of Greenwich.

output_type = None

Specify 0 for visible radiation, 1 for solar radiation and 2 for luminance

perez_parameters = None

Perez parameters corresponding to epsilon and delta values.

suppress_sun = None

Prevent the solar disc from being in the output.

suppress_warnings = None

Suppress warning messages.

time_interval = None

…

to_rad_string()

Generate Radiance string for gendaylit.

unfreeze()

honeybee.radiance.parameters.gendaymtx module

Radiance raytracing Parameters.

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

Bases: honeybee.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 = None

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

only_direct = None

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

only_sky = None

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

output_format = None

[-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 = None

[-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 = None

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

rotation = None

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

sky_color = None

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

sky_density = None

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

unfreeze()

verbose_report = None

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

honeybee.radiance.parameters.gensky module

class honeybee.radiance.parameters.gensky.GenskyParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

Gensky parameters.

Read more:

http://radsite.lbl.gov/radiance/man_html/gensky.1.html

altitude_azimuth

[-ang] A tuple corresponding to altitude and azimuth angle.This input can be used instead of specifying the monthDayTime.

sunny_sky

[-s|+s] A boolean value to generate sunny sky with or without sun. Set to True to generate a sunnny sky with sun, Fasle to generate a sunny sky without sun (Default: None)

cloudy_sky

[-c] A boolean value to generate cloudy sky

interm_sky

[-i|+i] A boolean value to generate intermediate sky with or without sun. Set to True to generate an intermediate sky with sun, Fasle to generate a intermediate sky without sun (Default: None)

uniform_cloudy_sky

[-u] A boolean value to generate Uniform cloudy sky.

ground_reflect

[-g rfl] A float number to indicate ground reflectance.

zenith_bright

[-b brt] A float number to indicate zenith brightness in watts/steradian/meter-sq.

zenith_bright_horz_diff

[-B irrad] A float number to indicate zenith brightness from horizontal diffuse irradiance in watts/meter-sq.

solar_rad

[-r rad] A float number to indicate solar radiance in

watts/steradians/meter-sq.

solar_rad_horz_diff

[-R irrad] A float number to indicate solar radiance from horizontal direct irradiance in watts/meter-sq.

turbidity

[-t trb] A float number to indicate turbidity.

latitude

[-a lat] A float number to indicate site altitude. Negative angle indicates south latitude.

longitude

[-o lon] A float number to indicate site latitude. Negative angle indicates east longitude.

meridian

[-m mer] A float number to indicate site meridian west of

Greenwich.

* For the full list of attributes try self.keys

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

Usage:

# generate sky matrix with default values gnskyparam = GenskyParameters()

# check the current values print(gnskyparam.to_rad_string()) > -g 0.5

# set altitude and azimuth angle values gnsky.altitude_azimuth = (12,31)

#check the new values added. print(gnskyparam.to_rad_string()) > -g 0.5 -ang 12.0 31.0

altitude_azimuth = None

[-ang] A tuple corresponding to altitude and azimuth angle.This input can be used instead of specifying the monthDayTime.

cloudy_sky = None

[-c] A boolean value to generate cloudy sky

freeze()

ground_reflect = None

[-g rfl] A float number to indicate ground reflectance

interm_sky = None

[-i|+i] A boolean value to generate intermediate sky with or without sun. Set to True to generate an intermediate sky with sun, Fasle to generate a intermediate sky without sun (Default: None)

latitude = None

[-a lat] A float number to indicate site altitude. Negative angle indicates south latitude.

longitude = None

[-o lon] A float number to indicate site latitude. Negative angle indicates east longitude.

meridian = None

[-m mer] A float number to indicate site meridian west of Greenwich.

solar_rad = None

[-r rad] A float number to indicate solar radiance in watts/steradians/meter-sq.

solar_rad_horz_diff = None

[-R irrad] A float number to indicate solar radiance from horizontal direct irradiance in watts/meter-sq.

sunny_sky = None

[-s|+s] A boolean value to generate sunny sky with or without sun. Set to True to generate a sunnny sky with sun, Fasle to generate a sunny sky without sun (Default: None)

turbidity = None

[-t trb] A float number to indicate turbidity.

unfreeze()

uniform_cloudy_sky = None

[-u] A boolean value to generate Uniform cloudy sky.

zenith_bright = None

[-b brt] A float number to indicate zenith brightness in watts/steradian/meter-sq.

zenith_bright_horz_diff = None

[-B irrad] A float number to indicate zenith brightness from horizontal diffuse irradiance in watts/meter-sq.

honeybee.radiance.parameters.mkpmap module

class honeybee.radiance.parameters.mkpmap.MkpmapParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

freeze()

unfreeze()

honeybee.radiance.parameters.oconv module

Radiance oconv Parameters.

class honeybee.radiance.parameters.oconv.OconvParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

Radiance Parameters for rcontrib command including rtrace parameters.

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

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 = None

[-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 = None

[-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 = None

[-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 = None

[-w] A Boolean to suppress warnings (Default – False).

unfreeze()

honeybee.radiance.parameters.pcomb module

class honeybee.radiance.parameters.pcomb.PcombParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

freeze()

unfreeze()

honeybee.radiance.parameters.raBmp module

class honeybee.radiance.parameters.raBmp.RaBmpParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

create_grayscale = None

Create an eight bit grayscale image instead of a color image.

crt_primaries = None

CRT color output primaries.

exposure = None

Specify tonemapping method or exposure value. Accepted tone mapping methods are ‘auto’, ‘human’ or ‘linear. Accepted exposure values are any number prefixed with a + or - sign (e.g. -1.2, +1.4, -3.4 etc).

freeze()

gamma = None

Gamma correction for the monitor. Default value is 2.2

reverse_conversion = None

Do a reverse conversion and convert bitmap to hdr

unfreeze()

honeybee.radiance.parameters.raTiff module

class honeybee.radiance.parameters.raTiff.RaTiffParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

compression_type = None

Compression type for the output TIFF file. Accepted values are z,L,l,f and w for LZW,SIGLOG,SIGLOG24,IEEE-floating-point and 16bit formats respectively.

create_grayscale = None

Create an eight bit grayscale image instead of a color image.

exposure = None

Specify tonemapping method or exposure value. Accepted tone mapping methods are ‘auto’, ‘human’ or ‘linear. Accepted exposure values are any number prefixed with a + or - sign (e.g. -1.2, +1.4, -3.4 etc).

freeze()

gamma = None

Gamma correction for the monitor. Default value is 2.2

reverse_conversion = None

Do a reverse conversion and convert bitmap to hdr

unfreeze()

xyze_output_type = None

Create an xyzeOutput format file.

honeybee.radiance.parameters.rcalc module

Radiance rcalc parameters

class honeybee.radiance.parameters.rcalc.RcalcParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

freeze()

unfreeze()

honeybee.radiance.parameters.rcollate module

class honeybee.radiance.parameters.rcollate.RcollateParameters(remove_header=None, warnings_off=None, output_format=None, transpose=None, input_columns=None, output_columns=None, input_rows=None, output_rows=None)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

Radiance parameters for rcollate.

Note: As on Apr-10-2016, this class has been implemented to facilitate it’s use for 3-Phase and 5-Phase method calculations. Not all the possible options of rcollate have been added at present.

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

remove_header

[-h[io]] -hi turns input header off, -ho turns ouput header off. -h turns both off.

warnings_off

[-w] turn off non fatal warnings.

output_format

[-f[afdb[N]]. Specify an output format.

transpose

[-t] Transpose the matrix.

input_columns

[-ic col] Size of the columns of the input matrix.

output_columns

[-oc col] Size of the columns of the output matrix.

input_rows

[-ir row] Size of the rows of the input matrix.

output_rows

[-or row] Size of the rows of output matrix.

* For the full list of attributes try self.keys

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

Usage:

#Rearrange an input 10x10 matrix to 20x5 matrix. rcolparam = RcollateParameters()

rcolparam.input_columns = 10 rcolpara.input_rows = 10

rcolparam.output_rows = 20 rcolparam.output_columns = 5

#Check the values. print(rcolparam.to_rad_string()) > -ic 10 -ir 10 -oc 5 -or 20

input_columns = None

input_columns – [-ic col] Size of the columns of the input matrix.

input_rows = None

input_rows – [-ir row] Size of the rows of the input matrix.

output_columns = None

output_columns – [-oc col] Size of the columns of the output matrix.

output_format = None

output_format – [-f[afdb[N]]. Specify an output format.

output_rows = None

output_rows – [-or row] Size of the rows of output matrix.

remove_header = None

remove_header – [-h[io]] -hi turns input header off, -ho turns ouput header off. -h turns both off.

transpose = None

transpose – [-t] Transpose the matrix.

warnings_off = None

warnings_off – [-w] turn off non fatal warnings.

honeybee.radiance.parameters.rcontrib module

Radiance rcontrib Parameters.

class honeybee.radiance.parameters.rcontrib.RcontribParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters.rtrace.RtraceParameters

Radiance Parameters for rcontrib command including rtrace parameters.

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

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

freeze()

mod_file = None

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

output_filename_format = None

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

unfreeze()

x_dimension = None

[-x int] X dimension of an image.

y_dimension = None

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

honeybee.radiance.parameters.rfluxmtx module

Radiance rfluxmtx parameters.

class honeybee.radiance.parameters.rfluxmtx.RfluxmtxParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters.rtrace.RtraceParameters

Rfluxmtx parameters.

freeze()

sampling_rays_count = None

-c int Number of sampling ray counts.

unfreeze()

honeybee.radiance.parameters.rmtxop module

class honeybee.radiance.parameters.rmtxop.RmtxopParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

Radiance parameters for the command rmtxop.

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

verbose_reporting

[-v] Boolean option to print each operation to stdout.

output_format

[-f[a|c|d|f]] Format in which the output data should be written.

Usage:

#generate rmtxop with default parameters. rmtx = RmtxopParameters()

#check current values print(rmtx.to_rad_string()) >

#add verbose flag. rmtx.verbose_reporting = True

#check values again. print(rmtx.to_rad_string()) > -v

freeze()

output_format = None

Specify the output format. Output formats correspond to a for ASCII, d for binary doubles, f for floats and c for RGBE colors.

transpose_matrix = None

This boolean option transposes the matrix.

unfreeze()

verbose_reporting = None

This boolean option turns on verbose reporting, which announces each operation of rmtxop

honeybee.radiance.parameters.rpict module

Radiance rpict Parameters.

class honeybee.radiance.parameters.rpict.HighQuality

Bases: honeybee.radiance.parameters.rpict.RpictParameters

High quality radiance parameters.

class honeybee.radiance.parameters.rpict.LowQuality

Bases: honeybee.radiance.parameters.rpict.RpictParameters

Radiance parmaters for a quick analysis.

class honeybee.radiance.parameters.rpict.MediumQuality

Bases: honeybee.radiance.parameters.rpict.RpictParameters

Medium quality Radiance parmaters.

class honeybee.radiance.parameters.rpict.RpictParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

Radiance Parameters for generating images.

For the full list of attributes try self.keys

quality

An integer between 0-2 (0:low, 1: medium or 2: high quality)

Usage:

rp = RpictParameters(0) print(rp.to_rad_string())

> -aa 0.25 -ab 2 -ad 512 -dc 0.25 -st 0.85 -lw 0.05 -as 128 -ar 16 -lr 4 -dt 0.5

-dr 0 -ds 0.5 -dp 64

rp = RpictParameters(1) print(rp.to_rad_string())

> -aa 0.2 -ab 3 -ad 2048 -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

rp = RpictParameters(2) print(rp.to_rad_string()) > -aa 0.1 -ab 6 -ad 4096 -dc 0.75 -st 0.15 -lw 0.005 -as 4096 -ar 128 -lr 8

-dt 0.15 -dr 3 -ds 0.05 -dp 512

rp.ab = 5 rp.u = True print(rp.to_rad_string())

> -aa 0.1 -ab 5 -dj 0.7 -ad 4096 -dc 0.75 -st 0.15 -lw 0.005 -as 4096 -ar 128

-lr 8 -dt 0.15 -dr 3 -ds 0.05 -dp 512 -u

ambient_accuracy = None

Number of ambient accuracy. This value will approximately equal the error from indirect illuminance interpolation. A value of zero implies no interpolation.

ambient_bounces = None

Number of ambient bounces. This is the maximum number of diffuse bounces computed by the indirect calculation. A value of zero implies no indirect calculation.

ambient_divisions = None

Number of ambient divisions. The error in the Monte Carlo calculation of indirect illuminance will be inversely proportional to the square root of this number. A value of zero implies no indirect calculation.

ambient_resolution = None

Number of ambient resolution. This number will determine the maximum density of ambient values used in interpolation. Error will start to increase on surfaces spaced closer than the scene size divided by the ambient resolution. The maximum ambient value density is the scene size times the ambient accuracy.

ambient_supersamples = None

Number of ambient super-samples. Super-samples are applied only to the ambient divisions which show a significant change.

ambient_value = None

-av red grn blu

Set the ambient value to a radiance of red grn blu . This is the final value used in place of an indirect light calculation. If the number of ambient bounces is one or greater and the ambient value weight is non-zero , this value may be modified by the computed indirect values to improve overall accuracy.

ambient_weight = None

-aw N

Set the relative weight of the ambient value given with the -av option to N. As new indirect irradiances are computed, they will modify the default ambient value in a moving average, with the specified weight assigned to the initial value given on the command and all other weights set to 1. If a value of 0 is given with this option, then the initial ambient value is never modified. This is the safest value for scenes with large differences in indirect contributions, such as when both indoor and outdoor (daylight) areas are visible

back_face_visibility = None

-bv

Boolean switch for back face visibility. With this switch off, back faces of opaque objects will be invisible to all rays. This is dangerous unless the model was constructed such that all surface normals on opaque objects face outward. Although turning off back face visibility does not save much computation time under most circumstances, it may be useful as a tool for scene debugging, or for seeing through one-sided walls from the outside. This option has no effect on transparent or translucent materials.

direct_certainty = None

-dc frac

Set the direct certainty to frac. A value of one guarantees that the absolute accuracy of the direct calculation will be equal to or better than that given in the -dt specification. A value of zero only insures that all shadow lines resulting in a contrast change greater than the -dt specification will be calculated.

direct_jitter = None

-dj frac Set the direct jittering to frac. A value of zero samples each source at specific sample points (see the -ds option below), giving a smoother but somewhat less accurate rendering. A positive value causes rays to be distributed over each source sample according to its size, resulting in more accurate penumbras. This option should never be greater than 1, and may even cause problems (such as speckle)when the value is smaller. A warning about aiming failure will issued if frac is too large. It is usually wise to turn off image sampling when using direct jitter by setting -ps to 1.

direct_presamp_density = None

-dp D

Set the secondary source presampling density to D. This is the number of samples per steradian that will be used to determine ahead of time whether or not it is worth following shadow rays through all the reflections and/or transmissions associated with a secondary source path. A value of 0 means that the full secondary source path will always be tested for shadows if it is tested at all.

direct_sampling = None

-ds frac Set the direct sampling ratio to frac. A light source will be subdivided until the width of each sample area divided by the distance to the illuminated point is below this ratio. This assures accuracy in regions close to large area sources at a slight computational expense. A value of zero turns source subdivision off, sending at most one shadow ray to each light source.

direct_sec_relays = None

-dr N

Set the number of relays for secondary sources to N. A value of 0 means that secondary sources will be ignored. A value of 1 means that sources will be made into first generation secondary sources; a value of 2 means that first generation secondary sources will also be made into second generation secondary sources, and so on.

direct_threshold = None

-dt frac

Set the direct threshold to frac. Shadow testing will stop when the potential contribution of at least the next and at most all remaining light source samples is less than this fraction of the accumulated value. The remaining light source contributions are approximated statistically. A value of zero means that all light source samples will be tested for shadow.

direct_visibility = None

-dv

Boolean switch for light source visibility. With this switch off, sources will be black when viewed directly although they will still participate in the direct calculation. This option may be desirable in conjunction with the -i option so that light sources do not appear in the output.

freeze()

get_parameter_default_value_based_on_quality(parameter)

Get parameter value based on quality.

You can change this value by using self.parameter = value (e.g. self.ab=5)

Parameters:parameter – Radiance parameter as an string (e.g “ab”)

Usage:

rp = low_quality() print(rp.getParameterValue(“ab”)) >> 2

classmethod high_quality()

High quality radiance parameters.

irradiance_calc = None

-i

Boolean switch to compute irradiance rather than radiance values. This only affects the final result, substituting a Lambertian surface and multiplying the radiance by pi. Glass and other transparent surfaces are ignored during this stage. Light sources still appear with their original radiance values, though the -dv option (above) may be used to override this. The radiance default value for this option is False.

isImageBasedRadianceParameters

Return True to indicate this object is a RadianceParameters.

limit_reflections = None

-lr N Limit reflections to a maximum of N, if N is a positive integer. If N is zero, then Russian roulette is used for ray termination, and the -lw setting (below) must be positive. If N is a negative integer, then this sets the upper limit of reflections past which Russian roulette will be used. In scenes with dielectrics and total internal reflection, a setting of 0 (no limit) may cause a stack overflow.

limit_weight = None

-lw frac

Limit the weight of each ray to a minimum of frac. During ray-tracing, a record is kept of the estimated contribution (weight) a ray would have in the image. If this weight is less than the specified minimum and the -lr setting (above) is positive, the ray is not traced. Otherwise, Russian roulette is used to continue rays with a probability equal to the ray weight divided by the given frac.

classmethod low_quality()

Radiance parmaters for a quick analysis.

max_search_radius = None

Place holder for comments.

classmethod medium_quality()

Medium quality Radiance parmaters.

photon_cache_pagesize = None

Place holder for comments.

photon_cache_size = None

Place holder for comments.

photon_map_file_bandwidth = None

Place holder for comments.

pixel_aspect_ratio = None

-pa rat

Set the pixel aspect ratio (height over width) to rat. Either the x or the y resolution will be reduced so that the pixels have this ratio for the specified view. If rat is zero, then the x and y resolutions will adhere to the given maxima.

pixel_depth_of_field = None

-pd dia

Set the pixel depth-of-field aperture to a diameter of dia (in world coordinates). This will be used in conjunction with the view focal distance, indicated by the length of the view direction vector given in the -vd option. It is not advisable to use this option in combination with the pdfblur(1) program, since one takes the place of the other. However, it may improve results with pdfblur to use a very small fraction with the -pd option, to avoid the ghosting effect of too few samples.

pixel_jitter = None

-pj frac

Set the pixel sample jitter to frac. Distributed ray-tracing performs anti-aliasing by randomly sampling over pixels. A value of one will randomly distribute samples over full pixels. A value of zero samples pixel centers only. A value between zero and one is usually best for low-resolution images.

pixel_motion_blur = None

-pm frac

Set the pixel motion blur to frac. In an animated sequence, the exact view will be blurred between the previous view and the next view as though a shutter were open this fraction of a frame time. (See the -S option regarding animated sequences.) The first view will be blurred according to the difference between the initial view set on the command line and the first view taken from the standard input. It is not advisable to use this option in combination with the pmblur(1) program, since one takes the place of the other. However, it may improve results with pmblur to use a very small fraction with the -pm option, to avoid the ghosting effect of too few time samples.

pixel_sampling = None

-ps size

Set the pixel sample spacing to the integer size. This specifies the sample spacing (in pixels) for adaptive subdivision on the image plane.

pixel_tolerance = None

-pt frac

Set the pixel sample tolerance to frac. If two samples differ by more than this amount, a third sample is taken between them.

quality

**An integer between 0-2 (0* – low, 1* – medium or 2: high quality)

specular_sampling = None

-ss samp

Set the specular sampling to samp. For values less than 1, this is the degree to which the highlights are sampled for rough specular materials. A value greater than one causes multiple ray samples to be sent to reduce noise at a commmesurate cost. A value of zero means that no jittering will take place, and all reflections will appear sharp even when they should be diffuse. This may be desirable when used in combination with image sampling to obtain faster renderings.

specular_threshold = None

-st frac

Set the specular sampling threshold to frac. This is the minimum fraction of reflection or transmission, under which no specular sampling is performed. A value of zero means that highlights will always be sampled by tracing reflected or transmitted rays. A value of one means that specular sampling is never used. Highlights from light sources will always be correct, but reflections from other surfaces will be approximated using an ambient value. A sampling threshold between zero and one offers a compromise between image accuracy and rendering time.

uncor_rand_samp = None

-u

Boolean switch to control uncorrelated random sampling. When “off”, a low-discrepancy sequence is used, which reduces variance but can result in a brushed appearance in specular highlights. When “on”, pure Monte Carlo sampling is used in all calculations.

unfreeze()

x_resolution = None

Set the maximum x resolution.

y_resolution = None

Set the maximum y resolution.

honeybee.radiance.parameters.rtrace module

Radiance raytracing Parameters.

class honeybee.radiance.parameters.rtrace.HighQuality

Bases: honeybee.radiance.parameters.rtrace.RtraceParameters

High quality radiance parameters.

class honeybee.radiance.parameters.rtrace.LowQuality

Bases: honeybee.radiance.parameters.rtrace.RtraceParameters

Radiance parmaters for a quick analysis.

class honeybee.radiance.parameters.rtrace.MediumQuality

Bases: honeybee.radiance.parameters.rtrace.RtraceParameters

Medium quality Radiance parmaters.

class honeybee.radiance.parameters.rtrace.RtraceParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

Radiance Parameters for grid based analysis.

For the full list of attributes try self.keys

quality

An integer between 0-2 (0:low, 1: medium or 2: high quality)

Usage:

rp = RtraceParameters(0) print(rp.to_rad_string())

> -aa 0.25 -ab 2 -ad 512 -dc 0.25 -st 0.85 -lw 0.05 -as 128 -ar 16 -lr 4

-dt 0.5 -dr 0 -ds 0.5 -dp 64

rp = RtraceParameters(1) print(rp.to_rad_string())

> -aa 0.2 -ab 3 -ad 2048 -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

rp = RtraceParameters(2) print(rp.to_rad_string()) > -aa 0.1 -ab 6 -ad 4096 -dc 0.75 -st 0.15 -lw 0.005 -as 4096 -ar 128

-lr 8 -dt 0.15 -dr 3 -ds 0.05 -dp 512

rp.ab = 5 rp.u = True print(rp.to_rad_string())

> -aa 0.1 -ab 5 -dj 0.7 -ad 4096 -dc 0.75 -st 0.15 -lw 0.005 -as 4096

-ar 128 -lr 8 -dt 0.15 -dr 3 -ds 0.05 -dp 512 -u

ambient_accuracy = None

Number of ambient accuracy. This value will approximately equal the error from indirect illuminance interpolation. A value of zero implies no interpolation.

ambient_bounces = None

Number of ambient bounces. This is the maximum number of diffuse bounces computed by the indirect calculation. A value of zero implies no indirect calculation.

ambient_divisions = None

Number of ambient divisions. The error in the Monte Carlo calculation of indirect illuminance will be inversely proportional to the square root of this number. A value of zero implies no indirect calculation.

ambient_resolution = None

Number of ambient resolution. This number will determine the maximum density of ambient values used in interpolation. Error will start to increase on surfaces spaced closer than the scene size divided by the ambient resolution. The maximum ambient value density is the scene size times the ambient accuracy.

ambient_supersamples = None

Number of ambient super-samples. Super-samples are applied only to the ambient divisions which show a significant change.

direct_certainty = None

-dc frac

Set the direct certainty to frac. A value of one guarantees that the absolute accuracy of the direct calculation will be equal to or better than that given in the -dt specification. A value of zero only insures that all shadow lines resulting in a contrast change greater than the -dt specification will be calculated.

direct_jitter = None

-dj frac Set the direct jittering to frac. A value of zero samples each source at specific sample points (see the -ds option below), giving a smoother but somewhat less accurate rendering. A positive value causes rays to be distributed over each source sample according to its size, resulting in more accurate penumbras. This option should never be greater than 1, and may even cause problems (such as speckle)when the value is smaller. A warning about aiming failure will issued if frac is too large. It is usually wise to turn off image sampling when using direct jitter by setting -ps to 1.

direct_presamp_density = None

-dp D

Set the secondary source presampling density to D. This is the number of samples per steradian that will be used to determine ahead of time whether or not it is worth following shadow rays through all the reflections and/or transmissions associated with a secondary source path. A value of 0 means that the full secondary source path will always be tested for shadows if it is tested at all.

direct_sampling = None

-ds frac Set the direct sampling ratio to frac. A light source will be subdivided until the width of each sample area divided by the distance to the illuminated point is below this ratio. This assures accuracy in regions close to large area sources at a slight computational expense. A value of zero turns source subdivision off, sending at most one shadow ray to each light source.

direct_sec_relays = None

-dr N

Set the number of relays for secondary sources to N. A value of 0 means that secondary sources will be ignored. A value of 1 means that sources will be made into first generation secondary sources; a value of 2 means that first generation secondary sources will also be made into second generation secondary sources, and so on.

direct_threshold = None

-dt frac

Set the direct threshold to frac. Shadow testing will stop when the potential contribution of at least the next and at most all remaining light source samples is less than this fraction of the accumulated value. The remaining light source contributions are approximated statistically. A value of zero means that all light source samples will be tested for shadow.

freeze()

classmethod from_json(rec_json)

Create radiance parameters from json. { “gridbased_parameters”: string // A standard radiance parameter string

(e.g. -ab 5 -aa 0.05 -ar 128)

}

get_parameter_default_value_based_on_quality(parameter)

Get parameter value based on quality.

You can change this value by using self.parameter = value (e.g. self.ab=5)

Parameters:parameter – Radiance parameter as an string (e.g “ab”)

Usage:

rp = LowQuality() print rp.getParameterValue(“ab”) >> 2

i_irradiance_calc = None

-i

Boolean switch to compute irradiance rather than radiance values. This only affects the final result, substituting a Lambertian surface and multiplying the radiance by pi. Glass and other transparent surfaces are ignored during this stage. Light sources still appear with their original radiance values, though the -dv option (below) may be used to override this. This option is especially useful in conjunction with ximage(1) for computing illuminance at scene points

irradiance_calc = None

-I

Boolean switch to compute irradiance rather than radiance, with the input origin and direction interpreted instead as measurement point and orientation. -h Boolean switch for information header on output. The radiance default value for this option is False.

isGridBasedRadianceParameters

Return True to indicate this object is a RadianceParameters.

limit_reflections = None

-lr N Limit reflections to a maximum of N, if N is a positive integer. If N is zero, then Russian roulette is used for ray termination, and the -lw setting (below) must be positive. If N is a negative integer, then this sets the upper limit of reflections past which Russian roulette will be used. In scenes with dielectrics and total internal reflection, a setting of 0 (no limit) may cause a stack overflow.

limit_weight = None

-lw frac

Limit the weight of each ray to a minimum of frac. During ray-tracing, a record is kept of the estimated contribution (weight) a ray would have in the image. If this weight is less than the specified minimum and the -lr setting (above) is positive, the ray is not traced. Otherwise, Russian roulette is used to continue rays with a probability equal to the ray weight divided by the given frac.

output_data_format = None

-f[io]

Format input according to the character i and output according to the character o. Rtrace understands the following input and output formats: ‘a’ for ascii, ‘f’ for single-precision floating point, and ‘d’ for double-precision floating point. In addition to these three choices, the character ‘c’ may be used to denote 4-byte floating point (Radiance) color format for the output of values only (-ov option, below). If the output character is missing, the input format is used.

output_spec = None

-o[spec]

Produce output fields according to spec. Characters are interpreted as follows: o - origin (input) d - direction (normalized) v - value (radiance) V - contribution (radiance) w - weight W - color coefficient l - effective length of ray L - first intersection distance c - local (u,v) coordinates p - point of intersection n - normal at intersection (perturbed) N - normal at intersection (unperturbed) s - surface name m - modifier name M - material name ~ tilde (end of trace marker)

If the letter t appears in spec, then the fields following will be printed for every ray traced, not just the final result. If the capital letter T is given instead of t, then all rays will be reported, including shadow testing rays to light sources. Spawned rays are indented one tab for each level. The tilde marker (~) is a handy way of differentiating the final ray value from daughter values in a traced ray tree, and usually appears right before the t or T output flags. E.g., -ov~TmW will emit a tilde followed by a tab at the end of each trace, which can be easily distinguished even in binary output.

quality

**An integer between 0-2 (0* – low, 1* – medium or 2: high quality)

specular_sampling = None

-ss samp

Set the specular sampling to samp. For values less than 1, this is the degree to which the highlights are sampled for rough specular materials. A value greater than one causes multiple ray samples to be sent to reduce noise at a commmesurate cost. A value of zero means that no jittering will take place, and all reflections will appear sharp even when they should be diffuse. This may be desirable when used in combination with image sampling to obtain faster renderings.

specular_threshold = None

-st frac

Set the specular sampling threshold to frac. This is the minimum fraction of reflection or transmission, under which no specular sampling is performed. A value of zero means that highlights will always be sampled by tracing reflected or transmitted rays. A value of one means that specular sampling is never used. Highlights from light sources will always be correct, but reflections from other surfaces will be approximated using an ambient value. A sampling threshold between zero and one offers a compromise between image accuracy and rendering time.

to_json()

Write radiance grid_based parameters to json. { “gridbased_parameters”: string // A standard radiance parameter string

(e.g. -ab 5 -aa 0.05 -ar 128)

}

uncor_rand_samp = None

-u

Boolean switch to control uncorrelated random sampling. When “off”, a low-discrepancy sequence is used, which reduces variance but can result in a brushed appearance in specular highlights. When “on”, pure Monte Carlo sampling is used in all calculations.

unfreeze()

honeybee.radiance.parameters.vwrays module

class honeybee.radiance.parameters.vwrays.VwraysParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

freeze()

unfreeze()

honeybee.radiance.parameters.xform module

Radiance xform parameters

class honeybee.radiance.parameters.xform.XformParameters(*args, **kwargs)

Bases: honeybee.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

freeze()

unfreeze()

Module contents