amrplot.polyplot Class Reference

Simple 2D plotter class using matplotlib, plots every cell in one patch. More...

Inheritance diagram for amrplot.polyplot:

Public Member Functions
def	__init__ (self, value, data, nlevels=256, grid=None, blocks=None, blockWidth=8, blockHeight=8, nlevel1=0, cmap='jet', min=None, max=None, xrange=None, yrange=None, orientation='vertical', right=True, fixzoom=None, fixrange=None, fig=None, axis=None, filenameout=None, clear=True, edgecolor='k', smooth=0, swap=0, kwargs)
def	setValue (self, value, min=None, max=None)
	Sets the min and max values of the data to saturate the display. More...
def	update (self, var=None, data=None, min=None, max=None, reset=None, fixrange=None, filenameout=None)
	Prepare to re-draw the window, check if data was updated. More...
def	info (self)
	Print info to the console. More...
def	show (self, var=None, data=None, min=None, max=None, reset=None, fixrange=None, filenameout=None)
	Draw the plotting-window. More...
def	colorbar (self, cax=None)
	Draw the colorbar. More...
def	save (self, filenameout=None)
	Save the figure. More...
def	onkey (self, event)

Public Attributes
	swap
	nlevels
	grid
	blocks
	blockWidth
	blockHeight
	nlevel1
	cmap
	orientation
	right
	cbarwidth
	cbarpad
	fixzoom
	fixrange
	filenameout
	clear
	fontsize
	fig_w
	fig_h
	dpi
	maxXticks
	maxYticks
	cbarticks
	edgecolor
	smooth
	xrange
	yrange
	figure
	ax
	value
	min
	max
	data
	viewXrange
	viewYrange
	valueClip
	xlist
	ylist
	xlistspecial
	ylistspecial
	cax
	cbar
	selection

Detailed Description

Simple 2D plotter class using matplotlib, plots every cell in one patch.

Definition at line 26 of file amrplot.py.

Constructor & Destructor Documentation

__init__()

def amrplot.polyplot.__init__	(		self,
			value,
			data,
			nlevels = 256,
			grid = None,
			blocks = None,
			blockWidth = 8,
			blockHeight = 8,
			nlevel1 = 0,
			cmap = 'jet',
			min = None,
			max = None,
			xrange = None,
			yrange = None,
			orientation = 'vertical',
			right = True,
			fixzoom = None,
			fixrange = None,
			fig = None,
			axis = None,
			filenameout = None,
			clear = True,
			edgecolor = 'k',
			smooth = 0,
			swap = 0,
			kwargs
	)

Definition at line 33 of file amrplot.py.

                 swap=0,**kwargs):

        self.swap=swap
        self.nlevels=nlevels
        self.grid = grid
        self.blocks = blocks
        self.blockWidth = blockWidth
        self.blockHeight = blockHeight
        self.nlevel1 = nlevel1
        self.cmap=cmap
        self.orientation=orientation
        self.right=right # If True, colorbar is at the right, if False it is at the left
        self.cbarwidth=0.15
        self.cbarpad=0.70
        self.fixzoom=fixzoom
        self.fixrange=fixrange
        self.filenameout=filenameout
        self.clear=clear # If True, the figure is cleared when initializing amrplot, preventing us e.g. for drawing on a different subplot.

        self.fontsize=10
        self.fig_w=2.5
        self.fig_h=4
        self.dpi=300
        self.maxXticks=None
        self.maxYticks=None
        self.cbarticks=None
        self.edgecolor=edgecolor
        self.smooth=smooth
            
        self.xrange=xrange
        self.yrange=yrange
        if xrange==None:
            self.xrange=[data.getBounds()[0],data.getBounds()[1]]
        if yrange==None:
            self.yrange=[data.getBounds()[2],data.getBounds()[3]]

        self.setValue(value,min=min,max=max)

        # initialize for screen:
            # If a figure and axis were not given, create new ones
        if fig==None:
            self.figure=plt.figure(figsize=(self.fig_w,self.fig_h),dpi=100)
        else:
            # else, use what was given
            self.figure=fig

        if axis==None:
            self.ax = self.figure.gca()
        else:
            self.ax = axis

        self.show(var=value,data=data,min=min,max=max)
        if self.filenameout == None:
            self.figure.canvas.mpl_connect('button_press_event', self.onkey)

Member Function Documentation

colorbar()

def amrplot.polyplot.colorbar	(		self,
			cax = None
	)

Draw the colorbar.

