#include <SpectralPlotWindow.h>

Inheritance diagram for Isis::SpectralPlotWindow:

Collaboration diagram for Isis::SpectralPlotWindow:

Public Types
enum	MenuOptions { ShowHideMarkersMenuOption = 1, ShowHideCurvesMenuOption = 2, ShowTableMenuOption = 4, SaveMenuOption = 8, PrintMenuOption = 16, TrackMenuOption = 32, BackgroundSwitchMenuOption = 64, ShowHideGridMenuOption = 128, RenameLabelsMenuOption = 256, SetDisplayRangeMenuOption = 512, ResetScaleMenuOption = 1024, ClearPlotMenuOption = 2048, DefaultHelpMenuOption = 4096, LineFitMenuOption = 8192, ConfigurePlotMenuOption = 16384, AllMenuOptions }
	There is a menu option for everything in the plot window's menu. More...

Public Slots
void	setBandMarkersVisible (bool visible)

void	clearPlot ()
	This method completely clears the plot of all plot items. More...

void	configurePlotCurves ()
	This method creates a CubePlotCurveConfigureDialog object. More...

void	createBestFitLine ()
	This method prompts the user to select the best fit line criterea. More...

void	printPlot ()
	Provides printing support of the plot image. More...

void	changePlotLabels ()
	This method creates the dialog box which allows the user to relabel the plot window. More...

void	savePlot ()
	This method allows the user to save the plot as a png, jpg, or tif image file. More...

void	setDefaultRange ()
	Resets the x/y min/max to the defaults. More...

void	setLabels ()
	Makes the user specified changes to the plot labels. More...

void	setUserValues ()
	This method sets the scale for the axis according to the user specified numbers. More...

void	showHideAllMarkers ()
	Shows/Hides all the markers(symbols) More...

void	showHideAllCurves ()
	This method shows or hides all of the curves in the plotWindow. More...

void	resetScale ()
	Sets plot scale back to the defaults. More...

void	showHideGrid ()
	This method hides/shows the grid on the plotWindow and changes the text for the action. More...

void	showHelp ()
	This method creates and shows the help dialog box for the plot window. More...

void	showTable ()
	This method is called from the showTable action on the tool bar There are some checks done to make sure there are data to fill the table. More...

void	switchBackground ()
	This method toggles the plot background color between black and white. More...

void	trackerEnabled ()
	Enables the plot mouse tracker. More...

void	scheduleFillTable ()
	Fills in the table with the data from the current curves in the plotWindow once all current actions/activations are done. More...

void	fillTable ()
	Fills in the table with the data from the current curves in the plotWindow immediately. More...

Signals
void	closed ()
	Emitted when there is a close event on this window that will be accepted. More...

void	plotChanged ()
	Emitted every time there is a change to the plot window. More...

void	requestFillTable ()

Public Member Functions
	SpectralPlotWindow (PlotCurve::Units xUnits, QWidget *parent)
	This constructs a spectral plot window. More...

bool	bandMarkersVisible () const

void	setViewport (MdiCubeViewport *cvp)
	This class needs to know which viewport the user is looking at so it can appropriately draw in the band lines. More...

void	update (MdiCubeViewport *activeViewport)
	This window can show markers for the currently visible bands. More...

virtual void	add (CubePlotCurve *pc)
	This method adds the curves to the plot. More...

virtual void	clearPlotCurves ()
	This method also clears the plot of all plot items, but does not call the table delete stuff This method is called from plotTool each time the changePlot() method is called. More...

bool	canAdd (CubePlotCurve *curveToTest) const
	This method tests whethere or not a CubePlotCurve can be successfully added to this window. More...

QColor	plotBackgroundColor () const
	Returns the plot's background color. More...

QList< CubePlotCurve * >	plotCurves ()
	Get a comprehensive list of the plot curves inside of this plot window, excluding plot curves that are in the process of being removed. More...

QList< const CubePlotCurve * >	plotCurves () const
	Get a comprehensive const list of the plot curves inside of this plot window, excluding plot curves that are in the process of being removed. More...

QList< QwtPlotSpectrogram * >	plotSpectrograms ()
	Get a comprehensive list of the scatter plots (spectrograms) inside of this plot window. More...

QList< const QwtPlotSpectrogram * >	plotSpectrograms () const
	Get a comprehensive const list of the scatter plots (spectrograms) inside of this plot window. More...

QString	plotTitle () const
	Returns the plot title. More...

bool	userCanAddCurves () const
	Ask if a user action can add this curve to this window in general. More...

PlotCurve::Units	xAxisUnits () const
	This is the data-type of the curves' x data in this plot window. More...

PlotCurve::Units	yAxisUnits () const
	This is the data-type of the curves' y data in this plot window. More...

virtual void	paint (MdiCubeViewport vp, QPainter painter)
	Paint plot curve information onto the viewport. More...

void	replot ()
	Reset the scale of the plot, replot it and emit plot changed. More...

void	setAxisLabel (int axisId, QString title)
	Sets the plots given axis title to the given string. More...

void	setPlotBackground (QColor c)
	Sets the plot background color to the given color. More...

void	setPlotTitle (QString pt)
	Sets the plot title to the given string. More...

void	setUserCanAddCurves (bool)
	Allow or disallow users from manually putting curves into this plot window through either copy-and-paste or drag-and-drop. More...

