Initialize, Construct a VCS Canvas Object

Construct the VCS Canas object. There can only be at most 8 VCS Canvases open at any given time.

Example of Use:

import vcs,cdms2

file=cdms2.open('filename.nc')
slab=file.getslab('variable')
a=vcs.init()
# This examples constructs 4 VCS Canvas a.plot(slab)
# Plot slab using default settings
b=vcs.init()
# Construct VCS object
template=b.gettemplate('AMIP')
# Get 'example' template object
b.plot(slab,template)
# Plot slab using template 'AMIP'
c=vcs.init()
# Construct new VCS object
isofill=c.getisofill('quick')
# Get 'quick' isofill graphics method
c.plot(slab,template,isofill)
# Plot slab using template and isofill objects
d=vcs.init()
# Construct new VCS object
isoline=c.getisoline('quick')

# Get 'quick' isoline graphics method
c.plot(isoline,slab,template)
# Plot slab using isoline and template objects

On-Line HELP!!!

Gives insight to other VCS functions by providing a description and at least one example.

Example of Use:

import vcs

vcs.help()
vcs.help('init')
vcs.help('plot')

Print out the object's doc string

Print out information on VCS objects. See example on its use.

Example of Use:

import vcs
a=vcs.init()
ln=a.getline('red')
# Get a VCS line object
a.objecthelp(ln)
# This will print out information on how to use ln

Update the VCS Canvas.

Updating of the graphical displays on the VCS Canvas can be deferred until a later time. This is helpful when generating templates or displaying numerous plots. If a series of commands are given to VCS and the Canvas Mode is set to manual (i.e., 0), then no updating of the VCS Canvas occurs until the 'update' function is executed.

Note, by default the VCS Canvas Mode is set to 'Automatic', which means VCS will update the VCS Canvas as necessary without prompting from the user.

• mode

  Options:

  • 1 = automatic
  • 0 = manual

Example of Use:

import vcs
...
a=vcs.init()
a.mode=0
# Set updating to manual mode
a.plot(array,'default','boxfill','quick')
box=x.getboxfill('quick')
box.color_1=100
box.xticlabels('lon30','lon30')
box.xticlabels('','')
box.datawc(1e20,1e20,1e20,1e20)
box.datawc(-45.0, 45.0, -90.0, 90.0)
...
a.update()
# Update the changes manually

If a series of commands are given to VCS and the Canvas Mode is set to manual, then use this function to update the VCS Canvas manually.

Example of Use:

import vcs
...
a=vcs.init()
a.mode=0
# Go to manual mode a.plot(s,'default','boxfill','quick')
box=x.getboxfill('quick')
box.color_1=100
box.xticlabels('lon30','lon30')
box.xticlabels('','')
box.datawc(1e20,1e20,1e20,1e20)
box.datawc(-45.0, 45.0, -90.0, 90.0)
a.update()
# Update the changes manually

Open VCS Canvas object. This routine really just manages the VCS canvas. It will popup the VCS Canvas for viewing. It can be used to display the VCS Canvas.

Example of Use:

import vcs
a=vcs.init()
a.open()

Close the VCS Canvas. It will remove the VCS Canvas object from the screen, but not deallocate it.

Example of Use:

import vcs
a=vcs.init()
a.plot(array,'default','isofill','quick')
a.close()

Change the VCS Canvas orientation to Portrait.

Example of Use:

a=vcs.init()
a.plot(array)
a.portrait()
# Change the VCS Canvas orientation and set object flag to portrait

Change the VCS Canvas orientation to Landscape.

Example of Use:

a=vcs.init()
a.plot(array)
a.landscape()
# Change the VCS Canvas orientation and set object flag to landscape

Change the VCS Canvas orientation to either 'portrait' or 'landscape'.

The orientation of the VCS Canvas and of cgm and raster images is controlled by the PAGE command. Only portrait (y > x) or landscape (x > y) orientations are permitted.

Example of Use:

a=vcs.init()
a.plot(array)
a.page()
# Change the VCS Canvas orientation and set object flag to portrait

The geometry command is used to set the size and position of the VCS canvas.

• width
• height
• x position
• y position

Example of Use:

a=vcs.init()
a.plot(array,'default','isofill','quick')
a.geometry(450, 337,100, 100)

Send plots to the printer

This function creates a temporary cgm file and then sends it to the specified printer. Once the printer received the information, then the temporary cgm file is deleted. The temporary cgm file is created in the user's PCMDI_GRAPHICS directory.

The PRINTER command is used to send the VCS Canvas plot(s) directly to the printer.

Note: VCS graphical displays can be printed only if the user customizes a HARD_COPY file (included with the VCS software) for the home system. The path to the HARD_COPY file must be

/$HOME/PCMDI_GRAPHICS/HARD_COPY

where /$HOME denotes the user's home directory.

More information on the HARD_COPY file

• printer's name

• [orientation]

  Options:

  • l = landscape
  • p = portrait

Example of Use:

import vcs
a=vcs.init()
a.plot(array)
a.printer('printer_name')
# Send plot(s) to postscript printer
a.printer('printer_name','p')
# Send plot(s) to the printer in portrait mode

Save plot(s) as gif image

In some cases, the user may want to save the plot out as a gif image. This routine allows the user to save the VCS canvas output as a gif file.

This file can be converted to other gif formats with the aid of xv and other such imaging tools found freely on the web.

If no path/file name is given and no previously created gif file has been

designated, then file

/$HOME/PCMDI_GRAPHICS/default.gif

will be used for storing gif images. However, if a previously created gif file is designated, that file will be used for gif output.

By default, the page orientation is in Landscape mode (l). To translate the page orientation to portrait mode (p), enter 'p' as the second parameter.

The GIF command is used to create or append to a gif file. There are two modes for saving a gif file: 'Append' mode (a) appends gif output to an existing gif file(i.e., making it an animated gif); 'Replace' (r) mode overwrites an existing gif file with new gif output.

• Filename to save

• [merge]

  Options:

  • a = append (or merge) image to an existing file
  • r = replace file with new image
• [orientation (l|p)]
  • l = landscape
  • p = portrait
• [geometry (widthxheight)]

Example of Use:

import vcs
a=vcs.init()
a.plot(array)
a.gif(filename='example.gif', merge='a', orientation='l', geometry='800x600')
# overwrite existing gif file (default is merge='r')
a.gif('example')
# overwrite existing gif file
a.gif('example',merge='r')
# merge gif image into existing gif file
a.gif('example',merge='a')
# merge gif image into existing gif file with landscape orientation
a.gif('example',orientation='l')
# merge gif image into existing gif file with portrait orientation
a.gif('example',orientation='p')
# merge gif image into existing gif file and set the gif geometry
a.gif('example',geometry='600x500')

Save plot(s) to a postscript file

Postscript output is another form of vector graphics. It is larger than its CGM output counter part, because it is stored out in ASCII format.

There are two modes for saving a postscript file: 'Append' (a) mode appends postscript output to an existing postscript file; and 'Replace' (r) mode overwrites an existing postscript file with new postscript output. The default mode is to overwrite an existing postscript file (i.e. mode (r)).

• filename

• [mode]

  Options:

  • a = append (or merge) image to an existing file
  • r = replace file with new image
• [width of image]
• [height of image]

• [units of width/height]

  Options:

  • 'in' or 'inches' — default
  • 'cm'
  • 'mm'
  • 'dot' or 'dots'
• [left_margin]
• [right_margin]
• [top_margin]
• [bottom_margin]

Example of Use:

import vcs
a=vcs.init()
a.plot(array)
# Overwrite a postscript file
a.postscript('example')
# Append postscript to an existing file
a.postscript('example', 'a')
# Overwrite an existing file
a.postscript('example', 'r')
# Append postscript to an existing file
a.postscript('example', mode='a')
# US Legal (default)
a.postscript('example', width=11.5, height= 8.5)
# A4
a.postscript('example', width=21, height=29.7, units='cm')
# US Legal output and control of margins (for printer friendly output), default units 'inches'
a.postscript('example', right_margin=.2,left_margin=.2,top_margin=.2,bottom_margin=.2)

To save a graphics plot in VCS the user can call CGM along with the name of the output. This routine will save the displayed image on the VCS canvas as a binary vector graphics that can be imported into MSWord or Framemaker. CGM files are in ISO standards output format.

The CGM command is used to create or append to a cgm file.

• cgm file name

Example of Use:

