tioga 1.4

data/split/Tioga/lib/Legends.rb

@@ -0,0 +1,190 @@
+#  Legends.rb
+
+module Tioga
+
+# These are the methods and attributes for plot legends.
+
+class Legends < Doc < FigureMaker
+
+# :call-seq:
+#               reset_legend_info                         
+#                   
+# Clears the current legend information.
+    def reset_legend_info
+    end
+
+# Creates a vertical space of _dy_ text heights in the legend.
+    def save_legend_separator(dy)
+    end
+
+# :call-seq:
+#               legend_height                         
+#                   
+# Returns the height (in units of text heights) of the currently saved legend information.
+    def legend_height
+    end
+
+# :call-seq:
+#               show_legend                         
+#                   
+# Shows the legend in the current frame.
+    def show_legend
+    end
+
+=begin rdoc
+:call-seq:
+    save_legend_info(text)
+    save_legend_info(dict)
+
+Saves information for later use in creating a legend.  If called with a string as argument,
+is equivalent to calling with a dictionary having a single entry with key 'text' and value the string.
+
+Dictionary Entries
+    'text'          => a_string      # text of the legend
+    'line_color'    => a_color       # defaults to self.line_color
+    'line_width'    => a_float       # defaults to self.line_width
+    'line_cap'      => a_line_cap    # defaults to self.line_cap
+    'line_type'     => a_line_type   # defaults to self.line_type
+    'dy'            => a_float       # defaults to self.legend_text_dy
+    'marker'        => a_marker      # defaults to nil
+    'marker_color'  => a_color       # defaults to self.line_color
+    'marker_scale'  => a_float       # defaults to 0.5
+    'marker_dict'   => a_dictionary  # defaults to nil
+
+The dictionary holding the information is appended to the legend_info array.  If the 'marker' entry is present,
+then the marker with the given 'marker_color' and 'marker_scale' will be shown in the middle of the
+legend line.  If the 'marker_dict' entry is present, it will have the values for 'x' and 'y' set to the location
+of the middle of the legend line and then it will be passed to the show_marker method.  This gives you the option of using
+the full range of marker functionality in legends -- perhaps you'd like to use a line marker that is rotated, stretched, filled in one color, and stroked in another!
+
+=end
+    def save_legend_info(arg)
+    end
+
+# :call-seq:
+#               legend_defaults                                     
+#               legend_defaults = a_dictionary
+#
+# This dictionary holds defaults for +show_plot_with_legend+.
+   def legend_defaults
+   end
+
+# :call-seq:
+#               legend_info                                     
+#
+# The current array of saved legend dictionaries.  See save_legend_info for details.
+   def legend_info
+   end
+
+# :call-seq:
+#               legend_line_x0                                     
+#               legend_line_x0 = a_float
+#
+# The x position for the start of lines in a legend, measured in units
+# of text height.  The corresponding position in figure coordinates is
+# (legend_line_x0 * legend_scale * default_text_height_dx).
+   def legend_line_x0
+   end
+   
+# :call-seq:
+#               legend_line_x1                                     
+#               legend_line_x1 = a_float
+#
+# The x position for the end of lines in a legend, measured in units
+# of text height.  The corresponding position in figure coordinates is
+# (legend_line_x1 * legend_scale * default_text_height_dx).
+   def legend_line_x1
+   end
+   
+# :call-seq:
+#               legend_line_dy                                     
+#               legend_line_dy = a_float
+#
+# Each line in a legend is shifted up from the text baseline by this amount
+# measured in units of text height.  The corresponding distance in figure coordinates is
+# (legend_line_dy * legend_scale * default_text_height_dy).
+   def legend_line_dy
+   end
+
+# :call-seq:
+#               legend_text_width                                     
+#               legend_text_width = a_float
+#
+# The assumed width of text in a legend, measured in units
+# of text height.  The corresponding width in figure coordinates is
+# (legend_text_width * legend_scale * default_text_height_dx).
+# The figure bounding box is expanded if necessary to provide for this
+# much space.  If legend_text_width is negative, then the system will
+# provide a default value depending on the placement of the legend.
+   def legend_text_width
+   end
+
+# :call-seq:
+#               legend_text_xstart                                     
+#               legend_text_xstart = a_float
+#
+# The x position for the start of text in a legend, measured in units
+# of text height.  The corresponding position in figure coordinates is
+# (legend_text_xstart * legend_scale * default_text_height_dx).
+   def legend_text_xstart
+   end
+
+# :call-seq:
+#               legend_text_ystart                                     
+#               legend_text_ystart = a_float
+#
+# The y position for the start of text in a legend, measured in units
+# of text height.  The corresponding position in figure coordinates is
+# (legend_text_ystart * legend_scale * default_text_height_dy).
+   def legend_text_ystart
+   end
+
+# :call-seq:
+#               legend_text_dy                                     
+#               legend_text_dy = a_float
+#
+# The distance in y to move down after a legend line entry, measured in
+# units of text height.  The corresponding distance in figure coordinates is
+# (legend_text_dy * legend_scale * default_text_height_dy).
+   def legend_text_dy
+   end
+
+# :call-seq:
+#               legend_line_width                                     
+#               legend_line_width = a_float
+#
+# If this is non-negative, then it is used as the line_width attribute when
+# stroking the lines in a legend.  If it is negative, then each legend
+# line is stroked using the value of the line_width attribute at the time
+# the legend information for the entry was saved by save_legend_info.
+   def legend_line_width
+   end
+
+# :call-seq:
+#               legend_scale                                     
+#               legend_scale = a_float
+#
+# Used for determining positions in the legend and for showing  legend text.
+   def legend_scale
+   end
+
+# :call-seq:
+#               legend_alignment                                     
+#               legend_alignment = an_alignment
+#
+# Used as the #alignment value in showing  legend text.
+   def legend_alignment
+   end
+
+# :call-seq:
+#               legend_justification                                     
+#               legend_justification = a_justification
+#
+# Used as the #justification value in showing legend text.
+   def legend_justification
+   end
+
+
+
+end # class
+end # module Tioga

