Band (Groovy Documentation)

geoscript.layer.Band

A Band of Raster Data that represents a single band/channel/layer.
Authors:
Jared Erickson

Properties Summary

Properties
Type	Name and description
`SampleDimension`	`dim` The wrapped GeoTools SampleDimension

Constructor Summary

Constructors
Constructor and description
`Band (SampleDimension dim)` Create a new Band wrapping a GeoTools SampleDimension
`Band (java.lang.String description, double min, double max)` Create a new Band with minimum and maximum values
`Band (java.lang.String description, double min, double max, double noValue)` Create a new Band with minimum, maximum, and no data values

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static Band.Builder`	`builder()` Create a new Band Builder
	`double`	`getMax()` Get the maximum value
	`double`	`getMin()` Get the minimum value
	`java.util.List<java.lang.Double>`	`getNoData()` Get a List of no data values
	`double`	`getOffset()` Get the offset
	`double`	`getScale()` Get the scale
	`java.lang.String`	`getType()` Get the type of data
	`Unit`	`getUnit()` Get the unit information
	`boolean`	`isNoData(double value)` Check whether the value is a NODATA value
	`java.lang.String`	`toString()` Get the string representation

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`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
  - SampleDimension dim
    
    The wrapped GeoTools SampleDimension
- Constructor Detail
  - Band(SampleDimension dim)
    
    Create a new Band wrapping a GeoTools SampleDimension
    Parameters:
    dim - The wrapped GeoTools SampleDimension
  - Band(java.lang.String description, double min, double max)
    
    Create a new Band with minimum and maximum values
    Parameters:
    description - The Band's description
    min - The minimum value
    max - The maximum value
  - Band(java.lang.String description, double min, double max, double noValue)
    
    Create a new Band with minimum, maximum, and no data values
    Parameters:
    description - The Band's description
    min - The minimum value
    max - The maximum value
    noValue - The no data value
- Method Detail
  - static Band.Builder builder()
    
    Create a new Band Builder
    Returns:
    A new Band Builder
  - double getMax()
    
    Get the maximum value
    Returns:
    The maximum value
  - double getMin()
    
    Get the minimum value
    Returns:
    The minimum value
  - java.util.List<java.lang.Double> getNoData()
    
    Get a List of no data values
    Returns:
    The List of no data values
  - double getOffset()
    
    Get the offset
    Returns:
    The offset
  - double getScale()
    
    Get the scale
    Returns:
    The scale
  - java.lang.String getType()
    
    Get the type of data
    Returns:
    The type of data
  - Unit getUnit()
    
    Get the unit information
    Returns:
    The unit information
  - boolean isNoData(double value)
    
    Check whether the value is a NODATA value
    Parameters:
    value - The value
    Returns:
    Whether the value is a NODATA value
  - @java.lang.Override java.lang.String toString()
    
    Get the string representation
    Returns:
    The string representation

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Band

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

SampleDimension dim

Constructor Detail

Band(SampleDimension dim)

Band(java.lang.String description, double min, double max)

Band(java.lang.String description, double min, double max, double noValue)

Method Detail

static Band.Builder builder()

double getMax()

double getMin()

java.util.List<java.lang.Double> getNoData()

double getOffset()

double getScale()

java.lang.String getType()

Unit getUnit()

boolean isNoData(double value)

@java.lang.Override java.lang.String toString()