a=vcs.init()
a.plot(array,'default','isofill','quick')
# Note, if you don't specify the extension '.cgm' at the end of file name, then the extension '.cgm' will be put on for you.
a.cgm(o)
a.cgm('example')
# by default a cgm file will be appended it an existing file
a.cgm('example','a')
# 'a' will instruct cgm to append to an existing file
a.cgm('example','r')
# 'r' will instruct cgm to over write an existing file

In some cases, the user may want to save the plot out as an raster image. This routine allows the user to save the VCS canvas output as a SUN raster file.

This file can be converted to other raster formats with the aid of xv and other such imaging tools found freely on the web.

If no path/file name is given and no previously created raster file has been designated, then file

/$HOME/PCMDI_GRAPHICS/default.ras

will be used for storing raster images. However, if a previously created raster file is designated, that file will be used for raster output.

• raster file name

• [mode]

  • 'a'=will append raster image to an existing raster file

  • 'r'=will replace a raster file with a new raster file

Example of Use:

import vcs
a=vcs.init()
a.plot(array)
# Note, if you don't specify the extension '.ras' at the end of file name, then the extension '.ras' will be put on for you.
a.raster('example','a')
# append raster image to existing file
a.raster('example','r')
# over write existing raster file

This function allows the user to convert a postscript file to a gif file.

• postscript file name

• ['l'=landscape 'p'=portrait]

Example of Use:

import vcs
a=vcs.init()
a.plot(array)
a.pstogif('filename.ps') # convert to landscape gif file
a.pstogif('filename.ps','l') # convert to landscape gif file
a.pstogif('filename.ps','p') # convert to portrait gif file

Plot an array(s) of data given a template and graphics method. The VCS template is used to define where the data and variable attributes will be displayed on the VCS Canvas. The VCS graphics method is used to define how the array(s) will be shown on the VCS Canvas.

The form of the call is:

plot(array1=None, array2=None, template_name=None, graphics_method=None,graphics_name=None, [key=value [, key=value [, ...]]])

• [array1] - NumPy Array, 2 ≤ rank(array) ≤ 5
• [array2] - NumPy Array, 2 ≤ rank(array) ≤ 5
• [template_name]
• [graphics_method]
• [graphics_name]
• [keyword arguments]

See section 4.5 for a detailed listing of possible plot options.

Example of Use:

import vcs
x=vcs.init()
# x is an instance of the VCS class object (constructor)
x.plot(array)
# this call will use default settings for template and boxfill
x.plot(array, 'AMIP', 'isofill','AMIP_psl')
# this is specifying the template and graphics method
t=x.gettemplate('AMIP')
# get a predefined the template 'AMIP'
vec=x.getvector('quick')
# get a predefined the vector graphics method 'quick'
x.plot(array1, array2, t, vec)
# plot the data as a vector using the 'AMIP' template
x.clear()
# clear the VCS Canvas of all plots
box=x.createboxfill('new')
# create boxfill graphics method 'new'
x.plot(box,t,array)
# plot array data using box 'new' and template 't'

Generate a boxfill plot

Generate a boxfill plot given the data, boxfill graphics method, and template. If no boxfill class object is given, then the 'default' boxfill graphics method is used. Similarly, if no template class object is given, then the 'default' template is used.

See plot command for options.

Example of Use:

import vcs
a=vcs.init()
a.show('boxfill')
# Show all the existing boxfill graphics methods
box=a.getboxfill('quick')
# Create instance of 'quick'
a.boxfill(array,box)
# Plot array using specified box and default template
templt=a.gettemplate('AMIP')
# Create an instance of template 'AMIP'
a.clear()
# Clear VCS canvas
a.boxfill(array,box,template)
# Plot array using specified box and template
a.boxfill(box,array,template)
# Plot array using specified box and template
a.boxfill(template,array,box)
# Plot array using specified box and template
a.boxfill(template,array,box)
# Plot array using specified box and template
a.boxfill(array,'AMIP','quick')
# Use 'AMIP' template and 'quick' boxfill
a.boxfill('AMIP',array,'quick')
# Use 'AMIP' template and 'quick' boxfill
a.boxfill('AMIP','quick',array)
# Use 'AMIP' template and 'quick' boxfill

Generate a continents plot

Generate a continents plot given the continents graphics method, and template. If no continents class object is given, then the 'default' continents graphics method is used. Similarly, if no template class object is given, then the 'default' template is used.

See plot command for options.

Example of Use:

import vcs
a=vcs.init()
a.show('continents')
# Show all the existing continents graphics methods
con=a.getcontinents('quick')
# Create instance of 'quick'
a.continents(array,con)
# Plot array using specified con and default template
a.clear()
# Clear VCS canvas
a.continents(array,con,template)
# Plot array using specified con and template

Generate an isofill plot

Generate a isofill plot given the data, isofill graphics method, and template. If no isofill class object is given, then the 'default' isofill graphics method is used. Similarly, if no template class object is given, then the 'default' template is used.

See plot command for options.

Example of Use:

import vcs
a=vcs.init()
a.show('isofill')
# Show all the existing isofill graphics methods
iso=a.getisofill('quick')
# Create instance of 'quick'
a.isofill(array,iso)
# Plot array using specified iso and defaul template
a.clear()
# Clear VCS canvas
a.isofill(array,iso,template)
# Plot array using specified iso and template

Generate an isoline plot

Generate a isoline plot given the data, isoline graphics method, and template. If no isoline class object is given, then the 'default' isoline graphics method is used. Similarly, if no template class object is given, then the 'default' template is used.

See plot command for options.

Example of Use:

a=vcs.init()
a.show('isoline')
# Show all the existing isoline graphics methods
iso=a.getisoline('quick')
# Create instance of 'quick'
a.isoline(array,iso)
# Plot array using specified iso and default template
a.clear()
# Clear VCS canvas a.isoline(array,iso,template)
# Plot array using specified iso and template

Generate an outfill plot

Generate a outfill plot given the data, outfill graphics method, and template. If no outfill class object is given, then the 'default' outfill graphics method is used. Similarly, if no template class object is given, then the 'default' template is used.

See plot command for options.

Example of Use:

a=vcs.init()
a.show('outfill')
# Show all the existing outfill graphics methods
out=a.getoutfill('quick')
# Create instance of 'quick'
a.outfill(array,out)
# Plot array using specified out and default template
a.clear()
# Clear VCS canvas
a.outfill(array,out,template)
# Plot array using specified out and template

Generate an outline plot

Generate a outline plot given the data, outline graphics method, and template. If no outline class object is given, then the 'default' outline graphics method is used. Similarly, if no template class object is given, then the 'default' template is used.

See plot command for options.

Example of Use:

import vcs
a=vcs.init()
a.show('outline')
# Show all the existing outline graphics methods
out=a.getoutline('quick')
# Create instance of 'quick'
a.outline(array,out)
# Plot array using specified out and default template
a.clear()
# Clear VCS canvas a.outline(array,out,template)
# Plot array using specified out and template

Generate a scatter plot

Generate a scatter plot given the data, scatter graphics method, and template. If no scatter class object is given, then the 'default' scatter graphics method is used. Similarly, if no template class object is given, then the 'default' template is used.

See plot command for options.

Example of Use:

a=vcs.init()
a.show('scatter')
# Show all the existing scatter graphics methods
sct=a.getscatter('quick')
# Create instance of 'quick'
a.scatter(array1,array2,sct)
# Plot array using specified sct and default template
a.clear()
# Clear VCS canvas
a.scatter(array1,array2,sct,template)
# Plot array using specified sct and template

Generate a vector plot

Generate a vector plot given the data, vector graphics method, andtemplate. If no vector class object is given, then the 'default' vectorgraphics method is used. Similarly, if no template class object is given,then the 'default' template is used.

See plot command for options.

Example of Use:

import vcs
a=vcs.init()
a.show('vector')
# Show all the existing vector graphics methods
vec=a.getvector('quick')
# Create instance of 'quick'
a.vector(array1,array2,vec)
# Plot array using specified vec and default template
a.clear()
# Clear VCS canvas
a.vector(array1,array2,vec,template)
# Plot array using specified vec and template

Generate a Xvsy plot

Generate a XvsY plot given the data, XvsY graphics method, and template. If no XvsY class object is given, then the 'default' XvsY graphics method is used. Similarly, if no template class object is given, then the 'default' template is used.

See plot command for options.

Example of Use:

import vcs
a=vcs.init()
a.show('xvsy')
# Show all the existing XvsY graphics methods
xy=a.getxvsy('quick')
# Create instance of 'quick'
a.xvsy(array1,array2,xy)
# Plot array using specified xy and default template
a.clear()
# Clear VCS canvas
a.xvsy(array1,array2,xy,template)
# Plot array using specified xy and template

