honeybee_radiance_command.options.pcomb module

class honeybee_radiance_command.options.pcomb.PcombOptions[source]

Bases: OptionCollection

pcomb command options.

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

additional_options
property c

RGB values

RGB values to be applied in the linear combination of pictures.

property command

Command name.

property e

Expression

This expression can be used to assign arbitrary mapping of coefficients.

property f

function file

This function file can be used to assign arbitrary mapping of coefficients.

property h

False

The −h option may be used to reduce the information header size, which can grow disproportionately after multiple runs of pcomb.

Type:

Reduce information header - default

property o

Use original pixel values

The −o option indicates that original pixel values are to be used for the next picture, undoing any previous exposure changes or color correction.

property options

Print out list of options.

property s

Factor for linear combination

A factor used in the linear combination of pictures.

property slots

Return slots including the ones from the baseclass if any.

property w

False

The −w option can be used to suppress warning messages about invalid calculations.

Type:

Suppress warning messages - default

property x

X resolution

The −x option can be used to specify the desired output resolution, xres, and can be expressions involving other constants such as xmax. The constants xres may also be specified in a file or expression. The default output resolution is the same as the input resolution.

property y

Y resolution

The −y option can be used to specify the desired output resolution, yres, and can be expressions involving other constants such as ymax. The constants yres may also be specified in a file or expression. The default output resolution is the same as the input resolution.