cubevis 1.0.14__py3-none-any.whl → 1.0.21__py3-none-any.whl

cubevis/private/apps/_createregion.py

@@ -35,7 +35,7 @@ from contextlib import asynccontextmanager
 from bokeh.layouts import row, column, grid
 from bokeh.plotting import show
 from bokeh.models import Button, CustomJS, TabPanel, Tabs, Spacer, Div, Dropdown
-from cubevis.toolbox import CubeMask, AppContext, RegionList
+from cubevis.toolbox import CubeMask, RegionList
 from cubevis.bokeh.utils import svg_icon
 from bokeh.io import curdoc
 from bokeh.io import reset_output as reset_bokeh_output
@@ -43,7 +43,7 @@ from bokeh.models.dom import HTML
 from bokeh.models.ui.tooltips import Tooltip
 from cubevis.utils import resource_manager, reset_resource_manager, is_interactive_jupyter
 from cubevis.data import casaimage
-from cubevis.bokeh.models import TipButton, Tip
+from cubevis.bokeh.models import TipButton, Tip, BokehAppContext
 from cubevis.utils import ContextMgrChain as CMC
 
 class CreateRegion:
@@ -141,12 +141,6 @@ class CreateRegion:
             path(s) to CASA image for which interactive regions will be drawn
         '''
 
-        ###
-        ### Create application context (which includes a temporary directory).
-        ### This sets the title of the plot.
-        ###
-        self._app_state = AppContext( 'Create Region' )
-
         ###
         ### widgets shared across image tabs (masking multiple images)
         ###
@@ -190,7 +184,7 @@ class CreateRegion:
 
             ###
             ### Use CubeMask init_script to set up a 'beforeunload' handler which will signal to
-            ### CubeMask that the app is shuting down (with 'document._cube_done( )'). It should then
+            ### CubeMask that the app is shuting down (with 'appstate.cube_done( )'). It should then
             ### send the final results to Python and then call the provided callback (the Promise
             ### resolve function).
             ###
@@ -231,7 +225,8 @@ class CreateRegion:
                 imdetails['gui']['slider'] = None
                 imdetails['gui']['goto'] = None
 
-        init_args = { 'sources': { } }
+        init_args = { 'status': self._fig['status'],
+                      'sources': { } }
         last_cube = None
         for k,v in self._region_state.items( ):
             init_args['sources'][k] = v['gui']['image']['src']
@@ -246,8 +241,9 @@ class CreateRegion:
                            acc[src.id] = img
                            if ( source == null ) source = src
                            return acc }}, sources, {{ }} )
-                       if ( source && document._cube_done )
-                       document._cube_done(
+                       const appstate = Bokeh.find.appState(status)
+                       if ( source && appstate?.cube_done )
+                       appstate.cube_done(
                            casalib.reduce(
                                (acc, poly) => {{
                                    acc[srcmap[poly.source.id]][poly.label] = {{
@@ -265,8 +261,8 @@ class CreateRegion:
         ## ImageDataSources (which is an element of CubeMask). This resulted in a circular
         ## reference when the plot was being rendered.
         ##
-        ## The document._cube_done callback ( `(msg) => { resolve(true); return false }` ) can
-        ## return `false` (indicating that the window should not be closed by _cube_done)
+        ## The appstate.cube_done callback ( `(msg) => { resolve(true); return false }` ) can
+        ## return `false` (indicating that the window should not be closed by cube_done)
         ## because the window is already being closed when this beforeunload callback
         ## is called.
         ##
@@ -385,7 +381,8 @@ class CreateRegion:
 
         self._image_control_tab_groups[imid] = result
         result.js_on_change( 'active', CustomJS( args=dict( ),
-                                                 code='''document._casa_last_control_tab = cb_obj.active''' ) )
+                                                 code='''const appstate = Bokeh.find.appState(cb_obj)
+                                                         appstate.last_control_tab = cb_obj.active''' ) )
         return result
 
     def _create_image_panel( self, imagetuple ):
@@ -421,17 +418,21 @@ class CreateRegion:
 
         image_tabs = Tabs( tabs=tab_panels, tabs_location='below', height_policy='max', width_policy='max' )
 
-        self._fig['layout'] = column(
-                                  row( self._fig['help'],
-                                       Spacer( height=self._ctrl_state['stop'].height, sizing_mode="scale_width" ),
-                                       Div( text="<div><b>status:</b></div>" ),
-                                       self._fig['status'],
-                                       self._ctrl_state['stop'], sizing_mode="scale_width" ),
-                                  row( image_tabs, height_policy='max', width_policy='max' ),
-                                  height_policy='max', width_policy='max' )
+        self._fig['layout'] = BokehAppContext(
+            column( row( self._fig['help'],
+                         Spacer( height=self._ctrl_state['stop'].height, sizing_mode="scale_width" ),
+                         Div( text="<div><b>status:</b></div>" ),
+                         self._fig['status'],
+                         self._ctrl_state['stop'], sizing_mode="scale_width" ),
+                    row( image_tabs, height_policy='max', width_policy='max' ),
+                    height_policy='max', width_policy='max' ),
+            app_state={                         ### while the state dictionary itself
+                'name': 'create region',        ### is used, these particular element
+                'initialized': True             ### are not currently used for anything
+            }, title='Create Region' )
 
         ###
-        ### Keep track of which image is currently active in document._casa_image_name (which is
+        ### Keep track of which image is currently active in appstate.image_name (which is
         ### initialized in self._js['initialize']). Also, update the current control sub-tab
         ### when the field main-tab is changed. An attempt to manage this all within the
         ### control sub-tabs using a reference to self._image_control_tab_groups from
@@ -441,11 +442,12 @@ class CreateRegion:
         ###
         image_tabs.js_on_change( 'active', CustomJS( args=dict( names=[ t[0] for t in self._region_state.items( ) ],
                                                                 itergroups=self._image_control_tab_groups ),
-                                                     code='''if ( ! hasprop(document,'_casa_last_control_tab') ) {
-                                                                 document._casa_last_control_tab = 0
+                                                     code='''const appstate = Bokeh.find.appState(cb_obj)
+                                                             if ( ! hasprop(appstate,'last_control_tab') ) {
+                                                                 appstate.last_control_tab = 0
                                                              }
-                                                             document._casa_image_name = names[cb_obj.active]
-                                                             itergroups[document._casa_image_name].active = document._casa_last_control_tab''' ) )
+                                                             appstate.image_name = names[cb_obj.active]
+                                                             itergroups[appstate.image_name].active = appstate.last_control_tab''' ) )
 
         # Change display type depending on runtime environment
         if is_interactive_jupyter( ):
@@ -456,7 +458,7 @@ class CreateRegion:
 ###         output_file(self._imagename+'_webpage/index.html')
             pass
 
-        show(self._fig['layout'])
+        self._fig['layout'].show( )
 
     def _asyncio_loop( self ):
         '''return the event loop which can be mixed in with an existing event loop

