SpecularDataImportWidget Class Reference

Description

Widget to define and show 1D (specular) imports by data loaders, e.g. CSV file import Contains space for the loader-defined import properties, a table for the raw and the imported data and a graph to show the plot of the imported data. The UI is defined via QtDesigner (.ui file)

Definition at line 37 of file SpecularDataImportWidget.h.

Inheritance diagram for SpecularDataImportWidget:

Collaboration diagram for SpecularDataImportWidget:

Public Member Functions
	SpecularDataImportWidget (QWidget *parent=nullptr)
QList< QAction * >	actionList () override
SessionItem *	currentItem ()
const SessionItem *	currentItem () const
void	setItem (SessionItem *realDataItem) override

Protected Member Functions
void	hideEvent (QHideEvent *) override
void	showEvent (QShowEvent *) override
virtual void	subscribeToItem ()
virtual void	unsubscribeFromItem ()

Private Slots
void	onContextMenuRequest (const QPoint &point)
void	onPlotAxisClicked (QCPAxis *axis, QCPAxis::SelectablePart part, QMouseEvent *event)

Private Member Functions
QString	currentFileName () const
void	fillLoaderCombo ()
void	onCreateNewFormatButton ()
void	onFormatSelectionChanged ()
void	onPropertiesChanged ()
RealDataItem *	realDataItem ()
const RealDataItem *	realDataItem () const
AbstractDataLoader *	selectedLoader ()
SpecularDataItem *	specularDataItem ()
void	updatePreview ()
void	updatePropertiesEdits ()

Private Attributes
SessionItemController *	m_itemController
AbstractDataLoader1D *	m_loader
Ui::SpecularDataImportWidget *	m_ui

Constructor & Destructor Documentation

SpecularDataImportWidget()

SpecularDataImportWidget::SpecularDataImportWidget

(

QWidget *

parent = nullptr

)

Definition at line 35 of file SpecularDataImportWidget.cpp.

    : SessionItemWidget(parent)
    , m_ui(new Ui::SpecularDataImportWidget)
    , m_loader(nullptr)
{
    setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 
    m_ui->setupUi(this);
    m_ui->warningsIcon->setFixedSize(20, 20);
    m_ui->warningsIcon->setPixmap(QPixmap(":/images/warning_16x16.png"));
 
    m_ui->linkedInstrumentGroup->hide(); // #baimport - remove from UI if not used in the future
 
    // #baUserDefLoaders - remove next line when implementation is complete
    m_ui->createNewFormatButton->hide();
 
    fillLoaderCombo();
    updatePropertiesEdits();
 
    connect(m_ui->formatSelectionComboBox, QOverload<int>::of(&QComboBox::currentIndexChanged),
            this, &SpecularDataImportWidget::onFormatSelectionChanged);
    connect(m_ui->createNewFormatButton, &QPushButton::clicked, this,
            &SpecularDataImportWidget::onCreateNewFormatButton);
 
    connect(m_ui->originalRowCheckBox, &QCheckBox::stateChanged, this,
            &SpecularDataImportWidget::updatePreview);
 
    connect(m_ui->rawDataCheckBox, &QCheckBox::stateChanged, this,
            &SpecularDataImportWidget::updatePreview);
 
    connect(m_ui->calculatedDataCheckBox, &QCheckBox::stateChanged, this,
            &SpecularDataImportWidget::updatePreview);
 
    connect(m_ui->specularDataCanvas->customPlot(), &QCustomPlot::axisClick, this,
            &SpecularDataImportWidget::onPlotAxisClicked);
 
    m_ui->specularDataCanvas->enableDeprecatedOnMousePress(false); // we have an own handler
 
    m_ui->plotToolbar->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
    for (auto* action : m_ui->specularDataCanvas->actionList())
        m_ui->plotToolbar->addAction(action);
}

References fillLoaderCombo(), m_ui, onCreateNewFormatButton(), onFormatSelectionChanged(), onPlotAxisClicked(), updatePreview(), and updatePropertiesEdits().

Here is the call graph for this function:

Member Function Documentation

actionList()

QList< QAction * > SpecularDataImportWidget::actionList ( )

