RasterLayer Class Reference

Adjusts the properties of a raster layer. More...

#include <RasterLayer.h>

Inheritance diagram for RasterLayer:

Inheritance graph

List of all members.

Public Member Functions

virtual std::list
< ContextMenuAction > 		getContextMenuActions () const =0
virtual bool isGpuImageSupported () const =0
virtual void enableGpuImage (bool bEnable)=0
virtual bool isGpuImageEnabled () const =0
virtual void setDisplayMode (const DisplayMode &eMode)=0
virtual DisplayMode getDisplayMode () const =0
virtual void toggleDisplayMode ()=0
virtual void setDisplayedBand (RasterChannelType eColor, DimensionDescriptor band, RasterElement *pRasterElement=NULL)=0
virtual DimensionDescriptor getDisplayedBand (RasterChannelType eColor) const =0
virtual RasterElement * getDisplayedRasterElement (RasterChannelType eColor) const =0
virtual bool isBandDisplayed (RasterChannelType eColor, DimensionDescriptor band, const RasterElement *pRasterElement=NULL) const =0
virtual Statistics * getStatistics (RasterChannelType eChannel) const =0
virtual void setColorMap (const ColorMap &colorMap)=0
virtual const ColorMap & getColorMap () const =0
virtual void setComplexComponent (const ComplexComponent &eComponent)=0
virtual ComplexComponent getComplexComponent () const =0
virtual void setStretchType (const DisplayMode &eMode, const StretchType &eType)=0
virtual StretchType getStretchType (const DisplayMode &eMode) const =0
virtual void setStretchUnits (const DisplayMode &eMode, const RegionUnits &eUnits)=0
virtual void setStretchUnits (const RasterChannelType &eColor, const RegionUnits &eUnits)=0
virtual RegionUnits getStretchUnits (const RasterChannelType &eColor) const =0
virtual void setStretchValues (const RasterChannelType &eColor, double dLower, double dUpper)=0
virtual void getStretchValues (const RasterChannelType &eColor, double &dLower, double &dUpper) const =0
virtual void resetStretch (const RasterChannelType &eColor=RasterChannelType())=0
virtual double convertStretchValue (const RasterChannelType &eColor, const RegionUnits &eUnits, double dStretchValue, const RegionUnits &eNewUnits) const =0
virtual double convertStretchValue (const RasterChannelType &eColor, double dStretchValue, const RegionUnits &eNewUnits) const =0
virtual void setAlpha (unsigned int alpha)=0
virtual unsigned int getAlpha () const =0
virtual bool canApplyFastContrastStretch () const =0
virtual bool enableFastContrastStretch (bool enable)=0
virtual bool isFilterSupported (const std::string &filterName) const =0
virtual std::vector< std::string > getSupportedFilters () const =0
virtual void enableFilter (const std::string &filterName)=0
virtual void enableFilters (const std::vector< std::string > &filterNames)=0
virtual void disableFilter (const std::string &filterName)=0
virtual bool isFilterEnabled (const std::string &filterName) const =0
virtual ImageFilterDescriptor * getEnabledFilter (const std::string &filterName) const =0
virtual const std::vector
< ImageFilterDescriptor * > & 		getEnabledFilters () const =0
virtual std::vector< std::string > getEnabledFilterNames () const =0
virtual void resetFilter (const std::string &filterName)=0
virtual void freezeFilter (const std::string &filterName, bool toggle=true)=0
virtual unsigned int readFilterBuffer (double xCoord, double yCoord, int width, int height, std::vector< float > &values, bool &hasAlphas)=0
virtual void setAnimation (Animation *pAnimation)=0
virtual Animation * getAnimation () const =0

Static Public Member Functions