void	showWindow ()
	Shows the plot window, and raises it to the front of any overlapping sibling widgets. More...

Static Public Member Functions
static QString	defaultWindowTitle ()
	This is the typical suffix for plot windows, it's here in case we want to update all plot windows to have a different ending than just 'Plot' on them (for example, 'Plot Window'). More...

static QString	settingsFileName (QString objectTitle)

Protected Member Functions
void	createWidgets (MenuOptions optionsToProvide)
	This method is called by the constructor to create the plot, legend. More...

void	disableAxisAutoScale ()
	This turns off scaling the x/y axes automatically. More...

virtual void	dragEnterEvent (QDragEnterEvent *event)
	When a user drags data into our plot window, we need to indicate whether or not this data is compatible with this window. More...

virtual void	dropEvent (QDropEvent *event)
	This is called when a user drops data into our window. More...

virtual bool	eventFilter (QObject o, QEvent e)
	This method filters the events of the objects it is connected to. More...

void	mousePressEvent (QObject object, QMouseEvent e)
	This is a helper method for the eventFilter() method. More...

QwtPlot *	plot ()
	Get the plot encapsulated by this PlotWindow. More...

void	setMenus (QList< QMenu > menus, QList< QAction > actions)
	Sets up the menus added from a parent object. More...

QwtPlotZoomer *	zoomer ()
	Get this window's plot's zoomer. More...

QString	settingsFileName () const

virtual void	closeEvent (QCloseEvent *event)
	This method is overridden so that we can be sure to write the current settings of the Main window. More...

virtual void	readSettings (QSize defaultSize=QSize())
	This method ensure that the settings get written even if the Main window was only hidden, not closed. More...

Private Member Functions
void	nullify ()
	This initializes the class member data to NULL. More...

QwtPlotMarker *	createMarker (QColor color)
	This is a helper method to create new band markers with the same line style and a custom color. More...

void	drawBandMarkers ()
	This method actually draws in the vertical band line(s) on the plot area. More...

Private Attributes
MdiCubeViewport *	m_cvp
	The viewport to be used as a reference for band markers. More...

bool	m_markersVisible
	True if the visibile state of the active markers should be true. More...

QwtPlotMarker *	m_grayBandLine
	The band marker for the gray band. More...

QwtPlotMarker *	m_redBandLine
	The band marker for the red band. More...

QwtPlotMarker *	m_greenBandLine
	The band marker for the green band. More...

QwtPlotMarker *	m_blueBandLine
	The band marker for the blue band. More...

QAction *	m_showHideBandMarkers
	This action toggles band marker visibility. More...

Detailed Description

Author: ????-??-?? Tracie Sucharski and Steven Lambright

History:: 2017-10-18 Summer Stapleton - Member variable m_cvp can now be set to NULL in ::setViewport() to represent that there are no open cube viewports. This means that ::drawBandMarkers will no longer attempt to access a non-existant cube. Fixes: #2142.

Definition at line 44 of file SpectralPlotWindow.h.

Member Enumeration Documentation

◆ MenuOptions

enum Isis::PlotWindow::MenuOptions

inherited

There is a menu option for everything in the plot window's menu.

This is provided so that you can enable/disable any given option.

Enumerator
ShowHideMarkersMenuOption	This option is titled 'Hide All Symbols' which hides all markers.
ShowHideCurvesMenuOption	This option is titled 'Hide All Curves' which makes all curves invisible.
ShowTableMenuOption	This option brings up the table. No table will be available without this option.
SaveMenuOption	This option exports the plot into a standard image format. No conversion to a standard image format file will be available without this option, but printing will still be available.
PrintMenuOption	This option sends the plot to a printer.
TrackMenuOption	This option enables mouse tracking on the plot area (displays next to the mouse which x/y point you are hovering over). This option is by default disabled.
BackgroundSwitchMenuOption	This option enables the ability for a user to change the background color of the plot from black to white.
ShowHideGridMenuOption	This option enables the ability for a user to enable a grid over the plot area.
RenameLabelsMenuOption	This option enables the ability for a user to change the x/y axis labels and plot title.
SetDisplayRangeMenuOption	This option allows the user to set the x/y axis display value ranges.
ResetScaleMenuOption	This option provides the user with an alternative zoom out button.
ClearPlotMenuOption	This option allows the user to delete all of the data inside the plot. If you don't want the user deleting a custom plot item, you should disable this option.
DefaultHelpMenuOption	Not implemented.
LineFitMenuOption	This option allows the user to create a best fit line for any of the scatter plot data or cube plot curve data in the window. This allows the user to create new plot curves.
ConfigurePlotMenuOption	This option allows the user to change the curve name, color, style size, and symbol of the curve.
AllMenuOptions	This is all of the available menu options.

Definition at line 96 of file PlotWindow.h.

Constructor & Destructor Documentation

◆ SpectralPlotWindow()

Isis::SpectralPlotWindow::SpectralPlotWindow	(	PlotCurve::Units	xUnits,
		QWidget *	parent
	)

This constructs a spectral plot window.

The spectral plot window graphs a spectral curve sent to it via the addPlotCurve() method.

Parameters

xUnits	The units to use for the x-axis: usually wavelength/band #
parent	The Qt-parent relationship parent for this window

Definition at line 27 of file SpectralPlotWindow.cpp.

