NetCdfConfigureDialog Class Reference

Detailed Description

The dialog for converting data from NetCDF-files into OGS data structures. While NetCDF files can include data ranging from dimensionality 0 (scalars) to 4 (e.g. 3d arrays over time), only arrays of dimensionality 2 or higher can be imported as this is the minimum requirement for a meaningful conversion into raster- or mesh-data-objects. Scalars or vector-variables are not selectable from the selection menu.

Definition at line 29 of file NetCdfConfigureDialog.h.

#include <NetCdfConfigureDialog.h>

Inheritance diagram for NetCdfConfigureDialog:

Collaboration diagram for NetCdfConfigureDialog:

Public Member Functions
	NetCdfConfigureDialog (const std::string &fileName, QDialog *parent=nullptr)
	~NetCdfConfigureDialog () override
MeshLib::Mesh *	getMesh ()
std::string	getName ()
VtkGeoImageSource *	getRaster ()

Private Slots
void	accept () override
void	reject () override
void	on_comboBoxVariable_currentIndexChanged (int id)
void	on_comboBoxDim1_currentIndexChanged (int id)
void	on_comboBoxDim2_currentIndexChanged (int id)
void	on_comboBoxDim3_currentIndexChanged (int id)
void	on_comboBoxDim4_currentIndexChanged (int id)
void	on_radioMesh_toggled (bool isTrue)

Private Member Functions
int	setVariableSelect ()
void	setDimensionSelect ()
void	getDimEdges (std::string const &name, unsigned &size, double &firstValue, double &lastValue)
void	createDataObject ()
int	getTimeStep () const
int	getDim4 () const
double	getResolution ()
QString	setName ()
void	reverseNorthSouth (double *data, std::size_t width, std::size_t height)

Private Attributes
netCDF::NcFile	_currentFile
netCDF::NcVar	_currentVar
std::unique_ptr< MeshLib::Mesh >	_currentMesh
VtkGeoImageSource *	_currentRaster
std::string	_currentPath

Constructor & Destructor Documentation

NetCdfConfigureDialog()

NetCdfConfigureDialog::NetCdfConfigureDialog ( const std::string & fileName, QDialog * parent = nullptr )

explicit

Definition at line 28 of file NetCdfConfigureDialog.cpp.

    : QDialog(parent),
      _currentFile(fileName.c_str(), NcFile::read),
      _currentMesh(nullptr),
      _currentRaster(nullptr),
      _currentPath(fileName)
{
    setupUi(this);
 
    int const idx =
        setVariableSelect();  // set up variables of the file in the combobox
    comboBoxVariable->setCurrentIndex(
        idx);  // pre-select the variable with the biggest number of
               // dimensions...valueWithMaxDim()
    _currentVar =
        _currentFile.getVar(comboBoxVariable->itemText(idx).toStdString());
 
    setDimensionSelect();
 
    lineEditName->setText(setName());
 
    this->radioMesh->setChecked(true);
}

References _currentFile, _currentVar, setDimensionSelect(), setName(), and setVariableSelect().

~NetCdfConfigureDialog()

NetCdfConfigureDialog::~NetCdfConfigureDialog ( )

override

Definition at line 53 of file NetCdfConfigureDialog.cpp.

{
    _currentMesh.release();
}

References _currentMesh.

Member Function Documentation

accept

void NetCdfConfigureDialog::accept ( )

overrideprivateslot

Definition at line 59 of file NetCdfConfigureDialog.cpp.

{
    QMessageBox valueErrorBox;
    if (_currentVar.getDimCount() < 2)
    {
        valueErrorBox.setText("Selected Variable has not enough dimensions.");
        valueErrorBox.exec();
    }
    else if (doubleSpinBoxDim2Start->value() ==
             doubleSpinBoxDim2Start->maximum())
    {
        valueErrorBox.setText("Lon has invalid extend.");
        valueErrorBox.exec();
    }
    else if (doubleSpinBoxDim1Start->value() ==
             doubleSpinBoxDim1Start->maximum())
    {
        valueErrorBox.setText("Lat has invalid extend.");
        valueErrorBox.exec();
    }
    else
    {
        createDataObject();
        this->done(QDialog::Accepted);
    }
}

References _currentVar, and createDataObject().

createDataObject()

void NetCdfConfigureDialog::createDataObject ( )

private

Definition at line 283 of file NetCdfConfigureDialog.cpp.

