14023130831

Committed 23 Mar 2025 09:23PM UTC coverage: 70.463% (+0.01%) from 70.452%

Build # 14023130831

Build Type

Pull #12013

github

Committed by

web-flow

Commit Message

Merge ba7475e98 into 8eb234d4d

Pull Request Pull Request #12013: Add gdal raster select/astype/scale/unscale

Run Details

210 of 214 new or added lines in 12 files covered. (98.13%)

69 existing lines in 34 files now uncovered.

554668 of 787176 relevant lines covered (70.46%)

222369.68 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

80.66

/frmts/xyz/xyzdataset.cpp

/******************************************************************************
 *
 * Project:  XYZ driver
 * Purpose:  GDALDataset driver for XYZ dataset.
 * Author:   Even Rouault, <even dot rouault at spatialys.com>
 *
 ******************************************************************************
 * Copyright (c) 2010-2013, Even Rouault <even dot rouault at spatialys.com>
 *
 * SPDX-License-Identifier: MIT
 ****************************************************************************/

#include "cpl_string.h"
#include "cpl_vsi_virtual.h"
#include "gdal_frmts.h"
#include "gdal_pam.h"

#include <algorithm>
#include <cmath>
#include <mutex>
#include <vector>

constexpr double RELATIVE_ERROR = 1e-3;

class XYZDataset;

// Global cache when we must ingest all grid points
static std::mutex gMutex;
static XYZDataset *gpoActiveDS = nullptr;
static std::vector<short> gasValues;
static std::vector<float> gafValues;

/************************************************************************/
/* ==================================================================== */
/*                              XYZDataset                              */
/* ==================================================================== */
/************************************************************************/

class XYZRasterBand;

class XYZDataset final : public GDALPamDataset
{
    friend class XYZRasterBand;

    VSILFILE *fp;
    int bHasHeaderLine;
    int nCommentLineCount;
    char chDecimalSep;
    int nXIndex;
    int nYIndex;
    int nZIndex;
    int nMinTokens;
    GIntBig nLineNum;     /* any line */
    GIntBig nDataLineNum; /* line with values (header line and empty lines
                             ignored) */
    double adfGeoTransform[6];
    int bSameNumberOfValuesPerLine;
    double dfMinZ;
    double dfMaxZ;
    bool bEOF;
    bool bIngestAll = false;

    static int IdentifyEx(GDALOpenInfo *, int &, int &nCommentLineCount,
                          int &nXIndex, int &nYIndex, int &nZIndex);

  public:
    XYZDataset();
    virtual ~XYZDataset();

    virtual CPLErr GetGeoTransform(double *) override;

    static GDALDataset *Open(GDALOpenInfo *);
    static int Identify(GDALOpenInfo *);
    static GDALDataset *CreateCopy(const char *pszFilename,
                                   GDALDataset *poSrcDS, int bStrict,
                                   char **papszOptions,
                                   GDALProgressFunc pfnProgress,
                                   void *pProgressData);
};

/************************************************************************/
/* ==================================================================== */
/*                            XYZRasterBand                             */
/* ==================================================================== */
/************************************************************************/

class XYZRasterBand final : public GDALPamRasterBand
{
    friend class XYZDataset;

    int nLastYOff;

  public:
    XYZRasterBand(XYZDataset *, int, GDALDataType);

    virtual CPLErr IReadBlock(int, int, void *) override;
    virtual double GetMinimum(int *pbSuccess = nullptr) override;
    virtual double GetMaximum(int *pbSuccess = nullptr) override;
    virtual double GetNoDataValue(int *pbSuccess = nullptr) override;
};

/************************************************************************/
/*                           XYZRasterBand()                            */
/************************************************************************/

XYZRasterBand::XYZRasterBand(XYZDataset *poDSIn, int nBandIn, GDALDataType eDT)
    : nLastYOff(-1)
{
    poDS = poDSIn;
    nBand = nBandIn;

    eDataType = eDT;

    nBlockXSize = poDSIn->GetRasterXSize();
    nBlockYSize = 1;
}

/************************************************************************/
/*                             IReadBlock()                             */
/************************************************************************/

