org.jactr.modules.pm.visual.scene

Class SceneChangeExtension

java.lang.Object

org.jactr.modules.pm.visual.scene.SceneChangeExtension

All Implemented Interfaces:

IExtension, IInitializable, IInstallable, IParameterized

public class SceneChangeExtension
extends java.lang.Object
implements IExtension

Provides scene change detection functionality without touching the core distribution. This adds two new status slots to the visual module scene-change and scene-change-value. scene-change-value is a proportion of objects that have changed in the visual scene since the last time the scene-change mechanism was reset (visual-onset-duration since last trigger, or explicit reset with +visual> isa clear-scene-change).

?visual> scene-change =value will be true or false depending on whether or not the scene-change-value is greater than SceneChangeThreshold (default 0.25).

This is all accomplished by attaching listeners to the visual module, and either the individual IVisualFeatureMaps or IAgent's IAfferentObjectManager, depending upon whether accuracy or speed is more important. Setting the AcceleratedDetectionEnabled to true will use the faster ( IAfferentListener version).

Injection of the chunktype clear-scene-change is handled by the SceneChangeParticipant and the extension point in the bundle manifest.

Author:

harrison

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCELERATED_DETECTION_PARAM
static java.lang.String	CLEAR_CHUNK_TYPE
static java.lang.String	SCENE_CHANGE_THRESHOLD_PARAM
static java.lang.String	SCENE_CHANGED_SLOT
static java.lang.String	SCENE_CHANGED_VALUE_SLOT

Constructor Summary

Constructors

Constructor and Description
SceneChangeExtension()

Method Summary

Modifier and Type	Method and Description
protected void	checkForChange() check to see if we should set the scene-change flag
IModel	getModel() return the IModel
java.lang.String	getName() returns the unique name of the extension.
java.lang.String	getParameter(java.lang.String key) return parameter value - null if not defined.
java.util.Collection<java.lang.String>	getPossibleParameters() Return all parameters that can be read
double	getSceneChangeThreshold()
java.util.Collection<java.lang.String>	getSetableParameters() Return list of all parameters that can be set.
void	initialize() intialize this component
void	install(IModel model) Install this extension into this model.
protected void	reset() explicitly reset the scene-change flag, regardless of whether or not its been triggered
void	setParameter(java.lang.String key, java.lang.String value) Set the named parameter
void	setSceneChangeThreshold(double threshold)
void	uninstall(IModel model) remove this extension from the model

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLEAR_CHUNK_TYPE

public static final java.lang.String CLEAR_CHUNK_TYPE

See Also:

Constant Field Values

SCENE_CHANGED_SLOT

public static final java.lang.String SCENE_CHANGED_SLOT

See Also:

Constant Field Values

SCENE_CHANGED_VALUE_SLOT

public static final java.lang.String SCENE_CHANGED_VALUE_SLOT

See Also:

Constant Field Values

SCENE_CHANGE_THRESHOLD_PARAM

public static final java.lang.String SCENE_CHANGE_THRESHOLD_PARAM

See Also:

Constant Field Values

ACCELERATED_DETECTION_PARAM

public static final java.lang.String ACCELERATED_DETECTION_PARAM

See Also:

Constant Field Values

Constructor Detail

SceneChangeExtension

public SceneChangeExtension()

Method Detail

getModel

public IModel getModel()

Description copied from interface: IExtension

return the IModel

Specified by:

getModel in interface IExtension

Returns:

The model value

getName

public java.lang.String getName()

Description copied from interface: IExtension

returns the unique name of the extension.

Specified by:

getName in interface IExtension

Returns:

The name value

install

public void install(IModel model)

Description copied from interface: IExtension

Install this extension into this model.

Specified by:

install in interface IExtension

Specified by:

install in interface IInstallable

Parameters:

model - Description of the Parameter

uninstall

public void uninstall(IModel model)

Description copied from interface: IExtension

remove this extension from the model

Specified by:

uninstall in interface IExtension

Specified by:

uninstall in interface IInstallable

Parameters:

model - Description of the Parameter

initialize

public void initialize()
                throws java.lang.Exception

Description copied from interface: IInitializable

intialize this component

Specified by:

initialize in interface IInitializable

Throws:

java.lang.Exception

See Also:

IInitializable.initialize()

checkForChange

protected void checkForChange()

check to see if we should set the scene-change flag

reset

protected void reset()

explicitly reset the scene-change flag, regardless of whether or not its been triggered

getSceneChangeThreshold

public double getSceneChangeThreshold()

setSceneChangeThreshold

public void setSceneChangeThreshold(double threshold)

getParameter

public java.lang.String getParameter(java.lang.String key)

Description copied from interface: IParameterized

return parameter value - null if not defined.

Specified by:

getParameter in interface IParameterized

Parameters:

key - Description of the Parameter

Returns:

The parameter value

getPossibleParameters

public java.util.Collection<java.lang.String> getPossibleParameters()

Description copied from interface: IParameterized

Return all parameters that can be read

Specified by:

getPossibleParameters in interface IParameterized

Returns:

The possibleParameters value

getSetableParameters

public java.util.Collection<java.lang.String> getSetableParameters()

Description copied from interface: IParameterized

Return list of all parameters that can be set.

Specified by:

getSetableParameters in interface IParameterized

Returns:

The setableParameters value

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)

Description copied from interface: IParameterized

Set the named parameter

Specified by:

setParameter in interface IParameterized