Isis 3 Programmer Reference
Isis::ManualStretchType Class Reference

This handles arbitrary user-input stretches. More...

#include <ManualStretchType.h>

Inheritance diagram for Isis::ManualStretchType:
Inheritance graph
Collaboration diagram for Isis::ManualStretchType:
Collaboration graph

Signals

void saveToCube ()
 Emitted when a new Stretch object is available.
 
void deleteFromCube ()
 
void stretchChanged ()
 
void loadStretch ()
 

Public Member Functions

 ManualStretchType (const Histogram &, const Stretch &, const QString &name, const QColor &color)
 This constructs a manual stretch type.
 
 ~ManualStretchType ()
 Destructor.
 
virtual CubeStretch getStretch ()
 Gets the current CubeStretch for this ManualStretch.
 
virtual void setStretch (Stretch)
 Given an arbitrary stretch, this will re-interpret it, as best as possible, into a manual stretch.
 
virtual void setHistogram (const Histogram &)
 This should be called when the visible area changes.
 

Protected Slots

void updateGraph ()
 This updates the graph with the current stretch object.
 
void updateTable ()
 This updates the table with the current stretch pairs.
 

Protected Member Functions

QTableWidget * createStretchTable ()
 This creates the stretch pairs table.
 

Protected Attributes

QGridLayout * p_mainLayout
 Main layout.
 
Histogramp_cubeHist
 Visible area histogram.
 
QTableWidget * p_table
 Pairs table.
 
HistogramWidgetp_graph
 Histogram graph.
 
Stretchp_stretch
 Current stretch pairs stored here.
 

Private Slots

void addButtonPressed (bool)
 This is called when a user clicks "Add / Edit" and is responsible for adding the pair into the correct location or editing the pair at that location (input value).
 
void deleteButtonPressed (bool)
 This is called when a user clicks "Delete" and is responsible for removing the pair with the given input value.
 
void readTable ()
 
void savePairs ()
 This asks the user for a file and saves the current stretch pairs to that file.
 

Private Member Functions

Stretch convertTableToStretch ()
 

Private Attributes

QLabel * p_errorMessage
 

Detailed Description

This handles arbitrary user-input stretches.

This is designed to take any stretch pairs the user wants that we can handle.

Author
2010-05-20 Steven Lambright
History
2011-11-04 Steven Lambright - This should be much, much easier to use now. Fixes #567.

Definition at line 32 of file ManualStretchType.h.

Constructor & Destructor Documentation

◆ ManualStretchType()

Isis::ManualStretchType::ManualStretchType ( const Histogram & hist,
const Stretch & stretch,
const QString & name,
const QColor & color )

This constructs a manual stretch type.

Parameters
hist
stretch
name
color

Definition at line 25 of file ManualStretchType.cpp.

References addButtonPressed(), deleteButtonPressed(), Isis::StretchType::p_mainLayout, Isis::StretchType::p_table, setStretch(), and Isis::StretchType::updateTable().

◆ ~ManualStretchType()

Isis::ManualStretchType::~ManualStretchType ( )

Destructor.

Definition at line 67 of file ManualStretchType.cpp.

Member Function Documentation

◆ addButtonPressed

void Isis::ManualStretchType::addButtonPressed ( bool )
privateslot

This is called when a user clicks "Add / Edit" and is responsible for adding the pair into the correct location or editing the pair at that location (input value).

Definition at line 99 of file ManualStretchType.cpp.

References Isis::StretchType::p_table.

Referenced by ManualStretchType().

◆ convertTableToStretch()

Stretch Isis::ManualStretchType::convertTableToStretch ( )
private

Definition at line 127 of file ManualStretchType.cpp.

◆ createStretchTable()

QTableWidget * Isis::StretchType::createStretchTable ( )
protectedinherited

This creates the stretch pairs table.

Returns
QTableWidget*

Definition at line 121 of file StretchType.cpp.

Referenced by Isis::StretchType::StretchType().

◆ deleteButtonPressed

void Isis::ManualStretchType::deleteButtonPressed ( bool )
privateslot

This is called when a user clicks "Delete" and is responsible for removing the pair with the given input value.

Definition at line 108 of file ManualStretchType.cpp.

References Isis::StretchType::p_table, and Isis::IException::User.

Referenced by ManualStretchType().

◆ getStretch()

CubeStretch Isis::ManualStretchType::getStretch ( )
virtual

Gets the current CubeStretch for this ManualStretch.

Returns
CubeStretch

Reimplemented from Isis::StretchType.

Definition at line 160 of file ManualStretchType.cpp.

References Isis::StretchType::p_stretch.

◆ readTable

void Isis::ManualStretchType::readTable ( )
privateslot

Definition at line 121 of file ManualStretchType.cpp.

◆ savePairs

void Isis::StretchType::savePairs ( )
privateslotinherited

This asks the user for a file and saves the current stretch pairs to that file.

Definition at line 170 of file StretchType.cpp.

References Isis::StretchType::getStretch(), and Isis::Stretch::Text().

Referenced by Isis::StretchType::StretchType().

◆ saveToCube

void Isis::StretchType::saveToCube ( )
signalinherited

Emitted when a new Stretch object is available.

Referenced by Isis::StretchType::StretchType().

◆ setHistogram()

void Isis::StretchType::setHistogram ( const Histogram & hist)
virtualinherited

This should be called when the visible area changes.

It updates the graph and calls setStretch() so that the children have a chance to update their GUI elements too.

Parameters
hist

Definition at line 109 of file StretchType.cpp.

References Isis::StretchType::p_cubeHist, Isis::StretchType::p_graph, Isis::StretchType::p_stretch, Isis::HistogramWidget::setHistogram(), and Isis::StretchType::setStretch().

◆ setStretch()

void Isis::ManualStretchType::setStretch ( Stretch newStretch)
virtual

Given an arbitrary stretch, this will re-interpret it, as best as possible, into a manual stretch.

It is required that a stretch that represents a manual stretch always translate into itself and does not cause a stretchChanged().

It is necessary to always update slider positions in this method even if the stretch did not change.

Good thing this is a manual stretch so no interpretation is really needed.

Parameters
newStretchStretch to interpret

Implements Isis::StretchType.

Definition at line 85 of file ManualStretchType.cpp.

References Isis::Stretch::CopyPairs(), Isis::StretchType::p_stretch, Isis::Stretch::Text(), and Isis::StretchType::updateTable().

Referenced by ManualStretchType().

◆ updateGraph

void Isis::StretchType::updateGraph ( )
protectedslotinherited

This updates the graph with the current stretch object.

Definition at line 140 of file StretchType.cpp.

References Isis::StretchType::p_graph, Isis::StretchType::p_stretch, and Isis::HistogramWidget::setStretch().

Referenced by Isis::StretchType::StretchType().

◆ updateTable

void Isis::StretchType::updateTable ( )
protectedslotinherited

Member Data Documentation

◆ p_cubeHist

◆ p_errorMessage

QLabel* Isis::ManualStretchType::p_errorMessage
private

Definition at line 51 of file ManualStretchType.h.

◆ p_graph

HistogramWidget* Isis::StretchType::p_graph
protectedinherited

◆ p_mainLayout

QGridLayout* Isis::StretchType::p_mainLayout
protectedinherited

◆ p_stretch

◆ p_table

QTableWidget* Isis::StretchType::p_table
protectedinherited

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