static bool getSettingBackgroundTileGeneration ()
static bool hasSettingBackgroundTileGeneration ()
static void setSettingBackgroundTileGeneration (bool newValue, bool setIfSame=false)
static std::string getSettingBackgroundTileGenerationKey ()
static ComplexComponent getSettingComplexComponent ()
static bool hasSettingComplexComponent ()
static void setSettingComplexComponent (ComplexComponent newValue, bool setIfSame=false)
static std::string getSettingComplexComponentKey ()
static RegionUnits getSettingGrayscaleStretchUnits ()
static bool hasSettingGrayscaleStretchUnits ()
static void setSettingGrayscaleStretchUnits (RegionUnits newValue, bool setIfSame=false)
static std::string getSettingGrayscaleStretchUnitsKey ()
static StretchType getSettingGrayscaleStretchType ()
static bool hasSettingGrayscaleStretchType ()
static void setSettingGrayscaleStretchType (StretchType newValue, bool setIfSame=false)
static std::string getSettingGrayscaleStretchTypeKey ()
static double getSettingBlueLowerStretchValue ()
static bool hasSettingBlueLowerStretchValue ()
static void setSettingBlueLowerStretchValue (double newValue, bool setIfSame=false)
static std::string getSettingBlueLowerStretchValueKey ()
static double getSettingBlueUpperStretchValue ()
static bool hasSettingBlueUpperStretchValue ()
static void setSettingBlueUpperStretchValue (double newValue, bool setIfSame=false)
static std::string getSettingBlueUpperStretchValueKey ()
static bool getSettingGpuImage ()
static bool hasSettingGpuImage ()
static void setSettingGpuImage (bool newValue, bool setIfSame=false)
static std::string getSettingGpuImageKey ()
static bool getSettingGpuImageAlwaysAlpha ()
static bool hasSettingGpuImageAlwaysAlpha ()
static void setSettingGpuImageAlwaysAlpha (bool newValue, bool setIfSame=false)
static std::string getSettingGpuImageAlwaysAlphaKey ()
static double getSettingGrayLowerStretchValue ()
static bool hasSettingGrayLowerStretchValue ()
static void setSettingGrayLowerStretchValue (double newValue, bool setIfSame=false)
static std::string getSettingGrayLowerStretchValueKey ()
static double getSettingGrayUpperStretchValue ()
static bool hasSettingGrayUpperStretchValue ()
static void setSettingGrayUpperStretchValue (double newValue, bool setIfSame=false)
static std::string getSettingGrayUpperStretchValueKey ()
static double getSettingGreenLowerStretchValue ()
static bool hasSettingGreenLowerStretchValue ()
static void setSettingGreenLowerStretchValue (double newValue, bool setIfSame=false)
static std::string getSettingGreenLowerStretchValueKey ()
static double getSettingGreenUpperStretchValue ()
static bool hasSettingGreenUpperStretchValue ()
static void setSettingGreenUpperStretchValue (double newValue, bool setIfSame=false)
static std::string getSettingGreenUpperStretchValueKey ()
static double getSettingRedLowerStretchValue ()
static bool hasSettingRedLowerStretchValue ()
static void setSettingRedLowerStretchValue (double newValue, bool setIfSame=false)
static std::string getSettingRedLowerStretchValueKey ()
static double getSettingRedUpperStretchValue ()
static bool hasSettingRedUpperStretchValue ()
static void setSettingRedUpperStretchValue (double newValue, bool setIfSame=false)
static std::string getSettingRedUpperStretchValueKey ()
static RegionUnits getSettingRedStretchUnits ()
static bool hasSettingRedStretchUnits ()
static void setSettingRedStretchUnits (RegionUnits newValue, bool setIfSame=false)
static std::string getSettingRedStretchUnitsKey ()
static RegionUnits getSettingGreenStretchUnits ()
static bool hasSettingGreenStretchUnits ()
static void setSettingGreenStretchUnits (RegionUnits newValue, bool setIfSame=false)
static std::string getSettingGreenStretchUnitsKey ()
static RegionUnits getSettingBlueStretchUnits ()
static bool hasSettingBlueStretchUnits ()
static void setSettingBlueStretchUnits (RegionUnits newValue, bool setIfSame=false)
static std::string getSettingBlueStretchUnitsKey ()
static StretchType getSettingRgbStretchType ()
static bool hasSettingRgbStretchType ()
static void setSettingRgbStretchType (StretchType newValue, bool setIfSame=false)
static std::string getSettingRgbStretchTypeKey ()
static bool getSettingFastContrastStretch ()
static bool hasSettingFastContrastStretch ()
static void setSettingFastContrastStretch (bool newValue, bool setIfSame=false)
static std::string getSettingFastContrastStretchKey ()
static const DynamicObject * getSettingColorComposites ()
static bool hasSettingColorComposites ()
static void setSettingColorComposites (DynamicObject *pNewValue, bool setIfSame=false)
static std::string getSettingColorCompositesKey ()
static const DynamicObject * getSettingStretchFavorites ()
static bool hasSettingStretchFavorites ()
static void setSettingStretchFavorites (DynamicObject *pNewValue, bool setIfSame=false)
static std::string getSettingStretchFavoritesKey ()
static const std::string & signalComplexComponentChanged ()
static const std::string & signalDisplayedBandChanged ()
static const std::string & signalFiltersChanged ()
static const std::string & signalGpuImageEnabled ()
static const std::string & signalStretchTypeChanged ()
static const std::string & signalStretchUnitsChanged ()
static const std::string & signalStretchValuesChanged ()
static const std::string & signalAlphaChanged ()
static const std::string & signalDisplayModeChanged ()
static const std::string & signalColorMapChanged ()
static const std::string & signalAnimationChanged ()

Protected Member Functions

virtual ~RasterLayer ()

Detailed Description

Adjusts the properties of a raster layer.

A raster layer displays all pixel values in shades of a certain color. There are two display modes, grayscale and RGB. For grayscale mode, values are displayed in shades of gray. In RGB mode, values can be displayed in either the red, green, or blue display colors. To enhance the layer display and contrast, values can be stretched for each display color to fit the display range. Values between an upper and lower threshold value are stretch according to a stretch type and stretch units. This class provides the means to set all of these properties for the current raster layer and also as the default properties for new raster layers.

This subclass of Subject will notify upon the following conditions:

See also:
Layer

