org.geotools.styling
Class ContrastEnhancementImpl

java.lang.Object
  extended by org.geotools.styling.ContrastEnhancementImpl
All Implemented Interfaces:
org.opengis.style.ContrastEnhancement

public class ContrastEnhancementImpl
extends java.lang.Object
implements ContrastEnhancement

The ContrastEnhancement object defines contrast enhancement for a channel of a false-color image or for a color image. Its format is:

 <xs:element name="ContrastEnhancement">
   <xs:complexType>
     <xs:sequence>
       <xs:choice minOccurs="0">
         <xs:element ref="sld:Normalize"/>
         <xs:element ref="sld:Histogram"/>
       </xs:choice>
       <xs:element ref="sld:GammaValue" minOccurs="0"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>
 <xs:element name="Normalize">
   <xs:complexType/>
 </xs:element>
 <xs:element name="Histogram">
   <xs:complexType/>
 </xs:element>
 <xs:element name="GammaValue" type="xs:double"/>
 
In the case of a color image, the relative grayscale brightness of a pixel color is used. ?Normalize? means to stretch the contrast so that the dimmest color is stretched to black and the brightest color is stretched to white, with all colors in between stretched out linearly. ?Histogram? means to stretch the contrast based on a histogram of how many colors are at each brightness level on input, with the goal of producing equal number of pixels in the image at each brightness level on output. This has the effect of revealing many subtle ground features. A ?GammaValue? tells how much to brighten (value greater than 1.0) or dim (value less than 1.0) an image. The default GammaValue is 1.0 (no change). If none of Normalize, Histogram, or GammaValue are selected in a ContrastEnhancement, then no enhancement is performed.

Author:
iant

Constructor Summary
ContrastEnhancementImpl()
           
ContrastEnhancementImpl(org.opengis.style.ContrastEnhancement contrastEnhancement)
           
ContrastEnhancementImpl(org.opengis.filter.FilterFactory factory)
           
ContrastEnhancementImpl(org.opengis.filter.FilterFactory2 factory, org.opengis.filter.expression.Expression gamma, org.opengis.style.ContrastMethod method)
           
ContrastEnhancementImpl(org.opengis.filter.FilterFactory factory, org.opengis.style.ContrastMethod method)
           
 
Method Summary
 void accept(StyleVisitor visitor)
          Traversal of the style data structure.
 java.lang.Object accept(org.opengis.style.StyleVisitor visitor, java.lang.Object extraData)
           
 boolean equals(java.lang.Object obj)
           
 org.opengis.filter.expression.Expression getGammaValue()
          How much to brighten (values greater than 1.0) or dim (values less than 1.0) an image.
 org.opengis.style.ContrastMethod getMethod()
           
 org.opengis.filter.expression.Expression getType()
          Returns a literal expression (one of NORMALIZE, HISTOGRAM, NONE) indicating which ContrastMethod value is to be used.
 int hashCode()
           
 void setExponential()
           
 void setFilterFactory(org.opengis.filter.FilterFactory factory)
           
 void setGammaValue(org.opengis.filter.expression.Expression gamma)
           
 void setHistogram()
           
 void setLogarithmic()
           
 void setMethod(org.opengis.style.ContrastMethod method)
          Used to set the contrast enhancement method used.
 void setNormalize()
           
 void setType(org.opengis.filter.expression.Expression type)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ContrastEnhancementImpl

public ContrastEnhancementImpl()

ContrastEnhancementImpl

public ContrastEnhancementImpl(org.opengis.filter.FilterFactory factory)

ContrastEnhancementImpl

public ContrastEnhancementImpl(org.opengis.filter.FilterFactory factory,
                               org.opengis.style.ContrastMethod method)

ContrastEnhancementImpl

public ContrastEnhancementImpl(org.opengis.style.ContrastEnhancement contrastEnhancement)

ContrastEnhancementImpl

public ContrastEnhancementImpl(org.opengis.filter.FilterFactory2 factory,
                               org.opengis.filter.expression.Expression gamma,
                               org.opengis.style.ContrastMethod method)
Method Detail

setFilterFactory

public void setFilterFactory(org.opengis.filter.FilterFactory factory)

getGammaValue

public org.opengis.filter.expression.Expression getGammaValue()
Description copied from interface: ContrastEnhancement
How much to brighten (values greater than 1.0) or dim (values less than 1.0) an image. The default GammaValue is 1.0 (no change).

Specified by:
getGammaValue in interface org.opengis.style.ContrastEnhancement
Returns:
Expression, if null a value of 1.0 is assumed indicating no change

getType

public org.opengis.filter.expression.Expression getType()
Description copied from interface: ContrastEnhancement
Returns a literal expression (one of NORMALIZE, HISTOGRAM, NONE) indicating which ContrastMethod value is to be used.


setGammaValue

public void setGammaValue(org.opengis.filter.expression.Expression gamma)
Parameters:
gamma - How much to brighten (greater than 1) or dim (less than 1) this channel; use 1.0 to indicate no change.

setHistogram

public void setHistogram()

setNormalize

public void setNormalize()

setLogarithmic

public void setLogarithmic()

setExponential

public void setExponential()

setType

public void setType(org.opengis.filter.expression.Expression type)
Parameters:
type - Should be a Literal of "Normalize" or "Histogram" or "None", if null supplied "None" is assumed

setMethod

public void setMethod(org.opengis.style.ContrastMethod method)
Description copied from interface: ContrastEnhancement
Used to set the contrast enhancement method used.


getMethod

public org.opengis.style.ContrastMethod getMethod()
Specified by:
getMethod in interface org.opengis.style.ContrastEnhancement

accept

public java.lang.Object accept(org.opengis.style.StyleVisitor visitor,
                               java.lang.Object extraData)
Specified by:
accept in interface org.opengis.style.ContrastEnhancement

accept

public void accept(StyleVisitor visitor)
Description copied from interface: ContrastEnhancement
Traversal of the style data structure.


hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object


Copyright © 1996-2010 Geotools. All Rights Reserved.