ChannelSelection (Groovy Documentation)

geoscript.style.ChannelSelection

The ChannelSelection Symbolizer is used to style multi-spectral Rasters such as multi-band satellite imagery.
You can create a ChannelSelection for RGB channels:
```
 def channel = new ChannelSelection("red", "green", "blue")
 
```
Or you can create a ChannelSelection for a gray scale channel:
```
 def channel = new ChannelSelection("gray")
 
```
Or you can create a ChannelSelection for a RBG channels with specific ContrastEnhancement values:
```
 def channel = new ChannelSelection()
    .red("red", new ContrastEnhancement("histogram", 0.35))
    .green("green", new ContrastEnhancement("histogram", 0.45))
    .blue("blue", new ContrastEnhancement("histogram", 0.55))
 
```
Authors:
Jared Erickson

Inherited fields
Fields inherited from class	Fields
`class Symbolizer`	`filterFactory, styleBuilder, styleFactory, styleOptions`

Properties Summary

Properties
Type	Name and description
`ContrastEnhancement`	`blueContrastEnhancement` The blue ContrastEnhancement
`java.lang.String`	`blueName` The blue channel name
`ContrastEnhancement`	`grayContrastEnhancement` The gray ContrastEnhancement
`java.lang.String`	`grayName` The gray channel name
`ContrastEnhancement`	`greenContrastEnhancement` The green ContrastEnhancement
`java.lang.String`	`greenName` The green channel name
`ContrastEnhancement`	`redContrastEnhancement` The red ContrastEnhancement
`java.lang.String`	`redName` The red channel name

Constructor Summary

Constructors
Constructor and description
`ChannelSelection ()` Create a new ChannelSelection
`ChannelSelection (java.lang.String redName, java.lang.String greenName, java.lang.String blueName)` Create a new ChannelSelection with red, green, and blue channel names
`ChannelSelection (java.lang.String grayName)` Create a new ChannelSelection with a gray channel name
`ChannelSelection (java.util.Map map)` Create a new ChannelSelection from named parameters.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`apply(org.geotools.styling.Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer
	`ChannelSelection`	`blue(java.lang.String name, ContrastEnhancement contrastEnhancement = null)` Set the blue channel name and optionally the blue ContrastEnhancement
	`ChannelSelection`	`gray(java.lang.String name, ContrastEnhancement contrastEnhancement = null)` Set the gray channel name and optionally the gray ContrastEnhancement
	`ChannelSelection`	`green(java.lang.String name, ContrastEnhancement contrastEnhancement = null)` Set the green channel name and optionally the green ContrastEnhancement
	`protected void`	`prepare(org.geotools.styling.Rule rule)` Prepare the GeoTools Rule by applying this Symbolizer
	`ChannelSelection`	`red(java.lang.String name, ContrastEnhancement contrastEnhancement = null)` Set the red channel name and optionally the red ContrastEnhancement
	`java.lang.String`	`toString()` The string representation

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class RasterSymbolizer`	`apply, geometry, opacity, overlap, prepare, setGeometry, setOpacity, setOverlap, toString`
`class Symbolizer`	`and, apply, asSLD, asSLD, buildString, composite, createGeoToolsSymbolizer, getDefault, getDefault, getGeoToolsSymbolizers, getGtStyle, getSld, plus, prepare, prepare, range, range, sortBy, sortBy, where, zindex`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - ContrastEnhancement blueContrastEnhancement
    
    The blue ContrastEnhancement
  - java.lang.String blueName
    
    The blue channel name
  - ContrastEnhancement grayContrastEnhancement
    
    The gray ContrastEnhancement
  - java.lang.String grayName
    
    The gray channel name
  - ContrastEnhancement greenContrastEnhancement
    
    The green ContrastEnhancement
  - java.lang.String greenName
    
    The green channel name
  - ContrastEnhancement redContrastEnhancement
    
    The red ContrastEnhancement
  - java.lang.String redName
    
    The red channel name
- Constructor Detail
  - ChannelSelection()
    
    Create a new ChannelSelection
  - ChannelSelection(java.lang.String redName, java.lang.String greenName, java.lang.String blueName)
    
    Create a new ChannelSelection with red, green, and blue channel names
    Parameters:
    redName - The red channel name
    greenName - The green channel name
    blueName - The blue channel name
  - ChannelSelection(java.lang.String grayName)
    
    Create a new ChannelSelection with a gray channel name
    Parameters:
    grayName - The gray channel name
  - ChannelSelection(java.util.Map map)
    
    Create a new ChannelSelection from named parameters.
    Parameters:
    map - A Map of named parameters.
- Method Detail
  - @java.lang.Override protected void apply(org.geotools.styling.Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - ChannelSelection blue(java.lang.String name, ContrastEnhancement contrastEnhancement = null)
    
    Set the blue channel name and optionally the blue ContrastEnhancement
    Parameters:
    name - The blue channel name
    contrastEnhancement - The blue ContrastEnhancement
    Returns:
    This ChannelSelection
  - ChannelSelection gray(java.lang.String name, ContrastEnhancement contrastEnhancement = null)
    
    Set the gray channel name and optionally the gray ContrastEnhancement
    Parameters:
    name - The gray channel name
    contrastEnhancement - The gray ContrastEnhancement
    Returns:
    This ChannelSelection
  - ChannelSelection green(java.lang.String name, ContrastEnhancement contrastEnhancement = null)
    
    Set the green channel name and optionally the green ContrastEnhancement
    Parameters:
    name - The green channel name
    contrastEnhancement - The green ContrastEnhancement
    Returns:
    This ChannelSelection
  - @java.lang.Override protected void prepare(org.geotools.styling.Rule rule)
    
    Prepare the GeoTools Rule by applying this Symbolizer
    Parameters:
    rule - The GeoTools Rule
  - ChannelSelection red(java.lang.String name, ContrastEnhancement contrastEnhancement = null)
    
    Set the red channel name and optionally the red ContrastEnhancement
    Parameters:
    name - The red channel name
    contrastEnhancement - The red ContrastEnhancement
    Returns:
    This ChannelSelection
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class ChannelSelection

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

ContrastEnhancement blueContrastEnhancement

java.lang.String blueName

ContrastEnhancement grayContrastEnhancement

java.lang.String grayName

ContrastEnhancement greenContrastEnhancement

java.lang.String greenName

ContrastEnhancement redContrastEnhancement

java.lang.String redName

Constructor Detail

ChannelSelection()

ChannelSelection(java.lang.String redName, java.lang.String greenName, java.lang.String blueName)

ChannelSelection(java.lang.String grayName)

ChannelSelection(java.util.Map map)

Method Detail

@java.lang.Override protected void apply(org.geotools.styling.Symbolizer sym)

ChannelSelection blue(java.lang.String name, ContrastEnhancement contrastEnhancement = null)

ChannelSelection gray(java.lang.String name, ContrastEnhancement contrastEnhancement = null)

ChannelSelection green(java.lang.String name, ContrastEnhancement contrastEnhancement = null)

@java.lang.Override protected void prepare(org.geotools.styling.Rule rule)

ChannelSelection red(java.lang.String name, ContrastEnhancement contrastEnhancement = null)

java.lang.String toString()