ColourSpace (OpenIMAJ master project 1.3.10 API)

java.lang.Object
- java.lang.Enum<ColourSpace>
- - org.openimaj.image.colour.ColourSpace

All Implemented Interfaces:

Serializable, Comparable<ColourSpace>
```
public enum ColourSpace
extends Enum<ColourSpace>
```
Different colour space types with conversion methods.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CIE_Lab` CIE_Lab color space, using the same transform as in OpenCV, which in turn came from: http://www.cica.indiana.edu/cica/faq/color_spaces/color.spaces.html
`CIE_Lab_Norm` Normalised CIE_Lab color space, using the same transform as in OpenCV, which in turn came from: http://www.cica.indiana.edu/cica/faq/color_spaces/color.spaces.html
`CIE_Luv` CIE Luv* color space (CIE 1976).
`CIE_XYZ` CIE_XYZ color space, using the same transform as in OpenCV, which in turn came from: http://www.cica.indiana.edu/cica/faq/color_spaces/color.spaces.html
`CUSTOM` A custom (unknown) colour space
`H1H2` H1H2 colour space (two component hue)
`H1H2_2` H1H2_2 colour space (two component hue)
`H2S` H2S colour space
`H2S_2` H2S_2 colour space
`H2SV` H2SV colour space
`H2SV_2` H2SV_2 colour space
`HS` HS colour space
`HS_2` HS_2 colour space
`HSI` HSI colour space
`HSL` HSL colour space
`HSV` HSV colour space
`HSY` HSY colour space
`HUE` Hue colour space
`LUMINANCE_AVG` LUMINANCE colour space from averaging RGB
`LUMINANCE_NTSC` LUMINANCE colour space using NTSC perceptual weightings
`MODIFIED_OPPONENT` Modified Opponent colour-space as used in `vlfeat`.
`OPPONENT` Basic opponent colour-space.
`RGB` RGB colour space
`RGB_INTENSITY_NORMALISED` Intensity normalised RGB colour space using normalisation
`RGBA` RGB with alpha colour space
`SATURATION` Saturation colour space
`YUV` YUV
`YUV_Norm` Normalised YUV.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract float`	`computeIntensity(float[] colour)` Compute the intensity of the given pixel in this colourspace.
`MBFImage`	`convert(MBFImage input)` Convert the image to this colour space
`static MBFImage`	`convert(MBFImage image, ColourSpace cs)` Convert the image to the given colour space
`Float[]`	`convertFromRGB(Float[] input)` Convert the given RGB image to the current colour space
`abstract MBFImage`	`convertFromRGB(MBFImage input)` Convert the given RGB image to the current colour space
`Float[]`	`convertToRGB(Float[] input)` Convert the given RGB image to the current colour space
`abstract MBFImage`	`convertToRGB(MBFImage input)` Convert the image in this color space to RGB
`abstract int`	`getNumBands()` Get the number of bands required by this colour space
`Float[]`	`sanitise(Float[] colour)` Sanitise the given colour array to fit the colour space format.
`static ColourSpace`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ColourSpace[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - RGB
```
public static final ColourSpace RGB
```
    RGB colour space
  - HSV
```
public static final ColourSpace HSV
```
    HSV colour space
  - HSI
```
public static final ColourSpace HSI
```
    HSI colour space
  - H2SV
```
public static final ColourSpace H2SV
```
    H2SV colour space
    
    See Also:
    
    Transforms.RGB_TO_H2SV(org.openimaj.image.MBFImage)
  - H2SV_2
```
public static final ColourSpace H2SV_2
```
    H2SV_2 colour space
    
    See Also:
    
    Transforms.RGB_TO_H2SV_2(org.openimaj.image.MBFImage)
  - H2S
```
public static final ColourSpace H2S
```
    H2S colour space
    
    See Also:
    
    Transforms.RGB_TO_H2S(org.openimaj.image.MBFImage)
  - H2S_2
```
public static final ColourSpace H2S_2
```
    H2S_2 colour space
    
    See Also:
    
    Transforms.RGB_TO_H2S_2(org.openimaj.image.MBFImage)
  - LUMINANCE_AVG
```
public static final ColourSpace LUMINANCE_AVG
```
    LUMINANCE colour space from averaging RGB
  - LUMINANCE_NTSC
```
public static final ColourSpace LUMINANCE_NTSC
```
    LUMINANCE colour space using NTSC perceptual weightings
  - HUE
```
public static final ColourSpace HUE
```
    Hue colour space
  - SATURATION
```
public static final ColourSpace SATURATION
```
    Saturation colour space
  - RGB_INTENSITY_NORMALISED
```
public static final ColourSpace RGB_INTENSITY_NORMALISED
```
    Intensity normalised RGB colour space using normalisation
  - CUSTOM
```
public static final ColourSpace CUSTOM
```
    A custom (unknown) colour space
  - RGBA
```
public static final ColourSpace RGBA
```
    RGB with alpha colour space
  - HSL
```
public static final ColourSpace HSL
```
    HSL colour space
  - HSY
```
public static final ColourSpace HSY
```
    HSY colour space
  - HS
```
public static final ColourSpace HS
```
    HS colour space
  - HS_2
```
public static final ColourSpace HS_2
```
    HS_2 colour space
  - H1H2
```
public static final ColourSpace H1H2
```
    H1H2 colour space (two component hue)
    
    See Also:
    
    Transforms.H_TO_H1H2(org.openimaj.image.FImage)
  - H1H2_2
```
public static final ColourSpace H1H2_2
```
    H1H2_2 colour space (two component hue)
    
    See Also:
    
    Transforms.H_TO_H1H2_2(org.openimaj.image.FImage)
  - CIE_XYZ
```
public static final ColourSpace CIE_XYZ
```
    CIE_XYZ color space, using the same transform as in OpenCV, which in turn came from: http://www.cica.indiana.edu/cica/faq/color_spaces/color.spaces.html
  - CIE_Lab
```
public static final ColourSpace CIE_Lab
```
    CIE_Lab color space, using the same transform as in OpenCV, which in turn came from: http://www.cica.indiana.edu/cica/faq/color_spaces/color.spaces.html
    The resultant L values are in the range 0-100, and the a & b values are in -127..127 inclusive.
  - CIE_Lab_Norm
```
public static final ColourSpace CIE_Lab_Norm
```
    Normalised CIE_Lab color space, using the same transform as in OpenCV, which in turn came from: http://www.cica.indiana.edu/cica/faq/color_spaces/color.spaces.html
    The L, & b values are normalised to 0..1.
  - CIE_Luv
```
public static final ColourSpace CIE_Luv
```
    CIE L*u*v* color space (CIE 1976).
    The resultant L values are in the range 0-100, and the u & v values are in -100..100 inclusive.
  - YUV
```
public static final ColourSpace YUV
```
    YUV
    The resultant Y is in the range [0, 1]; U is [-0.436, 0.436] and V is [-0.615, 0.615].
  - YUV_Norm
```
public static final ColourSpace YUV_Norm
```
    Normalised YUV.
    Each of the Y, U and V values are in [0, 1].
  - MODIFIED_OPPONENT
```
public static final ColourSpace MODIFIED_OPPONENT
```
    Modified Opponent colour-space as used in vlfeat. Intensity is computed using the NTSC conversion. The intensity is also is added back to the other two components with a small multiplier for monochromatic regions.
    The channel order is Intensity, O1 (r-g), O2 (r + g - 2b).
  - OPPONENT
```
public static final ColourSpace OPPONENT
```
    Basic opponent colour-space. Intensity is the mean of r, g and b.
    The channel order is Intensity, O1 (r-g), O2 (r + g - 2b).
- Method Detail
  - values
```
public static ColourSpace[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ColourSpace c : ColourSpace.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ColourSpace valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - convertFromRGB
```
public abstract MBFImage convertFromRGB(MBFImage input)
```
    Convert the given RGB image to the current colour space
    
    Parameters:
    
    input - RGB image
    
    Returns:
    
    image in the current colour space
  - convertFromRGB
```
public Float[] convertFromRGB(Float[] input)
```
    Convert the given RGB image to the current colour space
    
    Parameters:
    
    input - RGB image
    
    Returns:
    
    image in the current colour space
  - convertToRGB
```
public Float[] convertToRGB(Float[] input)
```
    Convert the given RGB image to the current colour space
    
    Parameters:
    
    input - RGB image
    
    Returns:
    
    image in the current colour space
  - convertToRGB
```
public abstract MBFImage convertToRGB(MBFImage input)
```
    Convert the image in this color space to RGB
    
    Parameters:
    
    input - image in this colour space
    
    Returns:
    
    RGB image
  - convert
```
public MBFImage convert(MBFImage input)
```
    Convert the image to this colour space
    
    Parameters:
    
    input - an image
    
    Returns:
    
    image in this colour space
  - convert
```
public static MBFImage convert(MBFImage image,
                               ColourSpace cs)
```
    Convert the image to the given colour space
    
    Parameters:
    
    image - the image
    
    cs - the target colour space
    
    Returns:
    
    the converted image
  - getNumBands
```
public abstract int getNumBands()
```
    Get the number of bands required by this colour space
    
    Returns:
    
    the number of bands
  - computeIntensity
```
public abstract float computeIntensity(float[] colour)
```
    Compute the intensity of the given pixel in this colourspace. In colourspaces where intensity cannot be calculated, this should just return 0.
    
    Parameters:
    
    colour - the colour to extract the intensity from
    
    Returns:
    
    the number of bands
  - sanitise
```
public Float[] sanitise(Float[] colour)
```
    Sanitise the given colour array to fit the colour space format. It uses a number of heuristics that are as follows: - if the colour has the same or more bands than the colour space, then the colour is returned unchanged. - if the colour has just one band, then it is duplicated by the same number of bands as required by the colour space - otherwise, the colour is duplicated and padded with 1s. Example: RGBA colour space, RGB colour [1.0, 0.2, 0.4] the result will be padded with 1s: [1.0, 0.2, 0.4, 1] Example: HSV colour space, single band colour [0.3] the result will be duplicated: [0.3, 0.3, 0.3]
    
    Parameters:
    
    colour - The colour to sanitise
    
    Returns:
    
    The sanitised colour

Enum ColourSpace

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

RGB

HSV

HSI

H2SV

H2SV_2

H2S

H2S_2

LUMINANCE_AVG

LUMINANCE_NTSC

HUE

SATURATION

RGB_INTENSITY_NORMALISED

CUSTOM

RGBA

HSL

HSY

HS

HS_2

H1H2

H1H2_2

CIE_XYZ

CIE_Lab

CIE_Lab_Norm

CIE_Luv

YUV

YUV_Norm

MODIFIED_OPPONENT

OPPONENT

Method Detail

values

valueOf

convertFromRGB

convertFromRGB

convertToRGB

convertToRGB

convert

convert

getNumBands

computeIntensity

sanitise