Changeset 1855

Timestamp:

08/04/10 18:29:19 (14 years ago)

Author:

Malte Marquarding

Message:

Ticket #194: docstring changes. Play nicely with sphinx.

File:

• trunk/python/scantable.py (modified) (37 diffs)

trunk/python/scantable.py

@@ -158 +158 @@
                          this is the root file name (data in 'name'.txt
                          and header in 'name'_header.txt)
+
             format:      an optional file format. Default is ASAP.
-                         Allowed are - 'ASAP' (save as ASAP [aips++] Table),
-                                       'SDFITS' (save as SDFITS file)
-                                       'ASCII' (saves as ascii text file)
-                                       'MS2' (saves as an aips++
-                                              MeasurementSet V2)
-                                       'FITS' (save as image FITS - not
-                                               readable by class)
-                                       'CLASS' (save as FITS readable by CLASS)
+                         Allowed are:
+
+                            * 'ASAP' (save as ASAP [aips++] Table),
+                            * 'SDFITS' (save as SDFITS file)
+                            * 'ASCII' (saves as ascii text file)
+                            * 'MS2' (saves as an casacore MeasurementSet V2)
+                            * 'FITS' (save as image FITS - not readable by class)
+                            * 'CLASS' (save as FITS readable by CLASS)
+
             overwrite:   If the file should be overwritten if it exists.
                          The default False is to return with warning
                          without writing the output. USE WITH CARE.
+
         Example::
 
@@ -274 +277 @@
 
     def get_scan(self, scanid=None):
-        """
+        """\
         Return a specific scan (by scanno) or collection of scans (by
         source name) in a new scantable.
@@ -402 +405 @@
         Parameters:
 
-             spec:   the spectrum
-             rowno:    the row number to set the spectrum for
+             spec:   the new spectrum
+
+             rowno:  the row number to set the spectrum for
 
         """
@@ -528 +532 @@
             stat:    'min', 'max', 'min_abc', 'max_abc', 'sumsq', 'sum',
                      'mean', 'var', 'stddev', 'avdev', 'rms', 'median'
+
             mask:    an optional mask specifying where the statistic
                      should be determined.
+
             form:    format string to print statistic values
 
@@ -621 +627 @@
             rowno:   a row number in the scantable. Default is the
                      first row, i.e. rowno=0
+
             chan:    a channel in the scantable. Default is the first
                      channel, i.e. pos=0
@@ -749 +756 @@
 
             row:          row no of integration. Default -1 return all rows
+
             asdatetime:   return values as datetime objects rather than strings
 
@@ -827 +835 @@
         Get a list of Positions on the sky (direction) for the observations.
         Return a string for each integration in the scantable.
-        Parameters:
+
+        Parameters:
+
             row:    row no of integration. Default -1 return all rows
-        Example:
-            none
+
         """
         return self._get_column(self._getdirection, row)
@@ -1019 +1028 @@
             mask:   an optional channel mask, created with create_mask. Default
                     (no mask) is all channels.
+
             unflag:    if True, unflag the data
 
@@ -1044 +1054 @@
             rows:   list of row numbers to be flagged. Default is no row
                     (must be explicitly specified to execute row-based flagging).
+
             unflag: if True, unflag the data.
 
@@ -1066 +1077 @@
 
             uthres:      upper threshold.
+
             dthres:      lower threshold
 
             clipoutside: True for flagging data outside the range [dthres:uthres].
                          False for glagging data inside the range.
+
             unflag:      if True, unflag the data.
 
@@ -1096 +1109 @@
             start:    the start frequency (really a period within the
                       bandwidth)  or period to remove
+
             end:      the end frequency or period to remove
+
             unit:     the frequency unit (default "MHz") or "" for
                       explicit lag channels
@@ -1145 +1160 @@
                 Pairs of start/end points (inclusive)specifying the regions
                 to be masked
+
             invert:     optional argument. If specified as True,
                         return an inverted mask, i.e. the regions
                         specified are EXCLUDED
+
             row:        create the mask using the specified row for
                         unit conversions, default is row=0
@@ -1211 +1228 @@
 
             mask:       channel mask, created with create_mask.
+
             row:        calcutate the masklist using the specified row
                         for unit conversions, default is row=0