Generate a Xyvsy plot

Generate a Xyvsy plot given the data, Xyvsy graphics method, and template. If no Xyvsy class object is given, then the 'default' Xyvsy graphics method is used. Simerly, if no template class object is given, then the 'default' template is used.

See plot command for options.

Example of Use:

import vcs
a=vcs.init()
a.show('xyvsy')
# Show all the existing Xyvsy graphics methods
xyy=a.getxyvsy('quick')
# Create instance of 'quick'
a.xyvsy(array,xyy)
# Plot array using specified xyy and default template
a.clear()
# Clear VCS canvas
a.xyvsy(array,xyy,template)
# Plot array using specified xyy and template

Generate a Yxvsx plot

Generate a Yxvsx plot given the data, Yxvsx graphics method, and template. If no Yxvsx class object is given, then the 'default' Yxvsx graphics method is used. Simerly, if no template class object is given, then the 'default' template is used.

See plot command for options.

Example of Use:

import vcs
a=vcs.init()
a.show('yxvsx')
# Show all the existing Yxvsx graphics methods
yxx=a.getyxvsx('quick')
# Create instance of 'quick'
a.yxvsx(array,yxx)
# Plot array using specified yxx and default template
a.clear()
# Clear VCS canvas
a.yxvsx(array,yxx,template)
# Plot array using specified yxx and template

At some point it will become necessary to clear all the plots from the VCS Canvas. This routine will remove all plots on the VCS Canvas.

Example of Use:

import vcs
a=vcs.init()
a.plot(array,'default','isofill','quick')
a.clear()

Returns the grapics method's type string: boxfill, isofill, isoline, outfill, outline, continents, scatter, vector, xvsy, xyvsy, yxvsx, 3d_scalar, or 3d_vector.

• Object to Query

Example of Use:

import vcs
a=vcs.init()
box=a.getboxfill() # Get an default boxfill
iso=a.getisofill() # Get default isofill
ln=a.getline() # Get default line
print a.graphicsmethodname(box) # Will
# print 'boxfill'
print a.graphicsmethodname(iso) # Will
# print 'isofill'
print a.graphicsmethodname(ln) # Will return
# None, because ln is not a
# graphics method

Return continents type from VCS. Remember the value can only be between 0 and 11.

Example of Use:

import vcs
a=vcs.init()
cont_type = a.getcontinentstype() # Get the
# continents type

Indicates if the entered argument is one of the following graphics methods: boxfill, isofill, isoline, outfill, outline, continents, scatter, vector, xvsy, xyvsy, yxvsx.

Returns a 1, which indicates true, if the argment is one of the above.

Otherwise, it will return a 0, indicating false.

• Object to Query

Example of Use:

import vcs
a=vcs.init()
box=a.getboxfill('quick')
# To Modify an existing boxfill use:
    ...
if a.isgraphicsmethod(box):
    box.list()

Check to see if an object is a VCS primary boxfill graphics method object.

Returns a 1 if the argment true.

Otherwise, it will return a 0, indicating false.

• Object to Query

Example of Use:

import vcs
a=vcs.init()
box=a.getboxfill("quick")
# To Modify an existing boxfill object
...
if a.isboxfill(box):
    box.list()

Check to see if an object is a VCS primary continents graphics method.

Returns a 1 if the argment true.

Otherwise, it will return a 0, indicating false.

• Object to Query

Example of Use:

import vcs
a=vcs.init()
con=a.getcontinents("quick")
# To Modify an existing continents object
...
if a.iscontinents(con):
    con.list()

Check to see if an object is a VCS primary isofill graphics method.

Returns a 1 if the argment true.

Otherwise, it will return a 0, indicating false.

• Object to Query

Example of Use:

import vcs
a=vcs.init()
iso=a.getisofill("quick")
# To Modify an existing isofill object
...
if a.isisofill(iso):
    iso.list()

Check to see if an object is a VCS primary isoline graphics method.

Returns a 1 if the argment true.

Otherwise, it will return a 0, indicating false.

• Object to Query

Example of Use:

import vcs
a=vcs.init()
iso=a.getisoline("quick")
# To Modify an existing isoline object
...
if a.isisoline(iso):
    iso.list()

Check to see if this object is a VCS primary outfill graphics method.

Returns a 1 if the argment true.

Otherwise, it will return a 0, indicating false.

• Object to Query

Example of Use:

import vcs
a=vcs.init()
out=a.getoutfill("quick")
# To Modify an existing outfill object
...

if a.isoutfill(out):
    out.list()

Check to see if an object is a VCS primary outline graphics method.

Returns a 1 if the argment true.

Otherwise, it will return a 0, indicating false.

• Object to Query

Example of Use:

import vcs
a=vcs.init()
out=a.getoutline("quick")
# To Modify an existing outline object
...
if a.isoutline(out):
    out.list()

Check to see if an object is a VCS primary vector graphics method.

Returns a 1 if the argment true.

Otherwise, it will return a 0, indicating false.

• Object to Query

Example of Use:

import vcs
a=vcs.init()
vec=a.getvector("quick")
# To Modify an existing vector object
...
if a.isvector(vec):
    vec.list()

Check to see if an object is a VCS primary xvsy graphics method.

Returns a 1 if the argment true.

Otherwise, it will return a 0, indicating false.

• Object to Query

Example of Use:

import vcs
a=vcs.init()
xy=a.getxvsy("quick")
# To Modify an existing xvsy object
...
if a.isxvsy(xy):
    xy.list()

Check to see if an object is a VCS primary Xyvsy graphics method.

Returns a 1 if the argment true.

Otherwise, it will return a 0, indicating false.

• Object to Query

Example of Use:

import vcs
a=vcs.init()
xyy=a.getxyvsy("quick")
# To Modify an existing Xyvsy object
...
if a.isxyvsy(xyy):
    xyy.list()

Check to see if an object is a VCS primary yxvsx graphics method.

Returns a 1 if the argment true.

Otherwise, it will return a 0, indicating false.

• Object to Query

Example of Use:

a=vcs.init()
yxx=a.getyxvsx("quick")
# To Modify an existing yxvsx object
...
if a.isyxvsx(yxx):
    yxx.list()

Check to see if an object is a VCS primary 3d_scalar graphics method.

Returns a 1 if the argment true.

Otherwise, it will return a 0, indicating false.

• Object to Check

Example of Use:

import vcs
a = vcs.init()
scalar = a.getxyvsy("quick")
# To Modify an existing 3d_scalar object
...
if vcs.is3d_scalar(scalar):
    scalar.list()

Check to see if an object is a VCS primary 3d_vector graphics method.

Returns a 1 if the argment true.

Otherwise, it will return a 0, indicating false.

• Object to Check

Example of Use:

import vcs
a = vcs.init()
vector = a.getxyvsy("quick")
# To Modify an existing 3d_vector object
...
if vcs.is3d_vector(vector):
    vector.list()

Indicates if the entered argument a template.

Returns a 1 if the argment true.

Otherwise, it will return a 0, indicating false.

• Object to Query

Example of Use:

a=vcs.init()
templt=a.gettemplate('quick')
# Modify an existing template named 'quick'
...
if a.istemplate(templt):
    templt.list()
# If it is a template then list its members

In addition, detailed specification of the primary elements' (or primary class elements'), attributes is provided by eight secondary elements or (secondary class elements):

1.) colormap: specification of combinations of 256 available colors

2.) fill area: style, style index, and color index

3.) format: specifications for converting numbers to display strings

4.) line: line type, width, and color index

5.) list: a sequence of pairs of numerical and character values

6.) marker: marker type, size, and color index

7.) text table: text font type, character spacing, expansion, and color index

8.) text orientation: character height, angle, path, and horizontal/vertical alignment

• Object to Query

Example of Use:

a=vcs.init()
line=a.getline('red')
# To Modify an existing line object
...
if a.issecondaryobject(line):
    box.list()

Check to see if an object is a VCS secondary fillarea.

Example of Use:

a=vcs.init()
fa=a.getfillarea("def37")
# To Modify an existing fillarea object
...
if a.isfillarea(fa):
    fa.list()

Check to see if this object is a VCS secondary line.

• Object to Query

Example of Use:

a=vcs.init()
ln=a.getline("red")
# To Modify an existing line object
...
if a.isline(ln):
    ln.list()

Check to see if an object is a VCS secondary marker.

• Object to Query

Example of Use:

a=vcs.init()
mk=a.getmarker("red")
# To Modify an existing marker object
...
if a.ismarker(mk):
    mk.list()

Check to see if an object is a VCS secondary text combined.

• Object to Query

Example of Use:

a=vcs.init()
tc=a.gettextcombined("std", "7left")
# To Modify existing text table and orientation objects
...
if a.istextcombined(tc):
    tc.list()
if a.istexttable(tc):
    tc.list()
if a.istextorientation(tc):
    tc.list()

Check to see if an object is a VCS secondary text orientation.

• Object to Query

Example of Use:

a=vcs.init()
to=a.gettextorientation("7left")
# To Modify an existing text orientation object
...
if a.istextorientation(to):
    to.list()

Check to see if an object is a VCS secondary text table.

• Object to Query

Example of Use:

a=vcs.init()
tt=a.gettexttable("std")
# To Modify an existing text table object
...
if a.istexttable(tt):
    tt.list()

Returns a Python list of all the VCS class objects.

Example of Use:

import vcs
a=vcs.init()
a.listelements()

Show the list of VCS primary and secondary class objects.

• Type of objects to list

Example of Use:

import vcs
a=vcs.init()
a.show('boxfill')
a.show('isofill')
a.show('template')
a.show('line')
a.show('marker')

Create a new boxfill graphics method given the name and the existingboxfill graphics method to copy the attributes from. If no existing boxfill graphics method name is given, then the default boxfill graphics method will be used as the graphics method to which the attributes will be copied from.

If the name provided already exists, then a error will be returned. Graphics method names must be unique.

• new boxfill name

• [name of boxfill to copy attributes from]

</td>

Example of Use:

import vcs
a=vcs.init()
a.show('boxfill')
box=a.createboxfill('example1')
a.show('boxfill')
box=a.createboxfill('example2','quick')
a.show('boxfill')

VCS contains a list of graphics methods. This function will create a boxfill class object from an existing VCS boxfill graphics method. If no boxfill name is given, then boxfill 'default' will be used.

Note, VCS does not allow the modification of 'default' attribute sets. However, a 'default' attribute set that has been copied under a different name can be modified. (See the createboxfill function.)

• [boxfill name]

Example of Use:

import vcs
a=vcs.init()
a.show('boxfill')
# Show all the existing boxfill graphics methods
box=a.getboxfill()
# box instance of 'default' boxfill graphics method
box2=a.getboxfill('quick')
# box2 instance of existing 'quick' boxfill graphics method

Object: boxfillobject

The boxfill graphics method (Gfb) displays a two-dimensional data array by surrounding each data value by a colored grid box.

This class is used to define a boxfill table entry used in VCS, or it can be used to change some or all of the attributes in an existing boxfill table entry. Other Useful Functions:

a=vcs.init() # Constructor

# Show predefined boxfill graphics methods
a.show('boxfill') 

# Change the VCS color map
a.setcolormap("AMIP") 

# Plot data 's' with boxfill 'b' and 'default' template
a.boxfill(s, b, 'default') 
# Updates the VCS Canvas at user's request
a.update() 
# If 1, then automatic update, else if 0, then use the update function to update the VCS Canvas.
a.mode=1, or 0

See Chapter 6 for additional information.

Attributes:

• name
• projection
• xticlabels1
• xticlabels2
• xmtics1
• xmtics2
• yticlabels1
• yticlabels2
• ymtics1
• ymtics2
• datawc_x1
• datawc_y1
• datawc_x2
• datawc_y2
• xaxisconvert
• yaxisconvert
• level_1
• level_2
• color_1
• color_2
• legend_type
• legend
• ext_1
• ext_2
• missing

Example of Use:

import vcs
a=vcs.init()

# To Create a new instance of boxfill use:
    box=a.createboxfill('new','quick')
# Copies content of 'quick' to 'new'
box=a.createboxfill('new')
# Copies content of 'default' to 'new'

# To Modify an existing boxfill use: box=a.getboxfill('AMIP_psl') box.list()
# Will list all the boxfill attribute values
box.projection='linear'
lon30={-180:'180W',-150:'150W',0:'Eq'} box.xticlabels1=lon30 box.xticlabels2=lon30 box.xticlabels(lon30, lon30)
# Will set them both
box.xmtics1=''
box.xmtics2=''
box.xmtics(lon30, lon30)
# Will set them both
box.yticlabels1=lat10 box.yticlabels2=lat10
box.yticlabels(lat10, lat10)
# Will set them both
box.ymtics1='' box.ymtics2='' box.ymtics(lat10, lat10)
# Will set them both
box.datawc_y1=-90.0 box.datawc_y2=90.0 box.datawc_x1=-180.0 box.datawc_x2=180.0 box.datawc(-90,90,-180,180)
box.exts('n', 'y' )
# Will set them both
# Will set them all
xaxisconvert='linear'
yaxisconvert='linear'
box.xyscale('linear', 'area_wt')
# Will set them both
level_1=1e20
level_2=1e20
box.levels(10, 90)
# Will set them both
color_1=16
color_2=239
box.colors(16, 239 )
# Will set them both
legend_type='VCS'
legend=''
ext_1='n'
ext_2='y'
missing=241
# Color index value range 0 to 255

Create a new continents graphics method given the name and the existing continents graphics method to copy the attributes from. If no existing continents graphics method name is given, then the default continents graphics method will be used as the graphics method to which the attributes will be copied from.

If the name provided already exists, then a error will be returned. Graphics method names must be unique.

• new continents name

• [name of continents to copy from]

Example of Use:

import vcs
a=vcs.init()
a.show('continents')
con=a.createcontinents('example1',)
a.show('continents')
con=a.createcontinents('example2','quick')
a.show('continents')

VCS contains a list of graphics methods. This function will create a continents class object from an existing VCS continents graphics method. If no continents name is given, then continents 'default' will be used.

Note, VCS does not allow the modification of 'default' attribute sets. However, a 'default' attribute set that has been copied under a different name can be modified. (See the createcontinents function.)

• [continents name]

</td>

Example of Use:

import vcs
a=vcs.init()
a.show('continents')
# Show all the existing continents graphics methods
con=a.getcontinents()
# con instance of 'default' continents graphics method
con2=a.getcontinents('quick')
# con2 instance of existing 'quick' continents graphics method

Object: continentsobject

The Continents graphics method draws a predefined, generic set of continental outlines in a longitude by latitude space. (To draw continental outlines, no external data set is required.)

This class is used to define an continents table entry used in VCS, or it can be used to change some or all of the continents attributes in an existing continents table entry.

Other Useful Functions:

a=vcs.init() Constructor

a.show('continents') Show predefined boxfill graphics methods

a.show('line') Show predefined line class objects

a.setcolormap("AMIP") Change the VCS color map

a.continents(c,'default') Plot continents, where 'c' is the defined continents object

a.update() Updates the VCS Canvas at user's request a.mode=1, or 0. If 1, then automatic update, else if 0, then use update function to update the VCS Canvas.

See Chapter 6 for additional information.

Attributes:

• name

• projection

• xticlabels1

• xticlabels2

• xmtics1

• xmtics2

• yticlabels1

• yticlabels2

• ymtics1

• ymtics2

• datawc_x1

• datawc_y1

• datawc_x2

• datawc_y2

• line

• linecolor

• type

Example of Use:

import vcs
a=vcs.init()

# To Create a new instance of continents use:
    con=a.createcontinents('new','quick')
#copies content of 'quick' to 'new'
con=a.createcontinents('new')
# copies content of 'default' to 'new'

# To Modify an existing continents use:
    con=a.getcontinents('AMIP_psl')
con.list()
# Will list all the continents attribute values
con.projection='linear'
lon30={-180:'180W',-150:'150W',0:'Eq'}
con.xticlabels1=lon30
con.xticlabels2=lon30
con.xticlabels(lon30, lon30)
# Will set them both
con.xmtics1=''
con.xmtics2=''
con.xmtics(lon30, lon30)
# Will set them both
con.yticlabels1=lat10
con.yticlabels2=lat10
con.yticlabels(lat10, lat10)
# Will set them both
con.ymtics1=''
con.ymtics2=''
con.ymtics(lat10, lat10)
# Will set them both
con.datawc_y1=-90.0
con.datawc_y2=90.0
con.datawc_x1=-180.0
con.datawc_x2=180.0
con.datawc(-90, 90, -180, 180) # Will set them all
# Specify the continents line style (or type):
    con.line=0 # Same as con.line='solid'
