Filter out solar flare predictions with invalid coordinates (#19)

* Filter out flare predictions with invalid coordinates

* Filter out flares with invalid coordinates

Author: dgarciabriseno

src/Translator/FlarePrediction.php

@@ -8,6 +8,7 @@
 use HelioviewerEventInterface\Types\HelioviewerEvent;
 use HelioviewerEventInterface\Util\Date;
 use HelioviewerEventInterface\Util\HapiRecord;
+use HelioviewerEventInterface\Util\LocationParser;
 
 const FLARE_CLASSES = ["C", "CPlus", "M", "MPlus", "X"];
 
@@ -68,6 +69,13 @@ public static function Transform(array $events, DateTimeInterface $obstime): arr
         foreach ($events['groups'] as &$group) {
             // $group:
             // array('name', 'contact', 'url', 'data')
+
+            // We have identified that some predictions in CCMC have invalid
+            // coordinates. In this case, we are going to drop these values
+            // from the list.
+            $group['data'] = array_values(array_filter($group['data'], function ($event) {
+                return LocationParser::IsValidLatitudeLongitude(GetLatitude($event['source']), GetLongitude($event['source']));
+            }));
             foreach ($group['data'] as &$event) {
                 // event:
                 // array of HelioviewerEvent fields

src/Util/LocationParser.php

@@ -20,4 +20,11 @@ public static function ParseText(string $location): array {
         $longitude = $east_west == "E" ? -$east_west_value : $east_west_value;
         return [$latitude, $longitude];
     }
-}
+
+    /**
+     * Verifies that the latitude and longitude are valid coordinates
+     */
+    public static function IsValidLatitudeLongitude(float $lat, float $lon): bool {
+        return (-90 <= $lat && $lat <= 90) && (-180 <= $lon && $lon <= 180);
+    }
+}

tests/translators/FlarePredictionTest.php

@@ -1,10 +1,12 @@
 <?php declare(strict_types=1);
 
 use HelioviewerEventInterface\Events;
+use HelioviewerEventInterface\Translator\FlarePrediction;
+use HelioviewerEventInterface\Util\Date;
 use PHPUnit\Framework\TestCase;
 use function HelioviewerEventInterface\Translator\CreateShortLabel;
 use HelioviewerEventInterface\Util\HapiRecord;
-
+use PHPUnit\TextUI\XmlConfiguration\Group;
 
 final class FlarePredictionTest extends TestCase
 {
@@ -171,5 +173,45 @@ public function testShortLabel(): void {
 
         $this->assertEquals("\nC+: 5%\nM+: 1%\nX: 1%", CreateShortLabel($hapi_record));
     }
+
+    static private function MakeEvent(float $lat, float $lon): array {
+        return [
+            'source' => [
+                'NOAALatitude' => $lat,
+                'NOAALongitude' => $lon,
+                'NOAALocationTime' => Date::FormatDate(new DateTimeImmutable()),
+                'issue_time' => new DateTimeImmutable(),
+            ]
+        ];
+    }
+
+    /**
+     * We've found that some CCMC Flare Scoreboard predictions have an invalid
+     * coordinate. The FlarePrediction translator filters these out.
+     * The FlarePrediction module now filters any records where the latitude
+     * and longitude are out of bounds.
+     */
+    #[Group('coordinator')]
+    public function testFlarePredictionInvalidCoordinates(): void {
+        $data = FlarePrediction::Transform([
+            'groups' => [[
+                'data' => [
+                    // Invalid coordinate
+                    self::MakeEvent(106, 130),
+                    // Edge cases out of bounds
+                    self::MakeEvent(90.01, 0),
+                    self::MakeEvent(-90.01, 0),
+                    self::MakeEvent(0, 180.01),
+                    self::MakeEvent(0, -180.01),
+                    // Edge cases in-bound
+                    self::MakeEvent(90, 180),
+                    self::MakeEvent(-90, -180),
+                ]
+            ]]
+        ], new DateTimeImmutable());
+        $this->assertCount(2, $data['groups'][0]['data']);
+        $this->assertArrayHasKey(0, $data['groups'][0]['data']);
+        $this->assertArrayHasKey(1, $data['groups'][0]['data']);
+    }
 }