CPLErr XYZRasterBand::IReadBlock(CPL_UNUSED int nBlockXOff, int nBlockYOff,
                                 void *pImage)
{
    XYZDataset *poGDS = reinterpret_cast<XYZDataset *>(poDS);

    if (poGDS->fp == nullptr)
        return CE_Failure;

    if (poGDS->bIngestAll)
    {
        CPLAssert(eDataType == GDT_Int16 || eDataType == GDT_Float32);

        std::lock_guard<std::mutex> guard(gMutex);

        if (gpoActiveDS != poGDS || (gasValues.empty() && gafValues.empty()))
        {
            gpoActiveDS = poGDS;

            const int nGridSize = nRasterXSize * nRasterYSize;
            try
            {
                if (eDataType == GDT_Int16)
                    gasValues.resize(nGridSize);
                else
                    gafValues.resize(nGridSize);
            }
            catch (const std::exception &)
            {
                CPLError(CE_Failure, CPLE_OutOfMemory, "Cannot allocate grid");
                return CE_Failure;
            }

            poGDS->nDataLineNum = 0;
            poGDS->nLineNum = 0;
            poGDS->bEOF = false;
            VSIFSeekL(poGDS->fp, 0, SEEK_SET);

            for (int i = 0; i < poGDS->nCommentLineCount; i++)
            {
                if (CPLReadLine2L(poGDS->fp, 100, nullptr) == nullptr)
                {
                    poGDS->bEOF = true;
                    return CE_Failure;
                }
                poGDS->nLineNum++;
            }

            if (poGDS->bHasHeaderLine)
            {
                const char *pszLine = CPLReadLine2L(poGDS->fp, 100, nullptr);
                if (pszLine == nullptr)
                {
                    poGDS->bEOF = true;
                    return CE_Failure;
                }
                poGDS->nLineNum++;
            }

            for (int i = 0; i < nGridSize; i++)
            {
                const char *pszLine = CPLReadLine2L(poGDS->fp, 100, nullptr);
                if (pszLine == nullptr)
                {
                    poGDS->bEOF = true;
                    CPLError(CE_Failure, CPLE_AppDefined,
                             "Cannot read line " CPL_FRMT_GIB,
                             poGDS->nLineNum + 1);
                    return CE_Failure;
                }
                poGDS->nLineNum++;

                const char *pszPtr = pszLine;
                char ch;
                int nCol = 0;
                bool bLastWasSep = true;
                double dfX = 0.0;
                double dfY = 0.0;
                double dfZ = 0.0;
                int nUsefulColsFound = 0;
                while ((ch = *pszPtr) != '\0')
                {
                    if (ch == ' ')
                    {
                        if (!bLastWasSep)
                            nCol++;
                        bLastWasSep = true;
                    }
                    else if ((ch == ',' && poGDS->chDecimalSep != ',') ||
                             ch == '\t' || ch == ';')
                    {
                        nCol++;
                        bLastWasSep = true;
                    }
                    else
                    {
                        if (bLastWasSep)
                        {
                            if (nCol == poGDS->nXIndex)
                            {
                                nUsefulColsFound++;
                                dfX = CPLAtofDelim(pszPtr, poGDS->chDecimalSep);
                            }
                            else if (nCol == poGDS->nYIndex)
                            {
                                nUsefulColsFound++;
                                dfY = CPLAtofDelim(pszPtr, poGDS->chDecimalSep);
                            }
                            else if (nCol == poGDS->nZIndex)
                            {
                                nUsefulColsFound++;
                                dfZ = CPLAtofDelim(pszPtr, poGDS->chDecimalSep);
                            }
                        }
                        bLastWasSep = false;
                    }
                    pszPtr++;
                }

                /* Skip empty line */
                if (nCol == 0 && bLastWasSep)
                    continue;

                if (nUsefulColsFound != 3)
                {
                    CPLError(
                        CE_Failure, CPLE_AppDefined,
                        "Unexpected number of values at line " CPL_FRMT_GIB,
                        poGDS->nLineNum);
                    return CE_Failure;
                }

                poGDS->nDataLineNum++;

                const int nX =
                    static_cast<int>((dfX - 0.5 * poGDS->adfGeoTransform[1] -
                                      poGDS->adfGeoTransform[0]) /
                                         poGDS->adfGeoTransform[1] +
                                     0.5);
                const int nY =
                    static_cast<int>((dfY - 0.5 * poGDS->adfGeoTransform[5] -
                                      poGDS->adfGeoTransform[3]) /
                                         poGDS->adfGeoTransform[5] +
                                     0.5);
                if (nX < 0 || nX >= nRasterXSize)
                {
                    CPLError(CE_Failure, CPLE_AppDefined,
                             "Unexpected X value at line " CPL_FRMT_GIB,
                             poGDS->nLineNum);
                    return CE_Failure;
                }
                if (nY < 0 || nY >= nRasterYSize)
                {
                    CPLError(CE_Failure, CPLE_AppDefined,
                             "Unexpected Y value at line " CPL_FRMT_GIB,
                             poGDS->nLineNum);
                    return CE_Failure;
                }
                const int nIdx = nX + nY * nRasterXSize;
                if (eDataType == GDT_Int16)
                    gasValues[nIdx] = static_cast<short>(0.5 + dfZ);
                else
                    gafValues[nIdx] = static_cast<float>(dfZ);
            }
        }

        if (eDataType == GDT_Int16)
            memcpy(pImage,
                   &gasValues[static_cast<size_t>(nBlockYOff) * nBlockXSize],
                   sizeof(short) * nBlockXSize);
        else
            memcpy(pImage,
                   &gafValues[static_cast<size_t>(nBlockYOff) * nBlockXSize],
                   sizeof(float) * nBlockXSize);
        return CE_None;
    }

    if (pImage)
    {
        int bSuccess = FALSE;
        double dfNoDataValue = GetNoDataValue(&bSuccess);
        if (!bSuccess)
            dfNoDataValue = 0.0;
        GDALCopyWords(&dfNoDataValue, GDT_Float64, 0, pImage, eDataType,
                      GDALGetDataTypeSize(eDataType) / 8, nRasterXSize);
    }

    // Only valid if bSameNumberOfValuesPerLine.
    const GIntBig nLineInFile = static_cast<GIntBig>(nBlockYOff) * nBlockXSize;
    if ((poGDS->bSameNumberOfValuesPerLine &&
         poGDS->nDataLineNum > nLineInFile) ||
        (!poGDS->bSameNumberOfValuesPerLine &&
         (nLastYOff == -1 || nBlockYOff == 0)))
    {
        poGDS->nDataLineNum = 0;
        poGDS->nLineNum = 0;
        poGDS->bEOF = false;
        VSIFSeekL(poGDS->fp, 0, SEEK_SET);

        for (int i = 0; i < poGDS->nCommentLineCount; i++)
        {
            if (CPLReadLine2L(poGDS->fp, 100, nullptr) == nullptr)
            {
                poGDS->bEOF = true;
                return CE_Failure;
            }
            poGDS->nLineNum++;
        }

        if (poGDS->bHasHeaderLine)
        {
            const char *pszLine = CPLReadLine2L(poGDS->fp, 100, nullptr);
            if (pszLine == nullptr)
            {
                poGDS->bEOF = true;
                return CE_Failure;
            }
            poGDS->nLineNum++;
        }
    }

    if (!poGDS->bSameNumberOfValuesPerLine)
    {
        if (nBlockYOff < nLastYOff)
        {
            nLastYOff = -1;
            for (int iY = 0; iY < nBlockYOff; iY++)
            {
                if (IReadBlock(0, iY, nullptr) != CE_None)
                    return CE_Failure;
            }
        }
        else
        {
            if (poGDS->bEOF)
            {
                return CE_Failure;
            }
            for (int iY = nLastYOff + 1; iY < nBlockYOff; iY++)
            {
                if (IReadBlock(0, iY, nullptr) != CE_None)
                    return CE_Failure;
            }
        }
    }
    else
    {
        if (poGDS->bEOF)
        {
            return CE_Failure;
        }
        while (poGDS->nDataLineNum < nLineInFile)
        {
            const char *pszLine = CPLReadLine2L(poGDS->fp, 100, nullptr);
            if (pszLine == nullptr)
            {
                poGDS->bEOF = true;
                return CE_Failure;
            }
            poGDS->nLineNum++;

            const char *pszPtr = pszLine;
            char ch;
            int nCol = 0;
            bool bLastWasSep = true;
            while ((ch = *pszPtr) != '\0')
            {
                if (ch == ' ')
                {
                    if (!bLastWasSep)
                        nCol++;
                    bLastWasSep = true;
                }
                else if ((ch == ',' && poGDS->chDecimalSep != ',') ||
                         ch == '\t' || ch == ';')
                {
                    nCol++;
                    bLastWasSep = true;
                }
                else
                {
                    bLastWasSep = false;
                }
                pszPtr++;
            }

            /* Skip empty line */
            if (nCol == 0 && bLastWasSep)
                continue;

            poGDS->nDataLineNum++;
        }
    }

    const double dfExpectedY = poGDS->adfGeoTransform[3] +
                               (0.5 + nBlockYOff) * poGDS->adfGeoTransform[5];

    int idx = -1;
    while (true)
    {
        int nCol;
        bool bLastWasSep;
        do
        {
            const vsi_l_offset nOffsetBefore = VSIFTellL(poGDS->fp);
            const char *pszLine = CPLReadLine2L(poGDS->fp, 100, nullptr);
            if (pszLine == nullptr)
            {
                poGDS->bEOF = true;
                if (poGDS->bSameNumberOfValuesPerLine)
                {
                    CPLError(CE_Failure, CPLE_AppDefined,
                             "Cannot read line " CPL_FRMT_GIB,
                             poGDS->nLineNum + 1);
                    return CE_Failure;
                }
                else
                {
                    nLastYOff = nBlockYOff;
                }
                return CE_None;
            }
            poGDS->nLineNum++;

            const char *pszPtr = pszLine;
            char ch;
            nCol = 0;
            bLastWasSep = true;
            double dfX = 0.0;
            double dfY = 0.0;
            double dfZ = 0.0;
            int nUsefulColsFound = 0;
            while ((ch = *pszPtr) != '\0')
            {
                if (ch == ' ')
                {
                    if (!bLastWasSep)
                        nCol++;
                    bLastWasSep = true;
                }
                else if ((ch == ',' && poGDS->chDecimalSep != ',') ||
                         ch == '\t' || ch == ';')
                {
                    nCol++;
                    bLastWasSep = true;
                }
                else
                {
                    if (bLastWasSep)
                    {
                        if (nCol == poGDS->nXIndex)
                        {
                            nUsefulColsFound++;
                            if (!poGDS->bSameNumberOfValuesPerLine)
                                dfX = CPLAtofDelim(pszPtr, poGDS->chDecimalSep);
                        }
                        else if (nCol == poGDS->nYIndex)
                        {
                            nUsefulColsFound++;
                            if (!poGDS->bSameNumberOfValuesPerLine)
                                dfY = CPLAtofDelim(pszPtr, poGDS->chDecimalSep);
                        }
                        else if (nCol == poGDS->nZIndex)
                        {
                            nUsefulColsFound++;
                            dfZ = CPLAtofDelim(pszPtr, poGDS->chDecimalSep);
                        }
                    }
                    bLastWasSep = false;
                }
                pszPtr++;
            }
            nCol++;

            if (nUsefulColsFound == 3)
            {
                if (poGDS->bSameNumberOfValuesPerLine)
                {
                    idx++;
                }
                else
                {
                    if (fabs((dfY - dfExpectedY) / poGDS->adfGeoTransform[5]) >
                        RELATIVE_ERROR)
                    {
                        if (idx < 0)
                        {
                            const double dfYDeltaOrigin =
                                dfY + 0.5 * poGDS->adfGeoTransform[5] -
                                poGDS->adfGeoTransform[3];
                            if (!(fabs(dfYDeltaOrigin) >
                                      fabs(poGDS->adfGeoTransform[5]) &&
                                  fabs(std::round(dfYDeltaOrigin /
                                                  poGDS->adfGeoTransform[5]) -
                                       (dfYDeltaOrigin /
                                        poGDS->adfGeoTransform[5])) <=
                                      RELATIVE_ERROR))
                            {
                                CPLError(CE_Failure, CPLE_AppDefined,
                                         "At line " CPL_FRMT_GIB
                                         ", found Y=%f instead of %f "
                                         "for nBlockYOff = %d",
                                         poGDS->nLineNum, dfY, dfExpectedY,
                                         nBlockYOff);
                                return CE_Failure;
                            }
                        }
                        VSIFSeekL(poGDS->fp, nOffsetBefore, SEEK_SET);
                        nLastYOff = nBlockYOff;
                        poGDS->nLineNum--;
                        return CE_None;
                    }

                    idx = static_cast<int>((dfX -
                                            0.5 * poGDS->adfGeoTransform[1] -
                                            poGDS->adfGeoTransform[0]) /
                                               poGDS->adfGeoTransform[1] +
                                           0.5);
                }
                CPLAssert(idx >= 0 && idx < nRasterXSize);

                if (pImage)
                {
                    if (eDataType == GDT_Float32)
                    {
                        reinterpret_cast<float *>(pImage)[idx] =
                            static_cast<float>(dfZ);
                    }
                    else if (eDataType == GDT_Int32)
                    {
                        reinterpret_cast<GInt32 *>(pImage)[idx] =
                            static_cast<GInt32>(dfZ);
                    }
                    else if (eDataType == GDT_Int16)
                    {
                        reinterpret_cast<GInt16 *>(pImage)[idx] =
                            static_cast<GInt16>(dfZ);
                    }
                    else
                    {
                        reinterpret_cast<GByte *>(pImage)[idx] =
                            static_cast<GByte>(dfZ);
                    }
                }
            }
            /* Skip empty line */
        } while (nCol == 1 && bLastWasSep);

        poGDS->nDataLineNum++;
        if (nCol < poGDS->nMinTokens)
            return CE_Failure;

        if (idx + 1 == nRasterXSize)
            break;
    }

    if (poGDS->bSameNumberOfValuesPerLine)
    {
        if (poGDS->nDataLineNum !=
            static_cast<GIntBig>(nBlockYOff + 1) * nBlockXSize)
        {
            CPLError(CE_Failure, CPLE_AssertionFailed,
                     "The file does not have the same number of values per "
                     "line as initially thought. It must be somehow corrupted");
            return CE_Failure;
        }
    }

    nLastYOff = nBlockYOff;

    return CE_None;
}