Definition at line 252 of file amrplot.py.

        '''
        colormap = plt.cm.get_cmap(self.cmap, self.nlevels)
        m = plt.cm.ScalarMappable(cmap=colormap)
        m.set_array(self.valueClip)
        m.set_clim(vmin=self.min,vmax=self.max)
        
        if (cax==None):
            divider = make_axes_locatable(self.ax)
            if self.orientation == 'horizontal':
                self.cax = divider.append_axes("bottom", self.cbarwidth, pad=self.cbarpad)
            else:
                if self.right:
                    self.cax = divider.append_axes("right", "4%", pad="6%")
                else:
                    self.cax = divider.append_axes("left", "4%", pad="6%")
        else:
            self.cax=cax
                    
        self.cbar=self.figure.colorbar(m, orientation=self.orientation,cax=self.cax)
                    
        self.cbar.solids.set_rasterized(True)

        if self.cbarticks != None:
            self.cbar.locator=MaxNLocator(nbins=self.cbarticks-1)
            self.cbar.update_ticks()


        for tick in self.cbar.ax.get_xticklabels():
            tick.set_fontsize(self.fontsize)
        for tick in self.cbar.ax.get_yticklabels():
            tick.set_fontsize(self.fontsize)
        self.cbar.ax.xaxis.get_offset_text().set_fontsize(self.fontsize-2)
        self.cbar.ax.yaxis.get_offset_text().set_fontsize(self.fontsize-2)

info()

def amrplot.polyplot.info

(

self

)

Print info to the console.

Definition at line 135 of file amrplot.py.

        '''Print info to the console'''
        print('=======================================================')
        print('plotting range between %e and %e' % (self.min,self.max))
        if self.fixzoom==None:
            print('xrange = [%e,%e]     yrange = [%e,%e]' % (self.xrange[0],self.xrange[1],self.yrange[0],self.yrange[1]))
        else:
            print('''Fixing zoomlevel to
xrange = [%e,%e]     yrange = [%e,%e]''' % (
                self.viewXrange[0],self.viewXrange[1],self.viewYrange[0],self.viewYrange[1]))
        if self.nlevels<=1:
            print('Need more than one color-level, resetting nlevels')
            self.nlevels=256
        print('colormap = %s; nlevels=%d; orientation=%s' % (self.cmap,self.nlevels,self.orientation))
        if self.grid!=None:
            print('Also showing gridlines')
        if self.blocks!=None:
            print('Also showing blocks')
        print('=======================================================')
            

onkey()

def amrplot.polyplot.onkey	(		self,
			event
	)

Definition at line 300 of file amrplot.py.

        '''
        try:
            if event.button !=2:
                return True
        except AttributeError:
                return True
        if event.xdata == None:
            try:
                self.selection.pop(0).remove()
                plt.show()
            except:
                return True
            return True
       
        icell=self.data.getIcellByPoint(event.xdata,event.ydata)
        try:
            self.selection.pop(0).remove()
        except AttributeError:
            print('first time defining selection, please wait for centerpoints...')
        except ValueError:
            pass
        except IndexError:
            pass
        self.selection=self.ax.plot(self.data.getCenterPoints()[icell,0],self.data.getCenterPoints()[icell,1],'m+', markersize=20,markeredgewidth=3)
        plt.show()
        self.data.showValues(icell)
        print('value=%e' %(self.value[icell]))
        if self.value[icell] != self.valueClip[icell]:
            print('exceeding plot range')
        print('=======================================================')


#=============================================================================

save()

def amrplot.polyplot.save	(		self,
			filenameout = None
	)

Save the figure.

Definition at line 287 of file amrplot.py.

        '''Save the figure'''
        if filenameout != None:
            self.filenameout=filenameout
        print('saving plot to file %s' % (self.filenameout))
        self.figure.set_size_inches( (self.fig_w,self.fig_h) )
        self.figure.savefig(self.filenameout, transparent=False,aa=True,dpi=self.dpi,interpolation='bicubic',bbox_inches='tight')
        self.filenameout=None

        

setValue()

def amrplot.polyplot.setValue	(		self,
			value,
			min = None,
			max = None
	)

Sets the min and max values of the data to saturate the display.

Definition at line 90 of file amrplot.py.

        '''Sets the min and max values of the data to saturate the display'''
        self.value=value
        self.min=min
        self.max=max
        if self.min==None:
            self.min=value.min()
        if self.max==None:
            self.max=value.max()

show()

def amrplot.polyplot.show	(		self,
			var = None,
			data = None,
			min = None,
			max = None,
			reset = None,
			fixrange = None,
			filenameout = None
	)

Draw the plotting-window.

