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
`private ContrastEnhancement`	`blueContrastEnhancement` The blue ContrastEnhancement
`private java.lang.String`	`blueName` The blue channel name
`private ContrastEnhancement`	`grayContrastEnhancement` The gray ContrastEnhancement
`private java.lang.String`	`grayName` The gray channel name
`private ContrastEnhancement`	`greenContrastEnhancement` The green ContrastEnhancement
`private java.lang.String`	`greenName` The green channel name
`private ContrastEnhancement`	`redContrastEnhancement` The red ContrastEnhancement
`private 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 (Map map)` Create a new ChannelSelection from named parameters.
`ChannelSelection ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`apply(Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer Parameters: `sym` - The GeoTools Symbolizer
	`ChannelSelection`	`blue(java.lang.String name, ContrastEnhancement contrastEnhancement)` 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)` 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)` Set the green channel name and optionally the green ContrastEnhancement Parameters: `name` - The green channel name `contrastEnhancement` - The green ContrastEnhancement Returns: This ChannelSelection
	`protected void`	`prepare(Rule rule)` Prepare the GeoTools Rule by applying this Symbolizer Parameters: `rule` - The GeoTools Rule
	`ChannelSelection`	`red(java.lang.String name, ContrastEnhancement contrastEnhancement)` 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

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`

- Property Detail
  - private ContrastEnhancement blueContrastEnhancement
    
    The blue ContrastEnhancement
  - private java.lang.String blueName
    
    The blue channel name
  - private ContrastEnhancement grayContrastEnhancement
    
    The gray ContrastEnhancement
  - private java.lang.String grayName
    
    The gray channel name
  - private ContrastEnhancement greenContrastEnhancement
    
    The green ContrastEnhancement
  - private java.lang.String greenName
    
    The green channel name
  - private ContrastEnhancement redContrastEnhancement
    
    The red ContrastEnhancement
  - private 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(Map map)
    
    Create a new ChannelSelection from named parameters.
    Parameters:
    map - A Map of named parameters.
  - ChannelSelection()
- Method Detail
  - @java.lang.OverrideOverride protected void apply(Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - ChannelSelection blue(java.lang.String name, ContrastEnhancement contrastEnhancement)
    
    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)
    
    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)
    
    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.OverrideOverride protected void prepare(Rule rule)
    
    Prepare the GeoTools Rule by applying this Symbolizer
    Parameters:
    rule - The GeoTools Rule
  - ChannelSelection red(java.lang.String name, ContrastEnhancement contrastEnhancement)
    
    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

private ContrastEnhancement blueContrastEnhancement

private java.lang.String blueName

private ContrastEnhancement grayContrastEnhancement

private java.lang.String grayName

private ContrastEnhancement greenContrastEnhancement

private java.lang.String greenName

private ContrastEnhancement redContrastEnhancement

private 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(Map map)

ChannelSelection()

Method Detail

@java.lang.OverrideOverride protected void apply(Symbolizer sym)

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

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

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

@java.lang.OverrideOverride protected void prepare(Rule rule)

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

java.lang.String toString()