IntensityDataIOFactory Class Reference

Provides users with possibility to read and write IntensityData from/to files in different format. More...

Static Public Member Functions
static IHistogram *	readIntensityData (const std::string &file_name)
	Reads file and returns newly created Histogram object. More...
static OutputData< double > *	readOutputData (const std::string &file_name)
	Reads file and returns newly created OutputData object. More...
static OutputData< double > *	readReflectometryData (const std::string &file_name)
static void	writeIntensityData (const IHistogram &histogram, const std::string &file_name)
	Writes histogram in file. More...
static void	writeOutputData (const OutputData< double > &data, const std::string &file_name)
	Writes OutputData in file. More...
static void	writeSimulationResult (const SimulationResult &result, const std::string &file_name)
	Writes OutputData contained in the given SimulationResult object. More...

Static Private Member Functions
static OutputData< double > *	readOutputData (const std::string &file_name, std::function< OutputData< double > *(std::istream &)> readData)
static void	writeOutputData (const std::string &file_name, std::function< void(std::ostream &)> writeData)

Detailed 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 = IntensityDataIOFactory.readIntensityData("filename.txt")
histogram = IntensityDataIOFactory.readIntensityData("filename.txt.gz")
 
# writing to 32-bits tiff file or b-zipped tiff file
IntensityDataIOFactory.writeIntensityData(histogram, "filename.tif")
IntensityDataIOFactory.writeIntensityData(histogram, "filename.tif.bz2")

Definition at line 47 of file IntensityDataIOFactory.h.

Member Function Documentation

readIntensityData()

IHistogram * IntensityDataIOFactory::readIntensityData ( const std::string &  file_name )

static

Reads file and returns newly created Histogram object.

Definition at line 61 of file IntensityDataIOFactory.cpp.

{
    std::unique_ptr<OutputData<double>> data(readOutputData(file_name));
    if (!data)
        throw std::runtime_error("Could not read " + file_name);
    return IHistogram::createHistogram(*data);
}

References IHistogram::createHistogram(), and readOutputData().

Referenced by IHistogram::createFrom(), and IHistogram::load().

Here is the call graph for this function:

readOutputData() [1/2]

OutputData< double > * IntensityDataIOFactory::readOutputData ( const std::string &  file_name )

static

Reads file and returns newly created OutputData object.

Definition at line 38 of file IntensityDataIOFactory.cpp.

{
    if (DataFormatUtils::isIntFile(file_name))
        return readOutputData(
            file_name, [](std::istream& s) { return OutputDataReadWriteINT().readOutputData(s); });
#ifdef BORNAGAIN_TIFF_SUPPORT
    if (DataFormatUtils::isTiffFile(file_name))
        return readOutputData(
            file_name, [](std::istream& s) { return OutputDataReadWriteTiff().readOutputData(s); });
#endif
    // 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.
    return readOutputData(
        file_name, [](std::istream& s) { return OutputDataReadWriteNumpyTXT().readOutputData(s); });
}

References DataFormatUtils::isIntFile(), DataFormatUtils::isTiffFile(), OutputDataReadWriteINT::readOutputData(), and OutputDataReadWriteNumpyTXT::readOutputData().

Referenced by HistoUtils::agreesWithReference(), ImportDataUtils::ImportKnownData(), DataItem::load(), PointwiseAxisItem::load(), readIntensityData(), and readReflectometryData().

Here is the call graph for this function:

readOutputData() [2/2]

OutputData< double > * IntensityDataIOFactory::readOutputData ( const std::string &  file_name, std::function< OutputData< double > *(std::istream &)>  readData  )

staticprivate

Definition at line 140 of file IntensityDataIOFactory.cpp.

