org.simbrain.world.odorworld.sensors

Class TileSensor

java.lang.Object

org.simbrain.world.odorworld.sensors.Sensor

org.simbrain.world.odorworld.sensors.TileSensor

public class TileSensor
extends Sensor

A sensor which detects whether the entity is in a given sector or "tile" of the world. Broadly inspired by "place cells".

Author:

jyoshimi

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_ACTIVATION Default Activation Amount.
static int	DEFAULT_HEIGHT Default height.
static int	DEFAULT_WIDTH Default width.
static int	DEFAULT_X Default X coordinate of the upper left corner.
static int	DEFAULT_Y Default Y coordinate of the upper left corner.

Fields inherited from class org.simbrain.world.odorworld.sensors.Sensor

parent

Constructor Summary

Constructors

Constructor and Description
TileSensor(OdorWorldEntity parent, int x, int y, int width, int height) Construct a tile sensor.

Method Summary

Modifier and Type	Method and Description
double	getActivationAmount()
int	getHeight()
java.lang.String	getTypeDescription() Short description of the sensor type.
double	getValue()
int	getWidth()
int	getX()
int	getY()
void	setActivationAmount(double amount)
void	setHeight(int height)
void	setValue(double value)
void	setWidth(int width)
void	setX(int x)
void	setY(int y)
void	update() Update the sensor.

Methods inherited from class org.simbrain.world.odorworld.sensors.Sensor

getApplicableTypes, getId, getLabel, getParent, setId, setLabel

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ACTIVATION

public static final double DEFAULT_ACTIVATION

Default Activation Amount.

See Also:

Constant Field Values

DEFAULT_X

public static final int DEFAULT_X

Default X coordinate of the upper left corner.

See Also:

Constant Field Values

DEFAULT_Y

public static final int DEFAULT_Y

Default Y coordinate of the upper left corner.

See Also:

Constant Field Values

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

Default width.

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

Default height.

See Also:

Constant Field Values

Constructor Detail

TileSensor

public TileSensor(OdorWorldEntity parent,
                  int x,
                  int y,
                  int width,
                  int height)

Construct a tile sensor.

Parameters:

parent - parent entity

x - upper left

y - upper right

width - width in pixels

height - height

Method Detail

update

public void update()

Update the sensor.

Specified by:

update in class Sensor

getValue

public double getValue()

Returns:

value associated with this sensor, 0 if occupied,

setValue

public void setValue(double value)

Parameters:

value - the value to set

getActivationAmount

public double getActivationAmount()

Returns:

the activationAmount

getX

public int getX()

Returns:

the x

setX

public void setX(int x)

Parameters:

x - the x to set

getY

public int getY()

Returns:

the y

setY

public void setY(int y)

Parameters:

y - the y to set

getWidth

public int getWidth()

Returns:

the width

setWidth

public void setWidth(int width)

Parameters:

width - the width to set

getHeight

public int getHeight()

Returns:

the height

setHeight

public void setHeight(int height)

Parameters:

height - the height to set

setActivationAmount

public void setActivationAmount(double amount)

Parameters:

amount - the activation amount to set

getTypeDescription

public java.lang.String getTypeDescription()

Description copied from class: Sensor

Short description of the sensor type.

Specified by:

getTypeDescription in class Sensor

Returns:

the short description of the type