con.line=1 # Same as con.line='dash'
con.line=2 # Same as con.line='dot'
con.line=3 # Same as con.line='dash-dot'
con.line=4 # Same as con.line='long-dash'
# There are three possibilities for setting the line #color indices (Ex):
    con.linecolor=22 # Same as con.line-color=(22)
con.linecolor=([22])
# Will set the continents to a specific color index
con.linecolor=None # Turns off the line color index, defaults to Black

Create a new isofill graphics method given the name and the existing isofill graphics method to copy the attributes from. If no existing isofill graphics method name is given, then the default isofill graphics method will be used as the graphics method to which the attributes will be copied from.

If the name provided already exists, then a error will be returned. Graphics method names must be unique.

• new isofill name

• [name of isofill to copy attributes from]

Example of Use:

import vcs
a=vcs.init()
a.show('isofill')
iso=a.createisofill('example1',)
a.show('isofill')
iso=a.createisofill('example2','quick')
a.show('isofill')

VCS contains a list of graphics methods. This function will create a isofill class object from an existing VCS isofill graphics method. If no isofill name is given, then isofill 'default' will be used.

Note, VCS does not allow the modification of 'default' attribute sets. However, a 'default' attribute set that has been copied under a different name can be modified. (See the createisofill function.)

• [isofill name]

Example of Use:

import vcs
a=vcs.init()
a.show('isofill')
# Show all the existing isofill graphics methods
iso=a.getisofill()
# iso instance of 'default' isofill graphics method
iso2=a.getisofill('quick')
# iso2 instance of existing 'quick' isofill graphics method

Object: isofillobject

The Isofill graphics method fills the area between selected isolevels (levels of constant value) of a two-dimensional array with a user-specified color. The example below shows how to display an isofill plot on the VCS Canvas and how to create and remove isofill isolevels.

This class is used to define an isofill table entry used in VCS, or it can be used to change some or all of the isofill attributes in anexisting isofill table entry.

Other Useful Functions:

a=vcs.init() Constructor

a.show('isofill') Show predefined isofill graphics methods

a.show('fillarea') Show predefined fillarea objects

a.show('template') Show predefined fillarea objects

a.setcolormap("AMIP") Change the VCS color map

a.createtemplate('test') Create a template

a.createfillarea('fill') Create a fillarea

a.gettemplate('AMIP') Get an existing template

a.getfillarea('def37') Get an existing fillarea

a.isofill(s,i,t) Plot array 's' with isofill 'i' and template 't'

a.update() Updates the VCS Canvas at user's request a.mode=1, or 0. If 1, then automatic update, else if 0, then use update function to update the VCS Canvas.

See Chapter 6 for additional information.

Attributes:

• name

• projection

• xticlabels1

• xticlabels2

• xmtics1

• xmtics2

• yticlabels1

• yticlabels2

• ymtics1

• ymtics2

• datawc_x1

• datawc_y1

• datawc_x2

• datawc_y2

• xaxisconvert

• yaxisconvert

• missing

• ext_1

• ext_2

• fillareaindices

• fillareastyle

• fillareacolors

• levels

Example of Use:

import vcs
a=vcs.init()

# To Create a new instance of isofill use:
    iso=a.createisofill('new','quick')
# Copies content of 'quick' to 'new'
iso=a.createisofill('new')
# Copies content of 'default' to 'new'

# To Modify an existing isofill use:
    iso=a.getisofill('AMIP_psl')

iso.list()
# Will list all the isofill attribute values
iso.projection='linear'
lon30={-180:'180W',-150:'150W',0:'Eq'}
iso.xticlabels1=lon30
iso.xticlabels2=lon30
iso.xticlabels(lon30, lon30)
# Will set them both
iso.xmtics1=''
iso.xmtics2=''
iso.xmtics(lon30, lon30)
# Will set them both
iso.yticlabels1=lat10
iso.yticlabels2=lat10
iso.yticlabels(lat10, lat10)
# Will set them both
iso.ymtics1=''
iso.ymtics2=''
iso.ymtics(lat10, lat10)
# Will set them both
iso.datawc_y1=-90.0
iso.datawc_y2=90.0
iso.datawc_x1=-180.0
iso.datawc_x2=180.0
iso.datawc(-90, 90, -180, 180) # Will set them all
xaxisconvert='linear'
yaxisconvert='linear'
iso.xyscale('linear', 'area_wt') # Will set them both
missing=241 # Color index value range 0 to 255
# There are two possibilities for setting the isofill levels:
    # A) Levels are all contiguous (Examples):
    iso.levels=([0,20,25,30,35,40],)
iso.levels=([0,20,25,30,35,40,45,50])
iso.levels=[0,20,25,30,35,40]
iso.levels=(0.0,20.0,25.0,30.0,35.0,40.0,50.0)
# B) Levels are not contiguous (Examples):
    iso.levels=([0,20],[30,40],[50,60])
iso.levels=([0,20,25,30,35,40],[30,40],[50,60])
iso.fillareaindices=(7,fill,4,9,fill,15) # Set index using fillarea
fill.list() # list fillarea attributes
fill.style='hatch' # change style
fill.color=241 # change color
fill.index=3 # change style index

ext_1='n'
ext_2='y'
iso.exts('n', 'y' ) # Will set them both

# There are three possibilities for setting the fillarea color indices (Ex):
    iso.fillareacolors=([22,33,44,55,66,77])
iso.fillareacolors=(16,19,33,44)
iso.fillareacolors=None

# There are three possibilities for setting the fillarea style (Ex):
    iso.fillareastyle = 'solid'
iso.fillareastyle = 'hatch'
iso.fillareastyle = 'pattern'
# There are two ways to set the fillarea hatch or pattern indices (Ex):
    iso.fillareaindices=([1,3,5,6,9,20])
iso.fillareaindices=(7,1,4,9,6,15)
See using fillarea objects below!

# Using the fillarea secondary object (Ex):
    f=createfillarea('fill1')
# To Create a new instance of fillarea use:
    fill=a.createisofill('new','quick') # Copies 'quick' to 'new'
fill=a.createisofill('new') # Copies 'default' to 'new'

# To Modify an existing isofill use:
    fill=a.getisofill('def37')

Create a new isoline graphics method given the name and the existing isoline graphics method to copy the attributes from. If no existing isoline graphics method name is given, then the default isoline graphics method will be used as the graphics method to which the attributes will be copied from.

If the name provided already exists, then a error will be returned. Graphicsmethod names must be unique.

• new isoline name

• [name of isoline to copy attributes from]

Example of Use:

import vcs
a=vcs.init()
a.show('isoline')
iso=a.createisoline('example1',)
a.show('isoline')
iso=a.createisoline('example2','quick')
a.show('isoline')

VCS contains a list of graphics methods. This function will create a isoline class object from an existing VCS isoline graphics method. If no isoline name is given, then isoline 'default' will be used.

Note, VCS does not allow the modification of 'default' attribute sets. However, a 'default' attribute set that has been copied under a different name can be modified. (See the createisoline function.)

• [isoline name]

Example of Use:

import vcs
a=vcs.init()
a.show('isoline')
# Show all the existing isoline graphics methods
iso=a.getisoline()
# iso instance of 'default' isoline graphics method
iso2=a.getisoline('quick')
# iso2 instance of existing 'quick' isoline graphics method

Object: isolineobject

The Isoline graphics method draws lines of constant value at specified levels in order to graphically represent a two-dimensional array. It also labels the values of these isolines on the VCS Canvas. The example below shows how to plot isolines of different types at specified levels and how to create isoline labels having user-specified text and line type and color.

This class is used to define an isoline table entry used in VCS, or it can be used to change some or all of the isoline attributes in an existing isoline table entry.

Other Useful Functions:

a=vcs.init() Constructor

a.show('isoline') Show predefined isoline graphics methods

a.show('line') Show predefined VCS line objects

a.update() Updates the VCS Canvas at user's request

a.mode=1, or 0 If 1, then automatic update, else if 0, then use update function.

a.setcolormap("AMIP") Change the VCS color map

a.isoline(s,a,'default') Plot data 's' with isoline 'i' and 'default' template

tion to update the VCS Canvas.

See Chapter 6 for additional information.

Attributes:

• name

• projection

• xticlabels1

• xticlabels2

• xmtics1

• xmtics2

• yticlabels1

• yticlabels2

• ymtics1

• ymtics2

• datawc_x1

• datawc_y1

• datawc_x2

• datawc_y2

• xaxisconvert

• yaxisconvert

• label

• line

• linecolors

• text

• textcolors

• level

Example of Use:

import vcs
a=vcs.init()

