org.simbrain.world.odorworld.sensors

Class SmellSensor

java.lang.Object

org.simbrain.world.odorworld.sensors.Sensor

org.simbrain.world.odorworld.sensors.SmellSensor

public class SmellSensor
extends Sensor

A sensor which is updated based on the presence of SmellSources near it.

See Also:

SmellSource

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_LABEL Default label.
static double	DEFAULT_RADIUS Initial length of mouse whisker.
static double	DEFAULT_THETA Angle of whisker in radians.

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

parent

Constructor Summary

Constructors

Constructor and Description
SmellSensor(OdorWorldEntity parent, java.lang.String label, double theta, double radius) Construct a smell sensor.

Method Summary

Modifier and Type	Method and Description
double[]	getCurrentValue()
double	getCurrentValue(int index) The current value at an index.
double[]	getLocation()
double	getRadius()
double	getTheta()
java.lang.String	getTypeDescription() Short description of the sensor type.
void	setRadius(double radius)
void	setTheta(double theta)
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_LABEL

public static final java.lang.String DEFAULT_LABEL

Default label.

See Also:

Constant Field Values

DEFAULT_THETA

public static double DEFAULT_THETA

Angle of whisker in radians.

DEFAULT_RADIUS

public static final double DEFAULT_RADIUS

Initial length of mouse whisker.

See Also:

Constant Field Values

Constructor Detail

SmellSensor

public SmellSensor(OdorWorldEntity parent,
                   java.lang.String label,
                   double theta,
                   double radius)

Construct a smell sensor.

Parameters:

parent - parent

label - label for this sensor (entity name will be added)

theta - offset from straight in degrees radians

radius - length of "whisker"

Method Detail

getLocation

public double[] getLocation()

Returns:

the location

update

public void update()

Update the sensor.

Specified by:

update in class Sensor

getCurrentValue

public double[] getCurrentValue()

Returns:

the currentValue

getCurrentValue

public double getCurrentValue(int index)

The current value at an index.

Parameters:

index -

Returns:

the currentValue

getTheta

public double getTheta()

Returns:

the theta

setTheta

public void setTheta(double theta)

Parameters:

theta - the theta to set

getRadius

public double getRadius()

Returns:

the radius

setRadius

public void setRadius(double radius)

Parameters:

radius - the radius 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