honeybee_radiance_command.options.dcglare module

class honeybee_radiance_command.options.dcglare.DcglareOptions

Bases: honeybee_radiance_command.options.optionbase.OptionCollection

dcglare options.

Also see: https://www.radiance-online.org/learning/documentation/manual-pages/pdfs/dcglare.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.

additional_options

property b

2000

If factor is larger than 100, it is used as constant threshold in cd/m2. If factor is less or equal than 100, this factor multiplied by the average luminance in each view will be used as threshold for detecting the glare sources (not recommended). The default value is 2000 (fixed threshold method).

Type

Threshold factor in cd/m2 - default

property command

Command name.

property l

Limit for glare occurrence

Set the limit for glare occurrence. When this option is provided, the program calculates glare autonomy, where any DGP value at or above the limit indicates the presence of glare. If the option is not provided, the program calculates DGP under each sky condition in the sky matrix instead.

property options

Print out list of options.

property se

Occupancy end hour

Set the occupancy end hour. This option is provided for expediency when no occupancy schedule file is available. It is assumed that the sky matrix includes 24 entries per day, corresponding to one per hour. This argument is used only if -l is specified.

property sf

Occupancy schedule file

Set the occupancy schedule file. In the event that the sky matrix includes unoccupied hours that should not contribute to the glare autonomy calculation, occupancy schedule file will be read to determine which entries from the sky file matrix will be included in this calculation. Each line of occupancy schedule file is expected to contain a numeric value at the end of a comma-delimited list, with zero corresponding to unoccupied. This argument is used only if -l is specified.

property slots

Return slots including the ones from the baseclass if any.

property ss

Occupancy start hour

Set the occupancy start hour. This option is provided for expediency when no occupancy schedule file is available. It is assumed that the sky matrix includes 24 entries per day, corresponding to one per hour. This argument is used only if -l is specified

property vd

View forward vector for DGP calculation

Set the view forward vector (vertical direction) for DGP calculation to xd yd zd. This option is ignored when the −vf option is provided.

property vf

View file for DGP calculation

Get the list of views for DGP calculation from file. Each line in file contains six numeric values corresponding to the position and direction of a view. Generally, this is the same file that is used as input to rcontrib to create the daylight coefficient matrices.

property vi

‘a’

Set the format of the view file. Available options are ‘f’ for single and ‘d’ for double precison IEEE float. The default when no value is provided is to use ASCII.

Type

Format of view file - default

property vu

0.000000 0.000000 1.000000

Set the view up vector (vertical direction) for DGP calculation to xd yd zd. The default up vector is the positive z direction.

Type

View up vector for DGP calculation - default