omde.plot
index
/usr/local/lib/python2.1/site-packages/omde/plot.py

Vector graphics for OMDE/pmask
 
This module requires the Sping module in your python path.

 
Modules
            
re
sping
string
types

 
Classes
            
Plotter
ScorePlotter

 
class Plotter
      Generate a plot of one or more lists and writes it to a PDF file.
 
The cache is stored in two lists:
 
input
contains the readed lists
 
styles
contains the appropriate representation-settings in a
list of dictionaries.
 
  
__init__(self, minY=None, maxY=None, maxX=None)
Create a Plotter() instance.
 
Syntax:
 
a = Plotter( [ minY, maxY, maxX ] )
 
The keyword-arguments define 
a default minimal range of the plot and they may be also omitted.
 
minY
default value for the low range of the plot.
 
maxY
default value for the top range of the plot.
 
maxX
default value for the length of the x axis.
clear(self, index=None)
Clear the cache.
 
Syntax:
 
clear([index])
 
If 'index' is given, than removes the 'index'-th list from the 
cache (the first read list is indexed by 0).
 
If 'index' is not given, than removes all lists from the cache.
read(self, l, **d)
Insert a list of objects (l) into cache.
 
read( list [ keyword_arguments ] ) 
The 'keyword_arguments' specifies the representation of the 'list' in the plot.
 
color
this may be a tuple with 3 values between 0 and 1 
(RGB colors), or one of the predefined PIDDLE colors
given as a string. 'color' default is 'black'.
 
width
linewidth expressed in points. Default is 1. If 0 is given
than no line is drawing.
 
dot
defines radius of the dots. If 0 is given than no dots are 
drawing. Default is 0. 
 
comment
a string with an optional comment text. This 'comment' is 
printed in the output file in the same 'color' as 'list'. 
Default 'comment' is None. The following arguments refers
to the 'comment'. 
 
textFace
some of the predefined PIDDLE fonts, default is 'times'.
 
textSize
default is 14.
 
textBold
default is 0.
write(self, name='omde-plot.pdf', pageWidth=841.88976377952747, pageHeight=595.27559055118104, pageColor='white', plotX=0.59999999999999998, plotY=0.34999999999999998, plotWidth=700, plotHeight=350, plotColor='white', borderWidth=10, borderColor='white*.9', gridColor='white*.9', gridWidth=1, gridXres=10, gridYres=4, numbYround=2, numbXstep=2, numbFace='helvetica', numbSize=10, numbBold=0, comment=1, textFace='times', textSize=16, textColor='black', textBold=0)
Plot the lists in the object cache and writes the plot to a PDF file.
The following 'keyword_arguments' may be given: 
 
Syntax:
 
write( [ keyword_arguments ] )
 
name            - the name of the outputfile (default to 'listPlotter.pdf')
pageWidth       - in points. Default is 841.89 ( A4 horizontal width )
pageHeight      - in points. Default is 595.27 ( A4 horizontal height )
pageColor       - background color of the page. Default is 'white'.
plotX           
plotY           - define the position of the plot on the page. These
                  values should be given in range 0 to 1:
                  'plotX=0.5, plotY=0.5' centers the plot on the page.
                  plotX default is: .6
                  plotY default is: .3
plotWidth       - in points. Default is 700.
plotHeight      - in points. Default is 350.
plotColor       - background color of the plot. Default is 'white',
borderWidth     - in points. Default is 10.
borderColor     - Default is 'white*.9'.
gridColor       - default is: 'white*.9'.
gridWidth       - this is the width of the grid lines. default is: 1.
gridXres        - this is the resolution of the x- grid measured in 
                  number of the list-items. Default is 10: a x-grid 
                  line at every 10-th item.
gridYres        - this is the number of the y- grid frames. 
                  Default is 4.
numbYround      - rounds the numbers shown on the y-grid axis. 
                  Default is 2 (rounds to 2 decimal points.)
numbXstep       - the occurence of the numbers shown on the x-grid
                  axis. Default is 2, on every second x-grid line 
                  a number is shown.
