Isis::SpectralPlotTool Class Reference

Plot cube DN statistics against the cube band numbers. More...

#include <SpectralPlotTool.h>

Public Slots
void	refreshPlot ()
	This method replots the data, with current settings and rubber band, in the plot window.
void	removeWindow (QObject *)
	When a user closes a window, we want to remove that window from our QComboBox.
void	repaintViewports (CubePlotCurve *)
	This method causes the viewports corresponding with the given CubePlotCurve to be repainted with all of the area's of interest associated with the CubePlotCurve's plotwindow.
void	showPlotWindow ()
	displays the plot window
void	activate (bool)
	Activates the tool.
void	setCubeViewport (MdiCubeViewport *cvp)
	Sets the current viewport to the given cvp.
Signals
void	clearWarningSignal ()
void	viewportChanged ()
Public Member Functions
	SpectralPlotTool (QWidget *parent)
	This constructs a plot tool.
virtual void	paintViewport (MdiCubeViewport vp, QPainter painter)
	This method paints the polygons of the copied curves onto the cubeviewport.
void	addTo (ViewportMainWindow *mw)
	Adds the tool to the application.
void	addTo (ToolPad *toolpad)
	Adds the tool to the toolpad.
virtual void	addTo (Workspace *ws)
	requires the programmer to have this member
virtual void	addToPermanent (QToolBar *toolbar)
	requires the programmer to have this member
void	addToActive (QToolBar *toolbar)
QString	toolIconDir () const
	returns the path to the icon directory.
Protected Types
typedef QVector < MdiCubeViewport * >	CubeViewportList
	A list of cubeviewports.
Protected Slots
virtual void	rubberBandComplete ()
	Called when the user has finished drawing with the rubber band.
void	viewportSelected ()
	This protected slot is called when user selects a viewport.
void	repaintViewports ()
virtual void	screenPixelsChanged ()
	This is called when actions change which pixels from the cube are displayed.
virtual void	mouseEnter ()
virtual void	mouseMove (QPoint p)
virtual void	mouseMove (QPoint p, Qt::MouseButton)
virtual void	mouseLeave ()
virtual void	mouseDoubleClick (QPoint p)
virtual void	mouseButtonPress (QPoint p, Qt::MouseButton s)
virtual void	mouseButtonRelease (QPoint p, Qt::MouseButton s)
	Resets the Warning to Nowarning when a different activity occurs on the application.
virtual void	updateMeasure ()
virtual void	scaleChanged ()
virtual void	stretchRequested (MdiCubeViewport *, int)
void	registerTool (MdiCubeViewport *viewport)
	Registers the tool to the viewport.
Protected Member Functions
void	addTo (QMenu *menu)
	Adds the plot tool to the menu.
QWidget *	createToolBarWidget (QStackedWidget *parent)
	Creates the widgets for the tool bar.
virtual PlotWindow *	createWindow ()
	Creates the active plot window.
virtual void	detachCurves ()
	This will be called when the selected plot window changes.
void	enableRubberBandTool ()
	This method is called when the tool is activated by the parent, or when the plot mode is changed.
QComboBox *	spectralDisplayCombo () const
QAction *	toolPadAction (ToolPad *pad)
void	updateTool ()
	Updates plot tool.
PlotWindow *	addWindow ()
QList< MdiCubeViewport * >	viewportsToPlot ()
QList< PlotWindow * >	plotWindows ()
PlotWindow *	selectedWindow (bool createIfNeeded=true)
MdiCubeViewport *	cubeViewport () const
	Return the current cubeviewport.
CubeViewportList *	cubeViewportList () const
	Return the list of cubeviewports.
virtual QString	menuName () const
	Anytime a tool is created, you must give it a name for the menu.
virtual void	addConnections (MdiCubeViewport *cvp)
	Anytime a tool is created, you must add the connections for it.
virtual void	removeConnections (MdiCubeViewport *cvp)
	Anytime a tool is created, you must be able to remove it's connections.
Static Protected Member Functions
static CubePlotCurve *	createCurve (QString name, QPen pen, PlotCurve::Units xUnits, PlotCurve::Units yUnits)
Protected Attributes
MdiCubeViewport *	p_cvp
	current cubeviewport
