CAsciiArt::__construct() - Code Metrics - mosbth/cimage - Measure and Improve Code Quality continuously with Scrutinizer

CAsciiArt::__construct() A
last analyzed 2021-05-10 14:03 UTC

↳ Parent: CAsciiArt

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Create an ASCII version of an image.
 *
 */
class CAsciiArt
{
    /**
     * Character set to use.
     */
    private $characterSet = array(
        'one' => "#0XT|:,.' ",
        'two' => "@%#*+=-:. ",
        'three' => "$@B%8&WM#*oahkbdpqwmZO0QLCJUYXzcvunxrjft/\|()1{}[]?-_+~<>i!lI;:,\"^`'. "
    );



    /**
     * Current character set.
     */
    private $characters = null;



    /**
     * Length of current character set.
     */
    private $charCount = null;



    /**
     * Scale of the area to swap to a character.
     */
    private $scale = null;



    /**
     * Strategy to calculate luminance.
     */
    private $luminanceStrategy = null;



    /**
     * Constructor which sets default options.
     */
    public function __construct()
    {
        $this->setOptions();
    }



    /**
     * Add a custom character set.
     *
     * @param string $key   for the character set.
     * @param string $value for the character set.
     *
     * @return $this
     */
    public function addCharacterSet($key, $value)
    {
        $this->characterSet[$key] = $value;
        return $this;
    }



    /**
     * Set options for processing, defaults are available.
     *
     * @param array $options to use as default settings.
     *
     * @return $this
     */
    public function setOptions($options = array())
    {
        $default = array(
            "characterSet" => 'two',
            "scale" => 14,
            "luminanceStrategy" => 3,
            "customCharacterSet" => null,
        );
        $default = array_merge($default, $options);
        
        if (!is_null($default['customCharacterSet'])) {
            $this->addCharacterSet('custom', $default['customCharacterSet']);
            $default['characterSet'] = 'custom';
        }
        
        $this->scale = $default['scale'];
        $this->characters = $this->characterSet[$default['characterSet']];
        $this->charCount = strlen($this->characters);
        $this->luminanceStrategy = $default['luminanceStrategy'];
        
        return $this;
    }



    /**
     * Create an Ascii image from an image file.
     *
     * @param string $filename of the image to use.
     *
     * @return string $ascii with the ASCII image.
     */
    public function createFromFile($filename)
    {
        $img = imagecreatefromstring(file_get_contents($filename));
        list($width, $height) = getimagesize($filename);

        $ascii = null;
        $incY = $this->scale;
        $incX = $this->scale / 2;
        
        for ($y = 0; $y < $height - 1; $y += $incY) {
            for ($x = 0; $x < $width - 1; $x += $incX) {
                $toX = min($x + $this->scale / 2, $width - 1);
                $toY = min($y + $this->scale, $height - 1);
                $luminance = $this->luminanceAreaAverage($img, $x, $y, $toX, $toY);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                $ascii .= $this->luminance2character($luminance);
            }
            $ascii .= PHP_EOL;
        }

        return $ascii;
    }



    /**
     * Get the luminance from a region of an image using average color value.
     *
     * @param string  $img the image.
     * @param integer $x1  the area to get pixels from.
     * @param integer $y1  the area to get pixels from.
     * @param integer $x2  the area to get pixels from.
     * @param integer $y2  the area to get pixels from.
     *
     * @return integer $luminance with a value between 0 and 100.
     */
    public function luminanceAreaAverage($img, $x1, $y1, $x2, $y2)
    {
        $numPixels = ($x2 - $x1 + 1) * ($y2 - $y1 + 1);
        $luminance = 0;
        
        for ($x = $x1; $x <= $x2; $x++) {
            for ($y = $y1; $y <= $y2; $y++) {
                $rgb   = imagecolorat($img, $x, $y);
                $red   = (($rgb >> 16) & 0xFF);
                $green = (($rgb >> 8) & 0xFF);
                $blue  = ($rgb & 0xFF);
                $luminance += $this->getLuminance($red, $green, $blue);
            }
        }
        
        return $luminance / $numPixels;
    }



    /**
     * Calculate luminance value with different strategies.
     *
     * @param integer $red   The color red.
     * @param integer $green The color green.
     * @param integer $blue  The color blue.
     *
     * @return float $luminance with a value between 0 and 1.
     */
    public function getLuminance($red, $green, $blue)
    {
        switch ($this->luminanceStrategy) {
            case 1:
                $luminance = ($red * 0.2126 + $green * 0.7152 + $blue * 0.0722) / 255;
                break;
            case 2:
                $luminance = ($red * 0.299 + $green * 0.587 + $blue * 0.114) / 255;
                break;
            case 3:
                $luminance = sqrt(0.299 * pow($red, 2) + 0.587 * pow($green, 2) + 0.114 * pow($blue, 2)) / 255;
                break;
            case 0:
            default:
                $luminance = ($red + $green + $blue) / (255 * 3);
        }

        return $luminance;
    }



    /**
     * Translate the luminance value to a character.
     *
     * @param string $position a value between 0-100 representing the
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *                         luminance.
     *
     * @return string with the ascii character.
     */
    public function luminance2character($luminance)
    {
        $position = (int) round($luminance * ($this->charCount - 1));
        $char = $this->characters[$position];
        return $char;
    }
}