numbFace        - font for the numbers on the  x- and y- axes. 
                  Default is 'helvetica'.
numbSize        - default is 10.
numbBold        - default is 0.
comment         - is a string with an optional comment text. 
                  Default is the name of the output file.
textFace        - default is 'times'.
textSize        - default is 16.
textColor       - default is 'black'.
textBold        - default is 0.

 
class ScorePlotter
      ScorePlotter 
 
plots csound scorefiles or lists with scoreevents and writes the plots 
to a PDF file. ScorePlotter() requires the python - PIDDLE module.
See: http://piddle.sourceforge.net. Usage:
 
a = ScorePlotter( [ keyword_arguments ] )
 
this creates a ScorePlotter() instance. The arguments are keywords
with defaults and they set instance attributes of the same name:
 
minPitch
sets the bottom range of the plot window in 
octave point decimal values. The default is: 4. 
           
maxPitch
sets the top range of the plot window in 
octave point decimal values. The default is: 14.
 
readBegin
sets the right side of the plot window in seconds.
The default is: 0.
 
readEnd
sets the left side of the plot window in seconds.
If readEnd is not given, the left side of the plot 
window is set to the end of the latest event in the
object cache. The default is: None.
 
The methods:
 
.initInstr( ins, [ keyword_arguments ] )
 
defines an instrument to read. 'ins' is the string 
in the first score pfield. A dot and following numbers 
are ignored: 'i1.01' shall be defined as: 'i1'. If the instrument 
has been already initialized the settings would be overwritten and 
the instrument-cache is cleared.
Following 'keyword_arguments' may be given:
 
pitchPfield     defines the parameterfield which contains pitch.
Default pitchPfield is: 4 (or: p4).
 
pitchFormat     may be some of the strings: 'cps', 'pch', 'oct' or a 
callable object.
In the last case, the callable object is called
during the 'write' procedure at every 'ins' event. 
The object is called with an argument which contain
s the whole scoreevent in a list of strings and
it should return the pitch in octave point decimal
value. Default pitchFormat is: 'oct'.
 
The following 'keyword_arguments' specifies the 
representation of the instrument 'ins' in the plot.
 
color
May be a tuple with 3 values between 0 and 1 
(RGB colors), or one of the predefined PIDDLE 
colors given as a string. 
 
width
default is 1 (point)
 
head
head radius in points. If not set, there is no 
head drawing. Default is 1. 
'head' may be also a callable object. This object
is called with 4 arguments: the first argument
contains the PIDDLE- 'canvas' object and the other
are the plot-coordinates of the event: x1 x2 and y.
 
.readList( event_list )
 
'event_list' is a list of strings with scoreevents. 
 
.readScoFile( fileobj )
 
'fileobj' is an open file object which contains a Csound scorefile
or a list with scoreevents.
 
.readEvent( event )
 
'event' is a string with a single scoreevent.
 
.clear( [ ins ] )
 
'ins' is an instrument (or p1) string. When 'ins' is given, than 
removes all 'ins' events from the object cache and clears all 'ins' 
settings.
When 'ins' is not given than removes all events from the object cache
and clears all 'initInstr' settings.
 
.cache( ins )
 
'ins' is an instrument (or p1) string. Returns the 'ins' 
cache of the instance.
 
.write( [ keyword_arguments ] )
 
writes the plot to a file. The following  
'keyword_arguments' may be given: 
 
name
name of the output file. Default is:'ScorePlotter.pdf',
 
pageWidth
in points. Default is 841.89 (A4-horizontal width)
 
pageHeight
in points. Default is 595.27 ( A4-horizontal height )
 
pageColor
background color of the page. Default is 'white'. The
colors may be given in a tuple with 3 values between 
0 and 1 (RGB colors), or as a string in PIDDLE-color 
manner.
 
plotX           
plotY
 
defines the position of the lower left corner of 
the plot. plotX=0.5 and plotY=0.5 centers the plot.
plotX default is: .6
plotY default is: .4
 
