Merge pull request #5 from philipnorton42/image_height

Change getHeight to getPixelHeightFromBottom in the Image class.

Author: philipnorton42

src/Type/Image/Image.php

@@ -213,12 +213,10 @@ public function getActivePixels()
     /**
      * Get the height of the active pixels in the image.
      *
-     * @todo : change the name of this method. it's confusing.
-     *
      * @return int
      *   The height.
      */
-    public function getHeight()
+    public function getPixelHeightFromBottom(): int
     {
         $imageMatrix = $this->getImageMatrix();
         $height = 0;

src/Type/Image/ImageIndividual.php

@@ -69,7 +69,7 @@ public function getName(): string
     public function getSpecies(): string
     {
         // The species of the ImageIndividual is the height of the image.
-        return (string) $this->getObject()->getHeight();
+        return (string) $this->getObject()->getPixelHeightFromBottom();
     }
 
     /**
@@ -120,7 +120,7 @@ public function getFitness($type = ''): float
     {
         switch ($type) {
             case 'height':
-                return $this->getObject()->getHeight();
+                return $this->getObject()->getPixelHeightFromBottom();
             default:
                 return $this->getObject()->getActivePixels();
         }

tests/Type/Image/ImagePopulationTest.php

@@ -89,25 +89,25 @@ public function testSortPopulation()
 
         // Ensure that the keys are still in the same locations.
         $images = $object->getIndividuals();
-        $this->assertEquals(6, $images[0]->getObject()->getHeight());
-        $this->assertEquals(3, $images[1]->getObject()->getHeight());
-        $this->assertEquals(2, $images[2]->getObject()->getHeight());
-        $this->assertEquals(5, $images[3]->getObject()->getHeight());
-        $this->assertEquals(1, $images[4]->getObject()->getHeight());
-        $this->assertEquals(4, $images[5]->getObject()->getHeight());
+        $this->assertEquals(6, $images[0]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(3, $images[1]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(2, $images[2]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(5, $images[3]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(1, $images[4]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(4, $images[5]->getObject()->getPixelHeightFromBottom());
 
         // Transpose the images into a sorted array so we can test sort order.
         $sortedImages = [];
         foreach ($images as $image) {
           $sortedImages[] = $image;
         }
 
-        $this->assertEquals(1, $sortedImages[0]->getObject()->getHeight());
-        $this->assertEquals(2, $sortedImages[1]->getObject()->getHeight());
-        $this->assertEquals(3, $sortedImages[2]->getObject()->getHeight());
-        $this->assertEquals(4, $sortedImages[3]->getObject()->getHeight());
-        $this->assertEquals(5, $sortedImages[4]->getObject()->getHeight());
-        $this->assertEquals(6, $sortedImages[5]->getObject()->getHeight());
+        $this->assertEquals(1, $sortedImages[0]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(2, $sortedImages[1]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(3, $sortedImages[2]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(4, $sortedImages[3]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(5, $sortedImages[4]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(6, $sortedImages[5]->getObject()->getPixelHeightFromBottom());
 
         $object->sort('DESC');
         $images = $object->getIndividuals();
@@ -118,11 +118,11 @@ public function testSortPopulation()
           $sortedImages[] = $image;
         }
 
-        $this->assertEquals(6, $sortedImages[0]->getObject()->getHeight());
-        $this->assertEquals(5, $sortedImages[1]->getObject()->getHeight());
-        $this->assertEquals(4, $sortedImages[2]->getObject()->getHeight());
-        $this->assertEquals(3, $sortedImages[3]->getObject()->getHeight());
-        $this->assertEquals(2, $sortedImages[4]->getObject()->getHeight());
-        $this->assertEquals(1, $sortedImages[5]->getObject()->getHeight());
+        $this->assertEquals(6, $sortedImages[0]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(5, $sortedImages[1]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(4, $sortedImages[2]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(3, $sortedImages[3]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(2, $sortedImages[4]->getObject()->getPixelHeightFromBottom());
+        $this->assertEquals(1, $sortedImages[5]->getObject()->getPixelHeightFromBottom());
     }
 }

tests/Type/Image/ImageTest.php

@@ -211,7 +211,7 @@ public function testGetHeightSimple()
         $image->setPixel(3, 2, 1);
         $image->setPixel(4, 2, 1);
 
-        $this->assertEquals(2, $image->getHeight());
+        $this->assertEquals(2, $image->getPixelHeightFromBottom());
     }
 
     public function testGetHeightComplex()
@@ -241,6 +241,6 @@ public function testGetHeightComplex()
         $image->setPixel(7, 9, 1);
         $image->setPixel(5, 0, 1);
 
-        $this->assertEquals(6, $image->getHeight());
+        $this->assertEquals(6, $image->getPixelHeightFromBottom());
     }
 }