honeybee_plus.radiance.resultcollection.pointintime module

Result collection for point-in-time daylight studies.

Use this PointInTime result grid to load the results from database for daylight factor, vertical sky component, and point-in-time illuminance or radiation studies.

class honeybee_plus.radiance.resultcollection.pointintime.PointInTime(db_file, grid_id=0, recipe_id=100001, hoy=None)

Bases: honeybee_plus.radiance.resultcollection.resultgrid.ResultGrid

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.

property moys

Return minutes of the year.

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

property recipe_id

Recipe type id for this result grid.

values(sids=None)

Get values for an hour of the year from several sources.

Parameters

sids – List of state ids for all the sources for an hour. If you want a source to be removed set the state to -1. Default value will consider state 0 of all the light sources.

Returns

A tuple for hourly values for this grid.

Usage:

ar = PointInTime(db_file, grid_id=0, recipe_id=100001) # For a case with sky and one other window group with 2 states the default # will return the addition of sky and first state of the window group total_values = ar.values() # sids will be set to [0, 0] # now let’s get the result for the next state of the window group. total_values = ar.values([0, 1]) # or remove the contribution from the second window group sky_only_values = ar.values([0, -1])