{
    double originLon = 0, originLat = 0;
    double lastLon = 0, lastLat = 0;
    unsigned sizeLon = 0, sizeLat = 0;
    std::string const dim1_name = comboBoxDim1->currentText().toStdString();
    getDimEdges(dim1_name, sizeLat, originLat, lastLat);
    std::string const dim2_name = comboBoxDim2->currentText().toStdString();
    getDimEdges(dim2_name, sizeLon, originLon, lastLon);
 
    // set up array
    std::vector<double> data_array(sizeLat * sizeLon, 0);
 
    std::vector<std::size_t> data_origin;
    std::vector<std::size_t> data_length;
 
    if (_currentVar.getDimCount() > 2)
    {
        // time
        data_origin.push_back(getTimeStep());
        data_length.push_back(1);
        // 3rd dimension
        if (_currentVar.getDimCount() > 3)
        {
            data_origin.push_back(getDim4());
            data_length.push_back(1);
        }
    }
 
    data_origin.push_back(0);  // x-origin
    data_origin.push_back(0);  // y-origin
    data_length.push_back(sizeLat);
    data_length.push_back(sizeLon);
    _currentVar.getVar(data_origin, data_length, data_array.data());
 
    std::replace_if(
        data_array.begin(), data_array.end(),
        [](double const& x) { return x <= -9999; }, -9999);
 
    double origin_x = (originLon < lastLon) ? originLon : lastLon;
    double origin_y = (originLat < lastLat) ? originLat : lastLat;
    MathLib::Point3d origin(std::array<double, 3>{{origin_x, origin_y, 0}});
    double resolution = (doubleSpinBoxResolution->value());
 
    if (originLat >
        lastLat)  // reverse lines in vertical direction if the original file
                  // has its origin in the northwest corner
        this->reverseNorthSouth(data_array.data(), sizeLon, sizeLat);
 
    GeoLib::RasterHeader const header = {sizeLon, sizeLat,    1,
                                         origin,  resolution, -9999};
    if (this->radioMesh->isChecked())
    {
        MeshLib::MeshElemType meshElemType = MeshLib::MeshElemType::QUAD;
        MeshLib::UseIntensityAs useIntensity =
            MeshLib::UseIntensityAs::DATAVECTOR;
        if (comboBoxMeshElemType->currentIndex() == 1)
        {
            meshElemType = MeshLib::MeshElemType::TRIANGLE;
        }
        else
        {
            meshElemType = MeshLib::MeshElemType::QUAD;
        }
        if ((comboBoxUseIntensity->currentIndex()) == 1)
        {
            useIntensity = MeshLib::UseIntensityAs::ELEVATION;
        }
        else
        {
            useIntensity = MeshLib::UseIntensityAs::DATAVECTOR;
        }
        _currentMesh = MeshToolsLib::RasterToMesh::convert(
            data_array.data(), header, meshElemType, useIntensity,
            _currentVar.getName());
    }
    else
    {
        vtkImageImport* image =
            VtkRaster::loadImageFromArray(data_array.data(), header);
        _currentRaster = VtkGeoImageSource::New();
        _currentRaster->setImage(image,
                                 QString::fromStdString(this->getName()));
    }
}

References _currentMesh, _currentRaster, _currentVar, MeshToolsLib::RasterToMesh::convert(), MeshLib::DATAVECTOR, MeshLib::ELEVATION, getDim4(), getDimEdges(), getName(), getTimeStep(), VtkRaster::loadImageFromArray(), VtkGeoImageSource::New(), MeshLib::QUAD, reverseNorthSouth(), VtkGeoImageSource::setImage(), and MeshLib::TRIANGLE.

Referenced by accept().

getDim4()

int NetCdfConfigureDialog::getDim4 ( ) const

private

Definition at line 247 of file NetCdfConfigureDialog.cpp.

{
    NcVar const& dim3Var =
        _currentFile.getVar(comboBoxDim4->currentText().toStdString());
    std::vector<std::size_t> start{
        static_cast<std::size_t>(spinBoxDim4->value())};
    int value(0);
    dim3Var.getVar(start, {1}, &value);
    if (value < 0)
        value = 0;  // if the value isn't found in the array, set it to 0 as
                    // default...
    return value;
}

References _currentFile.

Referenced by createDataObject().

getDimEdges()