{
 
    if (!FileSystemUtils::IsFileExists(file_name))
        return nullptr;
 
    using namespace DataFormatUtils;
    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(FileSystemUtils::convert_utf8_to_utf16(file_name), openmode);
#else
    input_stream.open(file_name, openmode);
#endif
 
    if (!input_stream.is_open())
        throw std::runtime_error(
            "IntensityDataIOFactory::getFromFilteredStream() -> Error. Can't open file '"
            + file_name + "' for reading.");
    if (!input_stream.good())
        throw std::runtime_error("IntensityDataIOFactory::getFromFilteredStream() -> Error! "
                                 "File is not good, probably it is a directory.");
 
    boost::iostreams::filtering_streambuf<boost::iostreams::input> input_filtered;
    if (DataFormatUtils::isGZipped(file_name))
        input_filtered.push(boost::iostreams::gzip_decompressor());
    else if (DataFormatUtils::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 FileSystemUtils::convert_utf8_to_utf16(), DataFormatUtils::isBZipped(), DataFormatUtils::isCompressed(), FileSystemUtils::IsFileExists(), DataFormatUtils::isGZipped(), and DataFormatUtils::isTiffFile().

Here is the call graph for this function:

readReflectometryData()

OutputData< double > * IntensityDataIOFactory::readReflectometryData ( const std::string &  file_name )

static

Definition at line 55 of file IntensityDataIOFactory.cpp.

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

References readOutputData(), and OutputDataReadReflectometry::readOutputData().

Referenced by ImportDataUtils::ImportReflectometryData().

Here is the call graph for this function:

writeIntensityData()

void IntensityDataIOFactory::writeIntensityData ( const IHistogram &  histogram, const std::string &  file_name  )

static

Writes histogram in file.

Definition at line 125 of file IntensityDataIOFactory.cpp.

{
    std::unique_ptr<OutputData<double>> data(histogram.createOutputData());
    writeOutputData(*data, file_name);
}

References IHistogram::createOutputData(), and writeOutputData().

Referenced by IHistogram::save().

Here is the call graph for this function:

writeOutputData() [1/2]

void IntensityDataIOFactory::writeOutputData ( const OutputData< double > &  data, const std::string &  file_name  )

static

Writes OutputData in file.

Definition at line 69 of file IntensityDataIOFactory.cpp.

{
    if (DataFormatUtils::isIntFile(file_name))
        writeOutputData(
            file_name, [&](std::ostream& s) { OutputDataReadWriteINT().writeOutputData(data, s); });
#ifdef BORNAGAIN_TIFF_SUPPORT
    else if (DataFormatUtils::isTiffFile(file_name))
        writeOutputData(file_name, [&](std::ostream& s) {
            OutputDataReadWriteTiff().writeOutputData(data, s);
        });
#endif
    else
        writeOutputData(file_name, [&](std::ostream& s) {
            OutputDataReadWriteNumpyTXT().writeOutputData(data, s);
        });
}

References DataFormatUtils::isIntFile(), DataFormatUtils::isTiffFile(), OutputDataReadWriteINT::writeOutputData(), and OutputDataReadWriteNumpyTXT::writeOutputData().

Referenced by DataItem::save(), PointwiseAxisItem::save(), SavePlotAssistant::saveToFile(), writeIntensityData(), and writeSimulationResult().

Here is the call graph for this function:

writeOutputData() [2/2]

void IntensityDataIOFactory::writeOutputData ( const std::string &  file_name, std::function< void(std::ostream &)>  writeData  )

staticprivate

Definition at line 87 of file IntensityDataIOFactory.cpp.

{
    using namespace DataFormatUtils;
 
    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(FileSystemUtils::convert_utf8_to_utf16(file_name), openmode);
#else
    fout.open(file_name, openmode);
#endif
 
    if (!fout.is_open())
        throw std::runtime_error("IntensityDataIOFactory::writeOutputData() -> Error. "
                                 "Can't open file '"
                                 + file_name + "' for writing.");
    if (!fout.good())
        throw std::runtime_error("IntensityDataIOFactory::writeOutputData() -> Error! "
                                 "File is not good, probably it is a directory.");
    std::stringstream ss;
    writeData(ss);
 
    boost::iostreams::filtering_streambuf<boost::iostreams::input> input_filtered;
    if (DataFormatUtils::isGZipped(file_name))
        input_filtered.push(boost::iostreams::gzip_compressor());
    else if (DataFormatUtils::isBZipped(file_name))
        input_filtered.push(boost::iostreams::bzip2_compressor());
    input_filtered.push(ss);
 
    boost::iostreams::copy(input_filtered, fout);
 
    fout.close();
}

References FileSystemUtils::convert_utf8_to_utf16(), DataFormatUtils::isBZipped(), DataFormatUtils::isCompressed(), DataFormatUtils::isGZipped(), and DataFormatUtils::isTiffFile().

Here is the call graph for this function:

writeSimulationResult()

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

static

Writes OutputData contained in the given SimulationResult object.

Definition at line 132 of file IntensityDataIOFactory.cpp.

{
    auto data = result.data();
    writeOutputData(*data, file_name);
}

References SimulationResult::data(), and writeOutputData().

Here is the call graph for this function:

---

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

• /home/www/ba/Device/Histo/IntensityDataIOFactory.h
• /home/www/ba/Device/Histo/IntensityDataIOFactory.cpp