com.mockturtlesolutions.snifflib.util

Class Nhood

java.lang.Object

com.mockturtlesolutions.snifflib.util.Nhood

public class Nhood
extends java.lang.Object

Class for producing various neighborhood stencils on N-dimensional matrices using different topologies. Provided stencils include: "cardinal" : Indices in the cardinal directions at distance of Depth are set to 1. "cross" : Indices in diagonal directions at distance of Depth are set to 1. "block" : Indices within a cube of edge length Depth are set to 1. "shell" : Indices on the edges of a cube of edge length Depth are set to 1. "sphere" : Indices within Euclidean distance of Depth are set to 1. "knight" : Possible moves of the knight in chess. Depth is forced to 2. "city" : Indices within a city-block distance of Depth are set to 1. Possible topologies include: "plane": Indices outside natural bounds are dropped. "torus": Indices outside natural bounds are wrapped toroidally.

Field Summary

Fields

Modifier and Type	Field and Description
int	Depth
NhoodMapping	Mapping
DblMatrix	SelectedStencil
int[]	Size
protected DblMatrix	Stencil
DblMatrix	StencilValues
Subscript[]	SubscriptMap
java.lang.String	Topology
java.lang.String	Type

Constructor Summary

Constructors

Constructor and Description
Nhood(int[] Size) Create a neighborhood operator for a matrix of dimension Size.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyMappingAll() Apply the Mapping's applyMapping method to all indices (entries) of the matrix.
void	applyMappingTo(int index) Apply the Mapping's applyMapping method to a particular index (entry) of the matrix.
NhoodMapping	getMapping()
DblMatrix	getStencil() Get the current stencil.
void	setDepth(int N) Set the depth of the base stencil.
void	setMapping(NhoodMapping N)
void	setSize(int[] Size) Set the depth of the base stencil.
void	setStencil(DblMatrix Stencil) Users can specify there own neighborhood stencil.
void	setTopology(java.lang.String topo) Set the type of stencil to be generated.
void	setType(java.lang.String type) Set the type of stencil to be generated.
void	show()
void	show(java.lang.String msg)
int[]	translateTo(int newIndex) Return translated indices relative to the input index.
void	update() Regenerate the current base stencil.

Methods inherited from class java.lang.Object

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

Field Detail

Size

public int[] Size

Depth

public int Depth

Stencil

protected DblMatrix Stencil

Type

public java.lang.String Type

Topology

public java.lang.String Topology

Mapping

public NhoodMapping Mapping

SubscriptMap

public Subscript[] SubscriptMap

StencilValues

public DblMatrix StencilValues

SelectedStencil

public DblMatrix SelectedStencil

Constructor Detail

Nhood

public Nhood(int[] Size)

Create a neighborhood operator for a matrix of dimension Size.

Method Detail

setDepth

public void setDepth(int N)

Set the depth of the base stencil.

setSize

public void setSize(int[] Size)

Set the depth of the base stencil.

setType

public void setType(java.lang.String type)

Set the type of stencil to be generated.

setTopology

public void setTopology(java.lang.String topo)

Set the type of stencil to be generated.

setStencil

public void setStencil(DblMatrix Stencil)

Users can specify there own neighborhood stencil.

getStencil

public DblMatrix getStencil()

Get the current stencil.

update

public void update()

Regenerate the current base stencil.

translateTo

public int[] translateTo(int newIndex)

Return translated indices relative to the input index.

setMapping

public void setMapping(NhoodMapping N)

getMapping

public NhoodMapping getMapping()

applyMappingTo

public void applyMappingTo(int index)

Apply the Mapping's applyMapping method to a particular index (entry) of the matrix.

applyMappingAll

public void applyMappingAll()

Apply the Mapping's applyMapping method to all indices (entries) of the matrix.

show

public void show(java.lang.String msg)

show

public void show()