honeybee_radiance_command.options.pfilt module

class honeybee_radiance_command.options.pfilt.PfiltOptions

Bases: honeybee_radiance_command.options.optionbase.OptionCollection

pfilt command options.

Also see: https://floyd.lbl.gov/radiance/man_html/pfilt.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 a

False

By default, the areas of the picture above the hot level are not used in setting the exposure.

Type

Average hot spots - default

additional_options

property b

True

Box filtering averages the input pixels corresponding to each separate output pixel.

Type

Use box filtering - default

property c

False

Pixel aspect ratio is being corrected, so do not write PIXASPECT variable to output file.

Type

Do not write PIXASPECT variable - default

property command

Command name.

property e

1

Adjust the exposure. If exp is preceded by a ‘+’ or ‘-’, the exposure is interpreted in f-stops (ie. the power of two). Otherwise, exp is interpreted as a straight multiplier.

Type

Exposure adjustment multiplier - default

property eb

Exposure adjustment multiplier for Blue channel.

property eg

Exposure adjustment multiplier for Green channel.

property er

Exposure adjustment multiplier for Red channel.

property f

Lamp lookup table file - default lib.lamp.tab

Use the specified lamp lookup table rather than the default (lamp.tab).

property h

100 watts/sr/m2

Set intensity considered “hot” to a value. This is the level above which areas of the image will begin to exhibit star diffraction patterns (see below). The default is 100 watts/sr/m2.

Type

Pixel intensity considered “hot” - default

property m

Limit given input pixels by a fraction

Limit the influence of any given input pixel to a fraction of any given output pixel. This option may be used to mitigate the problems associated with inadequate image sampling, at the expense of a slightly blurred image. The fraction given should not be less than the output picture dimensions over the input picture dimensions (x_o*y_o/x_i/y_i), or blurring will occur over the entire image. This option implies the −r option for Gaussian filtering, which defaults to a radius of 0.6.

property n

Number of points on star patterns - default 0

Set the number of points on star patterns to N. A value of zero turns star patterns off. The default is 0. (Note that two passes are required for star patterns.)

property options

Print out list of options.

property p

0

Either the x or the y resolution will be reduced so that the pixels have this ratio for the specified picture. If rat is zero, then the x and y resolutions will adhere to the given maxima. Zero is the default.

Type

Pixel aspect ratio - default

property r

Use Gaussian filtering with specified radius

Use Gaussian filtering with a specified radius relative to the output pixel size. This option with a radius around 0.6 and a reduction in image width and height of 2 or 3 produces the highest quality pictures. A radius greater than 0.7 results in a defocused picture.

property s

.0001

Set the spread for star patterns to val. This is the value a star pattern will have at the edge of the image. The default is .0001.

Type

Spread for star patterns - default

property slots

Return slots including the ones from the baseclass if any.

property t

Fixture type to color balance.

Color-balance the image as if it were illuminated by fixtures of the given type. The specification must match a pattern listed in the lamp lookup table (see the −f option below).

property x

same as input

Set the output x resolution to a number or to a division of the input resolution. Numbers must be less than or equal to the x dimension of the target device. If res is given as a slash followed by a real number (eg. /2), the input resolution is divided by this number to get the output resolution. By default, the output resolution is the same as the input.

Type

X resolution - default

property y

same as input

Set the output y resolution to a number or to a division of the input resolution. Numbers must be less than or equal to the x dimension of the target device. If res is given as a slash followed by a real number (eg. /2), the input resolution is divided by this number to get the output resolution. By default, the output resolution is the same as the input.

Type

Y resolution - default