Isis 3 Programmer Reference
Isis::MatrixOptions Class Reference

This class holds the matrix color and focus information. More...

#include <MatrixOptions.h>

Inheritance diagram for Isis::MatrixOptions:
Inheritance graph
Collaboration diagram for Isis::MatrixOptions:
Collaboration graph

Public Types

enum  FocusOption { Best , Worst , Specific , Tolerance }
 

Signals

void optionsUpdated ()
 

Public Member Functions

 MatrixOptions (CorrelationMatrix parent, MatrixSceneWidget *scene)
 Default Constructor.
 
 ~MatrixOptions ()
 Constructor that sets up all the variables.
 
QColor goodCorrelationColor ()
 The color selected for the correlation values that are below the given threshold.
 
QColor badCorrelationColor ()
 The color selected for the correlation values that are above the given threshold.
 
double colorTolerance ()
 Threshold for what is considered a bad correlation.
 
bool colorScheme ()
 Use the green-red gradient if false.
 
void setColorScheme (bool tolerance)
 
void setColorTolerance (double tolerance)
 
void setGoodCorrelationColor (QColor color)
 
void setBadCorrelationColor (QColor color)
 
FocusOption focusOption ()
 
double focusValue ()
 The value of the spot on the matrix that we need to focus on.
 
QString focusImage1 ()
 
QString focusParameter1 ()
 
QString focusImage2 ()
 
QString focusParameter2 ()
 
QList< double > goodElements ()
 
QList< double > badElements ()
 
void setFocusOption (FocusOption option)
 
void setFocusValue (double value)
 
void setGoodElements (QList< double > goodElements)
 
void setBadElements (QList< double > badElements)
 
double currentCorrelation ()
 
QString currentImage1 ()
 
QString currentParameter1 ()
 
QString currentImage2 ()
 
QString currentParameter2 ()
 
void setCurrentCorrelation (double value)
 
void setCurrentImage1 (QString current)
 
void setCurrentParameter1 (QString current)
 
void setCurrentImage2 (QString current)
 
void setCurrentParameter2 (QString current)
 
QMap< QString, QStringListmatrixImgsAndParams ()
 This slot will be called when a matrix element is clicked on.
 
CorrelationMatrixparentMatrix ()
 

Private Attributes

CorrelationMatrixm_parentMatrix
 
bool m_tolerance
 
QColor m_goodColor
 
QColor m_badColor
 
double m_colorTolerance
 
FocusOption m_focusOption
 
QString m_image1
 
QString m_parameter1
 
QString m_image2
 
QString m_parameter2
 
double m_focusTolSelectedElement
 
QList< double > m_goodElements
 
QList< double > m_badElements
 
double m_currentValue
 
QString m_currentImg1
 
QString m_currentParam1
 
QString m_currentImg2
 
QString m_currentParam2
 

Detailed Description

This class holds the matrix color and focus information.

This class is the go-between for the MatrixOptionsDialog and the MatrixSceneWidget.

Author
2014-07-14 Kimberly Oyama
History

2014-07-14 Kimberly Oyama - Original Version

2014-07-21 Kimberly Oyama - Connected apply button to scene. The color options are now functional.

Definition at line 28 of file MatrixOptions.h.

Member Enumeration Documentation

◆ FocusOption

enum Isis::MatrixOptions::FocusOption

Definition at line 32 of file MatrixOptions.h.

Constructor & Destructor Documentation

◆ MatrixOptions()

Isis::MatrixOptions::MatrixOptions ( CorrelationMatrix parent,
MatrixSceneWidget * scene )

Default Constructor.

Definition at line 15 of file MatrixOptions.cpp.

◆ ~MatrixOptions()

Isis::MatrixOptions::~MatrixOptions ( )

Constructor that sets up all the variables.

Default Destructor

Definition at line 71 of file MatrixOptions.cpp.

Member Function Documentation

◆ badCorrelationColor()

QColor Isis::MatrixOptions::badCorrelationColor ( )

The color selected for the correlation values that are above the given threshold.

Returns

Definition at line 93 of file MatrixOptions.cpp.

Referenced by Isis::MatrixSceneWidget::drawElements(), and Isis::MatrixOptionsDialog::readOptions().

◆ badElements()

QList< double > Isis::MatrixOptions::badElements ( )
Returns

Definition at line 232 of file MatrixOptions.cpp.

Referenced by setBadElements().

◆ colorScheme()

bool Isis::MatrixOptions::colorScheme ( )

Use the green-red gradient if false.

Use the 50/50 color split if true. You need the good/bad correlation color methods if true.

Returns

Definition at line 116 of file MatrixOptions.cpp.

Referenced by Isis::MatrixSceneWidget::drawElements(), and Isis::MatrixOptionsDialog::readOptions().

◆ colorTolerance()

double Isis::MatrixOptions::colorTolerance ( )

Threshold for what is considered a bad correlation.

Returns

Definition at line 104 of file MatrixOptions.cpp.

Referenced by Isis::MatrixSceneWidget::drawElements(), and Isis::MatrixOptionsDialog::readOptions().

◆ currentCorrelation()

double Isis::MatrixOptions::currentCorrelation ( )
Returns

Definition at line 281 of file MatrixOptions.cpp.

◆ currentImage1()

QString Isis::MatrixOptions::currentImage1 ( )
Returns

Definition at line 290 of file MatrixOptions.cpp.

◆ currentImage2()

QString Isis::MatrixOptions::currentImage2 ( )
Returns

Definition at line 308 of file MatrixOptions.cpp.

◆ currentParameter1()

QString Isis::MatrixOptions::currentParameter1 ( )
Returns

Definition at line 299 of file MatrixOptions.cpp.

◆ currentParameter2()

QString Isis::MatrixOptions::currentParameter2 ( )
Returns

Definition at line 317 of file MatrixOptions.cpp.

◆ focusImage1()

QString Isis::MatrixOptions::focusImage1 ( )
Returns

Definition at line 187 of file MatrixOptions.cpp.

◆ focusImage2()

QString Isis::MatrixOptions::focusImage2 ( )
Returns

Definition at line 205 of file MatrixOptions.cpp.

◆ focusOption()

MatrixOptions::FocusOption Isis::MatrixOptions::focusOption ( )
Returns

Definition at line 166 of file MatrixOptions.cpp.

Referenced by Isis::MatrixOptionsDialog::readOptions().

◆ focusParameter1()

QString Isis::MatrixOptions::focusParameter1 ( )
Returns

Definition at line 196 of file MatrixOptions.cpp.

◆ focusParameter2()

QString Isis::MatrixOptions::focusParameter2 ( )
Returns

Definition at line 214 of file MatrixOptions.cpp.

◆ focusValue()

double Isis::MatrixOptions::focusValue ( )

The value of the spot on the matrix that we need to focus on.

This can come from the best or worst option as well as the good/bad lists when a tolerance is entered.

Returns

Definition at line 178 of file MatrixOptions.cpp.

Referenced by Isis::MatrixOptionsDialog::readOptions().

◆ goodCorrelationColor()

QColor Isis::MatrixOptions::goodCorrelationColor ( )

The color selected for the correlation values that are below the given threshold.

Returns

Definition at line 82 of file MatrixOptions.cpp.

Referenced by Isis::MatrixSceneWidget::drawElements(), and Isis::MatrixOptionsDialog::readOptions().

◆ goodElements()

QList< double > Isis::MatrixOptions::goodElements ( )
Returns

Definition at line 223 of file MatrixOptions.cpp.

Referenced by setGoodElements().

◆ matrixImgsAndParams()

QMap< QString, QStringList > Isis::MatrixOptions::matrixImgsAndParams ( )

This slot will be called when a matrix element is clicked on.

Returns

Definition at line 383 of file MatrixOptions.cpp.

References Isis::CorrelationMatrix::imagesAndParameters().

Referenced by Isis::MatrixOptionsDialog::readOptions(), and Isis::MatrixOptionsDialog::updateSpecificParameterComboBox().

◆ parentMatrix()

CorrelationMatrix * Isis::MatrixOptions::parentMatrix ( )

Definition at line 393 of file MatrixOptions.cpp.

◆ setBadCorrelationColor()

void Isis::MatrixOptions::setBadCorrelationColor ( QColor color)
Parameters

Definition at line 156 of file MatrixOptions.cpp.

Referenced by Isis::MatrixOptionsDialog::applyOptions().

◆ setBadElements()

void Isis::MatrixOptions::setBadElements ( QList< double > badElements)
Parameters

Definition at line 268 of file MatrixOptions.cpp.

References badElements().

◆ setColorScheme()

void Isis::MatrixOptions::setColorScheme ( bool tolerance)
Parameters

Definition at line 126 of file MatrixOptions.cpp.

Referenced by Isis::MatrixOptionsDialog::applyOptions().

◆ setColorTolerance()

void Isis::MatrixOptions::setColorTolerance ( double tolerance)
Parameters

Definition at line 136 of file MatrixOptions.cpp.

Referenced by Isis::MatrixOptionsDialog::applyOptions().

◆ setCurrentCorrelation()

void Isis::MatrixOptions::setCurrentCorrelation ( double value)
Parameters

Definition at line 326 of file MatrixOptions.cpp.

◆ setCurrentImage1()

void Isis::MatrixOptions::setCurrentImage1 ( QString current)
Parameters

Definition at line 335 of file MatrixOptions.cpp.

◆ setCurrentImage2()

void Isis::MatrixOptions::setCurrentImage2 ( QString current)
Parameters

Definition at line 353 of file MatrixOptions.cpp.

◆ setCurrentParameter1()

void Isis::MatrixOptions::setCurrentParameter1 ( QString current)
Parameters

Definition at line 344 of file MatrixOptions.cpp.

◆ setCurrentParameter2()

void Isis::MatrixOptions::setCurrentParameter2 ( QString current)
Parameters

Definition at line 362 of file MatrixOptions.cpp.

◆ setFocusOption()

void Isis::MatrixOptions::setFocusOption ( FocusOption option)
Parameters

Definition at line 241 of file MatrixOptions.cpp.

◆ setFocusValue()

void Isis::MatrixOptions::setFocusValue ( double value)
Parameters

Definition at line 250 of file MatrixOptions.cpp.

◆ setGoodCorrelationColor()

void Isis::MatrixOptions::setGoodCorrelationColor ( QColor color)
Parameters

Definition at line 146 of file MatrixOptions.cpp.

Referenced by Isis::MatrixOptionsDialog::applyOptions().

◆ setGoodElements()

void Isis::MatrixOptions::setGoodElements ( QList< double > goodElements)
Parameters

Definition at line 259 of file MatrixOptions.cpp.

References goodElements().

Member Data Documentation

◆ m_badColor

QColor Isis::MatrixOptions::m_badColor
private

Definition at line 97 of file MatrixOptions.h.

◆ m_badElements

QList<double> Isis::MatrixOptions::m_badElements
private

Definition at line 113 of file MatrixOptions.h.

◆ m_colorTolerance

double Isis::MatrixOptions::m_colorTolerance
private

Definition at line 98 of file MatrixOptions.h.

◆ m_currentImg1

QString Isis::MatrixOptions::m_currentImg1
private

Definition at line 117 of file MatrixOptions.h.

◆ m_currentImg2

QString Isis::MatrixOptions::m_currentImg2
private

Definition at line 119 of file MatrixOptions.h.

◆ m_currentParam1

QString Isis::MatrixOptions::m_currentParam1
private

Definition at line 118 of file MatrixOptions.h.

◆ m_currentParam2

QString Isis::MatrixOptions::m_currentParam2
private

Definition at line 120 of file MatrixOptions.h.

◆ m_currentValue

double Isis::MatrixOptions::m_currentValue
private

Definition at line 116 of file MatrixOptions.h.

◆ m_focusOption

FocusOption Isis::MatrixOptions::m_focusOption
private

Definition at line 101 of file MatrixOptions.h.

◆ m_focusTolSelectedElement

double Isis::MatrixOptions::m_focusTolSelectedElement
private

Definition at line 111 of file MatrixOptions.h.

◆ m_goodColor

QColor Isis::MatrixOptions::m_goodColor
private

Definition at line 96 of file MatrixOptions.h.

◆ m_goodElements

QList<double> Isis::MatrixOptions::m_goodElements
private

Definition at line 112 of file MatrixOptions.h.

◆ m_image1

QString Isis::MatrixOptions::m_image1
private

Definition at line 104 of file MatrixOptions.h.

◆ m_image2

QString Isis::MatrixOptions::m_image2
private

Definition at line 106 of file MatrixOptions.h.

◆ m_parameter1

QString Isis::MatrixOptions::m_parameter1
private

Definition at line 105 of file MatrixOptions.h.

◆ m_parameter2

QString Isis::MatrixOptions::m_parameter2
private

Definition at line 107 of file MatrixOptions.h.

◆ m_parentMatrix

CorrelationMatrix* Isis::MatrixOptions::m_parentMatrix
private

Definition at line 93 of file MatrixOptions.h.

◆ m_tolerance

bool Isis::MatrixOptions::m_tolerance
private

Definition at line 95 of file MatrixOptions.h.


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