Ticket #2100: trac_2100-auto-automatic-and-vector.patch

sage/plot/bar_chart.py

@@ -119 +119 @@
         subplot.bar(ind, datalist, color=color, width=width, label=options['legend_label'])
 
 @rename_keyword(color='rgbcolor')
-@options(width=0.5, rgbcolor=(0,0,1), legend_label=None, aspect_ratio='auto')
+@options(width=0.5, rgbcolor=(0,0,1), legend_label=None, aspect_ratio='automatic')
 def bar_chart(datalist, **options):
     """
     A bar chart of (currently) one list of numerical data.

sage/plot/line.py

@@ -275 +275 @@
 
     
 @rename_keyword(color='rgbcolor')
-@options(alpha=1, rgbcolor=(0,0,1), thickness=1, legend_label=None)
+@options(alpha=1, rgbcolor=(0,0,1), thickness=1, legend_label=None, aspect_ratio ='automatic')
 def line2d(points, **options):
     r"""
     Create the line through the given list of points.

sage/plot/plot.py

@@ -470 +470 @@
         """
         Set the aspect ratio, which is the ratio of height and width
         of a unit square (i.e., height/width of a unit square), or
-        'auto' (expand to fill the figure).
+        'automatic' (expand to fill the figure).
         
         INPUT:
         
         
-        -  ``ratio`` - a positive real number or 'auto'
+        -  ``ratio`` - a positive real number or 'automatic'
         
         
         EXAMPLES: We create a plot of a circle, and it doesn't look quite
@@ -501 +501 @@
             sage: P + Q
             sage: Q + P
         """
-        if ratio != 'auto':
+        if ratio != 'auto' and ratio != 'automatic':
             ratio = float(ratio)
             if ratio <= 0:
-                raise ValueError, "the aspect ratio must be positive or 'auto'"
+                raise ValueError, "the aspect ratio must be positive or 'automatic'"
+        else:
+            ratio = 'automatic'
         self.__aspect_ratio = ratio
 
     def aspect_ratio(self):
         """
         Get the current aspect ratio, which is the ratio of height to
-        width of a unit square, or 'auto'.
-        
-        OUTPUT: a positive float (height/width of a unit square), or 'auto'
+        width of a unit square, or 'automatic'.
+        
+        OUTPUT: a positive float (height/width of a unit square), or 'automatic'
         (expand to fill the figure).
         
         EXAMPLES::
@@ -523 +525 @@
             sage: P.set_aspect_ratio(2)
             sage: P.aspect_ratio()
             2.0
-            sage: P.set_aspect_ratio('auto')
+            sage: P.set_aspect_ratio('automatic')
             sage: P.aspect_ratio()
-            'auto'
+            'automatic'
         """
         return self.__aspect_ratio
 
@@ -1251 +1253 @@
         The xmin, xmax, ymin, and ymax properties of the graphics objects
         are expanded to include all objects in both scenes. If the aspect
         ratio property of either or both objects are set, then the larger
-        aspect ratio is chosen, with 'auto' being overridden by a
+        aspect ratio is chosen, with 'automatic' being overridden by a
         numeric aspect ratio.
 
         If one of the graphics object is set to show a legend, then the
@@ -1268 +1270 @@
 
         Extra keywords to show are propagated::
 
-            sage: (g1 + g2)._extra_kwds=={'aspect_ratio': 'auto', 'frame': True}
+            sage: (g1 + g2)._extra_kwds=={'aspect_ratio': 'automatic', 'frame': True}
             True
         """
         if isinstance(other, int) and other == 0:
@@ -1280 +1282 @@
             raise TypeError, "other (=%s) must be a Graphics objects"%other
         g = Graphics()
         g.__objects = self.__objects + other.__objects
-        if self.__aspect_ratio=='auto':
+        if self.__aspect_ratio=='automatic':
             g.__aspect_ratio=other.__aspect_ratio
-        elif other.__aspect_ratio=='auto':
+        elif other.__aspect_ratio=='automatic':
             g.__aspect_ratio=self.__aspect_ratio
         else:
             g.__aspect_ratio = max(self.__aspect_ratio, other.__aspect_ratio)
@@ -1420 +1422 @@
           will look round and a unit square will appear to have sides
           of equal length. If the aspect ratio is set ``2``, vertical units will be
           twice as long as horizontal units, so a unit square will be twice as
-          high as it is wide.  If set to ``'auto'``, the aspect ratio
+          high as it is wide.  If set to ``'automatic'``, the aspect ratio
           is determined by ``figsize`` and the picture fills the figure.
 
         - ``axes`` - (default: True)
@@ -1968 +1970 @@
             subplot = figure.add_subplot(111)
         if aspect_ratio is None:
             aspect_ratio=self.aspect_ratio()
-        subplot.set_aspect(aspect_ratio, adjustable='box')
+        if aspect_ratio == 'automatic':
+            subplot.set_aspect('auto', adjustable='box')
+        else:
+            subplot.set_aspect(aspect_ratio, adjustable='box')
         #add all the primitives to the subplot
         for g in self.__objects:
             g._render_on_subplot(subplot)
@@ -2691 +2696 @@
 @rename_keyword(color='rgbcolor')
 @options(alpha=1, thickness=1, fill=False, fillcolor='automatic', fillalpha=0.5, rgbcolor=(0,0,1), plot_points=200,
          adaptive_tolerance=0.01, adaptive_recursion=5, detect_poles = False, exclude = None, legend_label=None,
-         __original_opts=True, aspect_ratio='auto')
+         __original_opts=True, aspect_ratio='automatic')
 def plot(funcs, *args, **kwds):
     r"""
     Use plot by writing
