Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
VoxCity Documentation
Light Logo Dark Logo
VoxCity Documentation

Getting Started:

  • API Reference
    • voxcity
      • voxcity.downloader
        • voxcity.downloader.citygml
        • voxcity.downloader.eubucco
        • voxcity.downloader.gba
        • voxcity.downloader.gee
        • voxcity.downloader.mbfp
        • voxcity.downloader.ocean
        • voxcity.downloader.oemj
        • voxcity.downloader.osm
        • voxcity.downloader.overture
        • voxcity.downloader.utils
      • voxcity.errors
        • voxcity.errors.VoxCityError
        • voxcity.errors.ConfigurationError
        • voxcity.errors.DownloaderError
        • voxcity.errors.ProcessingError
        • voxcity.errors.VisualizationError
      • voxcity.exporter
        • voxcity.exporter.cityles
          • voxcity.exporter.cityles.CityLesExporter
        • voxcity.exporter.envimet
          • voxcity.exporter.envimet.EnvimetExporter
        • voxcity.exporter.magicavoxel
          • voxcity.exporter.magicavoxel.MagicaVoxelExporter
        • voxcity.exporter.netcdf
          • voxcity.exporter.netcdf.NetCDFExporter
        • voxcity.exporter.obj
          • voxcity.exporter.obj.OBJExporter
        • voxcity.exporter.EnvimetExporter
        • voxcity.exporter.MagicaVoxelExporter
        • voxcity.exporter.OBJExporter
        • voxcity.exporter.CityLesExporter
        • voxcity.exporter.NetCDFExporter
        • voxcity.exporter.Exporter
      • voxcity.generator
        • voxcity.generator.api
        • voxcity.generator.grids
        • voxcity.generator.io
        • voxcity.generator.pipeline
          • voxcity.generator.pipeline.VoxCityPipeline
          • voxcity.generator.pipeline.LandCoverSourceStrategy
          • voxcity.generator.pipeline.DefaultLandCoverStrategy
          • voxcity.generator.pipeline.LandCoverSourceFactory
          • voxcity.generator.pipeline.BuildingSourceStrategy
          • voxcity.generator.pipeline.DefaultBuildingSourceStrategy
          • voxcity.generator.pipeline.BuildingSourceFactory
          • voxcity.generator.pipeline.CanopySourceStrategy
          • voxcity.generator.pipeline.StaticCanopyStrategy
          • voxcity.generator.pipeline.SourceCanopyStrategy
          • voxcity.generator.pipeline.OSMCanopyStrategy
          • voxcity.generator.pipeline.CanopySourceFactory
          • voxcity.generator.pipeline.DemSourceStrategy
          • voxcity.generator.pipeline.FlatDemStrategy
          • voxcity.generator.pipeline.SourceDemStrategy
          • voxcity.generator.pipeline.DemSourceFactory
        • voxcity.generator.update
        • voxcity.generator.voxelizer
          • voxcity.generator.voxelizer.Voxelizer
        • voxcity.generator.Voxelizer
        • voxcity.generator.VoxCityPipeline
      • voxcity.geoprocessor
        • voxcity.geoprocessor.conversion
        • voxcity.geoprocessor.draw
          • voxcity.geoprocessor.draw.edit_building
          • voxcity.geoprocessor.draw.edit_landcover
          • voxcity.geoprocessor.draw.edit_tree
          • voxcity.geoprocessor.draw.polygon
          • voxcity.geoprocessor.draw.rectangle
        • voxcity.geoprocessor.heights
        • voxcity.geoprocessor.io
        • voxcity.geoprocessor.merge_utils
        • voxcity.geoprocessor.mesh
        • voxcity.geoprocessor.network
        • voxcity.geoprocessor.overlap
        • voxcity.geoprocessor.raster
          • voxcity.geoprocessor.raster.buildings
          • voxcity.geoprocessor.raster.canopy
          • voxcity.geoprocessor.raster.core
          • voxcity.geoprocessor.raster.export
          • voxcity.geoprocessor.raster.landcover
          • voxcity.geoprocessor.raster.raster
        • voxcity.geoprocessor.selection
        • voxcity.geoprocessor.surface_meta
        • voxcity.geoprocessor.utils
      • voxcity.io
      • voxcity.models
        • voxcity.models.GridMetadata
        • voxcity.models.BuildingGrid
        • voxcity.models.LandCoverGrid
        • voxcity.models.DemGrid
        • voxcity.models.VoxelGrid
        • voxcity.models.CanopyGrid
        • voxcity.models.VoxCity
        • voxcity.models.PipelineConfig
        • voxcity.models.MeshModel
        • voxcity.models.MeshCollection
      • voxcity.simulator
        • voxcity.simulator.common
          • voxcity.simulator.common.coordinates
          • voxcity.simulator.common.geometry
          • voxcity.simulator.common.raytracing
        • voxcity.simulator.solar
          • voxcity.simulator.solar.integration
          • voxcity.simulator.solar.kernels
          • voxcity.simulator.solar.radiation
          • voxcity.simulator.solar.sky
          • voxcity.simulator.solar.temporal
        • voxcity.simulator.utils
        • voxcity.simulator.view
        • voxcity.simulator.visibility
          • voxcity.simulator.visibility.landmark
          • voxcity.simulator.visibility.view
      • voxcity.simulator_gpu
        • voxcity.simulator_gpu.core
          • voxcity.simulator_gpu.core.Rays
          • voxcity.simulator_gpu.core.HitRecord
        • voxcity.simulator_gpu.domain
          • voxcity.simulator_gpu.domain.Domain
          • voxcity.simulator_gpu.domain.Surfaces
        • voxcity.simulator_gpu.init_taichi
        • voxcity.simulator_gpu.raytracing
        • voxcity.simulator_gpu.solar
          • voxcity.simulator_gpu.solar.core
            • voxcity.simulator_gpu.solar.core.Rays
            • voxcity.simulator_gpu.solar.core.HitRecord
          • voxcity.simulator_gpu.solar.csf
            • voxcity.simulator_gpu.solar.csf.CSFCalculator
          • voxcity.simulator_gpu.solar.domain
            • voxcity.simulator_gpu.solar.domain.Domain
            • voxcity.simulator_gpu.solar.domain.Surfaces
          • voxcity.simulator_gpu.solar.epw
            • voxcity.simulator_gpu.solar.epw.EPWLocation
            • voxcity.simulator_gpu.solar.epw.EPWSolarData
          • voxcity.simulator_gpu.solar.integration
            • voxcity.simulator_gpu.solar.integration.building
            • voxcity.simulator_gpu.solar.integration.caching
              • voxcity.simulator_gpu.solar.integration.caching.LandCoverAlbedo
              • voxcity.simulator_gpu.solar.integration.caching.VoxCityDomainResult
              • voxcity.simulator_gpu.solar.integration.caching.CachedRadiationModel
              • voxcity.simulator_gpu.solar.integration.caching.CachedBuildingRadiationModel
              • voxcity.simulator_gpu.solar.integration.caching.CachedGPURayTracer
            • voxcity.simulator_gpu.solar.integration.ground
            • voxcity.simulator_gpu.solar.integration.utils
              • voxcity.simulator_gpu.solar.integration.utils.ArrayWithMetadata
            • voxcity.simulator_gpu.solar.integration.volumetric
            • voxcity.simulator_gpu.solar.integration.ArrayWithMetadata
          • voxcity.simulator_gpu.solar.mask
          • voxcity.simulator_gpu.solar.radiation
            • voxcity.simulator_gpu.solar.radiation.RadiationConfig
            • voxcity.simulator_gpu.solar.radiation.RadiationModel
          • voxcity.simulator_gpu.solar.raytracing
            • voxcity.simulator_gpu.solar.raytracing.RayTracer
          • voxcity.simulator_gpu.solar.reflection
            • voxcity.simulator_gpu.solar.reflection.OptimizedReflectionSolver
          • voxcity.simulator_gpu.solar.sky
            • voxcity.simulator_gpu.solar.sky.SkyPatches
            • voxcity.simulator_gpu.solar.sky.BinnedSolarData
          • voxcity.simulator_gpu.solar.solar
            • voxcity.simulator_gpu.solar.solar.SolarPosition
            • voxcity.simulator_gpu.solar.solar.SolarCalculator
          • voxcity.simulator_gpu.solar.svf
            • voxcity.simulator_gpu.solar.svf.SVFCalculator
          • voxcity.simulator_gpu.solar.volumetric
            • voxcity.simulator_gpu.solar.volumetric.VolumetricFluxMode
            • voxcity.simulator_gpu.solar.volumetric.VolumetricFluxCalculator
        • voxcity.simulator_gpu.visibility
          • voxcity.simulator_gpu.visibility.geometry
            • voxcity.simulator_gpu.visibility.geometry.RayDirectionField
          • voxcity.simulator_gpu.visibility.integration
          • voxcity.simulator_gpu.visibility.landmark
            • voxcity.simulator_gpu.visibility.landmark.LandmarkVisibilityCalculator
            • voxcity.simulator_gpu.visibility.landmark.SurfaceLandmarkVisibilityCalculator
          • voxcity.simulator_gpu.visibility.view
            • voxcity.simulator_gpu.visibility.view.ViewCalculator
            • voxcity.simulator_gpu.visibility.view.SurfaceViewFactorCalculator
          • voxcity.simulator_gpu.visibility.workspace
            • voxcity.simulator_gpu.visibility.workspace.ViewWorkspaceKey
            • voxcity.simulator_gpu.visibility.workspace.SurfaceViewWorkspaceKey
            • voxcity.simulator_gpu.visibility.workspace.ViewWorkspace
            • voxcity.simulator_gpu.visibility.workspace.SurfaceViewWorkspace
          • voxcity.simulator_gpu.visibility.ViewCalculator
          • voxcity.simulator_gpu.visibility.SurfaceViewFactorCalculator
          • voxcity.simulator_gpu.visibility.LandmarkVisibilityCalculator
          • voxcity.simulator_gpu.visibility.SurfaceLandmarkVisibilityCalculator
      • voxcity.utils
        • voxcity.utils.classes
        • voxcity.utils.lc
        • voxcity.utils.logging
        • voxcity.utils.material
        • voxcity.utils.orientation
        • voxcity.utils.projector
          • voxcity.utils.projector.GridGeom
          • voxcity.utils.projector.GridProjector
        • voxcity.utils.shape
        • voxcity.utils.weather
          • voxcity.utils.weather.epw
          • voxcity.utils.weather.files
          • voxcity.utils.weather.onebuilding
        • voxcity.utils.zoning
        • voxcity.utils.GridGeom
        • voxcity.utils.GridProjector
      • voxcity.visualizer
        • voxcity.visualizer.builder
          • voxcity.visualizer.builder.MeshBuilder
        • voxcity.visualizer.grids
        • voxcity.visualizer.maps
        • voxcity.visualizer.palette
        • voxcity.visualizer.renderer
          • voxcity.visualizer.renderer.PyVistaRenderer
        • voxcity.visualizer.renderer_gpu
          • voxcity.visualizer.renderer_gpu.GPURenderer
        • voxcity.visualizer.MeshBuilder
        • voxcity.visualizer.PyVistaRenderer