References createMarker(), m_blueBandLine, m_grayBandLine, m_greenBandLine, m_redBandLine, m_showHideBandMarkers, nullify(), and setBandMarkersVisible().

Member Function Documentation

◆ add()

void Isis::PlotWindow::add ( CubePlotCurve * pc )

virtualinherited

This method adds the curves to the plot.

Parameters

pc

Definition at line 436 of file PlotWindow.cpp.

References Isis::PlotCurve::attachMarkers(), Isis::PlotWindow::canAdd(), Isis::PlotWindow::fillTable(), Isis::PlotWindow::m_legend, Isis::PlotWindow::m_plot, Isis::PlotWindow::plot(), Isis::PlotWindow::plotChanged(), Isis::PlotWindow::replot(), Isis::PlotWindow::resetScale(), Isis::CubePlotCurve::updateLegendItemWidget(), and Isis::PlotWindow::updateVisibility().

Referenced by Isis::PlotWindow::dropEvent(), Isis::PlotWindow::pasteCurve(), Isis::SpatialPlotTool::validatePlotCurves(), and Isis::SpectralPlotTool::validatePlotCurves().

◆ bandMarkersVisible()

bool Isis::SpectralPlotWindow::bandMarkersVisible ( ) const

Returns: bool

Definition at line 235 of file SpectralPlotWindow.cpp.

References m_markersVisible.

◆ canAdd()

bool Isis::PlotWindow::canAdd ( CubePlotCurve * curveToTest ) const

inherited

This method tests whethere or not a CubePlotCurve can be successfully added to this window.

Plot curves with mismatched X/Y data from the plot's x/y axis types can not be added to the window. This does not test whether or not a user is allowed to add the curve manually, just if the curve can be added programatically.

Parameters

curveToTest The plot curve to test for compatibility with this window

Returns: True if the curve is compatible with this window, false otherwise

Definition at line 305 of file PlotWindow.cpp.

References Isis::PlotWindow::m_xAxisUnits, Isis::PlotWindow::m_yAxisUnits, Isis::PlotCurve::xUnits(), and Isis::PlotCurve::yUnits().

Referenced by Isis::PlotWindow::add(), and Isis::PlotWindow::userCanAddCurve().

◆ changePlotLabels

void Isis::PlotWindow::changePlotLabels ( )

slotinherited

This method creates the dialog box which allows the user to relabel the plot window.

Definition at line 854 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot, Isis::PlotWindow::m_plotTitleText, Isis::PlotWindow::m_xAxisText, Isis::PlotWindow::m_yAxisText, Isis::PlotWindow::plot(), and Isis::PlotWindow::setLabels().

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ clearPlot

void Isis::PlotWindow::clearPlot ( )

slotinherited

This method completely clears the plot of all plot items.

i.e. curves and markers, which also deletes the legend also calls the necessary method to delete the table stuff

Definition at line 492 of file PlotWindow.cpp.

References Isis::PlotWindow::clearPlotCurves(), Isis::PlotWindow::m_tableWindow, and Isis::TableMainWindow::table().

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ clearPlotCurves()

void Isis::PlotWindow::clearPlotCurves ( )

virtualinherited

This method also clears the plot of all plot items, but does not call the table delete stuff This method is called from plotTool each time the changePlot() method is called.

Definition at line 540 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot, and Isis::PlotWindow::replot().

Referenced by Isis::PlotWindow::clearPlot().

◆ closed

void Isis::PlotWindow::closed ( )

signalinherited

Emitted when there is a close event on this window that will be accepted.

Referenced by Isis::PlotWindow::eventFilter().

◆ closeEvent()

void Isis::MainWindow::closeEvent ( QCloseEvent * event )

protectedvirtualinherited

This method is overridden so that we can be sure to write the current settings of the Main window.

Parameters

event

Reimplemented in Isis::TableMainWindow, and Isis::ViewportMainWindow.

Definition at line 37 of file MainWindow.cpp.

References Isis::MainWindow::writeSettings().

Referenced by Isis::ViewportMainWindow::closeEvent(), and Isis::TableMainWindow::closeEvent().

◆ configurePlotCurves

void Isis::PlotWindow::configurePlotCurves ( )

slotinherited

This method creates a CubePlotCurveConfigureDialog object.

When there are no curves in this PlotWindow, the dialog will not be created.

Definition at line 508 of file PlotWindow.cpp.

References Isis::PlotWindow::plotChanged(), and Isis::PlotWindow::plotCurves().

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ createBestFitLine

void Isis::PlotWindow::createBestFitLine ( )

slotinherited

This method prompts the user to select the best fit line criterea.

The PlotWindowBestFitDialog will create the best fit line automatically when the user asks for one, so we don't need to worry about doing any more than showing a dialog here.

Definition at line 529 of file PlotWindow.cpp.

References Isis::PlotWindow::plot().

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ createMarker()

QwtPlotMarker * Isis::SpectralPlotWindow::createMarker ( QColor color )

private

This is a helper method to create new band markers with the same line style and a custom color.

Parameters

color The color of the band marker

Returns: The requested plot marker; ownership is passed to the caller

Definition at line 80 of file SpectralPlotWindow.cpp.

References Isis::PlotWindow::plot().

Referenced by SpectralPlotWindow().

◆ createWidgets()

void Isis::PlotWindow::createWidgets ( MenuOptions optionsToProvide )

