org.jactr.modules.pm.visual.visicon
Class AbstractVisicon

java.lang.Object
  extended by org.jactr.modules.pm.visual.visicon.AbstractVisicon
All Implemented Interfaces:
IVisicon
Direct Known Subclasses:
DefaultVisicon6

public abstract class AbstractVisicon
extends java.lang.Object
implements IVisicon


Field Summary
static org.apache.commons.logging.Log LOGGER
          logger definition
 
Constructor Summary
AbstractVisicon(IVisualModule module)
           
 
Method Summary
 void addVisualChunkEncoder(IVisualChunkEncoder encoder)
           
 void dispose()
           
 boolean exceedsMovementTolerance(IChunk originalVisualLocation, IChunk newVisualLocation)
          returns true if the distance between these two visual locations is greater than the movement tolerance
 double getFINSTTimeSpan()
           
 double getMovementTolerance()
          the maximum visual degrees than an object can move between search and encoding before a failure is logged, and the maximum visual degrees that an object can move while tracking before the track is lost
 int getNumberOfFINSTs()
           
 java.util.Collection<IVisualChunkEncoder> getVisualChunkEncoders()
           
 IVisualMap getVisualMap()
           
 IVisualModule getVisualModule()
           
 double getVisualOnsetSpanTime()
           
 void removeVisualChunkEncoder(IVisualChunkEncoder encoder)
           
 void setFINSTTimeSpan(double finstTimeSpan)
          how long does an attended object retain :attended true before becoming :attended null
 void setMovementTolerance(double tolerance)
           
 void setNumberOfFINSTs(int number)
          FINSTs permit the tracking of the attended status of visual chunks
 void setVisualOnsetSpanTime(double visualOnsetTimeSpan)
          new visual chunks (encoded by the visual chunk encoders but not added to the model yet) are initially flagged as :attended new, and will remain so until visualOnsetTimeSpan expires
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jactr.modules.pm.visual.visicon.IVisicon
getLastChangeTime
 

Field Detail

LOGGER

public static final org.apache.commons.logging.Log LOGGER
logger definition

Constructor Detail

AbstractVisicon

public AbstractVisicon(IVisualModule module)
Method Detail

dispose

public void dispose()
Specified by:
dispose in interface IVisicon

addVisualChunkEncoder

public void addVisualChunkEncoder(IVisualChunkEncoder encoder)
Specified by:
addVisualChunkEncoder in interface IVisicon

getVisualModule

public IVisualModule getVisualModule()
Specified by:
getVisualModule in interface IVisicon

getFINSTTimeSpan

public double getFINSTTimeSpan()
Specified by:
getFINSTTimeSpan in interface IVisicon

getNumberOfFINSTs

public int getNumberOfFINSTs()
Specified by:
getNumberOfFINSTs in interface IVisicon

getVisualChunkEncoders

public java.util.Collection<IVisualChunkEncoder> getVisualChunkEncoders()
Specified by:
getVisualChunkEncoders in interface IVisicon

getVisualMap

public IVisualMap getVisualMap()
Specified by:
getVisualMap in interface IVisicon

getVisualOnsetSpanTime

public double getVisualOnsetSpanTime()
Specified by:
getVisualOnsetSpanTime in interface IVisicon
Returns:
See Also:
IVisicon.getVisualOnsetSpanTime()

removeVisualChunkEncoder

public void removeVisualChunkEncoder(IVisualChunkEncoder encoder)
Specified by:
removeVisualChunkEncoder in interface IVisicon
Parameters:
encoder -
See Also:
IVisicon.removeVisualChunkEncoder(org.jactr.modules.pm.visual.visicon.encoder.IVisualChunkEncoder)

setMovementTolerance

public void setMovementTolerance(double tolerance)
Specified by:
setMovementTolerance in interface IVisicon
Parameters:
tolerance -
See Also:
IVisicon.setMovementTolerance(double)

getMovementTolerance

public double getMovementTolerance()
Description copied from interface: IVisicon
the maximum visual degrees than an object can move between search and encoding before a failure is logged, and the maximum visual degrees that an object can move while tracking before the track is lost

Specified by:
getMovementTolerance in interface IVisicon
Returns:
See Also:
IVisicon.getMovementTolerance()

exceedsMovementTolerance

public boolean exceedsMovementTolerance(IChunk originalVisualLocation,
                                        IChunk newVisualLocation)
Description copied from interface: IVisicon
returns true if the distance between these two visual locations is greater than the movement tolerance

Specified by:
exceedsMovementTolerance in interface IVisicon
Parameters:
originalVisualLocation -
newVisualLocation -
Returns:
See Also:
IVisicon.exceedsMovementTolerance(org.jactr.core.chunk.IChunk, org.jactr.core.chunk.IChunk)

setFINSTTimeSpan

public void setFINSTTimeSpan(double finstTimeSpan)
Description copied from interface: IVisicon
how long does an attended object retain :attended true before becoming :attended null

Specified by:
setFINSTTimeSpan in interface IVisicon
Parameters:
finstTimeSpan -
See Also:
IVisicon.setFINSTTimeSpan(double)

setNumberOfFINSTs

public void setNumberOfFINSTs(int number)
Description copied from interface: IVisicon
FINSTs permit the tracking of the attended status of visual chunks

Specified by:
setNumberOfFINSTs in interface IVisicon
Parameters:
number -
See Also:
IVisicon.setNumberOfFINSTs(int)

setVisualOnsetSpanTime

public void setVisualOnsetSpanTime(double visualOnsetTimeSpan)
Description copied from interface: IVisicon
new visual chunks (encoded by the visual chunk encoders but not added to the model yet) are initially flagged as :attended new, and will remain so until visualOnsetTimeSpan expires

Specified by:
setVisualOnsetSpanTime in interface IVisicon
Parameters:
visualOnsetTimeSpan -
See Also:
IVisicon.setVisualOnsetSpanTime(double)