voxcity 0.5.10__py3-none-any.whl → 0.5.11__py3-none-any.whl

voxcity/generator.py

@@ -689,6 +689,14 @@ def get_voxcity(rectangle_vertices, building_source, land_cover_source, canopy_h
         voxcity_grid_vis[-1, -1, -1] = -99  # Add marker to fix camera location and angle of view
         visualize_3d_voxel(voxcity_grid_vis, voxel_size=meshsize, save_path=kwargs["voxelvis_img_save_path"])
 
+    # Save all data if a save path is provided
+    save_voxcity = kwargs.get("save_voxctiy_data", True)
+    if save_voxcity:
+        save_path = kwargs.get("save_data_path", f"{output_dir}/voxcity_data.pkl")
+        save_voxcity_data(save_path, voxcity_grid, building_height_grid, building_min_height_grid, 
+                         building_id_grid, canopy_height_grid, land_cover_grid, dem_grid, 
+                         building_gdf, meshsize, rectangle_vertices)
+    
     return voxcity_grid, building_height_grid, building_min_height_grid, building_id_grid, canopy_height_grid, land_cover_grid, dem_grid, building_gdf
 
 def get_voxcity_CityGML(rectangle_vertices, land_cover_source, canopy_height_source, meshsize, url_citygml=None, citygml_path=None, **kwargs):
@@ -817,6 +825,14 @@ def get_voxcity_CityGML(rectangle_vertices, land_cover_source, canopy_height_sou
     # Generate 3D voxel grid
     voxcity_grid = create_3d_voxel(building_height_grid, building_min_height_grid, building_id_grid, land_cover_grid, dem_grid, canopy_height_grid, meshsize, land_cover_source)
 
+    # Save all data if a save path is provided
+    save_voxcity = kwargs.get("save_voxctiy_data", True)
+    if save_voxcity:
+        save_path = kwargs.get("save_data_path", f"{output_dir}/voxcity_data.pkl")
+        save_voxcity_data(save_path, voxcity_grid, building_height_grid, building_min_height_grid, 
+                         building_id_grid, canopy_height_grid, land_cover_grid, dem_grid, 
+                         building_gdf, meshsize, rectangle_vertices)
+    
     return voxcity_grid, building_height_grid, building_min_height_grid, building_id_grid, canopy_height_grid, land_cover_grid, dem_grid, filtered_buildings
 
 def replace_nan_in_nested(arr, replace_value=10.0):
@@ -844,4 +860,89 @@ def replace_nan_in_nested(arr, replace_value=10.0):
                             if isinstance(arr[i][j][k][l], float) and np.isnan(arr[i][j][k][l]):
                                 arr[i][j][k][l] = replace_value
     
-    return np.array(arr, dtype=object)
+    return np.array(arr, dtype=object)
+
+def save_voxcity_data(output_path, voxcity_grid, building_height_grid, building_min_height_grid, 
+                     building_id_grid, canopy_height_grid, land_cover_grid, dem_grid, 
+                     building_gdf, meshsize, rectangle_vertices):
+    """Save voxcity data to a file for later loading.
+    
+    Args:
+        output_path: Path to save the data file
+        voxcity_grid: 3D voxel grid of the complete city model
+        building_height_grid: 2D grid of building heights
+        building_min_height_grid: 2D grid of minimum building heights
+        building_id_grid: 2D grid of building IDs
+        canopy_height_grid: 2D grid of tree canopy heights
+        land_cover_grid: 2D grid of land cover classifications
+        dem_grid: 2D grid of ground elevation
+        building_gdf: GeoDataFrame of building footprints and metadata
+        meshsize: Size of each grid cell in meters
+        rectangle_vertices: List of coordinates defining the area of interest
+    """
+    import pickle
+    import os
+    
+    # Create directory if it doesn't exist
+    os.makedirs(os.path.dirname(output_path), exist_ok=True)
+    
+    # Create a dictionary with all the data
+    data_dict = {
+        'voxcity_grid': voxcity_grid,
+        'building_height_grid': building_height_grid,
+        'building_min_height_grid': building_min_height_grid,
+        'building_id_grid': building_id_grid,
+        'canopy_height_grid': canopy_height_grid,
+        'land_cover_grid': land_cover_grid,
+        'dem_grid': dem_grid,
+        'building_gdf': building_gdf,
+        'meshsize': meshsize,
+        'rectangle_vertices': rectangle_vertices
+    }
+    
+    # Save the data to a file using pickle
+    with open(output_path, 'wb') as f:
+        pickle.dump(data_dict, f)
+    
+    print(f"Voxcity data saved to {output_path}")
+
+def load_voxcity_data(input_path):
+    """Load voxcity data from a saved file.
+    
+    Args:
+        input_path: Path to the saved data file
+        
+    Returns:
+        tuple: All the voxcity data components including:
+            - voxcity_grid: 3D voxel grid of the complete city model
+            - building_height_grid: 2D grid of building heights
+            - building_min_height_grid: 2D grid of minimum building heights
+            - building_id_grid: 2D grid of building IDs
+            - canopy_height_grid: 2D grid of tree canopy heights
+            - land_cover_grid: 2D grid of land cover classifications
+            - dem_grid: 2D grid of ground elevation
+            - building_gdf: GeoDataFrame of building footprints and metadata
+            - meshsize: Size of each grid cell in meters
+            - rectangle_vertices: List of coordinates defining the area of interest
+    """
+    import pickle
+    
+    # Load the data from the file
+    with open(input_path, 'rb') as f:
+        data_dict = pickle.load(f)
+    
+    print(f"Voxcity data loaded from {input_path}")
+    
+    # Return all components as a tuple
+    return (
+        data_dict['voxcity_grid'],
+        data_dict['building_height_grid'],
+        data_dict['building_min_height_grid'],
+        data_dict['building_id_grid'],
+        data_dict['canopy_height_grid'],
+        data_dict['land_cover_grid'],
+        data_dict['dem_grid'],
+        data_dict['building_gdf'],
+        data_dict['meshsize'],
+        data_dict['rectangle_vertices']
+    )

{voxcity-0.5.10.dist-info → voxcity-0.5.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: voxcity
-Version: 0.5.10
+Version: 0.5.11
 Summary: voxcity is an easy and one-stop tool to output 3d city models for microclimate simulation by integrating multiple geospatial open-data
 Author-email: Kunihiko Fujiwara <kunihiko@nus.edu.sg>
 Maintainer-email: Kunihiko Fujiwara <kunihiko@nus.edu.sg>

{voxcity-0.5.10.dist-info → voxcity-0.5.11.dist-info}/RECORD

@@ -1,5 +1,5 @@
 voxcity/__init__.py,sha256=el9v3gfybHOF_GUYPeSOqN0-vCrTW0eU1mcvi0sEfeU,252
-voxcity/generator.py,sha256=Ae0dAqfrVMLmjeilO2oOm5s-TMPbnLo40Z4TFJaWf5A,42651
+voxcity/generator.py,sha256=qWe2LJsbY2_IYUuI99ZJ5_rRNJ8IQrEIdxND7azYd-M,47045
 voxcity/downloader/__init__.py,sha256=OgGcGxOXF4tjcEL6DhOnt13DYPTvOigUelp5xIpTqM0,171
 voxcity/downloader/citygml.py,sha256=R3DvsYJz_S5OPkeA71eEI2U7fBDLcpqdludV6gO1ihw,30305
 voxcity/downloader/eubucco.py,sha256=XCkkdEPNuWdrnuxzL80Ext37WsgiCiZGueb-aQV5rvI,14476
@@ -30,9 +30,9 @@ voxcity/utils/lc.py,sha256=RwPd-VY3POV3gTrBhM7TubgGb9MCd3nVah_G8iUEF7k,11562
 voxcity/utils/material.py,sha256=Vt3IID5Ft54HNJcEC4zi31BCPqi_687X3CSp7rXaRVY,5907
 voxcity/utils/visualization.py,sha256=jsKfUoRRW0yRCmJ03I7ESK1Tic_Xk1tcliw-8syr3Y0,87228
 voxcity/utils/weather.py,sha256=CFPtoqRTajwMRswswDChwQ3BW1cGsnA3orgWHgz7Ehg,26304
-voxcity-0.5.10.dist-info/licenses/AUTHORS.rst,sha256=m82vkI5QokEGdcHof2OxK39lf81w1P58kG9ZNNAKS9U,175
-voxcity-0.5.10.dist-info/licenses/LICENSE,sha256=s_jE1Df1nTPL4A_5GCGic5Zwex0CVaPKcAmSilxJPPE,1089
-voxcity-0.5.10.dist-info/METADATA,sha256=py17aZn67P-e2JouRMZVJqLFERDB-J7ccBRJ7Dc_9Jw,25885
-voxcity-0.5.10.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-voxcity-0.5.10.dist-info/top_level.txt,sha256=00b2U-LKfDllt6RL1R33MXie5MvxzUFye0NGD96t_8I,8
-voxcity-0.5.10.dist-info/RECORD,,
+voxcity-0.5.11.dist-info/licenses/AUTHORS.rst,sha256=m82vkI5QokEGdcHof2OxK39lf81w1P58kG9ZNNAKS9U,175
+voxcity-0.5.11.dist-info/licenses/LICENSE,sha256=s_jE1Df1nTPL4A_5GCGic5Zwex0CVaPKcAmSilxJPPE,1089
+voxcity-0.5.11.dist-info/METADATA,sha256=hK1HErMdMRO_166kD7r3ZeGGT9pZq6Ok54PbcwpCYJA,25885
+voxcity-0.5.11.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+voxcity-0.5.11.dist-info/top_level.txt,sha256=00b2U-LKfDllt6RL1R33MXie5MvxzUFye0NGD96t_8I,8
+voxcity-0.5.11.dist-info/RECORD,,