IntensityDataIOFactory Class Reference

Collaboration diagram for IntensityDataIOFactory:

Static Public Member Functions
static OutputData< double > *	readOutputData (const std::string &file_name)
static OutputData< double > *	readReflectometryData (const std::string &file_name)
static IHistogram *	readIntensityData (const std::string &file_name)
static void	writeOutputData (const OutputData< double > &data, const std::string &file_name)
static void	writeIntensityData (const IHistogram &histogram, const std::string &file_name)
static void	writeSimulationResult (const SimulationResult &result, const std::string &file_name)

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 woth "*.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 46 of file IntensityDataIOFactory.h.

Member Function Documentation

readOutputData()

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

static

Reads file and returns newly created OutputData object.

Definition at line 25 of file IntensityDataIOFactory.cpp.

{
    if (!FileSystemUtils::IsFileExists(file_name))
        return nullptr;
    std::unique_ptr<OutputDataReader> reader(OutputDataReadFactory::getReader(file_name));
    if (reader)
        return reader->getOutputData();
    return nullptr;
}

References OutputDataReadFactory::getReader(), and FileSystemUtils::IsFileExists().

Referenced by readIntensityData().

Here is the call graph for this function:

readReflectometryData()

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

static

Definition at line 35 of file IntensityDataIOFactory.cpp.

{
    if (!FileSystemUtils::IsFileExists(file_name))
        return nullptr;
    std::unique_ptr<OutputDataReader> reader(
        OutputDataReadFactory::getReflectometryReader(file_name));
    if (reader)
        return reader->getOutputData();
    return nullptr;
}

References OutputDataReadFactory::getReflectometryReader(), and FileSystemUtils::IsFileExists().

Here is the call graph for this function:

readIntensityData()

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

static

Reads file and returns newly created Histogram object.

Definition at line 46 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:

writeOutputData()

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

static

Writes OutputData in file.

Definition at line 54 of file IntensityDataIOFactory.cpp.

{
    auto* writer = OutputDataWriteFactory::getWriter(file_name);
    writer->writeOutputData(data);
    delete writer;
}

References OutputDataWriteFactory::getWriter().

Referenced by writeIntensityData(), and writeSimulationResult().

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 62 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:

writeSimulationResult()

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

static

Writes OutputData contained in the given SimulationResult object.

Definition at line 69 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