Tool for histograms. More...

#include <HistogramTool.h>

Inheritance diagram for Isis::HistogramTool:

Collaboration diagram for Isis::HistogramTool:

Public Slots
void	refreshPlot ()
	This method plots the selected data in a histogram window. More...

void	removeWindow (QObject *)
	When a user closes a window, we want to remove that window from our combo box for selecting the active window. More...

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. More...

void	showPlotWindow ()
	displays the plot window More...

void	activate (bool)
	Activates the tool. More...

void	setCubeViewport (MdiCubeViewport *cvp)
	Sets the current viewport to the given cvp. More...

Signals
void	clearWarningSignal ()

void	toolActivated ()

void	viewportChanged ()

Public Member Functions
	HistogramTool (QWidget *parent)
	Constructor creates a new HistogramTool object. More...

virtual void	paintViewport (MdiCubeViewport vp, QPainter painter)
	This method allows each plot window to paint any information it wants onto the cube viewports. More...

void	addTo (ViewportMainWindow *mw)
	Adds the tool to the application. More...

void	addTo (ToolPad *toolpad)
	Adds the tool to the toolpad. More...

virtual void	addTo (QMenu *menu)

virtual void	addTo (Workspace *ws)
	Adds the given workspace to the cubeviewport list. More...

virtual QString	menuName () const
	Anytime a tool is created, you must give it a name for the menu. More...

virtual void	addToPermanent (QToolBar *toolbar)

void	addToActive (QToolBar *toolbar)

QString	toolIconDir () const
	returns the path to the icon directory. More...

RubberBandTool *	rubberBandTool ()

void	setList (ToolList *currentList)

Protected Types
typedef QVector< MdiCubeViewport *>	CubeViewportList
	A list of cubeviewports. More...

Protected Slots
void	rubberBandComplete ()
	Called when the user has finished drawing with the rubber band. More...

void	repaintViewports ()
	This method causes all of the viewports to be repainted. More...

virtual void	screenPixelsChanged ()
	This is called when actions change which pixels from the cube are displayed. More...

virtual void	mouseEnter ()

virtual void	mouseMove (QPoint p)

virtual void	mouseMove (QPoint p, Qt::MouseButton)

virtual void	mouseLeave ()

Protected Member Functions
QWidget *	createToolBarWidget (QStackedWidget *parent)
	This method creates the widgets for the tool bar. More...

void	detachCurves ()
	Forget the frequency histogram item and the percentage curve. More...

PlotWindow *	createWindow ()
	This method creates the default histogram plot window. More...

void	enableRubberBandTool ()
	This method is called when the tool is activated by the parent, or when the plot mode is changed. More...

QAction *	toolPadAction (ToolPad *pad)
	This method adds the histogram tool to the tool pad. More...

void	updateTool ()
	This method updates the histogram tool. More...

PlotWindow *	addWindow ()
	This creates and initializes everything about a plot window. More...

QList< MdiCubeViewport * >	viewportsToPlot ()
	Get a list of linked viewports that should be plotting when a new plot is requested. More...

QList< PlotWindow * >	plotWindows ()
	Get a list of all of the instantiated plot windows. More...

PlotWindow *	selectedWindow (bool createIfNeeded=true)
	Get the 'active' plot window (the window selected by the user to contain new curves). More...

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. More...

virtual void	updateMeasure ()

virtual void	scaleChanged ()

virtual void	stretchRequested (MdiCubeViewport *, int)

void	registerTool (MdiCubeViewport *viewport)
	Registers the tool to the viewport. More...

MdiCubeViewport *	cubeViewport () const
	Return the current cubeviewport. More...

CubeViewportList *	cubeViewportList () const
	Return the list of cubeviewports. More...

virtual void	addConnections (MdiCubeViewport *cvp)
	Anytime a tool is created, you must add the connections for it. More...

virtual void	removeConnections (MdiCubeViewport *cvp)
	Anytime a tool is created, you must be able to remove it's connections. More...

Workspace *	workspace ()

Static Protected Member Functions
static CubePlotCurve *	createCurve (QString name, QPen pen, PlotCurve::Units xUnits, PlotCurve::Units yUnits)
	This is a helper method for children. More...

