PHPCoord\CoordinateOperation\KMSGrid

Complexity

Total Complexity

10

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Test Coverage

Coverage

55.88%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getValues()	0	5	1
B	__construct()	0	66	7
A	getRecord()	0	25	2

<?php
/**
 * PHPCoord.
 *
 * @author Doug Wright
 */
declare(strict_types=1);

namespace PHPCoord\CoordinateOperation;

use Composer\Pcre\Preg;
use PHPCoord\UnitOfMeasure\Length\Metre;
use SplFixedArray;

use function assert;
use function explode;
use function intdiv;
use function trim;

/**
 * @see https://github.com/Kortforsyningen/kmsgrid/blob/master/kmsgrid.py for documentation
 */
class KMSGrid extends GeographicGeoidHeightGrid
{
    use BilinearInterpolation;

    private int $binaryHeaderLength = 64;
    private bool $isBinary;
    private string $integerFormatChar = 'V';
    private string $doubleFormatChar = 'e';
    private string $floatFormatChar = 'g';

    /**
     * @var SplFixedArray<float>
     */
    private SplFixedArray $textData;

    public function __construct(string $filename)
    {
        $this->gridFile = new GridFile($filename);
        $this->storageOrder = self::STORAGE_ORDER_INCREASING_LONGITUDE_DECREASING_LATIITUDE;

        $firstChar = $this->gridFile->fread(1);

        if ($firstChar === ' ') {
            $this->isBinary = false;

            $header = Preg::split('/\s+/', trim($this->gridFile->fgets()));

            $this->startX = (float) $header[2];
            $this->startY = (float) $header[0];
            $this->endX = (float) $header[3];
            $this->endY = (float) $header[1];
            $this->columnGridInterval = (float) $header[5];
            $this->rowGridInterval = (float) $header[4];
            $this->numberOfColumns = (int) (string) (($this->endX - $this->startX) / $this->columnGridInterval) + 1;
            $this->numberOfRows = (int) (string) (($this->endY - $this->startY) / $this->rowGridInterval) + 1;

            $this->textData = new SplFixedArray($this->numberOfColumns * $this->numberOfRows);
            $index = 0;
            while (!$this->gridFile->eof()) {
                $rawData = trim($this->gridFile->fgets());
                if ($rawData) {
                    $values = explode(' ', trim(Preg::replace('/\s+/', ' ', $rawData)));
                    foreach ($values as $value) {
                        $this->textData[$index] = (float) $value;
                        ++$index;
                    }
                }
            }
        } else {
            $this->isBinary = true;

            $this->gridFile->fseek(0);
            $rawHeader = $this->gridFile->fread($this->binaryHeaderLength);
            $icode = $this->unpack("{$this->integerFormatChar}ICODE", $rawHeader)['ICODE'];

            if ($icode !== 777) {
                $this->integerFormatChar = 'N';
                $this->doubleFormatChar = 'E';
                $this->floatFormatChar = 'G';
                $icode = $this->unpack("{$this->integerFormatChar}ICODE", $rawHeader)['ICODE'];
            }

            assert($icode === 777);

            /** @var array{ICODE: int, BMIN: float, BMAX: float, LMIN: float, LMAX: float, DB: float, DL: float, DATUM: int, CSTM: int, MODE: int} $header */
            $header = $this->unpack("{$this->integerFormatChar}ICODE/{$this->doubleFormatChar}BMIN/{$this->doubleFormatChar}BMAX/{$this->doubleFormatChar}LMIN/{$this->doubleFormatChar}LMAX/{$this->doubleFormatChar}DB/{$this->doubleFormatChar}DL/{$this->integerFormatChar}DATUM/{$this->integerFormatChar}CSTM/{$this->integerFormatChar}MODE", $rawHeader);
            $this->startX = $header['LMIN'];
            $this->startY = $header['BMIN'];
            $this->endX = $header['LMAX'];
            $this->endY = $header['BMAX'];
            $this->columnGridInterval = $header['DL'];
            $this->rowGridInterval = $header['DB'];
            $this->numberOfColumns = (int) (string) (($this->endX - $this->startX) / $this->columnGridInterval) + 1;
            $this->numberOfRows = (int) (string) (($this->endY - $this->startY) / $this->rowGridInterval) + 1;

            // there's a weird 16 records per block thing here, columns extend beyond declared boundaries
            $this->numberOfColumns = intdiv($this->numberOfColumns + 16 - 1, 16) * 16;
        }

        if ($this->startX > 180) { // normalise if necessary
            $this->startX -= 360;
        }
    }

    /**
     * @return Metre[]
     */
    public function getValues(float $x, float $y): array
    {
        $shift = $this->interpolate($x, $y)[0];

        return [new Metre($shift)];
    }

    private function getRecord(int $longitudeIndex, int $latitudeIndex): GridValues

The method getRecord() is not used, and could be removed.

    {
        $recordId = ($this->numberOfRows - $latitudeIndex - 1) * $this->numberOfColumns + $longitudeIndex;
        $longitude = $longitudeIndex * $this->columnGridInterval + $this->startX;
        $latitude = $latitudeIndex * $this->rowGridInterval + $this->startY;

        if ($this->isBinary) {
            $offset = $this->binaryHeaderLength + $recordId * 4;
            $this->gridFile->fseek($offset);
            $rawRow = $this->gridFile->fread(4);
            /** @var array{shift: float} $data */
            $data = $this->unpack("{$this->floatFormatChar}shift", $rawRow);

            return new GridValues(
                $longitude,
                $latitude,
                [$data['shift']]
            );
        } else {
            assert($this->textData[$recordId] !== null);

            return new GridValues(
                $longitude,
                $latitude,
                [$this->textData[$recordId]]
            );
        }
    }
}