source: TI04-geosplat/trunk/pygss/PlotClasses.py @ 798

#   Copyright (C) 2004 CCLRC & NERC( Natural Environment Research Council ).
#   This software may be distributed under the terms of the
#   Q Public License, version 1.0 or later. http://ndg.nerc.ac.uk/public_docs/QPublic_license.txt

"""
PlotClasses.py
==============

Holds classes used for each plot type.

"""

# Import standard libary modules


# Import local modules
from serverConfig import *

class YvsXGraph:
    """
    Used for plotting 1D variables as graphs.
    """
    
    def __init__(self, canvas, data):
        """
        Takes canvas and data and calls other relevant methods.
        """
        self.canvas=canvas
        try:
            self.plot_type=canvas.createyxvsx("new_yxvsx","default")
        except:
            self.plot_type=canvas.getyxvsx("new_yxvsx") 
        self._extractData(data)
        self._getTemplate()

    def _extractData(self, data):
        """
        Used to extract the appropriate data object.
        """
        self.data=data(squeeze=1)

    def _getTemplate(self):
        """
        Sets up the appropriate template for a plot type.
        """
        try:
            self.template=self.canvas.gettemplate(VCS_TEMPLATES["no_levels"])
        except:
            self.template=self.canvas.gettemplate("AMIP")           

    def createPlot(self):
        """
        Plots the output and saves to a file.
        """
        # The next line is a bug fix to stop part of the plot being chopped when background plot is set to 1 (on).
        # self.canvas.open()
        if hasattr(self.data, "title"):
            fileComment="Dataset: "+self.data.title
        else:
            fileComment=""
        self.canvas.plot(self.data, self.template, self.plot_type, bg=1, file_comment=fileComment, comment1=SOURCE_NAME)



class SimplePlot:
    """
    SimplePlot class - used for non-XY plots.
    """
    
    def __init__(self, canvas, data):
        """
        Takes canvas and data and calls other relevant methods.
        """
        self.canvas=canvas
        self._extractData(data)
        self._getTemplate()

    def _extractData(self, data):
        """
        Used to extract the appropriate data object.
        """
        self.data=data(squeeze=1)

    def _getTemplate(self):
        """
        Sets up the appropriate template for a plot type.
        """
        try:
            self.template=self.canvas.gettemplate(VCS_TEMPLATES["no_levels"])
        except:
            self.template=self.canvas.gettemplate("AMIP")

    def createPlot(self, animationArgs=None, continentsSwitch=0):
        """
        Plots the output and saves to a file.
        """
        # The next line is a bug fix to stop part of the plot being chopped when background plot is set to 1 (on).
        # self.canvas.open()
        if hasattr(self.data, "title"):
            fileComment="Dataset: "+self.data.title
        else:
            fileComment=""
        if animationArgs==None:
            self.canvas.plot(self.data, self.template, bg=1, continents=continentsSwitch, file_comment=fileComment, comment1=SOURCE_NAME)
        else: # animationArgs is the slice indices of the data to plot converted to a string
            dataSlice=eval("self.data%s" % animationArgs)
            dataSlice=dataSlice(squeeze=1)
            #print dataSlice.shape, dataSlice.getAxisIds()
            #print dataSlice
            self.canvas.plot(dataSlice, self.template, self.plot_type, continents=continentsSwitch, bg=1, file_comment=fileComment, comment1=SOURCE_NAME) 


#        elif animationArgs[0]=="time":
#            self.canvas.plot(self.data(time=slice(animationArgs[1][0],animationArgs[1][1])), self.template, bg=1, continents=continentsSwitch, file_comment=fileComment, comment1=SOURCE_NAME) 
#        elif animationArgs[0]=="level":
#            self.canvas.plot(self.data(level=slice(animationArgs[1][0],animationArgs[1][1])), self.template, bg=1, continents=continentsSwitch, file_comment=fileComment, comment1=SOURCE_NAME)                


