Changeset 2860 for trunk/python

Timestamp:

10/10/13 13:43:31 (11 years ago)

Author:

WataruKawasaki

Message:

New Development: No

JIRA Issue: No

Ready for Test: Yes

Interface Changes: No

What Interface Changed:

Test Programs:

Put in Release Notes: No

Module(s): sd

Description: bugfix in sd.plotter2.get_linestyleindex() and minor clean-up

File:

• trunk/python/plotter2.py (modified) (11 diffs)

trunk/python/plotter2.py

@@ -93 +93 @@
     def set_range(self, xmin, xmax, ymin, ymax, vpid=None):
         """\
-        set 2D range of area to be displayed in a viewport.
+        set 2D range to be displayed in the specified viewport.
         by default, the display range is set automatically. 
 
@@ -109 +109 @@
     def set_xrange(self, xmin, xmax, vpid=None):
         """\
-        set x range of area to be displayed in a viewport.
+        set x range to be displayed in the specified viewport.
         by default, the display range is set automatically. 
 
@@ -123 +123 @@
     def set_yrange(self, ymin, ymax, vpid=None):
         """\
-        set y range of area to be displayed in a viewport.
+        set y range to be displayed in the specified viewport.
         by default, the display range is set automatically. 
 
@@ -137 +137 @@
     def get_xrange(self, vpid=None):
         """\
-        returns x range of display area of the specified viewport in
-        a shape of (xmin, xmax). 
+        returns x range of displayed region of the specified viewport 
+        as a list of [xmin, xmax]. 
 
         Parameter:
@@ -149 +149 @@
     def get_yrange(self, vpid=None):
         """\
-        returns y range of display area of the specified viewport in
-        a shape of (ymin, ymax). 
+        returns y range of displayed region in the specified viewport
+        as a list of [ymin, ymax]. 
 
         Parameter:
@@ -161 +161 @@
     def set_autorange(self, vpid=None):
         """\
-        set 2D range of display area of the specified viewport to be
-        automatic depending on the given data.
-        the x range will be the exact range of the x values of data,
-        whereas y range has a margin of 10% of the range of y values of data. 
+        set the 2-Dimensional range of displayed area of the specified
+        viewport to automatically enclose the given data.
+        the x range will be from the minimum up to the maximum value
+        of the given x values, whereas y range has margins of 10% of
+        the y value range both at the top and the bottom sides. 
 
         Parameter:
@@ -175 +176 @@
     def set_xautorange(self, vpid=None):
         """\
-        set x range of display area of the specified viewport to be
-        automatic depending on the given data.
-        the x range will be the exact range of the x values of data,
+        set x range of displayed area of the specified viewport to 
+        automatically enclose the given data with no margins. 
 
         Parameter:
@@ -188 +188 @@
     def set_yautorange(self, vpid=None):
         """\
-        set y range of display area of the specified viewport to be
-        automatic depending on the given data.
-        the y range has a margin of 10% of the range of y values of data. 
+        set y range of displayed area of the specified viewport to 
+        automatically enclose the given data with margins of 10% of
+        the y value range both at the top and the bottom sides. 
 
         Parameter:
@@ -341 +341 @@
 
         Parameters:
-            color: line color specified by color name. available colors 
-                   can be listed via list_colornames().
-            width: line width. default is 1.
-            style: line style. available styles can be listed via
-                   list_linestyles().
-            vpid:   viewport id. when not given, the last viewport
-                    will be the target. 
-            dataid: dataset id. when not given, the last dataset used.
+            color:  line color specified by color name. available colors 
+                    can be listed via list_colornames().
+            width:  line width. default is 1.
+            style:  line style. available styles can be listed via
+                    list_linestyles().
+            vpid:   viewport id. when not given, the last viewport
+                    will be the target of operation. 
+            dataid: dataset id. when not given, the last dataset for the
+                    specified viewport is the target.
         """
         if width  is None: width  = 1
@@ -477 +478 @@
                    default is the center of x axis.
             posy:  y position of label string.
-            vpid:   viewport id. when not given, the last viewport
-                    will be the target. 
+            vpid:  viewport id. when not given, the last viewport
+                   will be the target. 
         """
         if style is None: style = ""
@@ -642 +643 @@
         """
         style = fstyle.strip().lower()
-        if style == "solid":        idx = 1
-        if style == "outline":      idx = 2
-        if style == "hatched":      idx = 3
-        if style == "crosshatched": idx = 4
+        if style == "solid":               idx = 1
+        if style == "dashed":              idx = 2
+        if style == "dash-dotted":         idx = 3
+        if style == "dotted":              idx = 4
+        if style == "dash-dot-dot-dotted": idx = 5
         
         return idx