net.imglib2.img.cell

Class CellGrid

java.lang.Object

net.imglib2.img.cell.CellGrid

public class CellGrid
extends Object

Defines AbstractCellImg geometry and translates between image, cell, and grid coordinates.

Author:

Tobias Pietzsch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CellGrid.CellIntervals

Constructor Summary

Constructors

Constructor and Description
CellGrid(CellGrid grid)
CellGrid(long[] dimensions, int[] cellDimensions)

Method Summary

Modifier and Type	Method and Description
int	cellDimension(int d) Get the number of pixels in a standard cell in dimension d.
void	cellDimensions(int[] dimensions) Write the number of pixels in a standard cell in each dimension into the provided dimensions array.
CellGrid.CellIntervals	cellIntervals()
boolean	equals(Object obj)
int	getCellDimension(int d, long cellGridPosition) From the position of a cell in the grid, compute the size of the cell in dimension d.
int[]	getCellDimensions() Get the number of pixels in a standard cell in each dimension as a new int[].
void	getCellDimensions(long[] cellGridPosition, long[] cellMin, int[] cellDims) From the position of a cell in the grid, compute the image position of the first pixel of the cell (the offset of the cell in image coordinates) and the dimensions of the cell.
void	getCellDimensions(long index, long[] cellMin, int[] cellDims) From the index of a cell in the grid, compute the image position of the first pixel of the cell (the offset of the cell in image coordinates) and the dimensions of the cell.
void	getCellGridPositionFlat(long index, long[] cellGridPosition) From the flattened index of a cell in the grid, compute the position of a cell in the grid.
void	getCellInterval(long[] cellGridPosition, long[] cellMin, long[] cellMax)
long	getCellMin(int d, long cellGridPosition) From the position of a cell in the grid, compute the image position in dimension d of the first pixel of the cell (the offset of the cell in image coordinates).
void	getCellPosition(long[] position, long[] cellPos) Get the grid position of the cell containing the element at position.
void	getCellPosition(long[] position, Positionable cellPos) Get the grid position of the cell containing the element at position.
long[]	getGridDimensions() Get the number of cells in each dimension as a new long[].
long[]	getImgDimensions() Get the number of pixels in each dimension as a new long[].
long	gridDimension(int d) Get the number of cells in dimension d.
void	gridDimensions(long[] dimensions) Write the number of cells in each dimension into the provided dimensions array.
int	hashCode()
long	imgDimension(int d) Get the number of pixels in dimension d.
void	imgDimensions(long[] dimensions) Write the number of pixels in each dimension into the provided dimensions array.
int	numDimensions()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CellGrid

public CellGrid(long[] dimensions,
                int[] cellDimensions)

Parameters:

dimensions - the dimensions of the image (in pixels, not in cells).

cellDimensions - the dimensions of a standard cell (in pixels). Cells on the max border of the image may be cut off and have different dimensions.

CellGrid

public CellGrid(CellGrid grid)

Method Detail

numDimensions

public int numDimensions()

getGridDimensions

public long[] getGridDimensions()

Get the number of cells in each dimension as a new long[].

gridDimensions

public void gridDimensions(long[] dimensions)

Write the number of cells in each dimension into the provided dimensions array.

gridDimension

public long gridDimension(int d)

Get the number of cells in dimension d.

getImgDimensions

public long[] getImgDimensions()

Get the number of pixels in each dimension as a new long[]. Note, that this is the number of pixels in all cells combined, not the number of cells!

imgDimensions

public void imgDimensions(long[] dimensions)

Write the number of pixels in each dimension into the provided dimensions array. Note, that this is the number of pixels in all cells combined, not the number of cells!

imgDimension

public long imgDimension(int d)

Get the number of pixels in dimension d. Note, that this is the number of pixels in all cells combined, not the number of cells!

getCellDimensions

public int[] getCellDimensions()

Get the number of pixels in a standard cell in each dimension as a new int[]. Cells on the borders of the image may be cut off and have different dimensions.

cellDimensions

public void cellDimensions(int[] dimensions)

Write the number of pixels in a standard cell in each dimension into the provided dimensions array. Cells on the max border of the image may be cut off and have different dimensions.

cellDimension

public int cellDimension(int d)

Get the number of pixels in a standard cell in dimension d. Cells on the max border of the image may be cut off and have different dimensions.

getCellDimensions

public void getCellDimensions(long index,
                              long[] cellMin,
                              int[] cellDims)

From the index of a cell in the grid, compute the image position of the first pixel of the cell (the offset of the cell in image coordinates) and the dimensions of the cell. The dimensions will be the standard cellDimensions unless the cell is at the border of the image in which case it might be truncated.

Note, that this method assumes that the cell grid has flat iteration order. It this is not the case, use getCellDimensions(long[], long[], int[]).

Parameters:

index - flattened grid coordinates of the cell.

cellMin - offset of the cell in image coordinates are written here.

cellDims - dimensions of the cell are written here.

getCellDimensions

public void getCellDimensions(long[] cellGridPosition,
                              long[] cellMin,
                              int[] cellDims)

From the position of a cell in the grid, compute the image position of the first pixel of the cell (the offset of the cell in image coordinates) and the dimensions of the cell. The dimensions will be the standard cellDimensions unless the cell is at the border of the image in which case it might be truncated.

Parameters:

cellGridPosition - grid coordinates of the cell.

cellMin - offset of the cell in image coordinates are written here.

cellDims - dimensions of the cell are written here.

getCellInterval

public void getCellInterval(long[] cellGridPosition,
                            long[] cellMin,
                            long[] cellMax)

getCellDimension

public int getCellDimension(int d,
                            long cellGridPosition)

From the position of a cell in the grid, compute the size of the cell in dimension d. The size will be the standard cellDimensions unless the cell is at the border of the image in which case it might be truncated.

Parameters:

d - dimension index

cellGridPosition - grid coordinates of the cell in dimension d.

Returns:

size of the cell in dimension d.

getCellMin

public long getCellMin(int d,
                       long cellGridPosition)

From the position of a cell in the grid, compute the image position in dimension d of the first pixel of the cell (the offset of the cell in image coordinates).

Parameters:

d - dimension index

cellGridPosition - grid coordinates of the cell in dimension d.

Returns:

offset of the cell in dimension d (in image coordinates).

getCellGridPositionFlat

public void getCellGridPositionFlat(long index,
                                    long[] cellGridPosition)

From the flattened index of a cell in the grid, compute the position of a cell in the grid.

Parameters:

index - flattened grid coordinates of the cell.

cellGridPosition - grid coordinates of the cell are written here.

getCellPosition

public void getCellPosition(long[] position,
                            long[] cellPos)

Get the grid position of the cell containing the element at position.

Parameters:

position - position of an element in the image.

cellPos - is set to the grid position of the cell containing the element.

getCellPosition

public void getCellPosition(long[] position,
                            Positionable cellPos)

Get the grid position of the cell containing the element at position.

Parameters:

position - position of an element in the image.

cellPos - is set to the grid position of the cell containing the element.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

cellIntervals

public CellGrid.CellIntervals cellIntervals()