Workspace *	p_workspace

Detailed Description

Plot cube DN statistics against the cube band numbers.

This will plot DN statistics against the cube band numbers. The statistical values plotted are the minimum, maximum, mean, mean + standard deviation and mean - standard deviation.

Author:: ????-??-?? Stacy Alley

Member Typedef Documentation

typedef QVector< MdiCubeViewport * > Isis::Tool::CubeViewportList [protected, inherited]

A list of cubeviewports.

Constructor & Destructor Documentation

Isis::SpectralPlotTool::SpectralPlotTool ( QWidget * parent )

This constructs a plot tool.

The plot tool graphs either DN values across a line, or statistics across a spectrum (bands).

Parameters:

parent

References Isis::Tool::toolIconDir(), Isis::Tool::viewportChanged(), and viewportSelected().

Member Function Documentation

void Tool::activate ( bool on ) [slot, inherited]

Activates the tool.

Parameters:

on

References Isis::Tool::clearWarningSignal().

Referenced by Isis::Tool::addTo(), Isis::AdvancedTrackTool::addTo(), Isis::RubberBandTool::disableBanding(), Isis::RubberBandTool::enableBanding(), Isis::TrackTool::TrackTool(), and Isis::WindowTool::WindowTool().

virtual void Isis::Tool::addConnections ( MdiCubeViewport * cvp ) [inline, protected, virtual, inherited]

Anytime a tool is created, you must add the connections for it.

Parameters:

cvp

Reimplemented in Isis::TrackTool, and Isis::WindowTool.

void Tool::addTo ( Workspace * ws ) [virtual, inherited]

requires the programmer to have this member

Adds the given workspace to the cubeviewport list.

Parameters:

ws

Reimplemented in Isis::FileTool, and Isis::WindowTool.

References Isis::Tool::p_workspace, Isis::Tool::registerTool(), and Isis::Tool::setCubeViewport().

void Tool::addTo ( ToolPad * toolpad ) [inherited]

Adds the tool to the toolpad.

Parameters:

toolpad

References Isis::Tool::activate(), Isis::ToolPad::addAction(), and Isis::Tool::toolPadAction().

void Tool::addTo ( ViewportMainWindow * pViewPortMnWin ) [inherited]

Adds the tool to the application.

Parameters:

pViewPortMnWin

References Isis::ViewportMainWindow::activeToolBar(), Isis::Tool::addToActive(), Isis::Tool::addToPermanent(), Isis::ViewportMainWindow::getMenu(), Isis::Tool::menuName(), Isis::ViewportMainWindow::permanentToolBar(), Isis::ViewportMainWindow::toolPad(), and Isis::ViewportMainWindow::workspace().

Referenced by Isis::ViewportMainWindow::ViewportMainWindow().

void Isis::SpectralPlotTool::addTo ( QMenu * menu ) [protected, virtual]

Adds the plot tool to the menu.

Parameters:

menu

Reimplemented from Isis::Tool.

void Tool::addToActive ( QToolBar * toolbar ) [inherited]

Parameters:

toolbar

References Isis::Tool::createToolBarWidget().

Referenced by Isis::Tool::addTo().

virtual void Isis::Tool::addToPermanent ( QToolBar * toolbar ) [inline, virtual, inherited]

requires the programmer to have this member

Parameters:

toolbar

Reimplemented in Isis::AdvancedTrackTool, Isis::BlinkTool, Isis::FileTool, Isis::HelpTool, Isis::SpecialPixelTool, and Isis::WindowTool.

Referenced by Isis::Tool::addTo().

PlotWindow * Isis::AbstractPlotTool::addWindow ( ) [protected, inherited]

Referenced by refreshPlot().

void Tool::clearWarningSignal ( ) [signal, inherited]

Referenced by Isis::Tool::activate(), Isis::Tool::mouseButtonPress(), Isis::Tool::mouseButtonRelease(), and Isis::Tool::mouseDoubleClick().

