bridges 3.4.5.dev1__tar.gz → 3.4.6__tar.gz

{bridges-3.4.5.dev1/bridges.egg-info → bridges-3.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: bridges
-Version: 3.4.5.dev1
+Version: 3.4.6
 Summary: Bridging Real-world Infrastructure Designed to Goal-align, Engage, and Stimulate, an NSF TUES
 Home-page: https://github.com/BridgesUNCC/bridges-python
 Author: BRIDGES
@@ -15,6 +15,15 @@ Requires-Dist: requests>=2.21.0
 Requires-Dist: webcolors>=1.8.1
 Requires-Dist: python-socketio[client]>=4.3.0
 Requires-Dist: SPARQLWrapper>=1.8.4
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # bridges-python
 

{bridges-3.4.5.dev1 → bridges-3.4.6}/bridges/bar_chart.py

@@ -37,7 +37,7 @@ class BarChart:
         self._c_label = ""
         self._v_label = ""
         self._title = ""
-        self._sub_title = ""
+        self._subtitle = ""
         self._tt_suffix = ""
         self._orientation = "horizontal"
         self._series_data = []
@@ -63,18 +63,18 @@ class BarChart:
         self._title = plot_title
 
     @property
-    def sub_title(self) -> str:
+    def subtitle(self) -> str:
         """
         Subtitle of the plot
         """
-        return self._sub_title
+        return self._subtitle
 
-    @sub_title.setter
-    def sub_title(self, plot_sub_title: str) -> None:
+    @subtitle.setter
+    def subtitle(self, plot_sub_title: str) -> None:
         """
         Subtitle of the plot
         """
-        self._sub_title = plot_sub_title
+        self._subtitle = plot_sub_title
 
     @property
     def value_label(self) -> str:

{bridges-3.4.5.dev1 → bridges-3.4.6}/bridges/bridges.py

@@ -1,5 +1,6 @@
 from bridges.connector import *
 from bridges import ColorGrid
+from bridges.us_map import *
 import os
 
 import json
@@ -32,8 +33,8 @@ class Bridges:
     @date 2015, 2016, 2017, 2018, 2019, 2020, 2021
     """
 
-    _MaxTitleSize = 50
-    _MaxDescSize = 250
+    _MaxTitleSize = 200
+    _MaxDescSize = 1000
     _projection_options = {"cartesian", "albersusa", "equirectangular", "window"}
     _debug = False
     
@@ -171,13 +172,18 @@ class Bridges:
     def set_map(self, map_info:list):
         """
         This method serializes all the state and county objects in the map_info for sending to the server
+        
+        See tutorial at https://bridgesuncc.github.io/tutorials/Map.html
+
         :param map_info: is a list of state objects with their counties
         :return: none
         """
+        if isinstance(map_info, Map):
+            self.set_map_overlay(map_info.get_overlay())
+            self.set_coord_system_type(map_info.get_projection())
         self.map = map_info
 
 
-
     def post_visualization_link(self, flag:bool):
         """
         This method controls (with a flag) if the visualization url is printed to the console or not.
@@ -192,6 +198,8 @@ class Bridges:
         Returns:
             None
         """
+        if isinstance(self.ds_handle, Map):
+            self.set_map(self.ds_handle)
         ds_str = ""
 
         if self.vis_type == "Tree" or self.vis_type == "BinaryTree" or self.vis_type == "AVLTree" or\
@@ -212,7 +220,7 @@ class Bridges:
             "map_overlay": self._map_overlay,
             "element_label_flag": self._element_label_flag,
             "link_label_flag": self._link_label_flag,
-            "map": self.map,
+            "map": (self.map.get_map_representation() if isinstance(self.map, Map) else self.map),
         }
         if self.window is not None and len(self.window) == 4:
             ds_dict['window'] = self.window

{bridges-3.4.5.dev1 → bridges-3.4.6}/bridges/color.py

@@ -235,12 +235,28 @@ class Color(object):
         col_name = None
         if args:
             errorcondition = True
-            if len(args) == 1 and type(args[0]) == list:
-                self.red = args[0][0]
-                self.green = args[0][1]
-                self.blue = args[0][2]
-                self.alpha = args[0][3]
-                errorcondition=False
+            if len(args) == 1:
+                thetype = type(args[0])
+                if thetype == list:
+                    self.red = args[0][0]
+                    self.green = args[0][1]
+                    self.blue = args[0][2]
+                    self.alpha = args[0][3]
+                    errorcondition=False
+                elif thetype is str:
+                    col_name = args[0]
+                    try:
+                        web_color = webcolors.name_to_rgb(col_name)
+                        self.set_color(web_color.red, web_color.green, web_color.blue)
+                        errorcondition=False
+                    except ValueError:
+                        raise ValueError(col_name + " is not a valid color name")
+                elif thetype is Color:
+                    self.red = args[0].red
+                    self.green = args[0].green
+                    self.blue = args[0].blue
+                    self.alpha = args[0].alpha
+                    errorcondition = False
             if len(args) == 4 or len(args) == 3:
                 self.red = args[0]
                 self.green = args[1]
@@ -248,21 +264,16 @@ class Color(object):
                 if len(args) == 4:
                     self.alpha = args[3]
                 errorcondition = False
-            elif len(args) == 1:
-                if type(args[0]) is str:
-                    col_name = args[0]
-                    errorcondition=False
-                elif type(args[0]) is Color:
-                    self.red = args[0].red
-                    self.green = args[0].green
-                    self.blue = args[0].blue
-                    self.alpha = args[0].alpha
-                    errorcondition = False
             if errorcondition:
                 raise ValueError("To use Color constructor pass 3 RGB values and a float alpha value or a color name or a Color object")
         elif kwargs:
             if 'col_name' in kwargs:
                 col_name = kwargs['col_name']
+                try:
+                    web_color = webcolors.name_to_rgb(col_name)
+                    self.set_color(web_color.red, web_color.green, web_color.blue)
+                except ValueError:
+                    raise ValueError(col_name + " is not a valid color name")
             if 'r' in kwargs:
                 self.red = kwargs['r']
             if 'red' in kwargs:
@@ -280,12 +291,6 @@ class Color(object):
             if 'alpha' in kwargs:
                 self.alpha = kwargs['alpha']
 
-        if col_name is not None:
-            try:
-                web_color = webcolors.name_to_rgb(col_name)
-                self.set_color(web_color.red, web_color.green, web_color.blue)
-            except ValueError:
-                raise ValueError(col_name + " is not a valid color name")
 
     def get_byte_representation(self) -> list:
         """
@@ -298,14 +303,24 @@ class Color(object):
         b = self.blue
         a = round(255 * self.alpha)
 
-        bytebuffer = list()
-        bytebuffer.append(r)
-        bytebuffer.append(g)
-        bytebuffer.append(b)
-        bytebuffer.append(a)
-
+        bytebuffer = [r,g,b,a]
+        
         return bytebuffer
 
+    def write_byte_representation(self, bytebuffer: list[int]) -> None:
+        """
+        Writes the RGBA values as list of ints from 0-255
+        Assumes bytebuffer is a list of size 4
+        """
+        bytebuffer[0] = self.red
+        bytebuffer[1] = self.green
+        bytebuffer[2] = self.blue
+        bytebuffer[3] = round(255 * self.alpha)
+
+
+        
+
+    
     def __eq__(self, other):
         """deep equality check, by value of each RGBA value"""
         if not isinstance(other, self.__class__):
@@ -315,3 +330,12 @@ class Color(object):
                 self.green == other.green and
                 self.blue == other.blue and
                 self.alpha == other.alpha)
