diff --git a/dumux/io/rasterimagereader.hh b/dumux/io/rasterimagereader.hh
index d3ff963332ae7406e14aba731b0bc42002b25c09..4ead3192f7a2ebbed232fee6396bdcced365605b 100644
--- a/dumux/io/rasterimagereader.hh
+++ b/dumux/io/rasterimagereader.hh
@@ -21,20 +21,21 @@
* \ingroup InputOutput
* \brief A simple reader class for raster images.
*/
- #ifndef DUMUX_RASTER_IMAGE_READER_HH
- #define DUMUX_RASTER_IMAGE_READER_HH
-
- #include <cassert>
- #include <string>
- #include <vector>
- #include <fstream>
- #include <sstream>
- #include <algorithm>
- #include <map>
- #include <iterator>
- #include <iostream>
-
- #include <dune/common/exceptions.hh>
+#ifndef DUMUX_RASTER_IMAGE_READER_HH
+#define DUMUX_RASTER_IMAGE_READER_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>
namespace Dumux {
@@ -108,11 +109,11 @@ public:
};
/*!
- * \brief A helper function to retrieve the format data from a given magic number.
+ * \brief A helper function to retrieve the format from tokens of the file's first line.
*
- * \param magicNumber The magic number contained in the header data of the file.
+ * \param firstLineTokes The tokens extracted from the first line of the file
*/
- static Format getFormat(const std::string& magicNumber)
+ static Format getFormat(const std::vector<std::string_view>& firstLineTokes)
{
static const auto format = []{
std::map<std::string, Format> format;
@@ -121,10 +122,12 @@ public:
format["P3"] = Format{"P3", "Portable PixMap", "ASCII"};
format["P4"] = Format{"P4", "Portable BitMap", "binary"};
format["P5"] = Format{"P5", "Portable GrayMap", "binary"};
- format["P5"] = Format{"P5", "Portable PixMap", "binary"};
+ format["P6"] = Format{"P6", "Portable PixMap", "binary"};
return format;
}();
+ const std::string& magicNumber = std::string(firstLineTokes[0]);
+
if (!format.count(magicNumber))
DUNE_THROW(Dune::IOError, magicNumber << " is not a valid magic number for the Netpbm format");
@@ -213,36 +216,70 @@ public:
{
HeaderData headerData;
std::string inputLine;
+ std::size_t lineNumber = 0;
// First line : get format.
std::getline(infile, inputLine);
- headerData.format = getFormat(inputLine);
+ ++lineNumber;
+
+ const auto firstLineTokens = tokenize(inputLine, " ");
+ headerData.format = getFormat(firstLineTokens);
const auto magicNumber = headerData.format.magicNumber;
- // Read dimensions and maximum value (for non-b/w images).
- while (!infile.eof())
+ // dimensions could be given right after magic number (in same line)
+ if (firstLineTokens.size() > 2)
{
- std::getline(infile, inputLine);
+ if (isBlackAndWhite_(magicNumber) && firstLineTokens.size() != 3)
+ DUNE_THROW(Dune::IOError, "Could not read first line for B/W image");
- auto isComment = [](const auto& s)
- { return (s.find("#") != std::string::npos); };
+ headerData.nCols = std::stoi(std::string(firstLineTokens[1]));
+ headerData.nRows = std::stoi(std::string(firstLineTokens[2]));
- // Skip comments.
- if (isComment(inputLine))
- continue;
-
- // The first line after the comments contains the dimensions.
- headerData.nCols = std::stoi(inputLine.substr(0, inputLine.find(" ")));
- headerData.nRows = std::stoi(inputLine.substr(inputLine.find(" ") + 1));
-
- // Grayscale images additionaly contain a maxium value in the header.
- if (magicNumber != "P1" && magicNumber != "P4")
+ if (isGrayScale_(magicNumber))
+ {
+ if (firstLineTokens.size() == 4)
+ headerData.maxValue = std::stoi(std::string(firstLineTokens[3]));
+ if (firstLineTokens.size() > 4)
+ DUNE_THROW(Dune::IOError, "Could not read first line for grayscale image");
+ }
+ }
+ else
+ {
+ // Read dimensions and maximum value (for non-b/w images).
+ while (!infile.eof())
{
std::getline(infile, inputLine);
- headerData.maxValue = std::stoi(inputLine);
+ ++lineNumber;
+
+ // Skip comments.
+ if (isComment_(inputLine))
+ continue;
+
+ const auto tokens = tokenize(inputLine, " ");
+
+ // The first line after the comments contains the dimensions.
+ if (tokens.size() != 2)
+ DUNE_THROW(Dune::IOError, "Expecting " << [](auto size){ return size < 2 ? "both" : "only"; }(tokens.size()) << " dimensions (2 numbers) in line " << lineNumber);
+
+ headerData.nCols = std::stoi(std::string(tokens[0]));
+ headerData.nRows = std::stoi(std::string(tokens[1]));
+
+ // Grayscale images additionaly contain a maxium value in the header.
+ if (isGrayScale_(magicNumber))
+ {
+ std::getline(infile, inputLine);
+ ++lineNumber;
+
+ const auto token = tokenize(inputLine, " ");
+ if (token.size() != 1)
+ DUNE_THROW(Dune::IOError, "Expecting" << [](auto size){ return size == 0 ? "" : " only"; }(token.size()) << " intensity (one number) in line " << lineNumber);
+
+ headerData.maxValue = std::stoi(std::string(token[0]));
+ }
+ break;
}
- break;
}
+
return headerData;
}
@@ -324,6 +361,17 @@ public:
}
private:
+
+ static bool isBlackAndWhite_(const std::string& magicNumber)
+ {
+ return magicNumber == "P1" || magicNumber == "P4";
+ }
+
+ static bool isGrayScale_(const std::string& magicNumber)
+ {
+ return magicNumber == "P2" || magicNumber == "P5";
+ }
+
/*!
* \brief Reads the data block of a *.pbm (black and white) file in ASCII encoding.
* Returns a vector that contains the pixel values.
@@ -342,14 +390,16 @@ private:
while (!infile.eof())
{
std::getline(infile, inputLine);
- inputLine.erase(std::remove(inputLine.begin(), inputLine.end(), '\n'), inputLine.end());
- inputLine.erase(std::remove(inputLine.begin(), inputLine.end(), ' '), inputLine.end());
- if (!inputLine.empty())
+ if (!isComment_(inputLine))
{
- for (const auto& value : inputLine)
+ inputLine.erase(std::remove_if(inputLine.begin(), inputLine.end(), [](unsigned char c){ return std::isspace(c); }), inputLine.end());
+ if (!inputLine.empty())
{
- assert(value == '0' || value == '1');
- data.push_back(value - '0'); // convert char to int
+ for (const auto& value : inputLine)
+ {
+ assert(value == '0' || value == '1');
+ data.push_back(value - '0'); // convert char to int
+ }
}
}
}
@@ -370,6 +420,28 @@ private:
{
std::vector<bool> data(numPixel_(headerData));
+ // Skip potentially remaining comments in header section
+ // before reading binary content. We detect a comment by
+ // reading a line with std::getline and checking the resulting string.
+ // We continue reading new lines until no more comments are found. Then we
+ // need to set infile's current position to one line before the actual binary
+ // content, otherwise the following steps will fail.
+ std::string inputLine;
+ while (!infile.eof())
+ {
+ // store position before calling std::getline
+ const auto lastPos = infile.tellg();
+ std::getline(infile, inputLine);
+
+ // stop the loop if no more comment is found and go back one line
+ if (!isComment_(inputLine))
+ {
+ infile.seekg(lastPos);
+ break;
+ }
+ }
+
+ // read actual binary content
std::size_t nBytes = 0;
std::size_t bitIndex = 0;
using Bit = std::uint8_t;
@@ -489,6 +561,14 @@ private:
{
return headerData.nRows*headerData.nCols;
}
+
+ /*!
+ * \brief Returns true if a given line is a comment (starting with #)
+ */
+ static bool isComment_(const std::string_view line)
+ {
+ return line[0] == '#';
+ }
};
} // namespace Dumux
diff --git a/test/io/rasterimagereader/CMakeLists.txt b/test/io/rasterimagereader/CMakeLists.txt
index 5dbae8b4668c1c53fbcbde51e0c7c5098e8801f7..3488e608f14d42942adc6dbc8921d052c344d68c 100644
--- a/test/io/rasterimagereader/CMakeLists.txt
+++ b/test/io/rasterimagereader/CMakeLists.txt
@@ -1,4 +1,7 @@
-dune_symlink_to_source_files(FILES blackwhite_j.pbm blackwhite_binary_j.pbm blackwhite_j.txt grayscale_j.pgm grayscale_binary_j.pgm grayscale_j.txt)
+dune_symlink_to_source_files(FILES blackwhite_j.pbm blackwhite_binary_j.pbm blackwhite_j.txt
+ grayscale_j.pgm grayscale_binary_j.pgm grayscale_j.txt
+ blackwhite_dim_firstline.pbm blackwhite_dim_firstline_binary.pbm
+ blackwhite_fail.pbm grayscale_fail_binary.pgm)
dumux_add_test(NAME test_io_rasterimagereader
SOURCES test_rasterimagereader.cc
diff --git a/test/io/rasterimagereader/blackwhite_dim_firstline.pbm b/test/io/rasterimagereader/blackwhite_dim_firstline.pbm
new file mode 100644
index 0000000000000000000000000000000000000000..adfff86bbadc3c71ce58dc34a0f8244f693e126e
--- /dev/null
+++ b/test/io/rasterimagereader/blackwhite_dim_firstline.pbm
@@ -0,0 +1,5 @@
+P1 2 2
+# delete this
+1 0
+# delete this
+0 1
diff --git a/test/io/rasterimagereader/blackwhite_dim_firstline_binary.pbm b/test/io/rasterimagereader/blackwhite_dim_firstline_binary.pbm
new file mode 100644
index 0000000000000000000000000000000000000000..2dddbeb48381d3907f80f9230cbd198b30d8ce2d
--- /dev/null
+++ b/test/io/rasterimagereader/blackwhite_dim_firstline_binary.pbm
@@ -0,0 +1,3 @@
+P4 2 2
+# dimensions given in first line
+€@
diff --git a/test/io/rasterimagereader/blackwhite_fail.pbm b/test/io/rasterimagereader/blackwhite_fail.pbm
new file mode 100644
index 0000000000000000000000000000000000000000..b3f1c44cdb15ca4e3ef3758308a9d7bf92cd64b2
--- /dev/null
+++ b/test/io/rasterimagereader/blackwhite_fail.pbm
@@ -0,0 +1,5 @@
+P1
+# we expect this to fail because line three contains more than just the two dimensions
+2 2 1
+0
+0 1
diff --git a/test/io/rasterimagereader/grayscale_fail_binary.pgm b/test/io/rasterimagereader/grayscale_fail_binary.pgm
new file mode 100644
index 0000000000000000000000000000000000000000..225e05dc7e2dfb44c6d4f509addeeb22d36cfa0c
Binary files /dev/null and b/test/io/rasterimagereader/grayscale_fail_binary.pgm differ
diff --git a/test/io/rasterimagereader/test_rasterimagereader.cc b/test/io/rasterimagereader/test_rasterimagereader.cc
index f4cc8b7028f3532f232cba0b77e37ef8e2c6774d..491a4fab09ea6e18cfe7ea19315121b5f60fbba3 100644
--- a/test/io/rasterimagereader/test_rasterimagereader.cc
+++ b/test/io/rasterimagereader/test_rasterimagereader.cc
@@ -90,6 +90,35 @@ int main(int argc, char** argv)
std::cout << std::endl;
+ // test file where the dimensions are given in the same line as the magic number and comments are present
+ const std::vector<bool> reference{1,0,0,1};
+
+ if (!isEqual(reference, NetPBMReader::readPBM("blackwhite_dim_firstline.pbm", false)))
+ {
+ std::cout << "Reading black/white with dimension in first line failed" << std::endl;
+ return 1;
+ }
+ if (!isEqual(reference, NetPBMReader::readPBM("blackwhite_dim_firstline.pbm", false)))
+ {
+ std::cout << "Reading black/white (binary) with dimension in first line failed" << std::endl;
+ return 1;
+ }
+
+ // test error message for poorly formatted file
+ try
+ {
+ NetPBMReader::readPBM("blackwhite_fail.pbm", false);
+ }
+ catch(const Dune::IOError& e)
+ {
+ const auto tokens = tokenize(e.what(), "]:");
+ if (tokens.back() != " Expecting only dimensions (2 numbers) in line 3")
+ {
+ std::cout << e.what() << std::endl;
+ return 1;
+ }
+ }
+
//////////////////////////////////////////////////
// Test the gray scale image reader
//////////////////////////////////////////////////
@@ -126,5 +155,20 @@ int main(int argc, char** argv)
return 1;
}
+ // test error message for poorly formatted file
+ try
+ {
+ NetPBMReader::readPBM("grayscale_fail_binary.pgm", false);
+ }
+ catch(const Dune::IOError& e)
+ {
+ const auto tokens = tokenize(e.what(), "]:");
+ if (tokens.back() != " Expecting only intensity (one number) in line 4")
+ {
+ std::cout << e.what() << std::endl;
+ return 1;
+ }
+ }
+
return 0;
}