/usr/include/vigra/imageiterator.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 | /************************************************************************/
/* */
/* Copyright 1998-2002 by Ullrich Koethe */
/* */
/* 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_IMAGEITERATOR_HXX
#define VIGRA_IMAGEITERATOR_HXX
#include "utilities.hxx"
#include "accessor.hxx"
#include "iteratortraits.hxx"
#include "metaprogramming.hxx"
namespace vigra {
template <class IMAGEITERATOR>
class StridedIteratorPolicy
{
public:
typedef IMAGEITERATOR ImageIterator;
typedef typename IMAGEITERATOR::value_type value_type;
typedef typename IMAGEITERATOR::difference_type::MoveY
difference_type;
typedef typename IMAGEITERATOR::reference reference;
typedef typename IMAGEITERATOR::index_reference index_reference;
typedef typename IMAGEITERATOR::pointer pointer;
typedef std::random_access_iterator_tag iterator_category;
struct BaseType
{
explicit BaseType(pointer c = 0, difference_type stride = 0)
: current_(c), stride_(stride)
{}
pointer current_;
difference_type stride_;
};
static void initialize(BaseType & /* d */) {}
static reference dereference(BaseType const & d)
{ return const_cast<reference>(*d.current_); }
static index_reference dereference(BaseType const & d, difference_type n)
{
return const_cast<index_reference>(d.current_[n*d.stride_]);
}
static bool equal(BaseType const & d1, BaseType const & d2)
{ return d1.current_ == d2.current_; }
static bool less(BaseType const & d1, BaseType const & d2)
{ return d1.current_ < d2.current_; }
static difference_type difference(BaseType const & d1, BaseType const & d2)
{ return (d1.current_ - d2.current_) / d1.stride_; }
static void increment(BaseType & d)
{ d.current_ += d.stride_; }
static void decrement(BaseType & d)
{ d.current_ -= d.stride_; }
static void advance(BaseType & d, difference_type n)
{ d.current_ += d.stride_*n; }
};
/** \addtogroup ImageIterators Image Iterators
\brief General image iterator definition and implementations.
<p>
The following tables describe the general requirements for image iterators
and their iterator traits. The iterator implementations provided here
may be used for any image data type that stores its
data as a linear array of pixels. The array will be interpreted as a
row-major matrix with a particular width.
</p>
<h3>Requirements for Image Iterators</h3>
<p>
<table border=2 cellspacing=0 cellpadding=2 width="100%">
<tr><th colspan=2>
Local Types
</th><th>
Meaning
</th>
</tr>
<tr><td colspan=2>
<tt>ImageIterator::value_type</tt></td><td>the underlying image's pixel type</td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator::PixelType</tt></td><td>the underlying image's pixel type</td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator::reference</tt></td>
<td>the iterator's reference type (return type of <TT>*iter</TT>). Will be
<tt>value_type &</tt> for a mutable iterator, and convertible to
<tt>value_type const &</tt> for a const iterator.</td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator::index_reference</tt></td>
<td>the iterator's index reference type (return type of <TT>iter[diff]</TT>). Will be
<tt>value_type &</tt> for a mutable iterator, and convertible to
<tt>value_type const &</tt> for a const iterator.</td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator::pointer</tt></td>
<td>the iterator's pointer type (return type of <TT>iter.operator->()</TT>). Will be
<tt>value_type *</tt> for a mutable iterator, and convertible to
<tt>value_type const *</tt> for a const iterator.</td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator::difference_type</tt></td>
<td>the iterator's difference type (<TT>vigra::Diff2D</TT>)</td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator::iterator_category</tt></td>
<td>the iterator tag (<tt>vigra::image_traverser_tag</tt>)</td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator::row_iterator</tt></td><td>the associated row iterator</td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator::column_iterator</tt></td><td>the associated column iterator</td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator::MoveX</tt></td><td>type of the horizontal navigator</td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator::MoveY</tt></td><td>type of the vertical navigator</td>
</tr>
<tr><th>
Operation
</th><th>
Result
</th><th>
Semantics
</th>
</tr>
<tr>
<td><tt>++i.x<br>i.x--</tt></td><td><tt>void</tt></td><td>increment x-coordinate</td>
</tr>
<tr>
<td><tt>--i.x<br>i.x--</tt></td><td><tt>void</tt></td><td>decrement x-coordinate</td>
</tr>
<tr>
<td><tt>i.x += dx</tt></td><td><tt>ImageIterator::MoveX &</tt></td>
<td>add <tt>dx</tt> to x-coordinate</td>
</tr>
<tr>
<td><tt>i.x -= dx</tt></td><td><tt>ImageIterator::MoveX &</tt></td>
<td>subtract <tt>dx</tt> from x-coordinate</td>
</tr>
<tr>
<td><tt>i.x - j.x</tt></td><td><tt>int</tt></td>
<td>difference of the x-coordinates of <tt>i</tt> and <tt>j</tt></td>
</tr>
<tr>
<td><tt>i.x = j.x</tt></td><td><tt>ImageIterator::MoveX &</tt></td><td><tt>i.x += j.x - i.x</tt></td>
</tr>
<tr>
<td><tt>i.x == i.y</tt></td><td><tt>bool</tt></td><td><tt>j.x - i.x == 0</tt></td>
</tr>
<tr>
<td><tt>i.x < j.x</tt></td><td><tt>bool</tt></td><td><tt>j.x - i.x > 0</tt></td>
</tr>
<tr>
<td><tt>++i.y<br>i.y++</tt></td><td><tt>void</tt></td><td>increment y-coordinate</td>
</tr>
<tr>
<td><tt>--i.y<br>i.y--</tt></td><td><tt>void</tt></td><td>decrement y-coordinate</td>
</tr>
<tr>
<td><tt>i.y += dy</tt></td><td><tt>ImageIterator::MoveY &</tt></td>
<td>add <tt>dy</tt> to y-coordinate</td>
</tr>
<tr>
<td><tt>i.y -= dy</tt></td><td><tt>ImageIterator::MoveY &</tt></td>
<td>subtract <tt>dy</tt> from y-coordinate</td>
</tr>
<tr>
<td><tt>i.y - j.y</tt></td><td><tt>int</tt></td>
<td>difference of the y-coordinates of <tt>i</tt> and <tt>j</tt></td>
</tr>
<tr>
<td><tt>i.y = j.y</tt></td><td><tt>ImageIterator::MoveY &</tt></td><td><tt>i.y += j.y - i.y</tt></td>
</tr>
<tr>
<td><tt>i.y == j.y</tt></td><td><tt>bool</tt></td><td><tt>j.y - i.y == 0</tt></td>
</tr>
<tr>
<td><tt>i.y < j.y</tt></td><td><tt>bool</tt></td><td><tt>j.y - i.y > 0</tt></td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator k(i)</tt></td><td>copy constructor</td>
</tr>
<tr>
<td><tt>k = i</tt></td><td><tt>ImageIterator &</tt></td><td>assignment</td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator k</tt></td><td>default constructor</td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator::row_iterator r(i)</tt></td><td>construction of row iterator</td>
</tr>
<tr><td colspan=2>
<tt>ImageIterator::column_iterator c(i)</tt></td><td>construction of column iterator</td>
</tr>
<tr>
<td><tt>i += diff</tt></td><td><tt>ImageIterator &</tt></td>
<td><tt>{ i.x += diff.x<br>i.y += diff.y; }</tt></td>
</tr>
<tr>
<td><tt>i -= diff</tt></td><td><tt>ImageIterator &</tt></td>
<td><tt>{ i.x -= diff.x<br>i.y -= diff.y; }</tt></td>
</tr>
<tr>
<td><tt>i + diff</tt></td><td><tt>ImageIterator</tt></td>
<td><tt>{ ImageIterator tmp(i);<br>tmp += diff;<br>return tmp; }</tt></td>
</tr>
<tr>
<td><tt>i - diff</tt></td><td><tt>ImageIterator</tt></td>
<td><tt>{ ImageIterator tmp(i);<br>tmp -= diff;<br>return tmp; }</tt></td>
</tr>
<tr>
<td><tt>i - j</tt></td><td><tt>ImageIterator::difference_type</tt></td>
<td><tt>{ ImageIterator::difference_type tmp(i.x - j.x, i.y - j.y);<br>return tmp; }</tt></td>
</tr>
<tr>
<td><tt>i == j</tt></td><td><tt>bool</tt></td>
<td><tt>i.x == j.x && i.y == j.y</tt></td>
</tr>
<tr>
<td><tt>*i</tt></td><td><tt>ImageIterator::reference</tt></td>
<td>access the current pixel</td>
</tr>
<tr>
<td><tt>i[diff]</tt></td><td><tt>ImageIterator::index_reference</tt></td>
<td>access pixel at offset <tt>diff</tt></td>
</tr>
<tr>
<td><tt>i(dx, dy)</tt></td><td><tt>ImageIterator::index_reference</tt></td>
<td>access pixel at offset <tt>(dx, dy)</tt></td>
</tr>
<tr>
<td><tt>i->member()</tt></td><td>depends on operation</td>
<td>call member function of underlying pixel type via <tt>operator-></tt> of iterator</td>
</tr>
<tr><td colspan=3>
<tt>i, j, k</tt> are of type <tt>ImageIterator</tt><br>
<tt>diff</tt> is of type <tt>ImageIterator::difference_type</tt><br>
<tt>dx, dy</tt> are of type <tt>int</tt><br>
</td>
</tr>
</table>
</p>
<h3>Requirements for Image Iterator Traits</h3>
<p>
The following iterator traits must be defined for an image iterator:
</p>
<p>
<table border=2 cellspacing=0 cellpadding=2 width="100%">
<tr><th>
Types
</th><th>
Meaning
</th>
</tr>
<tr>
<td><tt>IteratorTraits<ImageIterator>::Iterator</tt></td><td>the iterator type the traits are referring to</td>
</tr>
<tr>
<td><tt>IteratorTraits<ImageIterator>::iterator</tt></td><td>the iterator type the traits are referring to</td>
</tr>
<tr>
<td><tt>IteratorTraits<ImageIterator>::value_type</tt></td><td>the underlying image's pixel type</td>
</tr>
<tr>
<td><tt>IteratorTraits<ImageIterator>::reference</tt></td>
<td>the iterator's reference type (return type of <TT>*iter</TT>)</td>
</tr>
<tr>
<td><tt>IteratorTraits<ImageIterator>::index_reference</tt></td>
<td>the iterator's index reference type (return type of <TT>iter[diff]</TT>)</td>
</tr>
<tr>
<td><tt>IteratorTraits<ImageIterator>::pointer</tt></td>
<td>the iterator's pointer type (return type of <TT>iter.operator->()</TT>)</td>
</tr>
<tr>
<td><tt>IteratorTraits<ImageIterator>::difference_type</tt></td>
<td>the iterator's difference type</td>
</tr>
<tr>
<td><tt>IteratorTraits<ImageIterator>::iterator_category</tt></td>
<td>the iterator tag (<tt>vigra::image_traverser_tag</tt>)</td>
</tr>
<tr>
<td><tt>IteratorTraits<ImageIterator>::row_iterator</tt></td><td>the associated row iterator</td>
</tr>
<tr>
<td><tt>IteratorTraits<ImageIterator>::column_iterator</tt></td><td>the associated column iterator</td>
</tr>
<tr>
<td><tt>IteratorTraits<ImageIterator>::DefaultAccessor</tt></td>
<td>the default accessor to be used with the iterator</td>
</tr>
<tr>
<td><tt>IteratorTraits<ImageIterator>::default_accessor</tt></td>
<td>the default accessor to be used with the iterator</td>
</tr>
<tr>
<td><tt>IteratorTraits<ImageIterator>::hasConstantStrides</tt></td>
<td>whether the iterator uses constant strides on the underlying memory
(always <tt>VigraTrueType</tt> for <tt>ImageIterator</tt>s).</td>
</tr>
</table>
</p>
*/
//@{
namespace detail {
template <class StridedOrUnstrided>
class DirectionSelector;
template <>
class DirectionSelector<UnstridedArrayTag>
{
public:
template <class T>
class type
{
public:
type(T base)
: current_(base)
{}
type(type const & rhs)
: current_(rhs.current_)
{}
type & operator=(type const & rhs)
{
current_ = rhs.current_;
return *this;
}
void operator++() {++current_;}
void operator++(int) {++current_;}
void operator--() {--current_;}
void operator--(int) {--current_;}
void operator+=(int dx) {current_ += dx; }
void operator-=(int dx) {current_ -= dx; }
bool operator==(type const & rhs) const
{ return current_ == rhs.current_; }
bool operator!=(type const & rhs) const
{ return current_ != rhs.current_; }
bool operator<(type const & rhs) const
{ return current_ < rhs.current_; }
bool operator<=(type const & rhs) const
{ return current_ <= rhs.current_; }
bool operator>(type const & rhs) const
{ return current_ > rhs.current_; }
bool operator>=(type const & rhs) const
{ return current_ >= rhs.current_; }
int operator-(type const & rhs) const
{ return current_ - rhs.current_; }
T operator()() const
{ return current_; }
T operator()(int d) const
{ return current_ + d; }
T current_;
};
};
template <>
class DirectionSelector<StridedArrayTag>
{
public:
template <class T>
class type
{
public:
type(int stride, T base = 0)
: stride_(stride),
current_(base)
{}
type(type const & rhs)
: stride_(rhs.stride_),
current_(rhs.current_)
{}
type & operator=(type const & rhs)
{
stride_ = rhs.stride_;
current_ = rhs.current_;
return *this;
}
void operator++() {current_ += stride_; }
void operator++(int) {current_ += stride_; }
void operator--() {current_ -= stride_; }
void operator--(int) {current_ -= stride_; }
void operator+=(int dy) {current_ += dy*stride_; }
void operator-=(int dy) {current_ -= dy*stride_; }
bool operator==(type const & rhs) const
{ return (current_ == rhs.current_); }
bool operator!=(type const & rhs) const
{ return (current_ != rhs.current_); }
bool operator<(type const & rhs) const
{ return (current_ < rhs.current_); }
bool operator<=(type const & rhs) const
{ return (current_ <= rhs.current_); }
bool operator>(type const & rhs) const
{ return (current_ > rhs.current_); }
bool operator>=(type const & rhs) const
{ return (current_ >= rhs.current_); }
int operator-(type const & rhs) const
{ return (current_ - rhs.current_) / stride_; }
T operator()() const
{ return current_; }
T operator()(int d) const
{ return current_ + d*stride_; }
int stride_;
T current_;
};
};
template <class StridedOrUnstrided>
class LinearIteratorSelector;
template <>
class LinearIteratorSelector<UnstridedArrayTag>
{
public:
template <class IMAGEITERATOR>
class type
{
public:
typedef typename IMAGEITERATOR::pointer res;
template <class DirSelect>
static res construct(typename IMAGEITERATOR::pointer data, DirSelect const &)
{
return data;
}
};
};
template <>
class LinearIteratorSelector<StridedArrayTag>
{
public:
template <class IMAGEITERATOR>
class type
{
public:
typedef IteratorAdaptor<StridedIteratorPolicy<IMAGEITERATOR> > res;
template <class DirSelect>
static res construct(typename IMAGEITERATOR::pointer data, DirSelect const & d)
{
typedef typename res::BaseType Base;
return res(Base(data, d.stride_));
}
};
};
} // namespace detail
/********************************************************/
/* */
/* ImageIteratorBase */
/* */
/********************************************************/
/** \brief Base class for 2D random access iterators.
This class contains the navigational part of the iterator.
It is usually not constructed directly, but via some derived class such as
\ref ImageIterator or \ref StridedImageIterator.
<b>\#include</b> \<vigra/imageiterator.hxx\>
Namespace: vigra
The usage examples assume that you constructed two iterators like
this:
\code
vigra::ImageIterator<SomePixelType> iterator(base, width);
vigra::ImageIterator<SomePixelType> iterator1(base, width);
\endcode
See the paper: U. Koethe:
<a href="http://hci.iwr.uni-heidelberg.de/vigra/documents/GenericProg2D.ps">Reusable Algorithms in Image Processing</a>
for a discussion of the concepts behind ImageIterators.
*/
template <class IMAGEITERATOR,
class PIXELTYPE, class REFERENCE, class POINTER,
class StridedOrUnstrided = UnstridedArrayTag>
class ImageIteratorBase
{
typedef typename
vigra::detail::LinearIteratorSelector<StridedOrUnstrided>::template type<ImageIteratorBase>
RowIteratorSelector;
typedef typename
vigra::detail::LinearIteratorSelector<StridedArrayTag>::template type<ImageIteratorBase>
ColumnIteratorSelector;
public:
typedef ImageIteratorBase<IMAGEITERATOR,
PIXELTYPE, REFERENCE, POINTER, StridedOrUnstrided> self_type;
/** The underlying image's pixel type.
*/
typedef PIXELTYPE value_type;
/** deprecated, use <TT>value_type</TT> instead.
*/
typedef PIXELTYPE PixelType;
/** the iterator's reference type (return type of <TT>*iter</TT>)
*/
typedef REFERENCE reference;
/** the iterator's index reference type (return type of <TT>iter[diff]</TT>)
*/
typedef REFERENCE index_reference;
/** the iterator's pointer type (return type of <TT>iter.operator->()</TT>)
*/
typedef POINTER pointer;
/** the iterator's difference type (argument type of <TT>iter[diff]</TT>)
*/
typedef Diff2D difference_type;
/** the iterator tag (image traverser)
*/
typedef image_traverser_tag iterator_category;
/** The associated row iterator.
*/
typedef typename RowIteratorSelector::res row_iterator;
/** The associated column iterator.
*/
typedef typename ColumnIteratorSelector::res column_iterator;
/** Let operations act in X direction
*/
typedef typename
vigra::detail::DirectionSelector<StridedOrUnstrided>::template type<pointer> MoveX;
/** Let operations act in Y direction
*/
typedef typename
vigra::detail::DirectionSelector<StridedArrayTag>::template type<int> MoveY;
/** @name Comparison of Iterators */
//@{
/** usage: <TT> iterator == iterator1 </TT>
*/
bool operator==(ImageIteratorBase const & rhs) const
{
return (x == rhs.x) && (y == rhs.y);
}
/** usage: <TT> iterator != iterator1 </TT>
*/
bool operator!=(ImageIteratorBase const & rhs) const
{
return (x != rhs.x) || (y != rhs.y);
}
/** usage: <TT> Diff2D dist = iterator - iterator1 </TT>
*/
difference_type operator-(ImageIteratorBase const & rhs) const
{
return difference_type(x - rhs.x, y - rhs.y);
}
//@}
/** @name Specify coordinate to operate on */
//@{
/** Refer to iterator's x coordinate.
Usage examples:<br>
\code
++iterator.x; // move one step to the right
--iterator.x; // move one step to the left
iterator.x += dx; // move dx steps to the right
iterator.x -= dx; // move dx steps to the left
bool notAtEndOfRow = iterator.x < lowerRight.x; // compare x coordinates of two iterators
int width = lowerRight.x - upperLeft.x; // calculate difference of x coordinates
// between two iterators
\endcode
*/
MoveX x;
/** Refer to iterator's y coordinate.
Usage examples:<br>
\code
++iterator.y; // move one step down
--iterator.y; // move one step up
iterator.y += dy; // move dy steps down
iterator.y -= dy; // move dy steps up
bool notAtEndOfColumn = iterator.y < lowerRight.y; // compare y coordinates of two iterators
int height = lowerRight.y - upperLeft.y; // calculate difference of y coordinates
// between two iterators
\endcode
*/
MoveY y;
//@}
protected:
/** Construct from raw memory with a vertical stride of <TT>ystride</TT>.
<TT>ystride</TT> must equal the physical image width (row length),
even if the iterator will only be used for a sub image. This constructor
must only be called for unstrided iterators
(<tt>StridedOrUnstrided == UnstridedArrayTag</tt>)
*/
ImageIteratorBase(pointer base, int ystride)
: x(base),
y(ystride)
{}
/** Construct from raw memory with a horizontal stride of <TT>xstride</TT>
and a vertical stride of <TT>ystride</TT>. This constructor
may be used for iterators that shall skip pixels. Thus, it
must only be called for strided iterators
(<tt>StridedOrUnstrided == StridedArrayTag</tt>)
*/
ImageIteratorBase(pointer base, int xstride, int ystride)
: x(xstride, base),
y(ystride)
{}
/** Copy constructor */
ImageIteratorBase(ImageIteratorBase const & rhs)
: x(rhs.x),
y(rhs.y)
{}
/** Default constructor */
ImageIteratorBase()
: x(0),
y(0)
{}
/** Copy assignment */
ImageIteratorBase & operator=(ImageIteratorBase const & rhs)
{
if(this != &rhs)
{
x = rhs.x;
y = rhs.y;
}
return *this;
}
public:
/** @name Random navigation */
//@{
/** Add offset via Diff2D
*/
IMAGEITERATOR & operator+=(difference_type const & s)
{
x += s.x;
y += s.y;
return static_cast<IMAGEITERATOR &>(*this);
}
/** Subtract offset via Diff2D
*/
IMAGEITERATOR & operator-=(difference_type const & s)
{
x -= s.x;
y -= s.y;
return static_cast<IMAGEITERATOR &>(*this);
}
/** Add a distance
*/
IMAGEITERATOR operator+(difference_type const & s) const
{
IMAGEITERATOR ret(static_cast<IMAGEITERATOR const &>(*this));
ret += s;
return ret;
}
/** Subtract a distance
*/
IMAGEITERATOR operator-(difference_type const & s) const
{
IMAGEITERATOR ret(static_cast<IMAGEITERATOR const &>(*this));
ret -= s;
return ret;
}
//@}
/** @name Access the Pixels */
//@{
/** Access current pixel. <br>
usage: <TT> SomePixelType value = *iterator </TT>
*/
reference operator*() const
{
return *current();
}
/** Call member of current pixel. <br>
usage: <TT> iterator->pixelMemberFunction() </TT>
*/
pointer operator->() const
{
return current();
}
/** Access pixel at offset from current location. <br>
usage: <TT> SomePixelType value = iterator[Diff2D(1,1)] </TT>
*/
index_reference operator[](Diff2D const & d) const
{
return *current(d.x, d.y);
}
/** Access pixel at offset (dx, dy) from current location. <br>
usage: <TT> SomePixelType value = iterator(dx, dy) </TT>
*/
index_reference operator()(int dx, int dy) const
{
return *current(dx, dy);
}
/** Read pixel with offset [dy][dx] from current pixel.
Note that the 'x' index is the trailing index. <br>
usage: <TT> SomePixelType value = iterator[dy][dx] </TT>
*/
pointer operator[](int dy) const
{
return x() + y(dy);
}
//@}
row_iterator rowIterator() const
{
return RowIteratorSelector::construct(current(), x);
}
column_iterator columnIterator() const
{
return ColumnIteratorSelector::construct(current(), y);
}
private:
pointer current() const
{ return x() + y(); }
pointer current(int dx, int dy) const
{ return x(dx) + y(dy); }
};
/********************************************************/
/* */
/* ImageIterator */
/* */
/********************************************************/
/** \brief Standard 2D random access iterator for images that store the
data in a linear array.
Most functions and local types are inherited from ImageIteratorBase.
See the paper: U. Koethe:
<a href="http://hci.iwr.uni-heidelberg.de/vigra/documents/GenericProg2D.ps">Reusable Algorithms in Image Processing</a>
for a discussion of the concepts behind ImageIterators.
<b>\#include</b> \<vigra/imageiterator.hxx\>
Namespace: vigra
*/
template <class PIXELTYPE>
class ImageIterator
: public ImageIteratorBase<ImageIterator<PIXELTYPE>,
PIXELTYPE, PIXELTYPE &, PIXELTYPE *>
{
public:
typedef ImageIteratorBase<ImageIterator<PIXELTYPE>,
PIXELTYPE, PIXELTYPE &, PIXELTYPE *> Base;
typedef typename Base::pointer pointer;
typedef typename Base::difference_type difference_type;
/** Construct from raw memory with a vertical stride of <TT>ystride</TT>.
<TT>ystride</TT> must equal the physical image width (row length),
even if the iterator will only be used for a sub image.
If the raw memory is encapsulated in an image object this
object should have a factory function that constructs the
iterator.
*/
ImageIterator(pointer base, int ystride)
: Base(base, ystride)
{}
/** Default constructor */
ImageIterator()
: Base()
{}
};
/********************************************************/
/* */
/* ConstImageIterator */
/* */
/********************************************************/
/** \brief Standard 2D random access const iterator for images that
store the data as a linear array.
Most functions are inherited from ImageIteratorBase.
<b>\#include</b> \<vigra/imageiterator.hxx\>
Namespace: vigra
*/
template <class PIXELTYPE>
class ConstImageIterator
: public ImageIteratorBase<ConstImageIterator<PIXELTYPE>,
PIXELTYPE, PIXELTYPE const &, PIXELTYPE const *>
{
public:
typedef ImageIteratorBase<ConstImageIterator<PIXELTYPE>,
PIXELTYPE, PIXELTYPE const &, PIXELTYPE const *> Base;
typedef typename Base::pointer pointer;
typedef typename Base::difference_type difference_type;
/** Construct from raw memory with a vertical stride of <TT>ystride</TT>.
<TT>ystride</TT> must equal the physical image width (row length),
even if the iterator will only be used for a sub image.
If the raw memory is encapsulated in an image object this
object should have a factory function that constructs the
iterator.
*/
ConstImageIterator(pointer base, int ystride)
: Base(base, ystride)
{}
ConstImageIterator(ImageIterator<PIXELTYPE> const & o)
: Base(o.x, o.y)
{}
/** Default constructor */
ConstImageIterator()
: Base()
{}
ConstImageIterator & operator=(ImageIterator<PIXELTYPE> const & o)
{
Base::x = o.x;
Base::y = o.y;
return *this;
}
};
/********************************************************/
/* */
/* StridedImageIterator */
/* */
/********************************************************/
/** \brief Iterator to be used when pixels are to be skipped.
This iterator can be used when some pixels shall be automatically skipped, for example
if an image is to be sub-sampled: instead of advancing to the next pixel,
<tt>++iterator.x</tt> jumps to the pixel at a horizontal offset of <tt>xskip</tt>.
Likewise with <tt>yskip</tt> in vertical direction. Most functions and local types
are inherited from ImageIteratorBase.
<b> Usage:</b>
\code
BImage img(w,h);
...
int xskip = 2, yskip = 2;
int wskip = w / xskip + 1, hskip = h / yskip + 1;
StridedImageIterator<BImage::value_type> upperLeft(&img(0,0), w, xskip, yskip);
StridedImageIterator<BImage::value_type> lowerRight = upperLeft + Diff2D(wskip, hskip);
// now navigation with upperLeft and lowerRight lets the image appear to have half
// the original resolution in either dimension
\endcode
<b>\#include</b> \<vigra/imageiterator.hxx\>
Namespace: vigra
*/
template <class PIXELTYPE>
class StridedImageIterator
: public ImageIteratorBase<StridedImageIterator<PIXELTYPE>,
PIXELTYPE, PIXELTYPE &, PIXELTYPE *, StridedArrayTag>
{
public:
typedef ImageIteratorBase<StridedImageIterator<PIXELTYPE>,
PIXELTYPE, PIXELTYPE &, PIXELTYPE *, StridedArrayTag> Base;
typedef typename Base::pointer pointer;
typedef typename Base::difference_type difference_type;
/** Construct from raw memory with a vertical stride of <TT>ystride</TT>,
jumping by <tt>xskip</tt> horizontally and <tt>yskip</tt> vertically.
<tt>ystride</tt> must be the physical width (row length) of the image.
*/
StridedImageIterator(pointer base, int ystride, int xskip, int yskip)
: Base(base, xskip, ystride*yskip)
{}
/** Default constructor */
StridedImageIterator()
: Base()
{}
};
/********************************************************/
/* */
/* ConstStridedImageIterator */
/* */
/********************************************************/
/** \brief Const iterator to be used when pixels are to be skipped.
This iterator can be used when some pixels shall be automatically skipped, for example
if an image is to be sub-sampled: instead of advancing to the next pixel,
<tt>++iterator.x</tt> jumps to the pixel at a horizontal offset of <tt>xskip</tt>.
Likewise with <tt>yskip</tt> in vertical direction. Most functions and local types
are inherited from ImageIteratorBase.
<b> Usage:</b>
\code
BImage img(w,h);
...
int xskip = 2, yskip = 2;
int wskip = w / xskip + 1, hskip = h / yskip + 1;
ConstStridedImageIterator<BImage::value_type> upperLeft(&img(0,0), w, xskip, yskip);
ConstStridedImageIterator<BImage::value_type> lowerRight = upperLeft + Diff2D(wskip, hskip);
// now navigation with upperLeft and lowerRight lets the image appear to have half
// the original resolution in either dimension
\endcode
<b>\#include</b> \<vigra/imageiterator.hxx\>
Namespace: vigra
*/
template <class PIXELTYPE>
class ConstStridedImageIterator
: public ImageIteratorBase<ConstStridedImageIterator<PIXELTYPE>,
PIXELTYPE, PIXELTYPE const &, PIXELTYPE const *,
StridedArrayTag>
{
public:
typedef ImageIteratorBase<ConstStridedImageIterator<PIXELTYPE>,
PIXELTYPE, PIXELTYPE const &, PIXELTYPE const *,
StridedArrayTag> Base;
typedef typename Base::pointer pointer;
typedef typename Base::difference_type difference_type;
/** Construct from raw memory with a vertical stride of <TT>ystride</TT>,
jumping by <tt>xskip</tt> horizontally and <tt>yskip</tt> vertically.
<tt>ystride</tt> must be the physical width (row length) of the image.
*/
ConstStridedImageIterator(pointer base, int ystride, int xskip, int yskip)
: Base(base, xskip, ystride*yskip)
{}
/** Copy-construct from mutable iterator */
ConstStridedImageIterator(StridedImageIterator<PIXELTYPE> const & o)
: Base(o.x, o.y)
{}
/** Default constructor */
ConstStridedImageIterator()
: Base()
{}
/** Assign mutable iterator */
ConstStridedImageIterator & operator=(StridedImageIterator<PIXELTYPE> const & o)
{
Base::x = o.x;
Base::y = o.y;
return *this;
}
};
/********************************************************/
/* */
/* definition of iterator traits */
/* */
/********************************************************/
#ifndef NO_PARTIAL_TEMPLATE_SPECIALIZATION
template <class T>
struct IteratorTraits<ImageIterator<T> >
: public IteratorTraitsBase<ImageIterator<T> >
{
typedef ImageIterator<T> mutable_iterator;
typedef ConstImageIterator<T> const_iterator;
typedef typename AccessorTraits<T>::default_accessor DefaultAccessor;
typedef DefaultAccessor default_accessor;
typedef VigraTrueType hasConstantStrides;
};
template <class T>
struct IteratorTraits<ConstImageIterator<T> >
: public IteratorTraitsBase<ConstImageIterator<T> >
{
typedef ImageIterator<T> mutable_iterator;
typedef ConstImageIterator<T> const_iterator;
typedef typename AccessorTraits<T>::default_const_accessor DefaultAccessor;
typedef DefaultAccessor default_accessor;
typedef VigraTrueType hasConstantStrides;
};
template <class T>
struct IteratorTraits<StridedImageIterator<T> >
: public IteratorTraitsBase<StridedImageIterator<T> >
{
typedef StridedImageIterator<T> mutable_iterator;
typedef ConstStridedImageIterator<T> const_iterator;
typedef typename AccessorTraits<T>::default_accessor DefaultAccessor;
typedef DefaultAccessor default_accessor;
typedef VigraTrueType hasConstantStrides;
};
template <class T>
struct IteratorTraits<ConstStridedImageIterator<T> >
: public IteratorTraitsBase<ConstStridedImageIterator<T> >
{
typedef StridedImageIterator<T> mutable_iterator;
typedef ConstStridedImageIterator<T> const_iterator;
typedef typename AccessorTraits<T>::default_const_accessor DefaultAccessor;
typedef DefaultAccessor default_accessor;
typedef VigraTrueType hasConstantStrides;
};
#else // NO_PARTIAL_TEMPLATE_SPECIALIZATION
#define VIGRA_DEFINE_ITERATORTRAITS(VALUETYPE) \
template <> \
struct IteratorTraits<ImageIterator<VALUETYPE > > \
: public IteratorTraitsBase<ImageIterator<VALUETYPE > > \
{ \
typedef ImageIterator<VALUETYPE> mutable_iterator; \
typedef ConstImageIterator<VALUETYPE> const_iterator; \
typedef typename AccessorTraits<VALUETYPE >::default_accessor DefaultAccessor; \
typedef DefaultAccessor default_accessor; \
typedef VigraTrueType hasConstantStrides; \
}; \
\
template <> \
struct IteratorTraits<ConstImageIterator<VALUETYPE > > \
: public IteratorTraitsBase<ConstImageIterator<VALUETYPE > > \
{ \
typedef ImageIterator<VALUETYPE> mutable_iterator; \
typedef ConstImageIterator<VALUETYPE> const_iterator; \
typedef typename AccessorTraits<VALUETYPE >::default_const_accessor DefaultAccessor; \
typedef DefaultAccessor default_accessor; \
typedef VigraTrueType hasConstantStrides; \
}; \
template <> \
struct IteratorTraits<StridedImageIterator<VALUETYPE > > \
: public IteratorTraitsBase<StridedImageIterator<VALUETYPE > > \
{ \
typedef StridedImageIterator<VALUETYPE> mutable_iterator; \
typedef ConstStridedImageIterator<VALUETYPE> const_iterator; \
typedef typename AccessorTraits<VALUETYPE >::default_accessor DefaultAccessor; \
typedef DefaultAccessor default_accessor; \
typedef VigraTrueType hasConstantStrides; \
}; \
\
template <> \
struct IteratorTraits<ConstStridedImageIterator<VALUETYPE > > \
: public IteratorTraitsBase<ConstStridedImageIterator<VALUETYPE > > \
{ \
typedef StridedImageIterator<VALUETYPE> mutable_iterator; \
typedef ConstStridedImageIterator<VALUETYPE> const_iterator; \
typedef typename AccessorTraits<VALUETYPE >::default_const_accessor DefaultAccessor; \
typedef DefaultAccessor default_accessor; \
typedef VigraTrueType hasConstantStrides; \
};
VIGRA_DEFINE_ITERATORTRAITS(RGBValue<unsigned char>)
VIGRA_DEFINE_ITERATORTRAITS(RGBValue<short>)
VIGRA_DEFINE_ITERATORTRAITS(RGBValue<int>)
VIGRA_DEFINE_ITERATORTRAITS(RGBValue<float>)
VIGRA_DEFINE_ITERATORTRAITS(RGBValue<double>)
#define VIGRA_PIXELTYPE TinyVector<unsigned char, 2>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<unsigned char, 3>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<unsigned char, 4>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<short, 2>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<short, 3>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<short, 4>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<int, 2>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<int, 3>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<int, 4>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<float, 2>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<float, 3>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<float, 4>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<double, 2>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<double, 3>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#define VIGRA_PIXELTYPE TinyVector<double, 4>
VIGRA_DEFINE_ITERATORTRAITS(VIGRA_PIXELTYPE)
#undef VIGRA_PIXELTYPE
#undef VIGRA_DEFINE_ITERATORTRAITS
#endif // NO_PARTIAL_TEMPLATE_SPECIALIZATION
template <class PIXELTYPE>
class ConstValueIteratorPolicy
{
public:
typedef PIXELTYPE value_type;
typedef int difference_type;
typedef PIXELTYPE const & reference;
typedef PIXELTYPE const & index_reference;
typedef PIXELTYPE const * pointer;
typedef std::random_access_iterator_tag iterator_category;
struct BaseType
{
BaseType(PIXELTYPE const & v = PIXELTYPE(), int p = 0)
: value(v), pos(p)
{}
PIXELTYPE value;
int pos;
};
static void initialize(BaseType & d) {}
static reference dereference(BaseType const & d)
{ return d.value; }
static index_reference dereference(BaseType d, difference_type)
{
return d.value;
}
static bool equal(BaseType const & d1, BaseType const & d2)
{ return d1.pos == d2.pos; }
static bool less(BaseType const & d1, BaseType const & d2)
{ return d1.pos < d2.pos; }
static difference_type difference(BaseType const & d1, BaseType const & d2)
{ return d1.pos - d2.pos; }
static void increment(BaseType & d)
{ ++d.pos; }
static void decrement(BaseType & d)
{ --d.pos; }
static void advance(BaseType & d, difference_type n)
{ d.pos += n; }
};
/********************************************************/
/* */
/* ConstValueIterator */
/* */
/********************************************************/
/** \brief Iterator that always returns the constant specified in the
constructor.
This iterator can be used to simulate an image that
does not actually exist.
<b>\#include</b> \<vigra/imageiterator.hxx\>
Namespace: vigra
*/
template <class PIXELTYPE>
class ConstValueIterator
{
public:
/** The type of the constant the iterator holds.
*/
typedef PIXELTYPE value_type;
/** The type of the constant the iterator holds.
*/
typedef PIXELTYPE PixelType;
/** the iterator's reference type (return type of <TT>*iter</TT>)
*/
typedef PIXELTYPE const & reference;
/** the iterator's index reference type (return type of <TT>iter[diff]</TT>)
*/
typedef PIXELTYPE const & index_reference;
/** the iterator's pointer type (return type of <TT>iter.operator->()</TT>)
*/
typedef PIXELTYPE const * pointer;
/** the iterator's difference type (argument type of <TT>iter[diff]</TT>)
*/
typedef Diff2D difference_type;
/** the iterator tag (image traverser)
*/
typedef image_traverser_tag iterator_category;
/** The associated row iterator.
*/
typedef IteratorAdaptor<ConstValueIteratorPolicy<PIXELTYPE> > row_iterator;
/** The associated column iterator.
*/
typedef IteratorAdaptor<ConstValueIteratorPolicy<PIXELTYPE> > column_iterator;
/** Let operations act in X direction
*/
typedef int MoveX;
/** Let operations act in Y direction
*/
typedef int MoveY;
/** Default Constructor. (the constant is set to
<TT>NumericTraits<PIXELTYPE>::zero()</TT> )
*/
ConstValueIterator()
: value_(NumericTraits<PIXELTYPE>::zero()), x(0), y(0)
{}
/** Construct with given constant.
*/
ConstValueIterator(PixelType const & v)
: value_(v), x(0), y(0)
{}
/** Copy Constructor.
*/
ConstValueIterator(ConstValueIterator const & v)
: value_(v.value_), x(v.x), y(v.y)
{}
/** Copy Assigment.
*/
ConstValueIterator & operator=(ConstValueIterator const & v)
{
if(this != &v)
{
value_ = v.value_;
x = v.x;
y = v.y;
}
return *this;
}
/** Move iterator by specified distance.
*/
ConstValueIterator & operator+=(Diff2D const & d)
{
x += d.x;
y += d.y;
return *this;
}
/** Move iterator by specified distance.
*/
ConstValueIterator & operator-=(Diff2D const & d)
{
x -= d.x;
y -= d.y;
return *this;
}
/** Create iterator at specified distance.
*/
ConstValueIterator operator+(Diff2D const & d) const
{
ConstValueIterator ret(*this);
ret += d;
return ret;
}
/** Create iterator at specified distance.
*/
ConstValueIterator operator-(Diff2D const & d) const
{
ConstValueIterator ret(*this);
ret -= d;
return ret;
}
/** Compute distance between two iterators
*/
Diff2D operator-(ConstValueIterator const & r) const
{
return Diff2D(x - r.x, y - r.y);
}
/** Equality.
*/
bool operator==(ConstValueIterator const & r) const
{
return (x == r.x) && (y == r.y);
}
/** Inequality.
*/
bool operator!=(ConstValueIterator const & r) const
{
return (x != r.x) || (y != r.y);
}
/** Read current pixel (return specified constant).
*/
reference operator*() const
{
return value_;
}
/** Call member function for stored constant.
*/
pointer operator->() const
{
return &value_;
}
/** Read pixel at a distance (return specified constant).
*/
index_reference operator()(int const &, int const &) const
{
return value_;
}
/** Read pixel at a distance (return specified constant).
*/
index_reference operator[](Diff2D const &) const
{
return value_;
}
/** Get row iterator at current position (which will also hold the constant).
*/
row_iterator rowIterator() const
{ return row_iterator(typename row_iterator::BaseType(value_, x)); }
/** Get column iterator at current position (which will also hold the constant).
*/
column_iterator columnIterator() const
{ return column_iterator(typename column_iterator::BaseType(value_, y)); }
/** @name Specify coordinate direction for navigation commands */
//@{
/// refer to x coordinate
int x;
/// refer to y coordinate
int y;
//@}
private:
PixelType value_;
};
#ifndef NO_PARTIAL_TEMPLATE_SPECIALIZATION
template <class T>
struct IteratorTraits<ConstValueIterator<T> >
{
typedef ConstValueIterator<T> Iterator;
typedef Iterator iterator;
typedef typename iterator::iterator_category iterator_category;
typedef typename iterator::value_type value_type;
typedef typename iterator::reference reference;
typedef typename iterator::index_reference index_reference;
typedef typename iterator::pointer pointer;
typedef typename iterator::difference_type difference_type;
typedef typename iterator::row_iterator row_iterator;
typedef typename iterator::column_iterator column_iterator;
typedef StandardConstAccessor<T> DefaultAccessor;
typedef StandardConstAccessor<T> default_accessor;
typedef VigraTrueType hasConstantStrides;
};
#endif
/** \brief Simulate an image where each pixel contains its coordinate.
CoordinateIterator used to be a separate class,
but has now become an alias for \ref vigra::Diff2D. This is possible because
Diff2D now provides all the necessary functionality.
CoordinateIterator behaves like a read-only \ref vigra::ImageIterator for
an image in which each pixel contains its coordinate. This is useful for
algorithms that need access to the current pixel's location.
For example, you can use CoordinateIterator/Diff2D to
find the center of mass of an image region. To implement this,
we first need a functor for center-of-mass calculations:
\code
struct CenterOfMassFunctor
{
CenterOfMassFunctor()
: x(0.0), y(0.0), size(0)
{}
void operator()(Diff2d const& diff)
{
++size;
x += diff.x;
y += diff.y;
}
float xCenter() const
{ return x / size; }
float yCenter() const
{ return y / size; }
float x;
float y;
int size;
};
\endcode
Using this functor, we find the center of mass like so:
\code
vigra::BImage img(w,h);
... // mark a region in the image with '1', background with '0'
CenterOfMassFunctor center;
vigra::inspectImageIf(
srcIterRange(Diff2D(), Diff2D() + img.size()),
srcImage(img),
center);
std::cout << "Center of mass: " << center.xCenter() <<
", " << center.yCenter() << std::endl;
\endcode
<b>\#include</b> \<vigra/imageiterator.hxx\>
Namespace: vigra
*/
typedef Diff2D CoordinateIterator;
//@}
} // namespace vigra
#endif // VIGRA_IMAGEITERATOR_HXX
|