ThresholdLayer Class Reference

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

#include <ThresholdLayer.h>

Inheritance diagram for ThresholdLayer:

Inheritance graph

List of all members.

Public Member Functions

virtual void setFirstThreshold (double dRawValue)=0
virtual double getFirstThreshold () const =0
virtual void setSecondThreshold (double dRawValue)=0
virtual double getSecondThreshold () const =0
virtual void setPassArea (const PassArea &eArea)=0
virtual PassArea getPassArea () const =0
virtual void setRegionUnits (const RegionUnits &eUnits)=0
virtual RegionUnits getRegionUnits () const =0
virtual double convertThreshold (const RegionUnits &eUnits, double dThreshold, const RegionUnits &eNewUnits)=0
virtual double convertThreshold (double dThreshold, const RegionUnits &eNewUnits)=0
virtual SymbolType getSymbol () const =0
virtual void setSymbol (SymbolType symbol)=0
virtual ColorType getColor () const =0
virtual void setColor (const ColorType &color)=0

Static Public Member Functions

static bool getSettingAutoColor ()
static bool hasSettingAutoColor ()
static void setSettingAutoColor (bool newValue, bool setIfSame=false)
static std::string getSettingAutoColorKey ()
static double getSettingFirstValue ()
static bool hasSettingFirstValue ()
static void setSettingFirstValue (double newValue, bool setIfSame=false)
static std::string getSettingFirstValueKey ()
static ColorType getSettingMarkerColor ()
static bool hasSettingMarkerColor ()
static void setSettingMarkerColor (ColorType newValue, bool setIfSame=false)
static std::string getSettingMarkerColorKey ()
static SymbolType getSettingMarkerSymbol ()
static bool hasSettingMarkerSymbol ()
static void setSettingMarkerSymbol (SymbolType newValue, bool setIfSame=false)
static std::string getSettingMarkerSymbolKey ()
static PassArea getSettingPassArea ()
static bool hasSettingPassArea ()
static void setSettingPassArea (PassArea newValue, bool setIfSame=false)
static std::string getSettingPassAreaKey ()
static double getSettingSecondValue ()
static bool hasSettingSecondValue ()
static void setSettingSecondValue (double newValue, bool setIfSame=false)
static std::string getSettingSecondValueKey ()
static RegionUnits getSettingRegionUnits ()
static bool hasSettingRegionUnits ()
static void setSettingRegionUnits (RegionUnits newValue, bool setIfSame=false)
static std::string getSettingRegionUnitsKey ()
static const std::string & signalUnitsChanged ()
static const std::string & signalPassAreaChanged ()
static const std::string & signalFirstThresholdChanged ()
static const std::string & signalSecondThresholdChanged ()
static const std::string & signalSymbolChanged ()
static const std::string & signalColorChanged ()

Protected Member Functions

virtual ~ThresholdLayer ()

Detailed Description

Adjusts the properties of a threshold layer.

A threshold layer consists of markers identifying pixels in a scene that fall in a defined range of values. To identify the marked pixels, the following properties are present: pass area, region units, and one or two threshold values. The pass area defines how many threshold values are used and how they define the marked pixels. The pixel marker is drawn with a symbol based on the AOI properties.

This subclass of Subject will notify upon the following conditions:

See also:
AoiLayer

Definition at line 34 of file ThresholdLayer.h.

Constructor & Destructor Documentation

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

This should be destroyed by calling SpatialDataView::deleteLayer.

Definition at line 519 of file ThresholdLayer.h.

Member Function Documentation

