Plot1DCanvas.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, Timo Sachsenberg, Chris Bielow $
// --------------------------------------------------------------------------

#pragma once

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

// OpenMS
#include <OpenMS/VISUAL/PlotCanvas.h>
#include <OpenMS/VISUAL/Painter1DBase.h>

// QT
#include <QTextDocument>

// STL
#include <vector>
#include <utility>

// QT
class QAction;

namespace OpenMS
{

  class OPENMS_GUI_DLLAPI Plot1DCanvas :
    public PlotCanvas
  {
    Q_OBJECT

public:
    enum LabelMode
    {
      LM_XABSOLUTE_YABSOLUTE,
      LM_XPERCENT_YABSOLUTE,
      LM_XABSOLUTE_YPERCENT,
      LM_XPERCENT_YPERCENT
    };

    constexpr static double TOP_MARGIN{1.09};

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

    bool addChromLayer(ExperimentSharedPtrType chrom_exp_sptr,
                       ODExperimentSharedPtrType ondisc_sptr, 
                       OSWDataSharedPtrType chrom_annotation,
                       const int index,
                       const String& filename, 
                       const String& caption, 
                       const bool multiple_select);

    
    enum DrawModes
    {
      DM_PEAKS,         
      DM_CONNECTEDLINES 
    };

    DrawModes getDrawMode() const;

    void setDrawMode(DrawModes mode);

    // Docu in base class
    void showCurrentLayerPreferences() override;

    // Docu in base class
    void saveCurrentLayer(bool visible) override;

    bool flippedLayersExist();

    void flipLayer(Size index);

    bool mirrorModeActive() const;

    void setMirrorModeActive(bool b);

    void dataToWidget(const PeakType& peak, QPoint& point, bool flipped = false, bool percentage = true);

    void dataToWidget(double x, double y, QPoint& point, bool flipped = false, bool percentage = false);

    PointType widgetToData(const QPoint& pos, bool percentage = false);

    PointType widgetToData(double x, double y, bool percentage = false);

    void setTextBox(const QString& html);


    Annotation1DItem* addPeakAnnotation(const PeakIndex& peak_index, const QString& text, const QColor& color);

    void performAlignment(Size layer_index_1, Size layer_index_2, const Param& param);

    void resetAlignment();

    Size getAlignmentSize();

    double getAlignmentScore() const;

    std::vector<std::pair<Size, Size> > getAlignedPeaksIndices();

    void activateSpectrum(Size index, bool repaint = true);

    void setSwappedAxis(bool swapped);

    void setCurrentLayerPeakPenStyle(Qt::PenStyle ps);

    void paint(QPainter* paint_device, QPaintEvent* e);

    void setDrawInterestingMZs(bool enable);

    bool isDrawInterestingMZs() const;

    // Show/hide ion ladder on top right corner (Identification view)
    void setIonLadderVisible(bool show);

    // Returns true if ion ladder is visible
    bool isIonLadderVisible() const;

signals:
    void showCurrentPeaksAs2D();

    void showCurrentPeaksAs3D();

    void showCurrentPeaksAsIonMobility();

    void showCurrentPeaksAsDIA();

public slots:
    // Docu in base class
    void activateLayer(Size layer_index) override;
    // Docu in base class
    void removeLayer(Size layer_index) override;
    // Docu in base class
    void updateLayer(Size i) override;

    void setVisibleArea(DRange<2> range);         //Do not change this to AreaType the signal needs QT needs the exact type...
    // Docu in base class
    void horizontalScrollBarChange(int value) override;

protected slots:

    void currentLayerParamtersChanged_();

protected:
    // Docu in base class
    bool finishAdding_() override;

    void drawCoordinates_(QPainter& painter, const PeakIndex& peak);
    void drawDeltas_(QPainter& painter, const PeakIndex& start, const PeakIndex& end);
    
    void drawAlignment_(QPainter& painter);

    void changeVisibleArea_(double lo, double hi, bool repaint = true, bool add_to_stack = false);

    void drawHighlightedPeak_(Size layer_index, const PeakIndex& peak, QPainter& painter, bool draw_elongation = false);

    void updatePercentageFactor_(Size layer_index);

    void changeVisibleArea_(const AreaType& new_area, bool repaint = true, bool add_to_stack = false) override;
    // Docu in base class
    void recalculateSnapFactor_() override;
    // Docu in base class
    void updateScrollbars_() override;
    // Docu in base class
    void intensityModeChange_() override;

    std::vector<DrawModes> draw_modes_;
    std::vector<Qt::PenStyle> peak_penstyle_;

    QPoint measurement_start_point_;
    bool mirror_mode_;

    bool moving_annotations_;

    bool show_alignment_;
    Size alignment_layer_1_;
    Size alignment_layer_2_;
    std::vector<std::pair<double, double> > aligned_peaks_mz_delta_;
    std::vector<std::pair<Size, Size> > aligned_peaks_indices_;
    double alignment_score_;
    bool is_swapped_;
    bool ion_ladder_visible_;
    bool draw_interesting_MZs_;

    PeakIndex findPeakAtPosition_(QPoint);

    void addUserLabelAnnotation_(const QPoint& screen_position);
    void addLabelAnnotation_(const QPoint& screen_position, const QString& label_text);
    void addUserPeakAnnotation_(PeakIndex near_peak);

    void ensureAnnotationsWithinDataRange_();

    QTextDocument text_box_content_;

    void paintEvent(QPaintEvent* e) override;
    void mousePressEvent(QMouseEvent* e) override;
    void mouseReleaseEvent(QMouseEvent* e) override;
    void mouseMoveEvent(QMouseEvent* e) override;
    void keyPressEvent(QKeyEvent* e) override;
    void contextMenuEvent(QContextMenuEvent* e) override;

    void zoomForward_() override;
    void zoom_(int x, int y, bool zoom_in) override;
    //docu in base class
    void translateLeft_(Qt::KeyboardModifiers m) override;
    //docu in base class
    void translateRight_(Qt::KeyboardModifiers m) override;
    //docu in base class
    void paintGridLines_(QPainter& painter) override;

    friend class Painter1DPeak;

  };
} // namespace OpenMS