CropEntropy::debugOn() - Code Metrics - Inspection of "Adding entropy midpoint detection" - stojg/crop - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.0 ( 312d76...be5b54 )

by Stig

created 2016-03-13 08:01 UTC

CropEntropy::debugOn() A

↳ Parent: CropEntropy

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Stojg\Crop;

use Imagick;
use ImagickPixel;
use InvalidArgumentException;

/**
 * Class CropEntropy
 *
 * This class will help on finding the most energetic part of an image.
 *
 * @package Stojg\Crop
 */
class CropEntropy
{
    /**
     * @var Imagick
     */
    protected $image = null;

    /**
     * @var bool
     */
    protected $debug;

    /**
     * CropEntropy constructor
     *
     * @param Imagick|null $image
     */
    public function __construct(Imagick $image = null)
    {
        if ($image !== null) {
            $this->image = $image;
        } else {
            $this->image = new Imagick();
        }
    }

    public function debugOn()
    {
        $this->debug = true;
    }

    public function debugOff()
    {
        $this->debug = false;
    }

    /**
     * @return Imagick
     */
    public function getImage()
    {
        return $this->image;
    }

    /**
     * @param int $width - The width of the region to be extracted
     * @param int $height - The height of the region to be extracted
     * @param int $x - X-coordinate of the top-left corner of the region to be extracted
     * @param int $y -Y-coordinate of the top-left corner of the region to be extracted
     * @return CropEntropy
     */
    public function getRegion($width, $height, $x, $y)
    {
        return new CropEntropy($this->image->getImageRegion($width, $height, $x, $y));
    }

    /**
     * Get the area in pixels for this image
     *
     * @return int
     */
    public function area()
    {
        $size = $this->image->getImageGeometry();
        return $size['height'] * $size['width'];
    }

    /**
     * @param CropEntropy $b
     * @return int
     */
    public function compare(CropEntropy $b)
    {
        $aValue = $this->getGrayScaleEntropy();
        $bValue = $b->getGrayScaleEntropy();


        if ($aValue == $bValue) {
            return 0;
        }

        return ($aValue < $bValue) ? -1 : 1;
    }

    /**
     * Calculate the entropy for this image.
     *
     * A higher value of entropy means more noise / liveliness / color / business
     *
     * @return float
     *
     * @see http://brainacle.com/calculating-image-entropy-with-python-how-and-why.html
     * @see http://www.mathworks.com/help/toolbox/images/ref/entropy.html
     */
    public function getGrayScaleEntropy()
    {
        $histogram = $this->image->getImageHistogram();
        return $this->getEntropy($histogram, $this->area());
    }

    /**
     *
     * @param string $axis - must be either 'x' or 'y'
     * @param $sliceSize
     * @return int
     */
    public function getMidPoint($axis, $sliceSize)
    {
        $currentPos = 0;

        if (!in_array($axis, ['x', 'y'])) {
            throw new InvalidArgumentException('argument $axis must be either "x" or "y"');
        }

        $image = new CropEntropy(clone($this->image));
        $image->getImage()->modulateImage(100, 0, 100);
        $image->getImage()->edgeImage(1);
        $image->getImage()->blackThresholdImage("#303030");

        $size = $this->image->getImageGeometry();


        if ($axis === 'x') {
            $max = $size['width'];
        } else {
            $max = $size['height'];
        }

        $sliceIndex = [];

        // until we have a slice that would fit inside the target size
        $left = $max;
        while ($left > 0) {
            $sliceSize = min($sliceSize, $left);
            if ($axis === 'x') {
                $a = $image->getVerticalSlice($currentPos, $sliceSize);
            } else {
                $a = $image->getHorizontalSlice($currentPos, $sliceSize);
            }
            $value = $a->getGrayScaleEntropy();
            $sliceIndex[] = $value;

            if ($this->debug) {
                $this->printDebug($axis, $sliceSize, $value, $currentPos, $size);
            }
            $currentPos += $sliceSize;
            $left -= $sliceSize;
        }
        $max = array_keys($sliceIndex, max($sliceIndex));
        return $sliceSize * $max[0] + $sliceSize / 2;
    }

    /**
     *
     * @param  ImagickPixel[] $histogram
     * @param  int $area
     * @return float
     */
    protected function getEntropy($histogram, $area)
    {
        $value = 0.0;
        foreach ($histogram as $pixel) {
            // calculates the percentage of pixels having this color value
            $p = $pixel->getColorCount() / $area;
            // A common way of representing entropy in scalar
            $value += $p * log($p, 2);
        }
        // $value is always 0.0 or negative, so transform into positive scalar value
        return -$value;
    }

    /**
     * @param int $x
     * @param int $sliceSize
     * @return CropEntropy
     */
    public function getVerticalSlice($x, $sliceSize)
    {
        $size = $this->image->getImageGeometry();
        return $this->getRegion($sliceSize, $size['height'], $x, 0);
    }

