ladybug_display.extension.study.directsun module

Method to draw a RadiationDome as a VisualizationSet.

ladybug_display.extension.study.directsun.direct_sun_study_to_vis_set(direct_sun_study, legend_parameters=None, include_title=True, include_context=False)[source]

Translate direct sun study into a VisualizationSet.

Parameters

  • direct_sun_study – A Ladybug-Radiance DirectSunStudy object.

  • legend_parameters – An optional LegendParameter object to change the display of the direct sun study. If None, default legend parameters will be used. (Default: None).

  • include_title – Boolean to note whether the title should be included in the output visualization. (Default: True).

  • include_context – Boolean to note whether the context geometry should be included in the output visualization. (Default: False).

Returns

A VisualizationSet with the direct sun study represented as an AnalysisGeometry. This includes these objects in the following order.

  • Direct_Sun_Data – An AnalysisGeometry for the direct sun data.

  • Title – A ContextGeometry with text for the title of the study.

    This layer will be excluded if include_title is False.

  • Context_Geometry – A ContextGeometry with the shading context used

    in the study. This layer will be excluded when include_context is False.