data/split/Tioga/lib/MarkerConstants.rb

@@ -0,0 +1,122 @@
+module Tioga
+
+# = PDF Fonts
+#
+# Text is normally sent to TeX, allowing you to use any font that can be accessed from your TeX documents.  
+# However, in certain special cases you may need to use text in a "graphical" manner and have it processed directly in the 
+# PDF output.  In that case, tioga needs to have metric information for the font (in the form of an "afm" file), and any 
+# output device needs to have access to the font definitions.  Providing a general solution to this is still a bit messy, and for the 
+# expected use in tioga, I decided that it wasn't worth it.  All PDF devices are guaranteed to have the 14 standard Adobe 
+# fonts, so they are easy to provide -- and that's what I've done.
+#
+# Here are the abc's of the PDF fonts, clockwise from the top: Times_Roman, Times_Italic, Times_Bold, Times_BoldItalic, Helvetica, Helvetica_Oblique, Helvetica_Bold, Helvetica_BoldOblique, Courier, Courier_Oblique, Courier_Bold, Courier_BoldOblique, Symbol, and ZapfDingbats.
+#
+# http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/pdf_fonts.jpg
+#
+# ---
+#
+# = Markers
+#
+# Any character from any of the PDF fonts can be used as a marker.
+# The predefined marker names are provided as a convenience, not as an exhaustive list.   Markers are specified by 
+# either a font number and character code (for filled characters), or by a font number, character code, and line 
+# width (for stroked characters).  In the following figure many of the markers appear in both a filled form, such 
+# as 'Arrow', and a stroked form, such as 'ArrowOpen'.   The color of filled markers is determined by the current 
+# setting of fill_color, and, similarly, stroke_color determines the color of stroked markers.
+#
+# http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/Marker_Names.jpg
+#
+# Here is the full set of options from the ZapfDingbats font.  If you would like to use the jet plane as a marker,
+# just write [ ZapfDingbats, 40 ] where you would have used one of the predefined marker names.
+#
+# http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/dingbats.jpg
+#
+
+module MarkerConstants
+
+    Times_Roman = 1
+    Times_Italic = 2
+    Times_Bold = 3
+    Times_BoldItalic = 4
+    Helvetica = 5
+    Helvetica_Oblique = 6
+    Helvetica_Bold = 7
+    Helvetica_BoldOblique = 8
+    Courier = 9
+    Courier_Oblique = 10
+    Courier_Bold = 11
+    Courier_BoldOblique = 12
+    Symbol = 13
+    ZapfDingbats = 14
+    
+    Arrow           = [ZapfDingbats, 0334]
+    Arrowhead       = [ZapfDingbats, 0344]
+    Asterisk        = [ZapfDingbats, 0135]
+    Bar             = [ZapfDingbats, 0171]
+    BarThick        = [ZapfDingbats, 0172]
+    BarThin         = [ZapfDingbats, 0170]
+    Box             = [ZapfDingbats, 0156]
+    Bullet          = [ZapfDingbats, 0154]
+    Check           = [ZapfDingbats, 0064]
+    Circle          = [ZapfDingbats, 0154]
+    Club            = [ZapfDingbats, 0250]
+    Cross           = [ZapfDingbats, 0072]
+    Diamond         = [ZapfDingbats, 0251]
+    Semicircle      = [ZapfDingbats, 0167]
+    Heart           = [ZapfDingbats, 0252]
+    HeartWide       = [ZapfDingbats, 0244]
+    Spade           = [ZapfDingbats, 0253]
+    Square          = [ZapfDingbats, 0156]
+    Star            = [ZapfDingbats, 0110]
+    TriangleDown    = [ZapfDingbats, 0164]
+    TriangleUp      = [ZapfDingbats, 0163]
+    Plus            = [ZapfDingbats, 0072]
+    Times           = [ZapfDingbats, 0066]
+    
+    ArrowOpen           = [ZapfDingbats, 0334, 0.5]
+    ArrowheadOpen       = [ZapfDingbats, 0344, 0.5]
+    AsteriskOpen        = [ZapfDingbats, 0135, 0.5]
+    BarOpen             = [ZapfDingbats, 0172, 0.5]
+    BarThickOpen        = [ZapfDingbats, 0172, 0.5]
+    BarThinOpen         = [ZapfDingbats, 0170, 0.5]
+    BoxOpen             = [ZapfDingbats, 0156, 0.5]
+    BulletOpen          = [ZapfDingbats, 0154, 0.5]
+    CheckOpen           = [ZapfDingbats, 0064, 0.5]
+    CircleOpen          = [ZapfDingbats, 0154, 0.5]
+    ClubOpen            = [ZapfDingbats, 0250, 0.5]
+    DiamondOpen         = [ZapfDingbats, 0251, 0.5]
+    SemicircleOpen      = [ZapfDingbats, 0167, 0.5]
+    HeartOpen           = [ZapfDingbats, 0252, 0.5]
+    HeartWideOpen       = [ZapfDingbats, 0244, 0.5]
+    SpadeOpen           = [ZapfDingbats, 0253, 0.5]
+    SquareOpen          = [ZapfDingbats, 0156, 0.5]
+    StarOpen            = [ZapfDingbats, 0110, 0.5]
+    TriangleDownOpen    = [ZapfDingbats, 0164, 0.5]
+    TriangleUpOpen      = [ZapfDingbats, 0163, 0.5]
+    PlusOpen            = [ZapfDingbats, 0072, 0.5]
+    TimesOpen           = [ZapfDingbats, 0066, 0.5]
+    Circled1       = [ZapfDingbats, 0300]
+    Circled2       = [ZapfDingbats, 0301]
+    Circled3       = [ZapfDingbats, 0302]
+    Circled4       = [ZapfDingbats, 0303]
+    Circled5       = [ZapfDingbats, 0304]
+    Circled6       = [ZapfDingbats, 0305]
+    Circled7       = [ZapfDingbats, 0306]
+    Circled8       = [ZapfDingbats, 0307]
+    Circled9       = [ZapfDingbats, 0310]
+    Circled10      = [ZapfDingbats, 0311]
+    SolidBall1    = [ZapfDingbats, 0312]
+    SolidBall2    = [ZapfDingbats, 0313]
+    SolidBall3    = [ZapfDingbats, 0314]
+    SolidBall4    = [ZapfDingbats, 0315]
+    SolidBall5    = [ZapfDingbats, 0316]
+    SolidBall6    = [ZapfDingbats, 0317]
+    SolidBall7    = [ZapfDingbats, 0320]
+    SolidBall8    = [ZapfDingbats, 0321]
+    SolidBall9    = [ZapfDingbats, 0322]
+    SolidBall10   = [ZapfDingbats, 0323]
+    Hand          = [ZapfDingbats, 0052]
+    OtherHand     = [ZapfDingbats, 0053]
+
+end
+end # module Tioga

