cz.cuni.jagrlib.piece
Class ImageCompute

java.lang.Object
  extended by cz.cuni.jagrlib.DefaultProperty
      extended by cz.cuni.jagrlib.Piece
          extended by cz.cuni.jagrlib.piece.ImageCompute
All Implemented Interfaces:
Breakable, Property, Trigger, Template

public class ImageCompute
extends Piece
implements Trigger

Image filter - general image composition.

Since:
0.25
See Also:
ImageCompute.java

Field Summary
protected static java.lang.String CATEGORY
          Object category.
protected  boolean clamp
          Use 0.0-1.0 clamping?
static java.lang.String CLAMPING
           
static java.lang.String CONST_X
           
static java.lang.String CONST_Y
           
protected  double constX
          Floating-point constant x.
protected  double constY
          Floating-point constant y.
static java.lang.String[] cVars
          Input constant names.
protected  java.lang.String expr
          Sequence of JEP expressions (separated by newline character) defining color of output pixel.
static java.lang.String EXPRESSIONS
           
static java.lang.String[][] iVars
          Input variable names.
static int MAX_INPUT
          Maximum number of input raster images.
static java.lang.String[] oVars
          Output variable names ("r" is used for gray value as well).
static RegPiece reg
          Static registration instance for this class.
protected static java.lang.String TEMPLATE_NAME
          Object template identifier.
 
Fields inherited from class cz.cuni.jagrlib.Piece
channels, info, pl, plugs, TEMPLATE_TYPE, userBreak
 
Fields inherited from interface cz.cuni.jagrlib.iface.Property
LOGGING, STATISTICS, TEXT_DESCRIPTION
 
Fields inherited from interface cz.cuni.jagrlib.Template
ALL_PLUGS, C_1D, C_2D, C_3D, C_ALPHA, C_BINARY, C_BREP, C_CAMERA, C_CIRCLE, C_CLIP, C_COMPRESSION, C_CURVE, C_DATA, C_DRAW, C_EDITOR, C_ELLIPSE, C_FILL, C_FILTER, C_FLOAT, C_FUNCTION, C_IMAGE, C_INTEGER, C_IO, C_LIGHT, C_LINE, C_METRIC, C_POLYGON, C_PROJECTION, C_RADIOSITY, C_RASTER, C_RENDER, C_SAMPLE, C_SCENE, C_SET, C_SOLID, C_TEXT, C_TRANSFORM, C_VECTOR, C_VIEWER, C_WORKER, CAT_EMPTY, EMPTY, IFACE, JAGRLIB, JAGRLIB2, MANIPULATOR_COMBO, MANIPULATOR_CUSTOM, MANIPULATOR_DEFAULT, MANIPULATOR_MULTILINE, PL_ALPHAMASK, PL_BITMASK, PL_CAUSTIC, PL_CODEC, PL_COLORMAP, PL_COMPARE, PL_DATA, PL_DIRECT, PL_EDITOR, PL_FILTER, PL_FUNCTION, PL_IMAGE, PL_IMPORT, PL_INPUT, PL_INTERSECTION, PL_LIGHTSOURCE, PL_ORDER, PL_OUTPUT, PL_PALETTE, PL_PHOTON, PL_PROPERTY, PL_QUANTIZER, PL_RASTER, PL_RENDER, PL_SHADOW, PL_STREAM, PL_TRANSFORM, PL_TRIGGER, PL_VOLUME, PL_WINDOW, TYPE_BOOLEAN, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INTEGER, TYPE_LONG, TYPE_OBJECT, TYPE_STRING
 
Constructor Summary
ImageCompute()
           
 
Method Summary
 boolean fire(int type)
          Starts image transformation.
 java.lang.Object get(java.lang.String key)
          Gets the given property.
 void set(java.lang.String key, java.lang.Object value)
          Sets the given property.
static int setTemplate(Template t, int ord)
          General-purpose registration routine.
 
Methods inherited from class cz.cuni.jagrlib.Piece
className, connect, findPlug, findPlug, getInfo, getInterface, getInterface, getPlug, getReg, init, isCompatible, isCompatible, isConnected, logError, logWarning, myInterface, newInputPlug, newOptOutputPlug, newOutputPlug, newPlug, noTemplates, propBegin, propBounds, propDefault, propEnd, propEnum, propManipulator, propManipulator, setProgressListener, setRegStrings, setTemplateDynamic, stop
 
Methods inherited from class cz.cuni.jagrlib.DefaultProperty
booleanProperty, booleanProperty, colorDoubleProperty, colorProperty, commit, doubleProperty, doubleProperty, doubleProperty, enumProperty, floatProperty, floatProperty, floatProperty, intProperty, intProperty, intProperty, longProperty, longProperty, longProperty, set, stringProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface cz.cuni.jagrlib.iface.Property
commit
 
Methods inherited from interface cz.cuni.jagrlib.Breakable
setProgressListener, stop
 

Field Detail

MAX_INPUT

public static final int MAX_INPUT
Maximum number of input raster images.

See Also:
Constant Field Values

iVars

public static final java.lang.String[][] iVars
Input variable names.


oVars

public static final java.lang.String[] oVars
Output variable names ("r" is used for gray value as well).


cVars

public static final java.lang.String[] cVars
Input constant names.


constX

protected double constX
Floating-point constant x.


constY

protected double constY
Floating-point constant y.


clamp

protected boolean clamp
Use 0.0-1.0 clamping?


expr

protected java.lang.String expr
Sequence of JEP expressions (separated by newline character) defining color of output pixel.

Input values: r1, g1, b1, a1, r2, g2, etc.

Output pixel: r, g, b, a


CONST_X

public static final java.lang.String CONST_X
See Also:
Constant Field Values

CONST_Y

public static final java.lang.String CONST_Y
See Also:
Constant Field Values

CLAMPING

public static final java.lang.String CLAMPING
See Also:
Constant Field Values

EXPRESSIONS

public static final java.lang.String EXPRESSIONS
See Also:
Constant Field Values

TEMPLATE_NAME

protected static final java.lang.String TEMPLATE_NAME
Object template identifier.

See Also:
Constant Field Values

CATEGORY

protected static final java.lang.String CATEGORY
Object category.

See Also:
Constant Field Values

reg

public static final RegPiece reg
Static registration instance for this class. Automatically initialized in class-loading time.

Constructor Detail

ImageCompute

public ImageCompute()
Method Detail

fire

public boolean fire(int type)
Starts image transformation.

Specified by:
fire in interface Trigger
Parameters:
type - The action type (whatever it means..).
Returns:
true if the action was successful.

set

public void set(java.lang.String key,
                java.lang.Object value)
Sets the given property.

Specified by:
set in interface Property
Overrides:
set in class DefaultProperty
Parameters:
key - Key string.
value - The new value.
See Also:
Property.commit()

get

public java.lang.Object get(java.lang.String key)
Gets the given property.

Specified by:
get in interface Property
Overrides:
get in class DefaultProperty
Parameters:
key - Key string.
Returns:
The actual value or null.

setTemplate

public static int setTemplate(Template t,
                              int ord)
General-purpose registration routine. Sets all plugs, strings, etc. to the given Template.