FinderPattern.php 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. <?php
  2. /*
  3. * Copyright 2007 ZXing authors
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. namespace Zxing\Qrcode\Detector;
  18. use Zxing\ResultPoint;
  19. /**
  20. * <p>Encapsulates a finder pattern, which are the three square patterns found in
  21. * the corners of QR Codes. It also encapsulates a count of similar finder patterns,
  22. * as a convenience to the finder's bookkeeping.</p>
  23. *
  24. * @author Sean Owen
  25. */
  26. final class FinderPattern extends ResultPoint
  27. {
  28. public function __construct($posX, $posY, private $estimatedModuleSize, private $count = 1)
  29. {
  30. parent::__construct($posX, $posY);
  31. }
  32. public function getEstimatedModuleSize()
  33. {
  34. return $this->estimatedModuleSize;
  35. }
  36. public function getCount()
  37. {
  38. return $this->count;
  39. }
  40. /*
  41. void incrementCount() {
  42. this.count++;
  43. }
  44. */
  45. /**
  46. * <p>Determines if this finder pattern "about equals" a finder pattern at the stated
  47. * position and size -- meaning, it is at nearly the same center with nearly the same size.</p>
  48. */
  49. public function aboutEquals($moduleSize, $i, $j)
  50. {
  51. if (abs($i - $this->getY()) <= $moduleSize && abs($j - $this->getX()) <= $moduleSize) {
  52. $moduleSizeDiff = abs($moduleSize - $this->estimatedModuleSize);
  53. return $moduleSizeDiff <= 1.0 || $moduleSizeDiff <= $this->estimatedModuleSize;
  54. }
  55. return false;
  56. }
  57. /**
  58. * Combines this object's current estimate of a finder pattern position and module size
  59. * with a new estimate. It returns a new {@code FinderPattern} containing a weighted average
  60. * based on count.
  61. */
  62. public function combineEstimate($i, $j, $newModuleSize): \Zxing\Qrcode\Detector\FinderPattern
  63. {
  64. $combinedCount = $this->count + 1;
  65. $combinedX = ($this->count * $this->getX() + $j) / $combinedCount;
  66. $combinedY = ($this->count * $this->getY() + $i) / $combinedCount;
  67. $combinedModuleSize = ($this->count * $this->estimatedModuleSize + $newModuleSize) / $combinedCount;
  68. return new FinderPattern($combinedX, $combinedY, $combinedModuleSize, $combinedCount);
  69. }
  70. }