Merge pull request #8 from ni1o1/0.3.3

update 0.3.3

Author: ni1o1

docs/source/analysis.rst

@@ -28,7 +28,7 @@ precision : number
 padding : number
     padding time before and after sunrise and sunset
 accuracy : number
-    size of grids.
+    size of grids. Produce vector polygons if set as `vector` 
 
 **Return**
 

docs/source/conf.py

@@ -22,8 +22,8 @@
 author = 'Qing Yu'
 
 # The full version, including alpha/beta/rc tags
-release = '0.3.2'
-version = '0.3.2'
+release = '0.3.3'
+version = '0.3.3'
 html_logo = "_static/logo-wordmark-light.png"
 html_favicon = '_static/logo.ico'
 # -- General configuration ---------------------------------------------------

example/Example1-building_shadow_analysis.ipynb

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="pybdshadow",
-    version="0.3.2",
+    version="0.3.3",
     author="Qing Yu",
     author_email="[email protected]",
     description="Python package to generate building shadow geometry",

setup.py

@@ -32,7 +32,7 @@
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 """
 
-__version__ = '0.3.2'
+__version__ = '0.3.3'
 __author__ = 'Qing Yu <[email protected]>'
 
 # module level doc-string

src/pybdshadow/__init__.py

@@ -28,7 +28,6 @@ def get_timeSeries(day, lon, lat, precision=3600, padding=1800):
     dates['date'] = dates['datetime'].apply(lambda r: str(r)[:19])
     return dates
 
-
 def cal_sunshine(buildings, day='2022-01-01', roof=False,grids =  gpd.GeoDataFrame(), accuracy=1, precision=3600, padding=0):
     '''
     Calculate the sunshine time in given date.
@@ -48,7 +47,7 @@ def cal_sunshine(buildings, day='2022-01-01', roof=False,grids =  gpd.GeoDataFra
     padding : number
         padding time before and after sunrise and sunset
     accuracy : number
-        size of grids.
+        size of grids. Produce vector polygons if set as `vector` 
         
     **Return**
 
@@ -69,12 +68,35 @@ def cal_sunshine(buildings, day='2022-01-01', roof=False,grids =  gpd.GeoDataFra
 
     # Generate shadow every 1800 s
     shadows = cal_sunshadows(buildings, dates=[day], precision=precision, padding=padding)
-    # Grid analysis of shadow cover duration(ground).
-    grids = cal_shadowcoverage(
-        shadows, buildings, grids = grids,roof=roof, precision=precision, accuracy=accuracy)
+    if accuracy == 'vector':
+        if roof:
+            shadows = shadows[shadows['type'] == 'roof'] 
+            shadows = bd_preprocess(shadows)
+            shadows = shadows.groupby(['date','type'])['geometry'].apply(
+                        lambda df: MultiPolygon(list(df)).buffer(0)).reset_index()
+            shadows = bd_preprocess(shadows)
+            shadows = count_overlapping_features(shadows)
+        else:
+            shadows = shadows[shadows['type'] == 'ground'] 
+            shadows = bd_preprocess(shadows)
+            shadows = shadows.groupby(['date','type'])['geometry'].apply(
+                        lambda df: MultiPolygon(list(df)).buffer(0)).reset_index()
+            shadows = bd_preprocess(shadows)
+            shadows = count_overlapping_features(shadows)
+
+        shadows['time'] = shadows['count']*precision
+        shadows['Hour'] = sunlighthour-shadows['time']/3600
+        shadows.loc[shadows['Hour']<=0,'Hour']=0
+        return shadows
+    else:
+        # Grid analysis of shadow cover duration(ground).
+        grids = cal_shadowcoverage(
+            shadows, buildings, grids = grids,roof=roof, precision=precision, accuracy=accuracy)
 
-    grids['Hour'] = sunlighthour-grids['time']/3600
-    return grids
+        grids['Hour'] = sunlighthour-grids['time']/3600
+        return grids
+
+    
 
 
 def cal_sunshadows(buildings, cityname='somecity', dates=['2022-01-01'], precision=3600, padding=0,
@@ -195,4 +217,17 @@ def cal_shadowcoverage(shadows_input, buildings, grids = gpd.GeoDataFrame(),roof
     grids = pd.merge(grids, gridcount, how='left')
     grids['time'] = grids['count'].fillna(0)*precision
 
-    return grids
+    return grids
+
+def count_overlapping_features(gdf):
+    import shapely
+    bounds = gdf.geometry.exterior.unary_union
+    new_polys = list(shapely.ops.polygonize(bounds))
+    new_gdf = gpd.GeoDataFrame(geometry=new_polys)
+    new_gdf['id'] = range(len(new_gdf))
+    new_gdf_centroid = new_gdf.copy()
+    new_gdf_centroid['geometry'] = new_gdf.centroid
+    overlapcount = gpd.sjoin(new_gdf_centroid,gdf)
+    overlapcount = overlapcount.groupby(['id'])['index_right'].count().rename('count').reset_index()
+    out_gdf = pd.merge(new_gdf,overlapcount)
+    return out_gdf

src/pybdshadow/analysis.py

@@ -34,4 +34,9 @@ def test_analysis(self):
         assert len(bdgrids)==1185
 
         grids = pybdshadow.cal_sunshine(buildings)
-        assert len(grids)==1882
+        assert len(grids)==1882
+                                 
+        sunshine = pybdshadow.cal_sunshine(buildings,accuracy='vector')
+        assert len(sunshine)==117
+        sunshine = pybdshadow.cal_sunshine(buildings,accuracy='vector',roof = True)
+        assert len(sunshine)==9