Plot2DWidget.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/VISUAL/PlotWidget.h>
#include <OpenMS/VISUAL/Plot2DCanvas.h>

class QGroupBox;
class QLabel;
class QCheckBox;

namespace OpenMS
{
  class Plot1DWidget;

  class OPENMS_GUI_DLLAPI Plot2DWidget :
    public PlotWidget
  {
    Q_OBJECT
public:
    typedef LayerDataBase::ExperimentSharedPtrType ExperimentSharedPtrType;

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

    // docu in base class
    Plot2DCanvas* canvas() const override
    {
      return static_cast<Plot2DCanvas*>(canvas_);
    }
            
    const Plot1DWidget* getProjectionOntoX() const;
    const Plot1DWidget* getProjectionOntoY() const;

    bool projectionsVisible() const;

    void setMapper(const DimMapper<2>& mapper) override
    {
      canvas_->setMapper(mapper); // update canvas
      // ... and projections: the projected Dim becomes intensity
      projection_onto_X_->setMapper(DimMapper<2>({mapper.getDim(DIM::X).getUnit(), DIM_UNIT::INT}));
      projection_onto_Y_->setMapper(DimMapper<2>({DIM_UNIT::INT, mapper.getDim(DIM::Y).getUnit()}));

          // decide on default draw mode, depending on main axis unit (e.g. m/z or RT)
      auto set_style = [&](const DIM_UNIT main_unit_1d, Plot1DCanvas* canvas) {
        switch (main_unit_1d)
        { // this may not be optimal for every unit. Feel free to change behavior.
          case DIM_UNIT::MZ:
            // to show isotope distributions as sticks
            canvas->setDrawMode(Plot1DCanvas::DM_PEAKS);
            canvas->setIntensityMode(PlotCanvas::IM_PERCENTAGE);
            break;
          // all other units
          default:
            canvas->setDrawMode(Plot1DCanvas::DM_CONNECTEDLINES);
            canvas->setIntensityMode(PlotCanvas::IM_SNAP);
            break;
        }
      };
      set_style(mapper.getDim(DIM::X).getUnit(), projection_onto_Y_->canvas());
      set_style(mapper.getDim(DIM::Y).getUnit(), projection_onto_X_->canvas());
    }

public slots:
    // Docu in base class
    void recalculateAxes_() override;
    void toggleProjections();
    // Docu in base class
    void showGoToDialog() override;

signals:
    void visibleAreaChanged(DRange<2> area);
    void showSpectrumAsNew1D(int index);
    void showChromatogramsAsNew1D(std::vector<int, std::allocator<int> > indices);
    void showCurrentPeaksAs3D();

protected:
    void projectionInfo_(int peaks, double intensity, double max);

    Plot1DWidget * projection_onto_X_;
    Plot1DWidget * projection_onto_Y_;
    QGroupBox * projection_box_;
    QLabel * projection_peaks_;
    QLabel * projection_sum_;
    QLabel * projection_max_;
    QCheckBox * projections_auto_;
    QTimer * projections_timer_;

private slots:
    void showProjections_(const LayerDataBase* source_layer);
    void autoUpdateProjections_();
  };
}