cubevis/private/apps/_interactiveclean.mustache

@@ -87,7 +87,8 @@ class InteractiveClean:
                                interpolation='nearest', ... )( ) )
         '''
         self._id = uuid4( )
+        self._ui.exclusion_mgr.set_mode("tab")
         context = exe.Context( exe.Mode.SYNC )
         bokeh_ui, exec_task = self._ui( context, self._id )
-        show(bokeh_ui)
+        bokeh_ui.show( )
         return context.execute( exec_task, self._id )

cubevis/private/apps/_interactiveclean.py

@@ -1849,7 +1849,8 @@ class InteractiveClean:
                                interpolation='nearest', ... )( ) )
         '''
         self._id = uuid4( )
+        self._ui.exclusion_mgr.set_mode("tab")
         context = exe.Context( exe.Mode.SYNC )
         bokeh_ui, exec_task = self._ui( context, self._id )
-        show(bokeh_ui)
+        bokeh_ui.show( )
         return context.execute( exec_task, self._id )

cubevis/private/apps/_interactivecleannotebook.mustache

@@ -43,6 +43,22 @@ from cubevis.utils import find_pkg, load_pkg
 from cubevis.toolbox import InteractiveCleanUI
 from cubevis import exe
 
+class DisplayContext:
+    def __init__(self, exclusion_manager):
+        self.exclusion_manager = exclusion_manager
+        self._custom_show_called = False
+
+    def on_show(self):
+        self._custom_show_called = True
+        self.exclusion_manager.set_mode('cell-custom-show')
+
+    def on_to_serializable(self):
+        # Only set mode if custom_show hasn't been called
+        if not self._custom_show_called:
+            self.exclusion_manager.set_mode('cell-bokeh-show')
+        # If custom_show was called, we're already in 'cell-custom-show' mode
+        # and don't need to do anything
+
 class InteractiveCleanNotebook:
     r'''InteractiveCleanNotebook(...) implements interactive clean using Bokeh
     {{docstring}}
@@ -107,6 +123,13 @@ class InteractiveCleanNotebook:
         def startup( ):
             self._future = context.execute( exec_task, self._id )
 
+        display_ctx = DisplayContext(self._ui.exclusion_mgr)
         ### name is used in summary output of the Showable
-        showed = Showable(bokeh_ui, startup, self.get_future, name="iclean-jpy")
+        showed = Showable(
+            bokeh_ui,
+            startup,
+            self.get_future,
+            name="iclean-jpy",
+            display_context=display_ctx
+        )
         return showed

cubevis/private/apps/_interactivecleannotebook.py

@@ -42,6 +42,22 @@ from cubevis.utils import find_pkg, load_pkg
 from cubevis.toolbox import InteractiveCleanUI
 from cubevis import exe
 
+class DisplayContext:
+    def __init__(self, exclusion_manager):
+        self.exclusion_manager = exclusion_manager
+        self._custom_show_called = False
+
+    def on_show(self):
+        self._custom_show_called = True
+        self.exclusion_manager.set_mode('cell-custom-show')
+
+    def on_to_serializable(self):
+        # Only set mode if custom_show hasn't been called
+        if not self._custom_show_called:
+            self.exclusion_manager.set_mode('cell-bokeh-show')
+        # If custom_show was called, we're already in 'cell-custom-show' mode
+        # and don't need to do anything
+
 class InteractiveCleanNotebook:
     r'''InteractiveCleanNotebook(...) implements interactive clean using Bokeh
         tclean ---- Radio Interferometric Image Reconstruction
