honeybee_radiance_command.options.evalglare module

class honeybee_radiance_command.options.evalglare.EvalglareOptions

Bases: OptionCollection

evalglare options.

Also see: https://www.radiance-online.org/learning/documentation/manual-pages/pdfs/evalglare.pdf/view

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

Masking file to study a certain area

Use a masking file to enable statistical analysis on a certain area. Does not affect glare source detection. The masking threshold is 0.1 cd/m2 (all pixels exceeding 0.1 cd/m2 are treated as “inside” the mask.) The PGSV equations are also calculated, but require the masking area to be the window. It requires the -d option. The result of the analysis of the masking area is given in the first line of the output. Should not be combined with -l or -L options.

property B

Angle to calculate luminance of horizontal band

Calculate average luminance of a horizontal band. The angle is in radians. This calculation does not affect glare source detection. Output only when using the -d option. The result of the analysis of the band is given in the first line of the output.

property C

Correction mode - default l+

Type 0: all corrections turned off , Type l+: Low light correction applied (default), Type l-: Low light correction disabled.

property G

Cut field of view according to Guth and perform glare evaluation

Type 1: total field of view. Type 2: field of view seen by both eyes

property I

Externally measured illuminance as (Ev, y_max, y_min)

The vertical illuminance Ev in lux is measured externally. This value will be used for calculating the DGP. Below y_min and above y_max, the picture is filled up by the last known value. This option should be used, when the provided picture is cut horizontally.

property L

Circular two zone evaluation as (xpos, ypos, angle1, angle2)

Activate circular two zone evaluation. The center of the zone is given by xpos and ypos. The opening angle of the inner zone1 is specified by angle1 in radians, the opening angle of the outer zone2 by angle2. The result of the analysis of the zones is given in the first two lines of the output.

property N

Pixel replacement during overflow as (xpos, ypos, angle, Ev, fname)

Pixel replacement in case of pixel overflow in hdr image and measured Ev (in lux) is available. Writes the modified image to fname and exists immediately (without glare evaluation). Replaces pixels in a circular zone to match Ev. The center of the zone is given by xpos and ypos. The opening angle of the zone is specified in radians.

This option should be applied very carefully and only exceptionally. Pixel overflow should be avoided from the beginning by applying shorter exposure times and/or neutral filters.

property T

Task position as (xpos, ypos, angle)

Same as -t, except that the task area is colored bluish in the checkfile.

property Y

Enable peak extraction with value in cd/m2

Enable peak extraction with value (in cd/m2) as threshold for extracted peaks.

additional_options

property b

2000

Threshold factor; if factor is larger than 100, it is used as constant threshold in cd/m2, regardless if a task position is given or not. If factor is less or equal than 100 and a task position is given, this factor multiplied by the average task luminance will be used as threshold for detecting the glare sources. If factor is less than or equal to 100 and no task position is given, this factor multiplied by the average luminance in the entire picture will be used as threshold for detecting the glare sources (not recommended). Default value of factor is 2000 (fixed threshold method).

Type:

Threshold factor in cd/m2 - default

property c

Output check file path

Checkfile is written in the RADIANCE picture format.

property command

Command name.

property d

False

Type:

Enable detailed output - default

property f

False

This forcing option prevents from stopping when -vtv is used and black corners are detected.

Type:

Forcing option for -vtv and black corners - default

property g

Cut field of view according to Guth with no glare evaluation

Cut field of view according to Guth, write checkfile specified by -c and exit without any glare evaluation. Type 1: total field of view. Type 2: field of view seen by both eyes

property i

Externally measured vertical illuminance in lux

The vertical illuminance Ev in lux is measured externally. This value will be used for calculating the DGP.

property l

Circular one zone evaluation as (xpos, ypos, angle)

Activate circular one zone evaluation. The center of the zone is given by xpos and ypos. The opening angle of the zone is specified in radians. The result of the analysis of zone1 is given in the first line of the output.

property options

Print out list of options.

property q

0

Toggle modes for the background luminance calculation.

• 0 (default) - CIE-mode Lb = (Ev - Edir) / pi

• 1 - Lb = mathematical average luminance without glare sources

• 2 (not recommended) - Lb = Ev / pi

Type:

Background luminance calculation method - default

property r

0.2 radians

Search radius (angle in radians) between pixels, where evalglare tries to merge glare source pixels to the same glare source (default value: 0.2 radians)

Type:

Search radius (angle) between pixels - default

property s

False

Type:

Enable smoothing function - default

property slots

Return slots including the ones from the baseclass if any.

property t

Task position as (xpos, ypos, angle)

Definition of task position in x and y coordinates, and its opening angle in radians.

property u

RGB color to color glare sources uniformly

Color glare sources uniformly when writing check file (implies -c option). Color given in r g b. (in any range, values are normalized)

property x

False

Type:

Disable peak extraction - default

property y

True

Type:

Enable peak extraction - default