Private Member Functions
void	validatePlotCurves ()
	This method sets up the names, line style, and color of the all the plot items that will be used in this class. More...

Private Attributes
HistogramToolWindow *	m_histToolWindow
	Plot Tool Window Widget. More...

QPointer< HistogramItem >	m_frequencyItem
	This is the qwt plot item which draws the histogram frequency bars. More...

QPointer< CubePlotCurve >	m_percentageCurve
	This plot curve indicates the data percentage over the histogram. More...

QAction *	m_action
	This is the action that activates this tool. More...

QPointer< RubberBandComboBox >	m_rubberBandCombo
	This combo box is for various rubber band selection types. More...

Detailed Description

Tool for histograms.

Author: ????-??-?? Noah Hilt

History:

2008-08-18 Christopher Austin - Upgraded to geos3.0.0

2012-01-18 Steven Lambright and Jai Rideout - Fixed issue where histograms were not created correctly for any bands but band 1. Added check for RGB mode. Fixes #668.

2012-01-20 Steven Lambright - Completed documentation.

2013-12-11 Janet Barrett - Fixed refreshPlot method so that it checks the start sample and end sample for the plot and starts the plot at the minimum of the 2 samples. Fixes #1760.

2016-04-28 Tracie Sucharski - Removed qwt refernces to merge with Qt5 library changes.

2016-07-06 Adam Paquette - Fixed the histogram tool to analyze the appropriate pixels selected when using box banding

Definition at line 40 of file HistogramTool.h.

Member Typedef Documentation

◆ CubeViewportList

typedef QVector< MdiCubeViewport * > Isis::Tool::CubeViewportList

protectedinherited

A list of cubeviewports.

Definition at line 219 of file Tool.h.

Constructor & Destructor Documentation

◆ HistogramTool()

Isis::HistogramTool::HistogramTool ( QWidget * parent )

Constructor creates a new HistogramTool object.

Parameters

parent

Definition at line 30 of file HistogramTool.cpp.

References m_action, and Isis::Tool::toolIconDir().

Member Function Documentation

◆ activate

void Isis::Tool::activate ( bool on )

slotinherited

Activates the tool.

Parameters

on

Definition at line 131 of file Tool.cpp.

References Isis::Tool::addViewportConnections(), Isis::Tool::disableToolBar(), Isis::Tool::enableToolBar(), Isis::Tool::m_active, Isis::Tool::m_toolPadAction, and Isis::Tool::removeViewportConnections().

Referenced by Isis::Tool::addTo(), Isis::AdvancedTrackTool::AdvancedTrackTool(), Isis::RubberBandTool::disable(), Isis::RubberBandTool::enable(), Isis::AdvancedTrackTool::eventFilter(), Isis::FileTool::FileTool(), Isis::RubberBandTool::RubberBandTool(), Isis::TrackTool::TrackTool(), Isis::WindowTool::WindowTool(), and Isis::Workspace::Workspace().

◆ addConnections()

virtual void Isis::Tool::addConnections ( MdiCubeViewport * cvp )

inlineprotectedvirtualinherited

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

Parameters

cvp

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

Definition at line 253 of file Tool.h.

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

◆ addTo() [1/4]

void Isis::Tool::addTo ( ViewportMainWindow * pViewPortMnWin )

inherited

Adds the tool to the application.

Parameters

pViewPortMnWin

Definition at line 78 of file Tool.cpp.

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::WindowTool::addTo(), Isis::SpecialPixelTool::addTo(), Isis::FileTool::addTo(), Isis::EditTool::addTo(), Isis::ViewportMainWindow::ViewportMainWindow(), and Isis::Workspace::Workspace().

◆ addTo() [2/4]

void Isis::Tool::addTo ( ToolPad * toolpad )

inherited

Adds the tool to the toolpad.

Parameters

toolpad

Definition at line 98 of file Tool.cpp.

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

◆ addTo() [3/4]

virtual void Isis::Tool::addTo ( QMenu * menu )

inlinevirtualinherited

Parameters

menu