class Boxfill(SimplePlot):
    """
    Boxfill class - base class for all Boxfill types.
    """
    
    def __init__(self, canvas, data):
        self.canvas=canvas
        try:
            self.plot_type=canvas.createboxfill("new_boxfill","default")
        except:
            self.plot_type=canvas.getboxfill("new_boxfill")
        self._extractData(data)
        self._getProjection()
        self._getTemplate()

    def _extractData(self, data):
        """
        _extractData method - used to extract the appropriate data object.
        """
        self.data=data

    def _getTemplate(self):
        """
        _getTemplate method - sets up the appropriate template for a plot type.
        """
        try:
            if not self.data.getLevel():
                self.template=self.canvas.gettemplate(VCS_TEMPLATES["no_levels"])
            else:
                self.template=self.canvas.gettemplate(VCS_TEMPLATES["with_levels"])             
        except:
            self.template=self.canvas.gettemplate("AMIP")

    def createPlot(self, animationArgs=None, continentsSwitch=1):
        """
        createPlot method - plots the output.
        """
        # The next line is a bug fix to stop part of the plot being chopped when background plot is set to 1 (on).
        # self.canvas.open()
        if hasattr(self.data, "title"):
            fileComment="Dataset: "+self.data.title
        else:
            fileComment=""
        if animationArgs==None:
            self.canvas.plot(self.data, self.template, self.plot_type, bg=1, continents=continentsSwitch, file_comment=fileComment, comment1=SOURCE_NAME)
        else: # animationArgs is the slice indices of the data to plot converted to a string
            dataSlice=eval("self.data%s" % animationArgs)
            dataSlice=dataSlice(squeeze=1)
            #print dataSlice.shape, dataSlice.getAxisIds()
            #print dataSlice
            self.canvas.plot(dataSlice, self.template, self.plot_type, continents=continentsSwitch, bg=1, file_comment=fileComment, comment1=SOURCE_NAME) 

        #elif animationArgs[0]=="time":
        #    self.canvas.plot(self.data(time=slice(animationArgs[1][0],animationArgs[1][1])), self.template, self.plot_type, continents=continentsSwitch, bg=1, file_comment=fileComment, comment1=SOURCE_NAME) 
        #elif animationArgs[0]=="level":
        #    self.canvas.plot(self.data(level=slice(animationArgs[1][0],animationArgs[1][1])), self.template, self.plot_type, continents=continentsSwitch, bg=1, file_comment=fileComment, comment1=SOURCE_NAME)                

class BoxfillLinear(Boxfill):
    def _getProjection(self):
        self.plot_type.projection="linear"

        
class BoxfillMollweide(Boxfill):
    def _getProjection(self):
        self.plot_type.projection="mollweide"
            

class BoxfillPolarNorth(Boxfill):
    def _extractData(self, data):
        "Extracts only northern hemisphere."
        self.data=data(latitude=(90,0))

    def _getProjection(self):
        self.plot_type.projection="polar"
          
        
class BoxfillPolarSouth(BoxfillPolarNorth):
    def _extractData(self, data):
        "Extracts only southern hemisphere."
        self.data=data(latitude=(-90,0))

        
class BoxfillRobinson(Boxfill):
    def _getProjection(self):
        self.plot_type.projection="robinson"


class Isofill(Boxfill):
    def __init__(self, canvas, data):
        self.canvas=canvas
        try:
            self.plot_type=canvas.createisofill("new_isofill","default")
        except:
            self.plot_type=canvas.getisofill("new_isofill") 
        self._extractData(data)
        self._getProjection()
        self._getTemplate()


class IsofillLinear(Isofill):
    def _getProjection(self):
        self.plot_type.projection="linear"


class IsofillMollweide(Isofill):
    def _getProjection(self):
        self.plot_type.projection="mollweide"


class IsofillPolarNorth(Isofill):
    def _extractData(self, data):
        "Extracts only northern hemisphere."    
        self.data=data(latitude=(90,0))

    def _getProjection(self):
        self.plot_type.projection="polar"

        
class IsofillPolarSouth(IsofillPolarNorth):
    def _extractData(self, data):
        "Extracts only southern hemisphere." 
        self.data=data(latitude=(0,-90))

        
class IsofillRobinson(Isofill):
    def _getProjection(self):
        self.plot_type.projection="robinson"


class Isoline(Isofill):
    def __init__(self, canvas, data):
        self.canvas=canvas
        try:
            self.plot_type=canvas.createisoline("new_isoline","default")
        except:
            self.plot_type=canvas.getisoline("new_isoline")     
        self.plot_type.label="y"
        self._extractData(data)
        self._getProjection()
        self._getTemplate()


class IsolineLinear(Isoline):
    def _getProjection(self):
        self.plot_type.projection="linear"


class IsolineMollweide(Isoline):
    def _getProjection(self):
        self.plot_type.projection="mollweide"


class IsolinePolarNorth(Isoline):
    def _extractData(self, data):
        "Extracts only northern hemisphere."    
        self.data=data(latitude=(90,0))

    def _getProjection(self):
        self.plot_type.projection="polar"

        
class IsolinePolarSouth(IsolinePolarNorth):
    def _extractData(self, data):
        "Extracts only southern hemisphere." 
        self.data=data(latitude=(0,-90))

        
class IsolineRobinson(Isoline):
    def _getProjection(self):
        self.plot_type.projection="robinson"