data/split/Tioga/lib/Markers.rb

@@ -0,0 +1,129 @@
+#  Markers.rb
+
+module Tioga
+
+# These are the methods for using text as markers in PDF graphics.  See also the predefined markers in #MarkerConstants.
+
+class Markers < Doc < FigureMaker
+
+=begin rdoc
+This routine takes care of text that is being used as a graphical element and consequently is going
+straight to PDF rather than to TeX for normal typesetting (see show_text).
+
+The most common use of markers is probably to mark points on plots (hence the name).  The ZapfDingbats font
+provides a useful collection for this purpose, and several glyphs from it are provided as predefined markers
+(see #MarkerConstants).
+A marker of this sort is represented either by an array of [ font_number, character_code ] for filled markers, or by
+an array holding [ font_number, character_code, line_width ] for stroked markers.  Often the same character
+can be used both for a filled marker and for an open one.  For example, the predefined markers include 
+Box and Circle (filled) as well as the same glyphs as BoxOpen and CircleOpen (stroked).  
+
+For the primary purpose of marking points on plots, we could stop with just single characters taken from
+ZapfDingbats.  However, for not much more effort, we can broaden this to allow strings of characters
+and fonts other than the dingbats.  But the usefulness of this is limited given that typesetting is
+properly done using TeX, and the problems of dealing with fonts in general are notoriously awful.
+So the  compromise is to allow markers using any of the 14 standard Adobe PDF
+fonts which are guaranteed to be supported by all PDF viewers and to toss in for good measure some
+Computer Modern fonts which are likely to be around since they come with TeX.  These fonts are predefined
+in the FigureConstants module.  Any character (or string of characters) from any of these fonts can be used as a marker.
+
+Because markers are sent to PDF rather than TeX, they are limited typographically but powerful graphically.
+In addition to specifying color, scale, and rotatation, as you can for TeX text, you can also stretch
+the characters either along the baseline ('horizontal_scale') or perpendicular to it ('vertical_scale').
+You can slant the individual characters ('italic_angle') or shift the baseline along the text ('ascent_angle').
+Finally, you can specify the 'rendering_mode' for the marker to be any combination of #fill, #stroke, and #clip.
+(So for next Valentine's Day you can take a Heart marker, scale it up, and use it to clip a JPEG image of yourself
+to send to your sweetheart.)
+
+Defaults for many of the entries come from the marker_defaults dictionary.
+
+Dictionary Entries
+    'marker'            => a_marker              # a marker definition array
+    'x'                 => a_float               # x location for marker reference point
+    'y'                 => a_float               # y location for marker reference point
+    'at'                => [ x, y ]              # location for marker reference point
+    'point'                                      # alias for 'at'
+    'Xs'                => a_Dvector             # x locations for marker reference points
+    'Ys'                => a_Dvector             # y locations for marker reference points
+    'xs'                                         # alias for 'Xs'
+    'ys'                                         # alias for 'Ys'
+    'font'              => an_integer            # one of the predefined font numbers
+    'string'            => a_string              # to be shown as a marker
+    'text'                                       # alias for 'string'
+    'fill_color'        => a_color               # to be used for filled markers
+    'stroke_color'      => a_color               # to be used for stroked markers
+    'color'             => a_color               # default for fill_color and stroke_color
+    'angle'             => a_float               # degrees to rotate marker
+    'scale'             => a_float               # factor for rescaling marker size
+    'horizontal_scale'  => a_float               # for scaling along baseline
+    'vertical_scale'    => a_float               # for scaling vertical to baseline
+    'italic_angle'      => a_float               # for slanting text relative to baseline
+    'ascent_angle'      => a_float               # factor for slanting baseline
+    'alignment'         => an_alignment          # see alignment
+    'justification'     => a_justification       # see justification
+    'rendering_mode'    => a_rendering_mode      # see below
+    'stroke_width'      => a_float               # to be used for stroked markers
+    'mode'                                       # alias for 'rendering_mode'
+
+
+Examples
+
+http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/Marker_Horizontal_Scaling.jpg
+
+http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/Marker_Vertical_Scaling.jpg
+
+http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/Marker_Italic_Angle.jpg
+
+http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/Marker_Ascent_Angle.jpg
+
+http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/Rendering_Modes.jpg
+
+    def marker_shadow_effect
+        t.landscape
+        background
+        scale = 2.6
+        t.line_width = 0.6
+        x = t.bounds_xmin + 0.5 * t.bounds_width
+        dy = -0.5; y = 1 + dy;
+        t.show_marker(
+            'string' => 'Shadow Effect',
+            'scale' => scale,
+            'point' => [x, y],
+            'mode' => FILL_AND_STROKE,
+            'alignment' => ALIGNED_AT_BASELINE,
+            'fill_color' => Blue,
+            'stroke_color' => Black)
+        t.fill_opacity = 0.8
+        t.show_marker(
+            'string' => 'Shadow Effect',
+            'vertical_scale' => -0.4,
+            'fill_color' => Grey,
+            'italic_angle' => -30,
+            'scale' => scale,
+            'point' => [x+0.022, y-0.03])
+    end
+    
+http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/Marker_Shadow_Effect.jpg
+
+=end
+    def show_marker(dict)
+    end
+
+# Returns an array with [_width_, <i>dx_left</i>, <i>dx_right</i>, <i>dy_down</i>, <i>dy_up</i>] given in
+# figure coordinates.  The first is the width in figure x coordinates, the remainder is the bounding box
+# relative to the reference point for showing the string.
+   def marker_string_info(font_number, string, scale)
+   end
+
+# :call-seq:
+#               marker_defaults                                     
+#               marker_defaults = a_dictionary
+#
+# This dictionary holds defaults for +show_marker+.
+   def marker_defaults
+   end
+
+
+
+end # class
+end # module Tioga

data/split/Tioga/lib/Page_Frame_Bounds.rb

@@ -0,0 +1,567 @@
+#  Page_Frame_Bounds.rb
+
+module Tioga
+    
+=begin rdoc
+
+This section describes the coordinate systems used by tioga for page layout.
+
+The "output page" is defined in "output coordinates"
+having units equal to 1/720 of an inch.  This unit is 1/10 of a "big point" that is the basic size used in PostScript and PDF.
+By making the unit this size, we can write output coordinates to the PDF file as integers, getting a significant size reduction in
+the file without giving up noticable accuracy.  The (0, 0) point of the output coordinate system is at the lower-left hand corner
+of the output page.  The x axis increases horizontally, and the y axis increases vertically.  The  dimensions of the page
+are given by the attributes page_width and page_height.  
+The attributes page_right and page_top are aliases for these.
+The attributes page_left and page_bottom are always zero.  The default page size is 5 inches square, 
+but you can set the size to anything you like using the set_device_pagesize routine. 
+
+While the output coordinates have a fixed physical size, all the other coordinate systems are relative rather than absolute.
+At the next level comes "page coordinates" that are defined relative to the output page with (0, 0) in page coordinates 
+at the lower left corner  of the output page and (1, 1) at the upper right.  Page coordinates are used to define the location of
+the current "frame".  The current frame location is held in the attributes frame_left, frame_right, frame_top, and frame_bottom,
+all in page coordinates.  In addition, the attribute frame_width is defined to be frame_right - frame_left, and frame_height is frame_top -
+frame_bottom.  The defaults are (0.2, 0.2) for the lower left corner of the frame and (0.8, 0.8) for the upper right.
+You can change these by calling the routine set_frame_sides.
+
+The "frame coordinates" are defined with (0, 0) at the lower left corner of the frame and (1, 1) at the upper right.  Subframes are
+sized and located using frame coordinates.  The routine set_subframe does this job.  In addition, subframes are used to
+give a desired aspect ratio.  The routine set_aspect_ratio_relative_to_frame does this in terms of frame coordinates -- in
+other words, it creates a subframe having the requested ratio of width to height relative to the frame.  In some cases
+that will be what you want, but it is more common to want to specify the width to height ratio relative to the output page, i.e.,
+in absolute rather than relative terms.   This is provided by the routine set_physical_aspect_ratio (with set_aspect_ratio as an alias).
+
+When doing a plot, you want yet another coordinate system, one that matches the data.  This is called the "figure coordinate system"
+and is set by the "bounds" attributes that give the locations in figure coordinates of the edges of the frame.  These attributes are
+called bounds_right, bounds_left, bounds_top, and bounds_bottom.  Note that you can "reverse" the x axis, for example, by making
+bounds_right smaller than bounds_left.  To help with the bookkeeping for this, the attribute bounds_xmin holds the minimum
+of bounds_left and bounds_right, while bounds_ymin has the minimum of bounds_top and bounds_bottom.  Finally, bounds_width holds
+the absolute value of bounds_right - bounds_left and bounds_height has abs(bounds_top - bounds_bottom).  The default bounds
+are 0 for left and bottom and 1 for right and top, making figure coordinates identical to frame coordinates.  The bounds can be
+changed by calling the set_bounds routine.
+
+
+
+
+
+
+
+=end
+
+
+class Page_Frame_Bounds < Doc < FigureMaker
+
+# :call-seq:
+#               set_device_pagesize(width, height) # measured in output page coordinates (1/720 inch)                                 
+#
+# The page coordinates go from 0.0 to 1.0 with (0,0) at the lower left and (1,1) at the upper right.
+# This command sets the physical size of this rectangle in the output coordinate 
+   def set_device_pagesize(width, height)
+   end
+
+# :call-seq:
+#               page_left                                     
+#
+# The position of the left of the page in the device coordinate system -- measured in output page coordinates (1/720 inch).
+   def page_left
+   end
+
+# :call-seq:
+#               page_right                                     
+#
+# The position of the right of the page in the device coordinate system -- measured in output page coordinates (1/720 inch).
+   def page_right
+   end
+
+# :call-seq:
+#               page_bottom                                     
+#
+# The position of the bottom of the page in the device coordinate system -- measured in output page coordinates (1/720 inch).
+   def page_bottom
+   end
+
+# :call-seq:
+#               page_top                                     
+#
+# The position of the top of the page in the device coordinate system -- measured in output page coordinates (1/720 inch).
+   def page_top
+   end
+
+# :call-seq:
+#               page_width                                     
+#
+# The width of the page in the device coordinate system -- measured in output page coordinates (1/720 inch).
+   def page_width
+   end
+
+# :call-seq:
+#               page_height                                     
+#
+# The height of the page in the device coordinate system -- measured in output page coordinates (1/720 inch).
+   def page_height
+   end
+   
+
+# :call-seq:
+#               set_frame_sides(left, right, top, bottom) # sizes in page coords [0..1]                                 
+#
+# This command sets frame_left, frame_right, frame_top, and frame_bottom to the given values. 
+   def set_frame_sides(left, right, top, bottom)
+   end
+
+# :call-seq:
+#               frame_left                                     
+#
+# The position of the left of the frame in the page x coordinate system which runs from 0 at the left to 1 at the right.
+# Initialized to 0.2 and changed by set_subframe.
+   def frame_left
+   end
+
+# :call-seq:
+#               frame_right                                     
+#
+# The position of the right of the frame in the page x coordinate system which runs from 0 at the left to 1 at the right.
+# Initialized to 0.8 and changed by set_subframe.
+   def frame_right
+   end
+
+# :call-seq:
+#               frame_bottom                                     
+#
+# The position of the bottom of the frame in the page y coordinate system which runs from 0 at the bottom to 1 at the top.
+# Initialized to 0.2 and changed by set_subframe.
+   def frame_bottom
+   end
+
+# :call-seq:
+#               frame_top                                     
+#
+# The position of the top of the frame in the page y coordinate system which runs from 0 at the bottom to 1 at the top.
+# Initialized to 0.8 and changed by set_subframe.
+   def frame_top
+   end
+
+# :call-seq:
+#               frame_width                                     
+#
+# The width of the frame in page coordinates.
+# Initialized to 0.6 and changed by set_subframe.
+   def frame_width
+   end
+
+# :call-seq:
+#               frame_height                                     
+#
+# The height of the frame in page coordinates.
+# Initialized to 0.6 and changed by set_subframe.
+   def frame_height
+   end
+
+# :call-seq:
+#               bounds_left                                     
+#
+# The position of the left of the frame in the figure coordinate system.
+# Initialized to 0.0 and changed by set_bounds.
+   def bounds_left
+   end
+
+# :call-seq:
+#               bounds_right                                     
+#
+# The position of the right of the frame in the figure coordinate system.
+# Initialized to 1.0 and changed by set_bounds.
+   def bounds_right
+   end
+
+# :call-seq:
+#               bounds_bottom                                     
+#
+# The position of the bottom of the frame in the figure coordinate system.
+# Initialized to 0.0 and changed by set_bounds.
+   def bounds_bottom
+   end
+
+# :call-seq:
+#               bounds_top                                     
+#
+# The position of the top of the frame in the figure coordinate system.
+# Initialized to 1.0 and changed by set_bounds.
+   def bounds_top
+   end
+
+# :call-seq:
+#               bounds_width                                     
+#
+# The width of the frame in figure coordinates.
+# Initialized to 1.0 and changed by set_bounds.
+   def bounds_width
+   end
+
+# :call-seq:
+#               bounds_height                                     
+#
+# The height of the frame in figure coordinates.
+# Initialized to 1.0 and changed by set_bounds.
+   def bounds_height
+   end
+
+# :call-seq:
+#               bounds_xmin                                     
+#
+# The minimum x figure coordinate that is inside the frame.
+# Initialized to 0.0 and changed by set_bounds.
+   def bounds_xmin
+   end
+
+# :call-seq:
+#               bounds_xmax                                     
+#
+# The maximum x figure coordinate that is inside the frame.
+# Initialized to 1.0 and changed by set_bounds.
+   def bounds_xmax
+   end
+
+# :call-seq:
+#               bounds_ymin                                     
+#
+# The minimum y figure coordinate that is inside the frame.
+# Initialized to 0.0 and changed by set_bounds.
+   def bounds_ymin
+   end
+
+# :call-seq:
+#               bounds_ymax                                     
+#
+# The maximum y figure coordinate that is inside the frame.
+# Initialized to 1.0 and changed by set_bounds.
+   def bounds_ymax
+   end
+
+=begin rdoc
+Adjusts frame margins according to the entries in the dictionary argument.  
+Note that this does not automatically adjust the clipping rectangle to the new frame.
+If you want the clipping changed, call clip_to_frame after calling set_subframe.
+
+Dictionary Entries
+    'left_margin'      => a_float     # optional
+    'right_margin'     => a_float     # optional
+    'top_margin'       => a_float     # optional
+    'bottom_margin'    => a_float     # optional
+    'left'                            # alias for 'left_margin'
+    'right'                           # alias for 'right_margin'
+    'top'                             # alias for 'top_margin'
+    'bottom'                          # alias for 'bottom_margin'
+
+The following forms are also supported for calls to set_subframe:
+
+    set_subframe('margins' => [ left, right, top, bottom ])
+    set_subframe([ left, right, top, bottom ])
+
+=end
+    def set_subframe(dict=nil)
+    end
+
+=begin rdoc
+Returns a dictionary with entries for 'left_margin' and 'right_margin' suitable for use with
+set_subframe.  The margins are determined by the column specifications in the argument _dict_.
+The leftmost column is number 1 and the number of columns equals the column number for the rightmost column.
+The entries 'left_margin' and 'right_margin' determine the space outside the columns, and 'column_margin' is the space between
+columns, all given as fractions of the frame width.  The space between the outer margins is divided to make room
+for 'num_columns' of equally wide columns.  The returned margins bracket the requested 'column', or the
+requested range of columns from 'first_column' to 'last_column', inclusive.  See also row_margins.
+
+Dictionary Entries
+    'left_margin'       => a_float      # default is 0
+    'right_margin'      => a_float      # default is 0
+    'column_margin'     => a_float      # default is 0
+    'column'            => an_integer
+    'first_column'      => an_integer   # default is 1
+    'last_column'       => an_integer   # default is 'first_column'
+    'num_columns'       => an_integer   # default is 'last_column'
+
+Example
+
+    def columns
+        t.set_aspect_ratio(2)
+        t.rescale(0.8)
+        t.do_box_labels(
+            'Blues, Reds, Greens',
+            'Position',
+            'Values for Colors')
+        num_plots = 3
+        t.subplot(t.column_margins('num_columns' => 3, 'column' => 1)) do
+            t.right_edge_type = AXIS_HIDDEN
+            blues
+        end
+        t.subplot(t.column_margins('num_columns' => 3, 'column' => 2)) do 
+            t.yaxis_type = AXIS_WITH_TICKS_ONLY
+            t.right_edge_type = AXIS_HIDDEN
+            reds
+        end
+        t.subplot(t.column_margins('num_columns' => 3, 'column' => 3)) do
+            t.yaxis_type = AXIS_WITH_TICKS_ONLY
+            t.right_edge_type = AXIS_WITH_TICKS_ONLY
+            greens
+        end
+    end
+    
+http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/Columns.jpg
+=end
+    def column_margins(dict)
+    end
+    
+=begin rdoc
+Returns a dictionary with entries for 'top_margin' and 'bottom_margin' suitable for use with
+set_subframe.  The margins are determined by the row specifications in the argument _dict_.
+The uppermost row is number 1 and the number of rows equals the row number for the bottom-most row.
+The entries 'top_margin' and 'bottom_margin' determine the space above and below the rows, and 'row_margin' is the space between
+rows, all given as fractions of the frame height.  The space between the outer margins is divided to make room
+for 'num_rows' of equally tall rows.  The returned margins bracket the requested 'row', or the
+requested range of rows from 'first_row' to 'last_row', inclusive.  See also column_margins.
+
+Dictionary Entries
+    'top_margin'        => a_float      # default is 0
+    'bottom_margin'     => a_float      # default is 0
+    'row_margin'        => a_float      # default is 0
+    'row'               => an_integer
+    'first_row'         => an_integer   # default is 1
+    'last_row'          => an_integer   # default is 'first_row'
+    'num_rows'          => an_integer   # default is 'last_row'
+
+=end
+    def row_margins(dict)
+    end
+        
+=begin rdoc
+Sets the bounds according to the entries in the dictionary argument (called by show_plot).
+
+The values of the entries
+are the figure coordinates for the edges of the frame.  The following attributes are changed:
+bounds_left, bounds_right, bounds_bottom, bounds_top, xaxis_reversed, bounds_xmin, bounds_xmax,
+bounds_width, yaxis_reversed, bounds_ymin, bounds_ymax, bounds_height,
+default_text_height_dx, and default_text_height_dy.
+
+Dictionary Entries
+    'bounds_left' => a_float     # required
+    'bounds_right' => a_float    # required
+    'bounds_top' => a_float      # required
+    'bounds_bottom' => a_float   # required
+    'left_boundary'              # alias for 'bounds_left'
+    'right_boundary'             # alias for 'bounds_right'
+    'top_boundary'               # alias for 'bounds_top'
+    'bottom_boundary'            # alias for 'bounds_bottom'
+
+The following forms are also supported for calls to set_bounds:
+
+    set_bounds('boundaries' => [ left, right, top, bottom ])
+    set_bounds([ left, right, top, bottom ])
+    
+=end
+    def set_bounds(dict=nil)
+    end
+
+
+    
+# Convert the distance _d_ measured in output coordinates to millimeters.
+    def convert_output_to_mm(d)
+    end
+    
+# Convert the distance _d_ measured in millimeters to output coordinates.
+    def convert_mm_to_output(d)
+    end
+    
+# Convert the distance _d_ measured in output coordinates to inches.
+    def convert_output_to_inches(d)
+    end
+    
+# Convert the distance _d_ measured in inches to output coordinates.
+    def convert_inches_to_output(d)
+    end
+    
+    
+# Convert the position _x_ measured in page x coordinates to the 
+# position in output x coordinates.
+    def convert_page_to_output_x(x)
+    end
+
+    
+# Convert the position _y_ measured in page y coordinates to the 
+# position in output y coordinates.
+    def convert_page_to_output_y(y)
+    end
+
+# Convert the distance _dx_ measured in page x coordinates to the 
+# distance in output x coordinates.
+    def convert_page_to_output_dx(dx)
+    end
+
+# Convert the distance _dy_ measured in page y coordinates to the 
+# distance in output y coordinates.
+    def convert_page_to_output_dy(dy)
+    end
+
+# Convert the position _x_ measured in output x coordinates to the 
+# position in page x coordinates.
+    def convert_output_to_page_x(x)
+    end
+
+# Convert the position _y_ measured in output y coordinates to the 
+# position in page y coordinates.
+    def convert_output_to_page_y(y)
+    end
+
+# Convert the distance _dx_ measured in output x coordinates to the 
+# distance in page x coordinates.
+    def convert_output_to_page_dx(dx)
+    end
+
+# Convert the distance _dy_ measured in output y coordinates to the same
+# distance in page y coordinates.
+    def convert_output_to_page_dy(dy)
+    end
+
+# Convert the position _x_ measured in page x coordinates to the 
+# position in frame x coordinates.
+    def convert_page_to_frame_x(x)
+    end
+
+# Convert the position _y_ measured in page y coordinates to the 
+# position in frame y coordinates.
+    def convert_page_to_frame_y(y)
+    end
+
+# Convert the distance _dx_ measured in page x coordinates to the 
+# distance in frame x coordinates.
+    def convert_page_to_frame_dx(dx)
+    end
+
+# Convert the distance _dy_ measured in page y coordinates to the 
+# distance in frame y coordinates.
+    def convert_page_to_frame_dy(dy)
+    end
+
+# Convert the position _x_ measured in frame x coordinates to the 
+# position in page x coordinates.
+    def convert_frame_to_page_x(x)
+    end
+
+# Convert the position _y_ measured in frame y coordinates to the 
+# position in page y coordinates.
+    def convert_frame_to_page_y(y)
+    end
+
+# Convert the distance _dx_ measured in frame x coordinates to the 
+# distance in page x coordinates.
+    def convert_frame_to_page_dx(dx)
+    end
+
+# Convert the distance _dy_ measured in frame y coordinates to the 
+# distance in page y coordinates.
+    def convert_frame_to_page_dy(dy)
+    end
+
+# Convert the position _x_ measured in figure x coordinates to the 
+# position in frame x coordinates.
+    def convert_figure_to_frame_x(x)
+    end
+
+# Convert the position _y_ measured in figure y coordinates to the 
+# position in frame y coordinates.
+    def convert_figure_to_frame_y(y)
+    end
+
+# Convert the distance _dx_ measured in figure x coordinates to the 
+# distance in frame x coordinates.
+    def convert_figure_to_frame_dx(dx)
+    end
+
+# Convert the distance _dy_ measured in figure y coordinates to the 
+# distance in frame y coordinates.
+    def convert_figure_to_frame_dy(dy)
+    end
+
+# Convert the position _x_ measured in frame x coordinates to the 
+# position in figure x coordinates.
+    def convert_frame_to_figure_x(x)
+    end
+
+# Convert the position _y_ measured in frame y coordinates to the 
+# position in figure y coordinates.
+    def convert_frame_to_figure_y(y)
+    end
+
+# Convert the distance _dx_ measured in frame x coordinates to the 
+# distance in figure x coordinates.
+    def convert_frame_to_figure_dx(dx)
+    end
+
+# Convert the distance _dy_ measured in frame y coordinates to the 
+# distance in figure y coordinates.
+    def convert_frame_to_figure_dy(dy)
+    end
+
+# Convert the position _x_ measured in figure x coordinates to the 
+# position in output x coordinates.
+    def convert_figure_to_output_x(x)
+    end
+
+# Convert the position _y_ measured in figure y coordinates to the 
+# position in output y coordinates.
+    def convert_figure_to_output_y(y) 
+    end
+
+# Convert the distance _dx_ measured in figure x coordinates to the 
+# distance in output x coordinates.
+    def convert_figure_to_output_dx(dx)
+    end
+
+# Convert the distance _dy_ measured in figure y coordinates to the 
+# distance in output y coordinates.
+    def convert_figure_to_output_dy(dy)
+    end
+
+# Convert the position _x_ measured in output x coordinates to the 
+# position in figure x coordinates.
+    def convert_output_to_figure_x(x)
+    end
+
+# Convert the position _y_ measured in output y coordinates to the 
+# position in figure y coordinates.
+    def convert_output_to_figure_y(y)
+    end
+
+# Convert the distance _dx_ measured in output x coordinates to the 
+# distance in figure x coordinates.
+    def convert_output_to_figure_dx(dx)
+    end
+
+# Convert the distance _dy_ measured in output y coordinates to the 
+# distance in figure y coordinates.
+    def convert_output_to_figure_dy(dy)
+    end
+
+# Returns the angle measured in degrees clockwise from the horizontal for the
+# slope specified by _dx_ and _dy_ given in figure coordinates.
+    def convert_to_degrees(dx, dy)
+    end
+
+
+=begin rdoc
+:call-seq:
+               tex_preamble                                     
+               tex_preamble = a_string
+
+This string will be used as the "preamble" for the TeX file.
+The default does "usepackage" commands for "color" and "geometry".
+You may want to use some other packages as well.  Here's an example of how to do it which
+adds the 'marvosym' package by inserting the following line into the 'initialize' routine.
+
+        t.tex_preamble = t.tex_preamble + "\n\t\\usepackage{marvosym}\n"
+        
+=end 
+   def tex_preamble
+   end
+
+
+end # class
+end # module Tioga