clickDetector

Class IDI_DisplayParams

java.lang.Object

clickDetector.IDI_DisplayParams

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class IDI_DisplayParams
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Parameters for the IDI Display

Author:

Michael Oswald

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID for serialization

Constructor Summary

Constructors

Constructor and Description
IDI_DisplayParams() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
int	getHighResIdiBinScale() Returns the scale of the IDI bins (horizontal axis), in milliseconds/bin
int	getLowResIdiBinScale() Returns the scale of the IDI bins (horizontal axis), in milliseconds/bin
int	getMaxHighCount() Gets the highest histogram count in the high-resolution colour bar
int	getMaxHighResBin() Returns the highest IDI bin number (horizontal axis) of the high- resolution histogram, in milliseconds
int	getMaxLowCount() Gets the highest histogram count in the low-resolution colour bar
int	getMaxLowResBin() Returns the highest IDI bin number (horizontal axis) of the low- resolution histogram, in milliseconds
int	getMaxTimeBin() Gets the highest time bin value in the vertical axis
java.io.File	getOutputFilename()
static long	getSerialVersionUID()
int	getTimeBinScale() Returns the size (along the vertical axis) of the time bins, in milliseconds.
boolean	isOutputSaved()
void	setHighResIdiBinScale(int idiBin) Sets the size (along the horizontal axis) of the IDI bins, in milliseconds/bin
void	setLowResIdiBinScale(int idiBin) Sets the size (along the horizontal axis) of the IDI bins, in milliseconds/bin
void	setMaxHighCount(int maxHighCount) Sets the highest histogram count in the high-resolution colour bar
void	setMaxHighResBin(int maxHighRes) Sets the highest IDI bin number (horizontal axis) of the high- resolution histogram, in milliseconds
void	setMaxLowCount(int maxLowCount) Sets the highest histogram count in the low-resolution colour bar
void	setMaxLowResBin(int maxLowRes) Sets the highest IDI bin number (horizontal axis) of the low- resolution histogram, in milliseconds
void	setMaxTimeBin(int maxTimeBin) Sets the highest time bin value to display in the vertical axis
void	setOutputFilename(java.io.File outputFilename)
void	setSaveOutput(boolean saveOutput)
void	setTimeBinScale(int timeBin) Sets the size (along the vertical axis) of the time bins, in milliseconds.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

for serialization

See Also:

Constant Field Values

Constructor Detail

IDI_DisplayParams

public IDI_DisplayParams()

Constructor

Method Detail

getHighResIdiBinScale

public int getHighResIdiBinScale()

Returns the scale of the IDI bins (horizontal axis), in milliseconds/bin

Returns:

width of IDI bins in milliseconds/bin

setHighResIdiBinScale

public void setHighResIdiBinScale(int idiBin)

Sets the size (along the horizontal axis) of the IDI bins, in milliseconds/bin

Parameters:

idiBin - width of IDI bins in milliseconds/bin

getLowResIdiBinScale

public int getLowResIdiBinScale()

Returns the scale of the IDI bins (horizontal axis), in milliseconds/bin

Returns:

width of IDI bins in milliseconds/bin

setLowResIdiBinScale

public void setLowResIdiBinScale(int idiBin)

Sets the size (along the horizontal axis) of the IDI bins, in milliseconds/bin

Parameters:

idiBin - width of IDI bins in milliseconds/bin

getMaxHighResBin

public int getMaxHighResBin()

Returns the highest IDI bin number (horizontal axis) of the high- resolution histogram, in milliseconds

Returns:

highest IDI bin number of high-res graph, in milliseconds

setMaxHighResBin

public void setMaxHighResBin(int maxHighRes)

Sets the highest IDI bin number (horizontal axis) of the high- resolution histogram, in milliseconds

Parameters:

maxHighResBin - highest IDI bin number of high-res graph, in milliseconds

getMaxLowResBin

public int getMaxLowResBin()

Returns the highest IDI bin number (horizontal axis) of the low- resolution histogram, in milliseconds

Returns:

highest IDI bin number of low-res graph, in milliseconds

setMaxLowResBin

public void setMaxLowResBin(int maxLowRes)

Sets the highest IDI bin number (horizontal axis) of the low- resolution histogram, in milliseconds

Parameters:

maxLowRes - highest IDI bin number of low-res graph, in milliseconds

getTimeBinScale

public int getTimeBinScale()

Returns the size (along the vertical axis) of the time bins, in milliseconds. This is the value used to set the timer; whenever the timer reaches this value, the histogram data is compiled and displayed as a new line on the chart.

Returns:

size of time bins, in milliseconds

setTimeBinScale

public void setTimeBinScale(int timeBin)

Sets the size (along the vertical axis) of the time bins, in milliseconds. This is the value used to set the timer; whenever the timer reaches this value, the histogram data is compiled and displayed as a new line on the chart.

Parameters:

timeBin - size of the time bins, in milliseconds

getMaxHighCount

public int getMaxHighCount()

Gets the highest histogram count in the high-resolution colour bar

Returns:

histogram count corresponding to the red color

setMaxHighCount

public void setMaxHighCount(int maxHighCount)

Sets the highest histogram count in the high-resolution colour bar

Parameters:

histogram - count corresponding to the red color

getMaxLowCount

public int getMaxLowCount()

Gets the highest histogram count in the low-resolution colour bar

Returns:

histogram count corresponding to the red color

setMaxLowCount

public void setMaxLowCount(int maxLowCount)

Sets the highest histogram count in the low-resolution colour bar

Parameters:

histogram - count corresponding to the red color

getMaxTimeBin

public int getMaxTimeBin()

Gets the highest time bin value in the vertical axis

Returns:

the largest time bin to display, in milliseconds

setMaxTimeBin

public void setMaxTimeBin(int maxTimeBin)

Sets the highest time bin value to display in the vertical axis

Parameters:

maxTimeBin - the largest time bin to display on the vertical axis, in milliseconds

getOutputFilename

public java.io.File getOutputFilename()

setOutputFilename

public void setOutputFilename(java.io.File outputFilename)

isOutputSaved

public boolean isOutputSaved()

setSaveOutput

public void setSaveOutput(boolean saveOutput)

getSerialVersionUID

public static long getSerialVersionUID()