RGBImageProfile (SNAP Engine API)

java.lang.Object
- org.esa.snap.core.datamodel.RGBImageProfile

All Implemented Interfaces:

com.bc.ceres.core.runtime.ConfigurableExtension
```
public class RGBImageProfile
extends Object
implements com.bc.ceres.core.runtime.ConfigurableExtension
```
A profile used for the creation of RGB images. The profile comprises the band arithmetic expressions for the computation of red, green, blue and alpha (optional) channels of the resulting image.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALPHA_BAND_NAME` The default name for the band providing input for the alpha image channel.
`static String`	`BLUE_BAND_NAME` The default name for the band providing input for the blue image channel.
`static String`	`FILENAME_EXTENSION`
`static String`	`GREEN_BAND_NAME` The default name for the band providing input for the green image channel.
`static String`	`PROPERTY_KEY_ALPHA`
`static String`	`PROPERTY_KEY_BLUE`
`static String`	`PROPERTY_KEY_GREEN`
`static String`	`PROPERTY_KEY_INTERNAL`
`static String`	`PROPERTY_KEY_NAME`
`static String`	`PROPERTY_KEY_PREFIX_RGB_PROFILE` Preferences key for RGB profile entries
`static String`	`PROPERTY_KEY_RED`
`static String`	`RED_BAND_NAME` The default name for the band providing input for the red image channel.
`static String[]`	`RGB_BAND_NAMES` An array of 3 strings containing the names for the default red, green and blue bands.
`static String[]`	`RGBA_BAND_NAMES` An array of 4 strings containing the names for the default red, green, blue and alpha bands.

Constructor Summary

Constructors
Constructor and Description
`RGBImageProfile(String name, String[] rgbaExpressions)`
`RGBImageProfile(String name, String[] rgbaExpressions, String[] pattern)`
`RGBImageProfile(String name, String[] rgbaExpressions, String[] pattern, Range[] valueRanges)` Creates a new RGB profile.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`configure(com.bc.ceres.core.runtime.ConfigurationElement config)` Deprecated. Not in use anymore. Was used in BEAM. Might be removed in the future. Deprecated since SNAP 9.
`boolean`	`equalExpressions(RGBImageProfile profile)`
`boolean`	`equalExpressions(String[] rgbaExpressions)` Deprecated.
`boolean`	`equals(Object obj)`
`String`	`getAlphaExpression()`
`String`	`getBlueExpression()`
`Range`	`getBlueMinMax()`
`static RGBImageProfile`	`getCurrentProfile(Product product)`
`String`	`getGreenExpression()`
`Range`	`getGreenMinMax()`
`String`	`getName()`
`String[]`	`getPattern()`
`void`	`getProperties(Properties properties)` Sets profile properties and accordingly sets them in the given property map.
`String`	`getRedExpression()`
`Range`	`getRedMinMax()`
`String[]`	`getRgbaExpressions()`
`RGBChannelDef`	`getRgbChannelDef()`
`String[]`	`getRgbExpressions()`
`boolean`	`hasAlpha()`
`int`	`hashCode()`
`boolean`	`isApplicableTo(Product product)` Tests whether this profile is applicable to the given product.
`boolean`	`isInternal()`
`boolean`	`isValid()` Tests if one of the R,G,B expressions are non-empty strings.
`static RGBImageProfile`	`loadProfile(File file)` Loads a profile from the given file using the Java properties file format
`static RGBImageProfile`	`loadProfile(URL url)` Loads a profile from the given url using the Java properties file format
`void`	`setAlphaExpression(String expression)`
`void`	`setBlueExpression(String expression)`
`void`	`setBlueMinMax(Range range)`
`void`	`setGreenExpression(String expression)`
`void`	`setGreenMinMax(Range range)`
`void`	`setInternal(boolean internal)`
`void`	`setName(String name)`
`void`	`setPattern(String[] pattern)`
`void`	`setProperties(Properties properties)` Sets profile properties from the given property map.
`void`	`setRedExpression(String expression)`
`void`	`setRedMinMax(Range range)`
`void`	`setRgbaExpressions(String[] rgbaExpressions)`
`void`	`setRgbExpressions(String[] rgbExpressions)`
`void`	`store(File file)` Stores this profile in the given file using the Java properties file format
`static void`	`storeRgbaExpressions(Product product, String[] rgbaExpressions)`
`static void`	`storeRgbaExpressions(Product product, String[] rgbaExpressions, String[] bandNames)`
`String`	`toString()`

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

- Field Detail
  - RED_BAND_NAME
```
public static final String RED_BAND_NAME
```
    The default name for the band providing input for the red image channel.
    
    See Also:
    
    Constant Field Values
  - GREEN_BAND_NAME
```
public static final String GREEN_BAND_NAME
```
    The default name for the band providing input for the green image channel.
    
    See Also:
    
    Constant Field Values
  - BLUE_BAND_NAME
```
public static final String BLUE_BAND_NAME
```
    The default name for the band providing input for the blue image channel.
    
    See Also:
    
    Constant Field Values
  - ALPHA_BAND_NAME
```
public static final String ALPHA_BAND_NAME
```
    The default name for the band providing input for the alpha image channel.
    
    See Also:
    
    Constant Field Values
  - RGB_BAND_NAMES
```
public static final String[] RGB_BAND_NAMES
```
    An array of 3 strings containing the names for the default red, green and blue bands.
  - RGBA_BAND_NAMES
```
public static final String[] RGBA_BAND_NAMES
```
    An array of 4 strings containing the names for the default red, green, blue and alpha bands.
  - FILENAME_EXTENSION
```
public static final String FILENAME_EXTENSION
```
    See Also:
    
    Constant Field Values
  - PROPERTY_KEY_NAME
```
public static final String PROPERTY_KEY_NAME
```
    See Also:
    
    Constant Field Values
  - PROPERTY_KEY_RED
```
public static final String PROPERTY_KEY_RED
```
    See Also:
    
    Constant Field Values
  - PROPERTY_KEY_GREEN
```
public static final String PROPERTY_KEY_GREEN
```
    See Also:
    
    Constant Field Values
  - PROPERTY_KEY_BLUE
```
public static final String PROPERTY_KEY_BLUE
```
    See Also:
    
    Constant Field Values
  - PROPERTY_KEY_ALPHA
```
public static final String PROPERTY_KEY_ALPHA
```
    See Also:
    
    Constant Field Values
  - PROPERTY_KEY_INTERNAL
```
public static final String PROPERTY_KEY_INTERNAL
```
    See Also:
    
    Constant Field Values
  - PROPERTY_KEY_PREFIX_RGB_PROFILE
```
public static final String PROPERTY_KEY_PREFIX_RGB_PROFILE
```
    Preferences key for RGB profile entries
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RGBImageProfile
```
public RGBImageProfile(String name,
                       String[] rgbaExpressions)