protectedinherited

This method is called by the constructor to create the plot, legend.

zoomer, and main window.

Parameters

optionsToProvide This is a bit-flag containing information on which menu options to give the user/put in the GUI.

Definition at line 145 of file PlotWindow.cpp.

References Isis::PlotWindow::m_grid, Isis::PlotWindow::m_legend, Isis::PlotWindow::m_plot, Isis::PlotWindow::m_zoomer, and Isis::PlotWindow::setupDefaultMenu().

Referenced by Isis::PlotWindow::PlotWindow().

◆ defaultWindowTitle()

QString Isis::PlotWindow::defaultWindowTitle ( )

staticinherited

This is the typical suffix for plot windows, it's here in case we want to update all plot windows to have a different ending than just 'Plot' on them (for example, 'Plot Window').

Returns: A string to be appended to your window title

Definition at line 1810 of file PlotWindow.cpp.

Referenced by Isis::HistogramTool::createWindow(), Isis::SpectralPlotTool::createWindow(), and Isis::SpatialPlotTool::createWindow().

◆ disableAxisAutoScale()

void Isis::PlotWindow::disableAxisAutoScale ( )

protectedinherited

This turns off scaling the x/y axes automatically.

Use this if you have a very specific axis range you want to use, but keep in mind that users (potentially) have an option to re-enable axis auto scaling if they want to.

Definition at line 1664 of file PlotWindow.cpp.

References Isis::PlotWindow::m_autoscaleAxes.

Referenced by Isis::ScatterPlotWindow::ScatterPlotWindow().

◆ dragEnterEvent()

void Isis::PlotWindow::dragEnterEvent ( QDragEnterEvent * event )

protectedvirtualinherited

When a user drags data into our plot window, we need to indicate whether or not this data is compatible with this window.

This checks userCanAddCurve() on the drag & drop data and allows or disallowed the event accordingly.

Parameters

event The drag event to test

Definition at line 1823 of file PlotWindow.cpp.

References Isis::PlotWindow::m_legend, and Isis::PlotWindow::userCanAddCurve().

◆ drawBandMarkers()

void Isis::SpectralPlotWindow::drawBandMarkers ( )

private

This method actually draws in the vertical band line(s) on the plot area.

Definition at line 99 of file SpectralPlotWindow.cpp.

References Isis::CubeViewport::blueBand(), Isis::CubeViewport::cube(), Isis::PvlContainer::findKeyword(), Isis::PvlObject::findObject(), Isis::CubeViewport::grayBand(), Isis::CubeViewport::greenBand(), Isis::PvlContainer::hasKeyword(), Isis::CubeViewport::isColor(), Isis::Cube::label(), m_blueBandLine, m_cvp, m_grayBandLine, m_greenBandLine, m_markersVisible, m_redBandLine, Isis::PlotWindow::plot(), Isis::CubeViewport::redBand(), Isis::toDouble(), Isis::PlotCurve::Wavelength, and Isis::PlotWindow::xAxisUnits().

Referenced by update().

◆ dropEvent()

void Isis::PlotWindow::dropEvent ( QDropEvent * event )

protectedvirtualinherited

This is called when a user drops data into our window.

The dragEnterEvent() must have said that this curve is compatible with this window. This provides all of the available options to the user (if any) set by the creator of the drag & drop event (i.e. whether or not we can move or just copy). If there are options, we create a context menu - otherwise the default action is taken.

Parameters

event The drop event containing the curve to put into the current window.

Definition at line 1844 of file PlotWindow.cpp.

References Isis::PlotWindow::add(), Isis::PlotWindow::m_allowUserToAddCurves, and Isis::PlotWindow::plotChanged().

◆ eventFilter()

bool Isis::PlotWindow::eventFilter	(	QObject *	o,
		QEvent *	e
	)

protectedvirtualinherited

This method filters the events of the objects it is connected to.

In this case, the eventFilter has been installed on the m_plot and m_legend.

Parameters

o
e

Returns: bool

Reimplemented in Isis::ScatterPlotWindow.

Definition at line 1590 of file PlotWindow.cpp.

References Isis::PlotWindow::closed(), Isis::PlotWindow::mousePressEvent(), and Isis::PlotWindow::plot().

Referenced by Isis::ScatterPlotWindow::eventFilter().

◆ fillTable

void Isis::PlotWindow::fillTable ( )

slotinherited

Fills in the table with the data from the current curves in the plotWindow immediately.

Definition at line 1411 of file PlotWindow.cpp.

References Isis::TableMainWindow::addToTable(), Isis::IsSpecial(), Isis::TableMainWindow::listWidget(), Isis::PlotWindow::m_plot, Isis::PlotWindow::m_tableWindow, Isis::Null, Isis::PlotWindow::plotCurves(), Isis::TableMainWindow::table(), Isis::toDouble(), and Isis::toString().

Referenced by Isis::PlotWindow::add(), Isis::PlotWindow::PlotWindow(), and Isis::PlotWindow::showTable().

◆ mousePressEvent()

void Isis::PlotWindow::mousePressEvent	(	QObject *	object,
		QMouseEvent *	event
	)

protectedinherited

This is a helper method for the eventFilter() method.

When a mouse press event is seen, this handles it. For example, if the user right clicks and the clipboard contains compatible data then this will give a paste option.

