Dataset.h

#pragma once

#include "forward.h"

#include <gdal_priv.h>
#include <memory>
#include <string>

#include <isce3/core/Projections.h>
#include <isce3/io/IH5.h>

#include "GeoTransform.h"

namespace isce3 { namespace io { namespace gdal {

class Dataset {
public:

    static
    std::string defaultDriver() { return "ENVI"; }

    Dataset(const std::string & path, GDALAccess access = GA_ReadOnly);

    Dataset(const isce3::io::IDataSet & dataset, GDALAccess access = GA_ReadOnly);

    Dataset(const std::string & path,
            int width,
            int length,
            int bands,
            GDALDataType datatype,
            const std::string & driver = defaultDriver());

    Dataset(const std::string & path, const Dataset & src);

    Dataset(const std::string & path, const Dataset & src, const std::string & driver);

    template<typename T>
    Dataset(const T * data, int width, int length, int bands);

    template<typename T>
    Dataset(T * data, int width, int length, int bands, GDALAccess access = GA_Update);

    template<typename T>
    Dataset(const T * data,
            int width,
            int length,
            int bands,
            std::size_t colstride,
            std::size_t rowstride,
            std::size_t bandstride);

    template<typename T>
    Dataset(T * data,
            int width,
            int length,
            int bands,
            std::size_t colstride,
            std::size_t rowstride,
            std::size_t bandstride,
            GDALAccess access = GA_Update);

    GDALAccess access() const { return _access; }

    int width() const { return _dataset->GetRasterXSize(); }

    int length() const { return _dataset->GetRasterYSize(); }

    int bands() const { return _dataset->GetRasterCount(); }

    std::string driver() const { return _dataset->GetDriverName(); }

    Raster getRaster(int band) const;

    GeoTransform getGeoTransform() const;

    void setGeoTransform(const GeoTransform &);

    isce3::core::ProjectionBase * getProjection() const;

    void setProjection(const isce3::core::ProjectionBase *);

    double x0() const { return getGeoTransform().x0; }

    double y0() const { return getGeoTransform().y0; }

    double dx() const { return getGeoTransform().dx; }

    double dy() const { return getGeoTransform().dy; }

    GDALDataset * get() { return _dataset.get(); }

    const GDALDataset * get() const { return _dataset.get(); }

    friend class Raster;

private:
    std::shared_ptr<GDALDataset> _dataset;

    // XXX need to keep track of access mode ourselves rather than use `_dataset->GetAccess()`
    // XXX GDAL silently ignores the requested access mode when using "MEM" driver
    // XXX and sets access mode to GA_Update (https://github.com/OSGeo/gdal/issues/1971)
    GDALAccess _access;
};

}}}

#define ISCE_IO_GDAL_DATASET_ICC
#include "Dataset.icc"
#undef ISCE_IO_GDAL_DATASET_ICC