honeybee_plus.radiance.resultcollection.imagecollection module

Image collection class.

Image collection class is similar to AnalysisGrid but for image-based analysis. Use ImageCollection to collect the path to different images and generate their combinations using pcomb.

class honeybee_plus.radiance.resultcollection.imagecollection.ImageCollection(name='untitled', output_folder=None)[source]

Bases: object

Image collection.

Image collection class is similar to AnalysisGrid but for image-based analysis. Use ImageCollection to collect the path to different images and generate their combinations using pcomb.

ToString()[source]

Overwrite ToString .NET method.

add_coupled_image_files(file_paths, hoys, source=None, state=None)[source]

Set total, direct and sun file paths for several hours of the year.

Parameters

  • file_paths – List of filepaths as tuples (total, direct, sun).

  • hoys – List of hours of the year that corresponds to input values.

  • source – Name of the source of light. Only needed in case of multiple sources / window groups (default: None).

  • state – State of the source if any (default: None).

add_image_file(file_path, hoy, source=None, state=None, index=0)[source]

Set value for a specific hour of the year.

Parameters

  • value – Value as a number.

  • hoy – The hour of the year that corresponds to this value.

  • source – Name of the source of light. Only needed in case of multiple sources / window groups (default: None).

  • state – State of the source if any (default: None).

  • index – 0 > Default scene, 1 > Direct, 2 > Sun.

add_image_files(file_paths, hoys, source=None, state=None, index=0)[source]

Set values for several hours of the year.

Parameters

  • file_paths – List of file paths as string.

  • hoys – List of hours of the year that corresponds to input values.

  • source – Name of the source of light. Only needed in case of multiple sources / window groups (default: None).

  • state – State of the source if any (default: None).

  • index – 0 > Default scene, 1 > Direct, 2 > Sun.

blind_state_id(source, state)[source]

Get state id if available.

property details

Human readable details.

generate_combined_image_by_id(hoy, blinds_state_ids=None, mode=0, output=None)[source]

Get combined value from all sources based on state_id.

Parameters

  • hoy – hour of the year.

  • blinds_state_ids – List of state ids for all the sources for an hour. If you want a source to be removed set the state to -1.

  • mode – 0 > combined scene, 1 > Default scene, 2 > Direct, 3 > Sun.

Returns

combined image from all sources.

generate_combined_images_by_id(hoys=None, blinds_state_ids=None, mode=0, outputs=None)[source]

Get combined value from all sources based on state_id.

Parameters

  • hoys – A collection of hours of the year.

  • blinds_state_ids – List of state ids for all the sources for input hoys. If you want a source to be removed set the state to -1.

Returns

Return a generator for (total, direct) values.

generate_image(hoy, source=None, state=None, mode=0, output=None)[source]

Generate the image for an hour of the year for input blindStates.

generate_image_by_id(hoy, sid=None, stateid=None, mode=0, output=None)[source]

Generate the image for an hour of the year for input blindStates.

generate_images(hoys, source=None, state=None, mode=0, outputs=None)[source]

Generate images for several hours of the year for input blindStates.

generate_images_by_id(hoys, sid=None, stateid=None, mode=0, outputs=None)[source]

Generate images for several hours of the year for input blindStates.

get_image(hoy, source=None, state=None)[source]

Get list of images for an hour in the year.

get_image_by_id(hoy, sid=None, stateid=None)[source]

Get list of images for an hour in the year.

get_images(hoys, source=None, state=None)[source]

Get list of images for an hour in the year.

get_images_by_id(hoys, sid=None, stateid=None)[source]

Get list of images for an hour in the year.

property has_values

Check if this point has results values.

property hoys

Return hours of the year for results if any.

static parse_blind_states(blinds_state_ids)[source]

Parse input blind states.

The method tries to convert each state to a tuple of a list. Use this method to parse the input from plugins.

Parameters

blinds_state_ids – List of state ids for all the sources for an hour. If you want a source to be removed set the state to -1. If not provided a longest combination of states from sources (window groups) will be used. Length of each item in states should be equal to number of sources.

source_id(source)[source]

Get source id from source name.

source_state_name(sid, stateid)[source]

Get source and state name based on ids.

property sources

Get sorted list of light sources.

In most of the cases light sources are window groups.

property states

Get list of states names for each source.