Deprecate show_fits and replace by show_fits_image

Author: jaladh-singhal

firefly_client/fc_utils.py

@@ -66,7 +66,7 @@ def ensure3(val, name):
 
 ACTION_DICT = {
     # actions from Firefly JS
-    'ShowFits': 'ImagePlotCntlr.PlotImage',
+    'ShowImage': 'ImagePlotCntlr.PlotImage',
     'AddExtension': 'ExternalAccessCntlr/extensionAdd',
     'FetchTable': 'table.fetch',
     'ShowTable': 'table.search',

firefly_client/firefly_client.py

@@ -730,9 +730,11 @@ def reinit_viewer(self):
         """
         return self.dispatch(ACTION_DICT['ReinitViewer'], {})
 
-    def show_fits(self, file_on_server=None, plot_id=None, viewer_id=None, **additional_params):
+    def show_fits_image(self, file_on_server=None, plot_id=None, viewer_id=None, **additional_params):
         """
-        Show a FITS image.
+        Show a FITS image. If the FITS file has multiple extensions/HDUs (for 
+        images, tables, etc.), all the image extensions are displayed by default
+        within the image plot.
 
         Parameters
         ----------
@@ -785,9 +787,16 @@ def show_fits(self, file_on_server=None, plot_id=None, viewer_id=None, **additio
         file_on_server and payload['wpRequest'].update({'file': file_on_server})
         additional_params and payload['wpRequest'].update(additional_params)
 
-        r = self.dispatch(ACTION_DICT['ShowFits'], payload)
+        r = self.dispatch(ACTION_DICT['ShowImage'], payload)
         warning and r.update({'warning': warning})
         return r
+    
+    def show_fits(self, *args, **kwargs):
+        """
+        DEPRECATED: Use show_fits_image() instead.
+        """
+        warn("show_fits() is deprecated. Use show_fits_image() instead.")
+        return self.show_fits_image(*args, **kwargs)
 
     def show_fits_3color(self, three_color_params, plot_id=None, viewer_id=None):
         """
@@ -827,7 +836,7 @@ def show_fits_3color(self, three_color_params, plot_id=None, viewer_id=None):
             viewer_id = FireflyClient.PINNED_IMAGE_VIEWER_ID
         payload.update({'viewerId': viewer_id})
 
-        r = self.dispatch(ACTION_DICT['ShowFits'], payload)
+        r = self.dispatch(ACTION_DICT['ShowImage'], payload)
         warning and r.update({'warning': warning})
         return r