+
+    
+    def _get_representation(self):
+        '''
+        Should not be needed externally.
+        This is used internally to derive BRIDGES JSON representation for colors
+        '''
+        return [str(self.red), str(self.green),
+                str(self.blue), str(self.alpha)]

{bridges-3.4.5.dev1 → bridges-3.4.6}/bridges/color_grid.py

@@ -83,6 +83,7 @@ class ColorGrid(Grid):
         total_count = 0
         pos = 0
         last = self.grid[0][0]
+        colorbuffer = [0, 0, 0, 0]
 
         while pos < self.grid_size[0] * self.grid_size[1]:
             posY = pos / self.grid_size[1]
@@ -98,27 +99,23 @@ class ColorGrid(Grid):
                 else:
                     total_count += count
                     img_bytes.append(count-1)
-                    last = last.get_byte_representation()
-
-                    for k in range(len(last)):
-                        img_bytes.append(last[k])
+                    last.write_byte_representation(colorbuffer)
+                    img_bytes.extend(colorbuffer)
 
                     count = 1
                     last = current
             if count == 256:
                 total_count += count
                 img_bytes.append(count-1)
-                last = last.get_byte_representation()
-                for k in range(len(last)):
-                    img_bytes.append(last[k])
+                last.write_byte_representation(colorbuffer)
+                img_bytes.extend(colorbuffer)
                 count = 0
             pos += 1
         total_count += count
         if count > 0:
             img_bytes.append(count-1)
