honeybee_plus.radiance.parameters.falsecolor module

class honeybee_plus.radiance.parameters.falsecolor.FalsecolorParameters(*args, **kwargs)

Bases: honeybee_plus.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters

contour_bands

-cb

The -cb option produces contour bands instead of lines, where the thickness of the bands is related to the rate of change in the image.

contour_lines

-cl

If contour lines are desired rather than just false color, the -cl option can be used. These lines can be placed over another Radiance picture using the -p option.

contour_quant

-n

The -n option can be used to change the number of contours (and corresponding legend entries) from the default value of 8.

freeze()

label

-l label

A legend is produced for the new image with a label given by the -l option. The default label is “Nits”, which is appropriate for standard Radiance images.

legend_height

The -lw and -lh options may be used to change the legend dimensions from the default width and height of 100x200. A value of zero in either eliminates the legend in the output.

legend_width

The -lw and -lh options may be used to change the legend dimensions from the default width and height of 100x200. A value of zero in either eliminates the legend in the output.

log

-log For a logarithmic rather than a linear mapping, the -log option can be used, where decades is the number of decades below the maximum scale desired.

multiplier

The default multiplier is 179, which converts from radiance or irradiance to luminance or illuminance, respectively. A different multiplier can be given with -m to get daylight factors or whatever.

palette

The -pal option provides different color palettes for falsecolor. The current choices are spec for the old spectral mapping, hot for a thermal scale, and pm3d for a variation of the default mapping, def.

pic_for_contours

-p picture

Contour lines can be placed over another Radiance picture using the -p option.

print_extrema_points

-e

The -e option causes extrema points to be printed on the brightest and darkest pixels of the input picture.

scale

-s scale

A different scale can be given with the -s option. If the argument given to -s begins with an “a” for “auto,” then the maximum is used for scaling the result. The default multiplier is 179, which converts from radiance or irradiance to luminance or illuminance, respectively.

unfreeze()