te::qt::widgets::RasterSlicingWizardPage Class Reference

#include <RasterSlicingWizardPage.h>

Inheritance diagram for te::qt::widgets::RasterSlicingWizardPage:

Public Member Functions

te::se::ColorMapgetColorMap ()
 This function returns the Color Map generated by the user. More...
 
std::string getCurrentBand ()
 This function returns the band from the raster taht will be used. More...
 
const te::gm::EnvelopegetExtent ()
 This function returns the envelope that can be used to trim the raster if the user requests it. More...
 
void getParameters (unsigned int &inputRasterBand, unsigned int &slicesNumber, bool &eqHistogram)
 This function returns the parameters as configured by the user. More...
 
int getSRID ()
 This function returns the srid of the display when the wizard was initiated. More...
 
bool isComplete () const
 This function evaluates the page to confirm if the user has completed the minimum configuration required to slice the raster. More...
 
 RasterSlicingWizardPage (QWidget *parent=0)
 Constructor. More...
 
void setExtent (const te::gm::Envelope &extent)
 This function sets the envelope that will be used to trim tha raster if the user requests it. More...
 
void setLayer (te::map::AbstractLayerPtr layer)
 This function sets the layer that contains the raster that will be sliced. More...
 
void setSRID (int srid=0)
 This function sets the srid of the display when the wizard was initiated. More...
 
bool trimRaster ()
 This function will check if the conditions required to trim the raster have been met. More...
 
 ~RasterSlicingWizardPage ()
 Destructor. More...
 

Protected Slots

void onSliceBandComboBoxIndexCHanged (int index)
 
void updateHistogram ()
 

Protected Attributes

te::qt::widgets::ChartDisplaym_chartDisplay
 The display used to draw the preview histogram. More...
 
te::qt::widgets::SlicingColorMapWidgetm_colorMapWidget
 The widget used to edit the legend of the output layer. More...
 
te::qt::widgets::HistogramChartm_histogramChart
 The preview histogram chart. More...
 
std::auto_ptr< te::rst::Rasterm_raster
 The raster that will be sliced. More...
 
te::map::AbstractLayerPtr m_rasterLayer
 Testing a better way to show the chart. More...
 
std::auto_ptr< Ui::RasterSlicingWizardPageForm > m_ui
 The wizard page form. More...
 

Private Member Functions

RasterSlicingWizardPageoperator= (const RasterSlicingWizardPage &rhs)
 
 RasterSlicingWizardPage (const RasterSlicingWizardPage &rhs)
 

Private Attributes

te::gm::Envelope m_extent
 The envelope that can be used to trim the output raster. More...
 
int m_srid
 The current srid from the display. More...
 

Detailed Description

Definition at line 58 of file RasterSlicingWizardPage.h.

Constructor & Destructor Documentation

te::qt::widgets::RasterSlicingWizardPage::RasterSlicingWizardPage ( QWidget *  parent = 0)

Constructor.

te::qt::widgets::RasterSlicingWizardPage::~RasterSlicingWizardPage ( )

Destructor.

te::qt::widgets::RasterSlicingWizardPage::RasterSlicingWizardPage ( const RasterSlicingWizardPage rhs)
private

Member Function Documentation

te::se::ColorMap* te::qt::widgets::RasterSlicingWizardPage::getColorMap ( )

This function returns the Color Map generated by the user.

Returns
A color map representing the legend created by the user.

/note The caller will take ownership of the returned pointer

std::string te::qt::widgets::RasterSlicingWizardPage::getCurrentBand ( )

This function returns the band from the raster taht will be used.

Returns
A string that represents the band that will be used to slice the raster.
const te::gm::Envelope& te::qt::widgets::RasterSlicingWizardPage::getExtent ( )

This function returns the envelope that can be used to trim the raster if the user requests it.

Returns
A reference to the Envelope that can be used to trim the raster if the user requests it.
void te::qt::widgets::RasterSlicingWizardPage::getParameters ( unsigned int &  inputRasterBand,
unsigned int &  slicesNumber,
bool &  eqHistogram 
)