Reimplemented in Isis::FindTool, Isis::FeatureNomenclatureTool, Isis::AdvancedTrackTool, Isis::StretchTool, Isis::QnetFileTool, Isis::ZoomTool, Isis::FileTool, Isis::SpectralPlotTool, Isis::MeasureTool, Isis::SunShadowTool, Isis::HelpTool, Isis::SpecialPixelTool, Isis::BlinkTool, Isis::WindowTool, and Isis::PanTool.

Definition at line 105 of file Tool.h.

◆ addTo() [4/4]

void Isis::Tool::addTo ( Workspace * ws )

virtualinherited

Adds the given workspace to the cubeviewport list.

Parameters

ws

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

Definition at line 45 of file Tool.cpp.

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

◆ addToActive()

void Isis::Tool::addToActive ( QToolBar * toolbar )

inherited

Parameters

toolbar

Definition at line 112 of file Tool.cpp.

References Isis::Tool::createToolBarWidget(), Isis::Tool::disableToolBar(), and Isis::Tool::m_toolBarWidget.

Referenced by Isis::Tool::addTo(), and Isis::Workspace::Workspace().

◆ addToPermanent()

virtual void Isis::Tool::addToPermanent ( QToolBar * toolbar )

inlinevirtualinherited

Parameters

toolbar

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

Definition at line 111 of file Tool.h.

Referenced by Isis::Tool::addTo(), and Isis::Workspace::Workspace().

◆ addWindow()

PlotWindow * Isis::AbstractPlotTool::addWindow ( )

protectedinherited

This creates and initializes everything about a plot window.

This updates the window's title to be unique, adds it to the active plot window combo box, listens for the window to be removed and selects it in the active plot window combo box. Call this if you need a new plot window.

Returns: The newly initialized plot window

Definition at line 295 of file AbstractPlotTool.cpp.

References Isis::AbstractPlotTool::createWindow(), Isis::AbstractPlotTool::m_selectWindowCombo, Isis::AbstractPlotTool::removeWindow(), and Isis::AbstractPlotTool::repaintViewports().

Referenced by Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::AbstractPlotTool::selectedWindow(), and Isis::AbstractPlotTool::selectedWindowChanged().

◆ createCurve()

CubePlotCurve * Isis::AbstractPlotTool::createCurve	(	QString	name,
		QPen	pen,
		PlotCurve::Units	xUnits,
		PlotCurve::Units	yUnits
	)

staticprotectedinherited

This is a helper method for children.

Given a title, a color, and units a new CubePlotCurve is created.

Parameters

name	The title of the curve to be created
pen	The color & thickness of the curve
xUnits	The units of the x-axis associated with this curve. This must match the plot window's x axis.
yUnits	The units of the y-axis associated with this curve. This must match the plot window's y axis.

Returns: createCurve The requested plot curve

Definition at line 225 of file AbstractPlotTool.cpp.

References Isis::PlotCurve::setColor(), and Isis::PlotCurve::setPen().

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

◆ createToolBarWidget()

QWidget * Isis::HistogramTool::createToolBarWidget ( QStackedWidget * parent )

protectedvirtual

This method creates the widgets for the tool bar.

Parameters

parent

Returns: QWidget*

Reimplemented from Isis::AbstractPlotTool.

Definition at line 81 of file HistogramTool.cpp.

References Isis::AbstractPlotTool::createToolBarWidget(), Isis::RubberBandComboBox::Line, m_rubberBandCombo, and Isis::RubberBandComboBox::Rectangle.

◆ createWindow()

PlotWindow * Isis::HistogramTool::createWindow ( )

protectedvirtual

This method creates the default histogram plot window.

Implements Isis::AbstractPlotTool.

Definition at line 126 of file HistogramTool.cpp.

References Isis::PlotWindow::defaultWindowTitle().

◆ cubeViewport()

MdiCubeViewport* Isis::Tool::cubeViewport ( ) const

inlineprotectedinherited

Return the current cubeviewport.

Returns: CubeViewport*

Definition at line 211 of file Tool.h.

References Isis::Tool::m_cvp.

◆ cubeViewportList()

Tool::CubeViewportList * Isis::Tool::cubeViewportList ( ) const

protectedinherited

Return the list of cubeviewports.

Returns: CubeViewportList*