void NetCdfConfigureDialog::getDimEdges ( std::string const & name, unsigned & size, double & firstValue, double & lastValue )

private

Definition at line 224 of file NetCdfConfigureDialog.cpp.

{
    size = 0;
    firstValue = 0;
    lastValue = 0;
    if (_currentFile.getVar(name).isNull())
        return;
 
    NcVar const& tmpVarOfDim = _currentFile.getVar(name);
    if ((tmpVarOfDim.getDimCount()) == 1)
    {
        size = tmpVarOfDim.getDim(0).getSize();
        tmpVarOfDim.getVar({0}, {1}, &firstValue);
        tmpVarOfDim.getVar({size - 1}, {1}, &lastValue);
    }
}

References _currentFile.

Referenced by createDataObject(), getResolution(), on_comboBoxDim1_currentIndexChanged(), on_comboBoxDim2_currentIndexChanged(), on_comboBoxDim3_currentIndexChanged(), and on_comboBoxDim4_currentIndexChanged().

getMesh()

MeshLib::Mesh * NetCdfConfigureDialog::getMesh ( )

inline

Definition at line 37 of file NetCdfConfigureDialog.h.

{ return _currentMesh.get(); };

References _currentMesh.

Referenced by MainWindow::loadFile().

getName()

std::string NetCdfConfigureDialog::getName

(

)

Definition at line 378 of file NetCdfConfigureDialog.cpp.

{
    std::string name = (lineEditName->text()).toStdString();
    QString const date = QString::number(dateTimeEditDim3->value());
    name.append(" - ").append(date.toStdString());
    return name;
}

Referenced by createDataObject(), and MainWindow::loadFile().

getRaster()

VtkGeoImageSource * NetCdfConfigureDialog::getRaster ( )

inline

Definition at line 39 of file NetCdfConfigureDialog.h.

{ return _currentRaster; };

References _currentRaster.

Referenced by VtkCompositeTextureOnSurfaceFilter::init(), and MainWindow::loadFile().

getResolution()

double NetCdfConfigureDialog::getResolution ( )

private

Definition at line 261 of file NetCdfConfigureDialog.cpp.

{
    if (comboBoxDim1->currentIndex() > -1)
    {
        NcVar const& var =
            _currentFile.getVar(comboBoxDim1->currentText().toStdString());
        double firstValue = 0, lastValue = 0;
        unsigned size = 0;
        getDimEdges(var.getName(), size, firstValue, lastValue);
        if (size < 2)
        {
            return 1;
        }
 
        double interval = fabs(lastValue - firstValue);
        double resolution = (double)interval / (size - 1);
        return resolution;
    }
 
    return 0;
}

References _currentFile, and getDimEdges().

Referenced by on_comboBoxDim1_currentIndexChanged().

getTimeStep()

int NetCdfConfigureDialog::getTimeStep ( ) const

private

Definition at line 242 of file NetCdfConfigureDialog.cpp.

{
    return dateTimeEditDim3->value();
}

Referenced by createDataObject().

on_comboBoxDim1_currentIndexChanged

void NetCdfConfigureDialog::on_comboBoxDim1_currentIndexChanged ( int id )

privateslot

Definition at line 100 of file NetCdfConfigureDialog.cpp.

{
    double firstValue = 0, lastValue = 0;
    unsigned size = 0;
    getDimEdges(comboBoxDim1->currentText().toStdString(), size, firstValue,
                lastValue);
    doubleSpinBoxDim1Start->setValue(firstValue);
    doubleSpinBoxDim1End->setValue(lastValue);
    doubleSpinBoxResolution->setValue(getResolution());
}

References getDimEdges(), and getResolution().

Referenced by setDimensionSelect().

on_comboBoxDim2_currentIndexChanged

void NetCdfConfigureDialog::on_comboBoxDim2_currentIndexChanged ( int id )

privateslot

Definition at line 112 of file NetCdfConfigureDialog.cpp.

{
    if (_currentVar.getDimCount() > 1)
    {
        double firstValue = 0, lastValue = 0;
        unsigned size = 0;
        getDimEdges(comboBoxDim2->currentText().toStdString(), size, firstValue,
                    lastValue);
        doubleSpinBoxDim2Start->setValue(firstValue);
        doubleSpinBoxDim2End->setValue(lastValue);
    }
}

References _currentVar, and getDimEdges().

Referenced by setDimensionSelect().

