Ladybug Primer
Ladybug Tools for Grasshopper Documentation
  • Ladybug Primer
  • Components
    • 0 :: Import
      • Download Weather
      • EPWmap
      • Import EPW
      • Import Location
      • Construct Location
      • Deconstruct Location
      • Import DDY
      • Import STAT
      • Deconstruct Design Day
      • Import Design Day
      • EPW to DDY
    • 1 :: Analyze Data
      • Construct Data
      • Construct Data Type
      • Construct Header
      • Deconstruct Data
      • Analysis Period
      • Calculate HOY
      • Apply Analysis Period
      • Apply Conditional Statement
      • Arithmetic Operation
      • Time Interval Operation
      • Degree Days
      • Wind Speed
      • Adaptive Comfort
      • PET Comfort
      • PMV Comfort
      • UTCI Comfort
      • Indoor Solar MRT
      • Outdoor Solar MRT
      • Ankle Draft
      • Clothing by Temperature
      • Comfort Statistics
      • Convert to Timestep
      • Data DateTimes
      • Day Solar Information
      • Deconstruct Header
      • Directional Solar Irradiance
      • HOY to DateTime
      • Humidity Metrics
      • Mass Arithmetic Operation
      • Radiant Asymmetry
      • Relative Humidity from Dew Point
      • Solar MRT from Solar Components
      • Thermal Indices
    • 2 :: Visualize Data
      • Hourly Plot
      • Monthly Chart
      • Adaptive Chart
      • PMV Polygon
      • Psychrometric Chart
      • UTCI Polygon
      • Benefit Sky Matrix
      • Cumulative Sky Matrix
      • Sky Dome
      • SunPath
      • Radiation Dome
      • Radiation Rose
      • Wind Profile
      • Wind Rose
    • 3 :: Analyze Geometry
      • Direct Sun Hours
      • Incident Radiation
      • View Factors
      • View Percent
      • View Rose
      • Visibility Percent
      • Human to Sky Relation
      • Sky Mask
      • Solar Envelope
      • Surface Ray Tracing
      • Shade Benefit
      • Thermal Shade Benefit
      • Set Rhino Sun
      • View From Sun
      • Real Time Incident Radiation
    • 4 :: Extra
      • Color Range
      • FalseStartToggle
      • Generate Point Grid
      • ImageViewer
      • Legend Parameters
      • Mesh Threshold Selector
      • Preview VisualizationSet
      • Spatial Heatmap
      • Capture View
      • Legend 2D Parameters
      • Orient to Camera
      • Set View
      • To IP
      • To SI
      • To Unit
      • Unit Converter
      • Adaptive Comfort Parameters
      • PMV Comfort Parameters
      • Passive Strategies
      • Solar Body Parameters
      • Dump Data
      • Load Data
      • Open Directory
      • Open File
      • Compass
      • Magnetic to True North
      • Activities Met List
      • Area Aggregate
      • Area Normalize
      • Clothing List
      • Construct Matrix
      • Create Legend
      • Deconstruct Matrix
      • Deconstruct VisualizationSet
      • Dump VisualizationSet
      • Filter by Normal
      • Legend Parameters Categorized
      • Mesh to Hatch
      • PET Body Parameters
      • Passive Strategy Parameters
      • Screen Oriented Text
      • SortByLayers
      • Time Aggregate
      • Time Rate of Change
      • UTCI Comfort Parameters
    • 5 :: Version
      • Sync Grasshopper File
      • Versioner
      • Export UserObject
      • Legacy Updater
Powered by GitBook
On this page
  • Inputs
  • Outputs
Export as PDF
  1. Components
  2. 3 :: Analyze Geometry

Visibility Percent

PreviousView RoseNextHuman to Sky Relation

Last updated 1 year ago

-

Evaluate the percent visibility from geometry to a specific set of points.

Such visibility calculations can be used to understand the portions of a building facade that can see a skyline or landmark when used on the outdoors. When used on the indoors, they can evaluate the spectator view of a stage, screen, or other point of interest.

Inputs

  • view_points [Required]

A list of points that characterize an area of interest to which visibility is being evaluated. If the area of interest is more like a surface than an individual point, the "LB Generate Point Grid" component can be used to obtain a list of points that are evenly distributed over the surface.

  • pt_weights

An optional list of numbers that align with the _view_points and represent weights of importance for each point. Weighted values should be between 0 and 1 and should be closer to 1 if a certain point is more important. The default value for all points is 0, which means they all have an equal importance.

  • geometry [Required]

Rhino Breps and/or Rhino Meshes for which visibility analysis will be conducted. If Breps are input, they will be subdivided using the _grid_size to yeild individual points at which analysis will occur. If a Mesh is input, visibility analysis analysis will be performed for each face of this mesh instead of subdividing it.

  • context

Rhino Breps and/or Rhino Meshes representing context geometry that can block visibility from the test _geometry.

  • grid_size [Required]

A positive number in Rhino model units for the size of grid cells at which the input _geometry will be subdivided for direct sun analysis. The smaller the grid size, the higher the resolution of the analysis and the longer the calculation will take. So it is recommended that one start with a large value here and decrease the value as needed. However, the grid size should usually be smaller than the dimensions of the smallest piece of the geometry and context in order to yield meaningful results.

  • offset_dist

A number for the distance to move points from the surfaces of the input _geometry. Typically, this should be a small positive number to ensure points are not blocked by the mesh. (Default: 10 cm in the equivalent Rhino Model units).

  • max_dist

An optional number to set the maximum distance beyond which the end_points are no longer considered visible by the start_points. If None, points with an unobstructed view to one another will be considered visible no matter how far they are from one another.

  • geo_block

Set to "True" to count the input _geometry as opaque and set to "False" to discount the geometry from the calculation and only look at context that blocks the visibility. (Default: True)

  • legend_par

Optional legend parameters from the "LB Legend Parameters" that will be used to customize the display of the results.

  • cpu_count

An integer to set the number of CPUs used in the execution of the intersection calculation. If unspecified, it will automatically default to one less than the number of CPUs currently available on the machine or 1 if only one processor is available.

  • run [Required]

Set to "True" to run the component and perform visibility analysis of the input _geometry.

Outputs

  • report

...

  • points

The grid of points on the test _geometry that are be used to perform the visibility analysis.

  • results

A list of numbers that aligns with the points. Each number indicates the percentage of the _view_points that are not blocked by context geometry.

  • mesh

A colored mesh of the test _geometry representing the percentage of the input _geometry's visibility that is not blocked by context.

  • legend

A legend showing the number of hours that correspond to the colors of the mesh.

  • title

A text object for the study title.

  • int_mtx

A Matrix object that can be connected to the "LB Deconstruct Matrix" component to obtain detailed point-by-point results of the study. Each sub-list (aka. branch of the Data Tree) represents one of the geometry points used for analysis. The length of each sub-list matches the number of _view_points used for the analysis. Each value in the sub-list is either a "1", indicating that the vector is visible for that vector, or a "0", indicating that the vector is not visible for that vector.

[source code]