Changeset 2616 for trunk

Timestamp:

08/01/12 17:19:51 (12 years ago)

Author:

Takeshi Nakazato

Message:

New Development: No

JIRA Issue: Yes CAS-2825

Ready for Test: Yes

Interface Changes: No

What Interface Changed: Please list interface changes

Test Programs: not available

Put in Release Notes: No

Module(s): Module Names change impacts.

Description: Describe your changes here...

Help document updated.

File:

• trunk/python/edgemarker.py (modified) (4 diffs)

trunk/python/edgemarker.py

@@ -18 +18 @@
     complicated observed area. Typical case is that the area has
     clear 'dent' (e.g. a composite area consisting of two diamond-
-    shaped areas that partially overlap). In such case, the class
+    shaped areas that slightly overlap). In such case, the class
     will fail to detect such feature.
 
@@ -64 +64 @@
         """
         Set options for edge detection. Valid options depend on
-        whether scan pattern is raster or not.
+        whether scan pattern is raster or not (i.e. constructor
+        is called with israster=True or False).
 
-        FOR RASTER:
+        === for raster (israster=True) ===
         fraction -- Fraction of OFF integration in each raster
                     row. Either numerical value (<1.0) or string
@@ -86 +87 @@
         specification by npts will come before. 
 
-        FOR NON-RASTER:
+        === for non-raster (israster=False) ===
         fraction -- Fraction of edge area with respect to whole
                     observed area. Either numerical value (<1.0)
@@ -93 +94 @@
                     is same as 0.1. Default is 0.1.
         width -- Pixel width for edge detection. It should be given
-                 as a fraction with respect to the median spatial
-                 separation between neighboring integrations in time.
-                 Default is 0.5. In the most case, default value
-                 will be fine. Larger value will cause worse result.
-                 Smaller value may improve result. However, if too
-                 small value is set (e.g. 1.0e-5), the algorithm may
-                 not work.
+                 as a fraction of the median spatial separation
+                 between neighboring integrations in time. Default
+                 is 0.5. In the most case, default value will be fine.
+                 Larger value will cause worse result. Smaller value
+                 may improve result. However, if too small value is
+                 set (e.g. 1.0e-5), the algorithm may not work.
         elongated -- Set True only if observed area is extremely
                      elongated in one direction. Default is False.