honeybee_radiance_command.options.pcond module

class honeybee_radiance_command.options.pcond.PcondOptions

Bases: honeybee_radiance_command.options.optionbase.OptionCollection

pcond options.

Also see: https://floyd.lbl.gov/radiance/man_html/pcond.1.html

to_file(folder, file_name, mkdir=False)

Write options to a file.

to_radiance()

Translate options to Radiance format.

update_from_string(string)

Update options from a standard radiance string.

If the option is not currently part of the collection, it will be added to additional_options.

property I

False

Rather than computing a histogram of foveal samples from the source picture, use the precomputed histogram provided on the standard input. This data should be given in pairs of the base-10 logarithm of world luminance and a count for each bin in ascending order, as computed by the phisto(1) script. This option is useful for producing identical exposures of multiple pictures (as in an animation), and provides greater control over the histogram computation.

Type

Precomputed histogram - default

property a

False

Defocus darker regions of the image to simulate human visual acuity loss. This option will not affect well-lit scenes.

Type

Human visual acuity loss - default

additional_options

property c

False

If parts of the image are in the mesopic or scotopic range where the cone photoreceptors lose their efficiency, this switch will cause a corresponding loss of color visibility in the output and a shift to a scotopic (blue-dominant) response function.

Type

Color visibility loss - default

property command

Command name.

property d

32

Specifies the dynamic range for the target output device, which is the ratio of the maximum and minimum usable display luminances. The default value is 32.

Type

Dynamic range - default

property e

Exposure adjustment

Set the exposure adjustment for the picture to a value. This may either be a real multiplier, or a (fractional) number of f-stops preceeded by a + or -. This option implies a linear response (see the −l option above).

property f

output file from macbethcal

Use the given output file from macbethcal(1) to precorrect the color and contrast for the target output device. This does a more thorough job than a simple primary correction using the −p option. Only one of −f or −p may be given.

property h

False

Mimic human visual response in the output. The goal of this process is to produce output that correlates strongly with a person’s subjective impression of a scene. This switch is a bundle of the −a, −v, −s and −c options.

Type

Human visual response - default

property i

0

Set the relative importance of fixation points to a value, which is a value between 0 and 1. If fixfrac is zero (the default), then no fixation points are used in determining the local or global adaptation. If the value is greater than zero, then a list of fixation points is read from the standard input. These points are given as tab-separated (x,y) picture coordinates, such as those produced by the −op option of ximage(1). The foveal samples about these fixation points will then be weighted together with the global averaging scheme such that the fixations receive the value of the total weight. If the value is one, then only the fixation points are considered for adaptation.

Type

Importance of fixation points -default

property l

False

Use a linear response function rather than the standard dynamic range compression algorithm. This will prevent the loss of usable physical values in the output picture, although some parts of the resulting image may be too dark or too bright to see.

Type

Linear response function - default

property options

Print out list of options.

property p

RGB primaries

Specifies the RGB primaries for the target output device. These are the 1931 CIE (x,y) chromaticity values for red, green, blue and white, respectively in the format of (xr yr xg yg xb yb xw yw).

property s

False

Use the human contrast sensitivity function in determining the exposure for the image. A darker scene will have relatively lower exposure with lower contrast than a well-lit scene.

Type

Human contrast sensitivity - default

property slots

Return slots including the ones from the baseclass if any.

property u

100

Specifies the top of the luminance range for the target output device. That is, the luminance (in candelas/m^2) for an output pixel value of (R,G,B)=(1,1,1). The default value is 100 cd/m^2.

Type

Top of Luminance - default

property v

False

Add veiling glare due to very bright regions in the image. This simulates internal scattering in the human eye, which results in a loss of visible contrast near bright sources.

Type

Veiling glare - default

property w

False

Use a center-weighted average for the exposure rather than the default uniform average. This may improve the exposure for scenes with high or low peripheral brightness.

Type

Weighted average exposure - default

property x

Output display luminance to mapfile

Put out the final mapping from world luminance to display luminance to mapfile. This file will contain values from the minimum usable world luminance to the maximum (in candelas/m^2) in one column, and their corresponding display luminance values (also in candelas/m^2) in the second column. This file may be used for debugging purposes, or to plot the mapping function created by pcond.