Fixed vtkTools and vtkView to work for all cell,faces, edges.

Changed index for cells, faces and edges to be C,F,E respectively. Made viewprop, limits, extent as @properties, with error checks in the set methods. Need to finish the limits error checks.
2026-07-02 23:04:57 +08:00 · 2013-11-26 21:07:30 -08:00
parent 4b292b574d
commit 1ec3c5cd09
2 changed files with 134 additions and 44 deletions
@@ -61,6 +61,7 @@ class vtkTools(object):
 			vtkObj.GetCellData().AddArray(vtkDoubleArr)

 		vtkObj.GetCellData().SetActiveScalars(model.keys()[0])
+		vtkObj.Update()
 		return vtkObj

 	@staticmethod
@@ -104,7 +105,7 @@ class vtkTools(object):
 		# Cells -cell array
 		FCellArr = vtk.vtkCellArray()
 		FCellArr.SetNumberOfCells(mesh.nF)
-		FCellArr.SetCells(mesh.nF*5,npsup.numpy_to_vtkIdTypeArray(np.vstack([FxCellBlock,FyCellBlock,FzCellBlock]),deep=1))
+		FCellArr.SetCells(mesh.nF,npsup.numpy_to_vtkIdTypeArray(np.vstack([FxCellBlock,FyCellBlock,FzCellBlock]),deep=1))
 		# Cell type
 		FCellType = npsup.numpy_to_vtk(vtk.VTK_QUAD*np.ones(mesh.nF,dtype='uint8'),deep=1)
 		# Cell location
@@ -166,7 +167,7 @@ class vtkTools(object):
 		# Cells -cell array
 		ECellArr = vtk.vtkCellArray()
 		ECellArr.SetNumberOfCells(mesh.nE)
-		ECellArr.SetCells(mesh.nE*3,npsup.numpy_to_vtkIdTypeArray(np.vstack([ExCellBlock,EyCellBlock,EzCellBlock]),deep=1))
+		ECellArr.SetCells(mesh.nE,npsup.numpy_to_vtkIdTypeArray(np.vstack([ExCellBlock,EyCellBlock,EzCellBlock]),deep=1))
 		# Cell type
 		ECellType = npsup.numpy_to_vtk(vtk.VTK_LINE*np.ones(mesh.nE,dtype='uint8'),deep=1)
 		# Cell location
@@ -186,6 +187,7 @@ class vtkTools(object):
 			vtkObj.GetCellData().AddArray(vtkDoubleArr)

 		vtkObj.GetCellData().SetActiveScalars(model.keys()[0])
+		vtkObj.Update()
 		return vtkObj

 	@staticmethod
