modellib/py_src/visualization.py

# $Id$

from esys.escript.modelframe import Model
from esys.escript import saveVTK
import os

class Visualization(Model):
    """
    Generic visualization of scalar, vector and tensorial data 
    (not implemeted yet)

    @ivar t: current time
    @ivar n: frame counter
    @ivar scalar: scalar data set
    @ivar vector: vector data set
    @ivar tensor: tensor data set
    @ivar dt: increment for output 
    @ivar filename: name of the output file
    """

    def __init__(self, debug=False):
        """
        Initialisation of the visualisation model object

        @param debug: Debugging flag
        """
        super(Visualization,self).__init__(debug=debug)
        self.declareParameter(t=0.,
                              n=0,
                              scalar=None,
                              vector=None,
                              tensor=None,
                              dt=1,
                              filename="movie.mpg")

    def doInitialization(self):
        """
        Does some kind of initialisation
        """
        self.__last_t=self.t

    def writeFrame(self):
       out=self.t>=self.__last_t+self.dt
       if out: 
            self.__last_t+=self.dt
            self.n+=1
       return out

    def getFrameCounter(self):
        return self.n-1

    def getSafeTimeStepSize(self,dt):
           """
           returns new step size

           @param dt: last time step size used
           @type dt: C{float}
           @return: time step size that can savely be used
           @rtype: C{float}
           """
           return self.__last_t+self.dt-self.t


    def doStepPostprocessing(self, dt):
        """
        renders the scene

        @note: to be overwritten
        """
        if self.writeFrame():
            self.trace("%s-th frame at time %s"%(self.getFrameCounter(),self.t))
            if not self.scalar==None:
               self.trace("scalar data: (min,max) =(%s,%s)"%(inf(self.scalar),sup(self.scalar)))
            if not self.vector==None:
               self.trace("vector data: (min,max) =(%s,%s)"%(inf(self.vector),sup(self.vector)))
            if not self.tensor==None:
               self.trace("tensor data: (min,max) =(%s,%s)"%(inf(self.tensor),sup(self.tensor)))
           
    def doFinalization(self):
        """
        Finalises the visualisation.  For instance, makes a movie of the image files.

        @note: to be overwritten
        """
        pass

class WriteVTK(Visualization):
    """
    Writes data into VTK files for further processing. 
    """

    def __init__(self, debug=False):
        """
        Initialisation of the WriteVTK object

        @param debug: Debugging flag
        """
        super(WriteVTK,self).__init__(debug=debug)

    def doInitialization(self):
        """
        Does some kind of initialisation
        """
        super(WriteVTK,self).doInitialization()
        fnc=self.filename.split('.')
        if len(fnc)==0:
           self.__filename="data.%s.xml"
        else:
           n=fnc[0]
           for i in range(1,len(fnc)-1):
              n+="."+fnc[i]
           if len(fnc)==1:
              self.__filename=n+".%s"
           else:
              self.__filename=n+".%s."+fnc[-1]
        self.trace("output filename is %s."%self.__filename)
       

    def doStepPostprocessing(self, dt):
        """
        Do any necessary postprocessing operations after a timestep.

        @param dt:
        """
        if self.writeFrame():
            kwargs={}
            if not self.scalar==None: kwargs["scalar"] = self.scalar
            if not self.vector==None: kwargs["vector"] = self.vector
            if not self.tensor==None: kwargs["tensor"] = self.tensor
            saveVTK(self.__filename%self.getFrameCounter(),**kwargs)
            self.trace("%s-th frame at time %s is writen to %s"%(self.getFrameCounter(),self.t,self.__filename%self.getFrameCounter()))

class ShadePlot(Visualization):
    """
    Shaded contour plots
    """
    
    def __init(self, debug=False):
        """
        Initialisation
        """
        Visualization.__init__(self, debug)
        self.declareParameter(filename="shadePlot.%s.png")

    def doStepPostprocessing(self, dt):
        """
        Do any necessary postprocessing operations after a timestep.

        @param dt:
        """
        self.counter += 1
        if self.counter % self.stride == 0:
            n = self.counter/self.stride

            # look for a vtk xml file of the right name and plot it
            dataFname = "data.s.%d.xml" % n
            if not os.path.exists(dataFname):
                print "Data file doesn't exist!  Skipping frame generation."

            else:
                import pyvisi
                import pyvisi.renderers.vtk
    
                scene = pyvisi.renderers.vtk.Scene()
                plot = pyvisi.renderers.vtk.ContourPlot(scene)
                plot.setData(fname=dataFname, 
                        format='vtk-xml', 
                        scalars='escript_scalar_data')
                scene.save(fname="shadePlot.%05d.png" % n, format="png")