static bool ThresholdLayer::getSettingAutoColor (  )  [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 47 of file ThresholdLayer.h.

static bool ThresholdLayer::hasSettingAutoColor (  )  [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 54 of file ThresholdLayer.h.

static void ThresholdLayer::setSettingAutoColor ( 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 70 of file ThresholdLayer.h.

static std::string ThresholdLayer::getSettingAutoColorKey (  )  [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 78 of file ThresholdLayer.h.

static double ThresholdLayer::getSettingFirstValue (  )  [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 89 of file ThresholdLayer.h.

static bool ThresholdLayer::hasSettingFirstValue (  )  [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 96 of file ThresholdLayer.h.

static void ThresholdLayer::setSettingFirstValue ( 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 112 of file ThresholdLayer.h.

static std::string ThresholdLayer::getSettingFirstValueKey (  )  [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 120 of file ThresholdLayer.h.

static ColorType ThresholdLayer::getSettingMarkerColor (  )  [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 131 of file ThresholdLayer.h.

static bool ThresholdLayer::hasSettingMarkerColor (  )  [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 138 of file ThresholdLayer.h.

static void ThresholdLayer::setSettingMarkerColor ( ColorType  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 154 of file ThresholdLayer.h.

static std::string ThresholdLayer::getSettingMarkerColorKey (  )  [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 162 of file ThresholdLayer.h.

static SymbolType ThresholdLayer::getSettingMarkerSymbol (  )  [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 173 of file ThresholdLayer.h.

static bool ThresholdLayer::hasSettingMarkerSymbol (  )  [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 180 of file ThresholdLayer.h.

static void ThresholdLayer::setSettingMarkerSymbol ( SymbolType  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 196 of file ThresholdLayer.h.

static std::string ThresholdLayer::getSettingMarkerSymbolKey (  )  [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 204 of file ThresholdLayer.h.

static PassArea ThresholdLayer::getSettingPassArea (  )  [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 215 of file ThresholdLayer.h.

static bool ThresholdLayer::hasSettingPassArea (  )  [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 222 of file ThresholdLayer.h.

static void ThresholdLayer::setSettingPassArea ( PassArea  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 238 of file ThresholdLayer.h.

static std::string ThresholdLayer::getSettingPassAreaKey (  )  [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 246 of file ThresholdLayer.h.

static double ThresholdLayer::getSettingSecondValue (  )  [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 257 of file ThresholdLayer.h.

static bool ThresholdLayer::hasSettingSecondValue (  )  [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 264 of file ThresholdLayer.h.

static void ThresholdLayer::setSettingSecondValue ( 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 280 of file ThresholdLayer.h.

static std::string ThresholdLayer::getSettingSecondValueKey (  )  [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 288 of file ThresholdLayer.h.

static RegionUnits ThresholdLayer::getSettingRegionUnits (  )  [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 299 of file ThresholdLayer.h.

static bool ThresholdLayer::hasSettingRegionUnits (  )  [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 306 of file ThresholdLayer.h.

static void ThresholdLayer::setSettingRegionUnits ( 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 322 of file ThresholdLayer.h.

static std::string ThresholdLayer::getSettingRegionUnitsKey (  )  [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 330 of file ThresholdLayer.h.

static const std::string& ThresholdLayer::signalUnitsChanged (  )  [static]

Emitted with boost::any<RegionUnits> when the units are changed.

Definition at line 335 of file ThresholdLayer.h.

static const std::string& ThresholdLayer::signalPassAreaChanged (  )  [static]

Emitted with boost::any<PassArea> when the pass area is changed.

Definition at line 340 of file ThresholdLayer.h.

static const std::string& ThresholdLayer::signalFirstThresholdChanged (  )  [static]

Emitted with boost::any<double> when the first threshold is changed.

Definition at line 345 of file ThresholdLayer.h.

static const std::string& ThresholdLayer::signalSecondThresholdChanged (  )  [static]

Emitted with boost::any<double> when the second threshold is changed.

Definition at line 350 of file ThresholdLayer.h.

static const std::string& ThresholdLayer::signalSymbolChanged (  )  [static]

Emitted with boost::any<SymbolType> when the symbol is changed.

Definition at line 355 of file ThresholdLayer.h.

static const std::string& ThresholdLayer::signalColorChanged (  )  [static]

Emitted with boost::any<ColorType> when the color is changed.

Definition at line 360 of file ThresholdLayer.h.

virtual void ThresholdLayer::setFirstThreshold ( double  dRawValue  )  [pure virtual]

Sets the first threshold value for the current threshold layer.

The first threshold value is used as the sole threshold value for the LOWER and UPPER pass areas. It is also used as the lower threshold value for the MIDDLE and OUTSIDE pass areas.

Parameters:
dRawValue The new threshold value as a raw value.
Subject Notifications:
This method will notify signalFirstThresholdChanged() with boost::any<double>.
See also:
getFirstThreshold(), setSecondThreshold()

virtual double ThresholdLayer::getFirstThreshold (  )  const [pure virtual]

Returns the first threshold value for the current threshold layer as a raw value.

Returns:
The threshold value as a raw value.
See also:
setFirstThreshold(), getSecondThreshold()

virtual void ThresholdLayer::setSecondThreshold ( double  dRawValue  )  [pure virtual]

Sets the second threshold value for the current threshold layer.

The second threshold value is used as the upper threshold value for the MIDDLE and OUTSIDE pass areas. It is ignored for the LOWER and UPPER pass areas.

Parameters:
dRawValue The new threshold value as a raw value.
Subject Notifications:
This method will notify signalSecondThresholdChanged() with boost::any<double>.
See also:
getSecondThreshold(), setFirstThreshold()

virtual double ThresholdLayer::getSecondThreshold (  )  const [pure virtual]

Returns the second threshold value for the current threshold layer as a raw value.

Returns:
The threshold value as a raw value.
See also:
getFirstThreshold(), setSecondThreshold()

virtual void ThresholdLayer::setPassArea ( const PassArea &  eArea  )  [pure virtual]

Sets the pass area for the current threshold layer.

Parameters:
eArea The new pass area.
Subject Notifications:
This method will notify signalPassAreaChanged() with boost::any<PassArea>.
See also:
getPassArea()

virtual PassArea ThresholdLayer::getPassArea (  )  const [pure virtual]

Returns the pass area of the current threshold layer.

Returns:
The current pass area.
See also:
setPassArea()

virtual void ThresholdLayer::setRegionUnits ( const RegionUnits &  eUnits  )  [pure virtual]

Sets the threshold units for the current threshold layer.

Parameters:
eUnits The new threshold units.
Subject Notifications:
This method will notify signalTypeChanged() with boost::any<RegionUnits>.
See also:
getRegionUnits()

virtual RegionUnits ThresholdLayer::getRegionUnits (  )  const [pure virtual]

Returns the threshold units of the current threshold layer.

Returns:
The current threshold units.
See also:
setRegionUnits()

virtual double ThresholdLayer::convertThreshold ( const RegionUnits &  eUnits,
double  dThreshold,
const RegionUnits &  eNewUnits 
) [pure virtual]

Converts a threshold value from one threshold units to another.

Parameters:
eUnits The initial threshold units.
dThreshold The threshold value to convert.
eNewUnits The threshold units for the converted value.
Returns:
The converted threshold value. If an error occurred, 0.0 is returned.

virtual double ThresholdLayer::convertThreshold ( double  dThreshold,
const RegionUnits &  eNewUnits 
) [pure virtual]

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

Parameters:
dThreshold The threshold value to convert.
eNewUnits The threshold units for the converted value.
Returns:
The converted threshold value. If an error occurred, 0.0 is returned.

virtual SymbolType ThresholdLayer::getSymbol (  )  const [pure virtual]

Retrieves the layer's current symbol style.

Returns:
The current symbol style.

virtual void ThresholdLayer::setSymbol ( SymbolType  symbol  )  [pure virtual]

Sets the layer's current symbol style.

Parameters:
symbol The new symbol style.
Subject Notifications:
This method will notify signalSymbolChanged() with boost::any<SymbolType>.

virtual ColorType ThresholdLayer::getColor (  )  const [pure virtual]

Retrieves the layer's current color.

Returns:
The layer's current color.

virtual void ThresholdLayer::setColor ( const ColorType &  color  )  [pure virtual]

Sets the layer's color.

Parameters:
color The new color.
Subject Notifications:
This method will notify signalColorChanged() with boost::any<ColorType>.

Software Development Kit - Opticks 4.9.0 Build 16218