    /**
     * @param int $y
     * @param int $sliceSize
     * @return CropEntropy
     */
    public function getHorizontalSlice($y, $sliceSize)
    {
        $size = $this->image->getImageGeometry();
        return $this->getRegion($size['width'], $sliceSize, 0, $y);
    }

    /**
     * @param int $x1
     * @param int $y1
     * @param int $x2
     * @param int $y2
     * @param strint $fillColor
     */
    public function rectDraw($x1, $y1, $x2, $y2, $fillColor)
    {
        $draw = new \ImagickDraw();
        $draw->setStrokeWidth(1);
        $draw->setStrokeColor(new \ImagickPixel('rgba(0%, 0%, 0%, 0.5)'));
        $draw->setFillColor(new \ImagickPixel($fillColor));
        $draw->rectangle($x1, $y1, $x2, $y2);
        $this->image->drawImage($draw);
    }

    /**
     * @param int $x
     * @param int $y
     * @param string $text
     * @param int $angle - 0 to 350
     */
    public function drawText($x, $y, $text, $angle)
    {
        $draw = new \ImagickDraw();
        $draw->setFont('fonts/Hack-Regular.ttf');
        $draw->setFontSize(10);
        $this->image->annotateImage($draw, $x, $y, $angle, $text);
    }

    /**
     * @param string $axis
     * @param int $sliceSize
     * @param float $value
     * @param int $currentPos
     * @param array $size
     */
    protected function printDebug($axis, $sliceSize, $value, $currentPos, $size)
    {
        $text = sprintf('%05.5f', $value);
        if ($axis === 'x') {
            $this->rectDraw($currentPos, 0, $currentPos + $sliceSize, $size['height'],
                'rgba(100%, 0%, 0%, 0.1)');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->drawText($currentPos + 5, $size['height'] - 5, $text, 0);
        } else {
            $this->rectDraw(0, $currentPos, $size['width'], $currentPos + $sliceSize,
                'rgba(100%, 0%, 0%, 0.1)');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->drawText(5, $currentPos + 15, $text, 0);
        }
    }
}


