BinPlotWidget.qo.h

Go to the documentation of this file.

//# Copyright (C) 2005
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//#        Internet email: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
#ifndef BINPLOTWIDGET_QO_H
#define BINPLOTWIDGET_QO_H

#include <QWidget>

#include <guitools/Histogram/BinPlotWidget.ui.h>
#include <guitools/Histogram/HeightSource.h>
#include <guitools/Histogram/FootPrintWidget.qo.h>
#include <images/Regions/ImageRegion.h>
#include <casa/aips.h>
#include <casa/aipstype.h>
#include <qwt_plot.h>
#include <qwt_plot_picker.h>
#include <vector>
#include <QDebug>
#include <QMenu>

using namespace std;

class QwtPlotMarker;
class QwtPlotCurve;
class QwtLinearColorMap;
class QWidgetAction;

namespace casacore{

template <class T> class ImageInterface;
template <class T> class Vector;
}

namespace casa {

class FitWidget;
class RangePicker;
class ToolTipPicker;
class Histogram;
class HistogramMarkerGaussian;
class HistogramMarkerPoisson;
class RangeControlsWidget;
class BinCountWidget;
class ChannelRangeWidget;
class ZoomWidget;


class BinPlotWidget : public QWidget, public HeightSource{
    Q_OBJECT

friend class RangePicker;

public:
    BinPlotWidget( bool fitControls, bool rangeControls, bool plotModeControls,
        QWidget* parent);

    bool setImage( const std::shared_ptr<const casacore::ImageInterface<float> > img, bool waitOnHistogram = false );
    bool setImageRegion( casacore::ImageRegion* imageRegion, int id );
    void deleteImageRegion( int id );
    void imageRegionSelected( int id );
    virtual void postMessage( const QString& msg );

    std::vector<float> getXValues() const;
    pair<double,double> getMinMaxValues() const;
    void setMinMaxValues( double minValue, double maxValue, bool updateGraph=true );

    //Customizing the display
    void hideMaximumRange();
    void setColorLookups( const casacore::Vector<casacore::uInt> & lookups );
    void setColorMap( QwtLinearColorMap* colorMap );
    void setColorScaleMax( int max );
    void setMultiColored( bool multipleColors );
    void setLineMode( bool lineMode );
    void setDisplayPlotTitle( bool display );
    void setDisplayAxisTitles( bool display );
    void setHistogramColor( QColor color );
    void setFitEstimateColor( QColor color );
    void setFitCurveColor( QColor color );
    void setMultipleHistogramColors( const QList<QColor>& colors );
    void setAxisLabelFont( int size );
    void setChannelCount( int count );
    void setChannelValue( int value );
    void addZoomActions( bool rangeControl, QMenu* zoomMenu );
    void addDisplayActions( QMenu* menu, QWidgetAction* binCountAction );
    void addPlotModeActions( QMenu* menu, QWidgetAction* channelRangeAction=NULL,
                QWidgetAction* footPrintAction = NULL );
    void setPlotMode( int mode );
    bool isEmpty() const;
    ~BinPlotWidget();

signals:
        void postStatusMessage( const QString& msg );
        void rangeChanged();


public slots:
        void fitModeChanged();
        void plotModeChanged( int mode );
        void setDisplayStep( bool display );
        void setDisplayLogY( bool display );
        void clearFit();
        void clearAll();

        //Saving the Histogram
        void toAscii( const QString& filePath );
        void toPing( const QString& filtPath, int width, int height );

        //The channel has changed value.
        void channelRangeChanged( int minValue, int maxValue, bool allChannels, bool automatic, int specIndex=-1 );

        //Histogramming an image versus a region.
        void imageModeSelected( bool enabled );
        void regionModeSelected( bool enabled );

protected:
    virtual void resizeEvent( QResizeEvent* event );
    virtual void keyPressEvent( QKeyEvent* event );
    /*Overriden because we weren't getting the first "Shift" to bring
     * up the context menu when the mouse first entered the histogram.
     * We set the focus on this widget when the mouse enters so it will
     * get that first "Shift" without having to do a click first.
     */
    virtual void enterEvent( QEvent* event );
        virtual void mousePressEvent( QMouseEvent* event );


private slots:
        void lineMoved( const QPoint& pt );
        void lineSelected();
        void clearRange();
        void defineCurve( int id, const QColor& curveColor, bool clear=true);
        void minMaxChanged();
        void showContextMenu( const QPoint& pt );
        void centerPeakSpecified();
        void lambdaSpecified();
        void fwhmSpecified();
        void fitDone( const QString& msg );
        void zoomContextFinished();
        void zoomMenuFinished();
        void resetGaussianFitMarker();
        void resetPoissonFitMarker();

        void zoomNeutral();
        //Zoom based on an intensity range specified by the user using the range controls widget
        void zoomRange();
        //Zoom based on an intensity range specified by the user using the zoom context menu.
        void zoomPercentage( float minValue, float maxValue);
        void binCountChanged( int count );