on_comboBoxDim3_currentIndexChanged

void NetCdfConfigureDialog::on_comboBoxDim3_currentIndexChanged ( int id )

privateslot

Definition at line 126 of file NetCdfConfigureDialog.cpp.

{
    if (_currentVar.getDimCount() > 2)
    {
        double firstValue = 0, lastValue = 0;
        unsigned size = 0;
        getDimEdges(comboBoxDim3->currentText().toStdString(), size, firstValue,
                    lastValue);
        dateTimeEditDim3->setValue(static_cast<int>(firstValue));
        dateTimeEditDim3->setMinimum(static_cast<int>(firstValue));
        dateTimeEditDim3->setMaximum(static_cast<int>(lastValue));
        lineEditName->setText(setName());
    }
}

References _currentVar, getDimEdges(), and setName().

Referenced by setDimensionSelect().

on_comboBoxDim4_currentIndexChanged

void NetCdfConfigureDialog::on_comboBoxDim4_currentIndexChanged ( int id )

privateslot

Definition at line 142 of file NetCdfConfigureDialog.cpp.

{
    if (_currentVar.getDimCount() > 3)
    {
        double firstValue = 0, lastValue = 0;
        unsigned size = 0;
        getDimEdges(comboBoxDim4->currentText().toStdString(), size, firstValue,
                    lastValue);
        spinBoxDim4->setValue(static_cast<int>(firstValue));
        spinBoxDim4->setMinimum(static_cast<int>(firstValue));
        spinBoxDim4->setMaximum(static_cast<int>(lastValue));
    }
}

References _currentVar, and getDimEdges().

Referenced by setDimensionSelect().

on_comboBoxVariable_currentIndexChanged

void NetCdfConfigureDialog::on_comboBoxVariable_currentIndexChanged ( int id )

privateslot

Definition at line 92 of file NetCdfConfigureDialog.cpp.

{
    std::string const var_name = comboBoxVariable->currentText().toStdString();
    _currentVar = _currentFile.getVar(var_name);
    setDimensionSelect();
}

References _currentFile, _currentVar, and setDimensionSelect().

on_radioMesh_toggled

void NetCdfConfigureDialog::on_radioMesh_toggled ( bool isTrue )

privateslot

Definition at line 408 of file NetCdfConfigureDialog.cpp.

{
    if (isTrue)  // output set to "mesh"
    {
        this->label_2->setEnabled(true);
        this->label_3->setEnabled(false);
        this->comboBoxMeshElemType->setEnabled(true);
        this->comboBoxUseIntensity->setEnabled(false);
    }
    else  // output set to "raster"
    {
        this->label_2->setEnabled(false);
        this->label_3->setEnabled(true);
        this->comboBoxMeshElemType->setEnabled(false);
        this->comboBoxUseIntensity->setEnabled(true);
    }
}

reject

void NetCdfConfigureDialog::reject ( )

overrideprivateslot

Definition at line 87 of file NetCdfConfigureDialog.cpp.

{
    this->done(QDialog::Rejected);
}

reverseNorthSouth()

void NetCdfConfigureDialog::reverseNorthSouth ( double * data, std::size_t width, std::size_t height )

private

Definition at line 386 of file NetCdfConfigureDialog.cpp.

{
    auto* cp_array = new double[width * height];
 
    for (std::size_t i = 0; i < height; i++)
    {
        for (std::size_t j = 0; j < width; j++)
        {
            std::size_t old_index((width * height) - (width * (i + 1)));
            std::size_t new_index(width * i);
            cp_array[new_index + j] = data[old_index + j];
        }
    }
 
    std::size_t length(height * width);
    for (std::size_t i = 0; i < length; i++)
        data[i] = cp_array[i];
 
    delete[] cp_array;
}

Referenced by createDataObject().

setDimensionSelect()

void NetCdfConfigureDialog::setDimensionSelect ( )

private

Definition at line 177 of file NetCdfConfigureDialog.cpp.

