ptolemy.backtrack.automatic.ptolemy.domains.sdf.lib
Class IFFT

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.InstantiableNamedObj
          ptolemy.kernel.Entity
              ptolemy.kernel.ComponentEntity
                  ptolemy.actor.AtomicActor
                      ptolemy.actor.TypedAtomicActor
                          ptolemy.domains.sdf.lib.SDFTransformer
                              ptolemy.backtrack.automatic.ptolemy.domains.sdf.lib.IFFT

All Implemented Interfaces:

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

public class IFFT
extends SDFTransformer
implements Rollbackable

This actor calculates the inverse FFT of a complex input array. The order of the IFFT determines the number of tokens that will be consumed and produced on each firing. The order is the base-2 logarithm of the size. The default order is 8, which means that 2⁸ = 256 tokens are read and 2⁸ = 256 tokens are produced. The result of the IFFT is a new array of Complex tokens.

Since:

Ptolemy II 1.0

Version:

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

Author:

Bart Kienhuis, Steve Neuendorffer

See Also:

SignalProcessing.IFFTComplexOut(ptolemy.math.Complex[]), Serialized Form

Accepted Rating:

Yellow (eal)

Proposed Rating:

Yellow (neuendor)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

private Complex[]	_inComplexArray
private int	_orderValue
private ComplexToken[]	_outTokenArray
private int	_transformSize
protected Checkpoint	$CHECKPOINT
private FieldRecord	$RECORD$_inComplexArray
private FieldRecord	$RECORD$_orderValue
private FieldRecord	$RECORD$_outTokenArray
private FieldRecord	$RECORD$_transformSize
protected CheckpointRecord	$RECORD$$CHECKPOINT
private FieldRecord[]	$RECORDS
Parameter	order The order of the IFFT.

Fields inherited from class ptolemy.domains.sdf.lib.SDFTransformer

input, input_tokenConsumptionRate, output, output_tokenInitProduction, output_tokenProductionRate

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

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

Method Summary

private Complex[]	$ASSIGN$_inComplexArray(Complex[] newValue)
private Complex	$ASSIGN$_inComplexArray(int index0, Complex newValue)
private int	$ASSIGN$_orderValue(int newValue)
private ComplexToken[]	$ASSIGN$_outTokenArray(ComplexToken[] newValue)
private ComplexToken	$ASSIGN$_outTokenArray(int index0, ComplexToken newValue)
private int	$ASSIGN$_transformSize(int newValue)
private Complex[]	$BACKUP$_inComplexArray()
private ComplexToken[]	$BACKUP$_outTokenArray()
void	$COMMIT(long timestamp) Commit changes up to the given timestamp, but not including changes made at timestamp and afterward.
Checkpoint	$GET$CHECKPOINT() Get the checkpoint object that monitors this rollbackable object.
void	$RESTORE(long timestamp, boolean trim) Restore a previous state to all the private fields of this rollbackable object.
java.lang.Object	$SET$CHECKPOINT(Checkpoint checkpoint) Set the checkpoint object of this rollbackable object.
void	attributeChanged(Attribute attribute) Ensure that the order parameter is positive and recompute the size of internal buffers.
void	fire() Consume the inputs and produce the outputs of the IFFT filter.

Methods inherited from class ptolemy.domains.sdf.lib.SDFTransformer

prefire

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, 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, 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

$CHECKPOINT

protected transient Checkpoint $CHECKPOINT

order

public Parameter order

The order of the IFFT. The type is IntToken, and the value should be greater than zero. The default value is an IntToken with value 8.

_transformSize

private int _transformSize

_orderValue

private int _orderValue

_outTokenArray

private ComplexToken[] _outTokenArray

_inComplexArray

private Complex[] _inComplexArray

$RECORD$$CHECKPOINT

protected transient CheckpointRecord $RECORD$$CHECKPOINT

$RECORD$_transformSize

private transient FieldRecord $RECORD$_transformSize

$RECORD$_orderValue

private transient FieldRecord $RECORD$_orderValue

$RECORD$_outTokenArray

private transient FieldRecord $RECORD$_outTokenArray

$RECORD$_inComplexArray

private transient FieldRecord $RECORD$_inComplexArray

$RECORDS

private transient FieldRecord[] $RECORDS

Constructor Detail

IFFT

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

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

Ensure that the order parameter is positive and recompute the size of internal buffers.

Overrides:

attributeChanged in class NamedObj

Parameters:

attribute - The attribute that has changed.

Throws:

IllegalActionException - If the parameters are out of range.

fire

public void fire()
          throws IllegalActionException

Consume the inputs and produce the outputs of the IFFT filter.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor

Throws:

IllegalActionException - If a runtime type error occurs.

$ASSIGN$_transformSize

private final int $ASSIGN$_transformSize(int newValue)

$ASSIGN$_orderValue

private final int $ASSIGN$_orderValue(int newValue)

$ASSIGN$_outTokenArray

private final ComplexToken[] $ASSIGN$_outTokenArray(ComplexToken[] newValue)

$ASSIGN$_outTokenArray

private final ComplexToken $ASSIGN$_outTokenArray(int index0,
                                                  ComplexToken newValue)

$BACKUP$_outTokenArray

private final ComplexToken[] $BACKUP$_outTokenArray()

$ASSIGN$_inComplexArray

private final Complex[] $ASSIGN$_inComplexArray(Complex[] newValue)

$ASSIGN$_inComplexArray

private final Complex $ASSIGN$_inComplexArray(int index0,
                                              Complex newValue)

$BACKUP$_inComplexArray

private final Complex[] $BACKUP$_inComplexArray()

$COMMIT

public void $COMMIT(long timestamp)

Description copied from interface: Rollbackable

Commit changes up to the given timestamp, but not including changes made at timestamp and afterward.

Specified by:

$COMMIT in interface Rollbackable

Parameters:

timestamp - The timestamp.

$RESTORE

public void $RESTORE(long timestamp,
                     boolean trim)

Description copied from interface: Rollbackable

Restore a previous state to all the private fields of this rollbackable object.

Specified by:

$RESTORE in interface Rollbackable

Parameters:

timestamp - The timestamp taken at the time when the previous state was recorded.

trim - Whether to delete the records used for the rollback.

See Also:

Checkpoint.rollback(long, boolean)

$GET$CHECKPOINT

public final Checkpoint $GET$CHECKPOINT()

Description copied from interface: Rollbackable

Get the checkpoint object that monitors this rollbackable object.

Specified by:

$GET$CHECKPOINT in interface Rollbackable

Returns:

The checkpoint object.

$SET$CHECKPOINT

public final java.lang.Object $SET$CHECKPOINT(Checkpoint checkpoint)

Description copied from interface: Rollbackable

Set the checkpoint object of this rollbackable object. A merge operation is performed on the current checkpoint object and the new checkpoint object, so that the two checkpoint objects monitor the same set of objects when this function returns.

Specified by:

$SET$CHECKPOINT in interface Rollbackable

Parameters:

checkpoint - The new checkpoint object.

Returns:

This rollbackable object itself.

See Also:

Checkpoint.setCheckpoint(Checkpoint)