class ArrowPlot(Visualization):
    """
    Arrow/vector/quiver plots
    """
    
    def __init(self, debug=False):
        """
        Initialisation
        """
        Visualization.__init__(self, debug)
        self.declareParameter(filename="arrowPlot.%s.png")

    def doStepPostprocessing(self, dt):
        """
        Do any necessary postprocessing operations after a timestep.

        @param dt:
        """
        self.counter += 1
        if self.counter % self.stride == 0:
            n = self.counter/self.stride

            # look for a vtk xml file of the right name and plot it
            dataFname = "data.v.%d.xml" % n
            if not os.path.exists(dataFname):
                print "Data file doesn't exist!  Skipping frame generation."

            else:
                import pyvisi
                import pyvisi.renderers.vtk
    
                scene = pyvisi.renderers.vtk.Scene()
                plot = pyvisi.renderers.vtk.ArrowPlot3D(scene)
                plot.setData(fname=dataFname, 
                        format='vtk-xml')
                scene.save(fname="arrowPlot.%05d.png" % n, format="png")


class EllipsoidPlot(Visualization):
    """
    Ellipsoid plots
    """
    
    def __init(self, debug=False):
        """
        Initialisation
        """
        Visualization.__init__(self, debug)


# vim: expandtab shiftwidth=4:
1	# $Id$
2
3	from esys.escript.modelframe import Model
4	from esys.escript import saveVTK
5	import os
6
7	class Visualization(Model):
8	"""
9	Generic visualization of scalar, vector and tensorial data
10	(not implemeted yet)
11
12	@ivar t: current time
13	@ivar n: frame counter
14	@ivar scalar: scalar data set
15	@ivar vector: vector data set
16	@ivar tensor: tensor data set
17	@ivar dt: increment for output
18	@ivar filename: name of the output file
19	"""
20
21	def __init__(self, debug=False):
22	"""
23	Initialisation of the visualisation model object
24
25	@param debug: Debugging flag
26	"""
27	super(Visualization,self).__init__(debug=debug)
28	self.declareParameter(t=0.,
29	n=0,
30	scalar=None,
31	vector=None,
32	tensor=None,
33	dt=1,
34	filename="movie.mpg")
35
36	def doInitialization(self):
37	"""
38	Does some kind of initialisation
39	"""
40	self.__last_t=self.t
41
42	def writeFrame(self):
43	out=self.t>=self.__last_t+self.dt
44	if out:
45	self.__last_t+=self.dt
46	self.n+=1
47	return out
48
49	def getFrameCounter(self):
50	return self.n-1
51
52	def getSafeTimeStepSize(self,dt):
53	"""
54	returns new step size
55
56	@param dt: last time step size used
57	@type dt: C{float}
58	@return: time step size that can savely be used
59	@rtype: C{float}
60	"""
61	return self.__last_t+self.dt-self.t
62
63
64	def doStepPostprocessing(self, dt):
65	"""
66	renders the scene
67
68	@note: to be overwritten
69	"""
70	if self.writeFrame():
71	self.trace("%s-th frame at time %s"%(self.getFrameCounter(),self.t))
72	if not self.scalar==None:
73	self.trace("scalar data: (min,max) =(%s,%s)"%(inf(self.scalar),sup(self.scalar)))
74	if not self.vector==None:
75	self.trace("vector data: (min,max) =(%s,%s)"%(inf(self.vector),sup(self.vector)))
76	if not self.tensor==None:
77	self.trace("tensor data: (min,max) =(%s,%s)"%(inf(self.tensor),sup(self.tensor)))
78
79	def doFinalization(self):
80	"""
81	Finalises the visualisation. For instance, makes a movie of the image files.
82
83	@note: to be overwritten
84	"""
85	pass
86
87	class WriteVTK(Visualization):
88	"""
89	Writes data into VTK files for further processing.
90	"""
91
92	def __init__(self, debug=False):
93	"""
94	Initialisation of the WriteVTK object
95
96	@param debug: Debugging flag
97	"""
98	super(WriteVTK,self).__init__(debug=debug)
99
100	def doInitialization(self):
101	"""
102	Does some kind of initialisation
103	"""
104	super(WriteVTK,self).doInitialization()
105	fnc=self.filename.split('.')
106	if len(fnc)==0:
107	self.__filename="data.%s.xml"
108	else:
109	n=fnc[0]
110	for i in range(1,len(fnc)-1):
111	n+="."+fnc[i]
112	if len(fnc)==1:
113	self.__filename=n+".%s"
114	else:
115	self.__filename=n+".%s."+fnc[-1]
116	self.trace("output filename is %s."%self.__filename)
117
118
119	def doStepPostprocessing(self, dt):
120	"""
121	Do any necessary postprocessing operations after a timestep.
122
123	@param dt:
124	"""
125	if self.writeFrame():
126	kwargs={}
127	if not self.scalar==None: kwargs["scalar"] = self.scalar
128	if not self.vector==None: kwargs["vector"] = self.vector
129	if not self.tensor==None: kwargs["tensor"] = self.tensor
130	saveVTK(self.__filename%self.getFrameCounter(),**kwargs)
131	self.trace("%s-th frame at time %s is writen to %s"%(self.getFrameCounter(),self.t,self.__filename%self.getFrameCounter()))
132
133	class ShadePlot(Visualization):
134	"""
135	Shaded contour plots
136	"""
137
138	def __init(self, debug=False):
139	"""
140	Initialisation
141	"""
142	Visualization.__init__(self, debug)
143	self.declareParameter(filename="shadePlot.%s.png")
144
145	def doStepPostprocessing(self, dt):
146	"""
147	Do any necessary postprocessing operations after a timestep.
148
149	@param dt:
150	"""
151	self.counter += 1
152	if self.counter % self.stride == 0:
153	n = self.counter/self.stride
154
155	# look for a vtk xml file of the right name and plot it
156	dataFname = "data.s.%d.xml" % n
157	if not os.path.exists(dataFname):
158	print "Data file doesn't exist! Skipping frame generation."
159
160	else:
161	import pyvisi
162	import pyvisi.renderers.vtk
163
164	scene = pyvisi.renderers.vtk.Scene()
165	plot = pyvisi.renderers.vtk.ContourPlot(scene)
166	plot.setData(fname=dataFname,
167	format='vtk-xml',
168	scalars='escript_scalar_data')
169	scene.save(fname="shadePlot.%05d.png" % n, format="png")
170
171
172	class ArrowPlot(Visualization):
173	"""
174	Arrow/vector/quiver plots
175	"""
176
177	def __init(self, debug=False):
178	"""
179	Initialisation
180	"""
181	Visualization.__init__(self, debug)
182	self.declareParameter(filename="arrowPlot.%s.png")
183
184	def doStepPostprocessing(self, dt):
185	"""
186	Do any necessary postprocessing operations after a timestep.
187
188	@param dt:
189	"""
190	self.counter += 1
191	if self.counter % self.stride == 0:
192	n = self.counter/self.stride
193
194	# look for a vtk xml file of the right name and plot it
195	dataFname = "data.v.%d.xml" % n
196	if not os.path.exists(dataFname):
197	print "Data file doesn't exist! Skipping frame generation."
198
199	else:
200	import pyvisi
201	import pyvisi.renderers.vtk
202
203	scene = pyvisi.renderers.vtk.Scene()
204	plot = pyvisi.renderers.vtk.ArrowPlot3D(scene)
205	plot.setData(fname=dataFname,
206	format='vtk-xml')
207	scene.save(fname="arrowPlot.%05d.png" % n, format="png")
208
209
210
211	class EllipsoidPlot(Visualization):
212	"""
213	Ellipsoid plots
214	"""
215
216	def __init(self, debug=False):
217	"""
218	Initialisation
219	"""
220	Visualization.__init__(self, debug)
221
222
223	# vim: expandtab shiftwidth=4:
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision