org.gvsig.raster.lib.legend.api.colorinterpretation

Interface ColorInterpretation

All Superinterfaces:

java.lang.Cloneable, Observable, Observer, Persistent, WeakReferencingObservable

public interface ColorInterpretation
extends WeakReferencingObservable, Persistent, Cloneable, Observer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALPHA_BAND
static java.lang.String	ARGB
static java.lang.String	BGR
static java.lang.String	BLACK_BAND
static java.lang.String	BLUE_BAND
static java.lang.String	CMYK
static java.lang.String	CYAN_BAND
static java.lang.String	GRAY_BAND
static java.lang.String	GRAYSCALE
static java.lang.String	GREEN_BAND
static java.lang.String	HSL
static java.lang.String	HUE_BAND
static java.lang.String	LIGHTNESS_BAND
static java.lang.String	MAGENTA_BAND
static java.lang.String	PALETTE
static java.lang.String	PALETTE_BAND
static java.lang.String	RED_BAND
static java.lang.String	RGB
static java.lang.String	SATURATION_BAND
static java.lang.String	UNDEFINED_BAND
static java.lang.String	YCBCR
static java.lang.String	YCBCR_CB_BAND
static java.lang.String	YCBCR_CR_BAND
static java.lang.String	YCBCR_Y_BAND
static java.lang.String	YELLOW_BAND

Method Summary

Modifier and Type	Method and Description
void	addColorInterpretation(ColorInterpretation ci) Adds a color interpretation to this color interpretation.
void	copyFrom(ColorInterpretation colorInterpretation) Copy from the color interpretation received as parameter
java.lang.String	get(int i) Get color interpretation of band.
int	getAlphaBand()
int	getBand(java.lang.String id) Gets the band position defined with color interpretation received as parameter.
ColorTable	getPalette()
int	getPaletteBand() If there are not color table, return -1
java.lang.String[]	getValues() Gets color interpretation of all bands
boolean	hasAlphaBand()
boolean	hasAnyCMYKBand()
boolean	hasAnyColorInterpretationBand()
boolean	hasAnyGrayBand()
boolean	hasAnyHSLBand()
boolean	hasAnyPaletteBand()
boolean	hasAnyRGBBand()
boolean	hasAnyYCBCRBand()
boolean	hasInterpretation()
boolean	isAlphaInterpretation(int band)
boolean	isBGR()
boolean	isCMYK()
boolean	isColorInterpretation(int band)
boolean	isGray()
boolean	isGrayInterpretation(int band)
boolean	isHSL()
boolean	isPalette()
boolean	isPaletteInterpretation(int band)
boolean	isRGB()
boolean	isRGBA()
boolean	isUndefined() Gets if color interpretation is defined
boolean	isYCBCR()
int	length()
void	setColorInterpValue(int band, java.lang.String value) Set color interpretation value to band
void	setPalette(ColorTable colorTable) Sets the colorTable.
void	setPaletteBand(int band) Sets the band which will apply the color table

Methods inherited from interface org.gvsig.tools.observer.Observable

addObserver, deleteObserver, deleteObservers

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Methods inherited from interface org.gvsig.tools.lang.Cloneable

clone, cloneQuietly, cloneQuietly

Methods inherited from interface org.gvsig.tools.observer.Observer

update

Field Detail

RED_BAND

static final java.lang.String RED_BAND

See Also:

Constant Field Values

GREEN_BAND

static final java.lang.String GREEN_BAND

See Also:

Constant Field Values

BLUE_BAND

static final java.lang.String BLUE_BAND

See Also:

Constant Field Values

ALPHA_BAND

static final java.lang.String ALPHA_BAND

See Also:

Constant Field Values

GRAY_BAND

static final java.lang.String GRAY_BAND

See Also:

Constant Field Values

HUE_BAND

static final java.lang.String HUE_BAND

See Also:

Constant Field Values

SATURATION_BAND

static final java.lang.String SATURATION_BAND

See Also:

Constant Field Values

LIGHTNESS_BAND

static final java.lang.String LIGHTNESS_BAND

See Also:

Constant Field Values

CYAN_BAND

static final java.lang.String CYAN_BAND

See Also:

Constant Field Values

MAGENTA_BAND

static final java.lang.String MAGENTA_BAND

See Also:

Constant Field Values

YELLOW_BAND

static final java.lang.String YELLOW_BAND

See Also:

Constant Field Values

BLACK_BAND

static final java.lang.String BLACK_BAND

See Also:

Constant Field Values

YCBCR_Y_BAND

static final java.lang.String YCBCR_Y_BAND

See Also:

Constant Field Values

YCBCR_CB_BAND

static final java.lang.String YCBCR_CB_BAND

See Also:

Constant Field Values

YCBCR_CR_BAND

static final java.lang.String YCBCR_CR_BAND

See Also:

Constant Field Values

PALETTE_BAND

static final java.lang.String PALETTE_BAND

See Also:

Constant Field Values

UNDEFINED_BAND

static final java.lang.String UNDEFINED_BAND

See Also:

Constant Field Values

RGB

static final java.lang.String RGB

See Also:

Constant Field Values

BGR

static final java.lang.String BGR

See Also:

Constant Field Values

ARGB

static final java.lang.String ARGB

See Also:

Constant Field Values

GRAYSCALE

static final java.lang.String GRAYSCALE

See Also:

Constant Field Values

PALETTE

static final java.lang.String PALETTE

See Also:

Constant Field Values

HSL

static final java.lang.String HSL

See Also:

Constant Field Values

CMYK

static final java.lang.String CMYK

See Also:

Constant Field Values

YCBCR

static final java.lang.String YCBCR

See Also:

Constant Field Values

Method Detail

setColorInterpValue

void setColorInterpValue(int band,
                         java.lang.String value)

Set color interpretation value to band

Parameters:

band - Band

value - Color interpretation value

length

int length()

Returns:

Returns the number of assigned color interpretation values

hasInterpretation

boolean hasInterpretation()

Returns:

Returns true if the color values are assigned to any band of the image or the values Gray or Palette are assigned.

isBGR

boolean isBGR()

Returns:

Returns true if the color interpretation is BGR, that is, the three first bands of the image are Blue, Green and Red.

isRGB

boolean isRGB()

Returns:

Returns true if the color interpretation is RGB, that is, the three first bands of the image are Red, Green and Blue.

isRGBA

boolean isRGBA()

Returns:

Returns true if the color interpretation is ARGB, that is, the four first bands of the image are Red, Green, Blue and Alpha.

hasAnyRGBBand

boolean hasAnyRGBBand()

Returns:

Returns true if the color interpretation has at least one RED band, one GREEN band and one BLUE band.

isGray

boolean isGray()

Returns:

Returns true if the color interpretation is Gray

isHSL

boolean isHSL()

Returns:

Returns true if the color interpretation is HSL

isCMYK

boolean isCMYK()

Returns:

Returns true if the color interpretation is CMYK

isYCBCR

boolean isYCBCR()

Returns:

Returns true if the color interpretation YCBCR

isColorInterpretation

boolean isColorInterpretation(int band)

Parameters:

band -

Returns:

Returns true if the selected band has color interpretation and false otherwise

isGrayInterpretation

boolean isGrayInterpretation(int band)

Parameters:

band -

Returns:

Returns true if the selected band has gray interpretation and false otherwise

isPaletteInterpretation

boolean isPaletteInterpretation(int band)

Parameters:

band -

Returns:

Returns true if the selected band has palette interpretation and false otherwise

isAlphaInterpretation

boolean isAlphaInterpretation(int band)

Parameters:

band -

Returns:

Returns true if the selected band has alpha interpretation and false otherwise

get

java.lang.String get(int i)

Get color interpretation of band.

Parameters:

i - Number of band

Returns:

Color interpretation defined of band

getBand

int getBand(java.lang.String id)

Gets the band position defined with color interpretation received as parameter.

Parameters:

id - Color interpretation definition

Returns:

Index of band

isUndefined

boolean isUndefined()

Gets if color interpretation is defined

Returns:

True if color interpretation is defined, false if it is undefined

getValues

java.lang.String[] getValues()

Gets color interpretation of all bands

Returns:

Array with color interpretation

hasAlphaBand

boolean hasAlphaBand()

Returns:

Returns true if one band has the "Alpha" label

getAlphaBand

int getAlphaBand()

Returns:

Returns the number of band with the label "Alpha"

addColorInterpretation

void addColorInterpretation(ColorInterpretation ci)

Adds a color interpretation to this color interpretation. The result is the addition of color interpretations.

Parameters:

ci -

copyFrom

void copyFrom(ColorInterpretation colorInterpretation)

Copy from the color interpretation received as parameter

Parameters:

colorInterpretation -

hasAnyGrayBand

boolean hasAnyGrayBand()

Returns:

Returns true if the color interpretation has at least one Gray band.

hasAnyPaletteBand

boolean hasAnyPaletteBand()

Returns:

Returns true if the color interpretation has at least one Palette band.

hasAnyHSLBand

boolean hasAnyHSLBand()

Returns:

Returns true if the color interpretation has at least one HUE band, one SATURATION band or one LIGHTNESS band.

hasAnyCMYKBand

boolean hasAnyCMYKBand()

Returns:

Returns true if the color interpretation has at least one HUE band, one SATURATION band or one LIGHTNESS band.

hasAnyYCBCRBand

boolean hasAnyYCBCRBand()

Returns:

Returns true if the color interpretation has at least one YCBCR-CB band, one YCBCR-CR band or one YCBCR-Y band.

setPalette

void setPalette(ColorTable colorTable)

Sets the colorTable.

Parameters:

colorTable -

setPaletteBand

void setPaletteBand(int band)

Sets the band which will apply the color table

Parameters:

band -

getPaletteBand

int getPaletteBand()

If there are not color table, return -1

Returns:

the band in which will apply the color table

getPalette

ColorTable getPalette()

Returns:

the color table

isPalette

boolean isPalette()

Returns:

true if paletteBand and colorTable are not null.

hasAnyColorInterpretationBand

boolean hasAnyColorInterpretationBand()

Returns:

Returns true if the color interpretation has at least one Color band (not Gray, Palette nor Alpha)