@@ -1251 +1269 @@
         """\
         Compute and Return lists of mask start indices and mask end indices.
-         Parameters:
+
+        Parameters:
+
             mask:       channel mask, created with create_mask.
 
@@ -1342 +1362 @@
 
             freqs:   list of rest frequency values or string idenitfiers
+
             unit:    unit for rest frequency (default 'Hz')
 
@@ -1519 +1540 @@
             mask:     an optional mask (only used for 'var' and 'tsys'
                       weighting)
+
             scanav:   True averages each scan separately
                       False (default) averages all scans together,
+
             weight:   Weighting scheme.
                       'none'     (mean no weight)
@@ -1529 +1552 @@
                       'median'   ( median averaging)
                       The default is 'tint'
+
             align:    align the spectra in velocity before averaging. It takes
                       the time of the first spectrum as reference time.
@@ -1578 +1602 @@
 
             jyperk:      the Jy / K conversion factor
+
             eta:         the aperture efficiency
+
             d:           the geomtric diameter (metres)
+
             insitu:      if False a new scantable is returned.
                          Otherwise, the scaling is done in-situ
@@ -1614 +1641 @@
                          gain-elevation correction as a function of
                          elevation (in degrees).
+
             filename:    The name of an ascii file holding correction factors.
                          The first row of the ascii file must give the column
@@ -1632 +1660 @@
                          0.5 80 0.8
                          0.6 90 0.75
+
             method:      Interpolation method when correcting from a table.
                          Values are  "nearest", "linear" (default), "cubic"
                          and "spline"
+
             insitu:      if False a new scantable is returned.
                          Otherwise, the scaling is done in-situ
@@ -1663 +1693 @@
 
         Parameters:
+
             reftime:     reference time to align at. By default, the time of
                          the first row of data is used.
+
             method:      Interpolation method for regridding the spectra.
                          Choose from "nearest", "linear", "cubic" (default)
                          and "spline"
+
             insitu:      if False a new scantable is returned.
                          Otherwise, the scaling is done in-situ
@@ -1690 +1723 @@
 
         Parameters:
+
             tau:         (list of) opacity from which the correction factor is
                          exp(tau*ZD)
@@ -1698 +1732 @@
                          if tau is `None` the opacities are determined from a
                          model.
+
             insitu:      if False a new scantable is returned.
                          Otherwise, the scaling is done in-situ
@@ -1722 +1757 @@
 
             width:       The bin width (default=5) in pixels
+
             insitu:      if False a new scantable is returned.
                          Otherwise, the scaling is done in-situ
@@ -1746 +1782 @@
 
             width:       The bin width (default=5) in pixels
+
             method:      Interpolation method when correcting from a table.
                          Values are  "nearest", "linear", "cubic" (default)
                          and "spline"
+
             insitu:      if False a new scantable is returned.
                          Otherwise, the scaling is done in-situ
@@ -1773 +1811 @@
                          averaging will be applied. The output will have all
                          specified points masked.
+
             weight:      Weighting scheme. 'none' (default), 'var' (1/var(spec)
                          weighted), or 'tsys' (1/Tsys**2 weighted)
@@ -1793 +1832 @@
                          averaging will be applied. The output will have all
                          specified points masked.
+
             weight:      Weighting scheme. 'none' (default), 'var' (1/var(spec)
                          weighted), or 'tsys' (1/Tsys**2 weighted)
@@ -1810 +1850 @@
 
         Parameters:
+
             pflag:  Bool indicating whether to turn this on (True) or
                     off (False)
@@ -1825 +1866 @@
 
         Parameters:
+
             poltype:    The new polarisation type. Valid types are:
                         "linear", "circular", "stokes" and "linpol"
@@ -1855 +1897 @@
                         'hanning' (default), 'gaussian', 'boxcar', 'rmedian'
                         or 'poly'
+
             width:      The width of the kernel in pixels. For hanning this is
                         ignored otherwise it defauls to 5 pixels.
@@ -1860 +1903 @@
                         Maximum. For 'boxcar' it is the full width.
                         For 'rmedian' and 'poly' it is the half width.
+
             order:      Optional parameter for 'poly' kernel (default is 2), to
                         specify the order of the polnomial. Ignored by all other
                         kernels.
+
             plot:       plot the original and the smoothed spectra.
                         In this each indivual fit has to be approved, by
                         typing 'y' or 'n'
+
             insitu:     if False a new scantable is returned.
                         Otherwise, the scaling is done in-situ
@@ -1929 +1975 @@
 
             mask:       an optional mask
+
             order:      the order of the polynomial (default is 0)
+
             plot:       plot the fit and the residual. In this each
                         indivual fit has to be approved, by typing 'y'
                         or 'n'
+
             uselin:     use linear polynomial fit
+
             insitu:     if False a new scantable is returned.
                         Otherwise, the scaling is done in-situ
@@ -2242 +2292 @@
 
             offset:      the offset
+
             insitu:      if False a new scantable is returned.
                          Otherwise, the scaling is done in-situ
@@ -2266 +2317 @@
 
             factor:      the scaling factor (float or 1D float list)
+
             insitu:      if False a new scantable is returned.
                          Otherwise, the scaling is done in-situ
                          The default is taken from .asaprc (False)
+
             tsys:        if True (default) then apply the operation to Tsys
                          as well as the data
@@ -2302 +2355 @@
 
             match:          a Unix style pattern, regular expression or selector
+
             matchtype:      'pattern' (default) UNIX style pattern or
                             'regex' regular expression
+
             sourcetype:     the type of the source to use (source/reference)
 
@@ -2345 +2400 @@
                             preserve: Output = Toff * (on/off) - Toff
                             remove:   Output = Toff * (on/off) - Ton
+
             mode:           the on/off detection mode
                             'paired' (default)
@@ -2386 +2442 @@
 
             mask:           an optional mask to be used when weight == 'stddev'
+
             weight:         How to average the off beams.  Default is 'median'.
+
             preserve:       you can preserve (default) the continuum or
-                            remove it.  The equations used are
-                            preserve: Output = Toff * (on/off) - Toff
-                            remove:   Output = Toff * (on/off) - Ton
+                            remove it.  The equations used are:
+
+                                preserve: Output = Toff * (on/off) - Toff
+
+                                remove:   Output = Toff * (on/off) - Ton
 
         """