overridevirtual

Reimplemented from SessionItemWidget.

Definition at line 98 of file SpecularDataImportWidget.cpp.

{
    return {};
}

Referenced by onContextMenuRequest().

currentFileName()

QString SpecularDataImportWidget::currentFileName ( ) const

private

Definition at line 363 of file SpecularDataImportWidget.cpp.

{
    return realDataItem()->nativeFileName();
}

References RealDataItem::nativeFileName(), and realDataItem().

Here is the call graph for this function:

currentItem() [1/2]

SessionItem * SessionItemWidget::currentItem ( )

inherited

Definition at line 41 of file SessionItemWidget.cpp.

{
    return const_cast<SessionItem*>(static_cast<const SessionItemWidget*>(this)->currentItem());
}

Referenced by FitFlowWidget::fitSuiteItem(), RealDataMaskWidget::intensityDataItem(), IntensityDataCanvas::intensityDataItem(), IntensityDataWidget::intensityDataItem(), IntensityDataProjectionsWidget::intensityDataItem(), ProjectionsPlot::intensityItem(), ColorMap::intensityItem(), JobResultsPresenter::itemPresentation(), FitParameterWidget::jobItem(), ParameterTuningWidget::jobItem(), RunFitControlWidget::jobItem(), FitComparisonWidget::jobItem(), FitComparisonWidget1D::jobItem(), IntensityDataPropertyWidget::jobItem(), SpecularDataPropertyWidget::jobItem(), realDataItem(), ItemComboWidget::setPresentation(), JobResultsPresenter::setPresentation(), specularDataItem(), SpecularDataCanvas::specularDataItem(), SpecularDataWidget::specularDataItem(), SpecularPlot::specularItem(), ItemComboWidget::subscribeToItem(), ProjectionsPlot::unsubscribeFromChildren(), and Plot1D::viewItem().

currentItem() [2/2]

const SessionItem * SessionItemWidget::currentItem ( ) const

inherited

Definition at line 46 of file SessionItemWidget.cpp.

{
    return m_itemController->currentItem();
}

References SessionItemController::currentItem(), and SessionItemWidget::m_itemController.

Here is the call graph for this function:

fillLoaderCombo()

void SpecularDataImportWidget::fillLoaderCombo ( )

private

Definition at line 153 of file SpecularDataImportWidget.cpp.

{
    QSignalBlocker b(m_ui->formatSelectionComboBox);
    m_ui->formatSelectionComboBox->clear();
    for (auto* loader : DataLoaders1D::instance().recentlyUsedLoaders())
        m_ui->formatSelectionComboBox->addItem(loader->name());
    for (auto* loader : DataLoaders1D::instance().loaders())
        m_ui->formatSelectionComboBox->addItem(loader->name());
 
    // e.g. legacy loader is not present in the combo by default. Add it here so it can be selected
    if (m_loader != nullptr)
        if (m_ui->formatSelectionComboBox->findText(m_loader->name()) < 0)
            m_ui->formatSelectionComboBox->addItem(m_loader->name());
}

References DataLoaders1D::instance(), m_loader, m_ui, and AbstractDataLoader::name().

Referenced by SpecularDataImportWidget(), onCreateNewFormatButton(), and setItem().

Here is the call graph for this function:

hideEvent()

void SessionItemWidget::hideEvent ( QHideEvent *  )

overrideprotectedinherited

Definition at line 56 of file SessionItemWidget.cpp.

{
    m_itemController->unsubscribe();
}

References SessionItemWidget::m_itemController, and SessionItemController::unsubscribe().

Here is the call graph for this function:

onContextMenuRequest

void SpecularDataImportWidget::onContextMenuRequest ( const QPoint &  point )

privateslot

Definition at line 103 of file SpecularDataImportWidget.cpp.

{
    QMenu menu;
    for (auto* action : actionList())
        menu.addAction(action);
    menu.exec(point);
}

References actionList().

Here is the call graph for this function:

onCreateNewFormatButton()

void SpecularDataImportWidget::onCreateNewFormatButton ( )

private

Definition at line 326 of file SpecularDataImportWidget.cpp.

