DataFormatUtils Namespace Reference

Utility functions for data input and output. More...

Functions
std::unique_ptr< IAxis >	createAxis (std::istream &input_stream)
	Creates axis of certain type from input stream. More...
void	fillOutputData (OutputData< double > *data, std::istream &input_stream)
	Fills output data raw buffer from input stream. More...
std::string	GetFileMainExtension (const std::string &name)
	Returns file extension after stripping '.gz' if any. More...
bool	isBZipped (const std::string &name)
	Returns true if name contains *.bz2 extension. More...
bool	isCompressed (const std::string &name)
	Returns true if name contains *.gz extension. More...
bool	isGZipped (const std::string &name)
	Returns true if name contains *.gz extension. More...
bool	isIntFile (const std::string &file_name)
	returns true if file name corresponds to BornAgain native format (compressed or not) More...
bool	isTiffFile (const std::string &file_name)
	returns true if file name corresponds to tiff file (can be also compressed) More...
std::vector< double >	parse_doubles (const std::string &str)
	Parse double values from string to vector of double. More...
void	readLineOfDoubles (std::vector< double > &buffer, std::istringstream &iss)

Detailed Description

Utility functions for data input and output.

Function Documentation

createAxis()

std::unique_ptr< IAxis > DataFormatUtils::createAxis

(

std::istream &

input_stream

)

Creates axis of certain type from input stream.

Definition at line 89 of file DataFormatUtils.cpp.

{
    auto iss = getAxisStringRepresentation(input_stream);
    std::string type;
    if (!(iss >> type))
        throw std::runtime_error(
            "Error in DataFormatUtils::createAxis:: couldn't read axis type from input");
 
    for (auto iter = type_map.cbegin(); iter != type_map.end(); ++iter)
        if (iter->first == type)
            return iter->second(std::move(iss));
    throw std::runtime_error("Error in DataFormatUtils::createAxis:"
                             "Unknown axis type '"
                             + type + "'");
}

Referenced by OutputDataReadWriteINT::readOutputData().

fillOutputData()

void DataFormatUtils::fillOutputData	(	OutputData< double > *	data,
		std::istream &	input_stream
	)

Fills output data raw buffer from input stream.

Definition at line 106 of file DataFormatUtils.cpp.

{
    std::string line;
    data->setAllTo(0.0);
    OutputData<double>::iterator it = data->begin();
    while (std::getline(input_stream, line)) {
        if (line.empty() || line[0] == '#')
            break;
 
        std::istringstream iss(line);
        std::vector<double> buffer;
        readLineOfDoubles(buffer, iss);
        for (auto value : buffer) {
            *it = value;
            ++it;
        }
    }
    if (it != data->end())
        throw std::runtime_error("DataFormatUtils::fillOutputData() -> Error while parsing data.");
}

References OutputData< T >::begin(), OutputData< T >::end(), readLineOfDoubles(), and OutputData< T >::setAllTo().

Referenced by OutputDataReadWriteINT::readOutputData().

Here is the call graph for this function:

GetFileMainExtension()

std::string DataFormatUtils::GetFileMainExtension

(

const std::string &

name

)

Returns file extension after stripping '.gz' if any.

Returns file main extension (without .gz).

Definition at line 66 of file DataFormatUtils.cpp.

{
    std::string stripped_name(name);
    if (isGZipped(name)) {
        stripped_name = name.substr(0, name.size() - GzipExtension.size());
    } else if (isBZipped(name)) {
        stripped_name = name.substr(0, name.size() - BzipExtension.size());
    }
    return FileSystemUtils::extension(stripped_name);
}

References FileSystemUtils::extension(), isBZipped(), isGZipped(), and RealSpace::Particles::name().

Referenced by isIntFile(), and isTiffFile().

Here is the call graph for this function:

isBZipped()

bool DataFormatUtils::isBZipped

(

const std::string &

name

)