{
    int const dim_count = _currentVar.getDimCount();
    std::array<QComboBox*, 4> dim_box = {
        {comboBoxDim1, comboBoxDim2, comboBoxDim3, comboBoxDim4}};
 
    for (int i = 0; i < 4; ++i)
    {
        dim_box[i]->clear();
        dim_box[i]->setEnabled(i < dim_count);
    }
 
    // write dimension-names into selection-boxes
    for (int i = 0; i < dim_count; ++i)
    {
        for (int j = 0; j < dim_count; ++j)
        {
            dim_box[j]->addItem(
                QString::fromStdString(_currentVar.getDim(i).getName()));
        }
    }
    comboBoxDim1->setCurrentIndex(dim_count - 2);
    on_comboBoxDim1_currentIndexChanged(dim_count - 2);
    comboBoxDim2->setCurrentIndex(dim_count - 1);
    on_comboBoxDim2_currentIndexChanged(dim_count - 1);
    // time is only enabled if dim > 2
    dateTimeEditDim3->setEnabled(dim_count > 2);
    // 3rd data dimension is only enabled if dim > 3
    spinBoxDim4->setEnabled(dim_count > 3);
 
    if (dim_count > 2)
    {
        comboBoxDim3->setCurrentIndex(0);
        on_comboBoxDim3_currentIndexChanged(0);
    }
    else
        dateTimeEditDim3->setSingleStep(0);
 
    if (dim_count == 4)
    {
        comboBoxDim4->setCurrentIndex(1);
        on_comboBoxDim4_currentIndexChanged(1);
    }
    else
        spinBoxDim4->setValue(0);
}

References _currentVar, on_comboBoxDim1_currentIndexChanged(), on_comboBoxDim2_currentIndexChanged(), on_comboBoxDim3_currentIndexChanged(), and on_comboBoxDim4_currentIndexChanged().

Referenced by NetCdfConfigureDialog(), and on_comboBoxVariable_currentIndexChanged().

setName()

QString NetCdfConfigureDialog::setName ( )

private

Definition at line 369 of file NetCdfConfigureDialog.cpp.

{
    std::string name;
    name.append(_currentPath);
    name.erase(0, name.find_last_of("/") + 1);
    name.erase(name.find_last_of("."));
    return QString::fromStdString(name);
}

References _currentPath.

Referenced by NetCdfConfigureDialog(), and on_comboBoxDim3_currentIndexChanged().

setVariableSelect()

int NetCdfConfigureDialog::setVariableSelect ( )

private

Fills the combobox with all applicable variables and returns the index of the first variable with the highest dimension.

Definition at line 156 of file NetCdfConfigureDialog.cpp.

{
    int max_dim = 0;
    int max_dim_idx = 0;
    auto const& names = _currentFile.getVars();
    for (auto [name, var] : names)
    {
        int const var_dim_count = var.getDimCount();
        if (var_dim_count > 1)
        {
            comboBoxVariable->addItem(QString::fromStdString(name));
            if (var_dim_count > max_dim)
            {
                max_dim = var_dim_count;
                max_dim_idx = comboBoxVariable->count() - 1;
            }
        }
    }
    return max_dim_idx;
}

References _currentFile.

Referenced by NetCdfConfigureDialog().

Member Data Documentation

_currentFile

netCDF::NcFile NetCdfConfigureDialog::_currentFile

private

Definition at line 67 of file NetCdfConfigureDialog.h.

Referenced by NetCdfConfigureDialog(), getDim4(), getDimEdges(), getResolution(), on_comboBoxVariable_currentIndexChanged(), and setVariableSelect().

_currentMesh

std::unique_ptr<MeshLib::Mesh> NetCdfConfigureDialog::_currentMesh

private

Definition at line 69 of file NetCdfConfigureDialog.h.

Referenced by ~NetCdfConfigureDialog(), createDataObject(), and getMesh().

_currentPath

std::string NetCdfConfigureDialog::_currentPath

private

Definition at line 71 of file NetCdfConfigureDialog.h.

Referenced by setName().

_currentRaster

VtkGeoImageSource* NetCdfConfigureDialog::_currentRaster

private

Definition at line 70 of file NetCdfConfigureDialog.h.

Referenced by createDataObject(), and getRaster().

_currentVar

netCDF::NcVar NetCdfConfigureDialog::_currentVar

private

Definition at line 68 of file NetCdfConfigureDialog.h.

Referenced by NetCdfConfigureDialog(), accept(), createDataObject(), on_comboBoxDim2_currentIndexChanged(), on_comboBoxDim3_currentIndexChanged(), on_comboBoxDim4_currentIndexChanged(), on_comboBoxVariable_currentIndexChanged(), and setDimensionSelect().

---

The documentation for this class was generated from the following files:

• Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.h
• Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.cpp