org.simbrain.gauge.core
Class ProjectCoordinate

java.lang.Object
  extended by org.simbrain.gauge.core.Projector
      extended by org.simbrain.gauge.core.ProjectCoordinate

public class ProjectCoordinate
extends Projector

Project Coordinate is perhaps the simplest possible projection algorithm; It simply takes two specificed dimensions in the high dimensional space, and uses these as the basis for the low-dimensional space. In effect it just takes a 2-dimensional subspace of the high-dimensional space.


Field Summary
 
Fields inherited from class org.simbrain.gauge.core.Projector
addMethod, downstairs, theSettings, upstairs
 
Constructor Summary
ProjectCoordinate()
          Default projector coordinate constructor.
ProjectCoordinate(Settings set)
          Projector coordinate constructor.
 
Method Summary
 void checkCoordinates()
          If the current coordinate axes are outside acceptable bounds, set them to acceptable values (currently 0 and 1).
 int getHiD1()
           
 int getHiD2()
           
 boolean hasDialog()
           
 void init(Dataset up, Dataset down)
          Initializes the coordinage dataset.
 boolean isAutoFind()
          In auto-find the projection automatically uses the most variant dimensions.
 boolean isExtendable()
           
 boolean isIterable()
           
 double iterate()
          Iterate, if it is iterable.
 void project()
          Project data points.
 void setAutoFind(boolean b)
          In auto-find the projection automatically uses the most variant dimensions.
 void setHiD1(int i)
           
 void setHiD2(int i)
           
 
Methods inherited from class org.simbrain.gauge.core.Projector
addDatapoint, addUpstairs, checkDatasets, compareDatasets, getAddMethod, getAddMethodIndex, getDownstairs, getPerturbationAmount, getTheSettings, getTolerance, getUpstairs, init, setAddMethod, setDownstairs, setPerturbationAmount, setTheSettings, setTolerance, setUpstairs
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProjectCoordinate

public ProjectCoordinate()
Default projector coordinate constructor.


ProjectCoordinate

public ProjectCoordinate(Settings set)
Projector coordinate constructor.

Parameters:
set - Projector setting
Method Detail

init

public void init(Dataset up,
                 Dataset down)
Initializes the coordinage dataset.

Overrides:
init in class Projector
Parameters:
up - Upper data set
down - Lower data set

project

public void project()
Project data points.

Specified by:
project in class Projector

checkCoordinates

public void checkCoordinates()
If the current coordinate axes are outside acceptable bounds, set them to acceptable values (currently 0 and 1).


isExtendable

public boolean isExtendable()
Specified by:
isExtendable in class Projector
Returns:
Return project is extendable.

isIterable

public boolean isIterable()
Specified by:
isIterable in class Projector
Returns:
Returns project is iterable

iterate

public double iterate()
Description copied from class: Projector
Iterate, if it is iterable. For non iterable-projectors this is just a stub

Specified by:
iterate in class Projector
Returns:
default times to iterate.

getHiD1

public int getHiD1()
Returns:
the first coordinate projected onto

getHiD2

public int getHiD2()
Returns:
the second coordinate projected onto

setHiD1

public void setHiD1(int i)
Parameters:
i - the first coordinate to project onto

setHiD2

public void setHiD2(int i)
Parameters:
i - the second coordinate to project onto

isAutoFind

public boolean isAutoFind()
In auto-find the projection automatically uses the most variant dimensions.

Returns:
true if in auto-find mode, false otherwise

setAutoFind

public void setAutoFind(boolean b)
In auto-find the projection automatically uses the most variant dimensions.

Parameters:
b - whether to use auto-find mode

hasDialog

public boolean hasDialog()
Specified by:
hasDialog in class Projector
Returns:
true true if current projector has a dialog.
See Also:
Projector