Definition at line 155 of file amrplot.py.

        '''Draw the plotting-window'''
        t0 = default_timer()

        self.update(var=var,data=data,min=min,max=max,reset=reset,fixrange=fixrange,filenameout=filenameout)

        if self.clear:
            self.figure.clf()
            self.ax = self.figure.gca()     
        self.info()
     
        colormap = plt.cm.get_cmap(self.cmap, self.nlevels)

        valueRange=self.max-self.min
        if valueRange == 0.:
            valueRange = 1

        self.valueClip = np.clip(self.value,self.min,self.max)

        tdata0= default_timer()
        if (self.swap == 0):
            [myxlist,myylist]=self.data.getPointList()
        else:
            [myylist,myxlist]=self.data.getPointList()
        # List for regular cells with finite values (no infinitys or NaNs)
        self.xlist = [[] for i in range(self.nlevels)]
        self.ylist = [[] for i in range(self.nlevels)]
        ilevel = ((self.nlevels-1)*(self.valueClip-self.min)/valueRange).astype(int)
        # Special list to contain NaNs or other problematic cells
        self.xlistspecial = []
        self.ylistspecial = []
        for icell in range(self.data.ncells):
             if ilevel[icell] > -1 and ilevel[icell]<self.nlevels:
                  self.xlist[ilevel[icell]].extend(myxlist[5*icell:5*(icell+1)])
                  self.ylist[ilevel[icell]].extend(myylist[5*icell:5*(icell+1)])
             else:
                  self.xlistspecial.extend(myxlist[5*icell:5*(icell+1)])
                  self.ylistspecial.extend(myylist[5*icell:5*(icell+1)])
        tdata1=default_timer()

        # Fill cells with finite values
        for ilevel in range(self.nlevels):
            self.ax.fill(self.xlist[ilevel],self.ylist[ilevel],
                     facecolor=colormap(ilevel/(self.nlevels-1.)), closed=False, edgecolor='none',antialiased=False,zorder=-10)

        # Fill cells with special values
        if self.xlistspecial: # If the list of special cells is not empty
            nancolor = 'magenta'
            print('WARNING: There are NaNs or Inftys, NaN color:',nancolor)
            self.ax.fill(self.xlistspecial,self.ylistspecial,
                     facecolor=nancolor, closed=False, edgecolor='none',antialiased=False,zorder=-10)

        if self.grid != None:
            self.ax.fill(myxlist,myylist, 
                     facecolor='none', edgecolor=self.edgecolor,aa=True,linewidth=0.2,alpha=0.8)

        if self.blocks != None:
            [myxBlockList,myyBlockList] = self.data.getPieces(self.blockWidth,self.blockHeight,self.nlevel1)
            self.ax.fill(myxBlockList,myyBlockList, 
                    facecolor='none', edgecolor=self.edgecolor,aa=True,linewidth=0.2,alpha=0.8)

        if self.orientation != None:
            self.colorbar()
        
        if self.fixzoom==None:
            self.ax.set_xlim(self.xrange[0],self.xrange[1])
            self.ax.set_ylim(self.yrange[0],self.yrange[1])
        else:
            self.ax.set_xlim(self.viewXrange)
            self.ax.set_ylim(self.viewYrange)
        self.ax.set_aspect('equal')
# ticks:
        if self.maxXticks != None:
            self.ax.xaxis.set_major_locator(MaxNLocator(self.maxXticks-1))
        if self.maxYticks != None:
            self.ax.yaxis.set_major_locator(MaxNLocator(self.maxYticks-1))

        for tick in self.ax.xaxis.get_major_ticks():
            tick.label1.set_fontsize(self.fontsize)
        for tick in self.ax.yaxis.get_major_ticks():
            tick.label1.set_fontsize(self.fontsize)
        self.ax.xaxis.get_offset_text().set_fontsize(self.fontsize-2)
        self.ax.yaxis.get_offset_text().set_fontsize(self.fontsize-2)

        tend = default_timer()
        print('time for arranging the data= %f sec' % (tdata1-tdata0))
        print('Execution time = %f sec' % (tend-t0))
        print('=======================================================')
        if self.filenameout == None:
            plt.draw()

# Make the main axis active:
        plt.sca(self.ax)

update()

def amrplot.polyplot.update	(		self,
			var = None,
			data = None,
			min = None,
			max = None,
			reset = None,
			fixrange = None,
			filenameout = None
	)

Prepare to re-draw the window, check if data was updated.