This function returns the parameters as configured by the user.

Parameters
inputRasterBandThe band from the raster selected by the user.
slicesNumberThe number of slices that will be used to generate the histogram.
eqHistogramA boolean that holds weather the histogram will be equalized or not.
int te::qt::widgets::RasterSlicingWizardPage::getSRID ( )

This function returns the srid of the display when the wizard was initiated.

Returns
The srid of the display when the wizard was initiated.
bool te::qt::widgets::RasterSlicingWizardPage::isComplete ( ) const

This function evaluates the page to confirm if the user has completed the minimum configuration required to slice the raster.

In order for this function to return true:

The color map taht will be used on the output layer can not be empty.

Parameters
Aboolean that indicates if the page is complete.
void te::qt::widgets::RasterSlicingWizardPage::onSliceBandComboBoxIndexCHanged ( int  index)
protectedslot
RasterSlicingWizardPage& te::qt::widgets::RasterSlicingWizardPage::operator= ( const RasterSlicingWizardPage rhs)
private
void te::qt::widgets::RasterSlicingWizardPage::setExtent ( const te::gm::Envelope extent)

This function sets the envelope that will be used to trim tha raster if the user requests it.

Parameters
extentA reference to the envelope that can be used to trim tha raster.
void te::qt::widgets::RasterSlicingWizardPage::setLayer ( te::map::AbstractLayerPtr  layer)

This function sets the layer that contains the raster that will be sliced.

Parameters
layerThe layer from which the raster will be obtained.
void te::qt::widgets::RasterSlicingWizardPage::setSRID ( int  srid = 0)

This function sets the srid of the display when the wizard was initiated.

Parameters
sridThe current srid of the display.
bool te::qt::widgets::RasterSlicingWizardPage::trimRaster ( )

This function will check if the conditions required to trim the raster have been met.

In order for this function to return true:

The user must select the option to use the visible area; The extent must be valid; The extent must be within the raster;

Returns
A boolean that indicates if the raster can be trimmed.
void te::qt::widgets::RasterSlicingWizardPage::updateHistogram ( )
protectedslot

Member Data Documentation

te::qt::widgets::ChartDisplay* te::qt::widgets::RasterSlicingWizardPage::m_chartDisplay
protected

The display used to draw the preview histogram.

Definition at line 158 of file RasterSlicingWizardPage.h.

te::qt::widgets::SlicingColorMapWidget* te::qt::widgets::RasterSlicingWizardPage::m_colorMapWidget
protected

The widget used to edit the legend of the output layer.

Definition at line 159 of file RasterSlicingWizardPage.h.

te::gm::Envelope te::qt::widgets::RasterSlicingWizardPage::m_extent
private

The envelope that can be used to trim the output raster.

Definition at line 175 of file RasterSlicingWizardPage.h.

te::qt::widgets::HistogramChart* te::qt::widgets::RasterSlicingWizardPage::m_histogramChart
protected

The preview histogram chart.

Definition at line 160 of file RasterSlicingWizardPage.h.

std::auto_ptr<te::rst::Raster> te::qt::widgets::RasterSlicingWizardPage::m_raster
protected

The raster that will be sliced.

Definition at line 161 of file RasterSlicingWizardPage.h.

te::map::AbstractLayerPtr te::qt::widgets::RasterSlicingWizardPage::m_rasterLayer
protected

Testing a better way to show the chart.

Definition at line 162 of file RasterSlicingWizardPage.h.

int te::qt::widgets::RasterSlicingWizardPage::m_srid
private

The current srid from the display.

Definition at line 176 of file RasterSlicingWizardPage.h.

std::auto_ptr<Ui::RasterSlicingWizardPageForm> te::qt::widgets::RasterSlicingWizardPage::m_ui
protected

The wizard page form.

Definition at line 157 of file RasterSlicingWizardPage.h.


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