deploy: 1019f72

.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 9840cfada4cf00d8df3c3dd7bbac1d38
+config: 5968195b44dd62fc064f20a377c21afd
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/api/firefly_client.FireflyClient.rst.txt

@@ -35,6 +35,7 @@ FireflyClient
       ~FireflyClient.add_listener
       ~FireflyClient.add_mask
       ~FireflyClient.add_region_data
+      ~FireflyClient.apply_table_filters
       ~FireflyClient.call_response
       ~FireflyClient.change_triview_layout
       ~FireflyClient.create_image_url
@@ -76,6 +77,7 @@ FireflyClient
       ~FireflyClient.show_lab_tab
       ~FireflyClient.show_table
       ~FireflyClient.show_xyplot
+      ~FireflyClient.sort_table_column
       ~FireflyClient.table_highlight_callback
       ~FireflyClient.upload_data
       ~FireflyClient.upload_file
@@ -108,6 +110,7 @@ FireflyClient
    .. automethod:: add_listener
    .. automethod:: add_mask
    .. automethod:: add_region_data
+   .. automethod:: apply_table_filters
    .. automethod:: call_response
    .. automethod:: change_triview_layout
    .. automethod:: create_image_url
@@ -149,6 +152,7 @@ FireflyClient
    .. automethod:: show_lab_tab
    .. automethod:: show_table
    .. automethod:: show_xyplot
+   .. automethod:: sort_table_column
    .. automethod:: table_highlight_callback
    .. automethod:: upload_data
    .. automethod:: upload_file

_sources/reference.rst.txt

@@ -4,5 +4,4 @@ API reference
 
 .. automodapi:: firefly_client
    :no-inheritance-diagram:
-   :no-heading:
-
+   :skip: PackageNotFoundError, Env, FFWs, RangeValues

_sources/usage/displaying-images.rst.txt

@@ -221,3 +221,15 @@ It is possible to create a 3-color composite image using a list of dictionaries
     fc.show_fits_3color(threeC,
     plot_id='wise_m101',
     viewer_id='3C')
+
+
+Displaying Image from a URL
+---------------------------
+
+If you have the URL of an image, you can pass it directly instead of 
+downloading it and then uploading it to firefly:
+
+.. code-block:: py
+
+    image_url = 'http://irsa.ipac.caltech.edu/ibe/data/wise/allsky/4band_p1bm_frm/6a/02206a/149/02206a149-w1-int-1b.fits?center=70,20&size=200pix'
+    fc.show_fits(url=image_url, plot_id='wise-allsky', title='WISE all-sky')

_sources/usage/viewing-tables.rst.txt

@@ -1,5 +1,6 @@
+###############################
 Visualizing Tables and Catalogs
--------------------------------
+###############################
 
 Tables can be uploaded to the Firefly server with :meth:`FireflyClient.upload_file`,
 and displayed in a table viewer component with :meth:`FireflyClient.show_table`.
@@ -11,18 +12,60 @@ if the table contains recognizable celestial coordinates.
     tval = fc.upload_file('m31-2mass-2412-row.tbl')
     fc.show_table(file_on_server=tval, tbl_id='m31-table')
 
+Modifying Table Display Parameters
+----------------------------------
+
 If it is desired to overlay the table on an image, or to make plots from it,
 without showing the table in the viewer, use :meth:`FireflyClient.fetch_table`:
 
 .. code-block:: py
 
     fc.fetch_table(file_on_server=tval, tbl_id='invisible-table')
 
+Alternatively, you can turn off the `visible` parameter in :meth:`FireflyClient.show_table`:
+
+.. code-block:: py
+
+    fc.show_table(file_on_server=tval, tbl_id='invisible-table', visible=False)
+
 If the table does not contain celestial coordinates recognized by Firefly,
-the image overlay will not appear. BUt if you specifically do not want
-the table overlaid on the image, `is_catalog=False` can be specified:
+the image overlay will not appear. But if you specifically do not want
+the table overlaid on the image, `is_catalog=False` can be specified (it is 
+`True` by default):
 
 .. code-block:: py
 
     fc.show_table(file_on_server=tval, tbl_id='2mass-tbl', is_catalog=False)
 
+
+Displaying Table from a URL
+---------------------------
+
+If you have the URL of a table, you can pass it directly instead of 
+downloading it and then uploading it to firefly:
+
+.. code-block:: py
+
+    table_url = "http://irsa.ipac.caltech.edu/TAP/sync?FORMAT=IPAC_TABLE&QUERY=SELECT+*+FROM+fp_psc+WHERE+CONTAINS(POINT('J2000',ra,dec),CIRCLE('J2000',70.0,20.0,0.1))=1"
+    tbl_id_2mass_psc = '2mass-point-source-catalog'
+    fc.show_table(url=table_url, tbl_id=tbl_id_2mass_psc)
+
+Filtering/Sorting a loaded Table
+--------------------------------
+
+After displaying a table in firefly, you can also apply filters on it. 
+You will need to pass the `tbl_id` of that table and specify `filters` as an
+SQL WHERE clause-like string with column names quoted:
+
+.. code-block:: py
+    
+    fc.apply_table_filters(tbl_id=tbl_id_2mass_psc, filters='"j_m">15 and "j_m"<16 and "j_cmsig"<0.06')
+
+You can sort the table by a column in ascending (`ASC`) or descending (`DESC`)
+order:
+
+.. code-block:: py
+    
+    fc.sort_table_column(tbl_id=tbl_id_2mass_psc, column_name='j_m', sort_direction='ASC')
+
+If a column has sorting, it can be removed by specifying `sort_direction=''`.