honeybee_radiance_command.dcglare module

dcglare command.

class honeybee_radiance_command.dcglare.Dcglare(options=None, output=None, dc_direct=None, dc_total=None, sky_matrix=None, vmtx=None, dmtx=None, tmtx=None)[source]

Bases: honeybee_radiance_command._command.Command

Dcglare command.

Dcglare generates daylight glare probability (DGP) predictions for multiple points in a space under a variety of daylit conditions. Usually, it is used to produce hourly DGP values for an entire year, or if the -l option is provided, it calculates glare autonomy based on an annual occupancy schedule.

As input, dcglare requires daylight coefficient matrices relating the illuminance at each view point to the brightness of each sky patch. Two such matrices are required. The first, DCdirect, consists of direct views to the sky only and is calculated by rcontrib using a single ambient bounce. The second, DCtotal, includes the total direct and diffuse contribution of each sky patch. The latter can be calculated directly by rcontrib as in the two-phase method, or internally as in the three-phase method if given view, BSDF, and daylight matrices. In this respect, dcglare is similar to dctimestep except that it calculates DGP instead of irradiance. The final input is the sky contribution matrix, usually computed by gendaymtx, which may be passed on the standard input. For efficiency, matrices stored in files can be represented as binary float data if machine byte-order is not an issue.

Parameters

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

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

  • dc_direct – File path to the direct contribution file (Default: None).

  • dc_total – File path to the total (direct and diffuse) contribution file (Default: None).

  • sky_matrix – File path to the sky contribution file (Default: None).

  • vmtx – File path to view matrix (three-phase methoc) (Default: None).

  • dmtx – File path to daylight matrix (three-phase methoc) (Default: None).

  • tmtx – File path to transmission matrix (three-phase methoc) (Default: None).

Properties:

  • options

  • output

  • dc_direct

  • dc_total

  • sky_matrix

  • vmtx

  • dmtx

  • tmtx

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 dc_direct

Direct contribution matrix.

property dc_total

Total (direct and diffuse) contribution matrix.

property dmtx

Daylight matrix.

property options

dcglare options.

property output

output file.

property pipe_to

Second command to pipe the outputs from this command.

property sky_matrix

Sky contribution matrix.

property tmtx

Transmission matrix (BSDF).

property vmtx

View matrix.