Package clickDetector.ClickClassifiers
Class ClickTypeCommonParams
java.lang.Object
clickDetector.ClickClassifiers.ClickTypeCommonParams
- All Implemented Interfaces:
Serializable
,Cloneable
,ManagedParameters
- Direct Known Subclasses:
ClickTypeParams
,SweepClassifierSet
public abstract class ClickTypeCommonParams
extends Object
implements Cloneable, Serializable, ManagedParameters
Superclass for click parameters, including the ClickTypeParms and
SweepClassifierSet classes. Created to allow simple access to the alarm-
specific parameters
- Author:
- Michael Oswald
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ClickAlarm
Alarm to be used for detectionprotected Boolean
boolean indicating whether or not the alarm has been enabledprotected Boolean
True to discard classified clicks insteac of calssifiying them.protected long
the maximum amount of time allowed (in milliseconds) between clicks to still be counted as a detection (for alarm purposes)protected String
The name of the classifierprotected long
the time (in milliseconds) of the previous detectionstatic final long
protected int
The species code of the classifier -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected ClickTypeCommonParams
clone()
getAlarm()
Returns theClickAlarm
associated with this click type.Returns true/false on whether an alarm has been enabled for the clickboolean
Don't use this function.long
getName()
Get a set of data that describes all of the parameters in a classlong
int
void
setAlarm
(ClickAlarm alarm) Sets the alarm used for this click type.void
setAlarmEnabled
(Boolean alarmEnabled) void
setDiscard
(Boolean discard) void
setEnable
(boolean enable) Set enabled.void
setMaxTime
(long maxTime) void
void
setPrevTime
(long prevTime) void
setSpeciesCode
(int speciesCode)
-
Field Details
-
serialVersionUID
public static final long serialVersionUID- See Also:
-
name
The name of the classifier -
speciesCode
protected int speciesCodeThe species code of the classifier -
discard
True to discard classified clicks insteac of calssifiying them. -
alarm
Alarm to be used for detection -
alarmEnabled
boolean indicating whether or not the alarm has been enabled -
prevTime
protected long prevTimethe time (in milliseconds) of the previous detection -
maxTime
protected long maxTimethe maximum amount of time allowed (in milliseconds) between clicks to still be counted as a detection (for alarm purposes)
-
-
Constructor Details
-
Method Details
-
getAlarm
Returns theClickAlarm
associated with this click type.- Returns:
- the ClickAlarm
-
setAlarm
Sets the alarm used for this click type. This is used in the setupProcess() method of ClickDetector to reset a species code's alarm to the default alarm, in case the original alarm has been deleted.- Parameters:
clickAlarm
- the clickAlarm to apply
-
getAlarmEnabled
Returns true/false on whether an alarm has been enabled for the click- Returns:
- Boolean indicating status
-
setAlarmEnabled
-
getPrevTime
public long getPrevTime() -
setPrevTime
public void setPrevTime(long prevTime) -
getMaxTime
public long getMaxTime() -
setMaxTime
public void setMaxTime(long maxTime) -
clone
-
getDiscard
-
getName
- Returns:
- the name
-
setName
- Parameters:
name
- the name to set
-
getSpeciesCode
public int getSpeciesCode()- Returns:
- the speciesCode
-
setSpeciesCode
public void setSpeciesCode(int speciesCode) - Parameters:
speciesCode
- the speciesCode to set
-
getEnable
public boolean getEnable()- Returns:
- the enable
-
getEnableObject
Don't use this function. Use getEnable which will return a primitive and default to true. This is used for some startup checks to deal with a bug.- Returns:
-
setEnable
public void setEnable(boolean enable) Set enabled.- Parameters:
enable
-
-
setDiscard
- Parameters:
discard
- the discard to set
-
getParameterSet
Description copied from interface:ManagedParameters
Get a set of data that describes all of the parameters in a class- Specified by:
getParameterSet
in interfaceManagedParameters
- Returns:
- description of the parameters in a class.
-