honeybee_plus.radiance.recipe.pointintime.imagebased module

Radiance Grid-based Analysis Recipe.

class honeybee_plus.radiance.recipe.pointintime.imagebased.ImageBased(sky, views, simulation_type=2, rad_parameters=None, hb_objects=None, sub_folder='imagebased')

Bases: honeybee_plus.radiance.recipe._imagebasedbase.GenericImageBased

Grid base analysis base class.

sky

A honeybee sky for the analysis

views

List of views.

simulation_type

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

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:

# create the sky sky = SkyWithCertainIlluminanceLevel(2000)

# initiate analysis_recipe analysis_recipe = ImageBased(

sky, views, simType )

# add honeybee object analysis_recipe.hb_objects = HBObjs

# write analysis files to local drive analysis_recipe.write(_folder_, _name_)

# run the analysis analysis_recipe.run(debaug=False)

# get the results print(analysis_recipe.results())

ToString()

Overwrite .NET ToString method.

property radiance_parameters

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

results()

Return results for this analysis.

property simulation_type

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

Type

Simulation type

Type

0

property sky

A honeybee sky for the analysis.

write(target_folder, project_name='untitled', header=True)

Write analysis files to target folder.

Files for an image based analysis are:

views <.vf>: A radiance view. sky file <.sky>: Radiance sky for this analysis. material file <*.mat>: Radiance materials. Will be empty if hb_objects is

None.

geometry file <*.rad>: Radiance geometries. Will be empty if hb_objects is

None.

sky file <.sky>: Radiance sky for this analysis. batch file <.bat>: An executable batch file which has the list of commands.

oconve <*.sky> <project_name.mat> <project_name.rad> <additional rad_files> > <project_name.oct> rtrace <radiance_parameters> <project_name.oct> > <project_name.res>

results file <*.hdr>: Results file once the analysis is over.

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