-            last = last.get_byte_representation()
-            for k in range(len(last)):
-                img_bytes.append(last[k])
+            last.write_byte_representation(colorbuffer)
+            img_bytes.extend(colorbuffer)
 
         if total_count != self.grid_size[0] * self.grid_size[1]:
             print("Something broke in getRLE construction")
@@ -132,14 +129,14 @@ class ColorGrid(Grid):
             bytearray: representing the colors of grid cells
         """
         img_bytes = bytearray()
+        colorbuffer = [0, 0, 0, 0]
         for i in range(self.grid_size[0]):
             if self.grid[i] is not None:
                 for j in range(self.grid_size[1]):
                     if self.grid[i][j] is not None:
                         color = self.grid[i][j]
-                        color = color.get_byte_representation()
-                        for k in range(len(color)):
-                            img_bytes.append(color[k])
+                        color.write_byte_representation(colorbuffer)
+                        img_bytes.extend(colorbuffer)
         return img_bytes
 
     def get_data_structure_representation(self) -> dict:

{bridges-3.4.5.dev1 → bridges-3.4.6}/bridges/data_src_dependent/cancer_incidence.py

@@ -12,7 +12,7 @@ class CancerIncidence:
     This object is generally not created by the user, to see how its created check 
     out bridges::data_src_dependent::data_source::get_cancer_incident_data()
       
-    http://www.cdc.gov/cancer/npcr/uscs/download_data.htm
+    https://www.cdc.gov/united-states-cancer-statistics/public-use/index.html
     Data: Courtesy of Corgis Datasets, 2017
    
     @author Kalpathi Subramanian

{bridges-3.4.5.dev1 → bridges-3.4.6}/bridges/data_src_dependent/data_source.py

@@ -22,8 +22,8 @@ from bridges.data_src_dependent.amenity import *
 from bridges.data_src_dependent.actor_movie_imdb import *
 from bridges.color_grid import ColorGrid
 from bridges.color import Color
-from bridges.data_src_dependent.state import *
-from bridges.data_src_dependent.county import *
+from bridges.data_src_dependent.us_state import *
+from bridges.data_src_dependent.us_county import *
 from SPARQLWrapper import SPARQLWrapper, JSON
 
 
@@ -229,8 +229,11 @@ def get_world_cities_data(**kwargs) -> List[City]:
     return wrapper
 
 
-def get_map(state_name = []):
-
+def get_us_map_county_data(state_name = [], view_counties = True):
+    '''
+    returns a list of USState objects.
+    See https://bridgesuncc.github.io/tutorials/Map.html on how to use these objects
+    '''
     wrapper = []
 
     url = "http://bridgesdata.herokuapp.com/api/us_map?state="
@@ -248,18 +251,33 @@ def get_map(state_name = []):
     state_info = r['data']
 
     for i in range(len(state_info)):
-        temp_state = State(state_info[i]['_id']["input"])
-        for j in range(len(state_info[i]['counties'])):
-            current_county = state_info[i]['counties'][j]
-            temp_state.counties.append(County(current_county['properties']['GEOID'],
-                                              current_county['properties']['FIPS_CODE'],
-                                              current_county['properties']['COUNTY_STATE_CODE'],
-                                              current_county['properties']['COUNTY_STATE_NAME']))
+        temp_state = USState(state_info[i]['_id']["input"])
+        temp_state._view_counties = view_counties
+        if view_counties:
+            for j in range(len(state_info[i]['counties'])):
+                current_county = state_info[i]['counties'][j]
+                temp_state.counties.append(USCounty(current_county['properties']['GEOID'],
+                                                    current_county['properties']['FIPS_CODE'],
+                                                    current_county['properties']['COUNTY_STATE_CODE'],
+                                                    current_county['properties']['COUNTY_STATE_NAME']))
         wrapper.append(temp_state)
 
     return wrapper
 
 
+all_states = ["Alabama", "Alaska", "Arizona", "Arkansas", "California", "Colorado", "Connecticut", "Delaware", "Florida", "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada", "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island", "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont", "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming"]
+
+def get_us_map_data():
+    '''
+    See https://bridgesuncc.github.io/tutorials/Map.html on how to use these objects
+    '''
+    return get_us_map_county_data(all_states, False)
+
+def get_all_us_map_county_data():
+    '''
+    See https://bridgesuncc.github.io/tutorials/Map.html on how to use these objects
+    '''
+    return get_us_map_county_data(all_states, True)
 
 def _parse_actor_movie_imdb(item) -> ActorMovieIMDB:
     """