{
    bool ok;
    QString name = QInputDialog::getText(
        this, "New format", "Please enter a name for the new format", QLineEdit::Normal, "", &ok);
    if (!ok || name.isEmpty())
        return;
 
    cloneAsUserDefinedLoader(m_loader, name);
 
    fillLoaderCombo();
    m_ui->formatSelectionComboBox->setCurrentText(name);
    onFormatSelectionChanged();
}

References cloneAsUserDefinedLoader(), fillLoaderCombo(), m_loader, m_ui, GUI::RealSpace::Particles::name(), and onFormatSelectionChanged().

Referenced by SpecularDataImportWidget().

Here is the call graph for this function:

onFormatSelectionChanged()

void SpecularDataImportWidget::onFormatSelectionChanged ( )

private

Definition at line 195 of file SpecularDataImportWidget.cpp.

{
    if (m_loader && m_loader->fileContent().isEmpty()) {
        QSignalBlocker b(m_ui->formatSelectionComboBox);
        m_ui->formatSelectionComboBox->setCurrentText(m_loader->name());
 
        QMessageBox::information(GUI::Global::mainWindow, "Information",
                                 "Changing the loader is not possible because the original file "
                                 "contents are not available any more.");
 
        return;
    }
 
    if (m_loader)
        m_loader->disconnect(this);
 
    m_loader = dynamic_cast<AbstractDataLoader1D*>(selectedLoader()->clone());
    m_loader->initWithDefaultImportSettings();
    m_loader->setFileContents(realDataItem()->dataLoader()->fileContent());
    realDataItem()->setDataLoader(m_loader);
    m_loader->setRealDataItem(realDataItem());
    QApplication::setOverrideCursor(Qt::WaitCursor);
    m_loader->guessSettings();
    m_loader->processContents();
    QApplication::restoreOverrideCursor();
 
    updatePropertiesEdits();
    updatePreview();
    connect(m_loader, &AbstractDataLoader::importSettingsChanged, this,
            &SpecularDataImportWidget::onPropertiesChanged);
}

References AbstractDataLoader::clone(), RealDataItem::dataLoader(), AbstractDataLoader::fileContent(), AbstractDataLoader::guessSettings(), AbstractDataLoader::importSettingsChanged(), GUI::View::Helpers::information(), AbstractDataLoader::initWithDefaultImportSettings(), m_loader, m_ui, GUI::Global::mainWindow, AbstractDataLoader::name(), onPropertiesChanged(), AbstractDataLoader::processContents(), realDataItem(), selectedLoader(), RealDataItem::setDataLoader(), AbstractDataLoader::setFileContents(), AbstractDataLoader::setRealDataItem(), updatePreview(), and updatePropertiesEdits().

Referenced by SpecularDataImportWidget(), and onCreateNewFormatButton().

Here is the call graph for this function:

onPlotAxisClicked

void SpecularDataImportWidget::onPlotAxisClicked ( QCPAxis *  axis, QCPAxis::SelectablePart  part, QMouseEvent *  event  )

privateslot

Definition at line 111 of file SpecularDataImportWidget.cpp.

{
    if (event->button() == Qt::RightButton && axis->axisType() == QCPAxis::atLeft) {
        QMenu menu;
 
        auto* lin = new QAction("Linear");
        connect(lin, &QAction::triggered, [=]() { specularDataItem()->setLog(false); });
        lin->setCheckable(true);
        lin->setChecked(!specularDataItem()->isLog());
 
        auto* log = new QAction("Logarithmic");
        connect(log, &QAction::triggered, [=]() { specularDataItem()->setLog(true); });
        log->setCheckable(true);
        log->setChecked(specularDataItem()->isLog());
 
        auto* ag = new QActionGroup(&menu);
        ag->addAction(lin);
        ag->addAction(log);
 
        menu.addAction(lin);
        menu.addAction(log);
 
        menu.exec(event->globalPos());
    }
}

References SpecularDataItem::isLog(), SpecularDataItem::setLog(), and specularDataItem().

Referenced by SpecularDataImportWidget().

Here is the call graph for this function:

onPropertiesChanged()

void SpecularDataImportWidget::onPropertiesChanged ( )

