ladybug_display.extension.viewsphere module

Method to draw a ViewSphere as a VisualizationSet.

ladybug_display.extension.viewsphere.view_sphere_to_vis_set(view_sphere, view_type='HorizontalRadial', resolution=1, center_point=Point3D(0.00, 0.00, 0.00), context_intersect_dist=None, dist_units='m', radius=1, legend_parameters=None, draw_view_rays=True)[source]

Translate a Ladybug ViewSphere object into Display geometry.

Parameters:

  • view_sphere – A Ladybug ViewSphere object to be converted to display geometry.

  • view_type –

    Text for the type of view analysis to conduct. Choose from the following options. (Default: HorizontalRadial)

    • HorizontalRadial - The percentage of the 360 horizontal view

      plane that is not blocked by the context geometry.

    • Horizontal30DegreeOffset - The percentage of the 360 horizontal

      view band bounded on top and bottom by a 30 degree offset from the horizontal plane. 30 degrees corresponds roughly to the vertical limit of human peripheral vision.

    • Spherical - The percentage of the sphere surrounding each of

      the test points that is not blocked by context geometry. This is equivalent to a solid angle and gives equal weight to all portions of the sphere.

    • SkyExposure - The percentage of the sky that is visible from

      each of the the test points.

  • resolution – A positive integer for the number of times that the original view vectors are subdivided. For a circle, 1 indicates that 72 evenly-spaced vectors are used to describe a circle, 2 indicates that 144 vectors describe a circle, and each successive value will roughly double the number of view vectors used. For a dome, 1 indicates that 1225 are used to describe the dome, 2 indicates that 5040 view vectors describe the some and each successive value will roughly quadruple the number of view vectors used. Setting this to a high value will result in a more accurate analysis but will take longer to run. (Default: 1).

  • center_point – Point3D for the center of the view Sphere. (Default: (0, 0, 0)).

  • context_intersect_dist – An optional list of positive numbers that align with the number of view vectors in the View Sphere, given the input view_type and resolution. If supplied, these will be used to color the view sphere with the distances to context geometry surrounding the center_point. This produces a graphic showing how open the view is around the center point. If None, the view sphere will have all one color and it will be assumed that the view sphere is being displayed primarily as a way to illustrate the view_type. (Default: None).

  • dist_units – Text for the abbreviation of the units to be used in the view sphere visualization. (Default: m).

  • radius – A number for the radius of the view sphere in Rhino model units. When a context_intersect_dist is supplied, this should be the maximum value of this list or the distance at which context is no longer able to block the view from the center point. (Default: 1).

  • legend_parameters – Optional legend parameters that will be used to customize the display of the context_intersect_dist. (Default: None).

  • draw_view_rays – Boolean to note whether a ContextGeometry should be included with the rays that are used to evaluate the view. (Default: True).

Returns:

A VisualizationSet with the ViewSphere represented as an AnalysisGeometry (and optionally a ContextGeometry if draw_view_rays is True). This includes these objects in the following order.

  • View_Analysis – A AnalysisGeometry for the View Sphere geometry. This will be colored with distances if context_intersect_dist is supplied.

  • View_Rays – A ContextGeometry for the rays used to evaluate view if draw_view_rays is True.