honeybee_plus.radiance.recipe.daylightcoeff.imagebased module¶

Radiance Daylight Coefficient Image-Based Analysis Recipe.

class honeybee_plus.radiance.recipe.daylightcoeff.imagebased.DaylightCoeffImageBased(sky_mtx, views, simulation_type=2, daylight_mtx_parameters=None, vwrays_parameters=None, reuse_daylight_mtx=True, hb_objects=None, sub_folder='imagebased_daylightcoeff')[source]¶

Bases: honeybee_plus.radiance.recipe._imagebasedbase.GenericImageBased

Daylight Coefficient Image-Based.

sky_mtx¶: A honeybee sky for the analysis

views¶: List of views.

simulation_type¶: 0: Illuminance(lux), 1: Radiation (kWh), 2: Luminance (Candela) (Default: 2)

rad_parameters¶: Radiance parameters for grid based analysis (rtrace). (Default: imagebased.LowQualityImage)

hb_objects¶: An optional list of Honeybee surfaces or zones (Default: None).

sub_folder¶: Analysis subfolder for this recipe. (Default: “gridbased”)

Usage:

ToString()[source]¶: Overwrite .NET ToString method.

property daylight_mtx_parameters¶: Radiance parameters for image based analysis (rfluxmtx). (Default: imagebased.LowQualityImage)

is_daylight_mtx_created(study_folder, view, wg, state)[source]¶: Check if hdr images for daylight matrix are already created.

is_hdr_mtx_created(study_folder, view, wg, state, stype)[source]¶: Check if hourly hdr images for daylight matrix are already created.

is_sun_mtx_created(study_folder, view, wg, state)[source]¶: Check if hdr images for daylight matrix are already created.

results()[source]¶: Return results for this analysis.

property simulation_type¶

Illuminance(lux), 1: Radiation (kWh), 2: Luminance (Candela) (Default: 2)

Type: Simulation type
Type: 0

property sky_density¶: Radiance sky type e.g. r1, r2, r4.

property sky_matrix¶: A honeybee sky for the analysis.

property vwrays_parameters¶: Radiance parameters for vwrays. (Default: imagebased.LowQualityImage)

write(target_folder, project_name='untitled', header=True)[source]¶

Write analysis files to target folder.

Parameters

target_folder – Path to parent folder. Files will be created under target_folder/gridbased. use self.sub_folder to change subfolder name.
project_name – Name of this project as a string.

Returns

Full path to command.bat