private

Definition at line 341 of file SpecularDataImportWidget.cpp.

{
    m_loader->applyImportSettings(); // #baimport: may be duplicate
    QApplication::setOverrideCursor(Qt::WaitCursor);
    m_loader->processContents();
    QApplication::restoreOverrideCursor();
 
    // If there is a linked instrument, any change in import settings can break the compatibility.
    // Therefore check the compatibility and break the link if necessary
    ASSERT(gSessionData->projectDocument.has_value());
    const auto* linkedInstrument =
        gSessionData->projectDocument.value()->collectedItems()->findInstrumentById(
            realDataItem()->instrumentId());
 
    if (linkedInstrument != nullptr)
        if (!linkedInstrument->alignedWith(realDataItem()))
            realDataItem()->unlinkFromInstrument();
 
 
    updatePreview();
}

References AbstractDataLoader::applyImportSettings(), gSessionData, m_loader, AbstractDataLoader::processContents(), SessionData::projectDocument, realDataItem(), RealDataItem::unlinkFromInstrument(), and updatePreview().

Referenced by onFormatSelectionChanged(), and setItem().

Here is the call graph for this function:

realDataItem() [1/2]

RealDataItem * SpecularDataImportWidget::realDataItem ( )

private

Definition at line 148 of file SpecularDataImportWidget.cpp.

{
    return dynamic_cast<RealDataItem*>(currentItem());
}

References SessionItemWidget::currentItem().

Here is the call graph for this function:

realDataItem() [2/2]

const RealDataItem * SpecularDataImportWidget::realDataItem ( ) const

private

Definition at line 143 of file SpecularDataImportWidget.cpp.

{
    return dynamic_cast<const RealDataItem*>(currentItem());
}

References SessionItemWidget::currentItem().

Referenced by currentFileName(), onFormatSelectionChanged(), onPropertiesChanged(), and setItem().

Here is the call graph for this function:

selectedLoader()

AbstractDataLoader * SpecularDataImportWidget::selectedLoader ( )

private

Definition at line 184 of file SpecularDataImportWidget.cpp.

{
    const QString name = m_ui->formatSelectionComboBox->currentText();
 
    for (auto* loader : DataLoaders1D::instance().loaders())
        if (name == loader->name())
            return loader;
 
    return nullptr;
}

References DataLoaders1D::instance(), m_ui, and GUI::RealSpace::Particles::name().

Referenced by onFormatSelectionChanged().

Here is the call graph for this function:

setItem()

void SpecularDataImportWidget::setItem ( SessionItem *  realDataItem )

overridevirtual

Reimplemented from SessionItemWidget.

Definition at line 78 of file SpecularDataImportWidget.cpp.

{
    SessionItemWidget::setItem(_realDataItem);
    m_ui->specularDataCanvas->setItem(specularDataItem());
 
    m_loader = dynamic_cast<AbstractDataLoader1D*>(realDataItem()->dataLoader());
    ASSERT(m_loader); // only items which have a loader are allowed for this widget. Every other
                      // items do not support this widget
 
    fillLoaderCombo();
 
    QSignalBlocker b(m_ui->formatSelectionComboBox);
    m_ui->formatSelectionComboBox->setCurrentText(m_loader->name());
 
    updatePropertiesEdits();
    updatePreview();
    connect(m_loader, &AbstractDataLoader::importSettingsChanged, this,
            &SpecularDataImportWidget::onPropertiesChanged);
}

References RealDataItem::dataLoader(), fillLoaderCombo(), AbstractDataLoader::importSettingsChanged(), m_loader, m_ui, AbstractDataLoader::name(), onPropertiesChanged(), realDataItem(), SessionItemWidget::setItem(), specularDataItem(), updatePreview(), and updatePropertiesEdits().

Here is the call graph for this function:

showEvent()

void SessionItemWidget::showEvent ( QShowEvent *  )

overrideprotectedinherited

Definition at line 51 of file SessionItemWidget.cpp.

{
    m_itemController->subscribe();
}

References SessionItemWidget::m_itemController, and SessionItemController::subscribe().

Here is the call graph for this function:

specularDataItem()

SpecularDataItem * SpecularDataImportWidget::specularDataItem ( )

private

Definition at line 138 of file SpecularDataImportWidget.cpp.

{
    return GUI::Model::DataItemUtils::specularDataItem(currentItem());
}

References SessionItemWidget::currentItem(), and GUI::Model::DataItemUtils::specularDataItem().

Referenced by onPlotAxisClicked(), and setItem().

Here is the call graph for this function:

subscribeToItem()

virtual void SessionItemWidget::subscribeToItem ( )

inlineprotectedvirtualinherited

Reimplemented in ProjectionsPlot, IntensityDataProjectionsWidget, ColorMap, SpecularPlot, Plot1D, FitFlowWidget, FitComparisonWidget1D, FitComparisonWidget, IntensityDataCanvas, RealDataMaskWidget, RunFitControlWidget, ParameterTuningWidget, FitParameterWidget, and ItemComboWidget.

Definition at line 43 of file SessionItemWidget.h.

{}

Referenced by SessionItemWidget::SessionItemWidget().

unsubscribeFromItem()

virtual void SessionItemWidget::unsubscribeFromItem ( )

inlineprotectedvirtualinherited

Reimplemented in ProjectionsPlot, IntensityDataProjectionsWidget, ColorMap, SpecularPlot, Plot1D, FitFlowWidget, FitComparisonWidget1D, FitComparisonWidget, RealDataMaskWidget, and RunFitControlWidget.

Definition at line 44 of file SessionItemWidget.h.

{}

Referenced by SessionItemWidget::SessionItemWidget().

updatePreview()

void SpecularDataImportWidget::updatePreview ( )

private

Definition at line 227 of file SpecularDataImportWidget.cpp.

{
    QApplication::setOverrideCursor(Qt::WaitCursor);
 
    if (m_loader) {
        auto* oldModel = m_ui->dataResultView->selectionModel(); // sic!! according to Qt docu
                                                                 // of QAbstractItemView::setModel
        auto* resultModel = m_loader->createResultModel();
        if (resultModel != nullptr) {
            const auto originalSections = resultModel->sectionsOfColumnType(
                AbstractDataLoaderResultModel::ColumnType::fileContent);
 
            const auto rawSections =
                resultModel->sectionsOfColumnType(AbstractDataLoaderResultModel::ColumnType::raw);
 
            const auto processedSections = resultModel->sectionsOfColumnType(
                AbstractDataLoaderResultModel::ColumnType::processed);
 
            QSignalBlocker b1(m_ui->originalRowCheckBox);
            QSignalBlocker b2(m_ui->rawDataCheckBox);
            QSignalBlocker b3(m_ui->calculatedDataCheckBox);
 
            if (originalSections.isEmpty()) {
                m_ui->originalRowCheckBox->setChecked(false);
                m_ui->originalRowCheckBox->setEnabled(false);
            } else
                m_ui->originalRowCheckBox->setEnabled(true);
 
            if (rawSections.isEmpty()) {
                m_ui->rawDataCheckBox->setChecked(false);
                m_ui->rawDataCheckBox->setEnabled(false);
            } else
                m_ui->rawDataCheckBox->setEnabled(true);
 
            if (processedSections.isEmpty()) {
                m_ui->calculatedDataCheckBox->setChecked(false);
                m_ui->calculatedDataCheckBox->setEnabled(false);
            } else
                m_ui->calculatedDataCheckBox->setEnabled(true);
 
            m_ui->dataResultView->setModel(resultModel);
            auto* horHeader = m_ui->dataResultView->horizontalHeader();
 
            for (int section : originalSections)
                horHeader->setSectionHidden(section, !m_ui->originalRowCheckBox->isChecked());
 
            for (int section : rawSections)
                horHeader->setSectionHidden(section, !m_ui->rawDataCheckBox->isChecked());
 
            for (int section : processedSections)
                horHeader->setSectionHidden(section, !m_ui->calculatedDataCheckBox->isChecked());
 
            // if the result model has a line column, then do not show the vertical header view
            const bool hasLinesColumn =
                !resultModel->sectionsOfColumnType(AbstractDataLoaderResultModel::ColumnType::line)
                     .isEmpty();
            m_ui->dataResultView->verticalHeader()->setHidden(hasLinesColumn);
 
            m_ui->dataResultView->resizeColumnsToContents();
        } else
            m_ui->dataResultView->setModel(nullptr);
 
        delete oldModel;
    }
 
    if (m_loader && m_loader->numErrors() > 0) {
        m_ui->warningsIcon->show();
        m_ui->warningsLabel->show();
        m_ui->warningsListWidget->show();
        m_ui->warningsListWidget->clear();
 
        auto warnings = m_loader->lineUnrelatedErrors();
        const int nLineRelatedWarnings = m_loader->numErrors() - warnings.size();
 
        if (nLineRelatedWarnings == 1)
            warnings << "1 line related warning. Please check the data tab on the right for more "
                        "information.";
        else if (nLineRelatedWarnings > 1)
            warnings
                << QString(
                       "%1 line related warnings. Please check the data tab on the right for more "
                       "information.")
                       .arg(nLineRelatedWarnings);
 
        if (warnings.size() > 1)
            for (auto& w : warnings)
                w.prepend("* ");
 
        for (auto& w : warnings)
            new QListWidgetItem(w, m_ui->warningsListWidget);
    } else {
        m_ui->warningsIcon->hide();
        m_ui->warningsLabel->hide();
        m_ui->warningsListWidget->hide();
    }
 
    QApplication::restoreOverrideCursor();
}

