Isis Developer Reference
Isis::MatchTool Class Reference

Match tool operations. More...

#include <MatchTool.h>

Inheritance diagram for Isis::MatchTool:
Inheritance graph
Collaboration diagram for Isis::MatchTool:
Collaboration graph

Public Types

enum  MeasureColumns {
  FILENAME, CUBESN, SAMPLE, LINE,
  APRIORISAMPLE, APRIORILINE, SAMPLERESIDUAL, LINERESIDUAL,
  RESIDUALMAGNITUDE, SAMPLESHIFT, LINESHIFT, PIXELSHIFT,
  GOODNESSOFFIT, IGNORED, EDITLOCK, TYPE
}
 

Public Slots

void createPoint (MdiCubeViewport *mvp, double sample, double line)
 Create new control point at given samp, line for viewport. More...
 
void modifyPoint (ControlPoint *point)
 Modify control point. More...
 
void deletePoint (ControlPoint *point)
 Delete control point. More...
 
void updatePointInfo (QString pointId)
 Update the current editPoint information in the Point Editor labels. More...
 
void refresh ()
 Refresh all necessary widgets in MatchTool including the PointEditor and CubeViewports. More...
 
void activate (bool)
 Activates the tool. More...
 
virtual void updateTool ()
 Updates the tool. More...
 
void setCubeViewport (MdiCubeViewport *cvp)
 Sets the current viewport to the given cvp. More...
 

Signals

void editPointChanged ()
 
void ignorePointChanged ()
 
void ignoreLeftChanged ()
 
void ignoreRightChanged ()
 
void newControlNetwork (ControlNet *)
 
void stretchChipViewport (Stretch *, CubeViewport *)
 
void measureChanged ()
 
void clearWarningSignal ()
 
void toolActivated ()
 
void viewportChanged ()
 

Public Member Functions

 MatchTool (QWidget *parent)
 Consructs the Match Tool window. More...
 
virtual ~MatchTool ()
 
void paintViewport (MdiCubeViewport *mvp, QPainter *painter)
 Take care of drawing things on a viewPort. More...
 
QString measureColumnToString (MeasureColumns column)
 
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...
 
RubberBandToolrubberBandTool ()
 
void setList (ToolList *currentList)
 

Static Public Attributes

static const int NUMCOLUMNS = 16
 

Protected Types

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

Protected Slots

QWidgetcreateToolBarWidget (QStackedWidget *parent)
 
void mouseButtonRelease (QPoint p, Qt::MouseButton s)
 Handle mouse events on CubeViewport. More...
 
virtual void rubberBandComplete ()
 
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

QActiontoolPadAction (ToolPad *pad)
 Adds the Tie tool action to the tool pad. More...
 
bool eventFilter (QObject *o, QEvent *e)
 Event filter for MatchTool. More...
 
virtual void mouseDoubleClick (QPoint p)
 
virtual void mouseButtonPress (QPoint p, Qt::MouseButton s)
 
virtual void updateMeasure ()
 
virtual void scaleChanged ()
 
virtual void stretchRequested (MdiCubeViewport *, int)
 
void registerTool (MdiCubeViewport *viewport)
 Registers the tool to the viewport. More...
 
MdiCubeViewportcubeViewport () const
 Return the current cubeviewport. More...
 
CubeViewportListcubeViewportList () 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...
 
virtual void enableRubberBandTool ()
 Anytime a tool is created, you may use the rubber band tool. More...
 
Workspaceworkspace ()
 

Detailed Description

Match tool operations.

Author
????-??-?? Unknown

Member Typedef Documentation

◆ CubeViewportList

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

A list of cubeviewports.

Member Enumeration Documentation

◆ MeasureColumns

Enumerator
FILENAME 
CUBESN 
SAMPLE 
LINE 
APRIORISAMPLE 
APRIORILINE 
SAMPLERESIDUAL 
LINERESIDUAL 
RESIDUALMAGNITUDE 
SAMPLESHIFT 
LINESHIFT 
PIXELSHIFT 
GOODNESSOFFIT 
IGNORED 
EDITLOCK 
TYPE 

Constructor & Destructor Documentation

◆ MatchTool()

Isis::MatchTool::MatchTool ( QWidget parent)

Consructs the Match Tool window.

Parameters
parentPointer to the parent widget for the Match tool

References Isis::Tool::toolActivated().

◆ ~MatchTool()

Isis::MatchTool::~MatchTool ( )
virtual

Member Function Documentation

◆ activate

◆ 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::WindowTool, and Isis::TrackTool.

◆ addTo() [1/4]

◆ addTo() [2/4]

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

Adds the tool to the toolpad.

Parameters
toolpad

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

◆ addTo() [3/4]

◆ addTo() [4/4]

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

Adds the given workspace to the cubeviewport list.

Parameters
ws

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

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

◆ addToActive()

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

◆ addToPermanent()

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

◆ clearWarningSignal

void Isis::Tool::clearWarningSignal ( )
signalinherited

◆ createPoint

◆ createToolBarWidget

QWidget * Isis::MatchTool::createToolBarWidget ( QStackedWidget *  parent)
protectedslot

◆ cubeViewport()

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

Return the current cubeviewport.

Returns
CubeViewport*

Referenced by Isis::TrackTool::addConnections(), Isis::WindowTool::addConnections(), Isis::StretchTool::deleteFromCube(), Isis::FileTool::discard(), Isis::FileTool::exportToList(), Isis::FileTool::exportView(), Isis::StretchTool::loadStretchFromCube(), Isis::SunShadowTool::mouseButtonPress(), Isis::EditTool::mouseButtonRelease(), Isis::ControlNetTool::mouseButtonRelease(), Isis::FeatureNomenclatureTool::mouseButtonRelease(), Isis::FindTool::mouseButtonRelease(), mouseButtonRelease(), Isis::PanTool::mouseButtonRelease(), Isis::QnetTool::mouseButtonRelease(), Isis::RubberBandTool::mouseButtonRelease(), Isis::StretchTool::mouseButtonRelease(), Isis::AdvancedTrackTool::mouseLeave(), Isis::SunShadowTool::mouseMove(), Isis::TrackTool::mouseMove(), Isis::RubberBandTool::mouseMove(), Isis::ScatterPlotTool::mouseMove(), Isis::FindTool::paintViewport(), Isis::RubberBandTool::paintViewport(), Isis::SunShadowTool::paintViewport(), Isis::FileTool::print(), Isis::HistogramTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::TrackTool::removeConnections(), Isis::WindowTool::removeConnections(), Isis::EditTool::rubberBandComplete(), Isis::HistogramTool::rubberBandComplete(), Isis::MeasureTool::rubberBandComplete(), Isis::StereoTool::rubberBandComplete(), Isis::StretchTool::rubberBandComplete(), Isis::ZoomTool::rubberBandComplete(), Isis::FileTool::save(), Isis::FileTool::saveAs(), Isis::FileTool::saveAsCubeByOption(), Isis::FileTool::saveInfo(), Isis::StretchTool::saveStretchToCube(), Isis::ScatterPlotTool::showNewScatterPlotConfig(), Isis::StretchTool::stretchGlobal(), Isis::StretchTool::stretchGlobalAllBands(), Isis::StretchTool::stretchRegional(), Isis::StretchTool::updateAdvStretchDialogforAll(), Isis::StretchTool::updateHistograms(), Isis::MeasureTool::updateMeasure(), Isis::AbstractPlotTool::updateTool(), Isis::BandTool::updateTool(), Isis::BlinkTool::updateTool(), Isis::EditTool::updateTool(), Isis::FileTool::updateTool(), Isis::FindTool::updateTool(), Isis::SpecialPixelTool::updateTool(), Isis::StretchTool::updateTool(), Isis::SunShadowTool::updateTool(), Isis::WindowTool::updateTool(), Isis::ZoomTool::updateTool(), and Isis::AbstractPlotTool::viewportsToPlot().

◆ cubeViewportList()

◆ deletePoint

◆ editPointChanged

void Isis::MatchTool::editPointChanged ( )
signal

Referenced by deletePoint(), modifyPoint(), and refresh().

◆ enableRubberBandTool()

void Isis::Tool::enableRubberBandTool ( )
protectedvirtualinherited

Anytime a tool is created, you may use the rubber band tool.

Enable the use of the rubberband tool.

Reimplemented in Isis::ZoomTool, Isis::StereoTool, Isis::SpectralPlotTool, Isis::SpatialPlotTool, Isis::RubberBandTool, Isis::MeasureTool, and Isis::HistogramTool.

References Isis::RubberBandTool::disable(), and Isis::Tool::rubberBandTool().

◆ eventFilter()

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

Event filter for MatchTool.

Determines whether to update left or right measure info.

Parameters
oPointer to QObject
ePointer to QEvent
Returns
bool Indicates whether the event type is "Leave".

◆ ignoreLeftChanged

void Isis::MatchTool::ignoreLeftChanged ( )
signal

◆ ignorePointChanged

void Isis::MatchTool::ignorePointChanged ( )
signal

◆ ignoreRightChanged

void Isis::MatchTool::ignoreRightChanged ( )
signal

◆ measureChanged

void Isis::MatchTool::measureChanged ( )
signal

◆ measureColumnToString()

◆ menuName()

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

◆ modifyPoint

void Isis::MatchTool::modifyPoint ( ControlPoint point)
slot

Modify control point.

Parameters
pointPointer to control point to be modified.
History:
2009-09-15 Tracie Sucharski - Add error check for points with no measures.

References editPointChanged(), Isis::ControlPoint::GetNumMeasures(), Isis::ControlPoint::Parent(), and Isis::ControlPointEdit::templateFileName().

Referenced by mouseButtonRelease().

◆ mouseButtonPress()

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

References Isis::Tool::clearWarningSignal().

◆ mouseButtonRelease

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

Handle mouse events on CubeViewport.

Parameters
p[in](QPoint) Point under cursor in cubeviewport
s[in](Qt::MouseButton) Which mouse button was pressed

References createPoint(), Isis::CubeViewport::cube(), Isis::Tool::cubeViewport(), deletePoint(), Isis::Cube::fileName(), modifyPoint(), Isis::SerialNumberList::serialNumber(), Isis::IException::toString(), and Isis::CubeViewport::viewportToCube().

◆ mouseDoubleClick()

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

References Isis::Tool::clearWarningSignal().

◆ mouseEnter

virtual void Isis::Tool::mouseEnter ( )
inlineprotectedvirtualslotinherited

◆ mouseLeave

virtual void Isis::Tool::mouseLeave ( )
inlineprotectedvirtualslotinherited

◆ mouseMove [1/2]

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

◆ mouseMove [2/2]

virtual void Isis::Tool::mouseMove ( QPoint  p,
Qt::MouseButton   
)
inlineprotectedvirtualslotinherited

◆ newControlNetwork

void Isis::MatchTool::newControlNetwork ( ControlNet )
signal

◆ paintViewport()

void Isis::MatchTool::paintViewport ( MdiCubeViewport mvp,
QPainter *  painter 
)
virtual

Take care of drawing things on a viewPort.

This is overiding the parents paintViewport member.

Parameters
vpPointer to Viewport to be painted
painter

Reimplemented from Isis::Tool.

◆ refresh

void Isis::MatchTool::refresh ( )
slot

Refresh all necessary widgets in MatchTool including the PointEditor and CubeViewports.

Author
2008-12-09 Tracie Sucharski

References editPointChanged().

◆ registerTool()

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

Registers the tool to the viewport.

Parameters
viewport

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

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::WindowTool, Isis::TrackTool, and Isis::MeasureTool.

◆ rubberBandComplete

virtual void Isis::Tool::rubberBandComplete ( )
inlineprotectedvirtualslotinherited

◆ rubberBandTool()

◆ scaleChanged()

virtual void Isis::Tool::scaleChanged ( )
inlineprotectedvirtualinherited

Reimplemented in Isis::RubberBandTool.

◆ screenPixelsChanged

virtual void Isis::Tool::screenPixelsChanged ( )
inlineprotectedvirtualslotinherited

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

◆ setCubeViewport

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

Sets the current viewport to the given cvp.

Parameters
cvp

References Isis::Tool::updateTool(), and Isis::Tool::viewportChanged().

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

◆ setList()

void Isis::Tool::setList ( ToolList currentList)
inherited

Referenced by Isis::ToolList::append().

◆ stretchChipViewport

void Isis::MatchTool::stretchChipViewport ( Stretch ,
CubeViewport  
)
signal

◆ stretchRequested()

virtual void Isis::Tool::stretchRequested ( MdiCubeViewport ,
int   
)
inlineprotectedvirtualinherited

Reimplemented in Isis::StretchTool.

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

◆ toolActivated

◆ toolIconDir()

◆ toolPadAction()

QAction * Isis::MatchTool::toolPadAction ( ToolPad pad)
protectedvirtual

Adds the Tie tool action to the tool pad.

When the Tie tool is selected, the Navigation Tool will automatically open.

Parameters
padTool pad
Returns
QAction* Pointer to Tie tool action

Reimplemented from Isis::Tool.

References Isis::Tool::toolIconDir().

◆ updateMeasure()

virtual void Isis::Tool::updateMeasure ( )
inlineprotectedvirtualinherited

◆ updatePointInfo

void Isis::MatchTool::updatePointInfo ( QString  pointId)
slot

Update the current editPoint information in the Point Editor labels.

Author
2011-05-05 Tracie Sucharski

@TODO Instead of a single method, should slots be separate for each updated point parameter, ie. ignore, editLock, apriori, etc. This is not robust, if other point attributes are changed outside of MatchTool, this method will need to be updated. *** THIS METHOD SHOULD GO AWAY WHEN CONTROLpOINTEDITOR IS INCLUDED IN MATCH ***

References Isis::ControlPoint::GetId(), Isis::ControlPoint::IsEditLocked(), Isis::ControlPoint::IsIgnored(), Isis::ControlPoint::SetEditLock(), and Isis::ControlPoint::SetIgnored().

◆ updateTool

◆ viewportChanged

◆ workspace()

Member Data Documentation

◆ NUMCOLUMNS

const int Isis::MatchTool::NUMCOLUMNS = 16
static

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