Definition at line 100 of file amrplot.py.

        '''Prepare to re-draw the window, check if data was updated'''
        if var is not None:
            newdata = np.any(var!=self.value)
        else:
            newdata = False

        if newdata:
            self.value=var
            if fixrange == None:
                if min==None:
                    self.min=self.value.min()
                if max==None:
                    self.max=self.value.max()
        if data != None:
            self.data=data
        if reset != None:
            self.min=self.value.min()
            self.max=self.value.max()
        if min != None:
            self.min = min
        if max != None:
            self.max = max
        
        if filenameout != None:
            self.filenameout=filenameout
            self.figure.set_size_inches( (self.fig_w,self.fig_h) )

        self.ax.set_rasterization_zorder(-9)

        # save the view for later:
        self.viewXrange=deepcopy( self.ax.xaxis.get_view_interval() )
        self.viewYrange=deepcopy( self.ax.yaxis.get_view_interval() )

        

Member Data Documentation

ax

amrplot.polyplot.ax

Definition at line 80 of file amrplot.py.

blockHeight

amrplot.polyplot.blockHeight

Definition at line 40 of file amrplot.py.

blocks

amrplot.polyplot.blocks

Definition at line 38 of file amrplot.py.

blockWidth

amrplot.polyplot.blockWidth

Definition at line 39 of file amrplot.py.

cax

amrplot.polyplot.cax

Definition at line 261 of file amrplot.py.

cbar

amrplot.polyplot.cbar

Definition at line 270 of file amrplot.py.

cbarpad

amrplot.polyplot.cbarpad

Definition at line 46 of file amrplot.py.

cbarticks

amrplot.polyplot.cbarticks

Definition at line 58 of file amrplot.py.

cbarwidth

amrplot.polyplot.cbarwidth

Definition at line 45 of file amrplot.py.

clear

amrplot.polyplot.clear

Definition at line 50 of file amrplot.py.

cmap

amrplot.polyplot.cmap

Definition at line 42 of file amrplot.py.

data

amrplot.polyplot.data

Definition at line 114 of file amrplot.py.

dpi

amrplot.polyplot.dpi

Definition at line 55 of file amrplot.py.

edgecolor

amrplot.polyplot.edgecolor

Definition at line 59 of file amrplot.py.

fig_h

amrplot.polyplot.fig_h

Definition at line 54 of file amrplot.py.

fig_w

amrplot.polyplot.fig_w

Definition at line 53 of file amrplot.py.

figure

amrplot.polyplot.figure

Definition at line 74 of file amrplot.py.

filenameout

amrplot.polyplot.filenameout

Definition at line 49 of file amrplot.py.

fixrange

amrplot.polyplot.fixrange

Definition at line 48 of file amrplot.py.

fixzoom

amrplot.polyplot.fixzoom

Definition at line 47 of file amrplot.py.

fontsize

amrplot.polyplot.fontsize

Definition at line 52 of file amrplot.py.

grid

amrplot.polyplot.grid

Definition at line 37 of file amrplot.py.

max

amrplot.polyplot.max

Definition at line 93 of file amrplot.py.

maxXticks

amrplot.polyplot.maxXticks

Definition at line 56 of file amrplot.py.

maxYticks

amrplot.polyplot.maxYticks

Definition at line 57 of file amrplot.py.

min

amrplot.polyplot.min

Definition at line 92 of file amrplot.py.

nlevel1

amrplot.polyplot.nlevel1

Definition at line 41 of file amrplot.py.

nlevels

amrplot.polyplot.nlevels

Definition at line 36 of file amrplot.py.

orientation

amrplot.polyplot.orientation

Definition at line 43 of file amrplot.py.

right

amrplot.polyplot.right

Definition at line 44 of file amrplot.py.

selection

amrplot.polyplot.selection

Definition at line 323 of file amrplot.py.

smooth

amrplot.polyplot.smooth

Definition at line 60 of file amrplot.py.

swap

amrplot.polyplot.swap

Definition at line 35 of file amrplot.py.

value

amrplot.polyplot.value

Definition at line 91 of file amrplot.py.

valueClip

amrplot.polyplot.valueClip

Definition at line 171 of file amrplot.py.

viewXrange

amrplot.polyplot.viewXrange

Definition at line 130 of file amrplot.py.

viewYrange

amrplot.polyplot.viewYrange

Definition at line 131 of file amrplot.py.

xlist

amrplot.polyplot.xlist

Definition at line 179 of file amrplot.py.

xlistspecial

amrplot.polyplot.xlistspecial

Definition at line 183 of file amrplot.py.

xrange

amrplot.polyplot.xrange

Definition at line 62 of file amrplot.py.

ylist

amrplot.polyplot.ylist

Definition at line 180 of file amrplot.py.

ylistspecial

amrplot.polyplot.ylistspecial

Definition at line 184 of file amrplot.py.

yrange

amrplot.polyplot.yrange

Definition at line 63 of file amrplot.py.

---

The documentation for this class was generated from the following file:

• amrplot.py