honeybee_plus.radiance.parameters.rpict module

Radiance rpict Parameters.

class honeybee_plus.radiance.parameters.rpict.HighQuality

Bases: honeybee_plus.radiance.parameters.rpict.RpictParameters

High quality radiance parameters.

class honeybee_plus.radiance.parameters.rpict.LowQuality

Bases: honeybee_plus.radiance.parameters.rpict.RpictParameters

Radiance parmaters for a quick analysis.

class honeybee_plus.radiance.parameters.rpict.MediumQuality

Bases: honeybee_plus.radiance.parameters.rpict.RpictParameters

Medium quality Radiance parmaters.

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

Bases: honeybee_plus.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

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

ambient_bounces

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

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

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

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

ambient_value

-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

-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

-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

-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

-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

-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

-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

-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

-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

-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

-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.

property isImageBasedRadianceParameters

Return True to indicate this object is a RadianceParameters.

limit_reflections

-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

-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

Place holder for comments.

classmethod medium_quality()

Medium quality Radiance parmaters.

photon_cache_pagesize

Place holder for comments.

photon_cache_size

Place holder for comments.

photon_map_file_bandwidth

Place holder for comments.

pixel_aspect_ratio

-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

-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

-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

-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

-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

-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.

property quality

medium or 2: high quality)

Type

An integer between 0-2 (0

Type

low, 1

specular_sampling

-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

-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

-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

Set the maximum x resolution.

y_resolution

Set the maximum y resolution.