Definition at line 390 of file Tool.cpp.

References Isis::Workspace::cubeViewportList().

Referenced by Isis::BlinkTool::advance(), Isis::SpecialPixelTool::apply(), Isis::FindTool::centerLinkedViewports(), Isis::WindowTool::changeCursor(), Isis::FileTool::closeAll(), Isis::BandTool::copyAllViewports(), Isis::BandTool::copyLinkedViewports(), Isis::MatchTool::createPoint(), Isis::BlinkTool::eventFilter(), Isis::FeatureNomenclatureTool::featuresIdentified(), Isis::FeatureNomenclatureTool::findMissingNomenclature(), Isis::FeatureNomenclatureTool::findNomenclatureStateChanged(), Isis::FindTool::handleLinkClicked(), Isis::WindowTool::linkWindows(), Isis::RubberBandTool::mouseButtonRelease(), Isis::RubberBandTool::mouseMove(), Isis::QnetTool::openGround(), Isis::StereoTool::paintAllViewports(), Isis::ControlNetTool::paintAllViewports(), Isis::MatchTool::paintAllViewports(), Isis::QnetTool::paintAllViewports(), Isis::FindTool::refresh(), Isis::ScatterPlotTool::repaintViewports(), Isis::AbstractPlotTool::repaintViewports(), Isis::WindowTool::resizeWindows(), Isis::BlinkTool::reverse(), Isis::ZoomTool::rubberBandComplete(), Isis::MatchTool::serialNumberList(), Isis::ControlNetTool::setControlNet(), Isis::FeatureNomenclatureTool::setFontColor(), Isis::FeatureNomenclatureTool::setFontSize(), Isis::FeatureNomenclatureTool::setShowApprovedOnly(), Isis::StretchTool::setStretchAllViewports(), Isis::FeatureNomenclatureTool::setVectorType(), Isis::StretchTool::stretchGlobalAllViewports(), Isis::BlinkTool::toggleLink(), Isis::WindowTool::unlinkWindows(), Isis::MeasureTool::updateMeasure(), Isis::AdvancedTrackTool::updateRow(), Isis::WindowTool::updateTool(), Isis::BlinkTool::updateTool(), Isis::FindTool::updateTool(), Isis::AbstractPlotTool::viewportsToPlot(), Isis::ZoomTool::zoomBy(), Isis::ZoomTool::zoomFit(), Isis::ZoomTool::zoomFitHeight(), Isis::ZoomTool::zoomFitWidth(), and Isis::ZoomTool::zoomManual().

◆ detachCurves()

void Isis::HistogramTool::detachCurves ( )

protectedvirtual

Forget the frequency histogram item and the percentage curve.

Implements Isis::AbstractPlotTool.

Definition at line 107 of file HistogramTool.cpp.

References m_frequencyItem, and m_percentageCurve.

◆ enableRubberBandTool()

void Isis::HistogramTool::enableRubberBandTool ( )

protectedvirtual

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.

Definition at line 44 of file HistogramTool.cpp.

References m_rubberBandCombo, and Isis::RubberBandTool::setDrawActiveViewportOnly().

◆ menuName()

virtual QString Isis::Tool::menuName ( ) const

inlinevirtualinherited

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

Returns: QString

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

Definition at line 97 of file Tool.h.

Referenced by Isis::Tool::addTo(), and Isis::Workspace::Workspace().

◆ mouseButtonPress()

void Isis::Tool::mouseButtonPress	(	QPoint	p,
		Qt::MouseButton	s
	)

protectedvirtualinherited

Parameters

p
s

Definition at line 367 of file Tool.cpp.

Referenced by Isis::Tool::addViewportConnections(), and Isis::Tool::removeViewportConnections().

◆ mouseButtonRelease()

void Isis::Tool::mouseButtonRelease	(	QPoint	p,
		Qt::MouseButton	s
	)

protectedvirtualinherited

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::FeatureNomenclatureTool.

Definition at line 380 of file Tool.cpp.

Referenced by Isis::Tool::addViewportConnections(), Isis::StretchTool::mouseButtonRelease(), and Isis::Tool::removeViewportConnections().

◆ mouseDoubleClick()

