org.ecoinformatics.seek.gis.java_gis

Class GridRescaler

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

ptolemy.actor.lib.Transformer

org.ecoinformatics.seek.gis.java_gis.GridRescaler

All Implemented Interfaces:

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

public class GridRescaler
extends Transformer
implements SequenceActor

This actor converts an ascii raster grid file into another ascii grid file with different extent and cell spacing A ASC grid file is read as input. (The file name(s) are connected to the input port.)
The xllcorner, yllcorner, cellsize, numrows and numcols of the desired grid are also input and a new ASC file is created. Algorithms are disk based meaning that very large rasters can be handled.

The input is a multiport so multiple input file names can be attached to that port. Multiple tokens are output in a sequence if multiple input filenames are attached. Token consumption and production rates are automatically calculated

A useExistingFile boolean parameter has been added. When true, the actor checks to see if the output file already exists. If it does, it is just sent to the output port without repeating the calculation.

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
StringParameter	algorithm This is the algoritm to be used in calculating cell values in the output grid from the values in the input grid Currently there are two choices: 'Nearest Neighbor' or 'Inverse Distance Weighted'
Parameter	cellsize The cell size of the output grid.
Parameter	numcols The number of columns (cells in the x-direction) in the output grid.
Parameter	numrows The number of rows (cells in the y-direction) in the output grid.
FileParameter	outputFilename This is the name to be given to the output file.
Parameter	useDisk Boolean setting to determine whether or not to use disk for storing grid data rather than putting all data in RAM arrays
Parameter	useExistingFile Boolean setting to determine whether or not to use currently existing output file, if it exists
Parameter	xllcorner The x-value of the lower left corner of the output grid Usually this is a longitude.
Parameter	yllcorner The y-value of the lower left corner of the output grid Usually this is a latitude.

Fields inherited from class ptolemy.actor.lib.Transformer

input, output

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _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

Constructors

Constructor and Description
GridRescaler(CompositeEntity container, java.lang.String name) constructor

Method Summary

Modifier and Type	Method and Description
void	connectionsChanged(Port port) Resets the output token production rate based on width of input port
void	fire() Creates rescaled ascii grid for each input grid using the input parameters Uses the 'Grid' class that is disk-based, thus allowing very large grids.
boolean	postfire() Post fire the actor.
boolean	prefire() Pre fire the actor.

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, 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

_addPort, _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, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, decorators, 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, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, 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, 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

xllcorner

public Parameter xllcorner

The x-value of the lower left corner of the output grid Usually this is a longitude. This is input as a string and converted to a double.

yllcorner

public Parameter yllcorner

The y-value of the lower left corner of the output grid Usually this is a latitude. This is input as a string and converted to a double.

cellsize

public Parameter cellsize

The cell size of the output grid. The grid is assumed square so that x and y grid sizes are equal and converted to a double..

numrows

public Parameter numrows

The number of rows (cells in the y-direction) in the output grid. This determines the extent of y-values in the grid when combined with the cell size This is input as a string and converted to a integer.

numcols

public Parameter numcols

The number of columns (cells in the x-direction) in the output grid. This determines the extent of x-values in the grid when combined with the cell size This is input as a string and converted to a integer.

algorithm

public StringParameter algorithm

This is the algoritm to be used in calculating cell values in the output grid from the values in the input grid Currently there are two choices: 'Nearest Neighbor' or 'Inverse Distance Weighted'

outputFilename

public FileParameter outputFilename

This is the name to be given to the output file. If left empty, the input file name plus a suffix (".out"+i) will be used for output file names Note that the input port is a multiport so multiple input can be converted in a single firing. If this parameter is a directory name, output file(s) will be placed in that directory

useExistingFile

public Parameter useExistingFile

Boolean setting to determine whether or not to use currently existing output file, if it exists

useDisk

public Parameter useDisk

Boolean setting to determine whether or not to use disk for storing grid data rather than putting all data in RAM arrays

Constructor Detail

GridRescaler

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

constructor

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

connectionsChanged

public void connectionsChanged(Port port)

Resets the output token production rate based on width of input port

Overrides:

connectionsChanged in class AtomicActor<TypedIOPort>

Parameters:

port - The port that has connection changes.

fire

public void fire()
          throws IllegalActionException

Creates rescaled ascii grid for each input grid using the input parameters Uses the 'Grid' class that is disk-based, thus allowing very large grids.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If there is no director.

postfire

public boolean postfire()
                 throws IllegalActionException

Post fire the actor. Return false to indicate that the process has finished. If it returns true, the process will continue indefinitely.

Specified by:

postfire in interface Executable

Overrides:

postfire in class AtomicActor<TypedIOPort>

Returns:

True if execution can continue into the next iteration.

Throws:

IllegalActionException - Not thrown in this base class.

prefire

public boolean prefire()
                throws IllegalActionException

Pre fire the actor. Calls the super class's prefire in case something is set there. *@exception IllegalActionException

Specified by:

prefire in interface Executable

Overrides:

prefire in class AtomicActor<TypedIOPort>

Returns:

True if this actor is ready for firing, false otherwise.

Throws:

IllegalActionException - Not thrown in this base class.