org.lsst.ccs.utilities.image.patterns

Class PatternGeneratorFactory

java.lang.Object

org.lsst.ccs.utilities.image.patterns.PatternGeneratorFactory

public class PatternGeneratorFactory
extends Object

A factory to generate patterns.

Author:

turri

Constructor Summary

Constructors

Constructor and Description
PatternGeneratorFactory()

Method Summary

Modifier and Type	Method and Description
static PatternGenerator	createPatternGenerator(String name) Creates a new PatternGenerator for the given name.
static void	exposeGeometryToGeneratedImage(Geometry<?> geometry, GeneratedImage generatedImage) Expose a Geometry object to a generated image.
static GeneratedImage	generateImageForGeometry(Geometry<?> geometry, String imagePattern, Map<String,String> params) Generate a simulated image for the given Geometry.
static Set<String>	listAvailablePatterns() List the patterns that are available for generating the Image.

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternGeneratorFactory

public PatternGeneratorFactory()

Method Detail

listAvailablePatterns

public static Set<String> listAvailablePatterns()

List the patterns that are available for generating the Image.

Returns:

The Set of the available patterns.

createPatternGenerator

public static PatternGenerator createPatternGenerator(String name)

Creates a new PatternGenerator for the given name. This method returns a new instance of a PatternGenerator so that different instances can be used on separate threads. A RuntimeException will be thrown if an instance of the given PatternGenerator cannot be instanced.

Parameters:

name - The name of the PatternGenerator.

Returns:

The desired PatternGenerator.

generateImageForGeometry

public static GeneratedImage generateImageForGeometry(Geometry<?> geometry,
                                                      String imagePattern,
                                                      Map<String,String> params)

Generate a simulated image for the given Geometry.

Parameters:

geometry - The Geometry for which to simulate an image

imagePattern - The simulated image pattern

params - The parameters for the simulated image.

Returns:

exposeGeometryToGeneratedImage

public static void exposeGeometryToGeneratedImage(Geometry<?> geometry,
                                                  GeneratedImage generatedImage)

Expose a Geometry object to a generated image. Internally the object's geometry is scanned to look for objects that can be exposed to images (ImageSensitiveArea).

Parameters:

geometry - The Geometry to be exposed

generatedImage -