void Isis::Tool::mouseDoubleClick ( QPoint p )

protectedvirtualinherited

Parameters

p

Definition at line 358 of file Tool.cpp.

Referenced by Isis::Tool::addViewportConnections(), and Isis::Tool::removeViewportConnections().

◆ mouseMove

void Isis::Tool::mouseMove ( QPoint p )

protectedvirtualslotinherited

Parameters

p

Definition at line 352 of file Tool.cpp.

Referenced by Isis::Tool::addViewportConnections(), and Isis::Tool::removeViewportConnections().

◆ paintViewport()

void Isis::AbstractPlotTool::paintViewport	(	MdiCubeViewport *	vp,
		QPainter *	painter
	)

virtualinherited

This method allows each plot window to paint any information it wants onto the cube viewports.

For example, spatial plots can paint the originating selection in the color of the curve.

Parameters

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

Reimplemented from Isis::Tool.

Reimplemented in Isis::StereoTool.

Definition at line 73 of file AbstractPlotTool.cpp.

References Isis::AbstractPlotTool::m_selectWindowCombo, and Isis::PlotWindow::paint().

Referenced by Isis::StereoTool::paintViewport().

◆ plotWindows()

QList< PlotWindow * > Isis::AbstractPlotTool::plotWindows ( )

protectedinherited

Get a list of all of the instantiated plot windows.

Returns: All of the plot windows associated with this tool

Definition at line 147 of file AbstractPlotTool.cpp.

References Isis::AbstractPlotTool::m_selectWindowCombo.

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

◆ refreshPlot

void Isis::HistogramTool::refreshPlot ( )

slot

This method plots the selected data in a histogram window.

Definition at line 166 of file HistogramTool.cpp.

References Isis::Histogram::AddData(), Isis::Statistics::Average(), Isis::Histogram::BinCount(), Isis::Histogram::BinMiddle(), Isis::Histogram::Bins(), Isis::Histogram::BinSize(), Isis::CubeViewport::cube(), Isis::CubeViewport::cubeToViewport(), Isis::Tool::cubeViewport(), Isis::Buffer::DoubleBuffer(), Isis::RubberBandTool::geometry(), Isis::CubeViewport::grayBand(), m_frequencyItem, m_percentageCurve, Isis::Statistics::Maximum(), Isis::Histogram::Median(), Isis::Statistics::Minimum(), Isis::Histogram::Mode(), Isis::Cube::read(), Isis::PlotWindow::replot(), Isis::AbstractPlotTool::selectedWindow(), Isis::Brick::SetBasePosition(), Isis::Histogram::Skew(), Isis::Statistics::StandardDeviation(), validatePlotCurves(), Isis::Statistics::ValidPixels(), Isis::Statistics::Variance(), Isis::RubberBandTool::vertices(), and Isis::CubeViewport::viewportToCube().

Referenced by rubberBandComplete().

◆ registerTool()

void Isis::Tool::registerTool ( MdiCubeViewport * viewport )

protectedinherited

Registers the tool to the viewport.

Parameters

viewport

Definition at line 327 of file Tool.cpp.

References Isis::Tool::m_cvp, and Isis::MdiCubeViewport::registerTool().

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

◆ removeConnections()

virtual void Isis::Tool::removeConnections ( MdiCubeViewport * cvp )

inlineprotectedvirtualinherited

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.

Definition at line 261 of file Tool.h.

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

◆ removeWindow

void Isis::AbstractPlotTool::removeWindow ( QObject * window )

slotinherited

When a user closes a window, we want to remove that window from our combo box for selecting the active window.

We also repaint all of the cube viewports so that the destroyed window leaves no visible artifacts.

Parameters

window The plot window that is to be removed

Definition at line 195 of file AbstractPlotTool.cpp.

References Isis::AbstractPlotTool::m_selectWindowCombo, and Isis::AbstractPlotTool::repaintViewports().

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

◆ repaintViewports [1/2]

void Isis::AbstractPlotTool::repaintViewports ( CubePlotCurve * pc )

slotinherited

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.

Parameters

pc	The plot curve which needs to repaint

Definition at line 276 of file AbstractPlotTool.cpp.