        void regionAllModeSelected( bool enabled );

private:
        BinPlotWidget( const BinPlotWidget& );
        BinPlotWidget& operator=( const BinPlotWidget& );
        void initializeFitWidget( bool fitControls );
        void initializeDisplayActions();
        void initializeZoomControls( bool rangeControls );
        void initializePlotModeControls( bool enable );
        void initializeGaussianFitMarker();
        void initializePoissonFitMarker();
        void initializeRangeControls( bool rangeControls);
        void connectZoomActions( ZoomWidget* zoomWidget );
        void clearGaussianFitMarker();
        void clearPoissonFitMarker();
        void clearHistograms();
        void clearCurves();
        void makeHistogram( int id, const QColor& histogramColor, bool clearCurve=true);
        void rectangleSizeChanged();
        void resetAxisTitles();
        void resetPlotTitle();
        void reset();
        bool resetImage( bool waitOnHistogram = false );
        void resetRegion();
        void resetRectangleMarker();
        void defineCurveLine( int id, const QColor& lineColor );
        void defineCurveHistogram( int id, const QColor& histogramColor );
        QwtPlotCurve* addCurve( QVector<double>& xValues, QVector<double>& yValues, const QColor& curveColor );
        bool isPrintOut( int id ) const;
        bool isPrincipalHistogram( int id ) const;
        bool isPlotContains( int x, int y );
        virtual int getCanvasHeight();
        Histogram* findHistogramFor( int id );
        int getSelectedId() const;
        QColor getPieceColor( int index, const QColor& defaultColor ) const;

        void zoom( float percent );
        void zoomRangeMarker( double startValue, double endValue );
    Ui::BinPlotWidgetClass ui;

    enum ContextMenuMode{ ZOOM_CONTEXT,DISPLAY_CONTEXT,FIT_CONTEXT };
    ContextMenuMode contextMenuMode;

    bool displayPlotTitle;
    bool displayAxisTitles;
    bool multiColored;
    bool allChannels;
    int spectralIndex;
    int minChannel;
    int maxChannel;

    QColor curveColor;
    QColor selectionColor;
    QColor fitEstimateColor;
    QColor fitCurveColor;
    QList<QColor> multipleHistogramColors;
    QwtLinearColorMap* colorMap;
    casacore::Vector<casacore::uInt> colorLookups;
    int colorScaleMax;

    //Histogram & data
    QList<QwtPlotCurve*> curves;
    QMap<int,Histogram*> histogramMap;
    std::shared_ptr<const casacore::ImageInterface<float> > image;
    QwtPlot binPlot;
    const QString NO_DATA;
    const QString NO_DATA_MESSAGE;
    const int IMAGE_ID;
    int selectedId;

    //Specifying a range with the histogram
    QwtPlotPicker* dragLine;
    RangePicker* rectMarker;
    ToolTipPicker* toolTipPicker;
    RangeControlsWidget* rangeControlWidget;
    QMenu contextMenuZoom;

    QWidgetAction* zoomActionContext;
    ZoomWidget* zoomWidgetContext;
    QWidgetAction* zoomActionMenu;
    ZoomWidget* zoomWidgetMenu;
    double rectX;
    double rectWidth;

    //Fitting the histogram
    QAction lambdaAction;
    QAction centerPeakAction;
    QAction fwhmAction;
    QMenu contextMenu;
    FitWidget* fitWidget;
    QwtPlotCurve* fitCurve;
    QPoint fitPosition;
    HistogramMarkerGaussian* fitEstimateMarkerGaussian;
    HistogramMarkerPoisson* fitEstimateMarkerPoisson;

    //Plot Display
    const QString LOG_COUNT;
    QAction stepFunctionNoneAction;
    QAction stepFunctionAction;
    QAction stepFunctionFilledAction;
    QAction logActionY;
    QAction clearAction;
    enum HistogramOptions{HISTOGRAM_FILLED,HISTOGRAM_OUTLINE,HISTOGRAM_LINE};
    bool displayLogY;
    QMenu contextMenuDisplay;

    //Plot Control
    //We should be able to use just one binCountAction and binCountWidget
    //However, to appear, the constructor has to take the appropriate
    //menu as a parent.
    QWidgetAction* binCountActionContext;
    QWidgetAction* channelRangeActionContext;
    QWidgetAction* footPrintActionContext;

    QWidgetAction* binCountActionMenu;
    QWidgetAction* channelRangeActionMenu;
    QWidgetAction* footPrintActionMenu;

    BinCountWidget* binCountWidgetContext;
    ChannelRangeWidget* channelRangeWidgetContext;
    FootPrintWidget* footPrintWidgetContext;

    BinCountWidget* binCountWidgetMenu;
    ChannelRangeWidget* channelRangeWidgetMenu;
    FootPrintWidget* footPrintWidgetMenu;
    QMenu contextMenuConfigure;
    FootPrintWidget::PlotMode plotMode;
};

}

#endif // THRESHOLDINGBINPLOTWIDGET_H