bridges-3.4.5.dev1/bridges/data_src_dependent/county.py → bridges-3.4.6/bridges/data_src_dependent/us_county.py

@@ -1,15 +1,39 @@
+from bridges.color import *
 
+class USCounty:
+    """
+    @brief Class that holds US County information
 
-class County:
+    This object is used alongside with the USMap object. Each county
+    has a stroke color and fill color attributes. Each county has a geoid
+    and FIPS code for identification. The geoid is used as the key in the
+    USState object to effic
 
+    Each County object contains its county name, state name, geoid, fips code,
+    stroke color, stroke width, fill color, stroke color
+
+    A tutorial on how to use the these objects is available at:
+    https://bridgesuncc.github.io/tutorials/Map.html
+
+    @author Erik Saule, Kalpathi Subramanian
+    @date 12/30/24
+    """
     def __init__(self, id: str, code: str, county: str, state: str):
+        """
+        @brief Constructor with county related parameters
+
+        @param id  GeoId of the county
+        @param code  FIPS ID Code of the county
+        @param county name of county 
+        @param state   state containing county
+        """
         self._geoid = id
         self._fips_code = code
         self._county_name = county
         self._state_name = state
-        self._stroke_color = 'green'
+        self._stroke_color = Color('blue')
         self._stroke_width = 0.5
-        self._fill_color = 'blue'
+        self._fill_color = Color('red')
         self._hide = False
 
     @property

bridges-3.4.5.dev1/bridges/data_src_dependent/state.py → bridges-3.4.6/bridges/data_src_dependent/us_state.py

@@ -1,15 +1,30 @@
+from bridges.color import *
 
+class USState:
+    """
+    @brief Class for USState and its attributes
 
-class State:
+    Each State object contains its name, stroke color, stroke width, 
+    fill color, and a list of counties 
+    A tutorial on how to use the these objects is available at:
+    https://bridgesuncc.github.io/tutorials/Map.html
+
+    @author Erik Saule, Kalpathi Subramanian
+    @date  Last modified Dec 30, 2024
+    """
 
     def __init__(self, state: str):