# To Create a new instance of isoline use:
    iso=a.createisoline('new','quick')
# Copies content of 'quick' to 'new'
iso=a.createisoline('new')
# Copies content of 'default' to 'new'

# To Modify an existing isoline use:
    iso=a.getisoline('AMIP_psl')
iso.list()
# Will list all the isoline attribute values
iso.projection='linear'
lon30={-180:'180W',-150:'150W',0:'Eq'}
iso.xticlabels1=lon30
iso.xticlabels2=lon30
iso.xticlabels(lon30, lon30)
# Will set them both
iso.xmtics1=''
iso.xmtics2=''
iso.xmtics(lon30, lon30)
# Will set them both
iso.yticlabels1=lat10
iso.yticlabels2=lat10
iso.yticlabels(lat10, lat10)
# Will set them both
iso.datawc_y1=-90.0
iso.datawc_y2=90.0
iso.datawc_x1=-180.0
iso.datawc_x2=180.0
iso.datawc(-90, 90, -180, 180) # Will set them all
xaxisconvert='linear'
yaxisconvert='linear'
iso.xyscale('linear', 'area_wt') # Will set them both
# There are many possibilities ways to set the isoline values:
    # A) As a list of tuples (Examples):
    iso.level=[(23,32,45,50,76),]
iso.level=[(22,33,44,55,66)]
iso.level=[(20,0.0),(30,0),(50,0)]
iso.level=[(23,32,45,50,76), (35, 45, 55)]
# B) As a tuple of lists (Examples):
    iso.level=([23,32,45,50,76],)
iso.level=([22,33,44,55,66])
iso.level=([23,32,45,50,76],)
iso.level=([0,20,25,30,35,40],[30,40],[50,60]
)
# C) As a list of lists (Examples):
    iso.level=[[20,0.0],[30,0],[50,0]]
# D) As a tuple of tuples (Examples):
    iso.level=((20,0.0),(30,0),(50,0),(60,0),(70,0))
# Note: a combination of a pair (i.e., (30,0) or [30,0]) represents the isoline value plus it increment value. Thus, to let VCS generate "default" isolines enter the following:
    iso.level=[[0,1e20]]
# Same as iso.level=((0,1e20),)

Displaying isoline labels:
    iso.label='y'
# Same as iso.label=1, will display isoline labels
iso.label='n'
# Same as iso.label=0, will turn isoline labels off
# color index
iso.linecolors=None # Turns off the line color index

There are three ways to specify the text or font number:
    iso.text=(1,2,3,4,5,6,7,8,9) # Font numbers are between 1 and 9
iso.text=[9,8,7,6,5,4,3,2,1]
iso.text=([1,3,5,6,9,2])
iso.text=None # Removes the text settings
There are three possibilities for setting the text color indices (Ex.):
    iso.textcolors=([22,33,44,55,66,77])
iso.textcolors=(16,19,33,44)
iso.textcolors=None # Turns off the text color index

Create a new outfill graphics method given the name and the existing outfill graphics method to copy the attributes from. If no existing outfill graphics method name is given, then the default outfill graphics method will be used as the graphics method to which the attributes will be copied from.

If the name provided already exists, then a error will be returned. Graphics method names must be unique.

• new outfill name

• [name of outfill to copy attributes from]

Example of Use:

import vcs
a=vcs.init()
a.show('outfill')
out=a.createoutfill('example1',)
a.show('outfill')
out=a.createoutfill('example2','quick')
a.show('outfill')

VCS contains a list of graphics methods. This function will create a outfill class object from an existing VCS outfill graphics method. If no outfill name is given, then outfill 'default' will be used.

Note, VCS does not allow the modification of 'default' attribute sets. However, a 'default' attribute set that has been copied under a different name can be modified. (See the createoutfill function.)

• [outfill name]

Example of Use:

import vcs
a=vcs.init()
a.show('outfill')
# Show all the existing outfill graphics methods
out=a.getoutfill()
# out instance of 'default' outfill graphics method
out2=a.getoutfill('quick')
# out2 instance of existing 'quick' outfill graphics method

Object: outfillobject

The outfill graphics method fills a set of integer values in any data array.

Its primary purpose is to display continents by filling their area as defined by a surface type array that indicates land, ocean, and sea-ice points. The example below shows how to apply the outfill graphics method and how to modify

Fillarea and outfill attributes. Other Useful Functions:

a=vcs.init() Constructor

a.show('outfill') Show predefined outfill graphics methods

a.show('line') Show predefined VCS line objects

a.setcolormap("AMIP") Change the VCS color map

a.outfill(s,o,'default') Plot data 's' with outfill 'o' and 'default' template

a.update() Updates the VCS Canvas at user's request a.mode=1, or 0 . If 1, then automatic update, else if 0, then use update function to update the VCS Canvas.

See Chapter 6 for additional information.

Attributes:

• name

• projection

• xticlabels1

• xticlabels2

• xmtics1

• xmtics2

• yticlabels1

• yticlabels2

• ymtics1

• ymtics2

• datawc_x1

• datawc_y1

• datawc_x2

• datawc_y2

• xaxisconvert

• yaxisconvert

• fillareastyle

• fillareaindex

• fillareacolor

• outfill

Example of Use:

import vcs
a=vcs.init()

# To Create a new instance of outfill use:
    out=a.createoutfill('new','quick')
# Copies content of 'quick' to 'new'
out=a.createoutfill('new')
# Copies content of 'default' to 'new'


# To Modify an existing outfill use:
    out=a.getoutfill('AMIP_psl')
out.list()
# Will list all the outfill attribute values
out.projection='linear'
lon30={-180:'180W',-150:'150W',0:'Eq'}
out.xticlabels1=lon30
out.xticlabels2=lon30
out.xticlabels(lon30, lon30)
# Will set them both
out.xmtics1=''
out.xmtics2=''
out.xmtics(lon30, lon30)
# Will set them both
out.yticlabels1=lat10
out.yticlabels2=lat10
out.yticlabels(lat10, lat10)
# Will set them both
out.datawc_y1=-90.0
out.datawc_y2=90.0
out.datawc_x1=-180.0
out.datawc_x2=180.0
out.datawc(-90, 90, -180, 180) # Will set them all
xaxisconvert='linear'
yaxisconvert='linear'
out.xyscale('linear', 'area_wt') # Will set them both
# Specify the outfill fill values:
    out.outfill=([0,1,2,3,4]) # Same as below
out.outfill=(0,1,2,3,4) # Will specify the outfill values
# There are four possibilities for setting the color index (Ex):
    out.fillareacolor=22 # Same as below
out.fillareacolor=(22) # Same as below
out.fillareacolor=([22]) # Will set the outfill to a specific color index
out.fillareacolor=None # Turns off the color index

Create a new outline graphics method given the name and the existing outline graphics method to copy the attributes from. If no existing outline graphics method name is given, then the default outline graphics method will be used as the graphics method to which the attributes will be copied from.

If the name provided already exists, then a error will be returned. Graphics method names must be unique.

• new outline name

• [name of outline to copy attributes from]

</td>

Example of Use:

import vcs
a=vcs.init()
a.show('outline')
out=a.createoutline('example1',)
a.show('outline')
out=a.createoutline('example2','quick')
a.show('outline')

VCS contains a list of graphics methods. This function will create a outline class object from an existing VCS outline graphics method. If no outline name is given, then outline 'default' will be used.

Note, VCS does not allow the modification of 'default' attribute sets. However, a 'default' attribute set that has been copied under a different name can be modified. (See the createoutline function.)

• [outline name]

Example of Use:

import vcs
a=vcs.init()
a.show('outline')
# Show all the existing outline graphics methods
out=a.getoutline()
# out instance of 'default' outline graphics method
out2=a.getoutline('quick')
# out2 instance of existing 'quick' outline graphics method

Object: outlineobject

The Outline graphics method outlines a set of integer values in any data array.

Its primary purpose is to display continental outlines as defined by a surface

type array that indicates land, ocean, and sea-ice points. The example below

shows how to change such an outline by modifying its attributes.

Other Useful Functions:

a=vcs.init() Constructor

a.show('outline') Show predefined outline graphics methods

a.show('line') Show predefined VCS line objects

a.setcolormap("AMIP") Change the VCS color map

a.outline(s,o,'default') Plot data 's' with outline 'o' and 'default' template

a.update()

Updates the VCS Canvas at user's request a.mode=1, or 0 # If 1, then automatic update, else if 0, then use u pdate function to update the VCS Canvas.

See Chapter 6 for additional information.

