ImportDataUtils Namespace Reference

Provides utility methods to import data files. More...

Functions
bool	Compatible (const InstrumentItem &instrumentItem, const RealDataItem &realDataItem)
	Check whether data item is compatible with instrument (same rank) More...
std::unique_ptr< OutputData< double > >	CreateSimplifiedOutputData (const OutputData< double > &data)
	Creates OutputData with bin-valued axes. More...
QString	Import1dData (RealDataItem *realDataItem, const AbstractDataLoader *selectedLoader)
	Import 1D data into the given item. More...
std::unique_ptr< OutputData< double > >	Import2dData (const QString &baseNameOfLoadedFile)
std::unique_ptr< OutputData< double > >	ImportKnownData (const QString &baseNameOfLoadedFile)
std::unique_ptr< OutputData< double > >	ImportReflectometryData (const QString &baseNameOfLoadedFile)
QString	printShapeMessage (const std::vector< int > &instrument_shape, const std::vector< int > &data_shape)
	Composes a message with the shapes of InstrumentItem and RealDataItem. More...

Detailed Description

Provides utility methods to import data files.

Function Documentation

Compatible()

bool ImportDataUtils::Compatible	(	const InstrumentItem &	instrumentItem,
		const RealDataItem &	realDataItem
	)

Check whether data item is compatible with instrument (same rank)

Definition at line 157 of file ImportDataUtils.cpp.

{
    return rank(instrumentItem) == rank(realDataItem);
}

Referenced by LinkInstrumentManager::canLinkDataToInstrument().

CreateSimplifiedOutputData()

std::unique_ptr< OutputData< double > > ImportDataUtils::CreateSimplifiedOutputData

(

const OutputData< double > &

data

)

Creates OutputData with bin-valued axes.

Definition at line 164 of file ImportDataUtils.cpp.

{
    const size_t data_rank = data.rank();
    if (data_rank > 2 || data_rank < 1)
        throw std::runtime_error("Error in ImportDataUtils::CreateSimplifiedOutputData: passed "
                                 "array is neither 1D nor 2D");
 
    std::unique_ptr<OutputData<double>> result(new OutputData<double>);
    for (size_t i = 0; i < data_rank; ++i) {
        const IAxis& axis = data.axis(i);
        const size_t axis_size = axis.size();
        const double min = 0.0;
        const double max = axis_size;
        result->addAxis(FixedBinAxis(axis.getName(), axis_size, min, max));
    }
    result->setRawDataVector(data.getRawDataVector());
 
    return result;
}

References OutputData< T >::axis(), IAxis::getName(), OutputData< T >::getRawDataVector(), OutputData< T >::rank(), and IAxis::size().

Referenced by ImportKnownData().

Here is the call graph for this function:

Import1dData()

QString ImportDataUtils::Import1dData	(	RealDataItem *	realDataItem,
		const AbstractDataLoader *	selectedLoader
	)

Import 1D data into the given item.

Returns an error text if a fatal error occurred (discard item). "Empty string" means "no fatal error" => imported item should be kept. The imported item still can have errors, but they might be solvable by different import settings or by using a different data loader. selectedLoader is the one which was selected in the open-file-dialog (or null if none selected).

Definition at line 92 of file ImportDataUtils.cpp.

{
    const QString fileName = realDataItem->nativeFileName();
    const std::string fileNameStdString = fileName.toStdString();
 
    if (selectedLoader == nullptr) {
        if (DataFormatUtils::isCompressed(fileNameStdString)
            || DataFormatUtils::isIntFile(fileNameStdString)
            || DataFormatUtils::isTiffFile(fileNameStdString)) {
            try {
                ImportDataInfo data(ImportKnownData(fileName), Axes::Units::QSPACE);
                if (data) {
                    realDataItem->setImportData(std::move(data));
                    return QString();
                }
            } catch (std::exception& ex) {
                // If it is not tiff but e.g. dat.gz, it could be tried with CSV import
                const bool tryWithLoaders =
                    (DataFormatUtils::isIntFile(fileNameStdString)
                     && !DataFormatUtils::isCompressed(
                         fileNameStdString)); // #baimport support compressed
 
                if (!tryWithLoaders)
                    // import is not possible
                    return QString::fromLatin1(ex.what());
            }
        }
    }
 
    // -- try with selected CSV loader. If none selected, try with QRE loader
 
    QFile file(fileName);
    const bool fileCouldBeOpened = file.open(QFile::ReadOnly | QIODevice::Text);
 
    if (!fileCouldBeOpened)
        return "File could not be opened.";
 
    QByteArray fileContent = file.readAll();
    file.close();
 
    if (fileContent.isEmpty())
        return "The imported file is empty.";
 
    if (DataFormatUtils::isCompressed(fileNameStdString)) {
        // #baimport implement decompress
    }
 
    AbstractDataLoader* loader = nullptr;
    if (selectedLoader == nullptr)
        loader = new QREDataLoader();
    else
        loader = selectedLoader->clone();
    loader->initWithDefaultImportSettings();
    loader->setRealDataItem(realDataItem);
    realDataItem->setDataLoader(loader);
    QApplication::setOverrideCursor(Qt::WaitCursor);
    loader->setFileContents(fileContent);
    loader->guessSettings();
    loader->processContents();
    QApplication::restoreOverrideCursor();
 
    return QString();
}

