Package org.geotools.styling
Class ContrastEnhancementImpl
Object
ContrastEnhancementImpl
- All Implemented Interfaces:
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
ConstructorsConstructorDescriptionContrastEnhancementImpl
(FilterFactory factory) ContrastEnhancementImpl
(FilterFactory factory, Expression gamma, ContrastMethod method) ContrastEnhancementImpl
(FilterFactory factory, ContrastMethod method) ContrastEnhancementImpl
(ContrastEnhancement contrastEnhancement) -
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(StyleVisitor visitor) Traversal of the style data structure.accept
(TraversingStyleVisitor visitor, Object extraData) calls the visit method of a StyleVisitorvoid
addOption
(String key, Expression value) Store a vendor optionboolean
How much to brighten (values greater than 1.0) or dim (values less than 1.0) an image.We use a codeList to enable more enchancement type possibilities.Return vendor options relating to the enhancement methodint
hashCode()
boolean
check if vendor option key is availablevoid
setFilterFactory
(FilterFactory factory) void
setGammaValue
(Expression gamma) void
setMethod
(ContrastMethod method) Used to set the contrast enhancement method used.void
setMethod
(ContrastMethodStrategy method) Convenience method to allow users to pass in aContrastMethodStrategy
to updateContrastEnhancement.setMethod(org.geotools.api.style.ContrastMethod)
andContrastEnhancement.setOptions(java.util.Map<java.lang.String, org.geotools.api.filter.expression.Expression>)
in one go.void
setOptions
(Map<String, Expression> options)
-
Constructor Details
-
ContrastEnhancementImpl
public ContrastEnhancementImpl() -
ContrastEnhancementImpl
-
ContrastEnhancementImpl
-
ContrastEnhancementImpl
-
ContrastEnhancementImpl
-
-
Method Details
-
setFilterFactory
-
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 interfaceContrastEnhancement
- Returns:
- Expression, if
null
a value of 1.0 is assumed indicating no change
-
setGammaValue
- Specified by:
setGammaValue
in interfaceContrastEnhancement
- Parameters:
gamma
- How much to brighten (greater than 1) or dim (less than 1) this channel; use 1.0 to indicate no change.
-
getMethod
Description copied from interface:ContrastEnhancement
We use a codeList to enable more enchancement type possibilities.- Specified by:
getMethod
in interfaceContrastEnhancement
-
accept
Description copied from interface:ContrastEnhancement
calls the visit method of a StyleVisitor- Specified by:
accept
in interfaceContrastEnhancement
- Parameters:
visitor
- the style visitor
-
accept
Description copied from interface:ContrastEnhancement
Traversal of the style data structure.- Specified by:
accept
in interfaceContrastEnhancement
-
setMethod
Description copied from interface:ContrastEnhancement
Used to set the contrast enhancement method used.- Specified by:
setMethod
in interfaceContrastEnhancement
-
getOptions
Description copied from interface:ContrastEnhancement
Return vendor options relating to the enhancement method- Specified by:
getOptions
in interfaceContrastEnhancement
- Returns:
- a Map containing expressions with string keys.
-
hasOption
Description copied from interface:ContrastEnhancement
check if vendor option key is available- Specified by:
hasOption
in interfaceContrastEnhancement
- Parameters:
key
- - the name of the option to check- Returns:
- true if present
-
getOption
- Specified by:
getOption
in interfaceContrastEnhancement
- Returns:
- An expression for the matching VendorOption
-
addOption
Description copied from interface:ContrastEnhancement
Store a vendor option- Specified by:
addOption
in interfaceContrastEnhancement
- Parameters:
key
- - the name of the optionvalue
- an expression that evaluates to it's value
-
setOptions
- Specified by:
setOptions
in interfaceContrastEnhancement
- Parameters:
options
- a Map of VendorOptions
-
setMethod
Description copied from interface:ContrastEnhancement
Convenience method to allow users to pass in aContrastMethodStrategy
to updateContrastEnhancement.setMethod(org.geotools.api.style.ContrastMethod)
andContrastEnhancement.setOptions(java.util.Map<java.lang.String, org.geotools.api.filter.expression.Expression>)
in one go.- Specified by:
setMethod
in interfaceContrastEnhancement
- Parameters:
method
- theContrastMethodStrategy
that underlies this enhancement
-
hashCode
public int hashCode() -
equals
-