Attributes:

• name

• projection

• xticlabels1

• xticlabels2

• xmtics1

• xmtics2

• yticlabels1

• yticlabels2

• ymtics1

• ymtics2

• datawc_x1

• datawc_y1

• datawc_x2

• datawc_y2

• xaxisconvert

• yaxisconvert

• line

• linecolor

• outline

Example of Use:

import vcs
a=vcs.init()

# To Create a new instance of outline use:
    out=a.createoutline('new','quick')
# Copies content of 'quick' to 'new'
out=a.createoutline('new')
# Copies content of 'default' to 'new'


# To Modify an existing outline use:
    out=a.getoutline('AMIP_psl')
out.list()
# Will list all the outline attribute values
out.projection='linear'
lon30={-180:'180W',-150:'150W',0:'Eq'}
out.xticlabels1=lon30
out.xticlabels2=lon30
out.xticlabels(lon30, lon30)
# Will set them both
out.xmtics1=''
out.xmtics2=''
out.xmtics(lon30, lon30)
# Will set them both
out.yticlabels1=lat10
out.yticlabels2=lat10
out.yticlabels(lat10, lat10)
# Will set them both
out.ymtics1=''
out.ymtics2=''
out.ymtics(lat10, lat10)
# Will set them both
 xyvsyobjectout.datawc_y1=-90.0
out.datawc_y2=90.0
out.datawc_x1=-180.0
out.datawc_x2=180.0
out.datawc(-90, 90, -180, 180) # Will set them all
xaxisconvert='linear'
yaxisconvert='linear'
out.xyscale('linear', 'area_wt') # Will set them both
# Specify the outline fill values:
    out.outline=([0,1,2,3,4]) # Same as below
out.outline=(0,1,2,3,4) # Will specify the outline values
# Specify the outline line type:
    out.line=0 # same as out.line = 'solid'
out.line=1 # same as out.line = 'dash'
out.line=2 # same as out.line = 'dot'
out.line=3
# same as out.line = 'dash-dot'
out.line=4 # same as out.line = 'long-dash'

# There are four possibilities for setting the line color index (Ex):
    out.linecolor=22 # Same as below
# Same as below
out.linecolor=([22]) # Will set the outline to a specific color index
out.linecolor=None # Turns off the color index

Create a new scatter graphics method given the name and the existing mscatter graphics method to copy the attributes from. If no existing scatter graphics method name is given, then the default scatter graphics method will be used as the graphics method to which the attributes will be copied from.

If the name provided already exists, then a error will be returned. Graphics method names must be unique

• new scatter name

• [name of scatter to copy attributes from]

Example of Use:

import vcs
a=vcs.init()
a.show('scatter')
sct=a.createscatter('example1',)
a.show('scatter')
sct=a.createscatter('example2','quick')
a.show('scatter')

VCS contains a list of graphics methods. This function will create a scatter class object from an existing VCS scatter graphics method. If no scatter name is given, then scatter 'default' will be used.

Note, VCS does not allow the modification of 'default' attribute sets. However, a 'default' attribute set that has been copied under a different name can be modified. (See the createscatter function.)

• [scatter name]

Example of Use:

import vcs
a=vcs.init()
a.show('scatter')
# Show all the existing scatter graphics methods
sct=a.getscatter()
# sct instance of 'default' scatter graphics method
sct2=a.getscatter('quick')
# sct2 instance of existing 'quick' scatter graphics method

Object: scatterobject

The Scatter graphics method displays a scatter plot of two 4-dimensional data arrays, e.g. A(x,y,z,t) and B(x,y,z,t). The example below shows how to change the marker attributes of a scatter plot.

This class is used to define an scatter table entry used in VCS, or it can be used to change some or all of the scatter attributes in an existing scatter table entry.

Other Useful Functions:

a=vcs.init() Constructor

a.show('scatter') Show predefined scatter graphics methods

a.show('marker') Show predefined marker objects

a.setcolormap("AMIP") Change the VCS color map

a.scatter(s1, s2, s,'default') Plot data 's1' and 's2' with scatter 's' and 'default' template

a.update() Updates the VCS Canvas at user's request a.mode=1, or 0. If 1, then automatic update, else if 0, then use update function to update the VCS Canvas.

See Chapter 6 for additional information.

Attributes:

• name

• projection

• xticlabels1

• xticlabels2

• xmtics1

• xmtics2

• yticlabels1

• yticlabels2

• ymtics1

• ymtics2

• datawc_x1

• datawc_y1

• datawc_x2

• datawc_y2

• xaxisconvert

• yaxisconvert

• marker

• markercolor

• markersize

Example of Use:

import vcs
a=vcs.init()

# To Create a new instance of scatter use:
    sr=a.createscatter('new','quick')
# copies content of 'quick' to 'new'
sr=a.createscatter('new')
# copies content of 'default' to 'new'

# To Modify an existing scatter use:
    sr=a.getscatter('AMIP_psl')
sr.list()
# Will list all the scatter attribute values
sr.projection='linear'
# Can only be 'linear'
lon30={-180:'180W',-150:'150W',0:'Eq'}
sr.xticlabels1=lon30
sr.xticlabels2=lon30
sr.xticlabels(lon30, lon30)
# Will set them both
sr.xmtics1=''
sr.xmtics2=''
sr.xmtics(lon30, lon30)
# Will set them both
sr.yticlabels1=lat10
sr.yticlabels2=lat10
sr.yticlabels(lat10, lat10)
# Will set them both
sr.ymtics1=''
sr.ymtics2=''
sr.ymtics(lat10, lat10)
# Will set them both
sr.datawc_y1=-90.0
sr.datawc_y2=90.0
sr.datawc_x1=-180.0
sr.datawc_x2=180.0
sr.datawc(-90, 90, -180, 180) # Will set them all
sr.xaxisconvert='linear'
sr.yaxisconvert='linear'
sr.xyscale('linear', 'area_wt') # Will set them both
# Specify the marker type:
    sr.marker=1 # Same as sr.marker='dot'
sr.marker=2 # Same as sr.marker='plus'
sr.marker=3 # Same as sr.marker='star'
sr.marker=4 # Same as sr.marker='circle'
sr.marker=5 # Same as sr.marker='cross'
sr.marker=6 # Same as sr.marker='diamond'
sr.marker=7
# Same as sr.marker='triangle_up'
sr.marker=8 # Same as sr.marker='triangle_down'
sr.marker=9 # Same as sr.marker='triangle_left'
sr.marker=10 # Same as sr.marker='triangle_right'
sr.marker=11 # Same as sr.marker='square'
sr.marker=12 # Same as sr.marker='diamond_fill'
sr.marker=13 # Same as sr.marker='triangle_up_fill'
sr.marker=14 # Same as sr.marker='triangle_down_fill'
sr.marker=15 # Same as sr.marker='triangle_left_fill'
sr.marker=16
# Same as below
sr.markercolor=(22) # Same as below
sr.markercolor=([22]) # Will set the markers to a specific
# color index
sr.markercolor=None # Color index defaults to Black

#To set the Marker sizie:
    sr.markersize=5
sr.markersize=55
sr.markersize=100
sr.markersize=300
sr.markersize=None

Create a new vector graphics method given the name and the existing vector graphics method to copy the attributes from. If no existing vector graphics method name is given, then the default vector graphics method will be used as the graphics method to which the attributes will be copied from.

If the name provided already exists, then a error will be returned. Graphics method names must be unique.

• new vector name

• [name of vector to copy attributes from]

Example of Use:

import vcs
a=vcs.init()
a.show('vector')
vec=a.createvector('example1',)
a.show('vector')
vec=a.createvector('example2','quick')
a.show('vector')

VCS contains a list of graphics methods. This function will create a vector class object from an existing VCS vector graphics method. If no vector name is given, then vector 'default' will be used.

Note, VCS does not allow the modification of 'default' attribute sets. However, a 'default' attribute set that has been copied under a different name can be modified. (See the createvector function.)

• [vector name]

Example of Use:

import vcs
a=vcs.init()
a.show('vector')
# Show all the existing vector graphics methods
vec=a.getvector()
# vec instance of 'default' vector graphics method
vec2=a.getvector('quick')
# vec2 instance of existing 'quick' vector graphics method

Object: vectorobject

The vector graphics method displays a vector plot of a 2D vector field. Vectors

are located at the coordinate locations and point in the direction of the data vector field. Vector magnitudes are the product of data vector field lengths and a scaling factor. The example below shows how to modify the vector's line, scale, alignment, type, and reference.