Parameters

object	The object which was pressed
event	The mouse event which contains button information

Definition at line 1628 of file PlotWindow.cpp.

References Isis::PlotWindow::pasteCurve(), and Isis::PlotWindow::userCanAddCurve().

Referenced by Isis::PlotWindow::eventFilter().

◆ nullify()

void Isis::SpectralPlotWindow::nullify ( )

private

This initializes the class member data to NULL.

Definition at line 63 of file SpectralPlotWindow.cpp.

References m_blueBandLine, m_cvp, m_grayBandLine, m_greenBandLine, m_redBandLine, and m_showHideBandMarkers.

Referenced by SpectralPlotWindow().

◆ paint()

void Isis::PlotWindow::paint	(	MdiCubeViewport *	vp,
		QPainter *	painter
	)

virtualinherited

Paint plot curve information onto the viewport.

Parameters

vp	The cube viewport to paint onto
painter	The painter to use for painting

Reimplemented in Isis::ScatterPlotWindow.

Definition at line 1787 of file PlotWindow.cpp.

References Isis::CubePlotCurve::paint(), and Isis::PlotWindow::plotCurves().

Referenced by Isis::ScatterPlotWindow::paint(), and Isis::AbstractPlotTool::paintViewport().

◆ plot()

QwtPlot * Isis::PlotWindow::plot ( )

protectedinherited

Get the plot encapsulated by this PlotWindow.

Returns: The QwtPlot that this window encapsulates.

Definition at line 1653 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot.

Referenced by Isis::HistogramPlotWindow::add(), Isis::PlotWindow::add(), Isis::PlotWindow::changePlotLabels(), Isis::ScatterPlotWindow::colorPlot(), Isis::PlotWindow::createBestFitLine(), createMarker(), drawBandMarkers(), Isis::ScatterPlotWindow::eventFilter(), Isis::PlotWindow::eventFilter(), Isis::HistogramPlotWindow::HistogramPlotWindow(), Isis::ScatterPlotWindow::mouseMoveEvent(), Isis::PlotWindow::PlotWindow(), Isis::ScatterPlotWindow::ScatterPlotWindow(), Isis::PlotWindow::setDefaultRange(), and Isis::ScatterPlotWindow::setMousePosition().

◆ plotBackgroundColor()

QColor Isis::PlotWindow::plotBackgroundColor ( ) const

inherited

Returns the plot's background color.

Returns: QColor

Definition at line 317 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot.

◆ plotChanged

void Isis::PlotWindow::plotChanged ( )

signalinherited

Emitted every time there is a change to the plot window.

Referenced by Isis::PlotWindow::add(), Isis::PlotWindow::configurePlotCurves(), Isis::PlotWindow::dropEvent(), Isis::ScatterPlotWindow::mouseLeaveEvent(), Isis::ScatterPlotWindow::mouseMoveEvent(), Isis::PlotWindow::pasteCurve(), Isis::PlotWindow::PlotWindow(), Isis::PlotWindow::replot(), and Isis::PlotWindow::updateVisibility().

◆ plotCurves() [1/2]

QList< CubePlotCurve * > Isis::PlotWindow::plotCurves ( )

inherited

Get a comprehensive list of the plot curves inside of this plot window, excluding plot curves that are in the process of being removed.

Returns: The plot curves contained inside of this plot window

Definition at line 328 of file PlotWindow.cpp.

References Isis::PlotCurve::color(), and Isis::PlotWindow::m_plot.

Referenced by Isis::PlotWindow::configurePlotCurves(), Isis::PlotWindow::fillTable(), Isis::PlotWindow::findDataRange(), Isis::PlotWindow::paint(), and Isis::PlotWindow::showTable().

◆ plotCurves() [2/2]

QList< const CubePlotCurve * > Isis::PlotWindow::plotCurves ( ) const

inherited

Get a comprehensive const list of the plot curves inside of this plot window, excluding plot curves that are in the process of being removed.

Returns: The const plot curves contained inside of this plot window

Definition at line 354 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot.

◆ plotSpectrograms() [1/2]

QList< QwtPlotSpectrogram * > Isis::PlotWindow::plotSpectrograms ( )

inherited

Get a comprehensive list of the scatter plots (spectrograms) inside of this plot window.

Returns: The spectrograms (scatter plots) contained inside of this plot window

Definition at line 381 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot.

◆ plotSpectrograms() [2/2]

QList< const QwtPlotSpectrogram * > Isis::PlotWindow::plotSpectrograms ( ) const

inherited

Get a comprehensive const list of the scatter plots (spectrograms) inside of this plot window.

Returns: The const spectrograms (scatter plots) contained inside of this plot window

Definition at line 409 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot.

◆ plotTitle()

QString Isis::PlotWindow::plotTitle ( ) const

inherited

Returns the plot title.

Returns: QwtText

Definition at line 241 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot.

◆ printPlot

void Isis::PlotWindow::printPlot ( )

slotinherited

Provides printing support of the plot image.

Definition at line 573 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot.

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ readSettings()

void Isis::MainWindow::readSettings ( QSize defaultSize = QSize() )

protectedvirtualinherited

This method ensure that the settings get written even if the Main window was only hidden, not closed.

Parameters

event This method is called from the constructor so that when the Main window is created, it know's it's size and location.

Reimplemented in Isis::MosaicMainWindow.

Definition at line 80 of file MainWindow.cpp.

Referenced by Isis::PlotWindow::PlotWindow(), Isis::MosaicMainWindow::readSettings(), Isis::TableMainWindow::TableMainWindow(), and Isis::ViewportMainWindow::ViewportMainWindow().

◆ replot()

void Isis::PlotWindow::replot ( )

inherited

Reset the scale of the plot, replot it and emit plot changed.

Definition at line 1797 of file PlotWindow.cpp.

References Isis::PlotWindow::plotChanged(), and Isis::PlotWindow::resetScale().

Referenced by Isis::PlotWindow::add(), Isis::PlotWindow::clearPlotCurves(), Isis::ScatterPlotWindow::colorPlot(), Isis::HistogramTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::ScatterPlotWindow::ScatterPlotWindow(), setBandMarkersVisible(), Isis::PlotWindow::setUserValues(), and Isis::ScatterPlotWindow::showHideContour().

◆ resetScale

void Isis::PlotWindow::resetScale ( )

slotinherited

Sets plot scale back to the defaults.

Definition at line 660 of file PlotWindow.cpp.

References Isis::PlotCurve::Band, Isis::PlotWindow::findDataRange(), Isis::PlotWindow::m_autoscaleAxes, Isis::PlotWindow::m_plot, Isis::PlotWindow::m_xAxisUnits, Isis::PlotWindow::m_yAxisUnits, and Isis::PlotWindow::m_zoomer.

Referenced by Isis::PlotWindow::add(), Isis::PlotWindow::replot(), and Isis::PlotWindow::setupDefaultMenu().

◆ savePlot

void Isis::PlotWindow::savePlot ( )

slotinherited

This method allows the user to save the plot as a png, jpg, or tif image file.

Definition at line 605 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot.

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ scheduleFillTable

void Isis::PlotWindow::scheduleFillTable ( )

slotinherited

Fills in the table with the data from the current curves in the plotWindow once all current actions/activations are done.

This is provided for performance reasons - re-plotting 4 curves only requires one fillTable at the end, instead of after each curve change.

Definition at line 1399 of file PlotWindow.cpp.

Referenced by Isis::PlotWindow::PlotWindow().

◆ setAxisLabel()

void Isis::PlotWindow::setAxisLabel	(	int	axisId,
		QString	title
	)

inherited

Sets the plots given axis title to the given string.

Parameters

axisId
title

Definition at line 208 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot.

◆ setBandMarkersVisible

void Isis::SpectralPlotWindow::setBandMarkersVisible ( bool visible )

slot

Parameters

visible

Definition at line 205 of file SpectralPlotWindow.cpp.

References m_blueBandLine, m_grayBandLine, m_greenBandLine, m_markersVisible, m_redBandLine, and Isis::PlotWindow::replot().

Referenced by SpectralPlotWindow().

◆ setDefaultRange

void Isis::PlotWindow::setDefaultRange ( )

slotinherited

Resets the x/y min/max to the defaults.

Definition at line 743 of file PlotWindow.cpp.

References Isis::PlotWindow::autoScaleCheckboxToggled(), Isis::PlotWindow::m_autoscaleAxes, Isis::PlotWindow::m_autoScaleCheckBox, Isis::PlotWindow::m_plotXLogScale, Isis::PlotWindow::m_plotYLogScale, Isis::PlotWindow::m_xLogCheckBox, Isis::PlotWindow::m_xMaxEdit, Isis::PlotWindow::m_xMinEdit, Isis::PlotWindow::m_yLogCheckBox, Isis::PlotWindow::m_yMaxEdit, Isis::PlotWindow::m_yMinEdit, Isis::PlotWindow::plot(), and Isis::PlotWindow::setUserValues().

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ setLabels

void Isis::PlotWindow::setLabels ( )

slotinherited

Makes the user specified changes to the plot labels.

Definition at line 910 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot, Isis::PlotWindow::m_plotTitleText, Isis::PlotWindow::m_xAxisText, and Isis::PlotWindow::m_yAxisText.

Referenced by Isis::PlotWindow::changePlotLabels().

◆ setMenus()

void Isis::PlotWindow::setMenus	(	QList< QMenu *>	menu,
		QList< QAction *>	actions
	)

protectedinherited

Sets up the menus added from a parent object.

Parameters

menu
actions

Definition at line 1358 of file PlotWindow.cpp.

References Isis::PlotWindow::m_menubar, and Isis::PlotWindow::m_toolBar.

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ setPlotBackground()

void Isis::PlotWindow::setPlotBackground ( QColor c )

inherited

Sets the plot background color to the given color.

Parameters

c

Definition at line 289 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot.

Referenced by Isis::HistogramPlotWindow::HistogramPlotWindow(), and Isis::PlotWindow::PlotWindow().

◆ setPlotTitle()

void Isis::PlotWindow::setPlotTitle ( QString pt )

inherited

Sets the plot title to the given string.

This does not update the window title.

Parameters

pt	The plot title to use

Definition at line 219 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot.

Referenced by Isis::PlotWindow::PlotWindow().

◆ setUserCanAddCurves()

void Isis::PlotWindow::setUserCanAddCurves ( bool userHasControl )

inherited

Allow or disallow users from manually putting curves into this plot window through either copy-and-paste or drag-and-drop.

