PlotWidget.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2022.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------

#pragma once

// OpenMS_GUI config
#include <OpenMS/VISUAL/OpenMS_GUIConfig.h>

//OpenMS
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/MATH/STATISTICS/Histogram.h>
#include <OpenMS/VISUAL/EnhancedTabBarWidgetInterface.h>
#include <OpenMS/VISUAL/PlotCanvas.h>

class QCloseEvent;
class QGridLayout;
class QMimeData;
class QScrollBar;

namespace OpenMS
{

  class AxisWidget;

  class OPENMS_GUI_DLLAPI PlotWidget :
    public QWidget,
    public EnhancedTabBarWidgetInterface
  {
    Q_OBJECT

public:
    static const char RT_AXIS_TITLE[];
    static const char MZ_AXIS_TITLE[];
    static const char INTENSITY_AXIS_TITLE[];
    static const char IM_MS_AXIS_TITLE[];
    static const char IM_ONEKZERO_AXIS_TITLE[];


    typedef LayerDataBase::ExperimentType ExperimentType;
    typedef LayerDataBase::FeatureMapType FeatureMapType;
    typedef ExperimentType::SpectrumType SpectrumType;

    PlotWidget(const Param & preferences, QWidget * parent = nullptr);
    ~PlotWidget() override;

    virtual PlotCanvas* canvas() const = 0;

    virtual inline AxisWidget * xAxis()
    {
      return x_axis_;
    }

    virtual inline AxisWidget * yAxis()
    {
      return y_axis_;
    }

    Int getActionMode() const;

    virtual bool isLegendShown() const;

    virtual void showLegend(bool show);

    void setIntensityMode(PlotCanvas::IntensityModes mode);

    virtual void hideAxes();

    virtual void saveAsImage();

signals:
    void sendStatusMessage(std::string, OpenMS::UInt);
    void sendCursorStatus(const String& x_value, const String& y_value);
    void aboutToBeDestroyed(int window_id);
    void openPreferences();
    void dropReceived(const QMimeData* data, QWidget* source, int id);

public slots:
    void showStatistics();
    void showIntensityDistribution(const Math::Histogram<>& dist);
    void showMetaDistribution(const String& name, const Math::Histogram<>& dist);
    void updateAxes();
    void updateHScrollbar(float min, float disp_min, float disp_max, float max);
    void updateVScrollbar(float min, float disp_min, float disp_max, float max);
    virtual void showGoToDialog() = 0;
    void changeLegendVisibility();

    virtual void setMapper(const DimMapper<2>& mapper) = 0;

protected:

    void closeEvent(QCloseEvent * e) override;

    void setCanvas_(PlotCanvas * canvas, UInt row = 0, UInt col = 2);
    virtual void intensityModeChange_();
    virtual void recalculateAxes_() = 0;


    void dragEnterEvent(QDragEnterEvent * event) override;
    void dragMoveEvent(QDragMoveEvent * event) override;
    void dropEvent(QDropEvent * event) override;
    void paintEvent(QPaintEvent * /*event*/) override;

    PlotCanvas* canvas_;
    QGridLayout* grid_;
    AxisWidget* y_axis_;
    AxisWidget* x_axis_;
    QScrollBar* x_scrollbar_;
    QScrollBar* y_scrollbar_;
  };
}