ucl.physiol.neuroconstruct.project.packing
Class OneDimRegSpacingPackingAdapter

java.lang.Object
  ucl.physiol.neuroconstruct.project.packing.CellPackingAdapter
      ucl.physiol.neuroconstruct.project.packing.OneDimRegSpacingPackingAdapter

public class OneDimRegSpacingPackingAdapter
extends CellPackingAdapter

Simple cell packing adapter. Places fixed number of cells in 1 dimension inside region

Author:

Padraig Gleeson

Field Summary

static int	DIMENSION_PARAM
static String	DIMENSION_PARAM_NAME
static int	DIMENSION_PARAM_X
static int	DIMENSION_PARAM_Y
static int	DIMENSION_PARAM_Z
static int	EDGE_POLICY_PARAM
static int	EDGE_POLICY_PARAM_EXTEND
static String	EDGE_POLICY_PARAM_NAME
static int	EDGE_POLICY_PARAM_NO_EXTEND
static int	NUMBER_PARAM
static String	NUMBER_PARAM_NAME
static int	OTHER_OVERLAP_PARAM

Fields inherited from class ucl.physiol.neuroconstruct.project.packing.CellPackingAdapter

description, myCell, myRegion, OTHER_OVERLAP_POLICY, parameterList

Constructor Summary

OneDimRegSpacingPackingAdapter()

Method Summary

boolean	avoidOtherCellGroups()
protected Point3f	generateNextPosition() Internal function to generate the next position
int	getNumberCells()
static void	main(String[] args)
void	reset() Resets to zero internally computed positions
void	setParameter(String parameterName, float parameterValue)
String	toNiceString() For a more plain english description of the settings
String	toString() Returns a short summary of the class's state, for GUIs etc.

Methods inherited from class ucl.physiol.neuroconstruct.project.packing.CellPackingAdapter

addRegionAndCellInfo, cancelPosition, doesCellCollideWithExistingCells, getCurrentNumberPositions, getDescription, getLastPosTaken, getNextPosition, getNumPosAlreadyTaken, getParameterList, setParameterList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EDGE_POLICY_PARAM

public static final int EDGE_POLICY_PARAM

See Also:

Constant Field Values

DIMENSION_PARAM

public static final int DIMENSION_PARAM

See Also:

Constant Field Values

NUMBER_PARAM

public static final int NUMBER_PARAM

See Also:

Constant Field Values

OTHER_OVERLAP_PARAM

public static final int OTHER_OVERLAP_PARAM

See Also:

Constant Field Values

EDGE_POLICY_PARAM_EXTEND

public static final int EDGE_POLICY_PARAM_EXTEND

See Also:

Constant Field Values

EDGE_POLICY_PARAM_NO_EXTEND

public static final int EDGE_POLICY_PARAM_NO_EXTEND

See Also:

Constant Field Values

DIMENSION_PARAM_X

public static final int DIMENSION_PARAM_X

See Also:

Constant Field Values

DIMENSION_PARAM_Y

public static final int DIMENSION_PARAM_Y

See Also:

Constant Field Values

DIMENSION_PARAM_Z

public static final int DIMENSION_PARAM_Z

See Also:

Constant Field Values

EDGE_POLICY_PARAM_NAME

public static final String EDGE_POLICY_PARAM_NAME

See Also:

Constant Field Values

DIMENSION_PARAM_NAME

public static final String DIMENSION_PARAM_NAME

See Also:

Constant Field Values

NUMBER_PARAM_NAME

public static final String NUMBER_PARAM_NAME

See Also:

Constant Field Values

Constructor Detail

OneDimRegSpacingPackingAdapter

public OneDimRegSpacingPackingAdapter()

Method Detail

generateNextPosition

protected Point3f generateNextPosition()
                                throws CellPackingException

Description copied from class: CellPackingAdapter

Internal function to generate the next position

Specified by:

generateNextPosition in class CellPackingAdapter

Returns:

The position as Point3d object

Throws:

CellPackingException - if a position cannoth be generated, i.e. region full

getNumberCells

public int getNumberCells()

setParameter

public void setParameter(String parameterName,
                         float parameterValue)
                  throws CellPackingException

Specified by:

setParameter in class CellPackingAdapter

Throws:

CellPackingException

reset

public void reset()

Description copied from class: CellPackingAdapter

Resets to zero internally computed positions

Overrides:

reset in class CellPackingAdapter

toString

public String toString()

Description copied from class: CellPackingAdapter

Returns a short summary of the class's state, for GUIs etc. Included here (even though it's in Object) to force the subclasses to implement it

Specified by:

toString in class CellPackingAdapter

Returns:

A string rep of internal state

toNiceString

public String toNiceString()

Description copied from class: CellPackingAdapter

For a more plain english description of the settings

Specified by:

toNiceString in class CellPackingAdapter

avoidOtherCellGroups

public boolean avoidOtherCellGroups()

Overrides:

avoidOtherCellGroups in class CellPackingAdapter

main

public static void main(String[] args)