Documentation

FinderPattern extends ResultPoint
in package

<p>Encapsulates a finder pattern, which are the three square patterns found in the corners of QR Codes. It also encapsulates a count of similar finder patterns, as a convenience to the finder's bookkeeping.</p>

Tags
author

Sean Owen

Table of Contents

$estimatedModuleSize  : float
$x  : float
$y  : float
$count  : int
__construct()  : mixed
aboutEquals()  : bool
<p>Determines if this finder pattern "about equals" a finder pattern at the stated position and size -- meaning, it is at nearly the same center with nearly the same size.</p>
combineEstimate()  : self
Combines this object's current estimate of a finder pattern position and module size with a new estimate. It returns a new {@code FinderPattern} containing a weighted average based on count.
distance()  : float
getCount()  : int
getDistance()  : float
getEstimatedModuleSize()  : float
getSquaredDistance()  : float
Get square of distance between a and b.
getX()  : float
getY()  : float
squaredDistance()  : float

Properties

$estimatedModuleSize

protected float $estimatedModuleSize

Methods

__construct()

public __construct(float $posX, float $posY, float $estimatedModuleSize[, int $count = null ]) : mixed
Parameters
$posX : float
$posY : float
$estimatedModuleSize : float
$count : int = null
Return values
mixed —

aboutEquals()

<p>Determines if this finder pattern "about equals" a finder pattern at the stated position and size -- meaning, it is at nearly the same center with nearly the same size.</p>

public aboutEquals(float $moduleSize, float $i, float $j) : bool
Parameters
$moduleSize : float
$i : float
$j : float
Return values
bool —

combineEstimate()

Combines this object's current estimate of a finder pattern position and module size with a new estimate. It returns a new {@code FinderPattern} containing a weighted average based on count.

public combineEstimate(float $i, float $j, float $newModuleSize) : self
Parameters
$i : float
$j : float
$newModuleSize : float
Return values
self —

distance()

public static distance(float $aX, float $aY, float $bX, float $bY) : float
Parameters
$aX : float
$aY : float
$bX : float
$bY : float
Return values
float —

getEstimatedModuleSize()

public getEstimatedModuleSize() : float
Return values
float —

getX()

public getX() : float
Return values
float —

getY()

public getY() : float
Return values
float —

squaredDistance()

private static squaredDistance(float $aX, float $aY, float $bX, float $bY) : float
Parameters
$aX : float
$aY : float
$bX : float
$bY : float
Return values
float —

Search results