Parameters

userHasControl True if users can add curves manually, false otherwise

Definition at line 231 of file PlotWindow.cpp.

References Isis::PlotWindow::m_allowUserToAddCurves.

◆ setUserValues

void Isis::PlotWindow::setUserValues ( )

slotinherited

This method sets the scale for the axis according to the user specified numbers.

Definition at line 694 of file PlotWindow.cpp.

References Isis::PlotWindow::m_autoscaleAxes, Isis::PlotWindow::m_autoScaleCheckBox, Isis::PlotWindow::m_plot, Isis::PlotWindow::m_plotXLogScale, Isis::PlotWindow::m_plotYLogScale, Isis::PlotWindow::m_xLogCheckBox, Isis::PlotWindow::m_xMaxEdit, Isis::PlotWindow::m_xMinEdit, Isis::PlotWindow::m_yLogCheckBox, Isis::PlotWindow::m_yMaxEdit, Isis::PlotWindow::m_yMinEdit, Isis::PlotWindow::m_zoomer, and Isis::PlotWindow::replot().

Referenced by Isis::PlotWindow::setDefaultRange().

◆ setViewport()

void Isis::SpectralPlotWindow::setViewport ( MdiCubeViewport * cvp )

This class needs to know which viewport the user is looking at so it can appropriately draw in the band lines.

Parameters

cvp

Definition at line 194 of file SpectralPlotWindow.cpp.

References m_cvp.

Referenced by update().

◆ showHelp

void Isis::PlotWindow::showHelp ( )

slotinherited

This method creates and shows the help dialog box for the plot window.

this is called from the Help–>Basic Help menu.

Definition at line 999 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot.

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ showHideAllCurves

void Isis::PlotWindow::showHideAllCurves ( )

slotinherited

This method shows or hides all of the curves in the plotWindow.

Definition at line 967 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot, and Isis::PlotWindow::m_showHideAllCurves.

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ showHideAllMarkers

void Isis::PlotWindow::showHideAllMarkers ( )

slotinherited

Shows/Hides all the markers(symbols)

Definition at line 939 of file PlotWindow.cpp.

References Isis::PlotWindow::m_plot, and Isis::PlotWindow::m_showHideAllMarkers.

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ showHideGrid

void Isis::PlotWindow::showHideGrid ( )

slotinherited

This method hides/shows the grid on the plotWindow and changes the text for the action.

Definition at line 923 of file PlotWindow.cpp.

References Isis::PlotWindow::m_grid, Isis::PlotWindow::m_plot, and Isis::PlotWindow::m_showHideGrid.

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ showTable

void Isis::PlotWindow::showTable ( )

slotinherited

This method is called from the showTable action on the tool bar There are some checks done to make sure there are data to fill the table.

Definition at line 1566 of file PlotWindow.cpp.

References Isis::PlotWindow::fillTable(), Isis::PlotWindow::m_parent, Isis::PlotWindow::m_tableWindow, Isis::PlotWindow::plotCurves(), Isis::TableMainWindow::setTrackListItems(), and Isis::TableMainWindow::syncColumns().

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ showWindow()

void Isis::PlotWindow::showWindow ( )

inherited

Shows the plot window, and raises it to the front of any overlapping sibling widgets.

Definition at line 185 of file PlotWindow.cpp.

Referenced by Isis::AbstractPlotTool::selectedWindowChanged(), and Isis::AbstractPlotTool::showPlotWindow().

◆ switchBackground

void Isis::PlotWindow::switchBackground ( )

slotinherited

This method toggles the plot background color between black and white.

Definition at line 635 of file PlotWindow.cpp.

References Isis::PlotWindow::m_grid, Isis::PlotWindow::m_plot, and Isis::PlotWindow::m_zoomer.

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ trackerEnabled

void Isis::PlotWindow::trackerEnabled ( )

slotinherited

Enables the plot mouse tracker.

Definition at line 560 of file PlotWindow.cpp.

References Isis::PlotWindow::m_zoomer.

Referenced by Isis::PlotWindow::setupDefaultMenu().

◆ update()

void Isis::SpectralPlotWindow::update ( MdiCubeViewport * activeViewport )

virtual

This window can show markers for the currently visible bands.

This will synchronize the markers with the given viewport.

Parameters

activeViewport The viewport to synchronize this plot window with

Reimplemented from Isis::PlotWindow.

Definition at line 223 of file SpectralPlotWindow.cpp.

References drawBandMarkers(), and setViewport().

◆ userCanAddCurves()

bool Isis::PlotWindow::userCanAddCurves ( ) const

inherited

Ask if a user action can add this curve to this window in general.

This verifies that the user is allowed to add curves to this window but not that a particular curve is compatible with this window.

Returns: True if the user should be allowed to paste/drop curves in general into this window

Definition at line 254 of file PlotWindow.cpp.

References Isis::PlotWindow::m_allowUserToAddCurves.

◆ xAxisUnits()

PlotCurve::Units Isis::PlotWindow::xAxisUnits ( ) const

inherited

This is the data-type of the curves' x data in this plot window.

All of the cube plot curves must have the same units for x axis data or the display will not make sense.

Returns: X-Axis Curve Data Units

Definition at line 266 of file PlotWindow.cpp.

References Isis::PlotWindow::m_xAxisUnits.