/************************************************************************/
/*                            GetMinimum()                              */
/************************************************************************/

double XYZRasterBand::GetMinimum(int *pbSuccess)
{
    XYZDataset *poGDS = reinterpret_cast<XYZDataset *>(poDS);
    if (pbSuccess)
        *pbSuccess = TRUE;
    return poGDS->dfMinZ;
}

/************************************************************************/
/*                            GetMaximum()                              */
/************************************************************************/

double XYZRasterBand::GetMaximum(int *pbSuccess)
{
    XYZDataset *poGDS = reinterpret_cast<XYZDataset *>(poDS);
    if (pbSuccess)
        *pbSuccess = TRUE;
    return poGDS->dfMaxZ;
}

/************************************************************************/
/*                          GetNoDataValue()                            */
/************************************************************************/

double XYZRasterBand::GetNoDataValue(int *pbSuccess)
{
    XYZDataset *poGDS = reinterpret_cast<XYZDataset *>(poDS);
    if (!poGDS->bSameNumberOfValuesPerLine && poGDS->dfMinZ > -32768 &&
        eDataType != GDT_Byte)
    {
        if (pbSuccess)
            *pbSuccess = TRUE;
        return (poGDS->dfMinZ > 0) ? 0 : -32768;
    }
    else if (!poGDS->bSameNumberOfValuesPerLine && poGDS->dfMinZ > 0 &&
             eDataType == GDT_Byte)
    {
        if (pbSuccess)
            *pbSuccess = TRUE;
        return 0;
    }

    return GDALPamRasterBand::GetNoDataValue(pbSuccess);
}

/************************************************************************/
/*                            ~XYZDataset()                            */
/************************************************************************/

XYZDataset::XYZDataset()
    : fp(nullptr), bHasHeaderLine(FALSE), nCommentLineCount(0),
      chDecimalSep('.'), nXIndex(-1), nYIndex(-1), nZIndex(-1), nMinTokens(0),
      nLineNum(0), nDataLineNum(GINTBIG_MAX), bSameNumberOfValuesPerLine(TRUE),
      dfMinZ(0), dfMaxZ(0), bEOF(false)
{
    adfGeoTransform[0] = 0;
    adfGeoTransform[1] = 1;
    adfGeoTransform[2] = 0;
    adfGeoTransform[3] = 0;
    adfGeoTransform[4] = 0;
    adfGeoTransform[5] = 1;
}

/************************************************************************/
/*                            ~XYZDataset()                            */
/************************************************************************/

XYZDataset::~XYZDataset()

{
    FlushCache(true);
    if (fp)
        VSIFCloseL(fp);

    {
        std::lock_guard<std::mutex> guard(gMutex);
        if (gpoActiveDS == this)
        {
            gpoActiveDS = nullptr;
            gasValues.clear();
            gafValues.clear();
        }
    }
}

/************************************************************************/
/*                             Identify()                               */
/************************************************************************/

int XYZDataset::Identify(GDALOpenInfo *poOpenInfo)
{
    int bHasHeaderLine, nCommentLineCount;
    int nXIndex;
    int nYIndex;
    int nZIndex;
    return IdentifyEx(poOpenInfo, bHasHeaderLine, nCommentLineCount, nXIndex,
                      nYIndex, nZIndex);
}

/************************************************************************/
/*                            IdentifyEx()                              */
/************************************************************************/

int XYZDataset::IdentifyEx(GDALOpenInfo *poOpenInfo, int &bHasHeaderLine,
                           int &nCommentLineCount, int &nXIndex, int &nYIndex,
                           int &nZIndex)

