ptolemy.actor.lib.jai
Class JAIRotate

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.InstantiableNamedObj
          ptolemy.kernel.Entity
              ptolemy.kernel.ComponentEntity
                  ptolemy.actor.AtomicActor
                      ptolemy.actor.TypedAtomicActor
                          ptolemy.actor.lib.Transformer
                              ptolemy.actor.lib.jai.JAIRotate

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class JAIRotate
extends Transformer

Rotate an image around a given point. The amount of rotation is in degrees. If the output is displayed, the image will be displayed the same, regardless of the point it was rotated around. The difference shows up in operations like adding (when two images are added together, a region of intersection is found; this region is effected by rotation).

Since:

Ptolemy II 3.0

Version:

$Id: JAIRotate.java 57040 2010-01-27 20:52:32Z cxh $

Author:

James Yeh

See Also:

Serialized Form

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (cxh)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

private static int	_BICUBIC
private static int	_BICUBIC2
private static int	_BILINEAR
private double	_degrees The number of degrees to rotate
private int	_interpolationType An indicator for the type of interpolation to use
private static int	_NEARESTNEIGHBOR
private int	_subSampleBits The subsample precision
private int	_xOrigin The x value of the origin
private int	_yOrigin The y value of the origin
PortParameter	degrees The number of degrees to rotate.
StringAttribute	interpolationType The type of interpolation to use.
Parameter	subSampleBits The subsample precision.
Parameter	xOrigin The x origin of the point to rotate around.
Parameter	yOrigin The y origin of the point to rotate around.

Fields inherited from class ptolemy.actor.lib.Transformer

input, output

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

JAIRotate(CompositeEntity container, java.lang.String name)
Construct an actor with the given container and name.

Method Summary

void	attributeChanged(Attribute attribute) Override the base class and set the origin, the rotating angle and the type of interpolation to use.
void	fire() Fire this actor.

Methods inherited from class ptolemy.actor.TypedAtomicActor

_addPort, _fireAt, _fireAt, attributeTypeChanged, clone, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

degrees

public PortParameter degrees

The number of degrees to rotate. The default value of this parameter is the double value 0. If the port is left unconnected, then the parameter value will be used.

interpolationType

public StringAttribute interpolationType

The type of interpolation to use. This is a string valued attribute that defaults to type "bilinear"

subSampleBits

public Parameter subSampleBits

The subsample precision. The default value of this parameter is the integer value 8.

xOrigin

public Parameter xOrigin

The x origin of the point to rotate around. The default value is the integer value 0.

yOrigin

public Parameter yOrigin

The y origin of the point to rotate around. The default value is the integer value 0.

_degrees

private double _degrees

The number of degrees to rotate

_interpolationType

private int _interpolationType

An indicator for the type of interpolation to use

_subSampleBits

private int _subSampleBits

The subsample precision

_xOrigin

private int _xOrigin

The x value of the origin

_yOrigin

private int _yOrigin

The y value of the origin

_BICUBIC

private static final int _BICUBIC

See Also:

Constant Field Values

_BICUBIC2

private static final int _BICUBIC2

See Also:

Constant Field Values

_BILINEAR

private static final int _BILINEAR

See Also:

Constant Field Values

_NEARESTNEIGHBOR

private static final int _NEARESTNEIGHBOR

See Also:

Constant Field Values

Constructor Detail

JAIRotate

public JAIRotate(CompositeEntity container,
                 java.lang.String name)
          throws IllegalActionException,
                 NameDuplicationException

Construct an actor with the given container and name.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

Override the base class and set the origin, the rotating angle and the type of interpolation to use.

Overrides:

attributeChanged in class NamedObj

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the function is not recognized.

fire

public void fire()
          throws IllegalActionException

Fire this actor. Output the rotated RenderedOp.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor

Throws:

IllegalActionException - If a contained method throws it.