gkdtree

Class Boundary

java.lang.Object

gkdtree.Boundary

public class Boundary
extends java.lang.Object

The Boundary class is an abstraction for n-dimensional boundaries. These are used as index in an array (therefore integer). In the context of Gaussian kd-trees the boundary only contains the extent of the spatial structure (not the range/domain of pixels or voxels).

Author:

DarkMatt

Constructor Summary

Constructors

Constructor and Description
Boundary(int[] lower, int[] size) Initializes the boundary.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containedBy(Boundary b) True if the current boundary is totally contained within b.
Boundary[]	cut(int dim, float cut) Splits the bounding box according to a specified dimension and cut value.
Boundary[]	cutHalf() Splits the bounding box according to its largest dimension.
Boundary	getAbsoluteSubregion(Boundary subregion) For a given boundary, calculate the absolute offset of a boundary contained within this boundary.
int	getDimensionality()
int	getHalfSplit() Returns the midpoint of the bounardy with the highest extent.
int[]	getLower()
Boundary	getMinimalSubregion(Boundary region) Returns the minimal sub-region of two boundaries.
int	getNumberOfElements() A multidimensional boundary has a number of n*m*k*... elements.
int[]	getSize()
int[]	getUpper() Calculates the upper boundary from internally stored lower and size.
boolean	inside(int[] point) Returns true if a point at integer coordinates is inside the boundary.
boolean	non_overlapping(Boundary b) Returns true if the bounding boxes are not overlapping.
void	printBoundary(java.lang.String id) Prints the boundary information to the console.
void	setLower(int[] lower)
void	setSize(int[] size)

Methods inherited from class java.lang.Object

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

Constructor Detail

Boundary

public Boundary(int[] lower,
        int[] size)

Initializes the boundary.

Parameters:

lower -

size -

Method Detail

getLower

public int[] getLower()

setLower

public void setLower(int[] lower)

getSize

public int[] getSize()

setSize

public void setSize(int[] size)

getUpper

public int[] getUpper()

Calculates the upper boundary from internally stored lower and size. (Calculated every time this method is executed.)

Returns:

int[]

getDimensionality

public int getDimensionality()

getHalfSplit

public int getHalfSplit()

Returns the midpoint of the bounardy with the highest extent.

Returns:

int

getNumberOfElements

public int getNumberOfElements()

A multidimensional boundary has a number of n*m*k*... elements. Where n, m, k, ... is the size in the respective dimensions.

Returns:

cutHalf

public Boundary[] cutHalf()

Splits the bounding box according to its largest dimension. The largest dimensional extent is split in the middle. This method returns both resulting boundaries.

Returns:

Boundary[]

cut

public Boundary[] cut(int dim,
             float cut)

Splits the bounding box according to a specified dimension and cut value. This method returns both resulting boundaries.

Returns:

Boundary[]

inside

public boolean inside(int[] point)

Returns true if a point at integer coordinates is inside the boundary.

Parameters:

point -

Returns:

boolean

non_overlapping

public boolean non_overlapping(Boundary b)

Returns true if the bounding boxes are not overlapping. This is an n-dimensional to n-dimensional intersection test. (It is assumed that the dimensions match.)

Parameters:

b -

Returns:

boolean

containedBy

public boolean containedBy(Boundary b)

True if the current boundary is totally contained within b. (It is assumed that the dimensions match.)

Parameters:

b -

Returns:

boolean

getAbsoluteSubregion

public Boundary getAbsoluteSubregion(Boundary subregion)

For a given boundary, calculate the absolute offset of a boundary contained within this boundary.

Parameters:

subregion -

Returns:

Boundary

getMinimalSubregion

public Boundary getMinimalSubregion(Boundary region)

Returns the minimal sub-region of two boundaries. (the largest lower and the smallest higher)

Parameters:

region -

Returns:

Boundary

printBoundary

public void printBoundary(java.lang.String id)

Prints the boundary information to the console.

Parameters:

id -