honeybee_plus.radiance.resultcollection.resultgrid module

Base class for result collection classes.

PointInTime(ResultGrid): DaylightFactor, Illuminance studies, etc.

values max average % larger/smaller than x count larger/smaller than x

TimeSeries(ResultGrid):

values will return the result for all the hours values_hourly: return the results for a single hour (point in time!) supports annual metrics

daylight autonomy useful daylight illuminance Annual Sunlight Exposure (for direct only study).

TimeSeriesCombined(ResultGrid):

Use this for daylight coefficient based studies in which direct sunlight is calculated separately from sky daylight. In Honeybee[+] this is the case for 2Phase and 5Phase recipes. supports all the above and separate calls for direct values

spatial daylight autonomy (if direct data is available).

class honeybee_plus.radiance.resultcollection.resultgrid.ResultGrid(db_file, grid_id, recipe_id)

Bases: object

ToString()

Overwrite ToString .NET method.

static average(values)

Calculate average value.

property db

Return path to database file.

property db_file

Return path to database file.

execute(command, values=None, fetch=True)

Run sql command.

executemany(command, values=None)

Run sql command.

property grid_id

Return grid id.

static grouper(iterable, n, fillvalue=None)

property has_direct_values

Check if direct values are available.

In point-in-time and 3phase recipes only total values are available.

property has_values

Check if this analysis grid has result values.

property hour_count

Number of hours.

property hoys

Return hour of the year for results.

For point-in-time result grid this will be a tuple with a single item.

static in_range_count(values, min_v, max_v, include_equal_values=False)

Number of values larger than a numerical value.

static in_range_percentage(values, min_v, max_v, include_equal_values=False)

Percentage of values larger than a numerical value.

property is_point_in_time

Return True if the grid has the results only for an hour.

static larger_equal_count(values, value)

Number of values larger than or equal to a numerical value.

static larger_equal_percentage(values, value)

Percentage of values larger than or equal to a numerical value.

static larger_than_count(values, value)

Number of values larger than a numerical value.

static larger_than_percentage(values, value)

Percentage of values larger than a numerical value.

static maximum(values)

Calculate max value.

static minimum(values)

Calculate minimum value.

property moys

Return minutes of the year.

For point-in-time result grid this will be a tuple with a single item.

property name

Return name for this result collection.

The name identical to the name of the original AnalysisGrid.

property point_count

Return number of points.

property recipe_id

Recipe type id for this result grid.

property recipe_name

The original recipe name that generated this result.

static smaller_equal_count(values, value)

Number of values smaller than or equal a numerical value.

static smaller_equal_percentage(values, value)

Percentage of values smaller than or equal a numerical value.

static smaller_than_count(values, value)

Number of values smaller than a numerical value.

static smaller_than_percentage(values, value)

Percentage of values smaller than a numerical value.

property source_combination_ids_longest

Get longest combination between light sources.

property source_count

Get length of light sources.

source_id(name, state)

Get id for a light sources at a specific state.

Parameters

• name – Name as string.

• state – State as a string.

Returns

state as an integer.

Return type

Id for this source

property source_ids

Get list of source ids.

property sources_distinct

Get unique name of light sources as a tuple.

Names are sorted based on id.

to_json()

Create json object from result collection.