honeybee_radiance_command.options.accelerad module¶

class honeybee_radiance_command.options.accelerad.AcceleradOptions[source]¶

Bases: OptionCollection

Accelerad command options.

Also see: https://nljones.github.io/Accelerad/documentation.html#commandline

to_file(folder, file_name, mkdir=False)¶: Write options to a file.

to_radiance()¶: Translate options to Radiance format.

update_from_string(string, raise_error=False)¶

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 ac¶

4096

Set the number of k-means clusters for ambient calculation to N.

Type:: k-means clusters for ambient calculation - default

additional_options¶

property ag¶

-1

Set number of ambient divisions for final gather infill to N. When -aa is non-zero, N ambient samples will be taken at points not covered by the precomputed irradiance cache. A value of -1 will cause the value to be copied from -ad.

Type:: Ambient divisions for final gather infill - default

property al¶

Set the spacing between seed point pixels for ambient sampling to stride in rpict only. A value of zero will cause all pixels to be considered. This option is ignored when the -az option is used.

Type:: Spacing between seed point pixels - default

property an¶

100

Set the maximum number of k-means iterations to N. Larger values can cause k-means calculation to take longer but will generate more accurate ambient results.

Type:: maximum k-means iterations - default

property at¶

0.05

Set the k-means threshold to thresh. This is the fraction of seeds that must change cluster in order for k-means iteration to continue. Smaller values can cause k-means calculation to take longer but will generate more accurate ambient results.

Type:: k-means threshold - default

property ax¶

1.0

Set the weighting factor for position in k-means error calculation to

wt. Small values concentrate more ambient calculations around edges where ambient gradients are likely to be large.

Type:: Weighting factor in k-means calculation - default

property az¶

Set the number of seeds points for ambient samples to take around the circumference of a sphere based at the view point to res in rpict only. A value of zero will cause view-dependent seeding to be used instead. Thus, zero should not be used in combination with the -S option in which a view file changes the view direction from between frames.

Type:: Seeds points for ambient samples - default

property command¶: Command name.

property g¶

Enable or disable GPU ray tracing. A value of -g- will cause the Accelerad programs to revert to normal Radiance behavior without using the GPU.

Type:: Enable or disable GPU ray tracing - default

property gv¶

Set the verbosity of GPU debugging to level. Level 0 produces the fastest output but will not display GPU errors which could affect results. Level 1 reports GPU errors. Levels 2 and 3 provide additional GPU stats but result in longer computations.

Type:: Flush interval - default

property options¶: Print out list of options.

property slots¶: Return slots including the ones from the baseclass if any.