CubePlotCurve * Isis::AbstractPlotTool::createCurve	(	QString	name,
		QPen	pen,
		PlotCurve::Units	xUnits,
		PlotCurve::Units	yUnits
	)			`[static, protected, inherited]`

QWidget * Isis::SpectralPlotTool::createToolBarWidget ( QStackedWidget * parent ) [protected, virtual]

Creates the widgets for the tool bar.

Parameters:

parent

Returns:: QWidget*

Reimplemented from Isis::AbstractPlotTool.

References Isis::RubberBandComboBox::Polygon, Isis::RubberBandComboBox::Rectangle, and spectralDisplayCombo().

PlotWindow * Isis::SpectralPlotTool::createWindow ( ) [protected, virtual]

Creates the active plot window.

Implements Isis::AbstractPlotTool.

References Isis::PlotWindow::defaultWindowTitle().

MdiCubeViewport* Isis::Tool::cubeViewport ( ) const [inline, protected, inherited]

Return the current cubeviewport.

Returns:: CubeViewport*

References Isis::Tool::p_cvp.

Tool::CubeViewportList * Tool::cubeViewportList ( ) const [protected, inherited]

Return the list of cubeviewports.

Returns:: CubeViewportList*

References Isis::Workspace::cubeViewportList(), and Isis::Tool::p_workspace.

Referenced by Isis::RubberBandTool::mouseButtonRelease(), Isis::PanTool::mouseButtonRelease(), Isis::RubberBandTool::mouseMove(), Isis::ScatterPlotTool::repaintViewports(), Isis::ZoomTool::rubberBandComplete(), Isis::MeasureTool::rubberBandComplete(), Isis::StretchTool::stretchGlobalAllViewports(), and Isis::WindowTool::updateTool().

void Isis::SpectralPlotTool::detachCurves ( ) [protected, virtual]

This will be called when the selected plot window changes.

The existing curves need to be detached (forgotten, but not deleted). The curves are being detached between the previously selected window and the tool.

Implements Isis::AbstractPlotTool.

void Isis::SpectralPlotTool::enableRubberBandTool ( ) [protected, virtual]

This method is called when the tool is activated by the parent, or when the plot mode is changed.

It's used to activate or change the rubber banding mode to be either rectangle or line, depending on the current plot type.

Reimplemented from Isis::Tool.

virtual QString Isis::Tool::menuName ( ) const [inline, protected, virtual, inherited]

Anytime a tool is created, you must give it a name for the menu.

Returns:: QString

Reimplemented in Isis::AdvancedTrackTool, Isis::BandTool, Isis::BlinkTool, Isis::FileTool, Isis::FindTool, Isis::HelpTool, Isis::MeasureTool, Isis::PanTool, Isis::SpecialPixelTool, Isis::StretchTool, Isis::WindowTool, and Isis::ZoomTool.

Referenced by Isis::Tool::addTo().

void Tool::mouseButtonPress	(	QPoint	p,
		Qt::MouseButton	s
	)			`[protected, virtual, slot, inherited]`

Parameters:

	p
	s

Reimplemented in Isis::PanTool, and Isis::RubberBandTool.

References Isis::Tool::clearWarningSignal().

void Tool::mouseButtonRelease	(	QPoint	p,
		Qt::MouseButton	s
	)			`[protected, virtual, slot, inherited]`

Resets the Warning to Nowarning when a different activity occurs on the application.

This is called by all the mouseButtonRelease events in all the tools.

Parameters:

	p
	s

Reimplemented in Isis::EditTool, Isis::FindTool, Isis::PanTool, Isis::RubberBandTool, Isis::StatisticsTool, and Isis::StretchTool.

References Isis::Tool::clearWarningSignal().

void Tool::mouseDoubleClick ( QPoint p ) [protected, virtual, slot, inherited]

Parameters:

p

Reimplemented in Isis::RubberBandTool.

References Isis::Tool::clearWarningSignal().

virtual void Isis::Tool::mouseEnter ( ) [inline, protected, virtual, slot, inherited]

virtual void Isis::Tool::mouseLeave ( ) [inline, protected, virtual, slot, inherited]