+        """
+        @brief Constructor for a specific state
+
+        @param state sets default values for the state
+        """
         self._state_name = state
-        self._stroke_color = 'blue'
+        self._stroke_color = Color('red')
         self._counties = []
         self._view_counties = True
         self._stroke_width = 0.5
-        self._fill_color = 'blue'
-
+        self._fill_color = Color('blue')
 
     @property
     def state_name(self):

bridges-3.4.6/bridges/map.py

@@ -0,0 +1,15 @@
+
+class Map:
+    '''This is meant to be a base class for all map visualization'''
+    '''Likely never instantiated explicitly'''
+    def __init__(self):
+        pass
+
+    def get_projection(self):
+        return None
+	
+    def get_overlay(self):
+        return None
+
+    def get_map_representation(self):
+        return None

bridges-3.4.6/bridges/us_map.py

@@ -0,0 +1,104 @@
+from bridges.map import *
+
+class USMap(Map):
+    """
+    @brief This class provides an API to building, displaying and
+    manipulating  US maps and counties in BRIDGES
+
+    In the current implementation, we can draw a US map  with all state
+    boundaries, a map with all US state and county boundaries, or
+    specify a set of states  and display the state and/or county
+    boundaries.
+
+    Functions are provided to access each US state or county and color
+    its boundary or its interior using the stroke color  and fill color
+    functions. This lets us build map based applications where the fill
+    fill color can be used to represent different data attributes, such
+    population counts, election statistics or any attribute at the state
+    or county level.
+
+    See the Maps  tutorials for examples of the usage of the US Map API at
+    https://bridgesuncc.github.io/tutorials/Map.html
+
+    """
+    def get_projection(self):
+        return "albersusa"
+	
+    def get_overlay(self):
+        return True
+
+
+    def get_data_structure_type(self):
+        """
+        Getter for the data structure type as a JSON string
+        Returns
+            str: the data structure type
+        """
+        return "us_map"
+
+    def get_data_structure_representation(self):
+        """
+        Getter for the data structure's JSON representatoin
+        Returns:
+            str: the data structure representation
+        """
+        #This is only used to make a dummy data structure for use when
+        #the map is passed as a datastructure and not as an overlay
+        return {"map_dummy": True}
+
+    def _county_to_obj(self, co):
+        return {
+            "_geoid" : co.geoid,
+            "_fips_code" : co.fips_code,
+            "_county_name": co.county_name,
+            "_state_name": co.state_name,
+            "_stroke_color": co.stroke_color._get_representation(),
+            "_stroke_width": co.stroke_width,
+            "_fill_color": co.fill_color._get_representation(),
+            "_hide" : co.hide
+            
+        }
+    
+    def _state_to_obj(self, st):
+        return {
+            "_state_name" : st.state_name,
+            "_stroke_color" : st.stroke_color._get_representation(),
+            "_stroke_width": st.stroke_width,
+            "_fill_color": st.fill_color._get_representation(),
+            "_view_counties": st.view_counties,
+            "_counties": [self._county_to_obj(st.counties[i]) for i in range(0,len(st.counties)) ]
+        }
+    
+    def get_map_representation(self):
+        """
+        @brief gets the JSON representation of the map data
+
+        Uses functions to convert the state and country attributes to objects
+        before serialization into a JSON string
+        """
+        data = [ self._state_to_obj(self._states[i]) for i in range(0,len(self._states)) ]
+        
+        return data
+
+    def __init__(self,states = []):
+        """
+        @brief Constructor: creates an objecdt with the given state data
+
+        @param states state and county information for a set of states 
+        """
+        self._states = states
+
+    @property
+    def states(self):
+        '''
+        Returns a list of USState objects
+        '''
+        return self._states
+
+    @states.setter
+    def states(self, value):
+        '''
+        value: a list of USState objects
+        '''
+        self._states = value
+