References Isis::CubeViewport::cube(), Isis::Tool::cubeViewportList(), Isis::Cube::fileName(), and Isis::CubePlotCurve::sourceCube().

◆ repaintViewports [2/2]

void Isis::AbstractPlotTool::repaintViewports ( )

protectedslotinherited

This method causes all of the viewports to be repainted.

This is useful because it removes visible artifacts from deleted plot windows/curves.

Definition at line 354 of file AbstractPlotTool.cpp.

References Isis::Tool::cubeViewportList().

Referenced by Isis::AbstractPlotTool::addWindow(), and Isis::AbstractPlotTool::removeWindow().

◆ rubberBandComplete

void Isis::HistogramTool::rubberBandComplete ( )

protectedslot

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

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

Definition at line 140 of file HistogramTool.cpp.

References Isis::Tool::cubeViewport(), refreshPlot(), and Isis::AbstractPlotTool::selectedWindow().

◆ screenPixelsChanged

virtual void Isis::Tool::screenPixelsChanged ( )

inlineprotectedvirtualslotinherited

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

Definition at line 162 of file Tool.h.

Referenced by Isis::Tool::addViewportConnections(), Isis::Tool::removeViewportConnections(), and Isis::FeatureNomenclatureTool::viewportDone().

◆ selectedWindow()

PlotWindow * Isis::AbstractPlotTool::selectedWindow ( bool createIfNeeded = true )

protectedinherited

Get the 'active' plot window (the window selected by the user to contain new curves).

This may return NULL if and only if createIfNeeded is false. Windows are created by child classes.

Parameters

createIfNeeded If this is true, and no window is selected in the active window combo box, then a window will be created and selected before this method returns.

Returns: The user-selected active plot window

Definition at line 248 of file AbstractPlotTool.cpp.

References Isis::AbstractPlotTool::addWindow(), and Isis::AbstractPlotTool::m_selectWindowCombo.

Referenced by refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), rubberBandComplete(), Isis::SpectralPlotTool::rubberBandComplete(), Isis::SpatialPlotTool::rubberBandComplete(), Isis::AbstractPlotTool::selectedWindowChanged(), Isis::AbstractPlotTool::showPlotWindow(), validatePlotCurves(), Isis::SpatialPlotTool::validatePlotCurves(), and Isis::SpectralPlotTool::validatePlotCurves().

◆ setCubeViewport

void Isis::Tool::setCubeViewport ( MdiCubeViewport * cvp )

slotinherited

Sets the current viewport to the given cvp.

Parameters

cvp

Definition at line 160 of file Tool.cpp.

References Isis::Tool::addViewportConnections(), Isis::Tool::enableToolBar(), Isis::Tool::m_active, Isis::Tool::m_cvp, Isis::Tool::removeViewportConnections(), and Isis::Tool::updateTool().

Referenced by Isis::Tool::addTo(), and Isis::FileTool::closeAll().

◆ showPlotWindow

void Isis::AbstractPlotTool::showPlotWindow ( )

slotinherited

displays the plot window

Definition at line 342 of file AbstractPlotTool.cpp.

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

◆ toolIconDir()

QString Isis::Tool::toolIconDir ( ) const

inlineinherited

returns the path to the icon directory.

Returns: QString

Definition at line 127 of file Tool.h.

References Isis::Tool::m_toolIconDir.

◆ toolPadAction()

QAction * Isis::HistogramTool::toolPadAction ( ToolPad * toolpad )

protectedvirtual

This method adds the histogram tool to the tool pad.

Parameters

toolpad

Returns: QAction*

Reimplemented from Isis::Tool.

Definition at line 59 of file HistogramTool.cpp.

References Isis::Tool::toolIconDir().

◆ updateTool()

void Isis::HistogramTool::updateTool ( )

protectedvirtual

This method updates the histogram tool.

Reimplemented from Isis::AbstractPlotTool.

Definition at line 117 of file HistogramTool.cpp.

References Isis::AbstractPlotTool::updateTool().

◆ validatePlotCurves()

void Isis::HistogramTool::validatePlotCurves ( )

private

This method sets up the names, line style, and color of the all the plot items that will be used in this class.

