cz.cuni.jagrlib.piece
Class ImageCrop

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

public class ImageCrop
extends Piece
implements Trigger

Image cropping & scaling. Preserves pixel format (except for RasterGraphics.MODE_COLORMAP which is converted into RasterGraphics.MODE_RGB).

Since:
0.25
See Also:
ImageCrop.java

Nested Class Summary
protected static class ImageCrop.ResamplingType
          Resampling types.
 
Field Summary
protected static java.lang.String CATEGORY
          Object category.
protected  int height
          Crop area height in pixels (0 for input image height).
static java.lang.String HEIGHT
           
static java.lang.String OUT_HEIGHT
           
static java.lang.String OUT_WIDTH
           
protected  int outHeight
          Target image height in pixels (0 for crop area height).
protected  int outWidth
          Target image width in pixels (0 for crop area width).
static RegPiece reg
          Static registration instance for this class.
protected  ImageCrop.ResamplingType resampling
          Actual resampling type.
static java.lang.String RESAMPLING
           
protected static java.lang.String TEMPLATE_NAME
          Object template identifier.
protected  int width
          Crop area width in pixels (0 for input image width).
static java.lang.String WIDTH
           
protected  int x0
          X coordinate of upper left corner of the crop area.
static java.lang.String X0
           
protected  int y0
          Y coordinate of upper left corner of the crop area.
static java.lang.String Y0
           
 
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
ImageCrop()
           
 
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

x0

protected int x0
X coordinate of upper left corner of the crop area.


y0

protected int y0
Y coordinate of upper left corner of the crop area.


width

protected int width
Crop area width in pixels (0 for input image width).


height

protected int height
Crop area height in pixels (0 for input image height).


outWidth

protected int outWidth
Target image width in pixels (0 for crop area width).


outHeight

protected int outHeight
Target image height in pixels (0 for crop area height).


resampling

protected ImageCrop.ResamplingType resampling
Actual resampling type.


X0

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

Y0

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

WIDTH

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

HEIGHT

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

OUT_WIDTH

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

OUT_HEIGHT

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

RESAMPLING

public static final java.lang.String RESAMPLING
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

ImageCrop

public ImageCrop()
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.