Spectrum2DCanvas.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-2017.
//
// 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 $
// --------------------------------------------------------------------------

#ifndef OPENMS_VISUAL_SPECTRUM2DCANVAS_H
#define OPENMS_VISUAL_SPECTRUM2DCANVAS_H

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

// OpenMS
#include <OpenMS/VISUAL/SpectrumCanvas.h>
#include <OpenMS/VISUAL/Spectrum1DCanvas.h>
#include <OpenMS/KERNEL/PeakIndex.h>

// QT
class QPainter;
class QMouseEvent;
class QAction;
class QMenu;

namespace OpenMS
{
  class OPENMS_GUI_DLLAPI Spectrum2DCanvas :
    public SpectrumCanvas
  {
    Q_OBJECT

public:
    Spectrum2DCanvas(const Param& preferences, QWidget* parent = 0);

    ~Spectrum2DCanvas();

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

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

    void mergeIntoLayer(Size i, FeatureMapSharedPtrType map);

    void mergeIntoLayer(Size i, ConsensusMapSharedPtrType map);

    void mergeIntoLayer(Size i, std::vector<PeptideIdentification>& peptides);

    void recalculateCurrentLayerDotGradient();

signals:
    void showProjectionHorizontal(ExperimentSharedPtrType);
    void showProjectionVertical(ExperimentSharedPtrType);
    void showProjectionInfo(int, double, double);
    void toggleProjections();
    void showSpectrumAs1D(int index);
    void showSpectrumAs1D(std::vector<int, std::allocator<int> > indices);
    void showCurrentPeaksAs3D();

public slots:
    // Docu in base class
    void activateLayer(Size layer_index);
    // Docu in base class
    void removeLayer(Size layer_index);
    //docu in base class
    virtual void updateLayer(Size i);
    // Docu in base class
    virtual void horizontalScrollBarChange(int value);
    // Docu in base class
    virtual void verticalScrollBarChange(int value);

    void updateProjections();

protected slots:

    void currentLayerParametersChanged_();

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

    bool collectFragmentScansInArea(double rt_min, double rt_max, double mz_min, double mz_max, QAction* a, QMenu * msn_scans, QMenu * msn_meta);

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

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

    // Docu in base class
    virtual void updateScrollbars_();

    void paintDots_(Size layer_index, QPainter& p);

    void paintAllIntensities_(Size layer_index, double pen_width, QPainter& painter);

    void paintMaximumIntensities_(Size layer_index, Size rt_pixel_count, Size mz_pixel_count, QPainter& p);

    void paintPrecursorPeaks_(Size layer_index, QPainter& painter);

    void paintFeatureData_(Size layer_index, QPainter& p);

    void paintTraceConvexHulls_(Size layer_index, QPainter& p);

    void paintFeatureConvexHulls_(Size layer_index, QPainter& p);

    void paintIdentifications_(Size layer_index, QPainter& p);

    void paintConsensusElements_(Size layer_index, QPainter& p);

    void paintConsensusElement_(Size layer_index, const ConsensusFeature& cf, QPainter& p, bool use_buffer);

    bool isConsensusFeatureVisible_(const ConsensusFeature& ce, Size layer_index);

    void paintConvexHulls_(const std::vector<ConvexHull2D>& hulls, bool hasIdentifications, QPainter& p);

    // Docu in base class
    virtual void intensityModeChange_();
    // DOcu in base class
    virtual void recalculateSnapFactor_();

    inline Int precalculatedColorIndex_(float val, const MultiGradient& gradient, double snap_factor)
    {
      float gradientPos;
      switch (intensity_mode_)
      {
      case IM_NONE:
        gradientPos = val;
        break;

      case IM_PERCENTAGE:
        gradientPos = val * percentage_factor_;
        break;

      case IM_SNAP:
        gradientPos = val * snap_factor;
        break;

      case IM_LOG:
        gradientPos = std::log(val + 1);
        break;

      default:
        throw Exception::NotImplemented(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION);
      }
      return gradient.precalculatedColorIndex(gradientPos);
    }

    inline QColor heightColor_(float val, const MultiGradient& gradient, double snap_factor)
    {
      return gradient.precalculatedColorByIndex(precalculatedColorIndex_(val, gradient, snap_factor));
    }

    inline void dataToWidget_(double x, double y, QPoint& point)
    {
      if (!isMzToXAxis())
      {
        point.setX(int((y - visible_area_.minY()) / visible_area_.height() * width()));
        point.setY(height() - int((x - visible_area_.minX()) / visible_area_.width() * height()));
      }
      else
      {
        point.setX(int((x - visible_area_.minX()) / visible_area_.width() * width()));
        point.setY(height() - int((y - visible_area_.minY()) / visible_area_.height() * height()));
      }
    }

    double adaptPenScaling_(double ratio_data2pixel, double& pen_size) const;
    
    void recalculateDotGradient_(Size layer);

    void highlightPeak_(QPainter& p, const PeakIndex& peak);

    PeakIndex findNearestPeak_(const QPoint& pos);

    void paintIcon_(const QPoint& pos, const QRgb& color, const String& icon, Size s, QPainter& p) const;

    virtual void translateVisibleArea_(double mzShiftRel, double rtShiftRel);

    //docu in base class
    virtual void translateLeft_(Qt::KeyboardModifiers m);
    //docu in base class
    virtual void translateRight_(Qt::KeyboardModifiers m);
    //docu in base class
    virtual void translateForward_();
    //docu in base class
    virtual void translateBackward_();

    void finishContextMenu_(QMenu* context_menu, QMenu* settings_menu);

    ExperimentType projection_mz_;
    ExperimentType projection_rt_;
    
    PeakIndex selected_peak_;
    PeakIndex measurement_start_;

    MultiGradient linear_gradient_;
    
    double pen_size_min_; //< minimum number of pixels for one data point
    double pen_size_max_; //< maximum number of pixels for one data point
    double canvas_coverage_min_; //< minimum coverage of the canvas required; if lower, points are upscaled in size

  private:
    Spectrum2DCanvas();

  };
}

#endif