Referenced by drawBandMarkers(), Isis::PlotWindow::PlotWindow(), Isis::SpatialPlotTool::refreshPlot(), and Isis::SpectralPlotTool::refreshPlot().

◆ yAxisUnits()

PlotCurve::Units Isis::PlotWindow::yAxisUnits ( ) const

inherited

This is the data-type of the curves' y data in this plot window.

All of the cube plot curves must have the same units for y-left axis data (y-right sometimes has different units) or the display will not make sense.

Returns: Left Y-Axis Data Units

Definition at line 278 of file PlotWindow.cpp.

References Isis::PlotWindow::m_yAxisUnits.

Referenced by Isis::PlotWindow::PlotWindow().

◆ zoomer()

QwtPlotZoomer * Isis::PlotWindow::zoomer ( )

protectedinherited

Get this window's plot's zoomer.

Returns: A QwtPlotZoomer which is associated with this PlotWindow's QwtPlot

Definition at line 1388 of file PlotWindow.cpp.

References Isis::PlotWindow::m_zoomer.

Referenced by Isis::ScatterPlotWindow::ScatterPlotWindow().

Member Data Documentation

◆ m_blueBandLine

QwtPlotMarker* Isis::SpectralPlotWindow::m_blueBandLine

private

The band marker for the blue band.

Definition at line 75 of file SpectralPlotWindow.h.

Referenced by drawBandMarkers(), nullify(), setBandMarkersVisible(), and SpectralPlotWindow().

◆ m_cvp

MdiCubeViewport* Isis::SpectralPlotWindow::m_cvp

private

The viewport to be used as a reference for band markers.

Definition at line 65 of file SpectralPlotWindow.h.

Referenced by drawBandMarkers(), nullify(), and setViewport().

◆ m_grayBandLine

QwtPlotMarker* Isis::SpectralPlotWindow::m_grayBandLine

private

The band marker for the gray band.

Definition at line 69 of file SpectralPlotWindow.h.

Referenced by drawBandMarkers(), nullify(), setBandMarkersVisible(), and SpectralPlotWindow().

◆ m_greenBandLine

QwtPlotMarker* Isis::SpectralPlotWindow::m_greenBandLine

private

The band marker for the green band.

Definition at line 73 of file SpectralPlotWindow.h.

Referenced by drawBandMarkers(), nullify(), setBandMarkersVisible(), and SpectralPlotWindow().

◆ m_markersVisible

bool Isis::SpectralPlotWindow::m_markersVisible

private

True if the visibile state of the active markers should be true.

Definition at line 67 of file SpectralPlotWindow.h.

Referenced by bandMarkersVisible(), drawBandMarkers(), and setBandMarkersVisible().

◆ m_redBandLine

QwtPlotMarker* Isis::SpectralPlotWindow::m_redBandLine

private

The band marker for the red band.

Definition at line 71 of file SpectralPlotWindow.h.

Referenced by drawBandMarkers(), nullify(), setBandMarkersVisible(), and SpectralPlotWindow().

◆ m_showHideBandMarkers

QAction* Isis::SpectralPlotWindow::m_showHideBandMarkers

private

This action toggles band marker visibility.

Definition at line 77 of file SpectralPlotWindow.h.

Referenced by nullify(), and SpectralPlotWindow().

The documentation for this class was generated from the following files:

src/qisis/objs/SpectralPlotTool/SpectralPlotWindow.h
src/qisis/objs/SpectralPlotTool/SpectralPlotWindow.cpp

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ MenuOptions

Constructor & Destructor Documentation

◆ SpectralPlotWindow()

Member Function Documentation

◆ add()

◆ bandMarkersVisible()

◆ canAdd()

◆ changePlotLabels

◆ clearPlot

◆ clearPlotCurves()

◆ closed

◆ closeEvent()

◆ configurePlotCurves

◆ createBestFitLine

◆ createMarker()

◆ createWidgets()

◆ defaultWindowTitle()

◆ disableAxisAutoScale()

◆ dragEnterEvent()

◆ drawBandMarkers()

◆ dropEvent()

◆ eventFilter()

◆ fillTable

◆ mousePressEvent()

◆ nullify()

◆ paint()

◆ plot()

◆ plotBackgroundColor()

◆ plotChanged

◆ plotCurves() [1/2]

◆ plotCurves() [2/2]

◆ plotSpectrograms() [1/2]

◆ plotSpectrograms() [2/2]

◆ plotTitle()

◆ printPlot

◆ readSettings()

◆ replot()

◆ resetScale

◆ savePlot

◆ scheduleFillTable

◆ setAxisLabel()

◆ setBandMarkersVisible

◆ setDefaultRange

◆ setLabels

◆ setMenus()

◆ setPlotBackground()

◆ setPlotTitle()

◆ setUserCanAddCurves()

◆ setUserValues

◆ setViewport()

◆ showHelp

◆ showHideAllCurves

◆ showHideAllMarkers

◆ showHideGrid

◆ showTable

◆ showWindow()

◆ switchBackground

◆ trackerEnabled

◆ update()

◆ userCanAddCurves()

◆ xAxisUnits()

◆ yAxisUnits()

◆ zoomer()

Member Data Documentation

◆ m_blueBandLine

◆ m_cvp

◆ m_grayBandLine

◆ m_greenBandLine

◆ m_markersVisible

◆ m_redBandLine