{
    bHasHeaderLine = FALSE;
    nCommentLineCount = 0;

    CPLString osFilename(poOpenInfo->pszFilename);
    if (EQUAL(CPLGetExtensionSafe(osFilename).c_str(), "GRA") &&
        !poOpenInfo->IsSingleAllowedDriver("XYZ"))
    {
        // IGNFHeightASCIIGRID .GRA
        return FALSE;
    }

    std::unique_ptr<GDALOpenInfo> poOpenInfoToDelete;  // keep in this scope
    /*  GZipped .xyz files are common, so automagically open them */
    /*  if the /vsigzip/ has not been explicitly passed */
    if (strlen(poOpenInfo->pszFilename) > 6 &&
        EQUAL(poOpenInfo->pszFilename + strlen(poOpenInfo->pszFilename) - 6,
              "xyz.gz") &&
        !STARTS_WITH_CI(poOpenInfo->pszFilename, "/vsigzip/"))
    {
        osFilename = "/vsigzip/";
        osFilename += poOpenInfo->pszFilename;
        poOpenInfoToDelete = std::make_unique<GDALOpenInfo>(
            osFilename.c_str(), GA_ReadOnly, poOpenInfo->GetSiblingFiles());
        poOpenInfo = poOpenInfoToDelete.get();
    }

    if (poOpenInfo->nHeaderBytes == 0)
    {
        return FALSE;
    }

    /* -------------------------------------------------------------------- */
    /*      Check that it looks roughly as an XYZ dataset                   */
    /* -------------------------------------------------------------------- */
    const char *pszData =
        reinterpret_cast<const char *>(poOpenInfo->pabyHeader);

    if (poOpenInfo->nHeaderBytes >= 4 && STARTS_WITH(pszData, "DSAA") &&
        !poOpenInfo->IsSingleAllowedDriver("XYZ"))
    {
        // Do not match GSAG datasets
        return FALSE;
    }

    /* Skip comments line at the beginning such as in */
    /* http://pubs.usgs.gov/of/2003/ofr-03-230/DATA/NSLCU.XYZ */
    int i = 0;
    if (pszData[i] == '/')
    {
        nCommentLineCount++;

        i++;
        for (; i < poOpenInfo->nHeaderBytes; i++)
        {
            const char ch = pszData[i];
            if (ch == 13 || ch == 10)
            {
                if (ch == 13 && pszData[i + 1] == 10)
                    i++;
                if (pszData[i + 1] == '/')
                {
                    nCommentLineCount++;
                    i++;
                }
                else
                    break;
            }
        }
    }

    int iStartLine = i;
    for (; i < poOpenInfo->nHeaderBytes; i++)
    {
        const char ch = pszData[i];
        if (ch == 13 || ch == 10)
        {
            break;
        }
        else if (ch == ' ' || ch == ',' || ch == '\t' || ch == ';')
            ;
        else if ((ch >= '0' && ch <= '9') || ch == '.' || ch == '+' ||
                 ch == '-' || ch == 'e' || ch == 'E')
            ;
        else if (ch == '"' || (ch >= 'a' && ch <= 'z') ||
                 (ch >= 'A' && ch <= 'Z'))
            bHasHeaderLine = TRUE;
        else
        {
            return FALSE;
        }
    }

    nXIndex = -1;
    nYIndex = -1;
    nZIndex = -1;
    const char *pszColumnOrder = CSLFetchNameValueDef(
        poOpenInfo->papszOpenOptions, "COLUMN_ORDER", "AUTO");
    if (EQUAL(pszColumnOrder, "XYZ"))
    {
        nXIndex = 0;
        nYIndex = 1;
        nZIndex = 2;
        return TRUE;
    }
    else if (EQUAL(pszColumnOrder, "YXZ"))
    {
        nXIndex = 1;
        nYIndex = 0;
        nZIndex = 2;
        return TRUE;
    }
    else if (!EQUAL(pszColumnOrder, "AUTO"))
    {
        CPLError(CE_Failure, CPLE_IllegalArg,
                 "Option COLUMN_ORDER can only be XYZ, YXZ and AUTO."
                 "%s is not valid",
                 pszColumnOrder);
        return FALSE;
    }

    if (bHasHeaderLine)
    {
        CPLString osHeaderLine;
        osHeaderLine.assign(pszData + iStartLine, i - iStartLine);
        char **papszTokens =
            CSLTokenizeString2(osHeaderLine, " ,\t;", CSLT_HONOURSTRINGS);
        int nTokens = CSLCount(papszTokens);
        for (int iToken = 0; iToken < nTokens; iToken++)
        {
            const char *pszToken = papszTokens[iToken];
            if (EQUAL(pszToken, "x") || STARTS_WITH_CI(pszToken, "lon") ||
                STARTS_WITH_CI(pszToken, "east"))
                nXIndex = iToken;
            else if (EQUAL(pszToken, "y") || STARTS_WITH_CI(pszToken, "lat") ||
                     STARTS_WITH_CI(pszToken, "north"))
                nYIndex = iToken;
            else if (EQUAL(pszToken, "z") || STARTS_WITH_CI(pszToken, "alt") ||
                     EQUAL(pszToken, "height"))
                nZIndex = iToken;
        }
        CSLDestroy(papszTokens);
        if (nXIndex >= 0 && nYIndex >= 0 && nZIndex >= 0)
        {
            return TRUE;
        }
    }

    bool bHasFoundNewLine = false;
    bool bPrevWasSep = true;
    int nCols = 0;
    int nMaxCols = 0;
    for (; i < poOpenInfo->nHeaderBytes; i++)
    {
        char ch = pszData[i];
        if (ch == 13 || ch == 10)
        {
            bHasFoundNewLine = true;
            if (!bPrevWasSep)
            {
                nCols++;
                if (nCols > nMaxCols)
                    nMaxCols = nCols;
            }
            bPrevWasSep = true;
            nCols = 0;
        }
        else if (ch == ' ' || ch == ',' || ch == '\t' || ch == ';')
        {
            if (!bPrevWasSep)
            {
                nCols++;
                if (nCols > nMaxCols)
                    nMaxCols = nCols;
            }
            bPrevWasSep = true;
        }
        else if ((ch >= '0' && ch <= '9') || ch == '.' || ch == '+' ||
                 ch == '-' || ch == 'e' || ch == 'E')
        {
            bPrevWasSep = false;
        }
        else
        {
            return FALSE;
        }
    }

    return bHasFoundNewLine && nMaxCols >= 3;
}

/************************************************************************/
/*                                Open()                                */
/************************************************************************/

GDALDataset *XYZDataset::Open(GDALOpenInfo *poOpenInfo)

