FireflyClient
=============

.. currentmodule:: firefly_client

.. autoclass:: FireflyClient
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~FireflyClient.ACTION_DICT
      ~FireflyClient.ALL
      ~FireflyClient.EXTENSION_TYPE
      ~FireflyClient.INVERSE_STRETCH_ALGORITHM
      ~FireflyClient.INVERSE_STRETCH_TYPE
      ~FireflyClient.LO_VIEW_DICT
      ~FireflyClient.STRETCH_ALGORITHM_DICT
      ~FireflyClient.STRETCH_TYPE_DICT
      ~FireflyClient.bind_addr
      ~FireflyClient.connection
      ~FireflyClient.daemon
      ~FireflyClient.handshake_headers
      ~FireflyClient.handshake_request
      ~FireflyClient.instances
      ~FireflyClient.local_address
      ~FireflyClient.peer_address
      ~FireflyClient.terminated

   .. rubric:: Methods Summary

   .. autosummary::

      ~FireflyClient.add_cell
      ~FireflyClient.add_extension
      ~FireflyClient.add_listener
      ~FireflyClient.add_mask
      ~FireflyClient.add_region_data
      ~FireflyClient.close
      ~FireflyClient.close_connection
      ~FireflyClient.closed
      ~FireflyClient.connect
      ~FireflyClient.create_image_url
      ~FireflyClient.delete_region_layer
      ~FireflyClient.disconnect
      ~FireflyClient.dispatch
      ~FireflyClient.display_url
      ~FireflyClient.fetch_table
      ~FireflyClient.get_default_instance
      ~FireflyClient.get_firefly_url
      ~FireflyClient.get_instances
      ~FireflyClient.handshake_ok
      ~FireflyClient.launch_browser
      ~FireflyClient.make_client
      ~FireflyClient.make_lab_client
      ~FireflyClient.once
      ~FireflyClient.opened
      ~FireflyClient.overlay_footprints
      ~FireflyClient.overlay_region_layer
      ~FireflyClient.parse_rvstring
      ~FireflyClient.ping
      ~FireflyClient.ponged
      ~FireflyClient.process
      ~FireflyClient.process_handshake_header
      ~FireflyClient.process_response_line
      ~FireflyClient.received_message
      ~FireflyClient.reinit_viewer
      ~FireflyClient.remove_listener
      ~FireflyClient.remove_mask
      ~FireflyClient.remove_region_data
      ~FireflyClient.run
      ~FireflyClient.run_forever
      ~FireflyClient.rvstring_from_dict
      ~FireflyClient.send
      ~FireflyClient.set_pan
      ~FireflyClient.set_stretch
      ~FireflyClient.set_stretch_hprgb
      ~FireflyClient.set_zoom
      ~FireflyClient.show_chart
      ~FireflyClient.show_coverage
      ~FireflyClient.show_fits
      ~FireflyClient.show_fits_3color
      ~FireflyClient.show_hips
      ~FireflyClient.show_histogram
      ~FireflyClient.show_image_metadata
      ~FireflyClient.show_image_or_hips
      ~FireflyClient.show_table
      ~FireflyClient.show_xyplot
      ~FireflyClient.stay_connected
      ~FireflyClient.terminate
      ~FireflyClient.unhandled_error
      ~FireflyClient.upload_data
      ~FireflyClient.upload_file
      ~FireflyClient.upload_fits_data
      ~FireflyClient.upload_text_data
      ~FireflyClient.wait_for_events

   .. rubric:: Attributes Documentation

   .. autoattribute:: ACTION_DICT
   .. autoattribute:: ALL
   .. autoattribute:: EXTENSION_TYPE
   .. autoattribute:: INVERSE_STRETCH_ALGORITHM
   .. autoattribute:: INVERSE_STRETCH_TYPE
   .. autoattribute:: LO_VIEW_DICT
   .. autoattribute:: STRETCH_ALGORITHM_DICT
   .. autoattribute:: STRETCH_TYPE_DICT
   .. autoattribute:: bind_addr
   .. autoattribute:: connection
   .. autoattribute:: daemon
   .. autoattribute:: handshake_headers
   .. autoattribute:: handshake_request
   .. autoattribute:: instances
   .. autoattribute:: local_address
   .. autoattribute:: peer_address
   .. autoattribute:: terminated

   .. rubric:: Methods Documentation

   .. automethod:: add_cell
   .. automethod:: add_extension
   .. automethod:: add_listener
   .. automethod:: add_mask
   .. automethod:: add_region_data
   .. automethod:: close
   .. automethod:: close_connection
   .. automethod:: closed
   .. automethod:: connect
   .. automethod:: create_image_url
   .. automethod:: delete_region_layer
   .. automethod:: disconnect
   .. automethod:: dispatch
   .. automethod:: display_url
   .. automethod:: fetch_table
   .. automethod:: get_default_instance
   .. automethod:: get_firefly_url
   .. automethod:: get_instances
   .. automethod:: handshake_ok
   .. automethod:: launch_browser
   .. automethod:: make_client
   .. automethod:: make_lab_client
   .. automethod:: once
   .. automethod:: opened
   .. automethod:: overlay_footprints
   .. automethod:: overlay_region_layer
   .. automethod:: parse_rvstring
   .. automethod:: ping
   .. automethod:: ponged
   .. automethod:: process
   .. automethod:: process_handshake_header
   .. automethod:: process_response_line
   .. automethod:: received_message
   .. automethod:: reinit_viewer
   .. automethod:: remove_listener
   .. automethod:: remove_mask
   .. automethod:: remove_region_data
   .. automethod:: run
   .. automethod:: run_forever
   .. automethod:: rvstring_from_dict
   .. automethod:: send
   .. automethod:: set_pan
   .. automethod:: set_stretch
   .. automethod:: set_stretch_hprgb
   .. automethod:: set_zoom
   .. automethod:: show_chart
   .. automethod:: show_coverage
   .. automethod:: show_fits
   .. automethod:: show_fits_3color
   .. automethod:: show_hips
   .. automethod:: show_histogram
   .. automethod:: show_image_metadata
   .. automethod:: show_image_or_hips
   .. automethod:: show_table
   .. automethod:: show_xyplot
   .. automethod:: stay_connected
   .. automethod:: terminate
   .. automethod:: unhandled_error
   .. automethod:: upload_data
   .. automethod:: upload_file
   .. automethod:: upload_fits_data
   .. automethod:: upload_text_data
   .. automethod:: wait_for_events