@@ -3535 +3540 @@
     kwds['polar']=True
     return plot(funcs, *args, **kwds)
 
-@options(aspect_ratio='auto')
+@options(aspect_ratio='automatic')
 def list_plot(data, plotjoined=False, **kwargs):
     r"""
     ``list_plot`` takes either a single list of data, a list of tuples,

sage/plot/plot3d/base.pyx

@@ -947 +947 @@
             opts['aspect_ratio'] = (1, 1, 1)
         if not isinstance(opts['aspect_ratio'], (str, list, tuple)):
             raise TypeError, 'aspect ratio must be a string, list, tuple, or 1'
+        # deal with any aspect_ratio instances passed from the default options to plot
+        if opts['aspect_ratio'] == 'auto':
+            opts['aspect_ratio'] = 'automatic'
 
         if opts['frame_aspect_ratio'] == 'automatic':
             if opts['aspect_ratio'] != 'automatic':
@@ -1029 +1032 @@
 
             sage: sphere((0,0,0))
 
-        EXAMPLES: We illustrate use of the aspect_ratio option::
+        EXAMPLES: We illustrate use of the ``aspect_ratio`` option::
 
             sage: x, y = var('x,y')
             sage: p = plot3d(2*sin(x*y), (x, -pi, pi), (y, -pi, pi))
@@ -1043 +1046 @@
 
             sage: p.show(aspect_ratio=[1,1,1], frame_aspect_ratio=[1,1,1/8])
 
+        This example shows indirectly that the defaults 
+        from :func:`~sage.plot.plot.plot` are dealt with properly::
+
+            sage: plot(vector([1,2,3]))
+
         We use the 'canvas3d' backend from inside the notebook to get a view of
         the plot rendered inline using HTML canvas::
 

sage/plot/plot3d/plot_field3d.py

@@ -57 +57 @@
         sage: plot_vector_field3d((x*cos(z),-y*cos(z),sin(z)), (x,0,pi), (y,0,pi), (z,0,pi),plot_points=4)
         sage: plot_vector_field3d((x*cos(z),-y*cos(z),sin(z)), (x,0,pi), (y,0,pi), (z,0,pi),plot_points=[3,5,7])
         sage: plot_vector_field3d((x*cos(z),-y*cos(z),sin(z)), (x,0,pi), (y,0,pi), (z,0,pi),center_arrows=True)
+
+    TESTS:
+
+    This tests that Trac # 2100 is fixed in a way compatible with this command::
+
+        sage: plot_vector_field3d((x*cos(z),-y*cos(z),sin(z)), (x,0,pi), (y,0,pi), (z,0,pi),center_arrows=True,aspect_ratio=(1,2,1))
     """
     (ff,gg,hh), ranges = setup_for_eval_on_grid(functions, [xrange, yrange, zrange], plot_points)
     xpoints, ypoints, zpoints = [srange(*r, include_endpoint=True) for r in ranges]

sage/plot/point.py

@@ -312 +312 @@
         return point3d(points, **kwds)
 
 @rename_keyword(color='rgbcolor', pointsize='size')
-@options(alpha=1, size=10, faceted=False, rgbcolor=(0,0,1), legend_label=None)
+@options(alpha=1, size=10, faceted=False, rgbcolor=(0,0,1), legend_label=None, aspect_ratio='automatic')
 def point2d(points, **options):
     r"""
     A point of size ``size`` defined by point = `(x,y)`.

sage/plot/scatter_plot.py

@@ -128 +128 @@
         options = self.options()
         subplot.scatter(self.xdata, self.ydata, alpha=options['alpha'], zorder=options['zorder'], marker=options['marker'],s=options['markersize'],facecolors=options['facecolor'], edgecolors=options['edgecolor'])
 
-@options(alpha=1, markersize=50, marker='o', zorder=5, facecolor='#fec7b8', edgecolor='black', aspect_ratio='auto')
+@options(alpha=1, markersize=50, marker='o', zorder=5, facecolor='#fec7b8', edgecolor='black', aspect_ratio='automatic')
 def scatter_plot(datalist, **options):
     """
     Returns a Graphics object of a scatter plot containing all points in