Professional Documents
Culture Documents
FreeMat-4 2 (Manual)
FreeMat-4 2 (Manual)
Contents
FreeMat Documentation
2.1
. . . . . . . . . . . . . . . . . . . . . . .
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.2.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.3.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.3.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.4.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.5.1
USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.5.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.6.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.6.2
Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10
2.6.3
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10
10
2.7.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10
2.7.2
Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11
2.7.3
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11
11
2.8.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11
2.8.2
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11
12
2.9.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12
2.9.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12
13
2.10.1 USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13
2.1.1
2.2
2.3
2.4
2.5
2.6
2.7
2.8
2.9
ii
CONTENTS
2.10.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13
13
2.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13
2.11.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14
15
2.12.1 USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15
2.12.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15
17
2.13.1 USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17
2.13.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18
2.14.1 USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18
2.14.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18
19
2.15.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19
2.15.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20
2.16.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
21
21
2.17.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
21
21
2.18.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
21
2.18.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
21
. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
21
2.19.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22
2.19.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22
22
2.20.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22
2.20.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22
23
2.21.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
24
2.21.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
24
24
2.22.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
25
2.22.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
25
26
2.23.1 USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26
2.23.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26
27
2.24.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
27
CONTENTS
iii
2.24.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
28
28
2.25.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
29
29
2.26.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
29
2.26.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
29
30
2.27.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
30
2.27.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
30
31
2.28.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
31
2.28.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
31
2.28.3 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
32
33
2.29.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
33
2.29.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
33
33
2.30.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
34
2.30.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
34
34
2.31.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
34
2.31.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
34
35
2.32.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
35
2.32.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
36
36
2.33.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
36
37
2.34.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
37
2.34.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
37
38
2.35.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
38
2.35.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
39
39
2.36.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
40
2.36.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
40
40
2.37.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
40
40
2.38.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
41
iv
CONTENTS
2.39 TRANSPOSE Matrix Transpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
41
2.39.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
41
2.39.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
41
41
2.40.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
41
42
2.41.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
42
42
2.42.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
42
2.42.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
42
45
2.43.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
45
45
2.44.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
45
2.44.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
45
Bitwise Operations
47
3.1
47
3.1.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
47
3.1.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
47
47
3.2.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
48
3.2.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
48
48
3.3.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
48
3.3.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
48
48
3.4.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
49
3.4.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
49
3.2
3.3
3.4
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
51
4.1
52
4.1.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
52
52
4.2.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
52
52
4.3.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
52
53
4.4.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
53
53
4.5.1
53
4.2
4.3
4.4
4.5
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONTENTS
4.6
54
4.6.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
54
54
4.7.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
54
54
4.8.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
54
54
4.9.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
55
55
4.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
55
55
4.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
55
55
4.12.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
55
56
4.13.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
56
56
4.14.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
56
56
4.15.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
56
56
4.16.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
57
57
4.17.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
57
57
4.18.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
57
57
4.19.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
57
58
4.20.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
58
58
4.21.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
58
58
4.22.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
58
58
4.23.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
58
59
4.24.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
59
59
4.25.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
59
4.7
4.8
4.9
vi
CONTENTS
4.26 SUBSINDEX Overloaded Class Indexing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
59
4.26.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
60
60
4.27.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
60
60
4.28.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
60
61
4.29.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
61
4.30.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
61
4.31.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
61
4.32.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
62
Base Constants
63
5.1
63
5.1.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
63
5.1.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
63
64
5.2.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
64
5.2.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
64
64
5.3.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
64
64
5.4.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
65
5.4.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
65
65
5.5.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
65
5.5.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
65
66
5.6.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
66
5.6.2
Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
67
5.6.3
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
67
PI Constant Pi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
67
5.7.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
68
5.7.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
68
68
5.8.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
68
5.8.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
68
5.2
5.3
5.4
5.5
5.6
5.7
5.8
CONTENTS
5.9
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
68
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
69
71
6.1
71
6.1.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
71
72
6.2.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
72
6.2.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
72
73
6.3.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
73
74
6.4.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
74
6.4.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
74
76
6.5.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
76
6.5.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
77
77
6.6.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
77
6.6.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
77
78
6.7.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
78
6.7.2
Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
78
6.7.3
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
78
81
6.8.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
81
6.8.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
82
82
6.9.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
82
6.9.2
Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
82
6.9.3
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
82
84
6.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
84
6.10.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
84
6.10.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
84
6.2
6.3
6.4
6.5
6.6
6.7
6.8
6.9
vii
85
7.1
85
7.1.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
85
86
7.2.1
86
7.2
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
viii
CONTENTS
7.3
7.4
86
7.3.1
86
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
86
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
86
86
7.5.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
86
DBSTOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
87
7.6.1
87
7.4.1
7.5
7.6
7.7
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
87
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
87
87
7.8.1
87
7.7.1
7.8
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Elementary Functions
89
8.1
90
8.1.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
90
8.1.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
90
90
8.2.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
90
8.2.2
Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
91
8.2.3
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
91
91
8.3.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
91
8.3.2
Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
92
8.3.3
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
92
92
8.4.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
92
8.4.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
93
8.2
8.3
8.4
8.5
8.6
8.7
8.8
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
93
8.5.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
93
8.5.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
93
94
8.6.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
94
8.6.2
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
94
95
8.7.1
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
95
8.7.2
Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
95
8.7.3
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
96
. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
96
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
96
CONTENTS
8.9
ix
8.8.2
Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
97
8.8.3
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
97
98
8.9.1
98
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . .
98
8.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
98
8.10.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
98
98
8.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
99
99
8.12.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
99
99
8.13.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
99
8.13.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
99
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
CONTENTS
8.22 PROD Product Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
8.22.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
8.22.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
8.23 REAL Real Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
8.23.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
8.23.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
8.24 ROUND Round Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
8.24.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
8.24.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
8.25 STD Standard Deviation Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
8.25.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
8.25.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
8.26 SUB2IND Convert Multiple Indexing To Linear Indexing . . . . . . . . . . . . . . . . . . . . . . . 111
8.26.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
8.26.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
8.27 SUM Sum Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
8.27.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
8.27.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
8.27.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
8.28 TEST Test Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
8.28.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
8.29 VAR Variance Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
8.29.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
8.29.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
8.29.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
8.30 VEC Reshape to a Vector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
8.30.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
8.30.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
9.2
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
9.5
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
9.4
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
9.3
115
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
. . . . . . . . . . . . . . . . . . . . . . . . . . 117
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
9.6
9.7
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
9.9
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
9.8
xi
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
. . . . . . . . . . . . . . . . . . . . . . . . 118
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
123
xii
CONTENTS
10.8.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
10.9 RETURN Return From Function
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
135
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
xiii
xiv
CONTENTS
11.30QUIT Quit Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
11.30.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
11.31REHASH Rehash Directory Caches
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
153
157
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
13.1 ANONYMOUS Anonymous Functions
xv
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
169
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
xvi
CONTENTS
14.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
14.4 GLLINES Create a GL Lineset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
14.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
14.5 GLNODE Create a GL Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
14.5.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
15 Handle-Based Graphics
171
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
CONTENTS
xvii
xviii
CONTENTS
CONTENTS
xix
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
xx
CONTENTS
15.65.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
15.66TITLE Plot Title Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
15.66.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
15.66.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
15.67TUBEPLOT Creates a Tubeplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
15.67.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
15.67.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
15.68UICONTROL Create a UI Control object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
15.68.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
15.69UICONTROLPROPERTIES UI Control Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 263
15.69.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
15.70VIEW Set Graphical View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
15.70.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
15.70.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
15.71WINLEV Image Window-Level Function
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
CONTENTS
xxi
16 Inspection Functions
291
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
xxii
CONTENTS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
CONTENTS
xxiii
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
. . . . . . . . . . . . . . . . . 312
313
315
. . . . . . . . . . . . . . . . . . . . . . . 317
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
xxiv
CONTENTS
18.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
CONTENTS
xxv
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
. . . . . . . . . . . . . . . . . . . . . . . . 340
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
xxvi
CONTENTS
18.33.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
18.33.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
345
CONTENTS
xxvii
. . . . . . . . . . . . . . . . . . . . . . . . . . 366
xxviii
CONTENTS
19.18.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
19.18.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
CONTENTS
xxix
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
xxx
CONTENTS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
CONTENTS
xxxi
421
425
. . . . . . . . . . . . . . . . . . . . . . . 428
xxxii
CONTENTS
21.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
21.3.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
21.3.3 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
. . . . . . . . . . . . . . . . . . . . . . . . . . 433
. . . . . . . . . . . . . . . . . . . . . . . . 435
CONTENTS
xxxiii
447
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
xxxiv
CONTENTS
22.11.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
457
CONTENTS
xxxv
473
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
xxxvi
CONTENTS
475
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
485
. . . . . . . . . . . . . . . . . . . . . . 486
. . . . . . . . . . . . . . . . . . . . . . . . . . . 486
CONTENTS
xxxvii
. . . . . . . . . . . . . . . . . . . . . . . . . . 489
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
497
xxxviii
CONTENTS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
. . . . . . . . . . . . . . . . . . . . . . . 503
505
CONTENTS
xxxix
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
521
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
xl
CONTENTS
29.9.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
29.9.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
29.10INT16 Convert to Signed 16-bit Integer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
29.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
29.10.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
29.11INT2BIN Convert Integer Arrays to Binary
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
541
CONTENTS
xli
551
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
xlii
CONTENTS
31.6.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
31.6.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
31.7 vtkArrayIterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
31.7.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
31.7.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
31.8 vtkAssemblyNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
31.8.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
31.8.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
31.9 vtkAssemblyPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
31.9.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
31.9.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
31.10vtkAssemblyPaths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
31.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
31.10.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
31.11vtkBitArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
31.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
31.11.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
31.12vtkBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
31.12.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
31.12.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
31.13vtkBoxMuellerRandomSequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
31.13.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
31.13.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
31.14vtkByteSwap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
31.14.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
31.14.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
31.15vtkCharArray
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
CONTENTS
xliii
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
xliv
CONTENTS
31.33vtkFastNumericConversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
31.33.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
31.33.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
31.34vtkFileOutputWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
31.34.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
31.34.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
31.35vtkFloatArray
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
CONTENTS
xlv
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
xlvi
CONTENTS
31.59.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
31.60vtkInformationKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
31.60.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
31.60.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
31.61vtkInformationKeyVectorKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
31.61.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
31.61.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
31.62vtkInformationObjectBaseKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
31.62.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
31.62.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
31.63vtkInformationObjectBaseVectorKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
31.63.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
31.63.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
31.64vtkInformationQuadratureSchemeDefinitionVectorKey . . . . . . . . . . . . . . . . . . . . . . . . 626
31.64.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
31.64.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
31.65vtkInformationRequestKey
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
CONTENTS
xlvii
31.73vtkLinearTransform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
31.73.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
31.73.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
31.74vtkLogLookupTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
31.74.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
31.74.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
31.75vtkLongArray
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
xlviii
CONTENTS
31.86.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
31.86.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
31.87vtkObject
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
CONTENTS
xlix
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
31.100.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
31.100.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
31.101
vtkParametricFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
31.101.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
31.101.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
31.102
vtkParametricKlein
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
31.102.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
31.102.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
31.103
vtkParametricMobius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
31.103.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
31.103.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
31.104
vtkParametricRandomHills . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
31.104.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
31.104.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
31.105
vtkParametricRoman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
31.105.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
31.105.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
31.106
vtkParametricSuperEllipsoid
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
31.106.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
31.106.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
31.107
vtkParametricSuperToroid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
31.107.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
31.107.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
31.108
vtkParametricTorus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
31.108.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
31.108.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
31.109
vtkPerspectiveTransform
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
31.109.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
31.109.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
31.110
vtkPlane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
31.110.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
31.110.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
31.111
vtkPlaneCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
31.111.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
31.111.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
31.112
vtkPlanes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
31.112.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
31.112.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
31.113
vtkPoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
31.113.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
31.113.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
31.114
vtkPoints2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
31.114.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
31.114.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
31.115
vtkPolynomialSolversUnivariate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
31.115.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
31.115.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
31.116
vtkPriorityQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
31.116.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
31.116.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
31.117
vtkProp
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
31.117.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
31.117.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
31.118
vtkPropCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
31.118.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
31.118.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
31.119
vtkProperty2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
31.119.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
31.119.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
31.120
vtkQuadratureSchemeDefinition
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
31.120.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
31.120.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
31.121
vtkQuadric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
31.121.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
31.121.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
31.122
vtkRandomSequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
31.122.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
31.122.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
31.123
vtkReferenceCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
31.123.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
31.123.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
31.124
vtkRungeKutta2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
31.124.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
31.124.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
31.125
vtkRungeKutta4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
31.125.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
31.125.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
31.126
vtkRungeKutta45 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
li
31.126.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
31.126.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
31.127
vtkScalarsToColors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
31.127.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
31.127.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
31.128
vtkServerSocket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
31.128.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
31.128.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
31.129
vtkShortArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
31.129.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
31.129.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
31.130
vtkSignedCharArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
31.130.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
31.130.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
31.131
vtkSocket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
31.131.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
31.131.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
31.132
vtkSocketCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
31.132.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
31.132.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
31.133
vtkSphericalTransform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
31.133.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
31.133.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
31.134
vtkStringArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
31.134.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
31.134.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
31.135
vtkStructuredData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
31.135.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
31.135.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
31.136
vtkStructuredVisibilityConstraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
31.136.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
31.136.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
31.137
vtkTableExtentTranslator
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
31.137.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
31.137.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
31.138
vtkTensor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
31.138.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
31.138.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
31.139
vtkThreadMessager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
31.139.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
lii
CONTENTS
31.139.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
31.140
vtkTimePointUtility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
31.140.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
31.140.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
31.141
vtkTimerLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
31.141.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
31.141.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
31.142
vtkTransform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
31.142.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
31.142.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
31.143
vtkTransform2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
31.143.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
31.143.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
31.144
vtkTransformCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
31.144.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
31.144.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
31.145
vtkTypeFloat32Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
31.145.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
31.145.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
31.146
vtkTypeFloat64Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
31.146.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
31.146.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
31.147
vtkTypeInt16Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
31.147.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
31.147.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
31.148
vtkTypeInt32Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
31.148.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
31.148.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
31.149
vtkTypeInt64Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
31.149.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
31.149.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
31.150
vtkTypeInt8Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
31.150.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
31.150.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
31.151
vtkTypeUInt16Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
31.151.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
31.151.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
31.152
vtkTypeUInt32Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
31.152.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
31.152.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
liii
31.153
vtkTypeUInt64Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
31.153.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
31.153.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
31.154
vtkTypeUInt8Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
31.154.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
31.154.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
31.155
vtkUnicodeStringArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
31.155.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
31.155.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
31.156
vtkUnsignedCharArray
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
31.156.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
31.156.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
31.157
vtkUnsignedIntArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
31.157.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
31.157.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
31.158
vtkUnsignedLongArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
31.158.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
31.158.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
31.159
vtkUnsignedLongLongArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
31.159.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
31.159.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
31.160
vtkUnsignedShortArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
31.160.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
31.160.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
31.161
vtkVariantArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
31.161.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
31.161.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
31.162
vtkVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
31.162.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
31.162.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
31.163
vtkVoidArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
31.163.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
31.163.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
31.164
vtkWarpTransform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
31.164.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
31.164.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
31.165
vtkWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
31.165.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
31.165.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
31.166
vtkWindowLevelLookupTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
liv
CONTENTS
31.166.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
31.166.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
31.167
vtkXMLDataElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
31.167.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
31.167.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
31.168
vtkXMLFileOutputWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
31.168.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
31.168.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
735
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
CONTENTS
lv
32.11vtkAnnotationLayers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
32.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
32.11.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
32.12vtkAnnotationLayersAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
32.12.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
32.12.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
32.13vtkArrayData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
32.13.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
32.13.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
32.14vtkArrayDataAlgorithm
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
lvi
CONTENTS
32.24.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
32.24.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
32.25vtkCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
32.25.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
32.25.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
32.26vtkCell3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
32.26.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
32.26.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
32.27vtkCellArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
32.27.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
32.27.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
32.28vtkCellData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
32.28.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
32.28.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
32.29vtkCellLinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
32.29.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
32.29.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
32.30vtkCellLocator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
32.30.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
32.30.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
32.31vtkCellLocatorInterpolatedVelocityField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
32.31.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
32.31.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
32.32vtkCellTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
32.32.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
32.32.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
32.33vtkColorTransferFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781
32.33.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781
32.33.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781
32.34vtkCompositeDataIterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
32.34.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
32.34.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
32.35vtkCompositeDataPipeline
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
CONTENTS
lvii
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
lviii
CONTENTS
32.51vtkDataSetCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
32.51.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
32.51.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
32.52vtkDataSetSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
32.52.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
32.52.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
32.53vtkDataSetToDataSetFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
32.53.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
32.53.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
32.54vtkDataSetToImageFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
32.54.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
32.54.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
32.55vtkDataSetToPolyDataFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
32.55.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
32.55.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
32.56vtkDataSetToStructuredGridFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
32.56.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
32.56.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
32.57vtkDataSetToStructuredPointsFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
32.57.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
32.57.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
32.58vtkDataSetToUnstructuredGridFilter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
CONTENTS
lix
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
lx
CONTENTS
32.77.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
32.78vtkGenericDataSetAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
32.78.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
32.78.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
32.79vtkGenericEdgeTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
32.79.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
32.79.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
32.80vtkGenericInterpolatedVelocityField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
32.80.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
32.80.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
32.81vtkGenericPointIterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
32.81.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
32.81.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
32.82vtkGenericSubdivisionErrorMetric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
32.82.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
32.82.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
32.83vtkGeometricErrorMetric
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 867
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
CONTENTS
lxi
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
32.100.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
32.100.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
32.101
vtkImageSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
32.101.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
32.101.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
32.102
vtkImageToImageFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
32.102.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
32.102.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
32.103
vtkImageToStructuredPoints
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
32.103.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
32.103.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
32.104
vtkImageTwoInputFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
32.104.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
lxii
CONTENTS
32.104.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
32.105
vtkImplicitBoolean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
32.105.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
32.105.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
32.106
vtkImplicitDataSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894
32.106.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894
32.106.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894
32.107
vtkImplicitHalo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
32.107.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
32.107.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
32.108
vtkImplicitSelectionLoop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
32.108.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
32.108.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
32.109
vtkImplicitSum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
32.109.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
32.109.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
32.110
vtkImplicitVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
32.110.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
32.110.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
32.111
vtkImplicitWindowFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
32.111.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
32.111.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
32.112
vtkIncrementalOctreeNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
32.112.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
32.112.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
32.113
vtkIncrementalOctreePointLocator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
32.113.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
32.113.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
32.114
vtkIncrementalPointLocator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
32.114.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
32.114.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
32.115
vtkInEdgeIterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
32.115.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
32.115.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
32.116
vtkInformationExecutivePortKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
32.116.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
32.116.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
32.117
vtkInformationExecutivePortVectorKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
32.117.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
32.117.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
lxiii
32.118
vtkInterpolatedVelocityField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
32.118.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
32.118.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
32.119
vtkKdNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
32.119.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
32.119.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
32.120
vtkKdTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
32.120.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
32.120.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
32.121
vtkKdTreePointLocator
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
32.121.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
32.121.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
32.122
vtkKochanekSpline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
32.122.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
32.122.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
32.123
vtkLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
32.123.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
32.123.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
32.124
vtkLocator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
32.124.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
32.124.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
32.125
vtkMapper2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
32.125.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
32.125.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
32.126
vtkMergePoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
32.126.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
32.126.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
32.127
vtkModifiedBSPTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
32.127.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
32.127.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
32.128
vtkMultiBlockDataSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
32.128.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
32.128.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
32.129
vtkMultiBlockDataSetAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
32.129.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
32.129.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
32.130
vtkMultiPieceDataSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
32.130.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
32.130.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
32.131
vtkMutableDirectedGraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
lxiv
CONTENTS
32.131.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
32.131.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
32.132
vtkMutableUndirectedGraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
32.132.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
32.132.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
32.133
vtkNonLinearCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
32.133.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
32.133.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
32.134
vtkNonMergingPointLocator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
32.134.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
32.134.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
32.135
vtkOctreePointLocator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
32.135.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
32.135.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
32.136
vtkOctreePointLocatorNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
32.136.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
32.136.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
32.137
vtkOrderedTriangulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
32.137.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
32.137.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
32.138
vtkOutEdgeIterator
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
32.138.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
32.138.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
32.139
vtkParametricSpline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
32.139.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
32.139.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
32.140
vtkPassInputTypeAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
32.140.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
32.140.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
32.141
vtkPentagonalPrism . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
32.141.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
32.141.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
32.142
vtkPerlinNoise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
32.142.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
32.142.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
32.143
vtkPiecewiseFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
32.143.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
32.143.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
32.144
vtkPiecewiseFunctionAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
32.144.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
lxv
32.144.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
32.145
vtkPiecewiseFunctionShiftScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
32.145.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
32.145.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
32.146
vtkPixel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
32.146.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
32.146.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
32.147
vtkPlanesIntersection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
32.147.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
32.147.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
32.148
vtkPointData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
32.148.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
32.148.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
32.149
vtkPointLocator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
32.149.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
32.149.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
32.150
vtkPointSet
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
32.150.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
32.150.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
32.151
vtkPointSetAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
32.151.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
32.151.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
32.152
vtkPointSetSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
32.152.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
32.152.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
32.153
vtkPointSetToPointSetFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
32.153.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
32.153.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
32.154
vtkPointsProjectedHull
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
32.154.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
32.154.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
32.155
vtkPolyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
32.155.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
32.155.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
32.156
vtkPolyDataAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
32.156.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
32.156.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
32.157
vtkPolyDataCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
32.157.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
32.157.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
lxvi
CONTENTS
32.158
vtkPolyDataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
32.158.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
32.158.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
32.159
vtkPolyDataToPolyDataFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
32.159.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
32.159.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
32.160
vtkPolygon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
32.160.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966
32.160.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966
32.161
vtkPolyLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
32.161.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
32.161.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
32.162
vtkPolyVertex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
32.162.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
32.162.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
32.163
vtkProcessObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
32.163.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
32.163.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
32.164
vtkPropAssembly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
32.164.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
32.164.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
32.165
vtkPyramid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
32.165.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 972
32.165.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 972
32.166
vtkQuad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 972
32.166.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 973
32.166.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 973
32.167
vtkQuadraticEdge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
32.167.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
32.167.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
32.168
vtkQuadraticHexahedron . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 975
32.168.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 975
32.168.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 975
32.169
vtkQuadraticLinearQuad
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976
32.169.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976
32.169.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976
32.170
vtkQuadraticLinearWedge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 977
32.170.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 977
32.170.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
32.171
vtkQuadraticPyramid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
lxvii
32.171.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
32.171.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
32.172
vtkQuadraticQuad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
32.172.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
32.172.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
32.173
vtkQuadraticTetra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
32.173.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
32.173.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
32.174
vtkQuadraticTriangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
32.174.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
32.174.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
32.175
vtkQuadraticWedge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
32.175.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
32.175.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
32.176
vtkRectilinearGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
32.176.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
32.176.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
32.177
vtkRectilinearGridAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
32.177.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
32.177.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
32.178
vtkRectilinearGridSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
32.178.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
32.178.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
32.179
vtkRectilinearGridToPolyDataFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
32.179.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
32.179.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
32.180
vtkScalarTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
32.180.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
32.180.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
32.181
vtkSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990
32.181.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990
32.181.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990
32.182
vtkSelectionAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
32.182.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
32.182.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
32.183
vtkSelectionNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
32.183.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
32.183.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
32.184
vtkSimpleCellTessellator
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
32.184.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
lxviii
CONTENTS
32.184.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
32.185
vtkSimpleImageToImageFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
32.185.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
32.185.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
32.186
vtkSimpleScalarTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
32.186.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
32.186.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
32.187
vtkSmoothErrorMetric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 997
32.187.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 997
32.187.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 997
32.188
vtkSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 998
32.188.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 998
32.188.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 998
32.189
vtkSphere . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999
32.189.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1000
32.189.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1000
32.190
vtkSpline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1000
32.190.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1000
32.190.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1001
32.191
vtkStreamingDemandDrivenPipeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1003
32.191.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1003
32.191.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1003
32.192
vtkStructuredGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1006
32.192.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1006
32.192.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1007
32.193
vtkStructuredGridAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1009
32.193.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1009
32.193.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1009
32.194
vtkStructuredGridSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1010
32.194.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1010
32.194.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1010
32.195
vtkStructuredGridToPolyDataFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1010
32.195.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1010
32.195.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1011
32.196
vtkStructuredGridToStructuredGridFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1011
32.196.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1011
32.196.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1011
32.197
vtkStructuredPoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1011
32.197.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1012
32.197.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1012
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
lxix
32.198
vtkStructuredPointsCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1012
32.198.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1012
32.198.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1012
32.199
vtkStructuredPointsSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
32.199.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
32.199.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
32.200
vtkStructuredPointsToPolyDataFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
32.200.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
32.200.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
32.201
vtkStructuredPointsToStructuredPointsFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
32.201.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
32.201.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
32.202
vtkStructuredPointsToUnstructuredGridFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
32.202.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
32.202.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1015
32.203
vtkSuperquadric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1015
32.203.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1015
32.203.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1015
32.204
vtkTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1016
32.204.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1017
32.204.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1017
32.205
vtkTableAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1018
32.205.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1018
32.205.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1018
32.206
vtkTemporalDataSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1019
32.206.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1019
32.206.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1019
32.207
vtkTemporalDataSetAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1020
32.207.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1020
32.207.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1020
32.208
vtkTetra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
32.208.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
32.208.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
32.209
vtkThreadedImageAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1022
32.209.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1022
32.209.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1022
32.210
vtkTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1022
32.210.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1023
32.210.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1023
32.211
vtkTreeAlgorithm
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1023
lxx
CONTENTS
32.211.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1024
32.211.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1024
32.212
vtkTreeDFSIterator
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1024
32.212.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1024
32.212.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1025
32.213
vtkTriangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1025
32.213.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1025
32.213.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1026
32.214
vtkTriangleStrip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1026
32.214.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
32.214.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
32.215
vtkTriQuadraticHexahedron . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1028
32.215.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1028
32.215.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1028
32.216
vtkTrivialProducer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029
32.216.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029
32.216.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029
32.217
vtkUndirectedGraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1030
32.217.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1030
32.217.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1030
32.218
vtkUndirectedGraphAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1030
32.218.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031
32.218.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031
32.219
vtkUniformGrid
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031
32.219.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1032
32.219.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1032
32.220
vtkUnstructuredGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1033
32.220.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1033
32.220.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1033
32.221
vtkUnstructuredGridAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
32.221.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
32.221.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
32.222
vtkUnstructuredGridSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1036
32.222.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1036
32.222.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1036
32.223
vtkUnstructuredGridToPolyDataFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1036
32.223.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1037
32.223.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1037
32.224
vtkUnstructuredGridToUnstructuredGridFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1037
32.224.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1037
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
lxxi
32.224.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1037
32.225
vtkVertex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1038
32.225.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1038
32.225.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1038
32.226
vtkVertexListIterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039
32.226.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039
32.226.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039
32.227
vtkViewDependentErrorMetric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039
32.227.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039
32.227.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1040
32.228
vtkViewport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041
32.228.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041
32.228.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041
32.229
vtkVoxel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1044
32.229.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1044
32.229.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1044
32.230
vtkWedge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1045
32.230.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1045
32.230.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1045
33 Visualization Toolkit Geo Vis Classes
1047
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1052
lxxii
CONTENTS
33.7.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1054
33.7.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1054
33.8 vtkGeoCamera
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1060
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1063
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1066
CONTENTS
lxxiii
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1068
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1071
1079
lxxiv
CONTENTS
34.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1089
34.4.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1089
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1105
CONTENTS
lxxv
lxxvi
CONTENTS
34.31vtkCompositeDataGeometryFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1125
34.31.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1125
34.31.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1125
34.32vtkCompositeDataProbeFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1125
34.32.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1125
34.32.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1126
34.33vtkConeSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1126
34.33.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1127
34.33.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1127
34.34vtkConnectivityFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128
34.34.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128
34.34.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128
34.35vtkContourFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1130
34.35.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1130
34.35.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1130
34.36vtkContourGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1132
34.36.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1132
34.36.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1132
34.37vtkConvertSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1134
34.37.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1134
34.37.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1134
34.38vtkCubeSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1135
34.38.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1135
34.38.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1135
34.39vtkCursor2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1136
34.39.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1136
34.39.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1136
34.40vtkCursor3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1138
34.40.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1138
34.40.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1138
34.41vtkCurvatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1140
34.41.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1140
34.41.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1140
34.42vtkCutter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1141
34.42.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1141
34.42.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1142
34.43vtkCylinderSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1143
34.43.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1144
34.43.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1144
34.44vtkDashedStreamLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1145
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
lxxvii
lxxviii
CONTENTS
34.57.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1169
34.58vtkDicer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1170
34.58.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1170
34.58.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1170
34.59vtkDijkstraGraphGeodesicPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1172
34.59.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1172
34.59.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1172
34.60vtkDijkstraImageGeodesicPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1173
34.60.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1173
34.60.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1173
34.61vtkDiscreteMarchingCubes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1174
34.61.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1174
34.61.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1174
34.62vtkDiskSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1174
34.62.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1175
34.62.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1175
34.63vtkEdgePoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1175
34.63.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1176
34.63.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1176
34.64vtkEdgeSubdivisionCriterion
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1176
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1177
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1182
CONTENTS
lxxix
34.71vtkExtractDataSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1183
34.71.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1183
34.71.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1183
34.72vtkExtractEdges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1183
34.72.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1184
34.72.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1184
34.73vtkExtractGeometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1184
34.73.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1184
34.73.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1184
34.74vtkExtractGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1185
34.74.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1185
34.74.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1186
34.75vtkExtractLevel
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1187
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1192
lxxx
CONTENTS
34.84.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1194
34.84.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1194
34.85vtkExtractSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1194
34.85.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1194
34.85.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1195
34.86vtkExtractSelectionBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1195
34.86.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1195
34.86.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1196
34.87vtkExtractTemporalFieldData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1196
34.87.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1196
34.87.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1196
34.88vtkExtractTensorComponents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1197
34.88.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1197
34.88.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1197
34.89vtkExtractUnstructuredGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1199
34.89.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1200
34.89.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1200
34.90vtkExtractVectorComponents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1201
34.90.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1202
34.90.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1202
34.91vtkFeatureEdges
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1202
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1210
CONTENTS
lxxxi
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1216
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1220
34.102.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1221
34.102.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1221
34.103
vtkGraphToPoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1222
34.103.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1222
34.103.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1222
34.104
vtkGraphToPolyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1222
34.104.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1223
34.104.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1223
34.105
vtkGridSynchronizedTemplates3D
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1223
34.105.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1224
34.105.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1224
34.106
vtkHedgeHog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1225
34.106.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1225
34.106.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1225
34.107
vtkHierarchicalDataExtractDataSets
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226
34.107.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226
34.107.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226
34.108
vtkHierarchicalDataExtractLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226
34.108.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226
34.108.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227
34.109
vtkHierarchicalDataLevelFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227
34.109.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227
34.109.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227
34.110
vtkHierarchicalDataSetGeometryFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227
34.110.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227
34.110.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1228
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
lxxxii
CONTENTS
34.111
vtkHull . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1228
34.111.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1228
34.111.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1228
34.112
vtkHyperOctreeContourFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1230
34.112.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1230
34.112.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1230
34.113
vtkHyperOctreeCutter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231
34.113.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231
34.113.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231
34.114
vtkHyperOctreeDepth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1233
34.114.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1233
34.114.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1233
34.115
vtkHyperOctreeDualGridContourFilter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1233
34.115.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1234
34.115.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1234
34.116
vtkHyperOctreeFractalSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1235
34.116.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1235
34.116.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1235
34.117
vtkHyperOctreeLimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1236
34.117.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1236
34.117.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1237
34.118
vtkHyperOctreeSampleFunction
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1237
34.118.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1237
34.118.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1237
34.119
vtkHyperOctreeSurfaceFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1240
34.119.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1240
34.119.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1240
34.120
vtkHyperOctreeToUniformGridFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1241
34.120.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1241
34.120.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1241
34.121
vtkHyperStreamline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1241
34.121.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1241
34.121.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1242
34.122
vtkIconGlyphFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1245
34.122.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1245
34.122.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1245
34.123
vtkIdFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1246
34.123.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1247
34.123.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1247
34.124
vtkImageDataGeometryFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1247
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
lxxxiii
34.124.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1248
34.124.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1248
34.125
vtkImageMarchingCubes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1249
34.125.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1249
34.125.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1249
34.126
vtkImplicitTextureCoords
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1251
34.126.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1251
34.126.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1251
34.127
vtkInterpolateDataSetAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1252
34.127.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1252
34.127.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1252
34.128
vtkInterpolatingSubdivisionFilter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1252
34.128.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1253
34.128.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1253
34.129
vtkKdTreeSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1253
34.129.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1253
34.129.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1253
34.130
vtkLevelIdScalars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1254
34.130.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255
34.130.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255
34.131
vtkLinearExtrusionFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255
34.131.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255
34.131.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255
34.132
vtkLinearSubdivisionFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1256
34.132.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1256
34.132.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1257
34.133
vtkLineSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1257
34.133.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1257
34.133.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1257
34.134
vtkLinkEdgels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1258
34.134.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1258
34.134.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1258
34.135
vtkLoopSubdivisionFilter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1258
34.135.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
34.135.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
34.136
vtkMarchingContourFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
34.136.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
34.136.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1260
34.137
vtkMarchingCubes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1261
34.137.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1261
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
lxxxiv
CONTENTS
34.137.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1261
34.138
vtkMarchingSquares . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1263
34.138.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1263
34.138.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1263
34.139
vtkMaskFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1264
34.139.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1264
34.139.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1264
34.140
vtkMaskPoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1265
34.140.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1265
34.140.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1266
34.141
vtkMaskPolyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1267
34.141.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1267
34.141.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1267
34.142
vtkMassProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1268
34.142.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1268
34.142.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1268
34.143
vtkMergeCells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1269
34.143.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1269
34.143.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1269
34.144
vtkMergeDataObjectFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1270
34.144.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1270
34.144.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1270
34.145
vtkMergeFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1271
34.145.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1271
34.145.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1271
34.146
vtkMergeFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1272
34.146.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1272
34.146.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1272
34.147
vtkMeshQuality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1273
34.147.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1273
34.147.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1274
34.148
vtkModelMetadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1288
34.148.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1288
34.148.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1289
34.149
vtkMultiBlockDataGroupFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1293
34.149.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1293
34.149.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1293
34.150
vtkMultiBlockMergeFilter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1294
34.150.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1294
34.150.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1294
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
lxxxv
34.151
vtkMultiThreshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1294
34.151.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1295
34.151.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1295
34.152
vtkOBBDicer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1298
34.152.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1298
34.152.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1298
34.153
vtkOBBTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1298
34.153.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1299
34.153.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1299
34.154
vtkOutlineCornerFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1300
34.154.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1300
34.154.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1300
34.155
vtkOutlineCornerSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1300
34.155.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1300
34.155.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1300
34.156
vtkOutlineFilter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1301
34.156.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1301
34.156.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1301
34.157
vtkOutlineSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1301
34.157.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1302
34.157.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1302
34.158
vtkParametricFunctionSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1302
34.158.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1303
34.158.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1303
34.159
vtkPlaneSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1307
34.159.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1307
34.159.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1308
34.160
vtkPlatonicSolidSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1309
34.160.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1309
34.160.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1309
34.161
vtkPointDataToCellData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1309
34.161.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1310
34.161.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1310
34.162
vtkPointSource
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1310
34.162.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1310
34.162.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1311
34.163
vtkPolyDataConnectivityFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1311
34.163.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1312
34.163.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1312
34.164
vtkPolyDataNormals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1313
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
lxxxvi
CONTENTS
34.164.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1313
34.164.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1314
34.165
vtkPolyDataPointSampler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1315
34.165.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1316
34.165.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1316
34.166
vtkPolyDataStreamer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1317
34.166.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1317
34.166.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1317
34.167
vtkProbeFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1318
34.167.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1318
34.167.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1318
34.168
vtkProbeSelectedLocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1319
34.168.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1319
34.168.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1320
34.169
vtkProgrammableAttributeDataFilter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1320
34.169.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1320
34.169.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1320
34.170
vtkProgrammableDataObjectSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1321
34.170.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1321
34.170.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1321
34.171
vtkProgrammableFilter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1321
34.171.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1321
34.171.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1322
34.172
vtkProgrammableGlyphFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1322
34.172.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1322
34.172.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1323
34.173
vtkProgrammableSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1323
34.173.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1323
34.173.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1324
34.174
vtkProjectedTexture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1324
34.174.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1324
34.174.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1325
34.175
vtkQuadraturePointInterpolator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1326
34.175.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1326
34.175.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1326
34.176
vtkQuadraturePointsGenerator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1326
34.176.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1326
34.176.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1326
34.177
vtkQuadratureSchemeDictionaryGenerator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1327
34.177.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1327
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
lxxxvii
34.177.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1327
34.178
vtkQuadricClustering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1327
34.178.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1327
34.178.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1328
34.179
vtkQuadricDecimation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1332
34.179.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1332
34.179.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1332
34.180
vtkQuantizePolyDataPoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1335
34.180.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1335
34.180.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1335
34.181
vtkRandomAttributeGenerator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1335
34.181.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1336
34.181.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1336
34.182
vtkRearrangeFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1340
34.182.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1340
34.182.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1341
34.183
vtkRectangularButtonSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1341
34.183.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1342
34.183.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1342
34.184
vtkRectilinearGridClip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1343
34.184.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1343
34.184.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1344
34.185
vtkRectilinearGridGeometryFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1344
34.185.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1344
34.185.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1345
34.186
vtkRectilinearGridToTetrahedra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1345
34.186.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1345
34.186.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1345
34.187
vtkRectilinearSynchronizedTemplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1346
34.187.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1346
34.187.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1346
34.188
vtkRecursiveDividingCubes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1348
34.188.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1348
34.188.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1348
34.189
vtkReflectionFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1349
34.189.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1349
34.189.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1349
34.190
vtkRegularPolygonSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1350
34.190.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1350
34.190.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1350
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
lxxxviii
CONTENTS
34.191
vtkReverseSense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1351
34.191.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1352
34.191.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1352
34.192
vtkRibbonFilter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1352
34.192.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1352
34.192.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1353
34.193
vtkRotationalExtrusionFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1354
34.193.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1355
34.193.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1355
34.194
vtkRotationFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1356
34.194.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1356
34.194.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1356
34.195
vtkRuledSurfaceFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1357
34.195.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1357
34.195.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1357
34.196
vtkSectorSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1360
34.196.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1360
34.196.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1360
34.197
vtkSelectEnclosedPoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1361
34.197.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1361
34.197.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1361
34.198
vtkSelectPolyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1362
34.198.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1363
34.198.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1363
34.199
vtkShrinkFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1364
34.199.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1365
34.199.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1365
34.200
vtkShrinkPolyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1365
34.200.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1365
34.200.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1365
34.201
vtkSimpleElevationFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
34.201.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
34.201.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
34.202
vtkSliceCubes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
34.202.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1367
34.202.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1367
34.203
vtkSmoothPolyDataFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1367
34.203.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1368
34.203.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1368
34.204
vtkSpatialRepresentationFilter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1370
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
lxxxix
34.204.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1370
34.204.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
34.205
vtkSpherePuzzle
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
34.205.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
34.205.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
34.206
vtkSpherePuzzleArrows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1372
34.206.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1372
34.206.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1372
34.207
vtkSphereSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1373
34.207.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1373
34.207.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1373
34.208
vtkSplineFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1375
34.208.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1375
34.208.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1375
34.209
vtkSplitField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1377
34.209.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1377
34.209.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1377
34.210
vtkStreamer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1378
34.210.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1378
34.210.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1378
34.211
vtkStreamingTessellator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1381
34.211.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1381
34.211.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1382
34.212
vtkStreamLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1384
34.212.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1384
34.212.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1385
34.213
vtkStreamPoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1385
34.213.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1385
34.213.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1385
34.214
vtkStreamTracer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1386
34.214.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1386
34.214.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1387
34.215
vtkStripper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1389
34.215.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1389
34.215.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1389
34.216
vtkStructuredGridClip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1390
34.216.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1391
34.216.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1391
34.217
vtkStructuredGridGeometryFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1391
34.217.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1392
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
xc
CONTENTS
34.217.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1392
34.218
vtkStructuredGridOutlineFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1392
34.218.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1392
34.218.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1392
34.219
vtkStructuredPointsGeometryFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1393
34.219.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1393
34.219.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1393
34.220
vtkSubdivideTetra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1393
34.220.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1393
34.220.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1393
34.221
vtkSubPixelPositionEdgels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1394
34.221.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1394
34.221.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1394
34.222
vtkSuperquadricSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1395
34.222.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1395
34.222.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1395
34.223
vtkSynchronizedTemplates2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1396
34.223.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1396
34.223.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1397
34.224
vtkSynchronizedTemplates3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1397
34.224.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1398
34.224.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1398
34.225
vtkSynchronizedTemplatesCutter3D
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1399
34.225.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1399
34.225.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1400
34.226
vtkTableBasedClipDataSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1400
34.226.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1400
34.226.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1401
34.227
vtkTableToPolyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1403
34.227.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1403
34.227.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1403
34.228
vtkTableToStructuredGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1405
34.228.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1405
34.228.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1405
34.229
vtkTemporalPathLineFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1406
34.229.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1406
34.229.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1406
34.230
vtkTemporalStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1408
34.230.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1408
34.230.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1408
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
xci
34.231
vtkTensorGlyph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1409
34.231.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1409
34.231.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1410
34.232
vtkTessellatedBoxSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1412
34.232.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1412
34.232.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1412
34.233
vtkTessellatorFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1413
34.233.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1413
34.233.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1414
34.234
vtkTextSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1415
34.234.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1415
34.234.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1415
34.235
vtkTexturedSphereSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1416
34.235.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1416
34.235.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1416
34.236
vtkTextureMapToCylinder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1417
34.236.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1417
34.236.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1418
34.237
vtkTextureMapToPlane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1418
34.237.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1419
34.237.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1419
34.238
vtkTextureMapToSphere . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1420
34.238.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1420
34.238.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1420
34.239
vtkThreshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1421
34.239.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1421
34.239.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1421
34.240
vtkThresholdPoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1424
34.240.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1424
34.240.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1424
34.241
vtkThresholdTextureCoords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1424
34.241.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1424
34.241.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1425
34.242
vtkTimeSourceExample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1425
34.242.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1426
34.242.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1426
34.243
vtkTransformCoordinateSystems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1426
34.243.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1427
34.243.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1427
34.244
vtkTransformFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1428
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
xcii
CONTENTS
34.244.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1428
34.244.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1428
34.245
vtkTransformPolyDataFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1428
34.245.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1429
34.245.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1429
34.246
vtkTransformTextureCoords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1429
34.246.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1429
34.246.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1430
34.247
vtkTriangleFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1431
34.247.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1431
34.247.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1431
34.248
vtkTriangularTCoords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1432
34.248.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1432
34.248.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1432
34.249
vtkTubeFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1432
34.249.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1432
34.249.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1432
34.250
vtkUncertaintyTubeFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1435
34.250.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1435
34.250.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1436
34.251
vtkUnstructuredGridGeometryFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1436
34.251.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1436
34.251.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1436
34.252
vtkVectorDot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1438
34.252.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1438
34.252.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1438
34.253
vtkVectorNorm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1439
34.253.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1439
34.253.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1439
34.254
vtkVertexGlyphFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1440
34.254.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1440
34.254.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1440
34.255
vtkVoxelContoursToSurfaceFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1440
34.255.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1440
34.255.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1441
34.256
vtkWarpLens
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1441
34.256.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1441
34.256.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1441
34.257
vtkWarpScalar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1442
34.257.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1443
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
xciii
34.257.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1443
34.258
vtkWarpTo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1444
34.258.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1444
34.258.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1444
34.259
vtkWarpVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1445
34.259.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1445
34.259.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1445
34.260
vtkWindowedSincPolyDataFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1445
34.260.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1445
34.260.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1446
34.261
vtkYoungsMaterialInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1448
34.261.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1448
34.261.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1449
35 Visualization Toolkit Hybrid Classes
1453
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1459
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1468
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1471
xciv
CONTENTS
35.9.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1473
35.9.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1474
35.10vtkCubeAxesActor2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1478
35.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1478
35.10.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1478
35.11vtkDepthSortPolyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1483
35.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1483
35.11.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1483
35.12vtkDSPFilterDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1485
35.12.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1485
35.12.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1485
35.13vtkDSPFilterGroup
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1485
CONTENTS
xcv
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1536
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1539
xcvi
CONTENTS
35.36vtkProcrustesAlignmentFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1544
35.36.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1544
35.36.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1544
35.37vtkProjectedTerrainPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1545
35.37.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1545
35.37.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1546
35.38vtkRenderLargeImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1547
35.38.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1547
35.38.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1547
35.39vtkRIBExporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1548
35.39.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1548
35.39.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1548
35.40vtkRIBLight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550
35.40.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550
35.40.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550
35.41vtkRIBProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550
35.41.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550
35.41.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550
35.42vtkSpiderPlotActor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1551
35.42.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1551
35.42.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1552
35.43vtkStructuredExtent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1554
35.43.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1554
35.43.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1554
35.44vtkTemporalDataSetCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1554
35.44.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1554
35.44.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1554
35.45vtkTemporalInterpolator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1555
35.45.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1555
35.45.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1555
35.46vtkTemporalShiftScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1556
35.46.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1556
35.46.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1556
35.47vtkTemporalSnapToTimeStep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1558
35.47.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1558
35.47.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1558
35.48vtkThinPlateSplineTransform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1558
35.48.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1558
35.48.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1559
35.49vtkTransformToGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1559
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
xcvii
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1561
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1568
1579
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1584
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1591
xcviii
CONTENTS
36.7 vtkImageAnisotropicDiffusion3D
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1593
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1594
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1597
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1601
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1605
CONTENTS
xcix
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1613
CONTENTS
36.33.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1618
36.34vtkImageEuclideanDistance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1619
36.34.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1619
36.34.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1620
36.35vtkImageEuclideanToPolar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1621
36.35.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1621
36.35.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1621
36.36vtkImageExport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1621
36.36.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1622
36.36.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1622
36.37vtkImageExtractComponents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1623
36.37.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1623
36.37.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1623
36.38vtkImageFFT
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1623
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1627
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1630
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1630
CONTENTS
ci
36.47vtkImageHSIToRGB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1632
36.47.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1632
36.47.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1632
36.48vtkImageHSVToRGB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1632
36.48.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1633
36.48.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1633
36.49vtkImageHybridMedian2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1633
36.49.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1633
36.49.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1633
36.50vtkImageIdealHighPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1634
36.50.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1634
36.50.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1634
36.51vtkImageIdealLowPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1635
36.51.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1635
36.51.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1635
36.52vtkImageImport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1636
36.52.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1636
36.52.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1636
36.53vtkImageImportExecutive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1637
36.53.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1638
36.53.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1638
36.54vtkImageIslandRemoval2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1638
36.54.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1638
36.54.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1638
36.55vtkImageIterateFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1639
36.55.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1639
36.55.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1639
36.56vtkImageLaplacian
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1639
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1642
cii
CONTENTS
36.60.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1642
36.60.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1642
36.61vtkImageMagnitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1643
36.61.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1643
36.61.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1643
36.62vtkImageMandelbrotSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1643
36.62.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1643
36.62.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1644
36.63vtkImageMapToColors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1645
36.63.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1645
36.63.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1645
36.64vtkImageMapToRGBA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1646
36.64.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1646
36.64.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1647
36.65vtkImageMapToWindowLevelColors
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1647
CONTENTS
ciii
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1658
civ
CONTENTS
36.87vtkImageShiftScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1671
36.87.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1671
36.87.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1671
36.88vtkImageShrink3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1672
36.88.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1672
36.88.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1672
36.89vtkImageSinusoidSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1673
36.89.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1674
36.89.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1674
36.90vtkImageSkeleton2D
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1674
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1678
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1682
CONTENTS
cv
36.100.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1683
36.100.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1683
36.101
vtkImageVariance3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1683
36.101.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1683
36.101.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1684
36.102
vtkImageWeightedSum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1684
36.102.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1684
36.102.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1684
36.103
vtkImageWrapPad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1685
36.103.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1685
36.103.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1685
36.104
vtkImplicitFunctionToImageStencil
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1685
36.104.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1686
36.104.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1686
36.105
vtkPointLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1687
36.105.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1687
36.105.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1687
36.106
vtkRTAnalyticSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1688
36.106.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1688
36.106.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1688
36.107
vtkSampleFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1689
36.107.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1689
36.107.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1689
36.108
vtkShepardMethod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1691
36.108.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1691
36.108.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1691
36.109
vtkSimpleImageFilterExample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1692
36.109.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1692
36.109.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1693
36.110
vtkSurfaceReconstructionFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1693
36.110.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1693
36.110.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1693
36.111
vtkTriangularTexture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1694
36.111.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1694
36.111.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1694
36.112
vtkVoxelModeller
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1695
36.112.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1695
36.112.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1695
37 Visualization Toolkit Infovis Classes
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1699
cvi
CONTENTS
37.1 vtkAddMembershipArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1702
37.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1702
37.1.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1703
37.2 vtkAdjacencyMatrixToEdgeTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1703
37.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1703
37.2.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1703
37.3 vtkAppendPoints
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1704
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1705
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1712
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1715
CONTENTS
cvii
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1731
cviii
CONTENTS
37.27.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1733
37.28vtkDataObjectToTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1734
37.28.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1734
37.28.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1734
37.29vtkDelimitedTextReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1735
37.29.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1735
37.29.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1735
37.30vtkDescriptiveStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1737
37.30.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1737
37.30.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1738
37.31vtkDotProductSimilarity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1738
37.31.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1738
37.31.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1739
37.32vtkEdgeCenters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1740
37.32.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1740
37.32.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1740
37.33vtkEdgeLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1740
37.33.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1741
37.33.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1741
37.34vtkEdgeLayoutStrategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1741
37.34.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1741
37.34.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1741
37.35vtkExpandSelectedGraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1742
37.35.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1742
37.35.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1742
37.36vtkExtractHistogram2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1743
37.36.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1743
37.36.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1743
37.37vtkExtractSelectedGraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1745
37.37.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1745
37.37.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1745
37.38vtkFast2DLayoutStrategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1746
37.38.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1746
37.38.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1746
37.39vtkFixedWidthTextReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1748
37.39.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1748
37.39.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1748
37.40vtkForceDirectedLayoutStrategy
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1749
CONTENTS
cix
37.41vtkGenerateIndexArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1751
37.41.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1751
37.41.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1752
37.42vtkGeoEdgeStrategy
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1752
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1760
cx
CONTENTS
37.54.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1764
37.54.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1764
37.55vtkMergeGraphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1764
37.55.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1764
37.55.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1765
37.56vtkMergeTables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1765
37.56.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1765
37.56.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1765
37.57vtkMultiCorrelativeStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1766
37.57.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1766
37.57.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1767
37.58vtkMutableGraphHelper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1767
37.58.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1767
37.58.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1767
37.59vtkNetworkHierarchy
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1768
CONTENTS
cxi
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1781
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1782
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1788
cxii
CONTENTS
37.81vtkRemoveHiddenData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1789
37.81.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1789
37.81.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1790
37.82vtkRemoveIsolatedVertices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1790
37.82.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1790
37.82.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1790
37.83vtkRISReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1790
37.83.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1790
37.83.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1791
37.84vtkSCurveSpline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1791
37.84.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1791
37.84.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1791
37.85vtkSimple2DLayoutStrategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1792
37.85.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1792
37.85.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1792
37.86vtkSimple3DCirclesStrategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1794
37.86.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1794
37.86.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1794
37.87vtkSliceAndDiceLayoutStrategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1796
37.87.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1796
37.87.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1796
37.88vtkSpanTreeLayoutStrategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1797
37.88.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1797
37.88.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1797
37.89vtkSparseArrayToTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1798
37.89.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1798
37.89.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1798
37.90vtkSplineGraphEdges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1798
37.90.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1799
37.90.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1799
37.91vtkSplitColumnComponents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1799
37.91.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1799
37.91.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1799
37.92vtkSQLDatabaseGraphSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1800
37.92.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1800
37.92.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1800
37.93vtkSQLDatabaseTableSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1801
37.93.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1801
37.93.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1801
37.94vtkSQLGraphReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1802
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
cxiii
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1804
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1807
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1812
37.104.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1812
37.104.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1813
37.105
vtkTableToSparseArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1813
37.105.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1814
37.105.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1814
37.106
vtkTableToTreeFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1814
37.106.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1814
37.106.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1815
37.107
vtkThresholdTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1815
37.107.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1815
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
cxiv
CONTENTS
37.107.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1815
37.108
vtkTimePointToString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1816
37.108.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1816
37.108.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1816
37.109
vtkTransferAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1816
37.109.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1817
37.109.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1817
37.110
vtkTreeFieldAggregator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1818
37.110.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1818
37.110.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1818
37.111
vtkTreeLayoutStrategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1819
37.111.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1819
37.111.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1819
37.112
vtkTreeLevelsFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1820
37.112.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1820
37.112.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1820
37.113
vtkTreeMapLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1820
37.113.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1821
37.113.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1821
37.114
vtkTreeMapLayoutStrategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1821
37.114.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1822
37.114.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1822
37.115
vtkTreeMapToPolyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1822
37.115.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1822
37.115.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1822
37.116
vtkTreeOrbitLayoutStrategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1823
37.116.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1823
37.116.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1823
37.117
vtkTreeRingToPolyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1824
37.117.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1824
37.117.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1824
37.118
vtkTulipReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1824
37.118.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1825
37.118.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1825
37.119
vtkUnivariateStatisticsAlgorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1825
37.119.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1825
37.119.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1825
37.120
vtkVertexDegree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1826
37.120.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1826
37.120.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1826
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
cxv
37.121
vtkXMLTreeReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1826
37.121.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1827
37.121.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1828
38 Visualization Toolkit IO Classes
1831
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1841
cxvi
CONTENTS
38.12.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1845
38.13vtkChacoReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1847
38.13.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1847
38.13.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1847
38.14vtkDataCompressor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1848
38.14.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1848
38.14.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1849
38.15vtkDataObjectReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1849
38.15.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1849
38.15.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1849
38.16vtkDataObjectWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1850
38.16.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1850
38.16.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1850
38.17vtkDataReader
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1851
CONTENTS
cxvii
38.26vtkEnSightGoldReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1863
38.26.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1863
38.26.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1863
38.27vtkFacetWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1864
38.27.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1864
38.27.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1864
38.28vtkFLUENTReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1864
38.28.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1864
38.28.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1864
38.29vtkGAMBITReader
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1866
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1868
cxviii
CONTENTS
38.39.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1876
38.39.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1876
38.40vtkImageReader2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1877
38.40.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1877
38.40.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1877
38.41vtkImageReader2Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1880
38.41.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1880
38.41.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1880
38.42vtkImageReader2Factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1881
38.42.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1881
38.42.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1881
38.43vtkImageWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1881
38.43.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1881
38.43.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1881
38.44vtkInputStream
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1882
CONTENTS
cxix
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1898
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1903
cxx
CONTENTS
38.66vtkOutputStream
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1914
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1922
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1925
CONTENTS
cxxi
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1934
cxxii
CONTENTS
38.92.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1941
38.93vtkSQLiteDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1942
38.93.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1943
38.93.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1943
38.94vtkSQLiteQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1944
38.94.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1944
38.94.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1944
38.95vtkSQLQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1945
38.95.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1945
38.95.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1946
38.96vtkSTLReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1946
38.96.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1947
38.96.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1947
38.97vtkSTLWriter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1947
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1953
38.105.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1953
38.105.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1953
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
cxxiii
38.106
vtkTIFFWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1954
38.106.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1954
38.106.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1954
38.107
vtkTreeReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1955
38.107.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1955
38.107.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1955
38.108
vtkTreeWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1955
38.108.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1956
38.108.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1956
38.109
vtkUGFacetReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1956
38.109.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1956
38.109.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1956
38.110
vtkUnstructuredGridReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1957
38.110.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1957
38.110.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1957
38.111
vtkUnstructuredGridWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1958
38.111.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1958
38.111.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1958
38.112
vtkVolume16Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1958
38.112.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1958
38.112.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1959
38.113
vtkVolumeReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1960
38.113.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1960
38.113.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1960
38.114
vtkWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1961
38.114.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1961
38.114.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1961
38.115
vtkXMLCompositeDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1962
38.115.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1962
38.115.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1962
38.116
vtkXMLCompositeDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1962
38.116.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1963
38.116.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1963
38.117
vtkXMLDataParser
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1963
38.117.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1963
38.117.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1963
38.118
vtkXMLDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1964
38.118.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1965
38.118.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1965
38.119
vtkXMLDataSetWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1965
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
cxxiv
CONTENTS
38.119.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1965
38.119.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1965
38.120
vtkXMLFileReadTester
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1966
38.120.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1966
38.120.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1966
38.121
vtkXMLHierarchicalBoxDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1966
38.121.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1966
38.121.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1967
38.122
vtkXMLHierarchicalBoxDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1967
38.122.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1967
38.122.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1967
38.123
vtkXMLHierarchicalDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1967
38.123.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1967
38.123.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1968
38.124
vtkXMLHyperOctreeReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1968
38.124.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1968
38.124.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1968
38.125
vtkXMLHyperOctreeWriter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1968
38.125.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1969
38.125.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1969
38.126
vtkXMLImageDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1969
38.126.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1969
38.126.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1969
38.127
vtkXMLImageDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1970
38.127.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1970
38.127.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1970
38.128
vtkXMLMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1970
38.128.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1970
38.128.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1971
38.129
vtkXMLMaterialParser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1971
38.129.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1971
38.129.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1972
38.130
vtkXMLMaterialReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1972
38.130.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1973
38.130.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1973
38.131
vtkXMLMultiBlockDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1973
38.131.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1973
38.131.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1974
38.132
vtkXMLMultiBlockDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1974
38.132.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1974
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
cxxv
38.132.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1974
38.133
vtkXMLMultiGroupDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1974
38.133.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1974
38.133.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1975
38.134
vtkXMLParser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1975
38.134.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1975
38.134.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1975
38.135
vtkXMLPDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1976
38.135.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1976
38.135.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1976
38.136
vtkXMLPDataSetWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1977
38.136.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1977
38.136.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1977
38.137
vtkXMLPDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1977
38.137.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1977
38.137.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1977
38.138
vtkXMLPImageDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1978
38.138.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1978
38.138.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1978
38.139
vtkXMLPImageDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1979
38.139.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1979
38.139.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1979
38.140
vtkXMLPolyDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1979
38.140.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1979
38.140.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1979
38.141
vtkXMLPolyDataWriter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1980
38.141.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1980
38.141.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1980
38.142
vtkXMLPPolyDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1980
38.142.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1981
38.142.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1981
38.143
vtkXMLPPolyDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1981
38.143.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1981
38.143.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1981
38.144
vtkXMLPRectilinearGridReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1982
38.144.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1982
38.144.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1982
38.145
vtkXMLPRectilinearGridWriter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1982
38.145.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1982
38.145.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1982
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
cxxvi
CONTENTS
38.146
vtkXMLPStructuredDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1983
38.146.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1983
38.146.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1983
38.147
vtkXMLPStructuredDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1983
38.147.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1983
38.147.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1984
38.148
vtkXMLPStructuredGridReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1984
38.148.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1984
38.148.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1984
38.149
vtkXMLPStructuredGridWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1984
38.149.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1985
38.149.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1985
38.150
vtkXMLPUnstructuredDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1985
38.150.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1985
38.150.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1985
38.151
vtkXMLPUnstructuredDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1985
38.151.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1986
38.151.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1986
38.152
vtkXMLPUnstructuredGridReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1986
38.152.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1986
38.152.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1986
38.153
vtkXMLPUnstructuredGridWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1987
38.153.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1987
38.153.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1987
38.154
vtkXMLReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1987
38.154.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1987
38.154.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1987
38.155
vtkXMLRectilinearGridReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1988
38.155.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1989
38.155.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1989
38.156
vtkXMLRectilinearGridWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1989
38.156.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1989
38.156.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1989
38.157
vtkXMLShader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1990
38.157.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1990
38.157.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1990
38.158
vtkXMLStructuredDataReader
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1990
38.158.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1991
38.158.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1991
38.159
vtkXMLStructuredDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1991
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
cxxvii
38.159.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1991
38.159.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1992
38.160
vtkXMLStructuredGridReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1992
38.160.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1992
38.160.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1992
38.161
vtkXMLStructuredGridWriter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1993
38.161.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1993
38.161.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1993
38.162
vtkXMLUnstructuredDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1993
38.162.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1993
38.162.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1994
38.163
vtkXMLUnstructuredDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1994
38.163.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1994
38.163.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1994
38.164
vtkXMLUnstructuredGridReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1995
38.164.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1995
38.164.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1995
38.165
vtkXMLUnstructuredGridWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1995
38.165.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1995
38.165.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1996
38.166
vtkXMLUtilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1996
38.166.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1996
38.166.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1996
38.167
vtkXMLWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1996
38.167.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1996
38.167.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1997
38.168
vtkXYZMolReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1999
38.168.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1999
38.168.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1999
38.169
vtkZLibDataCompressor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1999
38.169.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1999
38.169.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1999
39 Visualization Toolkit Parallel Classes
39.1 vtkBranchExtentTranslator
2001
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2003
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2004
cxxviii
CONTENTS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2006
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2007
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2020
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
cxxix
cxxx
CONTENTS
39.29.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2042
39.30vtkPCosmoHaloFinder
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2042
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2043
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2054
CONTENTS
cxxxi
39.43vtkPOutlineCornerFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2054
39.43.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2055
39.43.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2055
39.44vtkPOutlineFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2055
39.44.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2055
39.44.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2055
39.45vtkPPolyDataNormals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2056
39.45.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2056
39.45.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2056
39.46vtkPProbeFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2056
39.46.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2056
39.46.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2057
39.47vtkPReflectionFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2057
39.47.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2057
39.47.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2057
39.48vtkProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2057
39.48.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2058
39.48.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2058
39.49vtkProcessGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2058
39.49.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2058
39.49.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2058
39.50vtkProcessIdScalars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2059
39.50.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2059
39.50.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2060
39.51vtkPSLACReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2060
39.51.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2060
39.51.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2060
39.52vtkPStreamTracer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2061
39.52.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2061
39.52.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2061
39.53vtkPTableToStructuredGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2061
39.53.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2062
39.53.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2062
39.54vtkRectilinearGridOutlineFilter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2062
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2063
cxxxii
CONTENTS
39.56.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2064
39.56.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2064
39.57vtkSubCommunicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2065
39.57.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2065
39.57.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2065
39.58vtkSubGroup
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2066
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2067
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2072
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2074
CONTENTS
cxxxiii
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2077
2079
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2088
cxxxiv
CONTENTS
40.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2103
40.11.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2103
40.12vtkCameraInterpolator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2104
40.12.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2104
40.12.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2104
40.13vtkCameraPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2106
40.13.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2106
40.13.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2106
40.14vtkCellCenterDepthSort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2107
40.14.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2107
40.14.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2107
40.15vtkCellPicker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2107
40.15.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2108
40.15.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2108
40.16vtkChooserPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2110
40.16.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2110
40.16.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2110
40.17vtkClearZPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2111
40.17.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2111
40.17.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2111
40.18vtkCoincidentTopologyResolutionPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2111
40.18.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2112
40.18.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2112
40.19vtkColorMaterialHelper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2112
40.19.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2112
40.19.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2112
40.20vtkCompositePainter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2113
CONTENTS
cxxxv
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2116
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2119
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2126
cxxxvi
CONTENTS
40.38vtkGaussianBlurPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2131
40.38.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2131
40.38.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2131
40.39vtkGenericRenderWindowInteractor
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2131
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2134
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2140
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2140
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2142
CONTENTS
cxxxvii
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2159
cxxxviii
CONTENTS
40.64.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2165
40.65vtkInteractorStyleFlight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2168
40.65.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2168
40.65.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2168
40.66vtkInteractorStyleImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2170
40.66.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2170
40.66.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2171
40.67vtkInteractorStyleJoystickActor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2171
40.67.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2171
40.67.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2172
40.68vtkInteractorStyleJoystickCamera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2172
40.68.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2172
40.68.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2173
40.69vtkInteractorStyleRubberBand2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2173
40.69.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2173
40.69.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2174
40.70vtkInteractorStyleRubberBand3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2174
40.70.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2174
40.70.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2175
40.71vtkInteractorStyleRubberBandPick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2175
40.71.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2175
40.71.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2176
40.72vtkInteractorStyleRubberBandZoom
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2176
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2179
CONTENTS
cxxxix
40.78vtkInteractorStyleUnicam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2181
40.78.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2182
40.78.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2182
40.79vtkInteractorStyleUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2183
40.79.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2183
40.79.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2183
40.80vtkIVExporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2184
40.80.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2184
40.80.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2184
40.81vtkLabeledDataMapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2185
40.81.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2185
40.81.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2185
40.82vtkLabeledTreeMapDataMapper
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2187
cxl
CONTENTS
40.91.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2201
40.91.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2201
40.92vtkLight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2204
40.92.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2204
40.92.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2204
40.93vtkLightActor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2208
40.93.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2208
40.93.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2208
40.94vtkLightCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2209
40.94.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2209
40.94.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2209
40.95vtkLightKit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2210
40.95.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2210
40.95.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2210
40.96vtkLightsPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2214
40.96.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2214
40.96.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2214
40.97vtkLineIntegralConvolution2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2214
40.97.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2215
40.97.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2215
40.98vtkLinesPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2218
40.98.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2218
40.98.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2218
40.99vtkLODActor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2218
40.99.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2218
40.99.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2219
40.100
vtkLODProp3D
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2219
40.100.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2220
40.100.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2220
40.101
vtkMapArrayValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2223
40.101.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2223
40.101.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2223
40.102
vtkMapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2225
40.102.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2225
40.102.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2225
40.103
vtkMapperCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2230
40.103.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2230
40.103.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2230
40.104
vtkOBJExporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2230
40.104.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2230
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
cxli
40.104.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2231
40.105
vtkObserverMediator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2231
40.105.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2231
40.105.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2231
40.106
vtkOOGLExporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2232
40.106.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2232
40.106.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2232
40.107
vtkOpaquePass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2232
40.107.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2232
40.107.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2232
40.108
vtkOpenGLActor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2233
40.108.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2233
40.108.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2233
40.109
vtkOpenGLCamera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2233
40.109.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2233
40.109.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2233
40.110
vtkOpenGLClipPlanesPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2234
40.110.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2234
40.110.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2234
40.111
vtkOpenGLCoincidentTopologyResolutionPainter
. . . . . . . . . . . . . . . . . . . . . . . . . . 2234
40.111.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2234
40.111.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2234
40.112
vtkOpenGLDisplayListPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2235
40.112.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2235
40.112.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2235
40.113
vtkOpenGLExtensionManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2235
40.113.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2235
40.113.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2236
40.114
vtkOpenGLFreeTypeTextMapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2238
40.114.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2238
40.114.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2238
40.115
vtkOpenGLHardwareSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2239
40.115.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2239
40.115.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2239
40.116
vtkOpenGLImageActor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2239
40.116.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2239
40.116.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2240
40.117
vtkOpenGLImageMapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2240
40.117.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2240
40.117.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2240
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
cxlii
CONTENTS
40.118
vtkOpenGLLight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2240
40.118.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2241
40.118.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2241
40.119
vtkOpenGLLightingPainter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2241
40.119.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2241
40.119.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2241
40.120
vtkOpenGLPainterDeviceAdapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2242
40.120.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2242
40.120.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2242
40.121
vtkOpenGLPolyDataMapper
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2243
40.121.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2243
40.121.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2243
40.122
vtkOpenGLPolyDataMapper2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2243
40.122.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2243
40.122.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2243
40.123
vtkOpenGLProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2244
40.123.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2244
40.123.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2244
40.124
vtkOpenGLRenderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2245
40.124.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2245
40.124.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2245
40.125
vtkOpenGLRenderWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2245
40.125.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2246
40.125.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2246
40.126
vtkOpenGLRepresentationPainter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2247
40.126.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2248
40.126.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2248
40.127
vtkOpenGLScalarsToColorsPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2248
40.127.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2248
40.127.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2248
40.128
vtkOpenGLTexture
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2249
40.128.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2249
40.128.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2249
40.129
vtkOverlayPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2249
40.129.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2249
40.129.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2250
40.130
vtkPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2250
40.130.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2250
40.130.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2250
40.131
vtkPainterDeviceAdapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2251
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
cxliii
40.131.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2251
40.131.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2251
40.132
vtkPainterPolyDataMapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2252
40.132.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2253
40.132.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2253
40.133
vtkParallelCoordinatesActor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2254
40.133.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2254
40.133.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2254
40.134
vtkParallelCoordinatesInteractorStyle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2255
40.134.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2255
40.134.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2256
40.135
vtkPicker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2257
40.135.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2257
40.135.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2257
40.136
vtkPixelBufferObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2258
40.136.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2258
40.136.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2258
40.137
vtkPointPicker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2259
40.137.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2259
40.137.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2260
40.138
vtkPointSetToLabelHierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2260
40.138.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2260
40.138.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2260
40.139
vtkPointsPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2261
40.139.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2261
40.139.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2261
40.140
vtkPolyDataMapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2262
40.140.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2262
40.140.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2262
40.141
vtkPolyDataMapper2D
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2263
40.141.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2263
40.141.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2263
40.142
vtkPolyDataPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2266
40.142.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2266
40.142.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2266
40.143
vtkPolygonsPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2267
40.143.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2267
40.143.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2267
40.144
vtkPOVExporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2267
40.144.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2267
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
cxliv
CONTENTS
40.144.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2268
40.145
vtkPrimitivePainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2268
40.145.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2268
40.145.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2268
40.146
vtkProp3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2268
40.146.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2269
40.146.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2269
40.147
vtkProp3DCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2271
40.147.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2271
40.147.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2271
40.148
vtkProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2272
40.148.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2272
40.148.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2272
40.149
vtkPropPicker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2277
40.149.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2278
40.149.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2278
40.150
vtkQImageToImageSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2278
40.150.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2278
40.150.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2278
40.151
vtkQtInitialization
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2279
40.151.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2279
40.151.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2279
40.152
vtkQtLabelRenderStrategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2279
40.152.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2279
40.152.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2279
40.153
vtkQtTreeRingLabelMapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2280
40.153.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2280
40.153.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2280
40.154
vtkQuadricLODActor
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2281
40.154.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2281
40.154.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2281
40.155
vtkQuaternionInterpolator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2285
40.155.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2285
40.155.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2286
40.156
vtkRenderedAreaPicker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2287
40.156.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2287
40.156.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2287
40.157
vtkRenderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2287
40.157.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2287
40.157.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2288
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
cxlv
40.158
vtkRendererCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2295
40.158.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2295
40.158.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2295
40.159
vtkRendererDelegate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2295
40.159.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2295
40.159.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2296
40.160
vtkRendererSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2296
40.160.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2296
40.160.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2296
40.161
vtkRenderPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2297
40.161.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2298
40.161.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2298
40.162
vtkRenderPassCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2298
40.162.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2299
40.162.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2299
40.163
vtkRenderWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2299
40.163.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2299
40.163.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2299
40.164
vtkRenderWindowCollection
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2307
40.164.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2307
40.164.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2307
40.165
vtkRenderWindowInteractor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2308
40.165.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2308
40.165.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2308
40.166
vtkRepresentationPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2317
40.166.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2317
40.166.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2317
40.167
vtkScalarBarActor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2317
40.167.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2317
40.167.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2318
40.168
vtkScalarsToColorsPainter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2320
40.168.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2320
40.168.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2321
40.169
vtkScaledTextActor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2321
40.169.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2321
40.169.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2321
40.170
vtkScenePicker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2322
40.170.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2322
40.170.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2322
40.171
vtkSelectVisiblePoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2323
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
cxlvi
CONTENTS
40.171.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2323
40.171.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2323
40.172
vtkSequencePass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2324
40.172.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2324
40.172.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2324
40.173
vtkShader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2325
40.173.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2325
40.173.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2325
40.174
vtkShaderProgram
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2326
40.174.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2326
40.174.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2327
40.175
vtkShadowMapPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2327
40.175.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2328
40.175.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2328
40.176
vtkSobelGradientMagnitudePass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2329
40.176.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2329
40.176.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2330
40.177
vtkStandardPolyDataPainter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2330
40.177.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2330
40.177.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2330
40.178
vtkSurfaceLICDefaultPainter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2330
40.178.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2331
40.178.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2331
40.179
vtkSurfaceLICPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2331
40.179.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2331
40.179.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2331
40.180
vtkTDxInteractorStyle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2333
40.180.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2333
40.180.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2333
40.181
vtkTDxInteractorStyleCamera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2333
40.181.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2333
40.181.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2333
40.182
vtkTDxInteractorStyleSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2334
40.182.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2334
40.182.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2334
40.183
vtkTesting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2335
40.183.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2336
40.183.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2336
40.184
vtkTextActor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2337
40.184.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2337
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
CONTENTS
cxlvii
40.184.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2338
40.185
vtkTextActor3D
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2340
40.185.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2340
40.185.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2341
40.186
vtkTextMapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2341
40.186.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2341
40.186.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2341
40.187
vtkTextProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2342
40.187.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2342
40.187.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2342
40.188
vtkTexture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2345
40.188.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2345
40.188.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2345
40.189
vtkTexturedActor2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2347
40.189.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2347
40.189.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2347
40.190
vtkTextureObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2348
40.190.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2348
40.190.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2348
40.191
vtkTransformInterpolator
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2354
40.191.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2354
40.191.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2354
40.192
vtkTranslucentPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2356
40.192.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2356
40.192.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2356
40.193
vtkTupleInterpolator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2357
40.193.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2357
40.193.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2357
40.194
vtkUniformVariables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2358
40.194.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2358
40.194.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2359
40.195
vtkViewTheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2360
40.195.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2360
40.195.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2361
40.196
vtkVisibilitySort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2364
40.196.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2364
40.196.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2364
40.197
vtkVisibleCellSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2365
40.197.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2365
40.197.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2366
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
cxlviii
CONTENTS
40.198
vtkVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2367
40.198.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2367
40.198.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2367
40.199
vtkVolumeCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2368
40.199.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2368
40.199.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2368
40.200
vtkVolumeProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2368
40.200.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2369
40.200.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2369
40.201
vtkVolumetricPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2374
40.201.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2374
40.201.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2374
40.202
vtkVRMLExporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2375
40.202.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2375
40.202.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2375
40.203
vtkWindowToImageFilter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2375
40.203.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2375
40.203.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2375
40.204
vtkWorldPointPicker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2377
40.204.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2377
40.204.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2377
40.205
vtkXGPUInfoList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2377
40.205.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2378
40.205.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2378
40.206
vtkXOpenGLRenderWindow
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2378
40.206.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2378
40.206.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2378
40.207
vtkXRenderWindowInteractor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2380
40.207.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2380
40.207.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2380
41 Visualization Toolkit View Classes
2383
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2386
CONTENTS
cxlix
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2387
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2400
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2412
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2413
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2414
cl
CONTENTS
41.17vtkRenderedTreeAreaRepresentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2414
41.17.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2414
41.17.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2414
41.18vtkRenderView
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2418
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2420
2427
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2433
CONTENTS
cli
clii
CONTENTS
42.20vtkProjectedTetrahedraMapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2453
42.20.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2453
42.20.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2454
42.21vtkRayCastImageDisplayHelper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2454
42.21.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2454
42.21.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2454
42.22vtkRecursiveSphereDirectionEncoder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2455
42.22.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2455
42.22.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2455
42.23vtkSphericalDirectionEncoder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2456
42.23.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2456
42.23.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2456
42.24vtkUnstructuredGridBunykRayCastFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2457
42.24.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2457
42.24.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2457
42.25vtkUnstructuredGridHomogeneousRayIntegrator . . . . . . . . . . . . . . . . . . . . . . . . . . . 2458
42.25.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2458
42.25.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2458
42.26vtkUnstructuredGridLinearRayIntegrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2458
42.26.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2458
42.26.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2459
42.27vtkUnstructuredGridPartialPreIntegration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2459
42.27.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2459
42.27.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2459
42.28vtkUnstructuredGridPreIntegration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2460
42.28.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2460
42.28.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2460
42.29vtkUnstructuredGridVolumeMapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2461
42.29.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2461
42.29.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2461
42.30vtkUnstructuredGridVolumeRayCastFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2462
42.30.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2462
42.30.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2462
42.31vtkUnstructuredGridVolumeRayCastIterator
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2462
CONTENTS
cliii
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2482
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2483
cliv
CONTENTS
42.46.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2483
42.47vtkVolumeTextureMapper3D
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2484
2487
CONTENTS
clv
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2531
clvi
CONTENTS
43.25.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2537
43.26vtkCenteredSliderRepresentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2537
43.26.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2538
43.26.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2538
43.27vtkCenteredSliderWidget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2539
43.27.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2539
43.27.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2540
43.28vtkCheckerboardRepresentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2540
43.28.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2540
43.28.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2540
43.29vtkCheckerboardWidget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2542
43.29.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2542
43.29.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2542
43.30vtkClosedSurfacePointPlacer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2543
43.30.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2543
43.30.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2543
43.31vtkConstrainedPointHandleRepresentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2544
43.31.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2544
43.31.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2545
43.32vtkContinuousValueWidget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2547
43.32.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2547
43.32.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2548
43.33vtkContinuousValueWidgetRepresentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2548
43.33.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2548
43.33.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2549
43.34vtkContourLineInterpolator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2549
43.34.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2549
43.34.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2550
43.35vtkContourRepresentation
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2550
CONTENTS
clvii
43.39vtkDistanceRepresentation2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2561
43.39.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2561
43.39.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2561
43.40vtkDistanceWidget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2562
43.40.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2562
43.40.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2562
43.41vtkEllipsoidTensorProbeRepresentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2563
43.41.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2563
43.41.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2563
43.42vtkEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2564
43.42.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2564
43.42.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2564
43.43vtkFocalPlaneContourRepresentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2564
43.43.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2564
43.43.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2565
43.44vtkFocalPlanePointPlacer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2565
43.44.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2565
43.44.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2565
43.45vtkHandleRepresentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2566
43.45.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2566
43.45.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2567
43.46vtkHandleWidget
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2569
clviii
CONTENTS
43.52.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2584
43.52.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2585
43.53vtkImplicitPlaneWidget
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2588
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2593
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2601
CONTENTS
clix
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2621
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2623
clx
CONTENTS
43.79vtkPolygonalSurfacePointPlacer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2628
43.79.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2628
43.79.2 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2628
43.80vtkRectilinearWipeRepresentation
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2629
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2632
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2635
CONTENTS
clxi
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2655
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2663
clxii
CONTENTS
43.105.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2669
43.106
vtkWidgetRepresentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2670
43.106.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2670
43.106.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2670
43.107
vtkWidgetSet
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2676
43.107.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2676
43.107.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2677
43.108
vtkXYPlotWidget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2678
43.108.1Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2678
43.108.2Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2678
Chapter 1
FreeMat Documentation
Documentation Sections
Introduction and Getting Started
Variables and Arrays
Functions and Scripts
Mathematical Operators
Flow Control
FreeMat Functions
Debugging FreeMat Code
Sparse Matrix Support
Mathematical Functions
Base Constants
Elementary Functions
Inspection Functions
Type Conversion Functions
Array Generation and Manipulations
Random Number Generation
Input/Ouput Functions
String Functions
Transforms/Decompositions
Signal Processing Functions
Numerical Methods
Operating System Functions
Optimization and Curve Fitting
Handle-Based Graphics
OpenGL Models
Object Oriented Programming
FreeMat Documentation
Bitwise Operations
FreeMat Threads
Function Related Functions
FreeMat External Interface
Visualization Toolkit Common Classes
Visualization Toolkit Filtering Classes
Visualization Toolkit Geo Vis Classes
Visualization Toolkit Graphics Classes
Visualization Toolkit Hybrid Classes
Visualization Toolkit Imaging Classes
Visualization Toolkit Infovis Classes
Visualization Toolkit IO Classes
Visualization Toolkit Parallel Classes
Visualization Toolkit Rendering Classes
Visualization Toolkit View Classes
Visualization Toolkit Volume Rendering Classes
Visualization Toolkit Widget Classes
Chapter 2
2.1
2.1.1
Usage
The arrayfun function is used to apply a function handle to each element of an input array (or arrays), and to
collect the outputs into an array. The general syntax for its use is
y = arrayfun(fun, x)
where x is an N-dimensional array. In this case, each element of the output y_i is defined as fun(x_i). You
can also supply multiple arguments to arrayfun, provided all of the arguments are the same size
y = arrayfun(fun, x, z,...)
The assumption is that the output types for each call to fun is the same across the inputs.
Finally, some hints can be provided to arrayfun using the syntax
[y1,y2,...] = arrayfun(fun, x, z, ..., param, value, param, value)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
2.2
2.2.1
Usage
FreeMat assignments take a number of different forms, depending on the type of the variable you want to make an
assignment to. For numerical arrays and strings, the form of an assignment is either
a(ndx) = val
where ndx is a set of vector indexing coordinates. This means that the values ndx takes reference the elements
of a in column order. So, if, for example a is an N x M matrix, the first column has vector indices 1,2,...,N,
and the second column has indices N+1,N+2,...,2N, and so on. Alternately, you can use multi-dimensional
indexing to make an assignment:
a(ndx_1,ndx_2,..,ndx_m) = val
where each indexing expression ndx_i corresponds to the i-th dimension of a. In both cases, (vector or multidimensional indexing), the right hand side val must either be a scalar, an empty matrix, or of the same size as the
indices. If val is an empty matrix, the assignment acts like a delete. Note that the type of a may be modified by
the assignment. So, for example, assigning a double value to an element of a float array a will cause the array
a to become double.
For cell arrays, the above forms of assignment will still work, but only if val is also a cell array. If you want to assign
the contents of a cell in a cell array, you must use one of the two following forms, either
a{ndx} = val
or
a{ndx_1,ndx_2,...,ndx_m} = val
2.3
2.3.1
Usage
Creates a cell array of empty matrix entres. Two seperate syntaxes are possible. The first syntax specifies the array
dimensions as a sequence of scalar dimensions:
y = cell(d1,d2,...,dn).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
The resulting array has the given dimensions, and is filled with all zeros. The type of y is cell, a cell array.
The second syntax specifies the array dimensions as a vector, where each element in the vector specifies a dimension length:
y = cell([d1,d2,...,dn]).
This syntax is more convenient for calling zeros using a variable for the argument. In both cases, specifying only
one dimension results in a square matrix output.
2.3.2
Example
The following examples demonstrate generation of some zero arrays using the first form.
--> cell(2,3,2)
ans =
(:,:,1) =
[] [] []
[] [] []
(:,:,2) =
[] [] []
[] [] []
--> cell(1,3)
ans =
[] [] []
2.4
2.4.1
Usage
The cellfun function is used to apply a function handle (or anonymous function) to each element of a cell array
and to collect the outputs into an array. The general syntax for its use is
y = cellfun(fun, x)
where x is an N-dimensional array. In this case, each element of the output y_i is defined as fun(x{i}). You
can also supply multiple arguments to cellfun, provided all of the arguments are the same size
y = cellfun(fun, x, z, ...)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
in which case each output y_i is defined as fun(x{i},z{i},...). Note that unlike arrayfun, the
cellfun function will allow for different types (if there are overloaded versions of the function fun) for each
element.
If the function returns multiple outputs, then arrayfun can be called with multiple outputs, in which case each
output goes to a separate array output
[y1,y2,...] = cellfun(fun, x, z, ...)
The assumption is that the output types for each call to fun is the same across the inputs.
Finally, some hints can be provided to cellfun using the syntax
[y1,y2,...] = cellfun(fun, x, z, ..., param, value, param, value)
2.5
2.5.1
USAGE
Applies a circular shift along each dimension of a given array. The syntax for its use is
y = circshift(x,shiftvec)
where x is an n-dimensional array, and shiftvec is a vector of integers, each of which specify how much to shift
x along the corresponding dimension.
2.5.2
Example
8 3
8 0
1 5
5 10
2
5
8
3
9
3
2
7
--> circshift(x,[1,0])
ans =
4 5 10
4 8 3
0 8 0
9 1 5
3
2
5
8
7
9
3
2
--> circshift(x,[0,-1])
ans =
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
8 3
8 0
1 5
5 10
2
5
8
3
9
3
2
7
4
0
9
4
--> circshift(x,[2,2])
ans =
8 2
3 7
2 9
5 3
9
4
4
0
1 5
5 10
8 3
8 0
--> x = int32(rand(4,5,3)*10)
x =
(:,:,1)
2 7
2 2
4 8
10 2
=
7
3
1
7
3 10
7 0
4 0
8 9
(:,:,2) =
5 7 10
0 3 5
4 5 1
9 1 5
9
0
3
1
4
4
6
5
(:,:,3)
1 5
8 10
6 2
1 9
9
5
6
5
2
7
8
3
=
6
6
1
6
--> circshift(x,[1,0,0])
ans =
(:,:,1)
10 2
2 7
2 2
4 8
=
7
7
3
1
8 9
3 10
7 0
4 0
(:,:,2) =
9 1 5
5 7 10
0 3 5
4 5 1
1
9
0
3
5
4
4
6
(:,:,3)
1 9
1 5
8 10
6 2
5
9
5
6
3
2
7
8
=
6
6
6
1
--> circshift(x,[0,-1,0])
ans =
(:,:,1)
7 7
2 3
8 1
2 7
=
3 10 2
7 0 2
4 0 4
8 9 10
(:,:,2)
7 10
3 5
5 1
1 5
=
9
0
3
1
4
4
6
5
5
0
4
9
(:,:,3)
5 6
10 6
2 1
9 6
=
9
5
6
5
2
7
8
3
1
8
6
1
--> circshift(x,[0,0,-1])
ans =
(:,:,1) =
5 7 10
0 3 5
4 5 1
9 1 5
9
0
3
1
4
4
6
5
(:,:,2)
1 5
8 10
6 2
1 9
=
6
6
1
6
9
5
6
5
2
7
8
3
(:,:,3)
2 7
2 2
4 8
10 2
=
7
3
1
7
3 10
7 0
4 0
8 9
--> circshift(x,[2,-3,1])
ans =
(:,:,1)
6 8
5 3
9 2
5 7
=
6 2
1 9
1 5
8 10
1
6
6
6
(:,:,2) =
4 0 4
8 9 10
3 10 2
7 0 2
8
2
7
2
(:,:,3)
3 6
1 5
9 4
0 4
5 1
1 5
7 10
3 5
2.6
=
4
9
5
0
1
7
7
3
2.6.1
Usage
Calculates the condition number of a matrix. To compute the 2-norm condition number of a matrix (ratio of largest
to smallest singular values), use the syntax
y = cond(A)
where A is a matrix. If you want to compute the condition number in a different norm (e.g., the 1-norm), use the
second syntax
y = cond(A,p)
where p is the norm to use when computing the condition number. The following choices of p are supported
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
10
2.6.2
Internals
kAk p
kA1 k p
This equation is precisely how the condition number is computed for the case p = 2. For the p=2 case, the
condition number can be computed much more efficiently using the ratio of the largest and smallest singular values.
2.6.3
Example
1.0000
0.0000
--> cond(A)
ans =
2.0000e+15
--> cond(A,1)
ans =
2000000000000002
You can also (for the case p=1 use rcond to calculate an estimate of the condition number
--> 1/rcond(A)
ans =
2.0000e+15
2.7
2.7.1
Usage
Calculates the determinant of a matrix. Note that for all but very small problems, the determinant is not particularly
useful. The condition number cond gives a more reasonable estimate as to the suitability of a matrix for inversion
than comparing det(A) to zero. In any case, the syntax for its use is
y = det(A)
2.7.2
11
Internals
The determinant is calculated via the LU decomposition. Note that the determinant of a product of matrices is the
product of the determinants. Then, we have that
LU = PA
where L is lower triangular with 1s on the main diagonal, U is upper triangular, and P is a row-permutation matrix.
Taking the determinant of both sides yields
2.7.3
Example
Then, we exchange two rows of A to demonstrate how the determinant changes sign (but the magnitude is the
same)
--> B = A([2,1,3,4,5],:);
--> det(B)
ans =
0.0489
2.8
2.8.1
Usage
The diag function is used to either construct a diagonal matrix from a vector, or return the diagonal elements of a
matrix as a vector. The general syntax for its use is
y = diag(x,n)
If x is a matrix, then y returns the n-th diagonal. If n is omitted, it is assumed to be zero. Conversely, if x is a vector,
then y is a matrix with x set to the n-th diagonal.
2.8.2
Examples
8
8
8
4
3
3
6
7
12
9
1
5 8
0 10
4
0
2
4
--> diag(A)
ans =
5
8
8
0
--> diag(A,1)
ans =
8
4
4
4
Here is an example of the second form of diag, being used to construct a diagonal matrix.
--> x = int32(10*rand(1,3))
x =
6 3 9
--> diag(x)
ans =
6 0 0
0 3 0
0 0 9
--> diag(x,-1)
ans =
0 0 0
6 0 0
0 3 0
0 0 9
2.9
0
0
0
0
2.9.1
Usage
Calculates e A for a square, full rank matrix A. The syntax for its use is
y = expm(A)
Internally, expm is mapped to a simple e A expression (which in turn uses the eigenvalue expansion of A to
compute the exponential).
2.9.2
Example
An example of expm
--> A = [1 1 0; 0 0 2; 0 0 -1]
A =
1
0
1
0
0
2
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
13
0 -1
--> expm(A)
ans =
2.7183
0
0
2.10
1.7183
1.0000
0
1.0862
1.2642
0.3679
2.10.1
USAGE
Creates an identity matrix of the specified size. The syntax for its use is
y = eye(n)
where n is the size of the identity matrix. The type of the output matrix is float.
2.10.2
Example
2.11
2.11.1
Usage
Returns a vector that contains the indicies of all non-zero elements in an array. The usage is
y = find(x)
The indices returned are generalized column indices, meaning that if the array x is of size [d1,d2,...,dn],
and the element x(i1,i2,...,in) is nonzero, then y will contain the integer
which returns the row and column index of the nonzero entries of x. The third syntax for the find command also
returns the values
[r,c,v] = find(x).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
14
Note that if the argument is a row vector, then the returned vectors are also row vectors. This form is particularly
useful for converting sparse matrices into IJV form.
The find command also supports some additional arguments. Each of the above forms can be combined with an
integer indicating how many results to return:
y = find(x,k)
where k is the maximum number of results to return. This form will return the first k results. You can also specify
an optional flag indicating whether to take the first or last k values:
y = find(x,k,first)
y = find(x,k,last)
in the case of the last argument, the last k values are returned.
2.11.2
Example
Some simple examples of its usage, and some common uses of find in FreeMat programs.
--> a = [1,2,5,2,4];
--> find(a==2)
ans =
2 4
Here is an example of using find to replace elements of A that are 0 with the number 5.
--> A = [1,0,3;0,2,1;3,0,0]
A =
1 0 3
0 2 1
3 0 0
--> n = find(A==0)
n =
2
4
6
9
--> A(n) = 5
A =
1 5 3
5 2 1
3 5 5
Or the three argument form of find, which returns the value also:
--> [r,c,v] = find(A)
r =
1
3
2
1
2
c =
1
1
2
3
3
v =
1
3
2
3
1
2.12
2.12.1
USAGE
Reverses an array along the given dimension. The syntax for its use is
y = flipdim(x,n)
2.12.2
Example
15
16
--> x = int32(rand(4,5,3)*10)
x =
(:,:,1)
5 2
7 6
7 0
3 2
=
4
6
1
1
2
6
1
9
(:,:,2)
10 6
1 2
9 7
3 10
=
3
5
5
4
3 1
7 10
1 4
4 3
(:,:,3)
3 6
9 8
1 7
4 6
=
5
5
9
4
8
3
4
9
8
7
0
9
9
0
8
5
--> flipdim(x,1)
ans =
(:,:,1)
3 2
7 0
7 6
5 2
=
1
1
6
4
9
1
6
2
(:,:,2)
3 10
9 7
1 2
10 6
=
4
5
5
3
4 3
1 4
7 10
3 1
(:,:,3)
4 6
1 7
9 8
3 6
=
4
9
5
5
9
4
3
8
9
0
7
8
5
8
0
9
--> flipdim(x,2)
ans =
(:,:,1)
8 2
7 6
0 1
9 9
=
4
6
1
1
(:,:,2)
1 3
10 7
4 1
3 4
=
3 6 10
5 2 1
5 7 9
4 10 3
(:,:,3)
9 8
0 3
8 4
5 9
=
5
5
9
4
2
6
0
2
6
8
7
6
5
7
7
3
3
9
1
4
--> flipdim(x,3)
ans =
(:,:,1) =
3 6 5
9 8 5
8
3
9
0
1
4
7
6
9
4
4
9
(:,:,2)
10 6
1 2
9 7
3 10
=
3
5
5
4
3 1
7 10
1 4
4 3
(:,:,3)
5 2
7 6
7 0
3 2
=
4
6
1
1
2
6
1
9
2.13
8
5
8
7
0
9
2.13.1
USAGE
2.13.2
Example
7
4
7
9
4
1
9
9
--> fliplr(x)
ans =
4 7 4
1 4 5
9 7 8
9 9 10
6
8
5
1
For a 3D array, note how the columns in each slice are flipped.
--> x = int32(rand(4,4,3)*10)
x =
(:,:,1)
4 8
1 5
2 10
4 8
=
1
5
5
2
8
2
8
1
(:,:,2) =
0 3 4
6 6 10
4 3 3
1
8
6
17
18
(:,:,3) =
6 5 1
6 8 10
4 3 7
9 4 4
1
3
9
3
--> fliplr(x)
ans =
(:,:,1) =
8 1 8
2 5 5
8 5 10
1 2 8
4
1
2
4
(:,:,2)
1 4
8 10
6 3
3 7
=
3
6
3
9
0
6
4
2
(:,:,3)
1 1
3 10
9 7
3 4
=
5
8
3
4
6
6
4
9
2.14
2.14.1
USAGE
2.14.2
Example
5
7
6
0
3
4
3
9
--> flipud(x)
ans =
6 7 0
4 8 6
8 9 7
9 4 5
9
3
4
3
For a 3D array, note how the rows in each slice are flipped.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
19
--> x = int32(rand(4,4,3)*10)
x =
(:,:,1) =
7 4 3
0 10 10
2 8 1
1 1 9
3
6
8
8
(:,:,2)
4 4
4 4
4 9
5 5
=
3
7
9
1
2
1
8
6
(:,:,3)
9 7
8 9
5 10
4 2
=
7
5
6
8
5
6
8
3
--> flipud(x)
ans =
(:,:,1) =
1 1 9
2 8 1
0 10 10
7 4 3
8
8
6
3
(:,:,2)
5 5
4 9
4 4
4 4
=
1
9
7
3
6
8
1
2
(:,:,3)
4 2
5 10
8 9
9 7
=
8
6
5
7
3
8
6
5
2.15
2.15.1
Usage
The ipermute function rearranges the contents of an array according to the inverse of the specified permutation
vector. The syntax for its use is
y = ipermute(x,p)
where p is a permutation vector - i.e., a vector containing the integers 1...ndims(x) each occuring exactly
once. The resulting array y contains the same data as the array x, but ordered according to the inverse of the given
permutation. This function and the permute function are inverses of each other.
2.15.2
Example
First we create a large multi-dimensional array, then permute it and then inverse permute it, to retrieve the original
array:
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
20
--> A = randn(13,5,7,2);
--> size(A)
ans =
13 5
--> B = permute(A,[3,4,2,1]);
--> size(B)
ans =
7 2
5 13
--> C = ipermute(B,[3,4,2,1]);
--> size(C)
ans =
13 5
--> any(A~=C)
ans =
(:,:,1,1) =
0 0 0 0 0
(:,:,2,1) =
0 0 0 0 0
(:,:,3,1) =
0 0 0 0 0
(:,:,4,1) =
0 0 0 0 0
(:,:,5,1) =
0 0 0 0 0
(:,:,6,1) =
0 0 0 0 0
(:,:,7,1) =
0 0 0 0 0
(:,:,1,2) =
0 0 0 0 0
(:,:,2,2) =
0 0 0 0 0
(:,:,3,2) =
0 0 0 0 0
(:,:,4,2) =
0 0 0 0 0
(:,:,5,2) =
0 0 0 0 0
(:,:,6,2) =
0 0 0 0 0
(:,:,7,2) =
0 0 0 0 0
2.16
2.16.1
21
Usage
and it returns a logical 1 if the argument is a floating point array (i.e., a single or double), and a logical 0
otherwise.
2.17
2.17.1
Usage
and it returns a logical 1 if the argument is an integer. The decision of whether the argument is an integer or not is
made based on the class of y, not on its value.
2.18
2.18.1
Usage
Generates a row vector with the specified number of elements, with entries uniformly spaced between two specified
endpoints. The syntax for its use is either
y = linspace(a,b,count)
2.18.2
Examples
2.19
0.2500
0.5000
0.7500
1.0000
22
2.19.1
Usage
Generates a row vector with the specified number number of elements, with entries logarithmically spaced between
two specified endpoints. The syntax for its use is either
y = logspace(a,b,count)
2.19.2
Example
2.20
31.6228
100.0000
2.20.1
Usage
The meshgrid function generates arrays that can be used for the generation of surface plots. The syntax is one
of
[X,Y] = meshgrid(x)
[X,Y] = meshgrid(x,y)
[X,Y,Z] = meshgrid(x,y,z)
where x,y,z are vectors, and X,Y,Z are matrices. In the first case [X,Y] = meshgrid(x), the rows of X
and the columns of Y contain copies of the vector x. In the second case [X,Y] = meshgrid(x,y), the rows
of X contain copies of x, and the columns of Y contain copies of y. In the third case, each input is copied along the
row, column or slice direction of the corresponding output variable.
2.20.2
Example
-1.6000
-1.6000
-1.6000
-1.2000
-1.2000
-1.2000
-0.8000
-0.8000
-0.8000
-0.4000
-0.4000
-0.4000
0.0000
0.0000
0.0000
0.4000
0.4000
0.4000
-2.0000
-2.0000
-2.0000
-2.0000
-2.0000
-2.0000
-2.0000
-2.0000
-1.6000
-1.6000
-1.6000
-1.6000
-1.6000
-1.6000
-1.6000
-1.6000
23
-1.2000
-1.2000
-1.2000
-1.2000
-1.2000
-1.2000
-1.2000
-1.2000
-0.8000
-0.8000
-0.8000
-0.8000
-0.8000
-0.8000
-0.8000
-0.8000
1.6000
1.6000
1.6000
1.6000
1.6000
1.6000
1.6000
1.6000
1.6000
1.6000
1.6000
2.0000
2.0000
2.0000
2.0000
2.0000
2.0000
2.0000
2.0000
2.0000
2.0000
2.0000
-2.0000
-1.6000
-1.2000
-0.8000
-0.4000
0.0000
0.4000
0.8000
1.2000
1.6000
2.0000
-2.0000
-1.6000
-1.2000
-0.8000
-0.4000
0.0000
0.4000
0.8000
1.2000
1.6000
2.0000
-2.0000
-1.6000
-1.2000
-0.8000
-0.4000
0.0000
0.4000
0.8000
1.2000
1.6000
2.0000
-2.0000
-1.6000
-1.2000
-0.8000
-0.4000
0.0000
0.4000
0.8000
1.2000
1.6000
2.0000
-0.4000
-0.4000
-0.4000
-0.4000
-0.4000
-0.4000
-0.4000
-0.4000
0.0000
0.0000
0.0000
0.0000
0.0000
0.0000
0.0000
0.0000
0.4000
0.4000
0.4000
0.4000
0.4000
0.4000
0.4000
0.4000
-2.0000
-1.6000
-1.2000
-0.8000
-0.4000
0.0000
0.4000
0.8000
1.2000
1.6000
2.0000
-2.0000
-1.6000
-1.2000
-0.8000
-0.4000
0.0000
0.4000
0.8000
1.2000
1.6000
2.0000
-2.0000
-1.6000
-1.2000
-0.8000
-0.4000
0.0000
0.4000
0.8000
1.2000
1.6000
2.0000
Columns 8 to 11
0.8000
0.8000
0.8000
0.8000
0.8000
0.8000
0.8000
0.8000
0.8000
0.8000
0.8000
1.2000
1.2000
1.2000
1.2000
1.2000
1.2000
1.2000
1.2000
1.2000
1.2000
1.2000
Y =
Columns 1 to 7
-2.0000
-1.6000
-1.2000
-0.8000
-0.4000
0.0000
0.4000
0.8000
1.2000
1.6000
2.0000
-2.0000
-1.6000
-1.2000
-0.8000
-0.4000
0.0000
0.4000
0.8000
1.2000
1.6000
2.0000
Columns 8 to 11
-2.0000
-1.6000
-1.2000
-0.8000
-0.4000
0.0000
0.4000
0.8000
1.2000
1.6000
2.0000
-2.0000
-1.6000
-1.2000
-0.8000
-0.4000
0.0000
0.4000
0.8000
1.2000
1.6000
2.0000
2.21
24
2.21.1
Usage
Returns a value that represents not-a-number for both 32 and 64-bit floating point values. This constant is meant
to represent the result of arithmetic operations whose output cannot be meaningfully defined (like zero divided by
zero). There are several forms for the NaN function. The first form returns a double precision NaN.
y = nan
The next form takes a class name that can be either double
y = nan(double)
or single:
y = nan(single)
or
y = nan([m,n,p,...])
2.21.2
Example
The following examples demonstrate a few calculations with the not-a-number constant.
--> nan*0
ans =
NaN
--> nan-nan
ans =
NaN
Note that NaNs are preserved under type conversion to floating point types (i.e., float, double, complex and
dcomplex types), but not integer types.
--> uint32(nan)
ans =
0
--> complex(nan)
ans =
NaN
2.22
2.22.1
25
Usage
Generates N-dimensional grids, each of which is constant in all but one dimension. The syntax for its use is either
[y1, y2, ..., ym] = ndgrid(x1, x2, ..., xn)
where m <= n or
[y1, y2, ..., ym] = ndgrid(x1)
which is equivalent to the first form, with x1=x2=...=xn. Each output yi is an n-dimensional array, with values
such that
2.22.2
Example
26
(:,:,1) =
1 1 1
2 2 2
3 3 3
(:,:,2) =
1 1 1
2 2 2
3 3 3
(:,:,3) =
1 1 1
2 2 2
3 3 3
b =
(:,:,1) =
1 2 3
1 2 3
1 2 3
(:,:,2) =
1 2 3
1 2 3
1 2 3
(:,:,3) =
1 2 3
1 2 3
1 2 3
c =
(:,:,1) =
1 1 1
1 1 1
1 1 1
(:,:,2) =
2 2 2
2 2 2
2 2 2
(:,:,3) =
3 3 3
3 3 3
3 3 3
2.23
2.23.1
USAGE
Returns a dense column vector containing the nonzero elements of the argument matrix. The syntax for its use is
y = nonzeros(x)
where x is the argument array. The argument matrix may be sparse as well as dense.
2.23.2
Example
2.24
2.24.1
Usage
Calculates the norm of a matrix. There are two ways to use the norm function. The general syntax is
y = norm(A,p)
where A is the matrix to analyze, and p is the type norm to compute. The following choices of p are supported
p = 1 returns the 1-norm, or the max column sum of A
p = 2 returns the 2-norm (largest singular value of A)
p = inf returns the infinity norm, or the max row sum of A
p = fro returns the Frobenius-norm (vector Euclidean norm, or RMS value)
For a vector, the regular norm calculations are performed:
1 <= p < inf returns sum(abs(A). p) (1/p)
p unspecified returns norm(A,2)
p = inf returns max(abs(A))
p = -inf returns min(abs(A))
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
27
28
2.24.2
Examples
0.9465
0.9206
0.6608
0.6874
0.5877
0.2035
0.8668
0.5837
0.5083
--> norm(A,1)
ans =
2.5280
--> norm(A,2)
ans =
2.2997
--> norm(A,inf)
ans =
3.3470
--> norm(A,fro)
ans =
2.3712
2.25
2.25.1
29
Usage
Converts an array into its string representation. The general syntax for this function is
s = num2str(X)
where s is a string (or string matrix) and X is an array. By default, the num2str function uses 4 digits of precision
and an exponent if required. If you want more digits of precision, you can specify the precition via the form
s = num2str(X, precision)
where precision is the number of digits to include in the string representation. For more control over the format
of the output, you can also specify a format specifier (see printf for more details).
s = num2str(X, format)
2.26
2.26.1
Usage
Creates an array of ones of the specified size. Two seperate syntaxes are possible. The first syntax specifies the
array dimensions as a sequence of scalar dimensions:
y = ones(d1,d2,...,dn).
The resulting array has the given dimensions, and is filled with all ones. The type of y is float, a 32-bit floating
point array. To get arrays of other types, use the typecast functions (e.g., uint8, int8, etc.).
The second syntax specifies the array dimensions as a vector, where each element in the vector specifies a dimension length:
y = ones([d1,d2,...,dn]).
This syntax is more convenient for calling ones using a variable for the argument. In both cases, specifying only
one dimension results in a square matrix output.
2.26.2
Example
The following examples demonstrate generation of some arrays of ones using the first form.
--> ones(2,3,2)
ans =
(:,:,1) =
1 1 1
1 1 1
(:,:,2) =
1 1 1
1 1 1
--> ones(1,3)
ans =
1 1 1
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
30
Finally, an example of using the type casting function uint16 to generate an array of 16-bit unsigned integers with
a value of 1.
--> uint16(ones(3))
ans =
1 1 1
1 1 1
1 1 1
2.27
2.27.1
Usage
The permute function rearranges the contents of an array according to the specified permutation vector. The
syntax for its use is
y = permute(x,p)
where p is a permutation vector - i.e., a vector containing the integers 1...ndims(x) each occuring exactly
once. The resulting array y contains the same data as the array x, but ordered according to the permutation. This
function is a generalization of the matrix transpose operation.
2.27.2
Example
Here we use permute to transpose a simple matrix (note that permute also works for sparse matrices):
--> A = [1,2;4,5]
A =
1 2
4 5
--> permute(A,[2,1])
ans =
1 4
2 5
--> A
ans =
1 4
2 5
31
--> A = randn(13,5,7,2);
--> size(A)
ans =
13 5
--> B = permute(A,[3,4,2,1]);
--> size(B)
ans =
7 2
2.28
5 13
2.28.1
Usage
Calculates the Moore-Penrose pseudoinverse of a matrix. The general syntax for its use is
y = pinv(A,tol)
For any m x n matrix A, the Moore-Penrose pseudoinverse is the unique n x m matrix B that satisfies the following four conditions
A B A = A
B A B = B
(A B) = A B
(B A) = B A
Also, it is true that B y is the minimum norm, least squares solution to A x = y. The Moore-Penrose pseudoinverse is computed from the singular value decomposition of A, with singular values smaller than tol being treated
as zeros. If tol is not specified then it is chosen as
tol = max(size(A)) * norm(A) * teps(A).
2.28.2
Internals
The calculation of the MP pseudo-inverse is almost trivial once the svd of the matrix is available. First, for a real,
diagonal matrix with positive entries, the pseudo-inverse is simply
(
1/ii ii > 0
=
ii
0
else
+
One can quickly verify that this choice of matrix satisfies the four properties of the pseudoinverse. Then, the
pseudoinverse of a general matrix A = U S V is defined as
A+ = V S+U 0
and again, using the facts that U U = I and V V = I, one can quickly verify that this choice of pseudoinverse
satisfies the four defining properties of the MP pseudoinverse. Note that in practice, the diagonal pseudoinverse
S {+} is computed with a threshold (the tol argument to pinv) so that singular values smaller than tol are
treated like zeros.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32
2.28.3
Examples
Consider a simple 1 x 2 matrix example, and note the various Moore-Penrose conditions:
--> A = float(rand(1,2))
A =
0.4840
0.0187
--> B = pinv(A)
B =
2.0630
0.0796
--> A*B*A
ans =
0.4840
0.0187
--> B*A*B
ans =
2.0630
0.0796
--> A*B
ans =
1.0000
--> B*A
ans =
0.9985
0.0385
0.0385
0.0015
To demonstrate that pinv returns the least squares solution, consider the following very simple case
--> A = float([1;1;1;1])
A =
1
1
1
1
The least squares solution to A x = b is just x = mean(b), and computing the pinv of A demonstrates this
--> pinv(A)
ans =
0.2500
0.2500
0.2500
0.2500
Similarly, we can demonstrate the minimum norm solution with the following simple case
--> A = float([1,1])
A =
1 1
The solutions of A x = 5 are those x_1 and x_2 such that x_1 + x_2 = 5. The norm of x is x_1 +
x_2 2, which is x_1 2 + (5-x_1) 2, which is minimized for x_1 = x_2 = 2.5:
--> pinv(A) * 5.0
ans =
2.5000
2.5000
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
2.29
33
2.29.1
Usage
Returns the rank of a matrix. There are two ways to use the rank function is
y = rank(A,tol)
where tol is the tolerance to use when computing the rank. The second form is
y = rank(A)
where s is the vector of singular values of A. The rank is computed using the singular value decomposition svd.
2.29.2
Examples
Here we construct an ill-conditioned matrix, and show the use of the tol argument.
--> A = [1,0;0,eps/2]
A =
1.0000
0
0
0.0000
--> rank(A)
ans =
1
--> rank(A,eps/8)
ans =
2
2.30
34
2.30.1
Usage
The rcond function is a FreeMat wrapper around LAPACKs function XGECON, which estimates the 1-norm condition number (reciprocal). For the details of the algorithm see the LAPACK documentation. The syntax for its use
is
x = rcond(A)
where A is a matrix.
2.30.2
Example
And here we calculate the same value using the definition of (reciprocal) condition number
--> 1/(norm(A,1)*norm(inv(A),1))
ans =
4.3595e-04
Note that the values are very similar. LAPACKs rcond function is far more efficient than the explicit calculation
(which is also used by the cond function.
2.31
2.31.1
Usage
The repmat function replicates an array the specified number of times. The source and destination arrays may be
multidimensional. There are three distinct syntaxes for the repmap function. The first form:
y = repmat(x,n)
replicates the array x on an n-times-n tiling, to create a matrix y that has n times as many rows and columns
as x. The output y will match x in all remaining dimensions. The second form is
y = repmat(x,m,n)
And creates a tiling of x with m copies of x in the row direction, and n copies of x in the column direction. The final
form is the most general
y = repmat(x,[m n p...])
where the supplied vector indicates the replication factor in each dimension.
2.31.2
Example
Here is an example of using the repmat function to replicate a row 5 times. Note that the same effect can be
accomplished (although somewhat less efficiently) by a multiplication.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35
--> x = [1 2 3 4]
x =
1 2 3 4
--> y = repmat(x,[5,1])
y =
1 2
1 2
1 2
1 2
1 2
3
3
3
3
3
4
4
4
4
4
The repmat function can also be used to create a matrix of scalars or to provide replication in arbitrary dimensions.
Here we use it to replicate a 2D matrix into a 3D volume.
--> x = [1 2;3 4]
x =
1 2
3 4
--> y = repmat(x,[1,1,3])
y =
(:,:,1) =
1 2
3 4
(:,:,2) =
1 2
3 4
(:,:,3) =
1 2
3 4
2.32
2.32.1
Usage
Reshapes an array from one size to another. Two seperate syntaxes are possible. The first syntax specifies the
array dimensions as a sequence of scalar dimensions:
y = reshape(x,d1,d2,...,dn).
The resulting array has the given dimensions, and is filled with the contents of x. The type of y is the same as x.
As a special case, you can specify exactly one of the dimensions as an empty matrix [], in which case FreeMat
will compute the size required in that dimension to make the reshape work. The syntax for this version is
y = reshape(x,d1,...,da,[],db,...,dn)
The second syntax specifies the array dimensions as a vector, where each element in the vector specifies a dimension length:
y = reshape(x,[d1,d2,...,dn]).
This syntax is more convenient for calling reshape using a variable for the argument. The reshape function
requires that the length of x equal the product of the di values. Note that arrays are stored in column format,
which means that elements in x are transferred to the new array y starting with the first column first element, then
proceeding to the last element of the first column, then the first element of the second column, etc.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36
2.32.2
Example
Here are several examples of the use of reshape applied to various arrays. The first example reshapes a row
vector into a matrix.
--> a = uint8(1:6)
a =
1 2 3 4 5 6
--> reshape(a,2,3)
ans =
1 3 5
2 4 6
The second example reshapes a longer row vector into a volume with two planes.
--> a = uint8(1:12)
a =
1
9 10 11 12
--> reshape(a,[2,3,2])
ans =
(:,:,1) =
1 3 5
2 4 6
(:,:,2) =
7 9 11
8 10 12
2.33
2.33.1
Usage
Calculates the reduced row echelon form of a matrix using Gauss Jordan elimination with partial pivoting. The
generic syntax for rref is
R = rref(A)
37
[R,k] = rref(A)
where k is a vector that correponds to the columns of A used as pivot columns. If you want to control the tolerance
used to identify negligible elements, you can use the form
[R,k] = rref(A, tolerance)
This implementation of rref is based on the one from the matcompat lib for octave. It is copyright Paul Kienzle,
and distributed under the GNU GPL.
2.34
2.34.1
Usage
The shiftdim function is used to shift the dimensions of an array. The general syntax for the shiftdim function
is
y = shiftdim(x,n)
where x is a multidimensional array, and n is an integer. If n is a positive integer, then shiftdim circularly shifts
the dimensions of x to the left, wrapping the dimensions around as necessary. If n is a negative integer, then
shiftdim shifts the dimensions of x to the right, introducing singleton dimensions as necessary. In its second
form:
[y,n] = shiftdim(x)
the shiftdim function will shift away (to the left) the leading singleton dimensions of x until the leading dimension
is not a singleton dimension (recall that a singleton dimension p is one for which size(x,p) == 1).
2.34.2
Example
Here are some simple examples of using shiftdim to remove the singleton dimensions of an array, and then
restore them:
--> x = uint8(10*randn(1,1,1,3,2));
--> [y,n] = shiftdim(x);
--> n
ans =
3
--> size(y)
ans =
3 2
--> c = shiftdim(y,-n);
--> size(c)
ans =
1 1 1 3 2
--> any(c~=x)
ans =
(:,:,1,1,1) =
0
(:,:,1,1,2) =
0
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
38
Note that these operations (where shifting involves only singleton dimensions) do not actually cause data to be
resorted, only the size of the arrays change. This is not true for the following example, which triggers a call to
permute:
--> z = shiftdim(x,4);
2.35
0
8
SORT Sort
2.35.1
Usage
Sorts an n-dimensional array along the specified dimensional. The first form sorts the array along the first nonsingular dimension.
B = sort(A)
FreeMat does not support vector arguments for dim - if you need A to be sorted along multiple dimensions (i.e., row
first, then columns), make multiple calls to sort. Also, the direction of the sort can be specified using the mode
argument
B = sort(A,dim,mode)
where mode = ascend means to sort the data in ascending order (the default), and mode = descend
means to sort the data into descending order.
When two outputs are requested from sort, the indexes are also returned. Thus, for
[B,IX] = sort(A)
[B,IX] = sort(A,dim)
[B,IX] = sort(A,dim,mode)
an array IX of the same size as A, where IX records the indices of A (along the sorting dimension) corresponding
to the output array B.
Two additional issues worth noting. First, a cell array can be sorted if each cell contains a string, in which case
the strings are sorted by lexical order. The second issue is that FreeMat uses the same method as MATLAB to
sort complex numbers. In particular, a complex number a is less than another complex number b if abs(a) <
abs(b). If the magnitudes are the same then we test the angle of a, i.e. angle(a) < angle(b), where
angle(a) is the phase of a between -pi,pi.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
2.35.2
Example
8
5
7
1
=
1
2
3
4
4
2
3
1
=
1
2
2
1
3
3
3
2
=
4
2
3
1
1
3
2
4
2.36
39
40
2.36.1
Usage
This function removes the singleton dimensions of an array. The syntax for its use is
y = squeeze(x)
2.36.2
Example
Here is a many dimensioned, ungainly array, both before and after squeezing;
--> x = zeros(1,4,3,1,1,2);
--> size(x)
ans =
1 4 3 1 1 2
--> y = squeeze(x);
--> size(y)
ans =
4 3 2
2.37
2.37.1
Usage
This function can be used to index into basic array types (or structures). It provides a functional interface to execute
complex indexing expressions such as a.b(3){5} at run time (i.e. while executing a script or a function) without
resorting to using eval. Note that this function should be overloaded for use with user defined classes, and that it
cannot be overloaeded for base types. The basic syntax of the function is:
b = subsref(a,s)
2.38
s(1).subs = {5}
s(2).subs = foo
s(3).subs = :
2.38.1
41
Usage
Returns the sum of the diagonal elements of a square matrix. The general syntax for its use is
y = trace(x)
2.39
2.39.1
Usage
2.39.2
Example
Here is an example of the transpose of a complex matrix. Note that the entries are not conjugated.
--> A = [1+i,2+i;3-2*i,4+2*i]
A =
1.0000 +
3.0000 -
1.0000i
2.0000i
2.0000 +
4.0000 +
1.0000i
2.0000i
3.0000 4.0000 +
2.0000i
2.0000i
--> transpose(A)
ans =
1.0000 +
2.0000 +
2.40
1.0000i
1.0000i
2.40.1
Usage
Returns the lower triangular matrix of a square matrix. The general syntax for its use is
y = tril(x)
where |x| is a square matrix. This returns the lower triangular matrix (i.e.: all cells on or above the diagonal are set
to 0). You can also specify a different diagonal using the alternate form
y = tril(x,n)
where n is the diagonal offset. In this mode, the diagonal specified is not set to zero in the returned matrix (e.g.:
tril(x) and tril(x,-1)) will return the same value.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
42
2.41
2.41.1
Usage
Returns the upper triangular matrix of a square matrix. The general syntax for its use is
y = triu(x)
where x is a square matrix. This returns the upper triangular matrix (i.e.: all elements on or below the diagonal are
set to 0). You can also specify a different diagonal using the alternate form
y = triu(x,n)
where n is the diagonal offset. In this mode, the diagonal specified is not set to zero in the returned matrix (e.g.:
tril(x) and tril(x,1)) will return the same value.
2.42
UNIQUE Unique
2.42.1
Usage
Returns a vector containing the unique elements of an array. The first form is simply
y = unique(x)
where x is either a numerical array or a cell-array of strings. The result is sorted in increasing order. You can also
retrieve two sets of index vectors
[y, m, n] = unique(x)
such that y = x(m) and x = y(n). If the argument x is a matrix, you can also indicate that FreeMat should
look for unique rows in the matrix via
y = unique(x,rows)
and
[y, m, n] = unique(x,rows)
2.42.2
Example
2
1
3
3
3
2
2
1
3
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
2
1
1
3
3
2
2
3
2
1
3
3
2
3
3
1
1
3
--> unique(A,rows)
ans =
1 1 1
1 2 2
1 2 3
1 3 3
2 1 1
2 1 2
2 1 3
2 2 2
2 2 3
2 3 2
2 3 3
3 1 1
3 1 3
3 3 1
--> [b,m,n] = unique(A,rows);
--> b
ans =
1 1 1
1 2 2
1 2 3
1 3 3
2 1 1
2 1 2
2 1 3
2 2 2
2 2 3
2 3 2
2 3 3
3 1 1
3 1 3
3 3 1
--> A(m,:)
ans =
1 1 1
1 2 2
1 2 3
1 3 3
2 1 1
2 1 2
2 1 3
2 2 2
2 2 3
2 3 2
2 3 3
3 1 1
3 1 3
3 3 1
--> b(n,:)
ans =
2 3 2
2 1 1
2 2 3
2 1 3
2 2 3
2 1 2
1 2 2
1 1 1
43
44
3
2
1
1
3
3
2
1
2
3
2
1
3
3
3
2
3
3
1
1
3
45
2.43
2.43.1
Usage
where A is the n-dimensional array to analyze. This form uses the underlying BLAS implementation to compute the
2-norm.
2.44
2.44.1
Usage
Creates an array of zeros of the specified size. Two seperate syntaxes are possible. The first syntax specifies the
array dimensions as a sequence of scalar dimensions:
y = zeros(d1,d2,...,dn).
The resulting array has the given dimensions, and is filled with all zeros. The type of y is double, a 64-bit floating
point array. To get arrays of other types, use the typecast functions (e.g., uint8, int8, etc.). An alternative syntax
is to use the following notation:
y = zeros(d1,d2,...,dn,classname)
where classname is one of double, single, int8, uint8, int16, uint16, int32, uint32, int64, uint64, float,
logical.
The second syntax specifies the array dimensions as a vector, where each element in the vector specifies a dimension length:
y = zeros([d1,d2,...,dn]),
or
y = zeros([d1,d2,...,dn],classname).
This syntax is more convenient for calling zeros using a variable for the argument. In both cases, specifying only
one dimension results in a square matrix output.
2.44.2
Example
The following examples demonstrate generation of some zero arrays using the first form.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
46
--> zeros(2,3,2)
ans =
(:,:,1) =
0 0 0
0 0 0
(:,:,2) =
0 0 0
0 0 0
--> zeros(1,3)
ans =
0 0 0
Finally, an example of using the type casting function uint16 to generate an array of 16-bit unsigned integers with
zero values.
--> uint16(zeros(3))
ans =
0 0 0
0 0 0
0 0 0
Here we use the second syntax where the class of the output is specified explicitly
--> zeros(3,int16)
ans =
0 0 0
0 0 0
0 0 0
Chapter 3
Bitwise Operations
BITAND Bitwise Boolean And Operation
BITCMP Bitwise Boolean Complement Operation
BITOR Bitwise Boolean Or Operation
BITXOR Bitwise Boolean Exclusive-Or (XOR) Operation
3.1
3.1.1
Usage
Performs a bitwise binary and operation on the two arguments and returns the result. The syntax for its use is
y = bitand(a,b)
where a and b are multi-dimensional unsigned integer arrays. The and operation is performed using 32 bit unsigned
intermediates. Note that if a or b is a scalar, then each element of the other array is anded with that scalar.
Otherwise the two arrays must match in size.
3.1.2
Example
--> bitand(uint16([1,16,255]),uint16([3,17,128]))
ans =
1 16 128
--> bitand(uint16([1,16,255]),uint16(3))
ans =
1 0 3
3.2
48
Bitwise Operations
3.2.1
Usage
Usage
Performs a bitwise binary complement operation on the argument and returns the result. The syntax for its use is
y = bitcmp(a)
where a is an unsigned integer arrays. This version of the command uses as many bits as required by the type of
a. For example, if a is an uint8 type, then the complement is formed using 8 bits. The second form of bitcmp allows
you to specify the number of bits to use,
y = bitcmp(a,n)
in which case the complement is taken with respect to n bits, where n must be less than the length of the integer
type.
3.2.2
Example
--> bitcmp(uint16(2^14-2))
ans =
49153
--> bitcmp(uint16(2^14-2),14)
ans =
1
3.3
3.3.1
Usage
Performs a bitwise binary or operation on the two arguments and returns the result. The syntax for its use is
y = bitor(a,b)
where a and b are multi-dimensional unsigned integer arrays. The and operation is performed using 32 bit unsigned
intermediates. Note that if a or b is a scalar, then each element of the other array is ored with that scalar. Otherwise
the two arrays must match in size.
3.3.2
Example
--> bitand(uint16([1,16,255]),uint16([3,17,128]))
ans =
1 16 128
--> bitand(uint16([1,16,255]),uint16(3))
ans =
1 0 3
3.4
3.4.1
49
Usage
Performs a bitwise binary xor operation on the two arguments and returns the result. The syntax for its use is
y = bitxor(a,b)
where a and b are multi-dimensional unsigned integer arrays. The and operation is performed using 32 bit unsigned
intermediates. Note that if a or b is a scalar, then each element of the other array is xored with that scalar. Otherwise
the two arrays must match in size.
3.4.2
Example
--> bitand(uint16([1,16,255]),uint16([3,17,128]))
ans =
1 16 128
--> bitand(uint16([1,16,255]),uint16(3))
ans =
1 0 3
50
Bitwise Operations
Chapter 4
52
4.1
4.1.1
Usage
This is a method that is invoked to combine two variables using a logical and operator, and is invoked when you call
c = and(a,b)
or for
c = a & b
4.2
4.2.1
Usage
This function concatenates arrays in a given dimension. The syntax for its use is
cat (DIM, A, B)
cat (DIM, A, B, C ...)
to return the concatenation along the dimension DIM of all arguments. cat(1, A, B, C) is the same as
[A; B; C] or vertcat(A, B, C). cat(2, A, B, C) is the same as [A, B, C] or horzcat(A,
B, C).
4.3
4.3.1
Usage
There are several uses for the class function. The first version takes a single argument, and returns the class of
that variable. The syntax for this form is
classname = class(variable)
and it returns a string containing the name of the class for variable. The second form of the class function is
used to construct an object of a specific type based on a structure which contains data elements for the class. The
syntax for this version is
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
53
This should be called inside the constructor for the class. The resulting class will be of the type classname, and
will be derived from parent1, parent2, etc. The template argument should be a structure array that contains
the members of the class. See the constructors help for some details on how to use the class function. Note
that if the template argument is an empty structure matrix, then the resulting variable has no fields beyond those
inherited from the parent classes.
4.4
4.4.1
Usage
This is a method that is invoked in one of two forms, either the two argument version
c = colon(a,b)
4.5
4.5.1
Usage
When designing a constructor for a FreeMat class, you should design the constructor to take a certain form. The
following is the code for the sample mat object
function p = mat(a)
if (nargin == 0)
p.c = [];
p = class(p,mat);
elseif isa(a,mat)
p = a;
else
p.c = a;
p = class(p,mat);
end
Generally speaking when it is provided with zero arguments, the constructor returns a default version of the class
using a template structure with the right fields populated with default values. If the constructor is given a single
argument that matches the class we are trying to construct, the constructor passes through the argument. This
form of the constructor is used for type conversion. In particular,
p = mat(a)
guarantees that p is an array of class mat. The last form of the constructor builds a class object given the input.
The meaning of this form depends on what makes sense for your class. For example, for a polynomial class, you
may want to pass in the coefficients of the polynomial.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
54
4.6
4.6.1
Usage
This is a method that is invoked when a variable has the conjugate transpose operator method applied, and is
invoked when you call
c = ctranspose(a)
or
/
c = a
4.7
4.7.1
Usage
This is a method that is invoked to combine two variables using an equals comparison operator, and is invoked
when you call
c = eq(a,b)
or for
c = a == b
4.8
4.8.1
Usage
This is a method that is invoked to combine two variables using a greater than or equals comparison operator, and
is invoked when you call
c = ge(a,b)
or for
c = a >= b
4.9
4.9.1
55
Usage
This is a method that is invoked to combine two variables using a greater than comparison operator, and is invoked
when you call
c = gt(a,b)
or for
c = a > b
4.10
4.10.1
Usage
This is a method for a class that is invoked to concatenate two or more variables of the same class type together.
Besides being called when you invoke
c = horzcat(a,b,c)
when one of these variables is a class. The exact meaning of horizontal concatenation depends on the class you
have designed.
4.11
4.11.1
Usage
This is a method that is invoked when two variables are divided and is invoked when you call
c = ldivide(a,b)
or for
c = a .\ b
4.12
4.12.1
Usage
This is a method that is invoked to compare two variables using a less than or equals comparison operator, and is
invoked when you call
c = le(a,b)
or for
c = a <= b
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
56
4.13
4.13.1
Usage
This is a method that is invoked to compare two variables using a less than comparison operator, and is invoked
when you call
c = lt(a,b)
or for
c = a < b
4.14
4.14.1
Usage
This is a method that is invoked when two variables are subtracted and is invoked when you call
c = minus(a,b)
or for
c = a - b
4.15
4.15.1
Usage
This is a method that is invoked when two variables are divided using the matrix (left) divide operator, and is invoked
when you call
c = mldivide(a,b)
or for
c = a \ b
4.16
4.16.1
57
Usage
This is a method that is invoked when one variable is raised to another variable using the matrix power operator,
and is invoked when you call
c = mpower(a,b)
or
c = a^b
4.17
4.17.1
Usage
This is a method that is invoked when two variables are divided using the matrix divide operator, and is invoked
when you call
c = mrdivide(a,b)
or for
c = a / b
4.18
4.18.1
Usage
This is a method that is invoked when two variables are multiplied using the matrix operator and is invoked when
you call
c = mtimes(a,b)
or for
c = a * b
4.19
4.19.1
Usage
This is a method that is invoked to combine two variables using a not-equals comparison operator, and is invoked
when you call
c = ne(a,b)
or for
c = a != b
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
58
4.20
4.20.1
Usage
This is a method that is invoked when a variable is logically inverted, and is invoked when you call
c = not(a)
or for
c = ~a
4.21
4.21.1
Usage
This is a method that is invoked to combine two variables using a logical or operator, and is invoked when you call
c = or(a,b)
or for
c = a | b
4.22
4.22.1
Usage
This is a method that is invoked when two variables are added and is invoked when you call
c = plus(a,b)
or for
c = a + b
4.23
4.23.1
Usage
This is a method that is invoked when one variable is raised to another variable using the dot-power operator, and
is invoked when you call
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
59
c = power(a,b)
or
c = a.^b
4.24
4.24.1
Usage
This is a method that is invoked when two variables are divided and is invoked when you call
c = rdivide(a,b)
or for
c = a ./ b
4.25
4.25.1
Usage
and overloading the subsasgn method can allow you to define the meaning of these expressions for objects of
class a. These expressions are mapped to a call of the form
a = subsasgn(a,s,b)
4.26
s(1).subs = {5}
s(2).subs = foo
s(3).subs = :
60
4.26.1
Usage
in which case subsindex(a) must return a vector containing integers between 0 and N-1 where N is the number
of elements in the vector b.
4.27
4.27.1
Usage
and overloading the subsref method allows you to define the meaning of these expressions for objects of class
a. These expressions are mapped to a call of the form
b = subsref(a,s)
4.28
s(1).subs = {5}
s(2).subs = foo
s(3).subs = :
4.28.1
Usage
This is a method that is invoked when two variables are multiplied and is invoked when you call
c = times(a,b)
or for
c = a .* b
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
4.29
61
4.29.1
Usage
This is a method that is invoked when a variable has the transpose operator method applied, and is invoked when
you call
c = transpose(a)
or
/
c = a.
4.30
4.30.1
Usage
This is a method that is invoked when a variable is negated, and is invoked when you call
c = uminus(a)
or for
c = -a
4.31
4.31.1
Usage
This is a method that is invoked when a variable is preceeded by a "+", and is invoked when you call
c = uplus(a)
or for
c = +a
4.32
62
4.32.1
Usage
This is a method for a class that is invoked to concatenate two or more variables of the same class type together.
Besides being called when you invoke
c = vertcat(a,b,c)
when one of the variables is a class. The exact meaning of vertical concatenation depends on the class you have
designed.
Chapter 5
Base Constants
E Euler Constant (Base of Natural Logarithm)
EPS Double Precision Floating Point Relative Machine Precision Epsilon
FALSE Logical False
FEPS Single Precision Floating Point Relative Machine Precision Epsilon
I-J Square Root of Negative One
INF Infinity Constant
PI Constant Pi
TEPS Type-based Epsilon Calculation
TRUE Logical TRUE
5.1
5.1.1
Usage
Returns a double (64-bit floating point number) value that represents Eulers constant, the base of the natural
logarithm. Typical usage
y = e
5.1.2
Example
64
Base Constants
5.2
5.2.1
Usage
Returns eps, which quantifies the relative machine precision of floating point numbers (a machine specific quantity).
The syntax for eps is:
y = eps
y = eps(double)
y = eps(X)
First form returns eps for double precision values. For most typical processors, this value is approximately
2 -52, or 2.2204e-16. Second form return eps for class double or single. Third form returns distance to the
next value greater than X.
5.2.2
Example
The following example demonstrates the use of the eps function, and one of its numerical consequences.
--> eps
ans =
2.2204e-16
--> 1.0+eps
ans =
1.0000
--> eps(1000.)
ans =
1.1369e-13
5.3
5.3.1
Usage
You can also create an array of logical ones using the syntax
y = false(d1,d2,...,dn)
or the syntax
y = false([d1,d2,...,dn])
5.4
5.4.1
65
Usage
Returns feps, which quantifies the relative machine precision of floating point numbers (a machine specific quantity). The syntax for feps is:
y = feps
which returns feps for single precision values. For most typical processors, this value is approximately 2 -24,
or 5.9604e-8.
5.4.2
Example
The following example demonstrates the use of the feps function, and one of its numerical consequences.
--> feps
ans =
1.1921e-07
--> 1.0f+eps
ans =
1
5.5
5.5.1
Usage
Returns a complex value that represents the square root of -1. There are two functions that return the same
value:
y = i
and
y = j.
This allows either i or j to be used as loop indices. The returned value is a 32-bit complex value.
5.5.2
Example
1.0000i
--> i^2
ans =
-1.0000 +
0.0000i
66
Base Constants
--> j
ans =
0.0000 +
1.0000i
--> j^2
ans =
-1.0000 +
0.0000i
Here is an example of how i can be used as a loop index and then recovered as the square root of -1.
--> accum = 0; for i=1:100; accum = accum + i; end; accum
ans =
5050
--> i
ans =
100
--> clear i
--> i
ans =
0.0000 +
5.6
1.0000i
5.6.1
Usage
Returns a value that represents positive infinity for both 32 and 64-bit floating point values. There are several forms
for the Inf function. The first form returns a double precision Inf.
y = inf
The next form takes a class name that can be either double
y = inf(double)
or single:
y = inf(single)
or
y = inf([m,n,p,...])
5.7 PI Constant Pi
5.6.2
67
Internals
0
a
a
/
/0
= NaN
= forall a > 0
= forall a < 0
= NaN
=
Note that infinities are not preserved under type conversion to integer types (see the examples below).
5.6.3
Example
The following examples demonstrate the various properties of the infinity constant.
--> inf*0
ans =
NaN
--> inf*2
ans =
Inf
--> inf*-2
ans =
-Inf
--> inf/inf
ans =
NaN
--> inf/0
ans =
Inf
--> inf/nan
ans =
NaN
Note that infinities are preserved under type conversion to floating point types (i.e., float, double, complex
and dcomplex types), but not integer types.
--> uint32(inf)
ans =
4294967295
--> complex(inf)
ans =
Inf
5.7
PI Constant Pi
68
Base Constants
5.7.1
Usage
Returns a double (64-bit floating point number) value that represents pi (ratio between the circumference and
diameter of a circle...). Typical usage
y = pi
5.7.2
Example
5.8
5.8.1
Usage
Returns eps for double precision arguments and feps for single precision arguments. The syntax for teps is
y = teps(x)
The teps function is most useful if you need to compute epsilon based on the type of the array.
5.8.2
Example
The following example demonstrates the use of the teps function, and one of its numerical consequences.
--> teps(float(3.4))
ans =
1.1921e-07
--> teps(complex(3.4+i*2))
ans =
2.2204e-16
5.9
5.9.1
Usage
You can also create an array of logical ones using the syntax
y = true(d1,d2,...,dn)
or the syntax
y = true([d1,d2,...,dn])
69
70
Base Constants
Chapter 6
6.1
6.1.1
Usage
Fits n (non-linear) functions of m variables using least squares and the Levenberg-Marquardt algorithm. The general
syntax for its usage is
[xopt,yopt] = fitfun(fcn,xinit,y,weights,tol,params...)
Where fcn is the name of the function to be fit, xinit is the initial guess for the solution (required), y is the right
hand side, i.e., the vector y such that:
the output yopt is the function fcn evaluated at xopt. The vector weights must be the same size as y, and
contains the relative weight to assign to an error in each output value. Generally, the ith weight should reflect your
confidence in the ith measurement. The parameter tol is the tolerance used for convergence. The function fcn
must return a vector of the same size as y, and params are passed to fcn after the argument x, i.e.,
72
6.2
6.2.1
Usage
6.2.2
Example
t = linspace(-pi,pi);
y = cos(t);
[mu,sigma,dc,gain,yhat] = gausfit(t,y);
plot(t,y,rx,t,yhat,g-);
73
1.5
0.5
-0.5
-1
-1.5
-4
-3
-2
-1
6.3
6.3.1
Usage
Given a set of monotonically increasing x coordinates and a corresponding set of y values, performs simple linear
interpolation to a new set of x coordinates. The general syntax for its usage is
zi = interp2(z,xi,yi)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
74
where xi and yi are vectors of the same length. The output vector zi is the same size as the input vector xi. For
each element of xi, the values in zi are linearly interpolated by default. Interpolation method can be selected as:
zi = interp2(z,xi,yi,method)
Default interpolation method is linear. Other methods are nearest, and cubic. For values in xi,
yi that are outside the size of z, the default value returned is NaN. To change this behavior, you can specify the
extrapolation value:
zi = interp2(z,xi,yi,method,extrapval)
The z and xi,yi vectors must be real, although complex types are allowed for z.
6.4
6.4.1
Usage
Given a set of monotonically increasing x coordinates and a corresponding set of y values, performs simple linear
interpolation to a new set of x coordinates. The general syntax for its usage is
yi = interplin1(x1,y1,xi)
where x1 and y1 are vectors of the same length, and the entries in x1 are monotoniccally increasing. The output
vector yi is the same size as the input vector xi. For each element of xi, the values in y1 are linearly interpolated.
For values in xi that are outside the range of x1 the default value returned is nan. To change this behavior, you
can specify the extrapolation flag:
yi = interplin1(x1,y1,xi,extrapflag)
6.4.2
Example
Here is an example of simple linear interpolation with the different extrapolation modes. We start with a fairly coarse
sampling of a cosine.
--> x = linspace(-pi*7/8,pi*7/8,15);
--> y = cos(x);
--> plot(x,y,ro);
75
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-3
-2
-1
Next, we generate a finer sampling over a slightly broader range (in this case [-pi,pi]). First, we demonstrate
the nan extrapolation method
-->
-->
-->
-->
-->
-->
xi = linspace(-4,4,100);
yi_nan = interplin1(x,y,xi,nan);
yi_zero = interplin1(x,y,xi,zero);
yi_endpoint = interplin1(x,y,xi,endpoint);
yi_extrap = interplin1(x,y,xi,extrap);
plot(x,y,ro,xi,yi_nan,g-x,xi,yi_zero,g-x,xi,yi_endpoint,g-x,xi,yi_extrap,g-x);
76
0.5
-0.5
-1
-1.5
-2
-4
-3
-2
-1
6.5
6.5.1
Usage
when r is a vector, is a vector whose elements are the coefficients of the polynomial whose roots are the elements
of r. Alternately, you can provide a matrix
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
77
p = poly(A)
when A is an N x N square matrix, is a row vector with N+1 elements which are the coefficients of the characteristic
polynomial, det(lambdaeye(size(A))-A).
Contributed by Paulo Xavier Candeias under GPL.
6.5.2
Example
-6.0000
-72.0000
-27.0000
--> r = roots(p)
r =
12.1229
-5.7345
-0.3884
6.6
6.6.1
Usage
The polyder function returns the polynomial coefficients resulting from differentiation of polynomial p. The syntax
for its use is either
pder = polyder(p)
for the derivative of polynomial n/d (nder is the numerator and dder is the denominator). In all cases the
polynomial coefficients are assumed to be in decreasing degree. Contributed by Paulo Xavier Candeias under GPL
6.6.2
Example
78
--> polyder([2,3,4],7)
ans =
28 21
6.7
6.7.1
Usage
where x and y are vectors of the same size, and n is the degree of the approximating polynomial. The resulting
vector p forms the coefficients of the optimal polynomial (in descending degree) that fit y with x.
6.7.2
Internals
(p(xi ) yi )2
i
is minimized. It does so by forming the Vandermonde matrix and solving the resulting set of equations using the
backslash operator. Note that the Vandermonde matrix can become poorly conditioned with large n quite rapidly.
6.7.3
Example
A classic example from Edwards and Penny, consider the problem of approximating a sinusoid with a polynomial.
We start with a vector of points evenly spaced on the unit interval, along with a vector of the sine of these points.
--> x = linspace(0,1,20);
--> y = sin(2*pi*x);
--> plot(x,y,r-)
79
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
0.1
0.2
0.3
0.4
0.5
0.6
0.7
0.8
Next, we fit a third degree polynomial to the sine, and use polyval to plot it
--> p = polyfit(x,y,3)
p =
21.9170
-32.8756
11.1897
-0.1156
--> f = polyval(p,x);
--> plot(x,y,r-,x,f,ko);
0.9
1.1
80
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
0.1
0.2
0.3
0.4
0.5
0.6
0.7
0.8
0.9
1.1
-68.5541
130.0555
-71.0940
-38.2814
-0.0029
6.2832
-0.0000
-14.1222
85.1018
Columns 8 to 12
-0.5642
-41.2861
--> f = polyval(p,x);
--> plot(x,y,r-,x,f,ko);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
81
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
0.1
0.2
0.3
0.4
0.5
0.6
0.7
0.8
0.9
1.1
6.8
6.8.1
Usage
The polyint function returns the polynomial coefficients resulting from integration of polynomial p. The syntax for its
use is either
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
82
pint = polyint(p,k)
where p is a vector of polynomial coefficients assumed to be in decreasing degree and k is the integration constant.
Contributed by Paulo Xavier Candeias under GPL
6.8.2
Example
1.5000
4.0000
4.0000
5.0000
And
--> polyint([2,3,4],5)
ans =
0.6667
6.9
1.5000
6.9.1
Usage
where p is a vector of polynomial coefficients, in decreasing degree (as generated by polyfit, for example). If x
is a matrix, the polynomial is evaluated in the matrix sense (in which case x must be square).
6.9.2
Internals
p(x) = ((p1 )x + p2 )x + p3
6.9.3
Example
83
--> p = [1 0 0 0]
p =
1 0 0 0
--> x = linspace(-1,1);
--> y = polyval(p,x);
--> plot(x,y,r-)
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
84
6.10
6.10.1
Usage
The roots routine will return a column vector containing the roots of a polynomial. The general syntax is
z = roots(p)
where p is a vector containing the coefficients of the polynomial ordered in descending powers.
6.10.2
Internals
Given a vector
[p1 , p2 , . . . pn ]
which describes a polynomial
p1 xn1 + p2 xn2 + + pn
we construct the companion matrix (which has a characteristic polynomial matching the polynomial described by
p), and then find the eigenvalues of it (which are the roots of its characteristic polynomial), and which are also the
roots of the polynomial of interest. This technique for finding the roots is described in the help page for roots on
the Mathworks website.
6.10.3
Example
x3 6x2 72x 27
--> roots([1 -6 -72 -27])
ans =
12.1229
-5.7345
-0.3884
Chapter 7
7.1
7.1.1
Usage
The dbauto functionality in FreeMat allows you to debug your FreeMat programs. When dbauto is on, then any
error that occurs while the program is running causes FreeMat to stop execution at that point and return you to the
command line (just as if you had placed a keyboard command there). You can then examine variables, modify
them, and resume execution using return. Alternately, you can exit out of all running routines via a retall
statement. Note that errors that occur inside of try/catch blocks do not (by design) cause auto breakpoints. The
dbauto function toggles the dbauto state of FreeMat. The syntax for its use is
dbauto(state)
to activate dbauto, or
dbauto(off)
to deactivate dbauto. Alternately, you can use FreeMats string-syntax equivalence and enter
dbauto on
or
86
dbauto off
to turn dbauto on or off (respectively). Entering dbauto with no arguments returns the current state (either on or
off).
7.2
7.2.1
Usage
The dbdelete function deletes a breakpoint. The syntax for the dbdelete function is
dbdelete(num)
7.3
7.3.1
Usage
The dbdown function moves up one level in the debug hierarchy. The syntax for the dbdown function is
dbdown
7.4
7.4.1
Usage
List the current set of breakpoints. The syntax for the dblist is simply
dblist
7.5
7.5.1
Usage
Step N statements during debug mode. The synax for this is either
dbstep(N)
to step N statements, or
dbstep
7.6 DBSTOP
7.6
87
DBSTOP
7.6.1
Usage
where funcname is the name of the function where we want to set the breakpoint, and linenumber is the line
number.
7.7
7.7.1
Usage
The dbup function moves up one level in the debug hierarchy. The syntax for the dbup function is
dbup
7.8
7.8.1
Usage
88
Chapter 8
Elementary Functions
ABS Absolute Value Function
ALL All True Function
ANY Any True Function
CEIL Ceiling Function
CONJ Conjugate Function
COV Covariance Matrix
CUMPROD Cumulative Product Function
CUMSUM Cumulative Summation Function
DEAL Multiple Simultaneous Assignments
DEC2HEX Convert Decimal Number to Hexadecimal
DIFF Difference Function
DOT Dot Product Function
FLOOR Floor Function
GETFIELD Get Field Contents
HEX2DEC Convert Hexadecimal Numbers To Decimal
IMAG Imaginary Function
IND2SUB Convert Linear Indexing To Multiple Indexing
MAX Maximum Function
MEAN Mean Function
MIN Minimum Function
NUM2HEX Convert Numbers to IEEE Hex Strings
PROD Product Function
REAL Real Function
ROUND Round Function
STD Standard Deviation Function
SUB2IND Convert Multiple Indexing To Linear Indexing
90
Elementary Functions
SUM Sum Function
TEST Test Function
VAR Variance Function
VEC Reshape to a Vector
8.1
8.1.1
Usage
Returns the absolute value of the input array for all elements. The general syntax for its use is
y = abs(x)
where x is an n-dimensional array of numerical type. The output is the same numerical type as the input, unless
the input is complex or dcomplex. For complex inputs, the absolute value is a floating point array, so that the
return type is float. For dcomplex inputs, the absolute value is a double precision floating point array, so that
the return type is double.
8.1.2
Example
8.2
1.0000
8.2.1
Usage
Reduces a logical array along a given dimension by testing for all logical 1s. The general syntax for its use is
y = all(x,d)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
91
where x is an n-dimensions array of logical type. The output is of logical type. The argument d is optional,
and denotes the dimension along which to operate. The output y is the same size as x, except that it is singular
along the operated direction. So, for example, if x is a 3 x 3 x 4 array, and we all operation along dimension
d=2, then the output is of size 3 x 1 x 4.
8.2.2
Internals
8.2.3
Example
The following piece of code demonstrates various uses of the all function
--> A = [1,0,0;1,0,0;0,0,1]
A =
1 0 0
1 0 0
0 0 1
We start by calling all without a dimension argument, in which case it defaults to testing all values of A
--> all(A)
ans =
0 0 0
8.3
8.3.1
Usage
Reduces a logical array along a given dimension by testing for any logical 1s. The general syntax for its use is
y = any(x,d)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
92
Elementary Functions
where x is an n-dimensions array of logical type. The output is of logical type. The argument d is optional,
and denotes the dimension along which to operate. The output y is the same size as x, except that it is singular
along the operated direction. So, for example, if x is a 3 x 3 x 4 array, and we any operation along dimension
d=2, then the output is of size 3 x 1 x 4.
8.3.2
Internals
If d is omitted, then the summation is taken along the first non-singleton dimension of x.
8.3.3
Example
The following piece of code demonstrates various uses of the summation function
--> A = [1,0,0;1,0,0;0,0,1]
A =
1 0 0
1 0 0
0 0 1
We start by calling any without a dimension argument, in which case it defaults to the first nonsingular dimension
(in this case, along the columns or d = 1).
--> any(A)
ans =
1 0 1
8.4
8.4.1
Usage
Computes the ceiling of an n-dimensional array elementwise. The ceiling of a number is defined as the smallest
integer that is larger than or equal to that number. The general syntax for its use is
y = ceil(x)
where x is a multidimensional array of numerical type. The ceil function preserves the type of the argument. So
integer arguments are not modified, and float arrays return float arrays as outputs, and similarly for double
arrays. The ceil function is not defined for complex or dcomplex types.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
8.4.2
93
Example
The following demonstrates the ceil function applied to various (numerical) arguments. For integer arguments,
the ceil function has no effect:
--> ceil(3)
ans =
3
--> ceil(-3)
ans =
-3
Note that the return type is a float also. Finally, for a double type:
--> ceil(4.312)
ans =
5
--> ceil(-5.32)
ans =
-5
8.5
8.5.1
Usage
Returns the complex conjugate of the input array for all elements. The general syntax for its use is
y = conj(x)
where x is an n-dimensional array of numerical type. The output is the same numerical type as the input. The
conj function does nothing to real and integer types.
8.5.2
Example
4.0000i
94
Elementary Functions
8.6
3.0000i
0.0000 -
1.0000i
8.6.1
Usage
Computes the covariance of a matrix or a vector. The general syntax for its use is
y = cov(x)
where x is a matrix or a vector. If x is a vector then cov returns the variance of x. If x is a matrix then cov returns
the covariance matrix of the columns of x. You can also call cov with two arguments to compute the matrix of cross
correlations. The syntax for this mode is
y = cov(x,z)
where x and z are matrices of the same size. Finally, you can provide a normalization flag d that is either 0 or 1,
which changes the normalization factor from L-1 (for d=0) to L (for d=1) where L is the number of rows in the
matrix x. In this case, the syntaxes are
y = cov(x,z,d)
8.6.2
Example
95
--> cov(A)
ans =
4.2222
-1.6667
1.5556
-1.6667
0.6667
-0.6667
1.5556
-0.6667
0.8889
-1.6667
0.6667
-0.6667
1.5556
-0.6667
0.8889
1.6667
5.1111
8.7
1.6667
5.1111
8.7.1
Usage
Computes the cumulative product of an n-dimensional array along a given dimension. The general syntax for its
use is
y = cumprod(x,d)
where x is a multidimensional array of numerical type, and d is the dimension along which to perform the cumulative
product. The output y is the same size of x. Integer types are promoted to int32. If the dimension d is not
specified, then the cumulative sum is applied along the first non-singular dimension.
8.7.2
Internals
96
Elementary Functions
8.7.3
Example
The default action is to perform the cumulative product along the first non-singular dimension.
--> A = [5,1,3;3,2,1;0,3,1]
A =
5 1 3
3 2 1
0 3 1
--> cumprod(A)
ans =
5 1
15 2
0 6
3
3
3
8.8
8.8.1
Usage
Computes the cumulative sum of an n-dimensional array along a given dimension. The general syntax for its use is
y = cumsum(x,d)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
97
where x is a multidimensional array of numerical type, and d is the dimension along which to perform the cumulative
sum. The output y is the same size of x. Integer types are promoted to int32. If the dimension d is not specified,
then the cumulative sum is applied along the first non-singular dimension.
8.8.2
Internals
8.8.3
Example
The default action is to perform the cumulative sum along the first non-singular dimension.
--> A = [5,1,3;3,2,1;0,3,1]
A =
5 1 3
3 2 1
0 3 1
--> cumsum(A)
ans =
5 1 3
8 3 4
8 6 5
98
Elementary Functions
8.9
8.9.1
Usage
When making a function call, it is possible to assign multiple outputs in a single call, (see, e.g., max for an example).
The deal call allows you to do the same thing with a simple assignment. The syntax for its use is
[a,b,c,...] = deal(expr)
where expr is an expression with multiple values. The simplest example is where expr is the dereference of a
cell array, e.g. expr <- A{:}. In this case, the deal call is equivalent to
a = A{1}; b = A{2}; C = A{3};
Other expressions which are multivalued are structure arrays with multiple entries (non-scalar), where field dereferencing has been applied.
8.10
8.10.1
Usage
Converts an integer value into its hexadecimal representation. The syntax for its use is
y = dec2hex(x)
where x is an integer (and is promoted to a 64-bit integer if it is not). The returned value y is a string containing
the hexadecimal representation of that integer. If you require a minimum length for the hexadecimal representation,
you can specify an optional second argument
y = dec2hex(x,n)
8.10.2
Example
8.11
8.11.1
99
Usage
y=diff(x)
y=diff(x,k)
y=diff(x,k,dim)
8.12
8.12.1
Usage
Computes the scalar dot product of its two arguments. The general syntax for its use is
y = dot(x,z)
where x and z are numerical vectors of the same length. If x and z are multi-dimensional arrays of the same size,
then the dot product is taken along the first non-singleton dimension. You can also specify the dimension to take
the dot product along using the alternate form
y = dot(x,z,dim)
where dim specifies the dimension to take the dot product along.
8.13
8.13.1
Usage
Computes the floor of an n-dimensional array elementwise. The floor of a number is defined as the smallest integer
that is less than or equal to that number. The general syntax for its use is
y = floor(x)
where x is a multidimensional array of numerical type. The floor function preserves the type of the argument. So
integer arguments are not modified, and float arrays return float arrays as outputs, and similarly for double
arrays. The floor function is not defined for complex types.
8.13.2
Example
The following demonstrates the floor function applied to various (numerical) arguments. For integer arguments,
the floor function has no effect:
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
100
Elementary Functions
--> floor(3)
ans =
3
--> floor(-3)
ans =
-3
8.14
8.14.1
Usage
Given a structure or structure array, returns the contents of the specified field. The first version is for scalar structures, and has the following syntax
y = getfield(x,fieldname)
and is equivalent to y = x.fieldname where x is a scalar (1 x 1) structure. If x is not a scalar structure, then
y is the first value, i.e., it is equivalent to y = x(1).fieldname. The second form allows you to specify a
subindex into a structure array, and has the following syntax
y = getfield(x, {m,n}, fieldname)
and is equivalent to y = x(m,n).fieldname. You can chain multiple references together using this syntax.
8.15
8.15.1
Usage
Converts a hexadecimal number (encoded as a string matrix) into integers. The syntax for its use is
y = hex2dec(x)
where x is a character matrix where each row represents an integer in hexadecimal form. The output is of type
Double.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
8.15.2
101
Examples
--> hex2dec(3ff)
ans =
1023
8.16
8.16.1
Usage
Returns the imaginary part of the input array for all elements. The general syntax for its use is
y = imag(x)
where x is an n-dimensional array of numerical type. The output is the same numerical type as the input, unless
the input is complex or dcomplex. For complex inputs, the imaginary part is a floating point array, so that the
return type is float. For dcomplex inputs, the imaginary part is a double precision floating point array, so that
the return type is double. The imag function returns zeros for real and integer types.
8.16.2
Example
The imaginary part of real and integer arguments is a vector of zeros, the same type and size of the argument.
--> imag([2,4,5,6])
ans =
0 0 0 0
8.17
102
Elementary Functions
8.17.1
Usage
The ind2sub function converts linear indexing expression into a multi-dimensional indexing expressionl The syntax for its use is
[d1, d2, ..., dn] = ind2sub(sizevec,index)
where sizevec is the size of the array being indexed into, index is the index value. Each di is a vector of the
same length, containing index values.
8.17.2
Example
6
1
1
9
8
6
6
6
2
8.18
8.18.1
Usage
Computes the maximum of an array along a given dimension, or alternately, computes two arrays (entry-wise) and
keeps the smaller value for each array. As a result, the max function has a number of syntaxes. The first one
computes the maximum of an array along a given dimension. The first general syntax for its use is either
[y,n] = max(x,[],d)
where x is a multidimensional array of numerical type, in which case the output y is the maximum of x along
dimension d. The second argument n is the index that results in the maximum. In the event that multiple maxima
are present with the same value, the index of the first maximum is used. The second general syntax for the use of
the max function is
[y,n] = max(x)
In this case, the maximum is taken along the first non-singleton dimension of x. For complex data types, the
maximum is based on the magnitude of the numbers. NaNs are ignored in the calculations. The third general
syntax for the use of the max function is as a comparison function for pairs of arrays. Here, the general syntax is
y = max(x,z)
where x and z are either both numerical arrays of the same dimensions, or one of the two is a scalar. In the first
case, the output is the same size as both arrays, and is defined elementwise by the smaller of the two arrays. In the
second case, the output is defined elementwise by the smaller of the array entries and the scalar.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
8.18.2
103
Internals
In the general version of the max function which is applied to a single array (using the max(x,[ ],d) or max(x)
syntaxes), The output is computed via
(
x(m1 , . . . , md1 , k, md+1 , . . . , m p ) x( ) z( )
y(m1 , . . . , md1 , 1, md+1 , . . . , m p ) =
z(m1 , . . . , md1 , k, md+1 , . . . , m p ) z( ) < x( ).
8.18.3
Example
The following piece of code demonstrates various uses of the maximum function. We start with the one-array
version.
--> A = [5,1,3;3,2,1;0,3,1]
A =
5 1 3
3 2 1
0 3 1
We first take the maximum along the columns, resulting in a row vector.
--> max(A)
ans =
5 3 3
Next, we take the maximum along the rows, resulting in a column vector.
--> max(A,[],2)
ans =
5
3
3
When the dimension argument is not supplied, max acts along the first non-singular dimension. For a row vector,
this is the column direction:
--> max([5,3,2,9])
ans =
9
For the two-argument version, we can compute the smaller of two arrays, as in this example:
--> a = int8(100*randn(4))
a =
-16
-33
65
-46
-38
127
-45
-14
104
Elementary Functions
-110
18 -15 -11
127 -128 -128 -120
--> b = int8(100*randn(4))
b =
-60 127 -128
91
71 -128 -36 -53
8 127 -106 -128
-128
47 -93 -34
--> max(a,b)
ans =
-16 127
71 -46
8 127
127 47
-38 91
127 -14
-15 -11
-93 -34
1.1346
-2.3248
--> max(a,0)
ans =
0
0
8.19
1.1346
0
8.19.1
Usage
Computes the mean of an array along a given dimension. The general syntax for its use is
y = mean(x,d)
where x is an n-dimensions array of numerical type. The output is of the same numerical type as the input. The
argument d is optional, and denotes the dimension along which to take the mean. The output y is the same size as
x, except that it is singular along the mean direction. So, for example, if x is a 3 x 3 x 4 array, and we compute
the mean along dimension d=2, then the output is of size 3 x 1 x 4.
8.19.2
Internals
1 N
x(m1 , . . . , md1 , k, md+1 , . . . , m p )
N k=1
If d is omitted, then the mean is taken along the first non-singleton dimension of x.
8.19.3
Example
The following piece of code demonstrates various uses of the mean function
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
105
--> A = [5,1,3;3,2,1;0,3,1]
A =
5 1 3
3 2 1
0 3 1
We start by calling mean without a dimension argument, in which case it defaults to the first nonsingular dimension
(in this case, along the columns or d = 1).
--> mean(A)
ans =
2.6667
2.0000
1.6667
8.20
8.20.1
Usage
Computes the minimum of an array along a given dimension, or alternately, computes two arrays (entry-wise) and
keeps the smaller value for each array. As a result, the min function has a number of syntaxes. The first one
computes the minimum of an array along a given dimension. The first general syntax for its use is either
[y,n] = min(x,[],d)
where x is a multidimensional array of numerical type, in which case the output y is the minimum of x along
dimension d. The second argument n is the index that results in the minimum. In the event that multiple minima are
present with the same value, the index of the first minimum is used. The second general syntax for the use of the
min function is
[y,n] = min(x)
In this case, the minimum is taken along the first non-singleton dimension of x. For complex data types, the minimum
is based on the magnitude of the numbers. NaNs are ignored in the calculations. The third general syntax for the
use of the min function is as a comparison function for pairs of arrays. Here, the general syntax is
y = min(x,z)
where x and z are either both numerical arrays of the same dimensions, or one of the two is a scalar. In the first
case, the output is the same size as both arrays, and is defined elementwise by the smaller of the two arrays. In the
second case, the output is defined elementwise by the smaller of the array entries and the scalar.
8.20.2
Internals
In the general version of the min function which is applied to a single array (using the min(x,[ ],d) or min(x)
syntaxes), The output is computed via
106
Elementary Functions
(
x(m1 , . . . , md1 , k, md+1 , . . . , m p ) x( ) z( )
y(m1 , . . . , md1 , 1, md+1 , . . . , m p ) =
z(m1 , . . . , md1 , k, md+1 , . . . , m p ) z( ) < x( ).
8.20.3
Example
The following piece of code demonstrates various uses of the minimum function. We start with the one-array version.
--> A = [5,1,3;3,2,1;0,3,1]
A =
5 1 3
3 2 1
0 3 1
We first take the minimum along the columns, resulting in a row vector.
--> min(A)
ans =
0 1 1
Next, we take the minimum along the rows, resulting in a column vector.
--> min(A,[],2)
ans =
1
1
0
When the dimension argument is not supplied, min acts along the first non-singular dimension. For a row vector,
this is the column direction:
--> min([5,3,2,9])
ans =
2
For the two-argument version, we can compute the smaller of two arrays, as in this example:
--> a = int8(100*randn(4))
a =
-66
-128
127
127
-74 -74
32
-14 -110 -128
-96 -49
72
50
83 120
--> b = int8(100*randn(4))
b =
-94
127
-98
-12
107
--> min(a,b)
ans =
-94
-128
-98
-12
0.6716
-1.3734
--> min(a,0)
ans =
0
-1.0581
8.21
0
-1.3734
8.21.1
Usage
Converts single and double precision arrays to IEEE hex strings. The syntax for its use is
y = num2hex(x)
where x is either a float or double array. The output y is a n-by-p character array, where n is the number of
elements in x, and p is 16 for double arrays, and 8 for single arrays.
8.21.2
Example
108
8.22
Elementary Functions
8.22.1
Usage
Computes the product of an array along a given dimension. The general syntax for its use is
y = prod(x,d)
where x is an n-dimensions array of numerical type. The output is of the same numerical type as the input, except for
integer types, which are automatically promoted to int32. The argument d is optional, and denotes the dimension
along which to take the product. The output is computed via
If d is omitted, then the product is taken along the first non-singleton dimension of x. Note that by definition (starting
with FreeMat 2.1) prod([ ]) = 1.
8.22.2
Example
The following piece of code demonstrates various uses of the product function
--> A = [5,1,3;3,2,1;0,3,1]
A =
5 1 3
3 2 1
0 3 1
We start by calling prod without a dimension argument, in which case it defaults to the first nonsingular dimension
(in this case, along the columns or d = 1).
--> prod(A)
ans =
0 6 3
8.23
8.23.1
Usage
Returns the real part of the input array for all elements. The general syntax for its use is
y = real(x)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
109
where x is an n-dimensional array of numerical type. The output is the same numerical type as the input, unless
the input is complex or dcomplex. For complex inputs, the real part is a floating point array, so that the return
type is float. For dcomplex inputs, the real part is a double precision floating point array, so that the return type
is double. The real function does nothing to real and integer types.
8.23.2
Example
8.24
8.24.1
Usage
Rounds an n-dimensional array to the nearest integer elementwise. The general syntax for its use is
y = round(x)
where x is a multidimensional array of numerical type. The round function preserves the type of the argument. So
integer arguments are not modified, and float arrays return float arrays as outputs, and similarly for double
arrays. The round function is not defined for complex or dcomplex types.
8.24.2
Example
The following demonstrates the round function applied to various (numerical) arguments. For integer arguments,
the round function has no effect:
--> round(3)
ans =
3
--> round(-3)
ans =
-3
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
110
Elementary Functions
Note that the return type is a float also. Finally, for a double type:
--> round(4.312)
ans =
4
--> round(-5.32)
ans =
-5
8.25
8.25.1
Usage
Computes the standard deviation of an array along a given dimension. The general syntax for its use is
y = std(x,d)
where x is an n-dimensions array of numerical type. The output is of the same numerical type as the input. The
argument d is optional, and denotes the dimension along which to take the variance. The output y is the same
size as x, except that it is singular along the mean direction. So, for example, if x is a 3 x 3 x 4 array, and we
compute the mean along dimension d=2, then the output is of size 3 x 1 x 4.
8.25.2
Example
The following piece of code demonstrates various uses of the std function
--> A = [5,1,3;3,2,1;0,3,1]
A =
5 1 3
3 2 1
0 3 1
We start by calling std without a dimension argument, in which case it defaults to the first nonsingular dimension
(in this case, along the columns or d = 1).
--> std(A)
ans =
2.5166
1.0000
1.1547
111
--> std(A,2)
ans =
2.0000
1.0000
1.5275
8.26
8.26.1
Usage
The sub2ind function converts a multi-dimensional indexing expression into a linear (or vector) indexing expression. The syntax for its use is
y = sub2ind(sizevec,d1,d2,...,dn)
where sizevec is the size of the array being indexed into, and each di is a vector of the same length, containing
index values. The basic idea behind sub2ind is that it makes
[z(d1(1),d2(1),...,dn(1)),...,z(d1(n),d2(n),...,dn(n))]
equivalent to
z(sub2ind(size(z),d1,d2,...,dn))
where the later form is using vector indexing, and the former one is using native, multi-dimensional indexing.
8.26.2
Example
2
4
1
3
8
2
We can extract the elements (1,3),(2,3),(3,4) of A via sub2ind. To calculate which elements of A this
corresponds to, we can use sub2ind as
--> n = sub2ind(size(A),1:3,2:4)
n =
4
8 12
--> A(n)
ans =
3 4 2
8.27
112
8.27.1
Elementary Functions
Usage
Computes the summation of an array along a given dimension. The general syntax for its use is
y = sum(x,d)
where x is an n-dimensions array of numerical type. The output is of the same numerical type as the input. The
argument d is optional, and denotes the dimension along which to take the summation. The output y is the same
size as x, except that it is singular along the summation direction. So, for example, if x is a 3 x 3 x 4 array, and
we compute the summation along dimension d=2, then the output is of size 3 x 1 x 4.
8.27.2
Internals
If d is omitted, then the summation is taken along the first non-singleton dimension of x.
8.27.3
Example
The following piece of code demonstrates various uses of the summation function
--> A = [5,1,3;3,2,1;0,3,1]
A =
5 1 3
3 2 1
0 3 1
We start by calling sum without a dimension argument, in which case it defaults to the first nonsingular dimension
(in this case, along the columns or d = 1).
--> sum(A)
ans =
8 6 5
8.28
8.28.1
Usage
Tests for the argument array to be all logical 1s. It is completely equivalent to the all function applied to a vectorized
form of the input. The syntax for the test function is
y = test(x)
8.29
113
8.29.1
Usage
Computes the variance of an array along a given dimension. The general syntax for its use is
y = var(x,d)
where x is an n-dimensions array of numerical type. The output is of the same numerical type as the input. The
argument d is optional, and denotes the dimension along which to take the variance. The output y is the same
size as x, except that it is singular along the mean direction. So, for example, if x is a 3 x 3 x 4 array, and we
compute the mean along dimension d=2, then the output is of size 3 x 1 x 4.
8.29.2
Internals
x =
1 N
(x(m1 , . . . , md1 , k, md+1 , . . . , m p ) x) 2 ,
N 1 k=1
1 N
x(m1 , . . . , md1 , k, md+1 , . . . , m p )
N k=1
If d is omitted, then the mean is taken along the first non-singleton dimension of x.
8.29.3
Example
The following piece of code demonstrates various uses of the var function
--> A = [5,1,3;3,2,1;0,3,1]
A =
5 1 3
3 2 1
0 3 1
We start by calling var without a dimension argument, in which case it defaults to the first nonsingular dimension
(in this case, along the columns or d = 1).
--> var(A)
ans =
6.3333
1.0000
1.3333
8.30
114
8.30.1
Elementary Functions
Usage
Reshapes an n-dimensional array into a column vector. The general syntax for its use is
y = vec(x)
where x is an n-dimensional array (not necessarily numeric). This function is equivalent to the expression y =
x(:).
8.30.2
Example
Chapter 9
9.1
9.1.1
Usage
The cenum function allows you to use the textual strings of C enumerated types (that have been defined using
ctypedefine) in your FreeMat scripts isntead of the hardcoded numerical values. The general syntax for its use
is
enum_int = cenum(enum_type,enum_string)
which looks up the integer value of the enumerated type based on the string. You can also supply an integer
argument, in which case cenum will find the matching string
enum_string = cenum(enum_type,enum_int)
9.2
116
9.2.1
Usage
The ctypecast function is a convenience function for ensuring that a FreeMat structure fits the definition of a C
struct (as defined via ctypedefine. It does so by encoding the structure to a byte array using ctypefreeze
and then recovering it using the ctypethaw function. The usage is simply
s = ctypecast(s,typename)
where s is the structure and typename is the name of the C structure that describes the desired layout and
types for elements of s. This function is equivalent to calling ctypefreeze and ctypethaw in succession on
a FreeMat structure.
9.3
9.3.1
Usage
The ctypedefine function allows you to define C types for use with FreeMat. Three variants of C types can be
used. You can use structures, enumerations, and aliases (typedefs). All three are defined through a single function
ctypedefine. The general syntax for its use is
ctypedefine(typeclass,typename,...)
where typeclass is the variant of the type (legal values are struct, alias, enum). The second
argument is the name of the C type. The remaining arguments depend on what the class of the typedef is.
To define a C structure, use the struct type class. The usage in this case is:
ctypedefine(struct,typename,field1,type1,field2,type2,...)
The argument typename must be a valid identifier string. Each of of the field arguments is also a valid identifier
string that describe in order, the elements of the C structure. The type arguments are typespecs. They can be
of three types:
Built in types, e.g. uint8 or double to name a couple of examples.
C types that have previously been defined with a call to ctypedefine, e.g. mytype where mytype
has already been defined through a call to ctypedefine.
Arrays of either built in types or previously defined C types with the length of the array coded as an integer in
square brackets, for example: uint8[10] or double[1000].
To define a C enumeration, use the enum type class. The usage in this case is: ctypedefine(enum,typename,name1,value1,name2
@] The argument typename must be a valid identifier string. Each of the name arguments must also be valid
identifier strings that describe the possible values that the enumeration can take an, and their corresponding integer
values. Note that the names should be unique. The behavior of the various cenum functions is undefined if the
names are not unique.
To define a C alias (or typedef), use the following form of ctypedefine:
ctypedefine(alias,typename,aliased_typename)
9.4
9.4.1
117
Usage
The ctypefreeze function is used to convert a FreeMat structure into a C struct as defined by a C structure typedef. To use the cstructfreeze function, you must first define the type of the C structure using the
ctypedefine function. The ctypefreeze function then serializes a FreeMat structure to a set of bytes, and
returns it as an array. The usage for ctypefreeze is
byte_array = ctypefreeze(mystruct, typename)
where mystruct is the array we want to freeze to a memory array, and typename is the name of the C type
that we want the resulting byte array to conform to.
9.5
9.5.1
Usage
The ctypenew function is a convenience function for creating a FreeMat structure that corresponds to a C structure. The entire structure is initialized with zeros. This has some negative implications, because if the structure
definition uses cenums, they may come out as unknown values if there are no enumerations corresponding to
zero. The use of the function is
a = ctypenew(typename)
which creates a single structure of C structure type typename. To create an array of structures, we can provide
a second argument
a = ctypenew(typename,count)
9.6
9.6.1
Usage
where typename is a string containing the name of the C type to print. Depending on the class of the C type (e.g.,
structure, alias or enumeration) the ctypeprint function will dump information about the type definition.
9.7
9.7.1
Usage
The ctyperead function is a convenience function for reading a C structure from a file. This is generally a very
bad idea, as direct writing of C structures to files is notoriously unportable. Consider yourself warned. The syntax
for this function is
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
118
a = ctyperead(fid,typename)
where typename is a string containing the name of the C structure as defined using ctypedefine, and fid
is the file handle returned by the fopen command. Note that this form will read a single structure from the file. If
you want to read multiple structures into an array, use the following form
a = ctyperead(fid,typename,count)
Note that the way this function works is by using ctypesize to compute the size of the structure, reading that
many bytes from the file, and then calling ctypethaw on the resulting buffer. A consequence of this behavior is
that the byte-endian corrective behavior of FreeMat does not work.
9.8
9.8.1
Usage
The ctypesize function is used to compute the size of a C structure that is defined using the ctypedefine
function. The usage of ctypesize is
size = ctypesize(typename)
where typename is the name of the C structure you want to compute the size of. The returned count is measured
in bytes. Note that as indicated in the help for ctypedefine that FreeMat does not automatically pad the entries
of the structure to match the particulars of your C compiler. Instead, the assumption is that you have adequate
padding entries in your structure to align the FreeMat members with the C ones. See ctypedefine for more
details. You can also specify an optional count parameter if you want to determine how large multiple structures are
size = ctypesize(typename,count)
9.9
9.9.1
Usage
The ctypethaw function is used to convert a C structure that is encoded in a byte array into a FreeMat structure
using a C structure typedef. To use the ctypethaw function, you must first define the type of the C structure using
the ctypedefine function. The usage of ctypethaw is
mystruct = ctypethaw(byte_array, typename)
where byte_array is a uint8 array containing the bytes that encode the C structure, and typename is a string
that contains the type description as registered with ctypedefine. If you want to retrieve multiple structures from
a single byte array, you can specify a count as
mystruct = ctypethaw(byte_array, typename, count)
where count is an integer containing the number of structures to retrieve. Sometimes it is also useful to retrieve
only part of the structure from a byte array, and then (based on the contents of the structure) retrieve more data. In
this case, you can retrieve the residual byte array using the optional second output argument of ctypethaw:
[mystruct,byte_array_remaining] = ctypethaw(byte_array, typename,...)
9.10
9.10.1
119
Usage
The ctypewrite function is a convenience function for writing a C typedef to a file. This is generally a very
bad idea, as writing of C typedefs to files is notoriously unportable. Consider yourself warned. The syntax for this
function is
ctypewrite(fid,a,typename)
where a is the FreeMat typedef to write, typename is a string containing the name of the C typedef to use
when writing the typedef to the file (previously defined using ctypedefine), and fid is the file handle returned
by fopen.
9.11
9.11.1
Usage
The import function allows you to call functions that are compiled into shared libraries, as if they were FreeMat
functions. The usage is
import(libraryname,symbol,function,return,arguments)
The argument libraryname is the name of the library (as a string) to import the function from. The second argument symbol (also a string), is the name of the symbol to import from the library. The third argument function
is the the name of the function after its been imported into Freemat. The fourth argument is a string that specifies
the return type of the function. It can take on one of the following types:
uint8 for an unsigned, 8-bit integer.
int8 for a signed, 8-bit integer.
uint16 an unsigned, 16-bit integer.
int16 a signed, 16-bit integer.
uint32 for an unsigned, 32-bit integer.
int32 for a signed, 32-bit integer.
single for a 32-bit floating point.
double for a 64-bit floating point.
void for no return type.
The fourth argument is more complicated. It encodes the arguments of the imported function using a special syntax.
In general, the argument list is a string consisting of entries of the form:
type[optional bounds check] {optional &}name
Here is a list of various scenarios (expressed in C), and the corresponding entries, along with snippets of code.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
120
i.e., it takes a scalar value (or a string) that is passed by value. Then the corresponding argument string would be
float t
Other types are as listed above. Note that FreeMat will automatically promote the type of scalar variables to the
type expected by the C function. For example, if we call a function expecting a float with a double or int16
argument, then FreeMat will automatically apply type promotion rules prior to calling the function.
i.e., it takes a scalar value (or a string) that is passed as a pointer. Then the corresponding argument string would
be
float &t
If the function fooFunction modifies t, then the argument passed in FreeMat will also be modified.
where sum_onehundred_ints assumes that t is a length 100 vector. Then the corresponding FreeMat argument is
float32[100] t.
Note that because the argument is marked as not being passed by reference, that if sub_onehundred_ints
modifies the array t, this will not affect the FreeMat argument. Note that the bounds-check expression can be any
legal scalar expression that evaluates to an integer, and can be a function of the arguments. For example to pass a
square N N matrix to the following function:
float determinantmatrix(int N, float *A),
121
Note that to avoid problems with memory allocation, external functions are not allowed to return pointers. As a
result, as a general operating mechanism, the FreeMat code must allocate the proper arrays, and then pass them
by reference to the external function.
In this case, once SomeImportedFunction is called from within FreeMat, the text "I am going to
double that argument" will appear in the FreeMat console.
Your freemat_io_handler function is automatically called when your library is loaded by FreeMat, which
happens with the first import statement that references it.
Repeating import calls to import the same function name will be ignored, except the first call. In order to refresh
the function without restarting FreeMat, you have to first clear all imported libraries via:
clear libs
9.11.2
Example
Here is a complete example. We have a C function that adds two float vectors of the same length, and stores the
result in a third array that is modified by the function. First, the C code:
addArrays.c
void addArrays(int N, float *a, float *b, float *c) {
int i;
for (i=0;i<N;i++)
c[i] = a[i] + b[i];
}
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
122
We then compile this into a dynamic library, say, add.so. The import command would then be:
import(add.so,addArrays,addArrays,void, ...
int32 N, float[N] a, float[N] b, float[N] &c);
We could then exercise the function exactly as if it had been written in FreeMat. The following only works on systems
using the GNU C Compiler:
-->
-->
-->
-->
-->
-->
-->
ans =
[]
--> c
ans =
8 8 3 3
9.12
9.12.1
Usage
The loadlib function allows a function in an external library to be added to FreeMat dynamically. This interface
is generally to be used as last resort, as the form of the function being called is assumed to match the internal
implementation. In short, this is not the interface mechanism of choice. For all but very complicated functions, the
import function is the preferred approach. Thus, only a very brief summary of it is presented here. The syntax for
loadlib is
loadlib(libfile, symbolname, functionname, nargin, nargout)
where libfile is the complete path to the library to use, symbolname is the name of the symbol in the library,
functionname is the name of the function after it is imported into FreeMat (this is optional, it defaults to the
symbolname), nargin is the number of input arguments (defaults to 0), and nargout is the number of output
arguments (defaults to 0). If the number of (input or output) arguments is variable then set the corresponding
argument to -1.
Chapter 10
Flow Control
BREAK Exit Execution In Loop
CONTINUE Continue Execution In Loop
ERROR Causes an Error Condition Raised
FOR For Loop
IF-ELSEIF-ELSE Conditional Statements
KEYBOARD Initiate Interactive Debug Session
LASTERR Retrieve Last Error Message
RETALL Return From All Keyboard Sessions
RETURN Return From Function
SWITCH Switch statement
TRY-CATCH Try and Catch Statement
WARNING Emits a Warning Message
WHILE While Loop
10.1
10.1.1
Usage
The break statement is used to exit a loop prematurely. It can be used inside a for loop or a while loop. The
syntax for its use is
break
inside the body of the loop. The break statement forces execution to exit the loop immediately.
124
Flow Control
10.1.2
Example
Here is a simple example of how break exits the loop. We have a loop that sums integers from 1 to 10, but that
stops prematurely at 5 using a break. We will use a while loop.
break_ex.m
function accum = break_ex
accum = 0;
i = 1;
while (i<=10)
accum = accum + i;
if (i == 5)
break;
end
i = i + 1;
end
10.2
10.2.1
Usage
The continue statement is used to change the order of execution within a loop. The continue statement can
be used inside a for loop or a while loop. The syntax for its use is
continue
inside the body of the loop. The continue statement forces execution to start at the top of the loop with the next
iteration. The examples section shows how the continue statement works.
10.2.2
Example
Here is a simple example of using a continue statement. We want to sum the integers from 1 to 10, but not the
number 5. We will use a for loop and a continue statement.
continue_ex.m
function accum = continue_ex
accum = 0;
for i=1:10
if (i==5)
continue;
end
accum = accum + 1; %skipped if i == 5!
end
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
125
10.3
10.3.1
Usage
The error function causes an error condition (exception to be raised). The general syntax for its use is
error(s),
where s is the string message describing the error. The error function is usually used in conjunction with try
and catch to provide error handling. If the string s, then (to conform to the MATLAB API), error does nothing.
10.3.2
Example
The normal command line prompt -> simply prints the error that occured.
--> evenoddtest(4)
4 is even
--> evenoddtest(5)
5 is odd
--> evenoddtest(0)
In /home/sbasu/Devel/FreeMat4/doc/fragments/evenoddtest.m(evenoddtest) at line 3
In scratch() at line 1
In base(base)
In base()
In global()
Error: zero is neither even nor odd
--> evenoddtest(pi)
In /home/sbasu/Devel/FreeMat4/doc/fragments/evenoddtest.m(evenoddtest) at line 5
In scratch() at line 1
In base(base)
In base()
In global()
Error: expecting integer argument
126
10.4
Flow Control
10.4.1
Usage
The for loop executes a set of statements with an index variable looping through each element in a vector. The
syntax of a for loop is one of the following:
for (variable=expression)
statements
end
or alternately, the index variable can be pre-initialized with the vector of values it is going to take:
for variable
statements
end
The third form is essentially equivalent to for variable=variable, where variable is both the index
variable and the set of values over which the for loop executes. See the examples section for an example of this
form of the for loop.
10.4.2
Examples
Here we write for loops to add all the integers from 1 to 100. We will use all three forms of the for statement.
--> accum = 0;
--> for (i=1:100); accum = accum + i; end
--> accum
ans =
5050
The second form is functionally the same, without the extra parenthesis
--> accum = 0;
--> for i=1:100; accum = accum + i; end
--> accum
ans =
5050
In the third example, we pre-initialize the loop variable with the values it is to take
10.5
10.5.1
127
Usage
The if and else statements form a control structure for conditional execution. The general syntax involves an if
test, followed by zero or more elseif clauses, and finally an optional else clause:
if conditional_expression_1
statements_1
elseif conditional_expression_2
statements_2
elseif conditional_expresiion_3
statements_3
...
else
statements_N
end
Note that a conditional expression is considered true if the real part of the result of the expression contains all
non-zero elements (this strange convention is adopted for compatibility with MATLAB).
10.5.2
Examples
10.6
10.6.1
Usage
The keyboard statement is used to initiate an interactive session at a specific point in a function. The general
syntax for the keyboard statement is
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
128
Flow Control
keyboard
A keyboard statement can be issued in a script, in a function, or from within another keyboard session.
The result of a keyboard statement is that execution of the program is halted, and you are given a prompt of the
form:
[scope,n] -->
where scope is the current scope of execution (either the name of the function we are executing, or base otherwise). And n is the depth of the keyboard session. If, for example, we are in a keyboard session, and we call a
function that issues another keyboard session, the depth of that second session will be one higher. Put another
way, n is the number of return statements you have to issue to get back to the base workspace. Incidentally,
a return is how you exit the keyboard session and resume execution of the program from where it left off. A
retall can be used to shortcut execution and return to the base workspace.
The keyboard statement is an excellent tool for debugging FreeMat code, and along with eval provide a unique
set of capabilities not usually found in compiled environments. Indeed, the keyboard statement is equivalent to a
debugger breakpoint in more traditional environments, but with significantly more inspection power.
10.6.2
Example
Here we demonstrate a two-level keyboard situation. We have a simple function that calls keyboard internally:
key_one.m
function c = key_one(a,b)
c = a + b;
keyboard
Now, we execute the function from the base workspace, and at the keyboard prompt, we call it again. This action
puts us at depth 2. We can confirm that we are in the second invocation of the function by examining the arguments.
We then issue two return statements to return to the base workspace.
--> key_one(1,2)
[key_one,3]--> key_one(5,7)
[key_one,3]--> a
ans =
5
[key_one,3]--> b
ans =
7
[key_one,3]--> c
ans =
12
[key_one,3]--> return
ans =
12
[key_one,3]--> a
ans =
1
[key_one,3]--> b
ans =
2
129
[key_one,3]--> c
ans =
3
[key_one,3]--> return
ans =
3
10.7
10.7.1
Usage
Either returns or sets the last error message. The general syntax for its use is either
msg = lasterr
10.7.2
Example
Here is an example of using the error function to set the last error, and then retrieving it using lasterr.
--> try; error(Test error message); catch; end;
--> lasterr
ans =
Test error message
10.8
10.8.1
Usage
The retall statement is used to return to the base workspace from a nested keyboard session. It is equivalent
to forcing execution to return to the main prompt, regardless of the level of nesting of keyboard sessions, or which
functions are running. The syntax is simple
retall
The retall is a convenient way to stop debugging. In the process of debugging a complex program or set of
functions, you may find yourself 5 function calls down into the program only to discover the problem. After fixing it,
issueing a retall effectively forces FreeMat to exit your program and return to the interactive prompt.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
130
Flow Control
10.8.2
Example
Here we demonstrate an extreme example of retall. We are debugging a recursive function self to calculate
the sum of the first N integers. When the function is called, a keyboard session is initiated after the function
has called itself N times. At this keyboard prompt, we issue another call to self and get another keyboard
prompt, this time with a depth of 2. A retall statement returns us to the top level without executing the remainder
of either the first or second call to self:
self.m
function y = self(n)
if (n>1)
y = n + self(n-1);
printf(y is %d\n,y);
else
y = 1;
printf(y is initialized to one\n);
keyboard
end
--> self(4)
y is initialized to one
[self,8]--> self(6)
y is initialized to one
[self,8]--> retall
10.9
10.9.1
Usage
The return statement is used to immediately return from a function, or to return from a keyboard session. The
syntax for its use is
return
Inside a function, a return statement causes FreeMat to exit the function immediately. When a keyboard
session is active, the return statement causes execution to resume where the keyboard session started.
10.9.2
Example
In the first example, we define a function that uses a return to exit the function if a certain test condition is
satisfied.
return_func.m
131
--> return_func(1,3)
finishing up...
ans =
b is greater
--> return_func(5,2)
ans =
a is greater
In the second example, we take the function and rewrite it to use a keyboard statement inside the if statement.
return_func2.m
function ret = return_func2(a,b)
if (a > b)
ret = a is greater;
keyboard;
else
ret = b is greater;
end
printf(finishing up...\n);
Now, we call the function with a larger first argument, which triggers the keyboard session. After verifying a few
values inside the keyboard session, we issue a return statement to resume execution.
--> return_func2(2,4)
finishing up...
ans =
b is greater
--> return_func2(5,1)
[return_func2,4]--> ret
ans =
a is greater
[return_func2,4]--> a
ans =
5
[return_func2,4]--> b
ans =
1
[return_func2,4]--> return
finishing up...
ans =
a is greater
10.10
10.10.1
Usage
The switch statement is used to selective execute code based on the value of either scalar value or a string. The
general syntax for a switch statement is
switch(expression)
case test_expression_1
statements
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
132
Flow Control
case test_expression_2
statements
otherwise
statements
end
The otherwise clause is optional. Note that each test expression can either be a scalar value, a string to test
against (if the switch expression is a string), or a cell-array of expressions to test against. Note that unlike
C switch statements, the FreeMat switch does not have fall-through, meaning that the statements associated
with the first matching case are executed, and then the switch ends. Also, if the switch expression matches
multiple case expressions, only the first one is executed.
10.10.2
Examples
10.11
10.11.1
Usage
The try and catch statements are used for error handling and control. A concept present in C++, the try and
catch statements are used with two statement blocks as follows
try
statements_1
catch
statements_2
end
The meaning of this construction is: try to execute statements_1, and if any errors occur during the execution,
then execute the code in statements_2. An error can either be a FreeMat generated error (such as a syntax
error in the use of a built in function), or an error raised with the error command.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
10.11.2
133
Examples
Here is an example of a function that uses error control via try and catch to check for failures in fopen.
read_file.m
function c = read_file(filename)
try
fp = fopen(filename,r);
c = fgetline(fp);
fclose(fp);
catch
c = [could not open file because of error : lasterr]
end
Now we try it on an example file - first one that does not exist, and then on one that we create (so that we know it
exists).
--> read_file(this_filename_is_invalid)
c =
could not open file because of error :Invalid handle!
ans =
could not open file because of error :Invalid handle!
--> fp = fopen(test_text.txt,w);
--> fprintf(fp,a line of text\n);
--> fclose(fp);
--> read_file(test_text.txt)
ans =
a line of text
10.12
10.12.1
Usage
The warning function causes a warning message to be sent to the user. The general syntax for its use is
warning(s)
at which point, warnings will not be displayed. To turn on warnings use the syntax
warning on
In both cases, you can also retrieve the current state of the warnings flag
y = warning(on)
y = warning(off)
10.13
134
Flow Control
10.13.1
Usage
The while loop executes a set of statements as long as a the test condition remains true. The syntax of a
while loop is
while test_expression
statements
end
Note that a conditional expression is considered true if the real part of the result of the expression contains any
non-zero elements (this strange convention is adopted for compatibility with MATLAB).
10.13.2
Examples
accum = 0;
k=1;
while (k<=100), accum = accum + k; k = k + 1; end
accum
ans =
5050
Chapter 11
FreeMat Functions
ADDPATH Add
ASSIGNIN Assign Variable in Workspace
BLASLIB Select BLAS library
BUILTIN Evaulate Builtin Function
CLC Clear Dislplay
CLOCK Get Current Time
CLOCKTOTIME Convert Clock Vector to Epoch Time
COMPUTER Computer System FreeMat is Running On
DIARY Create a Log File of Console
DOCLI Start a Command Line Interface
EDIT Open Editor Window
EDITOR Open Editor Window
ERRORCOUNT Retrieve the Error Counter for the Interpreter
ETIME Elapsed Time Function
EVAL Evaluate a String
EVALIN Evaluate a String in Workspace
EXIT Exit Program
FEVAL Evaluate a Function
FILESEP Directory Separation Character
HELP Help
HELPWIN Online Help Window
JITCONTROL Control the Just In Time Compiler
MFILENAME Name of Current Function
PATH Get or Set FreeMat Path
PATHSEP Path Directories Separation Character
PATHTOOL Open Path Setting Tool
136
FreeMat Functions
PCODE Convert a Script or Function to P-Code
PROFILER Control Profiling
QUIET Control the Verbosity of the Interpreter
QUIT Quit Program
REHASH Rehash Directory Caches
RESCAN Rescan M Files for Changes
ROOTPATH Set FreeMat Root Path
SAVERETVALUE Save Return Value Of Function
SIMKEYS Simulate Keypresses from the User
SLEEP Sleep For Specified Number of Seconds
SOURCE Execute an Arbitrary File
STARTUP Startup Script
TIC Start Stopwatch Timer
TOC Stop Stopwatch Timer
VERSION The Current Version Number
VERSTRING The Current Version String
11.1
ADDPATH Add
11.1.1
Usage
The addpath routine adds a set of directories to the current path. The first form takes a single directory and adds
it to the beginning or top of the path:
addpath(directory)
The second form add several directories to the top of the path:
addpath(dir1,dir2,...,dirn)
Finally, you can provide a flag to control where the directories get added to the path
addpath(dir1,dir2,...,dirn,-flag)
where if flag is either -0 or -begin, the directories are added to the top of the path, and if the flag is
either -1 or -end the directories are added to the bottom (or end) of the path.
11.2
11.2.1
137
Usage
The assignin function allows you to assign a value to a variable in either the callers work space or the base work
space. The syntax for assignin is
assignin(workspace,variablename,value)
The argument workspace must be either caller or base. If it is caller then the variable is assigned in the callers
work space. That does not mean the caller of assignin, but the caller of the current function or script. On the
other hand if the argument is base, then the assignment is done in the base work space. Note that the variable is
created if it does not already exist.
11.3
11.3.1
Usage
The blaslib function allows you to select the FreeMat blas library. It has two modes of operation. The first is to
select blas library:
blaslib LIB_NAME
If you want to see current blas library selected issue a blaslib command with no arguments.
blaslib
the returned list of libraries will include an asterix next to the library currently selected. If no library is selected,
FreeMat will use its internal (reference) BLAS implementation, which is slow, but portable.
Location of the optimized library is specified in blas.ini file which is installed in the binary directory (i.e. directory
where FreeMat executable is located).
The format of blas.ini file is following:
[Linux64]
ATLAS64\libname=/usr/lib64/atlas/libblas.so
ATLAS64\capfnames=false
ATLAS64\prefix=
ATLAS64\suffix=_
ATLAS64\desc="ATLAS BLAS. Optimized."
Where Linux64 is the OS flavor for the blas library described below it. Other options are [Win32], [Linux32], [OSX].
Note that Linux is our name for all unix platforms.
ATLAS64 - name of the library as it will appear in the list when you type blaslib command in FreeMat.
ATLAS64\libname - path to the library. It has to be a shared library (Linux), DLL (Windows), Bundle (?
OSX). This library has to be a Fortran BLAS library, not cblas!
ATLAS64\capfnames - does the library use capital letters for function names (usually false).
ATLAS64\prefix - prefix (characters that are put in front of) for all blas functions in the library (e.g. ATL_
or AMD_).
ATLAS64\suffix - suffix (characters that are put after) for all blas function in the library (e.g. _)
ATLAS64\desc - text description of the library.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
138
FreeMat Functions
On FreeMat startup it looks at the blas.ini file, and tries to load each library described in the section for the given OS
flavor. FreeMat will use the first library it can successfully load. If you want to switch the BLAS libraries dynamically
in the running FreeMat session you need to use blaslib command.
If FreeMat cant load any library it will default to using built in BLAS.
You should be a careful when using non-default BLAS libraries. Some libraries do not implement all the BLAS functions correctly. You should run FreeMat test suite (type run_tests()) and use common sense when
evaluating the results of numerical computations.
11.4
11.4.1
Usage
The builtin function evaluates a built in function with the given name, bypassing any overloaded functions. The
syntax of builtin is
[y1,y2,...,yn] = builtin(fname,x1,x2,...,xm)
where fname is the name of the function to call. Apart from the fact that fname must be a string, and that
builtin always calls the non-overloaded method, it operates exactly like feval. Note that unlike MATLAB,
builtin does not force evaluation to an actual compiled function. It simply subverts the activation of overloaded
method calls.
11.5
11.5.1
Usage
The clc function clears the current display. The syntax for its use is
clc
11.6
11.6.1
Usage
Returns the current date and time as a vector. The syntax for its use is
y = clock
11.6.2
139
Example
11.7
0.0020
0.0080
0.0220
0.0420
0.0412
11.7.1
Usage
Given the output of the clock command, this function computes the epoch time, i.e, the time in seconds since
January 1,1970 at 00:00:00 UTC. This function is most useful for calculating elapsed times using the clock, and
should be accurate to less than a millisecond (although the true accuracy depends on accuracy of the argument
vector). The usage for clocktotime is
y = clocktotime(x)
11.7.2
Example
0.0020
0.0080
0.0220
0.0420
0.0415
0.0020
0.0080
0.0220
0.0420
0.0425
--> sleep(1)
--> y = clock
y =
1.0e+03 *
2.0120
11.8
140
FreeMat Functions
11.8.1
Usage
Returns a string describing the name of the system FreeMat is running on. The exact value of this string is subject
to change, although the MAC and PCWIN values are probably fixed.
str = computer
11.9
11.9.1
Usage
The diary function controls the creation of a log file that duplicates the text that would normally appear on the
console. The simplest syntax for the command is simply:
diary
which toggles the current state of the diary command. You can also explicitly set the state of the diary command via
the syntax
diary off
or
diary on
To specify a filename for the log (other than the default of diary), you can use the form:
diary filename
or
diary(filename)
which activates the diary with an output filename of filename. Note that the diary command is thread specific,
but that the output is appended to a given file. That means that if you call diary with the same filename on multiple
threads, their outputs will be intermingled in the log file (just as on the console). Because the diary state is tied to
individual threads, you cannot retrieve the current diary state using the get(0,Diary) syntax from MATLAB.
Instead, you must call the diary function with no inputs and one output:
state = diary
which returns a logical 1 if the output of the current thread is currently going to a diary, and a logical 0 if not.
11.10
11.10.1
141
Usage
The docli function is the main function that you interact with when you run FreeMat. I am not sure why you would
want to use it, but hey - its there if you want to use it.
11.11
11.11.1
Usage
Brings up the editor window. The arguments of edit function are names of files for editing:
edit file1 file2 file3
11.12
11.12.1
Usage
11.13
11.13.1
Usage
This routine retrieves the internal counter for the interpreter, and resets it to zero. The general syntax for its use is
count = errorcount
11.14
11.14.1
Usage
The etime calculates the elapsed time between two clock vectors x1 and x2. The syntax for its use is
y = etime(x1,x2)
142
FreeMat Functions
11.14.2
Example
x1 = clock;
sleep(1);
x2 = clock;
etime(x2,x1);
11.15
11.15.1
Usage
The eval function evaluates a string. The general syntax for its use is
eval(s)
where s is the string to evaluate. If s is an expression (instead of a set of statements), you can assign the output of
the eval call to one or more variables, via
x = eval(s)
[x,y,z] = eval(s)
Another form of eval allows you to specify an expression or set of statements to execute if an error occurs. In this
form, the syntax for eval is
eval(try_clause,catch_clause),
These later forms are useful for specifying defaults. Note that both the try_clause and catch_clause must
be expressions, as the equivalent code is
try
[x,y,z] = try_clause
catch
[x,y,z] = catch_clause
end
11.15.2
Example
143
The primary use of the eval statement is to enable construction of expressions at run time.
--> s = [b = a + 2]
s =
b = a + 2
--> eval(s)
b =
34
Note that in the second case, b takes the value of 33, indicating that the evaluation of the first expression failed
(because z is not defined).
11.16
11.16.1
Usage
The evalin function is similar to the eval function, with an additional argument up front that indicates the
workspace that the expressions are to be evaluated in. The various syntaxes for evalin are:
evalin(workspace,expression)
x = evalin(workspace,expression)
[x,y,z] = evalin(workspace,expression)
evalin(workspace,try_clause,catch_clause)
x = evalin(workspace,try_clause,catch_clause)
[x,y,z] = evalin(workspace,try_clause,catch_clause)
The argument workspace must be either caller or base. If it is caller, then the expression is evaluated in the
callers work space. That does not mean the caller of evalin, but the caller of the current function or script. On
the other hand if the argument is base, then the expression is evaluated in the base work space. See eval for
details on the use of each variation.
11.17
11.17.1
Usage
The usage is
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
144
FreeMat Functions
exit
11.18
11.18.1
Usage
The feval function executes a function using its name. The syntax of feval is
[y1,y2,...,yn] = feval(f,x1,x2,...,xm)
where f is the name of the function to evaluate, and xi are the arguments to the function, and yi are the return
values.
Alternately, f can be a function handle to a function (see the section on function handles for more information).
Finally, FreeMat also supports f being a user defined class in which case it will atttempt to invoke the subsref
method of the class.
11.18.2
Example
Here we construct an inline object (which is a user-defined class) and use feval to call it
--> afunc = inline(cos(t)+sin(t),t)
afunc =
inline function object
f(t) = cos(t)+sin(t)
--> feval(afunc,pi)
ans =
-1.0000
--> afunc(pi)
ans =
-1.0000
In both cases, (the feval call and the direct invokation), FreeMat calls the subsref method of the class, which
computes the requested function.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
11.19
145
11.19.1
Usage
The filesep routine returns the character used to separate directory names on the current platform (basically, a
forward slash for Windows, and a backward slash for all other OSes). The syntax is simple:
x = filesep
11.20
HELP Help
11.20.1
Usage
Displays help on a function available in FreeMat. The help function takes one argument:
help topic
where topic is the topic to look for help on. For scripts, the result of running help is the contents of the comments
at the top of the file. If FreeMat finds no comments, then it simply displays the function declaration.
11.21
11.21.1
Usage
Brings up the online help window with the FreeMat manual. The helpwin function takes no arguments:
helpwin
helpwin FunctionName
11.22
11.22.1
Usage
The jitcontrol functionality in FreeMat allows you to control the use of the Just In Time (JIT) compiler. Starting
in FreeMat version 4, the JIT compiler is enabled by default on all platforms where it is successfully built. The JIT
compiler should significantly improve the performance of loop intensive, scalar code. As development progresses,
more and more functionality will be enabled under the JIT. In the mean time (if you use the GUI version of FreeMat)
you can use the JIT chat window to get information on why your code was JIT compiled (or not).
11.23
146
FreeMat Functions
11.23.1
Usage
Returns a string describing the name of the current function. For M-files this string will be the complete filename of
the function. This is true even for subfunctions. The syntax for its use is
y = mfilename
11.24
11.24.1
Usage
The path routine has one of the following syntaxes. In the first form
x = path
path simply returns the current path. In the second, the current path is replaced by the argument string
thepath
path(thepath)
In the third form, a new path is appended to the current search path
path(path,newpath)
In the fourth form, a new path is prepended to the current search path
path(newpath,path)
In the final form, the path command prints out the current path
path
11.25
11.25.1
Usage
The pathsep routine returns the character used to separate multiple directories on a path string for the current
platform (basically, a semicolon for Windows, and a regular colon for all other OSes). The syntax is simple:
x = pathsep
11.26
11.26.1
Usage
11.27
147
11.27.1
Usage
Writes out a script or function as a P-code function. The general syntax for its use is:
pcode fun1 fun2 ...
11.28
11.28.1
Usage
The profile function allows you to control the FreeMat profiler. It has two modes of operation. The first is to
enable-disable the profiler. To turn on profiling:
profiler on
Note that regardless of the state of the profiler, only functions and scripts are profiled. Commands entered on the
command line are not profiled. To see information that has accumulated in a profile, you use the variant of the
command:
profiler list
which lists current sorted profiling resuls. You can use this form to obtain profiler results as a cell array
r=profiler(list)
If you want to see current profile status issue a profile command with no arguments.
profiler
11.29
11.29.1
Usage
The quiet function controls how verbose the interpreter is when executing code. The syntax for the function is
quiet flag
148
FreeMat Functions
quiet - only intentional output (e.g. printf calls and disp calls) is printed. The output of expressions
that are not terminated in semicolons are not printed.
silent - nothing is printed to the output.
11.30
11.30.1
Usage
The quit statement is used to immediately exit the FreeMat application. The syntax for its use is
quit
11.31
11.31.1
Usage
Usually, FreeMat will automatically determine when M Files have changed, and pick up changes you have made to
M files. Sometimes, you have to force a refresh. Use the rehash command for this purpose. The syntax for its
use is
rehash
11.32
11.32.1
Usage
Usually, FreeMat will automatically determine when M Files have changed, and pick up changes you have made to
M files. Sometimes, you have to force a refresh. Use the rescan command for this purpose. The syntax for its
use is
rescan
11.33
11.33.1
Usage
In order to function properly, FreeMat needs to know where to find the toolbox directory as well as the help directory. These directories are located on what is known as the root path. Normally, FreeMat should know where
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
149
these directories are located. However under some circumstances (usually when FreeMat is installed into a nondefault location), it may be necessary to indicate a different root path location, or to specify a particular one. Note
that on the Mac OS platform, FreeMat is installed as a bundle, and will use the toolbox that is installed in the bundle
regardless of the setting for rootpath. For Linux, FreeMat will typically use /usr/local/share/FreeMat-<Version>/ for the root path. Installations from source code will generally work, but binary installations
(e.g., from an RPM) may need to have the rootpath set.
The rootpath function has two forms. The first form takes no arguments and returns the current root path
rootpath
The second form will set a rootpath directly from the command line
rootpath(path)
where path is the full path to where the toolbox and help directories are located.
rootpath(/usr/share/FreeMat-4.0). The third form enables the GUI form
For example,
rootpath gui
which activates a dialog box to pick a directory that is the root directory of the FreeMat installation (e.g., where
help and toolbox are located. Changes to rootpath are persistent (you do not need to run it every time you
start FreeMat).
11.34
11.34.1
Usage
saves the given argument value for return when FreeMat (the application) exits.
11.35
11.35.1
Usage
This routine simulates keystrokes from the user on FreeMat. The general syntax for its use is
otext = simkeys(text)
where text is a string to simulate as input to the console. The output of the commands are captured and returned
in the string otext. This is primarily used by the testing infrastructure.
11.36
150
FreeMat Functions
11.36.1
Usage
Suspends execution of FreeMat for the specified number of seconds. The general syntax for its use is
sleep(n),
11.37
11.37.1
Usage
The source function executes the contents of the given filename one line at a time (as if it had been typed at the
-> prompt). The source function syntax is
source(filename)
11.37.2
Example
First, we write some commands to a file (note that it does not end in the usual .m extension):
source_test
a = 32;
b = a;
printf(a is %d and b is %d\n,a,b);
11.38
11.38.1
Usage
Upon starting, FreeMat searches for a script names startup.m, and if it finds it, it executes it. This script can be
in the current directory, or on the FreeMat path (set using setpath). The contents of startup.m must be a valid
script (not a function).
11.39
11.39.1
151
Usage
Starts the stopwatch timer, which can be used to time tasks in FreeMat. The tic takes no arguments, and returns
no outputs. You must use toc to get the elapsed time. The usage is
tic
11.39.2
Example
11.40
11.40.1
Usage
Stop the stopwatch timer, which can be used to time tasks in FreeMat. The toc function takes no arguments, and
returns no outputs. You must use toc to get the elapsed time. The usage is
toc
11.40.2
Example
11.41
11.41.1
Usage
The version function returns the current version number for FreeMat (as a string). The general syntax for its use
is
v = version
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
152
FreeMat Functions
11.41.2
Example
11.42
11.42.1
Usage
The verstring function returns the current version string for FreeMat. The general syntax for its use is
version = verstring
11.42.2
Example
Chapter 12
12.1
12.1.1
Usage
Constructs an inline function object. The syntax for its use is either
y = inline(expr)
which uses the symvar function to identify the variables in the expression, or the explicit form
y = inline(expr,var1,var2,...,varn)
where the variables are explicitly given. Note that inline functions are only partially supported in FreeMat. If you
need features of the inline function that are not currently implemented, please file a feature request at the FreeMat
website.
12.1.2
Example
0.0000i
154
--> a = inline(x+y-cos(x+y))
a =
inline function object
f(x,y) = x+y-cos(x+y)
--> a(pi,-pi)
ans =
-1
In this form, we specify which arguments we want to use (thereby also specifying the order of the arguments
--> a = inline(x+t-sin(x),x,t)
a =
inline function object
f(x,t) = x+t-sin(x)
--> a(0.5,1)
ans =
1.0206
12.2
12.2.1
Usage
Finds the symbolic variables in an expression. The syntax for its use is
syms = symvar(expr)
where expr is a string containing an expression, such as x 2 + cos(t+alpha). The result is a cell array
of strings containing the non-function identifiers in the expression. Because they are usually not used as identifiers
in expressions, the strings pi,inf,nan,eps,i,j are ignored.
12.2.2
Example
ans =
[x]
--> symvar(pi+3)
% No identifiers here
ans =
Empty array 0x1
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
% x, t and alpha
ans =
[alpha]
[t]
[x]
155
156
Chapter 13
13.1
13.1.1
Usage
Anonymous functions are simple, nameless functions that can be defined anywhere (in a script, function, or at the
prompt). They are intended to supplant inline functions. The syntax for an anonymous function is simple:
y = @(arg1,arg2,...,argn) expression
where arg1,arg2,...,argn is a list of valid identifiers that define the arguments to the function, and
expression is the expression to compute in the function. The returned value y is a function handle for the
anonymous function that can then be used to evaluate the expression. Note that y will capture the value of variables that are not indicated in the argument list from the current scope or workspace at the time it is defined. So,
for example, consider the simple anonymous function definition
y = @(x) a*(x+b)
In order for this definition to work, the variables a and b need to be defined in the current workspace. Whatever
value they have is captured in the function handle y. To change the values of a and b in the anonymous function,
you must recreate the handle using another call. See the examples section for more information. In order to use
the anonymous function, you can use it just like any other function handle. For example,
158
p = y(3)
p = y()
p = feval(y,3)
13.1.2
Examples
ans =
8
--> a = 5; b = 7;
--> y(2)
% change a and b
% the value did not change!
ans =
8
--> y = @(x) a*x+b
y =
@(x)
a*x+b
--> y(2)
ans =
17
13.2
13.2.1
Usage
The func2str function converts a function pointer into a string. The syntax is
y = func2str(funcptr)
where funcptr is a function pointer. If funcptr is a pointer to a function, then y is the name of the function. On
the other hand, if funcptr is an anonymous function then func2str returns the definition of the anonymous
function.
13.2.2
Example
159
If we use an anonymous function, then func2str returns the definition of the anonymous function
--> y = @(x) x.^2
y =
@(x)
x.^2
--> x = func2str(y)
x =
@(x)
13.3
x.^2
13.3.1
Usage
There are several forms for function declarations in FreeMat. The most general syntax for a function declaration is
the following:
function [out_1,...,out_M,varargout] = fname(in_1,...,in_N,varargin)
where out_i are the output parameters, in_i are the input parameters, and varargout and varargin are
special keywords used for functions that have variable inputs or outputs. For functions with a fixed number of input
or output parameters, the syntax is somewhat simpler:
function [out_1,...,out_M] = fname(in_1,...,in_N)
Note that functions that have no return arguments can omit the return argument list (of out_i) and the equals sign:
function fname(in_1,...,in_N)
Likewise, a function with no arguments can eliminate the list of parameters in the declaration:
function [out_1,...,out_M] = fname
Functions that return only a single value can omit the brackets
function out_1 = fname(in_1,...,in_N)
In the body of the function in_i are initialized with the values passed when the function is called. Also, the function
must assign values for out_i to pass values to the caller. Note that by default, FreeMat passes arguments by
value, meaning that if we modify the contents of in_i inside the function, it has no effect on any variables used
by the caller. Arguments can be passed by reference by prepending an ampersand & before the name of the input,
e.g.
function [out1,...,out_M] = fname(in_1,&in_2,in_3,...,in_N)
in which case in_2 is passed by reference and not by value. Also, FreeMat works like C in that the caller does
not have to supply the full list of arguments. Also, when keywords (see help keywords) are used, an arbitrary
subset of the parameters may be unspecified. To assist in deciphering the exact parameters that were passed,
FreeMat also defines two variables inside the function context: nargin and nargout, which provide the number
of input and output parameters of the caller, respectively. See help for nargin and nargout for more details.
In some circumstances, it is necessary to have functions that take a variable number of arguments, or that return
a variable number of results. In these cases, the last argument to the parameter list is the special argument
varargin. Inside the function, varargin is a cell-array that contains all arguments passed to the function that
have not already been accounted for. Similarly, the function can create a cell array named varargout for variable
length output lists. See help varargin and varargout for more details.
The function name fname can be any legal FreeMat identifier. Functions are stored in files with the .m extension.
Note that the name of the file (and not the function name fname used in the declaration) is how the function appears
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
160
in FreeMat. So, for example, if the file is named foo.m, but the declaration uses bar for the name of the function,
in FreeMat, it will still appear as function foo. Note that this is only true for the first function that appears in a .m file.
Additional functions that appear after the first function are known as helper functions or local functions.
These are functions that can only be called by other functions in the same .m file. Furthermore the names of these
helper functions are determined by their declaration and not by the name of the .m file. An example of using helper
functions is included in the examples.
Another important feature of functions, as opposed to, say scripts, is that they have their own scope. That
means that variables defined or modified inside a function do not affect the scope of the caller. That means that
a function can freely define and use variables without unintentionally using a variable name reserved elsewhere.
The flip side of this fact is that functions are harder to debug than scripts without using the keyboard function,
because the intermediate calculations used in the function are not available once the function exits.
13.3.2
Examples
Here is an example of a trivial function that adds its first argument to twice its second argument:
addtest.m
function c = addtest(a,b)
c = a + 2*b;
--> addtest(1,3)
ans =
7
--> addtest(3,0)
ans =
3
Suppose, however, we want to replace the value of the first argument by the computed sum. A first attempt at doing
so has no effect:
addtest2.m
function addtest2(a,b)
a = a + 2*b;
--> arg1 = 1
arg1 =
1
--> arg2 = 3
arg2 =
3
--> addtest2(arg1,arg2)
--> arg1
ans =
1
--> arg2
ans =
3
The values of arg1 and arg2 are unchanged, because they are passed by value, so that any changes to a and b
inside the function do not affect arg1 and arg2. We can change that by passing the first argument by reference:
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
161
addtest3.m
function addtest3(&a,b)
a = a + 2*b
Note that it is now illegal to pass a literal value for a when calling addtest3:
--> addtest3(3,4)
a =
11
Error: Must have lvalue in argument passed by reference
--> addtest3(arg1,arg2)
a =
7
--> arg1
ans =
7
--> arg2
ans =
3
The first example fails because we cannot pass a literal like the number 3 by reference. However, the second call
succeeds, and note that arg1 has now changed. Note: please be careful when passing by reference - this feature
is not available in MATLAB and you must be clear that you are using it.
As variable argument and return functions are covered elsewhere, as are keywords, we include one final example
that demonstrates the use of helper functions, or local functions, where multiple function declarations occur in the
same file.
euclidlength.m
function y = foo(x,y)
square_me(x);
square_me(y);
y = sqrt(x+y);
function square_me(&t)
t = t^2;
--> euclidlength(3,4)
ans =
5
--> euclidlength(2,0)
ans =
2
13.4
13.4.1
Usage
A feature of IDL that FreeMat has adopted is a modified form of keywords. The purpose of keywords is to
allow you to call a function with the arguments to the function specified in an arbitrary order. To specify the syntax
of keywords, suppose there is a function with prototype
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
162
Then the general syntax for calling function foo using keywords is
foo(val_1, val_2, /in_k=3)
Note that you can even pass reference arguments using keywords.
13.4.2
Example
The most common use of keywords is in controlling options for functions. For example, the following function takes a
number of binary options that control its behavior. For example, consider the following function with two arguments
and two options. The function has been written to properly use and handle keywords. The result is much cleaner
than the MATLAB approach involving testing all possible values of nargin, and forcing explicit empty brackets for
dont care parameters.
keyfunc.m
function c = keyfunc(a,b,operation,printit)
if (~isset(a) | ~isset(b))
error(keyfunc requires at least the first two 2 arguments);
end;
if (~isset(operation))
% user did not define the operation, default to +
operation = +;
end
if (~isset(printit))
% user did not specify the printit flag, default is false
printit = 0;
end
% simple operation...
eval([c = a operation b;]);
if (printit)
printf(%f %s %f = %f\n,a,operation,b,c);
end
Now some examples of how this function can be called using keywords.
--> keyfunc(1,3)
ans =
4
--> keyfunc(1,3,/printit)
1.000000 + 3.000000 = 4.000000
ans =
4
--> keyfunc(/operation=-,2,3) % assigns a=2, b=3
ans =
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
163
-1
--> keyfunc(4,/operation=*,/printit) % error as b is unspecified
In /home/sbasu/Devel/FreeMat4/doc/fragments/keyfunc.m(keyfunc) at line 3
In scratch() at line 1
In base(base)
In base()
In global()
Error: keyfunc requires at least the first two 2 arguments
13.5
13.5.1
Usage
The nargin function returns the number of arguments passed to a function when it was called. The general syntax
for its use is
y = nargin
FreeMat allows for fewer arguments to be passed to a function than were declared, and nargin, along with isset
can be used to determine exactly what subset of the arguments were defined.
You can also use nargin on a function handle to return the number of input arguments expected by the function
y = nargin(fun)
where fun is the name of the function (e.g. sin) or a function handle.
13.5.2
Example
Here is a function that is declared to take five arguments, and that simply prints the value of nargin each time it
is called.
nargintest.m
function nargintest(a1,a2,a3,a4,a5)
printf(nargin = %d\n,nargin);
--> nargintest(3);
nargin = 1
--> nargintest(3,h);
nargin = 2
--> nargintest(3,h,1.34);
nargin = 3
--> nargintest(3,h,1.34,pi,e);
nargin = 5
--> nargin(sin)
ans =
1
--> y = @sin
y =
@sin
--> nargin(y)
ans =
1
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
164
13.6
13.6.1
Usage
The nargout function computes the number of return values requested from a function when it was called. The
general syntax for its use
y = nargout
FreeMat allows for fewer return values to be requested from a function than were declared, and nargout can be
used to determine exactly what subset of the functions outputs are required.
You can also use nargout on a function handle to return the number of input arguments expected by the function
y = nargout(fun)
where fun is the name of the function (e.g. sin) or a function handle.
13.6.2
Example
Here is a function that is declared to return five values, and that simply prints the value of nargout each time it is
called.
nargouttest.m
function [a1,a2,a3,a4,a5] = nargouttest
printf(nargout = %d\n,nargout);
a1 = 1; a2 = 2; a3 = 3; a4 = 4; a5 = 5;
--> a1 = nargouttest
nargout = 1
a1 =
1
--> [a1,a2] = nargouttest
nargout = 2
a1 =
1
a2 =
2
--> [a1,a2,a3] = nargouttest
nargout = 3
a1 =
1
a2 =
2
a3 =
3
--> [a1,a2,a3,a4,a5] = nargouttest
nargout = 5
a1 =
1
a2 =
2
165
a3 =
3
a4 =
4
a5 =
5
--> nargout(sin)
ans =
1
--> y = @sin
y =
@sin
--> nargout(y)
ans =
1
13.7
13.7.1
Usage
A script is a sequence of FreeMat commands contained in a .m file. When the script is called (via the name of the
file), the effect is the same as if the commands inside the script file were issued one at a time from the keyboard.
Unlike function files (which have the same extension, but have a function declaration), script files share the
same environment as their callers. Hence, assignments, etc, made inside a script are visible to the caller (which is
not the case for functions.
13.7.2
Example
Here is an example of a script that makes some simple assignments and printf statements.
tscript.m
a = 13;
printf(a is %d\n,a);
b = a + 32
Type
double
double
double
Flags
Size
[1x1]
[0x0]
[1x1]
166
13.8
13.8.1
Usage
To reduce the effort to call certain functions, FreeMat supports a special calling syntax for functions that take string
arguments. In particular, the three following syntaxes are equivalent, with one caveat:
functionname(arg1,arg2,...,argn)
The quotes are also optional (providing, of course, that the argument strings have no spaces in them)
functionname arg1 arg2 ... argn
This special syntax enables you to type hold on instead of the more cumbersome hold(on). The caveat is
that FreeMat currently only recognizes the special calling syntax as the first statement on a line of input. Thus, the
following construction
for i=1:10; plot(vec(i)); hold on; end
13.8.2
Example
Here is a function that takes two string arguments and returns the concatenation of them.
strcattest.m
function strcattest(str1,str2)
str3 = [str1,str2];
printf(str1 = %s, str2 = %s, str3 = %s\n,str1,str2,str3);
13.9
13.9.1
Usage
The str2func function converts a function name into a function pointer. The syntax is
y = str2func(funcname)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
167
where funcname is the name of the function. The return variable y is a function handle that points to the given
function.
An alternate syntax is used to construct an anonymous function given an expression. They syntax is
y = str2func(anonymous def)
where anonymous def is an expression that defines an anonymous function, for example @(x) x. 2.
13.9.2
Example
ans =
0.4794
--> y = str2func(sin)
y =
@sin
--> y(.5)
ans =
0.4794
13.10
13.10.1
Usage
FreeMat functions can take a variable number of input arguments by setting the last argument in the argument list
to varargin. This special keyword indicates that all arguments to the function (beyond the last non-varargin
keyword) are assigned to a cell array named varargin available to the function. Variable argument functions
are usually used when writing driver functions, i.e., functions that need to pass arguments to another function. The
general syntax for a function that takes a variable number of arguments is
function [out_1,...,out_M] = fname(in_1,..,in_M,varargin)
Inside the function body, varargin collects the arguments to fname that are not assigned to the in_k.
13.10.2
Example
Here is a simple wrapper to feval that demonstrates the use of variable arguments functions.
wrapcall.m
168
function wrapcall(fname,varargin)
feval(fname,varargin{:});
A more serious driver routine could, for example, optimize a one dimensional function that takes a number of
auxilliary parameters that are passed through varargin.
13.11
13.11.1
Usage
FreeMat functions can return a variable number of output arguments by setting the last argument in the argument
list to varargout. This special keyword indicates that the number of return values is variable. The general syntax
for a function that returns a variable number of outputs is
function [out_1,...,out_M,varargout] = fname(in_1,...,in_M)
The function is responsible for ensuring that varargout is a cell array that contains the values to assign to the
outputs beyond out_M. Generally, variable output functions use nargout to figure out how many outputs have
been requested.
13.11.2
Example
This is a function that returns a varying number of values depending on the value of the argument.
varoutfunc.m
function [varargout] = varoutfunc
switch(nargout)
case 1
varargout = {one of one};
case 2
varargout = {one of two,two of two};
case 3
varargout = {one of three,two of three,three of three};
end
Chapter 14
OpenGL Models
GLASSEMBLY Create a GL Assembly
GLCLUMP Create a GL Clump
GLDEFMATERIAL Defines a GL Material
GLLINES Create a GL Lineset
GLNODE Create a GL Node
14.1
14.1.1
Usage
Define a GL Assembly. A GL Assembly consists of one or more GL Nodes or GL Assemblies that are placed
relative to the coordinate system of the assembly. For example, if we have glnode definitions for bread
and cheese, then a glassembly of sandwich would consist of placements of two bread nodes with a
cheese node in between. Furthermore, a lunch assembly could consist of a sandwich a chips
and soda. Hopefully, you get the idea. The syntax for the glassembly command is
glassembly(name,part1,transform1,part2,transform2,...)
where part1 is the name of the first part, and could be either a glnode or itself be another glassembly. Here
transform1 is the 4 x 4 matrix that transforms the part into the local reference coordinate system.
WARNING!! Currently FreeMat does not detect or gracefully handle self-referential assemblies (i.e, if you try to
make a sandwich contain a sandwich, which you can do by devious methods that I refuse to explain). Do not
do this! You have been warned.
14.2
14.2.1
Usage
Defines an aggregate clump of objects that can be treated as a node. A GL Clump is defined by a vector consisting
of the following elements:
[r1 g1 b1 n1 p1 p2 p3 ... r2 g2 b2 n2 p1 p2 p3 ... ]
170
OpenGL Models
i.e., an RGB color spec, followed by a point count ni, followed by a length ni vector of coordinates that are x,y,z
triplets. The usage of this function is
glclump(name,vector)
where name is the name of the clump and vector is the aforementioned vector of points.
14.3
14.3.1
Usage
where name is the name of the material, and ambient is a 4 x 1 vector containing the ambient component of
the material property, and diffuse is a 4 x 1 vector and specular is a 4 x 1 vector containing the specular
component of the material properties and shininess is the exponent that governs the shinines of the material.
14.4
14.4.1
Usage
Defines a set of lines that can be treated as a node. A GL Lines is defined by a vector consisting of the following
elements:
[m1 x1 y1 z1 ... xn yn zn m2 x1 y1 z1 .... ]
i.e., a point count followed by that number of triplets. The usage of this function is
gllines(name,vector,color)
where name is the name of the lineset and vector is the aforementioned vector of points.
14.5
14.5.1
Usage
Define a GL Node. A GL Node is an object that can be displayed in a GL Window. It is defined by a triangular mesh
of vertices. It must also have a material that defines its appearance (i.e. color, shininess, etc.). The syntax for the
glnode command is
glnode(name,material,pointset)
where material is the name of a material that has already been defined with gldefmaterial, pointset is
a 3 x N matrix of points that define the geometry of the object. Note that the points are assumed to be connected
in triangular facts, with the points defined counter clock-wise as seen from the outside of the facet. FreeMat will
compute the normals. The name argument must be unique. If you want multiple instances of a given glnode in
your GLWindow, that is fine, as instances of a glnode are created through a glassembly.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
Chapter 15
Handle-Based Graphics
AXES Create Handle Axes
AXIS Setup Axis Behavior
AXISPROPERTIES Axis Object Properties
CLA Clear Current Axis
CLABEL Add Labels To Contour Plot
CLF Clear Figure
CLIM Adjust Color limits of plot
CLOSE Close Figure Window
COLORBAR Add Colorbar to Current Plot
COLORMAP Image Colormap Function
COLORSPEC Color Property Description
CONTOUR Contour Plot Function
CONTOUR3 3D Contour Plot Function
COPPER Copper Colormap
COPY Copy Figure Window
COUNTOUR Contour Object Properties
DATACURSORMODE Interactive Data Cursor
DRAWNOW Flush the Event Queue
FIGLOWER Lower a Figure Window
FIGRAISE Raise a Figure Window
FIGURE Figure Window Select and Create Function
FIGUREPROPERTIES Figure Object Properties
GCA Get Current Axis
GCF Get Current Figure
GET Get Object Property
GLSHOW Show a GL Assembly in a GL Window
172
Handle-Based Graphics
GRAY Gray Colormap
GRID Plot Grid Toggle Function
HCONTOUR Create a contour object
HIMAGE Create a image object
HIST Histogram Function
HLINE Create a line object
HOLD Plot Hold Toggle Function
HPATCH Create a patch object
HPOINT Get Point From Window
HRAWPLOT Generate a Raw Plot File
HSURFACE Create a surface object
HTEXT Create a text object
HTEXTBITMAP Get Text Rendered as a Bitmap
IMAGE Image Display Function
IMAGEPROPERTIES Image Object Properties
IMAGESC Image Display Function
IS2DVIEW Test Axes For 2D View
ISHOLD Test Hold Status
LEGEND Add Legent to Plot
LINE Line Display Function
LINEPROPERTIES Line Series Object Properties
LOGLOG Log-Log Plot Function
NEWPLOT Get Handle For Next Plot
PATCH Patch Graphics Function
PCOLOR Pseudocolor Plot
PLOT Plot Function
PLOT3 Plot 3D Function
POINT Get Axis Position From Mouse Click
PRINT Print a Figure To A File
PVALID Validate Property Name
SEMILOGX Semilog X Axis Plot Function
SEMILOGY Semilog Y Axis Plot Function
SET Set Object Property
SIZEFIG Set Size of Figure
SUBPLOT Subplot Function
SURF Surface Plot Function
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
173
15.1
15.1.1
Usage
This function has three different syntaxes. The first takes no arguments,
h = axes
and creates a new set of axes that are parented to the current figure (see gcf). The newly created axes are made
the current axes (see gca) and are added to the end of the list of children for the current figure. The second form
takes a set of property names and values
h = axes(propertyname,value,propertyname,value,...)
Creates a new set of axes, and then sets the specified properties to the given value. This is a shortcut for calling
set(h,propertyname,value) for each pair. The third form takes a handle as an argument
axes(handle)
and makes handle the current axes, placing it at the head of the list of children for the current figure.
15.2
174
15.2.1
Handle-Based Graphics
Usage
Control the axis behavior. There are several versions of the axis command based on what you would like the axis
command to do. The first versions set scalings for the current plot. The general syntax for its use is
axis([xmin xmax ymin ymax zmin zmax cmin cmax])
which sets the limits in the X, Y, Z and color axes. You can also set only the X, Y and Z axes:
axis([xmin xmax ymin ymax zmin zmax])
The next option sets all of the axis limits to manual mode. This state turns off automatic scaling of the axis based
on the children of the current axis object.
axis manual
The next option sets the axis limits to fit tightly around the data.
axis tight
The next option adjusts the axis limits and plotbox aspect ratio so that the axis fills the position rectangle.
axis fill
The next option puts the axis in matrix mode. This mode is equivalent to the standard mode, but with the vertical
axis reversed. Thus, the origin of the coordinate system is at the top left corner of the plot. This mode makes plots
of matrix elements look normal (i.e., an identity matrix goes from upper left to lower right).
axis ij
The next option puts the axis in normal mode, with the origin at the lower left corner.
axis xy
The next option sets the axis parameters (specifically the data aspect ratio) so that equal ticks on each axis represent
equal length. In this mode, spheres look spherical insteal of ellipsoidal.
axis equal
The next option is the same as axis equal, but sets the plot box to fit tightly around the data (so no background
shows through). It is the best option to use when displaying images.
axis image
175
The next option restores many of the normal characteristics of the axis. In particular, it undoes the effects of
square image and equal modes.
axis normal
The next mode freezes axis properties so that 3D objects can be rotated properly.
axis vis3d
The next mode turns off all labels, tick marks and background.
axis on
The next mode turns on all labels, tick marks and background.
axis off
The next mode is similar to axis off, but also repacks the figure as tightly as possible. The result is a plot box
that takes up the entire outerposition vector.
axis maximal
The axis command can also be applied to a particular axis (as opposed to the current axis as returned by gca)
handle
axis(M,...)
15.3
15.3.1
Usage
176
Handle-Based Graphics
cameraupvectormode - {auto,manual} - For manual mode, the camera up vector is picked
up from the cameraupvector. The auto mode chooses the up vector to point along the positive y axis.
cameraviewangle - scalar - Not used.
cameraviewanglemode - {auto,manual} - Not used.
children - vector of handles - A vector containing handles to children of the current axis. Be
careful as to how you manipulate this vector. FreeMat uses a reference counting mechanism for graphics
objects, so if you remove a handle from the children property of an axis, and you have not added it to the
children property of another object, it will be deleted.
clim - two vector - The color range vector. This vector contains two values that dictate how children of
this axis get mapped to the colormap. Values between the two endpoints of this vector are mapped to the
extremes of the colormap.
climmode - {auto,manual} - For auto mode, the color limits are chosen to span the colordata
for all of the children objects. For manual mode, the color mapping is based on clim.
clipping - {on,off} - Not used.
color - colorspec - The color used to draw the background box for the axes. Defaults to white.
colororder - color vector - A vector of color specs (in RGB) that are cycled between when drawing
line plots into this axis. The default is order blue,green,red,cyan,magenta,yellow,black.
datalimits - six vector - A vector that contains the x, y and z limits of the data for children of the
current axis. Changes to this property are ignored - it is calculated by FreeMat based on the datasets.
dataaspectratio - three vector - A vector that describes the aspect ratio of the data. You can
think of this as the relative scaling of units for each axis. For example, if one unit along the x axis is twice as
long as one unit along the y axis, you would specify a data aspect ratio of [2,1,1].
dataaspectratiomode - {auto,manual} - When the data aspect ratio is set to manual, the
data is scaled by the data aspect ratio before being plotted. When the data aspect ratio mode is auto a
complex set of rules are applied to determine how the data should be scaled. If dataaspectratio mode
is auto and plotboxaspectratio is auto, then the default data aspect ratio is set to [1,1,1] and
the default plot box aspect ratio is chosen proportional to [xrange,yrange,zrange], where xrange is
the span of data along the x axis, and similarly for yrange and zrange. If plotboxaspectratio is set
to [px,py,pz], then the dataaspectratio is set to [xrange/px,yrange/py,zrange/pz].
If one of the axes has been specified manually, then the data will be scaled to fit the axes as well as possible.
fontangle - {normal,italic,oblique} - The angle of the fonts used for text labels (e.g.,
tick labels).
fontsize - scalar - The size of fonts used for text labels (tick labels).
fontunits - Not used.
fontweight - {normal,bold,light,demi} - The weight of the font used for tick labels.
gridlinestyle - {-,-,:,-.,none} - The line style to use for drawing the grid lines.
Defaults to :.
handlevisibility - Not used.
hittest - Not used.
interruptible - Not used.
layer - Not used.
linestyleorder - linestyle vector - A vector of linestyles that are cycled through when plotted
line series.
linewidth - scalar - The width of line used to draw grid lines, axis lines, and other lines.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
177
minorgridlinestyle - {-,-,:,-.,none} - The line style used for drawing grid lines
through minor ticks.
nextplot - {add,replace,replacechildren} - Controls how the next plot interacts with
the axis. If it is set to add the next plot will be added to the current axis. If it is set to replace the
new plot replaces all of the previous children.
outerposition - four vector - Specifies the coordinates of the outermost box that contains the axis
relative to the containing figure. This vector is in normalized coordinates and corresponds to the x, y,
width, height coordinates of the box.
parent - handle - The handle for the containing object (a figure).
plotboxaspectratio - three vector - Controls the aspect ratio of the plot box. See the entry
under dataaspectratio for details on how FreeMat uses this vector in combination with the axis limits
and the plotboxaspectratio to determine how to scale the data.
plotboxaspectratiomode - {auto,manual} - The plot box aspect ratio mode interacts with
the dataaspectratiomode and the axis limits.
position - fourvector - The normalized coordinates of the plot box space. Should be inside the
rectable defined by outerposition.
positionmode - {auto,manual} - the position mode is normally auto which means that
FreeMat computes the position vector to fit the plot inside the outerposition vector. If you set the
position vector manually (using a set command), this mode flag becomes manual and remains
that way until reset to @|auto.
projection - Not used.
selected - Not used.
selectionhighlight - Not used.
tag - A string that can be set to tag the axes with a name.
textheight - scalar - This value is set by FreeMat to the height of the current font in pixels.
tickdir - {in,out} - The direction of ticks. Defaults to in for 2D plots, and out for 3D plots
if tickdirmode is auto.
tickdirmode - {auto,manual} - When set to auto the tickdir defaults to in for 2D
plots, and out for 3D plots.
ticklength - two vector - The first element is the length of the tick in 2D plots, and the second is the
length of the tick in the 3D plots. The lengths are described as fractions of the longer dimension (width or
height).
tightinset - Not used.
title - handle - The handle of the label used to represent the title of the plot.
type - string - Takes the value of axes for objects of the axes type.
units - Not used.
userdata - array - An arbitrary array you can set to anything you want.
visible - {on,off} - If set to on the axes are drawn as normal. If set to off, only the
children of the axes are drawn. The plot box, axis lines, and tick labels are not drawn.
xaxislocation - {top,bottom} - Controls placement of the x axis.
yaxislocation - {left,right} - Controls placement of the y axis.
xcolor - colorspec - The color of the x elements including the the x axis line, ticks, grid lines and tick
labels
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
178
Handle-Based Graphics
ycolor - colorspec - The color of the y elements including the the y axis line, ticks, grid lines and tick
labels.
zcolor - colorspec - The color of the z elements including the the z axis line, ticks, grid lines and tick
labels.
xdir - {normal,reverse} - For normal, axes are drawn as you would expect (e.g, in default
2D mode, the x axis has values increasing from left to right. For reverse, the x axis has values increasing
from right to left.
ydir - {normal,reverse} - For normal, axes are drawn as you would expect (e.g, in default 2D
mode, the y axis has values increasing from bottom to top. For reverse, the y axis has values increasing
from top to bottom.
zdir - {normal,reverse} - For normal, axes are drawn as you would expect. In default 3D
mode, the z axis has values increasing in some direction (usually up). For reverse the z axis increases in
the opposite direction.
xgrid - {on,off} - Set to on to draw grid lines from ticks on the x axis.
ygrid - {on,off} - Set to on to draw grid lines from ticks on the y axis.
zgrid - {on,off} - Set to on to draw grid lines from ticks on the z axis.
xlabel - handle - The handle of the text label attached to the x axis. The position of that label and the
rotation angle is computed automatically by FreeMat.
ylabel - handle - The handle of the text label attached to the y axis. The position of that label and the
rotation angle is computed automatically by FreeMat.
zlabel - handle - The handle of the text label attached to the z axis. The position of that label and the
rotation angle is computed automatically by FreeMat.
xlim - two vector - Contains the limits of the data along the x axis. These are set automatically for
xlimmode. When manually set it allows you to zoom into the data. The first element of this vector should
be the smallest x value you want mapped to the axis, and the second element should be the largest.
ylim - two vector - Contains the limits of the data along the y axis. These are set automatically for
ylimmode. When manually set it allows you to zoom into the data. The first element of this vector should
be the smallest y value you want mapped to the axis, and the second element should be the largest.
zlim - two vector - Contains the limits of the data along the z axis. These are set automatically for
zlimmode. When manually set it allows you to zoom into the data. The first element of this vector should
be the smallest z value you want mapped to the axis, and the second element should be the largest.
xlimmode - {auto,manual} - Determines if xlim is determined automatically or if it is determined manually. When determined automatically, it is chosen to span the data range (at least).
ylimmode - {auto,manual} - Determines if ylim is determined automatically or if it is determined manually. When determined automatically, it is chosen to span the data range (at least).
zlimmode - {auto,manual} - Determines if zlim is determined automatically or if it is determined manually. When determined automatically, it is chosen to span the data range (at least).
xminorgrid - {on,off} - Set to on to draw grid lines from minor ticks on the x axis.
yminorgrid - {on,off} - Set to on to draw grid lines from minor ticks on the y axis.
zminorgrid - {on,off} - Set to on to draw grid lines from minor ticks on the z axis.
xscale - {linear,log} - Determines if the data on the x axis is linear or logarithmically scaled.
yscale - {linear,log} - Determines if the data on the y axis is linear or logarithmically scaled.
zscale - {linear,log} - Determines if the data on the z axis is linear or logarithmically scaled.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
179
xtick - vector - A vector of x coordinates where ticks are placed on the x axis. Setting this vector allows
you complete control over the placement of ticks on the axis.
ytick - vector - A vector of y coordinates where ticks are placed on the y axis. Setting this vector allows
you complete control over the placement of ticks on the axis.
ztick - vector - A vector of z coordinates where ticks are placed on the z axis. Setting this vector allows
you complete control over the placement of ticks on the axis.
xticklabel - string vector - A string vector, of the form stringstring|string| that contains labels
to assign to the labels on the axis. If this vector is shorter than xtick, then FreeMat will cycle through the
elements of this vector to fill out the labels.
yticklabel - string vector - A string vector, of the form stringstring|string| that contains labels
to assign to the labels on the axis. If this vector is shorter than ytick, then FreeMat will cycle through the
elements of this vector to fill out the labels.
zticklabel - string vector - A string vector, of the form stringstring|string| that contains labels
to assign to the labels on the axis. If this vector is shorter than ztick, then FreeMat will cycle through the
elements of this vector to fill out the labels.
xtickmode - {auto,manual} - Set to auto if you want FreeMat to calculate the tick locations.
Setting xtick will cause this property to switch to manual.
ytickmode - {auto,manual} - Set to auto if you want FreeMat to calculate the tick locations.
Setting ytick will cause this property to switch to manual.
ztickmode - {auto,manual} - Set to auto if you want FreeMat to calculate the tick locations.
Setting ztick will cause this property to switch to manual.
xticklabelmode - {auto,manual} - Set to auto if you want FreeMat to set the tick labels.
This will be based on the vector xtick.
yticklabelmode - {auto,manual} - Set to auto if you want FreeMat to set the tick labels.
This will be based on the vector ytick.
zticklabelmode - {auto,manual} - Set to auto if you want FreeMat to set the tick labels.
This will be based on the vector ztick.
15.4
15.4.1
Usage
15.5
180
Handle-Based Graphics
15.5.1
Usage
The clabel function adds labels to a contour plot Generate contour labels for a contour plot. The syntax for its
use is either:
handles = clabel(contourhandle,property,value,property,value,...)
handles = clabel(contourhandle,vals,property,value,property,value,...)
which only labels those contours indicated by the vector vals. The contourhandle must be the handle to a
contour plot object. The remaining property/value pairs are passed to the text function to control the parameters
of the generated text labels. See the text properties for the details on what can be used in those labels.
15.5.2
-->
-->
-->
-->
Example
[x,y] = meshgrid(linspace(-1,1,50));
z = x.*exp(-(x.^2+y.^2));
h = contour(z);
clabel(h,backgroundcolor,[1,1,.6],edgecolor,[.7,.7,.7]);
which results in
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
181
50
0.2
0.2
35
0.1
-0.1
-0.2
-0.3
0.4
-0
.4
20
0.4
-0.4
25
0.4
0.3
-0.4
30
0.3
0.1
-0.1
.3
-0
40
2
-0.
45
15
-0.2
0
-0.1
10
15
20
25
0.1
30
--> h = contour(z);
--> clabel(h,[-.2,0,.3]);
which results in
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
3
0.
0.2
-0.3
10
35
40
45
50
182
Handle-Based Graphics
50
2
-0.
45
0
40
0.3
35
0.3
30
25
-0.2
20
15
3
0.
10
5
0
-0.2
0
10
15
20
25
30
35
40
45
50
15.6
15.6.1
Usage
This function clears the contents of the current figure. The syntax for its use is
clf
15.7
183
15.7.1
Usage
There are several ways to use clim to adjust the color limits of a plot. The various syntaxes are
clim
clim([lo,hi])
clim(auto)
clim(manual)
clim(mode)
clim(handle,...)
The first form (without arguments), returns a 2-vector containing the current limits. The second form sets the limits
on the plot to [lo,hi]. The third and fourth form set the mode for the limit to auto and manual respectively. In
auto mode, FreeMat chooses the range for the axis automatically. The clim(mode) form returns the current
mode for the axis (either auto or manual).
Switching to manual mode does not change the limits, it simply allows you to modify them (and disables the
automatic adjustment of the limits as more objects are added to the plot). Also, if you specify a set of limits explicitly,
the mode is set to manual
Finally, you can specify the handle of an axis to manipulate instead of using the current one.
15.7.2
Example
Here is an example of using clim to change the effective window and level onto an image. First, the image with
default limits
-->
-->
-->
-->
x = repmat(linspace(-1,1),[100,1]); y = x;
z = exp(-x.^2-y.^2);
image(z);
min(z(:))
ans =
0.1353
--> max(z(:))
ans =
0.9998
which results in
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
184
Handle-Based Graphics
10
20
30
40
50
60
70
80
90
100
10
20
30
40
50
60
70
80
90
100
Next, we change the colorscale of the image using the clim function
--> image(z);
--> clim([0,0.2]);
which results in
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
185
10
20
30
40
50
60
70
80
90
100
10
20
30
40
50
60
70
80
90
100
15.8
15.8.1
Usage
Closes a figure window, either the currently active window, a window with a specific handle, or all figure windows.
The general syntax for its use is
close(handle)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
186
Handle-Based Graphics
in which case the figure window with the speicified handle is closed. Alternately, issuing the command with no
argument
close
is equivalent to closing the currently active figure window. Finally the command
close(all)
15.9
15.9.1
Usage
There are a number of syntaxes for the colorbar command. The first takes no arguments, and adds a vertical
colorbar to the right of the current axes.
colorbar
You can also pass properties to the newly created axes object using the second syntax for colorbar
colorbar(properties...)
15.10
15.10.1
Usage
Changes the colormap for the current figure. The generic syntax for its use is
colormap(map)
where map is a an array organized as 3 N ), which defines the RGB (Red Green Blue) coordinates for each color
in the colormap. You can also use the function with no arguments to recover the current colormap
map = colormap
15.10.2
Internals
Assuming that the contents of the colormap function argument c are labeled as:
r1
r1
c = r1
..
.
g1
g2
g3
..
.
b1
b2
b3
..
.
then these columns for the RGB coordinates of pixel in the mapped image. Assume that the image occupies the
range $[a,b]$. Then the RGB color of each pixel depends on the value $x$ via the following integer
k = 1 + b256
xa
c,
ba
so that a pixel corresponding to image value $x$ will receive RGB color $[r_k,g_k,b_k]$. Colormaps are generally
used to pseudo color images to enhance visibility of features, etc.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
15.10.3
187
Examples
x = linspace(-1,1,512)*ones(1,512);
y = x;
Z = exp(-(x.^2+y.^2)/0.3);
image(Z);
100
200
300
400
500
100
200
300
400
500
188
Handle-Based Graphics
--> image(Z);
100
200
300
400
500
100
200
300
400
500
If we capture the output of the copper command and plot it, we obtain the following result:
--> a = copper;
--> plot(a);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
189
1.1
1
0.9
0.8
0.7
0.6
0.5
0.4
0.3
0.2
0.1
0
50
100
150
200
250
300
Note that in the output that each of the color components are linear functions of the index, with the ratio between
the red, blue and green components remaining constant as a function of index. The result is an intensity map with
a copper tint. We can similarly construct a colormap of our own by defining the three components seperately. For
example, suppose we take three gaussian curves, one for each color, centered on different parts of the index space:
--> t = linspace(0,1,256);
--> A = [exp(-(t-1.0).^2/0.1);exp(-(t-0.5).^2/0.1);exp(-t.^2/0.1)];
--> plot(A);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
190
Handle-Based Graphics
1.1
1
0.9
0.8
0.7
0.6
0.5
0.4
0.3
0.2
0.1
0
50
100
150
200
250
300
The resulting image has dark bands in it near the color transitions.
--> image(Z);
--> colormap(A);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
191
100
200
300
400
500
100
200
300
400
500
These dark bands are a result of the nonuniform color intensity, which we can correct for by renormalizing each
color to have the same norm.
--> w = sqrt(sum(A.^2));
--> sA = diag(1./w)*A;
--> plot(A);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
192
Handle-Based Graphics
1.1
1
0.9
0.8
0.7
0.6
0.5
0.4
0.3
0.2
0.1
0
50
100
150
200
250
300
--> image(Z);
--> colormap(A);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
193
100
200
300
400
500
100
200
300
400
500
15.11
15.11.1
Usage
There are a number of ways of specifying a color value for a color-based property. Examples include line colors,
marker colors, and the like. One option is to specify color as an RGB triplet
set(h,color,[r,g,b])
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
194
Handle-Based Graphics
where r,g,b are between @[0,1] Alternately, you can use color names to specify a color.
none - No color.
y,yellow - The color @[1,1,0]@ in RGB space.
m,magenta - The color @[1,0,1]@ in RGB space.
c,cyan - The color @[0,1,1]@ in RGB space.
r,red - The color @[1,0,0]@ in RGB space.
g,green - The color @[0,1,0]@ in RGB space.
b,blue - The color @[0,0,1]@ in RGB space.
w,white - The color @[1,1,1]@ in RGB space.
k,black - The color @[0,0,0]@ in RGB space.
15.12
15.12.1
Usage
This command generates contour plots. There are several syntaxes for the command. The simplest is
contour(Z)
which generates a contour plot of the data in matrix Z, and will automatically select the contour levels. The x,y
coordinates of the contour default to 1:n and 1:m, where n is the number of columns and m is the number of rows
in the Z matrix. Alternately, you can specify a scalar n
contour(Z,n)
which indicates that you want n contour levels. For more control, you can provide a vector v containing the levels
to contour. If you want to generate a contour for a particular level, you must pass a vector [t,t] where t is the
level you want to contour. If you have data that lies on a particular X,Y grid, you can pass either vectors x,y or
matrices X,Y to the contour function via
contour(X,Y,Z)
contour(X,Y,Z,n)
contour(X,Y,Z,v)
Each form of contour can optionally take a line spec to indicate the color and linestyle of the contours to draw:
contour(...,linespec)
or any of the other forms of contour. Furthermore, you can supply an axis to target the contour plot to (so that
it does not get added to the current axis, which is the default):
contour(axis_handle,...)
Finally, the contour command returns a handle to the newly returned contour plot.
handle = contour(...)
15.12.2
195
Example
Here is a simple example of a contour plot with the default x,y coordinates:
--> [x,y] = meshgrid(linspace(-1,1,25),linspace(-2,2,30));
--> z = x.*exp(-x.^2-y.^2);
--> contour(z)
30
25
20
15
10
10
15
20
25
196
Handle-Based Graphics
2
1.5
1
0.5
0
-0.5
-1
-1.5
-2
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
By default, contours are created at values selected by FreeMat. To provide our own set of contour values (asymmetrically about zero in this case), we supply them as
--> contour(x,y,z,[-.4,0.,3])
which is here
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
197
2
1.5
1
0.5
0
-0.5
-1
-1.5
-2
-0.9
-0.8
-0.7
-0.6
-0.5
-0.4
-0.3
-0.2
-0.1
Also be default, contour uses the current color map and clim limits to determine the coloring of the contours.
Here, we override the color spec so that we have all black contour
--> contour(x,y,z,b-)
which is here
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
198
Handle-Based Graphics
2
1.5
1
0.5
0
-0.5
-1
-1.5
-2
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
15.13
15.13.1
Usage
This command generates contour plots where the lines are plotted in 3D. The syntax for its use is identical to the
contour function. Please see its help for details.
15.13.2
199
Example
[x,y] = meshgrid([-2:.25:2]);
z=x.*exp(-x.^2-y.^2);
contour3(x,y,z,30);
axis square;
view(-15,25)
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
2.5
0
-2.5
-2
-1
200
Handle-Based Graphics
15.14
15.14.1
Usage
y = copper
15.14.2
Example
-->
-->
-->
-->
-->
x = linspace(-1,1,512)*ones(1,512);
y = x;
Z = exp(-(x.^2+y.^2)/0.3);
image(Z);
colormap(copper);
201
100
200
300
400
500
100
200
300
400
500
15.15
15.15.1
Usage
Copies the currently active figure window to the clipboard. The syntax for its use is:
copy
The resulting figure is copied as a bitmap to the clipboard, and can then be pasted into any suitable application.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
202
Handle-Based Graphics
15.16
15.16.1
Usage
15.17
15.17.1
Usage
15.18
203
15.18.1
Usage
The drawnow function can be used to process the events in the event queue of the FreeMat application. The
syntax for its use is
drawnow
Now that FreeMat is threaded, you do not generally need to call this function, but it is provided for compatibility.
15.19
15.19.1
Usage
Lowers a figure window indicated by the figure number. The syntax for its use is
figlower(fignum)
where fignum is the number of the figure to lower. The figure will be lowerd to the bottom of the GUI stack
(meaning that it we be behind other windows). Note that this function does not cause fignum to become the
current figure, you must use the figure command for that. Similarly, if fignum is the current figure, it will remain
the current figure (even though the figure is now behind others).
15.20
15.20.1
Usage
Raises a figure window indicated by the figure number. The syntax for its use is
figraise(fignum)
where fignum is the number of the figure to raise. The figure will be raised to the top of the GUI stack (meaning
that it we be visible). Note that this function does not cause fignum to become the current figure, you must use
the figure command for that.
15.21
15.21.1
Usage
Changes the active figure window to the specified figure number. The general syntax for its use is
figure(number)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
204
Handle-Based Graphics
where number is the figure number to use. If the figure window corresponding to number does not already exist,
a new window with this number is created. If it does exist then it is brought to the forefront and made active. You
can use gcf to obtain the number of the current figure.
Note that the figure number is also the handle for the figure. While for most graphical objects (e.g., axes, lines,
images), the handles are large integers, for figures, the handle is the same as the figure number. This means that
the figure number can be passed to set and get to modify the properties of the current figure, (e.g., the colormap).
So, for figure 3, for example, you can use get(3,colormap) to retrieve the colormap for the current figure.
15.22
15.22.1
Usage
15.23
15.23.1
205
Usage
Returns the handle for the current axis. The syntax for its use is
handle = gca
where handle is the handle of the active axis. All object creation functions will be children of this axis.
15.24
15.24.1
Usage
Returns the figure number for the current figure (which is also its handle, and can be used to set properties of the
current figure using set). The syntax for its use is
figure_number = gcf
where figure_number is the number of the active figure (also the handle of the figure).
Note that figures have handles, just like axes, images, plots, etc. However the handles for figures match the figure
number (while handles for other graphics objects tend to be large, somewhat arbitrary integers). So, to retrieve the
colormap of the current figure, you could use get(gcf,colormap), or to obtain the colormap for figure 3,
use get(3,colormap).
15.25
15.25.1
Usage
This function allows you to retrieve the value associated with a property. The syntax for its use is
value = get(handle,property)
where property is a string containing the name of the property, and value is the value for that property. The
type of the variable value depends on the property being set. See the help for the properties to see what values
you can set.
15.26
15.26.1
Usage
which shows the glassembly named name in a new GL window, with the scale set to scale. Roughly speaking
scale should represent the radial size of the object that you want to see in the window.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
206
Handle-Based Graphics
15.27
15.27.1
Usage
y = gray
15.27.2
Example
-->
-->
-->
-->
-->
x = linspace(-1,1,512)*ones(1,512);
y = x;
Z = exp(-(x.^2+y.^2)/0.3);
image(Z);
colormap(gray);
207
100
200
300
400
500
100
200
300
400
500
15.28
15.28.1
Usage
Toggles the drawing of grid lines on the currently active plot. The general syntax for its use is
grid(state)
208
Handle-Based Graphics
grid(on)
grid(off)
to deactivate the grid lines. If you specify no argument then grid toggles the state of the grid:
grid
grid(handle,...)
15.28.2
Example
--> x = linspace(-1,1);
--> y = cos(3*pi*x);
--> plot(x,y,r-);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
209
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-1
-0.8
-0.6
-0.4
-0.2
0.2
--> plot(x,y,r-);
--> grid on
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
0.4
0.6
0.8
210
Handle-Based Graphics
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
15.29
15.29.1
Usage
Creates a contour object and parents it to the current axis. The syntax for its use is
handle = hcontour(property,value,property,value,...)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
211
where property and value are set. The handle ID for the resulting object is returned. It is automatically added
to the children of the current axis.
15.30
15.30.1
Usage
Creates a image object and parents it to the current axis. The syntax for its use is
handle = himage(property,value,property,value,...)
where property and value are set. The handle ID for the resulting object is returned. It is automatically added
to the children of the current axis.
15.31
15.31.1
Usage
n=hist (y)
n=hist (y,x)
n=hist (y,x,norm)
15.32
15.32.1
Usage
Creates a line object and parents it to the current axis. The syntax for its use is
handle = hline(property,value,property,value,...)
where property and value are set. The handle ID for the resulting object is returned. It is automatically added
to the children of the current axis.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
212
Handle-Based Graphics
15.33
15.33.1
Usage
Toggles the hold state on the currently active plot. The general syntax for its use is
hold(state)
hold(on)
hold(off)
to turn hold off. If you specify no argument then hold toggles the state of the hold:
hold
hold(handle,...)
15.33.2
Internals
The hold function allows one to construct a plot sequence incrementally, instead of issuing all of the plots simultaneously using the plot command.
15.33.3
Example
Here is an example of using both the hold command and the multiple-argument plot command to construct a
plot composed of three sets of data. The first is a plot of a modulated Gaussian.
-->
-->
-->
-->
x = linspace(-5,5,500);
t = exp(-x.^2);
y = t.*cos(2*pi*x*3);
plot(x,y);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
213
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-5
-4
-3
-2
-1
We now turn the hold state to on, and add another plot sequence, this time composed of the top and bottom
envelopes of the modulated Gaussian. We add the two envelopes simultaneously using a single plot command.
The fact that hold is on means that these two envelopes are added to (instead of replace) the current contents
of the plot.
--> plot(x,y);
--> hold on
--> plot(x,t,g-,x,-t,b-)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
214
Handle-Based Graphics
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-5
-4
-3
-2
-1
15.34
15.34.1
Usage
Creates a patch object and parents it to the current axis. The syntax for its use is
handle = hpatch(property,value,property,value,...)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
215
where property and value are set. The handle ID for the resulting object is returned. It is automatically added
to the children of the current axis.
15.35
15.35.1
Usage
This function waits for the user to click on the current figure window, and then returns the coordinates of that click.
The generic syntax for its use is
[x,y] = hpoint
15.36
15.36.1
Usage
This function takes a sequence of commands, and generates a raw plot (to a file) that renders the commands. It is
a useful tool for creating high quality fully customized PDF plots from within FreeMat scripts that are portable. The
syntax for its use
hrawplot(filename,commands)
where filename is the name of the file to plot to, and commands is a cell array of strings. Each entry in the cell
array contains a string with a command text. The commands describe a simple mini-language for describing plots.
The complete dictionary of commands is given
LINE x1 y1 x2 y2 draw a line
FONT name size select a font of the given name and size
TEXT x1 y1 string draw the given text string at the given location
STYLE style select line style (solid or dotted)
PAGE force a new page
SIZE x1 y1 Set the page mapping
BOX x1 y1 x2 y2 draw a filled box covering the given coordinates
HTEXTBOX x1 y1 x2 y2 string Draw a horizontal box with the given string centered in it
VTEXTBOX x1 y1 x2 y2 string Draw a vertical box with the given string centered in it (rotated 90
degrees)
BRUSH string Set the brush color (red,blue, etc)
PEN string Set the pen color
15.37
216
15.37.1
Handle-Based Graphics
Usage
Creates a surface object and parents it to the current axis. The syntax for its use is
handle = hsurface(property,value,property,value,...)
where property and value are set. The handle ID for the resulting object is returned. It is automatically added
to the children of the current axis.
15.38
15.38.1
Usage
Creates a text object and parents it to the current axis. The syntax for its use is
handle = htext(property,value,property,value,...)
where property and value are set. The handle ID for the resulting object is returned. It is automatically added
to the children of the current axis.
15.39
15.39.1
Usage
This function takes a fontname, a size, and a text string and returns a bitmap containing the text. The generic syntax
for its use is
bitmap = htextbitmap(fontname,size,text)
where the output bitmap contains the text rendered into a matrix.
15.40
15.40.1
Usage
where x is a two vector containing the x coordinates of the first and last pixels along a column, and y is a two vector
containing the y coordinates of the first and last pixels along a row. The matrix C constitutes the image data. It must
either be a scalar matrix, in which case the image is colormapped using the colormap for the current figure. If the
matrix is M x N x 3, then C is intepreted as RGB data, and the image is not colormapped. The properties
argument is a set of property/value pairs that affect the final image. You can also omit the x and y,
handle = image(C, properties...)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
217
in which case they default to x = [1,size(C,2)] and y = [1,size(C,1)]. Finally, you can use the
image function with only formal arguments
handle = image(properties...)
To support legacy FreeMat code, you can also use the following form of image
image(C, zoomfactor)
which is equivalent to image(C) with the axes removed so that the image takes up the full figure window, and the
size of the figure window adjusted to achieve the desired zoom factor using the zoom command.
15.40.2
Example
In this example, we create an image that is 512 x 512 pixels square, and set the background to a noise pattern.
We set the central 128 x 256 pixels to be white.
--> x = rand(512);
--> x((-64:63)+256,(-128:127)+256) = 1.0;
--> figure
ans =
1
--> image(x)
--> colormap(gray)
218
Handle-Based Graphics
100
200
300
400
500
100
200
300
400
500
-->
-->
-->
-->
-->
-->
-->
-->
t = linspace(0,1);
red = t*t;
green = t*(t.^2);
blue = t*(0*t+1);
A(:,:,1) = red;
A(:,:,2) = green;
A(:,:,3) = blue;
image(A);
219
10
20
30
40
50
60
70
80
90
100
10
20
30
40
50
60
70
80
90
100
15.41
15.41.1
Usage
220
Handle-Based Graphics
Otherwise, the transparency of each pixel is determined by the corresponding value from the alphadata
vector.
alphadatamapping - {scaled,direct,none} - For none mode (the default), no transparency is applied to the data. For direct mode, the vector alphadata contains values between @[0,M1]| where M is the length of the alpha map stored in the figure. For scaled mode, the alim vector for the
figure is used to linearly rescale the alpha data prior to lookup in the alpha map.
cdata - array - This is either a M x N array or an M x N x 3 array. If the data is M x N the image
is a scalar image (indexed mode), where the color associated with each image pixel is computed using the
colormap and the cdatamapping mode. If the data is M x N x 3 the image is assumed to be in RGB
mode, and the colorpanes are taken directly from cdata (the colormap is ignored). Note that in this case,
the data values must be between @[0,1]| for each color channel and each pixel.
cdatamapping - {scaled,direct} - For scaled (the default), the pixel values are scaled
using the clim vector for the figure prior to looking up in the colormap. For direct mode, the pixel values
must be in the range [0,N-1 where N is the number of colors in the colormap if the data is integer type. For
floating point data types, values must be in the range [1,N].
children - Not used.
parent - handle - The axis containing the image.
tag - string - You can set this to any string you want.
type - string - Set to the string image.
xdata - two vector - contains the x coordinates of the first and last column (respectively). Defaults to
[1,C] where C is the number of columns in the image.
ydata - two vector - contains the y coordinates of the first and last row (respectively). Defaults to
[1,R] where R is the number of rows in the image.
userdata - array - Available to store any variable you want in the handle object.
visible - {on,off} - Controls whether the image is visible or not.
15.42
15.42.1
Usage
where x is a two vector containing the x coordinates of the first and last pixels along a column, and y is a two vector
containing the y coordinates of the first and last pixels along a row. The matrix C constitutes the image data. It must
either be a scalar matrix, in which case the image is colormapped using the colormap for the current figure. If the
matrix is M x N x 3, then C is intepreted as RGB data, and the image is not colormapped. The clim argument
is a pairs [low high] that specifies scaling. You can also omit the x and y,
handle = imagesc(C, clim)
in which case they default to x = [1,size(C,2)] and y = [1,size(C,1)]. Finally, you can use the
image function with only formal arguments
handle = imagesc(properties...)
15.42.2
221
Example
In this example, we create an image that is 512 x 512 pixels square, and set the background to a noise pattern.
We set the central 128 x 256 pixels to be white.
--> x = rand(512);
--> x((-64:63)+256,(-128:127)+256) = 1.0;
--> figure
ans =
1
--> imagesc(x,[0 .5])
--> colormap(gray)
15.43
15.43.1
Usage
This function returns true if the current axes are in a 2-D view, and false otherwise. The generic syntax for its use
is
y = is2dview(x)
15.44
15.44.1
Usage
Returns the state of the hold flag on the currently active plot. The general syntax for its use is
ishold
15.45
15.45.1
Usage
This command adds a legend to the current plot. Currently, the following forms of the legend command are
supported. The first form creates a legend with the given labels for the data series:
legend(label1,label2,...)
where label1 is the text label associated with data plot 1 and so on. You can also use the legend command
to control the appearance of the legend in the current plot. To remove the legend from the current plot, use
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
222
Handle-Based Graphics
legend(off)
To hide the legend for the current plot (but do not remove it)
legend(hide)
You can also toggle the display of the box surrounding the legend. Use
legend(boxoff)
or
legend(boxon)
to turn the legend box off or on, respectively. To toggle the visible state of the current legend, use
legend(toggle)
Specifying no arguments at all (apart from an optional location argument as specified below) results in the legend
being rebuilt. This form is useful for picking up font changes or relocating the legend.
legend
By default, the legend command places the new legend in the upper right corner of the current plot. To change
this behavior, use the location specifier (must be the last two options to the command)
legend(...,location,option)
15.46
15.46.1
Usage
where...
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
15.47
223
15.47.1
Usage
15.48
224
15.48.1
Handle-Based Graphics
Usage
This command has the exact same syntax as the plot command:
in fact, it is a simple wrapper around plot that sets the x and y axis to have a logarithmic scale.
15.48.2
Example
--> x = linspace(1,100);
--> y = x;
--> plot(x,y,r-);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
225
100
90
80
70
60
50
40
30
20
10
0
10
20
30
40
50
60
--> loglog(x,y,r-);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
70
80
90
100
226
Handle-Based Graphics
1.0e+2
1.0e+1
1.0e+0
1.0e+0
1.0e+1
1.0e+2
15.49
15.49.1
Usage
Returns the handle for the next plot operation. The general syntax for its use is
h = newplot
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
227
This routine checks the nextplot properties of the current figure and axes to see if they are set to replace
or not. If the figures nextplot property is set to replace, the current figure is cleared. If the axes nextplot
property is set to replace then the axes are cleared for the next operation.
15.50
15.50.1
Usage
This routine is used to create a patch object that can be plotting 2D and 3D surfaces. A patch is a polygon defined
by the xyz coordinates of its vertices and optionally by the color at the vertices. There are several forms for the
patch function:
h
h
h
h
=
=
=
=
patch(X,Y,C,properties...)
patch(X,Y,Z,C,properties...)
patch(properties...)
patch(V)
Where X, Y and Z are matrices or vectors of x, y or z coordinates and C is a matrix or vector of color values (the
colormap for the current fig is applied).
15.50.2
Example
-->
-->
-->
-->
-->
-->
x = [ 0 1 0 1];
y = [ 0 0 1 1];
c = [ 1 1 1 ];
patch(x,y,c)
axis equal
view(3)
228
Handle-Based Graphics
1.6
1.4
1.2
1
0.8
0.6
0.4
0
0.2
0.4
0.6
0.8
0.2
0.4
0.6
0.8
15.51
15.51.1
Usage
This routine is used to create a pseudocolor plot of the data. A pseudocolor plot is a essentially a surface plot seen
from above. There are two forms for the pcolor command:
pcolor(C)
which uses a rectangular grid. Alternately, you can specify X,Y matrices or vectors.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
229
pcolor(X,Y,C)
15.52
15.52.1
Usage
This is the basic plot command for FreeMat. The general syntax for its use is
plot(\<data 1\>,{linespec 1},\<data 2\>,{linespec 2}...,properties...)
where the <data> arguments can have various forms, and the linespec arguments are optional. We start with
the <data> term, which can take on one of multiple forms:
Vector Matrix Case In this case the argument data is a pair of variables. A set of x coordinates in a numeric
vector, and a set of y coordinates in the columns of the second, numeric matrix. x must have as many
elements as y has columns (unless y is a vector, in which case only the number of elements must match).
Each column of y is plotted sequentially against the common vector x.
Unpaired Matrix Case In this case the argument data is a single numeric matrix y that constitutes the yvalues of the plot. An x vector is synthesized as x = 1:length(y), and each column of y is plotted
sequentially against this common x axis.
Complex Matrix Case Here the argument data is a complex matrix, in which case, the real part of each
column is plotted against the imaginary part of each column. All columns receive the same line styles.
Multiple data arguments in a single plot command are treated as a sequence, meaning that all of the plots are
overlapped on the same set of axes. The linespec is a string used to change the characteristics of the line.
In general, the linespec is composed of three optional parts, the colorspec, the symbolspec and the
linestylespec in any order. Each of these specifications is a single character that determines the corresponding characteristic. First, the colorspec:
b - Color Blue
g - Color Green
r - Color Red
c - Color Cyan
m - Color Magenta
y - Color Yellow
k - Color Black
The symbolspec specifies the (optional) symbol to be drawn at each data point:
. - Dot symbol
o - Circle symbol
x - Times symbol
+ - Plus symbol
- Asterisk symbol
s - Square symbol
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
230
Handle-Based Graphics
d - Diamond symbol
The linestylespec specifies the (optional) line style to use for each data series:
For sequences of plots, the linespec is recycled with color order determined by the properties of the current
axes. You can also use the properties argument to specify handle properties that will be inherited by all of the
plots generated during this event. Finally, you can also specify the handle for the axes that are the target of the
plot operation.
handle = plot(handle,...)
15.52.2
Example
The most common use of the plot command probably involves the vector-matrix paired case. Here, we generate
a simple cosine, and plot it using a red line, with no symbols (i.e., a linespec of r-).
--> x = linspace(-pi,pi);
--> y = cos(x);
--> plot(x,y,r-);
231
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-4
-3
-2
-1
Next, we plot multiple sinusoids (at different frequencies). First, we construct a matrix, in which each column
corresponds to a different sinusoid, and then plot them all at once.
--> x = linspace(-pi,pi);
--> y = [cos(x(:)),cos(3*x(:)),cos(5*x(:))];
--> plot(x,y);
In this case, we do not specify a linespec, so that we cycle through the colors automatically (in the order listed
in the previous section).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
232
Handle-Based Graphics
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-4
-3
-2
-1
This time, we produce the same plot, but as we want to assign individual linespecs to each line, we use a
sequence of arguments in a single plot command, which has the effect of plotting all of the data sets on a common
axis, but which allows us to control the linespec of each plot. In the following example, the first line (harmonic)
has red, solid lines with times symbols marking the data points, the second line (third harmonic) has blue, solid lines
with right-pointing triangle symbols, and the third line (fifth harmonic) has green, dotted lines with asterisk symbols.
--> plot(x,y(:,1),rx-,x,y(:,2),b>-,x,y(:,3),g*:);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
233
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-4
-3
-2
-1
The second most frequently used case is the unpaired matrix case. Here, we need to provide only one data
component, which will be automatically plotted against a vector of natural number of the appropriate length. Here,
we use a plot sequence to change the style of each line to be dotted, dot-dashed, and dashed.
--> plot(y(:,1),r:,y(:,2),b;,y(:,3),g|);
Note in the resulting plot that the x-axis no longer runs from [-pi,pi], but instead runs from [1,100].
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
234
Handle-Based Graphics
140
120
100
80
60
40
20
0
-20
-20
20
40
60
80
100
The final case is for complex matrices. For complex arguments, the real part is plotted against the imaginary part.
Hence, we can generate a 2-dimensional plot from a vector as follows.
235
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
Here is an example of using the handle properties to influence the behavior of the generated lines.
--> t = linspace(-3,3);
--> plot(cos(5*t).*exp(-t),r-,linewidth,3);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
236
Handle-Based Graphics
15
10
5
0
-5
-10
-15
-20
10
20
30
40
50
60
70
80
90
100
15.53
15.53.1
Usage
This is the 3D plot command. The general syntax for its use is
plot3(X,Y,Z,{linespec 1},X,Y,Z,{linespec 2},...,properties...)
where X Y and Z are the coordinates of the points on the 3D line. Note that in general, all three should be vectors.
If some or all of the quantities are matrices, then FreeMat will attempt to expand the vector arguments to the same
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
237
size, and then generate multiple plots, one for each column of the matrices. The linespec is optional, see plot for
details. You can specify properties for the generated line plots. You can also specify a handle as an axes to
target
plot3(handle,...)
15.53.2
Example
-->
-->
-->
-->
t = linspace(0,5*pi,200);
x = cos(t); y = sin(t); z = t;
plot3(x,y,z);
view(3);
Shown here
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
238
Handle-Based Graphics
16
14
12
10
8
6
4
2
0
-1 -0.8 -0.6 -0.4 -0.2 0
0
-1 -0.8-0.6-0.4-0.2
0.2 0.4 0.6 0.8
15.54
15.54.1
Usage
Returns information about the currently displayed image based on a use supplied mouse-click. The general syntax
for its use is
t = point
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
239
t = [x, y]
where x,y are the coordinates in the current axes of the click. This function has changed since FreeMat 1.10. If
the click is not inside the active area of any set of axes, a pair of NaNs are returned.
15.55
15.55.1
Usage
This function prints the currently active fig to a file. The generic syntax for its use is
print(filename)
or, alternately,
print filename
where filename is the (string) filename of the destined file. The current fig is then saved to the output file using a
format that is determined by the extension of the filename. The exact output formats may vary on different platforms,
but generally speaking, the following extensions should be supported cross-platform:
jpg, jpeg JPEG file
pdf Portable Document Format file
png Portable Net Graphics file
svg Scalable Vector Graphics file
Postscript (PS, EPS) is supported on non-Mac-OSX Unix only. Note that only the fig is printed, not the window
displaying the fig. If you want something like that (essentially a window-capture) use a seperate utility or your
operating systems built in screen capture ability.
15.55.2
Example
Here is a simple example of how the figures in this manual are generated.
-->
-->
-->
-->
-->
x = linspace(-1,1);
y = cos(5*pi*x);
plot(x,y,r-);
print(printfig1.jpg)
print(printfig1.eps)
which creates three plots printfig.eps, which is an Encapsulated PostScript file, printfig1.png, which is
a Portable Net Graphics file, and printfig1.jpg which is a JPEG file.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
240
Handle-Based Graphics
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
15.56
15.56.1
Usage
This function checks to see if the given string is a valid property name for an object of the given type. The syntax
for its use is
b = pvalid(type,propertyname)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
241
where string is a string that contains the name of a valid graphics object type, and propertyname is a string
that contains the name of the property to test for.
15.56.2
Example
--> pvalid(axes,type)
ans =
1
--> pvalid(axes,children)
ans =
1
--> pvalid(axes,foobar)
ans =
0
15.57
15.57.1
Usage
This command has the exact same syntax as the plot command:
in fact, it is a simple wrapper around plot that sets the x axis to have a logarithmic scale.
15.57.2
Example
--> y = linspace(0,2);
--> x = (10).^y;
--> plot(x,y,r-);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
242
Handle-Based Graphics
2.2
2
1.8
1.6
1.4
1.2
1
0.8
0.6
0.4
0.2
0
10
20
30
40
50
60
70
80
90
100
--> semilogx(x,y,r-);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
243
2.2
2
1.8
1.6
1.4
1.2
1
0.8
0.6
0.4
0.2
0
1.0e+0
1.0e+1
1.0e+2
15.58
15.58.1
Usage
This command has the exact same syntax as the plot command:
semilogy(<data 1>,{linespec 1},<data 2>,{linespec 2}...,properties...)
in fact, it is a simple wrapper around plot that sets the y axis to have a logarithmic scale.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
244
15.58.2
Handle-Based Graphics
Example
100
90
80
70
60
50
40
30
20
10
0
0.2
0.4
0.6
0.8
1.2
1.4
1.6
1.8
2.2
245
1.0e+2
1.0e+1
1.0e+0
0.2
0.4
0.6
0.8
1.2
1.4
1.6
1.8
2.2
15.59
15.59.1
Usage
This function allows you to change the value associated with a property. The syntax for its use is
set(handle,property,value,property,value,...)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
246
Handle-Based Graphics
where property is a string containing the name of the property, and value is the value for that property. The
type of the variable value depends on the property being set. See the help for the properties to see what values
you can set.
15.60
15.60.1
Usage
The sizefig function changes the size of the currently selected fig window. The general syntax for its use is
sizefig(width,height)
where width and height are the dimensions of the fig window.
15.61
15.61.1
Usage
This function divides the current figure into a 2-dimensional grid, each of which can contain a plot of some kind. The
function has a number of syntaxes. The first version
subplot(row,col,num)
which either activates subplot number num, or sets up a subplot grid of size row x col, and then activates num.
You can also set up subplots that cover multiple grid elements
subplot(row,col,[vec])
where vec is a set of indexes covered by the new subplot. Finally, as a shortcut, you can specify a string with three
components
subplot(mnp)
where m is the number of rows, n is the number of columns and p is the index. You can also specify the location of
the subplot explicitly using the syntax
subplot(position,[left bottom width height])
15.61.2
Example
t = linspace(-pi,pi);
subplot(2,2,1)
plot(t,cos(t).*exp(-2*t));
subplot(2,2,2);
plot(t,cos(t*2).*exp(-2*t));
subplot(2,2,3);
plot(t,cos(t*3).*exp(-2*t));
subplot(2,2,4);
plot(t,cos(t*4).*exp(-2*t));
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
247
200
600
400
-200
200
-400
-600
-4
-2
-200
-4
200
600
400
-200
200
-400
-600
-4
-2
-200
-4
-2
-2
Here we use the second form of subplot to generate one subplot that is twice as large.
-->
-->
-->
-->
-->
-->
-->
t = linspace(-pi,pi);
subplot(2,2,[1,2])
plot(t,cos(t).*exp(-2*t));
subplot(2,2,3);
plot(t,cos(t*3).*exp(-2*t));
subplot(2,2,4);
plot(t,cos(t*4).*exp(-2*t));
248
Handle-Based Graphics
200
0
-200
-400
-600
-4
-3
-2
-1
200
600
400
-200
200
-400
-600
-4
-2
-200
-4
-2
Note that the subplots can contain any handle graphics objects, not only simple plots.
-->
-->
-->
-->
-->
-->
-->
-->
-->
-->
-->
-->
-->
-->
t=0:(2*pi/100):(2*pi);
x=cos(t*2).*(2+sin(t*3)*.3);
y=sin(t*2).*(2+sin(t*3)*.3);
z=cos(t*3)*.3;
subplot(2,2,1)
plot(t,x);
subplot(2,2,2);
plot(t,y);
subplot(2,2,3);
plot(t,z);
subplot(2,2,4);
tubeplot(x,y,z,0.14*sin(t*5)+.29,t,10)
axis equal
view(3)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
249
-1
-1
-2
-2
-3
0
-3
0
0.4
0.2
1
0
-1
-0.2
-0.4
0
-3
-2
2.5
-1
0
3-2.5
15.62
15.62.1
Usage
This routine is used to create a surface plot of data. A surface plot is a 3D surface defined by the xyz coordinates of
its vertices and optionally by the color at the vertices. The most general syntax for the surf function is
h = surf(X,Y,Z,C,properties...)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
250
Handle-Based Graphics
h = surf(X,Y,Z,properties...)
in which case C=Z. You can also eliminate the X and Y matrices in the specification
h = surf(Z,properties)
in which case they are set to 1:size(Z,2) and 1:size(Y,2) respectively. You can also specify a handle as
the target of the surf command via
h = surf(handle,...)
15.62.2
Example
-->
-->
-->
-->
-->
-->
-->
-->
x = repmat(linspace(-1,1),[100,1]);
y = x;
r = x.^2+y.^2;
z = exp(-r*3).*cos(5*r);
c = r;
surf(x,y,z,c)
axis equal
view(3)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
251
-1
1
-1
0
0
1
-1
If we allow FreeMat to specify the color component, we see that the colorfield is the same as the height
--> surf(x,y,z)
--> axis equal
--> view(3)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
252
Handle-Based Graphics
-1
1
-1
0
0
1
-1
15.63
15.63.1
Usage
253
Otherwise, the transparency of each pixel is determined by the corresponding value from the alphadata
vector.
alphadatamapping - {scaled,direct,none} - For none mode (the default), no transparency is applied to the data. For direct mode, the vector alphadata contains values between @[0,M1]| where M is the length of the alpha map stored in the figure. For scaled mode, the alim vector for the
figure is used to linearly rescale the alpha data prior to lookup in the alpha map.
ambientstrength - Not used.
backfacelighting - Not used.
cdata - array - This is either a M x N array or an M x N x 3 array. If the data is M x N the surface
is a scalar surface (indexed mode), where the color associated with each surface pixel is computed using the
colormap and the cdatamapping mode. If the data is M x N x 3 the surface is assumed to be in RGB
mode, and the colorpanes are taken directly from cdata (the colormap is ignored). Note that in this case,
the data values must be between @[0,1]| for each color channel and each point on the surface.
cdatamapping - {scaled,direct} - For scaled (the default), the pixel values are scaled
using the clim vector for the figure prior to looking up in the colormap. For direct mode, the pixel values
must be in the range [0,N-1 where N is the number of colors in the colormap.
children - Not used.
diffusestrength - Not used.
edgealpha - {flat,interp,scalar} - Controls how the transparency is mapped for the
edges of the surface.
edgecolor - {flat,interp,none,colorspec} - Specifies how the edges are colored.
For flat the edges are flat colored, meaning that the line segments that make up the edges are not
shaded. The color for the line is determined by the first edge point it is connected to.
edgelighting - Not used.
facealpha - {flat,interp,texturemap,scalar} - Controls how the transparency of
the faces of the surface are controlled. For flat shading, the faces are constant transparency. For interp
mode, the faces are smoothly transparently mapped. If set to a scalar, all faces have the same transparency.
facecolor - {none,flat,interp,colorspec} - Controls how the faces are colored. For
none the faces are uncolored, and the surface appears as a mesh without hidden lines removed. For
flat the surface faces have a constant color. For interp smooth shading is applied to the surface.
And if a colorspec is provided, then the faces all have the same color.
facelighting - Not used.
linestyle - {-,-,:,-.,none} - The style of the line used to draw the edges.
linewidth - scalar - The width of the line used to draw the edges.
marker - {+,o,,.,x,square,s,diamond,d, ,v,>,<}
- The marker for data points on the line. Some of these are redundant, as square s are synonyms,
and diamond and d are also synonyms.
markeredgecolor - colorspec - The color used to draw the marker. For some of the markers (circle,
square, etc.) there are two colors used to draw the marker. This property controls the edge color (which for
unfilled markers) is the primary color of the marker.
markerfacecolor - colorspec - The color used to fill the marker. For some of the markers (circle,
square, etc.) there are two colors used to fill the marker.
markersize - scalar - Control the size of the marker. Defaults to 6, which is effectively the radius (in
pixels) of the markers.
meshstyle - {both,rows,cols} - This property controls how the mesh is drawn for the surface. For rows and cols modes, only one set of edges is drawn.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
254
Handle-Based Graphics
normalmode - Not used.
parent - handle - The axis containing the surface.
specularcolorreflectance - Not used.
specularexponent - Not used.
specularstrength - Not used.
tag - string - You can set this to any string you want.
type - string - Set to the string surface.
userdata - array - Available to store any variable you want in the handle object.
vertexnormals - Not used.
xdata - array - Must be a numeric array of size M x N which contains the x location of each point in the
defined surface. Must be the same size as ydata and zdata. Alternately, you can specify an array of size
1 x N in which case FreeMat replicates the vector to fill out an M x N matrix.
xdatamode - {auto,manual} - When set to auto then FreeMat will automatically generate the x
coordinates.
ydata - array - Must be a numeric array of size M x N which contains the y location of each point in the
defined surface. Must be the same size as xdata and zdata. Alternately, you can specify an array of size
M x 1 in which case FreeMat replicates the vector to fill out an M x N matrix.
ydatamode - {auto,manual} - When set to auto then FreeMat will automatically generate the y
coordinates.
zdata - array - Must be a numeric array of size M x N which contains the y location of each point in the
defined surface. Must be the same size as xdata and ydata.
visible - {on,off} - Controls whether the surface is visible or not.
15.64
15.64.1
Usage
Adds a text label to the currently active plot. The general syntax for it is use is either
text(x,y,label)
where x and y are both vectors of the same length, in which case the text label is added to the current plot
at each of the coordinates x(i),y(i) (using the current axis to map these to screen coordinates). The second
form supplies a cell-array of strings as the second argument, and allows you to place many labels simultaneously
text(x,y,{label1,label2,....})
where the number of elements in the cell array must match the size of vectors x and y. You can also specify
properties for the labels via
handles = text(x,y,{labels},properties...)
15.64.2
255
Example
0.7
0.6
0.5
hello
there
0.4
0.3
0.2
0.1
0
1.5
2.5
3.5
256
Handle-Based Graphics
0.8
0.7
0.6
hello
0.5
there
0.4
0.3
0.2
0.1
1.5
2.5
3.5
15.65
15.65.1
Usage
257
15.66
258
Handle-Based Graphics
15.66.1
Usage
This command adds a title to the plot. The general syntax for its use is
title(label)
title label
or simply
title label
Here label is a string variable. You can also specify properties for the label, and a handle to serve as a target for
the operation
title(handle,label,properties...)
15.66.2
Example
-->
-->
-->
-->
x = linspace(-1,1);
y = cos(2*pi*x);
plot(x,y,r-);
title(cost over time);
259
-0.8
-0.6
-0.4
-0.2
0.2
0.4
We now increase the size of the font using the properties of the label
0.6
0.8
260
Handle-Based Graphics
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
15.67
15.67.1
Usage
This tubeplot function is from the tubeplot package written by Anders Sandberg. The simplest syntax for the
tubeplot routine is
tubeplot(x,y,z)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
261
plots the basic tube with radius 1, where x,y,z are vectors that describe the tube. If the radius of the tube is to be
varied, use the second form
tubeplot(x,y,z,r)
which plots the basic tube with variable radius r (either a vector or a scalar value). The third form allows you to
specify the coloring using a vector of values:
tubeplot(x,y,z,r,v)
where the coloring is now dependent on the values in the vector v. If you want to create a tube plot with a greater
degree of tangential subdivisions (i.e., the tube is more circular, use the form
tubeplot(x,y,z,r,v,s)
where s is the number of tangential subdivisions (default is 6) You can also use tubeplot to calculate matrices
to feed to mesh and surf.
[X,Y,Z]=tubeplot(x,y,z)
tubeplot(x,y,z,r,v,s,vec)
calculates the tube by setting the normal to the cross product of the tangent and the vector vec. If it is chosen so
that it is always far from the tangent vector the frame will not twist unduly.
15.67.2
Example
-->
-->
-->
-->
-->
t=0:(2*pi/100):(2*pi);
x=cos(t*2).*(2+sin(t*3)*.3);
y=sin(t*2).*(2+sin(t*3)*.3);
z=cos(t*3)*.3;
tubeplot(x,y,z,0.14*sin(t*5)+.29,t,10);
262
Handle-Based Graphics
2.5
2
1.5
1
0.5
0
-0.5
-1
-1.5
-2
-2.5
-2.5
-2
-1.5
-1
-0.5
0.5
1.5
2.5
Written by Anders Sandberg, asa@nada.kth.se, 2005 Website says the package is free for anybody to use.
www.nada.kth.se/asa/Ray/Tubeplot/tubeplot.html
15.68
15.68.1
Usage
Creates a UI control object and parents it to the current figure. The syntax for its use is
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
263
handle = uicontrol(property,value,property,value,...)
where property and value are set. The handle ID for the resulting object is returned. It is automatically added
to the children of the current figure.
15.69
15.69.1
Usage
264
Handle-Based Graphics
max - a scalar that specifies the largest value allowed for the value property. The interpretation varies
depending on the type of the control
check boxes - specifies what value is set to when the check box is selected.
edit box - if max-min>1 then the text box allows for multiple lines of input. Otherwise, it is a single
line only.
list box - if max-min>1 then multiple item selections are allowed. Otherwise, only single item
selections are allowed.
radio buttons - specifies what value is set to when the radio button is selected.
slider - the maximum value the slider can take.
toggle button - specifies what value is set to when the toggle button is selected.
min - a scalar that specifies the smallest value for the value property. The interpretation of it depends on
the type of the control
check boxes - specifies what value is set to when the check box is not selected.
edit box - if max-min>1 then the text box allows for multiple lines of input. Otherwise, it is a single
line only.
list box - if max-min>1 then multiple item selections are allowed. Otherwise, only single item
selections are allowed.
radio buttons - specifies what value is set to when the radio button is not selected.
slider - the minimum value the slider can take.
toggle button - specifies what value is set to when the toggle button is not selected.
parent - the handle of the parent object.
position - size and location of the uicontrol as a four vector [left, bottom, width, height].
If width>height then sliders are horizontal, otherwise the slider is oriented vertically.
selected - {on,off} - not used.
selectionhighlight - {on,off} - not used.
sliderstep - a two vector [min_step max_step] that controls the amount the slider value
changes when you click the mouse on the control. If you click the arrow for the slider, the value changes
by min_step, while if you click the trough, the value changes by max_step. Each value must be in the
range [0,1], and is a percentage of the range max-min.
string - string - the text for the control.
style - @|{pushbutton,toggle,radiobutton,checkbox, edit,text,slider,frame,listbox,popupmenu}|.
tag - string - user specified label.
tooltipstring - string the tooltip for the control.
type - string - the text is set to uicontrol.
uicontextmenu - handle the handle of the uicontextmenu that shows up when you right-click over
the control.
units - not used.
userdata - array - any data you want to associate with the control.
value - The meaning of this property depends on the type of the control:
check box - set to max when checked, and min when off.
list box - set to a vector of indices corresponding to selected items, with 1 corresponding to the first item
in the list.
pop up menu - set to the index of the item selected (starting with 1)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
265
radio buttons - set to max when selected, and set to min when not selected.
sliders - set to the value of the slider
toggle buttons - set to max when selected, and set to min when not selected.
text controls, push buttons - do not use this property.
15.70
15.70.1
Usage
The view function sets the view into the current plot. The simplest form is
view(n)
where n=2 sets a standard view (azimuth 0 and elevation 90), and n=3 sets a standard 3D view (azimuth 37.5 and
elevation 30). With two arguments,
view(az,el)
15.70.2
Example
Here is a 3D surface plot shown with a number of viewpoints. First, the default view for a 3D plot.
-->
-->
-->
-->
-->
-->
-->
x = repmat(linspace(-1,1),[100,1]);
y = x;
r = x.^2+y.^2;
z = exp(-r*3).*cos(5*pi*r);
surf(x,y,z);
axis equal
view(3)
266
Handle-Based Graphics
-1
1
-1
0
0
1
-1
--> surf(x,y,z);
--> axis equal
--> view(2)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
267
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-1
0.2
0.4
--> surf(x,y,z);
--> axis equal
--> view(25,50);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
0.6
0.8
268
Handle-Based Graphics
0
1
-1
0
-1
0
1 -1
15.71
15.71.1
Usage
Adjusts the data range used to map the current image to the current colormap. The general syntax for its use is
winlev(window,level)
where window is the new window, and level is the new level, or
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
269
winlev
in which case it returns a vector containing the current window and level for the active image.
15.71.2
Internals
FreeMat deals with scalar images on the range of [0,1], and must therefor map an arbitrary image x to this range
before it can be displayed. By default, the image command chooses
level =
window
2
This ensures that the entire range of image values in x are mapped to the screen. With the winlev function, you
can change the range of values mapped. In general, before display, a pixel x is mapped to [0,1] via:
x level
max 0, min 1,
window
15.71.3
Examples
The window level function is fairly easy to demonstrate. Consider the following image, which is a Gaussian pulse
image that is very narrow:
-->
-->
-->
-->
t = linspace(-1,1,256);
xmat = ones(256,1)*t; ymat = xmat;
A = exp(-(xmat.^2 + ymat.^2)*100);
image(A);
To see the tail behavior, we use the winlev command to force FreeMat to map a smaller range of A to the
colormap.
--> image(A);
--> winlev(1e-4,0.5e-4)
The result is a look at more of the tail behavior of A. We can also use the winlev function to find out what the window
and level are once set, as in the following example.
--> image(A);
--> winlev(1e-4,0.5e-4)
--> winlev
ans =
1.0000e-04
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
270
Handle-Based Graphics
15.72
15.72.1
Usage
This command adds a label to the x-axis of the plot. The general syntax for its use is
xlabel(label)
xlabel label
or simply
xlabel label
Here label is a string variable. You can also specify properties for that label using the syntax
xlabel(label,properties...)
15.72.2
Example
-->
-->
-->
-->
x = linspace(-1,1);
y = cos(2*pi*x);
plot(x,y,r-);
xlabel(time);
271
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
time
15.73
15.73.1
Usage
There are several ways to use xlim to adjust the X axis limits of a plot. The various syntaxes are
xlim
xlim([lo,hi])
xlim(auto)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
272
Handle-Based Graphics
xlim(manual)
xlim(mode)
xlim(handle,...)
The first form (without arguments), returns a 2-vector containing the current limits. The second form sets the limits
on the plot to [lo,hi]. The third and fourth form set the mode for the limit to auto and manual respectively. In
auto mode, FreeMat chooses the range for the axis automatically. The xlim(mode) form returns the current
mode for the axis (either auto or manual). Finally, you can specify the handle of an axis to manipulate
instead of using the current one.
As an additional feature, you can now specify inf for a limit, and FreeMat will take that limit from the automatic
set. So, for example xlim([10,inf]) will set the minimum for the x axis, but use the automatic value for the
maximum.
15.73.2
-->
-->
-->
-->
Example
x = linspace(-1,1);
y = sin(2*pi*x);
plot(x,y,r-);
xlim % what are the current limits?
ans =
-1 1
which results in
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
273
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-1
-0.8
-0.6
-0.4
-0.2
0.2
--> plot(x,y,r-)
--> xlim([-0.2,0.2])
which results in
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
0.4
0.6
0.8
274
Handle-Based Graphics
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-0.2
-0.15
-0.1
-0.05
0.05
0.1
0.15
0.2
--> plot(x,y,r-);
--> xlim([0,inf])
which results in
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
275
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
0.1
0.2
0.3
0.4
0.5
0.6
0.7
0.8
0.9
15.74
15.74.1
Usage
This command adds a label to the y-axis of the plot. The general syntax for its use is
ylabel(label)
276
Handle-Based Graphics
ylabel label
or simply
ylabel label
You can also specify properties for that label using the syntax
ylabel(label,properties...)
15.74.2
Example
-->
-->
-->
-->
x = linspace(-1,1);
y = cos(2*pi*x);
plot(x,y,r-);
ylabel(cost);
277
1
0.8
0.6
0.4
cost
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
15.75
15.75.1
Usage
There are several ways to use ylim to adjust the Y axis limits of a plot. The various syntaxes are
ylim
ylim([lo,hi])
ylim(auto)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
278
Handle-Based Graphics
ylim(manual)
ylim(mode)
ylim(handle,...)
The first form (without arguments), returns a 2-vector containing the current limits. The second form sets the limits
on the plot to [lo,hi]. The third and fourth form set the mode for the limit to auto and manual respectively. In
auto mode, FreeMat chooses the range for the axis automatically. The ylim(mode) form returns the current
mode for the axis (either auto or manual). Finally, you can specify the handle of an axis to manipulate
instead of using the current one.
As an additional feature, you can now specify inf for a limit, and FreeMat will take that limit from the automatic
set. So, for example ylim([10,inf]) will set the minimum for the y axis, but use the automatic value for the
maximum.
15.75.2
-->
-->
-->
-->
Example
x = linspace(-1,1);
y = sin(2*pi*x);
plot(x,y,r-);
ylim % what are the current limits?
ans =
-0.9999
0.9999
which results in
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
279
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-1
-0.8
-0.6
-0.4
-0.2
0.2
--> plot(x,y,r-)
--> ylim([-0.2,0.2])
which results in
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
0.4
0.6
0.8
280
Handle-Based Graphics
0.2
0.15
0.1
0.05
0
-0.05
-0.1
-0.15
-0.2
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
--> plot(x,y,r-);
--> ylim([0,inf])
which results in
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
281
0.9
0.8
0.7
0.6
0.5
0.4
0.3
0.2
0.1
0
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
15.76
15.76.1
Usage
This command adds a label to the z-axis of the plot. The general syntax for its use is
zlabel(label)
282
Handle-Based Graphics
zlabel label
or simply
zlabel label
Here label is a string variable. You can also specify properties for that label using the syntax
zlabel(label,properties...)
15.76.2
Example
-->
-->
-->
-->
-->
-->
-->
t = linspace(0,5*pi);
x = cos(t);
y = sin(t);
z = t;
plot3(x,y,z,r-);
view(3);
zlabel(time);
283
16
14
12
10
time
8
6
4
2
0
-1 -0.8 -0.6 -0.4 -0.2 0
0
-1 -0.8-0.6-0.4-0.2
0.2 0.4 0.6 0.8
15.77
15.77.1
Usage
There are several ways to use zlim to adjust the Z axis limits of a plot. The various syntaxes are
zlim
zlim([lo,hi])
zlim(auto)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
284
Handle-Based Graphics
zlim(manual)
zlim(mode)
zlim(handle,...)
The first form (without arguments), returns a 2-vector containing the current limits. The second form sets the limits
on the plot to [lo,hi]. The third and fourth form set the mode for the limit to auto and manual respectively. In
auto mode, FreeMat chooses the range for the axis automatically. The zlim(mode) form returns the current
mode for the axis (either auto or manual). Finally, you can specify the handle of an axis to manipulate
instead of using the current one.
15.78
15.78.1
Usage
This function changes the zoom factor associated with the currently active image. It is a legacy support function
only, and thus is not quite equivalent to the zoom function from previous versions of FreeMat. However, it should
achieve roughly the same effect. The generic syntax for its use is
zoom(x)
where x is the zoom factor to be used. The exact behavior of the zoom factor is as follows:
x=0 The image on display is zoomed to fit the size of the image window, but the aspect ratio of the image is
not changed. (see the Examples section for more details). This is the default zoom level for images displayed
with the image command.
x<0 The image on display is zoomed to fit the size of the image window, with the zoom factor in the row and
column directions chosen to fill the entire window. The aspect ratio of the image is not preserved. The exact
value of x is irrelevant.
15.78.2
Example
To demonstrate the use of the zoom function, we create a rectangular image of a Gaussian pulse. We start with a
display of the image using the image command, and a zoom of 1.
-->
-->
-->
-->
-->
x = linspace(-1,1,300)*ones(1,600);
y = ones(300,1)*linspace(-1,1,600);
Z = exp(-(x.^2+y.^2)/0.3);
image(Z);
zoom(1.0);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
285
50
100
150
200
250
300
100
200
300
400
500
600
At this point, resizing the window accomplishes nothing, as with a zoom factor greater than zero, the size of the
image is fixed.
If we change the zoom to another factor larger than 1, we enlarge the image by the specified factor (or shrink it, for
zoom factors 0 < x < 1. Here is the same image zoomed out to 60%
--> image(Z);
--> zoom(0.6);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
286
Handle-Based Graphics
100
200
300
100
200
300
400
500
600
--> image(Z)
--> zoom(1.3);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
287
50
100
150
200
250
300
100
200
300
400
500
600
The free zoom of x = 0 results in the image being zoomed to fit the window without changing the aspect ratio.
The image is zoomed as much as possible in one direction.
--> image(Z);
--> zoom(0);
--> sizefig(200,400);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
288
Handle-Based Graphics
250
200
400
600
The case of a negative zoom x < 0 results in the image being scaled arbitrarily. This allows the image aspect
ratio to be changed, as in the following example.
--> image(Z);
--> zoom(-1);
--> sizefig(200,400);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
289
50
100
150
200
250
300
100
200
300
400
500
600
15.79
15.79.1
Usage
This function makes a zero-pole plot of a discrete-time system defined by its zeros and poles. The various syntaxes
are
zplane(z,p)
where z and p are the zeros and the poles of the system stored as column vectors, or
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
290
Handle-Based Graphics
zplane(b,a)
where a and b are the polynomial coefficients of the numerator and denominator stored as line vectors (roots is
used to find the zeros and poles). The symbol o represents a zero and the symbol x represents a pole. The
plot includes the unit circle for reference. Contributed by Paulo Xavier Candeias under GPL
Chapter 16
Inspection Functions
CLEAR Clear or Delete a Variable
END End Function
EXIST Test for Existence
FIELDNAMES Fieldnames of a Structure
ISA Test Type of Variable
ISCELL Test For Cell Array
ISCELLSTR Test For Cell Array of Strings
ISCHAR Test For Character Array (string)
ISEMPTY Test For Variable Empty
ISEQUAL Test For Matrix Equality
ISEQUALWITHEQUALNANS Test For Matrix Equality
ISFIELD Test for Existence of a Structure Field
ISHANDLE Test for Graphics Handle
ISINF Test for infinities
ISINTTYPE Test For Integer-type Array
ISLOGICAL Test for Logical Array
ISMATRIX Test For a 2D Matrix
ISNAN Test for Not-a-Numbers
ISNUMERIC Test for Numeric Array
ISREAL Test For Real Array
ISSAME Test If Two Arrays Are Identical
ISSCALAR Test For Scalar
ISSET Test If Variable Set
ISSPARSE Test for Sparse Matrix
ISSQUARE Test For a Square matrix
ISSTR Test For Character Array (string)
292
Inspection Functions
ISSTRUCT Test For Structure Array
ISVECTOR Test For a Vector
LENGTH Length of an Array
MAXDIM Maximum Dimension in Array
NDIMS Number of Dimensions in Array
NNZ Number of Nonzeros
NUMEL Number of Elements in an Array
SIZE Size of a Variable
TYPEOF Determine the Type of an Argument
WHAT List FreeMat Files In Directory
WHERE Get Information on Program Stack
WHICH Get Information on Function
WHO Describe Currently Defined Variables
WHOS Describe Currently Defined Variables With Memory Usage
16.1
16.1.1
Usage
Clears a set of variables from the current context, or alternately, delete all variables defined in the current context.
There are several formats for the function call. The first is the explicit form in which a list of variables are provided:
clear a1 a2 ...
The variables can be persistent or global, and they will be deleted. The second form
clear all
clears all variables and libraries from the current context. Alternately, you can use the form:
clear libs
which will unload any libraries or DLLs that have been imported. Optionally, you can specify that persistent
variables should be cleared via:
clear persistent
to clear all definitions of user-defined classes. With no arguments, clear defaults to clearing all.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
16.1.2
293
Example
Here is a simple example of using clear to delete a variable. First, we create a variable called a:
--> a = 53
a =
53
Next, we clear a using the clear function, and verify that it is deleted.
--> clear a
--> a
Error: Undefined function or variable a
16.2
16.2.1
Usage
Computes the size of a variable along a given dimension. The syntax for its use is
y = end(x,dim,subindexes)
where x is the array to be analyzed, dim is the dimension along which to compute the end, and subindexes
indicates how many dimensions are involved in the end calculation.
16.3
16.3.1
Usage
Tests for the existence of a variable, function, directory or file. The general syntax for its use is
y = exist(item,kind)
where item is a string containing the name of the item to look for, and kind is a string indicating the type of the
search. The kind must be one of
builtin checks for built-in functions
dir checks for directories
file checks for files
var checks for variables
all checks all possibilities (same as leaving out kind)
You can also leave the kind specification out, in which case the calling syntax is
y = exist(item)
294
Inspection Functions
0 - if item does not exist
1 - if item is a variable in the workspace
2 - if item is an M file on the search path, a full pathname to a file, or an ordinary file on your search path
5 - if item is a built-in FreeMat function
7 - if item is a directory
Note: previous to version 1.10, exist used a different notion of existence for variables: a variable was said to
exist if it was defined and non-empty. This test is now performed by isset.
16.3.2
Example
Some examples of the exist function. Note that generally exist is used in functions to test for keywords. For
example,
function y = testfunc(a, b, c)
if (~exist(c))
% c was not defined, so establish a default
c = 13;
end
y = a + b + c;
0.6357
1.0468
0.0865
1.7582
-0.6919
1.5704
1.5784
-0.6796
-0.1267
-0.8470
0.4767
2.1381
(:,:,2) =
1.5525
0.1652
0.3147
-0.2908
-0.5668
-0.1109
-1.4220
-0.8018
-0.5203
1.1076
-0.5975
0.5851
0.2419
0.8483
1.1503
--> b = []
b =
[]
--> who
Variable Name
a
b
--> exist(a)
Type
double
double
Flags
Size
[3x5x2]
[0x0]
ans =
1
--> exist(b)
ans =
1
--> exist(c)
ans =
0
16.4
16.4.1
Usage
Returns a cell array containing the names of the fields in a structure array. The syntax for its use is
x = fieldnames(y)
where y is a structure array of object array. The result is a cell array, with one entry per field in y.
16.4.2
Example
16.5
16.5.1
Usage
where x is the variable to test, and type is the type. Supported built-in types are
cell for cell-arrays
struct for structure-arrays
logical for logical arrays
uint8 for unsigned 8-bit integers
int8 for signed 8-bit integers
uint16 for unsigned 16-bit integers
int16 for signed 16-bit integers
uint32 for unsigned 32-bit integers
int32 for signed 32-bit integers
uint64 for unsigned 64-bit integers
int64 for signed 64-bit integers
single for 32-bit floating point numbers
double for 64-bit floating point numbers
char for string arrays
If the argument is a user-defined type (via the class function), then the name of that class is returned.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
295
296
16.5.2
Inspection Functions
Examples
Here we use isa along with shortcut boolean evaluation to safely determine if a variable contains the string
hello
--> a = hello
a =
hello
--> isa(a,char) && strcmp(a,hello)
ans =
1
16.6
16.6.1
Usage
and it returns a logical 1 if the argument is a cell array and a logical 0 otherwise.
16.6.2
Example
16.7
297
16.7.1
Usage
and it returns a logical 1 if the argument is a cell array in which every cell is a character array (or is empty), and a
logical 0 otherwise.
16.7.2
Example
16.8
16.8.1
Usage
16.9
16.9.1
Usage
The isempty function returns a boolean that indicates if the argument variable is empty or not. The general syntax
for its use is
y = isempty(x).
298
16.9.2
Inspection Functions
Examples
Note that if the variable is not defined, isempty does not return true.
--> clear x
--> isempty(x)
Error: Undefined function or variable x
16.10
16.10.1
Usage
Test two arrays for equality. The general format for its use is
y = isequal(a,b)
This function returns true if the two arrays are equal (compared element-wise). Unlike issame the isequal
function will type convert where possible to do the comparison.
16.11
16.11.1
Usage
Test two arrays for equality, with NaNs being equal. The general format for its use is
y = isequalwithequalnans(a,b)
This function returns true if the two arrays are equal (compared element-wise).
Unlike issame the
isequalwithequalnans function will type convert where possible to do the comparison.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
16.12
299
16.12.1
Usage
Given a structure array, tests to see if that structure array contains a field with the given name. The syntax for its
use is
y = isfield(x,field)
and returns a logical 1 if x has a field with the name field and a logical 0 if not. It also returns a logical 0 if the
argument x is not a structure array.
16.12.2
Example
Here we define a simple struct, and then test for some fields
--> a.foo = 32
a =
foo: 32
--> a.goo = 64
a =
foo: 32
goo: 64
--> isfield(a,goo)
ans =
1
--> isfield(a,got)
ans =
0
--> isfield(pi,round)
ans =
0
16.13
16.13.1
Usage
Given a constant, this routine will test to see if the constant is a valid graphics handle or not. The syntax for its use
is
y = ishandle(h,type)
16.14
300
Inspection Functions
16.14.1
Usage
Returns true for entries of an array that are infs (i.e., infinities). The usage is
y = isinf(x)
The result is a logical array of the same size as x, which is true if x is not-a-number, and false otherwise. Note that
for complex or dcomplex data types that the result is true if either the real or imaginary parts are infinite.
16.14.2
Example
3.4000 Inf
5.0000
--> isinf(a)
ans =
0 0 1 0
--> b = 3./[2 5 0 3 1]
b =
1.5000
16.15
0.6000 Inf
1.0000
3.0000
16.15.1
Usage
and it returns a logical 1 if the argument is an integer type and a logical 0 otherwise. Note that this function only
tests the type of the variable, not the value. So if, for example, y is a float array containing all integer values, it
will still return a logical 0.
16.16
16.16.1
Usage
and it returns a logical 1 if the argument is a logical array and a logical 0 otherwise.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
16.17
301
16.17.1
Usage
This function tests to see if the argument is a matrix. The syntax for ismatrix is
x = ismatrix(y)
16.18
16.18.1
Usage
Returns true for entries of an array that are NaNs (i.e., Not-a-Numbers). The usage is
y = isnan(x)
The result is a logical array of the same size as x, which is true if x is not-a-number, and false otherwise. Note that
for complex data types that the result is true if either the real or imaginary parts are NaNs.
16.18.2
Example
3.4000 NaN
5.0000
--> isnan(a)
ans =
0 0 1 0
16.19
16.19.1
Usage
and it returns a logical 1 if the argument is a numeric (i.e., not a structure array, cell array, string or user defined
class), and a logical 0 otherwise.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
302
16.20
Inspection Functions
16.20.1
Usage
and it returns a logical 1 if the argument is real valued and a logical 0 otherwise.
16.21
16.21.1
Usage
Tests for two arrays to be identical. The syntax for its use is
y = issame(a,b)
where a and b are two arrays to compare. This comparison succeeds only if a and b are of the same data type,
size, and contents. Unlike numerical equivalence tests, the issame function considers NaN to be equal in both
arguments.
16.22
16.22.1
Usage
16.23
16.23.1
Usage
Tests for the existence and non-emptiness of a variable. the general syntax for its use is
y = isset(name)
where name is the name of the variable to test. This is functionally equivalent to
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
303
It returns a logical 1 if the variable is defined in the current workspace, and is not empty, and returns a 0
otherwise.
16.23.2
Example
Type
Flags
Size
ans =
0
--> a = [];
--> isset(a)
ans =
0
--> a = 2;
--> isset(a)
ans =
1
16.24
16.24.1
Usage
Test a matrix to see if it is sparse or not. The general format for its use is
y = issparse(x)
This function returns true if x is encoded as a sparse matrix, and false otherwise.
16.24.2
Example
304
Inspection Functions
1 4 5
--> issparse(A)
ans =
1
16.25
16.25.1
Usage
This function tests to see if the argument is a square matrix. The syntax for issquare is
x = issquare(y)
16.26
16.26.1
Usage
16.27
16.27.1
Usage
and it returns a logical 1 if the argument is a structure array, and a logical 0 otherwise.
16.28
16.28.1
305
Usage
This function tests to see if the argument is a vector. The syntax for isvector is
x = isvector(y)
16.29
16.29.1
Usage
and is defined as the maximum length of x along any of its dimensions, i.e., max(size(x)). If you want to
determine the number of elements in x, use the numel function instead.
16.29.2
Example
16.30
16.30.1
Usage
The maxdim function returns the lowest order dimension along which an array is largest. The general syntax for
its use is
n = maxdim(x)
16.31
306
16.31.1
Inspection Functions
Usage
The ndims function returns the number of dimensions allocated in an array. The general syntax for its use is
n = ndims(x)
16.32
16.32.1
Usage
Returns the number of nonzero elements in a matrix. The general format for its use is
y = nnz(x)
This function returns the number of nonzero elements in a matrix or array. This function works for both sparse and
non-sparse arrays. For
16.32.2
Example
--> a = [1,0,0,5;0,3,2,0]
a =
1 0 0 5
0 3 2 0
--> nnz(a)
ans =
4
--> A = sparse(a)
A =
1 1 1
2 2 3
2 3 2
1 4 5
--> nnz(A)
ans =
4
16.33
16.33.1
Usage
Returns the number of elements in an array x, or in a subindex expression. The syntax for its use is either
y = numel(x)
or
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
307
y = numel(x,varargin)
Generally, numel returns prod(size(x)), the number of total elements in x. However, you can specify a
number of indexing expressions for varagin such as index1, index2, ..., indexm. In that case, the
output of numel is prod(size(x(index1,...,indexm))).
16.33.2
Example
For a 4 x 4 x 3 matrix, the length is 4, not 48, as you might expect, but numel is 48.
--> x = rand(4,4,3);
--> length(x)
ans =
4
--> numel(x)
ans =
48
16.34
16.34.1
Usage
Returns the size of a variable. There are two syntaxes for its use. The first syntax returns the size of the array as a
vector of integers, one integer for each dimension
[d1,d2,...,dn] = size(x)
16.34.2
Example
--> a = randn(23,12,5);
--> size(a)
ans =
23 12
308
Inspection Functions
16.35
16.35.1
Usage
Returns a string describing the type of an array. The syntax for its use is
y = typeof(x),
16.35.2
Example
The following piece of code demonstrates the output of the typeof command for each possible type. The first
example is with a simple cell array.
--> typeof({1})
ans =
cell
The next example uses the struct constructor to make a simple scalar struct.
--> typeof(struct(foo,3))
ans =
struct
The next example uses a comparison between two scalar integers to generate a scalar logical type.
--> typeof(3>5)
ans =
logical
For the integers, the typecast operations are used to generate the arguments.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
309
--> typeof(uint8(3))
ans =
uint8
--> typeof(int8(8))
ans =
int8
--> typeof(uint16(3))
ans =
uint16
--> typeof(int16(8))
ans =
int16
--> typeof(uint32(3))
ans =
uint32
--> typeof(int32(3))
ans =
int32
--> typeof(uint64(3))
ans =
uint64
--> typeof(int64(3))
ans =
int64
16.36
16.36.1
Usage
Lists files in a directory (or the current directory if no argument is supplied) that are relevant to FreeMat. These are
M-files, MAT-files, and class directories. There are several syntaxes for its use. The first is
what
then what will list the relevant FreeMat items in the specified directory.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
310
Inspection Functions
16.37
16.37.1
Usage
The result is a kind of stack trace that indicates the state of the current call stack, and where you are relative to the
stack.
16.37.2
Example
function chain1
a = 32;
b = a + 5;
chain2(b)
chain2.m
function chain2(d)
d = d + 5;
chain3
chain3.m
function chain3
g = 54;
f = g + 1;
keyboard
16.38
16.38.1
311
Usage
where fname is a string argument that contains the name of the function. For functions and scripts defined via
.m files, the which command returns the location of the source file:
y = which(fname)
will return the filename for the .m file corresponding to the given function, and an empty string otherwise.
16.38.2
Example
16.39
16.39.1
Usage
Reports information on either all variables in the current context or on a specified set of variables. For each variable,
the who function indicates the size and type of the variable as well as if it is a global or persistent. There are two
formats for the function call. The first is the explicit form, in which a list of variables are provided:
who a1 a2 ...
the who function lists all variables defined in the current context (as well as global and persistent variables). Note
that there are two alternate forms for calling the who function:
who a1 a2 ...
and
who(a1,a2,...)
16.39.2
Example
Here is an example of the general use of who, which lists all of the variables defined.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
312
Inspection Functions
--> c = [1,2,3];
--> f = hello;
--> p = randn(1,256);
--> who
Variable Name
Type
c
double
f
char
p
double
Flags
Size
[1x3]
[1x5]
[1x256]
16.40
Type
double
Flags
Size
[1x3]
Type
double
Flags
Size
[1x3]
16.40.1
Usage
Reports information on either all variables in the current context or on a specified set of variables. For each variable,
the who function indicates the size and type of the variable as well as if it is a global or persistent. There are two
formats for the function call. The first is the explicit form, in which a list of variables are provided:
whos a1 a2 ...
the whos function lists all variables defined in the current context (as well as global and persistent variables). Note
that there are two alternate forms for calling the whos function:
whos a1 a2 ...
and
whos(a1,a2,...)
Chapter 17
17.1
17.1.1
Instructions
Here are the general instructions for installing FreeMat. First, follow the instructions listed below for the platform of
interest. Then, run the
-->pathtool
which brings up the path setup tool. More documentation on the GUI elements (and how to use them) will be
forthcoming.
17.1.2
Linux
For Linux, FreeMat is now provided as a binary installation. To install it simply download the binary using your web
browser, and then unpack it
tar xvfz FreeMat-\<VERSION_NUMBER\>-Linux-Binary.tar.gz
You can then run FreeMat directly without any additional effort
FreeMat-\<VERSION_NUMBER\>-Linux-Binary/Contents/bin/FreeMat
will start up FreeMat as an X application. If you want to run it as a command line application (to run from within an
xterm), use the nogui flag
FreeMat-\<VERSION_NUMBER\>-Linux-Binary/Contents/bin/FreeMat -nogui
If you do not want FreeMat to use X at all (no graphics at all), use the noX flag
FreeMat-\<VERSION_NUMBER\>-Linux-Binary/Contents/bin/FreeMat -noX
For convenience, you may want to add FreeMat to your path. The exact mechanism for doing this depends on your
shell. Assume that you have unpacked FreeMat-<VERSION_NUMBER>-Linux-Binary.tar.gz into the
directory /home/myname. Then if you use csh or its derivatives (like tcsh) you should add the following line to
your .cshrc file:
set path=($path /home/myname/FreeMat-\<VERSION_NUMBER\>-Linux/Binary/Contents/bin)
314
If you use bash, then add the following line to your .bash_profile
PATH=$PATH:/home/myname/FreeMat-\<VERSION_NUMBER\>-Linux/Binary/Contents/bin
If the prebuilt binary package does not work for your Linux distribution, you will need to build FreeMat from source
(see the source section below). When you have FreeMat running, you can setup your path using the pathtool.
Note that the FREEMAT_PATH is no longer used by FreeMat. You must use the pathtool to adjust the path.
17.1.3
Windows
For Windows, FreeMat is installed via a binary installer program. To use it, simply download the setup program
FreeMat-<VERSION_NUMBER>-Setup.exe, and double click it. Follow the instructions to do the installation, then setup your path using pathtool.
17.1.4
OS X
For Mac OS X, FreeMat is distributed as an application bundle. To install it, simply download the compressed
disk image file FreeMat-<VERSION_NUMBER>.dmg, double click to mount the disk image, and then copy the
application FreeMat-<VERSION_NUMBER> to some convenient place. To run FreeMat, simply double click on
the application. Run pathtool to setup your FreeMat path.
17.1.5
Code
The source code build is a little more complicated than previous versions of FreeMat. Here are the current build
instructions for all platforms.
1. Build and install Qt 4.3 or later - http://trolltech.com/developer/downloads/opensource
2. Install g77 or gfortran (use fink for Mac OS X, use gcc-g77 package for MinGW)
3. Download the source code FreeMat-<VERSION_NUMBER>-src.tar.gz.
4. Unpack the source code: tar xvfz FreeMat-<VERSION_NUMBER>-src.tar.gz.
5. For Windows, you will need to install MSYS as well as MINGW to build FreeMat. You will also need unzip
to unpack the enclosed matio.zip archive. Alternately, you can cross-build the WIndows version of FreeMat
under Linux (this is how I build it now).
6. If you are extraordinarily lucky (or prepared), you can issue the usual ./configure, then the make and make
install. This is not likely to work because of the somewhat esoteric dependencies of FreeMat. The configure
step will probably fail and indicate what external dependencies are still needed.
7. I assume that you are familiar with the process of installing dependencies if you are trying to build FreeMat
from source.
To build a binary distributable (app bundle on the Mac, setup installer on win32, and a binary distribution on Linux),
you will need to run make package instead of make install.
Chapter 18
Input/Ouput Functions
CSVREAD Read Comma Separated Value (CSV) File
CSVWRITE Write Comma Separated Value (CSV) File
DISP Display a Variable or Expression
DLMREAD Read ASCII-delimited File
FCLOSE File Close Function
FEOF End Of File Function
FFLUSH Force File Flush
FGETLINE Read a String from a File
FOPEN File Open Function
FORMAT Control the Format of Matrix Display
FPRINTF Formated File Output Function (C-Style)
FREAD File Read Function
FSCANF Formatted File Input Function (C-Style)
FSEEK Seek File To A Given Position
FTELL File Position Function
FWRITE File Write Function
GETLINE Get a Line of Input from User
GETPRINTLIMIT Get Limit For Printing Of Arrays
HTMLREAD Read an HTML Document into FreeMat
IMREAD Read Image File To Matrix
IMWRITE Write Matrix to Image File
INPUT Get Input From User
LOAD Load Variables From A File
PAUSE Pause Script Execution
PRINTF Formated Output Function (C-Style)
RAWREAD Read N-dimensional Array From File
316
Input/Ouput Functions
RAWWRITE Write N-dimensional Array From File
SAVE Save Variables To A File
SETPRINTLIMIT Set Limit For Printing Of Arrays
SPRINTF Formated String Output Function (C-Style)
SSCANF Formated String Input Function (C-Style)
STR2NUM Convert a String to a Number
TYPE Type Contents of File or Function
URLWRITE Retrieve a URL into a File
WAVPLAY
WAVREAD Read a WAV Audio File
WAVRECORD
WAVWRITE Write a WAV Audio File
XMLREAD Read an XML Document into FreeMat
18.1
18.1.1
Usage
The csvread function reads a text file containing comma separated values (CSV), and returns the resulting
numeric matrix (2D). The function supports multiple syntaxes. The first syntax for csvread is
x = csvread(filename)
which attempts to read the entire CSV file into array x. The file can contain only numeric values. Each entry in the
file should be separated from other entries by a comma. However, FreeMat will attempt to make sense of the entries
if the comma is missing (e.g., a space separated file will also parse correctly). For complex values, you must be
careful with the spaces). The second form of csvread allows you to specify the first row and column (zero-based
index)
x = csvread(filename,firstrow,firstcol)
The last form allows you to specify the range to read also. This form is
x = csvread(filename,firstrow,firstcol,readrange)
where readrange is either a 4-vector of the form [R1,C1,R2,C2], where R1,C1 is the first row and column
to use, and R2,C2 is the last row and column to use. You can also specify the readrange as a spreadsheet
range B12..C34, in which case the index for the range is 1-based (as in a typical spreadsheet), so that A1 is the
first cell in the upper left corner. Note also that csvread is somewhat limited.
18.1.2
Example
10,
09,
01,
14,
21,
12,
11,
03,
17,
33,
13,
52,
04,
13,
14,
00,
93,
04,
67,
44,
45,
05,
90,
30,
01,
317
16
06
-3
43
00
=
12
11
3
17
33
13 0 45 16
52 93 5 6
4 4 90 -3
13 67 30 43
14 44 1 0
Next, we read everything starting with the second row, and third column
--> csvread(sample_data.csv,1,2)
ans
52
4
13
14
=
93 5 6
4 90 -3
67 30 43
44 1 0
Finally, we specify that we only want the 3 x 3 submatrix starting with the second row, and third column
--> csvread(sample_data.csv,1,2,[1,2,3,4])
ans =
52 93 5
4 4 90
13 67 30
18.2
18.2.1
Usage
The csvwrite function writes a given matrix to a text file using comma separated value (CSV) notation. Note that
you can create CSV files with arbitrary sized matrices, but that csvread has limits on line length. If you need to
reliably read and write large matrices, use rawwrite and rawread respectively. The syntax for csvwrite is
csvwrite(filename,x)
where x is a numeric array. The contents of x are written to filename as comma-separated values. You can also
specify a row and column offset to csvwrite to force csvwrite to write the matrix x starting at the specified
location in the file. This syntax of the function is
csvwrite(filename,x,startrow,startcol)
18.2.2
Example
318
Input/Ouput Functions
--> x = [1,2,3;5,6,7]
x =
1 2 3
5 6 7
--> csvwrite(csvwrite.csv,x)
--> csvread(csvwrite.csv)
ans =
1 2 3
5 6 7
18.3
18.3.1
Usage
Displays the result of a set of expressions. The disp function takes a variable number of arguments, each of which
is an expression to output:
disp(expr1,expr2,...,exprn)
This is functionally equivalent to evaluating each of the expressions without a semicolon after each.
18.3.2
Example
18.4
18.4.1
319
Usage
Loads a matrix from an ASCII-formatted text file with a delimiter between the entries. This function is similar to the
load -ascii command, except that it can handle complex data, and it allows you to specify the delimiter. Also,
you can read only a subset of the data from the file. The general syntax for the dlmread function is
y = dlmread(filename)
where filename is a string containing the name of the file to read. In this form, FreeMat will guess at the type of
the delimiter in the file. The guess is made by examining the input for common delimiter characters, which are ,;:
or a whitespace (e.g., tab). The text in the file is preprocessed to replace these characters with whitespace and the
file is then read in using a whitespace for the delimiter.
If you know the delimiter in the file, you can specify it using this form of the function:
y = dlmread(filename, delimiter)
where delimiter is a string containing the delimiter. If delimiter is the empty string, then the delimiter is
guessed from the file.
You can also read only a portion of the file by specifying a start row and start column:
y = dlmread(filename, delimiter, startrow, startcol)
where startrow and startcol are zero-based. You can also specify the data to read using a range argument:
y = dlmread(filename, delimiter, range)
18.5
18.5.1
Usage
Closes a file handle, or all open file handles. The general syntax for its use is either
fclose(handle)
or
fclose(all)
In the first case a specific file is closed, In the second, all open files are closed. Note that until a file is closed the
file buffers are not flushed. Returns a 0 if the close was successful and a -1 if the close failed for some reason.
18.5.2
Example
A simple example of a file being opened with fopen and then closed with fclose.
--> fp = fopen(test.dat,wb,ieee-le)
fp =
3
--> fclose(fp)
320
18.6
Input/Ouput Functions
18.6.1
Usage
The handle argument must be a valid and active file handle. The return is true (logical 1) if the current position
is at the end of the file, and false (logical 0) otherwise. Note that simply reading to the end of a file will not cause
feof to return true. You must read past the end of the file (which will cause an error anyway). See the example
for more details.
18.6.2
Example
Here, we read to the end of the file to demonstrate how feof works. At first pass, we force a read of the contents
of the file by specifying inf for the dimension of the array to read. We then test the end of file, and somewhat
counter-intuitively, the answer is false. We then attempt to read past the end of the file, which causes an error.
An feof test now returns the expected value of true.
--> fp = fopen(test.dat,rb);
--> x = fread(fp,[512,inf],float);
--> feof(fp)
ans =
1
--> x = fread(fp,[1,1],float);
--> feof(fp)
ans =
1
18.7
18.7.1
Usage
Flushes any pending output to a given file. The general use of this function is
fflush(handle)
18.8
18.8.1
321
Usage
Reads a string from a file. The general syntax for its use is
s = fgetline(handle)
This function reads characters from the file handle into a string array s until it encounters the end of the file or
a newline. The newline, if any, is retained in the output string. If the file is at its end, (i.e., that feof would return
true on this handle), fgetline returns an empty string.
18.8.2
Example
fp = fopen(testtext,w);
fprintf(fp,String 1\n);
fprintf(fp,String 2\n);
fclose(fp);
18.9
18.9.1
Usage
Opens a file and returns a handle which can be used for subsequent file manipulations. The general syntax for its
use is
fp = fopen(fname,mode,byteorder)
Here fname is a string containing the name of the file to be opened. mode is the mode string for the file open
command. The first character of the mode string is one of the following:
r Open file for reading. The file pointer is placed at the beginning of the file. The file can be read from, but
not written to.
r+ Open for reading and writing. The file pointer is placed at the beginning of the file. The file can be read
from and written to, but must exist at the outset.
w Open file for writing. If the file already exists, it is truncated to zero length. Otherwise, a new file is
created. The file pointer is placed at the beginning of the file.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
322
Input/Ouput Functions
w+ Open for reading and writing. The file is created if it does not exist, otherwise it is truncated to zero
length. The file pointer placed at the beginning of the file.
a Open for appending (writing at end of file). The file is created if it does not exist. The file pointer is placed
at the end of the file.
a+ Open for reading and appending (writing at end of file). The file is created if it does not exist. The file
pointer is placed at the end of the file.
Starting with FreeMat 4, all files are treated as binary files by default. To invoke the operating systems CR/LF <->
CR translation (on Win32) add a t to the mode string, as in rt+.
Also, you can supply a second argument to fopen to retrieve error messages if the fopen fails.
[fp,messages] = fopen(fname,mode,byteorder)
Finally, FreeMat has the ability to read and write files of any byte-sex (endian). The third (optional) input indicates
the byte-endianness of the file. If it is omitted, the native endian-ness of the machine running FreeMat is used.
Otherwise, the third argument should be one of the following strings:
le,ieee-le,little-endian,littleEndian,little,l,ieee-le.-
l64,s
be,ieee-be,big-endian,bigEndian,big,b,ieee-be.l64,a
If the file cannot be opened, or the file mode is illegal, then an error occurs. Otherwise, a file handle is returned
(which is an integer). This file handle can then be used with fread, fwrite, or fclose for file access.
Note that three handles are assigned at initialization time:
Handle 0 - is assigned to standard input
Handle 1 - is assigned to standard output
Handle 2 - is assigned to standard error
These handles cannot be closed, so that user created file handles start at 3.
18.9.2
Examples
Here are some examples of how to use fopen. First, we create a new file, which we want to be little-endian,
regardless of the type of the machine. We also use the fwrite function to write some floating point data to the
file.
--> fp = fopen(test.dat,w,ieee-le)
fp =
4
--> fwrite(fp,float([1.2,4.3,2.1]))
ans =
12
--> fclose(fp)
323
--> fread(fp,[1,3],float)
ans =
1.2000
4.3000
2.1000
--> fclose(fp)
Now, we re-open the file in append mode and add two additional floats to the file.
--> fp = fopen(test.dat,a+,le)
fp =
4
--> fwrite(fp,float([pi,e]))
ans =
8
--> fclose(fp)
4.3000
2.1000
3.1416
2.7183
--> fclose(fp)
18.10
18.10.1
Usage
FreeMat supports several modes for displaying matrices (either through the disp function or simply by entering expressions on the command line. There are several options for the format command. The default mode is equivalent
to
format short
which generally displays matrices with 4 decimals, and scales matrices if the entries have magnitudes larger than
roughly 1e2 or smaller than 1e-2. For more information you can use
format long
which displays roughly 7 decimals for float and complex arrays, and 14 decimals for double and dcomplex.
You can also use
format short e
to get exponential format with 4 decimals. Matrices are not scaled for exponential formats. Similarly, you can use
format long e
which displays the same decimals as format long, but in exponential format. You can also use the format
command to retrieve the current format:
s = format
324
18.10.2
Input/Ouput Functions
Example
We start with the short format, and two matrices, one of double precision, and the other of single precision.
--> format short
--> a = randn(4)
a =
-0.3756
0.5078
0.5578
-0.4420
0.0920
-0.2088
0.7695
-0.4871
0.9516
-0.3120
0.0226
-0.7582
1.8527
-0.2380
2.9326
-0.5059
--> b = float(randn(4))
b =
0.2010
1.2842
-0.7660
-0.1727
0.3416
-0.3808
-0.6251
0.8577
0.1562
-1.2720
2.4811
1.5701
-0.5460
-0.3398
0.7956
-1.5048
Note that in the short format, these two matrices are displayed with the same format. In long format, however,
they display differently
--> format long
--> a
ans =
Columns 1 to 3
-0.37559630424227
0.50776589164635
0.55783547335483
-0.44202929771190
0.09196341864118
-0.20877480315311
0.76954243414671
-0.48708606879623
0.95155934364300
-0.31198760445638
0.02264031516947
-0.75822963661106
Columns 4 to 4
1.85265231634028
-0.23799081322695
2.93263318869123
-0.50590405332950
--> b
ans =
0.2010476
1.2841575
-0.7659672
-0.1726678
0.3415550
-0.3808453
-0.6251388
0.8576548
0.1561587
-1.2719837
2.4811494
1.5701485
-0.5460028
-0.3397521
0.7956446
-1.5048176
Note also that we we scale the contents of the matrices, FreeMat rescales the entries with a scale premultiplier.
--> format short
--> a*1e4
ans =
1.0e+04 *
-0.3756
0.0920
0.5078
-0.2088
0.5578
0.7695
-0.4420
-0.4871
0.9516
-0.3120
0.0226
-0.7582
1.8527
-0.2380
2.9326
-0.5059
--> a*1e-4
ans =
1.0e-04 *
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
-0.3756
0.5078
0.5578
-0.4420
0.0920
-0.2088
0.7695
-0.4871
0.9516
-0.3120
0.0226
-0.7582
1.8527
-0.2380
2.9326
-0.5059
1.0e+04 *
0.2010
0.3416
1.2842
-0.3808
-0.7660
-0.6251
-0.1727
0.8577
0.1562
-1.2720
2.4811
1.5701
-0.5460
-0.3398
0.7956
-1.5048
0.1562
-1.2720
2.4811
1.5701
-0.5460
-0.3398
0.7956
-1.5048
--> b*1e4
ans =
--> b*1e-4
ans =
1.0e-04 *
0.2010
0.3416
1.2842
-0.3808
-0.7660
-0.6251
-0.1727
0.8577
Finally, if we assign the format function to a variable, we can retrieve the current format:
--> format short
--> t = format
t =
short
325
326
Input/Ouput Functions
18.11
18.11.1
Usage
or,
fprintf(format,a1,a2,...).
Here format is the format string, which is a string that controls the format of the output. The values of the variables
ai are substituted into the output as required. It is an error if there are not enough variables to satisfy the format
string. Note that this fprintf command is not vectorized! Each variable must be a scalar. The value fp is the
file handle. If fp is omitted, file handle 1 is assumed, and the behavior of fprintf is effectively equivalent to
printf. For more details on the format string, see printf.
18.11.2
Examples
A number of examples are present in the Examples section of the printf command.
18.12
18.12.1
Usage
Reads a block of binary data from the given file handle into a variable of a given shape and precision. The general
use of the function is
A = fread(handle,size,precision)
The handle argument must be a valid value returned by the fopen function, and accessable for reading. The size
argument determines the number of values read from the file. The size argument is simply a vector indicating the
size of the array A. The size argument can also contain a single inf dimension, indicating that FreeMat should
calculate the size of the array along that dimension so as to read as much data as possible from the file (see the
examples listed below for more details). The data is stored as columns in the file, not rows.
Alternately, you can specify two return values to the fread function, in which case the second value contains the
number of elements read
[A,count] = fread(...)
327
18.12.2
Example
First, we create an array of 512 x 512 Gaussian-distributed float random variables, and then writing them to
a file called test.dat.
-->
-->
-->
-->
A = float(randn(512));
fp = fopen(test.dat,w);
fwrite(fp,A);
fclose(fp);
Size
[1x262144]
Note that x is a double array. This behavior is new to FreeMat 4. Read the same floats into a 2-D float array.
--> fp = fopen(test.dat,r);
--> x = fread(fp,[512,inf],float);
--> fclose(fp);
--> who x
Variable Name
Type
Flags
x
double
Size
[512x512]
To read them as a single precision float array, we can use the following form:
--> fp = fopen(test.dat,r);
--> x = fread(fp,[512,inf],*float);
--> fclose(fp);
--> who x
Variable Name
Type
Flags
x
single
18.13
Size
[512x512]
328
Input/Ouput Functions
18.13.1
Usage
Reads values from a file. The general syntax for its use is
[a,count] = fscanf(handle,format,[size])
Here format is the format string, which is a string that controls the format of the input, size specifies the amount
of data to be read. Values that are parsed from the text are stored in a. Note that fscanf is vectorized - the format
string is reused as long as there are entries in the text string. See printf for a description of the format. Note
that if the file is at the end-of-file, the fscanf will return
18.14
18.14.1
Usage
Moves the file pointer associated with the given file handle to the specified offset (in bytes). The usage is
fseek(handle,offset,style)
The handle argument must be a value and active file handle. The offset parameter indicates the desired seek
offset (how much the file pointer is moved in bytes). The style parameter determines how the offset is treated.
Three values for the style parameter are understood:
string bof or the value -1, which indicate the seek is relative to the beginning of the file. This is equivalent
to SEEK_SET in ANSI C.
string cof or the value 0, which indicates the seek is relative to the current position of the file. This is
equivalent to SEEK_CUR in ANSI C.
string eof or the value 1, which indicates the seek is relative to the end of the file. This is equivalent to
SEEK_END in ANSI C.
The offset can be positive or negative.
18.14.2
Example
The first example reads a file and then rewinds the file pointer by seeking to the beginning. The next example
seeks forward by 2048 bytes from the files current position, and then reads a line of 512 floats.
--> % First we create the file
--> fp = fopen(test.dat,wb);
--> fwrite(fp,float(rand(4096,1)));
--> fclose(fp);
--> % Now we open it
--> fp = fopen(test.dat,rb);
--> % Read the whole thing
--> x = fread(fp,[1,inf],float);
--> % Rewind to the beginning
--> fseek(fp,0,bof);
--> % Read part of the file
--> y = fread(fp,[1,1024],float);
--> who x y
Variable Name
Type
Flags
x
double
y
double
--> % Seek 2048 bytes into the file
--> fseek(fp,2048,cof);
Size
[1x4096]
[1x1024]
-->
-->
-->
-->
329
18.15
18.15.1
Usage
Returns the current file position for a valid file handle. The general use of this function is
n = ftell(handle)
The handle argument must be a valid and active file handle. The return is the offset into the file relative to the
start of the file (in bytes).
18.15.2
Example
Here is an example of using ftell to determine the current file position. We read 512 4-byte floats, which results
in the file pointer being at position 5124 = 2048.
-->
-->
-->
-->
-->
-->
fp = fopen(test.dat,wb);
fwrite(fp,randn(512,1));
fclose(fp);
fp = fopen(test.dat,rb);
x = fread(fp,[512,1],float);
ftell(fp)
ans =
2048
18.16
18.16.1
Usage
Writes an array to a given file handle as a block of binary (raw) data. The general use of the function is
n = fwrite(handle,A)
The handle argument must be a valid value returned by the fopen function, and accessable for writing. The array
A is written to the file a column at a time. The form of the output data depends on (and is inferred from) the precision
of the array A. If the write fails (because we ran out of disk space, etc.) then an error is returned. The output n
indicates the number of elements successfully written.
Note that unlike MATLAB, FreeMat 4 does not default to uint8 for writing arrays to files. Alternately, the type of
the data to be written to the file can be specified with the syntax
n = fwrite(handle,A,type)
330
Input/Ouput Functions
int8,char,integer1 for a signed, 8-bit integer.
uint16,unsigned short for an unsigned, 16-bit integer.
int16,short,integer2 for a signed, 16-bit integer.
uint32,unsigned int for an unsigned, 32-bit integer.
int32,int,integer4 for a signed, 32-bit integer.
single,float32,float,real4 for a 32-bit floating point.
double,float64,real8 for a 64-bit floating point.
18.16.2
Example
Heres an example of writing an array of 512 x 512 Gaussian-distributed float random variables, and then
writing them to a file called test.dat.
-->
-->
-->
-->
A = float(randn(512));
fp = fopen(test.dat,w);
fwrite(fp,A,single);
fclose(fp);
18.17
18.17.1
Usage
Reads a line (as a string) from the user. This function has two syntaxes. The first is
a = getline(prompt)
where prompt is a prompt supplied to the user for the query. The second syntax omits the prompt argument:
a = getline
Note that this function requires command line input, i.e., it will only operate correctly for programs or scripts written
to run inside the FreeMat GUI environment or from the X11 terminal. If you build a stand-alone application and
expect it to operate cross-platform, do not use this function (unless you include the FreeMat console in the final
application).
18.18
18.18.1
Usage
Returns the limit on how many elements of an array are printed using either the disp function or using expressions
on the command line without a semi-colon. The default is set to one thousand elements. You can increase or
decrease this limit by calling setprintlimit. This function is provided primarily so that you can temporarily
change the output truncation and then restore it to the previous value (see the examples).
n=getprintlimit
18.18.2
331
Example
Here is an example of using getprintlimit along with setprintlimit to temporarily change the output
behavior of FreeMat.
--> A = randn(100,1);
--> n = getprintlimit
n =
1000
--> setprintlimit(5);
--> A
ans =
-0.6933
-0.9500
0.0824
-1.1740
-0.3467
Print limit has been reached.
--> setprintlimit(n)
18.19
18.19.1
Usage
Given a filename, reads an HTML document, (attempts to) parse it, and returns the result as a FreeMat data
structure. The syntax for its use is:
p = htmlread(filename)
where filename is a string. The resulting object p is a data structure containing the information in the
document. Note that this function works by internally converting the HTML document into something closer to
XHTML, and then using the XML parser to parse it. In some cases, the converted HTML cannot be properly parsed.
In such cases, a third party tool such as "tidy" will probably do a better job.
18.20
18.20.1
Usage
Reads the image data from the given file into a matrix. Note that FreeMats support for imread is not complete.
Only some of the formats specified in the MATLAB API are implemented. The syntax for its use is
[A,map,alpha] = imread(filename)
where filename is the name of the file to read from. The returned arrays A contain the image data, map contains
the colormap information (for indexed images), and alpha contains the alphamap (transparency). The returned
values will depend on the type of the original image. Generally you can read images in the jpg,png,xpm,ppm
and some other formats.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
332
Input/Ouput Functions
18.21
18.21.1
Usage
Write the image data from the matrix into a given file. Note that FreeMats support for imwrite is not complete.
You can write images in the jpg,png,xpm,ppm and some other formats. The syntax for its use is
imwrite(A, filename)
imwrite(A, map, filename)
imwrite(A, map, filename, Alpha, alpha)
or Octave-style syntax:
imwrite(filename, A)
imwrite(filename, A, map)
imwrite(filename, A, map, alpha)
where filename is the name of the file to write to. The input array A contains the image data (2D for gray or
indexed, and 3D for color). If A is an integer array (int8, uint8, int16, uint16, int32, uint32), the values of its elements
should be within 0-255. If A is a floating-point array (float or double), the value of its elements should be in the range
[0,1]. map contains the colormap information (for indexed images), and alpha the alphamap (transparency).
18.21.2
Example
Here is a simple example of imread/imwrite. First, we generate a grayscale image and save it to an image file.
-->
-->
-->
-->
a = uint8(255*rand(64));
figure(1), image(a), colormap(gray)
title(image to save)
imwrite(a, test.bmp)
18.22
18.22.1
Usage
The input function is used to obtain input from the user. There are two syntaxes for its use. The first is
r = input(prompt)
in which case, the prompt is presented, and the user is allowed to enter an expression. The expression is evaluated
in the current workspace or context (so it can use any defined variables or functions), and returned for assignment
to the variable (r in this case). In the second form of the input function, the syntax is
r = input(prompt,s)
in which case the text entered by the user is copied verbatim to the output.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
18.23
333
18.23.1
Usage
Loads a set of variables from a file in a machine independent format. The load function takes one argument:
load filename,
or alternately,
load(filename)
This command is the companion to save. It loads the contents of the file generated by save back into the current
context. Global and persistent variables are also loaded and flagged appropriately. By default, FreeMat assumes
that files that end in a .mat or .MAT extension are MATLAB-formatted files. Also, FreeMat assumes that files that
end in .txt or .TXT are ASCII files. For other filenames, FreeMat first tries to open the file as a FreeMat binary
format file (as created by the save function). If the file fails to open as a FreeMat binary file, then FreeMat attempts
to read it as an ASCII file.
You can force FreeMat to assume a particular format for the file by using alternate forms of the load command. In
particular,
load -ascii filename
will load the data in file filename as an ASCII file (space delimited numeric text) loaded into a single variable in
the current workspace with the name filename (without the extension).
For MATLAB-formatted data files, you can use
load -mat filename
which forces FreeMat to assume that filename is a MAT-file, regardless of the extension on the filename.
You can also specify which variables to load from a file (not from an ASCII file - only single 2-D variables can
be successfully saved and retrieved from ASCII files) using the additional syntaxes of the load command. In
particular, you can specify a set of variables to load by name
load filename Var_1 Var_2 Var_3 ...
where Var_n is the name of a variable to load from the file. Alternately, you can use the regular expression syntax
load filename -regexp expr_1 expr_2 expr_3 ...
where expr_n is a regular expression (roughly as expected by regexp). Note that a simpler regular expression
mechanism is used for this syntax than the full mechanism used by the regexp command.
Finally, you can use load to create a variable containing the contents of the file, instead of automatically inserting
the variables into the curent workspace. For this form of load you must use the function syntax, and capture the
output:
V = load(arg1,arg2,...)
which returns a structure V with one field for each variable retrieved from the file. For ASCII files, V is a double
precision matrix.
18.23.2
Example
334
Input/Ouput Functions
--> D = {1,5,hello};
--> s = test string;
--> x = randn(512,1);
--> z = zeros(512);
--> who
Variable Name
Type
D
cell
s
char
x
double
z
double
--> save loadsave.dat
Flags
Size
[1x3]
[1x11]
[512x1]
[512x512]
Next, we clear the variables, and then load them back from the file.
--> clear D s x z
--> who
Variable Name
Type
ans
double
--> load loadsave.dat
--> who
Variable Name
Type
D
cell
ans
double
s
char
x
double
z
double
18.24
Flags
Size
[0x0]
Flags
Size
[1x3]
[0x0]
[1x11]
[512x1]
[512x512]
18.24.1
Usage
The pause function can be used to pause execution of FreeMat scripts. There are several syntaxes for its use.
The first form is
pause
This form of the pause function pauses FreeMat until you press any key. The second form of the pause function
takes an argument
pause(p)
where p is the number of seconds to pause FreeMat for. The pause argument should be accurate to a millisecond
on all supported platforms. Alternately, you can control all pause statements using:
pause on
which disables all pause statements, both with and without arguments.
18.25
18.25.1
335
Usage
Prints values to the output. The general syntax for its use is
printf(format,a1,a2,...)
Here format is the format string, which is a string that controls the format of the output. The values of the variables
a_i are substituted into the output as required. It is an error if there are not enough variables to satisfy the format
string. Note that this printf command is not vectorized! Each variable must be a scalar.
It is important to point out that the printf function does not add a newline (or carriage return) to the output by
default. That can lead to some confusing behavior if you do not know what to expect. For example, the command
printf(Hello) does not appear to produce any output. In fact, it does produce the text, but it then gets
overwritten by the prompt. To see the text, you need printf(Hello
). This seems odd, but allows you to assemble a line using multiple printf commands, including the
when you are done with the line. You can also use the \r character as an explicit carriage return (with no line
feed). This allows you to write to the same line many times (to show a progress string, for example).
18.25.2
The format string is a character string, beginning and ending in its initial shift state, if any. The format string is
composed of zero or more directives: ordinary characters (not %), which are copied unchanged to the output
stream; and conversion specifications, each of which results in fetching zero or more subsequent arguments. Each
conversion specification is introduced by the character %, and ends with a conversion specifier. In between there
may be (in this order) zero or more flags, an optional minimum field width, and an optional precision.
The arguments must correspond properly (after type promotion) with the conversion specifier, and are used in the
order given.
18.25.3
conversion specifier
336
Input/Ouput Functions
18.25.4
conversion specifier
An optional decimal digit string (with nonzero first digit) specifying a minimum field width. If the converted value has
fewer characters than the field width, it will be padded with spaces on the left (or right, if the left-adjustment flag
has been given). A negative field width is taken as a - flag followed by a positive field width. In no case does a
non-existent or small field width cause truncation of a field; if the result of a conversion is wider than the field width,
the field is expanded to contain the conversion result.
18.25.5
conversion specifier
An optional precision, in the form of a period (.) followed by an optional decimal digit string. If the precision is
given as just ., or the precision is negative, the precision is taken to be zero. This gives the minimum number of
digits to appear for d, i, o, u, x, and X conversions, the number of digits to appear after the radix character
for a, A, e, E, f, and F conversions, the maximum number of significant digits for g and G conversions, or
the maximum number of characters to be printed from a string for s conversions.
18.25.6
conversion specifier
A character that specifies the type of conversion to be applied. The conversion specifiers and their meanings are:
d,i The int argument is converted to signed decimal notation. The precision, if any, gives the minimum
number of digits that must appear; if the converted value requires fewer digits, it is padded on the left with
zeros. The default precision is 1. When 0 is printed with an explicit precision 0, the output is empty.
o,u,x,X The unsigned int argument is converted to unsigned octal (o), unsigned decimal (u), or unsigned
hexadecimal (x and X) notation. The letters abcdef are used for x conversions; the letters ABCDEF are
used for X conversions. The precision, if any, gives the minimum number of digits that must appear; if the
converted value requires fewer digits, it is padded on the left with zeros. The default precision is 1. When 0
is printed with an explicit precision 0, the output is empty.
e,E The double argument is rounded and converted in the style [-]d.ddde dd where there is one digit
before the decimal-point character and the number of digits after it is equal to the precision; if the precision is
missing, it is taken as 6; if the precision is zero, no decimal-point character appears. An E conversion uses
the letter E (rather than e) to introduce the exponent. The exponent always contains at least two digits; if the
value is zero, the exponent is 00.
f,F The double argument is rounded and converted to decimal notation in the style [-]ddd.ddd, where
the number of digits after the decimal-point character is equal to the precision specification. If the precision
is missing, it is taken as 6; if the precision is explicitly zero, no decimal-point character appears. If a decimal
point appears, at least one digit appears before it.
g,G The double argument is converted in style f or e (or F or E for G conversions). The precision specifies
the number of significant digits. If the precision is missing, 6 digits are given; if the precision is zero, it is
treated as 1. Style e is used if the exponent from its conversion is less than -4 or greater than or equal to
the precision. Trailing zeros are removed from the fractional part of the result; a decimal point appears only if
it is followed by at least one digit.
c The int argument is converted to an unsigned char, and the resulting character is written.
s The string argument is printed.
% A is written. No argument is converted. The complete conversion specification is %.
18.25.7
Example
Here are some examples of the use of printf with various arguments. First we print out an integer and double
value.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
337
Print out a double precision value with a sign, a total of 18 characters (zero prepended if necessary), a decimal
point, and 12 digit precision.
--> printf(float value is %+018.12f\n,pi);
float value is +0003.141592653590
18.26
18.26.1
Usage
where fname is the name of the file to read from, and size is an n-dimensional vector that stores the size of the
array in each dimension. The argument precision is the type of the data to read in:
uint8,uchar,unsigned char for unsigned, 8-bit integers
int8,char,integer1 for signed, 8-bit integers
uint16,unsigned short for unsigned, 16-bit integers
int16,short,integer2 for signed, 16-bit integers
uint32,unsigned int for unsigned, 32-bit integers
int32,int,integer4 for signed, 32-bit integers
uint64,unsigned int for unsigned, 64-bit integers
int64,int,integer8 for signed, 64-bit integers
single,float32,float,real4 for 32-bit floating point
double,float64,real8 for 64-bit floating point
complex,complex8 for 64-bit complex floating point (32 bits for the real and imaginary part).
dcomplex,complex16 for 128-bit complex floating point (64 bits for the real and imaginary part).
As a special feature, one of the size elements can be inf, in which case, the largest possible array is read in. If
byteorder is left unspecified, the file is assumed to be of the same byte-order as the machine FreeMat is
running on. If you wish to force a particular byte order, specify the byteorder argument as
le,ieee-le,little-endian,littleEndian,little
be,ieee-be,big-endian,bigEndian,big
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
338
Input/Ouput Functions
18.27
18.27.1
Usage
where fname is the name of the file to write to, and the (numeric) array x is writen to the file in its native type (e.g.
if x is of type int16, then it will be written to the file as 16-bit signed integers. If byteorder is left unspecified,
the file is assumed to be of the same byte-order as the machine FreeMat is running on. If you wish to force a
particular byte order, specify the byteorder argument as
le,ieee-le,little-endian,littleEndian,little
be,ieee-be,big-endian,bigEndian,big
18.28
18.28.1
Usage
Saves a set of variables to a file in a machine independent format. There are two formats for the function call. The
first is the explicit form, in which a list of variables are provided to write to the file:
save filename a1 a2 ...
all variables in the current context are written to the file. The format of the file is a simple binary encoding (raw) of
the data with enough information to restore the variables with the load command. The endianness of the machine
is encoded in the file, and the resulting file should be portable between machines of similar types (in particular,
machines that support IEEE floating point representation).
You can also specify both the filename as a string, in which case you also have to specify the names of the variables
to save. In particular
save(filename,a1,a2)
339
although where -ascii appears on the command line is arbitrary (provided it comes after the save command, of
course). Be default, the save command uses an 8-digit exponential format notation to save the values to the file.
You can specify that you want 16-digits using the
save -ascii -double filename var1 var2
form of the command. Also, by default, save uses spaces as the delimiters between the entries in the matrix. If
you want tabs instead, you can use
save -ascii -tabs filename var1 var2
(you can also use both the -tabs and -double flags simultaneously).
Finally, you can specify that save should only save variables that match a particular regular expression. Any of the
above forms can be combined with the -regexp flag:
save filename -regexp pattern1 pattern2
in which case variables that match any of the patterns will be saved.
18.28.2
Example
Flags
Size
[1x3]
[1x11]
[512x1]
[512x512]
Next, we clear the variables, and then load them back from the file.
--> clear D s x z
--> who
Variable Name
Type
ans
double
--> load loadsave.dat
--> who
Variable Name
Type
D
cell
ans
double
s
char
x
double
z
double
18.29
Flags
Size
[0x0]
Flags
Size
[1x3]
[0x0]
[1x11]
[512x1]
[512x512]
18.29.1
Usage
Changes the limit on how many elements of an array are printed using either the disp function or using expressions
on the command line without a semi-colon. The default is set to one thousand elements. You can increase or
decrease this limit by calling
setprintlimit(n)
340
18.29.2
Input/Ouput Functions
Example
Setting a smaller print limit avoids pages of output when you forget the semicolon on an expression.
--> A = randn(512);
--> setprintlimit(10)
--> A
ans =
Columns 1 to 7
-0.2514
-0.1353
-1.3148
1.7915
-0.4740
-1.6836
-0.2605
-0.6206
-0.6711
-0.4389
Print limit has been reached. Use setprintlimit function to enable longer printouts
--> setprintlimit(1000)
18.30
18.30.1
Usage
Here format is the format string, which is a string that controls the format of the output. The values of the variables
a_i are substituted into the output as required. It is an error if there are not enough variables to satisfy the format
string. Note that this sprintf command is not vectorized! Each variable must be a scalar. The returned value y
contains the string that would normally have been printed. For more details on the format string, see printf.
18.30.2
Examples
Here is an example of a loop that generates a sequence of files based on a template name, and stores them in a
cell array.
--> l = {}; for i = 1:5; s = sprintf(file_%d.dat,i); l(i) = {s}; end;
--> l
ans =
[file_1.dat] [file_2.dat] [file_3.dat] [file_4.dat] [file_5.dat]
18.31
18.31.1
Usage
Reads values from a string. The general syntax for its use is
[a, count, errmsg, nextind] = sscanf(text,format,[size])
Here format is the format string, which is a string that controls the format of the input, size specifies the amount
of data to be read. Values that are parsed from the text are stored in a. Note that sscanf is vectorized - the format
string is reused as long as there are entries in the text string. See printf for a description of the format.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
18.32
341
18.32.1
Usage
Here string is the data string, which contains the data to be converted into a number. The output is in double precision, and must be typecasted to the appropriate type based on what you need. Note that by definition, str2num
is entirely equivalent to eval([[ string ]],[]) with all of the associated problems where string
contains text that causes side effects.
18.33
18.33.1
Usage
Displays the contents of a file or a function to the screen or console. The syntax for its use is
type filename
type(filename)
or
type function
type(function)
18.33.2
Example
18.34
342
18.34.1
Input/Ouput Functions
Usage
Given a URL and a timeout, attempts to retrieve the URL and write the contents to a file. The syntax is
f = urlwrite(url,filename,timeout)
The timeout is in milliseconds. Note that the URL must be a complete spec (i.e., including the name of the
resource you wish to retrieve). So for example, you cannot use http://www.google.com as a URL, but must
instead use http://www.google.com/index.html.
18.35
WAVPLAY
18.35.1
Usage
Plays a linear PCM set of samples through the audio system. This function is only available if the portaudio
library was available when FreeMat was built. The syntax for the command is one of:
wavplay(y)
wavplay(y,sampling_rate)
wavplay(...,mode)
where y is a matrix of audio samples. If y has two columns, then the audio playback is in stereo. The y input can be
of types float, double, int32, int16, int8, uint8. For float and double types, the sample
values in y must be between -1 and 1. The sampling_rate specifies the rate at which the data is recorded. If
not specified, the sampling_rate defaults to 11025Hz. Finally, you can specify a playback mode of sync
which is synchronous playback or a playback mode of async which is asynchronous playback. For sync
playback, the wavplay function returns when the playback is complete. For async playback, the function returns
immediately (unless a former playback is still issuing).
18.36
18.36.1
Usage
The wavread function (attempts) to read the contents of a linear PCM audio WAV file. This function could definitely
use improvements - it is based on a very simplistic notion of a WAV file. The simplest form for its use is
y = wavread(filename)
where filename is the name of the WAV file to read. If no extension is provided, FreeMat will add a .wav
extension. This loads the data from the WAV file into y, and returns it in double precision, normalized format. If
you want additional information on, for example, the WAV sampling rate or bit depth, you can request it via
[y, SamplingRate, BitDepth] = wavread(filename)
where SamplingRate and BitDepth are the sampling rate (in Hz) and the bit depth of the original data in the
WAV file. If you only want to load part of the WAV file, you can use
[...] = wavread(filename, N)
where N indicates the number of samples to read from the file. Alternately, you can indicate a range of samples to
load via
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
18.37 WAVRECORD
343
which returns only the indicated samples from each channel in the file. By default, the output format is double
precision. You can cntrol the format of the output by indicating
[...] = wavread(filename, format)
where format is either double for double precision output, or native for native precision output (meaning whatever bitdepth that was present in the original file). Finally, you can use the size flag
y_siz = wavread(filename,size)
which returns a vector [samples channels] indicating the size of the data present in the WAV file.
18.37
WAVRECORD
18.37.1
Usage
Records linear PCM sound from the audio system. This function is only available if the portaudio library was
available when FreeMat was built. The syntax for this command is one of:
y = wavrecord(samples,rate)
y = wavrecord(...,channels)
y = wavrecord(...,datatype)
where samples is the number of samples to record, and rate is the sampling rate. If not specified, the rate
defaults to 11025Hz. If you want to record in stero, specify channels = 2. Finally, you can specify the type of
the recorded data (defaults to FM_DOUBLE). Valid choices are float, double, int32, int16, int8,
uint8.
18.38
18.38.1
Usage
The wavwrite funtion writes an audio signal to a linear PCM WAV file. The simplest form for its use is
wavwrite(y,filename)
which writes the data stored in y to a WAV file with the name filename. By default, the output data is assumed to
be sampled at a rate of 8 KHz, and is output using 16 bit integer format. Each column of y is written as a separate
channel. The data are clipped to the range [-1,1] prior to writing them out. If you want the data to be written with
a different sampling frequency, you can use the following form of the wavwrite command:
wavwrite(y,SampleRate,filename)
where SampleRate is in Hz. Finally, you can specify the number of bits to use in the output form of the file using
the form
wavwrite(y,SampleRate,NBits,filename)
where NBits is the number of bits to use. Legal values include 8,16,24,32. For less than 32 bit output format,
the data is truncated to the range [-1,1], and an integer output format is used (type 1 PCM in WAV-speak). For
32 bit output format, the data is written in type 3 PCM as floating point data.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
344
18.39
Input/Ouput Functions
18.39.1
Usage
Given a filename, reads an XML document, parses it, and returns the result as a FreeMat data structure. The syntax
for its use is:
p = xmlread(filename)
where filename is a string. The resulting object p is a data structure containing the information in the
document. Note that the returned object p is not the same object as the one returned by MATLABs xmlread,
although the information content is the same. The output is largely compatible with the output of the parseXML
example in the xmlread documentation of the MATLAB API.
Chapter 19
Mathematical Functions
ACOS Inverse Trigonometric Arccosine Function
ACOSD Inverse Cosine Degrees Function
ACOSH Inverse Hyperbolic Cosine Function
ACOT Inverse Cotangent Function
ACOTD Inverse Cotangent Degrees Function
ACOTH Inverse Hyperbolic Cotangent Function
ACSC Inverse Cosecant Function
ACSCD Inverse Cosecant Degrees Function
ACSCH Inverse Hyperbolic Cosecant Function
ANGLE Phase Angle Function
ASEC Inverse Secant Function
ASECD Inverse Secant Degrees Function
ASECH Inverse Hyperbolic Secant Function
ASIN Inverse Trigonometric Arcsine Function
ASIND Inverse Sine Degrees Function
ASINH Inverse Hyperbolic Sine Function
ATAN Inverse Trigonometric Arctangent Function
ATAN2 Inverse Trigonometric 4-Quadrant Arctangent Function
ATAND Inverse Tangent Degrees Function
ATANH Inverse Hyperbolic Tangent Function
BETAINC Incomplete Beta Function
COS Trigonometric Cosine Function
COSD Cosine Degrees Function
COSH Hyperbolic Cosine Function
COT Trigonometric Cotangent Function
COTD Cotangent Degrees Function
346
Mathematical Functions
COTH Hyperbolic Cotangent Function
CROSS Cross Product of Two Vectors
CSC Trigonometric Cosecant Function
CSCD Cosecant Degrees Function
CSCH Hyperbolic Cosecant Function
DEG2RAD Convert From Degrees To Radians
ERF Error Function
ERFC Complimentary Error Function
ERFINV Inverse Error Function
EXP Exponential Function
EXPM1 Exponential Minus One Function
FIX Round Towards Zero
GAMMA Gamma Function
GAMMALN Log Gamma Function
IDIV Integer Division Operation
LEGENDRE Associated Legendre Polynomial
LOG Natural Logarithm Function
LOG10 Base-10 Logarithm Function
LOG1P Natural Logarithm of 1+P Function
LOG2 Base-2 Logarithm Function
MOD Modulus Operation
MPOWER Matrix Power Function
POWER Element-wise Power Function
RAD2DEG Radians To Degrees Conversion Function
REM Remainder After Division
SEC Trigonometric Secant Function
SECD Secant Degrees Function
SECH Hyperbolic Secant Function
SIN Trigonometric Sine Function
SIND Sine Degrees Function
SINH Hyperbolic Sine Function
SQRT Square Root of an Array
TAN Trigonometric Tangent Function
TAND Tangent Degrees Function
TANH Hyperbolic Tangent Function
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
19.1
347
19.1.1
Usage
Computes the acos function for its argument. The general syntax for its use is
y = acos(x)
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the acos function. Output y is of the same size and type as the input x, (unless x is an integer, in
which case y is a double type).
19.1.2
Internals
acosx
p
pi
+ i log ix + 1 x2 .
2
For real valued variables x in the range [-1,1], the function is computed directly using the standard C librarys
numerical acos function. For both real and complex arguments x, note that generally
acos(cos(x)) 6= x,
19.1.3
Example
The following code demonstates the acos function over the range [-1,1].
--> t = linspace(-1,1);
--> plot(t,acos(t))
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
348
Mathematical Functions
3.5
3
2.5
2
1.5
1
0.5
0
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
19.2
19.2.1
Usage
Computes the inverse cosine of the argument, but returns the argument in degrees instead of radians (as is the
case for acos. The syntax for its use is
y = acosd(x)
19.2.2
349
Examples
--> acosd(sqrt(2)/2)
ans =
45.0000 +
0.0000i
--> acosd(0.5)
ans =
60.0000 +
19.3
0.0000i
19.3.1
Usage
Computes the inverse hyperbolic cosine of its argument. The general syntax for its use is
y = acosh(x)
19.3.2
Internals
19.3.3
Examples
--> x = linspace(1,pi);
--> plot(x,acosh(x)); grid(on);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
350
Mathematical Functions
2
1.8
1.6
1.4
1.2
1
0.8
0.6
0.4
0.2
0
1.5
2.5
3.5
19.4
19.4.1
Usage
Computes the inverse cotangent of its argument. The general syntax for its use is
y = acot(x)
19.4.2
351
Internals
19.4.3
Examples
--> x1 = -2*pi:pi/30:-0.1;
--> x2 = 0.1:pi/30:2*pi;
--> plot(x1,acot(x1),x2,acot(x2)); grid(on);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1
x
352
Mathematical Functions
1.5
0.5
-0.5
-1
-1.5
-8
-6
-4
-2
19.5
19.5.1
Usage
Computes the inverse cotangent of its argument in degrees. The general syntax for its use is
y = acotd(x)
19.6
353
19.6.1
Usage
Computes the inverse hyperbolic cotangent of its argument. The general syntax for its use is
y = acoth(x)
19.6.2
Internals
19.6.3
1
x
Examples
--> x = linspace(1,pi);
--> plot(x,acoth(x)); grid(on);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
354
Mathematical Functions
2.4
2.2
2
1.8
1.6
1.4
1.2
1
0.8
0.6
0.4
0.2
1.5
2.5
3.5
19.7
19.7.1
Usage
Computes the inverse cosecant of its argument. The general syntax for its use is
y = acsc(x)
19.7.2
355
Internals
19.7.3
Examples
--> x1 = -10:.01:-1.01;
--> x2 = 1.01:.01:10;
--> plot(x1,acsc(x1),x2,acsc(x2)); grid(on);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1
x
356
Mathematical Functions
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-20
-15
-10
-5
10
15
20
19.8
19.8.1
Usage
Computes the inverse cosecant of the argument, but returns the argument in degrees instead of radians (as is the
case for acsc. The syntax for its use is
y = acscd(x)
19.8.2
357
Examples
--> acscd(2/sqrt(2))
ans =
45.0000
--> acscd(0.5)
ans =
90.0000 - 75.4561i
19.9
19.9.1
Usage
Computes the inverse hyperbolic cosecant of its argument. The general syntax for its use is
y = acsch(x)
19.9.2
Internals
19.9.3
Examples
--> x1 = -20:.01:-1;
--> x2 = 1:.01:20;
--> plot(x1,acsch(x1),x2,acsch(x2)); grid(on);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1
x
358
Mathematical Functions
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-20
-15
-10
-5
10
15
20
19.10
19.10.1
Usage
Compute the phase angle in radians of a complex matrix. The general syntax for its use is
p = angle(c)
19.10.2
359
Internals
x = |x|e j
and we can compute
= atan2(x, x)
19.10.3
Example
Here are some examples of the use of angle in the polar decomposition of a complex number.
--> x = 3+4*i
x =
3.0000 +
4.0000i
--> a = abs(x)
a =
5
--> t = angle(x)
t =
0.9273
--> a*exp(i*t)
ans =
3.0000 +
4.0000i
19.11
19.11.1
Usage
Computes the inverse secant of its argument. The general syntax for its use is
y = asec(x)
19.11.2
Internals
1
x
360
19.11.3
Mathematical Functions
Examples
3.5
3
2.5
2
1.5
1
0.5
0
-5
-4
-3
-2
-1
19.12
19.12.1
361
Usage
Computes the inverse secant of the argument, but returns the argument in degrees instead of radians (as is the
case for asec. The syntax for its use is
y = asecd(x)
19.12.2
Examples
0.0000i
19.13
0.0000i
19.13.1
Usage
Computes the inverse hyperbolic secant of its argument. The general syntax for its use is
y = asech(x)
19.13.2
Internals
19.13.3
1
x
Examples
362
Mathematical Functions
3.5
3
2.5
2
1.5
1
0.5
0
-20
-15
-10
-5
10
15
20
19.14
19.14.1
Usage
Computes the asin function for its argument. The general syntax for its use is
y = asin(x)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
363
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the asin function. Output y is of the same size and type as the input x, (unless x is an integer, in
which case y is a double type).
19.14.2
Internals
p
asinx i log ix + 1 x2 .
For real valued variables x in the range [-1,1], the function is computed directly using the standard C librarys
numerical asin function. For both real and complex arguments x, note that generally
asin(sin(x)) 6= x,
19.14.3
Example
The following code demonstates the asin function over the range [-1,1].
--> t = linspace(-1,1);
--> plot(t,asin(t))
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
364
Mathematical Functions
2
1.5
1
0.5
0
-0.5
-1
-1.5
-2
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
19.15
19.15.1
Usage
Computes the inverse sine of the argument, but returns the argument in degrees instead of radians (as is the case
for asin). The syntax for its use is
y = asind(x)
19.15.2
365
Examples
--> asind(sqrt(2)/2)
ans =
45.0000
--> asind(0.5)
ans =
30.0000
19.16
19.16.1
Usage
Computes the inverse hyperbolic sine of its argument. The general syntax for its use is
y = asinh(x)
19.16.2
Internals
19.16.3
Examples
--> x = -5:.01:5;
--> plot(x,asinh(x)); grid(on);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
366
Mathematical Functions
2.5
2
1.5
1
0.5
0
-0.5
-1
-1.5
-2
-2.5
-5
-4
-3
-2
-1
19.17
19.17.1
Usage
Computes the atan function for its argument. The general syntax for its use is
y = atan(x)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
367
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the atan function. Output y is of the same size and type as the input x, (unless x is an integer, in
which case y is a double type).
19.17.2
Internals
atanx
i
(log(1 ix) log(ix + 1)) .
2
For real valued variables x, the function is computed directly using the standard C librarys numerical atan function.
For both real and complex arguments x, note that generally
atan(tan(x)) 6= x,
19.17.3
Example
The following code demonstates the atan function over the range [-1,1].
--> t = linspace(-1,1);
--> plot(t,atan(t))
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
368
Mathematical Functions
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
19.18
19.18.1
Usage
Computes the atan2 function for its argument. The general syntax for its use is
z = atan2(y,x)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
369
where x and y are n-dimensional arrays of numerical type. Integer types are promoted to the double type prior
to calculation of the atan2 function. The size of the output depends on the size of x and y. If x is a scalar, then z
is the same size as y, and if y is a scalar, then z is the same size as x. The type of the output is equal to the type
of |y/x|.
19.18.2
Internals
The function is defined (for real values) to return an angle between -pi and pi. The signs of x and y are used to
find the correct quadrant for the solution. For complex arguments, the two-argument arctangent is computed via
atan2(y, x) i log
x + iy
p
x2 + y2
For real valued arguments x,y, the function is computed directly using the standard C librarys numerical atan2
function. For both real and complex arguments x, note that generally
atan2(sin(x), cos(x)) 6= x,
19.18.3
Example
The following code demonstates the difference between the atan2 function and the atan function over the range
[-pi,pi].
--> x = linspace(-pi,pi);
--> sx = sin(x); cx = cos(x);
--> plot(x,atan(sx./cx),x,atan2(sx,cx))
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
370
Mathematical Functions
4
3
2
1
0
-1
-2
-3
-4
-4
-3
-2
-1
Note how the two-argument atan2 function (green line) correctly unwraps the phase of the angle, while the atan
function (red line) wraps the angle to the interval [/2, /2].
19.19
19.19.1
371
Usage
Computes the inverse tangent of the argument, but returns the argument in degrees instead of radians (as is the
case for atan. The syntax for its use is
y = atand(x)
19.19.2
Examples
--> atand(1)
ans =
45
19.20
19.20.1
Usage
Computes the inverse hyperbolic tangent of its argument. The general syntax for its use is
y = atanh(x)
19.20.2
Internals
1+x
1
tanh (x) = log
2
1x
1
where the log (and square root) is taken in its most general sense.
19.20.3
Examples
--> x = -0.99:.01:0.99;
--> plot(x,atanh(x)); grid(on);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
372
Mathematical Functions
-1
-2
-3
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
19.21
19.21.1
Usage
Computes the incomplete beta function. The betainc function takes 3 or 4 arguments
A = betainc(X,Y,Z)
A = betainc(X,Y,Z,tail)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
373
where X is either a float or double array with elements in [0,1] interval, Y and Z are real non-negative arrays.
tail specifies the tail of the incomplete beta function. If tail is lower (default) than the integral from 0 to x is
computed. If tail is upper than the integral from x to 1 is computed. All arrays must be the same size or be
scalar. The output vector A is the same size (and type) as input arrays.
19.21.2
Internals
Z x
19.21.3
Example
--> x=.2:.01:.8;
--> y = betainc(x,5,3);
--> plot(x,y); xlabel(x); ylabel(betainc(x,5,3));
374
Mathematical Functions
0.9
0.8
0.7
betainc(x,5,3)
0.6
0.5
0.4
0.3
0.2
0.1
0
0.2
0.3
0.4
0.5
0.6
0.7
0.8
0.9
19.22
19.22.1
Usage
Computes the cos function for its argument. The general syntax for its use is
y = cos(x)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
375
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the cos function. Output y is of the same size and type as the input x, (unless x is an integer, in
which case y is a double type).
19.22.2
Internals
Mathematically, the cos function is defined for all real valued arguments x by the infinite summation
(1)n x2n
.
n=0 (2n)!
cos x
19.22.3
Example
The following piece of code plots the real-valued cos(2 pi x) function over one period of [0,1]:
--> x = linspace(0,1);
--> plot(x,cos(2*pi*x))
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
376
Mathematical Functions
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
0.1
0.2
0.3
0.4
0.5
0.6
0.7
0.8
0.9
1.1
19.23
19.23.1
Usage
Computes the cosine of the argument, but takes the argument in degrees instead of radians (as is the case for
cos). The syntax for its use is
y = cosd(x)
19.23.2
377
Examples
--> cosd(45)
ans =
0.7071
--> cosd(60)
ans =
0.5000
19.24
19.24.1
Usage
Computes the hyperbolic cosine of the argument. The syntax for its use is
y = cosh(x)
19.24.2
Internals
cosh(x) =
ex + ex
2
cosh(a + i b) =
19.24.3
Examples
--> x = linspace(-5,5);
--> plot(x,cosh(x)); grid(on);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
378
Mathematical Functions
80
70
60
50
40
30
20
10
0
-5
-4
-3
-2
-1
19.25
19.25.1
Usage
Computes the cot function for its argument. The general syntax for its use is
y = cot(x)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
379
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the cot function. Output y is of the same size and type as the input x, (unless x is an integer, in
which case y is a double type).
19.25.2
Internals
cot x
cos x
sin x
cot z
19.25.3
cos 2z + cosh 2z
.
sin 2z + i sinh 2z
Example
The following piece of code plots the real-valued cot(x) function over the interval [-1,1]:
--> t = linspace(-1,1);
--> plot(t,cot(t))
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
380
Mathematical Functions
100
80
60
40
20
0
-20
-40
-60
-80
-100
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
19.26
19.26.1
Usage
Computes the cotangent of the argument, but takes the argument in degrees instead of radians (as is the case for
cot). The syntax for its use is
y = cotd(x)
19.26.2
381
Examples
--> cotd(45)
ans =
1.0000
19.27
19.27.1
Usage
Computes the hyperbolic cotangent of the argument. The syntax for its use is
y = coth(x)
19.27.2
Internals
coth(x) =
19.27.3
Examples
--> x1 = -pi+.01:.01:-.01;
--> x2 = .01:.01:pi-.01;
--> plot(x1,coth(x1),x2,coth(x2)); grid(on);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1
tanh(x)
382
Mathematical Functions
120
100
80
60
40
20
0
-20
-40
-60
-80
-100
-4
-3
-2
-1
19.28
19.28.1
Usage
Computes the cross product of two vectors. The general syntax for its use is
c = cross(a,b)
19.29
383
19.29.1
Usage
Computes the csc function for its argument. The general syntax for its use is
y = csc(x)
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the csc function. Output y is of the same size and type as the input x, (unless x is an integer, in
which case y is a double type).
19.29.2
Internals
csc x
19.29.3
1
.
sin x
Example
The following piece of code plots the real-valued csc(2 pi x) function over the interval of [-1,1]:
--> t = linspace(-1,1,1000);
--> plot(t,csc(2*pi*t))
--> axis([-1,1,-10,10]);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
384
Mathematical Functions
10
8
6
4
2
0
-2
-4
-6
-8
-10
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
19.30
19.30.1
Usage
Computes the cosecant of the argument, but takes the argument in degrees instead of radians (as is the case for
csc). The syntax for its use is
y = cscd(x)
19.31
385
19.31.1
Usage
Computes the hyperbolic cosecant of the argument. The syntax for its use is
y = csch(x)
19.31.2
Internals
csch(x) =
19.31.3
Examples
--> x1 = -pi+.01:.01:-.01;
--> x2 = .01:.01:pi-.01;
--> plot(x1,csch(x1),x2,csch(x2)); grid(on);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1
sinh(x)
386
Mathematical Functions
100
80
60
40
20
0
-20
-40
-60
-80
-100
-4
-3
-2
-1
19.32
19.32.1
Usage
Converts the argument from degrees to radians. The syntax for its use is
y = deg2rad(x)
19.32.2
387
Example
19.33
19.33.1
Usage
Computes the error function for real arguments. The erf function takes only a single argument
y = erf(x)
where x is either a float or double array. The output vector y is the same size (and type) as x.
19.33.2
Internals
2
erf(x) =
19.33.3
Example
--> x = linspace(-5,5);
--> y = erf(x);
--> plot(x,y); xlabel(x); ylabel(erf(x));
Z x
0
et dt,
388
Mathematical Functions
1
0.8
0.6
0.4
erf(x)
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-5
-4
-3
-2
-1
19.34
19.34.1
Usage
Computes the complimentary error function for real arguments. The erfc function takes only a single argument
y = erfc(x)
where x is either a float or double array. The output vector y is the same size (and type) as x.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
19.34.2
389
Internals
2
erfc(x) =
Z
x
19.34.3
Example
--> x = linspace(-5,5);
--> y = erfc(x);
--> plot(x,y); xlabel(x); ylabel(erfc(x));
et dt,
390
Mathematical Functions
2
1.8
1.6
1.4
erfc(x)
1.2
1
0.8
0.6
0.4
0.2
0
-5
-4
-3
-2
-1
19.35
19.35.1
Usage
Computes the inverse error function for each element of x. The erf function takes only a single argument
y = erfinv(x)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
391
where x is either a float or double array. The output vector y is the same size (and type) as x. For values
outside the interval [-1, 1] function returns NaN.
19.35.2
Example
1.5
erfinv(x)
0.5
-0.5
-1
-1.5
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
392
19.36
Mathematical Functions
19.36.1
Usage
Computes the exp function for its argument. The general syntax for its use is
y = exp(x)
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the exp function. Output y is of the same size and type as the input x, (unless x is an integer, in
which case y is a double type).
19.36.2
Internals
Mathematically, the exp function is defined for all real valued arguments x as
exp x ex ,
where
e=
0
1
k!
and is approximately 2.718281828459045 (returned by the function e). For complex values z, the famous
Euler formula is used to calculate the exponential
19.36.3
Example
The following piece of code plots the real-valued exp function over the interval [-1,1]:
--> x = linspace(-1,1);
--> plot(x,exp(x))
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
393
2.5
1.5
0.5
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
In the second example, we plot the unit circle in the complex plane e {i 2 pi x} for x in [-1,1].
--> x = linspace(-1,1);
--> plot(exp(-i*x*2*pi))
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
394
Mathematical Functions
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
19.37
19.37.1
Usage
Computes exp(x)-1 function accurately for x small. The syntax for its use is
y = expm1(x)
19.38
395
19.38.1
Usage
Rounds the argument array towards zero. The syntax for its use is
y = fix(x)
where x is a numeric array. For positive elements of x, the output is the largest integer smaller than x. For negative
elements of x the output is the smallest integer larger than x. For complex x, the operation is applied seperately to
the real and imaginary parts.
19.38.2
Example
0.0000i
3.1416 +
0.0000i
8.0000 +
0.0000i
-0.0010 +
0.0000i
2.3000 +
0.3000i
3.0000 +
0.0000i
8.0000 +
0.0000i
Columns 4 to 6
-3.1416 +
0.0000i
--> fix(a)
ans =
Columns 1 to 3
-1.0000 +
0.0000i
Columns 4 to 6
-3.0000 +
19.39
0.0000i
2.0000 +
0.0000i
19.39.1
Usage
Computes the gamma function for real arguments. The gamma function takes only a single argument
y = gamma(x)
where x is either a float or double array. The output vector y is the same size (and type) as x.
19.39.2
Internals
(x) =
0
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
et t x1 dt
396
Mathematical Functions
19.39.3
Example
-->
-->
-->
-->
x = linspace(-5,5);
y = gamma(x);
plot(x,y); xlabel(x); ylabel(gamma(x));
axis([-5,5,-5,5]);
397
5
4
3
gamma(x)
2
1
0
-1
-2
-3
-4
-5
-5
-4
-3
-2
-1
19.40
19.40.1
Usage
Computes the natural log of the gamma function for real arguments. The gammaln function takes only a single
argument
y = gammaln(x)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
398
Mathematical Functions
where x is either a float or double array. The output vector y is the same size (and type) as x.
19.40.2
Example
14
12
gammaln(x)
10
8
6
4
2
0
-2
10
19.41
399
19.41.1
Usage
Computes the integer division of two arrays. The syntax for its use is
y = idiv(a,b)
where a and b are arrays or scalars. The effect of the idiv is to compute the integer division of b into a.
19.41.2
Example
19.42
19.42.1
Usage
where x is either a float or double array in range [-1,1], n is integer scalar. The output vector y is the same
size (and type) as x.
19.42.2
Example
400
Mathematical Functions
1
0.8
legendre(4,x)
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
19.43
19.43.1
Usage
Computes the log function for its argument. The general syntax for its use is
y = log(x)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
401
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the log function. Output y is of the same size as the input x. For strictly positive, real inputs, the
output type is the same as the input. For negative and complex arguments, the output is complex.
19.43.2
Internals
Mathematically, the log function is defined for all real valued arguments x by the integral
log x
Z x
dt
1
19.43.3
Example
The following piece of code plots the real-valued log function over the interval [1,100]:
-->
-->
-->
-->
x = linspace(1,100);
plot(x,log(x))
xlabel(x);
ylabel(log(x));
402
Mathematical Functions
5
4.5
4
3.5
log(x)
3
2.5
2
1.5
1
0.5
0
10
20
30
40
50
60
70
80
90
100
19.44
19.44.1
Usage
Computes the log10 function for its argument. The general syntax for its use is
y = log10(x)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
403
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the log10 function. Output y is of the same size as the input x. For strictly positive, real inputs, the
output type is the same as the input. For negative and complex arguments, the output is complex.
19.44.2
Example
The following piece of code plots the real-valued log10 function over the interval [1,100]:
-->
-->
-->
-->
x = linspace(1,100);
plot(x,log10(x))
xlabel(x);
ylabel(log10(x));
2.2
2
1.8
1.6
log10(x)
1.4
1.2
1
0.8
0.6
0.4
0.2
0
10
20
30
40
50
60
70
80
90
100
404
Mathematical Functions
19.45
19.45.1
Usage
Computes the log function for one plus its argument. The general syntax for its use is
y = log1p(x)
19.46
19.46.1
Usage
Computes the log2 function for its argument. The general syntax for its use is
y = log2(x)
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the log2 function. Output y is of the same size as the input x. For strictly positive, real inputs, the
output type is the same as the input. For negative and complex arguments, the output is complex.
19.46.2
Example
The following piece of code plots the real-valued log2 function over the interval [1,100]:
-->
-->
-->
-->
x = linspace(1,100);
plot(x,log2(x))
xlabel(x);
ylabel(log2(x));
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
405
7
6
log2(x)
5
4
3
2
1
0
10
20
30
40
50
60
19.47
19.47.1
Usage
70
80
90
100
406
Mathematical Functions
where x is matrix, and n is the base of the modulus. The effect of the mod operator is to add or subtract multiples
of n to the vector x so that each element x_i is between 0 and n (strictly). Note that n does not have to be an
integer. Also, n can either be a scalar (same base for all elements of x), or a vector (different base for each element
of x).
Note that the following are defined behaviors:
1. mod(x,0) = x@
2. mod(x,x) = 0@
3. mod(x,n)@ has the same sign as n for all other cases.
19.47.2
Example
Here we use the second form of mod, with each element using a separate base.
--> mod([9 3 2 0],[1 0 2 2])
ans =
0 3 0 0
19.48
19.48.1
Usage
Computes the matrix power operator for two arrays. It is an M-file version of the operator. The syntax for its use is
y = mpower(a,b)
where y=a b. See the matrixpower documentation for more details on what this function actually does.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
19.49
407
19.49.1
Usage
Computes the element-wise power operator for two arrays. It is an M-file version of the . operator. The syntax for
its use is
y = power(a,b)
where y=a. b. See the dotpower documentation for more details on what this function actually does.
19.50
19.50.1
Usage
Converts the argument array from radians to degrees. The general syntax for its use is
y = rad2deg(x)
Note that the output type will be the same as the input type, and that complex arguments are allowed. The output is
not wrapped to [0,360).
19.50.2
Examples
19.51
19.51.1
Usage
Computes the remainder after division of an array. The syntax for its use is
y = rem(x,n)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
408
Mathematical Functions
where x is matrix, and n is the base of the modulus. The effect of the rem operator is to add or subtract multiples
of n to the vector x so that each element x_i is between 0 and n (strictly). Note that n does not have to be an
integer. Also, n can either be a scalar (same base for all elements of x), or a vector (different base for each element
of x).
Note that the following are defined behaviors:
1. rem(x,0) = nan@
2. rem(x,x) = 0@ for nonzero x
3. rem(x,n)@ has the same sign as x for all other cases.
Note that rem and mod return the same value if x and n are of the same sign. But differ by n if x and y have
different signs.
19.51.2
Example
Here we use the second form of rem, with each element using a separate base.
--> rem([9 3 2 0],[1 0 2 2])
ans =
0 NaN
19.52
19.52.1
Usage
Computes the sec function for its argument. The general syntax for its use is
y = sec(x)
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the sec function. Output y is of the same size and type as the input x, (unless x is an integer, in
which case y is a double type).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
19.52.2
409
Internals
sec x
19.52.3
1
.
cos x
Example
The following piece of code plots the real-valued sec(2 pi x) function over the interval of [-1,1]:
--> t = linspace(-1,1,1000);
--> plot(t,sec(2*pi*t))
--> axis([-1,1,-10,10]);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
410
Mathematical Functions
10
8
6
4
2
0
-2
-4
-6
-8
-10
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
19.53
19.53.1
Usage
Computes the secant of the argument, but takes the argument in degrees instead of radians (as is the case for
sec). The syntax for its use is
y = secd(x)
19.54
411
19.54.1
Usage
Computes the hyperbolic secant of the argument. The syntax for its use is
y = sech(x)
19.54.2
Internals
sech(x) =
19.54.3
Examples
--> x = -2*pi:.01:2*pi;
--> plot(x,sech(x)); grid(on);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1
cosh(x)
412
Mathematical Functions
1
0.9
0.8
0.7
0.6
0.5
0.4
0.3
0.2
0.1
0
-8
-6
-4
-2
19.55
19.55.1
Usage
Computes the sin function for its argument. The general syntax for its use is
y = sin(x)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
413
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the sin function. Output y is of the same size and type as the input x, (unless x is an integer, in
which case y is a double type).
19.55.2
Internals
Mathematically, the sin function is defined for all real valued arguments x by the infinite summation
(1)n1 x2n1
.
(2n 1)!
n=1
sin x
19.55.3
Example
The following piece of code plots the real-valued sin(2 pi x) function over one period of [0,1]:
--> x = linspace(0,1);
--> plot(x,sin(2*pi*x))
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
414
Mathematical Functions
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
0.1
0.2
0.3
0.4
0.5
0.6
0.7
0.8
0.9
1.1
19.56
19.56.1
Usage
Computes the sine of the argument, but takes the argument in degrees instead of radians (as is the case for cos).
The syntax for its use is
y = sind(x)
19.56.2
415
Examples
--> sind(45)
ans =
0.7071
--> sind(30)
ans =
0.5000
19.57
19.57.1
Usage
Computes the hyperbolic sine of the argument. The syntax for its use is
y = sinh(x)
19.57.2
Internals
sinh(x) =
19.57.3
Examples
--> x = linspace(-5,5);
--> plot(x,sinh(x)); grid(on);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
ex ex
2
416
Mathematical Functions
80
60
40
20
0
-20
-40
-60
-80
-5
-4
-3
-2
-1
19.58
19.58.1
Usage
Computes the square root of the argument matrix. The general syntax for its use is
y = sqrt(x)
19.58.2
417
Example
0.7071i
--> sqrt(-1)
ans =
0.0000 +
1.0000i
--> x = rand(4)
x =
0.4871
0.7049
0.5845
0.5407
0.5309
0.6431
0.8331
0.9178
0.3343
0.3320
0.9892
0.3408
0.1123
0.7799
0.9155
0.2274
0.7286
0.8020
0.9127
0.9580
0.5782
0.5762
0.9946
0.5838
0.3352
0.8831
0.9568
0.4769
--> sqrt(x)
ans =
0.6980
0.8396
0.7645
0.7354
19.59
19.59.1
Usage
Computes the tan function for its argument. The general syntax for its use is
y = tan(x)
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the tan function. Output y is of the same size and type as the input x, (unless x is an integer, in
which case y is a double type).
19.59.2
Internals
Mathematically, the tan function is defined for all real valued arguments x by the infinite summation
tan x x +
x3 2x5
+
+ ,
3
15
tan x
sin x
cos x
tan z
sin 2z + i sinh 2z
.
cos 2z + cosh 2z
418
19.59.3
Mathematical Functions
Example
The following piece of code plots the real-valued tan(x) function over the interval [-1,1]:
--> t = linspace(-1,1);
--> plot(t,tan(t))
2
1.5
1
0.5
0
-0.5
-1
-1.5
-2
-1
-0.8
-0.6
-0.4
-0.2
0.2
0.4
0.6
0.8
19.60
19.60.1
419
Usage
Computes the tangent of the argument, but takes the argument in degrees instead of radians (as is the case for
cos). The syntax for its use is
y = tand(x)
19.60.2
Examples
--> tand(45)
ans =
1.0000
19.61
19.61.1
Usage
Computes the hyperbolic tangent of the argument. The syntax for its use is
y = tanh(x)
19.61.2
Internals
tanh(x) =
19.61.3
Examples
--> x = linspace(-5,5);
--> plot(x,tanh(x)); grid(on);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
sinh(x)
cosh(x)
420
Mathematical Functions
1
0.8
0.6
0.4
0.2
0
-0.2
-0.4
-0.6
-0.8
-1
-5
-4
-3
-2
-1
Chapter 20
Numerical Methods
CUMTRAPZ Trapezoidal Rule Cumulative Integration
ODE45 Numerical Solution of ODEs
TRAPZ Trapezoidal Rule Integration
20.1
20.1.1
Usage
The cumtrapz routine has the following syntax @[ [z] = cumtrapz(x,y) @] where |x| is a dependent vector and |y| an
m-by-n matrix equal in at least one dimension to x. (e.g.:x = time samples, y = f(t))
Alternatively, you can enter
[z] = cumtrapz(y)
20.2
20.2.1
Usage
f(t,y)
y0
over the interval tspan=[t0 t1], you can use ode45. For example, to solve the ode
y
=
y(0) =
y
1
422
Numerical Methods
Columns 1 to 7
0
0.0030
0.0180
0.0930
0.3930
0.6930
0.9930
1.8930
2.1930
2.4930
2.7930
3.0000
Columns 8 to 14
1.2930
1.5930
y =
1.0000
1.0030
1.0182
1.0975
1.4814
1.9997
2.6993
3.6437
4.9185
6.6392
8.9620
12.0975
16.3299
20.0854
If you want a dense output (i.e., an output that also contains an interpolating spline), use instead
-->
SOL =
x: 1x14 double array
y: 1x14 double array
xe:
ye:
ie:
solver: generic_ode_solver
interpolant: 1x1 functionpointer array
idata: 1x1 struct array
You will notice that this function is available for "every" value of t, while
plot(t,y,o-)
423
If the output yn is very different from the input yn, the quality of interpolation may decrease.
20.3
20.3.1
Usage
The trapz routine has the following syntax @[ z = trapz(x,y) @] where |x| is a dependent vector and |y| an m-by-n
matrix equal in at least one dimension to x. (e.g.:|x| = time samples, y = f(t))
Alternatively, you can enter
z = trapz(y)
424
Numerical Methods
Chapter 21
Mathematical Operators
COLON Index Generation Operator
COMPARISONOPS Array Comparison Operators
DOTLEFTDIVIDE Element-wise Left-Division Operator
DOTPOWER Element-wise Power Operator
DOTRIGHTDIVIDE Element-wise Right-Division Operator
DOTTIMES Element-wise Multiplication Operator
HERMITIAN Matrix Hermitian (Conjugate Transpose) Operator
LEFTDIVIDE Matrix Equation Solver/Divide Operator
LOGICALOPS Logical Array Operators
MATRIXPOWER Matrix Power Operator
MINUS Subtraction Operator
PLUS Addition Operator
RIGHTDIVIDE Matrix Equation Solver/Divide Operator
TIMES Matrix Multiply Operator
TRANSPOSE Matrix Transpose Operator
TYPERULES Type Rules for Operators
21.1
21.1.1
Usage
There are two distinct syntaxes for the colon : operator - the two argument form
y = a : c
426
Mathematical Operators
The two argument form is exactly equivalent to a:1:c. The output y is the vector
21.1.2
Internals
The colon operator turns out to be trickier to implement than one might believe at first, primarily because the floating
point versions should do the right thing, which is not the obvious behavior. For example, suppose the user issues a
three point colon command
y = a : b : c
The first question that one might need to answer is: how many points in this vector? If you answered
n=
ca
+1
b
then you would be doing the straighforward, but not correct thing. because a, b, and c are all floating point values,
there are errors associated with each of the quantities that can lead to n not being an integer. A better way (and the
way FreeMat currently does the calculation) is to compute the bounding values (for b positive)
(c a) 0 (c a)
,
+1
n
b
b0
where
xy
means we replace x by the floating point number that is closest to it in the direction of y. Once we have determined
the number of points we have to compute the intermediate values
[a, a + b, a + 2 b, . . . , a + n b]
but one can readily verify for themselves that this may not be the same as the vector
fliplr[c, c b, c 2 b, . . . , c n b]
even for the case where
c = a+nb
for some n. The reason is that the roundoff in the calculations may be different depending on the nature of the sum.
FreeMat uses the following strategy to compute the double-colon vector:
1. The value n is computed by taking the floor of the larger value in the interval defined above.
2. If n falls inside the interval defined above, then it is assumed that the user intended c = a + nb, and the
symmetric algorithm is used. Otherwise, the nonsymmetric algorithm is used.
3. The symmetric algorithm computes the vector via
21.1.3
427
Examples
Now by half-steps:
--> y = 1:.5:4
y =
1.0000
1.5000
2.0000
2.5000
3.0000
3.5000
4.0000
2.5000
2.0000
1.5000
1.0000
3.5000
3.0000
If the endpoints are the same, one point is generated, regardless of the step size (middle argument)
--> y = 4:1:4
y =
4
21.2
21.2.1
Usage
There are a total of six comparison operators available in FreeMat, all of which are binary operators with the following
syntax
y
y
y
y
y
y
=
=
=
=
=
=
a
a
a
a
a
a
< b
<= b
> b
>= b
~= b
== b
where a and b are numerical arrays or scalars, and y is a logical array of the appropriate size. Each of the
operators has three modes of operation, summarized in the following list:
1. a is a scalar, b is an n-dimensional array - the output is then the same size as b, and contains the result of
comparing each element in b to the scalar a.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
428
Mathematical Operators
2. a is an n-dimensional array, b is a scalar - the output is the same size as a, and contains the result of
comparing each element in a to the scalar b.
3. a and b are both n-dimensional arrays of the same size - the output is then the same size as both a and b,
and contains the result of an element-wise comparison between a and b.
The operators behave the same way as in C, with unequal types being promoted using the standard type promotion
rules prior to comparisons. The only difference is that in FreeMat, the not-equals operator is = instead of !=.
21.2.2
Examples
-0.1876
1.5987
-0.9136
-0.2120
--> a>0
ans =
0 0 1 0 0
21.3
21.3.1
Usage
Divides two numerical arrays (elementwise) - gets its name from the fact that the divisor is on the left. There are
two forms for its use, both with the same general syntax:
y = a .\ b
where a and b are n-dimensional arrays of numerical type. In the first case, the two arguments are the same size,
in which case, the output y is the same size as the inputs, and is the element-wise division of b by a. In the second
case, either a or b is a scalar, in which case y is the same size as the larger argument, and is the division of the
scalar with each element of the other argument.
The rules for manipulating types has changed in FreeMat 4.0. See typerules for more details.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
21.3.2
429
Internals
There are three formulae for the dot-left-divide operator, depending on the sizes of the three arguments. In the most
general case, in which the two arguments are the same size, the output is computed via:
y(m1 , . . . , md ) =
b(m1 , . . . , md )
a(m1 , . . . , md )
y(m1 , . . . , md ) =
b(m1 , . . . , md )
a
y(m1 , . . . , md ) =
21.3.3
b
.
a(m1 , . . . , md )
Examples
Here are some examples of using the dot-left-divide operator. First, a straight-forward usage of the .\ operator.
The first example is straightforward:
--> 3 .\ 8
ans =
2.6667
4.0000i
--> b = 5 + 8*i
b =
5.0000 +
8.0000i
--> c = b .\ a
c =
0.5281 -
0.0449i
We can also demonstrate the three forms of the dot-left-divide operator. First the element-wise version:
--> a = [1,2;3,4]
a =
1 2
3 4
--> b = [2,3;6,7]
b =
2 3
6 7
--> c = a .\ b
c =
2.0000
2.0000
1.5000
1.7500
430
Mathematical Operators
1.5000
0.7500
--> c = 3 .\ a
c =
0.3333
1.0000
21.4
0.6667
1.3333
21.4.1
Usage
Raises one numerical array to another array (elementwise). There are three operators all with the same general
syntax:
y = a .^ b
The result y depends on which of the following three situations applies to the arguments a and b:
1. a is a scalar, b is an arbitrary n-dimensional numerical array, in which case the output is a raised to the power
of each element of b, and the output is the same size as b.
2. a is an n-dimensional numerical array, and b is a scalar, then the output is the same size as a, and is defined
by each element of a raised to the power b.
3. a and b are both n-dimensional numerical arrays of the same size. In this case, each element of the output
is the corresponding element of a raised to the power defined by the corresponding element of b.
The rules for manipulating types has changed in FreeMat 4.0. See typerules for more details.
21.4.2
Internals
There are three formulae for this operator. For the first form
y(m1 , . . . , md ) = a(m1 , . . . , md )b ,
and in the third form
21.4.3
Examples
We demonstrate the three forms of the dot-power operator using some simple examples. First, the case of a scalar
raised to a series of values.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
431
--> a = 2
a =
2
--> b = 1:4
b =
1 2 3 4
--> c = a.^b
c =
2
8 16
9 16
The third case shows the most general use of the dot-power operator.
--> A = [1,2;3,2]
A =
1 2
3 2
--> B = [2,1.5;0.5,0.6]
B =
2.0000
0.5000
1.5000
0.6000
--> C = A.^B
C =
1.0000
1.7321
21.5
2.8284
1.5157
21.5.1
Usage
Divides two numerical arrays (elementwise). There are two forms for its use, both with the same general syntax:
y = a ./ b
where a and b are n-dimensional arrays of numerical type. In the first case, the two arguments are the same size,
in which case, the output y is the same size as the inputs, and is the element-wise division of b by a. In the second
case, either a or b is a scalar, in which case y is the same size as the larger argument, and is the division of the
scalar with each element of the other argument.
The rules for manipulating types has changed in FreeMat 4.0. See typerules for more details.
432
Mathematical Operators
21.5.2
Internals
There are three formulae for the dot-right-divide operator, depending on the sizes of the three arguments. In the
most general case, in which the two arguments are the same size, the output is computed via:
y(m1 , . . . , md ) =
a(m1 , . . . , md )
b(m1 , . . . , md )
y(m1 , . . . , md ) =
a
b(m1 , . . . , md )
y(m1 , . . . , md ) =
21.5.3
a(m1 , . . . , md )
.
b
Examples
Here are some examples of using the dot-right-divide operator. First, a straight-forward usage of the ./ operator.
The first example is straightforward:
--> 3 ./ 8
ans =
0.3750
4.0000i
--> b = 5 + 8*i
b =
5.0000 +
8.0000i
--> c = a ./ b
c =
0.5281 -
0.0449i
We can also demonstrate the three forms of the dot-right-divide operator. First the element-wise version:
--> a = [1,2;3,4]
a =
1 2
3 4
--> b = [2,3;6,7]
b =
2 3
6 7
--> c = a ./ b
c =
0.5000
0.5000
0.6667
0.5714
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
433
0.6667
1.3333
--> c = 3 ./ a
c =
3.0000
1.0000
21.6
1.5000
0.7500
21.6.1
Usage
Multiplies two numerical arrays (elementwise). There are two forms for its use, both with the same general syntax:
y = a .* b
where a and b are n-dimensional arrays of numerical type. In the first case, the two arguments are the same size,
in which case, the output y is the same size as the inputs, and is the element-wise product of a and b. In the
second case, either a or b is a scalar, in which case y is the same size as the larger argument, and is the product
of the scalar with each element of the other argument.
The rules for manipulating types has changed in FreeMat 4.0. See typerules for more details.
21.6.2
Internals
There are three formulae for the dot-times operator, depending on the sizes of the three arguments. In the most
general case, in which the two arguments are the same size, the output is computed via:
y(m1 , . . . , md ) = a b(m1 , . . . , md ).
On the other hand, if b is a scalar, then the output is computed via
y(m1 , . . . , md ) = a(m1 , . . . , md ) b.
21.6.3
Examples
Here are some examples of using the dottimes operator. First, a straight-forward usage of the . operator. The first
example is straightforward:
--> 3 .* 8
ans =
24
434
Mathematical Operators
12.4000
15.5000
18.6000
21.7000
4.0000i
--> b = a .* 2
b =
6.0000 +
8.0000i
21.7
21.7.1
Usage
Computes the Hermitian of the argument (a 2D matrix). The syntax for its use is
y = a;
where a is a M x N numerical matrix. The output y is a numerical matrix of the same type of size N x M. This
operator is the conjugating transpose, which is different from the transpose operator . (which does not conjugate
complex values).
21.7.2
Internals
yi, j = a j,i
where y_ij is the element in the ith row and jth column of the output matrix y.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
21.7.3
435
Examples
2 0
1 -1
--> A
ans =
1 4
2 1
0 -1
Here, we use a complex matrix to demonstrate how the Hermitian operator conjugates the entries.
--> A = [1+i,2-i]
A =
1.0000 +
1.0000i
2.0000 -
1.0000i
--> A.
ans =
1.0000 +
2.0000 -
21.8
1.0000i
1.0000i
21.8.1
Usage
The divide operator </tt> is really a combination of three operators, all of which
where A and B are arrays of numerical type. The result Y depends on which
of the following three situations applies to the arguments A and B:
1. A is a scalar, B is an arbitrary n-dimensional numerical array, in which
case the output is each element of B divided by the scalar A.
2. A,B are matrices with the same number of rows, i.e., A is of size M x
K, and B is of size M x L, in which case the output is of size K x L.
The output follows the standard type promotion rules, although in the first
two cases, if A and B are integers, the output is an integer also, while in
the third case if A and B are integers, the output is of type double.
A few additional words about the third version, in which A and B are matrices.
Very loosely speaking, Y is the matrix that satisfies A Y = B. In cases
where such a matrix exists. If such a matrix does not exist, then a matrix
Y is returned that approximates A Y B.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
436
21.8.2
Mathematical Operators
Internals
B(m1 , . . . , md )
.
A
In the second form, the calculation of the output depends on the size of
A. Because each column of B is treated independantly, we can rewrite the
equation AY = B as
A[y1 , y2 , . . . , yl ] = [b1 , b2 , . . . , bl ]
where y_i are the columns of Y, and b_i are the columns of the matrix B. If
A is a square matrix, then the LAPACK routine gesvx (where the is replaced
with sdcz depending on the type of the arguments) is used, which uses an LU decomposition of A to solve the sequence of equations sequentially. If A
is singular, then a warning is emitted.
On the other hand, if A is rectangular, then the LAPACK routine gelsy is
used. Note that these routines are designed to work with matrices A that
are full rank - either full column rank or full row rank. If A fails to
satisfy this assumption, a warning is emitted. If A has full column rank
(and thus necessarily has more rows than columns), then theoretically, this
operator finds the columns y_i that satisfy:
yi = arg min kAy bi k2
y
and each column is thus the Least Squares solution of A y = b_i. On the
other hand, if A has full row rank (and thus necessarily has more columns
than rows), then theoretically, this operator finds the columns y_i that
satisfy
yi = arg min kyk2
Ay=bi
and each column is thus the Minimum Norm vector y_i that satisfies Ayi = bi .
In the event that the matrix A is neither full row rank nor full column
rank, a solution is returned, that is the minimum norm least squares solution.
The solution is computed using an orthogonal factorization technique that
is documented in the LAPACK Users Guide (see the References section for
details).
21.8.3
Examples
--> A = [1,1;0,1]
A =
1 1
0 1
1 y1
3
=
2
1 y2
Thus we compute:
--> B = [3;2]
B =
3
2
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
437
--> Y = A\B
Y =
1
2
21.9
21.9.1
Usage
There are three Boolean operators available in FreeMat. The syntax for their use is:
y = ~x
y = a & b
y = a | b
438
Mathematical Operators
OR (|) - output y is true if corresponding element of a is true or if corresponding element of b is true (or if
both are true).
AND (&) - output y is true only if both the corresponding elements of a and b are both true.
The binary operators AND and OR can take scalar arguments as well as vector arguments, in which case, the scalar
is operated on with each element of the vector. As of version 1.10, FreeMat supports shortcut evaluation. This
means that if we have two expressions
if (expr1 & expr2)
then if expr1 evaluates to false, then expr2 is not evaluated at all. Similarly, for the expression
if (expr1 | expr2)
then if expr1 evaluates to true, then expr2 is not evaluated at all. Shortcut evaluation is useful for doing a
sequence of tests, each of which is not valid unless the prior test is successful. For example,
if isa(p,string) & strcmp(p,fro)
is not valid without shortcut evaluation (if p is an integer, for example, the first test returns false, and an attempt
to evaluate the second expression would lead to an error). Note that shortcut evaluation only works with scalar
expressions.
21.9.2
Examples
Some simple examples of logical operators. Suppose we want to calculate the exclusive-or (XOR) of two vectors of
logical variables. First, we create a pair of vectors to perform the XOR operation on:
--> a = (randn(1,6)>0)
a =
0 0 0 0 1 0
--> b = (randn(1,6)>0)
b =
1 1 0 1 0 1
However, the XOR and OR operations differ on the fifth entry - the XOR would be false, since it is true if and only if
exactly one of the two inputs is true. To isolate this case, we can AND the two vectors, to find exactly those entries
that appear as true in both a and b:
--> d = a & b
d =
0 0 0 0 0 0
At this point, we can modify the contents of c in two ways the Boolean way is to AND d with c, like so
--> xor = c & (~d)
xor =
1 1 0 1 1 1
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
439
The other way to do this is simply force c(d) = 0, which uses the logical indexing mode of FreeMat (see the
chapter on indexing for more details). This, however, will cause c to become an int32 type, as opposed to a
logical type.
--> c(d) = 0
c =
1 1 0 1 1 1
21.10
21.10.1
Usage
The power operator for scalars and square matrices. This operator is really a combination of two operators, both of
which have the same general syntax:
y = a ^ b
The exact action taken by this operator, and the size and type of the output, depends on which of the two configurations of a and b is present:
1. a is a scalar, b is a square matrix
2. a is a square matrix, b is a scalar
21.10.2
Internals
In the first case that a is a scalar, and b is a square matrix, the matrix power is defined in terms of the eigenvalue
decomposition of b. Let b have the following eigen-decomposition (problems arise with non-symmetric matrices b,
so let us assume that b is symmetric):
0
b=E
..
.
0
..
..
...
..
..
.
E 1
0
n
a 1
0
ab = E
..
.
0
a2
..
..
..
...
..
.
E 1
0
an
Similarly, if a is a square matrix, then a has the following eigen-decomposition (again, suppose a is symmetric):
0
a=E
..
.
0
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
..
..
...
..
..
.
E 1
0
n
440
Mathematical Operators
b
1
0
ab = E
..
.
0
21.10.3
..
..
...
2b
..
..
.
E 1
0
nb
Examples
0.2000
1.0000
0.2995
1.0150
21.11
0.1218
1.5049
21.11.1
Usage
Subtracts two numerical arrays (elementwise). There are two forms for its use, both with the same general syntax:
y = a - b
where a and b are n-dimensional arrays of numerical type. In the first case, the two arguments are the same size,
in which case, the output y is the same size as the inputs, and is the element-wise difference of a and b. In the
second case, either a or b is a scalar, in which case y is the same size as the larger argument, and is the difference
of the scalar to each element of the other argument.
The rules for manipulating types has changed in FreeMat 4.0. See typerules for more details.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
21.11.2
441
Internals
There are three formulae for the subtraction operator, depending on the sizes of the three arguments. In the most
general case, in which the two arguments are the same size, the output is computed via:
y(m1 , . . . , md ) = a b(m1 , . . . , md ).
On the other hand, if b is a scalar, then the output is computed via
y(m1 , . . . , md ) = a(m1 , . . . , md ) b.
21.11.3
Examples
Here are some examples of using the subtraction operator. First, a straight-forward usage of the minus operator.
The first example is straightforward:
--> 3 - 8
ans =
-5
-0.9000
-1.9000
-2.9000
4.0000i
--> b = a - 2
b =
1.0000 -
4.0000i
-3.9000
442
21.12
Mathematical Operators
21.12.1
Usage
Adds two numerical arrays (elementwise) together. There are two forms for its use, both with the same general
syntax:
y = a + b
where a and b are n-dimensional arrays of numerical type. In the first case, the two arguments are the same size,
in which case, the output y is the same size as the inputs, and is the element-wise the sum of a and b. In the
second case, either a or b is a scalar, in which case y is the same size as the larger argument, and is the sum of
the scalar added to each element of the other argument.
The rules for manipulating types has changed in FreeMat 4.0. See typerules for more details.
21.12.2
Internals
There are three formulae for the addition operator, depending on the sizes of the three arguments. In the most
general case, in which the two arguments are the same size, the output is computed via:
y(m1 , . . . , md ) = a + b(m1 , . . . , md ).
On the other hand, if b is a scalar, then the output is computed via
y(m1 , . . . , md ) = a(m1 , . . . , md ) + b.
21.12.3
Examples
Here are some examples of using the addition operator. First, a straight-forward usage of the plus operator. The
first example is straightforward:
--> 3 + 8
ans =
11
7.1000
8.1000
9.1000
10.1000
4.0000i
--> b = a + 2
b =
5.0000 +
4.0000i
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
443
21.13
21.13.1
Usage
The divide operator / is really a combination of three operators, all of which have the same general syntax:
Y = A / B
where A and B are arrays of numerical type. The result Y depends on which of the following three situations applies
to the arguments A and B:
1. A is a scalar, B is an arbitrary n-dimensional numerical array, in which case the output is the scalar A divided
into each element of B.
2. B is a scalar, A is an arbitrary n-dimensional numerical array, in which case the output is each element of A
divided by the scalar B.
3. A,B are matrices with the same number of columns, i.e., A is of size K x M, and B is of size L x M, in
which case the output is of size K x L.
The output follows the standard type promotion rules, although in the first two cases, if A and B are integers, the
output is an integer also, while in the third case if A and B are integers, the output is of type double.
21.13.2
Internals
There are three formulae for the times operator. For the first form
Y (m1 , . . . , md ) =
A
,
B(m1 , . . . , md )
Y (m1 , . . . , md ) =
A(m1 , . . . , md )
.
B
Y = (B0 \A0 )0
444
21.13.3
Mathematical Operators
Examples
The right-divide operator is much less frequently used than the left-divide operator, but the concepts are similar. It
can be used to find least-squares and minimum norm solutions. It can also be used to solve systems of equations
in much the same way. Heres a simple example:
--> B = [1,1;0,1];
--> A = [4,5]
A =
4 5
--> A/B
ans =
4 1
21.14
21.14.1
Usage
Multiplies two numerical arrays. This operator is really a combination of three operators, all of which have the same
general syntax:
y = a * b
where a and b are arrays of numerical type. The result y depends on which of the following three situations applies
to the arguments a and b:
1. a is a scalar, b is an arbitrary n-dimensional numerical array, in which case the output is the element-wise
product of b with the scalar a.
2. b is a scalar, a is an arbitrary n-dimensional numerical array, in which case the output is the element-wise
product of a with the scalar b.
3. a,b are conformant matrices, i.e., a is of size M x K, and b is of size K x N, in which case the output is
of size M x N and is the matrix product of a, and b.
Matrix multiplication is only defined for matrices of type double and single.
21.14.2
Internals
There are three formulae for the times operator. For the first form
y(m1 , . . . , md ) = a b(m1 , . . . , md ),
and the second form
y(m1 , . . . , md ) = a(m1 , . . . , md ) b.
In the third form, the output is the matrix product of the arguments
K
y(m, n) =
a(m, k)b(k, n)
k=1
21.14.3
445
Examples
Here are some examples of using the matrix multiplication operator. First, the scalar examples (types 1 and 2 from
the list above):
--> a = [1,3,4;0,2,1]
a =
1 3 4
0 2 1
--> b = a * 2
b =
2 6 8
0 4 2
The matrix form, where the first argument is 2 x 3, and the second argument is 3 x 1, so that the product is
size 2 x 1.
--> a = [1,2,0;4,2,3]
a =
1 2 0
4 2 3
--> b = [5;3;1]
b =
5
3
1
--> c = a*b
c =
11
29
21.15
21.15.1
Usage
Performs a transpose of the argument (a 2D matrix). The syntax for its use is
y = a.;
where a is a M x N numerical matrix. The output y is a numerical matrix of the same type of size N x M.
This operator is the non-conjugating transpose, which is different from the Hermitian operator (which conjugates
complex values).
21.15.2
Internals
yi, j = a j,i
where y_ij is the element in the ith row and jth column of the output matrix y.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
446
Mathematical Operators
21.15.3
Examples
2 0
1 -1
--> A.
ans =
1 4
2 1
0 -1
Here, we use a complex matrix to demonstrate how the transpose does not conjugate the entries.
--> A = [1+i,2-i]
A =
1.0000 +
1.0000i
2.0000 -
1.0000i
--> A.
ans =
1.0000 +
2.0000 -
21.16
1.0000i
1.0000i
21.16.1
Usage
Starting with FreeMat 4.0, the type of y is determined according to the same rules as Matlab. These are the rules:
1. Integer types of the same class can be combined. The answer is the same type as the inputs, and the
operation is performed using saturating arithmetic. Integer types can also be combined with double precision
values (again, the result is of the integer type).
2. Single precision floating point values can be combined with double precision, logical and character array
classes. The result is of class single.
3. Double precision floating point values can be combined with all other types. Except as noted above, the
output is of double precision.
These rules look strange, and they are. In general, computations are done in double precision in almost all cases.
When single precision values are involved, the computations take place in single precision.
Chapter 22
22.1
22.1.1
Usage
Changes the current working directory to the one specified as the argument. The general syntax for its use is
cd(dirname)
448
or
cd dirname
Examples of all three usages are given below. Generally speaking, dirname is any string that would be accepted
by the underlying OS as a valid directory name. For example, on most systems, . refers to the current directory,
and .. refers to the parent directory. Also, depending on the OS, it may be necessary to escape the directory
seperators. In particular, if directories are seperated with the backwards-slash character \, then the path specification must use double-slashes \\. Note: to get file-name completion to work at this time, you must use one
of the first two forms of the command.
22.1.2
Example
The pwd command returns the current directory location. First, we use the simplest form of the cd command, in
which the directory name argument is given unquoted.
--> pwd
ans =
/home/sbasu/Devel/FreeMat4/doc/fragments
--> cd ..
--> pwd
ans =
/home/sbasu/Devel/FreeMat4/doc
Next, we use the traditional form of the function call, using both the parenthesis and a variable to store the quoted
string.
--> a = pwd;
--> cd(a)
--> pwd
ans =
/home/sbasu/Devel/FreeMat4/doc/fragments
22.2
22.2.1
Usage
Copies a file or files from one location to another. There are several syntaxes for this function that are acceptable:
copyfile(file_in,file_out)
copies the file from file_in to file_out. Also, the second argument can be a directory name:
copyfile(file_in,directory_out)
in which case file_in is copied into the directory specified by directory_out. You can also use copyfile
to copy entire directories as in
copyfile(dir_in,dir_out)
in which case the directory contents are copied to the destination directory (which is created if necessary). Finally,
the first argument to copyfile can contain wildcards
copyfile(pattern,directory_out)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
449
in which case all files that match the given pattern are copied to the output directory. Note that to remain compatible
with the MATLAB API, this function will delete/replace destination files that already exist, unless they are marked as
read-only. If you want to force the copy to succeed, you can append a f argument to the copyfile function:
copyfile(arg1,arg2,f)
or equivalently
copyfile arg1 arg2 f
22.3
22.3.1
Usage
or alternately
delete filename
which removes the file described by filename which must be relative to the current path.
22.4
22.4.1
Usage
In some versions of FreeMat (pre 3.1), the dir function was aliased to the ls function. Starting with version 3.1,
the dir function has been rewritten to provide compatibility with MATLAB. The general syntax for its use is
dir
in which case, a listing of the files in the current directory are output to the console. Alternately, you can specify a
target via
dir(name)
If you want to capture the output of the dir command, you can assign the output to an array
result = dir(name)
(or you can omit name to get a directory listing of the current directory. The resulting array result is a structure
array containing the fields:
name the filename as a string
date the modification date and time stamp as a string
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
450
Note that name can also contain wildcards (e.g., dir .m to get a listing of all FreeMat scripts in the current
directory.
22.5
22.5.1
Usage
Returns the directory seperator character for the current platform. The general syntax for its use is
y = dirsep
This function can be used to build up paths (or see fullfile for another way to do this.
22.6
22.6.1
Usage
Retrieves information about a file or directory. The first version uses the syntax
y = fileattrib(filename)
where filename is the name of a file or directory. The returned structure contains several entries, corresponding
to the attributes of the file. Here is a list of the entries, and their meaning:
Name - the full pathname for the file
archive - not used, set to 0
system - not used, set to 0
hidden - set to 1 for a hidden file, and 0 else.
directory - set to 1 for a directory, and 0 for a file.
UserRead - set to 1 if the user has read permission, 0 otherwise.
UserWrite - set to 1 if the user has write permission, 0 otherwise.
UserExecute - set to 1 if the user has execute permission, 0 otherwise.
GroupRead - set to 1 if the group has read permission, 0 otherwise.
GroupWrite - set to 1 if the group has write permission, 0 otherwise.
GroupExecute - set to 1 if the group has execute permission, 0 otherwise.
OtherRead - set to 1 if the world has read permission, 0 otherwise.
OtherWrite - set to 1 if the world has write permission, 0 otherwise.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
451
You can also use fileattrib to change the attributes of a file and/or directories. To change attributes, use one
of the following syntaxes
y = fileattrib(filename,attributelist)
y = fileattrib(filename,attributelist,userlist)
y = fileattrib(filename,attributelist,userlist,s)
where attributelist is a string that consists of a list of attributes, each preceeded by a + to enable the
attribute, and - to disable the attribute. The valid list of attributes that can be changed are
w - change write permissions
r - change read permissions
x - change execute permissions
for example, -w +r would indicate removal of write permissions and addition of read permissions. The
userlist is a string that lists the realm of the permission changes. If it is not specified, it defaults to u.
u - user or owner permissions
g - group permissions
o - other permissions ("world" in normal Unix terminology)
a - equivalent to ugo.
Finally, if you specify a s for the last argument, the attribute change is applied recursively, so that setting the
attributes for a directory will apply to all the entries within the directory.
22.7
22.7.1
Usage
The fileparts takes a filename, and returns the path, filename, extension, and (for MATLAB-compatibility) an
empty version number of the file. The syntax for its use is
[path,name,extension,version] = fileparts(filename)
where filename is a string containing the description of the file, and path is the path to the file,
22.8
452
22.8.1
Usage
The fullfile routine constructs a full filename from a set of pieces, namely, directory names and a filename.
The syntax is:
x = fullfile(dir1,dir2,...,dirn,filename)
where each of the arguments are strings. The fullfile function is equivalent to [dir1 dirsep dir2
dirsep ... dirn dirsep filename].
22.8.2
Example
--> fullfile(path,to,my,file.m)
ans =
path/to/my/file.m
22.9
22.9.1
Usage
The getenv function returns the value for an environment variable from the underlying OS. The syntax for the
getenv function is
y = getenv(environment_variable)
where environment_variable is the name of the environment variable to return. The return is a string.
22.9.2
Example
Here is an example of using the getenv function to get the value for the HOME variable
--> getenv(HOME)
ans =
/home/sbasu
22.10
22.10.1
Usage
Returns a string containing the current FreeMat search path. The general syntax for its use is
y = getpath
The delimiter between the paths depends on the system being used. For Win32, the delimiter is a semicolon. For
all other systems, the delimiter is a colon.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
22.10.2
453
Example
22.11
22.11.1
Usage
Lists the files in a directory or directories. The general syntax for its use is
ls(dirname1,dirname2,...,dirnameN)
or
ls dirname1 dirname2 ... dirnameN
For compatibility with some environments, the function dir can also be used instead of ls. Generally speaking,
dirname is any string that would be accepted by the underlying OS as a valid directory name. For example, on
most systems, . refers to the current directory, and .. refers to the parent directory. Also, depending on
the OS, it may be necessary to escape the directory seperators. In particular, if directories are seperated with
the backwards-slash character \, then the path specification must use double-slashes \\. Two points worth
mentioning about the ls function:
To get file-name completion to work at this time, you must use one of the first two forms of the command.
If you want to capture the output of the ls command, use the system function instead.
22.11.2
Example
First, we use the simplest form of the ls command, in which the directory name argument is given unquoted.
--> ls m*.m
Next, we use the traditional form of the function call, using both the parenthesis and the quoted string.
--> ls(m*.m)
In the third version, we use only the quoted string argument without parenthesis.
--> ls m*.m
22.12
454
22.12.1
Usage
which creates the directory dirname if it does not exist. The argument dirname can be either a relative path or
an absolute path. For compatibility with MATLAB, the following syntax is also allowed
mkdir(parentdir,dirname)
which attempts to create a directory dirname in the directory given by parentdir. However, this simply calls
mkdir([parentdir dirsep dirname]), and if this is not the required behavior, please file an enhancement request to have it changed. Note that mkdir returns a logical 1 if the call succeeded, and a logical 0 if not.
22.13
22.13.1
Usage
Returns a string describing the current working directory. The general syntax for its use is
y = pwd
22.13.2
Example
22.14
22.14.1
Usage
which removes the directory dirname if it is empty. If you want to delete the directory and all subdirectories and
files in it, use the syntax
rmdir(dirname,s)
22.15
22.15.1
455
Usage
Changes the current FreeMat search path. The general syntax for its use is
setpath(y)
where y is a string containing a delimited list of directories to be searched for M files and libraries. The delimiter
between the paths depends on the system being used. For Win32, the delimiter is a semicolon. For all other
systems, the delimiter is a colon.
22.15.2
Example
22.16
22.16.1
Usage
The system function allows you to call an external program from within FreeMat, and capture the output. The
syntax of the system function is
y = system(cmd)
where cmd is the command to execute. The return array y is of type cell-array, where each entry in the array
corresponds to a line from the output.
22.16.2
Example
Here is an example of calling the ls function (the list files function under Unx-like operating system).
--> y = system(ls a*.m)
y =
[addtest2.m] [addtest3.m] [addtest.m]
--> y{1}
ans =
addtest2.m
456
Chapter 23
23.1
23.1.1
Usage
Creates an array of pseudo-random numbers of the specified size. The numbers are uniformly distributed on
[0,1). Two seperate syntaxes are possible. The first syntax specifies the array dimensions as a sequence of
scalar dimensions:
y = rand(d1,d2,...,dn).
458
The resulting array has the given dimensions, and is filled with random numbers. The type of y is double, a 64-bit
floating point array. To get arrays of other types, use the typecast functions.
The second syntax specifies the array dimensions as a vector, where each element in the vector specifies a dimension length:
y = rand([d1,d2,...,dn]).
This syntax is more convenient for calling rand using a variable for the argument.
Finally, rand supports two additional forms that allow you to manipulate the state of the random number generator.
The first retrieves the state
y = rand(state)
which is a 625 length integer vector. The second form sets the state
rand(state,y)
23.1.2
Example
The following example demonstrates an example of using the first form of the rand function.
--> rand(2,2,2)
ans =
(:,:,1) =
0.8539
0.0415
0.1733
0.1300
(:,:,2) =
0.7163
0.5953
0.5752
0.3728
The second example demonstrates the second form of the rand function.
--> rand([2,2,2])
ans =
(:,:,1) =
0.4992
0.6513
0.2797
0.3209
(:,:,2) =
0.6244
0.0934
0.7774
0.1820
The third example computes the mean and variance of a large number of uniform random numbers. Recall that the
mean should be 1/2, and the variance should be 1/12 0.083.
--> x = rand(1,10000);
--> mean(x)
ans =
0.4952
--> var(x)
ans =
0.0845
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
459
Now, we use the state manipulation functions of rand to exactly reproduce a random sequence. Note that unlike
using seed, we can exactly control where the random number generator starts by saving the state.
--> rand(state,0)
--> a = rand(1,3)
a =
0.3759
0.0183
0.9134
0.7604
--> rand(state,b);
--> c = rand(1,3)
0.8077
% restart the random generator so...
% we get random sequence 2 again
c =
0.3580
23.2
0.7604
0.8077
23.2.1
Usage
Creates an array of beta random deviates based on the supplied two parameters.
randbeta is
y = randbeta(alpha, beta)
where alpha and beta are the two parameters of the random deviate. There are three forms for calling
randbeta. The first uses two vectors alpha and beta of the same size, in which case the output y is the
same size as both inputs, and each deviate uses the corresponding values of alpha and beta from the arguments. In the other forms, either alpha or beta are scalars.
23.2.2
Internals
23.2.3
Example
Here is a plot of the PDF of a beta random variable with a=3, b=7.
-->
-->
-->
-->
a = 3; b = 7;
x = (0:100)/100; t = x.^(a-1).*(1-x).^(b-1);
t = t/(sum(t)*.01);
plot(x,t);
which is plotted as
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
460
2.5
1.5
0.5
0.1
0.2
0.3
0.4
0.5
0.6
0.7
0.8
0.9
1.1
If we generate a few random deviates with these values, we see they are distributed around the peak of roughly
0.25.
--> randbeta(3*ones(1,5),7*ones(1,5))
ans =
0.4343
23.3
0.4220
0.3992
0.2727
0.2475
23.3.1
461
Usage
Generates random variables with a binomial distribution. The general syntax for its use is
y = randbin(N,p)
where N is a vector representing the number of Bernoulli trials, and p is the success probability associated with
each trial.
23.3.2
Internals
A Binomial random variable describes the number of successful outcomes from N Bernoulli trials, with the probability
of success in each trial being p. The probability distribution is
P(n) =
23.3.3
N!
pn (1 p)Nn
n!(N n)!
Example
Here we generate 10 binomial random variables, corresponding to N=100 trials, each with probability p=0.1,
using both randbin and then again using rand (to simulate the trials):
--> randbin(100,.1*ones(1,10))
ans =
6 7
7 13
7 10 13 15
--> sum(rand(100,10)<0.1)
ans =
11 9
23.4
9 15 16 11 17
23.4.1
Usage
Generates a vector of chi-square random variables with the given number of degrees of freedom. The general
syntax for its use is
y = randchi(n)
where n is an array containing the degrees of freedom for each generated random variable.
23.4.2
Internals
A chi-square random variable is essentially distributed as the squared Euclidean norm of a vector of standard
Gaussian random variables. The number of degrees of freedom is generally the number of elements in the vector.
In general, the PDF of a chi-square random variable is
f (x) =
xr/21 ex/2
(r/2)2r/2
462
23.4.3
Example
f = zeros(7,100);
x = (1:100)/10;
for n=1:7;t=x.^(n/2-1).*exp(-x/2);f(n,:)=10*t/sum(t);end
plot(x,f);
1.6
1.4
1.2
1
0.8
0.6
0.4
0.2
0
10
Here is an example of using randchi and randn to compute some chi-square random variables with four degrees
of freedom.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
463
--> randchi(4*ones(1,6))
ans =
2.6122
6.2362
0.8717
1.4935
6.0370
5.2771
0.8697
0.5796
1.5490
5.8538
--> sum(randn(4,6).^2)
ans =
0.0399
23.5
4.6296
23.5.1
Usage
Generates a vector of exponential random variables with the specified parameter. The general syntax for its use is
y = randexp(lambda)
where lambda is a vector containing the parameters for the generated random variables.
23.5.2
Internals
The exponential random variable is usually associated with the waiting time between events in a Poisson random
process. The PDF of an exponential random variable is:
f (x) = e x
23.5.3
Example
Here is an example of using the randexp function to generate some exponentially distributed random variables
--> randexp(ones(1,6))
ans =
0.7969
23.6
0.2401
0.5891
1.5129
0.9998
2.7738
23.6.1
Usage
Generates random variables with an F-distribution. The general syntax for its use is
y = randf(n,m)
where n and m are vectors of the number of degrees of freedom in the numerator and denominator of the chi-square
random variables whose ratio defines the statistic.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
464
23.6.2
Internals
The statistic F_{n,m} is defined as the ratio of two chi-square random variables:
Fn,m =
n2 /n
m2 /m
fn,m =
23.6.3
Example
Here we use randf to generate some F-distributed random variables, and then again using the randchi function:
--> randf(5*ones(1,9),7)
ans =
Columns 1 to 7
0.5241
0.8414
0.4859
1.1266
0.4792
2.3743
2.9095
0.6337
0.4597
Columns 8 to 9
0.5825
0.4244
--> randchi(5*ones(1,9))./randchi(7*ones(1,9))
ans =
Columns 1 to 7
0.3737
0.2363
1.5733
0.7003
1.1385
Columns 8 to 9
0.2691
23.7
0.5190
23.7.1
Usage
Generates random variables with a gamma distribution. The general syntax for its use is
y = randgamma(a,r),
where a and r are vectors describing the parameters of the gamma distribution. Roughly speaking, if a is the
mean time between changes of a Poisson random process, and we wait for the r change, the resulting wait time is
Gamma distributed with parameters a and r.
23.7.2
Internals
The Gamma distribution arises in Poisson random processes. It represents the waiting time to the occurance of the
r-th event in a process with mean time a between events. The probability distribution of a Gamma random variable
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
465
is
P(x) =
ar xr1 eax
.
(r)
Note also that for integer values of r that a Gamma random variable is effectively the sum of r exponential random
variables with parameter a.
23.7.3
Example
Here we use the randgamma function to generate Gamma-distributed random variables, and then generate them
again using the randexp function.
--> randgamma(1,15*ones(1,9))
ans =
Columns 1 to 7
10.0227
12.4783
18.0388
21.7056
14.1249
15.9260
22.0177
16.9976
9.8463
12.7479
13.6879
Columns 8 to 9
15.9170
24.3781
--> sum(randexp(ones(15,9)))
ans =
Columns 1 to 7
14.5031
12.8908
10.5201
Columns 8 to 9
21.7005
23.8
11.4172
23.8.1
Usage
Generates an array of uniformly distributed integers between the two supplied limits. The general syntax for randi
is
y = randi(low,high)
where low and high are arrays of integers. Scalars can be used for one of the arguments. The output y is a
uniformly distributed pseudo-random number between low and high (inclusive).
23.8.2
Example
466
23.9
23.9.1
Usage
This function generates samples from a multinomial distribution given the probability of each outcome. The general
syntax for its use is
y = randmulti(N,pvec)
where N is the number of experiments to perform, and pvec is the vector of probabilities describing the distribution
of outcomes.
23.9.2
Internals
A multinomial distribution describes the number of times each of m possible outcomes occurs out of N trials, where
each outcome has a probability p_i. More generally, suppose that the probability of a Bernoulli random variable
X_i is p_i, and that
m
pi = 1.
i=1
PN (x1 , x2 , . . . , xn ) =
23.9.3
N!
px1 pxnn .
x1 ! xn ! 1
Example
Suppose an experiment has three possible outcomes, say heads, tails and edge, with probabilities 0.4999, 0.4999 and 0.0002, respectively. Then if we perform ten thousand coin flips we get
--> randmulti(10000,[0.4999,0.4999,0.0002])
ans =
5051
23.10
0 4948
23.10.1
Usage
Creates an array of pseudo-random numbers of the specified size. The numbers are normally distributed with zero
mean and a unit standard deviation (i.e., mu = 0, sigma = 1). Two seperate syntaxes are possible. The first
syntax specifies the array dimensions as a sequence of scalar dimensions:
y = randn(d1,d2,...,dn).
The resulting array has the given dimensions, and is filled with random numbers. The type of y is double, a 64-bit
floating point array. To get arrays of other types, use the typecast functions.
The second syntax specifies the array dimensions as a vector, where each element in the vector specifies a dimension length:
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
467
y = randn([d1,d2,...,dn]).
This syntax is more convenient for calling randn using a variable for the argument.
Finally, randn supports two additional forms that allow you to manipulate the state of the random number generator.
The first retrieves the state
y = randn(state)
which is a 625 length integer vector. The second form sets the state
randn(state,y)
23.10.2
Internals
Recall that the probability density function (PDF) of a normal random variable is
(x)2
1
e 2 2 .
f (x) =
2 2
The Gaussian random numbers are generated from pairs of uniform random numbers using a transformation technique.
23.10.3
Example
The following example demonstrates an example of using the first form of the randn function.
--> randn(2,2,2)
ans =
(:,:,1) =
-1.3838
-1.1738
0.9091
0.1705
(:,:,2) =
-0.0336
0.7566
0.4572
-1.1720
The second example demonstrates the second form of the randn function.
--> randn([2,2,2])
ans =
(:,:,1) =
1.2183
0.1605
-0.5558
0.1819
(:,:,2) =
0.5727
-0.3895
-0.5929
-0.2424
In the next example, we create a large array of 10000 normally distributed pseudo-random numbers. We then shift
the mean to 10, and the variance to 5. We then numerically calculate the mean and variance using mean and var,
respectively.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
468
--> x = 10+sqrt(5)*randn(1,10000);
--> mean(x)
ans =
10.0370
--> var(x)
ans =
4.9402
Now, we use the state manipulation functions of randn to exactly reproduce a random sequence. Note that unlike
using seed, we can exactly control where the random number generator starts by saving the state.
--> randn(state,0)
--> a = randn(1,3)
a =
-0.0362
0.6934
-0.1404
0.7086
--> randn(state,b);
--> c = randn(1,3)
-0.9394
% restart the random generator so...
% we get random sequence 2 again
c =
0.5998
23.11
0.7086
-0.9394
23.11.1
Usage
Generates random variables with a negative binomial distribution. The general syntax for its use is
y = randnbin(r,p)
where r is a vector of integers representing the number of successes, and p is the probability of success.
23.11.2
Internals
A negative binomial random variable describes the number of failures x that occur in x+r bernoulli trials, with a
success on the x+r trial. The pdf is given by
Pr,p (x) =
23.11.3
x+r1 r
p (1 p)x .
r1
Example
469
ans =
437 215 199 187
--> randnbin(6*ones(1,4),.01)
ans =
471 1233
23.12
768
338
23.12.1
Usage
Generates a vector of non-central chi-square random variables with the given number of degrees of freedom and
the given non-centrality parameters. The general syntax for its use is
y = randnchi(n,mu)
where n is an array containing the degrees of freedom for each generated random variable (with each element of n
>= 1), and mu is the non-centrality shift (must be positive).
23.12.2
Internals
A non-central chi-square random variable is the sum of a chisquare deviate with n-1 degrees of freedom plus the
square of a normal deviate with mean mu and standard deviation 1.
23.12.3
Examples
1.5030
1.9084
3.6028
1.1185
4.1872
4.5202
Columns 8 to 9
3.4539
23.13
0.4578
23.13.1
Usage
Generates a vector of non-central F-distributed random variables with the specified parameters. The general syntax
for its use is
y = randnf(n,m,c)
where n is the number of degrees of freedom in the numerator, and m is the number of degrees of freedom in the
denominator. The vector c determines the non-centrality shift of the numerator.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
470
23.13.2
Internals
A non-central F-distributed random variable is the ratio of a non-central chi-square random variable and a central
chi-square random variable, i.e.,
Fn,m,c =
23.13.3
2 /n
n,c
.
m2 /m
Example
Here we use the randf to generate some non-central F-distributed random variables:
--> randnf(5*ones(1,9),7,1.34)
ans =
Columns 1 to 7
0.5880
1.6093
0.4639
0.7857
2.5543
0.5044
3.3383
Columns 8 to 9
1.4102
23.14
1.1489
23.14.1
Usage
Generates a vector Poisson random variables with the given parameters. The general syntax for its use is
y = randp(nu),
where nu is an array containing the rate parameters for the generated random variables.
23.14.2
Internals
A Poisson random variable is generally defined by taking the limit of a binomial distribution as the sample size
becomes large, with the expected number of successes being fixed (so that the probability of success decreases
as 1/N). The Poisson distribution is given by
P (n) =
23.14.3
n enu
.
n!
Example
Here is an exmaple of using randp to generate some Poisson random variables, and also using randbin to do
the same using N=1000 trials to approximate the Poisson result.
--> randp(33*ones(1,10))
ans =
39 39 27 27 35 31 29 28 33 25
471
--> randbin(1000*ones(1,10),33/1000*ones(1,10))
ans =
31 17 42 19 34 36 34 41 30 30
23.15
23.15.1
USAGE
y = randperm(n)
y is a random permutation of integers from 1 to n. randperm calls rand and changes its state.
23.15.2
Example
--> y = randperm(10)
y =
2
5 10
23.16
23.16.1
Usage
Seeds the random number generator using the given integer seeds. Changing the seed allows you to choose which
pseudo-random sequence is generated. The seed takes two uint32 values:
seed(s,t)
where s and t are the seed values. Note that due to limitations in ranlib, the values of s,t must be between 0
<= s,t <= 2 30.
23.16.2
Example
Heres an example of how the seed value can be used to reproduce a specific random number sequence.
--> seed(32,41);
--> rand(1,5)
ans =
0.8589
0.3727
0.5551
0.9557
0.7367
0.5551
0.9557
0.7367
--> seed(32,41);
--> rand(1,5)
ans =
0.8589
0.3727
472
Chapter 24
24.1
24.1.1
Usage
The conv function performs a one-dimensional convolution of two vector arguments. The syntax for its use is
z = conv(x,y)
where x and y are vectors. The output is of length nx + ny -1. The conv function calls conv2 to do the
calculation. See its help for more details.
24.2
24.2.1
Usage
The conv2 function performs a two-dimensional convolution of matrix arguments. The syntax for its use is
Z = conv2(X,Y)
which performs the full 2-D convolution of X and Y. If the input matrices are of size [xm,xn] and [ym,yn]
respectively, then the output is of size [xm+ym-1,xn+yn-1]. Another form is
Z = conv2(hcol,hrow,X)
where hcol and hrow are vectors. In this form, conv2 first convolves Y along the columns with hcol, and then
convolves Y along the rows with hrow. This is equivalent to conv2(hcol(:)hrow(:),Y).
You can also provide an optional shape argument to conv2 via either
Z = conv2(X,Y,shape)
Z = conv2(hcol,hrow,X,shape)
474
24.2.2
Internals
If the full output is requested, then m ranges over 0 <= m < xm+ym-1 and n ranges over 0 <= n <
xn+yn-1. For the case where shape is same, the output ranges over (ym-1)/2 <= m < xm +
(ym-1)/2 and (yn-1)/2 <= n < xn + (yn-1)/2.
Chapter 25
25.1
25.1.1
Usage
Computes the eigendecomsition of a sparse square matrix. The eigs function has several forms. The most general
form is
[V,D] = eigs(A,k,sigma)
where A is the matrix to analyze, k is the number of eigenvalues to compute and sigma determines which eigenvallues to solve for. Valid values for sigma are lm - largest magnitude sm - smallest magnitude la - largest
algebraic (for real symmetric problems) sa - smallest algebraic (for real symmetric problems) be - both ends (for
real symmetric problems) lr - largest real part sr - smallest real part li - largest imaginary part si - smallest imaginary part scalar - find the eigenvalues closest to sigma. The returned matrix V contains the eigenvectors, and D
stores the eigenvalues. The related form
d = eigs(A,k,sigma)
computes only the eigenvalues and not the eigenvectors. If sigma is omitted, as in the forms
[V,D] = eigs(A,k)
and
d = eigs(A,k)
476
then eigs returns the largest magnitude eigenvalues (and optionally the associated eigenvectors). As an even
simpler form, the forms
[V,D] = eigs(A)
and
d = eigs(A)
then eigs returns the six largest magnitude eigenvalues of A and optionally the eigenvectors. The eigs function
uses ARPACK to compute the eigenvectors and/or eigenvalues. Note that due to a limitation in the interface into ARPACK from FreeMat, the number of eigenvalues that are to be computed must be strictly smaller than the number
of columns (or rows) in the matrix.
25.1.2
Example
Here is an example of using eigs to calculate eigenvalues of a matrix, and a comparison of the results with eig
--> a = sparse(rand(9));
--> eigs(a)
ans =
4.1831
0.3249
0.3249
0.5932
0.5932
-0.5572
+
+
+
+
0.0000i
0.5504i
0.5504i
0.1774i
0.1774i
0.0000i
--> eig(full(a))
ans =
4.1831
0.5932
0.5932
0.3249
0.3249
-0.5572
-0.1285
-0.1285
-0.3219
+
+
+
+
+
+
0.0000i
0.1774i
0.1774i
0.5504i
0.5504i
0.0000i
0.0901i
0.0901i
0.0000i
+
+
+
0.0901i
0.0901i
0.0000i
0.0000i
--> eigs(a,4,lr)
ans =
4.1831
0.5932
0.5932
0.3249
+
+
+
0.0000i
0.1774i
0.1774i
0.5504i
--> eigs(a,4,sr)
ans =
-0.5572
-0.3219
-0.1285
-0.1285
+
+
+
-
0.0000i
0.0000i
0.0901i
0.0901i
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
25.2
477
25.2.1
Usage
Converts a sparse matrix to a full matrix. The syntax for its use is
y = full(x)
The type of x is preserved. Be careful with the function. As a general rule of thumb, if you can work with the full
representation of a function, you probably do not need the sparse representation.
25.2.2
Example
25.3
25.3.1
Usage
Creates a sparse matrix using one of several formats. The first creates a sparse matrix from a full matrix
y = sparse(x).
The second form creates a sparse matrix containing all zeros that is of the specified size (the sparse equivalent of
zeros).
y = sparse(m,n)
where m and n are integers. Just like the zeros function, the sparse matrix returned is of type float. The third
form constructs a sparse matrix from the IJV syntax. It has two forms. The first version autosizes the sparse matrix
y = sparse(i,j,v)
478
25.4
25.4.1
Usage
Creates a sparse identity matrix of the given size. The syntax for its use is
y = speye(m,n)
which forms an n x n sparse matrix with ones on the main diagonal. The matrix type is a float single precision
matrix.
25.4.2
Example
The following creates a 5000 by 5000 identity matrix, which would be difficult to do using sparse(eye(5000))
because of the large amount of intermediate storage required.
--> I = speye(5000);
--> who I
Variable Name
Type
I
double
--> full(I(1:10,1:10))
Flags
sparse
ans =
1 0 0
0 1 0
0 0 1
0 0 0
0 0 0
0 0 0
0 0 0
0 0 0
0 0 0
0 0 0
0
0
0
1
0
0
0
0
0
0
25.5
0
0
0
0
1
0
0
0
0
0
0
0
0
0
0
1
0
0
0
0
0
0
0
0
0
0
1
0
0
0
0
0
0
0
0
0
0
1
0
0
0
0
0
0
0
0
0
0
1
0
Size
[5000x5000]
0
0
0
0
0
0
0
0
0
1
25.5.1
Usage
Returns a sparse float matrix with ones where the argument matrix has nonzero values. The general syntax for
it is
y = spones(x)
where x is a matrix (it may be full or sparse). The output matrix y is the same size as x, has type float, and
contains ones in the nonzero positions of x.
25.5.2
Examples
479
--> a = [1,0,3,0,5;0,0,2,3,0;1,0,0,0,1]
a =
1 0 3 0 5
0 0 2 3 0
1 0 0 0 1
--> b = spones(a)
b =
1 1 1
1 2 1
1 3 1
1 4 1
1 5 1
--> full(b)
ans =
1 1 1 1 1
0 0 0 0 0
0 0 0 0 0
25.6
25.6.1
Usage
Creates a sparse matrix with uniformly distributed random entries (on [0,1]). The syntax for its use is
y = sprand(x)
where x is a sparse matrix, where y is a sparse matrix that has random entries where x is nonzero. The second
form specifies the size of the matrix and the density
y = sprand(m,n,density)
where m is the number of rows in the output, n is the number of columns in the output, and density (which is
between 0 and 1) is the density of nonzeros in the resulting matrix. Note that for very high densities the actual
density of the output matrix may differ from the density you specify. This difference is a result of the way the random
entries into the matrix are generated. If you need a very dense random matrix, it is better to generate a full matrix
and zero out the entries you do not need.
25.6.2
Examples
Here we seed sprand with a full matrix (to demonstrate how the structure of the output is determined by the input
matrix when using the first form).
--> x = [1,0,0;0,0,1;1,0,0]
x =
1 0 0
0 0 1
1 0 0
--> y = sprand(x)
y =
1 1 0.171364
3 1 0.245464
2 3 0.0426635
--> full(y)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
480
ans =
0.1714
0
0.2455
0
0
0
0
0.0427
0
The more generic version with a density of 0.001. On many systems the following is impossible using full matrices
--> y = sprand(10000,10000,.001);
--> nnz(y)/10000^2
ans =
9.9946e-04
25.7
25.7.1
Usage
Creates a sparse matrix with normally distributed random entries (mean 0, sigma 1). The syntax for its use is
y = sprandn(x)
where x is a sparse matrix, where y is a sparse matrix that has random entries where x is nonzero. The second
form specifies the size of the matrix and the density
y = sprandn(m,n,density)
where m is the number of rows in the output, n is the number of columns in the output, and density (which is
between 0 and 1) is the density of nonzeros in the resulting matrix. Note that for very high densities the actual
density of the output matrix may differ from the density you specify. This difference is a result of the way the random
entries into the matrix are generated. If you need a very dense random matrix, it is better to generate a full matrix
and zero out the entries you do not need.
25.7.2
Examples
Here we seed sprandn with a full matrix (to demonstrate how the structure of the output is determined by the
input matrix when using the first form).
--> x = [1,0,0;0,0,1;1,0,0]
x =
1 0 0
0 0 1
1 0 0
--> y = sprandn(x)
y =
1 1 -0.498012
3 1 0.813313
2 3 -1.10282
--> full(y)
ans =
-0.4980
0
0.8133
0
0
0
0
-1.1028
0
The more generic version with a density of 0.001. On many systems the following is impossible using full matrices
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
--> y = sprandn(10000,10000,.001);
--> nnz(y)/10000^2
ans =
9.9952e-04
25.8
25.8.1
Usage
Plots the sparsity pattern of a sparse matrix. The syntax for its use is
spy(x)
which uses a default color and symbol. Alternately, you can use
spy(x,colspec)
where colspec is any valid color and symbol spec accepted by plot.
25.8.2
Example
--> y = sprand(1000,1000,.001);
--> spy(y,ro)
481
482
0
100
200
300
400
500
600
700
800
900
1000
100
200
300
400
500
600
700
800
900
1000
nz = 1000
Here is a sparse matrix with a little more structure. First we build a sparse matrix with block diagonal structure, and
then use spy to visualize the structure.
--> A = sparse(1000,1000);
--> for i=1:25; A((1:40) + 40*(i-1),(1:40) + 40*(i-1)) = 1; end;
--> spy(A,gx)
483
0
100
200
300
400
500
600
700
800
900
1000
100
200
300
400
500
600
nz = 40000
700
800
900
1000
484
Chapter 26
String Functions
BLANKS Create a blank string
CELLSTR Convert character array to cell array of strings
DEBLANK Remove trailing blanks from a string
ISALPHA Test for Alpha Characters in a String
ISDIGIT Test for Digit Characters in a String
ISSPACE Test for Space Characters in a String
LOWER Convert strings to lower case
REGEXP Regular Expression Matching Function
REGEXPREP Regular Expression Replacement Function
STRCMP String Compare Function
STRCMPI String Compare Case Insensitive Function
STRFIND Find Substring in a String
STRNCMP String Compare Function To Length N
STRREP String Replace Function
STRSTR String Search Function
STRTRIM Trim Spaces from a String
UPPER Convert strings to upper case
26.1
26.1.1
Usage
str = blanks(n)
486
26.1.2
String Functions
Example
A simple example:
--> sprintf([x0123456789y\n,x,blanks(10),y\n])
ans =
x0123456789y
x
y
26.2
26.2.1
Usage
The cellstr converts a character array matrix into a a cell array of individual strings. Each string in the matrix is
placed in a different cell, and extra spaces are removed. The syntax for the command is
y = cellstr(x)
26.2.2
Example
;is
a =
quick
brown
fox
is
--> cellstr(a)
ans =
[quick]
[brown]
[fox]
[is]
26.3
26.3.1
Usage
The deblank function removes spaces at the end of a string when used with the syntax
y = deblank(x)
where x is a string, in which case, all of the extra spaces in x are stripped from the end of the string. Alternately,
you can call deblank with a cell array of strings
y = deblank(c)
26.3.2
487
Example
A simple example
--> deblank(hello
ans =
hello
26.4
,there ,
is] [
is
sign
})
sign]
26.4.1
Usage
The isalpha functions returns a logical array that is 1 for characters in the argument string that are letters, and is
a logical 0 for characters in the argument that are not letters. The syntax for its use is
x = isalpha(s)
where s is a string. Note that this function is not locale sensitive, and returns a logical 1 for letters in the classic
ASCII sense (a through z, and A through Z).
26.4.2
Example
26.5
26.5.1
Usage
The isdigit functions returns a logical array that is 1 for characters in the argument string that are digits, and is
a logical 0 for characters in the argument that are not digits. The syntax for its use is
x = isdigit(s)
where s is a string.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
488
26.5.2
String Functions
Example
26.6
26.6.1
Usage
The isspace functions returns a logical array that is 1 for characters in the argument string that are spaces, and
is a logical 0 for characters in the argument that are not spaces. The syntax for its use is
x = isspace(s)
where s is a string. A blank character is considered a space, newline, tab, carriage return, formfeed, and vertical
tab.
26.6.2
Example
ans =
1 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 1
26.7
26.7.1
Usage
The lower function converts a string to lower case with the syntax
y = lower(x)
where x is a string, in which case all of the upper case characters in x (defined as the range A-Z) are
converted to lower case. Alternately, you can call lower with a cell array of strings
y = lower(c)
in which case each string in the cell array is converted to lower case.
26.7.2
Example
A simple example:
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
489
26.8
26.8.1
Usage
Matches regular expressions in the provided string. This function is complicated, and compatibility with MATLABs
syntax is not perfect. The syntax for its use is
regexp(str,expr)
which returns a row vector containing the starting index of each substring of str that matches the regular expression described by expr. The second form of regexp returns six outputs in the following order:
[start stop tokenExtents match tokens names] = regexp(str,expr)
where p1 etc. are the names of the outputs (and the order we want the outputs in). As a final variant, you can
supply some mode flags to regexp
[o1 o2 ...] = regexp(str,expr, p1, p2, ..., mode1, mode2)
490
String Functions
matchcase - letter case must match (selected by default for regexp)
ignorecase - letter case is ignored (selected by default for regexpi)
dotall - the . operator matches any character (default)
dotexceptnewline - the . operator does not match the newline character
stringanchors - the and $ operators match at the beginning and end (respectively) of a string.
lineanchors - the and $ operators match at the beginning and end (respectively) of a line.
literalspacing - the space characters and comment characters # are matched as literals, just like
any other ordinary character (default).
freespacing - all spaces and comments are ignored in the regular expression. You must use \ and
# to match spaces and comment characters, respectively.
Note the following behavior differences between MATLABs regexp and FreeMats:
If you have an old version of pcre installed, then named tokens must use the older <?P<name> syntax,
instead of the new <?<name> syntax.
The pcre library is pickier about named tokens and their appearance in expressions. So, for example, the
regexp from the MATLAB manual (?<first>\w+)\s+(?<last>\w+)(?<last>\w+),\s+(?<first>\w+)|
does not work correctly (as of this writing) because the same named tokens appear multiple times. The
workaround is to assign different names to each token, and then collapse the results later.
26.8.2
Example
26.9
26.9.1
Usage
Replaces regular expressions in the provided string. The syntax for its use is
outstring = regexprep(instring,pattern,replacement,modes)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
491
Here instring is the string to be operated on. And pattern is a regular expression of the type accepted by
regexp. For each match, the contents of the matched string are replaced with the replacement text. Tokens in the
regular expression can be used in the replacement text using $N where N is the number of the token to use. You
can also specify the same mode flags that are used by regexp.
26.10
26.10.1
USAGE
Compares two strings for equality. The general syntax for its use is
p = strcmp(x,y)
where x and y are two strings. Returns true if x and y are the same size, and are equal (as strings). Otherwise,
it returns false. In the second form, strcmp can be applied to a cell array of strings. The syntax for this form is
p = strcmp(cellstra,cellstrb)
where cellstra and cellstrb are cell arrays of a strings to compare. Also, you can also supply a character
matrix as an argument to strcmp, in which case it will be converted via cellstr (so that trailing spaces are
removed), before being compared.
26.10.2
Example
x1 = astring;
x2 = bstring;
x3 = astring;
strcmp(x1,x2)
ans =
0
--> strcmp(x1,x3)
ans =
1
492
String Functions
26.11
26.11.1
Usage
Compares two strings for equality ignoring case. The general syntax for its use is
p = strcmpi(x,y)
where x and y are two strings, or cell arrays of strings. See strcmp for more help.
26.12
26.12.1
Usage
Searches through a string for a pattern, and returns the starting positions of the pattern in an array. There are two
forms for the strfind function. The first is for single strings
ndx = strfind(string, pattern)
the resulting array ndx contains the starting indices in string for the pattern pattern. The second form takes
a cell array of strings
ndx = strfind(cells, pattern)
and applies the search operation to each string in the cell array.
26.12.2
Example
6 11 16
493
26.13
26.13.1
USAGE
Compares two strings for equality, but only looks at the first N characters from each string. The general syntax for
its use is
p = strncmp(x,y,n)
where x and y are two strings. Returns true if x and y are each at least n characters long, and if the first n
characters from each string are the same. Otherwise, it returns false. In the second form, strncmp can be
applied to a cell array of strings. The syntax for this form is
p = strncmp(cellstra,cellstrb,n)
where cellstra and cellstrb are cell arrays of a strings to compare. Also, you can also supply a character
matrix as an argument to strcmp, in which case it will be converted via cellstr (so that trailing spaces are
removed), before being compared.
26.13.2
Example
x1 = astring;
x2 = bstring;
x3 = astring;
strncmp(x1,x2,4)
ans =
0
--> strncmp(x1,x3,4)
ans =
1
494
String Functions
26.14
26.14.1
Usage
Replace every occurance of one string with another. The general syntax for its use is
p = strrep(source,find,replace)
Every instance of the string find in the string source is replaced with the string replace. Any of source,
find and replace can be a cell array of strings, in which case each entry has the replace operation applied.
26.14.2
Example
Here are some examples of the use of strrep. First the case where are the arguments are simple strings
--> strrep(Matlab is great,Matlab,FreeMat)
ans =
FreeMat is great
26.15
26.15.1
Usage
Searches for the first occurance of one string inside another. The general syntax for its use is
p = strstr(x,y)
where x and y are two strings. The returned integer p indicates the index into the string x where the substring y
occurs. If no instance of y is found, then p is set to zero.
26.15.2
Example
495
--> strstr(hello,lo)
ans =
4
--> strstr(quick brown fox,own)
ans =
9
--> strstr(free stuff,lunch)
ans =
0
26.16
26.16.1
Usage
Removes the white-spaces at the beginning and end of a string (or a cell array of strings). See isspace for a
definition of a white-space. There are two forms for the strtrim function. The first is for single strings
y = strtrim(strng)
where strng is a string. The second form operates on a cell array of strings
y = strtrim(cellstr)
26.16.2
Example
);
ans =
[space] [enough] [for] []
26.17
26.17.1
Usage
The upper function converts a string to upper case with the syntax
y = upper(x)
where x is a string, in which case all of the lower case characters in x (defined as the range a-z) are
converted to upper case. Alternately, you can call upper with a cell array of strings
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
496
String Functions
y = upper(c)
in which case each string in the cell array is converted to upper case.
26.17.2
Example
A simple example:
--> upper(this Is Strange CAPitalizaTion)
ans =
THIS IS STRANGE CAPITALIZATION
Chapter 27
FreeMat Threads
THREADCALL Call Function In A Thread
THREADFREE Free thread resources
THREADID Get Current Thread Handle
THREADKILL Halt execution of a thread
THREADNEW Create a New Thread
THREADSTART Start a New Thread Computation
THREADVALUE Retrieve the return values from a thread
THREADWAIT Wait on a thread to complete execution
27.1
27.1.1
Usage
The threadcall function is a convenience function for executing a function call in a thread. The syntax for its
use is
[val1,...,valn] = threadcall(threadid,timeout,funcname,arg1,arg2,...)
where threadid is the ID of the thread (as returned by the threadnew function), funcname is the name of the
function to call, and argi are the arguments to the function, and timeout is the amount of time (in milliseconds)
that the function is allowed to take.
27.1.2
Example
498
FreeMat Threads
0.5204
--> threadfree(id)
27.2
27.2.1
Usage
The threadfree is a function to free the resources claimed by a thread that has finished. The syntax for its use
is
threadfree(handle)
where handle is the handle returned by the call to threadnew. The threadfree function requires that the
thread be completed. Otherwise it will wait for the thread to complete, potentially for an arbitrarily long period of
time. To fix this, you can either call threadfree only on threads that are known to have completed, or you can
call it using the syntax
threadfree(handle,timeout)
where timeout is a time to wait in milliseconds. If the thread fails to complete before the timeout expires, an error
occurs.
27.3
27.3.1
Usage
The threadid function in FreeMat tells you which thread is executing the context you are in. Normally, this is
thread 1, the main thread. However, if you start a new thread using threadnew, you will be operating in a new
thread, and functions that call threadid from the new thread will return their handles.
27.3.2
Example
27.4
499
27.4.1
Usage
The threadkill function stops (or attempts to stop) execution of the given thread. It works only for functions
defined in M-files (i.e., not for built in or imported functions), and it works by setting a flag that causes the thread to
stop execution at the next available statement. The syntax for this function is
threadkill(handle)
where handle is the value returned by a threadnew call. Note that the threadkill function returns immediately. It is still your responsibility to call threadfree to free the thread you have halted.
You cannot kill the main thread (thread id 1).
27.4.2
Example
Here is an example of stopping a runaway thread using threadkill. Note that the thread function in this case is
an M-file function. We start by setting up a free running counter, where we can access the counter from the global
variables.
freecount.m
function freecount
global count
if (~exist(count)) count = 0; end
while (1)
count = count + 1;
end
We now launch this function in a thread, and use threadkill to stop it:
-->
-->
-->
-->
-->
a = threadnew;
global count
count = 0;
threadstart(a,freecount,0)
count
ans =
0
--> sleep(1)
--> count
% Wait a bit
% it is still counting
ans =
225458
--> threadkill(a)
--> threadwait(a,1000)
ans =
1
--> count
ans =
225497
--> sleep(1)
--> count
ans =
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
500
FreeMat Threads
225497
--> threadfree(a)
27.5
27.5.1
Usage
The threadnew function creates a new FreeMat thread, and returns a handle to the resulting thread. The
threadnew function takes no arguments. They general syntax for the threadnew function is
handle = threadnew
Once you have a handle to a thread, you can start the thread on a computation using the threadstart function.
The threads returned by threadnew are in a dormant state (i.e., not running). Once you are finished with the
thread you must call threadfree to free the resources associated with that thread.
Some additional important information. Thread functions operate in their own context or workspace, which means
that data cannot be shared between threads. The exception is global variables, which provide a thread-safe way
for multiple threads to share data. Accesses to global variables are serialized so that they can be used to share
data. Threads and FreeMat are a new feature, so there is room for improvement in the API and behavior. The best
way to improve threads is to experiment with them, and send feedback.
27.6
27.6.1
Usage
The threadstart function starts a new computation on a FreeMat thread, and you must provide a function (no
scripts are allowed) to run inside the thread, pass any parameters that the thread function requires, as well as the
number of output arguments expected. The general syntax for the threadstart function is
threadstart(threadid,function,nargout,arg1,arg2,...)
where threadid is a thread handle (returned by threadnew), where function is a valid function name (it
can be a built-in imported or M-function), nargout is the number of output arguments expected from the function,
and arg1 is the first argument that is passed to the function. Because the function runs in its own thread, the return
values of the function are not available imediately. Instead, execution of that function will continue in parallel with
the current thread. To retrieve the output of the thread function, you must wait for the thread to complete using the
threadwait function, and then call threadvalue to retrieve the result. You can also stop the running thread
prematurely by using the threadkill function. It is important to call threadfree on the handle you get from
threadnew when you are finished with the thread to ensure that the resoures are properly freed.
It is also perfectly reasonable to use a single thread multiple times, calling threadstart and threadreturn
multiple times on a single thread. The context is preserved between threads. When calling threadstart on a
pre-existing thread, FreeMat will attempt to wait on the thread. If the wait fails, then an error will occur.
Some additional important information. Thread functions operate in their own context or workspace, which means
that data cannot be shared between threads. The exception is global variables, which provide a thread-safe way
for multiple threads to share data. Accesses to global variables are serialized so that they can be used to share
data. Threads and FreeMat are a new feature, so there is room for improvement in the API and behavior. The best
way to improve threads is to experiment with them, and send feedback.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
27.6.2
501
Example
Here we do something very simple. We want to obtain a listing of all files on the system, but do not want the results
to stop our computation. So we run the system call in a thread.
-->
-->
-->
-->
-->
a = threadnew;
% Create the thread
threadstart(a,system,1,ls -lrt /); % Start the thread
b = rand(100)\rand(100,1);
% Solve some equations simultaneously
c = threadvalue(a);
% Retrieve the file list
size(c)
% It is large!
ans =
1 28
--> threadfree(a);
The possibilities for threads are significant. For example, we can solve equations in parallel, or take Fast Fourier
Transforms on multiple threads. On multi-processor machines or multicore CPUs, these threaded calculations will
execute in parallel. Neat.
The reason for the nargout argument is best illustrated with an example. Suppose we want to compute the
Singular Value Decomposition svd of a matrix A in a thread. The documentation for the svd function tells us that
the behavior depends on the number of output arguments we request. For example, if we want a full decomposition,
including the left and right singular vectors, and a diagonal singular matrix, we need to use the three-output syntax,
instead of the single output syntax (which returns only the singular values in a column vector):
--> A = float(rand(4))
A =
0.4011
0.8633
0.4939
0.9335
0.4747
0.0123
0.5458
0.8614
0.9193
0.0599
0.9481
0.7993
0.8655
0.5917
0.4566
0.6394
0.3626
-0.2431
-0.7925
0.4259
s =
2.5579
0
0
0
0
0.7905
0
0
0
0
0.4392
0
0
0
0
0.1705
v =
-0.5071
-0.4146
-0.5735
-0.4921
-0.7054
0.3096
0.5955
-0.2279
-0.3579
-0.6032
0.1558
0.6955
-0.3422
0.6070
-0.5406
0.4713
sigmas =
2.5579
0.7905
0.4392
0.1705
Normally, FreeMat uses the left hand side of an assignment to calculate the number of outputs for the function.
When running a function in a thread, we separate the assignment of the output from the invokation of the function.
Hence, we have to provide the number of arguments at the time we invoke the function. For example, to compute a
full decomposition in a thread, we specify that we want 3 output arguments:
--> a = threadnew;
502
FreeMat Threads
--> threadstart(a,svd,3,A);
% Start a full decomposition
--> [u1,s1,v1] = threadvalue(a); % Retrieve the function values
--> threadfree(a);
If we want to compute just the singular values, we start the thread function with only one output argument:
-->
-->
-->
-->
a = threadnew;
threadstart(a,svd,1,A);
sigmas = threadvalue(a);
threadfree(a)
27.7
27.7.1
Usage
The threadvalue function retrieves the values returned by the function specified in the threadnew call. The
syntax for its use is
[arg1,arg2,...,argN] = threadvalue(handle)
where handle is the value returned by a threadnew call. Note that there are issues with nargout. See the
examples section of threadnew for details on how to work around this limitation. Because the function you have
spawned with threadnew may still be executing, threadvalue must first threadwait for the function to
complete before retrieving the output values. This wait may take an arbitrarily long time if the thread function is
caught in an infinite loop. Hence, you can also specify a timeout parameter to threadvalue as
[arg1,arg2,...,argN] = threadvalue(handle,timeout)
where the timeout is specified in milliseconds. If the wait times out, an error is raised (that can be caught with a
try and catch block.
In either case, if the thread function itself caused an error and ceased execution abruptly, then calling
threadvalue will cause that function to raise an error, allowing you to retrieve the error that was caused
and correct it. See the examples section for more information.
27.7.2
Example
Here we do something very simple. We want to obtain a listing of all files on the system, but do not want the results
to stop our computation. So we run the system call in a thread.
-->
-->
-->
-->
-->
a = threadnew;
% Create the thread
threadstart(a,system,1,ls -lrt /); % Start the thread
b = rand(100)\rand(100,1);
% Solve some equations simultaneously
c = threadvalue(a);
% Retrieve the file list
size(c)
% It is large!
ans =
1 28
--> threadfree(a);
In this example, we force the threaded function to cause an exception (by calling the error function as the thread
function). When we call threadvalue, we get an error, instead of the return value of the function
--> a = threadnew
a =
3
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
503
Note that the error has the text Thread: prepended to the message to help you identify that this was an error in a
different thread.
27.8
27.8.1
Usage
The threadwait function waits for the given thread to complete execution, and stops execution of the current
thread (the one calling threadwait) until the given thread completes. The syntax for its use is
success = threadwait(handle)
where handle is the value returned by threadnew and success is a logical vaariable that will be 1 if the
wait was successful or 0 if the wait times out. By default, the wait is indefinite. It is better to use the following form
of the function
success = threadwait(handle,timeout)
where timeout is the amount of time (in milliseconds) for the threadwait function to wait before a timeout
occurs. If the threadwait function succeeds, then the return value is a logical 1, and if it fails, the return value is
a logical 0. Note that you can call threadwait multiple times on a thread, and if the thread is completed, each
one will succeed.
27.8.2
Example
Here we lauch the sleep function in a thread with a time delay of 10 seconds. This means that the thread function
will not complete until 10 seconds have elapsed. When we call threadwait on this thread with a short timeout,
it fails, but not when the timeout is long enough to capture the end of the function call.
--> a = threadnew;
--> threadstart(a,sleep,0,10);
--> threadwait(a,2000)
ans =
0
--> threadwait(a,10000)
ans =
1
--> threadfree(a)
504
FreeMat Threads
Chapter 28
Transforms/Decompositions
EIG Eigendecomposition of a Matrix
FFT (Inverse) Fast Fourier Transform Function
FFTN N-Dimensional Forward FFT
FFTSHIFT Shift FFT Output
HILBERT Hilbert Transform
IFFTN N-Dimensional Inverse FFT
IFFTSHIFT Inverse Shift FFT Output
INV Invert Matrix
LU LU Decomposition for Matrices
QR QR Decomposition of a Matrix
SVD Singular Value Decomposition of a Matrix
28.1
Section: Transforms/Decompositions
28.1.1
Usage
Computes the eigendecomposition of a square matrix. The eig function has several forms. The first returns only
the eigenvalues of the matrix:
s = eig(A)
The second form returns both the eigenvectors and eigenvalues as two matrices (the eigenvalues are stored in a
diagonal matrix):
[V,D] = eig(A)
506
Transforms/Decompositions
which computes the eigenvalues of A only, and does not balance the matrix prior to computation. Similarly,
[V,D] = eig(A,nobalance)
recovers both the eigenvectors and eigenvalues of A without balancing. Note that the nobalance option has no
affect on symmetric matrices.
FreeMat also provides the ability to calculate generalized eigenvalues and eigenvectors. Similarly to the regular
case, there are two forms for eig when computing generalized eigenvector (see the Function Internals section for
a description of what a generalized eigenvector is). The first returns only the generalized eigenvalues of the matrix
pair A,B
s = eig(A,B)
The second form also computes the generalized eigenvectors, and is accessible via
[V,D] = eig(A,B)
28.1.2
Internals
Av = dv.
This decomposition can be written in matrix form as
AV = V D
where
V = [v1 , v2 , . . . , vn ], D = diag(d1 , d2 , . . . , dn ).
The eig function uses the LAPACK class of functions GEEVX to compute the eigenvalue decomposition for
non-symmetric (or non-Hermitian) matrices A. For symmetric matrices, SSYEV and DSYEV are used for float
and double matrices (respectively). For Hermitian matrices, CHEEV and ZHEEV are used for complex and
dcomplex matrices.
For some matrices, the process of balancing (in which the rows and columns of the matrix are pre-scaled to facilitate
the search for eigenvalues) is detrimental to the quality of the final solution. This is particularly true if the matrix
contains some elements on the order of round off error. See the Example section for an example.
A generalized eigenvector of the matrix pair A,B is simply a vector v with associated eigenvalue d such that
Av = dBv,
where B is a square matrix of the same size as A. This decomposition can be written in matrix form as
AV = BV D
where
V = [v1 , v2 , . . . , vn ], D = diag(d1 , d2 , . . . , dn ).
For general matrices A and B, the GGEV class of routines are used to compute the generalized eigendecomposition.
If howevever, A and B are both symmetric (or Hermitian, as appropriate), Then FreeMat first attempts to use SSYGV and DSYGV for float and double arguments and CHEGV and ZHEGV for complex and dcomplex
arguments (respectively). These routines requires that B also be positive definite, and if it fails to be, FreeMat will
revert to the routines used for general arguments.
28.1.3
Example
Some examples of eigenvalue decompositions. First, for a diagonal matrix, the eigenvalues are the diagonal elements of the matrix.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
507
--> A = diag([1.02f,3.04f,1.53f])
A =
1.0200
0
0
0
3.0400
0
0
0
1.5300
--> eig(A)
ans =
1.0200
1.5300
3.0400
Next, we compute the eigenvalues of an upper triangular matrix, where the eigenvalues are again the diagonal
elements.
--> A = [1.0f,3.0f,4.0f;0,2.0f,6.7f;0.0f,0.0f,1.0f]
A =
1.0000
0
0
3.0000
2.0000
0
4.0000
6.7000
1.0000
--> eig(A)
ans =
1
2
1
Next, we compute the complete eigenvalue decomposition of a random matrix, and then demonstrate the accuracy
of the solution
--> A = float(randn(2))
A =
0.3747
-0.6283
-1.5129
-1.1096
0
-1.5928
0
0
Now, we consider a matrix that requires the nobalance option to compute the eigenvalues and eigenvectors properly.
Here is an example from MATLABs manual.
--> B = [3,-2,-.9,2*eps;-2,4,1,-eps;-eps/4,eps/2,-1,0;-.5,-.5,.1,1]
B =
3.0000
-2.0000
-0.0000
-0.5000
-2.0000
4.0000
0.0000
-0.5000
-0.9000
1.0000
-1.0000
0.1000
0.0000
-0.0000
0
1.0000
508
Transforms/Decompositions
VB =
0.6153
-0.7881
-0.0000
0.0189
-0.4176
-0.3261
-0.0000
0.8481
-0.0000
-0.0000
0.0000
1.0000
-0.1495
0.1316
-0.9570
-0.2110
DB =
5.5616
0
0
0
0
1.4384
0
0
0
0
1.0000
0
0
0
0
-1.0000
0.0000
-0.0000
-0.0000
0.0000
-0.0000
0.0000
-0.0000
-0.5088
0
0.0000
-0.0000
0.0000
0
1.4384
0
0
0
0
1.0000
0
0
0
0
-1.0000
-0.5587
0.3364
0.0066
0.2220
-0.1665
-0.1943
0
0.0833
28.2
Section: Transforms/Decompositions
28.2.1
Usage
Computes the Discrete Fourier Transform (DFT) of a vector using the Fast Fourier Transform technique. The general
syntax for its use is
y = fft(x,n,d)
where x is an n-dimensional array of numerical type. Integer types are promoted to the double type prior to
calculation of the DFT. The argument n is the length of the FFT, and d is the dimension along which to take the DFT.
If |n| is larger than the length of x along dimension d, then x is zero-padded (by appending zeros) prior to calculation
of the DFT. If n is smaller than the length of x along the given dimension, then x is truncated (by removing elements
at the end) to length n.
If d is omitted, then the DFT is taken along the first non-singleton dimension of x. If n is omitted, then the DFT
length is chosen to match of the length of x along dimension d.
Note that FFT support on Linux builds requires availability of the FFTW libraries at compile time. On Windows and
Mac OS X, single and double precision FFTs are available by default.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
28.2.2
509
Internals
2(k1)l
n
k=1
For the inverse DFT, the calculation is similar, and the arguments have the same meanings as the DFT:
2(k1)l
1 n
x(m1 , . . . , md1 , k, md+1 , . . . , m p )e n .
n k=1
The FFT is computed using the FFTPack library, available from netlib at http://www.netlib.org. Generally
speaking, the computational cost for a FFT is (in worst case) O(n 2). However, if n is composite, and can be
factored as
n = mk ,
k=1
O(n mk )
k=1
operations. If n is a power of 2, then the FFT can be calculated in O(n log_2 n). The calculations for the
inverse FFT are identical.
28.2.3
Example
The following piece of code plots the FFT for a sinusoidal signal:
-->
-->
-->
-->
t = linspace(0,2*pi,128);
x = cos(15*t);
y = fft(x);
plot(t,abs(y));
510
Transforms/Decompositions
70
60
50
40
30
20
10
0
The FFT can also be taken along different dimensions, and with padding and/or truncation. The following example
demonstrates the Fourier Transform being computed along each column, and then along each row.
--> A = [2,5;3,6]
A =
2 5
3 6
--> real(fft(A,[],1))
ans =
5 11
-1 -1
511
--> real(fft(A,[],2))
ans =
7 -3
9 -3
Fourier transforms can also be padded using the n argument. This pads the signal with zeros prior to taking
the Fourier transform. Zero padding in the time domain results in frequency interpolation. The following example
demonstrates the FFT of a pulse (consisting of 10 ones) with (red line) and without (green circles) padding.
-->
-->
-->
-->
delta(1:10) = 1;
plot((0:255)/256*pi*2,real(fft(delta,256)),r-);
hold on
plot((0:9)/10*pi*2,real(fft(delta)),go);
512
Transforms/Decompositions
10
-2
28.3
Section: Transforms/Decompositions
28.3.1
Usage
Computes the DFT of an N-dimensional numerical array along all dimensions. The general syntax for its use is
y = fftn(x)
which computes the same-size FFTs for each dimension of x. Alternately, you can specify the size vector
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
513
y = fftn(x,dims)
where dims is a vector of sizes. The array x is zero padded or truncated as necessary in each dimension so that
the output is of size dims. The fftn function is implemented by a sequence of calls to fft.
28.4
Section: Transforms/Decompositions
28.4.1
Usage
The fftshift function shifts the DC component (zero-frequency) of the output from an FFT to the center of the
array. For vectors this means swapping the two halves of the vector. For matrices, the first and third quadrants are
swapped. So on for N-dimensional arrays. The syntax for its use is
y = fftshift(x).
28.5
Section: Transforms/Decompositions
28.5.1
Usage
The hilbert function computes the hilbert transform of the argument vector or matrix. The FreeMat hilbert
function is compatible with the one from the MATLAB API. This means that the output of the hilbert function
is the sum of the original function and an imaginary signal containing the Hilbert transform of it. There are two
syntaxes for the hilbert function. The first is
y = hilbert(x)
where x is real vector or matrix. If x is a matrix, then he Hilbert transform is computed along the columns of x. The
second syntax provides a dimension along which to take the transform.
y = hilbert(x,n)
28.6
Section: Transforms/Decompositions
28.6.1
Usage
Computes the inverse DFT of an N-dimensional numerical array along all dimensions. The general syntax for its
use is
y = ifftn(x)
which computes the same-size inverse FFTs for each dimension of x. Alternately, you can specify the size vector
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
514
Transforms/Decompositions
y = ifftn(x,dims)
where dims is a vector of sizes. The array x is zero padded or truncated as necessary in each dimension so that
the output is of size dims. The ifftn function is implemented by a sequence of calls to ifft.
28.7
Section: Transforms/Decompositions
28.7.1
Usage
The ifftshift function shifts the DC component (zero-frequency) of the output from the center of the array back
to the first position and iseffectively the inverse of fftshift. For vectors this means swapping the two halves of
the vector. For matrices, the first and third quadrants are swapped. So on for N-dimensional arrays. The syntax for
its use is
y = ifftshift(x).
28.8
Section: Transforms/Decompositions
28.8.1
Usage
Inverts the argument matrix, provided it is square and invertible. The syntax for its use is
y = inv(x)
Internally, the inv function uses the matrix divide operators. For sparse matrices, a sparse matrix solver is used.
28.8.2
Example
0.8182
-0.9091
-0.4545
-0.5455
0.2727
0.6364
0.0000
1.0000
-0.0000
0
--> a*b
ans =
1.0000
0.0000
0.0000
0.0000
1.0000
0.0000
1.0000
-0.0000
0
0
1.0000
515
--> b*a
ans =
1.0000
0.0000
0.0000
28.9
Section: Transforms/Decompositions
28.9.1
Usage
Computes the LU decomposition for a matrix. The form of the command depends on the type of the argument. For
full (non-sparse) matrices, the primary form for lu is
[L,U,P] = lu(A),
where L is lower triangular, U is upper triangular, and P is a permutation matrix such that LU = PA. The second
form is
[V,U] = lu(A),
where V is PL (a row-permuted lower triangular matrix), and U is upper triangular. For sparse, square matrices,
the LU decomposition has the following form:
[L,U,P,Q,R] = lu(A),
where A is a sparse matrix of either double or dcomplex type. The matrices are such that LU=PRAQ,
where L is a lower triangular matrix, U is upper triangular, P and Q are permutation vectors and R is a diagonal
matrix of row scaling factors. The decomposition is computed using UMFPACK for sparse matrices, and LAPACK
for dense matrices.
28.9.2
Example
3
8
3
0
0
1.0000
u =
10.0000
0
0
3.0000
2.7000
6.1250
12.0000
0.8000
0
p =
0 0 1
1 0 0
0 1 0
516
Transforms/Decompositions
--> l*u
ans =
10 12
1 2
4 5
3
3
8
--> p*a
ans =
10 12
1 2
4 5
3
3
8
Now we repeat the exercise with a sparse matrix, and demonstrate the use of the permutation vectors.
--> a = sparse([1,0,0,4;3,2,0,0;0,0,0,1;4,3,2,4])
a =
1 1 1
2 1 3
4 1 4
2 2 2
4 2 3
4 3 2
1 4 4
3 4 1
4 4 4
--> [l,u,p,q,r] = lu(a)
l =
1 1 1
2 2 1
3 3 1
4 4 1
u =
1 1 0.153846
1 2 0.230769
2 2 0.4
1 3 0.307692
2 3 0.6
3 3 0.2
1 4 0.307692
3 4 0.8
4 4 1
p =
4
2
1
3
q =
3
2
1
4
r =
1 1 0.2
2 2 0.2
3 3 1
4 4 0.0769231
--> full(l*a)
ans =
1 0 0
3 2 0
0 0 0
4 3 2
4
0
1
4
--> b = r*a
b =
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
517
1 1 0.2
2 1 0.6
3 1 0
4 1 0.307692
1 2 0
2 2 0.4
3 2 0
4 2 0.230769
1 3 0
2 3 0
3 3 0
4 3 0.153846
1 4 0.8
2 4 0
3 4 1
4 4 0.307692
--> full(b(p,q))
ans =
0.1538
0
0
0
28.10
0.2308
0.4000
0
0
0.3077
0.6000
0.2000
0
0.3077
0
0.8000
1.0000
QR QR Decomposition of a Matrix
Section: Transforms/Decompositions
28.10.1
Usage
Computes the QR factorization of a matrix. The qr function has multiple forms, with and without pivoting. The
non-pivot version has two forms, a compact version and a full-blown decomposition version. The compact version
of the decomposition of a matrix of size M x N is
[q,r] = qr(a,0)
where q is a matrix of size M x L and r is a matrix of size L x N and L = min(N,M), and qr = a. The QR
decomposition is such that the columns of Q are orthonormal, and R is upper triangular. The decomposition is computed using the LAPACK routine xgeqrf, where x is the precision of the matrix. FreeMat supports decompositions
of single and double types.
The second form of the non-pivot decomposition omits the second 0 argument:
[q,r] = qr(a)
This second form differs from the previous form only for matrices with more rows than columns (M > N). For these
matrices, the full decomposition is of a matrix Q of size M x M and a matrix R of size M x N. The full decomposition
is computed using the same LAPACK routines as the compact decomposition, but on an augmented matrix [a 0],
where enough columns are added to form a square matrix.
Generally, the QR decomposition will not return a matrix R with diagonal elements in any specific order. The
remaining two forms of the qr command utilize permutations of the columns of a so that the diagonal elements of r
are in decreasing magnitude. To trigger this form of the decomposition, a third argument is required, which records
the permutation applied to the argument a. The compact version is
[q,r,e] = qr(a,0)
where e is an integer vector that describes the permutation of the columns of a necessary to reorder the diagonal
elements of r. This result is computed using the LAPACK routines (s,d)geqp3. In the non-compact version of
the QR decomposition with pivoting,
[q,r,e] = qr(a)
518
Transforms/Decompositions
28.11
Section: Transforms/Decompositions
28.11.1
Usage
Computes the singular value decomposition (SVD) of a matrix. The svd function has three forms. The first returns
only the singular values of the matrix:
s = svd(A)
The second form returns both the singular values in a diagonal matrix S, as well as the left and right eigenvectors.
[U,S,V] = svd(A)
The third form returns a more compact decomposition, with the left and right singular vectors corresponding to zero
singular values being eliminated. The syntax is
[U,S,V] = svd(A,0)
28.11.2
Internals
Recall that sigma_i is a singular value of an M x N matrix A if there exists two vectors u_i, v_i where u_i
is of length M, and v_i is of length u_i and
Avi = i ui
and generally
K
A = i ui v0i ,
i=1
where K is the rank of A. In matrix form, the left singular vectors u_i are stored in the matrix U as
28.11.3
Examples
-1.7828
-0.6335
-1.0621
0.5810
0
1.0268
0
0
V =
-0.0588
0.8806
-0.6051
-0.4061
0.7940
-0.2443
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
0.4702
0.6848
0.5567
-1.7828
-0.6335
-1.0621
0.5810
--> U*S*V
ans =
0.1962
-0.6022
--> svd(A)
ans =
2.0957
1.0268
519
520
Transforms/Decompositions
Chapter 29
29.1
522
29.1.1
USAGE
29.1.2
Example
29.2
29.2.1
Usage
Converts the binary decomposition of an integer array back to an integer array. The general syntax for its use is
y = bin2int(x)
where x is a multi-dimensional logical array, where the last dimension indexes the bit planes (see int2bin for an
example). By default, the output of bin2int is unsigned uint32. To get a signed integer, it must be typecast
correctly. A second form for bin2int takes a signed flag
y = bin2int(x,signed)
29.2.2
Example
The following piece of code demonstrates various uses of the int2bin function. First the simplest example:
--> A = [2;5;6;2]
A =
2
5
6
2
--> B = int2bin(A,8)
B =
0 0
0 0
0 0
0 0
0
0
0
0
0
0
0
0
0
0
0
0
0
1
1
0
1
0
1
1
0
1
0
0
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
523
--> bin2int(B)
ans =
2
5
6
2
--> A = [1;2;-5;2]
A =
1
2
-5
2
--> B = int2bin(A,8)
B =
0 0
0 0
1 1
0 0
0
0
1
0
0
0
1
0
0
0
1
0
0
0
0
0
0
1
1
1
1
0
1
0
--> bin2int(B)
ans =
1
2
251
2
--> int32(bin2int(B))
ans =
1
2
251
2
29.2.3
Tets
29.3
29.3.1
Usage
The cast function allows you to typecast a variable from one type to another. The syntax for its use is
y = cast(x,toclass)
where toclass is the name of the class to cast x to. Note that the typecast must make sense, and that toclass
must be one of the builtin types. The current list of supported types is
cell for cell-arrays
struct for structure-arrays
logical for logical arrays
uint8 for unsigned 8-bit integers
int8 for signed 8-bit integers
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
524
29.3.2
Example
29.4
29.4.1
Usage
The char function can be used to convert an array into a string. It has several forms. The first form is
y = char(x)
where x is a numeric array containing character codes. FreeMat does not currently support Unicode, so the character codes must be in the range of [0,255]. The output is a string of the same size as x. A second form
is
y = char(c)
where c is a cell array of strings, creates a matrix string where each row contains a string from the corresponding
cell array. The third form is
y = char(s1, s2, s3, ...)
where si are a character arrays. The result is a matrix string where each row contains a string from the corresponding argument.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
29.4.2
525
Example
Here is an example of the first technique being used to generate a string containing some ASCII characters
--> char([32:64;65:97])
ans =
!"#$%&()*+,-./0123456789:;<=>?@
ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_a
In the next example, we form a character array from a set of strings in a cell array. Note that the character array is
padded with spaces to make the rows all have the same length.
--> char({hello,to,the,world})
ans =
hello
to
the
world
In the last example, we pass the individual strings as explicit arguments to char
--> char(hello,to,the,world)
ans =
hello
to
the
world
29.5
29.5.1
Usage
Converts the two real input arguments into the real and imaginary part (respectively) of a complex number. The
syntax for its use is
y = complex(x,z)
where x and z are n-dimensional numerical arrays. The usual rules for binary operators apply (i.e., one of the
arguments can be a scalar, if either is of type single the output is single, etc.).
29.6
29.6.1
Usage
The dcomplex function used to convert variables into 64-bit complex data types in prior versions of FreeMat.
Starting with FreeMat 4, the type rules are the same as Matlab, hence, there is no distinction between a 64-bit
complex type and and 64-bit real type. Thus, the dcomplex function is just a synonym for double.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
526
29.7
29.7.1
USAGE
where x is the positive integer, and n is the number of bits to use in the representation. Alternately, if you leave n
unspecified,
y = dec2bin(x)
the minimum number of bits needed to represent x are used. If x is a vector, then the resulting y is a character
matrix.
29.7.2
Example
29.8
29.8.1
Usage
Converts the argument to a 64-bit floating point number. The syntax for its use is
y = double(x)
where x is an n-dimensional numerical array. Conversion follows the saturation rules. Note that both NaN and Inf
are both preserved under type conversion.
29.8.2
Example
The following piece of code demonstrates several uses of double. First, we convert from an integer (the argument
is an integer because no decimal is present):
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
527
--> double(200)
ans =
200
In the next example, a single precision argument is passed in (the presence of the f suffix implies single precision).
--> double(400.0f)
ans =
400
4.0000i
In the next example, a string argument is passed in. The string argument is converted into an integer array corresponding to the ASCII values of each character.
--> double(helo)
ans =
104 101 108 111
In the last example, a cell-array is passed in. For cell-arrays and structure arrays, the result is an error.
--> double({4})
Error: Cannot perform type conversions with this type
29.9
29.9.1
Usage
Converts the argument to a 32-bit floating point number. The syntax for its use is
y = float(x)
where x is an n-dimensional numerical array. Conversion follows the saturation rules. Note that both NaN and Inf
are both preserved under type conversion.
29.9.2
Example
The following piece of code demonstrates several uses of float. First, we convert from an integer (the argument
is an integer because no decimal is present):
--> float(200)
ans =
200
528
--> float(400.0)
ans =
400
4.0000i
In the next example, a string argument is passed in. The string argument is converted into an integer array corresponding to the ASCII values of each character.
--> float(helo)
ans =
104 101 108 111
In the last example, a cell-array is passed in. For cell-arrays and structure arrays, the result is an error.
--> float({4})
Error: Cannot perform type conversions with this type
29.10
29.10.1
Usage
Converts the argument to an signed 16-bit Integer. The syntax for its use is
y = int16(x)
where x is an n-dimensional numerical array. Conversion follows the saturation rules (e.g., if x is outside the normal
range for a signed 16-bit integer of [-32767,32767], it is truncated to that range). Note that both NaN and Inf
both map to 0.
29.10.2
Example
The following piece of code demonstrates several uses of int16. First, the routine uses
--> int16(100)
ans =
100
--> int16(-100)
ans =
-100
In the next example, an integer outside the range of the type is passed in. The result is truncated to the range of
the data type.
--> int16(40000)
ans =
32767
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
529
In the next example, a positive double precision argument is passed in. The result is the signed integer that is
closest to the argument.
--> int16(pi)
ans =
3
In the next example, a complex argument is passed in. The result is the signed complex integer that is closest to
the argument.
--> int16(5+2*i)
ans =
5.0000 +
2.0000i
In the next example, a string argument is passed in. The string argument is converted into an integer array corresponding to the ASCII values of each character.
--> int16(helo)
ans =
104 101 108 111
In the last example, a cell-array is passed in. For cell-arrays and structure arrays, the result is an error.
--> int16({4})
Error: Cannot perform type conversions with this type
29.11
29.11.1
Usage
Computes the binary decomposition of an integer array to the specified number of bits. The general syntax for its
use is
y = int2bin(x,n)
where x is a multi-dimensional integer array, and n is the number of bits to expand it to. The output array y has one
extra dimension to it than the input. The bits are expanded along this extra dimension.
29.11.2
Example
The following piece of code demonstrates various uses of the int2bin function. First the simplest example:
--> A = [2;5;6;2]
A =
2
5
6
2
--> int2bin(A,8)
ans =
0 0 0 0 0 0 1 0
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
530
0 0 0 0 0 1 0 1
0 0 0 0 0 1 1 0
0 0 0 0 0 0 1 0
--> A = [1;2;-5;2]
A =
1
2
-5
2
--> int2bin(A,8)
ans =
0 0 0
0 0 0
1 1 1
0 0 0
29.12
0
0
1
0
0
0
1
0
0
0
0
0
0
1
1
1
1
0
1
0
29.12.1
Usage
Converts the argument to an signed 32-bit Integer. The syntax for its use is
y = int32(x)
where x is an n-dimensional numerical array. Conversion follows the saturation rules (e.g., if x is outside the normal
range for a signed 32-bit integer of [-2147483647,2147483647], it is truncated to that range). Note that both
NaN and Inf both map to 0.
29.12.2
Example
The following piece of code demonstrates several uses of int32. First, the routine uses
--> int32(100)
ans =
100
--> int32(-100)
ans =
-100
In the next example, an integer outside the range of the type is passed in. The result is truncated to the range of
the data type.
--> int32(40e9)
ans =
2147483647
In the next example, a positive double precision argument is passed in. The result is the signed integer that is
closest to the argument.
--> int32(pi)
ans =
3
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
531
In the next example, a complex argument is passed in. The result is the signed complex integer that is closest to
the argument.
--> int32(5+2*i)
ans =
5.0000 +
2.0000i
In the next example, a string argument is passed in. The string argument is converted into an integer array corresponding to the ASCII values of each character.
--> int32(helo)
ans =
104 101 108 111
In the last example, a cell-array is passed in. For cell-arrays and structure arrays, the result is an error.
--> int32({4})
Error: Cannot perform type conversions with this type
29.13
29.13.1
Usage
Converts the argument to an signed 64-bit Integer. The syntax for its use is
y = int64(x)
where x is an n-dimensional numerical array. Conversion follows the saturation rules (e.g., if x is outside the normal
range for a signed 64-bit integer of [-2 63+1,2 63-1], it is truncated to that range). Note that both NaN and
Inf both map to 0.
29.13.2
Example
The following piece of code demonstrates several uses of int64. First, the routine uses
--> int64(100)
ans =
100
--> int64(-100)
ans =
-100
In the next example, an integer outside the range of the type is passed in. The result is truncated to the range of
the data type.
--> int64(40e9)
ans =
40000000000
In the next example, a positive double precision argument is passed in. The result is the signed integer that is
closest to the argument.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
532
--> int64(pi)
ans =
3
In the next example, a complex argument is passed in. The result is the complex signed integer that is closest to
the argument.
--> int64(5+2*i)
ans =
5.0000 +
2.0000i
In the next example, a string argument is passed in. The string argument is converted into an integer array corresponding to the ASCII values of each character.
--> int64(helo)
ans =
104 101 108 111
In the last example, a cell-array is passed in. For cell-arrays and structure arrays, the result is an error.
--> int64({4})
Error: Cannot perform type conversions with this type
29.14
29.14.1
Usage
Converts the argument to an signed 8-bit Integer. The syntax for its use is
y = int8(x)
where x is an n-dimensional numerical array. Conversion follows the saturation rules (e.g., if x is outside the normal
range for a signed 8-bit integer of [-127,127], it is truncated to that range. Note that both NaN and Inf both
map to 0.
29.14.2
Example
The following piece of code demonstrates several uses of int8. First, the routine uses
--> int8(100)
ans =
100
--> int8(-100)
ans =
-100
In the next example, an integer outside the range of the type is passed in. The result is truncated to the range of
the type.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
533
--> int8(400)
ans =
127
In the next example, a positive double precision argument is passed in. The result is the signed integer that is
closest to the argument.
--> int8(pi)
ans =
3
In the next example, a complex argument is passed in. The result is the signed complex integer that is closest to
the argument.
--> int8(5+2*i)
ans =
5.0000 +
2.0000i
In the next example, a string argument is passed in. The string argument is converted into an integer array corresponding to the ASCII values of each character.
--> int8(helo)
ans =
104 101 108 111
In the last example, a cell-array is passed in. For cell-arrays and structure arrays, the result is an error.
--> int8({4})
Error: Cannot perform type conversions with this type
29.15
29.15.1
Usage
Converts the argument to a logical array. The syntax for its use is
y = logical(x)
29.15.2
Example
534
29.16
29.16.1
Usage
A synonym for the float function, converts the argument to a 32-bit floating point number. The syntax for its use
is
y = single(x)
where x is an n-dimensional numerical array. Conversion follows the general C rules. Note that both NaN and Inf
are both preserved under type conversion.
29.17
29.17.1
Usage
Converts the argument array into a string. The syntax for its use is
y = string(x)
29.17.2
Example
Here we take an array containing ASCII codes for a string, and convert it into a string.
--> a = [104,101,108,108,111]
a =
104 101 108 108 111
--> string(a)
ans =
hello
29.18
29.18.1
Usage
Converts the argument to an unsigned 16-bit Integer. The syntax for its use is
y = uint16(x)
where x is an n-dimensional numerical array. Conversion follows saturation rules (e.g., if x is outside the normal
range for an unsigned 16-bit integer of [0,65535], it is truncated to that range. Note that both NaN and Inf
both map to 0.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
29.18.2
535
Example
In the next example, an integer outside the range of the type is passed in. The result is truncated to the maximum
value of the data type.
--> uint16(99400)
ans =
65535
In the next example, a negative integer is passed in. The result is truncated to zero.
--> uint16(-100)
ans =
0
In the next example, a positive double precision argument is passed in. The result is the unsigned integer that is
closest to the argument.
--> uint16(pi)
ans =
3
In the next example, a complex argument is passed in. The result is the complex unsigned integer that is closest to
the argument.
--> uint16(5+2*i)
ans =
5.0000 +
2.0000i
In the next example, a string argument is passed in. The string argument is converted into an integer array corresponding to the ASCII values of each character.
--> uint16(helo)
ans =
104 101 108 111
In the last example, a cell-array is passed in. For cell-arrays and structure arrays, the result is an error.
--> uint16({4})
Error: Cannot perform type conversions with this type
29.19
536
29.19.1
Usage
Converts the argument to an unsigned 32-bit Integer. The syntax for its use is
y = uint32(x)
where x is an n-dimensional numerical array. Conversion follows saturation rules (e.g., if x is outside the normal
range for an unsigned 32-bit integer of [0,4294967295], it is truncated to that range. Note that both NaN and
Inf both map to 0.
29.19.2
Example
In the next example, an integer outside the range of the type is passed in. The result is truncated to the maximum
value of the data type.
--> uint32(40e9)
ans =
4294967295
In the next example, a negative integer is passed in. The result is truncated to zero.
--> uint32(-100)
ans =
0
In the next example, a positive double precision argument is passed in. The result is the unsigned integer that is
closest to the argument.
--> uint32(pi)
ans =
3
In the next example, a complex argument is passed in. The result is the complex unsigned integer that is closest to
the argument.
--> uint32(5+2*i)
ans =
5.0000 +
2.0000i
In the next example, a string argument is passed in. The string argument is converted into an integer array corresponding to the ASCII values of each character.
--> uint32(helo)
ans =
104 101 108 111
In the last example, a cell-array is passed in. For cell-arrays and structure arrays, the result is an error.
--> uint32({4})
Error: Cannot perform type conversions with this type
29.20
537
29.20.1
Usage
Converts the argument to an unsigned 64-bit Integer. The syntax for its use is
y = uint64(x)
where x is an n-dimensional numerical array. Conversion follows saturation rules (e.g., if x is outside the normal
range for an unsigned 64-bit integer of [0,2 64-1], it is truncated to that range. Note that both NaN and Inf
both map to 0.
29.20.2
Example
In the next example, an integer outside the range of the type is passed in. The result is truncated to the maximum
value of the data type.
--> uint64(40e9)
ans =
40000000000
In the next example, a negative integer is passed in. The result is zero.
--> uint64(-100)
ans =
0
In the next example, a positive double precision argument is passed in. The result is the unsigned integer that is
closest to the argument.
--> uint64(pi)
ans =
3
In the next example, a complex argument is passed in. The result is the complex unsigned integer that is closest to
the argument.
--> uint64(5+2*i)
ans =
5.0000 +
2.0000i
In the next example, a string argument is passed in. The string argument is converted into an integer array corresponding to the ASCII values of each character.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
538
--> uint64(helo)
ans =
104 101 108 111
In the last example, a cell-array is passed in. For cell-arrays and structure arrays, the result is an error.
--> uint64({4})
Error: Cannot perform type conversions with this type
29.21
29.21.1
Usage
Converts the argument to an unsigned 8-bit Integer. The syntax for its use is
y = uint8(x)
where x is an n-dimensional numerical array. Conversion follows saturation rules (e.g., if x is outside the normal
range for an unsigned 8-bit integer of [0,255], it is truncated to that range. Note that both NaN and Inf both
map to 0.
29.21.2
Example
In the next example, an integer outside the range of the type is passed in. The result is truncated to the maximum
value of the data type.
--> uint8(400)
ans =
255
In the next example, a negative integer is passed in. The result is trunated to zero.
--> uint8(-100)
ans =
0
In the next example, a positive double precision argument is passed in. The result is the unsigned integer that is
closest to the argument.
--> uint8(pi)
ans =
3
In the next example, a complex argument is passed in. The result is complex unsigned integer that is closest to the
argument.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
539
--> uint8(5+2*i)
ans =
5.0000 +
2.0000i
In the next example, a string argument is passed in. The string argument is converted into an integer array corresponding to the ASCII values of each character.
--> uint8(helo)
ans =
104 101 108 111
In the last example, a cell-array is passed in. For cell-arrays and structure arrays, the result is an error.
--> uint8({4})
Error: Cannot perform type conversions with this type
540
Chapter 30
30.1
30.1.1
Usage
The cell array is a fairly powerful array type that is available in FreeMat. Generally speaking, a cell array is a heterogenous array type, meaning that different elements in the array can contain variables of different type (including
other cell arrays). For those of you familiar with C, it is the equivalent to the void array. The general syntax for
their construction is
A = {row_def1;row_def2;...;row_defN}
Each element can be any type of FreeMat variable, including matrices, arrays, cell-arrays, structures, strings, etc.
The restriction on the definition is that each row must have the same number of elements in it.
30.1.2
Examples
542
Note that in the output, the number and string are explicitly printed, but the array is summarized. We can create a
2-dimensional cell-array by adding another row definition
--> B = {pi,i;e,-1}
B =
[3.14159] [0+1i]
[2.71828] [-1]
30.2
30.2.1
Usage
Starting with version 1.11, FreeMat now supports function handles, or function pointers. A
function handle is an alias for a function or script that is stored in a variable. First, the way to assign a
function handle is to use the notation
handle = @func
where func is the name to point to. The function func must exist at the time we make the call. It can be a local
function (i.e., a subfunction). To use the handle, we can either pass it to feval via
[x,y] = feval(handle,arg1,arg2).
30.3
30.3.1
Usage
Global variables are shared variables that can be seen and modified from any function or script that declares them.
The syntax for the global statement is
global variable_1 variable_2 ...
30.3.2
Example
Here is an example of two functions that use a global variable to communicate an array between them. The first
function sets the global variable.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
543
set_global.m
function set_global(x)
global common_array
common_array = x;
The second function retrieves the value from the global variable
get_global.m
function x = get_global
global common_array
x = common_array;
30.4
30.4.1
Usage
There are three classes of indexing expressions available in FreeMat: (), {}, and . Each is explained below in
some detail, and with its own example section.
30.4.2
Indexing
We start with array indexing (), which is the most general indexing expression, and can be used on any array.
There are two general forms for the indexing expression - the N-dimensional form, for which the general syntax is
variable(index_1,index_2,...,index_n)
Here each index expression is either a scalar, a range of integer values, or the special token :, which is shorthand
for 1:end. The keyword end, when included in an indexing expression, is assigned the length of the array in that
dimension. The concept is easier to demonstrate than explain. Consider the following examples:
--> A = zeros(4)
A =
0 0
0 0
0 0
0 0
0
0
0
0
0
0
0
0
--> B = float(randn(2))
B =
-0.1688
0.9485
0.5183
-0.6864
544
--> A(2:3,2:3) = B
A =
0
0
0
0
0
-0.1688
0.9485
0
0
0.5183
-0.6864
0
0
0
0
0
Here the array indexing was used on the left hand side only. It can also be used for right hand side indexing, as in
--> C = A(2:3,1:end)
C =
0
0
-0.1688
0.9485
0.5183
-0.6864
0
0
Note that we used the end keyword to avoid having to know that A has 4 columns. Of course, we could also use
the : token instead:
--> C = A(2:3,:)
C =
0
0
-0.1688
0.9485
0.5183
-0.6864
0
0
An extremely useful example of : with array indexing is for slicing. Suppose we have a 3-D array, that is 2 x 2 x
3, and we want to set the middle slice:
--> D = zeros(2,2,3)
D =
(:,:,1) =
0 0
0 0
(:,:,2) =
0 0
0 0
(:,:,3) =
0 0
0 0
--> D(:,:,2) = int32(10*rand(2,2))
D =
(:,:,1) =
0 0
0 0
(:,:,2) =
9 10
5 8
(:,:,3) =
0 0
0 0
In another level of nuance, the assignment expression will automatically fill in the indexed rectangle on the left using
data from the right hand side, as long as the lengths match. So we can take a vector and roll it into a matrix using
this approach:
--> A = zeros(4)
A =
0 0
0 0
0 0
0 0
0
0
0
0
545
0
0
0
0
--> v = [1;2;3;4]
v =
1
2
3
4
--> A(2:3,2:3) = v
A =
0 0
0 1
0 2
0 0
0
3
4
0
0
0
0
0
The N-dimensional form of the variable index is limited to accessing only (hyper-) rectangular regions of the array.
You cannot, for example, use it to access only the diagonal elements of the array. To do that, you use the second
form of the array access (or a loop). The vector form treats an arbitrary N-dimensional array as though it were
a column vector. You can then access arbitrary subsets of the arrays elements (for example, through a find
expression) efficiently. Note that in vector form, the end keyword takes the meaning of the total length of the array
(defined as the product of its dimensions), as opposed to the size along the first dimension.
30.4.3
Indexing
The second form of indexing operates, to a large extent, in the same manner as the array indexing, but it is by no
means interchangable. As the name implies, cell-indexing applies only to cell arrays. For those familiar with C,
cell- indexing is equivalent to pointer derefencing in C. First, the syntax:
variable{index_1,index_2,...,index_n}
The rules and interpretation for N-dimensional and vector indexing are identical to (), so we will describe only the
differences. In simple terms, applying () to a cell-array returns another cell array that is a subset of the original
array. On the other hand, applying {} to a cell-array returns the contents of that cell array. A simple example makes
the difference quite clear:
--> A = {1, hello, [1:4]}
A =
[1] [hello] [1x4 double array]
--> A(1:2)
ans =
[1] [hello]
--> A{1:2}
ans =
1 of 2:
1
2 of 2:
hello
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
546
You may be surprised by the response to the last line. The output is multiple assignments to ans!. The output of a
cell-array dereference can be used anywhere a list of expressions is required. This includes arguments and returns
for function calls, matrix construction, etc. Here is an example of using cell-arrays to pass parameters to a function:
--> A = {[1,3,0],[5,2,7]}
A =
[1x3 double array] [1x3 double array]
--> max(A{1:end})
ans =
5 3 7
Note that this form of indexing is used to implement variable length arguments to function. See varargin and
varargout for more details.
30.4.4
Indexing
The third form of indexing is structure indexing. It can only be applied to structure arrays, and has the general syntax
variable.fieldname
where fieldname is one of the fields on the structure. Note that in FreeMat, fields are allocated dynamically, so if
you reference a field that does not exist in an assignment, it is created automatically for you. If variable is an array,
then the result of the . reference is an expression list, exactly like the {} operator. Hence, we can use structure
indexing in a simple fashion:
--> clear A
--> A.color = blue
A =
color: blue
--> B = A.color
B =
blue
547
maxargs
--> max(A.maxargs)
ans =
5 6 9 3
clear A
A(1).maxreturn = [];
A(2).maxreturn = [];
[A.maxreturn] = max(randn(1,4))
struct array with fields:
maxreturn
FreeMat now also supports the so called dynamic-field indexing expressions. In this mode, the fieldname is supplied
through an expression instead of being explicitly provided. For example, suppose we have a set of structure indexed
by color,
-->
-->
-->
-->
x.red = 430;
x.green = 240;
x.blue = 53;
x.yello = 105
x =
red: 430
green: 240
blue: 53
yello: 105
Then we can index into the structure x using a dynamic field reference:
--> y = green
y =
green
--> a = x.(y)
a =
240
Note that the indexing expression has to resolve to a string for dynamic field indexing to work.
30.4.5
Indexing
The indexing expressions described above can be freely combined to affect complicated indexing expressions. Here
is an example that exercises all three indexing expressions in one assignment.
--> Z{3}.foo(2) = pi
Z =
[0] [0] [1x1 struct array]
From this statement, FreeMat infers that Z is a cell-array of length 3, that the third element is a structure array (with
one element), and that this structure array contains a field named foo with two double elements, the second of
which is assigned a value of pi.
30.5
548
30.5.1
Usage
The matrix is the basic datatype of FreeMat. Matrices can be defined using the following syntax
A = [row_def1;row_def2;...,row_defN]
Each element can either be a scalar value or another matrix, provided that the resulting matrix definition makes
sense. In general this means that all of the elements belonging to a row have the same number of rows themselves,
and that all of the row definitions have the same number of columns. Matrices are actually special cases of Ndimensional arrays where N<=2. Higher dimensional arrays cannot be constructed using the bracket notation
described above. The type of a matrix defined in this way (using the bracket notation) is determined by examining the
types of the elements. The resulting type is chosen so no information is lost on any of the elements (or equivalently,
by choosing the highest order type from those present in the elements).
30.5.2
Examples
Here is an example of a matrix of int32 elements (note that untyped integer constants default to type int32).
--> A = [1,2;5,8]
A =
1 2
5 8
Now we define a new matrix by adding a column to the right of A, and using float constants.
--> B = [A,[3.2f;5.1f]]
B =
1.0000
5.0000
2.0000
8.0000
3.2000
5.1000
Next, we add extend B by adding a row at the bottom. Note how the use of an untyped floating point constant forces
the result to be of type double
--> C = [B;5.2,1.0,0.0]
C =
1.0000
5.0000
5.2000
2.0000
8.0000
1.0000
3.2000
5.1000
0
If we instead add a row of complex values (recall that i is a complex constant, not a dcomplex constant)
--> D = [B;2.0f+3.0f*i,i,0.0f]
D =
1.0000 +
5.0000 +
2.0000 +
0.0000i
0.0000i
3.0000i
2.0000 +
8.0000 +
0.0000 +
0.0000i
0.0000i
1.0000i
3.2000 +
5.1000 +
0
0.0000i
0.0000i
3.2000 +
5.1000 +
0
0.0000i
0.0000i
0.0000i
0.0000i
3.0000i
2.0000 +
8.0000 +
0.0000 +
0.0000i
0.0000i
1.0000i
549
Finally, in FreeMat, you can construct matrices with strings as contents, but you have to make sure that if the matrix
has more than one row, that all the strings have the same length.
--> F = [hello;there]
F =
hello
there
30.6
30.6.1
Usage
Persistent variables are variables whose value persists between calls to a function or script. The general syntax for
its use is
persistent variable1 variable2 ... variableN
The persistent statement must occur before the variable is the tagged as persistent. Per the MATLAB API
documentation an empty variable is created when the persistent statement is called.
30.6.2
Example
Here is an example of a function that counts how many times it has been called.
count_calls.m
function count_calls
persistent ccount
if isempty(ccount); ccount = 0; end;
ccount = ccount + 1;
printf(Function has been called %d times\n,ccount);
30.7
30.7.1
Usage
Creates an array of structures from a set of field, value pairs. The syntax is
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
550
y = struct(n_1,v_1,n_2,v_2,...)
where n_i are the names of the fields in the structure array, and v_i are the values. The values v_i must either
all be scalars, or be cell-arrays of all the same dimensions. In the latter case, the output structure array will have
dimensions dictated by this common size. Scalar entries for the v_i are replicated to fill out their dimensions. An
error is raised if the inputs are not properly matched (i.e., are not pairs of field names and values), or if the size of
any two non-scalar values cell-arrays are different.
Another use of the struct function is to convert a class into a structure. This allows you to access the members
of the class, directly but removes the class information from the object.
30.7.2
Example
This example creates a 3-element structure array with three fields, foo bar and key, where the contents of foo
and bar are provided explicitly as cell arrays of the same size, and the contents of bar are replicated from a scalar.
--> y = struct(foo,{1,3,4},bar,{cheese,cola,beer},key,508)
y =
1x3 struct array with fields:
foo
bar
key
--> y(1)
ans =
foo: 1
bar: cheese
key: 508
--> y(2)
ans =
foo: 3
bar: cola
key: 508
--> y(3)
ans =
foo: 4
bar: beer
key: 508
An alternate way to create a structure array is to initialize the last element of each field of the structure
-->
-->
-->
-->
Test(2,3).Type = Beer;
Test(2,3).Ounces = 12;
Test(2,3).Container = Can;
Test(2,3)
ans =
Type: Beer
Ounces: 12
Container: Can
--> Test(1,1)
ans =
Type: 0
Ounces: 0
Container: 0
Chapter 31
552
553
vtkInformationObjectBaseVectorKey
vtkInformationQuadratureSchemeDefinitionVectorKey
vtkInformationRequestKey
vtkInformationStringKey
vtkInformationStringVectorKey
vtkInformationUnsignedLongKey
vtkInformationVector
vtkInitialValueProblemSolver
vtkInstantiator
vtkIntArray
vtkLinearTransform
vtkLogLookupTable
vtkLongArray
vtkLongLongArray
vtkLookupTable
vtkLookupTableWithEnabling
vtkMath
vtkMatrix3x3
vtkMatrix4x4
vtkMatrixToHomogeneousTransform
vtkMatrixToLinearTransform
vtkMinimalStandardRandomSequence
vtkMultiThreader
vtkMutexLock
vtkObject
vtkObjectBase
vtkObjectFactory
vtkObjectFactoryCollection
vtkOutputWindow
vtkOverrideInformation
vtkOverrideInformationCollection
vtkParametricBoy
vtkParametricConicSpiral
vtkParametricCrossCap
vtkParametricDini
vtkParametricEllipsoid
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
554
555
vtkStructuredData
vtkStructuredVisibilityConstraint
vtkTableExtentTranslator
vtkTensor
vtkThreadMessager
vtkTimePointUtility
vtkTimerLog
vtkTransform
vtkTransform2D
vtkTransformCollection
vtkTypeFloat32Array
vtkTypeFloat64Array
vtkTypeInt16Array
vtkTypeInt32Array
vtkTypeInt64Array
vtkTypeInt8Array
vtkTypeUInt16Array
vtkTypeUInt32Array
vtkTypeUInt64Array
vtkTypeUInt8Array
vtkUnicodeStringArray
vtkUnsignedCharArray
vtkUnsignedIntArray
vtkUnsignedLongArray
vtkUnsignedLongLongArray
vtkUnsignedShortArray
vtkVariantArray
vtkVersion
vtkVoidArray
vtkWarpTransform
vtkWindow
vtkWindowLevelLookupTable
vtkXMLDataElement
vtkXMLFileOutputWindow
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
556
31.1
vtkAbstractArray
31.1.1
Usage
vtkAbstractArray is an abstract superclass for data array objects. This class defines an API that all subclasses
must support. The data type must be assignable and copy-constructible, but no other assumptions about its type
are made. Most of the subclasses of this array deal with numeric data either as scalars or tuples of scalars. A
program can use the IsNumeric() method to check whether an instance of vtkAbstractArray contains numbers. It is
also possible to test for this by attempting to SafeDownCast an array to an instance of vtkDataArray, although this
assumes that all numeric arrays will always be descended from vtkDataArray.
Every array has a character-string name. The naming of the array occurs automatically when it is instantiated, but
you are free to change this name using the SetName() method. (The array name is used for data manipulation.)
To create an instance of class vtkAbstractArray, simply invoke its constructor as follows
obj = vtkAbstractArray
31.1.2
Methods
The class vtkAbstractArray has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkAbstractArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAbstractArray = obj.NewInstance ()
vtkAbstractArray = obj.SafeDownCast (vtkObject o)
int = obj.Allocate (vtkIdType sz, vtkIdType ext) - Allocate memory for this array.
Delete old storage only if necessary. Note that ext is no longer used.
obj.Initialize () - Release storage and reset array to initial state.
int = obj.GetDataType () - Return the underlying data type. An integer indicating data type is
returned as specified in vtkSetGet.h.
int = obj.GetDataTypeSize () - Return the size of the underlying data type. For a bit, 0 is returned. For string 0 is returned. Arrays with variable length components return 0.
int = obj.GetElementComponentSize () - Return the size, in bytes, of the lowest-level element
of an array. For vtkDataArray and subclasses this is the size of the data type. For vtkStringArray, this is
sizeof(vtkStdString::value_type), which winds up being sizeof(char).
obj.SetNumberOfComponents (int ) - Set/Get the dimention (n) of the components. Must be >=
1. Make sure that this is set before allocation.
int = obj.GetNumberOfComponentsMinValue () - Set/Get the dimention (n) of the components. Must be >= 1. Make sure that this is set before allocation.
int = obj.GetNumberOfComponentsMaxValue () - Set/Get the dimention (n) of the components. Must be >= 1. Make sure that this is set before allocation.
int = obj.GetNumberOfComponents () - Set the number of tuples (a component group) in the
array. Note that this may allocate space depending on the number of components. Also note that if allocation
is performed no copy is performed so existing data will be lost (if data conservation is sought, one may use
the Resize method instead).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.1 vtkAbstractArray
557
558
31.2
vtkAbstractTransform
31.2.1
Usage
vtkAbstractTransform is the superclass for all VTK geometric transformations. The VTK transform hierarchy is split
into two major branches: warp transformations and homogeneous (including linear) transformations. The latter can
be represented in terms of a 4x4 transformation matrix, the former cannot.
Transformations can be pipelined through two mechanisms:
1) GetInverse() returns the pipelined inverse of a transformation i.e. if you modify the original transform, any transform previously returned by the GetInverse() method will automatically update itself according to the change.
2) You can do pipelined concatenation of transformations through the vtkGeneralTransform class, the vtkPerspectiveTransform class, or the vtkTransform class.
To create an instance of class vtkAbstractTransform, simply invoke its constructor as follows
obj = vtkAbstractTransform
31.2.2
Methods
The class vtkAbstractTransform has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAbstractTransform class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.2 vtkAbstractTransform
559
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAbstractTransform = obj.NewInstance ()
vtkAbstractTransform = obj.SafeDownCast (vtkObject o)
obj.TransformPoint (float in[3], float out[3]) - Apply the transformation to a coordinate. You can use the same array to store both the input and output point.
obj.TransformPoint (double in[3], double out[3]) - Apply the transformation to a
double-precision coordinate. You can use the same array to store both the input and output point.
double = obj.TransformPoint (double x, double y, double z) - Apply the transformation to a double-precision coordinate. Use this if you are programming in Python, tcl or Java.
double = obj.TransformPoint (double point[3]) - Apply the transformation to a doubleprecision coordinate. Use this if you are programming in Python, tcl or Java.
float = obj.TransformFloatPoint (float x, float y, float z) - Apply the transformation to an (x,y,z) coordinate. Use this if you are programming in Python, tcl or Java.
float = obj.TransformFloatPoint (float point[3]) - Apply the transformation to an
(x,y,z) coordinate. Use this if you are programming in Python, tcl or Java.
double = obj.TransformDoublePoint (double x, double y, double z) - Apply the
transformation to a double-precision (x,y,z) coordinate. Use this if you are programming in Python, tcl or Java.
double = obj.TransformDoublePoint (double point[3]) - Apply the transformation to a
double-precision (x,y,z) coordinate. Use this if you are programming in Python, tcl or Java.
obj.TransformNormalAtPoint (float point[3], float in[3], float out[3]) Apply the transformation to a normal at the specified vertex. If the transformation is a vtkLinearTransform,
you can use TransformNormal() instead.
obj.TransformNormalAtPoint (double point[3], double in[3], double out[3])
- Apply the transformation to a normal at the specified vertex. If the transformation is a vtkLinearTransform,
you can use TransformNormal() instead.
double = obj.TransformNormalAtPoint (double point[3], double normal[3])
double = obj.TransformDoubleNormalAtPoint (double point[3], double normal[3])
- Apply the transformation to a double-precision normal at the specified vertex. If the transformation is a
vtkLinearTransform, you can use TransformDoubleNormal() instead.
float = obj.TransformFloatNormalAtPoint (float point[3], float normal[3])
- Apply the transformation to a single-precision normal at the specified vertex. If the transformation is a vtkLinearTransform, you can use TransformFloatNormal() instead.
obj.TransformVectorAtPoint (float point[3], float in[3], float out[3]) Apply the transformation to a vector at the specified vertex. If the transformation is a vtkLinearTransform, you
can use TransformVector() instead.
obj.TransformVectorAtPoint (double point[3], double in[3], double out[3])
- Apply the transformation to a vector at the specified vertex. If the transformation is a vtkLinearTransform,
you can use TransformVector() instead.
double = obj.TransformVectorAtPoint (double point[3], double vector[3])
double = obj.TransformDoubleVectorAtPoint (double point[3], double vector[3])
- Apply the transformation to a double-precision vector at the specified vertex. If the transformation is a vtkLinearTransform, you can use TransformDoubleVector() instead.
float = obj.TransformFloatVectorAtPoint (float point[3], float vector[3])
- Apply the transformation to a single-precision vector at the specified vertex. If the transformation is a vtkLinearTransform, you can use TransformFloatVector() instead.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
560
vtkDataArray inNms, vtkDataArray outNms, vtkDataArray inVrs, vtkDataArray outVrs) - Apply the transformation to a combination of points, normals and vectors.
vtkAbstractTransform = obj.GetInverse () - Get the inverse of this transform. If you modify
this transform, the returned inverse transform will automatically update. If you want the inverse of a vtkTransform, you might want to use GetLinearInverse() instead which will type cast the result from vtkAbstractTransform to vtkLinearTransform.
obj.SetInverse (vtkAbstractTransform transform) - Set a transformation that this transform will be the inverse of. This transform will automatically update to agree with the inverse transform that
you set.
obj.Inverse () - Invert the transformation.
obj.DeepCopy (vtkAbstractTransform ) - Copy this transform from another of the same type.
obj.Update () - Update the transform to account for any changes which have been made. You do not
have to call this method yourself, it is called automatically whenever the transform needs an update.
obj.InternalTransformPoint (float in[3], float out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformPoint (double in[3], double out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
vtkAbstractTransform = obj.MakeTransform () - Make another transform of the same type.
int = obj.CircuitCheck (vtkAbstractTransform transform) - Check for selfreference. Will return true if concatenating with the specified transform, setting it to be our inverse, or
setting it to be our input will create a circular reference. CircuitCheck is automatically called by SetInput(),
SetInverse(), and Concatenate(vtkXTransform ). Avoid using this function, it is experimental.
long = obj.GetMTime () - Override GetMTime necessary because of inverse transforms.
obj.UnRegister (vtkObjectBase O) - Needs a special UnRegister() implementation to avoid circular references.
obj.Identity () -
31.3
vtkAmoebaMinimizer
31.3.1
Usage
vtkAmoebaMinimizer will modify a set of parameters in order to find the minimum of a specified function. The method
used is commonly known as the amoeba method, it constructs an n-dimensional simplex in parameter space (i.e. a
tetrahedron if the number or parameters is 3) and moves the vertices around parameter space until a local minimum
is found. The amoeba method is robust, reasonably efficient, but is not guaranteed to find the global minimum if
several local minima exist.
To create an instance of class vtkAmoebaMinimizer, simply invoke its constructor as follows
obj = vtkAmoebaMinimizer
31.3 vtkAmoebaMinimizer
31.3.2
561
Methods
The class vtkAmoebaMinimizer has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAmoebaMinimizer
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAmoebaMinimizer = obj.NewInstance ()
vtkAmoebaMinimizer = obj.SafeDownCast (vtkObject o)
obj.SetParameterValue (string name, double value) - Set the initial value for the specified parameter. Calling this function for any parameter will reset the Iterations and the FunctionEvaluations
counts to zero. You must also use SetParameterScale() to specify the step size by which the parameter will
be modified during the minimization. It is preferable to specify parameters by name, rather than by number.
obj.SetParameterValue (int i, double value) - Set the initial value for the specified parameter. Calling this function for any parameter will reset the Iterations and the FunctionEvaluations counts to
zero. You must also use SetParameterScale() to specify the step size by which the parameter will be modified
during the minimization. It is preferable to specify parameters by name, rather than by number.
obj.SetParameterScale (string name, double scale) - Set the scale to use when modifying a parameter, i.e. the initial amount by which the parameter will be modified during the search for the
minimum. It is preferable to identify scalars by name rather than by number.
double = obj.GetParameterScale (string name) - Set the scale to use when modifying a
parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum.
It is preferable to identify scalars by name rather than by number.
obj.SetParameterScale (int i, double scale) - Set the scale to use when modifying a
parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum.
It is preferable to identify scalars by name rather than by number.
double = obj.GetParameterScale (int i) - Set the scale to use when modifying a parameter,
i.e. the initial amount by which the parameter will be modified during the search for the minimum. It is
preferable to identify scalars by name rather than by number.
double = obj.GetParameterValue (string name) - Get the value of a parameter at the current stage of the minimization. Call this method within the function that you are minimizing in order to get the
current parameter values. It is preferable to specify parameters by name rather than by index.
double = obj.GetParameterValue (int i) - Get the value of a parameter at the current stage
of the minimization. Call this method within the function that you are minimizing in order to get the current
parameter values. It is preferable to specify parameters by name rather than by index.
string = obj.GetParameterName (int i) - For completeness, an unchecked method to get the
name for particular parameter (the result will be NULL if no name was set).
int = obj.GetNumberOfParameters () - Get the number of parameters that have been set.
obj.Initialize () - Initialize the minimizer. This will reset the number of parameters to zero so that
the minimizer can be reused.
obj.Minimize () - Iterate until the minimum is found to within the specified tolerance, or until the MaxIterations has been reached.
int = obj.Iterate () - Perform one iteration of minimization. Returns zero if the tolerance stopping
criterion has been met.
obj.SetFunctionValue (double ) - Get the function value resulting from the minimization.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
562
31.4
vtkAnimationCue
31.4.1
Usage
vtkAnimationCue and vtkAnimationScene provide the framework to support animations in VTK. vtkAnimationCue
represents an entity that changes/ animates with time, while vtkAnimationScene represents scene or setup for the
animation, which consists on individual cues or other scenes.
A cue has three states: UNINITIALIZED, ACTIVE and INACTIVE. UNINITIALIZED represents an point in time before
the start time of the cue. The cue is in ACTIVE state at a point in time between start time and end time for the cue.
While, beyond the end time, it is in INACTIVE state. When the cue enters the ACTIVE state, StartAnimationCueEvent is fired. This event may be handled to initialize the entity to be animated. When the cue leaves the ACTIVE
state, EndAnimationCueEvent is fired, which can be handled to cleanup after having run the animation. For every
request to render during the ACTIVE state, AnimationCueTickEvent is fired, which must be handled to perform the
actual animation.
To create an instance of class vtkAnimationCue, simply invoke its constructor as follows
obj = vtkAnimationCue
31.4.2
Methods
The class vtkAnimationCue has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkAnimationCue class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAnimationCue = obj.NewInstance ()
vtkAnimationCue = obj.SafeDownCast (vtkObject o)
obj.SetTimeMode (int mode) - Get/Set the time mode. In Normalized mode, the start and end
times of the cue are normalized [0,1] with respect to the start and end times of the container scene. In
Relative mode the start and end time of the cue are specified in offset seconds relative to the start time of the
container scene.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.4 vtkAnimationCue
563
int = obj.GetTimeMode () - Get/Set the time mode. In Normalized mode, the start and end times of
the cue are normalized [0,1] with respect to the start and end times of the container scene. In Relative mode
the start and end time of the cue are specified in offset seconds relative to the start time of the container
scene.
obj.SetTimeModeToRelative () - Get/Set the time mode. In Normalized mode, the start and end
times of the cue are normalized [0,1] with respect to the start and end times of the container scene. In
Relative mode the start and end time of the cue are specified in offset seconds relative to the start time of the
container scene.
obj.SetTimeModeToNormalized () - Get/Set the Start time for this cue. When the current time is
>= StartTime, the Cue is in ACTIVE state. if Current time i < StartTime, the Cue is in UNINITIALIZED state.
Whenever the cue enters the ACTIVE state from an INACTIVE state, it triggers the StartEvent. The Start time
is in seconds relative to the start of the container Scene (when in Relative time mode) or is normalized over
the span of the container Scene (when in Normalized time mode).
obj.SetStartTime (double ) - Get/Set the Start time for this cue. When the current time is >=
StartTime, the Cue is in ACTIVE state. if Current time i < StartTime, the Cue is in UNINITIALIZED state.
Whenever the cue enters the ACTIVE state from an INACTIVE state, it triggers the StartEvent. The Start time
is in seconds relative to the start of the container Scene (when in Relative time mode) or is normalized over
the span of the container Scene (when in Normalized time mode).
double = obj.GetStartTime () - Get/Set the Start time for this cue. When the current time is >=
StartTime, the Cue is in ACTIVE state. if Current time i < StartTime, the Cue is in UNINITIALIZED state.
Whenever the cue enters the ACTIVE state from an INACTIVE state, it triggers the StartEvent. The Start time
is in seconds relative to the start of the container Scene (when in Relative time mode) or is normalized over
the span of the container Scene (when in Normalized time mode).
obj.SetEndTime (double ) - Get/Set the End time for this cue. When the current time is > EndTime, the Cue is in INACTIVE state. Whenever the cue leaves an ACTIVE state to enter INACTIVE state,
the EndEvent is triggered. The End time is in seconds relative to the start of the container Scene (when in
Relative time mode) or is normalized over the span of the container Scene (when in Normalized time mode).
double = obj.GetEndTime () - Get/Set the End time for this cue. When the current time is > EndTime, the Cue is in INACTIVE state. Whenever the cue leaves an ACTIVE state to enter INACTIVE state,
the EndEvent is triggered. The End time is in seconds relative to the start of the container Scene (when in
Relative time mode) or is normalized over the span of the container Scene (when in Normalized time mode).
obj.Tick (double currenttime, double deltatime, double clocktime) - Indicates a tick or point in time in the animation. Triggers a Tick event if currenttime >= StartTime and
currenttime <= EndTime. Whenever the state of the cue changes, either StartEvent or EndEvent is triggerred depending upon whether the cue entered Active state or quit active state respectively. The current
time is relative to the start of the container Scene (when in Relative time mode) or is normalized over the
span of the container Scene (when in Normalized time mode). deltatime is the time since last call to Tick.
deltatime also can be in seconds relative to the start of the container Scene or normalized depending upon
the cues Time mode. clocktime is the time from the scene i.e. it does not depend on the time mode for the
cue. For the first call to Tick after a call to Initialize(), the deltatime is 0;
obj.Initialize () - Called when the playing of the scene begins. This will set the Cue to UNINITIALIZED state.
obj.Finalize () - Called when the scene reaches the end. If the cue state is ACTIVE when this method
is called, this will trigger a EndAnimationCueEvent.
double = obj.GetAnimationTime () - This is valid only in a AnimationCueTickEvent handler. Before firing the event the animation cue sets the AnimationTime to the time of the tick.
double = obj.GetDeltaTime () - This is valid only in a AnimationCueTickEvent handler. Before
firing the event the animation cue sets the DeltaTime to the difference in time between the current tick and
the last tick.
double = obj.GetClockTime () - This is valid only in a AnimationCueTickEvent handler. Before
firing the event the animation cue sets the ClockTime to the time of the tick. ClockTime is directly the time
from the animation scene neither normalized nor offsetted to the start of the scene.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
564
31.5
vtkAnimationScene
31.5.1
Usage
vtkAnimationCue and vtkAnimationScene provide the framework to support animations in VTK. vtkAnimationCue
represents an entity that changes/ animates with time, while vtkAnimationScene represents scene or setup for the
animation, which consists of individual cues or other scenes.
A scene can be played in real time mode, or as a seqence of frames 1/frame rate apart in time.
To create an instance of class vtkAnimationScene, simply invoke its constructor as follows
obj = vtkAnimationScene
31.5.2
Methods
The class vtkAnimationScene has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkAnimationScene class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAnimationScene = obj.NewInstance ()
vtkAnimationScene = obj.SafeDownCast (vtkObject o)
obj.SetPlayMode (int ) - Get/Set the PlayMode for running/playing the animation scene. In the
Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the
constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.
obj.SetModeToSequence () - Get/Set the PlayMode for running/playing the animation scene. In the
Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the
constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.
obj.SetModeToRealTime () - Get/Set the PlayMode for running/playing the animation scene. In the
Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the
constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.
int = obj.GetPlayMode () - Get/Set the PlayMode for running/playing the animation scene. In the
Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the
constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.
obj.SetFrameRate (double ) - Get/Set the frame rate (in frames per second). This parameter
affects only in the Sequence mode. The time interval indicated to each cue on every tick is progressed by
1/frame-rate seconds.
double = obj.GetFrameRate () - Get/Set the frame rate (in frames per second). This parameter
affects only in the Sequence mode. The time interval indicated to each cue on every tick is progressed by
1/frame-rate seconds.
obj.AddCue (vtkAnimationCue cue) - Add/Remove an AnimationCue to/from the Scene. Its an
error to add a cue twice to the Scene.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.6 vtkArray
565
31.6
vtkArray
31.6.1
Usage
vtkArray is the root of a hierarchy of arrays that can be used to store data with any number of dimensions. It provides
an abstract interface for retrieving and setting array attributes that are independent of the type of values stored in
the array - such as the number of dimensions, extents along each dimension, and number of values stored in the
array.
To get and set array values, the vtkTypedArray template class derives from vtkArray and provides type-specific
methods for retrieval and update.
Two concrete derivatives of vtkTypedArray are provided at the moment: vtkDenseArray and vtkSparseArray, which
provide dense and sparse storage for arbitrary-dimension data, respectively. Toolkit users can create their own
concrete derivatives that implement alternative storage strategies, such as compressed-sparse-row, etc. You could
also create an array that provided read-only access to virtual data, such as an array that returned a Fibonacci
sequence, etc.
To create an instance of class vtkArray, simply invoke its constructor as follows
obj = vtkArray
31.6.2
Methods
The class vtkArray has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
566
31.7
vtkArrayIterator
31.8 vtkAssemblyNode
31.7.1
567
Usage
vtkArrayIterator is used to iterate over elements in any vtkAbstractArray subclass. The vtkArrayIteratorTemplateMacro is used to centralize the set of types supported by Execute methods. It also avoids duplication of long switch
statement case lists. Note that in this macro VTK_TT is defined to be the type of the iterator for the given type of
array. One must include the vtkArrayIteratorIncludes.h header file to provide for extending of this macro by addition
of new iterators.
Example usage:
vtkArrayIter* iter = array->NewIterator();
switch(array->GetDataType())
{
vtkArrayIteratorTemplateMacro(myFunc(static_cast<VTK_TT*>(iter), arg2));
}
iter->Delete();
31.7.2
Methods
The class vtkArrayIterator has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkArrayIterator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkArrayIterator = obj.NewInstance ()
vtkArrayIterator = obj.SafeDownCast (vtkObject o)
obj.Initialize (vtkAbstractArray array) - Set the array this iterator will iterate over. After
Initialize() has been called, the iterator is valid so long as the Array has not been modified (except using the
iterator itself). If the array is modified, the iterator must be re-intialized.
int = obj.GetDataType ()
31.8
vtkAssemblyNode
31.8.1
Usage
vtkAssemblyNode represents a node in an assembly. It is used by vtkAssemblyPath to create hierarchical assemblies of props. The props can be either 2D or 3D.
An assembly node refers to a vtkProp, and possibly a vtkMatrix4x4. Nodes are used by vtkAssemblyPath to build
fully evaluated path (matrices are concatenated through the path) that is used by picking and other operations
involving assemblies.
To create an instance of class vtkAssemblyNode, simply invoke its constructor as follows
obj = vtkAssemblyNode
568
31.8.2
Methods
The class vtkAssemblyNode has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkAssemblyNode class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAssemblyNode = obj.NewInstance ()
vtkAssemblyNode = obj.SafeDownCast (vtkObject o)
obj.SetViewProp (vtkProp prop) - Set/Get the prop that this assembly node refers to.
vtkProp = obj.GetViewProp () - Set/Get the prop that this assembly node refers to.
obj.SetMatrix (vtkMatrix4x4 matrix) - Specify a transformation matrix associated with the
prop. Note: if the prop is not a type of vtkProp3D, then the transformation matrix is ignored (and expected
to be NULL). Also, internal to this object the matrix is copied because the matrix is used for computation by
vtkAssemblyPath.
vtkMatrix4x4 = obj.GetMatrix () - Specify a transformation matrix associated with the prop.
Note: if the prop is not a type of vtkProp3D, then the transformation matrix is ignored (and expected to
be NULL). Also, internal to this object the matrix is copied because the matrix is used for computation by
vtkAssemblyPath.
long = obj.GetMTime () - Override the standard GetMTime() to check for the modified times of the
prop and matrix.
obj.SetProp (vtkProp prop) -
31.9
vtkAssemblyPath
31.9.1
Usage
vtkAssemblyPath represents an ordered list of assembly nodes that represent a fully evaluated assembly path. This
class is used primarily for picking. Note that the use of this class is to add one or more assembly nodes to form the
path. (An assembly node consists of an instance of vtkProp and vtkMatrix4x4, the matrix may be NULL.) As each
node is added, the matrices are concatenated to create a final, evaluated matrix.
To create an instance of class vtkAssemblyPath, simply invoke its constructor as follows
obj = vtkAssemblyPath
31.9.2
Methods
The class vtkAssemblyPath has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkAssemblyPath class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAssemblyPath = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.10 vtkAssemblyPaths
569
31.10
vtkAssemblyPaths
31.10.1
Usage
vtkAssemblyPaths represents an assembly hierarchy as a list of vtkAssemblyPath. Each path represents the complete path from the top level assembly (if any) down to the leaf prop.
To create an instance of class vtkAssemblyPaths, simply invoke its constructor as follows
obj = vtkAssemblyPaths
31.10.2
Methods
The class vtkAssemblyPaths has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkAssemblyPaths class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAssemblyPaths = obj.NewInstance ()
vtkAssemblyPaths = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkAssemblyPath p) - Add a path to the list.
obj.RemoveItem (vtkAssemblyPath p) - Remove a path from the list.
int = obj.IsItemPresent (vtkAssemblyPath p) - Determine whether a particular path is
present. Returns its position in the list.
vtkAssemblyPath = obj.GetNextItem () - Get the next path in the list.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
570
31.11
vtkBitArray
31.11.1
Usage
vtkBitArray is an array of bits (0/1 data value). The array is packed so that each byte stores eight bits. vtkBitArray
provides methods for insertion and retrieval of bits, and will automatically resize itself to hold new data.
To create an instance of class vtkBitArray, simply invoke its constructor as follows
obj = vtkBitArray
31.11.2
Methods
The class vtkBitArray has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkBitArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBitArray = obj.NewInstance ()
vtkBitArray = obj.SafeDownCast (vtkObject o)
int = obj.Allocate (vtkIdType sz, vtkIdType ext) - Allocate memory for this array.
Delete old storage only if necessary. Note that ext is no longer used.
obj.Initialize () - Release storage and reset array to initial state.
int = obj.GetDataType ()
int = obj.GetDataTypeSize () - Set the number of n-tuples in the array.
obj.SetNumberOfTuples (vtkIdType number) - Set the number of n-tuples in the array.
obj.SetTuple (vtkIdType i, vtkIdType j, vtkAbstractArray source) - Set the
tuple at the ith location using the jth tuple in the source array. This method assumes that the two arrays
have the same type and structure. Note that range checking and memory allocation is not performed; use in
conjunction with SetNumberOfTuples() to allocate space.
obj.InsertTuple (vtkIdType i, vtkIdType j, vtkAbstractArray source) - Insert the jth tuple in the source array, at ith location in this array. Note that memory allocation is performed as
necessary to hold the data.
vtkIdType = obj.InsertNextTuple (vtkIdType j, vtkAbstractArray source) Insert the jth tuple in the source array, at the end in this array. Note that memory allocation is performed as
necessary to hold the data. Returns the location at which the data was inserted.
obj.GetTuple (vtkIdType i, double tuple) - Copy the tuple value into a user-provided array.
obj.SetTuple (vtkIdType i, float tuple) - Set the tuple value at the ith location in the array.
obj.SetTuple (vtkIdType i, double tuple) - Set the tuple value at the ith location in the
array.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.11 vtkBitArray
571
572
31.12
vtkBox
31.12.1
Usage
vtkBox computes the implicit function and/or gradient for a axis-aligned bounding box. (The superclasses transform
can be used to modify this orientation.) Each side of the box is orthogonal to all other sides meeting along shared
edges and all faces are orthogonal to the x-y-z coordinate axes. (If you wish to orient this box differently, recall
that the superclass vtkImplicitFunction supports a transformation matrix.) vtkCube is a concrete implementation of
vtkImplicitFunction.
To create an instance of class vtkBox, simply invoke its constructor as follows
obj = vtkBox
31.12.2
Methods
The class vtkBox has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkBox class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBox = obj.NewInstance ()
vtkBox = obj.SafeDownCast (vtkObject o)
double = obj.EvaluateFunction (double x[3])
double = obj.EvaluateFunction (double x, double y, double z)
obj.EvaluateGradient (double x[3], double n[3])
obj.SetXMin (double p[3]) - Set / get the bounding box using various methods.
obj.SetXMin (double x, double y, double z) - Set / get the bounding box using various
methods.
obj.GetXMin (double p[3]) - Set / get the bounding box using various methods.
obj.SetXMax (double p[3])
obj.SetXMax (double x, double y, double z)
obj.GetXMax (double p[3])
obj.SetBounds (double xMin, double xMax, double yMin, double yMax, double
31.13 vtkBoxMuellerRandomSequence
573
31.13
vtkBoxMuellerRandomSequence
31.13.1
Usage
vtkGaussianRandomSequence is a sequence of pseudo random numbers distributed according to the Gaussian/normal distribution (mean=0 and standard deviation=1).
It based is calculation from a uniformly distributed pseudo random sequence. The initial sequence is a vtkMinimalStandardRandomSequence.
To create an instance of class vtkBoxMuellerRandomSequence, simply invoke its constructor as follows
obj = vtkBoxMuellerRandomSequence
31.13.2
Methods
The class vtkBoxMuellerRandomSequence has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkBoxMuellerRandomSequence class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBoxMuellerRandomSequence = obj.NewInstance ()
vtkBoxMuellerRandomSequence = obj.SafeDownCast (vtkObject o)
double = obj.GetValue () - Current value.
obj.Next () - Move to the next number in the random sequence.
vtkRandomSequence = obj.GetUniformSequence () - Return the uniformly distributed sequence of random numbers.
obj.SetUniformSequence (vtkRandomSequence uniformSequence) - Set the uniformly
distributed sequence of random numbers. Default is a .
31.14
vtkByteSwap
574
31.14.1
Usage
vtkByteSwap is used by other classes to perform machine dependent byte swapping. Byte swapping is often used
when reading or writing binary files.
To create an instance of class vtkByteSwap, simply invoke its constructor as follows
obj = vtkByteSwap
31.14.2
Methods
The class vtkByteSwap has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkByteSwap class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkByteSwap = obj.NewInstance ()
vtkByteSwap = obj.SafeDownCast (vtkObject o)
31.15
vtkCharArray
31.15.1
Usage
vtkCharArray is an array of values of type char. It provides methods for insertion and retrieval of values and will
automatically resize itself to hold new data.
To create an instance of class vtkCharArray, simply invoke its constructor as follows
obj = vtkCharArray
31.15.2
Methods
The class vtkCharArray has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCharArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCharArray = obj.NewInstance ()
vtkCharArray = obj.SafeDownCast (vtkObject o)
int = obj.GetDataType () - Copy the tuple value into a user-provided array.
obj.GetTupleValue (vtkIdType i, string tuple) - Set the tuple value at the ith location in
the array.
obj.SetTupleValue (vtkIdType i, string tuple) - Insert (memory allocation performed)
the tuple into the ith location in the array.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.16 vtkCollection
575
obj.InsertTupleValue (vtkIdType i, string tuple) - Insert (memory allocation performed) the tuple onto the end of the array.
vtkIdType = obj.InsertNextTupleValue (string tuple) - Get the data at a particular
index.
char = obj.GetValue (vtkIdType id) - Set the data at a particular index. Does not do range
checking. Make sure you use the method SetNumberOfValues() before inserting data.
obj.SetValue (vtkIdType id, char value) - Specify the number of values for this object to
hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for
fast insertion.
obj.SetNumberOfValues (vtkIdType number) - Insert data at a specified position in the array.
obj.InsertValue (vtkIdType id, char f) - Insert data at the end of the array. Return its
location in the array.
vtkIdType = obj.InsertNextValue (char f) - Get the address of a particular data index.
Make sure data is allocated for the number of items requested. Set MaxId according to the number of data
values requested.
string = obj.WritePointer (vtkIdType id, vtkIdType number) - Get the address of
a particular data index. Performs no checks to verify that the memory has been allocated etc.
string = obj.GetPointer (vtkIdType id) - This method lets the user specify data to be held
by the array. The array argument is a pointer to the data. size is the size of the array supplied by the user.
Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class
uses the actual array provided; it does not copy the data from the suppled array.
obj.SetArray (string array, vtkIdType size, int save) - This method lets the user
specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array
supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates
memory. The class uses the actual array provided; it does not copy the data from the suppled array.
obj.SetArray (string array, vtkIdType size, int save, int deleteMethod)
31.16
vtkCollection
31.16.1
Usage
vtkCollection is a general object for creating and manipulating lists of objects. The lists are unsorted and allow
duplicate entries. vtkCollection also serves as a base class for lists of specific types of objects.
To create an instance of class vtkCollection, simply invoke its constructor as follows
obj = vtkCollection
31.16.2
Methods
The class vtkCollection has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCollection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
576
31.17
vtkCollectionIterator
31.17.1
Usage
vtkCollectionIterator provides an alternative way to traverse through the objects in a vtkCollection. Unlike the collections built in interface, this allows multiple iterators to simultaneously traverse the collection. If items are removed
from the collection, only the iterators currently pointing to those items are invalidated. Other iterators will still continue to function normally.
To create an instance of class vtkCollectionIterator, simply invoke its constructor as follows
obj = vtkCollectionIterator
31.18 vtkConditionVariable
31.17.2
577
Methods
The class vtkCollectionIterator has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkCollectionIterator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCollectionIterator = obj.NewInstance ()
vtkCollectionIterator = obj.SafeDownCast (vtkObject o)
obj.SetCollection (vtkCollection ) - Set/Get the collection over which to iterate.
vtkCollection = obj.GetCollection () - Set/Get the collection over which to iterate.
obj.InitTraversal () - Position the iterator at the first item in the collection.
obj.GoToFirstItem () - Position the iterator at the first item in the collection.
obj.GoToNextItem () - Move the iterator to the next item in the collection.
int = obj.IsDoneWithTraversal () - Test whether the iterator is currently positioned at a valid
item. Returns 1 for yes, 0 for no.
vtkObject = obj.GetCurrentObject () - Get the item at the current iterator position. Valid only
when IsDoneWithTraversal() returns 1.
vtkObject = obj.GetObject () -
31.18
vtkConditionVariable
31.18.1
Usage
vtkConditionVariable allows the locking of variables which are accessed through different threads. This header file
also defines vtkSimpleConditionVariable which is not a subclass of vtkObject.
The win32 implementation is based on notes provided by Douglas C. Schmidt and Irfan Pyarali, Department of Computer Science, Washington University, St. Louis, Missouri. http://www.cs.wustl.-
edu/schmidt/win32-cv-1.html
To create an instance of class vtkConditionVariable, simply invoke its constructor as follows
obj = vtkConditionVariable
31.18.2
Methods
The class vtkConditionVariable has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkConditionVariable class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkConditionVariable = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
578
The mutex that should be locked on entry and will be locked on exit (but not in between)
Return values
Normally,this
31.19
vtkContourValues
31.19.1
Usage
vtkContourValues is a general class to manage the creation, generation, and retrieval of contour values. This class
serves as a helper class for contouring classes, or those classes operating on lists of contour values.
To create an instance of class vtkContourValues, simply invoke its constructor as follows
obj = vtkContourValues
31.19.2
Methods
The class vtkContourValues has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkContourValues class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkContourValues = obj.NewInstance ()
vtkContourValues = obj.SafeDownCast (vtkObject o)
obj.SetValue (int i, double value) - Set the ith contour value.
double = obj.GetValue (int i) - Get the ith contour value. The return value will be clamped if
the index i is out of range.
obj.GetValues (double contourValues) - Fill a supplied list with contour values. Make sure
youve allocated memory of size GetNumberOfContours().
obj.SetNumberOfContours (int number) - Set the number of contours to place into the list. You
only really need to use this method to reduce list size. The method SetValue() will automatically increase list
size as needed.
int = obj.GetNumberOfContours () - Return the number of contours in the
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.20 vtkCriticalSection
579
31.20
vtkCriticalSection
31.20.1
Usage
vtkCriticalSection allows the locking of variables which are accessed through different threads. This header file also
defines vtkSimpleCriticalSection which is not a subclass of vtkObject. The API is identical to that of vtkMutexLock,
and the behavior is identical as well, except on Windows 9x/NT platforms. The only difference on these platforms is
that vtkMutexLock is more flexible, in that it works across processes as well as across threads, but also costs more,
in that it evokes a 600-cycle x86 ring transition. The vtkCriticalSection provides a higher-performance equivalent
(on Windows) but wont work across processes. Since it is unclear how, in vtk, an object at the vtk level can be
shared across processes in the first place, one should use vtkCriticalSection unless one has a very good reason to
use vtkMutexLock. If higher-performance equivalents for non-Windows platforms (Irix, SunOS, etc) are discovered,
they should replace the implementations in this class
To create an instance of class vtkCriticalSection, simply invoke its constructor as follows
obj = vtkCriticalSection
31.20.2
Methods
The class vtkCriticalSection has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkCriticalSection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCriticalSection = obj.NewInstance ()
vtkCriticalSection = obj.SafeDownCast (vtkObject o)
obj.Lock () - Lock the vtkCriticalSection
obj.Unlock () - Unlock the vtkCriticalSection
31.21
vtkCylindricalTransform
31.21.1
Usage
vtkCylindricalTransform will convert (r,theta,z) coordinates to (x,y,z) coordinates and back again. The angles are
given in radians. By default, it converts cylindrical coordinates to rectangular, but GetInverse() returns a transform
that will do the opposite. The equation that is used is x = rcos(theta), y = rsin(theta), z = z.
To create an instance of class vtkCylindricalTransform, simply invoke its constructor as follows
obj = vtkCylindricalTransform
580
31.21.2
Methods
The class vtkCylindricalTransform has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCylindricalTransform
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCylindricalTransform = obj.NewInstance ()
vtkCylindricalTransform = obj.SafeDownCast (vtkObject o)
vtkAbstractTransform = obj.MakeTransform () - Make another transform of the same type.
31.22
vtkDataArray
31.22.1
Usage
vtkDataArray is an abstract superclass for data array objects containing numeric data. It extends the API defined
in vtkAbstractArray. vtkDataArray is an abstract superclass for data array objects. This class defines an API that
all array objects must support. Note that the concrete subclasses of this class represent data in native form (char,
int, etc.) and often have specialized more efficient methods for operating on this data (for example, getting pointers
to data or getting/inserting data in native form). Subclasses of vtkDataArray are assumed to contain data whose
components are meaningful when cast to and from double.
To create an instance of class vtkDataArray, simply invoke its constructor as follows
obj = vtkDataArray
31.22.2
Methods
The class vtkDataArray has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkDataArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataArray = obj.NewInstance ()
vtkDataArray = obj.SafeDownCast (vtkObject o)
int = obj.IsNumeric () - Return the size, in bytes, of the lowest-level element of an array. For
vtkDataArray and subclasses this is the size of the data type.
int = obj.GetElementComponentSize () - Set the tuple at the ith location using the jth tuple in
the source array. This method assumes that the two arrays have the same type and structure. Note that range
checking and memory allocation is not performed; use in conjunction with SetNumberOfTuples() to allocate
space.
obj.SetTuple (vtkIdType i, vtkIdType j, vtkAbstractArray source) - Set the
tuple at the ith location using the jth tuple in the source array. This method assumes that the two arrays
have the same type and structure. Note that range checking and memory allocation is not performed; use in
conjunction with SetNumberOfTuples() to allocate space.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.22 vtkDataArray
581
obj.InsertTuple (vtkIdType i, vtkIdType j, vtkAbstractArray source) - Insert the jth tuple in the source array, at ith location in this array. Note that memory allocation is performed as
necessary to hold the data. This pure virtual function is redeclared here to avoid declaration hidden warnings.
vtkIdType = obj.InsertNextTuple (vtkIdType j, vtkAbstractArray source) Insert the jth tuple in the source array, at the end in this array. Note that memory allocation is performed as
necessary to hold the data. Returns the location at which the data was inserted. This pure virtual function is
redeclared here to avoid declaration hidden warnings.
obj.GetTuples (vtkIdList ptIds, vtkAbstractArray output) - Given a list of point
ids, return an array of tuples. You must insure that the output array has been previously allocated with
enough space to hold the data.
obj.GetTuples (vtkIdType p1, vtkIdType p2, vtkAbstractArray output) - Get
the tuples for the range of points ids specified (i.e., p1->p2 inclusive). You must insure that the output
array has been previously allocated with enough space to hold the data.
obj.InterpolateTuple (vtkIdType i, vtkIdList ptIndices, vtkAbstractArray source, double weights) - Set the ith tuple in this array as the interpolated tuple value,
given the ptIndices in the source array and associated interpolation weights. This method assumes that the
two arrays are of the same type and strcuture.
obj.InterpolateTuple (vtkIdType i, vtkIdType id1, vtkAbstractArray source1,
582
double val3, double val4, double val5, double val6, double val7, double
val8) - These methods are included as convenience for the wrappers. InsertTuple() which takes arrays can
not be used from wrapped languages. These methods can be used instead.
vtkIdType = obj.InsertNextTuple (float tuple) - Insert the data tuple at the end of the
array and return the location at which the data was inserted. Memory is allocated as necessary to hold the
data.
vtkIdType = obj.InsertNextTuple (double tuple) - Insert the data tuple at the end of the
array and return the location at which the data was inserted. Memory is allocated as necessary to hold the
data.
obj.InsertNextTuple1 (double value) - These methods are included as convenience for the
wrappers. InsertTuple() which takes arrays can not be used from wrapped languages. These methods can
be used instead.
obj.InsertNextTuple2 (double val0, double val1) - These methods are included as
convenience for the wrappers. InsertTuple() which takes arrays can not be used from wrapped languages.
These methods can be used instead.
obj.InsertNextTuple3 (double val0, double val1, double val2) - These methods
are included as convenience for the wrappers. InsertTuple() which takes arrays can not be used from wrapped
languages. These methods can be used instead.
obj.InsertNextTuple4 (double val0, double val1, double val2, double
val3) - These methods are included as convenience for the wrappers. InsertTuple() which takes arrays can not be used from wrapped languages. These methods can be used instead.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.22 vtkDataArray
583
val3, double val4, double val5, double val6, double val7, double val8)
- These methods are included as convenience for the wrappers. InsertTuple() which takes arrays can not be
used from wrapped languages. These methods can be used instead.
obj.RemoveTuple (vtkIdType id) - These methods remove tuples from the data array. They shift
data and resize array, so the data array is still valid after this operation. Note, this operation is fairly slow.
obj.RemoveFirstTuple () - These methods remove tuples from the data array. They shift data and
resize array, so the data array is still valid after this operation. Note, this operation is fairly slow.
obj.RemoveLastTuple () - These methods remove tuples from the data array. They shift data and
resize array, so the data array is still valid after this operation. Note, this operation is fairly slow.
double = obj.GetComponent (vtkIdType i, int j) - Return the data component at the ith
tuple and jth component location. Note that i is less than NumberOfTuples and j is less than NumberOfComponents.
obj.SetComponent (vtkIdType i, int j, double c) - Set the data component at the ith
tuple and jth component location. Note that i is less than NumberOfTuples and j is less than NumberOfComponents. Make sure enough memory has been allocated (use SetNumberOfTuples() and SetNumberOfComponents()).
obj.InsertComponent (vtkIdType i, int j, double c) - Insert the data component at
ith tuple and jth component location. Note that memory allocation is performed as necessary to hold the data.
obj.GetData (vtkIdType tupleMin, vtkIdType tupleMax, int compMin, int
compMax, vtkDoubleArray data) - Get the data as a double array in the range (tupleMin,tupleMax)
and (compMin, compMax). The resulting double array consists of all data in the tuple range specified and
only the component range specified. This process typically requires casting the data from native form into
doubleing point values. This method is provided as a convenience for data exchange, and is not very fast.
obj.DeepCopy (vtkAbstractArray aa) - Deep copy of data. Copies data from different data
arrays even if they are different types (using doubleing-point exchange).
obj.DeepCopy (vtkDataArray da) - Deep copy of data. Copies data from different data arrays
even if they are different types (using doubleing-point exchange).
obj.FillComponent (int j, double c) - Fill a component of a data array with a specified value.
This method sets the specified component to specified value for all tuples in the data array. This methods can
be used to initialize or reinitialize a single component of a multi-component array.
obj.CopyComponent (int j, vtkDataArray from, int fromComponent) - Copy a
component from one data array into a component on this data array. This method copies the specified
component ("fromComponent") from the specified data array ("from") to the specified component ("j") over all
the tuples in this data array. This method can be used to extract a component (column) from one data array
and paste that data into a component on this data array.
long = obj.GetActualMemorySize () - Return the memory in kilobytes consumed by this data
array. Used to support streaming and reading/writing data. The value returned is guaranteed to be greater
than or equal to the memory required to actually represent the data represented by this object. The information returned is valid only after the pipeline has been updated.
obj.CreateDefaultLookupTable () - Create default lookup table. Generally used to create one
when none is available.
obj.SetLookupTable (vtkLookupTable lut) - Set/get the lookup table associated with this
scalar data, if any.
vtkLookupTable = obj.GetLookupTable () - Set/get the lookup table associated with this
scalar data, if any.
obj.GetRange (double range[2], int comp) - Return the range of the array values for the
given component. Range is copied into the array provided. If comp is equal to -1, it returns the range of the
magnitude (if the number of components is equal to 1 it still returns the range of component 0).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
584
31.23
vtkDataArrayCollection
31.23.1
Usage
vtkDataArrayCollection is an object that creates and manipulates lists of datasets. See also vtkCollection and
subclasses.
To create an instance of class vtkDataArrayCollection, simply invoke its constructor as follows
obj = vtkDataArrayCollection
31.23.2
Methods
The class vtkDataArrayCollection has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataArrayCollection
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataArrayCollection = obj.NewInstance ()
vtkDataArrayCollection = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkDataArray ds) - Get the next dataarray in the list.
vtkDataArray = obj.GetNextItem () - Get the next dataarray in the list.
vtkDataArray = obj.GetItem (int i) - Get the ith dataarray in the list.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.24 vtkDataArrayCollectionIterator
31.24
585
vtkDataArrayCollectionIterator
31.24.1
Usage
vtkDataArrayCollectionIterator provides an implementation of vtkCollectionIterator which allows the items to be retrieved with the proper subclass pointer type for vtkDataArrayCollection.
To create an instance of class vtkDataArrayCollectionIterator, simply invoke its constructor as follows
obj = vtkDataArrayCollectionIterator
31.24.2
Methods
The class vtkDataArrayCollectionIterator has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataArrayCollectionIterator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataArrayCollectionIterator = obj.NewInstance ()
vtkDataArrayCollectionIterator = obj.SafeDownCast (vtkObject o)
obj.SetCollection (vtkCollection ) - Set the collection over which to iterate.
obj.SetCollection (vtkDataArrayCollection ) - Set the collection over which to iterate.
vtkDataArray = obj.GetDataArray () - Get the item at the current iterator position. Valid only
when IsDoneWithTraversal() returns 1.
31.25
vtkDataArraySelection
31.25.1
Usage
vtkDataArraySelection can be used by vtkSource subclasses to store on/off settings for whether each vtkDataArray
in its input should be passed in the sources output. This is primarily intended to allow file readers to configure what
data arrays are read from the file.
To create an instance of class vtkDataArraySelection, simply invoke its constructor as follows
obj = vtkDataArraySelection
31.25.2
Methods
The class vtkDataArraySelection has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataArraySelection class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
586
31.26
vtkDebugLeaks
31.26.1
Usage
vtkDebugLeaks is used to report memory leaks at the exit of the program. It uses the vtkObjectFactory to intercept
the construction of all VTK objects. It uses the UnRegister method of vtkObject to intercept the destruction of all
objects. A table of object name to number of instances is kept. At the exit of the program if there are still VTK
objects around it will print them out. To enable this class add the flag -DVTK_DEBUG_LEAKS to the compile line,
and rebuild vtkObject and vtkObjectFactory.
To create an instance of class vtkDebugLeaks, simply invoke its constructor as follows
obj = vtkDebugLeaks
31.27 vtkDirectory
31.26.2
587
Methods
The class vtkDebugLeaks has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkDebugLeaks class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDebugLeaks = obj.NewInstance ()
vtkDebugLeaks = obj.SafeDownCast (vtkObject o)
31.27
vtkDirectory
31.27.1
Usage
vtkDirectory provides a portable way of finding the names of the files in a system directory. It also provides methods
of manipulating directories.
To create an instance of class vtkDirectory, simply invoke its constructor as follows
obj = vtkDirectory
31.27.2
Methods
The class vtkDirectory has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkDirectory class.
string = obj.GetClassName () - Return the class name as a string.
int = obj.IsA (string name) - Return the class name as a string.
vtkDirectory = obj.NewInstance () - Return the class name as a string.
vtkDirectory = obj.SafeDownCast (vtkObject o) - Return the class name as a string.
int = obj.Open (string dir) - Open the specified directory and load the names of the files in that
directory. 0 is returned if the directory can not be opened, 1 if it is opened.
vtkIdType = obj.GetNumberOfFiles () - Return the number of files in the current directory.
string = obj.GetFile (vtkIdType index) - Return the file at the given index, the indexing is
0 based
int = obj.FileIsDirectory (string name) - Return true if the file is a directory. If the file is
not an absolute path, it is assumed to be relative to the opened directory. If no directory has been opened, it
is assumed to be relative to the current working directory.
vtkStringArray = obj.GetFiles () - Get an array that contains all the file names.
31.28
vtkDoubleArray
588
31.28.1
Usage
vtkDoubleArray is an array of values of type double. It provides methods for insertion and retrieval of values and will
automatically resize itself to hold new data.
To create an instance of class vtkDoubleArray, simply invoke its constructor as follows
obj = vtkDoubleArray
31.28.2
Methods
The class vtkDoubleArray has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkDoubleArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDoubleArray = obj.NewInstance ()
vtkDoubleArray = obj.SafeDownCast (vtkObject o)
int = obj.GetDataType () - Copy the tuple value into a user-provided array.
obj.GetTupleValue (vtkIdType i, double tuple) - Set the tuple value at the ith location in
the array.
obj.SetTupleValue (vtkIdType i, double tuple) - Insert (memory allocation performed)
the tuple into the ith location in the array.
obj.InsertTupleValue (vtkIdType i, double tuple) - Insert (memory allocation performed) the tuple onto the end of the array.
vtkIdType = obj.InsertNextTupleValue (double tuple) - Get the data at a particular
index.
double = obj.GetValue (vtkIdType id) - Set the data at a particular index. Does not do range
checking. Make sure you use the method SetNumberOfValues() before inserting data.
obj.SetValue (vtkIdType id, double value) - Specify the number of values for this object
to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for
fast insertion.
obj.SetNumberOfValues (vtkIdType number) - Insert data at a specified position in the array.
obj.InsertValue (vtkIdType id, double f) - Insert data at the end of the array. Return its
location in the array.
vtkIdType = obj.InsertNextValue (double f) - Get the address of a particular data index.
Make sure data is allocated for the number of items requested. Set MaxId according to the number of data
values requested.
obj.SetArray (double array, vtkIdType size, int save) - This method lets the user
specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array
supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates
memory. The class uses the actual array provided; it does not copy the data from the suppled array.
obj.SetArray (double array, vtkIdType size, int save, int deleteMethod)
31.29
vtkDynamicLoader
31.30 vtkEdgeTable
31.29.1
589
Usage
31.29.2
Methods
The class vtkDynamicLoader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkDynamicLoader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDynamicLoader = obj.NewInstance ()
vtkDynamicLoader = obj.SafeDownCast (vtkObject o)
31.30
vtkEdgeTable
31.30.1
Usage
vtkEdgeTable is a general object for keeping track of lists of edges. An edge is defined by the pair of point ids
(p1,p2). Methods are available to insert edges, check if edges exist, and traverse the list of edges. Also, its possible
to associate attribute information with each edge. The attribute information may take the form of vtkIdType ids,
void pointers, or points. To store attributes, make sure that InitEdgeInsertion() is invoked with the storeAttributes
flag set properly. If points are inserted, use the methods InitPointInsertion() and InsertUniquePoint().
To create an instance of class vtkEdgeTable, simply invoke its constructor as follows
obj = vtkEdgeTable
31.30.2
Methods
The class vtkEdgeTable has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkEdgeTable class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkEdgeTable = obj.NewInstance ()
vtkEdgeTable = obj.SafeDownCast (vtkObject o)
obj.Initialize () - Free memory and return to the initially instantiated state.
int = obj.InitEdgeInsertion (vtkIdType numPoints, int storeAttributes) Initialize the edge insertion process. Provide an estimate of the number of points in a dataset (the maximum
range value of p1 or p2). The storeAttributes variable controls whether attributes are to be stored with
the edge, and what type of attributes. If storeAttributes==1, then attributes of vtkIdType can be stored. If
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
590
31.31
vtkExtentSplitter
31.31.1
Usage
vtkExtentSplitter splits each input extent into non-overlapping sub-extents that are completely contained within other
"source extents". A source extent corresponds to some resource providing an extent. Each source extent has an
integer identifier, integer priority, and an extent. The input extents are split into sub-extents according to priority,
availability, and amount of overlap of the source extents. This can be used by parallel data readers to read as few
piece files as possible.
To create an instance of class vtkExtentSplitter, simply invoke its constructor as follows
obj = vtkExtentSplitter
31.31.2
Methods
The class vtkExtentSplitter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkExtentSplitter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.32 vtkExtentTranslator
591
vtkExtentSplitter = obj.NewInstance ()
vtkExtentSplitter = obj.SafeDownCast (vtkObject o)
obj.AddExtentSource (int id, int priority, int x0, int x1, int y0, int
y1, int z0, int z1) - Add/Remove a source providing the given extent. Sources with higher priority
numbers are favored. Source id numbers and priorities must be non-negative.
obj.AddExtentSource (int id, int priority, int extent) - Add/Remove a source
providing the given extent. Sources with higher priority numbers are favored. Source id numbers and priorities must be non-negative.
obj.RemoveExtentSource (int id) - Add/Remove a source providing the given extent. Sources
with higher priority numbers are favored. Source id numbers and priorities must be non-negative.
obj.RemoveAllExtentSources () - Add/Remove a source providing the given extent. Sources with
higher priority numbers are favored. Source id numbers and priorities must be non-negative.
obj.AddExtent (int x0, int x1, int y0, int y1, int z0, int z1) - Add an extent to the queue of extents to be split among the available sources.
obj.AddExtent (int extent) - Add an extent to the queue of extents to be split among the available
sources.
int = obj.ComputeSubExtents () - Split the extents currently in the queue among the available
sources. The queue is empty when this returns. Returns 1 if all extents could be read. Returns 0 if any
portion of any extent was not available through any source.
int = obj.GetNumberOfSubExtents () - Get the number of sub-extents into which the original
set of extents have been split across the available sources. Valid after a call to ComputeSubExtents.
int = obj.GetSubExtent (int index) - Get the sub-extent associated with the given index. Use
GetSubExtentSource to get the id of the source from which this sub-extent should be read. Valid after a call
to ComputeSubExtents.
obj.GetSubExtent (int index, int extent) - Get the sub-extent associated with the given
index. Use GetSubExtentSource to get the id of the source from which this sub-extent should be read. Valid
after a call to ComputeSubExtents.
int = obj.GetSubExtentSource (int index) - Get the id of the source from which the subextent associated with the given index should be read. Returns -1 if no source provides the sub-extent.
int = obj.GetPointMode () - Get/Set whether "point mode" is on. In point mode, sub-extents are
generated to ensure every point in the update request is read, but not necessarily every cell. This can be
used when point data are stored in a planar slice per piece with no cell data. The default is OFF.
obj.SetPointMode (int ) - Get/Set whether "point mode" is on. In point mode, sub-extents are
generated to ensure every point in the update request is read, but not necessarily every cell. This can be
used when point data are stored in a planar slice per piece with no cell data. The default is OFF.
obj.PointModeOn () - Get/Set whether "point mode" is on. In point mode, sub-extents are generated
to ensure every point in the update request is read, but not necessarily every cell. This can be used when
point data are stored in a planar slice per piece with no cell data. The default is OFF.
obj.PointModeOff () - Get/Set whether "point mode" is on. In point mode, sub-extents are generated
to ensure every point in the update request is read, but not necessarily every cell. This can be used when
point data are stored in a planar slice per piece with no cell data. The default is OFF.
31.32
vtkExtentTranslator
592
31.32.1
Usage
vtkExtentTranslator generates a structured extent from an unstructured extent. It uses a recursive scheme that splits
the largest axis. A hard coded extent can be used for a starting point.
To create an instance of class vtkExtentTranslator, simply invoke its constructor as follows
obj = vtkExtentTranslator
31.32.2
Methods
The class vtkExtentTranslator has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkExtentTranslator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtentTranslator = obj.NewInstance ()
vtkExtentTranslator = obj.SafeDownCast (vtkObject o)
obj.SetWholeExtent (int , int , int , int , int , int ) - Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent
ivar.
obj.SetWholeExtent (int a[6]) - Set the Piece/NumPieces. Set the WholeExtent and then call
PieceToExtent. The result can be obtained from the Extent ivar.
int = obj. GetWholeExtent () - Set the Piece/NumPieces. Set the WholeExtent and then call
PieceToExtent. The result can be obtained from the Extent ivar.
obj.SetExtent (int , int , int , int , int , int ) - Set the Piece/NumPieces. Set
the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.
obj.SetExtent (int a[6]) - Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.
int = obj. GetExtent () - Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.
obj.SetPiece (int ) - Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent.
The result can be obtained from the Extent ivar.
int = obj.GetPiece () - Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.
obj.SetNumberOfPieces (int ) - Set the Piece/NumPieces. Set the WholeExtent and then call
PieceToExtent. The result can be obtained from the Extent ivar.
int = obj.GetNumberOfPieces () - Set the Piece/NumPieces. Set the WholeExtent and then call
PieceToExtent. The result can be obtained from the Extent ivar.
obj.SetGhostLevel (int ) - Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.
int = obj.GetGhostLevel () - Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.
int = obj.PieceToExtent () - These are the main methods that should be called. These methods
are responsible for converting a piece to an extent. The signatures without arguments are only thread safe
when each thread accesses a different instance. The signatures with arguements are fully thread safe.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.33 vtkFastNumericConversion
593
int = obj.PieceToExtentByPoints () - These are the main methods that should be called.
These methods are responsible for converting a piece to an extent. The signatures without arguments are
only thread safe when each thread accesses a different instance. The signatures with arguements are fully
thread safe.
int = obj.PieceToExtentThreadSafe (int piece, int numPieces, int ghost-
Level, int wholeExtent, int resultExtent, int splitMode, int byPoints) These are the main methods that should be called. These methods are responsible for converting a piece
to an extent. The signatures without arguments are only thread safe when each thread accesses a different
instance. The signatures with arguements are fully thread safe.
obj.SetSplitModeToBlock () - How should the streamer break up extents. Block mode tries to
break an extent up into cube blocks. It always chooses the largest axis to split. Slab mode first breaks up the
Z axis. If it gets to one slice, then it starts breaking up other axes.
obj.SetSplitModeToXSlab () - How should the streamer break up extents. Block mode tries to
break an extent up into cube blocks. It always chooses the largest axis to split. Slab mode first breaks up the
Z axis. If it gets to one slice, then it starts breaking up other axes.
obj.SetSplitModeToYSlab () - How should the streamer break up extents. Block mode tries to
break an extent up into cube blocks. It always chooses the largest axis to split. Slab mode first breaks up the
Z axis. If it gets to one slice, then it starts breaking up other axes.
obj.SetSplitModeToZSlab () - How should the streamer break up extents. Block mode tries to
break an extent up into cube blocks. It always chooses the largest axis to split. Slab mode first breaks up the
Z axis. If it gets to one slice, then it starts breaking up other axes.
int = obj.GetSplitMode () - How should the streamer break up extents. Block mode tries to break
an extent up into cube blocks. It always chooses the largest axis to split. Slab mode first breaks up the Z axis.
If it gets to one slice, then it starts breaking up other axes.
obj.SetSplitPath (int len, int splitpath)
31.33
vtkFastNumericConversion
31.33.1
Usage
vtkFastNumericConversion uses a portable (assuming IEEE format) method for converting single and double precision floating point values to a fixed point representation. This allows fast integer floor operations on platforms,
such as Intel X86, in which CPU floating point conversion algorithms are very slow. It is based on the techniques
described in Chris Heckers article, "Lets Get to the (Floating) Point", in Game Developer Magazine, Feb/Mar 1996,
and the techniques described in Michael Herfs website, http://www.stereopsis.com/FPU.html. The
Hecker article can be found at http://www.d6.com/users/checker/pdfs/gdmfp.pdf. Unfortunately,
each of these techniques is incomplete, and doesnt convert properly, in a way that depends on how many bits are
reserved for fixed point fractional use, due to failing to properly account for the default round-towards-even rounding
mode of the X86. Thus, my implementation incorporates some rounding correction that undoes the rounding that
the FPU performs during denormalization of the floating point value. Note that the rounding affect Im talking about
here is not the effect on the fistp instruction, but rather the effect that occurs during the denormalization of a value
that occurs when adding it to a much larger value. The bits must be shifted to the right, and when a "1" bit falls
off the edge, the rounding mode determines what happens next, in order to avoid completely "losing" the 1-bit.
Furthermore, my implementation works on Linux, where the default precision mode is 64-bit extended precision.
To create an instance of class vtkFastNumericConversion, simply invoke its constructor as follows
obj = vtkFastNumericConversion
594
31.33.2
Methods
The class vtkFastNumericConversion has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkFastNumericConversion
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkFastNumericConversion = obj.NewInstance ()
vtkFastNumericConversion = obj.SafeDownCast (vtkObject o)
int = obj.TestQuickFloor (double val) - Wrappable method for script-testing of correct
cross-platform functionality
int = obj.TestSafeFloor (double val) - Wrappable method for script-testing of correct crossplatform functionality
int = obj.TestRound (double val) - Wrappable method for script-testing of correct crossplatform functionality
int = obj.TestConvertFixedPointIntPart (double val) - Wrappable method for scripttesting of correct cross-platform functionality
int = obj.TestConvertFixedPointFracPart (double val) - Wrappable method for
script-testing of correct cross-platform functionality
obj.SetReservedFracBits (int bits) - Set the number of bits reserved for fractional precision
that are maintained as part of the flooring process. This number affects the flooring arithmetic. It may be
useful if the factional part is to be used to index into a lookup table of some sort. However, if you are only
interested in knowing the fractional remainder after flooring, there doesnt appear to be any advantage to
using these bits, either in terms of a lookup table, or by directly multiplying by some unit fraction, over simply
subtracting the floored value from the original value. Note that since only 32 bits are used for the entire fixed
point representation, increasing the number of reserved fractional bits reduces the range of integer values
that can be floored to. Add one to the requested number of fractional bits, to make the conversion safe with
respect to rounding mode. This is the same as the difference between QuickFloor and SafeFloor.
obj.PerformanceTests (void ) - Conduct timing tests so that the usefulness of this class can be
ascertained on whatever platform it is being used. Output can be retrieved via Print method.
31.34
vtkFileOutputWindow
31.34.1
Usage
Writes debug/warning/error output to a log file instead of the console. To use this class, instantiate it and then call
SetInstance(this).
To create an instance of class vtkFileOutputWindow, simply invoke its constructor as follows
obj = vtkFileOutputWindow
31.35 vtkFloatArray
31.34.2
595
Methods
The class vtkFileOutputWindow has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkFileOutputWindow class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkFileOutputWindow = obj.NewInstance ()
vtkFileOutputWindow = obj.SafeDownCast (vtkObject o)
obj.DisplayText (string ) - Put the text into the log file. New lines are converted to carriage return
new lines.
obj.SetFileName (string ) - Sets the name for the log file.
string = obj.GetFileName () - Sets the name for the log file.
obj.SetFlush (int ) - Turns on buffer flushing for the output to the log file.
int = obj.GetFlush () - Turns on buffer flushing for the output to the log file.
obj.FlushOn () - Turns on buffer flushing for the output to the log file.
obj.FlushOff () - Turns on buffer flushing for the output to the log file.
obj.SetAppend (int ) - Setting append will cause the log file to be opened in append mode. Otherwise, if the log file exists, it will be overwritten each time the vtkFileOutputWindow is created.
int = obj.GetAppend () - Setting append will cause the log file to be opened in append mode.
Otherwise, if the log file exists, it will be overwritten each time the vtkFileOutputWindow is created.
obj.AppendOn () - Setting append will cause the log file to be opened in append mode. Otherwise, if
the log file exists, it will be overwritten each time the vtkFileOutputWindow is created.
obj.AppendOff () - Setting append will cause the log file to be opened in append mode. Otherwise, if
the log file exists, it will be overwritten each time the vtkFileOutputWindow is created.
31.35
vtkFloatArray
31.35.1
Usage
vtkFloatArray is an array of values of type float. It provides methods for insertion and retrieval of values and will
automatically resize itself to hold new data.
To create an instance of class vtkFloatArray, simply invoke its constructor as follows
obj = vtkFloatArray
31.35.2
Methods
The class vtkFloatArray has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkFloatArray class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
596
31.36
vtkFunctionParser
31.36.1
Usage
vtkFunctionParser is a class that takes in a mathematical expression as a char string, parses it, and evaluates it at
the specified values of the variables in the input string.
You can use the "if" operator to create conditional expressions such as if ( test, trueresult, falseresult). These
evaluate the boolean valued test expression and then evaluate either the trueresult or the falseresult expression to
produce a final (scalar or vector valued) value. "test" may contain <,>,=,|,&, and () and all three subexpressions
can evaluate arbitrary function operators (ln, cos, +, if, etc)
.SECTION Thanks Thomas Dunne (thomas.dunne@iwr.uni-heidelberg.de) for adding code for twoparameter-parsing and a few functions (sign, min, max).
Sid Sydoriak (sxs@lanl.gov) for adding boolean operations and conditional expressions and for fixing a variety
of bugs.
To create an instance of class vtkFunctionParser, simply invoke its constructor as follows
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.36 vtkFunctionParser
597
obj = vtkFunctionParser
31.36.2
Methods
The class vtkFunctionParser has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkFunctionParser class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkFunctionParser = obj.NewInstance ()
vtkFunctionParser = obj.SafeDownCast (vtkObject o)
obj.SetFunction (string function)
string = obj.GetFunction ()
int = obj.IsScalarResult () - Check whether the result is a scalar result. If it isnt, then either
the result is a vector or an error has occurred.
int = obj.IsVectorResult () - Check whether the result is a vector result. If it isnt, then either
the result is scalar or an error has occurred.
double = obj.GetScalarResult () - Get a scalar result from evaluating the input function.
double = obj.GetVectorResult () - Get a vector result from evaluating the input function.
obj.GetVectorResult (double result[3]) - Get a vector result from evaluating the input function.
obj.SetScalarVariableValue (string variableName, double value) - Set the value
of a scalar variable. If a variable with this name exists, then its value will be set to the new value. If there is
not already a variable with this name, variableName will be added to the list of variables, and its value will be
set to the new value.
obj.SetScalarVariableValue (int i, double value) - Set the value of a scalar variable.
If a variable with this name exists, then its value will be set to the new value. If there is not already a variable
with this name, variableName will be added to the list of variables, and its value will be set to the new value.
double = obj.GetScalarVariableValue (string variableName) - Get the value of a
scalar variable.
double = obj.GetScalarVariableValue (int i) - Get the value of a scalar variable.
obj.SetVectorVariableValue (string variableName, double xValue, double
yValue, double zValue) - Set the value of a vector variable. If a variable with this name exists, then
its value will be set to the new value. If there is not already a variable with this name, variableName will be
added to the list of variables, and its value will be set to the new value.
obj.SetVectorVariableValue (string variableName, double values[3]) - Set
the value of a vector variable. If a variable with this name exists, then its value will be set to the new value.
If there is not already a variable with this name, variableName will be added to the list of variables, and its
value will be set to the new value.
obj.SetVectorVariableValue (int i, double xValue, double yValue, double
zValue) - Set the value of a vector variable. If a variable with this name exists, then its value will be set
to the new value. If there is not already a variable with this name, variableName will be added to the list of
variables, and its value will be set to the new value.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
598
31.37
vtkFunctionSet
31.38 vtkGarbageCollector
31.37.1
599
Usage
vtkFunctionSet specifies an abstract interface for set of functions of the form F_i = F_i(x_j) where F (with i=1..m)
are the functions and x (with j=1..n) are the independent variables. The only supported operation is the function
evaluation at x_j.
To create an instance of class vtkFunctionSet, simply invoke its constructor as follows
obj = vtkFunctionSet
31.37.2
Methods
The class vtkFunctionSet has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkFunctionSet class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkFunctionSet = obj.NewInstance ()
vtkFunctionSet = obj.SafeDownCast (vtkObject o)
int = obj.FunctionValues (double x, double f) - Evaluate functions at x_j. x and f have
to point to valid double arrays of appropriate sizes obtained with GetNumberOfFunctions() and GetNumberOfIndependentVariables.
int = obj.GetNumberOfFunctions () - Return the number of independent variables. Note that
this is constant for a given type of set of functions and can not be changed at run time.
int = obj.GetNumberOfIndependentVariables ()
31.38
vtkGarbageCollector
31.38.1
Usage
vtkGarbageCollector is used by VTK classes that may be involved in reference counting loops (such as Algorithm
<-> Executive). It detects strongly connected components of the reference graph that have been leaked deletes
them. The garbage collector uses the ReportReferences method to search the reference graph and construct a net
reference count for each connected component. If the net reference count is zero the entire set of objects is deleted.
Deleting each component may leak other components, which are then collected recursively.
To enable garbage collection for a class, add these members:
public:
virtual void Register(vtkObjectBase* o)
{
this->RegisterInternal(o, 1);
}
virtual void UnRegister(vtkObjectBase* o)
{
this->UnRegisterInternal(o, 1);
}
protected:
virtual void ReportReferences(vtkGarbageCollector* collector)
{
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
600
The implementations should be in the .cxx file in practice. It is important that the reference be reported using the
real pointer or smart pointer instance that holds the reference. When collecting the garbage collector will actually
set this pointer to NULL. The destructor of the class should be written to deal with this. It is also expected that an
invariant is maintained for any reference that is reported. The variable holding the reference must always either
be NULL or refer to a fully constructed valid object. Therefore code like "this->Object->UnRegister(this)" must be
avoided if "this->Object" is a reported reference because it is possible that the object is deleted before UnRegister
returns but then "this->Object" will be left as a dangling pointer. Instead use code like
vtkObjectBase* obj = this->Object;
this->Object = 0;
obj->UnRegister(this);
31.38.2
Methods
The class vtkGarbageCollector has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGarbageCollector class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGarbageCollector = obj.NewInstance ()
vtkGarbageCollector = obj.SafeDownCast (vtkObject o)
31.39
vtkGaussianRandomSequence
31.39.1
Usage
vtkGaussianRandomSequence is a sequence of pseudo random numbers distributed according to the Gaussian/normal distribution (mean=0 and standard deviation=1)
This is just an interface.
To create an instance of class vtkGaussianRandomSequence, simply invoke its constructor as follows
obj = vtkGaussianRandomSequence
31.40 vtkGeneralTransform
31.39.2
601
Methods
The class vtkGaussianRandomSequence has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGaussianRandomSequence class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGaussianRandomSequence = obj.NewInstance ()
vtkGaussianRandomSequence = obj.SafeDownCast (vtkObject o)
double = obj.GetScaledValue (double mean, double standardDeviation) - Convenient method to return a value given the mean and standard deviation of the Gaussian distribution from the
the Gaussian distribution of mean=0 and standard deviation=1.0. There is an initial implementation that can
be overridden by a subclass.
31.40
vtkGeneralTransform
31.40.1
Usage
vtkGeneralTransform is like vtkTransform and vtkPerspectiveTransform, but it will work with any vtkAbstractTransform as input. It is not as efficient as the other two, however, because arbitrary transformations cannot be
concatenated by matrix multiplication. Transform concatenation is simulated by passing each input point through
each transform in turn.
To create an instance of class vtkGeneralTransform, simply invoke its constructor as follows
obj = vtkGeneralTransform
31.40.2
Methods
The class vtkGeneralTransform has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGeneralTransform class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeneralTransform = obj.NewInstance ()
vtkGeneralTransform = obj.SafeDownCast (vtkObject o)
obj.Identity () - Set this transformation to the identity transformation. If the transform has an Input,
then the transformation will be reset so that it is the same as the Input.
obj.Inverse () - Invert the transformation. This will also set a flag so that the transformation will use
the inverse of its Input, if an Input has been set.
obj.Translate (double x, double y, double z) - Create a translation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.
obj.Translate (double x[3]) - Create a translation matrix and concatenate it with the current
transformation according to PreMultiply or PostMultiply semantics.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
602
31.41 vtkHeap
603
vtkAbstractTransform = obj.GetInput () - Set the input for this transformation. This will be
used as the base transformation if it is set. This method allows you to build a transform pipeline: if the input is
modified, then this transformation will automatically update accordingly. Note that the InverseFlag, controlled
via Inverse(), determines whether this transformation will use the Input or the inverse of the Input.
int = obj.GetInverseFlag () - Get the inverse flag of the transformation. This controls whether
it is the Input or the inverse of the Input that is used as the base transformation. The InverseFlag is flipped
every time Inverse() is called. The InverseFlag is off when a transform is first created.
obj.Push () - Pushes the current transformation onto the transformation stack.
obj.Pop () - Deletes the transformation on the top of the stack and sets the top to the next transformation
on the stack.
obj.InternalTransformPoint (float in[3], float out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformPoint (double in[3], double out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
int = obj.CircuitCheck (vtkAbstractTransform transform) - Check for selfreference. Will return true if concatenating with the specified transform, setting it to be our inverse, or
setting it to be our input will create a circular reference. CircuitCheck is automatically called by SetInput(),
SetInverse(), and Concatenate(vtkXTransform ). Avoid using this function, it is experimental.
vtkAbstractTransform = obj.MakeTransform () - Make another transform of the same type.
long = obj.GetMTime () - Override GetMTime to account for input and concatenation.
31.41
vtkHeap
31.41.1
Usage
This class is a replacement for malloc/free and new/delete for software that has inherent memory leak or performance problems. For example, external software such as the PLY library (vtkPLY) and VRML importer (vtkVRMLImporter) are often written with lots of malloc() calls but without the corresponding free() invocations. The class
vtkOrderedTriangulator may create and delete millions of new/delete calls. This class allows the overloading of the
C++ new operator (or other memory allocation requests) by using the method AllocateMemory(). Memory is deleted
with an invocation of CleanAll() (which deletes ALL memory; any given memory allocation cannot be deleted). Note:
a block size can be used to control the size of each memory allocation. Requests for memory are fulfilled from the
block until the block runs out, then a new block is created.
To create an instance of class vtkHeap, simply invoke its constructor as follows
obj = vtkHeap
31.41.2
Methods
The class vtkHeap has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkHeap class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHeap = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
604
31.42
vtkHomogeneousTransform
31.42.1
Usage
31.42.2
Methods
The class vtkHomogeneousTransform has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHomogeneousTransform
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHomogeneousTransform = obj.NewInstance ()
vtkHomogeneousTransform = obj.SafeDownCast (vtkObject o)
obj.TransformPoints (vtkPoints inPts, vtkPoints outPts) - Apply the transformation to a series of points, and append the results to outPts.
obj.TransformPointsNormalsVectors (vtkPoints inPts, vtkPoints outPts,
vtkDataArray inNms, vtkDataArray outNms, vtkDataArray inVrs, vtkDataArray outVrs) - Apply the transformation to a combination of points, normals and vectors.
obj.GetMatrix (vtkMatrix4x4 m) - Get a copy of the internal transformation matrix. The transform is Updated first, to guarantee that the matrix is valid.
vtkMatrix4x4 = obj.GetMatrix () - Get a pointer to an internal vtkMatrix4x4 that represents the
transformation. An Update() is called on the transform to ensure that the matrix is up-to-date when you get it.
You should not store the matrix pointer anywhere because it might become stale.
vtkHomogeneousTransform = obj.GetHomogeneousInverse () - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformPoint (float in[3], float out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformPoint (double in[3], double out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.43 vtkIdentityTransform
31.43
605
vtkIdentityTransform
31.43.1
Usage
vtkIdentityTransform is a transformation which will simply pass coordinate data unchanged. All other transform types
can also do this, however, the vtkIdentityTransform does so with much greater efficiency.
To create an instance of class vtkIdentityTransform, simply invoke its constructor as follows
obj = vtkIdentityTransform
31.43.2
Methods
The class vtkIdentityTransform has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkIdentityTransform class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkIdentityTransform = obj.NewInstance ()
vtkIdentityTransform = obj.SafeDownCast (vtkObject o)
obj.TransformPoints (vtkPoints inPts, vtkPoints outPts) - Apply the transformation to a series of points, and append the results to outPts.
obj.TransformNormals (vtkDataArray inNms, vtkDataArray outNms) - Apply the
transformation to a series of normals, and append the results to outNms.
obj.TransformVectors (vtkDataArray inVrs, vtkDataArray outVrs) - Apply the
transformation to a series of vectors, and append the results to outVrs.
obj.TransformPointsNormalsVectors (vtkPoints inPts, vtkPoints outPts,
vtkDataArray inNms, vtkDataArray outNms, vtkDataArray inVrs, vtkDataArray outVrs) - Apply the transformation to a combination of points, normals and vectors.
obj.Inverse ()
obj.InternalTransformPoint (float in[3], float out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformPoint (double in[3], double out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformNormal (float in[3], float out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformNormal (double in[3], double out[3]) - This will calculate
the transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformVector (float in[3], float out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformVector (double in[3], double out[3]) - This will calculate
the transformation without calling Update. Meant for use only within other VTK classes.
vtkAbstractTransform = obj.MakeTransform () - Make a transform of the same type. This
will actually return the same transform.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
606
31.44
vtkIdList
31.44.1
Usage
vtkIdList is used to represent and pass data ids between objects. vtkIdList may represent any type of integer id, but
usually represents point and cell ids.
To create an instance of class vtkIdList, simply invoke its constructor as follows
obj = vtkIdList
31.44.2
Methods
The class vtkIdList has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkIdList class.
obj.Initialize ()
int = obj.Allocate (vtkIdType sz, int strategy)
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkIdList = obj.NewInstance ()
vtkIdList = obj.SafeDownCast (vtkObject o)
vtkIdType = obj.GetNumberOfIds () - Return the number of ids in the list.
vtkIdType = obj.GetId (vtkIdType i) - Return the id at location i.
obj.SetNumberOfIds (vtkIdType number) - Specify the number of ids for this object to hold.
Does an allocation as well as setting the number of ids.
obj.SetId (vtkIdType i, vtkIdType vtkid) - Set the id at location i. Doesnt do range
checking so its a bit faster than InsertId. Make sure you use SetNumberOfIds() to allocate memory prior
to using SetId().
obj.InsertId (vtkIdType i, vtkIdType vtkid) - Set the id at location i. Does range checking and allocates memory as necessary.
vtkIdType = obj.InsertNextId (vtkIdType vtkid) - Add the id specified to the end of the
list. Range checking is performed.
vtkIdType = obj.InsertUniqueId (vtkIdType vtkid) - If id is not already in list, insert it
and return location in list. Otherwise return just location in list.
vtkIdType = obj.GetPointer (vtkIdType i) - Get a pointer to a particular data index.
vtkIdType = obj.WritePointer (vtkIdType i, vtkIdType number) - Get a pointer to
a particular data index. Make sure data is allocated for the number of items requested. Set MaxId according
to the number of data values requested.
obj.Reset () - Reset to an empty state.
obj.Squeeze () - Free any unused memory.
obj.DeepCopy (vtkIdList ids) - Copy an id list by explicitly copying the internal array.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.45 vtkIdListCollection
607
obj.DeleteId (vtkIdType vtkid) - Delete specified id from list. Will remove all occurrences of id
in list.
vtkIdType = obj.IsId (vtkIdType vtkid) - Return -1 if id specified is not contained in the list;
otherwise return the position in the list.
obj.IntersectWith (vtkIdList &otherIds) - Intersect this list with another vtkIdList. Updates
current list according to result of intersection operation.
31.45
vtkIdListCollection
31.45.1
Usage
vtkIdListCollection is an object that creates and manipulates lists of datasets. See also vtkCollection and subclasses.
To create an instance of class vtkIdListCollection, simply invoke its constructor as follows
obj = vtkIdListCollection
31.45.2
Methods
The class vtkIdListCollection has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkIdListCollection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkIdListCollection = obj.NewInstance ()
vtkIdListCollection = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkIdList ds) - Get the next dataset in the list.
vtkIdList = obj.GetNextItem () - Get the next dataset in the list.
vtkIdList = obj.GetItem (int i) - Get the ith dataset in the list.
31.46
vtkIdTypeArray
31.46.1
Usage
vtkIdTypeArray is an array of values of type vtkIdType. It provides methods for insertion and retrieval of values and
will automatically resize itself to hold new data.
To create an instance of class vtkIdTypeArray, simply invoke its constructor as follows
obj = vtkIdTypeArray
608
31.46.2
Methods
The class vtkIdTypeArray has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkIdTypeArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkIdTypeArray = obj.NewInstance ()
vtkIdTypeArray = obj.SafeDownCast (vtkObject o)
int = obj.GetDataType () - Copy the tuple value into a user-provided array.
vtkIdType = obj.GetValue (vtkIdType id) - Set the data at a particular index. Does not do
range checking. Make sure you use the method SetNumberOfValues() before inserting data.
obj.SetValue (vtkIdType id, vtkIdType value) - Specify the number of values for this object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method
for fast insertion.
obj.SetNumberOfValues (vtkIdType number) - Insert data at a specified position in the array.
obj.InsertValue (vtkIdType id, vtkIdType f) - Insert data at the end of the array. Return
its location in the array.
vtkIdType = obj.InsertNextValue (vtkIdType f) - Get the address of a particular data
index. Make sure data is allocated for the number of items requested. Set MaxId according to the number of
data values requested.
vtkIdType = obj.WritePointer (vtkIdType id, vtkIdType number) - Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc.
vtkIdType = obj.GetPointer (vtkIdType id) - This method lets the user specify data to be
held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the
user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The
class uses the actual array provided; it does not copy the data from the suppled array.
31.47
vtkImplicitFunction
31.47.1
Usage
vtkImplicitFunction specifies an abstract interface for implicit functions. Implicit functions are real valued functions
defined in 3D space, w = F(x,y,z). Two primitive operations are required: the ability to evaluate the function, and the
function gradient at a given point. The implicit function divides space into three regions: on the surface (F(x,y,z)=w),
outside of the surface (F(x,y,z)>c), and inside the surface (F(x,y,z)<c). (When c is zero, positive values are outside,
negative values are inside, and zero is on the surface. Note also that the function gradient points from inside to
outside.)
Implicit functions are very powerful. It is possible to represent almost any type of geometry with the level sets w =
const, especially if you use boolean combinations of implicit functions (see vtkImplicitBoolean).
vtkImplicitFunction provides a mechanism to transform the implicit function(s) via a vtkAbstractTransform. This
capability can be used to translate, orient, scale, or warp implicit functions. For example, a sphere implicit function
can be transformed into an oriented ellipse.
To create an instance of class vtkImplicitFunction, simply invoke its constructor as follows
obj = vtkImplicitFunction
31.48 vtkImplicitFunctionCollection
31.47.2
609
Methods
The class vtkImplicitFunction has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImplicitFunction class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImplicitFunction = obj.NewInstance ()
vtkImplicitFunction = obj.SafeDownCast (vtkObject o)
long = obj.GetMTime () - Overload standard modified time function. If Transform is modified, then
this object is modified as well.
double = obj.FunctionValue (double x[3]) - Evaluate function at position x-y-z and return
value. Point x[3] is transformed through transform (if provided).
double = obj.FunctionValue (double x, double y, double z) - Evaluate function at
position x-y-z and return value. Point x[3] is transformed through transform (if provided).
obj.FunctionGradient (double x[3], double g[3]) - Evaluate function gradient at position x-y-z and pass back vector. Point x[3] is transformed through transform (if provided).
double = obj.FunctionGradient (double x[3]) - Evaluate function gradient at position x-yz and pass back vector. Point x[3] is transformed through transform (if provided).
double = obj.FunctionGradient (double x, double y, double z) - Evaluate function gradient at position x-y-z and pass back vector. Point x[3] is transformed through transform (if provided).
obj.SetTransform (vtkAbstractTransform ) - Set/Get a transformation to apply to input
points before executing the implicit function.
obj.SetTransform (double elements[16]) - Set/Get a transformation to apply to input points
before executing the implicit function.
vtkAbstractTransform = obj.GetTransform () - Set/Get a transformation to apply to input
points before executing the implicit function.
double = obj.EvaluateFunction (double x[3]) - Evaluate function at position x-y-z and return value. You should generally not call this method directly, you should use FunctionValue() instead. This
method must be implemented by any derived class.
double = obj.EvaluateFunction (double x, double y, double z) - Evaluate function at position x-y-z and return value. You should generally not call this method directly, you should use
FunctionValue() instead. This method must be implemented by any derived class.
obj.EvaluateGradient (double x[3], double g[3]) - Evaluate function gradient at position x-y-z and pass back vector. You should generally not call this method directly, you should use FunctionGradient() instead. This method must be implemented by any derived class.
31.48
vtkImplicitFunctionCollection
31.48.1
Usage
vtkImplicitFunctionCollection is an object that creates and manipulates lists of objects of type vtkImplicitFunction.
To create an instance of class vtkImplicitFunctionCollection, simply invoke its constructor as follows
obj = vtkImplicitFunctionCollection
610
31.48.2
Methods
The class vtkImplicitFunctionCollection has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImplicitFunctionCollection
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImplicitFunctionCollection = obj.NewInstance ()
vtkImplicitFunctionCollection = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkImplicitFunction ) - Add an implicit function to the list.
vtkImplicitFunction = obj.GetNextItem () - Get the next implicit function in the list.
31.49
vtkInformation
31.49.1
Usage
vtkInformation represents information and/or data for one input or one output of a vtkAlgorithm. It maps from keys
to values of several data types. Instances of this class are collected in vtkInformationVector instances and passed
to vtkAlgorithm::ProcessRequest calls. The information and data referenced by the instance on a particular input or
output define the request made to the vtkAlgorithm instance.
To create an instance of class vtkInformation, simply invoke its constructor as follows
obj = vtkInformation
31.49.2
Methods
The class vtkInformation has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkInformation class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformation = obj.NewInstance ()
vtkInformation = obj.SafeDownCast (vtkObject o)
obj.Modified () - Modified signature with no arguments that calls Modified on vtkObject superclass.
obj.Modified (vtkInformationKey key) - Modified signature that takes an information key as
an argument. Sets the new MTime and invokes a modified event with the information key as call data.
obj.Clear () - Clear all information entries.
int = obj.GetNumberOfKeys () - Return the number of keys in this information object (as would
be returned by iterating over the keys).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.49 vtkInformation
611
obj.Copy (vtkInformation from, int deep) - Copy all information entries from the given vtkInformation instance. Any previously existing entries are removed. If deep==1, a deep copy of the information
structure is performed (new instances of any contained vtkInformation and vtkInformationVector objects are
created).
obj.CopyEntry (vtkInformation from, vtkInformationKey key, int deep)
Copy the key/value pair associated with the given key in the given information object. If deep=1, a
deep copy of the information structure is performed (new instances of any contained vtkInformation and
vtkInformationVector objects are created).
obj.CopyEntry (vtkInformation from, vtkInformationDataObjectKey key,
int deep) - Copy the key/value pair associated with the given key in the given information object. If
deep=1, a deep copy of the information structure is performed (new instances of any contained vtkInformation
and vtkInformationVector objects are created).
obj.CopyEntry (vtkInformation from, vtkInformationDoubleVectorKey key,
int deep) - Copy the key/value pair associated with the given key in the given information object. If
deep=1, a deep copy of the information structure is performed (new instances of any contained vtkInformation
and vtkInformationVector objects are created).
obj.CopyEntry (vtkInformation from, vtkInformationInformationKey key,
int deep) - Copy the key/value pair associated with the given key in the given information object. If
deep=1, a deep copy of the information structure is performed (new instances of any contained vtkInformation
and vtkInformationVector objects are created).
obj.CopyEntry (vtkInformation from, vtkInformationInformationVectorKey
key, int deep) - Copy the key/value pair associated with the given key in the given information object. If deep=1, a deep copy of the information structure is performed (new instances of any contained
vtkInformation and vtkInformationVector objects are created).
obj.CopyEntry (vtkInformation from, vtkInformationIntegerKey key, int
deep) - Copy the key/value pair associated with the given key in the given information object. If deep=1,
a deep copy of the information structure is performed (new instances of any contained vtkInformation and
vtkInformationVector objects are created).
obj.CopyEntry (vtkInformation from, vtkInformationIntegerVectorKey key,
int deep) - Copy the key/value pair associated with the given key in the given information object. If
deep=1, a deep copy of the information structure is performed (new instances of any contained vtkInformation
and vtkInformationVector objects are created).
obj.CopyEntry (vtkInformation from, vtkInformationRequestKey key, int
deep) - Copy the key/value pair associated with the given key in the given information object. If deep=1,
a deep copy of the information structure is performed (new instances of any contained vtkInformation and
vtkInformationVector objects are created).
obj.CopyEntry (vtkInformation from, vtkInformationStringKey key, int
deep) - Copy the key/value pair associated with the given key in the given information object. If deep=1,
a deep copy of the information structure is performed (new instances of any contained vtkInformation and
vtkInformationVector objects are created).
obj.CopyEntry (vtkInformation from, vtkInformationStringVectorKey key,
int deep) - Copy the key/value pair associated with the given key in the given information object. If
deep=1, a deep copy of the information structure is performed (new instances of any contained vtkInformation
and vtkInformationVector objects are created).
obj.CopyEntry (vtkInformation from, vtkInformationUnsignedLongKey key,
int deep) - Copy the key/value pair associated with the given key in the given information object. If
deep=1, a deep copy of the information structure is performed (new instances of any contained vtkInformation
and vtkInformationVector objects are created).
obj.CopyEntries (vtkInformation from, vtkInformationKeyVectorKey key,
int deep) - Use the given key to lookup a list of other keys in the given information object. The
key/value pairs associated with these other keys will be copied. If deep==1, a deep copy of the information
structure is performed.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
612
Get/Set
an
31.49 vtkInformation
obj.Append (vtkInformationStringVectorKey key, string value)
string-vector-valued entry.
613
-
Get/Set
obj.Set (vtkInformationStringVectorKey key, string value, int idx) - Get/Set a string-vector-valued entry.
string = obj.Get (vtkInformationStringVectorKey key, int idx) - Get/Set a
string-vector-valued entry.
int = obj.Length (vtkInformationStringVectorKey key) - Get/Set a string-vectorvalued entry.
obj.Remove (vtkInformationStringVectorKey key) - Get/Set a string-vector-valued entry.
int = obj.Has (vtkInformationStringVectorKey key) - Get/Set a string-vector-valued
entry.
obj.Set (vtkInformationIntegerPointerKey key, int value, int length)
Get/Set an integer-pointer-valued entry.
614
31.50 vtkInformationDataObjectKey
615
31.50
vtkInformationDataObjectKey
31.50.1
Usage
vtkInformationDataObjectKey is used to represent keys in vtkInformation for values that are vtkDataObject instances.
To create an instance of class vtkInformationDataObjectKey, simply invoke its constructor as follows
obj = vtkInformationDataObjectKey
31.50.2
Methods
The class vtkInformationDataObjectKey has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationDataObjectKey
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationDataObjectKey = obj.NewInstance ()
vtkInformationDataObjectKey = obj.SafeDownCast (vtkObject o)
vtkInformationDataObjectKey = obj.(string name, string location)
vtkInformationDataObjectKey = obj.()
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
obj.Report (vtkInformation info, vtkGarbageCollector collector) - Report a
reference this key has in the given information object.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
616
31.51
vtkInformationDoubleKey
31.51.1
Usage
31.51.2
Methods
The class vtkInformationDoubleKey has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationDoubleKey
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationDoubleKey = obj.NewInstance ()
vtkInformationDoubleKey = obj.SafeDownCast (vtkObject o)
vtkInformationDoubleKey = obj.(string name, string location)
vtkInformationDoubleKey = obj.()
obj.Set (vtkInformation info, double ) - Get/Set the value associated with this key in the
given information object.
double = obj.Get (vtkInformation info) - Get/Set the value associated with this key in the
given information object.
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
31.52
vtkInformationDoubleVectorKey
31.52.1
Usage
31.53 vtkInformationIdTypeKey
31.52.2
617
Methods
The class vtkInformationDoubleVectorKey has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationDoubleVectorKey class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationDoubleVectorKey = obj.NewInstance ()
vtkInformationDoubleVectorKey = obj.SafeDownCast (vtkObject o)
vtkInformationDoubleVectorKey = obj.(string name, string location, int
length)
vtkInformationDoubleVectorKey = obj.()
obj.Append (vtkInformation info, double value) - Get/Set the value associated with this
key in the given information object.
obj.Set (vtkInformation info, double value, int length) - Get/Set the value associated with this key in the given information object.
double = obj.Get (vtkInformation info, int idx) - Get/Set the value associated with
this key in the given information object.
obj.Get (vtkInformation info, double value) - Get/Set the value associated with this key
in the given information object.
int = obj.Length (vtkInformation info) - Get/Set the value associated with this key in the
given information object.
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
31.53
vtkInformationIdTypeKey
31.53.1
Usage
31.53.2
Methods
The class vtkInformationIdTypeKey has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationIdTypeKey
class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
618
31.54
vtkInformationInformationKey
31.54.1
Usage
31.54.2
Methods
The class vtkInformationInformationKey has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationInformationKey
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationInformationKey = obj.NewInstance ()
vtkInformationInformationKey = obj.SafeDownCast (vtkObject o)
vtkInformationInformationKey = obj.(string name, string location)
vtkInformationInformationKey = obj.()
obj.Set (vtkInformation info, vtkInformation ) - Get/Set the value associated with this
key in the given information object.
vtkInformation = obj.Get (vtkInformation info) - Get/Set the value associated with this
key in the given information object.
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
obj.DeepCopy (vtkInformation from, vtkInformation to) - Duplicate (new instance
created) the entry associated with this key from one information object to another (new instances of any
contained vtkInformation and vtkInformationVector objects are created).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.55 vtkInformationInformationVectorKey
31.55
619
vtkInformationInformationVectorKey
31.55.1
Usage
31.55.2
Methods
The class vtkInformationInformationVectorKey has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationInformationVectorKey class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationInformationVectorKey = obj.NewInstance ()
vtkInformationInformationVectorKey = obj.SafeDownCast (vtkObject o)
vtkInformationInformationVectorKey = obj.(string name, string location)
vtkInformationInformationVectorKey = obj.()
obj.Set (vtkInformation info, vtkInformationVector ) - Get/Set the value associated with this key in the given information object.
vtkInformationVector = obj.Get (vtkInformation info) - Get/Set the value associated with this key in the given information object.
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
obj.DeepCopy (vtkInformation from, vtkInformation to) - Duplicate (new instance
created) the entry associated with this key from one information object to another (new instances of any
contained vtkInformation and vtkInformationVector objects are created).
obj.Report (vtkInformation info, vtkGarbageCollector collector) - Report a
reference this key has in the given information object.
31.56
vtkInformationIntegerKey
31.56.1
Usage
620
31.56.2
Methods
The class vtkInformationIntegerKey has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationIntegerKey
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationIntegerKey = obj.NewInstance ()
vtkInformationIntegerKey = obj.SafeDownCast (vtkObject o)
vtkInformationIntegerKey = obj.(string name, string location)
vtkInformationIntegerKey = obj.()
obj.Set (vtkInformation info, int ) - Get/Set the value associated with this key in the given
information object.
int = obj.Get (vtkInformation info) - Get/Set the value associated with this key in the given
information object.
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
31.57
vtkInformationIntegerPointerKey
31.57.1
Usage
31.57.2
Methods
The class vtkInformationIntegerPointerKey has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationIntegerPointerKey class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationIntegerPointerKey = obj.NewInstance ()
vtkInformationIntegerPointerKey = obj.SafeDownCast (vtkObject o)
vtkInformationIntegerPointerKey = obj.(string name, string location,
int length)
vtkInformationIntegerPointerKey = obj.()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.58 vtkInformationIntegerVectorKey
621
obj.Set (vtkInformation info, int value, int length) - Get/Set the value associated with this key in the given information object.
obj.Get (vtkInformation info, int value) - Get/Set the value associated with this key in
the given information object.
int = obj.Length (vtkInformation info) - Get/Set the value associated with this key in the
given information object.
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
31.58
vtkInformationIntegerVectorKey
31.58.1
Usage
31.58.2
Methods
The class vtkInformationIntegerVectorKey has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationIntegerVectorKey class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationIntegerVectorKey = obj.NewInstance ()
vtkInformationIntegerVectorKey = obj.SafeDownCast (vtkObject o)
vtkInformationIntegerVectorKey = obj.(string name, string location, int
length)
vtkInformationIntegerVectorKey = obj.()
obj.Append (vtkInformation info, int value) - Get/Set the value associated with this key
in the given information object.
obj.Set (vtkInformation info, int value, int length) - Get/Set the value associated with this key in the given information object.
int = obj.Get (vtkInformation info, int idx) - Get/Set the value associated with this
key in the given information object.
obj.Get (vtkInformation info, int value) - Get/Set the value associated with this key in
the given information object.
int = obj.Length (vtkInformation info) - Get/Set the value associated with this key in the
given information object.
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
622
31.59
vtkInformationIterator
31.59.1
Usage
vtkInformationIterator can be used to iterate over the keys of an information object. The corresponding values can
then be directly obtained from the information object using the keys.
To create an instance of class vtkInformationIterator, simply invoke its constructor as follows
obj = vtkInformationIterator
31.59.2
Methods
The class vtkInformationIterator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationIterator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationIterator = obj.NewInstance ()
vtkInformationIterator = obj.SafeDownCast (vtkObject o)
obj.SetInformation (vtkInformation ) - Set/Get the information to iterator over.
vtkInformation = obj.GetInformation () - Set/Get the information to iterator over.
obj.InitTraversal () - Move the iterator to the beginning of the collection.
obj.GoToFirstItem () - Move the iterator to the beginning of the collection.
obj.GoToNextItem () - Move the iterator to the next item in the collection.
int = obj.IsDoneWithTraversal () - Test whether the iterator is currently pointing to a valid item.
Returns 1 for yes, 0 for no.
vtkInformationKey = obj.GetCurrentKey () - Get the current item. Valid only when IsDoneWithTraversal() returns 1.
31.60
vtkInformationKey
31.60.1
Usage
vtkInformationKey is the superclass for all keys used to access the map represented by vtkInformation. The vtkInformation::Set and vtkInformation::Get methods of vtkInformation are accessed by information keys. A key is a
pointer to an instance of a subclass of vtkInformationKey. The type of the subclass determines the overload of
Set/Get that is selected. This ensures that the type of value stored in a vtkInformation instance corresponding to a
given key matches the type expected for that key.
To create an instance of class vtkInformationKey, simply invoke its constructor as follows
obj = vtkInformationKey
31.61 vtkInformationKeyVectorKey
31.60.2
623
Methods
The class vtkInformationKey has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationKey class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationKey = obj.NewInstance ()
vtkInformationKey = obj.SafeDownCast (vtkObject o)
obj.Register (vtkObjectBase ) - Prevent normal vtkObject reference counting behavior.
obj.UnRegister (vtkObjectBase ) - Prevent normal vtkObject reference counting behavior.
string = obj.GetName () - Get the name of the key. This is not the type of the key, but the name of
the key instance.
string = obj.GetLocation () - Get the location of the key. This is the name of the class in which
the key is defined.
vtkInformationKey = obj.(string name, string location) - Key instances are static
data that need to be created and destroyed. The constructor and destructor must be public. The name of the
static instance and the class in which it is defined should be passed to the constructor. They must be string
literals because the strings are not copied.
vtkInformationKey = obj.() - Key instances are static data that need to be created and destroyed. The constructor and destructor must be public. The name of the static instance and the class in
which it is defined should be passed to the constructor. They must be string literals because the strings are
not copied.
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
obj.DeepCopy (vtkInformation from, vtkInformation to) - Check whether this key
appears in the given information object.
int = obj.Has (vtkInformation info) - Check whether this key appears in the given information object.
obj.Remove (vtkInformation info) - Remove this key from the given information object.
obj.Report (vtkInformation info, vtkGarbageCollector collector) - Report a
reference this key has in the given information object.
31.61
vtkInformationKeyVectorKey
31.61.1
Usage
624
31.61.2
Methods
The class vtkInformationKeyVectorKey has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationKeyVectorKey
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationKeyVectorKey = obj.NewInstance ()
vtkInformationKeyVectorKey = obj.SafeDownCast (vtkObject o)
vtkInformationKeyVectorKey = obj.(string name, string location)
vtkInformationKeyVectorKey = obj.()
obj.Append (vtkInformation info, vtkInformationKey value) - Get/Set the value
associated with this key in the given information object.
obj.AppendUnique (vtkInformation info, vtkInformationKey value) - Get/Set the
value associated with this key in the given information object.
obj.RemoveItem (vtkInformation info, vtkInformationKey value) - Get/Set the
value associated with this key in the given information object.
vtkInformationKey = obj.Get (vtkInformation info, int idx) - Get/Set the value
associated with this key in the given information object.
int = obj.Length (vtkInformation info) - Get/Set the value associated with this key in the
given information object.
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
31.62
vtkInformationObjectBaseKey
31.62.1
Usage
vtkInformationObjectBaseKey is used to represent keys in vtkInformation for values that are vtkObjectBase instances.
To create an instance of class vtkInformationObjectBaseKey, simply invoke its constructor as follows
obj = vtkInformationObjectBaseKey
31.62.2
Methods
The class vtkInformationObjectBaseKey has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationObjectBaseKey class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.63 vtkInformationObjectBaseVectorKey
625
requiredClass)
vtkInformationObjectBaseKey = obj.()
obj.Set (vtkInformation info, vtkObjectBase ) - Get/Set the value associated with this
key in the given information object.
vtkObjectBase = obj.Get (vtkInformation info) - Get/Set the value associated with this
key in the given information object.
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
obj.Report (vtkInformation info, vtkGarbageCollector collector) - Report a
reference this key has in the given information object.
31.63
vtkInformationObjectBaseVectorKey
31.63.1
Usage
vtkInformationObjectBaseVectorKey is used to represent keys for double vector values in vtkInformation.h. NOTE
the interface in this key differs from that in other similar keys because of our internal use of smart pointers.
To create an instance of class vtkInformationObjectBaseVectorKey, simply invoke its constructor as follows
obj = vtkInformationObjectBaseVectorKey
31.63.2
Methods
The class vtkInformationObjectBaseVectorKey has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationObjectBaseVectorKey class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationObjectBaseVectorKey = obj.NewInstance ()
vtkInformationObjectBaseVectorKey = obj.SafeDownCast (vtkObject o)
vtkInformationObjectBaseVectorKey = obj.(string name, string location,
string requiredClass) - The name of the static instance and the class in which it is defined(location)
should be passed to the constructor. Providing "requiredClass" name one can insure that only objects of type
"requiredClass" are stored in vectors associated with the instance of this key type created. These should be
string literals as they are not coppied.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
626
31.64
vtkInformationQuadratureSchemeDefinitionVectorKey
31.64.1
Usage
vtkInformationQuadratureSchemeDefinitionVectorKey is used to represent keys for double vector values in vtkInformation.h. NOTE the interface in this key differs from that in other similar keys because of our internal use
of smart pointers.
To create an instance of class vtkInformationQuadratureSchemeDefinitionVectorKey, simply invoke its constructor
as follows
obj = vtkInformationQuadratureSchemeDefinitionVectorKey
31.64.2
Methods
The class vtkInformationQuadratureSchemeDefinitionVectorKey has several methods that can be used. They are
listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the
vtkInformationQuadratureSchemeDefinitionVectorKey class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationQuadratureSchemeDefinitionVectorKey = obj.NewInstance ()
vtkInformationQuadratureSchemeDefinitionVectorKey = obj.SafeDownCast
(vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.65 vtkInformationRequestKey
627
31.65
vtkInformationRequestKey
31.65.1
Usage
31.65.2
Methods
The class vtkInformationRequestKey has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationRequestKey
class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
628
31.66
vtkInformationStringKey
31.66.1
Usage
31.66.2
Methods
The class vtkInformationStringKey has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationStringKey
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationStringKey = obj.NewInstance ()
vtkInformationStringKey = obj.SafeDownCast (vtkObject o)
vtkInformationStringKey = obj.(string name, string location)
vtkInformationStringKey = obj.()
obj.Set (vtkInformation info, string ) - Get/Set the value associated with this key in the
given information object.
string = obj.Get (vtkInformation info) - Get/Set the value associated with this key in the
given information object.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.67 vtkInformationStringVectorKey
629
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
31.67
vtkInformationStringVectorKey
31.67.1
Usage
31.67.2
Methods
The class vtkInformationStringVectorKey has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationStringVectorKey class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationStringVectorKey = obj.NewInstance ()
vtkInformationStringVectorKey = obj.SafeDownCast (vtkObject o)
vtkInformationStringVectorKey = obj.(string name, string location, int
length)
vtkInformationStringVectorKey = obj.()
obj.Append (vtkInformation info, string value) - Get/Set the value associated with this
key in the given information object.
obj.Set (vtkInformation info, string value, int idx) - Get/Set the value associated with this key in the given information object.
string = obj.Get (vtkInformation info, int idx) - Get/Set the value associated with
this key in the given information object.
int = obj.Length (vtkInformation info) - Get/Set the value associated with this key in the
given information object.
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
31.68
vtkInformationUnsignedLongKey
630
31.68.1
Usage
31.68.2
Methods
The class vtkInformationUnsignedLongKey has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationUnsignedLongKey class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationUnsignedLongKey = obj.NewInstance ()
vtkInformationUnsignedLongKey = obj.SafeDownCast (vtkObject o)
vtkInformationUnsignedLongKey = obj.(string name, string location)
vtkInformationUnsignedLongKey = obj.()
obj.Set (vtkInformation info, long ) - Get/Set the value associated with this key in the
given information object.
long = obj.Get (vtkInformation info) - Get/Set the value associated with this key in the
given information object.
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
31.69
vtkInformationVector
31.69.1
Usage
31.69.2
Methods
The class vtkInformationVector has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationVector class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationVector = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.70 vtkInitialValueProblemSolver
631
31.70
vtkInitialValueProblemSolver
31.70.1
Usage
Given a vtkFunctionSet which returns dF_i(x_j, t)/dt given x_j and t, vtkInitialValueProblemSolver computes the
value of F_i at t+deltat.
To create an instance of class vtkInitialValueProblemSolver, simply invoke its constructor as follows
obj = vtkInitialValueProblemSolver
31.70.2
Methods
The class vtkInitialValueProblemSolver has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInitialValueProblemSolver
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInitialValueProblemSolver = obj.NewInstance ()
vtkInitialValueProblemSolver = obj.SafeDownCast (vtkObject o)
obj.SetFunctionSet (vtkFunctionSet functionset) - Set / get the dataset used for the
implicit function evaluation.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
632
31.71
vtkInstantiator
31.71.1
Usage
vtkInstantiator provides an interface to create an instance of any VTK class from its name. Instances are created
through registered pointers to functions returning the objects. New classes can also be registered with the creator.
VTK libraries automatically register their classes with the creator when they are loaded. Instances are created using
the static New() method, so the normal vtkObjectFactory mechanism is still invoked.
When using this class from language wrappers (Tcl, Python, or Java), the vtkInstantiator should be able to create
any class from any kit that has been loaded.
In C++ code, one should include the header for each kit from which one wishes to create instances through vtkInstantiator. This is necessary to ensure proper linking when building static libraries. Be careful, though, because
including each kits header means every class from that kit will be linked into your executable whether or not the
class is used. The headers are:
vtkCommon - vtkCommonInstantiator.h vtkFiltering - vtkFilteringInstantiator.h vtkIO - vtkIOInstantiator.h vtkImaging
- vtkImagingInstantiator.h vtkGraphics - vtkGraphicsInstantiator.h vtkRendering - vtkRenderingInstantiator.h vtkVolumeRendering - vtkVolumeRenderingInstantiator.h vtkHybrid - vtkHybridInstantiator.h vtkParallel - vtkParallelInstantiator.h
The VTK_MAKE_INSTANTIATOR() command in CMake is used to automatically generate the creator registration
for each VTK library. It can also be used to create registration code for VTK-style user libraries that are linked
to vtkCommon. After using this command to register classes from a new library, the generated header must be
included.
To create an instance of class vtkInstantiator, simply invoke its constructor as follows
obj = vtkInstantiator
31.71.2
Methods
The class vtkInstantiator has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkInstantiator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInstantiator = obj.NewInstance ()
vtkInstantiator = obj.SafeDownCast (vtkObject o)
31.72
vtkIntArray
31.73 vtkLinearTransform
31.72.1
633
Usage
vtkIntArray is an array of values of type int. It provides methods for insertion and retrieval of values and will automatically resize itself to hold new data.
To create an instance of class vtkIntArray, simply invoke its constructor as follows
obj = vtkIntArray
31.72.2
Methods
The class vtkIntArray has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkIntArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkIntArray = obj.NewInstance ()
vtkIntArray = obj.SafeDownCast (vtkObject o)
int = obj.GetDataType () - Copy the tuple value into a user-provided array.
obj.GetTupleValue (vtkIdType i, int tuple) - Set the tuple value at the ith location in the
array.
obj.SetTupleValue (vtkIdType i, int tuple) - Insert (memory allocation performed) the
tuple into the ith location in the array.
obj.InsertTupleValue (vtkIdType i, int tuple) - Insert (memory allocation performed)
the tuple onto the end of the array.
vtkIdType = obj.InsertNextTupleValue (int tuple) - Get the data at a particular index.
int = obj.GetValue (vtkIdType id) - Set the data at a particular index. Does not do range
checking. Make sure you use the method SetNumberOfValues() before inserting data.
obj.SetValue (vtkIdType id, int value) - Specify the number of values for this object to
hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for
fast insertion.
obj.SetNumberOfValues (vtkIdType number) - Insert data at a specified position in the array.
obj.InsertValue (vtkIdType id, int f) - Insert data at the end of the array. Return its location in the array.
vtkIdType = obj.InsertNextValue (int f) - Get the address of a particular data index. Make
sure data is allocated for the number of items requested. Set MaxId according to the number of data values
requested.
obj.SetArray (int array, vtkIdType size, int save) - This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied
by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory.
The class uses the actual array provided; it does not copy the data from the suppled array.
obj.SetArray (int array, vtkIdType size, int save, int deleteMethod)
31.73
vtkLinearTransform
634
31.73.1
Usage
vtkLinearTransform provides a generic interface for linear (affine or 12 degree-of-freedom) geometric transformations.
To create an instance of class vtkLinearTransform, simply invoke its constructor as follows
obj = vtkLinearTransform
31.73.2
Methods
The class vtkLinearTransform has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkLinearTransform class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkLinearTransform = obj.NewInstance ()
vtkLinearTransform = obj.SafeDownCast (vtkObject o)
obj.TransformNormal (float in[3], float out[3]) - Apply the transformation to a normal. You can use the same array to store both the input and output.
obj.TransformNormal (double in[3], double out[3]) - Apply the transformation to a
double-precision normal. You can use the same array to store both the input and output.
double = obj.TransformNormal (double x, double y, double z) with TransformDoubleNormal(x,y,z). Use this if you are programming in python, tcl or Java.
Synonymous
double = obj.TransformNormal (double normal[3]) - Synonymous with TransformDoubleNormal(x,y,z). Use this if you are programming in python, tcl or Java.
float = obj.TransformFloatNormal (float x, float y, float z) - Apply the transformation to an (x,y,z) normal. Use this if you are programming in python, tcl or Java.
float = obj.TransformFloatNormal (float normal[3]) - Apply the transformation to an
(x,y,z) normal. Use this if you are programming in python, tcl or Java.
double = obj.TransformDoubleNormal (double x, double y, double z) - Apply
the transformation to a double-precision (x,y,z) normal. Use this if you are programming in python, tcl or Java.
double = obj.TransformDoubleNormal (double normal[3]) - Apply the transformation
to a double-precision (x,y,z) normal. Use this if you are programming in python, tcl or Java.
double = obj.TransformVector (double x, double y, double z)
with TransformDoubleVector(x,y,z). Use this if you are programming in python, tcl or Java.
Synonymous
double = obj.TransformVector (double normal[3]) - Synonymous with TransformDoubleVector(x,y,z). Use this if you are programming in python, tcl or Java.
obj.TransformVector (float in[3], float out[3]) - Apply the transformation to a vector.
You can use the same array to store both the input and output.
obj.TransformVector (double in[3], double out[3]) - Apply the transformation to a
double-precision vector. You can use the same array to store both the input and output.
float = obj.TransformFloatVector (float x, float y, float z) - Apply the transformation to an (x,y,z) vector. Use this if you are programming in python, tcl or Java.
float = obj.TransformFloatVector (float vec[3]) - Apply the transformation to an
(x,y,z) vector. Use this if you are programming in python, tcl or Java.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.74 vtkLogLookupTable
635
vtkDataArray inNms, vtkDataArray outNms, vtkDataArray inVrs, vtkDataArray outVrs) - Apply the transformation to a combination of points, normals and vectors.
vtkLinearTransform = obj.GetLinearInverse () - This will calculate the transformation
without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformPoint (float in[3], float out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformPoint (double in[3], double out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformNormal (float in[3], float out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformNormal (double in[3], double out[3]) - This will calculate
the transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformVector (float in[3], float out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformVector (double in[3], double out[3]) - This will calculate
the transformation without calling Update. Meant for use only within other VTK classes.
31.74
vtkLogLookupTable
31.74.1
Usage
31.74.2
Methods
The class vtkLogLookupTable has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkLogLookupTable class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
636
31.75
vtkLongArray
31.75.1
Usage
vtkLongArray is an array of values of type long. It provides methods for insertion and retrieval of values and will
automatically resize itself to hold new data.
To create an instance of class vtkLongArray, simply invoke its constructor as follows
obj = vtkLongArray
31.75.2
Methods
The class vtkLongArray has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkLongArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkLongArray = obj.NewInstance ()
vtkLongArray = obj.SafeDownCast (vtkObject o)
int = obj.GetDataType () - Copy the tuple value into a user-provided array.
obj.GetTupleValue (vtkIdType i, long tuple) - Set the tuple value at the ith location in
the array.
obj.SetTupleValue (vtkIdType i, long tuple) - Insert (memory allocation performed) the
tuple into the ith location in the array.
obj.InsertTupleValue (vtkIdType i, long tuple) - Insert (memory allocation performed)
the tuple onto the end of the array.
vtkIdType = obj.InsertNextTupleValue (long tuple) - Get the data at a particular index.
long = obj.GetValue (vtkIdType id) - Set the data at a particular index. Does not do range
checking. Make sure you use the method SetNumberOfValues() before inserting data.
obj.SetValue (vtkIdType id, long value) - Specify the number of values for this object to
hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for
fast insertion.
obj.SetNumberOfValues (vtkIdType number) - Insert data at a specified position in the array.
obj.InsertValue (vtkIdType id, long f) - Insert data at the end of the array. Return its
location in the array.
vtkIdType = obj.InsertNextValue (long f) - Get the address of a particular data index.
Make sure data is allocated for the number of items requested. Set MaxId according to the number of data
values requested.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.76 vtkLongLongArray
637
obj.SetArray (long array, vtkIdType size, int save) - This method lets the user
specify data to be held by the array. The array argument is a pointer to the data. size is the size of the
array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or
reallocates memory. The class uses the actual array provided; it does not copy the data from the suppled
array.
obj.SetArray (long array, vtkIdType size, int save, int deleteMethod)
31.76
vtkLongLongArray
31.76.1
Usage
vtkLongLongArray is an array of values of type long long. It provides methods for insertion and retrieval of values
and will automatically resize itself to hold new data.
To create an instance of class vtkLongLongArray, simply invoke its constructor as follows
obj = vtkLongLongArray
31.76.2
Methods
The class vtkLongLongArray has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkLongLongArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkLongLongArray = obj.NewInstance ()
vtkLongLongArray = obj.SafeDownCast (vtkObject o)
int = obj.GetDataType () - Copy the tuple value into a user-provided array.
long = obj.long GetValue (vtkIdType id) - Set the data at a particular index. Does not do
range checking. Make sure you use the method SetNumberOfValues() before inserting data.
obj.SetValue (vtkIdType id, long long value) - Specify the number of values for this object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method
for fast insertion.
obj.SetNumberOfValues (vtkIdType number) - Insert data at a specified position in the array.
obj.InsertValue (vtkIdType id, long long f) - Insert data at the end of the array. Return
its location in the array.
vtkIdType = obj.InsertNextValue (long long f) - Get the address of a particular data
index. Make sure data is allocated for the number of items requested. Set MaxId according to the number of
data values requested.
long = obj.long WritePointer (vtkIdType id, vtkIdType number) - Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc.
long = obj.long GetPointer (vtkIdType id) - This method lets the user specify data to be
held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the
user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The
class uses the actual array provided; it does not copy the data from the suppled array.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
638
31.77
vtkLookupTable
31.77.1
Usage
vtkLookupTable is an object that is used by mapper objects to map scalar values into rgba (red-green-blue-alpha
transparency) color specification, or rgba into scalar values. The color table can be created by direct insertion of
color values, or by specifying hue, saturation, value, and alpha range and generating a table.
To create an instance of class vtkLookupTable, simply invoke its constructor as follows
obj = vtkLookupTable
31.77.2
Methods
The class vtkLookupTable has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkLookupTable class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkLookupTable = obj.NewInstance ()
vtkLookupTable = obj.SafeDownCast (vtkObject o)
int = obj.IsOpaque () - Return true if all of the values defining the mapping have an opacity equal
to 1. Default implementation return true.
int = obj.Allocate (int sz, int ext) - Allocate a color table of specified size.
obj.Build () - Generate lookup table from hue, saturation, value, alpha min/max values. Table is built
from linear ramp of each value.
obj.ForceBuild () - Force the lookup table to regenerate from hue, saturation, value, and alpha min/max values. Table is built from a linear ramp of each value. ForceBuild() is useful if a lookup table has been
defined manually (using SetTableValue) and then an application decides to rebuild the lookup table using the
implicit process.
obj.SetRamp (int ) - Set the shape of the table ramp to either linear or S-curve. The default is Scurve, which tails off gradually at either end. The equation used for the S-curve is y = (sin((x - 1/2)pi) +
1)/2, while the equation for the linear ramp is simply y = x. For an S-curve greyscale ramp, you should set
NumberOfTableValues to 402 (which is 256pi/2) to provide room for the tails of the ramp. The equation for
the SQRT is y = sqrt(x).
obj.SetRampToLinear () - Set the shape of the table ramp to either linear or S-curve. The default is
S-curve, which tails off gradually at either end. The equation used for the S-curve is y = (sin((x - 1/2)pi) +
1)/2, while the equation for the linear ramp is simply y = x. For an S-curve greyscale ramp, you should set
NumberOfTableValues to 402 (which is 256pi/2) to provide room for the tails of the ramp. The equation for
the SQRT is y = sqrt(x).
obj.SetRampToSCurve () - Set the shape of the table ramp to either linear or S-curve. The default is
S-curve, which tails off gradually at either end. The equation used for the S-curve is y = (sin((x - 1/2)pi) +
1)/2, while the equation for the linear ramp is simply y = x. For an S-curve greyscale ramp, you should set
NumberOfTableValues to 402 (which is 256pi/2) to provide room for the tails of the ramp. The equation for
the SQRT is y = sqrt(x).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.77 vtkLookupTable
639
obj.SetRampToSQRT () - Set the shape of the table ramp to either linear or S-curve. The default is
S-curve, which tails off gradually at either end. The equation used for the S-curve is y = (sin((x - 1/2)pi) +
1)/2, while the equation for the linear ramp is simply y = x. For an S-curve greyscale ramp, you should set
NumberOfTableValues to 402 (which is 256pi/2) to provide room for the tails of the ramp. The equation for
the SQRT is y = sqrt(x).
int = obj.GetRamp () - Set the shape of the table ramp to either linear or S-curve. The default is
S-curve, which tails off gradually at either end. The equation used for the S-curve is y = (sin((x - 1/2)pi) +
1)/2, while the equation for the linear ramp is simply y = x. For an S-curve greyscale ramp, you should set
NumberOfTableValues to 402 (which is 256pi/2) to provide room for the tails of the ramp. The equation for
the SQRT is y = sqrt(x).
obj.SetScale (int scale) - Set the type of scale to use, linear or logarithmic. The default is linear.
If the scale is logarithmic, then the TableRange must not cross the value zero.
obj.SetScaleToLinear () - Set the type of scale to use, linear or logarithmic. The default is linear. If
the scale is logarithmic, then the TableRange must not cross the value zero.
obj.SetScaleToLog10 () - Set the type of scale to use, linear or logarithmic. The default is linear. If
the scale is logarithmic, then the TableRange must not cross the value zero.
int = obj.GetScale () - Set the type of scale to use, linear or logarithmic. The default is linear. If
the scale is logarithmic, then the TableRange must not cross the value zero.
obj.SetTableRange (double r[2]) - Set/Get the minimum/maximum scalar values for scalar
mapping. Scalar values less than minimum range value are clamped to minimum range value. Scalar values
greater than maximum range value are clamped to maximum range value.
obj.SetTableRange (double min, double max) - Set/Get the minimum/maximum scalar values for scalar mapping. Scalar values less than minimum range value are clamped to minimum range value.
Scalar values greater than maximum range value are clamped to maximum range value.
double = obj. GetTableRange () - Set/Get the minimum/maximum scalar values for scalar
mapping. Scalar values less than minimum range value are clamped to minimum range value. Scalar values
greater than maximum range value are clamped to maximum range value.
obj.SetHueRange (double , double ) - Set the range in hue (using automatic generation). Hue
ranges between [0,1].
obj.SetHueRange (double a[2]) - Set the range in hue (using automatic generation). Hue ranges
between [0,1].
double = obj.
between [0,1].
GetHueRange () - Set the range in hue (using automatic generation). Hue ranges
640
obj.GetColor (double x, double rgb[3]) - Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1.
double = obj.GetOpacity (double v) - Map one value through the lookup table and return the
alpha value (the opacity) as a double between 0 and 1.
vtkIdType = obj.GetIndex (double v) - Return the table index associated with a particular
value.
obj.SetNumberOfTableValues (vtkIdType number) - Specify the number of values (i.e., colors) in the lookup table.
vtkIdType = obj.GetNumberOfTableValues () - Specify the number of values (i.e., colors) in
the lookup table.
obj.SetTableValue (vtkIdType indx, double rgba[4]) - Directly load color into lookup
table. Use [0,1] double values for color component specification. Make sure that youve either used the
Build() method or used SetNumberOfTableValues() prior to using this method.
obj.SetTableValue (vtkIdType indx, double r, double g, double b, double
a) - Directly load color into lookup table. Use [0,1] double values for color component specification.
double = obj.GetTableValue (vtkIdType id) - Return a rgba color value for the given index
into the lookup table. Color components are expressed as [0,1] double values.
obj.GetTableValue (vtkIdType id, double rgba[4]) - Return a rgba color value for the
given index into the lookup table. Color components are expressed as [0,1] double values.
double = obj.GetRange () - Sets/Gets the range of scalars which will be mapped. This is a duplicate of Get/SetTableRange.
obj.SetRange (double min, double max) - Sets/Gets the range of scalars which will be
mapped. This is a duplicate of Get/SetTableRange.
obj.SetRange (double rng[2]) - Sets/Gets the range of scalars which will be mapped. This is a
duplicate of Get/SetTableRange.
obj.SetNumberOfColors (vtkIdType ) - Set the number of colors in the lookup table. Use SetNumberOfTableValues() instead, it can be used both before and after the table has been built whereas SetNumberOfColors() has no effect after the table has been built.
vtkIdType = obj.GetNumberOfColorsMinValue () - Set the number of colors in the lookup
table. Use SetNumberOfTableValues() instead, it can be used both before and after the table has been built
whereas SetNumberOfColors() has no effect after the table has been built.
vtkIdType = obj.GetNumberOfColorsMaxValue () - Set the number of colors in the lookup
table. Use SetNumberOfTableValues() instead, it can be used both before and after the table has been built
whereas SetNumberOfColors() has no effect after the table has been built.
vtkIdType = obj.GetNumberOfColors () - Set the number of colors in the lookup table. Use
SetNumberOfTableValues() instead, it can be used both before and after the table has been built whereas
SetNumberOfColors() has no effect after the table has been built.
obj.SetTable (vtkUnsignedCharArray ) - Set/Get the internal table array that is used to map
the scalars to colors. The table array is an unsigned char array with 4 components representing RGBA.
vtkUnsignedCharArray = obj.GetTable () - Set/Get the internal table array that is used to
map the scalars to colors. The table array is an unsigned char array with 4 components representing RGBA.
obj.DeepCopy (vtkLookupTable lut) - Copy the contents from another LookupTable
int = obj.UsingLogScale ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.78 vtkLookupTableWithEnabling
31.78
641
vtkLookupTableWithEnabling
31.78.1
Usage
vtkLookupTableWithEnabling "disables" or "grays out" output colors based on whether the given value in EnabledArray is "0" or not.
To create an instance of class vtkLookupTableWithEnabling, simply invoke its constructor as follows
obj = vtkLookupTableWithEnabling
31.78.2
Methods
The class vtkLookupTableWithEnabling has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkLookupTableWithEnabling
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkLookupTableWithEnabling = obj.NewInstance ()
vtkLookupTableWithEnabling = obj.SafeDownCast (vtkObject o)
vtkDataArray = obj.GetEnabledArray () - This must be set before MapScalars() is called.
Indices of this array must map directly to those in the scalars array passed to MapScalars(). Values of 0 in
the array indicate the color should be desaturatated.
obj.SetEnabledArray (vtkDataArray enabledArray) - This must be set before MapScalars() is called. Indices of this array must map directly to those in the scalars array passed to MapScalars(). Values of 0 in the array indicate the color should be desaturatated.
obj.DisableColor (char r, char g, char b, string rd, string gd, string
bd) - A convenience method for taking a color and desaturating it.
31.79
vtkMath
31.79.1
Usage
vtkMath provides methods to perform common math operations. These include providing constants such as Pi;
conversion from degrees to radians; vector operations such as dot and cross products and vector norm; matrix determinant for 2x2 and 3x3 matrices; univariate polynomial solvers; and for random number generation (for backward
compatibility only).
To create an instance of class vtkMath, simply invoke its constructor as follows
obj = vtkMath
642
31.79.2
Methods
The class vtkMath has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkMath class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMath = obj.NewInstance ()
vtkMath = obj.SafeDownCast (vtkObject o)
31.80
vtkMatrix3x3
31.80.1
Usage
vtkMatrix3x3 is a class to represent and manipulate 3x3 matrices. Specifically, it is designed to work on 3x3
transformation matrices found in 2D rendering using homogeneous coordinates [x y w].
To create an instance of class vtkMatrix3x3, simply invoke its constructor as follows
obj = vtkMatrix3x3
31.80.2
Methods
The class vtkMatrix3x3 has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkMatrix3x3 class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMatrix3x3 = obj.NewInstance ()
vtkMatrix3x3 = obj.SafeDownCast (vtkObject o)
obj.DeepCopy (vtkMatrix3x3 source) - Non-static member function. Assigns from elements
array
obj.DeepCopy (double Elements[9]) - Set all of the elements to zero.
obj.Zero () - Set equal to Identity matrix
obj.Identity () - Matrix Inversion (adapted from Richard Carling in "Graphics Gems," Academic
Press, 1990).
obj.Invert () - Transpose the matrix and put it into out.
obj.Transpose () - Multiply a homogeneous coordinate by this matrix, i.e. out = Ain. The in[3] and
out[3] can be the same array.
obj.MultiplyPoint (float in[3], float out[3]) - Multiply a homogeneous coordinate by
this matrix, i.e. out = Ain. The in[3] and out[3] can be the same array.
obj.MultiplyPoint (double in[3], double out[3]) - Multiplies matrices a and b and
stores the result in c (c=ab).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.81 vtkMatrix4x4
643
31.81
vtkMatrix4x4
31.81.1
Usage
vtkMatrix4x4 is a class to represent and manipulate 4x4 matrices. Specifically, it is designed to work on 4x4
transformation matrices found in 3D rendering using homogeneous coordinates [x y z w].
To create an instance of class vtkMatrix4x4, simply invoke its constructor as follows
obj = vtkMatrix4x4
31.81.2
Methods
The class vtkMatrix4x4 has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkMatrix4x4 class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMatrix4x4 = obj.NewInstance ()
vtkMatrix4x4 = obj.SafeDownCast (vtkObject o)
obj.DeepCopy (vtkMatrix4x4 source) - Non-static member function. Assigns from elements
array
obj.DeepCopy (double Elements[16]) - Set all of the elements to zero.
obj.Zero () - Set equal to Identity matrix
obj.Identity () - Matrix Inversion (adapted from Richard Carling in "Graphics Gems," Academic
Press, 1990).
obj.Invert () - Transpose the matrix and put it into out.
obj.Transpose () - Multiply a homogeneous coordinate by this matrix, i.e. out = Ain. The in[4] and
out[4] can be the same array.
obj.MultiplyPoint (float in[4], float out[4]) - Multiply a homogeneous coordinate by
this matrix, i.e. out = Ain. The in[4] and out[4] can be the same array.
obj.MultiplyPoint (double in[4], double out[4]) - For use in Java, Python or Tcl. The
default MultiplyPoint() uses a single-precision point.
float = obj.MultiplyPoint (float in[4]) - For use in Java, Python or Tcl. The default
MultiplyPoint() uses a single-precision point.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
644
31.82
vtkMatrixToHomogeneousTransform
31.82.1
Usage
This is a very simple class which allows a vtkMatrix4x4 to be used in place of a vtkHomogeneousTransform or
vtkAbstractTransform. For example, if you use it as a proxy between a matrix and vtkTransformPolyDataFilter then
any modifications to the matrix will automatically be reflected in the output of the filter.
To create an instance of class vtkMatrixToHomogeneousTransform, simply invoke its constructor as follows
obj = vtkMatrixToHomogeneousTransform
31.82.2
Methods
The class vtkMatrixToHomogeneousTransform has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMatrixToHomogeneousTransform class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMatrixToHomogeneousTransform = obj.NewInstance ()
vtkMatrixToHomogeneousTransform = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkMatrix4x4 )
vtkMatrix4x4 = obj.GetInput ()
obj.Inverse () - The input matrix is left as-is, but the transformation matrix is inverted.
long = obj.GetMTime () - Get the MTime: this is the bit of magic that makes everything work.
vtkAbstractTransform = obj.MakeTransform () - Make a new transform of the same type.
obj.SetMatrix (vtkMatrix4x4 matrix) -
31.83
vtkMatrixToLinearTransform
31.84 vtkMinimalStandardRandomSequence
31.83.1
645
Usage
This is a very simple class which allows a vtkMatrix4x4 to be used in place of a vtkLinearTransform or vtkAbstractTransform. For example, if you use it as a proxy between a matrix and vtkTransformPolyDataFilter then any modifications to the matrix will automatically be reflected in the output of the filter.
To create an instance of class vtkMatrixToLinearTransform, simply invoke its constructor as follows
obj = vtkMatrixToLinearTransform
31.83.2
Methods
The class vtkMatrixToLinearTransform has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMatrixToLinearTransform
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMatrixToLinearTransform = obj.NewInstance ()
vtkMatrixToLinearTransform = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkMatrix4x4 ) - Set the input matrix. Any modifications to the matrix will be
reflected in the transformation.
vtkMatrix4x4 = obj.GetInput () - Set the input matrix. Any modifications to the matrix will be
reflected in the transformation.
obj.Inverse () - The input matrix is left as-is, but the transformation matrix is inverted.
long = obj.GetMTime () - Get the MTime: this is the bit of magic that makes everything work.
vtkAbstractTransform = obj.MakeTransform () - Make a new transform of the same type.
obj.SetMatrix (vtkMatrix4x4 matrix) -
31.84
vtkMinimalStandardRandomSequence
31.84.1
Usage
646
31.84.2
Methods
The class vtkMinimalStandardRandomSequence has several methods that can be used. They are listed below.
Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMinimalStandardRandomSequence class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMinimalStandardRandomSequence = obj.NewInstance ()
vtkMinimalStandardRandomSequence = obj.SafeDownCast (vtkObject o)
obj.SetSeed (int value) - Set the seed of the random sequence. The following pre-condition is
stated page 1197, second column: valid_seed: value>=1 && value<=2147483646 2147483646=(2 31)-2
This method does not have this criterium as a pre-condition (ie it will not fail if an incorrect seed value is
passed) but the value is silently changed to fit in the valid range [1,2147483646]. 2147483646 is added to a
null or negative value. 2147483647 is changed to be 1 (ie 2147483646 is substracted). Implementation note:
it also performs 3 calls to Next() to avoid the bad property that the first random number is proportional to the
seed value.
obj.SetSeedOnly (int value) - Set the seed of the random sequence. There is no extra internal
ajustment. Only useful for writing correctness test. The following pre-condition is stated page 1197, second
column 2147483646=(2 31)-2 This method does not have this criterium as a pre-condition (ie it will not fail if
an incorrect seed value is passed) but the value is silently changed to fit in the valid range [1,2147483646].
2147483646 is added to a null or negative value. 2147483647 is changed to be 1 (ie 2147483646 is substracted).
int = obj.GetSeed () - Get the seed of the random sequence. Only useful for writing correctness
test.
double = obj.GetValue () - Current value
Postcondition
unit_range: result>=0.0 && result<=1.0
obj.Next () - Move to the next number in the random sequence.
double = obj.GetRangeValue (double rangeMin, double rangeMax) - Convenient
method to return a value in a specific range from the range [0,1. There is an initial implementation that can
be overridden by a subclass. There is no pre-condition on the range:
it can be in increasing order: rangeMin<rangeMax
it can be empty: rangeMin=rangeMax
it can be in decreasing order: rangeMin>rangeMax
Postcondition
result_in_range: (rangeMin<=rangeMax && result>=rangeMin && result<=rangeMax) || (rangeMax<=rangeMin && result>=rangeMax && result<=rangeMin)
31.85
vtkMultiThreader
31.86 vtkMutexLock
31.85.1
647
Usage
vtkMultithreader is a class that provides support for multithreaded execution using sproc() on an SGI, or pthread_create on any platform supporting POSIX threads. This class can be used to execute a single method on multiple
threads, or to specify a method per thread.
To create an instance of class vtkMultiThreader, simply invoke its constructor as follows
obj = vtkMultiThreader
31.85.2
Methods
The class vtkMultiThreader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkMultiThreader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMultiThreader = obj.NewInstance ()
vtkMultiThreader = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfThreads (int ) - Get/Set the number of threads to create. It will be clamped to
the range 1 - VTK_MAX_THREADS, so the caller of this method should check that the requested number of
threads was accepted.
int = obj.GetNumberOfThreadsMinValue () - Get/Set the number of threads to create. It will
be clamped to the range 1 - VTK_MAX_THREADS, so the caller of this method should check that the requested number of threads was accepted.
int = obj.GetNumberOfThreadsMaxValue () - Get/Set the number of threads to create. It will
be clamped to the range 1 - VTK_MAX_THREADS, so the caller of this method should check that the requested number of threads was accepted.
int = obj.GetNumberOfThreads () - Get/Set the number of threads to create. It will be clamped
to the range 1 - VTK_MAX_THREADS, so the caller of this method should check that the requested number
of threads was accepted.
31.86
vtkMutexLock
31.86.1
Usage
vtkMutexLock allows the locking of variables which are accessed through different threads. This header file also
defines vtkSimpleMutexLock which is not a subclass of vtkObject.
To create an instance of class vtkMutexLock, simply invoke its constructor as follows
obj = vtkMutexLock
31.86.2
Methods
The class vtkMutexLock has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkMutexLock class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
648
31.87
vtkObject
31.87.1
Usage
vtkObject is the base class for most objects in the visualization toolkit. vtkObject provides methods for tracking
modification time, debugging, printing, and event callbacks. Most objects created within the VTK framework should
be a subclass of vtkObject or one of its children. The few exceptions tend to be very small helper classes that usually
never get instantiated or situations where multiple inheritance gets in the way. vtkObject also performs reference
counting: objects that are reference counted exist as long as another object uses them. Once the last reference to
a reference counted object is removed, the object will spontaneously destruct.
To create an instance of class vtkObject, simply invoke its constructor as follows
obj = vtkObject
31.87.2
Methods
The class vtkObject has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkObject class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkObject = obj.NewInstance ()
vtkObject = obj.SafeDownCast (vtkObject o)
obj.DebugOn () - Turn debugging output on.
obj.DebugOff () - Turn debugging output off.
char = obj.GetDebug () - Get the value of the debug flag.
obj.SetDebug (char debugFlag) - Set the value of the debug flag. A non-zero value turns debugging on.
obj.Modified () - Update the modification time for this object. Many filters rely on the modification time
to determine if they need to recompute their data. The modification time is a unique monotonically increasing
unsigned long integer.
long = obj.GetMTime () - Return this objects modified time.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.88 vtkObjectBase
649
31.88
vtkObjectBase
31.88.1
Usage
vtkObjectBase is the base class for all reference counted classes in the VTK. These classes include vtkCommand
classes, vtkInformationKey classes, and vtkObject classes.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
650
vtkObjectBase performs reference counting: objects that are reference counted exist as long as another object uses
them. Once the last reference to a reference counted object is removed, the object will spontaneously destruct.
Constructor and destructor of the subclasses of vtkObjectBase should be protected, so that only New() and UnRegister() actually call them. Debug leaks can be used to see if there are any objects left with nonzero reference
count.
To create an instance of class vtkObjectBase, simply invoke its constructor as follows
obj = vtkObjectBase
31.88.2
Methods
The class vtkObjectBase has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkObjectBase class.
string = obj.GetClassName () const - Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeRevisionMacro found in vtkSetGet.h.
int = obj.IsA (string name) - Return 1 if this class is the same type of (or a subclass of) the
named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in
vtkSetGet.h.
obj.Delete () - Delete a VTK object. This method should always be used to delete an object when the
New() method was used to create it. Using the C++ delete method will not work with reference counting.
obj.FastDelete () - Delete a reference to this object. This version will not invoke garbage collection
and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that
the object has another reference and would not be collected if a full garbage collection check were done.
obj.Register (vtkObjectBase o) - Increase the reference count (mark as used by another object).
obj.UnRegister (vtkObjectBase o) - Decrease the reference count (release by another object).
This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).
int = obj.GetReferenceCount () - Sets the reference count. (This is very dangerous, use with
care.)
obj.SetReferenceCount (int ) - Sets the reference count. (This is very dangerous, use with care.)
31.89
vtkObjectFactory
31.89.1
Usage
vtkObjectFactory is used to create vtk objects. The base class vtkObjectFactory contains a static method CreateInstance which is used to create vtk objects from the list of registered vtkObjectFactory sub-classes. The first
time CreateInstance is called, all dlls or shared libraries in the environment variable VTK_AUTOLOAD_PATH are
loaded into the current process. The C functions vtkLoad, vtkGetFactoryCompilerUsed, and vtkGetFactoryVersion
are called on each dll. To implement these functions in a shared library or dll, use the macro: VTK_FACTORY_INTERFACE_IMPLEMENT. VTK_AUTOLOAD_PATH is an environment variable containing a colon separated
(semi-colon on win32) list of paths.
The vtkObjectFactory can be use to override the creation of any object in VTK with a sub-class of that object.
The factories can be registered either at run time with the VTK_AUTOLOAD_PATH, or at compile time with the
vtkObjectFactory::RegisterFactory method.
To create an instance of class vtkObjectFactory, simply invoke its constructor as follows
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.90 vtkObjectFactoryCollection
651
obj = vtkObjectFactory
31.89.2
Methods
The class vtkObjectFactory has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkObjectFactory class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkObjectFactory = obj.NewInstance ()
vtkObjectFactory = obj.SafeDownCast (vtkObject o)
string = obj.GetVTKSourceVersion () - All sub-classes of vtkObjectFactory should must return the version of VTK they were built with. This should be implemented with the macro VTK_SOURCE_VERSION and NOT a call to vtkVersion::GetVTKSourceVersion. As the version needs to be compiled into the
file as a string constant. This is critical to determine possible incompatible dynamic factory loads.
string = obj.GetDescription () - Return a descriptive string describing the factory.
int = obj.GetNumberOfOverrides () - Return number of overrides this factory can create.
string = obj.GetClassOverrideName (int index) - Return the name of a class override at
the given index.
string = obj.GetClassOverrideWithName (int index) - Return the name of the class that
will override the class at the given index
int = obj.GetEnableFlag (int index) - Return the enable flag for the class at the given index.
string = obj.GetOverrideDescription (int index) - Return the description for a the
class override at the given index.
obj.SetEnableFlag (int flag, string className, string subclassName) - Set
and Get the Enable flag for the specific override of className. if subclassName is null, then it is ignored.
int = obj.GetEnableFlag (string className, string subclassName) - Set and
Get the Enable flag for the specific override of className. if subclassName is null, then it is ignored.
int = obj.HasOverride (string className) - Return 1 if this factory overrides the given
class name, 0 otherwise.
int = obj.HasOverride (string className, string subclassName) - Return 1 if this
factory overrides the given class name, 0 otherwise.
obj.Disable (string className) - Set all enable flags for the given class to 0. This will mean
that the factory will stop producing class with the given name.
string = obj.GetLibraryPath () - This returns the path to a dynamically loaded factory.
31.90
vtkObjectFactoryCollection
652
31.90.1
Usage
vtkObjectFactoryCollection is an object that creates and manipulates lists of object of type vtkObjectFactory.
To create an instance of class vtkObjectFactoryCollection, simply invoke its constructor as follows
obj = vtkObjectFactoryCollection
31.90.2
Methods
The class vtkObjectFactoryCollection has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkObjectFactoryCollection
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkObjectFactoryCollection = obj.NewInstance ()
vtkObjectFactoryCollection = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkObjectFactory t) - Get the next ObjectFactory in the list. Return NULL when
the end of the list is reached.
vtkObjectFactory = obj.GetNextItem ()
31.91
vtkOutputWindow
31.91.1
Usage
This class is used to encapsulate all text output, so that it will work with operating systems that have a stdout and
stderr, and ones that do not. (i.e windows does not). Sub-classes can be provided which can redirect the output to
a window.
To create an instance of class vtkOutputWindow, simply invoke its constructor as follows
obj = vtkOutputWindow
31.91.2
Methods
The class vtkOutputWindow has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkOutputWindow class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkOutputWindow = obj.NewInstance ()
vtkOutputWindow = obj.SafeDownCast (vtkObject o)
obj.DisplayText (string ) - Display the text. Four virtual methods exist, depending on the type
of message to display. This allows redirection or reformatting of the messages. The default implementation
uses DisplayText for all.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.92 vtkOverrideInformation
653
obj.DisplayErrorText (string ) - Display the text. Four virtual methods exist, depending on the
type of message to display. This allows redirection or reformatting of the messages. The default implementation uses DisplayText for all.
obj.DisplayWarningText (string ) - Display the text. Four virtual methods exist, depending
on the type of message to display. This allows redirection or reformatting of the messages. The default
implementation uses DisplayText for all.
obj.DisplayGenericWarningText (string ) - Display the text. Four virtual methods exist, depending on the type of message to display. This allows redirection or reformatting of the messages. The
default implementation uses DisplayText for all.
obj.DisplayDebugText (string )
obj.PromptUserOn () - If PromptUser is set to true then each time a line of text is displayed, the user
is asked if they want to keep getting messages.
obj.PromptUserOff () - If PromptUser is set to true then each time a line of text is displayed, the user
is asked if they want to keep getting messages.
obj.SetPromptUser (int ) - If PromptUser is set to true then each time a line of text is displayed,
the user is asked if they want to keep getting messages.
31.92
vtkOverrideInformation
31.92.1
Usage
vtkOverrideInformation is used to represent the information about a class which is overriden in a vtkObjectFactory.
To create an instance of class vtkOverrideInformation, simply invoke its constructor as follows
obj = vtkOverrideInformation
31.92.2
Methods
The class vtkOverrideInformation has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkOverrideInformation
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkOverrideInformation = obj.NewInstance ()
vtkOverrideInformation = obj.SafeDownCast (vtkObject o)
string = obj.GetClassOverrideName () - Returns the name of the class that will override the
class. For example, if you had a factory that provided an override for vtkVertex called vtkMyVertex, then this
would return "vtkMyVertex"
string = obj.GetClassOverrideWithName () - Return a human readable or GUI displayable
description of this override.
string = obj.GetDescription () - Return the specific object factory that this override occurs in.
vtkObjectFactory = obj.GetObjectFactory () - Set the class override name
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
654
31.93
vtkOverrideInformationCollection
31.93.1
Usage
vtkOverrideInformationCollection is an object that creates and manipulates lists of objects of type vtkOverrideInformation.
To create an instance of class vtkOverrideInformationCollection, simply invoke its constructor as follows
obj = vtkOverrideInformationCollection
31.93.2
Methods
The class vtkOverrideInformationCollection has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkOverrideInformationCollection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkOverrideInformationCollection = obj.NewInstance ()
vtkOverrideInformationCollection = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkOverrideInformation ) - Add a OverrideInformation to the list.
vtkOverrideInformation = obj.GetNextItem () - Get the next OverrideInformation in the
list.
31.94
vtkParametricBoy
31.94.1
Usage
vtkParametricBoy generates Boys surface. This is a Model of the projective plane without singularities. It was found
by Werner Boy on assignment from David Hilbert.
For further information about this surface, please consult the technical description "Parametric surfaces" in http://www.vtk.org/documents.php in the "VTK Technical Documents" section in the VTk.org web pages.
.SECTION Thanks Andrew Maclean a.maclean@cas.edu.au for creating and contributing the class.
To create an instance of class vtkParametricBoy, simply invoke its constructor as follows
obj = vtkParametricBoy
31.95 vtkParametricConicSpiral
31.94.2
655
Methods
The class vtkParametricBoy has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricBoy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkParametricBoy = obj.NewInstance ()
vtkParametricBoy = obj.SafeDownCast (vtkObject o)
int = obj.GetDimension () - Set/Get the scale factor for the z-coordinate. Default = 1/8, giving a
nice shape.
obj.SetZScale (double ) - Set/Get the scale factor for the z-coordinate. Default = 1/8, giving a nice
shape.
double = obj.GetZScale () - Set/Get the scale factor for the z-coordinate. Default = 1/8, giving a
nice shape.
obj.Evaluate (double uvw[3], double Pt[3], double Duvw[9]) - Boys surface.
This function performs the mapping f (u, v) (x, y, x), returning it as Pt. It also returns the partial derivatives
Du and Dv. Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv) . Then the normal is
N = DuXDv .
double = obj.EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])
- Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
uvw are the parameters with Pt being the the cartesian point, Duvw are the derivatives of this point with
respect to u, v and w. Pt, Duvw are obtained from Evaluate().
This function is only called if the ScalarMode has the value vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED
If the user does not need to calculate a scalar, then the instantiated function should return zero.
31.95
vtkParametricConicSpiral
31.95.1
Usage
vtkParametricConicSpiral generates conic spiral surfaces. These can resemble sea shells, or may look like a torus
"eating" its own tail.
For further information about this surface, please consult the technical description "Parametric surfaces" in http://www.vtk.org/documents.php in the "VTK Technical Documents" section in the VTk.org web pages.
.SECTION Thanks Andrew Maclean a.maclean@cas.edu.au for creating and contributing the class.
To create an instance of class vtkParametricConicSpiral, simply invoke its constructor as follows
obj = vtkParametricConicSpiral
656
31.95.2
Methods
The class vtkParametricConicSpiral has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricConicSpiral
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkParametricConicSpiral = obj.NewInstance ()
vtkParametricConicSpiral = obj.SafeDownCast (vtkObject o)
int = obj.GetDimension () - Set/Get the scale factor. Default = 0.2
obj.SetA (double ) - Set/Get the scale factor. Default = 0.2
double = obj.GetA () - Set/Get the scale factor. Default = 0.2
obj.SetB (double ) - Set/Get the A function coefficient (see equation below). Default = 1.
double = obj.GetB () - Set/Get the A function coefficient (see equation below). Default = 1.
obj.SetC (double ) - Set/Get the B function coefficient (see equation below). Default = 0.1.
double = obj.GetC () - Set/Get the B function coefficient (see equation below). Default = 0.1.
obj.SetN (double ) - Set/Get the C function coefficient (see equation below). Default = 2.
double = obj.GetN () - Set/Get the C function coefficient (see equation below). Default = 2.
obj.Evaluate (double uvw[3], double Pt[3], double Duvw[9]) - A conic spiral surface.
This function performs the mapping f (u, v) (x, y, x), returning it as Pt. It also returns the partial derivatives
Du and Dv. Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv) . Then the normal is
N = DuXDv .
double = obj.EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])
- Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
uvw are the parameters with Pt being the the cartesian point, Duvw are the derivatives of this point with
respect to u, v and w. Pt, Duvw are obtained from Evaluate().
This function is only called if the ScalarMode has the value vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED
If the user does not need to calculate a scalar, then the instantiated function should return zero.
31.96
vtkParametricCrossCap
31.96.1
Usage
31.97 vtkParametricDini
31.96.2
657
Methods
The class vtkParametricCrossCap has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricCrossCap
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkParametricCrossCap = obj.NewInstance ()
vtkParametricCrossCap = obj.SafeDownCast (vtkObject o)
int = obj.GetDimension () - A cross-cap.
This function performs the mapping f (u, v) (x, y, x), returning it as Pt. It also returns the partial derivatives
Du and Dv. Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv) . Then the normal is
N = DuXDv .
obj.Evaluate (double uvw[3], double Pt[3], double Duvw[9]) - A cross-cap.
This function performs the mapping f (u, v) (x, y, x), returning it as Pt. It also returns the partial derivatives
Du and Dv. Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv) . Then the normal is
N = DuXDv .
double = obj.EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])
- Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
uvw are the parameters with Pt being the the cartesian point, Duvw are the derivatives of this point with
respect to u, v and w. Pt, Duvw are obtained from Evaluate().
This function is only called if the ScalarMode has the value vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED
If the user does not need to calculate a scalar, then the instantiated function should return zero.
31.97
vtkParametricDini
31.97.1
Usage
vtkParametricDini generates Dinis surface. Dinis surface is a surface that posesses constant negative Gaussian
curvature
For further information about this surface, please consult the technical description "Parametric surfaces" in http://www.vtk.org/documents.php in the "VTK Technical Documents" section in the VTk.org web pages.
.SECTION Thanks Andrew Maclean a.maclean@cas.edu.au for creating and contributing the class.
To create an instance of class vtkParametricDini, simply invoke its constructor as follows
obj = vtkParametricDini
31.97.2
Methods
The class vtkParametricDini has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricDini class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
658
31.98
vtkParametricEllipsoid
31.98.1
Usage
vtkParametricEllipsoid generates an ellipsoid. If all the radii are the same, we have a sphere. An oblate spheroid
occurs if RadiusX = RadiusY > RadiusZ. Here the Z-axis forms the symmetry axis. To a first approximation, this is
the shape of the earth. A prolate spheroid occurs if RadiusX = RadiusY < RadiusZ.
For further information about this surface, please consult the technical description "Parametric surfaces" in http://www.vtk.org/documents.php in the "VTK Technical Documents" section in the VTk.org web pages.
.SECTION Thanks Andrew Maclean a.maclean@cas.edu.au for creating and contributing the class.
To create an instance of class vtkParametricEllipsoid, simply invoke its constructor as follows
obj = vtkParametricEllipsoid
31.98.2
Methods
The class vtkParametricEllipsoid has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricEllipsoid class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.99 vtkParametricEnneper
659
vtkParametricEllipsoid = obj.NewInstance ()
vtkParametricEllipsoid = obj.SafeDownCast (vtkObject o)
int = obj.GetDimension () - Set/Get the scaling factor for the x-axis. Default = 1.
obj.SetXRadius (double ) - Set/Get the scaling factor for the x-axis. Default = 1.
double = obj.GetXRadius () - Set/Get the scaling factor for the x-axis. Default = 1.
obj.SetYRadius (double ) - Set/Get the scaling factor for the y-axis. Default = 1.
double = obj.GetYRadius () - Set/Get the scaling factor for the y-axis. Default = 1.
obj.SetZRadius (double ) - Set/Get the scaling factor for the z-axis. Default = 1.
double = obj.GetZRadius () - Set/Get the scaling factor for the z-axis. Default = 1.
obj.Evaluate (double uvw[3], double Pt[3], double Duvw[9]) - An ellipsoid.
This function performs the mapping f (u, v) (x, y, x), returning it as Pt. It also returns the partial derivatives
Du and Dv. Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv) . Then the normal is
N = DuXDv .
double = obj.EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])
- Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
uvw are the parameters with Pt being the the cartesian point, Duvw are the derivatives of this point with
respect to u, v and w. Pt, Duvw are obtained from Evaluate().
This function is only called if the ScalarMode has the value vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED
If the user does not need to calculate a scalar, then the instantiated function should return zero.
31.99
vtkParametricEnneper
31.99.1
Usage
31.99.2
Methods
The class vtkParametricEnneper has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricEnneper class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkParametricEnneper = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
660
31.100
vtkParametricFigure8Klein
31.100.1
Usage
vtkParametricFigure8Klein generates a figure-8 Klein bottle. A Klein bottle is a closed surface with no interior and
only one surface. It is unrealisable in 3 dimensions without intersecting surfaces. It can be realised in 4 dimensions
by considering the map F : R2 R4 given by:
f (u, v) = ((r cos(v) + a) cos(u), (r cos(v) + a) sin(u), r sin(v) cos(u/2), r sin(v) sin(u/2))
This representation of the immersion in R3 is formed by taking two Mobius strips and joining them along their
boundaries, this is the so called "Figure-8 Klein Bottle"
For further information about this surface, please consult the technical description "Parametric surfaces" in http://www.vtk.org/documents.php in the "VTK Technical Documents" section in the VTk.org web pages.
.SECTION Thanks Andrew Maclean a.maclean@cas.edu.au for creating and contributing the class.
To create an instance of class vtkParametricFigure8Klein, simply invoke its constructor as follows
obj = vtkParametricFigure8Klein
31.100.2
Methods
The class vtkParametricFigure8Klein has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricFigure8Klein
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkParametricFigure8Klein = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.101 vtkParametricFunction
661
31.101
vtkParametricFunction
31.101.1
Usage
vtkParametricFunction is an abstract interface for functions defined by parametric mapping i.e. f(u,v,w)->(x,y,z)
where u_min <= u < u_max, v_min <= v < v_max, w_min <= w < w_max. (For notational convenience, we will
write f(u)->x and assume that u means (u,v,w) and x means (x,y,z).)
The interface contains the pure virtual function, Evaluate(), that generates a point and the derivatives at that point
which are then used to construct the surface. A second pure virtual function, EvaluateScalar(), can be used to
generate a scalar for the surface. Finally, the GetDimension() virtual function is used to differentiate 1D, 2D, and 3D
parametric functions. Since this abstract class defines a pure virtual API, its subclasses must implement the pure
virtual functions GetDimension(), Evaluate() and EvaluateScalar().
This class has also methods for defining a range of parametric values (u,v,w).
.SECTION Thanks Andrew Maclean a.maclean@cas.edu.au for creating and contributing the class.
To create an instance of class vtkParametricFunction, simply invoke its constructor as follows
obj = vtkParametricFunction
31.101.2
Methods
The class vtkParametricFunction has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricFunction class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
662
31.102 vtkParametricKlein
663
obj.TwistUOff () - Set/Get the flag which joins the first triangle strip to the last one with a twist. JoinU
must also be set if this is set. Used when building some non-orientable surfaces.
obj.SetTwistV (int ) - Set/Get the flag which joins the ends of the triangle strips with a twist. JoinV
must also be set if this is set. Used when building some non-orientable surfaces.
int = obj.GetTwistV () - Set/Get the flag which joins the ends of the triangle strips with a twist.
JoinV must also be set if this is set. Used when building some non-orientable surfaces.
obj.TwistVOn () - Set/Get the flag which joins the ends of the triangle strips with a twist. JoinV must
also be set if this is set. Used when building some non-orientable surfaces.
obj.TwistVOff () - Set/Get the flag which joins the ends of the triangle strips with a twist. JoinV must
also be set if this is set. Used when building some non-orientable surfaces.
obj.SetClockwiseOrdering (int ) - Set/Get the flag which determines the ordering of the the
vertices forming the triangle strips. The ordering of the points being inserted into the triangle strip is important
because it determines the direction of the normals for the lighting. If set, the ordering is clockwise, otherwise
the ordering is anti-clockwise. Default is true (i.e. clockwise ordering).
int = obj.GetClockwiseOrdering () - Set/Get the flag which determines the ordering of the the
vertices forming the triangle strips. The ordering of the points being inserted into the triangle strip is important
because it determines the direction of the normals for the lighting. If set, the ordering is clockwise, otherwise
the ordering is anti-clockwise. Default is true (i.e. clockwise ordering).
obj.ClockwiseOrderingOn () - Set/Get the flag which determines the ordering of the the vertices
forming the triangle strips. The ordering of the points being inserted into the triangle strip is important because
it determines the direction of the normals for the lighting. If set, the ordering is clockwise, otherwise the
ordering is anti-clockwise. Default is true (i.e. clockwise ordering).
obj.ClockwiseOrderingOff () - Set/Get the flag which determines the ordering of the the vertices
forming the triangle strips. The ordering of the points being inserted into the triangle strip is important because
it determines the direction of the normals for the lighting. If set, the ordering is clockwise, otherwise the
ordering is anti-clockwise. Default is true (i.e. clockwise ordering).
obj.SetDerivativesAvailable (int ) - Set/Get the flag which determines whether derivatives
are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives).
int = obj.GetDerivativesAvailable () - Set/Get the flag which determines whether derivatives are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives).
obj.DerivativesAvailableOn () - Set/Get the flag which determines whether derivatives are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives).
obj.DerivativesAvailableOff () - Set/Get the flag which determines whether derivatives are
available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives).
31.102
vtkParametricKlein
31.102.1
Usage
vtkParametricKlein generates a "classical" representation of a Klein bottle. A Klein bottle is a closed surface with no
interior and only one surface. It is unrealisable in 3 dimensions without intersecting surfaces. It can be realised in 4
dimensions by considering the map F : R2 R4 given by:
f (u, v) = ((r cos(v) + a) cos(u), (r cos(v) + a) sin(u), r sin(v) cos(u/2), r sin(v) sin(u/2))
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
664
31.102.2
Methods
The class vtkParametricKlein has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricKlein class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkParametricKlein = obj.NewInstance ()
vtkParametricKlein = obj.SafeDownCast (vtkObject o)
int = obj.GetDimension () - A Klein bottle.
This function performs the mapping f (u, v) (x, y, x), returning it as Pt. It also returns the partial derivatives
Du and Dv. Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv) . Then the normal is
N = DuXDv .
obj.Evaluate (double uvw[3], double Pt[3], double Duvw[9]) - A Klein bottle.
This function performs the mapping f (u, v) (x, y, x), returning it as Pt. It also returns the partial derivatives
Du and Dv. Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv) . Then the normal is
N = DuXDv .
double = obj.EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])
- Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
uvw are the parameters with Pt being the the cartesian point, Duvw are the derivatives of this point with
respect to u, v and w. Pt, Duvw are obtained from Evaluate().
This function is only called if the ScalarMode has the value vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED
If the user does not need to calculate a scalar, then the instantiated function should return zero.
31.103
vtkParametricMobius
31.103.1
Usage
31.104 vtkParametricRandomHills
31.103.2
665
Methods
The class vtkParametricMobius has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricMobius class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkParametricMobius = obj.NewInstance ()
vtkParametricMobius = obj.SafeDownCast (vtkObject o)
obj.SetRadius (double ) - Set/Get the radius of the Mobius strip.
double = obj.GetRadius () - Set/Get the radius of the Mobius strip.
int = obj.GetDimension () - The Mobius strip.
This function performs the mapping f (u, v) (x, y, x), returning it as Pt. It also returns the partial derivatives
Du and Dv. Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv) . Then the normal is
N = DuXDv .
obj.Evaluate (double uvw[3], double Pt[3], double Duvw[9]) - The Mobius strip.
This function performs the mapping f (u, v) (x, y, x), returning it as Pt. It also returns the partial derivatives
Du and Dv. Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv) . Then the normal is
N = DuXDv .
double = obj.EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])
- Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
uvw are the parameters with Pt being the the cartesian point, Duvw are the derivatives of this point with
respect to u, v and w. Pt, Du, Dv are obtained from Evaluate().
This function is only called if the ScalarMode has the value vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED
If the user does not need to calculate a scalar, then the instantiated function should return zero.
31.104
vtkParametricRandomHills
31.104.1
Usage
666
31.104.2
Methods
The class vtkParametricRandomHills has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricRandomHills
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkParametricRandomHills = obj.NewInstance ()
vtkParametricRandomHills = obj.SafeDownCast (vtkObject o)
int = obj.GetDimension () - Construct a surface of random hills with the following parameters:
MinimumU = -10, MaximumU = 10, MinimumV = -10, MaximumV = 10, JoinU = 0, JoinV = 0, TwistU = 0,
TwistV = 0; ClockwiseOrdering = 1, DerivativesAvailable = 0, Number of hills = 30, Variance of the hills 2.5 in
both x- and y- directions, Scaling factor for the variances 1/3 in both x- and y- directions, Amplitude of each
hill = 1, Scaling factor for the amplitude = 1/3, RandomSeed = 1, AllowRandomGeneration = 1.
obj.SetNumberOfHills (int ) - Set/Get the number of hills. Default is 30.
int = obj.GetNumberOfHills () - Set/Get the number of hills. Default is 30.
obj.SetHillXVariance (double ) - Set/Get the hill variance in the x-direction. Default is 2.5.
double = obj.GetHillXVariance () - Set/Get the hill variance in the x-direction. Default is 2.5.
obj.SetHillYVariance (double ) - Set/Get the hill variance in the y-direction. Default is 2.5.
double = obj.GetHillYVariance () - Set/Get the hill variance in the y-direction. Default is 2.5.
obj.SetHillAmplitude (double ) - Set/Get the hill amplitude (height). Default is 2.
double = obj.GetHillAmplitude () - Set/Get the hill amplitude (height). Default is 2.
obj.SetRandomSeed (int ) - Set/Get the Seed for the random number generator, a value of 1 will
initialize the random number generator, a negative value will initialize it with the system time. Default is 1.
int = obj.GetRandomSeed () - Set/Get the Seed for the random number generator, a value of 1 will
initialize the random number generator, a negative value will initialize it with the system time. Default is 1.
obj.SetAllowRandomGeneration (int ) - Set/Get the random generation flag. A value of 0 will
disable the generation of random hills on the surface. This allows a reproducible shape to be generated. Any
other value means that the generation of the hills will be done randomly. Default is 1.
int = obj.GetAllowRandomGeneration () - Set/Get the random generation flag. A value of 0
will disable the generation of random hills on the surface. This allows a reproducible shape to be generated.
Any other value means that the generation of the hills will be done randomly. Default is 1.
obj.AllowRandomGenerationOn () - Set/Get the random generation flag. A value of 0 will disable
the generation of random hills on the surface. This allows a reproducible shape to be generated. Any other
value means that the generation of the hills will be done randomly. Default is 1.
obj.AllowRandomGenerationOff () - Set/Get the random generation flag. A value of 0 will disable
the generation of random hills on the surface. This allows a reproducible shape to be generated. Any other
value means that the generation of the hills will be done randomly. Default is 1.
obj.SetXVarianceScaleFactor (double ) - Set/Get the scaling factor for the variance in the
x-direction. Default is 1/3.
double = obj.GetXVarianceScaleFactor () - Set/Get the scaling factor for the variance in the
x-direction. Default is 1/3.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.105 vtkParametricRoman
667
obj.SetYVarianceScaleFactor (double ) - Set/Get the scaling factor for the variance in the
y-direction. Default is 1/3.
double = obj.GetYVarianceScaleFactor () - Set/Get the scaling factor for the variance in the
y-direction. Default is 1/3.
obj.SetAmplitudeScaleFactor (double ) - Set/Get the scaling factor for the amplitude. Default
is 1/3.
double = obj.GetAmplitudeScaleFactor () - Set/Get the scaling factor for the amplitude. Default is 1/3.
obj.GenerateTheHills (void ) - Generate the centers of the hills, their standard deviations and
their amplitudes. This function creates a series of vectors representing the u, v coordinates of each hill, its
variance in the u, v directions and the amplitude.
NOTE: This function must be called whenever any of the parameters are changed.
obj.Evaluate (double uvw[3], double Pt[3], double Duvw[9]) - Construct a terrain
consisting of randomly placed hills on a surface.
It is assumed that the function GenerateTheHills() has been executed to build the vectors of coordinates
required to generate the point Pt. Pt represents the sum of all the amplitudes over the space.
This function performs the mapping f (u, v) (x, y, x), returning it as Pt. It also returns the partial derivatives
Du and Dv. Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv) . Then the normal is
N = DuXDv .
double = obj.EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])
- Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
uvw are the parameters with Pt being the the Cartesian point, Duvw are the derivatives of this point with
respect to u, v and w. Pt, Duvw are obtained from Evaluate().
This function is only called if the ScalarMode has the value vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED
If the user does not need to calculate a scalar, then the instantiated function should return zero.
31.105
vtkParametricRoman
31.105.1
Usage
31.105.2
Methods
The class vtkParametricRoman has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricRoman class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
668
31.106
vtkParametricSuperEllipsoid
31.106.1
Usage
31.106.2
Methods
The class vtkParametricSuperEllipsoid has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricSuperEllipsoid
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkParametricSuperEllipsoid = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.107 vtkParametricSuperToroid
669
31.107
vtkParametricSuperToroid
31.107.1
Usage
vtkParametricSuperToroid generates a supertoroid. Essentially a supertoroid is a torus with the sine and cosine
terms raised to a power. A supertoroid is a versatile primitive that is controlled by four parameters r0, r1, n1 and n2.
r0, r1 determine the type of torus whilst the value of n1 determines the shape of the torus ring and n2 determines
the shape of the cross section of the ring. It is the different values of these powers which give rise to a family of 3D
shapes that are all basically toroidal in shape.
For further information about this surface, please consult the technical description "Parametric surfaces" in http://www.vtk.org/documents.php in the "VTK Technical Documents" section in the VTk.org web pages.
Also see: http://astronomy.swin.edu.au/pbourke/surfaces/.
To create an instance of class vtkParametricSuperToroid, simply invoke its constructor as follows
obj = vtkParametricSuperToroid
670
31.107.2
Methods
The class vtkParametricSuperToroid has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricSuperToroid
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkParametricSuperToroid = obj.NewInstance ()
vtkParametricSuperToroid = obj.SafeDownCast (vtkObject o)
int = obj.GetDimension () - Set/Get the radius from the center to the middle of the ring of the
supertoroid. Default = 1.
obj.SetRingRadius (double ) - Set/Get the radius from the center to the middle of the ring of the
supertoroid. Default = 1.
double = obj.GetRingRadius () - Set/Get the radius from the center to the middle of the ring of
the supertoroid. Default = 1.
obj.SetCrossSectionRadius (double ) - Set/Get the radius of the cross section of ring of the
supertoroid. Default = 0.5.
double = obj.GetCrossSectionRadius () - Set/Get the radius of the cross section of ring of
the supertoroid. Default = 0.5.
obj.SetXRadius (double ) - Set/Get the scaling factor for the x-axis. Default = 1.
double = obj.GetXRadius () - Set/Get the scaling factor for the x-axis. Default = 1.
obj.SetYRadius (double ) - Set/Get the scaling factor for the y-axis. Default = 1.
double = obj.GetYRadius () - Set/Get the scaling factor for the y-axis. Default = 1.
obj.SetZRadius (double ) - Set/Get the scaling factor for the z-axis. Default = 1.
double = obj.GetZRadius () - Set/Get the scaling factor for the z-axis. Default = 1.
obj.SetN1 (double ) - Set/Get the shape of the torus ring. Default = 1.
double = obj.GetN1 () - Set/Get the shape of the torus ring. Default = 1.
obj.SetN2 (double ) - Set/Get the shape of the cross section of the ring. Default = 1.
double = obj.GetN2 () - Set/Get the shape of the cross section of the ring. Default = 1.
obj.Evaluate (double uvw[3], double Pt[3], double Duvw[9]) - A supertoroid.
This function performs the mapping f (u, v) (x, y, x), returning it as Pt. It also returns the partial derivatives
Du and Dv. Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv) . Then the normal is
N = DuXDv .
double = obj.EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])
- Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
uvw are the parameters with Pt being the the cartesian point, Duvw are the derivatives of this point with
respect to u, v and w. Pt, Duvw are obtained from Evaluate().
This function is only called if the ScalarMode has the value vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED
If the user does not need to calculate a scalar, then the instantiated function should return zero.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.108 vtkParametricTorus
31.108
671
vtkParametricTorus
31.108.1
Usage
31.108.2
Methods
The class vtkParametricTorus has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricTorus class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkParametricTorus = obj.NewInstance ()
vtkParametricTorus = obj.SafeDownCast (vtkObject o)
obj.SetRingRadius (double ) - Set/Get the radius from the center to the middle of the ring of the
torus. The default value is 1.0.
double = obj.GetRingRadius () - Set/Get the radius from the center to the middle of the ring of
the torus. The default value is 1.0.
obj.SetCrossSectionRadius (double ) - Set/Get the radius of the cross section of ring of the
torus. The default value is 0.5.
double = obj.GetCrossSectionRadius () - Set/Get the radius of the cross section of ring of
the torus. The default value is 0.5.
int = obj.GetDimension () - A torus.
This function performs the mapping f (u, v) (x, y, x), returning it as Pt. It also returns the partial derivatives
Du and Dv. Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv). Then the normal is
N = DuXDv.
obj.Evaluate (double uvw[3], double Pt[3], double Duvw[9]) - A torus.
This function performs the mapping f (u, v) (x, y, x), returning it as Pt. It also returns the partial derivatives
Du and Dv. Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv). Then the normal is
N = DuXDv.
double = obj.EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])
- Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
uvw are the parameters with Pt being the the Cartesian point, Duvw are the derivatives of this point with
respect to u, v and w. Pt, Duvw are obtained from Evaluate().
This function is only called if the ScalarMode has the value vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED
If the user does not need to calculate a scalar, then the instantiated function should return zero.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
672
31.109
vtkPerspectiveTransform
31.109.1
Usage
A vtkPerspectiveTransform can be used to describe the full range of homogeneous transformations. It was designed
in particular to describe a camera-view of a scene.
The order in which you set up the display coordinates (via AdjustZBuffer() and AdjustViewport()), the projection (via
Perspective(), Frustum(), or Ortho()) and the camera view (via SetupCamera()) are important. If the transform is in
PreMultiply mode, which is the default, set the Viewport and ZBuffer first, then the projection, and finally the camera
view. Once the view is set up, the Translate and Rotate methods can be used to move the camera around in world
coordinates. If the Oblique() or Stereo() methods are used, they should be called just before SetupCamera().
In PostMultiply mode, you must perform all transformations in the opposite order. This is necessary, for example, if
you already have a perspective transformation set up but must adjust the viewport. Another example is if you have
a view transformation, and wish to perform translations and rotations in the cameras coordinate system rather than
in world coordinates.
The SetInput and Concatenate methods can be used to create a transformation pipeline with vtkPerspectiveTransform. See vtkTransform for more information on the transformation pipeline.
To create an instance of class vtkPerspectiveTransform, simply invoke its constructor as follows
obj = vtkPerspectiveTransform
31.109.2
Methods
The class vtkPerspectiveTransform has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPerspectiveTransform
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPerspectiveTransform = obj.NewInstance ()
vtkPerspectiveTransform = obj.SafeDownCast (vtkObject o)
obj.Identity () - Set this transformation to the identity transformation. If the transform has an Input,
then the transformation will be reset so that it is the same as the Input.
obj.Inverse () - Invert the transformation. This will also set a flag so that the transformation will use
the inverse of its Input, if an Input has been set.
obj.AdjustViewport (double oldXMin, double oldXMax, double oldYMin,
31.109 vtkPerspectiveTransform
673
obj.Ortho (double xmin, double xmax, double ymin, double ymax, double
znear, double zfar) - Create an orthogonal projection matrix and concatenate it by the current
transformation. The matrix maps [xmin,xmax], [ymin,ymax], [-znear,-zfar] to [-1,+1], [-1,+1], [+1,-1].
obj.Frustum (double xmin, double xmax, double ymin, double ymax, double
znear, double zfar) - Create an perspective projection matrix and concatenate it by the current
transformation. The matrix maps a frustum with a back plane at -zfar and a front plane at -znear with extent
[xmin,xmax],[ymin,ymax] to [-1,+1], [-1,+1], [+1,-1].
obj.Perspective (double angle, double aspect, double znear, double zfar)
- Create a perspective projection matrix by specifying the view angle (this angle is in the y direction), the
aspect ratio, and the near and far clipping range. The projection matrix is concatenated with the current
transformation. This method works via Frustum.
obj.Shear (double dxdz, double dydz, double zplane) - Create a shear transformation about a plane at distance z from the camera. The values dxdz (i.e. dx/dz) and dydz specify the amount
of shear in the x and y directions. The zplane specifies the distance from the camera to the plane at which
the shear causes zero displacement. Generally you want this plane to be the focal plane. This transformation
can be used in combination with Ortho to create an oblique projection. It can also be used in combination
with Perspective to provide correct stereo views when the eye is at arbitrary but known positions relative to
the center of a flat viewing screen.
obj.Stereo (double angle, double focaldistance) - Create a stereo shear matrix and
concatenate it with the current transformation. This can be applied in conjunction with either a perspective
transformation (via Frustum or Projection) or an orthographic projection. You must specify the distance from
the camera plane to the focal plane, and the angle between the distance vector and the eye. The angle should
be negative for the left eye, and positive for the right. This method works via Oblique.
obj.SetupCamera (double position[3], double focalpoint[3], double viewup[3])
- Set a view transformation matrix for the camera (this matrix does not contain any perspective) and concatenate it with the current transformation.
obj.SetupCamera (double p0, double p1, double p2, double fp0, double
674
31.110 vtkPlane
675
obj.Pop () - Deletes the transformation on the top of the stack and sets the top to the next transformation
on the stack.
vtkAbstractTransform = obj.MakeTransform () - Make a new transform of the same type
you are responsible for deleting the transform when you are done with it.
int = obj.CircuitCheck (vtkAbstractTransform transform) - Check for selfreference. Will return true if concatenating with the specified transform, setting it to be our inverse, or
setting it to be our input will create a circular reference. CircuitCheck is automatically called by SetInput(),
SetInverse(), and Concatenate(vtkXTransform ). Avoid using this function, it is experimental.
long = obj.GetMTime () - Override GetMTime to account for input and concatenation.
31.110
vtkPlane
31.110.1
Usage
vtkPlane provides methods for various plane computations. These include projecting points onto a plane, evaluating
the plane equation, and returning plane normal. vtkPlane is a concrete implementation of the abstract class vtkImplicitFunction.
To create an instance of class vtkPlane, simply invoke its constructor as follows
obj = vtkPlane
31.110.2
Methods
The class vtkPlane has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPlane class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPlane = obj.NewInstance ()
vtkPlane = obj.SafeDownCast (vtkObject o)
double = obj.EvaluateFunction (double x[3])
double = obj.EvaluateFunction (double x, double y, double z)
obj.EvaluateGradient (double x[3], double g[3])
obj.SetNormal (double , double , double ) - Set/get plane normal. Plane is defined by
point and normal.
obj.SetNormal (double a[3]) - Set/get plane normal. Plane is defined by point and normal.
double = obj.
obj.SetOrigin (double , double , double ) - Set/get point through which plane passes.
Plane is defined by point and normal.
obj.SetOrigin (double a[3]) - Set/get point through which plane passes. Plane is defined by
point and normal.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
676
obj.Push (double distance) - Translate the plane in the direction of the normal by the distance
specified. Negative values move the plane in the opposite direction.
obj.ProjectPoint (double x[3], double xproj[3])
obj.GeneralizedProjectPoint (double x[3], double xproj[3])
double = obj.DistanceToPlane (double x[3]) - Return the distance of a point x to a plane
defined by n(x-p0) = 0. The normal n[3] must be magnitude=1.
31.111
vtkPlaneCollection
31.111.1
Usage
vtkPlaneCollection is an object that creates and manipulates lists of objects of type vtkPlane.
To create an instance of class vtkPlaneCollection, simply invoke its constructor as follows
obj = vtkPlaneCollection
31.111.2
Methods
The class vtkPlaneCollection has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkPlaneCollection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPlaneCollection = obj.NewInstance ()
vtkPlaneCollection = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkPlane ) - Add a plane to the list.
vtkPlane = obj.GetNextItem () - Get the next plane in the list.
vtkPlane = obj.GetItem (int i) - Get the ith plane in the list.
31.112
vtkPlanes
31.112.1
Usage
vtkPlanes computes the implicit function and function gradient for a set of planes. The planes must define a convex
space.
The function value is the closest first order distance of a point to the convex region defined by the planes. The
function gradient is the plane normal at the function value. Note that the normals must point outside of the convex
region. Thus, a negative function value means that a point is inside the convex region.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.112 vtkPlanes
677
There are several methods to define the set of planes. The most general is to supply an instance of vtkPoints and an
instance of vtkDataArray. (The points define a point on the plane, and the normals corresponding plane normals.)
Two other specialized ways are to 1) supply six planes defining the view frustrum of a camera, and 2) provide a
bounding box.
To create an instance of class vtkPlanes, simply invoke its constructor as follows
obj = vtkPlanes
31.112.2
Methods
The class vtkPlanes has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPlanes class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPlanes = obj.NewInstance ()
vtkPlanes = obj.SafeDownCast (vtkObject o)
double = obj.EvaluateFunction (double x[3])
double = obj.EvaluateFunction (double x, double y, double z)
obj.EvaluateGradient (double x[3], double n[3])
obj.SetPoints (vtkPoints ) - Specify a list of points defining points through which the planes
pass.
vtkPoints = obj.GetPoints () - Specify a list of points defining points through which the planes
pass.
obj.SetNormals (vtkDataArray normals) - Specify a list of normal vectors for the planes.
There is a one-to-one correspondence between plane points and plane normals.
vtkDataArray = obj.GetNormals () - Specify a list of normal vectors for the planes. There is a
one-to-one correspondence between plane points and plane normals.
obj.SetFrustumPlanes (double planes[24]) - An alternative method to specify six planes
defined by the camera view frustrum. See vtkCamera::GetFrustumPlanes() documentation.
obj.SetBounds (double bounds[6]) - An alternative method to specify six planes defined by a
bounding box. The bounding box is a six-vector defined as (xmin,xmax,ymin,ymax,zmin,zmax). It defines six
planes orthogonal to the x-y-z coordinate axes.
obj.SetBounds (double xmin, double xmax, double ymin, double ymax, double
zmin, double zmax) - An alternative method to specify six planes defined by a bounding box. The
bounding box is a six-vector defined as (xmin,xmax,ymin,ymax,zmin,zmax). It defines six planes orthogonal
to the x-y-z coordinate axes.
int = obj.GetNumberOfPlanes () - Return the number of planes in the set of planes.
vtkPlane = obj.GetPlane (int i) - Create and return a pointer to a vtkPlane object at the ith
position. Asking for a plane outside the allowable range returns NULL. This method always returns the same
object. Use GetPlane(int i, vtkPlane plane) instead
obj.GetPlane (int i, vtkPlane plane) - Create and return a pointer to a vtkPlane object at
the ith position. Asking for a plane outside the allowable range returns NULL. This method always returns the
same object. Use GetPlane(int i, vtkPlane plane) instead
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
678
31.113
vtkPoints
31.113.1
Usage
vtkPoints represents 3D points. The data model for vtkPoints is an array of vx-vy-vz triplets accessible by (point or
cell) id.
To create an instance of class vtkPoints, simply invoke its constructor as follows
obj = vtkPoints
31.113.2
Methods
The class vtkPoints has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPoints class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPoints = obj.NewInstance ()
vtkPoints = obj.SafeDownCast (vtkObject o)
int = obj.Allocate (vtkIdType sz, vtkIdType ext) - Allocate initial memory size.
obj.Initialize () - Return object to instantiated state.
obj.SetData (vtkDataArray ) - Set/Get the underlying data array. This function must be implemented in a concrete subclass to check for consistency. (The tuple size must match the type of data. For
example, 3-tuple data array can be assigned to a vector, normal, or points object, but not a tensor object,
which has a tuple dimension of 9. Scalars, on the other hand, can have tuple dimension from 1-4, depending
on the type of scalar.)
vtkDataArray = obj.GetData () - Set/Get the underlying data array. This function must be implemented in a concrete subclass to check for consistency. (The tuple size must match the type of data. For
example, 3-tuple data array can be assigned to a vector, normal, or points object, but not a tensor object,
which has a tuple dimension of 9. Scalars, on the other hand, can have tuple dimension from 1-4, depending
on the type of scalar.)
int = obj.GetDataType () - Return the underlying data type. An integer indicating data type is
returned as specified in vtkSetGet.h.
obj.SetDataType (int dataType) - Specify the underlying data type of the object.
obj.SetDataTypeToBit () - Specify the underlying data type of the object.
obj.SetDataTypeToChar () - Specify the underlying data type of the object.
obj.SetDataTypeToUnsignedChar () - Specify the underlying data type of the object.
obj.SetDataTypeToShort () - Specify the underlying data type of the object.
obj.SetDataTypeToUnsignedShort () - Specify the underlying data type of the object.
obj.SetDataTypeToInt () - Specify the underlying data type of the object.
obj.SetDataTypeToUnsignedInt () - Specify the underlying data type of the object.
obj.SetDataTypeToLong () - Specify the underlying data type of the object.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.113 vtkPoints
679
680
31.114
vtkPoints2D
31.114.1
Usage
vtkPoints2D represents 2D points. The data model for vtkPoints2D is an array of vx-vy doublets accessible by (point
or cell) id.
To create an instance of class vtkPoints2D, simply invoke its constructor as follows
obj = vtkPoints2D
31.114.2
Methods
The class vtkPoints2D has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPoints2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPoints2D = obj.NewInstance ()
vtkPoints2D = obj.SafeDownCast (vtkObject o)
int = obj.Allocate (vtkIdType sz, vtkIdType ext) - Allocate initial memory size.
obj.Initialize () - Return object to instantiated state.
obj.SetData (vtkDataArray ) - Set/Get the underlying data array. This function must be implemented in a concrete subclass to check for consistency. (The tuple size must match the type of data. For
example, 3-tuple data array can be assigned to a vector, normal, or points object, but not a tensor object,
which has a tuple dimension of 9. Scalars, on the other hand, can have tuple dimension from 1-4, depending
on the type of scalar.)
vtkDataArray = obj.GetData () - Return the underlying data type. An integer indicating data type
is returned as specified in vtkSetGet.h.
int = obj.GetDataType () - Return the underlying data type. An integer indicating data type is
returned as specified in vtkSetGet.h.
obj.SetDataType (int dataType) - Specify the underlying data type of the object.
obj.SetDataTypeToBit () - Specify the underlying data type of the object.
obj.SetDataTypeToChar () - Specify the underlying data type of the object.
obj.SetDataTypeToUnsignedChar () - Specify the underlying data type of the object.
obj.SetDataTypeToShort () - Specify the underlying data type of the object.
obj.SetDataTypeToUnsignedShort () - Specify the underlying data type of the object.
obj.SetDataTypeToInt () - Specify the underlying data type of the object.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.114 vtkPoints2D
681
682
31.115
vtkPolynomialSolversUnivariate
31.115.1
Usage
vtkPolynomialSolversUnivariate provides solvers for univariate polynomial equations with real coefficients. The
Tartaglia-Cardan and Ferrari solvers work on polynomials of fixed degree 3 and 4, respectively. The Lin-Bairstow
and Sturm solvers work on polynomials of arbitrary degree. The Sturm solver is the most robust solver but only
reports roots within an interval and does not report multiplicities. The Lin-Bairstow solver reports multiplicities.
For difficult polynomials, you may wish to use FilterRoots to eliminate some of the roots reported by the Sturm
solver. FilterRoots evaluates the derivatives near each root to eliminate cases where a local minimum or maximum
is close to zero.
.SECTION Thanks Thanks to Philippe Pebay, Korben Rusek, David Thompson, and Maurice Rojas for implementing
these solvers.
To create an instance of class vtkPolynomialSolversUnivariate, simply invoke its constructor as follows
obj = vtkPolynomialSolversUnivariate
31.115.2
Methods
The class vtkPolynomialSolversUnivariate has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPolynomialSolversUnivariate class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPolynomialSolversUnivariate = obj.NewInstance ()
vtkPolynomialSolversUnivariate = obj.SafeDownCast (vtkObject o)
31.116
vtkPriorityQueue
31.116.1
Usage
vtkPriorityQueue is a general object for creating and manipulating lists of object ids (e.g., point or cell ids). Object
ids are sorted according to a user-specified priority, where entries at the top of the queue have the smallest values.
This implementation provides a feature beyond the usual ability to insert and retrieve (or pop) values from the queue.
It is also possible to pop any item in the queue given its id number. This allows you to delete entries in the queue
which can useful for reinserting an item into the queue.
To create an instance of class vtkPriorityQueue, simply invoke its constructor as follows
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.117 vtkProp
683
obj = vtkPriorityQueue
31.116.2
Methods
The class vtkPriorityQueue has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkPriorityQueue class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPriorityQueue = obj.NewInstance ()
vtkPriorityQueue = obj.SafeDownCast (vtkObject o)
obj.Allocate (vtkIdType sz, vtkIdType ext) - Allocate initial space for priority queue.
obj.Insert (double priority, vtkIdType id) - Insert id with priority specified. The id is
generally an index like a point id or cell id.
vtkIdType = obj.Pop (vtkIdType location) - Same as above but simplified for easier wrapping into interpreted languages.
vtkIdType = obj.Peek (vtkIdType location) - Peek into the queue without actually removing anything. Returns the id.
double = obj.DeleteId (vtkIdType id) - Delete entry in queue with specified id. Returns priority value associated with that id; or VTK_DOUBLE_MAX if not in queue.
double = obj.GetPriority (vtkIdType id) - Get the priority of an entry in the queue with
specified id. Returns priority value of that id or VTK_DOUBLE_MAX if not in queue.
vtkIdType = obj.GetNumberOfItems () - Return the number of items in this queue.
obj.Reset () - Empty the queue but without releasing memory. This avoids the overhead of memory
allocation/deletion.
31.117
vtkProp
31.117.1
Usage
vtkProp is an abstract superclass for any objects that can exist in a rendered scene (either 2D or 3D). Instances of
vtkProp may respond to various render methods (e.g., RenderOpaqueGeometry()). vtkProp also defines the API
for picking, LOD manipulation, and common instance variables that control visibility, picking, and dragging.
To create an instance of class vtkProp, simply invoke its constructor as follows
obj = vtkProp
31.117.2
Methods
The class vtkProp has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkProp class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
684
31.118 vtkPropCollection
685
obj.UseBoundsOn () - In case the Visibility flag is true, tell if the bounds of this prop should be taken
into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
Initial value is true.
obj.UseBoundsOff () - In case the Visibility flag is true, tell if the bounds of this prop should be taken
into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
Initial value is true.
double = obj.GetBounds () - Shallow copy of this vtkProp.
obj.ShallowCopy (vtkProp prop) - Shallow copy of this vtkProp.
obj.InitPathTraversal () - vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). The following methods interface with the picking classes and return "pick paths".
A pick path is a hierarchical, ordered list of props that form an assembly. Most often, when a vtkProp is
picked, its path consists of a single node (i.e., the prop). However, classes like vtkAssembly and vtkPropAssembly can return more than one path, each path being several layers deep. (See vtkAssemblyPath for
more information.) To use these methods - first invoke InitPathTraversal() followed by repeated calls to GetNextPath(). GetNextPath() returns a NULL pointer when the list is exhausted.
vtkAssemblyPath = obj.GetNextPath () - vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). The following methods interface with the picking classes
and return "pick paths". A pick path is a hierarchical, ordered list of props that form an assembly. Most
often, when a vtkProp is picked, its path consists of a single node (i.e., the prop). However, classes like vtkAssembly and vtkPropAssembly can return more than one path, each path being several layers deep. (See
vtkAssemblyPath for more information.) To use these methods - first invoke InitPathTraversal() followed by
repeated calls to GetNextPath(). GetNextPath() returns a NULL pointer when the list is exhausted.
int = obj.GetNumberOfPaths () - These methods are used by subclasses to place a matrix (if
any) in the prop prior to rendering. Generally used only for picking. See vtkProp3D for more information.
obj.PokeMatrix (vtkMatrix4x4 ) - These methods are used by subclasses to place a matrix (if
any) in the prop prior to rendering. Generally used only for picking. See vtkProp3D for more information.
vtkMatrix4x4 = obj.GetMatrix () - Set/Get property keys. Property keys can be digest by some
rendering passes. For instance, the user may mark a prop as a shadow caster for a shadow mapping render
pass. Keys are documented in render pass classes. Initial value is NULL.
vtkInformation = obj.GetPropertyKeys () - Set/Get property keys. Property keys can be
digest by some rendering passes. For instance, the user may mark a prop as a shadow caster for a shadow
mapping render pass. Keys are documented in render pass classes. Initial value is NULL.
obj.SetPropertyKeys (vtkInformation keys) - Set/Get property keys. Property keys can be
digest by some rendering passes. For instance, the user may mark a prop as a shadow caster for a shadow
mapping render pass. Keys are documented in render pass classes. Initial value is NULL.
bool = obj.HasKeys (vtkInformation requiredKeys) - Tells if the prop has all the required
keys.
Precondition
keys_can_be_null: requiredKeys==0 || requiredKeys!=0
31.118
vtkPropCollection
686
31.118.1
Usage
vtkPropCollection represents and provides methods to manipulate a list of Props (i.e., vtkProp and subclasses).
The list is unsorted and duplicate entries are not prevented.
To create an instance of class vtkPropCollection, simply invoke its constructor as follows
obj = vtkPropCollection
31.118.2
Methods
The class vtkPropCollection has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkPropCollection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPropCollection = obj.NewInstance ()
vtkPropCollection = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkProp a) - Add an Prop to the list.
vtkProp = obj.GetNextProp () - Get the next Prop in the list.
vtkProp = obj.GetLastProp () - Get the last Prop in the list.
int = obj.GetNumberOfPaths () - Get the number of paths contained in this list. (Recall that a vtkProp can consist of multiple parts.) Used in picking and other activities to get the parts of composite entities
like vtkAssembly or vtkPropAssembly.
31.119
vtkProperty2D
31.119.1
Usage
vtkProperty2D contains properties used to render two dimensional images and annotations.
To create an instance of class vtkProperty2D, simply invoke its constructor as follows
obj = vtkProperty2D
31.119.2
Methods
The class vtkProperty2D has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkProperty2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkProperty2D = obj.NewInstance ()
vtkProperty2D = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.119 vtkProperty2D
687
688
31.120
vtkQuadratureSchemeDefinition
31.120.1
Usage
An Elemental data type that holds a definition of a numerical quadrature scheme. The definition contains the
requisite information to interpolate to the so called quadrature points of the specific scheme. namely:
1)
A matrix of shape function weights(shape functions evaluated
at parametric coordinates of the quadrature points).
2)
The number of quadrature points and cell nodes. These parameters
size the matrix, and allow for convinent evaluation by users
of the definition.
31.120.2
Methods
The class vtkQuadratureSchemeDefinition has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.121 vtkQuadric
689
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadratureSchemeDefinition class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuadratureSchemeDefinition = obj.NewInstance ()
vtkQuadratureSchemeDefinition = obj.SafeDownCast (vtkObject o)
int = obj.DeepCopy (vtkQuadratureSchemeDefinition other) - Deep copy.
int = obj.SaveState (vtkXMLDataElement e) - Put the object into an XML representation.
The element passed in is assumed to be empty.
int = obj.RestoreState (vtkXMLDataElement e) - Restore the object from an XML representation.
obj.Clear () - Release all allocated resources and set the object to an unitialized state.
obj.Initialize (int cellType, int numberOfNodes, int numberOfQuadraturePoints, double shapeFunctionWeights) - Initialize the object allocating resources as needed.
obj.Initialize (int cellType, int numberOfNodes, int numberOfQuadraturePoints, double shapeFunctionWeights, double quadratureWeights) - Initialize the
object allocating resources as needed.
int = obj.GetCellType () const - Access to an alternative key.
int = obj.GetQuadratureKey () const - Get the number of nodes associated with the interpolation.
int = obj.GetNumberOfNodes () const - Get the number of quadrature points associated with
the scheme.
int = obj.GetNumberOfQuadraturePoints () const - Get the array of shape function
weights. Shape function weights are the shape functions evaluated at the quadrature points. There are
"NumberOfNodes" weights for each quadrature point.
31.121
vtkQuadric
31.121.1
Usage
vtkQuadric evaluates the quadric function F(x,y,z) = a0x 2 + a1y 2 + a2z 2 + a3xy + a4yz + a5xz +
a6x + a7y + a8z + a9. vtkQuadric is a concrete implementation of vtkImplicitFunction.
To create an instance of class vtkQuadric, simply invoke its constructor as follows
obj = vtkQuadric
31.121.2
Methods
The class vtkQuadric has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkQuadric class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
690
a4, double a5, double a6, double a7, double a8, double a9)
double = obj.
31.122
GetCoefficients ()
vtkRandomSequence
31.122.1
Usage
31.122.2
Methods
The class vtkRandomSequence has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRandomSequence class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRandomSequence = obj.NewInstance ()
vtkRandomSequence = obj.SafeDownCast (vtkObject o)
double = obj.GetValue () - Current value
obj.Next () - Move to the next number in the random sequence.
31.123
vtkReferenceCount
31.124 vtkRungeKutta2
31.123.1
691
Usage
31.123.2
Methods
The class vtkReferenceCount has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkReferenceCount class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkReferenceCount = obj.NewInstance ()
vtkReferenceCount = obj.SafeDownCast (vtkObject o)
31.124
vtkRungeKutta2
31.124.1
Usage
This is a concrete sub-class of vtkInitialValueProblemSolver. It uses a 2nd order Runge-Kutta method to obtain the
values of a set of functions at the next time step.
To create an instance of class vtkRungeKutta2, simply invoke its constructor as follows
obj = vtkRungeKutta2
31.124.2
Methods
The class vtkRungeKutta2 has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkRungeKutta2 class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRungeKutta2 = obj.NewInstance ()
vtkRungeKutta2 = obj.SafeDownCast (vtkObject o)
31.125
vtkRungeKutta4
692
31.125.1
Usage
This is a concrete sub-class of vtkInitialValueProblemSolver. It uses a 4th order Runge-Kutta method to obtain the
values of a set of functions at the next time step.
To create an instance of class vtkRungeKutta4, simply invoke its constructor as follows
obj = vtkRungeKutta4
31.125.2
Methods
The class vtkRungeKutta4 has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkRungeKutta4 class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRungeKutta4 = obj.NewInstance ()
vtkRungeKutta4 = obj.SafeDownCast (vtkObject o)
31.126
vtkRungeKutta45
31.126.1
Usage
This is a concrete sub-class of vtkInitialValueProblemSolver. It uses a 5th order Runge-Kutta method with stepsize
control to obtain the values of a set of functions at the next time step. The stepsize is adjusted by calculating an
estimated error using an embedded 4th order Runge-Kutta formula: Press, W. H. et al., 1992, Numerical Recipes
in Fortran, Second Edition, Cambridge University Press Cash, J.R. and Karp, A.H. 1990, ACM Transactions on
Mathematical Software, vol 16, pp 201-222
To create an instance of class vtkRungeKutta45, simply invoke its constructor as follows
obj = vtkRungeKutta45
31.126.2
Methods
The class vtkRungeKutta45 has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkRungeKutta45 class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRungeKutta45 = obj.NewInstance ()
vtkRungeKutta45 = obj.SafeDownCast (vtkObject o)
31.127
vtkScalarsToColors
31.127 vtkScalarsToColors
31.127.1
693
Usage
vtkScalarsToColors is a general purpose superclass for objects that convert scalars to colors. This include vtkLookupTable classes and color transfer functions.
The scalars to color mapping can be augmented with an additional uniform alpha blend. This is used, for example,
to blend a vtkActors opacity with the lookup table values.
To create an instance of class vtkScalarsToColors, simply invoke its constructor as follows
obj = vtkScalarsToColors
31.127.2
Methods
The class vtkScalarsToColors has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkScalarsToColors class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkScalarsToColors = obj.NewInstance ()
vtkScalarsToColors = obj.SafeDownCast (vtkObject o)
int = obj.IsOpaque () - Return true if all of the values defining the mapping have an opacity equal
to 1. Default implementation return true.
obj.Build () - Perform any processing required (if any) before processing scalars.
double = obj.GetRange () - Sets/Gets the range of scalars which will be mapped.
obj.SetRange (double min, double max) - Sets/Gets the range of scalars which will be
mapped.
obj.SetRange (double rng[2]) - Map one value through the lookup table and return a color defined as a RGBA unsigned char tuple (4 bytes).
obj.GetColor (double v, double rgb[3]) - Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1.
double = obj.GetColor (double v) - Map one value through the lookup table and return the
alpha value (the opacity) as a double between 0 and 1.
double = obj.GetOpacity (double ) - Map one value through the lookup table and return the
luminance 0.3red + 0.59green + 0.11blue as a double between 0 and 1. Returns the luminance value for
the specified scalar value.
double = obj.GetLuminance (double x) - Specify an additional opacity (alpha) value to blend
with. Values != 1 modify the resulting color consistent with the requested form of the output. This is typically
used by an actor in order to blend its opacity.
obj.SetAlpha (double alpha) - Specify an additional opacity (alpha) value to blend with. Values
!= 1 modify the resulting color consistent with the requested form of the output. This is typically used by an
actor in order to blend its opacity.
double = obj.GetAlpha () - Specify an additional opacity (alpha) value to blend with. Values != 1
modify the resulting color consistent with the requested form of the output. This is typically used by an actor
in order to blend its opacity.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
694
31.128
vtkServerSocket
31.128.1
Usage
31.128.2
Methods
The class vtkServerSocket has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkServerSocket class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.129 vtkShortArray
695
31.129
vtkShortArray
31.129.1
Usage
vtkShortArray is an array of values of type short. It provides methods for insertion and retrieval of values and will
automatically resize itself to hold new data.
To create an instance of class vtkShortArray, simply invoke its constructor as follows
obj = vtkShortArray
31.129.2
Methods
The class vtkShortArray has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkShortArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkShortArray = obj.NewInstance ()
vtkShortArray = obj.SafeDownCast (vtkObject o)
int = obj.GetDataType () - Copy the tuple value into a user-provided array.
obj.GetTupleValue (vtkIdType i, short tuple) - Set the tuple value at the ith location in
the array.
obj.SetTupleValue (vtkIdType i, short tuple) - Insert (memory allocation performed)
the tuple into the ith location in the array.
obj.InsertTupleValue (vtkIdType i, short tuple) - Insert (memory allocation performed) the tuple onto the end of the array.
vtkIdType = obj.InsertNextTupleValue (short tuple) - Get the data at a particular index.
short = obj.GetValue (vtkIdType id) - Set the data at a particular index. Does not do range
checking. Make sure you use the method SetNumberOfValues() before inserting data.
obj.SetValue (vtkIdType id, short value) - Specify the number of values for this object to
hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for
fast insertion.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
696
31.130
vtkSignedCharArray
31.130.1
Usage
vtkSignedCharArray is an array of values of type signed char. It provides methods for insertion and retrieval of
values and will automatically resize itself to hold new data.
To create an instance of class vtkSignedCharArray, simply invoke its constructor as follows
obj = vtkSignedCharArray
31.130.2
Methods
The class vtkSignedCharArray has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkSignedCharArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSignedCharArray = obj.NewInstance ()
vtkSignedCharArray = obj.SafeDownCast (vtkObject o)
int = obj.GetDataType () - Copy the tuple value into a user-provided array.
signed = obj.char GetValue (vtkIdType id) - Set the data at a particular index. Does not
do range checking. Make sure you use the method SetNumberOfValues() before inserting data.
obj.SetValue (vtkIdType id, signed char value) - Specify the number of values for this
object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue()
method for fast insertion.
obj.SetNumberOfValues (vtkIdType number) - Insert data at a specified position in the array.
obj.InsertValue (vtkIdType id, signed char f) - Insert data at the end of the array. Return its location in the array.
vtkIdType = obj.InsertNextValue (signed char f) - Get the address of a particular data
index. Make sure data is allocated for the number of items requested. Set MaxId according to the number of
data values requested.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.131 vtkSocket
697
31.131
vtkSocket
31.131.1
Usage
This abstract class encapsulates a BSD socket. It provides an API for basic socket operations.
To create an instance of class vtkSocket, simply invoke its constructor as follows
obj = vtkSocket
31.131.2
Methods
The class vtkSocket has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkSocket class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSocket = obj.NewInstance ()
vtkSocket = obj.SafeDownCast (vtkObject o)
int = obj.GetConnected () - Close the socket.
obj.CloseSocket () - These methods send data over the socket. Returns 1 on success, 0 on error
and raises vtkCommand::ErrorEvent.
31.132
vtkSocketCollection
31.132.1
Usage
Apart from being vtkCollection subclass for sockets, this class provides means to wait for activity on all the sockets
in the collection simultaneously.
To create an instance of class vtkSocketCollection, simply invoke its constructor as follows
obj = vtkSocketCollection
698
31.132.2
Methods
The class vtkSocketCollection has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkSocketCollection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSocketCollection = obj.NewInstance ()
vtkSocketCollection = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkSocket soc)
int = obj.SelectSockets (long msec) - Select all Connected sockets in the collection. If msec
is specified, it timesout after msec milliseconds on inactivity. Returns 0 on timeout, -1 on error; 1 is a socket
was selected. The selected socket can be retrieved by GetLastSelectedSocket().
vtkSocket = obj.GetLastSelectedSocket () - Overridden to unset SelectedSocket.
obj.ReplaceItem (int i, vtkObject ) - Overridden to unset SelectedSocket.
obj.RemoveItem (int i) - Overridden to unset SelectedSocket.
obj.RemoveItem (vtkObject ) - Overridden to unset SelectedSocket.
obj.RemoveAllItems () - Overridden to unset SelectedSocket.
31.133
vtkSphericalTransform
31.133.1
Usage
vtkSphericalTransform will convert (r,phi,theta) coordinates to (x,y,z) coordinates and back again. The angles are
given in radians. By default, it converts spherical coordinates to rectangular, but GetInverse() returns a transform
that will do the opposite. The equation that is used is x = rsin(phi)cos(theta), y = rsin(phi)sin(theta), z =
rcos(phi).
To create an instance of class vtkSphericalTransform, simply invoke its constructor as follows
obj = vtkSphericalTransform
31.133.2
Methods
The class vtkSphericalTransform has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSphericalTransform class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSphericalTransform = obj.NewInstance ()
vtkSphericalTransform = obj.SafeDownCast (vtkObject o)
vtkAbstractTransform = obj.MakeTransform () - Make another transform of the same type.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.134 vtkStringArray
31.134
699
vtkStringArray
31.134.1
Usage
Points and cells may sometimes have associated data that are stored as strings, e.g. many information visualization
projects. This class provides a reasonably clean way to store and access those.
To create an instance of class vtkStringArray, simply invoke its constructor as follows
obj = vtkStringArray
31.134.2
Methods
The class vtkStringArray has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkStringArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStringArray = obj.NewInstance ()
vtkStringArray = obj.SafeDownCast (vtkObject o)
int = obj.GetDataType ()
int = obj.IsNumeric () - Release storage and reset array to initial state.
obj.Initialize () - Release storage and reset array to initial state.
int = obj.GetDataTypeSize () - Return the size of the data type. WARNING: This may not mean
what you expect with strings. It will return sizeof(vtkstd::string) and not take into account the data included in
any particular string.
obj.Squeeze () - Resize the array while conserving the data.
int = obj.Resize (vtkIdType numTuples) - Resize the array while conserving the data.
obj.SetTuple (vtkIdType i, vtkIdType j, vtkAbstractArray source) - Set the
tuple at the ith location using the jth tuple in the source array. This method assumes that the two arrays
have the same type and structure. Note that range checking and memory allocation is not performed; use in
conjunction with SetNumberOfTuples() to allocate space.
obj.InsertTuple (vtkIdType i, vtkIdType j, vtkAbstractArray source) - Insert the jth tuple in the source array, at ith location in this array. Note that memory allocation is performed as
necessary to hold the data.
vtkIdType = obj.InsertNextTuple (vtkIdType j, vtkAbstractArray source) Insert the jth tuple in the source array, at the end in this array. Note that memory allocation is performed as
necessary to hold the data. Returns the location at which the data was inserted.
obj.InterpolateTuple (vtkIdType i, vtkIdList ptIndices, vtkAbstractArray source, double weights) - Set the ith tuple in this array as the interpolated tuple value,
given the ptIndices in the source array and associated interpolation weights. This method assumes that the
two arrays are of the same type and strcuture.
obj.InterpolateTuple (vtkIdType i, vtkIdType id1, vtkAbstractArray source1,
700
31.135 vtkStructuredData
701
obj.ClearLookup () - Delete the associated fast lookup data structure on this array, if it exists. The
lookup will be rebuilt on the next call to a lookup function.
31.135
vtkStructuredData
31.135.1
Usage
vtkStructuredData is an abstract class that specifies an interface for topologically regular data. Regular data is data
that can be accessed in rectangular fashion using an i-j-k index. A finite difference grid, a volume, or a pixmap are
all considered regular.
To create an instance of class vtkStructuredData, simply invoke its constructor as follows
obj = vtkStructuredData
31.135.2
Methods
The class vtkStructuredData has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredData = obj.NewInstance ()
vtkStructuredData = obj.SafeDownCast (vtkObject o)
31.136
vtkStructuredVisibilityConstraint
31.136.1
Usage
31.136.2
Methods
The class vtkStructuredVisibilityConstraint has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredVisibilityConstraint class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
702
obj.Initialize (int dims[3]) - Set the dimensions and set the Initialized flag to 1. Once an
object is initialized, its dimensions can not be changed anymore.
obj.SetVisibilityById (vtkUnsignedCharArray vis) - Set/Get the array used to store the
visibility flags.
vtkUnsignedCharArray = obj.GetVisibilityById () - Set/Get the array used to store the
visibility flags.
obj.ShallowCopy (vtkStructuredVisibilityConstraint src) - Copies the dimensions,
the visibility array pointer and the initialized flag.
obj.DeepCopy (vtkStructuredVisibilityConstraint src) - Copies the dimensions, the
visibility array and the initialized flag.
char = obj.IsConstrained ()
31.137
vtkTableExtentTranslator
31.137.1
Usage
31.137.2
Methods
The class vtkTableExtentTranslator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTableExtentTranslator
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTableExtentTranslator = obj.NewInstance ()
vtkTableExtentTranslator = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.138 vtkTensor
703
Level, int wholeExtent, int resultExtent, int splitMode, int byPoints) Not supported by this subclass of vtkExtentTranslator.
obj.SetExtentForPiece (int piece, int extent) - Set the extent to be used for a piece.
This sets the extent table entry for the piece.
obj.GetExtentForPiece (int piece, int extent) - Get the extent table entry for the given
piece. This is only for code that is setting up the table. Extent translation should always be done through the
PieceToExtent method.
obj.SetMaximumGhostLevel (int ) - Set the maximum ghost level that can be requested. This
can be used by a reader to make sure an extent request does not go outside the boundaries of the pieces
file.
int = obj.GetMaximumGhostLevel () - Set the maximum ghost level that can be requested. This
can be used by a reader to make sure an extent request does not go outside the boundaries of the pieces
file.
obj.SetPieceAvailable (int piece, int available) - Get/Set whether the given piece is
available. Requesting a piece that is not available will produce errors in the pipeline.
int = obj.GetPieceAvailable (int piece) - Get/Set whether the given piece is available.
Requesting a piece that is not available will produce errors in the pipeline.
31.138
vtkTensor
31.138.1
Usage
vtkTensor is a floating point representation of an nxn tensor. vtkTensor provides methods for assignment and
reference of tensor components. It does it in such a way as to minimize data copying.
To create an instance of class vtkTensor, simply invoke its constructor as follows
obj = vtkTensor
31.138.2
Methods
The class vtkTensor has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkTensor class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
704
31.139
vtkThreadMessager
31.139.1
Usage
vtkMultithreader is a class that provides support for messaging between threads multithreaded using pthreads or
Windows messaging.
To create an instance of class vtkThreadMessager, simply invoke its constructor as follows
obj = vtkThreadMessager
31.139.2
Methods
The class vtkThreadMessager has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkThreadMessager class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkThreadMessager = obj.NewInstance ()
vtkThreadMessager = obj.SafeDownCast (vtkObject o)
obj.WaitForMessage () - Wait (block, non-busy) until another thread sends a message.
obj.SendWakeMessage () - Send a message to all threads who are waiting via WaitForMessage().
obj.EnableWaitForReceiver () - pthreads only. If the wait is enabled, the thread who is to call
WaitForMessage() will block until a receiver thread is ready to receive.
obj.DisableWaitForReceiver () - pthreads only. If the wait is enabled, the thread who is to call
WaitForMessage() will block until a receiver thread is ready to receive.
obj.WaitForReceiver () - pthreads only. If wait is enable, this will block until one thread is ready to
receive a message.
obj.SendMessage () -
31.140
vtkTimePointUtility
31.141 vtkTimerLog
31.140.1
705
Usage
31.140.2
Methods
The class vtkTimePointUtility has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTimePointUtility class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTimePointUtility = obj.NewInstance ()
vtkTimePointUtility = obj.SafeDownCast (vtkObject o)
31.141
vtkTimerLog
31.141.1
Usage
vtkTimerLog contains walltime and cputime measurements associated with a given event. These results can be
later analyzed when "dumping out" the table.
In addition, vtkTimerLog allows the user to simply get the current time, and to start/stop a simple timer separate
from the timing table logging.
To create an instance of class vtkTimerLog, simply invoke its constructor as follows
obj = vtkTimerLog
31.141.2
Methods
The class vtkTimerLog has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkTimerLog class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTimerLog = obj.NewInstance ()
vtkTimerLog = obj.SafeDownCast (vtkObject o)
obj.StartTimer () - Set the StartTime to the current time. Used with GetElapsedTime().
obj.StopTimer () - Sets EndTime to the current time. Used with GetElapsedTime().
double = obj.GetElapsedTime () - Returns the difference between StartTime and EndTime as a
doubleing point value indicating the elapsed time in seconds.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
706
31.142
vtkTransform
31.142.1
Usage
A vtkTransform can be used to describe the full range of linear (also known as affine) coordinate transformations in
three dimensions, which are internally represented as a 4x4 homogeneous transformation matrix. When you create
a new vtkTransform, it is always initialized to the identity transformation.
The SetInput() method allows you to set another transform, instead of the identity transform, to be the base transformation. There is a pipeline mechanism to ensure that when the input is modified, the current transformation will
be updated accordingly. This pipeline mechanism is also supported by the Concatenate() method.
Most of the methods for manipulating this transformation, e.g. Translate, Rotate, and Concatenate, can operate in
either PreMultiply (the default) or PostMultiply mode. In PreMultiply mode, the translation, concatenation, etc. will
occur before any transformations which are represented by the current matrix. In PostMultiply mode, the additional
transformation will occur after any transformations represented by the current matrix.
This class performs all of its operations in a right handed coordinate system with right handed rotations. Some other
graphics libraries use left handed coordinate systems and rotations.
To create an instance of class vtkTransform, simply invoke its constructor as follows
obj = vtkTransform
31.142.2
Methods
The class vtkTransform has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkTransform class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTransform = obj.NewInstance ()
vtkTransform = obj.SafeDownCast (vtkObject o)
obj.Identity () - Set the transformation to the identity transformation. If the transform has an Input,
then the transformation will be reset so that it is the same as the Input.
obj.Inverse () - Invert the transformation. This will also set a flag so that the transformation will use
the inverse of its Input, if an Input has been set.
obj.Translate (double x, double y, double z) - Create a translation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.
obj.Translate (double x[3]) - Create a translation matrix and concatenate it with the current
transformation according to PreMultiply or PostMultiply semantics.
obj.Translate (float x[3]) - Create a translation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.
obj.RotateWXYZ (double angle, double x, double y, double z) - Create a rotation
matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.
The angle is in degrees, and (x,y,z) specifies the axis that the rotation will be performed around.
obj.RotateWXYZ (double angle, double axis[3]) - Create a rotation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics. The angle is in
degrees, and (x,y,z) specifies the axis that the rotation will be performed around.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.142 vtkTransform
707
obj.RotateWXYZ (double angle, float axis[3]) - Create a rotation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics. The angle is in
degrees, and (x,y,z) specifies the axis that the rotation will be performed around.
obj.RotateX (double angle) - Create a rotation matrix about the X, Y, or Z axis and concatenate it
with the current transformation according to PreMultiply or PostMultiply semantics. The angle is expressed in
degrees.
obj.RotateY (double angle) - Create a rotation matrix about the X, Y, or Z axis and concatenate it
with the current transformation according to PreMultiply or PostMultiply semantics. The angle is expressed in
degrees.
obj.RotateZ (double angle) - Create a rotation matrix about the X, Y, or Z axis and concatenate it
with the current transformation according to PreMultiply or PostMultiply semantics. The angle is expressed in
degrees.
obj.Scale (double x, double y, double z) - Create a scale matrix (i.e. set the diagonal
elements to x, y, z) and concatenate it with the current transformation according to PreMultiply or PostMultiply
semantics.
obj.Scale (double s[3]) - Create a scale matrix (i.e. set the diagonal elements to x, y, z) and
concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.
obj.Scale (float s[3]) - Create a scale matrix (i.e. set the diagonal elements to x, y, z) and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.
obj.SetMatrix (vtkMatrix4x4 matrix) - Set the current matrix directly. This actually calls Identity(), followed by Concatenate(matrix).
obj.SetMatrix (double elements[16]) - Set the current matrix directly. This actually calls Identity(), followed by Concatenate(matrix).
obj.Concatenate (vtkMatrix4x4 matrix) - Concatenates the matrix with the current transformation according to PreMultiply or PostMultiply semantics.
obj.Concatenate (double elements[16]) - Concatenates the matrix with the current transformation according to PreMultiply or PostMultiply semantics.
obj.Concatenate (vtkLinearTransform transform) - Concatenate the specified transform
with the current transformation according to PreMultiply or PostMultiply semantics. The concatenation is
pipelined, meaning that if any of the transformations are changed, even after Concatenate() is called, those
changes will be reflected when you call TransformPoint().
obj.PreMultiply () - Sets the internal state of the transform to PreMultiply. All subsequent operations
will occur before those already represented in the current transformation. In homogeneous matrix notation,
M = MA where M is the current transformation matrix and A is the applied matrix. The default is PreMultiply.
obj.PostMultiply () - Sets the internal state of the transform to PostMultiply. All subsequent operations will occur after those already represented in the current transformation. In homogeneous matrix
notation, M = AM where M is the current transformation matrix and A is the applied matrix. The default is
PreMultiply.
int = obj.GetNumberOfConcatenatedTransforms () - Get the total number of transformations that are linked into this one via Concatenate() operations or via SetInput().
vtkLinearTransform = obj.GetConcatenatedTransform (int i) - Get the x, y, z orientation angles from the transformation matrix as an array of three floating point values.
obj.GetOrientation (double orient[3]) - Get the x, y, z orientation angles from the transformation matrix as an array of three floating point values.
obj.GetOrientation (float orient[3]) - Get the x, y, z orientation angles from the transformation matrix as an array of three floating point values.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
708
31.143 vtkTransform2D
709
31.143
vtkTransform2D
31.143.1
Usage
A vtkTransform2D can be used to describe the full range of linear (also known as affine) coordinate transformations
in two dimensions, which are internally represented as a 3x3 homogeneous transformation matrix. When you create
a new vtkTransform2D, it is always initialized to the identity transformation.
This class performs all of its operations in a right handed coordinate system with right handed rotations. Some other
graphics libraries use left handed coordinate systems and rotations.
To create an instance of class vtkTransform2D, simply invoke its constructor as follows
obj = vtkTransform2D
31.143.2
Methods
The class vtkTransform2D has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkTransform2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTransform2D = obj.NewInstance ()
vtkTransform2D = obj.SafeDownCast (vtkObject o)
obj.Identity () - Set the transformation to the identity transformation.
obj.Inverse () - Invert the transformation.
obj.Translate (double x, double y) - Create a translation matrix and concatenate it with the
current transformation.
obj.Translate (double x[2]) - Create a translation matrix and concatenate it with the current
transformation.
obj.Translate (float x[2]) - Create a rotation matrix and concatenate it with the current transformation. The angle is in degrees.
obj.Rotate (double angle) - Create a rotation matrix and concatenate it with the current transformation. The angle is in degrees.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
710
31.144
vtkTransformCollection
31.145 vtkTypeFloat32Array
31.144.1
711
Usage
vtkTransformCollection is an object that creates and manipulates lists of objects of type vtkTransform.
To create an instance of class vtkTransformCollection, simply invoke its constructor as follows
obj = vtkTransformCollection
31.144.2
Methods
The class vtkTransformCollection has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTransformCollection
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTransformCollection = obj.NewInstance ()
vtkTransformCollection = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkTransform ) - Add a Transform to the list.
vtkTransform = obj.GetNextItem () - Get the next Transform in the list. Return NULL when the
end of the list is reached.
31.145
vtkTypeFloat32Array
31.145.1
Usage
vtkTypeFloat32Array is an array of values of type vtkTypeFloat32. It provides methods for insertion and retrieval of
values and will automatically resize itself to hold new data.
To create an instance of class vtkTypeFloat32Array, simply invoke its constructor as follows
obj = vtkTypeFloat32Array
31.145.2
Methods
The class vtkTypeFloat32Array has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTypeFloat32Array class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTypeFloat32Array = obj.NewInstance ()
vtkTypeFloat32Array = obj.SafeDownCast (vtkObject o)
31.146
vtkTypeFloat64Array
712
31.146.1
Usage
vtkTypeFloat64Array is an array of values of type vtkTypeFloat64. It provides methods for insertion and retrieval of
values and will automatically resize itself to hold new data.
To create an instance of class vtkTypeFloat64Array, simply invoke its constructor as follows
obj = vtkTypeFloat64Array
31.146.2
Methods
The class vtkTypeFloat64Array has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTypeFloat64Array class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTypeFloat64Array = obj.NewInstance ()
vtkTypeFloat64Array = obj.SafeDownCast (vtkObject o)
31.147
vtkTypeInt16Array
31.147.1
Usage
vtkTypeInt16Array is an array of values of type vtkTypeInt16. It provides methods for insertion and retrieval of values
and will automatically resize itself to hold new data.
To create an instance of class vtkTypeInt16Array, simply invoke its constructor as follows
obj = vtkTypeInt16Array
31.147.2
Methods
The class vtkTypeInt16Array has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTypeInt16Array class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTypeInt16Array = obj.NewInstance ()
vtkTypeInt16Array = obj.SafeDownCast (vtkObject o)
31.148
vtkTypeInt32Array
31.149 vtkTypeInt64Array
31.148.1
713
Usage
vtkTypeInt32Array is an array of values of type vtkTypeInt32. It provides methods for insertion and retrieval of values
and will automatically resize itself to hold new data.
To create an instance of class vtkTypeInt32Array, simply invoke its constructor as follows
obj = vtkTypeInt32Array
31.148.2
Methods
The class vtkTypeInt32Array has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTypeInt32Array class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTypeInt32Array = obj.NewInstance ()
vtkTypeInt32Array = obj.SafeDownCast (vtkObject o)
31.149
vtkTypeInt64Array
31.149.1
Usage
vtkTypeInt64Array is an array of values of type vtkTypeInt64. It provides methods for insertion and retrieval of values
and will automatically resize itself to hold new data.
To create an instance of class vtkTypeInt64Array, simply invoke its constructor as follows
obj = vtkTypeInt64Array
31.149.2
Methods
The class vtkTypeInt64Array has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTypeInt64Array class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTypeInt64Array = obj.NewInstance ()
vtkTypeInt64Array = obj.SafeDownCast (vtkObject o)
31.150
vtkTypeInt8Array
714
31.150.1
Usage
vtkTypeInt8Array is an array of values of type vtkTypeInt8. It provides methods for insertion and retrieval of values
and will automatically resize itself to hold new data.
To create an instance of class vtkTypeInt8Array, simply invoke its constructor as follows
obj = vtkTypeInt8Array
31.150.2
Methods
The class vtkTypeInt8Array has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkTypeInt8Array class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTypeInt8Array = obj.NewInstance ()
vtkTypeInt8Array = obj.SafeDownCast (vtkObject o)
31.151
vtkTypeUInt16Array
31.151.1
Usage
vtkTypeUInt16Array is an array of values of type vtkTypeUInt16. It provides methods for insertion and retrieval of
values and will automatically resize itself to hold new data.
To create an instance of class vtkTypeUInt16Array, simply invoke its constructor as follows
obj = vtkTypeUInt16Array
31.151.2
Methods
The class vtkTypeUInt16Array has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTypeUInt16Array class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTypeUInt16Array = obj.NewInstance ()
vtkTypeUInt16Array = obj.SafeDownCast (vtkObject o)
31.152
vtkTypeUInt32Array
31.153 vtkTypeUInt64Array
31.152.1
715
Usage
vtkTypeUInt32Array is an array of values of type vtkTypeUInt32. It provides methods for insertion and retrieval of
values and will automatically resize itself to hold new data.
To create an instance of class vtkTypeUInt32Array, simply invoke its constructor as follows
obj = vtkTypeUInt32Array
31.152.2
Methods
The class vtkTypeUInt32Array has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTypeUInt32Array class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTypeUInt32Array = obj.NewInstance ()
vtkTypeUInt32Array = obj.SafeDownCast (vtkObject o)
31.153
vtkTypeUInt64Array
31.153.1
Usage
vtkTypeUInt64Array is an array of values of type vtkTypeUInt64. It provides methods for insertion and retrieval of
values and will automatically resize itself to hold new data.
To create an instance of class vtkTypeUInt64Array, simply invoke its constructor as follows
obj = vtkTypeUInt64Array
31.153.2
Methods
The class vtkTypeUInt64Array has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTypeUInt64Array class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTypeUInt64Array = obj.NewInstance ()
vtkTypeUInt64Array = obj.SafeDownCast (vtkObject o)
31.154
vtkTypeUInt8Array
716
31.154.1
Usage
vtkTypeUInt8Array is an array of values of type vtkTypeUInt8. It provides methods for insertion and retrieval of
values and will automatically resize itself to hold new data.
To create an instance of class vtkTypeUInt8Array, simply invoke its constructor as follows
obj = vtkTypeUInt8Array
31.154.2
Methods
The class vtkTypeUInt8Array has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTypeUInt8Array class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTypeUInt8Array = obj.NewInstance ()
vtkTypeUInt8Array = obj.SafeDownCast (vtkObject o)
31.155
vtkUnicodeStringArray
31.155.1
Usage
31.155.2
Methods
The class vtkUnicodeStringArray has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkUnicodeStringArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkUnicodeStringArray = obj.NewInstance ()
vtkUnicodeStringArray = obj.SafeDownCast (vtkObject o)
int = obj.Allocate (vtkIdType sz, vtkIdType ext)
obj.Initialize ()
int = obj.GetDataType ()
int = obj.GetDataTypeSize ()
int = obj.GetElementComponentSize ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.156 vtkUnsignedCharArray
717
31.156
vtkUnsignedCharArray
31.156.1
Usage
vtkUnsignedCharArray is an array of values of type unsigned char. It provides methods for insertion and retrieval of
values and will automatically resize itself to hold new data.
To create an instance of class vtkUnsignedCharArray, simply invoke its constructor as follows
obj = vtkUnsignedCharArray
31.156.2
Methods
The class vtkUnsignedCharArray has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkUnsignedCharArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkUnsignedCharArray = obj.NewInstance ()
vtkUnsignedCharArray = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
718
31.157
vtkUnsignedIntArray
31.157.1
Usage
vtkUnsignedIntArray is an array of values of type unsigned int. It provides methods for insertion and retrieval of
values and will automatically resize itself to hold new data.
To create an instance of class vtkUnsignedIntArray, simply invoke its constructor as follows
obj = vtkUnsignedIntArray
31.157.2
Methods
The class vtkUnsignedIntArray has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkUnsignedIntArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
31.158 vtkUnsignedLongArray
719
vtkUnsignedIntArray = obj.NewInstance ()
vtkUnsignedIntArray = obj.SafeDownCast (vtkObject o)
int = obj.GetDataType () - Copy the tuple value into a user-provided array.
obj.GetTupleValue (vtkIdType i, int tuple) - Set the tuple value at the ith location in the
array.
obj.SetTupleValue (vtkIdType i, int tuple) - Insert (memory allocation performed) the
tuple into the ith location in the array.
obj.InsertTupleValue (vtkIdType i, int tuple) - Insert (memory allocation performed)
the tuple onto the end of the array.
vtkIdType = obj.InsertNextTupleValue (int tuple) - Get the data at a particular index.
int = obj.GetValue (vtkIdType id) - Set the data at a particular index. Does not do range
checking. Make sure you use the method SetNumberOfValues() before inserting data.
obj.SetValue (vtkIdType id, int value) - Specify the number of values for this object to
hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for
fast insertion.
obj.SetNumberOfValues (vtkIdType number) - Insert data at a specified position in the array.
obj.InsertValue (vtkIdType id, int f) - Insert data at the end of the array. Return its location in the array.
vtkIdType = obj.InsertNextValue (int f) - Get the address of a particular data index. Make
sure data is allocated for the number of items requested. Set MaxId according to the number of data values
requested.
obj.SetArray (int array, vtkIdType size, int save) - This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied
by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory.
The class uses the actual array provided; it does not copy the data from the suppled array.
obj.SetArray (int array, vtkIdType size, int save, int deleteMethod)
31.158
vtkUnsignedLongArray
31.158.1
Usage
vtkUnsignedLongArray is an array of values of type unsigned long. It provides methods for insertion and retrieval of
values and will automatically resize itself to hold new data.
To create an instance of class vtkUnsignedLongArray, simply invoke its constructor as follows
obj = vtkUnsignedLongArray
31.158.2
Methods
The class vtkUnsignedLongArray has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkUnsignedLongArray
class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
720
31.159
vtkUnsignedLongLongArray
31.159.1
Usage
vtkUnsignedLongLongArray is an array of values of type unsigned long long. It provides methods for insertion and
retrieval of values and will automatically resize itself to hold new data.
To create an instance of class vtkUnsignedLongLongArray, simply invoke its constructor as follows
obj = vtkUnsignedLongLongArray
31.160 vtkUnsignedShortArray
31.159.2
721
Methods
The class vtkUnsignedLongLongArray has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkUnsignedLongLongArray
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkUnsignedLongLongArray = obj.NewInstance ()
vtkUnsignedLongLongArray = obj.SafeDownCast (vtkObject o)
int = obj.GetDataType () - Copy the tuple value into a user-provided array.
long = obj.long GetValue (vtkIdType id) - Set the data at a particular index. Does not do
range checking. Make sure you use the method SetNumberOfValues() before inserting data.
obj.SetValue (vtkIdType id, long long value) - Specify the number of values for this object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method
for fast insertion.
obj.SetNumberOfValues (vtkIdType number) - Insert data at a specified position in the array.
obj.InsertValue (vtkIdType id, long long f) - Insert data at the end of the array. Return
its location in the array.
vtkIdType = obj.InsertNextValue (long long f) - Get the address of a particular data
index. Make sure data is allocated for the number of items requested. Set MaxId according to the number of
data values requested.
long = obj.long WritePointer (vtkIdType id, vtkIdType number) - Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc.
long = obj.long GetPointer (vtkIdType id) - This method lets the user specify data to be
held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the
user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The
class uses the actual array provided; it does not copy the data from the suppled array.
31.160
vtkUnsignedShortArray
31.160.1
Usage
vtkUnsignedShortArray is an array of values of type unsigned short. It provides methods for insertion and retrieval
of values and will automatically resize itself to hold new data.
To create an instance of class vtkUnsignedShortArray, simply invoke its constructor as follows
obj = vtkUnsignedShortArray
31.160.2
Methods
The class vtkUnsignedShortArray has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkUnsignedShortArray
class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
722
31.161
vtkVariantArray
31.161.1
Usage
.SECTION Thanks Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from Sandia National
Laboratories for their help in developing this class.
To create an instance of class vtkVariantArray, simply invoke its constructor as follows
obj = vtkVariantArray
31.161 vtkVariantArray
31.161.2
723
Methods
The class vtkVariantArray has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkVariantArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVariantArray = obj.NewInstance ()
vtkVariantArray = obj.SafeDownCast (vtkObject o)
int = obj.Allocate (vtkIdType sz, vtkIdType ext) - Allocate memory for this array.
Delete old storage only if necessary. Note that ext is no longer used.
obj.Initialize () - Release storage and reset array to initial state.
int = obj.GetDataType () - Return the underlying data type. An integer indicating data type is
returned as specified in vtkSetGet.h.
int = obj.GetDataTypeSize () - Return the size of the underlying data type. For a bit, 1 is returned. For string 0 is returned. Arrays with variable length components return 0.
int = obj.GetElementComponentSize () - Return the size, in bytes, of the lowest-level element
of an array. For vtkDataArray and subclasses this is the size of the data type. For vtkStringArray, this is
sizeof(vtkStdString::value_type), which winds up being sizeof(char).
obj.SetNumberOfTuples (vtkIdType number) - Set the number of tuples (a component group)
in the array. Note that this may allocate space depending on the number of components.
obj.SetTuple (vtkIdType i, vtkIdType j, vtkAbstractArray source) - Set the
tuple at the ith location using the jth tuple in the source array. This method assumes that the two arrays
have the same type and structure. Note that range checking and memory allocation is not performed; use in
conjunction with SetNumberOfTuples() to allocate space.
obj.InsertTuple (vtkIdType i, vtkIdType j, vtkAbstractArray source) - Insert the jth tuple in the source array, at ith location in this array. Note that memory allocation is performed as
necessary to hold the data.
vtkIdType = obj.InsertNextTuple (vtkIdType j, vtkAbstractArray source) Insert the jth tuple in the source array, at the end in this array. Note that memory allocation is performed as
necessary to hold the data. Returns the location at which the data was inserted.
obj.DeepCopy (vtkAbstractArray da) - Deep copy of data. Implementation left to subclasses,
which should support as many type conversions as possible given the data type.
obj.InterpolateTuple (vtkIdType i, vtkIdList ptIndices, vtkAbstractArray source, double weights) - Set the ith tuple in this array as the interpolated tuple value,
given the ptIndices in the source array and associated interpolation weights. This method assumes that the
two arrays are of the same type and strcuture.
obj.InterpolateTuple (vtkIdType i, vtkIdType id1, vtkAbstractArray source1,
724
31.162
vtkVersion
31.162.1
Usage
Holds methods for defining/determining the current vtk version (major, minor, build).
To create an instance of class vtkVersion, simply invoke its constructor as follows
obj = vtkVersion
31.162.2
Methods
The class vtkVersion has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkVersion class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVersion = obj.NewInstance ()
vtkVersion = obj.SafeDownCast (vtkObject o)
31.163
vtkVoidArray
31.164 vtkWarpTransform
31.163.1
725
Usage
vtkVoidArray is an array of pointers to void. It provides methods for insertion and retrieval of these pointers values,
and will automatically resize itself to hold new data.
To create an instance of class vtkVoidArray, simply invoke its constructor as follows
obj = vtkVoidArray
31.163.2
Methods
The class vtkVoidArray has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkVoidArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVoidArray = obj.NewInstance ()
vtkVoidArray = obj.SafeDownCast (vtkObject o)
int = obj.Allocate (vtkIdType sz, vtkIdType ext) - Allocate memory for this array.
Delete old storage only if necessary. Note that the parameter ext is no longer used.
obj.Initialize () - Release storage and reset array to initial state.
int = obj.GetDataType () - Return the size of the data contained in the array.
int = obj.GetDataTypeSize () - Set the number of void pointers held in the array.
obj.SetNumberOfPointers (vtkIdType number) - Get the number of void pointers held in the
array.
vtkIdType = obj.GetNumberOfPointers () - Get the void pointer at the ith location.
obj.Reset () - Resize the array to just fit the inserted memory. Reclaims extra memory.
obj.Squeeze () - Get the address of a particular data index. Performs no checks to verify that the
memory has been allocated etc.
obj.DeepCopy (vtkVoidArray va) - Deep copy of another void array.
31.164
vtkWarpTransform
31.164.1
Usage
726
31.164.2
Methods
The class vtkWarpTransform has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkWarpTransform class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkWarpTransform = obj.NewInstance ()
vtkWarpTransform = obj.SafeDownCast (vtkObject o)
obj.Inverse () - Invert the transformation. Warp transformations are usually inverted using an iterative
technique such as Newtons method. The inverse transform is usually around five or six times as computationally expensive as the forward transform.
int = obj.GetInverseFlag () - Get the inverse flag of the transformation. This flag is set to zero
when the transformation is first created, and is flipped each time Inverse() is called.
obj.SetInverseTolerance (double ) - Set the tolerance for inverse transformation. The default
is 0.001.
double = obj.GetInverseTolerance () - Set the tolerance for inverse transformation. The default is 0.001.
obj.SetInverseIterations (int ) - Set the maximum number of iterations for the inverse transformation. The default is 500, but usually only 2 to 5 iterations are used. The inversion method is fairly robust,
and it should converge for nearly all smooth transformations that do not fold back on themselves.
int = obj.GetInverseIterations () - Set the maximum number of iterations for the inverse
transformation. The default is 500, but usually only 2 to 5 iterations are used. The inversion method is fairly
robust, and it should converge for nearly all smooth transformations that do not fold back on themselves.
obj.InternalTransformPoint (float in[3], float out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformPoint (double in[3], double out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.TemplateTransformPoint (float in[3], float out[3]) - Do not use these methods. They exists only as a work-around for internal templated functions (I really didnt want to make the
Forward/Inverse methods public, is there a decent work around for this sort of thing?)
obj.TemplateTransformPoint (double in[3], double out[3]) - Do not use these
methods. They exists only as a work-around for internal templated functions (I really didnt want to make the
Forward/Inverse methods public, is there a decent work around for this sort of thing?)
obj.TemplateTransformInverse (float in[3], float out[3]) - Do not use these
methods. They exists only as a work-around for internal templated functions (I really didnt want to make the
Forward/Inverse methods public, is there a decent work around for this sort of thing?)
obj.TemplateTransformInverse (double in[3], double out[3]) - Do not use these
methods. They exists only as a work-around for internal templated functions (I really didnt want to make the
Forward/Inverse methods public, is there a decent work around for this sort of thing?)
31.165
vtkWindow
31.165 vtkWindow
31.165.1
727
Usage
vtkWindow is an abstract object to specify the behavior of a rendering window. It contains vtkViewports.
To create an instance of class vtkWindow, simply invoke its constructor as follows
obj = vtkWindow
31.165.2
Methods
The class vtkWindow has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkWindow class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkWindow = obj.NewInstance ()
vtkWindow = obj.SafeDownCast (vtkObject o)
obj.SetWindowInfo (string ) - These are window system independent methods that are used to
help interface vtkWindow to native windowing systems.
obj.SetParentInfo (string ) - These are window system independent methods that are used to
help interface vtkWindow to native windowing systems.
int = obj.GetPosition () - Set/Get the position in screen coordinates of the rendering window.
obj.SetPosition (int , int ) - Set/Get the position in screen coordinates of the rendering window.
obj.SetPosition (int a[2]) - Set/Get the position in screen coordinates of the rendering window.
int = obj.GetSize () - Set/Get the size of the window in screen coordinates in pixels.
obj.SetSize (int , int ) - Set/Get the size of the window in screen coordinates in pixels.
obj.SetSize (int a[2]) - Set/Get the size of the window in screen coordinates in pixels.
obj.SetMapped (int ) - Keep track of whether the rendering window has been mapped to screen.
int = obj.GetMapped () - Keep track of whether the rendering window has been mapped to screen.
obj.MappedOn () - Keep track of whether the rendering window has been mapped to screen.
obj.MappedOff () - Keep track of whether the rendering window has been mapped to screen.
obj.SetErase (int ) - Turn on/off erasing the screen between images. This allows multiple exposure
sequences if turned on. You will need to turn double buffering off or make use of the SwapBuffers methods
to prevent you from swapping buffers between exposures.
int = obj.GetErase () - Turn on/off erasing the screen between images. This allows multiple exposure sequences if turned on. You will need to turn double buffering off or make use of the SwapBuffers
methods to prevent you from swapping buffers between exposures.
obj.EraseOn () - Turn on/off erasing the screen between images. This allows multiple exposure sequences if turned on. You will need to turn double buffering off or make use of the SwapBuffers methods to
prevent you from swapping buffers between exposures.
obj.EraseOff () - Turn on/off erasing the screen between images. This allows multiple exposure sequences if turned on. You will need to turn double buffering off or make use of the SwapBuffers methods to
prevent you from swapping buffers between exposures.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
728
31.166 vtkWindowLevelLookupTable
729
31.166
vtkWindowLevelLookupTable
31.166.1
Usage
vtkWindowLevelLookupTable is an object that is used by mapper objects to map scalar values into rgba (red-greenblue-alpha transparency) color specification, or rgba into scalar values. The color table can be created by direct
insertion of color values, or by specifying a window and level. Window / Level is used in medical imaging to specify
a linear greyscale ramp. The Level is the center of the ramp. The Window is the width of the ramp.
To create an instance of class vtkWindowLevelLookupTable, simply invoke its constructor as follows
obj = vtkWindowLevelLookupTable
31.166.2
Methods
The class vtkWindowLevelLookupTable has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkWindowLevelLookupTable
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkWindowLevelLookupTable = obj.NewInstance ()
vtkWindowLevelLookupTable = obj.SafeDownCast (vtkObject o)
obj.Build () - Generate lookup table as a linear ramp between MinimumTableValue and MaximumTableValue.
obj.SetWindow (double window) - Set the window for the lookup table. The window is the difference between TableRange[0] and TableRange[1].
double = obj.GetWindow () - Set the window for the lookup table. The window is the difference
between TableRange[0] and TableRange[1].
obj.SetLevel (double level) - Set the Level for the lookup table. The level is the average of
TableRange[0] and TableRange[1].
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
730
31.167
vtkXMLDataElement
31.167.1
Usage
31.167 vtkXMLDataElement
31.167.2
731
Methods
The class vtkXMLDataElement has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkXMLDataElement class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkXMLDataElement = obj.NewInstance ()
vtkXMLDataElement = obj.SafeDownCast (vtkObject o)
string = obj.GetName () - Set/Get the name of the element. This is its XML tag.
obj.SetName (string _arg) - Set/Get the name of the element. This is its XML tag.
string = obj.GetId () - Set/Get the value of the id attribute of the element, if any.
obj.SetId (string ) - Set/Get the value of the id attribute of the element, if any.
string = obj.GetAttribute (string name) - Get the attribute with the given name.
doesnt exist, returns 0.
If it
obj.SetAttribute (string name, string value) - Set the attribute with the given name and
value. If it doesnt exist, adds it.
obj.SetCharacterData (string c, int length) - Set/Get the character data between XML
start/end tags.
string = obj.GetCharacterData () - Set/Get the character data between XML start/end tags.
obj.SetIntAttribute (string name, int value) - Set the attribute with the given name.
We can not use the same GetScalarAttribute() construct since the compiler will not be able to resolve between
SetAttribute(..., int) and SetAttribute(..., unsigned long).
obj.SetFloatAttribute (string name, float value) - Set the attribute with the given
name. We can not use the same GetScalarAttribute() construct since the compiler will not be able to resolve between SetAttribute(..., int) and SetAttribute(..., unsigned long).
obj.SetDoubleAttribute (string name, double value) - Set the attribute with the given
name. We can not use the same GetScalarAttribute() construct since the compiler will not be able to resolve
between SetAttribute(..., int) and SetAttribute(..., unsigned long).
obj.SetUnsignedLongAttribute (string name, long value) - Set the attribute with the
given name. We can not use the same GetScalarAttribute() construct since the compiler will not be able to
resolve between SetAttribute(..., int) and SetAttribute(..., unsigned long).
int = obj.GetVectorAttribute (string name, int length, int value) - Get the
attribute with the given name and converted to a scalar value. Returns length of vector read.
int = obj.GetVectorAttribute (string name, int length, float value) - Get
the attribute with the given name and converted to a scalar value. Returns length of vector read.
int = obj.GetVectorAttribute (string name, int length, double value) - Get
the attribute with the given name and converted to a scalar value. Returns length of vector read.
int = obj.GetVectorAttribute (string name, int length, long value) - Get
the attribute with the given name and converted to a scalar value. Returns length of vector read.
obj.SetVectorAttribute (string name, int length, int value) - Set the attribute
with the given name.
obj.SetVectorAttribute (string name, int length, float value) - Set the attribute with the given name.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
732
31.168 vtkXMLFileOutputWindow
733
obj.DeepCopy (vtkXMLDataElement elem) - Copy this element from another of the same type
(elem), recursively. Old attributes and nested elements are removed, new ones are created given the contents
of elem. Warning: Parent is ignored.
obj.SetAttributeEncoding (int ) - Get/Set the internal character encoding of the attributes.
Default type is VTK_ENCODING_UTF_8. Note that a vtkXMLDataParser has its own AttributesEncoding
ivar. If this ivar is set to something other than VTK_ENCODING_NONE, it will be used to set the attribute
encoding of each vtkXMLDataElement created by this vtkXMLDataParser.
int = obj.GetAttributeEncodingMinValue () - Get/Set the internal character encoding of
the attributes. Default type is VTK_ENCODING_UTF_8. Note that a vtkXMLDataParser has its own
AttributesEncoding ivar. If this ivar is set to something other than VTK_ENCODING_NONE, it will be used to
set the attribute encoding of each vtkXMLDataElement created by this vtkXMLDataParser.
int = obj.GetAttributeEncodingMaxValue () - Get/Set the internal character encoding of
the attributes. Default type is VTK_ENCODING_UTF_8. Note that a vtkXMLDataParser has its own
AttributesEncoding ivar. If this ivar is set to something other than VTK_ENCODING_NONE, it will be used to
set the attribute encoding of each vtkXMLDataElement created by this vtkXMLDataParser.
int = obj.GetAttributeEncoding () - Get/Set the internal character encoding of the attributes.
Default type is VTK_ENCODING_UTF_8. Note that a vtkXMLDataParser has its own AttributesEncoding ivar.
If this ivar is set to something other than VTK_ENCODING_NONE, it will be used to set the attribute encoding
of each vtkXMLDataElement created by this vtkXMLDataParser.
obj.PrintXML (string fname) - Prints element tree as XML.
int = obj.GetCharacterDataWidth () - Get/Set the width (in number of fields) that character
data (that between open and closing tags ie. <X> ... </X>) is printed. If the width is less than one the tags
character data is printed all on one line. If it is greater than one the character data is streamed insterting line
feeds every width number of fields. See PrintXML.
obj.SetCharacterDataWidth (int ) - Get/Set the width (in number of fields) that character data
(that between open and closing tags ie. <X> ... </X>) is printed. If the width is less than one the tags
character data is printed all on one line. If it is greater than one the character data is streamed insterting line
feeds every width number of fields. See PrintXML.
31.168
vtkXMLFileOutputWindow
31.168.1
Usage
Writes debug/warning/error output to an XML file. Uses prefined XML tags for each text display method. The text is
processed to replace XML markup characters.
DisplayText - <Text>
DisplayErrorText - <Error>
DisplayWarningText - <Warning>
DisplayGenericWarningText - <GenericWarning>
DisplayDebugText - <Debug>
The method DisplayTag outputs the text unprocessed. To use this class, instantiate it and then call SetInstance(this).
To create an instance of class vtkXMLFileOutputWindow, simply invoke its constructor as follows
obj = vtkXMLFileOutputWindow
734
31.168.2
Methods
The class vtkXMLFileOutputWindow has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkXMLFileOutputWindow
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkXMLFileOutputWindow = obj.NewInstance ()
vtkXMLFileOutputWindow = obj.SafeDownCast (vtkObject o)
obj.DisplayText (string ) - Put the text into the log file. The text is processed to replace &, <, >
with &, <, and >. Each display method outputs a different XML tag.
obj.DisplayErrorText (string ) - Put the text into the log file. The text is processed to replace
&, <, > with &, <, and >. Each display method outputs a different XML tag.
obj.DisplayWarningText (string ) - Put the text into the log file. The text is processed to replace &, <, > with &, <, and >. Each display method outputs a different XML tag.
obj.DisplayGenericWarningText (string ) - Put the text into the log file. The text is processed to replace &, <, > with &, <, and >. Each display method outputs a different XML tag.
obj.DisplayDebugText (string ) - Put the text into the log file. The text is processed to replace
&, <, > with &, <, and >. Each display method outputs a different XML tag.
obj.DisplayTag (string ) - Put the text into the log file without processing it.
Chapter 32
736
737
vtkDiscretizableColorTransferFunction
vtkDistributedGraphHelper
vtkEdgeListIterator
vtkEmptyCell
vtkExecutive
vtkExecutiveCollection
vtkExplicitCell
vtkFieldData
vtkGenericAdaptorCell
vtkGenericAttribute
vtkGenericAttributeCollection
vtkGenericCell
vtkGenericCellIterator
vtkGenericCellTessellator
vtkGenericDataSet
vtkGenericDataSetAlgorithm
vtkGenericEdgeTable
vtkGenericInterpolatedVelocityField
vtkGenericPointIterator
vtkGenericSubdivisionErrorMetric
vtkGeometricErrorMetric
vtkGraph
vtkGraphAlgorithm
vtkGraphEdge
vtkGraphInternals
vtkHexagonalPrism
vtkHexahedron
vtkHierarchicalBoxDataIterator
vtkHierarchicalBoxDataSet
vtkHierarchicalBoxDataSetAlgorithm
vtkHyperOctree
vtkHyperOctreeAlgorithm
vtkHyperOctreeCursor
vtkImageAlgorithm
vtkImageData
vtkImageInPlaceFilter
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
738
739
vtkOctreePointLocator
vtkOctreePointLocatorNode
vtkOrderedTriangulator
vtkOutEdgeIterator
vtkParametricSpline
vtkPassInputTypeAlgorithm
vtkPentagonalPrism
vtkPerlinNoise
vtkPiecewiseFunction
vtkPiecewiseFunctionAlgorithm
vtkPiecewiseFunctionShiftScale
vtkPixel
vtkPlanesIntersection
vtkPointData
vtkPointLocator
vtkPointSet
vtkPointSetAlgorithm
vtkPointSetSource
vtkPointSetToPointSetFilter
vtkPointsProjectedHull
vtkPolyData
vtkPolyDataAlgorithm
vtkPolyDataCollection
vtkPolyDataSource
vtkPolyDataToPolyDataFilter
vtkPolygon
vtkPolyLine
vtkPolyVertex
vtkProcessObject
vtkPropAssembly
vtkPyramid
vtkQuad
vtkQuadraticEdge
vtkQuadraticHexahedron
vtkQuadraticLinearQuad
vtkQuadraticLinearWedge
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
740
32.1 vtkAbstractCellLocator
741
vtkTemporalDataSetAlgorithm
vtkTetra
vtkThreadedImageAlgorithm
vtkTree
vtkTreeAlgorithm
vtkTreeDFSIterator
vtkTriangle
vtkTriangleStrip
vtkTriQuadraticHexahedron
vtkTrivialProducer
vtkUndirectedGraph
vtkUndirectedGraphAlgorithm
vtkUniformGrid
vtkUnstructuredGrid
vtkUnstructuredGridAlgorithm
vtkUnstructuredGridSource
vtkUnstructuredGridToPolyDataFilter
vtkUnstructuredGridToUnstructuredGridFilter
vtkVertex
vtkVertexListIterator
vtkViewDependentErrorMetric
vtkViewport
vtkVoxel
vtkWedge
32.1
vtkAbstractCellLocator
32.1.1
Usage
vtkAbstractCellLocator is a spatial search object to quickly locate cells in 3D. vtkAbstractCellLocator supplies a basic
interface which concrete subclasses should implement.
.SECTION Warning When deriving a class from vtkAbstractCellLocator, one should include the hidden member
functions by the following construct in the derived class
//BTX
using vtkAbstractCellLocator::IntersectWithLine;
using vtkAbstractCellLocator::FindClosestPoint;
using vtkAbstractCellLocator::FindClosestPointWithinRadius;
//ETX
742
32.1.2
Methods
The class vtkAbstractCellLocator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAbstractCellLocator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAbstractCellLocator = obj.NewInstance ()
vtkAbstractCellLocator = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfCellsPerNode (int ) - Specify the preferred/maximum number of cells in each
node/bucket. Default 32. Locators generally operate by subdividing space into smaller regions until the
number of cells in each region (or node) reaches the desired level.
int = obj.GetNumberOfCellsPerNodeMinValue () - Specify the preferred/maximum number
of cells in each node/bucket. Default 32. Locators generally operate by subdividing space into smaller regions
until the number of cells in each region (or node) reaches the desired level.
int = obj.GetNumberOfCellsPerNodeMaxValue () - Specify the preferred/maximum number
of cells in each node/bucket. Default 32. Locators generally operate by subdividing space into smaller regions
until the number of cells in each region (or node) reaches the desired level.
int = obj.GetNumberOfCellsPerNode () - Specify the preferred/maximum number of cells in
each node/bucket. Default 32. Locators generally operate by subdividing space into smaller regions until the
number of cells in each region (or node) reaches the desired level.
obj.SetCacheCellBounds (int ) - Boolean controls whether the bounds of each cell are computed
only once and then saved. Should be 10 to 20% faster if repeatedly calling any of the Intersect/Find routines
and the extra memory wont cause disk caching (24 extra bytes per cell are required to save the bounds).
int = obj.GetCacheCellBounds () - Boolean controls whether the bounds of each cell are computed only once and then saved. Should be 10 to 20% faster if repeatedly calling any of the Intersect/Find
routines and the extra memory wont cause disk caching (24 extra bytes per cell are required to save the
bounds).
obj.CacheCellBoundsOn () - Boolean controls whether the bounds of each cell are computed only
once and then saved. Should be 10 to 20% faster if repeatedly calling any of the Intersect/Find routines and
the extra memory wont cause disk caching (24 extra bytes per cell are required to save the bounds).
obj.CacheCellBoundsOff () - Boolean controls whether the bounds of each cell are computed only
once and then saved. Should be 10 to 20% faster if repeatedly calling any of the Intersect/Find routines and
the extra memory wont cause disk caching (24 extra bytes per cell are required to save the bounds).
obj.SetRetainCellLists (int ) - Boolean controls whether to maintain list of cells in each node.
not applicable to all implementations, but if the locator is being used as a geometry simplification technique,
there is no need to keep them.
int = obj.GetRetainCellLists () - Boolean controls whether to maintain list of cells in each
node. not applicable to all implementations, but if the locator is being used as a geometry simplification
technique, there is no need to keep them.
obj.RetainCellListsOn () - Boolean controls whether to maintain list of cells in each node. not
applicable to all implementations, but if the locator is being used as a geometry simplification technique, there
is no need to keep them.
obj.RetainCellListsOff () - Boolean controls whether to maintain list of cells in each node. not
applicable to all implementations, but if the locator is being used as a geometry simplification technique, there
is no need to keep them.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.1 vtkAbstractCellLocator
743
obj.SetLazyEvaluation (int ) - Most Locators build their search structures during BuildLocator
but some may delay construction until it is actually needed. If LazyEvaluation is supported, this turns on/off
the feature. if not supported, it is ignored.
int = obj.GetLazyEvaluation () - Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed. If LazyEvaluation is supported, this
turns on/off the feature. if not supported, it is ignored.
obj.LazyEvaluationOn () - Most Locators build their search structures during BuildLocator but some
may delay construction until it is actually needed. If LazyEvaluation is supported, this turns on/off the feature.
if not supported, it is ignored.
obj.LazyEvaluationOff () - Most Locators build their search structures during BuildLocator but
some may delay construction until it is actually needed. If LazyEvaluation is supported, this turns on/off the
feature. if not supported, it is ignored.
obj.SetUseExistingSearchStructure (int ) - Some locators support querying a new dataset
without rebuilding the search structure (typically this may occur when a dataset changes due to a time update,
but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase
int = obj.GetUseExistingSearchStructure () - Some locators support querying a new
dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a
time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase
obj.UseExistingSearchStructureOn () - Some locators support querying a new dataset without
rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is
actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase
obj.UseExistingSearchStructureOff () - Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update,
but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase
int = obj.IntersectWithLine (double p1[3], double p2[3], vtkPoints points,
vtkIdList cellIds) - Take the passed line segment and intersect it with the data set. This method
assumes that the data set is a vtkPolyData that describes a closed surface, and the intersection points that
are returned in points alternate between entrance points and exit points. The return value of the function is
0 if no intersections were found, -1 if point a0 lies inside the closed surface, or +1 if point a0 lies outside
the closed surface. Either points or cellIds can be set to NULL if you dont want to receive that information.
This method is currently only implemented in vtkOBBTree
obj.FindCellsWithinBounds (double bbox, vtkIdList cells) - Return a list of unique
cell ids inside of a given bounding box. The user must provide the vtkIdList to populate. This method returns
data only after the locator has been built.
obj.FindCellsAlongLine (double p1[3], double p2[3], double tolerance,
vtkIdList cells) - Given a finite line defined by the two points (p1,p2), return the list of unique
cell ids in the buckets containing the line. It is possible that an empty cell list is returned. The user must
provide the vtkIdList to populate. This method returns data only after the locator has been built.
vtkIdType = obj.FindCell (double x[3]) - Returns the Id of the cell containing the point,
returns -1 if no cell found. This interface uses a tolerance of zero
vtkIdType = obj.FindCell (double x[3], double tol2, vtkGenericCell GenCell, double pcoords[3], double weights) - Find the cell containing a given point. returns
-1 if no cell found the cell parameters are copied into the supplied variables, a cell must be provided to store
the information.
bool = obj.InsideCellBounds (double x[3], vtkIdType cell_ID) - Quickly test if a
point is inside the bounds of a particular cell. Some locators cache cell bounds and this function can make
use of fast access to the data.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
744
32.2
vtkAbstractInterpolatedVelocityField
32.2.1
Usage
vtkAbstractInterpolatedVelocityField acts as a continuous velocity field by performing cell interpolation on the underlying vtkDataSet. This is an abstract sub-class of vtkFunctionSet, NumberOfIndependentVariables = 4 (x,y,z,t)
and NumberOfFunctions = 3 (u,v,w). With a brute-force scheme, every time an evaluation is performed, the target
cell containing point (x,y,z) needs to be found by calling FindCell(), via either vtkDataSet or vtkAbstractCelllocators
sub-classes (vtkCellLocator & vtkModifiedBSPTree). As it incurs a large cost, one (for vtkCellLocatorInterpolatedVelocityField via vtkAbstractCellLocator) or two (for vtkInterpolatedVelocityField via vtkDataSet that involves vtkPointLocator in addressing vtkPointSet) levels of cell caching may be exploited to increase the performance.
For vtkInterpolatedVelocityField, level #0 begins with intra-cell caching. Specifically if the previous cell is valid
and the next point is still in it ( i.e., vtkCell::EvaluatePosition() returns 1, coupled with newly created parametric
coordinates & weights ), the function values can be interpolated and only vtkCell::EvaluatePosition() is invoked. If
this fails, then level #1 follows by inter-cell search for the target cell that contains the next point. By an inter-cell
search, the previous cell provides an important clue or serves as an immediate neighbor to aid in locating the target
cell via vtkPointSet:: FindCell(). If this still fails, a global cell location / search is invoked via vtkPointSet::FindCell().
Here regardless of either inter-cell or global search, vtkPointLocator is in fact employed (for datasets of type vtkPointSet only, note vtkImageData and vtkRectilinearGrid are able to provide rapid and robust cell location due to
the simple mesh topology) as a crucial tool underlying the cell locator. However, the use of vtkPointLocator makes
vtkInterpolatedVelocityField non-robust in cell location for vtkPointSet.
For vtkCellLocatorInterpolatedVelocityField, the only caching (level #0) works by intra-cell trial. In case of failure,
a global search for the target cell is invoked via vtkAbstractCellLocator::FindCell() and the actual work is done by
either vtkCellLocator or vtkModifiedBSPTree (for datasets of type vtkPointSet only, while vtkImageData and vtkRectilinearGrid themselves are able to provide fast robust cell location). Without the involvement of vtkPointLocator,
robust cell location is achieved for vtkPointSet.
To create an instance of class vtkAbstractInterpolatedVelocityField, simply invoke its constructor as follows
obj = vtkAbstractInterpolatedVelocityField
32.2.2
Methods
The class vtkAbstractInterpolatedVelocityField has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAbstractInterpolatedVelocityField class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAbstractInterpolatedVelocityField = obj.NewInstance ()
vtkAbstractInterpolatedVelocityField = obj.SafeDownCast (vtkObject o)
obj.SetCaching (bool ) - Set/Get the caching flag. If this flag is turned ON, there are two levels of
caching for derived concrete class vtkInterpolatedVelocityField and one level of caching for derived concrete
class vtkCellLocatorInterpolatedVelocityField. Otherwise a global cell location is always invoked for evaluating
the function values at any point.
bool = obj.GetCaching () - Set/Get the caching flag. If this flag is turned ON, there are two levels of
caching for derived concrete class vtkInterpolatedVelocityField and one level of caching for derived concrete
class vtkCellLocatorInterpolatedVelocityField. Otherwise a global cell location is always invoked for evaluating
the function values at any point.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.2 vtkAbstractInterpolatedVelocityField
745
int = obj.GetCacheHit () - Get the caching statistics. CacheHit refers to the number of level #0
cache hits while CacheMiss is the number of level #0 cache misses.
int = obj.GetCacheMiss () - Get the caching statistics. CacheHit refers to the number of level #0
cache hits while CacheMiss is the number of level #0 cache misses.
int = obj.GetLastDataSetIndex () - Get the most recently visited dataset and it id. The dataset
is used for a guess regarding where the next point will be, without searching through all datasets. When
setting the last dataset, care is needed as no reference counting or checks are performed. This feature is
intended for custom interpolators only that cache datasets independently.
vtkDataSet = obj.GetLastDataSet () - Get the most recently visited dataset and it id. The
dataset is used for a guess regarding where the next point will be, without searching through all datasets.
When setting the last dataset, care is needed as no reference counting or checks are performed. This feature
is intended for custom interpolators only that cache datasets independently.
vtkIdType = obj.GetLastCellId () - Get/Set the id of the cell cached from last evaluation.
obj.SetLastCellId (vtkIdType c) - Set the id of the most recently visited cell of a dataset.
obj.SetLastCellId (vtkIdType c, int dataindex) - Set the id of the most recently visited
cell of a dataset.
string = obj.GetVectorsSelection () - Get/Set the name of a spcified vector array. By default
it is NULL, with the active vector array for use.
obj.SelectVectors (string fieldName) - Set/Get the flag indicating vector post-normalization
(following vector interpolation). Vector post-normalization is required to avoid the curve-overshooting problem (caused by high velocity magnitude) that occurs when Cell-Length is used as the step size unit (particularly the Minimum step size unit). Furthermore, it is required by RK45 to achieve, as expected, high numerical
accuracy (or high smoothness of flow lines) through adaptive step sizing. Note this operation is performed
(when NormalizeVector TRUE) right after vector interpolation such that the differing amount of contribution
of each node (of a cell) to the resulting direction of the interpolated vector, due to the possibly significantlydiffering velocity magnitude values at the nodes (which is the case with large cells), can be reflected as is.
Also note that this flag needs to be turned to FALSE after vtkInitialValueProblemSolver:: ComputeNextStep()
as subsequent operations, e.g., vorticity computation, may need non-normalized vectors.
obj.SetNormalizeVector (bool ) - Set/Get the flag indicating vector post-normalization (following
vector interpolation). Vector post-normalization is required to avoid the curve-overshooting problem (caused
by high velocity magnitude) that occurs when Cell-Length is used as the step size unit (particularly the Minimum step size unit). Furthermore, it is required by RK45 to achieve, as expected, high numerical accuracy
(or high smoothness of flow lines) through adaptive step sizing. Note this operation is performed (when
NormalizeVector TRUE) right after vector interpolation such that the differing amount of contribution of each
node (of a cell) to the resulting direction of the interpolated vector, due to the possibly significantly-differing
velocity magnitude values at the nodes (which is the case with large cells), can be reflected as is. Also
note that this flag needs to be turned to FALSE after vtkInitialValueProblemSolver:: ComputeNextStep() as
subsequent operations, e.g., vorticity computation, may need non-normalized vectors.
bool = obj.GetNormalizeVector () - Set/Get the flag indicating vector post-normalization (following vector interpolation). Vector post-normalization is required to avoid the curve-overshooting problem
(caused by high velocity magnitude) that occurs when Cell-Length is used as the step size unit (particularly
the Minimum step size unit). Furthermore, it is required by RK45 to achieve, as expected, high numerical
accuracy (or high smoothness of flow lines) through adaptive step sizing. Note this operation is performed
(when NormalizeVector TRUE) right after vector interpolation such that the differing amount of contribution
of each node (of a cell) to the resulting direction of the interpolated vector, due to the possibly significantlydiffering velocity magnitude values at the nodes (which is the case with large cells), can be reflected as is.
Also note that this flag needs to be turned to FALSE after vtkInitialValueProblemSolver:: ComputeNextStep()
as subsequent operations, e.g., vorticity computation, may need non-normalized vectors.
obj.CopyParameters (vtkAbstractInterpolatedVelocityField from) - Add a
dataset for implicit velocity function evaluation. If more than one dataset is added, the evaluation point
is searched in all until a match is found. THIS FUNCTION DOES NOT CHANGE THE REFERENCE COUNT
OF dataset FOR THREAD SAFETY REASONS.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
746
32.3
vtkAbstractMapper
32.3.1
Usage
vtkAbstractMapper is an abstract class to specify interface between data and graphics primitives or software rendering techniques. Subclasses of vtkAbstractMapper can be used for rendering 2D data, geometry, or volumetric
data.
To create an instance of class vtkAbstractMapper, simply invoke its constructor as follows
obj = vtkAbstractMapper
32.3.2
Methods
The class vtkAbstractMapper has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkAbstractMapper class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAbstractMapper = obj.NewInstance ()
vtkAbstractMapper = obj.SafeDownCast (vtkObject o)
long = obj.GetMTime () - Override Modifiedtime as we have added Clipping planes
obj.ReleaseGraphicsResources (vtkWindow ) - Release any graphics resources that are being consumed by this mapper. The parameter window could be used to determine which graphic resources
to release.
double = obj.GetTimeToDraw () - Get the time required to draw the geometry last time it was
rendered
obj.AddClippingPlane (vtkPlane plane) - Specify clipping planes to be applied when the data
is mapped (at most 6 clipping planes can be specified).
obj.RemoveClippingPlane (vtkPlane plane) - Specify clipping planes to be applied when the
data is mapped (at most 6 clipping planes can be specified).
obj.RemoveAllClippingPlanes () - Specify clipping planes to be applied when the data is mapped
(at most 6 clipping planes can be specified).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.4 vtkAbstractPointLocator
747
32.4
vtkAbstractPointLocator
32.4.1
Usage
vtkAbstractPointLocator is an abstract spatial search object to quickly locate points in 3D. vtkAbstractPointLocator
works by dividing a specified region of space into "rectangular" buckets, and then keeping a list of points that lie in
each bucket. Typical operation involves giving a position in 3D and finding the closest point. The points are provided
from the specified dataset input.
To create an instance of class vtkAbstractPointLocator, simply invoke its constructor as follows
obj = vtkAbstractPointLocator
32.4.2
Methods
The class vtkAbstractPointLocator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAbstractPointLocator
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAbstractPointLocator = obj.NewInstance ()
vtkAbstractPointLocator = obj.SafeDownCast (vtkObject o)
vtkIdType = obj.FindClosestPoint (double x[3]) - Given a position x, return the id of
the point closest to it. Alternative method requires separate x-y-z values. These methods are thread safe if
BuildLocator() is directly or indirectly called from a single thread first.
vtkIdType = obj.FindClosestPoint (double x, double y, double z) - Given a position x, return the id of the point closest to it. Alternative method requires separate x-y-z values. These
methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.
obj.FindClosestNPoints (int N, double x[3], vtkIdList result) - Find the closest N points to a position. This returns the closest N points to a position. A faster method could be created
that returned N close points to a position, but necessarily the exact N closest. The returned points are sorted
from closest to farthest. These methods are thread safe if BuildLocator() is directly or indirectly called from a
single thread first.
obj.FindClosestNPoints (int N, double x, double y, double z, vtkIdList
result) - Find the closest N points to a position. This returns the closest N points to a position. A faster
method could be created that returned N close points to a position, but necessarily the exact N closest. The
returned points are sorted from closest to farthest. These methods are thread safe if BuildLocator() is directly
or indirectly called from a single thread first.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
748
32.5
vtkActor2D
32.5.1
Usage
vtkActor2D is similar to vtkActor, but it is made to be used with two dimensional images and annotation. vtkActor2D
has a position but does not use a transformation matrix like vtkActor (see the superclass vtkProp for information on
positioning vtkActor2D). vtkActor2D has a reference to a vtkMapper2D object which does the rendering.
To create an instance of class vtkActor2D, simply invoke its constructor as follows
obj = vtkActor2D
32.5.2
Methods
The class vtkActor2D has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkActor2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkActor2D = obj.NewInstance ()
vtkActor2D = obj.SafeDownCast (vtkObject o)
int = obj.RenderOverlay (vtkViewport viewport) - Support the standard render methods.
int = obj.RenderOpaqueGeometry (vtkViewport viewport) - Support the standard render methods.
int = obj.RenderTranslucentPolygonalGeometry (vtkViewport viewport) - Support the standard render methods.
int = obj.HasTranslucentPolygonalGeometry () - Does this prop have some translucent
polygonal geometry?
obj.SetMapper (vtkMapper2D mapper) - Set/Get the vtkMapper2D which defines the data to be
drawn.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.5 vtkActor2D
749
vtkMapper2D = obj.GetMapper () - Set/Get the vtkMapper2D which defines the data to be drawn.
obj.SetLayerNumber (int ) - Set/Get the layer number in the overlay planes into which to render.
int = obj.GetLayerNumber () - Set/Get the layer number in the overlay planes into which to render.
vtkProperty2D = obj.GetProperty () - Returns this actors vtkProperty2D. Creates a property
if one doesnt already exist.
obj.SetProperty (vtkProperty2D ) - Set this vtkProps vtkProperty2D.
vtkCoordinate = obj.GetPositionCoordinate () - Get the PositionCoordinate instance of
vtkCoordinate. This is used for for complicated or relative positioning. The position variable controls the lower
left corner of the Actor2D
obj.SetPosition (double, double) - Get the PositionCoordinate instance of vtkCoordinate. This
is used for for complicated or relative positioning. The position variable controls the lower left corner of the
Actor2D
obj.SetPosition (double a[2]) - Get the PositionCoordinate instance of vtkCoordinate. This is
used for for complicated or relative positioning. The position variable controls the lower left corner of the
Actor2D
double = obj.GetPosition () - Get the PositionCoordinate instance of vtkCoordinate. This is used
for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D
obj.SetDisplayPosition (int , int ) - Set the Prop2Ds position in display coordinates.
vtkCoordinate = obj.GetPosition2Coordinate () - Access the Position2 instance variable.
This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable
obj.SetPosition2 (double, double) - Access the Position2 instance variable. This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport
coordinates. Some 2D actor subclasses ignore the position2 variable
obj.SetPosition2 (double a[2]) - Access the Position2 instance variable. This variable controls
the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable
double = obj.GetPosition2 () - Access the Position2 instance variable. This variable controls the
upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates.
Some 2D actor subclasses ignore the position2 variable
obj.SetWidth (double w) - Set/Get the height and width of the Actor2D. The value is expressed as
a fraction of the viewport. This really is just another way of setting the Position2 instance variable.
double = obj.GetWidth () - Set/Get the height and width of the Actor2D. The value is expressed
as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.
obj.SetHeight (double h) - Set/Get the height and width of the Actor2D. The value is expressed
as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.
double = obj.GetHeight () - Set/Get the height and width of the Actor2D. The value is expressed
as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.
long = obj.GetMTime () - Return this objects MTime.
obj.GetActors2D (vtkPropCollection pc) - For some exporters and other other operations
we must be able to collect all the actors or volumes. These methods are used in that process.
obj.ShallowCopy (vtkProp prop) - Shallow copy of this vtkActor2D. Overloads the virtual vtkProp
method.
obj.ReleaseGraphicsResources (vtkWindow ) - Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to
release.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
750
32.6
vtkActor2DCollection
32.6.1
Usage
vtkActor2DCollection is a subclass of vtkCollection. vtkActor2DCollection maintains a collection of vtkActor2D objects that is sorted by layer number, with lower layer numbers at the start of the list. This allows the vtkActor2D
objects to be rendered in the correct order.
To create an instance of class vtkActor2DCollection, simply invoke its constructor as follows
obj = vtkActor2DCollection
32.6.2
Methods
The class vtkActor2DCollection has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkActor2DCollection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkActor2DCollection = obj.NewInstance ()
vtkActor2DCollection = obj.SafeDownCast (vtkObject o)
obj.Sort () - Sorts the vtkActor2DCollection by layer number. Smaller layer numbers are first. Layer
numbers can be any integer value.
obj.AddItem (vtkActor2D a) - Add an actor to the list. The new actor is inserted in the list according to its layer number.
int = obj.IsItemPresent (vtkActor2D a) - Standard Collection methods
vtkActor2D = obj.GetNextActor2D () - Standard Collection methods
vtkActor2D = obj.GetLastActor2D () - Standard Collection methods
vtkActor2D = obj.GetNextItem () - Access routines that are provided for compatibility with previous version of VTK. Please use the GetNextActor2D(), GetLastActor2D() variants where possible.
vtkActor2D = obj.GetLastItem () - Access routines that are provided for compatibility with previous version of VTK. Please use the GetNextActor2D(), GetLastActor2D() variants where possible.
obj.RenderOverlay (vtkViewport viewport) - Sort and then render the collection of 2D actors.
32.7
vtkAdjacentVertexIterator
32.8 vtkAlgorithm
32.7.1
751
Usage
vtkAdjacentVertexIterator iterates through all vertices adjacent to a vertex, i.e. the vertices which may be reached
by traversing an out edge of the source vertex. Use graph->GetAdjacentVertices(v, it) to initialize the iterator.
To create an instance of class vtkAdjacentVertexIterator, simply invoke its constructor as follows
obj = vtkAdjacentVertexIterator
32.7.2
Methods
The class vtkAdjacentVertexIterator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAdjacentVertexIterator
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAdjacentVertexIterator = obj.NewInstance ()
vtkAdjacentVertexIterator = obj.SafeDownCast (vtkObject o)
obj.Initialize (vtkGraph g, vtkIdType v) - Initialize the iterator with a graph and vertex.
vtkGraph = obj.GetGraph () - Get the graph and vertex associated with this iterator.
vtkIdType = obj.GetVertex () - Get the graph and vertex associated with this iterator.
vtkIdType = obj.Next () - Whether this iterator has more edges.
bool = obj.HasNext ()
32.8
vtkAlgorithm
32.8.1
Usage
vtkAlgorithm is the superclass for all sources, filters, and sinks in VTK. It defines a generalized interface for executing
data processing algorithms. Pipeline connections are associated with input and output ports that are independent
of the type of data passing through the connections.
Instances may be used independently or within pipelines with a variety of architectures and update mechanisms.
Pipelines are controlled by instances of vtkExecutive. Every vtkAlgorithm instance has an associated vtkExecutive
when it is used in a pipeline. The executive is responsible for data flow.
To create an instance of class vtkAlgorithm, simply invoke its constructor as follows
obj = vtkAlgorithm
32.8.2
Methods
The class vtkAlgorithm has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkAlgorithm class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
752
32.8 vtkAlgorithm
753
obj.SetProgressText (string ptext) - Set the current text message associated with the
progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called
from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify
themselves from inside RequestData().
string = obj.GetProgressText () - Set the current text message associated with the progress
state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside
RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from
inside RequestData().
long = obj.GetErrorCode () - The error code contains a possible error that occured while reading
or writing the file.
obj.SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, string name) - Set the input data arrays that this algorithm will process. Specifically
the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified
association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the
data object the array is stored. See vtkDataObject::FieldAssociations for detail.
obj.SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) - Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection
with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to
which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
obj.SetInputArrayToProcess (int idx, vtkInformation info) - Set the input data
arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting
from 0) is the array on port, connection with the specified association and name or attribute type (such as
SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
obj.SetInputArrayToProcess (int idx, int port, int connection, string
fieldAssociation, string attributeTypeorName) - String based versions of SetInputArrayToProcess(). Because fieldAssociation and fieldAttributeType are enums, they cannot be easily
accessed from scripting language. These methods provides an easy and safe way of passing association
and attribute type information. Field association is one of the following:
vtkDataObject::FIELD_ASSOCIATION_POINTS
vtkDataObject::FIELD_ASSOCIATION_CELLS
vtkDataObject::FIELD_ASSOCIATION_NONE
vtkDataObject::FIELD_ASSOCIATION_POINTS_THEN_CELLS
754
32.9 vtkAlgorithmOutput
755
obj.ReleaseDataFlagOff () - Turn release data flag on or off for all output ports.
int = obj.UpdateExtentIsEmpty (vtkDataObject output) - This detects when the
UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume
(0,-1,...) or the UpdateNumberOfPieces is 0. The source uses this call to determine whether to call Execute.
int = obj.UpdateExtentIsEmpty (vtkInformation pinfo, int extentType)
This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. The source uses this call to determine
whether to call Execute.
double = obj.ComputePriority () - Returns the priority of the piece described by the current
update extent. The priority is a number between 0.0 and 1.0 with 0 meaning skippable (REQUEST_DATA
not needed) and 1.0 meaning important.
32.9
vtkAlgorithmOutput
32.9.1
Usage
vtkAlgorithmOutput is a proxy object returned by the GetOutputPort method of vtkAlgorithm. It may be passed
to the SetInputConnection, AddInputConnection, or RemoveInputConnection methods of another vtkAlgorithm to
establish a connection between an output and input port. The connection is not stored in the proxy object: it is
simply a convenience for creating or removing connections.
To create an instance of class vtkAlgorithmOutput, simply invoke its constructor as follows
obj = vtkAlgorithmOutput
32.9.2
Methods
The class vtkAlgorithmOutput has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkAlgorithmOutput class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAlgorithmOutput = obj.NewInstance ()
vtkAlgorithmOutput = obj.SafeDownCast (vtkObject o)
obj.SetIndex (int index)
int = obj.GetIndex ()
vtkAlgorithm = obj.GetProducer ()
obj.SetProducer (vtkAlgorithm producer)
32.10
vtkAnnotation
756
32.10.1
Usage
vtkAnnotation is a collection of annotation properties along with an associated selection indicating the portion of
data the annotation refers to.
.SECTION Thanks Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories contributed code
to this class.
To create an instance of class vtkAnnotation, simply invoke its constructor as follows
obj = vtkAnnotation
32.10.2
Methods
The class vtkAnnotation has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkAnnotation class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAnnotation = obj.NewInstance ()
vtkAnnotation = obj.SafeDownCast (vtkObject o)
vtkSelection = obj.GetSelection () - The selection to which this set of annotations will apply.
obj.SetSelection (vtkSelection selection) - The selection to which this set of annotations
will apply.
obj.Initialize () - Initialize the annotation to an empty state.
obj.ShallowCopy (vtkDataObject other) - Make this annotation have the same properties and
have the same selection of another annotation.
obj.DeepCopy (vtkDataObject other) - Make this annotation have the same properties and
have a copy of the selection of another annotation.
long = obj.GetMTime () - Get the modified time of this object.
32.11
vtkAnnotationLayers
32.11.1
Usage
vtkAnnotationLayers stores a vector of annotation layers. Each layer may contain any number of vtkAnnotation
objects. The ordering of the layers introduces a prioritization of annotations. Annotations in higher layers may
obscure annotations in lower layers.
To create an instance of class vtkAnnotationLayers, simply invoke its constructor as follows
obj = vtkAnnotationLayers
32.12 vtkAnnotationLayersAlgorithm
32.11.2
757
Methods
The class vtkAnnotationLayers has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkAnnotationLayers class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAnnotationLayers = obj.NewInstance ()
vtkAnnotationLayers = obj.SafeDownCast (vtkObject o)
obj.SetCurrentAnnotation (vtkAnnotation ann) - The current annotation associated with
this annotation link.
vtkAnnotation = obj.GetCurrentAnnotation () - The current annotation associated with
this annotation link.
obj.SetCurrentSelection (vtkSelection sel) - The current selection associated with this
annotation link. This is simply the selection contained in the current annotation.
vtkSelection = obj.GetCurrentSelection () - The current selection associated with this annotation link. This is simply the selection contained in the current annotation.
int = obj.GetNumberOfAnnotations () - The number of annotations in a specific layer.
vtkAnnotation = obj.GetAnnotation (int idx) - Retrieve an annotation from a layer.
obj.AddAnnotation (vtkAnnotation ann) - Add an annotation to a layer.
obj.RemoveAnnotation (vtkAnnotation ann) - Remove an annotation from a layer.
obj.Initialize () - Initialize the data structure to an empty state.
obj.ShallowCopy (vtkDataObject other) - Copy data from another data object into this one
which references the same member annotations.
obj.DeepCopy (vtkDataObject other) - Copy data from another data object into this one, performing a deep copy of member annotations.
long = obj.GetMTime () - The modified time for this object.
32.12
vtkAnnotationLayersAlgorithm
32.12.1
Usage
vtkAnnotationLayersAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help
transition old algorithms to the new pipeline architecture. There are some assumptions and defaults made by this
class you should be aware of. This class defaults such that your filter will have one input port and one output port. If
that is not the case simply change it with SetNumberOfInputPorts etc. See this class constructor for the default. This
class also provides a FillInputPortInfo method that by default says that all inputs will be vtkAnnotationLayers. If that
isnt the case then please override this method in your subclass. This class breaks out the downstream requests
into separate functions such as ExecuteData and ExecuteInformation. For new algorithms you should implement
RequestData( request, inputVec, outputVec) but for older filters there is a default implementation that calls the old
ExecuteData(output) signature. For even older filters that dont implement ExecuteData the default implementation
calls the even older Execute() signature.
To create an instance of class vtkAnnotationLayersAlgorithm, simply invoke its constructor as follows
obj = vtkAnnotationLayersAlgorithm
758
32.12.2
Methods
The class vtkAnnotationLayersAlgorithm has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAnnotationLayersAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAnnotationLayersAlgorithm = obj.NewInstance ()
vtkAnnotationLayersAlgorithm = obj.SafeDownCast (vtkObject o)
vtkAnnotationLayers = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkAnnotationLayers = obj.GetOutput (int index) - Get the output data object for a port
on this algorithm.
obj.SetInput (vtkDataObject obj) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
obj.SetInput (int index, vtkDataObject obj) - Set an input of this algorithm. You should
not override these methods because they are not the only way to connect a pipeline. Note that these methods
support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
32.13
vtkArrayData
32.13.1
Usage
Because vtkArray cannot be stored as attributes of data objects (yet), a "carrier" object is needed to pass vtkArray
through the pipeline. vtkArrayData acts as a container of zero-to-many vtkArray instances, which can be retrieved
via a zero-based index. Note that a collection of arrays stored in vtkArrayData may-or-may-not have related types,
dimensions, or extents.
To create an instance of class vtkArrayData, simply invoke its constructor as follows
obj = vtkArrayData
32.13.2
Methods
The class vtkArrayData has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkArrayData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkArrayData = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.14 vtkArrayDataAlgorithm
759
32.14
vtkArrayDataAlgorithm
32.14.1
Usage
vtkArrayDataAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition
old algorithms to the new pipeline architecture. There are some assumptions and defaults made by this class you
should be aware of. This class defaults such that your filter will have one input port and one output port. If that is not
the case simply change it with SetNumberOfInputPorts etc. See this class constructor for the default. This class also
provides a FillInputPortInfo method that by default says that all inputs will be vtkArrayData. If that isnt the case then
please override this method in your subclass. This class breaks out the downstream requests into separate functions
such as ExecuteData and ExecuteInformation. For new algorithms you should implement RequestData( request,
inputVec, outputVec) but for older filters there is a default implementation that calls the old ExecuteData(output)
signature. For even older filters that dont implement ExecuteData the default implementation calls the even older
Execute() signature.
To create an instance of class vtkArrayDataAlgorithm, simply invoke its constructor as follows
obj = vtkArrayDataAlgorithm
32.14.2
Methods
The class vtkArrayDataAlgorithm has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkArrayDataAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkArrayDataAlgorithm = obj.NewInstance ()
vtkArrayDataAlgorithm = obj.SafeDownCast (vtkObject o)
vtkArrayData = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkArrayData = obj.GetOutput (int index) - Get the output data object for a port on this
algorithm.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
760
32.15
vtkAttributesErrorMetric
32.15.1
Usage
It is a concrete error metric, based on an attribute criterium: the variation of the active attribute/component value
from a linear ramp
To create an instance of class vtkAttributesErrorMetric, simply invoke its constructor as follows
obj = vtkAttributesErrorMetric
32.15.2
Methods
The class vtkAttributesErrorMetric has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAttributesErrorMetric
class.
string = obj.GetClassName () - Standard VTK type and error macros.
int = obj.IsA (string name) - Standard VTK type and error macros.
vtkAttributesErrorMetric = obj.NewInstance () - Standard VTK type and error macros.
vtkAttributesErrorMetric = obj.SafeDownCast (vtkObject o) - Standard VTK type
and error macros.
double = obj.GetAbsoluteAttributeTolerance () - Absolute tolerance of the active scalar
(attribute+component). Subdivision is required if the square distance between the real attribute at the mid
point on the edge and the interpolated attribute is greater than AbsoluteAttributeTolerance. This is the attribute
accuracy. 0.01 will give better result than 0.1.
obj.SetAbsoluteAttributeTolerance (double value) - Set the absolute attribute accuracy to value. See GetAbsoluteAttributeTolerance() for details. It is particularly useful when some concrete
implementation of vtkGenericAttribute does not support GetRange() request, called internally in SetAttributeTolerance(). It may happen when the implementation support higher order attributes but cannot compute the
range.
32.16 vtkBiQuadraticQuad
761
Precondition
valid_range_value: value>0
double = obj.GetAttributeTolerance () - Relative tolerance of the active scalar (attribute+component). Subdivision is required if the square distance between the real attribute at the mid
point on the edge and the interpolated attribute is greater than AttributeTolerance. This is the attribute
accuracy. 0.01 will give better result than 0.1.
obj.SetAttributeTolerance (double value) - Set the relative attribute accuracy to value.
See GetAttributeTolerance() for details.
Precondition
valid_range_value: value>0 && value<1
int = obj.RequiresEdgeSubdivision (double leftPoint, double midPoint,
double rightPoint, double alpha) - Does the edge need to be subdivided according to the
distance between the value of the active attribute/component at the midpoint and the mean value between
the endpoints? The edge is defined by its leftPoint and its rightPoint. leftPoint, midPoint and rightPoint
have to be initialized before calling RequiresEdgeSubdivision(). Their format is global coordinates, parametric
coordinates and point centered attributes: xyx rst abc de... alpha is the normalized abscissa of the midpoint
along the edge. (close to 0 means close to the left point, close to 1 means close to the right point)
Precondition
leftPoint_exists: leftPoint!=0
midPoint_exists: midPoint!=0
rightPoint_exists: rightPoint!=0
clamped_alpha: alpha>0 && alpha<1
valid_size: sizeof(leftPoint)=sizeof(midPoint)=sizeof(rightPoint) =GetAttributeCollection()->GetNumberOfPointCenteredComponents()+6
double = obj.GetError (double leftPoint, double midPoint, double rightPoint, double alpha) - Return the error at the mid-point. The type of error depends on the state of
the concrete error metric. For instance, it can return an absolute or relative error metric. See RequiresEdgeSubdivision() for a description of the arguments.
Precondition
leftPoint_exists: leftPoint!=0
midPoint_exists: midPoint!=0
rightPoint_exists: rightPoint!=0
clamped_alpha: alpha>0 && alpha<1
valid_size: sizeof(leftPoint)=sizeof(midPoint)=sizeof(rightPoint) =GetAttributeCollection()->GetNumberOfPointCenteredComponents()+6
Postcondition
positive_result: result>=0
32.16
vtkBiQuadraticQuad
32.16.1
Usage
762
a center node at the surface. The ordering of the eight points defining the cell are point ids (0-3,4-8) where ids 0-3
define the four corner vertices of the quad; ids 4-7 define the midedge nodes (0,1), (1,2), (2,3), (3,0) and 8 define
the face center node.
To create an instance of class vtkBiQuadraticQuad, simply invoke its constructor as follows
obj = vtkBiQuadraticQuad
32.16.2
Methods
The class vtkBiQuadraticQuad has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkBiQuadraticQuad class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBiQuadraticQuad = obj.NewInstance ()
vtkBiQuadraticQuad = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - Implement the vtkCell API. See the vtkCell API for descriptions of these
methods.
int = obj.GetCellDimension () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfEdges () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfFaces () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetEdge (int ) - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetFace (int )
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
obj.Contour (double value, vtkDataArray cellScalars, vtkIncremental-
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.17 vtkBiQuadraticQuadraticHexahedron
32.17
763
vtkBiQuadraticQuadraticHexahedron
32.17.1
Usage
vtkBiQuadraticQuadraticHexahedron is a concrete implementation of vtkNonLinearCell to represent a threedimensional, 24-node isoparametric biquadratic hexahedron. The interpolation is the standard finite element,
biquadratic-quadratic isoparametric shape function. The cell includes mid-edge and center-face nodes. The ordering of the 24 points defining the cell is point ids (0-7,8-19, 20-23) where point ids 0-7 are the eight corner
vertices of the cube; followed by twelve midedge nodes (8-19), nodes 20-23 are the center-face nodes. Note that
these midedge nodes correspond lie on the edges defined by (0,1), (1,2), (2,3), (3,0), (4,5), (5,6), (6,7), (7,4), (0,4),
(1,5), (2,6), (3,7). The center face nodes lieing in quad 22-(0,1,5,4), 21-(1,2,6,5), 23-(2,3,7,6) and 22-(3,0,4,7)
top
7--14--6
|
|
15
13
|
|
4--12--5
middle
19--23--18
|
|
20
21
|
|
16--22--17
bottom
3--10--2
|
|
11
9
|
|
0-- 8--1
32.17.2
Methods
The class vtkBiQuadraticQuadraticHexahedron has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkBiQuadraticQuadraticHexahedron class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBiQuadraticQuadraticHexahedron = obj.NewInstance ()
vtkBiQuadraticQuadraticHexahedron = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - Implement the vtkCell API. See the vtkCell API for descriptions of these
methods.
int = obj.GetCellDimension () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfEdges () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
764
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.18
vtkBiQuadraticQuadraticWedge
32.18.1
Usage
32.18.2
Methods
The class vtkBiQuadraticQuadraticWedge has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkBiQuadraticQuadraticWedge class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.19 vtkBiQuadraticTriangle
765
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.19
vtkBiQuadraticTriangle
766
32.19.1
Usage
32.19.2
Methods
The class vtkBiQuadraticTriangle has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkBiQuadraticTriangle class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBiQuadraticTriangle = obj.NewInstance ()
vtkBiQuadraticTriangle = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - Implement the vtkCell API. See the vtkCell API for descriptions of these
methods.
int = obj.GetCellDimension () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfEdges () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfFaces () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetEdge (int edgeId) - Implement the vtkCell API. See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int )
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
obj.Contour (double value, vtkDataArray cellScalars, vtkIncremental-
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.20 vtkBSPCuts
767
32.20
vtkBSPCuts
32.20.1
Usage
This class converts between the vtkKdTree representation of a tree of vtkKdNodes (used by vtkDistributedDataFilter) and a compact array representation that might be provided by a graph partitioning library like Zoltan. Such a
representation could be used in message passing.
To create an instance of class vtkBSPCuts, simply invoke its constructor as follows
obj = vtkBSPCuts
32.20.2
Methods
The class vtkBSPCuts has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkBSPCuts class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBSPCuts = obj.NewInstance ()
vtkBSPCuts = obj.SafeDownCast (vtkObject o)
obj.CreateCuts (double bounds, int ncuts, int dim, double coord, int
32.21
vtkBSPIntersections
768
32.21.1
Usage
Given an axis aligned binary spatial partitioning described by a vtkBSPCuts object, perform intersection queries on
various geometric entities with regions of the spatial partitioning.
To create an instance of class vtkBSPIntersections, simply invoke its constructor as follows
obj = vtkBSPIntersections
32.21.2
Methods
The class vtkBSPIntersections has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkBSPIntersections class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBSPIntersections = obj.NewInstance ()
vtkBSPIntersections = obj.SafeDownCast (vtkObject o)
obj.SetCuts (vtkBSPCuts cuts)
vtkBSPCuts = obj.GetCuts ()
int = obj.GetBounds (double bounds)
int = obj.GetNumberOfRegions ()
int = obj.GetRegionBounds (int regionID, double bounds[6])
int = obj.GetRegionDataBounds (int regionID, double bounds[6])
int = obj.IntersectsBox (int regionId, double x) - Determine whether a region of the
spatial decomposition intersects an axis aligned box.
int = obj.IntersectsBox (int regionId, double xmin, double xmax, double
ymin, double ymax, double zmin, double zmax) - Determine whether a region of the
spatial decomposition intersects an axis aligned box.
int = obj.IntersectsBox (int ids, int len, double x) - Compute a list of the Ids of
all regions that intersect the specified axis aligned box. Returns: the number of ids in the list.
int = obj.IntersectsBox (int ids, int len, double x0, double x1, double
y0, double y1, double z0, double z1) - Compute a list of the Ids of all regions that intersect
the specified axis aligned box. Returns: the number of ids in the list.
int = obj.IntersectsSphere2 (int regionId, double x, double y, double
z, double rSquared) - Determine whether a region of the spatial decomposition intersects a sphere,
given the center of the sphere and the square of its radius.
int = obj.IntersectsSphere2 (int ids, int len, double x, double y, double
z, double rSquared) - Compute a list of the Ids of all regions that intersect the specified sphere. The
sphere is given by its center and the square of its radius. Returns: the number of ids in the list.
int = obj.IntersectsCell (int regionId, vtkCell cell, int cellRegion) Determine whether a region of the spatial decomposition intersects the given cell. If you already know the
region that the cell centroid lies in, provide that as the last argument to make the computation quicker.
int = obj.IntersectsCell (int ids, int len, vtkCell cell, int cellRegion) - Compute a list of the Ids of all regions that intersect the given cell. If you alrady know the
region that the cell centroid lies in, provide that as the last argument to make the computation quicker.
Returns the number of regions the cell intersects.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.22 vtkCachedStreamingDemandDrivenPipeline
769
int = obj.GetComputeIntersectionsUsingDataBounds ()
obj.SetComputeIntersectionsUsingDataBounds (int c)
obj.ComputeIntersectionsUsingDataBoundsOn ()
obj.ComputeIntersectionsUsingDataBoundsOff ()
32.22
vtkCachedStreamingDemandDrivenPipeline
32.22.1
Usage
vtkCachedStreamingDemandDrivenPipeline
To create an instance of class vtkCachedStreamingDemandDrivenPipeline, simply invoke its constructor as follows
obj = vtkCachedStreamingDemandDrivenPipeline
32.22.2
Methods
The class vtkCachedStreamingDemandDrivenPipeline has several methods that can be used. They are listed
below. Note that the documentation is translated automatically from the VTK sources, and may not be completely
intelligible. When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCachedStreamingDemandDrivenPipeline class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCachedStreamingDemandDrivenPipeline = obj.NewInstance ()
vtkCachedStreamingDemandDrivenPipeline = obj.SafeDownCast (vtkObject o)
int = obj.Update () - Bring the algorithms outputs up-to-date.
int = obj.Update (int port) - Bring the algorithms outputs up-to-date.
obj.SetCacheSize (int size) - This is the maximum number of images that can be retained in
memory. it defaults to 10.
int = obj.GetCacheSize () - This is the maximum number of images that can be retained in memory. it defaults to 10.
32.23
vtkCardinalSpline
32.23.1
Usage
770
32.23.2
Methods
The class vtkCardinalSpline has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkCardinalSpline class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCardinalSpline = obj.NewInstance ()
vtkCardinalSpline = obj.SafeDownCast (vtkObject o)
obj.Compute ()
double = obj.Evaluate (double t) - Evaluate a 1D cardinal spline.
obj.DeepCopy (vtkSpline s) - Deep copy of cardinal spline data.
32.24
vtkCastToConcrete
32.24.1
Usage
vtkCastToConcrete is a filter that works around type-checking limitations in the filter classes. Some filters generate
abstract types on output, and cannot be connected to the input of filters requiring a concrete input type. For example,
vtkElevationFilter generates vtkDataSet for output, and cannot be connected to vtkDecimate, because vtkDecimate
requires vtkPolyData as input. This is true even though (in this example) the input to vtkElevationFilter is of type
vtkPolyData, and you know the output of vtkElevationFilter is the same type as its input.
vtkCastToConcrete performs run-time checking to insure that output type is of the right type. An error message will
result if you try to cast an input type improperly. Otherwise, the filter performs the appropriate cast and returns the
data.
To create an instance of class vtkCastToConcrete, simply invoke its constructor as follows
obj = vtkCastToConcrete
32.24.2
Methods
The class vtkCastToConcrete has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkCastToConcrete class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCastToConcrete = obj.NewInstance ()
vtkCastToConcrete = obj.SafeDownCast (vtkObject o)
32.25
vtkCell
32.25 vtkCell
32.25.1
771
Usage
vtkCell is an abstract class that specifies the interfaces for data cells. Data cells are simple topological elements like
points, lines, polygons, and tetrahedra of which visualization datasets are composed. In some cases visualization
datasets may explicitly represent cells (e.g., vtkPolyData, vtkUnstructuredGrid), and in some cases, the datasets
are implicitly composed of cells (e.g., vtkStructuredPoints).
To create an instance of class vtkCell, simply invoke its constructor as follows
obj = vtkCell
32.25.2
Methods
The class vtkCell has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCell class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCell = obj.NewInstance ()
vtkCell = obj.SafeDownCast (vtkObject o)
obj.ShallowCopy (vtkCell c) - Copy this cell by reference counting the internal data structures.
This is safe if you want a "read-only" copy. If you modify the cell you might wish to use DeepCopy().
obj.DeepCopy (vtkCell c) - Copy this cell by completely copying internal data structures. This is
slower but safer than ShallowCopy().
int = obj.GetCellType () - Return the type of cell.
int = obj.GetCellDimension () - Return the topological dimensional of the cell (0,1,2, or 3).
int = obj.IsLinear () - Some cells require initialization prior to access. For example, they may
have to triangulate themselves or set up internal data structures.
int = obj.RequiresInitialization () - Some cells require initialization prior to access. For
example, they may have to triangulate themselves or set up internal data structures.
obj.Initialize () - Explicit cells require additional representational information beyond the usual cell
type and connectivity list information. Most cells in VTK are implicit cells.
int = obj.IsExplicitCell () - Get the point coordinates for the cell.
vtkPoints = obj.GetPoints () - Return the number of points in the cell.
vtkIdType = obj.GetNumberOfPoints () - Return the number of edges in the cell.
int = obj.GetNumberOfEdges () - Return the number of edges in the cell.
int = obj.GetNumberOfFaces () - Return the number of faces in the cell.
vtkIdList = obj.GetPointIds () - For cell point i, return the actual point id.
vtkIdType = obj.GetPointId (int ptId) - Return the edge cell from the edgeId of the cell.
vtkCell = obj.GetEdge (int edgeId) - Return the edge cell from the edgeId of the cell.
vtkCell = obj.GetFace (int faceId) - Return the face cell from the faceId of the cell.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is inside or outside of the cell. The cell boundary is defined by a list of points (pts) that specify a face (3D cell),
edge (2D cell), or vertex (1D cell). If the return value of the method is != 0, then the point is inside the cell.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
772
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - Generate contouring primitives. The scalar list
cellScalars are scalar values at each cell point. The point locator is essentially a points list that merges points
as they are inserted (i.e., prevents duplicates). Contouring primitives can be vertices, lines, or polygons. It is
possible to interpolate point data along the edge by providing input and output point data - if outPd is NULL,
then no interpolation is performed. Also, if the output cell data is non-NULL, the cell data from the contoured
cell is passed to the generated contouring primitives. (Note: the CopyAllocate() method must be invoked on
both the output cell and point data. The cellId refers to the cell from which the cell data is copied.)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
Locator locator, vtkCellArray connectivity, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData outCd,
int insideOut) - Cut (or clip) the cell based on the input cellScalars and the specified value. The output
of the clip operation will be one or more cells of the same topological dimension as the original cell. The
flag insideOut controls what part of the cell is considered inside - normally cell points whose scalar value is
greater than "value" are considered inside. If insideOut is on, this is reversed. Also, if the output cell data is
non-NULL, the cell data from the clipped cell is passed to the generated contouring primitives. (Note: the
CopyAllocate() method must be invoked on both the output cell and point data. The cellId refers to the cell
from which the cell data is copied.)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts) - Generate simplices of proper dimension. If cell is 3D, tetrahedron are generated; if 2D triangles; if 1D lines; if
0D points. The form of the output is a sequence of points, each n+1 points (where n is topological cell dimension) defining a simplex. The index is a parameter that controls which triangulation to use (if more than one
is possible). If numerical degeneracy encountered, 0 is returned, otherwise 1 is returned. This method does
not insert new points: all the points that define the simplices are the points that define the cell.
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs) - Compute derivatives given cell subId and parametric coordinates. The values array
is a series of data value(s) at the cell points. There is a one-to-one correspondence between cell point and
data value(s). Dim is the number of data values per cell point. Derivs are derivatives in the x-y-z coordinate
directions for each data value. Thus, if computing derivatives for a scalar function in a hexahedron, dim=1,
8 values are supplied, and 3 deriv values are returned (i.e., derivatives in x-y-z directions). On the other
hand, if computing derivatives of velocity (vx,vy,vz) dim=3, 24 values are supplied ((vx,vy,vz)1, (vx,vy,vz)2,
....()8), and 9 deriv values are returned ((d(vx)/dx),(d(vx)/dy),(d(vx)/dz), (d(vy)/dx),(d(vy)/dy), (d(vy)/dz),
(d(vz)/dx),(d(vz)/dy),(d(vz)/dz)).
obj.GetBounds (double bounds[6]) - Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax).
Copy result into user provided array.
double = obj.GetBounds () - Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax). Return pointer to array of six double values.
double = obj.GetLength2 () - Compute Length squared of cell (i.e., bounding box diagonal
squared).
int = obj.GetParametricCenter (double pcoords[3]) - Return center of the cell in parametric coordinates. Note that the parametric center is not always located at (0.5,0.5,0.5). The return value
is the subId that the center is in (if a composite cell). If you want the center in x-y-z space, invoke the
EvaluateLocation() method.
double = obj.GetParametricDistance (double pcoords[3]) - Return the distance of
the parametric coordinate provided to the cell. If inside the cell, a distance of zero is returned. This is
used during picking to get the correct cell picked. (The tolerance will occasionally allow cells to be picked who
are not really intersected "inside" the cell.)
int = obj.IsPrimaryCell () - Return a contiguous array of parametric coordinates of the points
defining this cell. In other words, (px,py,pz, px,py,pz, etc..) The coordinates are ordered consistent with
the definition of the point ordering for the cell. This method returns a non-NULL pointer when the cell is a
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.26 vtkCell3D
773
primary type (i.e., IsPrimaryCell() is true). Note that 3D parametric coordinates are returned no matter what
the topological dimension of the cell.
obj.InterpolateFunctions (double pcoords[3], double weights[3]) - Compute
the interpolation functions/derivatives (aka shape functions/derivatives) No-ops at this level. Typically overridden in subclasses.
obj.InterpolateDerivs (double pcoords[3], double derivs[3])
32.26
vtkCell3D
32.26.1
Usage
vtkCell3D is an abstract class that extends the interfaces for 3D data cells, and implements methods needed to
satisfy the vtkCell API. The 3D cells include hexehedra, tetrahedra, wedge, pyramid, and voxel.
To create an instance of class vtkCell3D, simply invoke its constructor as follows
obj = vtkCell3D
32.26.2
Methods
The class vtkCell3D has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCell3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCell3D = obj.NewInstance ()
vtkCell3D = obj.SafeDownCast (vtkObject o)
obj.Contour (double value, vtkDataArray cellScalars, vtkIncremental-
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
Locator locator, vtkCellArray connectivity, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData outCd,
int insideOut) - Cut (or clip) the cell based on the input cellScalars and the specified value. The output
of the clip operation will be one or more cells of the same topological dimension as the original cell. The
flag insideOut controls what part of the cell is considered inside - normally cell points whose scalar value is
greater than "value" are considered inside. If insideOut is on, this is reversed. Also, if the output cell data is
non-NULL, the cell data from the clipped cell is passed to the generated contouring primitives. (Note: the
CopyAllocate() method must be invoked on both the output cell and point data. The cellId refers to the cell
from which the cell data is copied.) (Satisfies vtkCell API.)
int = obj.GetCellDimension () - Set the tolerance for merging clip intersection points that are
near the vertices of cells. This tolerance is used to prevent the generation of degenerate tetrahedra during
clipping.
obj.SetMergeTolerance (double ) - Set the tolerance for merging clip intersection points that are
near the vertices of cells. This tolerance is used to prevent the generation of degenerate tetrahedra during
clipping.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
774
32.27
vtkCellArray
32.27.1
Usage
vtkCellArray is a supporting object that explicitly represents cell connectivity. The cell array structure is a raw integer
list of the form: (n,id1,id2,...,idn, n,id1,id2,...,idn, ...) where n is the number of points in the cell, and id is a zero-offset
index into an associated point list.
Advantages of this data structure are its compactness, simplicity, and easy interface to external data. However, it
is totally inadequate for random access. This functionality (when necessary) is accomplished by using the vtkCellTypes and vtkCellLinks objects to extend the definition of the data structure.
To create an instance of class vtkCellArray, simply invoke its constructor as follows
obj = vtkCellArray
32.27.2
Methods
The class vtkCellArray has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCellArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCellArray = obj.NewInstance ()
vtkCellArray = obj.SafeDownCast (vtkObject o)
int = obj.Allocate (vtkIdType sz, int ext) - Free any memory and reset to an empty
state.
obj.Initialize () - Free any memory and reset to an empty state.
vtkIdType = obj.GetNumberOfCells () - Get the number of cells in the array.
obj.SetNumberOfCells (vtkIdType ) - Set the number of cells in the array. DO NOT do any kind
of allocation, advanced use only.
vtkIdType = obj.EstimateSize (vtkIdType numCells, int maxPtsPerCell) - A
cell traversal methods that is more efficient than vtkDataSet traversal methods. InitTraversal() initializes the
traversal of the list of cells.
obj.InitTraversal () - A cell traversal methods that is more efficient than vtkDataSet traversal methods. InitTraversal() initializes the traversal of the list of cells.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.27 vtkCellArray
775
vtkIdType = obj.GetSize () - Get the total number of entries (i.e., data values) in the connectivity
array. This may be much less than the allocated size (i.e., return value from GetSize().)
vtkIdType = obj.GetNumberOfConnectivityEntries () - Internal method used to retrieve
a cell given an offset into the internal array.
vtkIdType = obj.InsertNextCell (vtkCell cell) - Insert a cell object. Return the cell id
of the cell.
vtkIdType = obj.InsertNextCell (vtkIdList pts) - Create a cell by specifying a list of
point ids. Return the cell id of the cell.
vtkIdType = obj.InsertNextCell (int npts) - Create cells by specifying count, and then
adding points one at a time using method InsertCellPoint(). If you dont know the count initially, use the
method UpdateCellCount() to complete the cell. Return the cell id of the cell.
obj.InsertCellPoint (vtkIdType id) - Used in conjunction with InsertNextCell(int npts) to add
another point to the list of cells.
obj.UpdateCellCount (int npts) - Used in conjunction with InsertNextCell(int npts) and InsertCellPoint() to update the number of points defining the cell.
vtkIdType = obj.GetInsertLocation (int npts) - Computes the current insertion location
within the internal array. Used in conjunction with GetCell(int loc,...).
vtkIdType = obj.GetTraversalLocation () - Get/Set the current traversal location.
obj.SetTraversalLocation (vtkIdType loc) - Computes the current traversal location within
the internal array. Used in conjunction with GetCell(int loc,...).
vtkIdType = obj.GetTraversalLocation (vtkIdType npts) - Special method inverts ordering of current cell. Must be called carefully or the cell topology may be corrupted.
obj.ReverseCell (vtkIdType loc) - Special method inverts ordering of current cell. Must be
called carefully or the cell topology may be corrupted.
int = obj.GetMaxCellSize () - Returns the size of the largest cell. The size is the number of
points defining the cell.
vtkIdType = obj.GetPointer () - Get pointer to data array for purpose of direct writes of data.
Size is the total storage consumed by the cell array. ncells is the number of cells represented in the array.
vtkIdType = obj.WritePointer (vtkIdType ncells, vtkIdType size) - Get pointer
to data array for purpose of direct writes of data. Size is the total storage consumed by the cell array. ncells
is the number of cells represented in the array.
obj.SetCells (vtkIdType ncells, vtkIdTypeArray cells) - Define multiple cells by
providing a connectivity list. The list is in the form (npts,p0,p1,...p(npts-1), repeated for each cell). Be careful
using this method because it discards the old cells, and anything referring these cells becomes invalid (for
example, if BuildCells() has been called see vtkPolyData). The traversal location is reset to the beginning of
the list; the insertion location is set to the end of the list.
obj.DeepCopy (vtkCellArray ca) - Perform a deep copy (no reference counting) of the given cell
array.
vtkIdTypeArray = obj.GetData () - Reuse list. Reset to initial condition.
obj.Reset () - Reuse list. Reset to initial condition.
obj.Squeeze () - Return the memory in kilobytes consumed by this cell array. Used to support streaming
and reading/writing data. The value returned is guaranteed to be greater than or equal to the memory required
to actually represent the data represented by this object. The information returned is valid only after the
pipeline has been updated.
long = obj.GetActualMemorySize () - Return the memory in kilobytes consumed by this cell array. Used to support streaming and reading/writing data. The value returned is guaranteed to be greater than
or equal to the memory required to actually represent the data represented by this object. The information
returned is valid only after the pipeline has been updated.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
776
32.28
vtkCellData
32.28.1
Usage
vtkCellData is a class that is used to represent and manipulate cell attribute data (e.g., scalars, vectors, normals,
texture coordinates, etc.) Special methods are provided to work with filter objects, such as passing data through
filter, copying data from one cell to another, and interpolating data given cell interpolation weights.
To create an instance of class vtkCellData, simply invoke its constructor as follows
obj = vtkCellData
32.28.2
Methods
The class vtkCellData has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCellData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCellData = obj.NewInstance ()
vtkCellData = obj.SafeDownCast (vtkObject o)
32.29
vtkCellLinks
32.29.1
Usage
vtkCellLinks is a supplemental object to vtkCellArray and vtkCellTypes, enabling access from points to the cells
using the points. vtkCellLinks is a list of Links, each link represents a dynamic list of cell ids using the point.
The information provided by this object can be used to determine neighbors and construct other local topological
information.
To create an instance of class vtkCellLinks, simply invoke its constructor as follows
obj = vtkCellLinks
32.29.2
Methods
The class vtkCellLinks has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCellLinks class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCellLinks = obj.NewInstance ()
vtkCellLinks = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.30 vtkCellLocator
777
32.30
vtkCellLocator
32.30.1
Usage
vtkCellLocator is a spatial search object to quickly locate cells in 3D. vtkCellLocator uses a uniform-level octree
subdivision, where each octant (an octant is also referred to as a bucket) carries an indication of whether it is empty
or not, and each leaf octant carries a list of the cells inside of it. (An octant is not empty if it has one or more cells
inside of it.) Typical operations are intersection with a line to return candidate cells, or intersection with another
vtkCellLocator to return candidate cells.
To create an instance of class vtkCellLocator, simply invoke its constructor as follows
obj = vtkCellLocator
778
32.30.2
Methods
The class vtkCellLocator has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCellLocator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCellLocator = obj.NewInstance ()
vtkCellLocator = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfCellsPerBucket (int N) - Specify the average number of cells in each octant.
int = obj.GetNumberOfCellsPerBucket () - reimplemented from vtkAbstractCellLocator to
support bad compilers
int = obj.IntersectWithLine (double a0[3], double a1[3], vtkPoints points,
vtkIdList cellIds) - Return intersection point (if any) AND the cell which was intersected by the
finite line. The cell is returned as a cell id and as a generic cell. For other IntersectWithLine signatures, see
vtkAbstractCellLocator
vtkIdList = obj.GetCells (int bucket) - Get the cells in a particular bucket.
int = obj.GetNumberOfBuckets (void ) - Return number of buckets available. Insure that the
locator has been built before attempting to access buckets (octants).
vtkIdType = obj.FindCell (double x[3]) - Find the cell containing a given point. returns -1
if no cell found the cell parameters are copied into the supplied variables, a cell must be provided to store the
information.
vtkIdType = obj.FindCell (double x[3], double tol2, vtkGenericCell GenCell, double pcoords[3], double weights) - Find the cell containing a given point. returns
-1 if no cell found the cell parameters are copied into the supplied variables, a cell must be provided to store
the information.
obj.FindCellsWithinBounds (double bbox, vtkIdList cells) - Return a list of unique
cell ids inside of a given bounding box. The user must provide the vtkIdList to populate. This method returns
data only after the locator has been built.
obj.FindCellsAlongLine (double p1[3], double p2[3], double tolerance,
vtkIdList cells) - Given a finite line defined by the two points (p1,p2), return the list of unique
cell ids in the buckets containing the line. It is possible that an empty cell list is returned. The user must
provide the vtkIdList to populate. This method returns data only after the locator has been built.
obj.FreeSearchStructure () - Satisfy vtkLocator abstract interface.
obj.BuildLocator () - Satisfy vtkLocator abstract interface.
obj.BuildLocatorIfNeeded () - Satisfy vtkLocator abstract interface.
obj.ForceBuildLocator () - Satisfy vtkLocator abstract interface.
obj.BuildLocatorInternal () - Satisfy vtkLocator abstract interface.
obj.GenerateRepresentation (int level, vtkPolyData pd) - Satisfy vtkLocator abstract interface.
32.31
vtkCellLocatorInterpolatedVelocityField
32.31 vtkCellLocatorInterpolatedVelocityField
32.31.1
779
Usage
32.31.2
Methods
The class vtkCellLocatorInterpolatedVelocityField has several methods that can be used. They are listed below.
Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCellLocatorInterpolatedVelocityField class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCellLocatorInterpolatedVelocityField = obj.NewInstance ()
vtkCellLocatorInterpolatedVelocityField = obj.SafeDownCast (vtkObject
o)
vtkAbstractCellLocator = obj.GetLastCellLocator () - Get the cell locator attached to
the most recently visited dataset.
vtkAbstractCellLocator = obj.GetCellLocatorPrototype () - Get the prototype of the
cell locator that is used for interpolating the velocity field during integration.
obj.SetCellLocatorPrototype (vtkAbstractCellLocator prototype) - Set a prototype of the cell locator that is used for interpolating the velocity field during integration.
obj.CopyParameters (vtkAbstractInterpolatedVelocityField from) - Import parameters. Sub-classes can add more after chaining.
obj.AddDataSet (vtkDataSet dataset) - Add a dataset coupled with a cell locator (of type vtkAbstractCellLocator) for vector function evaluation. Note the use of a vtkAbstractCellLocator enables robust
cell location. If more than one dataset is added, the evaluation point is searched in all until a match is found.
THIS FUNCTION DOES NOT CHANGE THE REFERENCE COUNT OF dataset FOR THREAD SAFETY
REASONS.
int = obj.FunctionValues (double x, double f) - Evaluate the velocity field f at point (x,
y, z).
obj.SetLastCellId (vtkIdType c, int dataindex) - Set the cell id cached by the last evaluation within a specified dataset.
obj.SetLastCellId (vtkIdType c)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
780
32.32
vtkCellTypes
32.32.1
Usage
This class is a supplemental object to vtkCellArray to allow random access into cells as well as representing cell
type information. The "location" field is the location in the vtkCellArray list in terms of an integer offset. An integer
offset was used instead of a pointer for easy storage and inter-process communication. The type information is
defined in the file vtkCellType.h.
To create an instance of class vtkCellTypes, simply invoke its constructor as follows
obj = vtkCellTypes
32.32.2
Methods
The class vtkCellTypes has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCellTypes class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCellTypes = obj.NewInstance ()
vtkCellTypes = obj.SafeDownCast (vtkObject o)
int = obj.Allocate (int sz, int ext) - Allocate memory for this array. Delete old storage
only if necessary.
obj.InsertCell (int id, char type, int loc) - Add a cell at specified id.
int = obj.InsertNextCell (char type, int loc) - Add a cell to the object in the next available slot.
obj.SetCellTypes (int ncells, vtkUnsignedCharArray cellTypes, vtkIntArray cellLocations) - Specify a group of cell types.
int = obj.GetCellLocation (int cellId) - Return the location of the cell in the associated
vtkCellArray.
obj.DeleteCell (vtkIdType cellId) - Delete cell by setting to NULL cell type.
int = obj.GetNumberOfTypes () - Return the number of types in the list.
int = obj.IsType (char type) - Return 1 if type specified is contained in list; 0 otherwise.
int = obj.InsertNextType (char type) - Add the type specified to the end of the list. Range
checking is performed.
char = obj.GetCellType (int cellId) - Return the type of cell.
obj.Squeeze () - Reclaim any extra memory.
obj.Reset () - Initialize object without releasing memory.
long = obj.GetActualMemorySize () - Return the memory in kilobytes consumed by this cell
type array. Used to support streaming and reading/writing data. The value returned is guaranteed to be
greater than or equal to the memory required to actually represent the data represented by this object. The
information returned is valid only after the pipeline has been updated.
obj.DeepCopy (vtkCellTypes src) - Standard DeepCopy method. Since this object contains no
reference to other objects, there is no ShallowCopy.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.33 vtkColorTransferFunction
32.33
781
vtkColorTransferFunction
32.33.1
Usage
vtkColorTransferFunction is a color mapping in RGB or HSV space that uses piecewise hermite functions to allow
interpolation that can be piecewise constant, piecewise linear, or somewhere in-between (a modified piecewise
hermite function that squishes the function according to a sharpness parameter). The function also allows for
the specification of the midpoint (the place where the function reaches the average of the two bounding nodes)
as a normalize distance between nodes. See the description of class vtkPiecewiseFunction for an explanation of
midpoint and sharpness.
To create an instance of class vtkColorTransferFunction, simply invoke its constructor as follows
obj = vtkColorTransferFunction
32.33.2
Methods
The class vtkColorTransferFunction has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkColorTransferFunction
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkColorTransferFunction = obj.NewInstance ()
vtkColorTransferFunction = obj.SafeDownCast (vtkObject o)
obj.DeepCopy (vtkColorTransferFunction f)
obj.ShallowCopy (vtkColorTransferFunction f)
int = obj.GetSize () - How many points are there defining this function?
int = obj.AddRGBPoint (double x, double r, double g, double b)
Add/Remove a point to/from the function defined in RGB or HSV Return the index of the point (0 based), or
-1 on error. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.
int = obj.AddRGBPoint (double x, double r, double g, double b, double
midpoint, double sharpness) - Add/Remove a point to/from the function defined in RGB or HSV
Return the index of the point (0 based), or -1 on error. See the description of class vtkPiecewiseFunction for
an explanation of midpoint and sharpness.
int = obj.AddHSVPoint (double x, double h, double s, double v)
Add/Remove a point to/from the function defined in RGB or HSV Return the index of the point (0 based), or
-1 on error. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.
int = obj.AddHSVPoint (double x, double h, double s, double v, double
midpoint, double sharpness) - Add/Remove a point to/from the function defined in RGB or HSV
Return the index of the point (0 based), or -1 on error. See the description of class vtkPiecewiseFunction for
an explanation of midpoint and sharpness.
int = obj.RemovePoint (double x) - Add/Remove a point to/from the function defined in RGB or
HSV Return the index of the point (0 based), or -1 on error. See the description of class vtkPiecewiseFunction
for an explanation of midpoint and sharpness.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
782
int = obj.AdjustRange (double range[2]) - Remove all points out of the new range, and
make sure there is a point at each end of that range. Return 1 on success, 0 otherwise.
obj.GetTable (double x1, double x2, int n, double table) - Fills in a table of n
function values between x1 and x2
obj.GetTable (double x1, double x2, int n, float table) - Fills in a table of n function values between x1 and x2
obj.BuildFunctionFromTable (double x1, double x2, int size, double table)
- Construct a color transfer function from a table. Function range is is set to [x1, x2], each function size is set
to size, and function points are regularly spaced between x1 and x2. Parameter "table" is assumed to be a
block of memory of size [3size]
obj.SetClamping (int ) - Sets and gets the clamping value for this transfer function.
int = obj.GetClampingMinValue () - Sets and gets the clamping value for this transfer function.
int = obj.GetClampingMaxValue () - Sets and gets the clamping value for this transfer function.
int = obj.GetClamping () - Sets and gets the clamping value for this transfer function.
obj.ClampingOn () - Sets and gets the clamping value for this transfer function.
obj.ClampingOff () - Sets and gets the clamping value for this transfer function.
obj.SetColorSpace (int ) - Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or
Diverging. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is
the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match
the current functionality of vtkLookupTable). Diverging is a special mode where colors will pass through white
when interpolating between two saturated colors.
int = obj.GetColorSpaceMinValue () - Set/Get the color space used for interpolation: RGB,
HSV, CIELAB, or Diverging. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back
through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0
(in order the match the current functionality of vtkLookupTable). Diverging is a special mode where colors will
pass through white when interpolating between two saturated colors.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.33 vtkColorTransferFunction
783
int = obj.GetColorSpaceMaxValue () - Set/Get the color space used for interpolation: RGB,
HSV, CIELAB, or Diverging. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back
through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0
(in order the match the current functionality of vtkLookupTable). Diverging is a special mode where colors will
pass through white when interpolating between two saturated colors.
obj.SetColorSpaceToRGB () - Set/Get the color space used for interpolation: RGB, HSV, CIELAB,
or Diverging. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if
that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order
the match the current functionality of vtkLookupTable). Diverging is a special mode where colors will pass
through white when interpolating between two saturated colors.
obj.SetColorSpaceToHSV () - Set/Get the color space used for interpolation: RGB, HSV, CIELAB,
or Diverging. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if
that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order
the match the current functionality of vtkLookupTable). Diverging is a special mode where colors will pass
through white when interpolating between two saturated colors.
obj.SetColorSpaceToLab () - Set/Get the color space used for interpolation: RGB, HSV, CIELAB,
or Diverging. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if
that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order
the match the current functionality of vtkLookupTable). Diverging is a special mode where colors will pass
through white when interpolating between two saturated colors.
obj.SetColorSpaceToDiverging () - Set/Get the color space used for interpolation: RGB, HSV,
CIELAB, or Diverging. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back
through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0
(in order the match the current functionality of vtkLookupTable). Diverging is a special mode where colors will
pass through white when interpolating between two saturated colors.
int = obj.GetColorSpace () - Set/Get the color space used for interpolation: RGB, HSV, CIELAB,
or Diverging. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if
that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order
the match the current functionality of vtkLookupTable). Diverging is a special mode where colors will pass
through white when interpolating between two saturated colors.
obj.SetHSVWrap (int ) - Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or
Diverging. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is
the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match
the current functionality of vtkLookupTable). Diverging is a special mode where colors will pass through white
when interpolating between two saturated colors.
int = obj.GetHSVWrap () - Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or
Diverging. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is
the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match
the current functionality of vtkLookupTable). Diverging is a special mode where colors will pass through white
when interpolating between two saturated colors.
obj.HSVWrapOn () - Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging.
In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is the
shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match
the current functionality of vtkLookupTable). Diverging is a special mode where colors will pass through white
when interpolating between two saturated colors.
obj.HSVWrapOff () - Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging.
In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is the
shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match
the current functionality of vtkLookupTable). Diverging is a special mode where colors will pass through white
when interpolating between two saturated colors.
obj.SetScale (int ) - Set the type of scale to use, linear or logarithmic. The default is linear. If the
scale is logarithmic, and the range contains zero, the color mapping will be linear.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
784
32.34
vtkCompositeDataIterator
32.34.1
Usage
32.34.2
Methods
The class vtkCompositeDataIterator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCompositeDataIterator
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCompositeDataIterator = obj.NewInstance ()
vtkCompositeDataIterator = obj.SafeDownCast (vtkObject o)
obj.SetDataSet (vtkCompositeDataSet ds) - Set the composite dataset this iterator is iterating over. Must be set before traversal begins.
vtkCompositeDataSet = obj.GetDataSet () - Set the composite dataset this iterator is iterating over. Must be set before traversal begins.
obj.InitTraversal () - Begin iterating over the composite dataset structure.
obj.InitReverseTraversal () - Begin iterating over the composite dataset structure in reverse
order.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.34 vtkCompositeDataIterator
785
786
32.35
vtkCompositeDataPipeline
32.35.1
Usage
vtkCompositeDataPipeline is an executive that supports the processing of composite dataset. It supports algorithms
that are aware of composite dataset as well as those that are not. Type checking is performed at run time. Algorithms
that are not composite dataset-aware have to support all dataset types contained in the composite dataset. The
pipeline execution can be summarized as follows:
REQUEST_INFORMATION: The producers have to provide information about the contents of the composite dataset
in this pass. Sources that can produce more than one piece (note that a piece is different than a block; each piece
consistes of 0 or more blocks) should set MAXIMUM_NUMBER_OF_PIECES to -1.
REQUEST_UPDATE_EXTENT: This pass is identical to the one implemented in vtkStreamingDemandDrivenPipeline
REQUEST_DATA: This is where the algorithms execute. If the vtkCompositeDataPipeline is assigned to a simple
filter, it will invoke the vtkStreamingDemandDrivenPipeline passes in a loop, passing a different block each time and
will collect the results in a composite dataset. .SECTION See also vtkCompositeDataSet
To create an instance of class vtkCompositeDataPipeline, simply invoke its constructor as follows
obj = vtkCompositeDataPipeline
32.35.2
Methods
The class vtkCompositeDataPipeline has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCompositeDataPipeline
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCompositeDataPipeline = obj.NewInstance ()
vtkCompositeDataPipeline = obj.SafeDownCast (vtkObject o)
vtkDataObject = obj.GetCompositeOutputData (int port) - Returns the data object
stored with the DATA_OBJECT() in the output port
32.36
vtkCompositeDataSet
32.36 vtkCompositeDataSet
32.36.1
787
Usage
vtkCompositeDataSet is an abstract class that represents a collection of datasets (including other composite
datasets). It provides an interface to access the datasets through iterators. vtkCompositeDataSet provides methods
that are used by subclasses to store the datasets. vtkCompositeDataSet provides the datastructure for a full tree
representation. Subclasses provide the semantics for it and control how this tree is built.
To create an instance of class vtkCompositeDataSet, simply invoke its constructor as follows
obj = vtkCompositeDataSet
32.36.2
Methods
The class vtkCompositeDataSet has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCompositeDataSet class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCompositeDataSet = obj.NewInstance ()
vtkCompositeDataSet = obj.SafeDownCast (vtkObject o)
vtkCompositeDataIterator = obj.NewIterator () - Return a new iterator (the iterator has
to be deleted by user).
int = obj.GetDataObjectType () - Get the port currently producing this object.
vtkAlgorithmOutput = obj.GetProducerPort () - Get the port currently producing this object.
obj.CopyStructure (vtkCompositeDataSet input) - Copies the tree structure from the input. All pointers to non-composite data objects are intialized to NULL. This also shallow copies the meta data
associated with all the nodes.
obj.SetDataSet (vtkCompositeDataIterator iter, vtkDataObject dataObj) Sets the data set at the location pointed by the iterator. The iterator does not need to be iterating over this
dataset itself. It can be any composite datasite with similar structure (achieved by using CopyStructure).
vtkDataObject = obj.GetDataSet (vtkCompositeDataIterator iter) - Returns the
dataset located at the positiong pointed by the iterator. The iterator does not need to be iterating over this
dataset itself. It can be an iterator for composite dataset with similar structure (achieved by using CopyStructure).
vtkInformation = obj.GetMetaData (vtkCompositeDataIterator iter) - Returns
the meta-data associated with the position pointed by the iterator. This will create a new vtkInformation object
if none already exists. Use HasMetaData to avoid creating the vtkInformation object unnecessarily. The
iterator does not need to be iterating over this dataset itself. It can be an iterator for composite dataset with
similar structure (achieved by using CopyStructure).
int = obj.HasMetaData (vtkCompositeDataIterator iter) - Returns if any meta-data
associated with the position pointed by the iterator. The iterator does not need to be iterating over this dataset
itself. It can be an iterator for composite dataset with similar structure (achieved by using CopyStructure).
obj.Initialize () - Restore data object to initial state,
obj.ShallowCopy (vtkDataObject src) - Shallow and Deep copy.
obj.DeepCopy (vtkDataObject src) - Shallow and Deep copy.
vtkIdType = obj.GetNumberOfPoints () - Returns the total number of points of all blocks. This
will iterate over all blocks and call GetNumberOfPoints() so it might be expansive.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
788
32.37
vtkCompositeDataSetAlgorithm
32.37.1
Usage
Algorithms that take any type of data object (including composite dataset) and produce a vtkCompositeDataSet in
the output can subclass from this class.
To create an instance of class vtkCompositeDataSetAlgorithm, simply invoke its constructor as follows
obj = vtkCompositeDataSetAlgorithm
32.37.2
Methods
The class vtkCompositeDataSetAlgorithm has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCompositeDataSetAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCompositeDataSetAlgorithm = obj.NewInstance ()
vtkCompositeDataSetAlgorithm = obj.SafeDownCast (vtkObject o)
vtkCompositeDataSet = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkCompositeDataSet = obj.GetOutput (int ) - Get the output data object for a port on this
algorithm.
obj.SetInput (vtkDataObject ) - Set an input of this algorithm. You should not override these
methods because they are not the only way to connect a pipeline. Note that these methods support oldstyle pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection
within a single port.
obj.SetInput (int , vtkDataObject ) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
32.38
vtkCone
32.38.1
Usage
vtkCone computes the implicit function and function gradient for a cone. vtkCone is a concrete implementation
of vtkImplicitFunction. The cone vertex is located at the origin with axis of rotation coincident with x-axis. (Use
the superclass vtkImplicitFunction transformation matrix if necessary to reposition.) The angle specifies the angle
between the axis of rotation and the side of the cone.
To create an instance of class vtkCone, simply invoke its constructor as follows
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.39 vtkConvexPointSet
789
obj = vtkCone
32.38.2
Methods
The class vtkCone has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCone class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCone = obj.NewInstance ()
vtkCone = obj.SafeDownCast (vtkObject o)
double = obj.EvaluateFunction (double x[3])
double = obj.EvaluateFunction (double x, double y, double z)
obj.EvaluateGradient (double x[3], double g[3])
obj.SetAngle (double ) - Set/Get the cone angle (expressed in degrees).
double = obj.GetAngleMinValue () - Set/Get the cone angle (expressed in degrees).
double = obj.GetAngleMaxValue () - Set/Get the cone angle (expressed in degrees).
double = obj.GetAngle () - Set/Get the cone angle (expressed in degrees).
32.39
vtkConvexPointSet
32.39.1
Usage
vtkConvexPointSet is a concrete implementation that represents a 3D cell defined by a convex set of points. An
example of such a cell is an octant (from an octree). vtkConvexPointSet uses the ordered triangulations approach
(vtkOrderedTriangulator) to create triangulations guaranteed to be compatible across shared faces. This allows a
general approach to processing complex, convex cell types.
To create an instance of class vtkConvexPointSet, simply invoke its constructor as follows
obj = vtkConvexPointSet
32.39.2
Methods
The class vtkConvexPointSet has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkConvexPointSet class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkConvexPointSet = obj.NewInstance ()
vtkConvexPointSet = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
790
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - Satisfy the vtkCell API. This method contours by
triangulating the cell and then contouring the resulting tetrahedra.
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
Locator locator, vtkCellArray connectivity, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData outCd,
int insideOut) - Satisfy the vtkCell API. This method contours by triangulating the cell and then adding
clip-edge intersection points into the triangulation; extracting the clipped region.
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts) - Triangulate using methods of vtkOrderedTriangulator.
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs) - Computes derivatives by triangulating and from subId and pcoords, evaluating
derivatives on the resulting tetrahedron.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts) - Returns the set of points forming a face of the triangulation of these points that are on the boundary of the cell
that are closest parametrically to the point specified.
int = obj.GetParametricCenter (double pcoords[3]) - Return the center of the cell in
parametric coordinates.
int = obj.IsPrimaryCell () - Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.40 vtkCoordinate
791
obj.InterpolateFunctions (double pcoords[3], double sf) - Compute the interpolation functions/derivatives (aka shape functions/derivatives)
obj.InterpolateDerivs (double pcoords[3], double derivs) - Compute the interpolation functions/derivatives (aka shape functions/derivatives)
32.40
vtkCoordinate
32.40.1
Usage
vtkCoordinate represents position in a variety of coordinate systems, and converts position to other coordinate
systems. It also supports relative positioning, so you can create a cascade of vtkCoordinate objects (no loops
please!) that refer to each other. The typical usage of this object is to set the coordinate system in which to represent
a position (e.g., SetCoordinateSystemToNormalizedDisplay()), set the value of the coordinate (e.g., SetValue()), and
then invoke the appropriate method to convert to another coordinate system (e.g., GetComputedWorldValue()).
The coordinate systems in vtk are as follows:
If you cascade vtkCoordinate objects, you refer to another vtkCoordinate object which in turn can refer to others,
and so on. This allows you to create composite groups of things like vtkActor2D that are positioned relative to
one another. Note that in cascaded sequences, each vtkCoordinate object may be specified in different coordinate
systems!
To create an instance of class vtkCoordinate, simply invoke its constructor as follows
obj = vtkCoordinate
32.40.2
Methods
The class vtkCoordinate has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCoordinate class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCoordinate = obj.NewInstance ()
vtkCoordinate = obj.SafeDownCast (vtkObject o)
obj.SetCoordinateSystem (int ) - Set/get the coordinate system which this coordinate is defined
in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.
int = obj.GetCoordinateSystem () - Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.
obj.SetCoordinateSystemToDisplay () - Set/get the coordinate system which this coordinate is
defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
792
32.41
vtkCubicLine
32.41 vtkCubicLine
32.41.1
793
Usage
vtkCubicLine is a concrete implementation of vtkNonLinearCell to represent a 1D Cubic line. The Cubic Line is the
4 nodes isoparametric parabolic line . The interpolation is the standard finite element, cubic isoparametric shape
function. The cell includes two mid-edge nodes. The ordering of the four points defining the cell is point ids (0,1,2,3)
where id #2 and #3 are the mid-edge nodes. Please note that the parametric coordinates lie between -1 and 1 in
accordance with most standard documentations. .SECTION Thanks <verbatim> This file has been developed by
Oxalya - www.oxalya.com Copyright (c) EDF - www.edf.fr </verbatim>
To create an instance of class vtkCubicLine, simply invoke its constructor as follows
obj = vtkCubicLine
32.41.2
Methods
The class vtkCubicLine has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCubicLine class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCubicLine = obj.NewInstance ()
vtkCubicLine = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int ) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int ) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts) - See the
vtkCell API for descriptions of these methods.
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs) - See the vtkCell API for descriptions of these methods.
double = obj.GetParametricDistance (double pcoords[3]) - Return the distance of
the parametric coordinate provided to the cell. If inside the cell, a distance of zero is returned.
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
794
32.42
vtkCylinder
32.42.1
Usage
vtkCylinder computes the implicit function and function gradient for a cylinder. vtkCylinder is a concrete implementation of vtkImplicitFunction. Cylinder is centered at Center and axes of rotation is along the y-axis. (Use the
superclass vtkImplicitFunction transformation matrix if necessary to reposition.)
To create an instance of class vtkCylinder, simply invoke its constructor as follows
obj = vtkCylinder
32.42.2
Methods
The class vtkCylinder has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCylinder class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCylinder = obj.NewInstance ()
vtkCylinder = obj.SafeDownCast (vtkObject o)
double = obj.EvaluateFunction (double x[3])
double = obj.EvaluateFunction (double x, double y, double z)
obj.EvaluateGradient (double x[3], double g[3])
obj.SetRadius (double ) - Set/Get cylinder radius.
double = obj.GetRadius () - Set/Get cylinder radius.
obj.SetCenter (double , double , double ) - Set/Get cylinder center
obj.SetCenter (double a[3]) - Set/Get cylinder center
double = obj.
32.43
vtkDataObject
32.43 vtkDataObject
32.43.1
795
Usage
vtkDataObject is an general representation of visualization data. It serves to encapsulate instance variables and
methods for visualization network execution, as well as representing data consisting of a field (i.e., just an unstructured pile of data). This is to be compared with a vtkDataSet, which is data with geometric and/or topological
structure.
vtkDataObjects are used to represent arbitrary repositories of data via the vtkFieldData instance variable. These
data must be eventually mapped into a concrete subclass of vtkDataSet before they can actually be displayed.
To create an instance of class vtkDataObject, simply invoke its constructor as follows
obj = vtkDataObject
32.43.2
Methods
The class vtkDataObject has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkDataObject class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataObject = obj.NewInstance ()
vtkDataObject = obj.SafeDownCast (vtkObject o)
vtkSource = obj.GetSource () - Set/Get the source object creating this data object.
obj.SetSource (vtkSource s) - Set/Get the source object creating this data object.
vtkInformation = obj.GetInformation () - Set/Get the information object associated with
this data object.
obj.SetInformation (vtkInformation ) - Set/Get the information object associated with this
data object.
vtkInformation = obj.GetPipelineInformation () - Get/Set the pipeline information object that owns this data object.
obj.SetPipelineInformation (vtkInformation ) - Get/Set the pipeline information object
that owns this data object.
vtkAlgorithmOutput = obj.GetProducerPort () - Get the port currently producing this object.
long = obj.GetMTime () - Data objects are composite objects and need to check each part for MTime. The information object also needs to be considered.
obj.Initialize () - Restore data object to initial state,
obj.ReleaseData () - Release data back to system to conserve memory resource. Used during visualization network execution. Releasing this data does not make down-stream data invalid, so it does not
modify the MTime of this data object.
int = obj.ShouldIReleaseData () - Return flag indicating whether data should be released after
use by a filter.
int = obj.GetDataReleased () - Get the flag indicating the data has been released.
obj.SetReleaseDataFlag (int ) - Turn on/off flag to control whether this objects data is released
after being used by a filter.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
796
32.43 vtkDataObject
797
obj.SetUpdateExtent (int x0, int x1, int y0, int y1, int z0, int z1) - Set
the update extent for data objects that use 3D extents. Using this method on data objects that set extents as
pieces (such as vtkPolyData or vtkUnstructuredGrid) has no real effect. Dont use the set macro to set the
update extent since we dont want this object to be modified just due to a change in update extent. When the
volume of the extent is zero (0, -1,..), then no data is requested, and the source will not execute.
obj.SetUpdateExtent (int extent[6]) - Set the update extent for data objects that use 3D
extents. Using this method on data objects that set extents as pieces (such as vtkPolyData or vtkUnstructuredGrid) has no real effect. Dont use the set macro to set the update extent since we dont want this object to
be modified just due to a change in update extent. When the volume of the extent is zero (0, -1,..), then no
data is requested, and the source will not execute.
int = obj.GetUpdateExtent () - Set the update extent for data objects that use 3D extents. Using
this method on data objects that set extents as pieces (such as vtkPolyData or vtkUnstructuredGrid) has no
real effect. Dont use the set macro to set the update extent since we dont want this object to be modified just
due to a change in update extent. When the volume of the extent is zero (0, -1,..), then no data is requested,
and the source will not execute.
obj.GetUpdateExtent (int extent[6]) - Set the update extent for data objects that use 3D
extents. Using this method on data objects that set extents as pieces (such as vtkPolyData or vtkUnstructuredGrid) has no real effect. Dont use the set macro to set the update extent since we dont want this object to
be modified just due to a change in update extent. When the volume of the extent is zero (0, -1,..), then no
data is requested, and the source will not execute.
int = obj.GetDataObjectType () - Used by Threaded ports to determine if they should initiate an
asynchronous update (still in development).
long = obj.GetUpdateTime () - Used by Threaded ports to determine if they should initiate an
asynchronous update (still in development).
obj.SetUpdateExtentToWholeExtent () - If the whole input extent is required to generate the
requested output extent, this method can be called to set the input update extent to the whole input extent.
This method assumes that the whole extent is known (that UpdateInformation has been called)
long = obj.GetPipelineMTime () - Get the cumulative modified time of everything upstream.
Does not include the MTime of this object.
long = obj.GetActualMemorySize () - Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than
or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the
return value).
obj.CopyInformation (vtkDataObject data) - Copy the generic information (WholeExtent ...)
obj.CopyTypeSpecificInformation (vtkDataObject data) - By default, there is no type
specific information
obj.SetUpdatePiece (int piece) - Set / Get the update piece and the update number of pieces.
Similar to update extent in 3D.
obj.SetUpdateNumberOfPieces (int num) - Set / Get the update piece and the update number
of pieces. Similar to update extent in 3D.
int = obj.GetUpdatePiece () - Set / Get the update piece and the update number of pieces.
Similar to update extent in 3D.
int = obj.GetUpdateNumberOfPieces () - Set / Get the update piece and the update number
of pieces. Similar to update extent in 3D.
obj.SetUpdateGhostLevel (int level) - Set / Get the update ghost level and the update number of ghost levels. Similar to update extent in 3D.
int = obj.GetUpdateGhostLevel () - Set / Get the update ghost level and the update number of
ghost levels. Similar to update extent in 3D.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
798
32.44 vtkDataObjectAlgorithm
799
32.44
vtkDataObjectAlgorithm
800
32.44.1
Usage
32.44.2
Methods
The class vtkDataObjectAlgorithm has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataObjectAlgorithm
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataObjectAlgorithm = obj.NewInstance ()
vtkDataObjectAlgorithm = obj.SafeDownCast (vtkObject o)
vtkDataObject = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkDataObject = obj.GetOutput (int ) - Get the output data object for a port on this algorithm.
obj.SetOutput (vtkDataObject d) - Get the output data object for a port on this algorithm.
vtkDataObject = obj.GetInput ()
vtkDataObject = obj.GetInput (int port)
obj.SetInput (vtkDataObject ) - Set an input of this algorithm. You should not override these
methods because they are not the only way to connect a pipeline. Note that these methods support oldstyle pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection
within a single port.
obj.SetInput (int , vtkDataObject ) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
obj.AddInput (vtkDataObject ) - Add an input of this algorithm. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
obj.AddInput (int , vtkDataObject ) - Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
32.45
vtkDataObjectCollection
32.45.1
Usage
vtkDataObjectCollection is an object that creates and manipulates lists of data objects. See also vtkCollection and
subclasses.
To create an instance of class vtkDataObjectCollection, simply invoke its constructor as follows
obj = vtkDataObjectCollection
32.46 vtkDataObjectSource
32.45.2
801
Methods
The class vtkDataObjectCollection has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataObjectCollection
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataObjectCollection = obj.NewInstance ()
vtkDataObjectCollection = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkDataObject ds) - Get the next data object in the list.
vtkDataObject = obj.GetNextItem () - Get the ith data object in the list.
vtkDataObject = obj.GetItem (int i)
32.46
vtkDataObjectSource
32.46.1
Usage
vtkDataObjectSource is an abstract object that specifies behavior and interface of field source objects. Field source
objects are source objects that create vtkFieldData (field data) on output.
Concrete subclasses of vtkDataObjectSource must define Update() and Execute() methods. The public method
Update() invokes network execution and will bring the network up-to-date. The protected Execute() method actually
does the work of data creation/generation. The difference between the two methods is that Update() implements
input consistency checks and modified time comparisons and then invokes the Execute() which is an implementation
of a particular algorithm.
vtkDataObjectSource provides a mechanism for invoking the methods StartMethod() and EndMethod() before and
after object execution (via Execute()). These are convenience methods you can use for any purpose (e.g., debugging info, highlighting/notifying user interface, etc.) These methods accept a single void pointer that can be used to
send data to the methods. It is also possible to specify a function to delete the argument via StartMethodArgDelete
and EndMethodArgDelete.
Another method, ProgressMethod() can be specified. Some filters invoke this method periodically during their
execution. The use is similar to that of StartMethod() and EndMethod().
An important feature of subclasses of vtkDataObjectSource is that it is possible to control the memory-management
model (i.e., retain output versus delete output data). If enabled the ReleaseDataFlag enables the deletion of the
output data once the downstream process object finishes processing the data (please see text).
To create an instance of class vtkDataObjectSource, simply invoke its constructor as follows
obj = vtkDataObjectSource
32.46.2
Methods
The class vtkDataObjectSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataObjectSource class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
802
32.47
vtkDataObjectTypes
32.47.1
Usage
vtkDataObjectTypes is a helper class that supports conversion between integer types defined in vtkType.h and string
names as well as creation of data objects from either integer or string types. This class has to be updated every
time a new data type is added to VTK.
To create an instance of class vtkDataObjectTypes, simply invoke its constructor as follows
obj = vtkDataObjectTypes
32.47.2
Methods
The class vtkDataObjectTypes has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkDataObjectTypes class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataObjectTypes = obj.NewInstance ()
vtkDataObjectTypes = obj.SafeDownCast (vtkObject o)
32.48
vtkDataSet
32.48.1
Usage
vtkDataSet is an abstract class that specifies an interface for dataset objects. vtkDataSet also provides methods to
provide informations about the data, such as center, bounding box, and representative length.
In vtk a dataset consists of a structure (geometry and topology) and attribute data. The structure is defined implicitly
or explicitly as a collection of cells. The geometry of the structure is contained in point coordinates plus the cell
interpolation functions. The topology of the dataset structure is defined by cell types and how the cells share their
defining points.
Attribute data in vtk is either point data (data at points) or cell data (data at cells). Typically filters operate on point
data, but some may operate on cell data, both cell and point data, either one, or none.
To create an instance of class vtkDataSet, simply invoke its constructor as follows
obj = vtkDataSet
32.48 vtkDataSet
32.48.2
803
Methods
The class vtkDataSet has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkDataSet class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSet = obj.NewInstance ()
vtkDataSet = obj.SafeDownCast (vtkObject o)
obj.CopyStructure (vtkDataSet ds) - Copy the geometric and topological structure of an object.
Note that the invoking object and the object pointed to by the parameter ds must be of the same type. THIS
METHOD IS NOT THREAD SAFE.
obj.CopyAttributes (vtkDataSet ds) - Copy the attributes associated with the specified
dataset to this instance of vtkDataSet. THIS METHOD IS NOT THREAD SAFE.
vtkIdType = obj.GetNumberOfPoints () - Determine the number of points composing the
dataset. THIS METHOD IS THREAD SAFE
vtkIdType = obj.GetNumberOfCells () - Determine the number of cells composing the dataset.
THIS METHOD IS THREAD SAFE
double = obj.GetPoint (vtkIdType ptId) - Get point coordinates with ptId such that: 0 <=
ptId < NumberOfPoints. THIS METHOD IS NOT THREAD SAFE.
obj.GetPoint (vtkIdType id, double x[3]) - Copy point coordinates into user provided array x[3] for specified point id. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE
THREAD AND THE DATASET IS NOT MODIFIED
vtkCell = obj.GetCell (vtkIdType cellId) - Get cell with cellId such that: 0 <= cellId <
NumberOfCells. THIS METHOD IS NOT THREAD SAFE.
obj.GetCell (vtkIdType cellId, vtkGenericCell cell) - Get cell with cellId such that: 0 <= cellId < NumberOfCells. This is a thread-safe alternative to the previous GetCell() method. THIS
METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT
MODIFIED
obj.GetCellBounds (vtkIdType cellId, double bounds[6]) - Get the bounds of the
cell with cellId such that: 0 <= cellId < NumberOfCells. A subclass may be able to determine the bounds
of cell without using an expensive GetCell() method. A default implementation is provided that actually uses
a GetCell() call. This is to ensure the method is available to all datasets. Subclasses should override this
method to provide an efficient implementation. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM
A SINGLE THREAD AND THE DATASET IS NOT MODIFIED
int = obj.GetCellType (vtkIdType cellId) - Get type of cell with cellId such that: 0 <=
cellId < NumberOfCells. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD
AND THE DATASET IS NOT MODIFIED
obj.GetCellTypes (vtkCellTypes types) - Get a list of types of cells in a dataset. The list
consists of an array of types (not necessarily in any order), with a single entry per type. For example a
dataset 5 triangles, 3 lines, and 100 hexahedra would result a list of three entries, corresponding to the
types VTK_TRIANGLE, VTK_LINE, and VTK_HEXAHEDRON. THIS METHOD IS THREAD SAFE IF FIRST
CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED
obj.GetCellPoints (vtkIdType cellId, vtkIdList ptIds) - Topological inquiry to get
points defining cell. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND
THE DATASET IS NOT MODIFIED
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
804
32.49 vtkDataSetAlgorithm
805
long = obj.GetActualMemorySize () - Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than
or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the
return value). THIS METHOD IS THREAD SAFE.
int = obj.GetDataObjectType () - Shallow and Deep copy.
obj.ShallowCopy (vtkDataObject src) - Shallow and Deep copy.
obj.DeepCopy (vtkDataObject src) - Shallow and Deep copy.
int = obj.CheckAttributes () - This method checks to see if the cell and point attributes match
the geometry. Many filters will crash if the number of tupples in an array is less than the number of points/cells.
This method returns 1 if there is a mismatch, and 0 if everything is ok. It prints an error if an array is too short,
and a warning if an array is too long.
obj.GenerateGhostLevelArray () - Normally called by pipeline executives or algoritgms only. This
method computes the ghost arrays for a given dataset.
vtkFieldData = obj.GetAttributesAsFieldData (int type) - Returns the attributes of
the data object as a vtkFieldData. This returns non-null values in all the same cases as GetAttributes, in
addition to the case of FIELD, which will return the field data for any vtkDataObject subclass.
vtkIdType = obj.GetNumberOfElements (int type) - Get the number of elements for a
specific attribute type (POINT, CELL, etc.).
32.49
vtkDataSetAlgorithm
32.49.1
Usage
vtkDataSetAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition
old algorithms to the new pipeline architecture. Ther are some assumptions and defaults made by this class you
should be aware of. This class defaults such that your filter will have one input port and one output port. If that
is not the case simply change it with SetNumberOfInputPorts etc. See this classes contstructor for the default.
This class also provides a FillInputPortInfo method that by default says that all inputs will be DataSet. If that isnt
the case then please override this method in your subclass. This class breaks out the downstream requests into
seperate functions such as RequestDataObject RequestData and RequestInformation. The default implementation
of RequestDataObject will create an output data of the same type as the input.
To create an instance of class vtkDataSetAlgorithm, simply invoke its constructor as follows
obj = vtkDataSetAlgorithm
32.49.2
Methods
The class vtkDataSetAlgorithm has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetAlgorithm = obj.NewInstance ()
vtkDataSetAlgorithm = obj.SafeDownCast (vtkObject o)
vtkDataSet = obj.GetOutput () - Get the output data object for a port on this algorithm.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
806
32.50 vtkDataSetAttributes
32.50
807
vtkDataSetAttributes
32.50.1
Usage
vtkDataSetAttributes is a class that is used to represent and manipulate attribute data (e.g., scalars, vectors, normals, texture coordinates, tensors, global ids, pedigree ids, and field data).
This adds to vtkFieldData the ability to pick one of the arrays from the field as the currently active array for each
attribute type. In other words, you pick one array to be called "THE" Scalars, and then filters down the pipeline will
treat that array specially. For example vtkContourFilter will contour "THE" Scalar array unless a different array is
asked for.
Additionally vtkDataSetAttributes provides methods that filters call to pass data through, copy data into, and interpolate from Fields. PassData passes entire arrays from the source to the destination. Copy passes through some
subset of the tuples from the source to the destination. Interpolate interpolates from the chosen tuple(s) in the
source data, using the provided weights, to produce new tuples in the destination. Each attribute type has pass,
copy and interpolate "copy" flags that can be set in the destination to choose which attribute arrays will be transfered
from the source to the destination.
Finally this class provides a mechanism to determine which attributes a group of sources have in common, and to
copy tuples from a source into the destination, for only those attributes that are held by all.
To create an instance of class vtkDataSetAttributes, simply invoke its constructor as follows
obj = vtkDataSetAttributes
32.50.2
Methods
The class vtkDataSetAttributes has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetAttributes class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetAttributes = obj.NewInstance ()
vtkDataSetAttributes = obj.SafeDownCast (vtkObject o)
obj.Initialize () - Initialize all of the objects data to NULL Also, clear the copy flags.
obj.Update () - Deep copy of data (i.e., create new data arrays and copy from input data). Ignores the
copy flags but preserves them in the output.
obj.DeepCopy (vtkFieldData pd) - Deep copy of data (i.e., create new data arrays and copy from
input data). Ignores the copy flags but preserves them in the output.
obj.ShallowCopy (vtkFieldData pd) - Shallow copy of data (i.e., use reference counting). Ignores the copy flags but preserves them in the output.
int = obj.SetScalars (vtkDataArray da) - Set/Get the scalar data.
int = obj.SetActiveScalars (string name) - Set/Get the scalar data.
vtkDataArray = obj.GetScalars () - Set/Get the scalar data.
int = obj.SetVectors (vtkDataArray da) - Set/Get the vector data.
int = obj.SetActiveVectors (string name) - Set/Get the vector data.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
808
32.50 vtkDataSetAttributes
809
810
32.50 vtkDataSetAttributes
811
1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and
3.
2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3.
3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
int = obj.GetCopyNormals (int ctypeALLCOPY) - Turn on/off the copying of normals data.
ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set,
ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if
all three flags are true.
During copying, interpolation and passdata, the following rules are followed for each array:
1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and
3.
2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3.
3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
obj.CopyNormalsOn () - Turn on/off the copying of normals data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all
three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true.
During copying, interpolation and passdata, the following rules are followed for each array:
1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and
3.
2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3.
3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
obj.CopyNormalsOff () - Turn on/off the copying of normals data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all
three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true.
During copying, interpolation and passdata, the following rules are followed for each array:
1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and
3.
2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3.
3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
obj.SetCopyTCoords (int i, int ctypeALLCOPY) - Turn on/off the copying of texture coordinates data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns
true only if all three flags are true.
During copying, interpolation and passdata, the following rules are followed for each array:
1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and
3.
2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3.
3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
int = obj.GetCopyTCoords (int ctypeALLCOPY) - Turn on/off the copying of texture coordinates data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns
true only if all three flags are true.
During copying, interpolation and passdata, the following rules are followed for each array:
1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and
3.
2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3.
3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
812
32.50 vtkDataSetAttributes
813
1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and
3.
2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3.
3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
obj.SetCopyGlobalIds (int i, int ctypeALLCOPY) - Turn on/off the copying of global id
data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For
set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only
if all three flags are true.
During copying, interpolation and passdata, the following rules are followed for each array:
1. If the copy/interpolate/pass for an attribute is set (on or off), it is applied. This overrides rules 2 and 3.
2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3.
3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
int = obj.GetCopyGlobalIds (int ctypeALLCOPY) - Turn on/off the copying of global id
data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior.
For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true
only if all three flags are true.
During copying, interpolation and passdata, the following rules are followed for each array:
1. If the copy/interpolate/pass for an attribute is set (on or off), it is applied. This overrides rules 2 and 3.
2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3.
3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
obj.CopyGlobalIdsOn () - Turn on/off the copying of global id data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set
all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true.
During copying, interpolation and passdata, the following rules are followed for each array:
1. If the copy/interpolate/pass for an attribute is set (on or off), it is applied. This overrides rules 2 and 3.
2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3.
3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
obj.CopyGlobalIdsOff () - Turn on/off the copying of global id data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set
all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true.
During copying, interpolation and passdata, the following rules are followed for each array:
1. If the copy/interpolate/pass for an attribute is set (on or off), it is applied. This overrides rules 2 and 3.
2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3.
3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
obj.SetCopyPedigreeIds (int i, int ctypeALLCOPY) - Turn on/off the copying of pedigree
id data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior.
For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true
only if all three flags are true.
During copying, interpolation and passdata, the following rules are followed for each array:
1. If the copy/interpolate/pass for an attribute is set (on or off), it is applied. This overrides rules 2 and 3.
2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3.
3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
int = obj.GetCopyPedigreeIds (int ctypeALLCOPY) - Turn on/off the copying of pedigree
id data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior.
For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true
only if all three flags are true.
During copying, interpolation and passdata, the following rules are followed for each array:
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
814
32.51 vtkDataSetCollection
815
32.51
vtkDataSetCollection
816
32.51.1
Usage
vtkDataSetCollection is an object that creates and manipulates lists of datasets. See also vtkCollection and subclasses.
To create an instance of class vtkDataSetCollection, simply invoke its constructor as follows
obj = vtkDataSetCollection
32.51.2
Methods
The class vtkDataSetCollection has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetCollection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetCollection = obj.NewInstance ()
vtkDataSetCollection = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkDataSet ds) - Get the next dataset in the list.
vtkDataSet = obj.GetNextItem () - Get the next dataset in the list.
vtkDataSet = obj.GetNextDataSet () - Get the next dataset in the list.
vtkDataSet = obj.GetItem (int i) - Get the ith dataset in the list.
vtkDataSet = obj.GetDataSet (int i) - Get the ith dataset in the list.
32.52
vtkDataSetSource
32.52.1
Usage
32.52.2
Methods
The class vtkDataSetSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetSource = obj.NewInstance ()
vtkDataSetSource = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.53 vtkDataSetToDataSetFilter
817
32.53
vtkDataSetToDataSetFilter
32.53.1
Usage
32.53.2
Methods
The class vtkDataSetToDataSetFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetToDataSetFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetToDataSetFilter = obj.NewInstance ()
vtkDataSetToDataSetFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkDataSet input) - Specify the input data or filter.
vtkDataSet = obj.GetOutput () - Get the output of this filter. If output is NULL then input hasnt
been set which is necessary for abstract objects.
vtkDataSet = obj.GetOutput (int idx) - Get the output of this filter. If output is NULL then
input hasnt been set which is necessary for abstract objects.
vtkPolyData = obj.GetPolyDataOutput () - Get the output as vtkPolyData.
vtkStructuredPoints = obj.GetStructuredPointsOutput () - Get the output as vtkStructuredPoints.
vtkStructuredGrid = obj.GetStructuredGridOutput () - Get the output as vtkStructuredGrid.
vtkUnstructuredGrid = obj.GetUnstructuredGridOutput () - Get the output as vtkUnstructuredGrid.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
818
32.54
vtkDataSetToImageFilter
32.54.1
Usage
vtkDataSetToImageFilter is an abstract filter class whose subclasses take as input any dataset and generate image
data on output.
To create an instance of class vtkDataSetToImageFilter, simply invoke its constructor as follows
obj = vtkDataSetToImageFilter
32.54.2
Methods
The class vtkDataSetToImageFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetToImageFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetToImageFilter = obj.NewInstance ()
vtkDataSetToImageFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkDataSet input) - Set / get the input data or filter.
vtkDataSet = obj.GetInput () - Set / get the input data or filter.
32.55
vtkDataSetToPolyDataFilter
32.55.1
Usage
vtkDataSetToPolyDataFilter is an abstract filter class whose subclasses take as input any dataset and generate
polygonal data on output.
To create an instance of class vtkDataSetToPolyDataFilter, simply invoke its constructor as follows
obj = vtkDataSetToPolyDataFilter
32.56 vtkDataSetToStructuredGridFilter
32.55.2
819
Methods
The class vtkDataSetToPolyDataFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetToPolyDataFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetToPolyDataFilter = obj.NewInstance ()
vtkDataSetToPolyDataFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkDataSet input) - Set / get the input data or filter.
vtkDataSet = obj.GetInput () - Set / get the input data or filter.
obj.ComputeInputUpdateExtents (vtkDataObject output) - Do not let images return
more than requested.
32.56
vtkDataSetToStructuredGridFilter
32.56.1
Usage
vtkDataSetToStructuredGridFilter is an abstract filter class whose subclasses take as input any dataset and generate a structured grid on output.
To create an instance of class vtkDataSetToStructuredGridFilter, simply invoke its constructor as follows
obj = vtkDataSetToStructuredGridFilter
32.56.2
Methods
The class vtkDataSetToStructuredGridFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetToStructuredGridFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetToStructuredGridFilter = obj.NewInstance ()
vtkDataSetToStructuredGridFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkDataSet input) - Set / get the input data or filter.
vtkDataSet = obj.GetInput () - Set / get the input data or filter.
32.57
vtkDataSetToStructuredPointsFilter
820
32.57.1
Usage
vtkDataSetToStructuredPointsFilter is an abstract filter class whose subclasses take as input any dataset and generate structured points data on output.
To create an instance of class vtkDataSetToStructuredPointsFilter, simply invoke its constructor as follows
obj = vtkDataSetToStructuredPointsFilter
32.57.2
Methods
The class vtkDataSetToStructuredPointsFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetToStructuredPointsFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetToStructuredPointsFilter = obj.NewInstance ()
vtkDataSetToStructuredPointsFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkDataSet input) - Set / get the input data or filter.
vtkDataSet = obj.GetInput () - Set / get the input data or filter.
32.58
vtkDataSetToUnstructuredGridFilter
32.58.1
Usage
vtkDataSetToUnstructuredGridFilter is an abstract filter class whose subclasses take as input any dataset and
generate an unstructured grid on output.
To create an instance of class vtkDataSetToUnstructuredGridFilter, simply invoke its constructor as follows
obj = vtkDataSetToUnstructuredGridFilter
32.58.2
Methods
The class vtkDataSetToUnstructuredGridFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetToUnstructuredGridFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetToUnstructuredGridFilter = obj.NewInstance ()
vtkDataSetToUnstructuredGridFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkDataSet input) - Set / get the input data or filter.
vtkDataSet = obj.GetInput () - Set / get the input data or filter.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.59 vtkDemandDrivenPipeline
32.59
821
vtkDemandDrivenPipeline
32.59.1
Usage
vtkDemandDrivenPipeline is an executive that will execute an algorithm only when its outputs are out-of-date with
respect to its inputs.
To create an instance of class vtkDemandDrivenPipeline, simply invoke its constructor as follows
obj = vtkDemandDrivenPipeline
32.59.2
Methods
The class vtkDemandDrivenPipeline has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDemandDrivenPipeline
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDemandDrivenPipeline = obj.NewInstance ()
vtkDemandDrivenPipeline = obj.SafeDownCast (vtkObject o)
int = obj.Update () - Bring the algorithms outputs up-to-date. Returns 1 for success and 0 for
failure.
int = obj.Update (int port) - Bring the algorithms outputs up-to-date. Returns 1 for success
and 0 for failure.
long = obj.GetPipelineMTime () - Get the PipelineMTime for this exective.
int = obj.SetReleaseDataFlag (int port, int n) - Set whether the given output port releases data when it is consumed. Returns 1 if the the value changes and 0 otherwise.
int = obj.GetReleaseDataFlag (int port) - Get whether the given output port releases data
when it is consumed.
int = obj.UpdatePipelineMTime () - Bring the PipelineMTime up to date.
int = obj.UpdateDataObject () - Bring the output data objects existence up to date. This does
not actually produce data, but does create the data object that will store data produced during the UpdateData
step.
int = obj.UpdateInformation () - Bring the output information up to date.
int = obj.UpdateData (int outputPort) - Bring the output data up to date. This should be
called only when information is up to date. Use the Update method if it is not known that the information is up
to date.
32.60
vtkDirectedAcyclicGraph
822
32.60.1
Usage
vtkDirectedAcyclicGraph is a connected directed graph with no cycles. A tree is a type of directed graph, so works
with all graph algorithms.
vtkDirectedAcyclicGraph is a read-only data structure. To construct a tree, create an instance of vtkMutableDirectedGraph. Add vertices and edges with AddVertex() and AddEdge(). You may alternately start by adding a single vertex
as the root then call graph->AddChild(parent) which adds a new vertex and connects the parent to the child. The
tree MUST have all edges in the proper direction, from parent to child. After building the tree, call tree->CheckedShallowCopy(graph) to copy the structure into a vtkDirectedAcyclicGraph. This method will return false if the graph
is an invalid tree.
vtkDirectedAcyclicGraph provides some convenience methods for obtaining the parent and children of a vertex, for
finding the root, and determining if a vertex is a leaf (a vertex with no children).
To create an instance of class vtkDirectedAcyclicGraph, simply invoke its constructor as follows
obj = vtkDirectedAcyclicGraph
32.60.2
Methods
The class vtkDirectedAcyclicGraph has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDirectedAcyclicGraph
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDirectedAcyclicGraph = obj.NewInstance ()
vtkDirectedAcyclicGraph = obj.SafeDownCast (vtkObject o)
int = obj.GetDataObjectType ()
32.61
vtkDirectedGraph
32.61.1
Usage
vtkDirectedGraph is a collection of vertices along with a collection of directed edges (edges that have a source and
target). ShallowCopy() and DeepCopy() (and CheckedShallowCopy(), CheckedDeepCopy()) accept instances of
vtkTree and vtkMutableDirectedGraph.
vtkDirectedGraph is read-only. To create an undirected graph, use an instance of vtkMutableDirectedGraph, then
you may set the structure to a vtkDirectedGraph using ShallowCopy().
To create an instance of class vtkDirectedGraph, simply invoke its constructor as follows
obj = vtkDirectedGraph
32.61.2
Methods
The class vtkDirectedGraph has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkDirectedGraph class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.62 vtkDirectedGraphAlgorithm
823
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDirectedGraph = obj.NewInstance ()
vtkDirectedGraph = obj.SafeDownCast (vtkObject o)
int = obj.GetDataObjectType ()
32.62
vtkDirectedGraphAlgorithm
32.62.1
Usage
vtkDirectedGraphAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help
transition old algorithms to the new pipeline edgehitecture. There are some assumptions and defaults made by
this class you should be aware of. This class defaults such that your filter will have one input port and one output
port. If that is not the case simply change it with SetNumberOfInputPorts etc. See this class constructor for the
default. This class also provides a FillInputPortInfo method that by default says that all inputs will be Graph. If that
isnt the case then please override this method in your subclass. This class breaks out the downstream requests
into separate functions such as ExecuteData and ExecuteInformation. For new algorithms you should implement
RequestData( request, inputVec, outputVec) but for older filters there is a default implementation that calls the old
ExecuteData(output) signature. For even older filters that dont implement ExecuteData the default implementation
calls the even older Execute() signature.
.SECTION Thanks Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from Sandia National
Laboratories for their help in developing this class.
To create an instance of class vtkDirectedGraphAlgorithm, simply invoke its constructor as follows
obj = vtkDirectedGraphAlgorithm
32.62.2
Methods
The class vtkDirectedGraphAlgorithm has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDirectedGraphAlgorithm
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDirectedGraphAlgorithm = obj.NewInstance ()
vtkDirectedGraphAlgorithm = obj.SafeDownCast (vtkObject o)
vtkDirectedGraph = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkDirectedGraph = obj.GetOutput (int index) - Get the output data object for a port on
this algorithm.
obj.SetInput (vtkDataObject obj) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
824
32.63
vtkDiscretizableColorTransferFunction
32.63.1
Usage
This is a cross between a vtkColorTransferFunction and a vtkLookupTable selectively combiniting the functionality
of both. NOTE: One must call Build() after making any changes to the points in the ColorTransferFunction to ensure
that the discrete and non-discrete version match up.
To create an instance of class vtkDiscretizableColorTransferFunction, simply invoke its constructor as follows
obj = vtkDiscretizableColorTransferFunction
32.63.2
Methods
The class vtkDiscretizableColorTransferFunction has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDiscretizableColorTransferFunction class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDiscretizableColorTransferFunction = obj.NewInstance ()
vtkDiscretizableColorTransferFunction = obj.SafeDownCast (vtkObject o)
obj.Build () - Generate discretized lookup table, if applicable. This method must be called after
changes to the ColorTransferFunction otherwise the discretized version will be inconsitent with the nondiscretized one.
obj.SetDiscretize (int ) - Set if the values are to mapped after discretization. The number of
discrete values is set by using SetNumberOfValues(). Not set by default, i.e. color value is determined by
interpolating at the scalar value.
int = obj.GetDiscretize () - Set if the values are to mapped after discretization. The number of
discrete values is set by using SetNumberOfValues(). Not set by default, i.e. color value is determined by
interpolating at the scalar value.
obj.DiscretizeOn () - Set if the values are to mapped after discretization. The number of discrete
values is set by using SetNumberOfValues(). Not set by default, i.e. color value is determined by interpolating
at the scalar value.
obj.DiscretizeOff () - Set if the values are to mapped after discretization. The number of discrete
values is set by using SetNumberOfValues(). Not set by default, i.e. color value is determined by interpolating
at the scalar value.
obj.SetUseLogScale (int useLogScale) - Get/Set if log scale must be used while mapping
scalars to colors. The default is 0.
int = obj.GetUseLogScale () - Get/Set if log scale must be used while mapping scalars to colors.
The default is 0.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.64 vtkDistributedGraphHelper
825
obj.SetNumberOfValues (vtkIdType number) - Set the number of values i.e. colors to be generated in the discrete lookup table. This has no effect if Discretize is off. The default is 256.
vtkIdType = obj.GetNumberOfValues () - Set the number of values i.e. colors to be generated
in the discrete lookup table. This has no effect if Discretize is off. The default is 256.
obj.GetColor (double v, double rgb[3]) - Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1.
vtkUnsignedCharArray = obj.MapScalars (vtkDataArray scalars, int colorMode, int component) - An internal method maps a data array into a 4-component, unsigned char
RGBA array. The color mode determines the behavior of mapping. If VTK_COLOR_MODE_DEFAULT is set,
then unsigned char data arrays are treated as colors (and converted to RGBA if necessary); otherwise, the
data is mapped through this instance of ScalarsToColors. The offset is used for data arrays with more than
one component; it indicates which component to use to do the blending. When the component argument is
-1, then the this object uses its own selected technique to change a vector into a scalar to map.
obj.SetAlpha (double alpha) - Specify an additional opacity (alpha) value to blend with. Values
!= 1 modify the resulting color consistent with the requested form of the output. This is typically used by an
actor in order to blend its opacity. Overridden to pass the alpha to the internal vtkLookupTable.
int = obj.UsingLogScale ()
32.64
vtkDistributedGraphHelper
32.64.1
Usage
A distributed graph helper can be attached to an empty vtkGraph object to turn the vtkGraph into a distributed
graph, whose vertices and edges are distributed across several different processors. vtkDistributedGraphHelper is
an abstract class. Use a subclass of vtkDistributedGraphHelper, such as vtkPBGLDistributedGraphHelper, to build
distributed graphs.
The distributed graph helper provides facilities used by vtkGraph to communicate with other processors that store
other parts of the same distributed graph. The only user-level functionality provided by vtkDistributedGraphHelper
involves this communication among processors and the ability to map between "distributed" vertex and edge IDs and their component parts (processor and local index). For example, the Synchronize() method provides a
barrier that allows all processors to catch up to the same point in the code before any processor can leave that
Synchronize() call. For example, one would call Synchronize() after adding many edges to a distributed graph, so
that all processors can handle the addition of inter-processor edges and continue, after the Synchronize() call, with
a consistent view of the distributed graph. For more information about manipulating (distributed) graphs, see the
vtkGraph documentation.
To create an instance of class vtkDistributedGraphHelper, simply invoke its constructor as follows
obj = vtkDistributedGraphHelper
32.64.2
Methods
The class vtkDistributedGraphHelper has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDistributedGraphHelper
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
826
32.65
vtkEdgeListIterator
32.65.1
Usage
vtkEdgeListIterator iterates through all the edges in a graph, by traversing the adjacency list for each vertex. You
may instantiate this class directly and call SetGraph() to traverse a certain graph. You may also call the graphs
GetEdges() method to set up the iterator for a certain graph.
Note that this class does NOT guarantee that the edges will be processed in order of their ids (i.e. it will not
necessarily return edge 0, then edge 1, etc.).
To create an instance of class vtkEdgeListIterator, simply invoke its constructor as follows
obj = vtkEdgeListIterator
32.65.2
Methods
The class vtkEdgeListIterator has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkEdgeListIterator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkEdgeListIterator = obj.NewInstance ()
vtkEdgeListIterator = obj.SafeDownCast (vtkObject o)
vtkGraph = obj.GetGraph ()
obj.SetGraph (vtkGraph graph)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.66 vtkEmptyCell
827
vtkGraphEdge = obj.NextGraphEdge () - Just like Next(), but returns heavy-weight vtkGraphEdge object instead of the vtkEdgeType struct, for use with wrappers. The graph edge is owned by this
iterator, and changes after each call to NextGraphEdge().
bool = obj.HasNext () - Whether this iterator has more edges.
32.66
vtkEmptyCell
32.66.1
Usage
vtkEmptyCell is a concrete implementation of vtkCell. It is used during processing to represented a deleted element.
To create an instance of class vtkEmptyCell, simply invoke its constructor as follows
obj = vtkEmptyCell
32.66.2
Methods
The class vtkEmptyCell has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkEmptyCell class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkEmptyCell = obj.NewInstance ()
vtkEmptyCell = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int ) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int ) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts1, vtkCellArray lines, vtkCellArray verts2, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
Locator locator, vtkCellArray pts, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData outCd, int insideOut) - See the vtkCell API for descriptions of these methods.
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
828
double derivs)
obj.InterpolateFunctions (double pcoords[3], double weights) - Compute the interpolation functions/derivatives (aka shape functions/derivatives)
obj.InterpolateDerivs (double pcoords[3], double derivs) - Compute the interpolation functions/derivatives (aka shape functions/derivatives)
32.67
vtkExecutive
32.67.1
Usage
vtkExecutive is the superclass for all pipeline executives in VTK. A VTK executive is responsible for controlling one
instance of vtkAlgorithm. A pipeline consists of one or more executives that control data flow. Every reader, source,
writer, or data processing algorithm in the pipeline is implemented in an instance of vtkAlgorithm.
To create an instance of class vtkExecutive, simply invoke its constructor as follows
obj = vtkExecutive
32.67.2
Methods
The class vtkExecutive has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkExecutive class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExecutive = obj.NewInstance ()
vtkExecutive = obj.SafeDownCast (vtkObject o)
vtkAlgorithm = obj.GetAlgorithm () - Get the algorithm to which this executive has been assigned.
int = obj.Update () - Bring the algorithms outputs up-to-date. Returns 1 for success and 0 for
failure.
int = obj.Update (int port) - Bring the algorithms outputs up-to-date. Returns 1 for success
and 0 for failure.
int = obj.GetNumberOfInputPorts () - Get the number of input/output ports for the algorithm
associated with this executive. Returns 0 if no algorithm is set.
int = obj.GetNumberOfOutputPorts () - Get the number of input/output ports for the algorithm
associated with this executive. Returns 0 if no algorithm is set.
int = obj.GetNumberOfInputConnections (int port) - Get the number of input connections on the given port.
vtkInformation = obj.GetOutputInformation (int port) - Get the pipeline information
object for the given output port.
vtkInformationVector = obj.GetOutputInformation () - Get the pipeline information object for all output ports.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.68 vtkExecutiveCollection
829
32.68
vtkExecutiveCollection
32.68.1
Usage
vtkExecutiveCollection is an object that creates and manipulates lists of objects that are (inherited from) vtkExecutives.
To create an instance of class vtkExecutiveCollection, simply invoke its constructor as follows
obj = vtkExecutiveCollection
32.68.2
Methods
The class vtkExecutiveCollection has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExecutiveCollection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExecutiveCollection = obj.NewInstance ()
vtkExecutiveCollection = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
830
32.69
vtkExplicitCell
32.69.1
Usage
vtkExplicitCell is an abstract superclass for cells that cannot be represented implicitly. An implicit representation
requires only a cell type and connectivity list (e.g., triangle). Explicit cells require information beyond this; e.g., a
NURBS surface or cells that require explicit face/edge descriptions. Most cells in VTK are implicitly represented.
To create an instance of class vtkExplicitCell, simply invoke its constructor as follows
obj = vtkExplicitCell
32.69.2
Methods
The class vtkExplicitCell has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkExplicitCell class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExplicitCell = obj.NewInstance ()
vtkExplicitCell = obj.SafeDownCast (vtkObject o)
int = obj.IsExplicitCell () - Set/Get the cell id. This is necessary for explicit cells because
they often need to keep extra information (typically contained in the cell data of a point set). This information
might be things like knot points/weights, boundaries, etc.
obj.SetCellId (vtkIdType ) - Set/Get the cell id. This is necessary for explicit cells because they
often need to keep extra information (typically contained in the cell data of a point set). This information might
be things like knot points/weights, boundaries, etc.
vtkIdType = obj.GetCellId () - Set/Get the cell id. This is necessary for explicit cells because
they often need to keep extra information (typically contained in the cell data of a point set). This information
might be things like knot points/weights, boundaries, etc.
obj.SetDataSet (vtkDataSet ) - Set/Get the mesh that owns this cell. This is necessary for explicit
cells because they often need to keep extra information (typically contained in the cell data of a point set).
This information might be things like knot points/weights, boundaries, etc.
vtkDataSet = obj.GetDataSet () - Set/Get the mesh that owns this cell. This is necessary for
explicit cells because they often need to keep extra information (typically contained in the cell data of a point
set). This information might be things like knot points/weights, boundaries, etc.
32.70
vtkFieldData
32.70 vtkFieldData
32.70.1
831
Usage
vtkFieldData represents and manipulates fields of data. The model of a field is a m x n matrix of data values, where
m is the number of tuples, and n is the number of components. (A tuple is a row of n components in the matrix.) The
field is assumed to be composed of a set of one or more data arrays, where the data in the arrays are of different
types (e.g., int, double, char, etc.), and there may be variable numbers of components in each array. Note that each
data array is assumed to be "m" in length (i.e., number of tuples), which typically corresponds to the number of
points or cells in a dataset. Also, each data array must have a character-string name. (This is used to manipulate
data.)
There are two ways of manipulating and interfacing to fields. You can do it generically by manipulating components/tuples via a double-type data exchange, or you can do it by grabbing the arrays and manipulating them directly. The
former is simpler but performs type conversion, which is bad if your data has non-castable types like (void) pointers,
or you lose information as a result of the cast. The, more efficient method means managing each array in the field.
Using this method you can create faster, more efficient algorithms that do not lose information.
To create an instance of class vtkFieldData, simply invoke its constructor as follows
obj = vtkFieldData
32.70.2
Methods
The class vtkFieldData has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkFieldData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkFieldData = obj.NewInstance ()
vtkFieldData = obj.SafeDownCast (vtkObject o)
obj.Initialize () - Release all data but do not delete object. Also, clear the copy flags.
int = obj.Allocate (vtkIdType sz, vtkIdType ext) - Allocate data for each array. Note
that ext is no longer used.
obj.CopyStructure (vtkFieldData ) - Copy data array structure from a given field. The same
arrays will exist with the same types, but will contain nothing in the copy.
obj.AllocateArrays (int num) - AllocateOfArrays actually sets the number of vtkAbstractArray
pointers in the vtkFieldData object, not the number of used pointers (arrays). Adding more arrays will cause
the object to dynamically adjust the number of pointers if it needs to extend. Although AllocateArrays can be
used if the number of arrays which will be added is known, it can be omitted with a small computation cost.
int = obj.GetNumberOfArrays () - Add an array to the array list. If an array with the same name
already exists - then the added array will replace it.
int = obj.AddArray (vtkAbstractArray array) - Add an array to the array list. If an array
with the same name already exists - then the added array will replace it.
obj.RemoveArray (string name) - Return the ith array in the field. A NULL is returned if the index
i is out of range. A NULL is returned if the array at the given index is not a vtkDataArray.
vtkDataArray = obj.GetArray (int i) - Return the ith array in the field. A NULL is returned if
the index i is out of range. A NULL is returned if the array at the given index is not a vtkDataArray.
vtkDataArray = obj.GetArray (string arrayName) - Returns the ith array in the field. Unlike GetArray(), this method returns a vtkAbstractArray. A NULL is returned only if the index i is out of range.
vtkAbstractArray = obj.GetAbstractArray (int i) - Returns the ith array in the field. Unlike GetArray(), this method returns a vtkAbstractArray. A NULL is returned only if the index i is out of range.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
832
32.71 vtkGenericAdaptorCell
833
vtkIdType = obj.GetNumberOfTuples () - Get the number of tuples in the field. Note: some
fields have arrays with different numbers of tuples; this method returns the number of tuples in the first array.
Mixed-length arrays may have to be treated specially. This method should not be used if the instance is from
a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is
stored with the other fields and will cause the method to behave in an unexpected way.
obj.SetNumberOfTuples (vtkIdType number) - Set the number of tuples for each data array in
the field. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or
vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause
the method to behave in an unexpected way.
obj.SetTuple (vtkIdType i, vtkIdType j, vtkFieldData source) - Set the jth tuple
in source field data at the ith location. Set operations mean that no range checking is performed, so theyre
faster.
obj.InsertTuple (vtkIdType i, vtkIdType j, vtkFieldData source) - Insert the
jth tuple in source field data at the ith location. Range checking is performed and memory allocates as
necessary.
vtkIdType = obj.InsertNextTuple (vtkIdType j, vtkFieldData source) - Insert
the jth tuple in source field data at the end of the tuple matrix. Range checking is performed and memory is
allocated as necessary.
obj.GetTuple (vtkIdType i, double tuple) - Copy the ith tuple value into a user provided
tuple array. Make sure that youve allocated enough space for the copy.
32.71
vtkGenericAdaptorCell
32.71.1
Usage
In VTK, spatial-temporal data is defined in terms of a dataset which is composed of cells. The cells are topological
entities over which an interpolation field is applied. Cells are defined in terms of a topology (e.g., vertices, lines,
triangles, polygons, tetrahedra, etc.), points that instantiate the geometry of the cells, and interpolation fields (in the
general case one interpolation field is for geometry, the other is for attribute data associated with the cell).
Currently most algorithms in VTK use vtkCell and vtkDataSet, which make assumptions about the nature of
datasets, cells, and attributes. In particular, this abstraction assumes that cell interpolation functions are linear,
or products of linear functions. Further, VTK implements most of the interpolation functions. This implementation
starts breaking down as the complexity of the interpolation (or basis) functions increases.
vtkGenericAdaptorCell addresses these issues by providing more general abstraction for cells. It also adopts modern C++ practices including using iterators. The vtkGenericAdaptorCell is designed to fit within the adaptor framework; meaning that it is meant to adapt VTK to external simulation systems (see the GenericFiltering/README.html).
Please note that most cells are defined in terms of other cells (the boundary cells). They are also defined in terms
of points, which are not the same as vertices (vertices are a 0-D cell; points represent a position in space).
Another important concept is the notion of DOFNodes. These concept supports cell types with complex interpolation functions. For example, higher-order p-method finite elements may have different functions on each of their
topological features (edges, faces, region). The coefficients of these polynomial functions are associated with DOFNodes. (There is a single DOFNode for each topological feature.) Note that from this perspective, points are used
to establish the topological form of the cell; mid-side nodes and such are considered DOFNodes.
To create an instance of class vtkGenericAdaptorCell, simply invoke its constructor as follows
obj = vtkGenericAdaptorCell
834
32.71.2
Methods
The class vtkGenericAdaptorCell has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGenericAdaptorCell class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGenericAdaptorCell = obj.NewInstance ()
vtkGenericAdaptorCell = obj.SafeDownCast (vtkObject o)
vtkIdType = obj.GetId () - Unique identification number of the cell over the whole data set. This
unique key may not be contiguous.
int = obj.IsInDataSet () - Does this a cell of a dataset? (otherwise, it is a boundary cell)
int = obj.GetType () - Return the type of the current cell.
Postcondition
(result==VTK_HIGHER_ORDER_EDGE)|| (result==VTK_HIGHER_ORDER_TRIANGLE)|| (result==VTK_HIGHER_ORDER_TETRAHEDRON)
int = obj.GetDimension () - Return the topological dimension of the current cell.
Postcondition
valid_result: result>=0 && result<=3
int = obj.GetGeometryOrder () - Return the interpolation order of the geometry.
Postcondition
positive_result: result>=0
int = obj.IsGeometryLinear () - Does the cell have a non-linear interpolation for the geometry?
Postcondition
definition: result==(GetGeometryOrder()==1)
int = obj.GetAttributeOrder (vtkGenericAttribute a) - Return the interpolation order
of attribute a on the cell (may differ by cell).
Precondition
a_exists: a!=0
Postcondition
positive_result: result>=0
int = obj.GetHighestOrderAttribute (vtkGenericAttributeCollection ac)
Return the index of the first point centered attribute with the highest order in ac.
Precondition
ac_exists: ac!=0
Postcondition
valid_result: result>=-1 && result<ac->GetNumberOfAttributes()
int = obj.IsAttributeLinear (vtkGenericAttribute a) - Does the attribute a have a
non-linear interpolation?
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.71 vtkGenericAdaptorCell
835
Precondition
a_exists: a!=0
Postcondition
definition: result==(GetAttributeOrder()==1)
int = obj.IsPrimary () - Is the cell primary (i.e. not composite) ?
int = obj.GetNumberOfPoints () - Return the number of corner points that compose the cell.
Postcondition
positive_result: result>=0
int = obj.GetNumberOfBoundaries (int dim) - Return the number of boundaries of dimension dim (or all dimensions greater than 0 and less than GetDimension() if -1) of the cell. When dim is -1, the
number of vertices is not included in the count because vertices are a special case: a vertex will have at most
a single field value associated with it; DOF nodes may have an arbitrary number of field values associated
with them.
Precondition
valid_dim_range: (dim==-1) || ((dim>=0)&&(dim<GetDimension()))
Postcondition
positive_result: result>=0
int = obj.GetNumberOfDOFNodes () - Accumulated number of DOF nodes of the current cell. A
DOF node is a component of cell with a given topological dimension. e.g.: a triangle has 4 DOF: 1 face and
3 edges. An hexahedron has 19 DOF: 1 region, 6 faces, and 12 edges.
The number of vertices is not included in the count because vertices are a special case: a vertex will have
at most a single field value associated with it; DOF nodes may have an arbitrary number of field values
associated with them.
Postcondition
valid_result: result==GetNumberOfBoundaries(-1)+1
obj.GetPointIterator (vtkGenericPointIterator it) - Return the points of cell into it.
Precondition
it_exists: it!=0
vtkGenericCellIterator = obj.NewCellIterator () - Create an empty cell iterator. The
user is responsible for deleting it.
Postcondition
result_exists: result!=0
obj.GetBoundaryIterator (vtkGenericCellIterator boundaries, int dim) - Return the boundaries cells of dimension dim (or all dimensions less than GetDimension() if -1) that are part
of the boundary of the cell.
Precondition
valid_dim_range: (dim==-1) || ((dim>=0)&&(dim<GetDimension()))
boundaries_exist: boundaries!=0
int = obj.CountNeighbors (vtkGenericAdaptorCell boundary) - Number of cells
(dimension>boundary->GetDimension()) of the dataset that share the boundary boundary of this. this IS
NOT INCLUDED.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
836
positive_subId: subId>=0
clamped_pcoords: (0<=pcoords[0])&&(pcoords[0]<=1)&&(0<=pcoords[1]) &&(pcoords[1]<=1)&&(0<=pcoords[2])&&(pco
obj.InterpolateTuple (vtkGenericAttribute a, double pcoords[3], double
val) - Interpolate the attribute a at local position pcoords of the cell into val.
Precondition
a_exists: a!=0
a_is_point_centered: a->GetCentering()==vtkPointCentered
clamped_point: pcoords[0]>=0 && pcoords[0]<=1 && pcoords[1]>=0 && pcoords[1]<=1 &&
pcoords[2]>=0 && pcoords[2]<=1
val_exists: val!=0
valid_size: sizeof(val)==a->GetNumberOfComponents()
obj.InterpolateTuple (vtkGenericAttributeCollection c, double pcoords[3],
double val) - Interpolate the whole collection of attributes c at local position pcoords of the cell into
val. Only point centered attributes are taken into account.
32.71 vtkGenericAdaptorCell
837
Precondition
c_exists: c!=0
clamped_point: pcoords[0]>=0 && pcoords[0]<=1 && pcoords[1]>=0 && pcoords[1]<=1 &&
pcoords[2]>=0 && pcoords[2]<=1
val_exists: val!=0
valid_size: sizeof(val)==c->GetNumberOfPointCenteredComponents()
obj.Contour (vtkContourValues values, vtkImplicitFunction f, vtkGeneric-
AttributeCollection attributes, vtkGenericCellTessellator tess, vtkIncrementalPointLocator locator, vtkCellArray verts, vtkCellArray lines,
vtkCellArray polys, vtkPointData outPd, vtkCellData outCd, vtkPointData
internalPd, vtkPointData secondaryPd, vtkCellData secondaryCd) - Generate a
contour (contouring primitives) for each values or with respect to an implicit function f. Contouring is
performed on the scalar attribute (attributes->GetActiveAttribute() attributes->GetActiveComponent()).
Contouring interpolates the attributes->GetNumberOfattributesToInterpolate() attributes attributes->GetAttributesToInterpolate(). The locator, verts, lines, polys, outPd and outCd are cumulative data arrays
over cell iterations: they store the result of each call to Contour():
locator is a points list that merges points as they are inserted (i.e., prevents duplicates).
verts is an array of generated vertices
lines is an array of generated lines
polys is an array of generated polygons
outPd is an array of interpolated point data along the edge (if not-NULL)
outCd is an array of copied cell data of the current cell (if not-NULL) internalPd, secondaryPd and
secondaryCd are initialized by the filter that call it from attributes.
internalPd stores the result of the tessellation pass: the higher-order cell is tessellated into linear subcells.
secondaryPd and secondaryCd are used internally as inputs to the Contour() method on linear subcells. Note: the CopyAllocate() method must be invoked on both outPd and outCd, from secondaryPd
and secondaryCd.
NOTE: vtkGenericAttributeCollection attributes will be replaced by a vtkInformation.
Precondition
values_exist: (values!=0 && f==0) || (values==0 && f!=0)
attributes_exist: attributes!=0
tessellator_exists: tess!=0
locator_exists: locator!=0
verts_exist: verts!=0
lines_exist: lines!=0
polys_exist: polys!=0
internalPd_exists: internalPd!=0
secondaryPd_exists: secondaryPd!=0
secondaryCd_exists: secondaryCd!=0
obj.Clip (double value, vtkImplicitFunction f, vtkGenericAttribute-
838
positive_subId: subId>=0
clamped_pcoords: (0<=pcoords[0])&&(pcoords[0]<=1)&&(0<=pcoords[1]) &&(pcoords[1]<=1)&&(0<=pcoords[2])%%(pc
attribute_exists: attribute!=0
derivs_exists: derivs!=0
valid_size: sizeof(derivs)>=attribute->GetNumberOfComponents()3
obj.GetBounds (double bounds[6]) - Compute the bounding box of the current cell in bounds
in global coordinates. THREAD SAFE
double = obj.GetLength2 () - Return the bounding box diagonal squared of the current cell.
Postcondition
positive_result: result>=0
int = obj.GetParametricCenter (double pcoords[3]) - Get the center of the current cell
(in parametric coordinates) and place it in pcoords. If the current cell is a composite, the return value is the
sub-cell id that the center is in.
Postcondition
valid_result: (result>=0) && (IsPrimary() implies result==0)
double = obj.GetParametricDistance (double pcoords[3]) - Return the distance of
the parametric coordinate pcoords to the current cell. If inside the cell, a distance of zero is returned.
This is used during picking to get the correct cell picked. (The tolerance will occasionally allow cells to be
picked who are not really intersected "inside" the cell.)
32.71 vtkGenericAdaptorCell
839
Postcondition
positive_result: result>=0
obj.Tessellate (vtkGenericAttributeCollection attributes, vtkGeneric-
GenericCellTessellator tess, int index, vtkPoints points, vtkIncrementalPointLocator locator, vtkCellArray cellArray, vtkPointData internalPd,
vtkPointData pd, vtkCellData cd) - Tessellate face index of the cell. See Tessellate() for
further explanations.
Precondition
cell_is_3d: GetDimension()==3
attributes_exist: attributes!=0
tessellator_exists: tess!=0
valid_face: index>=0
points_exist: points!=0
cellArray_exists: cellArray!=0
internalPd_exists: internalPd!=0
pd_exist: pd!=0
cd_exists: cd!=0
int = obj.GetNumberOfVerticesOnFace (int faceId) - Return the number of vertices
defining face faceId.
Precondition
is_3d: this->GetDimension()==3
valid_faceId_range: faceId>=0 && faceId<this->GetNumberOfBoundaries(2)
840
32.72
vtkGenericAttribute
32.72.1
Usage
vtkGenericAttribute is an abstract class that defines an API for attribute data. Attribute data is data associated with
the topology or geometry of a dataset (i.e., points, cells, etc.). vtkGenericAttribute is part of the adaptor framework
(see GenericFiltering/README.html).
vtkGenericAttribute provides a more general interface to attribute data than its counterpart vtkDataArray (which
assumes a linear, contiguous array). It adopts an iterator interface, and allows attributes to be associated with
points, edges, faces, or edges.
To create an instance of class vtkGenericAttribute, simply invoke its constructor as follows
obj = vtkGenericAttribute
32.72.2
Methods
The class vtkGenericAttribute has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGenericAttribute class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGenericAttribute = obj.NewInstance ()
vtkGenericAttribute = obj.SafeDownCast (vtkObject o)
string = obj.GetName () - Name of the attribute. (e.g. "velocity")
Postcondition
result_may_not_exist: result!=0 || result==0
int = obj.GetNumberOfComponents () - Dimension of the attribute. (1 for scalar, 3 for velocity)
Postcondition
positive_result: result>=0
GetType()==VTK_SCALARS implies result==1
(GetType()==VTK_VECTORS||(GetType()==VTK_NORMALS)||(GetType()==VTK_TCOORDS) implies
result==3
GetType()==VTK_TENSORS implies result==6
int = obj.GetCentering () - Is the attribute centered either on points, cells or boundaries?
Postcondition
valid_result: (result==vtkPointCentered)||(result==vtkCellCentered)
int = obj.GetType () - Type of the attribute: scalar, vector, normal, texture coordinate, tensor
32.72 vtkGenericAttribute
841
Postcondition
valid_result:
(result==vtkDataSetAttributes::SCALARS) ||(result==vtkDataSetAttributes::VECTORS)
||(result==vtkDataSetAttributes::NORMALS) ||(result==vtkDataSetAttributes::TCOORDS) ||(result==vtkDataSetAttributes::TENSORS)
int = obj.GetComponentType () - Type of the components of the attribute: int, float, double
Postcondition
valid_result: (result==VTK_BIT) ||(result==VTK_CHAR) ||(result==VTK_UNSIGNED_CHAR) ||(result==VTK_SHORT) ||(result==VTK_UNSIGNED_SHORT)||(result==VTK_INT) ||(result==VTK_UNSIGNED_INT) ||(result==VTK_LONG) ||(result==VTK_UNSIGNED_LONG) ||(result==VTK_FLOAT) ||(result==VTK_DOUBLE) ||(result==VTK_ID_TYPE)
vtkIdType = obj.GetSize () - Number of tuples.
Postcondition
valid_result: result>=0
long = obj.GetActualMemorySize () - Size in kilobytes taken by the attribute.
obj.GetRange (int component, double range[2]) - Range of the attribute component
component. If component==-1, it returns the range of the magnitude (euclidean norm). THREAD SAFE
Precondition
valid_component: (component>=-1)&&(component<GetNumberOfComponents())
double = obj.GetMaxNorm () - Return the maximum euclidean norm for the tuples.
Postcondition
positive_result: result>=0
obj.GetTuple (vtkGenericAdaptorCell c, double tuple) - Put attribute at all points of
cell c in tuple.
Precondition
c_exists: c!=0
c_valid: !c->IsAtEnd()
tuple_exists: tuple!=0
valid_tuple: sizeof(tuple)>=GetNumberOfComponents()c->GetCell()->GetNumberOfPoints()
obj.GetTuple (vtkGenericCellIterator c, double tuple) - Put attribute at all points of
cell c in tuple.
Precondition
c_exists: c!=0
c_valid: !c->IsAtEnd()
tuple_exists: tuple!=0
valid_tuple: sizeof(tuple)>=GetNumberOfComponents()c->GetCell()->GetNumberOfPoints()
obj.GetTuple (vtkGenericPointIterator p, double tuple) - Put the value of the attribute at position p into tuple.
Precondition
p_exists: p!=0
p_valid: !p->IsAtEnd()
tuple_exists: tuple!=0
valid_tuple_size: sizeof(tuple)>=GetNumberOfComponents()
obj.GetComponent (int i, vtkGenericCellIterator c, double values)
component i of the attribute at all points of cell c in values.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
Put
842
32.73
vtkGenericAttributeCollection
32.73.1
Usage
32.73.2
Methods
The class vtkGenericAttributeCollection has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGenericAttributeCollection
class.
string = obj.GetClassName () - Standard type definition and print methods for a VTK class.
int = obj.IsA (string name) - Standard type definition and print methods for a VTK class.
vtkGenericAttributeCollection = obj.NewInstance () - Standard type definition and
print methods for a VTK class.
vtkGenericAttributeCollection = obj.SafeDownCast (vtkObject o)
type definition and print methods for a VTK class.
Standard
int = obj.GetNumberOfAttributes () - Return the number of attributes (e.g., instances of vtkGenericAttribute) in the collection.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.73 vtkGenericAttributeCollection
843
Postcondition
positive_result: result>=0
int = obj.GetNumberOfComponents () - Return the number of components. This is the sum of
all components found in all attributes.
Postcondition
positive_result: result>=0
int = obj.GetNumberOfPointCenteredComponents () - Return the number of components.
This is the sum of all components found in all point centered attributes.
Postcondition
positive_result: result>=0
int = obj.GetMaxNumberOfComponents () - Maximum number of components encountered
among all attributes.
Postcondition
positive_result: result>=0
valid_result: result<=GetNumberOfComponents()
long = obj.GetActualMemorySize () - Actual size of the data in kilobytes; only valid after the
pipeline has updated. It is guaranteed to be greater than or equal to the memory required to represent the
data.
int = obj.IsEmpty () - Indicate whether the collection contains any attributes.
Postcondition
definition: result==(GetNumberOfAttributes()==0)
vtkGenericAttribute = obj.GetAttribute (int i) - Return a pointer to the ith instance of
vtkGenericAttribute.
Precondition
not_empty: !IsEmpty()
valid_i: i>=0 && i<GetNumberOfAttributes()
Postcondition
result_exists: result!=0
int = obj.FindAttribute (string name) - Return the index of the attribute named name.
Return the non-negative index if found. Return -1 otherwise.
Precondition
name_exists: name!=0
Postcondition
valid_result: (result==-1) || (result>=0) && (result<=GetNumberOfAttributes())
int = obj.GetAttributeIndex (int i) - Return the index of the first component of attribute i
in an array of format attrib0comp0 attrib0comp1 ... attrib4comp0 ...
Precondition
valid_i: i>=0 && i<GetNumberOfAttributes()
is_point_centered: GetAttribute(i)->GetCentering()==vtkPointCentered
obj.InsertNextAttribute (vtkGenericAttribute a) - Add the attribute a to the end of
the collection.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
844
32.73 vtkGenericAttributeCollection
845
Precondition
not_empty: !IsEmpty()
Postcondition
valid_result: result>=0 && result<GetNumberOfAttributes()
int = obj.GetActiveComponent () - Component of the active attribute to be processed. -1 means
module.
Precondition
not_empty: GetNumberOfAttributes()>0
Postcondition
valid_result: result>=-1 && result<GetAttribute(GetActiveAttribute())->GetNumberOfComponents()
obj.SetActiveAttribute (int attribute, int component) - Set the scalar attribute to
be processed. -1 means module.
Precondition
not_empty: !IsEmpty()
valid_attribute: attribute>=0 && attribute<GetNumberOfAttributes()
valid_component: component>=-1 && component<GetAttribute(attribute)->GetNumberOfComponents()
Postcondition
is_set: GetActiveAttribute()==attribute && GetActiveComponent()==component
int = obj.GetNumberOfAttributesToInterpolate () - Number of attributes to interpolate.
Precondition
not_empty: !IsEmpty()
Postcondition
positive_result: result>=0
int = obj.HasAttribute (int size, int attributes, int attribute)
obj.SetAttributesToInterpolate (int size, int attributes) - Set the attributes to
interpolate.
Precondition
not_empty: !IsEmpty()
positive_size: size>=0
valid_attributes: size>0 implies attributes!=0
valid_attributes_contents: attributes!=0 implies !HasAttributes(size,attributes,GetActiveAttribute())
Postcondition
is_set: (GetNumberOfAttributesToInterpolate()==size)&& (GetAttributesToInterpolate()==attributes)
obj.SetAttributesToInterpolateToAll () - Set the attributes to interpolate.
Precondition
not_empty: !IsEmpty()
positive_size: size>=0
valid_attributes: size>0 implies attributes!=0
valid_attributes_contents: attributes!=0 implies !HasAttributes(size,attributes,GetActiveAttribute())
Postcondition
is_set: (GetNumberOfAttributesToInterpolate()==size)&& (GetAttributesToInterpolate()==attributes)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
846
32.74
vtkGenericCell
32.74.1
Usage
vtkGenericCell is a class that provides access to concrete types of cells. Its main purpose is to allow thread-safe
access to cells, supporting the vtkDataSet::GetCell(vtkGenericCell ) method. vtkGenericCell acts like any type of
cell, it just dereferences an internal representation. The SetCellType() methods use #define constants; these are
defined in the file vtkCellType.h.
To create an instance of class vtkGenericCell, simply invoke its constructor as follows
obj = vtkGenericCell
32.74.2
Methods
The class vtkGenericCell has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkGenericCell class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGenericCell = obj.NewInstance ()
vtkGenericCell = obj.SafeDownCast (vtkObject o)
obj.ShallowCopy (vtkCell c) - See the vtkCell API for descriptions of these methods.
obj.DeepCopy (vtkCell c) - See the vtkCell API for descriptions of these methods.
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.IsLinear () - See the vtkCell API for descriptions of these methods.
int = obj.RequiresInitialization () - See the vtkCell API for descriptions of these methods.
obj.Initialize () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int edgeId) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int faceId) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
Locator locator, vtkCellArray connectivity, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData outCd,
int insideOut) - See the vtkCell API for descriptions of these methods.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.74 vtkGenericCell
847
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts) - See the
vtkCell API for descriptions of these methods.
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs) - See the vtkCell API for descriptions of these methods.
int = obj.GetParametricCenter (double pcoords[3]) - See the vtkCell API for descriptions of these methods.
int = obj.IsPrimaryCell () - See the vtkCell API for descriptions of these methods.
obj.InterpolateFunctions (double pcoords[3], double weights) - Compute the interpolation functions/derivatives (aka shape functions/derivatives)
obj.InterpolateDerivs (double pcoords[3], double derivs) - Compute the interpolation functions/derivatives (aka shape functions/derivatives)
obj.SetCellType (int cellType) - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal instance
of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal cell which is then
used for computation.
obj.SetCellTypeToEmptyCell () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal instance
of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal cell which is then
used for computation.
obj.SetCellTypeToVertex () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal instance of a
concrete cell type. When you set the cell type, you are resetting a pointer to an internal cell which is then
used for computation.
obj.SetCellTypeToPolyVertex () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal instance
of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal cell which is then
used for computation.
obj.SetCellTypeToLine () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell
) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal instance of a concrete
cell type. When you set the cell type, you are resetting a pointer to an internal cell which is then used for
computation.
obj.SetCellTypeToPolyLine () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal instance
of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal cell which is then
used for computation.
obj.SetCellTypeToTriangle () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal instance
of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal cell which is then
used for computation.
obj.SetCellTypeToTriangleStrip () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal
instance of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal cell
which is then used for computation.
obj.SetCellTypeToPolygon () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal instance
of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal cell which is then
used for computation.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
848
32.75 vtkGenericCellIterator
849
obj.SetCellTypeToBiQuadraticTriangle () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an
internal instance of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal
cell which is then used for computation.
obj.SetCellTypeToQuadraticQuad () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal
instance of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal cell
which is then used for computation.
obj.SetCellTypeToQuadraticTetra () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal
instance of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal cell
which is then used for computation.
obj.SetCellTypeToQuadraticHexahedron () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an
internal instance of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal
cell which is then used for computation.
obj.SetCellTypeToQuadraticWedge () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal
instance of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal cell
which is then used for computation.
obj.SetCellTypeToQuadraticPyramid () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal
instance of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal cell
which is then used for computation.
obj.SetCellTypeToQuadraticLinearQuad () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an
internal instance of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal
cell which is then used for computation.
obj.SetCellTypeToBiQuadraticQuad () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an internal
instance of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal cell
which is then used for computation.
obj.SetCellTypeToQuadraticLinearWedge () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an
internal instance of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal
cell which is then used for computation.
obj.SetCellTypeToBiQuadraticQuadraticWedge () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing
an internal instance of a concrete cell type. When you set the cell type, you are resetting a pointer to an
internal cell which is then used for computation.
obj.SetCellTypeToTriQuadraticHexahedron () - This method is used to support the vtkDataSet::GetCell(vtkGenericCell ) method. It allows vtkGenericCell to act like any cell type by dereferencing an
internal instance of a concrete cell type. When you set the cell type, you are resetting a pointer to an internal
cell which is then used for computation.
obj.SetCellTypeToBiQuadraticQuadraticHexahedron () - Instantiate a new vtkCell based
on its cell type value
32.75
vtkGenericCellIterator
850
32.75.1
Usage
This class (and subclasses) are used to iterate over cells. Use it only in conjunction with vtkGenericDataSet (i.e.,
the adaptor framework).
Typical use is:
vtkGenericDataSet *dataset;
vtkGenericCellIterator *it = dataset->NewCellIterator(2);
for (it->Begin(); !it->IsAtEnd(); it->Next());
{
spec=it->GetCell();
}
32.75.2
Methods
The class vtkGenericCellIterator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGenericCellIterator class.
string = obj.GetClassName () - Standard VTK construction and type macros.
int = obj.IsA (string name) - Standard VTK construction and type macros.
vtkGenericCellIterator = obj.NewInstance () - Standard VTK construction and type
macros.
vtkGenericCellIterator = obj.SafeDownCast (vtkObject o) - Standard VTK construction and type macros.
obj.Begin () - Move iterator to first position if any (loop initialization).
int = obj.IsAtEnd () - Is the iterator at the end of traversal?
vtkGenericAdaptorCell = obj.NewCell () - Create an empty cell. The user is responsible for
deleting it.
Postcondition
result_exists: result!=0
obj.GetCell (vtkGenericAdaptorCell c) - Get the cell at current position. The cell should be
instantiated with the NewCell() method.
Precondition
not_at_end: !IsAtEnd()
c_exists: c!=0 THREAD SAFE
vtkGenericAdaptorCell = obj.GetCell () - Get the cell at the current traversal position. NOT
THREAD SAFE
Precondition
not_at_end: !IsAtEnd()
32.76 vtkGenericCellTessellator
851
Postcondition
result_exits: result!=0
obj.Next () - Move the iterator to the next position in the list.
Precondition
not_at_end: !IsAtEnd()
32.76
vtkGenericCellTessellator
32.76.1
Usage
vtkGenericCellTessellator is a helper class to perform adaptive tessellation of particular cell topologies. The major
purpose for this class is to transform higher-order cell types (e.g., higher-order finite elements) into linear cells that
can then be easily visualized by VTK. This class works in conjunction with the vtkGenericDataSet and vtkGenericAdaptorCell classes.
This algorithm is based on edge subdivision. An error metric along each edge is evaluated, and if the error is greater
than some tolerance, the edge is subdivided (as well as all connected 2D and 3D cells). The process repeats until
the error metric is satisfied.
A significant issue addressed by this algorithm is to insure face compatibility across neigboring cells. That is,
diagonals due to face triangulation must match to insure that the mesh is compatible. The algorithm employs a
precomputed table to accelerate the tessellation process. The table was generated with the help of vtkOrderedTriangulator; the basic idea is that the choice of diagonal is made by considering the relative value of the point
ids.
To create an instance of class vtkGenericCellTessellator, simply invoke its constructor as follows
obj = vtkGenericCellTessellator
32.76.2
Methods
The class vtkGenericCellTessellator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGenericCellTessellator
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGenericCellTessellator = obj.NewInstance ()
vtkGenericCellTessellator = obj.SafeDownCast (vtkObject o)
obj.TessellateFace (vtkGenericAdaptorCell cell, vtkGenericAttribute-
852
att, vtkDoubleArray points, vtkCellArray cellArray, vtkPointData internalPd) - Tessellate a 3D cell. The result is a set of smaller linear tetrahedra in cellArray with points and point
data internalPd.
Precondition
cell_exists: cell!=0
valid_dimension: cell->GetDimension()==3
att_exists: att!=0
points_exists: points!=0
cellArray_exists: cellArray!=0
internalPd_exists: internalPd!=0
obj.Triangulate (vtkGenericAdaptorCell cell, vtkGenericAttributeCollection
att, vtkDoubleArray points, vtkCellArray cellArray, vtkPointData internalPd) - Triangulate a 2D cell. The result is a set of smaller linear triangles in cellArray with points and point
data internalPd.
Precondition
cell_exists: cell!=0
valid_dimension: cell->GetDimension()==2
att_exists: att!=0
points_exists: points!=0
cellArray_exists: cellArray!=0
internalPd_exists: internalPd!=0
obj.SetErrorMetrics (vtkCollection someErrorMetrics) - Specify the list of error metrics used to decide if an edge has to be splitted or not. It is a collection of vtkGenericSubdivisionErrorMetric-s.
vtkCollection = obj.GetErrorMetrics () - Specify the list of error metrics used to decide if
an edge has to be splitted or not. It is a collection of vtkGenericSubdivisionErrorMetric-s.
obj.Initialize (vtkGenericDataSet ds) - Initialize the tessellator with a data set ds.
obj.InitErrorMetrics (vtkGenericDataSet ds) - Init the error metric with the dataset.
Should be called in each filter before any tessellation of any cell.
int = obj.GetMeasurement () - If true, measure the quality of the fixed subdivision.
obj.SetMeasurement (int ) - If true, measure the quality of the fixed subdivision.
obj.GetMaxErrors (double errors) - Get the maximum error measured after the fixed subdivision.
Precondition
errors_exists: errors!=0
valid_size: sizeof(errors)==GetErrorMetrics()->GetNumberOfItems()
32.77
vtkGenericDataSet
32.77 vtkGenericDataSet
32.77.1
853
Usage
In VTK, spatial-temporal data is defined in terms of a dataset. The dataset consists of geometry (e.g., points),
topology (e.g., cells), and attributes (e.g., scalars, vectors, etc.) vtkGenericDataSet is an abstract class defining this
abstraction.
Since vtkGenericDataSet provides a general interface to manipulate data, algorithms that process it tend to be
slower than those specialized for a particular data type. For this reason, there are concrete, non-abstract subclasses
that represent and provide access to data more efficiently. Note that filters to process this dataset type are currently
found in the VTK/GenericFiltering/ subdirectory.
Unlike the vtkDataSet class, vtkGenericDataSet provides a more flexible interface including support for iterators.
vtkGenericDataSet is also designed to interface VTK to external simulation packages without the penalty of copying
memory (see VTK/GenericFiltering/README.html) for more information. Thus vtkGenericDataSet plays a central
role in the adaptor framework.
Please note that this class introduces the concepts of "boundary cells". This refers to the boundaries of a cell (e.g.,
face of a tetrahedron) which may in turn be represented as a cell. Boundary cells are derivative topological features
of cells, and are therefore never explicitly represented in the dataset. Often in visualization algorithms, looping over
boundaries (edges or faces) is employed, while the actual dataset cells may not traversed. Thus there are methods
to loop over these boundary cells.
Finally, as a point of clarification, points are not the same as vertices. Vertices refer to points, and points specify a
position is space. Vertices are a type of 0-D cell. Also, the concept of a DOFNode, which is where coefficients for
higher-order cells are kept, is a new concept introduced by the adaptor framework (see vtkGenericAdaptorCell for
more information).
To create an instance of class vtkGenericDataSet, simply invoke its constructor as follows
obj = vtkGenericDataSet
32.77.2
Methods
The class vtkGenericDataSet has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGenericDataSet class.
string = obj.GetClassName () - Standard VTK type and print macros.
int = obj.IsA (string name) - Standard VTK type and print macros.
vtkGenericDataSet = obj.NewInstance () - Standard VTK type and print macros.
vtkGenericDataSet = obj.SafeDownCast (vtkObject o) - Standard VTK type and print
macros.
vtkIdType = obj.GetNumberOfPoints () - Return the number of points composing the dataset.
See NewPointIterator() for more details.
Postcondition
positive_result: result>=0
vtkIdType = obj.GetNumberOfCells (int dim) - Return the number of cells that explicitly
define the dataset. See NewCellIterator() for more details.
Precondition
valid_dim_range: (dim>=-1) && (dim<=3)
854
32.78 vtkGenericDataSetAlgorithm
855
Precondition
not_empty: GetNumberOfPoints()>0
p_exists: p!=0
long = obj.GetMTime () - Datasets are composite objects and need to check each part for their
modified time.
obj.ComputeBounds () - Compute the geometry bounding box.
obj.GetBounds (double bounds[6]) - Return the geometry bounding box in global coordinates
in the form (xmin,xmax, ymin,ymax, zmin,zmax) in the bounds array.
obj.GetCenter (double center[3]) - Get the center of the bounding box in global coordinates.
double = obj.GetLength () - Return the length of the diagonal of the bounding box.
Postcondition
positive_result: result>=0
vtkGenericAttributeCollection = obj.GetAttributes () - Get the collection of attributes associated with this dataset.
vtkDataSetAttributes = obj.GetAttributes (int type) - Set/Get a cell tessellator if
cells must be tessellated during processing.
Precondition
tessellator_exists: tessellator!=0
obj.SetTessellator (vtkGenericCellTessellator tessellator) - Set/Get a cell tessellator if cells must be tessellated during processing.
Precondition
tessellator_exists: tessellator!=0
vtkGenericCellTessellator = obj.GetTessellator () - Set/Get a cell tessellator if cells
must be tessellated during processing.
Precondition
tessellator_exists: tessellator!=0
long = obj.GetActualMemorySize () - Actual size of the data in kilobytes; only valid after the
pipeline has updated. It is guaranteed to be greater than or equal to the memory required to represent the
data.
int = obj.GetDataObjectType () - Return the type of data object.
vtkIdType = obj.GetEstimatedSize () - Estimated size needed after tessellation (or special
operation)
32.78
vtkGenericDataSetAlgorithm
32.78.1
Usage
856
32.78.2
Methods
The class vtkGenericDataSetAlgorithm has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGenericDataSetAlgorithm
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGenericDataSetAlgorithm = obj.NewInstance ()
vtkGenericDataSetAlgorithm = obj.SafeDownCast (vtkObject o)
vtkGenericDataSet = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkGenericDataSet = obj.GetOutput (int ) - Get the output data object for a port on this
algorithm.
obj.SetOutput (vtkDataObject d) - Get the output data object for a port on this algorithm.
vtkDataObject = obj.GetInput ()
vtkDataObject = obj.GetInput (int port)
vtkGenericDataSet = obj.GetGenericDataSetInput (int port)
obj.SetInput (vtkDataObject ) - Set an input of this algorithm. You should not override these
methods because they are not the only way to connect a pipeline. Note that these methods support oldstyle pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection
within a single port.
obj.SetInput (int , vtkDataObject ) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
obj.AddInput (vtkDataObject ) - Add an input of this algorithm. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
obj.AddInput (int , vtkDataObject ) - Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
32.79
vtkGenericEdgeTable
32.79.1
Usage
vtkGenericEdgeTable is used to indicate the existance of and hold information about edges. Similar to vtkEdgeTable, this class is more sophisticated in that it uses reference counting to keep track of when information about an
edge should be deleted.
vtkGenericEdgeTable is a helper class used in the adaptor framework. It is used during the tessellation process to
hold information about the error metric on each edge. This avoids recomputing the error metric each time the same
edge is visited.
To create an instance of class vtkGenericEdgeTable, simply invoke its constructor as follows
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.79 vtkGenericEdgeTable
857
obj = vtkGenericEdgeTable
32.79.2
Methods
The class vtkGenericEdgeTable has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGenericEdgeTable class.
string = obj.GetClassName () - Standard VTK type and print macros.
int = obj.IsA (string name) - Standard VTK type and print macros.
vtkGenericEdgeTable = obj.NewInstance () - Standard VTK type and print macros.
vtkGenericEdgeTable = obj.SafeDownCast (vtkObject o) - Standard VTK type and print
macros.
obj.InsertEdge (vtkIdType e1, vtkIdType e2, vtkIdType cellId, int ref) Insert an edge but do not split it.
int = obj.RemoveEdge (vtkIdType e1, vtkIdType e2) - Method to remove an edge from
the table. The method returns the current reference count.
int = obj.IncrementEdgeReferenceCount (vtkIdType e1, vtkIdType e2, vtkIdType cellId) - Method that increments the referencecount and returns it.
int = obj.CheckEdgeReferenceCount (vtkIdType e1, vtkIdType e2) - Return the
edge reference count.
obj.Initialize (vtkIdType start) - To specify the starting point id. It will initialize LastPointId
This is very sensitive the start point should be cautiously chosen
int = obj.GetNumberOfComponents () - Return the total number of components for the pointcentered attributes.
Postcondition
positive_result: result>0
obj.SetNumberOfComponents (int count) - Set the total number of components for the pointcentered attributes.
Precondition
positive_count: count>0
int = obj.CheckPoint (vtkIdType ptId) - Check if a point is already in the point table.
int = obj.CheckPoint (vtkIdType ptId, double point[3], double scalar)
Check for the existence of a point and return its coordinate value.
Precondition
scalar_size: sizeof(scalar)==this->GetNumberOfComponents()
obj.InsertPoint (vtkIdType ptId, double point[3]) - Insert point associated with an
edge.
obj.InsertPointAndScalar (vtkIdType ptId, double pt[3], double s) - Insert
point associated with an edge.
858
32.80
vtkGenericInterpolatedVelocityField
32.80.1
Usage
vtkGenericInterpolatedVelocityField acts as a continuous velocity field by performing cell interpolation on the underlying vtkDataSet. This is a concrete sub-class of vtkFunctionSet with NumberOfIndependentVariables = 4 (x,y,z,t)
and NumberOfFunctions = 3 (u,v,w). Normally, every time an evaluation is performed, the cell which contains the
point (x,y,z) has to be found by calling FindCell. This is a computationally expansive operation. In certain cases,
the cell search can be avoided or shortened by providing a guess for the cell iterator. For example, in streamline
integration, the next evaluation is usually in the same or a neighbour cell. For this reason, vtkGenericInterpolatedVelocityField stores the last cell iterator. If caching is turned on, it uses this iterator as the starting point.
To create an instance of class vtkGenericInterpolatedVelocityField, simply invoke its constructor as follows
obj = vtkGenericInterpolatedVelocityField
32.80.2
Methods
The class vtkGenericInterpolatedVelocityField has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGenericInterpolatedVelocityField class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGenericInterpolatedVelocityField = obj.NewInstance ()
vtkGenericInterpolatedVelocityField = obj.SafeDownCast (vtkObject o)
int = obj.FunctionValues (double x, double f) - Evaluate the velocity field, f, at (x, y, z,
t). For now, t is ignored.
obj.AddDataSet (vtkGenericDataSet dataset) - Add a dataset used for the implicit function
evaluation. If more than one dataset is added, the evaluation point is searched in all until a match is found.
THIS FUNCTION DOES NOT CHANGE THE REFERENCE COUNT OF dataset FOR THREAD SAFETY
REASONS.
obj.ClearLastCell () - Set the last cell id to -1 so that the next search does not start from the
previous cell
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.81 vtkGenericPointIterator
859
32.81
vtkGenericPointIterator
32.81.1
Usage
This class (and subclasses) are used to iterate over points. Use it only in conjunction with vtkGenericDataSet (i.e.,
the adaptor framework).
Typical use is:
vtkGenericDataSet *dataset;
vtkGenericPointIterator *it = dataset->NewPointIterator();
for (it->Begin(); !it->IsAtEnd(); it->Next());
{
x=it->GetPosition();
}
860
32.81.2
Methods
The class vtkGenericPointIterator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGenericPointIterator
class.
string = obj.GetClassName () - Standard VTK construction and type macros.
int = obj.IsA (string name) - Standard VTK construction and type macros.
vtkGenericPointIterator = obj.NewInstance () - Standard VTK construction and type
macros.
vtkGenericPointIterator = obj.SafeDownCast (vtkObject o) - Standard VTK construction and type macros.
obj.Begin () - Move iterator to first position if any (loop initialization).
int = obj.IsAtEnd () - Is the iterator at the end of traversal?
obj.Next () - Move the iterator to the next position in the list.
Precondition
not_off: !IsAtEnd()
obj.GetPosition (double x[3]) - Get the coordinates of the point at the current iterator position.
Precondition
not_off: !IsAtEnd()
x_exists: x!=0
vtkIdType = obj.GetId () - Return the unique identifier for the point, could be non-contiguous.
Precondition
not_off: !IsAtEnd()
32.82
vtkGenericSubdivisionErrorMetric
32.82.1
Usage
Objects of that class answer the following question during the cell subdivision: "does the edge need to be subdivided?" through RequiresEdgeSubdivision(). The answer depends on the criterium actually used in the subclass of
this abstract class: a geometric-based error metric (variation of edge from a straight line), an attribute-based error
metric (variation of the active attribute/component value from a linear ramp) , a view-depend error metric, ... Cell
subdivision is performed in the context of the adaptor framework: higher-order, or complex cells, are automatically
tessellated into simplices so that they can be processed with conventional visualization algorithms.
To create an instance of class vtkGenericSubdivisionErrorMetric, simply invoke its constructor as follows
obj = vtkGenericSubdivisionErrorMetric
32.83 vtkGeometricErrorMetric
32.82.2
861
Methods
The class vtkGenericSubdivisionErrorMetric has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGenericSubdivisionErrorMetric class.
string = obj.GetClassName () - Standard VTK type and error macros.
int = obj.IsA (string name) - Standard VTK type and error macros.
vtkGenericSubdivisionErrorMetric = obj.NewInstance () - Standard VTK type and error macros.
vtkGenericSubdivisionErrorMetric = obj.SafeDownCast (vtkObject o) - Standard VTK type and error macros.
int = obj.RequiresEdgeSubdivision (double leftPoint, double midPoint,
double rightPoint, double alpha) - Does the edge need to be subdivided according to the
implemented computation? The edge is defined by its leftPoint and its rightPoint. leftPoint, midPoint and
rightPoint have to be initialized before calling RequiresEdgeSubdivision(). Their format is global coordinates,
parametric coordinates and point centered attributes: xyx rst abc de... alpha is the normalized abscissa of
the midpoint along the edge. (close to 0 means close to the left point, close to 1 means close to the right
point)
Precondition
leftPoint_exists: leftPoint!=0
midPoint_exists: midPoint!=0
rightPoint_exists: rightPoint!=0
clamped_alpha: alpha>0 && alpha<1
valid_size: sizeof(leftPoint)=sizeof(midPoint)=sizeof(rightPoint) =GetAttributeCollection()->GetNumberOfPointCenteredComponents()+6
double = obj.GetError (double leftPoint, double midPoint, double rightPoint, double alpha) - Return the error at the mid-point. The type of error depends on the state of
the concrete error metric. For instance, it can return an absolute or relative error metric. See RequiresEdgeSubdivision() for a description of the arguments.
Precondition
leftPoint_exists: leftPoint!=0
midPoint_exists: midPoint!=0
rightPoint_exists: rightPoint!=0
clamped_alpha: alpha>0 && alpha<1
valid_size: sizeof(leftPoint)=sizeof(midPoint)=sizeof(rightPoint) =GetAttributeCollection()->GetNumberOfPointCenteredComponents()+6
Postcondition
positive_result: result>=0
obj.SetGenericCell (vtkGenericAdaptorCell cell) - The cell that the edge belongs to.
vtkGenericAdaptorCell = obj.GetGenericCell () - The cell that the edge belongs to.
obj.SetDataSet (vtkGenericDataSet ds) - Set/Get the dataset to be tessellated.
vtkGenericDataSet = obj.GetDataSet () - Set/Get the dataset to be tessellated.
32.83
vtkGeometricErrorMetric
862
32.83.1
Usage
It is a concrete error metric, based on a geometric criterium: the variation of the edge from a straight line.
To create an instance of class vtkGeometricErrorMetric, simply invoke its constructor as follows
obj = vtkGeometricErrorMetric
32.83.2
Methods
The class vtkGeometricErrorMetric has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGeometricErrorMetric
class.
string = obj.GetClassName () - Standard VTK type and error macros.
int = obj.IsA (string name) - Standard VTK type and error macros.
vtkGeometricErrorMetric = obj.NewInstance () - Standard VTK type and error macros.
vtkGeometricErrorMetric = obj.SafeDownCast (vtkObject o) - Standard VTK type
and error macros.
double = obj.GetAbsoluteGeometricTolerance () - Return the squared absolute geometric accuracy. See SetAbsoluteGeometricTolerance() for details.
Postcondition
positive_result: result>0
obj.SetAbsoluteGeometricTolerance (double value) - Set the geometric accuracy with
a squared absolute value. This is the geometric object-based accuracy. Subdivision will be required if the
square distance between the real point and the straight line passing through the vertices of the edge is greater
than value. For instance 0.01 will give better result than 0.1.
Precondition
positive_value: value>0
obj.SetRelativeGeometricTolerance (double value, vtkGenericDataSet ds) Set the geometric accuracy with a value relative to the length of the bounding box of the dataset. Internally
compute the absolute tolerance. For instance 0.01 will give better result than 0.1.
Precondition
valid_range_value: value>0 && value<1
ds_exists: ds!=0
int = obj.RequiresEdgeSubdivision (double leftPoint, double midPoint,
double rightPoint, double alpha) - Does the edge need to be subdivided according to
the distance between the line passing through its endpoints and the mid point? The edge is defined by
its leftPoint and its rightPoint. leftPoint, midPoint and rightPoint have to be initialized before calling
RequiresEdgeSubdivision(). Their format is global coordinates, parametric coordinates and point centered
attributes: xyx rst abc de... alpha is the normalized abscissa of the midpoint along the edge. (close to 0
means close to the left point, close to 1 means close to the right point)
32.84 vtkGraph
863
Precondition
leftPoint_exists: leftPoint!=0
midPoint_exists: midPoint!=0
rightPoint_exists: rightPoint!=0
clamped_alpha: alpha>0 && alpha<1
valid_size: sizeof(leftPoint)=sizeof(midPoint)=sizeof(rightPoint) =GetAttributeCollection()->GetNumberOfPointCenteredComponents()+6
double = obj.GetError (double leftPoint, double midPoint, double rightPoint, double alpha) - Return the error at the mid-point. It will return an error relative to the
bounding box size if GetRelative() is true, a square absolute error otherwise. See RequiresEdgeSubdivision()
for a description of the arguments.
Precondition
leftPoint_exists: leftPoint!=0
midPoint_exists: midPoint!=0
rightPoint_exists: rightPoint!=0
clamped_alpha: alpha>0 && alpha<1
valid_size: sizeof(leftPoint)=sizeof(midPoint)=sizeof(rightPoint) =GetAttributeCollection()->GetNumberOfPointCenteredComponents()+6
Postcondition
positive_result: result>=0
int = obj.GetRelative () - Return the type of output of GetError()
32.84
vtkGraph
32.84.1
Usage
vtkGraph is the abstract base class that provides all read-only API for graph data types. A graph consists of
a collection of vertices and a collection of edges connecting pairs of vertices. The vtkDirectedGraph subclass
represents a graph whose edges have inherent order from source vertex to target vertex, while vtkUndirectedGraph
is a graph whose edges have no inherent ordering.
Graph vertices may be traversed in two ways. In the current implementation, all vertices are assigned consecutive
ids starting at zero, so they may be traversed in a simple for loop from 0 to graph->GetNumberOfVertices() - 1. You
may alternately create a vtkVertexListIterator and call graph->GetVertices(it). it->Next() will return the id of the next
vertex, while it->HasNext() indicates whether there are more vertices in the graph. This is the preferred method,
since in the future graphs may support filtering or subsetting where the vertex ids may not be contiguous.
Graph edges must be traversed through iterators. To traverse all edges in a graph, create an instance of vtkEdgeListIterator and call graph->GetEdges(it). it->Next() returns lightweight vtkEdgeType structures, which contain the
public fields Id, Source and Target. Id is the identifier for the edge, which may be used to look up values in assiciated
edge data arrays. Source and Target store the ids of the source and target vertices of the edge. Note that the edge
list iterator DOES NOT necessarily iterate over edges in order of ascending id. To traverse edges from wrapper
code (Python, Tcl, Java), use it->NextGraphEdge() instead of it->Next(). This will return a heavyweight, wrappable
vtkGraphEdge object, which has the same fields as vtkEdgeType accessible through getter methods.
To traverse all edges outgoing from a vertex, create a vtkOutEdgeIterator and call graph->GetOutEdges(v, it). it>Next() returns a lightweight vtkOutEdgeType containing the fields Id and Target. The source of the edge is always
the vertex that was passed as an argument to GetOutEdges(). Incoming edges may be similarly traversed with
vtkInEdgeIterator, which returns vtkInEdgeType structures with Id and Source fields. Both vtkOutEdgeIterator and
vtkInEdgeIterator also provide the wrapper functions NextGraphEdge() which return vtkGraphEdge objects.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
864
An additional iterator, vtkAdjacentVertexIterator can traverse outgoing vertices directly, instead needing to parse
through edges. Initialize the iterator by calling graph->GetAdjacentVertices(v, it).
vtkGraph has two instances of vtkDataSetAttributes for associated vertex and edge data. It also has a vtkPoints
instance which may store x,y,z locations for each vertex. This is populated by filters such as vtkGraphLayout and
vtkAssignCoordinates.
All graph types share the same implementation, so the structure of one may be shared among multiple graphs,
even graphs of different types. Structures from vtkUndirectedGraph and vtkMutableUndirectedGraph may be shared
directly. Structures from vtkDirectedGraph, vtkMutableDirectedGraph, and vtkTree may be shared directly with the
exception that setting a structure to a tree requires that a "is a tree" test passes.
For graph types that are known to be compatible, calling ShallowCopy() or DeepCopy() will work as expected. When
the outcome of a conversion is unknown (i.e. setting a graph to a tree), CheckedShallowCopy() and CheckedDeepCopy() exist which are identical to ShallowCopy() and DeepCopy(), except that instead of emitting an error for an
incompatible structure, the function returns false. This allows you to programmatically check structure compatibility
without causing error messages.
To construct a graph, use vtkMutableDirectedGraph or vtkMutableUndirectedGraph. You may then use CheckedShallowCopy to set the contents of a mutable graph type into one of the non-mutable types vtkDirectedGraph,
vtkUndirectedGraph. To construct a tree, use vtkMutableDirectedGraph, with directed edges which point from the
parent to the child, then use CheckedShallowCopy to set the structure to a vtkTree.
To create an instance of class vtkGraph, simply invoke its constructor as follows
obj = vtkGraph
32.84.2
Methods
The class vtkGraph has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkGraph class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGraph = obj.NewInstance ()
vtkGraph = obj.SafeDownCast (vtkObject o)
vtkDataSetAttributes = obj.GetVertexData () - Get the vertex or edge data.
vtkDataSetAttributes = obj.GetEdgeData () - Get the vertex or edge data.
int = obj.GetDataObjectType () - Initialize to an empty graph.
obj.Initialize () - Initialize to an empty graph.
obj.GetPoint (vtkIdType ptId, double x[3]) - These methods return the point (0,0,0) until
the points structure is created, when it returns the actual point position. In a distributed graph, only the points
for local vertices can be retrieved.
vtkPoints = obj.GetPoints () - Returns the points array for this graph. If points is not yet constructed, generates and returns a new points array filled with (0,0,0) coordinates. In a distributed graph, only
the points for local vertices can be retrieved or modified.
obj.SetPoints (vtkPoints points) - Returns the points array for this graph. If points is not yet
constructed, generates and returns a new points array filled with (0,0,0) coordinates. In a distributed graph,
only the points for local vertices can be retrieved or modified.
obj.ComputeBounds () - Compute the bounds of the graph. In a distributed graph, this computes the
bounds around the local part of the graph.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.84 vtkGraph
865
obj.GetBounds (double bounds[6]) - Return a pointer to the geometry bounding box in the form
(xmin,xmax, ymin,ymax, zmin,zmax). In a distributed graph, this computes the bounds around the local part
of the graph.
long = obj.GetMTime () - The modified time of the graph.
obj.GetOutEdges (vtkIdType v, vtkOutEdgeIterator it) - Initializes the out edge iterator to iterate over all outgoing edges of vertex v. For an undirected graph, returns all incident edges. In a
distributed graph, the vertex v must be local to this processor.
vtkIdType = obj.GetDegree (vtkIdType v) - The total of all incoming and outgoing vertices
for vertex v. For undirected graphs, this is simply the number of edges incident to v. In a distributed graph,
the vertex v must be local to this processor.
vtkIdType = obj.GetOutDegree (vtkIdType v) - The number of outgoing edges from vertex
v. For undirected graphs, returns the same as GetDegree(). In a distributed graph, the vertex v must be local
to this processor.
obj.GetOutEdge (vtkIdType v, vtkIdType index, vtkGraphEdge e) - Randomaccess method for retrieving outgoing edges from vertex v. The method fills the vtkGraphEdge instance
with the id, source, and target of the edge. This method is provided for wrappers, GetOutEdge(vtkIdType,
vtkIdType) is preferred.
obj.GetInEdges (vtkIdType v, vtkInEdgeIterator it) - Initializes the in edge iterator to
iterate over all incoming edges to vertex v. For an undirected graph, returns all incident edges. In a distributed
graph, the vertex v must be local to this processor.
vtkIdType = obj.GetInDegree (vtkIdType v) - The number of incoming edges to vertex v.
For undirected graphs, returns the same as GetDegree(). In a distributed graph, the vertex v must be local to
this processor.
obj.GetInEdge (vtkIdType v, vtkIdType index, vtkGraphEdge e)
Randomaccess method for retrieving incoming edges to vertex v. The method fills the vtkGraphEdge instance
with the id, source, and target of the edge. This method is provided for wrappers, GetInEdge(vtkIdType,
vtkIdType) is preferred.
obj.GetAdjacentVertices (vtkIdType v, vtkAdjacentVertexIterator it) - Initializes the adjacent vertex iterator to iterate over all outgoing vertices from vertex v. For an undirected graph,
returns all adjacent vertices. In a distributed graph, the vertex v must be local to this processor.
obj.GetEdges (vtkEdgeListIterator it) - Initializes the edge list iterator to iterate over all
edges in the graph. Edges may not be traversed in order of increasing edge id. In a distributed graph, this
returns edges that are stored locally.
vtkIdType = obj.GetNumberOfEdges () - The number of edges in the graph. In a distributed
graph, this returns the number of edges stored locally.
obj.GetVertices (vtkVertexListIterator it) - Initializes the vertex list iterator to iterate
over all vertices in the graph. In a distributed graph, the iterator traverses all local vertices.
vtkIdType = obj.GetNumberOfVertices () - The number of vertices in the graph. In a distributed graph, returns the number of local vertices in the graph.
obj.SetDistributedGraphHelper (vtkDistributedGraphHelper helper) - Sets the
distributed graph helper of this graph, turning it into a distributed graph. This operation can only be executed on an empty graph.
vtkDistributedGraphHelper = obj.GetDistributedGraphHelper () - Retrieves the
distributed graph helper for this graph
obj.ShallowCopy (vtkDataObject obj) - Shallow copies the data object into this graph. If it is
an incompatible graph, reports an error.
obj.DeepCopy (vtkDataObject obj) - Deep copies the data object into this graph. If it is an
incompatible graph, reports an error.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
866
32.85 vtkGraphAlgorithm
867
32.85
vtkGraphAlgorithm
32.85.1
Usage
vtkGraphAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition
old algorithms to the new pipeline architecture. There are some assumptions and defaults made by this class you
should be aware of. This class defaults such that your filter will have one input port and one output port. If that is
not the case simply change it with SetNumberOfInputPorts etc. See this class constructor for the default. This class
also provides a FillInputPortInfo method that by default says that all inputs will be Graph. If that isnt the case then
please override this method in your subclass. This class breaks out the downstream requests into separate functions
such as ExecuteData and ExecuteInformation. For new algorithms you should implement RequestData( request,
inputVec, outputVec) but for older filters there is a default implementation that calls the old ExecuteData(output)
signature. For even older filters that dont implement ExecuteData the default implementation calls the even older
Execute() signature.
.SECTION Thanks Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from Sandia National
Laboratories for their help in developing this class.
To create an instance of class vtkGraphAlgorithm, simply invoke its constructor as follows
obj = vtkGraphAlgorithm
32.85.2
Methods
The class vtkGraphAlgorithm has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGraphAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGraphAlgorithm = obj.NewInstance ()
vtkGraphAlgorithm = obj.SafeDownCast (vtkObject o)
vtkGraph = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkGraph = obj.GetOutput (int index) - Get the output data object for a port on this algorithm.
obj.SetInput (vtkDataObject obj) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
868
32.86
vtkGraphEdge
32.86.1
Usage
A heavy-weight (vtkObject subclass) graph edge object that may be used instead of the vtkEdgeType struct, for use
with wrappers. The edge contains the source and target vertex ids, and the edge id.
To create an instance of class vtkGraphEdge, simply invoke its constructor as follows
obj = vtkGraphEdge
32.86.2
Methods
The class vtkGraphEdge has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkGraphEdge class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGraphEdge = obj.NewInstance ()
vtkGraphEdge = obj.SafeDownCast (vtkObject o)
obj.SetSource (vtkIdType ) - The source of the edge.
vtkIdType = obj.GetSource () - The source of the edge.
obj.SetTarget (vtkIdType ) - The target of the edge.
vtkIdType = obj.GetTarget () - The target of the edge.
obj.SetId (vtkIdType ) - The id of the edge.
vtkIdType = obj.GetId () - The id of the edge.
32.87
vtkGraphInternals
32.87.1
Usage
This is the internal representation of vtkGraph, used only in rare cases where one must modify that representation.
To create an instance of class vtkGraphInternals, simply invoke its constructor as follows
obj = vtkGraphInternals
32.88 vtkHexagonalPrism
32.88
869
vtkHexagonalPrism
32.88.1
Usage
vtkHexagonalPrism is a concrete implementation of vtkCell to represent a linear 3D prism with hexagonal base.
Such prism is defined by the twelve points (0-12) where (0,1,2,3,4,5) is the base of the prism which, using the right
hand rule, forms a hexagon whose normal points is in the direction of the opposite face (6,7,8,9,10,11).
To create an instance of class vtkHexagonalPrism, simply invoke its constructor as follows
obj = vtkHexagonalPrism
32.88.2
Methods
The class vtkHexagonalPrism has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkHexagonalPrism class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHexagonalPrism = obj.NewInstance ()
vtkHexagonalPrism = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int edgeId) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int faceId) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
double derivs)
int = obj.GetParametricCenter (double pcoords[3]) - Return the center of the wedge
in parametric coordinates.
obj.InterpolateFunctions (double pcoords[3], double weights[12]) - Compute
the interpolation functions/derivatives (aka shape functions/derivatives)
obj.InterpolateDerivs (double pcoords[3], double derivs[36]) - Return the ids
of the vertices defining edge/face (edgeId/faceId). Ids are related to the cell, not to the dataset.
32.89
vtkHexahedron
870
32.89.1
Usage
32.89.2
Methods
The class vtkHexahedron has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkHexahedron class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHexahedron = obj.NewInstance ()
vtkHexahedron = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int edgeId) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int faceId) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
obj.InterpolateFunctions (double pcoords[3], double weights[8]) - Compute
the interpolation functions/derivatives (aka shape functions/derivatives)
obj.InterpolateDerivs (double pcoords[3], double derivs[24]) - Return the ids
of the vertices defining edge/face (edgeId/faceId). Ids are related to the cell, not to the dataset.
32.90
vtkHierarchicalBoxDataIterator
32.91 vtkHierarchicalBoxDataSet
32.90.1
871
Usage
32.90.2
Methods
The class vtkHierarchicalBoxDataIterator has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHierarchicalBoxDataIterator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHierarchicalBoxDataIterator = obj.NewInstance ()
vtkHierarchicalBoxDataIterator = obj.SafeDownCast (vtkObject o)
int = obj.GetCurrentLevel () - Returns the level for the current dataset.
int = obj.GetCurrentIndex () - Returns the dataset index for the current data object. Valid only
if the current data is a leaf node i.e. no a composite dataset.
32.91
vtkHierarchicalBoxDataSet
32.91.1
Usage
32.91.2
Methods
The class vtkHierarchicalBoxDataSet has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHierarchicalBoxDataSet
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHierarchicalBoxDataSet = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
872
32.92 vtkHierarchicalBoxDataSetAlgorithm
32.92
873
vtkHierarchicalBoxDataSetAlgorithm
32.92.1
Usage
Algorithms that take any type of data object (including composite dataset) and produce a vtkHierarchicalBoxDataSet
in the output can subclass from this class.
To create an instance of class vtkHierarchicalBoxDataSetAlgorithm, simply invoke its constructor as follows
obj = vtkHierarchicalBoxDataSetAlgorithm
32.92.2
Methods
The class vtkHierarchicalBoxDataSetAlgorithm has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHierarchicalBoxDataSetAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHierarchicalBoxDataSetAlgorithm = obj.NewInstance ()
vtkHierarchicalBoxDataSetAlgorithm = obj.SafeDownCast (vtkObject o)
vtkHierarchicalBoxDataSet = obj.GetOutput () - Get the output data object for a port on
this algorithm.
vtkHierarchicalBoxDataSet = obj.GetOutput (int ) - Get the output data object for a
port on this algorithm.
obj.SetInput (vtkDataObject ) - Set an input of this algorithm. You should not override these
methods because they are not the only way to connect a pipeline. Note that these methods support oldstyle pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection
within a single port.
obj.SetInput (int , vtkDataObject ) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
32.93
vtkHyperOctree
32.93.1
Usage
An hyperoctree is a dataset where each node has either exactly 2 n children or no child at all if the node is a leaf.
n is the dimension of the dataset (1 (binary tree), 2 (quadtree) or 3 (octree) ). The class name comes from the
following paper:
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
874
@ARTICLE{yau-srihari-1983,
author={Mann-May Yau and Sargur N. Srihari},
title={A Hierarchical Data Structure for Multidimensional Digital Images},
journal={Communications of the ACM},
month={July},
year={1983},
volume={26},
number={7},
pages={504--515}
}
Each node is a cell. Attributes are associated with cells, not with points. The geometry is implicitly given by the
size of the root node on each axis and position of the center and the orientation. (TODO: review center position
and orientation). The geometry is then not limited to an hybercube but can have a rectangular shape. Attributes
are associated with leaves. For LOD (Level-Of-Detail) purpose, attributes can be computed on none-leaf nodes by
computing the average values from its children (which can be leaves or not).
By construction, an hyperoctree is efficient in memory usage when the geometry is sparse. The LOD feature allows
to cull quickly part of the dataset.
A couple of filters can be applied on this dataset: contour, outline, geometry.
3D case (octree) for each node, each child index (from 0 to 7) is encoded in the following orientation. It is easy to
access each child as a cell of a grid. Note also that the binary representation is relevant, each bit code a side: bit 0
encodes -x side (0) or +x side (1) bit 1 encodes -y side (0) or +y side (1) bit 2 encodes -z side (0) or +z side (2)
the -z side first
0: -y -x sides
1: -y +x sides
2: +y -x sides
3: +y +x sides
+-+-+
|2|3|
+-+-+
|0|1|
+-+-+
O +z
+y
^
|
+-> +x
+-+-+
|6|7|
+-+-+
|4|5|
+-+-+
O +z
+y
^
|
+-> +x
The cases with fewer dimensions are consistent with the octree case:
Quadtree: in counter-clockwise
0: -y -x edges
1: -y +x edges
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.93 vtkHyperOctree
875
2: +y -x edges
3: +y +x edges
+-+-+
|2|3|
+-+-+
|0|1|
+-+-+
+y
^
|
O+-> +x
Binary tree:
+0+1+
O+-> +x
32.93.2
Methods
The class vtkHyperOctree has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkHyperOctree class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHyperOctree = obj.NewInstance ()
vtkHyperOctree = obj.SafeDownCast (vtkObject o)
int = obj.GetDataObjectType () - Return what type of dataset this is.
obj.CopyStructure (vtkDataSet ds) - Copy the geometric and topological structure of an input
rectilinear grid object.
int = obj.GetDimension () - Return the dimension of the tree (1D:binary tree(2 children), 2D:quadtree(4 children), 3D:octree (8 children))
Postcondition
valid_result: result>=1 && result<=3
obj.SetDimension (int dim) - Set the dimension of the tree with dim. See GetDimension() for
details.
Precondition
valid_dim: dim>=1 && dim<=3
Postcondition
dimension_is_set: GetDimension()==dim
vtkIdType = obj.GetNumberOfCells () - Return the number of cells in the dual grid.
Postcondition
positive_result: result>=0
vtkIdType = obj.GetNumberOfLeaves () - Get the number of leaves in the tree.
vtkIdType = obj.GetNumberOfPoints () - Return the number of points in the dual grid.
876
obj.SetOrigin (double , double , double ) - Set the origin (position of corner (0,0,0) of
the root.
obj.SetOrigin (double a[3]) - Set the origin (position of corner (0,0,0) of the root.
double = obj. GetOrigin () - Set the origin (position of corner (0,0,0) of the root. Return the
origin (position of corner (0,0,0) ) of the root.
vtkHyperOctreeCursor = obj.NewCellCursor () - Create a new cursor: an object that can
traverse the cell of an hyperoctree.
32.93 vtkHyperOctree
877
Postcondition
result_exists: result!=0
obj.SubdivideLeaf (vtkHyperOctreeCursor leaf) - Subdivide node pointed by cursor, only
if its a leaf. At the end, cursor points on the node that used to be leaf.
Precondition
leaf_exists: leaf!=0
is_a_leaf: leaf->CurrentIsLeaf()
obj.CollapseTerminalNode (vtkHyperOctreeCursor node) - Collapse a node for which
all children are leaves. At the end, cursor points on the leaf that used to be a node.
Precondition
node_exists: node!=0
node_is_node: !node->CurrentIsLeaf()
children_are_leaves: node->CurrentIsTerminalNode()
double = obj.GetPoint (vtkIdType ptId) - Get point coordinates with ptId such that: 0 <=
ptId < NumberOfPoints. THIS METHOD IS NOT THREAD SAFE.
obj.GetPoint (vtkIdType id, double x[3]) - Copy point coordinates into user provided array x[3] for specified point id. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE
THREAD AND THE DATASET IS NOT MODIFIED
vtkCell = obj.GetCell (vtkIdType cellId) - Get cell with cellId such that: 0 <= cellId <
NumberOfCells. THIS METHOD IS NOT THREAD SAFE.
obj.GetCell (vtkIdType cellId, vtkGenericCell cell) - Get cell with cellId such that: 0 <= cellId < NumberOfCells. This is a thread-safe alternative to the previous GetCell() method. THIS
METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT
MODIFIED
int = obj.GetCellType (vtkIdType cellId) - Get type of cell with cellId such that: 0 <=
cellId < NumberOfCells. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD
AND THE DATASET IS NOT MODIFIED
obj.GetCellPoints (vtkIdType cellId, vtkIdList ptIds) - Topological inquiry to get
points defining cell. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND
THE DATASET IS NOT MODIFIED
obj.GetPointCells (vtkIdType ptId, vtkIdList cellIds) - Topological inquiry to get
cells using point. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND
THE DATASET IS NOT MODIFIED
obj.GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds) - Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). Note that
the list consists of only cells that use ALL the points provided. THIS METHOD IS THREAD SAFE IF FIRST
CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED
vtkIdType = obj.FindPoint (double x[3])
obj.Initialize () - Restore data object to initial state, THIS METHOD IS NOT THREAD SAFE.
int = obj.GetMaxCellSize () - Convenience method returns largest cell size in dataset. This is
generally used to allocate memory for supporting data structures. This is the number of points of a cell. THIS
METHOD IS THREAD SAFE
obj.ShallowCopy (vtkDataObject src) - Shallow and Deep copy.
obj.DeepCopy (vtkDataObject src) - Shallow and Deep copy.
obj.GetPointsOnFace (vtkHyperOctreeCursor sibling, int face, int level,
vtkHyperOctreePointsGrabber grabber) - Get the points of node sibling on its face face.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
878
32.94 vtkHyperOctreeAlgorithm
879
Precondition
cursor_exists: cursor!=0
cursor_2d: cursor->GetDimension()==2
valid_level: level>=0
valid_edge: edge>=0 && edge<4
vtkDataSetAttributes = obj.GetLeafData () - A generic way to set the leaf data attributes.
This can be either point data for dual or cell data for normal grid.
obj.SetDualGridFlag (int flag) - Switch between returning leaves as cells, or the dual grid.
int = obj.GetDualGridFlag () - Switch between returning leaves as cells, or the dual grid.
long = obj.GetActualMemorySize () - Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than
or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the
return value). THIS METHOD IS THREAD SAFE.
32.94
vtkHyperOctreeAlgorithm
32.94.1
Usage
32.94.2
Methods
The class vtkHyperOctreeAlgorithm has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHyperOctreeAlgorithm
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHyperOctreeAlgorithm = obj.NewInstance ()
vtkHyperOctreeAlgorithm = obj.SafeDownCast (vtkObject o)
vtkHyperOctree = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkHyperOctree = obj.GetOutput (int ) - Get the output data object for a port on this algorithm.
obj.SetOutput (vtkDataObject d) - Get the output data object for a port on this algorithm.
vtkDataObject = obj.GetInput ()
vtkDataObject = obj.GetInput (int port)
vtkHyperOctree = obj.GetHyperOctreeInput (int port)
obj.SetInput (vtkDataObject ) - Set an input of this algorithm.
obj.SetInput (int , vtkDataObject ) - Set an input of this algorithm.
obj.AddInput (vtkDataObject ) - Add an input of this algorithm.
obj.AddInput (int , vtkDataObject ) - Add an input of this algorithm.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
880
32.95
vtkHyperOctreeCursor
32.95.1
Usage
Objects that can traverse hyperoctree nodes. It is an abstract class. Cursors are created by the hyperoctree.
To create an instance of class vtkHyperOctreeCursor, simply invoke its constructor as follows
obj = vtkHyperOctreeCursor
32.95.2
Methods
The class vtkHyperOctreeCursor has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHyperOctreeCursor class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHyperOctreeCursor = obj.NewInstance ()
vtkHyperOctreeCursor = obj.SafeDownCast (vtkObject o)
int = obj.GetLeafId () - Return the index of the current leaf in the data arrays.
Precondition
is_leaf: CurrentIsLeaf()
int = obj.CurrentIsLeaf () - Is the node pointed by the cursor a leaf?
int = obj.CurrentIsRoot () - Is the node pointed by the cursor the root?
int = obj.GetCurrentLevel () - Return the level of the node pointed by the cursor.
Postcondition
positive_result: result>=0
int = obj.GetChildIndex () - Return the child number of the current node relative to its parent.
Precondition
not_root: !CurrentIsRoot().
Postcondition
valid_range: result>=0 && result<GetNumberOfChildren()
int = obj.CurrentIsTerminalNode ()
obj.ToRoot () - Move the cursor the root node.
Precondition
can be root
Postcondition
is_root: CurrentIsRoot()
obj.ToParent () - Move the cursor to the parent of the current node.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.95 vtkHyperOctreeCursor
881
Precondition
not_root: !CurrentIsRoot()
obj.ToChild (int child) - Move the cursor to child child of the current node.
Precondition
not_leaf: !CurrentIsLeaf()
valid_child: child>=0 && child<this->GetNumberOfChildren()
obj.ToSameNode (vtkHyperOctreeCursor other) - Move the cursor to the same node pointed
by other.
Precondition
other_exists: other!=0
same_hyperoctree: this->SameTree(other);
Postcondition
equal: this->IsEqual(other)
int = obj.IsEqual (vtkHyperOctreeCursor other) - Is this equal to other?
Precondition
other_exists: other!=0
same_hyperoctree: this->SameTree(other);
vtkHyperOctreeCursor = obj.Clone () - Create a copy of this.
Postcondition
results_exists:result!=0
same_tree: result->SameTree(this)
int = obj.SameTree (vtkHyperOctreeCursor other) - Are this and other pointing on the
same hyperoctree?
Precondition
other_exists: other!=0
int = obj.GetIndex (int d) - Return the index in dimension d, as if the node was a cell of a
uniform grid of 1<<GetCurrentLevel() cells in each dimension.
Precondition
valid_range: d>=0 && d<GetDimension()
Postcondition
valid_result: result>=0 && result<(1<<GetCurrentLevel())
int = obj.GetNumberOfChildren () - Return the number of children for each node of the tree.
Postcondition
positive_number: result>0
int = obj.GetDimension () - Return the dimension of the tree.
Postcondition
positive_result: result>0
obj.MoveToNode (int indices, int level) - Move to the node described by its indices in
each dimension and at a given level. If there is actually a node or a leaf at this location, Found() returns true.
Otherwise, Found() returns false and the cursor moves to the closest parent of the query. It can be the root in
the worst case.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
882
32.96
vtkImageAlgorithm
32.96.1
Usage
vtkImageAlgorithm is a filter superclass that hides much of the pipeline complexity. It handles breaking the pipeline
execution into smaller extents so that the vtkImageData limits are observed. It also provides support for multithreading. If you dont need any of this functionality, consider using vtkSimpleImageToImageFilter instead. .SECTION See
also vtkSimpleImageToImageFilter
To create an instance of class vtkImageAlgorithm, simply invoke its constructor as follows
obj = vtkImageAlgorithm
32.96.2
Methods
The class vtkImageAlgorithm has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageAlgorithm = obj.NewInstance ()
vtkImageAlgorithm = obj.SafeDownCast (vtkObject o)
vtkImageData = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkImageData = obj.GetOutput (int ) - Get the output data object for a port on this algorithm.
obj.SetOutput (vtkDataObject d) - Get the output data object for a port on this algorithm.
obj.SetInput (vtkDataObject ) - Set an input of this algorithm. You should not override these
methods because they are not the only way to connect a pipeline. Note that these methods support oldstyle pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection
within a single port.
obj.SetInput (int , vtkDataObject ) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
vtkDataObject = obj.GetInput (int port)
vtkDataObject = obj.GetInput ()
vtkImageData = obj.GetImageDataInput (int port)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.97 vtkImageData
883
obj.AddInput (vtkDataObject ) - Add an input of this algorithm. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
obj.AddInput (int , vtkDataObject ) - Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
32.97
vtkImageData
32.97.1
Usage
vtkImageData is a data object that is a concrete implementation of vtkDataSet. vtkImageData represents a geometric structure that is a topological and geometrical regular array of points. Examples include volumes (voxel data)
and pixmaps.
To create an instance of class vtkImageData, simply invoke its constructor as follows
obj = vtkImageData
32.97.2
Methods
The class vtkImageData has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkImageData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageData = obj.NewInstance ()
vtkImageData = obj.SafeDownCast (vtkObject o)
obj.CopyStructure (vtkDataSet ds) - Copy the geometric and topological structure of an input
image data object.
int = obj.GetDataObjectType () - Return what type of dataset this is.
vtkIdType = obj.GetNumberOfCells () - Standard vtkDataSet API methods. See vtkDataSet
for more information.
vtkIdType = obj.GetNumberOfPoints () - Standard vtkDataSet API methods. See vtkDataSet
for more information.
double = obj.GetPoint (vtkIdType ptId) - Standard vtkDataSet API methods. See vtkDataSet for more information.
obj.GetPoint (vtkIdType id, double x[3]) - Standard vtkDataSet API methods. See vtkDataSet for more information.
vtkCell = obj.GetCell (vtkIdType cellId) - Standard vtkDataSet API methods. See vtkDataSet for more information.
obj.GetCell (vtkIdType cellId, vtkGenericCell cell) - Standard vtkDataSet API
methods. See vtkDataSet for more information.
obj.GetCellBounds (vtkIdType cellId, double bounds[6]) - Standard vtkDataSet API
methods. See vtkDataSet for more information.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
884
32.97 vtkImageData
885
obj.SetExtent (int extent[6]) - Set/Get the extent. On each axis, the extent is defined by the index of the first point and the index of the last point. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). The dataset extent does not have to start at (0,0,0). (0,0,0)
is just the extent of the origin. The first point (the one with Id=0) is at extent (Extent[0],Extent[2],Extent[4]). As
for any dataset, a data array on point data starts at Id=0.
obj.SetExtent (int x1, int x2, int y1, int y2, int z1, int z2) - Set/Get the
extent. On each axis, the extent is defined by the index of the first point and the index of the last point.
The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).
The dataset extent does not have to start at (0,0,0). (0,0,0) is just the extent of the origin. The first point (the
one with Id=0) is at extent (Extent[0],Extent[2],Extent[4]). As for any dataset, a data array on point data starts
at Id=0.
int = obj. GetExtent () - Set/Get the extent. On each axis, the extent is defined by the index of
the first point and the index of the last point. The extent should be set before the "Scalars" are set or allocated.
The Extent is stored in the order (X, Y, Z). The dataset extent does not have to start at (0,0,0). (0,0,0) is just
the extent of the origin. The first point (the one with Id=0) is at extent (Extent[0],Extent[2],Extent[4]). As for
any dataset, a data array on point data starts at Id=0.
long = obj.GetEstimatedMemorySize () - Get the estimated size of this data object itself.
Should be called after UpdateInformation() and PropagateUpdateExtent() have both been called. This estimate should be fairly accurate since this is structured data.
double = obj.GetScalarTypeMin () - These returns the minimum and maximum values the
ScalarType can hold without overflowing.
double = obj.GetScalarTypeMax () - These returns the minimum and maximum values the
ScalarType can hold without overflowing.
int = obj.GetScalarSize () - Set the size of the scalar type in bytes.
vtkIdType = obj.GetIncrements () - Different ways to get the increments for moving around the
data. GetIncrements() calls ComputeIncrements() to ensure the increments are up to date.
obj.GetIncrements (vtkIdType inc[3]) - Different ways to get the increments for moving
around the data. GetIncrements() calls ComputeIncrements() to ensure the increments are up to date.
float = obj.GetScalarComponentAsFloat (int x, int y, int z, int component)
- For access to data from tcl
obj.SetScalarComponentFromFloat (int x, int y, int z, int component,
float v) - For access to data from tcl
double = obj.GetScalarComponentAsDouble (int x, int y, int z, int component)
- For access to data from tcl
obj.SetScalarComponentFromDouble (int x, int y, int z, int component,
double v) - For access to data from tcl
obj.AllocateScalars () - Allocate the vtkScalars object associated with this object.
obj.CopyAndCastFrom (vtkImageData inData, int extent[6]) - This method is
passed a input and output region, and executes the filter algorithm to fill the output from the input. It
just executes a switch statement to call the correct function for the regions data types.
obj.CopyAndCastFrom (vtkImageData inData, int x0, int x1, int y0, int
y1, int z0, int z1) - Reallocates and copies to set the Extent to the UpdateExtent. This is
used internally when the exact extent is requested, and the source generated more than the update extent.
obj.Crop () - Reallocates and copies to set the Extent to the UpdateExtent. This is used internally when
the exact extent is requested, and the source generated more than the update extent.
long = obj.GetActualMemorySize () - Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than
or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the
return value). THIS METHOD IS THREAD SAFE.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
886
32.98 vtkImageInPlaceFilter
887
32.98
vtkImageInPlaceFilter
888
32.98.1
Usage
vtkImageInPlaceFilter is a filter super class that operates directly on the input region. The data is copied if the
requested region has different extent than the input region or some other object is referencing the input region.
To create an instance of class vtkImageInPlaceFilter, simply invoke its constructor as follows
obj = vtkImageInPlaceFilter
32.98.2
Methods
The class vtkImageInPlaceFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageInPlaceFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageInPlaceFilter = obj.NewInstance ()
vtkImageInPlaceFilter = obj.SafeDownCast (vtkObject o)
32.99
vtkImageMultipleInputFilter
32.99.1
Usage
vtkImageMultipleInputFilter is a super class for filters that have any number of inputs. Streaming is not available in
this class yet.
To create an instance of class vtkImageMultipleInputFilter, simply invoke its constructor as follows
obj = vtkImageMultipleInputFilter
32.99.2
Methods
The class vtkImageMultipleInputFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageMultipleInputFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageMultipleInputFilter = obj.NewInstance ()
vtkImageMultipleInputFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (int num, vtkImageData input) - Set an Input of this filter.
obj.AddInput (vtkImageData input) - Adds an input to the first null position in the input list.
Expands the list memory if necessary
obj.RemoveInput (vtkImageData input) - Adds an input to the first null position in the input list.
Expands the list memory if necessary
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.100 vtkImageMultipleInputOutputFilter
889
32.100
vtkImageMultipleInputOutputFilter
32.100.1
Usage
vtkImageMultipleInputOutputFilter is a super class for filters that have any number of inputs. Streaming is not
available in this class yet.
To create an instance of class vtkImageMultipleInputOutputFilter, simply invoke its constructor as follows
obj = vtkImageMultipleInputOutputFilter
32.100.2
Methods
The class vtkImageMultipleInputOutputFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageMultipleInputOutputFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageMultipleInputOutputFilter = obj.NewInstance ()
vtkImageMultipleInputOutputFilter = obj.SafeDownCast (vtkObject o)
vtkImageData = obj.GetOutput (int num) - Get one input to this filter.
vtkImageData = obj.GetOutput () - Get one input to this filter.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
890
32.101
vtkImageSource
32.101.1
Usage
vtkImageSource is the superclass for all imaging sources and filters. The method Update(), called by the cache, is
the major interface to the source.
To create an instance of class vtkImageSource, simply invoke its constructor as follows
obj = vtkImageSource
32.101.2
Methods
The class vtkImageSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkImageSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageSource = obj.NewInstance ()
vtkImageSource = obj.SafeDownCast (vtkObject o)
obj.SetOutput (vtkImageData output) - Get the output of this source.
vtkImageData = obj.GetOutput () - Get the output of this source.
vtkImageData = obj.GetOutput (int idx) - Get the output of this source.
32.102
vtkImageToImageFilter
32.102.1
Usage
vtkImageToImageFilter is a filter superclass that hides much of the pipeline complexity. It handles breaking the
pipeline execution into smaller extents so that the vtkImageData limits are observed. It also provides support for
multithreading. If you dont need any of this functionality, consider using vtkSimpleImageToImageFilter instead.
.SECTION Warning This used to be the parent class for most imaging filter in VTK4.x, now this role has been
replaced by vtkImageAlgorithm. You should consider using vtkImageAlgorithm instead, when writing filter for VTK5
and above. This class was kept to ensure full backward compatibility. .SECTION See also vtkSimpleImageToImageFilter vtkImageSpatialFilter vtkImageAlgorithm
To create an instance of class vtkImageToImageFilter, simply invoke its constructor as follows
obj = vtkImageToImageFilter
32.102.2
Methods
The class vtkImageToImageFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageToImageFilter
class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.103 vtkImageToStructuredPoints
891
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageToImageFilter = obj.NewInstance ()
vtkImageToImageFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkImageData input) - Set the Input of a filter.
vtkImageData = obj.GetInput () - Set the Input of a filter.
obj.SetBypass (int ) - Obsolete feature - do not use.
obj.BypassOn () - Obsolete feature - do not use.
obj.BypassOff () - Obsolete feature - do not use.
int = obj.GetBypass () - Obsolete feature - do not use.
obj.ThreadedExecute (vtkImageData inData, vtkImageData outData, int
extent[6], int threadId) - If the subclass does not define an Execute method, then the task
will be broken up, multiple threads will be spawned, and each thread will call this method. It is public so that
the thread functions can call this method.
obj.SetNumberOfThreads (int ) - Get/Set the number of threads to create when rendering
int = obj.GetNumberOfThreadsMinValue () - Get/Set the number of threads to create when
rendering
int = obj.GetNumberOfThreadsMaxValue () - Get/Set the number of threads to create when
rendering
int = obj.GetNumberOfThreads () - Get/Set the number of threads to create when rendering
obj.SetInputMemoryLimit (int )
long = obj.GetInputMemoryLimit ()
int = obj.SplitExtent (int splitExt[6], int startExt[6], int num, int
total) - Putting this here until I merge graphics and imaging streaming.
32.103
vtkImageToStructuredPoints
32.103.1
Usage
vtkImageToStructuredPoints changes an image cache format to a structured points dataset. It takes an Input plus
an optional VectorInput. The VectorInput converts the RGB scalar components of the VectorInput to vector pointdata
attributes. This filter will try to reference count the data but in some cases it must make a copy.
To create an instance of class vtkImageToStructuredPoints, simply invoke its constructor as follows
obj = vtkImageToStructuredPoints
892
32.103.2
Methods
The class vtkImageToStructuredPoints has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageToStructuredPoints
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageToStructuredPoints = obj.NewInstance ()
vtkImageToStructuredPoints = obj.SafeDownCast (vtkObject o)
obj.SetVectorInput (vtkImageData input) - Set/Get the input object from the image pipeline.
vtkImageData = obj.GetVectorInput () - Set/Get the input object from the image pipeline.
vtkStructuredPoints = obj.GetStructuredPointsOutput () - Get the output of the filter.
32.104
vtkImageTwoInputFilter
32.104.1
Usage
vtkImageTwoInputFilter handles two inputs. It is just a subclass of vtkImageMultipleInputFilter with some methods
that are specific to two inputs. Although the inputs are labeled input1 and input2, they are stored in an array indexed
starting at 0.
To create an instance of class vtkImageTwoInputFilter, simply invoke its constructor as follows
obj = vtkImageTwoInputFilter
32.104.2
Methods
The class vtkImageTwoInputFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageTwoInputFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageTwoInputFilter = obj.NewInstance ()
vtkImageTwoInputFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput1 (vtkImageData input) - Set the Input1 of this filter. If a ScalarType has not been
set, then the ScalarType of the input is used.
obj.SetInput2 (vtkImageData input) - Set the Input2 of this filter. If a ScalarType has not been
set, then the ScalarType of the input is used.
vtkImageData = obj.GetInput1 () - Get the inputs to this filter.
vtkImageData = obj.GetInput2 () - Get the inputs to this filter.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.105 vtkImplicitBoolean
32.105
893
vtkImplicitBoolean
32.105.1
Usage
vtkImplicitBoolean is an implicit function consisting of boolean combinations of implicit functions. The class has a list
of functions (FunctionList) that are combined according to a specified operator (VTK_UNION or VTK_INTERSECTION or VTK_DIFFERENCE). You can use nested combinations of vtkImplicitFunctions (and/or vtkImplicitBoolean)
to create elaborate implicit functions. vtkImplicitBoolean is a concrete implementation of vtkImplicitFunction.
The operators work as follows. The VTK_UNION operator takes the minimum value of all implicit functions. The VTK_INTERSECTION operator takes the maximum value of all implicit functions. The VTK_DIFFERENCE operator
subtracts the 2nd through last implicit functions from the first. The VTK_UNION_OF_MAGNITUDES takes the
minimum absolute value of the implicit functions.
To create an instance of class vtkImplicitBoolean, simply invoke its constructor as follows
obj = vtkImplicitBoolean
32.105.2
Methods
The class vtkImplicitBoolean has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImplicitBoolean class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImplicitBoolean = obj.NewInstance ()
vtkImplicitBoolean = obj.SafeDownCast (vtkObject o)
double = obj.EvaluateFunction (double x[3]) - Evaluate boolean combinations of implicit
function using current operator.
double = obj.EvaluateFunction (double x, double y, double z)
boolean combinations of implicit function using current operator.
Evaluate
894
32.106
vtkImplicitDataSet
32.106.1
Usage
vtkImplicitDataSet treats any type of dataset as if it were an implicit function. This means it computes a function
value and gradient. vtkImplicitDataSet is a concrete implementation of vtkImplicitFunction.
vtkImplicitDataSet computes the function (at the point x) by performing cell interpolation. That is, it finds the cell
containing x, and then uses the cells interpolation functions to compute an interpolated scalar value at x. (A similar
approach is used to find the gradient, if requested.) Points outside of the dataset are assigned the value of the ivar
OutValue, and the gradient value OutGradient.
To create an instance of class vtkImplicitDataSet, simply invoke its constructor as follows
obj = vtkImplicitDataSet
32.106.2
Methods
The class vtkImplicitDataSet has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImplicitDataSet class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImplicitDataSet = obj.NewInstance ()
vtkImplicitDataSet = obj.SafeDownCast (vtkObject o)
long = obj.GetMTime () - Return the MTime also considering the DataSet dependency.
double = obj.EvaluateFunction (double x[3])
double = obj.EvaluateFunction (double x, double y, double z)
obj.EvaluateGradient (double x[3], double n[3])
obj.SetDataSet (vtkDataSet ) - Set / get the dataset used for the implicit function evaluation.
vtkDataSet = obj.GetDataSet () - Set / get the dataset used for the implicit function evaluation.
obj.SetOutValue (double ) - Set / get the function value to use for points outside of the dataset.
double = obj.GetOutValue () - Set / get the function value to use for points outside of the dataset.
obj.SetOutGradient (double , double , double ) - Set / get the function gradient to use
for points outside of the dataset.
obj.SetOutGradient (double a[3]) - Set / get the function gradient to use for points outside of
the dataset.
double = obj.
the dataset.
GetOutGradient () - Set / get the function gradient to use for points outside of
32.107 vtkImplicitHalo
32.107
895
vtkImplicitHalo
32.107.1
Usage
vtkImplicitHalo evaluates to 1.0 for each position in the sphere of a given center and radius Radius(1-FadeOut).
It evaluates to 0.0 for each position out the sphere of a given Center and radius Radius. It fades out linearly from
1.0 to 0.0 for points in a radius from Radius(1-FadeOut) to Radius. vtkImplicitHalo is a concrete implementation of
vtkImplicitFunction. It is useful as an input to vtkSampleFunction to generate an 2D image of an halo. It is used this
way by vtkShadowMapPass.
To create an instance of class vtkImplicitHalo, simply invoke its constructor as follows
obj = vtkImplicitHalo
32.107.2
Methods
The class vtkImplicitHalo has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkImplicitHalo class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImplicitHalo = obj.NewInstance ()
vtkImplicitHalo = obj.SafeDownCast (vtkObject o)
double = obj.EvaluateFunction (double x[3])
double = obj.EvaluateFunction (double x, double y, double z)
obj.EvaluateGradient (double x[3], double g[3])
obj.SetRadius (double ) - Radius of the sphere.
double = obj.GetRadius () - Radius of the sphere.
obj.SetCenter (double , double , double ) - Center of the sphere.
obj.SetCenter (double a[3]) - Center of the sphere.
double = obj.
obj.SetFadeOut (double ) - FadeOut ratio. Valid values are between 0.0 and 1.0.
double = obj.GetFadeOut () - FadeOut ratio. Valid values are between 0.0 and 1.0.
32.108
vtkImplicitSelectionLoop
896
32.108.1
Usage
vtkImplicitSelectionLoop computes the implicit function value and function gradient for a irregular, cylinder-like object
whose cross section is defined by a set of points forming a loop. The loop need not be convex nor its points coplanar.
However, the loop must be non-self-intersecting when projected onto the plane defined by the accumulated cross
product around the loop (i.e., the axis of the loop). (Alternatively, you can specify the normal to use.)
The following procedure is used to compute the implicit function value for a point x. Each point of the loop is first
projected onto the plane defined by the loop normal. This forms a polygon. Then, to evaluate the implicit function
value, inside/outside tests are used to determine if x is inside the polygon, and the distance to the loop boundary is
computed (negative values are inside the loop).
One example application of this implicit function class is to draw a loop on the surface of a mesh, and use the loop
to clip or extract cells from within the loop. Remember, the selection loop is "infinite" in length, you can use a plane
(in boolean combination) to cap the extent of the selection loop. Another trick is to use a connectivity filter to extract
the closest region to a given point (i.e., one of the points used to define the selection loop).
To create an instance of class vtkImplicitSelectionLoop, simply invoke its constructor as follows
obj = vtkImplicitSelectionLoop
32.108.2
Methods
The class vtkImplicitSelectionLoop has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImplicitSelectionLoop
class.
string = obj.GetClassName () - Standard VTK methods for printing and type information.
int = obj.IsA (string name) - Standard VTK methods for printing and type information.
vtkImplicitSelectionLoop = obj.NewInstance () - Standard VTK methods for printing and
type information.
vtkImplicitSelectionLoop = obj.SafeDownCast (vtkObject o) - Standard VTK methods for printing and type information.
double = obj.EvaluateFunction (double x[3]) - Evaluate selection loop returning a signed
distance.
double = obj.EvaluateFunction (double x, double y, double z) - Evaluate selection loop returning a signed distance.
obj.EvaluateGradient (double x[3], double n[3]) - Evaluate selection loop returning
the gradient.
obj.SetLoop (vtkPoints ) - Set/Get the array of point coordinates defining the loop. There must be
at least three points used to define a loop.
vtkPoints = obj.GetLoop () - Set/Get the array of point coordinates defining the loop. There must
be at least three points used to define a loop.
obj.SetAutomaticNormalGeneration (int ) - Turn on/off automatic normal generation. By
default, the normal is computed from the accumulated cross product of the edges. You can also specify the
normal to use.
int = obj.GetAutomaticNormalGeneration () - Turn on/off automatic normal generation. By
default, the normal is computed from the accumulated cross product of the edges. You can also specify the
normal to use.
obj.AutomaticNormalGenerationOn () - Turn on/off automatic normal generation. By default,
the normal is computed from the accumulated cross product of the edges. You can also specify the normal
to use.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.109 vtkImplicitSum
897
32.109
vtkImplicitSum
32.109.1
Usage
vtkImplicitSum produces a linear combination of other implicit functions. The contribution of each function is
weighted by a scalar coefficient. The NormalizeByWeight option normalizes the output so that the scalar weights
add up to 1. Note that this function gives accurate sums and gradients only if the input functions are linear.
To create an instance of class vtkImplicitSum, simply invoke its constructor as follows
obj = vtkImplicitSum
32.109.2
Methods
The class vtkImplicitSum has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkImplicitSum class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImplicitSum = obj.NewInstance ()
vtkImplicitSum = obj.SafeDownCast (vtkObject o)
double = obj.EvaluateFunction (double x[3]) - Evaluate implicit function using current
functions and weights.
double = obj.EvaluateFunction (double x, double y, double z) - Evaluate implicit function using current functions and weights.
obj.EvaluateGradient (double x[3], double g[3]) - Evaluate gradient of the weighted
sum of functions. Input functions should be linear.
long = obj.GetMTime () - Override modified time retrieval because of object dependencies.
obj.AddFunction (vtkImplicitFunction in, double weight) - Add another implicit
function to the list of functions, along with a weighting factor.
obj.AddFunction (vtkImplicitFunction in) - Remove all functions from the list.
obj.RemoveAllFunctions () - Remove all functions from the list.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
898
32.110
vtkImplicitVolume
32.110.1
Usage
vtkImplicitVolume treats a volume (e.g., structured point dataset) as if it were an implicit function. This means it
computes a function value and gradient. vtkImplicitVolume is a concrete implementation of vtkImplicitFunction.
vtkImplicitDataSet computes the function (at the point x) by performing cell interpolation. That is, it finds the cell
containing x, and then uses the cells interpolation functions to compute an interpolated scalar value at x. (A similar
approach is used to find the gradient, if requested.) Points outside of the dataset are assigned the value of the ivar
OutValue, and the gradient value OutGradient.
To create an instance of class vtkImplicitVolume, simply invoke its constructor as follows
obj = vtkImplicitVolume
32.110.2
Methods
The class vtkImplicitVolume has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImplicitVolume class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImplicitVolume = obj.NewInstance ()
vtkImplicitVolume = obj.SafeDownCast (vtkObject o)
long = obj.GetMTime () - Returns the mtime also considering the volume. This also calls Update
on the volume, and it therefore must be called before the function is evaluated.
double = obj.EvaluateFunction (double x[3])
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.111 vtkImplicitWindowFunction
899
32.111
GetOutGradient () - Set the function gradient to use for points outside of the
vtkImplicitWindowFunction
32.111.1
Usage
vtkImplicitWindowFunction is used to modify the output of another implicit function to lie within a specified "window",
or function range. This can be used to add "thickness" to cutting or clipping functions.
This class works as follows. First, it evaluates the function value of the user-specified implicit function. Then, based
on the window range specified, it maps the function value into the window values specified.
To create an instance of class vtkImplicitWindowFunction, simply invoke its constructor as follows
obj = vtkImplicitWindowFunction
32.111.2
Methods
The class vtkImplicitWindowFunction has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImplicitWindowFunction
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImplicitWindowFunction = obj.NewInstance ()
vtkImplicitWindowFunction = obj.SafeDownCast (vtkObject o)
double = obj.EvaluateFunction (double x[3])
double = obj.EvaluateFunction (double x, double y, double z)
obj.EvaluateGradient (double x[3], double n[3])
obj.SetImplicitFunction (vtkImplicitFunction ) - Specify an implicit function to operate
on.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
900
32.112
vtkIncrementalOctreeNode
32.112.1
Usage
Octree nodes serve as spatial sub-division primitives to build the search structure of an incremental octree in
a recursive top-down manner. The hierarchy takes the form of a tree-like representation by which a parent node
contains eight mutually non-overlapping child nodes. Each child is assigned with an axis-aligned rectangular volume
(Spatial Bounding Box) and the eight children together cover exactly the same region as governed by their parent.
The eight child nodes / octants are ordered as
{ (xBBoxMin, xBBoxMid] & (yBBoxMin, yBBoxMid] & (zBBoxMin, zBBoxMid] }, { (xBBoxMid, xBBoxMax] & (yBBoxMin, yBBoxMid] & (zBBoxMin, zBBoxMid] }, { (xBBoxMin, xBBoxMid] & (yBBoxMid, yBBoxMax] & (zBBoxMin,
zBBoxMid] }, { (xBBoxMid, xBBoxMax] & (yBBoxMid, yBBoxMax] & (zBBoxMin, zBBoxMid] }, { (xBBoxMin, xBBoxMid] & (yBBoxMin, yBBoxMid] & (zBBoxMid, zBBoxMax] }, { (xBBoxMid, xBBoxMax] & (yBBoxMin, yBBoxMid] &
(zBBoxMid, zBBoxMax] }, { (xBBoxMin, xBBoxMid] & (yBBoxMid, yBBoxMax] & (zBBoxMid, zBBoxMax] }, { (xBBoxMid, xBBoxMax] & (yBBoxMid, yBBoxMax] & (zBBoxMid, zBBoxMax] },
where { xrange & yRange & zRange } defines the region of each 3D octant. In addition, the points falling within
and registered, by means of point indices, in the parent node are distributed to the child nodes for delegated
maintenance. In fact, only leaf nodes, i.e., those without any descendants, actually store point indices while each
node, regardless of a leaf or non- leaf node, keeps a dynamically updated Data Bounding Box of the inhabitant
points, if any. Given a maximum number of points per leaf node, an octree is initialized with an empty leaf node that
is then recursively sub-divided, but only on demand as points are incrementally inserted, to construct a populated
tree.
Please note that this octree node class is able to handle a large number of EXACTLY duplicate points that is
greater than the specified maximum number of points per leaf node. In other words, as an exception, a leaf node
may maintain an arbitrary number of exactly duplicate points to deal with possible extreme cases.
To create an instance of class vtkIncrementalOctreeNode, simply invoke its constructor as follows
obj = vtkIncrementalOctreeNode
32.112 vtkIncrementalOctreeNode
32.112.2
901
Methods
The class vtkIncrementalOctreeNode has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkIncrementalOctreeNode
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkIncrementalOctreeNode = obj.NewInstance ()
vtkIncrementalOctreeNode = obj.SafeDownCast (vtkObject o)
int = obj.GetNumberOfPoints () - Get the number of points inside or under this node.
vtkIdList = obj.GetPointIdSet () - Get the list of point indices, NULL for a non-leaf node.
obj.DeleteChildNodes () - Delete the eight child nodes.
obj.SetBounds (double x1, double x2, double y1, double y2, double z1,
double z2) - Set the spatial bounding box of the node. This function sets a default data bounding
box.
obj.GetBounds (double bounds[6]) const - Get the spatial bounding box of the node. The
values are returned via an array in order of: x_min, x_max, y_min, y_max, z_min, z_max.
double = obj.
double = obj.
int = obj.IsLeaf () - Determine which specific child / octant contains a given point. Note that the
point is assumed to be inside this node and no checking is performed on the inside issue.
int = obj.GetChildIndex (double point[3]) - Determine which specific child / octant contains a given point. Note that the point is assumed to be inside this node and no checking is performed on
the inside issue.
vtkIncrementalOctreeNode = obj.GetChild (int i) - A point is in a node if and only if
MinBounds[i] < p[i] <= MaxBounds[i], which allows a node to be divided into eight non-overlapping children.
int = obj.ContainsPoint (double pnt[3]) - A point is in a node if and only if MinBounds[i]
< p[i] <= MaxBounds[i], which allows a node to be divided into eight non-overlapping children.
int = obj.ContainsPointByData (double pnt[3]) - A point is in a node, in terms of data, if
and only if MinDataBounds[i] <= p[i] <= MaxDataBounds[i].
double = obj.GetDistance2ToInnerBoundary (double point[3], vtkIncrementalOctreeNode rootNode) - Given a point inside this node, get the minimum squared distance to all inner
boundaries. An inner boundary is a nodes face that is shared by another non-root node.
double = obj.GetDistance2ToBoundary (double point[3], vtkIncrementalOctreeNode rootNode, int checkData) - Compute the minimum squared distance from a
point to this node, with all six boundaries considered. The data bounding box is checked if checkData is
non-zero.
double = obj.GetDistance2ToBoundary (double point[3], double closest[3],
vtkIncrementalOctreeNode rootNode, int checkData) - Compute the minimum squared
distance from a point to this node, with all six boundaries considered. The data bounding box is checked if
checkData is non-zero. The closest on-boundary point is returned via closest.
obj.ExportAllPointIdsByInsertion (vtkIdList idList) - Export all the indices of the
points (contained in or under this node) by inserting them to an allocated vtkIdList via vtkIdList::InsertNextId().
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
902
32.113
vtkIncrementalOctreePointLocator
32.113.1
Usage
As opposed to the uniform bin-based search structure (adopted in class vtkPointLocator) with a fixed spatial resolution, an octree mechanism employs a hierarchy of tree-like sub-division of the 3D data domain. Thus it enables
data-aware multi-resolution and accordingly accelerated point location as well as insertion, particularly when handling a radically imbalanced layout of points as not uncommon in datasets defined on adaptive meshes. Compared
to a static point locator supporting pure location functionalities through some search structure established from a
fixed set of points, an incremental point locator allows for, in addition, point insertion capabilities, with the search
structure maintaining a dynamically increasing number of points. Class vtkIncrementalOctreePointLocator is an
octree-based accelerated implementation of the functionalities of the uniform bin-based incremental point locator
vtkPointLocator. For point location, an octree is built by accessing a vtkDataSet, specifically a vtkPointSet. For point
insertion, an empty octree is inited and then incrementally populated as points are inserted. Three increasingly
complex point insertion modes, i.e., direct check-free insertion, zero tolerance insertion, and non-zero tolerance
insertion, are supported. In fact, the octree used in the point location mode is actually constructed via direct checkfree point insertion. This class also provides a polygonal representation of the octree boundary.
To create an instance of class vtkIncrementalOctreePointLocator, simply invoke its constructor as follows
obj = vtkIncrementalOctreePointLocator
32.113.2
Methods
The class vtkIncrementalOctreePointLocator has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkIncrementalOctreePointLocator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkIncrementalOctreePointLocator = obj.NewInstance ()
vtkIncrementalOctreePointLocator = obj.SafeDownCast (vtkObject o)
obj.SetMaxPointsPerLeaf (int ) - Set/Get the maximum number of points that a leaf node may
maintain. Note that the actual number of points maintained by a leaf node might exceed this threshold if there
is a large number (equal to or greater than the threshold) of exactly duplicate points (with zero distance) to
be inserted (e.g., to construct an octree for subsequent point location) in extreme cases. Respecting this
threshold in such scenarios would cause endless node sub-division. Thus this threshold is broken, but only
in case of such situations.
int = obj.GetMaxPointsPerLeafMinValue () - Set/Get the maximum number of points that a
leaf node may maintain. Note that the actual number of points maintained by a leaf node might exceed this
threshold if there is a large number (equal to or greater than the threshold) of exactly duplicate points (with
zero distance) to be inserted (e.g., to construct an octree for subsequent point location) in extreme cases.
Respecting this threshold in such scenarios would cause endless node sub-division. Thus this threshold is
broken, but only in case of such situations.
int = obj.GetMaxPointsPerLeafMaxValue () - Set/Get the maximum number of points that a
leaf node may maintain. Note that the actual number of points maintained by a leaf node might exceed this
threshold if there is a large number (equal to or greater than the threshold) of exactly duplicate points (with
zero distance) to be inserted (e.g., to construct an octree for subsequent point location) in extreme cases.
Respecting this threshold in such scenarios would cause endless node sub-division. Thus this threshold is
broken, but only in case of such situations.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.113 vtkIncrementalOctreePointLocator
903
int = obj.GetMaxPointsPerLeaf () - Set/Get the maximum number of points that a leaf node
may maintain. Note that the actual number of points maintained by a leaf node might exceed this threshold if
there is a large number (equal to or greater than the threshold) of exactly duplicate points (with zero distance)
to be inserted (e.g., to construct an octree for subsequent point location) in extreme cases. Respecting this
threshold in such scenarios would cause endless node sub-division. Thus this threshold is broken, but only
in case of such situations.
obj.SetBuildCubicOctree (int ) - Set/Get whether the search octree is built as a cubic shape or
not.
int = obj.GetBuildCubicOctree () - Set/Get whether the search octree is built as a cubic shape
or not.
obj.BuildCubicOctreeOn () - Set/Get whether the search octree is built as a cubic shape or not.
obj.BuildCubicOctreeOff () - Set/Get whether the search octree is built as a cubic shape or not.
vtkPoints = obj.GetLocatorPoints () - Get access to the vtkPoints object in which point coordinates are stored for either point location or point insertion.
obj.Initialize () - Delete the octree search structure.
obj.FreeSearchStructure () - Delete the octree search structure.
obj.GetBounds (double bounds) - Get the spatial bounding box of the octree.
int = obj.GetNumberOfPoints () - Get the number of points maintained by the octree.
vtkIdType = obj.FindClosestInsertedPoint (double x[3]) - Given a point x assumed
to be covered by the octree, return the index of the closest in-octree point regardless of the associated
minimum squared distance relative to the squared insertion-tolerance distance. This method is used when
performing incremental point insertion. Note -1 indicates that no point is found. InitPointInsertion() should
have been called in advance.
obj.GenerateRepresentation (int nodeLevel, vtkPolyData polysData) - Create
a polygonal representation of the octree boundary (from the root node to a specified level).
obj.BuildLocator () - Load points from a dataset to construct an octree for point location. This
function resorts to InitPointInsertion() to fulfill some of the work.
vtkIdType = obj.FindClosestPoint (double x[3]) - Given a point x, return the id of the
closest point. BuildLocator() should have been called prior to this function. This method is thread safe if
BuildLocator() is directly or indirectly called from a single thread first.
vtkIdType = obj.FindClosestPoint (double x, double y, double z) - Given a
point (x, y, z), return the id of the closest point. Note that BuildLocator() should have been called prior to this
function. This method is thread safe if BuildLocator() is directly or indirectly called from a single thread first.
vtkIdType = obj.FindClosestPoint (double x[3], double miniDist2) - Given a
point x, return the id of the closest point and the associated minimum squared distance (via miniDist2).
Note BuildLocator() should have been called prior to this function. This method is thread safe if BuildLocator()
is directly or indirectly called from a single thread first.
vtkIdType = obj.FindClosestPoint (double x, double y, double z, double
miniDist2) - Given a point (x, y, z), return the id of the closest point and the associated minimum squared
distance (via miniDist2). BuildLocator() should have been called prior to this function. This method is thread
safe if BuildLocator() is directly or indirectly called from a single thread first.
obj.FindPointsWithinRadius (double R, double x[3], vtkIdList result)
Find all points within a radius R relative to a given point x. The returned point ids (stored in result) are
not sorted in any way. BuildLocator() should have been called prior to this function. This method is thread
safe if BuildLocator() is directly or indirectly called from a single thread first.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
904
32.114
vtkIncrementalPointLocator
32.114.1
Usage
Compared to a static point locator for pure location functionalities through some search structure established from
a fixed set of points, an incremental point locator allows for, in addition, point insertion capabilities, with the search
structure maintaining a dynamically increasing number of points. There are two incremental point locators, i.e., vtkPointLocator and vtkIncrementalOctreePointLocator. As opposed to the uniform bin-based search structure
(adopted in vtkPointLocator) with a fixed spatial resolution, an octree mechanism (employed in vtkIncrementalOctreePointlocator) resorts to a hierarchy of tree-like sub-division of the 3D data domain. Thus it enables data-aware
multi- resolution and accordingly accelerated point location as well as point insertion, particularly when handling a
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.115 vtkInEdgeIterator
905
radically imbalanced layout of points as not uncommon in datasets defined on adaptive meshes. In other words,
vtkIncrementalOctreePointLocator is an octree-based accelerated implementation of all functionalities of vtkPointLocator.
To create an instance of class vtkIncrementalPointLocator, simply invoke its constructor as follows
obj = vtkIncrementalPointLocator
32.114.2
Methods
The class vtkIncrementalPointLocator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkIncrementalPointLocator
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkIncrementalPointLocator = obj.NewInstance ()
vtkIncrementalPointLocator = obj.SafeDownCast (vtkObject o)
obj.Initialize () - Delete the search structure.
vtkIdType = obj.FindClosestInsertedPoint (double x[3]) - Given a point x assumed
to be covered by the search structure, return the index of the closest point (already inserted to the search
structure) regardless of the associated minimum squared distance relative to the squared insertion-tolerance
distance. This method is used when performing incremental point insertion. Note -1 indicates that no point is
found. InitPointInsertion() should have been called in advance.
int = obj.InitPointInsertion (vtkPoints newPts, double bounds[6]) - Initialize
the point insertion process. newPts is an object, storing 3D point coordinates, to which incremental point
insertion puts coordinates. It is created and provided by an external VTK class. Argument bounds represents
the spatial bounding box, into which the points fall.
int = obj.InitPointInsertion (vtkPoints newPts, double bounds[6], vtkIdType estSize) - Initialize the point insertion process. newPts is an object, storing 3D point coordinates, to which incremental point insertion puts coordinates. It is created and provided by an external VTK
class. Argument bounds represents the spatial bounding box, into which the points fall.
vtkIdType = obj.IsInsertedPoint (double x, double y, double z) - Determine
whether or not a given point has been inserted. Return the id of the already inserted point if true, else return
-1. InitPointInsertion() should have been called in advance.
vtkIdType = obj.IsInsertedPoint (double x[3]) - Determine whether or not a given point
has been inserted. Return the id of the already inserted point if true, else return -1. InitPointInsertion() should
have been called in advance.
obj.InsertPoint (vtkIdType ptId, double x[3]) - Insert a given point with a specified
point index ptId. InitPointInsertion() should have been called prior to this function. Also, IsInsertedPoint()
should have been called in advance to ensure that the given point has not been inserted unless point duplication is allowed.
vtkIdType = obj.InsertNextPoint (double x[3]) - Insert a given point and return the point
index. InitPointInsertion() should have been called prior to this function. Also, IsInsertedPoint() should have
been called in advance to ensure that the given point has not been inserted unless point duplication is allowed.
32.115
vtkInEdgeIterator
906
32.115.1
Usage
vtkInEdgeIterator iterates through all edges whose target is a particular vertex. Instantiate this class directly and
call Initialize() to traverse the vertex of a graph. Alternately, use GetInEdges() on the graph to initialize the iterator.
it->Next() returns a vtkInEdgeType structure, which contains Id, the edges id, and Source, the edges source vertex.
To create an instance of class vtkInEdgeIterator, simply invoke its constructor as follows
obj = vtkInEdgeIterator
32.115.2
Methods
The class vtkInEdgeIterator has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkInEdgeIterator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInEdgeIterator = obj.NewInstance ()
vtkInEdgeIterator = obj.SafeDownCast (vtkObject o)
obj.Initialize (vtkGraph g, vtkIdType v) - Initialize the iterator with a graph and vertex.
vtkGraph = obj.GetGraph () - Get the graph and vertex associated with this iterator.
vtkIdType = obj.GetVertex () - Get the graph and vertex associated with this iterator.
vtkGraphEdge = obj.NextGraphEdge () - Just like Next(), but returns heavy-weight vtkGraphEdge object instead of the vtkEdgeType struct, for use with wrappers. The graph edge is owned by this
iterator, and changes after each call to NextGraphEdge().
bool = obj.HasNext ()
32.116
vtkInformationExecutivePortKey
32.116.1
Usage
vtkInformationExecutivePortKey is used to represent keys in vtkInformation for values that are vtkExecutive instances paired with port numbers.
To create an instance of class vtkInformationExecutivePortKey, simply invoke its constructor as follows
obj = vtkInformationExecutivePortKey
32.116.2
Methods
The class vtkInformationExecutivePortKey has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationExecutivePortKey class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.117 vtkInformationExecutivePortVectorKey
907
vtkInformationExecutivePortKey = obj.NewInstance ()
vtkInformationExecutivePortKey = obj.SafeDownCast (vtkObject o)
vtkInformationExecutivePortKey = obj.(string name, string location)
vtkInformationExecutivePortKey = obj.()
obj.Set (vtkInformation info, vtkExecutive , int ) - Get/Set the value associated
with this key in the given information object.
vtkExecutive = obj.GetExecutive (vtkInformation info) - Get/Set the value associated with this key in the given information object.
int = obj.GetPort (vtkInformation info) - Get/Set the value associated with this key in the
given information object.
obj.ShallowCopy (vtkInformation from, vtkInformation to) - Copy the entry associated with this key from one information object to another. If there is no entry in the first information object
for this key, the value is removed from the second.
obj.Report (vtkInformation info, vtkGarbageCollector collector) - Report a
reference this key has in the given information object.
32.117
vtkInformationExecutivePortVectorKey
32.117.1
Usage
vtkInformationExecutivePortVectorKey is used to represent keys in vtkInformation for values that are vectors of
vtkExecutive instances paired with port numbers.
To create an instance of class vtkInformationExecutivePortVectorKey, simply invoke its constructor as follows
obj = vtkInformationExecutivePortVectorKey
32.117.2
Methods
The class vtkInformationExecutivePortVectorKey has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInformationExecutivePortVectorKey class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInformationExecutivePortVectorKey = obj.NewInstance ()
vtkInformationExecutivePortVectorKey = obj.SafeDownCast (vtkObject o)
vtkInformationExecutivePortVectorKey = obj.(string name, string location)
vtkInformationExecutivePortVectorKey = obj.()
obj.Append (vtkInformation info, vtkExecutive executive, int port) - Get/Set the value associated with this key in the given information object.
obj.Remove (vtkInformation info, vtkExecutive executive, int port) - Get/Set the value associated with this key in the given information object.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
908
32.118
vtkInterpolatedVelocityField
32.118.1
Usage
vtkInterpolatedVelocityField acts as a continuous velocity field via cell interpolation on a vtkDataSet, NumberOfIndependentVariables = 4 (x,y,z,t) and NumberOfFunctions = 3 (u,v,w). As a concrete sub-class of vtkAbstractInterpolatedVelocityField, this class adopts two levels of cell caching for faster though less robust cell location than
its sibling class vtkCellLocatorInterpolatedVelocityField. Level #0 begins with intra-cell caching. Specifically, if the
previous cell is valid and the nex point is still within it, ( vtkCell::EvaluatePosition() returns 1, coupled with the new
parametric coordinates and weights ), the function values are interpolated and vtkCell::EvaluatePosition() is invoked
only. If it fails, level #1 follows by inter-cell location of the target cell (that contains the next point). By inter-cell, the
previous cell gives an important clue / guess or serves as an immediate neighbor to aid in the location of the target
cell (as is typically the case with integrating a streamline across cells) by means of vtkDataSet:: FindCell(). If this
still fails, a global cell search is invoked via vtkDataSet::FindCell().
Regardless of inter-cell or global search, vtkPointLocator is employed as a crucial tool underlying the cell locator.
The use of vtkPointLocator casues vtkInterpolatedVelocityField to return false target cells for datasets defined on
complex grids.
To create an instance of class vtkInterpolatedVelocityField, simply invoke its constructor as follows
obj = vtkInterpolatedVelocityField
32.118.2
Methods
The class vtkInterpolatedVelocityField has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInterpolatedVelocityField
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInterpolatedVelocityField = obj.NewInstance ()
vtkInterpolatedVelocityField = obj.SafeDownCast (vtkObject o)
obj.AddDataSet (vtkDataSet dataset) - Add a dataset used for the implicit function evaluation.
If more than one dataset is added, the evaluation point is searched in all until a match is found. THIS FUNCTION DOES NOT CHANGE THE REFERENCE COUNT OF DATASET FOR THREAD SAFETY REASONS.
int = obj.FunctionValues (double x, double f) - Evaluate the velocity field f at point (x,
y, z).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.119 vtkKdNode
909
obj.SetLastCellId (vtkIdType c, int dataindex) - Set the cell id cached by the last evaluation within a specified dataset.
obj.SetLastCellId (vtkIdType c)
32.119
vtkKdNode
32.119.1
Usage
32.119.2
Methods
The class vtkKdNode has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkKdNode class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkKdNode = obj.NewInstance ()
vtkKdNode = obj.SafeDownCast (vtkObject o)
obj.SetDim (int ) - Set/Get the dimension along which this region is divided. (0 - x, 1 - y, 2 - z, 3 leaf node (default)).
int = obj.GetDim () - Set/Get the dimension along which this region is divided. (0 - x, 1 - y, 2 - z, 3 leaf node (default)).
double = obj.GetDivisionPosition () - Get the location of the division plane along the axis
the region is divided. See also GetDim(). The result is undertermined if this node is not divided (a leaf node).
obj.SetNumberOfPoints (int ) - Set/Get the number of points contained in this region.
int = obj.GetNumberOfPoints () - Set/Get the number of points contained in this region.
obj.SetBounds (double x1, double x2, double y1, double y2, double z1,
double z2) - Set/Get the bounds of the spatial region represented by this node. Caller allocates
storage for 6-vector in GetBounds.
obj.SetBounds (double b[6]) - Set/Get the bounds of the spatial region represented by this node.
Caller allocates storage for 6-vector in GetBounds.
obj.GetBounds (double b) const - Set/Get the bounds of the spatial region represented by this
node. Caller allocates storage for 6-vector in GetBounds.
obj.SetDataBounds (double x1, double x2, double y1, double y2, double
z1, double z2) - Set/Get the bounds of the points contained in this spatial region. This may be
smaller than the bounds of the region itself. Caller allocates storage for 6-vector in GetDataBounds.
obj.GetDataBounds (double b) const - Set/Get the bounds of the points contained in this spatial region. This may be smaller than the bounds of the region itself. Caller allocates storage for 6-vector in
GetDataBounds.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
910
32.120 vtkKdTree
911
int = obj.IntersectsBox (double x1, double x2, double y1, double y2,
double z1, double z2, int useDataBounds) - Return 1 if this spatial region intersects the
axis-aligned box given by the bounds passed in. Use the possibly smaller bounds of the points within the
region if useDataBounds is non-zero.
int = obj.IntersectsSphere2 (double x, double y, double z, double rSquared, int useDataBounds) - Return 1 if this spatial region intersects a sphere described
by its center and the square of its radius. Use the possibly smaller bounds of the points within the region if
useDataBounds is non-zero.
int = obj.IntersectsRegion (vtkPlanesIntersection pi, int useDataBounds)
- A vtkPlanesIntersection object represents a convex 3D region bounded by planes, and it is capable of computing intersections of boxes with itself. Return 1 if this spatial region intersects the spatial region described
by the vtkPlanesIntersection object. Use the possibly smaller bounds of the points within the region if
useDataBounds is non-zero.
int = obj.IntersectsCell (vtkCell cell, int useDataBounds, int cellRegion, double cellBoundsNULL) - Return 1 if the cell specified intersects this region. If you
already know the ID of the region containing the cells centroid, provide that as an argument. If you already
know the bounds of the cell, provide that as well, in the form of xmin,xmax,ymin,ymax,zmin, zmax. Either
of these may speed the calculation. Use the possibly smaller bounds of the points within the region if
useDataBounds is non-zero.
int = obj.ContainsBox (double x1, double x2, double y1, double y2, double
z1, double z2, int useDataBounds) - Return 1 if this spatial region entirely contains a box specified by its bounds. Use the possibly smaller bounds of the points within the region if useDataBounds is
non-zero.
int = obj.ContainsPoint (double x, double y, double z, int useDataBounds) - Return 1 if this spatial region entirely contains the given point. Use the possibly smaller
bounds of the points within the region if useDataBounds is non-zero.
double = obj.GetDistance2ToBoundary (double x, double y, double z, int
useDataBounds) - Calculate the distance squared from any point to the boundary of this region. Use the
boundary of the points within the region if useDataBounds is non-zero.
double = obj.GetDistance2ToBoundary (double x, double y, double z, double
boundaryPt, int useDataBounds) - Calculate the distance squared from any point to the boundary of this region. Use the boundary of the points within the region if useDataBounds is non-zero. Set
boundaryPt to the point on the boundary.
double = obj.GetDistance2ToInnerBoundary (double x, double y, double z)
- Calculate the distance from the specified point (which is required to be inside this spatial region) to an
interior boundary. An interior boundary is one that is not also an boundary of the entire space partitioned by
the tree of vtkKdNodes.
obj.PrintNode (int depth) - For debugging purposes, print out this node.
obj.PrintVerboseNode (int depth) - For debugging purposes, print out this node.
32.120
vtkKdTree
32.120.1
Usage
Given one or more vtkDataSets, create a load balancing k-d tree decomposition of the points at the center of the
cells. Or, create a k-d tree point locator from a list of points.
This class can also generate a PolyData representation of the boundaries of the spatial regions in the decomposition.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
912
It can sort the regions with respect to a viewing direction, and it can decompose a list of regions into subsets, each
of which represent a convex spatial region (since many algorithms require a convex region).
If the points were derived from cells, vtkKdTree can create a list of cell Ids for each region for each data set. Two
lists are available - all cells with centroid in the region, and all cells that intersect the region but whose centroid lies
in another region.
For the purpose of removing duplicate points quickly from large data sets, or for finding nearby points, we added
another mode for building the locator. BuildLocatorFromPoints will build a k-d tree from one or more vtkPoints
objects. This can be followed by BuildMapForDuplicatePoints which returns a mapping from the original ids to a
subset of the ids that is unique within a supplied tolerance, or you can use FindPoint and FindClosestPoint to locate
points in the original set that the tree was built from.
To create an instance of class vtkKdTree, simply invoke its constructor as follows
obj = vtkKdTree
32.120.2
Methods
The class vtkKdTree has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkKdTree class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkKdTree = obj.NewInstance ()
vtkKdTree = obj.SafeDownCast (vtkObject o)
obj.TimingOn () - Turn on timing of the k-d tree build
obj.TimingOff () - Turn on timing of the k-d tree build
obj.SetTiming (int ) - Turn on timing of the k-d tree build
int = obj.GetTiming () - Turn on timing of the k-d tree build
obj.SetMinCells (int ) - Minimum number of cells per spatial region. Default is 100.
int = obj.GetMinCells () - Minimum number of cells per spatial region. Default is 100.
int = obj.GetNumberOfRegionsOrLess ()
obj.SetNumberOfRegionsOrLess (int )
int = obj.GetNumberOfRegionsOrMore ()
obj.SetNumberOfRegionsOrMore (int )
double = obj.GetFudgeFactor ()
obj.SetFudgeFactor (double )
vtkBSPCuts = obj.GetCuts ()
obj.SetCuts (vtkBSPCuts cuts)
obj.OmitXPartitioning () - Omit partitions along the X axis, yielding shafts in the X direction
obj.OmitYPartitioning () - Omit partitions along the Y axis, yielding shafts in the Y direction
obj.OmitZPartitioning () - Omit partitions along the Z axis, yielding shafts in the Z direction
obj.OmitXYPartitioning () - Omit partitions along the X and Y axes, yielding slabs along Z
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.120 vtkKdTree
913
obj.OmitYZPartitioning () - Omit partitions along the Y and Z axes, yielding slabs along X
obj.OmitZXPartitioning () - Omit partitions along the Z and X axes, yielding slabs along Y
obj.OmitNoPartitioning () - Partition along all three axes - this is the default
obj.SetDataSet (vtkDataSet set) - Clear out all data sets and replace with single data set. For
backward compatibility with superclass.
obj.AddDataSet (vtkDataSet set) - This class can compute a spatial decomposition based on
the cells in a list of one or more input data sets. Add them one at a time with this method.
obj.RemoveDataSet (int index) - Remove the given data set.
obj.RemoveDataSet (vtkDataSet set) - Remove the given data set.
obj.RemoveAllDataSets () - Remove the given data set.
int = obj.GetNumberOfDataSets () - Get the number of data sets included in spatial paritioning
vtkDataSet = obj.GetDataSet (int n) - Return the nth data set.
vtkDataSet = obj.GetDataSet () - Return a collection of all the data sets.
vtkDataSetCollection = obj.GetDataSets () - Return a collection of all the data sets.
int = obj.GetDataSetIndex (vtkDataSet set) - Return the index of the given data set. Returns -1 if that data set does not exist.
obj.GetBounds (double bounds) - Get the spatial bounds of the entire k-d tree space. Sets bounds
array to xmin, xmax, ymin, ymax, zmin, zmax.
obj.SetNewBounds (double bounds)
int = obj.GetNumberOfRegions () - The number of leaf nodes of the tree, the spatial regions
obj.GetRegionBounds (int regionID, double bounds[6]) - Get the spatial bounds of kd tree region
obj.GetRegionDataBounds (int regionID, double bounds[6]) - Get the bounds of the
data within the k-d tree region
obj.PrintTree () - Print out nodes of kd tree
obj.PrintVerboseTree () - Print out nodes of kd tree
obj.PrintRegion (int id) - Print out leaf node data for given id
obj.CreateCellLists (int dataSetIndex, int regionReqList, int reqList-
Size)
obj.CreateCellLists (vtkDataSet set, int regionReqList, int reqList-
Size)
obj.CreateCellLists (int regionReqList, int listSize)
obj.CreateCellLists ()
obj.SetIncludeRegionBoundaryCells (int ) - If IncludeRegionBoundaryCells is ON, CreateCellLists() will also create a list of cells which intersect a given region, but are not assigned to the region.
These lists are obtained with GetBoundaryCellList(). Default is OFF.
int = obj.GetIncludeRegionBoundaryCells () - If IncludeRegionBoundaryCells is ON,
CreateCellLists() will also create a list of cells which intersect a given region, but are not assigned to the
region. These lists are obtained with GetBoundaryCellList(). Default is OFF.
obj.IncludeRegionBoundaryCellsOn () - If IncludeRegionBoundaryCells is ON, CreateCellLists() will also create a list of cells which intersect a given region, but are not assigned to the region. These
lists are obtained with GetBoundaryCellList(). Default is OFF.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
914
32.120 vtkKdTree
915
916
32.121
vtkKdTreePointLocator
32.122 vtkKochanekSpline
32.121.1
917
Usage
vtkKdTreePointLocator is a wrapper class that derives from vtkAbstractPointLocator and calls the search functions
in vtkKdTree.
To create an instance of class vtkKdTreePointLocator, simply invoke its constructor as follows
obj = vtkKdTreePointLocator
32.121.2
Methods
The class vtkKdTreePointLocator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkKdTreePointLocator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkKdTreePointLocator = obj.NewInstance ()
vtkKdTreePointLocator = obj.SafeDownCast (vtkObject o)
vtkIdType = obj.FindClosestPoint (double x[3]) - Given a position x, return the id of
the point closest to it. Alternative method requires separate x-y-z values. These methods are thread safe if
BuildLocator() is directly or indirectly called from a single thread first.
obj.FindClosestNPoints (int N, double x[3], vtkIdList result) - Find the closest N points to a position. This returns the closest N points to a position. A faster method could be created
that returned N close points to a position, but necessarily the exact N closest. The returned points are sorted
from closest to farthest. These methods are thread safe if BuildLocator() is directly or indirectly called from a
single thread first.
obj.FindPointsWithinRadius (double R, double x[3], vtkIdList result)
Find all points within a specified radius R of position x. The result is not sorted in any specific manner.
These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.
obj.FreeSearchStructure () - See vtkLocator interface documentation. These methods are not
thread safe.
obj.BuildLocator () - See vtkLocator interface documentation. These methods are not thread safe.
obj.GenerateRepresentation (int level, vtkPolyData pd) - See vtkLocator interface
documentation. These methods are not thread safe.
32.122
vtkKochanekSpline
32.122.1
Usage
Implements the Kochenek interpolating spline described in: Kochanek, D., Bartels, R., "Interpolating Splines with
Local Tension, Continuity, and Bias Control," Computer Graphics, vol. 18, no. 3, pp. 33-41, July 1984. These splines
give the user more control over the shape of the curve than the cardinal splines implemented in vtkCardinalSpline.
Three parameters can be specified. All have a range from -1 to 1.
Tension controls how sharply the curve bends at an input point. A value of -1 produces more slack in the curve. A
value of 1 tightens the curve.
Continuity controls the continuity of the first derivative at input points.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
918
Bias controls the direction of the curve at it passes through an input point. A value of -1 undershoots the point while
a value of 1 overshoots the point.
These three parameters give the user broad control over the shape of the interpolating spline. The original Kochanek
paper describes the effects nicely and is recommended reading.
To create an instance of class vtkKochanekSpline, simply invoke its constructor as follows
obj = vtkKochanekSpline
32.122.2
Methods
The class vtkKochanekSpline has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkKochanekSpline class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkKochanekSpline = obj.NewInstance ()
vtkKochanekSpline = obj.SafeDownCast (vtkObject o)
obj.Compute () - Compute Kochanek Spline coefficients.
double = obj.Evaluate (double t) - Evaluate a 1D Kochanek spline.
obj.SetDefaultBias (double ) - Set the bias for all points. Default is 0.
double = obj.GetDefaultBias () - Set the bias for all points. Default is 0.
obj.SetDefaultTension (double ) - Set the tension for all points. Default is 0.
double = obj.GetDefaultTension () - Set the tension for all points. Default is 0.
obj.SetDefaultContinuity (double ) - Set the continuity for all points. Default is 0.
double = obj.GetDefaultContinuity () - Set the continuity for all points. Default is 0.
obj.DeepCopy (vtkSpline s) - Deep copy of cardinal spline data.
32.123
vtkLine
32.123.1
Usage
32.124 vtkLocator
32.123.2
919
Methods
The class vtkLine has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkLine class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkLine = obj.NewInstance ()
vtkLine = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int ) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int ) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts) - See the
vtkCell API for descriptions of these methods.
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs) - See the vtkCell API for descriptions of these methods.
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.124
vtkLocator
920
32.124.1
Usage
vtkLocator is an abstract base class for spatial search objects, or locators. The principle behind locators is that they
divide 3-space into small pieces (or "buckets") that can be quickly found in response to queries like point location,
line intersection, or object-object intersection.
The purpose of this base class is to provide ivars and methods shared by all locators. The GenerateRepresentation()
is one such interesting method. This method works in conjunction with vtkLocatorFilter to create polygonal representations for the locator. For example, if the locator is an OBB tree (i.e., vtkOBBTree.h), then the representation is
a set of one or more oriented bounding boxes, depending upon the specified level.
Locators typically work as follows. One or more "entities", such as points or cells, are inserted into the tree. These
entities are associated with one or more buckets. Then, when performing geometric operations, the operations
are performed first on the buckets, and then if the operation tests positive, then on the entities in the bucket. For
example, during collision tests, the locators are collided first to identify intersecting buckets. If an intersection is
found, more expensive operations are then carried out on the entities in the bucket.
To obtain good performance, locators are often organized in a tree structure. In such a structure, there are frequently
multiple "levels" corresponding to different nodes in the tree. So the word level (in the context of the locator) can be
used to specify a particular representation in the tree. For example, in an octree (which is a tree with 8 children),
level 0 is the bounding box, or root octant, and level 1 consists of its eight children.
To create an instance of class vtkLocator, simply invoke its constructor as follows
obj = vtkLocator
32.124.2
Methods
The class vtkLocator has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkLocator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkLocator = obj.NewInstance ()
vtkLocator = obj.SafeDownCast (vtkObject o)
obj.SetDataSet (vtkDataSet ) - Build the locator from the points/cells defining this dataset.
vtkDataSet = obj.GetDataSet () - Build the locator from the points/cells defining this dataset.
obj.SetMaxLevel (int ) - Set the maximum allowable level for the tree. If the Automatic ivar is off,
this will be the target depth of the locator. Initial value is 8.
int = obj.GetMaxLevelMinValue () - Set the maximum allowable level for the tree. If the Automatic ivar is off, this will be the target depth of the locator. Initial value is 8.
int = obj.GetMaxLevelMaxValue () - Set the maximum allowable level for the tree. If the Automatic ivar is off, this will be the target depth of the locator. Initial value is 8.
int = obj.GetMaxLevel () - Set the maximum allowable level for the tree. If the Automatic ivar is
off, this will be the target depth of the locator. Initial value is 8.
int = obj.GetLevel () - Get the level of the locator (determined automatically if Automatic is true).
The value of this ivar may change each time the locator is built. Initial value is 8.
obj.SetAutomatic (int ) - Boolean controls whether locator depth/resolution of locator is computed
automatically from average number of entities in bucket. If not set, there will be an explicit method to control
the construction of the locator (found in the subclass).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.125 vtkMapper2D
921
int = obj.GetAutomatic () - Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. If not set, there will be an explicit method to
control the construction of the locator (found in the subclass).
obj.AutomaticOn () - Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. If not set, there will be an explicit method to control the
construction of the locator (found in the subclass).
obj.AutomaticOff () - Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. If not set, there will be an explicit method to control the
construction of the locator (found in the subclass).
obj.SetTolerance (double ) - Specify absolute tolerance (in world coordinates) for performing geometric operations.
double = obj.GetToleranceMinValue () - Specify absolute tolerance (in world coordinates) for
performing geometric operations.
double = obj.GetToleranceMaxValue () - Specify absolute tolerance (in world coordinates) for
performing geometric operations.
double = obj.GetTolerance () - Specify absolute tolerance (in world coordinates) for performing
geometric operations.
obj.Update () - Cause the locator to rebuild itself if it or its input dataset has changed.
obj.Initialize () - Initialize locator. Frees memory and resets object as appropriate.
obj.BuildLocator () - Build the locator from the input dataset.
obj.FreeSearchStructure () - Free the memory required for the spatial data structure.
obj.GenerateRepresentation (int level, vtkPolyData pd) - Method to build a representation at a particular level. Note that the method GetLevel() returns the maximum number of levels available for the tree. You must provide a vtkPolyData object into which to place the data.
long = obj.GetBuildTime () - Return the time of the last data structure build.
obj.Register (vtkObjectBase o) - Handle the PointSet <-> Locator loop.
obj.UnRegister (vtkObjectBase o) - Handle the PointSet <-> Locator loop.
32.125
vtkMapper2D
32.125.1
Usage
vtkMapper2D is an abstract class which defines the interface for objects which render two dimensional actors (vtkActor2D).
To create an instance of class vtkMapper2D, simply invoke its constructor as follows
obj = vtkMapper2D
922
32.125.2
Methods
The class vtkMapper2D has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkMapper2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMapper2D = obj.NewInstance ()
vtkMapper2D = obj.SafeDownCast (vtkObject o)
obj.RenderOverlay (vtkViewport , vtkActor2D )
obj.RenderOpaqueGeometry (vtkViewport , vtkActor2D )
obj.RenderTranslucentPolygonalGeometry (vtkViewport , vtkActor2D )
int = obj.HasTranslucentPolygonalGeometry ()
32.126
vtkMergePoints
32.126.1
Usage
vtkMergePoints is a locator object to quickly locate points in 3D. The primary difference between vtkMergePoints
and its superclass vtkPointLocator is that vtkMergePoints merges precisely coincident points and is therefore much
faster.
To create an instance of class vtkMergePoints, simply invoke its constructor as follows
obj = vtkMergePoints
32.126.2
Methods
The class vtkMergePoints has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkMergePoints class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMergePoints = obj.NewInstance ()
vtkMergePoints = obj.SafeDownCast (vtkObject o)
vtkIdType = obj.IsInsertedPoint (double x[3]) - Determine whether point given by x[3]
has been inserted into points list. Return id of previously inserted point if this is true, otherwise return -1.
vtkIdType = obj.IsInsertedPoint (double x, double y, double z) - Determine
whether point given by x[3] has been inserted into points list. Return id of previously inserted point if this is
true, otherwise return -1.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.127 vtkModifiedBSPTree
32.127
923
vtkModifiedBSPTree
32.127.1
Usage
vtkModifiedBSPTree creates an evenly balanced BSP tree using a top down implementation. Axis aligned split
planes are found which evenly divide cells into two buckets. Generally a split plane will intersect some cells and
these are usually stored in both child nodes of the current parent. (Or split into separate cells which we cannot
consider in this case). Storing cells in multiple buckets creates problems associated with multiple tests against rays
and increases the required storage as complex meshes will have many cells straddling a split plane (and further
splits may cause multiple copies of these).
During a discussion with Arno Formella in 1998 he suggested using a third child node to store objects which straddle
split planes. Ive not seen this published (Yes! - see below), but thought it worth trying. This implementation of the
BSP tree creates a third child node for storing cells lying across split planes, the third cell may overlap the other two,
but the two proper nodes otherwise conform to usual BSP rules.
The advantage of this implementation is cells only ever lie in one node and mailbox testing is avoided. All BBoxes
are axis aligned and a ray cast uses an efficient search strategy based on near/far nodes and rejects all BBoxes
using simple tests.
For fast raytracing, 6 copies of cell lists are stored in each leaf node each list is in axis sorted order +/- x,y,z and
cells are always tested in the direction of the ray dominant axis. Once an intersection is found any cell or BBox with
a closest point further than the I-point can be instantly rejected and raytracing stops as soon as no nodes can be
closer than the current best intersection point.
The addition of the middle node upsets the optimal balance of the tree, but is a minor overhead during the raytrace.
Each child node is contracted such that it tightly fits all cells inside it, enabling further ray/box rejections.
This class is intented for persons requiring many ray tests and is optimized for this purpose. As no cell ever lies in
more than one leaf node, and parent nodes do not maintain cell lists, the memory overhead of the sorted cell lists
is 6num_cells4 for 6 lists of ints, each num_cells in length. The memory requirement of the nodes themselves is
usually of minor significance.
Subdividision is controlled by MaxCellsPerNode - any node with more than this number will be subdivided providing
a good split plane can be found and the max depth is not exceeded.
The average cells per leaf will usually be around half the MaxCellsPerNode, though the middle node is usually
sparsely populated and lowers the average slightly. The middle node will not be created when not needed. Subdividing down to very small cells per node is not generally suggested as then the 6 stored cell lists are effectively
redundant.
Values of MaxcellsPerNode of around 16->128 depending on dataset size will usually give good results.
Cells are only sorted into 6 lists once - before tree creation, each node segments the lists and passes them down
to the new child nodes whilst maintaining sorted order. This makes for an efficient subdivision strategy.
NB. The following reference has been sent to me {formella-1995-ray, author = "Arno Formella and Christian Gill",
title = "{Ray Tracing: A Quantitative Analysis and a New Practical Algorithm}", journal = "{The Visual Computer}",
year = "{1995}", month = dec, pages = "{465--476}", volume = "{11}", number = "{9}", publisher = "{Springer}",
keywords = "{ray tracing, space subdivision, plane traversal, octree, clustering, benchmark scenes}", annote = "{We
present a new method to accelerate the process of finding nearest rayobject intersections in ray tracing. The
algorithm consumes an amount of memory more or less linear in the number of objects. The basic ideas can be
characterized with a modified BSPtree and plane traversal. Plane traversal is a fast linear time algorithm to find
the closest intersection point in a list of bounding volumes hit by a ray. We use plane traversal at every node of the
high outdegree BSPtree. Our implementation is competitive to fast ray tracing programs. We present a benchmark
suite which allows for an extensive comparison of ray tracing algorithms.}", }
.SECTION Thanks John Biddiscombe for developing and contributing this class
924
.SECTION ToDo
Implement intersection heap for testing rays against transparent objects
.SECTION Style
This class is currently maintained by J. Biddiscombe who has specially requested that the code style not be modified
to the kitware standard. Please respect the contribution of this class by keeping the style as close as possible to the
authors original.
To create an instance of class vtkModifiedBSPTree, simply invoke its constructor as follows
obj = vtkModifiedBSPTree
32.127.2
Methods
The class vtkModifiedBSPTree has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkModifiedBSPTree class.
string = obj.GetClassName () - Standard Type-Macro
int = obj.IsA (string name) - Standard Type-Macro
vtkModifiedBSPTree = obj.NewInstance () - Standard Type-Macro
vtkModifiedBSPTree = obj.SafeDownCast (vtkObject o) - Standard Type-Macro
obj.FreeSearchStructure () - Free tree memory
obj.BuildLocator () - Build Tree
32.128
vtkMultiBlockDataSet
32.128.1
Usage
vtkMultiBlockDataSet is a vtkCompositeDataSet that stores a hierarchy of datasets. The dataset collection consists
of multiple blocks. Each block can itself be a vtkMultiBlockDataSet, thus providing for a full tree structure. Subblocks are usually used to distribute blocks across processors. For example, a 1 block dataset can be distributed as
following:
proc 0:
Block 0:
* ds 0
* (null)
proc 1:
Block 0:
* (null)
* ds 1
32.129 vtkMultiBlockDataSetAlgorithm
32.128.2
925
Methods
The class vtkMultiBlockDataSet has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMultiBlockDataSet class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMultiBlockDataSet = obj.NewInstance ()
vtkMultiBlockDataSet = obj.SafeDownCast (vtkObject o)
int = obj.GetDataObjectType () - Set the number of blocks. This will cause allocation if the new
number of blocks is greater than the current size. All new blocks are initialized to null.
obj.SetNumberOfBlocks (int numBlocks) - Set the number of blocks. This will cause allocation
if the new number of blocks is greater than the current size. All new blocks are initialized to null.
int = obj.GetNumberOfBlocks () - Returns the number of blocks.
vtkDataObject = obj.GetBlock (int blockno) - Returns the block at the given index. It is
recommended that one uses the iterators to iterate over composite datasets rather than using this API.
obj.SetBlock (int blockno, vtkDataObject block) - Sets the data object as the given
block. The total number of blocks will be resized to fit the requested block no.
obj.RemoveBlock (int blockno) - Remove the given block from the dataset.
int = obj.HasMetaData (int blockno) - Returns the meta-data for the block. If none is already
present, a new vtkInformation object will be allocated. Use HasMetaData to avoid allocating vtkInformation
objects.
vtkInformation = obj.GetMetaData (int blockno) - Unhiding superclass method.
vtkInformation = obj.GetMetaData (vtkCompositeDataIterator iter) - Unhiding
superclass method.
int = obj.HasMetaData (vtkCompositeDataIterator iter)
32.129
vtkMultiBlockDataSetAlgorithm
32.129.1
Usage
Algorithms that take any type of data object (including composite dataset) and produce a vtkMultiBlockDataSet in
the output can subclass from this class.
To create an instance of class vtkMultiBlockDataSetAlgorithm, simply invoke its constructor as follows
obj = vtkMultiBlockDataSetAlgorithm
32.129.2
Methods
The class vtkMultiBlockDataSetAlgorithm has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMultiBlockDataSetAlgorithm class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
926
32.130
vtkMultiPieceDataSet
32.130.1
Usage
A vtkMultiPieceDataSet dataset groups multiple data pieces together. For example, say that a simulation broke a
volume into 16 piece so that each piece can be processed with 1 process in parallel. We want to load this volume in
a visualization cluster of 4 nodes. Each node will get 4 pieces, not necessarily forming a whole rectangular piece. In
this case, it is not possible to append the 4 pieces together into a vtkImageData. In this case, these 4 pieces can be
collected together using a vtkMultiPieceDataSet. Note that vtkMultiPieceDataSet is intended to be included in other
composite datasets eg. vtkMultiBlockDataSet, vtkHierarchicalBoxDataSet. Hence the lack of algorithms producting
vtkMultiPieceDataSet.
To create an instance of class vtkMultiPieceDataSet, simply invoke its constructor as follows
obj = vtkMultiPieceDataSet
32.130.2
Methods
The class vtkMultiPieceDataSet has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMultiPieceDataSet class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMultiPieceDataSet = obj.NewInstance ()
vtkMultiPieceDataSet = obj.SafeDownCast (vtkObject o)
int = obj.GetDataObjectType () - Set the number of pieces. This will cause allocation if the new
number of pieces is greater than the current size. All new pieces are initialized to null.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.131 vtkMutableDirectedGraph
927
obj.SetNumberOfPieces (int numpieces) - Set the number of pieces. This will cause allocation
if the new number of pieces is greater than the current size. All new pieces are initialized to null.
int = obj.GetNumberOfPieces () - Returns the number of pieces.
vtkDataSet = obj.GetPiece (int pieceno) - Returns the piece at the given index.
vtkDataObject = obj.GetPieceAsDataObject (int pieceno) - Returns the piece at the
given index.
obj.SetPiece (int pieceno, vtkDataObject piece) - Sets the data object as the given
piece. The total number of pieces will be resized to fit the requested piece no.
int = obj.HasMetaData (int piece) - Returns the meta-data for the piece. If none is already
present, a new vtkInformation object will be allocated. Use HasMetaData to avoid allocating vtkInformation
objects.
vtkInformation = obj.GetMetaData (int pieceno) - Unhiding superclass method.
vtkInformation = obj.GetMetaData (vtkCompositeDataIterator iter) - Unhiding
superclass method.
int = obj.HasMetaData (vtkCompositeDataIterator iter)
32.131
vtkMutableDirectedGraph
32.131.1
Usage
vtkMutableDirectedGraph is a directed graph which has additional methods for adding edges and vertices. AddChild() is a convenience method for constructing trees. ShallowCopy(), DeepCopy(), CheckedShallowCopy() and
CheckedDeepCopy() will succeed for instances of vtkDirectedGraph, vtkMutableDirectedGraph and vtkTree.
To create an instance of class vtkMutableDirectedGraph, simply invoke its constructor as follows
obj = vtkMutableDirectedGraph
32.131.2
Methods
The class vtkMutableDirectedGraph has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMutableDirectedGraph
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMutableDirectedGraph = obj.NewInstance ()
vtkMutableDirectedGraph = obj.SafeDownCast (vtkObject o)
vtkIdType = obj.AddVertex () - Adds a vertex to the graph and returns the index of the new
vertex.
Note: In a distributed graph (i.e. a graph whose DistributedHelper is non-null), this routine cannot be used to
add a vertex if the vertices in the graph have pedigree IDs, because this routine will always add the vertex
locally, which may conflict with the proper location of the vertex based on the distribution of the pedigree IDs.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
928
If non-null, propertyArr provides edge properties for the newly-created edge. The values in propertyArr must match up with the arrays in the edge data returned by GetEdgeData().
vtkIdType = obj.AddChild (vtkIdType parent) - Removes the vertex from the graph along
with any connected edges. Note: This invalidates the last vertex index, which is reassigned to v.
obj.RemoveVertex (vtkIdType v) - Removes the vertex from the graph along with any connected
edges. Note: This invalidates the last vertex index, which is reassigned to v.
obj.RemoveEdge (vtkIdType e) - Removes the edge from the graph. Note: This invalidates the
last edge index, which is reassigned to e.
obj.RemoveVertices (vtkIdTypeArray arr) - Removes a collection of vertices from the graph
along with any connected edges.
obj.RemoveEdges (vtkIdTypeArray arr) - Removes a collection of edges from the graph.
32.132
vtkMutableUndirectedGraph
32.132 vtkMutableUndirectedGraph
32.132.1
929
Usage
vtkMutableUndirectedGraph is an undirected graph with additional functions for adding vertices and edges. ShallowCopy(), DeepCopy(), CheckedShallowCopy(), and CheckedDeepCopy() will succeed when the argument is a vtkUndirectedGraph or vtkMutableUndirectedGraph.
To create an instance of class vtkMutableUndirectedGraph, simply invoke its constructor as follows
obj = vtkMutableUndirectedGraph
32.132.2
Methods
The class vtkMutableUndirectedGraph has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMutableUndirectedGraph
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMutableUndirectedGraph = obj.NewInstance ()
vtkMutableUndirectedGraph = obj.SafeDownCast (vtkObject o)
vtkIdType = obj.AddVertex () - Adds a vertex to the graph and returns the index of the new
vertex.
Note: In a distributed graph (i.e. a graph whose DistributedHelper is non-null), this routine cannot be used to
add a vertex if the vertices in the graph have pedigree IDs, because this routine will always add the vertex
locally, which may conflict with the proper location of the vertex based on the distribution of the pedigree IDs.
vtkIdType = obj.AddVertex (vtkVariantArray propertyArr) - Adds a vertex to the
graph with associated properties defined in propertyArr and returns the index of the new vertex. The
number and order of values in propertyArr must match up with the arrays in the vertex data retrieved by
GetVertexData().
If a vertex with the given pedigree ID already exists, its properties will be overwritten with the properties in
propertyArr and the existing vertex index will be returned.
Note: In a distributed graph (i.e. a graph whose DistributedHelper is non-null) the vertex added or found
might not be local. In this case, AddVertex will wait until the vertex can be added or found remotely, so that
the proper vertex index can be returned. If you dont actually need to use the vertex index, consider calling
LazyAddVertex, which provides better performance by eliminating the delays associated with returning the
vertex index.
obj.LazyAddVertex () - Adds a vertex to the graph.
This method is lazily evaluated for distributed graphs (i.e. graphs whose DistributedHelper is non-null) the
next time Synchronize is called on the helper.
obj.LazyAddVertex (vtkVariantArray propertyArr) - Adds a vertex to the graph with associated properties defined in propertyArr. The number and order of values in propertyArr must
match up with the arrays in the vertex data retrieved by GetVertexData().
If a vertex with the given pedigree ID already exists, its properties will be overwritten with the properties in
propertyArr.
This method is lazily evaluated for distributed graphs (i.e. graphs whose DistributedHelper is non-null) the
next time Synchronize is called on the helper.
obj.LazyAddEdge (vtkIdType u, vtkIdType v) - Adds an undirected edge from u to v,
where u and v are vertex indices.
This method is lazily evaluated for distributed graphs (i.e. graphs whose DistributedHelper is non-null) the
next time Synchronize is called on the helper.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
930
32.133
vtkNonLinearCell
32.133.1
Usage
vtkNonLinearCell is an abstract superclass for non-linear cell types. Cells that are a direct subclass of vtkCell or
vtkCell3D are linear; cells that are a subclass of vtkNonLinearCell have non-linear interpolation functions. Nonlinear cells require special treatment when tessellating or converting to graphics primitives. Note that the linearity of
the cell is a function of whether the cell needs tessellation, which does not strictly correlate with interpolation order
(e.g., vtkHexahedron has non-linear interpolation functions (a product of three linear functions in r-s-t) even thought
vtkHexahedron is considered linear.)
To create an instance of class vtkNonLinearCell, simply invoke its constructor as follows
obj = vtkNonLinearCell
32.133.2
Methods
The class vtkNonLinearCell has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkNonLinearCell class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkNonLinearCell = obj.NewInstance ()
vtkNonLinearCell = obj.SafeDownCast (vtkObject o)
int = obj.IsLinear ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.134 vtkNonMergingPointLocator
32.134
931
vtkNonMergingPointLocator
32.134.1
Usage
32.134.2
Methods
The class vtkNonMergingPointLocator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkNonMergingPointLocator
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkNonMergingPointLocator = obj.NewInstance ()
vtkNonMergingPointLocator = obj.SafeDownCast (vtkObject o)
32.135
vtkOctreePointLocator
32.135.1
Usage
Given a vtkDataSetxs, create an octree that is locally refined such that all leaf octants contain less than a certain
amount of points. Note that there is no size constraint that a leaf octant in relation to any of its neighbors.
This class can also generate a PolyData representation of the boundaries of the spatial regions in the decomposition.
To create an instance of class vtkOctreePointLocator, simply invoke its constructor as follows
obj = vtkOctreePointLocator
32.135.2
Methods
The class vtkOctreePointLocator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkOctreePointLocator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
932
32.136 vtkOctreePointLocatorNode
32.136
933
vtkOctreePointLocatorNode
32.136.1
Usage
This class represents a single spatial region in a 3D axis octant partitioning. It is intended to work efficiently with
the vtkOctreePointLocator and is not meant for general use. It is assumed the region bounds some set of points.
The ordering of the children is (-x,-y,-z),(+x,-y,-z),(-x,+y,-z),(+x,+y,-z),(-x,-y,+z),(+x,-y,+z), (-x,+y,+z),(+x,+y,+z). The
portion of the domain assigned to an octant is Min < x <= Max.
To create an instance of class vtkOctreePointLocatorNode, simply invoke its constructor as follows
obj = vtkOctreePointLocatorNode
32.136.2
Methods
The class vtkOctreePointLocatorNode has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkOctreePointLocatorNode
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkOctreePointLocatorNode = obj.NewInstance ()
vtkOctreePointLocatorNode = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfPoints (int numberOfPoints) - Set/Get the number of points contained in
this region.
int = obj.GetNumberOfPoints () - Set/Get the number of points contained in this region.
obj.SetBounds (double xMin, double xMax, double yMin, double yMax, double
zMin, double zMax) - Set/Get the bounds of the spatial region represented by this node. Caller allocates storage for 6-vector in GetBounds.
obj.SetBounds (double b[6]) - Set/Get the bounds of the spatial region represented by this node.
Caller allocates storage for 6-vector in GetBounds.
obj.GetBounds (double b) const - Set/Get the bounds of the spatial region represented by this
node. Caller allocates storage for 6-vector in GetBounds.
obj.SetDataBounds (double xMin, double xMax, double yMin, double yMax,
double zMin, double zMax) - Set/Get the bounds of the points contained in this spatial region. This
may be smaller than the bounds of the region itself. Caller allocates storage for 6-vector in GetDataBounds.
obj.GetDataBounds (double b) const - Set/Get the bounds of the points contained in this spatial region. This may be smaller than the bounds of the region itself. Caller allocates storage for 6-vector in
GetDataBounds.
obj.SetMinBounds (double minBounds[3]) - Set the xmax, ymax and zmax value of the
bounds of this region
obj.SetMaxBounds (double maxBounds[3]) - Set the xmin, ymin and zmin value of the bounds
of this data within this region.
obj.SetMinDataBounds (double minDataBounds[3]) - Set the xmax, ymax and zmax value
of the bounds of this data within this region.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
934
32.137
vtkOrderedTriangulator
32.137.1
Usage
This class is used to generate unique triangulations of points. The uniqueness of the triangulation is controlled by
the id of the inserted points in combination with a Delaunay criterion. The class is designed to be as fast as possible
(since the algorithm can be slow) and uses block memory allocations to support rapid triangulation generation. Also,
the assumption behind the class is that a maximum of hundreds of points are to be triangulated. If you desire more
robust triangulation methods use vtkPolygon::Triangulate(), vtkDelaunay2D, or vtkDelaunay3D.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.137 vtkOrderedTriangulator
935
.SECTION Background This work is documented in the technical paper: W.J. Schroeder, B. Geveci, M. Malaterre.
Compatible Triangulations of Spatial Decompositions. In Proceedings of Visualization 2004, IEEE Press October
2004.
Delaunay triangulations are unique assuming a random distribution of input points. The 3D Delaunay criterion is
as follows: the circumsphere of each tetrahedron contains no other points of the triangulation except for the four
points defining the tetrahedron. In application this property is hard to satisfy because objects like cubes are defined
by eight points all sharing the same circumsphere (center and radius); hence the Delaunay triangulation is not
unique. These so-called degenerate situations are typically resolved by arbitrary selecting a triangulation. This
code does something different: it resolves degenerate triangulations by modifying the "InCircumsphere" method to
use a slightly smaller radius. Hence, degenerate points are always considered "out" of the circumsphere. This, in
combination with an ordering (based on id) of the input points, guarantees a unique triangulation.
There is another related characteristic of Delaunay triangulations. Given a N-dimensional Delaunay triangulation,
points lying on a (N-1) dimensional plane also form a (N-1) Delaunay triangulation. This means for example, that if
a 3D cell is defined by a set of (2D) planar faces, then the face triangulations are Delaunay. Combining this with the
method to generate unique triangulations described previously, the triangulations on the face are guaranteed unique.
This fact can be used to triangulate 3D objects in such a way to guarantee compatible face triangulations. This is a
very useful fact for parallel processing, or performing operations like clipping that require compatible triangulations
across 3D cell faces. (See vtkClipVolume for an example.)
A special feature of this class is that it can generate triangulation templates on the fly. If template triangulation is
enabled, then the ordered triangulator will first triangulate the cell using the slower ordered Delaunay approach,
and then store the result as a template. Later, if the same cell type and cell configuration is encountered, then the
template is reused which greatly speeds the triangulation.
To create an instance of class vtkOrderedTriangulator, simply invoke its constructor as follows
obj = vtkOrderedTriangulator
32.137.2
Methods
The class vtkOrderedTriangulator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkOrderedTriangulator
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkOrderedTriangulator = obj.NewInstance ()
vtkOrderedTriangulator = obj.SafeDownCast (vtkObject o)
obj.InitTriangulation (double xmin, double xmax, double ymin, double
ymax, double zmin, double zmax, int numPts) - Initialize the triangulation process. Provide a bounding box and the maximum number of points to be inserted. Note that since the triangulation is
performed using parametric coordinates (see InsertPoint()) the bounds should be represent the range of the
parametric coordinates inserted.
Postcondition
no_point_inserted: GetNumberOfPoints()==0
obj.InitTriangulation (double bounds[6], int numPts) - Initialize the triangulation
process. Provide a bounding box and the maximum number of points to be inserted. Note that since the
triangulation is performed using parametric coordinates (see InsertPoint()) the bounds should be represent
the range of the parametric coordinates inserted.
936
32.137 vtkOrderedTriangulator
937
obj.SetUseTemplates (int ) - If this flag is set, then the ordered triangulator will create and use
templates for the triangulation. To use templates, the TemplateTriangulate() method should be called when
appropriate. (Note: the TemplateTriangulate() method works for complete (interior) cells without extra points
due to intersection, etc.)
int = obj.GetUseTemplates () - If this flag is set, then the ordered triangulator will create and use
templates for the triangulation. To use templates, the TemplateTriangulate() method should be called when
appropriate. (Note: the TemplateTriangulate() method works for complete (interior) cells without extra points
due to intersection, etc.)
obj.UseTemplatesOn () - If this flag is set, then the ordered triangulator will create and use templates
for the triangulation. To use templates, the TemplateTriangulate() method should be called when appropriate. (Note: the TemplateTriangulate() method works for complete (interior) cells without extra points due to
intersection, etc.)
obj.UseTemplatesOff () - If this flag is set, then the ordered triangulator will create and use templates for the triangulation. To use templates, the TemplateTriangulate() method should be called when appropriate. (Note: the TemplateTriangulate() method works for complete (interior) cells without extra points due
to intersection, etc.)
obj.SetPreSorted (int ) - Boolean indicates whether the points have been pre-sorted. If pre-sorted
is enabled, the points are not sorted on point id. By default, presorted is off. (The point id is defined in InsertPoint().)
int = obj.GetPreSorted () - Boolean indicates whether the points have been pre-sorted. If presorted is enabled, the points are not sorted on point id. By default, presorted is off. (The point id is defined in
InsertPoint().)
obj.PreSortedOn () - Boolean indicates whether the points have been pre-sorted. If pre-sorted is
enabled, the points are not sorted on point id. By default, presorted is off. (The point id is defined in InsertPoint().)
obj.PreSortedOff () - Boolean indicates whether the points have been pre-sorted. If pre-sorted is
enabled, the points are not sorted on point id. By default, presorted is off. (The point id is defined in InsertPoint().)
obj.SetUseTwoSortIds (int ) - Tells the triangulator that a second sort id is provided for each
point and should also be considered when sorting.
int = obj.GetUseTwoSortIds () - Tells the triangulator that a second sort id is provided for each
point and should also be considered when sorting.
obj.UseTwoSortIdsOn () - Tells the triangulator that a second sort id is provided for each point and
should also be considered when sorting.
obj.UseTwoSortIdsOff () - Tells the triangulator that a second sort id is provided for each point and
should also be considered when sorting.
vtkIdType = obj.GetTetras (int classification, vtkUnstructuredGrid ugrid)
- Initialize and add the tetras and points from the triangulation to the unstructured grid provided. New points
are created and the mesh is allocated. (This method differs from AddTetras() in that it inserts points
and cells; AddTetras only adds the tetra cells.) The tetrahdera added are of the type specified (0=inside,1=outside,2=all). Inside tetrahedron are those whose points are classified "inside" or on the "boundary."
Outside tetrahedron have at least one point classified "outside." The method returns the number of tetrahedrahedron of the type requested.
vtkIdType = obj.AddTetras (int classification, vtkUnstructuredGrid ugrid)
- Add the tetras to the unstructured grid provided. The unstructured grid is assumed to have been initialized (with Allocate()) and points set (with SetPoints()). The tetrahdera added are of the type specified
(0=inside,1=outside,2=all). Inside tetrahedron are those whose points are classified "inside" or on the
"boundary." Outside tetrahedron have at least one point classified "outside." The method returns the number
of tetrahedrahedron of the type requested.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
938
Locator locator, vtkCellArray outConnectivity, vtkPointData inPD, vtkPointData outPD, vtkCellData inCD, vtkIdType cellId, vtkCellData outCD)
- Assuming that all the inserted points come from a cell cellId to triangulate, get the tetrahedra in outConnectivity, the points in locator and copy point data and cell data. Return the number of added tetras.
Precondition
locator_exists: locator!=0
outConnectivity: outConnectivity!=0
inPD_exists: inPD!=0
outPD_exists: outPD!=0
inCD_exists: inCD!=0
outCD_exists: outCD!=0
vtkIdType = obj.AddTetras (int classification, vtkIdList ptIds, vtkPoints pts) - Add the tetrahedra classified (0=inside,1=outside) to the list of ids and coordinates
provided. These assume that the first four points form a tetrahedron, the next four the next, and so on.
vtkIdType = obj.AddTriangles (vtkCellArray connectivity) - Add the triangle faces
classified (2=boundary) to the connectivity list provided. The method returns the number of triangles.
vtkIdType = obj.AddTriangles (vtkIdType id, vtkCellArray connectivity) Add the triangle faces classified (2=boundary) and attached to the specified point id to the connectivity list
provided. (The id is the same as that specified in InsertPoint().)
obj.InitTetraTraversal () - Methods to get one tetra at a time. Start with InitTetraTraversal() and
then invoke GetNextTetra() until the method returns 0.
int = obj.GetNextTetra (int classification, vtkTetra tet, vtkDataArray
cellScalars, vtkDoubleArray tetScalars) - Methods to get one tetra at a time. Start with
InitTetraTraversal() and then invoke GetNextTetra() until the method returns 0. cellScalars are point-centered
scalars on the original cell. tetScalars are point-centered scalars on the tetra: the values will be copied from
cellScalars.
Precondition
tet_exists: tet!=0
cellScalars_exists: cellScalars!=0
tetScalars_exists: tetScalars!=0
tetScalars_valid_size: tetScalars->GetNumberOfTuples()==4
32.138
vtkOutEdgeIterator
32.138.1
Usage
vtkOutEdgeIterator iterates through all edges whose source is a particular vertex. Instantiate this class directly and
call Initialize() to traverse the vertex of a graph. Alternately, use GetInEdges() on the graph to initialize the iterator.
it->Next() returns a vtkOutEdgeType structure, which contains Id, the edges id, and Target, the edges target vertex.
To create an instance of class vtkOutEdgeIterator, simply invoke its constructor as follows
obj = vtkOutEdgeIterator
32.139 vtkParametricSpline
32.138.2
939
Methods
The class vtkOutEdgeIterator has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkOutEdgeIterator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkOutEdgeIterator = obj.NewInstance ()
vtkOutEdgeIterator = obj.SafeDownCast (vtkObject o)
obj.Initialize (vtkGraph g, vtkIdType v) - Initialize the iterator with a graph and vertex.
vtkGraph = obj.GetGraph () - Get the graph and vertex associated with this iterator.
vtkIdType = obj.GetVertex () - Get the graph and vertex associated with this iterator.
vtkGraphEdge = obj.NextGraphEdge () - Just like Next(), but returns heavy-weight vtkGraphEdge object instead of the vtkEdgeType struct, for use with wrappers. The graph edge is owned by this
iterator, and changes after each call to NextGraphEdge().
bool = obj.HasNext ()
32.139
vtkParametricSpline
32.139.1
Usage
vtkParametricSpline is a parametric function for 1D interpolating splines. vtkParametricSpline maps the single
parameter u into a 3D point (x,y,z) using three instances of interpolating splines. This family of 1D splines is
quaranteed to be parameterized in the interval [0,1]. Attempting to evaluate outside this interval will cause the
parameter u to be clamped in the range [0,1].
When constructed, this class creates instances of vtkCardinalSpline for each of the x-y-z coordinates. The user
may choose to replace these with their own instances of subclasses of vtkSpline.
To create an instance of class vtkParametricSpline, simply invoke its constructor as follows
obj = vtkParametricSpline
32.139.2
Methods
The class vtkParametricSpline has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricSpline class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkParametricSpline = obj.NewInstance ()
vtkParametricSpline = obj.SafeDownCast (vtkObject o)
int = obj.GetDimension () - Evaluate the spline at parametric coordinate u[0] returning the point
coordinate Pt[3].
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
940
32.139 vtkParametricSpline
941
942
32.140
vtkPassInputTypeAlgorithm
32.140.1
Usage
vtkPassInputTypeAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help
transition old algorithms to the new pipeline architecture. Ther are some assumptions and defaults made by this
class you should be aware of. This class defaults such that your filter will have one input port and one output port. If
that is not the case simply change it with SetNumberOfInputPorts etc. See this classes contstructor for the default.
This class also provides a FillInputPortInfo method that by default says that all inputs will be DataObject. If that isnt
the case then please override this method in your subclass. This class breaks out the downstream requests into
seperate functions such as RequestDataObject RequestData and RequestInformation. The default implementation
of RequestDataObject will create an output data of the same type as the input.
To create an instance of class vtkPassInputTypeAlgorithm, simply invoke its constructor as follows
obj = vtkPassInputTypeAlgorithm
32.140.2
Methods
The class vtkPassInputTypeAlgorithm has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPassInputTypeAlgorithm
class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.141 vtkPentagonalPrism
943
32.141
vtkPentagonalPrism
944
32.141.1
Usage
vtkPentagonalPrism is a concrete implementation of vtkCell to represent a linear 3D prism with pentagonal base.
Such prism is defined by the ten points (0-9) where (0,1,2,3,4) is the base of the prism which, using the right hand
rule, forms a pentagon whose normal points is in the direction of the opposite face (5,6,7,8,9).
To create an instance of class vtkPentagonalPrism, simply invoke its constructor as follows
obj = vtkPentagonalPrism
32.141.2
Methods
The class vtkPentagonalPrism has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkPentagonalPrism class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPentagonalPrism = obj.NewInstance ()
vtkPentagonalPrism = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell3D API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell3D API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell3D API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell3D API for descriptions of these methods.
vtkCell = obj.GetEdge (int edgeId) - See the vtkCell3D API for descriptions of these methods.
vtkCell = obj.GetFace (int faceId) - See the vtkCell3D API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell3D API for descriptions of these methods.
double derivs)
int = obj.GetParametricCenter (double pcoords[3]) - Return the center of the wedge
in parametric coordinates.
obj.InterpolateFunctions (double pcoords[3], double weights[10]) - Compute
the interpolation functions/derivatives (aka shape functions/derivatives)
obj.InterpolateDerivs (double pcoords[3], double derivs[30]) - Return the ids
of the vertices defining edge/face (edgeId/faceId). Ids are related to the cell, not to the dataset.
32.142
vtkPerlinNoise
32.142 vtkPerlinNoise
32.142.1
945
Usage
vtkPerlinNoise computes a Perlin noise field as an implicit function. vtkPerlinNoise is a concrete implementation of
vtkImplicitFunction. Perlin noise, originally described by Ken Perlin, is a non-periodic and continuous noise function
useful for modeling real-world objects.
The amplitude and frequency of the noise pattern are adjustable. This implementation of Perlin noise is derived
closely from Greg Wards version in Graphics Gems II.
To create an instance of class vtkPerlinNoise, simply invoke its constructor as follows
obj = vtkPerlinNoise
32.142.2
Methods
The class vtkPerlinNoise has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPerlinNoise class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPerlinNoise = obj.NewInstance ()
vtkPerlinNoise = obj.SafeDownCast (vtkObject o)
double = obj.EvaluateFunction (double x[3]) - Evaluate PerlinNoise function.
double = obj.EvaluateFunction (double x, double y, double z) - Evaluate PerlinNoise function.
obj.EvaluateGradient (double x[3], double n[3]) - Evaluate PerlinNoise gradient. Currently, the method returns a 0 gradient.
obj.SetFrequency (double , double , double ) - Set/get the frequency, or physical scale,
of the noise function (higher is finer scale). The frequency can be adjusted per axis, or the same for all axes.
obj.SetFrequency (double a[3]) - Set/get the frequency, or physical scale, of the noise function
(higher is finer scale). The frequency can be adjusted per axis, or the same for all axes.
double = obj. GetFrequency () - Set/get the frequency, or physical scale, of the noise function
(higher is finer scale). The frequency can be adjusted per axis, or the same for all axes.
obj.SetPhase (double , double , double ) - Set/get the phase of the noise function. This
parameter can be used to shift the noise function within space (perhaps to avoid a beat with a noise pattern
at another scale). Phase tends to repeat about every unit, so a phase of 0.5 is a half-cycle shift.
obj.SetPhase (double a[3]) - Set/get the phase of the noise function. This parameter can be used
to shift the noise function within space (perhaps to avoid a beat with a noise pattern at another scale). Phase
tends to repeat about every unit, so a phase of 0.5 is a half-cycle shift.
double = obj. GetPhase () - Set/get the phase of the noise function. This parameter can be used
to shift the noise function within space (perhaps to avoid a beat with a noise pattern at another scale). Phase
tends to repeat about every unit, so a phase of 0.5 is a half-cycle shift.
obj.SetAmplitude (double ) - Set/get the amplitude of the noise function. Amplitude can be negative. The noise function varies randomly between -|Amplitude| and |Amplitude|. Therefore the range of values
is 2|Amplitude| large. The initial amplitude is 1.
double = obj.GetAmplitude () - Set/get the amplitude of the noise function. Amplitude can be
negative. The noise function varies randomly between -|Amplitude| and |Amplitude|. Therefore the range of
values is 2|Amplitude| large. The initial amplitude is 1.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
946
32.143
vtkPiecewiseFunction
32.143.1
Usage
Defines a piecewise function mapping. This mapping allows the addition of control points, and allows the user to
control the function between the control points. A piecewise hermite curve is used between control points, based
on the sharpness and midpoint parameters. A sharpness of 0 yields a piecewise linear function and a sharpness
of 1 yields a piecewise constant function. The midpoint is the normalized distance between control points at which
the curve reaches the median Y value. The midpoint and sharpness values specified when adding a node are used
to control the transition to the next node (the last nodes values are ignored) Outside the range of nodes, the values
are 0 if Clamping is off, or the nearest node point if Clamping is on. Using the legacy methods for adding points
(which do not have Sharpness and Midpoint parameters) will default to Midpoint = 0.5 (halfway between the control
points) and Sharpness = 0.0 (linear).
To create an instance of class vtkPiecewiseFunction, simply invoke its constructor as follows
obj = vtkPiecewiseFunction
32.143.2
Methods
The class vtkPiecewiseFunction has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPiecewiseFunction class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPiecewiseFunction = obj.NewInstance ()
vtkPiecewiseFunction = obj.SafeDownCast (vtkObject o)
obj.DeepCopy (vtkDataObject f)
obj.ShallowCopy (vtkDataObject f)
int = obj.GetDataObjectType () - Return what type of dataset this is.
int = obj.GetSize () - Get the number of points used to specify the function
int = obj.AddPoint (double x, double y) - Add/Remove points to/from the function. If a
duplicate point is added then the function value is changed at that location. Return the index of the point (0
based), or -1 on error.
int = obj.AddPoint (double x, double y, double midpoint, double sharpness)
- Add/Remove points to/from the function. If a duplicate point is added then the function value is changed at
that location. Return the index of the point (0 based), or -1 on error.
int = obj.RemovePoint (double x) - Add/Remove points to/from the function. If a duplicate
point is added then the function value is changed at that location. Return the index of the point (0 based), or
-1 on error.
obj.RemoveAllPoints () - Removes all points from the function.
obj.AddSegment (double x1, double y1, double x2, double y2) - Add a line segment to the function. All points defined between the two points specified are removed from the function.
This is a legacy method that does not allow the specification of the sharpness and midpoint values for the two
nodes.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.143 vtkPiecewiseFunction
947
double = obj.GetValue (double x) - Returns the value of the function at the specified location
using the specified interpolation.
int = obj.GetNodeValue (int index, double val[4]) - For the node specified by index,
set/get the location (X), value (Y), midpoint, and sharpness values at the node.
int = obj.SetNodeValue (int index, double val[4]) - For the node specified by index,
set/get the location (X), value (Y), midpoint, and sharpness values at the node.
obj.FillFromDataPointer (int , double ) - Returns a pointer to the data stored in the table.
Fills from a pointer to data stored in a similar table. These are legacy methods which will be maintained
for compatibility - however, note that the vtkPiecewiseFunction no longer stores the nodes in a double array
internally.
double = obj.
GetRange () - Returns the min and max node locations of the function.
int = obj.AdjustRange (double range[2]) - Remove all points out of the new range, and
make sure there is a point at each end of that range. Return 1 on success, 0 otherwise.
obj.GetTable (double x1, double x2, int size, float table, int stride) Fills in an array of function values evaluated at regular intervals. Parameter "stride" is used to step through
the output "table".
obj.GetTable (double x1, double x2, int size, double table, int stride)
- Fills in an array of function values evaluated at regular intervals. Parameter "stride" is used to step through
the output "table".
obj.BuildFunctionFromTable (double x1, double x2, int size, double table,
int stride) - Constructs a piecewise function from a table. Function range is is set to [x1, x2], function
size is set to size, and function points are regularly spaced between x1 and x2. Parameter "stride" is is step
through the input table.
obj.SetClamping (int ) - When zero range clamping is Off, GetValue() returns 0.0 when a value is
requested outside of the points specified. When zero range clamping is On, GetValue() returns the value at
the value at the lowest point for a request below all points specified and returns the value at the highest point
for a request above all points specified. On is the default.
int = obj.GetClamping () - When zero range clamping is Off, GetValue() returns 0.0 when a value
is requested outside of the points specified. When zero range clamping is On, GetValue() returns the value
at the value at the lowest point for a request below all points specified and returns the value at the highest
point for a request above all points specified. On is the default.
obj.ClampingOn () - When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified. When zero range clamping is On, GetValue() returns the value at the
value at the lowest point for a request below all points specified and returns the value at the highest point for
a request above all points specified. On is the default.
obj.ClampingOff () - When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified. When zero range clamping is On, GetValue() returns the value at the
value at the lowest point for a request below all points specified and returns the value at the highest point for
a request above all points specified. On is the default.
string = obj.GetType () - Return the type of function: Function Types: 0 : Constant (No change in
slope between end points) 1 : NonDecreasing (Always increasing or zero slope) 2 : NonIncreasing (Always
decreasing or zero slope) 3 : Varied (Contains both decreasing and increasing slopes)
double = obj.GetFirstNonZeroValue () - Returns the first point location which precedes a
non-zero segment of the function. Note that the value at this point may be zero.
obj.Initialize () - Clears out the current function. A newly created vtkPiecewiseFunction is alreay
initialized, so there is no need to call this method which in turn simply calls RemoveAllPoints()
obj.SetAllowDuplicateScalars (int ) - Toggle whether to allow duplicate scalar values in the
piecewise function (off by default).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
948
32.144
vtkPiecewiseFunctionAlgorithm
32.144.1
Usage
32.144.2
Methods
The class vtkPiecewiseFunctionAlgorithm has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPiecewiseFunctionAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPiecewiseFunctionAlgorithm = obj.NewInstance ()
vtkPiecewiseFunctionAlgorithm = obj.SafeDownCast (vtkObject o)
vtkDataObject = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkDataObject = obj.GetOutput (int ) - Get the output data object for a port on this algorithm.
obj.SetOutput (vtkDataObject d) - Get the output data object for a port on this algorithm.
vtkDataObject = obj.GetInput ()
vtkDataObject = obj.GetInput (int port)
obj.SetInput (vtkDataObject ) - Set an input of this algorithm. You should not override these
methods because they are not the only way to connect a pipeline. Note that these methods support oldstyle pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection
within a single port.
obj.SetInput (int , vtkDataObject ) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
obj.AddInput (vtkDataObject ) - Add an input of this algorithm. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.145 vtkPiecewiseFunctionShiftScale
949
obj.AddInput (int , vtkDataObject ) - Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
32.145
vtkPiecewiseFunctionShiftScale
32.145.1
Usage
32.145.2
Methods
The class vtkPiecewiseFunctionShiftScale has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPiecewiseFunctionShiftScale class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPiecewiseFunctionShiftScale = obj.NewInstance ()
vtkPiecewiseFunctionShiftScale = obj.SafeDownCast (vtkObject o)
obj.SetPositionShift (double )
obj.SetPositionScale (double )
obj.SetValueShift (double )
obj.SetValueScale (double )
double = obj.GetPositionShift ()
double = obj.GetPositionScale ()
double = obj.GetValueShift ()
double = obj.GetValueScale ()
32.146
vtkPixel
32.146.1
Usage
vtkPixel is a concrete implementation of vtkCell to represent a 2D orthogonal quadrilateral. Unlike vtkQuad, the
corners are at right angles, and aligned along x-y-z coordinate axes leading to large increases in computational
efficiency.
To create an instance of class vtkPixel, simply invoke its constructor as follows
obj = vtkPixel
950
32.146.2
Methods
The class vtkPixel has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPixel class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPixel = obj.NewInstance ()
vtkPixel = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int edgeId) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int ) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
double derivs)
obj.InterpolateFunctions (double pcoords[3], double weights[4]) - Compute
the interpolation functions/derivatives (aka shape functions/derivatives)
obj.InterpolateDerivs (double pcoords[3], double derivs[8])
32.147
vtkPlanesIntersection
32.148 vtkPointData
32.147.1
951
Usage
A subclass of vtkPlanes, this class determines whether it intersects an axis aligned box. This is motivated by the
need to intersect the axis aligned region of a spacial decomposition of volume data with various other regions. It
uses the algorithm from Graphics Gems IV, page 81.
.SECTION Caveat An instance of vtkPlanes can be redefined by changing the planes, but this subclass then will
not know if the region vertices are up to date. (Region vertices can be specified in SetRegionVertices or computed
by the subclass.) So Delete and recreate if you want to change the set of planes.
To create an instance of class vtkPlanesIntersection, simply invoke its constructor as follows
obj = vtkPlanesIntersection
32.147.2
Methods
The class vtkPlanesIntersection has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPlanesIntersection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPlanesIntersection = obj.NewInstance ()
vtkPlanesIntersection = obj.SafeDownCast (vtkObject o)
obj.SetRegionVertices (vtkPoints pts)
obj.SetRegionVertices (double v, int nvertices)
int = obj.GetNumRegionVertices ()
int = obj.GetRegionVertices (double v, int nvertices)
int = obj.IntersectsRegion (vtkPoints R)
32.148
vtkPointData
32.148.1
Usage
vtkPointData is a class that is used to represent and manipulate point attribute data (e.g., scalars, vectors, normals,
texture coordinates, etc.) Most of the functionality is handled by vtkDataSetAttributes
To create an instance of class vtkPointData, simply invoke its constructor as follows
obj = vtkPointData
32.148.2
Methods
The class vtkPointData has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPointData class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
952
32.149
vtkPointLocator
32.149.1
Usage
vtkPointLocator is a spatial search object to quickly locate points in 3D. vtkPointLocator works by dividing a specified
region of space into a regular array of "rectangular" buckets, and then keeping a list of points that lie in each bucket.
Typical operation involves giving a position in 3D and finding the closest point.
vtkPointLocator has two distinct methods of interaction. In the first method, you supply it with a dataset, and it
operates on the points in the dataset. In the second method, you supply it with an array of points, and the object
operates on the array.
To create an instance of class vtkPointLocator, simply invoke its constructor as follows
obj = vtkPointLocator
32.149.2
Methods
The class vtkPointLocator has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkPointLocator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPointLocator = obj.NewInstance ()
vtkPointLocator = obj.SafeDownCast (vtkObject o)
obj.SetDivisions (int , int , int ) - Set the number of divisions in x-y-z directions.
obj.SetDivisions (int a[3]) - Set the number of divisions in x-y-z directions.
int = obj.
32.149 vtkPointLocator
953
954
32.150
vtkPointSet
32.150.1
Usage
vtkPointSet is an abstract class that specifies the interface for datasets that explicitly use "point" arrays to represent
geometry. For example, vtkPolyData and vtkUnstructuredGrid require point arrays to specify point position, while
vtkStructuredPoints generates point positions implicitly.
To create an instance of class vtkPointSet, simply invoke its constructor as follows
obj = vtkPointSet
32.150.2
Methods
The class vtkPointSet has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPointSet class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPointSet = obj.NewInstance ()
vtkPointSet = obj.SafeDownCast (vtkObject o)
obj.Initialize () - Reset to an empty state and free any memory.
obj.CopyStructure (vtkDataSet pd) - Copy the geometric structure of an input point set object.
vtkIdType = obj.GetNumberOfPoints () - See vtkDataSet for additional information.
double = obj.GetPoint (vtkIdType ptId) - See vtkDataSet for additional information.
obj.GetPoint (vtkIdType ptId, double x[3]) - See vtkDataSet for additional information.
vtkIdType = obj.FindPoint (double x[3]) - See vtkDataSet for additional information.
vtkIdType = obj.FindPoint (double x, double y, double z) - See vtkDataSet for
additional information.
long = obj.GetMTime () - Get MTime which also considers its vtkPoints MTime.
obj.ComputeBounds () - Compute the (X, Y, Z) bounds of the data.
obj.Squeeze () - Reclaim any unused memory.
obj.SetPoints (vtkPoints ) - Specify point array to define point coordinates.
vtkPoints = obj.GetPoints () - Specify point array to define point coordinates.
long = obj.GetActualMemorySize () - Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than
or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the
return value). THIS METHOD IS THREAD SAFE.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.151 vtkPointSetAlgorithm
955
32.151
vtkPointSetAlgorithm
32.151.1
Usage
vtkPointSetAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition
old algorithms to the new pipeline architecture. Ther are some assumptions and defaults made by this class you
should be aware of. This class defaults such that your filter will have one input port and one output port. If that
is not the case simply change it with SetNumberOfInputPorts etc. See this classes contstructor for the default.
This class also provides a FillInputPortInfo method that by default says that all inputs will be PointSet. If that isnt
the case then please override this method in your subclass. This class breaks out the downstream requests into
seperate functions such as RequestDataObject RequestData and ExecuteInformation. The default implementation
of RequestDataObject will create an output data of the same type as the input.
To create an instance of class vtkPointSetAlgorithm, simply invoke its constructor as follows
obj = vtkPointSetAlgorithm
32.151.2
Methods
The class vtkPointSetAlgorithm has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkPointSetAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPointSetAlgorithm = obj.NewInstance ()
vtkPointSetAlgorithm = obj.SafeDownCast (vtkObject o)
vtkPointSet = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkPointSet = obj.GetOutput (int ) - Get the output data object for a port on this algorithm.
vtkPolyData = obj.GetPolyDataOutput () - Get the output as vtkPolyData.
vtkStructuredGrid = obj.GetStructuredGridOutput () - Get the output as vtkStructuredGrid.
vtkUnstructuredGrid = obj.GetUnstructuredGridOutput () - Get the output as vtkUnstructuredGrid.
obj.SetInput (vtkDataObject ) - Set an input of this algorithm. You should not override these
methods because they are not the only way to connect a pipeline. Note that these methods support oldstyle pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection
within a single port.
obj.SetInput (int , vtkDataObject ) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
956
32.152
vtkPointSetSource
32.152.1
Usage
32.152.2
Methods
The class vtkPointSetSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkPointSetSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPointSetSource = obj.NewInstance ()
vtkPointSetSource = obj.SafeDownCast (vtkObject o)
vtkPointSet = obj.GetOutput () - Get the output of this source.
vtkPointSet = obj.GetOutput (int idx) - Get the output of this source.
obj.SetOutput (vtkPointSet output) - Get the output of this source.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.153 vtkPointSetToPointSetFilter
32.153
957
vtkPointSetToPointSetFilter
32.153.1
Usage
vtkPointSetToPointSetFilter is an abstract filter class whose subclasses take as input a point set and generates
a point set on output. At a minimum, the concrete subclasses of vtkPointSetToPointSetFilter modify their point
coordinates. They never modify their topological form, however.
This is an abstract filter type. What that means is that the output of the filter is an abstract type (i.e., vtkPointSet),
no matter what the input of the filter is. This can cause problems connecting together filters due to the change
in dataset type. (For example, in a series of filters processing vtkPolyData, when a vtkPointSetToPointSetFilter
or subclass is introduced into the pipeline, if the filter downstream of it takes vtkPolyData as input, the pipeline
connection cannot be made.) To get around this problem, use one of the convenience methods to return a concrete
type (e.g., vtkGetPolyDataOutput(), GetStructuredGridOutput(), etc.).
To create an instance of class vtkPointSetToPointSetFilter, simply invoke its constructor as follows
obj = vtkPointSetToPointSetFilter
32.153.2
Methods
The class vtkPointSetToPointSetFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPointSetToPointSetFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPointSetToPointSetFilter = obj.NewInstance ()
vtkPointSetToPointSetFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkPointSet input) - Specify the input data or filter.
vtkPointSet = obj.GetInput () - Get the input data or filter.
vtkPointSet = obj.GetOutput () - Get the output of this filter. If output is NULL, then input hasnt
been set, which is necessary for abstract filter objects.
vtkPointSet = obj.GetOutput (int idx) - Get the output as vtkPolyData. Performs run-time
checking.
vtkPolyData = obj.GetPolyDataOutput () - Get the output as vtkPolyData. Performs run-time
checking.
vtkStructuredGrid = obj.GetStructuredGridOutput () - Get the output as vtkStructuredGrid. Performs run-time checking.
vtkUnstructuredGrid = obj.GetUnstructuredGridOutput () - Get the output as vtkUnstructuredGrid. Performs run-time checking.
obj.ComputeInputUpdateExtents (vtkDataObject output) - By default copy the output
update extent to the input
32.154
vtkPointsProjectedHull
958
32.154.1
Usage
a subclass of vtkPoints, it maintains the counter clockwise convex hull of the points (projected orthogonally in the
three coordinate directions) and has a method to test for intersection of that hull with an axis aligned rectangle. This
is used for intersection tests of 3D volumes.
To create an instance of class vtkPointsProjectedHull, simply invoke its constructor as follows
obj = vtkPointsProjectedHull
32.154.2
Methods
The class vtkPointsProjectedHull has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPointsProjectedHull class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPointsProjectedHull = obj.NewInstance ()
vtkPointsProjectedHull = obj.SafeDownCast (vtkObject o)
int = obj.RectangleIntersectionX (vtkPoints R)
int = obj.RectangleIntersectionX (float ymin, float ymax, float zmin,
float zmax)
int = obj.RectangleIntersectionX (double ymin, double ymax, double zmin,
double zmax)
int = obj.RectangleIntersectionY (vtkPoints R)
int = obj.RectangleIntersectionY (float zmin, float zmax, float xmin,
float xmax)
int = obj.RectangleIntersectionY (double zmin, double zmax, double xmin,
double xmax)
int = obj.RectangleIntersectionZ (vtkPoints R)
int = obj.RectangleIntersectionZ (float xmin, float xmax, float ymin,
float ymax)
int = obj.RectangleIntersectionZ (double xmin, double xmax, double ymin,
double ymax)
int = obj.GetCCWHullX (float pts, int len)
int = obj.GetCCWHullX (double pts, int len)
int = obj.GetCCWHullY (float pts, int len)
int = obj.GetCCWHullY (double pts, int len)
int = obj.GetCCWHullZ (float pts, int len)
int = obj.GetCCWHullZ (double pts, int len)
int = obj.GetSizeCCWHullX ()
int = obj.GetSizeCCWHullY ()
int = obj.GetSizeCCWHullZ ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.155 vtkPolyData
959
obj.Initialize ()
obj.Reset ()
obj.Update ()
32.155
vtkPolyData
32.155.1
Usage
vtkPolyData is a data object that is a concrete implementation of vtkDataSet. vtkPolyData represents a geometric
structure consisting of vertices, lines, polygons, and/or triangle strips. Point and cell attribute values (e.g., scalars,
vectors, etc.) also are represented.
The actual cell types (vtkCellType.h) supported by vtkPolyData are: vtkVertex, vtkPolyVertex, vtkLine, vtkPolyLine,
vtkTriangle, vtkQuad, vtkPolygon, and vtkTriangleStrip.
One important feature of vtkPolyData objects is that special traversal and data manipulation methods are available to
process data. These methods are generally more efficient than vtkDataSet methods and should be used whenever
possible. For example, traversing the cells in a dataset we would use GetCell(). To traverse cells with vtkPolyData we would retrieve the cell array object representing polygons (for example using GetPolys()) and then use
vtkCellArrays InitTraversal() and GetNextCell() methods.
To create an instance of class vtkPolyData, simply invoke its constructor as follows
obj = vtkPolyData
32.155.2
Methods
The class vtkPolyData has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPolyData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPolyData = obj.NewInstance ()
vtkPolyData = obj.SafeDownCast (vtkObject o)
int = obj.GetDataObjectType () - Copy the geometric and topological structure of an input poly
data object.
obj.CopyStructure (vtkDataSet ds) - Copy the geometric and topological structure of an input
poly data object.
vtkIdType = obj.GetNumberOfCells () - Standard vtkDataSet interface.
vtkCell = obj.GetCell (vtkIdType cellId) - Standard vtkDataSet interface.
obj.GetCell (vtkIdType cellId, vtkGenericCell cell) - Standard vtkDataSet interface.
int = obj.GetCellType (vtkIdType cellId) - Standard vtkDataSet interface.
obj.GetCellBounds (vtkIdType cellId, double bounds[6]) - Standard vtkDataSet interface.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
960
32.155 vtkPolyData
961
int = obj.InsertNextCell (int type, vtkIdList pts) - Insert a cell of type VTK_VERTEX, VTK_POLY_VERTEX, VTK_LINE, VTK_POLY_LINE, VTK_TRIANGLE, VTK_QUAD, VTK_POLYGON, or VTK_TRIANGLE_STRIP. Make sure that the PolyData::Allocate() function has been called first or that
vertex, line, polygon, and triangle strip arrays have been supplied. Note: will also insert VTK_PIXEL, but
converts it to VTK_QUAD.
obj.Reset () - Begin inserting data all over again. Memory is not freed but otherwise objects are returned to their initial state.
obj.BuildCells () - Create data structure that allows random access of cells.
obj.BuildLinks (int initialSize) - Create upward links from points to cells that use each
point. Enables topologically complex queries. Normally the links array is allocated based on the number
of points in the vtkPolyData. The optional initialSize parameter can be used to allocate a larger size initially.
obj.DeleteCells () - Release data structure that allows random access of the cells. This must be
done before a 2nd call to BuildLinks(). DeleteCells implicitly deletes the links as well since they are no longer
valid.
obj.DeleteLinks () - Release the upward links from point to cells that use each point.
obj.GetCellEdgeNeighbors (vtkIdType cellId, vtkIdType p1, vtkIdType p2,
vtkIdList cellIds) - Get the neighbors at an edge. More efficient than the general GetCellNeighbors(). Assumes links have been built (with BuildLinks()), and looks specifically for edge neighbors.
int = obj.IsTriangle (int v1, int v2, int v3) - Given three vertices, determine
whether its a triangle. Make sure BuildLinks() has been called first.
int = obj.IsEdge (vtkIdType p1, vtkIdType p2) - Determine whether two points form an
edge. If they do, return non-zero. By definition PolyVertex and PolyLine have no edges since 1-dimensional
edges are only found on cells 2D and higher. Edges are defined as 1-D boundary entities to cells. Make sure
BuildLinks() has been called first.
int = obj.IsPointUsedByCell (vtkIdType ptId, vtkIdType cellId) - Determine
whether a point is used by a particular cell. If it is, return non-zero. Make sure BuildCells() has been called
first.
obj.ReplaceCellPoint (vtkIdType cellId, vtkIdType oldPtId, vtkIdType
newPtId) - Replace a point in the cell connectivity list with a different point.
obj.ReverseCell (vtkIdType cellId) - Reverse the order of point ids defining the cell.
obj.DeletePoint (vtkIdType ptId) - Mark a point/cell as deleted from this vtkPolyData.
obj.DeleteCell (vtkIdType cellId) - Mark a point/cell as deleted from this vtkPolyData.
obj.RemoveDeletedCells () - The cells marked by calls to DeleteCell are stored in the Cell Array
VTK_EMPTY_CELL, but they still exist in the polys array. Calling RemoveDeletedCells will travers the poly
array and remove/compact the cell array as well as any cell data thus truly removing the cells from the polydata
object. WARNING. This only handles the polys at the moment
int = obj.InsertNextLinkedPoint (int numLinks) - Add a point to the cell data structure
(after cell pointers have been built). This method adds the point and then allocates memory for the links to
the cells. (To use this method, make sure points are available and BuildLinks() has been invoked.) Of the two
methods below, one inserts a point coordinate and the other just makes room for cell links.
int = obj.InsertNextLinkedPoint (double x[3], int numLinks) - Add a point to the
cell data structure (after cell pointers have been built). This method adds the point and then allocates memory
for the links to the cells. (To use this method, make sure points are available and BuildLinks() has been
invoked.) Of the two methods below, one inserts a point coordinate and the other just makes room for cell
links.
obj.RemoveCellReference (vtkIdType cellId) - Remove all references to cell in cell structure. This means the links from the cells points to the cell are deleted. Memory is not reclaimed. Use
the method ResizeCellList() to resize the link list from a point to its using cells. (This operator assumes
BuildLinks() has been called.)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
962
32.156 vtkPolyDataAlgorithm
963
the index) vtkPolyData::ERR_INCORRECT_FIELD: the number of entries in the scalar field array is different
form the number of vertices in the mesh. vtkPolyData::ERR_NO_SUCH_FIELD: the specified scalar field
does not exist.
int = obj.GetScalarFieldCriticalIndex (vtkIdType pointId, string fieldName) - Scalar field critical point classification (for manifold 2D meshes). Reference: J. Milnor "Morse
Theory", Princeton University Press, 1963.
Given a pointId and an attribute representing a scalar field, this member returns the index of the critical point:
vtkPolyData::MINIMUM (index 0): local minimum; vtkPolyData::SADDLE (index 1): local saddle; vtkPolyData::MAXIMUM (index 2): local maximum.
Other returned values are: vtkPolyData::REGULAR_POINT: regular point (the gradient does not vanish); vtkPolyData::ERR_NON_MANIFOLD_STAR: the star of the considered vertex is not manifold (could not evaluate
the index) vtkPolyData::ERR_INCORRECT_FIELD: the number of entries in the scalar field array is different
form the number of vertices in the mesh. vtkPolyData::ERR_NO_SUCH_FIELD: the specified scalar field
does not exist.
32.156
vtkPolyDataAlgorithm
32.156.1
Usage
32.156.2
Methods
The class vtkPolyDataAlgorithm has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPolyDataAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPolyDataAlgorithm = obj.NewInstance ()
vtkPolyDataAlgorithm = obj.SafeDownCast (vtkObject o)
vtkPolyData = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkPolyData = obj.GetOutput (int ) - Get the output data object for a port on this algorithm.
obj.SetOutput (vtkDataObject d) - Get the output data object for a port on this algorithm.
vtkDataObject = obj.GetInput ()
vtkDataObject = obj.GetInput (int port)
vtkPolyData = obj.GetPolyDataInput (int port)
obj.SetInput (vtkDataObject ) - Set an input of this algorithm. You should not override these
methods because they are not the only way to connect a pipeline. Note that these methods support oldstyle pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection
within a single port.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
964
32.157
vtkPolyDataCollection
32.157.1
Usage
vtkPolyDataCollection is an object that creates and manipulates lists of datasets of type vtkPolyData.
To create an instance of class vtkPolyDataCollection, simply invoke its constructor as follows
obj = vtkPolyDataCollection
32.157.2
Methods
The class vtkPolyDataCollection has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPolyDataCollection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPolyDataCollection = obj.NewInstance ()
vtkPolyDataCollection = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkPolyData pd) - Get the next poly data in the list.
vtkPolyData = obj.GetNextItem () - Get the next poly data in the list.
32.158
vtkPolyDataSource
32.158.1
Usage
32.159 vtkPolyDataToPolyDataFilter
32.158.2
965
Methods
The class vtkPolyDataSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkPolyDataSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPolyDataSource = obj.NewInstance ()
vtkPolyDataSource = obj.SafeDownCast (vtkObject o)
vtkPolyData = obj.GetOutput () - Get the output of this source.
vtkPolyData = obj.GetOutput (int idx) - Get the output of this source.
obj.SetOutput (vtkPolyData output) - Get the output of this source.
32.159
vtkPolyDataToPolyDataFilter
32.159.1
Usage
vtkPolyDataToPolyDataFilter is an abstract filter class whose subclasses take as input polygonal data and generate
polygonal data on output. .SECTION Warning This used to be the parent class for most polydata filter in VTK4.x,
now this role has been replaced by vtkPolyDataAlgorithm. You should consider using vtkPolyDataAlgorithm instead
of this class, when writing filter for VTK5 and above. This class was kept to ensure full backward compatibility.
To create an instance of class vtkPolyDataToPolyDataFilter, simply invoke its constructor as follows
obj = vtkPolyDataToPolyDataFilter
32.159.2
Methods
The class vtkPolyDataToPolyDataFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPolyDataToPolyDataFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPolyDataToPolyDataFilter = obj.NewInstance ()
vtkPolyDataToPolyDataFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkPolyData input) - Set / get the input data or filter.
vtkPolyData = obj.GetInput () - Set / get the input data or filter.
32.160
vtkPolygon
966
32.160.1
Usage
vtkPolygon is a concrete implementation of vtkCell to represent a 2D n-sided polygon. The polygons cannot have
any internal holes, and cannot self-intersect. Define the polygon with n-points ordered in the counter- clockwise
direction; do not repeat the last point.
To create an instance of class vtkPolygon, simply invoke its constructor as follows
obj = vtkPolygon
32.160.2
Methods
The class vtkPolygon has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPolygon class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPolygon = obj.NewInstance ()
vtkPolygon = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int edgeId) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int ) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.161 vtkPolyLine
967
obj.InterpolateFunctions (double pcoords[3], double sf) - Compute the interpolation functions/derivatives (aka shape functions/derivatives)
obj.InterpolateDerivs (double pcoords[3], double derivs) - Compute the interpolation functions/derivatives (aka shape functions/derivatives)
obj.ComputeWeights (double x[3], double weights) - Compute interpolation weights using 1/r2 normalized sum.
32.161
vtkPolyLine
32.161.1
Usage
32.161.2
Methods
The class vtkPolyLine has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPolyLine class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPolyLine = obj.NewInstance ()
vtkPolyLine = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int ) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int ) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
968
32.162
vtkPolyVertex
32.162.1
Usage
32.162.2
Methods
The class vtkPolyVertex has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPolyVertex class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPolyVertex = obj.NewInstance ()
vtkPolyVertex = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int ) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int ) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.163 vtkProcessObject
969
32.163
vtkProcessObject
32.163.1
Usage
vtkProcessObject is an abstract object that specifies behavior and interface of visualization network process objects
(sources, filters, mappers). Source objects are creators of visualization data; filters input, process, and output
visualization data; and mappers transform data into another form (like rendering primitives or write data to a file).
vtkProcessObject fires events for Start and End events before and after object execution (via Execute()). These
events can be used for any purpose (e.g., debugging info, highlighting/notifying user interface, etc.)
Another event, Progress, can be observed. Some filters fire this event periodically during their execution. The use
is similar to that of Start and End events. Filters may also check their AbortExecute flag to determine whether to
prematurely end their execution.
An important feature of subclasses of vtkProcessObject is that it is possible to control the memory-management
model (i.e., retain output versus delete output data). If enabled the ReleaseDataFlag enables the deletion of the
output data once the downstream process object finishes processing the data (please see text).
To create an instance of class vtkProcessObject, simply invoke its constructor as follows
obj = vtkProcessObject
32.163.2
Methods
The class vtkProcessObject has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkProcessObject class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkProcessObject = obj.NewInstance ()
vtkProcessObject = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
970
Reimplemented
from
vtk-
Reimplemented
from
-
vtk-
Reimple-
32.164
Reimplemented
from
vtk-
vtkPropAssembly
32.164.1
Usage
vtkPropAssembly is an object that groups props and other prop assemblies into a tree-like hierarchy. The props can
then be treated as a group (e.g., turning visibility on and off).
A vtkPropAssembly object can be used in place of an vtkProp since it is a subclass of vtkProp. The difference is that
vtkPropAssembly maintains a list of other prop and prop assembly instances (its "parts") that form the assembly.
Note that this process is recursive: you can create groups consisting of prop assemblies to arbitrary depth.
vtkPropAssemblys and vtkProps that compose a prop assembly need not be added to a renderers list of props,
as long as the parent assembly is in the prop list. This is because they are automatically renderered during the
hierarchical traversal process.
To create an instance of class vtkPropAssembly, simply invoke its constructor as follows
obj = vtkPropAssembly
32.164.2
Methods
The class vtkPropAssembly has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkPropAssembly class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPropAssembly = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.165 vtkPyramid
971
32.165
vtkPyramid
972
32.165.1
Usage
32.165.2
Methods
The class vtkPyramid has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPyramid class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPyramid = obj.NewInstance ()
vtkPyramid = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int edgeId) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int faceId) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts) - See the
vtkCell API for descriptions of these methods.
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs) - See the vtkCell API for descriptions of these methods.
int = obj.GetParametricCenter (double pcoords[3]) - Return the center of the pyramid
in parametric coordinates.
obj.InterpolateFunctions (double pcoords[3], double weights[5]) - Compute
the interpolation functions/derivatives (aka shape functions/derivatives)
obj.InterpolateDerivs (double pcoords[3], double derivs[15])
32.166
vtkQuad
32.166 vtkQuad
32.166.1
973
Usage
vtkQuad is a concrete implementation of vtkCell to represent a 2D quadrilateral. vtkQuad is defined by the four
points (0,1,2,3) in counterclockwise order. vtkQuad uses the standard isoparametric interpolation functions for a
linear quadrilateral.
To create an instance of class vtkQuad, simply invoke its constructor as follows
obj = vtkQuad
32.166.2
Methods
The class vtkQuad has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkQuad class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuad = obj.NewInstance ()
vtkQuad = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int edgeId) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int ) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts) - See the
vtkCell API for descriptions of these methods.
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs) - See the vtkCell API for descriptions of these methods.
int = obj.GetParametricCenter (double pcoords[3]) - Return the center of the triangle
in parametric coordinates.
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
974
32.167
vtkQuadraticEdge
32.167.1
Usage
32.167.2
Methods
The class vtkQuadraticEdge has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadraticEdge class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuadraticEdge = obj.NewInstance ()
vtkQuadraticEdge = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - Implement the vtkCell API. See the vtkCell API for descriptions of these
methods.
int = obj.GetCellDimension () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfEdges () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfFaces () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetEdge (int ) - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetFace (int )
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
obj.Contour (double value, vtkDataArray cellScalars, vtkIncremental-
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.168 vtkQuadraticHexahedron
975
32.168
vtkQuadraticHexahedron
32.168.1
Usage
vtkQuadraticHexahedron is a concrete implementation of vtkNonLinearCell to represent a three-dimensional, 20node isoparametric parabolic hexahedron. The interpolation is the standard finite element, quadratic isoparametric
shape function. The cell includes a mid-edge node. The ordering of the twenty points defining the cell is point ids
(0-7,8-19) where point ids 0-7 are the eight corner vertices of the cube; followed by twelve midedge nodes (8-19).
Note that these midedge nodes correspond lie on the edges defined by (0,1), (1,2), (2,3), (3,0), (4,5), (5,6), (6,7),
(7,4), (0,4), (1,5), (2,6), (3,7).
To create an instance of class vtkQuadraticHexahedron, simply invoke its constructor as follows
obj = vtkQuadraticHexahedron
32.168.2
Methods
The class vtkQuadraticHexahedron has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadraticHexahedron
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuadraticHexahedron = obj.NewInstance ()
vtkQuadraticHexahedron = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - Implement the vtkCell API. See the vtkCell API for descriptions of these
methods.
int = obj.GetCellDimension () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfEdges () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfFaces () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetEdge (int ) - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetFace (int ) - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
976
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.169
vtkQuadraticLinearQuad
32.169.1
Usage
32.169.2
Methods
The class vtkQuadraticLinearQuad has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadraticLinearQuad
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuadraticLinearQuad = obj.NewInstance ()
vtkQuadraticLinearQuad = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - Implement the vtkCell API. See the vtkCell API for descriptions of these
methods.
int = obj.GetCellDimension () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.170 vtkQuadraticLinearWedge
977
int = obj.GetNumberOfEdges () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfFaces () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetEdge (int ) - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetFace (int )
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
obj.Contour (double value, vtkDataArray cellScalars, vtkIncremental-
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.170
vtkQuadraticLinearWedge
32.170.1
Usage
vtkQuadraticLinearWedge is a concrete implementation of vtkNonLinearCell to represent a three-dimensional, 12node isoparametric linear quadratic wedge. The interpolation is the standard finite element, quadratic isoparametric
shape function in xy - layer and the linear functions in z - direction. The cell includes mid-edge node in the triangle
edges. The ordering of the 12 points defining the cell is point ids (0-5,6-12) where point ids 0-5 are the six corner
vertices of the wedge; followed by six midedge nodes (6-12). Note that these midedge nodes correspond lie on the
edges defined by (0,1), (1,2), (2,0), (3,4), (4,5), (5,3). The Edges (0,3), (1,4), (2,5) dont have midedge nodes.
To create an instance of class vtkQuadraticLinearWedge, simply invoke its constructor as follows
obj = vtkQuadraticLinearWedge
978
32.170.2
Methods
The class vtkQuadraticLinearWedge has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadraticLinearWedge
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuadraticLinearWedge = obj.NewInstance ()
vtkQuadraticLinearWedge = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - Implement the vtkCell API. See the vtkCell API for descriptions of these
methods.
int = obj.GetCellDimension () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfEdges () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfFaces () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetEdge (int edgeId) - Implement the vtkCell API. See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int faceId) - Implement the vtkCell API. See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
obj.Contour (double value, vtkDataArray cellScalars, vtkIncremental-
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - The quadratic linear wege is splitted into 4 linear
wedges, each of them is contoured by a provided scalar value
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts) - The
quadratic linear wege is splitted into 4 linear wedges, each of them is contoured by a provided scalar value
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs) - The quadratic linear wege is splitted into 4 linear wedges, each of them is contoured
by a provided scalar value
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.171 vtkQuadraticPyramid
32.171
979
vtkQuadraticPyramid
32.171.1
Usage
32.171.2
Methods
The class vtkQuadraticPyramid has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadraticPyramid class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuadraticPyramid = obj.NewInstance ()
vtkQuadraticPyramid = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - Implement the vtkCell API. See the vtkCell API for descriptions of these
methods.
int = obj.GetCellDimension () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfEdges () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfFaces () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetEdge (int edgeId) - Implement the vtkCell API. See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int faceId) - Implement the vtkCell API. See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
obj.Contour (double value, vtkDataArray cellScalars, vtkIncremental-
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
980
32.172
vtkQuadraticQuad
32.172.1
Usage
32.172.2
Methods
The class vtkQuadraticQuad has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadraticQuad class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuadraticQuad = obj.NewInstance ()
vtkQuadraticQuad = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - Implement the vtkCell API. See the vtkCell API for descriptions of these
methods.
int = obj.GetCellDimension () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfEdges () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfFaces () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetEdge (int ) - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.173 vtkQuadraticTetra
981
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.173
vtkQuadraticTetra
32.173.1
Usage
32.173.2
Methods
The class vtkQuadraticTetra has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadraticTetra class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuadraticTetra = obj.NewInstance ()
vtkQuadraticTetra = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - Implement the vtkCell API. See the vtkCell API for descriptions of these
methods.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
982
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.174
vtkQuadraticTriangle
32.174.1
Usage
32.175 vtkQuadraticWedge
32.174.2
983
Methods
The class vtkQuadraticTriangle has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadraticTriangle class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuadraticTriangle = obj.NewInstance ()
vtkQuadraticTriangle = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - Implement the vtkCell API. See the vtkCell API for descriptions of these
methods.
int = obj.GetCellDimension () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfEdges () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfFaces () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetEdge (int edgeId) - Implement the vtkCell API. See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int )
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
obj.Contour (double value, vtkDataArray cellScalars, vtkIncremental-
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.175
vtkQuadraticWedge
984
32.175.1
Usage
32.175.2
Methods
The class vtkQuadraticWedge has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadraticWedge class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuadraticWedge = obj.NewInstance ()
vtkQuadraticWedge = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - Implement the vtkCell API. See the vtkCell API for descriptions of these
methods.
int = obj.GetCellDimension () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfEdges () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfFaces () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetEdge (int edgeId) - Implement the vtkCell API. See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int faceId) - Implement the vtkCell API. See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
obj.Contour (double value, vtkDataArray cellScalars, vtkIncremental-
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.176 vtkRectilinearGrid
985
32.176
vtkRectilinearGrid
32.176.1
Usage
32.176.2
Methods
The class vtkRectilinearGrid has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkRectilinearGrid class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRectilinearGrid = obj.NewInstance ()
vtkRectilinearGrid = obj.SafeDownCast (vtkObject o)
int = obj.GetDataObjectType () - Return what type of dataset this is.
obj.CopyStructure (vtkDataSet ds) - Copy the geometric and topological structure of an input
rectilinear grid object.
obj.Initialize () - Restore object to initial state. Release memory back to system.
vtkIdType = obj.GetNumberOfCells () - Standard vtkDataSet API methods. See vtkDataSet
for more information.
vtkIdType = obj.GetNumberOfPoints () - Standard vtkDataSet API methods. See vtkDataSet
for more information.
double = obj.GetPoint (vtkIdType ptId) - Standard vtkDataSet API methods. See vtkDataSet for more information.
obj.GetPoint (vtkIdType id, double x[3]) - Standard vtkDataSet API methods. See vtkDataSet for more information.
vtkCell = obj.GetCell (vtkIdType cellId) - Standard vtkDataSet API methods. See vtkDataSet for more information.
obj.GetCell (vtkIdType cellId, vtkGenericCell cell) - Standard vtkDataSet API
methods. See vtkDataSet for more information.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
986
32.177 vtkRectilinearGridAlgorithm
987
int = obj. GetExtent () - Different ways to set the extent of the data array. The extent should be
set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).
long = obj.GetActualMemorySize () - Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than
or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the
return value). THIS METHOD IS THREAD SAFE.
obj.ShallowCopy (vtkDataObject src) - Shallow and Deep copy.
obj.DeepCopy (vtkDataObject src) - Shallow and Deep copy.
int = obj.GetExtentType () - Structured extent. The extent type is a 3D extent
obj.Crop () - Reallocates and copies to set the Extent to the UpdateExtent. This is used internally when
the exact extent is requested, and the source generated more than the update extent.
32.177
vtkRectilinearGridAlgorithm
32.177.1
Usage
32.177.2
Methods
The class vtkRectilinearGridAlgorithm has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRectilinearGridAlgorithm
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRectilinearGridAlgorithm = obj.NewInstance ()
vtkRectilinearGridAlgorithm = obj.SafeDownCast (vtkObject o)
vtkRectilinearGrid = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkRectilinearGrid = obj.GetOutput (int ) - Get the output data object for a port on this
algorithm.
obj.SetOutput (vtkDataObject d) - Get the output data object for a port on this algorithm.
vtkDataObject = obj.GetInput ()
vtkDataObject = obj.GetInput (int port)
vtkRectilinearGrid = obj.GetRectilinearGridInput (int port)
obj.SetInput (vtkDataObject ) - Set an input of this algorithm. You should not override these
methods because they are not the only way to connect a pipeline. Note that these methods support oldstyle pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection
within a single port.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
988
32.178
vtkRectilinearGridSource
32.178.1
Usage
32.178.2
Methods
The class vtkRectilinearGridSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRectilinearGridSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRectilinearGridSource = obj.NewInstance ()
vtkRectilinearGridSource = obj.SafeDownCast (vtkObject o)
vtkRectilinearGrid = obj.GetOutput () - Get the output of this source.
vtkRectilinearGrid = obj.GetOutput (int idx) - Get the output of this source.
obj.SetOutput (vtkRectilinearGrid output) - Get the output of this source.
32.179
vtkRectilinearGridToPolyDataFilter
32.179.1
Usage
vtkRectilinearGridToPolyDataFilter is a filter whose subclasses take as input rectilinear grid datasets and generate
polygonal data on output.
To create an instance of class vtkRectilinearGridToPolyDataFilter, simply invoke its constructor as follows
obj = vtkRectilinearGridToPolyDataFilter
32.180 vtkScalarTree
32.179.2
989
Methods
The class vtkRectilinearGridToPolyDataFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRectilinearGridToPolyDataFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRectilinearGridToPolyDataFilter = obj.NewInstance ()
vtkRectilinearGridToPolyDataFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkRectilinearGrid input) - Set / get the input Grid or filter.
vtkRectilinearGrid = obj.GetInput () - Set / get the input Grid or filter.
32.180
vtkScalarTree
32.180.1
Usage
vtkScalarTree is an abstract class that defines the API to concrete scalar tree subclasses. A scalar tree is a data
structure that organizes data according to its scalar value. This allows rapid access to data for those algorithms
that access the data based on scalar value. For example, isocontouring operates on cells based on the scalar
(isocontour) value.
To use subclasses of this class, you must specify a dataset to operate on, and then specify a scalar value in the InitTraversal() method. Then calls to GetNextCell() return cells whose scalar data contains the scalar value specified.
To create an instance of class vtkScalarTree, simply invoke its constructor as follows
obj = vtkScalarTree
32.180.2
Methods
The class vtkScalarTree has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkScalarTree class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkScalarTree = obj.NewInstance ()
vtkScalarTree = obj.SafeDownCast (vtkObject o)
obj.SetDataSet (vtkDataSet ) - Build the tree from the points/cells defining this dataset.
vtkDataSet = obj.GetDataSet () - Build the tree from the points/cells defining this dataset.
obj.BuildTree () - Construct the scalar tree from the dataset provided. Checks build times and modified time from input and reconstructs the tree if necessary.
obj.Initialize () - Initialize locator. Frees memory and resets object as appropriate.
obj.InitTraversal (double scalarValue) - Begin to traverse the cells based on a scalar
value. Returned cells will have scalar values that span the scalar value specified.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
990
32.181
vtkSelection
32.181.1
Usage
32.181.2
Methods
The class vtkSelection has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkSelection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSelection = obj.NewInstance ()
vtkSelection = obj.SafeDownCast (vtkObject o)
obj.Initialize () - Restore data object to initial state,
int = obj.GetDataObjectType () - Returns the number of nodes in this selection. Each node
contains information about part of the selection.
int = obj.GetNumberOfNodes () - Returns the number of nodes in this selection. Each node
contains information about part of the selection.
vtkSelectionNode = obj.GetNode (int idx) - Returns a node given its index. Performs
bound checking and will return 0 if out-of-bounds.
obj.AddNode (vtkSelectionNode ) - Adds a selection node.
obj.RemoveNode (int idx) - Removes a selection node.
obj.RemoveNode (vtkSelectionNode ) - Removes a selection node.
obj.RemoveAllNodes () - Removes a selection node.
obj.DeepCopy (vtkDataObject src) - Copy selection nodes of the input.
obj.ShallowCopy (vtkDataObject src) - Copy selection nodes of the input. This is a shallow
copy: selection lists and pointers in the properties are passed by reference.
obj.Union (vtkSelection selection) - Union this selection with the specified selection. Attempts to reuse selection nodes in this selection if properties match exactly. Otherwise, creates new selection
nodes.
obj.Union (vtkSelectionNode node) - Union this selection with the specified selection node.
Attempts to reuse a selection node in this selection if properties match exactly. Otherwise, creates a new
selection node.
long = obj.GetMTime () - Return the MTime taking into account changes to the properties
obj.Dump () - Dumps the contents of the selection, giving basic information only.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.182 vtkSelectionAlgorithm
32.182
991
vtkSelectionAlgorithm
32.182.1
Usage
vtkSelectionAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition
old algorithms to the new pipeline edgehitecture. There are some assumptions and defaults made by this class
you should be aware of. This class defaults such that your filter will have one input port and one output port. If
that is not the case simply change it with SetNumberOfInputPorts etc. See this class constructor for the default.
This class also provides a FillInputPortInfo method that by default says that all inputs will be Selection. If that
isnt the case then please override this method in your subclass. This class breaks out the downstream requests
into separate functions such as ExecuteData and ExecuteInformation. For new algorithms you should implement
RequestData( request, inputVec, outputVec) but for older filters there is a default implementation that calls the old
ExecuteData(output) signature. For even older filters that dont implement ExecuteData the default implementation
calls the even older Execute() signature.
.SECTION Thanks Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from Sandia National
Laboratories for their help in developing this class.
To create an instance of class vtkSelectionAlgorithm, simply invoke its constructor as follows
obj = vtkSelectionAlgorithm
32.182.2
Methods
The class vtkSelectionAlgorithm has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSelectionAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSelectionAlgorithm = obj.NewInstance ()
vtkSelectionAlgorithm = obj.SafeDownCast (vtkObject o)
vtkSelection = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkSelection = obj.GetOutput (int index) - Get the output data object for a port on this
algorithm.
obj.SetInput (vtkDataObject obj) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
obj.SetInput (int index, vtkDataObject obj) - Set an input of this algorithm. You should
not override these methods because they are not the only way to connect a pipeline. Note that these methods
support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
32.183
vtkSelectionNode
992
32.183.1
Usage
32.183.2
Methods
The class vtkSelectionNode has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkSelectionNode class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSelectionNode = obj.NewInstance ()
vtkSelectionNode = obj.SafeDownCast (vtkObject o)
obj.Initialize () - Restore data object to initial state,
obj.SetSelectionList (vtkAbstractArray ) - Sets the selection list.
vtkAbstractArray = obj.GetSelectionList () - Sets the selection list.
obj.SetSelectionData (vtkDataSetAttributes data) - Sets the selection table.
vtkDataSetAttributes = obj.GetSelectionData () - Sets the selection table.
vtkInformation = obj.GetProperties () - Returns the property map.
obj.DeepCopy (vtkSelectionNode src) - Copy properties, selection list and children of the input.
obj.ShallowCopy (vtkSelectionNode src) - Copy properties, selection list and children of the
input. This is a shallow copy: selection lists and pointers in the properties are passed by reference.
long = obj.GetMTime () - Return the MTime taking into account changes to the properties
obj.SetContentType (int type) - Get or set the content type of the selection. This is the same
as setting the CONTENT_TYPE() key on the property.
int = obj.GetContentType () - Get or set the content type of the selection. This is the same as
setting the CONTENT_TYPE() key on the property.
obj.SetFieldType (int type) - Get or set the field type of the selection. This is the same as
setting the FIELD_TYPE() key on the property.
int = obj.GetFieldType () - Get or set the field type of the selection. This is the same as setting
the FIELD_TYPE() key on the property.
obj.SetSelectedProp (vtkProp prop) - Get or set the prop of the selection. This is the same as
setting the PROP() key on the property.
vtkProp = obj.GetSelectedProp () - Get or set the prop of the selection. This is the same as
setting the PROP() key on the property.
obj.UnionSelectionList (vtkSelectionNode other) - Merges the selection list between
self and the other. Assumes that both has identical properties.
bool = obj.EqualProperties (vtkSelectionNode other, bool fullcomparetrue)
- Compares Properties of self and other to ensure that they are exactly same.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.184 vtkSimpleCellTessellator
32.184
993
vtkSimpleCellTessellator
32.184.1
Usage
vtkSimpleCellTessellator is a helper class to perform adaptive tessellation of particular cell topologies. The major
purpose for this class is to transform higher-order cell types (e.g., higher-order finite elements) into linear cells that
can then be easily visualized by VTK. This class works in conjunction with the vtkGenericDataSet and vtkGenericAdaptorCell classes.
This algorithm is based on edge subdivision. An error metric along each edge is evaluated, and if the error is greater
than some tolerance, the edge is subdivided (as well as all connected 2D and 3D cells). The process repeats until
the error metric is satisfied. Since the algorithm is based on edge subdivision it inherently avoid T-junctions.
A significant issue addressed by this algorithm is to insure face compatibility across neigboring cells. That is,
diagonals due to face triangulation must match to insure that the mesh is compatible. The algorithm employs a
precomputed table to accelerate the tessellation process. The table was generated with the help of vtkOrderedTriangulator the basic idea is that the choice of diagonal is made only by considering the relative value of the point
ids.
To create an instance of class vtkSimpleCellTessellator, simply invoke its constructor as follows
obj = vtkSimpleCellTessellator
32.184.2
Methods
The class vtkSimpleCellTessellator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSimpleCellTessellator
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSimpleCellTessellator = obj.NewInstance ()
vtkSimpleCellTessellator = obj.SafeDownCast (vtkObject o)
vtkGenericAdaptorCell = obj.GetGenericCell () - Get the higher order cell in order to
access the evaluation function.
obj.TessellateFace (vtkGenericAdaptorCell cell, vtkGenericAttribute-
att, vtkDoubleArray points, vtkCellArray cellArray, vtkPointData internalPd) - Tessellate a 3D cell. The result is a set of smaller linear tetrahedra in cellArray with points and point
data internalPd.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
994
att, vtkDoubleArray points, vtkCellArray cellArray, vtkPointData internalPd) - Triangulate a 2D cell. The result is a set of smaller linear triangles in cellArray with points and point
data internalPd.
Precondition
cell_exists: cell!=0
valid_dimension: cell->GetDimension()==2
att_exists: att!=0
points_exists: points!=0
cellArray_exists: cellArray!=0
internalPd_exists: internalPd!=0
obj.Reset () - Reset the output for repeated use of this class.
obj.Initialize (vtkGenericDataSet ds) - Initialize the tessellator with a data set ds.
int = obj.GetFixedSubdivisions () - Return the number of fixed subdivisions. It is used to
prevent from infinite loop in degenerated cases. For order 3 or higher, if the inflection point is exactly on the
mid-point, error metric will not detect that a subdivision is required. 0 means no fixed subdivision: there will
be only adaptive subdivisions.
The algorithm first performs GetFixedSubdivisions non adaptive subdivisions followed by at most GetMaxAdaptiveSubdivisions adaptive subdivisions. Hence, there are at most GetMaxSubdivisionLevel subdivisions.
Postcondition
positive_result: result>=0 && result<=GetMaxSubdivisionLevel()
int = obj.GetMaxSubdivisionLevel () - Return the maximum level of subdivision. It is used to
prevent from infinite loop in degenerated cases. For order 3 or higher, if the inflection point is exactly on the
mid-point, error metric will not detect that a subdivision is required. 0 means no subdivision, neither fixed nor
adaptive.
Postcondition
positive_result: result>=GetFixedSubdivisions()
int = obj.GetMaxAdaptiveSubdivisions () - Return the maximum number of adaptive subdivisions.
Postcondition
valid_result: result==GetMaxSubdivisionLevel()-GetFixedSubdivisions()
obj.SetFixedSubdivisions (int level) - Set the number of fixed subdivisions. See GetFixedSubdivisions() for more explanations.
Precondition
positive_level: level>=0 && level<=GetMaxSubdivisionLevel()
32.185 vtkSimpleImageToImageFilter
995
Postcondition
is_set: GetFixedSubdivisions()==level
obj.SetMaxSubdivisionLevel (int level) - Set the maximum level of subdivision. See GetMaxSubdivisionLevel() for more explanations.
Precondition
positive_level: level>=GetFixedSubdivisions()
Postcondition
is_set: level==GetMaxSubdivisionLevel()
obj.SetSubdivisionLevels (int fixed, int maxLevel) - Set both the number of fixed
subdivisions and the maximum level of subdivisions. See GetFixedSubdivisions(), GetMaxSubdivisionLevel()
and GetMaxAdaptiveSubdivisions() for more explanations.
Precondition
positive_fixed: fixed>=0
valid_range: fixed<=maxLevel
Postcondition
fixed_is_set: fixed==GetFixedSubdivisions()
maxLevel_is_set: maxLevel==GetMaxSubdivisionLevel()
32.185
vtkSimpleImageToImageFilter
32.185.1
Usage
vtkSimpleImageToImageFilter is a filter which aims to avoid much of the complexity associated with vtkImageAlgorithm (i.e. support for pieces, multi-threaded operation). If you need to write a simple image-image filter which
operates on the whole input, use this as the superclass. The subclass has to provide only an execute method which
takes input and output as arguments. Memory allocation is handled in vtkSimpleImageToImageFilter. Also, you
are guaranteed to have a valid input in the Execute(input, output) method. By default, this filter requests its inputs
whole extent and copies the inputs information (spacing, whole extent etc...) to the output. If the outputs setup is
different (for example, if it performs some sort of sub-sampling), ExecuteInformation has to be overwritten. As an
example of how this can be done, you can look at vtkImageShrink3D::ExecuteInformation. For a complete example
which uses templates to support generic data types, see vtkSimpleImageToImageFilter.
To create an instance of class vtkSimpleImageToImageFilter, simply invoke its constructor as follows
obj = vtkSimpleImageToImageFilter
32.185.2
Methods
The class vtkSimpleImageToImageFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSimpleImageToImageFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSimpleImageToImageFilter = obj.NewInstance ()
vtkSimpleImageToImageFilter = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
996
32.186
vtkSimpleScalarTree
32.186.1
Usage
vtkSimpleScalarTree creates a pointerless binary tree that helps search for cells that lie within a particular scalar
range. This object is used to accelerate some contouring (and other scalar-based techniques).
The tree consists of an array of (min,max) scalar range pairs per node in the tree. The (min,max) range is determined
from looking at the range of the children of the tree node. If the node is a leaf, then the range is determined by
scanning the range of scalar data in n cells in the dataset. The n cells are determined by arbitrary selecting cell ids
from id(i) to id(i+n), and where n is specified using the BranchingFactor ivar. Note that leaf node i=0 contains the
scalar range computed from cell ids (0,n-1); leaf node i=1 contains the range from cell ids (n,2n-1); and so on. The
implication is that there are no direct lists of cell ids per leaf node, instead the cell ids are implicitly known.
To create an instance of class vtkSimpleScalarTree, simply invoke its constructor as follows
obj = vtkSimpleScalarTree
32.186.2
Methods
The class vtkSimpleScalarTree has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkSimpleScalarTree class.
string = obj.GetClassName () - Standard type related macros and PrintSelf() method.
int = obj.IsA (string name) - Standard type related macros and PrintSelf() method.
vtkSimpleScalarTree = obj.NewInstance () - Standard type related macros and PrintSelf()
method.
vtkSimpleScalarTree = obj.SafeDownCast (vtkObject o) - Standard type related
macros and PrintSelf() method.
obj.SetBranchingFactor (int ) - Set the branching factor for the tree. This is the number of
children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory overhead.
Larger values mean shallower trees, less memory usage, but worse performance.
int = obj.GetBranchingFactorMinValue () - Set the branching factor for the tree. This is the
number of children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory
overhead. Larger values mean shallower trees, less memory usage, but worse performance.
int = obj.GetBranchingFactorMaxValue () - Set the branching factor for the tree. This is the
number of children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory
overhead. Larger values mean shallower trees, less memory usage, but worse performance.
int = obj.GetBranchingFactor () - Set the branching factor for the tree. This is the number
of children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory overhead.
Larger values mean shallower trees, less memory usage, but worse performance.
int = obj.GetLevel () - Get the level of the scalar tree. This value may change each time the scalar
tree is built and the branching factor changes.
obj.SetMaxLevel (int ) - Set the maximum allowable level for the tree.
int = obj.GetMaxLevelMinValue () - Set the maximum allowable level for the tree.
int = obj.GetMaxLevelMaxValue () - Set the maximum allowable level for the tree.
int = obj.GetMaxLevel () - Set the maximum allowable level for the tree.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.187 vtkSmoothErrorMetric
997
obj.BuildTree () - Construct the scalar tree from the dataset provided. Checks build times and modified time from input and reconstructs the tree if necessary.
obj.Initialize () - Initialize locator. Frees memory and resets object as appropriate.
obj.InitTraversal (double scalarValue) - Begin to traverse the cells based on a scalar
value. Returned cells will have scalar values that span the scalar value specified.
32.187
vtkSmoothErrorMetric
32.187.1
Usage
It is a concrete error metric, based on a geometric criterium: a max angle between the chord passing through the
midpoint and one of the endpoints and the other chord passing through the midpoint and the other endpoint of the
edge. It is related to the flatness of an edge.
To create an instance of class vtkSmoothErrorMetric, simply invoke its constructor as follows
obj = vtkSmoothErrorMetric
32.187.2
Methods
The class vtkSmoothErrorMetric has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSmoothErrorMetric class.
string = obj.GetClassName () - Standard VTK type and error macros.
int = obj.IsA (string name) - Standard VTK type and error macros.
vtkSmoothErrorMetric = obj.NewInstance () - Standard VTK type and error macros.
vtkSmoothErrorMetric = obj.SafeDownCast (vtkObject o) - Standard VTK type and error macros.
double = obj.GetAngleTolerance () - Return the flatness threshold.
Postcondition
positive_result: result>90 && result<180
obj.SetAngleTolerance (double value) - Set the flatness threshold with an angle in degrees.
Internally compute the cosine. value is supposed to be in ]90,180[, if not it is clamped in [90.1,179.9]. For
instance 178 will give better result than 150.
int = obj.RequiresEdgeSubdivision (double leftPoint, double midPoint,
double rightPoint, double alpha) - Does the edge need to be subdivided according to
the cosine between the two chords passing through the mid-point and the endpoints? The edge is defined
by its leftPoint and its rightPoint. leftPoint, midPoint and rightPoint have to be initialized before calling
RequiresEdgeSubdivision(). Their format is global coordinates, parametric coordinates and point centered
attributes: xyx rst abc de... alpha is the normalized abscissa of the midpoint along the edge. (close to 0
means close to the left point, close to 1 means close to the right point)
998
32.188
vtkSource
32.188.1
Usage
vtkSource is an abstract object that specifies behavior and interface of source objects. Source objects are objects
that begin visualization pipeline. Sources include readers (read data from file or communications port) and procedural sources (generate data programmatically). vtkSource objects are also objects that generate output data. In
this sense vtkSource is used as a superclass to vtkFilter.
Concrete subclasses of vtkSource must define Update() and Execute() methods. The public method Update()
invokes network execution and will bring the network up-to-date. The protected Execute() method actually does
the work of data creation/generation. The difference between the two methods is that Update() implements input
consistency checks and modified time comparisons and then invokes the Execute() which is an implementation of
a particular algorithm.
An important feature of subclasses of vtkSource is that it is possible to control the memory-management model
(i.e., retain output versus delete output data). If enabled the ReleaseDataFlag enables the deletion of the output
data once the downstream process object finishes processing the data (please see text).
To create an instance of class vtkSource, simply invoke its constructor as follows
obj = vtkSource
32.188.2
Methods
The class vtkSource has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkSource class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.189 vtkSphere
999
32.189
vtkSphere
1000
32.189.1
Usage
vtkSphere computes the implicit function and/or gradient for a sphere. vtkSphere is a concrete implementation of
vtkImplicitFunction. Additional methods are available for sphere-related computations, such as computing bounding
spheres for a set of points, or set of spheres.
To create an instance of class vtkSphere, simply invoke its constructor as follows
obj = vtkSphere
32.189.2
Methods
The class vtkSphere has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkSphere class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSphere = obj.NewInstance ()
vtkSphere = obj.SafeDownCast (vtkObject o)
double = obj.EvaluateFunction (double x[3])
double = obj.EvaluateFunction (double x, double y, double z)
obj.EvaluateGradient (double x[3], double n[3])
obj.SetRadius (double ) - Set / get the radius of the sphere.
double = obj.GetRadius () - Set / get the radius of the sphere.
obj.SetCenter (double , double , double ) - Set / get the center of the sphere.
obj.SetCenter (double a[3]) - Set / get the center of the sphere.
double = obj.
32.190
vtkSpline
32.190.1
Usage
vtkSpline interpolates a set of data points (i.e., interpolation means that the spline passes through the points).
vtkSpline is an abstract class: its subclasses vtkCardinalSpline and vtkKochenekSpline do the interpolation. Note
that this spline maps the 1D parametric coordinate t into a single value x. Thus if you want to use the spline to
interpolate points (i.e. x[3]), you have to create three splines for each of the x-y-z coordinates. Fortunately, the
vtkParametricSpline class does this for you.
Typically a spline is used by adding a sequence of parametric coordinate / data (t,x) values followed by use of an
evaluation function (e.g., vtkCardinalSpline::Evaluate()). Since these splines are 1D, a point in this context is an
independent / dependent variable pair.
Splines can also be set up to be closed or open. Closed splines continue from the last point to the first point with
continuous function and derivative values. (You dont need to duplicate the first point to close the spline, just set
ClosedOn.)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.190 vtkSpline
1001
This implementation of splines does not use a normalized parametric coordinate. If the spline is open, then the
parameter space is (tMin <= t <= tMax) where tMin and tMax are the minimum and maximum parametric values
seen when performing AddPoint(). If the spline is closed, then the parameter space is (tMin <= t <= (tMax+1)) where
tMin and tMax are the minimum and maximum parametric values seen when performing AddPoint(). Note, however,
that this behavior can be changed by explicitly setting the ParametricRange(tMin,tMax). If set, the parameter space
remains (tMin <= t <= tMax), except that additions of data with parametric values outside this range are clamped
within this range.
To create an instance of class vtkSpline, simply invoke its constructor as follows
obj = vtkSpline
32.190.2
Methods
The class vtkSpline has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkSpline class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSpline = obj.NewInstance ()
vtkSpline = obj.SafeDownCast (vtkObject o)
obj.SetParametricRange (double tMin, double tMax) - Set/Get the parametric range. If
not set, the range is determined implicitly by keeping track of the (min,max) parameter values for t. If set, the
AddPoint() method will clamp the t value to lie within the specified range.
obj.SetParametricRange (double tRange[2]) - Set/Get the parametric range. If not set, the
range is determined implicitly by keeping track of the (min,max) parameter values for t. If set, the AddPoint()
method will clamp the t value to lie within the specified range.
obj.GetParametricRange (double tRange[2]) const - Set/Get the parametric range. If not
set, the range is determined implicitly by keeping track of the (min,max) parameter values for t. If set, the
AddPoint() method will clamp the t value to lie within the specified range.
obj.SetClampValue (int ) - Set/Get ClampValue. If On, results of the interpolation will be clamped
to the min/max of the input data.
int = obj.GetClampValue () - Set/Get ClampValue. If On, results of the interpolation will be
clamped to the min/max of the input data.
obj.ClampValueOn () - Set/Get ClampValue. If On, results of the interpolation will be clamped to the
min/max of the input data.
obj.ClampValueOff () - Set/Get ClampValue. If On, results of the interpolation will be clamped to the
min/max of the input data.
obj.Compute () - Compute the coefficients for the spline.
double = obj.Evaluate (double t) - Interpolate the value of the spline at parametric location of
t.
int = obj.GetNumberOfPoints () - Return the number of points inserted thus far.
obj.AddPoint (double t, double x) - Add a pair of points to be fit with the spline.
obj.RemovePoint (double t) - Remove a point from the data to be fit with the spline.
obj.RemoveAllPoints () - Remove all points from the data.
obj.SetClosed (int ) - Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1002
int = obj.GetClosed () - Control whether the spline is open or closed. A closed spline forms a
continuous loop: the first and last points are the same, and derivatives are continuous.
obj.ClosedOn () - Control whether the spline is open or closed. A closed spline forms a continuous
loop: the first and last points are the same, and derivatives are continuous.
obj.ClosedOff () - Control whether the spline is open or closed. A closed spline forms a continuous
loop: the first and last points are the same, and derivatives are continuous.
obj.SetLeftConstraint (int ) - Set the type of constraint of the left(right) end points. Four constraints are available:
0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.
1: the first derivative at left(right) most point is set to Left(Right)Value.
2: the second derivative at left(right) most point is set to Left(Right)Value.
3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior
point.
int = obj.GetLeftConstraintMinValue () - Set the type of constraint of the left(right) end
points. Four constraints are available:
0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.
1: the first derivative at left(right) most point is set to Left(Right)Value.
2: the second derivative at left(right) most point is set to Left(Right)Value.
3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior
point.
int = obj.GetLeftConstraintMaxValue () - Set the type of constraint of the left(right) end
points. Four constraints are available:
0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.
1: the first derivative at left(right) most point is set to Left(Right)Value.
2: the second derivative at left(right) most point is set to Left(Right)Value.
3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior
point.
int = obj.GetLeftConstraint () - Set the type of constraint of the left(right) end points. Four
constraints are available:
0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.
1: the first derivative at left(right) most point is set to Left(Right)Value.
2: the second derivative at left(right) most point is set to Left(Right)Value.
3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior
point.
obj.SetRightConstraint (int ) - Set the type of constraint of the left(right) end points. Four
constraints are available:
0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.
1: the first derivative at left(right) most point is set to Left(Right)Value.
2: the second derivative at left(right) most point is set to Left(Right)Value.
3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior
point.
int = obj.GetRightConstraintMinValue () - Set the type of constraint of the left(right) end
points. Four constraints are available:
0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.
1: the first derivative at left(right) most point is set to Left(Right)Value.
2: the second derivative at left(right) most point is set to Left(Right)Value.
3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior
point.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.191 vtkStreamingDemandDrivenPipeline
1003
32.191
vtkStreamingDemandDrivenPipeline
32.191.1
Usage
vtkStreamingDemandDrivenPipeline is an executive that supports updating only a portion of the data set in the
pipeline. This is the style of pipeline update that is provided by the old-style VTK 4.x pipeline. Instead of always
updating an entire data set, this executive supports asking for pieces or sub-extents.
To create an instance of class vtkStreamingDemandDrivenPipeline, simply invoke its constructor as follows
obj = vtkStreamingDemandDrivenPipeline
32.191.2
Methods
The class vtkStreamingDemandDrivenPipeline has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStreamingDemandDrivenPipeline class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1004
vtkStreamingDemandDrivenPipeline = obj.NewInstance ()
vtkStreamingDemandDrivenPipeline = obj.SafeDownCast (vtkObject o)
int = obj.Update () - Bring the outputs up-to-date.
int = obj.Update (int port) - Bring the outputs up-to-date.
int = obj.UpdateWholeExtent () - Bring the outputs up-to-date.
int = obj.PropagateUpdateExtent (int outputPort) - Propagate the update request
from the given output port back through the pipeline. Should be called only when information is up to date.
int = obj.SetMaximumNumberOfPieces (int port, int n) - Set/Get the maximum number of pieces that can be requested from the given port. The maximum number of pieces is meta data for
unstructured data sets. It gets set by the source during the update information call. A value of -1 indicates
that there is no maximum.
int = obj.SetMaximumNumberOfPieces (vtkInformation , int n) - Set/Get the maximum number of pieces that can be requested from the given port. The maximum number of pieces is meta
data for unstructured data sets. It gets set by the source during the update information call. A value of -1
indicates that there is no maximum.
int = obj.GetMaximumNumberOfPieces (int port) - Set/Get the maximum number of
pieces that can be requested from the given port. The maximum number of pieces is meta data for unstructured data sets. It gets set by the source during the update information call. A value of -1 indicates that there
is no maximum.
int = obj.GetMaximumNumberOfPieces (vtkInformation ) - Set/Get the maximum number of pieces that can be requested from the given port. The maximum number of pieces is meta data for
unstructured data sets. It gets set by the source during the update information call. A value of -1 indicates
that there is no maximum.
int = obj.SetWholeExtent (vtkInformation , int extent[6]) - Set/Get the whole
extent of an output port. The whole extent is meta data for structured data sets. It gets set by the algorithm during the update information pass.
obj.GetWholeExtent (vtkInformation , int extent[6]) - Set/Get the whole extent of
an output port. The whole extent is meta data for structured data sets. It gets set by the algorithm during the
update information pass.
int = obj.SetUpdateExtentToWholeExtent (int port) - If the whole input extent is required to generate the requested output extent, this method can be called to set the input update extent to the
whole input extent. This method assumes that the whole extent is known (that UpdateInformation has been
called)
int = obj.SetUpdateExtentToWholeExtent (vtkInformation ) - If the whole input extent is required to generate the requested output extent, this method can be called to set the input update
extent to the whole input extent. This method assumes that the whole extent is known (that UpdateInformation
has been called)
int = obj.SetUpdateExtent (int port, int extent[6]) - Get/Set the update extent for
output ports that use 3D extents.
int = obj.SetUpdateExtent (vtkInformation , int extent[6]) - Get/Set the update
extent for output ports that use 3D extents.
obj.GetUpdateExtent (vtkInformation , int extent[6]) - Get/Set the update extent
for output ports that use 3D extents.
int = obj.SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel) - Set/Get the update piece, update number of pieces, and update number of ghost levels for an
output port. Similar to update extent in 3D.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.191 vtkStreamingDemandDrivenPipeline
1005
1006
32.192
vtkStructuredGrid
32.192.1
Usage
32.192 vtkStructuredGrid
32.192.2
1007
Methods
The class vtkStructuredGrid has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredGrid class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredGrid = obj.NewInstance ()
vtkStructuredGrid = obj.SafeDownCast (vtkObject o)
int = obj.GetDataObjectType () - Copy the geometric and topological structure of an input poly
data object.
obj.CopyStructure (vtkDataSet ds) - Copy the geometric and topological structure of an input
poly data object.
vtkIdType = obj.GetNumberOfPoints () - Standard vtkDataSet API methods. See vtkDataSet
for more information.
double = obj.GetPoint (vtkIdType ptId) - Standard vtkDataSet API methods. See vtkDataSet for more information.
obj.GetPoint (vtkIdType ptId, double p[3]) - Standard vtkDataSet API methods. See
vtkDataSet for more information.
vtkCell = obj.GetCell (vtkIdType cellId) - Standard vtkDataSet API methods. See vtkDataSet for more information.
obj.GetCell (vtkIdType cellId, vtkGenericCell cell) - Standard vtkDataSet API
methods. See vtkDataSet for more information.
obj.GetCellBounds (vtkIdType cellId, double bounds[6]) - Standard vtkDataSet API
methods. See vtkDataSet for more information.
int = obj.GetCellType (vtkIdType cellId) - Standard vtkDataSet API methods. See vtkDataSet for more information.
vtkIdType = obj.GetNumberOfCells () - Standard vtkDataSet API methods. See vtkDataSet
for more information.
obj.GetCellPoints (vtkIdType cellId, vtkIdList ptIds) - Standard vtkDataSet API
methods. See vtkDataSet for more information.
obj.GetPointCells (vtkIdType ptId, vtkIdList cellIds) - Standard vtkDataSet API
methods. See vtkDataSet for more information.
obj.Initialize () - Standard vtkDataSet API methods. See vtkDataSet for more information.
int = obj.GetMaxCellSize () - Standard vtkDataSet API methods. See vtkDataSet for more information.
obj.GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds) - Standard vtkDataSet API methods. See vtkDataSet for more information.
obj.GetScalarRange (double range[2]) - Standard vtkDataSet API methods. See vtkDataSet
for more information.
double = obj.GetScalarRange () - following methods are specific to structured grid
obj.SetDimensions (int i, int j, int k) - following methods are specific to structured grid
obj.SetDimensions (int dim[3]) - following methods are specific to structured grid
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1008
32.193 vtkStructuredGridAlgorithm
1009
32.193
vtkStructuredGridAlgorithm
32.193.1
Usage
32.193.2
Methods
The class vtkStructuredGridAlgorithm has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredGridAlgorithm
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredGridAlgorithm = obj.NewInstance ()
vtkStructuredGridAlgorithm = obj.SafeDownCast (vtkObject o)
vtkStructuredGrid = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkStructuredGrid = obj.GetOutput (int ) - Get the output data object for a port on this
algorithm.
obj.SetOutput (vtkDataObject d) - Get the output data object for a port on this algorithm.
vtkDataObject = obj.GetInput ()
vtkDataObject = obj.GetInput (int port)
vtkStructuredGrid = obj.GetStructuredGridInput (int port)
obj.SetInput (vtkDataObject ) - Set an input of this algorithm. You should not override these
methods because they are not the only way to connect a pipeline. Note that these methods support oldstyle pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection
within a single port.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1010
obj.SetInput (int , vtkDataObject ) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
obj.AddInput (vtkDataObject ) - Add an input of this algorithm. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
obj.AddInput (int , vtkDataObject ) - Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
32.194
vtkStructuredGridSource
32.194.1
Usage
32.194.2
Methods
The class vtkStructuredGridSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredGridSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredGridSource = obj.NewInstance ()
vtkStructuredGridSource = obj.SafeDownCast (vtkObject o)
vtkStructuredGrid = obj.GetOutput () - Get the output of this source.
vtkStructuredGrid = obj.GetOutput (int idx) - Get the output of this source.
obj.SetOutput (vtkStructuredGrid output) - Get the output of this source.
32.195
vtkStructuredGridToPolyDataFilter
32.195.1
Usage
vtkStructuredGridToPolyDataFilter is a filter whose subclasses take as input structured grid datasets and generate
polygonal data on output.
To create an instance of class vtkStructuredGridToPolyDataFilter, simply invoke its constructor as follows
obj = vtkStructuredGridToPolyDataFilter
32.196 vtkStructuredGridToStructuredGridFilter
32.195.2
1011
Methods
The class vtkStructuredGridToPolyDataFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredGridToPolyDataFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredGridToPolyDataFilter = obj.NewInstance ()
vtkStructuredGridToPolyDataFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkStructuredGrid input) - Set / get the input Grid or filter.
vtkStructuredGrid = obj.GetInput () - Set / get the input Grid or filter.
32.196
vtkStructuredGridToStructuredGridFilter
32.196.1
Usage
32.196.2
Methods
The class vtkStructuredGridToStructuredGridFilter has several methods that can be used. They are listed below.
Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredGridToStructuredGridFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredGridToStructuredGridFilter = obj.NewInstance ()
vtkStructuredGridToStructuredGridFilter = obj.SafeDownCast (vtkObject
o)
obj.SetInput (vtkStructuredGrid input) - Set / get the input Grid or filter.
vtkStructuredGrid = obj.GetInput () - Set / get the input Grid or filter.
32.197
vtkStructuredPoints
1012
32.197.1
Usage
StructuredPoints is a subclass of ImageData that requires the data extent to exactly match the update extent.
Normall image data allows that the data extent may be larger than the update extent. StructuredPoints also defines
the origin differently that vtkImageData. For structured points the origin is the location of first point. Whereas images
define the origin as the location of point 0, 0, 0. Image Origin is stored in ivar, and structured points have special
methods for setting/getting the origin/extents.
To create an instance of class vtkStructuredPoints, simply invoke its constructor as follows
obj = vtkStructuredPoints
32.197.2
Methods
The class vtkStructuredPoints has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredPoints class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredPoints = obj.NewInstance ()
vtkStructuredPoints = obj.SafeDownCast (vtkObject o)
int = obj.GetDataObjectType ()
32.198
vtkStructuredPointsCollection
32.198.1
Usage
vtkStructuredPointsCollection is an object that creates and manipulates lists of structured points datasets. See also
vtkCollection and subclasses.
To create an instance of class vtkStructuredPointsCollection, simply invoke its constructor as follows
obj = vtkStructuredPointsCollection
32.198.2
Methods
The class vtkStructuredPointsCollection has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredPointsCollection
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredPointsCollection = obj.NewInstance ()
vtkStructuredPointsCollection = obj.SafeDownCast (vtkObject o)
obj.AddItem (vtkStructuredPoints ds) - Get the next item in the collection. NULL is returned
if the collection is exhausted.
vtkStructuredPoints = obj.GetNextItem () - Get the next item in the collection. NULL is
returned if the collection is exhausted.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.199 vtkStructuredPointsSource
32.199
1013
vtkStructuredPointsSource
32.199.1
Usage
32.199.2
Methods
The class vtkStructuredPointsSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredPointsSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredPointsSource = obj.NewInstance ()
vtkStructuredPointsSource = obj.SafeDownCast (vtkObject o)
obj.SetOutput (vtkStructuredPoints output) - Set/Get the output of this source.
vtkStructuredPoints = obj.GetOutput () - Set/Get the output of this source.
vtkStructuredPoints = obj.GetOutput (int idx) - Set/Get the output of this source.
32.200
vtkStructuredPointsToPolyDataFilter
32.200.1
Usage
vtkStructuredPointsToPolyDataFilter is an abstract filter class whose subclasses take on input structured points and
generate polygonal data on output.
To create an instance of class vtkStructuredPointsToPolyDataFilter, simply invoke its constructor as follows
obj = vtkStructuredPointsToPolyDataFilter
32.200.2
Methods
The class vtkStructuredPointsToPolyDataFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredPointsToPolyDataFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1014
vtkStructuredPointsToPolyDataFilter = obj.NewInstance ()
vtkStructuredPointsToPolyDataFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkImageData input) - Set / get the input data or filter.
vtkImageData = obj.GetInput () - Set / get the input data or filter.
32.201
vtkStructuredPointsToStructuredPointsFilter
32.201.1
Usage
32.201.2
Methods
The class vtkStructuredPointsToStructuredPointsFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely
intelligible. When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredPointsToStructuredPointsFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredPointsToStructuredPointsFilter = obj.NewInstance ()
vtkStructuredPointsToStructuredPointsFilter = obj.SafeDownCast (vtk-
Object o)
obj.SetInput (vtkImageData input) - Set / get the input data or filter.
vtkImageData = obj.GetInput () - Set / get the input data or filter.
32.202
vtkStructuredPointsToUnstructuredGridFilter
32.202.1
Usage
32.203 vtkSuperquadric
32.202.2
1015
Methods
The class vtkStructuredPointsToUnstructuredGridFilter has several methods that can be used. They are listed
below. Note that the documentation is translated automatically from the VTK sources, and may not be completely
intelligible. When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredPointsToUnstructuredGridFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredPointsToUnstructuredGridFilter = obj.NewInstance ()
vtkStructuredPointsToUnstructuredGridFilter = obj.SafeDownCast (vtk-
Object o)
obj.SetInput (vtkImageData input) - Set / get the input data or filter.
vtkImageData = obj.GetInput () - Set / get the input data or filter.
32.203
vtkSuperquadric
32.203.1
Usage
vtkSuperquadric computes the implicit function and function gradient for a superquadric. vtkSuperquadric is a
concrete implementation of vtkImplicitFunction. The superquadric is centered at Center and axes of rotation is along
the y-axis. (Use the superclass vtkImplicitFunction transformation matrix if necessary to reposition.) Roundness
parameters (PhiRoundness and ThetaRoundness) control the shape of the superquadric. The Toroidal boolean
controls whether a toroidal superquadric is produced. If so, the Thickness parameter controls the thickness of
the toroid: 0 is the thinnest allowable toroid, and 1 has a minimum sized hole. The Scale parameters allow the
superquadric to be scaled in x, y, and z (normal vectors are correctly generated in any case). The Size parameter
controls size of the superquadric.
This code is based on "Rigid physically based superquadrics", A. H. Barr, in "Graphics Gems III", David Kirk, ed.,
Academic Press, 1992.
To create an instance of class vtkSuperquadric, simply invoke its constructor as follows
obj = vtkSuperquadric
32.203.2
Methods
The class vtkSuperquadric has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkSuperquadric class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSuperquadric = obj.NewInstance ()
vtkSuperquadric = obj.SafeDownCast (vtkObject o)
double = obj.EvaluateFunction (double x[3])
double = obj.EvaluateFunction (double x, double y, double z)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1016
obj.SetScale (double , double , double ) - Set the scale factors of the superquadric. Default is 1,1,1.
obj.SetScale (double a[3]) - Set the scale factors of the superquadric. Default is 1,1,1.
double = obj.
Values
32.204
vtkTable
32.204 vtkTable
32.204.1
1017
Usage
vtkTable is a basic data structure for storing columns of data. Internally, columns are stored in a vtkDataSetAttributes
structure called RowData. However, using the vtkTable API additionally ensures that every column has the same
number of entries, and provides row access (using vtkVariantArray) and single entry access (using vtkVariant).
The field data inherited from vtkDataObject may be used to store metadata related to the table.
To create an instance of class vtkTable, simply invoke its constructor as follows
obj = vtkTable
32.204.2
Methods
The class vtkTable has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkTable class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTable = obj.NewInstance ()
vtkTable = obj.SafeDownCast (vtkObject o)
obj.Dump (int colWidth) - Dump table contents.
int = obj.GetDataObjectType () - Return the actual size of the data in kilobytes. This number is
valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal
to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return
value).
long = obj.GetActualMemorySize () - Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than
or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the
return value).
vtkDataSetAttributes = obj.GetRowData () - Get/Set the main data (columns) of the table.
obj.SetRowData (vtkDataSetAttributes data) - Get/Set the main data (columns) of the table.
vtkIdType = obj.GetNumberOfRows () - Get the number of rows in the table.
obj.SetNumberOfRows (vtkIdType ) - Set the number of rows in the table. Note that memory
allocation might be performed as a result of this, but no memory will be released.
vtkVariantArray = obj.GetRow (vtkIdType row) - Get a row of the table as a vtkVariantArray which has one entry for each column. NOTE: This version of the method is NOT thread safe.
obj.GetRow (vtkIdType row, vtkVariantArray values) - Get a row of the table as a vtkVariantArray which has one entry for each column.
obj.SetRow (vtkIdType row, vtkVariantArray values) - Set a row of the table with a
vtkVariantArray which has one entry for each column.
vtkIdType = obj.InsertNextBlankRow (double default_num_val) - Insert a blank row
at the end of the table.
vtkIdType = obj.InsertNextRow (vtkVariantArray arr) - Insert a row specified by a
vtkVariantArray. The number of entries in the array should match the number of columns in the table.
obj.RemoveRow (vtkIdType row) - Delete a row from the table. Rows below the deleted row are
shifted up.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1018
32.205
vtkTableAlgorithm
32.205.1
Usage
vtkTableAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition
old algorithms to the new pipeline architecture. There are some assumptions and defaults made by this class you
should be aware of. This class defaults such that your filter will have one input port and one output port. If that is not
the case simply change it with SetNumberOfInputPorts etc. See this class constructor for the default. This class also
provides a FillInputPortInfo method that by default says that all inputs will be Tree. If that isnt the case then please
override this method in your subclass. This class breaks out the downstream requests into separate functions
such as ExecuteData and ExecuteInformation. For new algorithms you should implement RequestData( request,
inputVec, outputVec) but for older filters there is a default implementation that calls the old ExecuteData(output)
signature. For even older filters that dont implement ExecuteData the default implementation calls the even older
Execute() signature.
.SECTION Thanks Thanks to Brian Wylie for creating this class.
To create an instance of class vtkTableAlgorithm, simply invoke its constructor as follows
obj = vtkTableAlgorithm
32.205.2
Methods
The class vtkTableAlgorithm has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTableAlgorithm class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.206 vtkTemporalDataSet
1019
32.206
vtkTemporalDataSet
32.206.1
Usage
32.206.2
Methods
The class vtkTemporalDataSet has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTemporalDataSet class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTemporalDataSet = obj.NewInstance ()
vtkTemporalDataSet = obj.SafeDownCast (vtkObject o)
int = obj.GetDataObjectType () - Set the number of time steps in theis dataset
obj.SetNumberOfTimeSteps (int numLevels) - Returns the number of time steps.
int = obj.GetNumberOfTimeSteps () - Set a data object as a timestep. Cannot be vtkTemporalDataSet.
obj.SetTimeStep (int timestep, vtkDataObject dobj) - Set a data object as a timestep.
Cannot be vtkTemporalDataSet.
vtkDataObject = obj.GetTimeStep (int timestep) - Get timestep meta-data.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1020
32.207
vtkTemporalDataSetAlgorithm
32.207.1
Usage
Algorithms that take any type of data object (including composite dataset) and produce a vtkTemporalDataSet in
the output can subclass from this class.
To create an instance of class vtkTemporalDataSetAlgorithm, simply invoke its constructor as follows
obj = vtkTemporalDataSetAlgorithm
32.207.2
Methods
The class vtkTemporalDataSetAlgorithm has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTemporalDataSetAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTemporalDataSetAlgorithm = obj.NewInstance ()
vtkTemporalDataSetAlgorithm = obj.SafeDownCast (vtkObject o)
vtkTemporalDataSet = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkTemporalDataSet = obj.GetOutput (int ) - Get the output data object for a port on this
algorithm.
obj.SetInput (vtkDataObject ) - Set an input of this algorithm. You should not override these
methods because they are not the only way to connect a pipeline. Note that these methods support oldstyle pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection
within a single port.
obj.SetInput (int , vtkDataObject ) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.208 vtkTetra
32.208
1021
vtkTetra
32.208.1
Usage
vtkTetra is a concrete implementation of vtkCell to represent a 3D tetrahedron. vtkTetra uses the standard isoparametric shape functions for a linear tetrahedron. The tetrahedron is defined by the four points (0-3); where (0,1,2) is
the base of the tetrahedron which, using the right hand rule, forms a triangle whose normal points in the direction
of the fourth point.
To create an instance of class vtkTetra, simply invoke its constructor as follows
obj = vtkTetra
32.208.2
Methods
The class vtkTetra has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkTetra class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTetra = obj.NewInstance ()
vtkTetra = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int edgeId) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int faceId) - See the vtkCell API for descriptions of these methods.
obj.Contour (double value, vtkDataArray cellScalars, vtkIncremental-
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
Locator locator, vtkCellArray connectivity, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData outCd,
int insideOut) - See the vtkCell API for descriptions of these methods.
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts) - See the
vtkCell API for descriptions of these methods.
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts) - Returns the set of points that are on the boundary of the tetrahedron that are closest parametrically to the point
specified. This may include faces, edges, or vertices.
int = obj.GetParametricCenter (double pcoords[3]) - Return the center of the tetrahedron in parametric coordinates.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1022
32.209
vtkThreadedImageAlgorithm
32.209.1
Usage
vtkThreadedImageAlgorithm is a filter superclass that hides much of the pipeline complexity. It handles breaking
the pipeline execution into smaller extents so that the vtkImageData limits are observed. It also provides support for
multithreading. If you dont need any of this functionality, consider using vtkSimpleImageToImageAlgorithm instead.
.SECTION See also vtkSimpleImageToImageAlgorithm
To create an instance of class vtkThreadedImageAlgorithm, simply invoke its constructor as follows
obj = vtkThreadedImageAlgorithm
32.209.2
Methods
The class vtkThreadedImageAlgorithm has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkThreadedImageAlgorithm
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkThreadedImageAlgorithm = obj.NewInstance ()
vtkThreadedImageAlgorithm = obj.SafeDownCast (vtkObject o)
obj.ThreadedExecute (vtkImageData inData, vtkImageData outData, int
32.210
vtkTree
32.211 vtkTreeAlgorithm
32.210.1
1023
Usage
vtkTree is a connected directed graph with no cycles. A tree is a type of directed graph, so works with all graph
algorithms.
vtkTree is a read-only data structure. To construct a tree, create an instance of vtkMutableDirectedGraph. Add
vertices and edges with AddVertex() and AddEdge(). You may alternately start by adding a single vertex as the
root then call graph->AddChild(parent) which adds a new vertex and connects the parent to the child. The tree
MUST have all edges in the proper direction, from parent to child. After building the tree, call tree->CheckedShallowCopy(graph) to copy the structure into a vtkTree. This method will return false if the graph is an invalid
tree.
vtkTree provides some convenience methods for obtaining the parent and children of a vertex, for finding the root,
and determining if a vertex is a leaf (a vertex with no children).
To create an instance of class vtkTree, simply invoke its constructor as follows
obj = vtkTree
32.210.2
Methods
The class vtkTree has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkTree class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTree = obj.NewInstance ()
vtkTree = obj.SafeDownCast (vtkObject o)
int = obj.GetDataObjectType () - Get the root vertex of the tree.
vtkIdType = obj.GetRoot () - Get the root vertex of the tree.
vtkIdType = obj.GetNumberOfChildren (vtkIdType v) - Get the i-th child of a parent vertex.
vtkIdType = obj.GetChild (vtkIdType v, vtkIdType i) - Get the i-th child of a parent
vertex.
obj.GetChildren (vtkIdType v, vtkAdjacentVertexIterator it) - Get the parent of
a vertex.
vtkIdType = obj.GetParent (vtkIdType v) - Get the parent of a vertex.
vtkIdType = obj.GetLevel (vtkIdType v) - Get the level of the vertex in the tree. The root
vertex has level 0. Returns -1 if the vertex id is < 0 or greater than the number of vertices in the tree.
bool = obj.IsLeaf (vtkIdType vertex) - Return whether the vertex is a leaf (i.e. it has no
children).
obj.ReorderChildren (vtkIdType parent, vtkIdTypeArray children) - Reorder
the children of a parent vertex. The children array must contain all the children of parent, just in a different
order. This does not change the topology of the tree.
32.211
vtkTreeAlgorithm
1024
32.211.1
Usage
vtkTreeAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition old
algorithms to the new pipeline edgehitecture. There are some assumptions and defaults made by this class you
should be aware of. This class defaults such that your filter will have one input port and one output port. If that is not
the case simply change it with SetNumberOfInputPorts etc. See this class constructor for the default. This class also
provides a FillInputPortInfo method that by default says that all inputs will be Tree. If that isnt the case then please
override this method in your subclass. This class breaks out the downstream requests into separate functions
such as ExecuteData and ExecuteInformation. For new algorithms you should implement RequestData( request,
inputVec, outputVec) but for older filters there is a default implementation that calls the old ExecuteData(output)
signature. For even older filters that dont implement ExecuteData the default implementation calls the even older
Execute() signature.
To create an instance of class vtkTreeAlgorithm, simply invoke its constructor as follows
obj = vtkTreeAlgorithm
32.211.2
Methods
The class vtkTreeAlgorithm has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkTreeAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTreeAlgorithm = obj.NewInstance ()
vtkTreeAlgorithm = obj.SafeDownCast (vtkObject o)
vtkTree = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkTree = obj.GetOutput (int index) - Get the output data object for a port on this algorithm.
obj.SetInput (vtkDataObject obj) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
obj.SetInput (int index, vtkDataObject obj) - Set an input of this algorithm. You should
not override these methods because they are not the only way to connect a pipeline. Note that these methods
support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
32.212
vtkTreeDFSIterator
32.212.1
Usage
vtkTreeDFSIterator performs a depth first seedgeh of a tree. First, you must set the tree on which you are going to
iterate, and set the starting vertex and mode. The mode is either DISCOVER, in which case vertices are visited as
they are first reached, or FINISH, in which case vertices are visited when they are done, i.e. all adjacent vertices
have been discovered already.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.213 vtkTriangle
1025
After setting up the iterator, the normal mode of operation is to set up a while(iter->HasNext()) loop, with
the statement vtkIdType vertex = iter->Next() inside the loop.
To create an instance of class vtkTreeDFSIterator, simply invoke its constructor as follows
obj = vtkTreeDFSIterator
32.212.2
Methods
The class vtkTreeDFSIterator has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTreeDFSIterator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTreeDFSIterator = obj.NewInstance ()
vtkTreeDFSIterator = obj.SafeDownCast (vtkObject o)
obj.SetTree (vtkTree graph) - Set the graph to iterate over.
obj.SetMode (int mode) - Set the visit mode of the iterator. Mode can be DISCOVER (0): Order
by discovery time FINISH (1): Order by finish time Default is DISCOVER. Use DISCOVER for top-down
algorithms where parents need to be processed before children. Use FINISH for bottom-up algorithms where
children need to be processed before parents.
int = obj.GetMode () - Set the visit mode of the iterator. Mode can be DISCOVER (0): Order by discovery time FINISH (1): Order by finish time Default is DISCOVER. Use DISCOVER for top-down algorithms
where parents need to be processed before children. Use FINISH for bottom-up algorithms where children
need to be processed before parents.
obj.SetStartVertex (vtkIdType vertex) - The start vertex of the seedgeh. The tree iterator
will only iterate over the subtree rooted at vertex. If not set (or set to a negative value), starts at the root of
the tree.
vtkIdType = obj.GetStartVertex () - The start vertex of the seedgeh. The tree iterator will only
iterate over the subtree rooted at vertex. If not set (or set to a negative value), starts at the root of the tree.
vtkIdType = obj.Next () - The next vertex visited in the graph.
bool = obj.HasNext () - Return true when all vertices have been visited.
32.213
vtkTriangle
32.213.1
Usage
1026
32.213.2
Methods
The class vtkTriangle has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkTriangle class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTriangle = obj.NewInstance ()
vtkTriangle = obj.SafeDownCast (vtkObject o)
vtkCell = obj.GetEdge (int edgeId) - Get the edge specified by edgeId (range 0 to 2) and
return that edges coordinates.
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int ) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts) - See the
vtkCell API for descriptions of these methods.
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs) - See the vtkCell API for descriptions of these methods.
double = obj.ComputeArea () - A convenience function to compute the area of a vtkTriangle.
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.214
vtkTriangleStrip
32.214 vtkTriangleStrip
32.214.1
1027
Usage
vtkTriangleStrip is a concrete implementation of vtkCell to represent a 2D triangle strip. A triangle strip is a compact
representation of triangles connected edge to edge in strip fashion. The connectivity of a triangle strip is three
points defining an initial triangle, then for each additional triangle, a single point that, combined with the previous
two points, defines the next triangle.
To create an instance of class vtkTriangleStrip, simply invoke its constructor as follows
obj = vtkTriangleStrip
32.214.2
Methods
The class vtkTriangleStrip has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkTriangleStrip class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTriangleStrip = obj.NewInstance ()
vtkTriangleStrip = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int edgeId) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int ) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
double derivs)
int = obj.IsPrimaryCell () - Return the center of the point cloud in parametric coordinates.
int = obj.GetParametricCenter (double pcoords[3]) - Return the center of the point
cloud in parametric coordinates.
obj.InterpolateFunctions (double pcoords[3], double weights) - Compute the interpolation functions/derivatives (aka shape functions/derivatives)
obj.InterpolateDerivs (double pcoords[3], double derivs) - Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1028
32.215
vtkTriQuadraticHexahedron
32.215.1
Usage
vtkTriQuadraticHexahedron is a concrete implementation of vtkNonLinearCell to represent a three-dimensional, 27node isoparametric triquadratic hexahedron. The interpolation is the standard finite element, triquadratic isoparametric shape function. The cell includes 8 edge nodes, 12 mid-edge nodes, 6 mid-face nodes and one mid-volume
node. The ordering of the 27 points defining the cell is point ids (0-7,8-19, 20-25, 26) where point ids 0-7 are the
eight corner vertices of the cube; followed by twelve midedge nodes (8-19); followed by 6 mid-face nodes (20-25)
and the last node (26) is the mid-volume node. Note that these midedge nodes correspond lie on the edges defined by (0,1), (1,2), (2,3), (3,0), (4,5), (5,6), (6,7), (7,4), (0,4), (1,5), (2,6), (3,7). The mid-surface nodes lies on
the faces defined by (first edge nodes ids, than mid-edge nodes ids): (0,1,5,4;8,17,12,16), (1,2,6,5;9,18,13,17),
(2,3,7,6,10,19,14,18), (3,0,4,7;11,16,15,19), (0,1,2,3;8,9,10,11), (4,5,6,7;12,13,14,15). The last point lies in the
center of the cell (0,1,2,3,4,5,6,7).
top
7--14--6
|
|
15 25 13
|
|
4--12--5
middle
19--23--18
|
|
20 26 21
|
|
16--22--17
bottom
3--10--2
|
|
11 24 9
|
|
0-- 8--1
32.215.2
Methods
The class vtkTriQuadraticHexahedron has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTriQuadraticHexahedron
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTriQuadraticHexahedron = obj.NewInstance ()
vtkTriQuadraticHexahedron = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - Implement the vtkCell API. See the vtkCell API for descriptions of these
methods.
int = obj.GetCellDimension () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.216 vtkTrivialProducer
1029
int = obj.GetNumberOfEdges () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.GetNumberOfFaces () - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetEdge (int ) - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
vtkCell = obj.GetFace (int ) - Implement the vtkCell API. See the vtkCell API for descriptions
of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
obj.Contour (double value, vtkDataArray cellScalars, vtkIncremental-
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd)
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs)
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
32.216
vtkTrivialProducer
32.216.1
Usage
vtkTrivialProducer allows stand-alone data objects to be connected as inputs in a pipeline. All data objects that are
connected to a pipeline involving vtkAlgorithm must have a producer. This trivial producer allows data objects that
are hand-constructed in a program without another vtk producer to be connected.
To create an instance of class vtkTrivialProducer, simply invoke its constructor as follows
obj = vtkTrivialProducer
32.216.2
Methods
The class vtkTrivialProducer has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTrivialProducer class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1030
vtkTrivialProducer = obj.NewInstance ()
vtkTrivialProducer = obj.SafeDownCast (vtkObject o)
obj.SetOutput (vtkDataObject output) - Set the data object that is "produced" by this producer. It is never really modified.
long = obj.GetMTime () - The modified time of this producer is the newer of this object or the assigned output.
32.217
vtkUndirectedGraph
32.217.1
Usage
vtkUndirectedGraph is a collection of vertices along with a collection of undirected edges (they connect two vertices
in no particular order). ShallowCopy(), DeepCopy(), CheckedShallowCopy(), CheckedDeepCopy() accept instances
of vtkUndirectedGraph and vtkMutableUndirectedGraph. GetOutEdges(v, it) and GetInEdges(v, it) return the same
list of edges, which is the list of all edges which have a v as an endpoint. GetInDegree(v), GetOutDegree(v) and
GetDegree(v) all return the full degree of vertex v.
vtkUndirectedGraph is read-only. To create an undirected graph, use an instance of vtkMutableUndirectedGraph,
then you may set the structure to a vtkUndirectedGraph using ShallowCopy().
To create an instance of class vtkUndirectedGraph, simply invoke its constructor as follows
obj = vtkUndirectedGraph
32.217.2
Methods
The class vtkUndirectedGraph has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkUndirectedGraph class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkUndirectedGraph = obj.NewInstance ()
vtkUndirectedGraph = obj.SafeDownCast (vtkObject o)
int = obj.GetDataObjectType () - Returns the full degree of the vertex.
vtkIdType = obj.GetInDegree (vtkIdType v) - Returns the full degree of the vertex.
obj.GetInEdge (vtkIdType v, vtkIdType i, vtkGraphEdge e) - Initialize the iterator to
get the incoming edges to a vertex. For an undirected graph, this is all incident edges.
obj.GetInEdges (vtkIdType v, vtkInEdgeIterator it)
32.218
vtkUndirectedGraphAlgorithm
32.219 vtkUniformGrid
32.218.1
1031
Usage
vtkUndirectedGraphAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help
transition old algorithms to the new pipeline edgehitecture. There are some assumptions and defaults made by
this class you should be aware of. This class defaults such that your filter will have one input port and one output
port. If that is not the case simply change it with SetNumberOfInputPorts etc. See this class constructor for the
default. This class also provides a FillInputPortInfo method that by default says that all inputs will be Graph. If that
isnt the case then please override this method in your subclass. This class breaks out the downstream requests
into separate functions such as ExecuteData and ExecuteInformation. For new algorithms you should implement
RequestData( request, inputVec, outputVec) but for older filters there is a default implementation that calls the old
ExecuteData(output) signature. For even older filters that dont implement ExecuteData the default implementation
calls the even older Execute() signature.
.SECTION Thanks Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from Sandia National
Laboratories for their help in developing this class.
To create an instance of class vtkUndirectedGraphAlgorithm, simply invoke its constructor as follows
obj = vtkUndirectedGraphAlgorithm
32.218.2
Methods
The class vtkUndirectedGraphAlgorithm has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkUndirectedGraphAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkUndirectedGraphAlgorithm = obj.NewInstance ()
vtkUndirectedGraphAlgorithm = obj.SafeDownCast (vtkObject o)
vtkUndirectedGraph = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkUndirectedGraph = obj.GetOutput (int index) - Get the output data object for a port
on this algorithm.
obj.SetInput (vtkDataObject obj) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
obj.SetInput (int index, vtkDataObject obj) - Set an input of this algorithm. You should
not override these methods because they are not the only way to connect a pipeline. Note that these methods
support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
32.219
vtkUniformGrid
1032
32.219.1
Usage
vtkUniformGrid is a subclass of vtkImageData. In addition to all the image data functionality, it supports blanking.
To create an instance of class vtkUniformGrid, simply invoke its constructor as follows
obj = vtkUniformGrid
32.219.2
Methods
The class vtkUniformGrid has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkUniformGrid class.
string = obj.GetClassName () - Construct an empty uniform grid.
int = obj.IsA (string name) - Construct an empty uniform grid.
vtkUniformGrid = obj.NewInstance () - Construct an empty uniform grid.
vtkUniformGrid = obj.SafeDownCast (vtkObject o) - Construct an empty uniform grid.
obj.CopyStructure (vtkDataSet ds) - Copy the geometric and topological structure of an input
image data object.
int = obj.GetDataObjectType () - Return what type of dataset this is.
vtkCell = obj.GetCell (vtkIdType cellId) - Standard vtkDataSet API methods. See vtkDataSet for more information.
obj.GetCell (vtkIdType cellId, vtkGenericCell cell) - Standard vtkDataSet API
methods. See vtkDataSet for more information.
int = obj.GetCellType (vtkIdType cellId) - Standard vtkDataSet API methods. See vtkDataSet for more information.
obj.GetCellPoints (vtkIdType cellId, vtkIdList ptIds) - Standard vtkDataSet API
methods. See vtkDataSet for more information.
obj.GetPointCells (vtkIdType ptId, vtkIdList cellIds) - Standard vtkDataSet API
methods. See vtkDataSet for more information.
obj.Initialize () - Standard vtkDataSet API methods. See vtkDataSet for more information.
int = obj.GetMaxCellSize () - Standard vtkDataSet API methods. See vtkDataSet for more information.
obj.ShallowCopy (vtkDataObject src) - Shallow and Deep copy.
obj.DeepCopy (vtkDataObject src) - Shallow and Deep copy.
obj.BlankPoint (vtkIdType ptId) - Methods for supporting blanking of cells. Blanking turns on
or off points in the structured grid, and hence the cells connected to them. These methods should be called
only after the dimensions of the grid are set.
obj.UnBlankPoint (vtkIdType ptId) - Methods for supporting blanking of cells. Blanking turns
on or off points in the structured grid, and hence the cells connected to them. These methods should be
called only after the dimensions of the grid are set.
obj.BlankCell (vtkIdType ptId) - Methods for supporting blanking of cells. Blanking turns on or
off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.
obj.UnBlankCell (vtkIdType ptId) - Methods for supporting blanking of cells. Blanking turns
on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are
set.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.220 vtkUnstructuredGrid
1033
32.220
vtkUnstructuredGrid
32.220.1
Usage
vtkUnstructuredGrid is a data object that is a concrete implementation of vtkDataSet. vtkUnstructuredGrid represents any combinations of any cell types. This includes 0D (e.g., points), 1D (e.g., lines, polylines), 2D (e.g.,
triangles, polygons), and 3D (e.g., hexahedron, tetrahedron).
To create an instance of class vtkUnstructuredGrid, simply invoke its constructor as follows
obj = vtkUnstructuredGrid
32.220.2
Methods
The class vtkUnstructuredGrid has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkUnstructuredGrid class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkUnstructuredGrid = obj.NewInstance ()
vtkUnstructuredGrid = obj.SafeDownCast (vtkObject o)
int = obj.GetDataObjectType () - Standard vtkDataSet API methods. See vtkDataSet for more
information.
obj.Allocate (vtkIdType numCells, int extSize) - Standard vtkDataSet API methods.
See vtkDataSet for more information.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1034
32.221 vtkUnstructuredGridAlgorithm
1035
int = obj.GetNumberOfPieces () - Set / Get the piece and the number of pieces. Similar to extent
in 3D.
int = obj.GetGhostLevel () - Get the ghost level.
long = obj.GetActualMemorySize () - Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than
or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the
return value). THIS METHOD IS THREAD SAFE.
obj.ShallowCopy (vtkDataObject src) - Shallow and Deep copy.
obj.DeepCopy (vtkDataObject src) - Shallow and Deep copy.
obj.GetIdsOfCellsOfType (int type, vtkIdTypeArray array) - Fill vtkIdTypeArray
container with list of cell Ids. This method traverses all cells and, for a particular cell type, inserts the cell Id
into the container.
int = obj.IsHomogeneous () - Traverse cells and determine if cells are all of the same type.
obj.RemoveGhostCells (int level) - This method will remove any cell that has a ghost level
array value greater or equal to level.
32.221
vtkUnstructuredGridAlgorithm
32.221.1
Usage
32.221.2
Methods
The class vtkUnstructuredGridAlgorithm has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkUnstructuredGridAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkUnstructuredGridAlgorithm = obj.NewInstance ()
vtkUnstructuredGridAlgorithm = obj.SafeDownCast (vtkObject o)
vtkUnstructuredGrid = obj.GetOutput () - Get the output data object for a port on this algorithm.
vtkUnstructuredGrid = obj.GetOutput (int ) - Get the output data object for a port on this
algorithm.
obj.SetOutput (vtkDataObject d) - Get the output data object for a port on this algorithm.
vtkDataObject = obj.GetInput (int port)
vtkDataObject = obj.GetInput ()
vtkUnstructuredGrid = obj.GetUnstructuredGridInput (int port)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1036
obj.SetInput (vtkDataObject ) - Set an input of this algorithm. You should not override these
methods because they are not the only way to connect a pipeline. Note that these methods support oldstyle pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection
within a single port.
obj.SetInput (int , vtkDataObject ) - Set an input of this algorithm. You should not override
these methods because they are not the only way to connect a pipeline. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a
connection within a single port.
obj.AddInput (vtkDataObject ) - Add an input of this algorithm. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
obj.AddInput (int , vtkDataObject ) - Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
32.222
vtkUnstructuredGridSource
32.222.1
Usage
32.222.2
Methods
The class vtkUnstructuredGridSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkUnstructuredGridSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkUnstructuredGridSource = obj.NewInstance ()
vtkUnstructuredGridSource = obj.SafeDownCast (vtkObject o)
vtkUnstructuredGrid = obj.GetOutput () - Get the output of this source.
vtkUnstructuredGrid = obj.GetOutput (int idx) - Get the output of this source.
obj.SetOutput (vtkUnstructuredGrid output) - Get the output of this source.
32.223
vtkUnstructuredGridToPolyDataFilter
32.224 vtkUnstructuredGridToUnstructuredGridFilter
32.223.1
1037
Usage
vtkUnstructuredGridToPolyDataFilter is an abstract filter class whose subclasses take as input datasets of type
vtkUnstructuredGrid and generate polygonal data on output.
To create an instance of class vtkUnstructuredGridToPolyDataFilter, simply invoke its constructor as follows
obj = vtkUnstructuredGridToPolyDataFilter
32.223.2
Methods
The class vtkUnstructuredGridToPolyDataFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkUnstructuredGridToPolyDataFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkUnstructuredGridToPolyDataFilter = obj.NewInstance ()
vtkUnstructuredGridToPolyDataFilter = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkUnstructuredGrid input) - Set / get the input data or filter.
vtkUnstructuredGrid = obj.GetInput () - Set / get the input data or filter.
obj.ComputeInputUpdateExtents (vtkDataObject output) - Do not let datasets return
more than requested.
32.224
vtkUnstructuredGridToUnstructuredGridFilter
32.224.1
Usage
32.224.2
Methods
The class vtkUnstructuredGridToUnstructuredGridFilter has several methods that can be used. They are listed
below. Note that the documentation is translated automatically from the VTK sources, and may not be completely
intelligible. When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkUnstructuredGridToUnstructuredGridFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkUnstructuredGridToUnstructuredGridFilter = obj.NewInstance ()
vtkUnstructuredGridToUnstructuredGridFilter = obj.SafeDownCast (vtk-
Object o)
obj.SetInput (vtkUnstructuredGrid input) - Set / get the input Grid or filter.
vtkUnstructuredGrid = obj.GetInput () - Set / get the input Grid or filter.
int = obj.FillInputPortInformation (int , vtkInformation )
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1038
32.225
vtkVertex
32.225.1
Usage
32.225.2
Methods
The class vtkVertex has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkVertex class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVertex = obj.NewInstance ()
vtkVertex = obj.SafeDownCast (vtkObject o)
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int ) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int ) - See the vtkCell API for descriptions of these methods.
obj.Clip (double value, vtkDataArray cellScalars, vtkIncrementalPoint-
Locator locator, vtkCellArray pts, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData outCd, int insideOut) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is inside or outside of the cell. The cell boundary is defined by a list of points (pts) that specify a vertex (1D cell).
If the return value of the method is != 0, then the point is inside the cell.
obj.Contour (double value, vtkDataArray cellScalars, vtkIncremental-
PointLocator locator, vtkCellArray verts1, vtkCellArray lines, vtkCellArray verts2, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - Generate contouring primitives. The scalar list cellScalars are scalar values at each cell point. The point locator is essentially a points list that merges points as
they are inserted (i.e., prevents duplicates).
int = obj.GetParametricCenter (double pcoords[3]) - Return the center of the triangle
in parametric coordinates.
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts) - Triangulate the vertex. This method fills pts and ptIds with information from the only point in the vertex.
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs) - Get the derivative of the vertex. Returns (0.0, 0.0, 0.0) for all dimensions.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.226 vtkVertexListIterator
1039
32.226
vtkVertexListIterator
32.226.1
Usage
vtkVertexListIterator iterates through all vertices in a graph. Create an instance of this and call graph->GetVertices(it) to initialize this iterator. You may alternately call SetGraph() to initialize the iterator.
To create an instance of class vtkVertexListIterator, simply invoke its constructor as follows
obj = vtkVertexListIterator
32.226.2
Methods
The class vtkVertexListIterator has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkVertexListIterator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVertexListIterator = obj.NewInstance ()
vtkVertexListIterator = obj.SafeDownCast (vtkObject o)
obj.SetGraph (vtkGraph graph) - Setup the iterator with a graph.
vtkGraph = obj.GetGraph () - Get the graph associated with this iterator.
vtkIdType = obj.Next () - Whether this iterator has more edges.
bool = obj.HasNext ()
32.227
vtkViewDependentErrorMetric
32.227.1
Usage
It is a concrete error metric, based on a geometric criterium in the screen space: the variation of the projected edge
from a projected straight line
To create an instance of class vtkViewDependentErrorMetric, simply invoke its constructor as follows
obj = vtkViewDependentErrorMetric
1040
32.227.2
Methods
The class vtkViewDependentErrorMetric has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkViewDependentErrorMetric class.
string = obj.GetClassName () - Standard VTK type and error macros.
int = obj.IsA (string name) - Standard VTK type and error macros.
vtkViewDependentErrorMetric = obj.NewInstance () - Standard VTK type and error
macros.
vtkViewDependentErrorMetric = obj.SafeDownCast (vtkObject o) - Standard VTK
type and error macros.
double = obj.GetPixelTolerance () - Return the squared screen-based geometric accurary
measured in pixels. An accuracy less or equal to 0.25 (0.5 2) ensures that the screen-space interpolation of a mid-point matchs exactly with the projection of the mid-point (a value less than 1 but greater than
0.25 is not enough, because of 8-neighbors). Maybe it is useful for lower accuracy in case of anti-aliasing?
Postcondition
positive_result: result>0
obj.SetPixelTolerance (double value) - Set the squared screen-based geometric accuracy
measured in pixels. Subdivision will be required if the square distance between the projection of the real point
and the straight line passing through the projection of the vertices of the edge is greater than value. For
instance, 0.25 will give better result than 1.
Precondition
positive_value: value>0
vtkViewport = obj.GetViewport () - Set/Get the renderer with renderer on which the error
metric is based. The error metric use the active camera of the renderer.
obj.SetViewport (vtkViewport viewport) - Set/Get the renderer with renderer on which the
error metric is based. The error metric use the active camera of the renderer.
int = obj.RequiresEdgeSubdivision (double leftPoint, double midPoint,
double rightPoint, double alpha) - Does the edge need to be subdivided according to
the distance between the line passing through its endpoints in screen space and the projection of its mid
point? The edge is defined by its leftPoint and its rightPoint. leftPoint, midPoint and rightPoint have
to be initialized before calling RequiresEdgeSubdivision(). Their format is global coordinates, parametric
coordinates and point centered attributes: xyx rst abc de... alpha is the normalized abscissa of the midpoint
along the edge. (close to 0 means close to the left point, close to 1 means close to the right point)
Precondition
leftPoint_exists: leftPoint!=0
midPoint_exists: midPoint!=0
rightPoint_exists: rightPoint!=0
clamped_alpha: alpha>0 && alpha<1
valid_size: sizeof(leftPoint)=sizeof(midPoint)=sizeof(rightPoint) =GetAttributeCollection()->GetNumberOfPointCenteredComponents()+6
double = obj.GetError (double leftPoint, double midPoint, double rightPoint, double alpha) - Return the error at the mid-point. The type of error depends on the state of
the concrete error metric. For instance, it can return an absolute or relative error metric. See RequiresEdgeSubdivision() for a description of the arguments.
32.228 vtkViewport
1041
Precondition
leftPoint_exists: leftPoint!=0
midPoint_exists: midPoint!=0
rightPoint_exists: rightPoint!=0
clamped_alpha: alpha>0 && alpha<1
valid_size: sizeof(leftPoint)=sizeof(midPoint)=sizeof(rightPoint) =GetAttributeCollection()->GetNumberOfPointCenteredComponents()+6
Postcondition
positive_result: result>=0
32.228
vtkViewport
32.228.1
Usage
vtkViewport provides an abstract specification for Viewports. A Viewport is an object that controls the rendering
process for objects. Rendering is the process of converting geometry, a specification for lights, and a camera view
into an image. vtkViewport also performs coordinate transformation between world coordinates, view coordinates
(the computer graphics rendering coordinate system), and display coordinates (the actual screen coordinates on
the display device). Certain advanced rendering features such as two-sided lighting can also be controlled.
To create an instance of class vtkViewport, simply invoke its constructor as follows
obj = vtkViewport
32.228.2
Methods
The class vtkViewport has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkViewport class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkViewport = obj.NewInstance ()
vtkViewport = obj.SafeDownCast (vtkObject o)
obj.AddViewProp (vtkProp ) - Add a prop to the list of props. Prop is the superclass of all actors,
volumes, 2D actors, composite props etc.
vtkPropCollection = obj.GetViewProps () - Return any props in this viewport.
int = obj.HasViewProp (vtkProp ) - Query if a prop is in the list of props.
obj.RemoveViewProp (vtkProp ) - Remove an actor from the list of actors.
obj.RemoveAllViewProps (void ) - Remove all actors from the list of actors.
obj.AddActor2D (vtkProp p) - Add/Remove different types of props to the renderer. These methods are all synonyms to AddViewProp and RemoveViewProp. They are here for convenience and backwards
compatibility.
obj.RemoveActor2D (vtkProp p) - Add/Remove different types of props to the renderer. These
methods are all synonyms to AddViewProp and RemoveViewProp. They are here for convenience and backwards compatibility.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1042
32.228 vtkViewport
1043
1044
double = obj.GetPickX () const - Methods used to return the pick (x,y) in local display coordinates (i.e., its that same as selectionX and selectionY).
double = obj.GetPickY () const - Methods used to return the pick (x,y) in local display coordinates (i.e., its that same as selectionX and selectionY).
double = obj.GetPickWidth () const - Methods used to return the pick (x,y) in local display
coordinates (i.e., its that same as selectionX and selectionY).
double = obj.GetPickHeight () const - Methods used to return the pick (x,y) in local display
coordinates (i.e., its that same as selectionX and selectionY).
double = obj.GetPickX1 () const - Methods used to return the pick (x,y) in local display coordinates (i.e., its that same as selectionX and selectionY).
double = obj.GetPickY1 () const - Methods used to return the pick (x,y) in local display coordinates (i.e., its that same as selectionX and selectionY).
double = obj.GetPickX2 () const - Methods used to return the pick (x,y) in local display coordinates (i.e., its that same as selectionX and selectionY).
double = obj.GetPickY2 () const - Methods used to return the pick (x,y) in local display coordinates (i.e., its that same as selectionX and selectionY).
int = obj.GetIsPicking () - Methods used to return the pick (x,y) in local display coordinates (i.e.,
its that same as selectionX and selectionY).
vtkPropCollection = obj.GetPickResultProps () - Methods used to return the pick (x,y)
in local display coordinates (i.e., its that same as selectionX and selectionY).
double = obj.GetPickedZ () - Return the Z value for the last picked Prop.
obj.RemoveProp (vtkProp ) -
32.229
vtkVoxel
32.229.1
Usage
32.229.2
Methods
The class vtkVoxel has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkVoxel class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVoxel = obj.NewInstance ()
vtkVoxel = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
32.230 vtkWedge
1045
int = obj.GetCellType () - See the vtkCell API for descriptions of these methods.
int = obj.GetCellDimension () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfEdges () - See the vtkCell API for descriptions of these methods.
int = obj.GetNumberOfFaces () - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetEdge (int edgeId) - See the vtkCell API for descriptions of these methods.
vtkCell = obj.GetFace (int faceId) - See the vtkCell API for descriptions of these methods.
int = obj.CellBoundary (int subId, double pcoords[3], vtkIdList pts)
See the vtkCell API for descriptions of these methods.
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts) - See the
vtkCell API for descriptions of these methods.
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs) - See the vtkCell API for descriptions of these methods.
obj.InterpolateFunctions (double pcoords[3], double weights[8]) - Compute
the interpolation functions/derivatives (aka shape functions/derivatives)
obj.InterpolateDerivs (double pcoords[3], double derivs[24]) - Return the ids
of the vertices defining edge/face (edgeId/faceId). Ids are related to the cell, not to the dataset.
32.230
vtkWedge
32.230.1
Usage
vtkWedge is a concrete implementation of vtkCell to represent a linear 3D wedge. A wedge consists of two triangular
and three quadrilateral faces and is defined by the six points (0-5). vtkWedge uses the standard isoparametric shape
functions for a linear wedge. The wedge is defined by the six points (0-5) where (0,1,2) is the base of the wedge
which, using the right hand rule, forms a triangle whose normal points outward (away from the triangular face
(3,4,5)).
To create an instance of class vtkWedge, simply invoke its constructor as follows
obj = vtkWedge
32.230.2
Methods
The class vtkWedge has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkWedge class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkWedge = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1046
PointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd,
vtkIdType cellId, vtkCellData outCd) - See the vtkCell API for descriptions of these methods.
int = obj.Triangulate (int index, vtkIdList ptIds, vtkPoints pts) - See the
vtkCell API for descriptions of these methods.
obj.Derivatives (int subId, double pcoords[3], double values, int dim,
double derivs) - See the vtkCell API for descriptions of these methods.
int = obj.GetParametricCenter (double pcoords[3]) - Return the center of the wedge
in parametric coordinates.
obj.InterpolateFunctions (double pcoords[3], double weights[6]) - Compute
the interpolation functions/derivatives (aka shape functions/derivatives)
obj.InterpolateDerivs (double pcoords[3], double derivs[18]) - Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Chapter 33
1048
vtkGeoView
vtkGeoView2D
vtkGlobeSource
33.1
vtkCompassRepresentation
33.1.1
Usage
33.1.2
Methods
The class vtkCompassRepresentation has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCompassRepresentation
class.
string = obj.GetClassName () - Standard methods for the class.
int = obj.IsA (string name) - Standard methods for the class.
vtkCompassRepresentation = obj.NewInstance () - Standard methods for the class.
vtkCompassRepresentation = obj.SafeDownCast (vtkObject o) - Standard methods
for the class.
vtkCoordinate = obj.GetPoint1Coordinate () - Position the first end point of the slider.
Note that this point is an instance of vtkCoordinate, meaning that Point 1 can be specified in a variety of
coordinate systems, and can even be relative to another point. To set the point, youll want to get the Point1Coordinate and then invoke the necessary methods to put it into the correct coordinate system and set the
correct initial value.
vtkCoordinate = obj.GetPoint2Coordinate () - Position the second end point of the slider.
Note that this point is an instance of vtkCoordinate, meaning that Point 1 can be specified in a variety of
coordinate systems, and can even be relative to another point. To set the point, youll want to get the Point2Coordinate and then invoke the necessary methods to put it into the correct coordinate system and set the
correct initial value.
vtkProperty2D = obj.GetRingProperty () - Get the slider properties. The properties of the
slider when selected and unselected can be manipulated.
vtkProperty2D = obj.GetSelectedProperty () - Get the selection property. This property is
used to modify the appearance of selected objects (e.g., the slider).
vtkTextProperty = obj.GetLabelProperty () - Set/Get the properties for the label and title
text.
obj.PlaceWidget (double bounds[6]) - Methods to interface with the vtkSliderWidget. The
PlaceWidget() method assumes that the parameter bounds[6] specifies the location in display space where
the widget should be placed.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
33.2 vtkCompassWidget
1049
33.2
vtkCompassWidget
1050
33.2.1
Usage
The vtkCompassWidget is used to adjust a scalar value in an application. Note that the actual appearance of the
widget depends on the specific representation for the widget.
To use this widget, set the widget representation. (the details may vary depending on the particulars of the representation).
.SECTION Event Bindings By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
Note that the event bindings described above can be changed using this classs vtkWidgetEventTranslator. This
class translates VTK events into the vtkCompassWidgets widget events:
In turn, when these widget events are processed, the vtkCompassWidget invokes the following VTK events on itself
(which observers can listen for):
33.2.2
Methods
The class vtkCompassWidget has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkCompassWidget class.
string = obj.GetClassName () - Standard macros.
int = obj.IsA (string name) - Standard macros.
vtkCompassWidget = obj.NewInstance () - Standard macros.
vtkCompassWidget = obj.SafeDownCast (vtkObject o) - Standard macros.
obj.SetRepresentation (vtkCompassRepresentation r) - Create the default widget representation if one is not set.
obj.CreateDefaultRepresentation () - Create the default widget representation if one is not
set.
double = obj.GetHeading () - Get the value for this widget.
obj.SetHeading (double v) - Get the value for this widget.
double = obj.GetTilt () - Get the value for this widget.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
33.3 vtkGeoAdaptiveArcs
1051
33.3
vtkGeoAdaptiveArcs
33.3.1
Usage
33.3.2
Methods
The class vtkGeoAdaptiveArcs has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoAdaptiveArcs class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoAdaptiveArcs = obj.NewInstance ()
vtkGeoAdaptiveArcs = obj.SafeDownCast (vtkObject o)
obj.SetGlobeRadius (double ) - The base radius used to determine the earths surface. Default
is the earths radius in meters. TODO: Change this to take in a vtkGeoTerrain to get altitude.
double = obj.GetGlobeRadius () - The base radius used to determine the earths surface. Default is the earths radius in meters. TODO: Change this to take in a vtkGeoTerrain to get altitude.
obj.SetMaximumPixelSeparation (double ) - The maximum number of pixels between points
on the arcs. If two adjacent points are farther than the threshold, the line segment will be subdivided such
that each point is separated by at most the threshold.
double = obj.GetMaximumPixelSeparation () - The maximum number of pixels between
points on the arcs. If two adjacent points are farther than the threshold, the line segment will be subdivided
such that each point is separated by at most the threshold.
obj.SetMinimumPixelSeparation (double ) - The minimum number of pixels between points
on the arcs. Points closer than the threshold will be skipped until a point farther than the minimum threshold
is reached.
double = obj.GetMinimumPixelSeparation () - The minimum number of pixels between
points on the arcs. Points closer than the threshold will be skipped until a point farther than the minimum
threshold is reached.
obj.SetRenderer (vtkRenderer ren) - The renderer used to estimate the number of pixels between points.
vtkRenderer = obj.GetRenderer () - The renderer used to estimate the number of pixels between points.
long = obj.GetMTime () - Return the modified time of this object.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1052
33.4
vtkGeoAlignedImageRepresentation
33.4.1
Usage
vtkGeoAlignedImageRepresentation represents a high resolution image over the globle. It has an associated vtkGeoSource which is responsible for fetching new data. This class keeps the fetched data in a quad-tree structure
organized by latitude and longitude.
To create an instance of class vtkGeoAlignedImageRepresentation, simply invoke its constructor as follows
obj = vtkGeoAlignedImageRepresentation
33.4.2
Methods
The class vtkGeoAlignedImageRepresentation has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoAlignedImageRepresentation class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoAlignedImageRepresentation = obj.NewInstance ()
vtkGeoAlignedImageRepresentation = obj.SafeDownCast (vtkObject o)
vtkGeoImageNode = obj.GetBestImageForBounds (double bounds[4]) - Retrieve the
most refined image patch that covers the specified latitude and longitude bounds (lat-min, lat-max, long-min,
long-max).
vtkGeoSource = obj.GetSource () - The source for this representation. This must be set first
before calling GetBestImageForBounds.
obj.SetSource (vtkGeoSource source) - The source for this representation. This must be set
first before calling GetBestImageForBounds.
obj.SaveDatabase (string path) - Serialize the database to the specified directory. Each image
is stored as a .vti file. The Origin and Spacing of the saved image contain (lat-min, long-min) and (lat-max,
long-max), respectively. Files are named based on their level and id within that level.
33.5
vtkGeoAlignedImageSource
33.5.1
Usage
vtkGeoAlignedImageSource uses a high resolution image to generate tiles at multiple resolutions in a hierarchy. It
should be used as a source in vtkGeoAlignedImageRepresentation.
To create an instance of class vtkGeoAlignedImageSource, simply invoke its constructor as follows
obj = vtkGeoAlignedImageSource
33.6 vtkGeoArcs
33.5.2
1053
Methods
The class vtkGeoAlignedImageSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoAlignedImageSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoAlignedImageSource = obj.NewInstance ()
vtkGeoAlignedImageSource = obj.SafeDownCast (vtkObject o)
bool = obj.FetchRoot (vtkGeoTreeNode node) - Fetch the root image.
bool = obj.FetchChild (vtkGeoTreeNode parent, int index, vtkGeoTreeNode
child) - Fetch a child image.
vtkImageData = obj.GetImage () - The high-resolution image to be used to cover the globe.
obj.SetImage (vtkImageData image) - The high-resolution image to be used to cover the globe.
obj.SetLatitudeRange (double , double ) - The range of the input hi-res image.
obj.SetLatitudeRange (double a[2]) - The range of the input hi-res image.
double = obj.
33.6
vtkGeoArcs
33.6.1
Usage
vtkGeoArcs produces arcs for each line in the input polydata. This is useful for viewing lines on a sphere (e.g. the
earth). The arcs may "jump" above the spheres surface using ExplodeFactor.
To create an instance of class vtkGeoArcs, simply invoke its constructor as follows
obj = vtkGeoArcs
1054
33.6.2
Methods
The class vtkGeoArcs has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkGeoArcs class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoArcs = obj.NewInstance ()
vtkGeoArcs = obj.SafeDownCast (vtkObject o)
obj.SetGlobeRadius (double ) - The base radius used to determine the earths surface. Default
is the earths radius in meters.
double = obj.GetGlobeRadius () - The base radius used to determine the earths surface. Default is the earths radius in meters.
obj.SetExplodeFactor (double ) - Factor on which to "explode" the arcs away from the surface.
A value of 0.0 keeps the values on the surface. Values larger than 0.0 push the arcs away from the surface
by a distance proportional to the distance between the points. The default is 0.2.
double = obj.GetExplodeFactor () - Factor on which to "explode" the arcs away from the surface. A value of 0.0 keeps the values on the surface. Values larger than 0.0 push the arcs away from the
surface by a distance proportional to the distance between the points. The default is 0.2.
obj.SetNumberOfSubdivisions (int ) - The number of subdivisions in the arc. The default is
20.
int = obj.GetNumberOfSubdivisions () - The number of subdivisions in the arc. The default
is 20.
33.7
vtkGeoAssignCoordinates
33.7.1
Usage
Givem latitude and longitude arrays, take the values in those arrays and convert them to x,y,z world coordinates.
Uses a spherical model of the earth to do the conversion. The position is in meters relative to the center of the
earth.
If a transform is given, use the transform to convert latitude and longitude to the world coordinate.
To create an instance of class vtkGeoAssignCoordinates, simply invoke its constructor as follows
obj = vtkGeoAssignCoordinates
33.7.2
Methods
The class vtkGeoAssignCoordinates has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoAssignCoordinates
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
33.8 vtkGeoCamera
1055
vtkGeoAssignCoordinates = obj.NewInstance ()
vtkGeoAssignCoordinates = obj.SafeDownCast (vtkObject o)
obj.SetLongitudeArrayName (string ) - Set the longitude coordinate array name.
string = obj.GetLongitudeArrayName () - Set the longitude coordinate array name.
obj.SetLatitudeArrayName (string ) - Set the latitude coordinate array name.
string = obj.GetLatitudeArrayName () - Set the latitude coordinate array name.
obj.SetGlobeRadius (double ) - The base radius to use in GLOBAL mode. Default is the earths
radius.
double = obj.GetGlobeRadius () - The base radius to use in GLOBAL mode. Default is the
earths radius.
obj.SetTransform (vtkAbstractTransform trans) - The transform to use to convert coordinates of the form (lat, long, 0) to (x, y z). If this is NULL (the default), use GlobeRadius to perform a spherical
embedding.
vtkAbstractTransform = obj.GetTransform () - The transform to use to convert coordinates
of the form (lat, long, 0) to (x, y z). If this is NULL (the default), use GlobeRadius to perform a spherical
embedding.
obj.SetCoordinatesInArrays (bool ) - If on, uses LatitudeArrayName and LongitudeArrayName to move values in data arrays into the points of the data set. Turn off if the lattitude and longitude
are already in the points.
bool = obj.GetCoordinatesInArrays () - If on, uses LatitudeArrayName and LongitudeArrayName to move values in data arrays into the points of the data set. Turn off if the lattitude and longitude are
already in the points.
obj.CoordinatesInArraysOn () - If on, uses LatitudeArrayName and LongitudeArrayName to
move values in data arrays into the points of the data set. Turn off if the lattitude and longitude are already in
the points.
obj.CoordinatesInArraysOff () - If on, uses LatitudeArrayName and LongitudeArrayName to
move values in data arrays into the points of the data set. Turn off if the lattitude and longitude are already in
the points.
33.8
vtkGeoCamera
33.8.1
Usage
I wanted to hide the normal vtkCamera API so I did not make this a subclass. The camera is a helper object. You
can get a pointer to the camera, but it should be treated like a const.
To create an instance of class vtkGeoCamera, simply invoke its constructor as follows
obj = vtkGeoCamera
1056
33.8.2
Methods
The class vtkGeoCamera has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkGeoCamera class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoCamera = obj.NewInstance ()
vtkGeoCamera = obj.SafeDownCast (vtkObject o)
double = obj.
obj.SetLongitude (double longitude) - Longitude is in degrees: (-180->180) Relative to absolute coordinates. Rotate Longitude around z axis (earth axis),
double = obj.GetLongitude () - Longitude is in degrees: (-180->180) Relative to absolute coordinates. Rotate Longitude around z axis (earth axis),
obj.SetLatitude (double latitude) - Latitude is in degrees: (-90->90) Relative to Longitude.
Rotate Latitude around x axis by Latitude,
double = obj.GetLatitude () - Latitude is in degrees: (-90->90) Relative to Longitude. Rotate
Latitude around x axis by Latitude,
obj.SetDistance (double Distance) - Distance is in Meters Relative to Longitude and Latitude.
above sea level ???? should we make this from center of earth ???? ???? what about equatorial bulge ????
double = obj.GetDistance () - Distance is in Meters Relative to Longitude and Latitude. above
sea level ???? should we make this from center of earth ???? ???? what about equatorial bulge ????
obj.SetHeading (double heading) - Heading is in degrees: (-180->180) Relative to Logitude
and Latitude. 0 is north. 90 is east. ???? what is the standard ???? 180 is south. -90 is west. Rotate
Heading around -y axis Center,
double = obj.GetHeading () - Heading is in degrees: (-180->180) Relative to Logitude and Latitude. 0 is north. 90 is east. ???? what is the standard ???? 180 is south. -90 is west. Rotate Heading
around -y axis Center,
obj.SetTilt (double tilt) - Tilt is also know as pitch. Tilt is in degrees: (0->90) Relative to
Longitude, Latitude, and Heading. Rotate Tilt around x axis,
double = obj.GetTilt () - Tilt is also know as pitch. Tilt is in degrees: (0->90) Relative to Longitude, Latitude, and Heading. Rotate Tilt around x axis,
vtkCamera = obj.GetVTKCamera () - This vtk camera is updated to match this geo cameras state.
It should be treated as a const and should not be modified.
obj.InitializeNodeAnalysis (int rendererSize[2]) - We precompute some values to
speed up update of the terrain. Unfortunately, they have to be manually/explicitely updated when the camera
or renderer size changes.
double = obj.GetNodeCoverage (vtkGeoTerrainNode node) - This method estimates
how much of the view is covered by the sphere. Returns a value from 0 to 1.
bool = obj.GetLockHeading ()
obj.SetLockHeading (bool )
obj.LockHeadingOn ()
obj.LockHeadingOff ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
33.9 vtkGeoFileImageSource
1057
obj.SetOriginLatitude (double oLat) - This point is shifted to 0,0,0 to avoid openGL issues.
double = obj.GetOriginLatitude () - This point is shifted to 0,0,0 to avoid openGL issues.
obj.SetOriginLongitude (double oLat) - This point is shifted to 0,0,0 to avoid openGL issues.
double = obj.GetOriginLongitude () - This point is shifted to 0,0,0 to avoid openGL issues.
double = obj. GetOrigin () - Get the rectilinear cooridinate location of the origin. This is used
to shift the terrain points.
obj.SetOrigin (double ox, double oy, double oz)
33.9
vtkGeoFileImageSource
33.9.1
Usage
vtkGeoFileImageSource is a vtkGeoSource that fetches .vti images from disk in a directory with a certain naming
scheme. You may use vtkGeoAlignedImageRepresentations SaveDatabase method to generate an database of
image tiles in this format.
To create an instance of class vtkGeoFileImageSource, simply invoke its constructor as follows
obj = vtkGeoFileImageSource
33.9.2
Methods
The class vtkGeoFileImageSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoFileImageSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoFileImageSource = obj.NewInstance ()
vtkGeoFileImageSource = obj.SafeDownCast (vtkObject o)
vtkGeoFileImageSource = obj.()
vtkGeoFileImageSource = obj.()
bool = obj.FetchRoot (vtkGeoTreeNode root) - Fetches the root image representing the
whole globe.
bool = obj.FetchChild (vtkGeoTreeNode node, int index, vtkGeoTreeNode
child) - Fetches the child image of a parent from disk.
obj.SetPath (string ) - The path the tiled image database.
string = obj.GetPath () - The path the tiled image database.
33.10
vtkGeoFileTerrainSource
1058
33.10.1
Usage
vtkGeoFileTerrainSource reads geometry tiles as .vtp files from a directory that follow a certain naming convention
containing the level of the patch and the position within that level. Use vtkGeoTerrains SaveDatabase method to
create a database of files in this format.
To create an instance of class vtkGeoFileTerrainSource, simply invoke its constructor as follows
obj = vtkGeoFileTerrainSource
33.10.2
Methods
The class vtkGeoFileTerrainSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoFileTerrainSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoFileTerrainSource = obj.NewInstance ()
vtkGeoFileTerrainSource = obj.SafeDownCast (vtkObject o)
vtkGeoFileTerrainSource = obj.()
vtkGeoFileTerrainSource = obj.()
bool = obj.FetchRoot (vtkGeoTreeNode root) - Retrieve the root geometry representing the
entire globe.
bool = obj.FetchChild (vtkGeoTreeNode node, int index, vtkGeoTreeNode
child)
obj.SetPath (string ) - The path the tiled geometry database.
string = obj.GetPath () - The path the tiled geometry database.
33.11
vtkGeoGlobeSource
33.11.1
Usage
vtkGeoGlobeSource is a 3D vtkGeoSource suitable for use in vtkGeoTerrain. It uses the vtkGlobeSource filter to
produce terrain patches.
To create an instance of class vtkGeoGlobeSource, simply invoke its constructor as follows
obj = vtkGeoGlobeSource
33.11.2
Methods
The class vtkGeoGlobeSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoGlobeSource class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
33.12 vtkGeoGraticule
1059
33.12
vtkGeoGraticule
33.12.1
Usage
This filter generates polydata to illustrate the distortions introduced by a map projection. The level parameter
specifies the number of lines to be drawn. Poles are treated differently than other regions; hence the use of a Level
parameter instead of a NumberOfLines parameter. The latitude and longitude are specified as half-open intervals
with units of degrees. By default the latitude bounds are [-90,90[ and the longitude bounds are [0,180[.
To create an instance of class vtkGeoGraticule, simply invoke its constructor as follows
obj = vtkGeoGraticule
33.12.2
Methods
The class vtkGeoGraticule has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkGeoGraticule class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoGraticule = obj.NewInstance ()
vtkGeoGraticule = obj.SafeDownCast (vtkObject o)
obj.SetLatitudeBounds (double , double ) - The latitude bounds of the graticule.
obj.SetLatitudeBounds (double a[2]) - The latitude bounds of the graticule.
double = obj.
1060
33.13
vtkGeoImageNode
33.13.1
Usage
vtkGeoImageNode contains an image tile in a multi-resolution image tree, along with metadata about that images
extents.
To create an instance of class vtkGeoImageNode, simply invoke its constructor as follows
obj = vtkGeoImageNode
33.13.2
Methods
The class vtkGeoImageNode has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoImageNode class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoImageNode = obj.NewInstance ()
vtkGeoImageNode = obj.SafeDownCast (vtkObject o)
vtkGeoImageNode = obj.GetChild (int idx)
vtkGeoImageNode = obj.GetParent ()
vtkImageData = obj.GetImage () - Get the image tile.
obj.SetImage (vtkImageData image) - Get the image tile.
vtkTexture = obj.GetTexture () - Get the image tile.
obj.SetTexture (vtkTexture texture) - Get the image tile.
obj.CropImageForTile (vtkImageData image, double imageLonLatExt, string
prefix) - This crops the image as small as possible while still covering the patch. The Longitude Latitude
range may get bigger to reflect the actual size of the image. If prefix is specified, writes the tile to that location.
obj.LoadAnImage (string prefix) - This loads the image from a tile database at the specified
location.
obj.ShallowCopy (vtkGeoTreeNode src) - Shallow and Deep copy.
obj.DeepCopy (vtkGeoTreeNode src) - Shallow and Deep copy.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
33.14 vtkGeoInteractorStyle
1061
bool = obj.HasData ()
obj.DeleteData () - Deletes the data associated with the node to make this an "empty" node. This is
performed when the node has been unused for a certain amount of time.
33.14
vtkGeoInteractorStyle
33.14.1
Usage
vtkGeoInteractorStyle contains interaction capabilities for a geographic view including orbit, zoom, and tilt. It also
includes a compass widget for changing view parameters.
To create an instance of class vtkGeoInteractorStyle, simply invoke its constructor as follows
obj = vtkGeoInteractorStyle
33.14.2
Methods
The class vtkGeoInteractorStyle has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoInteractorStyle class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoInteractorStyle = obj.NewInstance ()
vtkGeoInteractorStyle = obj.SafeDownCast (vtkObject o)
obj.OnEnter () - Event bindings
obj.OnLeave () - Event bindings
obj.OnMouseMove () - Event bindings
obj.OnLeftButtonUp () - Event bindings
obj.OnMiddleButtonUp () - Event bindings
obj.OnRightButtonUp () - Event bindings
obj.OnLeftButtonDown () - Event bindings
obj.OnMiddleButtonDown () - Event bindings
obj.OnRightButtonDown () - Event bindings
obj.OnChar () - Event bindings
obj.RubberBandZoom ()
obj.Pan ()
obj.Dolly ()
obj.RedrawRectangle ()
obj.StartState (int newstate)
vtkGeoCamera = obj.GetGeoCamera ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1062
obj.ResetCamera () - This can be used to set the camera to the standard view of the earth.
obj.WidgetInteraction (vtkObject caller)
obj.SetInteractor (vtkRenderWindowInteractor interactor) - Set/Get the Interactor
wrapper being controlled by this object. (Satisfy superclass API.)
int = obj.GetRayIntersection (double origin[3], double direction[3],
double intersection[3])
obj.SetCurrentRenderer (vtkRenderer ) - Override to make the renderer use this camera
subclass
bool = obj.GetLockHeading ()
obj.SetLockHeading (bool )
obj.LockHeadingOn ()
obj.LockHeadingOff ()
obj.ResetCameraClippingRange ()
33.15
vtkGeoProjection
33.15.1
Usage
This class uses the PROJ.4 library to represent geographic coordinate projections.
To create an instance of class vtkGeoProjection, simply invoke its constructor as follows
obj = vtkGeoProjection
33.15.2
Methods
The class vtkGeoProjection has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoProjection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoProjection = obj.NewInstance ()
vtkGeoProjection = obj.SafeDownCast (vtkObject o)
obj.SetName (string ) - Set/get the short name describing the projection you wish to use. This
defaults to "rpoly" for no reason other than I like it. To get a list of valid values, use the GetNumberOfProjections() and GetProjectionName(int) static methods.
string = obj.GetName () - Set/get the short name describing the projection you wish to use. This
defaults to "rpoly" for no reason other than I like it. To get a list of valid values, use the GetNumberOfProjections() and GetProjectionName(int) static methods.
int = obj.GetIndex () - Return the index of the current projections type in the list of all projection
types. On error, this will return -1. On success, it returns a number in [0,GetNumberOfProjections()[.
string = obj.GetDescription () - Get the description of a projection. This will return NULL if the
projection name is invalid.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
33.16 vtkGeoProjectionSource
1063
33.16
vtkGeoProjectionSource
33.16.1
Usage
vtkGeoProjectionSource is a vtkGeoSource suitable for use in vtkTerrain2D. This source uses the libproj4 library to
produce geometry patches at multiple resolutions. Each patch covers a specific region in projected space.
To create an instance of class vtkGeoProjectionSource, simply invoke its constructor as follows
obj = vtkGeoProjectionSource
33.16.2
Methods
The class vtkGeoProjectionSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoProjectionSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoProjectionSource = obj.NewInstance ()
vtkGeoProjectionSource = obj.SafeDownCast (vtkObject o)
vtkGeoProjectionSource = obj.()
vtkGeoProjectionSource = obj.()
bool = obj.FetchRoot (vtkGeoTreeNode root) - Blocking methods for sources with low latency.
bool = obj.FetchChild (vtkGeoTreeNode node, int index, vtkGeoTreeNode
child) - Blocking methods for sources with low latency.
int = obj.GetProjection () - The projection ID defining the projection. Initial value is 0.
obj.SetProjection (int projection) - The projection ID defining the projection. Initial value is
0.
int = obj.GetMinCellsPerNode () - The minimum number of cells per node.
obj.SetMinCellsPerNode (int ) - The minimum number of cells per node.
vtkAbstractTransform = obj.GetTransform () - Return the projection transformation used
by this 2D terrain.
33.17
vtkGeoRandomGraphSource
1064
33.17.1
Usage
Generates a graph with a specified number of vertices, with the density of edges specified by either an exact number
of edges or the probability of an edge. You may additionally specify whether to begin with a random tree (which
enforces graph connectivity).
The filter also adds random vertex attributes called latitude and longitude. The latitude is distributed uniformly from
-90 to 90, while longitude is distributed uniformly from -180 to 180.
To create an instance of class vtkGeoRandomGraphSource, simply invoke its constructor as follows
obj = vtkGeoRandomGraphSource
33.17.2
Methods
The class vtkGeoRandomGraphSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoRandomGraphSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoRandomGraphSource = obj.NewInstance ()
vtkGeoRandomGraphSource = obj.SafeDownCast (vtkObject o)
33.18
vtkGeoSampleArcs
33.18.1
Usage
vtkGeoSampleArcs refines lines in the input polygonal data so that the distance between adjacent points is no more
than a threshold distance. Points are interpolated along the surface of the globe. This is useful in order to keep
lines such as political boundaries from intersecting the globe and becoming invisible.
To create an instance of class vtkGeoSampleArcs, simply invoke its constructor as follows
obj = vtkGeoSampleArcs
33.18.2
Methods
The class vtkGeoSampleArcs has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoSampleArcs class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoSampleArcs = obj.NewInstance ()
vtkGeoSampleArcs = obj.SafeDownCast (vtkObject o)
obj.SetGlobeRadius (double ) - The base radius used to determine the earths surface. Default
is the earths radius in meters. TODO: Change this to take in a vtkGeoTerrain to get altitude.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
33.19 vtkGeoSource
1065
double = obj.GetGlobeRadius () - The base radius used to determine the earths surface. Default is the earths radius in meters. TODO: Change this to take in a vtkGeoTerrain to get altitude.
obj.SetMaximumDistanceMeters (double ) - The maximum distance, in meters, between adjacent points.
double = obj.GetMaximumDistanceMeters () - The maximum distance, in meters, between
adjacent points.
obj.SetInputCoordinateSystem (int ) - The input coordinate system. RECTANGULAR is x,y,z
meters relative the the earth center. SPHERICAL is longitude,latitude,altitude.
int = obj.GetInputCoordinateSystem () - The input coordinate system. RECTANGULAR is
x,y,z meters relative the the earth center. SPHERICAL is longitude,latitude,altitude.
obj.SetInputCoordinateSystemToRectangular () - The input coordinate system. RECTANGULAR is x,y,z meters relative the the earth center. SPHERICAL is longitude,latitude,altitude.
obj.SetInputCoordinateSystemToSpherical () - The desired output coordinate system. RECTANGULAR is x,y,z meters relative the the earth center. SPHERICAL is longitude,latitude,altitude.
obj.SetOutputCoordinateSystem (int ) - The desired output coordinate system. RECTANGULAR is x,y,z meters relative the the earth center. SPHERICAL is longitude,latitude,altitude.
int = obj.GetOutputCoordinateSystem () - The desired output coordinate system. RECTANGULAR is x,y,z meters relative the the earth center. SPHERICAL is longitude,latitude,altitude.
obj.SetOutputCoordinateSystemToRectangular () - The desired output coordinate system.
RECTANGULAR is x,y,z meters relative the the earth center. SPHERICAL is longitude,latitude,altitude.
obj.SetOutputCoordinateSystemToSpherical ()
33.19
vtkGeoSource
33.19.1
Usage
vtkGeoSource is an abstract superclass for all multi-resolution data sources shown in a geographic view like vtkGeoView or vtkGeoView2D. vtkGeoSource subclasses need to implement the FetchRoot() method, which fills a
vtkGeoTreeNode with the low-res data at the root, and FetchChild(), which produces a refinement of a parent
node. Other geovis classes such as vtkGeoTerrain, vtkGeoTerrain2D, and vtkGeoAlignedImageSource use a vtkGeoSource subclass to build their geometry or image caches which are stored in trees. The source itself does not
maintain the tree, but simply provides a mechanism for generating refined tree nodes.
Sources are multi-threaded. Each source may have one or more worker threads associated with it, which this
superclass manages. It is essential that the FetchChild() method is thread-safe, since it may be called from multiple
workers simultaneously.
To create an instance of class vtkGeoSource, simply invoke its constructor as follows
obj = vtkGeoSource
33.19.2
Methods
The class vtkGeoSource has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkGeoSource class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1066
33.20
vtkGeoSphereTransform
33.20.1
Usage
33.21 vtkGeoTerrain
33.20.2
1067
Methods
The class vtkGeoSphereTransform has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoSphereTransform
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoSphereTransform = obj.NewInstance ()
vtkGeoSphereTransform = obj.SafeDownCast (vtkObject o)
obj.Inverse () - Invert the transformation.
obj.InternalTransformPoint (float in[3], float out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformPoint (double in[3], double out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
vtkAbstractTransform = obj.MakeTransform () - Make another transform of the same type.
obj.SetToRectangular (bool ) - If on, this transform converts (long,lat,alt) triples to (x,y,z) as an
offset from the center of the earth. Alt, x, y, and z are all be in meters. If off, the tranform works in the reverse
direction. Initial value is on.
bool = obj.GetToRectangular () - If on, this transform converts (long,lat,alt) triples to (x,y,z) as
an offset from the center of the earth. Alt, x, y, and z are all be in meters. If off, the tranform works in the
reverse direction. Initial value is on.
obj.ToRectangularOn () - If on, this transform converts (long,lat,alt) triples to (x,y,z) as an offset from
the center of the earth. Alt, x, y, and z are all be in meters. If off, the tranform works in the reverse direction.
Initial value is on.
obj.ToRectangularOff () - If on, this transform converts (long,lat,alt) triples to (x,y,z) as an offset
from the center of the earth. Alt, x, y, and z are all be in meters. If off, the tranform works in the reverse
direction. Initial value is on.
obj.SetBaseAltitude (double ) - The base altitude to transform coordinates to. This can be
useful for transforming lines just above the earths surface. Default is 0.
double = obj.GetBaseAltitude () - The base altitude to transform coordinates to. This can be
useful for transforming lines just above the earths surface. Default is 0.
33.21
vtkGeoTerrain
33.21.1
Usage
vtkGeoTerrain contains a multi-resolution tree of geometry representing the globe. It uses a vtkGeoSource subclass
to generate the terrain, such as vtkGeoGlobeSource. This source must be set before using the terrain in a vtkGeoView. The terrain also contains an AddActors() method which will update the set of actors representing the globe
given the current camera position.
To create an instance of class vtkGeoTerrain, simply invoke its constructor as follows
obj = vtkGeoTerrain
1068
33.21.2
Methods
The class vtkGeoTerrain has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkGeoTerrain class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoTerrain = obj.NewInstance ()
vtkGeoTerrain = obj.SafeDownCast (vtkObject o)
vtkGeoSource = obj.GetSource () - The source used to obtain geometry patches.
obj.SetSource (vtkGeoSource source) - The source used to obtain geometry patches.
obj.SaveDatabase (string path, int depth) - Save the set of patches up to a given maximum depth.
obj.AddActors (vtkRenderer ren, vtkAssembly assembly, vtkCollection
imageReps) - Update the actors in an assembly used to render the globe. ren is the current renderer, and imageReps holds the collection of vtkGeoAlignedImageRepresentations that will be blended
together to form the image on the globe.
obj.SetOrigin (double , double , double ) - The world-coordinate origin offset used to
eliminate precision errors when zoomed in to a particular region of the globe.
obj.SetOrigin (double a[3]) - The world-coordinate origin offset used to eliminate precision errors when zoomed in to a particular region of the globe.
double = obj. GetOrigin () - The world-coordinate origin offset used to eliminate precision errors when zoomed in to a particular region of the globe.
obj.SetMaxLevel (int ) - The maximum level of the terrain tree.
int = obj.GetMaxLevelMinValue () - The maximum level of the terrain tree.
int = obj.GetMaxLevelMaxValue () - The maximum level of the terrain tree.
int = obj.GetMaxLevel () - The maximum level of the terrain tree.
33.22
vtkGeoTerrain2D
33.22.1
Usage
vtkGeoTerrain2D contains a multi-resolution tree of geometry representing the globe. It uses a vtkGeoSource
subclass to generate the terrain, such as vtkGeoProjectionSource. This source must be set before using the terrain
in a vtkGeoView2D. The terrain also contains an AddActors() method which updates the set of actors representing
the globe given the current camera position.
To create an instance of class vtkGeoTerrain2D, simply invoke its constructor as follows
obj = vtkGeoTerrain2D
33.23 vtkGeoTerrainNode
33.22.2
1069
Methods
The class vtkGeoTerrain2D has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkGeoTerrain2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoTerrain2D = obj.NewInstance ()
vtkGeoTerrain2D = obj.SafeDownCast (vtkObject o)
obj.SetTextureTolerance (double ) - The maximum size of a single texel in pixels. Images will
be refined if a texel becomes larger than the tolerance.
double = obj.GetTextureTolerance () - The maximum size of a single texel in pixels. Images
will be refined if a texel becomes larger than the tolerance.
obj.SetLocationTolerance (double ) - The maximum allowed deviation of geometry in pixels.
Geometry will be refined if the deviation is larger than the tolerance.
double = obj.GetLocationTolerance () - The maximum allowed deviation of geometry in pixels. Geometry will be refined if the deviation is larger than the tolerance.
vtkAbstractTransform = obj.GetTransform () - Return the projection transformation used
by this 2D terrain.
33.23
vtkGeoTerrainNode
33.23.1
Usage
33.23.2
Methods
The class vtkGeoTerrainNode has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoTerrainNode class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoTerrainNode = obj.NewInstance ()
vtkGeoTerrainNode = obj.SafeDownCast (vtkObject o)
vtkGeoTerrainNode = obj.GetChild (int idx)
vtkGeoTerrainNode = obj.GetParent ()
double = obj.GetAltitude (double longitude, double latitude)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1070
vtkPolyData = obj.GetModel () - Get the terrrain model. The user has to copy the terrain into
this object.
obj.SetModel (vtkPolyData model) - Get the terrrain model. The user has to copy the terrain
into this object.
obj.UpdateBoundingSphere () - Bounding sphere is precomputed for faster updates of terrain.
double = obj.GetBoundingSphereRadius () - Bounding sphere is precomputed for faster updates of terrain.
double = obj.
updates of terrain.
double = obj.
GetCornerNormal00 ()
double = obj.
GetCornerNormal01 ()
double = obj.
GetCornerNormal10 ()
double = obj.
GetCornerNormal11 ()
double = obj. GetProjectionBounds () - For 2D projections, store the bounds of the node in
projected space to quickly determine if a node is offscreen.
obj.SetProjectionBounds (double , double , double , double ) - For 2D projections, store the bounds of the node in projected space to quickly determine if a node is offscreen.
obj.SetProjectionBounds (double a[4]) - For 2D projections, store the bounds of the node in
projected space to quickly determine if a node is offscreen.
int = obj.GetGraticuleLevel () - For 2D projections, store the granularity of the graticule in this
node.
obj.SetGraticuleLevel (int ) - For 2D projections, store the granularity of the graticule in this
node.
double = obj.GetError () - For 2D projections, store the maximum deviation of line segment centers from the actual projection value.
obj.SetError (double ) - For 2D projections, store the maximum deviation of line segment centers
from the actual projection value.
float = obj.GetCoverage () - For 2D projections, store the maximum deviation of line segment
centers from the actual projection value.
obj.SetCoverage (float ) - For 2D projections, store the maximum deviation of line segment centers from the actual projection value.
obj.ShallowCopy (vtkGeoTreeNode src) - Shallow and Deep copy.
obj.DeepCopy (vtkGeoTreeNode src) - Shallow and Deep copy.
bool = obj.HasData () - Returns whether this node has valid data associated with it, or if it is an
"empty" node.
obj.DeleteData () - Deletes the data associated with the node to make this an "empty" node. This is
performed when the node has been unused for a certain amount of time.
33.24
vtkGeoTransform
33.25 vtkGeoTreeNode
33.24.1
1071
Usage
This class takes two geographic projections and transforms point coordinates between them.
To create an instance of class vtkGeoTransform, simply invoke its constructor as follows
obj = vtkGeoTransform
33.24.2
Methods
The class vtkGeoTransform has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoTransform class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoTransform = obj.NewInstance ()
vtkGeoTransform = obj.SafeDownCast (vtkObject o)
obj.SetSourceProjection (vtkGeoProjection source) - The source geographic projection.
vtkGeoProjection = obj.GetSourceProjection () - The source geographic projection.
obj.SetDestinationProjection (vtkGeoProjection dest) - The target geographic projection.
vtkGeoProjection = obj.GetDestinationProjection () - The target geographic projection.
obj.TransformPoints (vtkPoints src, vtkPoints dst) - Transform many points at once.
obj.Inverse () - Invert the transformation.
obj.InternalTransformPoint (float in[3], float out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
obj.InternalTransformPoint (double in[3], double out[3]) - This will calculate the
transformation without calling Update. Meant for use only within other VTK classes.
vtkAbstractTransform = obj.MakeTransform () - Make another transform of the same type.
33.25
vtkGeoTreeNode
33.25.1
Usage
A self-referential data structure for storing geometry or imagery for the geospatial views. The data is organized in
a quadtree. Each node contains a pointer to its parent and owns references to its four child nodes. The ID of each
node is unique in its level, and encodes the path from the root node in its bits.
To create an instance of class vtkGeoTreeNode, simply invoke its constructor as follows
obj = vtkGeoTreeNode
1072
33.25.2
Methods
The class vtkGeoTreeNode has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkGeoTreeNode class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoTreeNode = obj.NewInstance ()
vtkGeoTreeNode = obj.SafeDownCast (vtkObject o)
obj.SetId (long ) - The id uniquely specified this node. For this implementation I am going to store
the branch path in the bits.
long = obj.GetId () - The id uniquely specified this node. For this implementation I am going to store
the branch path in the bits.
obj.SetLevel (int )
int = obj.GetLevel ()
obj.SetLongitudeRange (double , double ) - Longitude and latitude range of the terrain
model.
obj.SetLongitudeRange (double a[2]) - Longitude and latitude range of the terrain model.
double = obj.
obj.SetChild (vtkGeoTreeNode node, int idx) - Get a child of this node. If one is set, then
they all should set. No not mix subclasses.
obj.SetParent (vtkGeoTreeNode node) - Manage links to older and newer tree nodes. These
are used to periodically delete unused patches.
obj.SetOlder (vtkGeoTreeNode node) - Manage links to older and newer tree nodes. These are
used to periodically delete unused patches.
vtkGeoTreeNode = obj.GetOlder () - Manage links to older and newer tree nodes. These are
used to periodically delete unused patches.
obj.SetNewer (vtkGeoTreeNode node) - Manage links to older and newer tree nodes. These are
used to periodically delete unused patches.
vtkGeoTreeNode = obj.GetNewer () - Returns whether this node has valid data associated with
it, or if it is an "empty" node.
bool = obj.HasData () - Deletes the data associated with the node to make this an "empty" node.
This is performed when the node has been unused for a certain amount of time.
obj.DeleteData ()
int = obj.GetWhichChildAreYou ()
bool = obj.IsDescendantOf (vtkGeoTreeNode elder) - This method returns true if this
node descends from the elder node. The descision is made from the node ids, so the nodes do not have
to be in the same tree!
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
33.26 vtkGeoTreeNodeCache
1073
int = obj.CreateChildren ()
vtkGeoTreeNode = obj.GetChildTreeNode (int idx) - Get the parent as a vtkGeoTreeNode. Subclasses also implement GetParent() which returns the parent as the appropriate subclass type.
vtkGeoTreeNode = obj.GetParentTreeNode () - Shallow and Deep copy. Deep copy performs
a shallow copy of the Child nodes.
obj.ShallowCopy (vtkGeoTreeNode src) - Shallow and Deep copy. Deep copy performs a shallow copy of the Child nodes.
obj.DeepCopy (vtkGeoTreeNode src) - Shallow and Deep copy. Deep copy performs a shallow
copy of the Child nodes.
33.26
vtkGeoTreeNodeCache
33.26.1
Usage
vtkGeoTreeNodeCache keeps track of a linked list of vtkGeoTreeNodes, and has operations to move nodes to the
front of the list and to delete data from the least used nodes. This is used to recover memory from nodes that store
data that hasnt been used in a while.
To create an instance of class vtkGeoTreeNodeCache, simply invoke its constructor as follows
obj = vtkGeoTreeNodeCache
33.26.2
Methods
The class vtkGeoTreeNodeCache has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoTreeNodeCache
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoTreeNodeCache = obj.NewInstance ()
vtkGeoTreeNodeCache = obj.SafeDownCast (vtkObject o)
obj.SetCacheMaximumLimit (int ) - The size of the cache of geospatial nodes. When the size
reaches this limit, the list of non-empty nodes will be shortened to CacheMinimumLimit.
int = obj.GetCacheMaximumLimit () - The size of the cache of geospatial nodes. When the size
reaches this limit, the list of non-empty nodes will be shortened to CacheMinimumLimit.
obj.SetCacheMinimumLimit (int ) - The cache is reduced to this size when the maximum limit is
reached.
int = obj.GetCacheMinimumLimit () - The cache is reduced to this size when the maximum limit
is reached.
obj.SendToFront (vtkGeoTreeNode node) - Send a node to the front of the list. Perform this
whenever a node is accessed, so that the most recently accessed nodes data are not deleted.
obj.RemoveNode (vtkGeoTreeNode node) - Remove the node from the list.
int = obj.GetSize () - The current size of the list.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1074
33.27
vtkGeoView
33.27.1
Usage
vtkGeoView is a 3D globe view. The globe may contain a multi-resolution geometry source (vtkGeoTerrain), multiple
multi-resolution image sources (vtkGeoAlignedImageRepresentation), as well as other representations such as vtkRenderedGraphRepresentation. At a minimum, the view must have a terrain and one image representation. The
view uses vtkGeoInteractorStyle to orbit, zoom, and tilt the view, and contains a vtkCompassWidget for manipulating
the camera.
Each terrain or image representation contains a vtkGeoSource subclass which generates geometry or imagery at
multiple resolutions. As the camera position changes, the terrain and/or image representations may ask its vtkGeoSource to refine the geometry. This refinement is performed on a separate thread, and the data is added to the view
when it becomes available.
To create an instance of class vtkGeoView, simply invoke its constructor as follows
obj = vtkGeoView
33.27.2
Methods
The class vtkGeoView has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkGeoView class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoView = obj.NewInstance ()
vtkGeoView = obj.SafeDownCast (vtkObject o)
vtkGeoAlignedImageRepresentation = obj.AddDefaultImageRepresentation
(vtkImageData image) - Adds an image representation with a simple terrain model using the image in the specified file as the globe terrain.
obj.PrepareForRendering ()
obj.BuildLowResEarth (double origin[3]) - Rebuild low-res earth source;
(re)setting origin.
call after
obj.SetLockHeading (bool lock) - Whether the view locks the heading when panning. Default is
off.
bool = obj.GetLockHeading () - Whether the view locks the heading when panning. Default is off.
obj.LockHeadingOn () - Whether the view locks the heading when panning. Default is off.
obj.LockHeadingOff () - Whether the view locks the heading when panning. Default is off.
vtkGeoInteractorStyle = obj.GetGeoInteractorStyle () - Convenience method for obtaining the internal interactor style.
obj.SetGeoInteractorStyle (vtkGeoInteractorStyle style) - Method to change the
interactor style.
obj.SetTerrain (vtkGeoTerrain terrain) - The terrain (geometry) model for this earth view.
vtkGeoTerrain = obj.GetTerrain () - The terrain (geometry) model for this earth view.
obj.Render () - Update and render the view.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
33.28 vtkGeoView2D
33.28
1075
vtkGeoView2D
33.28.1
Usage
vtkGeoView is a 2D globe view. The globe may contain a multi-resolution geometry source (vtkGeoTerrain2D), multiple multi-resolution image sources (vtkGeoAlignedImageRepresentation), as well as other representations such
as vtkGeoGraphRepresentation2D. At a minimum, the view must have a terrain and one image representation. By
default, you may select in the view with the left mouse button, pan with the middle button, and zoom with the right
mouse button or scroll wheel.
Each terrain or image representation contains a vtkGeoSource subclass which generates geometry or imagery at
multiple resolutions. As the camera position changes, the terrain and/or image representations may ask its vtkGeoSource to refine the geometry. This refinement is performed on a separate thread, and the data is added to the view
when it becomes available.
To create an instance of class vtkGeoView2D, simply invoke its constructor as follows
obj = vtkGeoView2D
33.28.2
Methods
The class vtkGeoView2D has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkGeoView2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoView2D = obj.NewInstance ()
vtkGeoView2D = obj.SafeDownCast (vtkObject o)
vtkGeoView2D = obj.()
vtkGeoView2D = obj.()
vtkGeoTerrain2D = obj.GetSurface ()
obj.SetSurface (vtkGeoTerrain2D surf)
vtkAbstractTransform = obj.GetTransform () - Returns the transform associated with the
surface.
obj.ApplyViewTheme (vtkViewTheme theme) - Apply the view theme to this view.
obj.Render () - Update and render the view.
33.29
vtkGlobeSource
1076
33.29.1
Usage
vtkGlobeSource will generate any "rectangular" patch of the globe given its Longitude-Latitude extent. It adds two
point scalar arrays Longitude and Latitude to the output. These arrays can be transformed to generate texture
coordinates for any texture map. This source is imperfect near the poles as implmented. It should really reduce the
longitude resolution as the triangles become slivers.
To create an instance of class vtkGlobeSource, simply invoke its constructor as follows
obj = vtkGlobeSource
33.29.2
Methods
The class vtkGlobeSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkGlobeSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGlobeSource = obj.NewInstance ()
vtkGlobeSource = obj.SafeDownCast (vtkObject o)
obj.SetOrigin (double , double , double )
obj.SetOrigin (double a[3])
obj.SetStartLongitude (double ) - Longitude Latitude clamps.
double = obj.GetStartLongitudeMinValue () - Longitude Latitude clamps.
double = obj.GetStartLongitudeMaxValue () - Longitude Latitude clamps.
obj.SetEndLongitude (double ) - Longitude Latitude clamps.
double = obj.GetEndLongitudeMinValue () - Longitude Latitude clamps.
double = obj.GetEndLongitudeMaxValue () - Longitude Latitude clamps.
obj.SetStartLatitude (double ) - Longitude Latitude clamps.
double = obj.GetStartLatitudeMinValue () - Longitude Latitude clamps.
double = obj.GetStartLatitudeMaxValue () - Longitude Latitude clamps.
obj.SetEndLatitude (double ) - Longitude Latitude clamps.
double = obj.GetEndLatitudeMinValue () - Longitude Latitude clamps.
double = obj.GetEndLatitudeMaxValue () - Longitude Latitude clamps.
obj.SetLongitudeResolution (int ) - Set the number of points in the longitude direction (ranging from StartLongitude to EndLongitude).
int = obj.GetLongitudeResolutionMinValue () - Set the number of points in the longitude
direction (ranging from StartLongitude to EndLongitude).
int = obj.GetLongitudeResolutionMaxValue () - Set the number of points in the longitude
direction (ranging from StartLongitude to EndLongitude).
int = obj.GetLongitudeResolution () - Set the number of points in the longitude direction
(ranging from StartLongitude to EndLongitude).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
33.29 vtkGlobeSource
1077
obj.SetLatitudeResolution (int ) - Set the number of points in the latitude direction (ranging
from StartLatitude to EndLatitude).
int = obj.GetLatitudeResolutionMinValue () - Set the number of points in the latitude direction (ranging from StartLatitude to EndLatitude).
int = obj.GetLatitudeResolutionMaxValue () - Set the number of points in the latitude direction (ranging from StartLatitude to EndLatitude).
int = obj.GetLatitudeResolution () - Set the number of points in the latitude direction (ranging from StartLatitude to EndLatitude).
obj.SetRadius (double ) - Set radius of sphere. Default is 6356750.0
double = obj.GetRadiusMinValue () - Set radius of sphere. Default is 6356750.0
double = obj.GetRadiusMaxValue () - Set radius of sphere. Default is 6356750.0
double = obj.GetRadius () - Set radius of sphere. Default is 6356750.0
obj.SetCurtainHeight (double )
double = obj.GetCurtainHeightMinValue ()
double = obj.GetCurtainHeightMaxValue ()
double = obj.GetCurtainHeight ()
obj.SetQuadrilateralTessellation (int ) - Cause the sphere to be tessellated with edges
along the latitude and longitude lines. If off, triangles are generated at non-polar regions, which results in
edges that are not parallel to latitude and longitude lines. If on, quadrilaterals are generated everywhere
except at the poles. This can be useful for generating a wireframe sphere with natural latitude and longitude
lines.
int = obj.GetQuadrilateralTessellation () - Cause the sphere to be tessellated with
edges along the latitude and longitude lines. If off, triangles are generated at non-polar regions, which results
in edges that are not parallel to latitude and longitude lines. If on, quadrilaterals are generated everywhere
except at the poles. This can be useful for generating a wireframe sphere with natural latitude and longitude
lines.
obj.QuadrilateralTessellationOn () - Cause the sphere to be tessellated with edges along
the latitude and longitude lines. If off, triangles are generated at non-polar regions, which results in edges
that are not parallel to latitude and longitude lines. If on, quadrilaterals are generated everywhere except at
the poles. This can be useful for generating a wireframe sphere with natural latitude and longitude lines.
obj.QuadrilateralTessellationOff () - Cause the sphere to be tessellated with edges along
the latitude and longitude lines. If off, triangles are generated at non-polar regions, which results in edges
that are not parallel to latitude and longitude lines. If on, quadrilaterals are generated everywhere except at
the poles. This can be useful for generating a wireframe sphere with natural latitude and longitude lines.
1078
Chapter 34
1080
vtkClipHyperOctree
vtkClipPolyData
vtkClipVolume
vtkCoincidentPoints
vtkCompositeDataGeometryFilter
vtkCompositeDataProbeFilter
vtkConeSource
vtkConnectivityFilter
vtkContourFilter
vtkContourGrid
vtkConvertSelection
vtkCubeSource
vtkCursor2D
vtkCursor3D
vtkCurvatures
vtkCutter
vtkCylinderSource
vtkDashedStreamLine
vtkDataObjectGenerator
vtkDataObjectToDataSetFilter
vtkDataSetEdgeSubdivisionCriterion
vtkDataSetGradient
vtkDataSetGradientPrecompute
vtkDataSetSurfaceFilter
vtkDataSetToDataObjectFilter
vtkDataSetTriangleFilter
vtkDecimatePolylineFilter
vtkDecimatePro
vtkDelaunay2D
vtkDelaunay3D
vtkDensifyPolyData
vtkDicer
vtkDijkstraGraphGeodesicPath
vtkDijkstraImageGeodesicPath
vtkDiscreteMarchingCubes
vtkDiskSource
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1081
vtkEdgePoints
vtkEdgeSubdivisionCriterion
vtkElevationFilter
vtkEllipticalButtonSource
vtkExtractArraysOverTime
vtkExtractBlock
vtkExtractCells
vtkExtractDataOverTime
vtkExtractDataSets
vtkExtractEdges
vtkExtractGeometry
vtkExtractGrid
vtkExtractLevel
vtkExtractPolyDataGeometry
vtkExtractRectilinearGrid
vtkExtractSelectedBlock
vtkExtractSelectedFrustum
vtkExtractSelectedIds
vtkExtractSelectedLocations
vtkExtractSelectedPolyDataIds
vtkExtractSelectedRows
vtkExtractSelectedThresholds
vtkExtractSelection
vtkExtractSelectionBase
vtkExtractTemporalFieldData
vtkExtractTensorComponents
vtkExtractUnstructuredGrid
vtkExtractVectorComponents
vtkFeatureEdges
vtkFieldDataToAttributeDataFilter
vtkFillHolesFilter
vtkFrustumSource
vtkGeodesicPath
vtkGeometryFilter
vtkGlyph2D
vtkGlyph3D
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1082
vtkGlyphSource2D
vtkGradientFilter
vtkGraphGeodesicPath
vtkGraphLayoutFilter
vtkGraphToPoints
vtkGraphToPolyData
vtkGridSynchronizedTemplates3D
vtkHedgeHog
vtkHierarchicalDataExtractDataSets
vtkHierarchicalDataExtractLevel
vtkHierarchicalDataLevelFilter
vtkHierarchicalDataSetGeometryFilter
vtkHull
vtkHyperOctreeContourFilter
vtkHyperOctreeCutter
vtkHyperOctreeDepth
vtkHyperOctreeDualGridContourFilter
vtkHyperOctreeFractalSource
vtkHyperOctreeLimiter
vtkHyperOctreeSampleFunction
vtkHyperOctreeSurfaceFilter
vtkHyperOctreeToUniformGridFilter
vtkHyperStreamline
vtkIconGlyphFilter
vtkIdFilter
vtkImageDataGeometryFilter
vtkImageMarchingCubes
vtkImplicitTextureCoords
vtkInterpolateDataSetAttributes
vtkInterpolatingSubdivisionFilter
vtkKdTreeSelector
vtkLevelIdScalars
vtkLinearExtrusionFilter
vtkLinearSubdivisionFilter
vtkLineSource
vtkLinkEdgels
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1083
vtkLoopSubdivisionFilter
vtkMarchingContourFilter
vtkMarchingCubes
vtkMarchingSquares
vtkMaskFields
vtkMaskPoints
vtkMaskPolyData
vtkMassProperties
vtkMergeCells
vtkMergeDataObjectFilter
vtkMergeFields
vtkMergeFilter
vtkMeshQuality
vtkModelMetadata
vtkMultiBlockDataGroupFilter
vtkMultiBlockMergeFilter
vtkMultiThreshold
vtkOBBDicer
vtkOBBTree
vtkOutlineCornerFilter
vtkOutlineCornerSource
vtkOutlineFilter
vtkOutlineSource
vtkParametricFunctionSource
vtkPlaneSource
vtkPlatonicSolidSource
vtkPointDataToCellData
vtkPointSource
vtkPolyDataConnectivityFilter
vtkPolyDataNormals
vtkPolyDataPointSampler
vtkPolyDataStreamer
vtkProbeFilter
vtkProbeSelectedLocations
vtkProgrammableAttributeDataFilter
vtkProgrammableDataObjectSource
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1084
vtkProgrammableFilter
vtkProgrammableGlyphFilter
vtkProgrammableSource
vtkProjectedTexture
vtkQuadraturePointInterpolator
vtkQuadraturePointsGenerator
vtkQuadratureSchemeDictionaryGenerator
vtkQuadricClustering
vtkQuadricDecimation
vtkQuantizePolyDataPoints
vtkRandomAttributeGenerator
vtkRearrangeFields
vtkRectangularButtonSource
vtkRectilinearGridClip
vtkRectilinearGridGeometryFilter
vtkRectilinearGridToTetrahedra
vtkRectilinearSynchronizedTemplates
vtkRecursiveDividingCubes
vtkReflectionFilter
vtkRegularPolygonSource
vtkReverseSense
vtkRibbonFilter
vtkRotationalExtrusionFilter
vtkRotationFilter
vtkRuledSurfaceFilter
vtkSectorSource
vtkSelectEnclosedPoints
vtkSelectPolyData
vtkShrinkFilter
vtkShrinkPolyData
vtkSimpleElevationFilter
vtkSliceCubes
vtkSmoothPolyDataFilter
vtkSpatialRepresentationFilter
vtkSpherePuzzle
vtkSpherePuzzleArrows
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1085
vtkSphereSource
vtkSplineFilter
vtkSplitField
vtkStreamer
vtkStreamingTessellator
vtkStreamLine
vtkStreamPoints
vtkStreamTracer
vtkStripper
vtkStructuredGridClip
vtkStructuredGridGeometryFilter
vtkStructuredGridOutlineFilter
vtkStructuredPointsGeometryFilter
vtkSubdivideTetra
vtkSubPixelPositionEdgels
vtkSuperquadricSource
vtkSynchronizedTemplates2D
vtkSynchronizedTemplates3D
vtkSynchronizedTemplatesCutter3D
vtkTableBasedClipDataSet
vtkTableToPolyData
vtkTableToStructuredGrid
vtkTemporalPathLineFilter
vtkTemporalStatistics
vtkTensorGlyph
vtkTessellatedBoxSource
vtkTessellatorFilter
vtkTextSource
vtkTexturedSphereSource
vtkTextureMapToCylinder
vtkTextureMapToPlane
vtkTextureMapToSphere
vtkThreshold
vtkThresholdPoints
vtkThresholdTextureCoords
vtkTimeSourceExample
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1086
vtkTransformCoordinateSystems
vtkTransformFilter
vtkTransformPolyDataFilter
vtkTransformTextureCoords
vtkTriangleFilter
vtkTriangularTCoords
vtkTubeFilter
vtkUncertaintyTubeFilter
vtkUnstructuredGridGeometryFilter
vtkVectorDot
vtkVectorNorm
vtkVertexGlyphFilter
vtkVoxelContoursToSurfaceFilter
vtkWarpLens
vtkWarpScalar
vtkWarpTo
vtkWarpVector
vtkWindowedSincPolyDataFilter
vtkYoungsMaterialInterface
34.1
vtkAnnotationLink
34.1.1
Usage
vtkAnnotationLink is a simple source filter which outputs the vtkAnnotationLayers object stored internally. Multiple
objects may share the same annotation link filter and connect it to an internal pipeline so that if one object changes
the annotation set, it will be pulled into all the other objects when their pipelines update.
The shared vtkAnnotationLayers object (a collection of annotations) is shallow copied to output port 0.
vtkAnnotationLink can also store a set of domain maps. A domain map is simply a table associating values between
domains. The domain of each column is defined by the array name of the column. The domain maps are sent to a
multi-block dataset in output port 1.
Output ports 0 and 1 can be set as input ports 0 and 1 to vtkConvertSelectionDomain, which can use the domain
maps to convert the domains of selections in the vtkAnnotationLayers to match a particular data object (set as port
2 on vtkConvertSelectionDomain).
The shared vtkAnnotationLayers object also stores a "current selection" normally interpreted as the interactive
selection of an application. As a convenience, this selection is sent to output port 2 so that it can be connected to
pipelines requiring a vtkSelection.
To create an instance of class vtkAnnotationLink, simply invoke its constructor as follows
obj = vtkAnnotationLink
34.2 vtkAppendCompositeDataLeaves
34.1.2
1087
Methods
The class vtkAnnotationLink has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkAnnotationLink class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAnnotationLink = obj.NewInstance ()
vtkAnnotationLink = obj.SafeDownCast (vtkObject o)
vtkAnnotationLayers = obj.GetAnnotationLayers () - The annotations to be shared.
obj.SetAnnotationLayers (vtkAnnotationLayers layers) - The annotations to be
shared.
obj.SetCurrentSelection (vtkSelection sel) - Set or get the current selection in the annotation layers.
vtkSelection = obj.GetCurrentSelection () - Set or get the current selection in the annotation layers.
obj.AddDomainMap (vtkTable map) - The domain mappings.
obj.RemoveDomainMap (vtkTable map) - The domain mappings.
obj.RemoveAllDomainMaps () - The domain mappings.
int = obj.GetNumberOfDomainMaps () - The domain mappings.
vtkTable = obj.GetDomainMap (int i) - The domain mappings.
long = obj.GetMTime () - Get the mtime of this object.
34.2
vtkAppendCompositeDataLeaves
34.2.1
Usage
vtkAppendCompositeDataLeaves is a filter that takes input composite datasets with the same structure: (1) the
same number of entries and if any children are composites the same constraint holds from them; and (2) the
same type of dataset at each position. It then creates an output dataset with the same structure whose leaves
contain all the cells from the datasets at the corresponding leaves of the input datasets.
Currently, only input polydata and unstructured grids are handled; other types of leaf datasets will be ignored and
their positions in the output dataset will be NULL pointers. Point attributes (i.e., scalars, vectors, normals, field data,
etc.) are extracted and appended only if all datasets have the point attributes available. (For example, if one dataset
has scalars but another does not, scalars will not be appended.)
To create an instance of class vtkAppendCompositeDataLeaves, simply invoke its constructor as follows
obj = vtkAppendCompositeDataLeaves
1088
34.2.2
Methods
The class vtkAppendCompositeDataLeaves has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAppendCompositeDataLeaves class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAppendCompositeDataLeaves = obj.NewInstance ()
vtkAppendCompositeDataLeaves = obj.SafeDownCast (vtkObject o)
obj.RemoveInput (vtkDataSet in) - Remove a dataset from the list of data to append.
obj.SetAppendFieldData (int ) - Set/get whether the field data of each dataset in the composite
dataset is copied to the output. If AppendFieldData is non-zero, then field data arrays from all the inputs are
added to the output. If there are duplicates, the array on the first input encountered is taken.
int = obj.GetAppendFieldData () - Set/get whether the field data of each dataset in the composite dataset is copied to the output. If AppendFieldData is non-zero, then field data arrays from all the
inputs are added to the output. If there are duplicates, the array on the first input encountered is taken.
obj.AppendFieldDataOn () - Set/get whether the field data of each dataset in the composite dataset
is copied to the output. If AppendFieldData is non-zero, then field data arrays from all the inputs are added to
the output. If there are duplicates, the array on the first input encountered is taken.
obj.AppendFieldDataOff () - Set/get whether the field data of each dataset in the composite
dataset is copied to the output. If AppendFieldData is non-zero, then field data arrays from all the inputs
are added to the output. If there are duplicates, the array on the first input encountered is taken.
34.3
vtkAppendFilter
34.3.1
Usage
vtkAppendFilter is a filter that appends one of more datasets into a single unstructured grid. All geometry is extracted
and appended, but point attributes (i.e., scalars, vectors, normals, field data, etc.) are extracted and appended only
if all datasets have the point attributes available. (For example, if one dataset has scalars but another does not,
scalars will not be appended.)
To create an instance of class vtkAppendFilter, simply invoke its constructor as follows
obj = vtkAppendFilter
34.3.2
Methods
The class vtkAppendFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkAppendFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAppendFilter = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.4 vtkAppendPolyData
1089
34.4
vtkAppendPolyData
34.4.1
Usage
vtkAppendPolyData is a filter that appends one of more polygonal datasets into a single polygonal dataset. All
geometry is extracted and appended, but point and cell attributes (i.e., scalars, vectors, normals) are extracted and
appended only if all datasets have the point and/or cell attributes available. (For example, if one dataset has point
scalars but another does not, point scalars will not be appended.)
To create an instance of class vtkAppendPolyData, simply invoke its constructor as follows
obj = vtkAppendPolyData
34.4.2
Methods
The class vtkAppendPolyData has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkAppendPolyData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAppendPolyData = obj.NewInstance ()
vtkAppendPolyData = obj.SafeDownCast (vtkObject o)
obj.SetUserManagedInputs (int ) - UserManagedInputs allows the user to set inputs by number instead of using the AddInput/RemoveInput functions. Calls to SetNumberOfInputs/SetInputByNumber
should not be mixed with calls to AddInput/RemoveInput. By default, UserManagedInputs is false.
int = obj.GetUserManagedInputs () - UserManagedInputs allows the user to set inputs by number instead of using the AddInput/RemoveInput functions. Calls to SetNumberOfInputs/SetInputByNumber
should not be mixed with calls to AddInput/RemoveInput. By default, UserManagedInputs is false.
obj.UserManagedInputsOn () - UserManagedInputs allows the user to set inputs by number instead
of using the AddInput/RemoveInput functions. Calls to SetNumberOfInputs/SetInputByNumber should not be
mixed with calls to AddInput/RemoveInput. By default, UserManagedInputs is false.
obj.UserManagedInputsOff () - UserManagedInputs allows the user to set inputs by number instead of using the AddInput/RemoveInput functions. Calls to SetNumberOfInputs/SetInputByNumber should
not be mixed with calls to AddInput/RemoveInput. By default, UserManagedInputs is false.
obj.AddInput (vtkPolyData ) - Add a dataset to the list of data to append. Should not be used
when UserManagedInputs is true, use SetInputByNumber instead.
obj.RemoveInput (vtkPolyData ) - Remove a dataset from the list of data to append. Should not
be used when UserManagedInputs is true, use SetInputByNumber (NULL) instead.
obj.SetNumberOfInputs (int num) - Directly set(allocate) number of inputs, should only be used
when UserManagedInputs is true.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1090
34.5
vtkAppendSelection
34.5.1
Usage
vtkAppendSelection is a filter that appends one of more selections into a single selection. All selections must have
the same content type unless AppendByUnion is false.
To create an instance of class vtkAppendSelection, simply invoke its constructor as follows
obj = vtkAppendSelection
34.5.2
Methods
The class vtkAppendSelection has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkAppendSelection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAppendSelection = obj.NewInstance ()
vtkAppendSelection = obj.SafeDownCast (vtkObject o)
obj.SetUserManagedInputs (int ) - UserManagedInputs allows the user to set inputs by number instead of using the AddInput/RemoveInput functions. Calls to SetNumberOfInputs/SetInputByNumber
should not be mixed with calls to AddInput/RemoveInput. By default, UserManagedInputs is false.
int = obj.GetUserManagedInputs () - UserManagedInputs allows the user to set inputs by number instead of using the AddInput/RemoveInput functions. Calls to SetNumberOfInputs/SetInputByNumber
should not be mixed with calls to AddInput/RemoveInput. By default, UserManagedInputs is false.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.6 vtkApproximatingSubdivisionFilter
1091
34.6
vtkApproximatingSubdivisionFilter
34.6.1
Usage
vtkApproximatingSubdivisionFilter is an abstract class that defines the protocol for Approximating subdivision surface filters.
To create an instance of class vtkApproximatingSubdivisionFilter, simply invoke its constructor as follows
obj = vtkApproximatingSubdivisionFilter
34.6.2
Methods
The class vtkApproximatingSubdivisionFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkApproximatingSubdivisionFilter class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1092
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkApproximatingSubdivisionFilter = obj.NewInstance ()
vtkApproximatingSubdivisionFilter = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfSubdivisions (int ) - Set/get the number of subdivisions.
int = obj.GetNumberOfSubdivisions () - Set/get the number of subdivisions.
34.7
vtkArcSource
34.7.1
Usage
vtkArcSource is a source object that creates an arc defined by two endpoints and a center. The number of segments
composing the polyline is controlled by setting the object resolution.
To create an instance of class vtkArcSource, simply invoke its constructor as follows
obj = vtkArcSource
34.7.2
Methods
The class vtkArcSource has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkArcSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkArcSource = obj.NewInstance ()
vtkArcSource = obj.SafeDownCast (vtkObject o)
obj.SetPoint1 (double , double , double ) - Set position of first end point.
obj.SetPoint1 (double a[3]) - Set position of first end point.
double = obj.
obj.SetCenter (double , double , double ) - Set position of the center of the circle that
define the arc. Note: you can use the function vtkMath::Solve3PointCircle to find the center from 3 points
located on a circle.
obj.SetCenter (double a[3]) - Set position of the center of the circle that define the arc. Note:
you can use the function vtkMath::Solve3PointCircle to find the center from 3 points located on a circle.
double = obj. GetCenter () - Set position of the center of the circle that define the arc. Note:
you can use the function vtkMath::Solve3PointCircle to find the center from 3 points located on a circle.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.8 vtkArrayCalculator
1093
obj.SetResolution (int ) - Divide line into resolution number of pieces. Note: if Resolution is set
to 1 (default), the arc is a straight line.
int = obj.GetResolutionMinValue () - Divide line into resolution number of pieces. Note: if
Resolution is set to 1 (default), the arc is a straight line.
int = obj.GetResolutionMaxValue () - Divide line into resolution number of pieces. Note: if
Resolution is set to 1 (default), the arc is a straight line.
int = obj.GetResolution () - Divide line into resolution number of pieces. Note: if Resolution is
set to 1 (default), the arc is a straight line.
obj.SetNegative (bool ) - Use the angle that is a negative coterminal of the vectors angle: the
longest angle. Note: false by default.
bool = obj.GetNegative () - Use the angle that is a negative coterminal of the vectors angle: the
longest angle. Note: false by default.
obj.NegativeOn () - Use the angle that is a negative coterminal of the vectors angle: the longest angle.
Note: false by default.
obj.NegativeOff () - Use the angle that is a negative coterminal of the vectors angle: the longest
angle. Note: false by default.
34.8
vtkArrayCalculator
34.8.1
Usage
vtkArrayCalculator performs operations on vectors or scalars in field data arrays. It uses vtkFunctionParser to do
the parsing and to evaluate the function for each entry in the input arrays. The arrays used in a given function must
be all in point data or all in cell data. The resulting array will be stored as a field data array. The result array can
either be stored in a new array or it can overwrite an existing array.
The functions that this array calculator understands is:
standard operations: + - * / ^ .
build unit vectors: iHat, jHat, kHat (ie (1,0,0), (0,1,0), (0,0,1))
abs
acos
asin
atan
ceil
cos
cosh
exp
floor
log
mag
min
max
norm
sign
sin
sinh
sqrt
tan
tanh
1094
Note that some of these operations work on scalars, some on vectors, and some on both (e.g., you can multiply a
scalar times a vector). The operations are performed tuple-wise (i.e., tuple-by-tuple). The user must specify which
arrays to use as vectors and/or scalars, and the name of the output data array.
To create an instance of class vtkArrayCalculator, simply invoke its constructor as follows
obj = vtkArrayCalculator
34.8.2
Methods
The class vtkArrayCalculator has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkArrayCalculator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkArrayCalculator = obj.NewInstance ()
vtkArrayCalculator = obj.SafeDownCast (vtkObject o)
obj.SetFunction (string function) - Set/Get the function to be evaluated.
string = obj.GetFunction () - Set/Get the function to be evaluated.
obj.AddScalarArrayName (string arrayName, int component) - Add an array name to
the list of arrays used in the function and specify which components of the array to use in evaluating the
function. The array name must match the name in the function. Use AddScalarVariable or AddVectorVariable
to use a variable name different from the array name.
obj.AddVectorArrayName (string arrayName, int component0, int component1,
int component2) - Add an array name to the list of arrays used in the function and specify which components of the array to use in evaluating the function. The array name must match the name in the function.
Use AddScalarVariable or AddVectorVariable to use a variable name different from the array name.
obj.AddScalarVariable (string variableName, string arrayName, int component)
- Add a variable name, a corresponding array name, and which components of the array to use.
obj.AddVectorVariable (string variableName, string arrayName, int component0,
int component1, int component2) - Add a variable name, a corresponding array name, and
which components of the array to use.
obj.AddCoordinateScalarVariable (string variableName, int component)
Add a variable name, a corresponding array name, and which components of the array to use.
34.8 vtkArrayCalculator
1095
int = obj.GetCoordinateResults () - Set whether to output results as coordinates. ResultArrayName will be ignored. Outputing as coordinates is only valid with vector results and if the AttributeMode
is AttributeModeToUsePointData. If a valid output cant be made, an error will occur.
obj.SetCoordinateResults (int ) - Set whether to output results as coordinates. ResultArrayName will be ignored. Outputing as coordinates is only valid with vector results and if the AttributeMode is
AttributeModeToUsePointData. If a valid output cant be made, an error will occur.
obj.CoordinateResultsOn () - Set whether to output results as coordinates. ResultArrayName will
be ignored. Outputing as coordinates is only valid with vector results and if the AttributeMode is AttributeModeToUsePointData. If a valid output cant be made, an error will occur.
obj.CoordinateResultsOff () - Set whether to output results as coordinates. ResultArrayName
will be ignored. Outputing as coordinates is only valid with vector results and if the AttributeMode is AttributeModeToUsePointData. If a valid output cant be made, an error will occur.
obj.SetAttributeMode (int ) - Control whether the filter operates on point data or cell data. By
default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly set the filter to use
point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). For graphs you can
set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData).
int = obj.GetAttributeMode () - Control whether the filter operates on point data or cell data. By
default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly set the filter to use
point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). For graphs you can
set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData).
obj.SetAttributeModeToDefault () - Control whether the filter operates on point data or cell
data. By default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly set the
filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). For graphs
you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData).
obj.SetAttributeModeToUsePointData () - Control whether the filter operates on point data or
cell data. By default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly set the
filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). For graphs
you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData).
obj.SetAttributeModeToUseCellData () - Control whether the filter operates on point data or
cell data. By default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly set the
filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). For graphs
you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData).
obj.SetAttributeModeToUseVertexData () - Control whether the filter operates on point data
or cell data. By default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly
set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). For
graphs you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData).
obj.SetAttributeModeToUseEdgeData () - Control whether the filter operates on point data or
cell data. By default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly set the
filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). For graphs
you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData).
string = obj.GetAttributeModeAsString () - Control whether the filter operates on point
data or cell data. By default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). For graphs you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data
(AttributeModeToUseEdgeData).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1096
obj.RemoveAllVariables () - Remove all the variable names and their associated array names.
obj.RemoveScalarVariables () - Remove all the scalar variable names and their associated array
names.
obj.RemoveVectorVariables () - Remove all the scalar variable names and their associated array
names.
obj.RemoveCoordinateScalarVariables () - Remove all the coordinate variables.
obj.RemoveCoordinateVectorVariables () - Remove all the coordinate variables.
string = obj.GetScalarArrayName (int i) - Methods to get information about the current
variables.
string = obj.GetVectorArrayName (int i) - Methods to get information about the current
variables.
string = obj.GetScalarVariableName (int i) - Methods to get information about the current variables.
string = obj.GetVectorVariableName (int i) - Methods to get information about the current variables.
int = obj.GetSelectedScalarComponent (int i) - Methods to get information about the
current variables.
int = obj.GetNumberOfScalarArrays () - Methods to get information about the current variables.
int = obj.GetNumberOfVectorArrays () - Methods to get information about the current variables.
obj.SetReplaceInvalidValues (int ) - When ReplaceInvalidValues is on, all invalid values
(such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by
ReplacementValue. Otherwise an error will be reported
int = obj.GetReplaceInvalidValues () - When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by
ReplacementValue. Otherwise an error will be reported
obj.ReplaceInvalidValuesOn () - When ReplaceInvalidValues is on, all invalid values (such as
sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue.
Otherwise an error will be reported
obj.ReplaceInvalidValuesOff () - When ReplaceInvalidValues is on, all invalid values (such as
sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue.
Otherwise an error will be reported
obj.SetReplacementValue (double ) - When ReplaceInvalidValues is on, all invalid values (such
as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported
double = obj.GetReplacementValue () - When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by
ReplacementValue. Otherwise an error will be reported
34.9
vtkArrowSource
34.9 vtkArrowSource
34.9.1
1097
Usage
vtkArrowSource was intended to be used as the source for a glyph. The shaft base is always at (0,0,0). The arrow
tip is always at (1,0,0). If "Invert" is true, then the ends are flipped i.e. tip is at (0,0,0) while base is at (1, 0, 0). The
resolution of the cone and shaft can be set and default to 6. The radius of the cone and shaft can be set and default
to 0.03 and 0.1. The length of the tip can also be set, and defaults to 0.35.
To create an instance of class vtkArrowSource, simply invoke its constructor as follows
obj = vtkArrowSource
34.9.2
Methods
The class vtkArrowSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkArrowSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkArrowSource = obj.NewInstance ()
vtkArrowSource = obj.SafeDownCast (vtkObject o)
obj.SetTipLength (double ) - Set the length, and radius of the tip. They default to 0.35 and 0.1
double = obj.GetTipLengthMinValue () - Set the length, and radius of the tip. They default to
0.35 and 0.1
double = obj.GetTipLengthMaxValue () - Set the length, and radius of the tip. They default to
0.35 and 0.1
double = obj.GetTipLength () - Set the length, and radius of the tip. They default to 0.35 and 0.1
obj.SetTipRadius (double ) - Set the length, and radius of the tip. They default to 0.35 and 0.1
double = obj.GetTipRadiusMinValue () - Set the length, and radius of the tip. They default to
0.35 and 0.1
double = obj.GetTipRadiusMaxValue () - Set the length, and radius of the tip. They default to
0.35 and 0.1
double = obj.GetTipRadius () - Set the length, and radius of the tip. They default to 0.35 and 0.1
obj.SetTipResolution (int ) - Set the resolution of the tip. The tip behaves the same as a cone.
Resoultion 1 gives a single triangle, 2 gives two crossed triangles.
int = obj.GetTipResolutionMinValue () - Set the resolution of the tip. The tip behaves the
same as a cone. Resoultion 1 gives a single triangle, 2 gives two crossed triangles.
int = obj.GetTipResolutionMaxValue () - Set the resolution of the tip. The tip behaves the
same as a cone. Resoultion 1 gives a single triangle, 2 gives two crossed triangles.
int = obj.GetTipResolution () - Set the resolution of the tip. The tip behaves the same as a
cone. Resoultion 1 gives a single triangle, 2 gives two crossed triangles.
obj.SetShaftRadius (double ) - Set the radius of the shaft. Defaults to 0.03.
double = obj.GetShaftRadiusMinValue () - Set the radius of the shaft. Defaults to 0.03.
double = obj.GetShaftRadiusMaxValue () - Set the radius of the shaft. Defaults to 0.03.
double = obj.GetShaftRadius () - Set the radius of the shaft. Defaults to 0.03.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1098
obj.SetShaftResolution (int ) - Set the resolution of the shaft. 2 gives a rectangle. I would like
to extend the cone to produce a line, but this is not an option now.
int = obj.GetShaftResolutionMinValue () - Set the resolution of the shaft. 2 gives a rectangle. I would like to extend the cone to produce a line, but this is not an option now.
int = obj.GetShaftResolutionMaxValue () - Set the resolution of the shaft. 2 gives a rectangle. I would like to extend the cone to produce a line, but this is not an option now.
int = obj.GetShaftResolution () - Set the resolution of the shaft. 2 gives a rectangle. I would
like to extend the cone to produce a line, but this is not an option now.
obj.InvertOn () - Inverts the arrow direction. When set to true, base is at (1, 0, 0) while the tip is at (0,
0, 0). The default is false, i.e. base at (0, 0, 0) and the tip at (1, 0, 0).
obj.InvertOff () - Inverts the arrow direction. When set to true, base is at (1, 0, 0) while the tip is at
(0, 0, 0). The default is false, i.e. base at (0, 0, 0) and the tip at (1, 0, 0).
obj.SetInvert (bool ) - Inverts the arrow direction. When set to true, base is at (1, 0, 0) while the
tip is at (0, 0, 0). The default is false, i.e. base at (0, 0, 0) and the tip at (1, 0, 0).
bool = obj.GetInvert () - Inverts the arrow direction. When set to true, base is at (1, 0, 0) while
the tip is at (0, 0, 0). The default is false, i.e. base at (0, 0, 0) and the tip at (1, 0, 0).
34.10
vtkAssignAttribute
34.10.1
Usage
vtkAssignAttribute is use to label a field (vtkDataArray) as an attribute. A field name or an attribute to labeled can
be specified. For example:
aa->Assign("foo", vtkDataSetAttributes::SCALARS,
vtkAssignAttribute::POINT_DATA);
tells vtkAssignAttribute to make the array in the point data called "foo" the active scalars. On the other hand,
aa->Assign(vtkDataSetAttributes::VECTORS, vtkDataSetAttributes::SCALARS,
vtkAssignAttribute::POINT_DATA);
tells vtkAssignAttribute to make the active vectors also the active scalars. The same can be done more easily from
Tcl by using the Assign() method which takes strings:
aa Assign "foo" SCALARS POINT_DATA
or
aa Assign SCALARS VECTORS POINT_DATA
AttributeTypes: SCALARS, VECTORS, NORMALS, TCOORDS, TENSORS
Attribute locations: POINT_DATA, CELL_DATA
34.10.2
Methods
The class vtkAssignAttribute has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkAssignAttribute class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.11 vtkAttributeDataToFieldDataFilter
1099
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAssignAttribute = obj.NewInstance ()
vtkAssignAttribute = obj.SafeDownCast (vtkObject o)
obj.Assign (int inputAttributeType, int attributeType, int attributeLoc) - Label an attribute as another attribute.
obj.Assign (string fieldName, int attributeType, int attributeLoc) - Label
an array as an attribute.
obj.Assign (string name, string attributeType, string attributeLoc)
Helper method used by other language bindings. Allows the caller to specify arguments as strings instead of enums.
34.11
vtkAttributeDataToFieldDataFilter
34.11.1
Usage
vtkAttributeDataToFieldDataFilter is a class that maps attribute data into field data. Since this filter is a subclass of
vtkDataSetAlgorithm, the output dataset (whose structure is the same as the input dataset), will contain the field
data that is generated. The filter will convert point and cell attribute data to field data and assign it as point and cell
field data, replacing any point or field data that was there previously. By default, the original non-field point and cell
attribute data will be passed to the output of the filter, although you can shut this behavior down.
To create an instance of class vtkAttributeDataToFieldDataFilter, simply invoke its constructor as follows
obj = vtkAttributeDataToFieldDataFilter
34.11.2
Methods
The class vtkAttributeDataToFieldDataFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAttributeDataToFieldDataFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAttributeDataToFieldDataFilter = obj.NewInstance ()
vtkAttributeDataToFieldDataFilter = obj.SafeDownCast (vtkObject o)
obj.SetPassAttributeData (int ) - Turn on/off the passing of point and cell non-field attribute
data to the output of the filter.
int = obj.GetPassAttributeData () - Turn on/off the passing of point and cell non-field attribute
data to the output of the filter.
obj.PassAttributeDataOn () - Turn on/off the passing of point and cell non-field attribute data to
the output of the filter.
obj.PassAttributeDataOff () - Turn on/off the passing of point and cell non-field attribute data to
the output of the filter.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1100
34.12
vtkAxes
34.12.1
Usage
vtkAxes creates three lines that form an x-y-z axes. The origin of the axes is user specified (0,0,0 is default), and
the size is specified with a scale factor. Three scalar values are generated for the three lines and can be used (via
color map) to indicate a particular coordinate axis.
To create an instance of class vtkAxes, simply invoke its constructor as follows
obj = vtkAxes
34.12.2
Methods
The class vtkAxes has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkAxes class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAxes = obj.NewInstance ()
vtkAxes = obj.SafeDownCast (vtkObject o)
obj.SetOrigin (double , double , double ) - Set the origin of the axes.
obj.SetOrigin (double a[3]) - Set the origin of the axes.
double = obj.
obj.SetScaleFactor (double ) - Set the scale factor of the axes. Used to control size.
double = obj.GetScaleFactor () - Set the scale factor of the axes. Used to control size.
obj.SetSymmetric (int ) - If Symetric is on, the the axis continue to negative values.
int = obj.GetSymmetric () - If Symetric is on, the the axis continue to negative values.
obj.SymmetricOn () - If Symetric is on, the the axis continue to negative values.
obj.SymmetricOff () - If Symetric is on, the the axis continue to negative values.
obj.SetComputeNormals (int ) - Option for computing normals. By default they are computed.
int = obj.GetComputeNormals () - Option for computing normals. By default they are computed.
obj.ComputeNormalsOn () - Option for computing normals. By default they are computed.
obj.ComputeNormalsOff () - Option for computing normals. By default they are computed.
34.13
vtkBandedPolyDataContourFilter
34.13 vtkBandedPolyDataContourFilter
34.13.1
1101
Usage
vtkBandedPolyDataContourFilter is a filter that takes as input vtkPolyData and produces as output filled contours
(also represented as vtkPolyData). Filled contours are bands of cells that all have the same cell scalar value, and
can therefore be colored the same. The method is also referred to as filled contour generation.
To use this filter you must specify one or more contour values. You can either use the method SetValue() to specify
each contour value, or use GenerateValues() to generate a series of evenly spaced contours. Each contour value
divides (or clips) the data into two pieces, values below the contour value, and values above it. The scalar values
of each band correspond to the specified contour value. Note that if the first and last contour values are not the
minimum/maximum contour range, then two extra contour values are added corresponding to the minimum and
maximum range values. These extra contour bands can be prevented from being output by turning clipping on.
To create an instance of class vtkBandedPolyDataContourFilter, simply invoke its constructor as follows
obj = vtkBandedPolyDataContourFilter
34.13.2
Methods
The class vtkBandedPolyDataContourFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkBandedPolyDataContourFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBandedPolyDataContourFilter = obj.NewInstance ()
vtkBandedPolyDataContourFilter = obj.SafeDownCast (vtkObject o)
obj.SetValue (int i, double value) - Methods to set / get contour values. A single value at
a time can be set with SetValue(). Multiple contour values can be set with GenerateValues(). Note that
GenerateValues() generates n values inclusive of the start and end range values.
double = obj.GetValue (int i) - Methods to set / get contour values. A single value at a time can
be set with SetValue(). Multiple contour values can be set with GenerateValues(). Note that GenerateValues()
generates n values inclusive of the start and end range values.
obj.GetValues (double contourValues) - Methods to set / get contour values. A single value
at a time can be set with SetValue(). Multiple contour values can be set with GenerateValues(). Note that
GenerateValues() generates n values inclusive of the start and end range values.
obj.SetNumberOfContours (int number) - Methods to set / get contour values. A single value
at a time can be set with SetValue(). Multiple contour values can be set with GenerateValues(). Note that
GenerateValues() generates n values inclusive of the start and end range values.
int = obj.GetNumberOfContours () - Methods to set / get contour values. A single value at
a time can be set with SetValue(). Multiple contour values can be set with GenerateValues(). Note that
GenerateValues() generates n values inclusive of the start and end range values.
obj.GenerateValues (int numContours, double range[2]) - Methods to set / get contour values. A single value at a time can be set with SetValue(). Multiple contour values can be set with
GenerateValues(). Note that GenerateValues() generates n values inclusive of the start and end range values.
obj.GenerateValues (int numContours, double rangeStart, double rangeEnd) - Methods to set / get contour values. A single value at a time can be set with SetValue(). Multiple
contour values can be set with GenerateValues(). Note that GenerateValues() generates n values inclusive
of the start and end range values.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1102
obj.SetClipping (int ) - Indicate whether to clip outside the range specified by the user. (The
range is contour value[0] to contour value[numContours-1].) Clipping means all cells outside of the range
specified are not sent to the output.
int = obj.GetClipping () - Indicate whether to clip outside the range specified by the user. (The
range is contour value[0] to contour value[numContours-1].) Clipping means all cells outside of the range
specified are not sent to the output.
obj.ClippingOn () - Indicate whether to clip outside the range specified by the user. (The range is
contour value[0] to contour value[numContours-1].) Clipping means all cells outside of the range specified
are not sent to the output.
obj.ClippingOff () - Indicate whether to clip outside the range specified by the user. (The range is
contour value[0] to contour value[numContours-1].) Clipping means all cells outside of the range specified
are not sent to the output.
obj.SetScalarMode (int ) - Control whether the cell scalars are output as an integer index or a
scalar value. If an index, the index refers to the bands produced by the clipping range. If a value, then a
scalar value which is a value between clip values is used.
int = obj.GetScalarModeMinValue () - Control whether the cell scalars are output as an integer
index or a scalar value. If an index, the index refers to the bands produced by the clipping range. If a value,
then a scalar value which is a value between clip values is used.
int = obj.GetScalarModeMaxValue () - Control whether the cell scalars are output as an integer
index or a scalar value. If an index, the index refers to the bands produced by the clipping range. If a value,
then a scalar value which is a value between clip values is used.
int = obj.GetScalarMode () - Control whether the cell scalars are output as an integer index or
a scalar value. If an index, the index refers to the bands produced by the clipping range. If a value, then a
scalar value which is a value between clip values is used.
obj.SetScalarModeToIndex () - Control whether the cell scalars are output as an integer index or
a scalar value. If an index, the index refers to the bands produced by the clipping range. If a value, then a
scalar value which is a value between clip values is used.
obj.SetScalarModeToValue () - Turn on/off a flag to control whether contour edges are generated.
Contour edges are the edges between bands. If enabled, they are generated from polygons/triangle strips
and placed into the second output (the ContourEdgesOutput).
obj.SetGenerateContourEdges (int ) - Turn on/off a flag to control whether contour edges are
generated. Contour edges are the edges between bands. If enabled, they are generated from polygons/triangle strips and placed into the second output (the ContourEdgesOutput).
int = obj.GetGenerateContourEdges () - Turn on/off a flag to control whether contour edges
are generated. Contour edges are the edges between bands. If enabled, they are generated from polygons/triangle strips and placed into the second output (the ContourEdgesOutput).
obj.GenerateContourEdgesOn () - Turn on/off a flag to control whether contour edges are generated. Contour edges are the edges between bands. If enabled, they are generated from polygons/triangle
strips and placed into the second output (the ContourEdgesOutput).
obj.GenerateContourEdgesOff () - Turn on/off a flag to control whether contour edges are generated. Contour edges are the edges between bands. If enabled, they are generated from polygons/triangle
strips and placed into the second output (the ContourEdgesOutput).
vtkPolyData = obj.GetContourEdgesOutput () - Get the second output which contains the
edges dividing the contour bands. This output is empty unless GenerateContourEdges is enabled.
long = obj.GetMTime () - Overload GetMTime because we delegate to vtkContourValues so its
modified time must be taken into account.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.14 vtkBlankStructuredGrid
34.14
1103
vtkBlankStructuredGrid
34.14.1
Usage
vtkBlankStructuredGrid is a filter that sets the blanking field in a vtkStructuredGrid dataset. The blanking field is set
by examining a specified point attribute data array (e.g., scalars) and converting values in the data array to either a
"1" (visible) or "0" (blanked) value in the blanking array. The values to be blanked are specified by giving a min/max
range. All data values in the data array indicated and laying within the range specified (inclusive on both ends) are
translated to a "off" blanking value.
To create an instance of class vtkBlankStructuredGrid, simply invoke its constructor as follows
obj = vtkBlankStructuredGrid
34.14.2
Methods
The class vtkBlankStructuredGrid has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkBlankStructuredGrid
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBlankStructuredGrid = obj.NewInstance ()
vtkBlankStructuredGrid = obj.SafeDownCast (vtkObject o)
obj.SetMinBlankingValue (double ) - Specify the lower data value in the data array specified
which will be converted into a "blank" (or off) value in the blanking array.
double = obj.GetMinBlankingValue () - Specify the lower data value in the data array specified
which will be converted into a "blank" (or off) value in the blanking array.
obj.SetMaxBlankingValue (double ) - Specify the upper data value in the data array specified
which will be converted into a "blank" (or off) value in the blanking array.
double = obj.GetMaxBlankingValue () - Specify the upper data value in the data array specified which will be converted into a "blank" (or off) value in the blanking array.
obj.SetArrayName (string ) - Specify the data array name to use to generate the blanking field.
Alternatively, you can specify the array id. (If both are set, the array name takes precedence.)
string = obj.GetArrayName () - Specify the data array name to use to generate the blanking field.
Alternatively, you can specify the array id. (If both are set, the array name takes precedence.)
obj.SetArrayId (int ) - Specify the data array id to use to generate the blanking field. Alternatively,
you can specify the array name. (If both are set, the array name takes precedence.)
int = obj.GetArrayId () - Specify the data array id to use to generate the blanking field. Alternatively, you can specify the array name. (If both are set, the array name takes precedence.)
obj.SetComponent (int ) - Specify the component in the data array to use to generate the blanking
field.
int = obj.GetComponentMinValue () - Specify the component in the data array to use to generate the blanking field.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1104
int = obj.GetComponentMaxValue () - Specify the component in the data array to use to generate the blanking field.
int = obj.GetComponent () - Specify the component in the data array to use to generate the blanking field.
34.15
vtkBlankStructuredGridWithImage
34.15.1
Usage
This filter can be used to set the blanking in a structured grid with an image. The filter takes two inputs: the
structured grid to blank, and the image used to set the blanking. Make sure that the dimensions of both the image
and the structured grid are identical.
Note that the image is interpreted as follows: zero values indicate that the structured grid point is blanked; non-zero
values indicate that the structured grid point is visible. The blanking data must be unsigned char.
To create an instance of class vtkBlankStructuredGridWithImage, simply invoke its constructor as follows
obj = vtkBlankStructuredGridWithImage
34.15.2
Methods
The class vtkBlankStructuredGridWithImage has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkBlankStructuredGridWithImage class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBlankStructuredGridWithImage = obj.NewInstance ()
vtkBlankStructuredGridWithImage = obj.SafeDownCast (vtkObject o)
obj.SetBlankingInput (vtkImageData input) - Set / get the input image used to perform the
blanking.
vtkImageData = obj.GetBlankingInput () - Set / get the input image used to perform the
blanking.
34.16
vtkBlockIdScalars
34.16.1
Usage
vtkBlockIdScalars is a filter that generates scalars using the block index for each block. Note that all sub-blocks
within a block get the same scalar. The new scalars array is named BlockIdScalars.
To create an instance of class vtkBlockIdScalars, simply invoke its constructor as follows
obj = vtkBlockIdScalars
34.17 vtkBoxClipDataSet
34.16.2
1105
Methods
The class vtkBlockIdScalars has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkBlockIdScalars class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBlockIdScalars = obj.NewInstance ()
vtkBlockIdScalars = obj.SafeDownCast (vtkObject o)
34.17
vtkBoxClipDataSet
34.17.1
Usage
Clipping means that is actually cuts through the cells of the dataset, returning tetrahedral cells inside of the box.
The output of this filter is an unstructured grid.
This filter can be configured to compute a second output. The second output is the part of the cell that is clipped
away. Set the GenerateClippedData boolean on if you wish to access this output data.
The vtkBoxClipDataSet will triangulate all types of 3D cells (i.e, create tetrahedra). This is necessary to preserve
compatibility across face neighbors.
To use this filter,you can decide if you will be clipping with a box or a hexahedral box. 1) Set orientation if(SetOrientation(0)): box (parallel with coordinate axis) SetBoxClip(xmin,xmax,ymin,ymax,zmin,zmax) if(SetOrientation(1)): hexahedral box (Default) SetBoxClip(n[0],o[0],n[1],o[1],n[2],o[2],n[3],o[3],n[4],o[4],n[5],o[5]) PlaneNormal[] normal of each plane PlanePoint[] point on the plane 2) Apply the GenerateClipScalarsOn() 3) Execute
clipping Update();
To create an instance of class vtkBoxClipDataSet, simply invoke its constructor as follows
obj = vtkBoxClipDataSet
34.17.2
Methods
The class vtkBoxClipDataSet has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkBoxClipDataSet class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBoxClipDataSet = obj.NewInstance ()
vtkBoxClipDataSet = obj.SafeDownCast (vtkObject o)
obj.SetBoxClip (double xmin, double xmax, double ymin, double ymax,
double o2, double n3, double o3, double n4, double o4, double n5, double
o5)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1106
obj.SetGenerateClipScalars (int ) - If this flag is enabled, then the output scalar values will
be interpolated, and not the input scalar data.
int = obj.GetGenerateClipScalars () - If this flag is enabled, then the output scalar values will
be interpolated, and not the input scalar data.
obj.GenerateClipScalarsOn () - If this flag is enabled, then the output scalar values will be interpolated, and not the input scalar data.
obj.GenerateClipScalarsOff () - If this flag is enabled, then the output scalar values will be
interpolated, and not the input scalar data.
obj.SetGenerateClippedOutput (int ) - Control whether a second output is generated. The
second output contains the polygonal data thats been clipped away.
int = obj.GetGenerateClippedOutput () - Control whether a second output is generated. The
second output contains the polygonal data thats been clipped away.
obj.GenerateClippedOutputOn () - Control whether a second output is generated. The second
output contains the polygonal data thats been clipped away.
obj.GenerateClippedOutputOff () - Control whether a second output is generated. The second
output contains the polygonal data thats been clipped away.
vtkUnstructuredGrid = obj.GetClippedOutput () - Return the Clipped output.
int = obj.GetNumberOfOutputs () - Return the Clipped output.
obj.SetLocator (vtkIncrementalPointLocator locator) - Specify a spatial locator for
merging points. By default, an instance of vtkMergePoints is used.
vtkIncrementalPointLocator = obj.GetLocator () - Specify a spatial locator for merging
points. By default, an instance of vtkMergePoints is used.
obj.CreateDefaultLocator () - Create default locator. Used to create one when none is specified.
The locator is used to merge coincident points.
long = obj.GetMTime () - Return the mtime also considering the locator.
int = obj.GetOrientation () - Tells if clipping happens with a box parallel with coordinate axis (0)
or with an hexahedral box (1). Initial value is 1.
obj.SetOrientation (int ) - Tells if clipping happens with a box parallel with coordinate axis (0) or
with an hexahedral box (1). Initial value is 1.
obj.ClipBox (vtkPoints newPoints, vtkGenericCell cell, vtkIncremental-
PointLocator locator, vtkCellArray tets, vtkPointData inPD, vtkPointData outPD, vtkCellData inCD, vtkIdType cellId, vtkCellData outCD)
obj.ClipHexahedron (vtkPoints newPoints, vtkGenericCell cell, vtkIncremental-
PointLocator locator, vtkCellArray tets, vtkPointData inPD, vtkPointData outPD, vtkCellData inCD, vtkIdType cellId, vtkCellData outCD)
obj.ClipBox2D (vtkPoints newPoints, vtkGenericCell cell, vtkIncremental-
PointLocator locator, vtkCellArray tets, vtkPointData inPD, vtkPointData outPD, vtkCellData inCD, vtkIdType cellId, vtkCellData outCD)
obj.ClipHexahedron2D (vtkPoints newPoints, vtkGenericCell cell, vtk-
IncrementalPointLocator locator, vtkCellArray tets, vtkPointData inPD, vtkPointData outPD, vtkCellData inCD, vtkIdType cellId, vtkCellData
outCD)
obj.ClipBox1D (vtkPoints newPoints, vtkGenericCell cell, vtkIncremental-
PointLocator locator, vtkCellArray lines, vtkPointData inPD, vtkPointData outPD, vtkCellData inCD, vtkIdType cellId, vtkCellData outCD)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.18 vtkBrownianPoints
1107
IncrementalPointLocator locator, vtkCellArray lines, vtkPointData inPD, vtkPointData outPD, vtkCellData inCD, vtkIdType cellId, vtkCellData
outCD)
obj.ClipBox0D (vtkGenericCell cell, vtkIncrementalPointLocator locator,
34.18
vtkBrownianPoints
34.18.1
Usage
vtkBrownianPoints is a filter object that assigns a random vector (i.e., magnitude and direction) to each point. The
minimum and maximum speed values can be controlled by the user.
To create an instance of class vtkBrownianPoints, simply invoke its constructor as follows
obj = vtkBrownianPoints
34.18.2
Methods
The class vtkBrownianPoints has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkBrownianPoints class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBrownianPoints = obj.NewInstance ()
vtkBrownianPoints = obj.SafeDownCast (vtkObject o)
obj.SetMinimumSpeed (double ) - Set the minimum speed value.
double = obj.GetMinimumSpeedMinValue () - Set the minimum speed value.
double = obj.GetMinimumSpeedMaxValue () - Set the minimum speed value.
double = obj.GetMinimumSpeed () - Set the minimum speed value.
obj.SetMaximumSpeed (double ) - Set the maximum speed value.
double = obj.GetMaximumSpeedMinValue () - Set the maximum speed value.
double = obj.GetMaximumSpeedMaxValue () - Set the maximum speed value.
double = obj.GetMaximumSpeed () - Set the maximum speed value.
34.19
vtkButterflySubdivisionFilter
1108
34.19.1
Usage
vtkButterflySubdivisionFilter is an interpolating subdivision scheme that creates four new triangles for each triangle
in the mesh. The user can specify the NumberOfSubdivisions. This filter implements the 8-point butterfly scheme
described in: Zorin, D., Schroder, P., and Sweldens, W., "Interpolating Subdivisions for Meshes with Arbitrary
Topology," Computer Graphics Proceedings, Annual Conference Series, 1996, ACM SIGGRAPH, pp.189-192. This
scheme improves previous butterfly subdivisions with special treatment of vertices with valence other than 6.
Currently, the filter only operates on triangles. Users should use the vtkTriangleFilter to triangulate meshes that
contain polygons or triangle strips.
The filter interpolates point data using the same scheme. New triangles created at a subdivision step will have the
cell data of their parent cell.
To create an instance of class vtkButterflySubdivisionFilter, simply invoke its constructor as follows
obj = vtkButterflySubdivisionFilter
34.19.2
Methods
The class vtkButterflySubdivisionFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkButterflySubdivisionFilter
class.
string = obj.GetClassName () - Construct object with NumberOfSubdivisions set to 1.
int = obj.IsA (string name) - Construct object with NumberOfSubdivisions set to 1.
vtkButterflySubdivisionFilter = obj.NewInstance () - Construct object with NumberOfSubdivisions set to 1.
vtkButterflySubdivisionFilter = obj.SafeDownCast (vtkObject o) - Construct
object with NumberOfSubdivisions set to 1.
34.20
vtkButtonSource
34.20.1
Usage
vtkButtonSource is an abstract class that defines an API for creating "button-like" objects in VTK. A button is a
geometry with a rectangular region that can be textured. The button is divided into two regions: the texture region
and the shoulder region. The points in both regions are assigned texture coordinates. The texture region has texture
coordinates consistent with the image to be placed on it. All points in the shoulder regions are assigned a texture
coordinate specified by the user. In this way the shoulder region can be colored by the texture.
Creating a vtkButtonSource requires specifying its center point. (Subclasses have other attributes that must be set
to control the shape of the button.) You must also specify how to control the shape of the texture region; i.e., wheter
to size the texture region proportional to the texture dimensions or whether to size the texture region proportional to
the button. Also, buttons can be created single sided are mirrored to create two-sided buttons.
To create an instance of class vtkButtonSource, simply invoke its constructor as follows
obj = vtkButtonSource
34.20 vtkButtonSource
34.20.2
1109
Methods
The class vtkButtonSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkButtonSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkButtonSource = obj.NewInstance ()
vtkButtonSource = obj.SafeDownCast (vtkObject o)
obj.SetCenter (double , double , double ) - Specify a point defining the origin (center) of
the button.
obj.SetCenter (double a[3]) - Specify a point defining the origin (center) of the button.
double = obj.
obj.SetTextureStyle (int ) - Set/Get the style of the texture region: whether to size it according
to the x-y dimensions of the texture, or whether to make the texture region proportional to the width/height of
the button.
int = obj.GetTextureStyleMinValue () - Set/Get the style of the texture region: whether to
size it according to the x-y dimensions of the texture, or whether to make the texture region proportional to
the width/height of the button.
int = obj.GetTextureStyleMaxValue () - Set/Get the style of the texture region: whether to
size it according to the x-y dimensions of the texture, or whether to make the texture region proportional to
the width/height of the button.
int = obj.GetTextureStyle () - Set/Get the style of the texture region: whether to size it according to the x-y dimensions of the texture, or whether to make the texture region proportional to the width/height
of the button.
obj.SetTextureStyleToFitImage () - Set/Get the style of the texture region: whether to size it
according to the x-y dimensions of the texture, or whether to make the texture region proportional to the
width/height of the button.
obj.SetTextureStyleToProportional () - Set/get the texture dimension. This needs to be set
if the texture style is set to fit the image.
obj.SetTextureDimensions (int , int ) - Set/get the texture dimension. This needs to be set
if the texture style is set to fit the image.
obj.SetTextureDimensions (int a[2]) - Set/get the texture dimension. This needs to be set if
the texture style is set to fit the image.
int = obj. GetTextureDimensions () - Set/get the texture dimension. This needs to be set if
the texture style is set to fit the image.
obj.SetShoulderTextureCoordinate (double , double ) - Set/Get the default texture coordinate to set the shoulder region to.
obj.SetShoulderTextureCoordinate (double a[2]) - Set/Get the default texture coordinate
to set the shoulder region to.
double = obj. GetShoulderTextureCoordinate () - Set/Get the default texture coordinate
to set the shoulder region to.
obj.SetTwoSided (int ) - Indicate whether the button is single or double sided. A double sided
button can be viewed from two sides...it looks sort of like a "pill." A single-sided button is meant to viewed
from a single side; it looks like a "clam-shell."
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1110
int = obj.GetTwoSided () - Indicate whether the button is single or double sided. A double sided
button can be viewed from two sides...it looks sort of like a "pill." A single-sided button is meant to viewed
from a single side; it looks like a "clam-shell."
obj.TwoSidedOn () - Indicate whether the button is single or double sided. A double sided button can
be viewed from two sides...it looks sort of like a "pill." A single-sided button is meant to viewed from a single
side; it looks like a "clam-shell."
obj.TwoSidedOff () - Indicate whether the button is single or double sided. A double sided button can
be viewed from two sides...it looks sort of like a "pill." A single-sided button is meant to viewed from a single
side; it looks like a "clam-shell."
34.21
vtkCellCenters
34.21.1
Usage
vtkCellCenters is a filter that takes as input any dataset and generates on output points at the center of the cells in
the dataset. These points can be used for placing glyphs (vtkGlyph3D) or labeling (vtkLabeledDataMapper). (The
center is the parametric center of the cell, not necessarily the geometric or bounding box center.) The cell attributes
will be associated with the points on output.
To create an instance of class vtkCellCenters, simply invoke its constructor as follows
obj = vtkCellCenters
34.21.2
Methods
The class vtkCellCenters has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCellCenters class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCellCenters = obj.NewInstance ()
vtkCellCenters = obj.SafeDownCast (vtkObject o)
obj.SetVertexCells (int ) - Enable/disable the generation of vertex cells. The default is Off.
int = obj.GetVertexCells () - Enable/disable the generation of vertex cells. The default is Off.
obj.VertexCellsOn () - Enable/disable the generation of vertex cells. The default is Off.
obj.VertexCellsOff () - Enable/disable the generation of vertex cells. The default is Off.
34.22
vtkCellDataToPointData
34.23 vtkCellDerivatives
34.22.1
1111
Usage
vtkCellDataToPointData is a filter that transforms cell data (i.e., data specified per cell) into point data (i.e., data
specified at cell points). The method of transformation is based on averaging the data values of all cells using a
particular point. Optionally, the input cell data can be passed through to the output as well.
To create an instance of class vtkCellDataToPointData, simply invoke its constructor as follows
obj = vtkCellDataToPointData
34.22.2
Methods
The class vtkCellDataToPointData has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCellDataToPointData
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCellDataToPointData = obj.NewInstance ()
vtkCellDataToPointData = obj.SafeDownCast (vtkObject o)
obj.SetPassCellData (int ) - Control whether the input cell data is to be passed to the output. If
on, then the input cell data is passed through to the output; otherwise, only generated point data is placed
into the output.
int = obj.GetPassCellData () - Control whether the input cell data is to be passed to the output.
If on, then the input cell data is passed through to the output; otherwise, only generated point data is placed
into the output.
obj.PassCellDataOn () - Control whether the input cell data is to be passed to the output. If on, then
the input cell data is passed through to the output; otherwise, only generated point data is placed into the
output.
obj.PassCellDataOff () - Control whether the input cell data is to be passed to the output. If on,
then the input cell data is passed through to the output; otherwise, only generated point data is placed into
the output.
34.23
vtkCellDerivatives
34.23.1
Usage
vtkCellDerivatives is a filter that computes derivatives of scalars and vectors at the center of cells. You can choose
to generate different output including the scalar gradient (a vector), computed tensor vorticity (a vector), gradient of
input vectors (a tensor), and strain matrix of the input vectors (a tensor); or you may choose to pass data through to
the output.
Note that it is assumed that on input scalars and vector point data is available, which are then used to generate cell
vectors and tensors. (The interpolation functions of the cells are used to compute the derivatives which is why point
data is required.)
To create an instance of class vtkCellDerivatives, simply invoke its constructor as follows
obj = vtkCellDerivatives
1112
34.23.2
Methods
The class vtkCellDerivatives has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkCellDerivatives class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCellDerivatives = obj.NewInstance ()
vtkCellDerivatives = obj.SafeDownCast (vtkObject o)
obj.SetVectorMode (int ) - Control how the filter works to generate vector cell data. You can
choose to pass the input cell vectors, compute the gradient of the input scalars, or extract the vorticity of the
computed vector gradient tensor. By default (VectorModeToComputeGradient), the filter will take the gradient
of the input scalar data.
int = obj.GetVectorMode () - Control how the filter works to generate vector cell data. You can
choose to pass the input cell vectors, compute the gradient of the input scalars, or extract the vorticity of the
computed vector gradient tensor. By default (VectorModeToComputeGradient), the filter will take the gradient
of the input scalar data.
obj.SetVectorModeToPassVectors () - Control how the filter works to generate vector cell data.
You can choose to pass the input cell vectors, compute the gradient of the input scalars, or extract the vorticity
of the computed vector gradient tensor. By default (VectorModeToComputeGradient), the filter will take the
gradient of the input scalar data.
obj.SetVectorModeToComputeGradient () - Control how the filter works to generate vector cell
data. You can choose to pass the input cell vectors, compute the gradient of the input scalars, or extract the
vorticity of the computed vector gradient tensor. By default (VectorModeToComputeGradient), the filter will
take the gradient of the input scalar data.
obj.SetVectorModeToComputeVorticity () - Control how the filter works to generate vector
cell data. You can choose to pass the input cell vectors, compute the gradient of the input scalars, or extract
the vorticity of the computed vector gradient tensor. By default (VectorModeToComputeGradient), the filter
will take the gradient of the input scalar data.
string = obj.GetVectorModeAsString () - Control how the filter works to generate vector cell
data. You can choose to pass the input cell vectors, compute the gradient of the input scalars, or extract the
vorticity of the computed vector gradient tensor. By default (VectorModeToComputeGradient), the filter will
take the gradient of the input scalar data.
obj.SetTensorMode (int ) - Control how the filter works to generate tensor cell data. You can
choose to pass the input cell tensors, compute the gradient of the input vectors, or compute the strain tensor
of the vector gradient tensor. By default (TensorModeToComputeGradient), the filter will take the gradient of
the vector data to construct a tensor.
int = obj.GetTensorMode () - Control how the filter works to generate tensor cell data. You can
choose to pass the input cell tensors, compute the gradient of the input vectors, or compute the strain tensor
of the vector gradient tensor. By default (TensorModeToComputeGradient), the filter will take the gradient of
the vector data to construct a tensor.
obj.SetTensorModeToPassTensors () - Control how the filter works to generate tensor cell data.
You can choose to pass the input cell tensors, compute the gradient of the input vectors, or compute the
strain tensor of the vector gradient tensor. By default (TensorModeToComputeGradient), the filter will take the
gradient of the vector data to construct a tensor.
obj.SetTensorModeToComputeGradient () - Control how the filter works to generate tensor cell
data. You can choose to pass the input cell tensors, compute the gradient of the input vectors, or compute
the strain tensor of the vector gradient tensor. By default (TensorModeToComputeGradient), the filter will take
the gradient of the vector data to construct a tensor.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.24 vtkCleanPolyData
1113
34.24
vtkCleanPolyData
34.24.1
Usage
vtkCleanPolyData is a filter that takes polygonal data as input and generates polygonal data as output. vtkCleanPolyData can merge duplicate points (within specified tolerance and if enabled), eliminate points that are not used,
and if enabled, transform degenerate cells into appropriate forms (for example, a triangle is converted into a line if
two points of triangle are merged).
Conversion of degenerate cells is controlled by the flags ConvertLinesToPoints, ConvertPolysToLines, ConvertStripsToPolys which act cumulatively such that a degenerate strip may become a poly. The full set is Line with 1
points -> Vert (if ConvertLinesToPoints) Poly with 2 points -> Line (if ConvertPolysToLines) Poly with 1 points ->
Vert (if ConvertPolysToLines && ConvertLinesToPoints) Strp with 3 points -> Poly (if ConvertStripsToPolys) Strp
with 2 points -> Line (if ConvertStripsToPolys && ConvertPolysToLines) Strp with 1 points -> Vert (if ConvertStripsToPolys && ConvertPolysToLines && ConvertLinesToPoints)
If tolerance is specified precisely=0.0, then vtkCleanPolyData will use the vtkMergePoints object to merge points
(which is faster). Otherwise the slower vtkIncrementalPointLocator is used. Before inserting points into the point
locator, this class calls a function OperateOnPoint which can be used (in subclasses) to further refine the cleaning
process. See vtkQuantizePolyDataPoints.
Note that merging of points can be disabled. In this case, a point locator will not be used, and points that are not
used by any cells will be eliminated, but never merged.
To create an instance of class vtkCleanPolyData, simply invoke its constructor as follows
obj = vtkCleanPolyData
34.24.2
Methods
The class vtkCleanPolyData has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkCleanPolyData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCleanPolyData = obj.NewInstance ()
vtkCleanPolyData = obj.SafeDownCast (vtkObject o)
obj.SetToleranceIsAbsolute (int ) - By default ToleranceIsAbsolute is false and Tolerance is a
fraction of Bounding box diagonal, if true, AbsoluteTolerance is used when adding points to locator (merging)
obj.ToleranceIsAbsoluteOn () - By default ToleranceIsAbsolute is false and Tolerance is a fraction
of Bounding box diagonal, if true, AbsoluteTolerance is used when adding points to locator (merging)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1114
obj.ToleranceIsAbsoluteOff () - By default ToleranceIsAbsolute is false and Tolerance is a fraction of Bounding box diagonal, if true, AbsoluteTolerance is used when adding points to locator (merging)
int = obj.GetToleranceIsAbsolute () - By default ToleranceIsAbsolute is false and Tolerance
is a fraction of Bounding box diagonal, if true, AbsoluteTolerance is used when adding points to locator
(merging)
obj.SetTolerance (double ) - Specify tolerance in terms of fraction of bounding box length.
double = obj.GetToleranceMinValue () - Specify tolerance in terms of fraction of bounding
box length.
double = obj.GetToleranceMaxValue () - Specify tolerance in terms of fraction of bounding
box length.
double = obj.GetTolerance () - Specify tolerance in terms of fraction of bounding box length.
obj.SetAbsoluteTolerance (double ) - Specify tolerance in absolute terms
double = obj.GetAbsoluteToleranceMinValue () - Specify tolerance in absolute terms
double = obj.GetAbsoluteToleranceMaxValue () - Specify tolerance in absolute terms
double = obj.GetAbsoluteTolerance () - Specify tolerance in absolute terms
obj.SetConvertLinesToPoints (int ) - Turn on/off conversion of degenerate lines to points
obj.ConvertLinesToPointsOn () - Turn on/off conversion of degenerate lines to points
obj.ConvertLinesToPointsOff () - Turn on/off conversion of degenerate lines to points
int = obj.GetConvertLinesToPoints () - Turn on/off conversion of degenerate lines to points
obj.SetConvertPolysToLines (int ) - Turn on/off conversion of degenerate polys to lines
obj.ConvertPolysToLinesOn () - Turn on/off conversion of degenerate polys to lines
obj.ConvertPolysToLinesOff () - Turn on/off conversion of degenerate polys to lines
int = obj.GetConvertPolysToLines () - Turn on/off conversion of degenerate polys to lines
obj.SetConvertStripsToPolys (int ) - Turn on/off conversion of degenerate strips to polys
obj.ConvertStripsToPolysOn () - Turn on/off conversion of degenerate strips to polys
obj.ConvertStripsToPolysOff () - Turn on/off conversion of degenerate strips to polys
int = obj.GetConvertStripsToPolys () - Turn on/off conversion of degenerate strips to polys
obj.SetPointMerging (int ) - Set/Get a boolean value that controls whether point merging is performed. If on, a locator will be used, and points laying within the appropriate tolerance may be merged. If off,
points are never merged. By default, merging is on.
int = obj.GetPointMerging () - Set/Get a boolean value that controls whether point merging is
performed. If on, a locator will be used, and points laying within the appropriate tolerance may be merged. If
off, points are never merged. By default, merging is on.
obj.PointMergingOn () - Set/Get a boolean value that controls whether point merging is performed.
If on, a locator will be used, and points laying within the appropriate tolerance may be merged. If off, points
are never merged. By default, merging is on.
obj.PointMergingOff () - Set/Get a boolean value that controls whether point merging is performed.
If on, a locator will be used, and points laying within the appropriate tolerance may be merged. If off, points
are never merged. By default, merging is on.
obj.SetLocator (vtkIncrementalPointLocator locator) - Set/Get a spatial locator for
speeding the search process. By default an instance of vtkMergePoints is used.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.25 vtkClipConvexPolyData
1115
34.25
vtkClipConvexPolyData
34.25.1
Usage
vtkClipConvexPolyData is a filter that clips a convex polydata with a set of planes. Its main usage is for clipping a
bounding volume with frustum planes (used later one in volume rendering).
To create an instance of class vtkClipConvexPolyData, simply invoke its constructor as follows
obj = vtkClipConvexPolyData
34.25.2
Methods
The class vtkClipConvexPolyData has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkClipConvexPolyData
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkClipConvexPolyData = obj.NewInstance ()
vtkClipConvexPolyData = obj.SafeDownCast (vtkObject o)
obj.SetPlanes (vtkPlaneCollection planes) - Set all the planes at once using a vtkPlanes
implicit function. This also sets the D value.
vtkPlaneCollection = obj.GetPlanes () - Set all the planes at once using a vtkPlanes implicit
function. This also sets the D value.
long = obj.GetMTime () - Redefines this method, as this filter depends on time of its components
(planes)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1116
34.26
vtkClipDataSet
34.26.1
Usage
vtkClipDataSet is a filter that clips any type of dataset using either any subclass of vtkImplicitFunction, or the input
scalar data. Clipping means that it actually "cuts" through the cells of the dataset, returning everything inside of
the specified implicit function (or greater than the scalar value) including "pieces" of a cell. (Compare this with
vtkExtractGeometry, which pulls out entire, uncut cells.) The output of this filter is an unstructured grid.
To use this filter, you must decide if you will be clipping with an implicit function, or whether you will be using the
input scalar data. If you want to clip with an implicit function, you must: 1) define an implicit function 2) set it
with the SetClipFunction method 3) apply the GenerateClipScalarsOn method If a ClipFunction is not specified, or
GenerateClipScalars is off (the default), then the inputs scalar data will be used to clip the polydata.
You can also specify a scalar value, which is used to decide what is inside and outside of the implicit function.
You can also reverse the sense of what inside/outside is by setting the InsideOut instance variable. (The clipping
algorithm proceeds by computing an implicit function value or using the input scalar data for each point in the
dataset. This is compared to the scalar value to determine inside/outside.)
This filter can be configured to compute a second output. The second output is the part of the cell that is clipped
away. Set the GenerateClippedData boolean on if you wish to access this output data.
To create an instance of class vtkClipDataSet, simply invoke its constructor as follows
obj = vtkClipDataSet
34.26.2
Methods
The class vtkClipDataSet has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkClipDataSet class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkClipDataSet = obj.NewInstance ()
vtkClipDataSet = obj.SafeDownCast (vtkObject o)
obj.SetValue (double ) - Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). The default value is 0.0. This value is ignored if UseValueAsOffset is true and a clip function is defined.
double = obj.GetValue () - Set the clipping value of the implicit function (if clipping with implicit
function) or scalar value (if clipping with scalars). The default value is 0.0. This value is ignored if UseValueAsOffset is true and a clip function is defined.
obj.SetUseValueAsOffset (bool ) - If UseValueAsOffset is true, Value is used as an offset parameter to the implicit function. Otherwise, Value is used only when clipping using a scalar array. Default is
true.
bool = obj.GetUseValueAsOffset () - If UseValueAsOffset is true, Value is used as an offset
parameter to the implicit function. Otherwise, Value is used only when clipping using a scalar array. Default
is true.
obj.UseValueAsOffsetOn () - If UseValueAsOffset is true, Value is used as an offset parameter to
the implicit function. Otherwise, Value is used only when clipping using a scalar array. Default is true.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.26 vtkClipDataSet
1117
1118
34.27
vtkClipHyperOctree
34.27.1
Usage
vtkClipHyperOctree is a filter that clips an hyperoctree using either any subclass of vtkImplicitFunction, or the input
scalar data. Clipping means that it actually "cuts" through the leaves (cells) of the hyperoctree, returning everything
inside of the specified implicit function (or greater than the scalar value) including "pieces" of a cell. (Compare this
with vtkExtractGeometry, which pulls out entire, uncut cells.) The output of this filter is an unstructured grid.
To use this filter, you must decide if you will be clipping with an implicit function, or whether you will be using the
input scalar data. If you want to clip with an implicit function, you must: 1) define an implicit function 2) set it
with the SetClipFunction method 3) apply the GenerateClipScalarsOn method If a ClipFunction is not specified, or
GenerateClipScalars is off (the default), then the inputs scalar data will be used to clip the polydata.
You can also specify a scalar value, which is used to decide what is inside and outside of the implicit function.
You can also reverse the sense of what inside/outside is by setting the InsideOut instance variable. (The clipping
algorithm proceeds by computing an implicit function value or using the input scalar data for each point in the
dataset. This is compared to the scalar value to determine inside/outside.)
This filter can be configured to compute a second output. The second output is the part of the cell that is clipped
away. Set the GenerateClippedData boolean on if you wish to access this output data.
To create an instance of class vtkClipHyperOctree, simply invoke its constructor as follows
obj = vtkClipHyperOctree
34.27.2
Methods
The class vtkClipHyperOctree has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkClipHyperOctree class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkClipHyperOctree = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.27 vtkClipHyperOctree
1119
1120
34.28
vtkClipPolyData
34.28.1
Usage
vtkClipPolyData is a filter that clips polygonal data using either any subclass of vtkImplicitFunction, or the input
scalar data. Clipping means that it actually "cuts" through the cells of the dataset, returning everything inside of
the specified implicit function (or greater than the scalar value) including "pieces" of a cell. (Compare this with
vtkExtractGeometry, which pulls out entire, uncut cells.) The output of this filter is polygonal data.
To use this filter, you must decide if you will be clipping with an implicit function, or whether you will be using the
input scalar data. If you want to clip with an implicit function, you must: 1) define an implicit function 2) set it
with the SetClipFunction method 3) apply the GenerateClipScalarsOn method If a ClipFunction is not specified, or
GenerateClipScalars is off (the default), then the inputs scalar data will be used to clip the polydata.
You can also specify a scalar value, which is used to decide what is inside and outside of the implicit function.
You can also reverse the sense of what inside/outside is by setting the InsideOut instance variable. (The cutting
algorithm proceeds by computing an implicit function value or using the input scalar data for each point in the
dataset. This is compared to the scalar value to determine inside/outside.)
This filter can be configured to compute a second output. The second output is the polygonal data that is clipped
away. Set the GenerateClippedData boolean on if you wish to access this output data.
To create an instance of class vtkClipPolyData, simply invoke its constructor as follows
obj = vtkClipPolyData
34.28.2
Methods
The class vtkClipPolyData has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkClipPolyData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkClipPolyData = obj.NewInstance ()
vtkClipPolyData = obj.SafeDownCast (vtkObject o)
obj.SetValue (double ) - Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). The default value is 0.0.
double = obj.GetValue () - Set the clipping value of the implicit function (if clipping with implicit
function) or scalar value (if clipping with scalars). The default value is 0.0.
obj.SetInsideOut (int ) - Set/Get the InsideOut flag. When off, a vertex is considered inside
the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex
is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar.
InsideOut is off by default.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.28 vtkClipPolyData
1121
int = obj.GetInsideOut () - Set/Get the InsideOut flag. When off, a vertex is considered inside
the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex
is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar.
InsideOut is off by default.
obj.InsideOutOn () - Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit
function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered
inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off
by default.
obj.InsideOutOff () - Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit
function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered
inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off
by default.
obj.SetClipFunction (vtkImplicitFunction )
vtkImplicitFunction = obj.GetClipFunction ()
obj.SetGenerateClipScalars (int ) - If this flag is enabled, then the output scalar values will
be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do
not provide an implicit function an error will be reported.
int = obj.GetGenerateClipScalars () - If this flag is enabled, then the output scalar values
will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but
do not provide an implicit function an error will be reported.
obj.GenerateClipScalarsOn () - If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not
provide an implicit function an error will be reported.
obj.GenerateClipScalarsOff () - If this flag is enabled, then the output scalar values will be
interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not
provide an implicit function an error will be reported.
obj.SetGenerateClippedOutput (int ) - Control whether a second output is generated. The
second output contains the polygonal data thats been clipped away.
int = obj.GetGenerateClippedOutput () - Control whether a second output is generated. The
second output contains the polygonal data thats been clipped away.
obj.GenerateClippedOutputOn () - Control whether a second output is generated. The second
output contains the polygonal data thats been clipped away.
obj.GenerateClippedOutputOff () - Control whether a second output is generated. The second
output contains the polygonal data thats been clipped away.
vtkPolyData = obj.GetClippedOutput () - Return the Clipped output.
vtkAlgorithmOutput = obj.GetClippedOutputPort () - Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.
obj.SetLocator (vtkIncrementalPointLocator locator) - Specify a spatial locator for
merging points. By default, an instance of vtkMergePoints is used.
vtkIncrementalPointLocator = obj.GetLocator () - Specify a spatial locator for merging
points. By default, an instance of vtkMergePoints is used.
obj.CreateDefaultLocator () - Create default locator. Used to create one when none is specified.
The locator is used to merge coincident points.
long = obj.GetMTime () - Return the mtime also considering the locator and clip function.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1122
34.29
vtkClipVolume
34.29.1
Usage
vtkClipVolume is a filter that clips volume data (i.e., vtkImageData) using either: any subclass of vtkImplicitFunction
or the input scalar data. The clipping operation cuts through the cells of the datasetconverting 3D image data into a
3D unstructured gridreturning everything inside of the specified implicit function (or greater than the scalar value).
During the clipping the filter will produce pieces of a cell. (Compare this with vtkExtractGeometry or vtkGeometryFilter, which produces entire, uncut cells.) The output of this filter is a 3D unstructured grid (e.g., tetrahedra or other
3D cell types).
To use this filter, you must decide if you will be clipping with an implicit function, or whether you will be using the input
scalar data. If you want to clip with an implicit function, you must first define and then set the implicit function with
the SetClipFunction() method. Otherwise, you must make sure input scalar data is available. You can also specify
a scalar value, which is used to decide what is inside and outside of the implicit function. You can also reverse
the sense of what inside/outside is by setting the InsideOut instance variable. (The cutting algorithm proceeds by
computing an implicit function value or using the input scalar data for each point in the dataset. This is compared to
the scalar value to determine inside/outside.)
This filter can be configured to compute a second output. The second output is the portion of the volume that is
clipped away. Set the GenerateClippedData boolean on if you wish to access this output data.
The filter will produce an unstructured grid of entirely tetrahedra or a mixed grid of tetrahedra and other 3D cell
types (e.g., wedges). Control this behavior by setting the Mixed3DCellGeneration. By default the Mixed3DCellGeneration is on and a combination of cell types will be produced. Note that producing mixed cell types is a faster
than producing only tetrahedra.
To create an instance of class vtkClipVolume, simply invoke its constructor as follows
obj = vtkClipVolume
34.29.2
Methods
The class vtkClipVolume has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkClipVolume class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkClipVolume = obj.NewInstance ()
vtkClipVolume = obj.SafeDownCast (vtkObject o)
obj.SetValue (double ) - Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). The default value is 0.0.
double = obj.GetValue () - Set the clipping value of the implicit function (if clipping with implicit
function) or scalar value (if clipping with scalars). The default value is 0.0.
obj.SetInsideOut (int ) - Set/Get the InsideOut flag. When off, a vertex is considered inside
the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex
is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar.
InsideOut is off by default.
int = obj.GetInsideOut () - Set/Get the InsideOut flag. When off, a vertex is considered inside
the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex
is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar.
InsideOut is off by default.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.29 vtkClipVolume
1123
obj.InsideOutOn () - Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit
function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered
inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off
by default.
obj.InsideOutOff () - Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit
function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered
inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off
by default.
obj.SetClipFunction (vtkImplicitFunction )
vtkImplicitFunction = obj.GetClipFunction ()
obj.SetGenerateClipScalars (int ) - If this flag is enabled, then the output scalar values will
be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do
not provide an implicit function an error will be reported.
int = obj.GetGenerateClipScalars () - If this flag is enabled, then the output scalar values
will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but
do not provide an implicit function an error will be reported.
obj.GenerateClipScalarsOn () - If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not
provide an implicit function an error will be reported.
obj.GenerateClipScalarsOff () - If this flag is enabled, then the output scalar values will be
interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not
provide an implicit function an error will be reported.
obj.SetGenerateClippedOutput (int ) - Control whether a second output is generated. The
second output contains the unstructured grid thats been clipped away.
int = obj.GetGenerateClippedOutput () - Control whether a second output is generated. The
second output contains the unstructured grid thats been clipped away.
obj.GenerateClippedOutputOn () - Control whether a second output is generated. The second
output contains the unstructured grid thats been clipped away.
obj.GenerateClippedOutputOff () - Control whether a second output is generated. The second
output contains the unstructured grid thats been clipped away.
vtkUnstructuredGrid = obj.GetClippedOutput () - Return the clipped output.
obj.SetMixed3DCellGeneration (int ) - Control whether the filter produces a mix of 3D cell
types on output, or whether the output cells are all tetrahedra. By default, a mixed set of cells (e.g., tetrahedra
and wedges) is produced. (Note: mixed type generation is faster and less overall data is generated.)
int = obj.GetMixed3DCellGeneration () - Control whether the filter produces a mix of 3D cell
types on output, or whether the output cells are all tetrahedra. By default, a mixed set of cells (e.g., tetrahedra
and wedges) is produced. (Note: mixed type generation is faster and less overall data is generated.)
obj.Mixed3DCellGenerationOn () - Control whether the filter produces a mix of 3D cell types on
output, or whether the output cells are all tetrahedra. By default, a mixed set of cells (e.g., tetrahedra and
wedges) is produced. (Note: mixed type generation is faster and less overall data is generated.)
obj.Mixed3DCellGenerationOff () - Control whether the filter produces a mix of 3D cell types on
output, or whether the output cells are all tetrahedra. By default, a mixed set of cells (e.g., tetrahedra and
wedges) is produced. (Note: mixed type generation is faster and less overall data is generated.)
obj.SetMergeTolerance (double ) - Set the tolerance for merging clip intersection points that are
near the corners of voxels. This tolerance is used to prevent the generation of degenerate tetrahedra.
double = obj.GetMergeToleranceMinValue () - Set the tolerance for merging clip intersection
points that are near the corners of voxels. This tolerance is used to prevent the generation of degenerate
tetrahedra.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1124
34.30
vtkCoincidentPoints
34.30.1
Usage
This class provides a collection of points that is organized such that each coordinate is stored with a set of point ids
of points that are all coincident.
To create an instance of class vtkCoincidentPoints, simply invoke its constructor as follows
obj = vtkCoincidentPoints
34.30.2
Methods
The class vtkCoincidentPoints has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkCoincidentPoints class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCoincidentPoints = obj.NewInstance ()
vtkCoincidentPoints = obj.SafeDownCast (vtkObject o)
obj.AddPoint (vtkIdType Id, double point[3]) - Accumulates a set of Ids in a map where
the point coordinate is the key. All Ids in a given map entry are thus coincident.
Parameters
in
Id
point
34.31 vtkCompositeDataGeometryFilter
1125
Parameters
point
in
34.31
vtkCompositeDataGeometryFilter
34.31.1
Usage
34.31.2
Methods
The class vtkCompositeDataGeometryFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCompositeDataGeometryFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCompositeDataGeometryFilter = obj.NewInstance ()
vtkCompositeDataGeometryFilter = obj.SafeDownCast (vtkObject o)
34.32
vtkCompositeDataProbeFilter
34.32.1
Usage
vtkCompositeDataProbeFilter supports probing into multi-group datasets. It sequentially probes through each concrete dataset within the composite probing at only those locations at which there were no hits when probing earlier
datasets. For Hierarchical datasets, this traversal through leaf datasets is done in reverse order of levels i.e. highest
level first.
When dealing with composite datasets, partial arrays are common i.e. data-arrays that are not available in all of
the blocks. By default, this filter only passes those point and cell data-arrays that are available in all the blocks i.e.
partial array are removed. When PassPartialArrays is turned on, this behavior is changed to take a union of all
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1126
arrays present thus partial arrays are passed as well. However, for composite dataset input, this filter still produces
a non-composite output. For all those locations in a block of where a particular data array is missing, this filter uses
vtkMath::Nan() for double and float arrays, while 0 for all other types of arrays i.e int, char etc.
To create an instance of class vtkCompositeDataProbeFilter, simply invoke its constructor as follows
obj = vtkCompositeDataProbeFilter
34.32.2
Methods
The class vtkCompositeDataProbeFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCompositeDataProbeFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCompositeDataProbeFilter = obj.NewInstance ()
vtkCompositeDataProbeFilter = obj.SafeDownCast (vtkObject o)
obj.SetPassPartialArrays (bool ) - When dealing with composite datasets, partial arrays are
common i.e. data-arrays that are not available in all of the blocks. By default, this filter only passes those point
and cell data-arrays that are available in all the blocks i.e. partial array are removed. When PassPartialArrays
is turned on, this behavior is changed to take a union of all arrays present thus partial arrays are passed as
well. However, for composite dataset input, this filter still produces a non-composite output. For all those
locations in a block of where a particular data array is missing, this filter uses vtkMath::Nan() for double and
float arrays, while 0 for all other types of arrays i.e int, char etc.
bool = obj.GetPassPartialArrays () - When dealing with composite datasets, partial arrays
are common i.e. data-arrays that are not available in all of the blocks. By default, this filter only passes those
point and cell data-arrays that are available in all the blocks i.e. partial array are removed. When PassPartialArrays is turned on, this behavior is changed to take a union of all arrays present thus partial arrays are
passed as well. However, for composite dataset input, this filter still produces a non-composite output. For all
those locations in a block of where a particular data array is missing, this filter uses vtkMath::Nan() for double
and float arrays, while 0 for all other types of arrays i.e int, char etc.
obj.PassPartialArraysOn () - When dealing with composite datasets, partial arrays are common
i.e. data-arrays that are not available in all of the blocks. By default, this filter only passes those point and
cell data-arrays that are available in all the blocks i.e. partial array are removed. When PassPartialArrays is
turned on, this behavior is changed to take a union of all arrays present thus partial arrays are passed as well.
However, for composite dataset input, this filter still produces a non-composite output. For all those locations
in a block of where a particular data array is missing, this filter uses vtkMath::Nan() for double and float arrays,
while 0 for all other types of arrays i.e int, char etc.
obj.PassPartialArraysOff () - When dealing with composite datasets, partial arrays are common
i.e. data-arrays that are not available in all of the blocks. By default, this filter only passes those point and
cell data-arrays that are available in all the blocks i.e. partial array are removed. When PassPartialArrays is
turned on, this behavior is changed to take a union of all arrays present thus partial arrays are passed as well.
However, for composite dataset input, this filter still produces a non-composite output. For all those locations
in a block of where a particular data array is missing, this filter uses vtkMath::Nan() for double and float arrays,
while 0 for all other types of arrays i.e int, char etc.
34.33
vtkConeSource
34.33 vtkConeSource
34.33.1
1127
Usage
vtkConeSource creates a cone centered at a specified point and pointing in a specified direction. (By default, the
center is the origin and the direction is the x-axis.) Depending upon the resolution of this object, different representations are created. If resolution=0 a line is created; if resolution=1, a single triangle is created; if resolution=2, two
crossed triangles are created. For resolution > 2, a 3D cone (with resolution number of sides) is created. It also is
possible to control whether the bottom of the cone is capped with a (resolution-sided) polygon, and to specify the
height and radius of the cone.
To create an instance of class vtkConeSource, simply invoke its constructor as follows
obj = vtkConeSource
34.33.2
Methods
The class vtkConeSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkConeSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkConeSource = obj.NewInstance ()
vtkConeSource = obj.SafeDownCast (vtkObject o)
obj.SetHeight (double ) - Set the height of the cone. This is the height along the cone in its
specified direction.
double = obj.GetHeightMinValue () - Set the height of the cone. This is the height along the
cone in its specified direction.
double = obj.GetHeightMaxValue () - Set the height of the cone. This is the height along the
cone in its specified direction.
double = obj.GetHeight () - Set the height of the cone. This is the height along the cone in its
specified direction.
obj.SetRadius (double ) - Set the base radius of the cone.
double = obj.GetRadiusMinValue () - Set the base radius of the cone.
double = obj.GetRadiusMaxValue () - Set the base radius of the cone.
double = obj.GetRadius () - Set the base radius of the cone.
obj.SetResolution (int ) - Set the number of facets used to represent the cone.
int = obj.GetResolutionMinValue () - Set the number of facets used to represent the cone.
int = obj.GetResolutionMaxValue () - Set the number of facets used to represent the cone.
int = obj.GetResolution () - Set the number of facets used to represent the cone.
obj.SetCenter (double , double , double ) - Set the center of the cone. It is located at the
middle of the axis of the cone. Warning: this is not the center of the base of the cone! The default is 0,0,0.
obj.SetCenter (double a[3]) - Set the center of the cone. It is located at the middle of the axis of
the cone. Warning: this is not the center of the base of the cone! The default is 0,0,0.
double = obj. GetCenter () - Set the center of the cone. It is located at the middle of the axis of
the cone. Warning: this is not the center of the base of the cone! The default is 0,0,0.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1128
obj.SetDirection (double , double , double ) - Set the orientation vector of the cone.
The vector does not have to be normalized. The direction goes from the center of the base toward the apex.
The default is (1,0,0).
obj.SetDirection (double a[3]) - Set the orientation vector of the cone. The vector does not
have to be normalized. The direction goes from the center of the base toward the apex. The default is (1,0,0).
double = obj. GetDirection () - Set the orientation vector of the cone. The vector does not
have to be normalized. The direction goes from the center of the base toward the apex. The default is (1,0,0).
obj.SetAngle (double angle) - Set the angle of the cone. This is the angle between the axis of
the cone and a generatrix. Warning: this is not the aperture! The aperture is twice this angle. As a side effect,
the angle plus height sets the base radius of the cone. Angle is expressed in degrees.
double = obj.GetAngle () - Set the angle of the cone. This is the angle between the axis of the
cone and a generatrix. Warning: this is not the aperture! The aperture is twice this angle. As a side effect,
the angle plus height sets the base radius of the cone. Angle is expressed in degrees.
obj.SetCapping (int ) - Turn on/off whether to cap the base of the cone with a polygon.
int = obj.GetCapping () - Turn on/off whether to cap the base of the cone with a polygon.
obj.CappingOn () - Turn on/off whether to cap the base of the cone with a polygon.
obj.CappingOff () - Turn on/off whether to cap the base of the cone with a polygon.
34.34
vtkConnectivityFilter
34.34.1
Usage
vtkConnectivityFilter is a filter that extracts cells that share common points and/or meet other connectivity criterion.
(Cells that share vertices and meet other connectivity criterion such as scalar range are known as a region.) The
filter works in one of six ways: 1) extract the largest connected region in the dataset; 2) extract specified region
numbers; 3) extract all regions sharing specified point ids; 4) extract all regions sharing specified cell ids; 5) extract
the region closest to the specified point; or 6) extract all regions (used to color the data by region).
vtkConnectivityFilter is generalized to handle any type of input dataset. It generates output data of type vtkUnstructuredGrid. If you know that your input type is vtkPolyData, you may wish to use vtkPolyDataConnectivityFilter.
The behavior of vtkConnectivityFilter can be modified by turning on the boolean ivar ScalarConnectivity. If this flag
is on, the connectivity algorithm is modified so that cells are considered connected only if 1) they are geometrically
connected (share a point) and 2) the scalar values of one of the cells points falls in the scalar range specified. This
use of ScalarConnectivity is particularly useful for volume datasets: it can be used as a simple "connected segmentation" algorithm. For example, by using a seed voxel (i.e., cell) on a known anatomical structure, connectivity will
pull out all voxels "containing" the anatomical structure. These voxels can then be contoured or processed by other
visualization filters.
To create an instance of class vtkConnectivityFilter, simply invoke its constructor as follows
obj = vtkConnectivityFilter
34.34.2
Methods
The class vtkConnectivityFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkConnectivityFilter class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.34 vtkConnectivityFilter
1129
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkConnectivityFilter = obj.NewInstance ()
vtkConnectivityFilter = obj.SafeDownCast (vtkObject o)
obj.SetScalarConnectivity (int ) - Turn on/off connectivity based on scalar value. If on, cells
are connected only if they share points AND one of the cells scalar values falls in the scalar range specified.
int = obj.GetScalarConnectivity () - Turn on/off connectivity based on scalar value. If on,
cells are connected only if they share points AND one of the cells scalar values falls in the scalar range
specified.
obj.ScalarConnectivityOn () - Turn on/off connectivity based on scalar value. If on, cells are
connected only if they share points AND one of the cells scalar values falls in the scalar range specified.
obj.ScalarConnectivityOff () - Turn on/off connectivity based on scalar value. If on, cells are
connected only if they share points AND one of the cells scalar values falls in the scalar range specified.
obj.SetScalarRange (double , double ) - Set the scalar range to use to extract cells based
on scalar connectivity.
obj.SetScalarRange (double a[2]) - Set the scalar range to use to extract cells based on scalar
connectivity.
double = obj.
connectivity.
GetScalarRange () - Set the scalar range to use to extract cells based on scalar
1130
obj.SetClosestPoint (double , double , double ) - Use to specify x-y-z point coordinates when extracting the region closest to a specified point.
obj.SetClosestPoint (double a[3]) - Use to specify x-y-z point coordinates when extracting
the region closest to a specified point.
double = obj. GetClosestPoint () - Use to specify x-y-z point coordinates when extracting
the region closest to a specified point.
int = obj.GetNumberOfExtractedRegions () - Obtain the number of connected regions.
obj.SetColorRegions (int ) - Turn on/off the coloring of connected regions.
int = obj.GetColorRegions () - Turn on/off the coloring of connected regions.
obj.ColorRegionsOn () - Turn on/off the coloring of connected regions.
obj.ColorRegionsOff () - Turn on/off the coloring of connected regions.
34.35
vtkContourFilter
34.35.1
Usage
vtkContourFilter is a filter that takes as input any dataset and generates on output isosurfaces and/or isolines. The
exact form of the output depends upon the dimensionality of the input data. Data consisting of 3D cells will generate
isosurfaces, data consisting of 2D cells will generate isolines, and data with 1D or 0D cells will generate isopoints.
Combinations of output type are possible if the input dimension is mixed.
To use this filter you must specify one or more contour values. You can either use the method SetValue() to specify
each contour value, or use GenerateValues() to generate a series of evenly spaced contours. It is also possible
to accelerate the operation of this filter (at the cost of extra memory) by using a vtkScalarTree. A scalar tree is
used to quickly locate cells that contain a contour surface. This is especially effective if multiple contours are being
extracted. If you want to use a scalar tree, invoke the method UseScalarTreeOn().
To create an instance of class vtkContourFilter, simply invoke its constructor as follows
obj = vtkContourFilter
34.35.2
Methods
The class vtkContourFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkContourFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkContourFilter = obj.NewInstance ()
vtkContourFilter = obj.SafeDownCast (vtkObject o)
obj.SetValue (int i, double value) - Methods to set / get contour values.
double = obj.GetValue (int i) - Methods to set / get contour values.
obj.GetValues (double contourValues) - Methods to set / get contour values.
obj.SetNumberOfContours (int number) - Methods to set / get contour values.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.35 vtkContourFilter
1131
1132
34.36
vtkContourGrid
34.36.1
Usage
vtkContourGrid is a filter that takes as input datasets of type vtkUnstructuredGrid and generates on output isosurfaces and/or isolines. The exact form of the output depends upon the dimensionality of the input data. Data
consisting of 3D cells will generate isosurfaces, data consisting of 2D cells will generate isolines, and data with 1D
or 0D cells will generate isopoints. Combinations of output type are possible if the input dimension is mixed.
To use this filter you must specify one or more contour values. You can either use the method SetValue() to specify
each contour value, or use GenerateValues() to generate a series of evenly spaced contours. It is also possible
to accelerate the operation of this filter (at the cost of extra memory) by using a vtkScalarTree. A scalar tree is
used to quickly locate cells that contain a contour surface. This is especially effective if multiple contours are being
extracted. If you want to use a scalar tree, invoke the method UseScalarTreeOn().
To create an instance of class vtkContourGrid, simply invoke its constructor as follows
obj = vtkContourGrid
34.36.2
Methods
The class vtkContourGrid has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkContourGrid class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkContourGrid = obj.NewInstance ()
vtkContourGrid = obj.SafeDownCast (vtkObject o)
obj.SetValue (int i, double value) - Methods to set / get contour values.
double = obj.GetValue (int i) - Methods to set / get contour values.
obj.GetValues (double contourValues) - Methods to set / get contour values.
obj.SetNumberOfContours (int number) - Methods to set / get contour values.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.36 vtkContourGrid
1133
1134
34.37
vtkConvertSelection
34.37.1
Usage
vtkConvertSelection converts an input selection from one type to another in the context of a data object being
selected. The first input is the selection, while the second input is the data object that the selection relates to.
To create an instance of class vtkConvertSelection, simply invoke its constructor as follows
obj = vtkConvertSelection
34.37.2
Methods
The class vtkConvertSelection has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkConvertSelection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkConvertSelection = obj.NewInstance ()
vtkConvertSelection = obj.SafeDownCast (vtkObject o)
obj.SetDataObjectConnection (vtkAlgorithmOutput in) - A convenience method for
setting the second input (i.e. the data object).
obj.SetInputFieldType (int ) - The input field type. If this is set to a number other than -1,
ignores the input selection field type and instead assumes that all selection nodes have the field type specified.
This should be one of the constants defined in vtkSelectionNode.h. Default is -1.
int = obj.GetInputFieldType () - The input field type. If this is set to a number other than 1, ignores the input selection field type and instead assumes that all selection nodes have the field type
specified. This should be one of the constants defined in vtkSelectionNode.h. Default is -1.
obj.SetOutputType (int ) - The output selection content type. This should be one of the constants
defined in vtkSelectionNode.h.
int = obj.GetOutputType () - The output selection content type. This should be one of the constants defined in vtkSelectionNode.h.
obj.SetArrayName (string ) - The output array name for value or threshold selections.
string = obj.GetArrayName () - The output array name for value or threshold selections.
obj.SetArrayNames (vtkStringArray ) - The output array names for value selection.
vtkStringArray = obj.GetArrayNames () - The output array names for value selection.
obj.AddArrayName (string ) - Convenience methods used by UI
obj.ClearArrayNames () - Convenience methods used by UI
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.38 vtkCubeSource
1135
obj.SetMatchAnyValues (bool ) - When on, creates a separate selection node for each array.
Defaults to OFF.
bool = obj.GetMatchAnyValues () - When on, creates a separate selection node for each array.
Defaults to OFF.
obj.MatchAnyValuesOn () - When on, creates a separate selection node for each array. Defaults to
OFF.
obj.MatchAnyValuesOff () - When on, creates a separate selection node for each array. Defaults
to OFF.
34.38
vtkCubeSource
34.38.1
Usage
vtkCubeSource creates a cube centered at origin. The cube is represented with four-sided polygons. It is possible
to specify the length, width, and height of the cube independently.
To create an instance of class vtkCubeSource, simply invoke its constructor as follows
obj = vtkCubeSource
34.38.2
Methods
The class vtkCubeSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkCubeSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCubeSource = obj.NewInstance ()
vtkCubeSource = obj.SafeDownCast (vtkObject o)
obj.SetXLength (double ) - Set the length of the cube in the x-direction.
double = obj.GetXLengthMinValue () - Set the length of the cube in the x-direction.
double = obj.GetXLengthMaxValue () - Set the length of the cube in the x-direction.
double = obj.GetXLength () - Set the length of the cube in the x-direction.
obj.SetYLength (double ) - Set the length of the cube in the y-direction.
double = obj.GetYLengthMinValue () - Set the length of the cube in the y-direction.
double = obj.GetYLengthMaxValue () - Set the length of the cube in the y-direction.
double = obj.GetYLength () - Set the length of the cube in the y-direction.
obj.SetZLength (double ) - Set the length of the cube in the z-direction.
double = obj.GetZLengthMinValue () - Set the length of the cube in the z-direction.
double = obj.GetZLengthMaxValue () - Set the length of the cube in the z-direction.
double = obj.GetZLength () - Set the length of the cube in the z-direction.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1136
obj.SetBounds (double xMin, double xMax, double yMin, double yMax, double
zMin, double zMax) - Convenience method allows creation of cube by specifying bounding box.
obj.SetBounds (double bounds[6]) - Convenience method allows creation of cube by specifying
bounding box.
34.39
vtkCursor2D
34.39.1
Usage
vtkCursor2D is a class that generates a 2D cursor representation. The cursor consists of two intersection axes lines
that meet at the cursor focus. Several optional features are available as well. An optional 2D bounding box may be
enabled. An inner radius, centered at the focal point, can be set that erases the intersecting lines (e.g., it leaves
a clear area under the focal point so you can see what you are selecting). And finally, an optional point can be
enabled located at the focal point. All of these features can be turned on and off independently.
To create an instance of class vtkCursor2D, simply invoke its constructor as follows
obj = vtkCursor2D
34.39.2
Methods
The class vtkCursor2D has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCursor2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCursor2D = obj.NewInstance ()
vtkCursor2D = obj.SafeDownCast (vtkObject o)
obj.SetModelBounds (double xmin, double xmax, double ymin, double ymax,
double zmin, double zmax) - Set / get the bounding box of the 2D cursor. This defines the outline
of the cursor, and where the focal point should lie.
obj.SetModelBounds (double bounds[6]) - Set / get the bounding box of the 2D cursor. This
defines the outline of the cursor, and where the focal point should lie.
double = obj. GetModelBounds () - Set / get the bounding box of the 2D cursor. This defines
the outline of the cursor, and where the focal point should lie.
obj.SetFocalPoint (double x[3]) - Set/Get the position of cursor focus. If translation mode is
on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal
point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires
that the bounding box is set prior to the focal point.) Note that the method takes a 3D point but ignores the
z-coordinate value.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.39 vtkCursor2D
1137
obj.SetFocalPoint (double x, double y, double z) - Set/Get the position of cursor focus. If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note:
this behavior requires that the bounding box is set prior to the focal point.) Note that the method takes a 3D
point but ignores the z-coordinate value.
double = obj. GetFocalPoint () - Set/Get the position of cursor focus. If translation mode is
on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal
point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires
that the bounding box is set prior to the focal point.) Note that the method takes a 3D point but ignores the
z-coordinate value.
obj.SetOutline (int ) - Turn on/off the wireframe bounding box.
int = obj.GetOutline () - Turn on/off the wireframe bounding box.
obj.OutlineOn () - Turn on/off the wireframe bounding box.
obj.OutlineOff () - Turn on/off the wireframe bounding box.
obj.SetAxes (int ) - Turn on/off the wireframe axes.
int = obj.GetAxes () - Turn on/off the wireframe axes.
obj.AxesOn () - Turn on/off the wireframe axes.
obj.AxesOff () - Turn on/off the wireframe axes.
obj.SetRadius (double ) - Specify a radius for a circle. This erases the cursor lines around the focal
point.
double = obj.GetRadiusMinValue () - Specify a radius for a circle. This erases the cursor lines
around the focal point.
double = obj.GetRadiusMaxValue () - Specify a radius for a circle. This erases the cursor lines
around the focal point.
double = obj.GetRadius () - Specify a radius for a circle. This erases the cursor lines around the
focal point.
obj.SetPoint (int ) - Turn on/off the point located at the cursor focus.
int = obj.GetPoint () - Turn on/off the point located at the cursor focus.
obj.PointOn () - Turn on/off the point located at the cursor focus.
obj.PointOff () - Turn on/off the point located at the cursor focus.
obj.SetTranslationMode (int ) - Enable/disable the translation mode. If on, changes in cursor
position cause the entire widget to translate along with the cursor. By default, translation mode is off.
int = obj.GetTranslationMode () - Enable/disable the translation mode. If on, changes in cursor
position cause the entire widget to translate along with the cursor. By default, translation mode is off.
obj.TranslationModeOn () - Enable/disable the translation mode. If on, changes in cursor position
cause the entire widget to translate along with the cursor. By default, translation mode is off.
obj.TranslationModeOff () - Enable/disable the translation mode. If on, changes in cursor position
cause the entire widget to translate along with the cursor. By default, translation mode is off.
obj.SetWrap (int ) - Turn on/off cursor wrapping. If the cursor focus moves outside the specified
bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around
(Wrap=on).
int = obj.GetWrap () - Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around
(Wrap=on).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1138
obj.WrapOn () - Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds,
the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on).
obj.WrapOff () - Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds,
the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on).
obj.AllOn () - Turn every part of the cursor on or off.
obj.AllOff () - Turn every part of the cursor on or off.
34.40
vtkCursor3D
34.40.1
Usage
vtkCursor3D is an object that generates a 3D representation of a cursor. The cursor consists of a wireframe
bounding box, three intersecting axes lines that meet at the cursor focus, and "shadows" or projections of the axes
against the sides of the bounding box. Each of these components can be turned on/off.
This filter generates two output datasets. The first (Output) is just the geometric representation of the cursor. The
second (Focus) is a single point at the focal point.
To create an instance of class vtkCursor3D, simply invoke its constructor as follows
obj = vtkCursor3D
34.40.2
Methods
The class vtkCursor3D has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCursor3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCursor3D = obj.NewInstance ()
vtkCursor3D = obj.SafeDownCast (vtkObject o)
obj.SetModelBounds (double xmin, double xmax, double ymin, double ymax,
double zmin, double zmax) - Set / get the boundary of the 3D cursor.
obj.SetModelBounds (double bounds[6]) - Set / get the boundary of the 3D cursor.
double = obj.
obj.SetFocalPoint (double x[3]) - Set/Get the position of cursor focus. If translation mode is
on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal
point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires that
the bounding box is set prior to the focal point.)
obj.SetFocalPoint (double x, double y, double z) - Set/Get the position of cursor focus. If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note:
this behavior requires that the bounding box is set prior to the focal point.)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.40 vtkCursor3D
1139
double = obj. GetFocalPoint () - Set/Get the position of cursor focus. If translation mode is
on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal
point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires that
the bounding box is set prior to the focal point.)
obj.SetOutline (int ) - Turn on/off the wireframe bounding box.
int = obj.GetOutline () - Turn on/off the wireframe bounding box.
obj.OutlineOn () - Turn on/off the wireframe bounding box.
obj.OutlineOff () - Turn on/off the wireframe bounding box.
obj.SetAxes (int ) - Turn on/off the wireframe axes.
int = obj.GetAxes () - Turn on/off the wireframe axes.
obj.AxesOn () - Turn on/off the wireframe axes.
obj.AxesOff () - Turn on/off the wireframe axes.
obj.SetXShadows (int ) - Turn on/off the wireframe x-shadows.
int = obj.GetXShadows () - Turn on/off the wireframe x-shadows.
obj.XShadowsOn () - Turn on/off the wireframe x-shadows.
obj.XShadowsOff () - Turn on/off the wireframe x-shadows.
obj.SetYShadows (int ) - Turn on/off the wireframe y-shadows.
int = obj.GetYShadows () - Turn on/off the wireframe y-shadows.
obj.YShadowsOn () - Turn on/off the wireframe y-shadows.
obj.YShadowsOff () - Turn on/off the wireframe y-shadows.
obj.SetZShadows (int ) - Turn on/off the wireframe z-shadows.
int = obj.GetZShadows () - Turn on/off the wireframe z-shadows.
obj.ZShadowsOn () - Turn on/off the wireframe z-shadows.
obj.ZShadowsOff () - Turn on/off the wireframe z-shadows.
obj.SetTranslationMode (int ) - Enable/disable the translation mode. If on, changes in cursor
position cause the entire widget to translate along with the cursor. By default, translation mode is off.
int = obj.GetTranslationMode () - Enable/disable the translation mode. If on, changes in cursor
position cause the entire widget to translate along with the cursor. By default, translation mode is off.
obj.TranslationModeOn () - Enable/disable the translation mode. If on, changes in cursor position
cause the entire widget to translate along with the cursor. By default, translation mode is off.
obj.TranslationModeOff () - Enable/disable the translation mode. If on, changes in cursor position
cause the entire widget to translate along with the cursor. By default, translation mode is off.
obj.SetWrap (int ) - Turn on/off cursor wrapping. If the cursor focus moves outside the specified
bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around
(Wrap=on).
int = obj.GetWrap () - Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around
(Wrap=on).
obj.WrapOn () - Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds,
the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1140
obj.WrapOff () - Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds,
the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on).
vtkPolyData = obj.GetFocus () - Get the focus for this filter.
obj.AllOn () - Turn every part of the 3D cursor on or off.
obj.AllOff () - Turn every part of the 3D cursor on or off.
34.41
vtkCurvatures
34.41.1
Usage
vtkCurvatures takes a polydata input and computes the curvature of the mesh at each point. Four possible methods
of computation are available :
Gauss Curvature discrete Gauss curvature (K) computation, K(vertexv) = 2 PI f acetneighbs f o f v (angle f atv)
The contribution of every facet is for the moment weighted by Area( f acet)/3 The units of Gaussian Curvature are
[1/m2 ]
Mean Curvature H(vertexv) = averageoveredgesneighbseo f H(e) H(edgee) = length(e) dihedrala ngle(e) NB:
dihedral_angle is the ORIENTED angle between -PI and PI, this means that the surface is assumed to be orientable
the computation creates the orientation The units of Mean Curvature are [1/m]
Maximum ( km ax) and Minimum ( km in) Principal Curvatures km ax = H + sqrt(H 2 K) km in = H sqrt(H 2 K)
Excepting spherical and planar surfaces which have equal principal curvatures, the curvature at a point on a surface
varies with the direction one "sets off" from the point. For all directions, the curvature will pass through two extrema:
a minimum ( km in) and a maximum ( km ax) which occur at mutually orthogonal directions to each other.
NB. The sign of the Gauss curvature is a geometric ivariant, it should be +ve when the surface looks like a sphere,
-ve when it looks like a saddle, however, the sign of the Mean curvature is not, it depends on the convention for
normals - This code assumes that normals point outwards (ie from the surface of a sphere outwards). If a given
mesh produces curvatures of opposite senses then the flag InvertMeanCurvature can be set and the Curvature
reported by the Mean calculation will be inverted.
.SECTION Thanks Philip Batchelor philipp.batchelor@kcl.ac.uk for creating and contributing the class
and Andrew Maclean a.maclean@acfr.usyd.edu.au for cleanups and fixes. Thanks also to Goodwin
Lawlor for contributing patch to calculate principal curvatures
To create an instance of class vtkCurvatures, simply invoke its constructor as follows
obj = vtkCurvatures
34.41.2
Methods
The class vtkCurvatures has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCurvatures class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCurvatures = obj.NewInstance ()
vtkCurvatures = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.42 vtkCutter
1141
34.42
vtkCutter
34.42.1
Usage
vtkCutter is a filter to cut through data using any subclass of vtkImplicitFunction. That is, a polygonal surface is
created corresponding to the implicit function F(x,y,z) = value(s), where you can specify one or more values used to
cut with.
In VTK, cutting means reducing a cell of dimension N to a cut surface of dimension N-1. For example, a tetrahedron
when cut by a plane (i.e., vtkPlane implicit function) will generate triangles. (In comparison, clipping takes a N
dimensional cell and creates N dimension primitives.)
vtkCutter is generally used to "slice-through" a dataset, generating a surface that can be visualized. It is also
possible to use vtkCutter to do a form of volume rendering. vtkCutter does this by generating multiple cut surfaces
(usually planes) which are ordered (and rendered) from back-to-front. The surfaces are set translucent to give a
volumetric rendering effect.
Note that data can be cut using either 1) the scalar values associated with the dataset or 2) an implicit function
associated with this class. By default, if an implicit function is set it is used to clip the data set, otherwise the dataset
scalars are used to perform the clipping.
To create an instance of class vtkCutter, simply invoke its constructor as follows
obj = vtkCutter
1142
34.42.2
Methods
The class vtkCutter has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCutter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCutter = obj.NewInstance ()
vtkCutter = obj.SafeDownCast (vtkObject o)
obj.SetValue (int i, double value) - Get the ith contour value.
double = obj.GetValue (int i) - Get a pointer to an array of contour values. There will be GetNumberOfContours() values in the list.
obj.GetValues (double contourValues) - Set the number of contours to place into the list. You
only really need to use this method to reduce list size. The method SetValue() will automatically increase list
size as needed.
obj.SetNumberOfContours (int number) - Get the number of contours in the list of contour
values.
int = obj.GetNumberOfContours () - Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.
obj.GenerateValues (int numContours, double range[2]) - Generate numContours
equally spaced contour values between specified range. Contour values will include min/max range values.
obj.GenerateValues (int numContours, double rangeStart, double rangeEnd) - Override GetMTime because we delegate to vtkContourValues and refer to vtkImplicitFunction.
long = obj.GetMTime () - Override GetMTime because we delegate to vtkContourValues and refer
to vtkImplicitFunction.
obj.SetCutFunction (vtkImplicitFunction )
vtkImplicitFunction = obj.GetCutFunction ()
obj.SetGenerateCutScalars (int ) - If this flag is enabled, then the output scalar values will be
interpolated from the implicit function values, and not the input scalar data.
int = obj.GetGenerateCutScalars () - If this flag is enabled, then the output scalar values will
be interpolated from the implicit function values, and not the input scalar data.
obj.GenerateCutScalarsOn () - If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
obj.GenerateCutScalarsOff () - If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
obj.SetLocator (vtkIncrementalPointLocator locator) - Specify a spatial locator for
merging points. By default, an instance of vtkMergePoints is used.
vtkIncrementalPointLocator = obj.GetLocator () - Specify a spatial locator for merging
points. By default, an instance of vtkMergePoints is used.
obj.SetSortBy (int ) - Set the sorting order for the generated polydata. There are two possibilities:
Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is
the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used
if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem
dependent. For most applications, the default order is fine (and faster).
Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses
with vtkPolyData output, verts and lines have lower cell ids than triangles.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.43 vtkCylinderSource
1143
int = obj.GetSortByMinValue () - Set the sorting order for the generated polydata. There are
two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are
processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order
should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is
very problem dependent. For most applications, the default order is fine (and faster).
Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses
with vtkPolyData output, verts and lines have lower cell ids than triangles.
int = obj.GetSortByMaxValue () - Set the sorting order for the generated polydata. There are
two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are
processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order
should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is
very problem dependent. For most applications, the default order is fine (and faster).
Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses
with vtkPolyData output, verts and lines have lower cell ids than triangles.
int = obj.GetSortBy () - Set the sorting order for the generated polydata. There are two
possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order
should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is
very problem dependent. For most applications, the default order is fine (and faster).
Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses
with vtkPolyData output, verts and lines have lower cell ids than triangles.
obj.SetSortByToSortByValue () - Set the sorting order for the generated polydata. There are two
possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed.
This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be
used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem
dependent. For most applications, the default order is fine (and faster).
Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses
with vtkPolyData output, verts and lines have lower cell ids than triangles.
obj.SetSortByToSortByCell () - Set the sorting order for the generated polydata. There are two
possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed.
This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be
used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem
dependent. For most applications, the default order is fine (and faster).
Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses
with vtkPolyData output, verts and lines have lower cell ids than triangles.
string = obj.GetSortByAsString () - Set the sorting order for the generated polydata. There
are two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are
processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order
should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is
very problem dependent. For most applications, the default order is fine (and faster).
Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses
with vtkPolyData output, verts and lines have lower cell ids than triangles.
obj.CreateDefaultLocator () - Create default locator. Used to create one when none is specified.
The locator is used to merge coincident points.
34.43
vtkCylinderSource
1144
34.43.1
Usage
vtkCylinderSource creates a polygonal cylinder centered at Center; The axis of the cylinder is aligned along the
global y-axis. The height and radius of the cylinder can be specified, as well as the number of sides. It is also
possible to control whether the cylinder is open-ended or capped.
To create an instance of class vtkCylinderSource, simply invoke its constructor as follows
obj = vtkCylinderSource
34.43.2
Methods
The class vtkCylinderSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkCylinderSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCylinderSource = obj.NewInstance ()
vtkCylinderSource = obj.SafeDownCast (vtkObject o)
obj.SetHeight (double ) - Set the height of the cylinder. Initial value is 1.
double = obj.GetHeightMinValue () - Set the height of the cylinder. Initial value is 1.
double = obj.GetHeightMaxValue () - Set the height of the cylinder. Initial value is 1.
double = obj.GetHeight () - Set the height of the cylinder. Initial value is 1.
obj.SetRadius (double ) - Set the radius of the cylinder. Initial value is 0.5
double = obj.GetRadiusMinValue () - Set the radius of the cylinder. Initial value is 0.5
double = obj.GetRadiusMaxValue () - Set the radius of the cylinder. Initial value is 0.5
double = obj.GetRadius () - Set the radius of the cylinder. Initial value is 0.5
obj.SetCenter (double , double , double ) - Set/Get cylinder center. Initial value is (0.0,0.0,0.0)
obj.SetCenter (double a[3]) - Set/Get cylinder center. Initial value is (0.0,0.0,0.0)
double = obj.
obj.SetResolution (int ) - Set the number of facets used to define cylinder. Initial value is 6.
int = obj.GetResolutionMinValue () - Set the number of facets used to define cylinder. Initial
value is 6.
int = obj.GetResolutionMaxValue () - Set the number of facets used to define cylinder. Initial
value is 6.
int = obj.GetResolution () - Set the number of facets used to define cylinder. Initial value is 6.
obj.SetCapping (int ) - Turn on/off whether to cap cylinder with polygons. Initial value is true.
int = obj.GetCapping () - Turn on/off whether to cap cylinder with polygons. Initial value is true.
obj.CappingOn () - Turn on/off whether to cap cylinder with polygons. Initial value is true.
obj.CappingOff () - Turn on/off whether to cap cylinder with polygons. Initial value is true.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.44 vtkDashedStreamLine
34.44
1145
vtkDashedStreamLine
34.44.1
Usage
vtkDashedStreamLine is a filter that generates a "dashed" streamline for an arbitrary dataset. The streamline
consists of a series of dashes, each of which represents (approximately) a constant time increment. Thus, in the
resulting visual representation, relatively long dashes represent areas of high velocity, and small dashes represent
areas of low velocity.
vtkDashedStreamLine introduces the instance variable DashFactor. DashFactor interacts with its superclass instance variable StepLength to create the dashes. DashFactor is the percentage of the StepLength line segment
that is visible. Thus, if the DashFactor=0.75, the dashes will be "three-quarters on" and "one-quarter off".
To create an instance of class vtkDashedStreamLine, simply invoke its constructor as follows
obj = vtkDashedStreamLine
34.44.2
Methods
The class vtkDashedStreamLine has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDashedStreamLine class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDashedStreamLine = obj.NewInstance ()
vtkDashedStreamLine = obj.SafeDownCast (vtkObject o)
obj.SetDashFactor (double ) - For each dash, specify the fraction of the dash that is "on". A factor
of 1.0 will result in a continuous line, a factor of 0.5 will result in dashed that are half on and half off.
double = obj.GetDashFactorMinValue () - For each dash, specify the fraction of the dash that
is "on". A factor of 1.0 will result in a continuous line, a factor of 0.5 will result in dashed that are half on and
half off.
double = obj.GetDashFactorMaxValue () - For each dash, specify the fraction of the dash that
is "on". A factor of 1.0 will result in a continuous line, a factor of 0.5 will result in dashed that are half on and
half off.
double = obj.GetDashFactor () - For each dash, specify the fraction of the dash that is "on". A
factor of 1.0 will result in a continuous line, a factor of 0.5 will result in dashed that are half on and half off.
34.45
vtkDataObjectGenerator
34.45.1
Usage
vtkDataObjectGenerator parses a string and produces dataobjects from the dataobject template names it sees
in the string. For example, if the string contains "ID1" the generator will create a vtkImageData. "UF1", "RG1",
"SG1", "PD1", and "UG1" will produce vtkUniformGrid, vtkRectilinearGrid, vtkStructuredGrid, vtkPolyData and vtkUnstructuredGrid respectively. "PD2" will produce an alternate vtkPolyData. You can compose composite datasets
from the atomic ones listed above by placing them within one of the two composite dataset identifiers
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1146
"MB{}" or "HB[ ]". "MB{ ID1 PD1 MB{} }" for example will create a vtkMultiBlockDataSet consisting of three
blocks: image data, poly data, multi-block (empty). Hierarchical Box data sets additionally require the notion
of groups, declared within "()" braces, to specify AMR depth. "HB[ (UF1)(UF1)(UF1) ]" will create a vtkHierarchicalBoxDataSet representing an octree that is three levels deep, in which the firstmost cell in each
level is refined.
To create an instance of class vtkDataObjectGenerator, simply invoke its constructor as follows
obj = vtkDataObjectGenerator
34.45.2
Methods
The class vtkDataObjectGenerator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataObjectGenerator
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataObjectGenerator = obj.NewInstance ()
vtkDataObjectGenerator = obj.SafeDownCast (vtkObject o)
obj.SetProgram (string ) - The string that will be parsed to specify a dataobject structure.
string = obj.GetProgram () - The string that will be parsed to specify a dataobject structure.
34.46
vtkDataObjectToDataSetFilter
34.46.1
Usage
vtkDataObjectToDataSetFilter is an class that maps a data object (i.e., a field) into a concrete dataset, i.e., gives
structure to the field by defining a geometry and topology.
To use this filter you associate components in the input field data with portions of the output dataset. (A component
is an array of values from the field.) For example, you would specify x-y-z points by assigning components from the
field for the x, then y, then z values of the points. You may also have to specify component ranges (for each z-y-z) to
make sure that the number of x, y, and z values is the same. Also, you may want to normalize the components which
helps distribute the data uniformly. Once youve setup the filter to combine all the pieces of data into a specified
dataset (the geometry, topology, point and cell data attributes), the various output methods (e.g., GetPolyData()) are
used to retrieve the final product.
This filter is often used in conjunction with vtkFieldDataToAttributeDataFilter. vtkFieldDataToAttributeDataFilter
takes field data and transforms it into attribute data (e.g., point and cell data attributes such as scalars and vectors).
To do this, use this filter which constructs a concrete dataset and passes the input data object field data to its output.
and then use vtkFieldDataToAttributeDataFilter to generate the attribute data associated with the dataset.
To create an instance of class vtkDataObjectToDataSetFilter, simply invoke its constructor as follows
obj = vtkDataObjectToDataSetFilter
34.46 vtkDataObjectToDataSetFilter
34.46.2
1147
Methods
The class vtkDataObjectToDataSetFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataObjectToDataSetFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataObjectToDataSetFilter = obj.NewInstance ()
vtkDataObjectToDataSetFilter = obj.SafeDownCast (vtkObject o)
vtkDataObject = obj.GetInput () - Get the input to the filter.
obj.SetDataSetType (int ) - Control what type of data is generated for output.
int = obj.GetDataSetType () - Control what type of data is generated for output.
obj.SetDataSetTypeToPolyData () - Control what type of data is generated for output.
obj.SetDataSetTypeToStructuredPoints () - Control what type of data is generated for output.
obj.SetDataSetTypeToStructuredGrid () - Control what type of data is generated for output.
obj.SetDataSetTypeToRectilinearGrid () - Control what type of data is generated for output.
obj.SetDataSetTypeToUnstructuredGrid () - Control what type of data is generated for output.
vtkDataSet = obj.GetOutput () - Get the output in different forms. The particular method invoked should be consistent with the SetDataSetType() method. (Note: GetOutput() will always return a type
consistent with SetDataSetType(). Also, GetOutput() will return NULL if the filter aborted due to inconsistent
data.)
vtkDataSet = obj.GetOutput (int idx) - Get the output in different forms. The particular
method invoked should be consistent with the SetDataSetType() method. (Note: GetOutput() will always
return a type consistent with SetDataSetType(). Also, GetOutput() will return NULL if the filter aborted due to
inconsistent data.)
vtkPolyData = obj.GetPolyDataOutput () - Get the output in different forms. The particular
method invoked should be consistent with the SetDataSetType() method. (Note: GetOutput() will always
return a type consistent with SetDataSetType(). Also, GetOutput() will return NULL if the filter aborted due to
inconsistent data.)
vtkStructuredPoints = obj.GetStructuredPointsOutput () - Get the output in different
forms. The particular method invoked should be consistent with the SetDataSetType() method. (Note: GetOutput() will always return a type consistent with SetDataSetType(). Also, GetOutput() will return NULL if the
filter aborted due to inconsistent data.)
vtkStructuredGrid = obj.GetStructuredGridOutput () - Get the output in different
forms. The particular method invoked should be consistent with the SetDataSetType() method. (Note:
GetOutput() will always return a type consistent with SetDataSetType(). Also, GetOutput() will return NULL if
the filter aborted due to inconsistent data.)
vtkUnstructuredGrid = obj.GetUnstructuredGridOutput () - Get the output in different
forms. The particular method invoked should be consistent with the SetDataSetType() method. (Note: GetOutput() will always return a type consistent with SetDataSetType(). Also, GetOutput() will return NULL if the
filter aborted due to inconsistent data.)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1148
34.46 vtkDataObjectToDataSetFilter
1149
in the component you wish to extract. (This method should be used for vtkPolyData, vtkUnstructuredGrid,
vtkStructuredGrid, and vtkRectilinearGrid.) A convenience method, SetPointComponent(),is also provided
which does not require setting the (min,max) component range or the normalize flag (normalize is set to
DefaulatNormalize value).
obj.SetVertsComponent (string arrayName, int arrayComp, int min, int
max) - Define cell connectivity when creating vtkPolyData. You can define vertices, lines, polygons,
and/or triangle strips via these methods. These methods are similar to those for defining points, except that
no normalization of the data is possible. Basically, you need to define an array of values that (for each cell)
includes the number of points per cell, and then the cell connectivity. (This is the vtk file format described in
in the textbook or Users Guide.)
obj.SetVertsComponent (string arrayName, int arrayComp) - Define cell connectivity
when creating vtkPolyData. You can define vertices, lines, polygons, and/or triangle strips via these methods.
These methods are similar to those for defining points, except that no normalization of the data is possible.
Basically, you need to define an array of values that (for each cell) includes the number of points per cell, and
then the cell connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
string = obj.GetVertsComponentArrayName () - Define cell connectivity when creating vtkPolyData. You can define vertices, lines, polygons, and/or triangle strips via these methods. These methods
are similar to those for defining points, except that no normalization of the data is possible. Basically, you
need to define an array of values that (for each cell) includes the number of points per cell, and then the cell
connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
int = obj.GetVertsComponentArrayComponent () - Define cell connectivity when creating
vtkPolyData. You can define vertices, lines, polygons, and/or triangle strips via these methods. These methods are similar to those for defining points, except that no normalization of the data is possible. Basically, you
need to define an array of values that (for each cell) includes the number of points per cell, and then the cell
connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
int = obj.GetVertsComponentMinRange () - Define cell connectivity when creating vtkPolyData. You can define vertices, lines, polygons, and/or triangle strips via these methods. These methods
are similar to those for defining points, except that no normalization of the data is possible. Basically, you
need to define an array of values that (for each cell) includes the number of points per cell, and then the cell
connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
int = obj.GetVertsComponentMaxRange () - Define cell connectivity when creating vtkPolyData. You can define vertices, lines, polygons, and/or triangle strips via these methods. These methods
are similar to those for defining points, except that no normalization of the data is possible. Basically, you
need to define an array of values that (for each cell) includes the number of points per cell, and then the cell
connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
obj.SetLinesComponent (string arrayName, int arrayComp, int min, int
max) - Define cell connectivity when creating vtkPolyData. You can define vertices, lines, polygons,
and/or triangle strips via these methods. These methods are similar to those for defining points, except that
no normalization of the data is possible. Basically, you need to define an array of values that (for each cell)
includes the number of points per cell, and then the cell connectivity. (This is the vtk file format described in
in the textbook or Users Guide.)
obj.SetLinesComponent (string arrayName, int arrayComp) - Define cell connectivity
when creating vtkPolyData. You can define vertices, lines, polygons, and/or triangle strips via these methods.
These methods are similar to those for defining points, except that no normalization of the data is possible.
Basically, you need to define an array of values that (for each cell) includes the number of points per cell, and
then the cell connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
string = obj.GetLinesComponentArrayName () - Define cell connectivity when creating vtkPolyData. You can define vertices, lines, polygons, and/or triangle strips via these methods. These methods
are similar to those for defining points, except that no normalization of the data is possible. Basically, you
need to define an array of values that (for each cell) includes the number of points per cell, and then the cell
connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1150
34.46 vtkDataObjectToDataSetFilter
1151
obj.SetStripsComponent (string arrayName, int arrayComp) - Define cell connectivity when creating vtkPolyData. You can define vertices, lines, polygons, and/or triangle strips via these methods. These methods are similar to those for defining points, except that no normalization of the data is
possible. Basically, you need to define an array of values that (for each cell) includes the number of points per
cell, and then the cell connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
string = obj.GetStripsComponentArrayName () - Define cell connectivity when creating vtkPolyData. You can define vertices, lines, polygons, and/or triangle strips via these methods. These methods
are similar to those for defining points, except that no normalization of the data is possible. Basically, you
need to define an array of values that (for each cell) includes the number of points per cell, and then the cell
connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
int = obj.GetStripsComponentArrayComponent () - Define cell connectivity when creating
vtkPolyData. You can define vertices, lines, polygons, and/or triangle strips via these methods. These methods are similar to those for defining points, except that no normalization of the data is possible. Basically, you
need to define an array of values that (for each cell) includes the number of points per cell, and then the cell
connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
int = obj.GetStripsComponentMinRange () - Define cell connectivity when creating vtkPolyData. You can define vertices, lines, polygons, and/or triangle strips via these methods. These methods
are similar to those for defining points, except that no normalization of the data is possible. Basically, you
need to define an array of values that (for each cell) includes the number of points per cell, and then the cell
connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
int = obj.GetStripsComponentMaxRange () - Define cell connectivity when creating vtkPolyData. You can define vertices, lines, polygons, and/or triangle strips via these methods. These methods
are similar to those for defining points, except that no normalization of the data is possible. Basically, you
need to define an array of values that (for each cell) includes the number of points per cell, and then the cell
connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
obj.SetCellTypeComponent (string arrayName, int arrayComp, int min, int
max) - Define cell types and cell connectivity when creating unstructured grid data. These methods are
similar to those for defining points, except that no normalization of the data is possible. Basically, you need
to define an array of cell types (an integer value per cell), and another array consisting (for each cell) of a
number of points per cell, and then the cell connectivity. (This is the vtk file format described in in the textbook
or Users Guide.)
obj.SetCellTypeComponent (string arrayName, int arrayComp) - Define cell types
and cell connectivity when creating unstructured grid data. These methods are similar to those for defining points, except that no normalization of the data is possible. Basically, you need to define an array of cell
types (an integer value per cell), and another array consisting (for each cell) of a number of points per cell,
and then the cell connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
string = obj.GetCellTypeComponentArrayName () - Define cell types and cell connectivity
when creating unstructured grid data. These methods are similar to those for defining points, except that no
normalization of the data is possible. Basically, you need to define an array of cell types (an integer value per
cell), and another array consisting (for each cell) of a number of points per cell, and then the cell connectivity.
(This is the vtk file format described in in the textbook or Users Guide.)
int = obj.GetCellTypeComponentArrayComponent () - Define cell types and cell connectivity when creating unstructured grid data. These methods are similar to those for defining points, except
that no normalization of the data is possible. Basically, you need to define an array of cell types (an integer
value per cell), and another array consisting (for each cell) of a number of points per cell, and then the cell
connectivity. (This is the vtk file format described in in the textbook or Users Guide.)
int = obj.GetCellTypeComponentMinRange () - Define cell types and cell connectivity when
creating unstructured grid data. These methods are similar to those for defining points, except that no normalization of the data is possible. Basically, you need to define an array of cell types (an integer value per
cell), and another array consisting (for each cell) of a number of points per cell, and then the cell connectivity.
(This is the vtk file format described in in the textbook or Users Guide.)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1152
GetDimensions ()
34.47 vtkDataSetEdgeSubdivisionCriterion
double = obj.
1153
GetOrigin ()
GetSpacing ()
int max)
obj.SetDimensionsComponent (string arrayName, int arrayComp)
obj.SetSpacingComponent (string arrayName, int arrayComp, int min, int
max)
obj.SetSpacingComponent (string arrayName, int arrayComp)
obj.SetOriginComponent (string arrayName, int arrayComp, int min, int
max)
obj.SetOriginComponent (string arrayName, int arrayComp)
34.47
vtkDataSetEdgeSubdivisionCriterion
34.47.1
Usage
This is a subclass of vtkEdgeSubdivisionCriterion that is used for tessellating cells of a vtkDataSet, particularly
nonlinear cells.
It provides functions for setting the current cell being tessellated and a convenience routine, EvaluateFields() to
evaluate field values at a point. You should call EvaluateFields() from inside EvaluateEdge() whenever the result
of EvaluateEdge() will be true. Otherwise, do not call EvaluateFields() as the midpoint is about to be discarded.
(Implementors note: This isnt true if UGLY_ASPECT_RATIO_HACK has been defined. But in that case, we dont
want the exact field values; we need the linearly interpolated ones at the midpoint for continuity.)
To create an instance of class vtkDataSetEdgeSubdivisionCriterion, simply invoke its constructor as follows
obj = vtkDataSetEdgeSubdivisionCriterion
34.47.2
Methods
The class vtkDataSetEdgeSubdivisionCriterion has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetEdgeSubdivisionCriterion class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetEdgeSubdivisionCriterion = obj.NewInstance ()
vtkDataSetEdgeSubdivisionCriterion = obj.SafeDownCast (vtkObject o)
obj.SetMesh (vtkDataSet )
vtkDataSet = obj.GetMesh ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1154
_start)
obj.EvaluatePointDataField (double result, double weights, int field) Evaluate either a cell or nodal field. This exists because of the funky way that Exodus data will be handled.
Sure, its a hack, but what are ya gonna do?
obj.EvaluateCellDataField (double result, double weights, int field)
Evaluate either a cell or nodal field. This exists because of the funky way that Exodus data will be handled. Sure, its a hack, but what are ya gonna do?
obj.SetChordError2 (double ) - Get/Set the square of the allowable chord error at any edges
midpoint. This value is used by EvaluateEdge.
double = obj.GetChordError2 () - Get/Set the square of the allowable chord error at any edges
midpoint. This value is used by EvaluateEdge.
obj.SetFieldError2 (int s, double err) - Get/Set the square of the allowable error magnitude for the scalar field s at any edges midpoint. A value less than or equal to 0 indicates that the field should
not be used as a criterion for subdivision.
double = obj.GetFieldError2 (int s) const - Get/Set the square of the allowable error
magnitude for the scalar field s at any edges midpoint. A value less than or equal to 0 indicates that the
field should not be used as a criterion for subdivision.
obj.ResetFieldError2 () - Tell the subdivider not to use any field values as subdivision criteria.
Effectively calls SetFieldError2( a, -1. ) for all fields.
int = obj.GetActiveFieldCriteria () - Return a bitfield specifying which FieldError2 criteria
are positive (i.e., actively used to decide edge subdivisions). This is stored as separate state to make subdivisions go faster.
int = obj.GetActiveFieldCriteria () const
34.48
vtkDataSetGradient
34.48.1
Usage
vtkDataSetGradient Computes per cell gradient of point scalar field or per point gradient of cell scalar field.
.SECTION Thanks This file is part of the generalized Youngs material interface reconstruction algorithm contributed
by CEA/DIF - Commissariat a lEnergie Atomique, Centre DAM Ile-De-France
BP12, F-91297 Arpajon, France.
Implementation by Thierry Carrard (CEA)
To create an instance of class vtkDataSetGradient, simply invoke its constructor as follows
obj = vtkDataSetGradient
34.49 vtkDataSetGradientPrecompute
34.48.2
1155
Methods
The class vtkDataSetGradient has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetGradient class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetGradient = obj.NewInstance ()
vtkDataSetGradient = obj.SafeDownCast (vtkObject o)
obj.SetResultArrayName (string ) - Set/Get the name of computed vector array.
string = obj.GetResultArrayName () - Set/Get the name of computed vector array.
34.49
vtkDataSetGradientPrecompute
34.49.1
Usage
Computes a geometry based vector field that the DataSetGradient filter uses to accelerate gradient computation.
This vector field is added to FieldData since it has a different value for each vertex of each cell (a vertex shared by
two cell has two differents values).
.SECTION Thanks This file is part of the generalized Youngs material interface reconstruction algorithm contributed
by CEA/DIF - Commissariat a lEnergie Atomique, Centre DAM Ile-De-France
BP12, F-91297 Arpajon, France.
Implementation by Thierry Carrard (CEA)
To create an instance of class vtkDataSetGradientPrecompute, simply invoke its constructor as follows
obj = vtkDataSetGradientPrecompute
34.49.2
Methods
The class vtkDataSetGradientPrecompute has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetGradientPrecompute class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetGradientPrecompute = obj.NewInstance ()
vtkDataSetGradientPrecompute = obj.SafeDownCast (vtkObject o)
34.50
vtkDataSetSurfaceFilter
1156
34.50.1
Usage
vtkDataSetSurfaceFilter is a faster version of vtkGeometry filter, but it does not have an option to select bounds. It
may use more memory than vtkGeometryFilter. It only has one option: whether to use triangle strips when the input
type is structured.
To create an instance of class vtkDataSetSurfaceFilter, simply invoke its constructor as follows
obj = vtkDataSetSurfaceFilter
34.50.2
Methods
The class vtkDataSetSurfaceFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetSurfaceFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetSurfaceFilter = obj.NewInstance ()
vtkDataSetSurfaceFilter = obj.SafeDownCast (vtkObject o)
obj.SetUseStrips (int ) - When input is structured data, this flag will generate faces with triangle
strips. This should render faster and use less memory, but no cell data is copied. By default, UseStrips is Off.
int = obj.GetUseStrips () - When input is structured data, this flag will generate faces with triangle strips. This should render faster and use less memory, but no cell data is copied. By default, UseStrips is
Off.
obj.UseStripsOn () - When input is structured data, this flag will generate faces with triangle strips.
This should render faster and use less memory, but no cell data is copied. By default, UseStrips is Off.
obj.UseStripsOff () - When input is structured data, this flag will generate faces with triangle strips.
This should render faster and use less memory, but no cell data is copied. By default, UseStrips is Off.
obj.SetPieceInvariant (int ) - If PieceInvariant is true, vtkDataSetSurfaceFilter requests 1
ghost level from input in order to remove internal surface that are between processes. False by default.
int = obj.GetPieceInvariant () - If PieceInvariant is true, vtkDataSetSurfaceFilter requests 1
ghost level from input in order to remove internal surface that are between processes. False by default.
obj.SetPassThroughCellIds (int ) - If on, the output polygonal dataset will have a celldata array
that holds the cell index of the original 3D cell that produced each output cell. This is useful for cell picking.
The default is off to conserve memory. Note that PassThroughCellIds will be ignored if UseStrips is on, since
in that case each tringle strip can represent more than on of the input cells.
int = obj.GetPassThroughCellIds () - If on, the output polygonal dataset will have a celldata
array that holds the cell index of the original 3D cell that produced each output cell. This is useful for cell
picking. The default is off to conserve memory. Note that PassThroughCellIds will be ignored if UseStrips is
on, since in that case each tringle strip can represent more than on of the input cells.
obj.PassThroughCellIdsOn () - If on, the output polygonal dataset will have a celldata array that
holds the cell index of the original 3D cell that produced each output cell. This is useful for cell picking. The
default is off to conserve memory. Note that PassThroughCellIds will be ignored if UseStrips is on, since in
that case each tringle strip can represent more than on of the input cells.
obj.PassThroughCellIdsOff () - If on, the output polygonal dataset will have a celldata array that
holds the cell index of the original 3D cell that produced each output cell. This is useful for cell picking. The
default is off to conserve memory. Note that PassThroughCellIds will be ignored if UseStrips is on, since in
that case each tringle strip can represent more than on of the input cells.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.51 vtkDataSetToDataObjectFilter
1157
obj.SetPassThroughPointIds (int ) - If on, the output polygonal dataset will have a celldata
array that holds the cell index of the original 3D cell that produced each output cell. This is useful for cell
picking. The default is off to conserve memory. Note that PassThroughCellIds will be ignored if UseStrips is
on, since in that case each tringle strip can represent more than on of the input cells.
int = obj.GetPassThroughPointIds () - If on, the output polygonal dataset will have a celldata
array that holds the cell index of the original 3D cell that produced each output cell. This is useful for cell
picking. The default is off to conserve memory. Note that PassThroughCellIds will be ignored if UseStrips is
on, since in that case each tringle strip can represent more than on of the input cells.
obj.PassThroughPointIdsOn () - If on, the output polygonal dataset will have a celldata array that
holds the cell index of the original 3D cell that produced each output cell. This is useful for cell picking. The
default is off to conserve memory. Note that PassThroughCellIds will be ignored if UseStrips is on, since in
that case each tringle strip can represent more than on of the input cells.
obj.PassThroughPointIdsOff () - If on, the output polygonal dataset will have a celldata array
that holds the cell index of the original 3D cell that produced each output cell. This is useful for cell picking.
The default is off to conserve memory. Note that PassThroughCellIds will be ignored if UseStrips is on, since
in that case each tringle strip can represent more than on of the input cells.
int = obj.StructuredExecute (vtkDataSet input, vtkPolyData output, int
ext32, int wholeExt32) - Direct access methods that can be used to use the this class as an
algorithm without using it as a filter.
int = obj.UnstructuredGridExecute (vtkDataSet input, vtkPolyData output)
- Direct access methods that can be used to use the this class as an algorithm without using it as a filter.
int = obj.DataSetExecute (vtkDataSet input, vtkPolyData output) - Direct access methods that can be used to use the this class as an algorithm without using it as a filter.
34.51
vtkDataSetToDataObjectFilter
34.51.1
Usage
vtkDataSetToDataObjectFilter is an class that transforms a dataset into data object (i.e., a field). The field will have
labeled data arrays corresponding to the topology, geometry, field data, and point and cell attribute data.
You can control what portions of the dataset are converted into the output data objects field data. The instance
variables Geometry, Topology, FieldData, PointData, and CellData are flags that control whether the datasets geometry (e.g., points, spacing, origin); topology (e.g., cell connectivity, dimensions); the field data associated with
the datasets superclass data object; the datasets point data attributes; and the datasets cell data attributes. (Note:
the data attributes include scalars, vectors, tensors, normals, texture coordinates, and field data.)
The names used to create the field data are as follows. For vtkPolyData, "Points", "Verts", "Lines", "Polys", and
"Strips". For vtkUnstructuredGrid, "Cells" and "CellTypes". For vtkStructuredPoints, "Dimensions", "Spacing", and
"Origin". For vtkStructuredGrid, "Points" and "Dimensions". For vtkRectilinearGrid, "XCoordinates", "YCoordinates",
and "ZCoordinates". for point attribute data, "PointScalars", "PointVectors", etc. For cell attribute data, "CellScalars",
"CellVectors", etc. Field data arrays retain their original name.
To create an instance of class vtkDataSetToDataObjectFilter, simply invoke its constructor as follows
obj = vtkDataSetToDataObjectFilter
34.51.2
Methods
The class vtkDataSetToDataObjectFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1158
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetToDataObjectFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetToDataObjectFilter = obj.NewInstance ()
vtkDataSetToDataObjectFilter = obj.SafeDownCast (vtkObject o)
obj.SetGeometry (int ) - Turn on/off the conversion of dataset geometry to a data object.
int = obj.GetGeometry () - Turn on/off the conversion of dataset geometry to a data object.
obj.GeometryOn () - Turn on/off the conversion of dataset geometry to a data object.
obj.GeometryOff () - Turn on/off the conversion of dataset geometry to a data object.
obj.SetTopology (int ) - Turn on/off the conversion of dataset topology to a data object.
int = obj.GetTopology () - Turn on/off the conversion of dataset topology to a data object.
obj.TopologyOn () - Turn on/off the conversion of dataset topology to a data object.
obj.TopologyOff () - Turn on/off the conversion of dataset topology to a data object.
obj.SetFieldData (int ) - Turn on/off the conversion of dataset field data to a data object.
int = obj.GetFieldData () - Turn on/off the conversion of dataset field data to a data object.
obj.FieldDataOn () - Turn on/off the conversion of dataset field data to a data object.
obj.FieldDataOff () - Turn on/off the conversion of dataset field data to a data object.
obj.SetPointData (int ) - Turn on/off the conversion of dataset point data to a data object.
int = obj.GetPointData () - Turn on/off the conversion of dataset point data to a data object.
obj.PointDataOn () - Turn on/off the conversion of dataset point data to a data object.
obj.PointDataOff () - Turn on/off the conversion of dataset point data to a data object.
obj.SetCellData (int ) - Turn on/off the conversion of dataset cell data to a data object.
int = obj.GetCellData () - Turn on/off the conversion of dataset cell data to a data object.
obj.CellDataOn () - Turn on/off the conversion of dataset cell data to a data object.
obj.CellDataOff () - Turn on/off the conversion of dataset cell data to a data object.
34.52
vtkDataSetTriangleFilter
34.52.1
Usage
vtkDataSetTriangleFilter generates n-dimensional simplices from any input dataset. That is, 3D cells are converted
to tetrahedral meshes, 2D cells to triangles, and so on. The triangulation is guaranteed to be compatible.
This filter uses simple 1D and 2D triangulation techniques for cells that are of topological dimension 2 or less. For
3D cellsdue to the issue of face compatibility across quadrilateral faces (which way to orient the diagonal?)a
fancier ordered Delaunay triangulation is used. This approach produces templates on the fly for triangulating the
cells. The templates are then used to do the actual triangulation.
To create an instance of class vtkDataSetTriangleFilter, simply invoke its constructor as follows
obj = vtkDataSetTriangleFilter
34.53 vtkDecimatePolylineFilter
34.52.2
1159
Methods
The class vtkDataSetTriangleFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataSetTriangleFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataSetTriangleFilter = obj.NewInstance ()
vtkDataSetTriangleFilter = obj.SafeDownCast (vtkObject o)
obj.SetTetrahedraOnly (int ) - When On this filter will cull all 1D and 2D cells from the output.
The default is Off.
int = obj.GetTetrahedraOnly () - When On this filter will cull all 1D and 2D cells from the output.
The default is Off.
obj.TetrahedraOnlyOn () - When On this filter will cull all 1D and 2D cells from the output. The
default is Off.
obj.TetrahedraOnlyOff () - When On this filter will cull all 1D and 2D cells from the output. The
default is Off.
34.53
vtkDecimatePolylineFilter
34.53.1
Usage
vtkDecimatePolylineFilter is a filter to reduce the number of lines in a polyline. The algorithm functions by evaluating
an error metric for each vertex (i.e., the distance of the vertex to a line defined from the two vertices on either side
of the vertex). Then, these vertices are placed into a priority queue, and those with larger errors are deleted first.
The decimation continues until the target reduction is reached.
To create an instance of class vtkDecimatePolylineFilter, simply invoke its constructor as follows
obj = vtkDecimatePolylineFilter
34.53.2
Methods
The class vtkDecimatePolylineFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDecimatePolylineFilter
class.
string = obj.GetClassName () - Standard methods for type information and printing.
int = obj.IsA (string name) - Standard methods for type information and printing.
vtkDecimatePolylineFilter = obj.NewInstance () - Standard methods for type information and printing.
vtkDecimatePolylineFilter = obj.SafeDownCast (vtkObject o) - Standard methods
for type information and printing.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1160
obj.SetTargetReduction (double ) - Specify the desired reduction in the total number of polygons (e.g., if TargetReduction is set to 0.9, this filter will try to reduce the data set to 10% of its original
size).
double = obj.GetTargetReductionMinValue () - Specify the desired reduction in the total
number of polygons (e.g., if TargetReduction is set to 0.9, this filter will try to reduce the data set to 10% of its
original size).
double = obj.GetTargetReductionMaxValue () - Specify the desired reduction in the total
number of polygons (e.g., if TargetReduction is set to 0.9, this filter will try to reduce the data set to 10% of its
original size).
double = obj.GetTargetReduction () - Specify the desired reduction in the total number of
polygons (e.g., if TargetReduction is set to 0.9, this filter will try to reduce the data set to 10% of its original size).
34.54
vtkDecimatePro
34.54.1
Usage
vtkDecimatePro is a filter to reduce the number of triangles in a triangle mesh, forming a good approximation to the
original geometry. The input to vtkDecimatePro is a vtkPolyData object, and only triangles are treated. If you desire
to decimate polygonal meshes, first triangulate the polygons with vtkTriangleFilter object.
The implementation of vtkDecimatePro is similar to the algorithm originally described in "Decimation of Triangle
Meshes", Proc Siggraph 92, with three major differences. First, this algorithm does not necessarily preserve the
topology of the mesh. Second, it is guaranteed to give the a mesh reduction factor specified by the user (as long as
certain constraints are not set - see Caveats). Third, it is set up generate progressive meshes, that is a stream of
operations that can be easily transmitted and incrementally updated (see Hugues Hoppes Siggraph 96 paper on
progressive meshes).
The algorithm proceeds as follows. Each vertex in the mesh is classified and inserted into a priority queue. The
priority is based on the error to delete the vertex and retriangulate the hole. Vertices that cannot be deleted or
triangulated (at this point in the algorithm) are skipped. Then, each vertex in the priority queue is processed (i.e.,
deleted followed by hole triangulation using edge collapse). This continues until the priority queue is empty. Next, all
remaining vertices are processed, and the mesh is split into separate pieces along sharp edges or at non-manifold
attachment points and reinserted into the priority queue. Again, the priority queue is processed until empty. If the
desired reduction is still not achieved, the remaining vertices are split as necessary (in a recursive fashion) so that
it is possible to eliminate every triangle as necessary.
To use this object, at a minimum you need to specify the ivar TargetReduction. The algorithm is guaranteed to
generate a reduced mesh at this level as long as the following four conditions are met: 1) topology modification
is allowed (i.e., the ivar PreserveTopology is off); 2) mesh splitting is enabled (i.e., the ivar Splitting is on); 3) the
algorithm is allowed to modify the boundary of the mesh (i.e., the ivar BoundaryVertexDeletion is on); and 4) the
maximum allowable error (i.e., the ivar MaximumError) is set to VTK_DOUBLE_MAX. Other important parameters
to adjust include the FeatureAngle and SplitAngle ivars, since these can impact the quality of the final mesh. Also,
you can set the ivar AccumulateError to force incremental error update and distribution to surrounding vertices as
each vertex is deleted. The accumulated error is a conservative global error bounds and decimation error, but
requires additional memory and time to compute.
To create an instance of class vtkDecimatePro, simply invoke its constructor as follows
obj = vtkDecimatePro
34.54 vtkDecimatePro
34.54.2
1161
Methods
The class vtkDecimatePro has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkDecimatePro class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDecimatePro = obj.NewInstance ()
vtkDecimatePro = obj.SafeDownCast (vtkObject o)
obj.SetTargetReduction (double ) - Specify the desired reduction in the total number of polygons (e.g., if TargetReduction is set to 0.9, this filter will try to reduce the data set to 10% of its original
size). Because of various constraints, this level of reduction may not be realized. If you want to guarantee
a particular reduction, you must turn off PreserveTopology, turn on SplitEdges and BoundaryVertexDeletion,
and set the MaximumError to VTK_DOUBLE_MAX (these ivars are initialized this way when the object is
instantiated).
double = obj.GetTargetReductionMinValue () - Specify the desired reduction in the total
number of polygons (e.g., if TargetReduction is set to 0.9, this filter will try to reduce the data set to 10%
of its original size). Because of various constraints, this level of reduction may not be realized. If you want
to guarantee a particular reduction, you must turn off PreserveTopology, turn on SplitEdges and BoundaryVertexDeletion, and set the MaximumError to VTK_DOUBLE_MAX (these ivars are initialized this way when
the object is instantiated).
double = obj.GetTargetReductionMaxValue () - Specify the desired reduction in the total
number of polygons (e.g., if TargetReduction is set to 0.9, this filter will try to reduce the data set to 10%
of its original size). Because of various constraints, this level of reduction may not be realized. If you want
to guarantee a particular reduction, you must turn off PreserveTopology, turn on SplitEdges and BoundaryVertexDeletion, and set the MaximumError to VTK_DOUBLE_MAX (these ivars are initialized this way when
the object is instantiated).
double = obj.GetTargetReduction () - Specify the desired reduction in the total number of
polygons (e.g., if TargetReduction is set to 0.9, this filter will try to reduce the data set to 10% of its original size). Because of various constraints, this level of reduction may not be realized. If you want to guarantee
a particular reduction, you must turn off PreserveTopology, turn on SplitEdges and BoundaryVertexDeletion,
and set the MaximumError to VTK_DOUBLE_MAX (these ivars are initialized this way when the object is
instantiated).
obj.SetPreserveTopology (int ) - Turn on/off whether to preserve the topology of the original
mesh. If on, mesh splitting and hole elimination will not occur. This may limit the maximum reduction that may
be achieved.
int = obj.GetPreserveTopology () - Turn on/off whether to preserve the topology of the original
mesh. If on, mesh splitting and hole elimination will not occur. This may limit the maximum reduction that may
be achieved.
obj.PreserveTopologyOn () - Turn on/off whether to preserve the topology of the original mesh. If
on, mesh splitting and hole elimination will not occur. This may limit the maximum reduction that may be
achieved.
obj.PreserveTopologyOff () - Turn on/off whether to preserve the topology of the original mesh.
If on, mesh splitting and hole elimination will not occur. This may limit the maximum reduction that may be
achieved.
obj.SetFeatureAngle (double ) - Specify the mesh feature angle. This angle is used to define
what an edge is (i.e., if the surface normal between two adjacent triangles is >= FeatureAngle, an edge
exists).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1162
34.54 vtkDecimatePro
1163
obj.SetMaximumError (double ) - Set the largest decimation error that is allowed during the decimation process. This may limit the maximum reduction that may be achieved. The maximum error is specified
as a fraction of the maximum length of the input data bounding box.
double = obj.GetMaximumErrorMinValue () - Set the largest decimation error that is allowed
during the decimation process. This may limit the maximum reduction that may be achieved. The maximum
error is specified as a fraction of the maximum length of the input data bounding box.
double = obj.GetMaximumErrorMaxValue () - Set the largest decimation error that is allowed
during the decimation process. This may limit the maximum reduction that may be achieved. The maximum
error is specified as a fraction of the maximum length of the input data bounding box.
double = obj.GetMaximumError () - Set the largest decimation error that is allowed during the
decimation process. This may limit the maximum reduction that may be achieved. The maximum error is
specified as a fraction of the maximum length of the input data bounding box.
obj.SetAccumulateError (int ) - The computed error can either be computed directly from the
mesh or the error may be accumulated as the mesh is modified. If the error is accumulated, then it represents
a global error bounds, and the ivar MaximumError becomes a global bounds on mesh error. Accumulating
the error requires extra memory proportional to the number of vertices in the mesh. If AccumulateError is off,
then the error is not accumulated.
int = obj.GetAccumulateError () - The computed error can either be computed directly from the
mesh or the error may be accumulated as the mesh is modified. If the error is accumulated, then it represents
a global error bounds, and the ivar MaximumError becomes a global bounds on mesh error. Accumulating
the error requires extra memory proportional to the number of vertices in the mesh. If AccumulateError is off,
then the error is not accumulated.
obj.AccumulateErrorOn () - The computed error can either be computed directly from the mesh or
the error may be accumulated as the mesh is modified. If the error is accumulated, then it represents a global
error bounds, and the ivar MaximumError becomes a global bounds on mesh error. Accumulating the error
requires extra memory proportional to the number of vertices in the mesh. If AccumulateError is off, then the
error is not accumulated.
obj.AccumulateErrorOff () - The computed error can either be computed directly from the mesh
or the error may be accumulated as the mesh is modified. If the error is accumulated, then it represents a
global error bounds, and the ivar MaximumError becomes a global bounds on mesh error. Accumulating the
error requires extra memory proportional to the number of vertices in the mesh. If AccumulateError is off,
then the error is not accumulated.
obj.SetErrorIsAbsolute (int ) - The MaximumError is normally defined as a fraction of the
dataset bounding diagonal. By setting ErrorIsAbsolute to 1, the error is instead defined as that specified
by AbsoluteError. By default ErrorIsAbsolute=0.
int = obj.GetErrorIsAbsolute () - The MaximumError is normally defined as a fraction of the
dataset bounding diagonal. By setting ErrorIsAbsolute to 1, the error is instead defined as that specified by
AbsoluteError. By default ErrorIsAbsolute=0.
obj.SetAbsoluteError (double ) - Same as MaximumError, but to be used when ErrorIsAbsolute
is 1
double = obj.GetAbsoluteErrorMinValue () - Same as MaximumError, but to be used when
ErrorIsAbsolute is 1
double = obj.GetAbsoluteErrorMaxValue () - Same as MaximumError, but to be used when
ErrorIsAbsolute is 1
double = obj.GetAbsoluteError () - Same as MaximumError, but to be used when ErrorIsAbsolute is 1
obj.SetBoundaryVertexDeletion (int ) - Turn on/off the deletion of vertices on the boundary
of a mesh. This may limit the maximum reduction that may be achieved.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1164
int = obj.GetBoundaryVertexDeletion () - Turn on/off the deletion of vertices on the boundary of a mesh. This may limit the maximum reduction that may be achieved.
obj.BoundaryVertexDeletionOn () - Turn on/off the deletion of vertices on the boundary of a
mesh. This may limit the maximum reduction that may be achieved.
obj.BoundaryVertexDeletionOff () - Turn on/off the deletion of vertices on the boundary of a
mesh. This may limit the maximum reduction that may be achieved.
obj.SetDegree (int ) - If the number of triangles connected to a vertex exceeds "Degree", then the
vertex will be split. (NOTE: the complexity of the triangulation algorithm is proportional to Degree 2. Setting
degree small can improve the performance of the algorithm.)
int = obj.GetDegreeMinValue () - If the number of triangles connected to a vertex exceeds "Degree", then the vertex will be split. (NOTE: the complexity of the triangulation algorithm is proportional to
Degree 2. Setting degree small can improve the performance of the algorithm.)
int = obj.GetDegreeMaxValue () - If the number of triangles connected to a vertex exceeds "Degree", then the vertex will be split. (NOTE: the complexity of the triangulation algorithm is proportional to
Degree 2. Setting degree small can improve the performance of the algorithm.)
int = obj.GetDegree () - If the number of triangles connected to a vertex exceeds "Degree", then
the vertex will be split. (NOTE: the complexity of the triangulation algorithm is proportional to Degree 2.
Setting degree small can improve the performance of the algorithm.)
obj.SetInflectionPointRatio (double ) - Specify the inflection point ratio. An inflection point
occurs when the ratio of reduction error between two iterations is greater than or equal to the InflectionPointRatio.
double = obj.GetInflectionPointRatioMinValue () - Specify the inflection point ratio. An
inflection point occurs when the ratio of reduction error between two iterations is greater than or equal to the
InflectionPointRatio.
double = obj.GetInflectionPointRatioMaxValue () - Specify the inflection point ratio. An
inflection point occurs when the ratio of reduction error between two iterations is greater than or equal to the
InflectionPointRatio.
double = obj.GetInflectionPointRatio () - Specify the inflection point ratio. An inflection
point occurs when the ratio of reduction error between two iterations is greater than or equal to the InflectionPointRatio.
vtkIdType = obj.GetNumberOfInflectionPoints () - Get the number of inflection points.
Only returns a valid value after the filter has executed. The values in the list are mesh reduction values
at each inflection point. Note: the first inflection point always occurs right before non-planar triangles are
decimated (i.e., as the error becomes non-zero).
obj.GetInflectionPoints (double inflectionPoints) - Get a list of inflection points.
These are double values 0 < r <= 1.0 corresponding to reduction level, and there are a total of NumberOfInflectionPoints() values. You must provide an array (of the correct size) into which the inflection points are
written.
34.55
vtkDelaunay2D
34.55.1
Usage
vtkDelaunay2D is a filter that constructs a 2D Delaunay triangulation from a list of input points. These points may
be represented by any dataset of type vtkPointSet and subclasses. The output of the filter is a polygonal dataset.
Usually the output is a triangle mesh, but if a non-zero alpha distance value is specified (called the "alpha" value),
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.55 vtkDelaunay2D
1165
then only triangles, edges, and vertices lying within the alpha radius are output. In other words, non-zero alpha
values may result in arbitrary combinations of triangles, lines, and vertices. (The notion of alpha value is derived
from Edelsbrunners work on "alpha shapes".) Also, it is possible to generate "constrained triangulations" using this
filter. A constrained triangulation is one where edges and loops (i.e., polygons) can be defined and the triangulation
will preserve them (read on for more information).
The 2D Delaunay triangulation is defined as the triangulation that satisfies the Delaunay criterion for n-dimensional
simplexes (in this case n=2 and the simplexes are triangles). This criterion states that a circumsphere of each
simplex in a triangulation contains only the n+1 defining points of the simplex. (See "The Visualization Toolkit" text
for more information.) In two dimensions, this translates into an optimal triangulation. That is, the maximum interior
angle of any triangle is less than or equal to that of any possible triangulation.
Delaunay triangulations are used to build topological structures from unorganized (or unstructured) points. The input
to this filter is a list of points specified in 3D, even though the triangulation is 2D. Thus the triangulation is constructed
in the x-y plane, and the z coordinate is ignored (although carried through to the output). If you desire to triangulate
in a different plane, you can use the vtkTransformFilter to transform the points into and out of the x-y plane or you can
specify a transform to the Delaunay2D directly. In the latter case, the input points are transformed, the transformed
points are triangulated, and the output will use the triangulated topology for the original (non-transformed) points.
This avoids transforming the data back as would be required when using the vtkTransformFilter method. Specifying
a transform directly also allows any transform to be used: rigid, non-rigid, non-invertible, etc.
If an input transform is used, then alpha values are applied (for the most part) in the original data space. The
exception is when BoundingTriangulation is on. In this case, alpha values are applied in the original data space
unless a cell uses a bounding vertex.
The Delaunay triangulation can be numerically sensitive in some cases. To prevent problems, try to avoid injecting
points that will result in triangles with bad aspect ratios (1000:1 or greater). In practice this means inserting points
that are "widely dispersed", and enables smooth transition of triangle sizes throughout the mesh. (You may even
want to add extra points to create a better point distribution.) If numerical problems are present, you will see a
warning message to this effect at the end of the triangulation process.
To create constrained meshes, you must define an additional input. This input is an instance of vtkPolyData which
contains lines, polylines, and/or polygons that define constrained edges and loops. Only the topology of (lines and
polygons) from this second input are used. The topology is assumed to reference points in the input point set (the
one to be triangulated). In other words, the lines and polygons use point ids from the first input point set. Lines
and polylines found in the input will be mesh edges in the output. Polygons define a loop with inside and outside
regions. The inside of the polygon is determined by using the right-hand-rule, i.e., looking down the z-axis a polygon
should be ordered counter-clockwise. Holes in a polygon should be ordered clockwise. If you choose to create a
constrained triangulation, the final mesh may not satisfy the Delaunay criterion. (Noted: the lines/polygon edges
must not intersect when projected onto the 2D plane. It may not be possible to recover all edges due to not enough
points in the triangulation, or poorly defined edges (coincident or excessively long). The form of the lines or polygons
is a list of point ids that correspond to the input point ids used to generate the triangulation.)
If an input transform is used, constraints are defined in the "transformed" space. So when the right hand rule is
used for a polygon constraint, that operation is applied using the transformed points. Since the input transform can
be any transformation (rigid or non-rigid), care must be taken in constructing constraints when an input transform is
used.
To create an instance of class vtkDelaunay2D, simply invoke its constructor as follows
obj = vtkDelaunay2D
34.55.2
Methods
The class vtkDelaunay2D has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkDelaunay2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDelaunay2D = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1166
34.56 vtkDelaunay3D
1167
34.56
vtkDelaunay3D
34.56.1
Usage
vtkDelaunay3D is a filter that constructs a 3D Delaunay triangulation from a list of input points. These points may
be represented by any dataset of type vtkPointSet and subclasses. The output of the filter is an unstructured grid
dataset. Usually the output is a tetrahedral mesh, but if a non-zero alpha distance value is specified (called the
"alpha" value), then only tetrahedra, triangles, edges, and vertices lying within the alpha radius are output. In other
words, non-zero alpha values may result in arbitrary combinations of tetrahedra, triangles, lines, and vertices. (The
notion of alpha value is derived from Edelsbrunners work on "alpha shapes".)
The 3D Delaunay triangulation is defined as the triangulation that satisfies the Delaunay criterion for n-dimensional
simplexes (in this case n=3 and the simplexes are tetrahedra). This criterion states that a circumsphere of each
simplex in a triangulation contains only the n+1 defining points of the simplex. (See text for more information.) While
in two dimensions this translates into an "optimal" triangulation, this is not true in 3D, since a measurement for
optimality in 3D is not agreed on.
Delaunay triangulations are used to build topological structures from unorganized (or unstructured) points. The
input to this filter is a list of points specified in 3D. (If you wish to create 2D triangulations see vtkDelaunay2D.) The
output is an unstructured grid.
The Delaunay triangulation can be numerically sensitive. To prevent problems, try to avoid injecting points that will
result in triangles with bad aspect ratios (1000:1 or greater). In practice this means inserting points that are "widely
dispersed", and enables smooth transition of triangle sizes throughout the mesh. (You may even want to add extra
points to create a better point distribution.) If numerical problems are present, you will see a warning message to
this effect at the end of the triangulation process.
To create an instance of class vtkDelaunay3D, simply invoke its constructor as follows
obj = vtkDelaunay3D
1168
34.56.2
Methods
The class vtkDelaunay3D has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkDelaunay3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDelaunay3D = obj.NewInstance ()
vtkDelaunay3D = obj.SafeDownCast (vtkObject o)
obj.SetAlpha (double ) - Specify alpha (or distance) value to control output of this filter. For a nonzero alpha value, only edges, faces, or tetra contained within the circumsphere (of radius alpha) will be output.
Otherwise, only tetrahedra will be output.
double = obj.GetAlphaMinValue () - Specify alpha (or distance) value to control output of this
filter. For a non-zero alpha value, only edges, faces, or tetra contained within the circumsphere (of radius
alpha) will be output. Otherwise, only tetrahedra will be output.
double = obj.GetAlphaMaxValue () - Specify alpha (or distance) value to control output of this
filter. For a non-zero alpha value, only edges, faces, or tetra contained within the circumsphere (of radius
alpha) will be output. Otherwise, only tetrahedra will be output.
double = obj.GetAlpha () - Specify alpha (or distance) value to control output of this filter. For a
non-zero alpha value, only edges, faces, or tetra contained within the circumsphere (of radius alpha) will be
output. Otherwise, only tetrahedra will be output.
obj.SetTolerance (double ) - Specify a tolerance to control discarding of closely spaced points.
This tolerance is specified as a fraction of the diagonal length of the bounding box of the points.
double = obj.GetToleranceMinValue () - Specify a tolerance to control discarding of closely
spaced points. This tolerance is specified as a fraction of the diagonal length of the bounding box of the
points.
double = obj.GetToleranceMaxValue () - Specify a tolerance to control discarding of closely
spaced points. This tolerance is specified as a fraction of the diagonal length of the bounding box of the
points.
double = obj.GetTolerance () - Specify a tolerance to control discarding of closely spaced points.
This tolerance is specified as a fraction of the diagonal length of the bounding box of the points.
obj.SetOffset (double ) - Specify a multiplier to control the size of the initial, bounding Delaunay
triangulation.
double = obj.GetOffsetMinValue () - Specify a multiplier to control the size of the initial, bounding Delaunay triangulation.
double = obj.GetOffsetMaxValue () - Specify a multiplier to control the size of the initial, bounding Delaunay triangulation.
double = obj.GetOffset () - Specify a multiplier to control the size of the initial, bounding Delaunay
triangulation.
obj.SetBoundingTriangulation (int ) - Boolean controls whether bounding triangulation
points (and associated triangles) are included in the output. (These are introduced as an initial triangulation
to begin the triangulation process. This feature is nice for debugging output.)
int = obj.GetBoundingTriangulation () - Boolean controls whether bounding triangulation
points (and associated triangles) are included in the output. (These are introduced as an initial triangulation
to begin the triangulation process. This feature is nice for debugging output.)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.57 vtkDensifyPolyData
1169
34.57
vtkDensifyPolyData
34.57.1
Usage
The filter takes any polygonal data as input and will tessellate cells that are planar polygons present by fanning out
triangles from its centroid. Other cells are simply passed through to the output. PointData, if present, is interpolated
via linear interpolation. CellData for any tessellated cell is simply copied over from its parent cell. Planar polygons
are assumed to be convex. Funny things will happen if they are not.
The number of subdivisions can be controlled by the parameter NumberOfSubdivisions.
To create an instance of class vtkDensifyPolyData, simply invoke its constructor as follows
obj = vtkDensifyPolyData
34.57.2
Methods
The class vtkDensifyPolyData has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkDensifyPolyData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDensifyPolyData = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1170
34.58
vtkDicer
34.58.1
Usage
Subclasses of vtkDicer divides the input dataset into separate pieces. These pieces can then be operated on by
other filters (e.g., vtkThreshold). One application is to break very large polygonal models into pieces and performing
viewing and occlusion culling on the pieces. Multiple pieces can also be streamed through the visualization pipeline.
To use this filter, you must specify the execution mode of the filter; i.e., set the way that the piece size is controlled
(do this by setting the DiceMode ivar). The filter does not change the geometry or topology of the input dataset,
rather it generates integer numbers that indicate which piece a particular point belongs to (i.e., it modifies the point
and cell attribute data). The integer number can be placed into the output scalar data, or the output field data.
To create an instance of class vtkDicer, simply invoke its constructor as follows
obj = vtkDicer
34.58.2
Methods
The class vtkDicer has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkDicer class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDicer = obj.NewInstance ()
vtkDicer = obj.SafeDownCast (vtkObject o)
obj.SetFieldData (int ) - Set/Get the flag which controls whether to generate point scalar data or
point field data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Note that the
generated the data are integer numbers indicating which piece a particular point belongs to.
int = obj.GetFieldData () - Set/Get the flag which controls whether to generate point scalar data
or point field data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Note that the
generated the data are integer numbers indicating which piece a particular point belongs to.
obj.FieldDataOn () - Set/Get the flag which controls whether to generate point scalar data or point
field data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Note that the
generated the data are integer numbers indicating which piece a particular point belongs to.
obj.FieldDataOff () - Set/Get the flag which controls whether to generate point scalar data or point
field data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Note that the
generated the data are integer numbers indicating which piece a particular point belongs to.
obj.SetDiceMode (int ) - Specify the method to determine how many pieces the data should be
broken into. By default, the number of points per piece is used.
int = obj.GetDiceModeMinValue () - Specify the method to determine how many pieces the
data should be broken into. By default, the number of points per piece is used.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.58 vtkDicer
1171
int = obj.GetDiceModeMaxValue () - Specify the method to determine how many pieces the
data should be broken into. By default, the number of points per piece is used.
int = obj.GetDiceMode () - Specify the method to determine how many pieces the data should be
broken into. By default, the number of points per piece is used.
obj.SetDiceModeToNumberOfPointsPerPiece () - Specify the method to determine how many
pieces the data should be broken into. By default, the number of points per piece is used.
obj.SetDiceModeToSpecifiedNumberOfPieces () - Specify the method to determine how
many pieces the data should be broken into. By default, the number of points per piece is used.
obj.SetDiceModeToMemoryLimitPerPiece () - Specify the method to determine how many
pieces the data should be broken into. By default, the number of points per piece is used.
int = obj.GetNumberOfActualPieces () - Use the following method after the filter has updated
to determine the actual number of pieces the data was separated into.
obj.SetNumberOfPointsPerPiece (int ) - Control piece size based on the maximum number
of points per piece. (This ivar has effect only when the DiceMode is set to SetDiceModeToNumberOfPoints().)
int = obj.GetNumberOfPointsPerPieceMinValue () - Control piece size based on the maximum number of points per piece. (This ivar has effect only when the DiceMode is set to SetDiceModeToNumberOfPoints().)
int = obj.GetNumberOfPointsPerPieceMaxValue () - Control piece size based on the maximum number of points per piece. (This ivar has effect only when the DiceMode is set to SetDiceModeToNumberOfPoints().)
int = obj.GetNumberOfPointsPerPiece () - Control piece size based on the maximum number of points per piece. (This ivar has effect only when the DiceMode is set to SetDiceModeToNumberOfPoints().)
obj.SetNumberOfPieces (int ) - Set/Get the number of pieces the object is to be separated into.
(This ivar has effect only when the DiceMode is set to SetDiceModeToSpecifiedNumber()). Note that the ivar
NumberOfPieces is a target - depending on the particulars of the data, more or less number of pieces than
the target value may be created.
int = obj.GetNumberOfPiecesMinValue () - Set/Get the number of pieces the object is to be
separated into. (This ivar has effect only when the DiceMode is set to SetDiceModeToSpecifiedNumber()).
Note that the ivar NumberOfPieces is a target - depending on the particulars of the data, more or less number
of pieces than the target value may be created.
int = obj.GetNumberOfPiecesMaxValue () - Set/Get the number of pieces the object is to be
separated into. (This ivar has effect only when the DiceMode is set to SetDiceModeToSpecifiedNumber()).
Note that the ivar NumberOfPieces is a target - depending on the particulars of the data, more or less number
of pieces than the target value may be created.
int = obj.GetNumberOfPieces () - Set/Get the number of pieces the object is to be separated
into. (This ivar has effect only when the DiceMode is set to SetDiceModeToSpecifiedNumber()). Note that the
ivar NumberOfPieces is a target - depending on the particulars of the data, more or less number of pieces
than the target value may be created.
obj.SetMemoryLimit (long ) - Control piece size based on a memory limit. (This ivar has effect
only when the DiceMode is set to SetDiceModeToMemoryLimit()). The memory limit should be set in kilobytes.
GetMemoryLimitMinValue = obj.() - Control piece size based on a memory limit. (This ivar has
effect only when the DiceMode is set to SetDiceModeToMemoryLimit()). The memory limit should be set in
kilobytes.
GetMemoryLimitMaxValue = obj.() - Control piece size based on a memory limit. (This ivar has
effect only when the DiceMode is set to SetDiceModeToMemoryLimit()). The memory limit should be set in
kilobytes.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1172
long = obj.GetMemoryLimit () - Control piece size based on a memory limit. (This ivar has effect only when the DiceMode is set to SetDiceModeToMemoryLimit()). The memory limit should be set in
kilobytes.
34.59
vtkDijkstraGraphGeodesicPath
34.59.1
Usage
Takes as input a polygonal mesh and performs a single source shortest path calculation. Dijkstras algorithm is
used. The implementation is similar to the one described in Introduction to Algorithms (Second Edition) by Thomas
H. Cormen, Charles E. Leiserson, Ronald L. Rivest, and Cliff Stein, published by MIT Press and McGraw-Hill.
Some minor enhancement are added though. All vertices are not pushed on the heap at start, instead a front set
is maintained. The heap is implemented as a binary heap. The output of the filter is a set of lines describing the
shortest path from StartVertex to EndVertex.
To create an instance of class vtkDijkstraGraphGeodesicPath, simply invoke its constructor as follows
obj = vtkDijkstraGraphGeodesicPath
34.59.2
Methods
The class vtkDijkstraGraphGeodesicPath has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDijkstraGraphGeodesicPath class.
string = obj.GetClassName () - Standard methids for printing and determining type information.
int = obj.IsA (string name) - Standard methids for printing and determining type information.
vtkDijkstraGraphGeodesicPath = obj.NewInstance () - Standard methids for printing
and determining type information.
vtkDijkstraGraphGeodesicPath = obj.SafeDownCast (vtkObject o) - Standard methids for printing and determining type information.
vtkIdList = obj.GetIdList () - The vertex ids (of the input polydata) on the shortest path
obj.SetStopWhenEndReached (int ) - Stop when the end vertex is reached or calculate shortest
path to all vertices
int = obj.GetStopWhenEndReached () - Stop when the end vertex is reached or calculate shortest path to all vertices
obj.StopWhenEndReachedOn () - Stop when the end vertex is reached or calculate shortest path to
all vertices
obj.StopWhenEndReachedOff () - Stop when the end vertex is reached or calculate shortest path
to all vertices
obj.SetUseScalarWeights (int ) - Use scalar values in the edge weight (experimental)
int = obj.GetUseScalarWeights () - Use scalar values in the edge weight (experimental)
obj.UseScalarWeightsOn () - Use scalar values in the edge weight (experimental)
obj.UseScalarWeightsOff () - Use scalar values in the edge weight (experimental)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.60 vtkDijkstraImageGeodesicPath
1173
obj.SetRepelPathFromVertices (int ) - Use the input point to repel the path by assigning high
costs.
int = obj.GetRepelPathFromVertices () - Use the input point to repel the path by assigning
high costs.
obj.RepelPathFromVerticesOn () - Use the input point to repel the path by assigning high costs.
obj.RepelPathFromVerticesOff () - Use the input point to repel the path by assigning high costs.
obj.SetRepelVertices (vtkPoints ) - Specify vtkPoints to use to repel the path from.
vtkPoints = obj.GetRepelVertices () - Specify vtkPoints to use to repel the path from.
double = obj.GetGeodesicLength ()
obj.GetCumulativeWeights (vtkDoubleArray weights)
34.60
vtkDijkstraImageGeodesicPath
34.60.1
Usage
Takes as input a polyline and an image representing a 2D cost function and performs a single source shortest
path calculation. Dijkstras algorithm is used. The implementation is similar to the one described in Introduction
to Algorithms (Second Edition) by Thomas H. Cormen, Charles E. Leiserson, Ronald L. Rivest, and Cliff Stein,
published by MIT Press and McGraw-Hill. Some minor enhancement are added though. All vertices are not pushed
on the heap at start, instead a front set is maintained. The heap is implemented as a binary heap. The output of
the filter is a set of lines describing the shortest path from StartVertex to EndVertex. See parent class vtkDijkstraGraphGeodesicPath for the implementation.
To create an instance of class vtkDijkstraImageGeodesicPath, simply invoke its constructor as follows
obj = vtkDijkstraImageGeodesicPath
34.60.2
Methods
The class vtkDijkstraImageGeodesicPath has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDijkstraImageGeodesicPath class.
string = obj.GetClassName () - Standard methids for printing and determining type information.
int = obj.IsA (string name) - Standard methids for printing and determining type information.
vtkDijkstraImageGeodesicPath = obj.NewInstance () - Standard methids for printing
and determining type information.
vtkDijkstraImageGeodesicPath = obj.SafeDownCast (vtkObject o) - Standard methids for printing and determining type information.
obj.SetInput (vtkDataObject ) - Specify the image object which is used as a cost function.
vtkImageData = obj.GetInputAsImageData () - Specify the image object which is used as a
cost function.
obj.SetImageWeight (double ) - Image cost weight.
double = obj.GetImageWeight () - Image cost weight.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1174
34.61
vtkDiscreteMarchingCubes
34.61.1
Usage
takes as input a volume (e.g., 3D structured point set) of segmentation labels and generates on output one or
more models representing the boundaries between the specified label and the adjacent structures. One or more
label values must be specified to generate the models. The boundary positions are always defined to be half-way
between adjacent voxels. This filter works best with integral scalar values. If ComputeScalars is on (the default),
each output cell will have cell data that corresponds to the scalar value (segmentation label) of the corresponding
cube. Note that this differs from vtkMarchingCubes, which stores the scalar value as point data. The rationale
for this difference is that cell vertices may be shared between multiple cells. This also means that the resultant
polydata may be non-manifold (cell faces may be coincident). To further process the polydata, users should either:
1) extract cells that have a common scalar value using vtkThreshold, or 2) process the data with filters that can
handle non-manifold polydata (e.g. vtkWindowedSincPolyDataFilter). Also note, Normals and Gradients are not
computed.
To create an instance of class vtkDiscreteMarchingCubes, simply invoke its constructor as follows
obj = vtkDiscreteMarchingCubes
34.61.2
Methods
The class vtkDiscreteMarchingCubes has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDiscreteMarchingCubes
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDiscreteMarchingCubes = obj.NewInstance ()
vtkDiscreteMarchingCubes = obj.SafeDownCast (vtkObject o)
34.62
vtkDiskSource
34.63 vtkEdgePoints
34.62.1
1175
Usage
vtkDiskSource creates a polygonal disk with a hole in the center. The disk has zero height. The user can specify
the inner and outer radius of the disk, and the radial and circumferential resolution of the polygonal representation.
To create an instance of class vtkDiskSource, simply invoke its constructor as follows
obj = vtkDiskSource
34.62.2
Methods
The class vtkDiskSource has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkDiskSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDiskSource = obj.NewInstance ()
vtkDiskSource = obj.SafeDownCast (vtkObject o)
obj.SetInnerRadius (double ) - Specify inner radius of hole in disc.
double = obj.GetInnerRadiusMinValue () - Specify inner radius of hole in disc.
double = obj.GetInnerRadiusMaxValue () - Specify inner radius of hole in disc.
double = obj.GetInnerRadius () - Specify inner radius of hole in disc.
obj.SetOuterRadius (double ) - Specify outer radius of disc.
double = obj.GetOuterRadiusMinValue () - Specify outer radius of disc.
double = obj.GetOuterRadiusMaxValue () - Specify outer radius of disc.
double = obj.GetOuterRadius () - Specify outer radius of disc.
obj.SetRadialResolution (int ) - Set the number of points in radius direction.
int = obj.GetRadialResolutionMinValue () - Set the number of points in radius direction.
int = obj.GetRadialResolutionMaxValue () - Set the number of points in radius direction.
int = obj.GetRadialResolution () - Set the number of points in radius direction.
obj.SetCircumferentialResolution (int ) - Set the number of points in circumferential direction.
int = obj.GetCircumferentialResolutionMinValue () - Set the number of points in circumferential direction.
int = obj.GetCircumferentialResolutionMaxValue () - Set the number of points in circumferential direction.
int = obj.GetCircumferentialResolution () - Set the number of points in circumferential
direction.
34.63
vtkEdgePoints
1176
34.63.1
Usage
vtkEdgePoints is a filter that takes as input any dataset and generates for output a set of points that lie on an
isosurface. The points are created by interpolation along cells edges whose end-points are below and above the
contour value.
To create an instance of class vtkEdgePoints, simply invoke its constructor as follows
obj = vtkEdgePoints
34.63.2
Methods
The class vtkEdgePoints has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkEdgePoints class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkEdgePoints = obj.NewInstance ()
vtkEdgePoints = obj.SafeDownCast (vtkObject o)
obj.SetValue (double ) - Set/get the contour value.
double = obj.GetValue () - Set/get the contour value.
34.64
vtkEdgeSubdivisionCriterion
34.64.1
Usage
Descendants of this abstract class are used to decide whether a piecewise linear approximation (triangles, lines, ...
) to some nonlinear geometry should be subdivided. This decision may be based on an absolute error metric (chord
error) or on some view-dependent metric (chord error compared to device resolution) or on some abstract metric
(color error). Or anything else, really. Just so long as you implement the EvaluateEdge member, all will be well.
To create an instance of class vtkEdgeSubdivisionCriterion, simply invoke its constructor as follows
obj = vtkEdgeSubdivisionCriterion
34.64.2
Methods
The class vtkEdgeSubdivisionCriterion has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkEdgeSubdivisionCriterion
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkEdgeSubdivisionCriterion = obj.NewInstance ()
vtkEdgeSubdivisionCriterion = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.65 vtkElevationFilter
1177
bool = obj.EvaluateEdge (double p0, double p1, double p2, int field_start) - You must implement this member function in a subclass. It will be called by vtkStreamingTessellator for each edge in each primitive that vtkStreamingTessellator generates.
int = obj.PassField (int sourceId, int sourceSize, vtkStreamingTessellator
t) - This is a helper routine called by PassFields() which you may also call directly; it adds sourceSize to
the size of the output vertex field values. The offset of the sourceId field in the output vertex array is returned.
-1 is returned if sourceSize would force the output to have more than vtkStreamingTessellator::MaxFieldSize
field values per vertex.
obj.ResetFieldList () - Dont pass any field values in the vertex pointer. This is used to reset the
list of fields to pass after a successful run of vtkStreamingTessellator.
bool = obj.DontPassField (int sourceId, vtkStreamingTessellator t) - This
does the opposite of PassField(); it removes a field from the output (assuming the field was set to be
passed). Returns true if any action was taken, false otherwise.
int = obj.GetOutputField (int fieldId) const - Return the output ID of an input field.
Returns -1 if fieldId is not set to be passed to the output.
int = obj.GetNumberOfFields () const - Return the number of fields being evaluated at each
output vertex. This is the length of the arrays returned by GetFieldIds() and GetFieldOffsets().
34.65
vtkElevationFilter
34.65.1
Usage
vtkElevationFilter is a filter to generate scalar values from a dataset. The scalar values lie within a user specified
range, and are generated by computing a projection of each dataset point onto a line. The line can be oriented
arbitrarily. A typical example is to generate scalars based on elevation or height above a plane.
To create an instance of class vtkElevationFilter, simply invoke its constructor as follows
obj = vtkElevationFilter
34.65.2
Methods
The class vtkElevationFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkElevationFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkElevationFilter = obj.NewInstance ()
vtkElevationFilter = obj.SafeDownCast (vtkObject o)
obj.SetLowPoint (double , double , double ) - Define one end of the line (small scalar
values). Default is (0,0,0).
obj.SetLowPoint (double a[3]) - Define one end of the line (small scalar values). Default is
(0,0,0).
double = obj.
(0,0,0).
GetLowPoint () - Define one end of the line (small scalar values). Default is
1178
obj.SetHighPoint (double , double , double ) - Define other end of the line (large scalar
values). Default is (0,0,1).
obj.SetHighPoint (double a[3]) - Define other end of the line (large scalar values). Default is
(0,0,1).
double = obj.
(0,0,1).
GetHighPoint () - Define other end of the line (large scalar values). Default is
obj.SetScalarRange (double , double ) - Specify range to map scalars into. Default is [0, 1].
obj.SetScalarRange (double a[2]) - Specify range to map scalars into. Default is [0, 1].
double = obj.
34.66
vtkEllipticalButtonSource
34.66.1
Usage
vtkEllipticalButtonSource creates a ellipsoidal shaped button with texture coordinates suitable for application of a
texture map. This provides a way to make nice looking 3D buttons. The buttons are represented as vtkPolyData
that includes texture coordinates and normals. The button lies in the x-y plane.
To use this class you must define the major and minor axes lengths of an ellipsoid (expressed as width (x), height (y)
and depth (z)). The button has a rectangular mesh region in the center with texture coordinates that range smoothly
from (0,1). (This flat region is called the texture region.) The outer, curved portion of the button (called the shoulder)
has texture coordinates set to a user specified value (by default (0,0). (This results in coloring the button curve the
same color as the (s,t) location of the texture map.) The resolution in the radial direction, the texture region, and the
shoulder region must also be set. The button can be moved by specifying an origin.
To create an instance of class vtkEllipticalButtonSource, simply invoke its constructor as follows
obj = vtkEllipticalButtonSource
34.66.2
Methods
The class vtkEllipticalButtonSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkEllipticalButtonSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkEllipticalButtonSource = obj.NewInstance ()
vtkEllipticalButtonSource = obj.SafeDownCast (vtkObject o)
obj.SetWidth (double ) - Set/Get the width of the button (the x-ellipsoid axis length 2).
double = obj.GetWidthMinValue () - Set/Get the width of the button (the x-ellipsoid axis length
2).
double = obj.GetWidthMaxValue () - Set/Get the width of the button (the x-ellipsoid axis length
2).
double = obj.GetWidth () - Set/Get the width of the button (the x-ellipsoid axis length 2).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.66 vtkEllipticalButtonSource
1179
obj.SetHeight (double ) - Set/Get the height of the button (the y-ellipsoid axis length 2).
double = obj.GetHeightMinValue () - Set/Get the height of the button (the y-ellipsoid axis
length 2).
double = obj.GetHeightMaxValue () - Set/Get the height of the button (the y-ellipsoid axis
length 2).
double = obj.GetHeight () - Set/Get the height of the button (the y-ellipsoid axis length 2).
obj.SetDepth (double ) - Set/Get the depth of the button (the z-eliipsoid axis length).
double = obj.GetDepthMinValue () - Set/Get the depth of the button (the z-eliipsoid axis length).
double = obj.GetDepthMaxValue () - Set/Get the depth of the button (the z-eliipsoid axis length).
double = obj.GetDepth () - Set/Get the depth of the button (the z-eliipsoid axis length).
obj.SetCircumferentialResolution (int ) - Specify the resolution of the button in the circumferential direction.
int = obj.GetCircumferentialResolutionMinValue () - Specify the resolution of the button in the circumferential direction.
int = obj.GetCircumferentialResolutionMaxValue () - Specify the resolution of the button in the circumferential direction.
int = obj.GetCircumferentialResolution () - Specify the resolution of the button in the
circumferential direction.
obj.SetTextureResolution (int ) - Specify the resolution of the texture in the radial direction in
the texture region.
int = obj.GetTextureResolutionMinValue () - Specify the resolution of the texture in the
radial direction in the texture region.
int = obj.GetTextureResolutionMaxValue () - Specify the resolution of the texture in the
radial direction in the texture region.
int = obj.GetTextureResolution () - Specify the resolution of the texture in the radial direction
in the texture region.
obj.SetShoulderResolution (int ) - Specify the resolution of the texture in the radial direction
in the shoulder region.
int = obj.GetShoulderResolutionMinValue () - Specify the resolution of the texture in the
radial direction in the shoulder region.
int = obj.GetShoulderResolutionMaxValue () - Specify the resolution of the texture in the
radial direction in the shoulder region.
int = obj.GetShoulderResolution () - Specify the resolution of the texture in the radial direction in the shoulder region.
obj.SetRadialRatio (double ) - Set/Get the radial ratio. This is the measure of the radius of the
outer ellipsoid to the inner ellipsoid of the button. The outer ellipsoid is the boundary of the button defined
by the height and width. The inner ellipsoid circumscribes the texture region. Larger RadialRatios cause
the button to be more rounded (and the texture region to be smaller); smaller ratios produce sharply curved
shoulders with a larger texture region.
double = obj.GetRadialRatioMinValue () - Set/Get the radial ratio. This is the measure of
the radius of the outer ellipsoid to the inner ellipsoid of the button. The outer ellipsoid is the boundary of the
button defined by the height and width. The inner ellipsoid circumscribes the texture region. Larger RadialRatios cause the button to be more rounded (and the texture region to be smaller); smaller ratios produce
sharply curved shoulders with a larger texture region.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1180
34.67
vtkExtractArraysOverTime
34.67.1
Usage
vtkExtractArraysOverTime extracts a selection over time. The output is a multiblock dataset. If selection content
type is vtkSelection::Locations, then each output block corresponds to each probed location. Otherwise, each output
block corresponds to an extracted cell/point depending on whether the selection field type is CELL or POINT. Each
block is a vtkTable with a column named Time (or TimeData if Time exists in the input). When extracting point data,
the input point coordinates are copied to a column named Point Coordinates or Points (if Point Coordinates exists in
the input). This algorithm does not produce a TIME_STEPS or TIME_RANGE information because it works across
time. .Section Caveat This algorithm works only with source that produce TIME_STEPS(). Continuous time range
is not yet supported.
To create an instance of class vtkExtractArraysOverTime, simply invoke its constructor as follows
obj = vtkExtractArraysOverTime
34.67.2
Methods
The class vtkExtractArraysOverTime has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractArraysOverTime
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractArraysOverTime = obj.NewInstance ()
vtkExtractArraysOverTime = obj.SafeDownCast (vtkObject o)
int = obj.GetNumberOfTimeSteps () - Get the number of time steps
obj.SetSelectionConnection (vtkAlgorithmOutput algOutput)
34.68
vtkExtractBlock
34.68 vtkExtractBlock
34.68.1
1181
Usage
vtkExtractBlock is a filter that extracts blocks from a multiblock dataset. Each node in the multi-block tree is identified
by an index. The index can be obtained by performing a preorder traversal of the tree (including empty nodes).
eg. A(B (D, E), C(F, G)). Inorder traversal yields: A, B, D, E, C, F, G Index of A is 0, while index of C is 4.
To create an instance of class vtkExtractBlock, simply invoke its constructor as follows
obj = vtkExtractBlock
34.68.2
Methods
The class vtkExtractBlock has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkExtractBlock class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractBlock = obj.NewInstance ()
vtkExtractBlock = obj.SafeDownCast (vtkObject o)
obj.AddIndex (int index) - Select the block indices to extract. Each node in the multi-block tree is
identified by an index. The index can be obtained by performing a preorder traversal of the tree (including
empty nodes). eg. A(B (D, E), C(F, G)). Inorder traversal yields: A, B, D, E, C, F, G Index of A is 0, while index
of C is 4.
obj.RemoveIndex (int index) - Select the block indices to extract. Each node in the multi-block
tree is identified by an index. The index can be obtained by performing a preorder traversal of the tree
(including empty nodes). eg. A(B (D, E), C(F, G)). Inorder traversal yields: A, B, D, E, C, F, G Index of A is 0,
while index of C is 4.
obj.RemoveAllIndices () - Select the block indices to extract. Each node in the multi-block tree is
identified by an index. The index can be obtained by performing a preorder traversal of the tree (including
empty nodes). eg. A(B (D, E), C(F, G)). Inorder traversal yields: A, B, D, E, C, F, G Index of A is 0, while index
of C is 4.
obj.SetPruneOutput (int ) - When set, the output mutliblock dataset will be pruned to remove
empty nodes. On by default.
int = obj.GetPruneOutput () - When set, the output mutliblock dataset will be pruned to remove
empty nodes. On by default.
obj.PruneOutputOn () - When set, the output mutliblock dataset will be pruned to remove empty
nodes. On by default.
obj.PruneOutputOff () - When set, the output mutliblock dataset will be pruned to remove empty
nodes. On by default.
obj.SetMaintainStructure (int ) - This is used only when PruneOutput is ON. By default, when
pruning the output i.e. remove empty blocks, if node has only 1 non-null child block, then that node is removed.
To preserve these parent nodes, set this flag to true. Off by default.
int = obj.GetMaintainStructure () - This is used only when PruneOutput is ON. By default,
when pruning the output i.e. remove empty blocks, if node has only 1 non-null child block, then that node is
removed. To preserve these parent nodes, set this flag to true. Off by default.
obj.MaintainStructureOn () - This is used only when PruneOutput is ON. By default, when pruning
the output i.e. remove empty blocks, if node has only 1 non-null child block, then that node is removed. To
preserve these parent nodes, set this flag to true. Off by default.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1182
obj.MaintainStructureOff () - This is used only when PruneOutput is ON. By default, when pruning the output i.e. remove empty blocks, if node has only 1 non-null child block, then that node is removed.
To preserve these parent nodes, set this flag to true. Off by default.
34.69
vtkExtractCells
34.69.1
Usage
Given a vtkDataSet and a list of cell Ids, create a vtkUnstructuredGrid composed of these cells. If the cell list is
empty when vtkExtractCells executes, it will set up the ugrid, point and cell arrays, with no points, cells or data.
To create an instance of class vtkExtractCells, simply invoke its constructor as follows
obj = vtkExtractCells
34.69.2
Methods
The class vtkExtractCells has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkExtractCells class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractCells = obj.NewInstance ()
vtkExtractCells = obj.SafeDownCast (vtkObject o)
obj.SetCellList (vtkIdList l)
obj.AddCellList (vtkIdList l)
obj.AddCellRange (vtkIdType from, vtkIdType to)
34.70
vtkExtractDataOverTime
34.70.1
Usage
This filter extracts the point data from a time sequence and specified index and creates an output of the same type
as the input but with Points containing "number of time steps" points; the point and PointData corresponding to the
PointIndex are extracted at each time step and added to the output. A PointData array is added called "Time" (or
"TimeData" if there is already an array called "Time"), which is the time at each index.
To create an instance of class vtkExtractDataOverTime, simply invoke its constructor as follows
obj = vtkExtractDataOverTime
34.71 vtkExtractDataSets
34.70.2
1183
Methods
The class vtkExtractDataOverTime has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractDataOverTime
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractDataOverTime = obj.NewInstance ()
vtkExtractDataOverTime = obj.SafeDownCast (vtkObject o)
obj.SetPointIndex (int ) - Index of point to extract at each time step
int = obj.GetPointIndex () - Index of point to extract at each time step
int = obj.GetNumberOfTimeSteps () - Get the number of time steps
34.71
vtkExtractDataSets
34.71.1
Usage
vtkExtractDataSets accepts a vtkHierarchicalBoxDataSet as input and extracts different datasets from different levels. The output is vtkHierarchicalBoxDataSet with same structure as the input with only the selected datasets
passed through.
To create an instance of class vtkExtractDataSets, simply invoke its constructor as follows
obj = vtkExtractDataSets
34.71.2
Methods
The class vtkExtractDataSets has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractDataSets class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractDataSets = obj.NewInstance ()
vtkExtractDataSets = obj.SafeDownCast (vtkObject o)
obj.AddDataSet (int level, int idx) - Add a dataset to be extracted.
obj.ClearDataSetList () - Remove all entries from the list of datasets to be extracted.
34.72
vtkExtractEdges
1184
34.72.1
Usage
vtkExtractEdges is a filter to extract edges from a dataset. Edges are extracted as lines or polylines.
To create an instance of class vtkExtractEdges, simply invoke its constructor as follows
obj = vtkExtractEdges
34.72.2
Methods
The class vtkExtractEdges has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkExtractEdges class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractEdges = obj.NewInstance ()
vtkExtractEdges = obj.SafeDownCast (vtkObject o)
obj.SetLocator (vtkIncrementalPointLocator locator) - Set / get a spatial locator for
merging points. By default an instance of vtkMergePoints is used.
vtkIncrementalPointLocator = obj.GetLocator () - Set / get a spatial locator for merging
points. By default an instance of vtkMergePoints is used.
obj.CreateDefaultLocator () - Create default locator. Used to create one when none is specified.
long = obj.GetMTime () - Return MTime also considering the locator.
34.73
vtkExtractGeometry
34.73.1
Usage
vtkExtractGeometry extracts from its input dataset all cells that are either completely inside or outside of a specified
implicit function. Any type of dataset can be input to this filter. On output the filter generates an unstructured grid.
To use this filter you must specify an implicit function. You must also specify whethter to extract cells lying inside or
outside of the implicit function. (The inside of an implicit function is the negative values region.) An option exists to
extract cells that are neither inside or outside (i.e., boundary).
A more efficient version of this filter is available for vtkPolyData input. See vtkExtractPolyDataGeometry.
To create an instance of class vtkExtractGeometry, simply invoke its constructor as follows
obj = vtkExtractGeometry
34.73.2
Methods
The class vtkExtractGeometry has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractGeometry class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.74 vtkExtractGrid
1185
34.74
vtkExtractGrid
34.74.1
Usage
vtkExtractGrid is a filter that selects a portion of an input structured grid dataset, or subsamples an input dataset.
(The selected portion of interested is referred to as the Volume Of Interest, or VOI.) The output of this filter is a
structured grid dataset. The filter treats input data of any topological dimension (i.e., point, line, image, or volume)
and can generate output data of any topological dimension.
To use this filter set the VOI ivar which are i-j-k min/max indices that specify a rectangular region in the data. (Note
that these are 0-offset.) You can also specify a sampling rate to subsample the data.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1186
Typical applications of this filter are to extract a plane from a grid for contouring, subsampling large grids to reduce
data size, or extracting regions of a grid with interesting data.
To create an instance of class vtkExtractGrid, simply invoke its constructor as follows
obj = vtkExtractGrid
34.74.2
Methods
The class vtkExtractGrid has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkExtractGrid class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractGrid = obj.NewInstance ()
vtkExtractGrid = obj.SafeDownCast (vtkObject o)
obj.SetVOI (int , int , int , int , int , int ) - Specify i-j-k (min,max) pairs to extract. The resulting structured grid dataset can be of any topological dimension (i.e., point, line, plane, or 3D
grid).
obj.SetVOI (int a[6]) - Specify i-j-k (min,max) pairs to extract. The resulting structured grid dataset
can be of any topological dimension (i.e., point, line, plane, or 3D grid).
int = obj. GetVOI () - Specify i-j-k (min,max) pairs to extract. The resulting structured grid dataset
can be of any topological dimension (i.e., point, line, plane, or 3D grid).
obj.SetSampleRate (int , int , int ) - Set the sampling rate in the i, j, and k directions. If
the rate is > 1, then the resulting VOI will be subsampled representation of the input. For example, if the
SampleRate=(2,2,2), every other point will be selected, resulting in a volume 1/8th the original size.
obj.SetSampleRate (int a[3]) - Set the sampling rate in the i, j, and k directions. If the rate is > 1,
then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2),
every other point will be selected, resulting in a volume 1/8th the original size.
int = obj. GetSampleRate () - Set the sampling rate in the i, j, and k directions. If the rate is > 1,
then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2),
every other point will be selected, resulting in a volume 1/8th the original size.
obj.SetIncludeBoundary (int ) - Control whether to enforce that the "boundary" of the grid is
output in the subsampling process. (This ivar only has effect when the SampleRate in any direction is not
equal to 1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the
grid even though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary
is off.)
int = obj.GetIncludeBoundary () - Control whether to enforce that the "boundary" of the grid is
output in the subsampling process. (This ivar only has effect when the SampleRate in any direction is not
equal to 1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the
grid even though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary
is off.)
obj.IncludeBoundaryOn () - Control whether to enforce that the "boundary" of the grid is output in
the subsampling process. (This ivar only has effect when the SampleRate in any direction is not equal to
1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the grid even
though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary is off.)
obj.IncludeBoundaryOff () - Control whether to enforce that the "boundary" of the grid is output
in the subsampling process. (This ivar only has effect when the SampleRate in any direction is not equal to
1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the grid even
though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary is off.)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.75 vtkExtractLevel
34.75
1187
vtkExtractLevel
34.75.1
Usage
vtkExtractLevel filter extracts the levels between (and including) the user specified min and max levels.
To create an instance of class vtkExtractLevel, simply invoke its constructor as follows
obj = vtkExtractLevel
34.75.2
Methods
The class vtkExtractLevel has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkExtractLevel class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractLevel = obj.NewInstance ()
vtkExtractLevel = obj.SafeDownCast (vtkObject o)
obj.AddLevel (int level) - Select the levels that should be extracted. All other levels will have no
datasets in them.
obj.RemoveLevel (int level) - Select the levels that should be extracted. All other levels will have
no datasets in them.
obj.RemoveAllLevels () - Select the levels that should be extracted. All other levels will have no
datasets in them.
34.76
vtkExtractPolyDataGeometry
34.76.1
Usage
vtkExtractPolyDataGeometry extracts from its input vtkPolyData all cells that are either completely inside or outside
of a specified implicit function. This filter is specialized to vtkPolyData. On output the filter generates vtkPolyData.
To use this filter you must specify an implicit function. You must also specify whether to extract cells lying inside or
outside of the implicit function. (The inside of an implicit function is the negative values region.) An option exists to
extract cells that are neither inside nor outside (i.e., boundary).
A more general version of this filter is available for arbitrary vtkDataSet input (see vtkExtractGeometry).
To create an instance of class vtkExtractPolyDataGeometry, simply invoke its constructor as follows
obj = vtkExtractPolyDataGeometry
1188
34.76.2
Methods
The class vtkExtractPolyDataGeometry has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractPolyDataGeometry
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractPolyDataGeometry = obj.NewInstance ()
vtkExtractPolyDataGeometry = obj.SafeDownCast (vtkObject o)
long = obj.GetMTime () - Return the MTime taking into account changes to the implicit function
obj.SetImplicitFunction (vtkImplicitFunction ) - Specify the implicit function for inside/outside checks.
vtkImplicitFunction = obj.GetImplicitFunction () - Specify the implicit function for inside/outside checks.
obj.SetExtractInside (int ) - Boolean controls whether to extract cells that are inside of implicit
function (ExtractInside == 1) or outside of implicit function (ExtractInside == 0).
int = obj.GetExtractInside () - Boolean controls whether to extract cells that are inside of implicit function (ExtractInside == 1) or outside of implicit function (ExtractInside == 0).
obj.ExtractInsideOn () - Boolean controls whether to extract cells that are inside of implicit function
(ExtractInside == 1) or outside of implicit function (ExtractInside == 0).
obj.ExtractInsideOff () - Boolean controls whether to extract cells that are inside of implicit function (ExtractInside == 1) or outside of implicit function (ExtractInside == 0).
obj.SetExtractBoundaryCells (int ) - Boolean controls whether to extract cells that are partially inside. By default, ExtractBoundaryCells is off.
int = obj.GetExtractBoundaryCells () - Boolean controls whether to extract cells that are
partially inside. By default, ExtractBoundaryCells is off.
obj.ExtractBoundaryCellsOn () - Boolean controls whether to extract cells that are partially inside. By default, ExtractBoundaryCells is off.
obj.ExtractBoundaryCellsOff () - Boolean controls whether to extract cells that are partially
inside. By default, ExtractBoundaryCells is off.
34.77
vtkExtractRectilinearGrid
34.77.1
Usage
vtkExtractRectilinearGrid rounds out the set of filters that extract a subgrid out of a larger structured data set. RIght
now, this filter only supports extracting a VOI. In the future, it might support strides like the vtkExtract grid filter.
To create an instance of class vtkExtractRectilinearGrid, simply invoke its constructor as follows
obj = vtkExtractRectilinearGrid
34.78 vtkExtractSelectedBlock
34.77.2
1189
Methods
The class vtkExtractRectilinearGrid has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractRectilinearGrid
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractRectilinearGrid = obj.NewInstance ()
vtkExtractRectilinearGrid = obj.SafeDownCast (vtkObject o)
obj.SetVOI (int , int , int , int , int , int ) - Specify i-j-k (min,max) pairs to extract. The resulting structured grid dataset can be of any topological dimension (i.e., point, line, plane, or 3D
grid).
obj.SetVOI (int a[6]) - Specify i-j-k (min,max) pairs to extract. The resulting structured grid dataset
can be of any topological dimension (i.e., point, line, plane, or 3D grid).
int = obj. GetVOI () - Specify i-j-k (min,max) pairs to extract. The resulting structured grid dataset
can be of any topological dimension (i.e., point, line, plane, or 3D grid).
obj.SetSampleRate (int , int , int ) - Set the sampling rate in the i, j, and k directions. If
the rate is > 1, then the resulting VOI will be subsampled representation of the input. For example, if the
SampleRate=(2,2,2), every other point will be selected, resulting in a volume 1/8th the original size.
obj.SetSampleRate (int a[3]) - Set the sampling rate in the i, j, and k directions. If the rate is > 1,
then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2),
every other point will be selected, resulting in a volume 1/8th the original size.
int = obj. GetSampleRate () - Set the sampling rate in the i, j, and k directions. If the rate is > 1,
then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2),
every other point will be selected, resulting in a volume 1/8th the original size.
obj.SetIncludeBoundary (int ) - Control whether to enforce that the "boundary" of the grid is
output in the subsampling process. (This ivar only has effect when the SampleRate in any direction is not
equal to 1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the
grid even though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary
is off.)
int = obj.GetIncludeBoundary () - Control whether to enforce that the "boundary" of the grid is
output in the subsampling process. (This ivar only has effect when the SampleRate in any direction is not
equal to 1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the
grid even though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary
is off.)
obj.IncludeBoundaryOn () - Control whether to enforce that the "boundary" of the grid is output in
the subsampling process. (This ivar only has effect when the SampleRate in any direction is not equal to
1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the grid even
though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary is off.)
obj.IncludeBoundaryOff () - Control whether to enforce that the "boundary" of the grid is output
in the subsampling process. (This ivar only has effect when the SampleRate in any direction is not equal to
1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the grid even
though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary is off.)
34.78
vtkExtractSelectedBlock
1190
34.78.1
Usage
34.78.2
Methods
The class vtkExtractSelectedBlock has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractSelectedBlock
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractSelectedBlock = obj.NewInstance ()
vtkExtractSelectedBlock = obj.SafeDownCast (vtkObject o)
34.79
vtkExtractSelectedFrustum
34.79.1
Usage
This class intersects the input DataSet with a frustum and determines which cells and points lie within the frustum.
The frustum is defined with a vtkPlanes containing six cutting planes. The output is a DataSet that is either a shallow
copy of the input dataset with two new "vtkInsidedness" attribute arrays, or a completely new UnstructuredGrid that
contains only the cells and points of the input that are inside the frustum. The PreserveTopology flag controls which
occurs. When PreserveTopology is off this filter adds a scalar array called vtkOriginalCellIds that says what input
cell produced each output cell. This is an example of a Pedigree ID which helps to trace back results.
To create an instance of class vtkExtractSelectedFrustum, simply invoke its constructor as follows
obj = vtkExtractSelectedFrustum
34.79.2
Methods
The class vtkExtractSelectedFrustum has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractSelectedFrustum
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractSelectedFrustum = obj.NewInstance ()
vtkExtractSelectedFrustum = obj.SafeDownCast (vtkObject o)
long = obj.GetMTime () - Return the MTime taking into account changes to the Frustum
obj.SetFrustum (vtkPlanes ) - Set the selection frustum. The planes object must contain six
planes.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.80 vtkExtractSelectedIds
1191
vtkPlanes = obj.GetFrustum () - Set the selection frustum. The planes object must contain six
planes.
obj.CreateFrustum (double vertices[32]) - Given eight vertices, creates a frustum. each pt
is x,y,z,1 in the following order near lower left, far lower left near upper left, far upper left near lower right, far
lower right near upper right, far upper right
vtkPoints = obj.GetClipPoints () - Return eight points that define the selection frustum. Valid
if create Frustum was used, invalid if SetFrustum was.
obj.SetFieldType (int ) - Sets/gets the intersection test type.
int = obj.GetFieldType () - Sets/gets the intersection test type.
obj.SetContainingCells (int ) - Sets/gets the intersection test type. Only meaningful when
fieldType is vtkSelection::POINT
int = obj.GetContainingCells () - Sets/gets the intersection test type. Only meaningful when
fieldType is vtkSelection::POINT
int = obj.OverallBoundsTest (double bounds) - Does a quick test on the AABBox defined
by the bounds.
obj.SetShowBounds (int ) - When On, this returns an unstructured grid that outlines selection area.
Off is the default.
int = obj.GetShowBounds () - When On, this returns an unstructured grid that outlines selection
area. Off is the default.
obj.ShowBoundsOn () - When On, this returns an unstructured grid that outlines selection area. Off is
the default.
obj.ShowBoundsOff () - When On, this returns an unstructured grid that outlines selection area. Off
is the default.
obj.SetInsideOut (int ) - When on, extracts cells outside the frustum instead of inside.
int = obj.GetInsideOut () - When on, extracts cells outside the frustum instead of inside.
obj.InsideOutOn () - When on, extracts cells outside the frustum instead of inside.
obj.InsideOutOff () - When on, extracts cells outside the frustum instead of inside.
34.80
vtkExtractSelectedIds
34.80.1
Usage
vtkExtractSelectedIds extracts a set of cells and points from within a vtkDataSet. The set of ids to extract are listed
within a vtkSelection. This filter adds a scalar array called vtkOriginalCellIds that says what input cell produced
each output cell. This is an example of a Pedigree ID which helps to trace back results. Depending on whether
the selection has GLOBALIDS, VALUES or INDICES, the selection will use the contents of the array named in the
GLOBALIDS DataSetAttribute, and arbitrary array, or the position (tuple id or number) within the cell or point array.
To create an instance of class vtkExtractSelectedIds, simply invoke its constructor as follows
obj = vtkExtractSelectedIds
1192
34.80.2
Methods
The class vtkExtractSelectedIds has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractSelectedIds class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractSelectedIds = obj.NewInstance ()
vtkExtractSelectedIds = obj.SafeDownCast (vtkObject o)
34.81
vtkExtractSelectedLocations
34.81.1
Usage
vtkExtractSelectedLocations extracts all cells whose volume contain at least one point listed in the LOCATIONS content of the vtkSelection. This filter adds a scalar array called vtkOriginalCellIds that says what input cell
produced each output cell. This is an example of a Pedigree ID which helps to trace back results.
To create an instance of class vtkExtractSelectedLocations, simply invoke its constructor as follows
obj = vtkExtractSelectedLocations
34.81.2
Methods
The class vtkExtractSelectedLocations has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractSelectedLocations
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractSelectedLocations = obj.NewInstance ()
vtkExtractSelectedLocations = obj.SafeDownCast (vtkObject o)
34.82
vtkExtractSelectedPolyDataIds
34.82.1
Usage
34.83 vtkExtractSelectedRows
34.82.2
1193
Methods
The class vtkExtractSelectedPolyDataIds has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractSelectedPolyDataIds class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractSelectedPolyDataIds = obj.NewInstance ()
vtkExtractSelectedPolyDataIds = obj.SafeDownCast (vtkObject o)
34.83
vtkExtractSelectedRows
34.83.1
Usage
The first input is a vtkTable to extract rows from. The second input is a vtkSelection containing the selected indices.
The third input is a vtkAnnotationLayers containing selected indices. The field type of the input selection is ignored
when converted to row indices.
To create an instance of class vtkExtractSelectedRows, simply invoke its constructor as follows
obj = vtkExtractSelectedRows
34.83.2
Methods
The class vtkExtractSelectedRows has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractSelectedRows
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractSelectedRows = obj.NewInstance ()
vtkExtractSelectedRows = obj.SafeDownCast (vtkObject o)
obj.SetSelectionConnection (vtkAlgorithmOutput in) - A convenience method for setting the second input (i.e. the selection).
obj.SetAnnotationLayersConnection (vtkAlgorithmOutput in)
method for setting the third input (i.e. the annotation layers).
convenience
int = obj.FillInputPortInformation (int port, vtkInformation info) - Specify the first vtkGraph input and the second vtkSelection input.
obj.SetAddOriginalRowIdsArray (bool ) - When set, a column named vtkOriginalRowIds will
be added to the output. False by default.
bool = obj.GetAddOriginalRowIdsArray () - When set, a column named vtkOriginalRowIds
will be added to the output. False by default.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1194
34.84
vtkExtractSelectedThresholds
34.84.1
Usage
vtkExtractSelectedThresholds extracts all cells and points with attribute values that lie within a vtkSelections THRESHOLD contents. The selecion can specify to threshold a particular array within either the point or cell attribute
data of the input. This is similar to vtkThreshold but allows mutliple thresholds ranges. This filter adds a scalar array
called vtkOriginalCellIds that says what input cell produced each output cell. This is an example of a Pedigree ID
which helps to trace back results.
To create an instance of class vtkExtractSelectedThresholds, simply invoke its constructor as follows
obj = vtkExtractSelectedThresholds
34.84.2
Methods
The class vtkExtractSelectedThresholds has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractSelectedThresholds class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractSelectedThresholds = obj.NewInstance ()
vtkExtractSelectedThresholds = obj.SafeDownCast (vtkObject o)
34.85
vtkExtractSelection
34.85.1
Usage
vtkExtractSelection extracts some subset of cells and points from its input dataset. The dataset is given on its first
input port. The subset is described by the contents of the vtkSelection on its second input port. Depending on
the content of the vtkSelection, this will use either a vtkExtractSelectedIds, vtkExtractSelectedFrustum vtkExtractSelectedLocations or a vtkExtractSelectedThreshold to perform the extraction.
To create an instance of class vtkExtractSelection, simply invoke its constructor as follows
obj = vtkExtractSelection
34.86 vtkExtractSelectionBase
34.85.2
1195
Methods
The class vtkExtractSelection has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractSelection class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractSelection = obj.NewInstance ()
vtkExtractSelection = obj.SafeDownCast (vtkObject o)
obj.SetShowBounds (int ) - When On, this returns an unstructured grid that outlines selection area.
Off is the default. Applicable only to Frustum selection extraction.
int = obj.GetShowBounds () - When On, this returns an unstructured grid that outlines selection
area. Off is the default. Applicable only to Frustum selection extraction.
obj.ShowBoundsOn () - When On, this returns an unstructured grid that outlines selection area. Off is
the default. Applicable only to Frustum selection extraction.
obj.ShowBoundsOff () - When On, this returns an unstructured grid that outlines selection area. Off
is the default. Applicable only to Frustum selection extraction.
obj.SetUseProbeForLocations (int ) - When On, vtkProbeSelectedLocations is used for extracting selections of content type vtkSelection::LOCATIONS. Default is off and then vtkExtractSelectedLocations is used.
int = obj.GetUseProbeForLocations () - When On, vtkProbeSelectedLocations is used for
extracting selections of content type vtkSelection::LOCATIONS. Default is off and then vtkExtractSelectedLocations is used.
obj.UseProbeForLocationsOn () - When On, vtkProbeSelectedLocations is used for extracting
selections of content type vtkSelection::LOCATIONS. Default is off and then vtkExtractSelectedLocations is
used.
obj.UseProbeForLocationsOff () - When On, vtkProbeSelectedLocations is used for extracting
selections of content type vtkSelection::LOCATIONS. Default is off and then vtkExtractSelectedLocations is
used.
34.86
vtkExtractSelectionBase
34.86.1
Usage
vtkExtractSelectionBase is an abstract base class for all extract selection filters. It defines some properties common
to all extract selection filters.
To create an instance of class vtkExtractSelectionBase, simply invoke its constructor as follows
obj = vtkExtractSelectionBase
1196
34.86.2
Methods
The class vtkExtractSelectionBase has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractSelectionBase
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractSelectionBase = obj.NewInstance ()
vtkExtractSelectionBase = obj.SafeDownCast (vtkObject o)
obj.SetSelectionConnection (vtkAlgorithmOutput algOutput) - This flag tells the extraction filter not to convert the selected output into an unstructured grid, but instead to produce a vtkInsidedness array and add it to the input dataset. Default value is false(0).
obj.SetPreserveTopology (int ) - This flag tells the extraction filter not to convert the selected
output into an unstructured grid, but instead to produce a vtkInsidedness array and add it to the input dataset.
Default value is false(0).
int = obj.GetPreserveTopology () - This flag tells the extraction filter not to convert the selected
output into an unstructured grid, but instead to produce a vtkInsidedness array and add it to the input dataset.
Default value is false(0).
obj.PreserveTopologyOn () - This flag tells the extraction filter not to convert the selected output
into an unstructured grid, but instead to produce a vtkInsidedness array and add it to the input dataset. Default
value is false(0).
obj.PreserveTopologyOff () - This flag tells the extraction filter not to convert the selected output
into an unstructured grid, but instead to produce a vtkInsidedness array and add it to the input dataset. Default
value is false(0).
34.87
vtkExtractTemporalFieldData
34.87.1
Usage
vtkExtractTemporalFieldData extracts arrays from the input vtkFieldData. These arrays are assumed to contain
temporal data, where the nth tuple contains the value for the nth timestep. The output is a 1D rectilinear grid where
the XCoordinates correspond to time (the same array is also copied to a point array named Time or TimeData (if
Time exists in the input). This algorithm does not produce a TIME_STEPS or TIME_RANGE information because it
works across time. .Section Caveat vtkExtractTemporalFieldData puts a vtkOnePieceExtentTranslator in the output
during RequestInformation(). As a result, the same whole extented is produced independent of the piece request.
This algorithm works only with source that produce TIME_STEPS(). Continuous time range is not yet supported.
To create an instance of class vtkExtractTemporalFieldData, simply invoke its constructor as follows
obj = vtkExtractTemporalFieldData
34.87.2
Methods
The class vtkExtractTemporalFieldData has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractTemporalFieldData
class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.88 vtkExtractTensorComponents
1197
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractTemporalFieldData = obj.NewInstance ()
vtkExtractTemporalFieldData = obj.SafeDownCast (vtkObject o)
int = obj.GetNumberOfTimeSteps () - Get the number of time steps
34.88
vtkExtractTensorComponents
34.88.1
Usage
vtkExtractTensorComponents is a filter that extracts components of a tensor to create a scalar, vector, normal, or
texture coords. For example, if the tensor contains components of stress, then you could extract the normal stress
in the x-direction as a scalar (i.e., tensor component (0,0).
To use this filter, you must set some boolean flags to control which data is extracted from the tensors, and whether
you want to pass the tensor data through to the output. Also, you must specify the tensor component(s) for each
type of data you want to extract. The tensor component(s) is(are) specified using matrix notation into a 3x3 matrix.
That is, use the (row,column) address to specify a particular tensor component; and if the data you are extracting
requires more than one component, use a list of addresses. (Note that the addresses are 0-offset -> (0,0) specifies
upper left corner of the tensor.)
There are two optional methods to extract scalar data. You can extract the determinant of the tensor, or you can
extract the effective stress of the tensor. These require that the ivar ExtractScalars is on, and the appropriate scalar
extraction mode is set.
To create an instance of class vtkExtractTensorComponents, simply invoke its constructor as follows
obj = vtkExtractTensorComponents
34.88.2
Methods
The class vtkExtractTensorComponents has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractTensorComponents
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractTensorComponents = obj.NewInstance ()
vtkExtractTensorComponents = obj.SafeDownCast (vtkObject o)
obj.SetPassTensorsToOutput (int ) - Boolean controls whether tensor data is passed through
to output.
int = obj.GetPassTensorsToOutput () - Boolean controls whether tensor data is passed
through to output.
obj.PassTensorsToOutputOn () - Boolean controls whether tensor data is passed through to output.
obj.PassTensorsToOutputOff () - Boolean controls whether tensor data is passed through to output.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1198
obj.SetExtractScalars (int ) - Boolean controls whether scalar data is extracted from tensor.
int = obj.GetExtractScalars () - Boolean controls whether scalar data is extracted from tensor.
obj.ExtractScalarsOn () - Boolean controls whether scalar data is extracted from tensor.
obj.ExtractScalarsOff () - Boolean controls whether scalar data is extracted from tensor.
obj.SetScalarComponents (int , int ) - Specify the (row,column) tensor component to extract as a scalar.
obj.SetScalarComponents (int a[2]) - Specify the (row,column) tensor component to extract
as a scalar.
int = obj.
as a scalar.
obj.SetScalarMode (int ) - Specify how to extract the scalar. You can extract it as one of the
components of the tensor, as effective stress, or as the determinant of the tensor. If you extract a component
make sure that you set the ScalarComponents ivar.
int = obj.GetScalarMode () - Specify how to extract the scalar. You can extract it as one of the
components of the tensor, as effective stress, or as the determinant of the tensor. If you extract a component
make sure that you set the ScalarComponents ivar.
obj.SetScalarModeToComponent () - Specify how to extract the scalar. You can extract it as one
of the components of the tensor, as effective stress, or as the determinant of the tensor. If you extract a
component make sure that you set the ScalarComponents ivar.
obj.SetScalarModeToEffectiveStress () - Specify how to extract the scalar. You can extract it
as one of the components of the tensor, as effective stress, or as the determinant of the tensor. If you extract
a component make sure that you set the ScalarComponents ivar.
obj.SetScalarModeToDeterminant () - Specify how to extract the scalar. You can extract it as
one of the components of the tensor, as effective stress, or as the determinant of the tensor. If you extract a
component make sure that you set the ScalarComponents ivar.
obj.ScalarIsComponent () - Specify how to extract the scalar. You can extract it as one of the
components of the tensor, as effective stress, or as the determinant of the tensor. If you extract a component
make sure that you set the ScalarComponents ivar.
obj.ScalarIsEffectiveStress () - Specify how to extract the scalar. You can extract it as one
of the components of the tensor, as effective stress, or as the determinant of the tensor. If you extract a
component make sure that you set the ScalarComponents ivar.
obj.ScalarIsDeterminant () - Specify how to extract the scalar. You can extract it as one of the
components of the tensor, as effective stress, or as the determinant of the tensor. If you extract a component
make sure that you set the ScalarComponents ivar.
obj.SetExtractVectors (int ) - Boolean controls whether vector data is extracted from tensor.
int = obj.GetExtractVectors () - Boolean controls whether vector data is extracted from tensor.
obj.ExtractVectorsOn () - Boolean controls whether vector data is extracted from tensor.
obj.ExtractVectorsOff () - Boolean controls whether vector data is extracted from tensor.
obj.SetVectorComponents (int , int , int , int , int , int ) - Specify the
((row,column)0,(row,column)1,(row,column)2) tensor components to extract as a vector.
obj.SetVectorComponents (int a[6]) - Specify the ((row,column)0,(row,column)1,(row,column)2)
tensor components to extract as a vector.
int = obj. GetVectorComponents () - Specify the ((row,column)0,(row,column)1,(row,column)2)
tensor components to extract as a vector.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.89 vtkExtractUnstructuredGrid
1199
obj.SetExtractNormals (int ) - Boolean controls whether normal data is extracted from tensor.
int = obj.GetExtractNormals () - Boolean controls whether normal data is extracted from tensor.
obj.ExtractNormalsOn () - Boolean controls whether normal data is extracted from tensor.
obj.ExtractNormalsOff () - Boolean controls whether normal data is extracted from tensor.
obj.SetNormalizeNormals (int ) - Boolean controls whether normal vector is converted to unit
normal after extraction.
int = obj.GetNormalizeNormals () - Boolean controls whether normal vector is converted to
unit normal after extraction.
obj.NormalizeNormalsOn () - Boolean controls whether normal vector is converted to unit normal
after extraction.
obj.NormalizeNormalsOff () - Boolean controls whether normal vector is converted to unit normal
after extraction.
obj.SetNormalComponents (int , int , int , int , int , int ) - Specify the
((row,column)0,(row,column)1,(row,column)2) tensor components to extract as a vector.
obj.SetNormalComponents (int a[6]) - Specify the ((row,column)0,(row,column)1,(row,column)2)
tensor components to extract as a vector.
int = obj. GetNormalComponents () - Specify the ((row,column)0,(row,column)1,(row,column)2)
tensor components to extract as a vector.
obj.SetExtractTCoords (int ) - Boolean controls whether texture coordinates are extracted from
tensor.
int = obj.GetExtractTCoords () - Boolean controls whether texture coordinates are extracted
from tensor.
obj.ExtractTCoordsOn () - Boolean controls whether texture coordinates are extracted from tensor.
obj.ExtractTCoordsOff () - Boolean controls whether texture coordinates are extracted from tensor.
obj.SetNumberOfTCoords (int ) - Set the dimension of the texture coordinates to extract.
int = obj.GetNumberOfTCoordsMinValue () - Set the dimension of the texture coordinates to
extract.
int = obj.GetNumberOfTCoordsMaxValue () - Set the dimension of the texture coordinates to
extract.
int = obj.GetNumberOfTCoords () - Set the dimension of the texture coordinates to extract.
obj.SetTCoordComponents (int , int , int , int , int , int ) - Specify the
((row,column)0,(row,column)1,(row,column)2) tensor components to extract as a vector. Up to NumberOfTCoords components are extracted.
obj.SetTCoordComponents (int a[6]) - Specify the ((row,column)0,(row,column)1,(row,column)2)
tensor components to extract as a vector. Up to NumberOfTCoords components are extracted.
int = obj. GetTCoordComponents () - Specify the ((row,column)0,(row,column)1,(row,column)2)
tensor components to extract as a vector. Up to NumberOfTCoords components are extracted.
34.89
vtkExtractUnstructuredGrid
1200
34.89.1
Usage
vtkExtractUnstructuredGrid is a general-purpose filter to extract geometry (and associated data) from an unstructured grid dataset. The extraction process is controlled by specifying a range of point ids, cell ids, or a bounding box
(referred to as "Extent"). Those cells lying within these regions are sent to the output. The user has the choice of
merging coincident points (Merging is on) or using the original point set (Merging is off).
To create an instance of class vtkExtractUnstructuredGrid, simply invoke its constructor as follows
obj = vtkExtractUnstructuredGrid
34.89.2
Methods
The class vtkExtractUnstructuredGrid has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractUnstructuredGrid
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractUnstructuredGrid = obj.NewInstance ()
vtkExtractUnstructuredGrid = obj.SafeDownCast (vtkObject o)
obj.SetPointClipping (int ) - Turn on/off selection of geometry by point id.
int = obj.GetPointClipping () - Turn on/off selection of geometry by point id.
obj.PointClippingOn () - Turn on/off selection of geometry by point id.
obj.PointClippingOff () - Turn on/off selection of geometry by point id.
obj.SetCellClipping (int ) - Turn on/off selection of geometry by cell id.
int = obj.GetCellClipping () - Turn on/off selection of geometry by cell id.
obj.CellClippingOn () - Turn on/off selection of geometry by cell id.
obj.CellClippingOff () - Turn on/off selection of geometry by cell id.
obj.SetExtentClipping (int ) - Turn on/off selection of geometry via bounding box.
int = obj.GetExtentClipping () - Turn on/off selection of geometry via bounding box.
obj.ExtentClippingOn () - Turn on/off selection of geometry via bounding box.
obj.ExtentClippingOff () - Turn on/off selection of geometry via bounding box.
obj.SetPointMinimum (vtkIdType ) - Specify the minimum point id for point id selection.
vtkIdType = obj.GetPointMinimumMinValue () - Specify the minimum point id for point id
selection.
vtkIdType = obj.GetPointMinimumMaxValue () - Specify the minimum point id for point id
selection.
vtkIdType = obj.GetPointMinimum () - Specify the minimum point id for point id selection.
obj.SetPointMaximum (vtkIdType ) - Specify the maximum point id for point id selection.
vtkIdType = obj.GetPointMaximumMinValue () - Specify the maximum point id for point id
selection.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.90 vtkExtractVectorComponents
1201
34.90
vtkExtractVectorComponents
1202
34.90.1
Usage
vtkExtractVectorComponents is a filter that extracts vector components as separate scalars. This is accomplished
by creating three different outputs. Each output is the same as the input, except that the scalar values will be one of
the three components of the vector. These can be found in the VxComponent, VyComponent, and VzComponent.
Alternatively, if the ExtractToFieldData flag is set, the filter will put all the components in the field data. The first
component will be the scalar and the others will be non-attribute arrays.
To create an instance of class vtkExtractVectorComponents, simply invoke its constructor as follows
obj = vtkExtractVectorComponents
34.90.2
Methods
The class vtkExtractVectorComponents has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractVectorComponents
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractVectorComponents = obj.NewInstance ()
vtkExtractVectorComponents = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkDataSet input) - Specify the input data or filter.
vtkDataSet = obj.GetVxComponent () - Get the output dataset representing velocity xcomponent. If output is NULL then input hasnt been set, which is necessary for abstract objects. (Note: this
method returns the same information as the GetOutput() method with an index of 0.)
vtkDataSet = obj.GetVyComponent () - Get the output dataset representing velocity ycomponent. If output is NULL then input hasnt been set, which is necessary for abstract objects. (Note:
this method returns the same information as the GetOutput() method with an index of 1.) Note that if
ExtractToFieldData is true, this output will be empty.
vtkDataSet = obj.GetVzComponent () - Get the output dataset representing velocity zcomponent. If output is NULL then input hasnt been set, which is necessary for abstract objects. (Note:
this method returns the same information as the GetOutput() method with an index of 2.) Note that if
ExtractToFieldData is true, this output will be empty.
obj.SetExtractToFieldData (int ) - Determines whether the vector components will be put in
separate outputs or in the first outputs field data
int = obj.GetExtractToFieldData () - Determines whether the vector components will be put
in separate outputs or in the first outputs field data
obj.ExtractToFieldDataOn () - Determines whether the vector components will be put in separate
outputs or in the first outputs field data
obj.ExtractToFieldDataOff () - Determines whether the vector components will be put in separate outputs or in the first outputs field data
34.91
vtkFeatureEdges
34.91 vtkFeatureEdges
34.91.1
1203
Usage
vtkFeatureEdges is a filter to extract special types of edges from input polygonal data. These edges are either 1)
boundary (used by one polygon) or a line cell; 2) non-manifold (used by three or more polygons); 3) feature edges
(edges used by two triangles and whose dihedral angle > FeatureAngle); or 4) manifold edges (edges used by
exactly two polygons). These edges may be extracted in any combination. Edges may also be "colored" (i.e., scalar
values assigned) based on edge type. The cell coloring is assigned to the cell data of the extracted edges.
To create an instance of class vtkFeatureEdges, simply invoke its constructor as follows
obj = vtkFeatureEdges
34.91.2
Methods
The class vtkFeatureEdges has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkFeatureEdges class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkFeatureEdges = obj.NewInstance ()
vtkFeatureEdges = obj.SafeDownCast (vtkObject o)
obj.SetBoundaryEdges (int ) - Turn on/off the extraction of boundary edges.
int = obj.GetBoundaryEdges () - Turn on/off the extraction of boundary edges.
obj.BoundaryEdgesOn () - Turn on/off the extraction of boundary edges.
obj.BoundaryEdgesOff () - Turn on/off the extraction of boundary edges.
obj.SetFeatureEdges (int ) - Turn on/off the extraction of feature edges.
int = obj.GetFeatureEdges () - Turn on/off the extraction of feature edges.
obj.FeatureEdgesOn () - Turn on/off the extraction of feature edges.
obj.FeatureEdgesOff () - Turn on/off the extraction of feature edges.
obj.SetFeatureAngle (double ) - Specify the feature angle for extracting feature edges.
double = obj.GetFeatureAngleMinValue () - Specify the feature angle for extracting feature
edges.
double = obj.GetFeatureAngleMaxValue () - Specify the feature angle for extracting feature
edges.
double = obj.GetFeatureAngle () - Specify the feature angle for extracting feature edges.
obj.SetNonManifoldEdges (int ) - Turn on/off the extraction of non-manifold edges.
int = obj.GetNonManifoldEdges () - Turn on/off the extraction of non-manifold edges.
obj.NonManifoldEdgesOn () - Turn on/off the extraction of non-manifold edges.
obj.NonManifoldEdgesOff () - Turn on/off the extraction of non-manifold edges.
obj.SetManifoldEdges (int ) - Turn on/off the extraction of manifold edges.
int = obj.GetManifoldEdges () - Turn on/off the extraction of manifold edges.
obj.ManifoldEdgesOn () - Turn on/off the extraction of manifold edges.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1204
34.92
vtkFieldDataToAttributeDataFilter
34.92.1
Usage
vtkFieldDataToAttributeDataFilter is a class that maps field data into dataset attributes. The input to this filter is any
type of dataset and the output is the same dataset (geometry/topology) with new attribute data (attribute data is
passed through if not replaced during filter execution).
To use this filter you must specify which field data from the input dataset to use. There are three possibilities: the cell
field data, the point field data, or the field data associated with the data object superclass. Then you specify which
attribute data to create: either cell attribute data or point attribute data. Finally, you must define how to construct
the various attribute data types (e.g., scalars, vectors, normals, etc.) from the arrays and the components of the
arrays from the field data. This is done by associating components in the input field with components making up
the attribute data. For example, you would specify a scalar with three components (RGB) by assigning components
from the field for the R, then G, then B values of the scalars. You may also have to specify component ranges (for
each R-G-B) to make sure that the number of R, G, and B values is the same. Also, you may want to normalize the
components which helps distribute the data uniformly.
This filter is often used in conjunction with vtkDataObjectToDataSetFilter. vtkDataObjectToDataSetFilter filter generates dataset topology and geometry and passes its input field data along to its output. Then this filter is used to
generate the attribute data to go along with the dataset.
To create an instance of class vtkFieldDataToAttributeDataFilter, simply invoke its constructor as follows
obj = vtkFieldDataToAttributeDataFilter
34.92.2
Methods
The class vtkFieldDataToAttributeDataFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkFieldDataToAttributeDataFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkFieldDataToAttributeDataFilter = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.92 vtkFieldDataToAttributeDataFilter
1205
1206
34.92 vtkFieldDataToAttributeDataFilter
1207
1208
34.93
vtkFillHolesFilter
34.93.1
Usage
vtkFillHolesFilter is a filter that identifies and fills holes in input vtkPolyData meshes. Holes are identified by locating
boundary edges, linking them together into loops, and then triangulating the resulting loops. Note that you can
specify an approximate limit to the size of the hole that can be filled.
To create an instance of class vtkFillHolesFilter, simply invoke its constructor as follows
obj = vtkFillHolesFilter
34.93.2
Methods
The class vtkFillHolesFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkFillHolesFilter class.
string = obj.GetClassName () - Standard methods for instantiation, type information and printing.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.94 vtkFrustumSource
1209
int = obj.IsA (string name) - Standard methods for instantiation, type information and printing.
vtkFillHolesFilter = obj.NewInstance () - Standard methods for instantiation, type information and printing.
vtkFillHolesFilter = obj.SafeDownCast (vtkObject o) - Standard methods for instantiation, type information and printing.
obj.SetHoleSize (double ) - Specify the maximum hole size to fill. This is represented as a radius
to the bounding circumsphere containing the hole. Note that this is an approximate area; the actual area
cannot be computed without first triangulating the hole.
double = obj.GetHoleSizeMinValue () - Specify the maximum hole size to fill. This is represented as a radius to the bounding circumsphere containing the hole. Note that this is an approximate area;
the actual area cannot be computed without first triangulating the hole.
double = obj.GetHoleSizeMaxValue () - Specify the maximum hole size to fill. This is represented as a radius to the bounding circumsphere containing the hole. Note that this is an approximate area;
the actual area cannot be computed without first triangulating the hole.
double = obj.GetHoleSize () - Specify the maximum hole size to fill. This is represented as a
radius to the bounding circumsphere containing the hole. Note that this is an approximate area; the actual
area cannot be computed without first triangulating the hole.
34.94
vtkFrustumSource
34.94.1
Usage
vtkFrustumSource creates a frustum defines by a set of planes. The frustum is represented with four-sided polygons.
It is possible to specify extra lines to better visualize the field of view.
.SECTION Usage Typical use consists of 3 steps:
1. get the planes coefficients from a vtkCamera with vtkCamera::GetFrustumPlanes()
2. initialize the planes with vtkPlanes::SetFrustumPlanes() with the planes coefficients
3. pass the vtkPlanes to a vtkFrustumSource.
To create an instance of class vtkFrustumSource, simply invoke its constructor as follows
obj = vtkFrustumSource
34.94.2
Methods
The class vtkFrustumSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkFrustumSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkFrustumSource = obj.NewInstance ()
vtkFrustumSource = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1210
vtkPlanes = obj.GetPlanes () - Return the 6 planes defining the frustum. Initial value is NULL.
The 6 planes are defined in this order: left,right,bottom,top,far,near. If Planes==NULL or if Planes->GetNumberOfPlanes()!=6 when RequestData() is called, an error message will be emitted and RequestData()
will return right away.
obj.SetPlanes (vtkPlanes planes) - Set the 6 planes defining the frustum.
bool = obj.GetShowLines () - Tells if some extra lines will be generated. Initial value is true.
obj.SetShowLines (bool ) - Tells if some extra lines will be generated. Initial value is true.
obj.ShowLinesOn () - Tells if some extra lines will be generated. Initial value is true.
obj.ShowLinesOff () - Tells if some extra lines will be generated. Initial value is true.
double = obj.GetLinesLength () - Length of the extra lines. This a stricly positive value. Initial
value is 1.0.
obj.SetLinesLength (double ) - Length of the extra lines. This a stricly positive value. Initial value
is 1.0.
long = obj.GetMTime () - Modified GetMTime because of Planes.
34.95
vtkGeodesicPath
34.95.1
Usage
Serves as a base class for algorithms that trace a geodesic path on a polygonal dataset.
To create an instance of class vtkGeodesicPath, simply invoke its constructor as follows
obj = vtkGeodesicPath
34.95.2
Methods
The class vtkGeodesicPath has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkGeodesicPath class.
string = obj.GetClassName () - Standard methids for printing and determining type information.
int = obj.IsA (string name) - Standard methids for printing and determining type information.
vtkGeodesicPath = obj.NewInstance () - Standard methids for printing and determining type
information.
vtkGeodesicPath = obj.SafeDownCast (vtkObject o) - Standard methids for printing and
determining type information.
double = obj.GetGeodesicLength ()
34.96
vtkGeometryFilter
34.96 vtkGeometryFilter
34.96.1
1211
Usage
vtkGeometryFilter is a general-purpose filter to extract geometry (and associated data) from any type of dataset.
Geometry is obtained as follows: all 0D, 1D, and 2D cells are extracted. All 2D faces that are used by only one
3D cell (i.e., boundary faces) are extracted. It also is possible to specify conditions on point ids, cell ids, and on
bounding box (referred to as "Extent") to control the extraction process.
This filter also may be used to convert any type of data to polygonal type. The conversion process may be less than
satisfactory for some 3D datasets. For example, this filter will extract the outer surface of a volume or structured grid
dataset. (For structured data you may want to use vtkImageDataGeometryFilter, vtkStructuredGridGeometryFilter,
vtkExtractUnstructuredGrid, vtkRectilinearGridGeometryFilter, or vtkExtractVOI.)
To create an instance of class vtkGeometryFilter, simply invoke its constructor as follows
obj = vtkGeometryFilter
34.96.2
Methods
The class vtkGeometryFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGeometryFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeometryFilter = obj.NewInstance ()
vtkGeometryFilter = obj.SafeDownCast (vtkObject o)
obj.SetPointClipping (int ) - Turn on/off selection of geometry by point id.
int = obj.GetPointClipping () - Turn on/off selection of geometry by point id.
obj.PointClippingOn () - Turn on/off selection of geometry by point id.
obj.PointClippingOff () - Turn on/off selection of geometry by point id.
obj.SetCellClipping (int ) - Turn on/off selection of geometry by cell id.
int = obj.GetCellClipping () - Turn on/off selection of geometry by cell id.
obj.CellClippingOn () - Turn on/off selection of geometry by cell id.
obj.CellClippingOff () - Turn on/off selection of geometry by cell id.
obj.SetExtentClipping (int ) - Turn on/off selection of geometry via bounding box.
int = obj.GetExtentClipping () - Turn on/off selection of geometry via bounding box.
obj.ExtentClippingOn () - Turn on/off selection of geometry via bounding box.
obj.ExtentClippingOff () - Turn on/off selection of geometry via bounding box.
obj.SetPointMinimum (vtkIdType ) - Specify the minimum point id for point id selection.
vtkIdType = obj.GetPointMinimumMinValue () - Specify the minimum point id for point id
selection.
vtkIdType = obj.GetPointMinimumMaxValue () - Specify the minimum point id for point id
selection.
vtkIdType = obj.GetPointMinimum () - Specify the minimum point id for point id selection.
obj.SetPointMaximum (vtkIdType ) - Specify the maximum point id for point id selection.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1212
34.97
vtkGlyph2D
34.98 vtkGlyph3D
34.97.1
1213
Usage
This subclass of vtkGlyph3D is a specialization to 2D. Transformations (i.e., translation, scaling, and rotation) are
constrained to the plane. For example, rotations due to a vector are computed from the x-y coordinates of the
vector only, and are assumed to occur around the z-axis. (See vtkGlyph3D for documentation on the interface to
this class.)
To create an instance of class vtkGlyph2D, simply invoke its constructor as follows
obj = vtkGlyph2D
34.97.2
Methods
The class vtkGlyph2D has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkGlyph2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGlyph2D = obj.NewInstance ()
vtkGlyph2D = obj.SafeDownCast (vtkObject o)
34.98
vtkGlyph3D
34.98.1
Usage
vtkGlyph3D is a filter that copies a geometric representation (called a glyph) to every point in the input dataset. The
glyph is defined with polygonal data from a source filter input. The glyph may be oriented along the input vectors or
normals, and it may be scaled according to scalar data or vector magnitude. More than one glyph may be used by
creating a table of source objects, each defining a different glyph. If a table of glyphs is defined, then the table can
be indexed into by using either scalar value or vector magnitude.
To use this object youll have to provide an input dataset and a source to define the glyph. Then decide whether you
want to scale the glyph and how to scale the glyph (using scalar value or vector magnitude). Next decide whether
you want to orient the glyph, and whether to use the vector data or normal data to orient it. Finally, decide whether
to use a table of glyphs, or just a single glyph. If you use a table of glyphs, youll have to decide whether to index
into it with scalar value or with vector magnitude.
To create an instance of class vtkGlyph3D, simply invoke its constructor as follows
obj = vtkGlyph3D
34.98.2
Methods
The class vtkGlyph3D has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkGlyph3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGlyph3D = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1214
34.98 vtkGlyph3D
1215
1216
obj.SetGeneratePointIds (int ) - Enable/disable the generation of point ids as part of the output. The point ids are the id of the input generating point. The point ids are stored in the output point field
data and named "InputPointIds". Point generation is useful for debugging and pick operations.
int = obj.GetGeneratePointIds () - Enable/disable the generation of point ids as part of the
output. The point ids are the id of the input generating point. The point ids are stored in the output point field
data and named "InputPointIds". Point generation is useful for debugging and pick operations.
obj.GeneratePointIdsOn () - Enable/disable the generation of point ids as part of the output. The
point ids are the id of the input generating point. The point ids are stored in the output point field data and
named "InputPointIds". Point generation is useful for debugging and pick operations.
obj.GeneratePointIdsOff () - Enable/disable the generation of point ids as part of the output. The
point ids are the id of the input generating point. The point ids are stored in the output point field data and
named "InputPointIds". Point generation is useful for debugging and pick operations.
obj.SetPointIdsName (string ) - Set/Get the name of the PointIds array if generated. By default
the Ids are named "InputPointIds", but this can be changed with this function.
string = obj.GetPointIdsName () - Set/Get the name of the PointIds array if generated. By
default the Ids are named "InputPointIds", but this can be changed with this function.
obj.SetFillCellData (int ) - Enable/disable the generation of cell data as part of the output. The
cell data at each cell will match the point data of the input at the glyphed point.
int = obj.GetFillCellData () - Enable/disable the generation of cell data as part of the output.
The cell data at each cell will match the point data of the input at the glyphed point.
obj.FillCellDataOn () - Enable/disable the generation of cell data as part of the output. The cell
data at each cell will match the point data of the input at the glyphed point.
obj.FillCellDataOff () - Enable/disable the generation of cell data as part of the output. The cell
data at each cell will match the point data of the input at the glyphed point.
int = obj.IsPointVisible (vtkDataSet , vtkIdType ) - This can be overwritten by subclass to return 0 when a point is blanked. Default implementation is to always return 1;
34.99
vtkGlyphSource2D
34.99.1
Usage
vtkGlyphSource2D can generate a family of 2D glyphs each of which lies in the x-y plane (i.e., the z-coordinate is
zero). The class is a helper class to be used with vtkGlyph2D and vtkXYPlotActor.
To use this class, specify the glyph type to use and its attributes. Attributes include its position (i.e., center point),
scale, color, and whether the symbol is filled or not (a polygon or closed line sequence). You can also put a short
line through the glyph running from -x to +x (the glyph looks like its on a line), or a cross.
To create an instance of class vtkGlyphSource2D, simply invoke its constructor as follows
obj = vtkGlyphSource2D
34.99.2
Methods
The class vtkGlyphSource2D has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGlyphSource2D class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.99 vtkGlyphSource2D
1217
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGlyphSource2D = obj.NewInstance ()
vtkGlyphSource2D = obj.SafeDownCast (vtkObject o)
obj.SetCenter (double , double , double ) - Set the center of the glyph. By default the
center is (0,0,0).
obj.SetCenter (double a[3]) - Set the center of the glyph. By default the center is (0,0,0).
double = obj.
GetCenter () - Set the center of the glyph. By default the center is (0,0,0).
obj.SetScale (double ) - Set the scale of the glyph. Note that the glyphs are designed to fit in the
(1,1) rectangle.
double = obj.GetScaleMinValue () - Set the scale of the glyph. Note that the glyphs are designed to fit in the (1,1) rectangle.
double = obj.GetScaleMaxValue () - Set the scale of the glyph. Note that the glyphs are designed to fit in the (1,1) rectangle.
double = obj.GetScale () - Set the scale of the glyph. Note that the glyphs are designed to fit in
the (1,1) rectangle.
obj.SetScale2 (double ) - Set the scale of optional portions of the glyph (e.g., the dash and cross
is DashOn() and CrossOn()).
double = obj.GetScale2MinValue () - Set the scale of optional portions of the glyph (e.g., the
dash and cross is DashOn() and CrossOn()).
double = obj.GetScale2MaxValue () - Set the scale of optional portions of the glyph (e.g., the
dash and cross is DashOn() and CrossOn()).
double = obj.GetScale2 () - Set the scale of optional portions of the glyph (e.g., the dash and
cross is DashOn() and CrossOn()).
obj.SetColor (double , double , double ) - Set the color of the glyph. The default color is
white.
obj.SetColor (double a[3]) - Set the color of the glyph. The default color is white.
double = obj.
GetColor () - Set the color of the glyph. The default color is white.
obj.SetFilled (int ) - Specify whether the glyph is filled (a polygon) or not (a closed polygon defined
by line segments). This only applies to 2D closed glyphs.
int = obj.GetFilled () - Specify whether the glyph is filled (a polygon) or not (a closed polygon
defined by line segments). This only applies to 2D closed glyphs.
obj.FilledOn () - Specify whether the glyph is filled (a polygon) or not (a closed polygon defined by
line segments). This only applies to 2D closed glyphs.
obj.FilledOff () - Specify whether the glyph is filled (a polygon) or not (a closed polygon defined by
line segments). This only applies to 2D closed glyphs.
obj.SetDash (int ) - Specify whether a short line segment is drawn through the glyph. (This is in
addition to the glyph. If the glyph type is set to "Dash" there is no need to enable this flag.)
int = obj.GetDash () - Specify whether a short line segment is drawn through the glyph. (This is in
addition to the glyph. If the glyph type is set to "Dash" there is no need to enable this flag.)
obj.DashOn () - Specify whether a short line segment is drawn through the glyph. (This is in addition to
the glyph. If the glyph type is set to "Dash" there is no need to enable this flag.)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1218
obj.DashOff () - Specify whether a short line segment is drawn through the glyph. (This is in addition
to the glyph. If the glyph type is set to "Dash" there is no need to enable this flag.)
obj.SetCross (int ) - Specify whether a cross is drawn as part of the glyph. (This is in addition to
the glyph. If the glyph type is set to "Cross" there is no need to enable this flag.)
int = obj.GetCross () - Specify whether a cross is drawn as part of the glyph. (This is in addition to
the glyph. If the glyph type is set to "Cross" there is no need to enable this flag.)
obj.CrossOn () - Specify whether a cross is drawn as part of the glyph. (This is in addition to the glyph.
If the glyph type is set to "Cross" there is no need to enable this flag.)
obj.CrossOff () - Specify whether a cross is drawn as part of the glyph. (This is in addition to the
glyph. If the glyph type is set to "Cross" there is no need to enable this flag.)
obj.SetRotationAngle (double ) - Specify an angle (in degrees) to rotate the glyph around the
z-axis. Using this ivar, it is possible to generate rotated glyphs (e.g., crosses, arrows, etc.)
double = obj.GetRotationAngle () - Specify an angle (in degrees) to rotate the glyph around
the z-axis. Using this ivar, it is possible to generate rotated glyphs (e.g., crosses, arrows, etc.)
obj.SetGlyphType (int ) - Specify the type of glyph to generate.
int = obj.GetGlyphTypeMinValue () - Specify the type of glyph to generate.
int = obj.GetGlyphTypeMaxValue () - Specify the type of glyph to generate.
int = obj.GetGlyphType () - Specify the type of glyph to generate.
obj.SetGlyphTypeToNone () - Specify the type of glyph to generate.
obj.SetGlyphTypeToVertex () - Specify the type of glyph to generate.
obj.SetGlyphTypeToDash () - Specify the type of glyph to generate.
obj.SetGlyphTypeToCross () - Specify the type of glyph to generate.
obj.SetGlyphTypeToThickCross () - Specify the type of glyph to generate.
obj.SetGlyphTypeToTriangle () - Specify the type of glyph to generate.
obj.SetGlyphTypeToSquare () - Specify the type of glyph to generate.
obj.SetGlyphTypeToCircle () - Specify the type of glyph to generate.
obj.SetGlyphTypeToDiamond () - Specify the type of glyph to generate.
obj.SetGlyphTypeToArrow () - Specify the type of glyph to generate.
obj.SetGlyphTypeToThickArrow () - Specify the type of glyph to generate.
obj.SetGlyphTypeToHookedArrow () - Specify the type of glyph to generate.
obj.SetGlyphTypeToEdgeArrow ()
34.100
vtkGradientFilter
34.100 vtkGradientFilter
34.100.1
1219
Usage
Estimates the gradient of a field in a data set. The gradient calculation is dependent on the input dataset type.
The created gradient array is of the same type as the array it is calculated from (e.g. point data or cell data) as
well as data type (e.g. float, double). At the boundary the gradient is not central differencing. The output array
has 3number of components of the input data array. The ordering for the output tuple will be {du/dx, du/dy, du/dz,
dv/dx, dv/dy, dv/dz, dw/dx, dw/dy, dw/dz} for an input array {u, v, w}.
To create an instance of class vtkGradientFilter, simply invoke its constructor as follows
obj = vtkGradientFilter
34.100.2
Methods
The class vtkGradientFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkGradientFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGradientFilter = obj.NewInstance ()
vtkGradientFilter = obj.SafeDownCast (vtkObject o)
obj.SetInputScalars (int fieldAssociation, string name) - These are basically a
convenience method that calls SetInputArrayToProcess to set the array used as the input scalars. The fieldAssociation comes from the vtkDataObject::FieldAssocations enum. The fieldAttributeType comes from the
vtkDataSetAttributes::AttributeTypes enum.
obj.SetInputScalars (int fieldAssociation, int fieldAttributeType) - These
are basically a convenience method that calls SetInputArrayToProcess to set the array used as the input
scalars. The fieldAssociation comes from the vtkDataObject::FieldAssocations enum. The fieldAttributeType
comes from the vtkDataSetAttributes::AttributeTypes enum.
string = obj.GetResultArrayName () - Get/Set the name of the resulting array to create. If
NULL (the default) then the output array will be named "Gradients".
obj.SetResultArrayName (string ) - Get/Set the name of the resulting array to create. If NULL
(the default) then the output array will be named "Gradients".
int = obj.GetFasterApproximation () - When this flag is on (default is off), the gradient filter
will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore
faster). The error contains some smoothing of the output data and some possible errors on the boundary.
This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a
vtkUnstructuredGrid or a vtkPolyData.
obj.SetFasterApproximation (int ) - When this flag is on (default is off), the gradient filter will
provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore
faster). The error contains some smoothing of the output data and some possible errors on the boundary.
This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a
vtkUnstructuredGrid or a vtkPolyData.
obj.FasterApproximationOn () - When this flag is on (default is off), the gradient filter will provide
a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster). The
error contains some smoothing of the output data and some possible errors on the boundary. This parameter
has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1220
obj.FasterApproximationOff () - When this flag is on (default is off), the gradient filter will provide
a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster). The
error contains some smoothing of the output data and some possible errors on the boundary. This parameter
has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData.
obj.SetComputeVorticity (int ) - Set the resultant array to be vorticity/curl of the input array.
The input array must have 3 components.
int = obj.GetComputeVorticity () - Set the resultant array to be vorticity/curl of the input array.
The input array must have 3 components.
obj.ComputeVorticityOn () - Set the resultant array to be vorticity/curl of the input array. The input
array must have 3 components.
obj.ComputeVorticityOff () - Set the resultant array to be vorticity/curl of the input array. The
input array must have 3 components.
34.101
vtkGraphGeodesicPath
34.101.1
Usage
Serves as a base class for algorithms that trace a geodesic on a polygonal dataset treating it as a graph. ie points
connecting the vertices of the graph
To create an instance of class vtkGraphGeodesicPath, simply invoke its constructor as follows
obj = vtkGraphGeodesicPath
34.101.2
Methods
The class vtkGraphGeodesicPath has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGraphGeodesicPath
class.
string = obj.GetClassName () - Standard methids for printing and determining type information.
int = obj.IsA (string name) - Standard methids for printing and determining type information.
vtkGraphGeodesicPath = obj.NewInstance () - Standard methids for printing and determining type information.
vtkGraphGeodesicPath = obj.SafeDownCast (vtkObject o) - Standard methids for printing and determining type information.
vtkIdType = obj.GetStartVertex () - The vertex at the start of the shortest path
obj.SetStartVertex (vtkIdType ) - The vertex at the start of the shortest path
vtkIdType = obj.GetEndVertex () - The vertex at the end of the shortest path
obj.SetEndVertex (vtkIdType ) - The vertex at the end of the shortest path
34.102
vtkGraphLayoutFilter
34.102 vtkGraphLayoutFilter
34.102.1
1221
Usage
vtkGraphLayoutFilter will reposition a network of nodes, connected by lines or polylines, into a more pleasing arrangement. The class implements a simple force-directed placement algorithm (Fruchterman & Reingold "Graph
Drawing by Force-directed Placement" Software-Practice and Experience 21(11) 1991).
The input to the filter is a vtkPolyData representing the undirected graphs. A graph is represented by a set of
polylines and/or lines. The output is also a vtkPolyData, where the point positions have been modified. To use
the filter, specify whether you wish the layout to occur in 2D or 3D; the bounds in which the graph should lie (note
that you can just use automatic bounds computation); and modify the cool down rate (controls the final process of
simulated annealing).
To create an instance of class vtkGraphLayoutFilter, simply invoke its constructor as follows
obj = vtkGraphLayoutFilter
34.102.2
Methods
The class vtkGraphLayoutFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGraphLayoutFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGraphLayoutFilter = obj.NewInstance ()
vtkGraphLayoutFilter = obj.SafeDownCast (vtkObject o)
obj.SetGraphBounds (double , double , double , double , double , double
) - Set / get the region in space in which to place the final graph. The GraphBounds only affects the results if
AutomaticBoundsComputation is off.
obj.SetGraphBounds (double a[6]) - Set / get the region in space in which to place the final
graph. The GraphBounds only affects the results if AutomaticBoundsComputation is off.
double = obj. GetGraphBounds () - Set / get the region in space in which to place the final
graph. The GraphBounds only affects the results if AutomaticBoundsComputation is off.
obj.SetAutomaticBoundsComputation (int ) - Turn on/off automatic graph bounds calculation. If this boolean is off, then the manually specified GraphBounds is used. If on, then the inputs bounds us
used as the graph bounds.
int = obj.GetAutomaticBoundsComputation () - Turn on/off automatic graph bounds calculation. If this boolean is off, then the manually specified GraphBounds is used. If on, then the inputs bounds
us used as the graph bounds.
obj.AutomaticBoundsComputationOn () - Turn on/off automatic graph bounds calculation. If this
boolean is off, then the manually specified GraphBounds is used. If on, then the inputs bounds us used as
the graph bounds.
obj.AutomaticBoundsComputationOff () - Turn on/off automatic graph bounds calculation. If
this boolean is off, then the manually specified GraphBounds is used. If on, then the inputs bounds us used
as the graph bounds.
obj.SetMaxNumberOfIterations (int ) - Set/Get the maximum number of iterations to be used.
The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph
gets modified.
int = obj.GetMaxNumberOfIterationsMinValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1222
int = obj.GetMaxNumberOfIterationsMaxValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified.
int = obj.GetMaxNumberOfIterations () - Set/Get the maximum number of iterations to be
used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the
graph gets modified.
obj.SetCoolDownRate (double ) - Set/Get the Cool-down rate. The higher this number is, the
longer it will take to "cool-down", and thus, the more the graph will be modified.
double = obj.GetCoolDownRateMinValue () - Set/Get the Cool-down rate. The higher this
number is, the longer it will take to "cool-down", and thus, the more the graph will be modified.
double = obj.GetCoolDownRateMaxValue () - Set/Get the Cool-down rate. The higher this
number is, the longer it will take to "cool-down", and thus, the more the graph will be modified.
double = obj.GetCoolDownRate () - Set/Get the Cool-down rate. The higher this number is, the
longer it will take to "cool-down", and thus, the more the graph will be modified.
obj.SetThreeDimensionalLayout (int )
int = obj.GetThreeDimensionalLayout ()
obj.ThreeDimensionalLayoutOn ()
obj.ThreeDimensionalLayoutOff ()
34.103
vtkGraphToPoints
34.103.1
Usage
Converts a vtkGraph to a vtkPolyData containing a set of points. This assumes that the points of the graph have
already been filled (perhaps by vtkGraphLayout). The vertex data is passed along to the point data.
To create an instance of class vtkGraphToPoints, simply invoke its constructor as follows
obj = vtkGraphToPoints
34.103.2
Methods
The class vtkGraphToPoints has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGraphToPoints class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGraphToPoints = obj.NewInstance ()
vtkGraphToPoints = obj.SafeDownCast (vtkObject o)
34.104
vtkGraphToPolyData
34.105 vtkGridSynchronizedTemplates3D
34.104.1
1223
Usage
Converts a vtkGraph to a vtkPolyData. This assumes that the points of the graph have already been filled (perhaps
by vtkGraphLayout), and coverts all the edge of the graph into lines in the polydata. The vertex data is passed along
to the point data, and the edge data is passed along to the cell data.
Only the owned graph edges (i.e. edges with ghost level 0) are copied into the vtkPolyData.
To create an instance of class vtkGraphToPolyData, simply invoke its constructor as follows
obj = vtkGraphToPolyData
34.104.2
Methods
The class vtkGraphToPolyData has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGraphToPolyData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGraphToPolyData = obj.NewInstance ()
vtkGraphToPolyData = obj.SafeDownCast (vtkObject o)
obj.SetEdgeGlyphOutput (bool ) - Create a second output containing points and orientation vectors for drawing arrows or other glyphs on edges. This output should be set as the first input to vtkGlyph3D
to place glyphs on the edges. vtkGlyphSource2Ds VTK_EDGEARROW_GLYPH provides a good glyph for
drawing arrows. Default value is off.
bool = obj.GetEdgeGlyphOutput () - Create a second output containing points and orientation
vectors for drawing arrows or other glyphs on edges. This output should be set as the first input to vtkGlyph3D
to place glyphs on the edges. vtkGlyphSource2Ds VTK_EDGEARROW_GLYPH provides a good glyph for
drawing arrows. Default value is off.
obj.EdgeGlyphOutputOn () - Create a second output containing points and orientation vectors for
drawing arrows or other glyphs on edges. This output should be set as the first input to vtkGlyph3D to place
glyphs on the edges. vtkGlyphSource2Ds VTK_EDGEARROW_GLYPH provides a good glyph for drawing
arrows. Default value is off.
obj.EdgeGlyphOutputOff () - Create a second output containing points and orientation vectors for
drawing arrows or other glyphs on edges. This output should be set as the first input to vtkGlyph3D to place
glyphs on the edges. vtkGlyphSource2Ds VTK_EDGEARROW_GLYPH provides a good glyph for drawing
arrows. Default value is off.
obj.SetEdgeGlyphPosition (double ) - The position of the glyph point along the edge. 0 puts a
glyph point at the source of each edge. 1 puts a glyph point at the target of each edge. An intermediate value
will place the glyph point between the source and target. The default value is 1.
double = obj.GetEdgeGlyphPosition () - The position of the glyph point along the edge. 0 puts
a glyph point at the source of each edge. 1 puts a glyph point at the target of each edge. An intermediate
value will place the glyph point between the source and target. The default value is 1.
34.105
vtkGridSynchronizedTemplates3D
1224
34.105.1
Usage
34.105.2
Methods
The class vtkGridSynchronizedTemplates3D has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGridSynchronizedTemplates3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGridSynchronizedTemplates3D = obj.NewInstance ()
vtkGridSynchronizedTemplates3D = obj.SafeDownCast (vtkObject o)
long = obj.GetMTime () - Because we delegate to vtkContourValues
obj.SetComputeNormals (int ) - Set/Get the computation of normals. Normal computation is fairly
expensive in both time and storage. If the output data will be processed by filters that modify topology or
geometry, it may be wise to turn Normals and Gradients off.
int = obj.GetComputeNormals () - Set/Get the computation of normals. Normal computation is
fairly expensive in both time and storage. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeNormalsOn () - Set/Get the computation of normals. Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or geometry,
it may be wise to turn Normals and Gradients off.
obj.ComputeNormalsOff () - Set/Get the computation of normals. Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or
geometry, it may be wise to turn Normals and Gradients off.
obj.SetComputeGradients (int ) - Set/Get the computation of gradients. Gradient computation
is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be
calculated, but will not be stored in the output dataset. If the output data will be processed by filters that
modify topology or geometry, it may be wise to turn Normals and Gradients off.
int = obj.GetComputeGradients () - Set/Get the computation of gradients. Gradient computation is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to
be calculated, but will not be stored in the output dataset. If the output data will be processed by filters that
modify topology or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeGradientsOn () - Set/Get the computation of gradients. Gradient computation is fairly
expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated,
but will not be stored in the output dataset. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeGradientsOff () - Set/Get the computation of gradients. Gradient computation is fairly
expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated,
but will not be stored in the output dataset. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.SetComputeScalars (int ) - Set/Get the computation of scalars.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.106 vtkHedgeHog
1225
34.106
vtkHedgeHog
34.106.1
Usage
vtkHedgeHog creates oriented lines from the input data set. Line length is controlled by vector (or normal) magnitude
times scale factor. If VectorMode is UseNormal, normals determine the orientation of the lines. Lines are colored
by scalar data, if available.
To create an instance of class vtkHedgeHog, simply invoke its constructor as follows
obj = vtkHedgeHog
34.106.2
Methods
The class vtkHedgeHog has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkHedgeHog class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHedgeHog = obj.NewInstance ()
vtkHedgeHog = obj.SafeDownCast (vtkObject o)
obj.SetScaleFactor (double ) - Set scale factor to control size of oriented lines.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1226
34.107
vtkHierarchicalDataExtractDataSets
34.107.1
Usage
34.107.2
Methods
The class vtkHierarchicalDataExtractDataSets has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHierarchicalDataExtractDataSets class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHierarchicalDataExtractDataSets = obj.NewInstance ()
vtkHierarchicalDataExtractDataSets = obj.SafeDownCast (vtkObject o)
34.108
vtkHierarchicalDataExtractLevel
34.108.1
Usage
34.109 vtkHierarchicalDataLevelFilter
34.108.2
1227
Methods
The class vtkHierarchicalDataExtractLevel has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHierarchicalDataExtractLevel class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHierarchicalDataExtractLevel = obj.NewInstance ()
vtkHierarchicalDataExtractLevel = obj.SafeDownCast (vtkObject o)
34.109
vtkHierarchicalDataLevelFilter
34.109.1
Usage
34.109.2
Methods
The class vtkHierarchicalDataLevelFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHierarchicalDataLevelFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHierarchicalDataLevelFilter = obj.NewInstance ()
vtkHierarchicalDataLevelFilter = obj.SafeDownCast (vtkObject o)
34.110
vtkHierarchicalDataSetGeometryFilter
34.110.1
Usage
1228
34.110.2
Methods
The class vtkHierarchicalDataSetGeometryFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHierarchicalDataSetGeometryFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHierarchicalDataSetGeometryFilter = obj.NewInstance ()
vtkHierarchicalDataSetGeometryFilter = obj.SafeDownCast (vtkObject o)
34.111
vtkHull
34.111.1
Usage
vtkHull is a filter which will produce an n-sided convex hull given a set of n planes. (The convex hull bounds the input
polygonal data.) The hull is generated by squeezing the planes towards the input vtkPolyData, until the planes just
touch the vtkPolyData. Then, the resulting planes are used to generate a polyhedron (i.e., hull) that is represented
by triangles.
The n planes can be defined in a number of ways including 1) manually specifying each plane; 2) choosing the six
face planes of the inputs bounding box; 3) choosing the eight vertex planes of the inputs bounding box; 4) choosing
the twelve edge planes of the inputs bounding box; and/or 5) using a recursively subdivided octahedron. Note that
when specifying planes, the plane normals should point outside of the convex region.
The output of this filter can be used in combination with vtkLODActor to represent a levels-of-detail in the LOD
hierarchy. Another use of this class is to manually specify the planes, and then generate the polyhedron from the
planes (without squeezing the planes towards the input). The method GenerateHull() is used to do this.
To create an instance of class vtkHull, simply invoke its constructor as follows
obj = vtkHull
34.111.2
Methods
The class vtkHull has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkHull class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHull = obj.NewInstance ()
vtkHull = obj.SafeDownCast (vtkObject o)
obj.RemoveAllPlanes (void ) - Remove all planes from the current set of planes.
int = obj.AddPlane (double A, double B, double C) - Add a plane to the current set of
planes. It will be added at the end of the list, and an index that can later be used to set this planes normal
will be returned. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does
not have to have unit length (but it must have a non-zero length!). If a value 0 > i >= -NumberOfPlanes is
returned, then the plane is parallel with a previously inserted plane, and |-i-1| is the index of the plane that
was previously inserted. If a value i < -NumberOfPlanes is returned, then the plane normal is zero length.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.111 vtkHull
1229
int = obj.AddPlane (double plane[3]) - Add a plane to the current set of planes. It will be
added at the end of the list, and an index that can later be used to set this planes normal will be returned.
The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit
length (but it must have a non-zero length!). If a value 0 > i >= -NumberOfPlanes is returned, then the plane
is parallel with a previously inserted plane, and |-i-1| is the index of the plane that was previously inserted. If
a value i < -NumberOfPlanes is returned, then the plane normal is zero length.
obj.SetPlane (int i, double A, double B, double C) - Set the normal values for plane
i. This is a plane that was already added to the current set of planes with AddPlane(), and is now being
modified. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to
have unit length. Note that D is set to zero, except in the case of the method taking a vtkPlanes argument,
where it is set to the D value defined there.
obj.SetPlane (int i, double plane[3]) - Set the normal values for plane i. This is a plane
that was already added to the current set of planes with AddPlane(), and is now being modified. The values
A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit length.
Note that D is set to zero, except in the case of the method taking a vtkPlanes argument, where it is set to
the D value defined there.
int = obj.AddPlane (double A, double B, double C, double D) - Variations of
AddPlane()/SetPlane() that allow D to be set. These methods are used when GenerateHull() is used.
int = obj.AddPlane (double plane[3], double D) - Variations of AddPlane()/SetPlane()
that allow D to be set. These methods are used when GenerateHull() is used.
obj.SetPlane (int i, double A, double B, double C, double D) - Variations of
AddPlane()/SetPlane() that allow D to be set. These methods are used when GenerateHull() is used.
obj.SetPlane (int i, double plane[3], double D) - Variations of AddPlane()/SetPlane()
that allow D to be set. These methods are used when GenerateHull() is used.
obj.SetPlanes (vtkPlanes planes) - Set all the planes at once using a vtkPlanes implicit function. This also sets the D value, so it can be used with GenerateHull().
int = obj.GetNumberOfPlanes () - Get the number of planes in the current set of planes.
obj.AddCubeVertexPlanes () - Add the 8 planes that represent the vertices of a cube - the combination of the three face planes connecting to a vertex - (1,1,1), (1,1,-1), (1,-1,1), (1,-1,1), (-1,1,1), (-1,1,-1),
(-1,-1,1), (-1,-1-1).
obj.AddCubeEdgePlanes () - Add the 12 planes that represent the edges of a cube - halfway between
the two connecting face planes - (1,1,0), (-1,-1,0), (-1,1,0), (1,-1,0), (0,1,1), (0,-1,-1), (0,1,-1), (0,-1,1), (1,0,1),
(-1,0,-1), (1,0,-1), (-1,0,1)
obj.AddCubeFacePlanes () - Add the six planes that make up the faces of a cube - (1,0,0), (-1, 0, 0),
(0,1,0), (0,-1,0), (0,0,1), (0,0,-1)
obj.AddRecursiveSpherePlanes (int level) - Add the planes that represent the normals of
the vertices of a polygonal sphere formed by recursively subdividing the triangles in an octahedron. Each
triangle is subdivided by connecting the midpoints of the edges thus forming 4 smaller triangles. The level
indicates how many subdivisions to do with a level of 0 used to add the 6 planes from the original octahedron,
level 1 will add 18 planes, and so on.
obj.GenerateHull (vtkPolyData pd, double bounds) - A special method that is used to
generate a polyhedron directly from a set of n planes. The planes that are supplied by the user are not
squeezed towards the input data (in fact the user need not specify an input). To use this method, you must
provide an instance of vtkPolyData into which the points and cells defining the polyhedron are placed. You
must also provide a bounding box where you expect the resulting polyhedron to lie. This can be a very
generous fit, its only used to create the initial polygons that are eventually clipped.
obj.GenerateHull (vtkPolyData pd, double xmin, double xmax, double ymin,
double ymax, double zmin, double zmax) - A special method that is used to generate a polyhedron directly from a set of n planes. The planes that are supplied by the user are not squeezed towards
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1230
34.112
vtkHyperOctreeContourFilter
34.112.1
Usage
vtkContourFilter is a filter that takes as input any dataset and generates on output isosurfaces and/or isolines. The
exact form of the output depends upon the dimensionality of the input data. Data consisting of 3D cells will generate
isosurfaces, data consisting of 2D cells will generate isolines, and data with 1D or 0D cells will generate isopoints.
Combinations of output type are possible if the input dimension is mixed.
To use this filter you must specify one or more contour values. You can either use the method SetValue() to specify
each contour value, or use GenerateValues() to generate a series of evenly spaced contours. It is also possible
to accelerate the operation of this filter (at the cost of extra memory) by using a vtkScalarTree. A scalar tree is
used to quickly locate cells that contain a contour surface. This is especially effective if multiple contours are being
extracted. If you want to use a scalar tree, invoke the method UseScalarTreeOn().
To create an instance of class vtkHyperOctreeContourFilter, simply invoke its constructor as follows
obj = vtkHyperOctreeContourFilter
34.112.2
Methods
The class vtkHyperOctreeContourFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHyperOctreeContourFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHyperOctreeContourFilter = obj.NewInstance ()
vtkHyperOctreeContourFilter = obj.SafeDownCast (vtkObject o)
obj.SetValue (int i, double value) - Get the ith contour value.
double = obj.GetValue (int i) - Get a pointer to an array of contour values. There will be GetNumberOfContours() values in the list.
obj.GetValues (double contourValues) - Set the number of contours to place into the list. You
only really need to use this method to reduce list size. The method SetValue() will automatically increase list
size as needed.
obj.SetNumberOfContours (int number) - Get the number of contours in the list of contour
values.
int = obj.GetNumberOfContours () - Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.
obj.GenerateValues (int numContours, double range[2]) - Generate numContours
equally spaced contour values between specified range. Contour values will include min/max range values.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.113 vtkHyperOctreeCutter
1231
obj.GenerateValues (int numContours, double rangeStart, double rangeEnd) - Modified GetMTime Because we delegate to vtkContourValues
long = obj.GetMTime () - Modified GetMTime Because we delegate to vtkContourValues
obj.SetLocator (vtkIncrementalPointLocator locator) - Set / get a spatial locator for
merging points. By default, an instance of vtkMergePoints is used.
vtkIncrementalPointLocator = obj.GetLocator () - Set / get a spatial locator for merging
points. By default, an instance of vtkMergePoints is used.
obj.CreateDefaultLocator () - Create default locator. Used to create one when none is specified.
The locator is used to merge coincident points.
34.113
vtkHyperOctreeCutter
34.113.1
Usage
vtkHyperOctreeCutter is a filter to cut through data using any subclass of vtkImplicitFunction. That is, a polygonal
surface is created corresponding to the implicit function F(x,y,z) = value(s), where you can specify one or more
values used to cut with.
In VTK, cutting means reducing a cell of dimension N to a cut surface of dimension N-1. For example, a tetrahedron
when cut by a plane (i.e., vtkPlane implicit function) will generate triangles. (In comparison, clipping takes a N
dimensional cell and creates N dimension primitives.)
vtkHyperOctreeCutter is generally used to "slice-through" a dataset, generating a surface that can be visualized. It
is also possible to use vtkHyperOctreeCutter to do a form of volume rendering. vtkHyperOctreeCutter does this by
generating multiple cut surfaces (usually planes) which are ordered (and rendered) from back-to-front. The surfaces
are set translucent to give a volumetric rendering effect.
Note that data can be cut using either 1) the scalar values associated with the dataset or 2) an implicit function
associated with this class. By default, if an implicit function is set it is used to cut the data set, otherwise the dataset
scalars are used to perform the cut.
To create an instance of class vtkHyperOctreeCutter, simply invoke its constructor as follows
obj = vtkHyperOctreeCutter
34.113.2
Methods
The class vtkHyperOctreeCutter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHyperOctreeCutter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHyperOctreeCutter = obj.NewInstance ()
vtkHyperOctreeCutter = obj.SafeDownCast (vtkObject o)
obj.SetValue (int i, double value) - Get the ith contour value.
double = obj.GetValue (int i) - Get a pointer to an array of contour values. There will be GetNumberOfContours() values in the list.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1232
obj.GetValues (double contourValues) - Set the number of contours to place into the list. You
only really need to use this method to reduce list size. The method SetValue() will automatically increase list
size as needed.
obj.SetNumberOfContours (int number) - Get the number of contours in the list of contour
values.
int = obj.GetNumberOfContours () - Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.
obj.GenerateValues (int numContours, double range[2]) - Generate numContours
equally spaced contour values between specified range. Contour values will include min/max range values.
obj.GenerateValues (int numContours, double rangeStart, double rangeEnd) - Override GetMTime because we delegate to vtkContourValues and refer to vtkImplicitFunction.
long = obj.GetMTime () - Override GetMTime because we delegate to vtkContourValues and refer
to vtkImplicitFunction.
obj.SetCutFunction (vtkImplicitFunction )
vtkImplicitFunction = obj.GetCutFunction ()
obj.SetGenerateCutScalars (int ) - If this flag is enabled, then the output scalar values will be
interpolated from the implicit function values, and not the input scalar data.
int = obj.GetGenerateCutScalars () - If this flag is enabled, then the output scalar values will
be interpolated from the implicit function values, and not the input scalar data.
obj.GenerateCutScalarsOn () - If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
obj.GenerateCutScalarsOff () - If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
obj.SetLocator (vtkIncrementalPointLocator locator) - Specify a spatial locator for
merging points. By default, an instance of vtkMergePoints is used.
vtkIncrementalPointLocator = obj.GetLocator () - Specify a spatial locator for merging
points. By default, an instance of vtkMergePoints is used.
obj.SetSortBy (int ) - Set the sorting order for the generated polydata. There are two possibilities:
Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is
the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used
if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem
dependent. For most applications, the default order is fine (and faster).
Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses
with vtkPolyData output, verts and lines have lower cell ids than triangles.
int = obj.GetSortByMinValue () - Set the sorting order for the generated polydata. There are
two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are
processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order
should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is
very problem dependent. For most applications, the default order is fine (and faster).
Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses
with vtkPolyData output, verts and lines have lower cell ids than triangles.
int = obj.GetSortByMaxValue () - Set the sorting order for the generated polydata. There are
two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are
processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order
should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is
very problem dependent. For most applications, the default order is fine (and faster).
Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses
with vtkPolyData output, verts and lines have lower cell ids than triangles.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.114 vtkHyperOctreeDepth
1233
int = obj.GetSortBy () - Set the sorting order for the generated polydata. There are two
possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order
should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is
very problem dependent. For most applications, the default order is fine (and faster).
Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses
with vtkPolyData output, verts and lines have lower cell ids than triangles.
obj.SetSortByToSortByValue () - Set the sorting order for the generated polydata. There are two
possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed.
This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be
used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem
dependent. For most applications, the default order is fine (and faster).
Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses
with vtkPolyData output, verts and lines have lower cell ids than triangles.
obj.SetSortByToSortByCell () - Return the sorting procedure as a descriptive character string.
string = obj.GetSortByAsString () - Create default locator. Used to create one when none is
specified. The locator is used to merge coincident points.
obj.CreateDefaultLocator () - Create default locator. Used to create one when none is specified.
The locator is used to merge coincident points.
34.114
vtkHyperOctreeDepth
34.114.1
Usage
This filter returns a shallow copy of its input HyperOctree with a new data attribute field containing the depth of each
cell.
To create an instance of class vtkHyperOctreeDepth, simply invoke its constructor as follows
obj = vtkHyperOctreeDepth
34.114.2
Methods
The class vtkHyperOctreeDepth has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHyperOctreeDepth class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHyperOctreeDepth = obj.NewInstance ()
vtkHyperOctreeDepth = obj.SafeDownCast (vtkObject o)
34.115
vtkHyperOctreeDualGridContourFilter
1234
34.115.1
Usage
use of unsigned short to hold level index limits tree depth to 16.
To use this filter you must specify one or more contour values. You can either use the method SetValue() to specify
each contour value, or use GenerateValues() to generate a series of evenly spaced contours. It is also possible
to accelerate the operation of this filter (at the cost of extra memory) by using a vtkScalarTree. A scalar tree is
used to quickly locate cells that contain a contour surface. This is especially effective if multiple contours are being
extracted. If you want to use a scalar tree, invoke the method UseScalarTreeOn().
To create an instance of class vtkHyperOctreeDualGridContourFilter, simply invoke its constructor as follows
obj = vtkHyperOctreeDualGridContourFilter
34.115.2
Methods
The class vtkHyperOctreeDualGridContourFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHyperOctreeDualGridContourFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHyperOctreeDualGridContourFilter = obj.NewInstance ()
vtkHyperOctreeDualGridContourFilter = obj.SafeDownCast (vtkObject o)
obj.SetValue (int i, double value) - Get the ith contour value.
double = obj.GetValue (int i) - Get a pointer to an array of contour values. There will be GetNumberOfContours() values in the list.
obj.GetValues (double contourValues) - Set the number of contours to place into the list. You
only really need to use this method to reduce list size. The method SetValue() will automatically increase list
size as needed.
obj.SetNumberOfContours (int number) - Get the number of contours in the list of contour
values.
int = obj.GetNumberOfContours () - Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.
obj.GenerateValues (int numContours, double range[2]) - Generate numContours
equally spaced contour values between specified range. Contour values will include min/max range values.
obj.GenerateValues (int numContours, double rangeStart, double rangeEnd) - Modified GetMTime Because we delegate to vtkContourValues
long = obj.GetMTime () - Modified GetMTime Because we delegate to vtkContourValues
obj.SetLocator (vtkIncrementalPointLocator locator) - Set / get a spatial locator for
merging points. By default, an instance of vtkMergePoints is used.
vtkIncrementalPointLocator = obj.GetLocator () - Set / get a spatial locator for merging
points. By default, an instance of vtkMergePoints is used.
obj.CreateDefaultLocator () - Create default locator. Used to create one when none is specified.
The locator is used to merge coincident points.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.116 vtkHyperOctreeFractalSource
34.116
1235
vtkHyperOctreeFractalSource
34.116.1
Usage
34.116.2
Methods
The class vtkHyperOctreeFractalSource has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHyperOctreeFractalSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHyperOctreeFractalSource = obj.NewInstance ()
vtkHyperOctreeFractalSource = obj.SafeDownCast (vtkObject o)
int = obj.GetMaximumLevel () - Return the maximum number of levels of the hyperoctree.
Postcondition
positive_result: result>=1
obj.SetMaximumLevel (int levels) - Set the maximum number of levels of the hyperoctree. If
GetMinLevels()>=levels, GetMinLevels() is changed to levels-1.
Precondition
positive_levels: levels>=1
Postcondition
is_set: this->GetLevels()==levels
min_is_valid: this->GetMinLevels()<this->GetLevels()
obj.SetMinimumLevel (int level) - Return the minimal number of levels of systematic subdivision.
Postcondition
positive_result: result>=0
int = obj.GetMinimumLevel () - Return the minimal number of levels of systematic subdivision.
Postcondition
positive_result: result>=0
obj.SetProjectionAxes (int x, int y, int z) - Set the projection from the 4D space (4
parameters / 2 imaginary numbers) to the axes of the 3D Volume. 0=C_Real, 1=C_Imaginary, 2=X_Real,
4=X_Imaginary
obj.SetProjectionAxes (int a[3]) - Set the projection from the 4D space (4 parameters / 2
imaginary numbers) to the axes of the 3D Volume. 0=C_Real, 1=C_Imaginary, 2=X_Real, 4=X_Imaginary
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1236
int = obj. GetProjectionAxes () - Set the projection from the 4D space (4 parameters / 2
imaginary numbers) to the axes of the 3D Volume. 0=C_Real, 1=C_Imaginary, 2=X_Real, 4=X_Imaginary
obj.SetOriginCX (double , double , double , double ) - Imaginary and real value for
C (constant in equation) and X (initial value).
obj.SetOriginCX (double a[4]) - Imaginary and real value for C (constant in equation) and X
(initial value).
double = obj.
(initial value).
34.117
vtkHyperOctreeLimiter
34.117.1
Usage
This filter returns a lower resolution copy of its input vtkHyperOctree. It does a length/area/volume weighted averaging to obtain data at each cut point. Above the cut level, leaf attribute data is simply copied.
To create an instance of class vtkHyperOctreeLimiter, simply invoke its constructor as follows
obj = vtkHyperOctreeLimiter
34.118 vtkHyperOctreeSampleFunction
34.117.2
1237
Methods
The class vtkHyperOctreeLimiter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHyperOctreeLimiter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHyperOctreeLimiter = obj.NewInstance ()
vtkHyperOctreeLimiter = obj.SafeDownCast (vtkObject o)
int = obj.GetMaximumLevel () - Return the maximum number of levels of the hyperoctree.
obj.SetMaximumLevel (int levels) - Set the maximum number of levels of the hyperoctree.
34.118
vtkHyperOctreeSampleFunction
34.118.1
Usage
vtkHyperOctreeSampleFunction is a source object that evaluates an implicit function to drive the subdivision process. The user can specify the threshold over which a subdivision occurs, the maximum and minimum level of
subdivisions and the dimension of the hyperoctree.
To create an instance of class vtkHyperOctreeSampleFunction, simply invoke its constructor as follows
obj = vtkHyperOctreeSampleFunction
34.118.2
Methods
The class vtkHyperOctreeSampleFunction has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHyperOctreeSampleFunction class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHyperOctreeSampleFunction = obj.NewInstance ()
vtkHyperOctreeSampleFunction = obj.SafeDownCast (vtkObject o)
int = obj.GetLevels () - Return the maximum number of levels of the hyperoctree.
Postcondition
positive_result: result>=1
obj.SetLevels (int levels) - Set the maximum number of levels of the hyperoctree. If GetMinLevels()>=levels, GetMinLevels() is changed to levels-1.
Precondition
positive_levels: levels>=1
1238
obj.SetOrigin (double , double , double ) - Set the origin (position of corner (0,0,0) of
the root.
obj.SetOrigin (double a[3]) - Set the origin (position of corner (0,0,0) of the root.
double = obj. GetOrigin () - Set the origin (position of corner (0,0,0) of the root. Return the
origin (position of corner (0,0,0) ) of the root.
double = obj.GetWidth () - Return the length along the x-axis.
Postcondition
positive_result: result>0
obj.SetWidth (double width) - Set the length along the x-axis.
34.118 vtkHyperOctreeSampleFunction
1239
Precondition
positive_width: width>0
Postcondition
width_is_set: GetWidth()==width
double = obj.GetHeight () - Return the length along the y-axis.
Dimension()>=2
Postcondition
positive_result: result>0
obj.SetHeight (double height) - Set the length along the y-axis.
Dimension()>=2
Precondition
positive_height: height>0
Postcondition
height_is_set: GetHeight()==height
double = obj.GetDepth () - Return the length along the z-axis.
Dimension()>=3
Postcondition
positive_result: result>0
obj.SetDepth (double depth) - Return the length along the z-axis.
Dimension()>=3
Precondition
positive_depth: depth>0
Postcondition
depth_is_set: GetDepth()==depth
obj.SetImplicitFunction (vtkImplicitFunction ) - Specify the implicit function to use to
generate data.
vtkImplicitFunction = obj.GetImplicitFunction () - Specify the implicit function to use
to generate data.
obj.SetOutputScalarType (int ) - Set what type of scalar data this source should generate.
int = obj.GetOutputScalarType () - Set what type of scalar data this source should generate.
obj.SetOutputScalarTypeToDouble () - Set what type of scalar data this source should generate.
obj.SetOutputScalarTypeToFloat () - Set what type of scalar data this source should generate.
obj.SetOutputScalarTypeToLong () - Set what type of scalar data this source should generate.
obj.SetOutputScalarTypeToUnsignedLong () - Set what type of scalar data this source should
generate.
obj.SetOutputScalarTypeToInt () - Set what type of scalar data this source should generate.
obj.SetOutputScalarTypeToUnsignedInt () - Set what type of scalar data this source should
generate.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1240
obj.SetOutputScalarTypeToShort () - Set what type of scalar data this source should generate.
obj.SetOutputScalarTypeToUnsignedShort () - Set what type of scalar data this source
should generate.
obj.SetOutputScalarTypeToChar () - Set what type of scalar data this source should generate.
obj.SetOutputScalarTypeToUnsignedChar () - Return the MTime also considering the implicit
function.
long = obj.GetMTime () - Return the MTime also considering the implicit function.
34.119
vtkHyperOctreeSurfaceFilter
34.119.1
Usage
34.119.2
Methods
The class vtkHyperOctreeSurfaceFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHyperOctreeSurfaceFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHyperOctreeSurfaceFilter = obj.NewInstance ()
vtkHyperOctreeSurfaceFilter = obj.SafeDownCast (vtkObject o)
obj.SetMerging (int ) - Turn on/off merging of coincident points. Note that is merging is on, points
with different point attributes (e.g., normals) are merged, which may cause rendering artifacts.
int = obj.GetMerging () - Turn on/off merging of coincident points. Note that is merging is on,
points with different point attributes (e.g., normals) are merged, which may cause rendering artifacts.
obj.MergingOn () - Turn on/off merging of coincident points. Note that is merging is on, points with
different point attributes (e.g., normals) are merged, which may cause rendering artifacts.
obj.MergingOff () - Turn on/off merging of coincident points. Note that is merging is on, points with
different point attributes (e.g., normals) are merged, which may cause rendering artifacts.
obj.SetLocator (vtkIncrementalPointLocator locator) - Set / get a spatial locator for
merging points. By default an instance of vtkMergePoints is used.
vtkIncrementalPointLocator = obj.GetLocator () - Set / get a spatial locator for merging
points. By default an instance of vtkMergePoints is used.
long = obj.GetMTime () - Return the MTime also considering the locator.
obj.SetPassThroughCellIds (int ) - If on, the output polygonal dataset will have a celldata array
that holds the cell index of the original 3D cell that produced each output cell. This is useful for cell picking.
The default is off to conserve memory.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.120 vtkHyperOctreeToUniformGridFilter
1241
int = obj.GetPassThroughCellIds () - If on, the output polygonal dataset will have a celldata
array that holds the cell index of the original 3D cell that produced each output cell. This is useful for cell
picking. The default is off to conserve memory.
obj.PassThroughCellIdsOn () - If on, the output polygonal dataset will have a celldata array that
holds the cell index of the original 3D cell that produced each output cell. This is useful for cell picking. The
default is off to conserve memory.
obj.PassThroughCellIdsOff () - If on, the output polygonal dataset will have a celldata array that
holds the cell index of the original 3D cell that produced each output cell. This is useful for cell picking. The
default is off to conserve memory.
34.120
vtkHyperOctreeToUniformGridFilter
34.120.1
Usage
vtkHyperOctreeToUniformGridFilter creates a uniform grid with a resolution based on the number of levels of the
hyperoctree. Then, it copies celldata in each cell of the uniform grid that belongs to an actual leaf of the hyperoctree.
To create an instance of class vtkHyperOctreeToUniformGridFilter, simply invoke its constructor as follows
obj = vtkHyperOctreeToUniformGridFilter
34.120.2
Methods
The class vtkHyperOctreeToUniformGridFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkHyperOctreeToUniformGridFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHyperOctreeToUniformGridFilter = obj.NewInstance ()
vtkHyperOctreeToUniformGridFilter = obj.SafeDownCast (vtkObject o)
34.121
vtkHyperStreamline
34.121.1
Usage
vtkHyperStreamline is a filter that integrates through a tensor field to generate a hyperstreamline. The integration is
along the maximum eigenvector and the cross section of the hyperstreamline is defined by the two other eigenvectors. Thus the shape of the hyperstreamline is "tube-like", with the cross section being elliptical. Hyperstreamlines
are used to visualize tensor fields.
The starting point of a hyperstreamline can be defined in one of two ways. First, you may specify an initial position.
This is a x-y-z global coordinate. The second option is to specify a starting location. This is cellId, subId, and cell
parametric coordinates.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1242
The integration of the hyperstreamline occurs through the major eigenvector field. IntegrationStepLength controls
the step length within each cell (i.e., this is the fraction of the cell length). The length of the hyperstreamline
is controlled by MaximumPropagationDistance. This parameter is the length of the hyperstreamline in units of
distance. The tube itself is composed of many small sub-tubes - NumberOfSides controls the number of sides in
the tube, and StepLength controls the length of the sub-tubes.
Because hyperstreamlines are often created near regions of singularities, it is possible to control the scaling of the
tube cross section by using a logarithmic scale. Use LogScalingOn to turn this capability on. The Radius value
controls the initial radius of the tube.
To create an instance of class vtkHyperStreamline, simply invoke its constructor as follows
obj = vtkHyperStreamline
34.121.2
Methods
The class vtkHyperStreamline has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkHyperStreamline class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkHyperStreamline = obj.NewInstance ()
vtkHyperStreamline = obj.SafeDownCast (vtkObject o)
obj.SetStartLocation (vtkIdType cellId, int subId, double pcoords[3]) Specify the start of the hyperstreamline in the cell coordinate system. That is, cellId and subId (if composite
cell), and parametric coordinates.
obj.SetStartLocation (vtkIdType cellId, int subId, double r, double s,
double t) - Specify the start of the hyperstreamline in the cell coordinate system. That is, cellId and subId
(if composite cell), and parametric coordinates.
obj.SetStartPosition (double x[3]) - Specify the start of the hyperstreamline in the global
coordinate system. Starting from position implies that a search must be performed to find initial cell to start
integration from.
obj.SetStartPosition (double x, double y, double z) - Specify the start of the hyperstreamline in the global coordinate system. Starting from position implies that a search must be performed to
find initial cell to start integration from.
double = obj.GetStartPosition () - Get the start position of the hyperstreamline in global x-y-z
coordinates.
obj.SetMaximumPropagationDistance (double ) - Set / get the maximum length of the hyperstreamline expressed as absolute distance (i.e., arc length) value.
double = obj.GetMaximumPropagationDistanceMinValue () - Set / get the maximum
length of the hyperstreamline expressed as absolute distance (i.e., arc length) value.
double = obj.GetMaximumPropagationDistanceMaxValue () - Set / get the maximum
length of the hyperstreamline expressed as absolute distance (i.e., arc length) value.
double = obj.GetMaximumPropagationDistance () - Set / get the maximum length of the
hyperstreamline expressed as absolute distance (i.e., arc length) value.
obj.SetIntegrationEigenvector (int ) - Set / get the eigenvector field through which to ingrate. It is possible to integrate using the major, medium or minor eigenvector field. The major eigenvector is
the eigenvector whose corresponding eigenvalue is closest to positive infinity. The minor eigenvector is the
eigenvector whose corresponding eigenvalue is closest to negative infinity. The medium eigenvector is the
eigenvector whose corresponding eigenvalue is between the major and minor eigenvalues.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.121 vtkHyperStreamline
1243
1244
34.122 vtkIconGlyphFilter
1245
double = obj.GetRadius () - Set / get the initial tube radius. This is the maximum "elliptical" radius
at the beginning of the tube. Radius varies based on ratio of eigenvalues. Note that tube section is actually
elliptical and may become a point or line in cross section in some cases.
obj.SetLogScaling (int ) - Turn on/off logarithmic scaling. If scaling is on, the log base 10 of the
computed eigenvalues are used to scale the cross section radii.
int = obj.GetLogScaling () - Turn on/off logarithmic scaling. If scaling is on, the log base 10 of
the computed eigenvalues are used to scale the cross section radii.
obj.LogScalingOn () - Turn on/off logarithmic scaling. If scaling is on, the log base 10 of the computed
eigenvalues are used to scale the cross section radii.
obj.LogScalingOff () - Turn on/off logarithmic scaling. If scaling is on, the log base 10 of the computed eigenvalues are used to scale the cross section radii.
34.122
vtkIconGlyphFilter
34.122.1
Usage
vtkIconGlyphFilter takes in a vtkPointSet where each point corresponds to the center of an icon. Scalar integer data
must also be set to give each point an icon index. This index is a zero based row major index into an image that
contains a grid of icons. You must also set pixel Size of the icon image and the size of a particular icon.
To create an instance of class vtkIconGlyphFilter, simply invoke its constructor as follows
obj = vtkIconGlyphFilter
34.122.2
Methods
The class vtkIconGlyphFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkIconGlyphFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkIconGlyphFilter = obj.NewInstance ()
vtkIconGlyphFilter = obj.SafeDownCast (vtkObject o)
obj.SetIconSize (int , int ) - Specify the Width and Height, in pixels, of an icon in the icon
sheet
obj.SetIconSize (int a[2]) - Specify the Width and Height, in pixels, of an icon in the icon sheet
int = obj.
GetIconSize () - Specify the Width and Height, in pixels, of an icon in the icon sheet
obj.SetIconSheetSize (int , int ) - Specify the Width and Height, in pixels, of an icon in the
icon sheet
obj.SetIconSheetSize (int a[2]) - Specify the Width and Height, in pixels, of an icon in the icon
sheet
int = obj.
sheet
GetIconSheetSize () - Specify the Width and Height, in pixels, of an icon in the icon
1246
obj.SetUseIconSize (bool b) - Specify whether the Quad generated to place the icon on will be
either 1 x 1 or the dimensions specified by IconSize.
bool = obj.GetUseIconSize () - Specify whether the Quad generated to place the icon on will be
either 1 x 1 or the dimensions specified by IconSize.
obj.UseIconSizeOn () - Specify whether the Quad generated to place the icon on will be either 1 x 1
or the dimensions specified by IconSize.
obj.UseIconSizeOff () - Specify whether the Quad generated to place the icon on will be either 1 x
1 or the dimensions specified by IconSize.
obj.SetGravity (int ) - Specify if the input points define the center of the icon quad or one of top
right corner, top center, top left corner, center right, center, center center left, bottom right corner, bottom
center or bottom left corner.
int = obj.GetGravity () - Specify if the input points define the center of the icon quad or one of
top right corner, top center, top left corner, center right, center, center center left, bottom right corner, bottom
center or bottom left corner.
obj.SetGravityToTopRight () - Specify if the input points define the center of the icon quad or
one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner,
bottom center or bottom left corner.
obj.SetGravityToTopCenter () - Specify if the input points define the center of the icon quad or
one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner,
bottom center or bottom left corner.
obj.SetGravityToTopLeft () - Specify if the input points define the center of the icon quad or one
of top right corner, top center, top left corner, center right, center, center center left, bottom right corner,
bottom center or bottom left corner.
obj.SetGravityToCenterRight () - Specify if the input points define the center of the icon quad or
one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner,
bottom center or bottom left corner.
obj.SetGravityToCenterCenter () - Specify if the input points define the center of the icon quad
or one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner,
bottom center or bottom left corner.
obj.SetGravityToCenterLeft () - Specify if the input points define the center of the icon quad or
one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner,
bottom center or bottom left corner.
obj.SetGravityToBottomRight () - Specify if the input points define the center of the icon quad or
one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner,
bottom center or bottom left corner.
obj.SetGravityToBottomCenter () - Specify if the input points define the center of the icon quad
or one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner,
bottom center or bottom left corner.
obj.SetGravityToBottomLeft () - Specify if the input points define the center of the icon quad or
one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner,
bottom center or bottom left corner.
34.123
vtkIdFilter
34.124 vtkImageDataGeometryFilter
34.123.1
1247
Usage
vtkIdFilter is a filter to that generates scalars or field data using cell and point ids. That is, the point attribute data
scalars or field data are generated from the point ids, and the cell attribute data scalars or field data are generated
from the the cell ids.
Typically this filter is used with vtkLabeledDataMapper (and possibly vtkSelectVisiblePoints) to create labels for
points and cells, or labels for the point or cell data scalar values.
To create an instance of class vtkIdFilter, simply invoke its constructor as follows
obj = vtkIdFilter
34.123.2
Methods
The class vtkIdFilter has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkIdFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkIdFilter = obj.NewInstance ()
vtkIdFilter = obj.SafeDownCast (vtkObject o)
obj.SetPointIds (int ) - Enable/disable the generation of point ids. Default is on.
int = obj.GetPointIds () - Enable/disable the generation of point ids. Default is on.
obj.PointIdsOn () - Enable/disable the generation of point ids. Default is on.
obj.PointIdsOff () - Enable/disable the generation of point ids. Default is on.
obj.SetCellIds (int ) - Enable/disable the generation of point ids. Default is on.
int = obj.GetCellIds () - Enable/disable the generation of point ids. Default is on.
obj.CellIdsOn () - Enable/disable the generation of point ids. Default is on.
obj.CellIdsOff () - Enable/disable the generation of point ids. Default is on.
obj.SetFieldData (int ) - Set/Get the flag which controls whether to generate scalar data or field
data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Default is off.
int = obj.GetFieldData () - Set/Get the flag which controls whether to generate scalar data or
field data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Default is off.
obj.FieldDataOn () - Set/Get the flag which controls whether to generate scalar data or field data. If
this flag is off, scalar data is generated. Otherwise, field data is generated. Default is off.
obj.FieldDataOff () - Set/Get the flag which controls whether to generate scalar data or field data.
If this flag is off, scalar data is generated. Otherwise, field data is generated. Default is off.
obj.SetIdsArrayName (string ) - Set/Get the name of the Ids array if generated. By default the
Ids are named "vtkIdFilter_Ids", but this can be changed with this function.
string = obj.GetIdsArrayName () - Set/Get the name of the Ids array if generated. By default
the Ids are named "vtkIdFilter_Ids", but this can be changed with this function.
34.124
vtkImageDataGeometryFilter
1248
34.124.1
Usage
vtkImageDataGeometryFilter is a filter that extracts geometry from a structured points dataset. By specifying appropriate i-j-k indices (via the "Extent" instance variable), it is possible to extract a point, a line, a plane (i.e., image), or
a "volume" from dataset. (Since the output is of type polydata, the volume is actually a (n x m x o) region of points.)
The extent specification is zero-offset. That is, the first k-plane in a 50x50x50 volume is given by (0,49, 0,49, 0,0).
To create an instance of class vtkImageDataGeometryFilter, simply invoke its constructor as follows
obj = vtkImageDataGeometryFilter
34.124.2
Methods
The class vtkImageDataGeometryFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageDataGeometryFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageDataGeometryFilter = obj.NewInstance ()
vtkImageDataGeometryFilter = obj.SafeDownCast (vtkObject o)
obj.SetExtent (int extent[6]) - Set / get the extent (imin,imax, jmin,jmax, kmin,kmax) indices.
obj.SetExtent (int iMin, int iMax, int jMin, int jMax, int kMin, int kMax) - Set / get the extent (imin,imax, jmin,jmax, kmin,kmax) indices.
obj.SetThresholdCells (int ) - Set ThresholdCells to true if you wish to skip any voxel/pixels
which have scalar values less than the specified threshold. Currently this functionality is only implemented
for 2D imagedata
int = obj.GetThresholdCells () - Set ThresholdCells to true if you wish to skip any voxel/pixels
which have scalar values less than the specified threshold. Currently this functionality is only implemented
for 2D imagedata
obj.ThresholdCellsOn () - Set ThresholdCells to true if you wish to skip any voxel/pixels which
have scalar values less than the specified threshold. Currently this functionality is only implemented for 2D
imagedata
obj.ThresholdCellsOff () - Set ThresholdCells to true if you wish to skip any voxel/pixels which
have scalar values less than the specified threshold. Currently this functionality is only implemented for 2D
imagedata
obj.SetThresholdValue (double ) - Set ThresholdValue to the scalar value by which to threshhold cells when extracting geometry when ThresholdCells is true. Cells with scalar values greater than the
threshold will be output.
double = obj.GetThresholdValue () - Set ThresholdValue to the scalar value by which to
threshhold cells when extracting geometry when ThresholdCells is true. Cells with scalar values greater
than the threshold will be output.
obj.ThresholdValueOn () - Set ThresholdValue to the scalar value by which to threshhold cells when
extracting geometry when ThresholdCells is true. Cells with scalar values greater than the threshold will be
output.
obj.ThresholdValueOff () - Set ThresholdValue to the scalar value by which to threshhold cells
when extracting geometry when ThresholdCells is true. Cells with scalar values greater than the threshold
will be output.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.125 vtkImageMarchingCubes
1249
34.125
vtkImageMarchingCubes
34.125.1
Usage
vtkImageMarchingCubes is a filter that takes as input images (e.g., 3D image region) and generates on output one
or more isosurfaces. One or more contour values must be specified to generate the isosurfaces. Alternatively, you
can specify a min/max scalar range and the number of contours to generate a series of evenly spaced contour
values. This filter can stream, so that the entire volume need not be loaded at once. Streaming is controlled using
the instance variable InputMemoryLimit, which has units KBytes.
To create an instance of class vtkImageMarchingCubes, simply invoke its constructor as follows
obj = vtkImageMarchingCubes
34.125.2
Methods
The class vtkImageMarchingCubes has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageMarchingCubes
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageMarchingCubes = obj.NewInstance ()
vtkImageMarchingCubes = obj.SafeDownCast (vtkObject o)
obj.SetValue (int i, double value) - Methods to set contour values
double = obj.GetValue (int i) - Methods to set contour values
obj.GetValues (double contourValues) - Methods to set contour values
obj.SetNumberOfContours (int number) - Methods to set contour values
int = obj.GetNumberOfContours () - Methods to set contour values
obj.GenerateValues (int numContours, double range[2]) - Methods to set contour
values
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1250
obj.GenerateValues (int numContours, double rangeStart, double rangeEnd) - Methods to set contour values
long = obj.GetMTime () - Because we delegate to vtkContourValues & refer to vtkImplicitFunction
obj.SetComputeScalars (int ) - Set/Get the computation of scalars.
int = obj.GetComputeScalars () - Set/Get the computation of scalars.
obj.ComputeScalarsOn () - Set/Get the computation of scalars.
obj.ComputeScalarsOff () - Set/Get the computation of scalars.
obj.SetComputeNormals (int ) - Set/Get the computation of normals. Normal computation is fairly
expensive in both time and storage. If the output data will be processed by filters that modify topology or
geometry, it may be wise to turn Normals and Gradients off.
int = obj.GetComputeNormals () - Set/Get the computation of normals. Normal computation is
fairly expensive in both time and storage. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeNormalsOn () - Set/Get the computation of normals. Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or geometry,
it may be wise to turn Normals and Gradients off.
obj.ComputeNormalsOff () - Set/Get the computation of normals. Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or
geometry, it may be wise to turn Normals and Gradients off.
obj.SetComputeGradients (int ) - Set/Get the computation of gradients. Gradient computation
is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be
calculated, but will not be stored in the output dataset. If the output data will be processed by filters that
modify topology or geometry, it may be wise to turn Normals and Gradients off.
int = obj.GetComputeGradients () - Set/Get the computation of gradients. Gradient computation is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to
be calculated, but will not be stored in the output dataset. If the output data will be processed by filters that
modify topology or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeGradientsOn () - Set/Get the computation of gradients. Gradient computation is fairly
expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated,
but will not be stored in the output dataset. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeGradientsOff () - Set/Get the computation of gradients. Gradient computation is fairly
expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated,
but will not be stored in the output dataset. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
int = obj.GetLocatorPoint (int cellX, int cellY, int edge)
obj.AddLocatorPoint (int cellX, int cellY, int edge, int ptId)
obj.IncrementLocatorZ ()
obj.SetInputMemoryLimit (int ) - The InputMemoryLimit determines the chunk size (the number of slices requested at each iteration). The units of this limit is KiloBytes. For now, only the Z axis is
split.
int = obj.GetInputMemoryLimit () - The InputMemoryLimit determines the chunk size (the
number of slices requested at each iteration). The units of this limit is KiloBytes. For now, only the Z axis is
split.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.126 vtkImplicitTextureCoords
34.126
1251
vtkImplicitTextureCoords
34.126.1
Usage
vtkImplicitTextureCoords is a filter to generate 1D, 2D, or 3D texture coordinates from one, two, or three implicit
functions, respectively. In combinations with a vtkBooleanTexture map (or another texture map of your own creation),
the texture coordinates can be used to highlight (via color or intensity) or cut (via transparency) dataset geometry
without any complex geometric processing. (Note: the texture coordinates are referred to as r-s-t coordinates.)
The texture coordinates are automatically normalized to lie between (0,1). Thus, no matter what the implicit functions
evaluate to, the resulting texture coordinates lie between (0,1), with the zero implicit function value mapped to the
0.5 texture coordinates value. Depending upon the maximum negative/positive implicit function values, the full (0,1)
range may not be occupied (i.e., the positive/negative ranges are mapped using the same scale factor).
A boolean variable InvertTexture is available to flip the texture coordinates around 0.5 (value 1.0 becomes 0.0,
0.25->0.75). This is equivalent to flipping the texture map (but a whole lot easier).
To create an instance of class vtkImplicitTextureCoords, simply invoke its constructor as follows
obj = vtkImplicitTextureCoords
34.126.2
Methods
The class vtkImplicitTextureCoords has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImplicitTextureCoords
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImplicitTextureCoords = obj.NewInstance ()
vtkImplicitTextureCoords = obj.SafeDownCast (vtkObject o)
obj.SetRFunction (vtkImplicitFunction ) - Specify an implicit function to compute the r texture coordinate.
vtkImplicitFunction = obj.GetRFunction () - Specify an implicit function to compute the r
texture coordinate.
obj.SetSFunction (vtkImplicitFunction ) - Specify an implicit function to compute the s
texture coordinate.
vtkImplicitFunction = obj.GetSFunction () - Specify an implicit function to compute the s
texture coordinate.
obj.SetTFunction (vtkImplicitFunction ) - Specify an implicit function to compute the t texture coordinate.
vtkImplicitFunction = obj.GetTFunction () - Specify an implicit function to compute the t
texture coordinate.
obj.SetFlipTexture (int ) - If enabled, this will flip the sense of inside and outside the implicit
function (i.e., a rotation around the r-s-t=0.5 axis).
int = obj.GetFlipTexture () - If enabled, this will flip the sense of inside and outside the implicit
function (i.e., a rotation around the r-s-t=0.5 axis).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1252
obj.FlipTextureOn () - If enabled, this will flip the sense of inside and outside the implicit function
(i.e., a rotation around the r-s-t=0.5 axis).
obj.FlipTextureOff () - If enabled, this will flip the sense of inside and outside the implicit function
(i.e., a rotation around the r-s-t=0.5 axis).
34.127
vtkInterpolateDataSetAttributes
34.127.1
Usage
vtkInterpolateDataSetAttributes is a filter that interpolates data set attribute values between input data sets. The
input to the filter must be datasets of the same type, same number of cells, and same number of points. The output
of the filter is a data set of the same type as the input dataset and whose attribute values have been interpolated at
the parametric value specified.
The filter is used by specifying two or more input data sets (total of N), and a parametric value t (0 <= t <= N-1).
The output will contain interpolated data set attributes common to all input data sets. (For example, if one input has
scalars and vectors, and another has just scalars, then only scalars will be interpolated and output.)
To create an instance of class vtkInterpolateDataSetAttributes, simply invoke its constructor as follows
obj = vtkInterpolateDataSetAttributes
34.127.2
Methods
The class vtkInterpolateDataSetAttributes has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInterpolateDataSetAttributes class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInterpolateDataSetAttributes = obj.NewInstance ()
vtkInterpolateDataSetAttributes = obj.SafeDownCast (vtkObject o)
vtkDataSetCollection = obj.GetInputList () - Return the list of inputs to this filter.
obj.SetT (double ) - Specify interpolation parameter t.
double = obj.GetTMinValue () - Specify interpolation parameter t.
double = obj.GetTMaxValue () - Specify interpolation parameter t.
double = obj.GetT () - Specify interpolation parameter t.
34.128
vtkInterpolatingSubdivisionFilter
34.129 vtkKdTreeSelector
34.128.1
1253
Usage
vtkInterpolatingSubdivisionFilter is an abstract class that defines the protocol for interpolating subdivision surface
filters.
To create an instance of class vtkInterpolatingSubdivisionFilter, simply invoke its constructor as follows
obj = vtkInterpolatingSubdivisionFilter
34.128.2
Methods
The class vtkInterpolatingSubdivisionFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkInterpolatingSubdivisionFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkInterpolatingSubdivisionFilter = obj.NewInstance ()
vtkInterpolatingSubdivisionFilter = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfSubdivisions (int ) - Set/get the number of subdivisions.
int = obj.GetNumberOfSubdivisions () - Set/get the number of subdivisions.
34.129
vtkKdTreeSelector
34.129.1
Usage
If SetKdTree is used, the filter ignores the input and selects based on that kd-tree. If SetKdTree is not used, the filter
builds a kd-tree using the input point set and uses that tree for selection. The output is a vtkSelection containing the
ids found in the kd-tree using the specified bounds.
To create an instance of class vtkKdTreeSelector, simply invoke its constructor as follows
obj = vtkKdTreeSelector
34.129.2
Methods
The class vtkKdTreeSelector has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkKdTreeSelector class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkKdTreeSelector = obj.NewInstance ()
vtkKdTreeSelector = obj.SafeDownCast (vtkObject o)
obj.SetKdTree (vtkKdTree tree) - The kd-tree to use to find selected ids. The kd-tree must be
initialized with the desired set of points. When this is set, the optional input is ignored.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1254
vtkKdTree = obj.GetKdTree () - The kd-tree to use to find selected ids. The kd-tree must be
initialized with the desired set of points. When this is set, the optional input is ignored.
obj.SetSelectionBounds (double , double , double , double , double ,
double ) - The bounds of the form (xmin,xmax,ymin,ymax,zmin,zmax). To perform a search in 2D,
use the bounds (xmin,xmax,ymin,ymax,VTK_DOUBLE_MIN,VTK_DOUBLE_MAX).
obj.SetSelectionBounds (double a[6]) - The bounds of the form (xmin,xmax,ymin,ymax,zmin,zmax).
To perform a search in 2D, use the bounds (xmin,xmax,ymin,ymax,VTK_DOUBLE_MIN,VTK_DOUBLE_MAX).
double = obj. GetSelectionBounds () - The bounds of the form (xmin,xmax,ymin,ymax,zmin,zmax).
To perform a search in 2D, use the bounds (xmin,xmax,ymin,ymax,VTK_DOUBLE_MIN,VTK_DOUBLE_MAX).
obj.SetSelectionFieldName (string ) - The field name to use when generating the selection.
If set, creates a VALUES selection. If not set (or is set to NULL), creates a INDICES selection. By default this
is not set.
string = obj.GetSelectionFieldName () - The field name to use when generating the selection. If set, creates a VALUES selection. If not set (or is set to NULL), creates a INDICES selection. By
default this is not set.
obj.SetSelectionAttribute (int ) - The field attribute to use when generating the selection.
If set, creates a PEDIGREEIDS or GLOBALIDS selection. If not set (or is set to -1), creates a INDICES selection. By default this is not set. NOTE: This should be set a constant in vtkDataSetAttributes, not
vtkSelection.
int = obj.GetSelectionAttribute () - The field attribute to use when generating the selection.
If set, creates a PEDIGREEIDS or GLOBALIDS selection. If not set (or is set to -1), creates a INDICES selection. By default this is not set. NOTE: This should be set a constant in vtkDataSetAttributes, not
vtkSelection.
obj.SetSingleSelection (bool ) - Whether to only allow up to one value in the result. The item
selected is closest to the center of the bounds, if there are any points within the selection threshold. Default
is off.
bool = obj.GetSingleSelection () - Whether to only allow up to one value in the result. The
item selected is closest to the center of the bounds, if there are any points within the selection threshold.
Default is off.
obj.SingleSelectionOn () - Whether to only allow up to one value in the result. The item selected
is closest to the center of the bounds, if there are any points within the selection threshold. Default is off.
obj.SingleSelectionOff () - Whether to only allow up to one value in the result. The item selected
is closest to the center of the bounds, if there are any points within the selection threshold. Default is off.
obj.SetSingleSelectionThreshold (double ) - The threshold for the single selection. A single point is added to the selection if it is within this threshold from the bounds center. Default is 1.
double = obj.GetSingleSelectionThreshold () - The threshold for the single selection. A
single point is added to the selection if it is within this threshold from the bounds center. Default is 1.
long = obj.GetMTime ()
34.130
vtkLevelIdScalars
34.131 vtkLinearExtrusionFilter
34.130.1
1255
Usage
vtkLevelIdScalars is a filter that generates scalars using the level number for each level. Note that all datasets within
a level get the same scalar. The new scalars array is named LevelIdScalars.
To create an instance of class vtkLevelIdScalars, simply invoke its constructor as follows
obj = vtkLevelIdScalars
34.130.2
Methods
The class vtkLevelIdScalars has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkLevelIdScalars class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkLevelIdScalars = obj.NewInstance ()
vtkLevelIdScalars = obj.SafeDownCast (vtkObject o)
34.131
vtkLinearExtrusionFilter
34.131.1
Usage
vtkLinearExtrusionFilter is a modeling filter. It takes polygonal data as input and generates polygonal data on output.
The input dataset is swept according to some extrusion function and creates new polygonal primitives. These
primitives form a "skirt" or swept surface. For example, sweeping a line results in a quadrilateral, and sweeping a
triangle creates a "wedge".
There are a number of control parameters for this filter. You can control whether the sweep of a 2D object (i.e.,
polygon or triangle strip) is capped with the generating geometry via the "Capping" ivar. Also, you can extrude in the
direction of a user specified vector, towards a point, or in the direction of vertex normals (normals must be provided use vtkPolyDataNormals if necessary). The amount of extrusion is controlled by the "ScaleFactor" instance variable.
The skirt is generated by locating certain topological features. Free edges (edges of polygons or triangle strips only
used by one polygon or triangle strips) generate surfaces. This is true also of lines or polylines. Vertices generate
lines.
This filter can be used to create 3D fonts, 3D irregular bar charts, or to model 2 1/2D objects like punched plates. It
also can be used to create solid objects from 2D polygonal meshes.
To create an instance of class vtkLinearExtrusionFilter, simply invoke its constructor as follows
obj = vtkLinearExtrusionFilter
34.131.2
Methods
The class vtkLinearExtrusionFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkLinearExtrusionFilter
class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1256
34.132
vtkLinearSubdivisionFilter
34.132.1
Usage
vtkLinearSubdivisionFilter is a filter that generates output by subdividing its input polydata. Each subdivision iteration
create 4 new triangles for each triangle in the polydata.
To create an instance of class vtkLinearSubdivisionFilter, simply invoke its constructor as follows
obj = vtkLinearSubdivisionFilter
34.133 vtkLineSource
34.132.2
1257
Methods
The class vtkLinearSubdivisionFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkLinearSubdivisionFilter
class.
string = obj.GetClassName () - Construct object with NumberOfSubdivisions set to 1.
int = obj.IsA (string name) - Construct object with NumberOfSubdivisions set to 1.
vtkLinearSubdivisionFilter = obj.NewInstance () - Construct object with NumberOfSubdivisions set to 1.
vtkLinearSubdivisionFilter = obj.SafeDownCast (vtkObject o) - Construct object
with NumberOfSubdivisions set to 1.
34.133
vtkLineSource
34.133.1
Usage
vtkLineSource is a source object that creates a polyline defined by two endpoints. The number of segments composing the polyline is controlled by setting the object resolution.
To create an instance of class vtkLineSource, simply invoke its constructor as follows
obj = vtkLineSource
34.133.2
Methods
The class vtkLineSource has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkLineSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkLineSource = obj.NewInstance ()
vtkLineSource = obj.SafeDownCast (vtkObject o)
obj.SetPoint1 (double , double , double ) - Set position of first end point.
obj.SetPoint1 (double a[3]) - Set position of first end point.
double = obj.
1258
34.134
vtkLinkEdgels
34.134.1
Usage
vtkLinkEdgels links edgels into digital curves which are then stored as polylines. The algorithm works one pixel at
a time only looking at its immediate neighbors. There is a GradientThreshold that can be set that eliminates any
pixels with a smaller gradient value. This can be used as the lower threshold of a two value edgel thresholding.
For the remaining edgels, links are first tried for the four connected neighbors. A successful neighbor will satisfy
three tests. First both edgels must be above the gradient threshold. Second, the difference between the orientation
between the two edgels (Alpha) and each edgels orientation (Phi) must be less than LinkThreshold. Third, the
difference between the two edgels Phi values must be less than PhiThreshold. The most successful link is selected.
The measure is simply the sum of the three angle differences (actually stored as the sum of the cosines). If none of
the four connect neighbors succeeds, then the eight connect neighbors are examined using the same method.
This filter requires gradient information so you will need to use a vtkImageGradient at some point prior to this filter.
Typically a vtkNonMaximumSuppression filter is also used. vtkThresholdEdgels can be used to complete the two
value edgel thresholding as used in a Canny edge detector. The vtkSubpixelPositionEdgels filter can also be used
after this filter to adjust the edgel locations.
To create an instance of class vtkLinkEdgels, simply invoke its constructor as follows
obj = vtkLinkEdgels
34.134.2
Methods
The class vtkLinkEdgels has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkLinkEdgels class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkLinkEdgels = obj.NewInstance ()
vtkLinkEdgels = obj.SafeDownCast (vtkObject o)
obj.SetLinkThreshold (double ) - Set/Get the threshold for Phi vs. Alpha link thresholding.
double = obj.GetLinkThreshold () - Set/Get the threshold for Phi vs. Alpha link thresholding.
obj.SetPhiThreshold (double ) - Set/get the threshold for Phi vs. Phi link thresholding.
double = obj.GetPhiThreshold () - Set/get the threshold for Phi vs. Phi link thresholding.
obj.SetGradientThreshold (double ) - Set/Get the threshold for image gradient thresholding.
double = obj.GetGradientThreshold () - Set/Get the threshold for image gradient thresholding.
34.135
vtkLoopSubdivisionFilter
34.136 vtkMarchingContourFilter
34.135.1
1259
Usage
vtkLoopSubdivisionFilter is an approximating subdivision scheme that creates four new triangles for each triangle
in the mesh. The user can specify the NumberOfSubdivisions. Loops subdivision scheme is described in: Loop,
C., "Smooth Subdivision surfaces based on triangles,", Masters Thesis, University of Utah, August 1987. For a nice
summary of the technique see, Hoppe, H., et. al, "Piecewise Smooth Surface Reconstruction,:, Proceedings of
Siggraph 94 (Orlando, Florida, July 24-29, 1994). In COmputer Graphics Proceedings, Annual COnference Series,
1994, ACM SIGGRAPH, pp. 295-302.
The filter only operates on triangles. Users should use the vtkTriangleFilter to triangulate meshes that contain
polygons or triangle strips.
The filter approximates point data using the same scheme. New triangles create at a subdivision step will have the
cell data of their parent cell.
To create an instance of class vtkLoopSubdivisionFilter, simply invoke its constructor as follows
obj = vtkLoopSubdivisionFilter
34.135.2
Methods
The class vtkLoopSubdivisionFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkLoopSubdivisionFilter
class.
string = obj.GetClassName () - Construct object with NumberOfSubdivisions set to 1.
int = obj.IsA (string name) - Construct object with NumberOfSubdivisions set to 1.
vtkLoopSubdivisionFilter = obj.NewInstance () - Construct object with NumberOfSubdivisions set to 1.
vtkLoopSubdivisionFilter = obj.SafeDownCast (vtkObject o) - Construct object
with NumberOfSubdivisions set to 1.
34.136
vtkMarchingContourFilter
34.136.1
Usage
vtkMarchingContourFilter is a filter that takes as input any dataset and generates on output isosurfaces and/or
isolines. The exact form of the output depends upon the dimensionality of the input data. Data consisting of 3D
cells will generate isosurfaces, data consisting of 2D cells will generate isolines, and data with 1D or 0D cells will
generate isopoints. Combinations of output type are possible if the input dimension is mixed.
This filter will identify special dataset types (e.g., structured points) and use the appropriate specialized filter to
process the data. For examples, if the input dataset type is a volume, this filter will create an internal vtkMarchingCubes instance and use it. This gives much better performance.
To use this filter you must specify one or more contour values. You can either use the method SetValue() to specify
each contour value, or use GenerateValues() to generate a series of evenly spaced contours. It is also possible
to accelerate the operation of this filter (at the cost of extra memory) by using a vtkScalarTree. A scalar tree is
used to quickly locate cells that contain a contour surface. This is especially effective if multiple contours are being
extracted. If you want to use a scalar tree, invoke the method UseScalarTreeOn().
To create an instance of class vtkMarchingContourFilter, simply invoke its constructor as follows
obj = vtkMarchingContourFilter
1260
34.136.2
Methods
The class vtkMarchingContourFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMarchingContourFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMarchingContourFilter = obj.NewInstance ()
vtkMarchingContourFilter = obj.SafeDownCast (vtkObject o)
obj.SetValue (int i, double value) - Methods to set / get contour values.
double = obj.GetValue (int i) - Methods to set / get contour values.
obj.GetValues (double contourValues) - Methods to set / get contour values.
obj.SetNumberOfContours (int number) - Methods to set / get contour values.
int = obj.GetNumberOfContours () - Methods to set / get contour values.
obj.GenerateValues (int numContours, double range[2]) - Methods to set / get contour values.
obj.GenerateValues (int numContours, double rangeStart, double rangeEnd) - Methods to set / get contour values.
long = obj.GetMTime () - Modified GetMTime Because we delegate to vtkContourValues
obj.SetComputeNormals (int ) - Set/Get the computation of normals. Normal computation is fairly
expensive in both time and storage. If the output data will be processed by filters that modify topology or
geometry, it may be wise to turn Normals and Gradients off.
int = obj.GetComputeNormals () - Set/Get the computation of normals. Normal computation is
fairly expensive in both time and storage. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeNormalsOn () - Set/Get the computation of normals. Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or geometry,
it may be wise to turn Normals and Gradients off.
obj.ComputeNormalsOff () - Set/Get the computation of normals. Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or
geometry, it may be wise to turn Normals and Gradients off.
obj.SetComputeGradients (int ) - Set/Get the computation of gradients. Gradient computation
is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be
calculated, but will not be stored in the output dataset. If the output data will be processed by filters that
modify topology or geometry, it may be wise to turn Normals and Gradients off.
int = obj.GetComputeGradients () - Set/Get the computation of gradients. Gradient computation is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to
be calculated, but will not be stored in the output dataset. If the output data will be processed by filters that
modify topology or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeGradientsOn () - Set/Get the computation of gradients. Gradient computation is fairly
expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated,
but will not be stored in the output dataset. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.137 vtkMarchingCubes
1261
34.137
vtkMarchingCubes
34.137.1
Usage
vtkMarchingCubes is a filter that takes as input a volume (e.g., 3D structured point set) and generates on output
one or more isosurfaces. One or more contour values must be specified to generate the isosurfaces. Alternatively,
you can specify a min/max scalar range and the number of contours to generate a series of evenly spaced contour
values.
To create an instance of class vtkMarchingCubes, simply invoke its constructor as follows
obj = vtkMarchingCubes
34.137.2
Methods
The class vtkMarchingCubes has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkMarchingCubes class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMarchingCubes = obj.NewInstance ()
vtkMarchingCubes = obj.SafeDownCast (vtkObject o)
obj.SetValue (int i, double value)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1262
End)
long = obj.GetMTime ()
obj.SetComputeNormals (int ) - Set/Get the computation of normals. Normal computation is fairly
expensive in both time and storage. If the output data will be processed by filters that modify topology or
geometry, it may be wise to turn Normals and Gradients off.
int = obj.GetComputeNormals () - Set/Get the computation of normals. Normal computation is
fairly expensive in both time and storage. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeNormalsOn () - Set/Get the computation of normals. Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or geometry,
it may be wise to turn Normals and Gradients off.
obj.ComputeNormalsOff () - Set/Get the computation of normals. Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or
geometry, it may be wise to turn Normals and Gradients off.
obj.SetComputeGradients (int ) - Set/Get the computation of gradients. Gradient computation
is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be
calculated, but will not be stored in the output dataset. If the output data will be processed by filters that
modify topology or geometry, it may be wise to turn Normals and Gradients off.
int = obj.GetComputeGradients () - Set/Get the computation of gradients. Gradient computation is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to
be calculated, but will not be stored in the output dataset. If the output data will be processed by filters that
modify topology or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeGradientsOn () - Set/Get the computation of gradients. Gradient computation is fairly
expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated,
but will not be stored in the output dataset. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeGradientsOff () - Set/Get the computation of gradients. Gradient computation is fairly
expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated,
but will not be stored in the output dataset. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.SetComputeScalars (int ) - Set/Get the computation of scalars.
int = obj.GetComputeScalars () - Set/Get the computation of scalars.
obj.ComputeScalarsOn () - Set/Get the computation of scalars.
obj.ComputeScalarsOff () - Set/Get the computation of scalars.
obj.SetLocator (vtkIncrementalPointLocator locator) - Overide the default locator.
Useful for changing the number of bins for performance or specifying a more aggressive locator.
vtkIncrementalPointLocator = obj.GetLocator () - Overide the default locator. Useful for
changing the number of bins for performance or specifying a more aggressive locator.
obj.CreateDefaultLocator () - Create default locator. Used to create one when none is specified.
The locator is used to merge coincident points.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.138 vtkMarchingSquares
34.138
1263
vtkMarchingSquares
34.138.1
Usage
vtkMarchingSquares is a filter that takes as input a structured points set and generates on output one or more
isolines. One or more contour values must be specified to generate the isolines. Alternatively, you can specify a
min/max scalar range and the number of contours to generate a series of evenly spaced contour values.
To generate contour lines the input data must be of topological dimension 2 (i.e., an image). If not, you can use the
ImageRange ivar to select an image plane from an input volume. This avoids having to extract a plane first (using
vtkExtractSubVolume). The filter deals with this by first trying to use the input data directly, and if not a 2D image,
then uses the ImageRange ivar to reduce it to an image.
To create an instance of class vtkMarchingSquares, simply invoke its constructor as follows
obj = vtkMarchingSquares
34.138.2
Methods
The class vtkMarchingSquares has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkMarchingSquares class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMarchingSquares = obj.NewInstance ()
vtkMarchingSquares = obj.SafeDownCast (vtkObject o)
obj.SetImageRange (int [6]) - Set/Get the i-j-k index range which define a plane on which to
generate contour lines. Using this ivar it is possible to input a 3D volume directly and then generate contour
lines on one of the i-j-k planes, or a portion of a plane.
int = obj. GetImageRange () - Set/Get the i-j-k index range which define a plane on which to
generate contour lines. Using this ivar it is possible to input a 3D volume directly and then generate contour
lines on one of the i-j-k planes, or a portion of a plane.
obj.SetImageRange (int imin, int imax, int jmin, int jmax, int kmin,
int kmax) - Set/Get the i-j-k index range which define a plane on which to generate contour lines.
Using this ivar it is possible to input a 3D volume directly and then generate contour lines on one of the i-j-k
planes, or a portion of a plane.
obj.SetValue (int i, double value) - Methods to set contour values
double = obj.GetValue (int i) - Methods to set contour values
obj.GetValues (double contourValues) - Methods to set contour values
obj.SetNumberOfContours (int number) - Methods to set contour values
int = obj.GetNumberOfContours () - Methods to set contour values
obj.GenerateValues (int numContours, double range[2]) - Methods to set contour
values
obj.GenerateValues (int numContours, double rangeStart, double rangeEnd) - Methods to set contour values
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1264
34.139
vtkMaskFields
34.139.1
Usage
vtkMaskFields is used to mark which fields in the input dataset get copied to the output. The output will contain only
those fields marked as on by the filter.
To create an instance of class vtkMaskFields, simply invoke its constructor as follows
obj = vtkMaskFields
34.139.2
Methods
The class vtkMaskFields has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkMaskFields class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMaskFields = obj.NewInstance ()
vtkMaskFields = obj.SafeDownCast (vtkObject o)
obj.CopyFieldOn (int fieldLocation, string name) - Turn on/off the copying of the field
or specified by name. During the copying/passing, the following rules are followed for each array:
1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2.
2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array A field name and a location
must be specified. For example:
maskFields->CopyFieldOff(vtkMaskFields::CELL_DATA, "foo");
causes the field "foo" on the input cell data to not get copied to the output.
obj.CopyFieldOff (int fieldLocation, string name) - Turn on/off the copying of the attribute or specified by vtkDataSetAttributes:AttributeTypes. During the copying/passing, the following rules
are followed for each array:
1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2.
2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array An attribute type and a
location must be specified. For example:
maskFields->CopyAttributeOff(vtkMaskFields::POINT_DATA, vtkDataSetAttributes::SCALARS);
causes the scalars on the input point data to not get copied to the output.
obj.CopyAttributeOn (int attributeLocation, int attributeType) - Turn on/off
the copying of the attribute or specified by vtkDataSetAttributes:AttributeTypes. During the copying/passing,
the following rules are followed for each array:
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.140 vtkMaskPoints
1265
1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2.
2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array An attribute type and a
location must be specified. For example:
maskFields->CopyAttributeOff(vtkMaskFields::POINT_DATA, vtkDataSetAttributes::SCALARS);
causes the scalars on the input point data to not get copied to the output.
obj.CopyAttributeOff (int attributeLocation, int attributeType) - Convenience methods which operate on all field data or attribute data. More specific than CopyAllOn or CopyAllOff
obj.CopyFieldsOff () - Convenience methods which operate on all field data or attribute data. More
specific than CopyAllOn or CopyAllOff
obj.CopyAttributesOff ()
obj.CopyFieldsOn ()
obj.CopyAttributesOn () - Helper methods used by other language bindings. Allows the caller to
specify arguments as strings instead of enums.
obj.CopyAttributeOn (string attributeLoc, string attributeType) - Helper
methods used by other language bindings. Allows the caller to specify arguments as strings instead of
enums.
obj.CopyAttributeOff (string attributeLoc, string attributeType) - Helper
methods used by other language bindings. Allows the caller to specify arguments as strings instead of
enums.
obj.CopyFieldOn (string fieldLoc, string name) - Helper methods used by other language bindings. Allows the caller to specify arguments as strings instead of enums.
obj.CopyFieldOff (string fieldLoc, string name) - Helper methods used by other language bindings. Allows the caller to specify arguments as strings instead of enums.
obj.CopyAllOn () - Turn on copying of all data. During the copying/passing, the following rules are
followed for each array:
1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2.
2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
obj.CopyAllOff () - Turn off copying of all data. During the copying/passing, the following rules are
followed for each array:
1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2.
2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array
34.140
vtkMaskPoints
34.140.1
Usage
vtkMaskPoints is a filter that passes through points and point attributes from input dataset. (Other geometry is not
passed through.) It is possible to mask every nth point, and to specify an initial offset to begin masking from. A
special random mode feature enables random selection of points. The filter can also generate vertices (topological
primitives) as well as points. This is useful because vertices are rendered while points are not.
To create an instance of class vtkMaskPoints, simply invoke its constructor as follows
obj = vtkMaskPoints
1266
34.140.2
Methods
The class vtkMaskPoints has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkMaskPoints class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMaskPoints = obj.NewInstance ()
vtkMaskPoints = obj.SafeDownCast (vtkObject o)
obj.SetOnRatio (int ) - Turn on every nth point.
int = obj.GetOnRatioMinValue () - Turn on every nth point.
int = obj.GetOnRatioMaxValue () - Turn on every nth point.
int = obj.GetOnRatio () - Turn on every nth point.
obj.SetMaximumNumberOfPoints (vtkIdType ) - Limit the number of points that can be passed
through.
vtkIdType = obj.GetMaximumNumberOfPointsMinValue () - Limit the number of points
that can be passed through.
vtkIdType = obj.GetMaximumNumberOfPointsMaxValue () - Limit the number of points
that can be passed through.
vtkIdType = obj.GetMaximumNumberOfPoints () - Limit the number of points that can be
passed through.
obj.SetOffset (vtkIdType ) - Start with this point.
vtkIdType = obj.GetOffsetMinValue () - Start with this point.
vtkIdType = obj.GetOffsetMaxValue () - Start with this point.
vtkIdType = obj.GetOffset () - Start with this point.
obj.SetRandomMode (int ) - Special flag causes randomization of point selection. If this mode is
on, statistically every nth point (i.e., OnRatio) will be displayed.
int = obj.GetRandomMode () - Special flag causes randomization of point selection. If this mode is
on, statistically every nth point (i.e., OnRatio) will be displayed.
obj.RandomModeOn () - Special flag causes randomization of point selection. If this mode is on, statistically every nth point (i.e., OnRatio) will be displayed.
obj.RandomModeOff () - Special flag causes randomization of point selection. If this mode is on,
statistically every nth point (i.e., OnRatio) will be displayed.
obj.SetGenerateVertices (int ) - Generate output polydata vertices as well as points. A useful
convenience method because vertices are drawn (they are topology) while points are not (they are geometry).
By default this method is off.
int = obj.GetGenerateVertices () - Generate output polydata vertices as well as points. A
useful convenience method because vertices are drawn (they are topology) while points are not (they are
geometry). By default this method is off.
obj.GenerateVerticesOn () - Generate output polydata vertices as well as points. A useful convenience method because vertices are drawn (they are topology) while points are not (they are geometry). By
default this method is off.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.141 vtkMaskPolyData
1267
obj.GenerateVerticesOff () - Generate output polydata vertices as well as points. A useful convenience method because vertices are drawn (they are topology) while points are not (they are geometry).
By default this method is off.
obj.SetSingleVertexPerCell (int ) - When vertex generation is enabled, by default vertices
are produced as multi-vertex cells (more than one per cell), if you wish to have a single vertex per cell, enable
this flag.
int = obj.GetSingleVertexPerCell () - When vertex generation is enabled, by default vertices
are produced as multi-vertex cells (more than one per cell), if you wish to have a single vertex per cell, enable
this flag.
obj.SingleVertexPerCellOn () - When vertex generation is enabled, by default vertices are produced as multi-vertex cells (more than one per cell), if you wish to have a single vertex per cell, enable this
flag.
obj.SingleVertexPerCellOff () - When vertex generation is enabled, by default vertices are produced as multi-vertex cells (more than one per cell), if you wish to have a single vertex per cell, enable this
flag.
34.141
vtkMaskPolyData
34.141.1
Usage
vtkMaskPolyData is a filter that sub-samples the cells of input polygonal data. The user specifies every nth item,
with an initial offset to begin sampling.
To create an instance of class vtkMaskPolyData, simply invoke its constructor as follows
obj = vtkMaskPolyData
34.141.2
Methods
The class vtkMaskPolyData has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkMaskPolyData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMaskPolyData = obj.NewInstance ()
vtkMaskPolyData = obj.SafeDownCast (vtkObject o)
obj.SetOnRatio (int ) - Turn on every nth entity (cell).
int = obj.GetOnRatioMinValue () - Turn on every nth entity (cell).
int = obj.GetOnRatioMaxValue () - Turn on every nth entity (cell).
int = obj.GetOnRatio () - Turn on every nth entity (cell).
obj.SetOffset (vtkIdType ) - Start with this entity (cell).
vtkIdType = obj.GetOffsetMinValue () - Start with this entity (cell).
vtkIdType = obj.GetOffsetMaxValue () - Start with this entity (cell).
vtkIdType = obj.GetOffset () - Start with this entity (cell).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1268
34.142
vtkMassProperties
34.142.1
Usage
vtkMassProperties estimates the volume, the surface area, and the normalized shape index of a triangle mesh. The
algorithm implemented here is based on the discrete form of the divergence theorem. The general assumption here
is that the model is of closed surface. For more details see the following reference (Alyassin A.M. et al, "Evaluation
of new algorithms for the interactive measurement of surface area and volume", Med Phys 21(6) 1994.).
To create an instance of class vtkMassProperties, simply invoke its constructor as follows
obj = vtkMassProperties
34.142.2
Methods
The class vtkMassProperties has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkMassProperties class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMassProperties = obj.NewInstance ()
vtkMassProperties = obj.SafeDownCast (vtkObject o)
double = obj.GetVolume () - Compute and return the projected volume. Typically you should
compare this volume to the value returned by GetVolume if you get an error (GetVolume()-GetVolumeProjected())10000 that is greater than GetVolume() this should identify a problem: Either the polydata is
not closed Or the polydata contains triangle that are flipped
double = obj.GetVolumeProjected () - Compute and return the volume projected on to each
axis aligned plane.
double = obj.GetVolumeX () - Compute and return the volume projected on to each axis aligned
plane.
double = obj.GetVolumeY () - Compute and return the volume projected on to each axis aligned
plane.
double = obj.GetVolumeZ () - Compute and return the weighting factors for the maximum unit
normal component (MUNC).
double = obj.GetKx () - Compute and return the weighting factors for the maximum unit normal
component (MUNC).
double = obj.GetKy () - Compute and return the weighting factors for the maximum unit normal
component (MUNC).
double = obj.GetKz () - Compute and return the area.
double = obj.GetSurfaceArea () - Compute and return the min cell area.
double = obj.GetMinCellArea () - Compute and return the max cell area.
double = obj.GetMaxCellArea () - Compute and return the normalized shape index. This characterizes the deviation of the shape of an object from a sphere. A spheres NSI is one. This number is always
>= 1.0.
double = obj.GetNormalizedShapeIndex ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.143 vtkMergeCells
34.143
1269
vtkMergeCells
34.143.1
Usage
Designed to work with distributed vtkDataSets, this class will take vtkDataSets and merge them back into a single
vtkUnstructuredGrid.
The vtkPoints object of the unstructured grid will have data type VTK_FLOAT, regardless of the data type of the
points of the input vtkDataSets. If this is a problem, someone must let me know.
It is assumed the different DataSets have the same field arrays. If the name of a global point ID array is provided,
this class will refrain from including duplicate points in the merged Ugrid. This class differs from vtkAppendFilter in
these ways: (1) it uses less memory than that class (which uses memory equal to twice the size of the final Ugrid)
but requires that you know the size of the final Ugrid in advance (2) this class assumes the individual DataSets have
the same field arrays, while vtkAppendFilter intersects the field arrays (3) this class knows duplicate points may be
appearing in the DataSets and can filter those out, (4) this class is not a filter.
To create an instance of class vtkMergeCells, simply invoke its constructor as follows
obj = vtkMergeCells
34.143.2
Methods
The class vtkMergeCells has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkMergeCells class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMergeCells = obj.NewInstance ()
vtkMergeCells = obj.SafeDownCast (vtkObject o)
obj.SetUnstructuredGrid (vtkUnstructuredGrid )
vtkUnstructuredGrid = obj.GetUnstructuredGrid ()
obj.SetTotalNumberOfCells (vtkIdType )
vtkIdType = obj.GetTotalNumberOfCells ()
obj.SetTotalNumberOfPoints (vtkIdType )
vtkIdType = obj.GetTotalNumberOfPoints ()
obj.SetUseGlobalIds (int )
int = obj.GetUseGlobalIds ()
obj.SetPointMergeTolerance (float )
float = obj.GetPointMergeToleranceMinValue ()
float = obj.GetPointMergeToleranceMaxValue ()
float = obj.GetPointMergeTolerance ()
obj.SetUseGlobalCellIds (int )
int = obj.GetUseGlobalCellIds ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1270
obj.SetMergeDuplicatePoints (int )
int = obj.GetMergeDuplicatePoints ()
obj.MergeDuplicatePointsOn ()
obj.MergeDuplicatePointsOff ()
obj.SetTotalNumberOfDataSets (int )
int = obj.GetTotalNumberOfDataSets ()
int = obj.MergeDataSet (vtkDataSet set)
obj.Finish ()
34.144
vtkMergeDataObjectFilter
34.144.1
Usage
vtkMergeDataObjectFilter is a filter that merges the field from a vtkDataObject with a vtkDataSet. The resulting
combined dataset can then be processed by other filters (e.g., vtkFieldDataToAttributeDataFilter) to create attribute
data like scalars, vectors, etc.
The filter operates as follows. The field data from the vtkDataObject is merged with the inputs vtkDataSet and
then placed in the output. You can choose to place the field data into the cell data field, the point data field, or the
datasets field (i.e., the one inherited from vtkDataSets superclass vtkDataObject). All this data shuffling occurs via
reference counting, therefore memory is not copied.
One of the uses of this filter is to allow you to read/generate the structure of a dataset independent of the attributes.
So, for example, you could store the dataset geometry/topology in one file, and field data in another. Then use this
filter in combination with vtkFieldDataToAttributeData to create a dataset ready for processing in the visualization
pipeline.
To create an instance of class vtkMergeDataObjectFilter, simply invoke its constructor as follows
obj = vtkMergeDataObjectFilter
34.144.2
Methods
The class vtkMergeDataObjectFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMergeDataObjectFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMergeDataObjectFilter = obj.NewInstance ()
vtkMergeDataObjectFilter = obj.SafeDownCast (vtkObject o)
obj.SetDataObject (vtkDataObject object) - Specify the data object to merge with the input
dataset.
vtkDataObject = obj.GetDataObject () - Specify the data object to merge with the input
dataset.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.145 vtkMergeFields
1271
obj.SetOutputField (int ) - Specify where to place the field data during the merge process. There
are three choices: the field data associated with the vtkDataObject superclass; the point field attribute data;
and the cell field attribute data.
int = obj.GetOutputField () - Specify where to place the field data during the merge process.
There are three choices: the field data associated with the vtkDataObject superclass; the point field attribute
data; and the cell field attribute data.
obj.SetOutputFieldToDataObjectField () - Specify where to place the field data during the
merge process. There are three choices: the field data associated with the vtkDataObject superclass; the
point field attribute data; and the cell field attribute data.
obj.SetOutputFieldToPointDataField () - Specify where to place the field data during the
merge process. There are three choices: the field data associated with the vtkDataObject superclass; the
point field attribute data; and the cell field attribute data.
obj.SetOutputFieldToCellDataField () - Specify where to place the field data during the
merge process. There are three choices: the field data associated with the vtkDataObject superclass; the
point field attribute data; and the cell field attribute data.
34.145
vtkMergeFields
34.145.1
Usage
vtkMergeFields is used to merge mutliple field into one. The new field is put in the same field data as the original
field. For example
mf->SetOutputField("foo", vtkMergeFields::POINT_DATA);
mf->SetNumberOfComponents(2);
mf->Merge(0, "array1", 1);
mf->Merge(1, "array2", 0);
will tell vtkMergeFields to use the 2nd component of array1 and the 1st component of array2 to create a 2 component
field called foo. The same can be done using Tcl:
mf SetOutputField foo POINT_DATA
mf Merge 0 array1 1
mf Merge 1 array2 0
Field locations: DATA_OBJECT, POINT_DATA, CELL_DATA
34.145.2
Methods
The class vtkMergeFields has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkMergeFields class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMergeFields = obj.NewInstance ()
vtkMergeFields = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1272
obj.SetOutputField (string name, int fieldLoc) - The output field will have the given
name and it will be in fieldLoc (the input fields also have to be in fieldLoc).
obj.SetOutputField (string name, string fieldLoc) - Helper method used by the other
language bindings. Allows the caller to specify arguments as strings instead of enums.Returns an operation
id which can later be used to remove the operation.
obj.Merge (int component, string arrayName, int sourceComp) - Add a component
(arrayName,sourceComp) to the output field.
obj.SetNumberOfComponents (int ) - Set the number of the components in the output field. This
has to be set before execution. Default value is 0.
int = obj.GetNumberOfComponents () - Set the number of the components in the output field.
This has to be set before execution. Default value is 0.
34.146
vtkMergeFilter
34.146.1
Usage
vtkMergeFilter is a filter that extracts separate components of data from different datasets and merges them into a
single dataset. The output from this filter is of the same type as the input (i.e., vtkDataSet.) It treats both cell and
point data set attributes.
To create an instance of class vtkMergeFilter, simply invoke its constructor as follows
obj = vtkMergeFilter
34.146.2
Methods
The class vtkMergeFilter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkMergeFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMergeFilter = obj.NewInstance ()
vtkMergeFilter = obj.SafeDownCast (vtkObject o)
obj.SetGeometry (vtkDataSet input) - Specify object from which to extract geometry information. Old style. Use SetGeometryConnection() instead.
vtkDataSet = obj.GetGeometry () - Specify object from which to extract geometry information.
Old style. Use SetGeometryConnection() instead.
obj.SetGeometryConnection (vtkAlgorithmOutput algOutput) - Specify object from
which to extract scalar information. Old style. Use SetScalarsConnection() instead.
obj.SetScalars (vtkDataSet ) - Specify object from which to extract scalar information. Old style.
Use SetScalarsConnection() instead.
vtkDataSet = obj.GetScalars () - Specify object from which to extract scalar information. Old
style. Use SetScalarsConnection() instead.
obj.SetScalarsConnection (vtkAlgorithmOutput algOutput) - Set / get the object from
which to extract vector information. Old style. Use SetVectorsConnection() instead.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.147 vtkMeshQuality
1273
obj.SetVectors (vtkDataSet ) - Set / get the object from which to extract vector information. Old
style. Use SetVectorsConnection() instead.
vtkDataSet = obj.GetVectors () - Set / get the object from which to extract vector information.
Old style. Use SetVectorsConnection() instead.
obj.SetVectorsConnection (vtkAlgorithmOutput algOutput) - Set / get the object from
which to extract normal information. Old style. Use SetNormalsConnection() instead.
obj.SetNormals (vtkDataSet ) - Set / get the object from which to extract normal information. Old
style. Use SetNormalsConnection() instead.
vtkDataSet = obj.GetNormals () - Set / get the object from which to extract normal information.
Old style. Use SetNormalsConnection() instead.
obj.SetNormalsConnection (vtkAlgorithmOutput algOutput) - Set / get the object from
which to extract texture coordinates information. Old style. Use SetTCoordsConnection() instead.
obj.SetTCoords (vtkDataSet ) - Set / get the object from which to extract texture coordinates
information. Old style. Use SetTCoordsConnection() instead.
vtkDataSet = obj.GetTCoords () - Set / get the object from which to extract texture coordinates
information. Old style. Use SetTCoordsConnection() instead.
obj.SetTCoordsConnection (vtkAlgorithmOutput algOutput) - Set / get the object from
which to extract tensor data. Old style. Use SetTensorsConnection() instead.
obj.SetTensors (vtkDataSet ) - Set / get the object from which to extract tensor data. Old style.
Use SetTensorsConnection() instead.
vtkDataSet = obj.GetTensors () - Set / get the object from which to extract tensor data. Old
style. Use SetTensorsConnection() instead.
obj.SetTensorsConnection (vtkAlgorithmOutput algOutput) - Set the object from
which to extract a field and the name of the field. Note that this does not create pipeline connectivity.
obj.AddField (string name, vtkDataSet input) - Set the object from which to extract a
field and the name of the field. Note that this does not create pipeline connectivity.
34.147
vtkMeshQuality
34.147.1
Usage
vtkMeshQuality computes one or more functions of (geometric) quality for each 2-D and 3-D cell (triangle, quadrilateral, tetrahedron, or hexahedron) of a mesh. These functions of quality are then averaged over the entire mesh.
The minimum, average, maximum, and unbiased variance of quality for each type of cell is stored in the output
meshs FieldData. The FieldData arrays are named "Mesh Triangle Quality," "Mesh Quadrilateral Quality," "Mesh
Tetrahedron Quality," and "Mesh Hexahedron Quality." Each array has a single tuple with 5 components. The first 4
components are the quality statistics mentioned above; the final value is the number of cells of the given type. This
final component makes aggregation of statistics for distributed mesh data possible.
By default, the per-cell quality is added to the meshs cell data, in an array named "Quality." Cell types not supported
by this filter will have an entry of 0. Use SaveCellQualityOff() to store only the final statistics.
This version of the filter written by Philippe Pebay and David Thompson overtakes an older version written by Leila
Baghdadi, Hanif Ladak, and David Steinman at the Imaging Research Labs, Robarts Research Institute. That
version only supported tetrahedral radius ratio. See the CompatibilityModeOn() member for information on how to
make this filter behave like the previous implementation. For more information on the triangle quality functions of
this class, cf. Pebay & Baker 2003, Analysis of triangle quality measures, Math Comp 72:244. For more information
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1274
on the quadrangle quality functions of this class, cf. Pebay 2004, Planar Quadrangle Quality Measures, Eng Comp
20:2.
To create an instance of class vtkMeshQuality, simply invoke its constructor as follows
obj = vtkMeshQuality
34.147.2
Methods
The class vtkMeshQuality has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkMeshQuality class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMeshQuality = obj.NewInstance ()
vtkMeshQuality = obj.SafeDownCast (vtkObject o)
obj.SetSaveCellQuality (int ) - This variable controls whether or not cell quality is stored as
cell data in the resulting mesh or discarded (leaving only the aggregate quality average of the entire mesh,
recorded in the FieldData).
int = obj.GetSaveCellQuality () - This variable controls whether or not cell quality is stored as
cell data in the resulting mesh or discarded (leaving only the aggregate quality average of the entire mesh,
recorded in the FieldData).
obj.SaveCellQualityOn () - This variable controls whether or not cell quality is stored as cell data
in the resulting mesh or discarded (leaving only the aggregate quality average of the entire mesh, recorded
in the FieldData).
obj.SaveCellQualityOff () - This variable controls whether or not cell quality is stored as cell data
in the resulting mesh or discarded (leaving only the aggregate quality average of the entire mesh, recorded
in the FieldData).
obj.SetTriangleQualityMeasure (int ) - Set/Get the particular estimator used to function the
quality of triangles. The default is VTK_QUALITY_RADIUS_RATIO and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, and VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_MIN_ANGLE, VTK_QUALITY_MAX_ANGLE, VTK_QUALITY_CONDITION, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
int = obj.GetTriangleQualityMeasure () - Set/Get the particular estimator used to function
the quality of triangles. The default is VTK_QUALITY_RADIUS_RATIO and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, and VTK_QUALITY_EDGE_RATIO,
VTK_QUALITY_MIN_ANGLE, VTK_QUALITY_MAX_ANGLE, VTK_QUALITY_CONDITION, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTriangleQualityMeasureToArea () - Set/Get the particular estimator used to function
the quality of triangles. The default is VTK_QUALITY_RADIUS_RATIO and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, and VTK_QUALITY_EDGE_RATIO,
VTK_QUALITY_MIN_ANGLE, VTK_QUALITY_MAX_ANGLE, VTK_QUALITY_CONDITION, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTriangleQualityMeasureToEdgeRatio () - Set/Get the particular estimator used to
function the quality of triangles. The default is VTK_QUALITY_RADIUS_RATIO and valid values also include
VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, and VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_MIN_ANGLE, VTK_QUALITY_MAX_ANGLE, VTK_QUALITY_CONDITION, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.147 vtkMeshQuality
1275
1276
34.147 vtkMeshQuality
1277
Scope: Except for VTK_QUALITY_EDGE_RATIO, these estimators are intended for planar quadrilaterals
only; use at your own risk if you really want to assess non-planar quadrilateral quality with those.
obj.SetQuadQualityMeasureToRadiusRatio () - Set/Get the particular estimator used to measure the quality of quadrilaterals. The default is VTK_QUALITY_EDGE_RATIO and valid values also include VTK_QUALITY_RADIUS_RATIO, VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_MAX_EDGE_RATIO VTK_QUALITY_SKEW, VTK_QUALITY_TAPER, VTK_QUALITY_WARPAGE, VTK_QUALITY_AREA,
VTK_QUALITY_STRETCH, VTK_QUALITY_MIN_ANGLE, VTK_QUALITY_MAX_ANGLE, VTK_QUALITY_ODDY, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN,
VTK_QUALITY_SHEAR, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, VTK_QUALITY_SHEAR_AND_SIZE, and VTK_QUALITY_DISTORTION.
Scope: Except for VTK_QUALITY_EDGE_RATIO, these estimators are intended for planar quadrilaterals
only; use at your own risk if you really want to assess non-planar quadrilateral quality with those.
obj.SetQuadQualityMeasureToMedAspectFrobenius () - Set/Get the particular estimator
used to measure the quality of quadrilaterals. The default is VTK_QUALITY_EDGE_RATIO and valid values
also include VTK_QUALITY_RADIUS_RATIO, VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_MAX_EDGE_RATIO VTK_QUALITY_SKEW, VTK_QUALITY_TAPER, VTK_QUALITY_WARPAGE, VTK_QUALITY_AREA, VTK_QUALITY_STRETCH, VTK_QUALITY_MIN_ANGLE, VTK_QUALITY_MAX_ANGLE, VTK_QUALITY_ODDY, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHEAR, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED,
VTK_QUALITY_SHAPE_AND_SIZE, VTK_QUALITY_SHEAR_AND_SIZE, and VTK_QUALITY_DISTORTION.
Scope: Except for VTK_QUALITY_EDGE_RATIO, these estimators are intended for planar quadrilaterals
only; use at your own risk if you really want to assess non-planar quadrilateral quality with those.
obj.SetQuadQualityMeasureToMaxAspectFrobenius () - Set/Get the particular estimator
used to measure the quality of quadrilaterals. The default is VTK_QUALITY_EDGE_RATIO and valid values
also include VTK_QUALITY_RADIUS_RATIO, VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_MAX_EDGE_RATIO VTK_QUALITY_SKEW, VTK_QUALITY_TAPER, VTK_QUALITY_WARPAGE, VTK_QUALITY_AREA, VTK_QUALITY_STRETCH, VTK_QUALITY_MIN_ANGLE, VTK_QUALITY_MAX_ANGLE, VTK_QUALITY_ODDY, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHEAR, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED,
VTK_QUALITY_SHAPE_AND_SIZE, VTK_QUALITY_SHEAR_AND_SIZE, and VTK_QUALITY_DISTORTION.
Scope: Except for VTK_QUALITY_EDGE_RATIO, these estimators are intended for planar quadrilaterals
only; use at your own risk if you really want to assess non-planar quadrilateral quality with those.
obj.SetQuadQualityMeasureToMaxEdgeRatios () - Set/Get the particular estimator used to
measure the quality of quadrilaterals. The default is VTK_QUALITY_EDGE_RATIO and valid values also
include VTK_QUALITY_RADIUS_RATIO, VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_MAX_EDGE_RATIO VTK_QUALITY_SKEW, VTK_QUALITY_TAPER, VTK_QUALITY_WARPAGE, VTK_QUALITY_AREA, VTK_QUALITY_STRETCH, VTK_QUALITY_MIN_ANGLE, VTK_QUALITY_MAX_ANGLE, VTK_QUALITY_ODDY, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHEAR, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, VTK_QUALITY_SHEAR_AND_SIZE, and VTK_QUALITY_DISTORTION.
Scope: Except for VTK_QUALITY_EDGE_RATIO, these estimators are intended for planar quadrilaterals
only; use at your own risk if you really want to assess non-planar quadrilateral quality with those.
obj.SetQuadQualityMeasureToSkew () - Set/Get the particular estimator used to measure the
quality of quadrilaterals. The default is VTK_QUALITY_EDGE_RATIO and valid values also include VTK_QUALITY_RADIUS_RATIO, VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_MAX_EDGE_RATIO VTK_QUALITY_SKEW, VTK_QUALITY_TAPER, VTK_QUALITY_WARPAGE, VTK_QUALITY_AREA, VTK_QUALITY_STRETCH, VTK_QUALITY_MIN_ANGLE, VTK_QUALITY_MAX_ANGLE, VTK_QUALITY_ODDY,
VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHEAR, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, VTK_QUALITY_SHEAR_AND_SIZE, and VTK_QUALITY_DISTORTION.
Scope: Except for VTK_QUALITY_EDGE_RATIO, these estimators are intended for planar quadrilaterals
only; use at your own risk if you really want to assess non-planar quadrilateral quality with those.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1278
34.147 vtkMeshQuality
1279
1280
34.147 vtkMeshQuality
1281
valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA, VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
int = obj.GetTetQualityMeasure () - Set/Get the particular estimator used to measure the
quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect ratio beta)
and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA, VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTetQualityMeasureToEdgeRatio () - Set/Get the particular estimator used to measure
the quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect ratio
beta) and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA,
VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTetQualityMeasureToAspectRatio () - Set/Get the particular estimator used to measure the quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect
ratio beta) and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA, VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTetQualityMeasureToRadiusRatio () - Set/Get the particular estimator used to measure the quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect
ratio beta) and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA, VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTetQualityMeasureToAspectFrobenius () - Set/Get the particular estimator used to
measure the quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect ratio beta) and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA, VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION,
VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTetQualityMeasureToMinAngle () - Set/Get the particular estimator used to measure
the quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect ratio
beta) and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA,
VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTetQualityMeasureToCollapseRatio () - Set/Get the particular estimator used to
measure the quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts
aspect ratio beta) and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA, VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION,
VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1282
obj.SetTetQualityMeasureToAspectBeta () - Set/Get the particular estimator used to measure the quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect
ratio beta) and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA, VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTetQualityMeasureToAspectGamma () - Set/Get the particular estimator used to measure the quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect
ratio beta) and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA, VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTetQualityMeasureToVolume () - Set/Get the particular estimator used to measure the
quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect ratio beta)
and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA, VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTetQualityMeasureToCondition () - Set/Get the particular estimator used to measure
the quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect ratio
beta) and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA,
VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTetQualityMeasureToJacobian () - Set/Get the particular estimator used to measure
the quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect ratio
beta) and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA,
VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTetQualityMeasureToScaledJacobian () - Set/Get the particular estimator used to
measure the quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect ratio beta) and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA, VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION,
VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTetQualityMeasureToShape () - Set/Get the particular estimator used to measure the
quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect ratio beta)
and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA, VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDITION, VTK_QUALITY_JACOBIAN, VTK_QUALITY_SCALED_JACOBIAN, VTK_QUALITY_SHAPE, VTK_QUALITY_RELATIVE_SIZE_SQUARED, VTK_QUALITY_SHAPE_AND_SIZE, and VTK_QUALITY_DISTORTION.
obj.SetTetQualityMeasureToRelativeSizeSquared () - Set/Get the particular estimator
used to measure the quality of tetrahedra. The default is VTK_QUALITY_RADIUS_RATIO (identical to Verdicts aspect ratio beta) and valid values also include VTK_QUALITY_ASPECT_RATIO, VTK_QUALITY_ASPECT_FROBENIUS, VTK_QUALITY_EDGE_RATIO, VTK_QUALITY_COLLAPSE_RATIO, VTK_QUALITY_ASPECT_BETA, VTK_QUALITY_ASPECT_GAMMA, VTK_QUALITY_VOLUME, VTK_QUALITY_CONDGenerated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.147 vtkMeshQuality
1283
1284
34.147 vtkMeshQuality
1285
1286
34.147 vtkMeshQuality
1287
component. You may also use CompatibilityModeOn()/Off() to enter this mode. In this mode, cells other than
tetrahedra will have report a volume of 0.0 (if volume computation is enabled).
By default, volume computation is disabled and compatibility mode is off, since it does not make a lot of sense
for meshes with non-tetrahedral cells.
int = obj.GetVolume () - These methods are deprecated. The functionality of computing cell volume is being removed until it can be computed for any 3D cell. (The previous implementation only worked for
tetrahedra.)
For now, turning on the volume computation will put this filter into "compatibility mode," where tetrahedral
cell volume is stored in first component of each output tuple and the radius ratio is stored in the second
component. You may also use CompatibilityModeOn()/Off() to enter this mode. In this mode, cells other than
tetrahedra will have report a volume of 0.0 (if volume computation is enabled).
By default, volume computation is disabled and compatibility mode is off, since it does not make a lot of sense
for meshes with non-tetrahedral cells.
obj.VolumeOn () - These methods are deprecated. The functionality of computing cell volume is being
removed until it can be computed for any 3D cell. (The previous implementation only worked for tetrahedra.)
For now, turning on the volume computation will put this filter into "compatibility mode," where tetrahedral
cell volume is stored in first component of each output tuple and the radius ratio is stored in the second
component. You may also use CompatibilityModeOn()/Off() to enter this mode. In this mode, cells other than
tetrahedra will have report a volume of 0.0 (if volume computation is enabled).
By default, volume computation is disabled and compatibility mode is off, since it does not make a lot of sense
for meshes with non-tetrahedral cells.
obj.VolumeOff () - These methods are deprecated. The functionality of computing cell volume is being
removed until it can be computed for any 3D cell. (The previous implementation only worked for tetrahedra.)
For now, turning on the volume computation will put this filter into "compatibility mode," where tetrahedral
cell volume is stored in first component of each output tuple and the radius ratio is stored in the second
component. You may also use CompatibilityModeOn()/Off() to enter this mode. In this mode, cells other than
tetrahedra will have report a volume of 0.0 (if volume computation is enabled).
By default, volume computation is disabled and compatibility mode is off, since it does not make a lot of sense
for meshes with non-tetrahedral cells.
obj.SetCompatibilityMode (int cm) - CompatibilityMode governs whether, when both a quality
function and cell volume are to be stored as cell data, the two values are stored in a single array. When
compatibility mode is off (the default), two separate arrays are used one labeled "Quality" and the other
labeled "Volume". When compatibility mode is on, both values are stored in a single array, with volume as the
first component and quality as the second component.
Enabling CompatibilityMode changes the default tetrahedral quality function to VTK_QUALITY_RADIUS_RATIO and turns volume computation on. (This matches the default behavior of the initial implementation
of vtkMeshQuality.) You may change quality function and volume computation without leaving compatibility
mode.
Disabling compatibility mode does not affect the current volume computation or tetrahedral quality function
settings.
The final caveat to CompatibilityMode is that regardless of its setting, the resulting array will be of type vtkDoubleArray rather than the original vtkFloatArray. This is a safety function to keep the authors from diving
off of the Combinatorial Coding Cliff into Certain Insanity.
int = obj.GetCompatibilityMode () - CompatibilityMode governs whether, when both a quality
function and cell volume are to be stored as cell data, the two values are stored in a single array. When
compatibility mode is off (the default), two separate arrays are used one labeled "Quality" and the other
labeled "Volume". When compatibility mode is on, both values are stored in a single array, with volume as the
first component and quality as the second component.
Enabling CompatibilityMode changes the default tetrahedral quality function to VTK_QUALITY_RADIUS_RATIO and turns volume computation on. (This matches the default behavior of the initial implementation
of vtkMeshQuality.) You may change quality function and volume computation without leaving compatibility
mode.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1288
34.148
vtkModelMetadata
34.148.1
Usage
This class is inspired by the Exodus II file format, but because this class does not depend on the Exodus library, it
should be possible to use it to represent metadata for other dataset file formats. Sandia Labs uses it in their Exodus
II reader, their Exodus II writer and their EnSight writer. vtkDistributedDataFilter looks for metadata attached to its
input and redistributes the metadata with the grid.
The fields in this class are those described in the document "EXODUS II: A Finite Element Data Model", SAND922137, November 1995.
Element and node IDs stored in this object must be global IDs, in the event that the original dataset was partitioned
across many files.
One way to initialize this object is by using vtkExodusModel (a Sandia class used by the Sandia Exodus reader).
That class will take an open Exodus II file and a vtkUnstructuredGrid drawn from it and will set the required fields.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.148 vtkModelMetadata
1289
Alternatively, you can use all the Set methods to set the individual fields. This class does not copy the data, it
simply uses your pointer. This class will free the storage associated with your pointer when the class is deleted.
Most fields have sensible defaults. The only requirement is that if you are using this ModelMetadata to write out an
Exodus or EnSight file in parallel, you must SetBlockIds and SetBlockIdArrayName. Your vtkUnstructuredGrid must
have a cell array giving the block ID for each cell.
To create an instance of class vtkModelMetadata, simply invoke its constructor as follows
obj = vtkModelMetadata
34.148.2
Methods
The class vtkModelMetadata has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkModelMetadata class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkModelMetadata = obj.NewInstance ()
vtkModelMetadata = obj.SafeDownCast (vtkObject o)
obj.PrintGlobalInformation ()
obj.PrintLocalInformation ()
obj.SetTitle (string ) - The title of the dataset.
obj.AddInformationLine (string info) - Add an information line.
obj.AddQARecord (string name, string version, string date, string time)
- Add a QA record. They fields are: The code name The code version number The date (MM/DD/YY or NULL
for today) The time (HH:MM:SS or NULL for right now)
obj.SetTimeStepIndex (int ) - Set the index of the time step represented by the results data in
the file attached to this ModelMetadata object. Time step indices start at 0 in this file, they start at 1 in an
Exodus file.
obj.SetTimeSteps (int numberOfTimeSteps, float timeStepValues) - Set the total
number of time steps in the file, and the value at each time step. We use your time step value array and
delete it when were done.
obj.SetNumberOfBlocks (int ) - The number of blocks in the file. Set this before setting any of
the block arrays.
obj.SetBlockIds (int ) - An arbitrary integer ID for each block. We use your pointer, and free the
memory when the object is freed.
int = obj.SetBlockNumberOfElements (int nelts) - Set or get a pointer to a list of the
number of elements in each block. We use your pointers, and free the memory when the object is freed.
obj.SetBlockNodesPerElement (int ) - Set or get a pointer to a list of the number of nodes in
the elements of each block. We use your pointers, and free the memory when the object is freed.
obj.SetBlockElementIdList (int ) - Set or get a pointer to a list global element IDs for the
elements in each block. We use your pointers, and free the memory when the object is freed.
int = obj.SetBlockNumberOfAttributesPerElement (int natts) - Set or get a pointer
to a list of the number of attributes stored for the elements in each block. We use your pointers, and free the
memory when the object is freed.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1290
obj.SetBlockAttributes (float ) - Set or get a pointer to a list of the attributes for all blocks.
The order of the list should be by block, by element within the block, by attribute. Omit blocks that dont have
element attributes.
obj.SetNumberOfNodeSets (int ) - The number of node sets in the file. Set this value before
setting the various node set arrays.
obj.SetNodeSetIds (int ) - Set or get the list the IDs for each node set. Length of list is the number
of node sets. We use your pointer, and free the memory when the object is freed.
int = obj.SetNodeSetSize (int ) - Set or get a pointer to a list of the number of nodes in each
node set. We use your pointer, and free the memory when the object is freed.
obj.SetNodeSetNodeIdList (int ) - Set or get a pointer to a concatenated list of the IDs of all
nodes in each node set. First list all IDs in node set 0, then all IDs in node set 1, and so on. We use your
pointer, and free the memory when the object is freed.
int = obj.SetNodeSetNumberOfDistributionFactors (int ) - Set or get a list of the
number of distribution factors stored by each node set. This is either 0 or equal to the number of nodes
in the node set. Length of list is number of node sets. We use your pointer, and free the memory when the
object is freed.
obj.SetNodeSetDistributionFactors (float ) - Set or get a list of the distribution factors for
the node sets. The list is organized by node set, and within node set by node. We use your pointer, and free
the memory when the object is freed.
obj.SetNumberOfSideSets (int ) - Set or get the number of side sets. Set this value before
setting any of the other side set arrays.
obj.SetSideSetIds (int ) - Set or get a pointer to a list giving the ID of each side set. We use your
pointer, and free the memory when the object is freed.
int = obj.SetSideSetSize (int sizes) - Set or get a pointer to a list of the number of sides in
each side set. We use your pointer, and free the memory when the object is freed.
int = obj.SetSideSetNumberOfDistributionFactors (int df) - Set or get a pointer to
a list of the number of distribution factors stored by each side set. Each side set has either no distribution
factors, or 1 per node in the side set. We use your pointer, and free the memory when the object is freed.
obj.SetSideSetElementList (int ) - Set or get a pointer to a list of the elements containing
each side in each side set. The list is organized by side set, and within side set by element. We use your
pointer, and free the memory when the object is freed.
obj.SetSideSetSideList (int ) - Set or get a pointer to the element side for each side in the side
set. (See the manual for the convention for numbering sides in different types of cells.) Side Ids are arranged
by side set and within side set by side, and correspond to the SideSetElementList. We use your pointer, and
free the memory when the object is freed.
obj.SetSideSetNumDFPerSide (int numNodes) - Set or get a pointer to a list of the number of
nodes in each side of each side set. This list is organized by side set, and within side set by side. We use
your pointer, and free the memory when the object is freed.
obj.SetSideSetDistributionFactors (float ) - Set or get a pointer to a list of all the distribution factors. For every side set that has distribution factors, the number of factors per node was given in the
SideSetNumberOfDistributionFactors array. If this number for a given side set is N, then for that side set we
have N floating point values for each node for each side in the side set. If nodes are repeated in more than
one side, we repeat the distribution factors. So this list is in order by side set, by node. We use your pointer,
and free the memory when the object is freed.
obj.SetBlockPropertyValue (int ) - Set or get value for each variable for each block. List the
integer values in order by variable and within variable by block.
obj.SetNodeSetPropertyValue (int ) - Set or get value for each variable for each node set. List
the integer values in order by variable and within variable by node set.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.148 vtkModelMetadata
1291
obj.SetSideSetPropertyValue (int ) - Set or get value for each variable for each side set. List
the integer values in order by variable and within variable by side set.
obj.SetGlobalVariableValue (float f) - Set or get the values of the global variables at the
current time step.
obj.SetElementVariableTruthTable (int ) - A truth table indicating which element variables
are defined for which blocks. The variables are all the original element variables that were in the file. The
table is by block ID and within block ID by variable.
obj.SetAllVariablesDefinedInAllBlocks (int ) - Instead of a truth table of all "1"s, you
can set this instance variable to indicate that all variables are defined in all blocks.
obj.AllVariablesDefinedInAllBlocksOn () - Instead of a truth table of all "1"s, you can set
this instance variable to indicate that all variables are defined in all blocks.
obj.AllVariablesDefinedInAllBlocksOff () - Instead of a truth table of all "1"s, you can set
this instance variable to indicate that all variables are defined in all blocks.
int = obj.ElementVariableIsDefinedInBlock (string varname, int blockId)
- If the element variable named is defined for the block Id provided (in the element variable truth table) return
a 1, otherwise return a 0. If the variable name or block Id are unrecognized, the default value of 1 is returned.
(This is an "original" variable name, from the file, not a name created for the vtkUnstructuredGrid. Use
FindOriginalVariableName to map between the two.)
string = obj.FindOriginalElementVariableName (string name, int component)
- Given the name of an element variable the vtkUnstructuredGrid described by this ModelMetadata, and a
component number, give the name of the scalar array in the original file that turned into that component when
the file was read into VTK.
string = obj.FindOriginalNodeVariableName (string name, int component) Given the name of an node variable the vtkUnstructuredGrid described by this ModelMetadata, and a component number, give the name of the scalar array in the original file that turned into that component when the
file was read into VTK.
obj.Pack (vtkDataSet ugrid) - Pack this objects metadata into a field array of a dataset.
int = obj.Unpack (vtkDataSet ugrid, int deleteIt) - Unpack the metadata stored in a
dataset, and initialize this object with it. Return 1 if theres no metadata packed into the grid, 0 if OK. If deleteIt
is ON, then delete the grids packed data after unpacking it into the object.
int = obj.AddUGridElementVariable (string ugridVarName, string origName, int numComponents) - In order to write Exodus files from vtkUnstructuredGrid objects that
were read from Exodus files, we need to know the mapping from variable names in the UGrid to variable
names in the Exodus file. (The Exodus reader combines scalar variables with similar names into vectors
in the UGrid.) When building the UGrid to which this ModelMetadata refers, add each element and node
variable name with this call, including the name of original variable that yielded its first component, and the
number of components. If a variable is removed from the UGrid, remove it from the ModelMetadata. (If this
information is missing or incomplete, the ExodusIIWriter can still do something sensible in creating names for
variables.)
int = obj.RemoveUGridElementVariable (string ugridVarName) - In order to write
Exodus files from vtkUnstructuredGrid objects that were read from Exodus files, we need to know the mapping from variable names in the UGrid to variable names in the Exodus file. (The Exodus reader combines
scalar variables with similar names into vectors in the UGrid.) When building the UGrid to which this ModelMetadata refers, add each element and node variable name with this call, including the name of original
variable that yielded its first component, and the number of components. If a variable is removed from the
UGrid, remove it from the ModelMetadata. (If this information is missing or incomplete, the ExodusIIWriter
can still do something sensible in creating names for variables.)
int = obj.AddUGridNodeVariable (string ugridVarName, string origName,
int numComponents)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1292
34.149 vtkMultiBlockDataGroupFilter
1293
34.149
vtkMultiBlockDataGroupFilter
34.149.1
Usage
vtkMultiBlockDataGroupFilter is an M to 1 filter that merges multiple input into one multi-group dataset. It will assign
each input to one group of the multi-group dataset and will assign each update piece as a sub-block. For example,
if there are two inputs and four update pieces, the output contains two groups with four datasets each.
To create an instance of class vtkMultiBlockDataGroupFilter, simply invoke its constructor as follows
obj = vtkMultiBlockDataGroupFilter
34.149.2
Methods
The class vtkMultiBlockDataGroupFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMultiBlockDataGroupFilter
class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1294
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMultiBlockDataGroupFilter = obj.NewInstance ()
vtkMultiBlockDataGroupFilter = obj.SafeDownCast (vtkObject o)
obj.AddInput (vtkDataObject ) - Add an input of this algorithm. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
obj.AddInput (int , vtkDataObject ) - Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
34.150
vtkMultiBlockMergeFilter
34.150.1
Usage
34.150.2
Methods
The class vtkMultiBlockMergeFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMultiBlockMergeFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMultiBlockMergeFilter = obj.NewInstance ()
vtkMultiBlockMergeFilter = obj.SafeDownCast (vtkObject o)
obj.AddInput (vtkDataObject ) - Add an input of this algorithm. Note that these methods support
old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
obj.AddInput (int , vtkDataObject ) - Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
34.151
vtkMultiThreshold
34.151 vtkMultiThreshold
34.151.1
1295
Usage
This filter can be substituted for a chain of several vtkThreshold filters and can also perform more sophisticated
subsetting operations. It generates a vtkMultiBlockDataSet as its output. This multiblock dataset contains a vtkUnstructuredGrid for each thresholded subset you request. A thresholded subset can be a set defined by an
interval over a point or cell attribute of the mesh; these subsets are called IntervalSets. A thresholded subset can
also be a boolean combination of one or more IntervalSets; these subsets are called BooleanSets. BooleanSets
allow complex logic since their output can depend on multiple intervals over multiple variables defined on the input
mesh. This is useful because it eliminates the need for thresholding several times and then appending the results,
as can be required with vtkThreshold when one wants to remove some range of values (e.g., a notch filter). Cells
are not repeated when they belong to more than one interval unless those intervals have different output grids.
Another advantage this filter provides over vtkThreshold is the ability to threshold on non-scalar (i.e., vector, tensor,
etc.) attributes without first computing an array containing some norm of the desired attribute. vtkMultiThreshold
provides L1 , L2 , and L norms.
This filter makes a distinction between intermediate subsets and subsets that will be output to a grid. Each intermediate subset you create with AddIntervalSet or AddBooleanSet is given a unique integer identifier (via the return
values of these member functions). If you wish for a given set to be output, you must call OutputSet and pass it one
of these identifiers. The return of OutputSet is the integer index of the output set in the multiblock dataset created
by this filter.
For example, if an input mesh defined three attributes T, P, and s, one might wish to find cells that satisfy "T < 320
[K] && ( P > 101 [kPa] || s < 0.1 [kJ/kg/K] )". To accomplish this with a vtkMultiThreshold filter,
vtkMultiThreshold* thr;
int intervalSets[3];
The result of this filter will be a multiblock dataset that contains a single child with the desired cells. If we had also
called thr->OutputSet( intervalSets[0] );, there would be two child meshes and one would contain
all cells with T < 320 [K]. In that case, the output can be represented by this graph The filled rectangles represent
sets that are output.
To create an instance of class vtkMultiThreshold, simply invoke its constructor as follows
obj = vtkMultiThreshold
34.151.2
Methods
The class vtkMultiThreshold has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkMultiThreshold class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1296
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMultiThreshold = obj.NewInstance ()
vtkMultiThreshold = obj.SafeDownCast (vtkObject o)
int = obj.AddIntervalSet (double xmin, double xmax, int omin, int omax,
int assoc, string arrayName, int component, int allScalars) - Add a mesh subset to be computed by thresholding an attribute of the input mesh. The subset can then be added to an output
mesh with OuputSet() or combined with other sets using AddBooleanSet. If you wish to include all cells with
values below some number a, call with xmin set to vtkMath::NegInf() and xmax set to a. Similarly, if you wish
to include all cells with values above some number a, call with xmin set to a and xmax set to vtkMath::Inf().
When specifying Inf() or NegInf() for an endpoint, it does not matter whether you specify and open or closed
endpoint.
When creating intervals, any integers can be used for the IDs of output meshes. All that matters is that the
same ID be used if intervals should output to the same mesh. The outputs are ordered with ascending IDs in
output block 0.
It is possible to specify an invalid interval, in which case these routines will return -1. Invalid intervals occur
when
an array does not exist,
center is invalid,
xmin == xmax and omin and/or omax are vtkMultiThreshold::OPEN, or
xmin > xmax.
xmin or xmax is not a number (i.e., IEEE NaN). Having both xmin and xmax equal NaN is allowed.
vtkMath provides a portable way to specify IEEE infinities and Nan. Note that specifying an interval
completely out of the bounds of an attribute is considered valid. In fact, it is occasionally useful to create
a closed interval with both endpoints set to or both endpoints set to in order to locate cells with
problematic values.
Parameters
xmin
xmax
omin
omax
assoc
arrayName
attribType
component
allScalars
Returns
An index used to identify the cells selected by the interval or -1 if the interval specification was invalid. If
a valid value is returned, you may pass it to OutputSet().
int = obj.AddIntervalSet (double xmin, double xmax, int omin, int omax,
int assoc, int attribType, int component, int allScalars) - Add a mesh subset
to be computed by thresholding an attribute of the input mesh. The subset can then be added to an output
mesh with OuputSet() or combined with other sets using AddBooleanSet. If you wish to include all cells with
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.151 vtkMultiThreshold
1297
values below some number a, call with xmin set to vtkMath::NegInf() and xmax set to a. Similarly, if you wish
to include all cells with values above some number a, call with xmin set to a and xmax set to vtkMath::Inf().
When specifying Inf() or NegInf() for an endpoint, it does not matter whether you specify and open or closed
endpoint.
When creating intervals, any integers can be used for the IDs of output meshes. All that matters is that the
same ID be used if intervals should output to the same mesh. The outputs are ordered with ascending IDs in
output block 0.
It is possible to specify an invalid interval, in which case these routines will return -1. Invalid intervals occur
when
an array does not exist,
center is invalid,
xmin == xmax and omin and/or omax are vtkMultiThreshold::OPEN, or
xmin > xmax.
xmin or xmax is not a number (i.e., IEEE NaN). Having both xmin and xmax equal NaN is allowed.
vtkMath provides a portable way to specify IEEE infinities and Nan. Note that specifying an interval
completely out of the bounds of an attribute is considered valid. In fact, it is occasionally useful to create
a closed interval with both endpoints set to or both endpoints set to in order to locate cells with
problematic values.
Parameters
xmin
xmax
omin
omax
assoc
arrayName
attribType
component
allScalars
Returns
An index used to identify the cells selected by the interval or -1 if the interval specification was invalid. If
a valid value is returned, you may pass it to OutputSet().
int = obj.AddLowpassIntervalSet (double xmax, int assoc, string arrayName, int component, int allScalars) - These convenience members make it easy to insert
closed intervals. The "notch" interval is accomplished by creating a bandpass interval and applying a NAND
operation. In this case, the set ID returned in the NAND operation set ID. Note that you can pass xmin
== xmax when creating a bandpass threshold to retrieve elements matching exactly one value (since the
intervals created by these routines are closed).
int = obj.AddHighpassIntervalSet (double xmin, int assoc, string arrayName, int component, int allScalars) - These convenience members make it easy to insert
closed intervals. The "notch" interval is accomplished by creating a bandpass interval and applying a NAND
operation. In this case, the set ID returned in the NAND operation set ID. Note that you can pass xmin
== xmax when creating a bandpass threshold to retrieve elements matching exactly one value (since the
intervals created by these routines are closed).
int = obj.AddBandpassIntervalSet (double xmin, double xmax, int assoc,
string arrayName, int component, int allScalars) - These convenience members
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1298
34.152
vtkOBBDicer
34.152.1
Usage
vtkOBBDicer separates the cells of a dataset into spatially aggregated pieces using a Oriented Bounding Box (OBB). These pieces can then be operated on by other filters (e.g., vtkThreshold). One application is to break very
large polygonal models into pieces and performing viewing and occlusion culling on the pieces.
Refer to the superclass documentation (vtkDicer) for more information.
To create an instance of class vtkOBBDicer, simply invoke its constructor as follows
obj = vtkOBBDicer
34.152.2
Methods
The class vtkOBBDicer has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkOBBDicer class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkOBBDicer = obj.NewInstance ()
vtkOBBDicer = obj.SafeDownCast (vtkObject o)
34.153
vtkOBBTree
34.153 vtkOBBTree
34.153.1
1299
Usage
vtkOBBTree is an object to generate oriented bounding box (OBB) trees. An oriented bounding box is a bounding
box that does not necessarily line up along coordinate axes. The OBB tree is a hierarchical tree structure of such
boxes, where deeper levels of OBB confine smaller regions of space.
To build the OBB, a recursive, top-down process is used. First, the root OBB is constructed by finding the mean and
covariance matrix of the cells (and their points) that define the dataset. The eigenvectors of the covariance matrix
are extracted, giving a set of three orthogonal vectors that define the tightest-fitting OBB. To create the two children
OBBs, a split plane is found that (approximately) divides the number cells in half. These are then assigned to the
children OBBs. This process then continues until the MaxLevel ivar limits the recursion, or no split plane can be
found.
A good reference for OBB-trees is Gottschalk & Manocha in Proceedings of Siggraph 96.
To create an instance of class vtkOBBTree, simply invoke its constructor as follows
obj = vtkOBBTree
34.153.2
Methods
The class vtkOBBTree has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkOBBTree class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkOBBTree = obj.NewInstance ()
vtkOBBTree = obj.SafeDownCast (vtkObject o)
int = obj.IntersectWithLine (double a0[3], double a1[3], vtkPoints points,
vtkIdList cellIds) - Take the passed line segment and intersect it with the data set. This method
assumes that the data set is a vtkPolyData that describes a closed surface, and the intersection points that
are returned in points alternate between entrance points and exit points. The return value of the function is
0 if no intersections were found, -1 if point a0 lies inside the closed surface, or +1 if point a0 lies outside
the closed surface. Either points or cellIds can be set to NULL if you dont want to receive that information.
obj.ComputeOBB (vtkDataSet input, double corner[3], double max[3], double
mid[3], double min[3], double size[3]) - Compute an OBB for the input dataset using the
cells in the data. Return the corner point and the three axes defining the orientation of the OBB. Also return
a sorted list of relative "sizes" of axes for comparison purposes.
int = obj.InsideOrOutside (double point[3]) - Determine whether a point is inside or outside the data used to build this OBB tree. The data must be a closed surface vtkPolyData data set. The return
value is +1 if outside, -1 if inside, and 0 if undecided.
obj.FreeSearchStructure () - Satisfy locators abstract interface, see vtkLocator.
obj.BuildLocator () - Satisfy locators abstract interface, see vtkLocator.
obj.GenerateRepresentation (int level, vtkPolyData pd) - Create polygonal representation for OBB tree at specified level. If level < 0, then the leaf OBB nodes will be gathered. The aspect
ratio (ar) and line diameter (d) are used to control the building of the representation. If a OBB node edge
ratios are greater than ar, then the dimension of the OBB is collapsed (OBB->plane->line). A "line" OBB will
be represented either as two crossed polygons, or as a line, depending on the relative diameter of the OBB
compared to the diameter (d).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1300
34.154
vtkOutlineCornerFilter
34.154.1
Usage
vtkOutlineCornerFilter is a filter that generates wireframe outline corners of any data set. The outline consists of the
eight corners of the dataset bounding box.
To create an instance of class vtkOutlineCornerFilter, simply invoke its constructor as follows
obj = vtkOutlineCornerFilter
34.154.2
Methods
The class vtkOutlineCornerFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkOutlineCornerFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkOutlineCornerFilter = obj.NewInstance ()
vtkOutlineCornerFilter = obj.SafeDownCast (vtkObject o)
obj.SetCornerFactor (double ) - Set/Get the factor that controls the relative size of the corners
to the length of the corresponding bounds
double = obj.GetCornerFactorMinValue () - Set/Get the factor that controls the relative size
of the corners to the length of the corresponding bounds
double = obj.GetCornerFactorMaxValue () - Set/Get the factor that controls the relative size
of the corners to the length of the corresponding bounds
double = obj.GetCornerFactor () - Set/Get the factor that controls the relative size of the corners to the length of the corresponding bounds
34.155
vtkOutlineCornerSource
34.155.1
Usage
34.155.2
Methods
The class vtkOutlineCornerSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkOutlineCornerSource
class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.156 vtkOutlineFilter
1301
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkOutlineCornerSource = obj.NewInstance ()
vtkOutlineCornerSource = obj.SafeDownCast (vtkObject o)
obj.SetCornerFactor (double ) - Set/Get the factor that controls the relative size of the corners
to the length of the corresponding bounds
double = obj.GetCornerFactorMinValue () - Set/Get the factor that controls the relative size
of the corners to the length of the corresponding bounds
double = obj.GetCornerFactorMaxValue () - Set/Get the factor that controls the relative size
of the corners to the length of the corresponding bounds
double = obj.GetCornerFactor () - Set/Get the factor that controls the relative size of the corners to the length of the corresponding bounds
34.156
vtkOutlineFilter
34.156.1
Usage
vtkOutlineFilter is a filter that generates a wireframe outline of any data set. The outline consists of the twelve edges
of the dataset bounding box.
To create an instance of class vtkOutlineFilter, simply invoke its constructor as follows
obj = vtkOutlineFilter
34.156.2
Methods
The class vtkOutlineFilter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkOutlineFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkOutlineFilter = obj.NewInstance ()
vtkOutlineFilter = obj.SafeDownCast (vtkObject o)
obj.SetGenerateFaces (int ) - Generate solid faces for the box. This is off by default.
obj.GenerateFacesOn () - Generate solid faces for the box. This is off by default.
obj.GenerateFacesOff () - Generate solid faces for the box. This is off by default.
int = obj.GetGenerateFaces () - Generate solid faces for the box. This is off by default.
34.157
vtkOutlineSource
1302
34.157.1
Usage
vtkOutlineSource creates a wireframe outline around a user-specified bounding box. The outline may be created
aligned with the {x,y,z} axis - in which case it is defined by the 6 bounds {xmin,xmax,ymin,ymax,zmin,zmax} via
SetBounds(). Alternatively, the box may be arbitrarily aligned, in which case it should be set via the SetCorners()
member.
To create an instance of class vtkOutlineSource, simply invoke its constructor as follows
obj = vtkOutlineSource
34.157.2
Methods
The class vtkOutlineSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkOutlineSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkOutlineSource = obj.NewInstance ()
vtkOutlineSource = obj.SafeDownCast (vtkObject o)
obj.SetBoxType (int ) - Set box type to AxisAligned (default) or Oriented. Use the method SetBounds() with AxisAligned mode, and SetCorners() with Oriented mode.
int = obj.GetBoxType () - Set box type to AxisAligned (default) or Oriented. Use the method SetBounds() with AxisAligned mode, and SetCorners() with Oriented mode.
obj.SetBoxTypeToAxisAligned () - Set box type to AxisAligned (default) or Oriented. Use the
method SetBounds() with AxisAligned mode, and SetCorners() with Oriented mode.
obj.SetBoxTypeToOriented () - Specify the bounds of the box to be used in Axis Aligned mode.
obj.SetBounds (double , double , double , double , double , double )
Specify the bounds of the box to be used in Axis Aligned mode.
obj.SetBounds (double a[6]) - Specify the bounds of the box to be used in Axis Aligned mode.
double = obj.
GetBounds () - Specify the bounds of the box to be used in Axis Aligned mode.
obj.SetCorners (double [24]) - Specify the corners of the outline when in Oriented mode, the
values are supplied as 83 double values The correct corner ordering is using {x,y,z} convention for the unit
cube as follows: {0,0,0},{1,0,0},{0,1,0},{1,1,0},{0,0,1},{1,0,1},{0,1,1},{1,1,1}.
double = obj. GetCorners () - Specify the corners of the outline when in Oriented mode, the
values are supplied as 83 double values The correct corner ordering is using {x,y,z} convention for the unit
cube as follows: {0,0,0},{1,0,0},{0,1,0},{1,1,0},{0,0,1},{1,0,1},{0,1,1},{1,1,1}.
obj.SetGenerateFaces (int ) - Generate solid faces for the box. This is off by default.
obj.GenerateFacesOn () - Generate solid faces for the box. This is off by default.
obj.GenerateFacesOff () - Generate solid faces for the box. This is off by default.
int = obj.GetGenerateFaces () - Generate solid faces for the box. This is off by default.
34.158
vtkParametricFunctionSource
34.158 vtkParametricFunctionSource
34.158.1
1303
Usage
This class tessellates parametric functions. The user must specify how many points in the parametric coordinate
directions are required (i.e., the resolution), and the mode to use to generate scalars.
.SECTION Thanks Andrew Maclean a.maclean@cas.edu.au for creating and contributing the class.
To create an instance of class vtkParametricFunctionSource, simply invoke its constructor as follows
obj = vtkParametricFunctionSource
34.158.2
Methods
The class vtkParametricFunctionSource has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkParametricFunctionSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkParametricFunctionSource = obj.NewInstance ()
vtkParametricFunctionSource = obj.SafeDownCast (vtkObject o)
obj.SetParametricFunction (vtkParametricFunction ) - Specify the parametric function
to use to generate the tessellation.
vtkParametricFunction = obj.GetParametricFunction () - Specify the parametric function to use to generate the tessellation.
obj.SetUResolution (int ) - Set/Get the number of subdivisions / tessellations in the u parametric
direction. Note that the number of tessellant points in the u direction is the UResolution + 1.
int = obj.GetUResolution () - Set/Get the number of subdivisions / tessellations in the u parametric direction. Note that the number of tessellant points in the u direction is the UResolution + 1.
obj.SetVResolution (int ) - Set/Get the number of subdivisions / tessellations in the v parametric
direction. Note that the number of tessellant points in the v direction is the VResolution + 1.
int = obj.GetVResolution () - Set/Get the number of subdivisions / tessellations in the v parametric direction. Note that the number of tessellant points in the v direction is the VResolution + 1.
obj.SetWResolution (int ) - Set/Get the number of subdivisions / tessellations in the w parametric
direction. Note that the number of tessellant points in the w direction is the WResolution + 1.
int = obj.GetWResolution () - Set/Get the number of subdivisions / tessellations in the w parametric direction. Note that the number of tessellant points in the w direction is the WResolution + 1.
obj.GenerateTextureCoordinatesOn () - Set/Get the generation of texture coordinates. This is
off by default. Note that this is only applicable to parametric surfaces whose parametric dimension is 2. Note
that texturing may fail in some cases.
obj.GenerateTextureCoordinatesOff () - Set/Get the generation of texture coordinates. This
is off by default. Note that this is only applicable to parametric surfaces whose parametric dimension is 2.
Note that texturing may fail in some cases.
obj.SetGenerateTextureCoordinates (int ) - Set/Get the generation of texture coordinates.
This is off by default. Note that this is only applicable to parametric surfaces whose parametric dimension is
2. Note that texturing may fail in some cases.
int = obj.GetGenerateTextureCoordinates () - Set/Get the generation of texture coordinates. This is off by default. Note that this is only applicable to parametric surfaces whose parametric
dimension is 2. Note that texturing may fail in some cases.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1304
obj.SetScalarMode (int ) - Get/Set the mode used for the scalar data. The options are: SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V, the
scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0 otherwise.
SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0, the scalar
is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE, the
scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
int = obj.GetScalarModeMinValue () - Get/Set the mode used for the scalar data. The options
are: SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V, the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
int = obj.GetScalarModeMaxValue () - Get/Set the mode used for the scalar data. The options
are: SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V, the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
int = obj.GetScalarMode () - Get/Set the mode used for the scalar data. The options are: SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V,
the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
obj.SetScalarModeToNone (void ) - Get/Set the mode used for the scalar data. The options are:
SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V, the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.158 vtkParametricFunctionSource
1305
obj.SetScalarModeToU (void ) - Get/Set the mode used for the scalar data. The options are: SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V,
the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
obj.SetScalarModeToV (void ) - Get/Set the mode used for the scalar data. The options are: SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V,
the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
obj.SetScalarModeToU0 (void ) - Get/Set the mode used for the scalar data. The options are:
SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V, the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
obj.SetScalarModeToV0 (void ) - Get/Set the mode used for the scalar data. The options are:
SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V, the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
obj.SetScalarModeToU0V0 (void ) - Get/Set the mode used for the scalar data. The options are:
SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V, the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1306
obj.SetScalarModeToModulus (void ) - Get/Set the mode used for the scalar data. The options
are: SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V, the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
obj.SetScalarModeToPhase (void ) - Get/Set the mode used for the scalar data. The options
are: SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V, the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
obj.SetScalarModeToQuadrant (void ) - Get/Set the mode used for the scalar data. The options are: SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value.
SCALAR_V, the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2
= u_avg, 0 otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise.
SCALAR_U0V0, the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise.
SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE, the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg).
SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X, the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar
is set to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the
origin. SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
obj.SetScalarModeToX (void ) - Get/Set the mode used for the scalar data. The options are: SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V,
the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
obj.SetScalarModeToY (void ) - Get/Set the mode used for the scalar data. The options are: SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V,
the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.159 vtkPlaneSource
1307
obj.SetScalarModeToZ (void ) - Get/Set the mode used for the scalar data. The options are: SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value. SCALAR_V,
the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2 = u_avg, 0
otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise. SCALAR_U0V0,
the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise. SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE,
the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg). SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X,
the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar is set
to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the origin.
SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
obj.SetScalarModeToDistance (void ) - Get/Set the mode used for the scalar data. The options are: SCALAR_NONE, (default) scalars are not generated. SCALAR_U, the scalar is set to the u-value.
SCALAR_V, the scalar is set to the v-value. SCALAR_U0, the scalar is set to 1 if u = (u_max - u_min)/2
= u_avg, 0 otherwise. SCALAR_V0, the scalar is set to 1 if v = (v_max - v_min)/2 = v_avg, 0 otherwise.
SCALAR_U0V0, the scalar is set to 1 if u == u_avg, 2 if v == v_avg, 3 if u = u_avg && v = v_avg, 0 otherwise.
SCALAR_MODULUS, the scalar is set to (sqrt(uu+vv)), this is measured relative to (u_avg,v_avg). SCALAR_PHASE, the scalar is set to (atan2(v,u)) (in degrees, 0 to 360), this is measured relative to (u_avg,v_avg).
SCALAR_QUADRANT, the scalar is set to 1, 2, 3 or 4 depending upon the quadrant of the point (u,v). SCALAR_X, the scalar is set to the x-value. SCALAR_Y, the scalar is set to the y-value. SCALAR_Z, the scalar
is set to the z-value. SCALAR_DISTANCE, the scalar is set to (sqrt(xx+yy+zz)). I.e. distance from the
origin. SCALAR_FUNCTION_DEFINED, the scalar is set to the value returned from EvaluateScalar().
obj.SetScalarModeToFunctionDefined (void ) - Return the MTime also considering the
parametric function.
long = obj.GetMTime () - Return the MTime also considering the parametric function.
34.159
vtkPlaneSource
34.159.1
Usage
vtkPlaneSource creates an m x n array of quadrilaterals arranged as a regular tiling in a plane. The plane is defined
by specifying an origin point, and then two other points that, together with the origin, define two axes for the plane.
These axes do not have to be orthogonal - so you can create a parallelogram. (The axes must not be parallel.) The
resolution of the plane (i.e., number of subdivisions) is controlled by the ivars XResolution and YResolution.
By default, the plane is centered at the origin and perpendicular to the z-axis, with width and height of length 1 and
resolutions set to 1.
There are three convenience methods that allow you to easily move the plane. The first, SetNormal(), allows you to
specify the plane normal. The effect of this method is to rotate the plane around the center of the plane, aligning the
plane normal with the specified normal. The rotation is about the axis defined by the cross product of the current
normal with the new normal. The second, SetCenter(), translates the center of the plane to the specified center
point. The third method, Push(), allows you to translate the plane along the plane normal by the distance specified.
(Negative Push values translate the plane in the negative normal direction.) Note that the SetNormal(), SetCenter()
and Push() methods modify the Origin, Point1, and/or Point2 instance variables.
To create an instance of class vtkPlaneSource, simply invoke its constructor as follows
obj = vtkPlaneSource
1308
34.159.2
Methods
The class vtkPlaneSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkPlaneSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPlaneSource = obj.NewInstance ()
vtkPlaneSource = obj.SafeDownCast (vtkObject o)
obj.SetXResolution (int ) - Specify the resolution of the plane along the first axes.
int = obj.GetXResolution () - Specify the resolution of the plane along the first axes.
obj.SetYResolution (int ) - Specify the resolution of the plane along the second axes.
int = obj.GetYResolution () - Specify the resolution of the plane along the second axes.
obj.SetResolution (int xR, int yR) - Set the number of x-y subdivisions in the plane.
obj.SetOrigin (double , double , double ) - Specify a point defining the origin of the
plane.
obj.SetOrigin (double a[3]) - Specify a point defining the origin of the plane.
double = obj.
obj.SetPoint1 (double x, double y, double z) - Specify a point defining the first axis of
the plane.
obj.SetPoint1 (double pnt[3]) - Specify a point defining the first axis of the plane.
double = obj.
obj.SetPoint2 (double x, double y, double z) - Specify a point defining the second axis
of the plane.
obj.SetPoint2 (double pnt[3]) - Specify a point defining the second axis of the plane.
double = obj.
obj.SetCenter (double x, double y, double z) - Set/Get the center of the plane. Works
in conjunction with the plane normal to position the plane. Dont use this method to define the plane. Instead,
use it to move the plane to a new center point.
obj.SetCenter (double center[3]) - Set/Get the center of the plane. Works in conjunction with
the plane normal to position the plane. Dont use this method to define the plane. Instead, use it to move the
plane to a new center point.
double = obj. GetCenter () - Set/Get the center of the plane. Works in conjunction with the
plane normal to position the plane. Dont use this method to define the plane. Instead, use it to move the
plane to a new center point.
obj.SetNormal (double nx, double ny, double nz) - Set/Get the plane normal. Works in
conjunction with the plane center to orient the plane. Dont use this method to define the plane. Instead, use
it to rotate the plane around the current center point.
obj.SetNormal (double n[3]) - Set/Get the plane normal. Works in conjunction with the plane
center to orient the plane. Dont use this method to define the plane. Instead, use it to rotate the plane
around the current center point.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.160 vtkPlatonicSolidSource
1309
double = obj. GetNormal () - Set/Get the plane normal. Works in conjunction with the plane
center to orient the plane. Dont use this method to define the plane. Instead, use it to rotate the plane
around the current center point.
obj.Push (double distance) - Translate the plane in the direction of the normal by the distance
specified. Negative values move the plane in the opposite direction.
34.160
vtkPlatonicSolidSource
34.160.1
Usage
vtkPlatonicSolidSource can generate each of the five Platonic solids: tetrahedron, cube, octahedron, icosahedron,
and dodecahedron. Each of the solids is placed inside a sphere centered at the origin with radius 1.0. To use this
class, simply specify the solid to create. Note that this source object creates cell scalars that are (integral value)
face numbers.
To create an instance of class vtkPlatonicSolidSource, simply invoke its constructor as follows
obj = vtkPlatonicSolidSource
34.160.2
Methods
The class vtkPlatonicSolidSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPlatonicSolidSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPlatonicSolidSource = obj.NewInstance ()
vtkPlatonicSolidSource = obj.SafeDownCast (vtkObject o)
obj.SetSolidType (int ) - Specify the type of PlatonicSolid solid to create.
int = obj.GetSolidTypeMinValue () - Specify the type of PlatonicSolid solid to create.
int = obj.GetSolidTypeMaxValue () - Specify the type of PlatonicSolid solid to create.
int = obj.GetSolidType () - Specify the type of PlatonicSolid solid to create.
obj.SetSolidTypeToTetrahedron () - Specify the type of PlatonicSolid solid to create.
obj.SetSolidTypeToCube () - Specify the type of PlatonicSolid solid to create.
obj.SetSolidTypeToOctahedron () - Specify the type of PlatonicSolid solid to create.
obj.SetSolidTypeToIcosahedron () - Specify the type of PlatonicSolid solid to create.
obj.SetSolidTypeToDodecahedron ()
34.161
vtkPointDataToCellData
1310
34.161.1
Usage
vtkPointDataToCellData is a filter that transforms point data (i.e., data specified per point) into cell data (i.e., data
specified per cell). The method of transformation is based on averaging the data values of all points defining a
particular cell. Optionally, the input point data can be passed through to the output as well.
To create an instance of class vtkPointDataToCellData, simply invoke its constructor as follows
obj = vtkPointDataToCellData
34.161.2
Methods
The class vtkPointDataToCellData has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPointDataToCellData
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPointDataToCellData = obj.NewInstance ()
vtkPointDataToCellData = obj.SafeDownCast (vtkObject o)
obj.SetPassPointData (int ) - Control whether the input point data is to be passed to the output.
If on, then the input point data is passed through to the output; otherwise, only generated point data is placed
into the output.
int = obj.GetPassPointData () - Control whether the input point data is to be passed to the
output. If on, then the input point data is passed through to the output; otherwise, only generated point data
is placed into the output.
obj.PassPointDataOn () - Control whether the input point data is to be passed to the output. If on,
then the input point data is passed through to the output; otherwise, only generated point data is placed into
the output.
obj.PassPointDataOff () - Control whether the input point data is to be passed to the output. If on,
then the input point data is passed through to the output; otherwise, only generated point data is placed into
the output.
34.162
vtkPointSource
34.162.1
Usage
vtkPointSource is a source object that creates a user-specified number of points within a specified radius about a
specified center point. By default location of the points is random within the sphere. It is also possible to generate
random points only on the surface of the sphere.
To create an instance of class vtkPointSource, simply invoke its constructor as follows
obj = vtkPointSource
34.163 vtkPolyDataConnectivityFilter
34.162.2
1311
Methods
The class vtkPointSource has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPointSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPointSource = obj.NewInstance ()
vtkPointSource = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfPoints (vtkIdType ) - Set the number of points to generate.
vtkIdType = obj.GetNumberOfPointsMinValue () - Set the number of points to generate.
vtkIdType = obj.GetNumberOfPointsMaxValue () - Set the number of points to generate.
vtkIdType = obj.GetNumberOfPoints () - Set the number of points to generate.
obj.SetCenter (double , double , double ) - Set the center of the point cloud.
obj.SetCenter (double a[3]) - Set the center of the point cloud.
double = obj.
obj.SetRadius (double ) - Set the radius of the point cloud. If you are generating a Gaussian
distribution, then this is the standard deviation for each of x, y, and z.
double = obj.GetRadiusMinValue () - Set the radius of the point cloud. If you are generating a
Gaussian distribution, then this is the standard deviation for each of x, y, and z.
double = obj.GetRadiusMaxValue () - Set the radius of the point cloud. If you are generating a
Gaussian distribution, then this is the standard deviation for each of x, y, and z.
double = obj.GetRadius () - Set the radius of the point cloud. If you are generating a Gaussian
distribution, then this is the standard deviation for each of x, y, and z.
obj.SetDistribution (int ) - Specify the distribution to use. The default is a uniform distribution.
The shell distribution produces random points on the surface of the sphere, none in the interior.
obj.SetDistributionToUniform () - Specify the distribution to use. The default is a uniform distribution. The shell distribution produces random points on the surface of the sphere, none in the interior.
obj.SetDistributionToShell () - Specify the distribution to use. The default is a uniform distribution. The shell distribution produces random points on the surface of the sphere, none in the interior.
int = obj.GetDistribution () - Specify the distribution to use. The default is a uniform distribution. The shell distribution produces random points on the surface of the sphere, none in the interior.
34.163
vtkPolyDataConnectivityFilter
1312
34.163.1
Usage
vtkPolyDataConnectivityFilter is a filter that extracts cells that share common points and/or satisfy a scalar threshold
criterion. (Such a group of cells is called a region.) The filter works in one of six ways: 1) extract the largest
connected region in the dataset; 2) extract specified region numbers; 3) extract all regions sharing specified point
ids; 4) extract all regions sharing specified cell ids; 5) extract the region closest to the specified point; or 6) extract
all regions (used to color regions).
This filter is specialized for polygonal data. This means it runs a bit faster and is easier to construct visualization
networks that process polygonal data.
The behavior of vtkPolyDataConnectivityFilter can be modified by turning on the boolean ivar ScalarConnectivity.
If this flag is on, the connectivity algorithm is modified so that cells are considered connected only if 1) they are
geometrically connected (share a point) and 2) the scalar values of one of the cells points falls in the scalar range
specified. This use of ScalarConnectivity is particularly useful for selecting cells for later processing.
To create an instance of class vtkPolyDataConnectivityFilter, simply invoke its constructor as follows
obj = vtkPolyDataConnectivityFilter
34.163.2
Methods
The class vtkPolyDataConnectivityFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPolyDataConnectivityFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPolyDataConnectivityFilter = obj.NewInstance ()
vtkPolyDataConnectivityFilter = obj.SafeDownCast (vtkObject o)
obj.SetScalarConnectivity (int ) - Turn on/off connectivity based on scalar value. If on, cells
are connected only if they share points AND one of the cells scalar values falls in the scalar range specified.
int = obj.GetScalarConnectivity () - Turn on/off connectivity based on scalar value. If on,
cells are connected only if they share points AND one of the cells scalar values falls in the scalar range
specified.
obj.ScalarConnectivityOn () - Turn on/off connectivity based on scalar value. If on, cells are
connected only if they share points AND one of the cells scalar values falls in the scalar range specified.
obj.ScalarConnectivityOff () - Turn on/off connectivity based on scalar value. If on, cells are
connected only if they share points AND one of the cells scalar values falls in the scalar range specified.
obj.SetScalarRange (double , double ) - Set the scalar range to use to extract cells based
on scalar connectivity.
obj.SetScalarRange (double a[2]) - Set the scalar range to use to extract cells based on scalar
connectivity.
double = obj.
connectivity.
GetScalarRange () - Set the scalar range to use to extract cells based on scalar
34.164 vtkPolyDataNormals
1313
34.164
vtkPolyDataNormals
34.164.1
Usage
vtkPolyDataNormals is a filter that computes point normals for a polygonal mesh. The filter can reorder polygons
to insure consistent orientation across polygon neighbors. Sharp edges can be split and points duplicated with
separate normals to give crisp (rendered) surface definition. It is also possible to globally flip the normal orientation.
The algorithm works by determining normals for each polygon and then averaging them at shared points. When
sharp edges are present, the edges are split and new points generated to prevent blurry edges (due to Gouraud
shading).
To create an instance of class vtkPolyDataNormals, simply invoke its constructor as follows
obj = vtkPolyDataNormals
1314
34.164.2
Methods
The class vtkPolyDataNormals has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkPolyDataNormals class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPolyDataNormals = obj.NewInstance ()
vtkPolyDataNormals = obj.SafeDownCast (vtkObject o)
obj.SetFeatureAngle (double ) - Specify the angle that defines a sharp edge. If the difference in
angle across neighboring polygons is greater than this value, the shared edge is considered "sharp".
double = obj.GetFeatureAngleMinValue () - Specify the angle that defines a sharp edge. If
the difference in angle across neighboring polygons is greater than this value, the shared edge is considered
"sharp".
double = obj.GetFeatureAngleMaxValue () - Specify the angle that defines a sharp edge. If
the difference in angle across neighboring polygons is greater than this value, the shared edge is considered
"sharp".
double = obj.GetFeatureAngle () - Specify the angle that defines a sharp edge. If the difference
in angle across neighboring polygons is greater than this value, the shared edge is considered "sharp".
obj.SetSplitting (int ) - Turn on/off the splitting of sharp edges.
int = obj.GetSplitting () - Turn on/off the splitting of sharp edges.
obj.SplittingOn () - Turn on/off the splitting of sharp edges.
obj.SplittingOff () - Turn on/off the splitting of sharp edges.
obj.SetConsistency (int ) - Turn on/off the enforcement of consistent polygon ordering.
int = obj.GetConsistency () - Turn on/off the enforcement of consistent polygon ordering.
obj.ConsistencyOn () - Turn on/off the enforcement of consistent polygon ordering.
obj.ConsistencyOff () - Turn on/off the enforcement of consistent polygon ordering.
obj.SetAutoOrientNormals (int ) - Turn on/off the automatic determination of correct normal
orientation. NOTE: This assumes a completely closed surface (i.e. no boundary edges) and no non-manifold
edges. If these constraints do not hold, all bets are off. This option adds some computational complexity,
and is useful if you dont want to have to inspect the rendered image to determine whether to turn on the
FlipNormals flag. However, this flag can work with the FlipNormals flag, and if both are set, all the normals in
the output will point "inward".
int = obj.GetAutoOrientNormals () - Turn on/off the automatic determination of correct normal
orientation. NOTE: This assumes a completely closed surface (i.e. no boundary edges) and no non-manifold
edges. If these constraints do not hold, all bets are off. This option adds some computational complexity,
and is useful if you dont want to have to inspect the rendered image to determine whether to turn on the
FlipNormals flag. However, this flag can work with the FlipNormals flag, and if both are set, all the normals in
the output will point "inward".
obj.AutoOrientNormalsOn () - Turn on/off the automatic determination of correct normal orientation. NOTE: This assumes a completely closed surface (i.e. no boundary edges) and no non-manifold edges.
If these constraints do not hold, all bets are off. This option adds some computational complexity, and is useful if you dont want to have to inspect the rendered image to determine whether to turn on the FlipNormals
flag. However, this flag can work with the FlipNormals flag, and if both are set, all the normals in the output
will point "inward".
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.165 vtkPolyDataPointSampler
1315
obj.AutoOrientNormalsOff () - Turn on/off the automatic determination of correct normal orientation. NOTE: This assumes a completely closed surface (i.e. no boundary edges) and no non-manifold edges.
If these constraints do not hold, all bets are off. This option adds some computational complexity, and is useful if you dont want to have to inspect the rendered image to determine whether to turn on the FlipNormals
flag. However, this flag can work with the FlipNormals flag, and if both are set, all the normals in the output
will point "inward".
obj.SetComputePointNormals (int ) - Turn on/off the computation of point normals.
int = obj.GetComputePointNormals () - Turn on/off the computation of point normals.
obj.ComputePointNormalsOn () - Turn on/off the computation of point normals.
obj.ComputePointNormalsOff () - Turn on/off the computation of point normals.
obj.SetComputeCellNormals (int ) - Turn on/off the computation of cell normals.
int = obj.GetComputeCellNormals () - Turn on/off the computation of cell normals.
obj.ComputeCellNormalsOn () - Turn on/off the computation of cell normals.
obj.ComputeCellNormalsOff () - Turn on/off the computation of cell normals.
obj.SetFlipNormals (int ) - Turn on/off the global flipping of normal orientation. Flipping reverves
the meaning of front and back for Frontface and Backface culling in vtkProperty. Flipping modifies both the
normal direction and the order of a cells points.
int = obj.GetFlipNormals () - Turn on/off the global flipping of normal orientation. Flipping
reverves the meaning of front and back for Frontface and Backface culling in vtkProperty. Flipping modifies both the normal direction and the order of a cells points.
obj.FlipNormalsOn () - Turn on/off the global flipping of normal orientation. Flipping reverves the
meaning of front and back for Frontface and Backface culling in vtkProperty. Flipping modifies both the
normal direction and the order of a cells points.
obj.FlipNormalsOff () - Turn on/off the global flipping of normal orientation. Flipping reverves the
meaning of front and back for Frontface and Backface culling in vtkProperty. Flipping modifies both the normal
direction and the order of a cells points.
obj.SetNonManifoldTraversal (int ) - Turn on/off traversal across non-manifold edges. This
will prevent problems where the consistency of polygonal ordering is corrupted due to topological loops.
int = obj.GetNonManifoldTraversal () - Turn on/off traversal across non-manifold edges.
This will prevent problems where the consistency of polygonal ordering is corrupted due to topological loops.
obj.NonManifoldTraversalOn () - Turn on/off traversal across non-manifold edges. This will prevent problems where the consistency of polygonal ordering is corrupted due to topological loops.
obj.NonManifoldTraversalOff () - Turn on/off traversal across non-manifold edges. This will
prevent problems where the consistency of polygonal ordering is corrupted due to topological loops.
34.165
vtkPolyDataPointSampler
1316
34.165.1
Usage
vtkPolyDataPointSampler generates points from input vtkPolyData. The points are placed approximately a specified
distance apart.
This filter functions as follows. First, it regurgitates all input points, then samples all lines, plus edges associated
with the input polygons and triangle strips to produce edge points. Finally, the interiors of polygons and triangle
strips are subsampled to produce points. All of these functiona can be enabled or disabled separately. Note that
this algorithm only approximately generates points the specified distance apart. Generally the point density is finer
than requested.
To create an instance of class vtkPolyDataPointSampler, simply invoke its constructor as follows
obj = vtkPolyDataPointSampler
34.165.2
Methods
The class vtkPolyDataPointSampler has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPolyDataPointSampler
class.
string = obj.GetClassName () - Standard macros for type information and printing.
int = obj.IsA (string name) - Standard macros for type information and printing.
vtkPolyDataPointSampler = obj.NewInstance () - Standard macros for type information
and printing.
vtkPolyDataPointSampler = obj.SafeDownCast (vtkObject o) - Standard macros for
type information and printing.
obj.SetDistance (double ) - Set/Get the approximate distance between points. This is an absolute
distance measure. The default is 0.01.
double = obj.GetDistanceMinValue () - Set/Get the approximate distance between points.
This is an absolute distance measure. The default is 0.01.
double = obj.GetDistanceMaxValue () - Set/Get the approximate distance between points.
This is an absolute distance measure. The default is 0.01.
double = obj.GetDistance () - Set/Get the approximate distance between points. This is an absolute distance measure. The default is 0.01.
int = obj.GetGenerateVertexPoints () - Specify/retrieve a boolean flag indicating whether
cell vertex points should be output.
obj.SetGenerateVertexPoints (int ) - Specify/retrieve a boolean flag indicating whether cell
vertex points should be output.
obj.GenerateVertexPointsOn () - Specify/retrieve a boolean flag indicating whether cell vertex
points should be output.
obj.GenerateVertexPointsOff () - Specify/retrieve a boolean flag indicating whether cell vertex
points should be output.
int = obj.GetGenerateEdgePoints () - Specify/retrieve a boolean flag indicating whether cell
edges should be sampled to produce output points. The default is true.
obj.SetGenerateEdgePoints (int ) - Specify/retrieve a boolean flag indicating whether cell
edges should be sampled to produce output points. The default is true.
obj.GenerateEdgePointsOn () - Specify/retrieve a boolean flag indicating whether cell edges
should be sampled to produce output points. The default is true.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.166 vtkPolyDataStreamer
1317
34.166
vtkPolyDataStreamer
34.166.1
Usage
vtkPolyDataStreamer initiates streaming by requesting pieces from its single input it appends these pieces it to the
requested output. Note that since vtkPolyDataStreamer uses an append filter, all the polygons generated have to
be kept in memory before rendering. If these do not fit in the memory, it is possible to make the vtkPolyDataMapper
stream. Since the mapper will render each piece separately, all the polygons do not have to stored in memory.
.SECTION Note The output may be slightly different if the pipeline does not handle ghost cells properly (i.e. you
might see seames between the pieces).
To create an instance of class vtkPolyDataStreamer, simply invoke its constructor as follows
obj = vtkPolyDataStreamer
34.166.2
Methods
The class vtkPolyDataStreamer has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPolyDataStreamer class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1318
vtkPolyDataStreamer = obj.NewInstance ()
vtkPolyDataStreamer = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfStreamDivisions (int num) - Set the number of pieces to divide the problem
into.
int = obj.GetNumberOfStreamDivisions () - Set the number of pieces to divide the problem
into.
obj.SetColorByPiece (int ) - By default, this option is off. When it is on, cell scalars are generated
based on which piece they are in.
int = obj.GetColorByPiece () - By default, this option is off. When it is on, cell scalars are
generated based on which piece they are in.
obj.ColorByPieceOn () - By default, this option is off. When it is on, cell scalars are generated based
on which piece they are in.
obj.ColorByPieceOff () - By default, this option is off. When it is on, cell scalars are generated
based on which piece they are in.
34.167
vtkProbeFilter
34.167.1
Usage
vtkProbeFilter is a filter that computes point attributes (e.g., scalars, vectors, etc.) at specified point positions. The
filter has two inputs: the Input and Source. The Input geometric structure is passed through the filter. The point
attributes are computed at the Input point positions by interpolating into the source data. For example, we can
compute data values on a plane (plane specified as Input) from a volume (Source). The cell data of the source data
is copied to the output based on in which source cell each input point is. If an array of the same name exists both in
sources point and cell data, only the one from the point data is probed.
This filter can be used to resample data, or convert one dataset form into another. For example, an unstructured grid
(vtkUnstructuredGrid) can be probed with a volume (three-dimensional vtkImageData), and then volume rendering
techniques can be used to visualize the results. Another example: a line or curve can be used to probe data to
produce x-y plots along that line or curve.
To create an instance of class vtkProbeFilter, simply invoke its constructor as follows
obj = vtkProbeFilter
34.167.2
Methods
The class vtkProbeFilter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkProbeFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkProbeFilter = obj.NewInstance ()
vtkProbeFilter = obj.SafeDownCast (vtkObject o)
obj.SetSource (vtkDataObject source) - Specify the point locations used to probe input. Any
geometry can be used. Old style. Do not use unless for backwards compatibility.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.168 vtkProbeSelectedLocations
1319
vtkDataObject = obj.GetSource () - Specify the point locations used to probe input. Any geometry can be used. Old style. Do not use unless for backwards compatibility.
obj.SetSourceConnection (vtkAlgorithmOutput algOutput) - Specify the point locations used to probe input. Any geometry can be used. New style. Equivalent to SetInputConnection(1,
algOutput).
obj.SetSpatialMatch (int ) - This flag is used only when a piece is requested to update. By
default the flag is off. Because no spatial correspondence between input pieces and source pieces is known,
all of the source has to be requested no matter what piece of the output is requested. When there is a spatial
correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to
be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be
requested of the source.
int = obj.GetSpatialMatch () - This flag is used only when a piece is requested to update. By
default the flag is off. Because no spatial correspondence between input pieces and source pieces is known,
all of the source has to be requested no matter what piece of the output is requested. When there is a spatial
correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to
be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be
requested of the source.
obj.SpatialMatchOn () - This flag is used only when a piece is requested to update. By default
the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of
the source has to be requested no matter what piece of the output is requested. When there is a spatial
correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to
be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be
requested of the source.
obj.SpatialMatchOff () - This flag is used only when a piece is requested to update. By default
the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of
the source has to be requested no matter what piece of the output is requested. When there is a spatial
correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to
be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be
requested of the source.
vtkIdTypeArray = obj.GetValidPoints () - Get the list of point ids in the output that contain
attribute data interpolated from the source.
obj.SetValidPointMaskArrayName (string ) - Returns the name of the char array added to
the output with values 1 for valid points and 0 for invalid points. Set to "vtkValidPointMask" by default.
string = obj.GetValidPointMaskArrayName () - Returns the name of the char array added
to the output with values 1 for valid points and 0 for invalid points. Set to "vtkValidPointMask" by default.
34.168
vtkProbeSelectedLocations
34.168.1
Usage
1320
34.168.2
Methods
The class vtkProbeSelectedLocations has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkProbeSelectedLocations
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkProbeSelectedLocations = obj.NewInstance ()
vtkProbeSelectedLocations = obj.SafeDownCast (vtkObject o)
34.169
vtkProgrammableAttributeDataFilter
34.169.1
Usage
vtkProgrammableAttributeDataFilter is a filter that allows you to write a custom procedure to manipulate attribute
data - either point or cell data. For example, you could generate scalars based on a complex formula; convert
vectors to normals; compute scalar values as a function of vectors, texture coords, and/or any other point data
attribute; and so on. The filter takes multiple inputs (input plus an auxiliary input list), so you can write procedures
that combine several dataset point attributes. Note that the output of the filter is the same type (topology/geometry)
as the input.
The filter works as follows. It operates like any other filter (i.e., checking and managing modified and execution
times, processing Update() and Execute() methods, managing release of data, etc.), but the difference is that the
Execute() method simply invokes a user-specified function with an optional (void ) argument (typically the "this"
pointer in C++). It is also possible to specify a function to delete the argument via ExecuteMethodArgDelete().
To use the filter, you write a procedure to process the input datasets, process the data, and generate output data.
Typically, this means grabbing the input point or cell data (using GetInput() and maybe GetInputList()), operating
on it (creating new point and cell attributes such as scalars, vectors, etc.), and then setting the point and/or cell
attributes in the output dataset (youll need to use GetOutput() to access the output). (Note: besides C++, it is
possible to do the same thing in Tcl, Java, or other languages that wrap the C++ core.) Remember, proper filter
protocol requires that you dont modify the input data - you create new output data from the input.
To create an instance of class vtkProgrammableAttributeDataFilter, simply invoke its constructor as follows
obj = vtkProgrammableAttributeDataFilter
34.169.2
Methods
The class vtkProgrammableAttributeDataFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkProgrammableAttributeDataFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkProgrammableAttributeDataFilter = obj.NewInstance ()
vtkProgrammableAttributeDataFilter = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.170 vtkProgrammableDataObjectSource
1321
34.170
vtkProgrammableDataObjectSource
34.170.1
Usage
vtkProgrammableDataObjectSource is a source object that is programmable by the user. The output of the filter is a
data object (vtkDataObject) which represents data via an instance of field data. To use this object, you must specify
a function that creates the output.
Example use of this filter includes reading tabular data and encoding it as vtkFieldData. You can then use filters like
vtkDataObjectToDataSetFilter to convert the data object to a dataset and then visualize it. Another important use of
this class is that it allows users of interpreters (e.g., Tcl or Java) the ability to write source objects without having to
recompile C++ code or generate new libraries.
To create an instance of class vtkProgrammableDataObjectSource, simply invoke its constructor as follows
obj = vtkProgrammableDataObjectSource
34.170.2
Methods
The class vtkProgrammableDataObjectSource has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkProgrammableDataObjectSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkProgrammableDataObjectSource = obj.NewInstance ()
vtkProgrammableDataObjectSource = obj.SafeDownCast (vtkObject o)
34.171
vtkProgrammableFilter
34.171.1
Usage
vtkProgrammableFilter is a filter that can be programmed by the user. To use the filter you define a function that
retrieves input of the correct type, creates data, and then manipulates the output of the filter. Using this filter avoids
the need for subclassing - and the function can be defined in an interpreter wrapper language such as Tcl or Java.
The trickiest part of using this filter is that the input and output methods are unusual and cannot be compile-time
type checked. Instead, as a user of this filter it is your responsibility to set and get the correct input and output types.
To create an instance of class vtkProgrammableFilter, simply invoke its constructor as follows
obj = vtkProgrammableFilter
1322
34.171.2
Methods
The class vtkProgrammableFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkProgrammableFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkProgrammableFilter = obj.NewInstance ()
vtkProgrammableFilter = obj.SafeDownCast (vtkObject o)
vtkPolyData = obj.GetPolyDataInput () - Get the input as a concrete type. This method is
typically used by the writer of the filter function to get the input as a particular type (i.e., it essentially does
type casting). It is the users responsibility to know the correct type of the input data.
vtkStructuredPoints = obj.GetStructuredPointsInput () - Get the input as a concrete
type.
vtkStructuredGrid = obj.GetStructuredGridInput () - Get the input as a concrete type.
vtkUnstructuredGrid = obj.GetUnstructuredGridInput () - Get the input as a concrete
type.
vtkRectilinearGrid = obj.GetRectilinearGridInput () - Get the input as a concrete
type.
vtkGraph = obj.GetGraphInput () - Get the input as a concrete type.
vtkTable = obj.GetTableInput () - Get the input as a concrete type.
obj.SetCopyArrays (bool ) - When CopyArrays is true, all arrays are copied to the output iff input
and output are of the same type. False by default.
bool = obj.GetCopyArrays () - When CopyArrays is true, all arrays are copied to the output iff
input and output are of the same type. False by default.
obj.CopyArraysOn () - When CopyArrays is true, all arrays are copied to the output iff input and output
are of the same type. False by default.
obj.CopyArraysOff () - When CopyArrays is true, all arrays are copied to the output iff input and
output are of the same type. False by default.
34.172
vtkProgrammableGlyphFilter
34.172.1
Usage
vtkProgrammableGlyphFilter is a filter that allows you to place a glyph at each input point in the dataset. In addition,
the filter is programmable which means the user has control over the generation of the glyph. The glyphs can be
controlled via the point data attributes (e.g., scalars, vectors, etc.) or any other information in the input dataset.
This is the way the filter works. You must define an input dataset which at a minimum contains points with associated
attribute values. Also, the Source instance variable must be set which is of type vtkPolyData. Then, for each point
in the input, the PointId is set to the current point id, and a user-defined function is called (i.e., GlyphMethod). In
this method you can manipulate the Source data (including changing to a different Source object). After the GlyphMethod is called, vtkProgrammableGlyphFilter will invoke an Update() on its Source object, and then copy its data
to the output of the vtkProgrammableGlyphFilter. Therefore the output of this filter is of type vtkPolyData.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.173 vtkProgrammableSource
1323
Another option to this filter is the way you color the glyphs. You can use the scalar data from the input or the source.
The instance variable ColorMode controls this behavior.
To create an instance of class vtkProgrammableGlyphFilter, simply invoke its constructor as follows
obj = vtkProgrammableGlyphFilter
34.172.2
Methods
The class vtkProgrammableGlyphFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkProgrammableGlyphFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkProgrammableGlyphFilter = obj.NewInstance ()
vtkProgrammableGlyphFilter = obj.SafeDownCast (vtkObject o)
obj.SetSource (vtkPolyData source) - Set/Get the source to use for this glyph. Note: you can
change the source during execution of this filter.
vtkPolyData = obj.GetSource () - Set/Get the source to use for this glyph. Note: you can change
the source during execution of this filter.
vtkIdType = obj.GetPointId () - Get the current point id during processing. Value only valid
during the Execute() method of this filter. (Meant to be called by the GlyphMethod().)
double = obj. GetPoint () - Get the current point coordinates during processing. Value only
valid during the Execute() method of this filter. (Meant to be called by the GlyphMethod().)
vtkPointData = obj.GetPointData () - Get the set of point data attributes for the input. A convenience to the programmer to be used in the GlyphMethod(). Only valid during the Execute() method of this
filter.
obj.SetColorMode (int ) - Either color by the input or source scalar data.
int = obj.GetColorMode () - Either color by the input or source scalar data.
obj.SetColorModeToColorByInput () - Either color by the input or source scalar data.
obj.SetColorModeToColorBySource () - Either color by the input or source scalar data.
string = obj.GetColorModeAsString () - Either color by the input or source scalar data.
34.173
vtkProgrammableSource
34.173.1
Usage
vtkProgrammableSource is a source object that is programmable by the user. To use this object, you must specify
a function that creates the output. It is possible to generate an output dataset of any (concrete) type; it is up to
the function to properly initialize and define the output. Typically, you use one of the methods to get a concrete
output type (e.g., GetPolyDataOutput() or GetStructuredPointsOutput()), and then manipulate the output in the
user-specified function.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1324
Example use of this include writing a function to read a data file or interface to another system. (You might want to
do this in favor of deriving a new class.) Another important use of this class is that it allows users of interpreters
(e.g., Tcl or Java) the ability to write source objects without having to recompile C++ code or generate new libraries.
To create an instance of class vtkProgrammableSource, simply invoke its constructor as follows
obj = vtkProgrammableSource
34.173.2
Methods
The class vtkProgrammableSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkProgrammableSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkProgrammableSource = obj.NewInstance ()
vtkProgrammableSource = obj.SafeDownCast (vtkObject o)
vtkPolyData = obj.GetPolyDataOutput () - Get the output as a concrete type. This method
is typically used by the writer of the source function to get the output as a particular type (i.e., it essentially
does type casting). It is the users responsibility to know the correct type of the output data.
vtkStructuredPoints = obj.GetStructuredPointsOutput () - Get the output as a concrete type.
vtkStructuredGrid = obj.GetStructuredGridOutput () - Get the output as a concrete
type.
vtkUnstructuredGrid = obj.GetUnstructuredGridOutput () - Get the output as a concrete type.
vtkRectilinearGrid = obj.GetRectilinearGridOutput () - Get the output as a concrete
type.
34.174
vtkProjectedTexture
34.174.1
Usage
vtkProjectedTexture assigns texture coordinates to a dataset as if the texture was projected from a slide projected
located somewhere in the scene. Methods are provided to position the projector and aim it at a location, to set the
width of the projectors frustum, and to set the range of texture coordinates assigned to the dataset.
Objects in the scene that appear behind the projector are also assigned texture coordinates; the projected image is
left-right and top-bottom flipped, much as a lens focus flips the rays of light that pass through it. A warning is issued
if a point in the dataset falls at the focus of the projector.
To create an instance of class vtkProjectedTexture, simply invoke its constructor as follows
obj = vtkProjectedTexture
34.174 vtkProjectedTexture
34.174.2
1325
Methods
The class vtkProjectedTexture has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkProjectedTexture class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkProjectedTexture = obj.NewInstance ()
vtkProjectedTexture = obj.SafeDownCast (vtkObject o)
obj.SetPosition (double , double , double ) - Set/Get the position of the focus of the
projector.
obj.SetPosition (double a[3]) - Set/Get the position of the focus of the projector.
double = obj.
obj.SetFocalPoint (double focalPoint[3]) - Set/Get the focal point of the projector (a point
that lies along the center axis of the projectors frustum).
obj.SetFocalPoint (double x, double y, double z) - Set/Get the focal point of the projector (a point that lies along the center axis of the projectors frustum).
double = obj. GetFocalPoint () - Set/Get the focal point of the projector (a point that lies along
the center axis of the projectors frustum).
obj.SetCameraMode (int ) - Set/Get the camera mode of the projection pinhole projection or two
mirror projection.
int = obj.GetCameraMode () - Set/Get the camera mode of the projection pinhole projection or
two mirror projection.
obj.SetCameraModeToPinhole () - Set/Get the camera mode of the projection pinhole projection
or two mirror projection.
obj.SetCameraModeToTwoMirror () - Set/Get the mirror separation for the two mirror system.
obj.SetMirrorSeparation (double ) - Set/Get the mirror separation for the two mirror system.
double = obj.GetMirrorSeparation () - Set/Get the mirror separation for the two mirror system.
double = obj.
GetUp ()
GetAspectRatio ()
obj.SetSRange (double , double ) - Specify s-coordinate range for texture s-t coordinate pair.
obj.SetSRange (double a[2]) - Specify s-coordinate range for texture s-t coordinate pair.
double = obj.
obj.SetTRange (double , double ) - Specify t-coordinate range for texture s-t coordinate pair.
obj.SetTRange (double a[2]) - Specify t-coordinate range for texture s-t coordinate pair.
double = obj.
1326
34.175
vtkQuadraturePointInterpolator
34.175.1
Usage
Interpolates each scalar/vector field in a vtkUnstrcturedGrid on its input to a specific set of quadrature points. The
set of quadrature points is specified per array via a dictionary (ie an instance of vtkInformationQuadratureSchemeDefinitionVectorKey). contained in the array. The interpolated fields are placed in FieldData along with a set of per
cell indexes, that allow random access to a given cells quadrature points.
To create an instance of class vtkQuadraturePointInterpolator, simply invoke its constructor as follows
obj = vtkQuadraturePointInterpolator
34.175.2
Methods
The class vtkQuadraturePointInterpolator has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadraturePointInterpolator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuadraturePointInterpolator = obj.NewInstance ()
vtkQuadraturePointInterpolator = obj.SafeDownCast (vtkObject o)
34.176
vtkQuadraturePointsGenerator
34.176.1
Usage
Create a vtkPolyData on its output containing the vertices for the quadrature points for one of the vtkDataArrays
present on its input vtkUnstructuredGrid. If the input data set has has FieldData generated by vtkQuadraturePointInterpolator then this will be set as point data. Note: Point sets are generated per field array. This is because each
field array may contain its own dictionary.
.SECTION See also vtkQuadraturePointInterpolator, vtkQuadratureSchemeDefinition, vtkInformationQuadratureSchemeDefinitionVectorKey
To create an instance of class vtkQuadraturePointsGenerator, simply invoke its constructor as follows
obj = vtkQuadraturePointsGenerator
34.176.2
Methods
The class vtkQuadraturePointsGenerator has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadraturePointsGenerator class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.177 vtkQuadratureSchemeDictionaryGenerator
1327
34.177
vtkQuadratureSchemeDictionaryGenerator
34.177.1
Usage
Given an unstructured grid on its input this filter generates for each data array in point data dictionary (ie an instance
of vtkInformationQuadratureSchemeDefinitionVectorKey). This filter has been introduced to facilitate testing of the
vtkQuadrature classes as these cannot operate with the dictionary. This class is for testing and should not be used
for application development.
.SECTION See also vtkQuadraturePointInterpolator, vtkQuadraturePointsGenerator, vtkQuadratureSchemeDefinition
To create an instance of class vtkQuadratureSchemeDictionaryGenerator, simply invoke its constructor as follows
obj = vtkQuadratureSchemeDictionaryGenerator
34.177.2
Methods
The class vtkQuadratureSchemeDictionaryGenerator has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely
intelligible. When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadratureSchemeDictionaryGenerator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuadratureSchemeDictionaryGenerator = obj.NewInstance ()
vtkQuadratureSchemeDictionaryGenerator = obj.SafeDownCast (vtkObject o)
34.178
vtkQuadricClustering
34.178.1
Usage
vtkQuadricClustering is a filter to reduce the number of triangles in a triangle mesh, forming a good approximation
to the original geometry. The input to vtkQuadricClustering is a vtkPolyData object, and all types of polygonal data
are handled.
The algorithm used is the one described by Peter Lindstrom in his Siggraph 2000 paper, "Out-of-Core Simplification
of Large Polygonal Models." The general approach of the algorithm is to cluster vertices in a uniform binning of
space, accumulating the quadric of each triangle (pushed out to the triangles vertices) within each bin, and then
determining an optimal position for a single vertex in a bin by using the accumulated quadric. In more detail, the
algorithm first gets the bounds of the input poly data. It then breaks this bounding volume into a user-specified
number of spatial bins. It then reads each triangle from the input and hashes its vertices into these bins. (If this is
the first time a bin has been visited, initialize its quadric to the 0 matrix.) The algorithm computes the error quadric
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1328
for this triangle and adds it to the existing quadric of the bin in which each vertex is contained. Then, if 2 or more
vertices of the triangle fall in the same bin, the triangle is dicarded. If the triangle is not discarded, it adds the triangle
to the list of output triangles as a list of vertex identifiers. (There is one vertex id per bin.) After all the triangles have
been read, the representative vertex for each bin is computed (an optimal location is found) using the quadric for
that bin. This determines the spatial location of the vertices of each of the triangles in the output.
To use this filter, specify the divisions defining the spatial subdivision in the x, y, and z directions. You must also specify an input vtkPolyData. Then choose to either 1) use the original points that minimize the quadric error to produce
the output triangles or 2) compute an optimal position in each bin to produce the output triangles (recommended
and default behavior).
This filter can take multiple inputs. To do this, the user must explicity call StartAppend, Append (once for each
input), and EndAppend. StartAppend sets up the data structure to hold the quadric matrices. Append processes
each triangle in the input poly data it was called on, hashes its vertices to the appropriate bins, determines whether
to keep this triangle, and updates the appropriate quadric matrices. EndAppend determines the spatial location
of each of the representative vertices for the visited bins. While this approach does not fit into the visualization
architecture and requires manual control, it has the advantage that extremely large data can be processed in pieces
and appended to the filter piece-by-piece.
To create an instance of class vtkQuadricClustering, simply invoke its constructor as follows
obj = vtkQuadricClustering
34.178.2
Methods
The class vtkQuadricClustering has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadricClustering class.
string = obj.GetClassName () - Standard instantition, type and print methods.
int = obj.IsA (string name) - Standard instantition, type and print methods.
vtkQuadricClustering = obj.NewInstance () - Standard instantition, type and print methods.
vtkQuadricClustering = obj.SafeDownCast (vtkObject o) - Standard instantition, type
and print methods.
obj.SetNumberOfXDivisions (int num) - Set/Get the number of divisions along each axis for the
spatial bins. The number of spatial bins is NumberOfXDivisionsNumberOfYDivisions NumberOfZDivisions.
The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled.
obj.SetNumberOfYDivisions (int num) - Set/Get the number of divisions along each axis for the
spatial bins. The number of spatial bins is NumberOfXDivisionsNumberOfYDivisions NumberOfZDivisions.
The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled.
obj.SetNumberOfZDivisions (int num) - Set/Get the number of divisions along each axis for the
spatial bins. The number of spatial bins is NumberOfXDivisionsNumberOfYDivisions NumberOfZDivisions.
The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled.
int = obj.GetNumberOfXDivisions () - Set/Get the number of divisions along each axis for the
spatial bins. The number of spatial bins is NumberOfXDivisionsNumberOfYDivisions NumberOfZDivisions.
The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled.
int = obj.GetNumberOfYDivisions () - Set/Get the number of divisions along each axis for the
spatial bins. The number of spatial bins is NumberOfXDivisionsNumberOfYDivisions NumberOfZDivisions.
The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.178 vtkQuadricClustering
1329
int = obj.GetNumberOfZDivisions () - Set/Get the number of divisions along each axis for the
spatial bins. The number of spatial bins is NumberOfXDivisionsNumberOfYDivisions NumberOfZDivisions.
The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled.
obj.SetNumberOfDivisions (int div[3]) - Set/Get the number of divisions along each axis
for the spatial bins. The number of spatial bins is NumberOfXDivisionsNumberOfYDivisions NumberOfZDivisions. The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled.
obj.SetNumberOfDivisions (int div0, int div1, int div2) - Set/Get the number of
divisions along each axis for the spatial bins. The number of spatial bins is NumberOfXDivisionsNumberOfYDivisions NumberOfZDivisions. The filter may choose to ignore large numbers of divisions if the input has
few points and AutoAdjustNumberOfDivisions is enabled.
int = obj.GetNumberOfDivisions () - Set/Get the number of divisions along each axis for the
spatial bins. The number of spatial bins is NumberOfXDivisionsNumberOfYDivisions NumberOfZDivisions.
The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled.
obj.GetNumberOfDivisions (int div[3]) - Set/Get the number of divisions along each axis
for the spatial bins. The number of spatial bins is NumberOfXDivisionsNumberOfYDivisions NumberOfZDivisions. The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled.
obj.SetAutoAdjustNumberOfDivisions (int ) - Enable automatic adjustment of number of
divisions. If off, the number of divisions specified by the user is always used (as long as it is valid). The
default is On
int = obj.GetAutoAdjustNumberOfDivisions () - Enable automatic adjustment of number
of divisions. If off, the number of divisions specified by the user is always used (as long as it is valid). The
default is On
obj.AutoAdjustNumberOfDivisionsOn () - Enable automatic adjustment of number of divisions.
If off, the number of divisions specified by the user is always used (as long as it is valid). The default is On
obj.AutoAdjustNumberOfDivisionsOff () - Enable automatic adjustment of number of divisions. If off, the number of divisions specified by the user is always used (as long as it is valid). The default is
On
obj.SetDivisionOrigin (double x, double y, double z) - This is an alternative way to
set up the bins. If you are trying to match boundaries between pieces, then you should use these methods
rather than SetNumberOfDivisions. To use these methods, specify the origin and spacing of the spatial
binning.
obj.SetDivisionOrigin (double o[3]) - This is an alternative way to set up the bins. If you are
trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions. To use these methods, specify the origin and spacing of the spatial binning.
double = obj. GetDivisionOrigin () - This is an alternative way to set up the bins. If you are
trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions. To use these methods, specify the origin and spacing of the spatial binning.
obj.SetDivisionSpacing (double x, double y, double z) - This is an alternative way
to set up the bins. If you are trying to match boundaries between pieces, then you should use these methods
rather than SetNumberOfDivisions. To use these methods, specify the origin and spacing of the spatial
binning.
obj.SetDivisionSpacing (double s[3]) - This is an alternative way to set up the bins. If you
are trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions. To use these methods, specify the origin and spacing of the spatial binning.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1330
double = obj. GetDivisionSpacing () - This is an alternative way to set up the bins. If you
are trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions. To use these methods, specify the origin and spacing of the spatial binning.
obj.SetUseInputPoints (int ) - Normally the point that minimizes the quadric error function is
used as the output of the bin. When this flag is on, the bin point is forced to be one of the points from the
input (the one with the smallest error). This option does not work (i.e., input points cannot be used) when the
append methods (StartAppend(), Append(), EndAppend()) are being called directly.
int = obj.GetUseInputPoints () - Normally the point that minimizes the quadric error function is
used as the output of the bin. When this flag is on, the bin point is forced to be one of the points from the
input (the one with the smallest error). This option does not work (i.e., input points cannot be used) when the
append methods (StartAppend(), Append(), EndAppend()) are being called directly.
obj.UseInputPointsOn () - Normally the point that minimizes the quadric error function is used as
the output of the bin. When this flag is on, the bin point is forced to be one of the points from the input (the
one with the smallest error). This option does not work (i.e., input points cannot be used) when the append
methods (StartAppend(), Append(), EndAppend()) are being called directly.
obj.UseInputPointsOff () - Normally the point that minimizes the quadric error function is used as
the output of the bin. When this flag is on, the bin point is forced to be one of the points from the input (the
one with the smallest error). This option does not work (i.e., input points cannot be used) when the append
methods (StartAppend(), Append(), EndAppend()) are being called directly.
obj.SetUseFeatureEdges (int ) - By default, this flag is off. When "UseFeatureEdges" is on, then
quadrics are computed for boundary edges/feature edges. They influence the quadrics (position of points),
but not the mesh. Which features to use can be controlled by the filter "FeatureEdges".
int = obj.GetUseFeatureEdges () - By default, this flag is off. When "UseFeatureEdges" is on,
then quadrics are computed for boundary edges/feature edges. They influence the quadrics (position of
points), but not the mesh. Which features to use can be controlled by the filter "FeatureEdges".
obj.UseFeatureEdgesOn () - By default, this flag is off. When "UseFeatureEdges" is on, then
quadrics are computed for boundary edges/feature edges. They influence the quadrics (position of points),
but not the mesh. Which features to use can be controlled by the filter "FeatureEdges".
obj.UseFeatureEdgesOff () - By default, this flag is off. When "UseFeatureEdges" is on, then
quadrics are computed for boundary edges/feature edges. They influence the quadrics (position of points),
but not the mesh. Which features to use can be controlled by the filter "FeatureEdges".
vtkFeatureEdges = obj.GetFeatureEdges () - By default, this flag is off. It only has an effect
when "UseFeatureEdges" is also on. When "UseFeaturePoints" is on, then quadrics are computed for boundary / feature points used in the boundary / feature edges. They influence the quadrics (position of points), but
not the mesh.
obj.SetUseFeaturePoints (int ) - By default, this flag is off. It only has an effect when "UseFeatureEdges" is also on. When "UseFeaturePoints" is on, then quadrics are computed for boundary / feature
points used in the boundary / feature edges. They influence the quadrics (position of points), but not the mesh.
int = obj.GetUseFeaturePoints () - By default, this flag is off. It only has an effect when "UseFeatureEdges" is also on. When "UseFeaturePoints" is on, then quadrics are computed for boundary /
feature points used in the boundary / feature edges. They influence the quadrics (position of points), but not
the mesh.
obj.UseFeaturePointsOn () - By default, this flag is off. It only has an effect when "UseFeatureEdges" is also on. When "UseFeaturePoints" is on, then quadrics are computed for boundary / feature points
used in the boundary / feature edges. They influence the quadrics (position of points), but not the mesh.
obj.UseFeaturePointsOff () - By default, this flag is off. It only has an effect when "UseFeatureEdges" is also on. When "UseFeaturePoints" is on, then quadrics are computed for boundary / feature points
used in the boundary / feature edges. They influence the quadrics (position of points), but not the mesh.
obj.SetFeaturePointsAngle (double ) - Set/Get the angle to use in determining whether a
point on a boundary / feature edge is a feature point.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.178 vtkQuadricClustering
1331
1332
34.179
vtkQuadricDecimation
34.179.1
Usage
vtkQuadricDecimation is a filter to reduce the number of triangles in a triangle mesh, forming a good approximation
to the original geometry. The input to vtkQuadricDecimation is a vtkPolyData object, and only triangles are treated.
If you desire to decimate polygonal meshes, first triangulate the polygons with vtkTriangleFilter.
The algorithm is based on repeated edge collapses until the requested mesh reduction is achieved. Edges are
placed in a priority queue based on the "cost" to delete the edge. The cost is an approximate measure of error
(distance to the original surface)described by the so-called quadric error measure. The quadric error measure is
associated with each vertex of the mesh and represents a matrix of planes incident on that vertex. The distance
of the planes to the vertex is the error in the position of the vertex (originally the vertex error iz zero). As edges
are deleted, the quadric error measure associated with the two end points of the edge are summed (this combines
the plane equations) and an optimal collapse point can be computed. Edges connected to the collapse point are
then reinserted into the queue after computing the new cost to delete them. The process continues until the desired
reduction level is reached or topological constraints prevent further reduction. Note that this basic algorithm can be
extended to higher dimensions by taking into account variation in attributes (i.e., scalars, vectors, and so on).
This paper is based on the work of Garland and Heckbert who first presented the quadric error measure at Siggraph
97 "Surface Simplification Using Quadric Error Metrics". For details of the algorithm Michael Garlands Ph.D.
thesis is also recommended. Hughues Hoppes Vis 99 paper, "New Quadric Metric for Simplifying Meshes with
Appearance Attributes" is also a good take on the subject especially as it pertains to the error metric applied to
attributes.
.SECTION Thanks Thanks to Bradley Lowekamp of the National Library of Medicine/NIH for contributing this class.
To create an instance of class vtkQuadricDecimation, simply invoke its constructor as follows
obj = vtkQuadricDecimation
34.179.2
Methods
The class vtkQuadricDecimation has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkQuadricDecimation class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuadricDecimation = obj.NewInstance ()
vtkQuadricDecimation = obj.SafeDownCast (vtkObject o)
obj.SetTargetReduction (double ) - Set/Get the desired reduction (expressed as a fraction of
the original number of triangles). The actual reduction may be less depending on triangulation and topological
constraints.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.179 vtkQuadricDecimation
1333
1334
obj.NormalsAttributeOn () - If attribute errors are to be included in the metric (i.e., AttributeErrorMetric is on), then the following flags control which attributes are to be included in the error calculation. By
default all of these are on.
obj.NormalsAttributeOff () - If attribute errors are to be included in the metric (i.e., AttributeErrorMetric is on), then the following flags control which attributes are to be included in the error calculation. By
default all of these are on.
obj.SetTCoordsAttribute (int ) - If attribute errors are to be included in the metric (i.e.,
AttributeErrorMetric is on), then the following flags control which attributes are to be included in the error
calculation. By default all of these are on.
int = obj.GetTCoordsAttribute () - If attribute errors are to be included in the metric (i.e.,
AttributeErrorMetric is on), then the following flags control which attributes are to be included in the error
calculation. By default all of these are on.
obj.TCoordsAttributeOn () - If attribute errors are to be included in the metric (i.e., AttributeErrorMetric is on), then the following flags control which attributes are to be included in the error calculation. By
default all of these are on.
obj.TCoordsAttributeOff () - If attribute errors are to be included in the metric (i.e., AttributeErrorMetric is on), then the following flags control which attributes are to be included in the error calculation. By
default all of these are on.
obj.SetTensorsAttribute (int ) - If attribute errors are to be included in the metric (i.e.,
AttributeErrorMetric is on), then the following flags control which attributes are to be included in the error
calculation. By default all of these are on.
int = obj.GetTensorsAttribute () - If attribute errors are to be included in the metric (i.e.,
AttributeErrorMetric is on), then the following flags control which attributes are to be included in the error
calculation. By default all of these are on.
obj.TensorsAttributeOn () - If attribute errors are to be included in the metric (i.e., AttributeErrorMetric is on), then the following flags control which attributes are to be included in the error calculation. By
default all of these are on.
obj.TensorsAttributeOff () - If attribute errors are to be included in the metric (i.e., AttributeErrorMetric is on), then the following flags control which attributes are to be included in the error calculation. By
default all of these are on.
obj.SetScalarsWeight (double ) - Set/Get the scaling weight contribution of the attribute. These
values are used to weight the contribution of the attributes towards the error metric.
obj.SetVectorsWeight (double ) - Set/Get the scaling weight contribution of the attribute. These
values are used to weight the contribution of the attributes towards the error metric.
obj.SetNormalsWeight (double ) - Set/Get the scaling weight contribution of the attribute. These
values are used to weight the contribution of the attributes towards the error metric.
obj.SetTCoordsWeight (double ) - Set/Get the scaling weight contribution of the attribute. These
values are used to weight the contribution of the attributes towards the error metric.
obj.SetTensorsWeight (double ) - Set/Get the scaling weight contribution of the attribute. These
values are used to weight the contribution of the attributes towards the error metric.
double = obj.GetScalarsWeight () - Set/Get the scaling weight contribution of the attribute.
These values are used to weight the contribution of the attributes towards the error metric.
double = obj.GetVectorsWeight () - Set/Get the scaling weight contribution of the attribute.
These values are used to weight the contribution of the attributes towards the error metric.
double = obj.GetNormalsWeight () - Set/Get the scaling weight contribution of the attribute.
These values are used to weight the contribution of the attributes towards the error metric.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.180 vtkQuantizePolyDataPoints
1335
34.180
vtkQuantizePolyDataPoints
34.180.1
Usage
34.180.2
Methods
The class vtkQuantizePolyDataPoints has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkQuantizePolyDataPoints
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkQuantizePolyDataPoints = obj.NewInstance ()
vtkQuantizePolyDataPoints = obj.SafeDownCast (vtkObject o)
obj.SetQFactor (double ) - Specify quantization grain size. Default is 0.25
double = obj.GetQFactorMinValue () - Specify quantization grain size. Default is 0.25
double = obj.GetQFactorMaxValue () - Specify quantization grain size. Default is 0.25
double = obj.GetQFactor () - Specify quantization grain size. Default is 0.25
obj.OperateOnPoint (double in[3], double out[3]) - Perform quantization on a point
obj.OperateOnBounds (double in[6], double out[6]) - Perform quantization on bounds
34.181
vtkRandomAttributeGenerator
1336
34.181.1
Usage
vtkRandomAttributeGenerator is a filter that creates random attributes including scalars, vectors, normals, tensors,
texture coordinates and/or general data arrays. These attributes can be generated as point data, cell data or general
field data. The generation of each component is normalized between a user-specified minimum and maximum value.
This filter provides that capability to specify the data type of the attributes, the range for each of the components,
and the number of components. Note, however, that this flexibility only goes so far because some attributes (e.g.,
normals, vectors and tensors) are fixed in the number of components, and in the case of normals and tensors, are
constrained in the values that some of the components can take (i.e., normals have magnitude one, and tensors
are symmetric).
To create an instance of class vtkRandomAttributeGenerator, simply invoke its constructor as follows
obj = vtkRandomAttributeGenerator
34.181.2
Methods
The class vtkRandomAttributeGenerator has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRandomAttributeGenerator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRandomAttributeGenerator = obj.NewInstance ()
vtkRandomAttributeGenerator = obj.SafeDownCast (vtkObject o)
obj.SetDataType (int ) - Specify the type of array to create (all components of this array are of this
type). This holds true for all arrays that are created.
obj.SetDataTypeToBit () - Specify the type of array to create (all components of this array are of
this type). This holds true for all arrays that are created.
obj.SetDataTypeToChar () - Specify the type of array to create (all components of this array are of
this type). This holds true for all arrays that are created.
obj.SetDataTypeToUnsignedChar () - Specify the type of array to create (all components of this
array are of this type). This holds true for all arrays that are created.
obj.SetDataTypeToShort () - Specify the type of array to create (all components of this array are of
this type). This holds true for all arrays that are created.
obj.SetDataTypeToUnsignedShort () - Specify the type of array to create (all components of this
array are of this type). This holds true for all arrays that are created.
obj.SetDataTypeToInt () - Specify the type of array to create (all components of this array are of
this type). This holds true for all arrays that are created.
obj.SetDataTypeToUnsignedInt () - Specify the type of array to create (all components of this
array are of this type). This holds true for all arrays that are created.
obj.SetDataTypeToLong () - Specify the type of array to create (all components of this array are of
this type). This holds true for all arrays that are created.
obj.SetDataTypeToUnsignedLong () - Specify the type of array to create (all components of this
array are of this type). This holds true for all arrays that are created.
obj.SetDataTypeToFloat () - Specify the type of array to create (all components of this array are of
this type). This holds true for all arrays that are created.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.181 vtkRandomAttributeGenerator
1337
obj.SetDataTypeToDouble () - Specify the type of array to create (all components of this array are
of this type). This holds true for all arrays that are created.
int = obj.GetDataType () - Specify the type of array to create (all components of this array are of
this type). This holds true for all arrays that are created.
obj.SetNumberOfComponents (int ) - Specify the number of components to generate. This value
only applies to those attribute types that take a variable number of components. For example, a vector is only
three components so the number of components is not applicable; whereas a scalar may support multiple,
varying number of components.
int = obj.GetNumberOfComponentsMinValue () - Specify the number of components to generate. This value only applies to those attribute types that take a variable number of components. For
example, a vector is only three components so the number of components is not applicable; whereas a scalar
may support multiple, varying number of components.
int = obj.GetNumberOfComponentsMaxValue () - Specify the number of components to generate. This value only applies to those attribute types that take a variable number of components. For
example, a vector is only three components so the number of components is not applicable; whereas a scalar
may support multiple, varying number of components.
int = obj.GetNumberOfComponents () - Specify the number of components to generate. This
value only applies to those attribute types that take a variable number of components. For example, a vector
is only three components so the number of components is not applicable; whereas a scalar may support
multiple, varying number of components.
obj.SetMinimumComponentValue (double ) - Set the minimum component value. This applies
to all data that is generated, although normals and tensors have internal constraints that must be observed.
double = obj.GetMinimumComponentValue () - Set the minimum component value. This applies to all data that is generated, although normals and tensors have internal constraints that must be observed.
obj.SetMaximumComponentValue (double ) - Set the maximum component value. This applies
to all data that is generated, although normals and tensors have internal constraints that must be observed.
double = obj.GetMaximumComponentValue () - Set the maximum component value. This applies to all data that is generated, although normals and tensors have internal constraints that must be observed.
obj.SetNumberOfTuples (vtkIdType ) - Specify the number of tuples to generate. This value
only applies when creating general field data. In all other cases (i.e., point data or cell data), the number of
tuples is controlled by the number of points and cells, respectively.
vtkIdType = obj.GetNumberOfTuplesMinValue () - Specify the number of tuples to generate. This value only applies when creating general field data. In all other cases (i.e., point data or cell data),
the number of tuples is controlled by the number of points and cells, respectively.
vtkIdType = obj.GetNumberOfTuplesMaxValue () - Specify the number of tuples to generate. This value only applies when creating general field data. In all other cases (i.e., point data or cell data),
the number of tuples is controlled by the number of points and cells, respectively.
vtkIdType = obj.GetNumberOfTuples () - Specify the number of tuples to generate. This value
only applies when creating general field data. In all other cases (i.e., point data or cell data), the number of
tuples is controlled by the number of points and cells, respectively.
obj.SetGeneratePointScalars (int ) - Indicate that point scalars are to be generated. Note
that the specified number of components is used to create the scalar.
int = obj.GetGeneratePointScalars () - Indicate that point scalars are to be generated. Note
that the specified number of components is used to create the scalar.
obj.GeneratePointScalarsOn () - Indicate that point scalars are to be generated. Note that the
specified number of components is used to create the scalar.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1338
obj.GeneratePointScalarsOff () - Indicate that point scalars are to be generated. Note that the
specified number of components is used to create the scalar.
obj.SetGeneratePointVectors (int ) - Indicate that point vectors are to be generated. Note
that the number of components is always equal to three.
int = obj.GetGeneratePointVectors () - Indicate that point vectors are to be generated. Note
that the number of components is always equal to three.
obj.GeneratePointVectorsOn () - Indicate that point vectors are to be generated. Note that the
number of components is always equal to three.
obj.GeneratePointVectorsOff () - Indicate that point vectors are to be generated. Note that the
number of components is always equal to three.
obj.SetGeneratePointNormals (int ) - Indicate that point normals are to be generated. Note
that the number of components is always equal to three.
int = obj.GetGeneratePointNormals () - Indicate that point normals are to be generated. Note
that the number of components is always equal to three.
obj.GeneratePointNormalsOn () - Indicate that point normals are to be generated. Note that the
number of components is always equal to three.
obj.GeneratePointNormalsOff () - Indicate that point normals are to be generated. Note that the
number of components is always equal to three.
obj.SetGeneratePointTensors (int ) - Indicate that point tensors are to be generated. Note
that the number of components is always equal to nine.
int = obj.GetGeneratePointTensors () - Indicate that point tensors are to be generated. Note
that the number of components is always equal to nine.
obj.GeneratePointTensorsOn () - Indicate that point tensors are to be generated. Note that the
number of components is always equal to nine.
obj.GeneratePointTensorsOff () - Indicate that point tensors are to be generated. Note that the
number of components is always equal to nine.
obj.SetGeneratePointTCoords (int ) - Indicate that point texture coordinates are to be generated. Note that the specified number of components is used to create the texture coordinates (but must range
between one and three).
int = obj.GetGeneratePointTCoords () - Indicate that point texture coordinates are to be generated. Note that the specified number of components is used to create the texture coordinates (but must
range between one and three).
obj.GeneratePointTCoordsOn () - Indicate that point texture coordinates are to be generated.
Note that the specified number of components is used to create the texture coordinates (but must range
between one and three).
obj.GeneratePointTCoordsOff () - Indicate that point texture coordinates are to be generated.
Note that the specified number of components is used to create the texture coordinates (but must range
between one and three).
obj.SetGeneratePointArray (int ) - Indicate that an arbitrary point array is to be generated.
Note that the specified number of components is used to create the array.
int = obj.GetGeneratePointArray () - Indicate that an arbitrary point array is to be generated.
Note that the specified number of components is used to create the array.
obj.GeneratePointArrayOn () - Indicate that an arbitrary point array is to be generated. Note that
the specified number of components is used to create the array.
obj.GeneratePointArrayOff () - Indicate that an arbitrary point array is to be generated. Note that
the specified number of components is used to create the array.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.181 vtkRandomAttributeGenerator
1339
obj.SetGenerateCellScalars (int ) - Indicate that cell scalars are to be generated. Note that
the specified number of components is used to create the scalar.
int = obj.GetGenerateCellScalars () - Indicate that cell scalars are to be generated. Note
that the specified number of components is used to create the scalar.
obj.GenerateCellScalarsOn () - Indicate that cell scalars are to be generated. Note that the
specified number of components is used to create the scalar.
obj.GenerateCellScalarsOff () - Indicate that cell scalars are to be generated. Note that the
specified number of components is used to create the scalar.
obj.SetGenerateCellVectors (int ) - Indicate that cell vectors are to be generated. Note that
the number of components is always equal to three.
int = obj.GetGenerateCellVectors () - Indicate that cell vectors are to be generated. Note
that the number of components is always equal to three.
obj.GenerateCellVectorsOn () - Indicate that cell vectors are to be generated. Note that the
number of components is always equal to three.
obj.GenerateCellVectorsOff () - Indicate that cell vectors are to be generated. Note that the
number of components is always equal to three.
obj.SetGenerateCellNormals (int ) - Indicate that cell normals are to be generated. Note that
the number of components is always equal to three.
int = obj.GetGenerateCellNormals () - Indicate that cell normals are to be generated. Note
that the number of components is always equal to three.
obj.GenerateCellNormalsOn () - Indicate that cell normals are to be generated. Note that the
number of components is always equal to three.
obj.GenerateCellNormalsOff () - Indicate that cell normals are to be generated. Note that the
number of components is always equal to three.
obj.SetGenerateCellTensors (int ) - Indicate that cell tensors are to be generated. Note that
the number of components is always equal to nine.
int = obj.GetGenerateCellTensors () - Indicate that cell tensors are to be generated. Note
that the number of components is always equal to nine.
obj.GenerateCellTensorsOn () - Indicate that cell tensors are to be generated. Note that the
number of components is always equal to nine.
obj.GenerateCellTensorsOff () - Indicate that cell tensors are to be generated. Note that the
number of components is always equal to nine.
obj.SetGenerateCellTCoords (int ) - Indicate that cell texture coordinates are to be generated.
Note that the specified number of components is used to create the texture coordinates (but must range
between one and three).
int = obj.GetGenerateCellTCoords () - Indicate that cell texture coordinates are to be generated. Note that the specified number of components is used to create the texture coordinates (but must range
between one and three).
obj.GenerateCellTCoordsOn () - Indicate that cell texture coordinates are to be generated. Note
that the specified number of components is used to create the texture coordinates (but must range between
one and three).
obj.GenerateCellTCoordsOff () - Indicate that cell texture coordinates are to be generated. Note
that the specified number of components is used to create the texture coordinates (but must range between
one and three).
obj.SetGenerateCellArray (int ) - Indicate that an arbitrary cell array is to be generated. Note
that the specified number of components is used to create the array.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1340
34.182
vtkRearrangeFields
34.182.1
Usage
vtkRearrangeFields is used to copy/move fields (vtkDataArrays) between data objects field data, point data and cell
data. To specify which fields are copied/moved, the user adds operations. There are two types of operations: 1. the
type which copies/moves an attributes data (i.e. the field will be copied but will not be an attribute in the target), 2.
the type which copies/moves fields by name. For example:
rf->AddOperation(vtkRearrangeFields::COPY, "foo",
vtkRearrangeFields::DATA_OBJECT,
vtkRearrangeFields::POINT_DATA);
adds an operation which copies a field (data array) called foo from the data objects field data to point data. From
Tcl, the same operation can be added as follows:
rf AddOperation COPY foo DATA_OBJECT POINT_DATA
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.183 vtkRectangularButtonSource
1341
The same can be done using Python and Java bindings by passing strings as arguments.
Operation types: COPY, MOVE
AttributeTypes: SCALARS, VECTORS, NORMALS, TCOORDS, TENSORS
Field data locations: DATA_OBJECT, POINT_DATA, CELL_DATA
34.182.2
Methods
The class vtkRearrangeFields has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkRearrangeFields class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRearrangeFields = obj.NewInstance ()
vtkRearrangeFields = obj.SafeDownCast (vtkObject o)
int = obj.AddOperation (int operationType, int attributeType, int fromFieldLoc, int toFieldLoc) - Add an operation which copies an attributes field (data array) from
one field data to another. Returns an operation id which can later be used to remove the operation.
int = obj.AddOperation (int operationType, string name, int fromFieldLoc, int toFieldLoc) - Add an operation which copies a field (data array) from one field data to
another. Returns an operation id which can later be used to remove the operation.
int = obj.AddOperation (string operationType, string attributeType,
string fromFieldLoc, string toFieldLoc) - Helper method used by other language bindings. Allows the caller to specify arguments as strings instead of enums.Returns an operation id which can
later be used to remove the operation.
int = obj.RemoveOperation (int operationId) - Remove an operation with the given id.
int = obj.RemoveOperation (int operationType, int attributeType, int
fromFieldLoc, int toFieldLoc) - Remove an operation with the given signature. See AddOperation for details.
int = obj.RemoveOperation (int operationType, string name, int fromFieldLoc, int toFieldLoc) - Remove an operation with the given signature. See AddOperation
for details.
int = obj.RemoveOperation (string operationType, string attributeType,
string fromFieldLoc, string toFieldLoc) - Remove an operation with the given signature.
See AddOperation for details.
obj.RemoveAllOperations ()
34.183
vtkRectangularButtonSource
1342
34.183.1
Usage
vtkRectangularButtonSource creates a rectangular shaped button with texture coordinates suitable for application
of a texture map. This provides a way to make nice looking 3D buttons. The buttons are represented as vtkPolyData
that includes texture coordinates and normals. The button lies in the x-y plane.
To use this class you must define its width, height and length. These measurements are all taken with respect to
the shoulder of the button. The shoulder is defined as follows. Imagine a box sitting on the floor. The distance from
the floor to the top of the box is the depth; the other directions are the length (x-direction) and height (y-direction).
In this particular widget the box can have a smaller bottom than top. The ratio in size between bottom and top is
called the box ratio (by default=1.0). The ratio of the texture region to the shoulder region is the texture ratio. And
finally the texture region may be out of plane compared to the shoulder. The texture height ratio controls this.
To create an instance of class vtkRectangularButtonSource, simply invoke its constructor as follows
obj = vtkRectangularButtonSource
34.183.2
Methods
The class vtkRectangularButtonSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRectangularButtonSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRectangularButtonSource = obj.NewInstance ()
vtkRectangularButtonSource = obj.SafeDownCast (vtkObject o)
obj.SetWidth (double ) - Set/Get the width of the button.
double = obj.GetWidthMinValue () - Set/Get the width of the button.
double = obj.GetWidthMaxValue () - Set/Get the width of the button.
double = obj.GetWidth () - Set/Get the width of the button.
obj.SetHeight (double ) - Set/Get the height of the button.
double = obj.GetHeightMinValue () - Set/Get the height of the button.
double = obj.GetHeightMaxValue () - Set/Get the height of the button.
double = obj.GetHeight () - Set/Get the height of the button.
obj.SetDepth (double ) - Set/Get the depth of the button (the z-eliipsoid axis length).
double = obj.GetDepthMinValue () - Set/Get the depth of the button (the z-eliipsoid axis length).
double = obj.GetDepthMaxValue () - Set/Get the depth of the button (the z-eliipsoid axis length).
double = obj.GetDepth () - Set/Get the depth of the button (the z-eliipsoid axis length).
obj.SetBoxRatio (double ) - Set/Get the ratio of the bottom of the button with the shoulder region.
Numbers greater than one produce buttons with a wider bottom than shoulder; ratios less than one produce
buttons that have a wider shoulder than bottom.
double = obj.GetBoxRatioMinValue () - Set/Get the ratio of the bottom of the button with the
shoulder region. Numbers greater than one produce buttons with a wider bottom than shoulder; ratios less
than one produce buttons that have a wider shoulder than bottom.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.184 vtkRectilinearGridClip
1343
double = obj.GetBoxRatioMaxValue () - Set/Get the ratio of the bottom of the button with the
shoulder region. Numbers greater than one produce buttons with a wider bottom than shoulder; ratios less
than one produce buttons that have a wider shoulder than bottom.
double = obj.GetBoxRatio () - Set/Get the ratio of the bottom of the button with the shoulder
region. Numbers greater than one produce buttons with a wider bottom than shoulder; ratios less than one
produce buttons that have a wider shoulder than bottom.
obj.SetTextureRatio (double ) - Set/Get the ratio of the texture region to the shoulder region.
This number must be 0<=tr<=1. If the texture style is to fit the image, then satisfying the texture ratio may
only be possible in one of the two directions (length or width) depending on the dimensions of the texture.
double = obj.GetTextureRatioMinValue () - Set/Get the ratio of the texture region to the
shoulder region. This number must be 0<=tr<=1. If the texture style is to fit the image, then satisfying the
texture ratio may only be possible in one of the two directions (length or width) depending on the dimensions
of the texture.
double = obj.GetTextureRatioMaxValue () - Set/Get the ratio of the texture region to the
shoulder region. This number must be 0<=tr<=1. If the texture style is to fit the image, then satisfying the
texture ratio may only be possible in one of the two directions (length or width) depending on the dimensions
of the texture.
double = obj.GetTextureRatio () - Set/Get the ratio of the texture region to the shoulder region.
This number must be 0<=tr<=1. If the texture style is to fit the image, then satisfying the texture ratio may
only be possible in one of the two directions (length or width) depending on the dimensions of the texture.
obj.SetTextureHeightRatio (double ) - Set/Get the ratio of the height of the texture region to
the shoulder height. Values greater than 1.0 yield convex buttons with the texture region raised above the
shoulder. Values less than 1.0 yield concave buttons with the texture region below the shoulder.
double = obj.GetTextureHeightRatioMinValue () - Set/Get the ratio of the height of the
texture region to the shoulder height. Values greater than 1.0 yield convex buttons with the texture region
raised above the shoulder. Values less than 1.0 yield concave buttons with the texture region below the
shoulder.
double = obj.GetTextureHeightRatioMaxValue () - Set/Get the ratio of the height of the
texture region to the shoulder height. Values greater than 1.0 yield convex buttons with the texture region
raised above the shoulder. Values less than 1.0 yield concave buttons with the texture region below the
shoulder.
double = obj.GetTextureHeightRatio () - Set/Get the ratio of the height of the texture region
to the shoulder height. Values greater than 1.0 yield convex buttons with the texture region raised above the
shoulder. Values less than 1.0 yield concave buttons with the texture region below the shoulder.
34.184
vtkRectilinearGridClip
34.184.1
Usage
vtkRectilinearGridClip will make an image smaller. The output must have an image extent which is the subset of the
input. The filter has two modes of operation: 1: By default, the data is not copied in this filter. Only the whole extent
is modified. 2: If ClipDataOn is set, then you will get no more that the clipped extent.
To create an instance of class vtkRectilinearGridClip, simply invoke its constructor as follows
obj = vtkRectilinearGridClip
1344
34.184.2
Methods
The class vtkRectilinearGridClip has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRectilinearGridClip class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRectilinearGridClip = obj.NewInstance ()
vtkRectilinearGridClip = obj.SafeDownCast (vtkObject o)
obj.SetOutputWholeExtent (int extent[6], vtkInformation outInfo)
whole extent of the output has to be set explicitly.
The
obj.SetOutputWholeExtent (int minX, int maxX, int minY, int maxY, int
minZ, int maxZ) - The whole extent of the output has to be set explicitly.
obj.GetOutputWholeExtent (int extent[6]) - The whole extent of the output has to be set
explicitly.
obj.ResetOutputWholeExtent ()
obj.SetClipData (int ) - By default, ClipData is off, and only the WholeExtent is modified. the
datas extent may actually be larger. When this flag is on, the data extent will be no more than the OutputWholeExtent.
int = obj.GetClipData () - By default, ClipData is off, and only the WholeExtent is modified. the
datas extent may actually be larger. When this flag is on, the data extent will be no more than the OutputWholeExtent.
obj.ClipDataOn () - By default, ClipData is off, and only the WholeExtent is modified. the datas extent
may actually be larger. When this flag is on, the data extent will be no more than the OutputWholeExtent.
obj.ClipDataOff () - By default, ClipData is off, and only the WholeExtent is modified. the datas
extent may actually be larger. When this flag is on, the data extent will be no more than the OutputWholeExtent.
obj.SetOutputWholeExtent (int piece, int numPieces) - Hack set output by piece
34.185
vtkRectilinearGridGeometryFilter
34.185.1
Usage
vtkRectilinearGridGeometryFilter is a filter that extracts geometry from a rectilinear grid. By specifying appropriate
i-j-k indices, it is possible to extract a point, a curve, a surface, or a "volume". The volume is actually a (n x m x o)
region of points.
The extent specification is zero-offset. That is, the first k-plane in a 50x50x50 rectilinear grid is given by (0,49, 0,49,
0,0).
To create an instance of class vtkRectilinearGridGeometryFilter, simply invoke its constructor as follows
obj = vtkRectilinearGridGeometryFilter
34.186 vtkRectilinearGridToTetrahedra
34.185.2
1345
Methods
The class vtkRectilinearGridGeometryFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRectilinearGridGeometryFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRectilinearGridGeometryFilter = obj.NewInstance ()
vtkRectilinearGridGeometryFilter = obj.SafeDownCast (vtkObject o)
int = obj.
kmin,kmax).
obj.SetExtent (int iMin, int iMax, int jMin, int jMax, int kMin, int kMax) - Specify (imin,imax, jmin,jmax, kmin,kmax) indices.
obj.SetExtent (int extent[6]) - Specify (imin,imax, jmin,jmax, kmin,kmax) indices in array form.
34.186
vtkRectilinearGridToTetrahedra
34.186.1
Usage
vtkRectilinearGridToTetrahedra forms a mesh of Tetrahedra from a vtkRectilinearGrid. The tetrahedra can be 5 per
cell, 6 per cell, or a mixture of 5 or 12 per cell. The resulting mesh is consistent, meaning that there are no edge
crossings and that each tetrahedron face is shared by two tetrahedra, except those tetrahedra on the boundary. All
tetrahedra are right handed.
Note that 12 tetrahedra per cell means adding a point in the center of the cell.
In order to subdivide some cells into 5 and some cells into 12 tetrahedra: SetTetraPerCellTo5And12(); Set the
Scalars of the Input RectilinearGrid to be 5 or 12 depending on what you want per cell of the RectilinearGrid.
If you set RememberVoxelId, the scalars of the tetrahedron will be set to the Id of the Cell in the RectilinearGrid
from which the tetrahedron came.
.SECTION Thanks This class was developed by Samson J. Timoner of the MIT Artificial Intelligence Laboratory
To create an instance of class vtkRectilinearGridToTetrahedra, simply invoke its constructor as follows
obj = vtkRectilinearGridToTetrahedra
34.186.2
Methods
The class vtkRectilinearGridToTetrahedra has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRectilinearGridToTetrahedra class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRectilinearGridToTetrahedra = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1346
34.187
vtkRectilinearSynchronizedTemplates
34.187.1
Usage
34.187.2
Methods
The class vtkRectilinearSynchronizedTemplates has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRectilinearSynchronizedTemplates class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.187 vtkRectilinearSynchronizedTemplates
1347
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRectilinearSynchronizedTemplates = obj.NewInstance ()
vtkRectilinearSynchronizedTemplates = obj.SafeDownCast (vtkObject o)
long = obj.GetMTime () - Because we delegate to vtkContourValues
obj.SetComputeNormals (int ) - Set/Get the computation of normals. Normal computation is fairly
expensive in both time and storage. If the output data will be processed by filters that modify topology or
geometry, it may be wise to turn Normals and Gradients off.
int = obj.GetComputeNormals () - Set/Get the computation of normals. Normal computation is
fairly expensive in both time and storage. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeNormalsOn () - Set/Get the computation of normals. Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or geometry,
it may be wise to turn Normals and Gradients off.
obj.ComputeNormalsOff () - Set/Get the computation of normals. Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or
geometry, it may be wise to turn Normals and Gradients off.
obj.SetComputeGradients (int ) - Set/Get the computation of gradients. Gradient computation
is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be
calculated, but will not be stored in the output dataset. If the output data will be processed by filters that
modify topology or geometry, it may be wise to turn Normals and Gradients off.
int = obj.GetComputeGradients () - Set/Get the computation of gradients. Gradient computation is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to
be calculated, but will not be stored in the output dataset. If the output data will be processed by filters that
modify topology or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeGradientsOn () - Set/Get the computation of gradients. Gradient computation is fairly
expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated,
but will not be stored in the output dataset. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeGradientsOff () - Set/Get the computation of gradients. Gradient computation is fairly
expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated,
but will not be stored in the output dataset. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.SetComputeScalars (int ) - Set/Get the computation of scalars.
int = obj.GetComputeScalars () - Set/Get the computation of scalars.
obj.ComputeScalarsOn () - Set/Get the computation of scalars.
obj.ComputeScalarsOff () - Set/Get the computation of scalars.
obj.SetValue (int i, double value) - Get the ith contour value.
double = obj.GetValue (int i) - Get a pointer to an array of contour values. There will be GetNumberOfContours() values in the list.
obj.GetValues (double contourValues) - Set the number of contours to place into the list. You
only really need to use this method to reduce list size. The method SetValue() will automatically increase list
size as needed.
obj.SetNumberOfContours (int number) - Get the number of contours in the list of contour
values.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1348
int = obj.GetNumberOfContours () - Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.
obj.GenerateValues (int numContours, double range[2]) - Generate numContours
equally spaced contour values between specified range. Contour values will include min/max range values.
obj.GenerateValues (int numContours, double rangeStart, double rangeEnd) - Needed by templated functions.
obj.SetArrayComponent (int ) - Set/get which component of the scalar array to contour on; defaults to 0.
int = obj.GetArrayComponent () - Set/get which component of the scalar array to contour on;
defaults to 0.
obj.ComputeSpacing (vtkRectilinearGrid data, int i, int j, int k, int
extent[6], double spacing[6]) - Compute the spacing between this point and its 6 neighbors.
This method needs to be public so it can be accessed from a templated function.
34.188
vtkRecursiveDividingCubes
34.188.1
Usage
vtkRecursiveDividingCubes is a filter that generates points lying on a surface of constant scalar value (i.e., an
isosurface). Dense point clouds (i.e., at screen resolution) will appear as a surface. Less dense clouds can be used
as a source to generate streamlines or to generate "transparent" surfaces.
This implementation differs from vtkDividingCubes in that it uses a recursive procedure. In many cases this can
result in generating more points than the procedural implementation of vtkDividingCubes. This is because the
recursive procedure divides voxels by multiples of powers of two. This can over-constrain subdivision. One of the
advantages of the recursive technique is that the recursion is terminated earlier, which in some cases can be more
efficient.
To create an instance of class vtkRecursiveDividingCubes, simply invoke its constructor as follows
obj = vtkRecursiveDividingCubes
34.188.2
Methods
The class vtkRecursiveDividingCubes has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRecursiveDividingCubes
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRecursiveDividingCubes = obj.NewInstance ()
vtkRecursiveDividingCubes = obj.SafeDownCast (vtkObject o)
obj.SetValue (double ) - Set isosurface value.
double = obj.GetValue () - Set isosurface value.
obj.SetDistance (double ) - Specify sub-voxel size at which to generate point.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.189 vtkReflectionFilter
1349
34.189
vtkReflectionFilter
34.189.1
Usage
The vtkReflectionFilter reflects a data set across one of the planes formed by the data sets bounding box. Since it
converts data sets into unstructured grids, it is not effeicient for structured data sets.
To create an instance of class vtkReflectionFilter, simply invoke its constructor as follows
obj = vtkReflectionFilter
34.189.2
Methods
The class vtkReflectionFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkReflectionFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkReflectionFilter = obj.NewInstance ()
vtkReflectionFilter = obj.SafeDownCast (vtkObject o)
obj.SetPlane (int ) - Set the normal of the plane to use as mirror.
int = obj.GetPlaneMinValue () - Set the normal of the plane to use as mirror.
int = obj.GetPlaneMaxValue () - Set the normal of the plane to use as mirror.
int = obj.GetPlane () - Set the normal of the plane to use as mirror.
obj.SetPlaneToX () - Set the normal of the plane to use as mirror.
obj.SetPlaneToY () - Set the normal of the plane to use as mirror.
obj.SetPlaneToZ () - Set the normal of the plane to use as mirror.
obj.SetPlaneToXMin () - Set the normal of the plane to use as mirror.
obj.SetPlaneToYMin () - Set the normal of the plane to use as mirror.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1350
34.190
vtkRegularPolygonSource
34.190.1
Usage
vtkRegularPolygonSource is a source object that creates a single n-sided polygon and/or polyline. The polygon is
centered at a specified point, orthogonal to a specified normal, and with a circumscribing radius set by the user.
The user can also specify the number of sides of the polygon ranging from [3,N].
This object can be used for seeding streamlines or defining regions for clipping/cutting.
To create an instance of class vtkRegularPolygonSource, simply invoke its constructor as follows
obj = vtkRegularPolygonSource
34.190.2
Methods
The class vtkRegularPolygonSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRegularPolygonSource
class.
string = obj.GetClassName () - Standard methods for instantiation, obtaining type and printing
instance values.
int = obj.IsA (string name) - Standard methods for instantiation, obtaining type and printing
instance values.
vtkRegularPolygonSource = obj.NewInstance () - Standard methods for instantiation, obtaining type and printing instance values.
vtkRegularPolygonSource = obj.SafeDownCast (vtkObject o) - Standard methods for
instantiation, obtaining type and printing instance values.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.191 vtkReverseSense
1351
obj.SetNumberOfSides (int ) - Set/Get the number of sides of the polygon. By default, the number
of sides is set to six.
int = obj.GetNumberOfSidesMinValue () - Set/Get the number of sides of the polygon. By
default, the number of sides is set to six.
int = obj.GetNumberOfSidesMaxValue () - Set/Get the number of sides of the polygon. By
default, the number of sides is set to six.
int = obj.GetNumberOfSides () - Set/Get the number of sides of the polygon. By default, the
number of sides is set to six.
obj.SetCenter (double , double , double ) - Set/Get the center of the polygon. By default,
the center is set at the origin (0,0,0).
obj.SetCenter (double a[3]) - Set/Get the center of the polygon. By default, the center is set at
the origin (0,0,0).
double = obj.
the origin (0,0,0).
GetCenter () - Set/Get the center of the polygon. By default, the center is set at
obj.SetNormal (double , double , double ) - Set/Get the normal to the polygon. The ordering of the polygon will be counter-clockwise around the normal (i.e., using the right-hand rule). By default,
the normal is set to (0,0,1).
obj.SetNormal (double a[3]) - Set/Get the normal to the polygon. The ordering of the polygon
will be counter-clockwise around the normal (i.e., using the right-hand rule). By default, the normal is set to
(0,0,1).
double = obj. GetNormal () - Set/Get the normal to the polygon. The ordering of the polygon
will be counter-clockwise around the normal (i.e., using the right-hand rule). By default, the normal is set to
(0,0,1).
obj.SetRadius (double ) - Set/Get the radius of the polygon. By default, the radius is set to 0.5.
double = obj.GetRadius () - Set/Get the radius of the polygon. By default, the radius is set to 0.5.
obj.SetGeneratePolygon (int ) - Control whether a polygon is produced. By default, GeneratePolygon is enabled.
int = obj.GetGeneratePolygon () - Control whether a polygon is produced.
GeneratePolygon is enabled.
By default,
By default,
34.191
vtkReverseSense
1352
34.191.1
Usage
vtkReverseSense is a filter that reverses the order of polygonal cells and/or reverses the direction of point and cell
normals. Two flags are used to control these operations. Cell reversal means reversing the order of indices in the
cell connectivity list. Normal reversal means multiplying the normal vector by -1 (both point and cell normals, if
present).
To create an instance of class vtkReverseSense, simply invoke its constructor as follows
obj = vtkReverseSense
34.191.2
Methods
The class vtkReverseSense has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkReverseSense class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkReverseSense = obj.NewInstance ()
vtkReverseSense = obj.SafeDownCast (vtkObject o)
obj.SetReverseCells (int ) - Flag controls whether to reverse cell ordering.
int = obj.GetReverseCells () - Flag controls whether to reverse cell ordering.
obj.ReverseCellsOn () - Flag controls whether to reverse cell ordering.
obj.ReverseCellsOff () - Flag controls whether to reverse cell ordering.
obj.SetReverseNormals (int ) - Flag controls whether to reverse normal orientation.
int = obj.GetReverseNormals () - Flag controls whether to reverse normal orientation.
obj.ReverseNormalsOn () - Flag controls whether to reverse normal orientation.
obj.ReverseNormalsOff () - Flag controls whether to reverse normal orientation.
34.192
vtkRibbonFilter
34.192.1
Usage
vtkRibbonFilter is a filter to create oriented ribbons from lines defined in polygonal dataset. The orientation of the
ribbon is along the line segments and perpendicular to "projected" line normals. Projected line normals are the
original line normals projected to be perpendicular to the local line segment. An offset angle can be specified to
rotate the ribbon with respect to the normal.
To create an instance of class vtkRibbonFilter, simply invoke its constructor as follows
obj = vtkRibbonFilter
34.192 vtkRibbonFilter
34.192.2
1353
Methods
The class vtkRibbonFilter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkRibbonFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRibbonFilter = obj.NewInstance ()
vtkRibbonFilter = obj.SafeDownCast (vtkObject o)
obj.SetWidth (double ) - Set the "half" width of the ribbon. If the width is allowed to vary, this is the
minimum width. The default is 0.5
double = obj.GetWidthMinValue () - Set the "half" width of the ribbon. If the width is allowed to
vary, this is the minimum width. The default is 0.5
double = obj.GetWidthMaxValue () - Set the "half" width of the ribbon. If the width is allowed to
vary, this is the minimum width. The default is 0.5
double = obj.GetWidth () - Set the "half" width of the ribbon. If the width is allowed to vary, this is
the minimum width. The default is 0.5
obj.SetAngle (double ) - Set the offset angle of the ribbon from the line normal. (The angle is
expressed in degrees.) The default is 0.0
double = obj.GetAngleMinValue () - Set the offset angle of the ribbon from the line normal. (The
angle is expressed in degrees.) The default is 0.0
double = obj.GetAngleMaxValue () - Set the offset angle of the ribbon from the line normal. (The
angle is expressed in degrees.) The default is 0.0
double = obj.GetAngle () - Set the offset angle of the ribbon from the line normal. (The angle is
expressed in degrees.) The default is 0.0
obj.SetVaryWidth (int ) - Turn on/off the variation of ribbon width with scalar value. The default is
Off
int = obj.GetVaryWidth () - Turn on/off the variation of ribbon width with scalar value. The default
is Off
obj.VaryWidthOn () - Turn on/off the variation of ribbon width with scalar value. The default is Off
obj.VaryWidthOff () - Turn on/off the variation of ribbon width with scalar value. The default is Off
obj.SetWidthFactor (double ) - Set the maximum ribbon width in terms of a multiple of the minimum width. The default is 2.0
double = obj.GetWidthFactor () - Set the maximum ribbon width in terms of a multiple of the
minimum width. The default is 2.0
obj.SetDefaultNormal (double , double , double ) - Set the default normal to use if no
normals are supplied, and DefaultNormalOn is set. The default is (0,0,1)
obj.SetDefaultNormal (double a[3]) - Set the default normal to use if no normals are supplied,
and DefaultNormalOn is set. The default is (0,0,1)
double = obj. GetDefaultNormal () - Set the default normal to use if no normals are supplied,
and DefaultNormalOn is set. The default is (0,0,1)
obj.SetUseDefaultNormal (int ) - Set a boolean to control whether to use default normals. The
default is Off
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1354
34.193
vtkRotationalExtrusionFilter
34.193 vtkRotationalExtrusionFilter
34.193.1
1355
Usage
vtkRotationalExtrusionFilter is a modeling filter. It takes polygonal data as input and generates polygonal data on
output. The input dataset is swept around the z-axis to create new polygonal primitives. These primitives form a
"skirt" or swept surface. For example, sweeping a line results in a cylindrical shell, and sweeping a circle creates a
torus.
There are a number of control parameters for this filter. You can control whether the sweep of a 2D object (i.e.,
polygon or triangle strip) is capped with the generating geometry via the "Capping" instance variable. Also, you
can control the angle of rotation, and whether translation along the z-axis is performed along with the rotation.
(Translation is useful for creating "springs".) You also can adjust the radius of the generating geometry using the
"DeltaRotation" instance variable.
The skirt is generated by locating certain topological features. Free edges (edges of polygons or triangle strips only
used by one polygon or triangle strips) generate surfaces. This is true also of lines or polylines. Vertices generate
lines.
This filter can be used to model axisymmetric objects like cylinders, bottles, and wine glasses; or translational/rotational symmetric objects like springs or corkscrews.
To create an instance of class vtkRotationalExtrusionFilter, simply invoke its constructor as follows
obj = vtkRotationalExtrusionFilter
34.193.2
Methods
The class vtkRotationalExtrusionFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRotationalExtrusionFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRotationalExtrusionFilter = obj.NewInstance ()
vtkRotationalExtrusionFilter = obj.SafeDownCast (vtkObject o)
obj.SetResolution (int ) - Set/Get resolution of sweep operation. Resolution controls the number
of intermediate node points.
int = obj.GetResolutionMinValue () - Set/Get resolution of sweep operation. Resolution controls the number of intermediate node points.
int = obj.GetResolutionMaxValue () - Set/Get resolution of sweep operation. Resolution controls the number of intermediate node points.
int = obj.GetResolution () - Set/Get resolution of sweep operation. Resolution controls the number of intermediate node points.
obj.SetCapping (int ) - Turn on/off the capping of the skirt.
int = obj.GetCapping () - Turn on/off the capping of the skirt.
obj.CappingOn () - Turn on/off the capping of the skirt.
obj.CappingOff () - Turn on/off the capping of the skirt.
obj.SetAngle (double ) - Set/Get angle of rotation.
double = obj.GetAngle () - Set/Get angle of rotation.
obj.SetTranslation (double ) - Set/Get total amount of translation along the z-axis.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1356
34.194
vtkRotationFilter
34.194.1
Usage
The vtkRotationFilter duplicates a data set by rotation about one of the 3 axis of the datasets reference. Since it
converts data sets into unstructured grids, it is not efficient for structured data sets.
.SECTION Thanks Theophane Foggia of The Swiss National Supercomputing Centre (CSCS) for creating and
contributing this filter
To create an instance of class vtkRotationFilter, simply invoke its constructor as follows
obj = vtkRotationFilter
34.194.2
Methods
The class vtkRotationFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkRotationFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRotationFilter = obj.NewInstance ()
vtkRotationFilter = obj.SafeDownCast (vtkObject o)
obj.SetAxis (int ) - Set the axis of rotation to use. It is set by default to Z.
int = obj.GetAxisMinValue () - Set the axis of rotation to use. It is set by default to Z.
int = obj.GetAxisMaxValue () - Set the axis of rotation to use. It is set by default to Z.
int = obj.GetAxis () - Set the axis of rotation to use. It is set by default to Z.
obj.SetAxisToX () - Set the axis of rotation to use. It is set by default to Z.
obj.SetAxisToY () - Set the axis of rotation to use. It is set by default to Z.
obj.SetAxisToZ () - Set the axis of rotation to use. It is set by default to Z.
obj.SetAngle (double ) - Set the rotation angle to use.
double = obj.GetAngle () - Set the rotation angle to use.
obj.SetCenter (double , double , double ) - Set the rotation center coordinates.
obj.SetCenter (double a[3]) - Set the rotation center coordinates.
double = obj.
obj.SetNumberOfCopies (int ) - Set the number of copies to create. The source will be rotated N
times and a new polydata copy of the original created at each angular position All copies will be appended to
form a single output
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.195 vtkRuledSurfaceFilter
1357
int = obj.GetNumberOfCopies () - Set the number of copies to create. The source will be rotated
N times and a new polydata copy of the original created at each angular position All copies will be appended
to form a single output
obj.SetCopyInput (int ) - If on (the default), copy the input geometry to the output. If off, the output
will only contain the rotation.
int = obj.GetCopyInput () - If on (the default), copy the input geometry to the output. If off, the
output will only contain the rotation.
obj.CopyInputOn () - If on (the default), copy the input geometry to the output. If off, the output will
only contain the rotation.
obj.CopyInputOff () - If on (the default), copy the input geometry to the output. If off, the output will
only contain the rotation.
34.195
vtkRuledSurfaceFilter
34.195.1
Usage
vtkRuledSurfaceFilter is a filter that generates a surface from a set of lines. The lines are assumed to be "parallel"
in the sense that they do not intersect and remain somewhat close to one another. A surface is generated by
connecting the points defining each pair of lines with straight lines. This creates a strip for each pair of lines (i.e.,
a triangulation is created from two generating lines). The filter can handle an arbitrary number of lines, with lines
i and i+1 assumed connected. Note that there are several different approaches for creating the ruled surface, the
method for creating the surface can either use the input points or resample from the polylines (using a user-specified
resolution).
This filter offers some other important features. A DistanceFactor ivar is used to decide when two lines are too far
apart to connect. (The factor is a multiple of the distance between the first two points of the two lines defining the
strip.) If the distance between the two generating lines becomes too great, then the surface is not generated in that
region. (Note: if the lines separate and then merge, then a hole can be generated in the surface.) In addition, the
Offset and OnRation ivars can be used to create nifty striped surfaces. Closed surfaces (e.g., tubes) can be created
by setting the CloseSurface ivar. (The surface can be closed in the other direction by repeating the first and last
point in the polylines defining the surface.)
An important use of this filter is to combine it with vtkStreamLine to generate stream surfaces. It can also be used
to create surfaces from contours.
To create an instance of class vtkRuledSurfaceFilter, simply invoke its constructor as follows
obj = vtkRuledSurfaceFilter
34.195.2
Methods
The class vtkRuledSurfaceFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRuledSurfaceFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRuledSurfaceFilter = obj.NewInstance ()
vtkRuledSurfaceFilter = obj.SafeDownCast (vtkObject o)
obj.SetDistanceFactor (double ) - Set/Get the factor that controls tearing of the surface.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1358
34.195 vtkRuledSurfaceFilter
1359
int = obj.GetRuledMode () - Set the mode by which to create the ruled surface. (Dramatically
different results are possible depending on the chosen mode.) The resample mode evenly resamples the
polylines (based on length) and generates triangle strips. The point walk mode uses the existing points and
walks around the polyline using existing points.
obj.SetRuledModeToResample () - Set the mode by which to create the ruled surface. (Dramatically different results are possible depending on the chosen mode.) The resample mode evenly resamples
the polylines (based on length) and generates triangle strips. The point walk mode uses the existing points
and walks around the polyline using existing points.
obj.SetRuledModeToPointWalk () - Set the mode by which to create the ruled surface. (Dramatically different results are possible depending on the chosen mode.) The resample mode evenly resamples
the polylines (based on length) and generates triangle strips. The point walk mode uses the existing points
and walks around the polyline using existing points.
string = obj.GetRuledModeAsString () - Set the mode by which to create the ruled surface.
(Dramatically different results are possible depending on the chosen mode.) The resample mode evenly
resamples the polylines (based on length) and generates triangle strips. The point walk mode uses the
existing points and walks around the polyline using existing points.
obj.SetResolution (int , int ) - If the ruled surface generation mode is RESAMPLE, then
these parameters are used to determine the resample rate. Resolution[0] defines the resolution in the direction of the polylines; Resolution[1] defines the resolution across the polylines (i.e., direction orthogonal to
Resolution[0]).
obj.SetResolution (int a[2]) - If the ruled surface generation mode is RESAMPLE, then these
parameters are used to determine the resample rate. Resolution[0] defines the resolution in the direction of the polylines; Resolution[1] defines the resolution across the polylines (i.e., direction orthogonal to
Resolution[0]).
int = obj. GetResolution () - If the ruled surface generation mode is RESAMPLE, then these
parameters are used to determine the resample rate. Resolution[0] defines the resolution in the direction of the polylines; Resolution[1] defines the resolution across the polylines (i.e., direction orthogonal to
Resolution[0]).
obj.SetPassLines (int ) - Indicate whether the generating lines are to be passed to the output. By
defualt lines are not passed to the output.
int = obj.GetPassLines () - Indicate whether the generating lines are to be passed to the output.
By defualt lines are not passed to the output.
obj.PassLinesOn () - Indicate whether the generating lines are to be passed to the output. By defualt
lines are not passed to the output.
obj.PassLinesOff () - Indicate whether the generating lines are to be passed to the output. By defualt
lines are not passed to the output.
obj.SetOrientLoops (int ) - Indicate whether the starting points of the loops need to be determined. If set to 0, then its assumes that the 0th point of each loop should be always connected By defualt the
loops are not oriented.
int = obj.GetOrientLoops () - Indicate whether the starting points of the loops need to be determined. If set to 0, then its assumes that the 0th point of each loop should be always connected By defualt the
loops are not oriented.
obj.OrientLoopsOn () - Indicate whether the starting points of the loops need to be determined. If
set to 0, then its assumes that the 0th point of each loop should be always connected By defualt the loops
are not oriented.
obj.OrientLoopsOff () - Indicate whether the starting points of the loops need to be determined. If
set to 0, then its assumes that the 0th point of each loop should be always connected By defualt the loops
are not oriented.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1360
34.196
vtkSectorSource
34.196.1
Usage
vtkSectorSource creates a sector of a polygonal disk. The disk has zero height. The user can specify the inner and outer radius of the disk, the z-coordinate, and the radial and circumferential resolution of the polygonal
representation.
To create an instance of class vtkSectorSource, simply invoke its constructor as follows
obj = vtkSectorSource
34.196.2
Methods
The class vtkSectorSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkSectorSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSectorSource = obj.NewInstance ()
vtkSectorSource = obj.SafeDownCast (vtkObject o)
obj.SetInnerRadius (double ) - Specify inner radius of the sector.
double = obj.GetInnerRadiusMinValue () - Specify inner radius of the sector.
double = obj.GetInnerRadiusMaxValue () - Specify inner radius of the sector.
double = obj.GetInnerRadius () - Specify inner radius of the sector.
obj.SetOuterRadius (double ) - Specify outer radius of the sector.
double = obj.GetOuterRadiusMinValue () - Specify outer radius of the sector.
double = obj.GetOuterRadiusMaxValue () - Specify outer radius of the sector.
double = obj.GetOuterRadius () - Specify outer radius of the sector.
obj.SetZCoord (double ) - Specify the z coordinate of the sector.
double = obj.GetZCoordMinValue () - Specify the z coordinate of the sector.
double = obj.GetZCoordMaxValue () - Specify the z coordinate of the sector.
double = obj.GetZCoord () - Specify the z coordinate of the sector.
obj.SetRadialResolution (int ) - Set the number of points in radius direction.
int = obj.GetRadialResolutionMinValue () - Set the number of points in radius direction.
int = obj.GetRadialResolutionMaxValue () - Set the number of points in radius direction.
int = obj.GetRadialResolution () - Set the number of points in radius direction.
obj.SetCircumferentialResolution (int ) - Set the number of points in circumferential direction.
int = obj.GetCircumferentialResolutionMinValue () - Set the number of points in circumferential direction.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.197 vtkSelectEnclosedPoints
1361
34.197
vtkSelectEnclosedPoints
34.197.1
Usage
vtkSelectEnclosedPoints is a filter that evaluates all the input points to determine whether they are in an enclosed
surface. The filter produces a (0,1) mask (in the form of a vtkDataArray) that indicates whether points are outside
(mask value=0) or inside (mask value=1) a provided surface. (The name of the output vtkDataArray is "SelectedPointsArray".)
After running the filter, it is possible to query it as to whether a point is inside/outside by invoking the IsInside(ptId)
method.
To create an instance of class vtkSelectEnclosedPoints, simply invoke its constructor as follows
obj = vtkSelectEnclosedPoints
34.197.2
Methods
The class vtkSelectEnclosedPoints has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSelectEnclosedPoints
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSelectEnclosedPoints = obj.NewInstance ()
vtkSelectEnclosedPoints = obj.SafeDownCast (vtkObject o)
obj.SetSurface (vtkPolyData pd) - Set the surface to be used to test for containment. Two
methods are provided: one directly for vtkPolyData, and one for the output of a filter.
obj.SetSurfaceConnection (vtkAlgorithmOutput algOutput) - Set the surface to be
used to test for containment. Two methods are provided: one directly for vtkPolyData, and one for the output
of a filter.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1362
34.198
vtkSelectPolyData
34.198 vtkSelectPolyData
34.198.1
1363
Usage
vtkSelectPolyData is a filter that selects polygonal data based on defining a "loop" and indicating the region inside
of the loop. The mesh within the loop consists of complete cells (the cells are not cut). Alternatively, this filter can
be used to generate scalars. These scalar values, which are a distance measure to the loop, can be used to clip,
contour. or extract data (i.e., anything that an implicit function can do).
The loop is defined by an array of x-y-z point coordinates. (Coordinates should be in the same coordinate space as
the input polygonal data.) The loop can be concave and non-planar, but not self-intersecting. The input to the filter
is a polygonal mesh (only surface primitives such as triangle strips and polygons); the output is either a) a portion
of the original mesh laying within the selection loop (GenerateSelectionScalarsOff); or b) the same polygonal mesh
with the addition of scalar values (GenerateSelectionScalarsOn).
The algorithm works as follows. For each point coordinate in the loop, the closest point in the mesh is found. The
result is a loop of closest point ids from the mesh. Then, the edges in the mesh connecting the closest points (and
laying along the lines forming the loop) are found. A greedy edge tracking procedure is used as follows. At the
current point, the mesh edge oriented in the direction of and whose end point is closest to the line is chosen. The
edge is followed to the new end point, and the procedure is repeated. This process continues until the entire loop
has been created.
To determine what portion of the mesh is inside and outside of the loop, three options are possible. 1) the smallest
connected region, 2) the largest connected region, and 3) the connected region closest to a user specified point.
(Set the ivar SelectionMode.)
Once the loop is computed as above, the GenerateSelectionScalars controls the output of the filter. If on, then
scalar values are generated based on distance to the loop lines. Otherwise, the cells laying inside the selection loop
are output. By default, the mesh lying within the loop is output; however, if InsideOut is on, then the portion of the
mesh lying outside of the loop is output.
The filter can be configured to generate the unselected portions of the mesh as output by setting GenerateUnselectedOutput. Use the method GetUnselectedOutput to access this output. (Note: this flag is pertinent only
when GenerateSelectionScalars is off.)
To create an instance of class vtkSelectPolyData, simply invoke its constructor as follows
obj = vtkSelectPolyData
34.198.2
Methods
The class vtkSelectPolyData has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkSelectPolyData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSelectPolyData = obj.NewInstance ()
vtkSelectPolyData = obj.SafeDownCast (vtkObject o)
obj.SetGenerateSelectionScalars (int ) - Set/Get the flag to control behavior of the filter. If
GenerateSelectionScalars is on, then the output of the filter is the same as the input, except that scalars are
generated. If off, the filter outputs the cells laying inside the loop, and does not generate scalars.
int = obj.GetGenerateSelectionScalars () - Set/Get the flag to control behavior of the filter.
If GenerateSelectionScalars is on, then the output of the filter is the same as the input, except that scalars
are generated. If off, the filter outputs the cells laying inside the loop, and does not generate scalars.
obj.GenerateSelectionScalarsOn () - Set/Get the flag to control behavior of the filter. If
GenerateSelectionScalars is on, then the output of the filter is the same as the input, except that scalars
are generated. If off, the filter outputs the cells laying inside the loop, and does not generate scalars.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1364
34.199
vtkShrinkFilter
34.200 vtkShrinkPolyData
34.199.1
1365
Usage
vtkShrinkFilter shrinks cells composing an arbitrary data set towards their centroid. The centroid of a cell is computed as the average position of the cell points. Shrinking results in disconnecting the cells from one another. The
output of this filter is of general dataset type vtkUnstructuredGrid.
To create an instance of class vtkShrinkFilter, simply invoke its constructor as follows
obj = vtkShrinkFilter
34.199.2
Methods
The class vtkShrinkFilter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkShrinkFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkShrinkFilter = obj.NewInstance ()
vtkShrinkFilter = obj.SafeDownCast (vtkObject o)
obj.SetShrinkFactor (double ) - Get/Set the fraction of shrink for each cell. The default is 0.5.
double = obj.GetShrinkFactorMinValue () - Get/Set the fraction of shrink for each cell. The
default is 0.5.
double = obj.GetShrinkFactorMaxValue () - Get/Set the fraction of shrink for each cell. The
default is 0.5.
double = obj.GetShrinkFactor () - Get/Set the fraction of shrink for each cell. The default is
0.5.
34.200
vtkShrinkPolyData
34.200.1
Usage
vtkShrinkPolyData shrinks cells composing a polygonal dataset (e.g., vertices, lines, polygons, and triangle strips)
towards their centroid. The centroid of a cell is computed as the average position of the cell points. Shrinking results
in disconnecting the cells from one another. The output dataset type of this filter is polygonal data.
During execution the filter passes its input cell data to its output. Point data attributes are copied to the points
created during the shrinking process.
To create an instance of class vtkShrinkPolyData, simply invoke its constructor as follows
obj = vtkShrinkPolyData
34.200.2
Methods
The class vtkShrinkPolyData has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkShrinkPolyData class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1366
34.201
vtkSimpleElevationFilter
34.201.1
Usage
vtkSimpleElevationFilter is a filter to generate scalar values from a dataset. The scalar values are generated by
dotting a user-specified vector against a vector defined from the input dataset points to the origin.
To create an instance of class vtkSimpleElevationFilter, simply invoke its constructor as follows
obj = vtkSimpleElevationFilter
34.201.2
Methods
The class vtkSimpleElevationFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSimpleElevationFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSimpleElevationFilter = obj.NewInstance ()
vtkSimpleElevationFilter = obj.SafeDownCast (vtkObject o)
obj.SetVector (double , double , double ) - Define one end of the line (small scalar values).
obj.SetVector (double a[3]) - Define one end of the line (small scalar values).
double = obj.
34.202
vtkSliceCubes
34.203 vtkSmoothPolyDataFilter
34.202.1
1367
Usage
vtkSliceCubes is a special version of the marching cubes filter. Instead of ingesting an entire volume at once it
processes only four slices at a time. This way, it can generate isosurfaces from huge volumes. Also, the output of
this object is written to a marching cubes triangle file. That way, output triangles do not need to be held in memory.
To use vtkSliceCubes you must specify an instance of vtkVolumeReader to read the data. Set this object up with
the proper file prefix, image range, data origin, data dimensions, header size, data mask, and swap bytes flag. The
vtkSliceCubes object will then take over and read slices as necessary. You also will need to specify the name of an
output marching cubes triangle file.
To create an instance of class vtkSliceCubes, simply invoke its constructor as follows
obj = vtkSliceCubes
34.202.2
Methods
The class vtkSliceCubes has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkSliceCubes class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSliceCubes = obj.NewInstance ()
vtkSliceCubes = obj.SafeDownCast (vtkObject o)
obj.Write ()
obj.Update ()
obj.SetReader (vtkVolumeReader ) - Set/get object to read slices.
vtkVolumeReader = obj.GetReader () - Set/get object to read slices.
obj.SetFileName (string ) - Specify file name of marching cubes output file.
string = obj.GetFileName () - Specify file name of marching cubes output file.
obj.SetValue (double ) - Set/get isosurface contour value.
double = obj.GetValue () - Set/get isosurface contour value.
obj.SetLimitsFileName (string ) - Specify file name of marching cubes limits file. The limits file
speeds up subsequent reading of output triangle file.
string = obj.GetLimitsFileName () - Specify file name of marching cubes limits file. The limits
file speeds up subsequent reading of output triangle file.
34.203
vtkSmoothPolyDataFilter
1368
34.203.1
Usage
vtkSmoothPolyDataFilter is a filter that adjusts point coordinates using Laplacian smoothing. The effect is to "relax"
the mesh, making the cells better shaped and the vertices more evenly distributed. Note that this filter operates on
the lines, polygons, and triangle strips composing an instance of vtkPolyData. Vertex or poly-vertex cells are never
modified.
The algorithm proceeds as follows. For each vertex v, a topological and geometric analysis is performed to determine which vertices are connected to v, and which cells are connected to v. Then, a connectivity array is constructed
for each vertex. (The connectivity array is a list of lists of vertices that directly attach to each vertex.) Next, an iteration phase begins over all vertices. For each vertex v, the coordinates of v are modified according to an average
of the connected vertices. (A relaxation factor is available to control the amount of displacement of v). The process
repeats for each vertex. This pass over the list of vertices is a single iteration. Many iterations (generally around 20
or so) are repeated until the desired result is obtained.
There are some special instance variables used to control the execution of this filter. (These ivars basically control
what vertices can be smoothed, and the creation of the connectivity array.) The BoundarySmoothing ivar enables/disables the smoothing operation on vertices that are on the "boundary" of the mesh. A boundary vertex is
one that is surrounded by a semi-cycle of polygons (or used by a single line).
Another important ivar is FeatureEdgeSmoothing. If this ivar is enabled, then interior vertices are classified as either
"simple", "interior edge", or "fixed", and smoothed differently. (Interior vertices are manifold vertices surrounded by
a cycle of polygons; or used by two line cells.) The classification is based on the number of feature edges attached
to v. A feature edge occurs when the angle between the two surface normals of a polygon sharing an edge is
greater than the FeatureAngle ivar. Then, vertices used by no feature edges are classified "simple", vertices used
by exactly two feature edges are classified "interior edge", and all others are "fixed" vertices.
Once the classification is known, the vertices are smoothed differently. Corner (i.e., fixed) vertices are not smoothed
at all. Simple vertices are smoothed as before (i.e., average of connected vertex coordinates). Interior edge vertices
are smoothed only along their two connected edges, and only if the angle between the edges is less than the EdgeAngle ivar.
The total smoothing can be controlled by using two ivars. The NumberOfIterations is a cap on the maximum number
of smoothing passes. The Convergence ivar is a limit on the maximum point motion. If the maximum motion during
an iteration is less than Convergence, then the smoothing process terminates. (Convergence is expressed as a
fraction of the diagonal of the bounding box.)
There are two instance variables that control the generation of error data. If the ivar GenerateErrorScalars is on,
then a scalar value indicating the distance of each vertex from its original position is computed. If the ivar GenerateErrorVectors is on, then a vector representing change in position is computed.
Optionally you can further control the smoothing process by defining a second input: the Source. If defined, the
input mesh is constrained to lie on the surface defined by the Source ivar.
To create an instance of class vtkSmoothPolyDataFilter, simply invoke its constructor as follows
obj = vtkSmoothPolyDataFilter
34.203.2
Methods
The class vtkSmoothPolyDataFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSmoothPolyDataFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSmoothPolyDataFilter = obj.NewInstance ()
vtkSmoothPolyDataFilter = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.203 vtkSmoothPolyDataFilter
1369
obj.SetConvergence (double ) - Specify a convergence criterion for the iteration process. Smaller
numbers result in more smoothing iterations.
double = obj.GetConvergenceMinValue () - Specify a convergence criterion for the iteration
process. Smaller numbers result in more smoothing iterations.
double = obj.GetConvergenceMaxValue () - Specify a convergence criterion for the iteration
process. Smaller numbers result in more smoothing iterations.
double = obj.GetConvergence () - Specify a convergence criterion for the iteration process.
Smaller numbers result in more smoothing iterations.
obj.SetNumberOfIterations (int ) - Specify the number of iterations for Laplacian smoothing,
int = obj.GetNumberOfIterationsMinValue () - Specify the number of iterations for Laplacian smoothing,
int = obj.GetNumberOfIterationsMaxValue () - Specify the number of iterations for Laplacian smoothing,
int = obj.GetNumberOfIterations () - Specify the number of iterations for Laplacian smoothing,
obj.SetRelaxationFactor (double ) - Specify the relaxation factor for Laplacian smoothing. As
in all iterative methods, the stability of the process is sensitive to this parameter. In general, small relaxation
factors and large numbers of iterations are more stable than larger relaxation factors and smaller numbers of
iterations.
double = obj.GetRelaxationFactor () - Specify the relaxation factor for Laplacian smoothing.
As in all iterative methods, the stability of the process is sensitive to this parameter. In general, small relaxation
factors and large numbers of iterations are more stable than larger relaxation factors and smaller numbers of
iterations.
obj.SetFeatureEdgeSmoothing (int ) - Turn on/off smoothing along sharp interior edges.
int = obj.GetFeatureEdgeSmoothing () - Turn on/off smoothing along sharp interior edges.
obj.FeatureEdgeSmoothingOn () - Turn on/off smoothing along sharp interior edges.
obj.FeatureEdgeSmoothingOff () - Turn on/off smoothing along sharp interior edges.
obj.SetFeatureAngle (double ) - Specify the feature angle for sharp edge identification.
double = obj.GetFeatureAngleMinValue () - Specify the feature angle for sharp edge identification.
double = obj.GetFeatureAngleMaxValue () - Specify the feature angle for sharp edge identification.
double = obj.GetFeatureAngle () - Specify the feature angle for sharp edge identification.
obj.SetEdgeAngle (double ) - Specify the edge angle to control smoothing along edges (either
interior or boundary).
double = obj.GetEdgeAngleMinValue () - Specify the edge angle to control smoothing along
edges (either interior or boundary).
double = obj.GetEdgeAngleMaxValue () - Specify the edge angle to control smoothing along
edges (either interior or boundary).
double = obj.GetEdgeAngle () - Specify the edge angle to control smoothing along edges (either
interior or boundary).
obj.SetBoundarySmoothing (int ) - Turn on/off the smoothing of vertices on the boundary of the
mesh.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1370
34.204
vtkSpatialRepresentationFilter
34.204.1
Usage
34.205 vtkSpherePuzzle
34.204.2
1371
Methods
The class vtkSpatialRepresentationFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSpatialRepresentationFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSpatialRepresentationFilter = obj.NewInstance ()
vtkSpatialRepresentationFilter = obj.SafeDownCast (vtkObject o)
obj.SetSpatialRepresentation (vtkLocator ) - Set/Get the locator that will be used to generate the representation.
vtkLocator = obj.GetSpatialRepresentation () - Set/Get the locator that will be used to
generate the representation.
int = obj.GetLevel () - Get the maximum number of outputs actually available.
vtkPolyData = obj.GetOutput (int level) - A special form of the GetOutput() method that
returns multiple outputs.
vtkPolyData = obj.GetOutput () - Output of terminal nodes/leaves.
obj.ResetOutput () - Reset requested output levels
obj.SetInput (vtkDataSet input) - Set / get the input data or filter.
vtkDataSet = obj.GetInput () - Set / get the input data or filter.
34.205
vtkSpherePuzzle
34.205.1
Usage
vtkSpherePuzzle creates
To create an instance of class vtkSpherePuzzle, simply invoke its constructor as follows
obj = vtkSpherePuzzle
34.205.2
Methods
The class vtkSpherePuzzle has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkSpherePuzzle class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSpherePuzzle = obj.NewInstance ()
vtkSpherePuzzle = obj.SafeDownCast (vtkObject o)
obj.Reset () - Reset the state of this puzzle back to its original state.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1372
34.206
vtkSpherePuzzleArrows
34.206.1
Usage
vtkSpherePuzzleArrows creates
To create an instance of class vtkSpherePuzzleArrows, simply invoke its constructor as follows
obj = vtkSpherePuzzleArrows
34.206.2
Methods
The class vtkSpherePuzzleArrows has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSpherePuzzleArrows
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSpherePuzzleArrows = obj.NewInstance ()
vtkSpherePuzzleArrows = obj.SafeDownCast (vtkObject o)
obj.SetPermutation (int [32]) - Permutation is an array of puzzle piece ids. Arrows will be
generated for any id that does not contain itself. Permutation[3] = 3 will produce no arrow. Permutation[3] =
10 will draw an arrow from location 3 to 10.
int = obj. GetPermutation () - Permutation is an array of puzzle piece ids. Arrows will be
generated for any id that does not contain itself. Permutation[3] = 3 will produce no arrow. Permutation[3] =
10 will draw an arrow from location 3 to 10.
obj.SetPermutationComponent (int comp, int val) - Permutation is an array of puzzle
piece ids. Arrows will be generated for any id that does not contain itself. Permutation[3] = 3 will produce no
arrow. Permutation[3] = 10 will draw an arrow from location 3 to 10.
obj.SetPermutation (vtkSpherePuzzle puz) - Permutation is an array of puzzle piece ids.
Arrows will be generated for any id that does not contain itself. Permutation[3] = 3 will produce no arrow.
Permutation[3] = 10 will draw an arrow from location 3 to 10.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.207 vtkSphereSource
34.207
1373
vtkSphereSource
34.207.1
Usage
vtkSphereSource creates a sphere (represented by polygons) of specified radius centered at the origin. The resolution (polygonal discretization) in both the latitude (phi) and longitude (theta) directions can be specified. It also is
possible to create partial spheres by specifying maximum phi and theta angles. By default, the surface tessellation
of the sphere uses triangles; however you can set LatLongTessellation to produce a tessellation using quadrilaterals.
To create an instance of class vtkSphereSource, simply invoke its constructor as follows
obj = vtkSphereSource
34.207.2
Methods
The class vtkSphereSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkSphereSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSphereSource = obj.NewInstance ()
vtkSphereSource = obj.SafeDownCast (vtkObject o)
obj.SetRadius (double ) - Set radius of sphere. Default is .5.
double = obj.GetRadiusMinValue () - Set radius of sphere. Default is .5.
double = obj.GetRadiusMaxValue () - Set radius of sphere. Default is .5.
double = obj.GetRadius () - Set radius of sphere. Default is .5.
obj.SetCenter (double , double , double ) - Set the center of the sphere. Default is 0,0,0.
obj.SetCenter (double a[3]) - Set the center of the sphere. Default is 0,0,0.
double = obj.
obj.SetThetaResolution (int ) - Set the number of points in the longitude direction (ranging from
StartTheta to EndTheta).
int = obj.GetThetaResolutionMinValue () - Set the number of points in the longitude direction (ranging from StartTheta to EndTheta).
int = obj.GetThetaResolutionMaxValue () - Set the number of points in the longitude direction (ranging from StartTheta to EndTheta).
int = obj.GetThetaResolution () - Set the number of points in the longitude direction (ranging
from StartTheta to EndTheta).
obj.SetPhiResolution (int ) - Set the number of points in the latitude direction (ranging from
StartPhi to EndPhi).
int = obj.GetPhiResolutionMinValue () - Set the number of points in the latitude direction
(ranging from StartPhi to EndPhi).
int = obj.GetPhiResolutionMaxValue () - Set the number of points in the latitude direction
(ranging from StartPhi to EndPhi).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1374
int = obj.GetPhiResolution () - Set the number of points in the latitude direction (ranging from
StartPhi to EndPhi).
obj.SetStartTheta (double ) - Set the starting longitude angle. By default StartTheta=0 degrees.
double = obj.GetStartThetaMinValue () - Set the starting longitude angle. By default StartTheta=0 degrees.
double = obj.GetStartThetaMaxValue () - Set the starting longitude angle. By default StartTheta=0 degrees.
double = obj.GetStartTheta () - Set the starting longitude angle. By default StartTheta=0 degrees.
obj.SetEndTheta (double ) - Set the ending longitude angle. By default EndTheta=360 degrees.
double = obj.GetEndThetaMinValue () - Set the ending longitude angle.
Theta=360 degrees.
By default End-
By default End-
double = obj.GetEndTheta () - Set the ending longitude angle. By default EndTheta=360 degrees.
obj.SetStartPhi (double ) - Set the starting latitude angle (0 is at north pole). By default StartPhi=0 degrees.
double = obj.GetStartPhiMinValue () - Set the starting latitude angle (0 is at north pole). By
default StartPhi=0 degrees.
double = obj.GetStartPhiMaxValue () - Set the starting latitude angle (0 is at north pole). By
default StartPhi=0 degrees.
double = obj.GetStartPhi () - Set the starting latitude angle (0 is at north pole). By default StartPhi=0 degrees.
obj.SetEndPhi (double ) - Set the ending latitude angle. By default EndPhi=180 degrees.
double = obj.GetEndPhiMinValue () - Set the ending latitude angle. By default EndPhi=180
degrees.
double = obj.GetEndPhiMaxValue () - Set the ending latitude angle. By default EndPhi=180
degrees.
double = obj.GetEndPhi () - Set the ending latitude angle. By default EndPhi=180 degrees.
obj.SetLatLongTessellation (int ) - Cause the sphere to be tessellated with edges along the
latitude and longitude lines. If off, triangles are generated at non-polar regions, which results in edges that
are not parallel to latitude and longitude lines. If on, quadrilaterals are generated everywhere except at the
poles. This can be useful for generating a wireframe sphere with natural latitude and longitude lines.
int = obj.GetLatLongTessellation () - Cause the sphere to be tessellated with edges along
the latitude and longitude lines. If off, triangles are generated at non-polar regions, which results in edges
that are not parallel to latitude and longitude lines. If on, quadrilaterals are generated everywhere except at
the poles. This can be useful for generating a wireframe sphere with natural latitude and longitude lines.
obj.LatLongTessellationOn () - Cause the sphere to be tessellated with edges along the latitude
and longitude lines. If off, triangles are generated at non-polar regions, which results in edges that are not
parallel to latitude and longitude lines. If on, quadrilaterals are generated everywhere except at the poles.
This can be useful for generating a wireframe sphere with natural latitude and longitude lines.
obj.LatLongTessellationOff () - Cause the sphere to be tessellated with edges along the latitude and longitude lines. If off, triangles are generated at non-polar regions, which results in edges that are
not parallel to latitude and longitude lines. If on, quadrilaterals are generated everywhere except at the poles.
This can be useful for generating a wireframe sphere with natural latitude and longitude lines.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.208 vtkSplineFilter
34.208
1375
vtkSplineFilter
34.208.1
Usage
vtkSplineFilter is a filter that generates an output polylines from an input set of polylines. The polylines are uniformly
subdivided and produced with the help of a vtkSpline class that the user can specify (by default a vtkCardinalSpline
is used). The number of subdivisions of the line can be controlled in several ways. The user can either specify
the number of subdivisions or a length of each subdivision can be provided (and the class will figure out how many
subdivisions is required over the whole polyline). The maximum number of subdivisions can also be set.
The output of this filter is a polyline per input polyline (or line). New points and texture coordinates are created.
Point data is interpolated and cell data passed on. Any polylines with less than two points, or who have coincident
points, are ignored.
To create an instance of class vtkSplineFilter, simply invoke its constructor as follows
obj = vtkSplineFilter
34.208.2
Methods
The class vtkSplineFilter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkSplineFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSplineFilter = obj.NewInstance ()
vtkSplineFilter = obj.SafeDownCast (vtkObject o)
obj.SetMaximumNumberOfSubdivisions (int ) - Set the maximum number of subdivisions
that are created for each polyline.
int = obj.GetMaximumNumberOfSubdivisionsMinValue () - Set the maximum number of
subdivisions that are created for each polyline.
int = obj.GetMaximumNumberOfSubdivisionsMaxValue () - Set the maximum number of
subdivisions that are created for each polyline.
int = obj.GetMaximumNumberOfSubdivisions () - Set the maximum number of subdivisions
that are created for each polyline.
obj.SetSubdivide (int ) - Specify how the number of subdivisions is determined.
int = obj.GetSubdivideMinValue () - Specify how the number of subdivisions is determined.
int = obj.GetSubdivideMaxValue () - Specify how the number of subdivisions is determined.
int = obj.GetSubdivide () - Specify how the number of subdivisions is determined.
obj.SetSubdivideToSpecified () - Specify how the number of subdivisions is determined.
obj.SetSubdivideToLength () - Specify how the number of subdivisions is determined.
string = obj.GetSubdivideAsString () - Specify how the number of subdivisions is determined.
obj.SetNumberOfSubdivisions (int ) - Set the number of subdivisions that are created for the
polyline. This method only has effect if Subdivisions is set to SetSubdivisionsToSpecify().
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1376
34.209 vtkSplitField
1377
34.209
vtkSplitField
34.209.1
Usage
vtkSplitField is used to split a multi-component field (vtkDataArray) into multiple single component fields. The new
fields are put in the same field data as the original field. The output arrays are of the same type as the input array.
Example:
sf->SetInputField("gradient", vtkSplitField::POINT_DATA);
sf->Split(0, "firstcomponent");
tells vtkSplitField to extract the first component of the field called gradient and create an array called firstcomponent
(the new field will be in the outputs point data). The same can be done from Tcl:
sf SetInputField gradient POINT_DATA
sf Split 0 firstcomponent
AttributeTypes: SCALARS, VECTORS, NORMALS, TCOORDS, TENSORS
Field locations: DATA_OBJECT, POINT_DATA, CELL_DATA
34.209.2
Methods
The class vtkSplitField has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkSplitField class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1378
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSplitField = obj.NewInstance ()
vtkSplitField = obj.SafeDownCast (vtkObject o)
obj.SetInputField (int attributeType, int fieldLoc) - Use the given attribute in the
field data given by fieldLoc as input.
obj.SetInputField (string name, int fieldLoc) - Use the array with given name in the
field data given by fieldLoc as input.
obj.SetInputField (string name, string fieldLoc) - Helper method used by other language bindings. Allows the caller to specify arguments as strings instead of enums.
obj.Split (int component, string arrayName) - Create a new array with the given component.
34.210
vtkStreamer
34.210.1
Usage
vtkStreamer is a filter that integrates a massless particle through a vector field. The integration is performed using second order Runge-Kutta method. vtkStreamer often serves as a base class for other classes that perform
numerical integration through a vector field (e.g., vtkStreamLine).
Note that vtkStreamer can integrate both forward and backward in time, or in both directions. The length of the
streamer is controlled by specifying an elapsed time. (The elapsed time is the time each particle travels.) Otherwise,
the integration terminates after exiting the dataset or if the particle speed is reduced to a value less than the terminal
speed.
vtkStreamer integrates through any type of dataset. As a result, if the dataset contains 2D cells such as polygons
or triangles, the integration is constrained to lie on the surface defined by the 2D cells.
The starting point of streamers may be defined in three different ways. Starting from global x-y-z "position" allows
you to start a single streamer at a specified x-y-z coordinate. Starting from "location" allows you to start at a specified
cell, subId, and parametric coordinate. Finally, you may specify a source object to start multiple streamers. If you
start streamers using a source object, for each point in the source that is inside the dataset a streamer is created.
vtkStreamer implements the integration process in the Integrate() method. Because vtkStreamer does not implement the Execute() method that its superclass (i.e., Filter) requires, it is an abstract class. Its subclasses implement
the execute method and use the Integrate() method, and then build their own representation of the integration path
(i.e., lines, dashed lines, points, etc.).
To create an instance of class vtkStreamer, simply invoke its constructor as follows
obj = vtkStreamer
34.210.2
Methods
The class vtkStreamer has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkStreamer class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.210 vtkStreamer
1379
vtkStreamer = obj.NewInstance ()
vtkStreamer = obj.SafeDownCast (vtkObject o)
obj.SetStartLocation (vtkIdType cellId, int subId, double pcoords[3]) Specify the start of the streamline in the cell coordinate system. That is, cellId and subId (if composite cell),
and parametric coordinates.
obj.SetStartLocation (vtkIdType cellId, int subId, double r, double s,
double t) - Specify the start of the streamline in the cell coordinate system. That is, cellId and subId (if
composite cell), and parametric coordinates.
obj.SetStartPosition (double x[3]) - Specify the start of the streamline in the global coordinate system. Search must be performed to find initial cell to start integration from.
obj.SetStartPosition (double x, double y, double z) - Specify the start of the
streamline in the global coordinate system. Search must be performed to find initial cell to start integration
from.
double = obj.GetStartPosition () - Get the start position in global x-y-z coordinates.
obj.SetSource (vtkDataSet source) - Specify the source object used to generate starting
points.
vtkDataSet = obj.GetSource () - Specify the source object used to generate starting points.
obj.SetMaximumPropagationTime (double ) - Specify the maximum length of the Streamer
expressed in elapsed time.
double = obj.GetMaximumPropagationTimeMinValue () - Specify the maximum length of
the Streamer expressed in elapsed time.
double = obj.GetMaximumPropagationTimeMaxValue () - Specify the maximum length of
the Streamer expressed in elapsed time.
double = obj.GetMaximumPropagationTime () - Specify the maximum length of the Streamer
expressed in elapsed time.
obj.SetIntegrationDirection (int ) - Specify the direction in which to integrate the Streamer.
int = obj.GetIntegrationDirectionMinValue () - Specify the direction in which to integrate the Streamer.
int = obj.GetIntegrationDirectionMaxValue () - Specify the direction in which to integrate the Streamer.
int = obj.GetIntegrationDirection () - Specify the direction in which to integrate the
Streamer.
obj.SetIntegrationDirectionToForward () - Specify the direction in which to integrate the
Streamer.
obj.SetIntegrationDirectionToBackward () - Specify the direction in which to integrate the
Streamer.
obj.SetIntegrationDirectionToIntegrateBothDirections () - Specify the direction in
which to integrate the Streamer.
string = obj.GetIntegrationDirectionAsString () - Specify the direction in which to integrate the Streamer.
obj.SetIntegrationStepLength (double ) - Specify a nominal integration step size (expressed as a fraction of the size of each cell). This value can be larger than 1.
double = obj.GetIntegrationStepLengthMinValue () - Specify a nominal integration step
size (expressed as a fraction of the size of each cell). This value can be larger than 1.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1380
34.211 vtkStreamingTessellator
1381
obj.SetNumberOfThreads (int )
int = obj.GetNumberOfThreads ()
obj.SetSavePointInterval (double )
double = obj.GetSavePointInterval ()
obj.SetIntegrator (vtkInitialValueProblemSolver ) - Set/get the integrator type to be
used in the stream line calculation. The object passed is not actually used but is cloned with NewInstance by
each thread/process in the process of integration (prototype pattern). The default is 2nd order Runge Kutta.
vtkInitialValueProblemSolver = obj.GetIntegrator () - Set/get the integrator type to
be used in the stream line calculation. The object passed is not actually used but is cloned with NewInstance
by each thread/process in the process of integration (prototype pattern). The default is 2nd order Runge
Kutta.
obj.SetEpsilon (double ) - A positive value, as small as possible for numerical comparison. The
initial value is 1E-12.
double = obj.GetEpsilon () - A positive value, as small as possible for numerical comparison.
The initial value is 1E-12.
34.211
vtkStreamingTessellator
34.211.1
Usage
This class is a simple algorithm that takes a single starting simplex a tetrahedron, triangle, or line segment and
calls a function you pass it with (possibly many times) tetrahedra, triangles, or lines adaptively sampled from the
one you specified. It uses an algorithm you specify to control the level of adaptivity.
This class does not create vtkUnstructuredGrid output because it is intended for use in mappers as well as filters.
Instead, it calls the registered function with simplices as they are created.
The subdivision algorithm should change the vertex coordinates (it must change both geometric and, if desired,
parametric coordinates) of the midpoint. These coordinates need not be changed unless the EvaluateEdge() member returns true. The vtkStreamingTessellator itself has no way of creating a more accurate midpoint vertex.
Heres how to use this class:
Call AdaptivelySample1Facet, AdaptivelySample2Facet, or AdaptivelySample3Facet, with an edge, triangle,
or tetrahedron you want tessellated.
The adaptive tessellator classifies each edge by passing the midpoint values to the vtkEdgeSubdivisionCriterion.
After each edge is classified, the tessellator subdivides edges as required until the subdivision criterion is
satisfied or the maximum subdivision depth has been reached.
Edges, triangles, or tetrahedra connecting the vertices generated by the subdivision algorithm are processed
by calling the user-defined callback functions (set with SetTetrahedronCallback(), SetTriangleCallback(), or
SetEdgeCallback() ).
.SECTION Warning Note that the vertices passed to AdaptivelySample3Facet, AdaptivelySample2Facet, or
AdaptivelySample1Facet must be at least 6, 5, or 4 entries long, respectively! This is because the <r,s,t>, <r,s>,
or <r> parametric coordinates of the vertices are maintained as the facet is subdivided. This information is often
required by the subdivision algorithm in order to compute an error metric. You may change the number of parametric
coordinates associated with each vertex using vtkStreamingTessellator::SetEmbeddingDimension().
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1382
.SECTION Interpolating Field Values If you wish, you may also use vtkStreamingTessellator to interpolate
field values at newly created vertices. Interpolated field values are stored just beyond the parametric coordinates
associated with a vertex. They will always be double values; it does not make sense to interpolate a boolean or
string value and your output and subdivision subroutines may always cast to a float or use floor() to truncate
an interpolated value to an integer.
To create an instance of class vtkStreamingTessellator, simply invoke its constructor as follows
obj = vtkStreamingTessellator
34.211.2
Methods
The class vtkStreamingTessellator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStreamingTessellator
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStreamingTessellator = obj.NewInstance ()
vtkStreamingTessellator = obj.SafeDownCast (vtkObject o)
obj.SetSubdivisionAlgorithm (vtkEdgeSubdivisionCriterion ) - Get/Set the algorithm used to determine whether an edge should be subdivided or left as-is. This is used once for each call
to AdaptivelySample1Facet (which is recursive and will call itself resulting in additional edges to be checked)
or three times for each call to AdaptivelySample2Facet (also recursive).
vtkEdgeSubdivisionCriterion = obj.GetSubdivisionAlgorithm () - Get/Set the algorithm used to determine whether an edge should be subdivided or left as-is. This is used once for each call
to AdaptivelySample1Facet (which is recursive and will call itself resulting in additional edges to be checked)
or three times for each call to AdaptivelySample2Facet (also recursive).
obj.SetEmbeddingDimension (int k, int d) - Get/Set the number of parameter-space coordinates associated with each input and output point. The default is k for k -facets. You may specify a different
dimension, d, for each type of k -facet to be processed. For example, SetEmbeddingDimension( 2,
3 ) would associate r, s, and t coordinates with each input and output point generated by AdaptivelySample2Facet but does not say anything about input or output points generated by AdaptivelySample1Facet. Call SetEmbeddingDimension( -1, d ) to specify the same dimension for all possible k values. d may not exceed 8, as that would be plain silly.
int = obj.GetEmbeddingDimension (int k) const - Get/Set the number of parameterspace coordinates associated with each input and output point. The default is k for k -facets. You may
specify a different dimension, d, for each type of k -facet to be processed. For example, SetEmbeddingDimension( 2, 3 ) would associate r, s, and t coordinates with each input and output point generated
by AdaptivelySample2Facet but does not say anything about input or output points generated by
AdaptivelySample1Facet. Call SetEmbeddingDimension( -1, d ) to specify the same dimension for all possible k values. d may not exceed 8, as that would be plain silly.
obj.SetFieldSize (int k, int s) - Get/Set the number of field value coordinates associated
with each input and output point. The default is 0; no field values are interpolated. You may specify a different
size, s, for each type of k -facet to be processed. For example, SetFieldSize( 2, 3 ) would associate 3
field value coordinates with each input and output point of an AdaptivelySample2Facet call, but does
not say anything about input or output points of AdaptivelySample1Facet. Call SetFieldSize(
-1, s ) to specify the same dimension for all possible k values. s may not exceed vtkStreamingTessellator::MaxFieldSize. This is a compile-time constant that defaults to 18, which is large enough for a scalar, vector,
tensor, normal, and texture coordinate to be included at each point.
Normally, you will not call SetFieldSize() directly; instead, subclasses of vtkEdgeSubdivisionCriterion, such
as vtkShoeMeshSubdivisionAlgorithm, will call it for you.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.211 vtkStreamingTessellator
1383
In any event, setting FieldSize to a non-zero value means you must pass field values to the AdaptivelySamplekFacet routines; For example,
vtkStreamingTessellator* t = vtkStreamingTessellator::New();
t->SetFieldSize( 1, 3 );
t->SetEmbeddingDimension( 1, 1 ); // not really required, this is the default
double p0[3+1+3] = { x0, y0, z0, r0, fx0, fy0, fz0 };
double p1[3+1+3] = { x1, y1, z1, r1, fx1, fy1, fz1 };
t->AdaptivelySample1Facet( p0, p1 );
This would adaptively sample an curve (1-facet) with geometry and a vector field at every output point on the
curve.
int = obj.GetFieldSize (int k) const - Get/Set the number of field value coordinates associated with each input and output point. The default is 0; no field values are interpolated. You may specify a
different size, s, for each type of k -facet to be processed. For example, SetFieldSize( 2, 3 ) would associate 3 field value coordinates with each input and output point of an AdaptivelySample2Facet call, but
does not say anything about input or output points of AdaptivelySample1Facet. Call SetFieldSize( -1, s ) to specify the same dimension for all possible k values. s may not exceed vtkStreamingTessellator::MaxFieldSize. This is a compile-time constant that defaults to 18, which is large enough for a
scalar, vector, tensor, normal, and texture coordinate to be included at each point.
Normally, you will not call SetFieldSize() directly; instead, subclasses of vtkEdgeSubdivisionCriterion, such
as vtkShoeMeshSubdivisionAlgorithm, will call it for you.
In any event, setting FieldSize to a non-zero value means you must pass field values to the AdaptivelySamplekFacet routines; For example,
vtkStreamingTessellator* t = vtkStreamingTessellator::New();
t->SetFieldSize( 1, 3 );
t->SetEmbeddingDimension( 1, 1 ); // not really required, this is the default
double p0[3+1+3] = { x0, y0, z0, r0, fx0, fy0, fz0 };
double p1[3+1+3] = { x1, y1, z1, r1, fx1, fy1, fz1 };
t->AdaptivelySample1Facet( p0, p1 );
This would adaptively sample an curve (1-facet) with geometry and a vector field at every output point on the
curve.
obj.SetMaximumNumberOfSubdivisions (int num_subdiv_in) - Get/Set the maximum
number of subdivisions that may occur.
int = obj.GetMaximumNumberOfSubdivisions () - Get/Set the maximum number of subdivisions that may occur.
obj.AdaptivelySample3Facet (double v1, double v2, double v3, double v4)
const - This will adaptively subdivide the tetrahedron (3-facet), triangle (2-facet), or edge (1-facet) until the
subdivision algorithm returns false for every edge or the maximum recursion depth is reached.
Use SetMaximumNumberOfSubdivisions to change the maximum recursion depth.
The AdaptivelySample0Facet method is provided as a convenience. Obviously, there is no way to adaptively
subdivide a vertex. Instead the input vertex is passed unchanged to the output via a call to the registered
VertexProcessorFunction callback.
.SECTION Warning This assumes that you have called SetSubdivisionAlgorithm(), SetEdgeCallback(), SetTriangleCallback(), and SetTetrahedronCallback() with valid values!
obj.AdaptivelySample2Facet (double v1, double v2, double v3) const - This
will adaptively subdivide the tetrahedron (3-facet), triangle (2-facet), or edge (1-facet) until the subdivision
algorithm returns false for every edge or the maximum recursion depth is reached.
Use SetMaximumNumberOfSubdivisions to change the maximum recursion depth.
The AdaptivelySample0Facet method is provided as a convenience. Obviously, there is no way to adaptively
subdivide a vertex. Instead the input vertex is passed unchanged to the output via a call to the registered
VertexProcessorFunction callback.
.SECTION Warning This assumes that you have called SetSubdivisionAlgorithm(), SetEdgeCallback(), SetTriangleCallback(), and SetTetrahedronCallback() with valid values!
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1384
obj.AdaptivelySample1Facet (double v1, double v2) const - This will adaptively subdivide the tetrahedron (3-facet), triangle (2-facet), or edge (1-facet) until the subdivision algorithm returns false
for every edge or the maximum recursion depth is reached.
Use SetMaximumNumberOfSubdivisions to change the maximum recursion depth.
The AdaptivelySample0Facet method is provided as a convenience. Obviously, there is no way to adaptively
subdivide a vertex. Instead the input vertex is passed unchanged to the output via a call to the registered
VertexProcessorFunction callback.
.SECTION Warning This assumes that you have called SetSubdivisionAlgorithm(), SetEdgeCallback(), SetTriangleCallback(), and SetTetrahedronCallback() with valid values!
obj.AdaptivelySample0Facet (double v1) const - This will adaptively subdivide the tetrahedron (3-facet), triangle (2-facet), or edge (1-facet) until the subdivision algorithm returns false for every
edge or the maximum recursion depth is reached.
Use SetMaximumNumberOfSubdivisions to change the maximum recursion depth.
The AdaptivelySample0Facet method is provided as a convenience. Obviously, there is no way to adaptively
subdivide a vertex. Instead the input vertex is passed unchanged to the output via a call to the registered
VertexProcessorFunction callback.
.SECTION Warning This assumes that you have called SetSubdivisionAlgorithm(), SetEdgeCallback(), SetTriangleCallback(), and SetTetrahedronCallback() with valid values!
obj.ResetCounts () - Reset/access the histogram of subdivision cases encountered. The histogram
may be used to examine coverage during testing as well as characterizing the tessellation algorithms performance. You should call ResetCounts() once, at the beginning of a stream of tetrahedra. It must be called
before AdaptivelySample3Facet() to prevent uninitialized memory reads.
These functions have no effect (and return 0) when PARAVIEW_DEBUG_TESSELLATOR has not been
defined. By default, PARAVIEW_DEBUG_TESSELLATOR is not defined, and your code will be fast and
efficient. Really!
vtkIdType = obj.GetCaseCount (int c) - Reset/access the histogram of subdivision cases encountered. The histogram may be used to examine coverage during testing as well as characterizing the
tessellation algorithms performance. You should call ResetCounts() once, at the beginning of a stream of
tetrahedra. It must be called before AdaptivelySample3Facet() to prevent uninitialized memory reads.
These functions have no effect (and return 0) when PARAVIEW_DEBUG_TESSELLATOR has not been
defined. By default, PARAVIEW_DEBUG_TESSELLATOR is not defined, and your code will be fast and
efficient. Really!
vtkIdType = obj.GetSubcaseCount (int casenum, int sub)
34.212
vtkStreamLine
34.212.1
Usage
vtkStreamLine is a filter that generates a streamline for an arbitrary dataset. A streamline is a line that is everywhere
tangent to the vector field. Scalar values also are calculated along the streamline and can be used to color the line.
Streamlines are calculated by integrating from a starting point through the vector field. Integration can be performed
forward in time (see where the line goes), backward in time (see where the line came from), or in both directions.
It also is possible to compute vorticity along the streamline. Vorticity is the projection (i.e., dot product) of the flow
rotation on the velocity vector, i.e., the rotation of flow around the streamline.
vtkStreamLine defines the instance variable StepLength. This parameter controls the time increment used to generate individual points along the streamline(s). Smaller values result in more line primitives but smoother streamlines.
The StepLength instance variable is defined in terms of time (i.e., the distance that the particle travels in the specified
time period). Thus, the line segments will be smaller in areas of low velocity and larger in regions of high velocity.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.213 vtkStreamPoints
1385
(NOTE: This is different than the IntegrationStepLength defined by the superclass vtkStreamer. IntegrationStepLength is used to control integration step size and is expressed as a fraction of the cell length.) The StepLength
instance variable is important because subclasses of vtkStreamLine (e.g., vtkDashedStreamLine) depend on this
value to build their representation.
To create an instance of class vtkStreamLine, simply invoke its constructor as follows
obj = vtkStreamLine
34.212.2
Methods
The class vtkStreamLine has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkStreamLine class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStreamLine = obj.NewInstance ()
vtkStreamLine = obj.SafeDownCast (vtkObject o)
obj.SetStepLength (double ) - Specify the length of a line segment. The length is expressed in
terms of elapsed time. Smaller values result in smoother appearing streamlines, but greater numbers of line
primitives.
double = obj.GetStepLengthMinValue () - Specify the length of a line segment. The length
is expressed in terms of elapsed time. Smaller values result in smoother appearing streamlines, but greater
numbers of line primitives.
double = obj.GetStepLengthMaxValue () - Specify the length of a line segment. The length
is expressed in terms of elapsed time. Smaller values result in smoother appearing streamlines, but greater
numbers of line primitives.
double = obj.GetStepLength () - Specify the length of a line segment. The length is expressed
in terms of elapsed time. Smaller values result in smoother appearing streamlines, but greater numbers of
line primitives.
34.213
vtkStreamPoints
34.213.1
Usage
vtkStreamPoints is a filter that generates points along a streamer. The points are separated by a constant time
increment. The resulting visual effect (especially when coupled with vtkGlyph3D) is an indication of particle speed.
To create an instance of class vtkStreamPoints, simply invoke its constructor as follows
obj = vtkStreamPoints
34.213.2
Methods
The class vtkStreamPoints has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkStreamPoints class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1386
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStreamPoints = obj.NewInstance ()
vtkStreamPoints = obj.SafeDownCast (vtkObject o)
obj.SetTimeIncrement (double ) - Specify the separation of points in terms of absolute time.
double = obj.GetTimeIncrementMinValue () - Specify the separation of points in terms of
absolute time.
double = obj.GetTimeIncrementMaxValue () - Specify the separation of points in terms of
absolute time.
double = obj.GetTimeIncrement () - Specify the separation of points in terms of absolute time.
34.214
vtkStreamTracer
34.214.1
Usage
vtkStreamTracer is a filter that integrates a vector field to generate streamlines. The integration is performed using
a specified integrator, by default Runge-Kutta2.
vtkStreamTracer produces polylines as the output, with each cell (i.e., polyline) representing a streamline. The attribute values associated with each streamline are stored in the cell data, whereas those associated with streamlinepoints are stored in the point data.
vtkStreamTracer supports forward (the default), backward, and combined (i.e., BOTH) integration. The length of
a streamline is governed by specifying a maximum value either in physical arc length or in (local) cell length.
Otherwise, the integration terminates upon exiting the flow field domain, or if the particle speed is reduced to a
value less than a specified terminal speed, or when a maximum number of steps is completed. The specific reason
for the termination is stored in a cell array named ReasonForTermination.
Note that normalized vectors are adopted in streamline integration, which achieves high numerical accuracy/smoothness of flow lines that is particularly guranteed for Runge-Kutta45 with adaptive step size and error control).
In support of this feature, the underlying step size is ALWAYS in arc length unit (LENGTH_UNIT) while the real
time interval (virtual for steady flows) that a particle actually takes to trave in a single step is obtained by dividing
the arc length by the LOCAL speed. The overall elapsed time (i.e., the life span) of the particle is the sum of those
individual step-wise time intervals.
The quality of streamline integration can be controlled by setting the initial integration step (InitialIntegrationStep),
particularly for Runge-Kutta2 and Runge-Kutta4 (with a fixed step size), and in the case of Runge-Kutta45 (with an
adaptive step size and error control) the minimum integration step, the maximum integration step, and the maximum
error. These steps are in either LENGTH_UNIT or CELL_LENGTH_UNIT while the error is in physical arc length.
For the former two integrators, there is a trade-off between integration speed and streamline quality.
The integration time, vorticity, rotation and angular velocity are stored in point data arrays named "IntegrationTime",
"Vorticity", "Rotation" and "AngularVelocity", respectively (vorticity, rotation and angular velocity are computed only
when ComputeVorticity is on). All point data attributes in the source dataset are interpolated on the new streamline
points.
vtkStreamTracer supports integration through any type of dataset. Thus if the dataset contains 2D cells like polygons
or triangles, the integration is constrained to lie on the surface defined by 2D cells.
The starting point, or the so-called seed, of a streamline may be set in two different ways. Starting from global x-y-z
"position" allows you to start a single trace at a specified x-y-z coordinate. If you specify a source object, traces will
be generated from each point in the source that is inside the dataset.
To create an instance of class vtkStreamTracer, simply invoke its constructor as follows
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.214 vtkStreamTracer
1387
obj = vtkStreamTracer
34.214.2
Methods
The class vtkStreamTracer has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkStreamTracer class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStreamTracer = obj.NewInstance ()
vtkStreamTracer = obj.SafeDownCast (vtkObject o)
obj.SetStartPosition (double , double , double ) - Specify the starting point (seed) of
a streamline in the global coordinate system. Search must be performed to find the initial cell from which to
start integration.
obj.SetStartPosition (double a[3]) - Specify the starting point (seed) of a streamline in the
global coordinate system. Search must be performed to find the initial cell from which to start integration.
double = obj. GetStartPosition () - Specify the starting point (seed) of a streamline in the
global coordinate system. Search must be performed to find the initial cell from which to start integration.
obj.SetSource (vtkDataSet source) - Specify the source object used to generate starting points
(seeds). Old style. Do not use.
vtkDataSet = obj.GetSource () - Specify the source object used to generate starting points
(seeds). Old style. Do not use.
obj.SetSourceConnection (vtkAlgorithmOutput algOutput) - Specify the source object
used to generate starting points (seeds). New style.
obj.SetIntegrator (vtkInitialValueProblemSolver ) - Set/get the integrator type to be
used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the
process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed
using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2
vtkInitialValueProblemSolver = obj.GetIntegrator () - Set/get the integrator type to
be used for streamline generation. The object passed is not actually used but is cloned with NewInstance
in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be
changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1
RUNGE_KUTTA45 = 2
obj.SetIntegratorType (int type) - Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration
(prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2
int = obj.GetIntegratorType () - Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration
(prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2
obj.SetIntegratorTypeToRungeKutta2 () - Set/get the integrator type to be used for streamline
generation. The object passed is not actually used but is cloned with NewInstance in the process of integration
(prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1388
34.215 vtkStripper
1389
obj.SetIntegrationDirection (int ) - Specify whether the streamline is integrated in the upstream or downstream direction.
int = obj.GetIntegrationDirectionMinValue () - Specify whether the streamline is integrated in the upstream or downstream direction.
int = obj.GetIntegrationDirectionMaxValue () - Specify whether the streamline is integrated in the upstream or downstream direction.
int = obj.GetIntegrationDirection () - Specify whether the streamline is integrated in the
upstream or downstream direction.
obj.SetIntegrationDirectionToForward () - Specify whether the streamline is integrated in
the upstream or downstream direction.
obj.SetIntegrationDirectionToBackward () - Specify whether the streamline is integrated in
the upstream or downstream direction.
obj.SetIntegrationDirectionToBoth () - Specify whether the streamline is integrated in the
upstream or downstream direction.
obj.SetComputeVorticity (bool )
bool = obj.GetComputeVorticity ()
obj.SetRotationScale (double )
double = obj.GetRotationScale ()
obj.SetInterpolatorPrototype (vtkAbstractInterpolatedVelocityField ivf)
- The object used to interpolate the velocity field during integration is of the same class as this prototype.
obj.SetInterpolatorType (int interpType) - Set the type of the velocity field interpolator
to determine whether vtkInterpolatedVelocityField (INTERPOLATOR_WITH_DATASET_POINT_LOCATOR) or vtkCellLocatorInterpolatedVelocityField (INTERPOLATOR_WITH_CELL_LOCATOR) is employed for
locating cells during streamline integration. The latter (adopting vtkAbstractCellLocator sub-classes such as
vtkCellLocator and vtkModifiedBSPTree) is more robust then the former (through vtkDataSet / vtkPointSet::FindCell() coupled with vtkPointLocator).
34.215
vtkStripper
34.215.1
Usage
34.215.2
Methods
The class vtkStripper has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkStripper class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStripper = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1390
34.216
vtkStructuredGridClip
34.217 vtkStructuredGridGeometryFilter
34.216.1
1391
Usage
vtkStructuredGridClip will make an image smaller. The output must have an image extent which is the subset of the
input. The filter has two modes of operation: 1: By default, the data is not copied in this filter. Only the whole extent
is modified. 2: If ClipDataOn is set, then you will get no more that the clipped extent.
To create an instance of class vtkStructuredGridClip, simply invoke its constructor as follows
obj = vtkStructuredGridClip
34.216.2
Methods
The class vtkStructuredGridClip has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredGridClip class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredGridClip = obj.NewInstance ()
vtkStructuredGridClip = obj.SafeDownCast (vtkObject o)
obj.SetOutputWholeExtent (int extent[6], vtkInformation outInfo)
whole extent of the output has to be set explicitly.
The
obj.SetOutputWholeExtent (int minX, int maxX, int minY, int maxY, int
minZ, int maxZ) - The whole extent of the output has to be set explicitly.
obj.GetOutputWholeExtent (int extent[6]) - The whole extent of the output has to be set
explicitly.
obj.ResetOutputWholeExtent ()
obj.SetClipData (int ) - By default, ClipData is off, and only the WholeExtent is modified. the
datas extent may actually be larger. When this flag is on, the data extent will be no more than the OutputWholeExtent.
int = obj.GetClipData () - By default, ClipData is off, and only the WholeExtent is modified. the
datas extent may actually be larger. When this flag is on, the data extent will be no more than the OutputWholeExtent.
obj.ClipDataOn () - By default, ClipData is off, and only the WholeExtent is modified. the datas extent
may actually be larger. When this flag is on, the data extent will be no more than the OutputWholeExtent.
obj.ClipDataOff () - By default, ClipData is off, and only the WholeExtent is modified. the datas
extent may actually be larger. When this flag is on, the data extent will be no more than the OutputWholeExtent.
obj.SetOutputWholeExtent (int piece, int numPieces) - Hack set output by piece
34.217
vtkStructuredGridGeometryFilter
1392
34.217.1
Usage
vtkStructuredGridGeometryFilter is a filter that extracts geometry from a structured grid. By specifying appropriate
i-j-k indices, it is possible to extract a point, a curve, a surface, or a "volume". Depending upon the type of data, the
curve and surface may be curved or planar. (The volume is actually a (n x m x o) region of points.)
The extent specification is zero-offset. That is, the first k-plane in a 50x50x50 structured grid is given by (0,49, 0,49,
0,0).
The output of this filter is affected by the structured grid blanking. If blanking is on, and a blanking array defined,
then those cells attached to blanked points are not output. (Blanking is a property of the input vtkStructuredGrid.)
To create an instance of class vtkStructuredGridGeometryFilter, simply invoke its constructor as follows
obj = vtkStructuredGridGeometryFilter
34.217.2
Methods
The class vtkStructuredGridGeometryFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredGridGeometryFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredGridGeometryFilter = obj.NewInstance ()
vtkStructuredGridGeometryFilter = obj.SafeDownCast (vtkObject o)
int = obj.
kmin,kmax).
obj.SetExtent (int iMin, int iMax, int jMin, int jMax, int kMin, int kMax) - Specify (imin,imax, jmin,jmax, kmin,kmax) indices.
obj.SetExtent (int extent[6]) - Specify (imin,imax, jmin,jmax, kmin,kmax) indices in array form.
34.218
vtkStructuredGridOutlineFilter
34.218.1
Usage
34.218.2
Methods
The class vtkStructuredGridOutlineFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredGridOutlineFilter class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.219 vtkStructuredPointsGeometryFilter
1393
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredGridOutlineFilter = obj.NewInstance ()
vtkStructuredGridOutlineFilter = obj.SafeDownCast (vtkObject o)
34.219
vtkStructuredPointsGeometryFilter
34.219.1
Usage
34.219.2
Methods
The class vtkStructuredPointsGeometryFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredPointsGeometryFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredPointsGeometryFilter = obj.NewInstance ()
vtkStructuredPointsGeometryFilter = obj.SafeDownCast (vtkObject o)
34.220
vtkSubdivideTetra
34.220.1
Usage
34.220.2
Methods
The class vtkSubdivideTetra has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkSubdivideTetra class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1394
34.221
vtkSubPixelPositionEdgels
34.221.1
Usage
vtkSubPixelPositionEdgels is a filter that takes a series of linked edgels (digital curves) and gradient maps as input.
It then adjusts the edgel locations based on the gradient data. Specifically, the algorithm first determines the
neighboring gradient magnitudes of an edgel using simple interpolation of its neighbors. It then fits the following
three data points: negative gradient direction gradient magnitude, edgel gradient magnitude and positive gradient
direction gradient magnitude to a quadratic function. It then solves this quadratic to find the maximum gradient
location along the gradient orientation. It then modifies the edgels location along the gradient orientation to the
calculated maximum location. This algorithm does not adjust an edgel in the direction orthogonal to its gradient
vector.
To create an instance of class vtkSubPixelPositionEdgels, simply invoke its constructor as follows
obj = vtkSubPixelPositionEdgels
34.221.2
Methods
The class vtkSubPixelPositionEdgels has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSubPixelPositionEdgels
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSubPixelPositionEdgels = obj.NewInstance ()
vtkSubPixelPositionEdgels = obj.SafeDownCast (vtkObject o)
obj.SetGradMaps (vtkStructuredPoints gm) - Set/Get the gradient data for doing the position
adjustments.
vtkStructuredPoints = obj.GetGradMaps () - Set/Get the gradient data for doing the position
adjustments.
obj.SetTargetFlag (int ) - These methods can make the positioning look for a target scalar value
instead of looking for a maximum.
int = obj.GetTargetFlag () - These methods can make the positioning look for a target scalar
value instead of looking for a maximum.
obj.TargetFlagOn () - These methods can make the positioning look for a target scalar value instead
of looking for a maximum.
obj.TargetFlagOff () - These methods can make the positioning look for a target scalar value instead
of looking for a maximum.
obj.SetTargetValue (double ) - These methods can make the positioning look for a target scalar
value instead of looking for a maximum.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.222 vtkSuperquadricSource
1395
double = obj.GetTargetValue () - These methods can make the positioning look for a target
scalar value instead of looking for a maximum.
34.222
vtkSuperquadricSource
34.222.1
Usage
vtkSuperquadricSource creates a superquadric (represented by polygons) of specified size centered at the origin.
The resolution (polygonal discretization) in both the latitude (phi) and longitude (theta) directions can be specified.
Roundness parameters (PhiRoundness and ThetaRoundness) control the shape of the superquadric. The Toroidal
boolean controls whether a toroidal superquadric is produced. If so, the Thickness parameter controls the thickness
of the toroid: 0 is the thinnest allowable toroid, and 1 has a minimum sized hole. The Scale parameters allow the
superquadric to be scaled in x, y, and z (normal vectors are correctly generated in any case). The Size parameter
controls size of the superquadric.
This code is based on "Rigid physically based superquadrics", A. H. Barr, in "Graphics Gems III", David Kirk, ed.,
Academic Press, 1992.
To create an instance of class vtkSuperquadricSource, simply invoke its constructor as follows
obj = vtkSuperquadricSource
34.222.2
Methods
The class vtkSuperquadricSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSuperquadricSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSuperquadricSource = obj.NewInstance ()
vtkSuperquadricSource = obj.SafeDownCast (vtkObject o)
obj.SetCenter (double , double , double ) - Set the center of the superquadric. Default
is 0,0,0.
obj.SetCenter (double a[3]) - Set the center of the superquadric. Default is 0,0,0.
double = obj.
obj.SetScale (double , double , double ) - Set the scale factors of the superquadric. Default is 1,1,1.
obj.SetScale (double a[3]) - Set the scale factors of the superquadric. Default is 1,1,1.
double = obj.
int = obj.GetThetaResolution () - Set the number of points in the longitude direction. Initial
value is 16.
obj.SetThetaResolution (int i) - Set the number of points in the longitude direction. Initial
value is 16.
int = obj.GetPhiResolution () - Set the number of points in the latitude direction. Initial value is
16.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1396
obj.SetPhiResolution (int i) - Set the number of points in the latitude direction. Initial value is
16.
double = obj.GetThickness () - Set/Get Superquadric ring thickness (toroids only). Changing
thickness maintains the outside diameter of the toroid. Initial value is 0.3333.
obj.SetThickness (double ) - Set/Get Superquadric ring thickness (toroids only). Changing thickness maintains the outside diameter of the toroid. Initial value is 0.3333.
double = obj.GetThicknessMinValue () - Set/Get Superquadric ring thickness (toroids only).
Changing thickness maintains the outside diameter of the toroid. Initial value is 0.3333.
double = obj.GetThicknessMaxValue () - Set/Get Superquadric ring thickness (toroids only).
Changing thickness maintains the outside diameter of the toroid. Initial value is 0.3333.
double = obj.GetPhiRoundness () - Set/Get Superquadric north/south roundness. Values range
from 0 (rectangular) to 1 (circular) to higher orders. Initial value is 1.0.
obj.SetPhiRoundness (double e) - Set/Get Superquadric north/south roundness. Values range
from 0 (rectangular) to 1 (circular) to higher orders. Initial value is 1.0.
double = obj.GetThetaRoundness () - Set/Get Superquadric east/west roundness.
range from 0 (rectangular) to 1 (circular) to higher orders. Initial value is 1.0.
Values
34.223
vtkSynchronizedTemplates2D
34.223.1
Usage
vtkSynchronizedTemplates2D is a 2D implementation of the synchronized template algorithm. Note that vtkContourFilter will automatically use this class when appropriate.
To create an instance of class vtkSynchronizedTemplates2D, simply invoke its constructor as follows
obj = vtkSynchronizedTemplates2D
34.224 vtkSynchronizedTemplates3D
34.223.2
1397
Methods
The class vtkSynchronizedTemplates2D has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSynchronizedTemplates2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSynchronizedTemplates2D = obj.NewInstance ()
vtkSynchronizedTemplates2D = obj.SafeDownCast (vtkObject o)
long = obj.GetMTime () - Because we delegate to vtkContourValues
obj.SetValue (int i, double value) - Get the ith contour value.
double = obj.GetValue (int i) - Get a pointer to an array of contour values. There will be GetNumberOfContours() values in the list.
obj.GetValues (double contourValues) - Set the number of contours to place into the list. You
only really need to use this method to reduce list size. The method SetValue() will automatically increase list
size as needed.
obj.SetNumberOfContours (int number) - Get the number of contours in the list of contour
values.
int = obj.GetNumberOfContours () - Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.
obj.GenerateValues (int numContours, double range[2]) - Generate numContours
equally spaced contour values between specified range. Contour values will include min/max range values.
obj.GenerateValues (int numContours, double rangeStart, double rangeEnd) - Option to set the point scalars of the output. The scalars will be the iso value of course. By
default this flag is on.
obj.SetComputeScalars (int ) - Option to set the point scalars of the output. The scalars will be
the iso value of course. By default this flag is on.
int = obj.GetComputeScalars () - Option to set the point scalars of the output. The scalars will
be the iso value of course. By default this flag is on.
obj.ComputeScalarsOn () - Option to set the point scalars of the output. The scalars will be the iso
value of course. By default this flag is on.
obj.ComputeScalarsOff () - Option to set the point scalars of the output. The scalars will be the iso
value of course. By default this flag is on.
obj.SetArrayComponent (int ) - Set/get which component of the scalar array to contour on; defaults to 0.
int = obj.GetArrayComponent () - Set/get which component of the scalar array to contour on;
defaults to 0.
34.224
vtkSynchronizedTemplates3D
1398
34.224.1
Usage
vtkSynchronizedTemplates3D is a 3D implementation of the synchronized template algorithm. Note that vtkContourFilter will automatically use this class when appropriate.
To create an instance of class vtkSynchronizedTemplates3D, simply invoke its constructor as follows
obj = vtkSynchronizedTemplates3D
34.224.2
Methods
The class vtkSynchronizedTemplates3D has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSynchronizedTemplates3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSynchronizedTemplates3D = obj.NewInstance ()
vtkSynchronizedTemplates3D = obj.SafeDownCast (vtkObject o)
long = obj.GetMTime () - Because we delegate to vtkContourValues
obj.SetComputeNormals (int ) - Set/Get the computation of normals. Normal computation is fairly
expensive in both time and storage. If the output data will be processed by filters that modify topology or
geometry, it may be wise to turn Normals and Gradients off.
int = obj.GetComputeNormals () - Set/Get the computation of normals. Normal computation is
fairly expensive in both time and storage. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeNormalsOn () - Set/Get the computation of normals. Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or geometry,
it may be wise to turn Normals and Gradients off.
obj.ComputeNormalsOff () - Set/Get the computation of normals. Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or
geometry, it may be wise to turn Normals and Gradients off.
obj.SetComputeGradients (int ) - Set/Get the computation of gradients. Gradient computation
is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be
calculated, but will not be stored in the output dataset. If the output data will be processed by filters that
modify topology or geometry, it may be wise to turn Normals and Gradients off.
int = obj.GetComputeGradients () - Set/Get the computation of gradients. Gradient computation is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to
be calculated, but will not be stored in the output dataset. If the output data will be processed by filters that
modify topology or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeGradientsOn () - Set/Get the computation of gradients. Gradient computation is fairly
expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated,
but will not be stored in the output dataset. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.ComputeGradientsOff () - Set/Get the computation of gradients. Gradient computation is fairly
expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated,
but will not be stored in the output dataset. If the output data will be processed by filters that modify topology
or geometry, it may be wise to turn Normals and Gradients off.
obj.SetComputeScalars (int ) - Set/Get the computation of scalars.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.225 vtkSynchronizedTemplatesCutter3D
1399
34.225
vtkSynchronizedTemplatesCutter3D
34.225.1
Usage
vtkSynchronizedTemplatesCutter3D is an implementation of the synchronized template algorithm. Note that vtkCutFilter will automatically use this class when appropriate.
To create an instance of class vtkSynchronizedTemplatesCutter3D, simply invoke its constructor as follows
obj = vtkSynchronizedTemplatesCutter3D
1400
34.225.2
Methods
The class vtkSynchronizedTemplatesCutter3D has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSynchronizedTemplatesCutter3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSynchronizedTemplatesCutter3D = obj.NewInstance ()
vtkSynchronizedTemplatesCutter3D = obj.SafeDownCast (vtkObject o)
obj.ThreadedExecute (vtkImageData data, vtkInformation outInfo, int exExt, int ) - Needed by templated functions.
obj.SetCutFunction (vtkImplicitFunction )
vtkImplicitFunction = obj.GetCutFunction ()
34.226
vtkTableBasedClipDataSet
34.226.1
Usage
vtkTableBasedClipDataSet is a filter that clips any type of dataset using either any subclass of vtkImplicitFunction
or an input scalar point data array. Clipping means that it actually "cuts" through the cells of the dataset, returning
everything outside the specified implicit function (or greater than the scalar value) including "pieces" of a cell (Note
to compare this with vtkExtractGeometry, which pulls out entire, uncut cells). The output of this filter is a vtkUnstructuredGrid data.
To use this filter, you need to decide whether an implicit function or an input scalar point data array is used for
clipping. For the former case, 1) define an implicit function 2) provide it to this filter via SetClipFunction() If a
clipping function is not specified, or GenerateClipScalars is off( the default), the input scalar point data array is then
employed for clipping.
You can also specify a scalar (iso-)value, which is used to decide what is inside and outside the implicit function.
You can also reverse the sense of what inside/outside is by setting IVAR InsideOut. The clipping algorithm proceeds
by computing an implicit function value or using the input scalar point data value for each point in the dataset. This
is compared against the scalar (iso-)value to determine the inside/outside status.
Although this filter sometimes (but rarely) may resort to the sibling class vtkClipDataSet for handling some special
grids (such as cylinders or cones with capping faces in the form of a vtkPolyData), it itself is able to deal with most
grids. It is worth mentioning that vtkTableBasedClipDataSet is capable of addressing the artifacts that may occur
with vtkClipDataSet due to the possibly inconsistent triagulation modes between neighboring cells. In addition, the
former is much faster than the latter. Furthermore, the former produces less cells (with ratio usually being 56)
than by the latter in the output. In other words, this filter retains the original cells (i.e., without triangulation / tetrahedralization) wherever possible. All these advantages are gained by adopting the unique clipping and triangulation
tables proposed by VisIt.
To create an instance of class vtkTableBasedClipDataSet, simply invoke its constructor as follows
obj = vtkTableBasedClipDataSet
34.226 vtkTableBasedClipDataSet
34.226.2
1401
Methods
The class vtkTableBasedClipDataSet has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTableBasedClipDataSet
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTableBasedClipDataSet = obj.NewInstance ()
vtkTableBasedClipDataSet = obj.SafeDownCast (vtkObject o)
long = obj.GetMTime () - Get the MTime for which the point locator and clip function are consdiered.
obj.SetInsideOut (int ) - Set/Get the InsideOut flag. With this flag off, a vertex is considered
inside (the implicit function or the isosurface) if the (function or scalar) value is greater than IVAR Value. With
this flag on, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar)
value is less than or equal to IVAR Value. This flag is off by default.
int = obj.GetInsideOut () - Set/Get the InsideOut flag. With this flag off, a vertex is considered
inside (the implicit function or the isosurface) if the (function or scalar) value is greater than IVAR Value. With
this flag on, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar)
value is less than or equal to IVAR Value. This flag is off by default.
obj.InsideOutOn () - Set/Get the InsideOut flag. With this flag off, a vertex is considered inside (the
implicit function or the isosurface) if the (function or scalar) value is greater than IVAR Value. With this flag
on, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar) value is less
than or equal to IVAR Value. This flag is off by default.
obj.InsideOutOff () - Set/Get the InsideOut flag. With this flag off, a vertex is considered inside (the
implicit function or the isosurface) if the (function or scalar) value is greater than IVAR Value. With this flag
on, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar) value is less
than or equal to IVAR Value. This flag is off by default.
obj.SetValue (double ) - Set/Get the clipping value of the implicit function (if an implicit function is
applied) or scalar data array (if a scalar data array is used), with 0.0 as the default value. This value is ignored
if flag UseValueAsOffset is true AND a clip function is defined.
double = obj.GetValue () - Set/Get the clipping value of the implicit function (if an implicit function
is applied) or scalar data array (if a scalar data array is used), with 0.0 as the default value. This value is
ignored if flag UseValueAsOffset is true AND a clip function is defined.
obj.SetUseValueAsOffset (bool ) - Set/Get flag UseValueAsOffset, with true as the default
value. With this flag on, IVAR Value is used as an offset parameter to the implicit function. Value is used only
when clipping using a scalar array.
bool = obj.GetUseValueAsOffset () - Set/Get flag UseValueAsOffset, with true as the default
value. With this flag on, IVAR Value is used as an offset parameter to the implicit function. Value is used only
when clipping using a scalar array.
obj.UseValueAsOffsetOn () - Set/Get flag UseValueAsOffset, with true as the default value. With
this flag on, IVAR Value is used as an offset parameter to the implicit function. Value is used only when
clipping using a scalar array.
obj.UseValueAsOffsetOff () - Set/Get flag UseValueAsOffset, with true as the default value. With
this flag on, IVAR Value is used as an offset parameter to the implicit function. Value is used only when
clipping using a scalar array.
obj.SetClipFunction (vtkImplicitFunction )
vtkImplicitFunction = obj.GetClipFunction ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1402
34.227 vtkTableToPolyData
34.227
1403
vtkTableToPolyData
34.227.1
Usage
34.227.2
Methods
The class vtkTableToPolyData has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTableToPolyData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTableToPolyData = obj.NewInstance ()
vtkTableToPolyData = obj.SafeDownCast (vtkObject o)
obj.SetXColumn (string ) - Set the name of the column to use as the X coordinate for the points.
string = obj.GetXColumn () - Set the name of the column to use as the X coordinate for the points.
obj.SetXColumnIndex (int ) - Set the index of the column to use as the X coordinate for the points.
int = obj.GetXColumnIndexMinValue () - Set the index of the column to use as the X coordinate for the points.
int = obj.GetXColumnIndexMaxValue () - Set the index of the column to use as the X coordinate for the points.
int = obj.GetXColumnIndex () - Set the index of the column to use as the X coordinate for the
points.
obj.SetXComponent (int ) - Specify the component for the column specified using SetXColumn()
to use as the xcoordinate in case the column is a multi-component array. Default is 0.
int = obj.GetXComponentMinValue () - Specify the component for the column specified using
SetXColumn() to use as the xcoordinate in case the column is a multi-component array. Default is 0.
int = obj.GetXComponentMaxValue () - Specify the component for the column specified using
SetXColumn() to use as the xcoordinate in case the column is a multi-component array. Default is 0.
int = obj.GetXComponent () - Specify the component for the column specified using SetXColumn()
to use as the xcoordinate in case the column is a multi-component array. Default is 0.
obj.SetYColumn (string ) - Set the name of the column to use as the Y coordinate for the points.
Default is 0.
string = obj.GetYColumn () - Set the name of the column to use as the Y coordinate for the points.
Default is 0.
obj.SetYColumnIndex (int ) - Set the index of the column to use as the Y coordinate for the points.
int = obj.GetYColumnIndexMinValue () - Set the index of the column to use as the Y coordinate for the points.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1404
int = obj.GetYColumnIndexMaxValue () - Set the index of the column to use as the Y coordinate for the points.
int = obj.GetYColumnIndex () - Set the index of the column to use as the Y coordinate for the
points.
obj.SetYComponent (int ) - Specify the component for the column specified using SetYColumn()
to use as the Ycoordinate in case the column is a multi-component array.
int = obj.GetYComponentMinValue () - Specify the component for the column specified using
SetYColumn() to use as the Ycoordinate in case the column is a multi-component array.
int = obj.GetYComponentMaxValue () - Specify the component for the column specified using
SetYColumn() to use as the Ycoordinate in case the column is a multi-component array.
int = obj.GetYComponent () - Specify the component for the column specified using SetYColumn()
to use as the Ycoordinate in case the column is a multi-component array.
obj.SetZColumn (string ) - Set the name of the column to use as the Z coordinate for the points.
Default is 0.
string = obj.GetZColumn () - Set the name of the column to use as the Z coordinate for the points.
Default is 0.
obj.SetZColumnIndex (int ) - Set the index of the column to use as the Z coordinate for the points.
int = obj.GetZColumnIndexMinValue () - Set the index of the column to use as the Z coordinate for the points.
int = obj.GetZColumnIndexMaxValue () - Set the index of the column to use as the Z coordinate for the points.
int = obj.GetZColumnIndex () - Set the index of the column to use as the Z coordinate for the
points.
obj.SetZComponent (int ) - Specify the component for the column specified using SetZColumn() to
use as the Zcoordinate in case the column is a multi-component array.
int = obj.GetZComponentMinValue () - Specify the component for the column specified using
SetZColumn() to use as the Zcoordinate in case the column is a multi-component array.
int = obj.GetZComponentMaxValue () - Specify the component for the column specified using
SetZColumn() to use as the Zcoordinate in case the column is a multi-component array.
int = obj.GetZComponent () - Specify the component for the column specified using SetZColumn()
to use as the Zcoordinate in case the column is a multi-component array.
obj.SetCreate2DPoints (bool ) - Specify whether the points of the polydata are 3D or 2D. If this
is set to true then the Z Column will be ignored and the z value of each point on the polydata will be set to 0.
By default this will be off.
bool = obj.GetCreate2DPoints () - Specify whether the points of the polydata are 3D or 2D. If
this is set to true then the Z Column will be ignored and the z value of each point on the polydata will be set
to 0. By default this will be off.
obj.Create2DPointsOn () - Specify whether the points of the polydata are 3D or 2D. If this is set to
true then the Z Column will be ignored and the z value of each point on the polydata will be set to 0. By
default this will be off.
obj.Create2DPointsOff () - Specify whether the points of the polydata are 3D or 2D. If this is set
to true then the Z Column will be ignored and the z value of each point on the polydata will be set to 0. By
default this will be off.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.228 vtkTableToStructuredGrid
34.228
1405
vtkTableToStructuredGrid
34.228.1
Usage
vtkTableToStructuredGrid is a filter that converts an input vtkTable to a vtkStructuredGrid. It provides API to select
columns to use as points in the output structured grid. The specified dimensions of the output (specified using
SetWholeExtent()) must match the number of rows in the input table.
To create an instance of class vtkTableToStructuredGrid, simply invoke its constructor as follows
obj = vtkTableToStructuredGrid
34.228.2
Methods
The class vtkTableToStructuredGrid has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTableToStructuredGrid
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTableToStructuredGrid = obj.NewInstance ()
vtkTableToStructuredGrid = obj.SafeDownCast (vtkObject o)
obj.SetWholeExtent (int , int , int , int , int , int ) - Get/Set the whole extents for the image to produce. The size of the image must match the number of rows in the input table.
obj.SetWholeExtent (int a[6]) - Get/Set the whole extents for the image to produce. The size
of the image must match the number of rows in the input table.
int = obj. GetWholeExtent () - Get/Set the whole extents for the image to produce. The size
of the image must match the number of rows in the input table.
obj.SetXColumn (string ) - Set the name of the column to use as the X coordinate for the points.
string = obj.GetXColumn () - Set the name of the column to use as the X coordinate for the points.
obj.SetXComponent (int ) - Specify the component for the column specified using SetXColumn()
to use as the xcoordinate in case the column is a multi-component array. Default is 0.
int = obj.GetXComponentMinValue () - Specify the component for the column specified using
SetXColumn() to use as the xcoordinate in case the column is a multi-component array. Default is 0.
int = obj.GetXComponentMaxValue () - Specify the component for the column specified using
SetXColumn() to use as the xcoordinate in case the column is a multi-component array. Default is 0.
int = obj.GetXComponent () - Specify the component for the column specified using SetXColumn()
to use as the xcoordinate in case the column is a multi-component array. Default is 0.
obj.SetYColumn (string ) - Set the name of the column to use as the Y coordinate for the points.
Default is 0.
string = obj.GetYColumn () - Set the name of the column to use as the Y coordinate for the points.
Default is 0.
obj.SetYComponent (int ) - Specify the component for the column specified using SetYColumn()
to use as the Ycoordinate in case the column is a multi-component array.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1406
int = obj.GetYComponentMinValue () - Specify the component for the column specified using
SetYColumn() to use as the Ycoordinate in case the column is a multi-component array.
int = obj.GetYComponentMaxValue () - Specify the component for the column specified using
SetYColumn() to use as the Ycoordinate in case the column is a multi-component array.
int = obj.GetYComponent () - Specify the component for the column specified using SetYColumn()
to use as the Ycoordinate in case the column is a multi-component array.
obj.SetZColumn (string ) - Set the name of the column to use as the Z coordinate for the points.
Default is 0.
string = obj.GetZColumn () - Set the name of the column to use as the Z coordinate for the points.
Default is 0.
obj.SetZComponent (int ) - Specify the component for the column specified using SetZColumn() to
use as the Zcoordinate in case the column is a multi-component array.
int = obj.GetZComponentMinValue () - Specify the component for the column specified using
SetZColumn() to use as the Zcoordinate in case the column is a multi-component array.
int = obj.GetZComponentMaxValue () - Specify the component for the column specified using
SetZColumn() to use as the Zcoordinate in case the column is a multi-component array.
int = obj.GetZComponent () - Specify the component for the column specified using SetZColumn()
to use as the Zcoordinate in case the column is a multi-component array.
34.229
vtkTemporalPathLineFilter
34.229.1
Usage
vtkTemporalPathLineFilter takes any dataset as input, it extracts the point locations of all cells over time to build up
a polyline trail. The point number (index) is used as the key if the points are randomly changing their respective
order in the points list, then you should specify a scalar that represents the unique ID. This is intended to handle the
output of a filter such as the TemporalStreamTracer.
To create an instance of class vtkTemporalPathLineFilter, simply invoke its constructor as follows
obj = vtkTemporalPathLineFilter
34.229.2
Methods
The class vtkTemporalPathLineFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTemporalPathLineFilter
class.
string = obj.GetClassName () - Standard Type-Macro
int = obj.IsA (string name) - Standard Type-Macro
vtkTemporalPathLineFilter = obj.NewInstance () - Standard Type-Macro
vtkTemporalPathLineFilter = obj.SafeDownCast (vtkObject o) - Standard Type-Macro
obj.SetMaskPoints (int ) - Set the number of particles to track as a ratio of the input example:
setting MaskPoints to 10 will track every 10th point
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.229 vtkTemporalPathLineFilter
1407
int = obj.GetMaskPoints () - Set the number of particles to track as a ratio of the input example:
setting MaskPoints to 10 will track every 10th point
obj.SetMaxTrackLength (int ) - If the Particles being traced animate for a long time, the trails
or traces will become long and stringy. Setting the MaxTraceTimeLength will limit how much of the trace is
displayed. Tracks longer then the Max will disappear and the trace will apppear like a snake of fixed length
which progresses as the particle moves
int = obj.GetMaxTrackLength () - If the Particles being traced animate for a long time, the trails
or traces will become long and stringy. Setting the MaxTraceTimeLength will limit how much of the trace is
displayed. Tracks longer then the Max will disappear and the trace will apppear like a snake of fixed length
which progresses as the particle moves
obj.SetIdChannelArray (string ) - Specify the name of a scalar array which will be used to
fetch the index of each point. This is necessary only if the particles change position (Id order) on each time
step. The Id can be used to identify particles at each step and hence track them properly. If this array is
NULL, the global point ids are used. If an Id array cannot otherwise be found, the point index is used as the
ID.
string = obj.GetIdChannelArray () - Specify the name of a scalar array which will be used to
fetch the index of each point. This is necessary only if the particles change position (Id order) on each time
step. The Id can be used to identify particles at each step and hence track them properly. If this array is
NULL, the global point ids are used. If an Id array cannot otherwise be found, the point index is used as the
ID.
obj.SetScalarArray (string )
string = obj.GetScalarArray ()
obj.SetMaxStepDistance (double , double , double ) - If a particle disappears from
one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a
MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for
the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will
be dropped and the newer part kept).
obj.SetMaxStepDistance (double a[3]) - If a particle disappears from one end of a simulation
and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which
acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be
dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part
kept).
double = obj. GetMaxStepDistance () - If a particle disappears from one end of a simulation
and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which
acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be
dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part
kept).
obj.SetKeepDeadTrails (int ) - When a particle disappears, the trail belonging to it is removed
from the list. When this flag is enabled, dead trails will persist until the next time the list is cleared. Use
carefully as it may cause excessive memory consumption if left on by mistake.
int = obj.GetKeepDeadTrails () - When a particle disappears, the trail belonging to it is removed from the list. When this flag is enabled, dead trails will persist until the next time the list is cleared.
Use carefully as it may cause excessive memory consumption if left on by mistake.
obj.Flush () - Flush will wipe any existing data so that traces can be restarted from whatever time step
is next supplied.
obj.SetSelectionConnection (vtkAlgorithmOutput algOutput) - Set a second input
which is a selection. Particles with the same Id in the selection as the primary input will be chosen for
pathlines Note that you must have the same IdChannelArray in the selection as the input
obj.SetSelection (vtkDataSet input) - Set a second input which is a selection. Particles with
the same Id in the selection as the primary input will be chosen for pathlines Note that you must have the
same IdChannelArray in the selection as the input
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1408
34.230
vtkTemporalStatistics
34.230.1
Usage
Given an input that changes over time, vtkTemporalStatistics looks at the data for each time step and computes
some statistical information of how a point or cell variable changes over time. For example, vtkTemporalStatistics
can compute the average value of "pressure" over time of each point.
Note that this filter will require the upstream filter to be run on every time step that it reports that it can compute.
This may be a time consuming operation.
vtkTemporalStatistics ignores the temporal spacing. Each timestep will be weighted the same regardless of how
long of an interval it is to the next timestep. Thus, the average statistic may be quite different from an integration of
the variable if the time spacing varies.
.SECTION Thanks This class was originally written by Kenneth Moreland (kmorel@sandia.gov) from Sandia
National Laboratories.
To create an instance of class vtkTemporalStatistics, simply invoke its constructor as follows
obj = vtkTemporalStatistics
34.230.2
Methods
The class vtkTemporalStatistics has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTemporalStatistics class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTemporalStatistics = obj.NewInstance ()
vtkTemporalStatistics = obj.SafeDownCast (vtkObject o)
int = obj.GetComputeAverage () - Turn on/off the computation of the average values over time.
On by default. The resulting array names have "_average" appended to them.
obj.SetComputeAverage (int ) - Turn on/off the computation of the average values over time. On
by default. The resulting array names have "_average" appended to them.
obj.ComputeAverageOn () - Turn on/off the computation of the average values over time. On by
default. The resulting array names have "_average" appended to them.
obj.ComputeAverageOff () - Turn on/off the computation of the average values over time. On by
default. The resulting array names have "_average" appended to them.
int = obj.GetComputeMinimum () - Turn on/off the computation of the minimum values over time.
On by default. The resulting array names have "_minimum" appended to them.
obj.SetComputeMinimum (int ) - Turn on/off the computation of the minimum values over time. On
by default. The resulting array names have "_minimum" appended to them.
obj.ComputeMinimumOn () - Turn on/off the computation of the minimum values over time. On by
default. The resulting array names have "_minimum" appended to them.
obj.ComputeMinimumOff () - Turn on/off the computation of the minimum values over time. On by
default. The resulting array names have "_minimum" appended to them.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.231 vtkTensorGlyph
1409
int = obj.GetComputeMaximum () - Turn on/off the computation of the maximum values over time.
On by default. The resulting array names have "_maximum" appended to them.
obj.SetComputeMaximum (int ) - Turn on/off the computation of the maximum values over time.
On by default. The resulting array names have "_maximum" appended to them.
obj.ComputeMaximumOn () - Turn on/off the computation of the maximum values over time. On by
default. The resulting array names have "_maximum" appended to them.
obj.ComputeMaximumOff () - Turn on/off the computation of the maximum values over time. On by
default. The resulting array names have "_maximum" appended to them.
int = obj.GetComputeStandardDeviation ()
obj.SetComputeStandardDeviation (int )
obj.ComputeStandardDeviationOn ()
obj.ComputeStandardDeviationOff ()
34.231
vtkTensorGlyph
34.231.1
Usage
vtkTensorGlyph is a filter that copies a geometric representation (specified as polygonal data) to every input point.
The geometric representation, or glyph, can be scaled and/or rotated according to the tensor at the input point. Scaling and rotation is controlled by the eigenvalues/eigenvectors of the tensor as follows. For each tensor, the eigenvalues (and associated eigenvectors) are sorted to determine the major, medium, and minor eigenvalues/eigenvectors.
If the boolean variable ThreeGlyphs is not set the major eigenvalue scales the glyph in the x-direction, the medium
in the y-direction, and the minor in the z-direction. Then, the glyph is rotated so that the glyphs local x-axis lies
along the major eigenvector, y-axis along the medium eigenvector, and z-axis along the minor.
If the boolean variable ThreeGlyphs is set three glyphs are produced, each of them oriented along an eigenvector
and scaled according to the corresponding eigenvector.
If the boolean variable Symmetric is set each glyph is mirrored (2 or 6 glyphs will be produced)
The x-axis of the source glyph will correspond to the eigenvector on output. Point (0,0,0) in the source will be placed
in the data point. Variable Length will normally correspond to the distance from the origin to the tip of the source
glyph along the x-axis, but can be changed to produce other results when Symmetric is on, e.g. glyphs that do not
touch or that overlap.
Please note that when Symmetric is false it will generally be better to place the source glyph from (-0.5,0,0) to
(0.5,0,0), i.e. centred at the origin. When symmetric is true the placement from (0,0,0) to (1,0,0) will generally be
more convenient.
A scale factor is provided to control the amount of scaling. Also, you can turn off scaling completely if desired. The
boolean variable ClampScaling controls the maximum scaling (in conjunction with MaxScaleFactor.) This is useful
in certain applications where singularities or large order of magnitude differences exist in the eigenvalues.
If the boolean variable ColorGlyphs is set to true the glyphs are colored. The glyphs can be colored using the
input scalars (SetColorModeToScalars), which is the default, or colored using the eigenvalues (SetColorModeToEigenvalues).
Another instance variable, ExtractEigenvalues, has been provided to control extraction of eigenvalues/eigenvectors.
If this boolean is false, then eigenvalues/eigenvectors are not extracted, and the columns of the tensor are taken as
the eigenvectors (the norm of column, always positive, is the eigenvalue). This allows additional capability over the
vtkGlyph3D object. That is, the glyph can be oriented in three directions instead of one.
To create an instance of class vtkTensorGlyph, simply invoke its constructor as follows
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1410
obj = vtkTensorGlyph
34.231.2
Methods
The class vtkTensorGlyph has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkTensorGlyph class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTensorGlyph = obj.NewInstance ()
vtkTensorGlyph = obj.SafeDownCast (vtkObject o)
obj.SetSource (vtkPolyData source) - Specify the geometry to copy to each point. Old style.
See SetSourceConnection.
vtkPolyData = obj.GetSource () - Specify the geometry to copy to each point. Old style. See
SetSourceConnection.
obj.SetSourceConnection (int id, vtkAlgorithmOutput algOutput) - Specify a
source object at a specified table location. New style. Source connection is stored in port 1. This method is
equivalent to SetInputConnection(1, id, outputPort).
obj.SetSourceConnection (vtkAlgorithmOutput algOutput) - Turn on/off scaling of
glyph with eigenvalues.
obj.SetScaling (int ) - Turn on/off scaling of glyph with eigenvalues.
int = obj.GetScaling () - Turn on/off scaling of glyph with eigenvalues.
obj.ScalingOn () - Turn on/off scaling of glyph with eigenvalues.
obj.ScalingOff () - Turn on/off scaling of glyph with eigenvalues.
obj.SetScaleFactor (double ) - Specify scale factor to scale object by. (Scale factor always affects output even if scaling is off.)
double = obj.GetScaleFactor () - Specify scale factor to scale object by. (Scale factor always
affects output even if scaling is off.)
obj.SetThreeGlyphs (int ) - Turn on/off drawing three glyphs
int = obj.GetThreeGlyphs () - Turn on/off drawing three glyphs
obj.ThreeGlyphsOn () - Turn on/off drawing three glyphs
obj.ThreeGlyphsOff () - Turn on/off drawing three glyphs
obj.SetSymmetric (int ) - Turn on/off drawing a mirror of each glyph
int = obj.GetSymmetric () - Turn on/off drawing a mirror of each glyph
obj.SymmetricOn () - Turn on/off drawing a mirror of each glyph
obj.SymmetricOff () - Turn on/off drawing a mirror of each glyph
obj.SetLength (double ) - Set/Get the distance, along x, from the origin to the end of the source
glyph. It is used to draw the symmetric glyphs.
double = obj.GetLength () - Set/Get the distance, along x, from the origin to the end of the source
glyph. It is used to draw the symmetric glyphs.
obj.SetExtractEigenvalues (int ) - Turn on/off extraction of eigenvalues from tensor.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.231 vtkTensorGlyph
1411
1412
obj.ClampScalingOff () - Turn on/off scalar clamping. If scalar clamping is on, the ivar MaxScaleFactor is used to control the maximum scale factor. (This is useful to prevent uncontrolled scaling near
singularities.)
obj.SetMaxScaleFactor (double ) - Set/Get the maximum allowable scale factor. This value is
compared to the combination of the scale factor times the eigenvalue. If less, the scale factor is reset to the
MaxScaleFactor. The boolean ClampScaling has to be "on" for this to work.
double = obj.GetMaxScaleFactor () - Set/Get the maximum allowable scale factor. This value
is compared to the combination of the scale factor times the eigenvalue. If less, the scale factor is reset to the
MaxScaleFactor. The boolean ClampScaling has to be "on" for this to work.
34.232
vtkTessellatedBoxSource
34.232.1
Usage
vtkTessellatedBoxSource creates a axis-aligned box defined by its bounds and a level of subdivision. Connectivity is
strong: points of the vertices and inside the edges are shared between faces. In other words, faces are connected.
Each face looks like a grid of quads, each quad is composed of 2 triangles. Given a level of subdivision l, each
edge has l+2 points, l of them are internal edge points, the 2 other ones are the vertices. Each face has a total of
(l+2)(l+2) points, 4 of them are vertices, 4l are internal edge points, it remains l 2 internal face points.
This source only generate geometry, no DataArrays like normals or texture coordinates.
To create an instance of class vtkTessellatedBoxSource, simply invoke its constructor as follows
obj = vtkTessellatedBoxSource
34.232.2
Methods
The class vtkTessellatedBoxSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTessellatedBoxSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTessellatedBoxSource = obj.NewInstance ()
vtkTessellatedBoxSource = obj.SafeDownCast (vtkObject o)
obj.SetBounds (double , double , double , double , double , double ) - Set
the bounds of the box. See GetBounds() for a detail description.
Precondition
xmin<=xmax && ymin<=ymax && zmin<zmax
obj.SetBounds (double a[6]) - Set the bounds of the box. See GetBounds() for a detail description.
Precondition
xmin<=xmax && ymin<=ymax && zmin<zmax
double = obj. GetBounds () - Bounds of the box in world coordinates. This a 6-uple of
xmin,xmax,ymin, ymax,zmin and zmax. Initial value is (-0.5,0.5,-0.5,0.5,-0.5,0.5), bounds of a cube of length
1 centered at (0,0,0). Bounds are defined such that xmin<=xmax, ymin<=ymax and zmin<zmax.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.233 vtkTessellatorFilter
1413
Postcondition
xmin<=xmax && ymin<=ymax && zmin<zmax
obj.SetLevel (int ) - Set the level of subdivision of the faces.
Precondition
positive_level: level>=0
int = obj.GetLevel () - Level of subdivision of the faces. Initial value is 0.
Postcondition
positive_level: level>=0
obj.SetDuplicateSharedPoints (int ) - Flag to tell the source to duplicate points shared between faces (vertices of the box and internal edge points). Initial value is false. Implementation note: duplicating points is an easier method to implement than a minimal number of points.
int = obj.GetDuplicateSharedPoints () - Flag to tell the source to duplicate points shared
between faces (vertices of the box and internal edge points). Initial value is false. Implementation note:
duplicating points is an easier method to implement than a minimal number of points.
obj.DuplicateSharedPointsOn () - Flag to tell the source to duplicate points shared between
faces (vertices of the box and internal edge points). Initial value is false. Implementation note: duplicating
points is an easier method to implement than a minimal number of points.
obj.DuplicateSharedPointsOff () - Flag to tell the source to duplicate points shared between
faces (vertices of the box and internal edge points). Initial value is false. Implementation note: duplicating
points is an easier method to implement than a minimal number of points.
obj.SetQuads (int ) - Flag to tell the source to generate either a quad or two triangle for a set of four
points. Initial value is false (generate triangles).
int = obj.GetQuads () - Flag to tell the source to generate either a quad or two triangle for a set of
four points. Initial value is false (generate triangles).
obj.QuadsOn () - Flag to tell the source to generate either a quad or two triangle for a set of four points.
Initial value is false (generate triangles).
obj.QuadsOff () - Flag to tell the source to generate either a quad or two triangle for a set of four points.
Initial value is false (generate triangles).
34.233
vtkTessellatorFilter
34.233.1
Usage
1414
The filters main member function is RequestData(). This function first calls SetupOutput() which allocates arrays
and some temporary variables for the primitive callbacks (OutputTriangle and OutputLine which are called by AddATriangle and AddALine, respectively). Each cell is given an initial tesselation, which results in one or more calls to
OutputTetrahedron, OutputTriangle or OutputLine to add elements to the OutputMesh. Finally, Teardown() is called
to free the filters working space.
To create an instance of class vtkTessellatorFilter, simply invoke its constructor as follows
obj = vtkTessellatorFilter
34.233.2
Methods
The class vtkTessellatorFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTessellatorFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTessellatorFilter = obj.NewInstance ()
vtkTessellatorFilter = obj.SafeDownCast (vtkObject o)
obj.SetTessellator (vtkStreamingTessellator )
vtkStreamingTessellator = obj.GetTessellator ()
obj.SetSubdivider (vtkDataSetEdgeSubdivisionCriterion )
vtkDataSetEdgeSubdivisionCriterion = obj.GetSubdivider ()
long = obj.GetMTime ()
obj.SetOutputDimension (int ) - Set the dimension of the output tessellation. Cells in dimensions higher than the given value will have their boundaries of dimension OutputDimension tessellated. For
example, if OutputDimension is 2, a hexahedrons quadrilateral faces would be tessellated rather than its
interior.
int = obj.GetOutputDimensionMinValue () - Set the dimension of the output tessellation.
Cells in dimensions higher than the given value will have their boundaries of dimension OutputDimension
tessellated. For example, if OutputDimension is 2, a hexahedrons quadrilateral faces would be tessellated
rather than its interior.
int = obj.GetOutputDimensionMaxValue () - Set the dimension of the output tessellation.
Cells in dimensions higher than the given value will have their boundaries of dimension OutputDimension
tessellated. For example, if OutputDimension is 2, a hexahedrons quadrilateral faces would be tessellated
rather than its interior.
int = obj.GetOutputDimension () - Set the dimension of the output tessellation. Cells in dimensions higher than the given value will have their boundaries of dimension OutputDimension tessellated. For
example, if OutputDimension is 2, a hexahedrons quadrilateral faces would be tessellated rather than its
interior.
obj.SetMaximumNumberOfSubdivisions (int num_subdiv_in) - These are convenience
routines for setting properties maintained by the tessellator and subdivider. They are implemented here for
ParaViews sake.
int = obj.GetMaximumNumberOfSubdivisions () - These are convenience routines for setting properties maintained by the tessellator and subdivider. They are implemented here for ParaViews sake.
obj.SetChordError (double ce) - These are convenience routines for setting properties maintained by the tessellator and subdivider. They are implemented here for ParaViews sake.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.234 vtkTextSource
1415
double = obj.GetChordError () - These are convenience routines for setting properties maintained by the tessellator and subdivider. They are implemented here for ParaViews sake.
obj.ResetFieldCriteria () - These methods are for the ParaView client.
obj.SetFieldCriterion (int field, double chord) - These methods are for the ParaView client.
int = obj.GetMergePoints () - The adaptive tessellation will output vertices that are not shared
among cells, even where they should be. This can be corrected to some extents with a vtkMergeFilter. By
default, the filter is off and vertices will not be shared.
obj.SetMergePoints (int ) - The adaptive tessellation will output vertices that are not shared
among cells, even where they should be. This can be corrected to some extents with a vtkMergeFilter.
By default, the filter is off and vertices will not be shared.
obj.MergePointsOn () - The adaptive tessellation will output vertices that are not shared among cells,
even where they should be. This can be corrected to some extents with a vtkMergeFilter. By default, the filter
is off and vertices will not be shared.
obj.MergePointsOff () - The adaptive tessellation will output vertices that are not shared among
cells, even where they should be. This can be corrected to some extents with a vtkMergeFilter. By default,
the filter is off and vertices will not be shared.
34.234
vtkTextSource
34.234.1
Usage
vtkTextSource converts a text string into polygons. This way you can insert text into your renderings. It uses the 9x15
font from X Windows. You can specify if you want the background to be drawn or not. The characters are formed by
scan converting the raster font into quadrilaterals. Colors are assigned to the letters using scalar data. To set the
color of the characters with the sources actor property, set BackingOff on the text source and ScalarVisibilityOff on
the associated vtkPolyDataMapper. Then, the color can be set using the associated actors property.
vtkVectorText generates higher quality polygonal representations of characters.
To create an instance of class vtkTextSource, simply invoke its constructor as follows
obj = vtkTextSource
34.234.2
Methods
The class vtkTextSource has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkTextSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTextSource = obj.NewInstance ()
vtkTextSource = obj.SafeDownCast (vtkObject o)
obj.SetText (string ) - Set/Get the text to be drawn.
string = obj.GetText () - Set/Get the text to be drawn.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1416
obj.SetBacking (int ) - Controls whether or not a background is drawn with the text.
int = obj.GetBacking () - Controls whether or not a background is drawn with the text.
obj.BackingOn () - Controls whether or not a background is drawn with the text.
obj.BackingOff () - Controls whether or not a background is drawn with the text.
obj.SetForegroundColor (double , double , double ) - Set/Get the foreground color.
Default is white (1,1,1). ALpha is always 1.
obj.SetForegroundColor (double a[3]) - Set/Get the foreground color. Default is white (1,1,1).
ALpha is always 1.
double = obj.
ALpha is always 1.
Default is black
Default is black
34.235
vtkTexturedSphereSource
34.235.1
Usage
vtkTexturedSphereSource creates a polygonal sphere of specified radius centered at the origin. The resolution
(polygonal discretization) in both the latitude (phi) and longitude (theta) directions can be specified. It also is possible
to create partial sphere by specifying maximum phi and theta angles.
To create an instance of class vtkTexturedSphereSource, simply invoke its constructor as follows
obj = vtkTexturedSphereSource
34.235.2
Methods
The class vtkTexturedSphereSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTexturedSphereSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTexturedSphereSource = obj.NewInstance ()
vtkTexturedSphereSource = obj.SafeDownCast (vtkObject o)
obj.SetRadius (double ) - Set radius of sphere.
double = obj.GetRadiusMinValue () - Set radius of sphere.
double = obj.GetRadiusMaxValue () - Set radius of sphere.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.236 vtkTextureMapToCylinder
1417
34.236
vtkTextureMapToCylinder
34.236.1
Usage
vtkTextureMapToCylinder is a filter that generates 2D texture coordinates by mapping input dataset points onto a
cylinder. The cylinder can either be user specified or generated automatically. (The cylinder is generated automatically by computing the axis of the cylinder.) Note that the generated texture coordinates for the s-coordinate ranges
from (0-1) (corresponding to angle of 0->360 around axis), while the mapping of the t-coordinate is controlled by
the projection of points along the axis.
To specify a cylinder manually, you must provide two points that define the axis of the cylinder. The length of the
axis will affect the t-coordinates.
A special ivar controls how the s-coordinate is generated. If PreventSeam is set to true, the s-texture varies from
0->1 and then 1->0 (corresponding to angles of 0->180 and 180->360).
To create an instance of class vtkTextureMapToCylinder, simply invoke its constructor as follows
obj = vtkTextureMapToCylinder
1418
34.236.2
Methods
The class vtkTextureMapToCylinder has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTextureMapToCylinder
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTextureMapToCylinder = obj.NewInstance ()
vtkTextureMapToCylinder = obj.SafeDownCast (vtkObject o)
obj.SetPoint1 (double , double , double ) - Specify the first point defining the cylinder
axis,
obj.SetPoint1 (double a[3]) - Specify the first point defining the cylinder axis,
double = obj.
obj.SetPoint2 (double , double , double ) - Specify the second point defining the cylinder
axis,
obj.SetPoint2 (double a[3]) - Specify the second point defining the cylinder axis,
double = obj.
This
34.237
vtkTextureMapToPlane
34.237 vtkTextureMapToPlane
34.237.1
1419
Usage
vtkTextureMapToPlane is a filter that generates 2D texture coordinates by mapping input dataset points onto a plane.
The plane can either be user specified or generated automatically. (A least squares method is used to generate the
plane automatically.)
There are two ways you can specify the plane. The first is to provide a plane normal. In this case the points are
projected to a plane, and the points are then mapped into the user specified s-t coordinate range. For more control,
you can specify a plane with three points: an origin and two points defining the two axes of the plane. (This is
compatible with the vtkPlaneSource.) Using the second method, the SRange and TRange vectors are ignored,
since the presumption is that the user does not want to scale the texture coordinates; and you can adjust the origin
and axes points to achieve the texture coordinate scaling you need. Note also that using the three point method the
axes do not have to be orthogonal.
To create an instance of class vtkTextureMapToPlane, simply invoke its constructor as follows
obj = vtkTextureMapToPlane
34.237.2
Methods
The class vtkTextureMapToPlane has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTextureMapToPlane
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTextureMapToPlane = obj.NewInstance ()
vtkTextureMapToPlane = obj.SafeDownCast (vtkObject o)
obj.SetOrigin (double , double , double ) - Specify a point defining the origin of the
plane. Used in conjunction with the Point1 and Point2 ivars to specify a map plane.
obj.SetOrigin (double a[3]) - Specify a point defining the origin of the plane. Used in conjunction
with the Point1 and Point2 ivars to specify a map plane.
double = obj. GetOrigin () - Specify a point defining the origin of the plane. Used in conjunction
with the Point1 and Point2 ivars to specify a map plane.
obj.SetPoint1 (double , double , double ) - Specify a point defining the first axis of the
plane.
obj.SetPoint1 (double a[3]) - Specify a point defining the first axis of the plane.
double = obj.
obj.SetPoint2 (double , double , double ) - Specify a point defining the second axis of
the plane.
obj.SetPoint2 (double a[3]) - Specify a point defining the second axis of the plane.
double = obj.
1420
double = obj. GetNormal () - Specify plane normal. An alternative way to specify a map plane.
Using this method, the object will scale the resulting texture coordinate between the SRange and TRange
specified.
obj.SetSRange (double , double ) - Specify s-coordinate range for texture s-t coordinate pair.
obj.SetSRange (double a[2]) - Specify s-coordinate range for texture s-t coordinate pair.
double = obj.
obj.SetTRange (double , double ) - Specify t-coordinate range for texture s-t coordinate pair.
obj.SetTRange (double a[2]) - Specify t-coordinate range for texture s-t coordinate pair.
double = obj.
34.238
vtkTextureMapToSphere
34.238.1
Usage
vtkTextureMapToSphere is a filter that generates 2D texture coordinates by mapping input dataset points onto a
sphere. The sphere can either be user specified or generated automatically. (The sphere is generated automatically
by computing the center (i.e., averaged coordinates) of the sphere.) Note that the generated texture coordinates
range between (0,1). The s-coordinate lies in the angular direction around the z-axis, measured counter-clockwise
from the x-axis. The t-coordinate lies in the angular direction measured down from the north pole towards the south
pole.
A special ivar controls how the s-coordinate is generated. If PreventSeam is set to true, the s-texture varies from
0->1 and then 1->0 (corresponding to angles of 0->180 and 180->360).
To create an instance of class vtkTextureMapToSphere, simply invoke its constructor as follows
obj = vtkTextureMapToSphere
34.238.2
Methods
The class vtkTextureMapToSphere has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTextureMapToSphere
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTextureMapToSphere = obj.NewInstance ()
vtkTextureMapToSphere = obj.SafeDownCast (vtkObject o)
obj.SetCenter (double , double , double ) - Specify a point defining the center of the
sphere.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.239 vtkThreshold
1421
obj.SetCenter (double a[3]) - Specify a point defining the center of the sphere.
double = obj.
34.239
vtkThreshold
34.239.1
Usage
vtkThreshold is a filter that extracts cells from any dataset type that satisfy a threshold criterion. A cell satisfies
the criterion if the scalar value of (every or any) point satisfies the criterion. The criterion can take three forms: 1)
greater than a particular value; 2) less than a particular value; or 3) between two values. The output of this filter is
an unstructured grid.
Note that scalar values are available from the point and cell attribute data. By default, point data is used to obtain
scalars, but you can control this behavior. See the AttributeMode ivar below.
By default only the first scalar value is used in the decision. Use the ComponentMode and SelectedComponent
ivars to control this behavior.
To create an instance of class vtkThreshold, simply invoke its constructor as follows
obj = vtkThreshold
34.239.2
Methods
The class vtkThreshold has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkThreshold class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1422
34.239 vtkThreshold
1423
int = obj.GetComponentMode () - Control how the decision of in / out is made with multicomponent data. The choices are to use the selected component (specified in the SelectedComponent ivar),
or to look at all components. When looking at all components, the evaluation can pass if all the components
satisfy the rule (UseAll) or if any satisfy is (UseAny). The default value is UseSelected.
obj.SetComponentModeToUseSelected () - Control how the decision of in / out is made with
multi-component data. The choices are to use the selected component (specified in the SelectedComponent
ivar), or to look at all components. When looking at all components, the evaluation can pass if all the components satisfy the rule (UseAll) or if any satisfy is (UseAny). The default value is UseSelected.
obj.SetComponentModeToUseAll () - Control how the decision of in / out is made with multicomponent data. The choices are to use the selected component (specified in the SelectedComponent ivar),
or to look at all components. When looking at all components, the evaluation can pass if all the components
satisfy the rule (UseAll) or if any satisfy is (UseAny). The default value is UseSelected.
obj.SetComponentModeToUseAny () - Control how the decision of in / out is made with multicomponent data. The choices are to use the selected component (specified in the SelectedComponent ivar),
or to look at all components. When looking at all components, the evaluation can pass if all the components
satisfy the rule (UseAll) or if any satisfy is (UseAny). The default value is UseSelected.
string = obj.GetComponentModeAsString () - Control how the decision of in / out is made
with multi-component data. The choices are to use the selected component (specified in the SelectedComponent ivar), or to look at all components. When looking at all components, the evaluation can pass
if all the components satisfy the rule (UseAll) or if any satisfy is (UseAny). The default value is UseSelected.
obj.SetSelectedComponent (int ) - When the component mode is UseSelected, this ivar indicated the selected component. The default value is 0.
int = obj.GetSelectedComponentMinValue () - When the component mode is UseSelected,
this ivar indicated the selected component. The default value is 0.
int = obj.GetSelectedComponentMaxValue () - When the component mode is UseSelected,
this ivar indicated the selected component. The default value is 0.
int = obj.GetSelectedComponent () - When the component mode is UseSelected, this ivar indicated the selected component. The default value is 0.
obj.SetAllScalars (int ) - If using scalars from point data, all scalars for all points in a cell must
satisfy the threshold criterion if AllScalars is set. Otherwise, just a single scalar value satisfying the threshold
criterion enables will extract the cell.
int = obj.GetAllScalars () - If using scalars from point data, all scalars for all points in a cell
must satisfy the threshold criterion if AllScalars is set. Otherwise, just a single scalar value satisfying the
threshold criterion enables will extract the cell.
obj.AllScalarsOn () - If using scalars from point data, all scalars for all points in a cell must satisfy the
threshold criterion if AllScalars is set. Otherwise, just a single scalar value satisfying the threshold criterion
enables will extract the cell.
obj.AllScalarsOff () - If using scalars from point data, all scalars for all points in a cell must satisfy
the threshold criterion if AllScalars is set. Otherwise, just a single scalar value satisfying the threshold criterion
enables will extract the cell.
obj.SetPointsDataTypeToDouble () - Set the data type of the output points (See the data types
defined in vtkType.h). The default data type is float.
obj.SetPointsDataTypeToFloat () - Set the data type of the output points (See the data types
defined in vtkType.h). The default data type is float.
obj.SetPointsDataType (int ) - Set the data type of the output points (See the data types defined
in vtkType.h). The default data type is float.
int = obj.GetPointsDataType () - Set the data type of the output points (See the data types
defined in vtkType.h). The default data type is float.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1424
34.240
vtkThresholdPoints
34.240.1
Usage
vtkThresholdPoints is a filter that extracts points from a dataset that satisfy a threshold criterion. The criterion can
take three forms: 1) greater than a particular value; 2) less than a particular value; or 3) between a particular value.
The output of the filter is polygonal data.
To create an instance of class vtkThresholdPoints, simply invoke its constructor as follows
obj = vtkThresholdPoints
34.240.2
Methods
The class vtkThresholdPoints has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkThresholdPoints class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkThresholdPoints = obj.NewInstance ()
vtkThresholdPoints = obj.SafeDownCast (vtkObject o)
obj.ThresholdByLower (double lower) - Criterion is cells whose scalars are less or equal to
lower threshold.
obj.ThresholdByUpper (double upper) - Criterion is cells whose scalars are greater or equal to
upper threshold.
obj.ThresholdBetween (double lower, double upper) - Criterion is cells whose scalars
are between lower and upper thresholds (inclusive of the end values).
obj.SetUpperThreshold (double ) - Set/Get the upper threshold.
double = obj.GetUpperThreshold () - Set/Get the upper threshold.
obj.SetLowerThreshold (double ) - Set/Get the lower threshold.
double = obj.GetLowerThreshold () - Set/Get the lower threshold.
34.241
vtkThresholdTextureCoords
34.241.1
Usage
vtkThresholdTextureCoords is a filter that generates texture coordinates for any input dataset type given a threshold
criterion. The criterion can take three forms: 1) greater than a particular value (ThresholdByUpper()); 2) less than
a particular value (ThresholdByLower(); or 3) between two values (ThresholdBetween(). If the threshold criterion is
satisfied, the "in" texture coordinate will be set (this can be specified by the user). If the threshold criterion is not
satisfied the "out" is set.
To create an instance of class vtkThresholdTextureCoords, simply invoke its constructor as follows
obj = vtkThresholdTextureCoords
34.242 vtkTimeSourceExample
34.241.2
1425
Methods
The class vtkThresholdTextureCoords has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkThresholdTextureCoords
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkThresholdTextureCoords = obj.NewInstance ()
vtkThresholdTextureCoords = obj.SafeDownCast (vtkObject o)
obj.ThresholdByLower (double lower) - Criterion is cells whose scalars are less than lower
threshold.
obj.ThresholdByUpper (double upper) - Criterion is cells whose scalars are less than upper
threshold.
obj.ThresholdBetween (double lower, double upper) - Criterion is cells whose scalars
are between lower and upper thresholds.
double = obj.GetUpperThreshold () - Return the upper and lower thresholds.
double = obj.GetLowerThreshold () - Return the upper and lower thresholds.
obj.SetTextureDimension (int ) - Set the desired dimension of the texture map.
int = obj.GetTextureDimensionMinValue () - Set the desired dimension of the texture map.
int = obj.GetTextureDimensionMaxValue () - Set the desired dimension of the texture map.
int = obj.GetTextureDimension () - Set the desired dimension of the texture map.
obj.SetInTextureCoord (double , double , double ) - Set the texture coordinate value
for point satisfying threshold criterion.
obj.SetInTextureCoord (double a[3]) - Set the texture coordinate value for point satisfying
threshold criterion.
double = obj.
threshold criterion.
34.242
vtkTimeSourceExample
1426
34.242.1
Usage
Creates a small easily understood time varying data set for testing. The output is a vtkUntructuredGrid in which
the point and cell values vary over time in a sin wave. The analytic ivar controls whether the output corresponds
to a step function over time or is continuous. The X and Y Amplitude ivars make the output move in the X and Y
directions over time. The Growing ivar makes the number of cells in the output grow and then shrink over time.
To create an instance of class vtkTimeSourceExample, simply invoke its constructor as follows
obj = vtkTimeSourceExample
34.242.2
Methods
The class vtkTimeSourceExample has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTimeSourceExample
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTimeSourceExample = obj.NewInstance ()
vtkTimeSourceExample = obj.SafeDownCast (vtkObject o)
obj.SetAnalytic (int )
int = obj.GetAnalyticMinValue ()
int = obj.GetAnalyticMaxValue ()
int = obj.GetAnalytic ()
obj.AnalyticOn ()
obj.AnalyticOff ()
obj.SetXAmplitude (double )
double = obj.GetXAmplitude ()
obj.SetYAmplitude (double )
double = obj.GetYAmplitude ()
obj.SetGrowing (int )
int = obj.GetGrowingMinValue ()
int = obj.GetGrowingMaxValue ()
int = obj.GetGrowing ()
obj.GrowingOn ()
obj.GrowingOff ()
34.243
vtkTransformCoordinateSystems
34.243 vtkTransformCoordinateSystems
34.243.1
1427
Usage
This filter transforms points from one coordinate system to another. The user must specify the coordinate systems
in which the input and output are specified. The user must also specify the VTK viewport (i.e., renderer) in which
the transformation occurs.
To create an instance of class vtkTransformCoordinateSystems, simply invoke its constructor as follows
obj = vtkTransformCoordinateSystems
34.243.2
Methods
The class vtkTransformCoordinateSystems has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTransformCoordinateSystems class.
string = obj.GetClassName () - Standard methods for type information and printing.
int = obj.IsA (string name) - Standard methods for type information and printing.
vtkTransformCoordinateSystems = obj.NewInstance () - Standard methods for type information and printing.
vtkTransformCoordinateSystems = obj.SafeDownCast (vtkObject o)
methods for type information and printing.
Standard
1428
34.244
vtkTransformFilter
34.244.1
Usage
vtkTransformFilter is a filter to transform point coordinates, and associated point normals and vectors. Other point
data is passed through the filter.
An alternative method of transformation is to use vtkActors methods to scale, rotate, and translate objects. The
difference between the two methods is that vtkActors transformation simply effects where objects are rendered (via
the graphics pipeline), whereas vtkTransformFilter actually modifies point coordinates in the visualization pipeline.
This is necessary for some objects (e.g., vtkProbeFilter) that require point coordinates as input.
To create an instance of class vtkTransformFilter, simply invoke its constructor as follows
obj = vtkTransformFilter
34.244.2
Methods
The class vtkTransformFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTransformFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTransformFilter = obj.NewInstance ()
vtkTransformFilter = obj.SafeDownCast (vtkObject o)
long = obj.GetMTime () - Return the MTime also considering the transform.
obj.SetTransform (vtkAbstractTransform ) - Specify the transform object used to transform
points.
vtkAbstractTransform = obj.GetTransform () - Specify the transform object used to transform points.
34.245
vtkTransformPolyDataFilter
34.246 vtkTransformTextureCoords
34.245.1
1429
Usage
vtkTransformPolyDataFilter is a filter to transform point coordinates and associated point and cell normals and
vectors. Other point and cell data is passed through the filter unchanged. This filter is specialized for polygonal
data. See vtkTransformFilter for more general data.
An alternative method of transformation is to use vtkActors methods to scale, rotate, and translate objects. The
difference between the two methods is that vtkActors transformation simply effects where objects are rendered (via
the graphics pipeline), whereas vtkTransformPolyDataFilter actually modifies point coordinates in the visualization
pipeline. This is necessary for some objects (e.g., vtkProbeFilter) that require point coordinates as input.
To create an instance of class vtkTransformPolyDataFilter, simply invoke its constructor as follows
obj = vtkTransformPolyDataFilter
34.245.2
Methods
The class vtkTransformPolyDataFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTransformPolyDataFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTransformPolyDataFilter = obj.NewInstance ()
vtkTransformPolyDataFilter = obj.SafeDownCast (vtkObject o)
long = obj.GetMTime () - Return the MTime also considering the transform.
obj.SetTransform (vtkAbstractTransform ) - Specify the transform object used to transform
points.
vtkAbstractTransform = obj.GetTransform () - Specify the transform object used to transform points.
34.246
vtkTransformTextureCoords
34.246.1
Usage
vtkTransformTextureCoords is a filter that operates on texture coordinates. It ingests any type of dataset, and
outputs a dataset of the same type. The filter lets you scale, translate, and rotate texture coordinates. For example,
by using the the Scale ivar, you can shift texture coordinates that range from (0->1) to range from (0->10) (useful
for repeated patterns).
The filter operates on texture coordinates of dimension 1->3. The texture coordinates are referred to as r-s-t. If the
texture map is two dimensional, the t-coordinate (and operations on the t-coordinate) are ignored.
To create an instance of class vtkTransformTextureCoords, simply invoke its constructor as follows
obj = vtkTransformTextureCoords
1430
34.246.2
Methods
The class vtkTransformTextureCoords has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTransformTextureCoords
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTransformTextureCoords = obj.NewInstance ()
vtkTransformTextureCoords = obj.SafeDownCast (vtkObject o)
obj.SetPosition (double , double , double ) - Set/Get the position of the texture map.
Setting the position translates the texture map by the amount specified.
obj.SetPosition (double a[3]) - Set/Get the position of the texture map. Setting the position
translates the texture map by the amount specified.
double = obj. GetPosition () - Set/Get the position of the texture map. Setting the position
translates the texture map by the amount specified.
obj.AddPosition (double deltaR, double deltaS, double deltaT) - Incrementally
change the position of the texture map (i.e., does a translate or shift of the texture coordinates).
obj.AddPosition (double deltaPosition[3]) - Incrementally change the position of the texture map (i.e., does a translate or shift of the texture coordinates).
obj.SetScale (double , double , double ) - Set/Get the scale of the texture map. Scaling
in performed independently on the r, s and t axes.
obj.SetScale (double a[3]) - Set/Get the scale of the texture map. Scaling in performed independently on the r, s and t axes.
double = obj. GetScale () - Set/Get the scale of the texture map. Scaling in performed independently on the r, s and t axes.
obj.SetOrigin (double , double , double ) - Set/Get the origin of the texture map. This is
the point about which the texture map is flipped (e.g., rotated). Since a typical texture map ranges from (0,1)
in the r-s-t coordinates, the default origin is set at (0.5,0.5,0.5).
obj.SetOrigin (double a[3]) - Set/Get the origin of the texture map. This is the point about which
the texture map is flipped (e.g., rotated). Since a typical texture map ranges from (0,1) in the r-s-t coordinates,
the default origin is set at (0.5,0.5,0.5).
double = obj. GetOrigin () - Set/Get the origin of the texture map. This is the point about which
the texture map is flipped (e.g., rotated). Since a typical texture map ranges from (0,1) in the r-s-t coordinates,
the default origin is set at (0.5,0.5,0.5).
obj.SetFlipR (int ) - Boolean indicates whether the texture map should be flipped around the s-axis.
Note that the flips occur around the texture origin.
int = obj.GetFlipR () - Boolean indicates whether the texture map should be flipped around the
s-axis. Note that the flips occur around the texture origin.
obj.FlipROn () - Boolean indicates whether the texture map should be flipped around the s-axis. Note
that the flips occur around the texture origin.
obj.FlipROff () - Boolean indicates whether the texture map should be flipped around the s-axis. Note
that the flips occur around the texture origin.
obj.SetFlipS (int ) - Boolean indicates whether the texture map should be flipped around the s-axis.
Note that the flips occur around the texture origin.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.247 vtkTriangleFilter
1431
int = obj.GetFlipS () - Boolean indicates whether the texture map should be flipped around the
s-axis. Note that the flips occur around the texture origin.
obj.FlipSOn () - Boolean indicates whether the texture map should be flipped around the s-axis. Note
that the flips occur around the texture origin.
obj.FlipSOff () - Boolean indicates whether the texture map should be flipped around the s-axis. Note
that the flips occur around the texture origin.
obj.SetFlipT (int ) - Boolean indicates whether the texture map should be flipped around the t-axis.
Note that the flips occur around the texture origin.
int = obj.GetFlipT () - Boolean indicates whether the texture map should be flipped around the
t-axis. Note that the flips occur around the texture origin.
obj.FlipTOn () - Boolean indicates whether the texture map should be flipped around the t-axis. Note
that the flips occur around the texture origin.
obj.FlipTOff () - Boolean indicates whether the texture map should be flipped around the t-axis. Note
that the flips occur around the texture origin.
34.247
vtkTriangleFilter
34.247.1
Usage
vtkTriangleFilter generates triangles from input polygons and triangle strips. The filter also will pass through vertices
and lines, if requested.
To create an instance of class vtkTriangleFilter, simply invoke its constructor as follows
obj = vtkTriangleFilter
34.247.2
Methods
The class vtkTriangleFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkTriangleFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTriangleFilter = obj.NewInstance ()
vtkTriangleFilter = obj.SafeDownCast (vtkObject o)
obj.PassVertsOn () - Turn on/off passing vertices through filter.
obj.PassVertsOff () - Turn on/off passing vertices through filter.
obj.SetPassVerts (int ) - Turn on/off passing vertices through filter.
int = obj.GetPassVerts () - Turn on/off passing vertices through filter.
obj.PassLinesOn () - Turn on/off passing lines through filter.
obj.PassLinesOff () - Turn on/off passing lines through filter.
obj.SetPassLines (int ) - Turn on/off passing lines through filter.
int = obj.GetPassLines () - Turn on/off passing lines through filter.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1432
34.248
vtkTriangularTCoords
34.248.1
Usage
vtkTriangularTCoords is a filter that generates texture coordinates for triangles. Texture coordinates for each triangle
are: (0,0), (1,0) and (.5,sqrt(3)/2). This filter assumes that the triangle texture map is symmetric about the center
of the triangle. Thus the order Of the texture coordinates is not important. The procedural texture in vtkTriangularTexture is designed with this symmetry. For more information see the paper "Opacity-modulating Triangular Textures
for Irregular Surfaces," by Penny Rheingans, IEEE Visualization 96, pp. 219-225.
To create an instance of class vtkTriangularTCoords, simply invoke its constructor as follows
obj = vtkTriangularTCoords
34.248.2
Methods
The class vtkTriangularTCoords has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTriangularTCoords class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTriangularTCoords = obj.NewInstance ()
vtkTriangularTCoords = obj.SafeDownCast (vtkObject o)
34.249
vtkTubeFilter
34.249.1
Usage
vtkTubeFilter is a filter that generates a tube around each input line. The tubes are made up of triangle strips
and rotate around the tube with the rotation of the line normals. (If no normals are present, they are computed
automatically.) The radius of the tube can be set to vary with scalar or vector value. If the radius varies with scalar
value the radius is linearly adjusted. If the radius varies with vector value, a mass flux preserving variation is used.
The number of sides for the tube also can be specified. You can also specify which of the sides are visible. This
is useful for generating interesting striping effects. Other options include the ability to cap the tube and generate
texture coordinates. Texture coordinates can be used with an associated texture map to create interesting effects
such as marking the tube with stripes corresponding to length or time.
This filter is typically used to create thick or dramatic lines. Another common use is to combine this filter with
vtkStreamLine to generate streamtubes.
To create an instance of class vtkTubeFilter, simply invoke its constructor as follows
obj = vtkTubeFilter
34.249.2
Methods
The class vtkTubeFilter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkTubeFilter class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.249 vtkTubeFilter
1433
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTubeFilter = obj.NewInstance ()
vtkTubeFilter = obj.SafeDownCast (vtkObject o)
obj.SetRadius (double ) - Set the minimum tube radius (minimum because the tube radius may
vary).
double = obj.GetRadiusMinValue () - Set the minimum tube radius (minimum because the tube
radius may vary).
double = obj.GetRadiusMaxValue () - Set the minimum tube radius (minimum because the tube
radius may vary).
double = obj.GetRadius () - Set the minimum tube radius (minimum because the tube radius may
vary).
obj.SetVaryRadius (int ) - Turn on/off the variation of tube radius with scalar value.
int = obj.GetVaryRadiusMinValue () - Turn on/off the variation of tube radius with scalar value.
int = obj.GetVaryRadiusMaxValue () - Turn on/off the variation of tube radius with scalar value.
int = obj.GetVaryRadius () - Turn on/off the variation of tube radius with scalar value.
obj.SetVaryRadiusToVaryRadiusOff () - Turn on/off the variation of tube radius with scalar
value.
obj.SetVaryRadiusToVaryRadiusByScalar () - Turn on/off the variation of tube radius with
scalar value.
obj.SetVaryRadiusToVaryRadiusByVector () - Turn on/off the variation of tube radius with
scalar value.
obj.SetVaryRadiusToVaryRadiusByAbsoluteScalar () - Turn on/off the variation of tube
radius with scalar value.
string = obj.GetVaryRadiusAsString () - Turn on/off the variation of tube radius with scalar
value.
obj.SetNumberOfSides (int ) - Set the number of sides for the tube. At a minimum, number of
sides is 3.
int = obj.GetNumberOfSidesMinValue () - Set the number of sides for the tube. At a minimum,
number of sides is 3.
int = obj.GetNumberOfSidesMaxValue () - Set the number of sides for the tube. At a minimum,
number of sides is 3.
int = obj.GetNumberOfSides () - Set the number of sides for the tube. At a minimum, number of
sides is 3.
obj.SetRadiusFactor (double ) - Set the maximum tube radius in terms of a multiple of the minimum radius.
double = obj.GetRadiusFactor () - Set the maximum tube radius in terms of a multiple of the
minimum radius.
obj.SetDefaultNormal (double , double , double ) - Set the default normal to use if no
normals are supplied, and the DefaultNormalOn is set.
obj.SetDefaultNormal (double a[3]) - Set the default normal to use if no normals are supplied,
and the DefaultNormalOn is set.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1434
double = obj. GetDefaultNormal () - Set the default normal to use if no normals are supplied,
and the DefaultNormalOn is set.
obj.SetUseDefaultNormal (int ) - Set a boolean to control whether to use default normals.
DefaultNormalOn is set.
int = obj.GetUseDefaultNormal () - Set a boolean to control whether to use default normals.
DefaultNormalOn is set.
obj.UseDefaultNormalOn () - Set a boolean to control whether to use default normals. DefaultNormalOn is set.
obj.UseDefaultNormalOff () - Set a boolean to control whether to use default normals. DefaultNormalOn is set.
obj.SetSidesShareVertices (int ) - Set a boolean to control whether tube sides should share
vertices. This creates independent strips, with constant normals so the tube is always faceted in appearance.
int = obj.GetSidesShareVertices () - Set a boolean to control whether tube sides should
share vertices. This creates independent strips, with constant normals so the tube is always faceted in
appearance.
obj.SidesShareVerticesOn () - Set a boolean to control whether tube sides should share vertices.
This creates independent strips, with constant normals so the tube is always faceted in appearance.
obj.SidesShareVerticesOff () - Set a boolean to control whether tube sides should share vertices. This creates independent strips, with constant normals so the tube is always faceted in appearance.
obj.SetCapping (int ) - Turn on/off whether to cap the ends with polygons.
int = obj.GetCapping () - Turn on/off whether to cap the ends with polygons.
obj.CappingOn () - Turn on/off whether to cap the ends with polygons.
obj.CappingOff () - Turn on/off whether to cap the ends with polygons.
obj.SetOnRatio (int ) - Control the striping of the tubes. If OnRatio is greater than 1, then every
nth tube side is turned on, beginning with the Offset side.
int = obj.GetOnRatioMinValue () - Control the striping of the tubes. If OnRatio is greater than
1, then every nth tube side is turned on, beginning with the Offset side.
int = obj.GetOnRatioMaxValue () - Control the striping of the tubes. If OnRatio is greater than
1, then every nth tube side is turned on, beginning with the Offset side.
int = obj.GetOnRatio () - Control the striping of the tubes. If OnRatio is greater than 1, then every
nth tube side is turned on, beginning with the Offset side.
obj.SetOffset (int ) - Control the striping of the tubes. The offset sets the first tube side that is
visible. Offset is generally used with OnRatio to create nifty striping effects.
int = obj.GetOffsetMinValue () - Control the striping of the tubes. The offset sets the first tube
side that is visible. Offset is generally used with OnRatio to create nifty striping effects.
int = obj.GetOffsetMaxValue () - Control the striping of the tubes. The offset sets the first tube
side that is visible. Offset is generally used with OnRatio to create nifty striping effects.
int = obj.GetOffset () - Control the striping of the tubes. The offset sets the first tube side that is
visible. Offset is generally used with OnRatio to create nifty striping effects.
obj.SetGenerateTCoords (int ) - Control whether and how texture coordinates are produced.
This is useful for striping the tube with length textures, etc. If you use scalars to create the texture, the scalars
are assumed to be monotonically increasing (or decreasing).
int = obj.GetGenerateTCoordsMinValue () - Control whether and how texture coordinates
are produced. This is useful for striping the tube with length textures, etc. If you use scalars to create the
texture, the scalars are assumed to be monotonically increasing (or decreasing).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.250 vtkUncertaintyTubeFilter
1435
34.250
vtkUncertaintyTubeFilter
34.250.1
Usage
vtkUncertaintyTubeFilter is a filter that generates ellipsoidal (in cross section) tubes that follows a polyline. The input
is a vtkPolyData with polylines that have associated vector point data. The vector data represents the uncertainty
of the polyline in the x-y-z directions.
To create an instance of class vtkUncertaintyTubeFilter, simply invoke its constructor as follows
obj = vtkUncertaintyTubeFilter
1436
34.250.2
Methods
The class vtkUncertaintyTubeFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkUncertaintyTubeFilter
class.
string = obj.GetClassName () - Standard methods for printing and obtaining type information for
instances of this class.
int = obj.IsA (string name) - Standard methods for printing and obtaining type information for
instances of this class.
vtkUncertaintyTubeFilter = obj.NewInstance () - Standard methods for printing and obtaining type information for instances of this class.
vtkUncertaintyTubeFilter = obj.SafeDownCast (vtkObject o) - Standard methods
for printing and obtaining type information for instances of this class.
obj.SetNumberOfSides (int ) - Set / get the number of sides for the tube. At a minimum, the
number of sides is 3.
int = obj.GetNumberOfSidesMinValue () - Set / get the number of sides for the tube. At a
minimum, the number of sides is 3.
int = obj.GetNumberOfSidesMaxValue () - Set / get the number of sides for the tube. At a
minimum, the number of sides is 3.
int = obj.GetNumberOfSides () - Set / get the number of sides for the tube. At a minimum, the
number of sides is 3.
34.251
vtkUnstructuredGridGeometryFilter
34.251.1
Usage
vtkUnstructuredGridGeometryFilter is a filter that extracts geometry (and associated data) from an unstructured
grid. It differs from vtkGeometryFilter by not tessellating higher order faces: 2D faces of quadratic 3D cells will
be quadratic. A quadratic edge is extracted as a quadratic edge. For that purpose, the output of this filter is an
unstructured grid, not a polydata. Also, the face of a voxel is a pixel, not a quad. Geometry is obtained as follows:
all 0D, 1D, and 2D cells are extracted. All 2D faces that are used by only one 3D cell (i.e., boundary faces) are
extracted. It also is possible to specify conditions on point ids, cell ids, and on bounding box (referred to as "Extent")
to control the extraction process.
To create an instance of class vtkUnstructuredGridGeometryFilter, simply invoke its constructor as follows
obj = vtkUnstructuredGridGeometryFilter
34.251.2
Methods
The class vtkUnstructuredGridGeometryFilter has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkUnstructuredGridGeometryFilter class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.251 vtkUnstructuredGridGeometryFilter
1437
1438
obj.SetExtent (double xMin, double xMax, double yMin, double yMax, double
zMin, double zMax) - Specify a (xmin,xmax, ymin,ymax, zmin,zmax) bounding box to clip data.
obj.SetExtent (double extent[6]) - Set / get a (xmin,xmax, ymin,ymax, zmin,zmax) bounding
box to clip data.
obj.SetMerging (int ) - Turn on/off merging of coincident points. Note that is merging is on, points
with different point attributes (e.g., normals) are merged, which may cause rendering artifacts.
int = obj.GetMerging () - Turn on/off merging of coincident points. Note that is merging is on,
points with different point attributes (e.g., normals) are merged, which may cause rendering artifacts.
obj.MergingOn () - Turn on/off merging of coincident points. Note that is merging is on, points with
different point attributes (e.g., normals) are merged, which may cause rendering artifacts.
obj.MergingOff () - Turn on/off merging of coincident points. Note that is merging is on, points with
different point attributes (e.g., normals) are merged, which may cause rendering artifacts.
obj.SetLocator (vtkIncrementalPointLocator locator) - Set / get a spatial locator for
merging points. By default an instance of vtkMergePoints is used.
vtkIncrementalPointLocator = obj.GetLocator () - Set / get a spatial locator for merging
points. By default an instance of vtkMergePoints is used.
obj.CreateDefaultLocator () - Create default locator. Used to create one when none is specified.
long = obj.GetMTime () - Return the MTime also considering the locator.
34.252
vtkVectorDot
34.252.1
Usage
vtkVectorDot is a filter to generate scalar values from a dataset. The scalar value at a point is created by computing
the dot product between the normal and vector at that point. Combined with the appropriate color map, this can
show nodal lines/mode shapes of vibration, or a displacement plot.
To create an instance of class vtkVectorDot, simply invoke its constructor as follows
obj = vtkVectorDot
34.252.2
Methods
The class vtkVectorDot has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkVectorDot class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVectorDot = obj.NewInstance ()
vtkVectorDot = obj.SafeDownCast (vtkObject o)
obj.SetScalarRange (double , double ) - Specify range to map scalars into.
obj.SetScalarRange (double a[2]) - Specify range to map scalars into.
double = obj.
34.253 vtkVectorNorm
34.253
1439
vtkVectorNorm
34.253.1
Usage
vtkVectorNorm is a filter that generates scalar values by computing Euclidean norm of vector triplets. Scalars can
be normalized 0<=s<=1 if desired.
Note that this filter operates on point or cell attribute data, or both. By default, the filter operates on both point and
cell data if vector point and cell data, respectively, are available from the input. Alternatively, you can choose to
generate scalar norm values for just cell or point data.
To create an instance of class vtkVectorNorm, simply invoke its constructor as follows
obj = vtkVectorNorm
34.253.2
Methods
The class vtkVectorNorm has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkVectorNorm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVectorNorm = obj.NewInstance ()
vtkVectorNorm = obj.SafeDownCast (vtkObject o)
obj.SetNormalize (int ) - Specify whether to normalize scalar values.
int = obj.GetNormalize () - Specify whether to normalize scalar values.
obj.NormalizeOn () - Specify whether to normalize scalar values.
obj.NormalizeOff () - Specify whether to normalize scalar values.
obj.SetAttributeMode (int ) - Control how the filter works to generate scalar data from the input
vector data. By default, (AttributeModeToDefault) the filter will generate the scalar norm for point and cell
data (if vector data present in the input). Alternatively, you can explicitly set the filter to generate point data
(AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).
int = obj.GetAttributeMode () - Control how the filter works to generate scalar data from the
input vector data. By default, (AttributeModeToDefault) the filter will generate the scalar norm for point and
cell data (if vector data present in the input). Alternatively, you can explicitly set the filter to generate point
data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).
obj.SetAttributeModeToDefault () - Control how the filter works to generate scalar data from
the input vector data. By default, (AttributeModeToDefault) the filter will generate the scalar norm for point
and cell data (if vector data present in the input). Alternatively, you can explicitly set the filter to generate point
data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).
obj.SetAttributeModeToUsePointData () - Control how the filter works to generate scalar data
from the input vector data. By default, (AttributeModeToDefault) the filter will generate the scalar norm for
point and cell data (if vector data present in the input). Alternatively, you can explicitly set the filter to generate
point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).
obj.SetAttributeModeToUseCellData () - Control how the filter works to generate scalar data
from the input vector data. By default, (AttributeModeToDefault) the filter will generate the scalar norm for
point and cell data (if vector data present in the input). Alternatively, you can explicitly set the filter to generate
point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1440
34.254
vtkVertexGlyphFilter
34.254.1
Usage
This filter throws away all of the cells in the input and replaces them with a vertex on each point. The intended
use of this filter is roughly equivalent to the vtkGlyph3D filter, except this filter is specifically for data that has many
vertices, making the rendered result faster and less cluttered than the glyph filter. This filter may take a graph or
point set as input.
To create an instance of class vtkVertexGlyphFilter, simply invoke its constructor as follows
obj = vtkVertexGlyphFilter
34.254.2
Methods
The class vtkVertexGlyphFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkVertexGlyphFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVertexGlyphFilter = obj.NewInstance ()
vtkVertexGlyphFilter = obj.SafeDownCast (vtkObject o)
34.255
vtkVoxelContoursToSurfaceFilter
34.255.1
Usage
vtkVoxelContoursToSurfaceFilter is a filter that takes contours and produces surfaces. There are some restrictions
for the contours:
The contours are input as vtkPolyData, with the contours being polys in the vtkPolyData.
The contours lie on XY planes - each contour has a constant Z
The contours are ordered in the polys of the vtkPolyData such that all contours on the first (lowest) XY plane
are first, then continuing in order of increasing Z value.
The X, Y and Z coordinates are all integer values.
The desired sampling of the contour data is 1x1x1 - Aspect can be used to control the aspect ratio in the
output polygonal dataset.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.256 vtkWarpLens
1441
This filter takes the contours and produces a structured points dataset of signed floating point number indicating
distance from a contour. A contouring filter is then applied to generate 3D surfaces from a stack of 2D contour
distance slices. This is done in a streaming fashion so as not to use to much memory.
To create an instance of class vtkVoxelContoursToSurfaceFilter, simply invoke its constructor as follows
obj = vtkVoxelContoursToSurfaceFilter
34.255.2
Methods
The class vtkVoxelContoursToSurfaceFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkVoxelContoursToSurfaceFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVoxelContoursToSurfaceFilter = obj.NewInstance ()
vtkVoxelContoursToSurfaceFilter = obj.SafeDownCast (vtkObject o)
obj.SetMemoryLimitInBytes (int ) - Set / Get the memory limit in bytes for this filter. This is the
limit of the size of the structured points data set that is created for intermediate processing. The data will be
streamed through this volume in as many pieces as necessary.
int = obj.GetMemoryLimitInBytes () - Set / Get the memory limit in bytes for this filter. This is
the limit of the size of the structured points data set that is created for intermediate processing. The data will
be streamed through this volume in as many pieces as necessary.
obj.SetSpacing (double , double , double )
obj.SetSpacing (double a[3])
double = obj.
34.256
GetSpacing ()
vtkWarpLens
34.256.1
Usage
vtkWarpLens is a filter that modifies point coordinates by moving in accord with a lens distortion model.
To create an instance of class vtkWarpLens, simply invoke its constructor as follows
obj = vtkWarpLens
34.256.2
Methods
The class vtkWarpLens has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkWarpLens class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1442
vtkWarpLens = obj.NewInstance ()
vtkWarpLens = obj.SafeDownCast (vtkObject o)
obj.SetKappa (double kappa) - Specify second order symmetric radial lens distortion parameter.
This is obsoleted by newer instance variables.
double = obj.GetKappa () - Specify second order symmetric radial lens distortion parameter. This
is obsoleted by newer instance variables.
obj.SetCenter (double centerX, double centerY) - Specify the center of radial distortion
in pixels. This is obsoleted by newer instance variables.
double = obj.GetCenter () - Specify the center of radial distortion in pixels. This is obsoleted by
newer instance variables.
obj.SetPrincipalPoint (double , double ) - Specify the calibrated principal point of the
camera/lens
obj.SetPrincipalPoint (double a[2]) - Specify the calibrated principal point of the camera/lens
double = obj.
a/lens
obj.SetK1 (double ) - Specify the symmetric radial distortion parameters for the lens
double = obj.GetK1 () - Specify the symmetric radial distortion parameters for the lens
obj.SetK2 (double ) - Specify the symmetric radial distortion parameters for the lens
double = obj.GetK2 () - Specify the symmetric radial distortion parameters for the lens
obj.SetP1 (double ) - Specify the decentering distortion parameters for the lens
double = obj.GetP1 () - Specify the decentering distortion parameters for the lens
obj.SetP2 (double ) - Specify the decentering distortion parameters for the lens
double = obj.GetP2 () - Specify the decentering distortion parameters for the lens
obj.SetFormatWidth (double ) - Specify the imager format width / height in mm
double = obj.GetFormatWidth () - Specify the imager format width / height in mm
obj.SetFormatHeight (double ) - Specify the imager format width / height in mm
double = obj.GetFormatHeight () - Specify the imager format width / height in mm
obj.SetImageWidth (int ) - Specify the image width / height in pixels
int = obj.GetImageWidth () - Specify the image width / height in pixels
obj.SetImageHeight (int ) - Specify the image width / height in pixels
int = obj.GetImageHeight () - Specify the image width / height in pixels
34.257
vtkWarpScalar
34.257 vtkWarpScalar
34.257.1
1443
Usage
vtkWarpScalar is a filter that modifies point coordinates by moving points along point normals by the scalar amount
times the scale factor. Useful for creating carpet or x-y-z plots.
If normals are not present in data, the Normal instance variable will be used as the direction along which to warp
the geometry. If normals are present but you would like to use the Normal instance variable, set the UseNormal
boolean to true.
If XYPlane boolean is set true, then the z-value is considered to be a scalar value (still scaled by scale factor), and
the displacement is along the z-axis. If scalars are also present, these are copied through and can be used to color
the surface.
Note that the filter passes both its point data and cell data to its output, except for normals, since these are distorted
by the warping.
To create an instance of class vtkWarpScalar, simply invoke its constructor as follows
obj = vtkWarpScalar
34.257.2
Methods
The class vtkWarpScalar has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkWarpScalar class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkWarpScalar = obj.NewInstance ()
vtkWarpScalar = obj.SafeDownCast (vtkObject o)
obj.SetScaleFactor (double ) - Specify value to scale displacement.
double = obj.GetScaleFactor () - Specify value to scale displacement.
obj.SetUseNormal (int ) - Turn on/off use of user specified normal. If on, data normals will be
ignored and instance variable Normal will be used instead.
int = obj.GetUseNormal () - Turn on/off use of user specified normal. If on, data normals will be
ignored and instance variable Normal will be used instead.
obj.UseNormalOn () - Turn on/off use of user specified normal. If on, data normals will be ignored and
instance variable Normal will be used instead.
obj.UseNormalOff () - Turn on/off use of user specified normal. If on, data normals will be ignored
and instance variable Normal will be used instead.
obj.SetNormal (double , double , double ) - Normal (i.e., direction) along which to warp
geometry. Only used if UseNormal boolean set to true or no normals available in data.
obj.SetNormal (double a[3]) - Normal (i.e., direction) along which to warp geometry. Only used
if UseNormal boolean set to true or no normals available in data.
double = obj. GetNormal () - Normal (i.e., direction) along which to warp geometry. Only used
if UseNormal boolean set to true or no normals available in data.
obj.SetXYPlane (int ) - Turn on/off flag specifying that input data is x-y plane. If x-y plane, then the
z value is used to warp the surface in the z-axis direction (times the scale factor) and scalars are used to color
the surface.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1444
int = obj.GetXYPlane () - Turn on/off flag specifying that input data is x-y plane. If x-y plane, then
the z value is used to warp the surface in the z-axis direction (times the scale factor) and scalars are used to
color the surface.
obj.XYPlaneOn () - Turn on/off flag specifying that input data is x-y plane. If x-y plane, then the z value
is used to warp the surface in the z-axis direction (times the scale factor) and scalars are used to color the
surface.
obj.XYPlaneOff () - Turn on/off flag specifying that input data is x-y plane. If x-y plane, then the z
value is used to warp the surface in the z-axis direction (times the scale factor) and scalars are used to color
the surface.
34.258
vtkWarpTo
34.258.1
Usage
vtkWarpTo is a filter that modifies point coordinates by moving the points towards a user specified position.
To create an instance of class vtkWarpTo, simply invoke its constructor as follows
obj = vtkWarpTo
34.258.2
Methods
The class vtkWarpTo has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkWarpTo class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkWarpTo = obj.NewInstance ()
vtkWarpTo = obj.SafeDownCast (vtkObject o)
obj.SetScaleFactor (double ) - Set/Get the value to scale displacement.
double = obj.GetScaleFactor () - Set/Get the value to scale displacement.
double = obj.
34.259 vtkWarpVector
34.259
1445
vtkWarpVector
34.259.1
Usage
vtkWarpVector is a filter that modifies point coordinates by moving points along vector times the scale factor. Useful
for showing flow profiles or mechanical deformation.
The filter passes both its point data and cell data to its output.
To create an instance of class vtkWarpVector, simply invoke its constructor as follows
obj = vtkWarpVector
34.259.2
Methods
The class vtkWarpVector has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkWarpVector class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkWarpVector = obj.NewInstance ()
vtkWarpVector = obj.SafeDownCast (vtkObject o)
obj.SetScaleFactor (double ) - Specify value to scale displacement.
double = obj.GetScaleFactor () - Specify value to scale displacement.
34.260
vtkWindowedSincPolyDataFilter
34.260.1
Usage
vtkWindowedSincPolyDataFiler adjust point coordinate using a windowed sinc function interpolation kernel. The
effect is to "relax" the mesh, making the cells better shaped and the vertices more evenly distributed. Note that this
filter operates the lines, polygons, and triangle strips composing an instance of vtkPolyData. Vertex or poly-vertex
cells are never modified.
The algorithm proceeds as follows. For each vertex v, a topological and geometric analysis is performed to determine which vertices are connected to v, and which cells are connected to v. Then, a connectivity array is constructed
for each vertex. (The connectivity array is a list of lists of vertices that directly attach to each vertex.) Next, an iteration phase begins over all vertices. For each vertex v, the coordinates of v are modified using a windowed sinc
function interpolation kernel. Taubin describes this methodology is the IBM tech report RC-20404 (#90237, dated
3/12/96) "Optimal Surface Smoothing as Filter Design" G. Taubin, T. Zhang and G. Golub. (Zhang and Golub are at
Stanford University).
This report discusses using standard signal processing low-pass filters (in particular windowed sinc functions) to
smooth polyhedra. The transfer functions of the low-pass filters are approximated by Chebyshev polynomials. This
facilitates applying the filters in an iterative diffusion process (as opposed to a kernel convolution). The more smoothing iterations applied, the higher the degree of polynomial approximating the low-pass filter transfer function. Each
smoothing iteration, therefore, applies the next higher term of the Chebyshev filter approximation to the polyhedron.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1446
This decoupling of the filter into an iteratively applied polynomial is possible since the Chebyshev polynomials are
orthogonal, i.e. increasing the order of the approximation to the filter transfer function does not alter the previously
calculated coefficients for the low order terms.
Note: Care must be taken to avoid smoothing with too few iterations. A Chebyshev approximation with too few terms
is an poor approximation. The first few smoothing iterations represent a severe scaling and translation of the data.
Subsequent iterations cause the smoothed polyhedron to converge to the true location and scale of the object. We
have attempted to protect against this by automatically adjusting the filter, effectively widening the pass band. This
adjustment is only possible if the number of iterations is greater than 1. Note that this sacrifices some degree of
smoothing for model integrity. For those interested, the filter is adjusted by searching for a value sigma such that
the actual pass band is k_pb + sigma and such that the filter transfer function evaluates to unity at k_pb, i.e. f(k_pb)
=1
To improve the numerical stability of the solution and minimize the scaling the translation effects, the algorithm can
translate and scale the position coordinates to within the unit cube [-1, 1], perform the smoothing, and translate and
scale the position coordinates back to the original coordinate frame. This mode is controlled with the NormalizeCoordinatesOn() / NormalizeCoordinatesOff() methods. For legacy reasons, the default is NormalizeCoordinatesOff.
This implementation is currently limited to using an interpolation kernel based on Hamming windows. Other windows
(such as Hann, Blackman, Kaiser, Lanczos, Gaussian, and exponential windows) could be used instead.
There are some special instance variables used to control the execution of this filter. (These ivars basically control
what vertices can be smoothed, and the creation of the connectivity array.) The BoundarySmoothing ivar enables/disables the smoothing operation on vertices that are on the "boundary" of the mesh. A boundary vertex is
one that is surrounded by a semi-cycle of polygons (or used by a single line).
Another important ivar is FeatureEdgeSmoothing. If this ivar is enabled, then interior vertices are classified as either
"simple", "interior edge", or "fixed", and smoothed differently. (Interior vertices are manifold vertices surrounded by
a cycle of polygons; or used by two line cells.) The classification is based on the number of feature edges attached
to v. A feature edge occurs when the angle between the two surface normals of a polygon sharing an edge is
greater than the FeatureAngle ivar. Then, vertices used by no feature edges are classified "simple", vertices used
by exactly two feature edges are classified "interior edge", and all others are "fixed" vertices.
Once the classification is known, the vertices are smoothed differently. Corner (i.e., fixed) vertices are not smoothed
at all. Simple vertices are smoothed as before . Interior edge vertices are smoothed only along their two connected
edges, and only if the angle between the edges is less than the EdgeAngle ivar.
The total smoothing can be controlled by using two ivars. The NumberOfIterations determines the maximum number of smoothing passes. The NumberOfIterations corresponds to the degree of the polynomial that is used to
approximate the windowed sinc function. Ten or twenty iterations is all the is usually necessary. Contrast this with
vtkSmoothPolyDataFilter which usually requires 100 to 200 smoothing iterations. vtkSmoothPolyDataFilter is also
not an approximation to an ideal low-pass filter, which can cause the geometry to shrink as the amount of smoothing
increases.
The second ivar is the specification of the PassBand for the windowed sinc filter. By design, the PassBand is
specified as a doubleing point number between 0 and 2. Lower PassBand values produce more smoothing. A good
default value for the PassBand is 0.1 (for those interested, the PassBand (and frequencies) for PolyData are based
on the valence of the vertices, this limits all the frequency modes in a polyhedral mesh to between 0 and 2.)
There are two instance variables that control the generation of error data. If the ivar GenerateErrorScalars is on,
then a scalar value indicating the distance of each vertex from its original position is computed. If the ivar GenerateErrorVectors is on, then a vector representing change in position is computed.
To create an instance of class vtkWindowedSincPolyDataFilter, simply invoke its constructor as follows
obj = vtkWindowedSincPolyDataFilter
34.260.2
Methods
The class vtkWindowedSincPolyDataFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkWindowedSincPolyGenerated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.260 vtkWindowedSincPolyDataFilter
1447
DataFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkWindowedSincPolyDataFilter = obj.NewInstance ()
vtkWindowedSincPolyDataFilter = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfIterations (int ) - Specify the number of iterations (or degree of the polynomial approximating the windowed sinc function).
int = obj.GetNumberOfIterationsMinValue () - Specify the number of iterations (or degree
of the polynomial approximating the windowed sinc function).
int = obj.GetNumberOfIterationsMaxValue () - Specify the number of iterations (or degree
of the polynomial approximating the windowed sinc function).
int = obj.GetNumberOfIterations () - Specify the number of iterations (or degree of the polynomial approximating the windowed sinc function).
obj.SetPassBand (double ) - Set the passband value for the windowed sinc filter
double = obj.GetPassBandMinValue () - Set the passband value for the windowed sinc filter
double = obj.GetPassBandMaxValue () - Set the passband value for the windowed sinc filter
double = obj.GetPassBand () - Set the passband value for the windowed sinc filter
obj.SetNormalizeCoordinates (int ) - Turn on/off coordinate normalization. The positions can
be translated and scaled such that they fit within a [-1, 1] prior to the smoothing computation. The default is
off. The numerical stability of the solution can be improved by turning normalization on. If normalization is on,
the coordinates will be rescaled to the original coordinate system after smoothing has completed.
int = obj.GetNormalizeCoordinates () - Turn on/off coordinate normalization. The positions
can be translated and scaled such that they fit within a [-1, 1] prior to the smoothing computation. The default
is off. The numerical stability of the solution can be improved by turning normalization on. If normalization is
on, the coordinates will be rescaled to the original coordinate system after smoothing has completed.
obj.NormalizeCoordinatesOn () - Turn on/off coordinate normalization. The positions can be
translated and scaled such that they fit within a [-1, 1] prior to the smoothing computation. The default is off.
The numerical stability of the solution can be improved by turning normalization on. If normalization is on, the
coordinates will be rescaled to the original coordinate system after smoothing has completed.
obj.NormalizeCoordinatesOff () - Turn on/off coordinate normalization. The positions can be
translated and scaled such that they fit within a [-1, 1] prior to the smoothing computation. The default is off.
The numerical stability of the solution can be improved by turning normalization on. If normalization is on, the
coordinates will be rescaled to the original coordinate system after smoothing has completed.
obj.SetFeatureEdgeSmoothing (int ) - Turn on/off smoothing along sharp interior edges.
int = obj.GetFeatureEdgeSmoothing () - Turn on/off smoothing along sharp interior edges.
obj.FeatureEdgeSmoothingOn () - Turn on/off smoothing along sharp interior edges.
obj.FeatureEdgeSmoothingOff () - Turn on/off smoothing along sharp interior edges.
obj.SetFeatureAngle (double ) - Specify the feature angle for sharp edge identification.
double = obj.GetFeatureAngleMinValue () - Specify the feature angle for sharp edge identification.
double = obj.GetFeatureAngleMaxValue () - Specify the feature angle for sharp edge identification.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1448
double = obj.GetFeatureAngle () - Specify the feature angle for sharp edge identification.
obj.SetEdgeAngle (double ) - Specify the edge angle to control smoothing along edges (either
interior or boundary).
double = obj.GetEdgeAngleMinValue () - Specify the edge angle to control smoothing along
edges (either interior or boundary).
double = obj.GetEdgeAngleMaxValue () - Specify the edge angle to control smoothing along
edges (either interior or boundary).
double = obj.GetEdgeAngle () - Specify the edge angle to control smoothing along edges (either
interior or boundary).
obj.SetBoundarySmoothing (int ) - Turn on/off the smoothing of vertices on the boundary of the
mesh.
int = obj.GetBoundarySmoothing () - Turn on/off the smoothing of vertices on the boundary of
the mesh.
obj.BoundarySmoothingOn () - Turn on/off the smoothing of vertices on the boundary of the mesh.
obj.BoundarySmoothingOff () - Turn on/off the smoothing of vertices on the boundary of the mesh.
obj.SetNonManifoldSmoothing (int ) - Smooth non-manifold vertices.
int = obj.GetNonManifoldSmoothing () - Smooth non-manifold vertices.
obj.NonManifoldSmoothingOn () - Smooth non-manifold vertices.
obj.NonManifoldSmoothingOff () - Smooth non-manifold vertices.
obj.SetGenerateErrorScalars (int ) - Turn on/off the generation of scalar distance values.
int = obj.GetGenerateErrorScalars () - Turn on/off the generation of scalar distance values.
obj.GenerateErrorScalarsOn () - Turn on/off the generation of scalar distance values.
obj.GenerateErrorScalarsOff () - Turn on/off the generation of scalar distance values.
obj.SetGenerateErrorVectors (int ) - Turn on/off the generation of error vectors.
int = obj.GetGenerateErrorVectors () - Turn on/off the generation of error vectors.
obj.GenerateErrorVectorsOn () - Turn on/off the generation of error vectors.
obj.GenerateErrorVectorsOff () - Turn on/off the generation of error vectors.
34.261
vtkYoungsMaterialInterface
34.261.1
Usage
Reconstructs material interfaces from a mesh containing mixed cells (where several materials are mixed) this implementation is based on the youngs algorithm, generalized to arbitrary cell types and works on both 2D and 3D
meshes. the main advantage of the youngs algorithm is it guarantees the material volume correctness. for 2D
meshes, the AxisSymetric flag allows to switch between a pure 2D (plannar) algorithm and an axis symetric 2D
algorithm handling volumes of revolution.
.SECTION Thanks This file is part of the generalized Youngs material interface reconstruction algorithm contributed
by
CEA/DIF - Commissariat a lEnergie Atomique, Centre DAM Ile-De-France
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.261 vtkYoungsMaterialInterface
1449
34.261.2
Methods
The class vtkYoungsMaterialInterface has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkYoungsMaterialInterface
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkYoungsMaterialInterface = obj.NewInstance ()
vtkYoungsMaterialInterface = obj.SafeDownCast (vtkObject o)
obj.SetInverseNormal (int ) - Set/Get wether the normal vector has to be flipped.
int = obj.GetInverseNormal () - Set/Get wether the normal vector has to be flipped.
obj.InverseNormalOn () - Set/Get wether the normal vector has to be flipped.
obj.InverseNormalOff () - Set/Get wether the normal vector has to be flipped.
obj.SetReverseMaterialOrder (int ) - If this flag is on, material order in reversed. Otherwise,
materials are sorted in ascending order depending on the given ordering array.
int = obj.GetReverseMaterialOrder () - If this flag is on, material order in reversed. Otherwise, materials are sorted in ascending order depending on the given ordering array.
obj.ReverseMaterialOrderOn () - If this flag is on, material order in reversed. Otherwise, materials are sorted in ascending order depending on the given ordering array.
obj.ReverseMaterialOrderOff () - If this flag is on, material order in reversed. Otherwise, materials are sorted in ascending order depending on the given ordering array.
obj.SetOnionPeel (int ) - Set/Get OnionPeel flag. if this flag is on, the normal vector of the first
material (which depends on material ordering) is used for all materials.
int = obj.GetOnionPeel () - Set/Get OnionPeel flag. if this flag is on, the normal vector of the first
material (which depends on material ordering) is used for all materials.
obj.OnionPeelOn () - Set/Get OnionPeel flag. if this flag is on, the normal vector of the first material
(which depends on material ordering) is used for all materials.
obj.OnionPeelOff () - Set/Get OnionPeel flag. if this flag is on, the normal vector of the first material
(which depends on material ordering) is used for all materials.
obj.SetAxisSymetric (int ) - Turns on/off AxisSymetric computation of 2D interfaces. in axis
symetric mode, 2D meshes are understood as volumes of revolution.
int = obj.GetAxisSymetric () - Turns on/off AxisSymetric computation of 2D interfaces. in axis
symetric mode, 2D meshes are understood as volumes of revolution.
obj.AxisSymetricOn () - Turns on/off AxisSymetric computation of 2D interfaces. in axis symetric
mode, 2D meshes are understood as volumes of revolution.
obj.AxisSymetricOff () - Turns on/off AxisSymetric computation of 2D interfaces. in axis symetric
mode, 2D meshes are understood as volumes of revolution.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1450
obj.SetUseFractionAsDistance (int ) - when UseFractionAsDistance is true, the volume fraction is interpreted as the distance of the cutting plane from the origin. in axis symetric mode, 2D meshes are
understood as volumes of revolution.
int = obj.GetUseFractionAsDistance () - when UseFractionAsDistance is true, the volume
fraction is interpreted as the distance of the cutting plane from the origin. in axis symetric mode, 2D meshes
are understood as volumes of revolution.
obj.UseFractionAsDistanceOn () - when UseFractionAsDistance is true, the volume fraction is
interpreted as the distance of the cutting plane from the origin. in axis symetric mode, 2D meshes are
understood as volumes of revolution.
obj.UseFractionAsDistanceOff () - when UseFractionAsDistance is true, the volume fraction
is interpreted as the distance of the cutting plane from the origin. in axis symetric mode, 2D meshes are
understood as volumes of revolution.
obj.SetFillMaterial (int ) - When FillMaterial is set to 1, the volume containing material is output and not only the interface surface.
int = obj.GetFillMaterial () - When FillMaterial is set to 1, the volume containing material is
output and not only the interface surface.
obj.FillMaterialOn () - When FillMaterial is set to 1, the volume containing material is output and
not only the interface surface.
obj.FillMaterialOff () - When FillMaterial is set to 1, the volume containing material is output and
not only the interface surface.
obj.SetTwoMaterialsOptimization (int ) - Triggers some additional optimizations for cells
containing only two materials. This option might produce different result than expected if the sum of volume
fractions is not 1.
int = obj.GetTwoMaterialsOptimization () - Triggers some additional optimizations for cells
containing only two materials. This option might produce different result than expected if the sum of volume
fractions is not 1.
obj.TwoMaterialsOptimizationOn () - Triggers some additional optimizations for cells containing only two materials. This option might produce different result than expected if the sum of volume fractions
is not 1.
obj.TwoMaterialsOptimizationOff () - Triggers some additional optimizations for cells containing only two materials. This option might produce different result than expected if the sum of volume fractions
is not 1.
obj.SetVolumeFractionRange (double , double ) - Set/Get minimum and maximum volume fraction value. if a material fills a volume above the minimum value, the material is considered to be void.
if a material fills a volume fraction beyond the maximum value it is considered as filling the whole volume.
obj.SetVolumeFractionRange (double a[2]) - Set/Get minimum and maximum volume fraction value. if a material fills a volume above the minimum value, the material is considered to be void. if a
material fills a volume fraction beyond the maximum value it is considered as filling the whole volume.
double = obj. GetVolumeFractionRange () - Set/Get minimum and maximum volume fraction value. if a material fills a volume above the minimum value, the material is considered to be void. if a
material fills a volume fraction beyond the maximum value it is considered as filling the whole volume.
obj.SetNumberOfMaterials (int n) - Sets/Gets the number of materials.
int = obj.GetNumberOfMaterials () - Sets/Gets the number of materials.
obj.SetMaterialArrays (int i, string volumeFraction, string interfaceNormal, string materialOrdering) - Set ith Material arrays to be used as volume fraction,
interface normal and material ordering. Each parameter name a cell array.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
34.261 vtkYoungsMaterialInterface
1451
obj.SetMaterialVolumeFractionArray (int i, string volume) - Set ith Material arrays to be used as volume fraction, interface normal and material ordering. Each parameter name a cell
array.
obj.SetMaterialNormalArray (int i, string normal) - Set ith Material arrays to be used
as volume fraction, interface normal and material ordering. Each parameter name a cell array.
obj.SetMaterialOrderingArray (int i, string ordering) - Set ith Material arrays to
be used as volume fraction, interface normal and material ordering. Each parameter name a cell array.
obj.RemoveAllMaterials () - Removes all meterials previously added.
1452
Chapter 35
1454
vtkLegendBoxActor
vtkLegendScaleActor
vtkLSDynaReader
vtkPCAAnalysisFilter
vtkPExodusIIReader
vtkPExodusReader
vtkPieChartActor
vtkPolyDataSilhouette
vtkPolyDataToImageStencil
vtkProcrustesAlignmentFilter
vtkProjectedTerrainPath
vtkRenderLargeImage
vtkRIBExporter
vtkRIBLight
vtkRIBProperty
vtkSpiderPlotActor
vtkStructuredExtent
vtkTemporalDataSetCache
vtkTemporalInterpolator
vtkTemporalShiftScale
vtkTemporalSnapToTimeStep
vtkThinPlateSplineTransform
vtkTransformToGrid
vtkVectorText
vtkVideoSource
vtkVRMLImporter
vtkWeightedTransformFilter
vtkX3DExporter
vtkXYPlotActor
35.1
vtk3DSImporter
35.2 vtkAnnotatedCubeActor
35.1.1
1455
Usage
35.1.2
Methods
The class vtk3DSImporter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtk3DSImporter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtk3DSImporter = obj.NewInstance ()
vtk3DSImporter = obj.SafeDownCast (vtkObject o)
obj.SetFileName (string ) - Specify the name of the file to read.
string = obj.GetFileName () - Specify the name of the file to read.
obj.SetComputeNormals (int ) - Set/Get the computation of normals. If on, imported geometry
will be run through vtkPolyDataNormals.
int = obj.GetComputeNormals () - Set/Get the computation of normals. If on, imported geometry
will be run through vtkPolyDataNormals.
obj.ComputeNormalsOn () - Set/Get the computation of normals. If on, imported geometry will be
run through vtkPolyDataNormals.
obj.ComputeNormalsOff () - Set/Get the computation of normals. If on, imported geometry will be
run through vtkPolyDataNormals.
35.2
vtkAnnotatedCubeActor
35.2.1
Usage
vtkAnnotatedCubeActor is a hybrid 3D actor used to represent an anatomical orientation marker in a scene. The
class consists of a 3D unit cube centered on the origin with each face labelled in correspondance to a particular
coordinate direction. For example, with Cartesian directions, the user defined text labels could be: +X, -X, +Y, -Y,
+Z, -Z, while for anatomical directions: A, P, L, R, S, I. Text is automatically centered on each cube face and is not
restriceted to single characters. In addition to or in replace of a solid text label representation, the outline edges of
the labels can be displayed. The individual properties of the cube, face labels and text outlines can be manipulated
as can their visibility.
To create an instance of class vtkAnnotatedCubeActor, simply invoke its constructor as follows
obj = vtkAnnotatedCubeActor
1456
35.2.2
Methods
The class vtkAnnotatedCubeActor has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAnnotatedCubeActor
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAnnotatedCubeActor = obj.NewInstance ()
vtkAnnotatedCubeActor = obj.SafeDownCast (vtkObject o)
obj.GetActors (vtkPropCollection ) - For some exporters and other other operations we must
be able to collect all the actors or volumes. These methods are used in that process.
int = obj.RenderOpaqueGeometry (vtkViewport viewport) - Support the standard render methods.
int = obj.RenderTranslucentPolygonalGeometry (vtkViewport viewport) - Support the standard render methods.
int = obj.HasTranslucentPolygonalGeometry () - Does this prop have some translucent
polygonal geometry?
obj.ShallowCopy (vtkProp prop) - Shallow copy of an axes actor. Overloads the virtual vtkProp
method.
obj.ReleaseGraphicsResources (vtkWindow ) - Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to
release.
obj.GetBounds (double bounds[6]) - Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
(The method GetBounds(double bounds[6]) is available from the superclass.)
double = obj.GetBounds () - Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
(The method GetBounds(double bounds[6]) is available from the superclass.)
long = obj.GetMTime () - Get the actors mtime plus consider its properties and texture if set.
obj.SetFaceTextScale (double ) - Set/Get the scale factor for the face text
double = obj.GetFaceTextScale () - Set/Get the scale factor for the face text
vtkProperty = obj.GetXPlusFaceProperty () - Get the individual face text properties.
vtkProperty = obj.GetXMinusFaceProperty () - Get the individual face text properties.
vtkProperty = obj.GetYPlusFaceProperty () - Get the individual face text properties.
vtkProperty = obj.GetYMinusFaceProperty () - Get the individual face text properties.
vtkProperty = obj.GetZPlusFaceProperty () - Get the individual face text properties.
vtkProperty = obj.GetZMinusFaceProperty () - Get the individual face text properties.
vtkProperty = obj.GetCubeProperty () - Get the cube properties.
vtkProperty = obj.GetTextEdgesProperty () - Get the text edges properties.
obj.SetXPlusFaceText (string ) - Set/get the face text.
string = obj.GetXPlusFaceText () - Set/get the face text.
obj.SetXMinusFaceText (string ) - Set/get the face text.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.3 vtkArcPlotter
1457
35.3
vtkArcPlotter
35.3.1
Usage
vtkArcPlotter performs plotting of attribute data along polylines defined with an input vtkPolyData data object. Any
type of attribute data can be plotted including scalars, vectors, tensors, normals, texture coordinates, and field data.
Either one or multiple data components can be plotted.
To use this class you must specify an input data set that contains one or more polylines, and some attribute data
including which component of the attribute data. (By default, this class processes the first component of scalar
data.) You will also need to set an offset radius (the distance of the polyline to the median line of the plot), a width
for the plot (the distance that the minimum and maximum plot values are mapped into), an possibly an offset (used
to offset attribute data with multiple components).
Normally the filter automatically computes normals for generating the offset arc plot. However, you can specify a
default normal and use that instead.
To create an instance of class vtkArcPlotter, simply invoke its constructor as follows
obj = vtkArcPlotter
1458
35.3.2
Methods
The class vtkArcPlotter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkArcPlotter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkArcPlotter = obj.NewInstance ()
vtkArcPlotter = obj.SafeDownCast (vtkObject o)
obj.SetCamera (vtkCamera ) - Specify a camera used to orient the plot along the arc. If no camera
is specified, then the orientation of the plot is arbitrary.
vtkCamera = obj.GetCamera () - Specify a camera used to orient the plot along the arc. If no
camera is specified, then the orientation of the plot is arbitrary.
obj.SetPlotMode (int ) - Specify which data to plot: scalars, vectors, normals, texture coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent to control
which component to plot.
int = obj.GetPlotMode () - Specify which data to plot: scalars, vectors, normals, texture coords,
tensors, or field data. If the data has more than one component, use the method SetPlotComponent to control
which component to plot.
obj.SetPlotModeToPlotScalars () - Specify which data to plot: scalars, vectors, normals, texture
coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent
to control which component to plot.
obj.SetPlotModeToPlotVectors () - Specify which data to plot: scalars, vectors, normals, texture
coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent
to control which component to plot.
obj.SetPlotModeToPlotNormals () - Specify which data to plot: scalars, vectors, normals, texture
coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent
to control which component to plot.
obj.SetPlotModeToPlotTCoords () - Specify which data to plot: scalars, vectors, normals, texture
coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent
to control which component to plot.
obj.SetPlotModeToPlotTensors () - Specify which data to plot: scalars, vectors, normals, texture
coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent
to control which component to plot.
obj.SetPlotModeToPlotFieldData () - Specify which data to plot: scalars, vectors, normals,
texture coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent to control which component to plot.
obj.SetPlotComponent (int ) - Set/Get the component number to plot if the data has more than
one component. If the value of the plot component is == (-1), then all the components will be plotted.
int = obj.GetPlotComponent () - Set/Get the component number to plot if the data has more
than one component. If the value of the plot component is == (-1), then all the components will be plotted.
obj.SetRadius (double ) - Set the radius of the "median" value of the first plotted component.
double = obj.GetRadiusMinValue () - Set the radius of the "median" value of the first plotted
component.
double = obj.GetRadiusMaxValue () - Set the radius of the "median" value of the first plotted
component.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.4 vtkAxesActor
1459
double = obj.GetRadius () - Set the radius of the "median" value of the first plotted component.
obj.SetHeight (double ) - Set the height of the plot. (The radius combined with the height define
the location of the plot relative to the generating polyline.)
double = obj.GetHeightMinValue () - Set the height of the plot. (The radius combined with the
height define the location of the plot relative to the generating polyline.)
double = obj.GetHeightMaxValue () - Set the height of the plot. (The radius combined with the
height define the location of the plot relative to the generating polyline.)
double = obj.GetHeight () - Set the height of the plot. (The radius combined with the height define
the location of the plot relative to the generating polyline.)
obj.SetOffset (double ) - Specify an offset that translates each subsequent plot (if there is more
than one component plotted) from the defining arc (i.e., polyline).
double = obj.GetOffsetMinValue () - Specify an offset that translates each subsequent plot (if
there is more than one component plotted) from the defining arc (i.e., polyline).
double = obj.GetOffsetMaxValue () - Specify an offset that translates each subsequent plot (if
there is more than one component plotted) from the defining arc (i.e., polyline).
double = obj.GetOffset () - Specify an offset that translates each subsequent plot (if there is more
than one component plotted) from the defining arc (i.e., polyline).
obj.SetUseDefaultNormal (int ) - Set a boolean to control whether to use default normals. By
default, normals are automatically computed from the generating polyline and camera.
int = obj.GetUseDefaultNormal () - Set a boolean to control whether to use default normals.
By default, normals are automatically computed from the generating polyline and camera.
obj.UseDefaultNormalOn () - Set a boolean to control whether to use default normals. By default,
normals are automatically computed from the generating polyline and camera.
obj.UseDefaultNormalOff () - Set a boolean to control whether to use default normals. By default,
normals are automatically computed from the generating polyline and camera.
obj.SetDefaultNormal (float , float , float ) - Set the default normal to use if you do
not wish automatic normal calculation. The arc plot will be generated using this normal.
obj.SetDefaultNormal (float a[3]) - Set the default normal to use if you do not wish automatic
normal calculation. The arc plot will be generated using this normal.
float = obj. GetDefaultNormal () - Set the default normal to use if you do not wish automatic
normal calculation. The arc plot will be generated using this normal.
obj.SetFieldDataArray (int ) - Set/Get the field data array to plot. This instance variable is only
applicable if field data is plotted.
int = obj.GetFieldDataArrayMinValue () - Set/Get the field data array to plot. This instance
variable is only applicable if field data is plotted.
int = obj.GetFieldDataArrayMaxValue () - Set/Get the field data array to plot. This instance
variable is only applicable if field data is plotted.
int = obj.GetFieldDataArray () - Set/Get the field data array to plot. This instance variable is
only applicable if field data is plotted.
long = obj.GetMTime () - New GetMTime because of camera dependency.
35.4
vtkAxesActor
1460
35.4.1
Usage
vtkAxesActor is a hybrid 2D/3D actor used to represent 3D axes in a scene. The user can define the geometry to
use for the shaft or the tip, and the user can set the text for the three axes. The text will appear to follow the camera
since it is implemented by means of vtkCaptionActor2D. All of the functionality of the underlying vtkCaptionActor2D
objects are accessable so that, for instance, the font attributes of the axes text can be manipulated through vtkTextProperty. Since this class inherits from vtkProp3D, one can apply a user transform to the underlying geometry
and the positioning of the labels. For example, a rotation transform could be used to generate a left-handed axes
representation.
To create an instance of class vtkAxesActor, simply invoke its constructor as follows
obj = vtkAxesActor
35.4.2
Methods
The class vtkAxesActor has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkAxesActor class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAxesActor = obj.NewInstance ()
vtkAxesActor = obj.SafeDownCast (vtkObject o)
obj.GetActors (vtkPropCollection ) - For some exporters and other other operations we must
be able to collect all the actors or volumes. These methods are used in that process.
int = obj.RenderOpaqueGeometry (vtkViewport viewport) - Support the standard render methods.
int = obj.RenderTranslucentPolygonalGeometry (vtkViewport viewport) - Support the standard render methods.
int = obj.RenderOverlay (vtkViewport viewport) - Support the standard render methods.
int = obj.HasTranslucentPolygonalGeometry () - Does this prop have some translucent
polygonal geometry?
obj.ShallowCopy (vtkProp prop) - Shallow copy of an axes actor. Overloads the virtual vtkProp
method.
obj.ReleaseGraphicsResources (vtkWindow ) - Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to
release.
obj.GetBounds (double bounds[6]) - Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
(The method GetBounds(double bounds[6]) is available from the superclass.)
double = obj.GetBounds () - Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
(The method GetBounds(double bounds[6]) is available from the superclass.)
long = obj.GetMTime () - Get the actors mtime plus consider its properties and texture if set.
long = obj.GetRedrawMTime () - Return the mtime of anything that would cause the rendered
image to appear differently. Usually this involves checking the mtime of the prop plus anything else it depends
on such as properties, textures etc.
obj.SetTotalLength (double v[3]) - Set the total length of the axes in 3 dimensions.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.4 vtkAxesActor
1461
obj.SetTotalLength (double x, double y, double z) - Set the total length of the axes in
3 dimensions.
double = obj.
obj.SetNormalizedShaftLength (double v[3]) - Set the normalized (0-1) length of the shaft.
obj.SetNormalizedShaftLength (double x, double y, double z) - Set the normalized (0-1) length of the shaft.
double = obj.
obj.SetNormalizedTipLength (double v[3]) - Set the normalized (0-1) length of the tip. Normally, this would be 1 - the normalized length of the shaft.
obj.SetNormalizedTipLength (double x, double y, double z) - Set the normalized
(0-1) length of the tip. Normally, this would be 1 - the normalized length of the shaft.
double = obj. GetNormalizedTipLength () - Set the normalized (0-1) length of the tip. Normally, this would be 1 - the normalized length of the shaft.
obj.SetNormalizedLabelPosition (double v[3]) - Set the normalized (0-1) position of the
label along the length of the shaft. A value > 1 is permissible.
obj.SetNormalizedLabelPosition (double x, double y, double z) - Set the normalized (0-1) position of the label along the length of the shaft. A value > 1 is permissible.
double = obj. GetNormalizedLabelPosition () - Set the normalized (0-1) position of the
label along the length of the shaft. A value > 1 is permissible.
obj.SetConeResolution (int ) - Set/get the resolution of the pieces of the axes actor.
int = obj.GetConeResolutionMinValue () - Set/get the resolution of the pieces of the axes
actor.
int = obj.GetConeResolutionMaxValue () - Set/get the resolution of the pieces of the axes
actor.
int = obj.GetConeResolution () - Set/get the resolution of the pieces of the axes actor.
obj.SetSphereResolution (int ) - Set/get the resolution of the pieces of the axes actor.
int = obj.GetSphereResolutionMinValue () - Set/get the resolution of the pieces of the axes
actor.
int = obj.GetSphereResolutionMaxValue () - Set/get the resolution of the pieces of the axes
actor.
int = obj.GetSphereResolution () - Set/get the resolution of the pieces of the axes actor.
obj.SetCylinderResolution (int ) - Set/get the resolution of the pieces of the axes actor.
int = obj.GetCylinderResolutionMinValue () - Set/get the resolution of the pieces of the
axes actor.
int = obj.GetCylinderResolutionMaxValue () - Set/get the resolution of the pieces of the
axes actor.
int = obj.GetCylinderResolution () - Set/get the resolution of the pieces of the axes actor.
obj.SetConeRadius (double ) - Set/get the radius of the pieces of the axes actor.
double = obj.GetConeRadiusMinValue () - Set/get the radius of the pieces of the axes actor.
double = obj.GetConeRadiusMaxValue () - Set/get the radius of the pieces of the axes actor.
double = obj.GetConeRadius () - Set/get the radius of the pieces of the axes actor.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1462
obj.SetSphereRadius (double ) - Set/get the radius of the pieces of the axes actor.
double = obj.GetSphereRadiusMinValue () - Set/get the radius of the pieces of the axes actor.
double = obj.GetSphereRadiusMaxValue () - Set/get the radius of the pieces of the axes actor.
double = obj.GetSphereRadius () - Set/get the radius of the pieces of the axes actor.
obj.SetCylinderRadius (double ) - Set/get the radius of the pieces of the axes actor.
double = obj.GetCylinderRadiusMinValue () - Set/get the radius of the pieces of the axes
actor.
double = obj.GetCylinderRadiusMaxValue () - Set/get the radius of the pieces of the axes
actor.
double = obj.GetCylinderRadius () - Set/get the radius of the pieces of the axes actor.
obj.SetShaftType (int type) - Set the type of the shaft to a cylinder, line, or user defined geometry.
obj.SetShaftTypeToCylinder () - Set the type of the shaft to a cylinder, line, or user defined
geometry.
obj.SetShaftTypeToLine () - Set the type of the shaft to a cylinder, line, or user defined geometry.
obj.SetShaftTypeToUserDefined () - Set the type of the shaft to a cylinder, line, or user defined
geometry.
int = obj.GetShaftType () - Set the type of the shaft to a cylinder, line, or user defined geometry.
obj.SetTipType (int type) - Set the type of the tip to a cone, sphere, or user defined geometry.
obj.SetTipTypeToCone () - Set the type of the tip to a cone, sphere, or user defined geometry.
obj.SetTipTypeToSphere () - Set the type of the tip to a cone, sphere, or user defined geometry.
obj.SetTipTypeToUserDefined () - Set the type of the tip to a cone, sphere, or user defined
geometry.
int = obj.GetTipType () - Set the type of the tip to a cone, sphere, or user defined geometry.
obj.SetUserDefinedTip (vtkPolyData ) - Set the user defined tip polydata.
vtkPolyData = obj.GetUserDefinedTip () - Set the user defined tip polydata.
obj.SetUserDefinedShaft (vtkPolyData ) - Set the user defined shaft polydata.
vtkPolyData = obj.GetUserDefinedShaft () - Set the user defined shaft polydata.
vtkProperty = obj.GetXAxisTipProperty () - Get the tip properties.
vtkProperty = obj.GetYAxisTipProperty () - Get the tip properties.
vtkProperty = obj.GetZAxisTipProperty () - Get the tip properties.
vtkProperty = obj.GetXAxisShaftProperty () - Get the shaft properties.
vtkProperty = obj.GetYAxisShaftProperty () - Get the shaft properties.
vtkProperty = obj.GetZAxisShaftProperty () - Get the shaft properties.
vtkCaptionActor2D = obj.GetXAxisCaptionActor2D () - Retrieve handles to the X, Y and
Z axis (so that you can set their text properties for example)
vtkCaptionActor2D = obj.GetYAxisCaptionActor2D () - Retrieve handles to the X, Y and
Z axis (so that you can set their text properties for example)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.5 vtkAxisActor
1463
35.5
vtkAxisActor
35.5.1
Usage
vtkAxisActor creates an axis with tick marks, labels, and/or a title, depending on the particular instance variable
settings. It is assumed that the axes is part of a bounding box and is orthoganal to one of the coordinate axes.
To use this class, you typically specify two points defining the start and end points of the line (xyz definition using
vtkCoordinate class), the axis type (X, Y or Z), the axis location in relation to the bounding box, the bounding box,
the number of labels, and the data range (min,max). You can also control what parts of the axis are visible including
the line, the tick marks, the labels, and the title. It is also possible to control gridlines, and specifiy on which side
the tickmarks are drawn (again with respect to the underlying assumed bounding box). You can also specify the
label format (a printf style format).
This class decides how to locate the labels, and how to create reasonable tick marks and labels.
Labels follow the camera so as to be legible from any viewpoint.
The instance variables Point1 and Point2 are instances of vtkCoordinate. All calculations and references are in
World Coordinates.
.SECTION Notes This class was adapted from a 2D version created by Hank Childs called vtkHankAxisActor2D.
To create an instance of class vtkAxisActor, simply invoke its constructor as follows
obj = vtkAxisActor
35.5.2
Methods
The class vtkAxisActor has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkAxisActor class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAxisActor = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1464
35.5 vtkAxisActor
obj.SetTickLocationToOutside (void )
obj.SetTickLocationToBoth (void )
obj.SetAxisVisibility (int ) - Set/Get visibility of the axis line.
int = obj.GetAxisVisibility () - Set/Get visibility of the axis line.
obj.AxisVisibilityOn () - Set/Get visibility of the axis line.
obj.AxisVisibilityOff () - Set/Get visibility of the axis line.
obj.SetTickVisibility (int ) - Set/Get visibility of the axis tick marks.
int = obj.GetTickVisibility () - Set/Get visibility of the axis tick marks.
obj.TickVisibilityOn () - Set/Get visibility of the axis tick marks.
obj.TickVisibilityOff () - Set/Get visibility of the axis tick marks.
obj.SetLabelVisibility (int ) - Set/Get visibility of the axis labels.
int = obj.GetLabelVisibility () - Set/Get visibility of the axis labels.
obj.LabelVisibilityOn () - Set/Get visibility of the axis labels.
obj.LabelVisibilityOff () - Set/Get visibility of the axis labels.
obj.SetTitleVisibility (int ) - Set/Get visibility of the axis title.
int = obj.GetTitleVisibility () - Set/Get visibility of the axis title.
obj.TitleVisibilityOn () - Set/Get visibility of the axis title.
obj.TitleVisibilityOff () - Set/Get visibility of the axis title.
obj.SetDrawGridlines (int ) - Set/Get whether gridlines should be drawn.
int = obj.GetDrawGridlines () - Set/Get whether gridlines should be drawn.
obj.DrawGridlinesOn () - Set/Get whether gridlines should be drawn.
obj.DrawGridlinesOff () - Set/Get whether gridlines should be drawn.
obj.SetGridlineXLength (double ) - Set/Get the length to use when drawing gridlines.
double = obj.GetGridlineXLength () - Set/Get the length to use when drawing gridlines.
obj.SetGridlineYLength (double ) - Set/Get the length to use when drawing gridlines.
double = obj.GetGridlineYLength () - Set/Get the length to use when drawing gridlines.
obj.SetGridlineZLength (double ) - Set/Get the length to use when drawing gridlines.
double = obj.GetGridlineZLength () - Set/Get the length to use when drawing gridlines.
obj.SetAxisType (int ) - Set/Get the type of this axis.
int = obj.GetAxisTypeMinValue () - Set/Get the type of this axis.
int = obj.GetAxisTypeMaxValue () - Set/Get the type of this axis.
int = obj.GetAxisType () - Set/Get the type of this axis.
obj.SetAxisTypeToX (void ) - Set/Get the type of this axis.
obj.SetAxisTypeToY (void ) - Set/Get the type of this axis.
obj.SetAxisTypeToZ (void ) - Set/Get the type of this axis.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1465
1466
obj.SetAxisPosition (int ) - Set/Get the position of this axis (in relation to an an assumed bounding box). For an x-type axis, MINMIN corresponds to the x-edge in the bounding box where Y values are
minimum and Z values are minimum. For a y-type axis, MAXMIN corresponds to the y-edge where X values
are maximum and Z values are minimum.
int = obj.GetAxisPositionMinValue () - Set/Get the position of this axis (in relation to an an
assumed bounding box). For an x-type axis, MINMIN corresponds to the x-edge in the bounding box where
Y values are minimum and Z values are minimum. For a y-type axis, MAXMIN corresponds to the y-edge
where X values are maximum and Z values are minimum.
int = obj.GetAxisPositionMaxValue () - Set/Get the position of this axis (in relation to an an
assumed bounding box). For an x-type axis, MINMIN corresponds to the x-edge in the bounding box where
Y values are minimum and Z values are minimum. For a y-type axis, MAXMIN corresponds to the y-edge
where X values are maximum and Z values are minimum.
int = obj.GetAxisPosition () - Set/Get the position of this axis (in relation to an an assumed
bounding box). For an x-type axis, MINMIN corresponds to the x-edge in the bounding box where Y values
are minimum and Z values are minimum. For a y-type axis, MAXMIN corresponds to the y-edge where X
values are maximum and Z values are minimum.
obj.SetAxisPositionToMinMin (void )
obj.SetAxisPositionToMinMax (void )
obj.SetAxisPositionToMaxMax (void )
obj.SetAxisPositionToMaxMin (void )
obj.SetCamera (vtkCamera ) - Set/Get the camera for this axis. The camera is used by the labels
to follow the camera and be legible from any viewpoint.
vtkCamera = obj.GetCamera () - Set/Get the camera for this axis. The camera is used by the
labels to follow the camera and be legible from any viewpoint.
int = obj.RenderOpaqueGeometry (vtkViewport viewport) - Draw the axis.
int = obj.RenderTranslucentGeometry (vtkViewport ) - Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine
which graphic resources to release.
obj.ReleaseGraphicsResources (vtkWindow ) - Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to
release.
obj.ShallowCopy (vtkProp prop) - Shallow copy of an axis actor. Overloads the virtual vtkProp
method.
obj.SetLabelScale (double )
obj.SetTitleScale (double )
obj.SetMinorStart (double ) - Set/Get the starting position for minor and major tick points, and
the delta values that determine their spacing.
double = obj.GetMinorStart () - Set/Get the starting position for minor and major tick points,
and the delta values that determine their spacing.
obj.SetMajorStart (double ) - Set/Get the starting position for minor and major tick points, and
the delta values that determine their spacing.
double = obj.GetMajorStart () - Set/Get the starting position for minor and major tick points,
and the delta values that determine their spacing.
obj.SetDeltaMinor (double ) - Set/Get the starting position for minor and major tick points, and
the delta values that determine their spacing.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.6 vtkBarChartActor
1467
double = obj.GetDeltaMinor () - Set/Get the starting position for minor and major tick points,
and the delta values that determine their spacing.
obj.SetDeltaMajor (double ) - Set/Get the starting position for minor and major tick points, and
the delta values that determine their spacing.
double = obj.GetDeltaMajor () - Set/Get the starting position for minor and major tick points,
and the delta values that determine their spacing.
obj.BuildAxis (vtkViewport viewport, bool )
35.6
vtkBarChartActor
35.6.1
Usage
vtkBarChartActor generates a bar chart from an array of numbers defined in field data (a vtkDataObject). To use
this class, you must specify an input data object. Youll probably also want to specify the position of the plot be
setting the Position and Position2 instance variables, which define a rectangle in which the plot lies. There are also
many other instance variables that control the look of the plot includes its title and legend.
Set the text property/attributes of the title and the labels through the vtkTextProperty objects associated with these
components.
To create an instance of class vtkBarChartActor, simply invoke its constructor as follows
obj = vtkBarChartActor
35.6.2
Methods
The class vtkBarChartActor has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkBarChartActor class.
string = obj.GetClassName () - Standard methods for type information and printing.
int = obj.IsA (string name) - Standard methods for type information and printing.
vtkBarChartActor = obj.NewInstance () - Standard methods for type information and printing.
vtkBarChartActor = obj.SafeDownCast (vtkObject o) - Standard methods for type information and printing.
obj.SetInput (vtkDataObject ) - Set the input to the bar chart actor.
vtkDataObject = obj.GetInput () - Get the input data object to this actor.
obj.SetTitleVisibility (int ) - Enable/Disable the display of a plot title.
int = obj.GetTitleVisibility () - Enable/Disable the display of a plot title.
obj.TitleVisibilityOn () - Enable/Disable the display of a plot title.
obj.TitleVisibilityOff () - Enable/Disable the display of a plot title.
obj.SetTitle (string ) - Set/Get the title of the bar chart.
string = obj.GetTitle () - Set/Get the title of the bar chart.
obj.SetTitleTextProperty (vtkTextProperty p) - Set/Get the title text property. The property controls the appearance of the plot title.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1468
35.7
vtkCaptionActor2D
35.7 vtkCaptionActor2D
35.7.1
1469
Usage
vtkCaptionActor2D is a hybrid 2D/3D actor that is used to associate text with a point (the AttachmentPoint) in the
scene. The caption can be drawn with a rectangular border and a leader connecting the caption to the attachment
point. Optionally, the leader can be glyphed at its endpoint to create arrow heads or other indicators.
To use the caption actor, you normally specify the Position and Position2 coordinates (these are inherited from the
vtkActor2D superclass). (Note that Position2 can be set using vtkActor2Ds SetWidth() and SetHeight() methods.)
Position and Position2 define the size of the caption, and a third point, the AttachmentPoint, defines a point that the
caption is associated with. You must also define the caption text, whether you want a border around the caption,
and whether you want a leader from the caption to the attachment point. The font attributes of the text can be set
through the vtkTextProperty associated to this actor. You also indicate whether you want the leader to be 2D or 3D.
(2D leaders are always drawn over the underlying geometry. 3D leaders may be occluded by the geometry.) The
leader may also be terminated by an optional glyph (e.g., arrow).
The trickiest part about using this class is setting Position, Position2, and AttachmentPoint correctly. These instance
variables are vtkCoordinates, and can be set up in various ways. In default usage, the AttachmentPoint is defined in
the world coordinate system, Position is the lower-left corner of the caption and relative to AttachmentPoint (defined
in display coordaintes, i.e., pixels), and Position2 is relative to Position and is the upper-right corner (also in display
coordinates). However, the user has full control over the coordinates, and can do things like place the caption in a
fixed position in the renderer, with the leader moving with the AttachmentPoint.
To create an instance of class vtkCaptionActor2D, simply invoke its constructor as follows
obj = vtkCaptionActor2D
35.7.2
Methods
The class vtkCaptionActor2D has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkCaptionActor2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCaptionActor2D = obj.NewInstance ()
vtkCaptionActor2D = obj.SafeDownCast (vtkObject o)
obj.SetCaption (string ) - Define the text to be placed in the caption. The text can be multiple
lines (separated by "\n").
string = obj.GetCaption () - Define the text to be placed in the caption. The text can be multiple
lines (separated by "\n").
vtkCoordinate = obj.GetAttachmentPointCoordinate () - Set/Get the attachment point
for the caption. By default, the attachment point is defined in world coordinates, but this can be changed
using vtkCoordinate methods.
obj.SetAttachmentPoint (double, double, double) - Set/Get the attachment point for the
caption. By default, the attachment point is defined in world coordinates, but this can be changed using
vtkCoordinate methods.
obj.SetAttachmentPoint (double a[3]) - Set/Get the attachment point for the caption. By
default, the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate
methods.
double = obj.GetAttachmentPoint () - Set/Get the attachment point for the caption. By default,
the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate methods.
obj.SetBorder (int ) - Enable/disable the placement of a border around the text.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1470
35.8 vtkCornerAnnotation
1471
int = obj.GetMaximumLeaderGlyphSize () - Specify the maximum size of the leader head (if
any) in pixels. This is used in conjunction with LeaderGlyphSize to cap the maximum size of the LeaderGlyph.
obj.SetPadding (int ) - Set/Get the padding between the caption and the border. The value is
specified in pixels.
int = obj.GetPaddingMinValue () - Set/Get the padding between the caption and the border.
The value is specified in pixels.
int = obj.GetPaddingMaxValue () - Set/Get the padding between the caption and the border.
The value is specified in pixels.
int = obj.GetPadding () - Set/Get the padding between the caption and the border. The value is
specified in pixels.
vtkTextActor = obj.GetTextActor () - Get the text actor used by the caption. This is useful if
you want to control justification and other characteristics of the text actor.
obj.SetCaptionTextProperty (vtkTextProperty p) - Set/Get the text property.
vtkTextProperty = obj.GetCaptionTextProperty () - Set/Get the text property.
obj.ShallowCopy (vtkProp prop) - Shallow copy of this scaled text actor. Overloads the virtual
vtkProp method.
obj.SetAttachEdgeOnly (int ) - Enable/disable whether to attach the arrow only to the edge, NOT
the vertices of the caption border.
int = obj.GetAttachEdgeOnly () - Enable/disable whether to attach the arrow only to the edge,
NOT the vertices of the caption border.
obj.AttachEdgeOnlyOn () - Enable/disable whether to attach the arrow only to the edge, NOT the
vertices of the caption border.
obj.AttachEdgeOnlyOff () - Enable/disable whether to attach the arrow only to the edge, NOT the
vertices of the caption border.
35.8
vtkCornerAnnotation
35.8.1
Usage
This is an annotation object that manages four text actors / mappers to provide annotation in the four corners of a
viewport
To create an instance of class vtkCornerAnnotation, simply invoke its constructor as follows
obj = vtkCornerAnnotation
35.8.2
Methods
The class vtkCornerAnnotation has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkCornerAnnotation class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCornerAnnotation = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1472
35.9 vtkCubeAxesActor
1473
35.9
vtkCubeAxesActor
35.9.1
Usage
vtkCubeAxesActor is a composite actor that draws axes of the bounding box of an input dataset. The axes include
labels and titles for the x-y-z axes. The algorithm selects which axes to draw based on the user-defined fly mode.
(STATIC is default). STATIC constructs axes from all edges of the bounding box. CLOSEST_TRIAD consists
of the three axes x-y-z forming a triad that lies closest to the specified camera. FURTHEST_TRIAD consists of
the three axes x-y-z forming a triad that lies furthest from the specified camera. OUTER_EDGES is constructed
from edges that are on the "exterior" of the bounding box, exterior as determined from examining outer edges of the
bounding box in projection (display) space.
To use this object you must define a bounding box and the camera used to render the vtkCubeAxesActor. You can
optionally turn on/off labels, ticks, gridlines, and set tick location, number of labels, and text to use for axis-titles. A
corner offset can also be set. This allows the axes to be set partially away from the actual bounding box to perhaps
prevent overlap of labels between the various axes.
The Bounds instance variable (an array of six doubles) is used to determine the bounding box.
To create an instance of class vtkCubeAxesActor, simply invoke its constructor as follows
obj = vtkCubeAxesActor
1474
35.9.2
Methods
The class vtkCubeAxesActor has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkCubeAxesActor class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCubeAxesActor = obj.NewInstance ()
vtkCubeAxesActor = obj.SafeDownCast (vtkObject o)
int = obj.RenderOpaqueGeometry (vtkViewport ) - Draw the axes as per the vtkProp superclass API.
int = obj.RenderTranslucentGeometry (vtkViewport ) - Explicitly specify the region in
space around which to draw the bounds. The bounds is used only when no Input or Prop is specified. The
bounds are specified according to (xmin,xmax, ymin,ymax, zmin,zmax), making sure that the mins are less
than the maxs.
obj.SetBounds (double , double , double , double , double , double ) - Explicitly specify the region in space around which to draw the bounds. The bounds is used only when no Input
or Prop is specified. The bounds are specified according to (xmin,xmax, ymin,ymax, zmin,zmax), making
sure that the mins are less than the maxs.
obj.SetBounds (double a[6]) - Explicitly specify the region in space around which to draw the
bounds. The bounds is used only when no Input or Prop is specified. The bounds are specified according to
(xmin,xmax, ymin,ymax, zmin,zmax), making sure that the mins are less than the maxs.
double = obj.GetBounds () - Explicitly specify the region in space around which to draw the
bounds. The bounds is used only when no Input or Prop is specified. The bounds are specified according to (xmin,xmax, ymin,ymax, zmin,zmax), making sure that the mins are less than the maxs.
obj.GetBounds (double bounds[6]) - Explicitly specify the region in space around which to draw
the bounds. The bounds is used only when no Input or Prop is specified. The bounds are specified according
to (xmin,xmax, ymin,ymax, zmin,zmax), making sure that the mins are less than the maxs.
obj.SetCamera (vtkCamera ) - Set/Get the camera to perform scaling and translation of the vtkCubeAxesActor.
vtkCamera = obj.GetCamera () - Set/Get the camera to perform scaling and translation of the vtkCubeAxesActor.
obj.SetFlyMode (int ) - Specify a mode to control how the axes are drawn: either static, closest
triad, furthest triad or outer edges in relation to the camera position.
int = obj.GetFlyModeMinValue () - Specify a mode to control how the axes are drawn: either
static, closest triad, furthest triad or outer edges in relation to the camera position.
int = obj.GetFlyModeMaxValue () - Specify a mode to control how the axes are drawn: either
static, closest triad, furthest triad or outer edges in relation to the camera position.
int = obj.GetFlyMode () - Specify a mode to control how the axes are drawn: either static, closest
triad, furthest triad or outer edges in relation to the camera position.
obj.SetFlyModeToOuterEdges () - Specify a mode to control how the axes are drawn: either static,
closest triad, furthest triad or outer edges in relation to the camera position.
obj.SetFlyModeToClosestTriad () - Specify a mode to control how the axes are drawn: either
static, closest triad, furthest triad or outer edges in relation to the camera position.
obj.SetFlyModeToFurthestTriad () - Specify a mode to control how the axes are drawn: either
static, closest triad, furthest triad or outer edges in relation to the camera position.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.9 vtkCubeAxesActor
1475
obj.SetFlyModeToStaticTriad () - Specify a mode to control how the axes are drawn: either
static, closest triad, furthest triad or outer edges in relation to the camera position.
obj.SetFlyModeToStaticEdges () - Specify a mode to control how the axes are drawn: either
static, closest triad, furthest triad or outer edges in relation to the camera position.
obj.SetXTitle (string ) - Set/Get the labels for the x, y, and z axes. By default, use "X-Axis",
"Y-Axis" and "Z-Axis".
string = obj.GetXTitle () - Set/Get the labels for the x, y, and z axes. By default, use "X-Axis",
"Y-Axis" and "Z-Axis".
obj.SetXUnits (string ) - Set/Get the labels for the x, y, and z axes. By default, use "X-Axis",
"Y-Axis" and "Z-Axis".
string = obj.GetXUnits () - Set/Get the labels for the x, y, and z axes. By default, use "X-Axis",
"Y-Axis" and "Z-Axis".
obj.SetYTitle (string ) - Set/Get the labels for the x, y, and z axes. By default, use "X-Axis",
"Y-Axis" and "Z-Axis".
string = obj.GetYTitle () - Set/Get the labels for the x, y, and z axes. By default, use "X-Axis",
"Y-Axis" and "Z-Axis".
obj.SetYUnits (string ) - Set/Get the labels for the x, y, and z axes. By default, use "X-Axis",
"Y-Axis" and "Z-Axis".
string = obj.GetYUnits () - Set/Get the labels for the x, y, and z axes. By default, use "X-Axis",
"Y-Axis" and "Z-Axis".
obj.SetZTitle (string ) - Set/Get the labels for the x, y, and z axes. By default, use "X-Axis",
"Y-Axis" and "Z-Axis".
string = obj.GetZTitle () - Set/Get the labels for the x, y, and z axes. By default, use "X-Axis",
"Y-Axis" and "Z-Axis".
obj.SetZUnits (string ) - Set/Get the labels for the x, y, and z axes. By default, use "X-Axis",
"Y-Axis" and "Z-Axis".
string = obj.GetZUnits () - Set/Get the labels for the x, y, and z axes. By default, use "X-Axis",
"Y-Axis" and "Z-Axis".
obj.SetXLabelFormat (string ) - Set/Get the format with which to print the labels on each of the
x-y-z axes.
string = obj.GetXLabelFormat () - Set/Get the format with which to print the labels on each of
the x-y-z axes.
obj.SetYLabelFormat (string ) - Set/Get the format with which to print the labels on each of the
x-y-z axes.
string = obj.GetYLabelFormat () - Set/Get the format with which to print the labels on each of
the x-y-z axes.
obj.SetZLabelFormat (string ) - Set/Get the format with which to print the labels on each of the
x-y-z axes.
string = obj.GetZLabelFormat () - Set/Get the format with which to print the labels on each of
the x-y-z axes.
obj.SetInertia (int ) - Set/Get the inertial factor that controls how often (i.e, how many renders)
the axes can switch position (jump from one axes to another).
int = obj.GetInertiaMinValue () - Set/Get the inertial factor that controls how often (i.e, how
many renders) the axes can switch position (jump from one axes to another).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1476
int = obj.GetInertiaMaxValue () - Set/Get the inertial factor that controls how often (i.e, how
many renders) the axes can switch position (jump from one axes to another).
int = obj.GetInertia () - Set/Get the inertial factor that controls how often (i.e, how many renders)
the axes can switch position (jump from one axes to another).
obj.SetCornerOffset (double ) - Specify an offset value to "pull back" the axes from the corner
at which they are joined to avoid overlap of axes labels. The "CornerOffset" is the fraction of the axis length
to pull back.
double = obj.GetCornerOffset () - Specify an offset value to "pull back" the axes from the corner at which they are joined to avoid overlap of axes labels. The "CornerOffset" is the fraction of the axis
length to pull back.
obj.ReleaseGraphicsResources (vtkWindow ) - Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to
release.
obj.SetXAxisVisibility (int ) - Turn on and off the visibility of each axis.
int = obj.GetXAxisVisibility () - Turn on and off the visibility of each axis.
obj.XAxisVisibilityOn () - Turn on and off the visibility of each axis.
obj.XAxisVisibilityOff () - Turn on and off the visibility of each axis.
obj.SetYAxisVisibility (int ) - Turn on and off the visibility of each axis.
int = obj.GetYAxisVisibility () - Turn on and off the visibility of each axis.
obj.YAxisVisibilityOn () - Turn on and off the visibility of each axis.
obj.YAxisVisibilityOff () - Turn on and off the visibility of each axis.
obj.SetZAxisVisibility (int ) - Turn on and off the visibility of each axis.
int = obj.GetZAxisVisibility () - Turn on and off the visibility of each axis.
obj.ZAxisVisibilityOn () - Turn on and off the visibility of each axis.
obj.ZAxisVisibilityOff () - Turn on and off the visibility of each axis.
obj.SetXAxisLabelVisibility (int ) - Turn on and off the visibility of labels for each axis.
int = obj.GetXAxisLabelVisibility () - Turn on and off the visibility of labels for each axis.
obj.XAxisLabelVisibilityOn () - Turn on and off the visibility of labels for each axis.
obj.XAxisLabelVisibilityOff () - Turn on and off the visibility of labels for each axis.
obj.SetYAxisLabelVisibility (int )
int = obj.GetYAxisLabelVisibility ()
obj.YAxisLabelVisibilityOn ()
obj.YAxisLabelVisibilityOff ()
obj.SetZAxisLabelVisibility (int )
int = obj.GetZAxisLabelVisibility ()
obj.ZAxisLabelVisibilityOn ()
obj.ZAxisLabelVisibilityOff ()
obj.SetXAxisTickVisibility (int ) - Turn on and off the visibility of ticks for each axis.
int = obj.GetXAxisTickVisibility () - Turn on and off the visibility of ticks for each axis.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.9 vtkCubeAxesActor
1477
obj.XAxisTickVisibilityOn () - Turn on and off the visibility of ticks for each axis.
obj.XAxisTickVisibilityOff () - Turn on and off the visibility of ticks for each axis.
obj.SetYAxisTickVisibility (int )
int = obj.GetYAxisTickVisibility ()
obj.YAxisTickVisibilityOn ()
obj.YAxisTickVisibilityOff ()
obj.SetZAxisTickVisibility (int )
int = obj.GetZAxisTickVisibility ()
obj.ZAxisTickVisibilityOn ()
obj.ZAxisTickVisibilityOff ()
obj.SetXAxisMinorTickVisibility (int ) - Turn on and off the visibility of minor ticks for each
axis.
int = obj.GetXAxisMinorTickVisibility () - Turn on and off the visibility of minor ticks for
each axis.
obj.XAxisMinorTickVisibilityOn () - Turn on and off the visibility of minor ticks for each axis.
obj.XAxisMinorTickVisibilityOff () - Turn on and off the visibility of minor ticks for each axis.
obj.SetYAxisMinorTickVisibility (int )
int = obj.GetYAxisMinorTickVisibility ()
obj.YAxisMinorTickVisibilityOn ()
obj.YAxisMinorTickVisibilityOff ()
obj.SetZAxisMinorTickVisibility (int )
int = obj.GetZAxisMinorTickVisibility ()
obj.ZAxisMinorTickVisibilityOn ()
obj.ZAxisMinorTickVisibilityOff ()
obj.SetDrawXGridlines (int )
int = obj.GetDrawXGridlines ()
obj.DrawXGridlinesOn ()
obj.DrawXGridlinesOff ()
obj.SetDrawYGridlines (int )
int = obj.GetDrawYGridlines ()
obj.DrawYGridlinesOn ()
obj.DrawYGridlinesOff ()
obj.SetDrawZGridlines (int )
int = obj.GetDrawZGridlines ()
obj.DrawZGridlinesOn ()
obj.DrawZGridlinesOff ()
obj.SetTickLocation (int ) - Set/Get the location of ticks marks.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1478
35.10
vtkCubeAxesActor2D
35.10.1
Usage
vtkCubeAxesActor2D is a composite actor that draws three axes of the bounding box of an input dataset. The
axes include labels and titles for the x-y-z axes. The algorithm selects the axes that are on the "exterior" of the
bounding box, exterior as determined from examining outer edges of the bounding box in projection (display) space.
Alternatively, the edges closest to the viewer (i.e., camera position) can be drawn.
To use this object you must define a bounding box and the camera used to render the vtkCubeAxesActor2D. The
camera is used to control the scaling and position of the vtkCubeAxesActor2D so that it fits in the viewport and
always remains visible.)
The font property of the axes titles and labels can be modified through the AxisTitleTextProperty and AxisLabelTextProperty attributes. You may also use the GetXAxisActor2D, GetYAxisActor2D or GetZAxisActor2D methods to
access each individual axis actor to modify their font properties.
The bounding box to use is defined in one of three ways. First, if the Input ivar is defined, then the input datasets
bounds is used. If the Input is not defined, and the Prop (superclass of all actors) is defined, then the Props bounds
is used. If neither the Input or Prop is defined, then the Bounds instance variable (an array of six doubles) is used.
To create an instance of class vtkCubeAxesActor2D, simply invoke its constructor as follows
obj = vtkCubeAxesActor2D
35.10.2
Methods
The class vtkCubeAxesActor2D has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCubeAxesActor2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCubeAxesActor2D = obj.NewInstance ()
vtkCubeAxesActor2D = obj.SafeDownCast (vtkObject o)
int = obj.RenderOverlay (vtkViewport ) - Draw the axes as per the vtkProp superclass API.
int = obj.RenderOpaqueGeometry (vtkViewport ) - Draw the axes as per the vtkProp superclass API.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.10 vtkCubeAxesActor2D
1479
1480
obj.UseRangesOn () - Set/Get a flag that controls whether the axes use the data ranges or the ranges
set by SetRanges. By default the axes use the data ranges.
obj.UseRangesOff () - Set/Get a flag that controls whether the axes use the data ranges or the ranges
set by SetRanges. By default the axes use the data ranges.
obj.SetCamera (vtkCamera ) - Set/Get the camera to perform scaling and translation of the vtkCubeAxesActor2D.
vtkCamera = obj.GetCamera () - Set/Get the camera to perform scaling and translation of the vtkCubeAxesActor2D.
obj.SetFlyMode (int ) - Specify a mode to control how the axes are drawn: either outer edges or
closest triad to the camera position, or you may also disable flying of the axes.
int = obj.GetFlyModeMinValue () - Specify a mode to control how the axes are drawn: either
outer edges or closest triad to the camera position, or you may also disable flying of the axes.
int = obj.GetFlyModeMaxValue () - Specify a mode to control how the axes are drawn: either
outer edges or closest triad to the camera position, or you may also disable flying of the axes.
int = obj.GetFlyMode () - Specify a mode to control how the axes are drawn: either outer edges
or closest triad to the camera position, or you may also disable flying of the axes.
obj.SetFlyModeToOuterEdges () - Specify a mode to control how the axes are drawn: either outer
edges or closest triad to the camera position, or you may also disable flying of the axes.
obj.SetFlyModeToClosestTriad () - Specify a mode to control how the axes are drawn: either
outer edges or closest triad to the camera position, or you may also disable flying of the axes.
obj.SetFlyModeToNone () - Specify a mode to control how the axes are drawn: either outer edges
or closest triad to the camera position, or you may also disable flying of the axes.
obj.SetScaling (int ) - Set/Get a flag that controls whether the axes are scaled to fit in the viewport.
If off, the axes size remains constant (i.e., stay the size of the bounding box). By default scaling is on so the
axes are scaled to fit inside the viewport.
int = obj.GetScaling () - Set/Get a flag that controls whether the axes are scaled to fit in the
viewport. If off, the axes size remains constant (i.e., stay the size of the bounding box). By default scaling is
on so the axes are scaled to fit inside the viewport.
obj.ScalingOn () - Set/Get a flag that controls whether the axes are scaled to fit in the viewport. If off,
the axes size remains constant (i.e., stay the size of the bounding box). By default scaling is on so the axes
are scaled to fit inside the viewport.
obj.ScalingOff () - Set/Get a flag that controls whether the axes are scaled to fit in the viewport. If
off, the axes size remains constant (i.e., stay the size of the bounding box). By default scaling is on so the
axes are scaled to fit inside the viewport.
obj.SetNumberOfLabels (int ) - Set/Get the number of annotation labels to show along the x, y,
and z axes. This values is a suggestion: the number of labels may vary depending on the particulars of the
data.
int = obj.GetNumberOfLabelsMinValue () - Set/Get the number of annotation labels to show
along the x, y, and z axes. This values is a suggestion: the number of labels may vary depending on the
particulars of the data.
int = obj.GetNumberOfLabelsMaxValue () - Set/Get the number of annotation labels to show
along the x, y, and z axes. This values is a suggestion: the number of labels may vary depending on the
particulars of the data.
int = obj.GetNumberOfLabels () - Set/Get the number of annotation labels to show along the x,
y, and z axes. This values is a suggestion: the number of labels may vary depending on the particulars of the
data.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.10 vtkCubeAxesActor2D
1481
obj.SetXLabel (string ) - Set/Get the labels for the x, y, and z axes. By default, use "X", "Y" and
"Z".
string = obj.GetXLabel () - Set/Get the labels for the x, y, and z axes. By default, use "X", "Y"
and "Z".
obj.SetYLabel (string ) - Set/Get the labels for the x, y, and z axes. By default, use "X", "Y" and
"Z".
string = obj.GetYLabel () - Set/Get the labels for the x, y, and z axes. By default, use "X", "Y"
and "Z".
obj.SetZLabel (string ) - Set/Get the labels for the x, y, and z axes. By default, use "X", "Y" and
"Z".
string = obj.GetZLabel () - Set/Get the labels for the x, y, and z axes. By default, use "X", "Y"
and "Z".
vtkAxisActor2D = obj.GetXAxisActor2D () - Retrieve handles to the X, Y and Z axis (so that
you can set their text properties for example)
vtkAxisActor2D = obj.GetYAxisActor2D () - Retrieve handles to the X, Y and Z axis (so that
you can set their text properties for example)
vtkAxisActor2D = obj.GetZAxisActor2D () - Set/Get the title text property of all axes. Note
that each axis can be controlled individually through the GetX/Y/ZAxisActor2D() methods.
obj.SetAxisTitleTextProperty (vtkTextProperty p) - Set/Get the title text property of all
axes. Note that each axis can be controlled individually through the GetX/Y/ZAxisActor2D() methods.
vtkTextProperty = obj.GetAxisTitleTextProperty () - Set/Get the title text property of
all axes. Note that each axis can be controlled individually through the GetX/Y/ZAxisActor2D() methods.
obj.SetAxisLabelTextProperty (vtkTextProperty p) - Set/Get the labels text property of
all axes. Note that each axis can be controlled individually through the GetX/Y/ZAxisActor2D() methods.
vtkTextProperty = obj.GetAxisLabelTextProperty () - Set/Get the labels text property
of all axes. Note that each axis can be controlled individually through the GetX/Y/ZAxisActor2D() methods.
obj.SetLabelFormat (string ) - Set/Get the format with which to print the labels on each of the
x-y-z axes.
string = obj.GetLabelFormat () - Set/Get the format with which to print the labels on each of
the x-y-z axes.
obj.SetFontFactor (double ) - Set/Get the factor that controls the overall size of the fonts used to
label and title the axes.
double = obj.GetFontFactorMinValue () - Set/Get the factor that controls the overall size of
the fonts used to label and title the axes.
double = obj.GetFontFactorMaxValue () - Set/Get the factor that controls the overall size of
the fonts used to label and title the axes.
double = obj.GetFontFactor () - Set/Get the factor that controls the overall size of the fonts used
to label and title the axes.
obj.SetInertia (int ) - Set/Get the inertial factor that controls how often (i.e, how many renders)
the axes can switch position (jump from one axes to another).
int = obj.GetInertiaMinValue () - Set/Get the inertial factor that controls how often (i.e, how
many renders) the axes can switch position (jump from one axes to another).
int = obj.GetInertiaMaxValue () - Set/Get the inertial factor that controls how often (i.e, how
many renders) the axes can switch position (jump from one axes to another).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1482
int = obj.GetInertia () - Set/Get the inertial factor that controls how often (i.e, how many renders)
the axes can switch position (jump from one axes to another).
obj.SetShowActualBounds (int ) - Set/Get the variable that controls whether the actual bounds
of the dataset are always shown. Setting this variable to 1 means that clipping is disabled and that the actual
value of the bounds is displayed even with corner offsets Setting this variable to 0 means these axis will clip
themselves and show variable bounds (legacy mode)
int = obj.GetShowActualBoundsMinValue () - Set/Get the variable that controls whether the
actual bounds of the dataset are always shown. Setting this variable to 1 means that clipping is disabled and
that the actual value of the bounds is displayed even with corner offsets Setting this variable to 0 means these
axis will clip themselves and show variable bounds (legacy mode)
int = obj.GetShowActualBoundsMaxValue () - Set/Get the variable that controls whether the
actual bounds of the dataset are always shown. Setting this variable to 1 means that clipping is disabled and
that the actual value of the bounds is displayed even with corner offsets Setting this variable to 0 means these
axis will clip themselves and show variable bounds (legacy mode)
int = obj.GetShowActualBounds () - Set/Get the variable that controls whether the actual
bounds of the dataset are always shown. Setting this variable to 1 means that clipping is disabled and
that the actual value of the bounds is displayed even with corner offsets Setting this variable to 0 means
these axis will clip themselves and show variable bounds (legacy mode)
obj.SetCornerOffset (double ) - Specify an offset value to "pull back" the axes from the corner
at which they are joined to avoid overlap of axes labels. The "CornerOffset" is the fraction of the axis length
to pull back.
double = obj.GetCornerOffset () - Specify an offset value to "pull back" the axes from the corner at which they are joined to avoid overlap of axes labels. The "CornerOffset" is the fraction of the axis
length to pull back.
obj.ReleaseGraphicsResources (vtkWindow ) - Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to
release.
obj.SetXAxisVisibility (int ) - Turn on and off the visibility of each axis.
int = obj.GetXAxisVisibility () - Turn on and off the visibility of each axis.
obj.XAxisVisibilityOn () - Turn on and off the visibility of each axis.
obj.XAxisVisibilityOff () - Turn on and off the visibility of each axis.
obj.SetYAxisVisibility (int ) - Turn on and off the visibility of each axis.
int = obj.GetYAxisVisibility () - Turn on and off the visibility of each axis.
obj.YAxisVisibilityOn () - Turn on and off the visibility of each axis.
obj.YAxisVisibilityOff () - Turn on and off the visibility of each axis.
obj.SetZAxisVisibility (int ) - Turn on and off the visibility of each axis.
int = obj.GetZAxisVisibility () - Turn on and off the visibility of each axis.
obj.ZAxisVisibilityOn () - Turn on and off the visibility of each axis.
obj.ZAxisVisibilityOff () - Turn on and off the visibility of each axis.
obj.ShallowCopy (vtkCubeAxesActor2D actor) - Shallow copy of a CubeAxesActor2D.
obj.SetProp (vtkProp prop) Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.11 vtkDepthSortPolyData
35.11
1483
vtkDepthSortPolyData
35.11.1
Usage
vtkDepthSortPolyData rearranges the order of cells so that certain rendering operations (e.g., transparency or
Painters algorithms) generate correct results. To use this filter you must specify the direction vector along which to
sort the cells. You can do this by specifying a camera and/or prop to define a view direction; or explicitly set a view
direction.
To create an instance of class vtkDepthSortPolyData, simply invoke its constructor as follows
obj = vtkDepthSortPolyData
35.11.2
Methods
The class vtkDepthSortPolyData has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDepthSortPolyData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDepthSortPolyData = obj.NewInstance ()
vtkDepthSortPolyData = obj.SafeDownCast (vtkObject o)
obj.SetDirection (int ) - Specify the sort method for the polygonal primitives. By default, the poly
data is sorted from back to front.
int = obj.GetDirection () - Specify the sort method for the polygonal primitives. By default, the
poly data is sorted from back to front.
obj.SetDirectionToFrontToBack () - Specify the sort method for the polygonal primitives. By
default, the poly data is sorted from back to front.
obj.SetDirectionToBackToFront () - Specify the sort method for the polygonal primitives. By
default, the poly data is sorted from back to front.
obj.SetDirectionToSpecifiedVector () - Specify the point to use when sorting. The fastest is
to just take the first cell point. Other options are to take the bounding box center or the parametric center of
the cell. By default, the first cell point is used.
obj.SetDepthSortMode (int ) - Specify the point to use when sorting. The fastest is to just take
the first cell point. Other options are to take the bounding box center or the parametric center of the cell. By
default, the first cell point is used.
int = obj.GetDepthSortMode () - Specify the point to use when sorting. The fastest is to just take
the first cell point. Other options are to take the bounding box center or the parametric center of the cell. By
default, the first cell point is used.
obj.SetDepthSortModeToFirstPoint () - Specify the point to use when sorting. The fastest is
to just take the first cell point. Other options are to take the bounding box center or the parametric center of
the cell. By default, the first cell point is used.
obj.SetDepthSortModeToBoundsCenter () - Specify the point to use when sorting. The fastest
is to just take the first cell point. Other options are to take the bounding box center or the parametric center
of the cell. By default, the first cell point is used.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1484
35.12 vtkDSPFilterDefinition
35.12
1485
vtkDSPFilterDefinition
35.12.1
Usage
35.12.2
Methods
The class vtkDSPFilterDefinition has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDSPFilterDefinition class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDSPFilterDefinition = obj.NewInstance ()
vtkDSPFilterDefinition = obj.SafeDownCast (vtkObject o)
obj.Copy (vtkDSPFilterDefinition other)
obj.Clear ()
bool = obj.IsThisInputVariableInstanceNeeded (int a_timestep, int a_-
outputTimestep)
obj.PushBackNumeratorWeight (double a_value)
obj.PushBackDenominatorWeight (double a_value)
obj.PushBackForwardNumeratorWeight (double a_value)
obj.SetInputVariableName (string a_value)
obj.SetOutputVariableName (string a_value)
string = obj.GetInputVariableName ()
string = obj.GetOutputVariableName ()
int = obj.GetNumNumeratorWeights ()
int = obj.GetNumDenominatorWeights ()
int = obj.GetNumForwardNumeratorWeights ()
double = obj.GetNumeratorWeight (int a_which)
double = obj.GetDenominatorWeight (int a_which)
double = obj.GetForwardNumeratorWeight (int a_which)
35.13
vtkDSPFilterGroup
1486
35.13.1
Usage
35.13.2
Methods
The class vtkDSPFilterGroup has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkDSPFilterGroup class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDSPFilterGroup = obj.NewInstance ()
vtkDSPFilterGroup = obj.SafeDownCast (vtkObject o)
obj.AddFilter (vtkDSPFilterDefinition filter)
obj.RemoveFilter (string a_outputVariableName)
bool = obj.IsThisInputVariableInstanceNeeded (string a_name, int a_-
timestep)
obj.AddInputVariableInstance (string a_name, int a_timestep, vtkFloat-
Array a_data)
vtkFloatArray = obj.GetCachedInput (int a_whichFilter, int a_which-
Timestep)
vtkFloatArray = obj.GetCachedOutput (int a_whichFilter, int a_which-
Timestep)
string = obj.GetInputVariableName (int a_whichFilter)
int = obj.GetNumFilters ()
obj.Copy (vtkDSPFilterGroup other)
vtkDSPFilterDefinition = obj.GetFilter (int a_whichFilter)
35.14
vtkEarthSource
35.14.1
Usage
vtkEarthSource creates a spherical rendering of the geographical shapes of the major continents of the earth. The
OnRatio determines how much of the data is actually used. The radius defines the radius of the sphere at which
the continents are placed. Obtains data from an imbedded array of coordinates.
To create an instance of class vtkEarthSource, simply invoke its constructor as follows
obj = vtkEarthSource
35.15 vtkExodusIIReader
35.14.2
1487
Methods
The class vtkEarthSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkEarthSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkEarthSource = obj.NewInstance ()
vtkEarthSource = obj.SafeDownCast (vtkObject o)
obj.SetRadius (double ) - Set radius of earth.
double = obj.GetRadiusMinValue () - Set radius of earth.
double = obj.GetRadiusMaxValue () - Set radius of earth.
double = obj.GetRadius () - Set radius of earth.
obj.SetOnRatio (int ) - Turn on every nth entity. This controls how much detail the model will have.
The maximum ratio is sixteen. (The smaller OnRatio, the more detail there is.)
int = obj.GetOnRatioMinValue () - Turn on every nth entity. This controls how much detail the
model will have. The maximum ratio is sixteen. (The smaller OnRatio, the more detail there is.)
int = obj.GetOnRatioMaxValue () - Turn on every nth entity. This controls how much detail the
model will have. The maximum ratio is sixteen. (The smaller OnRatio, the more detail there is.)
int = obj.GetOnRatio () - Turn on every nth entity. This controls how much detail the model will
have. The maximum ratio is sixteen. (The smaller OnRatio, the more detail there is.)
obj.SetOutline (int ) - Turn on/off drawing continents as filled polygons or as wireframe outlines.
Warning: some graphics systems will have trouble with the very large, concave filled polygons. Recommend
you use OutlienOn (i.e., disable filled polygons) for now.
int = obj.GetOutline () - Turn on/off drawing continents as filled polygons or as wireframe outlines. Warning: some graphics systems will have trouble with the very large, concave filled polygons. Recommend you use OutlienOn (i.e., disable filled polygons) for now.
obj.OutlineOn () - Turn on/off drawing continents as filled polygons or as wireframe outlines. Warning:
some graphics systems will have trouble with the very large, concave filled polygons. Recommend you use
OutlienOn (i.e., disable filled polygons) for now.
obj.OutlineOff () - Turn on/off drawing continents as filled polygons or as wireframe outlines.
Warning: some graphics systems will have trouble with the very large, concave filled polygons. Recommend
you use OutlienOn (i.e., disable filled polygons) for now.
35.15
vtkExodusIIReader
35.15.1
Usage
vtkExodusIIReader is a unstructured grid source object that reads ExodusII files. Most of the meta data associated
with the file is loaded when UpdateInformation is called. This includes information like Title, number of blocks,
number and names of arrays. This data can be retrieved from methods in this reader. Separate arrays that are
meant to be a single vector, are combined internally for convenience. To be combined, the array names have to be
identical except for a trailing X,Y and Z (or x,y,z). By default cell and point arrays are not loaded. However, the user
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1488
can flag arrays to load with the methods "SetPointArrayStatus" and "SetCellArrayStatus". The reader DOES NOT
respond to piece requests
To create an instance of class vtkExodusIIReader, simply invoke its constructor as follows
obj = vtkExodusIIReader
35.15.2
Methods
The class vtkExodusIIReader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkExodusIIReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExodusIIReader = obj.NewInstance ()
vtkExodusIIReader = obj.SafeDownCast (vtkObject o)
int = obj.CanReadFile (string fname) - Determine if the file can be readed with this reader.
long = obj.GetMTime () - Return the objects MTime. This is overridden to include the timestamp of
its internal class.
long = obj.GetMetadataMTime () - Return the MTime of the internal data structure. This is really
only intended for use by vtkPExodusIIReader in order to determine if the filename is newer than the metadata.
obj.SetFileName (string fname) - Specify file name of the Exodus file.
string = obj.GetFileName () - Specify file name of the Exodus file.
obj.SetXMLFileName (string fname) - Specify file name of the xml file.
string = obj.GetXMLFileName () - Specify file name of the xml file.
obj.SetTimeStep (int ) - Which TimeStep to read.
int = obj.GetTimeStep () - Which TimeStep to read.
obj.SetModeShape (int val) - Returns the available range of valid integer time steps.
int = obj.
obj.SetTimeStepRange (int , int ) - Returns the available range of valid integer time steps.
obj.SetTimeStepRange (int a[2]) - Returns the available range of valid integer time steps.
obj.SetGenerateObjectIdCellArray (int g) - Extra cell data array that can be generated. By
default, this array is ON. The value of the array is the integer id found in the exodus file. The name of the
array is returned by GetBlockIdArrayName(). For cells representing elements from an Exodus element block,
this is set to the element block ID. For cells representing edges from an Exodus edge block, this is the edge
block ID. Similarly, ths is the face block ID for cells representing faces from an Exodus face block. The same
holds for cells representing entries of node, edge, face, side, and element sets.
int = obj.GetGenerateObjectIdCellArray () - Extra cell data array that can be generated.
By default, this array is ON. The value of the array is the integer id found in the exodus file. The name of the
array is returned by GetBlockIdArrayName(). For cells representing elements from an Exodus element block,
this is set to the element block ID. For cells representing edges from an Exodus edge block, this is the edge
block ID. Similarly, ths is the face block ID for cells representing faces from an Exodus face block. The same
holds for cells representing entries of node, edge, face, side, and element sets.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.15 vtkExodusIIReader
1489
1490
35.15 vtkExodusIIReader
1491
Index)
int = obj.GetObjectArrayStatus (int objectType, int arrayIndex)
int = obj.GetObjectArrayStatus (int objectType, string arrayName)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1492
int attribIndex)
int = obj.GetObjectAttributeIndex (int objectType, int objectIndex,
string attribName)
int = obj.GetObjectAttributeStatus (int objectType, int objectIndex,
int attribIndex)
int = obj.GetObjectAttributeStatus (int objectType, int objectIndex,
string attribName)
obj.SetObjectAttributeStatus (int objectType, int objectIndex, int attrib-
35.15 vtkExodusIIReader
1493
FloatArray result)
int = obj.GetNumberOfEdgeBlockArrays ()
string = obj.GetEdgeBlockArrayName (int index)
int = obj.GetEdgeBlockArrayStatus (string name)
obj.SetEdgeBlockArrayStatus (string name, int flag)
int = obj.GetNumberOfFaceBlockArrays ()
string = obj.GetFaceBlockArrayName (int index)
int = obj.GetFaceBlockArrayStatus (string name)
obj.SetFaceBlockArrayStatus (string name, int flag)
int = obj.GetNumberOfElementBlockArrays ()
string = obj.GetElementBlockArrayName (int index)
int = obj.GetElementBlockArrayStatus (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1494
35.15 vtkExodusIIReader
obj.SetElementMapArrayStatus (string name, int flag)
int = obj.GetNumberOfNodeSetArrays ()
string = obj.GetNodeSetArrayName (int index)
int = obj.GetNodeSetArrayStatus (string name)
obj.SetNodeSetArrayStatus (string name, int flag)
int = obj.GetNumberOfSideSetArrays ()
string = obj.GetSideSetArrayName (int index)
int = obj.GetSideSetArrayStatus (string name)
obj.SetSideSetArrayStatus (string name, int flag)
int = obj.GetNumberOfEdgeSetArrays ()
string = obj.GetEdgeSetArrayName (int index)
int = obj.GetEdgeSetArrayStatus (string name)
obj.SetEdgeSetArrayStatus (string name, int flag)
int = obj.GetNumberOfFaceSetArrays ()
string = obj.GetFaceSetArrayName (int index)
int = obj.GetFaceSetArrayStatus (string name)
obj.SetFaceSetArrayStatus (string name, int flag)
int = obj.GetNumberOfElementSetArrays ()
string = obj.GetElementSetArrayName (int index)
int = obj.GetElementSetArrayStatus (string name)
obj.SetElementSetArrayStatus (string name, int flag)
int = obj.GetNumberOfNodeSetResultArrays ()
string = obj.GetNodeSetResultArrayName (int index)
int = obj.GetNodeSetResultArrayStatus (string name)
obj.SetNodeSetResultArrayStatus (string name, int flag)
int = obj.GetNumberOfSideSetResultArrays ()
string = obj.GetSideSetResultArrayName (int index)
int = obj.GetSideSetResultArrayStatus (string name)
obj.SetSideSetResultArrayStatus (string name, int flag)
int = obj.GetNumberOfEdgeSetResultArrays ()
string = obj.GetEdgeSetResultArrayName (int index)
int = obj.GetEdgeSetResultArrayStatus (string name)
obj.SetEdgeSetResultArrayStatus (string name, int flag)
int = obj.GetNumberOfFaceSetResultArrays ()
string = obj.GetFaceSetResultArrayName (int index)
int = obj.GetFaceSetResultArrayStatus (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1495
1496
35.16
vtkExodusModel
35.16.1
Usage
35.17 vtkExodusReader
1497
It can also be initialized (using UnpackExodusModel) from a vtkUnstructuredGrid that has had metadata packed
into its field arrays with PackExodusModel. The vtkExodusIIWriter does this.
If you plan to write out the Exodus file (with vtkExodusIIWriter), you should direct the Exodus reader to create a
vtkExodusModel object. This will be used by the Exodus writer to create a correct Exodus II file on output. In
addition, the vtkDistributedDataFilter is cognizant of the ExodusModel object and will unpack, extract, merge, and
pack these objects associated with the grids it is partitioning.
.SECTION See also vtkExodusReader vtkPExodusReader vtkExodusIIWriter vtkModelMetadata vtkDistributedDataFilter
To create an instance of class vtkExodusModel, simply invoke its constructor as follows
obj = vtkExodusModel
35.16.2
Methods
The class vtkExodusModel has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkExodusModel class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExodusModel = obj.NewInstance ()
vtkExodusModel = obj.SafeDownCast (vtkObject o)
int = obj.SetGlobalInformation (int fid, int compute_word_size)
int = obj.AddUGridElementVariable (string ugridVarName, string orig-
int numComponents)
int = obj.RemoveUGridNodeVariable (string ugridVarName)
int = obj.SetLocalInformation (vtkUnstructuredGrid ugrid, int fid, int
35.17
vtkExodusReader
1498
35.17.1
Usage
vtkExodusReader is a unstructured grid source object that reads ExodusII files. Most of the meta data associated
with the file is loaded when UpdateInformation is called. This includes information like Title, number of blocks,
number and names of arrays. This data can be retrieved from methods in this reader. Separate arrays that are
meant to be a single vector, are combined internally for convenience. To be combined, the array names have to be
identical except for a trailing X,Y and Z (or x,y,z). By default cell and point arrays are not loaded. However, the user
can flag arrays to load with the methods "SetPointArrayStatus" and "SetCellArrayStatus". The reader DOES NOT
respond to piece requests
To create an instance of class vtkExodusReader, simply invoke its constructor as follows
obj = vtkExodusReader
35.17.2
Methods
The class vtkExodusReader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkExodusReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExodusReader = obj.NewInstance ()
vtkExodusReader = obj.SafeDownCast (vtkObject o)
int = obj.CanReadFile (string fname) - Determine if the file can be readed with this reader.
obj.SetFileName (string ) - Specify file name of the Exodus file.
string = obj.GetFileName () - Specify file name of the Exodus file.
obj.SetXMLFileName (string ) - Specify file name of the xml file.
string = obj.GetXMLFileName () - Specify file name of the xml file.
obj.SetTimeStep (int ) - Which TimeStep to read.
int = obj.GetTimeStep () - Which TimeStep to read.
obj.SetGenerateBlockIdCellArray (int ) - Extra cell data array that can be generated. By
default, this array is ON. The value of the array is the integer id found in the exodus file. The name of the
array is returned by GetBlockIdArrayName()
int = obj.GetGenerateBlockIdCellArray () - Extra cell data array that can be generated. By
default, this array is ON. The value of the array is the integer id found in the exodus file. The name of the
array is returned by GetBlockIdArrayName()
obj.GenerateBlockIdCellArrayOn () - Extra cell data array that can be generated. By default,
this array is ON. The value of the array is the integer id found in the exodus file. The name of the array is
returned by GetBlockIdArrayName()
obj.GenerateBlockIdCellArrayOff () - Extra cell data array that can be generated. By default,
this array is ON. The value of the array is the integer id found in the exodus file. The name of the array is
returned by GetBlockIdArrayName()
string = obj.GetBlockIdArrayName () - Extra cell data array that can be generated. By default,
this array is off. The value of the array is the integer global id of the cell. The name of the array is returned by
GetGlobalElementIdArrayName()
obj.SetGenerateGlobalElementIdArray (int ) - Extra cell data array that can be generated.
By default, this array is off. The value of the array is the integer global id of the cell. The name of the array is
returned by GetGlobalElementIdArrayName()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.17 vtkExodusReader
1499
int = obj.GetGenerateGlobalElementIdArray () - Extra cell data array that can be generated. By default, this array is off. The value of the array is the integer global id of the cell. The name of the
array is returned by GetGlobalElementIdArrayName()
obj.GenerateGlobalElementIdArrayOn () - Extra cell data array that can be generated. By
default, this array is off. The value of the array is the integer global id of the cell. The name of the array is
returned by GetGlobalElementIdArrayName()
obj.GenerateGlobalElementIdArrayOff () - Extra cell data array that can be generated. By
default, this array is off. The value of the array is the integer global id of the cell. The name of the array is
returned by GetGlobalElementIdArrayName()
obj.SetGenerateGlobalNodeIdArray (int ) - Extra point data array that can be generated. By
default, this array is ON. The value of the array is the integer id of the node. The id is relative to the entire
data set. The name of the array is returned by GlobalNodeIdArrayName().
int = obj.GetGenerateGlobalNodeIdArray () - Extra point data array that can be generated.
By default, this array is ON. The value of the array is the integer id of the node. The id is relative to the entire
data set. The name of the array is returned by GlobalNodeIdArrayName().
obj.GenerateGlobalNodeIdArrayOn () - Extra point data array that can be generated. By default,
this array is ON. The value of the array is the integer id of the node. The id is relative to the entire data set.
The name of the array is returned by GlobalNodeIdArrayName().
obj.GenerateGlobalNodeIdArrayOff () - Extra point data array that can be generated. By default, this array is ON. The value of the array is the integer id of the node. The id is relative to the entire data
set. The name of the array is returned by GlobalNodeIdArrayName().
obj.SetApplyDisplacements (int ) - Geometric locations can include displacements. By default, this is ON. The nodal positions are displaced by the standard exodus displacment vector. If displacements are turned off, the user can explicitly add them by applying a warp filter.
int = obj.GetApplyDisplacements () - Geometric locations can include displacements. By default, this is ON. The nodal positions are displaced by the standard exodus displacment vector. If displacements are turned off, the user can explicitly add them by applying a warp filter.
obj.ApplyDisplacementsOn () - Geometric locations can include displacements. By default, this
is ON. The nodal positions are displaced by the standard exodus displacment vector. If displacements are
turned off, the user can explicitly add them by applying a warp filter.
obj.ApplyDisplacementsOff () - Geometric locations can include displacements. By default, this
is ON. The nodal positions are displaced by the standard exodus displacment vector. If displacements are
turned off, the user can explicitly add them by applying a warp filter.
obj.SetDisplacementMagnitude (float ) - Geometric locations can include displacements. By
default, this is ON. The nodal positions are displaced by the standard exodus displacment vector. If displacements are turned off, the user can explicitly add them by applying a warp filter.
float = obj.GetDisplacementMagnitude () - Geometric locations can include displacements.
By default, this is ON. The nodal positions are displaced by the standard exodus displacment vector. If
displacements are turned off, the user can explicitly add them by applying a warp filter.
string = obj.GetTitle () - Access to meta data generated by UpdateInformation.
int = obj.GetDimensionality () - Access to meta data generated by UpdateInformation.
int = obj.GetNumberOfTimeSteps () - Access to meta data generated by UpdateInformation.
int = obj.GetNumberOfElements () - Access to meta data generated by UpdateInformation.
int = obj.GetNumberOfNodeSets () - Access to meta data generated by UpdateInformation.
int = obj.GetNumberOfSideSets () - Access to meta data generated by UpdateInformation.
int = obj.GetNumberOfBlocks () - Access to meta data generated by UpdateInformation.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1500
int = obj.
35.17 vtkExodusReader
1501
int = obj.GetNodeSetArrayStatus (int index) - By default Node/Side sets are not loaded,
These methods allow the user to select which Node/Side sets they want to load. NumberOfNodeSets and
NumberOfSideSets (set by vtk macros) are stored in vtkExodusReader but other Node/Side set metadata are
stored in vtkExodusMetaData Note: GetNumberOfNodeSetArrays and GetNumberOfSideSetArrays are just
syntatic sugar for paraview server xml
int = obj.GetNodeSetArrayStatus (string name) - By default Node/Side sets are not
loaded, These methods allow the user to select which Node/Side sets they want to load. NumberOfNodeSets
and NumberOfSideSets (set by vtk macros) are stored in vtkExodusReader but other Node/Side set metadata
are stored in vtkExodusMetaData Note: GetNumberOfNodeSetArrays and GetNumberOfSideSetArrays are
just syntatic sugar for paraview server xml
obj.SetNodeSetArrayStatus (int index, int flag) - By default Node/Side sets are not
loaded, These methods allow the user to select which Node/Side sets they want to load. NumberOfNodeSets
and NumberOfSideSets (set by vtk macros) are stored in vtkExodusReader but other Node/Side set metadata
are stored in vtkExodusMetaData Note: GetNumberOfNodeSetArrays and GetNumberOfSideSetArrays are
just syntatic sugar for paraview server xml
obj.SetNodeSetArrayStatus (string name, int flag) - By default Node/Side sets are
not loaded, These methods allow the user to select which Node/Side sets they want to load. NumberOfNodeSets and NumberOfSideSets (set by vtk macros) are stored in vtkExodusReader but other Node/Side
set metadata are stored in vtkExodusMetaData Note: GetNumberOfNodeSetArrays and GetNumberOfSideSetArrays are just syntatic sugar for paraview server xml
string = obj.GetNodeSetArrayName (int index) - By default Node/Side sets are not
loaded, These methods allow the user to select which Node/Side sets they want to load. NumberOfNodeSets
and NumberOfSideSets (set by vtk macros) are stored in vtkExodusReader but other Node/Side set metadata
are stored in vtkExodusMetaData Note: GetNumberOfNodeSetArrays and GetNumberOfSideSetArrays are
just syntatic sugar for paraview server xml
int = obj.GetNumberOfSideSetArrays ()
int = obj.GetSideSetArrayStatus (int index)
int = obj.GetSideSetArrayStatus (string name)
obj.SetSideSetArrayStatus (int index, int flag)
obj.SetSideSetArrayStatus (string name, int flag)
string = obj.GetSideSetArrayName (int index)
int = obj.GetNumberOfPartArrays ()
string = obj.GetPartArrayName (int arrayIdx)
int = obj.GetPartArrayID (string name)
string = obj.GetPartBlockInfo (int arrayIdx)
obj.SetPartArrayStatus (int index, int flag)
obj.SetPartArrayStatus (string , int flag)
int = obj.GetPartArrayStatus (int index)
int = obj.GetPartArrayStatus (string )
int = obj.GetNumberOfMaterialArrays ()
string = obj.GetMaterialArrayName (int arrayIdx)
int = obj.GetMaterialArrayID (string name)
obj.SetMaterialArrayStatus (int index, int flag)
obj.SetMaterialArrayStatus (string , int flag)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1502
35.18 vtkFacetReader
1503
obj.SetPackExodusModelOntoOutput (int )
int = obj.GetPackExodusModelOntoOutput ()
obj.PackExodusModelOntoOutputOn ()
obj.PackExodusModelOntoOutputOff ()
int = obj.IsValidVariable (string type, string name)
int = obj.GetVariableID (string type, string name)
obj.SetAllAssemblyArrayStatus (int status)
obj.SetAllBlockArrayStatus (int status)
obj.SetAllCellArrayStatus (int status)
obj.SetAllHierarchyArrayStatus (int status)
obj.SetAllMaterialArrayStatus (int status)
obj.SetAllPartArrayStatus (int status)
obj.SetAllPointArrayStatus (int status)
obj.SetArrayStatus (string type, string name, int flag)
int = obj.GetArrayStatus (string type, string name)
int = obj.GetTimeSeriesData (int ID, string vName, string vType, vtk-
FloatArray result)
int = obj.GetNumberOfVariableArrays ()
string = obj.GetVariableArrayName (int a_which)
obj.EnableDSPFiltering ()
obj.AddFilter (vtkDSPFilterDefinition a_filter)
obj.StartAddingFilter ()
obj.AddFilterInputVar (string name)
obj.AddFilterOutputVar (string name)
obj.AddFilterNumeratorWeight (double weight)
obj.AddFilterForwardNumeratorWeight (double weight)
obj.AddFilterDenominatorWeight (double weight)
obj.FinishAddingFilter ()
obj.RemoveFilter (string a_outputVariableName)
obj.GetDSPOutputArrays (int exoid, vtkUnstructuredGrid output)
35.18
vtkFacetReader
1504
35.18.1
Usage
vtkFacetReader creates a poly data dataset. It reads ASCII files stored in Facet format
The facet format looks like this: FACET FILE ... nparts Part 1 name 0 npoints 0 0 p1x p1y p1z p2x p2y p2z ... 1 Part
1 name ncells npointspercell p1c1 p2c1 p3c1 ... pnc1 materialnum partnum p1c2 p2c2 p3c2 ... pnc2 materialnum
partnum ...
To create an instance of class vtkFacetReader, simply invoke its constructor as follows
obj = vtkFacetReader
35.18.2
Methods
The class vtkFacetReader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkFacetReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkFacetReader = obj.NewInstance ()
vtkFacetReader = obj.SafeDownCast (vtkObject o)
obj.SetFileName (string ) - Specify file name of Facet datafile to read
string = obj.GetFileName () - Specify file name of Facet datafile to read
35.19
vtkGreedyTerrainDecimation
35.19.1
Usage
vtkGreedyTerrainDecimation approximates a height field with a triangle mesh (triangulated irregular network - TIN)
using a greedy insertion algorithm similar to that described by Garland and Heckbert in their paper "Fast Polygonal
Approximations of Terrain and Height Fields" (Technical Report CMU-CS-95-181). The input to the filter is a height
field (represented by a image whose scalar values are height) and the output of the filter is polygonal data consisting
of triangles. The number of triangles in the output is reduced in number as compared to a naive tessellation of the
input height field. This filter copies point data from the input to the output for those points present in the output.
An brief description of the algorithm is as follows. The algorithm uses a top-down decimation approach that initially
represents the height field with two triangles (whose vertices are at the four corners of the image). These two
triangles form a Delaunay triangulation. In an iterative fashion, the point in the image with the greatest error (as
compared to the original height field) is injected into the triangulation. (Note that the single point with the greatest
error per triangle is identified and placed into a priority queue. As the triangulation is modified, the errors from the
deleted triangles are removed from the queue, error values from the new triangles are added.) The point whose
error is at the top of the queue is added to the triangulaion modifying it using the standard incremental Delaunay
point insertion (see vtkDelaunay2D) algorithm. Points are repeatedly inserted until the appropriate (user-specified)
error criterion is met.
To use this filter, set the input and specify the error measure to be used. The error measure options are 1) the
absolute number of triangles to be produced; 2) a fractional reduction of the mesh (numTris/maxTris) where maxTris
is the largest possible number of triangles 2(dims[0]-1)(dims[1]-1); 3) an absolute measure on error (maximum
difference in height field to reduced TIN); and 4) relative error (the absolute error is normalized by the diagonal of
the bounding box of the height field).
To create an instance of class vtkGreedyTerrainDecimation, simply invoke its constructor as follows
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.19 vtkGreedyTerrainDecimation
1505
obj = vtkGreedyTerrainDecimation
35.19.2
Methods
The class vtkGreedyTerrainDecimation has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGreedyTerrainDecimation
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGreedyTerrainDecimation = obj.NewInstance ()
vtkGreedyTerrainDecimation = obj.SafeDownCast (vtkObject o)
obj.SetErrorMeasure (int ) - Specify how to terminate the algorithm: either as an absolute number of triangles, a relative number of triangles (normalized by the full resolution mesh), an absolute error (in
the height field), or relative error (normalized by the length of the diagonal of the image).
int = obj.GetErrorMeasureMinValue () - Specify how to terminate the algorithm: either as
an absolute number of triangles, a relative number of triangles (normalized by the full resolution mesh), an
absolute error (in the height field), or relative error (normalized by the length of the diagonal of the image).
int = obj.GetErrorMeasureMaxValue () - Specify how to terminate the algorithm: either as
an absolute number of triangles, a relative number of triangles (normalized by the full resolution mesh), an
absolute error (in the height field), or relative error (normalized by the length of the diagonal of the image).
int = obj.GetErrorMeasure () - Specify how to terminate the algorithm: either as an absolute
number of triangles, a relative number of triangles (normalized by the full resolution mesh), an absolute error
(in the height field), or relative error (normalized by the length of the diagonal of the image).
obj.SetErrorMeasureToNumberOfTriangles () - Specify how to terminate the algorithm: either as an absolute number of triangles, a relative number of triangles (normalized by the full resolution
mesh), an absolute error (in the height field), or relative error (normalized by the length of the diagonal of the
image).
obj.SetErrorMeasureToSpecifiedReduction () - Specify how to terminate the algorithm: either as an absolute number of triangles, a relative number of triangles (normalized by the full resolution mesh),
an absolute error (in the height field), or relative error (normalized by the length of the diagonal of the image).
obj.SetErrorMeasureToAbsoluteError () - Specify how to terminate the algorithm: either as
an absolute number of triangles, a relative number of triangles (normalized by the full resolution mesh), an
absolute error (in the height field), or relative error (normalized by the length of the diagonal of the image).
obj.SetErrorMeasureToRelativeError () - Specify the number of triangles to produce on output. (It is a good idea to make sure this is less than a tessellated mesh at full resolution.) You need to set this
value only when the error measure is set to NumberOfTriangles.
obj.SetNumberOfTriangles (vtkIdType ) - Specify the number of triangles to produce on output. (It is a good idea to make sure this is less than a tessellated mesh at full resolution.) You need to set this
value only when the error measure is set to NumberOfTriangles.
vtkIdType = obj.GetNumberOfTrianglesMinValue () - Specify the number of triangles to
produce on output. (It is a good idea to make sure this is less than a tessellated mesh at full resolution.) You
need to set this value only when the error measure is set to NumberOfTriangles.
vtkIdType = obj.GetNumberOfTrianglesMaxValue () - Specify the number of triangles to
produce on output. (It is a good idea to make sure this is less than a tessellated mesh at full resolution.) You
need to set this value only when the error measure is set to NumberOfTriangles.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1506
35.20 vtkGridTransform
1507
int = obj.GetComputeNormals () - Compute normals based on the input image. Off by default.
obj.ComputeNormalsOn () - Compute normals based on the input image. Off by default.
obj.ComputeNormalsOff () - Compute normals based on the input image. Off by default.
35.20
vtkGridTransform
35.20.1
Usage
vtkGridTransform describes a nonlinear warp transformation as a set of displacement vectors sampled along a
uniform 3D grid.
To create an instance of class vtkGridTransform, simply invoke its constructor as follows
obj = vtkGridTransform
35.20.2
Methods
The class vtkGridTransform has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGridTransform class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGridTransform = obj.NewInstance ()
vtkGridTransform = obj.SafeDownCast (vtkObject o)
obj.SetDisplacementGrid (vtkImageData ) - Set/Get the grid transform (the grid transform
must have three components for displacement in x, y, and z respectively). The vtkGridTransform class will
never modify the data.
vtkImageData = obj.GetDisplacementGrid () - Set/Get the grid transform (the grid transform
must have three components for displacement in x, y, and z respectively). The vtkGridTransform class will
never modify the data.
obj.SetDisplacementScale (double ) - Set scale factor to be applied to the displacements. This
is used primarily for grids which contain integer data types. Default: 1
double = obj.GetDisplacementScale () - Set scale factor to be applied to the displacements.
This is used primarily for grids which contain integer data types. Default: 1
obj.SetDisplacementShift (double ) - Set a shift to be applied to the displacements. The shift
is applied after the scale, i.e. x = scaley + shift. Default: 0
double = obj.GetDisplacementShift () - Set a shift to be applied to the displacements. The
shift is applied after the scale, i.e. x = scaley + shift. Default: 0
obj.SetInterpolationMode (int mode) - Set interpolation mode for sampling the grid. Higherorder interpolation allows you to use a sparser grid. Default: Linear.
int = obj.GetInterpolationMode () - Set interpolation mode for sampling the grid. Higherorder interpolation allows you to use a sparser grid. Default: Linear.
obj.SetInterpolationModeToNearestNeighbor () - Set interpolation mode for sampling the
grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1508
obj.SetInterpolationModeToLinear () - Set interpolation mode for sampling the grid. Higherorder interpolation allows you to use a sparser grid. Default: Linear.
obj.SetInterpolationModeToCubic () - Set interpolation mode for sampling the grid. Higherorder interpolation allows you to use a sparser grid. Default: Linear.
string = obj.GetInterpolationModeAsString () - Set interpolation mode for sampling the
grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.
vtkAbstractTransform = obj.MakeTransform () - Make another transform of the same type.
long = obj.GetMTime () - Get the MTime.
35.21
vtkImageDataLIC2D
35.21.1
Usage
GPU implementation of a Line Integral Convolution, a technique for imaging vector fields.
The input on port 0 is an vtkImageData with extents of a 2D image. It needs a vector field on point data. Port 1
is a special port for customized noise input. It is an optional port. If not present, noise is generated by the filter.
Even if none-power-of-two texture are supported, giving a power-of-two image may result in faster execution on the
GPU. If noise input is not specified, then the filter using vtkImageNoiseSource to generate a 128x128 noise texture.
This filter only works on point vectors. One can use a vtkCellDataToPointData filter to convert cell vectors to point
vectors.
.SECTION Required OpenGL Extensins GL_ARB_texture_non_power_of_two GL_VERSION_2_0 GL_ARB_texture_float GL_ARB_draw_buffers GL_EXT_framebuffer_object GL_ARB_pixel_buffer_object
To create an instance of class vtkImageDataLIC2D, simply invoke its constructor as follows
obj = vtkImageDataLIC2D
35.21.2
Methods
The class vtkImageDataLIC2D has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageDataLIC2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageDataLIC2D = obj.NewInstance ()
vtkImageDataLIC2D = obj.SafeDownCast (vtkObject o)
int = obj.SetContext (vtkRenderWindow context) - Get/Set the context. Context must be
a vtkOpenGLRenderWindow. This does not increase the reference count of the context to avoid reference
loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions. Return 0 upon failure and 1 upon success.
vtkRenderWindow = obj.GetContext () - Get/Set the context. Context must be a vtkOpenGLRenderWindow. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions. Return
0 upon failure and 1 upon success.
obj.SetSteps (int ) - Number of steps. Initial value is 20. class invariant: Steps>0. In term of visual
quality, the greater the better.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.22 vtkImageDataLIC2DExtentTranslator
1509
int = obj.GetSteps () - Number of steps. Initial value is 20. class invariant: Steps>0. In term of
visual quality, the greater the better.
obj.SetStepSize (double ) - Step size. Specify the step size as a unit of the cell length of the
input vector field. Cell lenghth is the length of the diagonal of a cell. Initial value is 1.0. class invariant:
StepSize>0.0. In term of visual quality, the smaller the better. The type for the interface is double as VTK
interface is double but GPU only supports float. This value will be converted to float in the execution of the
algorithm.
double = obj.GetStepSizeMinValue () - Step size. Specify the step size as a unit of the cell
length of the input vector field. Cell lenghth is the length of the diagonal of a cell. Initial value is 1.0. class
invariant: StepSize>0.0. In term of visual quality, the smaller the better. The type for the interface is double
as VTK interface is double but GPU only supports float. This value will be converted to float in the execution
of the algorithm.
double = obj.GetStepSizeMaxValue () - Step size. Specify the step size as a unit of the cell
length of the input vector field. Cell lenghth is the length of the diagonal of a cell. Initial value is 1.0. class
invariant: StepSize>0.0. In term of visual quality, the smaller the better. The type for the interface is double
as VTK interface is double but GPU only supports float. This value will be converted to float in the execution
of the algorithm.
double = obj.GetStepSize () - Step size. Specify the step size as a unit of the cell length of the
input vector field. Cell lenghth is the length of the diagonal of a cell. Initial value is 1.0. class invariant:
StepSize>0.0. In term of visual quality, the smaller the better. The type for the interface is double as VTK
interface is double but GPU only supports float. This value will be converted to float in the execution of the
algorithm.
obj.SetMagnification (int ) - The the magnification factor. Default is 1
int = obj.GetMagnificationMinValue () - The the magnification factor. Default is 1
int = obj.GetMagnificationMaxValue () - The the magnification factor. Default is 1
int = obj.GetMagnification () - The the magnification factor. Default is 1
int = obj.GetOpenGLExtensionsSupported () - Check if the required OpenGL extensions /
GPU are supported.
int = obj.GetFBOSuccess () - Check if LIC runs properly.
int = obj.GetLICSuccess ()
obj.TranslateInputExtent (int inExt, int inWholeExtent, int outExt)
35.22
vtkImageDataLIC2DExtentTranslator
35.22.1
Usage
35.22.2
Methods
The class vtkImageDataLIC2DExtentTranslator has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageDataLIC2DExtentTranslator class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1510
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageDataLIC2DExtentTranslator = obj.NewInstance ()
vtkImageDataLIC2DExtentTranslator = obj.SafeDownCast (vtkObject o)
obj.SetAlgorithm (vtkImageDataLIC2D ) - Set the vtkImageDataLIC2D algorithm for which
this extent translator is being used.
vtkImageDataLIC2D = obj.GetAlgorithm () - Set the vtkImageDataLIC2D algorithm for which
this extent translator is being used.
obj.SetInputExtentTranslator (vtkExtentTranslator )
vtkExtentTranslator = obj.GetInputExtentTranslator ()
obj.SetInputWholeExtent (int , int , int , int , int , int )
obj.SetInputWholeExtent (int a[6])
int = obj.
GetInputWholeExtent ()
35.23
vtkImageToPolyDataFilter
35.23.1
Usage
vtkImageToPolyDataFilter converts raster data (i.e., an image) into polygonal data (i.e., quads or n-sided polygons),
with each polygon assigned a constant color. This is useful for writers that generate vector formats (i.e., CGM or
PostScript). To use this filter, you specify how to quantize the color (or whether to use an image with a lookup table),
and what style the output should be. The output is always polygons, but the choice is n x m quads (where n and m
define the input image dimensions) "Pixelize" option; arbitrary polygons "Polygonalize" option; or variable number
of quads of constant color generated along scan lines "RunLength" option.
The algorithm quantizes color in order to create coherent regions that the polygons can represent with good compression. By default, the input image is quantized to 256 colors using a 3-3-2 bits for red-green-blue. However,
you can also supply a single component image and a lookup table, with the single component assumed to be an
index into the table. (Note: a quantized image can be generated with the filter vtkImageQuantizeRGBToIndex.) The
number of colors on output is equal to the number of colors in the input lookup table (or 256 if the built in linear ramp
is used).
The output of the filter is polygons with a single color per polygon cell. If the output style is set to "Polygonalize",
the polygons may have an large number of points (bounded by something like 2(n+m)); and the polygon may not
be convex which may cause rendering problems on some systems (use vtkTriangleFilter). Otherwise, each polygon
will have four vertices. The output also contains scalar data defining RGB color in unsigned char form.
To create an instance of class vtkImageToPolyDataFilter, simply invoke its constructor as follows
obj = vtkImageToPolyDataFilter
35.23 vtkImageToPolyDataFilter
35.23.2
1511
Methods
The class vtkImageToPolyDataFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageToPolyDataFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageToPolyDataFilter = obj.NewInstance ()
vtkImageToPolyDataFilter = obj.SafeDownCast (vtkObject o)
obj.SetOutputStyle (int ) - Specify how to create the output. Pixelize means converting the
image to quad polygons with a constant color per quad. Polygonalize means merging colors together into
polygonal regions, and then smoothing the regions (if smoothing is turned on). RunLength means creating
quad polygons that may encompass several pixels on a scan line. The default behavior is Polygonalize.
int = obj.GetOutputStyleMinValue () - Specify how to create the output. Pixelize means converting the image to quad polygons with a constant color per quad. Polygonalize means merging colors
together into polygonal regions, and then smoothing the regions (if smoothing is turned on). RunLength
means creating quad polygons that may encompass several pixels on a scan line. The default behavior is
Polygonalize.
int = obj.GetOutputStyleMaxValue () - Specify how to create the output. Pixelize means converting the image to quad polygons with a constant color per quad. Polygonalize means merging colors
together into polygonal regions, and then smoothing the regions (if smoothing is turned on). RunLength
means creating quad polygons that may encompass several pixels on a scan line. The default behavior is
Polygonalize.
int = obj.GetOutputStyle () - Specify how to create the output. Pixelize means converting the
image to quad polygons with a constant color per quad. Polygonalize means merging colors together into
polygonal regions, and then smoothing the regions (if smoothing is turned on). RunLength means creating
quad polygons that may encompass several pixels on a scan line. The default behavior is Polygonalize.
obj.SetOutputStyleToPixelize () - Specify how to create the output. Pixelize means converting
the image to quad polygons with a constant color per quad. Polygonalize means merging colors together into
polygonal regions, and then smoothing the regions (if smoothing is turned on). RunLength means creating
quad polygons that may encompass several pixels on a scan line. The default behavior is Polygonalize.
obj.SetOutputStyleToPolygonalize () - Specify how to create the output. Pixelize means converting the image to quad polygons with a constant color per quad. Polygonalize means merging colors
together into polygonal regions, and then smoothing the regions (if smoothing is turned on). RunLength
means creating quad polygons that may encompass several pixels on a scan line. The default behavior is
Polygonalize.
obj.SetOutputStyleToRunLength () - Specify how to create the output. Pixelize means converting the image to quad polygons with a constant color per quad. Polygonalize means merging colors together
into polygonal regions, and then smoothing the regions (if smoothing is turned on). RunLength means creating quad polygons that may encompass several pixels on a scan line. The default behavior is Polygonalize.
obj.SetColorMode (int ) - Specify how to quantize color.
int = obj.GetColorModeMinValue () - Specify how to quantize color.
int = obj.GetColorModeMaxValue () - Specify how to quantize color.
int = obj.GetColorMode () - Specify how to quantize color.
obj.SetColorModeToLUT () - Specify how to quantize color.
obj.SetColorModeToLinear256 () - Specify how to quantize color.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1512
The
35.24 vtkImplicitModeller
1513
int = obj.GetErrorMaxValue () - Specify the error value between two colors where the colors
are considered the same. Only use this if the color mode uses the default 256 table.
int = obj.GetError () - Specify the error value between two colors where the colors are considered
the same. Only use this if the color mode uses the default 256 table.
obj.SetSubImageSize (int ) - Specify the size (n by n pixels) of the largest region to polygonalize.
When the OutputStyle is set to VTK_STYLE_POLYGONALIZE, large amounts of memory are used. In order
to process large images, the image is broken into pieces that are at most Size pixels in width and height.
int = obj.GetSubImageSizeMinValue () - Specify the size (n by n pixels) of the largest region
to polygonalize. When the OutputStyle is set to VTK_STYLE_POLYGONALIZE, large amounts of memory
are used. In order to process large images, the image is broken into pieces that are at most Size pixels in
width and height.
int = obj.GetSubImageSizeMaxValue () - Specify the size (n by n pixels) of the largest region
to polygonalize. When the OutputStyle is set to VTK_STYLE_POLYGONALIZE, large amounts of memory
are used. In order to process large images, the image is broken into pieces that are at most Size pixels in
width and height.
int = obj.GetSubImageSize () - Specify the size (n by n pixels) of the largest region to polygonalize. When the OutputStyle is set to VTK_STYLE_POLYGONALIZE, large amounts of memory are used.
In order to process large images, the image is broken into pieces that are at most Size pixels in width and
height.
35.24
vtkImplicitModeller
35.24.1
Usage
vtkImplicitModeller is a filter that computes the distance from the input geometry to the points of an output structured
point set. This distance function can then be "contoured" to generate new, offset surfaces from the original geometry.
An important feature of this object is "capping". If capping is turned on, after the implicit model is created, the values
on the boundary of the structured points dataset are set to the cap value. This is used to force closure of the
resulting contoured surface. Note, however, that large cap values can generate weird surface normals in those cells
adjacent to the boundary of the dataset. Using smaller cap value will reduce this effect.
Another important ivar is MaximumDistance. This controls how far into the volume the distance function is computed
from the input geometry. Small values give significant increases in performance. However, there can strange
sampling effects at the extreme range of the MaximumDistance.
In order to properly execute and sample the input data, a rectangular region in space must be defined (this is the ivar
ModelBounds). If not explicitly defined, the model bounds will be computed. Note that to avoid boundary effects, it
is possible to adjust the model bounds (i.e., using the AdjustBounds and AdjustDistance ivars) to strictly contain the
sampled data.
This filter has one other unusual capability: it is possible to append data in a sequence of operations to generate a
single output. This is useful when you have multiple datasets and want to create a conglomeration of all the data.
However, the user must be careful to either specify the ModelBounds or specify the first item such that its bounds
completely contain all other items. This is because the rectangular region of the output can not be changed after
the 1st Append.
The ProcessMode ivar controls the method used within the Append function (where the actual work is done regardless if the Append function is explicitly called) to compute the implicit model. If set to work in voxel mode, each
voxel is visited once. If set to cell mode, each cell is visited once. Tests have shown once per voxel to be faster
when there are a lot of cells (at least a thousand?); relative performance improvement increases with addition cells.
Primitives should not be stripped for best performance of the voxel mode. Also, if explicitly using the Append feature
many times, the cell mode will probably be better because each voxel will be visited each Append. Append the data
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1514
before input if possible when using the voxel mode. Do not switch between voxel and cell mode between execution
of StartAppend and EndAppend.
Further performance improvement is now possible using the PerVoxel process mode on multi-processor machines
(the mode is now multithreaded). Each thread processes a different "slab" of the output. Also, if the input is vtkPolyData, it is appropriately clipped for each thread; that is, each thread only considers the input which could affect its
slab of the output.
This filter can now produce output of any type supported by vtkImageData. However to support this change, additional sqrts must be executed during the Append step. Previously, the output was initialized to the squared CapValue
in StartAppend, the output was updated with squared distance values during the Append, and then the sqrt of the
distances was computed in EndAppend. To support different scalar types in the output (largely to reduce memory
requirements as an vtkImageShiftScale and/or vtkImageCast could have achieved the same result), we cant "afford" to save squared value in the output, because then we could only represent up to the sqrt of the scalar max
for an integer type in the output; 1 (instead of 255) for an unsigned char; 11 for a char (instead of 127). Thus this
change may result in a minor performance degradation. Non-float output types can be scaled to the CapValue by
turning ScaleToMaximumDistance On.
To create an instance of class vtkImplicitModeller, simply invoke its constructor as follows
obj = vtkImplicitModeller
35.24.2
Methods
The class vtkImplicitModeller has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImplicitModeller class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImplicitModeller = obj.NewInstance ()
vtkImplicitModeller = obj.SafeDownCast (vtkObject o)
double = obj.ComputeModelBounds (vtkDataSet inputNULL) - Compute ModelBounds
from input geometry. If input is not specified, the input of the filter will be used.
int = obj.
tance function.
35.24 vtkImplicitModeller
1515
obj.SetModelBounds (double a[6]) - Set / get the region in space in which to perform the sampling. If not specified, it will be computed automatically.
double = obj. GetModelBounds () - Set / get the region in space in which to perform the sampling. If not specified, it will be computed automatically.
obj.SetAdjustBounds (int ) - Control how the model bounds are computed. If the ivar AdjustBounds is set, then the bounds specified (or computed automatically) is modified by the fraction given by
AdjustDistance. This means that the model bounds is expanded in each of the x-y-z directions.
int = obj.GetAdjustBounds () - Control how the model bounds are computed. If the ivar AdjustBounds is set, then the bounds specified (or computed automatically) is modified by the fraction given by
AdjustDistance. This means that the model bounds is expanded in each of the x-y-z directions.
obj.AdjustBoundsOn () - Control how the model bounds are computed. If the ivar AdjustBounds is
set, then the bounds specified (or computed automatically) is modified by the fraction given by AdjustDistance.
This means that the model bounds is expanded in each of the x-y-z directions.
obj.AdjustBoundsOff () - Control how the model bounds are computed. If the ivar AdjustBounds is
set, then the bounds specified (or computed automatically) is modified by the fraction given by AdjustDistance.
This means that the model bounds is expanded in each of the x-y-z directions.
obj.SetAdjustDistance (double ) - Specify the amount to grow the model bounds (if the ivar
AdjustBounds is set). The value is a fraction of the maximum length of the sides of the box specified by the
model bounds.
double = obj.GetAdjustDistanceMinValue () - Specify the amount to grow the model
bounds (if the ivar AdjustBounds is set). The value is a fraction of the maximum length of the sides of the box
specified by the model bounds.
double = obj.GetAdjustDistanceMaxValue () - Specify the amount to grow the model
bounds (if the ivar AdjustBounds is set). The value is a fraction of the maximum length of the sides of the box
specified by the model bounds.
double = obj.GetAdjustDistance () - Specify the amount to grow the model bounds (if the ivar
AdjustBounds is set). The value is a fraction of the maximum length of the sides of the box specified by the
model bounds.
obj.SetCapping (int ) - The outer boundary of the structured point set can be assigned a particular
value. This can be used to close or "cap" all surfaces.
int = obj.GetCapping () - The outer boundary of the structured point set can be assigned a particular value. This can be used to close or "cap" all surfaces.
obj.CappingOn () - The outer boundary of the structured point set can be assigned a particular value.
This can be used to close or "cap" all surfaces.
obj.CappingOff () - The outer boundary of the structured point set can be assigned a particular value.
This can be used to close or "cap" all surfaces.
obj.SetCapValue (double value) - Specify the capping value to use. The CapValue is also used
as an initial distance value at each point in the dataset.
double = obj.GetCapValue () - Specify the capping value to use. The CapValue is also used as
an initial distance value at each point in the dataset.
obj.SetScaleToMaximumDistance (int ) - If a non-floating output type is specified, the output
distances can be scaled to use the entire positive scalar range of the output type specified (up to the CapValue
which is equal to the max for the type unless modified by the user). For example, if ScaleToMaximumDistance
is On and the OutputScalarType is UnsignedChar the distances saved in the output would be linearly scaled
between 0 (for distances "very close" to the surface) and 255 (at the specifed maximum distance)... assuming
the CapValue is not changed from 255.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1516
int = obj.GetScaleToMaximumDistance () - If a non-floating output type is specified, the output distances can be scaled to use the entire positive scalar range of the output type specified (up to the
CapValue which is equal to the max for the type unless modified by the user). For example, if ScaleToMaximumDistance is On and the OutputScalarType is UnsignedChar the distances saved in the output would
be linearly scaled between 0 (for distances "very close" to the surface) and 255 (at the specifed maximum
distance)... assuming the CapValue is not changed from 255.
obj.ScaleToMaximumDistanceOn () - If a non-floating output type is specified, the output distances
can be scaled to use the entire positive scalar range of the output type specified (up to the CapValue which
is equal to the max for the type unless modified by the user). For example, if ScaleToMaximumDistance is
On and the OutputScalarType is UnsignedChar the distances saved in the output would be linearly scaled
between 0 (for distances "very close" to the surface) and 255 (at the specifed maximum distance)... assuming
the CapValue is not changed from 255.
obj.ScaleToMaximumDistanceOff () - If a non-floating output type is specified, the output distances can be scaled to use the entire positive scalar range of the output type specified (up to the CapValue
which is equal to the max for the type unless modified by the user). For example, if ScaleToMaximumDistance
is On and the OutputScalarType is UnsignedChar the distances saved in the output would be linearly scaled
between 0 (for distances "very close" to the surface) and 255 (at the specifed maximum distance)... assuming
the CapValue is not changed from 255.
obj.SetProcessMode (int ) - Specify whether to visit each cell once per append or each voxel
once per append. Some tests have shown once per voxel to be faster when there are a lot of cells (at least a
thousand?); relative performance improvement increases with addition cells. Primitives should not be stripped
for best performance of the voxel mode.
int = obj.GetProcessModeMinValue () - Specify whether to visit each cell once per append or
each voxel once per append. Some tests have shown once per voxel to be faster when there are a lot of cells
(at least a thousand?); relative performance improvement increases with addition cells. Primitives should not
be stripped for best performance of the voxel mode.
int = obj.GetProcessModeMaxValue () - Specify whether to visit each cell once per append or
each voxel once per append. Some tests have shown once per voxel to be faster when there are a lot of cells
(at least a thousand?); relative performance improvement increases with addition cells. Primitives should not
be stripped for best performance of the voxel mode.
int = obj.GetProcessMode () - Specify whether to visit each cell once per append or each voxel
once per append. Some tests have shown once per voxel to be faster when there are a lot of cells (at least a
thousand?); relative performance improvement increases with addition cells. Primitives should not be stripped
for best performance of the voxel mode.
obj.SetProcessModeToPerVoxel () - Specify whether to visit each cell once per append or each
voxel once per append. Some tests have shown once per voxel to be faster when there are a lot of cells (at
least a thousand?); relative performance improvement increases with addition cells. Primitives should not be
stripped for best performance of the voxel mode.
obj.SetProcessModeToPerCell () - Specify whether to visit each cell once per append or each
voxel once per append. Some tests have shown once per voxel to be faster when there are a lot of cells (at
least a thousand?); relative performance improvement increases with addition cells. Primitives should not be
stripped for best performance of the voxel mode.
string = obj.GetProcessModeAsString (void ) - Specify whether to visit each cell once per
append or each voxel once per append. Some tests have shown once per voxel to be faster when there are a
lot of cells (at least a thousand?); relative performance improvement increases with addition cells. Primitives
should not be stripped for best performance of the voxel mode.
obj.SetLocatorMaxLevel (int ) - Specify the level of the locator to use when using the per voxel
process mode.
int = obj.GetLocatorMaxLevel () - Specify the level of the locator to use when using the per
voxel process mode.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.25 vtkIterativeClosestPointTransform
1517
obj.SetNumberOfThreads (int ) - Set / Get the number of threads used during Per-Voxel processing mode
int = obj.GetNumberOfThreadsMinValue () - Set / Get the number of threads used during
Per-Voxel processing mode
int = obj.GetNumberOfThreadsMaxValue () - Set / Get the number of threads used during
Per-Voxel processing mode
int = obj.GetNumberOfThreads () - Set / Get the number of threads used during Per-Voxel processing mode
obj.SetOutputScalarType (int type) - Set the desired output scalar type.
int = obj.GetOutputScalarType () - Set the desired output scalar type.
obj.SetOutputScalarTypeToFloat () - Set the desired output scalar type.
obj.SetOutputScalarTypeToDouble () - Set the desired output scalar type.
obj.SetOutputScalarTypeToInt () - Set the desired output scalar type.
obj.SetOutputScalarTypeToUnsignedInt () - Set the desired output scalar type.
obj.SetOutputScalarTypeToLong () - Set the desired output scalar type.
obj.SetOutputScalarTypeToUnsignedLong () - Set the desired output scalar type.
obj.SetOutputScalarTypeToShort () - Set the desired output scalar type.
obj.SetOutputScalarTypeToUnsignedShort () - Set the desired output scalar type.
obj.SetOutputScalarTypeToUnsignedChar () - Set the desired output scalar type.
obj.SetOutputScalarTypeToChar () - Set the desired output scalar type.
obj.StartAppend () - Initialize the filter for appending data. You must invoke the StartAppend() method
before doing successive Appends(). Its also a good idea to manually specify the model bounds; otherwise
the input bounds for the data will be used.
obj.Append (vtkDataSet input) - Append a data set to the existing output. To use this function,
youll have to invoke the StartAppend() method before doing successive appends. Its also a good idea to
specify the model bounds; otherwise the input model bounds is used. When youve finished appending, use
the EndAppend() method.
obj.EndAppend () - Method completes the append process.
35.25
vtkIterativeClosestPointTransform
35.25.1
Usage
Match two surfaces using the iterative closest point (ICP) algorithm. The core of the algorithm is to match each
vertex in one surface with the closest surface point on the other, then apply the transformation that modify one
surface to best match the other (in a least square sense). This has to be iterated to get proper convergence of the
surfaces. .SECTION Note Use vtkTransformPolyDataFilter to apply the resulting ICP transform to your data. You
might also set it to your actors user transform. .SECTION Note This class makes use of vtkLandmarkTransform
internally to compute the best fit. Use the GetLandmarkTransform member to get a pointer to that transform and set
its parameters. You might, for example, constrain the number of degrees of freedom of the solution (i.e. rigid body,
similarity, etc.) by checking the vtkLandmarkTransform documentation for its SetMode member.
To create an instance of class vtkIterativeClosestPointTransform, simply invoke its constructor as follows
obj = vtkIterativeClosestPointTransform
1518
35.25.2
Methods
The class vtkIterativeClosestPointTransform has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkIterativeClosestPointTransform class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkIterativeClosestPointTransform = obj.NewInstance ()
vtkIterativeClosestPointTransform = obj.SafeDownCast (vtkObject o)
obj.SetSource (vtkDataSet source) - Specify the source and target data sets.
obj.SetTarget (vtkDataSet target) - Specify the source and target data sets.
vtkDataSet = obj.GetSource () - Specify the source and target data sets.
vtkDataSet = obj.GetTarget () - Specify the source and target data sets.
obj.SetLocator (vtkCellLocator locator) - Set/Get a spatial locator for speeding up the
search process. An instance of vtkCellLocator is used by default.
vtkCellLocator = obj.GetLocator () - Set/Get a spatial locator for speeding up the search
process. An instance of vtkCellLocator is used by default.
obj.SetMaximumNumberOfIterations (int ) - Set/Get the maximum number of iterations. Default is 50.
int = obj.GetMaximumNumberOfIterations () - Set/Get the maximum number of iterations.
Default is 50.
int = obj.GetNumberOfIterations () - Get the number of iterations since the last update
obj.SetCheckMeanDistance (int ) - Force the algorithm to check the mean distance between
two iterations. Default is Off.
int = obj.GetCheckMeanDistance () - Force the algorithm to check the mean distance between
two iterations. Default is Off.
obj.CheckMeanDistanceOn () - Force the algorithm to check the mean distance between two iterations. Default is Off.
obj.CheckMeanDistanceOff () - Force the algorithm to check the mean distance between two iterations. Default is Off.
obj.SetMeanDistanceMode (int ) - Specify the mean distance mode. This mode expresses how
the mean distance is computed. The RMS mode is the square root of the average of the sum of squares
of the closest point distances. The Absolute Value mode is the mean of the sum of absolute values of the
closest point distances. The default is VTK_ICP_MODE_RMS
int = obj.GetMeanDistanceModeMinValue () - Specify the mean distance mode. This mode
expresses how the mean distance is computed. The RMS mode is the square root of the average of the sum
of squares of the closest point distances. The Absolute Value mode is the mean of the sum of absolute values
of the closest point distances. The default is VTK_ICP_MODE_RMS
int = obj.GetMeanDistanceModeMaxValue () - Specify the mean distance mode. This mode
expresses how the mean distance is computed. The RMS mode is the square root of the average of the sum
of squares of the closest point distances. The Absolute Value mode is the mean of the sum of absolute values
of the closest point distances. The default is VTK_ICP_MODE_RMS
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.26 vtkLandmarkTransform
1519
int = obj.GetMeanDistanceMode () - Specify the mean distance mode. This mode expresses
how the mean distance is computed. The RMS mode is the square root of the average of the sum of squares
of the closest point distances. The Absolute Value mode is the mean of the sum of absolute values of the
closest point distances. The default is VTK_ICP_MODE_RMS
obj.SetMeanDistanceModeToRMS () - Specify the mean distance mode. This mode expresses how
the mean distance is computed. The RMS mode is the square root of the average of the sum of squares of
the closest point distances. The Absolute Value mode is the mean of the sum of absolute values of the closest
point distances. The default is VTK_ICP_MODE_RMS
obj.SetMeanDistanceModeToAbsoluteValue () - Specify the mean distance mode. This mode
expresses how the mean distance is computed. The RMS mode is the square root of the average of the sum
of squares of the closest point distances. The Absolute Value mode is the mean of the sum of absolute values
of the closest point distances. The default is VTK_ICP_MODE_RMS
string = obj.GetMeanDistanceModeAsString () - Specify the mean distance mode. This
mode expresses how the mean distance is computed. The RMS mode is the square root of the average
of the sum of squares of the closest point distances. The Absolute Value mode is the mean of the sum of
absolute values of the closest point distances. The default is VTK_ICP_MODE_RMS
obj.SetMaximumMeanDistance (double ) - Set/Get the maximum mean distance between two
iteration. If the mean distance is lower than this, the convergence stops. The default is 0.01.
double = obj.GetMaximumMeanDistance () - Set/Get the maximum mean distance between
two iteration. If the mean distance is lower than this, the convergence stops. The default is 0.01.
double = obj.GetMeanDistance () - Get the mean distance between the last two iterations.
obj.SetMaximumNumberOfLandmarks (int ) - Set/Get the maximum number of landmarks sampled in your dataset. If your dataset is dense, then you will typically not need all the points to compute the
ICP transform. The default is 200.
int = obj.GetMaximumNumberOfLandmarks () - Set/Get the maximum number of landmarks
sampled in your dataset. If your dataset is dense, then you will typically not need all the points to compute
the ICP transform. The default is 200.
obj.SetStartByMatchingCentroids (int ) - Starts the process by translating source centroid
to target centroid. The default is Off.
int = obj.GetStartByMatchingCentroids () - Starts the process by translating source centroid to target centroid. The default is Off.
obj.StartByMatchingCentroidsOn () - Starts the process by translating source centroid to target
centroid. The default is Off.
obj.StartByMatchingCentroidsOff () - Starts the process by translating source centroid to target centroid. The default is Off.
vtkLandmarkTransform = obj.GetLandmarkTransform () - Get the internal landmark
transform. Use it to constrain the number of degrees of freedom of the solution (i.e. rigid body, similarity,
etc.).
obj.Inverse () - Invert the transformation. This is done by switching the source and target.
vtkAbstractTransform = obj.MakeTransform () - Make another transform of the same type.
35.26
vtkLandmarkTransform
1520
35.26.1
Usage
A vtkLandmarkTransform is defined by two sets of landmarks, the transform computed gives the best fit mapping
one onto the other, in a least squares sense. The indices are taken to correspond, so point 1 in the first set will get
mapped close to point 1 in the second set, etc. Call SetSourceLandmarks and SetTargetLandmarks to specify the
two sets of landmarks, ensure they have the same number of points.
To create an instance of class vtkLandmarkTransform, simply invoke its constructor as follows
obj = vtkLandmarkTransform
35.26.2
Methods
The class vtkLandmarkTransform has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkLandmarkTransform
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkLandmarkTransform = obj.NewInstance ()
vtkLandmarkTransform = obj.SafeDownCast (vtkObject o)
obj.SetSourceLandmarks (vtkPoints points) - Specify the source and target landmark sets.
The two sets must have the same number of points. If you add or change points in these objects, you must
call Modified() on them or the transformation might not update.
obj.SetTargetLandmarks (vtkPoints points) - Specify the source and target landmark sets.
The two sets must have the same number of points. If you add or change points in these objects, you must
call Modified() on them or the transformation might not update.
vtkPoints = obj.GetSourceLandmarks () - Specify the source and target landmark sets. The
two sets must have the same number of points. If you add or change points in these objects, you must call
Modified() on them or the transformation might not update.
vtkPoints = obj.GetTargetLandmarks () - Specify the source and target landmark sets. The
two sets must have the same number of points. If you add or change points in these objects, you must call
Modified() on them or the transformation might not update.
obj.SetMode (int ) - Set the number of degrees of freedom to constrain the solution to. Rigidbody
(VTK_LANDMARK_RIGIDBODY): rotation and translation only. Similarity (VTK_LANDMARK_SIMILARITY): rotation, translation and isotropic scaling. Affine (VTK_LANDMARK_AFFINE): collinearity is preserved.
Ratios of distances along a line are preserved. The default is similarity.
obj.SetModeToRigidBody () - Set the number of degrees of freedom to constrain the solution to.
Rigidbody (VTK_LANDMARK_RIGIDBODY): rotation and translation only. Similarity (VTK_LANDMARK_SIMILARITY): rotation, translation and isotropic scaling. Affine (VTK_LANDMARK_AFFINE): collinearity is
preserved. Ratios of distances along a line are preserved. The default is similarity.
obj.SetModeToSimilarity () - Set the number of degrees of freedom to constrain the solution to.
Rigidbody (VTK_LANDMARK_RIGIDBODY): rotation and translation only. Similarity (VTK_LANDMARK_SIMILARITY): rotation, translation and isotropic scaling. Affine (VTK_LANDMARK_AFFINE): collinearity is
preserved. Ratios of distances along a line are preserved. The default is similarity.
obj.SetModeToAffine () - Set the number of degrees of freedom to constrain the solution to. Rigidbody (VTK_LANDMARK_RIGIDBODY): rotation and translation only. Similarity (VTK_LANDMARK_SIMILARITY): rotation, translation and isotropic scaling. Affine (VTK_LANDMARK_AFFINE): collinearity is preserved. Ratios of distances along a line are preserved. The default is similarity.
int = obj.GetMode () - Get the current transformation mode.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.27 vtkLegendBoxActor
1521
35.27
vtkLegendBoxActor
35.27.1
Usage
vtkLegendBoxActor is used to associate a symbol with a text string. The user specifies a vtkPolyData to use as the
symbol, and a string associated with the symbol. The actor can then be placed in the scene in the same way that
any other vtkActor2D can be used.
To use this class, you must define the position of the legend box by using the superclasses vtkActor2D::Position
coordinate and Position2 coordinate. Then define the set of symbols and text strings that make up the menu box.
The font attributes of the entries can be set through the vtkTextProperty associated to this actor. The class will
scale the symbols and text to fit in the legend box defined by (Position,Position2). Optional features like turning on
a border line and setting the spacing between the border and the symbols/text can also be set.
To create an instance of class vtkLegendBoxActor, simply invoke its constructor as follows
obj = vtkLegendBoxActor
35.27.2
Methods
The class vtkLegendBoxActor has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkLegendBoxActor class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkLegendBoxActor = obj.NewInstance ()
vtkLegendBoxActor = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfEntries (int num) - Specify the number of entries in the legend box.
int = obj.GetNumberOfEntries () - Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is
assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when
this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color
is not specified, then the entry color is the same as this actors color.) (Note: use the set methods when you
use SetNumberOfEntries().)
obj.SetEntry (int i, vtkPolyData symbol, string string, double color[3])
- Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL)
and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and
the text is assumed to be a single line in height. Note that when this method is invoked previous entries are
deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the
same as this actors color.) (Note: use the set methods when you use SetNumberOfEntries().)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1522
obj.SetEntrySymbol (int i, vtkPolyData symbol) - Add an entry to the legend box. You
must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be
NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line
in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and
optionally a color. (If a color is not specified, then the entry color is the same as this actors color.) (Note: use
the set methods when you use SetNumberOfEntries().)
obj.SetEntryString (int i, string string) - Add an entry to the legend box. You must
supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL).
The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in
height. Note that when this method is invoked previous entries are deleted. Also supply a text string and
optionally a color. (If a color is not specified, then the entry color is the same as this actors color.) (Note: use
the set methods when you use SetNumberOfEntries().)
obj.SetEntryColor (int i, double color[3]) - Add an entry to the legend box. You must
supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL).
The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in
height. Note that when this method is invoked previous entries are deleted. Also supply a text string and
optionally a color. (If a color is not specified, then the entry color is the same as this actors color.) (Note: use
the set methods when you use SetNumberOfEntries().)
obj.SetEntryColor (int i, double r, double g, double b) - Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which
also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be
a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text
string and optionally a color. (If a color is not specified, then the entry color is the same as this actors color.)
(Note: use the set methods when you use SetNumberOfEntries().)
vtkPolyData = obj.GetEntrySymbol (int i) - Add an entry to the legend box. You must
supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL).
The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in
height. Note that when this method is invoked previous entries are deleted. Also supply a text string and
optionally a color. (If a color is not specified, then the entry color is the same as this actors color.) (Note: use
the set methods when you use SetNumberOfEntries().)
string = obj.GetEntryString (int i) - Add an entry to the legend box. You must supply a
vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note
that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color.
(If a color is not specified, then the entry color is the same as this actors color.) (Note: use the set methods
when you use SetNumberOfEntries().)
double = obj.GetEntryColor (int i) - Add an entry to the legend box. You must supply a
vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note
that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color.
(If a color is not specified, then the entry color is the same as this actors color.) (Note: use the set methods
when you use SetNumberOfEntries().)
obj.SetEntryTextProperty (vtkTextProperty p) - Set/Get the text property.
vtkTextProperty = obj.GetEntryTextProperty () - Set/Get the text property.
obj.SetBorder (int ) - Set/Get the flag that controls whether a border will be drawn around the
legend box.
int = obj.GetBorder () - Set/Get the flag that controls whether a border will be drawn around the
legend box.
obj.BorderOn () - Set/Get the flag that controls whether a border will be drawn around the legend box.
obj.BorderOff () - Set/Get the flag that controls whether a border will be drawn around the legend
box.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.28 vtkLegendScaleActor
1523
obj.SetLockBorder (int ) - Set/Get the flag that controls whether the border and legend placement
is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so
that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is
guaranteed to lie within the original border definition.
int = obj.GetLockBorder () - Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size
so that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is
guaranteed to lie within the original border definition.
obj.LockBorderOn () - Set/Get the flag that controls whether the border and legend placement is
locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so
that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is
guaranteed to lie within the original border definition.
obj.LockBorderOff () - Set/Get the flag that controls whether the border and legend placement is
locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so
that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is
guaranteed to lie within the original border definition.
obj.SetBox (int ) - Set/Get the flag that controls whether a box will be drawn/filled corresponding to
the legend box.
int = obj.GetBox () - Set/Get the flag that controls whether a box will be drawn/filled corresponding
to the legend box.
obj.BoxOn () - Set/Get the flag that controls whether a box will be drawn/filled corresponding to the
legend box.
obj.BoxOff () - Set/Get the flag that controls whether a box will be drawn/filled corresponding to the
legend box.
vtkProperty2D = obj.GetBoxProperty () - Get the box vtkProperty2D.
obj.SetPadding (int ) - Set/Get the padding between the legend entries and the border. The value
is specified in pixels.
int = obj.GetPaddingMinValue () - Set/Get the padding between the legend entries and the
border. The value is specified in pixels.
int = obj.GetPaddingMaxValue () - Set/Get the padding between the legend entries and the
border. The value is specified in pixels.
int = obj.GetPadding () - Set/Get the padding between the legend entries and the border. The
value is specified in pixels.
obj.SetScalarVisibility (int ) - Turn on/off flag to control whether the symbols scalar data is
used to color the symbol. If off, the color of the vtkLegendBoxActor is used.
int = obj.GetScalarVisibility () - Turn on/off flag to control whether the symbols scalar data
is used to color the symbol. If off, the color of the vtkLegendBoxActor is used.
obj.ScalarVisibilityOn () - Turn on/off flag to control whether the symbols scalar data is used to
color the symbol. If off, the color of the vtkLegendBoxActor is used.
obj.ScalarVisibilityOff () - Turn on/off flag to control whether the symbols scalar data is used
to color the symbol. If off, the color of the vtkLegendBoxActor is used.
obj.ShallowCopy (vtkProp prop) - Shallow copy of this scaled text actor. Overloads the virtual
vtkProp method.
35.28
vtkLegendScaleActor
1524
35.28.1
Usage
This class is used to annotate the render window. Its basic goal is to provide an indication of the scale of the scene.
Four axes surrounding the render window indicate (in a variety of ways) the scale of what the camera is viewing. An
option also exists for displaying a scale legend.
The axes can be programmed either to display distance scales or x-y coordinate values. By default, the scales
display a distance. However, if you know that the view is down the z-axis, the scales can be programmed to display
x-y coordinate values.
To create an instance of class vtkLegendScaleActor, simply invoke its constructor as follows
obj = vtkLegendScaleActor
35.28.2
Methods
The class vtkLegendScaleActor has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkLegendScaleActor class.
string = obj.GetClassName () - Standard methods for the class.
int = obj.IsA (string name) - Standard methods for the class.
vtkLegendScaleActor = obj.NewInstance () - Standard methods for the class.
vtkLegendScaleActor = obj.SafeDownCast (vtkObject o) - Standard methods for the
class.
obj.SetLabelMode (int ) - Specify the mode for labeling the scale axes. By default, the axes are
labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the
view is down the z-axis; the axes can be labeled with x-y coordinate values.
int = obj.GetLabelModeMinValue () - Specify the mode for labeling the scale axes. By default,
the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you
know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.
int = obj.GetLabelModeMaxValue () - Specify the mode for labeling the scale axes. By default,
the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you
know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.
int = obj.GetLabelMode () - Specify the mode for labeling the scale axes. By default, the axes are
labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the
view is down the z-axis; the axes can be labeled with x-y coordinate values.
obj.SetLabelModeToDistance () - Specify the mode for labeling the scale axes. By default, the
axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know
that the view is down the z-axis; the axes can be labeled with x-y coordinate values.
obj.SetLabelModeToXYCoordinates () - Set/Get the flags that control which of the four axes to
display (top, bottom, left and right). By default, all the axes are displayed.
obj.SetRightAxisVisibility (int ) - Set/Get the flags that control which of the four axes to
display (top, bottom, left and right). By default, all the axes are displayed.
int = obj.GetRightAxisVisibility () - Set/Get the flags that control which of the four axes to
display (top, bottom, left and right). By default, all the axes are displayed.
obj.RightAxisVisibilityOn () - Set/Get the flags that control which of the four axes to display
(top, bottom, left and right). By default, all the axes are displayed.
obj.RightAxisVisibilityOff () - Set/Get the flags that control which of the four axes to display
(top, bottom, left and right). By default, all the axes are displayed.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.28 vtkLegendScaleActor
1525
obj.SetTopAxisVisibility (int ) - Set/Get the flags that control which of the four axes to display
(top, bottom, left and right). By default, all the axes are displayed.
int = obj.GetTopAxisVisibility () - Set/Get the flags that control which of the four axes to
display (top, bottom, left and right). By default, all the axes are displayed.
obj.TopAxisVisibilityOn () - Set/Get the flags that control which of the four axes to display (top,
bottom, left and right). By default, all the axes are displayed.
obj.TopAxisVisibilityOff () - Set/Get the flags that control which of the four axes to display (top,
bottom, left and right). By default, all the axes are displayed.
obj.SetLeftAxisVisibility (int ) - Set/Get the flags that control which of the four axes to
display (top, bottom, left and right). By default, all the axes are displayed.
int = obj.GetLeftAxisVisibility () - Set/Get the flags that control which of the four axes to
display (top, bottom, left and right). By default, all the axes are displayed.
obj.LeftAxisVisibilityOn () - Set/Get the flags that control which of the four axes to display (top,
bottom, left and right). By default, all the axes are displayed.
obj.LeftAxisVisibilityOff () - Set/Get the flags that control which of the four axes to display
(top, bottom, left and right). By default, all the axes are displayed.
obj.SetBottomAxisVisibility (int ) - Set/Get the flags that control which of the four axes to
display (top, bottom, left and right). By default, all the axes are displayed.
int = obj.GetBottomAxisVisibility () - Set/Get the flags that control which of the four axes
to display (top, bottom, left and right). By default, all the axes are displayed.
obj.BottomAxisVisibilityOn () - Set/Get the flags that control which of the four axes to display
(top, bottom, left and right). By default, all the axes are displayed.
obj.BottomAxisVisibilityOff () - Set/Get the flags that control which of the four axes to display
(top, bottom, left and right). By default, all the axes are displayed.
obj.SetLegendVisibility (int ) - Indicate whether the legend scale should be displayed or not.
The default is On.
int = obj.GetLegendVisibility () - Indicate whether the legend scale should be displayed or
not. The default is On.
obj.LegendVisibilityOn () - Indicate whether the legend scale should be displayed or not. The
default is On.
obj.LegendVisibilityOff () - Indicate whether the legend scale should be displayed or not. The
default is On.
obj.AllAxesOn () - Convenience method that turns all the axes either on or off.
obj.AllAxesOff () - Convenience method that turns all the axes either on or off.
obj.AllAnnotationsOn () - Convenience method that turns all the axes and the legend scale.
obj.AllAnnotationsOff () - Convenience method that turns all the axes and the legend scale.
obj.SetRightBorderOffset (int ) - Set/Get the offset of the right axis from the border. This
number is expressed in pixels, and represents the approximate distance of the axes from the sides of the
renderer. The default is 50.
int = obj.GetRightBorderOffsetMinValue () - Set/Get the offset of the right axis from the
border. This number is expressed in pixels, and represents the approximate distance of the axes from the
sides of the renderer. The default is 50.
int = obj.GetRightBorderOffsetMaxValue () - Set/Get the offset of the right axis from the
border. This number is expressed in pixels, and represents the approximate distance of the axes from the
sides of the renderer. The default is 50.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1526
int = obj.GetRightBorderOffset () - Set/Get the offset of the right axis from the border. This
number is expressed in pixels, and represents the approximate distance of the axes from the sides of the
renderer. The default is 50.
obj.SetTopBorderOffset (int ) - Set/Get the offset of the top axis from the border. This number
is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer.
The default is 30.
int = obj.GetTopBorderOffsetMinValue () - Set/Get the offset of the top axis from the border.
This number is expressed in pixels, and represents the approximate distance of the axes from the sides of
the renderer. The default is 30.
int = obj.GetTopBorderOffsetMaxValue () - Set/Get the offset of the top axis from the border.
This number is expressed in pixels, and represents the approximate distance of the axes from the sides of
the renderer. The default is 30.
int = obj.GetTopBorderOffset () - Set/Get the offset of the top axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer.
The default is 30.
obj.SetLeftBorderOffset (int ) - Set/Get the offset of the left axis from the border. This number
is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer.
The default is 50.
int = obj.GetLeftBorderOffsetMinValue () - Set/Get the offset of the left axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides
of the renderer. The default is 50.
int = obj.GetLeftBorderOffsetMaxValue () - Set/Get the offset of the left axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides
of the renderer. The default is 50.
int = obj.GetLeftBorderOffset () - Set/Get the offset of the left axis from the border. This
number is expressed in pixels, and represents the approximate distance of the axes from the sides of the
renderer. The default is 50.
obj.SetBottomBorderOffset (int ) - Set/Get the offset of the bottom axis from the border. This
number is expressed in pixels, and represents the approximate distance of the axes from the sides of the
renderer. The default is 30.
int = obj.GetBottomBorderOffsetMinValue () - Set/Get the offset of the bottom axis from
the border. This number is expressed in pixels, and represents the approximate distance of the axes from the
sides of the renderer. The default is 30.
int = obj.GetBottomBorderOffsetMaxValue () - Set/Get the offset of the bottom axis from
the border. This number is expressed in pixels, and represents the approximate distance of the axes from the
sides of the renderer. The default is 30.
int = obj.GetBottomBorderOffset () - Set/Get the offset of the bottom axis from the border.
This number is expressed in pixels, and represents the approximate distance of the axes from the sides of
the renderer. The default is 30.
obj.SetCornerOffsetFactor (double ) - Get/Set the corner offset. This is the offset factor used
to offset the axes at the corners. Default value is 2.0.
double = obj.GetCornerOffsetFactorMinValue () - Get/Set the corner offset. This is the
offset factor used to offset the axes at the corners. Default value is 2.0.
double = obj.GetCornerOffsetFactorMaxValue () - Get/Set the corner offset. This is the
offset factor used to offset the axes at the corners. Default value is 2.0.
double = obj.GetCornerOffsetFactor () - Get/Set the corner offset. This is the offset factor
used to offset the axes at the corners. Default value is 2.0.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.29 vtkLSDynaReader
1527
35.29
vtkLSDynaReader
35.29.1
Usage
1528
35.29.2
Methods
The class vtkLSDynaReader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkLSDynaReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkLSDynaReader = obj.NewInstance ()
vtkLSDynaReader = obj.SafeDownCast (vtkObject o)
obj.DebugDump () - A routine to call Dump() from within a lame debugger that wont properly pass a
C++ iostream object like cout.
int = obj.CanReadFile (string fname) - Determine if the file can be readed with this reader.
obj.SetDatabaseDirectory (string ) - Get/Set the directory containing the LS-Dyna database
and determine whether it is valid.
string = obj.GetDatabaseDirectory () - Get/Set the directory containing the LS-Dyna
database and determine whether it is valid.
int = obj.IsDatabaseValid () - Get/Set the directory containing the LS-Dyna database and determine whether it is valid.
obj.SetFileName (string ) - Get/Set the filename. The Set/GetFileName() routines are actually
wrappers around the Set/GetDatabaseDirectory() members; the actual filename you choose is irrelevant
only the directory name is used. This is done in order to accommodate ParaView.
string = obj.GetFileName () - Get/Set the filename. The Set/GetFileName() routines are actually
wrappers around the Set/GetDatabaseDirectory() members; the actual filename you choose is irrelevant
only the directory name is used. This is done in order to accommodate ParaView.
string = obj.GetTitle () - The title of the database is a 40 or 80 character text description stored
at the front of a d3plot file. Do not call this function before setting the database directory and calling UpdateInformation().
int = obj.GetDimensionality () - Retrieve the dimension of points in the database. This should
return 2 or 3. Do not call this function before setting the database directory and calling UpdateInformation().
vtkIdType = obj.GetNumberOfNodes () - Retrieve the number of points in the database. Do not
call this function before setting the database directory and calling UpdateInformation().
vtkIdType = obj.GetNumberOfCells () - Retrieve the number of cells of a given type in the
database. Do not call this function before setting the database directory and calling UpdateInformation().
Note that GetNumberOfCells() returns the sum of GetNumberOfContinuumCells() and GetNumberOfParticleCells().
vtkIdType = obj.GetNumberOfContinuumCells () - Retrieve the number of cells of a given
type in the database. Do not call this function before setting the database directory and calling UpdateInformation().
Note that GetNumberOfContinuumCells() returns the sum of GetNumberOfSolidCells(), GetNumberOfThickShellCells(), GetNumberOfShellCells(), GetNumberOfRigidBodyCells(), GetNumberOfRoadSurfaceCells(),
and GetNumberOfBeamCells().
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.29 vtkLSDynaReader
1529
1530
int = obj.GetPointArrayStatus (string arrName) - These methods allow you to load only
selected subsets of the nodal variables defined over the mesh.
int = obj.GetNumberOfComponentsInPointArray (int arr) - These methods allow you
to load only selected subsets of the nodal variables defined over the mesh.
int = obj.GetNumberOfComponentsInPointArray (string arrName) - These methods
allow you to load only selected subsets of the nodal variables defined over the mesh.
int = obj.GetNumberOfCellArrays (int cellType) - Routines that allow the status of a cell
variable to be adjusted or queried independent of the output mesh. The cellType parameter should be one
of: LS_POINT, LS_BEAM, LS_SHELL, LS_THICK_SHELL, LS_SOLID, LS_RIGID_BODY, or LS_ROAD_SURFACE
string = obj.GetCellArrayName (int cellType, int arr) - Routines that allow the
status of a cell variable to be adjusted or queried independent of the output mesh. The cellType parameter should be one of: LS_POINT, LS_BEAM, LS_SHELL, LS_THICK_SHELL, LS_SOLID, LS_RIGID_BODY,
or LS_ROAD_SURFACE
obj.SetCellArrayStatus (int cellType, int arr, int status) - Routines that allow
the status of a cell variable to be adjusted or queried independent of the output mesh. The cellType parameter
should be one of: LS_POINT, LS_BEAM, LS_SHELL, LS_THICK_SHELL, LS_SOLID, LS_RIGID_BODY, or
LS_ROAD_SURFACE
obj.SetCellArrayStatus (int cellType, string arrName, int status) - Routines that allow the status of a cell variable to be adjusted or queried independent of the output mesh. The
cellType parameter should be one of: LS_POINT, LS_BEAM, LS_SHELL, LS_THICK_SHELL, LS_SOLID,
LS_RIGID_BODY, or LS_ROAD_SURFACE
int = obj.GetCellArrayStatus (int cellType, int arr) - Routines that allow the status of a cell variable to be adjusted or queried independent of the output mesh. The cellType parameter
should be one of: LS_POINT, LS_BEAM, LS_SHELL, LS_THICK_SHELL, LS_SOLID, LS_RIGID_BODY, or
LS_ROAD_SURFACE
int = obj.GetCellArrayStatus (int cellType, string arrName) - Routines that allow the status of a cell variable to be adjusted or queried independent of the output mesh. The cellType
parameter should be one of: LS_POINT, LS_BEAM, LS_SHELL, LS_THICK_SHELL, LS_SOLID, LS_RIGID_BODY, or LS_ROAD_SURFACE
int = obj.GetNumberOfComponentsInCellArray (int cellType, int arr) - Routines that allow the status of a cell variable to be adjusted or queried independent of the output mesh. The
cellType parameter should be one of: LS_POINT, LS_BEAM, LS_SHELL, LS_THICK_SHELL, LS_SOLID,
LS_RIGID_BODY, or LS_ROAD_SURFACE
int = obj.GetNumberOfComponentsInCellArray (int cellType, string arrName) - Routines that allow the status of a cell variable to be adjusted or queried independent of the
output mesh. The cellType parameter should be one of: LS_POINT, LS_BEAM, LS_SHELL, LS_THICK_SHELL, LS_SOLID, LS_RIGID_BODY, or LS_ROAD_SURFACE
int = obj.GetNumberOfSolidArrays () - These methods allow you to load only selected subsets of the cell variables defined over the mesh.
string = obj.GetSolidArrayName (int ) - These methods allow you to load only selected
subsets of the cell variables defined over the mesh.
obj.SetSolidArrayStatus (int arr, int status) - These methods allow you to load only
selected subsets of the cell variables defined over the mesh.
obj.SetSolidArrayStatus (string arrName, int status) - These methods allow you to
load only selected subsets of the cell variables defined over the mesh.
int = obj.GetSolidArrayStatus (int arr) - These methods allow you to load only selected
subsets of the cell variables defined over the mesh.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.29 vtkLSDynaReader
1531
int = obj.GetSolidArrayStatus (string arrName) - These methods allow you to load only
selected subsets of the cell variables defined over the mesh.
int = obj.GetNumberOfComponentsInSolidArray (int a)
int = obj.GetNumberOfComponentsInSolidArray (string arrName)
int = obj.GetNumberOfThickShellArrays () - These methods allow you to load only selected
subsets of the cell variables defined over the mesh.
string = obj.GetThickShellArrayName (int ) - These methods allow you to load only selected subsets of the cell variables defined over the mesh.
obj.SetThickShellArrayStatus (int arr, int status) - These methods allow you to
load only selected subsets of the cell variables defined over the mesh.
obj.SetThickShellArrayStatus (string arrName, int status) - These methods allow you to load only selected subsets of the cell variables defined over the mesh.
int = obj.GetThickShellArrayStatus (int arr) - These methods allow you to load only
selected subsets of the cell variables defined over the mesh.
int = obj.GetThickShellArrayStatus (string arrName) - These methods allow you to
load only selected subsets of the cell variables defined over the mesh.
int = obj.GetNumberOfComponentsInThickShellArray (int a)
int = obj.GetNumberOfComponentsInThickShellArray (string arrName)
int = obj.GetNumberOfShellArrays () - These methods allow you to load only selected subsets of the cell variables defined over the mesh.
string = obj.GetShellArrayName (int ) - These methods allow you to load only selected
subsets of the cell variables defined over the mesh.
obj.SetShellArrayStatus (int arr, int status) - These methods allow you to load only
selected subsets of the cell variables defined over the mesh.
obj.SetShellArrayStatus (string arrName, int status) - These methods allow you to
load only selected subsets of the cell variables defined over the mesh.
int = obj.GetShellArrayStatus (int arr) - These methods allow you to load only selected
subsets of the cell variables defined over the mesh.
int = obj.GetShellArrayStatus (string arrName) - These methods allow you to load only
selected subsets of the cell variables defined over the mesh.
int = obj.GetNumberOfComponentsInShellArray (int a)
int = obj.GetNumberOfComponentsInShellArray (string arrName)
int = obj.GetNumberOfRigidBodyArrays () - These methods allow you to load only selected
subsets of the cell variables defined over the mesh.
string = obj.GetRigidBodyArrayName (int ) - These methods allow you to load only selected subsets of the cell variables defined over the mesh.
obj.SetRigidBodyArrayStatus (int arr, int status) - These methods allow you to load
only selected subsets of the cell variables defined over the mesh.
obj.SetRigidBodyArrayStatus (string arrName, int status) - These methods allow
you to load only selected subsets of the cell variables defined over the mesh.
int = obj.GetRigidBodyArrayStatus (int arr) - These methods allow you to load only selected subsets of the cell variables defined over the mesh.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1532
35.29 vtkLSDynaReader
1533
1534
string = obj.GetInputDeck () - The name of the input deck corresponding to the current
database. This is used to determine the part names associated with each material ID. This file may be in
two formats: a valid LSDyna input deck or a short XML summary. If the file begins with "<?xml" then the
summary format is used. Otherwise, the keyword format is used and a summary file will be created if write
permissions exist in the directory containing the keyword file. The newly created summary will have ".k" or
".key" stripped from the end of the keyword filename and ".lsdyna" appended.
int = obj.GetNumberOfPartArrays () - These methods allow you to load only selected parts of
the input. If InputDeck points to a valid keyword file (or summary), then part names will be taken from that file.
Otherwise, when arbitrary material numbering is used, parts will be named "PartXXX (MatlYYY)" where XXX
is an increasing sequential number and YYY is the respective material ID. If no input deck is specified and
arbitrary arbitrary material numbering is not used, parts will be named "PartXXX" where XXX is a sequential
material ID.
string = obj.GetPartArrayName (int ) - These methods allow you to load only selected parts
of the input. If InputDeck points to a valid keyword file (or summary), then part names will be taken from
that file. Otherwise, when arbitrary material numbering is used, parts will be named "PartXXX (MatlYYY)"
where XXX is an increasing sequential number and YYY is the respective material ID. If no input deck is
specified and arbitrary arbitrary material numbering is not used, parts will be named "PartXXX" where XXX is
a sequential material ID.
obj.SetPartArrayStatus (int arr, int status) - These methods allow you to load only
selected parts of the input. If InputDeck points to a valid keyword file (or summary), then part names will be
taken from that file. Otherwise, when arbitrary material numbering is used, parts will be named "PartXXX
(MatlYYY)" where XXX is an increasing sequential number and YYY is the respective material ID. If no input
deck is specified and arbitrary arbitrary material numbering is not used, parts will be named "PartXXX" where
XXX is a sequential material ID.
obj.SetPartArrayStatus (string partName, int status) - These methods allow you to
load only selected parts of the input. If InputDeck points to a valid keyword file (or summary), then part names
will be taken from that file. Otherwise, when arbitrary material numbering is used, parts will be named "PartXXX (MatlYYY)" where XXX is an increasing sequential number and YYY is the respective material ID. If no
input deck is specified and arbitrary arbitrary material numbering is not used, parts will be named "PartXXX"
where XXX is a sequential material ID.
int = obj.GetPartArrayStatus (int arr) - These methods allow you to load only selected
parts of the input. If InputDeck points to a valid keyword file (or summary), then part names will be taken from
that file. Otherwise, when arbitrary material numbering is used, parts will be named "PartXXX (MatlYYY)"
where XXX is an increasing sequential number and YYY is the respective material ID. If no input deck is
specified and arbitrary arbitrary material numbering is not used, parts will be named "PartXXX" where XXX is
a sequential material ID.
int = obj.GetPartArrayStatus (string partName) - These methods allow you to load only
selected parts of the input. If InputDeck points to a valid keyword file (or summary), then part names will be
taken from that file. Otherwise, when arbitrary material numbering is used, parts will be named "PartXXX
(MatlYYY)" where XXX is an increasing sequential number and YYY is the respective material ID. If no input
deck is specified and arbitrary arbitrary material numbering is not used, parts will be named "PartXXX" where
XXX is a sequential material ID.
35.30
vtkPCAAnalysisFilter
35.30.1
Usage
vtkPCAAnalysisFilter is a filter that takes as input a set of aligned pointsets (any object derived from vtkPointSet)
and performs a principal component analysis of the coordinates. This can be used to visualise the major or minor
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.30 vtkPCAAnalysisFilter
1535
modes of variation seen in a set of similar biological objects with corresponding landmarks. vtkPCAAnalysisFilter is
designed to work with the output from the vtkProcrustesAnalysisFilter
Call SetNumberOfInputs(n) before calling SetInput(0) ... SetInput(n-1). Retrieve the outputs using GetOutput(0) ...
GetOutput(n-1).
vtkPCAAnalysisFilter is an implementation of (for example):
T. Cootes et al. : Active Shape Models - their training and application. Computer Vision and Image Understanding,
61(1):38-59, 1995.
The material can also be found in Tim Cootes ever-changing online report published at his website: http-
://www.isbe.man.ac.uk/bim/
To create an instance of class vtkPCAAnalysisFilter, simply invoke its constructor as follows
obj = vtkPCAAnalysisFilter
35.30.2
Methods
The class vtkPCAAnalysisFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPCAAnalysisFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPCAAnalysisFilter = obj.NewInstance ()
vtkPCAAnalysisFilter = obj.SafeDownCast (vtkObject o)
vtkFloatArray = obj.GetEvals () - Get the vector of eigenvalues sorted in descending order
obj.SetNumberOfInputs (int n) - Specify how many pointsets are going to be given as input.
obj.SetInput (int idx, vtkPointSet p) - Specify the input pointset with index idx. Call SetNumberOfInputs before calling this function.
obj.SetInput (int idx, vtkDataObject input) - Specify the input pointset with index idx.
Call SetNumberOfInputs before calling this function.
vtkPointSet = obj.GetInput (int idx) - Retrieve the input with index idx (usually only used
for pipeline tracing).
obj.GetParameterisedShape (vtkFloatArray b, vtkPointSet shape) - Fills the
shape with:
mean + b[0] sqrt(eigenvalue[0]) eigenvector[0]
b[1] sqrt(eigenvalue[1]) eigenvector[1] ...
b[sizeb-1] sqrt(eigenvalue[bsize-1]) eigenvector[bsize-1]
here b are the parameters expressed in standard deviations bsize is the number of parameters in the b vector
This function assumes that shape is allready allocated with the right size, it just moves the points.
obj.GetShapeParameters (vtkPointSet shape, vtkFloatArray b, int bsize) Return the bsize parameters b that best model the given shape (in standard deviations). That is that the
given shape will be approximated by:
shape mean + b[0] sqrt(eigenvalue[0]) eigenvector[0]
b[1] sqrt(eigenvalue[1]) eigenvector[1] ...
b[bsize-1] sqrt(eigenvalue[bsize-1]) eigenvector[bsize-1]
int = obj.GetModesRequiredFor (double proportion) - Retrieve how many modes are
necessary to model the given proportion of the variation. proportion should be between 0 and 1
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1536
35.31
vtkPExodusIIReader
35.31.1
Usage
vtkPExodusIIReader is a unstructured grid source object that reads ExodusII files. Most of the meta data associated
with the file is loaded when UpdateInformation is called. This includes information like Title, number of blocks,
number and names of arrays. This data can be retrieved from methods in this reader. Separate arrays that are
meant to be a single vector, are combined internally for convenience. To be combined, the array names have to be
identical except for a trailing X,Y and Z (or x,y,z). By default all cell and point arrays are loaded. However, the user
can flag arrays not to load with the methods "SetPointDataArrayLoadFlag" and "SetCellDataArrayLoadFlag". The
reader responds to piece requests by loading only a range of the possible blocks. Unused points are filtered out
internally.
To create an instance of class vtkPExodusIIReader, simply invoke its constructor as follows
obj = vtkPExodusIIReader
35.31.2
Methods
The class vtkPExodusIIReader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkPExodusIIReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPExodusIIReader = obj.NewInstance ()
vtkPExodusIIReader = obj.SafeDownCast (vtkObject o)
obj.SetController (vtkMultiProcessController c) - Set/get the communication object
used to relay a list of files from the rank 0 process to all others. This is the only interprocess communication
required by vtkPExodusIIReader.
vtkMultiProcessController = obj.GetController () - Set/get the communication object
used to relay a list of files from the rank 0 process to all others. This is the only interprocess communication
required by vtkPExodusIIReader.
obj.SetFilePattern (string ) - These methods tell the reader that the data is ditributed across
multiple files. This is for distributed execution. It this case, pieces are mapped to files. The pattern should have
one d to format the file number. FileNumberRange is used to generate file numbers. I was thinking of having
an arbitrary list of file numbers. This may happen in the future. (That is why there is no GetFileNumberRange
method.
string = obj.GetFilePattern () - These methods tell the reader that the data is ditributed
across multiple files. This is for distributed execution. It this case, pieces are mapped to files. The pattern should have one d to format the file number. FileNumberRange is used to generate file numbers. I was
thinking of having an arbitrary list of file numbers. This may happen in the future. (That is why there is no
GetFileNumberRange method.
obj.SetFilePrefix (string ) - These methods tell the reader that the data is ditributed across
multiple files. This is for distributed execution. It this case, pieces are mapped to files. The pattern should
have one d to format the file number. FileNumberRange is used to generate file numbers. I was thinking
of having an arbitrary list of file numbers. This may happen in the future. (That is why there is no GetFileNumberRange method.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.32 vtkPExodusReader
1537
string = obj.GetFilePrefix () - These methods tell the reader that the data is ditributed across
multiple files. This is for distributed execution. It this case, pieces are mapped to files. The pattern should have
one d to format the file number. FileNumberRange is used to generate file numbers. I was thinking of having
an arbitrary list of file numbers. This may happen in the future. (That is why there is no GetFileNumberRange
method.
obj.SetFileRange (int , int ) - Set the range of files that are being loaded. The range for single
file should add to 0.
obj.SetFileRange (int r) - Set the range of files that are being loaded. The range for single file
should add to 0.
int = obj. GetFileRange () - Set the range of files that are being loaded. The range for single
file should add to 0.
obj.SetFileName (string name)
int = obj.GetNumberOfFileNames () - Return the number of files to be read.
int = obj.GetNumberOfFiles () - Return the number of files to be read.
vtkIdType = obj.GetTotalNumberOfElements ()
vtkIdType = obj.GetTotalNumberOfNodes ()
obj.UpdateTimeInformation () - Calls UpdateTimeInformation() on all serial readers so theyll
re-read their time info from the file. The last time step that they all have in common is stored in LastCommonTimeStep, which is used in RequestInformation() to override the output time-specific information keys with
the range of times that ALL readers can actually read.
obj.Broadcast (vtkMultiProcessController ctrl) - Sends metadata (that read from the
input file, not settings modified through this API) from the rank 0 node to all other processes in a job.
35.32
vtkPExodusReader
35.32.1
Usage
vtkPExodusReader is a unstructured grid source object that reads PExodusReaderII files. Most of the meta data
associated with the file is loaded when UpdateInformation is called. This includes information like Title, number of
blocks, number and names of arrays. This data can be retrieved from methods in this reader. Separate arrays that
are meant to be a single vector, are combined internally for convenience. To be combined, the array names have to
be identical except for a trailing X,Y and Z (or x,y,z). By default all cell and point arrays are loaded. However, the
user can flag arrays not to load with the methods "SetPointDataArrayLoadFlag" and "SetCellDataArrayLoadFlag".
The reader responds to piece requests by loading only a range of the possible blocks. Unused points are filtered
out internally.
To create an instance of class vtkPExodusReader, simply invoke its constructor as follows
obj = vtkPExodusReader
35.32.2
Methods
The class vtkPExodusReader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkPExodusReader class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1538
35.33 vtkPieChartActor
1539
35.33
vtkPieChartActor
35.33.1
Usage
vtkPieChartActor generates a pie chart from an array of numbers defined in field data (a vtkDataObject). To use this
class, you must specify an input data object. Youll probably also want to specify the position of the plot be setting
the Position and Position2 instance variables, which define a rectangle in which the plot lies. There are also many
other instance variables that control the look of the plot includes its title, and legend.
Set the text property/attributes of the title and the labels through the vtkTextProperty objects associated with these
components.
To create an instance of class vtkPieChartActor, simply invoke its constructor as follows
obj = vtkPieChartActor
35.33.2
Methods
The class vtkPieChartActor has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkPieChartActor class.
string = obj.GetClassName () - Standard methods for type information and printing.
int = obj.IsA (string name) - Standard methods for type information and printing.
vtkPieChartActor = obj.NewInstance () - Standard methods for type information and printing.
vtkPieChartActor = obj.SafeDownCast (vtkObject o) - Standard methods for type information and printing.
obj.SetInput (vtkDataObject ) - Set the input to the pie chart actor.
vtkDataObject = obj.GetInput () - Get the input data object to this actor.
obj.SetTitleVisibility (int ) - Enable/Disable the display of a plot title.
int = obj.GetTitleVisibility () - Enable/Disable the display of a plot title.
obj.TitleVisibilityOn () - Enable/Disable the display of a plot title.
obj.TitleVisibilityOff () - Enable/Disable the display of a plot title.
obj.SetTitle (string ) - Set/Get the title of the pie chart.
string = obj.GetTitle () - Set/Get the title of the pie chart.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1540
obj.SetTitleTextProperty (vtkTextProperty p) - Set/Get the title text property. The property controls the appearance of the plot title.
vtkTextProperty = obj.GetTitleTextProperty () - Set/Get the title text property. The
property controls the appearance of the plot title.
obj.SetLabelVisibility (int ) - Enable/Disable the display of pie piece labels.
int = obj.GetLabelVisibility () - Enable/Disable the display of pie piece labels.
obj.LabelVisibilityOn () - Enable/Disable the display of pie piece labels.
obj.LabelVisibilityOff () - Enable/Disable the display of pie piece labels.
obj.SetLabelTextProperty (vtkTextProperty p) - Set/Get the labels text property. This
controls the appearance of all pie piece labels.
vtkTextProperty = obj.GetLabelTextProperty () - Set/Get the labels text property. This
controls the appearance of all pie piece labels.
obj.SetPieceColor (int i, double r, double g, double b) - Specify colors for each
piece of pie. If not specified, they are automatically generated.
obj.SetPieceColor (int i, double color[3]) - Specify colors for each piece of pie. If not
specified, they are automatically generated.
obj.SetPieceLabel (int i, string ) - Specify the names for each piece of pie. not specified,
then an integer number is automatically generated.
string = obj.GetPieceLabel (int i) - Specify the names for each piece of pie. not specified,
then an integer number is automatically generated.
obj.SetLegendVisibility (int ) - Enable/Disable the creation of a legend. If on, the legend
labels will be created automatically unless the per plot legend symbol has been set.
int = obj.GetLegendVisibility () - Enable/Disable the creation of a legend. If on, the legend
labels will be created automatically unless the per plot legend symbol has been set.
obj.LegendVisibilityOn () - Enable/Disable the creation of a legend. If on, the legend labels will
be created automatically unless the per plot legend symbol has been set.
obj.LegendVisibilityOff () - Enable/Disable the creation of a legend. If on, the legend labels will
be created automatically unless the per plot legend symbol has been set.
vtkLegendBoxActor = obj.GetLegendActor () - Retrieve handles to the legend box. This is
useful if you would like to manually control the legend appearance.
int = obj.RenderOverlay (vtkViewport ) - Draw the pie plot.
int = obj.RenderOpaqueGeometry (vtkViewport ) - Draw the pie plot.
int = obj.RenderTranslucentPolygonalGeometry (vtkViewport ) - Does this prop
have some translucent polygonal geometry?
int = obj.HasTranslucentPolygonalGeometry () - Does this prop have some translucent
polygonal geometry?
obj.ReleaseGraphicsResources (vtkWindow ) - Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to
release.
35.34
vtkPolyDataSilhouette
35.34 vtkPolyDataSilhouette
35.34.1
1541
Usage
vtkPolyDataSilhouette extracts a subset of a polygonal mesh edges to generate an outline (silhouette) of the corresponding 3D object. In addition, this filter can also extracts sharp edges (aka feature angles). In order to use this
filter you must specify the a point of view (origin) or a direction (vector). given this direction or origin, a silhouette is
generated wherever the surfaces normal is orthogonal to the view direction.
To create an instance of class vtkPolyDataSilhouette, simply invoke its constructor as follows
obj = vtkPolyDataSilhouette
35.34.2
Methods
The class vtkPolyDataSilhouette has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPolyDataSilhouette class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPolyDataSilhouette = obj.NewInstance ()
vtkPolyDataSilhouette = obj.SafeDownCast (vtkObject o)
obj.SetEnableFeatureAngle (int ) - Enables or Disables generation of silhouette edges along
sharp edges
int = obj.GetEnableFeatureAngle () - Enables or Disables generation of silhouette edges
along sharp edges
obj.SetFeatureAngle (double ) - Sets/Gets minimal angle for sharp edges detection. Default is
60
double = obj.GetFeatureAngle () - Sets/Gets minimal angle for sharp edges detection. Default
is 60
obj.SetBorderEdges (int ) - Enables or Disables generation of border edges. Note: borders exist
only in case of non closed surface
int = obj.GetBorderEdges () - Enables or Disables generation of border edges. Note: borders
exist only in case of non closed surface
obj.BorderEdgesOn () - Enables or Disables generation of border edges. Note: borders exist only in
case of non closed surface
obj.BorderEdgesOff () - Enables or Disables generation of border edges. Note: borders exist only
in case of non closed surface
obj.SetPieceInvariant (int ) - Enables or Disables piece invariance. This is usefull when dealing with multi-block data sets. Note: requires one level of ghost cells
int = obj.GetPieceInvariant () - Enables or Disables piece invariance. This is usefull when
dealing with multi-block data sets. Note: requires one level of ghost cells
obj.PieceInvariantOn () - Enables or Disables piece invariance. This is usefull when dealing with
multi-block data sets. Note: requires one level of ghost cells
obj.PieceInvariantOff () - Enables or Disables piece invariance. This is usefull when dealing with
multi-block data sets. Note: requires one level of ghost cells
obj.SetDirection (int ) - Specify how view direction is computed. By default, the camera origin
(eye) is used.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1542
int = obj.GetDirection () - Specify how view direction is computed. By default, the camera origin
(eye) is used.
obj.SetDirectionToSpecifiedVector () - Specify how view direction is computed. By default,
the camera origin (eye) is used.
obj.SetDirectionToSpecifiedOrigin () - Specify how view direction is computed. By default,
the camera origin (eye) is used.
obj.SetDirectionToCameraVector () - Specify how view direction is computed. By default, the
camera origin (eye) is used.
obj.SetDirectionToCameraOrigin () - Specify a camera that is used to define the view direction.
This ivar only has effect if the direction is set to VTK_DIRECTION_CAMERA_ORIGIN or VTK_DIRECTION_CAMERA_VECTOR, and a camera is specified.
obj.SetCamera (vtkCamera ) - Specify a camera that is used to define the view direction. This ivar
only has effect if the direction is set to VTK_DIRECTION_CAMERA_ORIGIN or VTK_DIRECTION_CAMERA_VECTOR, and a camera is specified.
vtkCamera = obj.GetCamera () - Specify a camera that is used to define the view direction. This
ivar only has effect if the direction is set to VTK_DIRECTION_CAMERA_ORIGIN or VTK_DIRECTION_CAMERA_VECTOR, and a camera is specified.
obj.SetProp3D (vtkProp3D ) - Specify a transformation matrix (via the vtkProp3D::GetMatrix()
method) that is used to include the effects of transformation. This ivar only has effect if the direction is set to
VTK_DIRECTION_CAMERA_ORIGIN or VTK_DIRECTION_CAMERA_VECTOR, and a camera is specified.
Specifying the vtkProp3D is optional.
vtkProp3D = obj.GetProp3D () - Specify a transformation matrix (via the vtkProp3D::GetMatrix()
method) that is used to include the effects of transformation. This ivar only has effect if the direction is set to
VTK_DIRECTION_CAMERA_ORIGIN or VTK_DIRECTION_CAMERA_VECTOR, and a camera is specified.
Specifying the vtkProp3D is optional.
obj.SetVector (double , double , double ) - Set/Get the sort direction. This ivar only has
effect if the sort direction is set to SetDirectionToSpecifiedVector(). The edge detection occurs in the direction
of the vector.
obj.SetVector (double a[3]) - Set/Get the sort direction. This ivar only has effect if the sort
direction is set to SetDirectionToSpecifiedVector(). The edge detection occurs in the direction of the vector.
double = obj. GetVector () - Set/Get the sort direction. This ivar only has effect if the sort
direction is set to SetDirectionToSpecifiedVector(). The edge detection occurs in the direction of the vector.
obj.SetOrigin (double , double , double ) - Set/Get the sort origin. This ivar only has
effect if the sort direction is set to SetDirectionToSpecifiedOrigin(). The edge detection occurs in the direction
of the origin to each edges center.
obj.SetOrigin (double a[3]) - Set/Get the sort origin. This ivar only has effect if the sort direction
is set to SetDirectionToSpecifiedOrigin(). The edge detection occurs in the direction of the origin to each
edges center.
double = obj. GetOrigin () - Set/Get the sort origin. This ivar only has effect if the sort direction
is set to SetDirectionToSpecifiedOrigin(). The edge detection occurs in the direction of the origin to each
edges center.
long = obj.GetMTime () - Return MTime also considering the dependent objects: the camera and/or
the prop3D.
35.35
vtkPolyDataToImageStencil
35.35 vtkPolyDataToImageStencil
35.35.1
1543
Usage
The vtkPolyDataToImageStencil class will convert a surface mesh into an image stencil that can be used to mask
an image with vtkImageStencil, or used to calculate statistics within the enclosed region with vtkImageAccumulate.
To create an instance of class vtkPolyDataToImageStencil, simply invoke its constructor as follows
obj = vtkPolyDataToImageStencil
35.35.2
Methods
The class vtkPolyDataToImageStencil has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPolyDataToImageStencil
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPolyDataToImageStencil = obj.NewInstance ()
vtkPolyDataToImageStencil = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkPolyData ) - Specify the implicit function to convert into a stencil.
vtkPolyData = obj.GetInput () - Specify the implicit function to convert into a stencil.
obj.SetInformationInput (vtkImageData ) - Set a vtkImageData that has the Spacing, Origin, and WholeExtent that will be used for the stencil. This input should be set to the image that you wish to
apply the stencil to. If you use this method, then any values set with the SetOutputSpacing, SetOutputOrigin,
and SetOutputWholeExtent methods will be ignored.
vtkImageData = obj.GetInformationInput () - Set a vtkImageData that has the Spacing,
Origin, and WholeExtent that will be used for the stencil. This input should be set to the image that you wish
to apply the stencil to. If you use this method, then any values set with the SetOutputSpacing, SetOutputOrigin, and SetOutputWholeExtent methods will be ignored.
obj.SetOutputOrigin (double , double , double ) - Set the Origin to be used for the
stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is
(0,0,0).
obj.SetOutputOrigin (double a[3]) - Set the Origin to be used for the stencil. It should be set
to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).
double = obj. GetOutputOrigin () - Set the Origin to be used for the stencil. It should be set
to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).
obj.SetOutputSpacing (double , double , double ) - Set the Spacing to be used for the
stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is
(1,1,1)
obj.SetOutputSpacing (double a[3]) - Set the Spacing to be used for the stencil. It should be
set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)
double = obj. GetOutputSpacing () - Set the Spacing to be used for the stencil. It should be
set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)
obj.SetOutputWholeExtent (int , int , int , int , int , int ) - Set the whole
extent for the stencil (anything outside this extent will be considered to be "outside" the stencil). If this is not
set, then the stencil will always use the requested UpdateExtent as the stencil extent.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1544
obj.SetOutputWholeExtent (int a[6]) - Set the whole extent for the stencil (anything outside
this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the
requested UpdateExtent as the stencil extent.
int = obj. GetOutputWholeExtent () - Set the whole extent for the stencil (anything outside
this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the
requested UpdateExtent as the stencil extent.
obj.SetTolerance (double ) - The tolerance to apply in when determining whether a voxel is inside
the stencil, given as a fraction of a voxel. Only used in X and Y, not in Z.
double = obj.GetToleranceMinValue () - The tolerance to apply in when determining whether
a voxel is inside the stencil, given as a fraction of a voxel. Only used in X and Y, not in Z.
double = obj.GetToleranceMaxValue () - The tolerance to apply in when determining whether
a voxel is inside the stencil, given as a fraction of a voxel. Only used in X and Y, not in Z.
double = obj.GetTolerance () - The tolerance to apply in when determining whether a voxel is
inside the stencil, given as a fraction of a voxel. Only used in X and Y, not in Z.
35.36
vtkProcrustesAlignmentFilter
35.36.1
Usage
vtkProcrustesAlignmentFilter is a filter that takes a set of pointsets (any object derived from vtkPointSet) and aligns
them in a least-squares sense to their mutual mean. The algorithm is iterated until convergence, as the mean must
be recomputed after each alignment.
Call SetNumberOfInputs(n) before calling SetInput(0) ... SetInput(n-1).
Retrieve the outputs using GetOutput(0) ... GetOutput(n-1).
The default (in vtkLandmarkTransform) is for a similarity alignment. For a rigid-body alignment (to build a size-andshape model) use:
GetLandmarkTransform()->SetModeToRigidBody().
Affine alignments are not normally used but are left in for completeness:
GetLandmarkTransform()->SetModeToAffine().
vtkProcrustesAlignmentFilter is an implementation of:
J.C. Gower (1975) Generalized Procrustes Analysis. Psychometrika, 40:33-51.
To create an instance of class vtkProcrustesAlignmentFilter, simply invoke its constructor as follows
obj = vtkProcrustesAlignmentFilter
35.36.2
Methods
The class vtkProcrustesAlignmentFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkProcrustesAlignmentFilter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.37 vtkProjectedTerrainPath
1545
vtkProcrustesAlignmentFilter = obj.NewInstance ()
vtkProcrustesAlignmentFilter = obj.SafeDownCast (vtkObject o)
vtkLandmarkTransform = obj.GetLandmarkTransform () - Get the internal landmark
transform. Use it to constrain the number of degrees of freedom of the alignment (i.e. rigid body, similarity,
etc.). The default is a similarity alignment.
vtkPoints = obj.GetMeanPoints () - Get the estimated mean point cloud
obj.SetNumberOfInputs (int n) - Specify how many pointsets are going to be given as input.
obj.SetInput (int idx, vtkPointSet p) - Specify the input pointset with index idx. Call SetNumberOfInputs before calling this function.
obj.SetInput (int idx, vtkDataObject input) - Specify the input pointset with index idx.
Call SetNumberOfInputs before calling this function.
obj.SetStartFromCentroid (bool ) - When on, the initial alignment is to the centroid of the cohort curves. When off, the alignment is to the centroid of the first input. Default is off for backward compatibility.
bool = obj.GetStartFromCentroid () - When on, the initial alignment is to the centroid of the
cohort curves. When off, the alignment is to the centroid of the first input. Default is off for backward compatibility.
obj.StartFromCentroidOn () - When on, the initial alignment is to the centroid of the cohort curves.
When off, the alignment is to the centroid of the first input. Default is off for backward compatibility.
obj.StartFromCentroidOff () - When on, the initial alignment is to the centroid of the cohort
curves. When off, the alignment is to the centroid of the first input. Default is off for backward compatibility.
vtkPointSet = obj.GetInput (int idx) - Retrieve the input point set with index idx (usually
only for pipeline tracing).
35.37
vtkProjectedTerrainPath
35.37.1
Usage
vtkProjectedTerrainPath projects an input polyline onto a terrain. (The terrain is defined by a 2D height image and
is the second input to the filter.) The polyline projection is controlled via several modes as follows. 1) Simple mode
projects the polyline points onto the terrain, taking into account the height offset instance variable. 2) Non-occluded
mode insures that no parts of the polyline are occluded by the terrain (e.g. a line passes through a mountain).
This may require recursive subdivision of the polyline. 3) Hug mode insures that the polyine points remain within
a constant distance from the surface. This may also require recursive subdivision of the polyline. Note that both
non-occluded mode and hug mode also take into account the height offset, so it is possible to create paths that hug
terrain a certain distance above it. To use this filter, define two inputs: 1) a polyline, and 2) an image whose scalar
values represent a height field. Then specify the mode, and the height offset to use.
An description of the algorithm is as follows. The filter begins by projecting the polyline points to the image (offset by
the specified height offset). If the mode is non-occluded or hug, then the maximum error along each line segment
is computed and placed into a priority queue. Each line segment is then split at the point of maximum error, and the
two new line segments are evaluated for maximum error. This process continues until the line is not occluded by the
terrain (non-occluded mode) or satisfies the error on variation from the surface (hug mode). (Note this process is
repeated for each polyline in the input. Also, the maximum error is computed in two parts: a maximum positive error
and maximum negative error. If the polyline is above the terraini.e., the height offset is positivein non-occluded or
hug mode all negative errors are eliminated. If the polyline is below the terraini.e., the height offset is negativein
non-occluded or hug mode all positive errors are eliminated.)
To create an instance of class vtkProjectedTerrainPath, simply invoke its constructor as follows
obj = vtkProjectedTerrainPath
1546
35.37.2
Methods
The class vtkProjectedTerrainPath has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkProjectedTerrainPath
class.
string = obj.GetClassName () - Standard methids for printing and determining type information.
int = obj.IsA (string name) - Standard methids for printing and determining type information.
vtkProjectedTerrainPath = obj.NewInstance () - Standard methids for printing and determining type information.
vtkProjectedTerrainPath = obj.SafeDownCast (vtkObject o) - Standard methids for
printing and determining type information.
obj.SetSource (vtkImageData source) - Specify the second input (the terrain) onto which the
polyline(s) should be projected.
vtkImageData = obj.GetSource () - Specify the second input (the terrain) onto which the polyline(s) should be projected.
obj.SetProjectionMode (int ) - Determine how to control the projection process. Simple projection just projects the original polyline points. Non-occluded projection insures that the polyline does not
intersect the terrain surface. Hug projection is similar to non-occulded projection except that produces a path
that is nearly parallel to the terrain (within the user specified height tolerance).
int = obj.GetProjectionModeMinValue () - Determine how to control the projection process.
Simple projection just projects the original polyline points. Non-occluded projection insures that the polyline does not intersect the terrain surface. Hug projection is similar to non-occulded projection except that
produces a path that is nearly parallel to the terrain (within the user specified height tolerance).
int = obj.GetProjectionModeMaxValue () - Determine how to control the projection process.
Simple projection just projects the original polyline points. Non-occluded projection insures that the polyline does not intersect the terrain surface. Hug projection is similar to non-occulded projection except that
produces a path that is nearly parallel to the terrain (within the user specified height tolerance).
int = obj.GetProjectionMode () - Determine how to control the projection process. Simple projection just projects the original polyline points. Non-occluded projection insures that the polyline does not
intersect the terrain surface. Hug projection is similar to non-occulded projection except that produces a path
that is nearly parallel to the terrain (within the user specified height tolerance).
obj.SetProjectionModeToSimple () - Determine how to control the projection process. Simple
projection just projects the original polyline points. Non-occluded projection insures that the polyline does not
intersect the terrain surface. Hug projection is similar to non-occulded projection except that produces a path
that is nearly parallel to the terrain (within the user specified height tolerance).
obj.SetProjectionModeToNonOccluded () - Determine how to control the projection process.
Simple projection just projects the original polyline points. Non-occluded projection insures that the polyline does not intersect the terrain surface. Hug projection is similar to non-occulded projection except that
produces a path that is nearly parallel to the terrain (within the user specified height tolerance).
obj.SetProjectionModeToHug () - This is the height above (or below) the terrain that the projected
path should be. Positive values indicate distances above the terrain; negative values indicate distances below
the terrain.
obj.SetHeightOffset (double ) - This is the height above (or below) the terrain that the projected
path should be. Positive values indicate distances above the terrain; negative values indicate distances below
the terrain.
double = obj.GetHeightOffset () - This is the height above (or below) the terrain that the projected path should be. Positive values indicate distances above the terrain; negative values indicate distances
below the terrain.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.38 vtkRenderLargeImage
1547
obj.SetHeightTolerance (double ) - This is the allowable variation in the altitude of the path
with respect to the variation in the terrain. It only comes into play if the hug projection mode is enabled.
double = obj.GetHeightToleranceMinValue () - This is the allowable variation in the altitude
of the path with respect to the variation in the terrain. It only comes into play if the hug projection mode is
enabled.
double = obj.GetHeightToleranceMaxValue () - This is the allowable variation in the altitude
of the path with respect to the variation in the terrain. It only comes into play if the hug projection mode is
enabled.
double = obj.GetHeightTolerance () - This is the allowable variation in the altitude of the path
with respect to the variation in the terrain. It only comes into play if the hug projection mode is enabled.
obj.SetMaximumNumberOfLines (vtkIdType ) - This instance variable can be used to limit the
total number of line segments created during subdivision. Note that the number of input line segments will be
the minimum number that cab be output.
vtkIdType = obj.GetMaximumNumberOfLinesMinValue () - This instance variable can be
used to limit the total number of line segments created during subdivision. Note that the number of input line
segments will be the minimum number that cab be output.
vtkIdType = obj.GetMaximumNumberOfLinesMaxValue () - This instance variable can be
used to limit the total number of line segments created during subdivision. Note that the number of input line
segments will be the minimum number that cab be output.
vtkIdType = obj.GetMaximumNumberOfLines () - This instance variable can be used to limit
the total number of line segments created during subdivision. Note that the number of input line segments
will be the minimum number that cab be output.
35.38
vtkRenderLargeImage
35.38.1
Usage
35.38.2
Methods
The class vtkRenderLargeImage has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRenderLargeImage class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRenderLargeImage = obj.NewInstance ()
vtkRenderLargeImage = obj.SafeDownCast (vtkObject o)
obj.SetMagnification (int ) - The magnification of the current render window
int = obj.GetMagnification () - The magnification of the current render window
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1548
obj.SetInput (vtkRenderer ) - Indicates what renderer to get the pixel data from.
vtkRenderer = obj.GetInput () - Returns which renderer is being used as the source for the pixel
data.
vtkImageData = obj.GetOutput () - Get the output data object for a port on this algorithm.
35.39
vtkRIBExporter
35.39.1
Usage
vtkRIBExporter is a concrete subclass of vtkExporter that writes a Renderman .RIB files. The input specifies a
vtkRenderWindow. All visible actors and lights will be included in the rib file. The following file naming conventions
apply: rib file - FilePrefix.rib image file created by RenderMan - FilePrefix.tif texture files - TexturePrefix_0xADDR_MTIME.tif This object does NOT generate an image file. The user must run either RenderMan or a RenderMan
emulator like Blue Moon Ray Tracer (BMRT). vtk properties are convert to Renderman shaders as follows: Normal
property, no texture map - plastic.sl Normal property with texture map - txtplastic.sl These two shaders must be
compiled by the rendering package being used. vtkRIBExporter also supports custom shaders. The shaders are
written using the Renderman Shading Language. See "The Renderman Companion", ISBN 0-201-50868, 1989 for
details on writing shaders. vtkRIBProperty specifies the declarations and parameter settings for custom shaders.
Tcl Example: generate a rib file for the current rendering. vtkRIBExporter myRIB myRIB SetInput $renWin myRIB
SetFIlePrefix mine myRIB Write This will create a file mine.rib. After running this file through a Renderman renderer
a file mine.tif will contain the rendered image.
To create an instance of class vtkRIBExporter, simply invoke its constructor as follows
obj = vtkRIBExporter
35.39.2
Methods
The class vtkRIBExporter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkRIBExporter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRIBExporter = obj.NewInstance ()
vtkRIBExporter = obj.SafeDownCast (vtkObject o)
obj.SetSize (int , int )
obj.SetSize (int a[2])
int = obj.
GetSize ()
GetPixelSamples ()
obj.SetFilePrefix (string ) - Specify the prefix of the files to write out. The resulting file names
will have .RIB appended to them.
string = obj.GetFilePrefix () - Specify the prefix of the files to write out. The resulting file
names will have .RIB appended to them.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.39 vtkRIBExporter
1549
1550
35.40
vtkRIBLight
35.40.1
Usage
vtkRIBLight is a subclass of vtkLight that allows the user to specify light source shaders and shadow casting lights
for use with RenderMan.
To create an instance of class vtkRIBLight, simply invoke its constructor as follows
obj = vtkRIBLight
35.40.2
Methods
The class vtkRIBLight has several methods that can be used. They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkRIBLight class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRIBLight = obj.NewInstance ()
vtkRIBLight = obj.SafeDownCast (vtkObject o)
obj.ShadowsOn ()
obj.ShadowsOff ()
obj.SetShadows (int )
int = obj.GetShadows ()
obj.Render (vtkRenderer ren, int index)
35.41
vtkRIBProperty
35.41.1
Usage
vtkRIBProperty is a subclass of vtkProperty that allows the user to specify named shaders for use with RenderMan.
Both a surface shader and displacement shader can be specified. Parameters for the shaders can be declared and
set.
To create an instance of class vtkRIBProperty, simply invoke its constructor as follows
obj = vtkRIBProperty
35.41.2
Methods
The class vtkRIBProperty has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkRIBProperty class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.42 vtkSpiderPlotActor
1551
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRIBProperty = obj.NewInstance ()
vtkRIBProperty = obj.SafeDownCast (vtkObject o)
obj.SetSurfaceShader (string ) - Specify the name of a surface shader.
string = obj.GetSurfaceShader () - Specify the name of a surface shader.
obj.SetDisplacementShader (string ) - Specify the name of a displacement shader.
string = obj.GetDisplacementShader () - Specify the name of a displacement shader.
obj.SetVariable (string variable, string declaration) - Specify declarations for
variables..
obj.AddVariable (string variable, string declaration) - Specify declarations for
variables..
string = obj.GetDeclarations () - Get variable declarations
obj.SetParameter (string parameter, string value) - Specify parameter values for
variables.
obj.AddParameter (string parameter, string value) - Specify parameter values for
variables.
string = obj.GetParameters () - Get parameters.
35.42
vtkSpiderPlotActor
35.42.1
Usage
vtkSpiderPlotActor generates a spider plot from an input field (i.e., vtkDataObject). A spider plot represents Ndimensional data by using a set of N axes that originate from the center of a circle, and form the spokes of a wheel
(like a spider web). Each N-dimensional point is plotted as a polyline that forms a closed polygon; the vertices of
the polygon are plotted against the radial axes.
To use this class, you must specify an input data object. Youll probably also want to specify the position of the plot
be setting the Position and Position2 instance variables, which define a rectangle in which the plot lies. Another
important parameter is the IndependentVariables ivar, which tells the instance how to interpret the field data (independent variables as the rows or columns of the field). There are also many other instance variables that control
the look of the plot includes its title and legend.
Set the text property/attributes of the title and the labels through the vtkTextProperty objects associated with these
components.
To create an instance of class vtkSpiderPlotActor, simply invoke its constructor as follows
obj = vtkSpiderPlotActor
1552
35.42.2
Methods
The class vtkSpiderPlotActor has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkSpiderPlotActor class.
string = obj.GetClassName () - Standard methods for type information and printing.
int = obj.IsA (string name) - Standard methods for type information and printing.
vtkSpiderPlotActor = obj.NewInstance () - Standard methods for type information and
printing.
vtkSpiderPlotActor = obj.SafeDownCast (vtkObject o) - Standard methods for type information and printing.
obj.SetInput (vtkDataObject ) - Set the input to the spider plot actor.
vtkDataObject = obj.GetInput () - Get the input data object to this actor.
obj.SetIndependentVariables (int ) - Specify whether to use the rows or columns as independent variables. If columns, then each row represents a separate point. If rows, then each column represents
a separate point.
int = obj.GetIndependentVariablesMinValue () - Specify whether to use the rows or
columns as independent variables. If columns, then each row represents a separate point. If rows, then
each column represents a separate point.
int = obj.GetIndependentVariablesMaxValue () - Specify whether to use the rows or
columns as independent variables. If columns, then each row represents a separate point. If rows, then
each column represents a separate point.
int = obj.GetIndependentVariables () - Specify whether to use the rows or columns as independent variables. If columns, then each row represents a separate point. If rows, then each column
represents a separate point.
obj.SetIndependentVariablesToColumns () - Specify whether to use the rows or columns as
independent variables. If columns, then each row represents a separate point. If rows, then each column
represents a separate point.
obj.SetIndependentVariablesToRows () - Specify whether to use the rows or columns as independent variables. If columns, then each row represents a separate point. If rows, then each column
represents a separate point.
obj.SetTitleVisibility (int ) - Enable/Disable the display of a plot title.
int = obj.GetTitleVisibility () - Enable/Disable the display of a plot title.
obj.TitleVisibilityOn () - Enable/Disable the display of a plot title.
obj.TitleVisibilityOff () - Enable/Disable the display of a plot title.
obj.SetTitle (string ) - Set/Get the title of the spider plot.
string = obj.GetTitle () - Set/Get the title of the spider plot.
obj.SetTitleTextProperty (vtkTextProperty p) - Set/Get the title text property.
vtkTextProperty = obj.GetTitleTextProperty () - Set/Get the title text property.
obj.SetLabelVisibility (int )
int = obj.GetLabelVisibility ()
obj.LabelVisibilityOn ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.42 vtkSpiderPlotActor
1553
obj.LabelVisibilityOff ()
obj.SetLabelTextProperty (vtkTextProperty p) - Enable/Disable the creation of a legend.
If on, the legend labels will be created automatically unless the per plot legend symbol has been set.
vtkTextProperty = obj.GetLabelTextProperty () - Enable/Disable the creation of a legend. If on, the legend labels will be created automatically unless the per plot legend symbol has been set.
obj.SetNumberOfRings (int ) - Specify the number of circumferential rings. If set to zero, then
none will be shown; othewise the specified number will be shown.
int = obj.GetNumberOfRingsMinValue () - Specify the number of circumferential rings. If set
to zero, then none will be shown; othewise the specified number will be shown.
int = obj.GetNumberOfRingsMaxValue () - Specify the number of circumferential rings. If set
to zero, then none will be shown; othewise the specified number will be shown.
int = obj.GetNumberOfRings () - Specify the number of circumferential rings. If set to zero, then
none will be shown; othewise the specified number will be shown.
obj.SetAxisLabel (int i, string ) - Specify the names of the radial spokes (i.e., the radial
axes). If not specified, then an integer number is automatically generated.
string = obj.GetAxisLabel (int i) - Specify the names of the radial spokes (i.e., the radial
axes). If not specified, then an integer number is automatically generated.
obj.SetAxisRange (int i, double min, double max) - Specify the range of data on each
radial axis. If not specified, then the range is computed automatically.
obj.SetAxisRange (int i, double range[2]) - Specify the range of data on each radial axis.
If not specified, then the range is computed automatically.
obj.GetAxisRange (int i, double range[2]) - Specify the range of data on each radial axis.
If not specified, then the range is computed automatically.
obj.SetPlotColor (int i, double r, double g, double b) - Specify colors for each
plot. If not specified, they are automatically generated.
obj.SetPlotColor (int i, double color[3]) - Specify colors for each plot. If not specified,
they are automatically generated.
obj.SetLegendVisibility (int ) - Enable/Disable the creation of a legend. If on, the legend
labels will be created automatically unless the per plot legend symbol has been set.
int = obj.GetLegendVisibility () - Enable/Disable the creation of a legend. If on, the legend
labels will be created automatically unless the per plot legend symbol has been set.
obj.LegendVisibilityOn () - Enable/Disable the creation of a legend. If on, the legend labels will
be created automatically unless the per plot legend symbol has been set.
obj.LegendVisibilityOff () - Enable/Disable the creation of a legend. If on, the legend labels will
be created automatically unless the per plot legend symbol has been set.
vtkLegendBoxActor = obj.GetLegendActor () - Retrieve handles to the legend box. This is
useful if you would like to manually control the legend appearance.
int = obj.RenderOverlay (vtkViewport ) - Draw the spider plot.
int = obj.RenderOpaqueGeometry (vtkViewport ) - Draw the spider plot.
int = obj.RenderTranslucentPolygonalGeometry (vtkViewport ) - Does this prop
have some translucent polygonal geometry?
int = obj.HasTranslucentPolygonalGeometry () - Does this prop have some translucent
polygonal geometry?
obj.ReleaseGraphicsResources (vtkWindow ) - Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to
release.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1554
35.43
vtkStructuredExtent
35.43.1
Usage
vtkStructuredExtent is an helper class that helps in arithmetic with structured extents. It defines a bunch of static
methods (most of which are inlined) to aid in dealing with extents.
To create an instance of class vtkStructuredExtent, simply invoke its constructor as follows
obj = vtkStructuredExtent
35.43.2
Methods
The class vtkStructuredExtent has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkStructuredExtent class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStructuredExtent = obj.NewInstance ()
vtkStructuredExtent = obj.SafeDownCast (vtkObject o)
35.44
vtkTemporalDataSetCache
35.44.1
Usage
vtkTemporalDataSetCache cache time step requests of a temporal dataset, when cached data is requested it is
returned using a shallow copy. .SECTION Thanks Ken Martin (Kitware) and John Bidiscombe of CSCS - Swiss
National Supercomputing Centre for creating and contributing this class. For related material, please refer to : John
Biddiscombe, Berk Geveci, Ken Martin, Kenneth Moreland, David Thompson, "Time Dependent Processing in a
Parallel Pipeline Architecture", IEEE Visualization 2007.
To create an instance of class vtkTemporalDataSetCache, simply invoke its constructor as follows
obj = vtkTemporalDataSetCache
35.44.2
Methods
The class vtkTemporalDataSetCache has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTemporalDataSetCache
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTemporalDataSetCache = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.45 vtkTemporalInterpolator
1555
35.45
vtkTemporalInterpolator
35.45.1
Usage
vtkTemporalInterpolator interpolates between two time steps to produce new data for an arbitrary T. vtkTemporalInterpolator has three modes of operation. The default mode is to produce a continuous range of time values as
output, which enables a filter downstream to request any value of T within the range. The second mode of operation
is enabled by setting DiscreteTimeStepInterval to a non zero value. When this mode is activated, the filter will report
a finite number of Time steps separated by deltaT between the original range of values. This mode is useful when a
dataset of N time steps has one (or more) missing datasets for certain T values and you simply wish to smooth over
the missing steps but otherwise use the original data. The third mode of operation is enabled by setting ResampleFactor to a non zero positive integer value. When this mode is activated, the filter will report a finite number of Time
steps which contain the original steps, plus N new values between each original step 1/ResampleFactor time units
apart. Note that if the input time steps are irregular, then using ResampleFactor will produce an irregular sequence
of regular steps between each of the original irregular steps (clear enough, yes?).
Higher order interpolation schemes will require changes to the API as most calls assume only two timesteps are
used.
To create an instance of class vtkTemporalInterpolator, simply invoke its constructor as follows
obj = vtkTemporalInterpolator
35.45.2
Methods
The class vtkTemporalInterpolator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTemporalInterpolator
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTemporalInterpolator = obj.NewInstance ()
vtkTemporalInterpolator = obj.SafeDownCast (vtkObject o)
obj.SetDiscreteTimeStepInterval (double ) - If you require a discrete number of outputs
steps, to be generated from an input source - for example, you required N steps separated by T, then set
DiscreteTimeStepInterval to T and you will get TIME_RANGE/DiscreteTimeStepInterval steps This is a useful
option to use if you have a dataset with one missing time step and wish to fill-in the missing data with an
interpolated value from the steps either side
double = obj.GetDiscreteTimeStepInterval () - If you require a discrete number of outputs
steps, to be generated from an input source - for example, you required N steps separated by T, then set
DiscreteTimeStepInterval to T and you will get TIME_RANGE/DiscreteTimeStepInterval steps This is a useful
option to use if you have a dataset with one missing time step and wish to fill-in the missing data with an
interpolated value from the steps either side
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1556
obj.SetResampleFactor (int ) - When ResampleFactor is a non zero positive integer, each pair
of input time steps will be interpolated between with the number of steps specified. For example an input of
1,2,3,4,5 and a resample factor of 10, will produce steps 0f 1.0, 1.1, 1.2.....1.9, 2.0 etc NB. Irregular input
steps will produce irregular output steps. Resample factor wuill only be used if DiscreteTimeStepInterval is
zero otherwise the DiscreteTimeStepInterval takes precedence
int = obj.GetResampleFactor () - When ResampleFactor is a non zero positive integer, each
pair of input time steps will be interpolated between with the number of steps specified. For example an input
of 1,2,3,4,5 and a resample factor of 10, will produce steps 0f 1.0, 1.1, 1.2.....1.9, 2.0 etc NB. Irregular input
steps will produce irregular output steps. Resample factor wuill only be used if DiscreteTimeStepInterval is
zero otherwise the DiscreteTimeStepInterval takes precedence
35.46
vtkTemporalShiftScale
35.46.1
Usage
vtkTemporalShiftScale modify the time range or time steps of the data without changing the data itself. The data is
not resampled by this filter, only the information accompanying the data is modified.
To create an instance of class vtkTemporalShiftScale, simply invoke its constructor as follows
obj = vtkTemporalShiftScale
35.46.2
Methods
The class vtkTemporalShiftScale has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTemporalShiftScale class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTemporalShiftScale = obj.NewInstance ()
vtkTemporalShiftScale = obj.SafeDownCast (vtkObject o)
obj.SetPreShift (double ) - Apply a translation to the data before scaling. To convert T{5,100} to
T{0,1} use Preshift=-5, Scale=1/95, PostShift=0 To convert T{5,105} to T{5,10} use Preshift=-5, Scale=5/100,
PostShift=5
double = obj.GetPreShift () - Apply a translation to the data before scaling. To convert
T{5,100} to T{0,1} use Preshift=-5, Scale=1/95, PostShift=0 To convert T{5,105} to T{5,10} use Preshift=5, Scale=5/100, PostShift=5
obj.SetPostShift (double ) - Apply a translation to the time
double = obj.GetPostShift () - Apply a translation to the time
obj.SetScale (double ) - Apply a scale to the time.
double = obj.GetScale () - Apply a scale to the time.
obj.SetPeriodic (int ) - If Periodic is true, requests for time will be wrapped around so that the
source appears to be a periodic time source. If data exists for times {0,N-1}, setting periodic to true will cause
time 0 to be produced when time N, 2N, 2N etc is requested. This effectively gives the source the ability to
generate time data indefinitely in a loop. When combined with Shift/Scale, the time becomes periodic in the
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.46 vtkTemporalShiftScale
1557
shifted and scaled time frame of reference. Note: Since the input time may not start at zero, the wrapping
of time from the end of one period to the start of the next, will subtract the initial time - a source with T{5..6}
repeated periodicaly will have output time {5..6..7..8} etc.
int = obj.GetPeriodic () - If Periodic is true, requests for time will be wrapped around so that the
source appears to be a periodic time source. If data exists for times {0,N-1}, setting periodic to true will cause
time 0 to be produced when time N, 2N, 2N etc is requested. This effectively gives the source the ability to
generate time data indefinitely in a loop. When combined with Shift/Scale, the time becomes periodic in the
shifted and scaled time frame of reference. Note: Since the input time may not start at zero, the wrapping
of time from the end of one period to the start of the next, will subtract the initial time - a source with T{5..6}
repeated periodicaly will have output time {5..6..7..8} etc.
obj.PeriodicOn () - If Periodic is true, requests for time will be wrapped around so that the source
appears to be a periodic time source. If data exists for times {0,N-1}, setting periodic to true will cause time 0
to be produced when time N, 2N, 2N etc is requested. This effectively gives the source the ability to generate
time data indefinitely in a loop. When combined with Shift/Scale, the time becomes periodic in the shifted
and scaled time frame of reference. Note: Since the input time may not start at zero, the wrapping of time
from the end of one period to the start of the next, will subtract the initial time - a source with T{5..6} repeated
periodicaly will have output time {5..6..7..8} etc.
obj.PeriodicOff () - If Periodic is true, requests for time will be wrapped around so that the source
appears to be a periodic time source. If data exists for times {0,N-1}, setting periodic to true will cause time 0
to be produced when time N, 2N, 2N etc is requested. This effectively gives the source the ability to generate
time data indefinitely in a loop. When combined with Shift/Scale, the time becomes periodic in the shifted
and scaled time frame of reference. Note: Since the input time may not start at zero, the wrapping of time
from the end of one period to the start of the next, will subtract the initial time - a source with T{5..6} repeated
periodicaly will have output time {5..6..7..8} etc.
obj.SetPeriodicEndCorrection (int ) - if Periodic time is enabled, this flag determines if the
last time step is the same as the first. If PeriodicEndCorrection is true, then it is assumed that the input data
goes from 0-1 (or whatever scaled/shifted actual time) and time 1 is the same as time 0 so that steps will be
0,1,2,3...N,1,2,3...N,1,2,3 where step N is the same as 0 and step 0 is not repeated. When this flag is false
the data is assumed to be literal and output is of the form 0,1,2,3...N,0,1,2,3... By default this flag is ON
int = obj.GetPeriodicEndCorrection () - if Periodic time is enabled, this flag determines if
the last time step is the same as the first. If PeriodicEndCorrection is true, then it is assumed that the input
data goes from 0-1 (or whatever scaled/shifted actual time) and time 1 is the same as time 0 so that steps
will be 0,1,2,3...N,1,2,3...N,1,2,3 where step N is the same as 0 and step 0 is not repeated. When this flag is
false the data is assumed to be literal and output is of the form 0,1,2,3...N,0,1,2,3... By default this flag is ON
obj.PeriodicEndCorrectionOn () - if Periodic time is enabled, this flag determines if the last time
step is the same as the first. If PeriodicEndCorrection is true, then it is assumed that the input data goes
from 0-1 (or whatever scaled/shifted actual time) and time 1 is the same as time 0 so that steps will be
0,1,2,3...N,1,2,3...N,1,2,3 where step N is the same as 0 and step 0 is not repeated. When this flag is false
the data is assumed to be literal and output is of the form 0,1,2,3...N,0,1,2,3... By default this flag is ON
obj.PeriodicEndCorrectionOff () - if Periodic time is enabled, this flag determines if the last
time step is the same as the first. If PeriodicEndCorrection is true, then it is assumed that the input data
goes from 0-1 (or whatever scaled/shifted actual time) and time 1 is the same as time 0 so that steps will be
0,1,2,3...N,1,2,3...N,1,2,3 where step N is the same as 0 and step 0 is not repeated. When this flag is false
the data is assumed to be literal and output is of the form 0,1,2,3...N,0,1,2,3... By default this flag is ON
obj.SetMaximumNumberOfPeriods (double ) - if Periodic time is enabled, this controls how
many time periods time is reported for. A filter cannot output an infinite number of time steps and therefore a finite number of periods is generated when reporting time.
double = obj.GetMaximumNumberOfPeriods () - if Periodic time is enabled, this controls how
many time periods time is reported for. A filter cannot output an infinite number of time steps and therefore a
finite number of periods is generated when reporting time.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1558
35.47
vtkTemporalSnapToTimeStep
35.47.1
Usage
vtkTemporalSnapToTimeStep modify the time range or time steps of the data without changing the data itself. The
data is not resampled by this filter, only the information accompanying the data is modified.
To create an instance of class vtkTemporalSnapToTimeStep, simply invoke its constructor as follows
obj = vtkTemporalSnapToTimeStep
35.47.2
Methods
The class vtkTemporalSnapToTimeStep has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTemporalSnapToTimeStep
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTemporalSnapToTimeStep = obj.NewInstance ()
vtkTemporalSnapToTimeStep = obj.SafeDownCast (vtkObject o)
obj.SetSnapMode (int )
int = obj.GetSnapMode ()
obj.SetSnapModeToNearest ()
obj.SetSnapModeToNextBelowOrEqual ()
obj.SetSnapModeToNextAboveOrEqual ()
35.48
vtkThinPlateSplineTransform
35.48.1
Usage
vtkThinPlateSplineTransform describes a nonlinear warp transform defined by a set of source and target landmarks.
Any point on the mesh close to a source landmark will be moved to a place close to the corresponding target
landmark. The points in between are interpolated smoothly using Booksteins Thin Plate Spline algorithm.
To obtain a correct TPS warp, use the R2LogR kernel if your data is 2D, and the R kernel if your data is 3D. Or you
can specify your own RBF. (Hence this class is more general than a pure TPS transform.)
To create an instance of class vtkThinPlateSplineTransform, simply invoke its constructor as follows
obj = vtkThinPlateSplineTransform
35.49 vtkTransformToGrid
35.48.2
1559
Methods
The class vtkThinPlateSplineTransform has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkThinPlateSplineTransform
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkThinPlateSplineTransform = obj.NewInstance ()
vtkThinPlateSplineTransform = obj.SafeDownCast (vtkObject o)
double = obj.GetSigma () - Specify the stiffness of the spline. The default is 1.0.
obj.SetSigma (double ) - Specify the stiffness of the spline. The default is 1.0.
obj.SetBasis (int basis) - Specify the radial basis function to use. The default is R2LogR which
is appropriate for 2D. Use |R| (SetBasisToR) if your data is 3D. Alternatively specify your own basis function,
however this will mean that the transform will no longer be a true thin-plate spline.
int = obj.GetBasis () - Specify the radial basis function to use. The default is R2LogR which is
appropriate for 2D. Use |R| (SetBasisToR) if your data is 3D. Alternatively specify your own basis function,
however this will mean that the transform will no longer be a true thin-plate spline.
obj.SetBasisToR () - Specify the radial basis function to use. The default is R2LogR which is appropriate for 2D. Use |R| (SetBasisToR) if your data is 3D. Alternatively specify your own basis function, however
this will mean that the transform will no longer be a true thin-plate spline.
obj.SetBasisToR2LogR () - Specify the radial basis function to use. The default is R2LogR which is
appropriate for 2D. Use |R| (SetBasisToR) if your data is 3D. Alternatively specify your own basis function,
however this will mean that the transform will no longer be a true thin-plate spline.
string = obj.GetBasisAsString () - Specify the radial basis function to use. The default is R2LogR which is appropriate for 2D. Use |R| (SetBasisToR) if your data is 3D. Alternatively specify your own
basis function, however this will mean that the transform will no longer be a true thin-plate spline.
obj.SetSourceLandmarks (vtkPoints source) - Set the source landmarks for the warp. If you
add or change the vtkPoints object, you must call Modified() on it or the transformation might not update.
vtkPoints = obj.GetSourceLandmarks () - Set the source landmarks for the warp. If you add
or change the vtkPoints object, you must call Modified() on it or the transformation might not update.
obj.SetTargetLandmarks (vtkPoints target) - Set the target landmarks for the warp. If you
add or change the vtkPoints object, you must call Modified() on it or the transformation might not update.
vtkPoints = obj.GetTargetLandmarks () - Set the target landmarks for the warp. If you add
or change the vtkPoints object, you must call Modified() on it or the transformation might not update.
long = obj.GetMTime () - Get the MTime.
vtkAbstractTransform = obj.MakeTransform () - Make another transform of the same type.
35.49
vtkTransformToGrid
1560
35.49.1
Usage
vtkTransformToGrid takes any transform as input and produces a grid for use by a vtkGridTransform. This can be
used, for example, to invert a grid transform, concatenate two grid transforms, or to convert a thin plate spline
transform into a grid transform.
To create an instance of class vtkTransformToGrid, simply invoke its constructor as follows
obj = vtkTransformToGrid
35.49.2
Methods
The class vtkTransformToGrid has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTransformToGrid class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTransformToGrid = obj.NewInstance ()
vtkTransformToGrid = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkAbstractTransform ) - Set/Get the transform which will be converted into a
grid.
vtkAbstractTransform = obj.GetInput () - Set/Get the transform which will be converted into
a grid.
obj.SetGridExtent (int , int , int , int , int , int ) - Get/Set the extent of the
grid.
obj.SetGridExtent (int a[6]) - Get/Set the extent of the grid.
int = obj.
obj.SetGridSpacing (double , double , double ) - Get/Set the spacing between samples in the grid.
obj.SetGridSpacing (double a[3]) - Get/Set the spacing between samples in the grid.
double = obj.
obj.SetGridScalarType (int ) - Get/Set the scalar type of the grid. The default is double.
int = obj.GetGridScalarType () - Get/Set the scalar type of the grid. The default is double.
obj.SetGridScalarTypeToFloat () - Get/Set the scalar type of the grid. The default is double.
obj.SetGridScalarTypeToShort () - Get/Set the scalar type of the grid. The default is double.
obj.SetGridScalarTypeToUnsignedShort () - Get/Set the scalar type of the grid. The default
is double.
obj.SetGridScalarTypeToUnsignedChar () - Get/Set the scalar type of the grid. The default is
double.
obj.SetGridScalarTypeToChar () - Get/Set the scalar type of the grid. The default is double.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.50 vtkVectorText
1561
double = obj.GetDisplacementScale () - Get the scale and shift to convert integer grid elements into real values: dx = scaledi + shift. If the grid is of double type, then scale = 1 and shift = 0.
double = obj.GetDisplacementShift () - Get the scale and shift to convert integer grid elements into real values: dx = scaledi + shift. If the grid is of double type, then scale = 1 and shift = 0.
vtkImageData = obj.GetOutput () - Get the output data object for a port on this algorithm.
35.50
vtkVectorText
35.50.1
Usage
35.50.2
Methods
The class vtkVectorText has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkVectorText class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVectorText = obj.NewInstance ()
vtkVectorText = obj.SafeDownCast (vtkObject o)
obj.SetText (string ) - Set/Get the text to be drawn.
string = obj.GetText () - Set/Get the text to be drawn.
35.51
vtkVideoSource
35.51.1
Usage
vtkVideoSource is a superclass for video input interfaces for VTK. The goal is to provide an interface which is very
similar to the interface of a VCR, where the tape is an internal frame buffer capable of holding a preset number
of video frames. Specialized versions of this class record input from various video input sources. This base class
records input from a noise source.
To create an instance of class vtkVideoSource, simply invoke its constructor as follows
obj = vtkVideoSource
1562
35.51.2
Methods
The class vtkVideoSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkVideoSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVideoSource = obj.NewInstance ()
vtkVideoSource = obj.SafeDownCast (vtkObject o)
obj.Record () - Record incoming video at the specified FrameRate. The recording continues indefinitely
until Stop() is called.
obj.Play () - Play through the tape sequentially at the specified frame rate. If you have just finished
Recoding, you should call Rewind() first.
obj.Stop () - Stop recording or playing.
obj.Rewind () - Rewind to the frame with the earliest timestamp. Record operations will start on the
following frame, therefore if you want to re-record over this frame you must call Seek(-1) before calling Grab()
or Record().
obj.FastForward () - FastForward to the last frame that was recorded (i.e. to the frame that has the
most recent timestamp).
obj.Seek (int n) - Seek forwards or backwards by the specified number of frames (positive is forward,
negative is backward).
obj.Grab () - Grab a single video frame.
int = obj.GetRecording () - Are we in record mode? (record mode and play mode are mutually
exclusive).
int = obj.GetPlaying () - Are we in play mode? (record mode and play mode are mutually exclusive).
obj.SetFrameSize (int x, int y, int z) - Set the full-frame size. This must be an allowed
size for the device, the device may either refuse a request for an illegal frame size or automatically choose a
new frame size. The default is usually 320x240x1, but can be device specific. The depth should always be 1
(unless you have a device that can handle 3D acquisition).
obj.SetFrameSize (int dim[3]) - Set the full-frame size. This must be an allowed size for the
device, the device may either refuse a request for an illegal frame size or automatically choose a new frame
size. The default is usually 320x240x1, but can be device specific. The depth should always be 1 (unless
you have a device that can handle 3D acquisition).
int = obj. GetFrameSize () - Set the full-frame size. This must be an allowed size for the device,
the device may either refuse a request for an illegal frame size or automatically choose a new frame size. The
default is usually 320x240x1, but can be device specific. The depth should always be 1 (unless you have a
device that can handle 3D acquisition).
obj.SetFrameRate (float rate) - Request a particular frame rate (default 30 frames per second).
float = obj.GetFrameRate () - Request a particular frame rate (default 30 frames per second).
obj.SetOutputFormat (int format) - Set the output format. This must be appropriate for device,
usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.
obj.SetOutputFormatToLuminance () - Set the output format. This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.51 vtkVideoSource
1563
obj.SetOutputFormatToRGB () - Set the output format. This must be appropriate for device, usually
only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.
obj.SetOutputFormatToRGBA () - Set the output format. This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.
int = obj.GetOutputFormat () - Set the output format. This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.
obj.SetFrameBufferSize (int FrameBufferSize) - Set size of the frame buffer, i.e. the number of frames that the tape can store.
int = obj.GetFrameBufferSize () - Set size of the frame buffer, i.e. the number of frames that
the tape can store.
obj.SetNumberOfOutputFrames (int ) - Set the number of frames to copy to the output on each
execute. The frames will be concatenated along the Z dimension, with the most recent frame first. Default: 1
int = obj.GetNumberOfOutputFrames () - Set the number of frames to copy to the output on
each execute. The frames will be concatenated along the Z dimension, with the most recent frame first.
Default: 1
obj.AutoAdvanceOn () - Set whether to automatically advance the buffer before each grab. Default:
on
obj.AutoAdvanceOff () - Set whether to automatically advance the buffer before each grab. Default:
on
obj.SetAutoAdvance (int ) - Set whether to automatically advance the buffer before each grab.
Default: on
int = obj.GetAutoAdvance () - Set whether to automatically advance the buffer before each grab.
Default: on
obj.SetClipRegion (int r[6]) - Set the clip rectangle for the frames. The video will be clipped
before it is copied into the framebuffer. Changing the ClipRegion will destroy the current contents of the
framebuffer. The default ClipRegion is (0,VTK_INT_MAX,0,VTK_INT_MAX,0,VTK_INT_MAX).
obj.SetClipRegion (int x0, int x1, int y0, int y1, int z0, int z1) - Set
the clip rectangle for the frames. The video will be clipped before it is copied into the framebuffer. Changing
the ClipRegion will destroy the current contents of the framebuffer. The default ClipRegion is (0,VTK_INT_MAX,0,VTK_INT_MAX,0,VTK_INT_MAX).
int = obj. GetClipRegion () - Set the clip rectangle for the frames. The video will be clipped
before it is copied into the framebuffer. Changing the ClipRegion will destroy the current contents of the
framebuffer. The default ClipRegion is (0,VTK_INT_MAX,0,VTK_INT_MAX,0,VTK_INT_MAX).
obj.SetOutputWholeExtent (int , int , int , int , int , int ) - Get/Set the
WholeExtent of the output. This can be used to either clip or pad the video frame. This clipping/padding is
done when the frame is copied to the output, and does not change the contents of the framebuffer. This is
useful e.g. for expanding the output size to a power of two for texture mapping. The default is (0,-1,0,-1,0,-1)
which causes the entire frame to be copied to the output.
obj.SetOutputWholeExtent (int a[6]) - Get/Set the WholeExtent of the output. This can be
used to either clip or pad the video frame. This clipping/padding is done when the frame is copied to the
output, and does not change the contents of the framebuffer. This is useful e.g. for expanding the output
size to a power of two for texture mapping. The default is (0,-1,0,-1,0,-1) which causes the entire frame to be
copied to the output.
int = obj. GetOutputWholeExtent () - Get/Set the WholeExtent of the output. This can be
used to either clip or pad the video frame. This clipping/padding is done when the frame is copied to the
output, and does not change the contents of the framebuffer. This is useful e.g. for expanding the output
size to a power of two for texture mapping. The default is (0,-1,0,-1,0,-1) which causes the entire frame to be
copied to the output.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1564
35.52
vtkVRMLImporter
35.53 vtkWeightedTransformFilter
35.52.1
1565
Usage
35.52.2
Methods
The class vtkVRMLImporter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkVRMLImporter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVRMLImporter = obj.NewInstance ()
vtkVRMLImporter = obj.SafeDownCast (vtkObject o)
vtkObject = obj.GetVRMLDEFObject (string name) - In the VRML spec you can DEF and
USE nodes (name them), This routine will return the associated VTK object which was created as a result of
the DEF mechanism Send in the name from the VRML file, get the VTK object. You will have to check and
correctly cast the object since this only returns vtkObjects.
obj.enterNode (string ) - Needed by the yacc/lex grammar used
obj.exitNode () - Needed by the yacc/lex grammar used
obj.enterField (string ) - Needed by the yacc/lex grammar used
obj.exitField () - Needed by the yacc/lex grammar used
obj.useNode (string ) - Needed by the yacc/lex grammar used
obj.SetFileName (string ) - Specify the name of the file to read.
string = obj.GetFileName () - Specify the name of the file to read.
35.53
vtkWeightedTransformFilter
35.53.1
Usage
35.53.2
Methods
The class vtkWeightedTransformFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkWeightedTransformFilter
class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1566
35.54 vtkX3DExporter
1567
obj.SetNumberOfTransforms (int num) - Set the number of transforms for the filter. References
to non-existent filter numbers in the data array is equivalent to a weight of zero (i.e., no contribution of that
filter or weight). The maximum number of transforms is limited to 65536 if transform index arrays are used.
int = obj.GetNumberOfTransforms () - Set the number of transforms for the filter. References
to non-existent filter numbers in the data array is equivalent to a weight of zero (i.e., no contribution of that
filter or weight). The maximum number of transforms is limited to 65536 if transform index arrays are used.
obj.AddInputValuesOn () - If AddInputValues is true, the output values of this filter will be offset from
the input values. The effect is exactly equivalent to having an identity transform of weight 1 added into each
output point.
obj.AddInputValuesOff () - If AddInputValues is true, the output values of this filter will be offset
from the input values. The effect is exactly equivalent to having an identity transform of weight 1 added into
each output point.
obj.SetAddInputValues (int ) - If AddInputValues is true, the output values of this filter will be
offset from the input values. The effect is exactly equivalent to having an identity transform of weight 1 added
into each output point.
int = obj.GetAddInputValues () - If AddInputValues is true, the output values of this filter will be
offset from the input values. The effect is exactly equivalent to having an identity transform of weight 1 added
into each output point.
35.54
vtkX3DExporter
35.54.1
Usage
vtkX3DExporter is a render window exporter which writes out the renderered scene into an X3D file. X3D is an XML-based format for representation 3D scenes (similar to VRML). Check out http://www.web3d.org/x3d/
for more details. .SECTION Thanks X3DExporter is contributed by Christophe Mouton at EDF.
To create an instance of class vtkX3DExporter, simply invoke its constructor as follows
obj = vtkX3DExporter
35.54.2
Methods
The class vtkX3DExporter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkX3DExporter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkX3DExporter = obj.NewInstance ()
vtkX3DExporter = obj.SafeDownCast (vtkObject o)
obj.SetFileName (string ) - Set/Get the output file name.
string = obj.GetFileName () - Set/Get the output file name.
obj.SetSpeed (double ) - Specify the Speed of navigation. Default is 4.
double = obj.GetSpeed () - Specify the Speed of navigation. Default is 4.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1568
35.55
vtkXYPlotActor
35.55.1
Usage
vtkXYPlotActor creates an x-y plot of data from one or more input data sets or field data. The class plots dataset
scalar values (y-axis) against the points (x-axis). The x-axis values are generated by taking the point ids, computing
a cumulative arc length, or a normalized arc length. More than one input data set can be specified to generate
multiple plots. Alternatively, if field data is supplied as input, the class plots one component against another. (The
user must specify which component to use as the x-axis and which for the y-axis.)
To use this class to plot dataset(s), you must specify one or more input datasets containing scalar and point data.
Youll probably also want to invoke a method to control how the point coordinates are converted into x values (by
default point ids are used).
To use this class to plot field data, you must specify one or more input data objects with its associated field data.
Youll also want to specify which component to use as the x-axis and which to use as the y-axis. Note that when
plotting field data, the x and y values are used directly (i.e., there are no options to normalize the components).
Once youve set up the plot, youll want to position it. The PositionCoordinate defines the lower-left location of the x-y
plot (specified in normalized viewport coordinates) and the Position2Coordinate define the upper-right corner. (Note:
the Position2Coordinate is relative to PositionCoordinate, so you can move the vtkXYPlotActor around the viewport
by setting just the PositionCoordinate.) The combination of the two position coordinates specifies a rectangle in
which the plot will lie.
Optional features include the ability to specify axes labels, label format and plot title. You can also manually specify
the x and y plot ranges (by default they are computed automatically). The Border instance variable is used to create
space between the boundary of the plot window (specified by PositionCoordinate and Position2Coordinate) and the
plot itself.
The font property of the plot title can be modified through the TitleTextProperty attribute. The font property of the
axes titles and labels can be modified through the AxisTitleTextProperty and AxisLabelTextProperty attributes. You
may also use the GetXAxisActor2D or GetYAxisActor2D methods to access each individual axis actor to modify
their font properties. In the same way, the GetLegendBoxActor method can be used to access the legend box actor
to modify its font properties.
There are several advanced features as well. You can assign per curve properties (such as color and a plot symbol).
(Note that each input dataset and/or data object creates a single curve.) Another option is to add a plot legend that
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.55 vtkXYPlotActor
1569
graphically indicates the correspondance between the curve, curve symbols, and the data source. You can also
exchange the x and y axes if you prefer you plot orientation that way.
To create an instance of class vtkXYPlotActor, simply invoke its constructor as follows
obj = vtkXYPlotActor
35.55.2
Methods
The class vtkXYPlotActor has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkXYPlotActor class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkXYPlotActor = obj.NewInstance ()
vtkXYPlotActor = obj.SafeDownCast (vtkObject o)
obj.AddInput (vtkDataSet in, string arrayName, int component) - Add a dataset
to the list of data to append. The array name specifies which point array to plot. The array must be a vtkDataArray subclass, i.e. a numeric array. If the array name is NULL, then the default scalars are used. The array
can have multiple components, but only the first component is ploted.
obj.AddInput (vtkDataSet in) - Remove a dataset from the list of data to append.
obj.RemoveInput (vtkDataSet in, string arrayName, int component) - Remove
a dataset from the list of data to append.
obj.RemoveInput (vtkDataSet in) - This removes all of the data set inputs, but does not change
the data object inputs.
obj.RemoveAllInputs () - This removes all of the data set inputs, but does not change the data
object inputs.
vtkDataSetCollection = obj.GetInputList () - If plotting points by value, which component
to use to determine the value. This sets a value per each input dataset (i.e., the ith dataset).
obj.SetPointComponent (int i, int comp) - If plotting points by value, which component to
use to determine the value. This sets a value per each input dataset (i.e., the ith dataset).
int = obj.GetPointComponent (int i) - If plotting points by value, which component to use to
determine the value. This sets a value per each input dataset (i.e., the ith dataset).
obj.SetXValues (int ) - Specify how the independent (x) variable is computed from the points. The
independent variable can be the scalar/point index (i.e., point id), the accumulated arc length along the points,
the normalized arc length, or by component value. If plotting datasets (e.g., points), the value that is used is
specified by the PointComponent ivar. (Note: these methods also control how field data is plotted. Field data
is usually plotted by value or index, if plotting length 1-dimensional length measures are used.)
int = obj.GetXValuesMinValue () - Specify how the independent (x) variable is computed from
the points. The independent variable can be the scalar/point index (i.e., point id), the accumulated arc length
along the points, the normalized arc length, or by component value. If plotting datasets (e.g., points), the
value that is used is specified by the PointComponent ivar. (Note: these methods also control how field data
is plotted. Field data is usually plotted by value or index, if plotting length 1-dimensional length measures are
used.)
int = obj.GetXValuesMaxValue () - Specify how the independent (x) variable is computed from
the points. The independent variable can be the scalar/point index (i.e., point id), the accumulated arc length
along the points, the normalized arc length, or by component value. If plotting datasets (e.g., points), the
value that is used is specified by the PointComponent ivar. (Note: these methods also control how field data
is plotted. Field data is usually plotted by value or index, if plotting length 1-dimensional length measures are
used.)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1570
int = obj.GetXValues () - Specify how the independent (x) variable is computed from the points.
The independent variable can be the scalar/point index (i.e., point id), the accumulated arc length along the
points, the normalized arc length, or by component value. If plotting datasets (e.g., points), the value that is
used is specified by the PointComponent ivar. (Note: these methods also control how field data is plotted.
Field data is usually plotted by value or index, if plotting length 1-dimensional length measures are used.)
obj.SetXValuesToIndex () - Specify how the independent (x) variable is computed from the points.
The independent variable can be the scalar/point index (i.e., point id), the accumulated arc length along the
points, the normalized arc length, or by component value. If plotting datasets (e.g., points), the value that is
used is specified by the PointComponent ivar. (Note: these methods also control how field data is plotted.
Field data is usually plotted by value or index, if plotting length 1-dimensional length measures are used.)
obj.SetXValuesToArcLength () - Specify how the independent (x) variable is computed from the
points. The independent variable can be the scalar/point index (i.e., point id), the accumulated arc length
along the points, the normalized arc length, or by component value. If plotting datasets (e.g., points), the
value that is used is specified by the PointComponent ivar. (Note: these methods also control how field data
is plotted. Field data is usually plotted by value or index, if plotting length 1-dimensional length measures are
used.)
obj.SetXValuesToNormalizedArcLength () - Specify how the independent (x) variable is computed from the points. The independent variable can be the scalar/point index (i.e., point id), the accumulated
arc length along the points, the normalized arc length, or by component value. If plotting datasets (e.g.,
points), the value that is used is specified by the PointComponent ivar. (Note: these methods also control
how field data is plotted. Field data is usually plotted by value or index, if plotting length 1-dimensional length
measures are used.)
obj.SetXValuesToValue () - Specify how the independent (x) variable is computed from the points.
The independent variable can be the scalar/point index (i.e., point id), the accumulated arc length along the
points, the normalized arc length, or by component value. If plotting datasets (e.g., points), the value that is
used is specified by the PointComponent ivar. (Note: these methods also control how field data is plotted.
Field data is usually plotted by value or index, if plotting length 1-dimensional length measures are used.)
string = obj.GetXValuesAsString () - Specify how the independent (x) variable is computed
from the points. The independent variable can be the scalar/point index (i.e., point id), the accumulated arc
length along the points, the normalized arc length, or by component value. If plotting datasets (e.g., points),
the value that is used is specified by the PointComponent ivar. (Note: these methods also control how field
data is plotted. Field data is usually plotted by value or index, if plotting length 1-dimensional length measures
are used.)
obj.AddDataObjectInput (vtkDataObject in) - Add a dataset to the list of data to append.
obj.RemoveDataObjectInput (vtkDataObject in) - Remove a dataset from the list of data
to append.
vtkDataObjectCollection = obj.GetDataObjectInputList () - Indicate whether to plot
rows or columns. If plotting rows, then the dependent variables is taken from a specified row, versus rows (y).
obj.SetDataObjectPlotMode (int ) - Indicate whether to plot rows or columns. If plotting rows,
then the dependent variables is taken from a specified row, versus rows (y).
int = obj.GetDataObjectPlotModeMinValue () - Indicate whether to plot rows or columns. If
plotting rows, then the dependent variables is taken from a specified row, versus rows (y).
int = obj.GetDataObjectPlotModeMaxValue () - Indicate whether to plot rows or columns. If
plotting rows, then the dependent variables is taken from a specified row, versus rows (y).
int = obj.GetDataObjectPlotMode () - Indicate whether to plot rows or columns. If plotting
rows, then the dependent variables is taken from a specified row, versus rows (y).
obj.SetDataObjectPlotModeToRows () - Indicate whether to plot rows or columns. If plotting
rows, then the dependent variables is taken from a specified row, versus rows (y).
obj.SetDataObjectPlotModeToColumns () - Indicate whether to plot rows or columns. If plotting
rows, then the dependent variables is taken from a specified row, versus rows (y).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.55 vtkXYPlotActor
1571
1572
obj.ExchangeAxesOn () - Enable/Disable exchange of the x-y axes (i.e., what was x becomes y, and
vice-versa). Exchanging axes affects the labeling as well.
obj.ExchangeAxesOff () - Enable/Disable exchange of the x-y axes (i.e., what was x becomes y, and
vice-versa). Exchanging axes affects the labeling as well.
obj.SetReverseXAxis (int ) - Normally the x-axis is plotted from minimum to maximum. Setting
this instance variable causes the x-axis to be plotted from maximum to minimum. Note that boolean always
applies to the x-axis even if ExchangeAxes is set.
int = obj.GetReverseXAxis () - Normally the x-axis is plotted from minimum to maximum. Setting
this instance variable causes the x-axis to be plotted from maximum to minimum. Note that boolean always
applies to the x-axis even if ExchangeAxes is set.
obj.ReverseXAxisOn () - Normally the x-axis is plotted from minimum to maximum. Setting this
instance variable causes the x-axis to be plotted from maximum to minimum. Note that boolean always
applies to the x-axis even if ExchangeAxes is set.
obj.ReverseXAxisOff () - Normally the x-axis is plotted from minimum to maximum. Setting this
instance variable causes the x-axis to be plotted from maximum to minimum. Note that boolean always
applies to the x-axis even if ExchangeAxes is set.
obj.SetReverseYAxis (int ) - Normally the y-axis is plotted from minimum to maximum. Setting
this instance variable causes the y-axis to be plotted from maximum to minimum. Note that boolean always
applies to the y-axis even if ExchangeAxes is set.
int = obj.GetReverseYAxis () - Normally the y-axis is plotted from minimum to maximum. Setting
this instance variable causes the y-axis to be plotted from maximum to minimum. Note that boolean always
applies to the y-axis even if ExchangeAxes is set.
obj.ReverseYAxisOn () - Normally the y-axis is plotted from minimum to maximum. Setting this
instance variable causes the y-axis to be plotted from maximum to minimum. Note that boolean always
applies to the y-axis even if ExchangeAxes is set.
obj.ReverseYAxisOff () - Normally the y-axis is plotted from minimum to maximum. Setting this
instance variable causes the y-axis to be plotted from maximum to minimum. Note that boolean always
applies to the y-axis even if ExchangeAxes is set.
vtkLegendBoxActor = obj.GetLegendActor () - Retrieve handles to the legend box and glyph
source. This is useful if you would like to change the default behavior of the legend box or glyph source. For
example, the default glyph can be changed from a line to a vertex plus line, etc.)
vtkGlyphSource2D = obj.GetGlyphSource () - Retrieve handles to the legend box and glyph
source. This is useful if you would like to change the default behavior of the legend box or glyph source. For
example, the default glyph can be changed from a line to a vertex plus line, etc.)
obj.SetTitle (string ) - Set/Get the title of the x-y plot, and the title along the x and y axes.
string = obj.GetTitle () - Set/Get the title of the x-y plot, and the title along the x and y axes.
obj.SetXTitle (string ) - Set/Get the title of the x-y plot, and the title along the x and y axes.
string = obj.GetXTitle () - Set/Get the title of the x-y plot, and the title along the x and y axes.
obj.SetYTitle (string ) - Set/Get the title of the x-y plot, and the title along the x and y axes.
string = obj.GetYTitle () - Set/Get the title of the x-y plot, and the title along the x and y axes.
vtkAxisActor2D = obj.GetXAxisActor2D () - Retrieve handles to the X and Y axis (so that
you can set their text properties for example)
vtkAxisActor2D = obj.GetYAxisActor2D () - Set the plot range (range of independent and
dependent variables) to plot. Data outside of the range will be clipped. If the plot range of either the x or y
variables is set to (v1,v2), where v1 == v2, then the range will be computed automatically. Note that the xrange values should be consistent with the way the independent variable is created (via INDEX, DISTANCE,
or ARC_LENGTH).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
35.55 vtkXYPlotActor
1573
obj.SetXRange (double , double ) - Set the plot range (range of independent and dependent
variables) to plot. Data outside of the range will be clipped. If the plot range of either the x or y variables is set
to (v1,v2), where v1 == v2, then the range will be computed automatically. Note that the x-range values should
be consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).
obj.SetXRange (double a[2]) - Set the plot range (range of independent and dependent variables)
to plot. Data outside of the range will be clipped. If the plot range of either the x or y variables is set to (v1,v2),
where v1 == v2, then the range will be computed automatically. Note that the x-range values should be
consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).
double = obj. GetXRange () - Set the plot range (range of independent and dependent variables)
to plot. Data outside of the range will be clipped. If the plot range of either the x or y variables is set to (v1,v2),
where v1 == v2, then the range will be computed automatically. Note that the x-range values should be
consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).
obj.SetYRange (double , double ) - Set the plot range (range of independent and dependent
variables) to plot. Data outside of the range will be clipped. If the plot range of either the x or y variables is set
to (v1,v2), where v1 == v2, then the range will be computed automatically. Note that the x-range values should
be consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).
obj.SetYRange (double a[2]) - Set the plot range (range of independent and dependent variables)
to plot. Data outside of the range will be clipped. If the plot range of either the x or y variables is set to (v1,v2),
where v1 == v2, then the range will be computed automatically. Note that the x-range values should be
consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).
double = obj. GetYRange () - Set the plot range (range of independent and dependent variables)
to plot. Data outside of the range will be clipped. If the plot range of either the x or y variables is set to (v1,v2),
where v1 == v2, then the range will be computed automatically. Note that the x-range values should be
consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).
obj.SetPlotRange (double xmin, double ymin, double xmax, double ymax) Set/Get the number of annotation labels to show along the x and y axes. This values is a suggestion: the
number of labels may vary depending on the particulars of the data. The convenience method SetNumberOfLables() sets the number of x and y labels to the same value.
obj.SetNumberOfXLabels (int ) - Set/Get the number of annotation labels to show along the x
and y axes. This values is a suggestion: the number of labels may vary depending on the particulars of the
data. The convenience method SetNumberOfLables() sets the number of x and y labels to the same value.
int = obj.GetNumberOfXLabelsMinValue () - Set/Get the number of annotation labels to show
along the x and y axes. This values is a suggestion: the number of labels may vary depending on the
particulars of the data. The convenience method SetNumberOfLables() sets the number of x and y labels to
the same value.
int = obj.GetNumberOfXLabelsMaxValue () - Set/Get the number of annotation labels to show
along the x and y axes. This values is a suggestion: the number of labels may vary depending on the
particulars of the data. The convenience method SetNumberOfLables() sets the number of x and y labels to
the same value.
int = obj.GetNumberOfXLabels () - Set/Get the number of annotation labels to show along the
x and y axes. This values is a suggestion: the number of labels may vary depending on the particulars of the
data. The convenience method SetNumberOfLables() sets the number of x and y labels to the same value.
obj.SetNumberOfYLabels (int ) - Set/Get the number of annotation labels to show along the x
and y axes. This values is a suggestion: the number of labels may vary depending on the particulars of the
data. The convenience method SetNumberOfLables() sets the number of x and y labels to the same value.
int = obj.GetNumberOfYLabelsMinValue () - Set/Get the number of annotation labels to show
along the x and y axes. This values is a suggestion: the number of labels may vary depending on the
particulars of the data. The convenience method SetNumberOfLables() sets the number of x and y labels to
the same value.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1574
35.55 vtkXYPlotActor
1575
obj.SetTitlePosition (double a[2]) - Set/Get the position of the title. This has no effect if
AdjustTitlePosition is true.
double = obj. GetTitlePosition () - Set/Get the position of the title. This has no effect if
AdjustTitlePosition is true.
obj.SetAdjustTitlePosition (int ) - If true, the xyplot actor will adjust the position of the title
automatically to be upper-middle. Default is true.
int = obj.GetAdjustTitlePosition () - If true, the xyplot actor will adjust the position of the
title automatically to be upper-middle. Default is true.
obj.AdjustTitlePositionOn () - If true, the xyplot actor will adjust the position of the title automatically to be upper-middle. Default is true.
obj.AdjustTitlePositionOff () - If true, the xyplot actor will adjust the position of the title automatically to be upper-middle. Default is true.
obj.SetAdjustTitlePositionMode (int ) - If AdjustTitlePosition is truem, the xyplot actor will
adjust the position of the title automatically depending on the given mode, the mode is a combination of the
Alignment flags. by default: vtkXYPlotActor::AlignHCenter | vtkXYPlotActor::Top | vtkXYPlotActor::AlignAxisVCenter
int = obj.GetAdjustTitlePositionMode () - If AdjustTitlePosition is truem, the xyplot actor
will adjust the position of the title automatically depending on the given mode, the mode is a combination of
the Alignment flags. by default: vtkXYPlotActor::AlignHCenter | vtkXYPlotActor::Top | vtkXYPlotActor::AlignAxisVCenter
obj.SetLegendPosition (double , double ) - Use these methods to control the position of
the legend. The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position
of the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by
PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.
obj.SetLegendPosition (double a[2]) - Use these methods to control the position of the legend. The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of
the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by
PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.
double = obj. GetLegendPosition () - Use these methods to control the position of the legend. The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of
the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by
PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.
obj.SetLegendPosition2 (double , double ) - Use these methods to control the position of
the legend. The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position
of the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by
PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.
obj.SetLegendPosition2 (double a[2]) - Use these methods to control the position of the legend. The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of
the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by
PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.
double = obj. GetLegendPosition2 () - Use these methods to control the position of the legend. The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of
the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by
PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.
obj.SetTitleTextProperty (vtkTextProperty p) - Set/Get the title text property.
vtkTextProperty = obj.GetTitleTextProperty () - Set/Get the title text property.
obj.SetAxisTitleTextProperty (vtkTextProperty p) - Set/Get the title text property of all
axes. Note that each axis can be controlled individually through the GetX/YAxisActor2D() methods.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1576
35.55 vtkXYPlotActor
1577
double = obj.GetGlyphSizeMinValue () - Set/Get the factor that controls how big glyphs are in
the plot. The number is expressed as a fraction of the length of the diagonal of the plot bounding box.
double = obj.GetGlyphSizeMaxValue () - Set/Get the factor that controls how big glyphs are in
the plot. The number is expressed as a fraction of the length of the diagonal of the plot bounding box.
double = obj.GetGlyphSize () - Set/Get the factor that controls how big glyphs are in the plot.
The number is expressed as a fraction of the length of the diagonal of the plot bounding box.
obj.ViewportToPlotCoordinate (vtkViewport viewport) - An alternate form of
ViewportToPlotCoordinate() above. This method inputs the viewport coordinate pair (defined by the ivar
ViewportCoordinate)and then stores them in the ivar PlotCoordinate.
obj.SetPlotCoordinate (double , double ) - An alternate form of ViewportToPlotCoordinate() above. This method inputs the viewport coordinate pair (defined by the ivar ViewportCoordinate)and then stores them in the ivar PlotCoordinate.
obj.SetPlotCoordinate (double a[2]) - An alternate form of ViewportToPlotCoordinate()
above. This method inputs the viewport coordinate pair (defined by the ivar ViewportCoordinate)and then
stores them in the ivar PlotCoordinate.
double = obj. GetPlotCoordinate () - An alternate form of ViewportToPlotCoordinate()
above. This method inputs the viewport coordinate pair (defined by the ivar ViewportCoordinate)and then
stores them in the ivar PlotCoordinate.
obj.PlotToViewportCoordinate (vtkViewport viewport) - An alternate form of PlotToViewportCoordinate() above. This method inputs the plot coordinate pair (defined in the ivar PlotCoordinate)
and then stores them in the ivar ViewportCoordinate. (This method can be wrapped.)
obj.SetViewportCoordinate (double , double ) - An alternate form of PlotToViewportCoordinate() above. This method inputs the plot coordinate pair (defined in the ivar PlotCoordinate) and
then stores them in the ivar ViewportCoordinate. (This method can be wrapped.)
obj.SetViewportCoordinate (double a[2]) - An alternate form of PlotToViewportCoordinate() above. This method inputs the plot coordinate pair (defined in the ivar PlotCoordinate) and then
stores them in the ivar ViewportCoordinate. (This method can be wrapped.)
double = obj. GetViewportCoordinate () - An alternate form of PlotToViewportCoordinate() above. This method inputs the plot coordinate pair (defined in the ivar PlotCoordinate) and then
stores them in the ivar ViewportCoordinate. (This method can be wrapped.)
int = obj.IsInPlot (vtkViewport viewport, double u, double v) - Is the specified viewport position within the plot area (as opposed to the region used by the plot plus the labels)?
obj.SetChartBox (int ) - Set/Get the flag that controls whether a box will be drawn/filled corresponding to the chart box.
int = obj.GetChartBox () - Set/Get the flag that controls whether a box will be drawn/filled corresponding to the chart box.
obj.ChartBoxOn () - Set/Get the flag that controls whether a box will be drawn/filled corresponding to
the chart box.
obj.ChartBoxOff () - Set/Get the flag that controls whether a box will be drawn/filled corresponding
to the chart box.
obj.SetChartBorder (int ) - Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.
int = obj.GetChartBorder () - Set/Get the flag that controls whether a box will be drawn/filled
corresponding to the legend box.
obj.ChartBorderOn () - Set/Get the flag that controls whether a box will be drawn/filled corresponding
to the legend box.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1578
obj.ChartBorderOff () - Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.
vtkProperty2D = obj.GetChartBoxProperty () - Get the box vtkProperty2D.
obj.SetShowReferenceXLine (int ) - Set/Get if the X reference line is visible. hidden by default
int = obj.GetShowReferenceXLine () - Set/Get if the X reference line is visible. hidden by default
obj.ShowReferenceXLineOn () - Set/Get if the X reference line is visible. hidden by default
obj.ShowReferenceXLineOff () - Set/Get if the X reference line is visible. hidden by default
obj.SetReferenceXValue (double )
double = obj.GetReferenceXValue ()
obj.SetShowReferenceYLine (int ) - Set/Get if the Y reference line is visible. hidden by default
int = obj.GetShowReferenceYLine () - Set/Get if the Y reference line is visible. hidden by default
obj.ShowReferenceYLineOn () - Set/Get if the Y reference line is visible. hidden by default
obj.ShowReferenceYLineOff () - Set/Get if the Y reference line is visible. hidden by default
obj.SetReferenceYValue (double )
double = obj.GetReferenceYValue ()
long = obj.GetMTime () - Take into account the modified time of internal helper classes.
Chapter 36
1580
vtkImageDataStreamer
vtkImageDecomposeFilter
vtkImageDifference
vtkImageDilateErode3D
vtkImageDivergence
vtkImageDotProduct
vtkImageEllipsoidSource
vtkImageEuclideanDistance
vtkImageEuclideanToPolar
vtkImageExport
vtkImageExtractComponents
vtkImageFFT
vtkImageFlip
vtkImageFourierCenter
vtkImageFourierFilter
vtkImageGaussianSmooth
vtkImageGaussianSource
vtkImageGradient
vtkImageGradientMagnitude
vtkImageGridSource
vtkImageHSIToRGB
vtkImageHSVToRGB
vtkImageHybridMedian2D
vtkImageIdealHighPass
vtkImageIdealLowPass
vtkImageImport
vtkImageImportExecutive
vtkImageIslandRemoval2D
vtkImageIterateFilter
vtkImageLaplacian
vtkImageLogarithmicScale
vtkImageLogic
vtkImageLuminance
vtkImageMagnify
vtkImageMagnitude
vtkImageMandelbrotSource
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1581
vtkImageMapToColors
vtkImageMapToRGBA
vtkImageMapToWindowLevelColors
vtkImageMask
vtkImageMaskBits
vtkImageMathematics
vtkImageMedian3D
vtkImageMirrorPad
vtkImageNoiseSource
vtkImageNonMaximumSuppression
vtkImageNormalize
vtkImageOpenClose3D
vtkImagePadFilter
vtkImagePermute
vtkImageQuantizeRGBToIndex
vtkImageRange3D
vtkImageRectilinearWipe
vtkImageResample
vtkImageReslice
vtkImageRFFT
vtkImageRGBToHSI
vtkImageRGBToHSV
vtkImageSeedConnectivity
vtkImageSeparableConvolution
vtkImageShiftScale
vtkImageShrink3D
vtkImageSinusoidSource
vtkImageSkeleton2D
vtkImageSobel2D
vtkImageSobel3D
vtkImageSpatialAlgorithm
vtkImageSpatialFilter
vtkImageStencil
vtkImageStencilData
vtkImageStencilSource
vtkImageThreshold
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1582
vtkImageToImageStencil
vtkImageTranslateExtent
vtkImageVariance3D
vtkImageWeightedSum
vtkImageWrapPad
vtkImplicitFunctionToImageStencil
vtkPointLoad
vtkRTAnalyticSource
vtkSampleFunction
vtkShepardMethod
vtkSimpleImageFilterExample
vtkSurfaceReconstructionFilter
vtkTriangularTexture
vtkVoxelModeller
36.1
vtkBooleanTexture
36.1.1
Usage
vtkBooleanTexture is a filter to generate a 2D texture map based on combinations of inside, outside, and on region
boundary. The "region" is implicitly represented via 2D texture coordinates. These texture coordinates are normally generated using a filter like vtkImplicitTextureCoords, which generates the texture coordinates for any implicit
function.
vtkBooleanTexture generates the map according to the s-t texture coordinates plus the notion of being in, on, or
outside of a region. An in region is when the texture coordinate is between (0,0.5-thickness/2). An out region is
where the texture coordinate is (0.5+thickness/2). An on region is between (0.5-thickness/2,0.5+thickness/2). The
combination in, on, and out for each of the s-t texture coordinates results in 16 possible combinations (see text). For
each combination, a different value of intensity and transparency can be assigned. To assign maximum intensity
and/or opacity use the value 255. A minimum value of 0 results in a black region (for intensity) and a fully transparent
region (for transparency).
To create an instance of class vtkBooleanTexture, simply invoke its constructor as follows
obj = vtkBooleanTexture
36.1.2
Methods
The class vtkBooleanTexture has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkBooleanTexture class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.1 vtkBooleanTexture
1583
vtkBooleanTexture = obj.NewInstance ()
vtkBooleanTexture = obj.SafeDownCast (vtkObject o)
obj.SetXSize (int ) - Set the X texture map dimension.
int = obj.GetXSize () - Set the X texture map dimension.
obj.SetYSize (int ) - Set the Y texture map dimension.
int = obj.GetYSize () - Set the Y texture map dimension.
obj.SetThickness (int ) - Set the thickness of the "on" region.
int = obj.GetThickness () - Set the thickness of the "on" region.
obj.SetInIn (char , char ) - Specify intensity/transparency for "in/in" region.
obj.SetInIn (char a[2]) - Specify intensity/transparency for "in/in" region.
char = obj.
1584
36.2
vtkExtractVOI
36.2.1
Usage
vtkExtractVOI is a filter that selects a portion of an input structured points dataset, or subsamples an input dataset.
(The selected portion of interested is referred to as the Volume Of Interest, or VOI.) The output of this filter is a
structured points dataset. The filter treats input data of any topological dimension (i.e., point, line, image, or volume)
and can generate output data of any topological dimension.
To use this filter set the VOI ivar which are i-j-k min/max indices that specify a rectangular region in the data. (Note
that these are 0-offset.) You can also specify a sampling rate to subsample the data.
Typical applications of this filter are to extract a slice from a volume for image processing, subsampling large volumes
to reduce data size, or extracting regions of a volume with interesting data.
To create an instance of class vtkExtractVOI, simply invoke its constructor as follows
obj = vtkExtractVOI
36.2.2
Methods
The class vtkExtractVOI has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkExtractVOI class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractVOI = obj.NewInstance ()
vtkExtractVOI = obj.SafeDownCast (vtkObject o)
obj.SetVOI (int , int , int , int , int , int ) - Specify i-j-k (min,max) pairs to extract. The resulting structured points dataset can be of any topological dimension (i.e., point, line, image, or
volume).
obj.SetVOI (int a[6]) - Specify i-j-k (min,max) pairs to extract. The resulting structured points
dataset can be of any topological dimension (i.e., point, line, image, or volume).
int = obj. GetVOI () - Specify i-j-k (min,max) pairs to extract. The resulting structured points
dataset can be of any topological dimension (i.e., point, line, image, or volume).
obj.SetSampleRate (int , int , int ) - Set the sampling rate in the i, j, and k directions. If
the rate is > 1, then the resulting VOI will be subsampled representation of the input. For example, if the
SampleRate=(2,2,2), every other point will be selected, resulting in a volume 1/8th the original size.
obj.SetSampleRate (int a[3]) - Set the sampling rate in the i, j, and k directions. If the rate is > 1,
then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2),
every other point will be selected, resulting in a volume 1/8th the original size.
int = obj. GetSampleRate () - Set the sampling rate in the i, j, and k directions. If the rate is > 1,
then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2),
every other point will be selected, resulting in a volume 1/8th the original size.
36.3
vtkFastSplatter
36.3 vtkFastSplatter
36.3.1
1585
Usage
vtkFastSplatter takes any vtkPointSet as input (of which vtkPolyData and vtkUnstructuredGrid inherit). Each point
in the data set is considered to be an impulse. These impulses are convolved with a given splat image. In other
words, the splat image is added to the final image at every place where there is an input point.
Note that point and cell data are thrown away. If you want a sampling of unstructured points consider vtkGaussianSplatter or vtkShepardMethod.
Use input port 0 for the impulse data (vtkPointSet), and input port 1 for the splat image (vtkImageData)
.SECTION Bugs
Any point outside of the extents of the image is thrown away, even if it is close enough such that its convolution with
the splat image would overlap the extents.
To create an instance of class vtkFastSplatter, simply invoke its constructor as follows
obj = vtkFastSplatter
36.3.2
Methods
The class vtkFastSplatter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkFastSplatter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkFastSplatter = obj.NewInstance ()
vtkFastSplatter = obj.SafeDownCast (vtkObject o)
obj.SetModelBounds (double , double , double , double , double , double
) - Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. If
any of the (min,max) bounds values are min >= max, then the bounds will be computed automatically from
the input data. Otherwise, the user-specified bounds will be used.
obj.SetModelBounds (double a[6]) - Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. If any of the (min,max) bounds values are min >= max, then
the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be
used.
double = obj. GetModelBounds () - Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. If any of the (min,max) bounds values are min >= max, then
the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be
used.
obj.SetOutputDimensions (int , int , int ) - Set/get the dimensions of the output image
obj.SetOutputDimensions (int a[3]) - Set/get the dimensions of the output image
int = obj.
obj.SetLimitMode (int ) - Set/get the way voxel values will be limited. If this is set to None (the
default), the output can have arbitrarily large values. If set to clamp, the output will be clamped to [MinValue,MaxValue]. If set to scale, the output will be linearly scaled between MinValue and MaxValue.
int = obj.GetLimitMode () - Set/get the way voxel values will be limited. If this is set to None
(the default), the output can have arbitrarily large values. If set to clamp, the output will be clamped to [MinValue,MaxValue]. If set to scale, the output will be linearly scaled between MinValue and MaxValue.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1586
obj.SetLimitModeToNone () - Set/get the way voxel values will be limited. If this is set to None
(the default), the output can have arbitrarily large values. If set to clamp, the output will be clamped to [MinValue,MaxValue]. If set to scale, the output will be linearly scaled between MinValue and MaxValue.
obj.SetLimitModeToClamp () - Set/get the way voxel values will be limited. If this is set to None
(the default), the output can have arbitrarily large values. If set to clamp, the output will be clamped to [MinValue,MaxValue]. If set to scale, the output will be linearly scaled between MinValue and MaxValue.
obj.SetLimitModeToScale () - Set/get the way voxel values will be limited. If this is set to None
(the default), the output can have arbitrarily large values. If set to clamp, the output will be clamped to [MinValue,MaxValue]. If set to scale, the output will be linearly scaled between MinValue and MaxValue.
obj.SetLimitModeToFreezeScale () - See the LimitMode method.
obj.SetMinValue (double ) - See the LimitMode method.
double = obj.GetMinValue () - See the LimitMode method.
obj.SetMaxValue (double ) - See the LimitMode method.
double = obj.GetMaxValue () - See the LimitMode method.
int = obj.GetNumberOfPointsSplatted () - This returns the number of points splatted (as
opposed to discarded for being outside the image) during the previous pass.
obj.SetSplatConnection (vtkAlgorithmOutput ) - Convenience function for connecting the
splat algorithm source. This is provided mainly for convenience using the filter with ParaView, VTK users
should prefer SetInputConnection(1, splat) instead.
36.4
vtkGaussianSplatter
36.4.1
Usage
vtkGaussianSplatter is a filter that injects input points into a structured points (volume) dataset. As each point is
injected, it "splats" or distributes values to nearby voxels. Data is distributed using an elliptical, Gaussian distribution function. The distribution function is modified using scalar values (expands distribution) or normals (creates
ellipsoidal distribution rather than spherical).
In general, the Gaussian distribution function f(x) around a given splat point p is given by
f(x) = ScaleFactor * exp( ExponentFactor*((r/Radius)**2) )
where x is the current voxel sample point; r is the distance |x-p| ExponentFactor <= 0.0, and ScaleFactor can be
multiplied by the scalar value of the point p that is currently being splatted.
If points normals are present (and NormalWarping is on), then the splat function becomes elliptical (as compared
to the spherical one described by the previous equation). The Gaussian distribution function then becomes:
f(x) = ScaleFactor *
exp( ExponentFactor*( ((rxy/E)**2 + z**2)/R**2) )
where E is a user-defined eccentricity factor that controls the elliptical shape of the splat; z is the distance of the
current voxel sample point along normal N; and rxy is the distance of x in the direction prependicular to N.
This class is typically used to convert point-valued distributions into a volume representation. The volume is then
usually iso-surfaced or volume rendered to generate a visualization. It can be used to create surfaces from point
distributions, or to create structure (i.e., topology) when none exists.
To create an instance of class vtkGaussianSplatter, simply invoke its constructor as follows
obj = vtkGaussianSplatter
36.4 vtkGaussianSplatter
36.4.2
1587
Methods
The class vtkGaussianSplatter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGaussianSplatter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGaussianSplatter = obj.NewInstance ()
vtkGaussianSplatter = obj.SafeDownCast (vtkObject o)
obj.SetSampleDimensions (int i, int j, int k) - Set / get the dimensions of the sampling structured point set. Higher values produce better results but are much slower.
obj.SetSampleDimensions (int dim[3]) - Set / get the dimensions of the sampling structured
point set. Higher values produce better results but are much slower.
int = obj. GetSampleDimensions () - Set / get the dimensions of the sampling structured point
set. Higher values produce better results but are much slower.
obj.SetModelBounds (double , double , double , double , double , double
) - Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. If
any of the (min,max) bounds values are min >= max, then the bounds will be computed automatically from
the input data. Otherwise, the user-specified bounds will be used.
obj.SetModelBounds (double a[6]) - Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. If any of the (min,max) bounds values are min >= max, then
the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be
used.
double = obj. GetModelBounds () - Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. If any of the (min,max) bounds values are min >= max, then
the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be
used.
obj.SetRadius (double ) - Set / get the radius of propagation of the splat. This value is expressed
as a percentage of the length of the longest side of the sampling volume. Smaller numbers greatly reduce
execution time.
double = obj.GetRadiusMinValue () - Set / get the radius of propagation of the splat. This value
is expressed as a percentage of the length of the longest side of the sampling volume. Smaller numbers
greatly reduce execution time.
double = obj.GetRadiusMaxValue () - Set / get the radius of propagation of the splat. This value
is expressed as a percentage of the length of the longest side of the sampling volume. Smaller numbers
greatly reduce execution time.
double = obj.GetRadius () - Set / get the radius of propagation of the splat. This value is expressed as a percentage of the length of the longest side of the sampling volume. Smaller numbers greatly
reduce execution time.
obj.SetScaleFactor (double ) - Multiply Gaussian splat distribution by this value. If ScalarWarping is on, then the Scalar value will be multiplied by the ScaleFactor times the Gaussian function.
double = obj.GetScaleFactorMinValue () - Multiply Gaussian splat distribution by this value.
If ScalarWarping is on, then the Scalar value will be multiplied by the ScaleFactor times the Gaussian function.
double = obj.GetScaleFactorMaxValue () - Multiply Gaussian splat distribution by this value.
If ScalarWarping is on, then the Scalar value will be multiplied by the ScaleFactor times the Gaussian function.
double = obj.GetScaleFactor () - Multiply Gaussian splat distribution by this value. If ScalarWarping is on, then the Scalar value will be multiplied by the ScaleFactor times the Gaussian function.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1588
obj.SetExponentFactor (double ) - Set / get the sharpness of decay of the splats. This is the
exponent constant in the Gaussian equation. Normally this is a negative value.
double = obj.GetExponentFactor () - Set / get the sharpness of decay of the splats. This is the
exponent constant in the Gaussian equation. Normally this is a negative value.
obj.SetNormalWarping (int ) - Turn on/off the generation of elliptical splats. If normal warping is
on, then the input normals affect the distribution of the splat. This boolean is used in combination with the
Eccentricity ivar.
int = obj.GetNormalWarping () - Turn on/off the generation of elliptical splats. If normal warping
is on, then the input normals affect the distribution of the splat. This boolean is used in combination with the
Eccentricity ivar.
obj.NormalWarpingOn () - Turn on/off the generation of elliptical splats. If normal warping is on, then
the input normals affect the distribution of the splat. This boolean is used in combination with the Eccentricity
ivar.
obj.NormalWarpingOff () - Turn on/off the generation of elliptical splats. If normal warping is on,
then the input normals affect the distribution of the splat. This boolean is used in combination with the
Eccentricity ivar.
obj.SetEccentricity (double ) - Control the shape of elliptical splatting. Eccentricity is the ratio
of the major axis (aligned along normal) to the minor (axes) aligned along other two axes. So Eccentricity
> 1 creates needles with the long axis in the direction of the normal; Eccentricity<1 creates pancakes
perpendicular to the normal vector.
double = obj.GetEccentricityMinValue () - Control the shape of elliptical splatting. Eccentricity is the ratio of the major axis (aligned along normal) to the minor (axes) aligned along other two axes.
So Eccentricity > 1 creates needles with the long axis in the direction of the normal; Eccentricity<1 creates
pancakes perpendicular to the normal vector.
double = obj.GetEccentricityMaxValue () - Control the shape of elliptical splatting. Eccentricity is the ratio of the major axis (aligned along normal) to the minor (axes) aligned along other two axes.
So Eccentricity > 1 creates needles with the long axis in the direction of the normal; Eccentricity<1 creates
pancakes perpendicular to the normal vector.
double = obj.GetEccentricity () - Control the shape of elliptical splatting. Eccentricity is the
ratio of the major axis (aligned along normal) to the minor (axes) aligned along other two axes. So Eccentricity
> 1 creates needles with the long axis in the direction of the normal; Eccentricity<1 creates pancakes
perpendicular to the normal vector.
obj.SetScalarWarping (int ) - Turn on/off the scaling of splats by scalar value.
int = obj.GetScalarWarping () - Turn on/off the scaling of splats by scalar value.
obj.ScalarWarpingOn () - Turn on/off the scaling of splats by scalar value.
obj.ScalarWarpingOff () - Turn on/off the scaling of splats by scalar value.
obj.SetCapping (int ) - Turn on/off the capping of the outer boundary of the volume to a specified
cap value. This can be used to close surfaces (after iso-surfacing) and create other effects.
int = obj.GetCapping () - Turn on/off the capping of the outer boundary of the volume to a specified
cap value. This can be used to close surfaces (after iso-surfacing) and create other effects.
obj.CappingOn () - Turn on/off the capping of the outer boundary of the volume to a specified cap
value. This can be used to close surfaces (after iso-surfacing) and create other effects.
obj.CappingOff () - Turn on/off the capping of the outer boundary of the volume to a specified cap
value. This can be used to close surfaces (after iso-surfacing) and create other effects.
obj.SetCapValue (double ) - Specify the cap value to use. (This instance variable only has effect
if the ivar Capping is on.)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.5 vtkImageAccumulate
1589
double = obj.GetCapValue () - Specify the cap value to use. (This instance variable only has
effect if the ivar Capping is on.)
obj.SetAccumulationMode (int ) - Specify the scalar accumulation mode. This mode expresses
how scalar values are combined when splats are overlapped. The Max mode acts like a set union operation
and is the most commonly used; the Min mode acts like a set intersection, and the sum is just weird.
int = obj.GetAccumulationModeMinValue () - Specify the scalar accumulation mode. This
mode expresses how scalar values are combined when splats are overlapped. The Max mode acts like a set
union operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is
just weird.
int = obj.GetAccumulationModeMaxValue () - Specify the scalar accumulation mode. This
mode expresses how scalar values are combined when splats are overlapped. The Max mode acts like a set
union operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is
just weird.
int = obj.GetAccumulationMode () - Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats are overlapped. The Max mode acts like a set union
operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just
weird.
obj.SetAccumulationModeToMin () - Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats are overlapped. The Max mode acts like a set union
operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just
weird.
obj.SetAccumulationModeToMax () - Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats are overlapped. The Max mode acts like a set union
operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just
weird.
obj.SetAccumulationModeToSum () - Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats are overlapped. The Max mode acts like a set union
operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just
weird.
string = obj.GetAccumulationModeAsString () - Specify the scalar accumulation mode.
This mode expresses how scalar values are combined when splats are overlapped. The Max mode acts
like a set union operation and is the most commonly used; the Min mode acts like a set intersection, and the
sum is just weird.
obj.SetNullValue (double ) - Set the Null value for output points not receiving a contribution from
the input points. (This is the initial value of the voxel samples.)
double = obj.GetNullValue () - Set the Null value for output points not receiving a contribution
from the input points. (This is the initial value of the voxel samples.)
obj.ComputeModelBounds (vtkDataSet input, vtkImageData output, vtkInformation outInfo) - Compute the size of the sample bounding box automatically from the
input data. This is an internal helper function.
36.5
vtkImageAccumulate
1590
36.5.1
Usage
vtkImageAccumulate - This filter divides component space into discrete bins. It then counts the number of pixels
associated with each bin. The output is this "scatter plot" (histogram values for 1D). The dimensionality of the
output depends on how many components the input pixels have. Input pixels with one component generate a 1D histogram. This filter can only handle images with 1 to 3 scalar components. The input can be any type, but
the output is always int. Some statistics are computed on the pixel values at the same time. The SetStencil and
ReverseStencil functions allow the statistics to be computed on an arbitrary portion of the input data. See the
documentation for vtkImageStencilData for more information.
This filter also support ignoring pixel with value equal to 0. Using this option with vtkImageMask may result in results
being slightly off since 0 could be a valid value from your input.
To create an instance of class vtkImageAccumulate, simply invoke its constructor as follows
obj = vtkImageAccumulate
36.5.2
Methods
The class vtkImageAccumulate has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageAccumulate
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageAccumulate = obj.NewInstance ()
vtkImageAccumulate = obj.SafeDownCast (vtkObject o)
obj.SetComponentSpacing (double , double , double ) - Set/Get - The component
spacing is the dimension of each bin. This ends up being the spacing of the output "image". If the number
of input scalar components are less than three, then some of these spacing values are ignored. For a 1D
histogram with 10 bins spanning the values 1000 to 2000, this spacing should be set to 100, 0, 0
obj.SetComponentSpacing (double a[3]) - Set/Get - The component spacing is the dimension
of each bin. This ends up being the spacing of the output "image". If the number of input scalar components
are less than three, then some of these spacing values are ignored. For a 1D histogram with 10 bins spanning
the values 1000 to 2000, this spacing should be set to 100, 0, 0
double = obj. GetComponentSpacing () - Set/Get - The component spacing is the dimension
of each bin. This ends up being the spacing of the output "image". If the number of input scalar components
are less than three, then some of these spacing values are ignored. For a 1D histogram with 10 bins spanning
the values 1000 to 2000, this spacing should be set to 100, 0, 0
obj.SetComponentOrigin (double , double , double ) - Set/Get - The component origin
is the location of bin (0, 0, 0). Note that if the Component extent does not include the value (0,0,0), then this
origin bin will not actually be in the output. The origin of the output ends up being the same as the componenet
origin. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this origin should be set to 1000,
0, 0
obj.SetComponentOrigin (double a[3]) - Set/Get - The component origin is the location of bin
(0, 0, 0). Note that if the Component extent does not include the value (0,0,0), then this origin bin will not
actually be in the output. The origin of the output ends up being the same as the componenet origin. For a
1D histogram with 10 bins spanning the values 1000 to 2000, this origin should be set to 1000, 0, 0
double = obj. GetComponentOrigin () - Set/Get - The component origin is the location of bin
(0, 0, 0). Note that if the Component extent does not include the value (0,0,0), then this origin bin will not
actually be in the output. The origin of the output ends up being the same as the componenet origin. For a
1D histogram with 10 bins spanning the values 1000 to 2000, this origin should be set to 1000, 0, 0
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.6 vtkImageAnisotropicDiffusion2D
1591
obj.SetComponentExtent (int extent[6]) - Set/Get - The component extent sets the number/extent of the bins. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this extent should
be set to 0, 9, 0, 0, 0, 0. The extent specifies inclusive min/max values. This implies that the top extent should
be set to the number of bins - 1.
obj.SetComponentExtent (int minX, int maxX, int minY, int maxY, int
minZ, int maxZ) - Set/Get - The component extent sets the number/extent of the bins. For a 1D
histogram with 10 bins spanning the values 1000 to 2000, this extent should be set to 0, 9, 0, 0, 0, 0. The
extent specifies inclusive min/max values. This implies that the top extent should be set to the number of bins
- 1.
obj.GetComponentExtent (int extent[6]) - Set/Get - The component extent sets the number/extent of the bins. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this extent should
be set to 0, 9, 0, 0, 0, 0. The extent specifies inclusive min/max values. This implies that the top extent should
be set to the number of bins - 1.
int = obj.GetComponentExtent () - Use a stencil to specify which voxels to accumulate.
obj.SetStencil (vtkImageStencilData stencil) - Use a stencil to specify which voxels to
accumulate.
vtkImageStencilData = obj.GetStencil () - Use a stencil to specify which voxels to accumulate.
obj.SetReverseStencil (int ) - Reverse the stencil.
int = obj.GetReverseStencilMinValue () - Reverse the stencil.
int = obj.GetReverseStencilMaxValue () - Reverse the stencil.
obj.ReverseStencilOn () - Reverse the stencil.
obj.ReverseStencilOff () - Reverse the stencil.
int = obj.GetReverseStencil () - Reverse the stencil.
double = obj.
double = obj.
double = obj.
double = obj.
36.6
vtkImageAnisotropicDiffusion2D
1592
36.6.1
Usage
36.6.2
Methods
The class vtkImageAnisotropicDiffusion2D has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageAnisotropicDiffusion2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageAnisotropicDiffusion2D = obj.NewInstance ()
vtkImageAnisotropicDiffusion2D = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfIterations (int num) - This method sets the number of interations which also
affects the input neighborhood needed to compute one output pixel. Each iterations requires an extra pixel
layer on the neighborhood. This is only relavent when you are trying to stream or are requesting a sub extent
of the "wholeExtent".
int = obj.GetNumberOfIterations () - Get the number of iterations.
obj.SetDiffusionThreshold (double ) - Set/Get the difference threshold that stops diffusion.
when the difference between two pixel is greater than this threshold, the pixels are not diffused. This causes
diffusion to avoid sharp edges. If the GradientMagnitudeThreshold is set, then gradient magnitude is used for
comparison instead of pixel differences.
double = obj.GetDiffusionThreshold () - Set/Get the difference threshold that stops diffusion. when the difference between two pixel is greater than this threshold, the pixels are not diffused. This
causes diffusion to avoid sharp edges. If the GradientMagnitudeThreshold is set, then gradient magnitude is
used for comparison instead of pixel differences.
obj.SetDiffusionFactor (double ) - The diffusion factor specifies how much neighboring pixels
effect each other. No diffusion occurs with a factor of 0, and a diffusion factor of 1 causes the pixel to become
the average of all its neighbors.
double = obj.GetDiffusionFactor () - The diffusion factor specifies how much neighboring
pixels effect each other. No diffusion occurs with a factor of 0, and a diffusion factor of 1 causes the pixel to
become the average of all its neighbors.
obj.SetFaces (int ) - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
int = obj.GetFaces () - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
obj.FacesOn () - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
obj.FacesOff () - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.7 vtkImageAnisotropicDiffusion3D
1593
36.7
vtkImageAnisotropicDiffusion3D
36.7.1
Usage
36.7.2
Methods
The class vtkImageAnisotropicDiffusion3D has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageAnisotropicDiffusion3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1594
vtkImageAnisotropicDiffusion3D = obj.NewInstance ()
vtkImageAnisotropicDiffusion3D = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfIterations (int num) - This method sets the number of interations which also
affects the input neighborhood needed to compute one output pixel. Each iterations requires an extra pixel
layer on the neighborhood. This is only relavent when you are trying to stream or are requesting a sub extent
of the "wholeExtent".
int = obj.GetNumberOfIterations () - Get the number of iterations.
obj.SetDiffusionThreshold (double ) - Set/Get the difference threshold that stops diffusion.
when the difference between two pixel is greater than this threshold, the pixels are not diffused. This causes
diffusion to avoid sharp edges. If the GradientMagnitudeThreshold is set, then gradient magnitude is used for
comparison instead of pixel differences.
double = obj.GetDiffusionThreshold () - Set/Get the difference threshold that stops diffusion. when the difference between two pixel is greater than this threshold, the pixels are not diffused. This
causes diffusion to avoid sharp edges. If the GradientMagnitudeThreshold is set, then gradient magnitude is
used for comparison instead of pixel differences.
obj.SetDiffusionFactor (double ) - Set/Get the difference factor
double = obj.GetDiffusionFactor () - Set/Get the difference factor
obj.SetFaces (int ) - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
int = obj.GetFaces () - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
obj.FacesOn () - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
obj.FacesOff () - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
obj.SetEdges (int ) - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
int = obj.GetEdges () - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
obj.EdgesOn () - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
obj.EdgesOff () - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
obj.SetCorners (int ) - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
int = obj.GetCorners () - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
obj.CornersOn () - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
obj.CornersOff () - Choose neighbors to diffuse (6 faces, 12 edges, 8 corners).
obj.SetGradientMagnitudeThreshold (int ) - Switch between gradient magnitude threshold
and pixel gradient threshold.
int = obj.GetGradientMagnitudeThreshold () - Switch between gradient magnitude threshold and pixel gradient threshold.
obj.GradientMagnitudeThresholdOn () - Switch between gradient magnitude threshold and
pixel gradient threshold.
obj.GradientMagnitudeThresholdOff () - Switch between gradient magnitude threshold and
pixel gradient threshold.
36.8
vtkImageAppend
36.8 vtkImageAppend
36.8.1
1595
Usage
vtkImageAppend takes the components from multiple inputs and merges them into one output. The output images
are append along the "AppendAxis". Except for the append axis, all inputs must have the same extent. All inputs
must have the same number of scalar components. A future extension might be to pad or clip inputs to have the
same extent. The output has the same origin and spacing as the first input. The origin and spacing of all other
inputs are ignored. All inputs must have the same scalar type.
To create an instance of class vtkImageAppend, simply invoke its constructor as follows
obj = vtkImageAppend
36.8.2
Methods
The class vtkImageAppend has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkImageAppend class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageAppend = obj.NewInstance ()
vtkImageAppend = obj.SafeDownCast (vtkObject o)
obj.ReplaceNthInputConnection (int idx, vtkAlgorithmOutput input) - Replace
one of the input connections with a new input. You can only replace input connections that you previously
created with AddInputConnection() or, in the case of the first input, with SetInputConnection().
obj.SetInput (int num, vtkDataObject input) - Set an Input of this filter. This method
is only for support of old-style pipeline connections. When writing new code you should use SetInputConnection(), AddInputConnection(), and ReplaceNthInputConnection() instead.
obj.SetInput (vtkDataObject input) - Set an Input of this filter. This method is only for support
of old-style pipeline connections. When writing new code you should use SetInputConnection(), AddInputConnection(), and ReplaceNthInputConnection() instead.
vtkDataObject = obj.GetInput (int num) - Get one input to this filter. This method is only
for support of old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetInputConnection(0, num).
vtkDataObject = obj.GetInput () - Get one input to this filter. This method is only for support of
old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetInputConnection(0,
num).
int = obj.GetNumberOfInputs () - Get the number of inputs to this filter. This method is only for
support of old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetNumberOfInputConnections(0).
obj.SetAppendAxis (int ) - This axis is expanded to hold the multiple images. The default AppendAxis is the X axis. If you want to create a volue from a series of XY images, then you should set the AppendAxis to 2 (Z axis).
int = obj.GetAppendAxis () - This axis is expanded to hold the multiple images. The default
AppendAxis is the X axis. If you want to create a volue from a series of XY images, then you should set the
AppendAxis to 2 (Z axis).
obj.SetPreserveExtents (int ) - By default "PreserveExtents" is off and the append axis is used.
When "PreseveExtents" is on, the extent of the inputs is used to place the image in the output. The whole
extent of the output is the union of the input whole extents. Any portion of the output not covered by the inputs
is set to zero. The origin and spacing is taken from the first input.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1596
36.9
vtkImageAppendComponents
36.9.1
Usage
vtkImageAppendComponents takes the components from two inputs and merges them into one output. If Input1
has M components, and Input2 has N components, the output will have M+N components with input1 components
coming first.
To create an instance of class vtkImageAppendComponents, simply invoke its constructor as follows
obj = vtkImageAppendComponents
36.9.2
Methods
The class vtkImageAppendComponents has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageAppendComponents class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageAppendComponents = obj.NewInstance ()
vtkImageAppendComponents = obj.SafeDownCast (vtkObject o)
obj.ReplaceNthInputConnection (int idx, vtkAlgorithmOutput input) - Replace
one of the input connections with a new input. You can only replace input connections that you previously
created with AddInputConnection() or, in the case of the first input, with SetInputConnection().
obj.SetInput (int num, vtkDataObject input) - Set an Input of this filter. This method
is only for support of old-style pipeline connections. When writing new code you should use SetInputConnection(), AddInputConnection(), and ReplaceNthInputConnection() instead.
obj.SetInput (vtkDataObject input) - Set an Input of this filter. This method is only for support
of old-style pipeline connections. When writing new code you should use SetInputConnection(), AddInputConnection(), and ReplaceNthInputConnection() instead.
vtkDataObject = obj.GetInput (int num) - Get one input to this filter. This method is only
for support of old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetInputConnection(0, num).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.10 vtkImageBlend
1597
vtkDataObject = obj.GetInput () - Get one input to this filter. This method is only for support of
old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetInputConnection(0,
num).
int = obj.GetNumberOfInputs () - Get the number of inputs to this filter. This method is only for
support of old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetNumberOfInputConnections(0).
36.10
vtkImageBlend
36.10.1
Usage
vtkImageBlend takes L, LA, RGB, or RGBA images as input and blends them according to the alpha values and/or
the opacity setting for each input.
The spacing, origin, extent, and number of components of the output are the same as those for the first input. If
the input has an alpha component, then this component is copied unchanged into the output. In addition, if the first
input has either one component or two components i.e. if it is either L (greyscale) or LA (greyscale + alpha) then all
other inputs must also be L or LA.
Different blending modes are available:
Normal (default) : This is the standard blending mode used by OpenGL and other graphics packages. The output
always has the same number of components and the same extent as the first input. The alpha value of the first
input is not used in the blending computation, instead it is copied directly to the output.
output <- input[0]
foreach input i {
foreach pixel px {
r <- input[i](px)(alpha) * opacity[i]
f <- (255 - r)
output(px) <- output(px) * f + input(px) * r
}
}
Compound : Images are compounded together and each component is scaled by the sum of the alpha/opacity values. Use the CompoundThreshold method to set specify a threshold in compound mode. Pixels with opacityalpha
less or equal than this threshold are ignored. The alpha value of the first input, if present, is NOT copied to the
alpha value of the output. The output always has the same number of components and the same extent as the first
input.
output <- 0
foreach pixel px {
sum <- 0
foreach input i {
r <- input[i](px)(alpha) * opacity(i)
sum <- sum + r
if r > threshold {
output(px) <- output(px) + input(px) * r
}
}
output(px) <- output(px) / sum
}
1598
36.10.2
Methods
The class vtkImageBlend has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkImageBlend class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageBlend = obj.NewInstance ()
vtkImageBlend = obj.SafeDownCast (vtkObject o)
obj.ReplaceNthInputConnection (int idx, vtkAlgorithmOutput input) - Replace
one of the input connections with a new input. You can only replace input connections that you previously
created with AddInputConnection() or, in the case of the first input, with SetInputConnection().
obj.SetInput (int num, vtkDataObject input) - Set an Input of this filter. This method
is only for support of old-style pipeline connections. When writing new code you should use SetInputConnection(), AddInputConnection(), and ReplaceNthInputConnection() instead.
obj.SetInput (vtkDataObject input) - Set an Input of this filter. This method is only for support
of old-style pipeline connections. When writing new code you should use SetInputConnection(), AddInputConnection(), and ReplaceNthInputConnection() instead.
vtkDataObject = obj.GetInput (int num) - Get one input to this filter. This method is only
for support of old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetInputConnection(0, num).
vtkDataObject = obj.GetInput () - Get one input to this filter. This method is only for support of
old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetInputConnection(0,
num).
int = obj.GetNumberOfInputs () - Get the number of inputs to this filter. This method is only for
support of old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetNumberOfInputConnections(0).
obj.SetOpacity (int idx, double opacity) - Set the opacity of an input image: the alpha
values of the image are multiplied by the opacity. The opacity of image idx=0 is ignored.
double = obj.GetOpacity (int idx) - Set the opacity of an input image: the alpha values of the
image are multiplied by the opacity. The opacity of image idx=0 is ignored.
obj.SetStencil (vtkImageStencilData stencil) - Set a stencil to apply when blending the
data.
vtkImageStencilData = obj.GetStencil () - Set a stencil to apply when blending the data.
obj.SetBlendMode (int ) - Set the blend mode
int = obj.GetBlendModeMinValue () - Set the blend mode
int = obj.GetBlendModeMaxValue () - Set the blend mode
int = obj.GetBlendMode () - Set the blend mode
obj.SetBlendModeToNormal () - Set the blend mode
obj.SetBlendModeToCompound () - Set the blend mode
string = obj.GetBlendModeAsString (void ) - Set the blend mode
obj.SetCompoundThreshold (double ) - Specify a threshold in compound mode. Pixels with
opacityalpha less or equal the threshold are ignored.
double = obj.GetCompoundThreshold () - Specify a threshold in compound mode. Pixels with
opacityalpha less or equal the threshold are ignored.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.11 vtkImageButterworthHighPass
36.11
1599
vtkImageButterworthHighPass
36.11.1
Usage
This filter only works on an image after it has been converted to frequency domain by a vtkImageFFT filter. A vtkImageRFFT filter can be used to convert the output back into the spatial domain. vtkImageButterworthHighPass the
frequency components around 0 are attenuated. Input and output are in doubles, with two components (complex
numbers). out(i, j) = 1 / (1 + pow(CutOff/Freq(i,j), 2Order));
To create an instance of class vtkImageButterworthHighPass, simply invoke its constructor as follows
obj = vtkImageButterworthHighPass
36.11.2
Methods
The class vtkImageButterworthHighPass has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageButterworthHighPass class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageButterworthHighPass = obj.NewInstance ()
vtkImageButterworthHighPass = obj.SafeDownCast (vtkObject o)
obj.SetCutOff (double , double , double ) - Set/Get the cutoff frequency for each axis.
The values are specified in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data
spacing).
obj.SetCutOff (double a[3]) - Set/Get the cutoff frequency for each axis. The values are specified in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified in
the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetXCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetYCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetZCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj. GetCutOff () - Set/Get the cutoff frequency for each axis. The values are specified in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj.GetXCutOff () - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj.GetYCutOff () - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj.GetZCutOff () - The order determines sharpness of the cutoff curve.
obj.SetOrder (int ) - The order determines sharpness of the cutoff curve.
int = obj.GetOrder () - The order determines sharpness of the cutoff curve.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1600
36.12
vtkImageButterworthLowPass
36.12.1
Usage
This filter only works on an image after it has been converted to frequency domain by a vtkImageFFT filter. A
vtkImageRFFT filter can be used to convert the output back into the spatial domain. vtkImageButterworthLowPass
the high frequency components are attenuated. Input and output are in doubles, with two components (complex
numbers). out(i, j) = (1 + pow(CutOff/Freq(i,j), 2Order));
To create an instance of class vtkImageButterworthLowPass, simply invoke its constructor as follows
obj = vtkImageButterworthLowPass
36.12.2
Methods
The class vtkImageButterworthLowPass has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageButterworthLowPass class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageButterworthLowPass = obj.NewInstance ()
vtkImageButterworthLowPass = obj.SafeDownCast (vtkObject o)
obj.SetCutOff (double , double , double ) - Set/Get the cutoff frequency for each axis.
The values are specified in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data
spacing).
obj.SetCutOff (double a[3]) - Set/Get the cutoff frequency for each axis. The values are specified in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified in
the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetXCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetYCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetZCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj. GetCutOff () - Set/Get the cutoff frequency for each axis. The values are specified in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj.GetXCutOff () - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj.GetYCutOff () - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj.GetZCutOff () - The order determines sharpness of the cutoff curve.
obj.SetOrder (int ) - The order determines sharpness of the cutoff curve.
int = obj.GetOrder () - The order determines sharpness of the cutoff curve.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.13 vtkImageCacheFilter
36.13
1601
vtkImageCacheFilter
36.13.1
Usage
vtkImageCacheFilter keep a number of vtkImageDataObjects from previous updates to satisfy future updates without needing to update the input. It does not change the data at all. It just makes the pipeline more efficient at the
expense of using extra memory.
To create an instance of class vtkImageCacheFilter, simply invoke its constructor as follows
obj = vtkImageCacheFilter
36.13.2
Methods
The class vtkImageCacheFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageCacheFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageCacheFilter = obj.NewInstance ()
vtkImageCacheFilter = obj.SafeDownCast (vtkObject o)
obj.SetCacheSize (int size) - This is the maximum number of images that can be retained in
memory. it defaults to 10.
int = obj.GetCacheSize () - This is the maximum number of images that can be retained in memory. it defaults to 10.
36.14
vtkImageCanvasSource2D
36.14.1
Usage
vtkImageCanvasSource2D is a source that starts as a blank image. you may add to the image with two-dimensional
drawing routines. It can paint multi-spectral images.
To create an instance of class vtkImageCanvasSource2D, simply invoke its constructor as follows
obj = vtkImageCanvasSource2D
36.14.2
Methods
The class vtkImageCanvasSource2D has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageCanvasSource2D
class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1602
36.14 vtkImageCanvasSource2D
1603
int = obj.GetDefaultZ () - The drawing operations can only draw into one 2D XY plane at a time.
If the canvas is a 3D volume, then this z value is used as the default for 2D operations. The default is 0.
obj.SetRatio (double , double , double ) - Set/Get Ratio. This is the value that is used to
pre-multiply each (x, y, z) drawing coordinates (including DefaultZ). The default is (1, 1, 1)
obj.SetRatio (double a[3]) - Set/Get Ratio. This is the value that is used to pre-multiply each (x,
y, z) drawing coordinates (including DefaultZ). The default is (1, 1, 1)
double = obj. GetRatio () - Set/Get Ratio. This is the value that is used to pre-multiply each (x,
y, z) drawing coordinates (including DefaultZ). The default is (1, 1, 1)
obj.SetNumberOfScalarComponents (int i) - Set the number of scalar components
int = obj.GetNumberOfScalarComponents () const - Set the number of scalar components
obj.SetScalarTypeToFloat () - Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these
methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will
be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This
is for backwards compatibility
obj.SetScalarTypeToDouble () - Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these
methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will
be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This
is for backwards compatibility
obj.SetScalarTypeToInt () - Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these
methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will
be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This
is for backwards compatibility
obj.SetScalarTypeToUnsignedInt () - Set/Get the data scalar type (i.e VTK_DOUBLE). Note
that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the
image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some
other type. This is for backwards compatibility
obj.SetScalarTypeToLong () - Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these
methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will
be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This
is for backwards compatibility
obj.SetScalarTypeToUnsignedLong () - Set/Get the data scalar type (i.e VTK_DOUBLE). Note
that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the
image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some
other type. This is for backwards compatibility
obj.SetScalarTypeToShort () - Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these
methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will
be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This
is for backwards compatibility
obj.SetScalarTypeToUnsignedShort () - Set/Get the data scalar type (i.e VTK_DOUBLE). Note
that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image
data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other
type. This is for backwards compatibility
obj.SetScalarTypeToUnsignedChar () - Set/Get the data scalar type (i.e VTK_DOUBLE). Note
that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the
image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some
other type. This is for backwards compatibility
obj.SetScalarTypeToChar () - Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these
methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will
be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This
is for backwards compatibility
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1604
obj.SetScalarType (int ) - Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be
once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is
for backwards compatibility
int = obj.GetScalarType () const - Set/Get the data scalar type (i.e VTK_DOUBLE). Note that
these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image
data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other
type. This is for backwards compatibility
36.15
vtkImageCast
36.15.1
Usage
vtkImageCast filter casts the input type to match the output type in the image processing pipeline. The filter does
nothing if the input already has the correct type. To specify the "CastTo" type, use "SetOutputScalarType" method.
To create an instance of class vtkImageCast, simply invoke its constructor as follows
obj = vtkImageCast
36.15.2
Methods
The class vtkImageCast has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkImageCast class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageCast = obj.NewInstance ()
vtkImageCast = obj.SafeDownCast (vtkObject o)
obj.SetOutputScalarType (int ) - Set the desired output scalar type to cast to.
int = obj.GetOutputScalarType () - Set the desired output scalar type to cast to.
obj.SetOutputScalarTypeToFloat () - Set the desired output scalar type to cast to.
obj.SetOutputScalarTypeToDouble () - Set the desired output scalar type to cast to.
obj.SetOutputScalarTypeToInt () - Set the desired output scalar type to cast to.
obj.SetOutputScalarTypeToUnsignedInt () - Set the desired output scalar type to cast to.
obj.SetOutputScalarTypeToLong () - Set the desired output scalar type to cast to.
obj.SetOutputScalarTypeToUnsignedLong () - Set the desired output scalar type to cast to.
obj.SetOutputScalarTypeToShort () - Set the desired output scalar type to cast to.
obj.SetOutputScalarTypeToUnsignedShort () - Set the desired output scalar type to cast to.
obj.SetOutputScalarTypeToUnsignedChar () - Set the desired output scalar type to cast to.
obj.SetOutputScalarTypeToChar () - Set the desired output scalar type to cast to.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.16 vtkImageChangeInformation
1605
obj.SetClampOverflow (int ) - When the ClampOverflow flag is on, the data is thresholded so
that the output value does not exceed the max or min of the data type. By default ClampOverflow is off.
int = obj.GetClampOverflow () - When the ClampOverflow flag is on, the data is thresholded so
that the output value does not exceed the max or min of the data type. By default ClampOverflow is off.
obj.ClampOverflowOn () - When the ClampOverflow flag is on, the data is thresholded so that the
output value does not exceed the max or min of the data type. By default ClampOverflow is off.
obj.ClampOverflowOff () - When the ClampOverflow flag is on, the data is thresholded so that the
output value does not exceed the max or min of the data type. By default ClampOverflow is off.
36.16
vtkImageChangeInformation
36.16.1
Usage
vtkImageChangeInformation modify the spacing, origin, or extent of the data without changing the data itself. The
data is not resampled by this filter, only the information accompanying the data is modified.
To create an instance of class vtkImageChangeInformation, simply invoke its constructor as follows
obj = vtkImageChangeInformation
36.16.2
Methods
The class vtkImageChangeInformation has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageChangeInformation
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageChangeInformation = obj.NewInstance ()
vtkImageChangeInformation = obj.SafeDownCast (vtkObject o)
obj.SetInformationInput (vtkImageData ) - Copy the information from another data set. By
default, the information is copied from the input.
vtkImageData = obj.GetInformationInput () - Copy the information from another data set.
By default, the information is copied from the input.
obj.SetOutputExtentStart (int , int , int ) - Specify new starting values for the extent
explicitly. These values are used as WholeExtent[0], WholeExtent[2] and WholeExtent[4] of the output. The
default is to the use the extent start of the Input, or of the InformationInput if InformationInput is set.
obj.SetOutputExtentStart (int a[3]) - Specify new starting values for the extent explicitly.
These values are used as WholeExtent[0], WholeExtent[2] and WholeExtent[4] of the output. The default is
to the use the extent start of the Input, or of the InformationInput if InformationInput is set.
int = obj. GetOutputExtentStart () - Specify new starting values for the extent explicitly.
These values are used as WholeExtent[0], WholeExtent[2] and WholeExtent[4] of the output. The default is
to the use the extent start of the Input, or of the InformationInput if InformationInput is set.
obj.SetOutputSpacing (double , double , double ) - Specify a new data spacing explicitly. The default is to use the spacing of the Input, or of the InformationInput if InformationInput is set.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1606
obj.SetOutputSpacing (double a[3]) - Specify a new data spacing explicitly. The default is to
use the spacing of the Input, or of the InformationInput if InformationInput is set.
double = obj. GetOutputSpacing () - Specify a new data spacing explicitly. The default is to
use the spacing of the Input, or of the InformationInput if InformationInput is set.
obj.SetOutputOrigin (double , double , double ) - Specify a new data origin explicitly.
The default is to use the origin of the Input, or of the InformationInput if InformationInput is set.
obj.SetOutputOrigin (double a[3]) - Specify a new data origin explicitly. The default is to use
the origin of the Input, or of the InformationInput if InformationInput is set.
double = obj. GetOutputOrigin () - Specify a new data origin explicitly. The default is to use
the origin of the Input, or of the InformationInput if InformationInput is set.
obj.SetCenterImage (int ) - Set the Origin of the output so that image coordinate (0,0,0) lies at
the Center of the data set. This will override SetOutputOrigin. This is often a useful operation to apply before
using vtkImageReslice to apply a transformation to an image.
obj.CenterImageOn () - Set the Origin of the output so that image coordinate (0,0,0) lies at the Center
of the data set. This will override SetOutputOrigin. This is often a useful operation to apply before using vtkImageReslice to apply a transformation to an image.
obj.CenterImageOff () - Set the Origin of the output so that image coordinate (0,0,0) lies at the
Center of the data set. This will override SetOutputOrigin. This is often a useful operation to apply before
using vtkImageReslice to apply a transformation to an image.
int = obj.GetCenterImage () - Set the Origin of the output so that image coordinate (0,0,0) lies at
the Center of the data set. This will override SetOutputOrigin. This is often a useful operation to apply before
using vtkImageReslice to apply a transformation to an image.
obj.SetExtentTranslation (int , int , int ) - Apply a translation to the extent.
obj.SetExtentTranslation (int a[3]) - Apply a translation to the extent.
int = obj.
obj.SetOriginScale (double , double , double ) - Apply a scale to the origin. The scale
is applied before the translation.
obj.SetOriginScale (double a[3]) - Apply a scale to the origin. The scale is applied before the
translation.
double = obj.
translation.
36.17
GetOriginScale () - Apply a scale to the origin. The scale is applied before the
vtkImageCheckerboard
36.18 vtkImageCityBlockDistance
36.17.1
1607
Usage
vtkImageCheckerboard displays two images as one using a checkerboard pattern. This filter can be used to compare two images. The checkerboard pattern is controlled by the NumberOfDivisions ivar. This controls the number
of checkerboard divisions in the whole extent of the image.
To create an instance of class vtkImageCheckerboard, simply invoke its constructor as follows
obj = vtkImageCheckerboard
36.17.2
Methods
The class vtkImageCheckerboard has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageCheckerboard
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageCheckerboard = obj.NewInstance ()
vtkImageCheckerboard = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfDivisions (int , int , int ) - Set/Get the number of divisions along
each axis.
obj.SetNumberOfDivisions (int a[3]) - Set/Get the number of divisions along each axis.
int = obj.
36.18
vtkImageCityBlockDistance
36.18.1
Usage
vtkImageCityBlockDistance creates a distance map using the city block (Manhatten) distance measure. The input is
a mask. Zero values are considered boundaries. The output pixel is the minimum of the input pixel and the distance
to a boundary (or neighbor value + 1 unit). distance values are calculated in pixels. The filter works by taking 6
passes (for 3d distance map): 2 along each axis (forward and backward). Each pass keeps a running minimum
distance. For some reason, I preserve the sign if the distance. If the input mask is initially negative, the output
distances will be negative. Distances maps can have inside (negative regions) and outsides (positive regions).
To create an instance of class vtkImageCityBlockDistance, simply invoke its constructor as follows
obj = vtkImageCityBlockDistance
36.18.2
Methods
The class vtkImageCityBlockDistance has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageCityBlockDistance
class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1608
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageCityBlockDistance = obj.NewInstance ()
vtkImageCityBlockDistance = obj.SafeDownCast (vtkObject o)
36.19
vtkImageClip
36.19.1
Usage
vtkImageClip will make an image smaller. The output must have an image extent which is the subset of the input.
The filter has two modes of operation: 1: By default, the data is not copied in this filter. Only the whole extent is
modified. 2: If ClipDataOn is set, then you will get no more that the clipped extent.
To create an instance of class vtkImageClip, simply invoke its constructor as follows
obj = vtkImageClip
36.19.2
Methods
The class vtkImageClip has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkImageClip class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageClip = obj.NewInstance ()
vtkImageClip = obj.SafeDownCast (vtkObject o)
obj.SetOutputWholeExtent (int extent[6], vtkInformation outInfo)
whole extent of the output has to be set explicitly.
The
obj.SetOutputWholeExtent (int minX, int maxX, int minY, int maxY, int
minZ, int maxZ) - The whole extent of the output has to be set explicitly.
obj.GetOutputWholeExtent (int extent[6]) - The whole extent of the output has to be set
explicitly.
int = obj.GetOutputWholeExtent ()
obj.ResetOutputWholeExtent ()
obj.SetClipData (int ) - By default, ClipData is off, and only the WholeExtent is modified. the
datas extent may actually be larger. When this flag is on, the data extent will be no more than the OutputWholeExtent.
int = obj.GetClipData () - By default, ClipData is off, and only the WholeExtent is modified. the
datas extent may actually be larger. When this flag is on, the data extent will be no more than the OutputWholeExtent.
obj.ClipDataOn () - By default, ClipData is off, and only the WholeExtent is modified. the datas extent
may actually be larger. When this flag is on, the data extent will be no more than the OutputWholeExtent.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.20 vtkImageConnector
1609
obj.ClipDataOff () - By default, ClipData is off, and only the WholeExtent is modified. the datas
extent may actually be larger. When this flag is on, the data extent will be no more than the OutputWholeExtent.
obj.SetOutputWholeExtent (int piece, int numPieces) - Hack set output by piece
36.20
vtkImageConnector
36.20.1
Usage
vtkImageConnector is a helper class for connectivity filters. It is not meant to be used directly. It implements a
stack and breadth first search necessary for some connectivity filters. Filtered axes sets the dimensionality of the
neighbor comparison, and cannot be more than three dimensions. As implemented, only voxels which share faces
are considered neighbors.
To create an instance of class vtkImageConnector, simply invoke its constructor as follows
obj = vtkImageConnector
36.20.2
Methods
The class vtkImageConnector has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageConnector class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageConnector = obj.NewInstance ()
vtkImageConnector = obj.SafeDownCast (vtkObject o)
obj.RemoveAllSeeds ()
obj.SetConnectedValue (char ) - Values used by the MarkRegion method
char = obj.GetConnectedValue () - Values used by the MarkRegion method
obj.SetUnconnectedValue (char ) - Values used by the MarkRegion method
char = obj.GetUnconnectedValue () - Values used by the MarkRegion method
obj.MarkData (vtkImageData data, int dimensionality, int ext[6]) - Input a
data of 0s and "UnconnectedValue"s. Seeds of this object are used to find connected pixels. All pixels
connected to seeds are set to ConnectedValue. The data has to be unsigned char.
36.21
vtkImageConstantPad
1610
36.21.1
Usage
vtkImageConstantPad changes the image extent of its input. Any pixels outside of the original image extent are
filled with a constant value (default is 0.0).
To create an instance of class vtkImageConstantPad, simply invoke its constructor as follows
obj = vtkImageConstantPad
36.21.2
Methods
The class vtkImageConstantPad has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageConstantPad class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageConstantPad = obj.NewInstance ()
vtkImageConstantPad = obj.SafeDownCast (vtkObject o)
obj.SetConstant (double ) - Set/Get the pad value.
double = obj.GetConstant () - Set/Get the pad value.
36.22
vtkImageContinuousDilate3D
36.22.1
Usage
vtkImageContinuousDilate3D replaces a pixel with the maximum over an ellipsoidal neighborhood. If KernelSize of
an axis is 1, no processing is done on that axis.
To create an instance of class vtkImageContinuousDilate3D, simply invoke its constructor as follows
obj = vtkImageContinuousDilate3D
36.22.2
Methods
The class vtkImageContinuousDilate3D has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageContinuousDilate3D
class.
string = obj.GetClassName () - Construct an instance of vtkImageContinuousDilate3D filter. By
default zero values are dilated.
int = obj.IsA (string name) - Construct an instance of vtkImageContinuousDilate3D filter. By
default zero values are dilated.
vtkImageContinuousDilate3D = obj.NewInstance () - Construct an instance of vtkImageContinuousDilate3D filter. By default zero values are dilated.
vtkImageContinuousDilate3D = obj.SafeDownCast (vtkObject o) - Construct an instance of vtkImageContinuousDilate3D filter. By default zero values are dilated.
obj.SetKernelSize (int size0, int size1, int size2) - This method sets the size of
the neighborhood. It also sets the default middle of the neighborhood and computes the elliptical foot print.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.23 vtkImageContinuousErode3D
36.23
1611
vtkImageContinuousErode3D
36.23.1
Usage
vtkImageContinuousErode3D replaces a pixel with the minimum over an ellipsoidal neighborhood. If KernelSize of
an axis is 1, no processing is done on that axis.
To create an instance of class vtkImageContinuousErode3D, simply invoke its constructor as follows
obj = vtkImageContinuousErode3D
36.23.2
Methods
The class vtkImageContinuousErode3D has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageContinuousErode3D
class.
string = obj.GetClassName () - Construct an instance of vtkImageContinuousErode3D filter. By
default zero values are eroded.
int = obj.IsA (string name) - Construct an instance of vtkImageContinuousErode3D filter. By
default zero values are eroded.
vtkImageContinuousErode3D = obj.NewInstance () - Construct an instance of vtkImageContinuousErode3D filter. By default zero values are eroded.
vtkImageContinuousErode3D = obj.SafeDownCast (vtkObject o) - Construct an instance of vtkImageContinuousErode3D filter. By default zero values are eroded.
obj.SetKernelSize (int size0, int size1, int size2) - This method sets the size of
the neighborhood. It also sets the default middle of the neighborhood and computes the elliptical foot print.
36.24
vtkImageConvolve
36.24.1
Usage
vtkImageConvolve convolves the image with a 3D NxNxN kernel or a 2D NxN kernal. The output image is cropped
to the same size as the input.
To create an instance of class vtkImageConvolve, simply invoke its constructor as follows
obj = vtkImageConvolve
36.24.2
Methods
The class vtkImageConvolve has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageConvolve class.
string = obj.GetClassName () - Construct an instance of vtkImageConvolve filter.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1612
obj.SetKernel3x3 (double kernel[9]) - Set the kernel to be a given 3x3 or 5x5 or 7x7 kernel.
obj.SetKernel5x5 (double kernel[25]) - Set the kernel to be a given 3x3 or 5x5 or 7x7 kernel.
obj.GetKernel3x3 (double kernel[9]) - Return an array that contains the kernel.
obj.GetKernel5x5 (double kernel[25]) - Return an array that contains the kernel.
obj.SetKernel3x3x3 (double kernel[27]) - Set the kernel to be a 3x3x3 or 5x5x5 or 7x7x7
kernel.
obj.GetKernel3x3x3 (double kernel[27]) - Return an array that contains the kernel
36.25
vtkImageCorrelation
36.25.1
Usage
vtkImageCorrelation finds the correlation between two data sets. SetDimensionality determines whether the Correlation will be 3D, 2D or 1D. The default is a 2D Correlation. The Output type will be double. The output size will
match the size of the first input. The second input is considered the correlation kernel.
To create an instance of class vtkImageCorrelation, simply invoke its constructor as follows
obj = vtkImageCorrelation
36.25.2
Methods
The class vtkImageCorrelation has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageCorrelation class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageCorrelation = obj.NewInstance ()
vtkImageCorrelation = obj.SafeDownCast (vtkObject o)
obj.SetDimensionality (int ) - Determines how the input is interpreted (set of 2d slices ...). The
default is 2.
int = obj.GetDimensionalityMinValue () - Determines how the input is interpreted (set of 2d
slices ...). The default is 2.
int = obj.GetDimensionalityMaxValue () - Determines how the input is interpreted (set of 2d
slices ...). The default is 2.
int = obj.GetDimensionality () - Determines how the input is interpreted (set of 2d slices ...).
The default is 2.
obj.SetInput1 (vtkDataObject in) - Set the correlation kernel.
obj.SetInput2 (vtkDataObject in)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.26 vtkImageCursor3D
36.26
1613
vtkImageCursor3D
36.26.1
Usage
36.26.2
Methods
The class vtkImageCursor3D has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageCursor3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageCursor3D = obj.NewInstance ()
vtkImageCursor3D = obj.SafeDownCast (vtkObject o)
obj.SetCursorPosition (double , double , double ) - Sets/Gets the center point of the
3d cursor.
obj.SetCursorPosition (double a[3]) - Sets/Gets the center point of the 3d cursor.
double = obj.
obj.SetCursorValue (double ) - Sets/Gets what pixel value to draw the cursor in.
double = obj.GetCursorValue () - Sets/Gets what pixel value to draw the cursor in.
obj.SetCursorRadius (int ) - Sets/Gets the radius of the cursor. The radius determines how far
the axis lines project out from the cursors center.
int = obj.GetCursorRadius () - Sets/Gets the radius of the cursor. The radius determines how
far the axis lines project out from the cursors center.
36.27
vtkImageDataStreamer
36.27.1
Usage
To satisfy a request, this filter calls update on its input many times with smaller update extents. All processing up
stream streams smaller pieces.
To create an instance of class vtkImageDataStreamer, simply invoke its constructor as follows
obj = vtkImageDataStreamer
1614
36.27.2
Methods
The class vtkImageDataStreamer has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageDataStreamer
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageDataStreamer = obj.NewInstance ()
vtkImageDataStreamer = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfStreamDivisions (int ) - Set how many pieces to divide the input into. void
SetNumberOfStreamDivisions(int num); int GetNumberOfStreamDivisions();
int = obj.GetNumberOfStreamDivisions () - Set how many pieces to divide the input into.
void SetNumberOfStreamDivisions(int num); int GetNumberOfStreamDivisions();
obj.Update ()
obj.UpdateWholeExtent ()
obj.SetExtentTranslator (vtkExtentTranslator ) - Get the extent translator that will be
used to split the requests
vtkExtentTranslator = obj.GetExtentTranslator () - Get the extent translator that will
be used to split the requests
36.28
vtkImageDecomposeFilter
36.28.1
Usage
This superclass molds the vtkImageIterateFilter superclass so it iterates over the axes. The filter uses dimensionality to determine how many axes to execute (starting from x). The filter also provides convenience methods for
permuting information retrieved from input, output and vtkImageData.
To create an instance of class vtkImageDecomposeFilter, simply invoke its constructor as follows
obj = vtkImageDecomposeFilter
36.28.2
Methods
The class vtkImageDecomposeFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageDecomposeFilter
class.
string = obj.GetClassName () - Construct an instance of vtkImageDecomposeFilter filter with default dimensionality 3.
int = obj.IsA (string name) - Construct an instance of vtkImageDecomposeFilter filter with default dimensionality 3.
vtkImageDecomposeFilter = obj.NewInstance () - Construct an instance of vtkImageDecomposeFilter filter with default dimensionality 3.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.29 vtkImageDifference
1615
36.29
vtkImageDifference
36.29.1
Usage
vtkImageDifference takes two rgb unsigned char images and compares them. It allows the images to be slightly
different. If AllowShift is on, then each pixel can be shifted by one pixel. Threshold is the allowable error for each
pixel.
This is not a symetric filter and the difference computed is not symetric when AllowShift is on. Specifically in that
case a pixel in SetImage input will be compared to the matching pixel in the input as well as to the inputs eight
connected neighbors. BUT... the opposite is not true. So for example if a valid image (SetImage) has a single white
pixel in it, it will not find a match in the input image if the input image is black (because none of the nine suspect
pixels are white). In contrast, if there is a single white pixel in the input image and the valid image (SetImage) is all
black it will match with no error because all it has to do is find black pixels and even though the input image has a
white pixel, its neighbors are not white.
To create an instance of class vtkImageDifference, simply invoke its constructor as follows
obj = vtkImageDifference
36.29.2
Methods
The class vtkImageDifference has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageDifference class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageDifference = obj.NewInstance ()
vtkImageDifference = obj.SafeDownCast (vtkObject o)
obj.SetImage (vtkDataObject image) - Specify the Image to compare the input to.
vtkImageData = obj.GetImage () - Specify the Image to compare the input to.
double = obj.GetError (void ) - Return the total error in comparing the two images.
obj.GetError (double e) - Return the total error in comparing the two images.
double = obj.GetThresholdedError (void ) - Return the total thresholded error in comparing
the two images. The thresholded error is the error for a given pixel minus the threshold and clamped at a
minimum of zero.
obj.GetThresholdedError (double e) - Return the total thresholded error in comparing the two
images. The thresholded error is the error for a given pixel minus the threshold and clamped at a minimum of
zero.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1616
36.30
vtkImageDilateErode3D
36.30.1
Usage
vtkImageDilateErode3D will dilate one value and erode another. It uses an elliptical foot print, and only erodes/dilates on the boundary of the two values. The filter is restricted to the X, Y, and Z axes for now. It can degenerate to
a 2 or 1 dimensional filter by setting the kernel size to 1 for a specific axis.
To create an instance of class vtkImageDilateErode3D, simply invoke its constructor as follows
obj = vtkImageDilateErode3D
36.30.2
Methods
The class vtkImageDilateErode3D has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageDilateErode3D
class.
string = obj.GetClassName () - Construct an instance of vtkImageDilateErode3D filter. By default
zero values are dilated.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.31 vtkImageDivergence
1617
36.31
vtkImageDivergence
36.31.1
Usage
vtkImageDivergence takes a 3D vector field and creates a scalar field which which represents the rate of change of
the vector field. The definition of Divergence: Given V = P(x,y,z), Q(x,y,z), R(x,y,z), Divergence = dP/dx + dQ/dy +
dR/dz.
To create an instance of class vtkImageDivergence, simply invoke its constructor as follows
obj = vtkImageDivergence
36.31.2
Methods
The class vtkImageDivergence has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageDivergence class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageDivergence = obj.NewInstance ()
vtkImageDivergence = obj.SafeDownCast (vtkObject o)
36.32
vtkImageDotProduct
36.32.1
Usage
vtkImageDotProduct interprets the scalar components of two images as vectors and takes the dot product vector by
vector (pixel by pixel).
To create an instance of class vtkImageDotProduct, simply invoke its constructor as follows
obj = vtkImageDotProduct
1618
36.32.2
Methods
The class vtkImageDotProduct has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageDotProduct class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageDotProduct = obj.NewInstance ()
vtkImageDotProduct = obj.SafeDownCast (vtkObject o)
obj.SetInput1 (vtkDataObject in) - Set the two inputs to this filter
obj.SetInput2 (vtkDataObject in)
36.33
vtkImageEllipsoidSource
36.33.1
Usage
vtkImageEllipsoidSource creates a binary image of a ellipsoid. It was created as an example of a simple source,
and to test the mask filter. It is also used internally in vtkImageDilateErode3D.
To create an instance of class vtkImageEllipsoidSource, simply invoke its constructor as follows
obj = vtkImageEllipsoidSource
36.33.2
Methods
The class vtkImageEllipsoidSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageEllipsoidSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageEllipsoidSource = obj.NewInstance ()
vtkImageEllipsoidSource = obj.SafeDownCast (vtkObject o)
obj.SetWholeExtent (int extent[6]) - Set/Get the extent of the whole output image.
obj.SetWholeExtent (int minX, int maxX, int minY, int maxY, int minZ,
int maxZ) - Set/Get the extent of the whole output image.
obj.GetWholeExtent (int extent[6]) - Set/Get the extent of the whole output image.
int = obj.GetWholeExtent () - Set/Get the center of the ellipsoid.
obj.SetCenter (double , double , double ) - Set/Get the center of the ellipsoid.
obj.SetCenter (double a[3]) - Set/Get the center of the ellipsoid.
double = obj.
36.34 vtkImageEuclideanDistance
1619
36.34
vtkImageEuclideanDistance
36.34.1
Usage
vtkImageEuclideanDistance implements the Euclidean DT using Saitos algorithm. The distance map produced
contains the square of the Euclidean distance values.
The algorithm has a o(n (D+1)) complexity over nxnx...xn images in D dimensions. It is very efficient on relatively
small images. Cuisenaires algorithms should be used instead if n >> 500. These are not implemented yet.
For the special case of images where the slice-size is a multiple of 2 N with a large N (typically for 256x256 slices),
Saitos algorithm encounters a lot of cache conflicts during the 3rd iteration which can slow it very significantly. In
that case, one should use ::SetAlgorithmToSaitoCached() instead for better performance.
References:
T. Saito and J.I. Toriwaki. New algorithms for Euclidean distance transformations of an n-dimensional digitised
picture with applications. Pattern Recognition, 27(11). pp. 15511565, 1994.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1620
O. Cuisenaire. Distance Transformation: fast algorithms and applications to medical image processing. PhD Thesis,
Universite catholique de Louvain, October 1999. http://ltswww.epfl.ch/cuisenai/papers/oc_-
thesis.pdf
To create an instance of class vtkImageEuclideanDistance, simply invoke its constructor as follows
obj = vtkImageEuclideanDistance
36.34.2
Methods
The class vtkImageEuclideanDistance has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageEuclideanDistance
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageEuclideanDistance = obj.NewInstance ()
vtkImageEuclideanDistance = obj.SafeDownCast (vtkObject o)
int = obj.SplitExtent (int splitExt[6], int startExt[6], int num, int
total) - Used internally for streaming and threads. Splits output update extent into num pieces. This
method needs to be called num times. Results must not overlap for consistent starting extent. Subclass can
override this method. This method returns the number of peices resulting from a successful split. This can
be from 1 to "total". If 1 is returned, the extent cannot be split.
obj.SetInitialize (int ) - Used to set all non-zero voxels to MaximumDistance before starting
the distance transformation. Setting Initialize off keeps the current value in the input image as starting point.
This allows to superimpose several distance maps.
int = obj.GetInitialize () - Used to set all non-zero voxels to MaximumDistance before starting
the distance transformation. Setting Initialize off keeps the current value in the input image as starting point.
This allows to superimpose several distance maps.
obj.InitializeOn () - Used to set all non-zero voxels to MaximumDistance before starting the distance transformation. Setting Initialize off keeps the current value in the input image as starting point. This
allows to superimpose several distance maps.
obj.InitializeOff () - Used to set all non-zero voxels to MaximumDistance before starting the distance transformation. Setting Initialize off keeps the current value in the input image as starting point. This
allows to superimpose several distance maps.
obj.SetConsiderAnisotropy (int ) - Used to define whether Spacing should be used in the
computation of the distances
int = obj.GetConsiderAnisotropy () - Used to define whether Spacing should be used in the
computation of the distances
obj.ConsiderAnisotropyOn () - Used to define whether Spacing should be used in the computation
of the distances
obj.ConsiderAnisotropyOff () - Used to define whether Spacing should be used in the computation of the distances
obj.SetMaximumDistance (double ) - Any distance bigger than this->MaximumDistance will not
ne computed but set to this->MaximumDistance instead.
double = obj.GetMaximumDistance () - Any distance bigger than this->MaximumDistance will
not ne computed but set to this->MaximumDistance instead.
obj.SetAlgorithm (int ) - Selects a Euclidean DT algorithm.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.35 vtkImageEuclideanToPolar
1621
1. Saito
2. Saito-cached More algorithms will be added later on.
int = obj.GetAlgorithm () - Selects a Euclidean DT algorithm.
1. Saito
2. Saito-cached More algorithms will be added later on.
obj.SetAlgorithmToSaito () - Selects a Euclidean DT algorithm.
1. Saito
2. Saito-cached More algorithms will be added later on.
obj.SetAlgorithmToSaitoCached ()
36.35
vtkImageEuclideanToPolar
36.35.1
Usage
For each pixel with vector components x,y, this filter outputs theta in component0, and radius in component1.
To create an instance of class vtkImageEuclideanToPolar, simply invoke its constructor as follows
obj = vtkImageEuclideanToPolar
36.35.2
Methods
The class vtkImageEuclideanToPolar has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageEuclideanToPolar
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageEuclideanToPolar = obj.NewInstance ()
vtkImageEuclideanToPolar = obj.SafeDownCast (vtkObject o)
obj.SetThetaMaximum (double ) - Theta is an angle. Maximum specifies when it maps back to 0.
ThetaMaximum defaults to 255 instead of 2PI, because unsigned char is expected as input. The output type
must be the same as input type.
double = obj.GetThetaMaximum () - Theta is an angle. Maximum specifies when it maps back to
0. ThetaMaximum defaults to 255 instead of 2PI, because unsigned char is expected as input. The output
type must be the same as input type.
36.36
vtkImageExport
1622
36.36.1
Usage
vtkImageExport provides a way of exporting image data at the end of a pipeline to a third-party system or to a
simple C array. Applications can use this to get direct access to the image data in memory. A callback interface is
provided to allow connection of the VTK pipeline to a third-party pipeline. This interface conforms to the interface of
vtkImageImport. In Python it is possible to use this class to write the image data into a python string that has been
pre-allocated to be the correct size.
To create an instance of class vtkImageExport, simply invoke its constructor as follows
obj = vtkImageExport
36.36.2
Methods
The class vtkImageExport has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkImageExport class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageExport = obj.NewInstance ()
vtkImageExport = obj.SafeDownCast (vtkObject o)
int = obj.GetDataMemorySize () - Get the number of bytes required for the output C array.
obj.GetDataDimensions (int ptr) - Get the (x,y,z) index dimensions of the data. Please note
that C arrays are indexed in decreasing order, i.e. array[z][y][x].
int = obj.GetDataDimensions () - Get the number of scalar components of the data. Please
note that when you index into a C array, the scalar component index comes last, i.e. array[z][y][x][c].
int = obj.GetDataNumberOfScalarComponents () - Get the number of scalar components
of the data. Please note that when you index into a C array, the scalar component index comes last, i.e.
array[z][y][x][c].
int = obj.GetDataScalarType () - Get the scalar type of the data. The scalar type of the C array
must match the scalar type of the data.
string = obj.GetDataScalarTypeAsString () - Get miscellaneous additional information
about the data.
int = obj.GetDataExtent () - Get miscellaneous additional information about the data.
obj.GetDataExtent (int ptr) - Get miscellaneous additional information about the data.
double = obj.GetDataSpacing () - Get miscellaneous additional information about the data.
obj.GetDataSpacing (double ptr) - Get miscellaneous additional information about the data.
double = obj.GetDataOrigin () - Get miscellaneous additional information about the data.
obj.GetDataOrigin (double ptr) - Get miscellaneous additional information about the data.
obj.ImageLowerLeftOn () - Set/Get whether the data goes to the exported memory starting in the
lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically
before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().
obj.ImageLowerLeftOff () - Set/Get whether the data goes to the exported memory starting in the
lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically
before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.37 vtkImageExtractComponents
1623
int = obj.GetImageLowerLeft () - Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped
vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by
GetPointerToData().
obj.SetImageLowerLeft (int ) - Set/Get whether the data goes to the exported memory starting
in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped
vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by
GetPointerToData().
obj.Export () - The main interface: update the pipeline and export the image to the memory pointed to
by SetExportVoidPointer(). You can also specify a void pointer when you call Export().
36.37
vtkImageExtractComponents
36.37.1
Usage
vtkImageExtractComponents takes an input with any number of components and outputs some of them. It does
involve a copy of the data.
To create an instance of class vtkImageExtractComponents, simply invoke its constructor as follows
obj = vtkImageExtractComponents
36.37.2
Methods
The class vtkImageExtractComponents has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageExtractComponents
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageExtractComponents = obj.NewInstance ()
vtkImageExtractComponents = obj.SafeDownCast (vtkObject o)
obj.SetComponents (int c1) - Set/Get the components to extract.
obj.SetComponents (int c1, int c2) - Set/Get the components to extract.
obj.SetComponents (int c1, int c2, int c3) - Set/Get the components to extract.
int = obj.
36.38
vtkImageFFT
1624
36.38.1
Usage
vtkImageFFT implements a fast Fourier transform. The input can have real or complex data in any components
and data types, but the output is always complex doubles with real values in component0, and imaginary values
in component1. The filter is fastest for images that have power of two sizes. The filter uses a butterfly fitlers for
each prime factor of the dimension. This makes images with prime number dimensions (i.e. 17x17) much slower to
compute. Multi dimensional (i.e volumes) FFTs are decomposed so that each axis executes in series.
To create an instance of class vtkImageFFT, simply invoke its constructor as follows
obj = vtkImageFFT
36.38.2
Methods
The class vtkImageFFT has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkImageFFT class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageFFT = obj.NewInstance ()
vtkImageFFT = obj.SafeDownCast (vtkObject o)
int = obj.SplitExtent (int splitExt[6], int startExt[6], int num, int
total) - Used internally for streaming and threads. Splits output update extent into num pieces. This
method needs to be called num times. Results must not overlap for consistent starting extent. Subclass can
override this method. This method returns the number of pieces resulting from a successful split. This can
be from 1 to "total". If 1 is returned, the extent cannot be split.
36.39
vtkImageFlip
36.39.1
Usage
vtkImageFlip will reflect the data along the filtered axis. This filter is actually a thin wrapper around vtkImageReslice.
To create an instance of class vtkImageFlip, simply invoke its constructor as follows
obj = vtkImageFlip
36.39.2
Methods
The class vtkImageFlip has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkImageFlip class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageFlip = obj.NewInstance ()
vtkImageFlip = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.39 vtkImageFlip
1625
obj.SetFilteredAxis (int ) - Specify which axis will be flipped. This must be an integer between
0 (for x) and 2 (for z). Initial value is 0.
int = obj.GetFilteredAxis () - Specify which axis will be flipped. This must be an integer between 0 (for x) and 2 (for z). Initial value is 0.
obj.SetFlipAboutOrigin (int ) - By default the image will be flipped about its center, and the
Origin, Spacing and Extent of the output will be identical to the input. However, if you have a coordinate
system associated with the image and you want to use the flip to convert +ve values along one axis to -ve
values (and vice versa) then you actually want to flip the image about coordinate (0,0,0) instead of about the
center of the image. This method will adjust the Origin of the output such that the flip occurs about (0,0,0).
Note that this method only changes the Origin (and hence the coordinate system) the output data: the actual
pixel values are the same whether or not this method is used. Also note that the Origin in this method name
refers to (0,0,0) in the coordinate system associated with the image, it does not refer to the Origin ivar that is
associated with a vtkImageData.
int = obj.GetFlipAboutOrigin () - By default the image will be flipped about its center, and the
Origin, Spacing and Extent of the output will be identical to the input. However, if you have a coordinate
system associated with the image and you want to use the flip to convert +ve values along one axis to -ve
values (and vice versa) then you actually want to flip the image about coordinate (0,0,0) instead of about the
center of the image. This method will adjust the Origin of the output such that the flip occurs about (0,0,0).
Note that this method only changes the Origin (and hence the coordinate system) the output data: the actual
pixel values are the same whether or not this method is used. Also note that the Origin in this method name
refers to (0,0,0) in the coordinate system associated with the image, it does not refer to the Origin ivar that is
associated with a vtkImageData.
obj.FlipAboutOriginOn () - By default the image will be flipped about its center, and the Origin,
Spacing and Extent of the output will be identical to the input. However, if you have a coordinate system
associated with the image and you want to use the flip to convert +ve values along one axis to -ve values
(and vice versa) then you actually want to flip the image about coordinate (0,0,0) instead of about the center
of the image. This method will adjust the Origin of the output such that the flip occurs about (0,0,0). Note
that this method only changes the Origin (and hence the coordinate system) the output data: the actual pixel
values are the same whether or not this method is used. Also note that the Origin in this method name
refers to (0,0,0) in the coordinate system associated with the image, it does not refer to the Origin ivar that is
associated with a vtkImageData.
obj.FlipAboutOriginOff () - By default the image will be flipped about its center, and the Origin,
Spacing and Extent of the output will be identical to the input. However, if you have a coordinate system
associated with the image and you want to use the flip to convert +ve values along one axis to -ve values
(and vice versa) then you actually want to flip the image about coordinate (0,0,0) instead of about the center
of the image. This method will adjust the Origin of the output such that the flip occurs about (0,0,0). Note
that this method only changes the Origin (and hence the coordinate system) the output data: the actual pixel
values are the same whether or not this method is used. Also note that the Origin in this method name
refers to (0,0,0) in the coordinate system associated with the image, it does not refer to the Origin ivar that is
associated with a vtkImageData.
obj.SetFilteredAxes (int axis) - Keep the mis-named Axes variations around for compatibility
with old scripts. Axis is singular, not plural...
int = obj.GetFilteredAxes () - PreserveImageExtentOff wasnt covered by test scripts and its
implementation was broken. It is deprecated now and it has no effect (i.e. the ImageExtent is always preserved).
obj.SetPreserveImageExtent (int ) - PreserveImageExtentOff wasnt covered by test scripts
and its implementation was broken. It is deprecated now and it has no effect (i.e. the ImageExtent is always
preserved).
int = obj.GetPreserveImageExtent () - PreserveImageExtentOff wasnt covered by test
scripts and its implementation was broken. It is deprecated now and it has no effect (i.e. the ImageExtent is
always preserved).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1626
36.40
vtkImageFourierCenter
36.40.1
Usage
Is used for dispaying images in frequency space. FFT converts spatial images into frequency space, but puts the
zero frequency at the origin. This filter shifts the zero frequency to the center of the image. Input and output are
assumed to be doubles.
To create an instance of class vtkImageFourierCenter, simply invoke its constructor as follows
obj = vtkImageFourierCenter
36.40.2
Methods
The class vtkImageFourierCenter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageFourierCenter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageFourierCenter = obj.NewInstance ()
vtkImageFourierCenter = obj.SafeDownCast (vtkObject o)
36.41
vtkImageFourierFilter
36.41.1
Usage
vtkImageFourierFilter is a class of filters that use complex numbers this superclass is a container for methods that
manipulate these structure including fast Fourier transforms. Complex numbers may become a class. This should
really be a helper class.
To create an instance of class vtkImageFourierFilter, simply invoke its constructor as follows
obj = vtkImageFourierFilter
36.42 vtkImageGaussianSmooth
36.41.2
1627
Methods
The class vtkImageFourierFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageFourierFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageFourierFilter = obj.NewInstance ()
vtkImageFourierFilter = obj.SafeDownCast (vtkObject o)
36.42
vtkImageGaussianSmooth
36.42.1
Usage
vtkImageGaussianSmooth implements a convolution of the input image with a gaussian. Supports from one to three
dimensional convolutions.
To create an instance of class vtkImageGaussianSmooth, simply invoke its constructor as follows
obj = vtkImageGaussianSmooth
36.42.2
Methods
The class vtkImageGaussianSmooth has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageGaussianSmooth
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageGaussianSmooth = obj.NewInstance ()
vtkImageGaussianSmooth = obj.SafeDownCast (vtkObject o)
obj.SetStandardDeviations (double , double , double ) - Sets/Gets the Standard
deviation of the gaussian in pixel units.
obj.SetStandardDeviations (double a[3]) - Sets/Gets the Standard deviation of the gaussian in pixel units.
obj.SetStandardDeviation (double std) - Sets/Gets the Standard deviation of the gaussian
in pixel units.
obj.SetStandardDeviations (double a, double b) - Sets/Gets the Standard deviation of
the gaussian in pixel units.
double = obj.
sian in pixel units.
1628
36.43
This determines
vtkImageGaussianSource
36.43.1
Usage
36.43.2
Methods
The class vtkImageGaussianSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageGaussianSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageGaussianSource = obj.NewInstance ()
vtkImageGaussianSource = obj.SafeDownCast (vtkObject o)
obj.SetWholeExtent (int xMinx, int xMax, int yMin, int yMax, int zMin,
int zMax) - Set/Get the extent of the whole output image.
obj.SetCenter (double , double , double ) - Set/Get the center of the Gaussian.
obj.SetCenter (double a[3]) - Set/Get the center of the Gaussian.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.44 vtkImageGradient
double = obj.
1629
36.44
vtkImageGradient
36.44.1
Usage
vtkImageGradient computes the gradient vector of an image. The vector results are stored as scalar components.
The Dimensionality determines whether to perform a 2d or 3d gradient. The default is two dimensional XY gradient.
OutputScalarType is always double. Gradient is computed using central differences.
To create an instance of class vtkImageGradient, simply invoke its constructor as follows
obj = vtkImageGradient
36.44.2
Methods
The class vtkImageGradient has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageGradient class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageGradient = obj.NewInstance ()
vtkImageGradient = obj.SafeDownCast (vtkObject o)
obj.SetDimensionality (int ) - Determines how the input is interpreted (set of 2d slices ...)
int = obj.GetDimensionalityMinValue () - Determines how the input is interpreted (set of 2d
slices ...)
int = obj.GetDimensionalityMaxValue () - Determines how the input is interpreted (set of 2d
slices ...)
int = obj.GetDimensionality () - Determines how the input is interpreted (set of 2d slices ...)
obj.SetHandleBoundaries (int ) - Get/Set whether to handle boundaries. If enabled, boundary
pixels are treated as duplicated so that central differencing works for the boundary pixels. If disabled, the
output whole extent of the image is reduced by one pixel.
int = obj.GetHandleBoundaries () - Get/Set whether to handle boundaries. If enabled, boundary pixels are treated as duplicated so that central differencing works for the boundary pixels. If disabled, the
output whole extent of the image is reduced by one pixel.
obj.HandleBoundariesOn () - Get/Set whether to handle boundaries. If enabled, boundary pixels
are treated as duplicated so that central differencing works for the boundary pixels. If disabled, the output
whole extent of the image is reduced by one pixel.
obj.HandleBoundariesOff () - Get/Set whether to handle boundaries. If enabled, boundary pixels
are treated as duplicated so that central differencing works for the boundary pixels. If disabled, the output
whole extent of the image is reduced by one pixel.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1630
36.45
vtkImageGradientMagnitude
36.45.1
Usage
vtkImageGradientMagnitude computes the gradient magnitude of an image. Setting the dimensionality determines
whether the gradient is computed on 2D images, or 3D volumes. The default is two dimensional XY images.
To create an instance of class vtkImageGradientMagnitude, simply invoke its constructor as follows
obj = vtkImageGradientMagnitude
36.45.2
Methods
The class vtkImageGradientMagnitude has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageGradientMagnitude
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageGradientMagnitude = obj.NewInstance ()
vtkImageGradientMagnitude = obj.SafeDownCast (vtkObject o)
obj.SetHandleBoundaries (int ) - If "HandleBoundariesOn" then boundary pixels are duplicated
So central differences can get values.
int = obj.GetHandleBoundaries () - If "HandleBoundariesOn" then boundary pixels are duplicated So central differences can get values.
obj.HandleBoundariesOn () - If "HandleBoundariesOn" then boundary pixels are duplicated So central differences can get values.
obj.HandleBoundariesOff () - If "HandleBoundariesOn" then boundary pixels are duplicated So
central differences can get values.
obj.SetDimensionality (int ) - Determines how the input is interpreted (set of 2d slices ...)
int = obj.GetDimensionalityMinValue () - Determines how the input is interpreted (set of 2d
slices ...)
int = obj.GetDimensionalityMaxValue () - Determines how the input is interpreted (set of 2d
slices ...)
int = obj.GetDimensionality () - Determines how the input is interpreted (set of 2d slices ...)
36.46
vtkImageGridSource
36.46.1
Usage
36.46 vtkImageGridSource
36.46.2
1631
Methods
The class vtkImageGridSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageGridSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageGridSource = obj.NewInstance ()
vtkImageGridSource = obj.SafeDownCast (vtkObject o)
obj.SetGridSpacing (int , int , int ) - Set/Get the grid spacing in pixel units. Default
(10,10,0). A value of zero means no grid.
obj.SetGridSpacing (int a[3]) - Set/Get the grid spacing in pixel units. Default (10,10,0). A
value of zero means no grid.
int = obj. GetGridSpacing () - Set/Get the grid spacing in pixel units. Default (10,10,0). A
value of zero means no grid.
obj.SetGridOrigin (int , int , int ) - Set/Get the grid origin, in ijk integer values. Default
(0,0,0).
obj.SetGridOrigin (int a[3]) - Set/Get the grid origin, in ijk integer values. Default (0,0,0).
int = obj.
GetGridOrigin () - Set/Get the grid origin, in ijk integer values. Default (0,0,0).
obj.SetLineValue (double ) - Set the grey level of the lines. Default 1.0.
double = obj.GetLineValue () - Set the grey level of the lines. Default 1.0.
obj.SetFillValue (double ) - Set the grey level of the fill. Default 0.0.
double = obj.GetFillValue () - Set the grey level of the fill. Default 0.0.
obj.SetDataScalarType (int ) - Set/Get the data type of pixels in the imported data. As a convenience, the OutputScalarType is set to the same value.
obj.SetDataScalarTypeToDouble () - Set/Get the data type of pixels in the imported data. As a
convenience, the OutputScalarType is set to the same value.
obj.SetDataScalarTypeToInt () - Set/Get the data type of pixels in the imported data. As a
convenience, the OutputScalarType is set to the same value.
obj.SetDataScalarTypeToShort () - Set/Get the data type of pixels in the imported data. As a
convenience, the OutputScalarType is set to the same value.
obj.SetDataScalarTypeToUnsignedShort () - Set/Get the data type of pixels in the imported
data. As a convenience, the OutputScalarType is set to the same value.
obj.SetDataScalarTypeToUnsignedChar () - Set/Get the data type of pixels in the imported
data. As a convenience, the OutputScalarType is set to the same value.
int = obj.GetDataScalarType () - Set/Get the data type of pixels in the imported data. As a
convenience, the OutputScalarType is set to the same value.
string = obj.GetDataScalarTypeAsString () - Set/Get the extent of the whole output image,
Default: (0,255,0,255,0,0)
obj.SetDataExtent (int , int , int , int , int , int ) - Set/Get the extent of the
whole output image, Default: (0,255,0,255,0,0)
obj.SetDataExtent (int a[6]) - Set/Get the extent of the whole output image, Default:
(0,255,0,255,0,0)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1632
int = obj. GetDataExtent () - Set/Get the extent of the whole output image, Default:
(0,255,0,255,0,0)
obj.SetDataSpacing (double , double , double ) - Set/Get the pixel spacing.
obj.SetDataSpacing (double a[3]) - Set/Get the pixel spacing.
double = obj.
36.47
vtkImageHSIToRGB
36.47.1
Usage
For each pixel with hue, saturation and intensity components this filter outputs the color coded as red, green, blue.
Output type must be the same as input type.
To create an instance of class vtkImageHSIToRGB, simply invoke its constructor as follows
obj = vtkImageHSIToRGB
36.47.2
Methods
The class vtkImageHSIToRGB has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageHSIToRGB class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageHSIToRGB = obj.NewInstance ()
vtkImageHSIToRGB = obj.SafeDownCast (vtkObject o)
obj.SetMaximum (double ) - Hue is an angle. Maximum specifies when it maps back to 0. HueMaximum defaults to 255 instead of 2PI, because unsigned char is expected as input. Maximum also specifies
the maximum of the Saturation, and R, G, B.
double = obj.GetMaximum () - Hue is an angle. Maximum specifies when it maps back to 0. HueMaximum defaults to 255 instead of 2PI, because unsigned char is expected as input. Maximum also specifies
the maximum of the Saturation, and R, G, B.
36.48
vtkImageHSVToRGB
36.49 vtkImageHybridMedian2D
36.48.1
1633
Usage
For each pixel with hue, saturation and value components this filter outputs the color coded as red, green, blue.
Output type must be the same as input type.
To create an instance of class vtkImageHSVToRGB, simply invoke its constructor as follows
obj = vtkImageHSVToRGB
36.48.2
Methods
The class vtkImageHSVToRGB has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageHSVToRGB class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageHSVToRGB = obj.NewInstance ()
vtkImageHSVToRGB = obj.SafeDownCast (vtkObject o)
obj.SetMaximum (double ) - Hue is an angle. Maximum specifies when it maps back to 0. HueMaximum defaults to 255 instead of 2PI, because unsigned char is expected as input. Maximum also specifies
the maximum of the Saturation, and R, G, B.
double = obj.GetMaximum () - Hue is an angle. Maximum specifies when it maps back to 0. HueMaximum defaults to 255 instead of 2PI, because unsigned char is expected as input. Maximum also specifies
the maximum of the Saturation, and R, G, B.
36.49
vtkImageHybridMedian2D
36.49.1
Usage
vtkImageHybridMedian2D is a median filter that preserves thin lines and corners. It operates on a 5x5 pixel neighborhood. It computes two values initially: the median of the + neighbors and the median of the x neighbors. It then
computes the median of these two values plus the center pixel. This result of this second median is the output pixel
value.
To create an instance of class vtkImageHybridMedian2D, simply invoke its constructor as follows
obj = vtkImageHybridMedian2D
36.49.2
Methods
The class vtkImageHybridMedian2D has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageHybridMedian2D
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageHybridMedian2D = obj.NewInstance ()
vtkImageHybridMedian2D = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1634
36.50
vtkImageIdealHighPass
36.50.1
Usage
This filter only works on an image after it has been converted to frequency domain by a vtkImageFFT filter. A vtkImageRFFT filter can be used to convert the output back into the spatial domain. vtkImageIdealHighPass just sets
a portion of the image to zero. The sharp cutoff in the frequence domain produces ringing in the spatial domain.
Input and Output must be doubles. Dimensionality is set when the axes are set. Defaults to 2D on X and Y axes.
To create an instance of class vtkImageIdealHighPass, simply invoke its constructor as follows
obj = vtkImageIdealHighPass
36.50.2
Methods
The class vtkImageIdealHighPass has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageIdealHighPass
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageIdealHighPass = obj.NewInstance ()
vtkImageIdealHighPass = obj.SafeDownCast (vtkObject o)
obj.SetCutOff (double , double , double ) - Set/Get the cutoff frequency for each axis.
The values are specified in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data
spacing).
obj.SetCutOff (double a[3]) - Set/Get the cutoff frequency for each axis. The values are specified in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified in
the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetXCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetYCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetZCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj. GetCutOff () - Set/Get the cutoff frequency for each axis. The values are specified in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj.GetXCutOff () - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj.GetYCutOff () - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj.GetZCutOff ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.51 vtkImageIdealLowPass
36.51
1635
vtkImageIdealLowPass
36.51.1
Usage
This filter only works on an image after it has been converted to frequency domain by a vtkImageFFT filter. A
vtkImageRFFT filter can be used to convert the output back into the spatial domain. vtkImageIdealLowPass just
sets a portion of the image to zero. The result is an image with a lot of ringing. Input and Output must be doubles.
Dimensionality is set when the axes are set. Defaults to 2D on X and Y axes.
To create an instance of class vtkImageIdealLowPass, simply invoke its constructor as follows
obj = vtkImageIdealLowPass
36.51.2
Methods
The class vtkImageIdealLowPass has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageIdealLowPass
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageIdealLowPass = obj.NewInstance ()
vtkImageIdealLowPass = obj.SafeDownCast (vtkObject o)
obj.SetCutOff (double , double , double ) - Set/Get the cutoff frequency for each axis.
The values are specified in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data
spacing).
obj.SetCutOff (double a[3]) - Set/Get the cutoff frequency for each axis. The values are specified in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified in
the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetXCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetYCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
obj.SetZCutOff (double v) - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj. GetCutOff () - Set/Get the cutoff frequency for each axis. The values are specified in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj.GetXCutOff () - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj.GetYCutOff () - Set/Get the cutoff frequency for each axis. The values are specified
in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).
double = obj.GetZCutOff ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1636
36.52
vtkImageImport
36.52.1
Usage
vtkImageImport provides methods needed to import image data from a source independent of VTK, such as a
simple C array or a third-party pipeline. Note that the VTK convention is for the image voxel index (0,0,0) to be the
lower-left corner of the image, while most 2D image formats use the upper-left corner. You can use vtkImageFlip to
correct the orientation after the image has been loaded into VTK. Note that is also possible to import the raw data
from a Python string instead of from a C array. The array applies on scalar point data only, not on cell data.
To create an instance of class vtkImageImport, simply invoke its constructor as follows
obj = vtkImageImport
36.52.2
Methods
The class vtkImageImport has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkImageImport class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageImport = obj.NewInstance ()
vtkImageImport = obj.SafeDownCast (vtkObject o)
obj.SetDataScalarType (int ) - Set/Get the data type of pixels in the imported data. This is used
as the scalar type of the Output. Default: Short.
obj.SetDataScalarTypeToDouble () - Set/Get the data type of pixels in the imported data. This
is used as the scalar type of the Output. Default: Short.
obj.SetDataScalarTypeToFloat () - Set/Get the data type of pixels in the imported data. This is
used as the scalar type of the Output. Default: Short.
obj.SetDataScalarTypeToInt () - Set/Get the data type of pixels in the imported data. This is
used as the scalar type of the Output. Default: Short.
obj.SetDataScalarTypeToShort () - Set/Get the data type of pixels in the imported data. This is
used as the scalar type of the Output. Default: Short.
obj.SetDataScalarTypeToUnsignedShort () - Set/Get the data type of pixels in the imported
data. This is used as the scalar type of the Output. Default: Short.
obj.SetDataScalarTypeToUnsignedChar () - Set/Get the data type of pixels in the imported
data. This is used as the scalar type of the Output. Default: Short.
int = obj.GetDataScalarType () - Set/Get the data type of pixels in the imported data. This is
used as the scalar type of the Output. Default: Short.
string = obj.GetDataScalarTypeAsString () - Set/Get the number of scalar components,
for RGB images this must be 3. Default: 1.
obj.SetNumberOfScalarComponents (int ) - Set/Get the number of scalar components, for RGB images this must be 3. Default: 1.
int = obj.GetNumberOfScalarComponents () - Set/Get the number of scalar components, for
RGB images this must be 3. Default: 1.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.53 vtkImageImportExecutive
1637
obj.SetDataExtent (int , int , int , int , int , int ) - Get/Set the extent of the
data buffer. The dimensions of your data must be equal to (extent[1]-extent[0]+1) (extent[3]-extent[2]+1)
(extent[5]-DataExtent[4]+1). For example, for a 2D image use (0,width-1, 0,height-1, 0,0).
obj.SetDataExtent (int a[6]) - Get/Set the extent of the data buffer. The dimensions of your data
must be equal to (extent[1]-extent[0]+1) (extent[3]-extent[2]+1) (extent[5]-DataExtent[4]+1). For example,
for a 2D image use (0,width-1, 0,height-1, 0,0).
int = obj. GetDataExtent () - Get/Set the extent of the data buffer. The dimensions of your data
must be equal to (extent[1]-extent[0]+1) (extent[3]-extent[2]+1) (extent[5]-DataExtent[4]+1). For example,
for a 2D image use (0,width-1, 0,height-1, 0,0).
obj.SetDataExtentToWholeExtent () - Set/Get the spacing (typically in mm) between image voxels. Default: (1.0, 1.0, 1.0).
obj.SetDataSpacing (double , double , double ) - Set/Get the spacing (typically in mm)
between image voxels. Default: (1.0, 1.0, 1.0).
obj.SetDataSpacing (double a[3]) - Set/Get the spacing (typically in mm) between image voxels. Default: (1.0, 1.0, 1.0).
double = obj. GetDataSpacing () - Set/Get the spacing (typically in mm) between image voxels. Default: (1.0, 1.0, 1.0).
obj.SetDataOrigin (double , double , double ) - Set/Get the origin of the data, i.e. the
coordinates (usually in mm) of voxel (0,0,0). Default: (0.0, 0.0, 0.0).
obj.SetDataOrigin (double a[3]) - Set/Get the origin of the data, i.e. the coordinates (usually
in mm) of voxel (0,0,0). Default: (0.0, 0.0, 0.0).
double = obj. GetDataOrigin () - Set/Get the origin of the data, i.e. the coordinates (usually
in mm) of voxel (0,0,0). Default: (0.0, 0.0, 0.0).
obj.SetWholeExtent (int , int , int , int , int , int ) - Get/Set the whole extent of the image. This is the largest possible extent. Set the DataExtent to the extent of the image in the
buffer pointed to by the ImportVoidPointer.
obj.SetWholeExtent (int a[6]) - Get/Set the whole extent of the image. This is the largest possible extent. Set the DataExtent to the extent of the image in the buffer pointed to by the ImportVoidPointer.
int = obj. GetWholeExtent () - Get/Set the whole extent of the image. This is the largest possible extent. Set the DataExtent to the extent of the image in the buffer pointed to by the ImportVoidPointer.
obj.SetScalarArrayName (string ) - Set/get the scalar array name for this data set. Initial value
is "scalars".
string = obj.GetScalarArrayName () - Set/get the scalar array name for this data set. Initial
value is "scalars".
int = obj.InvokePipelineModifiedCallbacks () - Invoke the appropriate callbacks
obj.InvokeUpdateInformationCallbacks () - Invoke the appropriate callbacks
obj.InvokeExecuteInformationCallbacks () - Invoke the appropriate callbacks
obj.InvokeExecuteDataCallbacks () - Invoke the appropriate callbacks
obj.LegacyCheckWholeExtent () - Invoke the appropriate callbacks
36.53
vtkImageImportExecutive
1638
36.53.1
Usage
vtkImageImportExecutive
To create an instance of class vtkImageImportExecutive, simply invoke its constructor as follows
obj = vtkImageImportExecutive
36.53.2
Methods
The class vtkImageImportExecutive has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageImportExecutive
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageImportExecutive = obj.NewInstance ()
vtkImageImportExecutive = obj.SafeDownCast (vtkObject o)
36.54
vtkImageIslandRemoval2D
36.54.1
Usage
vtkImageIslandRemoval2D computes the area of separate islands in a mask image. It removes any island that has
less than AreaThreshold pixels. Output has the same ScalarType as input. It generates the whole 2D output image
for any output request.
To create an instance of class vtkImageIslandRemoval2D, simply invoke its constructor as follows
obj = vtkImageIslandRemoval2D
36.54.2
Methods
The class vtkImageIslandRemoval2D has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageIslandRemoval2D
class.
string = obj.GetClassName () - Constructor: Sets default filter to be identity.
int = obj.IsA (string name) - Constructor: Sets default filter to be identity.
vtkImageIslandRemoval2D = obj.NewInstance () - Constructor: Sets default filter to be
identity.
vtkImageIslandRemoval2D = obj.SafeDownCast (vtkObject o) - Constructor: Sets default filter to be identity.
obj.SetAreaThreshold (int ) - Set/Get the cutoff area for removal
int = obj.GetAreaThreshold () - Set/Get the cutoff area for removal
obj.SetSquareNeighborhood (int ) - Set/Get whether to use 4 or 8 neighbors
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.55 vtkImageIterateFilter
1639
36.55
vtkImageIterateFilter
36.55.1
Usage
vtkImageIterateFilter is a filter superclass that supports calling execute multiple times per update. The largest
hack/open issue is that the input and output caches are temporarily changed to "fool" the subclasses. I believe the
correct solution is to pass the in and out cache to the subclasses methods as arguments. Now the data is passes.
Can the caches be passed, and data retrieved from the cache?
To create an instance of class vtkImageIterateFilter, simply invoke its constructor as follows
obj = vtkImageIterateFilter
36.55.2
Methods
The class vtkImageIterateFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageIterateFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageIterateFilter = obj.NewInstance ()
vtkImageIterateFilter = obj.SafeDownCast (vtkObject o)
int = obj.GetIteration () - Get which iteration is current being performed. Normally the user will
not access this method.
int = obj.GetNumberOfIterations () - Get which iteration is current being performed. Normally the user will not access this method.
36.56
vtkImageLaplacian
1640
36.56.1
Usage
vtkImageLaplacian computes the Laplacian (like a second derivative) of a scalar image. The operation is the
same as taking the divergence after a gradient. Boundaries are handled, so the input is the same as the output.
Dimensionality determines how the input regions are interpreted. (images, or volumes). The Dimensionality defaults
to two.
To create an instance of class vtkImageLaplacian, simply invoke its constructor as follows
obj = vtkImageLaplacian
36.56.2
Methods
The class vtkImageLaplacian has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageLaplacian class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageLaplacian = obj.NewInstance ()
vtkImageLaplacian = obj.SafeDownCast (vtkObject o)
obj.SetDimensionality (int ) - Determines how the input is interpreted (set of 2d slices ...)
int = obj.GetDimensionalityMinValue () - Determines how the input is interpreted (set of 2d
slices ...)
int = obj.GetDimensionalityMaxValue () - Determines how the input is interpreted (set of 2d
slices ...)
int = obj.GetDimensionality () - Determines how the input is interpreted (set of 2d slices ...)
36.57
vtkImageLogarithmicScale
36.57.1
Usage
vtkImageLogarithmicScale passes each pixel through the function clog(1+x). It also handles negative values with
the function -clog(1-x).
To create an instance of class vtkImageLogarithmicScale, simply invoke its constructor as follows
obj = vtkImageLogarithmicScale
36.57.2
Methods
The class vtkImageLogarithmicScale has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageLogarithmicScale
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.58 vtkImageLogic
1641
vtkImageLogarithmicScale = obj.NewInstance ()
vtkImageLogarithmicScale = obj.SafeDownCast (vtkObject o)
obj.SetConstant (double ) - Set/Get the scale factor for the logarithmic function.
double = obj.GetConstant () - Set/Get the scale factor for the logarithmic function.
36.58
vtkImageLogic
36.58.1
Usage
vtkImageLogic implements basic logic operations. SetOperation is used to select the filters behavior. The filter can
take two or one input. Inputs must have the same type.
To create an instance of class vtkImageLogic, simply invoke its constructor as follows
obj = vtkImageLogic
36.58.2
Methods
The class vtkImageLogic has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkImageLogic class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageLogic = obj.NewInstance ()
vtkImageLogic = obj.SafeDownCast (vtkObject o)
obj.SetOperation (int ) - Set/Get the Operation to perform.
int = obj.GetOperation () - Set/Get the Operation to perform.
obj.SetOperationToAnd () - Set/Get the Operation to perform.
obj.SetOperationToOr () - Set/Get the Operation to perform.
obj.SetOperationToXor () - Set/Get the Operation to perform.
obj.SetOperationToNand () - Set/Get the Operation to perform.
obj.SetOperationToNor () - Set/Get the Operation to perform.
obj.SetOperationToNot () - Set/Get the Operation to perform.
obj.SetOutputTrueValue (double ) - Set the value to use for true in the output.
double = obj.GetOutputTrueValue () - Set the value to use for true in the output.
obj.SetInput1 (vtkDataObject input) - Set the Input1 of this filter.
obj.SetInput2 (vtkDataObject input) - Set the Input2 of this filter.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1642
36.59
vtkImageLuminance
36.59.1
Usage
36.59.2
Methods
The class vtkImageLuminance has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageLuminance class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageLuminance = obj.NewInstance ()
vtkImageLuminance = obj.SafeDownCast (vtkObject o)
36.60
vtkImageMagnify
36.60.1
Usage
vtkImageMagnify maps each pixel of the input onto a nxmx... region of the output. Location (0,0,...) remains in the
same place. The magnification occurs via pixel replication, or if Interpolate is on, by bilinear interpolation. Initially,
interpolation is off and magnification factors are set to 1 in all directions.
To create an instance of class vtkImageMagnify, simply invoke its constructor as follows
obj = vtkImageMagnify
36.60.2
Methods
The class vtkImageMagnify has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageMagnify class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageMagnify = obj.NewInstance ()
vtkImageMagnify = obj.SafeDownCast (vtkObject o)
obj.SetMagnificationFactors (int , int , int ) - Set/Get the integer magnification factors in the i-j-k directions. Initially, factors are set to 1 in all directions.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.61 vtkImageMagnitude
1643
36.61
vtkImageMagnitude
36.61.1
Usage
36.61.2
Methods
The class vtkImageMagnitude has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageMagnitude class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageMagnitude = obj.NewInstance ()
vtkImageMagnitude = obj.SafeDownCast (vtkObject o)
36.62
vtkImageMandelbrotSource
36.62.1
Usage
vtkImageMandelbrotSource creates an unsigned char image of the Mandelbrot set. The values in the image are the
number of iterations it takes for the magnitude of the value to get over 2. The equation repeated is z = z 2 + C (z
and C are complex). Initial value of z is zero, and the real value of C is mapped onto the x axis, and the imaginary
value of C is mapped onto the Y Axis. I was thinking of extending this source to generate Julia Sets (initial value of
Z varies). This would be 4 possible parameters to vary, but there are no more 4d images :( The third dimension (z
axis) is the imaginary value of the initial value.
To create an instance of class vtkImageMandelbrotSource, simply invoke its constructor as follows
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1644
obj = vtkImageMandelbrotSource
36.62.2
Methods
The class vtkImageMandelbrotSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageMandelbrotSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageMandelbrotSource = obj.NewInstance ()
vtkImageMandelbrotSource = obj.SafeDownCast (vtkObject o)
obj.SetWholeExtent (int extent[6]) - Set/Get the extent of the whole output Volume.
obj.SetWholeExtent (int minX, int maxX, int minY, int maxY, int minZ,
int maxZ) - Set/Get the extent of the whole output Volume.
int = obj.
obj.SetConstantSize (int ) - This flag determines whether the Size or spacing of a data set remain constant (when extent is changed). By default, size remains constant.
int = obj.GetConstantSize () - This flag determines whether the Size or spacing of a data set
remain constant (when extent is changed). By default, size remains constant.
obj.ConstantSizeOn () - This flag determines whether the Size or spacing of a data set remain
constant (when extent is changed). By default, size remains constant.
obj.ConstantSizeOff () - This flag determines whether the Size or spacing of a data set remain
constant (when extent is changed). By default, size remains constant.
obj.SetProjectionAxes (int x, int y, int z) - Set the projection from the 4D space (4
parameters / 2 imaginary numbers) to the axes of the 3D Volume. 0=C_Real, 1=C_Imaginary, 2=X_Real,
4=X_Imaginary
obj.SetProjectionAxes (int a[3]) - Set the projection from the 4D space (4 parameters / 2
imaginary numbers) to the axes of the 3D Volume. 0=C_Real, 1=C_Imaginary, 2=X_Real, 4=X_Imaginary
int = obj. GetProjectionAxes () - Set the projection from the 4D space (4 parameters / 2
imaginary numbers) to the axes of the 3D Volume. 0=C_Real, 1=C_Imaginary, 2=X_Real, 4=X_Imaginary
obj.SetOriginCX (double , double , double , double ) - Imaginary and real value for
C (constant in equation) and X (initial value).
obj.SetOriginCX (double a[4]) - Imaginary and real value for C (constant in equation) and X
(initial value).
double = obj. GetOriginCX () - Imaginary and real value for C (constant in equation) and X
(initial value). void SetOriginCX(double cReal, double cImag, double xReal, double xImag);
obj.SetSampleCX (double , double , double , double ) - Imaginary and real value for
C (constant in equation) and X (initial value).
obj.SetSampleCX (double a[4]) - Imaginary and real value for C (constant in equation) and X
(initial value).
double = obj. GetSampleCX () - Imaginary and real value for C (constant in equation) and X
(initial value). void SetOriginCX(double cReal, double cImag, double xReal, double xImag);
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.63 vtkImageMapToColors
1645
obj.SetSizeCX (double cReal, double cImag, double xReal, double xImag) Just a different way of setting the sample. This sets the size of the 4D volume. SampleCX is computed from
size and extent. Size is ignored when a dimension i 0 (collapsed).
double = obj.GetSizeCX () - Just a different way of setting the sample. This sets the size of the
4D volume. SampleCX is computed from size and extent. Size is ignored when a dimension i 0 (collapsed).
obj.GetSizeCX (double s[4]) - Just a different way of setting the sample. This sets the size of the
4D volume. SampleCX is computed from size and extent. Size is ignored when a dimension i 0 (collapsed).
obj.SetMaximumNumberOfIterations (short ) - The maximum number of cycles run to see if
the value goes over 2
GetMaximumNumberOfIterationsMinValue = obj.() - The maximum number of cycles run to
see if the value goes over 2
GetMaximumNumberOfIterationsMaxValue = obj.() - The maximum number of cycles run to
see if the value goes over 2
short = obj.GetMaximumNumberOfIterations () - The maximum number of cycles run to
see if the value goes over 2
obj.Zoom (double factor) - Convienence for Viewer. Pan 3D volume relative to spacing. Zoom
constant factor.
obj.Pan (double x, double y, double z) - Convienence for Viewer. Pan 3D volume relative
to spacing. Zoom constant factor.
obj.CopyOriginAndSample (vtkImageMandelbrotSource source) - Convienence for
Viewer. Copy the OriginCX and the SpacingCX. What about other parameters ???
obj.SetSubsampleRate (int ) - Set/Get a subsample rate.
int = obj.GetSubsampleRateMinValue () - Set/Get a subsample rate.
int = obj.GetSubsampleRateMaxValue () - Set/Get a subsample rate.
int = obj.GetSubsampleRate () - Set/Get a subsample rate.
36.63
vtkImageMapToColors
36.63.1
Usage
The vtkImageMapToColors filter will take an input image of any valid scalar type, and map the first component of
the image through a lookup table. The result is an image of type VTK_UNSIGNED_CHAR. If the lookup table is not
set, or is set to NULL, then the input data will be passed through if it is already of type VTK_UNSIGNED_CHAR.
To create an instance of class vtkImageMapToColors, simply invoke its constructor as follows
obj = vtkImageMapToColors
36.63.2
Methods
The class vtkImageMapToColors has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageMapToColors class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1646
36.64
vtkImageMapToRGBA
36.64.1
Usage
This filter has been replaced by vtkImageMapToColors, which provided additional features. Use vtkImageMapToColors instead.
To create an instance of class vtkImageMapToRGBA, simply invoke its constructor as follows
obj = vtkImageMapToRGBA
36.65 vtkImageMapToWindowLevelColors
36.64.2
1647
Methods
The class vtkImageMapToRGBA has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageMapToRGBA class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageMapToRGBA = obj.NewInstance ()
vtkImageMapToRGBA = obj.SafeDownCast (vtkObject o)
36.65
vtkImageMapToWindowLevelColors
36.65.1
Usage
The vtkImageMapToWindowLevelColors filter will take an input image of any valid scalar type, and map the first
component of the image through a lookup table. This resulting color will be modulated with value obtained by a
window / level operation. The result is an image of type VTK_UNSIGNED_CHAR. If the lookup table is not set, or
is set to NULL, then the input data will be passed through if it is already of type UNSIGNED_CHAR.
To create an instance of class vtkImageMapToWindowLevelColors, simply invoke its constructor as follows
obj = vtkImageMapToWindowLevelColors
36.65.2
Methods
The class vtkImageMapToWindowLevelColors has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageMapToWindowLevelColors class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageMapToWindowLevelColors = obj.NewInstance ()
vtkImageMapToWindowLevelColors = obj.SafeDownCast (vtkObject o)
obj.SetWindow (double ) - Set / Get the Window to use -> modulation will be performed on the
color based on (S - (L - W/2))/W where S is the scalar value, L is the level and W is the window.
double = obj.GetWindow () - Set / Get the Window to use -> modulation will be performed on the
color based on (S - (L - W/2))/W where S is the scalar value, L is the level and W is the window.
obj.SetLevel (double ) - Set / Get the Level to use -> modulation will be performed on the color
based on (S - (L - W/2))/W where S is the scalar value, L is the level and W is the window.
double = obj.GetLevel () - Set / Get the Level to use -> modulation will be performed on the color
based on (S - (L - W/2))/W where S is the scalar value, L is the level and W is the window.
36.66
vtkImageMask
1648
36.66.1
Usage
vtkImageMask combines a mask with an image. Non zero mask implies the output pixel will be the same as the
image. If a mask pixel is zero, then the output pixel is set to "MaskedValue". The filter also has the option to pass
the mask through a boolean not operation before processing the image. This reverses the passed and replaced
pixels. The two inputs should have the same "WholeExtent". The mask input should be unsigned char, and the
image scalar type is the same as the output scalar type.
To create an instance of class vtkImageMask, simply invoke its constructor as follows
obj = vtkImageMask
36.66.2
Methods
The class vtkImageMask has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkImageMask class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageMask = obj.NewInstance ()
vtkImageMask = obj.SafeDownCast (vtkObject o)
obj.SetMaskedOutputValue (int num, double v) - SetGet the value of the output pixel replaced by mask.
obj.SetMaskedOutputValue (double v) - SetGet the value of the output pixel replaced by mask.
obj.SetMaskedOutputValue (double v1, double v2) - SetGet the value of the output pixel
replaced by mask.
obj.SetMaskedOutputValue (double v1, double v2, double v3) - SetGet the value of
the output pixel replaced by mask.
int = obj.GetMaskedOutputValueLength () - Set/Get the alpha blending value for the mask
The input image is assumed to be at alpha = 1.0 and the mask image uses this alpha to blend using an over
operator.
obj.SetMaskAlpha (double ) - Set/Get the alpha blending value for the mask The input image is
assumed to be at alpha = 1.0 and the mask image uses this alpha to blend using an over operator.
double = obj.GetMaskAlphaMinValue () - Set/Get the alpha blending value for the mask The
input image is assumed to be at alpha = 1.0 and the mask image uses this alpha to blend using an over
operator.
double = obj.GetMaskAlphaMaxValue () - Set/Get the alpha blending value for the mask The
input image is assumed to be at alpha = 1.0 and the mask image uses this alpha to blend using an over
operator.
double = obj.GetMaskAlpha () - Set/Get the alpha blending value for the mask The input image
is assumed to be at alpha = 1.0 and the mask image uses this alpha to blend using an over operator.
obj.SetImageInput (vtkImageData in) - Set the input to be masked.
obj.SetMaskInput (vtkImageData in) - Set the mask to be used.
obj.SetNotMask (int ) - When Not Mask is on, the mask is passed through a boolean not before it
is used to mask the image. The effect is to pass the pixels where the input mask is zero, and replace the
pixels where the input value is non zero.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.67 vtkImageMaskBits
1649
int = obj.GetNotMask () - When Not Mask is on, the mask is passed through a boolean not before
it is used to mask the image. The effect is to pass the pixels where the input mask is zero, and replace the
pixels where the input value is non zero.
obj.NotMaskOn () - When Not Mask is on, the mask is passed through a boolean not before it is used
to mask the image. The effect is to pass the pixels where the input mask is zero, and replace the pixels where
the input value is non zero.
obj.NotMaskOff () - When Not Mask is on, the mask is passed through a boolean not before it is used
to mask the image. The effect is to pass the pixels where the input mask is zero, and replace the pixels where
the input value is non zero.
obj.SetInput1 (vtkDataObject in) - Set the two inputs to this filter
obj.SetInput2 (vtkDataObject in)
36.67
vtkImageMaskBits
36.67.1
Usage
vtkImageMaskBits applies a bit-mask pattern to each component. The bit-mask can be applied using a variety of
boolean bitwise operators.
To create an instance of class vtkImageMaskBits, simply invoke its constructor as follows
obj = vtkImageMaskBits
36.67.2
Methods
The class vtkImageMaskBits has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageMaskBits class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageMaskBits = obj.NewInstance ()
vtkImageMaskBits = obj.SafeDownCast (vtkObject o)
obj.SetMasks (int , int , int , int ) - Set/Get the bit-masks. Default is 0xffffffff.
obj.SetMasks (int a[4]) - Set/Get the bit-masks. Default is 0xffffffff.
obj.SetMask (int mask) - Set/Get the bit-masks. Default is 0xffffffff.
obj.SetMasks (int mask1, int mask2) - Set/Get the bit-masks. Default is 0xffffffff.
obj.SetMasks (int mask1, int mask2, int mask3) - Set/Get the bit-masks.
0xffffffff.
int = obj.
Default is
1650
36.68
vtkImageMathematics
36.68.1
Usage
vtkImageMathematics implements basic mathematic operations SetOperation is used to select the filters behavior.
The filter can take two or one input.
To create an instance of class vtkImageMathematics, simply invoke its constructor as follows
obj = vtkImageMathematics
36.68.2
Methods
The class vtkImageMathematics has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageMathematics class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageMathematics = obj.NewInstance ()
vtkImageMathematics = obj.SafeDownCast (vtkObject o)
obj.SetOperation (int ) - Set/Get the Operation to perform.
int = obj.GetOperation () - Set/Get the Operation to perform.
obj.SetOperationToAdd () - Set each pixel in the output image to the sum of the corresponding
pixels in Input1 and Input2.
obj.SetOperationToSubtract () - Set each pixel in the output image to the difference of the corresponding pixels in Input1 and Input2 (output = Input1 - Input2).
obj.SetOperationToMultiply () - Set each pixel in the output image to the product of the corresponding pixels in Input1 and Input2.
obj.SetOperationToDivide () - Set each pixel in the output image to the quotient of the corresponding pixels in Input1 and Input2 (Output = Input1 / Input2).
obj.SetOperationToConjugate ()
obj.SetOperationToComplexMultiply ()
obj.SetOperationToInvert () - Set each pixel in the output image to 1 over the corresponding
pixel in Input1 and Input2 (output = 1 / Input1). Input2 is not used.
obj.SetOperationToSin () - Set each pixel in the output image to the sine of the corresponding
pixel in Input1. Input2 is not used.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.69 vtkImageMedian3D
1651
obj.SetOperationToCos () - Set each pixel in the output image to the cosine of the corresponding
pixel in Input1. Input2 is not used.
obj.SetOperationToExp () - Set each pixel in the output image to the exponential of the corresponding pixel in Input1. Input2 is not used.
obj.SetOperationToLog () - Set each pixel in the output image to the log of the corresponding pixel
in Input1. Input2 is not used.
obj.SetOperationToAbsoluteValue () - Set each pixel in the output image to the absolute value
of the corresponding pixel in Input1. Input2 is not used.
obj.SetOperationToSquare () - Set each pixel in the output image to the square of the corresponding pixel in Input1. Input2 is not used.
obj.SetOperationToSquareRoot () - Set each pixel in the output image to the square root of the
corresponding pixel in Input1. Input2 is not used.
obj.SetOperationToMin () - Set each pixel in the output image to the minimum of the corresponding
pixels in Input1 and Input2. (Output = min(Input1, Input2))
obj.SetOperationToMax () - Set each pixel in the output image to the maximum of the corresponding
pixels in Input1 and Input2. (Output = max(Input1, Input2))
obj.SetOperationToATAN () - Set each pixel in the output image to the arctangent of the corresponding pixel in Input1. Input2 is not used.
obj.SetOperationToATAN2 ()
obj.SetOperationToMultiplyByK () - Set each pixel in the output image to the product of
ConstantK with the corresponding pixel in Input1. Input2 is not used.
obj.SetOperationToAddConstant () - Set each pixel in the output image to the product of
ConstantC with the corresponding pixel in Input1. Input2 is not used.
obj.SetOperationToReplaceCByK () - Find every pixel in Input1 that equals ConstantC and set
the corresponding pixels in the Output to ConstantK. Input2 is not used.
obj.SetConstantK (double ) - A constant used by some operations (typically multiplicative). Default is 1.
double = obj.GetConstantK () - A constant used by some operations (typically multiplicative).
Default is 1.
obj.SetConstantC (double ) - A constant used by some operations (typically additive). Default is
0.
double = obj.GetConstantC () - A constant used by some operations (typically additive). Default
is 0.
obj.SetDivideByZeroToC (int ) - How to handle divide by zero. Default is 0.
int = obj.GetDivideByZeroToC () - How to handle divide by zero. Default is 0.
obj.DivideByZeroToCOn () - How to handle divide by zero. Default is 0.
obj.DivideByZeroToCOff () - How to handle divide by zero. Default is 0.
obj.SetInput1 (vtkDataObject in) - Set the two inputs to this filter. For some operations, the
second input is not used.
obj.SetInput2 (vtkDataObject in)
36.69
vtkImageMedian3D
1652
36.69.1
Usage
vtkImageMedian3D a Median filter that replaces each pixel with the median value from a rectangular neighborhood
around that pixel. Neighborhoods can be no more than 3 dimensional. Setting one axis of the neighborhood
kernelSize to 1 changes the filter into a 2D median.
To create an instance of class vtkImageMedian3D, simply invoke its constructor as follows
obj = vtkImageMedian3D
36.69.2
Methods
The class vtkImageMedian3D has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageMedian3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageMedian3D = obj.NewInstance ()
vtkImageMedian3D = obj.SafeDownCast (vtkObject o)
obj.SetKernelSize (int size0, int size1, int size2) - This method sets the size of
the neighborhood. It also sets the default middle of the neighborhood
int = obj.GetNumberOfElements () - Return the number of elements in the median mask
36.70
vtkImageMirrorPad
36.70.1
Usage
vtkImageMirrorPad makes an image larger by filling extra pixels with a mirror image of the original image (mirror at
image boundaries).
To create an instance of class vtkImageMirrorPad, simply invoke its constructor as follows
obj = vtkImageMirrorPad
36.70.2
Methods
The class vtkImageMirrorPad has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageMirrorPad class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageMirrorPad = obj.NewInstance ()
vtkImageMirrorPad = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.71 vtkImageNoiseSource
36.71
1653
vtkImageNoiseSource
36.71.1
Usage
vtkImageNoiseSource just produces images filled with noise. The only option now is uniform noise specified by a
min and a max. There is one major problem with this source. Every time it executes, it will output different pixel
values. This has important implications when a stream requests overlapping regions. The same pixels will have
different values on different updates.
To create an instance of class vtkImageNoiseSource, simply invoke its constructor as follows
obj = vtkImageNoiseSource
36.71.2
Methods
The class vtkImageNoiseSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageNoiseSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageNoiseSource = obj.NewInstance ()
vtkImageNoiseSource = obj.SafeDownCast (vtkObject o)
obj.SetMinimum (double ) - Set/Get the minimum and maximum values for the generated noise.
double = obj.GetMinimum () - Set/Get the minimum and maximum values for the generated noise.
obj.SetMaximum (double ) - Set/Get the minimum and maximum values for the generated noise.
double = obj.GetMaximum () - Set/Get the minimum and maximum values for the generated noise.
obj.SetWholeExtent (int xMinx, int xMax, int yMin, int yMax, int zMin,
int zMax) - Set how large of an image to generate.
obj.SetWholeExtent (int ext[6])
36.72
vtkImageNonMaximumSuppression
36.72.1
Usage
vtkImageNonMaximumSuppression Sets to zero any pixel that is not a peak. If a pixel has a neighbor along the
vector that has larger magnitude, the smaller pixel is set to zero. The filter takes two inputs: a magnitude and a
vector. Output is magnitude information and is always in doubles. Typically this filter is used with vtkImageGradient
and vtkImageGradientMagnitude as inputs.
To create an instance of class vtkImageNonMaximumSuppression, simply invoke its constructor as follows
obj = vtkImageNonMaximumSuppression
1654
36.72.2
Methods
The class vtkImageNonMaximumSuppression has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageNonMaximumSuppression class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageNonMaximumSuppression = obj.NewInstance ()
vtkImageNonMaximumSuppression = obj.SafeDownCast (vtkObject o)
obj.SetMagnitudeInput (vtkImageData input) - Set the magnitude and vector inputs.
obj.SetVectorInput (vtkImageData input) - Set the magnitude and vector inputs.
obj.SetHandleBoundaries (int ) - If "HandleBoundariesOn" then boundary pixels are duplicated
So central differences can get values.
int = obj.GetHandleBoundaries () - If "HandleBoundariesOn" then boundary pixels are duplicated So central differences can get values.
obj.HandleBoundariesOn () - If "HandleBoundariesOn" then boundary pixels are duplicated So central differences can get values.
obj.HandleBoundariesOff () - If "HandleBoundariesOn" then boundary pixels are duplicated So
central differences can get values.
obj.SetDimensionality (int ) - Determines how the input is interpreted (set of 2d slices or a 3D
volume)
int = obj.GetDimensionalityMinValue () - Determines how the input is interpreted (set of 2d
slices or a 3D volume)
int = obj.GetDimensionalityMaxValue () - Determines how the input is interpreted (set of 2d
slices or a 3D volume)
int = obj.GetDimensionality () - Determines how the input is interpreted (set of 2d slices or a
3D volume)
36.73
vtkImageNormalize
36.73.1
Usage
For each point, vtkImageNormalize normalizes the vector defined by the scalar components. If the magnitude of
this vector is zero, the output vector is zero also.
To create an instance of class vtkImageNormalize, simply invoke its constructor as follows
obj = vtkImageNormalize
36.74 vtkImageOpenClose3D
36.73.2
1655
Methods
The class vtkImageNormalize has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageNormalize class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageNormalize = obj.NewInstance ()
vtkImageNormalize = obj.SafeDownCast (vtkObject o)
36.74
vtkImageOpenClose3D
36.74.1
Usage
vtkImageOpenClose3D performs opening or closing by having two vtkImageErodeDilates in series. The size of
operation is determined by the method SetKernelSize, and the operator is an ellipse. OpenValue and CloseValue
determine how the filter behaves. For binary images Opening and closing behaves as expected. Close value is first
dilated, and then eroded. Open value is first eroded, and then dilated. Degenerate two dimensional opening/closing
can be achieved by setting the one axis the 3D KernelSize to 1. Values other than open value and close value are
not touched. This enables the filter to processes segmented images containing more than two tags.
To create an instance of class vtkImageOpenClose3D, simply invoke its constructor as follows
obj = vtkImageOpenClose3D
36.74.2
Methods
The class vtkImageOpenClose3D has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageOpenClose3D
class.
string = obj.GetClassName () - Default open value is 0, and default close value is 255.
int = obj.IsA (string name) - Default open value is 0, and default close value is 255.
vtkImageOpenClose3D = obj.NewInstance () - Default open value is 0, and default close value
is 255.
vtkImageOpenClose3D = obj.SafeDownCast (vtkObject o) - Default open value is 0, and
default close value is 255.
long = obj.GetMTime () - This method considers the sub filters MTimes when computing this objects
modified time.
obj.DebugOn () - Turn debugging output on. (in sub filters also)
obj.DebugOff () - Turn debugging output on. (in sub filters also)
obj.Modified () - Pass modified message to sub filters.
obj.SetKernelSize (int size0, int size1, int size2) - Selects the size of gaps or objects removed.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1656
obj.SetOpenValue (double value) - Determines the value that will opened. Open value is first
eroded, and then dilated.
double = obj.GetOpenValue () - Determines the value that will opened. Open value is first eroded,
and then dilated.
obj.SetCloseValue (double value) - Determines the value that will closed. Close value is first
dilated, and then eroded
double = obj.GetCloseValue () - Determines the value that will closed. Close value is first dilated, and then eroded
vtkImageDilateErode3D = obj.GetFilter0 () - Needed for Progress functions
vtkImageDilateErode3D = obj.GetFilter1 () - Needed for Progress functions
36.75
vtkImagePadFilter
36.75.1
Usage
vtkImagePadFilter Changes the image extent of an image. If the image extent is larger than the input image extent,
the extra pixels are filled by an algorithm determined by the subclass. The image extent of the output has to be
specified.
To create an instance of class vtkImagePadFilter, simply invoke its constructor as follows
obj = vtkImagePadFilter
36.75.2
Methods
The class vtkImagePadFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImagePadFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImagePadFilter = obj.NewInstance ()
vtkImagePadFilter = obj.SafeDownCast (vtkObject o)
obj.SetOutputWholeExtent (int extent[6]) - The image extent of the output has to be set
explicitly.
obj.SetOutputWholeExtent (int minX, int maxX, int minY, int maxY, int
minZ, int maxZ) - The image extent of the output has to be set explicitly.
obj.GetOutputWholeExtent (int extent[6]) - The image extent of the output has to be set
explicitly.
int = obj.GetOutputWholeExtent () - Set/Get the number of output scalar components.
obj.SetOutputNumberOfScalarComponents (int ) - Set/Get the number of output scalar
components.
int = obj.GetOutputNumberOfScalarComponents () - Set/Get the number of output scalar
components.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.76 vtkImagePermute
36.76
1657
vtkImagePermute
36.76.1
Usage
vtkImagePermute reorders the axes of the input. Filtered axes specify the input axes which become X, Y, Z. The
input has to have the same scalar type of the output. The filter does copy the data when it executes. This filter is
actually a very thin wrapper around vtkImageReslice.
To create an instance of class vtkImagePermute, simply invoke its constructor as follows
obj = vtkImagePermute
36.76.2
Methods
The class vtkImagePermute has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImagePermute class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImagePermute = obj.NewInstance ()
vtkImagePermute = obj.SafeDownCast (vtkObject o)
obj.SetFilteredAxes (int x, int y, int z) - The filtered axes are the input axes that get
relabeled to X,Y,Z.
obj.SetFilteredAxes (int xyz[3]) - The filtered axes are the input axes that get relabeled to
X,Y,Z.
int = obj.
36.77
GetFilteredAxes () - The filtered axes are the input axes that get relabeled to X,Y,Z.
vtkImageQuantizeRGBToIndex
36.77.1
Usage
vtkImageQuantizeRGBToIndex takes a 3 component RGB image as input and produces a one component index
image as output, along with a lookup table that contains the color definitions for the index values. This filter works
on the entire input extent - it does not perform streaming, and it does not supported threaded execution (because it
has to process the entire image).
To use this filter, you typically set the number of colors (between 2 and 65536), execute it, and then retrieve the
lookup table. The colors can then be using the lookup table and the image index.
To create an instance of class vtkImageQuantizeRGBToIndex, simply invoke its constructor as follows
obj = vtkImageQuantizeRGBToIndex
1658
36.77.2
Methods
The class vtkImageQuantizeRGBToIndex has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageQuantizeRGBToIndex class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageQuantizeRGBToIndex = obj.NewInstance ()
vtkImageQuantizeRGBToIndex = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfColors (int ) - Set / Get the number of color index values to produce - must be
a number between 2 and 65536.
int = obj.GetNumberOfColorsMinValue () - Set / Get the number of color index values to produce - must be a number between 2 and 65536.
int = obj.GetNumberOfColorsMaxValue () - Set / Get the number of color index values to produce - must be a number between 2 and 65536.
int = obj.GetNumberOfColors () - Set / Get the number of color index values to produce - must
be a number between 2 and 65536.
vtkLookupTable = obj.GetLookupTable () - Get the resulting lookup table that contains the
color definitions corresponding to the index values in the output image.
double = obj.GetInitializeExecuteTime ()
double = obj.GetBuildTreeExecuteTime ()
double = obj.GetLookupIndexExecuteTime ()
36.78
vtkImageRange3D
36.78.1
Usage
vtkImageRange3D replaces a pixel with the maximum minus minimum over an ellipsoidal neighborhood. If KernelSize of an axis is 1, no processing is done on that axis.
To create an instance of class vtkImageRange3D, simply invoke its constructor as follows
obj = vtkImageRange3D
36.78.2
Methods
The class vtkImageRange3D has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageRange3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageRange3D = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.79 vtkImageRectilinearWipe
1659
36.79
vtkImageRectilinearWipe
36.79.1
Usage
vtkImageRectilinearWipe makes a rectilinear combination of two images. The two input images must correspond
in size, scalar type and number of components. The resulting image has four possible configurations called: Quad
- alternate input 0 and input 1 horizontally and vertically. Select this with SetWipeModeToQuad. The Position
specifies the location of the quad intersection. Corner - 3 of one input and 1 of the other. Select the location of
input 0 with with SetWipeModeToLowerLeft, SetWipeModeToLowerRight, SetWipeModeToUpperLeft and SetWipeModeToUpperRight. The Position selects the location of the corner. Horizontal - alternate input 0 and input 1 with a
vertical split. Select this with SetWipeModeToHorizontal. Position[0] specifies the location of the vertical transition
between input 0 and input 1. Vertical - alternate input 0 and input 1 with a horizontal split. Only the y The intersection
point of the rectilinear points is controlled with the Point ivar.
To create an instance of class vtkImageRectilinearWipe, simply invoke its constructor as follows
obj = vtkImageRectilinearWipe
36.79.2
Methods
The class vtkImageRectilinearWipe has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageRectilinearWipe
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageRectilinearWipe = obj.NewInstance ()
vtkImageRectilinearWipe = obj.SafeDownCast (vtkObject o)
obj.SetPosition (int , int ) - Set/Get the location of the image transition. Note that position is
specified in pixels.
obj.SetPosition (int a[2]) - Set/Get the location of the image transition. Note that position is
specified in pixels.
int = obj. GetPosition () - Set/Get the location of the image transition. Note that position is
specified in pixels.
obj.SetInput1 (vtkDataObject in) - Set the two inputs to this filter.
obj.SetInput2 (vtkDataObject in) - Specify the wipe mode. This mode determnis how input 0
and input 1 are combined to produce the output. Each mode uses one or both of the values stored in Position.
SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location
of the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of
the other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects
the location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0]
specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input
0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input
0 and input 1.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1660
obj.SetWipe (int ) - Specify the wipe mode. This mode determnis how input 0 and input 1 are
combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of
the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the
other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the
location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0]
specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input
0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input
0 and input 1.
int = obj.GetWipeMinValue () - Specify the wipe mode. This mode determnis how input 0 and
input 1 are combined to produce the output. Each mode uses one or both of the values stored in Position.
SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location
of the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of
the other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects
the location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0]
specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input
0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input
0 and input 1.
int = obj.GetWipeMaxValue () - Specify the wipe mode. This mode determnis how input 0 and
input 1 are combined to produce the output. Each mode uses one or both of the values stored in Position.
SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location
of the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of
the other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects
the location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0]
specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input
0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input
0 and input 1.
int = obj.GetWipe () - Specify the wipe mode. This mode determnis how input 0 and input 1 are
combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of
the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the
other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the
location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0]
specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input
0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input
0 and input 1.
obj.SetWipeToQuad () - Specify the wipe mode. This mode determnis how input 0 and input 1 are
combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of
the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the
other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the
location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0]
specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input
0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input
0 and input 1.
obj.SetWipeToHorizontal () - Specify the wipe mode. This mode determnis how input 0 and input
1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of
the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the
other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the
location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0]
specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input
0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input
0 and input 1.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.80 vtkImageResample
1661
obj.SetWipeToVertical () - Specify the wipe mode. This mode determnis how input 0 and input
1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of
the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the
other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the
location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0]
specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input
0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input
0 and input 1.
obj.SetWipeToLowerLeft () - Specify the wipe mode. This mode determnis how input 0 and input
1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of
the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the
other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the
location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0]
specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input
0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input
0 and input 1.
obj.SetWipeToLowerRight () - Specify the wipe mode. This mode determnis how input 0 and input
1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of
the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the
other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the
location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0]
specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input
0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input
0 and input 1.
obj.SetWipeToUpperLeft () - Specify the wipe mode. This mode determnis how input 0 and input
1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of
the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the
other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the
location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0]
specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input
0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input
0 and input 1.
obj.SetWipeToUpperRight ()
36.80
vtkImageResample
36.80.1
Usage
This filter produces an output with different spacing (and extent) than the input. Linear interpolation can be used
to resample the data. The Output spacing can be set explicitly or relative to input spacing with the SetAxisMagnificationFactor method.
To create an instance of class vtkImageResample, simply invoke its constructor as follows
obj = vtkImageResample
1662
36.80.2
Methods
The class vtkImageResample has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageResample class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageResample = obj.NewInstance ()
vtkImageResample = obj.SafeDownCast (vtkObject o)
obj.SetAxisOutputSpacing (int axis, double spacing) - Set desired spacing. Zero is
a reserved value indicating spacing has not been set.
obj.SetAxisMagnificationFactor (int axis, double factor) - Set/Get Magnification
factors. Zero is a reserved value indicating values have not been computed.
double = obj.GetAxisMagnificationFactor (int axis, vtkInformation inInfo) - Set/Get Magnification factors. Zero is a reserved value indicating values have not been computed.
obj.SetDimensionality (int ) - Dimensionality is the number of axes which are considered during execution. To process images dimensionality would be set to 2. This has the same effect as setting the
magnification of the third axis to 1.0
int = obj.GetDimensionality () - Dimensionality is the number of axes which are considered
during execution. To process images dimensionality would be set to 2. This has the same effect as setting
the magnification of the third axis to 1.0
36.81
vtkImageReslice
36.81.1
Usage
vtkImageReslice is the swiss-army-knife of image geometry filters: It can permute, rotate, flip, scale, resample,
deform, and pad image data in any combination with reasonably high efficiency. Simple operations such as permutation, resampling and padding are done with similar efficiently to the specialized vtkImagePermute, vtkImageResample, and vtkImagePad filters. There are a number of tasks that vtkImageReslice is well suited for:
1) Application of simple rotations, scales, and translations to an image. It is often a good idea to use vtkImageChangeInformation to center the image first, so that scales and rotations occur around the center rather than around
the lower-left corner of the image.
2) Resampling of one data set to match the voxel sampling of a second data set via the SetInformationInput()
method, e.g. for the purpose of comparing two images or combining two images. A transformation, either linear
or nonlinear, can be applied at the same time via the SetResliceTransform method if the two images are not in the
same coordinate space.
3) Extraction of slices from an image volume. The most convenient way to do this is to use SetResliceAxesDirectionCosines() to specify the orientation of the slice. The direction cosines give the x, y, and z axes for the output volume.
The method SetOutputDimensionality(2) is used to specify that want to output a slice rather than a volume. The
SetResliceAxesOrigin() command is used to provide an (x,y,z) point that the slice will pass through. You can use
both the ResliceAxes and the ResliceTransform at the same time, in order to extract slices from a volume that you
have applied a transformation to.
To create an instance of class vtkImageReslice, simply invoke its constructor as follows
obj = vtkImageReslice
36.81 vtkImageReslice
36.81.2
1663
Methods
The class vtkImageReslice has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkImageReslice class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageReslice = obj.NewInstance ()
vtkImageReslice = obj.SafeDownCast (vtkObject o)
obj.SetResliceAxes (vtkMatrix4x4 ) - This method is used to set up the axes for the output
voxels. The output Spacing, Origin, and Extent specify the locations of the voxels within the coordinate system
defined by the axes. The ResliceAxes are used most often to permute the data, e.g. to extract ZY or XZ slices
of a volume as 2D XY images.
The first column of the matrix specifies the x-axis vector (the fourth element must be set to zero), the second
column specifies the y-axis, and the third column the z-axis. The fourth column is the origin of the axes (the
fourth element must be set to one).
An alternative to SetResliceAxes() is to use SetResliceAxesDirectionCosines() to set the directions of the
axes and SetResliceAxesOrigin() to set the origin of the axes.
vtkMatrix4x4 = obj.GetResliceAxes () - This method is used to set up the axes for the output
voxels. The output Spacing, Origin, and Extent specify the locations of the voxels within the coordinate system
defined by the axes. The ResliceAxes are used most often to permute the data, e.g. to extract ZY or XZ slices
of a volume as 2D XY images.
The first column of the matrix specifies the x-axis vector (the fourth element must be set to zero), the second
column specifies the y-axis, and the third column the z-axis. The fourth column is the origin of the axes (the
fourth element must be set to one).
An alternative to SetResliceAxes() is to use SetResliceAxesDirectionCosines() to set the directions of the
axes and SetResliceAxesOrigin() to set the origin of the axes.
obj.SetResliceAxesDirectionCosines (double x0, double x1, double x2,
double y0, double y1, double y2, double z0, double z1, double z2) - Specify
the direction cosines for the ResliceAxes (i.e. the first three elements of each of the first three columns of the
ResliceAxes matrix). This will modify the current ResliceAxes matrix, or create a new matrix if none exists.
obj.SetResliceAxesDirectionCosines (double x[3], double y[3], double
z[3]) - Specify the direction cosines for the ResliceAxes (i.e. the first three elements of each of the
first three columns of the ResliceAxes matrix). This will modify the current ResliceAxes matrix, or create a
new matrix if none exists.
obj.SetResliceAxesDirectionCosines (double xyz[9]) - Specify the direction cosines
for the ResliceAxes (i.e. the first three elements of each of the first three columns of the ResliceAxes matrix).
This will modify the current ResliceAxes matrix, or create a new matrix if none exists.
obj.GetResliceAxesDirectionCosines (double x[3], double y[3], double
z[3]) - Specify the direction cosines for the ResliceAxes (i.e. the first three elements of each of the
first three columns of the ResliceAxes matrix). This will modify the current ResliceAxes matrix, or create a
new matrix if none exists.
obj.GetResliceAxesDirectionCosines (double xyz[9]) - Specify the direction cosines
for the ResliceAxes (i.e. the first three elements of each of the first three columns of the ResliceAxes matrix).
This will modify the current ResliceAxes matrix, or create a new matrix if none exists.
double = obj.GetResliceAxesDirectionCosines () - Specify the direction cosines for the
ResliceAxes (i.e. the first three elements of each of the first three columns of the ResliceAxes matrix). This
will modify the current ResliceAxes matrix, or create a new matrix if none exists.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1664
36.81 vtkImageReslice
1665
int = obj.GetAutoCropOutput () - Turn this on if you want to guarantee that the extent of the
output will be large enough to ensure that none of the data will be cropped (default: Off).
obj.SetWrap (int ) - Turn on wrap-pad feature (default: Off).
int = obj.GetWrap () - Turn on wrap-pad feature (default: Off).
obj.WrapOn () - Turn on wrap-pad feature (default: Off).
obj.WrapOff () - Turn on wrap-pad feature (default: Off).
obj.SetMirror (int ) - Turn on mirror-pad feature (default: Off). This will override the wrap-pad.
int = obj.GetMirror () - Turn on mirror-pad feature (default: Off). This will override the wrap-pad.
obj.MirrorOn () - Turn on mirror-pad feature (default: Off). This will override the wrap-pad.
obj.MirrorOff () - Turn on mirror-pad feature (default: Off). This will override the wrap-pad.
obj.SetBorder (int ) - Extend the apparent input border by a half voxel (default: On). This changes
how interpolation is handled at the borders of the input image: if the center of an output voxel is beyond the
edge of the input image, but is within a half voxel width of the edge (using the input voxel width), then the
value of the output voxel is calculated as if the inputs edge voxels were duplicated past the edges of the input.
This has no effect if Mirror or Wrap are on.
int = obj.GetBorder () - Extend the apparent input border by a half voxel (default: On). This
changes how interpolation is handled at the borders of the input image: if the center of an output voxel is
beyond the edge of the input image, but is within a half voxel width of the edge (using the input voxel width),
then the value of the output voxel is calculated as if the inputs edge voxels were duplicated past the edges of
the input. This has no effect if Mirror or Wrap are on.
obj.BorderOn () - Extend the apparent input border by a half voxel (default: On). This changes how
interpolation is handled at the borders of the input image: if the center of an output voxel is beyond the edge
of the input image, but is within a half voxel width of the edge (using the input voxel width), then the value of
the output voxel is calculated as if the inputs edge voxels were duplicated past the edges of the input. This
has no effect if Mirror or Wrap are on.
obj.BorderOff () - Extend the apparent input border by a half voxel (default: On). This changes how
interpolation is handled at the borders of the input image: if the center of an output voxel is beyond the edge
of the input image, but is within a half voxel width of the edge (using the input voxel width), then the value of
the output voxel is calculated as if the inputs edge voxels were duplicated past the edges of the input. This
has no effect if Mirror or Wrap are on.
obj.SetInterpolationMode (int ) - Set interpolation mode (default: nearest neighbor).
int = obj.GetInterpolationModeMinValue () - Set interpolation mode (default: nearest
neighbor).
int = obj.GetInterpolationModeMaxValue () - Set interpolation mode (default: nearest
neighbor).
int = obj.GetInterpolationMode () - Set interpolation mode (default: nearest neighbor).
obj.SetInterpolationModeToNearestNeighbor () - Set interpolation mode (default: nearest
neighbor).
obj.SetInterpolationModeToLinear () - Set interpolation mode (default: nearest neighbor).
obj.SetInterpolationModeToCubic () - Set interpolation mode (default: nearest neighbor).
string = obj.GetInterpolationModeAsString () - Set interpolation mode (default: nearest
neighbor).
obj.SetOptimization (int ) - Turn on and off optimizations (default on, they should only be turned
off for testing purposes).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1666
int = obj.GetOptimization () - Turn on and off optimizations (default on, they should only be
turned off for testing purposes).
obj.OptimizationOn () - Turn on and off optimizations (default on, they should only be turned off for
testing purposes).
obj.OptimizationOff () - Turn on and off optimizations (default on, they should only be turned off
for testing purposes).
obj.SetBackgroundColor (double , double , double , double ) - Set the background color (for multi-component images).
obj.SetBackgroundColor (double a[4]) - Set the background color (for multi-component images).
double = obj.
ages).
36.82 vtkImageRFFT
1667
36.82
vtkImageRFFT
36.82.1
Usage
vtkImageRFFT implements the reverse fast Fourier transform. The input can have real or complex data in any
components and data types, but the output is always complex doubles with real values in component0, and imaginary values in component1. The filter is fastest for images that have power of two sizes. The filter uses a butterfly
fitlers for each prime factor of the dimension. This makes images with prime number dimensions (i.e. 17x17) much
slower to compute. Multi dimensional (i.e volumes) FFTs are decomposed so that each axis executes in series. In
most cases the RFFT will produce an image whose imaginary values are all zeros. In this case vtkImageExtractComponents can be used to remove this imaginary components leaving only the real image.
To create an instance of class vtkImageRFFT, simply invoke its constructor as follows
obj = vtkImageRFFT
1668
36.82.2
Methods
The class vtkImageRFFT has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkImageRFFT class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageRFFT = obj.NewInstance ()
vtkImageRFFT = obj.SafeDownCast (vtkObject o)
int = obj.SplitExtent (int splitExt[6], int startExt[6], int num, int
total) - For streaming and threads. Splits output update extent into num pieces. This method needs
to be called num times. Results must not overlap for consistent starting extent. Subclass can override this
method. This method returns the number of pieces resulting from a successful split. This can be from 1 to
"total". If 1 is returned, the extent cannot be split.
36.83
vtkImageRGBToHSI
36.83.1
Usage
For each pixel with red, blue, and green components this filter output the color coded as hue, saturation and intensity.
Output type must be the same as input type.
To create an instance of class vtkImageRGBToHSI, simply invoke its constructor as follows
obj = vtkImageRGBToHSI
36.83.2
Methods
The class vtkImageRGBToHSI has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageRGBToHSI class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageRGBToHSI = obj.NewInstance ()
vtkImageRGBToHSI = obj.SafeDownCast (vtkObject o)
obj.SetMaximum (double ) - Hue is an angle. Maximum specifies when it maps back to 0. HueMaximum defaults to 255 instead of 2PI, because unsigned char is expected as input. Maximum also specifies
the maximum of the Saturation.
double = obj.GetMaximum () - Hue is an angle. Maximum specifies when it maps back to 0. HueMaximum defaults to 255 instead of 2PI, because unsigned char is expected as input. Maximum also specifies
the maximum of the Saturation.
36.84
vtkImageRGBToHSV
36.85 vtkImageSeedConnectivity
36.84.1
1669
Usage
For each pixel with red, blue, and green components this filter output the color coded as hue, saturation and value.
Output type must be the same as input type.
To create an instance of class vtkImageRGBToHSV, simply invoke its constructor as follows
obj = vtkImageRGBToHSV
36.84.2
Methods
The class vtkImageRGBToHSV has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageRGBToHSV class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageRGBToHSV = obj.NewInstance ()
vtkImageRGBToHSV = obj.SafeDownCast (vtkObject o)
obj.SetMaximum (double )
double = obj.GetMaximum ()
36.85
vtkImageSeedConnectivity
36.85.1
Usage
vtkImageSeedConnectivity marks pixels connected to user supplied seeds. The input must be unsigned char, and
the output is also unsigned char. If a seed supplied by the user does not have pixel value "InputTrueValue", then
the image is scanned +x, +y, +z until a pixel is encountered with value "InputTrueValue". This new pixel is used as
the seed . Any pixel with out value "InputTrueValue" is consider off. The output pixels values are 0 for any off pixel
in input, "OutputTrueValue" for any pixels connected to seeds, and "OutputUnconnectedValue" for any on pixels not
connected to seeds. The same seeds are used for all images in the image set.
To create an instance of class vtkImageSeedConnectivity, simply invoke its constructor as follows
obj = vtkImageSeedConnectivity
36.85.2
Methods
The class vtkImageSeedConnectivity has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageSeedConnectivity
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageSeedConnectivity = obj.NewInstance ()
vtkImageSeedConnectivity = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1670
36.86
vtkImageSeparableConvolution
36.86.1
Usage
vtkImageSeparableConvolution performs a convolution along the X, Y, and Z axes of an image, based on the
three different 1D convolution kernels. The kernels must be of odd size, and are considered to be centered at
(int)((kernelsize - 1) / 2.0 ). If a kernel is NULL, that dimension is skipped. This filter is designed to efficiently
convolve separable filters that can be decomposed into 1 or more 1D convolutions. It also handles arbitrarly large
kernel sizes, and uses edge replication to handle boundaries.
To create an instance of class vtkImageSeparableConvolution, simply invoke its constructor as follows
obj = vtkImageSeparableConvolution
36.86.2
Methods
The class vtkImageSeparableConvolution has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageSeparableConvolution class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageSeparableConvolution = obj.NewInstance ()
vtkImageSeparableConvolution = obj.SafeDownCast (vtkObject o)
obj.SetXKernel (vtkFloatArray )
vtkFloatArray = obj.GetXKernel ()
obj.SetYKernel (vtkFloatArray )
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.87 vtkImageShiftScale
1671
vtkFloatArray = obj.GetYKernel ()
obj.SetZKernel (vtkFloatArray )
vtkFloatArray = obj.GetZKernel ()
long = obj.GetMTime () - Overload standard modified time function. If kernel arrays are modified,
then this object is modified as well.
36.87
vtkImageShiftScale
36.87.1
Usage
With vtkImageShiftScale Pixels are shifted (a constant value added) and then scaled (multiplied by a scalar. As a
convenience, this class allows you to set the output scalar type similar to vtkImageCast. This is because shift scale
operations frequently convert data types.
To create an instance of class vtkImageShiftScale, simply invoke its constructor as follows
obj = vtkImageShiftScale
36.87.2
Methods
The class vtkImageShiftScale has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageShiftScale class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageShiftScale = obj.NewInstance ()
vtkImageShiftScale = obj.SafeDownCast (vtkObject o)
obj.SetShift (double ) - Set/Get the shift value. This value is added to each pixel
double = obj.GetShift () - Set/Get the shift value. This value is added to each pixel
obj.SetScale (double ) - Set/Get the scale value. Each pixel is multiplied by this value.
double = obj.GetScale () - Set/Get the scale value. Each pixel is multiplied by this value.
obj.SetOutputScalarType (int ) - Set the desired output scalar type. The result of the shift and
scale operations is cast to the type specified.
int = obj.GetOutputScalarType () - Set the desired output scalar type. The result of the shift
and scale operations is cast to the type specified.
obj.SetOutputScalarTypeToDouble () - Set the desired output scalar type. The result of the
shift and scale operations is cast to the type specified.
obj.SetOutputScalarTypeToFloat () - Set the desired output scalar type. The result of the shift
and scale operations is cast to the type specified.
obj.SetOutputScalarTypeToLong () - Set the desired output scalar type. The result of the shift
and scale operations is cast to the type specified.
obj.SetOutputScalarTypeToUnsignedLong () - Set the desired output scalar type. The result
of the shift and scale operations is cast to the type specified.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1672
obj.SetOutputScalarTypeToInt () - Set the desired output scalar type. The result of the shift
and scale operations is cast to the type specified.
obj.SetOutputScalarTypeToUnsignedInt () - Set the desired output scalar type. The result of
the shift and scale operations is cast to the type specified.
obj.SetOutputScalarTypeToShort () - Set the desired output scalar type. The result of the shift
and scale operations is cast to the type specified.
obj.SetOutputScalarTypeToUnsignedShort () - Set the desired output scalar type. The result
of the shift and scale operations is cast to the type specified.
obj.SetOutputScalarTypeToChar () - Set the desired output scalar type. The result of the shift
and scale operations is cast to the type specified.
obj.SetOutputScalarTypeToUnsignedChar () - When the ClampOverflow flag is on, the data
is thresholded so that the output value does not exceed the max or min of the data type. By default, ClampOverflow is off.
obj.SetClampOverflow (int ) - When the ClampOverflow flag is on, the data is thresholded so
that the output value does not exceed the max or min of the data type. By default, ClampOverflow is off.
int = obj.GetClampOverflow () - When the ClampOverflow flag is on, the data is thresholded so
that the output value does not exceed the max or min of the data type. By default, ClampOverflow is off.
obj.ClampOverflowOn () - When the ClampOverflow flag is on, the data is thresholded so that the
output value does not exceed the max or min of the data type. By default, ClampOverflow is off.
obj.ClampOverflowOff () - When the ClampOverflow flag is on, the data is thresholded so that the
output value does not exceed the max or min of the data type. By default, ClampOverflow is off.
36.88
vtkImageShrink3D
36.88.1
Usage
36.88.2
Methods
The class vtkImageShrink3D has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageShrink3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageShrink3D = obj.NewInstance ()
vtkImageShrink3D = obj.SafeDownCast (vtkObject o)
obj.SetShrinkFactors (int , int , int ) - Set/Get the shrink factors
obj.SetShrinkFactors (int a[3]) - Set/Get the shrink factors
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.89 vtkImageSinusoidSource
int = obj.
1673
obj.SetAveraging (int ) - Choose Mean, Minimum, Maximum, Median or sub sampling. The
neighborhood operations are not centered on the sampled pixel. This may cause a half pixel shift in your
output image. You can changed "Shift" to get around this. vtkImageGaussianSmooth or vtkImageMean with
strides.
int = obj.GetAveraging () - Choose Mean, Minimum, Maximum, Median or sub sampling. The
neighborhood operations are not centered on the sampled pixel. This may cause a half pixel shift in your
output image. You can changed "Shift" to get around this. vtkImageGaussianSmooth or vtkImageMean with
strides.
obj.AveragingOn () - Choose Mean, Minimum, Maximum, Median or sub sampling. The neighborhood operations are not centered on the sampled pixel. This may cause a half pixel shift in your output
image. You can changed "Shift" to get around this. vtkImageGaussianSmooth or vtkImageMean with strides.
obj.AveragingOff () - Choose Mean, Minimum, Maximum, Median or sub sampling. The neighborhood operations are not centered on the sampled pixel. This may cause a half pixel shift in your output image.
You can changed "Shift" to get around this. vtkImageGaussianSmooth or vtkImageMean with strides.
obj.SetMean (int )
int = obj.GetMean ()
obj.MeanOn ()
obj.MeanOff ()
obj.SetMinimum (int )
int = obj.GetMinimum ()
obj.MinimumOn ()
obj.MinimumOff ()
obj.SetMaximum (int )
int = obj.GetMaximum ()
obj.MaximumOn ()
obj.MaximumOff ()
obj.SetMedian (int )
int = obj.GetMedian ()
obj.MedianOn ()
obj.MedianOff ()
36.89
vtkImageSinusoidSource
1674
36.89.1
Usage
36.89.2
Methods
The class vtkImageSinusoidSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageSinusoidSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageSinusoidSource = obj.NewInstance ()
vtkImageSinusoidSource = obj.SafeDownCast (vtkObject o)
obj.SetWholeExtent (int xMinx, int xMax, int yMin, int yMax, int zMin,
int zMax) - Set/Get the extent of the whole output image.
obj.SetDirection (double , double , double ) - Set/Get the direction vector which determines the sinusoidal orientation. The magnitude is ignored.
obj.SetDirection (double dir[3]) - Set/Get the direction vector which determines the sinusoidal orientation. The magnitude is ignored.
double = obj. GetDirection () - Set/Get the direction vector which determines the sinusoidal
orientation. The magnitude is ignored.
obj.SetPeriod (double ) - Set/Get the period of the sinusoid in pixels.
double = obj.GetPeriod () - Set/Get the period of the sinusoid in pixels.
obj.SetPhase (double ) - Set/Get the phase: 0->2Pi. 0 => Cosine, pi/2 => Sine.
double = obj.GetPhase () - Set/Get the phase: 0->2Pi. 0 => Cosine, pi/2 => Sine.
obj.SetAmplitude (double ) - Set/Get the magnitude of the sinusoid.
double = obj.GetAmplitude () - Set/Get the magnitude of the sinusoid.
36.90
vtkImageSkeleton2D
36.90.1
Usage
vtkImageSkeleton2D should leave only single pixel width lines of non-zero-valued pixels (values of 1 are not allowed). It works by erosion on a 3x3 neighborhood with special rules. The number of iterations determines how
far the filter can erode. There are three pruning levels: prune == 0 will leave traces on all angles... prune == 1 will
not leave traces on 135 degree angles, but will on 90. prune == 2 does not leave traces on any angles leaving only
closed loops. Prune defaults to zero. The output scalar type is the same as the input.
To create an instance of class vtkImageSkeleton2D, simply invoke its constructor as follows
obj = vtkImageSkeleton2D
36.91 vtkImageSobel2D
36.90.2
1675
Methods
The class vtkImageSkeleton2D has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageSkeleton2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageSkeleton2D = obj.NewInstance ()
vtkImageSkeleton2D = obj.SafeDownCast (vtkObject o)
obj.SetPrune (int ) - When prune is on, only closed loops are left unchanged.
int = obj.GetPrune () - When prune is on, only closed loops are left unchanged.
obj.PruneOn () - When prune is on, only closed loops are left unchanged.
obj.PruneOff () - When prune is on, only closed loops are left unchanged.
obj.SetNumberOfIterations (int num) - Sets the number of cycles in the erosion.
36.91
vtkImageSobel2D
36.91.1
Usage
vtkImageSobel2D computes a vector field from a scalar field by using Sobel functions. The number of vector
components is 2 because the input is an image. Output is always doubles.
To create an instance of class vtkImageSobel2D, simply invoke its constructor as follows
obj = vtkImageSobel2D
36.91.2
Methods
The class vtkImageSobel2D has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageSobel2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageSobel2D = obj.NewInstance ()
vtkImageSobel2D = obj.SafeDownCast (vtkObject o)
36.92
vtkImageSobel3D
1676
36.92.1
Usage
vtkImageSobel3D computes a vector field from a scalar field by using Sobel functions. The number of vector
components is 3 because the input is a volume. Output is always doubles. A little creative liberty was used to
extend the 2D sobel kernels into 3D.
To create an instance of class vtkImageSobel3D, simply invoke its constructor as follows
obj = vtkImageSobel3D
36.92.2
Methods
The class vtkImageSobel3D has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageSobel3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageSobel3D = obj.NewInstance ()
vtkImageSobel3D = obj.SafeDownCast (vtkObject o)
36.93
vtkImageSpatialAlgorithm
36.93.1
Usage
vtkImageSpatialAlgorithm is a super class for filters that operate on an input neighborhood for each output pixel. It
handles even sized neighborhoods, but their can be a half pixel shift associated with processing. This superclass
has some logic for handling boundaries. It can split regions into boundary and non-boundary pieces and call different
execute methods.
To create an instance of class vtkImageSpatialAlgorithm, simply invoke its constructor as follows
obj = vtkImageSpatialAlgorithm
36.93.2
Methods
The class vtkImageSpatialAlgorithm has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageSpatialAlgorithm
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageSpatialAlgorithm = obj.NewInstance ()
vtkImageSpatialAlgorithm = obj.SafeDownCast (vtkObject o)
int = obj.
int = obj.
36.94 vtkImageSpatialFilter
36.94
1677
vtkImageSpatialFilter
36.94.1
Usage
vtkImageSpatialFilter is a super class for filters that operate on an input neighborhood for each output pixel. It
handles even sized neighborhoods, but their can be a half pixel shift associated with processing. This superclass
has some logic for handling boundaries. It can split regions into boundary and non-boundary pieces and call different
execute methods. .SECTION Warning This used to be the parent class for most imaging filter in VTK4.x, now this
role has been replaced by vtkImageSpatialAlgorithm. You should consider using vtkImageSpatialAlgorithm instead,
when writing filter for VTK5 and above. This class was kept to ensure full backward compatibility. .SECTION See
also vtkSimpleImageToImageFilter vtkImageToImageFilter vtkImageSpatialAlgorithm
To create an instance of class vtkImageSpatialFilter, simply invoke its constructor as follows
obj = vtkImageSpatialFilter
36.94.2
Methods
The class vtkImageSpatialFilter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageSpatialFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageSpatialFilter = obj.NewInstance ()
vtkImageSpatialFilter = obj.SafeDownCast (vtkObject o)
int = obj.
int = obj.
36.95
vtkImageStencil
36.95.1
Usage
vtkImageStencil will combine two images together using a stencil. The stencil should be provided in the form of a
vtkImageStencilData,
To create an instance of class vtkImageStencil, simply invoke its constructor as follows
obj = vtkImageStencil
36.95.2
Methods
The class vtkImageStencil has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkImageStencil class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1678
36.96
vtkImageStencilData
36.96.1
Usage
vtkImageStencilData describes an image stencil in a manner which is efficient both in terms of speed and storage
space. The stencil extents are stored for each x-row across the image (multiple extents per row if necessary) and
can be retrieved via the GetNextExtent() method.
To create an instance of class vtkImageStencilData, simply invoke its constructor as follows
obj = vtkImageStencilData
36.96 vtkImageStencilData
36.96.2
1679
Methods
The class vtkImageStencilData has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageStencilData class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageStencilData = obj.NewInstance ()
vtkImageStencilData = obj.SafeDownCast (vtkObject o)
obj.Initialize ()
obj.DeepCopy (vtkDataObject o)
obj.ShallowCopy (vtkDataObject f)
obj.InternalImageStencilDataCopy (vtkImageStencilData s)
int = obj.GetDataObjectType () - The extent type is 3D, just like vtkImageData.
int = obj.GetExtentType () - The extent type is 3D, just like vtkImageData.
obj.InsertNextExtent (int r1, int r2, int yIdx, int zIdx) - This method is used
by vtkImageStencilDataSource to add an x sub extent [r1,r2] for the x row (yIdx,zIdx). The specified sub
extent must not intersect any other sub extents along the same x row. As well, r1 and r2 must both be within
the total x extent [Extent[0],Extent[1]].
obj.InsertAndMergeExtent (int r1, int r2, int yIdx, int zIdx) - Similar to
InsertNextExtent, except that the extent (r1,r2) at yIdx, zIdx is merged with other extents, (if any) on that row.
So a unique extent may not necessarily be added. For instance, if an extent [5,11] already exists adding an
extent, [7,9] will not affect the stencil. Likewise adding [10, 13] will replace the existing extent with [5,13].
obj.RemoveExtent (int r1, int r2, int yIdx, int zIdx) - Remove the extent from
(r1,r2) at yIdx, zIdx
obj.SetSpacing (double , double , double ) - Set the desired spacing for the stencil. This
must be called before the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter
that is using the stencil.
obj.SetSpacing (double a[3]) - Set the desired spacing for the stencil. This must be called before
the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.
double = obj. GetSpacing () - Set the desired spacing for the stencil. This must be called before
the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.
obj.SetOrigin (double , double , double ) - Set the desired origin for the stencil. This
must be called before the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter
that is using the stencil.
obj.SetOrigin (double a[3]) - Set the desired origin for the stencil. This must be called before
the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.
double = obj. GetOrigin () - Set the desired origin for the stencil. This must be called before
the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.
obj.SetExtent (int extent[6]) - Set the extent of the data. This is should be called only by
vtkImageStencilSource, as it is part of the basic pipeline functionality.
obj.SetExtent (int x1, int x2, int y1, int y2, int z1, int z2) - Set the extent of the data. This is should be called only by vtkImageStencilSource, as it is part of the basic pipeline
functionality.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1680
int = obj. GetExtent () - Set the extent of the data. This is should be called only by vtkImageStencilSource, as it is part of the basic pipeline functionality.
obj.AllocateExtents () - Allocate space for the sub-extents. This is called by vtkImageStencilSource.
obj.Fill () - Fill the sub-extents.
obj.CopyInformationToPipeline (vtkInformation request, vtkInformation
input, vtkInformation output, int forceCopy) - Override these to handle origin, spacing,
scalar type, and scalar number of components. See vtkDataObject for details.
obj.CopyInformationFromPipeline (vtkInformation request) - Override these to
handle origin, spacing, scalar type, and scalar number of components. See vtkDataObject for details.
obj.Add (vtkImageStencilData ) - Add merges the stencil supplied as argument into Self.
obj.Subtract (vtkImageStencilData ) - Subtract removes the portion of the stencil, supplied
as argument, that lies within Self from Self.
obj.Replace (vtkImageStencilData ) - Replaces the portion of the stencil, supplied as argument, that lies within Self from Self.
int = obj.Clip (int extent[6]) - Clip the stencil with the supplied extents. In other words,
discard data outside the specified extents. Return 1 if something changed.
36.97
vtkImageStencilSource
36.97.1
Usage
vtkImageStencilSource is a superclass for filters that generate image stencils. Given a clipping object such as a
vtkImplicitFunction, it will set up a list of clipping extents for each x-row through the image data. The extents for each
x-row can be retrieved via the GetNextExtent() method after the extent lists have been built with the BuildExtents()
method. For large images, using clipping extents is much more memory efficient (and slightly more time-efficient)
than building a mask. This class can be subclassed to allow clipping with objects other than vtkImplicitFunction.
To create an instance of class vtkImageStencilSource, simply invoke its constructor as follows
obj = vtkImageStencilSource
36.97.2
Methods
The class vtkImageStencilSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageStencilSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageStencilSource = obj.NewInstance ()
vtkImageStencilSource = obj.SafeDownCast (vtkObject o)
obj.SetOutput (vtkImageStencilData output) - Get or set the output for this source.
vtkImageStencilData = obj.GetOutput () - Get or set the output for this source.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.98 vtkImageThreshold
36.98
1681
vtkImageThreshold
36.98.1
Usage
vtkImageThreshold can do binary or continuous thresholding for lower, upper or a range of data. The output data
type may be different than the output, but defaults to the same type.
To create an instance of class vtkImageThreshold, simply invoke its constructor as follows
obj = vtkImageThreshold
36.98.2
Methods
The class vtkImageThreshold has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageThreshold class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageThreshold = obj.NewInstance ()
vtkImageThreshold = obj.SafeDownCast (vtkObject o)
obj.ThresholdByUpper (double thresh) - The values greater than or equal to the value match.
obj.ThresholdByLower (double thresh) - The values less than or equal to the value match.
obj.ThresholdBetween (double lower, double upper) - The values in a range (inclusive)
match
obj.SetReplaceIn (int ) - Determines whether to replace the pixel in range with InValue
int = obj.GetReplaceIn () - Determines whether to replace the pixel in range with InValue
obj.ReplaceInOn () - Determines whether to replace the pixel in range with InValue
obj.ReplaceInOff () - Determines whether to replace the pixel in range with InValue
obj.SetInValue (double val) - Replace the in range pixels with this value.
double = obj.GetInValue () - Replace the in range pixels with this value.
obj.SetReplaceOut (int ) - Determines whether to replace the pixel out of range with OutValue
int = obj.GetReplaceOut () - Determines whether to replace the pixel out of range with OutValue
obj.ReplaceOutOn () - Determines whether to replace the pixel out of range with OutValue
obj.ReplaceOutOff () - Determines whether to replace the pixel out of range with OutValue
obj.SetOutValue (double val) - Replace the in range pixels with this value.
double = obj.GetOutValue () - Replace the in range pixels with this value.
double = obj.GetUpperThreshold () - Get the Upper and Lower thresholds.
double = obj.GetLowerThreshold () - Get the Upper and Lower thresholds.
obj.SetOutputScalarType (int ) - Set the desired output scalar type to cast to
int = obj.GetOutputScalarType () - Set the desired output scalar type to cast to
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1682
36.99
vtkImageToImageStencil
36.99.1
Usage
vtkImageToImageStencil will convert a vtkImageData into an stencil that can be used with vtkImageStecil or other
vtk classes that apply a stencil to an image.
To create an instance of class vtkImageToImageStencil, simply invoke its constructor as follows
obj = vtkImageToImageStencil
36.99.2
Methods
The class vtkImageToImageStencil has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageToImageStencil
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageToImageStencil = obj.NewInstance ()
vtkImageToImageStencil = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkImageData input) - Specify the image data to convert into a stencil.
vtkImageData = obj.GetInput () - Specify the image data to convert into a stencil.
obj.ThresholdByUpper (double thresh) - The values greater than or equal to the value match.
obj.ThresholdByLower (double thresh) - The values less than or equal to the value match.
obj.ThresholdBetween (double lower, double upper) - The values in a range (inclusive)
match
obj.SetUpperThreshold (double ) - Get the Upper and Lower thresholds.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.100 vtkImageTranslateExtent
1683
36.100
vtkImageTranslateExtent
36.100.1
Usage
vtkImageTranslateExtent shift the whole extent, but does not change the data.
To create an instance of class vtkImageTranslateExtent, simply invoke its constructor as follows
obj = vtkImageTranslateExtent
36.100.2
Methods
The class vtkImageTranslateExtent has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageTranslateExtent
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageTranslateExtent = obj.NewInstance ()
vtkImageTranslateExtent = obj.SafeDownCast (vtkObject o)
obj.SetTranslation (int , int , int ) - Delta to change "WholeExtent". -1 changes 0->10
to -1->9.
obj.SetTranslation (int a[3]) - Delta to change "WholeExtent". -1 changes 0->10 to -1->9.
int = obj.
36.101
vtkImageVariance3D
36.101.1
Usage
vtkImageVariance3D replaces each pixel with a measurement of pixel variance in a elliptical neighborhood centered
on that pixel. The value computed is not exactly the variance. The difference between the neighbor values and
center value is computed and squared for each neighbor. These values are summed and divided by the total
number of neighbors to produce the output value.
To create an instance of class vtkImageVariance3D, simply invoke its constructor as follows
obj = vtkImageVariance3D
1684
36.101.2
Methods
The class vtkImageVariance3D has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageVariance3D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageVariance3D = obj.NewInstance ()
vtkImageVariance3D = obj.SafeDownCast (vtkObject o)
obj.SetKernelSize (int size0, int size1, int size2) - This method sets the size of
the neighborhood. It also sets the default middle of the neighborhood and computes the Elliptical foot print.
36.102
vtkImageWeightedSum
36.102.1
Usage
All weights are normalized so they will sum to 1. Images must have the same extents. Output is
.SECTION Thanks The original author of this class is Lauren ODonnell (MIT) for Slicer
To create an instance of class vtkImageWeightedSum, simply invoke its constructor as follows
obj = vtkImageWeightedSum
36.102.2
Methods
The class vtkImageWeightedSum has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImageWeightedSum
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageWeightedSum = obj.NewInstance ()
vtkImageWeightedSum = obj.SafeDownCast (vtkObject o)
obj.SetWeights (vtkDoubleArray ) - The weights control the contribution of each input to the
sum. They will be normalized to sum to 1 before filter execution.
vtkDoubleArray = obj.GetWeights () - The weights control the contribution of each input to the
sum. They will be normalized to sum to 1 before filter execution.
obj.SetWeight (vtkIdType id, double weight) - Change a specific weight. Reallocation is
done
int = obj.GetNormalizeByWeight () - Setting NormalizeByWeight on will divide the final result
by the total weight of the component functions. This process does not otherwise normalize the weighted sum
By default, NormalizeByWeight is on.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.103 vtkImageWrapPad
1685
36.103
vtkImageWrapPad
36.103.1
Usage
vtkImageWrapPad performs a modulo operation on the output pixel index to determine the source input index. The
new image extent of the output has to be specified. Input has to be the same scalar type as output.
To create an instance of class vtkImageWrapPad, simply invoke its constructor as follows
obj = vtkImageWrapPad
36.103.2
Methods
The class vtkImageWrapPad has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkImageWrapPad class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImageWrapPad = obj.NewInstance ()
vtkImageWrapPad = obj.SafeDownCast (vtkObject o)
36.104
vtkImplicitFunctionToImageStencil
1686
36.104.1
Usage
vtkImplicitFunctionToImageStencil will convert a vtkImplicitFunction into a stencil that can be used with vtkImageStencil or with other classes that apply a stencil to an image.
To create an instance of class vtkImplicitFunctionToImageStencil, simply invoke its constructor as follows
obj = vtkImplicitFunctionToImageStencil
36.104.2
Methods
The class vtkImplicitFunctionToImageStencil has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkImplicitFunctionToImageStencil class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkImplicitFunctionToImageStencil = obj.NewInstance ()
vtkImplicitFunctionToImageStencil = obj.SafeDownCast (vtkObject o)
obj.SetInput (vtkImplicitFunction ) - Specify the implicit function to convert into a stencil.
vtkImplicitFunction = obj.GetInput () - Specify the implicit function to convert into a stencil.
obj.SetInformationInput (vtkImageData ) - Set a vtkImageData that has the Spacing, Origin, and WholeExtent that will be used for the stencil. This input should be set to the image that you wish to
apply the stencil to. If you use this method, then any values set with the SetOutputSpacing, SetOutputOrigin,
and SetOutputWholeExtent methods will be ignored.
vtkImageData = obj.GetInformationInput () - Set a vtkImageData that has the Spacing,
Origin, and WholeExtent that will be used for the stencil. This input should be set to the image that you wish
to apply the stencil to. If you use this method, then any values set with the SetOutputSpacing, SetOutputOrigin, and SetOutputWholeExtent methods will be ignored.
obj.SetOutputOrigin (double , double , double ) - Set the Origin to be used for the
stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is
(0,0,0).
obj.SetOutputOrigin (double a[3]) - Set the Origin to be used for the stencil. It should be set
to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).
double = obj. GetOutputOrigin () - Set the Origin to be used for the stencil. It should be set
to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).
obj.SetOutputSpacing (double , double , double ) - Set the Spacing to be used for the
stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is
(1,1,1)
obj.SetOutputSpacing (double a[3]) - Set the Spacing to be used for the stencil. It should be
set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)
double = obj. GetOutputSpacing () - Set the Spacing to be used for the stencil. It should be
set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)
obj.SetOutputWholeExtent (int , int , int , int , int , int ) - Set the whole
extent for the stencil (anything outside this extent will be considered to be "outside" the stencil). If this is not
set, then the stencil will always use the requested UpdateExtent as the stencil extent.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.105 vtkPointLoad
1687
obj.SetOutputWholeExtent (int a[6]) - Set the whole extent for the stencil (anything outside
this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the
requested UpdateExtent as the stencil extent.
int = obj. GetOutputWholeExtent () - Set the whole extent for the stencil (anything outside
this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the
requested UpdateExtent as the stencil extent.
obj.SetThreshold (double ) - Set the threshold value for the implicit function.
double = obj.GetThreshold () - Set the threshold value for the implicit function.
36.105
vtkPointLoad
36.105.1
Usage
vtkPointLoad is a source object that computes stress tensors on a volume. The tensors are computed from the
application of a point load on a semi-infinite domain. (The analytical results are adapted from Saada - see text.) It
also is possible to compute effective stress scalars if desired. This object serves as a specialized data generator for
some of the examples in the text.
To create an instance of class vtkPointLoad, simply invoke its constructor as follows
obj = vtkPointLoad
36.105.2
Methods
The class vtkPointLoad has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPointLoad class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPointLoad = obj.NewInstance ()
vtkPointLoad = obj.SafeDownCast (vtkObject o)
obj.SetLoadValue (double ) - Set/Get value of applied load.
double = obj.GetLoadValue () - Set/Get value of applied load.
obj.SetSampleDimensions (int i, int j, int k) - Specify the dimensions of the volume.
A stress tensor will be computed for each point in the volume.
obj.SetSampleDimensions (int dim[3]) - Specify the dimensions of the volume. A stress tensor will be computed for each point in the volume.
int = obj. GetSampleDimensions () - Specify the dimensions of the volume. A stress tensor
will be computed for each point in the volume.
obj.SetModelBounds (double , double , double , double , double , double
) - Specify the region in space over which the tensors are computed. The point load is assumed to be applied
at top center of the volume.
obj.SetModelBounds (double a[6]) - Specify the region in space over which the tensors are
computed. The point load is assumed to be applied at top center of the volume.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1688
double = obj. GetModelBounds () - Specify the region in space over which the tensors are
computed. The point load is assumed to be applied at top center of the volume.
obj.SetPoissonsRatio (double ) - Set/Get Poissons ratio.
double = obj.GetPoissonsRatio () - Set/Get Poissons ratio.
obj.SetComputeEffectiveStress (int ) - Turn on/off computation of effective stress scalar.
These methods do nothing. The effective stress is always computed.
int = obj.GetComputeEffectiveStress () - Turn on/off computation of effective stress scalar.
These methods do nothing. The effective stress is always computed.
obj.ComputeEffectiveStressOn () - Turn on/off computation of effective stress scalar. These
methods do nothing. The effective stress is always computed.
obj.ComputeEffectiveStressOff () - Turn on/off computation of effective stress scalar. These
methods do nothing. The effective stress is always computed.
36.106
vtkRTAnalyticSource
36.106.1
Usage
vtkRTAnalyticSource just produces images with pixel values determined by a MaximumGaussianXMagsin(XFreqx)sin(YFreqy)cos(ZFreqz) Values are float scalars on point data with name "RTData".
To create an instance of class vtkRTAnalyticSource, simply invoke its constructor as follows
obj = vtkRTAnalyticSource
36.106.2
Methods
The class vtkRTAnalyticSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRTAnalyticSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRTAnalyticSource = obj.NewInstance ()
vtkRTAnalyticSource = obj.SafeDownCast (vtkObject o)
obj.SetWholeExtent (int xMinx, int xMax, int yMin, int yMax, int zMin,
int zMax) - Set/Get the extent of the whole output image. Initial value is {-10,10,-10,10,-10,10}
int = obj. GetWholeExtent () - Set/Get the extent of the whole output image. Initial value is
{-10,10,-10,10,-10,10}
obj.SetCenter (double , double , double ) - Set/Get the center of function. Initial value is
{0.0,0.0,0.0}
obj.SetCenter (double a[3]) - Set/Get the center of function. Initial value is {0.0,0.0,0.0}
double = obj.
obj.SetMaximum (double ) - Set/Get the Maximum value of the function. Initial value is 255.0.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.107 vtkSampleFunction
1689
double = obj.GetMaximum () - Set/Get the Maximum value of the function. Initial value is 255.0.
obj.SetStandardDeviation (double ) - Set/Get the standard deviation of the function. Initial
value is 0.5.
double = obj.GetStandardDeviation () - Set/Get the standard deviation of the function. Initial
value is 0.5.
obj.SetXFreq (double ) - Set/Get the natural frequency in x. Initial value is 60.
double = obj.GetXFreq () - Set/Get the natural frequency in x. Initial value is 60.
obj.SetYFreq (double ) - Set/Get the natural frequency in y. Initial value is 30.
double = obj.GetYFreq () - Set/Get the natural frequency in y. Initial value is 30.
obj.SetZFreq (double ) - Set/Get the natural frequency in z. Initial value is 40.
double = obj.GetZFreq () - Set/Get the natural frequency in z. Initial value is 40.
obj.SetXMag (double ) - Set/Get the magnitude in x. Initial value is 10.
double = obj.GetXMag () - Set/Get the magnitude in x. Initial value is 10.
obj.SetYMag (double ) - Set/Get the magnitude in y. Initial value is 18.
double = obj.GetYMag () - Set/Get the magnitude in y. Initial value is 18.
obj.SetZMag (double ) - Set/Get the magnitude in z. Initial value is 5.
double = obj.GetZMag () - Set/Get the magnitude in z. Initial value is 5.
obj.SetSubsampleRate (int ) - Set/Get the sub-sample rate. Initial value is 1.
int = obj.GetSubsampleRate () - Set/Get the sub-sample rate. Initial value is 1.
36.107
vtkSampleFunction
36.107.1
Usage
vtkSampleFunction is a source object that evaluates an implicit function and normals at each point in a vtkStructuredPoints. The user can specify the sample dimensions and location in space to perform the sampling.
To create closed surfaces (in conjunction with the vtkContourFilter), capping can be turned on to set a particular
value on the boundaries of the sample space.
To create an instance of class vtkSampleFunction, simply invoke its constructor as follows
obj = vtkSampleFunction
36.107.2
Methods
The class vtkSampleFunction has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkSampleFunction class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSampleFunction = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1690
36.108 vtkShepardMethod
1691
obj.CappingOff () - Turn on/off capping. If capping is on, then the outer boundaries of the structured
point set are set to cap value. This can be used to insure surfaces are closed.
obj.SetCapValue (double ) - Set the cap value.
double = obj.GetCapValue () - Set the cap value.
obj.SetComputeNormals (int ) - Turn on/off the computation of normals (normals are float values).
int = obj.GetComputeNormals () - Turn on/off the computation of normals (normals are float values).
obj.ComputeNormalsOn () - Turn on/off the computation of normals (normals are float values).
obj.ComputeNormalsOff () - Turn on/off the computation of normals (normals are float values).
obj.SetScalarArrayName (string ) - Set/get the scalar array name for this data set. Initial value
is "scalars".
string = obj.GetScalarArrayName () - Set/get the scalar array name for this data set. Initial
value is "scalars".
obj.SetNormalArrayName (string ) - Set/get the normal array name for this data set. Initial value
is "normals".
string = obj.GetNormalArrayName () - Set/get the normal array name for this data set. Initial
value is "normals".
long = obj.GetMTime () - Return the MTime also considering the implicit function.
36.108
vtkShepardMethod
36.108.1
Usage
vtkShepardMethod is a filter used to visualize unstructured point data using Shepards method. The method works
by resampling the unstructured points onto a structured points set. The influence functions are described as "inverse distance weighted". Once the structured points are computed, the usual visualization techniques (e.g., isocontouring or volume rendering) can be used visualize the structured points.
To create an instance of class vtkShepardMethod, simply invoke its constructor as follows
obj = vtkShepardMethod
36.108.2
Methods
The class vtkShepardMethod has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkShepardMethod class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkShepardMethod = obj.NewInstance ()
vtkShepardMethod = obj.SafeDownCast (vtkObject o)
double = obj.ComputeModelBounds (double origin[3], double ar[3]) - Compute
ModelBounds from input geometry.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1692
int = obj.
points.
obj.SetNullValue (double ) - Set the Null value for output points not receiving a contribution from
the input points.
double = obj.GetNullValue () - Set the Null value for output points not receiving a contribution
from the input points.
36.109
vtkSimpleImageFilterExample
36.109.1
Usage
This is an example of a simple image-image filter. It copies its input to its output (point by point). It shows how
templates can be used to support various data types. .SECTION See also vtkSimpleImageToImageFilter
To create an instance of class vtkSimpleImageFilterExample, simply invoke its constructor as follows
obj = vtkSimpleImageFilterExample
36.110 vtkSurfaceReconstructionFilter
36.109.2
1693
Methods
The class vtkSimpleImageFilterExample has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSimpleImageFilterExample class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSimpleImageFilterExample = obj.NewInstance ()
vtkSimpleImageFilterExample = obj.SafeDownCast (vtkObject o)
36.110
vtkSurfaceReconstructionFilter
36.110.1
Usage
vtkSurfaceReconstructionFilter takes a list of points assumed to lie on the surface of a solid 3D object. A signed
measure of the distance to the surface is computed and sampled on a regular grid. The grid can then be contoured
at zero to extract the surface. The default values for neighborhood size and sample spacing should give reasonable
results for most uses but can be set if desired. This procedure is based on the PhD work of Hugues Hoppe:
http://www.research.microsoft.com/hoppe
To create an instance of class vtkSurfaceReconstructionFilter, simply invoke its constructor as follows
obj = vtkSurfaceReconstructionFilter
36.110.2
Methods
The class vtkSurfaceReconstructionFilter has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSurfaceReconstructionFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSurfaceReconstructionFilter = obj.NewInstance ()
vtkSurfaceReconstructionFilter = obj.SafeDownCast (vtkObject o)
int = obj.GetNeighborhoodSize () - Specify the number of neighbors each point has, used for
estimating the local surface orientation. The default value of 20 should be OK for most applications, higher
values can be specified if the spread of points is uneven. Values as low as 10 may yield adequate results for
some surfaces. Higher values cause the algorithm to take longer. Higher values will cause errors on sharp
boundaries.
obj.SetNeighborhoodSize (int ) - Specify the number of neighbors each point has, used for
estimating the local surface orientation. The default value of 20 should be OK for most applications, higher
values can be specified if the spread of points is uneven. Values as low as 10 may yield adequate results for
some surfaces. Higher values cause the algorithm to take longer. Higher values will cause errors on sharp
boundaries.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1694
double = obj.GetSampleSpacing () - Specify the spacing of the 3D sampling grid. If not set, a
reasonable guess will be made.
obj.SetSampleSpacing (double ) - Specify the spacing of the 3D sampling grid. If not set, a
reasonable guess will be made.
36.111
vtkTriangularTexture
36.111.1
Usage
vtkTriangularTexture is a filter that generates a 2D texture map based on the paper "Opacity-modulating Triangular
Textures for Irregular Surfaces," by Penny Rheingans, IEEE Visualization 96, pp. 219-225. The textures assume
texture coordinates of (0,0), (1.0) and (.5, sqrt(3)/2). The sequence of texture values is the same along each edge
of the triangular texture map. So, the assignment order of texture coordinates is arbitrary.
To create an instance of class vtkTriangularTexture, simply invoke its constructor as follows
obj = vtkTriangularTexture
36.111.2
Methods
The class vtkTriangularTexture has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTriangularTexture class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTriangularTexture = obj.NewInstance ()
vtkTriangularTexture = obj.SafeDownCast (vtkObject o)
obj.SetScaleFactor (double ) - Set a Scale Factor.
double = obj.GetScaleFactor () - Set a Scale Factor.
obj.SetXSize (int ) - Set the X texture map dimension. Default is 64.
int = obj.GetXSize () - Set the X texture map dimension. Default is 64.
obj.SetYSize (int ) - Set the Y texture map dimension. Default is 64.
int = obj.GetYSize () - Set the Y texture map dimension. Default is 64.
obj.SetTexturePattern (int ) - Set the texture pattern. 1 = opaque at centroid (default) 2 =
opaque at vertices 3 = opaque in rings around vertices
int = obj.GetTexturePatternMinValue () - Set the texture pattern. 1 = opaque at centroid
(default) 2 = opaque at vertices 3 = opaque in rings around vertices
int = obj.GetTexturePatternMaxValue () - Set the texture pattern. 1 = opaque at centroid
(default) 2 = opaque at vertices 3 = opaque in rings around vertices
int = obj.GetTexturePattern () - Set the texture pattern. 1 = opaque at centroid (default) 2 =
opaque at vertices 3 = opaque in rings around vertices
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.112 vtkVoxelModeller
36.112
1695
vtkVoxelModeller
36.112.1
Usage
vtkVoxelModeller is a filter that converts an arbitrary data set to a structured point (i.e., voxel) representation. It is
very similar to vtkImplicitModeller, except that it doesnt record distance; instead it records occupancy. By default
it supports a compact output of 0/1 VTK_BIT. Other vtk scalar types can be specified. The Foreground and Background values of the output can also be specified. NOTE: Not all vtk filters/readers/writers support the VTK_BIT
scalar type. You may want to use VTK_CHAR as an alternative.
To create an instance of class vtkVoxelModeller, simply invoke its constructor as follows
obj = vtkVoxelModeller
36.112.2
Methods
The class vtkVoxelModeller has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkVoxelModeller class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVoxelModeller = obj.NewInstance ()
vtkVoxelModeller = obj.SafeDownCast (vtkObject o)
double = obj.ComputeModelBounds (double origin[3], double ar[3]) - Compute
the ModelBounds based on the input geometry.
obj.SetSampleDimensions (int i, int j, int k) - Set the i-j-k dimensions on which to
sample the distance function. Default is (50, 50, 50)
obj.SetSampleDimensions (int dim[3]) - Set the i-j-k dimensions on which to sample the distance function. Default is (50, 50, 50)
int = obj. GetSampleDimensions () - Set the i-j-k dimensions on which to sample the distance
function. Default is (50, 50, 50)
obj.SetMaximumDistance (double ) - Specify distance away from surface of input geometry to
sample. Smaller values make large increases in performance. Default is 1.0.
double = obj.GetMaximumDistanceMinValue () - Specify distance away from surface of input
geometry to sample. Smaller values make large increases in performance. Default is 1.0.
double = obj.GetMaximumDistanceMaxValue () - Specify distance away from surface of input
geometry to sample. Smaller values make large increases in performance. Default is 1.0.
double = obj.GetMaximumDistance () - Specify distance away from surface of input geometry
to sample. Smaller values make large increases in performance. Default is 1.0.
obj.SetModelBounds (double bounds[6]) - Specify the position in space to perform the voxelization. Default is (0, 0, 0, 0, 0, 0)
obj.SetModelBounds (double xmin, double xmax, double ymin, double ymax,
double zmin, double zmax) - Specify the position in space to perform the voxelization. Default is
(0, 0, 0, 0, 0, 0)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1696
double = obj. GetModelBounds () - Specify the position in space to perform the voxelization.
Default is (0, 0, 0, 0, 0, 0)
obj.SetScalarType (int ) - Control the scalar type of the output image. The default is VTK_BIT.
NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as
an alternative.
obj.SetScalarTypeToFloat () - Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR
as an alternative.
obj.SetScalarTypeToDouble () - Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR
as an alternative.
obj.SetScalarTypeToInt () - Control the scalar type of the output image. The default is VTK_BIT.
NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as
an alternative.
obj.SetScalarTypeToUnsignedInt () - Control the scalar type of the output image. The default
is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use
VTK_CHAR as an alternative.
obj.SetScalarTypeToLong () - Control the scalar type of the output image. The default is VTK_BIT.
NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as
an alternative.
obj.SetScalarTypeToUnsignedLong () - Control the scalar type of the output image. The default
is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use
VTK_CHAR as an alternative.
obj.SetScalarTypeToShort () - Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR
as an alternative.
obj.SetScalarTypeToUnsignedShort () - Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use
VTK_CHAR as an alternative.
obj.SetScalarTypeToUnsignedChar () - Control the scalar type of the output image. The default
is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use
VTK_CHAR as an alternative.
obj.SetScalarTypeToChar () - Control the scalar type of the output image. The default is VTK_BIT.
NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as
an alternative.
obj.SetScalarTypeToBit () - Control the scalar type of the output image. The default is VTK_BIT.
NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as
an alternative.
int = obj.GetScalarType () - Control the scalar type of the output image. The default is VTK_BIT.
NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as
an alternative.
obj.SetForegroundValue (double ) - Set the Foreground/Background values of the output. The
Foreground value is set when a voxel is occupied. The Background value is set when a voxel is not occupied.
The default ForegroundValue is 1. The default BackgroundValue is 0.
double = obj.GetForegroundValue () - Set the Foreground/Background values of the output.
The Foreground value is set when a voxel is occupied. The Background value is set when a voxel is not
occupied. The default ForegroundValue is 1. The default BackgroundValue is 0.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
36.112 vtkVoxelModeller
1697
1698
Chapter 37
1700
vtkCosmicTreeLayoutStrategy
vtkDataObjectToTable
vtkDelimitedTextReader
vtkDescriptiveStatistics
vtkDotProductSimilarity
vtkEdgeCenters
vtkEdgeLayout
vtkEdgeLayoutStrategy
vtkExpandSelectedGraph
vtkExtractHistogram2D
vtkExtractSelectedGraph
vtkFast2DLayoutStrategy
vtkFixedWidthTextReader
vtkForceDirectedLayoutStrategy
vtkGenerateIndexArray
vtkGeoEdgeStrategy
vtkGeoMath
vtkGraphHierarchicalBundle
vtkGraphHierarchicalBundleEdges
vtkGraphLayout
vtkGraphLayoutStrategy
vtkGroupLeafVertices
vtkISIReader
vtkKMeansDistanceFunctor
vtkKMeansDistanceFunctorCalculator
vtkKMeansStatistics
vtkMatricizeArray
vtkMergeColumns
vtkMergeGraphs
vtkMergeTables
vtkMultiCorrelativeStatistics
vtkMutableGraphHelper
vtkNetworkHierarchy
vtkOrderStatistics
vtkPairwiseExtractHistogram2D
vtkPassArrays
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1701
vtkPassThrough
vtkPassThroughEdgeStrategy
vtkPassThroughLayoutStrategy
vtkPBivariateLinearTableThreshold
vtkPCAStatistics
vtkPComputeHistogram2DOutliers
vtkPContingencyStatistics
vtkPCorrelativeStatistics
vtkPDescriptiveStatistics
vtkPerturbCoincidentVertices
vtkPExtractHistogram2D
vtkPKMeansStatistics
vtkPMultiCorrelativeStatistics
vtkPPairwiseExtractHistogram2D
vtkPPCAStatistics
vtkPruneTreeFilter
vtkRandomGraphSource
vtkRandomLayoutStrategy
vtkRemoveHiddenData
vtkRemoveIsolatedVertices
vtkRISReader
vtkSCurveSpline
vtkSimple2DLayoutStrategy
vtkSimple3DCirclesStrategy
vtkSliceAndDiceLayoutStrategy
vtkSpanTreeLayoutStrategy
vtkSparseArrayToTable
vtkSplineGraphEdges
vtkSplitColumnComponents
vtkSQLDatabaseGraphSource
vtkSQLDatabaseTableSource
vtkSQLGraphReader
vtkSquarifyLayoutStrategy
vtkStackedTreeLayoutStrategy
vtkStatisticsAlgorithm
vtkStrahlerMetric
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1702
vtkStreamGraph
vtkStringToCategory
vtkStringToNumeric
vtkStringToTimePoint
vtkTableToArray
vtkTableToGraph
vtkTableToSparseArray
vtkTableToTreeFilter
vtkThresholdTable
vtkTimePointToString
vtkTransferAttributes
vtkTreeFieldAggregator
vtkTreeLayoutStrategy
vtkTreeLevelsFilter
vtkTreeMapLayout
vtkTreeMapLayoutStrategy
vtkTreeMapToPolyData
vtkTreeOrbitLayoutStrategy
vtkTreeRingToPolyData
vtkTulipReader
vtkUnivariateStatisticsAlgorithm
vtkVertexDegree
vtkXMLTreeReader
37.1
vtkAddMembershipArray
37.1.1
Usage
This filter takes an input selection, vtkDataSetAttribute information, and data object and adds a bit array to the output
vtkDataSetAttributes indicating whether each index was selected or not.
To create an instance of class vtkAddMembershipArray, simply invoke its constructor as follows
obj = vtkAddMembershipArray
37.2 vtkAdjacencyMatrixToEdgeTable
37.1.2
1703
Methods
The class vtkAddMembershipArray has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAddMembershipArray
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAddMembershipArray = obj.NewInstance ()
vtkAddMembershipArray = obj.SafeDownCast (vtkObject o)
int = obj.GetFieldType () - The field type to add the membership array to.
obj.SetFieldType (int ) - The field type to add the membership array to.
int = obj.GetFieldTypeMinValue () - The field type to add the membership array to.
int = obj.GetFieldTypeMaxValue () - The field type to add the membership array to.
obj.SetOutputArrayName (string ) - The name of the array added to the output vtkDataSetAttributes indicating membership. Defaults to "membership".
string = obj.GetOutputArrayName () - The name of the array added to the output vtkDataSetAttributes indicating membership. Defaults to "membership".
obj.SetInputArrayName (string )
string = obj.GetInputArrayName ()
obj.SetInputValues (vtkAbstractArray )
vtkAbstractArray = obj.GetInputValues ()
37.2
vtkAdjacencyMatrixToEdgeTable
37.2.1
Usage
Treats a dense 2-way array of doubles as an adacency matrix and converts it into a vtkTable suitable for use as an
edge table with vtkTableToGraph.
To create an instance of class vtkAdjacencyMatrixToEdgeTable, simply invoke its constructor as follows
obj = vtkAdjacencyMatrixToEdgeTable
37.2.2
Methods
The class vtkAdjacencyMatrixToEdgeTable has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAdjacencyMatrixToEdgeTable class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1704
vtkAdjacencyMatrixToEdgeTable = obj.NewInstance ()
vtkAdjacencyMatrixToEdgeTable = obj.SafeDownCast (vtkObject o)
vtkIdType = obj.GetSourceDimension () - Specifies whether rows or columns become the
"source" in the output edge table. 0 = rows, 1 = columns. Default: 0
obj.SetSourceDimension (vtkIdType ) - Specifies whether rows or columns become the
"source" in the output edge table. 0 = rows, 1 = columns. Default: 0
string = obj.GetValueArrayName () - Controls the name of the output table column that contains edge weights. Default: "value"
obj.SetValueArrayName (string ) - Controls the name of the output table column that contains
edge weights. Default: "value"
vtkIdType = obj.GetMinimumCount () - Specifies the minimum number of adjacent edges to
include for each source vertex. Default: 0
obj.SetMinimumCount (vtkIdType ) - Specifies the minimum number of adjacent edges to include for each source vertex. Default: 0
double = obj.GetMinimumThreshold () - Specifies a minimum threshold that an edge weight
must exceed to be included in the output. Default: 0.5
obj.SetMinimumThreshold (double ) - Specifies a minimum threshold that an edge weight must
exceed to be included in the output. Default: 0.5
37.3
vtkAppendPoints
37.3.1
Usage
vtkAppendPoints is a filter that appends the points and assoicated data of one or more polygonal (vtkPolyData)
datasets. This filter can optionally add a new array marking the input index that the point came from.
To create an instance of class vtkAppendPoints, simply invoke its constructor as follows
obj = vtkAppendPoints
37.3.2
Methods
The class vtkAppendPoints has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkAppendPoints class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAppendPoints = obj.NewInstance ()
vtkAppendPoints = obj.SafeDownCast (vtkObject o)
obj.SetInputIdArrayName (string ) - Sets the output array name to fill with the input connection
index for each point. This provides a way to trace a point back to a particular input. If this is NULL (the default),
the array is not generated.
string = obj.GetInputIdArrayName () - Sets the output array name to fill with the input connection index for each point. This provides a way to trace a point back to a particular input. If this is NULL
(the default), the array is not generated.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.4 vtkApplyColors
37.4
1705
vtkApplyColors
37.4.1
Usage
vtkApplyColors performs a coloring of the dataset using default colors, lookup tables, annotations, and/or a selection. The output is a four-component vtkUnsignedCharArray containing RGBA tuples for each element in the
dataset. The first input is the dataset to be colored, which may be a vtkTable, vtkGraph subclass, or vtkDataSet
subclass. The API of this algorithm refers to "points" and "cells". For vtkGraph, the "points" refer to the graph
vertices and "cells" refer to graph edges. For vtkTable, "points" refer to table rows. For vtkDataSet subclasses, the
meaning is obvious.
The second (optional) input is a vtkAnnotationLayers object, which stores a list of annotation layers, with each
layer holding a list of vtkAnnotation objects. The annotation specifies a subset of data along with other properties,
including color. For annotations with color properties, this algorithm will use the color to color elements, using a "top
one wins" strategy.
The third (optional) input is a vtkSelection object, meant for specifying the current selection. You can control the
color of the selection.
The algorithm takes two input arrays, specified with SetInputArrayToProcess(0, 0, 0, vtkDataObject::FIELD_ASSOCIATION_POINTS, name) and SetInputArrayToProcess(1, 0, 0, vtkDataObject::FIELD_ASSOCIATION_CELLS,
name). These set the point and cell data arrays to use to color the data with the associated lookup table. For
vtkGraph, vtkTable inputs, you would use FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, or
FIELD_ASSOCIATION_ROWS as appropriate.
To use the color array generated here, you should do the following:
mapper->SetScalarModeToUseCellFieldData();
>SetScalarVisibility(true);
mapper->SelectColorArray("vtkApplyColors color");
mapper-
37.4.2
Methods
The class vtkApplyColors has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkApplyColors class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1706
vtkApplyColors = obj.NewInstance ()
vtkApplyColors = obj.SafeDownCast (vtkObject o)
obj.SetPointLookupTable (vtkScalarsToColors lut) - The lookup table to use for point
colors. This is only used if input array 0 is set and UsePointLookupTable is on.
vtkScalarsToColors = obj.GetPointLookupTable () - The lookup table to use for point colors. This is only used if input array 0 is set and UsePointLookupTable is on.
obj.SetUsePointLookupTable (bool ) - If on, uses the point lookup table to set the colors of
unannotated, unselected elements of the data.
bool = obj.GetUsePointLookupTable () - If on, uses the point lookup table to set the colors of
unannotated, unselected elements of the data.
obj.UsePointLookupTableOn () - If on, uses the point lookup table to set the colors of unannotated,
unselected elements of the data.
obj.UsePointLookupTableOff () - If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data.
obj.SetScalePointLookupTable (bool ) - If on, uses the range of the data to scale the lookup
table range. Otherwise, uses the range defined in the lookup table.
bool = obj.GetScalePointLookupTable () - If on, uses the range of the data to scale the
lookup table range. Otherwise, uses the range defined in the lookup table.
obj.ScalePointLookupTableOn () - If on, uses the range of the data to scale the lookup table
range. Otherwise, uses the range defined in the lookup table.
obj.ScalePointLookupTableOff () - If on, uses the range of the data to scale the lookup table
range. Otherwise, uses the range defined in the lookup table.
obj.SetDefaultPointColor (double , double , double ) - The default point color for all
unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.
obj.SetDefaultPointColor (double a[3]) - The default point color for all unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.
double = obj. GetDefaultPointColor () - The default point color for all unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.
obj.SetDefaultPointOpacity (double ) - The default point opacity for all unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.
double = obj.GetDefaultPointOpacity () - The default point opacity for all unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.
obj.SetSelectedPointColor (double , double , double ) - The point color for all selected elements of the data. This is used if the selection input is available.
obj.SetSelectedPointColor (double a[3]) - The point color for all selected elements of the
data. This is used if the selection input is available.
double = obj. GetSelectedPointColor () - The point color for all selected elements of the
data. This is used if the selection input is available.
obj.SetSelectedPointOpacity (double ) - The point opacity for all selected elements of the
data. This is used if the selection input is available.
double = obj.GetSelectedPointOpacity () - The point opacity for all selected elements of the
data. This is used if the selection input is available.
obj.SetPointColorOutputArrayName (string ) - The output array name for the point color
RGBA array. Default is "vtkApplyColors color".
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.4 vtkApplyColors
1707
string = obj.GetPointColorOutputArrayName () - The output array name for the point color
RGBA array. Default is "vtkApplyColors color".
obj.SetCellLookupTable (vtkScalarsToColors lut) - The lookup table to use for cell colors. This is only used if input array 1 is set and UseCellLookupTable is on.
vtkScalarsToColors = obj.GetCellLookupTable () - The lookup table to use for cell colors.
This is only used if input array 1 is set and UseCellLookupTable is on.
obj.SetUseCellLookupTable (bool ) - If on, uses the cell lookup table to set the colors of unannotated, unselected elements of the data.
bool = obj.GetUseCellLookupTable () - If on, uses the cell lookup table to set the colors of
unannotated, unselected elements of the data.
obj.UseCellLookupTableOn () - If on, uses the cell lookup table to set the colors of unannotated,
unselected elements of the data.
obj.UseCellLookupTableOff () - If on, uses the cell lookup table to set the colors of unannotated,
unselected elements of the data.
obj.SetScaleCellLookupTable (bool ) - If on, uses the range of the data to scale the lookup
table range. Otherwise, uses the range defined in the lookup table.
bool = obj.GetScaleCellLookupTable () - If on, uses the range of the data to scale the lookup
table range. Otherwise, uses the range defined in the lookup table.
obj.ScaleCellLookupTableOn () - If on, uses the range of the data to scale the lookup table range.
Otherwise, uses the range defined in the lookup table.
obj.ScaleCellLookupTableOff () - If on, uses the range of the data to scale the lookup table
range. Otherwise, uses the range defined in the lookup table.
obj.SetDefaultCellColor (double , double , double ) - The default cell color for all
unannotated, unselected elements of the data. This is used if UseCellLookupTable is off.
obj.SetDefaultCellColor (double a[3]) - The default cell color for all unannotated, unselected elements of the data. This is used if UseCellLookupTable is off.
double = obj. GetDefaultCellColor () - The default cell color for all unannotated, unselected elements of the data. This is used if UseCellLookupTable is off.
obj.SetDefaultCellOpacity (double ) - The default cell opacity for all unannotated, unselected
elements of the data. This is used if UseCellLookupTable is off.
double = obj.GetDefaultCellOpacity () - The default cell opacity for all unannotated, unselected elements of the data. This is used if UseCellLookupTable is off.
obj.SetSelectedCellColor (double , double , double ) - The cell color for all selected
elements of the data. This is used if the selection input is available.
obj.SetSelectedCellColor (double a[3]) - The cell color for all selected elements of the data.
This is used if the selection input is available.
double = obj. GetSelectedCellColor () - The cell color for all selected elements of the data.
This is used if the selection input is available.
obj.SetSelectedCellOpacity (double ) - The cell opacity for all selected elements of the data.
This is used if the selection input is available.
double = obj.GetSelectedCellOpacity () - The cell opacity for all selected elements of the
data. This is used if the selection input is available.
obj.SetCellColorOutputArrayName (string ) - The output array name for the cell color RGBA array. Default is "vtkApplyColors color".
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1708
string = obj.GetCellColorOutputArrayName () - The output array name for the cell color
RGBA array. Default is "vtkApplyColors color".
obj.SetUseCurrentAnnotationColor (bool ) - Use the annotation to color the current annotation (i.e. the current selection). Otherwise use the selection color attributes of this filter.
bool = obj.GetUseCurrentAnnotationColor () - Use the annotation to color the current annotation (i.e. the current selection). Otherwise use the selection color attributes of this filter.
obj.UseCurrentAnnotationColorOn () - Use the annotation to color the current annotation (i.e.
the current selection). Otherwise use the selection color attributes of this filter.
obj.UseCurrentAnnotationColorOff () - Use the annotation to color the current annotation (i.e.
the current selection). Otherwise use the selection color attributes of this filter.
37.5
vtkApplyIcons
37.5.1
Usage
vtkApplyIcons performs a iconing of the dataset using default icons, lookup tables, annotations, and/or a selection.
The output is a vtkIntArray containing the icon index for each element in the dataset. The first input is the dataset to
be iconed, which may be a vtkTable, vtkGraph subclass, or vtkDataSet subclass.
The second (optional) input is a vtkAnnotationLayers object, which stores a list of annotation layers, with each
layer holding a list of vtkAnnotation objects. The annotation specifies a subset of data along with other properties,
including icon. For annotations with icon properties, this algorithm will use the icon index of annotated elements,
using a "top one wins" strategy.
The third (optional) input is a vtkSelection object, meant for specifying the current selection. You can control the
icon of the selection, or whether there is a set of selected icons at a particular offset in the icon sheet.
The algorithm takes an input array, specified with SetInputArrayToProcess(0, 0, 0, vtkDataObject::FIELD_ASSOCIATION_POINTS, name) This sets data arrays to use to icon the data with the associated lookup table. For vtkGraph
and vtkTable inputs, you would use FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, or FIELD_ASSOCIATION_ROWS as appropriate. The icon array will be added to the same set of attributes that the
input array came from. If there is no input array, the icon array will be applied to the attributes associated with the
AttributeType parameter.
Icons are assigned with the following priorities:
1. If an item is part of the selection, it is glyphed with that icon.
2. Otherwise, if the item is part of an annotation, it is glyphed with the icon of the final (top) annotation in the set
of layers.
3. Otherwise, if a lookup table is used, it is glyphed using the lookup table icon for the data value of the element.
4. Otherwise it will be glyphed with the default icon.
To create an instance of class vtkApplyIcons, simply invoke its constructor as follows
obj = vtkApplyIcons
37.5.2
Methods
The class vtkApplyIcons has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkApplyIcons class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.5 vtkApplyIcons
1709
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkApplyIcons = obj.NewInstance ()
vtkApplyIcons = obj.SafeDownCast (vtkObject o)
obj.SetIconType (double v, int icon) - Edits the lookup table to use for point icons. This is
only used if input array 0 is set and UsePointLookupTable is on.
obj.SetIconType (string v, int icon) - Edits the lookup table to use for point icons. This is
only used if input array 0 is set and UsePointLookupTable is on.
obj.ClearAllIconTypes () - Edits the lookup table to use for point icons. This is only used if input
array 0 is set and UsePointLookupTable is on.
obj.SetUseLookupTable (bool ) - If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data.
bool = obj.GetUseLookupTable () - If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data.
obj.UseLookupTableOn () - If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data.
obj.UseLookupTableOff () - If on, uses the point lookup table to set the colors of unannotated,
unselected elements of the data.
obj.SetDefaultIcon (int ) - The default point icon for all unannotated, unselected elements of the
data. This is used if UsePointLookupTable is off.
int = obj.GetDefaultIcon () - The default point icon for all unannotated, unselected elements of
the data. This is used if UsePointLookupTable is off.
obj.SetSelectedIcon (int ) - The point icon for all selected elements of the data. This is used if
the annotation input has a current selection.
int = obj.GetSelectedIcon () - The point icon for all selected elements of the data. This is used
if the annotation input has a current selection.
obj.SetIconOutputArrayName (string ) - The output array name for the point icon index array.
Default is "vtkApplyIcons icon".
string = obj.GetIconOutputArrayName () - The output array name for the point icon index
array. Default is "vtkApplyIcons icon".
obj.SetSelectionMode (int ) - Changes the behavior of the icon to use for selected items.
SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
IGNORE_SELECTION does not change the icon based on the current selection.
The default is IGNORE_SELECTION.
int = obj.GetSelectionMode () - Changes the behavior of the icon to use for selected items.
SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
IGNORE_SELECTION does not change the icon based on the current selection.
The default is IGNORE_SELECTION.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1710
obj.SetSelectionModeToSelectedIcon () - Changes the behavior of the icon to use for selected items.
SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
IGNORE_SELECTION does not change the icon based on the current selection.
The default is IGNORE_SELECTION.
obj.SetSelectionModeToSelectedOffset () - Changes the behavior of the icon to use for selected items.
SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
IGNORE_SELECTION does not change the icon based on the current selection.
The default is IGNORE_SELECTION.
obj.SetSelectionModeToAnnotationIcon () - Changes the behavior of the icon to use for selected items.
SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
IGNORE_SELECTION does not change the icon based on the current selection.
The default is IGNORE_SELECTION.
obj.SetSelectionModeToIgnoreSelection () - The attribute type to append the icon array to,
used only if the input array is not specified or does not exist. This is set to one of the AttributeTypes enum in
vtkDataObject (e.g. POINT, CELL, VERTEX EDGE, FIELD).
obj.SetAttributeType (int ) - The attribute type to append the icon array to, used only if the input
array is not specified or does not exist. This is set to one of the AttributeTypes enum in vtkDataObject (e.g.
POINT, CELL, VERTEX EDGE, FIELD).
int = obj.GetAttributeType () - The attribute type to append the icon array to, used only if the
input array is not specified or does not exist. This is set to one of the AttributeTypes enum in vtkDataObject
(e.g. POINT, CELL, VERTEX EDGE, FIELD).
37.6
vtkArcParallelEdgeStrategy
37.6.1
Usage
Parallel edges are drawn as arcs, and self-loops are drawn as ovals. When only one edge connects two vertices it
is drawn as a straight line.
To create an instance of class vtkArcParallelEdgeStrategy, simply invoke its constructor as follows
obj = vtkArcParallelEdgeStrategy
37.7 vtkAreaLayout
37.6.2
1711
Methods
The class vtkArcParallelEdgeStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkArcParallelEdgeStrategy
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkArcParallelEdgeStrategy = obj.NewInstance ()
vtkArcParallelEdgeStrategy = obj.SafeDownCast (vtkObject o)
obj.Layout () - This is the layout method where the graph that was set in SetGraph() is laid out.
int = obj.GetNumberOfSubdivisions () - Get/Set the number of subdivisions on each edge.
obj.SetNumberOfSubdivisions (int ) - Get/Set the number of subdivisions on each edge.
37.7
vtkAreaLayout
37.7.1
Usage
vtkAreaLayout assigns sector regions to each vertex in the tree, creating a tree ring. The data is added as a data
array with four components per tuple representing the location and size of the sector using the format (StartAngle,
EndAngle, innerRadius, outerRadius).
This algorithm relies on a helper class to perform the actual layout. This helper class is a subclass of vtkAreaLayoutStrategy.
.SECTION Thanks Thanks to Jason Shepherd from Sandia National Laboratories for help developing this class.
To create an instance of class vtkAreaLayout, simply invoke its constructor as follows
obj = vtkAreaLayout
37.7.2
Methods
The class vtkAreaLayout has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkAreaLayout class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAreaLayout = obj.NewInstance ()
vtkAreaLayout = obj.SafeDownCast (vtkObject o)
obj.SetSizeArrayName (string name) - The name for the array created for the area for each
vertex. The rectangles are stored in a quadruple float array (startAngle, endAngle, innerRadius, outerRadius).
For rectangular layouts, this is (minx, maxx, miny, maxy).
string = obj.GetAreaArrayName () - The name for the array created for the area for each vertex.
The rectangles are stored in a quadruple float array (startAngle, endAngle, innerRadius, outerRadius). For
rectangular layouts, this is (minx, maxx, miny, maxy).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1712
obj.SetAreaArrayName (string ) - The name for the array created for the area for each vertex.
The rectangles are stored in a quadruple float array (startAngle, endAngle, innerRadius, outerRadius). For
rectangular layouts, this is (minx, maxx, miny, maxy).
bool = obj.GetEdgeRoutingPoints () - Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.
obj.SetEdgeRoutingPoints (bool ) - Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.
obj.EdgeRoutingPointsOn () - Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.
obj.EdgeRoutingPointsOff () - Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.
vtkAreaLayoutStrategy = obj.GetLayoutStrategy () - The strategy to use when laying
out the tree map.
obj.SetLayoutStrategy (vtkAreaLayoutStrategy strategy) - The strategy to use when
laying out the tree map.
long = obj.GetMTime () - Get the modification time of the layout algorithm.
vtkIdType = obj.FindVertex (float pnt[2]) - Get the vertex whose area contains the point,
or return -1 if no vertex area covers the point.
obj.GetBoundingArea (vtkIdType id, float sinfo) - The bounding area information for
a certain vertex id.
37.8
vtkAreaLayoutStrategy
37.8.1
Usage
All subclasses of this class perform a area layout on a tree. This involves assigning a region to each vertex in
the tree, and placing that information in a data array with four components per tuple representing (innerRadius,
outerRadius, startAngle, endAngle).
Instances of subclasses of this class may be assigned as the layout strategy to vtkAreaLayout
.SECTION Thanks Thanks to Jason Shepherd from Sandia National Laboratories for help developing this class.
To create an instance of class vtkAreaLayoutStrategy, simply invoke its constructor as follows
obj = vtkAreaLayoutStrategy
37.8.2
Methods
The class vtkAreaLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAreaLayoutStrategy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAreaLayoutStrategy = obj.NewInstance ()
vtkAreaLayoutStrategy = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.9 vtkArrayNorm
1713
37.9
vtkArrayNorm
37.9.1
Usage
Given an input matrix (vtkTypedArray<double>), computes the L-norm for each vector along either dimension,
storing the results in a dense output vector (1D vtkDenseArray<double>). The caller may optionally request the
inverse norm as output (useful for subsequent normalization), and may limit the computation to a "window" of vector
elements, to avoid data copying.
.SECTION Thanks Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.
To create an instance of class vtkArrayNorm, simply invoke its constructor as follows
obj = vtkArrayNorm
37.9.2
Methods
The class vtkArrayNorm has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkArrayNorm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkArrayNorm = obj.NewInstance ()
vtkArrayNorm = obj.SafeDownCast (vtkObject o)
int = obj.GetDimension () - Controls the dimension along which norms will be computed. For
input matrices, For input matrices, use "0" (rows) or "1" (columns). Default: 0
obj.SetDimension (int ) - Controls the dimension along which norms will be computed. For input
matrices, For input matrices, use "0" (rows) or "1" (columns). Default: 0
int = obj.GetL () - Controls the L-value. Default: 2
obj.SetL (int value) - Controls the L-value. Default: 2
obj.SetInvert (int ) - Controls whether to invert output values. Default: false
int = obj.GetInvert () - Controls whether to invert output values. Default: false
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1714
37.10
vtkAssignCoordinates
37.10.1
Usage
Given two(or three) arrays take the values in those arrays and simply assign them to the coordinates of the vertices.
Yes you could do this with the array calculator, but your mom wears army boots so were not going to.
To create an instance of class vtkAssignCoordinates, simply invoke its constructor as follows
obj = vtkAssignCoordinates
37.10.2
Methods
The class vtkAssignCoordinates has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAssignCoordinates class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAssignCoordinates = obj.NewInstance ()
vtkAssignCoordinates = obj.SafeDownCast (vtkObject o)
obj.SetXCoordArrayName (string ) - Set the x coordinate array name.
string = obj.GetXCoordArrayName () - Set the x coordinate array name.
obj.SetYCoordArrayName (string ) - Set the y coordinate array name.
string = obj.GetYCoordArrayName () - Set the y coordinate array name.
obj.SetZCoordArrayName (string ) - Set the z coordinate array name.
string = obj.GetZCoordArrayName () - Set the z coordinate array name.
obj.SetJitter (bool ) - Set if you want a random jitter
37.11
vtkAssignCoordinatesLayoutStrategy
37.11.1
Usage
37.12 vtkAttributeClustering2DLayoutStrategy
37.11.2
1715
Methods
The class vtkAssignCoordinatesLayoutStrategy has several methods that can be used. They are listed below.
Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAssignCoordinatesLayoutStrategy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAssignCoordinatesLayoutStrategy = obj.NewInstance ()
vtkAssignCoordinatesLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.SetXCoordArrayName (string name) - The array to use for the x coordinate values.
string = obj.GetXCoordArrayName () - The array to use for the x coordinate values.
obj.SetYCoordArrayName (string name) - The array to use for the y coordinate values.
string = obj.GetYCoordArrayName () - The array to use for the y coordinate values.
obj.SetZCoordArrayName (string name) - The array to use for the z coordinate values.
string = obj.GetZCoordArrayName () - The array to use for the z coordinate values.
obj.Layout () - Perform the random layout.
37.12
vtkAttributeClustering2DLayoutStrategy
37.12.1
Usage
This class is a density grid based force directed layout strategy. Also please note that fast is relative to quite slow.
:) The layout running time is O(V+E) with an extremely high constant. .SECTION Thanks Thanks to Godzilla for not
eating my computer so that this class could be written.
To create an instance of class vtkAttributeClustering2DLayoutStrategy, simply invoke its constructor as follows
obj = vtkAttributeClustering2DLayoutStrategy
37.12.2
Methods
The class vtkAttributeClustering2DLayoutStrategy has several methods that can be used. They are listed below.
Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAttributeClustering2DLayoutStrategy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAttributeClustering2DLayoutStrategy = obj.NewInstance ()
vtkAttributeClustering2DLayoutStrategy = obj.SafeDownCast (vtkObject o)
string = obj.GetVertexAttribute () - The name of the array on the vertices, whose values
will be used for determining clusters.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1716
obj.SetVertexAttribute (string ) - The name of the array on the vertices, whose values will
be used for determining clusters.
obj.SetRandomSeed (int ) - Seed the random number generator used to jitter point positions. This
has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMinValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMaxValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeed () - Seed the random number generator used to jitter point positions.
This has a significant effect on their final positions when the layout is complete.
obj.SetMaxNumberOfIterations (int ) - Set/Get the maximum number of iterations to be used.
The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph
gets modified. The default is 100 for no particular reason Note: The strong recommendation is that you do
not change this parameter. :)
int = obj.GetMaxNumberOfIterationsMinValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified. The default is 100 for no particular reason Note: The strong recommendation
is that you do not change this parameter. :)
int = obj.GetMaxNumberOfIterationsMaxValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified. The default is 100 for no particular reason Note: The strong recommendation
is that you do not change this parameter. :)
int = obj.GetMaxNumberOfIterations () - Set/Get the maximum number of iterations to be
used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the
graph gets modified. The default is 100 for no particular reason Note: The strong recommendation is that
you do not change this parameter. :)
obj.SetIterationsPerLayout (int ) - Set/Get the number of iterations per layout. The only use
for this ivar is for the application to do visualizations of the layout before its complete. The default is 100 to
match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayoutMinValue () - Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before its complete. The
default is 100 to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayoutMaxValue () - Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before its complete. The
default is 100 to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayout () - Set/Get the number of iterations per layout. The only
use for this ivar is for the application to do visualizations of the layout before its complete. The default is 100
to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
obj.SetInitialTemperature (float ) - Set the initial temperature. The temperature default is
5 for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
float = obj.GetInitialTemperatureMinValue () - Set the initial temperature. The temperature default is 5 for no particular reason Note: The strong recommendation is that you do not change this
parameter. :)
float = obj.GetInitialTemperatureMaxValue () - Set the initial temperature. The temperature default is 5 for no particular reason Note: The strong recommendation is that you do not change this
parameter. :)
float = obj.GetInitialTemperature () - Set the initial temperature. The temperature default
is 5 for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.13 vtkBivariateLinearTableThreshold
1717
obj.SetCoolDownRate (double ) - Set/Get the Cool-down rate. The higher this number is, the
longer it will take to "cool-down", and thus, the more the graph will be modified. The default is 10 for no
particular reason. Note: The strong recommendation is that you do not change this parameter. :)
double = obj.GetCoolDownRateMinValue () - Set/Get the Cool-down rate. The higher this
number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is
10 for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)
double = obj.GetCoolDownRateMaxValue () - Set/Get the Cool-down rate. The higher this
number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is
10 for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)
double = obj.GetCoolDownRate () - Set/Get the Cool-down rate. The higher this number is, the
longer it will take to "cool-down", and thus, the more the graph will be modified. The default is 10 for no
particular reason. Note: The strong recommendation is that you do not change this parameter. :)
obj.SetRestDistance (float ) - Manually set the resting distance. Otherwise the distance is
computed automatically.
float = obj.GetRestDistance () - Manually set the resting distance. Otherwise the distance is
computed automatically.
obj.Initialize () - This strategy sets up some data structures for faster processing of each Layout()
call
obj.Layout () - This is the layout method where the graph that was set in SetGraph() is laid out. The
method can either entirely layout the graph or iteratively lay out the graph. If you have an iterative layout
please implement the IsLayoutComplete() method.
int = obj.IsLayoutComplete ()
37.13
vtkBivariateLinearTableThreshold
37.13.1
Usage
Class for filtering the rows of a two numeric columns of a vtkTable. The columns are treated as the two variables of
a line. This filter will then iterate through the rows of the table determining if X,Y values pairs are above/below/between/near one or more lines.
The "between" mode checks to see if a row is contained within the convex hull of all of the specified lines. The
"near" mode checks if a row is within a distance threshold two one of the specified lines. This class is used in
conjunction with various plotting classes, so it is useful to rescale the X,Y axes to a particular range of values.
Distance comparisons can be performed in the scaled space by setting the CustomRanges ivar and enabling UseNormalizedDistance.
To create an instance of class vtkBivariateLinearTableThreshold, simply invoke its constructor as follows
obj = vtkBivariateLinearTableThreshold
37.13.2
Methods
The class vtkBivariateLinearTableThreshold has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkBivariateLinearTableThreshold class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1718
37.14 vtkBivariateStatisticsAlgorithm
1719
double = obj. GetColumnRanges () - Manually access the maximum/minimum x,y values. This
is used in conjunction with UseNormalizedDistance when determining if a row passes the threshold.
obj.SetDistanceThreshold (double ) - The Cartesian distance within which a point will pass
the near threshold.
double = obj.GetDistanceThreshold () - The Cartesian distance within which a point will pass
the near threshold.
obj.SetUseNormalizedDistance (int ) - Renormalize the space of the data such that the X
and Y axes are "square" over the specified ColumnRanges. This essentially scales the data space so that
ColumnRanges[1]-ColumnRanges[0] = 1.0 and ColumnRanges[3]-ColumnRanges[2] = 1.0. Used for scatter
plot distance calculations. Be sure to set DistanceThreshold accordingly, when used.
int = obj.GetUseNormalizedDistance () - Renormalize the space of the data such that the X
and Y axes are "square" over the specified ColumnRanges. This essentially scales the data space so that
ColumnRanges[1]-ColumnRanges[0] = 1.0 and ColumnRanges[3]-ColumnRanges[2] = 1.0. Used for scatter
plot distance calculations. Be sure to set DistanceThreshold accordingly, when used.
obj.UseNormalizedDistanceOn () - Renormalize the space of the data such that the X and Y
axes are "square" over the specified ColumnRanges. This essentially scales the data space so that ColumnRanges[1]-ColumnRanges[0] = 1.0 and ColumnRanges[3]-ColumnRanges[2] = 1.0. Used for scatter plot
distance calculations. Be sure to set DistanceThreshold accordingly, when used.
obj.UseNormalizedDistanceOff () - Renormalize the space of the data such that the X and Y
axes are "square" over the specified ColumnRanges. This essentially scales the data space so that ColumnRanges[1]-ColumnRanges[0] = 1.0 and ColumnRanges[3]-ColumnRanges[2] = 1.0. Used for scatter plot
distance calculations. Be sure to set DistanceThreshold accordingly, when used.
37.14
vtkBivariateStatisticsAlgorithm
37.14.1
Usage
This class specializes statistics algorithms to the bivariate case, where a number of pairs of columns of interest can
be selected in the input data set. This is done by the means of the following functions:
ResetColumns() - reset the list of columns of interest. Add/RemoveColum( namColX, namColY ) - try to add/remove
column pair ( namColX, namColy ) to/from the list. SetColumnStatus ( namCol, status ) - mostly for UI wrapping
purposes, try to add/remove (depending on status) namCol from a list of buffered columns, from which all possible
pairs are generated. The verb "try" is used in the sense that neither attempting to repeat an existing entry nor to
remove a non-existent entry will work.
.SECTION Thanks Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.
To create an instance of class vtkBivariateStatisticsAlgorithm, simply invoke its constructor as follows
obj = vtkBivariateStatisticsAlgorithm
37.14.2
Methods
The class vtkBivariateStatisticsAlgorithm has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkBivariateStatisticsAlgorithm class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1720
37.15
vtkBoxLayoutStrategy
37.15.1
Usage
vtkBoxLayoutStrategy recursively partitions the space for children vertices in a tree-map into square regions (or
regions very close to a square).
.SECTION Thanks Thanks to Brian Wylie from Sandia National Laboratories for creating this class.
To create an instance of class vtkBoxLayoutStrategy, simply invoke its constructor as follows
obj = vtkBoxLayoutStrategy
37.15.2
Methods
The class vtkBoxLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkBoxLayoutStrategy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBoxLayoutStrategy = obj.NewInstance ()
vtkBoxLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.Layout (vtkTree inputTree, vtkDataArray coordsArray, vtkDataArray
sizeArray) - Perform the layout of a tree and place the results as 4-tuples in coordsArray (Xmin,
Xmax, Ymin, Ymax).
37.16
vtkChacoGraphReader
37.17 vtkCircularLayoutStrategy
37.16.1
1721
Usage
vtkChacoGraphReader reads in files in the Chaco format into a vtkGraph. An example is the following 10 13 2
6 10 1 3 2 4 8 3 5 4 6 10 1 5 7 6 8 3 7 9 8 10 1 5 9 The first line specifies the number
of vertices and edges in the graph. Each additional line contains the vertices adjacent to a particular vertex. In this
example, vertex 1 is adjacent to 2, 6 and 10, vertex 2 is adjacent to 1 and 3, etc. Since Chaco ids start at 1 and
VTK ids start at 0, the vertex ids in the vtkGraph will be 1 less than the Chaco ids.
To create an instance of class vtkChacoGraphReader, simply invoke its constructor as follows
obj = vtkChacoGraphReader
37.16.2
Methods
The class vtkChacoGraphReader has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkChacoGraphReader
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkChacoGraphReader = obj.NewInstance ()
vtkChacoGraphReader = obj.SafeDownCast (vtkObject o)
string = obj.GetFileName () - The Chaco file name.
obj.SetFileName (string ) - The Chaco file name.
37.17
vtkCircularLayoutStrategy
37.17.1
Usage
37.17.2
Methods
The class vtkCircularLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCircularLayoutStrategy
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCircularLayoutStrategy = obj.NewInstance ()
vtkCircularLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.Layout () - Perform the layout.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1722
37.18
vtkClustering2DLayoutStrategy
37.18.1
Usage
This class is a density grid based force directed layout strategy. Also please note that fast is relative to quite slow.
:) The layout running time is O(V+E) with an extremely high constant. .SECTION Thanks Thanks to Godzilla for not
eating my computer so that this class could be written.
To create an instance of class vtkClustering2DLayoutStrategy, simply invoke its constructor as follows
obj = vtkClustering2DLayoutStrategy
37.18.2
Methods
The class vtkClustering2DLayoutStrategy has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkClustering2DLayoutStrategy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkClustering2DLayoutStrategy = obj.NewInstance ()
vtkClustering2DLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.SetRandomSeed (int ) - Seed the random number generator used to jitter point positions. This
has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMinValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMaxValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeed () - Seed the random number generator used to jitter point positions.
This has a significant effect on their final positions when the layout is complete.
obj.SetMaxNumberOfIterations (int ) - Set/Get the maximum number of iterations to be used.
The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph
gets modified. The default is 100 for no particular reason Note: The strong recommendation is that you do
not change this parameter. :)
int = obj.GetMaxNumberOfIterationsMinValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified. The default is 100 for no particular reason Note: The strong recommendation
is that you do not change this parameter. :)
int = obj.GetMaxNumberOfIterationsMaxValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified. The default is 100 for no particular reason Note: The strong recommendation
is that you do not change this parameter. :)
int = obj.GetMaxNumberOfIterations () - Set/Get the maximum number of iterations to be
used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the
graph gets modified. The default is 100 for no particular reason Note: The strong recommendation is that
you do not change this parameter. :)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.19 vtkCollapseGraph
1723
obj.SetIterationsPerLayout (int ) - Set/Get the number of iterations per layout. The only use
for this ivar is for the application to do visualizations of the layout before its complete. The default is 100 to
match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayoutMinValue () - Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before its complete. The
default is 100 to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayoutMaxValue () - Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before its complete. The
default is 100 to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayout () - Set/Get the number of iterations per layout. The only
use for this ivar is for the application to do visualizations of the layout before its complete. The default is 100
to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
obj.SetInitialTemperature (float ) - Set the initial temperature. The temperature default is
5 for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
float = obj.GetInitialTemperatureMinValue () - Set the initial temperature. The temperature default is 5 for no particular reason Note: The strong recommendation is that you do not change this
parameter. :)
float = obj.GetInitialTemperatureMaxValue () - Set the initial temperature. The temperature default is 5 for no particular reason Note: The strong recommendation is that you do not change this
parameter. :)
float = obj.GetInitialTemperature () - Set the initial temperature. The temperature default
is 5 for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
obj.SetCoolDownRate (double ) - Set/Get the Cool-down rate. The higher this number is, the
longer it will take to "cool-down", and thus, the more the graph will be modified. The default is 10 for no
particular reason. Note: The strong recommendation is that you do not change this parameter. :)
double = obj.GetCoolDownRateMinValue () - Set/Get the Cool-down rate. The higher this
number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is
10 for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)
double = obj.GetCoolDownRateMaxValue () - Set/Get the Cool-down rate. The higher this
number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is
10 for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)
double = obj.GetCoolDownRate () - Set/Get the Cool-down rate. The higher this number is, the
longer it will take to "cool-down", and thus, the more the graph will be modified. The default is 10 for no
particular reason. Note: The strong recommendation is that you do not change this parameter. :)
obj.SetRestDistance (float ) - Manually set the resting distance. Otherwise the distance is
computed automatically.
float = obj.GetRestDistance () - Manually set the resting distance. Otherwise the distance is
computed automatically.
obj.Initialize () - This strategy sets up some data structures for faster processing of each Layout()
call
obj.Layout () - This is the layout method where the graph that was set in SetGraph() is laid out. The
method can either entirely layout the graph or iteratively lay out the graph. If you have an iterative layout
please implement the IsLayoutComplete() method.
int = obj.IsLayoutComplete ()
37.19
vtkCollapseGraph
1724
37.19.1
Usage
vtkCollapseGraph "collapses" vertices onto their neighbors, while maintaining connectivity. Two inputs are required
- a graph (directed or undirected), and a vertex selection that can be converted to indices.
Conceptually, each of the vertices specified in the input selection expands, "swallowing" adacent vertices. Edges
to-or-from the "swallowed" vertices become edges to-or-from the expanding vertices, maintaining the overall graph
connectivity.
In the case of directed graphs, expanding vertices only swallow vertices that are connected via out edges. This
rule provides intuitive behavior when working with trees, so that "child" vertices collapse into their parents when the
parents are part of the input selection.
Input port 0: graph Input port 1: selection
To create an instance of class vtkCollapseGraph, simply invoke its constructor as follows
obj = vtkCollapseGraph
37.19.2
Methods
The class vtkCollapseGraph has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkCollapseGraph class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCollapseGraph = obj.NewInstance ()
vtkCollapseGraph = obj.SafeDownCast (vtkObject o)
obj.SetGraphConnection (vtkAlgorithmOutput )
obj.SetSelectionConnection (vtkAlgorithmOutput )
37.20
vtkCollapseVerticesByArray
37.20.1
Usage
vtkCollapseVerticesByArray is a class which collapses the graph using a vertex array as the key. So if the graph has
vertices sharing common traits then this class combines all these vertices into one. This class does not perform
aggregation on vertex data but allow to do so for edge data. Users can choose one or more edge data arrays for
aggregation using AddAggregateEdgeArray function.
.SECTION Thanks
To create an instance of class vtkCollapseVerticesByArray, simply invoke its constructor as follows
obj = vtkCollapseVerticesByArray
37.20.2
Methods
The class vtkCollapseVerticesByArray has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCollapseVerticesByArray
class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.21 vtkCommunity2DLayoutStrategy
1725
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCollapseVerticesByArray = obj.NewInstance ()
vtkCollapseVerticesByArray = obj.SafeDownCast (vtkObject o)
bool = obj.GetAllowSelfLoops () - Boolean to allow self loops during collapse.
obj.SetAllowSelfLoops (bool ) - Boolean to allow self loops during collapse.
obj.AllowSelfLoopsOn () - Boolean to allow self loops during collapse.
obj.AllowSelfLoopsOff () - Boolean to allow self loops during collapse.
obj.AddAggregateEdgeArray (string arrName) - Add arrays on which aggregation of data is
allowed. Default if replaced by the last value.
obj.ClearAggregateEdgeArray () - Clear the list of arrays on which aggregation was set to allow.
string = obj.GetVertexArray () - Set the array using which perform the collapse.
obj.SetVertexArray (string ) - Set the array using which perform the collapse.
37.21
vtkCommunity2DLayoutStrategy
37.21.1
Usage
This class is a density grid based force directed layout strategy. Also please note that fast is relative to quite slow.
:) The layout running time is O(V+E) with an extremely high constant. .SECTION Thanks Thanks to Godzilla for not
eating my computer so that this class could be written.
To create an instance of class vtkCommunity2DLayoutStrategy, simply invoke its constructor as follows
obj = vtkCommunity2DLayoutStrategy
37.21.2
Methods
The class vtkCommunity2DLayoutStrategy has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCommunity2DLayoutStrategy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCommunity2DLayoutStrategy = obj.NewInstance ()
vtkCommunity2DLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.SetRandomSeed (int ) - Seed the random number generator used to jitter point positions. This
has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMinValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMaxValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1726
int = obj.GetRandomSeed () - Seed the random number generator used to jitter point positions.
This has a significant effect on their final positions when the layout is complete.
obj.SetMaxNumberOfIterations (int ) - Set/Get the maximum number of iterations to be used.
The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph
gets modified. The default is 100 for no particular reason Note: The strong recommendation is that you do
not change this parameter. :)
int = obj.GetMaxNumberOfIterationsMinValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified. The default is 100 for no particular reason Note: The strong recommendation
is that you do not change this parameter. :)
int = obj.GetMaxNumberOfIterationsMaxValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified. The default is 100 for no particular reason Note: The strong recommendation
is that you do not change this parameter. :)
int = obj.GetMaxNumberOfIterations () - Set/Get the maximum number of iterations to be
used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the
graph gets modified. The default is 100 for no particular reason Note: The strong recommendation is that
you do not change this parameter. :)
obj.SetIterationsPerLayout (int ) - Set/Get the number of iterations per layout. The only use
for this ivar is for the application to do visualizations of the layout before its complete. The default is 100 to
match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayoutMinValue () - Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before its complete. The
default is 100 to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayoutMaxValue () - Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before its complete. The
default is 100 to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayout () - Set/Get the number of iterations per layout. The only
use for this ivar is for the application to do visualizations of the layout before its complete. The default is 100
to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
obj.SetInitialTemperature (float ) - Set the initial temperature. The temperature default is
5 for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
float = obj.GetInitialTemperatureMinValue () - Set the initial temperature. The temperature default is 5 for no particular reason Note: The strong recommendation is that you do not change this
parameter. :)
float = obj.GetInitialTemperatureMaxValue () - Set the initial temperature. The temperature default is 5 for no particular reason Note: The strong recommendation is that you do not change this
parameter. :)
float = obj.GetInitialTemperature () - Set the initial temperature. The temperature default
is 5 for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
obj.SetCoolDownRate (double ) - Set/Get the Cool-down rate. The higher this number is, the
longer it will take to "cool-down", and thus, the more the graph will be modified. The default is 10 for no
particular reason. Note: The strong recommendation is that you do not change this parameter. :)
double = obj.GetCoolDownRateMinValue () - Set/Get the Cool-down rate. The higher this
number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is
10 for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)
double = obj.GetCoolDownRateMaxValue () - Set/Get the Cool-down rate. The higher this
number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is
10 for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.22 vtkComputeHistogram2DOutliers
1727
double = obj.GetCoolDownRate () - Set/Get the Cool-down rate. The higher this number is, the
longer it will take to "cool-down", and thus, the more the graph will be modified. The default is 10 for no
particular reason. Note: The strong recommendation is that you do not change this parameter. :)
obj.SetRestDistance (float ) - Manually set the resting distance. Otherwise the distance is
computed automatically.
float = obj.GetRestDistance () - Manually set the resting distance. Otherwise the distance is
computed automatically.
obj.Initialize () - This strategy sets up some data structures for faster processing of each Layout()
call
obj.Layout () - This is the layout method where the graph that was set in SetGraph() is laid out. The
method can either entirely layout the graph or iteratively lay out the graph. If you have an iterative layout
please implement the IsLayoutComplete() method.
int = obj.IsLayoutComplete () - Get/Set the community array name
string = obj.GetCommunityArrayName () - Get/Set the community array name
obj.SetCommunityArrayName (string ) - Get/Set the community array name
obj.SetCommunityStrength (float ) - Set the community strength. The default is 1 which
means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean
a layout closer to traditional force directed.
float = obj.GetCommunityStrengthMinValue () - Set the community strength. The default
is 1 which means vertices in the same community will be placed close together, values closer to .1 (minimum)
will mean a layout closer to traditional force directed.
float = obj.GetCommunityStrengthMaxValue () - Set the community strength. The default
is 1 which means vertices in the same community will be placed close together, values closer to .1 (minimum)
will mean a layout closer to traditional force directed.
float = obj.GetCommunityStrength () - Set the community strength. The default is 1 which
means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean
a layout closer to traditional force directed.
37.22
vtkComputeHistogram2DOutliers
37.22.1
Usage
This class takes a table and one or more vtkImageData histograms as input and computes the outliers in that data.
In general it does so by identifying histogram bins that are removed by a median (salt and pepper) filter and below
a threshold. This threshold is automatically identified to retrieve a number of outliers close to a user-determined
value. This value is set by calling SetPreferredNumberOfOutliers(int).
The image data input can come either as a multiple vtkImageData via the repeatable INPUT_HISTOGRAM_IMAGE_DATA port, or as a single vtkMultiBlockDataSet containing vtkImageData objects as blocks. One or the other
must be set, not both (or neither).
The output can be retrieved as a set of row ids in a vtkSelection or as a vtkTable containing the actual outlier row
data.
To create an instance of class vtkComputeHistogram2DOutliers, simply invoke its constructor as follows
obj = vtkComputeHistogram2DOutliers
1728
37.22.2
Methods
The class vtkComputeHistogram2DOutliers has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkComputeHistogram2DOutliers class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkComputeHistogram2DOutliers = obj.NewInstance ()
vtkComputeHistogram2DOutliers = obj.SafeDownCast (vtkObject o)
obj.SetPreferredNumberOfOutliers (int )
int = obj.GetPreferredNumberOfOutliers ()
vtkTable = obj.GetOutputTable ()
obj.SetInputTableConnection (vtkAlgorithmOutput cxn) - Set the input histogram data
as a (repeatable) vtkImageData
obj.SetInputHistogramImageDataConnection (vtkAlgorithmOutput cxn) - Set the
input histogram data as a vtkMultiBlockData set containing multiple vtkImageData objects.
obj.SetInputHistogramMultiBlockConnection (vtkAlgorithmOutput cxn)
37.23
vtkConeLayoutStrategy
37.23.1
Usage
vtkConeLayoutStrategy positions the nodes of a tree(forest) in 3D space based on the cone-tree approach first
described by Robertson, Mackinlay and Card in Proc. CHI91. This implementation incorporates refinements to the
layout developed by Carriere and Kazman, and by Auber.
The input graph must be a forest (i.e. a set of trees, or a single tree); in the case of a forest, the input will be
converted to a single tree by introducing a new root node, and connecting each root in the input forest to the
meta-root. The tree is then laid out, after which the meta-root is removed.
The cones are positioned so that children lie in planes parallel to the X-Y plane, with the axis of cones parallel to Z,
and with Z coordinate increasing with distance of nodes from the root.
.SECTION Thanks Thanks to David Duke from the University of Leeds for providing this implementation.
To create an instance of class vtkConeLayoutStrategy, simply invoke its constructor as follows
obj = vtkConeLayoutStrategy
37.23.2
Methods
The class vtkConeLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkConeLayoutStrategy
class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.24 vtkConstrained2DLayoutStrategy
1729
37.24
vtkConstrained2DLayoutStrategy
37.24.1
Usage
This class is a density grid based force directed layout strategy. Also please note that fast is relative to quite slow.
:) The layout running time is O(V+E) with an extremely high constant. .SECTION Thanks We would like to thank
Mothra for distracting Godzilla while we wrote this class.
To create an instance of class vtkConstrained2DLayoutStrategy, simply invoke its constructor as follows
obj = vtkConstrained2DLayoutStrategy
37.24.2
Methods
The class vtkConstrained2DLayoutStrategy has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkConstrained2DLayoutStrategy class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1730
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkConstrained2DLayoutStrategy = obj.NewInstance ()
vtkConstrained2DLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.SetRandomSeed (int ) - Seed the random number generator used to jitter point positions. This
has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMinValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMaxValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeed () - Seed the random number generator used to jitter point positions.
This has a significant effect on their final positions when the layout is complete.
obj.SetMaxNumberOfIterations (int ) - Set/Get the maximum number of iterations to be used.
The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph
gets modified. The default is 100 for no particular reason Note: The strong recommendation is that you do
not change this parameter. :)
int = obj.GetMaxNumberOfIterationsMinValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified. The default is 100 for no particular reason Note: The strong recommendation
is that you do not change this parameter. :)
int = obj.GetMaxNumberOfIterationsMaxValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified. The default is 100 for no particular reason Note: The strong recommendation
is that you do not change this parameter. :)
int = obj.GetMaxNumberOfIterations () - Set/Get the maximum number of iterations to be
used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the
graph gets modified. The default is 100 for no particular reason Note: The strong recommendation is that
you do not change this parameter. :)
obj.SetIterationsPerLayout (int ) - Set/Get the number of iterations per layout. The only use
for this ivar is for the application to do visualizations of the layout before its complete. The default is 100 to
match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayoutMinValue () - Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before its complete. The
default is 100 to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayoutMaxValue () - Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before its complete. The
default is 100 to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayout () - Set/Get the number of iterations per layout. The only
use for this ivar is for the application to do visualizations of the layout before its complete. The default is 100
to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
obj.SetInitialTemperature (float ) - Set the initial temperature. The temperature default is
5 for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
float = obj.GetInitialTemperatureMinValue () - Set the initial temperature. The temperature default is 5 for no particular reason Note: The strong recommendation is that you do not change this
parameter. :)
float = obj.GetInitialTemperatureMaxValue () - Set the initial temperature. The temperature default is 5 for no particular reason Note: The strong recommendation is that you do not change this
parameter. :)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.25 vtkContingencyStatistics
1731
37.25
vtkContingencyStatistics
37.25.1
Usage
Given a pair of columns of interest, this class provides the following functionalities, depending on the execution mode
it is executed in: Learn: calculate contigency tables and corresponding discrete bivariate probability distribution.
Assess: given two columns of interest with the same number of entries as input in port INPUT_DATA, and a
corresponding bivariate probability distribution,
.SECTION Thanks Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.
To create an instance of class vtkContingencyStatistics, simply invoke its constructor as follows
obj = vtkContingencyStatistics
1732
37.25.2
Methods
The class vtkContingencyStatistics has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkContingencyStatistics
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkContingencyStatistics = obj.NewInstance ()
vtkContingencyStatistics = obj.SafeDownCast (vtkObject o)
obj.Aggregate (vtkDataObjectCollection , vtkDataObject ) - Given a collection of
models, calculate aggregate model NB: not implemented
37.26
vtkCorrelativeStatistics
37.26.1
Usage
Given a selection of pairs of columns of interest, this class provides the following functionalities, depending on the
execution mode it is executed in: Learn: calculate means, unbiased variance and covariance estimators of column
pairs, and corresponding linear regressions and linear correlation coefficient. More precisely, Learn calculates the
sums; if finalize is set to true (default), the final statistics are calculated with the function CalculateFromSums.
Otherwise, only raw sums are output; this option is made for efficient parallel calculations. Note that CalculateFromSums is a static function, so that it can be used directly with no need to instantiate a vtkCorrelativeStatistics
object. Assess: given two data vectors X and Y with the same number of entries as input in port INPUT_DATA, and
reference means, variances, and covariance, along with an acceptable threshold t>1, assess all pairs of values of
(X,Y) whose relative PDF (assuming a bivariate Gaussian model) is below t.
.SECTION Thanks Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.
To create an instance of class vtkCorrelativeStatistics, simply invoke its constructor as follows
obj = vtkCorrelativeStatistics
37.26.2
Methods
The class vtkCorrelativeStatistics has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCorrelativeStatistics
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCorrelativeStatistics = obj.NewInstance ()
vtkCorrelativeStatistics = obj.SafeDownCast (vtkObject o)
obj.Aggregate (vtkDataObjectCollection , vtkDataObject ) - Given a collection of
models, calculate aggregate model
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.27 vtkCosmicTreeLayoutStrategy
37.27
1733
vtkCosmicTreeLayoutStrategy
37.27.1
Usage
This layout strategy takes an input tree and places all the children of a node into a containing circle. The placement
is such that each child placed can be represented with a circle tangent to the containing circle and (usually) 2 other
children. The interior of the circle is left empty so that graph edges drawn on top of the tree will not obfuscate the
tree. However, when one child is much larger than all the others, it may encroach on the center of the containing
circle; thats OK, because its large enough not to be obscured by edges drawn atop it.
.SECTION Thanks Thanks to the galaxy and David Thompson hierarchically nested inside it for inspiring this layout
strategy.
To create an instance of class vtkCosmicTreeLayoutStrategy, simply invoke its constructor as follows
obj = vtkCosmicTreeLayoutStrategy
37.27.2
Methods
The class vtkCosmicTreeLayoutStrategy has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkCosmicTreeLayoutStrategy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkCosmicTreeLayoutStrategy = obj.NewInstance ()
vtkCosmicTreeLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.Layout () - Perform the layout.
obj.SetSizeLeafNodesOnly (int ) - Should node size specifications be obeyed at leaf nodes
only or (with scaling as required to meet constraints) at every node in the tree? This defaults to true, so that
leaf nodes are scaled according to the size specification provided, and the parent node sizes are calculated
by the algorithm.
int = obj.GetSizeLeafNodesOnly () - Should node size specifications be obeyed at leaf nodes
only or (with scaling as required to meet constraints) at every node in the tree? This defaults to true, so that
leaf nodes are scaled according to the size specification provided, and the parent node sizes are calculated
by the algorithm.
obj.SizeLeafNodesOnlyOn () - Should node size specifications be obeyed at leaf nodes only or
(with scaling as required to meet constraints) at every node in the tree? This defaults to true, so that leaf
nodes are scaled according to the size specification provided, and the parent node sizes are calculated by
the algorithm.
obj.SizeLeafNodesOnlyOff () - Should node size specifications be obeyed at leaf nodes only or
(with scaling as required to meet constraints) at every node in the tree? This defaults to true, so that leaf
nodes are scaled according to the size specification provided, and the parent node sizes are calculated by
the algorithm.
obj.SetLayoutDepth (int ) - How many levels of the tree should be laid out? For large trees, you
may wish to set the root and maximum depth in order to retrieve the layout for the visible portion of the tree.
When this value is zero or negative, all nodes below and including the LayoutRoot will be presented. This
defaults to 0.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1734
int = obj.GetLayoutDepth () - How many levels of the tree should be laid out? For large trees,
you may wish to set the root and maximum depth in order to retrieve the layout for the visible portion of the
tree. When this value is zero or negative, all nodes below and including the LayoutRoot will be presented.
This defaults to 0.
obj.SetLayoutRoot (vtkIdType ) - What is the top-most tree node to lay out? This node will
become the largest containing circle in the layout. Use this in combination with SetLayoutDepth to retrieve
the layout of a subtree of interest for rendering. Setting LayoutRoot to a negative number signals that the root
node of the tree should be used as the root node of the layout. This defaults to -1.
vtkIdType = obj.GetLayoutRoot () - What is the top-most tree node to lay out? This node will
become the largest containing circle in the layout. Use this in combination with SetLayoutDepth to retrieve
the layout of a subtree of interest for rendering. Setting LayoutRoot to a negative number signals that the root
node of the tree should be used as the root node of the layout. This defaults to -1.
obj.SetNodeSizeArrayName (string ) - Set the array to be used for sizing nodes. If this is set
to an empty string or NULL (the default), then all leaf nodes (or all nodes, when SizeLeafNodesOnly is false)
will be assigned a unit size.
string = obj.GetNodeSizeArrayName () - Set the array to be used for sizing nodes. If this is
set to an empty string or NULL (the default), then all leaf nodes (or all nodes, when SizeLeafNodesOnly is
false) will be assigned a unit size.
37.28
vtkDataObjectToTable
37.28.1
Usage
This filter is used to extract either the field, cell or point data of any data object as a table.
To create an instance of class vtkDataObjectToTable, simply invoke its constructor as follows
obj = vtkDataObjectToTable
37.28.2
Methods
The class vtkDataObjectToTable has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataObjectToTable class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataObjectToTable = obj.NewInstance ()
vtkDataObjectToTable = obj.SafeDownCast (vtkObject o)
int = obj.GetFieldType () - The field type to copy into the output table. Should be one of FIELD_DATA, POINT_DATA, CELL_DATA, VERTEX_DATA, EDGE_DATA.
obj.SetFieldType (int ) - The field type to copy into the output table. Should be one of FIELD_DATA, POINT_DATA, CELL_DATA, VERTEX_DATA, EDGE_DATA.
int = obj.GetFieldTypeMinValue () - The field type to copy into the output table. Should be
one of FIELD_DATA, POINT_DATA, CELL_DATA, VERTEX_DATA, EDGE_DATA.
int = obj.GetFieldTypeMaxValue () - The field type to copy into the output table. Should be
one of FIELD_DATA, POINT_DATA, CELL_DATA, VERTEX_DATA, EDGE_DATA.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.29 vtkDelimitedTextReader
37.29
1735
vtkDelimitedTextReader
37.29.1
Usage
vtkDelimitedTextReader is an interface for pulling in data from a flat, delimited ascii or unicode text file (delimiter can
be any character).
The behavior of the reader with respect to ascii or unicode input is controlled by the SetUnicodeCharacterSet()
method. By default (without calling SetUnicodeCharacterSet()), the reader will expect to read ascii text and will
output vtkStdString columns. Use the Set and Get methods to set delimiters that do not contain UTF8 in the name
when operating the reader in default ascii mode. If the SetUnicodeCharacterSet() method is called, the reader will
output vtkUnicodeString columns in the output table. In addition, it is necessary to use the Set and Get methods
that contain UTF8 in the name to specify delimiters when operating in unicode mode.
This class emits ProgressEvent for every 100 lines it reads.
.SECTION Thanks Thanks to Andy Wilson, Brian Wylie, Tim Shead, and Thomas Otahal from Sandia National
Laboratories for implementing this class.
To create an instance of class vtkDelimitedTextReader, simply invoke its constructor as follows
obj = vtkDelimitedTextReader
37.29.2
Methods
The class vtkDelimitedTextReader has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDelimitedTextReader
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDelimitedTextReader = obj.NewInstance ()
vtkDelimitedTextReader = obj.SafeDownCast (vtkObject o)
string = obj.GetFileName ()
obj.SetFileName (string )
string = obj.GetUnicodeCharacterSet () - Specifies the character set used in the input file.
Valid character set names will be drawn from the list maintained by the Internet Assigned Name Authority at
http://www.iana.org/assignments/character-sets
Where multiple aliases are provided for a character set, the preferred MIME name will be used. vtkUnicodeDelimitedTextReader currently supports "US-ASCII", "UTF-8", "UTF-16", "UTF-16BE", and "UTF-16LE" character sets.
obj.SetUnicodeCharacterSet (string ) - Specifies the character set used in the input file.
Valid character set names will be drawn from the list maintained by the Internet Assigned Name Authority
at
http://www.iana.org/assignments/character-sets
Where multiple aliases are provided for a character set, the preferred MIME name will be used. vtkUnicodeDelimitedTextReader currently supports "US-ASCII", "UTF-8", "UTF-16", "UTF-16BE", and "UTF-16LE" character sets.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1736
37.30 vtkDescriptiveStatistics
1737
obj.SetMaxRecords (vtkIdType ) - Specifies the maximum number of records to read from the
file. Limiting the number of records to read is useful for previewing the contents of a file.
obj.SetDetectNumericColumns (bool ) - When set to true, the reader will detect numeric
columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray. Default is off.
bool = obj.GetDetectNumericColumns () - When set to true, the reader will detect numeric
columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray. Default is off.
obj.DetectNumericColumnsOn () - When set to true, the reader will detect numeric columns and
create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray. Default is off.
obj.DetectNumericColumnsOff () - When set to true, the reader will detect numeric columns and
create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray. Default is off.
obj.SetPedigreeIdArrayName (string ) - The name of the array for generating or assigning
pedigree ids (default "id").
string = obj.GetPedigreeIdArrayName () - The name of the array for generating or assigning
pedigree ids (default "id").
obj.SetGeneratePedigreeIds (bool ) - If on (default), generates pedigree ids automatically. If
off, assign one of the arrays to be the pedigree id.
bool = obj.GetGeneratePedigreeIds () - If on (default), generates pedigree ids automatically.
If off, assign one of the arrays to be the pedigree id.
obj.GeneratePedigreeIdsOn () - If on (default), generates pedigree ids automatically. If off, assign
one of the arrays to be the pedigree id.
obj.GeneratePedigreeIdsOff () - If on (default), generates pedigree ids automatically. If off, assign one of the arrays to be the pedigree id.
obj.SetOutputPedigreeIds (bool ) - If on, assigns pedigree ids to output. Defaults to off.
bool = obj.GetOutputPedigreeIds () - If on, assigns pedigree ids to output. Defaults to off.
obj.OutputPedigreeIdsOn () - If on, assigns pedigree ids to output. Defaults to off.
obj.OutputPedigreeIdsOff () - If on, assigns pedigree ids to output. Defaults to off.
vtkStdString = obj.GetLastError () - Returns a human-readable description of the most recent error, if any. Otherwise, returns an empty string. Note that the result is only valid after calling Update().
37.30
vtkDescriptiveStatistics
37.30.1
Usage
Given a selection of columns of interest in an input data table, this class provides the following functionalities,
depending on the execution mode it is executed in: Learn: calculate extremal values, arithmetic mean, unbiased
variance estimator, skewness estimator, and both sample and G2 estimation of the kurtosis excess. More precisely,
Learn calculates the sums; if finalize is set to true (default), the final statistics are calculated with CalculateFromSums. Otherwise, only raw sums are output; this option is made for efficient parallel calculations. Note that
CalculateFromSums is a static function, so that it can be used directly with no need to instantiate a vtkDescriptiveStatistics object. Assess: given an input data set in port INPUT_DATA, and a reference value x along with an
acceptable deviation d>0, assess all entries in the data set which are outside of [x-d,x+d].
.SECTION Thanks Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.
To create an instance of class vtkDescriptiveStatistics, simply invoke its constructor as follows
obj = vtkDescriptiveStatistics
1738
37.30.2
Methods
The class vtkDescriptiveStatistics has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDescriptiveStatistics
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDescriptiveStatistics = obj.NewInstance ()
vtkDescriptiveStatistics = obj.SafeDownCast (vtkObject o)
obj.SetUnbiasedVariance (int ) - Set/get whether the unbiased estimator for the variance
should be used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.
int = obj.GetUnbiasedVariance () - Set/get whether the unbiased estimator for the variance
should be used, or if the population variance will be calculated. The default is that the unbiased estimator will
be used.
obj.UnbiasedVarianceOn () - Set/get whether the unbiased estimator for the variance should be
used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.
obj.UnbiasedVarianceOff () - Set/get whether the unbiased estimator for the variance should be
used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.
obj.SetSignedDeviations (int ) - Set/get whether the deviations returned should be signed, or
should only have their magnitude reported. The default is that signed deviations will be computed.
int = obj.GetSignedDeviations () - Set/get whether the deviations returned should be signed,
or should only have their magnitude reported. The default is that signed deviations will be computed.
obj.SignedDeviationsOn () - Set/get whether the deviations returned should be signed, or should
only have their magnitude reported. The default is that signed deviations will be computed.
obj.SignedDeviationsOff () - Set/get whether the deviations returned should be signed, or should
only have their magnitude reported. The default is that signed deviations will be computed.
obj.SetNominalParameter (string name) - A convenience method (in particular for UI wrapping) to set the name of the column that contains the nominal value for the Assess option.
obj.SetDeviationParameter (string name) - A convenience method (in particular for UI wrapping) to set the name of the column that contains the deviation for the Assess option.
obj.Aggregate (vtkDataObjectCollection , vtkDataObject ) - Given a collection of
models, calculate aggregate model
37.31
vtkDotProductSimilarity
37.31.1
Usage
Treats matrices as collections of vectors and computes dot-product similarity metrics between vectors.
The results are returned as an edge-table that lists the index of each vector and their computed similarity. The
output edge-table is typically used with vtkTableToGraph to create a similarity graph.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.31 vtkDotProductSimilarity
1739
This filter can be used with one or two input matrices. If you provide a single matrix as input, every vector in the
matrix is compared with every other vector. If you provide two matrices, every vector in the first matrix is compared
with every vector in the second matrix.
Note that this filter only computes the dot-product between each pair of vectors; if you want to compute the cosine
of the angles between vectors, you will need to normalize the inputs yourself.
Inputs: Input port 0: (required) A vtkDenseArray<double> with two dimensions (a matrix). Input port 1: (optional)
A vtkDenseArray<double> with two dimensions (a matrix).
Outputs: Output port 0: A vtkTable containing "source", "target", and "similarity" columns.
To create an instance of class vtkDotProductSimilarity, simply invoke its constructor as follows
obj = vtkDotProductSimilarity
37.31.2
Methods
The class vtkDotProductSimilarity has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDotProductSimilarity
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDotProductSimilarity = obj.NewInstance ()
vtkDotProductSimilarity = obj.SafeDownCast (vtkObject o)
vtkIdType = obj.GetVectorDimension () - Controls whether to compute similarities for rowvectors or column-vectors. 0 = rows, 1 = columns.
obj.SetVectorDimension (vtkIdType ) - Controls whether to compute similarities for rowvectors or column-vectors. 0 = rows, 1 = columns.
int = obj.GetUpperDiagonal () - When computing similarities for a single input matrix, controls
whether the results will include the upper diagonal of the similarity matrix. Default: true.
obj.SetUpperDiagonal (int ) - When computing similarities for a single input matrix, controls
whether the results will include the upper diagonal of the similarity matrix. Default: true.
int = obj.GetDiagonal () - When computing similarities for a single input matrix, controls whether
the results will include the diagonal of the similarity matrix. Default: false.
obj.SetDiagonal (int ) - When computing similarities for a single input matrix, controls whether the
results will include the diagonal of the similarity matrix. Default: false.
int = obj.GetLowerDiagonal () - When computing similarities for a single input matrix, controls
whether the results will include the lower diagonal of the similarity matrix. Default: false.
obj.SetLowerDiagonal (int ) - When computing similarities for a single input matrix, controls
whether the results will include the lower diagonal of the similarity matrix. Default: false.
int = obj.GetFirstSecond () - When computing similarities for two input matrices, controls
whether the results will include comparisons from the first matrix to the second matrix.
obj.SetFirstSecond (int ) - When computing similarities for two input matrices, controls whether
the results will include comparisons from the first matrix to the second matrix.
int = obj.GetSecondFirst () - When computing similarities for two input matrices, controls
whether the results will include comparisons from the second matrix to the first matrix.
obj.SetSecondFirst (int ) - When computing similarities for two input matrices, controls whether
the results will include comparisons from the second matrix to the first matrix.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1740
37.32
vtkEdgeCenters
37.32.1
Usage
vtkEdgeCenters is a filter that takes as input any graph and generates on output points at the center of the cells
in the dataset. These points can be used for placing glyphs (vtkGlyph3D) or labeling (vtkLabeledDataMapper).
(The center is the parametric center of the cell, not necessarily the geometric or bounding box center.) The edge
attributes will be associated with the points on output.
To create an instance of class vtkEdgeCenters, simply invoke its constructor as follows
obj = vtkEdgeCenters
37.32.2
Methods
The class vtkEdgeCenters has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkEdgeCenters class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkEdgeCenters = obj.NewInstance ()
vtkEdgeCenters = obj.SafeDownCast (vtkObject o)
obj.SetVertexCells (int ) - Enable/disable the generation of vertex cells.
int = obj.GetVertexCells () - Enable/disable the generation of vertex cells.
obj.VertexCellsOn () - Enable/disable the generation of vertex cells.
obj.VertexCellsOff () - Enable/disable the generation of vertex cells.
37.33
vtkEdgeLayout
37.34 vtkEdgeLayoutStrategy
37.33.1
1741
Usage
This class is a shell for many edge layout strategies which may be set using the SetLayoutStrategy() function. The
layout strategies do the actual work.
To create an instance of class vtkEdgeLayout, simply invoke its constructor as follows
obj = vtkEdgeLayout
37.33.2
Methods
The class vtkEdgeLayout has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkEdgeLayout class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkEdgeLayout = obj.NewInstance ()
vtkEdgeLayout = obj.SafeDownCast (vtkObject o)
obj.SetLayoutStrategy (vtkEdgeLayoutStrategy strategy) - The layout strategy to
use during graph layout.
vtkEdgeLayoutStrategy = obj.GetLayoutStrategy () - The layout strategy to use during
graph layout.
long = obj.GetMTime () - Get the modification time of the layout algorithm.
37.34
vtkEdgeLayoutStrategy
37.34.1
Usage
All edge layouts should subclass from this class. vtkEdgeLayoutStrategy works as a plug-in to the vtkEdgeLayout
algorithm.
To create an instance of class vtkEdgeLayoutStrategy, simply invoke its constructor as follows
obj = vtkEdgeLayoutStrategy
37.34.2
Methods
The class vtkEdgeLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkEdgeLayoutStrategy
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkEdgeLayoutStrategy = obj.NewInstance ()
vtkEdgeLayoutStrategy = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1742
obj.SetGraph (vtkGraph graph) - Setting the graph for the layout strategy
obj.Initialize () - This method allows the layout strategy to do initialization of data structures or
whatever else it might want to do.
obj.Layout () - This is the layout method where the graph that was set in SetGraph() is laid out.
obj.SetEdgeWeightArrayName (string ) - Set/Get the field to use for the edge weights.
string = obj.GetEdgeWeightArrayName () - Set/Get the field to use for the edge weights.
37.35
vtkExpandSelectedGraph
37.35.1
Usage
The first input is a vtkSelection containing the selected vertices. The second input is a vtkGraph. This filter grows
the selection set in one of the following ways 1) SetBFSDistance controls how many hops the selection is grown
from each seed point in the selection set (defaults to 1) 2) IncludeShortestPaths controls whether this filter tries to
connect the vertices in the selection set by computing the shortest path between the vertices (if such a path exists)
Note: IncludeShortestPaths is currently non-functional
To create an instance of class vtkExpandSelectedGraph, simply invoke its constructor as follows
obj = vtkExpandSelectedGraph
37.35.2
Methods
The class vtkExpandSelectedGraph has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExpandSelectedGraph
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExpandSelectedGraph = obj.NewInstance ()
vtkExpandSelectedGraph = obj.SafeDownCast (vtkObject o)
obj.SetGraphConnection (vtkAlgorithmOutput in) - A convenience method for setting the
second input (i.e. the graph).
int = obj.FillInputPortInformation (int port, vtkInformation info) - Specify the first vtkSelection input and the second vtkGraph input.
obj.SetBFSDistance (int ) - Set/Get BFSDistance which controls how many hops the selection
is grown from each seed point in the selection set (defaults to 1)
int = obj.GetBFSDistance () - Set/Get BFSDistance which controls how many hops the selection is grown from each seed point in the selection set (defaults to 1)
obj.SetIncludeShortestPaths (bool ) - Set/Get IncludeShortestPaths controls whether this
filter tries to connect the vertices in the selection set by computing the shortest path between the vertices (if
such a path exists) Note: IncludeShortestPaths is currently non-functional
bool = obj.GetIncludeShortestPaths () - Set/Get IncludeShortestPaths controls whether this
filter tries to connect the vertices in the selection set by computing the shortest path between the vertices (if
such a path exists) Note: IncludeShortestPaths is currently non-functional
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.36 vtkExtractHistogram2D
1743
37.36
vtkExtractHistogram2D
37.36.1
Usage
This class computes a 2D histogram between two columns of an input vtkTable. Just as with a 1D histogram, a 2D
histogram breaks up the input domain into bins, and each pair of values (row in the table) fits into a single bin and
increments a row counter for that bin.
To use this class, set the input with a table and call AddColumnPair(nameX,nameY), where nameX and nameY are
the names of the two columns to be used.
In addition to the number of bins (in X and Y), the domain of the histogram can be customized by toggling the
UseCustomHistogramExtents flag and setting the CustomHistogramExtents variable to the desired value.
To create an instance of class vtkExtractHistogram2D, simply invoke its constructor as follows
obj = vtkExtractHistogram2D
37.36.2
Methods
The class vtkExtractHistogram2D has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractHistogram2D
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractHistogram2D = obj.NewInstance ()
vtkExtractHistogram2D = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfBins (int , int ) - Set/get the number of bins to be used per dimension (x,y)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1744
obj.SetNumberOfBins (int a[2]) - Set/get the number of bins to be used per dimension (x,y)
int = obj.
obj.SetComponentsToProcess (int , int ) - Set/get the components of the arrays in the two
input columns to be used during histogram computation. Defaults to component 0.
obj.SetComponentsToProcess (int a[2]) - Set/get the components of the arrays in the two
input columns to be used during histogram computation. Defaults to component 0.
int = obj. GetComponentsToProcess () - Set/get the components of the arrays in the two
input columns to be used during histogram computation. Defaults to component 0.
obj.SetCustomHistogramExtents (double , double , double , double )
Set/get a custom domain for histogram computation. UseCustomHistogramExtents must be called for
these to actually be used.
obj.SetCustomHistogramExtents (double a[4]) - Set/get a custom domain for histogram
computation. UseCustomHistogramExtents must be called for these to actually be used.
double = obj. GetCustomHistogramExtents () - Set/get a custom domain for histogram
computation. UseCustomHistogramExtents must be called for these to actually be used.
obj.SetUseCustomHistogramExtents (int ) - Use the extents in CustomHistogramExtents
when computing the histogram, rather than the simple range of the input columns.
int = obj.GetUseCustomHistogramExtents () - Use the extents in CustomHistogramExtents
when computing the histogram, rather than the simple range of the input columns.
obj.UseCustomHistogramExtentsOn () - Use the extents in CustomHistogramExtents when computing the histogram, rather than the simple range of the input columns.
obj.UseCustomHistogramExtentsOff () - Use the extents in CustomHistogramExtents when
computing the histogram, rather than the simple range of the input columns.
obj.SetScalarType (int ) - Control the scalar type of the output histogram. If the input is relatively
small, you can save space by using a smaller data type. Defaults to unsigned integer.
obj.SetScalarTypeToUnsignedInt () - Control the scalar type of the output histogram. If the
input is relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.
obj.SetScalarTypeToUnsignedLong () - Control the scalar type of the output histogram. If the
input is relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.
obj.SetScalarTypeToUnsignedShort () - Control the scalar type of the output histogram. If the
input is relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.
obj.SetScalarTypeToUnsignedChar () - Control the scalar type of the output histogram. If the
input is relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.
obj.SetScalarTypeToFloat () - Control the scalar type of the output histogram. If the input is
relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.
obj.SetScalarTypeToDouble () - Control the scalar type of the output histogram. If the input is
relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.
int = obj.GetScalarType () - Control the scalar type of the output histogram. If the input is relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.
double = obj.GetMaximumBinCount () - Access the count of the histogram bin containing the
largest number of input rows.
int = obj.GetBinRange (vtkIdType binX, vtkIdType binY, double range[4])
- Compute the range of the bin located at position (binX,binY) in the 2D histogram.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.37 vtkExtractSelectedGraph
1745
int = obj.GetBinRange (vtkIdType bin, double range[4]) - Get the range of the of
the bin located at 1D position index bin in the 2D histogram array.
obj.GetBinWidth (double bw[2]) - Get the width of all of the bins. Also stored in the spacing ivar
of the histogram image output.
vtkImageData = obj.GetOutputHistogramImage () - Gets the data object at the histogram
image output port and casts it to a vtkImageData.
obj.SetSwapColumns (int )
int = obj.GetSwapColumns ()
obj.SwapColumnsOn ()
obj.SwapColumnsOff ()
obj.SetRowMask (vtkDataArray ) - Get/Set an optional mask that can ignore rows of the table
vtkDataArray = obj.GetRowMask () - Get/Set an optional mask that can ignore rows of the table
obj.Aggregate (vtkDataObjectCollection , vtkDataObject ) - Given a collection of
models, calculate aggregate model. Not used.
37.37
vtkExtractSelectedGraph
37.37.1
Usage
The first input is a vtkGraph to take a subgraph from. The second input (optional) is a vtkSelection containing
selected indices. The third input (optional) is a vtkAnnotationsLayers whose annotations contain selected specifying
selected indices. The vtkSelection may have FIELD_TYPE set to POINTS (a vertex selection) or CELLS (an edge
selection). A vertex selection preserves all edges that connect selected vertices. An edge selection preserves all
vertices that are adjacent to at least one selected edge. Alternately, you may indicate that an edge selection should
maintain the full set of vertices, by turning RemoveIsolatedVertices off.
To create an instance of class vtkExtractSelectedGraph, simply invoke its constructor as follows
obj = vtkExtractSelectedGraph
37.37.2
Methods
The class vtkExtractSelectedGraph has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkExtractSelectedGraph
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkExtractSelectedGraph = obj.NewInstance ()
vtkExtractSelectedGraph = obj.SafeDownCast (vtkObject o)
obj.SetSelectionConnection (vtkAlgorithmOutput in) - A convenience method for setting the second input (i.e. the selection).
obj.SetAnnotationLayersConnection (vtkAlgorithmOutput in)
method for setting the third input (i.e. the annotation layers).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
convenience
1746
37.38
vtkFast2DLayoutStrategy
37.38.1
Usage
This class is a density grid based force directed layout strategy. Also please note that fast is relative to quite slow.
:) The layout running time is O(V+E) with an extremely high constant. .SECTION Thanks Thanks to Godzilla for not
eating my computer so that this class could be written.
To create an instance of class vtkFast2DLayoutStrategy, simply invoke its constructor as follows
obj = vtkFast2DLayoutStrategy
37.38.2
Methods
The class vtkFast2DLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkFast2DLayoutStrategy
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkFast2DLayoutStrategy = obj.NewInstance ()
vtkFast2DLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.SetRandomSeed (int ) - Seed the random number generator used to jitter point positions. This
has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMinValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMaxValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeed () - Seed the random number generator used to jitter point positions.
This has a significant effect on their final positions when the layout is complete.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.38 vtkFast2DLayoutStrategy
1747
1748
obj.SetRestDistance (float ) - Manually set the resting distance. Otherwise the distance is
computed automatically.
float = obj.GetRestDistance () - Manually set the resting distance. Otherwise the distance is
computed automatically.
obj.Initialize () - This strategy sets up some data structures for faster processing of each Layout()
call
obj.Layout () - This is the layout method where the graph that was set in SetGraph() is laid out. The
method can either entirely layout the graph or iteratively lay out the graph. If you have an iterative layout
please implement the IsLayoutComplete() method.
int = obj.IsLayoutComplete ()
37.39
vtkFixedWidthTextReader
37.39.1
Usage
vtkFixedWidthTextReader reads in a table from a text file where each column occupies a certain number of characters.
This class emits ProgressEvent for every 100 lines it reads.
To create an instance of class vtkFixedWidthTextReader, simply invoke its constructor as follows
obj = vtkFixedWidthTextReader
37.39.2
Methods
The class vtkFixedWidthTextReader has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkFixedWidthTextReader
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkFixedWidthTextReader = obj.NewInstance ()
vtkFixedWidthTextReader = obj.SafeDownCast (vtkObject o)
string = obj.GetFileName ()
obj.SetFileName (string )
obj.SetFieldWidth (int ) - Set/get the field width
int = obj.GetFieldWidth () - Set/get the field width
obj.SetStripWhiteSpace (bool ) - If set, this flag will cause the reader to strip whitespace from
the beginning and ending of each field. Defaults to off.
bool = obj.GetStripWhiteSpace () - If set, this flag will cause the reader to strip whitespace
from the beginning and ending of each field. Defaults to off.
obj.StripWhiteSpaceOn () - If set, this flag will cause the reader to strip whitespace from the beginning and ending of each field. Defaults to off.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.40 vtkForceDirectedLayoutStrategy
1749
obj.StripWhiteSpaceOff () - If set, this flag will cause the reader to strip whitespace from the
beginning and ending of each field. Defaults to off.
bool = obj.GetHaveHeaders () - Set/get whether to treat the first line of the file as headers.
obj.SetHaveHeaders (bool ) - Set/get whether to treat the first line of the file as headers.
obj.HaveHeadersOn () - Set/get whether to treat the first line of the file as headers.
obj.HaveHeadersOff () - Set/get whether to treat the first line of the file as headers.
37.40
vtkForceDirectedLayoutStrategy
37.40.1
Usage
Lays out a graph in 2D or 3D using a force-directed algorithm. The user may specify whether to layout the graph
randomly initially, the bounds, the number of dimensions (2 or 3), and the cool-down rate.
.SECTION Thanks Thanks to Brian Wylie for adding functionality for allowing this layout to be incremental.
To create an instance of class vtkForceDirectedLayoutStrategy, simply invoke its constructor as follows
obj = vtkForceDirectedLayoutStrategy
37.40.2
Methods
The class vtkForceDirectedLayoutStrategy has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkForceDirectedLayoutStrategy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkForceDirectedLayoutStrategy = obj.NewInstance ()
vtkForceDirectedLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.SetRandomSeed (int ) - Seed the random number generator used to jitter point positions. This
has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMinValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMaxValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeed () - Seed the random number generator used to jitter point positions.
This has a significant effect on their final positions when the layout is complete.
obj.SetGraphBounds (double , double , double , double , double , double
) - Set / get the region in space in which to place the final graph. The GraphBounds only affects the results if
AutomaticBoundsComputation is off.
obj.SetGraphBounds (double a[6]) - Set / get the region in space in which to place the final
graph. The GraphBounds only affects the results if AutomaticBoundsComputation is off.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1750
double = obj. GetGraphBounds () - Set / get the region in space in which to place the final
graph. The GraphBounds only affects the results if AutomaticBoundsComputation is off.
obj.SetAutomaticBoundsComputation (int ) - Turn on/off automatic graph bounds calculation. If this boolean is off, then the manually specified GraphBounds is used. If on, then the inputs bounds us
used as the graph bounds.
int = obj.GetAutomaticBoundsComputation () - Turn on/off automatic graph bounds calculation. If this boolean is off, then the manually specified GraphBounds is used. If on, then the inputs bounds
us used as the graph bounds.
obj.AutomaticBoundsComputationOn () - Turn on/off automatic graph bounds calculation. If this
boolean is off, then the manually specified GraphBounds is used. If on, then the inputs bounds us used as
the graph bounds.
obj.AutomaticBoundsComputationOff () - Turn on/off automatic graph bounds calculation. If
this boolean is off, then the manually specified GraphBounds is used. If on, then the inputs bounds us used
as the graph bounds.
obj.SetMaxNumberOfIterations (int ) - Set/Get the maximum number of iterations to be used.
The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph
gets modified. The default is 50 for no particular reason
int = obj.GetMaxNumberOfIterationsMinValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified. The default is 50 for no particular reason
int = obj.GetMaxNumberOfIterationsMaxValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified. The default is 50 for no particular reason
int = obj.GetMaxNumberOfIterations () - Set/Get the maximum number of iterations to be
used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the
graph gets modified. The default is 50 for no particular reason
obj.SetIterationsPerLayout (int ) - Set/Get the number of iterations per layout. The only use
for this ivar is for the application to do visualizations of the layout before its complete. The default is 50 to
match the default MaxNumberOfIterations
int = obj.GetIterationsPerLayoutMinValue () - Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before its complete. The
default is 50 to match the default MaxNumberOfIterations
int = obj.GetIterationsPerLayoutMaxValue () - Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before its complete. The
default is 50 to match the default MaxNumberOfIterations
int = obj.GetIterationsPerLayout () - Set/Get the number of iterations per layout. The only
use for this ivar is for the application to do visualizations of the layout before its complete. The default is 50
to match the default MaxNumberOfIterations
obj.SetCoolDownRate (double ) - Set/Get the Cool-down rate. The higher this number is, the
longer it will take to "cool-down", and thus, the more the graph will be modified.
double = obj.GetCoolDownRateMinValue () - Set/Get the Cool-down rate. The higher this
number is, the longer it will take to "cool-down", and thus, the more the graph will be modified.
double = obj.GetCoolDownRateMaxValue () - Set/Get the Cool-down rate. The higher this
number is, the longer it will take to "cool-down", and thus, the more the graph will be modified.
double = obj.GetCoolDownRate () - Set/Get the Cool-down rate. The higher this number is, the
longer it will take to "cool-down", and thus, the more the graph will be modified.
obj.SetThreeDimensionalLayout (int ) - Turn on/off layout of graph in three dimensions. If off,
graph layout occurs in two dimensions. By default, three dimensional layout is off.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.41 vtkGenerateIndexArray
1751
37.41
vtkGenerateIndexArray
37.41.1
Usage
1752
37.41.2
Methods
The class vtkGenerateIndexArray has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGenerateIndexArray
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGenerateIndexArray = obj.NewInstance ()
vtkGenerateIndexArray = obj.SafeDownCast (vtkObject o)
obj.SetArrayName (string ) - Control the output index array name. Default: "index".
string = obj.GetArrayName () - Control the output index array name. Default: "index".
obj.SetFieldType (int ) - Control the location where the index array will be stored.
int = obj.GetFieldType () - Control the location where the index array will be stored.
obj.SetReferenceArrayName (string ) - Specifies an optional reference array for indexgeneration.
string = obj.GetReferenceArrayName () - Specifies an optional reference array for indexgeneration.
obj.SetPedigreeID (int ) - Specifies whether the index array should be marked as pedigree ids.
Default: false.
int = obj.GetPedigreeID () - Specifies whether the index array should be marked as pedigree
ids. Default: false.
37.42
vtkGeoEdgeStrategy
37.42.1
Usage
vtkGeoEdgeStrategy produces arcs for each edge in the input graph. This is useful for viewing lines on a sphere
(e.g. the earth). The arcs may "jump" above the spheres surface using ExplodeFactor.
To create an instance of class vtkGeoEdgeStrategy, simply invoke its constructor as follows
obj = vtkGeoEdgeStrategy
37.42.2
Methods
The class vtkGeoEdgeStrategy has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkGeoEdgeStrategy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoEdgeStrategy = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.43 vtkGeoMath
1753
37.43
vtkGeoMath
37.43.1
Usage
37.43.2
Methods
The class vtkGeoMath has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkGeoMath class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGeoMath = obj.NewInstance ()
vtkGeoMath = obj.SafeDownCast (vtkObject o)
37.44
vtkGraphHierarchicalBundle
1754
37.44.1
Usage
This algorithm creates a vtkPolyData from a vtkGraph. As opposed to vtkGraphToPolyData, which converts each
arc into a straight line, each arc is converted to a polyline, following a tree structure. The filter requires both a
vtkGraph and vtkTree as input. The tree vertices must be a superset of the graph vertices. A common example is
when the graph vertices correspond to the leaves of the tree, but the internal vertices of the tree represent groupings
of graph vertices. The algorithm matches the vertices using the array "PedigreeId". The user may alternately set
the DirectMapping flag to indicate that the two structures must have directly corresponding offsets (i.e. node i in the
graph must correspond to node i in the tree).
The vtkGraph defines the topology of the output vtkPolyData (i.e. the connections between nodes) while the vtkTree
defines the geometry (i.e. the location of nodes and arc routes). Thus, the tree must have been assigned vertex
locations, but the graph does not need locations, in fact they will be ignored. The edges approximately follow the
path from the source to target nodes in the tree. A bundling parameter controls how closely the edges are bundled
together along the tree structure.
You may follow this algorithm with vtkSplineFilter in order to make nicely curved edges.
To create an instance of class vtkGraphHierarchicalBundle, simply invoke its constructor as follows
obj = vtkGraphHierarchicalBundle
37.44.2
Methods
The class vtkGraphHierarchicalBundle has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGraphHierarchicalBundle
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGraphHierarchicalBundle = obj.NewInstance ()
vtkGraphHierarchicalBundle = obj.SafeDownCast (vtkObject o)
obj.SetBundlingStrength (double ) - The level of arc bundling in the graph. A strength of 0
creates straight lines, while a strength of 1 forces arcs to pass directly through hierarchy node points. The
default value is 0.8.
double = obj.GetBundlingStrengthMinValue () - The level of arc bundling in the graph. A
strength of 0 creates straight lines, while a strength of 1 forces arcs to pass directly through hierarchy node
points. The default value is 0.8.
double = obj.GetBundlingStrengthMaxValue () - The level of arc bundling in the graph. A
strength of 0 creates straight lines, while a strength of 1 forces arcs to pass directly through hierarchy node
points. The default value is 0.8.
double = obj.GetBundlingStrength () - The level of arc bundling in the graph. A strength of 0
creates straight lines, while a strength of 1 forces arcs to pass directly through hierarchy node points. The
default value is 0.8.
obj.SetDirectMapping (bool ) - If on, uses direct mapping from tree to graph vertices. If off, both
the graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default
is off.
bool = obj.GetDirectMapping () - If on, uses direct mapping from tree to graph vertices. If off,
both the graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices.
Default is off.
obj.DirectMappingOn () - If on, uses direct mapping from tree to graph vertices. If off, both the graph
and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default is off.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.45 vtkGraphHierarchicalBundleEdges
1755
obj.DirectMappingOff () - If on, uses direct mapping from tree to graph vertices. If off, both the
graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default is
off.
int = obj.FillInputPortInformation (int port, vtkInformation info) - Set
the input type of the algorithm to vtkGraph.
37.45
vtkGraphHierarchicalBundleEdges
37.45.1
Usage
This algorithm creates a vtkPolyData from a vtkGraph. As opposed to vtkGraphToPolyData, which converts each
arc into a straight line, each arc is converted to a polyline, following a tree structure. The filter requires both a
vtkGraph and vtkTree as input. The tree vertices must be a superset of the graph vertices. A common example is
when the graph vertices correspond to the leaves of the tree, but the internal vertices of the tree represent groupings
of graph vertices. The algorithm matches the vertices using the array "PedigreeId". The user may alternately set
the DirectMapping flag to indicate that the two structures must have directly corresponding offsets (i.e. node i in the
graph must correspond to node i in the tree).
The vtkGraph defines the topology of the output vtkPolyData (i.e. the connections between nodes) while the vtkTree
defines the geometry (i.e. the location of nodes and arc routes). Thus, the tree must have been assigned vertex
locations, but the graph does not need locations, in fact they will be ignored. The edges approximately follow the
path from the source to target nodes in the tree. A bundling parameter controls how closely the edges are bundled
together along the tree structure.
You may follow this algorithm with vtkSplineFilter in order to make nicely curved edges.
To create an instance of class vtkGraphHierarchicalBundleEdges, simply invoke its constructor as follows
obj = vtkGraphHierarchicalBundleEdges
37.45.2
Methods
The class vtkGraphHierarchicalBundleEdges has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGraphHierarchicalBundleEdges class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGraphHierarchicalBundleEdges = obj.NewInstance ()
vtkGraphHierarchicalBundleEdges = obj.SafeDownCast (vtkObject o)
obj.SetBundlingStrength (double ) - The level of arc bundling in the graph. A strength of 0
creates straight lines, while a strength of 1 forces arcs to pass directly through hierarchy node points. The
default value is 0.8.
double = obj.GetBundlingStrengthMinValue () - The level of arc bundling in the graph. A
strength of 0 creates straight lines, while a strength of 1 forces arcs to pass directly through hierarchy node
points. The default value is 0.8.
double = obj.GetBundlingStrengthMaxValue () - The level of arc bundling in the graph. A
strength of 0 creates straight lines, while a strength of 1 forces arcs to pass directly through hierarchy node
points. The default value is 0.8.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1756
37.46
vtkGraphLayout
37.46.1
Usage
This class is a shell for many graph layout strategies which may be set using the SetLayoutStrategy() function. The
layout strategies do the actual work.
.SECION Thanks Thanks to Brian Wylie from Sandia National Laboratories for adding incremental layout capabilities.
To create an instance of class vtkGraphLayout, simply invoke its constructor as follows
obj = vtkGraphLayout
37.46.2
Methods
The class vtkGraphLayout has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkGraphLayout class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGraphLayout = obj.NewInstance ()
vtkGraphLayout = obj.SafeDownCast (vtkObject o)
obj.SetLayoutStrategy (vtkGraphLayoutStrategy strategy) - The layout strategy to
use during graph layout.
vtkGraphLayoutStrategy = obj.GetLayoutStrategy () - The layout strategy to use during
graph layout.
int = obj.IsLayoutComplete () - Ask the layout algorithm if the layout is complete
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.47 vtkGraphLayoutStrategy
1757
37.47
vtkGraphLayoutStrategy
37.47.1
Usage
All graph layouts should subclass from this class. vtkGraphLayoutStrategy works as a plug-in to the vtkGraphLayout
algorithm. The Layout() function should perform some reasonable "chunk" of the layout. This allows the user to be
able to see the progress of the layout. Use IsLayoutComplete() to tell the user when there is no more layout to
perform.
.SECTION Thanks Thanks to Brian Wylie from Sandia National Laboratories for adding incremental layout capabilities.
To create an instance of class vtkGraphLayoutStrategy, simply invoke its constructor as follows
obj = vtkGraphLayoutStrategy
37.47.2
Methods
The class vtkGraphLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGraphLayoutStrategy
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGraphLayoutStrategy = obj.NewInstance ()
vtkGraphLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.SetGraph (vtkGraph graph) - Setting the graph for the layout strategy
obj.Initialize () - This method allows the layout strategy to do initialization of data structures or
whatever else it might want to do.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1758
obj.Layout () - This is the layout method where the graph that was set in SetGraph() is laid out. The
method can either entirely layout the graph or iteratively lay out the graph. If you have an iterative layout
please implement the IsLayoutComplete() method.
int = obj.IsLayoutComplete () - Whether to use edge weights in the layout or not.
obj.SetWeightEdges (bool state) - Whether to use edge weights in the layout or not.
bool = obj.GetWeightEdges () - Whether to use edge weights in the layout or not.
obj.SetEdgeWeightField (string field) - Set/Get the field to use for the edge weights.
string = obj.GetEdgeWeightField () - Set/Get the field to use for the edge weights.
37.48
vtkGroupLeafVertices
37.48.1
Usage
Use SetInputArrayToProcess(0, ...) to set the array to group on. Currently this array must be a vtkStringArray.
To create an instance of class vtkGroupLeafVertices, simply invoke its constructor as follows
obj = vtkGroupLeafVertices
37.48.2
Methods
The class vtkGroupLeafVertices has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkGroupLeafVertices class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkGroupLeafVertices = obj.NewInstance ()
vtkGroupLeafVertices = obj.SafeDownCast (vtkObject o)
obj.SetGroupDomain (string ) - The name of the domain that non-leaf vertices will be assigned
to. If the input graph already contains vertices in this domain:
If the ids for this domain are numeric, starts assignment with max id
If the ids for this domain are strings, starts assignment with "group X" where "X" is the max id. Default
is "group_vertex".
string = obj.GetGroupDomain () - The name of the domain that non-leaf vertices will be assigned to. If the input graph already contains vertices in this domain:
If the ids for this domain are numeric, starts assignment with max id
If the ids for this domain are strings, starts assignment with "group X" where "X" is the max id. Default
is "group_vertex".
37.49
vtkISIReader
37.50 vtkKMeansDistanceFunctor
37.49.1
1759
Usage
ISI is a tagged format for expressing bibliographic citations. Data is structured as a collection of records with each
record composed of one-to-many fields. See
http://isibasic.com/help/helpprn.html#dialog_export_format
for details. vtkISIReader will convert an ISI file into a vtkTable, with the set of table columns determined dynamically
from the contents of the file.
To create an instance of class vtkISIReader, simply invoke its constructor as follows
obj = vtkISIReader
37.49.2
Methods
The class vtkISIReader has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkISIReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkISIReader = obj.NewInstance ()
vtkISIReader = obj.SafeDownCast (vtkObject o)
string = obj.GetFileName () - Set/get the file to load
obj.SetFileName (string ) - Set/get the file to load
string = obj.GetDelimiter () - Set/get the delimiter to be used for concatenating field data
(default: ";")
obj.SetDelimiter (string ) - Set/get the delimiter to be used for concatenating field data (default:
";")
int = obj.GetMaxRecords () - Set/get the maximum number of records to read from the file (zero
= unlimited)
obj.SetMaxRecords (int ) - Set/get the maximum number of records to read from the file (zero =
unlimited)
37.50
vtkKMeansDistanceFunctor
37.50.1
Usage
This is an abstract class (with a default concrete subclass) that implements algorithms used by the vtkKMeansStatistics filter that rely on a distance metric. If you wish to use a non-Euclidean distance metric (this could include
working with strings that do not have a Euclidean distance metric, implementing k-mediods, or trying distance
metrics in norms other than L2), you should subclass vtkKMeansDistanceFunctor.
To create an instance of class vtkKMeansDistanceFunctor, simply invoke its constructor as follows
obj = vtkKMeansDistanceFunctor
1760
37.50.2
Methods
The class vtkKMeansDistanceFunctor has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkKMeansDistanceFunctor
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkKMeansDistanceFunctor = obj.NewInstance ()
vtkKMeansDistanceFunctor = obj.SafeDownCast (vtkObject o)
vtkVariantArray = obj.GetEmptyTuple (vtkIdType dimension) - Return an empty tuple. These values are used as cluster center coordinates when no initial cluster centers are specified.
obj.PairwiseUpdate (vtkTable clusterCenters, vtkIdType row, vtkVariantArray data, vtkIdType dataCardinality, vtkIdType totalCardinality) - This is
called once per observation per run per iteration in order to assign the observation to its nearest cluster
center after the distance functor has been evaluated for all the cluster centers.
The distance functor is responsible for incrementally updating the cluster centers to account for the assignment.
obj.PerturbElement (vtkTable , vtkTable , vtkIdType , vtkIdType , vtkIdType , double ) - When a cluster center (1) has no observations that are closer to it than other
cluster centers or (2) has exactly the same coordinates as another cluster center, its coordinates should be
perturbed. This function should perform that perturbation.
Since perturbation relies on a distance metric, this function is the responsibility of the distance functor.
vtkAbstractArray = obj.CreateCoordinateArray () - Return a vtkAbstractArray capable
of holding cluster center coordinates. This is used by vtkPKMeansStatistics to hold cluster center coordinates
sent to (received from) other processes.
int = obj.GetDataType () - Return the data type used to store cluster center coordinates.
37.51
vtkKMeansDistanceFunctorCalculator
37.51.1
Usage
This is a subclass of the default k-means distance functor that allows the user to specify a distance function as a
string. The provided expression is evaluated whenever the parenthesis operator is invoked but this is much slower
than the default distance calculation.
User-specified distance expressions should be written in terms of two vector variables named "x" and "y". The
length of the vectors will be determined by the k-means request and all columns of interest in the request must
contain values that may be converted to a floating point representation. (Strings and vtkObject pointers are not
allowed.) An example distance expression is "sqrt( (x0-y0) 2 + (x1-y1) 2 )" which computes Euclidian distance in
a plane defined by the first 2 coordinates of the vectors specified.
To create an instance of class vtkKMeansDistanceFunctorCalculator, simply invoke its constructor as follows
obj = vtkKMeansDistanceFunctorCalculator
37.52 vtkKMeansStatistics
37.51.2
1761
Methods
The class vtkKMeansDistanceFunctorCalculator has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkKMeansDistanceFunctorCalculator class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkKMeansDistanceFunctorCalculator = obj.NewInstance ()
vtkKMeansDistanceFunctorCalculator = obj.SafeDownCast (vtkObject o)
obj.SetDistanceExpression (string ) - Set/get the distance function expression.
string = obj.GetDistanceExpression () - Set/get the distance function expression.
obj.SetFunctionParser (vtkFunctionParser ) - Set/get the string containing an expression
which evaluates to the distance metric used for k-means computation. The scalar variables "x0", "x1", ... "xn"
and "y0", "y1", ..., "yn" refer to the coordinates involved in the computation.
vtkFunctionParser = obj.GetFunctionParser () - Set/get the string containing an expression which evaluates to the distance metric used for k-means computation. The scalar variables "x0", "x1", ...
"xn" and "y0", "y1", ..., "yn" refer to the coordinates involved in the computation.
37.52
vtkKMeansStatistics
37.52.1
Usage
This class takes as input an optional vtkTable on port LEARN_PARAMETERS specifying initial set(s) of cluster
values of the following form:
K
| Col1
| ...
| ColN
-----------+-----------------+---------+--------------M
|clustCoord(1, 1) | ...
| clustCoord(1, N)
M
|clustCoord(2, 1) | ...
| clustCoord(2, N)
.
|
.
|
.
|
.
.
|
.
|
.
|
.
.
|
.
|
.
|
.
M
|clustCoord(M, 1) | ...
| clustCoord(M, N)
L
|clustCoord(1, 1) | ...
| clustCoord(1, N)
L
|clustCoord(2, 1) | ...
| clustCoord(2, N)
.
|
.
|
.
|
.
.
|
.
|
.
|
.
.
|
.
|
.
|
.
L
|clustCoord(L, 1) | ...
| clustCoord(L, N)
Because the desired value of K is often not known in advance and the results of the algorithm are dependent on the
initial cluster centers, we provide a mechanism for the user to test multiple runs or sets of cluster centers within a
single call to the Learn phase. The first column of the table identifies the number of clusters K in the particular run
(the entries in this column should be of type vtkIdType), while the remaining columns are a subset of the columns
contained in the table on port INPUT_DATA. We require that all user specified clusters be of the same dimension
N and consequently, that the LEARN_PARAMETERS table have N+1 columns. Due to this restriction, only one
request can be processed for each call to the Learn phase and subsequent requests are silently ignored. Note
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1762
that, if the first column of the LEARN_PARAMETERS table is not of type vtkIdType, then the table will be ignored
and a single run will be performed using the first DefaultNumberOfClusters input data observations as initial cluster
centers.
When the user does not supply an initial set of clusters, then the first DefaultNumberOfClusters input data observations are used as initial cluster centers and a single run is performed.
This class provides the following functionalities, depending on the mode it is executed in: Learn: calculates new
cluster centers for each run. The output metadata on port OUTPUT_MODEL is a multiblock dataset containing at a
minimum one vtkTable with columns specifying the following for each run: the run ID, number of clusters, number of
iterations required for convergence, total error associated with the cluster (sum of squared Euclidean distance from
each observation to its nearest cluster center), the cardinality of the cluster, and the new cluster coordinates.
Derive: An additional vtkTable is stored in the multiblock dataset output on port OUTPUT_MODEL. This table
contains columns that store for each run: the runID, number of clusters, total error for all clusters in the run, local
rank, and global rank. The local rank is computed by comparing squared Euclidean errors of all runs with the same
number of clusters. The global rank is computed analagously across all runs.
Assess: This requires a multiblock dataset (as computed from Learn and Derive) on input port INPUT_MODEL and
tabular data on input port INPUT_DATA that contains column names matching those of the tables on input port
INPUT_MODEL. The assess mode reports the closest cluster center and associated squared Euclidean distance of
each observation in port INPUT_DATAs table to the cluster centers for each run in the multiblock dataset provided
on port INPUT_MODEL.
The code can handle a wide variety of data types as it operates on vtkAbstractArrays and is not limited to vtkDataArrays. A default distance functor that computes the sum of the squares of the Euclidean distance between two
objects is provided (vtkKMeansDistanceFunctor). The default distance functor can be overridden to use alternative
distance metrics.
.SECTION Thanks Thanks to Janine Bennett, David Thompson, and Philippe Pebay of Sandia National Laboratories
for implementing this class.
To create an instance of class vtkKMeansStatistics, simply invoke its constructor as follows
obj = vtkKMeansStatistics
37.52.2
Methods
The class vtkKMeansStatistics has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkKMeansStatistics class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkKMeansStatistics = obj.NewInstance ()
vtkKMeansStatistics = obj.SafeDownCast (vtkObject o)
obj.SetDistanceFunctor (vtkKMeansDistanceFunctor ) - Set the DistanceFunctor.
vtkKMeansDistanceFunctor = obj.GetDistanceFunctor () - Set the DistanceFunctor.
obj.SetDefaultNumberOfClusters (int ) - Set/get the DefaultNumberOfClusters, used when
no initial cluster coordinates are specified.
int = obj.GetDefaultNumberOfClusters () - Set/get the DefaultNumberOfClusters, used
when no initial cluster coordinates are specified.
obj.SetKValuesArrayName (string ) - Set/get the KValuesArrayName.
string = obj.GetKValuesArrayName () - Set/get the KValuesArrayName.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.53 vtkMatricizeArray
1763
37.53
vtkMatricizeArray
37.53.1
Usage
Given a sparse input array of arbitrary dimension, creates a sparse output matrix (vtkSparseArray<double>) where
each column is a slice along an arbitrary dimension from the source.
.SECTION Thanks Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.
To create an instance of class vtkMatricizeArray, simply invoke its constructor as follows
obj = vtkMatricizeArray
37.53.2
Methods
The class vtkMatricizeArray has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkMatricizeArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMatricizeArray = obj.NewInstance ()
vtkMatricizeArray = obj.SafeDownCast (vtkObject o)
vtkIdType = obj.GetSliceDimension () - Returns the 0-numbered dimension that will be
mapped to columns in the output
obj.SetSliceDimension (vtkIdType ) - Sets the 0-numbered dimension that will be mapped to
columns in the output
37.54
vtkMergeColumns
1764
37.54.1
Usage
vtkMergeColumns replaces two columns in a table with a single column containing data in both columns. The
columns are set using
SetInputArrayToProcess(0, 0, 0, vtkDataObject::FIELD_ASSOCIATION_ROWS, "col1")
and
SetInputArrayToProcess(1, 0, 0, vtkDataObject::FIELD_ASSOCIATION_ROWS, "col2")
where "col1" and "col2" are the names of the columns to merge. The user may also specify the name of the merged
column. The arrays must be of the same type. If the arrays are numeric, the values are summed in the merged
column. If the arrays are strings, the values are concatenated. The strings are separated by a space if they are both
nonempty.
To create an instance of class vtkMergeColumns, simply invoke its constructor as follows
obj = vtkMergeColumns
37.54.2
Methods
The class vtkMergeColumns has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkMergeColumns class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMergeColumns = obj.NewInstance ()
vtkMergeColumns = obj.SafeDownCast (vtkObject o)
obj.SetMergedColumnName (string ) - The name to give the merged column created by this
filter.
string = obj.GetMergedColumnName () - The name to give the merged column created by this
filter.
37.55
vtkMergeGraphs
37.55.1
Usage
vtkMergeGraphs combines information from two graphs into one. Both graphs must have pedigree ids assigned to
the vertices. The output will contain the vertices/edges in the first graph, in addition to:
vertices in the second graph whose pedigree id does not match a vertex in the first input
edges in the second graph
The output will contain the same attribute structure as the input; fields associated only with the second input graph
will not be passed to the output. When possible, the vertex/edge data for new vertices and edges will be populated
with matching attributes on the second graph. To be considered a matching attribute, the array must have the same
name, type, and number of components.
To create an instance of class vtkMergeGraphs, simply invoke its constructor as follows
obj = vtkMergeGraphs
37.56 vtkMergeTables
37.55.2
1765
Methods
The class vtkMergeGraphs has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkMergeGraphs class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMergeGraphs = obj.NewInstance ()
vtkMergeGraphs = obj.SafeDownCast (vtkObject o)
int = obj.ExtendGraph (vtkMutableGraphHelper g1, vtkGraph g2) - This is the
core functionality of the algorithm. Adds edges and vertices from g2 into g1.
obj.SetMaxEdges (vtkIdType ) - The maximum number of edges in the combined graph. Default
is -1, which specifies that there should be no limit on the number of edges.
vtkIdType = obj.GetMaxEdges () - The maximum number of edges in the combined graph. Default is -1, which specifies that there should be no limit on the number of edges.
37.56
vtkMergeTables
37.56.1
Usage
Combines the columns of two tables into one larger table. The number of rows in the resulting table is the sum of
the number of rows in each of the input tables. The number of columns in the output is generally the sum of the
number of columns in each input table, except in the case where column names are duplicated in both tables. In
this case, if MergeColumnsByName is on (the default), the two columns will be merged into a single column of the
same name. If MergeColumnsByName is off, both columns will exist in the output. You may set the FirstTablePrefix
and SecondTablePrefix to define how the columns named are modified. One of these prefixes may be the empty
string, but they must be different.
To create an instance of class vtkMergeTables, simply invoke its constructor as follows
obj = vtkMergeTables
37.56.2
Methods
The class vtkMergeTables has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkMergeTables class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMergeTables = obj.NewInstance ()
vtkMergeTables = obj.SafeDownCast (vtkObject o)
obj.SetFirstTablePrefix (string ) - The prefix to give to same-named fields from the first
table. Default is "Table1.".
string = obj.GetFirstTablePrefix () - The prefix to give to same-named fields from the first
table. Default is "Table1.".
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1766
obj.SetSecondTablePrefix (string ) - The prefix to give to same-named fields from the second
table. Default is "Table2.".
string = obj.GetSecondTablePrefix () - The prefix to give to same-named fields from the
second table. Default is "Table2.".
obj.SetMergeColumnsByName (bool ) - If on, merges columns with the same name. If off, keeps
both columns, but calls one FirstTablePrefix + name, and the other SecondTablePrefix + name. Default is on.
bool = obj.GetMergeColumnsByName () - If on, merges columns with the same name. If off,
keeps both columns, but calls one FirstTablePrefix + name, and the other SecondTablePrefix + name. Default
is on.
obj.MergeColumnsByNameOn () - If on, merges columns with the same name. If off, keeps both
columns, but calls one FirstTablePrefix + name, and the other SecondTablePrefix + name. Default is on.
obj.MergeColumnsByNameOff () - If on, merges columns with the same name. If off, keeps both
columns, but calls one FirstTablePrefix + name, and the other SecondTablePrefix + name. Default is on.
obj.SetPrefixAllButMerged (bool ) - If on, all columns will have prefixes except merged
columns. If off, only unmerged columns with the same name will have prefixes. Default is off.
bool = obj.GetPrefixAllButMerged () - If on, all columns will have prefixes except merged
columns. If off, only unmerged columns with the same name will have prefixes. Default is off.
obj.PrefixAllButMergedOn () - If on, all columns will have prefixes except merged columns. If off,
only unmerged columns with the same name will have prefixes. Default is off.
obj.PrefixAllButMergedOff () - If on, all columns will have prefixes except merged columns. If
off, only unmerged columns with the same name will have prefixes. Default is off.
37.57
vtkMultiCorrelativeStatistics
37.57.1
Usage
Given a selection of sets of columns of interest, this class provides the following functionalities, depending on
the execution mode it is executed in: Learn: calculates means, unbiased variance and covariance estimators of
column pairs coefficient. More precisely, Learn calculates the averages and centered variance/covariance sums; if
finalize is set to true (default), the final statistics are calculated. The output metadata on port OUTPUT_MODEL is a multiblock dataset containing at a minimum one vtkTable holding the raw sums in a sparse matrix style.
If finalize is true, then one additional vtkTable will be present for each requested set of column correlations. These
additional tables contain column averages, the upper triangular portion of the covariance matrix (in the upper right
hand portion of the table) and the Cholesky decomposition of the covariance matrix (in the lower portion of the table
beneath the covariance triangle). The leftmost column will be a vector of column averages. The last entry in the
column averages vector is the number of samples. As an example, consider a request for a 3-column correlation
with columns named ColA, ColB, and ColC. The resulting table will look like this:
Column |Mean
|ColA
|ColB
|ColC
--------+---------+---------+---------+--------ColA
|avg(A)
|cov(A,A) |cov(A,B) |cov(A,C)
ColB
|avg(B)
|chol(1,1)|cov(B,B) |cov(B,C)
ColC
|avg(C)
|chol(2,1)|chol(2,2)|cov(C,C)
Cholesky|length(A)|chol(3,1)|chol(3,2)|chol(3,3)
Assess: given a set of results matrices as specified above in input port INPUT_MODEL and tabular data on input
port INPUT_DATA that contains column names matching those of the tables on input port INPUT_MODEL, the
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.58 vtkMutableGraphHelper
1767
assess mode computes the relative deviation of each observation in port INPUT_DATAs table according to the
linear correlations implied by each table in port INPUT_MODEL.
.SECTION Thanks Thanks to Philippe Pebay, Jackson Mayo, and David Thompson of Sandia National Laboratories
for implementing this class.
To create an instance of class vtkMultiCorrelativeStatistics, simply invoke its constructor as follows
obj = vtkMultiCorrelativeStatistics
37.57.2
Methods
The class vtkMultiCorrelativeStatistics has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMultiCorrelativeStatistics
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMultiCorrelativeStatistics = obj.NewInstance ()
vtkMultiCorrelativeStatistics = obj.SafeDownCast (vtkObject o)
obj.Aggregate (vtkDataObjectCollection , vtkDataObject ) - Given a collection of
models, calculate aggregate model
37.58
vtkMutableGraphHelper
37.58.1
Usage
vtkMutableGraphHelper has helper methods AddVertex and AddEdge which add vertices/edges to the underlying
mutable graph. This is helpful in filters which need to (re)construct graphs which may be either directed or undirected.
To create an instance of class vtkMutableGraphHelper, simply invoke its constructor as follows
obj = vtkMutableGraphHelper
37.58.2
Methods
The class vtkMutableGraphHelper has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkMutableGraphHelper
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkMutableGraphHelper = obj.NewInstance ()
vtkMutableGraphHelper = obj.SafeDownCast (vtkObject o)
obj.SetGraph (vtkGraph g) - Set the underlying graph that you want to modify with this helper. The
graph must be an instance of vtkMutableDirectedGraph or vtkMutableUndirectedGraph.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1768
vtkGraph = obj.GetGraph () - Set the underlying graph that you want to modify with this helper.
The graph must be an instance of vtkMutableDirectedGraph or vtkMutableUndirectedGraph.
vtkGraphEdge = obj.AddGraphEdge (vtkIdType u, vtkIdType v) - Add an edge to the
underlying mutable graph.
vtkIdType = obj.AddVertex () - Add a vertex to the underlying mutable graph.
obj.RemoveVertex (vtkIdType v) - Remove a vertex from the underlying mutable graph.
obj.RemoveVertices (vtkIdTypeArray verts) - Remove a collection of vertices from the underlying mutable graph.
obj.RemoveEdge (vtkIdType e) - Remove an edge from the underlying mutable graph.
obj.RemoveEdges (vtkIdTypeArray edges) - Remove a collection of edges from the underlying
mutable graph.
37.59
vtkNetworkHierarchy
37.59.1
Usage
Use SetInputArrayToProcess(0, ...) to set the array to that has the network ip addresses. Currently this array must
be a vtkStringArray.
To create an instance of class vtkNetworkHierarchy, simply invoke its constructor as follows
obj = vtkNetworkHierarchy
37.59.2
Methods
The class vtkNetworkHierarchy has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkNetworkHierarchy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkNetworkHierarchy = obj.NewInstance ()
vtkNetworkHierarchy = obj.SafeDownCast (vtkObject o)
string = obj.GetIPArrayName () - Used to store the ip array name
obj.SetIPArrayName (string ) - Used to store the ip array name
37.60
vtkOrderStatistics
37.61 vtkPairwiseExtractHistogram2D
37.60.1
1769
Usage
Given a selection of columns of interest in an input data table, this class provides the following functionalities,
depending on the execution mode it is executed in: Learn: calculate 5-point statistics (minimum, 1st quartile,
median, third quartile, maximum) and all other deciles (1,2,3,4,6,7,8,9). Assess: given an input data set in port
INPUT_DATA, and two percentiles p1 < p2, assess all entries in the data set which are outside of [p1,p2].
.SECTION Thanks Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.
To create an instance of class vtkOrderStatistics, simply invoke its constructor as follows
obj = vtkOrderStatistics
37.60.2
Methods
The class vtkOrderStatistics has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkOrderStatistics class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkOrderStatistics = obj.NewInstance ()
vtkOrderStatistics = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfIntervals (vtkIdType ) - Set the number of quantiles (with uniform spacing).
vtkIdType = obj.GetNumberOfIntervals () - Get the number of quantiles (with uniform spacing).
obj.SetQuantileDefinition (int ) - Set the quantile definition.
vtkIdType = obj.GetQuantileDefinition () - Given a collection of models, calculate aggregate model NB: not implemented
obj.Aggregate (vtkDataObjectCollection , vtkDataObject ) - Given a collection of
models, calculate aggregate model NB: not implemented
37.61
vtkPairwiseExtractHistogram2D
37.61.1
Usage
This class computes a 2D histogram between all adjacent pairs of columns of an input vtkTable. Internally it creates
multiple vtkExtractHistogram2D instances (one for each pair of adjacent table columns). It also manages updating
histogram computations intelligently, only recomputing those histograms for whom a relevant property has been
altered.
Note that there are two different outputs from this filter. One is a table for which each column contains a flattened
2D histogram array. The other is a vtkMultiBlockDataSet for which each block is a vtkImageData representation of
the 2D histogram.
To create an instance of class vtkPairwiseExtractHistogram2D, simply invoke its constructor as follows
obj = vtkPairwiseExtractHistogram2D
1770
37.61.2
Methods
The class vtkPairwiseExtractHistogram2D has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPairwiseExtractHistogram2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPairwiseExtractHistogram2D = obj.NewInstance ()
vtkPairwiseExtractHistogram2D = obj.SafeDownCast (vtkObject o)
obj.SetNumberOfBins (int , int ) - Set/get the bin dimensions of the histograms to compute
obj.SetNumberOfBins (int a[2]) - Set/get the bin dimensions of the histograms to compute
int = obj.
37.62 vtkPassArrays
1771
vtkImageData = obj.GetOutputHistogramImage (int idx) - Get the vtkImageData output of the idxth histogram filter
vtkExtractHistogram2D = obj.GetHistogramFilter (int idx) - Get a pointer to the
idxth histogram filter.
obj.Aggregate (vtkDataObjectCollection , vtkDataObject ) - Given a collection of
models, calculate aggregate model. Not used
37.62
vtkPassArrays
37.62.1
Usage
This filter preserves all the topology of the input, but only a subset of arrays are passed to the output. Add an array
to be passed to the output data object with AddArray(). If RemoveArrays is on, the specified arrays will be the ones
that are removed instead of the ones that are kept.
Arrays with special attributes (scalars, pedigree ids, etc.) will retain those attributes in the output.
By default, only those field types with at least one array specified through AddArray will be processed. If instead
UseFieldTypes is turned on, you explicitly set which field types to process with AddFieldType.
Example 1:
passArray->AddArray(vtkDataObject::POINT, "velocity");
The output will have only that one array "velocity" in the point data, but cell and field data will be untouched.
Example 2:
passArray->AddArray(vtkDataObject::POINT, "velocity");
passArray->UseFieldTypesOn();
passArray->AddFieldType(vtkDataObject::POINT);
passArray->AddFieldType(vtkDataObject::CELL);
The point data would still contain the single array, but the cell data would be cleared since you did not specify any
arrays to pass. Field data would still be untouched.
To create an instance of class vtkPassArrays, simply invoke its constructor as follows
obj = vtkPassArrays
37.62.2
Methods
The class vtkPassArrays has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkPassArrays class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPassArrays = obj.NewInstance ()
vtkPassArrays = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1772
obj.AddArray (int fieldType, string name) - Adds an array to pass through. fieldType
where the array that should be passed (point data, cell data, etc.). It should be one of the constants defined in the vtkDataObject::AttributeTypes enumeration.
obj.ClearArrays () - Clear all arrays to pass through.
obj.SetRemoveArrays (bool ) - Instead of passing only the specified arrays, remove the specified
arrays and keep all other arrays. Default is off.
bool = obj.GetRemoveArrays () - Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.
obj.RemoveArraysOn () - Instead of passing only the specified arrays, remove the specified arrays
and keep all other arrays. Default is off.
obj.RemoveArraysOff () - Instead of passing only the specified arrays, remove the specified arrays
and keep all other arrays. Default is off.
obj.SetUseFieldTypes (bool ) - Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.
bool = obj.GetUseFieldTypes () - Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.
obj.UseFieldTypesOn () - Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.
obj.UseFieldTypesOff () - Process only those field types explicitly specified with AddFieldType.
Otherwise, processes field types associated with at least one specified array. Default is off.
obj.AddFieldType (int fieldType) - Add a field type to process. fieldType where the array that
should be passed (point data, cell data, etc.). It should be one of the constants defined in the vtkDataObject::AttributeTypes enumeration. NOTE: These are only used if UseFieldType is turned on.
obj.ClearFieldTypes () - Clear all field types to process.
37.63
vtkPassThrough
37.63.1
Usage
The output type is always the same as the input object type.
To create an instance of class vtkPassThrough, simply invoke its constructor as follows
obj = vtkPassThrough
37.63.2
Methods
The class vtkPassThrough has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkPassThrough class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPassThrough = obj.NewInstance ()
vtkPassThrough = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.64 vtkPassThroughEdgeStrategy
1773
int = obj.FillInputPortInformation (int port, vtkInformation info) - Specify the first input port as optional
obj.SetDeepCopyInput (int ) - Whether or not to deep copy the input. This can be useful if you
want to create a copy of a data object. You can then disconnect this filters input connections and it will act
like a source. Defaults to OFF.
int = obj.GetDeepCopyInput () - Whether or not to deep copy the input. This can be useful if
you want to create a copy of a data object. You can then disconnect this filters input connections and it will
act like a source. Defaults to OFF.
obj.DeepCopyInputOn () - Whether or not to deep copy the input. This can be useful if you want to
create a copy of a data object. You can then disconnect this filters input connections and it will act like a
source. Defaults to OFF.
obj.DeepCopyInputOff () - Whether or not to deep copy the input. This can be useful if you want
to create a copy of a data object. You can then disconnect this filters input connections and it will act like a
source. Defaults to OFF.
37.64
vtkPassThroughEdgeStrategy
37.64.1
Usage
Simply passes existing edge layout information from the input to the output without making changes.
To create an instance of class vtkPassThroughEdgeStrategy, simply invoke its constructor as follows
obj = vtkPassThroughEdgeStrategy
37.64.2
Methods
The class vtkPassThroughEdgeStrategy has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPassThroughEdgeStrategy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPassThroughEdgeStrategy = obj.NewInstance ()
vtkPassThroughEdgeStrategy = obj.SafeDownCast (vtkObject o)
obj.Layout () - This is the layout method where the graph that was set in SetGraph() is laid out.
37.65
vtkPassThroughLayoutStrategy
1774
37.65.1
Usage
Yes, this incredible strategy does absoluted nothing to the data so in affect passes through the graph untouched.
This strategy is useful in the cases where the graph is already laid out.
To create an instance of class vtkPassThroughLayoutStrategy, simply invoke its constructor as follows
obj = vtkPassThroughLayoutStrategy
37.65.2
Methods
The class vtkPassThroughLayoutStrategy has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPassThroughLayoutStrategy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPassThroughLayoutStrategy = obj.NewInstance ()
vtkPassThroughLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.Initialize () - This strategy sets up some data structures for faster processing of each Layout()
call
obj.Layout () - This is the layout method where the graph that was set in SetGraph() is laid out. The
method can either entirely layout the graph or iteratively lay out the graph. If you have an iterative layout
please implement the IsLayoutComplete() method.
int = obj.IsLayoutComplete ()
37.66
vtkPBivariateLinearTableThreshold
37.66.1
Usage
37.66.2
Methods
The class vtkPBivariateLinearTableThreshold has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPBivariateLinearTableThreshold class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPBivariateLinearTableThreshold = obj.NewInstance ()
vtkPBivariateLinearTableThreshold = obj.SafeDownCast (vtkObject o)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.67 vtkPCAStatistics
1775
37.67
vtkPCAStatistics
37.67.1
Usage
This class derives from the multi-correlative statistics algorithm and uses the covariance matrix and Cholesky decomposition computed by it. However, when it finalizes the statistics in Learn mode, the PCA class computes the
SVD of the covariance matrix in order to obtain its eigenvectors.
In the assess mode, the input data are
projected into the basis defined by the eigenvectors,
the energy associated with each datum is computed,
or some combination thereof. Additionally, the user may specify some threshold energy or eigenvector entry
below which the basis is truncated. This allows projection into a lower-dimensional state while minimizing (in
a least squares sense) the projection error.
.SECTION Thanks Thanks to David Thompson, Philippe Pebay and Jackson Mayo from Sandia National Laboratories for implementing this class.
To create an instance of class vtkPCAStatistics, simply invoke its constructor as follows
obj = vtkPCAStatistics
37.67.2
Methods
The class vtkPCAStatistics has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkPCAStatistics class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPCAStatistics = obj.NewInstance ()
vtkPCAStatistics = obj.SafeDownCast (vtkObject o)
obj.SetNormalizationScheme (int ) - This determines how (or if) the covariance matrix cov is
normalized before PCA.
When set to NONE, no normalization is performed. This is the default.
When set to TRIANGLE_SPECIFIED, each entry cov(i,j) is divided by V(i,j). The list V of normalization factors
must be set using the SetNormalization method before the filter is executed.
When set to DIAGONAL_SPECIFIED, each entry cov(i,j) is divided by sqrt(V(i)V(j)). The list V of normalization factors must be set using the SetNormalization method before the filter is executed.
When set to DIAGONAL_VARIANCE, each entry cov(i,j) is divided by sqrt(cov(i,i)cov(j,j)). Warning: Although this is accepted practice in some fields, some people think you should not turn this option on unless
there is a good physically-based reason for doing so. Much better instead to determine how component
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1776
int = obj.GetNormalizationScheme () - This determines how (or if) the covariance matrix cov
is normalized before PCA.
When set to NONE, no normalization is performed. This is the default.
When set to TRIANGLE_SPECIFIED, each entry cov(i,j) is divided by V(i,j). The list V of normalization factors
must be set using the SetNormalization method before the filter is executed.
When set to DIAGONAL_SPECIFIED, each entry cov(i,j) is divided by sqrt(V(i)V(j)). The list V of normalization factors must be set using the SetNormalization method before the filter is executed.
When set to DIAGONAL_VARIANCE, each entry cov(i,j) is divided by sqrt(cov(i,i)cov(j,j)). Warning: Although this is accepted practice in some fields, some people think you should not turn this option on unless
there is a good physically-based reason for doing so. Much better instead to determine how component
magnitudes should be compared using physical reasoning and use DIAGONAL_SPECIFIED, TRIANGLE_SPECIFIED, or perform some pre-processing to shift and scale input data columns appropriately than to expect
magical results from a shady normalization hack.
obj.SetNormalizationSchemeByName (string sname) - This determines how (or if) the covariance matrix cov is normalized before PCA.
When set to NONE, no normalization is performed. This is the default.
When set to TRIANGLE_SPECIFIED, each entry cov(i,j) is divided by V(i,j). The list V of normalization factors
must be set using the SetNormalization method before the filter is executed.
When set to DIAGONAL_SPECIFIED, each entry cov(i,j) is divided by sqrt(V(i)V(j)). The list V of normalization factors must be set using the SetNormalization method before the filter is executed.
When set to DIAGONAL_VARIANCE, each entry cov(i,j) is divided by sqrt(cov(i,i)cov(j,j)). Warning: Although this is accepted practice in some fields, some people think you should not turn this option on unless
there is a good physically-based reason for doing so. Much better instead to determine how component
magnitudes should be compared using physical reasoning and use DIAGONAL_SPECIFIED, TRIANGLE_SPECIFIED, or perform some pre-processing to shift and scale input data columns appropriately than to expect
magical results from a shady normalization hack.
string = obj.GetNormalizationSchemeName (int scheme) - This determines how (or if)
the covariance matrix cov is normalized before PCA.
When set to NONE, no normalization is performed. This is the default.
When set to TRIANGLE_SPECIFIED, each entry cov(i,j) is divided by V(i,j). The list V of normalization factors
must be set using the SetNormalization method before the filter is executed.
When set to DIAGONAL_SPECIFIED, each entry cov(i,j) is divided by sqrt(V(i)V(j)). The list V of normalization factors must be set using the SetNormalization method before the filter is executed.
When set to DIAGONAL_VARIANCE, each entry cov(i,j) is divided by sqrt(cov(i,i)cov(j,j)). Warning: Although this is accepted practice in some fields, some people think you should not turn this option on unless
there is a good physically-based reason for doing so. Much better instead to determine how component
magnitudes should be compared using physical reasoning and use DIAGONAL_SPECIFIED, TRIANGLE_SPECIFIED, or perform some pre-processing to shift and scale input data columns appropriately than to expect
magical results from a shady normalization hack.
vtkTable = obj.GetSpecifiedNormalization () - These methods allow you to set/get values used to normalize the covariance matrix before PCA. The normalization values apply to all requests, so
you do not specify a single vector but a 3-column table.
The first two columns contain the names of columns from input 0 and the third column contains the value
to normalize the corresponding entry in the covariance matrix. The table must always have 3 columns even
when the NormalizationScheme is DIAGONAL_SPECIFIED. When only diagonal entries are to be used, only
table rows where the first two columns are identical to one another will be employed. If there are multiple
rows specifying different values for the same pair of columns, the entry nearest the bottom of the table takes
precedence.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.67 vtkPCAStatistics
1777
These functions are actually convenience methods that set/get the third input of the filter. Because the table
is the third input, you may use other filters to produce a table of normalizations and have the pipeline take
care of updates.
Any missing entries will be set to 1.0 and a warning issued. An error will occur if the third input to the filter is
not set and the NormalizationScheme is DIAGONAL_SPECIFIED or TRIANGLE_SPECIFIED.
obj.SetSpecifiedNormalization (vtkTable ) - These methods allow you to set/get values
used to normalize the covariance matrix before PCA. The normalization values apply to all requests, so you
do not specify a single vector but a 3-column table.
The first two columns contain the names of columns from input 0 and the third column contains the value
to normalize the corresponding entry in the covariance matrix. The table must always have 3 columns even
when the NormalizationScheme is DIAGONAL_SPECIFIED. When only diagonal entries are to be used, only
table rows where the first two columns are identical to one another will be employed. If there are multiple
rows specifying different values for the same pair of columns, the entry nearest the bottom of the table takes
precedence.
These functions are actually convenience methods that set/get the third input of the filter. Because the table
is the third input, you may use other filters to produce a table of normalizations and have the pipeline take
care of updates.
Any missing entries will be set to 1.0 and a warning issued. An error will occur if the third input to the filter is
not set and the NormalizationScheme is DIAGONAL_SPECIFIED or TRIANGLE_SPECIFIED.
obj.SetBasisScheme (int ) - This variable controls the dimensionality of output tuples in Assess
mode. Consider the case where you have requested a PCA on D columns.
When set to vtkPCAStatistics::FULL_BASIS, the entire set of basis vectors is used to derive new coordinates
for each tuple being assessed. In this mode, you are guaranteed to have output tuples of the same dimension
as the input tuples. (That dimension is D, so there will be D additional columns added to the table for the
request.)
When set to vtkPCAStatistics::FIXED_BASIS_SIZE, only the first N basis vectors are used to derive new coordinates for each tuple being assessed. In this mode, you are guaranteed to have output tuples of dimension
min(N,D). You must set N prior to assessing data using the SetFixedBasisSize() method. When N < D, this
turns the PCA into a projection (instead of change of basis).
When set to vtkPCAStatistics::FIXED_BASIS_ENERGY, the number of basis vectors used to derive new
coordinates for each tuple will be the minimum number of columns N that satisfy
Ni=1 i
<T
D
i=1 i
You must set T prior to assessing data using the SetFixedBasisEnergy() method. When T < 1, this turns the
PCA into a projection (instead of change of basis).
By default BasisScheme is set to vtkPCAStatistics::FULL_BASIS.
int = obj.GetBasisScheme () - This variable controls the dimensionality of output tuples in Assess
mode. Consider the case where you have requested a PCA on D columns.
When set to vtkPCAStatistics::FULL_BASIS, the entire set of basis vectors is used to derive new coordinates
for each tuple being assessed. In this mode, you are guaranteed to have output tuples of the same dimension
as the input tuples. (That dimension is D, so there will be D additional columns added to the table for the
request.)
When set to vtkPCAStatistics::FIXED_BASIS_SIZE, only the first N basis vectors are used to derive new coordinates for each tuple being assessed. In this mode, you are guaranteed to have output tuples of dimension
min(N,D). You must set N prior to assessing data using the SetFixedBasisSize() method. When N < D, this
turns the PCA into a projection (instead of change of basis).
When set to vtkPCAStatistics::FIXED_BASIS_ENERGY, the number of basis vectors used to derive new
coordinates for each tuple will be the minimum number of columns N that satisfy
Ni=1 i
<T
D
i=1 i
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1778
string = obj.GetBasisSchemeName (int schemeIndex) - This variable controls the dimensionality of output tuples in Assess mode. Consider the case where you have requested a PCA on D columns.
When set to vtkPCAStatistics::FULL_BASIS, the entire set of basis vectors is used to derive new coordinates
for each tuple being assessed. In this mode, you are guaranteed to have output tuples of the same dimension
as the input tuples. (That dimension is D, so there will be D additional columns added to the table for the
request.)
When set to vtkPCAStatistics::FIXED_BASIS_SIZE, only the first N basis vectors are used to derive new coordinates for each tuple being assessed. In this mode, you are guaranteed to have output tuples of dimension
min(N,D). You must set N prior to assessing data using the SetFixedBasisSize() method. When N < D, this
turns the PCA into a projection (instead of change of basis).
When set to vtkPCAStatistics::FIXED_BASIS_ENERGY, the number of basis vectors used to derive new
coordinates for each tuple will be the minimum number of columns N that satisfy
Ni=1 i
<T
D
i=1 i
You must set T prior to assessing data using the SetFixedBasisEnergy() method. When T < 1, this turns the
PCA into a projection (instead of change of basis).
By default BasisScheme is set to vtkPCAStatistics::FULL_BASIS.
obj.SetBasisSchemeByName (string schemeName) - This variable controls the dimensionality
of output tuples in Assess mode. Consider the case where you have requested a PCA on D columns.
When set to vtkPCAStatistics::FULL_BASIS, the entire set of basis vectors is used to derive new coordinates
for each tuple being assessed. In this mode, you are guaranteed to have output tuples of the same dimension
as the input tuples. (That dimension is D, so there will be D additional columns added to the table for the
request.)
When set to vtkPCAStatistics::FIXED_BASIS_SIZE, only the first N basis vectors are used to derive new coordinates for each tuple being assessed. In this mode, you are guaranteed to have output tuples of dimension
min(N,D). You must set N prior to assessing data using the SetFixedBasisSize() method. When N < D, this
turns the PCA into a projection (instead of change of basis).
When set to vtkPCAStatistics::FIXED_BASIS_ENERGY, the number of basis vectors used to derive new
coordinates for each tuple will be the minimum number of columns N that satisfy
Ni=1 i
<T
D
i=1 i
You must set T prior to assessing data using the SetFixedBasisEnergy() method. When T < 1, this turns the
PCA into a projection (instead of change of basis).
By default BasisScheme is set to vtkPCAStatistics::FULL_BASIS.
obj.SetFixedBasisSize (int ) - The number of basis vectors to use. See SetBasisScheme() for
more information. When FixedBasisSize <= 0 (the default), the fixed basis size scheme is equivalent to the
full basis scheme.
int = obj.GetFixedBasisSize () - The number of basis vectors to use. See SetBasisScheme()
for more information. When FixedBasisSize <= 0 (the default), the fixed basis size scheme is equivalent to
the full basis scheme.
obj.SetFixedBasisEnergy (double ) - The minimum energy the new basis should use, as a
fraction. See SetBasisScheme() for more information. When FixedBasisEnergy >= 1 (the default), the fixed
basis energy scheme is equivalent to the full basis scheme.
double = obj.GetFixedBasisEnergyMinValue () - The minimum energy the new basis
should use, as a fraction. See SetBasisScheme() for more information. When FixedBasisEnergy >= 1 (the
default), the fixed basis energy scheme is equivalent to the full basis scheme.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.68 vtkPComputeHistogram2DOutliers
1779
37.68
vtkPComputeHistogram2DOutliers
37.68.1
Usage
This class does exactly the same this as vtkComputeHistogram2DOutliers, but does it in a multi-process environment. After each node computes their own local outliers, class does an AllGather that distributes the outliers to
every node. This could probably just be a Gather onto the root node instead.
After this operation, the row selection will only contain local row ids, since Im not sure how to deal with distributed
ids.
To create an instance of class vtkPComputeHistogram2DOutliers, simply invoke its constructor as follows
obj = vtkPComputeHistogram2DOutliers
37.68.2
Methods
The class vtkPComputeHistogram2DOutliers has several methods that can be used. They are listed below. Note
that the documentation is translated automatically from the VTK sources, and may not be completely intelligible.
When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPComputeHistogram2DOutliers class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPComputeHistogram2DOutliers = obj.NewInstance ()
vtkPComputeHistogram2DOutliers = obj.SafeDownCast (vtkObject o)
obj.SetController (vtkMultiProcessController )
vtkMultiProcessController = obj.GetController ()
37.69
vtkPContingencyStatistics
37.69.1
Usage
vtkPContingencyStatistics is vtkContingencyStatistics subclass for parallel datasets. It learns and derives the global
statistical model on each node, but assesses each individual data points on the node that owns it.
To create an instance of class vtkPContingencyStatistics, simply invoke its constructor as follows
obj = vtkPContingencyStatistics
1780
37.69.2
Methods
The class vtkPContingencyStatistics has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPContingencyStatistics
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPContingencyStatistics = obj.NewInstance ()
vtkPContingencyStatistics = obj.SafeDownCast (vtkObject o)
obj.SetController (vtkMultiProcessController ) - Get/Set the multiprocess controller. If
no controller is set, single process is assumed.
vtkMultiProcessController = obj.GetController () - Get/Set the multiprocess controller. If no controller is set, single process is assumed.
obj.Learn (vtkTable inData, vtkTable inParameters, vtkDataObject outMeta) - Execute the parallel calculations required by the Learn option.
37.70
vtkPCorrelativeStatistics
37.70.1
Usage
vtkPCorrelativeStatistics is vtkCorrelativeStatistics subclass for parallel datasets. It learns and derives the global
statistical model on each node, but assesses each individual data points on the node that owns it.
To create an instance of class vtkPCorrelativeStatistics, simply invoke its constructor as follows
obj = vtkPCorrelativeStatistics
37.70.2
Methods
The class vtkPCorrelativeStatistics has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPCorrelativeStatistics
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPCorrelativeStatistics = obj.NewInstance ()
vtkPCorrelativeStatistics = obj.SafeDownCast (vtkObject o)
obj.SetController (vtkMultiProcessController ) - Get/Set the multiprocess controller. If
no controller is set, single process is assumed.
vtkMultiProcessController = obj.GetController () - Get/Set the multiprocess controller. If no controller is set, single process is assumed.
obj.Learn (vtkTable inData, vtkTable inParameters, vtkDataObject outMeta) - Execute the parallel calculations required by the Learn option.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.71 vtkPDescriptiveStatistics
37.71
1781
vtkPDescriptiveStatistics
37.71.1
Usage
vtkPDescriptiveStatistics is vtkDescriptiveStatistics subclass for parallel datasets. It learns and derives the global
statistical model on each node, but assesses each individual data points on the node that owns it.
To create an instance of class vtkPDescriptiveStatistics, simply invoke its constructor as follows
obj = vtkPDescriptiveStatistics
37.71.2
Methods
The class vtkPDescriptiveStatistics has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPDescriptiveStatistics
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPDescriptiveStatistics = obj.NewInstance ()
vtkPDescriptiveStatistics = obj.SafeDownCast (vtkObject o)
obj.SetController (vtkMultiProcessController ) - Get/Set the multiprocess controller. If
no controller is set, single process is assumed.
vtkMultiProcessController = obj.GetController () - Get/Set the multiprocess controller. If no controller is set, single process is assumed.
obj.Learn (vtkTable inData, vtkTable inParameters, vtkDataObject outMeta) - Execute the parallel calculations required by the Learn option.
37.72
vtkPerturbCoincidentVertices
37.72.1
Usage
This filter perturbs vertices in a graph that have coincident coordinates. In particular this happens all the time with
graphs that are georeferenced, so we need a nice scheme to perturb the vertices so that when the user zooms in
the vertices can be distiquished.
To create an instance of class vtkPerturbCoincidentVertices, simply invoke its constructor as follows
obj = vtkPerturbCoincidentVertices
37.72.2
Methods
The class vtkPerturbCoincidentVertices has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPerturbCoincidentVertices
class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1782
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPerturbCoincidentVertices = obj.NewInstance ()
vtkPerturbCoincidentVertices = obj.SafeDownCast (vtkObject o)
obj.SetPerturbFactor (double ) - Specify the perturbation factor (defaults to 1.0)
double = obj.GetPerturbFactor () - Specify the perturbation factor (defaults to 1.0)
37.73
vtkPExtractHistogram2D
37.73.1
Usage
This class does exactly the same this as vtkExtractHistogram2D, but does it in a multi-process environment. After
each node computes their own local histograms, this class does an AllReduce that distributes the sum of all local
histograms onto each node.
To create an instance of class vtkPExtractHistogram2D, simply invoke its constructor as follows
obj = vtkPExtractHistogram2D
37.73.2
Methods
The class vtkPExtractHistogram2D has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPExtractHistogram2D
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPExtractHistogram2D = obj.NewInstance ()
vtkPExtractHistogram2D = obj.SafeDownCast (vtkObject o)
obj.SetController (vtkMultiProcessController )
vtkMultiProcessController = obj.GetController ()
37.74
vtkPKMeansStatistics
37.74.1
Usage
vtkPKMeansStatistics is vtkKMeansStatistics subclass for parallel datasets. It learns and derives the global statistical model on each node, but assesses each individual data points on the node that owns it.
To create an instance of class vtkPKMeansStatistics, simply invoke its constructor as follows
obj = vtkPKMeansStatistics
37.75 vtkPMultiCorrelativeStatistics
37.74.2
1783
Methods
The class vtkPKMeansStatistics has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPKMeansStatistics class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPKMeansStatistics = obj.NewInstance ()
vtkPKMeansStatistics = obj.SafeDownCast (vtkObject o)
obj.SetController (vtkMultiProcessController ) - Get/Set the multiprocess controller. If
no controller is set, single process is assumed.
vtkMultiProcessController = obj.GetController () - Get/Set the multiprocess controller. If no controller is set, single process is assumed.
obj.UpdateClusterCenters (vtkTable newClusterElements, vtkTable cur-
37.75
vtkPMultiCorrelativeStatistics
37.75.1
Usage
vtkPMultiCorrelativeStatistics is vtkMultiCorrelativeStatistics subclass for parallel datasets. It learns and derives the
global statistical model on each node, but assesses each individual data points on the node that owns it.
To create an instance of class vtkPMultiCorrelativeStatistics, simply invoke its constructor as follows
obj = vtkPMultiCorrelativeStatistics
37.75.2
Methods
The class vtkPMultiCorrelativeStatistics has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPMultiCorrelativeStatistics
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPMultiCorrelativeStatistics = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1784
37.76
vtkPPairwiseExtractHistogram2D
37.76.1
Usage
This class does exactly the same this as vtkPairwiseExtractHistogram2D, but does it in a multi-process environment.
After each node computes their own local histograms, this class does an AllReduce that distributes the sum of all
local histograms onto each node.
Because vtkPairwiseExtractHistogram2D is a light wrapper around a series of vtkExtractHistogram2D classes, this
class just overrides the function that instantiates new histogram filters and returns the parallel version (vtkPExtractHistogram2D).
To create an instance of class vtkPPairwiseExtractHistogram2D, simply invoke its constructor as follows
obj = vtkPPairwiseExtractHistogram2D
37.76.2
Methods
The class vtkPPairwiseExtractHistogram2D has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkPPairwiseExtractHistogram2D class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPPairwiseExtractHistogram2D = obj.NewInstance ()
vtkPPairwiseExtractHistogram2D = obj.SafeDownCast (vtkObject o)
obj.SetController (vtkMultiProcessController )
vtkMultiProcessController = obj.GetController ()
37.77
vtkPPCAStatistics
37.77.1
Usage
vtkPPCAStatistics is vtkPCAStatistics subclass for parallel datasets. It learns and derives the global statistical
model on each node, but assesses each individual data points on the node that owns it.
To create an instance of class vtkPPCAStatistics, simply invoke its constructor as follows
obj = vtkPPCAStatistics
37.78 vtkPruneTreeFilter
37.77.2
1785
Methods
The class vtkPPCAStatistics has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkPPCAStatistics class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPPCAStatistics = obj.NewInstance ()
vtkPPCAStatistics = obj.SafeDownCast (vtkObject o)
obj.SetController (vtkMultiProcessController ) - Get/Set the multiprocess controller. If
no controller is set, single process is assumed.
vtkMultiProcessController = obj.GetController () - Get/Set the multiprocess controller. If no controller is set, single process is assumed.
37.78
vtkPruneTreeFilter
37.78.1
Usage
37.78.2
Methods
The class vtkPruneTreeFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkPruneTreeFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkPruneTreeFilter = obj.NewInstance ()
vtkPruneTreeFilter = obj.SafeDownCast (vtkObject o)
vtkIdType = obj.GetParentVertex () - Set the parent vertex of the subtree to remove.
obj.SetParentVertex (vtkIdType ) - Set the parent vertex of the subtree to remove.
37.79
vtkRandomGraphSource
1786
37.79.1
Usage
Generates a graph with a specified number of vertices, with the density of edges specified by either an exact number
of edges or the probability of an edge. You may additionally specify whether to begin with a random tree (which
enforces graph connectivity).
To create an instance of class vtkRandomGraphSource, simply invoke its constructor as follows
obj = vtkRandomGraphSource
37.79.2
Methods
The class vtkRandomGraphSource has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRandomGraphSource
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRandomGraphSource = obj.NewInstance ()
vtkRandomGraphSource = obj.SafeDownCast (vtkObject o)
int = obj.GetNumberOfVertices () - The number of vertices in the graph.
obj.SetNumberOfVertices (int ) - The number of vertices in the graph.
int = obj.GetNumberOfVerticesMinValue () - The number of vertices in the graph.
int = obj.GetNumberOfVerticesMaxValue () - The number of vertices in the graph.
int = obj.GetNumberOfEdges () - If UseEdgeProbability is off, creates a graph with the specified
number of edges. Duplicate (parallel) edges are allowed.
obj.SetNumberOfEdges (int ) - If UseEdgeProbability is off, creates a graph with the specified
number of edges. Duplicate (parallel) edges are allowed.
int = obj.GetNumberOfEdgesMinValue () - If UseEdgeProbability is off, creates a graph with
the specified number of edges. Duplicate (parallel) edges are allowed.
int = obj.GetNumberOfEdgesMaxValue () - If UseEdgeProbability is off, creates a graph with
the specified number of edges. Duplicate (parallel) edges are allowed.
double = obj.GetEdgeProbability () - If UseEdgeProbability is on, adds an edge with this
probability between 0 and 1 for each pair of vertices in the graph.
obj.SetEdgeProbability (double ) - If UseEdgeProbability is on, adds an edge with this probability between 0 and 1 for each pair of vertices in the graph.
double = obj.GetEdgeProbabilityMinValue () - If UseEdgeProbability is on, adds an edge
with this probability between 0 and 1 for each pair of vertices in the graph.
double = obj.GetEdgeProbabilityMaxValue () - If UseEdgeProbability is on, adds an edge
with this probability between 0 and 1 for each pair of vertices in the graph.
obj.SetIncludeEdgeWeights (bool ) - When set, includes edge weights in an array named
"edge_weights". Defaults to off. Weights are random between 0 and 1.
bool = obj.GetIncludeEdgeWeights () - When set, includes edge weights in an array named
"edge_weights". Defaults to off. Weights are random between 0 and 1.
obj.IncludeEdgeWeightsOn () - When set, includes edge weights in an array named "edge_weights". Defaults to off. Weights are random between 0 and 1.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.79 vtkRandomGraphSource
1787
obj.IncludeEdgeWeightsOff () - When set, includes edge weights in an array named "edge_weights". Defaults to off. Weights are random between 0 and 1.
obj.SetEdgeWeightArrayName (string ) - The name of the edge weight array. Default "edge
weight".
string = obj.GetEdgeWeightArrayName () - The name of the edge weight array. Default "edge
weight".
obj.SetDirected (bool ) - When set, creates a directed graph, as opposed to an undirected graph.
bool = obj.GetDirected () - When set, creates a directed graph, as opposed to an undirected
graph.
obj.DirectedOn () - When set, creates a directed graph, as opposed to an undirected graph.
obj.DirectedOff () - When set, creates a directed graph, as opposed to an undirected graph.
obj.SetUseEdgeProbability (bool ) - When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used.
bool = obj.GetUseEdgeProbability () - When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used.
obj.UseEdgeProbabilityOn () - When set, uses the EdgeProbability parameter to determine the
density of edges. Otherwise, NumberOfEdges is used.
obj.UseEdgeProbabilityOff () - When set, uses the EdgeProbability parameter to determine the
density of edges. Otherwise, NumberOfEdges is used.
obj.SetStartWithTree (bool ) - When set, builds a random tree structure first, then adds additional random edges.
bool = obj.GetStartWithTree () - When set, builds a random tree structure first, then adds additional random edges.
obj.StartWithTreeOn () - When set, builds a random tree structure first, then adds additional random edges.
obj.StartWithTreeOff () - When set, builds a random tree structure first, then adds additional random edges.
obj.SetAllowSelfLoops (bool ) - If this flag is set to true, edges where the source and target
vertex are the same can be generated. The default is to forbid such loops.
bool = obj.GetAllowSelfLoops () - If this flag is set to true, edges where the source and target
vertex are the same can be generated. The default is to forbid such loops.
obj.AllowSelfLoopsOn () - If this flag is set to true, edges where the source and target vertex are
the same can be generated. The default is to forbid such loops.
obj.AllowSelfLoopsOff () - If this flag is set to true, edges where the source and target vertex are
the same can be generated. The default is to forbid such loops.
obj.SetAllowParallelEdges (bool ) - When set, multiple edges from a source to a target vertex
are allowed. The default is to forbid such loops.
bool = obj.GetAllowParallelEdges () - When set, multiple edges from a source to a target
vertex are allowed. The default is to forbid such loops.
obj.AllowParallelEdgesOn () - When set, multiple edges from a source to a target vertex are
allowed. The default is to forbid such loops.
obj.AllowParallelEdgesOff () - When set, multiple edges from a source to a target vertex are
allowed. The default is to forbid such loops.
obj.SetGeneratePedigreeIds (bool ) - Add pedigree ids to vertex and edge data.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1788
37.80
vtkRandomLayoutStrategy
37.80.1
Usage
37.80.2
Methods
The class vtkRandomLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRandomLayoutStrategy
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRandomLayoutStrategy = obj.NewInstance ()
vtkRandomLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.SetRandomSeed (int ) - Seed the random number generator used to compute point positions.
This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMinValue () - Seed the random number generator used to compute
point positions. This has a significant effect on their final positions when the layout is complete.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.81 vtkRemoveHiddenData
1789
37.81
vtkRemoveHiddenData
37.81.1
Usage
Output only those rows/vertices/edges of the input vtkDataObject that are visible, as defined by the vtkAnnotation::HIDE() flag of the input vtkAnnotationLayers. Inputs: Port 0 - vtkDataObject Port 1 - vtkAnnotationLayers (optional)
To create an instance of class vtkRemoveHiddenData, simply invoke its constructor as follows
obj = vtkRemoveHiddenData
1790
37.81.2
Methods
The class vtkRemoveHiddenData has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRemoveHiddenData
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRemoveHiddenData = obj.NewInstance ()
vtkRemoveHiddenData = obj.SafeDownCast (vtkObject o)
37.82
vtkRemoveIsolatedVertices
37.82.1
Usage
37.82.2
Methods
The class vtkRemoveIsolatedVertices has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkRemoveIsolatedVertices
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRemoveIsolatedVertices = obj.NewInstance ()
vtkRemoveIsolatedVertices = obj.SafeDownCast (vtkObject o)
37.83
vtkRISReader
37.83.1
Usage
RIS is a tagged format for expressing bibliographic citations. Data is structured as a collection of records with each
record composed of one-to-many fields. See
37.84 vtkSCurveSpline
37.83.2
1791
Methods
The class vtkRISReader has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkRISReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkRISReader = obj.NewInstance ()
vtkRISReader = obj.SafeDownCast (vtkObject o)
string = obj.GetFileName () - Set/get the file to load
obj.SetFileName (string ) - Set/get the file to load
string = obj.GetDelimiter () - Set/get the delimiter to be used for concatenating field data
(default: ";")
obj.SetDelimiter (string ) - Set/get the delimiter to be used for concatenating field data (default:
";")
int = obj.GetMaxRecords () - Set/get the maximum number of records to read from the file (zero
= unlimited)
obj.SetMaxRecords (int ) - Set/get the maximum number of records to read from the file (zero =
unlimited)
37.84
vtkSCurveSpline
37.84.1
Usage
37.84.2
Methods
The class vtkSCurveSpline has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkSCurveSpline class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSCurveSpline = obj.NewInstance ()
vtkSCurveSpline = obj.SafeDownCast (vtkObject o)
obj.Compute ()
double = obj.Evaluate (double t) - Evaluate a 1D SCurve spline.
obj.DeepCopy (vtkSpline s) - Deep copy of SCurve spline data.
obj.SetNodeWeight (double )
double = obj.GetNodeWeight ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1792
37.85
vtkSimple2DLayoutStrategy
37.85.1
Usage
This class is an implementation of the work presented in: Fruchterman & Reingold "Graph Drawing by Forcedirected Placement" Software-Practice and Experience 21(11) 1991). The class includes some optimizations but
nothing too fancy.
.SECTION Thanks Thanks to Brian Wylie from Sandia National Laboratories for creating this class.
To create an instance of class vtkSimple2DLayoutStrategy, simply invoke its constructor as follows
obj = vtkSimple2DLayoutStrategy
37.85.2
Methods
The class vtkSimple2DLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSimple2DLayoutStrategy
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSimple2DLayoutStrategy = obj.NewInstance ()
vtkSimple2DLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.SetRandomSeed (int ) - Seed the random number generator used to jitter point positions. This
has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMinValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeedMaxValue () - Seed the random number generator used to jitter point
positions. This has a significant effect on their final positions when the layout is complete.
int = obj.GetRandomSeed () - Seed the random number generator used to jitter point positions.
This has a significant effect on their final positions when the layout is complete.
obj.SetMaxNumberOfIterations (int ) - Set/Get the maximum number of iterations to be used.
The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph
gets modified. The default is 100 for no particular reason Note: The strong recommendation is that you do
not change this parameter. :)
int = obj.GetMaxNumberOfIterationsMinValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified. The default is 100 for no particular reason Note: The strong recommendation
is that you do not change this parameter. :)
int = obj.GetMaxNumberOfIterationsMaxValue () - Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the
more the graph gets modified. The default is 100 for no particular reason Note: The strong recommendation
is that you do not change this parameter. :)
int = obj.GetMaxNumberOfIterations () - Set/Get the maximum number of iterations to be
used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the
graph gets modified. The default is 100 for no particular reason Note: The strong recommendation is that
you do not change this parameter. :)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.85 vtkSimple2DLayoutStrategy
1793
obj.SetIterationsPerLayout (int ) - Set/Get the number of iterations per layout. The only use
for this ivar is for the application to do visualizations of the layout before its complete. The default is 100 to
match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayoutMinValue () - Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before its complete. The
default is 100 to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayoutMaxValue () - Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before its complete. The
default is 100 to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
int = obj.GetIterationsPerLayout () - Set/Get the number of iterations per layout. The only
use for this ivar is for the application to do visualizations of the layout before its complete. The default is 100
to match the default MaxNumberOfIterations Note: Changing this parameter is just fine :)
obj.SetInitialTemperature (float ) - Set the initial temperature. The temperature default is
5 for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
float = obj.GetInitialTemperatureMinValue () - Set the initial temperature. The temperature default is 5 for no particular reason Note: The strong recommendation is that you do not change this
parameter. :)
float = obj.GetInitialTemperatureMaxValue () - Set the initial temperature. The temperature default is 5 for no particular reason Note: The strong recommendation is that you do not change this
parameter. :)
float = obj.GetInitialTemperature () - Set the initial temperature. The temperature default
is 5 for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
obj.SetCoolDownRate (double ) - Set/Get the Cool-down rate. The higher this number is, the
longer it will take to "cool-down", and thus, the more the graph will be modified. The default is 10 for no
particular reason. Note: The strong recommendation is that you do not change this parameter. :)
double = obj.GetCoolDownRateMinValue () - Set/Get the Cool-down rate. The higher this
number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is
10 for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)
double = obj.GetCoolDownRateMaxValue () - Set/Get the Cool-down rate. The higher this
number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is
10 for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)
double = obj.GetCoolDownRate () - Set/Get the Cool-down rate. The higher this number is, the
longer it will take to "cool-down", and thus, the more the graph will be modified. The default is 10 for no
particular reason. Note: The strong recommendation is that you do not change this parameter. :)
obj.SetJitter (bool ) - Set Random jitter of the nodes at initialization to on or off. Note: Its strongly
recommendation to have jitter ON even if you have initial coordinates in your graph. Default is ON
bool = obj.GetJitter () - Set Random jitter of the nodes at initialization to on or off. Note: Its
strongly recommendation to have jitter ON even if you have initial coordinates in your graph. Default is ON
obj.SetRestDistance (float ) - Manually set the resting distance. Otherwise the distance is
computed automatically.
float = obj.GetRestDistance () - Manually set the resting distance. Otherwise the distance is
computed automatically.
obj.Initialize () - This strategy sets up some data structures for faster processing of each Layout()
call
obj.Layout () - This is the layout method where the graph that was set in SetGraph() is laid out. The
method can either entirely layout the graph or iteratively lay out the graph. If you have an iterative layout
please implement the IsLayoutComplete() method.
int = obj.IsLayoutComplete ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1794
37.86
vtkSimple3DCirclesStrategy
37.86.1
Usage
Places vertices on circles depending on the graph vertices hierarchy level. The source graph could be vtkDirectedAcyclicGraph or vtkDirectedGraph if MarkedStartPoints array was added. The algorithm collects the standalone
points, too and take them to a separated circle. If method is FixedRadiusMethod, the radius of the circles will be
equal. If method is FixedDistanceMethod, the distance beetwen the points on circles will be equal.
In first step initial points are searched. A point is initial, if its in degree equal zero and out degree is greater than zero
(or marked by MarkedStartVertices and out degree is greater than zero). Independent vertices (in and out degree
equal zero) are collected separatelly. In second step the hierarchical level is generated for every vertex. In third
step the hierarchical order is generated. If a vertex has no hierarchical level and it is not independent, the graph has
loop so the algorithm exit with error message. Finally the vertices positions are calculated by the hierarchical order
and by the vertices hierarchy levels.
.SECTION Thanks Ferenc Nasztanovics, naszta@naszta.hu, Budapest University of Technology and Economics, Department of Structural Mechanics
.SECTION References in 3D rotation was used: http://en.citizendium.org/wiki/Rotation_-
matrix
To create an instance of class vtkSimple3DCirclesStrategy, simply invoke its constructor as follows
obj = vtkSimple3DCirclesStrategy
37.86.2
Methods
The class vtkSimple3DCirclesStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSimple3DCirclesStrategy
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSimple3DCirclesStrategy = obj.NewInstance ()
vtkSimple3DCirclesStrategy = obj.SafeDownCast (vtkObject o)
obj.SetMethod (int ) - Set or get cicrle generating method (FixedRadiusMethod/FixedDistanceMethod). Default is FixedRadiusMethod.
int = obj.GetMethod () - Set or get cicrle generating method (FixedRadiusMethod/FixedDistanceMethod). Default is FixedRadiusMethod.
obj.SetRadius (double ) - If Method is FixedRadiusMethod: Set or get the radius of the circles. If
Method is FixedDistanceMethod: Set or get the distance of the points in the circle.
double = obj.GetRadius () - If Method is FixedRadiusMethod: Set or get the radius of the circles.
If Method is FixedDistanceMethod: Set or get the distance of the points in the circle.
obj.SetHeight (double ) - Set or get the vertical (local z) distance between the circles. If AutoHeight is on, this is the minimal height between the circle layers
double = obj.GetHeight () - Set or get the vertical (local z) distance between the circles. If AutoHeight is on, this is the minimal height between the circle layers
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.86 vtkSimple3DCirclesStrategy
1795
obj.SetOrign (double , double , double ) - Set or get the orign of the geometry. This is
the center of the first circle. SetOrign(x,y,z)
obj.SetOrign (double a[3]) - Set or get the orign of the geometry. This is the center of the first
circle. SetOrign(x,y,z)
double = obj. GetOrign () - Set or get the orign of the geometry. This is the center of the first
circle. SetOrign(x,y,z)
obj.SetDirection (double dx, double dy, double dz) - Set or get the normal vector of
the circles plain. The height is growing in this direction. The direction must not be zero vector. The default
vector is (0.0,0.0,1.0)
obj.SetDirection (double d[3]) - Set or get the normal vector of the circles plain. The height is
growing in this direction. The direction must not be zero vector. The default vector is (0.0,0.0,1.0)
double = obj. GetDirection () - Set or get the normal vector of the circles plain. The height is
growing in this direction. The direction must not be zero vector. The default vector is (0.0,0.0,1.0)
obj.SetMarkedStartVertices (vtkIntArray _arg) - Set or get initial vertices. If MarkedStartVertices is added, loop is accepted in the graph. (If all of the loop start vertices are marked in MarkedStartVertices array.) MarkedStartVertices size must be equal with the number of the vertices in the graph.
Start vertices must be marked by MarkedValue. (E.g.: if MarkedValue=3 and MarkedStartPoints is { 0, 3, 5, 3
}, the start points ids will be {1,3}.) )
vtkIntArray = obj.GetMarkedStartVertices () - Set or get initial vertices. If MarkedStartVertices is added, loop is accepted in the graph. (If all of the loop start vertices are marked in MarkedStartVertices array.) MarkedStartVertices size must be equal with the number of the vertices in the graph. Start
vertices must be marked by MarkedValue. (E.g.: if MarkedValue=3 and MarkedStartPoints is { 0, 3, 5, 3 }, the
start points ids will be {1,3}.) )
obj.SetMarkedValue (int ) - Set or get MarkedValue. See: MarkedStartVertices.
int = obj.GetMarkedValue () - Set or get MarkedValue. See: MarkedStartVertices.
obj.SetForceToUseUniversalStartPointsFinder (int ) - Set or get ForceToUseUniversalStartPointsFinder. If ForceToUseUniversalStartPointsFinder is true, MarkedStartVertices wont
be used. In this case the input graph must be vtkDirectedAcyclicGraph (Defualt: false).
int = obj.GetForceToUseUniversalStartPointsFinder () - Set or get ForceToUseUniversalStartPointsFinder. If ForceToUseUniversalStartPointsFinder is true, MarkedStartVertices wont be
used. In this case the input graph must be vtkDirectedAcyclicGraph (Defualt: false).
obj.ForceToUseUniversalStartPointsFinderOn () - Set or get ForceToUseUniversalStartPointsFinder. If ForceToUseUniversalStartPointsFinder is true, MarkedStartVertices wont be used. In this
case the input graph must be vtkDirectedAcyclicGraph (Defualt: false).
obj.ForceToUseUniversalStartPointsFinderOff () - Set or get ForceToUseUniversalStartPointsFinder. If ForceToUseUniversalStartPointsFinder is true, MarkedStartVertices wont be used. In
this case the input graph must be vtkDirectedAcyclicGraph (Defualt: false).
obj.SetAutoHeight (int ) - Set or get auto height (Default: false). If AutoHeight is true, (r(i+1) r(i-1))/Height will be smaller than tan(MinimumRadian). If you want equal distances and parallel circles, you
should turn off AutoHeight.
int = obj.GetAutoHeight () - Set or get auto height (Default: false). If AutoHeight is true, (r(i+1) r(i-1))/Height will be smaller than tan(MinimumRadian). If you want equal distances and parallel circles, you
should turn off AutoHeight.
obj.AutoHeightOn () - Set or get auto height (Default: false). If AutoHeight is true, (r(i+1) - r(i-1))/Height will be smaller than tan(MinimumRadian). If you want equal distances and parallel circles, you should
turn off AutoHeight.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1796
obj.AutoHeightOff () - Set or get auto height (Default: false). If AutoHeight is true, (r(i+1) - r(i-1))/Height will be smaller than tan(MinimumRadian). If you want equal distances and parallel circles, you should
turn off AutoHeight.
obj.SetMinimumRadian (double ) - Set or get minimum radian (used by auto height).
double = obj.GetMinimumRadian () - Set or get minimum radian (used by auto height).
obj.SetMinimumDegree (double degree) - Set or get minimum degree (used by auto height).
There is no separated minimum degree, so minimum radian will be changed.
double = obj.GetMinimumDegree (void ) - Set or get minimum degree (used by auto height).
There is no separated minimum degree, so minimum radian will be changed.
obj.SetHierarchicalLayers (vtkIntArray _arg) - Set or get hierarchical layers id by vertices (An usual vertexs layer id is greater or equal to zero. If a vertex is standalone, its layer id is -2.) If no
HierarchicalLayers array is defined, vtkSimple3DCirclesStrategy will generate it automatically (default).
vtkIntArray = obj.GetHierarchicalLayers () - Set or get hierarchical layers id by vertices
(An usual vertexs layer id is greater or equal to zero. If a vertex is standalone, its layer id is -2.) If no
HierarchicalLayers array is defined, vtkSimple3DCirclesStrategy will generate it automatically (default).
obj.SetHierarchicalOrder (vtkIdTypeArray _arg) - Set or get hierarchical ordering of vertices (The array starts from the first vertexs id. All id must be greater or equal to zero!) If no HierarchicalOrder
is defined, vtkSimple3DCirclesStrategy will generate it automatically (default).
vtkIdTypeArray = obj.GetHierarchicalOrder () - Set or get hierarchical ordering of vertices (The array starts from the first vertexs id. All id must be greater or equal to zero!) If no HierarchicalOrder
is defined, vtkSimple3DCirclesStrategy will generate it automatically (default).
obj.Layout (void ) - Standard layout method
obj.SetGraph (vtkGraph graph) - Set graph (warning: HierarchicalOrder and HierarchicalLayers
will set to zero. These reference counts will be decreased!)
37.87
vtkSliceAndDiceLayoutStrategy
37.87.1
Usage
Lays out a tree-map alternating between horizontal and vertical slices, taking into account the relative size of each
vertex.
.SECTION Thanks Slice and dice algorithm comes from: Shneiderman, B. 1992. Tree visualization with tree-maps:
2-d space-filling approach. ACM Trans. Graph. 11, 1 (Jan. 1992), 92-99.
To create an instance of class vtkSliceAndDiceLayoutStrategy, simply invoke its constructor as follows
obj = vtkSliceAndDiceLayoutStrategy
37.87.2
Methods
The class vtkSliceAndDiceLayoutStrategy has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSliceAndDiceLayoutStrategy class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.88 vtkSpanTreeLayoutStrategy
1797
37.88
vtkSpanTreeLayoutStrategy
37.88.1
Usage
vtkSpanTreeLayout is a strategy for drawing directed graphs that works by first extracting a spanning tree (more
accurately, a spanning forest), and using this both to position graph vertices and to plan the placement of non-tree
edges. The latter are drawn with the aid of edge points to produce a tidy drawing.
The approach is best suited to "quasi-trees", graphs where the number of edges is of the same order as the number
of nodes; it is less well suited to denser graphs. The boolean flag DepthFirstSpanningTree determines whether a
depth-first or breadth-first strategy is used to construct the underlying forest, and the choice of strategy affects the
output layout significantly. Informal experiments suggest that the breadth-first strategy is better for denser graphs.
Different layouts could also be produced by plugging in alternative tree layout strategies. To work with the method
of routing non-tree edges, any strategy should draw a tree so that levels are equally spaced along the z-axis,
precluding for example the use of a radial or balloon layout.
vtkSpanTreeLayout is based on an approach to 3D graph layout first developed as part of the "tulip" tool by Dr.
David Auber at LaBRI, U.Bordeaux: see www.tulip-software.org
This implementation departs from the original version in that: (a) it is reconstructed to use Titan/VTK data structures;
(b) it uses a faster method for dealing with non-tree edges, requiring at most two edge points per edge (c) allows
for plugging in different tree layout methods (d) allows selection of two different strategies for building the underlying
layout tree, which can yield significantly different results depending on the data.
.SECTION Thanks Thanks to David Duke from the University of Leeds for providing this implementation.
To create an instance of class vtkSpanTreeLayoutStrategy, simply invoke its constructor as follows
obj = vtkSpanTreeLayoutStrategy
37.88.2
Methods
The class vtkSpanTreeLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSpanTreeLayoutStrategy
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSpanTreeLayoutStrategy = obj.NewInstance ()
vtkSpanTreeLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.SetDepthFirstSpanningTree (bool ) - If set, base the layout on a depth-first spanning
tree, rather than the default breadth-first spanning tree. Switching between DFT and BFT may significantly
change the layout, and choice must be made on a per-graph basis. Default value is off.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1798
37.89
vtkSparseArrayToTable
37.89.1
Usage
Converts any sparse array to a vtkTable containing one row for each value stored in the array. The table will contain
one column of coordinates for each dimension in the source array, plus one column of array values. A common
use-case for vtkSparseArrayToTable would be converting a sparse array into a table suitable for use as an input to
vtkTableToGraph.
The coordinate columns in the output table will be named using the dimension labels from the source array, The
value column name can be explicitly set using SetValueColumn().
.SECTION Thanks Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.
To create an instance of class vtkSparseArrayToTable, simply invoke its constructor as follows
obj = vtkSparseArrayToTable
37.89.2
Methods
The class vtkSparseArrayToTable has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSparseArrayToTable
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSparseArrayToTable = obj.NewInstance ()
vtkSparseArrayToTable = obj.SafeDownCast (vtkObject o)
string = obj.GetValueColumn () - Specify the name of the output table column that contains
array values. Default: "value"
obj.SetValueColumn (string ) - Specify the name of the output table column that contains array
values. Default: "value"
37.90
vtkSplineGraphEdges
37.91 vtkSplitColumnComponents
37.90.1
1799
Usage
vtkSplineGraphEdges uses a vtkSpline to make edges into nicely sampled splines. By default, the filter will use an
optimized b-spline. Otherwise, it will use a custom vtkSpline instance set by the user.
To create an instance of class vtkSplineGraphEdges, simply invoke its constructor as follows
obj = vtkSplineGraphEdges
37.90.2
Methods
The class vtkSplineGraphEdges has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSplineGraphEdges class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSplineGraphEdges = obj.NewInstance ()
vtkSplineGraphEdges = obj.SafeDownCast (vtkObject o)
obj.SetSpline (vtkSpline s) - If SplineType is CUSTOM, uses this spline.
vtkSpline = obj.GetSpline () - If SplineType is CUSTOM, uses this spline.
obj.SetSplineType (int ) - Spline type used by the filter. BSPLINE (0) - Use optimized b-spline
(default). CUSTOM (1) - Use spline set with SetSpline.
int = obj.GetSplineType () - Spline type used by the filter. BSPLINE (0) - Use optimized b-spline
(default). CUSTOM (1) - Use spline set with SetSpline.
obj.SetNumberOfSubdivisions (vtkIdType ) - The number of subdivisions in the spline.
vtkIdType = obj.GetNumberOfSubdivisions () - The number of subdivisions in the spline.
37.91
vtkSplitColumnComponents
37.91.1
Usage
Splits any columns in a table that have more than one component into individual columns. Single component
columns are passed through without any data duplication. So if column names "Points" had three components this
column would be split into "Points (0)", "Points (1)" and Points (2)".
To create an instance of class vtkSplitColumnComponents, simply invoke its constructor as follows
obj = vtkSplitColumnComponents
37.91.2
Methods
The class vtkSplitColumnComponents has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSplitColumnComponents
class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1800
37.92
vtkSQLDatabaseGraphSource
37.92.1
Usage
This class combines vtkSQLDatabase, vtkSQLQuery, and vtkQueryToGraph to provide a convenience class for
generating graphs from databases. Also this class can be easily wrapped and used within ParaView / OverView.
To create an instance of class vtkSQLDatabaseGraphSource, simply invoke its constructor as follows
obj = vtkSQLDatabaseGraphSource
37.92.2
Methods
The class vtkSQLDatabaseGraphSource has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSQLDatabaseGraphSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSQLDatabaseGraphSource = obj.NewInstance ()
vtkSQLDatabaseGraphSource = obj.SafeDownCast (vtkObject o)
vtkStdString = obj.GetURL ()
obj.SetURL (vtkStdString &url)
obj.SetPassword (vtkStdString &password)
vtkStdString = obj.GetEdgeQuery ()
obj.SetEdgeQuery (vtkStdString &query)
vtkStdString = obj.GetVertexQuery ()
obj.SetVertexQuery (vtkStdString &query)
obj.AddLinkVertex (string column, string domain, int hidden)
obj.ClearLinkVertices ()
obj.AddLinkEdge (string column1, string column2)
obj.ClearLinkEdges ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.93 vtkSQLDatabaseTableSource
1801
37.93
vtkSQLDatabaseTableSource
37.93.1
Usage
This class combines vtkSQLDatabase, vtkSQLQuery, and vtkQueryToTable to provide a convenience class for
generating tables from databases. Also this class can be easily wrapped and used within ParaView / OverView.
To create an instance of class vtkSQLDatabaseTableSource, simply invoke its constructor as follows
obj = vtkSQLDatabaseTableSource
37.93.2
Methods
The class vtkSQLDatabaseTableSource has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSQLDatabaseTableSource class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSQLDatabaseTableSource = obj.NewInstance ()
vtkSQLDatabaseTableSource = obj.SafeDownCast (vtkObject o)
vtkStdString = obj.GetURL ()
obj.SetURL (vtkStdString &url)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1802
37.94
vtkSQLGraphReader
37.94.1
Usage
Creates a vtkGraph using one or two vtkSQLQuerys. The first (required) query must have one row for each arc in
the graph. The query must have two columns which represent the source and target node ids.
The second (optional) query has one row for each node in the graph. The table must have a field whose values
match those in the arc table. If the node table is not given, a node will be created for each unique source or target
identifier in the arc table.
The source, target, and node ID fields must be of the same type, and must be either vtkStringArray or a subclass of
vtkDataArray.
All columns in the queries, including the source, target, and node index fields, are copied into the arc data and node
data of the resulting vtkGraph. If the node query is not given, the node data will contain a single "id" column with
the same type as the source/target id arrays.
If parallel arcs are collected, not all the arc data is not copied into the output. Only the source and target id arrays
will be transferred. An additional vtkIdTypeArray column called "weight" is created which contains the number of
times each arc appeared in the input.
If the node query contains positional data, the user may specify the names of these fields. These arrays must be
data arrays. The z-coordinate array is optional, and if not given the z-coordinates are set to zero.
To create an instance of class vtkSQLGraphReader, simply invoke its constructor as follows
obj = vtkSQLGraphReader
37.94.2
Methods
The class vtkSQLGraphReader has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSQLGraphReader class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.94 vtkSQLGraphReader
1803
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSQLGraphReader = obj.NewInstance ()
vtkSQLGraphReader = obj.SafeDownCast (vtkObject o)
obj.SetDirected (bool ) - When set, creates a directed graph, as opposed to an undirected graph.
bool = obj.GetDirected () - When set, creates a directed graph, as opposed to an undirected
graph.
obj.DirectedOn () - When set, creates a directed graph, as opposed to an undirected graph.
obj.DirectedOff () - When set, creates a directed graph, as opposed to an undirected graph.
obj.SetVertexQuery (vtkSQLQuery q) - The query that retrieves the node information.
vtkSQLQuery = obj.GetVertexQuery () - The query that retrieves the node information.
obj.SetEdgeQuery (vtkSQLQuery q) - The query that retrieves the arc information.
vtkSQLQuery = obj.GetEdgeQuery () - The query that retrieves the arc information.
obj.SetSourceField (string ) - The name of the field in the arc query for the source node of
each arc.
string = obj.GetSourceField () - The name of the field in the arc query for the source node of
each arc.
obj.SetTargetField (string ) - The name of the field in the arc query for the target node of each
arc.
string = obj.GetTargetField () - The name of the field in the arc query for the target node of
each arc.
obj.SetVertexIdField (string ) - The name of the field in the node query for the node ID.
string = obj.GetVertexIdField () - The name of the field in the node query for the node ID.
obj.SetXField (string ) - The name of the field in the node query for the nodes x coordinate.
string = obj.GetXField () - The name of the field in the node query for the nodes x coordinate.
obj.SetYField (string ) - The name of the field in the node query for the nodes y coordinate.
string = obj.GetYField () - The name of the field in the node query for the nodes y coordinate.
obj.SetZField (string ) - The name of the field in the node query for the nodes z coordinate.
string = obj.GetZField () - The name of the field in the node query for the nodes z coordinate.
obj.SetCollapseEdges (bool ) - When set, creates a graph with no parallel arcs. Parallel arcs are
combined into one arc. No cell fields are passed to the output, except the vtkGhostLevels array if it exists, but
a new field "weight" is created that holds the number of duplicates of that arc in the input.
bool = obj.GetCollapseEdges () - When set, creates a graph with no parallel arcs. Parallel arcs
are combined into one arc. No cell fields are passed to the output, except the vtkGhostLevels array if it exists,
but a new field "weight" is created that holds the number of duplicates of that arc in the input.
obj.CollapseEdgesOn () - When set, creates a graph with no parallel arcs. Parallel arcs are combined into one arc. No cell fields are passed to the output, except the vtkGhostLevels array if it exists, but a
new field "weight" is created that holds the number of duplicates of that arc in the input.
obj.CollapseEdgesOff () - When set, creates a graph with no parallel arcs. Parallel arcs are combined into one arc. No cell fields are passed to the output, except the vtkGhostLevels array if it exists, but a
new field "weight" is created that holds the number of duplicates of that arc in the input.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1804
37.95
vtkSquarifyLayoutStrategy
37.95.1
Usage
vtkSquarifyLayoutStrategy partitions the space for child vertices into regions that use all avaliable space and are as
close to squares as possible. The algorithm also takes into account the relative vertex size.
.SECTION Thanks The squarified tree map algorithm comes from: Bruls, D.M., C. Huizing, J.J. van Wijk. Squarified
Treemaps. In: W. de Leeuw, R. van Liere (eds.), Data Visualization 2000, Proceedings of the joint Eurographics and
IEEE TCVG Symposium on Visualization, 2000, Springer, Vienna, p. 33-42.
To create an instance of class vtkSquarifyLayoutStrategy, simply invoke its constructor as follows
obj = vtkSquarifyLayoutStrategy
37.95.2
Methods
The class vtkSquarifyLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkSquarifyLayoutStrategy
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkSquarifyLayoutStrategy = obj.NewInstance ()
vtkSquarifyLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.Layout (vtkTree inputTree, vtkDataArray coordsArray, vtkDataArray
sizeArray) - Perform the layout of a tree and place the results as 4-tuples in coordsArray (Xmin,
Xmax, Ymin, Ymax).
37.96
vtkStackedTreeLayoutStrategy
37.96.1
Usage
Performs a tree ring layout or "icicle" layout on a tree. This involves assigning a sector region to each vertex in
the tree, and placing that information in a data array with four components per tuple representing (innerRadius,
outerRadius, startAngle, endAngle).
This class may be assigned as the layout strategy to vtkAreaLayout.
.SECTION Thanks Thanks to Jason Shepherd from Sandia National Laboratories for help developing this class.
To create an instance of class vtkStackedTreeLayoutStrategy, simply invoke its constructor as follows
obj = vtkStackedTreeLayoutStrategy
37.96 vtkStackedTreeLayoutStrategy
37.96.2
1805
Methods
The class vtkStackedTreeLayoutStrategy has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStackedTreeLayoutStrategy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStackedTreeLayoutStrategy = obj.NewInstance ()
vtkStackedTreeLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.Layout (vtkTree inputTree, vtkDataArray sectorArray, vtkDataArray
sizeArray) - Perform the layout of the input tree, and store the sector bounds of each vertex as a
tuple (innerRadius, outerRadius, startAngle, endAngle) in a data array.
obj.LayoutEdgePoints (vtkTree inputTree, vtkDataArray sectorArray, vtkDataArray sizeArray, vtkTree edgeRoutingTree) - Fill edgeRoutingTree with points suitable for routing edges of an overlaid graph.
obj.SetInteriorRadius (double ) - Define the tree rings interior radius.
double = obj.GetInteriorRadius () - Define the tree rings interior radius.
obj.SetRingThickness (double ) - Define the thickness of each of the tree rings.
double = obj.GetRingThickness () - Define the thickness of each of the tree rings.
obj.SetRootStartAngle (double ) - Define the start angle for the root node. NOTE: It is assumed
that the root end angle is greater than the root start angle and subtends no more than 360 degrees.
double = obj.GetRootStartAngle () - Define the start angle for the root node. NOTE: It is
assumed that the root end angle is greater than the root start angle and subtends no more than 360 degrees.
obj.SetRootEndAngle (double ) - Define the end angle for the root node. NOTE: It is assumed
that the root end angle is greater than the root start angle and subtends no more than 360 degrees.
double = obj.GetRootEndAngle () - Define the end angle for the root node. NOTE: It is assumed
that the root end angle is greater than the root start angle and subtends no more than 360 degrees.
obj.SetUseRectangularCoordinates (bool ) - Define whether or not rectangular coordinates
are being used (as opposed to polar coordinates).
bool = obj.GetUseRectangularCoordinates () - Define whether or not rectangular coordinates are being used (as opposed to polar coordinates).
obj.UseRectangularCoordinatesOn () - Define whether or not rectangular coordinates are being
used (as opposed to polar coordinates).
obj.UseRectangularCoordinatesOff () - Define whether or not rectangular coordinates are being used (as opposed to polar coordinates).
obj.SetReverse (bool ) - Define whether to reverse the order of the tree stacks from low to high.
bool = obj.GetReverse () - Define whether to reverse the order of the tree stacks from low to high.
obj.ReverseOn () - Define whether to reverse the order of the tree stacks from low to high.
obj.ReverseOff () - Define whether to reverse the order of the tree stacks from low to high.
obj.SetInteriorLogSpacingValue (double ) - The spacing of tree levels in the edge routing
tree. Levels near zero give more space to levels near the root, while levels near one (the default) create
evenly-spaced levels. Levels above one give more space to levels near the leaves.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1806
double = obj.GetInteriorLogSpacingValue () - The spacing of tree levels in the edge routing tree. Levels near zero give more space to levels near the root, while levels near one (the default) create
evenly-spaced levels. Levels above one give more space to levels near the leaves.
vtkIdType = obj.FindVertex (vtkTree tree, vtkDataArray array, float
pnt[2]) - Returns the vertex id that contains pnt (or -1 if no one contains it).
37.97
vtkStatisticsAlgorithm
37.97.1
Usage
All statistics algorithms can conceptually be operated with several options: Learn: given an input data set, calculate
a minimal statistical model (e.g., sums, raw moments, joint probabilities). Derive: given an input minimal statistical
model, derive the full model (e.g., descriptive statistics, quantiles, correlations, conditional probabilities). NB: It may
be, or not be, a problem that a full model was not derived. For instance, when doing parallel calculations, one only
wants to derive the full model after all partial calculations have completed. On the other hand, one can also directly
provide a full model, that was previously calculated or guessed, and not derive a new one. Assess: given an input
data set, input statistics, and some form of threshold, assess a subset of the data set. Test: perform at least one
statistical test. Therefore, a vtkStatisticsAlgorithm has the following vtkTable ports 3 input ports: Data (mandatory)
Parameters to the learn phase (optional) Input model (optional) 3 output port (called Output): Data (annotated with
assessments when the Assess option is ON). Output model (identical to the the input model when Learn option is
OFF). Meta information about the model and/or the overall fit of the data to the model; is filled only when the Assess
option is ON.
.SECTION Thanks Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.
To create an instance of class vtkStatisticsAlgorithm, simply invoke its constructor as follows
obj = vtkStatisticsAlgorithm
37.97.2
Methods
The class vtkStatisticsAlgorithm has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStatisticsAlgorithm class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStatisticsAlgorithm = obj.NewInstance ()
vtkStatisticsAlgorithm = obj.SafeDownCast (vtkObject o)
obj.SetLearnOptionParameterConnection (vtkAlgorithmOutput params) - A convenience method for setting learn input parameters (if one is expected or allowed). It is equivalent to calling
SetInput( 1, params );
obj.SetLearnOptionParameters (vtkDataObject params) - A convenience method for
setting the input model (if one is expected or allowed). It is equivalent to calling SetInputConnection( 2,
model );
obj.SetInputModelConnection (vtkAlgorithmOutput model) - // obj.SetInputModel (vtkDataObject model) - Set/Get the Learn option.
obj.SetLearnOption (bool ) - Set/Get the Learn option.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.98 vtkStrahlerMetric
1807
37.98
vtkStrahlerMetric
1808
37.98.1
Usage
The Strahler metric is a value assigned to each vertex of a tree that characterizes the structural complexity of the
sub-tree rooted at that node. The metric originated in the study of river systems, but has been applied to other treestructured systes, Details of the metric and the rationale for using it in infovis can be found in:
Tree Visualization and Navigation Clues for Information Visualization, I. Herman, M. Delest, and G. Melancon,
Computer Graphics Forum, Vol 17(2), Blackwell, 1998.
The input tree is copied to the output, but with a new array added to the output vertex data.
.SECTION Thanks Thanks to David Duke from the University of Leeds for providing this implementation.
To create an instance of class vtkStrahlerMetric, simply invoke its constructor as follows
obj = vtkStrahlerMetric
37.98.2
Methods
The class vtkStrahlerMetric has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkStrahlerMetric class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStrahlerMetric = obj.NewInstance ()
vtkStrahlerMetric = obj.SafeDownCast (vtkObject o)
obj.SetMetricArrayName (string ) - Set the name of the array in which the Strahler values will
be stored within the output vertex data. Default is "Strahler"
obj.SetNormalize (int ) - Set/get setting of normalize flag. If this is set, the Strahler values are
scaled into the range [0..1]. Default is for normalization to be OFF.
int = obj.GetNormalize () - Set/get setting of normalize flag. If this is set, the Strahler values are
scaled into the range [0..1]. Default is for normalization to be OFF.
obj.NormalizeOn () - Set/get setting of normalize flag. If this is set, the Strahler values are scaled into
the range [0..1]. Default is for normalization to be OFF.
obj.NormalizeOff () - Set/get setting of normalize flag. If this is set, the Strahler values are scaled
into the range [0..1]. Default is for normalization to be OFF.
float = obj.GetMaxStrahler () - Get the maximum strahler value for the tree.
37.99
vtkStreamGraph
37.99.1
Usage
vtkStreamGraph iteratively collects information from the input graph and combines it in the output graph. It internally
maintains a graph instance that is incrementally updated every time the filter is called.
Each update, vtkMergeGraphs is used to combine this filters input with the internal graph.
To create an instance of class vtkStreamGraph, simply invoke its constructor as follows
obj = vtkStreamGraph
37.100 vtkStringToCategory
37.99.2
1809
Methods
The class vtkStreamGraph has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkStreamGraph class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStreamGraph = obj.NewInstance ()
vtkStreamGraph = obj.SafeDownCast (vtkObject o)
obj.SetMaxEdges (vtkIdType ) - The maximum number of edges in the combined graph. Default
is -1, which specifies that there should be no limit on the number of edges.
vtkIdType = obj.GetMaxEdges () - The maximum number of edges in the combined graph. Default is -1, which specifies that there should be no limit on the number of edges.
37.100
vtkStringToCategory
37.100.1
Usage
vtkStringToCategory creates an integer array named "category" based on the values in a string array. You may use
this filter to create an array that you may use to color points/cells by the values in a string array. Currently there
is not support to color by a string array directly. The category values will range from zero to N-1, where N is the
number of distinct strings in the string array. Set the string array to process with SetInputArrayToProcess(0,0,0,...).
The array may be in the point, cell, or field data of the data object.
To create an instance of class vtkStringToCategory, simply invoke its constructor as follows
obj = vtkStringToCategory
37.100.2
Methods
The class vtkStringToCategory has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkStringToCategory class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStringToCategory = obj.NewInstance ()
vtkStringToCategory = obj.SafeDownCast (vtkObject o)
obj.SetCategoryArrayName (string ) - The name to give to the output vtkIntArray of category
values.
string = obj.GetCategoryArrayName () - The name to give to the output vtkIntArray of category values.
37.101
vtkStringToNumeric
1810
37.101.1
Usage
37.101.2
Methods
The class vtkStringToNumeric has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkStringToNumeric class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStringToNumeric = obj.NewInstance ()
vtkStringToNumeric = obj.SafeDownCast (vtkObject o)
obj.SetConvertFieldData (bool ) - Whether to detect and convert field data arrays. Default is
on.
bool = obj.GetConvertFieldData () - Whether to detect and convert field data arrays. Default
is on.
obj.ConvertFieldDataOn () - Whether to detect and convert field data arrays. Default is on.
obj.ConvertFieldDataOff () - Whether to detect and convert field data arrays. Default is on.
obj.SetConvertPointData (bool ) - Whether to detect and convert cell data arrays. Default is
on.
bool = obj.GetConvertPointData () - Whether to detect and convert cell data arrays. Default is
on.
obj.ConvertPointDataOn () - Whether to detect and convert cell data arrays. Default is on.
obj.ConvertPointDataOff () - Whether to detect and convert cell data arrays. Default is on.
obj.SetConvertCellData (bool ) - Whether to detect and convert point data arrays. Default is
on.
bool = obj.GetConvertCellData () - Whether to detect and convert point data arrays. Default is
on.
obj.ConvertCellDataOn () - Whether to detect and convert point data arrays. Default is on.
obj.ConvertCellDataOff () - Whether to detect and convert point data arrays. Default is on.
obj.SetConvertVertexData (bool b) - Whether to detect and convert vertex data arrays. Default
is on.
bool = obj.GetConvertVertexData () - Whether to detect and convert vertex data arrays. Default is on.
obj.ConvertVertexDataOn () - Whether to detect and convert vertex data arrays. Default is on.
obj.ConvertVertexDataOff () - Whether to detect and convert vertex data arrays. Default is on.
obj.SetConvertEdgeData (bool b) - Whether to detect and convert edge data arrays. Default is
on.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.102 vtkStringToTimePoint
1811
bool = obj.GetConvertEdgeData () - Whether to detect and convert edge data arrays. Default
is on.
obj.ConvertEdgeDataOn () - Whether to detect and convert edge data arrays. Default is on.
obj.ConvertEdgeDataOff () - Whether to detect and convert edge data arrays. Default is on.
obj.SetConvertRowData (bool b) - Whether to detect and convert row data arrays. Default is on.
bool = obj.GetConvertRowData () - Whether to detect and convert row data arrays. Default is
on.
obj.ConvertRowDataOn () - Whether to detect and convert row data arrays. Default is on.
obj.ConvertRowDataOff () - Whether to detect and convert row data arrays. Default is on.
37.102
vtkStringToTimePoint
37.102.1
Usage
vtkStringToTimePoint is a filter for converting a string array into a datetime, time or date array. The input strings
must conform to one of the ISO8601 formats defined in vtkTimePointUtility.
The input array specified by SetInputArrayToProcess(...) indicates the array to process. This array must be of type
vtkStringArray.
The output array will be of type vtkTypeUInt64Array.
To create an instance of class vtkStringToTimePoint, simply invoke its constructor as follows
obj = vtkStringToTimePoint
37.102.2
Methods
The class vtkStringToTimePoint has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkStringToTimePoint class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkStringToTimePoint = obj.NewInstance ()
vtkStringToTimePoint = obj.SafeDownCast (vtkObject o)
obj.SetOutputArrayName (string ) - The name of the output array. If this is not specified, the
name will be the same as the input array name with either " [to datetime]", " [to date]", or " [to time]" appended.
string = obj.GetOutputArrayName () - The name of the output array. If this is not specified, the
name will be the same as the input array name with either " [to datetime]", " [to date]", or " [to time]" appended.
37.103
vtkTableToArray
1812
37.103.1
Usage
Converts a vtkTable into a dense matrix. Use AddColumn() to designate one-to-many table columns that will become
columns in the output matrix.
To create an instance of class vtkTableToArray, simply invoke its constructor as follows
obj = vtkTableToArray
37.103.2
Methods
The class vtkTableToArray has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkTableToArray class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTableToArray = obj.NewInstance ()
vtkTableToArray = obj.SafeDownCast (vtkObject o)
obj.ClearColumns () - Specify the set of input table columns that will be mapped to columns in the
output matrix.
obj.AddColumn (string name) - Specify the set of input table columns that will be mapped to
columns in the output matrix.
37.104
vtkTableToGraph
37.104.1
Usage
vtkTableToGraph converts a table to a graph using an auxilliary link graph. The link graph specifies how each row
in the table should be converted to an edge, or a collection of edges. It also specifies which columns of the table
should be considered part of the same domain, and which columns should be hidden.
A second, optional, table may be provided as the vertex table. This vertex table must have one or more domain
columns whose values match values in the edge table. The linked column name is specified in the domain array
in the link graph. The output graph will only contain vertices corresponding to a row in the vertex table. For
heterogenous graphs, you may want to use vtkMergeTables to create a single vertex table.
The link graph contains the following arrays:
(1) The "column" array has the names of the columns to connect in each table row. This array is required.
(2) The optional "domain" array provides user-defined domain names for each column. Matching domains in multiple
columns will merge vertices with the same value from those columns. By default, all columns are in the same
domain. If a vertex table is supplied, the domain indicates the column in the vertex table that the edge table column
associates with. If the user provides a vertex table but no domain names, the output will be an empty graph. Hidden
columns do not need valid domain names.
(3) The optional "hidden" array is a bit array specifying whether the column should be hidden. The resulting graph
will contain edges representing connections "through" the hidden column, but the vertices for that column will not
be present. By default, no columns are hidden. Hiding a column in a particular domain hides all columns in that
domain.
The output graph will contain three additional arrays in the vertex data. The "domain" column is a string array
containing the domain of each vertex. The "label" column is a string version of the distinct value that, along with the
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.105 vtkTableToSparseArray
1813
domain, defines that vertex. The "ids" column also contains the distinguishing value, but as a vtkVariant holding the
raw value instead of being converted to a string. The "ids" column is set as the vertex pedigree ID attribute.
To create an instance of class vtkTableToGraph, simply invoke its constructor as follows
obj = vtkTableToGraph
37.104.2
Methods
The class vtkTableToGraph has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkTableToGraph class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTableToGraph = obj.NewInstance ()
vtkTableToGraph = obj.SafeDownCast (vtkObject o)
obj.AddLinkVertex (string column, string domain, int hidden) - Add a vertex to
the link graph. Specify the column name, the domain name for the column, and whether the column is hidden.
obj.ClearLinkVertices () - Clear the link graph vertices. This also clears all edges.
obj.AddLinkEdge (string column1, string column2) - Add an edge to the link graph.
Specify the names of the columns to link.
obj.ClearLinkEdges () - Clear the link graph edges. The graph vertices will remain.
vtkMutableDirectedGraph = obj.GetLinkGraph () - The graph describing how to link the
columns in the table.
obj.SetLinkGraph (vtkMutableDirectedGraph g) - The graph describing how to link the
columns in the table.
obj.LinkColumnPath (vtkStringArray column, vtkStringArray domain, vtkBitArray hidden) - Links the columns in a specific order. This creates a simple path as the link
graph.
obj.SetDirected (bool ) - Specify the directedness of the output graph.
bool = obj.GetDirected () - Specify the directedness of the output graph.
obj.DirectedOn () - Specify the directedness of the output graph.
obj.DirectedOff () - Specify the directedness of the output graph.
long = obj.GetMTime () - Get the current modified time.
obj.SetVertexTableConnection (vtkAlgorithmOutput in) - A convenience method for
setting the vertex table input. This is mainly for the benefit of the VTK client/server layer, vanilla VTK code
should use e.g:
table_to_graph->SetInputConnection(1, vertex_table->output());
37.105
vtkTableToSparseArray
1814
37.105.1
Usage
Converts a vtkTable into a sparse array. Use AddCoordinateColumn() to designate one-to-many table columns that
contain coordinates for each array value, and SetValueColumn() to designate the table column that contains array
values.
Thus, the number of dimensions in the output array will equal the number of calls to AddCoordinateColumn().
The coordinate columns will also be used to populate dimension labels in the output array.
.SECTION Thanks Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.
To create an instance of class vtkTableToSparseArray, simply invoke its constructor as follows
obj = vtkTableToSparseArray
37.105.2
Methods
The class vtkTableToSparseArray has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTableToSparseArray
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTableToSparseArray = obj.NewInstance ()
vtkTableToSparseArray = obj.SafeDownCast (vtkObject o)
obj.ClearCoordinateColumns () - Specify the set of input table columns that will be mapped to
coordinates in the output sparse array.
obj.AddCoordinateColumn (string name) - Specify the set of input table columns that will be
mapped to coordinates in the output sparse array.
obj.SetValueColumn (string name) - Specify the input table column that will be mapped to values in the output array.
string = obj.GetValueColumn () - Specify the input table column that will be mapped to values
in the output array.
37.106
vtkTableToTreeFilter
37.106.1
Usage
vtkTableToTreeFilter is a filter for converting a vtkTable data structure into a vtkTree datastructure. Currently, this will
convert the table into a star, with each row of the table as a child of a new root node. The columns of the table are
passed as node fields of the tree.
To create an instance of class vtkTableToTreeFilter, simply invoke its constructor as follows
obj = vtkTableToTreeFilter
37.107 vtkThresholdTable
37.106.2
1815
Methods
The class vtkTableToTreeFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTableToTreeFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTableToTreeFilter = obj.NewInstance ()
vtkTableToTreeFilter = obj.SafeDownCast (vtkObject o)
37.107
vtkThresholdTable
37.107.1
Usage
vtkThresholdTable uses minimum and/or maximum values to threshold table rows based on the values in a particular
column. The column to threshold is specified using SetInputArrayToProcess(0, ...).
To create an instance of class vtkThresholdTable, simply invoke its constructor as follows
obj = vtkThresholdTable
37.107.2
Methods
The class vtkThresholdTable has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkThresholdTable class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkThresholdTable = obj.NewInstance ()
vtkThresholdTable = obj.SafeDownCast (vtkObject o)
obj.SetMode (int ) - The mode of the threshold filter. Options are: ACCEPT_LESS_THAN (0) accepts rows with values < MaxValue; ACCEPT_GREATER_THAN (1) accepts rows with values > MinValue;
ACCEPT_BETWEEN (2) accepts rows with values > MinValue and < MaxValue; ACCEPT_OUTSIDE (3)
accepts rows with values < MinValue or > MaxValue.
int = obj.GetModeMinValue () - The mode of the threshold filter. Options are: ACCEPT_LESS_THAN (0) accepts rows with values < MaxValue; ACCEPT_GREATER_THAN (1) accepts rows with values
> MinValue; ACCEPT_BETWEEN (2) accepts rows with values > MinValue and < MaxValue; ACCEPT_OUTSIDE (3) accepts rows with values < MinValue or > MaxValue.
int = obj.GetModeMaxValue () - The mode of the threshold filter. Options are: ACCEPT_LESS_THAN (0) accepts rows with values < MaxValue; ACCEPT_GREATER_THAN (1) accepts rows with values
> MinValue; ACCEPT_BETWEEN (2) accepts rows with values > MinValue and < MaxValue; ACCEPT_OUTSIDE (3) accepts rows with values < MinValue or > MaxValue.
int = obj.GetMode () - The mode of the threshold filter. Options are: ACCEPT_LESS_THAN (0)
accepts rows with values < MaxValue; ACCEPT_GREATER_THAN (1) accepts rows with values > MinValue; ACCEPT_BETWEEN (2) accepts rows with values > MinValue and < MaxValue; ACCEPT_OUTSIDE
(3) accepts rows with values < MinValue or > MaxValue.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1816
37.108
vtkTimePointToString
37.108.1
Usage
vtkTimePointToString is a filter for converting a timestamp array into string array using one of the formats defined in
vtkTimePointUtility.h.
Use SetInputArrayToProcess to indicate the array to process. This array must be an unsigned 64-bit integer array
for DATETIME formats, and may be either an unsigned 32-bit or unsigned 64-bit array for DATE and TIME formats.
If the new array name is not specified, the array name will be the old name appended by " [to string]".
To create an instance of class vtkTimePointToString, simply invoke its constructor as follows
obj = vtkTimePointToString
37.108.2
Methods
The class vtkTimePointToString has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTimePointToString class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTimePointToString = obj.NewInstance ()
vtkTimePointToString = obj.SafeDownCast (vtkObject o)
obj.SetISO8601Format (int ) - The format to use when converting the timestamp to a string.
int = obj.GetISO8601Format () - The format to use when converting the timestamp to a string.
obj.SetOutputArrayName (string ) - The name of the output array. If this is not specified, the
name will be the input array name with " [to string]" appended to it.
string = obj.GetOutputArrayName () - The name of the output array. If this is not specified, the
name will be the input array name with " [to string]" appended to it.
37.109
vtkTransferAttributes
37.109 vtkTransferAttributes
37.109.1
1817
Usage
The filter requires both a vtkGraph and vtkTree as input. The tree vertices must be a superset of the graph vertices.
A common example is when the graph vertices correspond to the leaves of the tree, but the internal vertices of the
tree represent groupings of graph vertices. The algorithm matches the vertices using the array "PedigreeId". The
user may alternately set the DirectMapping flag to indicate that the two structures must have directly corresponding
offsets (i.e. node i in the graph must correspond to node i in the tree).
.SECTION Thanks
To create an instance of class vtkTransferAttributes, simply invoke its constructor as follows
obj = vtkTransferAttributes
37.109.2
Methods
The class vtkTransferAttributes has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTransferAttributes class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTransferAttributes = obj.NewInstance ()
vtkTransferAttributes = obj.SafeDownCast (vtkObject o)
obj.SetDirectMapping (bool ) - If on, uses direct mapping from tree to graph vertices. If off, both
the graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default
is off.
bool = obj.GetDirectMapping () - If on, uses direct mapping from tree to graph vertices. If off,
both the graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices.
Default is off.
obj.DirectMappingOn () - If on, uses direct mapping from tree to graph vertices. If off, both the graph
and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default is off.
obj.DirectMappingOff () - If on, uses direct mapping from tree to graph vertices. If off, both the
graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default is
off.
string = obj.GetSourceArrayName () - The field name to use for storing the source array.
obj.SetSourceArrayName (string ) - The field name to use for storing the source array.
string = obj.GetTargetArrayName () - The field name to use for storing the source array.
obj.SetTargetArrayName (string ) - The field name to use for storing the source array.
int = obj.GetSourceFieldType () - The source field type for accessing the source array. Valid
values are those from enum vtkDataObject::FieldAssociations.
obj.SetSourceFieldType (int ) - The source field type for accessing the source array. Valid
values are those from enum vtkDataObject::FieldAssociations.
int = obj.GetTargetFieldType () - The target field type for accessing the target array. Valid
values are those from enum vtkDataObject::FieldAssociations.
obj.SetTargetFieldType (int ) - The target field type for accessing the target array. Valid values
are those from enum vtkDataObject::FieldAssociations.
int = obj.FillInputPortInformation (int port, vtkInformation info) - Set
the input type of the algorithm to vtkGraph.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1818
37.110
vtkTreeFieldAggregator
37.110.1
Usage
vtkTreeFieldAggregator may be used to assign sizes to all the vertices in the tree, based on the sizes of the leaves.
The size of a vertex will equal the sum of the sizes of the child vertices. If you have a data array with values for all
leaves, you may specify that array, and the values will be filled in for interior tree vertices. If you do not yet have an
array, you may tell the filter to create a new array, assuming that the size of each leaf vertex is 1. You may optionally
set a flag to first take the log of all leaf values before aggregating.
To create an instance of class vtkTreeFieldAggregator, simply invoke its constructor as follows
obj = vtkTreeFieldAggregator
37.110.2
Methods
The class vtkTreeFieldAggregator has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTreeFieldAggregator
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTreeFieldAggregator = obj.NewInstance ()
vtkTreeFieldAggregator = obj.SafeDownCast (vtkObject o)
string = obj.GetField () - The field to aggregate. If this is a string array, the entries are converted
to double. TODO: Remove this field and use the ArrayToProcess in vtkAlgorithm.
obj.SetField (string ) - The field to aggregate. If this is a string array, the entries are converted to
double. TODO: Remove this field and use the ArrayToProcess in vtkAlgorithm.
double = obj.GetMinValue () - If the value of the vertex is less than MinValue then consider its
value to be minVal.
obj.SetMinValue (double ) - If the value of the vertex is less than MinValue then consider its value
to be minVal.
obj.SetLeafVertexUnitSize (bool ) - If set, the algorithm will assume a size of 1 for each leaf
vertex.
bool = obj.GetLeafVertexUnitSize () - If set, the algorithm will assume a size of 1 for each
leaf vertex.
obj.LeafVertexUnitSizeOn () - If set, the algorithm will assume a size of 1 for each leaf vertex.
obj.LeafVertexUnitSizeOff () - If set, the algorithm will assume a size of 1 for each leaf vertex.
obj.SetLogScale (bool ) - If set, the leaf values in the tree will be logarithmically scaled (base 10).
bool = obj.GetLogScale () - If set, the leaf values in the tree will be logarithmically scaled (base
10).
obj.LogScaleOn () - If set, the leaf values in the tree will be logarithmically scaled (base 10).
obj.LogScaleOff () - If set, the leaf values in the tree will be logarithmically scaled (base 10).
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.111 vtkTreeLayoutStrategy
37.111
1819
vtkTreeLayoutStrategy
37.111.1
Usage
Assigns points to the nodes of a tree in either a standard or radial layout. The standard layout places each level on
a horizontal line, while the radial layout places each level on a concentric circle. You may specify the sweep angle of
the tree which constrains the tree to be contained within a wedge. Also, you may indicate the log scale of the tree,
which diminishes the length of arcs at lower levels of the tree. Values near zero give a large proportion of the space
to the tree levels near the root, while values near one give nearly equal proportions of space to all tree levels.
The user may also specify an array to use to indicate the distance from the root, either vertically (for standard layout)
or radially (for radial layout). You specify this with SetDistanceArrayName().
To create an instance of class vtkTreeLayoutStrategy, simply invoke its constructor as follows
obj = vtkTreeLayoutStrategy
37.111.2
Methods
The class vtkTreeLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTreeLayoutStrategy class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTreeLayoutStrategy = obj.NewInstance ()
vtkTreeLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.Layout () - Perform the tree layout.
obj.SetAngle (double ) - The sweep angle of the tree. For a standard tree layout, this should be
between 0 and 180. For a radial tree layout, this can be between 0 and 360.
double = obj.GetAngleMinValue () - The sweep angle of the tree. For a standard tree layout,
this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.
double = obj.GetAngleMaxValue () - The sweep angle of the tree. For a standard tree layout,
this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.
double = obj.GetAngle () - The sweep angle of the tree. For a standard tree layout, this should be
between 0 and 180. For a radial tree layout, this can be between 0 and 360.
obj.SetRadial (bool ) - If set, the tree is laid out with levels on concentric circles around the root. If
unset (default), the tree is laid out with levels on horizontal lines.
bool = obj.GetRadial () - If set, the tree is laid out with levels on concentric circles around the root.
If unset (default), the tree is laid out with levels on horizontal lines.
obj.RadialOn () - If set, the tree is laid out with levels on concentric circles around the root. If unset
(default), the tree is laid out with levels on horizontal lines.
obj.RadialOff () - If set, the tree is laid out with levels on concentric circles around the root. If unset
(default), the tree is laid out with levels on horizontal lines.
obj.SetLogSpacingValue (double ) - The spacing of tree levels. Levels near zero give more
space to levels near the root, while levels near one (the default) create evenly-spaced levels. Levels above
one give more space to levels near the leaves.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1820
double = obj.GetLogSpacingValue () - The spacing of tree levels. Levels near zero give more
space to levels near the root, while levels near one (the default) create evenly-spaced levels. Levels above
one give more space to levels near the leaves.
obj.SetLeafSpacing (double ) - The spacing of leaves. Levels near one evenly space leaves with
no gaps between subtrees. Levels near zero creates large gaps between subtrees.
double = obj.GetLeafSpacingMinValue () - The spacing of leaves. Levels near one evenly
space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.
double = obj.GetLeafSpacingMaxValue () - The spacing of leaves. Levels near one evenly
space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.
double = obj.GetLeafSpacing () - The spacing of leaves. Levels near one evenly space leaves
with no gaps between subtrees. Levels near zero creates large gaps between subtrees.
obj.SetDistanceArrayName (string ) - Get/Set the array to use to determine the distance from
the root.
string = obj.GetDistanceArrayName () - Get/Set the array to use to determine the distance
from the root.
37.112
vtkTreeLevelsFilter
37.112.1
Usage
The filter currently add two arrays to the incoming vtkTree datastructure. 1) "levels" this is the distance from the root
of the vertex. Root = 0 and you add 1 for each level down from the root 2) "leaf" this array simply indicates whether
the vertex is a leaf or not
.SECTION Thanks Thanks to Brian Wylie from Sandia National Laboratories for creating this class.
To create an instance of class vtkTreeLevelsFilter, simply invoke its constructor as follows
obj = vtkTreeLevelsFilter
37.112.2
Methods
The class vtkTreeLevelsFilter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTreeLevelsFilter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTreeLevelsFilter = obj.NewInstance ()
vtkTreeLevelsFilter = obj.SafeDownCast (vtkObject o)
37.113
vtkTreeMapLayout
37.114 vtkTreeMapLayoutStrategy
37.113.1
1821
Usage
vtkTreeMapLayout assigns rectangular regions to each vertex in the tree, creating a tree map. The data is added
as a data array with four components per tuple representing the location and size of the rectangle using the format
(Xmin, Xmax, Ymin, Ymax).
This algorithm relies on a helper class to perform the actual layout. This helper class is a subclass of vtkTreeMapLayoutStrategy.
.SECTION Thanks Thanks to Brian Wylie and Ken Moreland from Sandia National Laboratories for help developing
this class.
Tree map concept comes from: Shneiderman, B. 1992. Tree visualization with tree-maps: 2-d space-filling approach. ACM Trans. Graph. 11, 1 (Jan. 1992), 92-99.
To create an instance of class vtkTreeMapLayout, simply invoke its constructor as follows
obj = vtkTreeMapLayout
37.113.2
Methods
The class vtkTreeMapLayout has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkTreeMapLayout class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTreeMapLayout = obj.NewInstance ()
vtkTreeMapLayout = obj.SafeDownCast (vtkObject o)
string = obj.GetRectanglesFieldName () - The field name to use for storing the rectangles
for each vertex. The rectangles are stored in a quadruple float array (minX, maxX, minY, maxY).
obj.SetRectanglesFieldName (string ) - The field name to use for storing the rectangles for
each vertex. The rectangles are stored in a quadruple float array (minX, maxX, minY, maxY).
obj.SetSizeArrayName (string name) - The strategy to use when laying out the tree map.
vtkTreeMapLayoutStrategy = obj.GetLayoutStrategy () - The strategy to use when laying out the tree map.
obj.SetLayoutStrategy (vtkTreeMapLayoutStrategy strategy) - The strategy to use
when laying out the tree map.
vtkIdType = obj.FindVertex (float pnt[2], float binfo) - Returns the vertex id that
contains pnt (or -1 if no one contains it)
obj.GetBoundingBox (vtkIdType id, float binfo) - Return the min and max 2D points of
the vertexs bounding box
long = obj.GetMTime () - Get the modification time of the layout algorithm.
37.114
vtkTreeMapLayoutStrategy
1822
37.114.1
Usage
All subclasses of this class perform a tree map layout on a tree. This involves assigning a rectangular region to each
vertex in the tree, and placing that information in a data array with four components per tuple representing (Xmin,
Xmax, Ymin, Ymax).
Instances of subclasses of this class may be assigned as the layout strategy to vtkTreeMapLayout
.SECTION Thanks Thanks to Brian Wylie and Ken Moreland from Sandia National Laboratories for help developing
this class.
To create an instance of class vtkTreeMapLayoutStrategy, simply invoke its constructor as follows
obj = vtkTreeMapLayoutStrategy
37.114.2
Methods
The class vtkTreeMapLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTreeMapLayoutStrategy
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTreeMapLayoutStrategy = obj.NewInstance ()
vtkTreeMapLayoutStrategy = obj.SafeDownCast (vtkObject o)
vtkIdType = obj.FindVertex (vtkTree tree, vtkDataArray areaArray, float
pnt[2]) - Find the vertex at a certain location, or -1 if none found.
37.115
vtkTreeMapToPolyData
37.115.1
Usage
This algorithm requires that the vtkTreeMapLayout filter has already applied to the data in order to create the
quadruple array (min x, max x, min y, max y) of bounds for each vertex of the tree.
To create an instance of class vtkTreeMapToPolyData, simply invoke its constructor as follows
obj = vtkTreeMapToPolyData
37.115.2
Methods
The class vtkTreeMapToPolyData has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTreeMapToPolyData
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTreeMapToPolyData = obj.NewInstance ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.116 vtkTreeOrbitLayoutStrategy
1823
37.116
vtkTreeOrbitLayoutStrategy
37.116.1
Usage
Assigns points to the nodes of a tree to an orbital layout. Each parent is orbited by its children, recursively.
To create an instance of class vtkTreeOrbitLayoutStrategy, simply invoke its constructor as follows
obj = vtkTreeOrbitLayoutStrategy
37.116.2
Methods
The class vtkTreeOrbitLayoutStrategy has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTreeOrbitLayoutStrategy
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTreeOrbitLayoutStrategy = obj.NewInstance ()
vtkTreeOrbitLayoutStrategy = obj.SafeDownCast (vtkObject o)
obj.Layout () - Perform the orbital layout.
obj.SetLogSpacingValue (double ) - The spacing of orbital levels. Levels near zero give more
space to levels near the root, while levels near one (the default) create evenly-spaced levels. Levels above
one give more space to levels near the leaves.
double = obj.GetLogSpacingValue () - The spacing of orbital levels. Levels near zero give
more space to levels near the root, while levels near one (the default) create evenly-spaced levels. Levels
above one give more space to levels near the leaves.
obj.SetLeafSpacing (double ) - The spacing of leaves. Levels near one evenly space leaves with
no gaps between subtrees. Levels near zero creates large gaps between subtrees.
double = obj.GetLeafSpacingMinValue () - The spacing of leaves. Levels near one evenly
space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1824
37.117
vtkTreeRingToPolyData
37.117.1
Usage
This algorithm requires that the vtkTreeRingLayout filter has already been applied to the data in order to create the
quadruple array (start angle, end angle, inner radius, outer radius) of bounds for each vertex of the tree.
To create an instance of class vtkTreeRingToPolyData, simply invoke its constructor as follows
obj = vtkTreeRingToPolyData
37.117.2
Methods
The class vtkTreeRingToPolyData has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkTreeRingToPolyData
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTreeRingToPolyData = obj.NewInstance ()
vtkTreeRingToPolyData = obj.SafeDownCast (vtkObject o)
obj.SetSectorsArrayName (string name) - Define a shrink percentage for each of the sectors.
obj.SetShrinkPercentage (double ) - Define a shrink percentage for each of the sectors.
double = obj.GetShrinkPercentage () - Define a shrink percentage for each of the sectors.
int = obj.FillInputPortInformation (int port, vtkInformation info)
37.118
vtkTulipReader
37.119 vtkUnivariateStatisticsAlgorithm
37.118.1
1825
Usage
vtkTulipReader reads in files in the Tulip format. Definition of the Tulip file format can be found online at: http://tulip.labri.fr/tlpformat.php An example is the following (nodes 0 1 2 3 4
37.118.2
Methods
The class vtkTulipReader has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkTulipReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkTulipReader = obj.NewInstance ()
vtkTulipReader = obj.SafeDownCast (vtkObject o)
string = obj.GetFileName () - The Tulip file name.
obj.SetFileName (string ) - The Tulip file name.
37.119
vtkUnivariateStatisticsAlgorithm
37.119.1
Usage
This class specializes statistics algorithms to the univariate case, where a number of columns of interest can be
selected in the input data set. This is done by the means of the following functions:
ResetColumns() - reset the list of columns of interest. Add/RemoveColum( namCol ) - try to add/remove column
with name namCol to/from the list. SetColumnStatus ( namCol, status ) - mostly for UI wrapping purposes, try to
add/remove (depending on status) namCol from the list of columns of interest. The verb "try" is used in the sense
that neither attempting to repeat an existing entry nor to remove a non-existent entry will work.
.SECTION Thanks Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.
To create an instance of class vtkUnivariateStatisticsAlgorithm, simply invoke its constructor as follows
obj = vtkUnivariateStatisticsAlgorithm
37.119.2
Methods
The class vtkUnivariateStatisticsAlgorithm has several methods that can be used. They are listed below. Note that
the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When
in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkUnivariateStatisticsAlgorithm class.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1826
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkUnivariateStatisticsAlgorithm = obj.NewInstance ()
vtkUnivariateStatisticsAlgorithm = obj.SafeDownCast (vtkObject o)
obj.AddColumn (string namCol) - Convenience method to create a request with a single column
name namCol in a single call; this is the preferred method to select columns, ensuring selection consistency (a single column per request). Warning: no name checking is performed on namCol; it is the users
responsibility to use valid column names.
int = obj.RequestSelectedColumns () - Use the current column status values to produce a
new request for statistics to be produced when RequestData() is called. Unlike the superclass implementation,
this version adds a new request for each selected column instead of a single request containing all the
columns.
37.120
vtkVertexDegree
37.120.1
Usage
Adds an attribute array with the degree of each vertex. By default the name of the array will be "VertexDegree", but
that can be changed by calling SetOutputArrayName("foo");
To create an instance of class vtkVertexDegree, simply invoke its constructor as follows
obj = vtkVertexDegree
37.120.2
Methods
The class vtkVertexDegree has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkVertexDegree class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkVertexDegree = obj.NewInstance ()
vtkVertexDegree = obj.SafeDownCast (vtkObject o)
obj.SetOutputArrayName (string ) - Set the output array name. If no output array name is set
then the name VertexDegree is used.
37.121
vtkXMLTreeReader
37.121 vtkXMLTreeReader
37.121.1
1827
Usage
vtkXMLTreeReader parses an XML file and uses the nesting structure of the XML tags to generate a tree. Node
attributes are assigned to node arrays, and the special arrays .tagname and .chardata contain the tag type and the
text internal to the tag, respectively. The arrays are of type vtkStringArray. There is an array for each attribute type
in the XML file, even if it appears in only one tag. If an attribute is missing from a tag, its value is the empty string.
If MaskArrays is on (the default is off), the filter will additionally make bit arrays whose names are prepended with
".valid." which are 1 if the element contains that attribute, and 0 otherwise.
For example, the XML file containing the text:
would be parsed into a tree with the following node IDs and structure:
0
1
2
3
4
5
name
initials other
age
.tagname .chardata
-----------------------------------------------------------------------------------------------jeff
(empty)
(empty)
26
node
" this is text in jeffs node\n \n \n \n"
joe
(empty)
(empty)
(empty)
node
"\n
\n
\n "
al
amb
something (empty)
node
(empty)
dave
(empty)
(empty)
30
node
(empty)
lisa
(empty)
(empty)
(empty)
node
"this is text in lisas node"
darlene
(empty)
(empty)
29
node
(empty)
.valid.name
.valid.initials
.valid.other
.valid.age
--------------------------------------------------------1
0
0
1
1
0
0
0
1
1
1
0
1
0
0
1
1
0
0
0
1
0
0
1
1828
37.121.2
Methods
The class vtkXMLTreeReader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkXMLTreeReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkXMLTreeReader = obj.NewInstance ()
vtkXMLTreeReader = obj.SafeDownCast (vtkObject o)
string = obj.GetFileName () - If set, reads in the XML file specified.
obj.SetFileName (string ) - If set, reads in the XML file specified.
string = obj.GetXMLString () - If set, and FileName is not set, reads in the XML string.
obj.SetXMLString (string ) - If set, and FileName is not set, reads in the XML string.
string = obj.GetEdgePedigreeIdArrayName () - The name of the edge pedigree ids. Default
is "edge id".
obj.SetEdgePedigreeIdArrayName (string ) - The name of the edge pedigree ids. Default is
"edge id".
string = obj.GetVertexPedigreeIdArrayName () - The name of the vertex pedigree ids.
Default is "vertex id".
obj.SetVertexPedigreeIdArrayName (string ) - The name of the vertex pedigree ids. Default is "vertex id".
obj.SetGenerateEdgePedigreeIds (bool ) - Set whether to use an property from the XML file
as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
bool = obj.GetGenerateEdgePedigreeIds () - Set whether to use an property from the XML
file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
obj.GenerateEdgePedigreeIdsOn () - Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
obj.GenerateEdgePedigreeIdsOff () - Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
obj.SetGenerateVertexPedigreeIds (bool ) - Set whether to use an property from the XML
file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
bool = obj.GetGenerateVertexPedigreeIds () - Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is
on.
obj.GenerateVertexPedigreeIdsOn () - Set whether to use an property from the XML file as
pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
obj.GenerateVertexPedigreeIdsOff () - Set whether to use an property from the XML file as
pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
bool = obj.GetMaskArrays () - If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. Default is off.
obj.SetMaskArrays (bool ) - If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. Default is off.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
37.121 vtkXMLTreeReader
1829
obj.MaskArraysOn () - If on, makes bit arrays for each attribute with name .valid.attribute_name for
each attribute. Default is off.
obj.MaskArraysOff () - If on, makes bit arrays for each attribute with name .valid.attribute_name for
each attribute. Default is off.
bool = obj.GetReadCharData () - If on, stores the XML character data (i.e. textual data between
tags) into an array named CharDataField, otherwise this field is skipped. Default is off.
obj.SetReadCharData (bool ) - If on, stores the XML character data (i.e. textual data between
tags) into an array named CharDataField, otherwise this field is skipped. Default is off.
obj.ReadCharDataOn () - If on, stores the XML character data (i.e. textual data between tags) into an
array named CharDataField, otherwise this field is skipped. Default is off.
obj.ReadCharDataOff () - If on, stores the XML character data (i.e. textual data between tags) into
an array named CharDataField, otherwise this field is skipped. Default is off.
bool = obj.GetReadTagName () - If on, stores the XML tag name data in a field called .tagname
otherwise this field is skipped. Default is on.
obj.SetReadTagName (bool ) - If on, stores the XML tag name data in a field called .tagname
otherwise this field is skipped. Default is on.
obj.ReadTagNameOn () - If on, stores the XML tag name data in a field called .tagname otherwise this
field is skipped. Default is on.
obj.ReadTagNameOff () - If on, stores the XML tag name data in a field called .tagname otherwise
this field is skipped. Default is on.
1830
Chapter 38
1832
vtkFacetWriter
vtkFLUENTReader
vtkGAMBITReader
vtkGaussianCubeReader
vtkGenericDataObjectReader
vtkGenericDataObjectWriter
vtkGenericEnSightReader
vtkGenericMovieWriter
vtkGESignaReader
vtkGlobFileNames
vtkGraphReader
vtkGraphWriter
vtkImageReader
vtkImageReader2
vtkImageReader2Collection
vtkImageReader2Factory
vtkImageWriter
vtkInputStream
vtkIVWriter
vtkJPEGReader
vtkJPEGWriter
vtkMaterialLibrary
vtkMCubesReader
vtkMCubesWriter
vtkMedicalImageProperties
vtkMedicalImageReader2
vtkMetaImageReader
vtkMetaImageWriter
vtkMFIXReader
vtkMINCImageAttributes
vtkMINCImageReader
vtkMINCImageWriter
vtkMoleculeReaderBase
vtkMultiBlockPLOT3DReader
vtkNetCDFCFReader
vtkNetCDFPOPReader
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1833
vtkNetCDFReader
vtkOBJReader
vtkOpenFOAMReader
vtkOutputStream
vtkParticleReader
vtkPDBReader
vtkPLOT3DReader
vtkPLYReader
vtkPLYWriter
vtkPNGReader
vtkPNGWriter
vtkPNMReader
vtkPNMWriter
vtkPolyDataReader
vtkPolyDataWriter
vtkPostScriptWriter
vtkRectilinearGridReader
vtkRectilinearGridWriter
vtkRowQuery
vtkRowQueryToTable
vtkRTXMLPolyDataReader
vtkSESAMEReader
vtkShaderCodeLibrary
vtkSimplePointsReader
vtkSLACParticleReader
vtkSLACReader
vtkSLCReader
vtkSortFileNames
vtkSQLDatabase
vtkSQLDatabaseSchema
vtkSQLiteDatabase
vtkSQLiteQuery
vtkSQLQuery
vtkSTLReader
vtkSTLWriter
vtkStructuredGridReader
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1834
vtkStructuredGridWriter
vtkStructuredPointsReader
vtkStructuredPointsWriter
vtkTableReader
vtkTableWriter
vtkTecplotReader
vtkTIFFReader
vtkTIFFWriter
vtkTreeReader
vtkTreeWriter
vtkUGFacetReader
vtkUnstructuredGridReader
vtkUnstructuredGridWriter
vtkVolume16Reader
vtkVolumeReader
vtkWriter
vtkXMLCompositeDataReader
vtkXMLCompositeDataWriter
vtkXMLDataParser
vtkXMLDataReader
vtkXMLDataSetWriter
vtkXMLFileReadTester
vtkXMLHierarchicalBoxDataReader
vtkXMLHierarchicalBoxDataWriter
vtkXMLHierarchicalDataReader
vtkXMLHyperOctreeReader
vtkXMLHyperOctreeWriter
vtkXMLImageDataReader
vtkXMLImageDataWriter
vtkXMLMaterial
vtkXMLMaterialParser
vtkXMLMaterialReader
vtkXMLMultiBlockDataReader
vtkXMLMultiBlockDataWriter
vtkXMLMultiGroupDataReader
vtkXMLParser
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1835
vtkXMLPDataReader
vtkXMLPDataSetWriter
vtkXMLPDataWriter
vtkXMLPImageDataReader
vtkXMLPImageDataWriter
vtkXMLPolyDataReader
vtkXMLPolyDataWriter
vtkXMLPPolyDataReader
vtkXMLPPolyDataWriter
vtkXMLPRectilinearGridReader
vtkXMLPRectilinearGridWriter
vtkXMLPStructuredDataReader
vtkXMLPStructuredDataWriter
vtkXMLPStructuredGridReader
vtkXMLPStructuredGridWriter
vtkXMLPUnstructuredDataReader
vtkXMLPUnstructuredDataWriter
vtkXMLPUnstructuredGridReader
vtkXMLPUnstructuredGridWriter
vtkXMLReader
vtkXMLRectilinearGridReader
vtkXMLRectilinearGridWriter
vtkXMLShader
vtkXMLStructuredDataReader
vtkXMLStructuredDataWriter
vtkXMLStructuredGridReader
vtkXMLStructuredGridWriter
vtkXMLUnstructuredDataReader
vtkXMLUnstructuredDataWriter
vtkXMLUnstructuredGridReader
vtkXMLUnstructuredGridWriter
vtkXMLUtilities
vtkXMLWriter
vtkXYZMolReader
vtkZLibDataCompressor
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1836
38.1
vtkAbstractParticleWriter
38.1.1
Usage
vtkAbstractParticleWriter is an abstract class which is used by vtkTemporalStreamTracer to write particles out during
simulations. This class is abstract and provides a TimeStep and FileName. Subclasses of this should provide the
necessary IO.
To create an instance of class vtkAbstractParticleWriter, simply invoke its constructor as follows
obj = vtkAbstractParticleWriter
38.1.2
Methods
The class vtkAbstractParticleWriter has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkAbstractParticleWriter
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAbstractParticleWriter = obj.NewInstance ()
vtkAbstractParticleWriter = obj.SafeDownCast (vtkObject o)
obj.SetTimeStep (int ) - Set/get the TimeStep that is being written
int = obj.GetTimeStep () - Set/get the TimeStep that is being written
obj.SetTimeValue (double ) - Before writing the current data out, set the TimeValue (optional) The
TimeValue is a float/double value that corresonds to the real time of the data, it may not be regular, whereas
the TimeSteps are simple increments.
double = obj.GetTimeValue () - Before writing the current data out, set the TimeValue (optional)
The TimeValue is a float/double value that corresonds to the real time of the data, it may not be regular,
whereas the TimeSteps are simple increments.
obj.SetFileName (string ) - Set/get the FileName that is being written to
string = obj.GetFileName () - Set/get the FileName that is being written to
obj.SetCollectiveIO (int ) - When running in parallel, this writer may be capable of Collective IO
operations (HDF5). By default, this is off.
int = obj.GetCollectiveIO () - When running in parallel, this writer may be capable of Collective
IO operations (HDF5). By default, this is off.
obj.SetWriteModeToCollective () - When running in parallel, this writer may be capable of Collective IO operations (HDF5). By default, this is off.
obj.SetWriteModeToIndependent () - When running in parallel, this writer may be capable of
Collective IO operations (HDF5). By default, this is off.
obj.CloseFile () - Close the file after a write. This is optional but may protect against data loss in
between steps
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
38.2 vtkArrayReader
38.2
1837
vtkArrayReader
38.2.1
Usage
38.2.2
Methods
The class vtkArrayReader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkArrayReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkArrayReader = obj.NewInstance ()
vtkArrayReader = obj.SafeDownCast (vtkObject o)
string = obj.GetFileName () - Set the filesystem location from which data will be read.
obj.SetFileName (string ) - Set the filesystem location from which data will be read.
38.3
vtkArrayWriter
38.3.1
Usage
vtkArrayWriter serializes sparse and dense array data using a text-based format that is human-readable and easily
parsed (default option). The WriteBinary array option can be set to true in the Write method, which will serialize the
sparse and dense array data using a binary format that is optimized for rapid throughput.
Inputs: Input port 0: (required) vtkArrayData object containing a sparse or dense array.
Output Format: The first line of output will contain the array type (sparse or dense) and the type of values stored in
the array (double, integer, string, etc).
The second line of output will contain the array extents along each dimension of the array, followed by the number
of non-null values stored in the array.
For sparse arrays, each subsequent line of output will contain the coordinates and value for each non-null value
stored in the array.
For dense arrays, each subsequent line of output will contain one value from the array, stored in the same order as
that used by vtkArrayCoordinateIterator.
To create an instance of class vtkArrayWriter, simply invoke its constructor as follows
obj = vtkArrayWriter
1838
38.3.2
Methods
The class vtkArrayWriter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkArrayWriter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkArrayWriter = obj.NewInstance ()
vtkArrayWriter = obj.SafeDownCast (vtkObject o)
bool = obj.Write (vtkStdString &file_name, bool WriteBinaryfalse) - Write input port 0 data to a file.
38.4
vtkAVSucdReader
38.4.1
Usage
vtkAVSucdReader creates an unstructured grid dataset. It reads binary or ASCII files stored in UCD format, with
optional data stored at the nodes or at the cells of the model. A cell-based fielddata stores the material id. The
class can automatically detect the endian-ness of the binary files.
To create an instance of class vtkAVSucdReader, simply invoke its constructor as follows
obj = vtkAVSucdReader
38.4.2
Methods
The class vtkAVSucdReader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkAVSucdReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAVSucdReader = obj.NewInstance ()
vtkAVSucdReader = obj.SafeDownCast (vtkObject o)
obj.SetFileName (string ) - Specify file name of AVS UCD datafile to read
string = obj.GetFileName () - Specify file name of AVS UCD datafile to read
obj.SetBinaryFile (int ) - Is the file to be read written in binary format (as opposed to ascii).
int = obj.GetBinaryFile () - Is the file to be read written in binary format (as opposed to ascii).
obj.BinaryFileOn () - Is the file to be read written in binary format (as opposed to ascii).
obj.BinaryFileOff () - Is the file to be read written in binary format (as opposed to ascii).
int = obj.GetNumberOfCells () - Get the total number of cells.
int = obj.GetNumberOfNodes () - Get the total number of nodes.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
38.5 vtkBase64InputStream
1839
38.5
vtkBase64InputStream
1840
38.5.1
Usage
38.5.2
Methods
The class vtkBase64InputStream has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkBase64InputStream
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBase64InputStream = obj.NewInstance ()
vtkBase64InputStream = obj.SafeDownCast (vtkObject o)
obj.StartReading () - Called after the stream position has been set by the caller, but before any Seek
or Read calls. The stream position should not be adjusted by the caller until after an EndReading call.
int = obj.Seek (long offset) - Seek to the given offset in the input data. Returns 1 for success,
0 for failure.
long = obj.Read (string data, long length) - Read input data of the given length. Returns amount actually read.
obj.EndReading () - Called after all desired calls to Seek and Read have been made. After this call,
the caller is free to change the position of the stream. Additional reads should not be done until after another
call to StartReading.
38.6
vtkBase64OutputStream
38.6.1
Usage
38.6.2
Methods
The class vtkBase64OutputStream has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkBase64OutputStream
class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
38.7 vtkBase64Utilities
1841
vtkBase64OutputStream = obj.NewInstance ()
vtkBase64OutputStream = obj.SafeDownCast (vtkObject o)
int = obj.StartWriting () - Called after the stream position has been set by the caller, but before
any Write calls. The stream position should not be adjusted by the caller until after an EndWriting call.
int = obj.Write (string data, long length) - Write output data of the given length.
int = obj.EndWriting () - Called after all desired calls to Write have been made. After this call, the
caller is free to change the position of the stream. Additional writes should not be done until after another call
to StartWriting.
38.7
vtkBase64Utilities
38.7.1
Usage
38.7.2
Methods
The class vtkBase64Utilities has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkBase64Utilities class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBase64Utilities = obj.NewInstance ()
vtkBase64Utilities = obj.SafeDownCast (vtkObject o)
38.8
vtkBMPReader
38.8.1
Usage
vtkBMPReader is a source object that reads Windows BMP files. This includes indexed and 24bit bitmaps Usually,
all BMPs are converted to 24bit RGB, but BMPs may be output as 8bit images with a LookupTable if the Allow8BitBMP flag is set.
BMPReader creates structured point datasets. The dimension of the dataset depends upon the number of files
read. Reading a single file results in a 2D image, while reading more than one file results in a 3D volume.
To read a volume, files must be of the form "FileName.<number>" (e.g., foo.bmp.0, foo.bmp.1, ...). You must also
specify the image range. This range specifies the beginning and ending files to read (range can be any pair of
non-negative numbers).
The default behavior is to read a single file. In this case, the form of the file is simply "FileName" (e.g., foo.bmp).
To create an instance of class vtkBMPReader, simply invoke its constructor as follows
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1842
obj = vtkBMPReader
38.8.2
Methods
The class vtkBMPReader has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkBMPReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBMPReader = obj.NewInstance ()
vtkBMPReader = obj.SafeDownCast (vtkObject o)
int = obj.GetDepth () - Returns the depth of the BMP, either 8 or 24.
int = obj.CanReadFile (string fname) - Is the given file a BMP file?
string = obj.GetFileExtensions () - Return a descriptive name for the file format that might
be useful in a GUI.
string = obj.GetDescriptiveName () - If this flag is set and the BMP reader encounters an 8bit
file, the data will be kept as unsigned chars and a lookuptable will be exported
obj.SetAllow8BitBMP (int ) - If this flag is set and the BMP reader encounters an 8bit file, the
data will be kept as unsigned chars and a lookuptable will be exported
int = obj.GetAllow8BitBMP () - If this flag is set and the BMP reader encounters an 8bit file, the
data will be kept as unsigned chars and a lookuptable will be exported
obj.Allow8BitBMPOn () - If this flag is set and the BMP reader encounters an 8bit file, the data will
be kept as unsigned chars and a lookuptable will be exported
obj.Allow8BitBMPOff () - If this flag is set and the BMP reader encounters an 8bit file, the data will
be kept as unsigned chars and a lookuptable will be exported
vtkLookupTable = obj.GetLookupTable ()
38.9
vtkBMPWriter
38.9.1
Usage
vtkBMPWriter writes BMP files. The data type of the file is unsigned char regardless of the input type.
To create an instance of class vtkBMPWriter, simply invoke its constructor as follows
obj = vtkBMPWriter
38.9.2
Methods
The class vtkBMPWriter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkBMPWriter class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
38.10 vtkBYUReader
1843
38.10
vtkBYUReader
38.10.1
Usage
vtkBYUReader is a source object that reads MOVIE.BYU polygon files. These files consist of a geometry file (.g), a
scalar file (.s), a displacement or vector file (.d), and a 2D texture coordinate file (.t).
To create an instance of class vtkBYUReader, simply invoke its constructor as follows
obj = vtkBYUReader
38.10.2
Methods
The class vtkBYUReader has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkBYUReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBYUReader = obj.NewInstance ()
vtkBYUReader = obj.SafeDownCast (vtkObject o)
obj.SetGeometryFileName (string ) - Specify name of geometry FileName.
string = obj.GetGeometryFileName () - Specify name of geometry FileName.
obj.SetFileName (string f) - Specify name of geometry FileName (alias).
string = obj.GetFileName () - Specify name of displacement FileName.
obj.SetDisplacementFileName (string ) - Specify name of displacement FileName.
string = obj.GetDisplacementFileName () - Specify name of displacement FileName.
obj.SetScalarFileName (string ) - Specify name of scalar FileName.
string = obj.GetScalarFileName () - Specify name of scalar FileName.
obj.SetTextureFileName (string ) - Specify name of texture coordinates FileName.
string = obj.GetTextureFileName () - Specify name of texture coordinates FileName.
obj.SetReadDisplacement (int ) - Turn on/off the reading of the displacement file.
int = obj.GetReadDisplacement () - Turn on/off the reading of the displacement file.
obj.ReadDisplacementOn () - Turn on/off the reading of the displacement file.
obj.ReadDisplacementOff () - Turn on/off the reading of the displacement file.
obj.SetReadScalar (int ) - Turn on/off the reading of the scalar file.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1844
38.11
vtkBYUWriter
38.11.1
Usage
vtkBYUWriter writes MOVIE.BYU polygonal files. These files consist of a geometry file (.g), a scalar file (.s), a
displacement or vector file (.d), and a 2D texture coordinate file (.t). These files must be specified to the object,
the appropriate boolean variables must be true, and data must be available from the input for the files to be written.
WARNING: this writer does not currently write triangle strips. Use vtkTriangleFilter to convert strips to triangles.
To create an instance of class vtkBYUWriter, simply invoke its constructor as follows
obj = vtkBYUWriter
38.11.2
Methods
The class vtkBYUWriter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkBYUWriter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkBYUWriter = obj.NewInstance ()
vtkBYUWriter = obj.SafeDownCast (vtkObject o)
obj.SetGeometryFileName (string ) - Specify the name of the geometry file to write.
string = obj.GetGeometryFileName () - Specify the name of the geometry file to write.
obj.SetDisplacementFileName (string ) - Specify the name of the displacement file to write.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
38.12 vtkCGMWriter
1845
38.12
vtkCGMWriter
38.12.1
Usage
vtkCGMWriter writes CGM (Computer Graphics Metafile) output. CGM is a 2D graphics vector format typically used
by large plotters. This writer can handle vertices, lines, polygons, and triangle strips in any combination. Colors are
specified either 1) from cell scalars (assumed to be RGB or RGBA color specification), 2) from a specified color; or
3) randomly assigned colors.
Note: During output of the polygonal data, triangle strips are converted to triangles, and polylines to lines. Also, due
to limitations in the CGM color model, only 256 colors are available to the color palette.
To create an instance of class vtkCGMWriter, simply invoke its constructor as follows
obj = vtkCGMWriter
38.12.2
Methods
The class vtkCGMWriter has several methods that can be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance of the vtkCGMWriter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1846
vtkCGMWriter = obj.NewInstance ()
vtkCGMWriter = obj.SafeDownCast (vtkObject o)
obj.SetViewport (vtkViewport ) - Specify a vtkViewport object to be used to transform the vtkPolyData points into 2D coordinates. By default (no vtkViewport specified), the point coordinates are generated by ignoring the z values. If a viewport is defined, then the points are transformed into viewport coordinates.
vtkViewport = obj.GetViewport () - Specify a vtkViewport object to be used to transform the
vtkPolyData points into 2D coordinates. By default (no vtkViewport specified), the point coordinates are
generated by ignoring the z values. If a viewport is defined, then the points are transformed into viewport
coordinates.
obj.SetSort (int ) - Turn on/off the sorting of the cells via depth. If enabled, polygonal cells will be
sorted from back to front, i.e., a Painters algorithm sort.
int = obj.GetSort () - Turn on/off the sorting of the cells via depth. If enabled, polygonal cells will
be sorted from back to front, i.e., a Painters algorithm sort.
obj.SetResolution (int ) - Specify the resolution of the CGM file. This number is used to integerize the maximum coordinate range of the plot file.
int = obj.GetResolutionMinValue () - Specify the resolution of the CGM file. This number is
used to integerize the maximum coordinate range of the plot file.
int = obj.GetResolutionMaxValue () - Specify the resolution of the CGM file. This number is
used to integerize the maximum coordinate range of the plot file.
int = obj.GetResolution () - Specify the resolution of the CGM file. This number is used to
integerize the maximum coordinate range of the plot file.
obj.SetColorMode (int ) - Control how output polydata is colored. By default (ColorModeToDefault), if per cell colors are defined (unsigned chars of 1-4 components), then the cells are colored with
these values. (If point colors are defined and cell colors are not, you can use vtkPointDataToCellData to
convert the point colors to cell colors.) Otherwise, by default, the cells are set to the specified color. If ColorModeToSpecifiedColor is set, then the primitives will all be set to this color. If ColorModeToRandomColors is
set, each cell will be randomly assigned a color.
int = obj.GetColorMode () - Control how output polydata is colored. By default (ColorModeToDefault), if per cell colors are defined (unsigned chars of 1-4 components), then the cells are colored with
these values. (If point colors are defined and cell colors are not, you can use vtkPointDataToCellData to
convert the point colors to cell colors.) Otherwise, by default, the cells are set to the specified color. If ColorModeToSpecifiedColor is set, then the primitives will all be set to this color. If ColorModeToRandomColors is
set, each cell will be randomly assigned a color.
obj.SetColorModeToDefault () - Control how output polydata is colored. By default (ColorModeToDefault), if per cell colors are defined (unsigned chars of 1-4 components), then the cells are colored with
these values. (If point colors are defined and cell colors are not, you can use vtkPointDataToCellData to
convert the point colors to cell colors.) Otherwise, by default, the cells are set to the specified color. If ColorModeToSpecifiedColor is set, then the primitives will all be set to this color. If ColorModeToRandomColors is
set, each cell will be randomly assigned a color.
obj.SetColorModeToSpecifiedColor () - Control how output polydata is colored. By default
(ColorModeToDefault), if per cell colors are defined (unsigned chars of 1-4 components), then the cells are
colored with these values. (If point colors are defined and cell colors are not, you can use vtkPointDataToCellData to convert the point colors to cell colors.) Otherwise, by default, the cells are set to the specified color.
If ColorModeToSpecifiedColor is set, then the primitives will all be set to this color. If ColorModeToRandomColors is set, each cell will be randomly assigned a color.
obj.SetColorModeToRandomColors () - Control how output polydata is colored. By default (ColorModeToDefault), if per cell colors are defined (unsigned chars of 1-4 components), then the cells are colored
with these values. (If point colors are defined and cell colors are not, you can use vtkPointDataToCellData to
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
38.13 vtkChacoReader
1847
convert the point colors to cell colors.) Otherwise, by default, the cells are set to the specified color. If ColorModeToSpecifiedColor is set, then the primitives will all be set to this color. If ColorModeToRandomColors is
set, each cell will be randomly assigned a color.
obj.SetSpecifiedColor (float , float , float ) - Set/Get the specified color to color
the polydata cells. This color is only used when the color mode is set to ColorModeToSpecifiedColor, or
ColorModeToDefault is set and no cell colors are specified. The specified color is specified as RGB values
ranging from (0,1). (Note: CGM will map this color to the closest color it supports.)
obj.SetSpecifiedColor (float a[3]) - Set/Get the specified color to color the polydata cells.
This color is only used when the color mode is set to ColorModeToSpecifiedColor, or ColorModeToDefault is
set and no cell colors are specified. The specified color is specified as RGB values ranging from (0,1). (Note:
CGM will map this color to the closest color it supports.)
float = obj. GetSpecifiedColor () - Set/Get the specified color to color the polydata cells.
This color is only used when the color mode is set to ColorModeToSpecifiedColor, or ColorModeToDefault is
set and no cell colors are specified. The specified color is specified as RGB values ranging from (0,1). (Note:
CGM will map this color to the closest color it supports.)
38.13
vtkChacoReader
38.13.1
Usage
vtkChacoReader is an unstructured grid source object that reads Chaco files. The reader DOES NOT respond
to piece requests. Chaco is a graph partitioning package developed at Sandia National Laboratories in the early
1990s. (http://www.cs.sandia.gov/bahendr/chaco.html)
Note that the Chaco "edges" become VTK "cells", and the Chaco "vertices" become VTK "points".
To create an instance of class vtkChacoReader, simply invoke its constructor as follows
obj = vtkChacoReader
38.13.2
Methods
The class vtkChacoReader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult
the VTK website. In the methods listed below, obj is an instance of the vtkChacoReader class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkChacoReader = obj.NewInstance ()
vtkChacoReader = obj.SafeDownCast (vtkObject o)
obj.SetBaseName (string )
string = obj.GetBaseName ()
obj.SetGenerateGlobalElementIdArray (int )
int = obj.GetGenerateGlobalElementIdArray ()
obj.GenerateGlobalElementIdArrayOn ()
obj.GenerateGlobalElementIdArrayOff ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1848
obj.SetGenerateGlobalNodeIdArray (int )
int = obj.GetGenerateGlobalNodeIdArray ()
obj.GenerateGlobalNodeIdArrayOn ()
obj.GenerateGlobalNodeIdArrayOff ()
obj.SetGenerateVertexWeightArrays (int )
int = obj.GetGenerateVertexWeightArrays ()
obj.GenerateVertexWeightArraysOn ()
obj.GenerateVertexWeightArraysOff ()
int = obj.GetNumberOfVertexWeights ()
string = obj.GetVertexWeightArrayName (int weight)
obj.SetGenerateEdgeWeightArrays (int )
int = obj.GetGenerateEdgeWeightArrays ()
obj.GenerateEdgeWeightArraysOn ()
obj.GenerateEdgeWeightArraysOff ()
int = obj.GetNumberOfEdgeWeights ()
string = obj.GetEdgeWeightArrayName (int weight)
int = obj.GetDimensionality () - Access to meta data generated by RequestInformation.
vtkIdType = obj.GetNumberOfEdges () - Access to meta data generated by RequestInformation.
vtkIdType = obj.GetNumberOfVertices () - Access to meta data generated by RequestInformation.
int = obj.GetNumberOfCellWeightArrays ()
int = obj.GetNumberOfPointWeightArrays ()
38.14
vtkDataCompressor
38.14.1
Usage
vtkDataCompressor provides a universal interface for data compression. Subclasses provide one compression
method and one decompression method. The public interface to all compressors remains the same, and is defined
by this class.
To create an instance of class vtkDataCompressor, simply invoke its constructor as follows
obj = vtkDataCompressor
38.15 vtkDataObjectReader
38.14.2
1849
Methods
The class vtkDataCompressor has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkDataCompressor class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataCompressor = obj.NewInstance ()
vtkDataCompressor = obj.SafeDownCast (vtkObject o)
long = obj.GetMaximumCompressionSpace (long size) - Get the maximum space that
may be needed to store data of the given uncompressed size after compression. This is the minimum size of
the output buffer that can be passed to the four-argument Compress method.
long = obj.Compress (string uncompressedData, long uncompressedSize,
string compressedData, long compressionSpace) - Compress the given input data buffer
into the given output buffer. The size of the output buffer must be at least as large as the value given by
GetMaximumCompressionSpace for the given input size.
long = obj.Uncompress (string compressedData, long compressedSize, string
uncompressedData, long uncompressedSize) - Uncompress the given input data into the given
output buffer. The size of the uncompressed data must be known by the caller. It should be transmitted from
the compressor by a means outside of this class.
vtkUnsignedCharArray = obj.Compress (string uncompressedData, long uncompressedSize) - Compress the given data. A vtkUnsignedCharArray containing the compressed data is returned
with a reference count of 1.
vtkUnsignedCharArray = obj.Uncompress (string compressedData, long compressedSize, long uncompressedSize) - Uncompress the given data. A vtkUnsignedCharArray containing
the compressed data is returned with a reference count of 1. The size of the uncompressed data must be
known by the caller. It should be transmitted from the compressor by a means outside of this class.
38.15
vtkDataObjectReader
38.15.1
Usage
vtkDataObjectReader is a source object that reads ASCII or binary field data files in vtk format. Fields are general
matrix structures used represent complex data. (See text for format details). The output of this reader is a single
vtkDataObject. The superclass of this class, vtkDataReader, provides many methods for controlling the reading of
the data file, see vtkDataReader for more information.
To create an instance of class vtkDataObjectReader, simply invoke its constructor as follows
obj = vtkDataObjectReader
38.15.2
Methods
The class vtkDataObjectReader has several methods that can be used. They are listed below. Note that the
documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkDataObjectReader class.
string = obj.GetClassName ()
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
1850
38.16
vtkDataObjectWriter
38.16.1
Usage
vtkDataObjectWriter is a source object that writes ASCII or binary field data files in vtk format. Field data is a general
form of data in matrix form.
To create an instance of class vtkDataObjectWriter, simply invoke its constructor as follows
obj = vtkDataObjectWriter
38.16.2
Methods
The class vtkDataObjectWriter has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt,
consult the VTK website. In the methods listed below, obj is an instance of the vtkDataObjectWriter class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkDataObjectWriter = obj.NewInstance ()
vtkDataObjectWriter = obj.SafeDownCast (vtkObject o)
obj.SetFileName (string filename) - Methods delegated to vtkDataWriter, see vtkDataWriter.
string = obj.GetFileName () - Methods delegated to vtkDataWriter, see vtkDataWriter.
obj.SetHeader (string header) - Methods delegated to vtkDataWriter, see vtkDataWriter.
string = obj.GetHeader () - Methods delegated to vtkDataWriter, see vtkDataWriter.
obj.SetFileType (int type) - Methods delegated to vtkDataWriter, see vtkDataWriter.
int = obj.GetFileType () - Methods delegated to vtkDataWriter, see vtkDataWriter.
obj.SetFileTypeToASCII () - Methods delegated to vtkDataWriter, see vtkDataWriter.
obj.SetFileTypeToBinary () - Methods delegated to vtkDataWriter, see vtkDataWriter.
obj.SetFieldDataName (string fieldname) - Methods delegated to vtkDataWriter, see vtkDataWriter.
string = obj.GetFieldDataName () - Methods delegated to vtkDataWriter, see vtkDataWriter.
Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen
38.17 vtkDataReader
38.17
1851
vtkDataReader
38.17.1
Usage
vtkDataReader is a helper superclass that reads the vtk data file header, dataset type, and attribute data (point and
cell attributes such as scalars, vectors, normals, etc.) from a vtk data file. See text for the format of the various vtk
file types.
To create an instance of class vtkDataReader, simply invoke its constructor as follows
obj = vtkDataReader
38.17.2
Methods
The class vtkDataReader has several methods that can be used. They are listed below. Note that the documentation
is translated automatic