plotWidth
in points. Default is 700.
 
plotHeight
in points. Default is 450.
 
plotColor
background color of the plot. Default is 'white',
 
borderWidth
in points. Default is 10.
 
borderColor
Default is 'white*.9'.
 
gridXcolor
Time grid color. May be also a callable object which
returns the colors. Default is 'white*.9'.
 
gridYcolor
Pitch grid color. May be also a callable object which
returns the colors. Default is 'white*.9'.
 
gridWidth
The width of the time and pitch grid-lines. 
Default is 1.
 
gridXres
Resolution of the time grid given in seconds.
Default is 1.
 
frameYres
Number of the pitch grid frames. Default is 10. This
may be also a list with a 'scale' pattern between 
0 and 1, whereby 0 represents the bottom side of the 
plot window, and 1 represents the top side of the 
plot window.
 
frameYcolor
may be an item or a callable object which returns items.
Default is: 'transparent'.
 
numbXstep
Default is 5. This means: 'write the time at every 5-th 
time-grid-line'.
 
numbXformat
If set, the the time is given in the format:
'min:sec'. Otherwise the time is given in sec.
Default is 0.
 
numbXround
defines the rounding on the time scale in
milliseconds-points. Default is 3.
 
numbY
- may be 0 or a callable object which returns strings.
If numbY = 0, the pitches at the y axis are given
in oct point decimal notation, otherwise the returned
strings are printed. Default is 0.
 
numbYstep
Default is 1. This means: 'write the pitch at every y 
grid-frame.
 
numbYround
defines the rounding of the pitch-numbers on the  
y-axis if they are given in the default oct point 
decimal notation. numbYround default is 3.
 
numbFace        - some of the predefined PIDDLE fonts, 
default is 'helvetica'.
 
umbSize
default is 10
 
numbBold
default is 0
 
marker
marker are vertical lines. They may be given as a list
with a 'scale' pattern between 0 an 1, whereby 0 
represents the right side of the plot window 
and 1 represents the left side of the plot window.
Default marker is: None.
 
markerColor
May be a callable object which returns the colors.
Default is: 'white*.7'.
 
markerWidth
Default is 1.
 
markerText
A callable object which returns strings. These strings
are printed above the markers and in the appropriate
'markerColor'. Default is: None.
 
comment
is a string with an optional comment text. 
Default is 'name'.
 
textColor
default is: 'black'
 
textSize
default is: 14
 
drawOrder
A list with 'ins' strings which define the drawing
order from back to front. If not given, the instruments
are drawing in the same order as they are read.
 
  
__init__(self, minPitch=4, maxPitch=14, readBegin=0, readEnd=None)
cache(self, a)
clear(self, a=None)
initInstr(self, p1, **d)
readEvent(self, a)
# readEvent
# the cache format is:   self._ins[p1]['cache'][0][1][2][trunc]
# example:               {'i1':{cache:[0,1,440,0]}}
readList(self, a)
readScoFile(self, a)
write(self, name='scorePlotter.pdf', pageWidth=841.88976377952747, pageHeight=595.27559055118104, pageColor='white', plotX=0.59999999999999998, plotY=0.40000000000000002, plotWidth=700, plotHeight=450, plotColor='white', borderWidth=10, borderColor='white*.9', gridXcolor='white*.9', gridYcolor='white*.9', gridWidth=1, gridXres=1, frameYres=10, frameYcolor='transparent', numbXstep=5, numbXround=3, numbXformat=0, numbY=0, numbYstep=1, numbYround=3, numbFace='helvetica', numbSize=10, numbBold=0, comment=1, marker=None, markerColor='white*.7', markerWidth=1, markerText=None, drawOrder=None, textColor='black', textSize=14)

 
Functions
            
_col(arg)
_t_(arg)

 
Data
             __file__ = '/usr/local/lib/python2.1/site-packages/omde/plot.pyc'
__name__ = 'omde.plot'