/usr/include/vigra/multi_pointoperators.hxx is in libvigraimpex-dev 1.9.0+dfsg-10+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 | //-- -*- c++ -*-
/************************************************************************/
/* */
/* Copyright 2003 by Ullrich Koethe, B. Seppke, F. Heinrich */
/* */
/* This file is part of the VIGRA computer vision library. */
/* The VIGRA Website is */
/* http://hci.iwr.uni-heidelberg.de/vigra/ */
/* Please direct questions, bug reports, and contributions to */
/* ullrich.koethe@iwr.uni-heidelberg.de or */
/* vigra@informatik.uni-hamburg.de */
/* */
/* Permission is hereby granted, free of charge, to any person */
/* obtaining a copy of this software and associated documentation */
/* files (the "Software"), to deal in the Software without */
/* restriction, including without limitation the rights to use, */
/* copy, modify, merge, publish, distribute, sublicense, and/or */
/* sell copies of the Software, and to permit persons to whom the */
/* Software is furnished to do so, subject to the following */
/* conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the */
/* Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES */
/* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND */
/* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT */
/* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, */
/* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING */
/* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR */
/* OTHER DEALINGS IN THE SOFTWARE. */
/* */
/************************************************************************/
#ifndef VIGRA_MULTI_POINTOPERATORS_H
#define VIGRA_MULTI_POINTOPERATORS_H
#include "initimage.hxx"
#include "copyimage.hxx"
#include "transformimage.hxx"
#include "combineimages.hxx"
#include "inspectimage.hxx"
#include "multi_array.hxx"
#include "metaprogramming.hxx"
#include "inspector_passes.hxx"
namespace vigra
{
/** \addtogroup MultiPointoperators Point operators for multi-dimensional arrays.
Copy, transform, and inspect arbitrary dimensional arrays which are represented
by iterators compatible to \ref MultiIteratorPage. Note that are range is here
specified by a pair: an iterator referring to the first point of the array
and a shape object specifying the size of the (rectangular) ROI.
<b>\#include</b> \<vigra/multi_pointoperators.hxx\>
*/
//@{
/********************************************************/
/* */
/* initMultiArray */
/* */
/********************************************************/
template <class Iterator, class Shape, class Accessor,
class VALUETYPE>
inline void
initMultiArrayImpl(Iterator s, Shape const & shape, Accessor a, VALUETYPE const & v, MetaInt<0>)
{
initLine(s, s + shape[0], a, v);
}
template <class Iterator, class Shape, class Accessor,
class VALUETYPE, int N>
void
initMultiArrayImpl(Iterator s, Shape const & shape, Accessor a,
VALUETYPE const & v, MetaInt<N>)
{
Iterator send = s + shape[N];
for(; s < send; ++s)
{
initMultiArrayImpl(s.begin(), shape, a, v, MetaInt<N-1>());
}
}
/** \brief Write a value to every pixel in a multi-dimensional array.
This function can be used to init the array which must be represented by
a pair of iterators compatible to \ref vigra::MultiIterator.
It uses an accessor to access the data elements. Note that the iterator range
must be specified by a shape object, because otherwise we could not control
the range simultaneously in all dimensions (this is a necessary consequence
of the \ref vigra::MultiIterator design).
The initial value can either be a constant of appropriate type (compatible with
the destination's value_type), or a functor with compatible result_type. These two
cases are automatically distinguished when <tt>FunctorTraits<FUNCTOR>::isInitializer</tt>
yields <tt>VigraTrueType</tt>. Since the functor is passed by <tt>const</tt> reference, its
<tt>operator()</tt> must be const, and its internal state may need to be <tt>mutable</tt>.
<b> Declarations:</b>
pass arguments explicitly:
\code
namespace vigra {
template <class Iterator, class Shape, class Accessor, class VALUETYPE>
void
initMultiArray(Iterator s, Shape const & shape, Accessor a, VALUETYPE const & v);
template <class Iterator, class Shape, class Accessor, class FUNCTOR>
void
initMultiArray(Iterator s, Shape const & shape, Accessor a, FUNCTOR const & f);
}
\endcode
use argument objects in conjunction with \ref ArgumentObjectFactories :
\code
namespace vigra {
template <class Iterator, class Shape, class Accessor, class VALUETYPE>
void
initMultiArray(triple<Iterator, Shape, Accessor> const & s, VALUETYPE const & v);
template <class Iterator, class Shape, class Accessor, class FUNCTOR>
void
initMultiArray(triple<Iterator, Shape, Accessor> const & s, FUNCTOR const & f);
}
\endcode
<b> Usage:</b>
<b>\#include</b> \<vigra/multi_pointoperators.hxx\><br>
Namespace: vigra
\code
typedef vigra::MultiArray<3, int> Array;
Array array(Array::size_type(100, 200, 50));
// zero the array
vigra::initMultiArray(destMultiArrayRange(array), 0);
\endcode
<b> Required Interface:</b>
The function accepts either a value that is copied into every destination element:
\code
MultiIterator begin;
Accessor accessor;
VALUETYPE v;
accessor.set(v, begin);
\endcode
or a functor that is called (without argument) at every location,
and the result is written into the current element. Internally,
functors are recognized by the meta function
<tt>FunctorTraits<FUNCTOR>::isInitializer</tt> yielding <tt>VigraTrueType</tt>.
Make sure that your functor correctly defines <tt>FunctorTraits</tt> because
otherwise the code will not compile.
\code
MultiIterator begin;
Accessor accessor;
FUNCTOR f;
assert(typeid(FunctorTraits<FUNCTOR>::isInitializer) == typeid(VigraTrueType));
accessor.set(f(), begin);
\endcode
*/
doxygen_overloaded_function(template <...> void initMultiArray)
template <class Iterator, class Shape, class Accessor, class VALUETYPE>
inline void
initMultiArray(Iterator s, Shape const & shape, Accessor a, VALUETYPE const & v)
{
initMultiArrayImpl(s, shape, a, v, MetaInt<Iterator::level>());
}
template <class Iterator, class Shape, class Accessor, class VALUETYPE>
inline
void
initMultiArray(triple<Iterator, Shape, Accessor> const & s, VALUETYPE const & v)
{
initMultiArray(s.first, s.second, s.third, v);
}
/********************************************************/
/* */
/* initMultiArrayBorder */
/* */
/********************************************************/
/** \brief Write value to the specified border values in the array.
*/template <class Iterator, class Diff_type, class Accessor, class VALUETYPE>
inline void initMultiArrayBorder( Iterator upperleft, Diff_type shape,
Accessor a, int border_width, VALUETYPE v)
{
Diff_type border(shape);
for(unsigned int dim=0; dim<shape.size(); dim++){
border[dim] = (border_width > shape[dim]) ? shape[dim] : border_width;
}
for(unsigned int dim=0; dim<shape.size(); dim++){
Diff_type start(shape),
offset(shape);
start = start-shape;
offset[dim]=border[dim];
initMultiArray(upperleft+start, offset, a, v);
start[dim]=shape[dim]-border[dim];
initMultiArray(upperleft+start, offset, a, v);
}
}
template <class Iterator, class Diff_type, class Accessor, class VALUETYPE>
inline void initMultiArrayBorder( triple<Iterator, Diff_type, Accessor> multiArray,
int border_width, VALUETYPE v)
{
initMultiArrayBorder(multiArray.first, multiArray.second, multiArray.third, border_width, v);
}
/********************************************************/
/* */
/* copyMultiArray */
/* */
/********************************************************/
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor>
void
copyMultiArrayImpl(SrcIterator s, SrcShape const & sshape, SrcAccessor src,
DestIterator d, DestShape const & dshape, DestAccessor dest, MetaInt<0>)
{
if(sshape[0] == 1)
{
initLine(d, d + dshape[0], dest, src(s));
}
else
{
copyLine(s, s + sshape[0], src, d, dest);
}
}
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor, int N>
void
copyMultiArrayImpl(SrcIterator s, SrcShape const & sshape, SrcAccessor src,
DestIterator d, DestShape const & dshape, DestAccessor dest, MetaInt<N>)
{
DestIterator dend = d + dshape[N];
if(sshape[N] == 1)
{
for(; d < dend; ++d)
{
copyMultiArrayImpl(s.begin(), sshape, src, d.begin(), dshape, dest, MetaInt<N-1>());
}
}
else
{
for(; d < dend; ++s, ++d)
{
copyMultiArrayImpl(s.begin(), sshape, src, d.begin(), dshape, dest, MetaInt<N-1>());
}
}
}
/** \brief Copy a multi-dimensional array.
This function can be applied in two modes:
<DL>
<DT><b>Standard Mode:</b>
<DD>If the source and destination arrays have the same size,
the corresponding array elements are simply copied.
If necessary, type conversion takes place.
<DT><b>Expanding Mode:</b>
<DD>If the source array has length 1 along some (or even all) dimensions,
the source value at index 0 is used for all destination
elements in those dimensions. For example, if we have single row of data
(column length is 1), we can copy it into a 2D image of the same width:
The given row is automatically repeated for every row of the destination image.
Again, type conversion os performed if necessary.
</DL>
The arrays must be represented by
iterators compatible with \ref vigra::MultiIterator, and the iteration range
is specified by means of shape objects. If only the source shape is given
the destination array is assumed to have the same shape, and standard mode
is applied. If two shapes are given, the size of corresponding dimensions
must be either equal (standard copy), or the source length must be 1
(expanding copy). The function uses accessors to access the data elements.
<b> Declarations:</b>
<b>\#include</b> \<vigra/multi_pointoperators.hxx\><br>
Namespace: vigra
pass arguments explicitly:
\code
namespace vigra {
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestAccessor>
void
copyMultiArray(SrcIterator s,
SrcShape const & shape, SrcAccessor src,
DestIterator d, DestAccessor dest);
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor>
void
copyMultiArray(SrcIterator s, SrcShape const & sshape, SrcAccessor src,
DestIterator d, DestShape const & dshape, DestAccessor dest);
}
\endcode
use argument objects in conjunction with \ref ArgumentObjectFactories :
\code
namespace vigra {
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestAccessor>
void
copyMultiArray(triple<SrcIterator, SrcShape, SrcAccessor> const & src,
pair<DestIterator, DestAccessor> const & dest);
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor>
void
copyMultiArray(triple<SrcIterator, SrcShape, SrcAccessor> const & src,
triple<DestIterator, DestShape, DestAccessor> const & dest);
}
\endcode
<b> Usage - Standard Mode:</b>
\code
typedef vigra::MultiArray<3, int> Array;
Array src(Array::size_type(100, 200, 50)),
dest(Array::size_type(100, 200, 50));
...
vigra::copyMultiArray(srcMultiArrayRange(src), destMultiArray(dest));
\endcode
<b> Usage - Expanding Mode:</b>
The source array is only 2D (it has depth 1). Thus, the destination
will contain 50 identical copies of this image. Note that the destination shape
must be passed to the algorithm for the expansion to work, so we use
<tt>destMultiArrayRange()</tt> rather than <tt>destMultiArray()</tt>.
\code
typedef vigra::MultiArray<3, int> Array;
Array src(Array::size_type(100, 200, 1)),
dest(Array::size_type(100, 200, 50));
...
vigra::copyMultiArray(srcMultiArrayRange(src), destMultiArrayRange(dest));
\endcode
<b> Required Interface:</b>
\code
MultiIterator src_begin, dest_begin;
SrcAccessor src_accessor;
DestAccessor dest_accessor;
dest_accessor.set(src_accessor(src_begin), dest_begin);
\endcode
*/
doxygen_overloaded_function(template <...> void copyMultiArray)
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestAccessor>
inline void
copyMultiArray(SrcIterator s,
SrcShape const & shape, SrcAccessor src,
DestIterator d, DestAccessor dest)
{
copyMultiArrayImpl(s, shape, src, d, shape, dest, MetaInt<SrcIterator::level>());
}
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestAccessor>
inline void
copyMultiArray(triple<SrcIterator, SrcShape, SrcAccessor> const & src,
pair<DestIterator, DestAccessor> const & dest)
{
copyMultiArray(src.first, src.second, src.third, dest.first, dest.second);
}
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor>
void
copyMultiArray(SrcIterator s, SrcShape const & sshape, SrcAccessor src,
DestIterator d, DestShape const & dshape, DestAccessor dest)
{
vigra_precondition(sshape.size() == dshape.size(),
"copyMultiArray(): dimensionality of source and destination array differ");
for(unsigned int i=0; i<sshape.size(); ++i)
vigra_precondition(sshape[i] == 1 || sshape[i] == dshape[i],
"copyMultiArray(): mismatch between source and destination shapes:\n"
"length of each source dimension must either be 1 or equal to the corresponding "
"destination length.");
copyMultiArrayImpl(s, sshape, src, d, dshape, dest, MetaInt<SrcIterator::level>());
}
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor>
inline void
copyMultiArray(triple<SrcIterator, SrcShape, SrcAccessor> const & src,
triple<DestIterator, DestShape, DestAccessor> const & dest)
{
copyMultiArray(src.first, src.second, src.third, dest.first, dest.second, dest.third);
}
/********************************************************/
/* */
/* transformMultiArray */
/* */
/********************************************************/
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void
transformMultiArrayReduceImpl(SrcIterator s, SrcShape const &, SrcAccessor src,
DestIterator d, DestShape const & dshape, DestAccessor dest,
SrcShape const & reduceShape,
Functor const & ff, MetaInt<0>)
{
DestIterator dend = d + dshape[0];
for(; d < dend; ++s.template dim<0>(), ++d)
{
Functor f = ff;
inspectMultiArray(s, reduceShape, src, f);
dest.set(f(), d);
}
}
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor,
class Functor, int N>
void
transformMultiArrayReduceImpl(SrcIterator s, SrcShape const & sshape, SrcAccessor src,
DestIterator d, DestShape const & dshape, DestAccessor dest,
SrcShape const & reduceShape,
Functor const & f, MetaInt<N>)
{
DestIterator dend = d + dshape[N];
for(; d < dend; ++s.template dim<N>(), ++d)
{
transformMultiArrayReduceImpl(s, sshape, src, d.begin(), dshape, dest,
reduceShape, f, MetaInt<N-1>());
}
}
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void
transformMultiArrayImpl(SrcIterator s, SrcShape const & sshape, SrcAccessor src,
DestIterator d, DestShape const & dshape, DestAccessor dest,
Functor const & f, VigraTrueType)
{
// reduce mode
SrcShape reduceShape = sshape;
for(unsigned int i=0; i<dshape.size(); ++i)
{
vigra_precondition(dshape[i] == 1 || sshape[i] == dshape[i],
"transformMultiArray(): mismatch between source and destination shapes:\n"
"In 'reduce'-mode, the length of each destination dimension must either be 1\n"
"or equal to the corresponding source length.");
if(dshape[i] != 1)
reduceShape[i] = 1;
}
transformMultiArrayReduceImpl(s, sshape, src, d, dshape, dest, reduceShape,
f, MetaInt<SrcIterator::level>());
}
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void
transformMultiArrayExpandImpl(SrcIterator s, SrcShape const & sshape, SrcAccessor src,
DestIterator d, DestShape const & dshape, DestAccessor dest,
Functor const & f, MetaInt<0>)
{
if(sshape[0] == 1)
{
initLine(d, d + dshape[0], dest, f(src(s)));
}
else
{
transformLine(s, s + sshape[0], src, d, dest, f);
}
}
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor,
class Functor, int N>
void
transformMultiArrayExpandImpl(SrcIterator s, SrcShape const & sshape, SrcAccessor src,
DestIterator d, DestShape const & dshape, DestAccessor dest,
Functor const & f, MetaInt<N>)
{
DestIterator dend = d + dshape[N];
if(sshape[N] == 1)
{
for(; d < dend; ++d)
{
transformMultiArrayExpandImpl(s.begin(), sshape, src, d.begin(), dshape, dest,
f, MetaInt<N-1>());
}
}
else
{
for(; d < dend; ++s, ++d)
{
transformMultiArrayExpandImpl(s.begin(), sshape, src, d.begin(), dshape, dest,
f, MetaInt<N-1>());
}
}
}
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void
transformMultiArrayImpl(SrcIterator s, SrcShape const & sshape, SrcAccessor src,
DestIterator d, DestShape const & dshape, DestAccessor dest,
Functor const & f, VigraFalseType)
{
// expand mode
for(unsigned int i=0; i<sshape.size(); ++i)
vigra_precondition(sshape[i] == 1 || sshape[i] == dshape[i],
"transformMultiArray(): mismatch between source and destination shapes:\n"
"In 'expand'-mode, the length of each source dimension must either be 1\n"
"or equal to the corresponding destination length.");
transformMultiArrayExpandImpl(s, sshape, src, d, dshape, dest,
f, MetaInt<SrcIterator::level>());
}
/** \brief Transform a multi-dimensional array with a unary function or functor.
This function can be applied in three modes:
<DL>
<DT><b>Standard Mode:</b>
<DD>If the source and destination arrays have the same size,
the transformation given by the functor is applied to every source
element and the result written into the corresponding destination element.
Unary functions, unary functors from the STL and the functors specifically
defined in \ref TransformFunctor can be used in standard mode.
Creation of new functors is easiest by using \ref FunctorExpressions.
<DT><b>Expanding Mode:</b>
<DD>If the source array has length 1 along some (or even all) dimensions,
the source value at index 0 is used for all destination
elements in those dimensions. In other words, the source index is not
incremented along these dimensions, but the transformation functor
is applied as usual. So, we can expand a small array (e.g. a single row of data,
column length is 1), into a larger one (e.g. a 2D image with the same width):
the given values are simply reused as necessary (e.g. for every row of the
destination image). The same functors as in standard mode can be applied.
<DT><b>Reducing Mode:</b>
<DD>If the destination array has length 1 along some (or even all) dimensions,
the source values in these dimensions are reduced to single values by means
of a suitable functor (e.g. \ref vigra::ReduceFunctor), which supports two
function call operators: one
with a single argument to collect the values, and without argument to
obtain the final (reduced) result. This behavior is a multi-dimensional
generalization of the C++ standard function <tt>std::accumulate()</tt>.
</DL>
The arrays must be represented by
iterators compatible with \ref vigra::MultiIterator, and the iteration range
is specified by means of shape objects. If only the source shape is given
the destination array is assumed to have the same shape, and standard mode
is applied. If two shapes are given, the size of corresponding dimensions
must be either equal (standard copy), or the source length must be 1
(expand mode), or the destination length must be 1 (reduce mode). However,
reduction and expansion cannot be executed at the same time, so the latter
conditions are mutual exclusive, even if they apply to different dimensions.
The function uses accessors to access the data elements.
<b> Declarations:</b>
<b>\#include</b> \<vigra/multi_pointoperators.hxx\><br>
Namespace: vigra
pass arguments explicitly:
\code
namespace vigra {
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestAccessor,
class Functor>
void
transformMultiArray(SrcIterator s, SrcShape const & shape, SrcAccessor src,
DestIterator d, DestAccessor dest, Functor const & f);
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void
transformMultiArray(SrcIterator s, SrcShape const & sshape, SrcAccessor src,
DestIterator d, DestShape const & dshape, DestAccessor dest,
Functor const & f);
}
\endcode
use argument objects in conjunction with \ref ArgumentObjectFactories :
\code
namespace vigra {
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestAccessor,
class Functor>
void
transformMultiArray(triple<SrcIterator, SrcShape, SrcAccessor> const & src,
pair<DestIterator, DestAccessor> const & dest, Functor const & f);
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void
transformMultiArray(triple<SrcIterator, SrcShape, SrcAccessor> const & src,
triple<DestIterator, DestShape, DestAccessor> const & dest,
Functor const & f)
}
\endcode
<b> Usage - Standard Mode:</b>
Source and destination array have the same size.
\code
#include <cmath> // for sqrt()
typedef vigra::MultiArray<3, float> Array;
Array src(Array::size_type(100, 200, 50)),
dest(Array::size_type(100, 200, 50));
...
vigra::transformMultiArray(srcMultiArrayRange(src),
destMultiArray(dest),
(float(*)(float))&std::sqrt );
\endcode
<b> Usage - Expand Mode:</b>
The source array is only 2D (it has depth 1). Thus, the destination
will contain 50 identical copies of the transformed source array.
Note that the destination shape must be passed to the algorithm for
the expansion to work, so we use <tt>destMultiArrayRange()</tt>
rather than <tt>destMultiArray()</tt>.
\code
#include <cmath> // for sqrt()
typedef vigra::MultiArray<3, float> Array;
Array src(Array::size_type(100, 200, 1)),
dest(Array::size_type(100, 200, 50));
...
vigra::transformMultiArray(srcMultiArrayRange(src),
destMultiArrayRange(dest),
(float(*)(float))&std::sqrt );
\endcode
<b> Usage - Reduce Mode:</b>
The destination array is only 1D (it's width and height are 1).
Thus, it will contain accumulated data for every slice of the source volume
(or for every frame, if the source is interpreted as an image sequence).
In the example, we use the functor \ref vigra::FindAverage to calculate
the average gray value of every slice. Note that the destination shape
must also be passed for the reduction to work, so we use
<tt>destMultiArrayRange()</tt> rather than <tt>destMultiArray()</tt>.
\code
typedef vigra::MultiArray<3, float> Array;
Array src(Array::size_type(100, 200, 50)),
dest(Array::size_type(1, 1, 50));
...
vigra::transformMultiArray(srcMultiArrayRange(src),
destMultiArrayRange(dest),
vigra::FindAverage<float>() );
\endcode
Note that the functor must define the appropriate traits described below in order to be
recognized as a reduce functor. This is most easily achieved by deriving from
<tt>UnaryReduceFunctorTag</tt> (see \ref vigra::FunctorTraits).
<b> Required Interface:</b>
In standard and expand mode, the functor must be a model of UnaryFunction
(i.e. support function call with one argument and a return value
<tt>res = functor(arg)</tt>):
\code
MultiIterator src_begin, src_end, dest_begin;
SrcAccessor src_accessor;
DestAccessor dest_accessor;
Functor functor;
dest_accessor.set(functor(src_accessor(src_begin)), dest_begin);
\endcode
In reduce mode, it must be a model of UnaryAnalyser (i.e. support function call
with one argument and no return value <tt>functor(arg)</tt>) and Initializer
(i.e. support function call with no argument, but return value
<tt>res = functor()</tt>). Internally, such functors are recognized by the
meta functions <tt>FunctorTraits<FUNCTOR>::isUnaryAnalyser</tt> and
<tt>FunctorTraits<FUNCTOR>::isInitializer</tt> which must both yield
<tt>VigraTrueType</tt>. Make sure that your functor correctly defines
<tt>FunctorTraits</tt> because otherwise reduce mode will not work.
This is most easily achieved by deriving the functor from
<tt>UnaryReduceFunctorTag</tt> (see \ref vigra::FunctorTraits).
In addition, the functor must be copy constructible in order to start each reduction
with a fresh functor.
\code
MultiIterator src_begin, src_end, dest_begin;
SrcAccessor src_accessor;
DestAccessor dest_accessor;
FUNCTOR initial_functor, functor(initial_functor);
assert(typeid(FunctorTraits<FUNCTOR>::isInitializer) == typeid(VigraTrueType));
assert(typeid(FunctorTraits<FUNCTOR>::isUnaryAnalyser) == typeid(VigraTrueType));
functor(src_accessor(src_begin));
dest_accessor.set(functor(), dest_begin);
\endcode
*/
doxygen_overloaded_function(template <...> void transformMultiArray)
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestAccessor,
class Functor>
inline void
transformMultiArray(SrcIterator s, SrcShape const & shape, SrcAccessor src,
DestIterator d, DestAccessor dest, Functor const & f)
{
transformMultiArrayExpandImpl(s, shape, src, d, shape, dest,
f, MetaInt<SrcIterator::level>());
}
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestAccessor,
class Functor>
inline void
transformMultiArray(triple<SrcIterator, SrcShape, SrcAccessor> const & src,
pair<DestIterator, DestAccessor> const & dest, Functor const & f)
{
transformMultiArray(src.first, src.second, src.third,
dest.first, dest.second, f);
}
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void
transformMultiArray(SrcIterator s, SrcShape const & sshape, SrcAccessor src,
DestIterator d, DestShape const & dshape, DestAccessor dest,
Functor const & f)
{
vigra_precondition(sshape.size() == dshape.size(),
"transformMultiArray(): dimensionality of source and destination array differ");
typedef FunctorTraits<Functor> FT;
typedef typename
And<typename FT::isInitializer, typename FT::isUnaryAnalyser>::result
isAnalyserInitializer;
transformMultiArrayImpl(s, sshape, src, d, dshape, dest,
f, isAnalyserInitializer());
}
template <class SrcIterator, class SrcShape, class SrcAccessor,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
inline void
transformMultiArray(triple<SrcIterator, SrcShape, SrcAccessor> const & src,
triple<DestIterator, DestShape, DestAccessor> const & dest,
Functor const & f)
{
transformMultiArray(src.first, src.second, src.third,
dest.first, dest.second, dest.third, f);
}
/********************************************************/
/* */
/* combineTwoMultiArrays */
/* */
/********************************************************/
template <class SrcIterator1, class SrcShape, class SrcAccessor1,
class SrcIterator2, class SrcAccessor2,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void
combineTwoMultiArraysReduceImpl(
SrcIterator1 s1, SrcShape const & , SrcAccessor1 src1,
SrcIterator2 s2, SrcAccessor2 src2,
DestIterator d, DestShape const & dshape, DestAccessor dest,
SrcShape const & reduceShape,
Functor const & ff, MetaInt<0>)
{
DestIterator dend = d + dshape[0];
for(; d < dend; ++s1.template dim<0>(), ++s2.template dim<0>(), ++d)
{
Functor f = ff;
inspectTwoMultiArrays(s1, reduceShape, src1, s2, src2, f);
dest.set(f(), d);
}
}
template <class SrcIterator1, class SrcShape, class SrcAccessor1,
class SrcIterator2, class SrcAccessor2,
class DestIterator, class DestShape, class DestAccessor,
class Functor, int N>
void
combineTwoMultiArraysReduceImpl(
SrcIterator1 s1, SrcShape const & sshape, SrcAccessor1 src1,
SrcIterator2 s2, SrcAccessor2 src2,
DestIterator d, DestShape const & dshape, DestAccessor dest,
SrcShape const & reduceShape,
Functor const & f, MetaInt<N>)
{
DestIterator dend = d + dshape[N];
for(; d < dend; ++s1.template dim<N>(), ++s2.template dim<N>(), ++d)
{
combineTwoMultiArraysReduceImpl(s1, sshape, src1, s2, src2,
d.begin(), dshape, dest,
reduceShape, f, MetaInt<N-1>());
}
}
template <class SrcIterator1, class SrcShape1, class SrcAccessor1,
class SrcIterator2, class SrcShape2, class SrcAccessor2,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void
combineTwoMultiArraysImpl(
SrcIterator1 s1, SrcShape1 const & sshape1, SrcAccessor1 src1,
SrcIterator2 s2, SrcShape2 const & sshape2, SrcAccessor2 src2,
DestIterator d, DestShape const & dshape, DestAccessor dest,
Functor const & f, VigraTrueType)
{
// reduce mode
SrcShape1 reduceShape = sshape1;
for(unsigned int i=0; i<dshape.size(); ++i)
{
vigra_precondition(sshape1[i] == sshape2[i] &&
(dshape[i] == 1 || sshape1[i] == dshape[i]),
"combineTwoMultiArrays(): mismatch between source and destination shapes:\n"
"In 'reduce'-mode, the two source shapes must be equal, and\n"
"the length of each destination dimension must either be 1\n"
"or equal to the corresponding source length.");
if(dshape[i] != 1)
reduceShape[i] = 1;
}
combineTwoMultiArraysReduceImpl(s1, sshape1, src1, s2, src2,
d, dshape, dest, reduceShape,
f, MetaInt<SrcIterator1::level>());
}
template <class SrcIterator1, class SrcShape1, class SrcAccessor1,
class SrcIterator2, class SrcShape2, class SrcAccessor2,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void
combineTwoMultiArraysExpandImpl(
SrcIterator1 s1, SrcShape1 const & sshape1, SrcAccessor1 src1,
SrcIterator2 s2, SrcShape2 const & sshape2, SrcAccessor2 src2,
DestIterator d, DestShape const & dshape, DestAccessor dest,
Functor const & f, MetaInt<0>)
{
DestIterator dend = d + dshape[0];
if(sshape1[0] == 1 && sshape2[0] == 1)
{
initLine(d, dend, dest, f(src1(s1), src2(s2)));
}
else if(sshape1[0] == 1)
{
typename SrcAccessor1::value_type sv1 = src1(s1);
for(; d < dend; ++d, ++s2)
dest.set(f(sv1, src2(s2)), d);
}
else if(sshape2[0] == 1)
{
typename SrcAccessor2::value_type sv2 = src2(s2);
for(; d < dend; ++d, ++s1)
dest.set(f(src1(s1), sv2), d);
}
else
{
combineTwoLines(s1, s1 + sshape1[0], src1, s2, src2, d, dest, f);
}
}
template <class SrcIterator1, class SrcShape1, class SrcAccessor1,
class SrcIterator2, class SrcShape2, class SrcAccessor2,
class DestIterator, class DestShape, class DestAccessor,
class Functor, int N>
void
combineTwoMultiArraysExpandImpl(
SrcIterator1 s1, SrcShape1 const & sshape1, SrcAccessor1 src1,
SrcIterator2 s2, SrcShape2 const & sshape2, SrcAccessor2 src2,
DestIterator d, DestShape const & dshape, DestAccessor dest,
Functor const & f, MetaInt<N>)
{
DestIterator dend = d + dshape[N];
int s1inc = sshape1[N] == 1
? 0
: 1;
int s2inc = sshape2[N] == 1
? 0
: 1;
for(; d < dend; ++d, s1 += s1inc, s2 += s2inc)
{
combineTwoMultiArraysExpandImpl(s1.begin(), sshape1, src1,
s2.begin(), sshape2, src2,
d.begin(), dshape, dest,
f, MetaInt<N-1>());
}
}
template <class SrcIterator1, class SrcShape1, class SrcAccessor1,
class SrcIterator2, class SrcShape2, class SrcAccessor2,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void
combineTwoMultiArraysImpl(
SrcIterator1 s1, SrcShape1 const & sshape1, SrcAccessor1 src1,
SrcIterator2 s2, SrcShape2 const & sshape2, SrcAccessor2 src2,
DestIterator d, DestShape const & dshape, DestAccessor dest,
Functor const & f, VigraFalseType)
{
// expand mode
for(unsigned int i=0; i<sshape1.size(); ++i)
vigra_precondition((sshape1[i] == 1 || sshape1[i] == dshape[i]) &&
(sshape2[i] == 1 || sshape2[i] == dshape[i]),
"combineTwoMultiArrays(): mismatch between source and destination shapes:\n"
"In 'expand'-mode, the length of each source dimension must either be 1\n"
"or equal to the corresponding destination length.");
combineTwoMultiArraysExpandImpl(s1, sshape1, src1, s2, sshape2, src2,
d, dshape, dest,
f, MetaInt<SrcIterator1::level>());
}
/** \brief Combine two multi-dimensional arrays into one using a binary function or functor.
This function can be applied in three modes:
<DL>
<DT><b>Standard Mode:</b>
<DD>If the source and destination arrays have the same size,
the transformation given by the functor is applied to every pair of
corresponding source elements and the result written into the corresponding
destination element.
Binary functions, binary functors from the STL and the functors specifically
defined in \ref CombineFunctor can be used in standard mode.
Creation of new functors is easiest by using \ref FunctorExpressions.
<DT><b>Expanding Mode:</b>
<DD>If the source arrays have length 1 along some (or even all) dimensions,
the source values at index 0 are used for all destination
elements in those dimensions. In other words, the source index is not
incremented along those dimensions, but the transformation functor
is applied as usual. So, we can expand small arrays (e.g. a single row of data,
column length is 1), into larger ones (e.g. a 2D image with the same width):
the given values are simply reused as necessary (e.g. for every row of the
destination image). It is not even necessary that the source array shapes
are equal. For example, we can combine a small array with one that
hase the same size as the destination array.
The same functors as in standard mode can be applied.
<DT><b>Reducing Mode:</b>
<DD>If the destination array has length 1 along some (or even all) dimensions,
the source values in these dimensions are reduced to single values by means
of a suitable functor which supports two function call operators: one
with two arguments to collect the values, and one without argument to
obtain the final (reduced) result. This behavior is a multi-dimensional
generalization of the C++ standard function <tt>std::accumulate()</tt>.
</DL>
The arrays must be represented by
iterators compatible with \ref vigra::MultiIterator, and the iteration range
is specified by means of shape objects. If only a single source shape is given
the destination array is assumed to have the same shape, and standard mode
is applied. If three shapes are given, the size of corresponding dimensions
must be either equal (standard copy), or the length of this dimension must
be 1 in one or both source arrays
(expand mode), or the destination length must be 1 (reduce mode). However,
reduction and expansion cannot be executed at the same time, so the latter
conditions are mutual exclusive, even if they apply to different dimensions.
The function uses accessors to access the data elements.
<b> Declarations:</b>
<b>\#include</b> \<vigra/multi_pointoperators.hxx\><br>
Namespace: vigra
pass arguments explicitly:
\code
namespace vigra {
template <class SrcIterator1, class SrcShape, class SrcAccessor1,
class SrcIterator2, class SrcAccessor2,
class DestIterator, class DestAccessor,
class Functor>
void combineTwoMultiArrays(
SrcIterator1 s1, SrcShape const & shape, SrcAccessor1 src1,
SrcIterator2 s2, SrcAccessor2 src2,
DestIterator d, DestAccessor dest, Functor const & f);
template <class SrcIterator1, class SrcShape1, class SrcAccessor1,
class SrcIterator2, class SrcShape2, class SrcAccessor2,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void combineTwoMultiArrays(
SrcIterator1 s1, SrcShape1 const & sshape1, SrcAccessor1 src1,
SrcIterator2 s2, SrcShape2 const & sshape2, SrcAccessor2 src2,
DestIterator d, DestShape const & dshape, DestAccessor dest,
Functor const & f);
}
\endcode
use argument objects in conjunction with \ref ArgumentObjectFactories :
\code
namespace vigra {
template <class SrcIterator1, class SrcShape, class SrcAccessor1,
class SrcIterator2, class SrcAccessor2,
class DestIterator, class DestAccessor, class Functor>
void combineTwoMultiArrays(
triple<SrcIterator1, SrcShape, SrcAccessor1> const & src1,
pair<SrcIterator2, SrcAccessor2> const & src2,
pair<DestIterator, DestAccessor> const & dest, Functor const & f);
template <class SrcIterator1, class SrcShape1, class SrcAccessor1,
class SrcIterator2, class SrcShape2, class SrcAccessor2,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void combineTwoMultiArrays(
triple<SrcIterator1, SrcShape1, SrcAccessor1> const & src1,
triple<SrcIterator2, SrcShape2, SrcAccessor2> const & src2,
triple<DestIterator, DestShape, DestAccessor> const & dest,
Functor const & f);
}
\endcode
<b> Usage - Standard Mode:</b>
Source and destination arrays have the same size.
\code
#include <functional> // for std::plus
typedef vigra::MultiArray<3, int> Array;
Array src1(Array::size_type(100, 200, 50)),
src2(Array::size_type(100, 200, 50)),
dest(Array::size_type(100, 200, 50));
...
vigra::combineTwoMultiArrays(
srcMultiArrayRange(src1),
srcMultiArray(src2),
destMultiArray(dest),
std::plus<int>());
\endcode
<b> Usage - Expand Mode:</b>
One source array is only 2D (it has depth 1). This image will be added
to every slice of the other source array, and the result
if written into the corresponding destination slice. Note that the shapes
of all arrays must be passed to the algorithm, so we use
<tt>srcMultiArrayRange()</tt> and <tt>destMultiArrayRange()</tt>
rather than <tt>srcMultiArray()</tt> and <tt>destMultiArray()</tt>.
\code
#include <functional> // for std::plus
typedef vigra::MultiArray<3, int> Array;
Array src1(Array::size_type(100, 200, 1)),
src2(Array::size_type(100, 200, 50)),
dest(Array::size_type(100, 200, 50));
...
vigra::combineTwoMultiArrays(
srcMultiArrayRange(src1),
srcMultiArray(src2),
destMultiArray(dest),
std::plus<int>());
\endcode
<b> Usage - Reduce Mode:</b>
The destination array is only 1D (it's width and height are 1).
Thus, it will contain accumulated data for every slice of the source volumes
(or for every frame, if the sources are interpreted as image sequences).
In the example, we use \ref vigra::ReduceFunctor together with a functor
expression (see \ref FunctorExpressions)
to calculate the total absolute difference of the gray values in every pair of
source slices. Note that the shapes of all arrays must be passed
to the algorithm in order for the reduction to work, so we use
<tt>srcMultiArrayRange()</tt> and <tt>destMultiArrayRange()</tt>
rather than <tt>srcMultiArray()</tt> and <tt>destMultiArray()</tt>.
\code
#include <vigra/functorexpression.hxx>
using namespace vigra::functor;
typedef vigra::MultiArray<3, int> Array;
Array src1(Array::size_type(100, 200, 50)),
src2(Array::size_type(100, 200, 50)),
dest(Array::size_type(1, 1, 50));
...
vigra::combineTwoMultiArrays(
srcMultiArrayRange(src1),
srcMultiArray(src2),
destMultiArray(dest),
reduceFunctor(Arg1() + abs(Arg2() - Arg3()), 0) );
// Arg1() is the sum accumulated so far, initialized with 0
\endcode
Note that the functor must define the appropriate traits described below in order to be
recognized as a reduce functor. This is most easily achieved by deriving from
<tt>BinaryReduceFunctorTag</tt> (see \ref vigra::FunctorTraits).
<b> Required Interface:</b>
In standard and expand mode, the functor must be a model of BinaryFunction
(i.e. support function call with two arguments and a return value
<tt>res = functor(arg1, arg2)</tt>):
\code
MultiIterator src1_begin, src2_begin, dest_begin;
SrcAccessor1 src1_accessor;
SrcAccessor2 src2_accessor;
DestAccessor dest_accessor;
Functor functor;
dest_accessor.set(
functor(src1_accessor(src1_begin), src2_accessor(src2_begin)),
dest_begin);
\endcode
In reduce mode, it must be a model of BinaryAnalyser (i.e. support function call
with two arguments and no return value <tt>functor(arg1, arg2)</tt>) and Initializer
(i.e. support function call with no argument, but return value
<tt>res = functor()</tt>). Internally, such functors are recognized by the
meta functions <tt>FunctorTraits<FUNCTOR>::isBinaryAnalyser</tt> and
<tt>FunctorTraits<FUNCTOR>::isInitializer</tt> which must both yield
<tt>VigraTrueType</tt>. Make sure that your functor correctly defines
<tt>FunctorTraits</tt> because otherwise reduce mode will not work.
This is most easily achieved by deriving the functor from
<tt>BinaryReduceFunctorTag</tt> (see \ref vigra::FunctorTraits).
In addition, the functor must be copy constructible in order to start each reduction
with a fresh functor.
\code
MultiIterator src1_begin, src2_begin, dest_begin;
SrcAccessor1 src1_accessor;
SrcAccessor2 src2_accessor;
DestAccessor dest_accessor;
FUNCTOR initial_functor, functor(initial_functor);
assert(typeid(FunctorTraits<FUNCTOR>::isInitializer) == typeid(VigraTrueType));
assert(typeid(FunctorTraits<FUNCTOR>::isBinaryAnalyser) == typeid(VigraTrueType));
functor(src1_accessor(src1_begin), src2_accessor(src2_begin));
dest_accessor.set(functor(), dest_begin);
\endcode
*/
doxygen_overloaded_function(template <...> void combineTwoMultiArrays)
template <class SrcIterator1, class SrcShape, class SrcAccessor1,
class SrcIterator2, class SrcAccessor2,
class DestIterator, class DestAccessor,
class Functor>
inline void
combineTwoMultiArrays(SrcIterator1 s1, SrcShape const & shape, SrcAccessor1 src1,
SrcIterator2 s2, SrcAccessor2 src2,
DestIterator d, DestAccessor dest, Functor const & f)
{
combineTwoMultiArraysExpandImpl(s1, shape, src1, s2, shape, src2, d, shape, dest, f,
MetaInt<SrcIterator1::level>());
}
template <class SrcIterator1, class SrcShape, class SrcAccessor1,
class SrcIterator2, class SrcAccessor2,
class DestIterator, class DestAccessor, class Functor>
inline void
combineTwoMultiArrays(triple<SrcIterator1, SrcShape, SrcAccessor1> const & src1,
pair<SrcIterator2, SrcAccessor2> const & src2,
pair<DestIterator, DestAccessor> const & dest, Functor const & f)
{
combineTwoMultiArrays(
src1.first, src1.second, src1.third,
src2.first, src2.second, dest.first, dest.second, f);
}
template <class SrcIterator1, class SrcShape1, class SrcAccessor1,
class SrcIterator2, class SrcShape2, class SrcAccessor2,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
void
combineTwoMultiArrays(
SrcIterator1 s1, SrcShape1 const & sshape1, SrcAccessor1 src1,
SrcIterator2 s2, SrcShape2 const & sshape2, SrcAccessor2 src2,
DestIterator d, DestShape const & dshape, DestAccessor dest,
Functor const & f)
{
vigra_precondition(sshape1.size() == dshape.size() && sshape2.size() == dshape.size(),
"combineTwoMultiArrays(): dimensionality of source and destination arrays differ");
typedef FunctorTraits<Functor> FT;
typedef typename
And<typename FT::isInitializer, typename FT::isBinaryAnalyser>::result
isAnalyserInitializer;
combineTwoMultiArraysImpl(s1, sshape1, src1, s2, sshape2, src2, d, dshape, dest,
f, isAnalyserInitializer());
}
template <class SrcIterator1, class SrcShape1, class SrcAccessor1,
class SrcIterator2, class SrcShape2, class SrcAccessor2,
class DestIterator, class DestShape, class DestAccessor,
class Functor>
inline void
combineTwoMultiArrays(
triple<SrcIterator1, SrcShape1, SrcAccessor1> const & src1,
triple<SrcIterator2, SrcShape2, SrcAccessor2> const & src2,
triple<DestIterator, DestShape, DestAccessor> const & dest,
Functor const & f)
{
combineTwoMultiArrays(src1.first, src1.second, src1.third,
src2.first, src2.second, src2.third,
dest.first, dest.second, dest.third, f);
}
/********************************************************/
/* */
/* combineThreeMultiArrays */
/* */
/********************************************************/
template <class SrcIterator1, class SrcShape, class SrcAccessor1,
class SrcIterator2, class SrcAccessor2,
class SrcIterator3, class SrcAccessor3,
class DestIterator, class DestAccessor,
class Functor>
inline void
combineThreeMultiArraysImpl(SrcIterator1 s1, SrcShape const & shape, SrcAccessor1 src1,
SrcIterator2 s2, SrcAccessor2 src2,
SrcIterator3 s3, SrcAccessor3 src3,
DestIterator d, DestAccessor dest, Functor const & f, MetaInt<0>)
{
combineThreeLines(s1, s1 + shape[0], src1, s2, src2, s3, src3, d, dest, f);
}
template <class SrcIterator1, class SrcShape, class SrcAccessor1,
class SrcIterator2, class SrcAccessor2,
class SrcIterator3, class SrcAccessor3,
class DestIterator, class DestAccessor,
class Functor, int N>
void
combineThreeMultiArraysImpl(SrcIterator1 s1, SrcShape const & shape, SrcAccessor1 src1,
SrcIterator2 s2, SrcAccessor2 src2,
SrcIterator3 s3, SrcAccessor3 src3,
DestIterator d, DestAccessor dest,
Functor const & f, MetaInt<N>)
{
SrcIterator1 s1end = s1 + shape[N];
for(; s1 < s1end; ++s1, ++s2, ++s3, ++d)
{
combineThreeMultiArraysImpl(s1.begin(), shape, src1,
s2.begin(), src2, s3.begin(), src3, d.begin(), dest,
f, MetaInt<N-1>());
}
}
/** \brief Combine three multi-dimensional arrays into one using a
ternary function or functor.
Except for the fact that it operates on three input arrays, this function is
identical to \ref combineTwoMultiArrays().
<b> Declarations:</b>
pass arguments explicitly:
\code
namespace vigra {
template <class SrcIterator1, class SrcShape, class SrcAccessor1,
class SrcIterator2, class SrcAccessor2,
class SrcIterator3, class SrcAccessor3,
class DestIterator, class DestAccessor,
class Functor>
void
combineThreeMultiArrays(SrcIterator1 s1, SrcShape const & shape, SrcAccessor1 src1,
SrcIterator2 s2, SrcAccessor2 src2,
SrcIterator3 s3, SrcAccessor3 src3,
DestIterator d, DestAccessor dest, Functor const & f);
}
\endcode
use argument objects in conjunction with \ref ArgumentObjectFactories :
\code
namespace vigra {
template <class SrcIterator1, class SrcShape, class SrcAccessor1,
class SrcIterator2, class SrcAccessor2,
class SrcIterator3, class SrcAccessor3,
class DestIterator, class DestAccessor,
class Functor>
inline void
combineThreeMultiArrays(triple<SrcIterator1, SrcShape, SrcAccessor1> const & src1,
pair<SrcIterator2, SrcAccessor2> const & src2,
pair<SrcIterator3, SrcAccessor3> const & src3,
pair<DestIterator, DestAccessor> const & dest, Functor const & f);
}
\endcode
<b> Usage:</b>
<b>\#include</b> \<vigra/multi_pointoperators.hxx\><br>
Namespace: vigra
\code
#include <functional> // for plus
typedef vigra::MultiArray<3, int> Array;
Array src1(Array::size_type(100, 200, 50)),
src2(Array::size_type(100, 200, 50)),
src3(Array::size_type(100, 200, 50)),
dest(Array::size_type(100, 200, 50));
...
vigra::combineThreeMultiArrays(
srcMultiArrayRange(src1),
srcMultiArray(src2),
srcMultiArray(src3),
destMultiArray(dest),
SomeThreeArgumentFunctor());
\endcode
*/
doxygen_overloaded_function(template <...> void combineThreeMultiArrays)
template <class SrcIterator1, class SrcShape, class SrcAccessor1,
class SrcIterator2, class SrcAccessor2,
class SrcIterator3, class SrcAccessor3,
class DestIterator, class DestAccessor,
class Functor>
inline void
combineThreeMultiArrays(SrcIterator1 s1, SrcShape const & shape, SrcAccessor1 src1,
SrcIterator2 s2, SrcAccessor2 src2,
SrcIterator3 s3, SrcAccessor3 src3,
DestIterator d, DestAccessor dest, Functor const & f)
{
combineThreeMultiArraysImpl(s1, shape, src1, s2, src2, s3, src3, d, dest, f,
MetaInt<SrcIterator1::level>());
}
template <class SrcIterator1, class SrcShape, class SrcAccessor1,
class SrcIterator2, class SrcAccessor2,
class SrcIterator3, class SrcAccessor3,
class DestIterator, class DestAccessor,
class Functor>
inline void
combineThreeMultiArrays(triple<SrcIterator1, SrcShape, SrcAccessor1> const & src1,
pair<SrcIterator2, SrcAccessor2> const & src2,
pair<SrcIterator3, SrcAccessor3> const & src3,
pair<DestIterator, DestAccessor> const & dest, Functor const & f)
{
combineThreeMultiArrays(
src1.first, src1.second, src1.third,
src2.first, src2.second, src3.first, src3.second, dest.first, dest.second, f);
}
/********************************************************/
/* */
/* inspectMultiArray */
/* */
/********************************************************/
template <class Iterator, class Shape, class Accessor, class Functor>
inline void
inspectMultiArrayImpl(Iterator s, Shape const & shape, Accessor a, Functor & f, MetaInt<0>)
{
inspectLine(s, s + shape[0], a, f);
}
template <class Iterator, class Shape, class Accessor, class Functor, int N>
void
inspectMultiArrayImpl(Iterator s, Shape const & shape, Accessor a, Functor & f, MetaInt<N>)
{
Iterator send = s + shape[N];
for(; s < send; ++s)
{
inspectMultiArrayImpl(s.begin(), shape, a, f, MetaInt<N-1>());
}
}
/** \brief Call an analyzing functor at every element of a multi-dimensional array.
This function can be used to collect statistics of the array etc.
The results must be stored in the functor, which serves as a return
value. The arrays must be represented by
iterators compatible with \ref vigra::MultiIterator.
The function uses an accessor to access the pixel data. Note that the iterator range
must be specified by a shape object, because otherwise we could not control
the range simultaneously in all dimensions (this is a necessary consequence
of the \ref vigra::MultiIterator design).
<b> Declarations:</b>
pass arguments explicitly:
\code
namespace vigra {
template <class Iterator, class Shape, class Accessor, class Functor>
void
inspectMultiArray(Iterator s, Shape const & shape, Accessor a, Functor & f);
}
\endcode
use argument objects in conjunction with \ref ArgumentObjectFactories :
\code
namespace vigra {
template <class Iterator, class Shape, class Accessor, class Functor>
void
inspectMultiArray(triple<Iterator, Shape, Accessor> const & s, Functor & f);
}
\endcode
<b> Usage:</b>
<b>\#include</b> \<vigra/multi_pointoperators.hxx\><br>
Namespace: vigra
\code
typedef vigra::MultiArray<3, int> Array;
Array array(Array::size_type(100, 200, 50));
// init functor
vigra::FindMinMax<int> minmax;
vigra::inspectMultiArray(srcMultiArrayRange(array), minmax);
cout << "Min: " << minmax.min << " Max: " << minmax.max;
\endcode
<b> Required Interface:</b>
\code
MultiIterator src_begin;
Accessor accessor;
Functor functor;
functor(accessor(src_begin));
\endcode
*/
doxygen_overloaded_function(template <...> void inspectMultiArray)
template <class Iterator, class Shape, class Accessor>
struct inspectMultiArray_binder
{
Iterator s;
const Shape & shape;
Accessor a;
inspectMultiArray_binder(Iterator s_, const Shape & shape_, Accessor a_)
: s(s_), shape(shape_), a(a_) {}
template <class Functor>
void operator()(Functor & f)
{
inspectMultiArrayImpl(s, shape, a, f, MetaInt<Iterator::level>());
}
};
template <class Iterator, class Shape, class Accessor, class Functor>
inline void
inspectMultiArray(Iterator s, Shape const & shape, Accessor a, Functor & f)
{
inspectMultiArray_binder<Iterator, Shape, Accessor> g(s, shape, a);
detail::extra_passes_select(g, f);
}
template <class Iterator, class Shape, class Accessor, class Functor>
inline void
inspectMultiArray(triple<Iterator, Shape, Accessor> const & s, Functor & f)
{
inspectMultiArray(s.first, s.second, s.third, f);
}
/********************************************************/
/* */
/* inspectTwoMultiArrays */
/* */
/********************************************************/
template <class Iterator1, class Shape, class Accessor1,
class Iterator2, class Accessor2,
class Functor>
inline void
inspectTwoMultiArraysImpl(Iterator1 s1, Shape const & shape, Accessor1 a1,
Iterator2 s2, Accessor2 a2,
Functor & f, MetaInt<0>)
{
inspectTwoLines(s1, s1 + shape[0], a1, s2, a2, f);
}
template <class Iterator1, class Shape, class Accessor1,
class Iterator2, class Accessor2,
class Functor, int N>
void
inspectTwoMultiArraysImpl(Iterator1 s1, Shape const & shape, Accessor1 a1,
Iterator2 s2, Accessor2 a2,
Functor & f, MetaInt<N>)
{
Iterator1 s1end = s1 + shape[N];
for(; s1 < s1end; ++s1, ++s2)
{
inspectTwoMultiArraysImpl(s1.begin(), shape, a1,
s2.begin(), a2, f, MetaInt<N-1>());
}
}
/** \brief Call an analyzing functor at all corresponding elements of
two multi-dimensional arrays.
This function can be used to collect statistics of the array etc.
The results must be stored in the functor, which serves as a return
value. The arrays must be represented by
iterators compatible with \ref vigra::MultiIterator.
The function uses an accessor to access the pixel data. Note that the iterator range
must be specified by a shape object, because otherwise we could not control
the range simultaneously in all dimensions (this is a necessary consequence
of the \ref vigra::MultiIterator design).
<b> Declarations:</b>
pass arguments explicitly:
\code
namespace vigra {
template <class Iterator1, class Shape, class Accessor1,
class Iterator2, class Accessor2,
class Functor>
void
inspectTwoMultiArrays(Iterator1 s1, Shape const & shape, Accessor1 a1,
Iterator2 s2, Accessor2 a2, Functor & f);
}
\endcode
use argument objects in conjunction with \ref ArgumentObjectFactories :
\code
namespace vigra {
template <class Iterator1, class Shape1, class Accessor1,
class Iterator2, class Accessor2,
class Functor>
void
inspectTwoMultiArrays(triple<Iterator1, Shape1, Accessor1> const & s1,
pair<Iterator2, Accessor2> const & s2, Functor & f);
}
\endcode
<b> Usage:</b>
<b>\#include</b> \<vigra/multi_pointoperators.hxx\><br>
Namespace: vigra
\code
typedef vigra::MultiArray<3, int> Array;
Array array1(Array::size_type(100, 200, 50)),
array2(Array::size_type(100, 200, 50));
// init functor
SomeStatisticsFunctor stats(..);
vigra::inspectTwoMultiArrays(srcMultiArrayRange(array1), srcMultiArray(array2), stats);
\endcode
<b> Required Interface:</b>
\code
MultiIterator src1_begin, src2_begin;
Accessor a1, a2;
Functor functor;
functor(a1(src1_begin), a2(src2_begin));
\endcode
*/
doxygen_overloaded_function(template <...> void inspectTwoMultiArrays)
template <class Iterator1, class Shape, class Accessor1,
class Iterator2, class Accessor2>
struct inspectTwoMultiArrays_binder
{
Iterator1 s1;
const Shape & shape;
Accessor1 a1;
Iterator2 s2;
Accessor2 a2;
inspectTwoMultiArrays_binder(Iterator1 s1_, const Shape & shape_,
Accessor1 a1_, Iterator2 s2_, Accessor2 a2_)
: s1(s1_), shape(shape_), a1(a1_), s2(s2_), a2(a2_) {}
template <class Functor>
void operator()(Functor & f)
{
inspectTwoMultiArraysImpl(s1, shape, a1, s2, a2, f,
MetaInt<Iterator1::level>());
}
};
template <class Iterator1, class Shape, class Accessor1,
class Iterator2, class Accessor2,
class Functor>
inline void
inspectTwoMultiArrays(Iterator1 s1, Shape const & shape, Accessor1 a1,
Iterator2 s2, Accessor2 a2, Functor & f)
{
inspectTwoMultiArrays_binder<Iterator1, Shape, Accessor1,
Iterator2, Accessor2>
g(s1, shape, a1, s2, a2);
detail::extra_passes_select(g, f);
}
template <class Iterator1, class Shape, class Accessor1,
class Iterator2, class Accessor2,
class Functor>
inline
void
inspectTwoMultiArrays(triple<Iterator1, Shape, Accessor1> const & s1,
pair<Iterator2, Accessor2> const & s2, Functor & f)
{
inspectTwoMultiArrays(s1.first, s1.second, s1.third,
s2.first, s2.second, f);
}
//@}
} //-- namespace vigra
#endif //-- VIGRA_MULTI_POINTOPERATORS_H
|