@@ -1869,6 +1885,13 @@ class InteractiveCleanNotebook:
         def startup( ):
             self._future = context.execute( exec_task, self._id )
 
+        display_ctx = DisplayContext(self._ui.exclusion_mgr)
         ### name is used in summary output of the Showable
-        showed = Showable(bokeh_ui, startup, self.get_future, name="iclean-jpy")
+        showed = Showable(
+            bokeh_ui,
+            startup,
+            self.get_future,
+            name="iclean-jpy",
+            display_context=display_ctx
+        )
         return showed

cubevis/toolbox/__init__.py

@@ -28,6 +28,5 @@
 '''Common tools used in creating applications.'''
 
 from ._cube import CubeMask
-from ._app_context import AppContext
 from ._region_list import RegionList
 from ._interactive_clean_ui import InteractiveCleanUI

cubevis/toolbox/_cube.py

@@ -1,6 +1,6 @@
 #######################################################################
 #
-# Copyright (C) 2022,2023,2024
+# Copyright (C) 2022,2023,2024,2025
 # Associated Universities, Inc. Washington DC, USA.
 #
 # This script is free software; you can redistribute it and/or modify it
@@ -1488,20 +1488,24 @@ class CubeMask:
                                 selector=self._bitmask_color_selector,
                                 disable_add_sub = self._mask_add_sub_disable,
                                 user_init_script = self.init_script,
