public class GarpPrediction extends TypedAtomicActor
GARP is a computer program for predicting species locations based on various spatial data sets of environment variables and known species locations. GARP is an acronym for Genetic Algorithm for Rule Set Production. GARP was originally ceated by David Stockwell. The version in Kepler is based on 'Desktop GARP', http://www.lifemapper.org/desktopgarp/. The GarpPrediction actor predicts presence/absence data on a spatial grid based on the input RuleSet (calculated by the GarpAlgorithm actor) and the input set of environmental layers. The input layers are described in a summary xml file (*.dxl). The outputs are either an *.asc grid file or a *.bmp file. Either can be displayed as a bitmapped image with predicted presence/absence indicated by pixel values (e.g. color mapped when displayed).
This is a JNI-based actor. It requires the following: linux: libgarp.so windows: garp.dll, libexpat.dll MacOSX - currently not available for the Mac (3/16/2006)
Entity.ContainedObjectsIterator| Modifier and Type | Field and Description |
|---|---|
TypedIOPort |
layersetFilename
This is the file name of the *.dxl file used to summarize the set of
spatial data files with environmental data for each pixel.
|
FileParameter |
layersetFilenameParameter
This is the file name of the *.dxl file used to summarize the set of
spatial data files with environmental data for each pixel.
|
TypedIOPort |
outputASCII
This is the file name to be used for the output ASCII grid file.
|
TypedIOPort |
outputASCIIFileName
This is the file name of the output ASCII grid file.
|
FileParameter |
outputASCIIParameter
This is the file name to be used for the output ASCII grid file.
|
TypedIOPort |
outputBMP
This is the file name to be used for the output BMP raster file.
|
TypedIOPort |
outputBMPFileName
This is the file name of the output BMP raster file.
|
FileParameter |
outputBMPParameter
This is the file name to be used for the output BMP raster file.
|
TypedIOPort |
ruleSetFilename
This is the file name of the file containing the RuleSet data.
|
FileParameter |
ruleSetFilenameParameter
This is the file name of the file containing the RuleSet data.
|
_typesValid_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKSCOMPLETED, NOT_READY, STOP_ITERATING| Constructor and Description |
|---|
GarpPrediction(CompositeEntity container,
java.lang.String name)
GarpPrediction Actor
|
| Modifier and Type | Method and Description |
|---|---|
void |
fire()
Do nothing.
|
void |
initialize()
Initialize this actor.
|
boolean |
prefire()
Return true.
|
_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition_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, workspaceequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitcreateReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortListisFireFunctional, isStrict, iterate, postfire, stop, stopFire, terminateaddInitializable, preinitialize, removeInitializable, wrapupdescription, getContainer, getDisplayName, getFullName, getName, getName, setNamegetDerivedLevel, getDerivedList, propagateValuepublic FileParameter ruleSetFilenameParameter
public FileParameter layersetFilenameParameter
public FileParameter outputASCIIParameter
public FileParameter outputBMPParameter
public TypedIOPort ruleSetFilename
public TypedIOPort layersetFilename
public TypedIOPort outputASCII
public TypedIOPort outputBMP
public TypedIOPort outputASCIIFileName
public TypedIOPort outputBMPFileName
public GarpPrediction(CompositeEntity container, java.lang.String name) throws NameDuplicationException, IllegalActionException
public void initialize() throws IllegalActionException
AtomicActorinitialize in interface Initializableinitialize in class AtomicActor<TypedIOPort>IllegalActionException - If a derived class throws it.public boolean prefire() throws IllegalActionException
AtomicActorprefire in interface Executableprefire in class AtomicActor<TypedIOPort>IllegalActionException - Not thrown in this base class.public void fire() throws IllegalActionException
AtomicActorfire in interface Executablefire in class AtomicActor<TypedIOPort>IllegalActionException - Not thrown in this base class.