Projector (Simbrain API)

java.lang.Object
- org.simbrain.util.projection.Projector

```
public class Projector
extends java.lang.Object
```
Projector is a the main class of this package, which provides an interface for projecting high dimensional data to 2 dimensions (this is also known as "dimensionality reduction"). Contains a high dimensional dataset ( "upstairs") and a low-dimensional projection of that high dimensional data ( "downstairs"), as well as a modifiable projection method.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Dataset`	`downstairs` A set of low-d datapoints, each of which is an array of doubles The projection of the upstairs data.
`protected double`	`tolerance` Distance within which added points are considered old and are thus not added.
`protected Dataset`	`upstairs` A set of hi-d datapoints, each of which is an array of doubles The data to be projected.

Constructor Summary

Constructors
Constructor and Description

Projector()
Default constructor for projector.

Projector(int dimension)
Default constructor for projector.

Constructors
Constructor and Description
`Projector()` Default constructor for projector.
`Projector(int dimension)` Default constructor for projector.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDatapoint(DataPointColored point)` Add a new point to the dataset, using the currently selected add method.
`void`	`addListener(ProjectorListener projectorListener)` Add a projector listener.
`boolean`	`compareDatasets()` Check the integrity of the two datasets by checking: (1) That the low-d set is at least 2 dimensions (2) That the low d space is lower dimensional than the hi d space (3) That both datasets have the same number of points.
`void`	`fireDataPointAdded()` Notify listeners that a new datapoint has been added to the projector.
`void`	`fireProjectionMethodChanged()` Notify listeners that the projection method has been changed.
`void`	`fireProjectorColorsChanged()` Notify listeners that the colors of some datapoints have changed but nothing else.
`void`	`fireProjectorDataChanged()` Notify listeners that data (in particular the underlying points) have been changed.
`DataColoringManager`	`getColorManager()`
`java.lang.String`	`getCurrentMethodString()` Used to get the String associated with the current projection method.
`DataPoint`	`getCurrentPoint()`
`int`	`getDimensions()` Number of dimensions of the underlying data.
`Dataset`	`getDownstairs()` Convenience method to get downstairs dataset.
`int`	`getNumPoints()` Returns the size of the dataset.
`ProjectionMethod`	`getProjectionMethod()`
`java.util.HashMap<java.lang.Class<?>,java.lang.String>`	`getProjectionMethods()`
`double`	`getTolerance()`
`Dataset`	`getUpstairs()` Convenience method to get upstairs dataset.
`void`	`importData(java.io.File theFile)` Add new high-d datapoints and reinitialize the datasets.
`void`	`init(int dims)` Initialize projector to accept data of a specified dimension.
`void`	`iterate()` Iterate the dataset once.
`void`	`postOpenInit()` Updates datasets from persistent forms of data.
`void`	`randomize(int upperBound)` Randomize the low-dimensional data.
`void`	`reset()` Reset the projector.
`void`	`resetColors()` Reset the colors of all colored data points.
`void`	`setProjectionMethod(ProjectionMethod method)` Change the current projection method and perform and other needed initialization.
`void`	`setProjectionMethod(java.lang.String projName)`
`void`	`setTolerance(double tolerance)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - upstairs
```
protected Dataset upstairs
```
    A set of hi-d datapoints, each of which is an array of doubles The data to be projected.
  - downstairs
```
protected Dataset downstairs
```
    A set of low-d datapoints, each of which is an array of doubles The projection of the upstairs data.
  - tolerance
```
protected double tolerance
```
    Distance within which added points are considered old and are thus not added.
- Constructor Detail
  - Projector
```
public Projector()
```
    Default constructor for projector.
  - Projector
```
public Projector(int dimension)
```
    Default constructor for projector.
    
    Parameters:
    
    dimension - dimensionality of data to be projected
- Method Detail
  - addListener
```
public void addListener(ProjectorListener projectorListener)
```
    Add a projector listener.
    
    Parameters:
    
    projectorListener - the listener to add
  - init
```
public void init(int dims)
```
    Initialize projector to accept data of a specified dimension.
    
    Parameters:
    
    dims - dimensionality of the high dimensional dataset
  - postOpenInit
```
public void postOpenInit()
```
    Updates datasets from persistent forms of data.
  - addDatapoint
```
public void addDatapoint(DataPointColored point)
```
    Add a new point to the dataset, using the currently selected add method.
    
    Parameters:
    
    point - the upstairs point to add
  - setProjectionMethod
```
public void setProjectionMethod(ProjectionMethod method)
```
    Change the current projection method and perform and other needed initialization.
    
    Parameters:
    
    method - the new projection algorithm
  - setProjectionMethod
```
public void setProjectionMethod(java.lang.String projName)
```
    Parameters:
    
    projName - the name of the projection algorithm to switch to
  - importData
```
public void importData(java.io.File theFile)
```
    Add new high-d datapoints and reinitialize the datasets.
    
    Parameters:
    
    theFile - file containing the high-d data, forwarded to a dataset method
  - getCurrentMethodString
```
public java.lang.String getCurrentMethodString()
```
    Used to get the String associated with the current projection method. Used by a combo box in the gui.
    
    Returns:
    
    the String associated with current projection method.
  - getDimensions
```
public int getDimensions()
```
    Number of dimensions of the underlying data.
    
    Returns:
    
    dimensions of the underlying data
  - fireDataPointAdded
```
public void fireDataPointAdded()
```
    Notify listeners that a new datapoint has been added to the projector.
  - fireProjectionMethodChanged
```
public void fireProjectionMethodChanged()
```
    Notify listeners that the projection method has been changed.
  - fireProjectorColorsChanged
```
public void fireProjectorColorsChanged()
```
    Notify listeners that the colors of some datapoints have changed but nothing else.
  - fireProjectorDataChanged
```
public void fireProjectorDataChanged()
```
    Notify listeners that data (in particular the underlying points) have been changed.
  - getProjectionMethod
```
public ProjectionMethod getProjectionMethod()
```
    Returns:
    
    the current projection algorithm
  - getUpstairs
```
public Dataset getUpstairs()
```
    Convenience method to get upstairs dataset.
    
    Returns:
    
    hi-dimensional dataset associated with current projector
  - getDownstairs
```
public Dataset getDownstairs()
```
    Convenience method to get downstairs dataset.
    
    Returns:
    
    low-dimensional dataset associated with current projector
  - iterate
```
public void iterate()
```
    Iterate the dataset once.
  - reset
```
public void reset()
```
    Reset the projector. Clear the underlying datasets.
  - resetColors
```
public void resetColors()
```
    Reset the colors of all colored data points.
  - getNumPoints
```
public int getNumPoints()
```
    Returns the size of the dataset.
    
    Returns:
    
    size of dataset.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getTolerance
```
public double getTolerance()
```
    Returns:
    
    the tolerance
  - setTolerance
```
public void setTolerance(double tolerance)
```
    Parameters:
    
    tolerance - the tolerance to set
  - randomize
```
public void randomize(int upperBound)
```
    Randomize the low-dimensional data. Used with iterative projection methods to "restart" the iteration.
    
    Parameters:
    
    upperBound - the upper bound of randomization
  - getColorManager
```
public DataColoringManager getColorManager()
```
    Returns:
    
    the colorManager
  - compareDatasets
```
public boolean compareDatasets()
```
    Check the integrity of the two datasets by checking: (1) That the low-d set is at least 2 dimensions (2) That the low d space is lower dimensional than the hi d space (3) That both datasets have the same number of points.
    
    Returns:
    
    true if low dimensions are lower than hi dimensions and low dimension is less than one
  - getProjectionMethods
```
public java.util.HashMap<java.lang.Class<?>,java.lang.String> getProjectionMethods()
```
    Returns:
    
    the projectionMethods
  - getCurrentPoint
```
public DataPoint getCurrentPoint()
```
    Returns:
    
    the currentPoint

Class Projector

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

upstairs

downstairs

tolerance

Constructor Detail

Projector

Projector

Method Detail

addListener

init

postOpenInit

addDatapoint

setProjectionMethod

setProjectionMethod

importData

getCurrentMethodString

getDimensions

fireDataPointAdded

fireProjectionMethodChanged

fireProjectorColorsChanged

fireProjectorDataChanged

getProjectionMethod

getUpstairs

getDownstairs

iterate

reset

resetColors

getNumPoints

toString

getTolerance

setTolerance

randomize

getColorManager

compareDatasets

getProjectionMethods

getCurrentPoint