bridges-3.4.6/bridges/world_map.py

@@ -0,0 +1,50 @@
+from bridges.map import *
+
+class WorldMap(Map):
+    """
+    @brief This class provides an API to displaying world maps in BRIDGES
+
+    See the Maps  tutorials for examples of the usage of the US Map API at
+    https://bridgesuncc.github.io/tutorials/Map.html
+
+    """
+    def get_projection(self):
+        return "equirectangular"
+	
+    def get_overlay(self):
+        return True
+
+
+    def get_data_structure_type(self):
+        """
+        Getter for the data structure type as a JSON string
+        Returns
+            str: the data structure type
+        """
+        return "world_map"
+
+    def get_data_structure_representation(self):
+        """
+        Getter for the data structure's JSON representatoin
+        Returns:
+            str: the data structure representation
+        """
+        #This is only used to make a dummy data structure for use when
+        #the map is passed as a datastructure and not as an overlay
+        return {"map_dummy": True}
+    
+    def get_map_representation(self):
+        """
+        @brief gets the JSON representation of the map data
+
+        Uses functions to convert the state and country attributes to objects
+        before serialization into a JSON string
+        """
+        
+        return "all"
+
+    def __init__(self):
+        """
+        @brief Constructor: creates an object
+
+        """

{bridges-3.4.5.dev1 → bridges-3.4.6/bridges.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: bridges
-Version: 3.4.5.dev1
+Version: 3.4.6
 Summary: Bridging Real-world Infrastructure Designed to Goal-align, Engage, and Stimulate, an NSF TUES
 Home-page: https://github.com/BridgesUNCC/bridges-python
 Author: BRIDGES
@@ -15,6 +15,15 @@ Requires-Dist: requests>=2.21.0
 Requires-Dist: webcolors>=1.8.1
 Requires-Dist: python-socketio[client]>=4.3.0
 Requires-Dist: SPARQLWrapper>=1.8.4
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # bridges-python
 

{bridges-3.4.5.dev1 → bridges-3.4.6}/bridges.egg-info/SOURCES.txt

@@ -42,6 +42,7 @@ bridges/keypress_listener.py
 bridges/light.py
 bridges/line_chart.py
 bridges/link_visualizer.py
+bridges/map.py
 bridges/mesh.py
 bridges/ml_element.py
 bridges/named_color.py
@@ -64,6 +65,8 @@ bridges/symbol_collection.py
 bridges/symbol_group.py
 bridges/text.py
 bridges/tree_element.py
+bridges/us_map.py
+bridges/world_map.py
 bridges.egg-info/PKG-INFO
 bridges.egg-info/SOURCES.txt
 bridges.egg-info/dependency_links.txt
@@ -74,7 +77,6 @@ bridges/data_src_dependent/actor_movie_imdb.py
 bridges/data_src_dependent/amenity.py
 bridges/data_src_dependent/cancer_incidence.py
 bridges/data_src_dependent/city.py
-bridges/data_src_dependent/county.py
 bridges/data_src_dependent/data_source.py
 bridges/data_src_dependent/earthquake_usgs.py
 bridges/data_src_dependent/elevation.py
@@ -87,5 +89,6 @@ bridges/data_src_dependent/osm.py
 bridges/data_src_dependent/reddit.py
 bridges/data_src_dependent/shakespeare.py
 bridges/data_src_dependent/song.py
-bridges/data_src_dependent/state.py
+bridges/data_src_dependent/us_county.py
+bridges/data_src_dependent/us_state.py
 bridges/data_src_dependent/world_cities.py

{bridges-3.4.5.dev1 → bridges-3.4.6}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="bridges",
-    version="3.4.5.dev1",
+    version="3.4.6",
     author="BRIDGES",
     author_email="bridges.uncc@gmail.com",
     description="Bridging Real-world Infrastructure Designed to Goal-align, Engage, and Stimulate, an NSF TUES",