1			<?php
2
3			namespace Stojg\Crop;
4
5			use Imagick;
6			use ImagickPixel;
7			use InvalidArgumentException;
8
9			/**
10			* Class CropEntropy
11			*
12			* This class will help on finding the most energetic part of an image.
13			*
14			* @package Stojg\Crop
15			*/
16			class CropEntropy
17			{
18			/**
19			* @var Imagick
20			*/
21			protected $image = null;
22
23			/**
24			* @var bool
25			*/
26			protected $debug;
27
28			/**
29			* CropEntropy constructor
30			*
31			* @param Imagick\|null $image
32			*/
33			public function __construct(Imagick $image = null)
34			{
35			if ($image !== null) {
36			$this->image = $image;
37			} else {
38			$this->image = new Imagick();
39			}
40			}
41
42			public function debugOn()
43			{
44			$this->debug = true;
45			}
46
47			public function debugOff()
48			{
49			$this->debug = false;
50			}
51
52			/**
53			* @return Imagick
54			*/
55			public function getImage()
56			{
57			return $this->image;
58			}
59
60			/**
61			* @param int $width - The width of the region to be extracted
62			* @param int $height - The height of the region to be extracted
63			* @param int $x - X-coordinate of the top-left corner of the region to be extracted
64			* @param int $y -Y-coordinate of the top-left corner of the region to be extracted
65			* @return CropEntropy
66			*/
67			public function getRegion($width, $height, $x, $y)
68			{
69			return new CropEntropy($this->image->getImageRegion($width, $height, $x, $y));
70			}
71
72			/**
73			* Get the area in pixels for this image
74			*
75			* @return int
76			*/
77			public function area()
78			{
79			$size = $this->image->getImageGeometry();
80			return $size['height'] * $size['width'];
81			}
82
83			/**
84			* @param CropEntropy $b
85			* @return int
86			*/
87			public function compare(CropEntropy $b)
88			{
89			$aValue = $this->getGrayScaleEntropy();
90			$bValue = $b->getGrayScaleEntropy();
91
92
93			if ($aValue == $bValue) {
94			return 0;
95			}
96
97			return ($aValue < $bValue) ? -1 : 1;
98			}
99
100			/**
101			* Calculate the entropy for this image.
102			*
103			* A higher value of entropy means more noise / liveliness / color / business
104			*
105			* @return float
106			*
107			* @see http://brainacle.com/calculating-image-entropy-with-python-how-and-why.html
108			* @see http://www.mathworks.com/help/toolbox/images/ref/entropy.html
109			*/
110			public function getGrayScaleEntropy()
111			{
112			$histogram = $this->image->getImageHistogram();
113			return $this->getEntropy($histogram, $this->area());
114			}
115
116			/**
117			*
118			* @param string $axis - must be either 'x' or 'y'
119			* @param $sliceSize
120			* @return int
121			*/
122			public function getMidPoint($axis, $sliceSize)
123			{
124			$currentPos = 0;
125
126			if (!in_array($axis, ['x', 'y'])) {
127			throw new InvalidArgumentException('argument $axis must be either "x" or "y"');
128			}
129
130			$image = new CropEntropy(clone($this->image));
131			$image->getImage()->modulateImage(100, 0, 100);
132			$image->getImage()->edgeImage(1);
133			$image->getImage()->blackThresholdImage("#303030");
134
135			$size = $this->image->getImageGeometry();
136
137
138			if ($axis === 'x') {
139			$max = $size['width'];
140			} else {
141			$max = $size['height'];
142			}
143
144			$sliceIndex = [];
145
146			// until we have a slice that would fit inside the target size
147			$left = $max;
148			while ($left > 0) {
149			$sliceSize = min($sliceSize, $left);
150			if ($axis === 'x') {
151			$a = $image->getVerticalSlice($currentPos, $sliceSize);
152			} else {
153			$a = $image->getHorizontalSlice($currentPos, $sliceSize);
154			}
155			$value = $a->getGrayScaleEntropy();
156			$sliceIndex[] = $value;
157
158			if ($this->debug) {
159			$this->printDebug($axis, $sliceSize, $value, $currentPos, $size);
160			}
161			$currentPos += $sliceSize;
162			$left -= $sliceSize;
163			}
164			$max = array_keys($sliceIndex, max($sliceIndex));
165			return $sliceSize * $max[0] + $sliceSize / 2;
166			}
167
168			/**
169			*
170			* @param ImagickPixel[] $histogram
171			* @param int $area
172			* @return float
173			*/
174			protected function getEntropy($histogram, $area)
175			{
176			$value = 0.0;
177			foreach ($histogram as $pixel) {
178			// calculates the percentage of pixels having this color value
179			$p = $pixel->getColorCount() / $area;
180			// A common way of representing entropy in scalar
181			$value += $p * log($p, 2);
182			}
183			// $value is always 0.0 or negative, so transform into positive scalar value
184			return -$value;
185			}
186
187			/**
188			* @param int $x
189			* @param int $sliceSize
190			* @return CropEntropy
191			*/
192			public function getVerticalSlice($x, $sliceSize)
193			{
194			$size = $this->image->getImageGeometry();
195			return $this->getRegion($sliceSize, $size['height'], $x, 0);
196			}
197
198			/**
199			* @param int $y
200			* @param int $sliceSize
201			* @return CropEntropy
202			*/
203			public function getHorizontalSlice($y, $sliceSize)
204			{
205			$size = $this->image->getImageGeometry();
206			return $this->getRegion($size['width'], $sliceSize, 0, $y);
207			}
208
209			/**
210			* @param int $x1
211			* @param int $y1
212			* @param int $x2
213			* @param int $y2
214			* @param strint $fillColor
215			*/
216			public function rectDraw($x1, $y1, $x2, $y2, $fillColor)
217			{
218			$draw = new \ImagickDraw();
219			$draw->setStrokeWidth(1);
220			$draw->setStrokeColor(new \ImagickPixel('rgba(0%, 0%, 0%, 0.5)'));
221			$draw->setFillColor(new \ImagickPixel($fillColor));
222			$draw->rectangle($x1, $y1, $x2, $y2);
223			$this->image->drawImage($draw);
224			}
225
226			/**
227			* @param int $x
228			* @param int $y
229			* @param string $text
230			* @param int $angle - 0 to 350
231			*/
232			public function drawText($x, $y, $text, $angle)
233			{
234			$draw = new \ImagickDraw();
235			$draw->setFont('fonts/Hack-Regular.ttf');
236			$draw->setFontSize(10);
237			$this->image->annotateImage($draw, $x, $y, $angle, $text);
238			}
239
240			/**
241			* @param string $axis
242			* @param int $sliceSize
243			* @param float $value
244			* @param int $currentPos
245			* @param array $size
246			*/
247			protected function printDebug($axis, $sliceSize, $value, $currentPos, $size)
248			{
249			$text = sprintf('%05.5f', $value);
250			if ($axis === 'x') {
251			$this->rectDraw($currentPos, 0, $currentPos + $sliceSize, $size['height'],
252			'rgba(100%, 0%, 0%, 0.1)');
			0 ignored issues – show Documentation introduced 2016-03-13 08:02 UTC by Report Bug Copy Issue Report `'rgba(100%, 0%, 0%, 0.1)'` is of type `string`, but the function expects a `object<Stojg\Crop\strint>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
253			$this->drawText($currentPos + 5, $size['height'] - 5, $text, 0);
254			} else {
255			$this->rectDraw(0, $currentPos, $size['width'], $currentPos + $sliceSize,
256			'rgba(100%, 0%, 0%, 0.1)');
			0 ignored issues – show Documentation introduced 2016-03-13 08:02 UTC by Report Bug Copy Issue Report `'rgba(100%, 0%, 0%, 0.1)'` is of type `string`, but the function expects a `object<Stojg\Crop\strint>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
257			$this->drawText(5, $currentPos + 15, $text, 0);
258			}
259			}
260			}
261

stojg / crop

Push — 2.0 ( 312d76...be5b54 )

CropEntropy::debugOn() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like