References AbstractDataLoader::createResultModel(), AbstractDataLoaderResultModel::fileContent, AbstractDataLoaderResultModel::line, AbstractDataLoader::lineUnrelatedErrors(), m_loader, m_ui, AbstractDataLoader::numErrors(), AbstractDataLoaderResultModel::processed, AbstractDataLoaderResultModel::raw, and AbstractDataLoaderResultModel::sectionsOfColumnType().

Referenced by SpecularDataImportWidget(), onFormatSelectionChanged(), onPropertiesChanged(), and setItem().

Here is the call graph for this function:

updatePropertiesEdits()

void SpecularDataImportWidget::updatePropertiesEdits ( )

private

Definition at line 168 of file SpecularDataImportWidget.cpp.

{
    for (auto* child : m_ui->propertiesWidget->children())
        delete child;
 
    if (m_ui->propertiesWidget->layout())
        delete m_ui->propertiesWidget->layout();
 
    if (m_loader)
        m_loader->populateImportSettingsWidget(m_ui->propertiesWidget);
 
    const bool hasChildren = !m_ui->propertiesWidget->children().empty();
 
    m_ui->propertiesWidget->setVisible(hasChildren);
}

References m_loader, m_ui, and AbstractDataLoader::populateImportSettingsWidget().

Referenced by SpecularDataImportWidget(), onFormatSelectionChanged(), and setItem().

Here is the call graph for this function:

Member Data Documentation

m_itemController

SessionItemController* SessionItemWidget::m_itemController

privateinherited

Definition at line 49 of file SessionItemWidget.h.

Referenced by SessionItemWidget::SessionItemWidget(), SessionItemWidget::currentItem(), SessionItemWidget::hideEvent(), SessionItemWidget::setItem(), and SessionItemWidget::showEvent().

m_loader

AbstractDataLoader1D* SpecularDataImportWidget::m_loader

private

Definition at line 66 of file SpecularDataImportWidget.h.

Referenced by fillLoaderCombo(), onCreateNewFormatButton(), onFormatSelectionChanged(), onPropertiesChanged(), setItem(), updatePreview(), and updatePropertiesEdits().

m_ui

Ui::SpecularDataImportWidget* SpecularDataImportWidget::m_ui

private

Definition at line 65 of file SpecularDataImportWidget.h.

Referenced by SpecularDataImportWidget(), fillLoaderCombo(), onCreateNewFormatButton(), onFormatSelectionChanged(), selectedLoader(), setItem(), updatePreview(), and updatePropertiesEdits().

---

The documentation for this class was generated from the following files:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Import/SpecularDataImportWidget.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Import/SpecularDataImportWidget.cpp