-                                freeze_cb = self._image_freeze_cb )
+                                freeze_cb = self._image_freeze_cb,
+                                image=self._image )
 
             self._image_source.init_script = CustomJS( args=init_args,
                                                        code='''let source = cb_obj
-                                                                      document._cube_already_shutdown = false
-                                                                   ''' + self._js['mask-state-init'] +
+                                                               const appstate = Bokeh.find.appState(image)
+                                                               const showable = Bokeh.find.showable(image)
+                                                               appstate.cube_already_shutdown = false
+                                                            ''' + self._js['mask-state-init'] +
                                                                    ( self._js['func-curmasks']( ) +
                                                                      self._js['key-state-funcs']
                                                                      if self._mask_path is None else '' ) +
                                                                         self._js['update-status'] + self._js['setup-key-mgmt'] +
                                                                    """// This function is called to collect the masks and/or stop
                                                                       // -->> collect_masks( ) is only defined if bitmask cube is NOT used
-                                                                      document._cube_done = ( final_polys=null, cb=null ) => {
-                                                                          if ( document._cube_already_shutdown ) return
+                                                                      console.log( "App state:", appstate )
+                                                                      appstate.cube_done = ( final_polys=null, cb=null ) => {
+                                                                          if ( appstate.cube_already_shutdown ) return
                                                                           function done_close_window( msg ) {
                                                                               if ( msg.result === 'stopped' ) {""" +
                                                                             # Don't close tab if running in a jupyter notebook
@@ -1509,14 +1513,28 @@ class CubeMask:
                                                                             ##     """console.log("Running from script/terminal. Closing window.")
                                                                             ##        window.close()"""
                                                                             ##) +
-                                                                            ("""console.log("Running in jupyter notebook. Not closing window.")""" if is_interactive_jupyter( ) else
-                                                                                 """console.log("Running from script/terminal. Closing window.")
-                                                                                    window.close()"""
-                                                                            ) +
+                                                                            ###
+                                                                            ###  Previously the Python is_interactive_jupyter( ) function was used
+                                                                            ###  to decide whether the window should be closed or not. However, to
+                                                                            ###  support the use of the regular iclean (i.e. display in a separate
+                                                                            ###  browser tab) the check is now whether a showable is available or
+                                                                            ###  not since Showable is the coupling between GUIs and Jupyter
+                                                                            ###  notebooks.
+                                                                            ###
+                                                                            """if ( showable ) {
+                                                                                     console.log("Running in jupyter notebook.\\nDisabling GUI via root Showable.")
+                                                                                     showable.disabled = true
+                                                                                     const data_pipes = Bokeh.activeDataPipes.getInstances( )
+                                                                                     console.log("Data pipes to be closed:", data_pipes)
+                                                                                 } else {
+                                                                                     console.log("Running from script/terminal. Closing window.")
+                                                                                     window.close()
+                                                                                 }
+                                                                              """ +
                                                                     """
                                                                               }
                                                                           }
-                                                                          document._cube_already_shutdown = true
+                                                                          appstate.cube_already_shutdown = true
                                                                           ctrl.send( ids['done'],
                                                                                      { action: 'done',
                                                                                        value: { regions: final_polys ? final_polys : source.masks( ) },
@@ -1526,13 +1544,12 @@ class CubeMask:
                                                                       // exported functions -- enable/disable masking, retrieve masks etc.
                                                                       source._masking_enabled = true
                                                                       source._pixel_update_enabled = true
-                                                                      if ( ! ('_masking_state' in document) ) {
-                                                                          document._masking_state = { }
-                                                                      }
-                                                                      document._masking_state[source.id] = false
-                                                                      source.masking_on = ( ) => { return document._masking_state[source.id] }
-                                                                      source.disable_masking = ( ) => { source._masking_enabled = false; document._masking_state[source.id] = false }
-                                                                      source.enable_masking = ( ) => { source._masking_enabled = true; document._masking_state[source.id] = true }
+                                                                      if ( ! ('masking_state' in appstate) )
+                                                                          appstate.masking_state = { }
+                                                                      appstate.masking_state[source.id] = false
+                                                                      source.masking_on = ( ) => { return appstate.masking_state[source.id] }
+                                                                      source.disable_masking = ( ) => { source._masking_enabled = false; appstate.masking_state[source.id] = false }
+                                                                      source.enable_masking = ( ) => { source._masking_enabled = true; appstate.masking_state[source.id] = true }
                                                                       source.disable_pixel_update = ( ) => source._pixel_update_enabled = false
                                                                       source.enable_pixel_update = ( ) => source._pixel_update_enabled = true
                                                                       source.masks = ( ) => typeof collect_masks == 'function' ? collect_masks( ) : { masks: [], polys: [] }
@@ -1549,7 +1566,7 @@ class CubeMask:
                                                                       if ( stats_source ) source.update_statistics( stats_source.data ) /*** round pre-filled floats ***/
                                                                       /*** this is the hook that allows the user to disable mask changes ***/
                                                                       this.disable_add_sub = disable_add_sub
-                                                                      if ( user_init_script ) { user_init_script.execute(this) }
+                                                                      if ( user_init_script ) { user_init_script.execute({ origin: this, appstate }) }
                                                                    """ )
 
         def region_position_connections( ):
@@ -2189,7 +2206,7 @@ class CubeMask:
                                                       stokes_labels=[ k for k,_ in self._region_controls['coord']['chan'].items( ) ],
                                                       status_line=self._region_controls['coord']['status'] if self._mask_path is None else None,
                                                       chan_select = [ v.child for k,v in self._region_controls['coord']['chan'].items( ) ] ),
-                                           code= ( self._js['func-newpoly'] + self._js['func-curmasks']( ) +
+                                           code= ( "const appstate = Bokeh.find.appState(cb_obj.origin);" + self._js['func-newpoly'] + self._js['func-curmasks']( ) +
                                                    self._js['mask-state-init'] + self._js_mode_code['no-bitmask-tool-selection'] )
                                                    if self._mask_path is None else  "" + (
                                                    ### selector indicates if a on-disk mask is being used
@@ -2655,10 +2672,10 @@ class CubeMask:
             'no-bitmask-init':          '''function _create_poly_mgr( annos, stokes_labels ) {
                                                const chan2polys = { }
 
-                                               if ( typeof document._polygon_list == 'undefined' )
-                                                   document._polygon_list = [ ]
+                                               if ( typeof appstate.polygon_list == 'undefined' )
+                                                   appstate.polygon_list = [ ]
 
-                                               const polys = document._polygon_list
+                                               const polys = appstate.polygon_list
 
                                                return {
                                                    reset_annos: ( ) => {