DHART: Automated analysis of the built environment

Contents

To get started from the very beginning with this package, please follow the installation guide below.

• Setup
  • Installation
    • Check Basic Requirements
    • Setup
  • Contributing and Testing
    • Check dependencies
    • Building Documentation
    • Testing
• Getting Started
  • Ray Casting
• Examples
  • Ray Casting
  • Generating a Graph
    • Generate a Graph
    • Get a CSR of the Graph
    • Visualize the Graph
      • Overview
      • Basic Graph Visualization
      • Slope Settings
      • Determining Minimum Connections
  • Path Planning
    • Basic Search on A Graph
    • Visualize a Path
      • Overview
    • Limit a Path
      • Overview
    • Path Plan with Different Costs
      • Overview
    • Path Plan with Custom Costs
      • Overview
  • Spatial View Analysis
    • Visualize Spatial View
      • Overview
    • Visualize Spatial View Points
      • Overview
      • Example
  • Visibility Analysis
    • Visualize a Visbility Graph Connections
      • Overview
    • Visibility Graph Grouping
      • Overview
• Code Reference
  • Modules
    • dhart.geometry
      • Provides functions for manipulating and loading geometry.
      • dhart.geometry.CommonRotations
        • CommonRotations
      • dhart.geometry.MeshInfo
        • MeshInfo
        • dhart.geometry.MeshInfo.Rotate
        • dhart.geometry.MeshInfo.SetupVertAndIndexArrays
      • dhart.geometry.OBJGroupType
        • OBJGroupType
      • dhart.geometry.ConstructPlane
        • ConstructPlane()
      • dhart.geometry.Flatten
        • Flatten()
      • dhart.geometry.LoadOBJ
        • LoadOBJ()
    • dhart.graphgenerator
      • Provides a function to generate a graph on accessible terrain
      • dhart.graphgenerator.GenerateGraph
        • GenerateGraph()
    • dhart.pathfinding
      • Find paths between points within a graph
      • dhart.pathfinding.Path
        • Path
        • dhart.pathfinding.Path.GetPointers
        • dhart.pathfinding.Path.delete_fp
      • dhart.pathfinding.PathMemberStruct
        • PathMemberStruct
      • dhart.pathfinding.ConvertNodesToIds
        • ConvertNodesToIds()
      • dhart.pathfinding.DijkstraFindAllShortestPaths
        • DijkstraFindAllShortestPaths()
      • dhart.pathfinding.DijkstraShortestPath
        • DijkstraShortestPath()
      • dhart.pathfinding.calculate_distance_and_predecessor
        • calculate_distance_and_predecessor()
    • dhart.raytracer
      • Perform efficent ray intersections with geometry.
      • dhart.raytracer.EmbreeBVH
        • EmbreeBVH
        • dhart.raytracer.EmbreeBVH.AddMesh
      • dhart.raytracer.RayResultList
        • RayResultList
        • dhart.raytracer.RayResultList.GetPointers
        • dhart.raytracer.RayResultList.delete_fp
      • dhart.raytracer.ResultStruct
        • ResultStruct
      • dhart.raytracer.Intersect
        • Intersect()
      • dhart.raytracer.IntersectDistanceDouble
        • IntersectDistanceDouble()
      • dhart.raytracer.IntersectForPoint
        • IntersectForPoint()
      • dhart.raytracer.IntersectOccluded
        • IntersectOccluded()
      • dhart.raytracer.isValidBVH
        • isValidBVH()
    • dhart.spatialstructures
      • Store relationhships between points in space
      • dhart.spatialstructures.CostAggregationType
        • CostAggregationType
      • dhart.spatialstructures.CostAlgorithmKeys
        • CostAlgorithmKeys
      • dhart.spatialstructures.Direction
        • Direction
      • dhart.spatialstructures.Edge
        • Edge
      • dhart.spatialstructures.EdgeSumArray
        • EdgeSumArray
        • dhart.spatialstructures.EdgeSumArray.GetPointers
        • dhart.spatialstructures.EdgeSumArray.delete_fp
      • dhart.spatialstructures.Graph
        • Graph
        • dhart.spatialstructures.Graph.AddEdgeToGraph
        • dhart.spatialstructures.Graph.AggregateEdgeCosts
        • dhart.spatialstructures.Graph.Clear
        • dhart.spatialstructures.Graph.CompressToCSR
        • dhart.spatialstructures.Graph.ConvertToLists
        • dhart.spatialstructures.Graph.GetEdgeCost
        • dhart.spatialstructures.Graph.GetNodeID
        • dhart.spatialstructures.Graph.NumNodes
        • dhart.spatialstructures.Graph.add_node_attributes
        • dhart.spatialstructures.Graph.attrs_to_costs
        • dhart.spatialstructures.Graph.clear_node_attribute
        • dhart.spatialstructures.Graph.getNodes
        • dhart.spatialstructures.Graph.get_closest_nodes
        • dhart.spatialstructures.Graph.get_closest_points
        • dhart.spatialstructures.Graph.get_node_attributes
        • dhart.spatialstructures.Graph.get_node_points
      • dhart.spatialstructures.NodeList
        • NodeList
        • dhart.spatialstructures.NodeList.GetPointers
        • dhart.spatialstructures.NodeList.delete_fp
      • dhart.spatialstructures.NodeStruct
        • NodeStruct
      • dhart.spatialstructures.CalculateCrossSlope
        • CalculateCrossSlope()
      • dhart.spatialstructures.CalculateEnergyExpenditure
        • CalculateEnergyExpenditure()
      • dhart.spatialstructures.CreateListOfNodeStructs
        • CreateListOfNodeStructs()
    • dhart.viewanalysis
      • Determine visual variety from points within the environment
      • dhart.viewanalysis.AggregationType
        • AggregationType
      • dhart.viewanalysis.ViewAnalysisAggregates
        • ViewAnalysisAggregates
        • dhart.viewanalysis.ViewAnalysisAggregates.GetPointers
        • dhart.viewanalysis.ViewAnalysisAggregates.delete_fp
      • dhart.viewanalysis.ViewAnalysisDirections
        • ViewAnalysisDirections
        • dhart.viewanalysis.ViewAnalysisDirections.GetPointers
        • dhart.viewanalysis.ViewAnalysisDirections.delete_fp
      • dhart.viewanalysis.SphericalViewAnalysis
        • SphericalViewAnalysis()
      • dhart.viewanalysis.SphericalViewAnalysisAggregate
        • SphericalViewAnalysisAggregate()
      • dhart.viewanalysis.SphericallyDistributeRays
        • SphericallyDistributeRays()
    • dhart.visibilitygraph
      • Determine which locations are visible from other locations.
      • dhart.visibilitygraph.VisibilityGraphAllToAll
        • VisibilityGraphAllToAll()
      • dhart.visibilitygraph.VisibilityGraphGroupToGroup
        • VisibilityGraphGroupToGroup()
      • dhart.visibilitygraph.VisibilityGraphUndirectedAllToAll
        • VisibilityGraphUndirectedAllToAll()
    • Main Module Methods
      • get_sample_model()
