/usr/lib/python2.7/dist-packages/vtk/numpy_interface/dataset_adapter.py is in python-vtk6 6.3.0+dfsg1-11build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 | """This module provides classes that allow Numpy-type access
to VTK datasets and arrays. This is best described with some examples.
To normalize a VTK array:
import vtk
import vtk.numpy_interface.dataset_adapter as dsa
import vtk.numpy_interface.algorithms as algs
rt = vtk.vtkRTAnalyticSource()
rt.Update()
image = dsa.WrapDataObject(rt.GetOutput())
rtdata = image.PointData['RTData']
rtmin = algs.min(rtdata)
rtmax = algs.max(rtdata)
rtnorm = (rtdata - rtmin) / (rtmax - rtmin)
image.PointData.append(rtnorm, 'RTData - normalized')
print image.GetPointData().GetArray('RTData - normalized').GetRange()
To calculate gradient:
grad= algs.gradient(rtnorm)
To access subsets:
>>> grad[0:10]
VTKArray([[ 0.10729134, 0.03763443, 0.03136338],
[ 0.02754352, 0.03886006, 0.032589 ],
[ 0.02248248, 0.04127144, 0.03500038],
[ 0.02678365, 0.04357527, 0.03730421],
[ 0.01765099, 0.04571581, 0.03944477],
[ 0.02344007, 0.04763837, 0.04136734],
[ 0.01089381, 0.04929155, 0.04302051],
[ 0.01769151, 0.05062952, 0.04435848],
[ 0.002764 , 0.05161414, 0.04534309],
[ 0.01010841, 0.05221677, 0.04594573]])
>>> grad[:, 0]
VTKArray([ 0.10729134, 0.02754352, 0.02248248, ..., -0.02748174,
-0.02410045, 0.05509736])
All of this functionality is also supported for composite datasets
even though their data arrays may be spread across multiple datasets.
We have implemented a VTKCompositeDataArray class that handles many
Numpy style operators and is supported by all algorithms in the
algorithms module.
This module also provides an API to access composite datasets.
For example:
mb = vtk.vtkMultiBlockDataSet()
mb.SetBlock(0, image.VTKObject)
mb.SetBlock(1e, image.VTKObject)
cds = dsa.WrapDataObject(mb)
for block in cds:
print block
Note that this module implements only the wrappers for datasets
and arrays. The classes implement many useful operators. However,
to make best use of these classes, take a look at the algorithms
module.
"""
try:
import numpy
except ImportError:
raise RuntimeError("This module depends on the numpy module. Please make\
sure that it is installed properly.")
import itertools
import operator
from vtk.util import numpy_support
from vtk.vtkCommonDataModel import vtkDataObject
import weakref
def reshape_append_ones (a1, a2):
"""Returns a list with the two arguments, any of them may be
processed. If the arguments are numpy.ndarrays, append 1s to the
shape of the array with the smallest number of dimensions until
the arrays have the same number of dimensions. Does nothing if the
arguments are not ndarrays or the arrays have the same number of
dimensions.
"""
l = [a1, a2]
if (isinstance(a1, numpy.ndarray) and isinstance(a2, numpy.ndarray)):
len1 = len(a1.shape)
len2 = len(a2.shape)
if (len1 == len2 or len1 == 0 or len2 == 0 or
a1.shape[0] != a2.shape[0]):
return l;
elif (len1 < len2):
d = len1
maxLength = len2
i = 0
else:
d = len2
maxLength = len1
i = 1
while (d < maxLength):
l[i] = numpy.expand_dims(l[i], d)
d = d + 1
return l
class ArrayAssociation :
"""Easy access to vtkDataObject.AttributeTypes"""
POINT = vtkDataObject.POINT
CELL = vtkDataObject.CELL
FIELD = vtkDataObject.FIELD
ROW = vtkDataObject.ROW
class VTKObjectWrapper(object):
"""Superclass for classes that wrap VTK objects with Python objects.
This class holds a reference to the wrapped VTK object. It also
forwards unresolved methods to the underlying object by overloading
__get__attr."""
def __init__(self, vtkobject):
self.VTKObject = vtkobject
def __getattr__(self, name):
"Forwards unknown attribute requests to VTK object."
return getattr(self.VTKObject, name)
def _MakeObserver(numpy_array):
"Internal function used to attach a numpy array to a vtk array"
def Closure(caller, event):
foo = numpy_array
return Closure
def vtkDataArrayToVTKArray(array, dataset=None):
"Given a vtkDataArray and a dataset owning it, returns a VTKArray."
narray = numpy_support.vtk_to_numpy(array)
# Make arrays of 9 components into matrices. Also transpose
# as VTK store matrices in Fortran order
shape = narray.shape
if len(shape) == 2 and shape[1] == 9:
narray = narray.reshape((shape[0], 3, 3)).transpose(0, 2, 1)
return VTKArray(narray, array=array, dataset=dataset)
def numpyTovtkDataArray(array, name="numpy_array", array_type=None):
"""Given a numpy array or a VTKArray and a name, returns a vtkDataArray.
The resulting vtkDataArray will store a reference to the numpy array
through a DeleteEvent observer: the numpy array is released only when
the vtkDataArray is destroyed."""
if not array.flags.contiguous:
array = array.copy()
vtkarray = numpy_support.numpy_to_vtk(array, array_type=array_type)
vtkarray.SetName(name)
# This makes the VTK array carry a reference to the numpy array.
vtkarray.AddObserver('DeleteEvent', _MakeObserver(array))
return vtkarray
def _make_tensor_array_contiguous(array):
if array == None:
return None
if array.flags.contiguous:
return array
array = numpy.asarray(array)
size = array.dtype.itemsize
strides = array.strides
if len(strides) == 3 and strides[1]/size == 1 and strides[2]/size == 3:
return array.transpose(0, 2, 1)
return array
class VTKArray(numpy.ndarray):
"""This is a sub-class of numpy ndarray that stores a
reference to a vtk array as well as the owning dataset.
The numpy array and vtk array should point to the same
memory location."""
def __metaclass__(name, parent, attr):
"""We overwrite numerical/comparison operators because we might need
to reshape one of the arrays to perform the operation without
broadcast errors. For instace:
An array G of shape (n,3) resulted from computing the
gradient on a scalar array S of shape (n,) cannot be added together without
reshaping.
G + expand_dims(S,1) works,
G + S gives an error:
ValueError: operands could not be broadcast together with shapes (n,3) (n,)
This metaclass overwrites operators such that it computes this
reshape operation automatically by appending 1s to the
dimensions of the array with fewer dimensions.
"""
def add_numeric_op(attr_name):
"""Create an attribute named attr_name that calls
_numeric_op(self, other, op)."""
def closure(self, other):
return VTKArray._numeric_op(self, other, attr_name)
closure.__name__ = attr_name
attr[attr_name] = closure
def add_default_numeric_op(op_name):
"""Adds '__[op_name]__' attribute that uses operator.[op_name]"""
add_numeric_op("__%s__"%op_name)
def add_reverse_numeric_op(attr_name):
"""Create an attribute named attr_name that calls
_reverse_numeric_op(self, other, op)."""
def closure(self, other):
return VTKArray._reverse_numeric_op(self, other, attr_name)
closure.__name__ = attr_name
attr[attr_name] = closure
def add_default_reverse_numeric_op(op_name):
"""Adds '__r[op_name]__' attribute that uses operator.[op_name]"""
add_reverse_numeric_op("__r%s__"%op_name)
def add_default_numeric_ops(op_name):
"""Call both add_default_numeric_op and add_default_reverse_numeric_op."""
add_default_numeric_op(op_name)
add_default_reverse_numeric_op(op_name)
add_default_numeric_ops("add")
add_default_numeric_ops("sub")
add_default_numeric_ops("mul")
add_default_numeric_ops("div")
add_default_numeric_ops("truediv")
add_default_numeric_ops("floordiv")
add_default_numeric_ops("mod")
add_default_numeric_ops("pow")
add_default_numeric_ops("lshift")
add_default_numeric_ops("rshift")
add_numeric_op("and")
add_default_numeric_ops("xor")
add_numeric_op("or")
add_default_numeric_op("lt")
add_default_numeric_op("le")
add_default_numeric_op("eq")
add_default_numeric_op("ne")
add_default_numeric_op("ge")
add_default_numeric_op("gt")
return type(name, parent, attr)
def _numeric_op(self, other, attr_name):
"""Used to implement numpy-style numerical operations such as __add__,
__mul__, etc."""
l = reshape_append_ones(self, other)
return getattr(numpy.ndarray, attr_name)(l[0], l[1])
def _reverse_numeric_op(self, other, attr_name):
"""Used to implement numpy-style numerical operations such as __add__,
__mul__, etc."""
l = reshape_append_ones(self, other)
return getattr(numpy.ndarray, attr_name)(l[0], l[1])
def __new__(cls, input_array, array=None, dataset=None):
# Input array is an already formed ndarray instance
# We first cast to be our class type
obj = numpy.asarray(input_array).view(cls)
obj.Association = ArrayAssociation.FIELD
# add the new attributes to the created instance
obj.VTKObject = array
# if dataset:
# import weakref
# obj.DataSet = weakref.ref(dataset)
obj.DataSet = dataset
# Finally, we must return the newly created object:
return obj
def __array_finalize__(self,obj):
# Copy the VTK array only if the two share data
slf = _make_tensor_array_contiguous(self)
obj2 = _make_tensor_array_contiguous(obj)
self.VTKObject = None
try:
# This line tells us that they are referring to the same buffer.
# Much like two pointers referring to same memory location in C/C++.
if buffer(slf) == buffer(obj2):
self.VTKObject = getattr(obj, 'VTKObject', None)
except TypeError:
pass
self.Association = getattr(obj, 'Association', None)
self.DataSet = getattr(obj, 'DataSet', None)
def __getattr__(self, name):
"Forwards unknown attribute requests to VTK array."
if not hasattr(self, "VTKObject") or not self.VTKObject:
raise AttributeError("class has no attribute %s" % name)
return getattr(self.VTKObject, name)
class VTKNoneArray(object):
"""VTKNoneArray is used to represent a "void" array. An instance
of this class (NoneArray) is returned instead of None when an
array that doesn't exist in a DataSetAttributes is requested.
All operations on the NoneArray return NoneArray. The main reason
for this is to support operations in parallel where one of the
processes may be working on an empty dataset. In such cases,
the process is still expected to evaluate a whole expression because
some of the functions may perform bulk MPI communication. None
cannot be used in these instances because it cannot properly override
operators such as __add__, __sub__ etc. This is the main raison
d'etre for VTKNoneArray."""
def __metaclass__(name, parent, attr):
"""Simplify the implementation of the numeric/logical sequence API."""
def _add_op(attr_name, op):
"""Create an attribute named attr_name that calls
_numeric_op(self, other, op)."""
def closure(self, other):
return VTKNoneArray._op(self, other, op)
closure.__name__ = attr_name
attr[attr_name] = closure
def _add_default_reverse_op(op_name):
"""Adds '__r[op_name]__' attribute that uses operator.[op_name]"""
_add_op("__r%s__"%op_name, getattr(operator, op_name))
def _add_default_op(op_name):
"""Adds '__[op_name]__' attribute that uses operator.[op_name]"""
_add_op("__%s__"%op_name, getattr(operator, op_name))
def _add_default_ops(op_name):
"""Call both add_default_numeric_op and add_default_reverse_numeric_op."""
_add_default_op(op_name)
_add_default_reverse_op(op_name)
_add_default_ops("add")
_add_default_ops("sub")
_add_default_ops("mul")
_add_default_ops("div")
_add_default_ops("truediv")
_add_default_ops("floordiv")
_add_default_ops("mod")
_add_default_ops("pow")
_add_default_ops("lshift")
_add_default_ops("rshift")
_add_op("__and__", operator.and_)
_add_op("__rand__", operator.and_)
_add_default_ops("xor")
_add_op("__or__", operator.or_)
_add_op("__ror__", operator.or_)
_add_default_op("lt")
_add_default_op("le")
_add_default_op("eq")
_add_default_op("ne")
_add_default_op("ge")
_add_default_op("gt")
return type(name, parent, attr)
def __getitem__(self, index):
return NoneArray
def _op(self, other, op):
"""Used to implement numpy-style numerical operations such as __add__,
__mul__, etc."""
return NoneArray
NoneArray = VTKNoneArray()
class VTKCompositeDataArray(object):
"""This class manages a set of arrays of the same name contained
within a composite dataset. Its main purpose is to provide a
Numpy-type interface to composite data arrays which are naturally
nothing but a collection of vtkDataArrays. A VTKCompositeDataArray
makes such a collection appear as a single Numpy array and support
all array operations that this module and the associated algorithm
module support. Note that this is not a subclass of a Numpy array
and as such cannot be passed to native Numpy functions. Instead
VTK modules should be used to process composite arrays.
"""
def __metaclass__(name, parent, attr):
"""Simplify the implementation of the numeric/logical sequence API."""
def add_numeric_op(attr_name, op):
"""Create an attribute named attr_name that calls
_numeric_op(self, other, op)."""
def closure(self, other):
return VTKCompositeDataArray._numeric_op(self, other, op)
closure.__name__ = attr_name
attr[attr_name] = closure
def add_reverse_numeric_op(attr_name, op):
"""Create an attribute named attr_name that calls
_reverse_numeric_op(self, other, op)."""
def closure(self, other):
return VTKCompositeDataArray._reverse_numeric_op(self, other, op)
closure.__name__ = attr_name
attr[attr_name] = closure
def add_default_reverse_numeric_op(op_name):
"""Adds '__r[op_name]__' attribute that uses operator.[op_name]"""
add_reverse_numeric_op("__r%s__"%op_name, getattr(operator, op_name))
def add_default_numeric_op(op_name):
"""Adds '__[op_name]__' attribute that uses operator.[op_name]"""
add_numeric_op("__%s__"%op_name, getattr(operator, op_name))
def add_default_numeric_ops(op_name):
"""Call both add_default_numeric_op and add_default_reverse_numeric_op."""
add_default_numeric_op(op_name)
add_default_reverse_numeric_op(op_name)
add_default_numeric_ops("add")
add_default_numeric_ops("sub")
add_default_numeric_ops("mul")
add_default_numeric_ops("div")
add_default_numeric_ops("truediv")
add_default_numeric_ops("floordiv")
add_default_numeric_ops("mod")
add_default_numeric_ops("pow")
add_default_numeric_ops("lshift")
add_default_numeric_ops("rshift")
add_numeric_op("__and__", operator.and_)
add_reverse_numeric_op("__rand__", operator.and_)
add_default_numeric_ops("xor")
add_numeric_op("__or__", operator.or_)
add_reverse_numeric_op("__ror__", operator.or_)
add_default_numeric_op("lt")
add_default_numeric_op("le")
add_default_numeric_op("eq")
add_default_numeric_op("ne")
add_default_numeric_op("ge")
add_default_numeric_op("gt")
return type(name, parent, attr)
def __init__(self, arrays = [], dataset = None, name = None,
association = ArrayAssociation.FIELD):
"""Construct a composite array given a container of
arrays, a dataset, name and association. It is sufficient
to define a container of arrays to define a composite array.
It is also possible to initialize an array by defining
the dataset, name and array association. In that case,
the underlying arrays will be created lazily when they
are needed. It is recommended to use the latter method
when initializing from an existing composite dataset."""
self._Arrays = arrays
self.DataSet = dataset
self.Name = name
self.Association = association
self.Initialized = False
def __init_from_composite(self):
if self.Initialized:
return
self.Initialized = True
if self.DataSet is None or self.Name is None:
return
self._Arrays = []
for ds in self.DataSet:
self._Arrays.append(ds.GetAttributes(self.Association)[self.Name])
def GetSize(self):
"Returns the number of elements in the array."
self.__init_from_composite()
size = numpy.int64(0)
for a in self._Arrays:
try:
size += a.size
except AttributeError:
pass
return size
size = property(GetSize)
def GetArrays(self):
"""Returns the internal container of VTKArrays. If necessary,
this will populate the array list from a composite dataset."""
self.__init_from_composite()
return self._Arrays
Arrays = property(GetArrays)
def __getitem__(self, index):
"""Overwritten to refer indexing to underlying VTKArrays.
For the most part, this will behave like Numpy. Note
that indexing is done per array - arrays are never treated
as forming a bigger array. If the index is another composite
array, a one-to-one mapping between arrays is assumed.
"""
self.__init_from_composite()
res = []
if type(index) == VTKCompositeDataArray:
for a, idx in itertools.izip(self._Arrays, index.Arrays):
if a is not NoneArray:
res.append(a.__getitem__(idx))
else:
res.append(NoneArray)
else:
for a in self._Arrays:
if a is not NoneArray:
res.append(a.__getitem__(index))
else:
res.append(NoneArray)
return VTKCompositeDataArray(res, dataset=self.DataSet)
def _numeric_op(self, other, op):
"""Used to implement numpy-style numerical operations such as __add__,
__mul__, etc."""
self.__init_from_composite()
res = []
if type(other) == VTKCompositeDataArray:
for a1, a2 in itertools.izip(self._Arrays, other.Arrays):
if a1 is not NoneArray and a2 is not NoneArray:
l = reshape_append_ones(a1, a2)
res.append(op(l[0],l[1]))
else:
res.append(NoneArray)
else:
for a in self._Arrays:
if a is not NoneArray:
l = reshape_append_ones(a, other)
res.append(op(l[0], l[1]))
else:
res.append(NoneArray)
return VTKCompositeDataArray(res, dataset=self.DataSet)
def _reverse_numeric_op(self, other, op):
"""Used to implement numpy-style numerical operations such as __add__,
__mul__, etc."""
self.__init_from_composite()
res = []
if type(other) == VTKCompositeDataArray:
for a1, a2 in itertools.izip(self._Arrays, other.Arrays):
if a1 is not NoneArray and a2 is notNoneArray:
l = reshape_append_ones(a2,a1)
res.append(op(l[0],l[1]))
else:
res.append(NoneArray)
else:
for a in self._Arrays:
if a is not NoneArray:
l = reshape_append_ones(other, a)
res.append(op(l[0], l[1]))
else:
res.append(NoneArray)
return VTKCompositeDataArray(res, dataset=self.DataSet)
def __str__(self):
return self.Arrays.__str__()
class DataSetAttributes(VTKObjectWrapper):
"""This is a python friendly wrapper of vtkDataSetAttributes. It
returns VTKArrays. It also provides the dictionary interface."""
def __init__(self, vtkobject, dataset, association):
super(DataSetAttributes, self).__init__(vtkobject)
# import weakref
# self.DataSet = weakref.ref(dataset)
self.DataSet = dataset
self.Association = association
def __getitem__(self, idx):
"""Implements the [] operator. Accepts an array name or index."""
return self.GetArray(idx)
def GetArray(self, idx):
"Given an index or name, returns a VTKArray."
if isinstance(idx, int) and idx >= self.VTKObject.GetNumberOfArrays():
raise IndexError, "array index out of range"
vtkarray = self.VTKObject.GetArray(idx)
if not vtkarray:
vtkarray = self.VTKObject.GetAbstractArray(idx)
if vtkarray:
return vtkarray
return NoneArray
array = vtkDataArrayToVTKArray(vtkarray, self.DataSet)
array.Association = self.Association
return array
def keys(self):
"""Returns the names of the arrays as a list."""
kys = []
narrays = self.VTKObject.GetNumberOfArrays()
for i in range(narrays):
name = self.VTKObject.GetAbstractArray(i).GetName()
if name:
kys.append(name)
return kys
def values(self):
"""Returns the arrays as a list."""
vals = []
narrays = self.VTKObject.GetNumberOfArrays()
for i in range(narrays):
a = self.VTKObject.GetAbstractArray(i)
if a.GetName():
vals.append(a)
return vals
def PassData(self, other):
"A wrapper for vtkDataSet.PassData."
try:
self.VTKObject.PassData(other)
except TypeError:
self.VTKObject.PassData(other.VTKObject)
def append(self, narray, name):
"""Appends a new array to the dataset attributes."""
if narray is NoneArray:
# if NoneArray, nothing to do.
return
if self.Association == ArrayAssociation.POINT:
arrLength = self.DataSet.GetNumberOfPoints()
elif self.Association == ArrayAssociation.CELL:
arrLength = self.DataSet.GetNumberOfCells()
else:
if not isinstance(narray, numpy.ndarray):
arrLength = 1
else:
arrLength = narray.shape[0]
# Fixup input array length:
if not isinstance(narray, numpy.ndarray) or numpy.ndim(narray) == 0: # Scalar input
narray = narray * numpy.ones(arrLength)
elif narray.shape[0] != arrLength: # Vector input
components = reduce(operator.mul, narray.shape)
narray = narray.flatten() * numpy.ones((arrLength, components))
shape = narray.shape
if len(shape) == 3:
# Array of matrices. We need to make sure the order in memory is right.
# If column order (c order), transpose. VTK wants row order (fortran
# order). The deep copy later will make sure that the array is contiguous.
# If row order but not contiguous, transpose so that the deep copy below
# does not happen.
size = narray.dtype.itemsize
if (narray.strides[1]/size == 3 and narray.strides[2]/size == 1) or \
(narray.strides[1]/size == 1 and narray.strides[2]/size == 3 and \
not narray.flags.contiguous):
narray = narray.transpose(0, 2, 1)
# If array is not contiguous, make a deep copy that is contiguous
if not narray.flags.contiguous:
narray = narray.copy()
# Flatten array of matrices to array of vectors
if len(shape) == 3:
narray = narray.reshape(shape[0], shape[1]*shape[2])
# this handle the case when an input array is directly appended on the
# output. We want to make sure that the array added to the output is not
# referring to the input dataset.
copy = VTKArray(narray)
try:
copy.VTKObject = narray.VTKObject
except AttributeError: pass
arr = numpyTovtkDataArray(copy, name)
self.VTKObject.AddArray(arr)
class CompositeDataSetAttributes():
"""This is a python friendly wrapper for vtkDataSetAttributes for composite
datsets. Since composite datasets themselves don't have attribute data, but
the attribute data is associated with the leaf nodes in the composite
dataset, this class simulates a DataSetAttributes interface by taking a
union of DataSetAttributes associated with all leaf nodes."""
def __init__(self, dataset, association):
# import weakref
# self.DataSet = weakref.ref(dataset)
self.DataSet = dataset
self.Association = association
self.ArrayNames = []
self.Arrays = {}
# build the set of arrays available in the composite dataset. Since
# composite datasets can have partial arrays, we need to iterate over
# all non-null blocks in the dataset.
self.__determine_arraynames()
def __determine_arraynames(self):
array_set = set()
array_list = []
for dataset in self.DataSet:
dsa = dataset.GetAttributes(self.Association)
for array_name in dsa.keys():
if array_name not in array_set:
array_set.add(array_name)
array_list.append(array_name)
self.ArrayNames = array_list
def keys(self):
"""Returns the names of the arrays as a list."""
return self.ArrayNames
def __getitem__(self, idx):
"""Implements the [] operator. Accepts an array name."""
return self.GetArray(idx)
def append(self, narray, name):
"""Appends a new array to the composite dataset attributes."""
if narray is NoneArray:
# if NoneArray, nothing to do.
return
added = False
if not isinstance(narray, VTKCompositeDataArray): # Scalar input
for ds in self.DataSet:
ds.GetAttributes(self.Association).append(narray, name)
added = True
if added:
self.ArrayNames.append(name)
# don't add the narray since it's a scalar. GetArray() will create a
# VTKCompositeArray on-demand.
else:
for ds, array in itertools.izip(self.DataSet, narray.Arrays):
if array != None:
ds.GetAttributes(self.Association).append(array, name)
added = True
if added:
self.ArrayNames.append(name)
self.Arrays[name] = weakref.ref(narray)
def GetArray(self, idx):
"""Given a name, returns a VTKCompositeArray."""
arrayname = idx
if arrayname not in self.ArrayNames:
return NoneArray
if arrayname not in self.Arrays or self.Arrays[arrayname]() is None:
array = VTKCompositeDataArray(
dataset = self.DataSet, name = arrayname, association = self.Association)
self.Arrays[arrayname] = weakref.ref(array)
else:
array = self.Arrays[arrayname]()
return array
def PassData(self, other):
"""Emulate PassData for composite datasets."""
for this,that in zip(self.DataSet, other.DataSet):
for assoc in [ArrayAssociation.POINT, ArrayAssociation.CELL]:
this.GetAttributes(assoc).PassData(that.GetAttributes(assoc))
class CompositeDataIterator(object):
"""Wrapper for a vtkCompositeDataIterator class to satisfy
the python iterator protocol. This iterator iterates
over non-empty leaf nodes. To iterate over empty or
non-leaf nodes, use the vtkCompositeDataIterator directly.
"""
def __init__(self, cds):
self.Iterator = cds.NewIterator()
if self.Iterator:
self.Iterator.UnRegister(None)
self.Iterator.GoToFirstItem()
def __iter__(self):
return self
def next(self):
if not self.Iterator:
raise StopIteration
if self.Iterator.IsDoneWithTraversal():
raise StopIteration
retVal = self.Iterator.GetCurrentDataObject()
self.Iterator.GoToNextItem()
return WrapDataObject(retVal)
def __getattr__(self, name):
"""Returns attributes from the vtkCompositeDataIterator."""
return getattr(self.Iterator, name)
class MultiCompositeDataIterator(CompositeDataIterator):
"""Iterator that can be used to iterate over multiple
composite datasets together. This iterator works only
with arrays that were copied from an original using
CopyStructured. The most common use case is to use
CopyStructure, then iterate over input and output together
while creating output datasets from corresponding input
datasets."""
def __init__(self, cds):
CompositeDataIterator.__init__(self, cds[0])
self.Datasets = cds
def next(self):
if not self.Iterator:
raise StopIteration
if self.Iterator.IsDoneWithTraversal():
raise StopIteration
retVal = []
retVal.append(WrapDataObject(self.Iterator.GetCurrentDataObject()))
if len(self.Datasets) > 1:
for cd in self.Datasets[1:]:
retVal.append(WrapDataObject(cd.GetDataSet(self.Iterator)))
self.Iterator.GoToNextItem()
return retVal
class DataObject(VTKObjectWrapper):
"""A wrapper for vtkDataObject that makes it easier to access FielData
arrays as VTKArrays
"""
def GetAttributes(self, type):
"""Returns the attributes specified by the type as a DataSetAttributes
instance."""
if type == ArrayAssociation.FIELD:
return DataSetAttributes(self.VTKObject.GetFieldData(), self, type)
return DataSetAttributes(self.VTKObject.GetAttributes(type), self, type)
def GetFieldData(self):
"Returns the field data as a DataSetAttributes instance."
return DataSetAttributes(self.VTKObject.GetFieldData(), self, ArrayAssociation.FIELD)
FieldData = property(GetFieldData, None, None, "This property returns the field data of a data object.")
class Table(DataObject):
"""A wrapper for vtkFielData that makes it easier to access RowData array as
VTKArrays
"""
def GetRowData(self):
"Returns the row data as a DataSetAttributes instance."
return self.GetAttributes(ArrayAssociation.ROW)
RowData = property(GetRowData, None, None, "This property returns the row data of the table.")
class CompositeDataSet(DataObject):
"""A wrapper for vtkCompositeData and subclasses that makes it easier
to access Point/Cell/Field data as VTKCompositeDataArrays. It also
provides a Python type iterator."""
def __init__(self, vtkobject):
DataObject.__init__(self, vtkobject)
self._PointData = None
self._CellData = None
self._FieldData = None
self._Points = None
def __iter__(self):
"Creates an iterator for the contained datasets."
return CompositeDataIterator(self)
def GetNumberOfElements(self, assoc):
"""Returns the total number of cells or points depending
on the value of assoc which can be ArrayAssociation.POINT or
ArrayAssociation.CELL."""
result = 0
for dataset in self:
result += dataset.GetNumberOfElements(assoc)
return int(result)
def GetNumberOfPoints(self):
"""Returns the total number of points of all datasets
in the composite dataset. Note that this traverses the
whole composite dataset every time and should not be
called repeatedly for large composite datasets."""
return self.GetNumberOfElements(ArrayAssociation.POINT)
def GetNumberOfCells(self):
"""Returns the total number of cells of all datasets
in the composite dataset. Note that this traverses the
whole composite dataset every time and should not be
called repeatedly for large composite datasets."""
return self.GetNumberOfElements(ArrayAssociation.CELL)
def GetAttributes(self, type):
"""Returns the attributes specified by the type as a
CompositeDataSetAttributes instance."""
return CompositeDataSetAttributes(self, type)
def GetPointData(self):
"Returns the point data as a DataSetAttributes instance."
if self._PointData is None or self._PointData() is None:
pdata = self.GetAttributes(ArrayAssociation.POINT)
self._PointData = weakref.ref(pdata)
return self._PointData()
def GetCellData(self):
"Returns the cell data as a DataSetAttributes instance."
if self._CellData is None or self._CellData() is None:
cdata = self.GetAttributes(ArrayAssociation.CELL)
self._CellData = weakref.ref(cdata)
return self._CellData()
def GetFieldData(self):
"Returns the field data as a DataSetAttributes instance."
if self._FieldData is None or self._FieldData() is None:
fdata = self.GetAttributes(ArrayAssociation.FIELD)
self._FieldData = weakref.ref(fdata)
return self._FieldData()
def GetPoints(self):
"Returns the points as a VTKCompositeDataArray instance."
if self._Points is None or self._Points() is None:
pts = []
for ds in self:
try:
_pts = ds.Points
except AttributeError:
_pts = None
if _pts is None:
pts.append(NoneArray)
else:
pts.append(_pts)
if len(pts) == 0 or all(map(lambda a : a is NoneArray, pts)):
cpts = NoneArray
else:
cpts = VTKCompositeDataArray(pts, dataset=self)
self._Points = weakref.ref(cpts)
return self._Points()
PointData = property(GetPointData, None, None, "This property returns the point data of the dataset.")
CellData = property(GetCellData, None, None, "This property returns the cell data of a dataset.")
FieldData = property(GetFieldData, None, None, "This property returns the field data of a dataset.")
Points = property(GetPoints, None, None, "This property returns the points of the dataset.")
class DataSet(DataObject):
"""This is a python friendly wrapper of a vtkDataSet that defines
a few useful properties."""
def GetPointData(self):
"Returns the point data as a DataSetAttributes instance."
return self.GetAttributes(ArrayAssociation.POINT)
def GetCellData(self):
"Returns the cell data as a DataSetAttributes instance."
return self.GetAttributes(ArrayAssociation.CELL)
PointData = property(GetPointData, None, None, "This property returns the point data of the dataset.")
CellData = property(GetCellData, None, None, "This property returns the cell data of a dataset.")
class PointSet(DataSet):
"""This is a python friendly wrapper of a vtkPointSet that defines
a few useful properties."""
def GetPoints(self):
"""Returns the points as a VTKArray instance. Returns None if the
dataset has implicit points."""
if not self.VTKObject.GetPoints():
return None
return vtkDataArrayToVTKArray(
self.VTKObject.GetPoints().GetData(), self)
def SetPoints(self, pts):
"""Given a VTKArray instance, sets the points of the dataset."""
from vtk.vtkCommonCore import vtkPoints
pts = numpyTovtkDataArray(pts)
p = vtkPoints()
p.SetData(pts)
self.VTKObject.SetPoints(p)
Points = property(GetPoints, SetPoints, None, "This property returns the point coordinates of dataset.")
class PolyData(PointSet):
"""This is a python friendly wrapper of a vtkPolyData that defines
a few useful properties."""
def GetPolygons(self):
"""Returns the polys as a VTKArray instance."""
if not self.VTKObject.GetPolys():
return None
return vtkDataArrayToVTKArray(
self.VTKObject.GetPolys().GetData(), self)
Polygons = property(GetPolygons, None, None, "This property returns the connectivity of polygons.")
class UnstructuredGrid(PointSet):
"""This is a python friendly wrapper of a vtkUnstructuredGrid that defines
a few useful properties."""
def GetCellTypes(self):
"""Returns the cell types as a VTKArray instance."""
if not self.VTKObject.GetCellTypesArray():
return None
return vtkDataArrayToVTKArray(
self.VTKObject.GetCellTypesArray(), self)
def GetCellLocations(self):
"""Returns the cell locations as a VTKArray instance."""
if not self.VTKObject.GetCellLocationsArray():
return None
return vtkDataArrayToVTKArray(
self.VTKObject.GetCellLocationsArray(), self)
def GetCells(self):
"""Returns the cells as a VTKArray instance."""
if not self.VTKObject.GetCells():
return None
return vtkDataArrayToVTKArray(
self.VTKObject.GetCells().GetData(), self)
def SetCells(self, cellTypes, cellLocations, cells):
"""Given cellTypes, cellLocations, cells as VTKArrays,
populates the unstructured grid data structures."""
from vtk import VTK_ID_TYPE
from vtk.vtkCommonDataModel import vtkCellArray
cellTypes = numpyTovtkDataArray(cellTypes)
cellLocations = numpyTovtkDataArray(cellLocations, array_type=VTK_ID_TYPE)
cells = numpyTovtkDataArray(cells, array_type=VTK_ID_TYPE)
ca = vtkCellArray()
ca.SetCells(cellTypes.GetNumberOfTuples(), cells)
self.VTKObject.SetCells(cellTypes, cellLocations, ca)
CellTypes = property(GetCellTypes, None, None, "This property returns the types of cells.")
CellLocations = property(GetCellLocations, None, None, "This property returns the locations of cells.")
Cells = property(GetCells, None, None, "This property returns the connectivity of cells.")
def WrapDataObject(ds):
"""Returns a Numpy friendly wrapper of a vtkDataObject."""
if ds.IsA("vtkPolyData"):
return PolyData(ds)
elif ds.IsA("vtkUnstructuredGrid"):
return UnstructuredGrid(ds)
elif ds.IsA("vtkPointSet"):
return PointSet(ds)
elif ds.IsA("vtkDataSet"):
return DataSet(ds)
elif ds.IsA("vtkCompositeDataSet"):
return CompositeDataSet(ds)
elif ds.IsA("vtkTable"):
return Table(ds)
|