IOFactory Class Reference

Description

Provides users with possibility to read and write IntensityData from/to files in different format. Type of the file will be deduced from file name. *.txt - ASCII file with 2D array [nrow][ncol], layout as in numpy. *.int - BornAgain internal ASCII format. *.tif - 32-bits tiff file. If file name ends with "*.gz" or "*.bz2" the file will be zipped on the fly using appropriate algorithm.

Usage:

# reading from ASCII file or g-zipped ASCII file
histogram = IOFactory.readDatafield("filename.txt")
histogram = IOFactory.readDatafield("filename.txt.gz")
 
# writing to 32-bits tiff file or b-zipped tiff file
IOFactory.writeIntensityData(histogram, "filename.tif")
IOFactory.writeIntensityData(histogram, "filename.tif.bz2")

Definition at line 46 of file IOFactory.h.

Public Types
enum	LoaderSelector { automatic , bornagain , tiff , nicos }

Static Public Member Functions
static Datafield *	readDatafield (const std::string &file_name, LoaderSelector selector=automatic)
	Reads file and returns newly created Datafield object. If selector is automatic, then the file extension will be used to determine which file type to load. If selector is not automatic, then this selector will define which type of file to load (no matter which file extension or content). May throw, but will never return nullptr. More...
static Datafield *	readReflectometryData (const std::string &file_name)
static void	writeDatafield (const Datafield &data, const std::string &file_name)
	Writes Datafield in file. More...
static void	writeSimulationResult (const SimulationResult &result, const std::string &file_name)
	Writes Datafield contained in the given SimulationResult object. More...

Static Private Member Functions
static bool	fileTypeMatchesLoaderSelector (const std::string &fileName, LoaderSelector selector)
static Datafield *	readDatafield (const std::string &file_name, std::function< Datafield *(std::istream &)> readData)
static void	writeDatafield (const std::string &file_name, std::function< void(std::ostream &)> writeData)

Member Enumeration Documentation

LoaderSelector

enum IOFactory::LoaderSelector

Enumerator
automatic
bornagain
tiff
nicos

Definition at line 48 of file IOFactory.h.

{ automatic, bornagain, tiff, nicos };

Member Function Documentation

fileTypeMatchesLoaderSelector()

bool IOFactory::fileTypeMatchesLoaderSelector ( const std::string &  fileName, LoaderSelector  selector  )

staticprivate

Definition at line 130 of file IOFactory.cpp.

{
    switch (selector) {
    case bornagain:
        return DataUtils::Format::isIntFile(fileName);
    case nicos:
        return DataUtils::Format::isNicosFile(fileName);
    case tiff:
        return DataUtils::Format::isTiffFile(fileName);
    case automatic:
        return false;
    }
 
    return false;
}

References automatic, bornagain, DataUtils::Format::isIntFile(), DataUtils::Format::isNicosFile(), DataUtils::Format::isTiffFile(), nicos, and tiff.

Referenced by readDatafield().

Here is the call graph for this function:

readDatafield() [1/2]

Datafield * IOFactory::readDatafield ( const std::string &  file_name, LoaderSelector  selector = automatic  )

static

Reads file and returns newly created Datafield object. If selector is automatic, then the file extension will be used to determine which file type to load. If selector is not automatic, then this selector will define which type of file to load (no matter which file extension or content). May throw, but will never return nullptr.

Definition at line 41 of file IOFactory.cpp.

{
    const auto readAs = [=](LoaderSelector testForSelector) {
        return (selector == testForSelector)
               || (selector == automatic
                   && fileTypeMatchesLoaderSelector(file_name, testForSelector));
    };
 
    Datafield* result = nullptr;
 
    if (readAs(bornagain))
        result = readDatafield(file_name,
                               [](std::istream& s) { return ReadWriteINT().readDatafield(s); });
 
    else if (readAs(nicos))
        result = readDatafield(file_name, [](std::istream& s) { return IO::readNicosData(s); });
 
#ifdef BA_TIFF_SUPPORT
    else if (readAs(tiff))
        result = readDatafield(file_name,
                               [](std::istream& s) { return ReadWriteTiff().readDatafield(s); });
#endif
 
    else
        // Try to read ASCII by default. Binary maps to ASCII.
        // If the file is not actually a matrix of numbers,
        // the error will be thrown during the reading.
        result = readDatafield(
            file_name, [](std::istream& s) { return ReadWriteNumpyTXT().readDatafield(s); });
 
    ASSERT(result);
    return result;
}

References ASSERT, automatic, bornagain, fileTypeMatchesLoaderSelector(), nicos, ReadWriteINT::readDatafield(), ReadWriteNumpyTXT::readDatafield(), IO::readNicosData(), and tiff.

Referenced by IOUtil::filesAgree(), and readReflectometryData().

Here is the call graph for this function:

readDatafield() [2/2]

Datafield * IOFactory::readDatafield ( const std::string &  file_name, std::function< Datafield *(std::istream &)>  readData  )

staticprivate

Definition at line 152 of file IOFactory.cpp.