This class is used to define an vector table entry used in VCS, or it can be used to change some or all of the vector attributes in an existing vector table entry.

Other Useful Functions:

a=vcs.init() Constructor

a.show('vector') Show predefined vector graphics methods

a.show('line') Show predefined VCS line objects

a.setcolormap("AMIP") Change the VCS color Map

a.vector(s1, s2, v,'default') Plot data 's1', and 's2' with vector 'v' and 'default' template

a.update() Updates the VCS Canvas at user's request a.mode=1, or 0. If 1, then automatic update, else if 0, then use update function to update the VCS Canvas.

See Chapter 6 for additional information.

Attributes:

• name

• projection

• xticlabels1

• xticlabels2

• xmtics1

• xmtics2

• yticlabels1

• yticlabels2

• ymtics1

• ymtics2

• datawc_x1

• datawc_y1

• datawc_x2

• datawc_y2

• xaxisconvert

• yaxisconvert

• line

• linecolor

• scale

• alignment

• type

• reference

Example of Use:

import vcs
a=vcs.init()

# To Create a new instance of vector use:
    vc=a.createvector('new','quick')
# Copies content of 'quick' to 'new'
vc=a.createvector('new')
# Copies content of 'default' to 'new'

# To Modify an existing vector use:
    vc=a.getvector('AMIP_psl')
vc.list()
# Will list all the vector attribute values
vc.projection='linear'
# Can only be 'linear'
lon30={-180:'180W',-150:'150W',0:'Eq'}
vc.xticlabels1=lon30
vc.xticlabels2=lon30
vc.xticlabels(lon30, lon30)
# Will set them both
vc.xmtics1=''
vc.xmtics2=''
vc.xmtics(lon30, lon30)
# Will set them both
vc.yticlabels1=lat10
vc.yticlabels2=lat10
vc.yticlabels(lat10, lat10)
# Will set them both
vc.ymtics1=''
vc.ymtics2=''
vc.ymtics(lat10, lat10)
# Will set them both
vc.datawc_y1=-90.0
vc.datawc_y2=90.0
vc.datawc_x1=-180.0
vc.datawc_x2=180.0
vc.datawc(-90, 90, -180, 180) # Will set them all
xaxisconvert='linear'
yaxisconvert='linear'
vc.xyscale('linear', 'area_wt') # Will set them both
# Specify the line style:
    vc.line=0 # Same as vc.line='solid'
vc.line=1 # Same as vc.line='davc.line=2 # Same as vc.line='dot'
vc.line=3 # Same as vc.line='dash-dot'
vc.line=4 # Same as vc.line='long-dot'
# Specify the line color of the vectors:
    vc.linecolor=16
# Color range: 16 to 230, default line color is black
# Specify the vector scale factor:
    vc.scale=2.0 # Can be an integer or float
# Specify the vector alignment:
    vc.alignment=0
# Same as vc.alignment='head'
vc.alignment=1 # Same as vc.alignment='center'
vc.alignment=2 # Same as vc.alignment='tail'
# Specify the vector type:
    vc.type=0 # Same as vc.type='arrow head'
vc.type=1 # Same as vc.type='wind barbs'
vc.type=2 # Same as vc.type='solid arrow head'

Specify the vector reference:
    vc.reference=4 # Can be an integer or float

Create a new XvsY graphics method given the name and the existing XvsY graphics method to copy the attributes from. If no existing XvsY graphics method name is given, then the default XvsY graphics method will be used as the graphics method to which the attributes will be copied from.

If the name provided already exists, then a error will be returned. Graphics method names must be unique.

• new xvsy name

• [name of xvsy to copy attributes from]

  </ul> </td>

Example of Use:

import vcs
a=vcs.init()
a.show('xvsy')
xy=a.createxvsy('example1',)
a.show('xvsy')
xy=a.createxvsy('example2','quick')
a.show('xvsy')

VCS contains a list of graphics methods. This function will create a XvsY class object from an existing VCS XvsY graphics method. If no XvsY name is given, then XvsY 'default' will be used.

Note, VCS does not allow the modification of 'default' attribute sets. However, a 'default' attribute set that has been copied under a different name can be modified. (See the createxvsy function.)

• [xvsy name]

Example of Use:

import vcs
a=vcs.init()
a.show('xvsy')
# Show all the existing XvsY xy=a.getxvsy()
# graphics methods xy instance of 'default' XvsY graphics method
xy2=a.getxvsy('quick')
# xy2 instance of existing 'quick' XvsY graphics method

Object: xvsyobject

The XvsY graphics method displays a line plot from two 1D data arrays, that is X(t) and Y(t), where t represents the 1D coordinate values. The example below shows how to change line and marker attributes for the XvsY graphics method.

This class is used to define an XvsY table entry used in VCS, or it can be used to change some or all of the XvsY attributes in an existing XvsY table entry.

Other Useful Functions:

a=vcs.init() Constructor

a.show('xvsy') Show predefined XvsY graphics methonds

a.show('line') Show predefined VCS line objects

a.show('marker') Show predefined VCS marker objects

a.setcolormap("AMIP") Change the VCS color map

a.xvsy(s1, s2, ,x,'default') Plot data 's1' and 's2' with XvsY 'x' and 'default' template

a.update() Updates the VCS Canvas at user's request a.mode=1, or 0. If 1, then automatic update, else if 0, then use update function to Update the VCS Canvas.

See Chapter 6 for additional information.

Attributes:

• name

• projection

• xticlabels1

• xticlabels2

• xmtics1

• xmtics2

• yticlabels1

• yticlabels2

• ymtics1

• ymtics2

• datawc_x1

• datawc_y1

• datawc_x2

• datawc_y2

• xaxisconvert

• yaxisconvert

• line

• linecolor

• marker

• markercolor

• markersize

Example of Use:

import vcs
a=vcs.init()

# To Create a new instance of XvsY use:
    xy=a.createxvsy('new','quick')
# Copies content of 'quick' to 'new'
xy=a.createxvsy('new')
# Copies content of 'default' to 'new'

# To Modify an existing XvsY use:
    xy=a.getxvsy('AMIP_psl')
xy.list()
# Will list all the XvsY attribute values
xy.projection='linear'
# Can only be 'linear'
lon30={-180:'180W',-150:'150W',0:'Eq'}
xy.xticlabels1=lon30
xy.xticlabels2=lon30
xy.xticlabels(lon30, lon30)
# Will set them both
xy.xmtics1=''
xy.xmtics2=''
xy.xmtics(lon30, lon30)
# Will set them both
xy.yticlabels1=lat10
xy.yticlabels2=lat10
xy.yticlabels(lat10, lat10)
# Will set them both
xy.datawc_y1=-90.0
xy.datawc_y2=90.0
xy.datawc_x1=-180.0
xy.datawc_x2=180.0
xy.datawc(-90, 90, -180, 180) # Will set them all
xaxisconvert='linear'
yaxisconvert='linear'
xy.xyscale('linear', 'area_wt') # Will set them both
# Specify the XvsY line type:
    xy.line=0 # same as xy.line = 'solid'
xy.line=1 # same as xy.line = 'dash'
xy.line=2 # same as xy.line = 'dot'
xy.line=3 # same as xy.line = 'dash-dot'
xy.line=4 # same as xy.line = 'long-dash
# Specify the Xvsy line color:
    xy.line# color range: 16 to 230, default color is black
# Specify the XvsY marker type:
    xy.marker=1 # Same as xy.marker='dot'
xy.marker=2 # Same as xy.marker='plus'
xy.marker=3
color=16 # color index
# Same as xy.marker='star'
xy.marker=4 # Same as xy.marker='circle'
xy.marker=5 # Same as xy.marker='cross'
xy.marker=6 # Same as xy.marker='diamond'
xy.marker=7 # Same as xy.marker='triangle_up'
xy.marker=8 # Same as xy.marker='triangle_down'
xy.marker=9 # Same as xy.marker='triangle_left'
xy.marker=10 # Same as xy.marker='triangle_right'
xy.marker=11 # Same as xy.marker='square'
xy.marker=12
# Same as xy.marker='square'
xy.marker=12 # Same as xy.marker='diamond_fill'
xy.marker=13 # Same as xy.marker='triangle_up_fill'
xy.marker=14 # Same as xy.marker='triangle_down_fill'
xy.marker=15 # Same as xy.marker='triangle_left_fill'
xy.marker=16 # Same as xy.marker='triangle_right_fill'
xy.marker=17 # Same as xy.marker='square_fill'
xy.marker=None # Draw no markers