Tutorial:

  • VoxCity Tutorial Notebooks
    • πŸ™οΈ VoxCity Quick Start Guide
    • πŸ™οΈ VoxCity Complete Demo
    • πŸ“¦ Step 1: Prepare Environment
    • πŸ“ Step 2: Define Target Area
    • βš™οΈ Step 3: Configure Data Sources
    • πŸ—οΈ Step 4: Generate 3D Voxel Model
    • πŸ’Ύ Step 5: Export to Different Formats
    • Step6 Urban simulations
    • 6.1. Solar radiation
    • 6.3. Landmark visibility
    • πŸ—‚οΈ VoxCity Data Sources Guide
    • 🌳 VoxCity View Index Analysis
    • β˜€οΈ VoxCity Solar Irradiance Analysis
    • πŸ›οΈ VoxCity Landmark Visibility Analysis
    • 🎨 VoxCity 3D Visualization
    • πŸ“¦ VoxCity OBJ Export
    • ENVI-met Export Demo

Project Information:

  • ======= History
  • ============ Contributing
  • ==================================== Contributor Covenant Code of Conduct
  • References
Back to top
View this page

voxcity.generator.pipelineΒΆ

ClassesΒΆ

VoxCityPipeline

LandCoverSourceStrategy

DefaultLandCoverStrategy

LandCoverSourceFactory

BuildingSourceStrategy

DefaultBuildingSourceStrategy

BuildingSourceFactory

CanopySourceStrategy

StaticCanopyStrategy

SourceCanopyStrategy

OSMCanopyStrategy

Canopy strategy that downloads individual tree data from OpenStreetMap.

CanopySourceFactory

DemSourceStrategy

FlatDemStrategy

SourceDemStrategy

DemSourceFactory

Next
voxcity.generator.pipeline.VoxCityPipeline
Previous
voxcity.generator.io
Copyright © 2024, Kunihiko Fujiwara
Made with Sphinx and @pradyunsg's Furo
On this page
  • voxcity.generator.pipeline
    • Classes