Home       Trees       Index       Help   

Project Homepage

Package asap :: Module selector :: Class selector
[show private | hide private]
[frames | no frames]

Type selector

object --+        
         |        
  instance --+    
             |    
      selector --+
                 |
                selector

A selection object to be applied to scantables to restrict the scantables to specific rows.
Method Summary
  __add__(self, other)
Merge two selections.
  __str__(self)
  get_beams(self)
  get_cycles(self)
  get_ifs(self)
  get_name(self)
  get_order(self)
  get_pols(self)
  get_poltypes(self)
  get_query(self)
  get_scans(self)
  is_empty(self)
Has anything been set?
  reset(self)
Unset all selections.
  set_beams(self, beams)
Set a sequence of Beam numbers (0-based).
  set_cycles(self, cycles)
Set a sequence of IF numbers (0-based).
  set_ifs(self, ifs)
Set a sequence of IF numbers (0-based).
  set_name(self, name)
Set a selection based on a name.
  set_order(self, order)
Set the order the scantable should be sorted by.
  set_polarisations(self, pols)
Set the polarisations to be selected in the scantable.
  set_polarization(self, pols)
Set the polarisations to be selected in the scantable.
  set_query(self, query)
Select by Column query.
  set_scans(self, scans)
Set a sequence of Scan numbers (0-based).
  set_tsys(self, tsysmin, tsysmax)
Select by Tsys range.
  __init(self)
Inherited from selector: __init__, _empty, _getbeams, _getcycles, _getifs, _getorder, _getpols, _getpoltypes, _getscans, _gettaql, _reset, _setbeams, _setcycles, _setifs, _setname, _setorder, _setpols, _setpolstrings, _setscans, _settaql
Inherited from instance: __new__
Inherited from object: __delattr__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__

Class Variable Summary
Inherited from selector: __instance_size__

Method Details

__add__(self, other)
(Addition operator)

Merge two selections.

is_empty(self)

Has anything been set?

reset(self)

Unset all selections.

set_beams(self, beams=[]) 

Set a sequence of Beam numbers (0-based).
Parameters:
    beams:    a list of integers. Default [] is to unset the selection.

set_cycles(self, cycles=[]) 

Set a sequence of IF numbers (0-based).
Parameters:
    cycless:    a list of integers. Default [] is to unset the selection.

set_ifs(self, ifs=[]) 

Set a sequence of IF numbers (0-based).
Parameters:
    ifs:    a list of integers. Default [] is to unset the selection.

set_name(self, name) 

Set a selection based on a name. This can be a unix pattern , e.g. "*_R"
Parameters:
    name:    a string containing a source name or pattern
Examples:
    # select all reference scans which start with "Orion"
    selection.set_name("Orion*_R")

set_order(self, order) 

Set the order the scantable should be sorted by.
Parameters:
    order:    The list of column names to sort by in order

set_polarisations(self, pols=[]) 

Set the polarisations to be selected in the scantable.
Parameters:
     pols:     a list of integers of 0-3, or strings, e.g ["I","Q"].
               Default [] is no selection
Example:
     sel = selector()
     # These are equivalent if data is 'linear'
     sel.set_polarisations(["XX","Re(XY)"])
     sel.set_polarisations([0,2])
     # reset the polarisation selection
     sel.set_polarisations()

set_polarization(self, pols=[]) 

Set the polarisations to be selected in the scantable.
Parameters:
     pols:     a list of integers of 0-3, or strings, e.g ["I","Q"].
               Default [] is no selection
Example:
     sel = selector()
     # These are equivalent if data is 'linear'
     sel.set_polarisations(["XX","Re(XY)"])
     sel.set_polarisations([0,2])
     # reset the polarisation selection
     sel.set_polarisations()

set_query(self, query) 

Select by Column query. Power users only!
Example:
    # select all off scans with integration times over 60 seconds.
    selection.set_query("SRCTYPE == 1 AND INTERVAL > 60.0")

set_scans(self, scans=[]) 

Set a sequence of Scan numbers (0-based).
Parameters:
    scans:    a list of integers. Default [] is to unset the selection.

set_tsys(self, tsysmin=0.0, tsysmax=None) 

Select by Tsys range.
Parameters:
    tsysmin:     the lower threshold. Default 0.0
    tsysmax:     the upper threshold. Default None.
Examples:
    # select all spectra with Tsys <= 500.0
    selection.set_tsys(tsysmax=500.0)

   Home       Trees       Index       Help   

Project Homepage

Generated by Epydoc 2.1 on Wed May 2 14:24:33 2007 http://epydoc.sf.net