### Navigation

- index
- modules |
- next |
- previous |
- SamSifter 0.4.0 documentation »
- samsifter package »

# samsifter.gui package

## composites module

Composed widgets used to visualize filter parameters in a form layout.

class `FileChooser`(parent=None, suffix_string='CSV files (*.csv *.CSV)')

  Bases: `PyQt4.QtGui.QWidget`

  Combined LineEdit and Pushbutton for standard file dialog to select a file.

  `get_filename`()
  `get_suffix_string`()
  `highlight`(boolean=True)

    Indicate errors or pending actions by changing background color.

  `set_filename`(filename)

    Set filename while maintaining cursor position and validating input on the fly.

  `set_suffix_string`(suffix_string)
  `show_dialog`()

class `OptionSwitcher`(parent=None, options=[True, False])

  Bases: `PyQt4.QtGui.QWidget`

  Group of coupled radio buttons to choose between exclusive options.

  `get_current_index`()
  `get_options`()
  `set_current_index`(index)
  `set_options`(options)

class `SliderSpinboxCombo`(parent=None, minimum=0.0, maximum=100.0, default=0.0, precision=2)

  Bases: `PyQt4.QtGui.QWidget`

  Slider coupled with Spinbox for setting numerical values between a minimum and maximum.

  `denormalize`(value)
  `get_value`()
  `normalize`(value)
  `on_slider_value_change`(value)
  `on_spinner_value_change`(value)
  `set_value`(value)

## dialogs module

Created on Tue Jan 27 15:34:20 2015

class `BashOptions`(use_basenames=True, processing_mode=3, print_commands=False, stop_on_error=True)

  Bases: `builtins.object`

  Options for the export of a workflow to a bash script.

  `PARALLEL_MODE` = 3
  `SEQUENTIAL_MODE` = 2
  `SINGLE_MODE` = 1
  `get_print_commands`()
  `get_processing_mode`()
  `get_stop_on_error`()
  `get_use_basenames`()
  `set_print_commands`(boolean)
  `set_processing_mode`(mode)
  `set_stop_on_error`(boolean)
  `set_use_basenames`(boolean)

class `BashOptionsDialog`(parent=None)

  Bases: `PyQt4.QtGui.QDialog`

  Dialog to set bash script export options.

  `get_options`()

    Shows dialog and returns options unless user decides to cancel.

  `save_options`()

    Stores current settings in BashOptions object to be returned.

class `RmaOptions`(sam2rma_path='/usr/local/megan/tools/sam2rma', top_percent=1, max_expected=0.01, min_score=50, min_support_percent=0.05, min_support=1)

  Bases: `builtins.object`

  Options for the conversion of SAM to RMA files.

  `get_max_expected`()
  `get_min_score`()
  `get_min_support`()
  `get_min_support_percent`()
  `get_sam2rma_path`()
  `get_top_percent`()
  `set_max_expected`(max_expected)
  `set_min_score`(min_score)
  `set_min_support`(min_support)
  `set_min_support_percent`(min_support_percent)
  `set_sam2rma_path`(sam2rma_path)
  `set_top_percent`(top_percent)

class `RmaOptionsDialog`(saved_options=None, parent=None)

  Bases: `PyQt4.QtGui.QDialog`

  Modal dialog to set SAM2RMA conversion settings.

  `get_options`()

    Shows dialog and returns options unless user decides to cancel.

  `reset_form`()

    Resets all form elements to defaults.

  `save_options`()

    Stores current settings in BashOptions object to be returned.

## widgets module

Created on Fri Dec 12 16:41:29 2014

class `FilterWidget`(item, parent=None)

  Bases: `PyQt4.QtGui.QWidget`

  Representation of a filter action in GUI.

  `add_parameter`(parameter)
  `on_value_change`(value)
  `set_name`(name)
  `value_changed`

class `InputWidget`(parent=None)

  Bases: `PyQt4.QtGui.QWidget`

  Representation of file input action in GUI.

  `highlight`(boolean=True)

    Indicate errors or pending actions by changing background color.

  `set_filename`(filename)

    Update filename in text box while retaining current cursor position.

  `show_dialog`()

class `OutputWidget`(parent=None)

  Bases: `PyQt4.QtGui.QWidget`

  Representation of file output action in GUI.

  `highlight`(boolean=True)

    Indicate errors or pending actions by changing background color.

  `set_filename`(filename)

    Update filename in text box while retaining current cursor position.

  `show_dialog`()

### Navigation

- index
- modules |
- next |
- previous |
- SamSifter 0.4.0 documentation »
- samsifter package »