DataUtils::Format Namespace Reference

Description

Utility functions for data input and output.

Functions
IAxis *	createAxis (std::istream &input_stream)
	Creates axis of certain type from input stream. More...
void	fillDatafield (Datafield *data, std::istream &input_stream)
	Fills output data raw buffer from input stream. 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	isNicosFile (const std::string &file_name)
	Returns true if file name corresponds to Nicos 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)

Function Documentation

createAxis()

IAxis * DataUtils::Format::createAxis

(

std::istream &

input_stream

)

Creates axis of certain type from input stream.

Definition at line 154 of file DataFormatUtils.cpp.

{
    auto iss = getAxisStringRepresentation(input_stream);
    std::string type;
    if (!(iss >> type))
        throw std::runtime_error(
            "Error in DataUtils::Format::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 DataUtils::Format::createAxis:"
                             "Unknown axis type '"
                             + type + "'");
}

Referenced by ReadWriteINT::readDatafield().

fillDatafield()

void DataUtils::Format::fillDatafield	(	Datafield *	data,
		std::istream &	input_stream
	)

Fills output data raw buffer from input stream.

Definition at line 171 of file DataFormatUtils.cpp.

{
    std::string line;
    size_t iout = 0;
    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)
            (*data)[iout++] = value;
    }
    if (iout != data->size())
        throw std::runtime_error("Error while parsing data, did not reach expected end");
}

References readLineOfDoubles(), and Datafield::size().

Referenced by ReadWriteINT::readDatafield().

Here is the call graph for this function:

isBZipped()

bool DataUtils::Format::isBZipped

(

const std::string &

name

)

Returns true if name contains *.bz2 extension.

Definition at line 132 of file DataFormatUtils.cpp.

{
    return BaseUtils::Filesystem::hasExtension(name, BzipExtension);
}

References BaseUtils::Filesystem::hasExtension().

Referenced by isCompressed(), IOFactory::readDatafield(), and IOFactory::writeDatafield().

Here is the call graph for this function:

isCompressed()

bool DataUtils::Format::isCompressed

(

const std::string &

name

)

Returns true if name contains *.gz extension.

Definition at line 120 of file DataFormatUtils.cpp.

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

References isBZipped(), and isGZipped().

Referenced by IOFactory::readDatafield(), and IOFactory::writeDatafield().

Here is the call graph for this function:

isGZipped()

bool DataUtils::Format::isGZipped

(

const std::string &

name

)

Returns true if name contains *.gz extension.

Does name contain *.gz extension?

Definition at line 127 of file DataFormatUtils.cpp.

{
    return BaseUtils::Filesystem::hasExtension(name, GzipExtension);
}

References BaseUtils::Filesystem::hasExtension().

Referenced by isCompressed(), IOFactory::readDatafield(), and IOFactory::writeDatafield().

Here is the call graph for this function:

isIntFile()

bool DataUtils::Format::isIntFile

(

const std::string &

file_name

)

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

Definition at line 137 of file DataFormatUtils.cpp.

{
    return BaseUtils::Filesystem::hasExtension(uncompressedFilename(file_name), IntExtension);
}

References BaseUtils::Filesystem::hasExtension().

Referenced by IOFactory::fileTypeMatchesLoaderSelector(), and IOFactory::writeDatafield().

Here is the call graph for this function:

isNicosFile()

bool DataUtils::Format::isNicosFile

(

const std::string &

file_name

)

Returns true if file name corresponds to Nicos format (compressed or not)

Definition at line 142 of file DataFormatUtils.cpp.

{
    return BaseUtils::Filesystem::hasExtension(uncompressedFilename(file_name), NicosExtension);
}

References BaseUtils::Filesystem::hasExtension().

Referenced by IOFactory::fileTypeMatchesLoaderSelector().

Here is the call graph for this function:

isTiffFile()

bool DataUtils::Format::isTiffFile

(

const std::string &

file_name

)

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

Definition at line 147 of file DataFormatUtils.cpp.

{
    return BaseUtils::Filesystem::hasExtension(uncompressedFilename(file_name), TiffExtension)
           || BaseUtils::Filesystem::hasExtension(uncompressedFilename(file_name), TiffExtension2);
}

References BaseUtils::Filesystem::hasExtension().

Referenced by IOFactory::fileTypeMatchesLoaderSelector(), IOFactory::readDatafield(), and IOFactory::writeDatafield().

Here is the call graph for this function:

parse_doubles()

std::vector< double > DataUtils::Format::parse_doubles

(

const std::string &

str

)

Parse double values from string to vector of double.

Definition at line 192 of file DataFormatUtils.cpp.

{
    std::vector<double> result;
    std::istringstream iss(str);
    DataUtils::Format::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("DataUtils::Format::parse_doubles -> Error! Can't parse double "
                                 "values from a string '"
                                 + out + "'");
    }
    return result;
}

References readLineOfDoubles().

Referenced by ReadWriteNumpyTXT::readDatafield(), and ReadReflectometry::readDatafield().

Here is the call graph for this function:

readLineOfDoubles()

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

Definition at line 212 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 fillDatafield(), and parse_doubles().