References AbstractDataLoader::clone(), AbstractDataLoader::guessSettings(), ImportKnownData(), AbstractDataLoader::initWithDefaultImportSettings(), DataFormatUtils::isCompressed(), DataFormatUtils::isIntFile(), DataFormatUtils::isTiffFile(), RealDataItem::nativeFileName(), AbstractDataLoader::processContents(), RealDataItem::setDataLoader(), AbstractDataLoader::setFileContents(), RealDataItem::setImportData(), and AbstractDataLoader::setRealDataItem().

Referenced by RealDataSelectorWidget::importData().

Here is the call graph for this function:

Import2dData()

std::unique_ptr< OutputData< double > > ImportDataUtils::Import2dData

(

const QString &

baseNameOfLoadedFile

)

Definition at line 87 of file ImportDataUtils.cpp.

{
    return ImportKnownData(fileName);
}

References ImportKnownData().

Referenced by RealDataSelectorWidget::importData().

Here is the call graph for this function:

ImportKnownData()

std::unique_ptr< OutputData< double > > ImportDataUtils::ImportKnownData

(

const QString &

baseNameOfLoadedFile

)

Definition at line 53 of file ImportDataUtils.cpp.

{
    // Try to use the canonical tools for importing data
    std::unique_ptr<OutputData<double>> result;
    try {
        std::unique_ptr<OutputData<double>> data(
            IntensityDataIOFactory::readOutputData(fileName.toStdString()));
        result = CreateSimplifiedOutputData(*data);
    } catch (std::exception& ex) {
        QString message = QString("Error while trying to read file\n\n'%1'\n\n%2")
                              .arg(fileName)
                              .arg(QString::fromStdString(std::string(ex.what())));
        QMessageBox::warning(nullptr, "IO Problem", message);
    }
    return result;
}

References CreateSimplifiedOutputData(), IntensityDataIOFactory::readOutputData(), and GUIHelpers::warning().

Referenced by Import1dData(), and Import2dData().

Here is the call graph for this function:

ImportReflectometryData()

std::unique_ptr< OutputData< double > > ImportDataUtils::ImportReflectometryData

(

const QString &

baseNameOfLoadedFile

)

Definition at line 71 of file ImportDataUtils.cpp.

{
    std::unique_ptr<OutputData<double>> result;
    try {
        std::unique_ptr<OutputData<double>> data(
            IntensityDataIOFactory::readReflectometryData(fileName.toStdString()));
        result.swap(data);
    } catch (std::exception& ex) {
        QString message = QString("Error while trying to read file\n\n'%1'\n\n%2")
                              .arg(fileName)
                              .arg(QString::fromStdString(std::string(ex.what())));
        QMessageBox::warning(nullptr, "IO Problem", message);
    }
    return result;
}

References IntensityDataIOFactory::readReflectometryData(), and GUIHelpers::warning().

Here is the call graph for this function:

printShapeMessage()

QString ImportDataUtils::printShapeMessage	(	const std::vector< int > &	instrument_shape,
		const std::vector< int > &	data_shape
	)

Composes a message with the shapes of InstrumentItem and RealDataItem.

Definition at line 184 of file ImportDataUtils.cpp.

{
    auto to_str = [](const std::vector<int>& shape) {
        std::string result;
        for (size_t i = 0, size = shape.size(); i < size; ++i) {
            result += std::to_string(shape[i]);
            if (i + 1 != size)
                result += ", ";
        }
        return result;
    };
 
    std::string message_string = "instrument [";
    message_string += to_str(instrument_shape);
    message_string += "], data [";
    message_string += to_str(data_shape);
    message_string += "]";
    return QString::fromStdString(std::move(message_string));
}

Referenced by LinkInstrumentManager::canLinkDataToInstrument().