@@ -8,16 +8,16 @@ import SimPEG as simpeg

 class vtkView(object):
 	"""
-	Class for storing and view of SimPEG models in VTK (visulization toolkit).
+	Class for storing and view of SimPEG models in VTK (visualization toolkit).

 	Inputs:
 	:param mesh, SimPEG mesh.
 	:param propdict, dictionary of property models.
 		Can have these dictionary names:
-		'C' - cell model; 'F' - face model; 'E' - edge model
-		The dictionary properties are given as dictionaries with:
+		'C' - cell model; 'F' - face model; 'E' - edge model; ('V' - vector field : NOT SUPPORTED)
+		The dictionary values are given as dictionaries with:
 		{'NameOfThePropertyModel': np.array of the properties}.
-		The property array has to be ordered in compliance with SimPEG standards.
+		The property np.array has to be ordered in compliance with SimPEG standards.

 	::
 	Example of usages.
@@ -30,27 +30,7 @@ class vtkView(object):
 		"""
 		"""

-		# Error check inputs
-		if type(mesh).__name__ != 'TensorMesh':
-			raise Exception('The input {:s} to vtkView has to be a TensorMesh object'.format(mesh))
-
-
-		# Set default values
-		self.name = 'VTK figure of SimPEG model'
-		self._extent = [0,mesh.nCx-1,0,mesh.nCy-1,0,mesh.nCz-1]
-		self._limits = [0, 1e12]
-		self._viewprop = {'C':0} # Name of the tyep and Int order of the array or name of the vector.
-		self._mesh = mesh
-
-
-		# Set vtk object containers
-		self._cell = None
-		self._faces = None
-		self._edges = None
-
-		self._readPropertyDictionary(propdict)
-
-		# Setup hidden properties
+		# Setup hidden properties, used for the visualization
 		self._ren = None
 		self._iren = None
 		self._renwin = None
@@ -61,31 +41,122 @@ class vtkView(object):
 		self._widget = None
 		self._actor = None
 		self._lut = None
+		# Set vtk object containers
+		self._cells = None
+		self._faces = None
+		self._edges = None
+		self._vectors = None # Not implemented
+		# Set default values
+		self.name = 'VTK figure of SimPEG model'
+		

+
+		# Error check the input mesh
+		if type(mesh).__name__ != 'TensorMesh':
+			raise Exception('The input {:s} to vtkView has to be a TensorMesh object'.format(mesh))
+		# Set the mesh
+		self._mesh = mesh
+
+		# Read the property dictionary 
+		self._readPropertyDictionary(propdict)
+		
+
+		
+		
 	# Set/Get properties
 	@property 
 	def extent(self):
-		return getattr(self,_extent)
+		''' Extent of the sub-domain of the model to view'''
+		if getattr(self,'_extent',None) is None:
+			self._extent = [0,self._mesh.nCx-1,0,self._mesh.nCy-1,0,self._mesh.nCz-1]
+		return self._extent

 	@extent.setter
 	def extent(self,value):

+		import warnings
 		# Error check
-		valnp = np.array(value)
+		valnp = np.array(value,dtype=int)
 		if valnp.dtype != int or len(valnp) != 6:
 			raise Exception('.extent has to be list or nparray of 6 integers.')
-
+		# Test the range of the values
+		loB = np.zeros(3,dtype=int)
+		upB = np.array(self._mesh.nCv - np.ones(3),dtype=int)
+		# Test the bounds
+		change = 0
+		# Test for lower bounds, can't be smaller the 0
+		#tlb = np.prod(valnp[::2] < loB,axis=0,dtype=bool)
+		tlb = valnp[::2] < loB
+		if tlb.any(): 
+			valnp[::2][tlb] = loB[tlb] 
+			change = 1
+			warnings.warn('Lower bounds smaller then 0')
+		# Test for lower bounds, can't be larger then upB
+		#tlb = np.prod(valnp[::2] < loB,axis=0,dtype=bool)
+		tlub = valnp[::2] > upB
+		if tlub.any(): 
+			valnp[::2][tlub] = upB[tlub] - 1  
+			change = 1
+			warnings.warn('Lower bounds larger then uppermost bounds')
+		# Test for upper bounds, can't be larger the extent of the mesh
+		#tub = np.prod(valnp[1::2] > upB,axis=0,dtype=bool)
+		tub = valnp[1::2] > upB
+		if tub.any(): 
+			valnp[1::2][tub] = upB[tub] 
+			change = 1
+			warnings.warn('Upper bounds greater then number of cells')
+		# Test if lower is smaller the upper
+		#tgt = np.prod(valnp[::2] < valnp[1::2],axis=0,dtype=bool)
+		tgt = valnp[::2] > valnp[1::2]
+		if tgt.any():
+			valnp[1::2][tgt] = valnp[::2][tgt] + 1
+			change = 1
+			warnings.warn('Lower bounds greater the Upper bounds')
+		# Print a warning
+		if change:
+			warnings.warn('Changed given extent from {:s} to {:s}'.format(value,valnp.tolist()))
+		
+		# Set extent
 		self._extent = valnp

 	@property
 	def limits(self):
-		return getattr(self._limits)
+		''' Lower and upper limits (cutoffs) of the values to view. '''
+		return getattr(self,'_limits',None)
+			

 	@limits.setter
 	def limits(self,value):
-		valnp = np.array(value)
-		if valnp.dtype != float or len(valnp) != 2:
-			raise Exception('.limits has to be list or nparray of 2 floats.')
+		if value is None:
+			self._limits = None
+		else:
+			valnp = np.array(value)
+			if valnp.dtype != float or len(valnp) != 2:
+				raise Exception('.limits has to be list or numpy array of 2 floats.')
+			self._limits = valnp
+
+
+	@property 
+	def viewprop(self):
+		''' Controls the property that will be viewed.'''
+
+		if getattr(self,'_viewprop',None) is None:
+			self._viewprop = {'C':0} # Name of the type and Int order of the array or name of the vector.
+		return self._viewprop
+
+	@viewprop.setter
+	def viewprop(self,value):
+		if type(value) != dict:
+			raise Exception('{:s} has to be a python dictionary containing property type and name index. ')
+		if len(value) > 1:
+			raise Exception('Too many input items in the viewprop dictionary')
+		if value.keys()[0] not in ['C','F','E']:
+			raise Exception('\"{:s}\" is not allowed as a dictionary key. Can be \'C\',\'F\',\'E\'.'.format(propitem[0]))
+		if not(type(self.viewprop.values()[0]) is int or type(self.viewprop.values()[0]) is str):
+			raise Exception('The vtkView.viewprop.values()[0] has the wrong format. Has to be integer or a string with the index.')
+		
+
+		self._viewprop = value

 	def _readPropertyDictionary(self,propdict):
 		"""
@@ -94,18 +165,20 @@ class vtkView(object):
 		import SimPEG.visualize.vtk.vtkTools as vtkSP

 		# Test the property dictionary
-		if len(propdict) > 3:
-			raise(Exception,'Too many input items in the property dictionary')
+		if type(propdict) != dict:
+			raise Exception('{:s} has to be a python dictionary containing property models. ')
+		if len(propdict) > 4:
+			raise Exception('Too many input items in the property dictionary')
 		for propitem in propdict.iteritems():
 			if propitem[0] in ['C','F','E']:
 				if propitem[0] == 'C':
