com.luciad.imaging.operator

LuciadLightspeedClass TLcdBandSelectOp

java.lang.Object

com.luciad.imaging.operator.ALcdImageOperator

com.luciad.imaging.operator.TLcdBandSelectOp

public final class TLcdBandSelectOp
extends ALcdImageOperator

Extracts a subset of the color bands of an image and/or reorders the bands.

For color data the bands should generally not be re-ordered. Otherwise they may or may not be interpreted as a color anymore. See here for details.

Example

   // Using the static method:
   ALcdImage inputImage = ...;
   int[] bands = new int[]{0};
   ALcdImage outputImage = TLcdBandSelectOp.bandSelect(inputImage, bands);

   // Using a data object:
   ALcdImage inputImage = ...;
   int[] bands = new int[]{0};
   TLcdBandSelectOp op = new TLcdBandSelectOp();
   ILcdDataObject params = op.getParameterDataType().newInstance();
   params.setValue(TLcdBandSelectOp.INPUT_IMAGE, inputImage);
   params.setValue(TLcdBandSelectOp.INPUT_BANDS, bands);
   ALcdImage outputImage = op.apply(params);
 

Input

Output

Since:

2014.0

Nested Class Summary

Nested classes/interfaces inherited from class com.luciad.imaging.operator.ALcdImageOperator

ALcdImageOperator.ImageOperatorTypeBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static TLcdDataType	BAND_SELECT_FILTER_TYPE Input data type of the operator.
static TLcdDataProperty	INPUT_BANDS The indices of the bands to be retained, in the order in which they are to appear in the output.
static TLcdDataProperty	INPUT_IMAGE The input image.
static String	NAME Name of the operator.

Fields inherited from class com.luciad.imaging.operator.ALcdImageOperator

INPUT_IMAGE_NAME

Constructor Summary

Constructors

Constructor and Description
TLcdBandSelectOp() Default constructor.

Method Summary

Modifier and Type	Method and Description
ALcdImage	apply(ILcdDataObject aParameters) Applies this operator to the given input parameters.
static ALcdImage	bandSelect(ALcdImage aSource, int[] aBands) Extracts a subset of the bands from the given image and/or reorders the bands.

Methods inherited from class com.luciad.imaging.operator.ALcdImageOperator

createTypeBuilder, createTypeBuilder, equals, getParameterDataType, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAME

public static final String NAME

Name of the operator.

See Also:

Constant Field Values

INPUT_IMAGE

public static final TLcdDataProperty INPUT_IMAGE

The input image.

INPUT_BANDS

public static final TLcdDataProperty INPUT_BANDS

The indices of the bands to be retained, in the order in which they are to appear in the output.

BAND_SELECT_FILTER_TYPE

public static final TLcdDataType BAND_SELECT_FILTER_TYPE

Input data type of the operator.

Constructor Detail

TLcdBandSelectOp

public TLcdBandSelectOp()

Default constructor.

Method Detail

apply

public ALcdImage apply(ILcdDataObject aParameters)

Description copied from class: ALcdImageOperator

Applies this operator to the given input parameters. The parameters are stored in a data object which must be of the type given by ALcdImageOperator.getParameterDataType().

Specified by:

apply in class ALcdImageOperator

Parameters:

aParameters - the parameters for the operator

Returns:

the image produced by the operator

bandSelect

public static ALcdImage bandSelect(ALcdImage aSource,
                                   int[] aBands)

Extracts a subset of the bands from the given image and/or reorders the bands.

Parameters:

aSource - the image to be processed

aBands - the indices of the bands to be retained, in the order in which they are to appear in the output

Returns:

image containing only the specified bands of the source image