org.lsst.ccs.utilities.image.patterns

Class PatternGenerator

java.lang.Object

org.lsst.ccs.utilities.image.patterns.PatternGenerator

Direct Known Subclasses:

CheckeredPatternGenerator, ImagePatternGenerator, NoisePatternGenerator, RipplesPatternGenerator

public abstract class PatternGenerator
extends Object

The base class for an Image pattern generator. A subclass must provide an empty constructor in order for the PatternGeneratorFactory to work. This is so that we can create a new instance of a pattern generation on different threads, ensuring its thread safety. Pattern generation parameters are passed as maps when the image is generated.

Author:

turri

Method Summary

Modifier and Type	Method and Description
abstract GeneratedImage	generateImage(int width, int height, Map<String,String> parameters) Generate a GeneratedImage with the provided width and height.
static BufferedImage	getBufferedImageFromRaster(WritableRaster r)
protected double	getDoubleParameter(String parName, Map<String,String> parameters, double defaultValue)
protected int	getIntParameter(String parName, Map<String,String> parameters, int defaultValue)
String	getName() The name of the pattern.
protected String	getParameter(String parName, Map<String,String> parameters)
protected String	getStringParameter(String parName, Map<String,String> parameters, String defaultValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public String getName()

The name of the pattern. It will be used to select the pattern to generate.

Returns:

The name of the pattern.

generateImage

public abstract GeneratedImage generateImage(int width,
                                             int height,
                                             Map<String,String> parameters)

Generate a GeneratedImage with the provided width and height. The generated pattern is affected by the provided parameters. Refer to the subclasses API for more information about the available parameter. By convention the parameters start with the name of the PatternGenerator.

Parameters:

width - The image width

height - The image

parameters - The parameters to be used to generate the image.

Returns:

The generated GeneratedImage

getParameter

protected String getParameter(String parName,
                              Map<String,String> parameters)

getDoubleParameter

protected double getDoubleParameter(String parName,
                                    Map<String,String> parameters,
                                    double defaultValue)

getIntParameter

protected int getIntParameter(String parName,
                              Map<String,String> parameters,
                              int defaultValue)

getStringParameter

protected String getStringParameter(String parName,
                                    Map<String,String> parameters,
                                    String defaultValue)

getBufferedImageFromRaster

public static BufferedImage getBufferedImageFromRaster(WritableRaster r)