rasterimagewriter.hh

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
//
// SPDX-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_RASTER_IMAGE_WRITER_HH
#define DUMUX_RASTER_IMAGE_WRITER_HH
 
#include <cassert>
#include <string>
#include <vector>
#include <fstream>
#include <sstream>
#include <algorithm>
#include <map>
#include <iterator>
#include <iostream>
 
#include <dune/common/exceptions.hh>
#include <dumux/common/stringutilities.hh>
#include <dumux/io/rasterimagedata.hh>
 
namespace Dumux {
 
class NetPBMWriter
{
    template<typename T>
    using Result = Detail::RasterImageData::Result<T>;
 
    using HeaderData = Detail::RasterImageData::HeaderData;
 
public:
 
    template<class ValueType>
    static void write(const std::string& writeFileName,
                      Result<ValueType>& img,
                      const bool useDuneGridOrdering = true)
    {
        // Pass the image to the writer
        writeRasterImageFile_(writeFileName, img, useDuneGridOrdering);
    }
 
    template<class ValueType>
    static void write(const std::string& writeFileName,
                      const std::size_t& nCols,
                      const std::size_t& nRows,
                      const std::string& magicNumber,
                      const std::string& type,
                      const std::string& encoding,
                      const std::vector<ValueType>& img,
                      const bool useDuneGridOrdering = true)
    {
        // Fill header data and collect img data
        HeaderData headerData;
        headerData.nCols = nCols;
        headerData.nRows = nRows;
        headerData.format.magicNumber = magicNumber;
        Result<ValueType> result(std::move(img), std::move(headerData));
 
        writeRasterImageFile_(writeFileName, result, useDuneGridOrdering);
    }
 
 
    template<class T>
    static void applyDuneGridOrdering(Result<T>& result)
    {
        auto tmp = result;
        for (std::size_t i = 0; i < result.size(); i += result.header().nCols)
            std::swap_ranges((result.begin() + i), (result.begin() + i + result.header().nCols), (tmp.end() - i - result.header().nCols));
    }
 
private:
 
    template <class T>
    static void writeRasterImageFile_(const std::string& writeFileName,
                                      Result<T>& result,
                                      const bool useDuneGridOrdering = true)
    {
            // This will reverse any reordering
        if (useDuneGridOrdering)
            applyDuneGridOrdering(result);
 
        // Write the corrected image and header information to a file
        std::ofstream outfile(writeFileName, std::ios::trunc);
        outfile << result.header().format.magicNumber << "\n";
        outfile << result.header().nCols << " " << result.header().nRows << "\n";
        if ((result.header().format.magicNumber == "P2") || (result.header().format.magicNumber == "P5"))
        {
            for (int i = 0; i < result.size(); i++)
                outfile << result[i] << "\n";
        }
        else
        {
            for (int i = 0; i < result.size(); i++)
            {
                if (i % result.header().nCols == 0) // wrap once per row
                    outfile << "\n";
                outfile << result[i];
            }
        }
    }
 
};
 
} // namespace Dumux
 
#endif