{
    int bHasHeaderLine;
    int nCommentLineCount = 0;

    int nXIndex = -1;
    int nYIndex = -1;
    int nZIndex = -1;
    if (!IdentifyEx(poOpenInfo, bHasHeaderLine, nCommentLineCount, nXIndex,
                    nYIndex, nZIndex))
        return nullptr;

    CPLString osFilename(poOpenInfo->pszFilename);

    /*  GZipped .xyz files are common, so automagically open them */
    /*  if the /vsigzip/ has not been explicitly passed */
    if (strlen(poOpenInfo->pszFilename) > 6 &&
        EQUAL(poOpenInfo->pszFilename + strlen(poOpenInfo->pszFilename) - 6,
              "xyz.gz") &&
        !STARTS_WITH_CI(poOpenInfo->pszFilename, "/vsigzip/"))
    {
        osFilename = "/vsigzip/";
        osFilename += poOpenInfo->pszFilename;
    }

    /* -------------------------------------------------------------------- */
    /*      Find dataset characteristics                                    */
    /* -------------------------------------------------------------------- */
    VSILFILE *fp = VSIFOpenL(osFilename.c_str(), "rb");
    if (fp == nullptr)
        return nullptr;

    /* For better performance of CPLReadLine2L() we create a buffered reader */
    /* (except for /vsigzip/ since it has one internally) */
    if (!STARTS_WITH_CI(poOpenInfo->pszFilename, "/vsigzip/"))
        fp = VSICreateBufferedReaderHandle(fp);

    int nMinTokens = 0;

    for (int i = 0; i < nCommentLineCount; i++)
    {
        if (CPLReadLine2L(fp, 100, nullptr) == nullptr)
        {
            VSIFCloseL(fp);
            return nullptr;
        }
    }

    /* -------------------------------------------------------------------- */
    /*      Parse header line                                               */
    /* -------------------------------------------------------------------- */
    if (bHasHeaderLine)
    {
        const char *pszLine = CPLReadLine2L(fp, 100, nullptr);
        if (pszLine == nullptr)
        {
            VSIFCloseL(fp);
            return nullptr;
        }
        if (nXIndex < 0 || nYIndex < 0 || nZIndex < 0)
        {
            CPLError(CE_Warning, CPLE_AppDefined,
                     "Could not find one of the X, Y or Z column names in "
                     "header line. Defaulting to the first 3 columns");
            nXIndex = 0;
            nYIndex = 1;
            nZIndex = 2;
        }
    }
    else if (nXIndex < 0 || nYIndex < 0 || nZIndex < 0)
    {
        nXIndex = 0;
        nYIndex = 1;
        nZIndex = 2;
    }
    nMinTokens = 1 + std::max(std::max(nXIndex, nYIndex), nZIndex);

    /* -------------------------------------------------------------------- */
    /*      Parse data lines                                                */
    /* -------------------------------------------------------------------- */

    GIntBig nLineNum = 0;
    GIntBig nDataLineNum = 0;
    double dfX = 0.0;
    double dfY = 0.0;
    double dfZ = 0.0;
    double dfMinX = 0.0;
    double dfMinY = 0.0;
    double dfMaxX = 0.0;
    double dfMaxY = 0.0;
    double dfMinZ = 0.0;
    double dfMaxZ = 0.0;
    double dfLastX = 0.0;
    double dfLastY = 0.0;
    std::vector<double> adfStepX;
    std::vector<double> adfStepY;
    GDALDataType eDT = GDT_Byte;
    bool bSameNumberOfValuesPerLine = true;
    char chDecimalSep = '\0';
    int nStepYSign = 0;
    bool bColOrganization = false;

    const char *pszLine;
    GIntBig nCountStepX = 0;
    GIntBig nCountStepY = 0;
    while ((pszLine = CPLReadLine2L(fp, 100, nullptr)) != nullptr)
    {
        nLineNum++;

        const char *pszPtr = pszLine;
        char ch;
        int nCol = 0;
        bool bLastWasSep = true;
        if (chDecimalSep == '\0')
        {
            int nCountComma = 0;
            int nCountFieldSep = 0;
            while ((ch = *pszPtr) != '\0')
            {
                if (ch == '.')
                {
                    chDecimalSep = '.';
                    break;
                }
                else if (ch == ',')
                {
                    nCountComma++;
                    bLastWasSep = false;
                }
                else if (ch == ' ')
                {
                    if (!bLastWasSep)
                        nCountFieldSep++;
                    bLastWasSep = true;
                }
                else if (ch == '\t' || ch == ';')
                {
                    nCountFieldSep++;
                    bLastWasSep = true;
                }
                else
                    bLastWasSep = false;
                pszPtr++;
            }
            if (chDecimalSep == '\0')
            {
                /* 1,2,3 */
                if (nCountComma >= 2 && nCountFieldSep == 0)
                    chDecimalSep = '.';
                /* 23,5;33;45 */
                else if (nCountComma > 0 && nCountFieldSep > 0)
                    chDecimalSep = ',';
            }
            pszPtr = pszLine;
            bLastWasSep = true;
        }

        char chLocalDecimalSep = chDecimalSep ? chDecimalSep : '.';
        int nUsefulColsFound = 0;
        while ((ch = *pszPtr) != '\0')
        {
            if (ch == ' ')
            {
                if (!bLastWasSep)
                    nCol++;
                bLastWasSep = true;
            }
            else if ((ch == ',' && chLocalDecimalSep != ',') || ch == '\t' ||
                     ch == ';')
            {
                nCol++;
                bLastWasSep = true;
            }
            else
            {
                if (bLastWasSep)
                {
                    if (nCol == nXIndex)
                    {
                        nUsefulColsFound++;
                        dfX = CPLAtofDelim(pszPtr, chLocalDecimalSep);
                    }
                    else if (nCol == nYIndex)
                    {
                        nUsefulColsFound++;
                        dfY = CPLAtofDelim(pszPtr, chLocalDecimalSep);
                    }
                    else if (nCol == nZIndex)
                    {
                        nUsefulColsFound++;
                        dfZ = CPLAtofDelim(pszPtr, chLocalDecimalSep);
                        if (nDataLineNum == 0)
                        {
                            dfMinZ = dfZ;
                            dfMaxZ = dfZ;
                        }
                        else if (dfZ < dfMinZ)
                        {
                            dfMinZ = dfZ;
                        }
                        else if (dfZ > dfMaxZ)
                        {
                            dfMaxZ = dfZ;
                        }

                        if (dfZ < INT_MIN || dfZ > INT_MAX)
                        {
                            eDT = GDT_Float32;
                        }
                        else
                        {
                            int nZ = static_cast<int>(dfZ);
                            if (static_cast<double>(nZ) != dfZ)
                            {
                                eDT = GDT_Float32;
                            }
                            else if ((eDT == GDT_Byte || eDT == GDT_Int16)
                                     // cppcheck-suppress
                                     // knownConditionTrueFalse
                                     && (nZ < 0 || nZ > 255))
                            {
                                if (nZ < -32768 || nZ > 32767)
                                    eDT = GDT_Int32;
                                else
                                    eDT = GDT_Int16;
                            }
                        }
                    }
                }
                bLastWasSep = false;
            }
            pszPtr++;
        }
        /* skip empty lines */
        if (bLastWasSep && nCol == 0)
        {
            continue;
        }
        nDataLineNum++;
        nCol++;
        if (nCol < nMinTokens)
        {
            CPLError(CE_Failure, CPLE_AppDefined,
                     "At line " CPL_FRMT_GIB
                     ", found %d tokens. Expected %d at least",
                     nLineNum, nCol, nMinTokens);
            VSIFCloseL(fp);
            return nullptr;
        }
        if (nUsefulColsFound != 3)
        {
            CPLError(CE_Failure, CPLE_AppDefined,
                     "At line " CPL_FRMT_GIB
                     ", did not find X, Y and/or Z values",
                     nLineNum);
            VSIFCloseL(fp);
            return nullptr;
        }

        if (nDataLineNum == 1)
        {
            dfMinX = dfX;
            dfMaxX = dfX;
            dfMinY = dfY;
            dfMaxY = dfY;
        }
        else if (nDataLineNum == 2 && dfX == dfLastX)
        {
            // Detect datasets organized by columns
            if (dfY == dfLastY)
            {
                CPLError(CE_Failure, CPLE_AppDefined,
                         "Ungridded dataset: At line " CPL_FRMT_GIB
                         ", Failed to detect grid layout.",
                         nLineNum);
                VSIFCloseL(fp);
                return nullptr;
            }

            bColOrganization = true;
            const double dfStepY = dfY - dfLastY;
            adfStepY.push_back(fabs(dfStepY));
            nStepYSign = dfStepY > 0 ? 1 : -1;
        }
        else if (bColOrganization)
        {
            const double dfStepX = dfX - dfLastX;
            if (dfStepX == 0)
            {
                const double dfStepY = dfY - dfLastY;
                const double dfExpectedStepY = adfStepY.back() * nStepYSign;
                if (fabs((dfStepY - dfExpectedStepY) / dfExpectedStepY) >
                    RELATIVE_ERROR)
                {
                    CPLError(CE_Failure, CPLE_AppDefined,
                             "Ungridded dataset: At line " CPL_FRMT_GIB
                             ", Y spacing was %f. Expected %f",
                             nLineNum, dfStepY, dfExpectedStepY);
                    VSIFCloseL(fp);
                    return nullptr;
                }
            }
            else if (dfStepX > 0)
            {
                if (adfStepX.empty())
                {
                    adfStepX.push_back(dfStepX);
                }
                else if (fabs((dfStepX - adfStepX.back()) / adfStepX.back()) >
                         RELATIVE_ERROR)
                {
                    CPLError(CE_Failure, CPLE_AppDefined,
                             "Ungridded dataset: At line " CPL_FRMT_GIB
                             ", X spacing was %f. Expected %f",
                             nLineNum, dfStepX, adfStepX.back());
                    VSIFCloseL(fp);
                    return nullptr;
                }
            }
            else if (nDataLineNum == 3)
            {
                const double dfStepY = dfY - dfLastY;
                const double dfLastSignedStepY = nStepYSign * adfStepY.back();
                if (dfStepY * dfLastSignedStepY > 0 &&
                    (fabs(dfStepY - dfLastSignedStepY) <=
                         RELATIVE_ERROR * fabs(dfLastSignedStepY)
#ifdef multiple_of_step_y_not_yet_supported
                     ||
                     (fabs(dfStepY) > fabs(dfLastSignedStepY) &&
                      fabs(std::round(dfStepY / dfLastSignedStepY) -
                           (dfStepY / dfLastSignedStepY)) <= RELATIVE_ERROR) ||
                     (fabs(dfLastSignedStepY) > fabs(dfStepY) &&
                      fabs(std::round(dfLastSignedStepY / dfStepY) -
                           (dfLastSignedStepY / dfStepY)) <= RELATIVE_ERROR)
#endif
                         ))
                {
                    // Assume it is a file starting with something like:
                    // 371999.50 5806917.50 41.21
                    // 371999.50 5806918.50 51.99
                    // 371998.50 5806919.50 53.50
                    // 371999.50 5806919.50 53.68
                    adfStepX.push_back(dfLastX - dfX);
                    bColOrganization = false;
                }
                else
                {
                    CPLError(CE_Failure, CPLE_AppDefined,
                             "Ungridded dataset: At line " CPL_FRMT_GIB
                             ", X spacing was %f. Expected >0 value",
                             nLineNum, dfX - dfLastX);
                    VSIFCloseL(fp);
                    return nullptr;
                }
            }
            else if (!adfStepX.empty() &&
                     fabs(std::round(-dfStepX / adfStepX[0]) -
                          (-dfStepX / adfStepX[0])) <= RELATIVE_ERROR)
            {
                bColOrganization = false;
            }
            else if (adfStepX.empty())
            {
                adfStepX.push_back(fabs(dfStepX));
                bColOrganization = false;
            }
            else
            {
                CPLError(CE_Failure, CPLE_AppDefined,
                         "Ungridded dataset: At line " CPL_FRMT_GIB
                         ", X spacing was %f. Expected a multiple of %f",
                         nLineNum, dfStepX, adfStepX[0]);
                VSIFCloseL(fp);
                return nullptr;
            }
        }
        else
        {
            double dfStepY = dfY - dfLastY;
            if (dfStepY == 0.0)
            {
                const double dfStepX = dfX - dfLastX;
                if (dfStepX <= 0)
                {
                    CPLError(CE_Failure, CPLE_AppDefined,
                             "Ungridded dataset: At line " CPL_FRMT_GIB
                             ", X spacing was %f. Expected >0 value",
                             nLineNum, dfStepX);
                    VSIFCloseL(fp);
                    return nullptr;
                }
                if (std::find(adfStepX.begin(), adfStepX.end(), dfStepX) ==
                    adfStepX.end())
                {
                    bool bAddNewValue = true;
                    std::vector<double>::iterator oIter = adfStepX.begin();
                    std::vector<double> adfStepXNew;
                    while (oIter != adfStepX.end())
                    {
                        if (fabs((dfStepX - *oIter) / dfStepX) < RELATIVE_ERROR)
                        {
                            double dfNewVal = *oIter;
                            if (nCountStepX > 0)
                            {
                                // Update mean step
                                /* n * mean(n) = (n-1) * mean(n-1) + val(n)
                                mean(n) = mean(n-1) + (val(n) - mean(n-1)) / n
                              */
                                nCountStepX++;
                                dfNewVal += (dfStepX - *oIter) / nCountStepX;
                            }

                            adfStepXNew.push_back(dfNewVal);
                            bAddNewValue = false;
                            break;
                        }
                        else if (dfStepX < *oIter &&
                                 fabs(*oIter -
                                      static_cast<int>(*oIter / dfStepX + 0.5) *
                                          dfStepX) /
                                         dfStepX <
                                     RELATIVE_ERROR)
                        {
                            nCountStepX = -1;  // disable update of mean
                            ++oIter;
                        }
                        else if (dfStepX > *oIter &&
                                 fabs(dfStepX -
                                      static_cast<int>(dfStepX / *oIter + 0.5) *
                                          (*oIter)) /
                                         dfStepX <
                                     RELATIVE_ERROR)
                        {
                            nCountStepX = -1;  // disable update of mean
                            bAddNewValue = false;
                            adfStepXNew.push_back(*oIter);
                            break;
                        }
                        else
                        {
                            adfStepXNew.push_back(*oIter);
                            ++oIter;
                        }
                    }
                    adfStepX = std::move(adfStepXNew);
                    if (bAddNewValue)
                    {
                        CPLDebug("XYZ", "New stepX=%.15f", dfStepX);
                        adfStepX.push_back(dfStepX);
                        if (adfStepX.size() == 1 && nCountStepX == 0)
                        {
                            nCountStepX++;
                        }
                        else if (adfStepX.size() == 2)
                        {
                            nCountStepX = -1;  // disable update of mean
                        }
                        else if (adfStepX.size() == 10)
                        {
                            CPLError(
                                CE_Failure, CPLE_AppDefined,
                                "Ungridded dataset: too many stepX values");
                            VSIFCloseL(fp);
                            return nullptr;
                        }
                    }
                }
            }
            else
            {
                int bNewStepYSign = (dfStepY < 0.0) ? -1 : 1;
                if (nStepYSign == 0)
                    nStepYSign = bNewStepYSign;
                else if (nStepYSign != bNewStepYSign)
                {
                    CPLError(CE_Failure, CPLE_AppDefined,
                             "Ungridded dataset: At line " CPL_FRMT_GIB
                             ", change of Y direction",
                             nLineNum);
                    VSIFCloseL(fp);
                    return nullptr;
                }
                if (bNewStepYSign < 0)
                    dfStepY = -dfStepY;
                nCountStepY++;
                if (adfStepY.empty())
                {
                    adfStepY.push_back(dfStepY);
                }
                else if (fabs((adfStepY[0] - dfStepY) / dfStepY) >
                         RELATIVE_ERROR)
                {
                    if (dfStepY > adfStepY[0] &&
                        fabs(std::round(dfStepY / adfStepY[0]) -
                             (dfStepY / adfStepY[0])) <= RELATIVE_ERROR)
                    {
                        // The new step is a multiple of the previous one,
                        // which means we have a missing line: OK
                    }
                    else
                    {
                        CPLDebug("XYZ", "New stepY=%.15f prev stepY=%.15f",
                                 dfStepY, adfStepY[0]);
                        CPLError(CE_Failure, CPLE_AppDefined,
                                 "Ungridded dataset: At line " CPL_FRMT_GIB
                                 ", too many stepY values",
                                 nLineNum);
                        VSIFCloseL(fp);
                        return nullptr;
                    }
                }
                else
                {
                    // Update mean step
                    adfStepY[0] += (dfStepY - adfStepY[0]) / nCountStepY;
                }
            }
        }

        if (dfX < dfMinX)
            dfMinX = dfX;
        if (dfX > dfMaxX)
            dfMaxX = dfX;
        if (dfY < dfMinY)
            dfMinY = dfY;
        if (dfY > dfMaxY)
            dfMaxY = dfY;

        dfLastX = dfX;
        dfLastY = dfY;
    }

    if (adfStepX.size() != 1 || adfStepX[0] == 0)
    {
        CPLError(CE_Failure, CPLE_AppDefined, "Couldn't determine X spacing");
        VSIFCloseL(fp);
        return nullptr;
    }

    if (adfStepY.size() != 1 || adfStepY[0] == 0)
    {
        CPLError(CE_Failure, CPLE_AppDefined, "Couldn't determine Y spacing");
        VSIFCloseL(fp);
        return nullptr;
    }

    // Decide for a north-up organization
    if (bColOrganization)
        nStepYSign = -1;

    const double dfXSize = 1 + ((dfMaxX - dfMinX) / adfStepX[0] + 0.5);
    const double dfYSize = 1 + ((dfMaxY - dfMinY) / adfStepY[0] + 0.5);
    // Test written such as to detect NaN values
    if (!(dfXSize > 0 && dfXSize < INT_MAX) ||
        !(dfYSize > 0 && dfYSize < INT_MAX))
    {
        CPLError(CE_Failure, CPLE_AppDefined, "Invalid dimensions");
        VSIFCloseL(fp);
        return nullptr;
    }
    const int nXSize = static_cast<int>(dfXSize);
    const int nYSize = static_cast<int>(dfYSize);
    const double dfStepX = (dfMaxX - dfMinX) / (nXSize - 1);
    const double dfStepY = (dfMaxY - dfMinY) / (nYSize - 1) * nStepYSign;

#ifdef DEBUG_VERBOSE
    CPLDebug("XYZ", "minx=%f maxx=%f stepx=%f", dfMinX, dfMaxX, dfStepX);
    CPLDebug("XYZ", "miny=%f maxy=%f stepy=%f", dfMinY, dfMaxY, dfStepY);
#endif

    if (nDataLineNum != static_cast<GIntBig>(nXSize) * nYSize)
    {
        if (bColOrganization)
        {
            CPLError(CE_Failure, CPLE_NotSupported,
                     "The XYZ driver does not support datasets organized by "
                     "columns with missing values");
            VSIFCloseL(fp);
            return nullptr;
        }
        bSameNumberOfValuesPerLine = false;
    }
    else if (bColOrganization && nDataLineNum > 100 * 1000 * 1000)
    {
        CPLError(CE_Failure, CPLE_NotSupported,
                 "The XYZ driver cannot load datasets organized by "
                 "columns with more than 100 million points");
        VSIFCloseL(fp);
        return nullptr;
    }

    const bool bIngestAll = bColOrganization;
    if (bIngestAll)
    {
        if (eDT == GDT_Int32)
            eDT = GDT_Float32;
        else if (eDT == GDT_Byte)
            eDT = GDT_Int16;
        CPLAssert(eDT == GDT_Int16 || eDT == GDT_Float32);
    }

    if (poOpenInfo->eAccess == GA_Update)
    {
        ReportUpdateNotSupportedByDriver("XYZ");
        VSIFCloseL(fp);
        return nullptr;
    }

    /* -------------------------------------------------------------------- */
    /*      Create a corresponding GDALDataset.                             */
    /* -------------------------------------------------------------------- */
    XYZDataset *poDS = new XYZDataset();
    poDS->fp = fp;
    poDS->bHasHeaderLine = bHasHeaderLine;
    poDS->nCommentLineCount = nCommentLineCount;
    poDS->chDecimalSep = chDecimalSep ? chDecimalSep : '.';
    poDS->nXIndex = nXIndex;
    poDS->nYIndex = nYIndex;
    poDS->nZIndex = nZIndex;
    poDS->nMinTokens = nMinTokens;
    poDS->nRasterXSize = nXSize;
    poDS->nRasterYSize = nYSize;
    poDS->adfGeoTransform[0] = dfMinX - dfStepX / 2;
    poDS->adfGeoTransform[1] = dfStepX;
    poDS->adfGeoTransform[3] =
        (dfStepY < 0) ? dfMaxY - dfStepY / 2 : dfMinY - dfStepY / 2;
    poDS->adfGeoTransform[5] = dfStepY;
    poDS->bSameNumberOfValuesPerLine = bSameNumberOfValuesPerLine;
    poDS->dfMinZ = dfMinZ;
    poDS->dfMaxZ = dfMaxZ;
    poDS->bIngestAll = bIngestAll;
#ifdef DEBUG_VERBOSE
    CPLDebug("XYZ", "bSameNumberOfValuesPerLine = %d",
             bSameNumberOfValuesPerLine);
#endif

    if (!GDALCheckDatasetDimensions(poDS->nRasterXSize, poDS->nRasterYSize))
    {
        delete poDS;
        return nullptr;
    }

    /* -------------------------------------------------------------------- */
    /*      Create band information objects.                                */
    /* -------------------------------------------------------------------- */
    poDS->nBands = 1;
    for (int i = 0; i < poDS->nBands; i++)
        poDS->SetBand(i + 1, new XYZRasterBand(poDS, i + 1, eDT));

    /* -------------------------------------------------------------------- */
    /*      Initialize any PAM information.                                 */
    /* -------------------------------------------------------------------- */
    poDS->SetDescription(poOpenInfo->pszFilename);
    poDS->TryLoadXML();

    /* -------------------------------------------------------------------- */
    /*      Support overviews.                                              */
    /* -------------------------------------------------------------------- */
    poDS->oOvManager.Initialize(poDS, poOpenInfo->pszFilename);
    return poDS;
}