Definition at line 50 of file RasterLayer.h.

Constructor & Destructor Documentation

virtual RasterLayer::~RasterLayer (  )  [protected, virtual]

This should be destroyed by calling SpatialDataView::deleteLayer.

Definition at line 1635 of file RasterLayer.h.

Member Function Documentation

static bool RasterLayer::getSettingBackgroundTileGeneration (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 63 of file RasterLayer.h.

static bool RasterLayer::hasSettingBackgroundTileGeneration (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 70 of file RasterLayer.h.

static void RasterLayer::setSettingBackgroundTileGeneration ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 86 of file RasterLayer.h.

static std::string RasterLayer::getSettingBackgroundTileGenerationKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 94 of file RasterLayer.h.

static ComplexComponent RasterLayer::getSettingComplexComponent (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 105 of file RasterLayer.h.

static bool RasterLayer::hasSettingComplexComponent (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 112 of file RasterLayer.h.

static void RasterLayer::setSettingComplexComponent ( ComplexComponent  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 128 of file RasterLayer.h.

static std::string RasterLayer::getSettingComplexComponentKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 136 of file RasterLayer.h.

static RegionUnits RasterLayer::getSettingGrayscaleStretchUnits (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 147 of file RasterLayer.h.

static bool RasterLayer::hasSettingGrayscaleStretchUnits (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 154 of file RasterLayer.h.

static void RasterLayer::setSettingGrayscaleStretchUnits ( RegionUnits  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 170 of file RasterLayer.h.

static std::string RasterLayer::getSettingGrayscaleStretchUnitsKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 178 of file RasterLayer.h.

static StretchType RasterLayer::getSettingGrayscaleStretchType (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 189 of file RasterLayer.h.

static bool RasterLayer::hasSettingGrayscaleStretchType (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 196 of file RasterLayer.h.

static void RasterLayer::setSettingGrayscaleStretchType ( StretchType  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 212 of file RasterLayer.h.

static std::string RasterLayer::getSettingGrayscaleStretchTypeKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 220 of file RasterLayer.h.

static double RasterLayer::getSettingBlueLowerStretchValue (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 231 of file RasterLayer.h.

static bool RasterLayer::hasSettingBlueLowerStretchValue (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 238 of file RasterLayer.h.

static void RasterLayer::setSettingBlueLowerStretchValue ( double  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 254 of file RasterLayer.h.

static std::string RasterLayer::getSettingBlueLowerStretchValueKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 262 of file RasterLayer.h.

static double RasterLayer::getSettingBlueUpperStretchValue (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 273 of file RasterLayer.h.

static bool RasterLayer::hasSettingBlueUpperStretchValue (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 280 of file RasterLayer.h.

static void RasterLayer::setSettingBlueUpperStretchValue ( double  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 296 of file RasterLayer.h.

static std::string RasterLayer::getSettingBlueUpperStretchValueKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 304 of file RasterLayer.h.

static bool RasterLayer::getSettingGpuImage (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 315 of file RasterLayer.h.

static bool RasterLayer::hasSettingGpuImage (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 322 of file RasterLayer.h.

static void RasterLayer::setSettingGpuImage ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 338 of file RasterLayer.h.

static std::string RasterLayer::getSettingGpuImageKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 346 of file RasterLayer.h.

static bool RasterLayer::getSettingGpuImageAlwaysAlpha (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 357 of file RasterLayer.h.

static bool RasterLayer::hasSettingGpuImageAlwaysAlpha (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 364 of file RasterLayer.h.

static void RasterLayer::setSettingGpuImageAlwaysAlpha ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 380 of file RasterLayer.h.

static std::string RasterLayer::getSettingGpuImageAlwaysAlphaKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 388 of file RasterLayer.h.

static double RasterLayer::getSettingGrayLowerStretchValue (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 399 of file RasterLayer.h.

static bool RasterLayer::hasSettingGrayLowerStretchValue (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 406 of file RasterLayer.h.

static void RasterLayer::setSettingGrayLowerStretchValue ( double  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 422 of file RasterLayer.h.

static std::string RasterLayer::getSettingGrayLowerStretchValueKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 430 of file RasterLayer.h.

static double RasterLayer::getSettingGrayUpperStretchValue (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 441 of file RasterLayer.h.

static bool RasterLayer::hasSettingGrayUpperStretchValue (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 448 of file RasterLayer.h.

static void RasterLayer::setSettingGrayUpperStretchValue ( double  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 464 of file RasterLayer.h.

static std::string RasterLayer::getSettingGrayUpperStretchValueKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 472 of file RasterLayer.h.

static double RasterLayer::getSettingGreenLowerStretchValue (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 483 of file RasterLayer.h.

static bool RasterLayer::hasSettingGreenLowerStretchValue (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 490 of file RasterLayer.h.

static void RasterLayer::setSettingGreenLowerStretchValue ( double  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 506 of file RasterLayer.h.

static std::string RasterLayer::getSettingGreenLowerStretchValueKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 514 of file RasterLayer.h.

static double RasterLayer::getSettingGreenUpperStretchValue (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 525 of file RasterLayer.h.

static bool RasterLayer::hasSettingGreenUpperStretchValue (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 532 of file RasterLayer.h.

static void RasterLayer::setSettingGreenUpperStretchValue ( double  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 548 of file RasterLayer.h.

static std::string RasterLayer::getSettingGreenUpperStretchValueKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 556 of file RasterLayer.h.

static double RasterLayer::getSettingRedLowerStretchValue (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 567 of file RasterLayer.h.

static bool RasterLayer::hasSettingRedLowerStretchValue (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 574 of file RasterLayer.h.

static void RasterLayer::setSettingRedLowerStretchValue ( double  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 590 of file RasterLayer.h.

static std::string RasterLayer::getSettingRedLowerStretchValueKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 598 of file RasterLayer.h.

static double RasterLayer::getSettingRedUpperStretchValue (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 609 of file RasterLayer.h.

static bool RasterLayer::hasSettingRedUpperStretchValue (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 616 of file RasterLayer.h.

static void RasterLayer::setSettingRedUpperStretchValue ( double  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 632 of file RasterLayer.h.

static std::string RasterLayer::getSettingRedUpperStretchValueKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 640 of file RasterLayer.h.

static RegionUnits RasterLayer::getSettingRedStretchUnits (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 651 of file RasterLayer.h.

static bool RasterLayer::hasSettingRedStretchUnits (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 658 of file RasterLayer.h.

static void RasterLayer::setSettingRedStretchUnits ( RegionUnits  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 674 of file RasterLayer.h.

static std::string RasterLayer::getSettingRedStretchUnitsKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 682 of file RasterLayer.h.

static RegionUnits RasterLayer::getSettingGreenStretchUnits (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 693 of file RasterLayer.h.

static bool RasterLayer::hasSettingGreenStretchUnits (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 700 of file RasterLayer.h.

static void RasterLayer::setSettingGreenStretchUnits ( RegionUnits  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 716 of file RasterLayer.h.

static std::string RasterLayer::getSettingGreenStretchUnitsKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 724 of file RasterLayer.h.

static RegionUnits RasterLayer::getSettingBlueStretchUnits (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 735 of file RasterLayer.h.

static bool RasterLayer::hasSettingBlueStretchUnits (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 742 of file RasterLayer.h.

static void RasterLayer::setSettingBlueStretchUnits ( RegionUnits  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 758 of file RasterLayer.h.

static std::string RasterLayer::getSettingBlueStretchUnitsKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 766 of file RasterLayer.h.

static StretchType RasterLayer::getSettingRgbStretchType (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 777 of file RasterLayer.h.

static bool RasterLayer::hasSettingRgbStretchType (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 784 of file RasterLayer.h.

static void RasterLayer::setSettingRgbStretchType ( StretchType  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 800 of file RasterLayer.h.

static std::string RasterLayer::getSettingRgbStretchTypeKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 808 of file RasterLayer.h.

static bool RasterLayer::getSettingFastContrastStretch (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 819 of file RasterLayer.h.

static bool RasterLayer::hasSettingFastContrastStretch (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 826 of file RasterLayer.h.

static void RasterLayer::setSettingFastContrastStretch ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 842 of file RasterLayer.h.

static std::string RasterLayer::getSettingFastContrastStretchKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 850 of file RasterLayer.h.

static const DynamicObject* RasterLayer::getSettingColorComposites (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Returns:
the current value for this setting or NULL if not found.

Definition at line 859 of file RasterLayer.h.

static bool RasterLayer::hasSettingColorComposites (  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 866 of file RasterLayer.h.

static void RasterLayer::setSettingColorComposites ( DynamicObject *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 882 of file RasterLayer.h.

static std::string RasterLayer::getSettingColorCompositesKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 890 of file RasterLayer.h.

static const DynamicObject* RasterLayer::getSettingStretchFavorites (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Returns:
the current value for this setting or NULL if not found.

Definition at line 899 of file RasterLayer.h.

static bool RasterLayer::hasSettingStretchFavorites (  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 906 of file RasterLayer.h.

static void RasterLayer::setSettingStretchFavorites ( DynamicObject *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 922 of file RasterLayer.h.

static std::string RasterLayer::getSettingStretchFavoritesKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 930 of file RasterLayer.h.

static const std::string& RasterLayer::signalComplexComponentChanged (  )  [static]

Emitted with boost::any<ComplexComponent> when the component is changed.

Definition at line 935 of file RasterLayer.h.

static const std::string& RasterLayer::signalDisplayedBandChanged (  )  [static]

Emitted with boost::any<std::pair<RasterChannelType, DimensionDescriptor> > when the displayed bands are changed.

Definition at line 941 of file RasterLayer.h.

static const std::string& RasterLayer::signalFiltersChanged (  )  [static]

Emitted with boost::any<std::vector<ImageFilterDescriptor*> > when the filters are changed.

It contains the enabled filters at the time it is emitted.

Definition at line 948 of file RasterLayer.h.

static const std::string& RasterLayer::signalGpuImageEnabled (  )  [static]

Emitted with boost::any<bool> when the GPU is enabled or disabled.

Definition at line 953 of file RasterLayer.h.

static const std::string& RasterLayer::signalStretchTypeChanged (  )  [static]

Emitted with boost::any<std::pair<DisplayMode, StretchType> > when the stretch type is changed.

Definition at line 958 of file RasterLayer.h.

static const std::string& RasterLayer::signalStretchUnitsChanged (  )  [static]

Emitted with boost::any<std::pair<RasterChannelType, RegionUnits> > when the stretch units are changed.

Definition at line 963 of file RasterLayer.h.

static const std::string& RasterLayer::signalStretchValuesChanged (  )  [static]

Emitted with boost::any<boost::tuple<RasterChannelType, double, double> > when the stretch values are changed.

Definition at line 968 of file RasterLayer.h.

static const std::string& RasterLayer::signalAlphaChanged (  )  [static]

Emitted with boost::any<unsigned int> when the opacity is changed.

Definition at line 973 of file RasterLayer.h.

static const std::string& RasterLayer::signalDisplayModeChanged (  )  [static]

Emitted with boost::any<DisplayMode> when the display mode is changed.

Definition at line 978 of file RasterLayer.h.

static const std::string& RasterLayer::signalColorMapChanged (  )  [static]

Emitted when the color map changes with boost::any<std::string> containing the name of the new color map.

Definition at line 984 of file RasterLayer.h.

static const std::string& RasterLayer::signalAnimationChanged (  )  [static]

Emitted when the Animation changes with boost::any<Animation*> containing a pointer to the new Animation.

Definition at line 990 of file RasterLayer.h.

virtual std::list<ContextMenuAction> RasterLayer::getContextMenuActions (  )  const [pure virtual]

Returns the context menu actions available for this session item.

Returns:
The list of context menu actions that should be displayed when the user right-clicks on a widget displaying or containing the session item.
See also:
ContextMenuAction

Default Implementation:
The default implementation returns the context menu actions listed here.

Implements Layer.

virtual bool RasterLayer::isGpuImageSupported (  )  const [pure virtual]

Queries whether the system hardware supports GPU images for this layer.

GPU images can be used to increase image display performance. For these images, the contrast stretch is performed on the GPU instead of the CPU. For GPU images to be supported, the system hardware must have the appropriate graphics capabilities and drivers.

When GPU images are displayed, there may occasionally be a loss of color resolution based on the data type and the range of data values being displayed. If this occurs, The GPU image can be toggled off by calling enableGpuImage().

Currently, data sets containing complex data cannot be displayed with GPU images.

Returns:
True if the system hardware supports GPU images and the data set displayed by this layer supports GPU images. Data sets containing complex data cannot be displayed with GPU images.
See also:
enableGpuImage()

virtual void RasterLayer::enableGpuImage ( bool  bEnable  )  [pure virtual]

Toggles the GPU image display of the layer.

This method enabled or disables the use of the GPU image when displaying the layer. If GPU images are not supported, this method does nothing. View::refresh() should be called to force a redraw as this method does not automatically redraw the layer.

Parameters:
bEnable Set this value to true to enable the GPU image or to false to disable the GPU image.
Subject Notifications:
This method will notify signalGpuImageEnabled() with boost::any<bool>.
See also:
isGpuImageSupported(), isGpuImageEnabled()

virtual bool RasterLayer::isGpuImageEnabled (  )  const [pure virtual]

Queries whether the GPU image is enabled.

Returns:
True if the GPU image is currently enabled, otherwise false. False is also returned if GPU images are not supported.
See also:
isGpuImageSupported(), enableGpuImage()

virtual void RasterLayer::setDisplayMode ( const DisplayMode &  eMode  )  [pure virtual]

Sets the display mode for the current raster layer.

Parameters:
eMode The new display mode.
See also:
getDisplayMode(), toggleDisplayMode()

virtual DisplayMode RasterLayer::getDisplayMode (  )  const [pure virtual]

Returns the display mode of the current raster layer.

Returns:
The current display mode.
See also:
setDisplayMode()

virtual void RasterLayer::toggleDisplayMode (  )  [pure virtual]

Toggles the display mode of the current raster layer.

This toggles the current display mode between grayscale and RGB.

See also:
setDisplayMode()

virtual void RasterLayer::setDisplayedBand ( RasterChannelType  eColor,
DimensionDescriptor  band,
RasterElement *  pRasterElement = NULL 
) [pure virtual]

Sets a single band to display in a color channel.

This method replaces the existing displayed band in the given color channel with the given band. The contrast stretch for the channel is not changed, regardless of the given raster element.

Parameters:
eColor The color channel for the new displayed band.
band The band to display. Pass in an invalid band to not display any band in the given channel.
pRasterElement The raster element on which the band is located. If NULL is passed in (the default), the layer's raster element is used. If the raster element does not have a band with the same active number as the given band, the displayed band is not changed. Also, the raster element must have the same number of rows and columns as the layer's raster element; otherwise the displayed band is not changed.
Subject Notifications:
The signalDisplayedBandChanged() signal is emitted with boost::any<std::pair<RasterChannelType, const DimensionDescriptor*> > containing the color channel and the new displayed band.
See also:
getDisplayedBand(), DimensionDescriptor::isValid()

virtual DimensionDescriptor RasterLayer::getDisplayedBand ( RasterChannelType  eColor  )  const [pure virtual]

Returns the displayed band for the given color.

Parameters:
eColor The color for the displayed bands.
Returns:
The displayed band for the given color.
See also:
isBandDisplayed(), getDisplayedRasterElement()

virtual RasterElement* RasterLayer::getDisplayedRasterElement ( RasterChannelType  eColor  )  const [pure virtual]

Returns the displayed raster element object for a given color.

Parameters:
eColor The color for the displayed raster element.
Returns:
The displayed raster element of the given color.
See also:
getDisplayedBand()

virtual bool RasterLayer::isBandDisplayed ( RasterChannelType  eColor,
DimensionDescriptor  band,
const RasterElement *  pRasterElement = NULL 
) const [pure virtual]

Queries if a band is currently displayed.

Parameters:
eColor The color of the display list to check.
band The band to query for its display.
pRasterElement The RasterElement on which the band is located. Defaults to the loaded cube.
Returns:
TRUE is the band is displayed. FALSE if the band is not displayed or the band number is out of range of the cube.
See also:
getDisplayedBand(), getDisplayedRasterElement()

virtual Statistics* RasterLayer::getStatistics ( RasterChannelType  eChannel  )  const [pure virtual]

Get the statistics for the displayed channel.

Parameters:
eChannel The channel where to get statistics from.
Returns:
Statistics for the given channel.

virtual void RasterLayer::setColorMap ( const ColorMap &  colorMap  )  [pure virtual]

Sets the current colormap that will be used for the GRAY RasterChannelType.

Parameters:
colorMap The new colormap to use.
Subject Notifications:
This method will notify Subject::signalModified.

virtual const ColorMap& RasterLayer::getColorMap (  )  const [pure virtual]

Retrieves the current colormap.

Returns:
The current colormap.

virtual void RasterLayer::setComplexComponent ( const ComplexComponent &  eComponent  )  [pure virtual]

Sets the display component for complex raster data.

This method sets the display component for complex data. If the data is not complex, calling this method has no effect.

Parameters:
eComponent The new complex display component.
Subject Notifications:
This method will notify signalComplexComponentChanged() with boost::any<ComplexComponent>.
See also:
ComplexComponent, getComplexComponent()

virtual ComplexComponent RasterLayer::getComplexComponent (  )  const [pure virtual]

Returns the currently displayed component of complex raster data.

Returns:
The current complex display component.
See also:
setComplexComponent()

virtual void RasterLayer::setStretchType ( const DisplayMode &  eMode,
const StretchType &  eType 
) [pure virtual]

Sets the stretch type for the given display mode.

Parameters:
eMode The display mode.
eType The new stretch type.
Subject Notifications:
This method will notify signalStretchTypeChanged() with boost::any<std::pair<DisplayMode, StretchType> >.
See also:
getStretchType()

virtual StretchType RasterLayer::getStretchType ( const DisplayMode &  eMode  )  const [pure virtual]

Returns the stretch type for the given display mode.

Parameters:
eMode The display mode.
Returns:
The current stretch type.
See also:
setStretchType()

virtual void RasterLayer::setStretchUnits ( const DisplayMode &  eMode,
const RegionUnits &  eUnits 
) [pure virtual]

Sets the stretch units for the given display mode.

Parameters:
eMode The display mode. RGB_MODE sets red, green, and blue.
eUnits The new stretch units.
Subject Notifications:
This method will notify signalStretchUnitsChanged() with boost::any<std::pair<RasterChannelType, RegionUnits> > for each RasterChannelType in the specified DisplayMode.
See also:
getStretchUnits()

virtual void RasterLayer::setStretchUnits ( const RasterChannelType &  eColor,
const RegionUnits &  eUnits 
) [pure virtual]

Sets the stretch units for the given color.

Parameters:
eColor The color to set.
eUnits The new stretch units.
Subject Notifications:
This method will notify signalStretchUnitsChanged() with boost::any<std::pair<RasterChannelType, RegionUnits> >.
See also:
getStretchUnits()

virtual RegionUnits RasterLayer::getStretchUnits ( const RasterChannelType &  eColor  )  const [pure virtual]

Returns the stretch units for the given color.

Parameters:
eColor The color.
Returns:
The current stretch units.
See also:
setStretchUnits()

virtual void RasterLayer::setStretchValues ( const RasterChannelType &  eColor,
double  dLower,
double  dUpper 
) [pure virtual]

Sets the stretch values for the given display color.

Parameters:
eColor The display color.
dLower The lower stretch value. Should be less than the upper value.
dUpper The upper stretch value. Should be greater than the lower value.
Subject Notifications:
This method will notify signalStretchValuesChanged() with boost::any<boost::tuple<RasterChannelType, double, double> >.
See also:
getStretchValues()

virtual void RasterLayer::getStretchValues ( const RasterChannelType &  eColor,
double &  dLower,
double &  dUpper 
) const [pure virtual]

Retrieves the stretch values for the given display color.

Parameters:
eColor The display color.
dLower A double value to contain the lower stretch value.
dUpper A double value to contain the upper stretch value.
See also:
getStretchValues()

virtual void RasterLayer::resetStretch ( const RasterChannelType &  eColor = RasterChannelType()  )  [pure virtual]

Resets the stretch type, units, values, and displayed band(s) for the specified channel(s) back to those used when the layer was created.

Parameters:
eColor The color to reset or an invalid enum to reset all colors.
Subject Notifications:
This method will notify the same signals as setDisplayedBand(), setStretchType(), setStretchUnits(), and setStretchValues().
See also:
setDisplayedBand(), setStretchType(), setStretchUnits(), setStretchValues()

virtual double RasterLayer::convertStretchValue ( const RasterChannelType &  eColor,
const RegionUnits &  eUnits,
double  dStretchValue,
const RegionUnits &  eNewUnits 
) const [pure virtual]

Converts a stretch value from one stretch units to another.

Parameters:
eColor The display color. This value is needed to get the data value statistics.
eUnits The initial stretch units.
dStretchValue The stretch value to convert.
eNewUnits The stretch units for the converted stretch value.
Returns:
The converted stretch value. If an error occurred, 0.0 is returned.
See also:
convertStretchValue()

virtual double RasterLayer::convertStretchValue ( const RasterChannelType &  eColor,
double  dStretchValue,
const RegionUnits &  eNewUnits 
) const [pure virtual]

Converts a stretch value from the current stretch units to another.

Parameters:
eColor The display color. This value is needed to get the data value statistics.
dStretchValue The stretch value to convert.
eNewUnits The stretch units for the converted stretch value.
Returns:
The converted stretch value. If an error occurred, 0.0 is returned.
See also:
convertStretchValue()

virtual void RasterLayer::setAlpha ( unsigned int  alpha  )  [pure virtual]

Sets the opacity for the raster layer.

Parameters:
alpha The opacity for the layer (0=transparent, 255=opaque).
Subject Notifications:
This method will notify signalAlphaChanged() with boost::any<unsigned int>.
See also:
getAlpha()

virtual unsigned int RasterLayer::getAlpha (  )  const [pure virtual]

Returns the opacity for the raster layer.

Returns:
The current opacity (0=transparent, 255=opaque).
See also:
setAlpha()

virtual bool RasterLayer::canApplyFastContrastStretch (  )  const [pure virtual]

Determines if the layer can currently support fast changing of contrast stretch parameters (i.e.

without regenerating the textures). This is a function of the underlying computer platform and the current contrast and alpha blending settings.

Returns:
true if fast contrast stretch changes are currently supported, false otherwise.
See also:
setAlpha()

virtual bool RasterLayer::enableFastContrastStretch ( bool  enable  )  [pure virtual]

This method is OBSOLETE and should not be used.

It is maintained for binary compatibility.

virtual bool RasterLayer::isFilterSupported ( const std::string &  filterName  )  const [pure virtual]

Queries whether an image filter is supported by the layer.

Not all layers support each filter type. This method queries the layer to see if it supports the given type.

Parameters:
filterName The name of the filter to query whether it is supported.
Returns:
Returns true if the filter is supported by the layer, otherwise returns false. Since image filtering is only available for GPU images, false is also returned if GPU images are not supported.
See also:
getSupportedFilters()

virtual std::vector<std::string> RasterLayer::getSupportedFilters (  )  const [pure virtual]

Returns the names of all image filters supported by the layer.

Returns:
A vector of supported image filter names.
See also:
isFilterSupported()

virtual void RasterLayer::enableFilter ( const std::string &  filterName  )  [pure virtual]

Enables an image filter.

This method enables the use of the given filter. Each of the enabled filters are applied to the image before it is drawn to the screen. View::refresh() should be called to force a redraw as this method does not automatically redraw the layer.

Filtering is only available for GPU images.

Parameters:
filterName The name of the filter to enable. If the string is empty, already enabled, or not supported, this method does nothing.
Subject Notifications:
This method will notify signalFiltersChanged() with boost::any<std::vector<ImageFilterDescriptor*> > containing the enabled filters at the end of the call.
See also:
getEnabledFilter(), enableFilters(), disableFilter(), isGpuImageEnabled()

virtual void RasterLayer::enableFilters ( const std::vector< std::string > &  filterNames  )  [pure virtual]

Enables multiple image filters.

This method enables the use of the given filters. Each of the enabled filters are applied to the image before it is drawn to the screen. This method is similar to enableFilter(), but any currently enabled filters that are not in the given vector are disabled. View::refresh() should be called to force a redraw as this method does not automatically redraw the layer.

Filtering is only available for GPU images.

Parameters:
filterNames The names of the filters to enable.
Subject Notifications:
This method will notify signalFiltersChanged() with boost::any<std::vector<ImageFilterDescriptor*> > containing the enabled filters at the end of the call.
See also:
getEnabledFilters(), enableFilter(), disableFilter(), isGpuImageSupported()

virtual void RasterLayer::disableFilter ( const std::string &  filterName  )  [pure virtual]

Disables an image filter.

This method disables an image filter, so that the filter is not applied to an image before it is drawn. View::refresh() should be called to force a redraw as this method does not automatically redraw the layer.

Parameters:
filterName The name of the filter to disable. If the string is empty, or if it is not already enabled, this method does nothing.
Subject Notifications:
This method will notify signalFiltersChanged() with boost::any<std::vector<ImageFilterDescriptor*> > containing the enabled filters at the end of the call.
See also:
enableFilter()

virtual bool RasterLayer::isFilterEnabled ( const std::string &  filterName  )  const [pure virtual]

Queries whether an image filter is enabled.

Parameters:
filterName The name of the filter to query whether it is enabled.
Returns:
Returns true if the filter is currently enabled, otherwise returns false.
See also:
enableFilter(), disableFilter()

virtual ImageFilterDescriptor* RasterLayer::getEnabledFilter ( const std::string &  filterName  )  const [pure virtual]

Returns the enabled image filter with the given name.

Parameters:
filterName Name of the enabled image filter descriptor requested.
Returns:
The enabled image filter descriptor pointer. NULL is returned if the filter with the given name is not currently enabled.

virtual const std::vector<ImageFilterDescriptor*>& RasterLayer::getEnabledFilters (  )  const [pure virtual]

Returns all currently enabled image filters.

Returns:
A reference to a vector of enabled filters. The vector should not be modified.
See also:
getEnabledFilterNames(), enableFilter(), disableFilter()

virtual std::vector<std::string> RasterLayer::getEnabledFilterNames (  )  const [pure virtual]

Returns the names of all currently enabled image filters.

Returns:
The names of the currently enabled filters.
See also:
getEnabledFilters()

virtual void RasterLayer::resetFilter ( const std::string &  filterName  )  [pure virtual]

Resets the image filter.

This method resets the image filter. If the image filter has a ImageFilterDescriptor::FEEDBACK_FILTER type, the method clears the filter's estimate image buffer. View::refresh() should be called to force a redraw as this method does not automatically redraw the layer.

Filtering is only available for GPU images.

Parameters:
filterName The name of the filter to reset.
See also:
freezeFilter()

virtual void RasterLayer::freezeFilter ( const std::string &  filterName,
bool  toggle = true 
) [pure virtual]

Freezes the image filter with its current values.

This method freezes the image filter. If the image filter has a ImageFilterDescriptor::FEEDBACK_FILTER type, the method freezes the filter's estimate image buffer. The estimate buffer's values do not update anymore.

Filtering is only available for GPU images.

Parameters:
filterName The name of the filter to freeze.
toggle Set this value to true to freeze the filter or to false to unfreeze the filter.
See also:
resetFilter()

virtual unsigned int RasterLayer::readFilterBuffer ( double  xCoord,
double  yCoord,
int  width,
int  height,
std::vector< float > &  values,
bool &  hasAlphas 
) [pure virtual]

Returns the number of elements read in from the filtered results image buffer.

Parameters:
xCoord The "x" coordinate used to read from the filtered results image buffer.
yCoord The "y" coordinate used to read from the filtered results image buffer.
width The width of the box of elements to read out of the filtered results image buffer.
height The height of the box of elements to read out of the filtered results image buffer.
values A vector populated with the filtered results.
hasAlphas A bool value to contain a flag indicating whether the results contain interleaved alpha values or not.
Returns:
Number of elements read. Zero is returned if isGpuImageEnabled() returns false or if getEnabledFilters() returns an empty vector. If alpha values are present, they will be included in this value.

virtual void RasterLayer::setAnimation ( Animation *  pAnimation  )  [pure virtual]

Associates an animation object with the layer.

This method associates an animation with the layer to automatically update the displayed band as the animation object is updated. When the animation object is updated, the layer will change based on the current display state. If the display mode is grayscale, the displayed band will change to match the animation frame. If the display mode is RGB, the band for each color component will change to match the animation frame. If a component has no valid RasterElement attached, or that element does not contain enough bands to display the animation frame, that component will be disabled.

Parameters:
pAnimation The animation object to associate. The layer does not take ownership of the animation, so a previously associated animation is not deleted. A value of NULL can be used to disable the automatic displayed band updates when the animation object is updated.
Subject Notifications:
This method will notify signalAnimationChanged() with boost::any<Animation*>.
See also:
getAnimation(), Animation

virtual Animation* RasterLayer::getAnimation (  )  const [pure virtual]

Returns the animation object associated with the layer.

Returns:
The associated animation object. NULL is returned if no animation is currently associated with the layer (the default state).
See also:
setAnimation(), Animation

Software Development Kit - Opticks 4.9.0 Build 16218