This method also fills the p_colors QList with the colors that will be used when the user copies and pastes (special) into another plot window.

Definition at line 436 of file HistogramTool.cpp.

References Isis::HistogramPlotWindow::add(), Isis::AbstractPlotTool::createCurve(), Isis::PlotCurve::CubeDN, m_frequencyItem, m_percentageCurve, Isis::PlotCurve::Percentage, and Isis::AbstractPlotTool::selectedWindow().

Referenced by refreshPlot().

◆ viewportsToPlot()

QList< MdiCubeViewport * > Isis::AbstractPlotTool::viewportsToPlot ( )

protectedinherited

Get a list of linked viewports that should be plotting when a new plot is requested.

This is a utility for child classes. For example, a spatial plot will make a curve for each viewport.

Returns: A list of viewports containing the active one and any that are linked to the active viewport.

Definition at line 125 of file AbstractPlotTool.cpp.

References Isis::Tool::cubeViewport(), Isis::Tool::cubeViewportList(), and Isis::MdiCubeViewport::isLinked().

Referenced by Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::SpectralPlotTool::updateTool(), Isis::SpatialPlotTool::updateTool(), Isis::SpatialPlotTool::validatePlotCurves(), and Isis::SpectralPlotTool::validatePlotCurves().

Member Data Documentation

◆ m_action

QAction* Isis::HistogramTool::m_action

private

This is the action that activates this tool.

Definition at line 70 of file HistogramTool.h.

Referenced by HistogramTool().

◆ m_frequencyItem

QPointer<HistogramItem> Isis::HistogramTool::m_frequencyItem

private

This is the qwt plot item which draws the histogram frequency bars.

Definition at line 66 of file HistogramTool.h.

Referenced by detachCurves(), refreshPlot(), and validatePlotCurves().

◆ m_histToolWindow

HistogramToolWindow* Isis::HistogramTool::m_histToolWindow

private

Plot Tool Window Widget.

Definition at line 63 of file HistogramTool.h.

◆ m_percentageCurve

QPointer<CubePlotCurve> Isis::HistogramTool::m_percentageCurve

private

This plot curve indicates the data percentage over the histogram.

Definition at line 68 of file HistogramTool.h.

Referenced by detachCurves(), refreshPlot(), and validatePlotCurves().

◆ m_rubberBandCombo

QPointer<RubberBandComboBox> Isis::HistogramTool::m_rubberBandCombo

private

This combo box is for various rubber band selection types.

Definition at line 72 of file HistogramTool.h.

Referenced by createToolBarWidget(), and enableRubberBandTool().

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

src/qisis/objs/HistogramTool/HistogramTool.h
src/qisis/objs/HistogramTool/HistogramTool.cpp

Public Slots

Signals

Public Member Functions

Protected Types

Protected Slots

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CubeViewportList

Constructor & Destructor Documentation

◆ HistogramTool()

Member Function Documentation

◆ activate

◆ addConnections()

◆ addTo() [1/4]

◆ addTo() [2/4]

◆ addTo() [3/4]

◆ addTo() [4/4]

◆ addToActive()

◆ addToPermanent()

◆ addWindow()

◆ createCurve()

◆ createToolBarWidget()

◆ createWindow()

◆ cubeViewport()

◆ cubeViewportList()

◆ detachCurves()

◆ enableRubberBandTool()

◆ menuName()

◆ mouseButtonPress()

◆ mouseButtonRelease()

◆ mouseDoubleClick()

◆ mouseMove

◆ paintViewport()

◆ plotWindows()

◆ refreshPlot

◆ registerTool()

◆ removeConnections()

◆ removeWindow

◆ repaintViewports [1/2]

◆ repaintViewports [2/2]

◆ rubberBandComplete

◆ screenPixelsChanged

◆ selectedWindow()

◆ setCubeViewport

◆ showPlotWindow

◆ toolIconDir()

◆ toolPadAction()

◆ updateTool()

◆ validatePlotCurves()

◆ viewportsToPlot()

Member Data Documentation

◆ m_action

◆ m_frequencyItem

◆ m_histToolWindow

◆ m_percentageCurve

◆ m_rubberBandCombo