/************************************************************************/
/*                             CreateCopy()                             */
/************************************************************************/

GDALDataset *XYZDataset::CreateCopy(const char *pszFilename,
                                    GDALDataset *poSrcDS, int bStrict,
                                    char **papszOptions,
                                    GDALProgressFunc pfnProgress,
                                    void *pProgressData)
{
    /* -------------------------------------------------------------------- */
    /*      Some some rudimentary checks                                    */
    /* -------------------------------------------------------------------- */
    int nBands = poSrcDS->GetRasterCount();
    if (nBands == 0)
    {
        CPLError(
            CE_Failure, CPLE_NotSupported,
            "XYZ driver does not support source dataset with zero band.\n");
        return nullptr;
    }

    if (nBands != 1)
    {
        CPLError((bStrict) ? CE_Failure : CE_Warning, CPLE_NotSupported,
                 "XYZ driver only uses the first band of the dataset.\n");
        if (bStrict)
            return nullptr;
    }

    if (pfnProgress && !pfnProgress(0.0, nullptr, pProgressData))
        return nullptr;

    /* -------------------------------------------------------------------- */
    /*      Get source dataset info                                         */
    /* -------------------------------------------------------------------- */

    int nXSize = poSrcDS->GetRasterXSize();
    int nYSize = poSrcDS->GetRasterYSize();
    double adfGeoTransform[6];
    poSrcDS->GetGeoTransform(adfGeoTransform);
    if (adfGeoTransform[2] != 0 || adfGeoTransform[4] != 0)
    {
        CPLError(CE_Failure, CPLE_NotSupported,
                 "XYZ driver does not support CreateCopy() from skewed or "
                 "rotated dataset.\n");
        return nullptr;
    }

    const GDALDataType eSrcDT = poSrcDS->GetRasterBand(1)->GetRasterDataType();
    GDALDataType eReqDT;
    if (eSrcDT == GDT_Byte || eSrcDT == GDT_Int16 || eSrcDT == GDT_UInt16 ||
        eSrcDT == GDT_Int32)
        eReqDT = GDT_Int32;
    else
        eReqDT = GDT_Float32;

    /* -------------------------------------------------------------------- */
    /*      Create target file                                              */
    /* -------------------------------------------------------------------- */

    VSILFILE *fp = VSIFOpenL(pszFilename, "wb");
    if (fp == nullptr)
    {
        CPLError(CE_Failure, CPLE_AppDefined, "Cannot create %s", pszFilename);
        return nullptr;
    }

    /* -------------------------------------------------------------------- */
    /*      Read creation options                                           */
    /* -------------------------------------------------------------------- */
    const char *pszColSep = CSLFetchNameValue(papszOptions, "COLUMN_SEPARATOR");
    if (pszColSep == nullptr)
        pszColSep = " ";
    else if (EQUAL(pszColSep, "COMMA"))
        pszColSep = ",";
    else if (EQUAL(pszColSep, "SPACE"))
        pszColSep = " ";
    else if (EQUAL(pszColSep, "SEMICOLON"))
        pszColSep = ";";
    else if (EQUAL(pszColSep, "\\t") || EQUAL(pszColSep, "TAB"))
        pszColSep = "\t";
#ifdef DEBUG_VERBOSE
    else
        CPLDebug("XYZ", "Using raw column separator: '%s' ", pszColSep);
#endif

    const char *pszAddHeaderLine =
        CSLFetchNameValue(papszOptions, "ADD_HEADER_LINE");
    if (pszAddHeaderLine != nullptr && CPLTestBool(pszAddHeaderLine))
    {
        VSIFPrintfL(fp, "X%sY%sZ\n", pszColSep, pszColSep);
    }

    /* -------------------------------------------------------------------- */
    /*      Copy imagery                                                    */
    /* -------------------------------------------------------------------- */
    char szFormat[50] = {'\0'};
    if (eReqDT == GDT_Int32)
        strcpy(szFormat, "%.17g%c%.17g%c%d\n");
    else
        strcpy(szFormat, "%.17g%c%.17g%c%.17g\n");
    const char *pszDecimalPrecision =
        CSLFetchNameValue(papszOptions, "DECIMAL_PRECISION");
    const char *pszSignificantDigits =
        CSLFetchNameValue(papszOptions, "SIGNIFICANT_DIGITS");
    bool bIgnoreSigDigits = false;
    if (pszDecimalPrecision && pszSignificantDigits)
    {
        CPLError(CE_Warning, CPLE_AppDefined,
                 "Conflicting precision arguments, using DECIMAL_PRECISION");
        bIgnoreSigDigits = true;
    }
    int nPrecision;
    if (pszSignificantDigits && !bIgnoreSigDigits)
    {
        nPrecision = atoi(pszSignificantDigits);
        if (nPrecision >= 0)
        {
            if (eReqDT == GDT_Int32)
                snprintf(szFormat, sizeof(szFormat), "%%.%dg%%c%%.%dg%%c%%d\n",
                         nPrecision, nPrecision);
            else
                snprintf(szFormat, sizeof(szFormat),
                         "%%.%dg%%c%%.%dg%%c%%.%dg\n", nPrecision, nPrecision,
                         nPrecision);
        }
        CPLDebug("XYZ", "Setting precision format: %s", szFormat);
    }
    else if (pszDecimalPrecision)
    {
        nPrecision = atoi(pszDecimalPrecision);
        if (nPrecision >= 0)
        {
            if (eReqDT == GDT_Int32)
                snprintf(szFormat, sizeof(szFormat), "%%.%df%%c%%.%df%%c%%d\n",
                         nPrecision, nPrecision);
            else
                snprintf(szFormat, sizeof(szFormat),
                         "%%.%df%%c%%.%df%%c%%.%df\n", nPrecision, nPrecision,
                         nPrecision);
        }
        CPLDebug("XYZ", "Setting precision format: %s", szFormat);
    }
    void *pLineBuffer =
        reinterpret_cast<void *>(CPLMalloc(nXSize * sizeof(int)));
    CPLErr eErr = CE_None;
    for (int j = 0; j < nYSize && eErr == CE_None; j++)
    {
        eErr = poSrcDS->GetRasterBand(1)->RasterIO(GF_Read, 0, j, nXSize, 1,
                                                   pLineBuffer, nXSize, 1,
                                                   eReqDT, 0, 0, nullptr);
        if (eErr != CE_None)
            break;
        const double dfY = adfGeoTransform[3] + (j + 0.5) * adfGeoTransform[5];
        CPLString osBuf;
        for (int i = 0; i < nXSize; i++)
        {
            const double dfX =
                adfGeoTransform[0] + (i + 0.5) * adfGeoTransform[1];
            char szBuf[256];
            if (eReqDT == GDT_Int32)
                CPLsnprintf(szBuf, sizeof(szBuf), szFormat, dfX, pszColSep[0],
                            dfY, pszColSep[0],
                            reinterpret_cast<int *>(pLineBuffer)[i]);
            else
                CPLsnprintf(szBuf, sizeof(szBuf), szFormat, dfX, pszColSep[0],
                            dfY, pszColSep[0],
                            reinterpret_cast<float *>(pLineBuffer)[i]);
            osBuf += szBuf;
            if ((i & 1023) == 0 || i == nXSize - 1)
            {
                if (VSIFWriteL(osBuf, static_cast<int>(osBuf.size()), 1, fp) !=
                    1)
                {
                    eErr = CE_Failure;
                    CPLError(CE_Failure, CPLE_AppDefined,
                             "Write failed, disk full?\n");
                    break;
                }
                osBuf = "";
            }
        }
        if (pfnProgress &&
            !pfnProgress((j + 1) * 1.0 / nYSize, nullptr, pProgressData))
        {
            eErr = CE_Failure;
            break;
        }
    }
    CPLFree(pLineBuffer);
    VSIFCloseL(fp);

    if (eErr != CE_None)
        return nullptr;

    /* -------------------------------------------------------------------- */
    /*      We don't want to call GDALOpen() since it will be expensive,    */
    /*      so we "hand prepare" an XYZ dataset referencing our file.       */
    /* -------------------------------------------------------------------- */
    XYZDataset *poXYZ_DS = new XYZDataset();
    poXYZ_DS->nRasterXSize = nXSize;
    poXYZ_DS->nRasterYSize = nYSize;
    poXYZ_DS->nBands = 1;
    poXYZ_DS->SetBand(1, new XYZRasterBand(poXYZ_DS, 1, eReqDT));
    /* If writing to stdout, we can't reopen it --> silence warning */
    CPLPushErrorHandler(CPLQuietErrorHandler);
    poXYZ_DS->fp = VSIFOpenL(pszFilename, "rb");
    CPLPopErrorHandler();
    memcpy(&(poXYZ_DS->adfGeoTransform), adfGeoTransform, sizeof(double) * 6);
    poXYZ_DS->nXIndex = 0;
    poXYZ_DS->nYIndex = 1;
    poXYZ_DS->nZIndex = 2;
    if (pszAddHeaderLine)
    {
        poXYZ_DS->nDataLineNum = 1;
        poXYZ_DS->bHasHeaderLine = TRUE;
    }

    return poXYZ_DS;
}

