Changeset 1597 for trunk/python

Timestamp:

07/06/09 11:17:40 (15 years ago)

Author:

Malte Marquarding

Message:

Added doc string

File:

• trunk/python/asapplotter.py (modified) (1 diff)

trunk/python/asapplotter.py

@@ -113 +113 @@
 
     def create_mask(self, nwin=1, panel=0, color=None):
+        """
+        Interactively define a mask.It retruns a mask that is equivalent to
+        the one created manually with scantable.create_mask.
+        Parameters:
+            nwin:       The number of mask windows to create interactively
+                        default is 1.
+            panel:      Which panel to use for mask selection. This is useful
+                        if different IFs are spread over panels (default 0)
+        """
         if self._data is None:
             return []