ptolemy.actor.lib.jai
Class JAIJPEGWriter
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.Sink
ptolemy.actor.lib.jai.JAIWriter
ptolemy.actor.lib.jai.JAIJPEGWriter
- 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 JAIJPEGWriter
- extends JAIWriter
Write a javax.media.jai.RenderedOp to a specified JPEG file.
The file is specified by the fileName attribute
using any form acceptable to FileParameter.
If the confirmOverwrite parameter has value false,
then this actor will overwrite the specified file if it exists
without asking. If true (the default), then if the file
exists, then this actor will ask for confirmation before overwriting.
- Since:
- Ptolemy II 3.0
- Version:
- $Id: JAIJPEGWriter.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- James Yeh, Christopher Hylands Brooks
- See Also:
FileParameter,
Serialized Form
- Accepted Rating:
- Proposed Rating:
| Fields inherited from class ptolemy.actor.lib.Sink |
input |
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
|
Method Summary |
boolean |
postfire()
Read an input JAIImageToken and write it to the file. |
| Methods inherited from class ptolemy.actor.AtomicActor |
_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, 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.util.NamedObj |
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, 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 |
quality
public IntRangeParameter quality
- The quality of the file written. The quality ranges from 0
which is a high amount of compression, small file size, and
poor picture quality, to 100, which is no compression, larger
file size, and high picture quality.
restartInterval
public Parameter restartInterval
- The restart interval in number of JPEG Minimum Coded Units
(MCUs). JPEG images can use these restart markers to
periodically delineate image segments to limit the effect
of bitstream errors to a single interval. The default
is zero.
writeJFIFHeader
public Parameter writeJFIFHeader
- If true (the default), the encoder will write a JFIF
header, using a marker.The marker includes data such as
version number, x and y pixel density, pixel aspect ratio.
If false, then the encoder will not write a JFIF header.
JAIJPEGWriter
public JAIJPEGWriter(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.
postfire
public boolean postfire()
throws IllegalActionException
- Read an input JAIImageToken and write it to the file.
If the file does not exist then create it. If the file
already exists, then query the user for overwrite.
- Specified by:
postfire in interface Executable- Overrides:
postfire in class JAIWriter
- Returns:
- True if the execution can continue.
- Throws:
IllegalActionException - If the file cannot be opened
or created, if the user refuses to overwrite an existing file,
of if the image in unable to be encoded.