honeybee_radiance_command.evalglare module

evalglare command.

class honeybee_radiance_command.evalglare.Evalglare(options=None, output=None, input=None)[source]

Bases: Command

Evalglare command.

Evalglare determines and evaluates glare sources within a 180 degree fisheye image, given in the RADIANCE image format (.pic or .hdr).

The image should be rendered as fisheye (e.g. using the -vta or -vth option) using 180 degrees for the horizontal and vertical view angle (-vv 180, -vh 180.) Due to runtime reasons of the evalglare code, the image should be smaller than 1500x1500 pixels. The recommended size is 1000x1000 pixels, the minimum recommended size is 800x800 pixels.

The program calculates the daylight glare probability (DGP) as well as other glare indexes (DGI, DGI_MOD, UGR, UGR_EXP, VCP, CGI, UDP) to the standard output. The DGP describes the fraction of persons disturbed caused by glare from daylight as a number from 0 to 1, where 0 is no-one disturbed and 1 is everyone. Values lower than 0.2 are out of the range of the user assessment tests, where the program is based on and should be interpreted carefully.

Parameters:

  • options – Command options. It will be set to Radiance default values if unspecified.

  • output – File path to the output file (Default: None).

  • input – File path to the radiance generated hdr file (Default: None).

Properties:

  • options

  • output

  • input

after_run()

After run script.

Overwrite this method to add extra tasks that runs right after run method.

enclose_command(stdin_input=False)

Enclose command in quotes and exclamation point (‘!’). This method should be used when reading the input of a command from another Radiance command.

Example: rmtxop -c 47.4 119.9 11.6 “!rmtxop view transmission daylight sky” > output

run(env=None, cwd=None)

Run command as a subprocess.

Parameters:

  • env – Environmental variables (default: None).

  • cwd – Working directory (Default: ‘.’).

Returns:

Command return code.

Return type:

  • int

to_radiance(stdin_input=False)[source]

Command in Radiance format.

Parameters:

stdin_input – A boolean that indicates if the input for this command comes from stdin. This is for instance the case when you pipe the input from another command. (Default: False).

validate(stdin_input=False)[source]

Overwrite this method to add extra specific checks for the command. For instance for rcontrib you want to make sure there is at least one modifier set in the command.

This method will be executed right before running the command.

property command
property input

Radiance HDR image file.

property options

evalglare options.

property output

output file.

property pipe_to

Second command to pipe the outputs from this command.