1			<?php
2			/**
3			* Create an ASCII version of an image.
4			*
5			*/
6			class CAsciiArt
7			{
8			/**
9			* Character set to use.
10			*/
11			private $characterSet = array(
12			'one' => "#0XT\|:,.' ",
13			'two' => "@%#*+=-:. ",
14			'three' => "$@B%8&WM#*oahkbdpqwmZO0QLCJUYXzcvunxrjft/\\|()1{}[]?-_+~<>i!lI;:,\"^`'. "
15			);
16
17
18
19			/**
20			* Current character set.
21			*/
22			private $characters = null;
23
24
25
26			/**
27			* Length of current character set.
28			*/
29			private $charCount = null;
30
31
32
33			/**
34			* Scale of the area to swap to a character.
35			*/
36			private $scale = null;
37
38
39
40			/**
41			* Strategy to calculate luminance.
42			*/
43			private $luminanceStrategy = null;
44
45
46
47			/**
48			* Constructor which sets default options.
49			*/
50			public function __construct()
51			{
52			$this->setOptions();
53			}
54
55
56
57			/**
58			* Add a custom character set.
59			*
60			* @param string $key for the character set.
61			* @param string $value for the character set.
62			*
63			* @return $this
64			*/
65			public function addCharacterSet($key, $value)
66			{
67			$this->characterSet[$key] = $value;
68			return $this;
69			}
70
71
72
73			/**
74			* Set options for processing, defaults are available.
75			*
76			* @param array $options to use as default settings.
77			*
78			* @return $this
79			*/
80			public function setOptions($options = array())
81			{
82			$default = array(
83			"characterSet" => 'two',
84			"scale" => 14,
85			"luminanceStrategy" => 3,
86			"customCharacterSet" => null,
87			);
88			$default = array_merge($default, $options);
89
90			if (!is_null($default['customCharacterSet'])) {
91			$this->addCharacterSet('custom', $default['customCharacterSet']);
92			$default['characterSet'] = 'custom';
93			}
94
95			$this->scale = $default['scale'];
96			$this->characters = $this->characterSet[$default['characterSet']];
97			$this->charCount = strlen($this->characters);
98			$this->luminanceStrategy = $default['luminanceStrategy'];
99
100			return $this;
101			}
102
103
104
105			/**
106			* Create an Ascii image from an image file.
107			*
108			* @param string $filename of the image to use.
109			*
110			* @return string $ascii with the ASCII image.
111			*/
112			public function createFromFile($filename)
113			{
114			$img = imagecreatefromstring(file_get_contents($filename));
115			list($width, $height) = getimagesize($filename);
116
117			$ascii = null;
118			$incY = $this->scale;
119			$incX = $this->scale / 2;
120
121			for ($y = 0; $y < $height - 1; $y += $incY) {
122			for ($x = 0; $x < $width - 1; $x += $incX) {
123			$toX = min($x + $this->scale / 2, $width - 1);
124			$toY = min($y + $this->scale, $height - 1);
125			$luminance = $this->luminanceAreaAverage($img, $x, $y, $toX, $toY);
			0 ignored issues – show Documentation introduced 2015-11-23 13:02 UTC by Report Bug Copy Issue Report `$img` is of type `resource`, but the function expects a `string`. 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...
126			$ascii .= $this->luminance2character($luminance);
127			}
128			$ascii .= PHP_EOL;
129			}
130
131			return $ascii;
132			}
133
134
135
136			/**
137			* Get the luminance from a region of an image using average color value.
138			*
139			* @param string $img the image.
140			* @param integer $x1 the area to get pixels from.
141			* @param integer $y1 the area to get pixels from.
142			* @param integer $x2 the area to get pixels from.
143			* @param integer $y2 the area to get pixels from.
144			*
145			* @return integer $luminance with a value between 0 and 100.
146			*/
147			public function luminanceAreaAverage($img, $x1, $y1, $x2, $y2)
148			{
149			$numPixels = ($x2 - $x1 + 1) * ($y2 - $y1 + 1);
150			$luminance = 0;
151
152			for ($x = $x1; $x <= $x2; $x++) {
153			for ($y = $y1; $y <= $y2; $y++) {
154			$rgb = imagecolorat($img, $x, $y);
155			$red = (($rgb >> 16) & 0xFF);
156			$green = (($rgb >> 8) & 0xFF);
157			$blue = ($rgb & 0xFF);
158			$luminance += $this->getLuminance($red, $green, $blue);
159			}
160			}
161
162			return $luminance / $numPixels;
163			}
164
165
166
167			/**
168			* Calculate luminance value with different strategies.
169			*
170			* @param integer $red The color red.
171			* @param integer $green The color green.
172			* @param integer $blue The color blue.
173			*
174			* @return float $luminance with a value between 0 and 1.
175			*/
176			public function getLuminance($red, $green, $blue)
177			{
178			switch ($this->luminanceStrategy) {
179			case 1:
180			$luminance = ($red * 0.2126 + $green * 0.7152 + $blue * 0.0722) / 255;
181			break;
182			case 2:
183			$luminance = ($red * 0.299 + $green * 0.587 + $blue * 0.114) / 255;
184			break;
185			case 3:
186			$luminance = sqrt(0.299 * pow($red, 2) + 0.587 * pow($green, 2) + 0.114 * pow($blue, 2)) / 255;
187			break;
188			case 0:
189			default:
190			$luminance = ($red + $green + $blue) / (255 * 3);
191			}
192
193			return $luminance;
194			}
195
196
197
198			/**
199			* Translate the luminance value to a character.
200			*
201			* @param string $position a value between 0-100 representing the
			0 ignored issues – show Bug introduced 2015-11-23 13:02 UTC by Report Bug Copy Issue Report There is no parameter named `$position`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
202			* luminance.
203			*
204			* @return string with the ascii character.
205			*/
206			public function luminance2character($luminance)
207			{
208			$position = (int) round($luminance * ($this->charCount - 1));
209			$char = $this->characters[$position];
210			return $char;
211			}
212			}
213

mosbth / cimage

CAsciiArt::__construct() A last analyzed 2021-05-10 14:03 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CAsciiArt::__construct() A
last analyzed 2021-05-10 14:03 UTC