GridManipulator

Constructor of class GridManipulator.

The model whose grid we are manipulating.

Helper method that assigns all pixels in a given array to a cell of a given cellkind: changes the pixels defined by voxels (array of coordinates p) into the given cellKind and a corresponding cellID.

Example:

	let C = new CPM.CPM( [10,10], {T:20, J:[[0,20],[20,10]]} )
	let gm = new CPM.GridManipulator( C )
	let myLine = gm.makeLine( 0, 2 )
	gm.assignCellPixels( myLine, 1 )

Abrogated; this is now assignCellPixels. *

Let cell "id" divide by splitting it along a line perpendicular to its major axis.

Example:

let C = new CPM.CPM( [10,10], {
	T:20, 
J:[[0,20],[20,10]], 
V:[0,200], 
LAMBDA_V:[0,2] 
})
let gm = new CPM.GridManipulator( C )

// Seed a single cell
gm.seedCell( 1 )

// Perform some Monte Carlo Steps before dividing the cell
for( let t = 0; t < 100; t++ ){
	C.timeStep()
}
gm.divideCell( 1 )

// Check which pixels belong to which cell. Should be roughly half half.
C.getStat( PixelsByCell )

Example:

let C = new CPM.CPM( [10,10], {
	T:20, 
J:[[0,20],[20,10]], 
V:[0,200], 
LAMBDA_V:[0,2] 
})
let gm = new CPM.GridManipulator( C )

// Seed a single cell
gm.seedCell( 1 )

// Perform some Monte Carlo Steps before dividing the cell
for( let t = 0; t < 100; t++ ){
	C.timeStep()
}
gm.divideCell( 1 )

// Check which pixels belong to which cell. Should be roughly half half.
C.getStat( PixelsByCell )

Test:

• Tests for Grid Manipulator [ unit tests ] should remove a cellID from the grid

Helper method to return a rectangle (or in 3D: box) of pixels; can be used in conjunction with assignCellPixels to assign all these pixels to a given CellId at once. (See also makeLine and makeCircle). The method takes an existing array of coordinates (which can be empty) and adds the pixels of the specified rectangle/box to it. See assignCellPixels for a method that sets such a pixel set to a new value.

The box/rectangle is specified by its bottom left corner (x,y,z) and size (dx, dy, dz).

Example:

let C = new CPM.CPM( [10,10], {T:20, J:[[0,20],[20,10]]} )
let gm = new CPM.GridManipulator( C )
let rect = gm.makeBox( [50,50], [10,10] )
gm.assignCellPixels( rect, 1 )

Helper method to return a circle (in 3D: sphere) of pixels; can be used in conjunction with assignCellPixels to assign all these pixels to a given CellId at once. (See also makeLine and makeBox). The method takes an existing array of coordinates (which can be empty) and adds the pixels of the specified circle/sphere to it. See assignCellPixels for a method that sets such a pixel set to a new value.

The circle/sphere is specified by its center (x,y,z) and radius.

Example:

let C = new CPM.CPM( [10,10], {T:20, J:[[0,20],[20,10]]} )
let gm = new CPM.GridManipulator( C )
let circ = gm.makeCircle( [50,50], 10 )
gm.assignCellPixels( circ, 1 )

Helper method to return an entire plane or line of pixels; can be used in conjunction with assignCellPixels to assign all these pixels to a given CellId at once. (See also makeBox and makeCircle). The method takes an existing array of coordinates (which can be empty) and adds the pixels of the specified plane to it. See assignCellPixels for a method that sets such a pixel set to a new value.

The plane is specified by fixing one coordinate (x,y,or z) to a fixed value, and letting the others range from their min value 0 to their max value. In 3D, this returns a plane.

Example:

let C = new CPM.CPM( [10,10], {T:20, J:[[0,20],[20,10]]} )
let gm = new CPM.GridManipulator( C )
let myLine = gm.makeLine( 0, 2 )
gm.assignCellPixels( myLine, 1 )

Deprecated method, please use makeLine instead. Old method just links to the new method for backwards-compatibility.

Seed a new cell at a random position. Return 0 if failed, ID of new cell otherwise. Try a specified number of times, then give up if grid is too full. The first cell will always be seeded at the midpoint of the grid.

See also seedCellAt to seed a cell on a predefined position.

Example:

// Build CPM and attach a gridmanipulator
let C = new CPM.CPM( [100,100], {T:20, J:[[0,20],[20,10]]} )
let gm = new CPM.GridManipulator( C )

// Seed some cells
gm.seedCell( 1 )
gm.seedCell( 1 )

// Check which pixels are nonzero. One is always the grid midpoint.
for( let p of C.pixels() ){
	console.log( p )
}

Seed a new cell of celltype "kind" onto position "p". This succeeds regardless of whether there is already a cell there. See also seedCell to seed a cell on a random position.

Example:

// Build CPM and attach a gridmanipulator
let C = new CPM.CPM( [100,100], {T:20, J:[[0,20],[20,10]]} )
let gm = new CPM.GridManipulator( C )

// Seed some cells
gm.seedCellAt( 1, [2,4] )
gm.seedCellAt( 1, [9,3] )

// Check which pixels are nonzero. These should be the positions defined above.
for( let p of C.pixels() ){
	console.log( p )
}

Test:

• Tests for Grid Manipulator [ unit tests ] seedCellAt should not throw error normally

Seed "n" cells of celltype "kind" at random points lying within a circle surrounding "center" with radius "radius".

See also seedCell to seed a cell on a random position in the entire grid, and seedCellAt to seed a cell at a specific position.

Example:

// Build CPM and attach a gridmanipulator
let C = new CPM.CPM( [100,100], {T:20, J:[[0,20],[20,10]]} )
let gm = new CPM.GridManipulator( C )

// Seed cells within a circle
gm.seedCellsInCircle( 1, 10, [50,30], 20 )

// Check which pixels are nonzero. These should be within the circle.
for( let p of C.pixels() ){
	console.log( p )
}