{
    if (!BaseUtils::Filesystem::IsFileExists(file_name))
        throw std::runtime_error("File does not exist: " + file_name);
 
    using namespace DataUtils::Format;
    std::ifstream input_stream;
    std::ios_base::openmode openmode = std::ios::in;
    if (isTiffFile(file_name) || isCompressed(file_name))
        openmode = std::ios::in | std::ios_base::binary;
 
#ifdef _WIN32
    input_stream.open(BaseUtils::Filesystem::convert_utf8_to_utf16(file_name), openmode);
#else
    input_stream.open(file_name, openmode);
#endif
 
    if (!input_stream.is_open())
        throw std::runtime_error("Cannot open file for reading: " + file_name);
    if (!input_stream.good())
        throw std::runtime_error("File is not good, probably it is a directory:" + file_name);
 
    boost::iostreams::filtering_streambuf<boost::iostreams::input> input_filtered;
    if (DataUtils::Format::isGZipped(file_name))
        input_filtered.push(boost::iostreams::gzip_decompressor());
    else if (DataUtils::Format::isBZipped(file_name))
        input_filtered.push(boost::iostreams::bzip2_decompressor());
    input_filtered.push(input_stream);
    // we use stringstream since it provides random access which is important for tiff files
    std::stringstream str;
    boost::iostreams::copy(input_filtered, str);
 
    return readData(str);
}

References BaseUtils::Filesystem::convert_utf8_to_utf16(), DataUtils::Format::isBZipped(), DataUtils::Format::isCompressed(), BaseUtils::Filesystem::IsFileExists(), DataUtils::Format::isGZipped(), and DataUtils::Format::isTiffFile().

Here is the call graph for this function:

readReflectometryData()

Datafield * IOFactory::readReflectometryData ( const std::string &  file_name )

static

Definition at line 75 of file IOFactory.cpp.

{
    return readDatafield(file_name,
                         [](std::istream& s) { return ReadReflectometry().readDatafield(s); });
}

References readDatafield(), and ReadReflectometry::readDatafield().

Here is the call graph for this function:

writeDatafield() [1/2]

void IOFactory::writeDatafield ( const Datafield &  data, const std::string &  file_name  )

static

Writes Datafield in file.

Definition at line 81 of file IOFactory.cpp.

{
    if (DataUtils::Format::isIntFile(file_name))
        writeDatafield(file_name, [&](std::ostream& s) { ReadWriteINT().writeDatafield(data, s); });
#ifdef BA_TIFF_SUPPORT
    else if (DataUtils::Format::isTiffFile(file_name))
        writeDatafield(file_name,
                       [&](std::ostream& s) { ReadWriteTiff().writeDatafield(data, s); });
#endif
    else
        writeDatafield(file_name,
                       [&](std::ostream& s) { ReadWriteNumpyTXT().writeDatafield(data, s); });
}

References DataUtils::Format::isIntFile(), DataUtils::Format::isTiffFile(), ReadWriteINT::writeDatafield(), and ReadWriteNumpyTXT::writeDatafield().

Referenced by writeSimulationResult().

Here is the call graph for this function:

writeDatafield() [2/2]

void IOFactory::writeDatafield ( const std::string &  file_name, std::function< void(std::ostream &)>  writeData  )

staticprivate

Definition at line 95 of file IOFactory.cpp.

{
    using namespace DataUtils::Format;
 
    std::ofstream fout;
    std::ios_base::openmode openmode = std::ios::out;
    if (isTiffFile(file_name) || isCompressed(file_name))
        openmode = std::ios::out | std::ios_base::binary;
 
#ifdef _WIN32
    fout.open(BaseUtils::Filesystem::convert_utf8_to_utf16(file_name), openmode);
#else
    fout.open(file_name, openmode);
#endif
 
    if (!fout.is_open())
        throw std::runtime_error("Cannot open file for writing: " + file_name);
    if (!fout.good())
        throw std::runtime_error("File is not good, probably it is a directory: " + file_name);
    std::stringstream ss;
    writeData(ss);
 
    boost::iostreams::filtering_streambuf<boost::iostreams::input> input_filtered;
    if (DataUtils::Format::isGZipped(file_name))
        input_filtered.push(boost::iostreams::gzip_compressor());
    else if (DataUtils::Format::isBZipped(file_name))
        input_filtered.push(boost::iostreams::bzip2_compressor());
    input_filtered.push(ss);
 
    boost::iostreams::copy(input_filtered, fout);
 
    fout.close();
}

References BaseUtils::Filesystem::convert_utf8_to_utf16(), DataUtils::Format::isBZipped(), DataUtils::Format::isCompressed(), DataUtils::Format::isGZipped(), and DataUtils::Format::isTiffFile().

Here is the call graph for this function:

writeSimulationResult()

void IOFactory::writeSimulationResult ( const SimulationResult &  result, const std::string &  file_name  )

static

Writes Datafield contained in the given SimulationResult object.

Definition at line 146 of file IOFactory.cpp.

{
    auto data = result.datafield();
    writeDatafield(*data, file_name); // TODO delete ptr
}

References SimulationResult::datafield(), and writeDatafield().

Here is the call graph for this function:

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/IO/IOFactory.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/IO/IOFactory.cpp