```
  - RGBImageProfile
```
public RGBImageProfile(String name,
                       String[] rgbaExpressions,
                       String[] pattern)
```
  - RGBImageProfile
```
public RGBImageProfile(String name,
                       String[] rgbaExpressions,
                       String[] pattern,
                       Range[] valueRanges)
```
    Creates a new RGB profile. In the pattern you can simply use '*' for a sequence of characters or use '?' for a single character. For Example: new String[]{ "MER_*_2*", "MER_*_2*", ""}
    
    Parameters:
    
    name - The name of the profile
    
    rgbaExpressions - the expressions for the RGBA channels. Only RGB expressions are mandatory, the one for the alpha channel can be missing
    
    pattern - Pattern to check if this profile can be applied to a certain product. Three patterns need to be provided. 1. Will be matched against the product type 2. Will be matched against the product name 3. Will be matched against the description of the product
- Method Detail
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getRgbChannelDef
```
public RGBChannelDef getRgbChannelDef()
```
  - isInternal
```
public boolean isInternal()
```
  - setInternal
```
public void setInternal(boolean internal)
```
  - equalExpressions
```
public boolean equalExpressions(RGBImageProfile profile)
```
  - equalExpressions
```
@Deprecated
public boolean equalExpressions(String[] rgbaExpressions)
```
    Deprecated.
    
    This API function exposes internal structure. please use equalExpressions(RGBImageProfile profile)
  - isValid
```
public boolean isValid()
```
    Tests if one of the R,G,B expressions are non-empty strings.
    
    Returns:
    
    true, if so
  - getRgbExpressions
```
public String[] getRgbExpressions()
```
  - setRgbExpressions
```
public void setRgbExpressions(String[] rgbExpressions)
```
  - getRgbaExpressions
```
public String[] getRgbaExpressions()
```
  - setRgbaExpressions
```
public void setRgbaExpressions(String[] rgbaExpressions)
```
  - getRedExpression
```
public String getRedExpression()
```
  - setRedExpression
```
public void setRedExpression(String expression)
```
  - getGreenExpression
```
public String getGreenExpression()
```
  - setGreenExpression
```
public void setGreenExpression(String expression)
```
  - getBlueExpression
```
public String getBlueExpression()
```
  - setBlueExpression
```
public void setBlueExpression(String expression)
```
  - getAlphaExpression
```
public String getAlphaExpression()
```
  - setAlphaExpression
```
public void setAlphaExpression(String expression)
```
  - hasAlpha
```
public boolean hasAlpha()
```
  - getPattern
```
public String[] getPattern()
```
  - setPattern
```
public void setPattern(String[] pattern)
```
  - isApplicableTo
```
public boolean isApplicableTo(Product product)
```
    Tests whether this profile is applicable to the given product. With other words, the method tests if an RGB image can be created from the given product.
    
    Parameters:
    
    product - the product
    
    Returns:
    
    true, if so
  - getCurrentProfile
```
public static RGBImageProfile getCurrentProfile(Product product)
```
  - loadProfile
```
public static RGBImageProfile loadProfile(File file)
                                   throws IOException