/************************************************************************/
/*                          GetGeoTransform()                           */
/************************************************************************/

CPLErr XYZDataset::GetGeoTransform(double *padfTransform)

{
    memcpy(padfTransform, adfGeoTransform, 6 * sizeof(double));

    return CE_None;
}

/************************************************************************/
/*                         GDALRegister_XYZ()                           */
/************************************************************************/

void GDALRegister_XYZ()

{
    if (GDALGetDriverByName("XYZ") != nullptr)
        return;

    GDALDriver *poDriver = new GDALDriver();

    poDriver->SetDescription("XYZ");
    poDriver->SetMetadataItem(GDAL_DCAP_RASTER, "YES");
    poDriver->SetMetadataItem(GDAL_DMD_LONGNAME, "ASCII Gridded XYZ");
    poDriver->SetMetadataItem(GDAL_DMD_HELPTOPIC, "drivers/raster/xyz.html");
    poDriver->SetMetadataItem(GDAL_DMD_EXTENSION, "xyz");
    poDriver->SetMetadataItem(
        GDAL_DMD_CREATIONOPTIONLIST,
        "<CreationOptionList>"
        "   <Option name='COLUMN_SEPARATOR' type='string' default=' ' "
        "description='Separator between fields.'/>"
        "   <Option name='ADD_HEADER_LINE' type='boolean' default='false' "
        "description='Add an header line with column names.'/>"
        "   <Option name='SIGNIFICANT_DIGITS' type='int' description='Number "
        "of significant digits when writing floating-point numbers (%g format; "
        "default with 18).'/>\n"
        "   <Option name='DECIMAL_PRECISION' type='int' description='Number of "
        "decimal places when writing floating-point numbers (%f format).'/>\n"
        "</CreationOptionList>");
    poDriver->SetMetadataItem(
        GDAL_DMD_OPENOPTIONLIST,
        "<OpenOptionList>"
        "   <Option name='COLUMN_ORDER' type='string-select' default='AUTO' "
        "description='Specifies the order of the columns. It overrides the "
        "header.'>"
        "       <Value>AUTO</Value>"
        "       <Value>XYZ</Value>"
        "       <Value>YXZ</Value>"
        "   </Option>"
        "</OpenOptionList>");

    poDriver->SetMetadataItem(GDAL_DCAP_VIRTUALIO, "YES");

    poDriver->pfnOpen = XYZDataset::Open;
    poDriver->pfnIdentify = XYZDataset::Identify;
    poDriver->pfnCreateCopy = XYZDataset::CreateCopy;

    GetGDALDriverManager()->RegisterDriver(poDriver);
}

OSGeo / gdal / 14023130831

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous