#include <AdvancedStretchDialog.h>

Inheritance diagram for Isis::AdvancedStretchDialog:

Collaboration diagram for Isis::AdvancedStretchDialog:

Public Slots
void	updateStretch (CubeViewport *)
	This calls setStretch on all applicable advanced stretches.

Signals
void	stretchChanged ()
	Emitted when an advanced stretch has changed.

void	visibilityChanged ()
	Emitted when this dialog is shown or hidden.

void	saveToCube ()

void	deleteFromCube ()

void	loadStretch ()

Public Member Functions
	AdvancedStretchDialog (QWidget *parent)
	This constructs an advanced stretch.

	~AdvancedStretchDialog ()
	This destroys the advanced stretch dialog.

void	enableRgbMode (Stretch &redStretch, Histogram &redHist, Stretch &grnStretch, Histogram &grnHist, Stretch &bluStretch, Histogram &bluHist)
	This displays RGB advanced stretches.

void	updateHistograms (const Histogram &redHist, const Histogram &grnHist, const Histogram &bluHist)
	This calls setHistogram on all of the advanced stretches.

void	updateForRGBMode (Stretch &redStretch, Histogram &redHist, Stretch &grnStretch, Histogram &grnHist, Stretch &bluStretch, Histogram &bluHist)
	Update the stretch and histogram for all the bands for All BandId option.

void	enableGrayMode (Stretch &grayStretch, Histogram &grayHist)
	This displays a gray advanced stretch.

void	updateHistogram (const Histogram &grayHist)
	This calls setHistogram on the gray advanced stretches.

bool	isRgbMode () const
	Returns true if the dialog is displaying the RGB advanced stretches.

void	restoreGrayStretch (CubeStretch stretch)
	Restores a saved grayscale stretch from the cube.

void	restoreRgbStretch (CubeStretch red, CubeStretch green, CubeStretch blue)
	Restores a saved RGB stretch from the cube.

CubeStretch	getGrayStretch ()
	This returns the advanced stretch's stretch for gray.

CubeStretch	getRedStretch ()
	This returns the advanced stretch's stretch for red.

CubeStretch	getGrnStretch ()
	This returns the advanced stretch's stretch for green.

CubeStretch	getBluStretch ()
	This returns the advanced stretch's stretch for blue.

bool	enabled ()
	Returns true if the advanced stretch is enabled.

void	enable (bool enable)
	Sets the enabled state to enable.

Protected Slots
void	showEvent (QShowEvent *)
	This is implemented to send a signal when visibility changes.

void	hideEvent (QHideEvent *)
	This is implemented to send a signal when visibility changes.

Private Member Functions
void	destroyCurrentStretches ()
	This cleans up memory from currently displayed advanced stretches.

Private Attributes
bool	p_enabled
	True if advanced stretch should be used.

AdvancedStretch *	p_grayStretch
	Gray stretch pane.

AdvancedStretch *	p_redStretch
	Red stretch pane.

AdvancedStretch *	p_grnStretch
	Green stretch pane.

AdvancedStretch *	p_bluStretch
	Blue stretch pane.

Detailed Description

Advanced Stretch Dialog.

Author: 2010-05-20 Steven Lambright

History: 2011-03-22 Sharmila Prasad - Added API updateForRGBMode to accomodate changes for all Bands for BandID All.

Definition at line 30 of file AdvancedStretchDialog.h.

Constructor & Destructor Documentation

◆ AdvancedStretchDialog()

Isis::AdvancedStretchDialog::AdvancedStretchDialog ( QWidget * parent )

This constructs an advanced stretch.

Parameters

parent the parent widget

Definition at line 18 of file AdvancedStretchDialog.cpp.

References p_bluStretch, p_enabled, p_grayStretch, p_grnStretch, and p_redStretch.

◆ ~AdvancedStretchDialog()

Isis::AdvancedStretchDialog::~AdvancedStretchDialog ( )

This destroys the advanced stretch dialog.

Definition at line 37 of file AdvancedStretchDialog.cpp.

References destroyCurrentStretches().

Member Function Documentation

◆ destroyCurrentStretches()

void Isis::AdvancedStretchDialog::destroyCurrentStretches ( )

private

This cleans up memory from currently displayed advanced stretches.

No stretches are visible after this is called.

Definition at line 219 of file AdvancedStretchDialog.cpp.

References p_bluStretch, p_grayStretch, p_grnStretch, p_redStretch, and stretchChanged().

Referenced by enableGrayMode(), enableRgbMode(), and ~AdvancedStretchDialog().

◆ enable()

void Isis::AdvancedStretchDialog::enable ( bool enable )

inline

Sets the enabled state to enable.

Parameters

enable

Definition at line 74 of file AdvancedStretchDialog.h.

References enable(), and p_enabled.

Referenced by enable().

◆ enabled()

bool Isis::AdvancedStretchDialog::enabled ( )

inline

Returns true if the advanced stretch is enabled.

Returns

Definition at line 65 of file AdvancedStretchDialog.h.

References p_enabled.

◆ enableGrayMode()

void Isis::AdvancedStretchDialog::enableGrayMode	(	Stretch &	grayStretch,
		Histogram &	grayHist )

This displays a gray advanced stretch.

Parameters

grayStretch
grayHist

Definition at line 151 of file AdvancedStretchDialog.cpp.

References destroyCurrentStretches(), p_grayStretch, and stretchChanged().

◆ enableRgbMode()

void Isis::AdvancedStretchDialog::enableRgbMode	(	Stretch &	redStretch,
		Histogram &	redHist,
		Stretch &	grnStretch,
		Histogram &	grnHist,
		Stretch &	bluStretch,
		Histogram &	bluHist )

This displays RGB advanced stretches.

Parameters

redStretch
redHist
grnStretch
grnHist
bluStretch
bluHist

Definition at line 52 of file AdvancedStretchDialog.cpp.

References destroyCurrentStretches(), p_bluStretch, p_grnStretch, p_redStretch, and stretchChanged().

◆ getBluStretch()

CubeStretch Isis::AdvancedStretchDialog::getBluStretch ( )

This returns the advanced stretch's stretch for blue.

Returns: Stretch

Definition at line 398 of file AdvancedStretchDialog.cpp.

References p_bluStretch, and Isis::IException::Programmer.

◆ getGrayStretch()

CubeStretch Isis::AdvancedStretchDialog::getGrayStretch ( )

This returns the advanced stretch's stretch for gray.

Returns: Stretch

Definition at line 350 of file AdvancedStretchDialog.cpp.

References p_grayStretch, and Isis::IException::Programmer.

◆ getGrnStretch()

CubeStretch Isis::AdvancedStretchDialog::getGrnStretch ( )

This returns the advanced stretch's stretch for green.

Returns: Stretch

Definition at line 382 of file AdvancedStretchDialog.cpp.

References p_grnStretch, and Isis::IException::Programmer.

◆ getRedStretch()

CubeStretch Isis::AdvancedStretchDialog::getRedStretch ( )

This returns the advanced stretch's stretch for red.

Returns: Stretch

Definition at line 366 of file AdvancedStretchDialog.cpp.

References p_redStretch, and Isis::IException::Programmer.

◆ hideEvent

void Isis::AdvancedStretchDialog::hideEvent ( QHideEvent * event )

protectedslot

This is implemented to send a signal when visibility changes.

Parameters

event

Definition at line 328 of file AdvancedStretchDialog.cpp.

References visibilityChanged().

◆ isRgbMode()

bool Isis::AdvancedStretchDialog::isRgbMode ( ) const

Returns true if the dialog is displaying the RGB advanced stretches.

Returns: bool

Definition at line 340 of file AdvancedStretchDialog.cpp.

References p_bluStretch, p_grnStretch, and p_redStretch.

Referenced by restoreRgbStretch().

◆ restoreGrayStretch()

void Isis::AdvancedStretchDialog::restoreGrayStretch ( CubeStretch stretch )

Restores a saved grayscale stretch from the cube.

Parameters

stretch

Definition at line 176 of file AdvancedStretchDialog.cpp.

References p_grayStretch, and Isis::IException::Programmer.

◆ restoreRgbStretch()

void Isis::AdvancedStretchDialog::restoreRgbStretch	(	CubeStretch	red,
		CubeStretch	green,
		CubeStretch	blue )

Restores a saved RGB stretch from the cube.

Parameters

red
green
blue

Definition at line 194 of file AdvancedStretchDialog.cpp.

References isRgbMode(), p_bluStretch, p_grnStretch, p_redStretch, and Isis::IException::Programmer.

◆ showEvent

void Isis::AdvancedStretchDialog::showEvent ( QShowEvent * event )

protectedslot

This is implemented to send a signal when visibility changes.

Parameters

event

Definition at line 317 of file AdvancedStretchDialog.cpp.

References visibilityChanged().

◆ stretchChanged

void Isis::AdvancedStretchDialog::stretchChanged ( )

signal

Emitted when an advanced stretch has changed.

Referenced by destroyCurrentStretches(), enableGrayMode(), and enableRgbMode().

◆ updateForRGBMode()

void Isis::AdvancedStretchDialog::updateForRGBMode	(	Stretch &	redStretch,
		Histogram &	redHist,
		Stretch &	grnStretch,
		Histogram &	grnHist,
		Stretch &	bluStretch,
		Histogram &	bluHist )

Update the stretch and histogram for all the bands for All BandId option.

Author: Sharmila Prasad (3/14/2011)

Parameters

redStretch	- Updated Red Stretch
redHist	- Updated Red Histogram
grnStretch	- Updated Green Stretch
grnHist	- Updated Green Histogram
bluStretch	- Updated Blue Stretch
bluHist	- Updated Blue Histogram

Definition at line 122 of file AdvancedStretchDialog.cpp.

References p_bluStretch, p_grnStretch, and p_redStretch.

◆ updateHistogram()

void Isis::AdvancedStretchDialog::updateHistogram ( const Histogram & grayHist )

This calls setHistogram on the gray advanced stretches.

This should be called every time the visible area changes.

Parameters

grayHist Histogram of visible area on gray band

Definition at line 306 of file AdvancedStretchDialog.cpp.

References p_grayStretch.

◆ updateHistograms()

void Isis::AdvancedStretchDialog::updateHistograms	(	const Histogram &	redHist,
		const Histogram &	grnHist,
		const Histogram &	bluHist )

This calls setHistogram on all of the advanced stretches.

This should be called every time the visible area changes.

Parameters

redHist	Histogram of visible area on red band
grnHist	Histogram of visible area on green band
bluHist	Histogram of visible area on blue band

Definition at line 284 of file AdvancedStretchDialog.cpp.

References p_bluStretch, p_grnStretch, and p_redStretch.

◆ updateStretch

void Isis::AdvancedStretchDialog::updateStretch ( CubeViewport * cvp )

slot

This calls setStretch on all applicable advanced stretches.

This should be called any time the cube viewport changes.

Parameters

cvp

Definition at line 260 of file AdvancedStretchDialog.cpp.

References Isis::CubeViewport::blueStretch(), Isis::CubeViewport::grayStretch(), Isis::CubeViewport::greenStretch(), p_bluStretch, p_grayStretch, p_grnStretch, p_redStretch, and Isis::CubeViewport::redStretch().

◆ visibilityChanged

void Isis::AdvancedStretchDialog::visibilityChanged ( )

signal

Emitted when this dialog is shown or hidden.

Referenced by hideEvent(), and showEvent().

Member Data Documentation

◆ p_bluStretch

AdvancedStretch* Isis::AdvancedStretchDialog::p_bluStretch

private

Blue stretch pane.

Definition at line 102 of file AdvancedStretchDialog.h.

Referenced by AdvancedStretchDialog(), destroyCurrentStretches(), enableRgbMode(), getBluStretch(), isRgbMode(), restoreRgbStretch(), updateForRGBMode(), updateHistograms(), and updateStretch().

◆ p_enabled

bool Isis::AdvancedStretchDialog::p_enabled

private

True if advanced stretch should be used.

Definition at line 98 of file AdvancedStretchDialog.h.

Referenced by AdvancedStretchDialog(), enable(), and enabled().

◆ p_grayStretch

AdvancedStretch* Isis::AdvancedStretchDialog::p_grayStretch

private

Gray stretch pane.

Definition at line 99 of file AdvancedStretchDialog.h.

Referenced by AdvancedStretchDialog(), destroyCurrentStretches(), enableGrayMode(), getGrayStretch(), restoreGrayStretch(), updateHistogram(), and updateStretch().

◆ p_grnStretch

AdvancedStretch* Isis::AdvancedStretchDialog::p_grnStretch

private

Green stretch pane.

Definition at line 101 of file AdvancedStretchDialog.h.

Referenced by AdvancedStretchDialog(), destroyCurrentStretches(), enableRgbMode(), getGrnStretch(), isRgbMode(), restoreRgbStretch(), updateForRGBMode(), updateHistograms(), and updateStretch().

◆ p_redStretch

AdvancedStretch* Isis::AdvancedStretchDialog::p_redStretch

private

Red stretch pane.

Definition at line 100 of file AdvancedStretchDialog.h.

Referenced by AdvancedStretchDialog(), destroyCurrentStretches(), enableRgbMode(), getRedStretch(), isRgbMode(), restoreRgbStretch(), updateForRGBMode(), updateHistograms(), and updateStretch().

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

src/qisis/objs/StretchTool/AdvancedStretchDialog.h
src/qisis/objs/StretchTool/AdvancedStretchDialog.cpp

Public Slots

Signals

Public Member Functions

Protected Slots

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AdvancedStretchDialog()

◆ ~AdvancedStretchDialog()

Member Function Documentation

◆ destroyCurrentStretches()

◆ enable()

◆ enabled()

◆ enableGrayMode()

◆ enableRgbMode()

◆ getBluStretch()

◆ getGrayStretch()

◆ getGrnStretch()

◆ getRedStretch()

◆ hideEvent

◆ isRgbMode()

◆ restoreGrayStretch()

◆ restoreRgbStretch()

◆ showEvent

◆ stretchChanged

◆ updateForRGBMode()

◆ updateHistogram()

◆ updateHistograms()

◆ updateStretch

◆ visibilityChanged

Member Data Documentation

◆ p_bluStretch

◆ p_enabled

◆ p_grayStretch

◆ p_grnStretch

◆ p_redStretch