• Internal API Documentation
  • API Overview
  • Native Functions to C Interface
    • Main Module
      • ConvertPointsToArray()
      • GetStringPtr()
      • convert_strings_to_array()
      • getDLLHandle()
      • FileNotFoundException
      • HFException
      • InvalidCostOperation
      • InvalidOBJException
      • LogicError
      • MissingDependencyException
      • OutOfRangeException
      • HF_STATUS
      • NativeNumpyLike
        • NativeNumpyLike.array
        • NativeNumpyLike.GetPointers()
        • NativeNumpyLike.__init__()
    • Graph Generator
      • GenerateGraph()
    • Geometry
      • C_GetMeshID()
      • C_GetMeshName()
      • C_GetMeshVertsAndTris()
      • CreateMesh()
      • CreateOBJ()
      • DestroyMeshInfo()
    • Path Finding
      • C_DestroyPath()
      • C_FindAllPaths()
      • C_FindPath()
      • C_FindPaths()
      • c_calculate_distance_and_predecessor()
    • Raytracer
      • C_AddMeshes()
      • C_PreciseIntersection()
      • CastMultipleOriginsOneDirection()
      • CastMultipleRays()
      • CastMultipleRaysDistance()
      • CastOcclusionRays()
      • CastOneOriginMultipleDirections()
      • CastRay()
      • CreateRayTracer()
      • DestroyRayTracer()
    • Spatial Structures
      • C_AddEdgeFromNodeIDs()
      • C_AddEdgeFromNodes()
      • C_AggregateEdgeCosts()
      • C_AttrsToCosts()
      • C_ClearGraph()
      • C_CreateGraph()
      • C_GetCSRPtrs()
      • C_GetEdgeCost()
      • C_GetNodeID()
      • C_NumNodes()
      • DestroyGraph()
      • DestroyNodes()
      • GetEdgesForNode()
      • GetNodesFromGraph()
      • SizeOfNodeVector()
      • c_add_node_attributes()
      • c_clear_node_attribute()
      • c_get_node_attributes()
    • View Analysis
      • C_SphericalViewAnalysis()
      • C_SphericalViewAnalysisAggregate()
    • Visibility Graph
      • C_VisibilityGraphAllToAll()
      • C_VisibilityGraphAlltoAllUndirected()
      • C_VisibilityGraphGroupToGroup()

Indices and tables

• Index

• Module Index

• Search Page