-					self._cell = vtkSP.makeCellVTKObject(self._mesh,propitem[1])
+					self._cells = vtkSP.makeCellVTKObject(self._mesh,propitem[1])
 				if propitem[0] == 'F':
-					self._face = vtkSP.makeFaceVTKObject(self._mesh,propitem[1])
+					self._faces = vtkSP.makeFaceVTKObject(self._mesh,propitem[1])
 				if propitem[0] == 'E':
-					self._edge = vtkSP.makeEdgeVTKObject(self._mesh,propitem[1])
+					self._edges = vtkSP.makeEdgeVTKObject(self._mesh,propitem[1])
 			else:
-				raise(Exception,'{:s} is not allowed as a dictonary key. Can be \'C\',\'F\',\'E\'.'.format(propitem[0]))
+				raise Exception('\"{:s}\" is not allowed as a dictionary key. Can be \'C\',\'F\',\'E\'.'.format(propitem[0]))

 	def Show(self):
 		"""
@@ -120,15 +193,22 @@ class vtkView(object):
 		self._iren, self._renwin = vtkSP.makeRenderWindow(self._ren)

 		imageType = self.viewprop.keys()[0]
+
 		# Sort out the actor
 		if imageType == 'C':
-			self._vtkobj, self._core = vtkSP.makeRectiVTKVOIThres(self._cell,self.extent,self.limits)
+			if self.limits is None:
+				self.limits = self._cells.GetCellData().GetArray(self.viewprop.values()[0]).GetRange()
+			self._vtkobj, self._core = vtkSP.makeRectiVTKVOIThres(self._cells,self.extent,self.limits)
 		elif imageType == 'F':
+			if self.limits is None:
+				self.limits = self._faces.GetCellData().GetArray(self.viewprop.values()[0]).GetRange()
 			extent = [self._mesh.vectorNx[self.extent[0]], self._mesh.vectorNx[self.extent[1]], self._mesh.vectorNy[self.extent[2]], self._mesh.vectorNy[self.extent[3]], self._mesh.vectorNz[self.extent[4]], self._mesh.vectorNz[self.extent[5]] ]
-			self._vtkobj, self._core = vtkSP.makeUnstructVTKVOIThres(self._face,extent,self.limits)
+			self._vtkobj, self._core = vtkSP.makeUnstructVTKVOIThres(self._faces,extent,self.limits)
 		elif imageType == 'E':
+			if self.limits is None:
+				self.limits = self._edges.GetCellData().GetArray(self.viewprop.values()[0]).GetRange()
 			extent = [self._mesh.vectorNx[self.extent[0]], self._mesh.vectorNx[self.extent[1]], self._mesh.vectorNy[self.extent[2]], self._mesh.vectorNy[self.extent[3]], self._mesh.vectorNz[self.extent[4]], self._mesh.vectorNz[self.extent[5]] ]
-			self._vtkobj, self._core = vtkSP.makeUnstructVTKVOIThres(self._edge,extent,self.limits)
+			self._vtkobj, self._core = vtkSP.makeUnstructVTKVOIThres(self._edges,extent,self.limits)
 		else:
 			raise Exception("{:s} is not a valid viewprop. Has to be 'C':'F':'E'".format(imageType))

@@ -174,6 +254,8 @@ class vtkView(object):


 if __name__ == '__main__':
+	
+
 	#Make a mesh and model
 	x0 = np.zeros(3)
 	h1 = np.ones(20)*50
@@ -183,8 +265,14 @@ if __name__ == '__main__':
 	mesh = simpeg.mesh.TensorMesh([h1,h2,h3],x0)

 	# Make a models that correspond to the cells, faces and edges.
-	models = {'C':{'Test':np.arange(0,mesh.nC),'AllOnce':np.ones(mesh.nC)},'F':{'Test':np.arange(0,np.sum(mesh.nF)),'AllOnce':np.ones(np.sum(mesh.nF))},'E':{'Test':np.arange(0,np.sum(mesh.nE)),'AllOnce':np.ones(np.sum(mesh.nE))}}
+	models = {'C':{'Test':np.arange(0,mesh.nC),'AllOnce':np.ones(mesh.nC)},'F':{'Test':np.arange(0,mesh.nF),'AllOnce':np.ones(mesh.nF)},'E':{'Test':np.arange(0,mesh.nE),'AllOnce':np.ones(mesh.nE)}}
 	# Make the vtk viewer object.
 	vtkViewer = simpeg.visualize.vtk.vtkView(mesh,models)
+	# Set the .viewprop for which model to view
+	vtkViewer.viewprop = {'F':'Test'}
 	# Show the image
 	vtkViewer.Show()
+
+	# Set subset of the mesh to view (remove padding)
+	vtkViewer.extent = [4,14,0,7,0,3]
+	vtkViewer.Show()