honeybee_radiance_command.options.falsecolor module¶

class honeybee_radiance_command.options.falsecolor.FalsecolorOptions[source]¶

Bases: OptionCollection

falsecolor options.

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

Blue channel mapping as an expression of ‘v’

The expression must be of the variable v, where v varies from 0 to 1. This option is not recommended for the casual user.

property cb¶

False

The thickness of the bands is related to the rate of change in the image. Note that contour bands are used instead of creating a falsecolor image.

Type:: Draw contour bands - default

property cl¶

False

Note that contour lines are used instead of creating a falsecolor image.

Type:: Draw contour lines - default

property command¶: Command name.

property e¶

False

Extrema are the brightest and darkest pixels of the input picture.

Type:: Print extrema min/max pixels - default

property g¶

Green channel mapping as an expression of ‘v’

The expression must be of the variable v, where v varies from 0 to 1. This option is not recommended for the casual user.

property l¶

Nits

The default label of “Nits” is appropriate for standard Radiance images. If the -i option of rpict was used to produce the image, then the appropriate label would be “Lux”.

Type:: Text for the legend label - default

property lh¶

200

A value of zero in either eliminates the legend in the output.

Type:: Legend height in pixels - default

property log¶

Number of decades to use with a logarithmic legend scale

Decades are the number of intervale of 10 below the maximum scale. If unspecified, a linear scale is used.

property lw¶

100

A value of zero in either eliminates the legend in the output.

Type:: Legend width in pixels - default

property m¶

179

The default multiplier is 179, which converts from radiance or irradiance to luminance or illuminance, respectively.

Type:: Legend multiplier (integer) - default

property n¶

Note that this also changes the corresponding legend entries.

Type:: Number of contours - default

property odim¶

“X and Y grid dimensions for value overlay.

The expression must be a tuple with two integer values.

property options¶: Print out list of options.

property p¶: Picture file path over which contour lines will be placed

property pal¶

def

‘def’ sets default colors.
‘pm3d’ sets a variation of the default colors.
‘spec’ sets the old spectral mapping.
‘hot’ sets a thermal scale.

Type:: Image and legend color palette - default

property r¶

Red channel mapping as an expression of ‘v’

The expression must be of the variable v, where v varies from 0 to 1. This option is not recommended for the casual user.

property s¶

auto

If the argument given begins with an “a” for “auto,” then the maximum is used for scaling the result.

Type:: Legend scale - default

property slots¶: Return slots including the ones from the baseclass if any.