Returns true if name contains *.bz2 extension.

Definition at line 59 of file DataFormatUtils.cpp.

{
    return FileSystemUtils::extension(name) == BzipExtension;
}

References FileSystemUtils::extension(), and RealSpace::Particles::name().

Referenced by GetFileMainExtension(), isCompressed(), IntensityDataIOFactory::readOutputData(), and IntensityDataIOFactory::writeOutputData().

Here is the call graph for this function:

isCompressed()

bool DataFormatUtils::isCompressed

(

const std::string &

name

)

Returns true if name contains *.gz extension.

Definition at line 47 of file DataFormatUtils.cpp.

{
    return isGZipped(name) || isBZipped(name);
}

References isBZipped(), isGZipped(), and RealSpace::Particles::name().

Referenced by ImportDataUtils::Import1dData(), IntensityDataIOFactory::readOutputData(), and IntensityDataIOFactory::writeOutputData().

Here is the call graph for this function:

isGZipped()

bool DataFormatUtils::isGZipped

(

const std::string &

name

)

Returns true if name contains *.gz extension.

Does name contain *.gz extension?

Definition at line 54 of file DataFormatUtils.cpp.

{
    return FileSystemUtils::extension(name) == GzipExtension;
}

References FileSystemUtils::extension(), and RealSpace::Particles::name().

Referenced by GetFileMainExtension(), isCompressed(), IntensityDataIOFactory::readOutputData(), and IntensityDataIOFactory::writeOutputData().

Here is the call graph for this function:

isIntFile()

bool DataFormatUtils::isIntFile

(

const std::string &

file_name

)

returns true if file name corresponds to BornAgain native format (compressed or not)

Definition at line 77 of file DataFormatUtils.cpp.

{
    return GetFileMainExtension(file_name) == IntExtension;
}

References GetFileMainExtension().

Referenced by ImportDataUtils::Import1dData(), IntensityDataIOFactory::readOutputData(), and IntensityDataIOFactory::writeOutputData().

Here is the call graph for this function:

isTiffFile()

bool DataFormatUtils::isTiffFile

(

const std::string &

file_name

)

returns true if file name corresponds to tiff file (can be also compressed)

Definition at line 82 of file DataFormatUtils.cpp.

{
    return (GetFileMainExtension(file_name) == TiffExtension
            || GetFileMainExtension(file_name) == TiffExtension2);
}

References GetFileMainExtension().

Referenced by ImportDataUtils::Import1dData(), IntensityDataIOFactory::readOutputData(), and IntensityDataIOFactory::writeOutputData().

Here is the call graph for this function:

parse_doubles()

std::vector< double > DataFormatUtils::parse_doubles

(

const std::string &

str

)

Parse double values from string to vector of double.

Definition at line 131 of file DataFormatUtils.cpp.

{
    std::vector<double> result;
    std::istringstream iss(str);
    DataFormatUtils::readLineOfDoubles(result, iss);
    if (result.empty()) {
        std::string out = str;
        const size_t max_string_length(10);
        if (out.size() > max_string_length)
            out.resize(max_string_length, ' ');
        out += " ...";
        throw std::runtime_error("DataFormatUtils::parse_doubles -> Error! Can't parse double "
                                 "values from a string '"
                                 + out + "'");
    }
    return result;
}

References readLineOfDoubles().

Referenced by OutputDataReadReflectometry::readOutputData(), and OutputDataReadWriteNumpyTXT::readOutputData().

Here is the call graph for this function:

readLineOfDoubles()

void DataFormatUtils::readLineOfDoubles	(	std::vector< double > &	buffer,
		std::istringstream &	iss
	)

Definition at line 151 of file DataFormatUtils.cpp.

{
    iss.imbue(std::locale::classic());
    std::copy(std::istream_iterator<double>(iss), std::istream_iterator<double>(),
              back_inserter(buffer));
}

Referenced by fillOutputData(), and parse_doubles().