IntensityDataIOFactory 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 = 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")

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

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, LoaderSelector selector=automatic)
	Reads file and returns newly created OutputData 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 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...

Member Enumeration Documentation

LoaderSelector

enum IntensityDataIOFactory::LoaderSelector

Enumerator
automatic
bornagain
tiff
nicos

Member Function Documentation

readIntensityData()

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

static

Reads file and returns newly created Histogram object.

readOutputData()

static OutputData<double>* IntensityDataIOFactory::readOutputData ( const std::string &  file_name, LoaderSelector  selector = automatic  )

static

Reads file and returns newly created OutputData 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.

readReflectometryData()

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

static

writeIntensityData()

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

static

Writes histogram in file.

writeOutputData()

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

static

Writes OutputData in file.

writeSimulationResult()

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

static

Writes OutputData contained in the given SimulationResult object.