```
    Loads a profile from the given file using the Java properties file format
    
    Parameters:
    
    file - the file
    
    Returns:
    
    the profile, never null
    
    Throws:
    
    IOException - if an I/O error occurs
    
    See Also:
    
    setProperties(java.util.Properties)
  - loadProfile
```
public static RGBImageProfile loadProfile(URL url)
                                   throws IOException
```
    Loads a profile from the given url using the Java properties file format
    
    Parameters:
    
    url - the url
    
    Returns:
    
    the profile, never null
    
    Throws:
    
    IOException - if an I/O error occurs
    
    See Also:
    
    setProperties(java.util.Properties)
  - store
```
public void store(File file)
           throws IOException
```
    Stores this profile in the given file using the Java properties file format
    
    Parameters:
    
    file - the file
    
    Throws:
    
    IOException - if an I/O error occurs
    
    See Also:
    
    getProperties(java.util.Properties)
  - getProperties
```
public void getProperties(Properties properties)
```
    Sets profile properties and accordingly sets them in the given property map.
    
    Parameters:
    
    properties - the property map which receives the properties of this profiles
  - setProperties
```
public void setProperties(Properties properties)
```
    Sets profile properties from the given property map.
    
    Parameters:
    
    properties - the property map which provides the properties for this profiles
  - storeRgbaExpressions
```
public static void storeRgbaExpressions(Product product,
                                        String[] rgbaExpressions)
```
  - storeRgbaExpressions
```
public static void storeRgbaExpressions(Product product,
                                        String[] rgbaExpressions,
                                        String[] bandNames)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - configure
```
@Deprecated
public void configure(com.bc.ceres.core.runtime.ConfigurationElement config)
                           throws CoreException
```
    Deprecated. Not in use anymore. Was used in BEAM. Might be removed in the future. Deprecated since SNAP 9.
    
    Description copied from interface: com.bc.ceres.core.runtime.ConfigurableExtension
    
    Configures this extension with the supplied configuration data.
    
    Specified by:
    
    configure in interface com.bc.ceres.core.runtime.ConfigurableExtension
    
    Parameters:
    
    config - The configuration data.
    
    Throws:
    
    CoreException - if an error occurred during configuration.
  - setRedMinMax
```
public void setRedMinMax(Range range)
```
  - getRedMinMax
```
public Range getRedMinMax()
```
  - setGreenMinMax
```
public void setGreenMinMax(Range range)
```
  - getGreenMinMax
```
public Range getGreenMinMax()
```
  - setBlueMinMax
```
public void setBlueMinMax(Range range)
```
  - getBlueMinMax
```
public Range getBlueMinMax()
```

Class RGBImageProfile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RED_BAND_NAME

GREEN_BAND_NAME

BLUE_BAND_NAME

ALPHA_BAND_NAME

RGB_BAND_NAMES

RGBA_BAND_NAMES

FILENAME_EXTENSION

PROPERTY_KEY_NAME

PROPERTY_KEY_RED

PROPERTY_KEY_GREEN

PROPERTY_KEY_BLUE

PROPERTY_KEY_ALPHA

PROPERTY_KEY_INTERNAL

PROPERTY_KEY_PREFIX_RGB_PROFILE

Constructor Detail

RGBImageProfile

RGBImageProfile

RGBImageProfile

Method Detail

getName

setName

getRgbChannelDef

isInternal

setInternal

equalExpressions

equalExpressions

isValid

getRgbExpressions

setRgbExpressions

getRgbaExpressions

setRgbaExpressions

getRedExpression

setRedExpression

getGreenExpression

setGreenExpression

getBlueExpression

setBlueExpression

getAlphaExpression

setAlphaExpression

hasAlpha

getPattern

setPattern

isApplicableTo

getCurrentProfile

loadProfile

loadProfile

store

getProperties

setProperties

storeRgbaExpressions

storeRgbaExpressions

hashCode

equals

toString

configure

setRedMinMax

getRedMinMax

setGreenMinMax

getGreenMinMax

setBlueMinMax

getBlueMinMax