Reimplemented in Isis::AdvancedTrackTool, Isis::MeasureTool, Isis::ScatterPlotTool, and Isis::TrackTool.

virtual void Isis::Tool::mouseMove	(	QPoint	p,
		Qt::MouseButton
	)			`[inline, protected, virtual, slot, inherited]`

Reimplemented in Isis::RubberBandTool, and Isis::ScatterPlotTool.

void Tool::mouseMove ( QPoint p ) [protected, virtual, slot, inherited]

Parameters:

p

Reimplemented in Isis::AdvancedTrackTool, Isis::PanTool, and Isis::TrackTool.

void Isis::AbstractPlotTool::paintViewport	(	MdiCubeViewport *	vp,
		QPainter *	painter
	)			`[virtual, inherited]`

This method paints the polygons of the copied curves onto the cubeviewport.

Parameters:

	vp
	painter

Reimplemented from Isis::Tool.

References Isis::PlotWindow::paint().

QList< PlotWindow * > Isis::AbstractPlotTool::plotWindows ( ) [protected, inherited]

Referenced by Isis::AbstractPlotTool::viewportsToPlot().

void Isis::SpectralPlotTool::refreshPlot ( ) [slot]

This method replots the data, with current settings and rubber band, in the plot window.

References Isis::Statistics::AddData(), Isis::AbstractPlotTool::addWindow(), Isis::CubeViewport::cube(), cube, Isis::Tool::cubeViewport(), Isis::PvlContainer::FindKeyword(), Isis::PvlObject::FindObject(), Isis::Cube::getLabel(), Isis::RubberBandTool::getVertices(), Isis::PvlContainer::HasKeyword(), Isis::IsSpecial(), Isis::RubberBandTool::isValid(), pvl(), Isis::PlotWindow::replot(), Isis::AbstractPlotTool::selectedWindow(), Isis::PvlKeyword::Size(), updateTool(), Isis::AbstractPlotTool::viewportsToPlot(), and Isis::PlotWindow::xAxisUnits().

Referenced by rubberBandComplete().

void Tool::registerTool ( MdiCubeViewport * viewport ) [protected, slot, inherited]

Registers the tool to the viewport.

Parameters:

viewport

References Isis::Tool::p_cvp, Isis::MdiCubeViewport::registerTool(), and Isis::Tool::stretchRequested().

Referenced by Isis::Tool::addTo().

virtual void Isis::Tool::removeConnections ( MdiCubeViewport * cvp ) [inline, protected, virtual, inherited]

Anytime a tool is created, you must be able to remove it's connections.

Parameters:

cvp

Reimplemented in Isis::MeasureTool, Isis::TrackTool, and Isis::WindowTool.

void Isis::AbstractPlotTool::removeWindow ( QObject * window ) [slot, inherited]

When a user closes a window, we want to remove that window from our QComboBox.

void Isis::AbstractPlotTool::repaintViewports ( ) [protected, slot, inherited]

References Isis::AbstractPlotTool::selectedWindow(), and Isis::PlotWindow::showWindow().

void Isis::AbstractPlotTool::repaintViewports ( CubePlotCurve * pc ) [slot, inherited]

This method causes the viewports corresponding with the given CubePlotCurve to be repainted with all of the area's of interest associated with the CubePlotCurve's plotwindow.

void Isis::SpectralPlotTool::rubberBandComplete ( ) [protected, virtual, slot]

Called when the user has finished drawing with the rubber band.

ChangePlot is called to plot the data within the rubber band.

Reimplemented from Isis::Tool.

References Isis::RubberBandTool::isValid(), refreshPlot(), and Isis::AbstractPlotTool::selectedWindow().

virtual void Isis::Tool::scaleChanged ( ) [inline, protected, virtual, slot, inherited]

Reimplemented in Isis::RubberBandTool.

virtual void Isis::Tool::screenPixelsChanged ( ) [inline, protected, virtual, slot, inherited]

This is called when actions change which pixels from the cube are displayed.

Reimplemented in Isis::StretchTool.

PlotWindow * Isis::AbstractPlotTool::selectedWindow ( bool createIfNeeded = true ) [protected, inherited]