A regular spatial grid storing single-precision floating-point values. More...

Inheritance diagram for CDPL.Grid.FRegularGrid:

Public Member Functions
None	__init__ (FRegularGrid grid)
	Initializes a copy of the `FRegularGrid` instance grid. More...

None	__init__ (Math.FGrid data, float xs, float ys, float zs)
	Constructs the grid with the specified anisotropic per-axis step sizes initialized to the supplied grid data. More...

None	__init__ (Math.FGrid data, float s)
	Constructs the grid with the isotropic step size s and the supplied grid data. More...

None	__init__ (float xs, float ys, float zs)
	Constructs an empty grid with the specified anisotropic per-axis step sizes. More...

None	__init__ (float s)
	Constructs an empty grid with the specified isotropic step size s on all three axes. More...

None	getCoordinates (int i, int j, int k, object coords)
	Writes the world space 3D position of the cell at (i, j, k) into coords. More...

None	getCoordinates (int i, object coords)
	Outputs the world space 3D position of the cell with linear index i into coords. More...

Math.FRegularSpatialGrid	assign (Math.ConstFGridExpression e)
	Assigns the grid expression e to the underlying grid data without intermediate temporary. More...

Math.FRegularSpatialGrid	assign (Math.ConstDGridExpression e)
	Assigns the grid expression e to the underlying grid data without intermediate temporary. More...

Math.FRegularSpatialGrid	assign (object e)
	Assigns the grid expression e to the underlying grid data without intermediate temporary. More...

Math.FRegularSpatialGrid	assign (Math.FRegularSpatialGrid g)
	Replaces the current state of self with a copy of the state of the `FRegularSpatialGrid` instance g. More...

int	getSize1 ()
	Returns the number of cells along the x-axis. More...

int	getSize2 ()
	Returns the number of cells along the y-axis. More...

int	getSize3 ()
	Returns the number of cells along the z-axis. More...

bool	isEmpty ()
	Tells whether the grid is empty (zero cells along any dimension). More...

float	getElement (int i, int j, int k)

float	getElement (int i)

object	toArray ()

int	getSize ()
	Returns the total number of cells of the grid. More...

None	swap (Math.FRegularSpatialGrid g)

None	setElement (int i, int j, int k, float v)

None	setElement (int i, float v)

Base.Any	__getitem__ (Base.LookupKey key)

float	__getitem__ (tuple ijk)

float	__getitem__ (int i)

bool	__contains__ (Base.LookupKey key)
	Returns the result of the membership test operation `key in self`. More...

None	__setitem__ (Base.LookupKey key, Base.Any value)

None	__setitem__ (tuple ijk, float v)

None	__setitem__ (int i, float v)

bool	__delitem__ (Base.LookupKey key)

int	__len__ ()
	Returns the total number of cells of the grid. More...

float	__call__ (int i, int j, int k)
	Returns a reference to the value of cell at (i, j, k). More...

float	__call__ (int i)
	Returns a reference to the value of the cell at the linear index i. More...

bool	__eq__ (Math.FRegularSpatialGrid g)
	Returns the result of the comparison operation `self == g`. More...

bool	__eq__ (Math.ConstFGridExpression e)
	Returns the result of the comparison operation `self == e`. More...

bool	__ne__ (Math.FRegularSpatialGrid g)
	Returns the result of the comparison operation `self != g`. More...

bool	__ne__ (Math.ConstFGridExpression e)
	Returns the result of the comparison operation `self != e`. More...

str	__str__ ()
	Returns a string representation of the `FRegularGrid` instance. More...

Math.FRegularSpatialGrid	__pos__ ()

Math.ConstFGridExpression	__neg__ ()

Math.ConstFGridExpression	__add__ (Math.ConstFGridExpression e)
	Returns the result of the addition operation `self + e`. More...

Math.ConstFGridExpression	__sub__ (Math.ConstFGridExpression e)
	Returns the result of the subtraction operation `self - e`. More...

Math.ConstFGridExpression	__mul__ (float t)
	Returns the result of the multiplication operation `self * t`. More...

Math.ConstFGridExpression	__div__ (float t)
	Returns the result of the division operation `self // t`. More...

Math.ConstFGridExpression	__truediv__ (float t)
	Returns the result of the true division operation `self / t`. More...

Math.ConstFGridExpression	__rmul__ (float t)
	Returns the result of the multiplication operation `t * self`. More...

Math.FRegularSpatialGrid	__iadd__ (Math.FRegularSpatialGrid g)
	Performs the in-place addition operation `self += g`. More...

Math.FRegularSpatialGrid	__iadd__ (Math.ConstFGridExpression e)
	Adds the grid expression e cell-wise to the underlying grid data. More...

Math.FRegularSpatialGrid	__isub__ (Math.FRegularSpatialGrid g)
	Performs the in-place subtraction operation `self -= g`. More...

Math.FRegularSpatialGrid	__isub__ (Math.ConstFGridExpression e)
	Subtracts the grid expression e cell-wise from the underlying grid data. More...

Math.FRegularSpatialGrid	__imul__ (float t)
	Multiplies every cell value by the scalar t. More...

Math.FRegularSpatialGrid	__idiv__ (float t)
	Divides every cell value by the scalar t. More...

Math.FRegularSpatialGrid	__itruediv__ (float t)

Public Member Functions inherited from CDPL.Grid.FSpatialGrid
None	__init__ ()
	Initializes the `FSpatialGrid` instance.

int	getNumElements ()
	Returns the total number of grid elements. More...

None	getCoordinates (int i, Math.Vector3F coords)
	Returns the 3D coordinates of the grid element at linear index i. More...

Public Member Functions inherited from CDPL.Base.PropertyContainer
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...

int	getNumProperties ()
	Returns the number of property entries. More...

Any	getPropertyOrDefault (LookupKey key, Any def_value)

list	getPropertyKeys ()

list	getPropertyValues ()

list	getProperties ()
	Returns a reference to itself. More...

None	setProperty (LookupKey key, Any value)

bool	removeProperty (LookupKey key)
	Clears the value of the property specified by key. More...

Any	getProperty (LookupKey key, bool throw_=False)
	Returns the value of the property specified by key. More...

bool	isPropertySet (LookupKey key)
	Tells whether or not a value has been assigned to the property specified by key. More...

None	clearProperties ()
	Clears all property values.

None	addProperties (PropertyContainer cntnr)
	Adds the property value entries in the `PropertyContainer` instance cntnr. More...

None	copyProperties (PropertyContainer cntnr)
	Replaces the current set of properties by a copy of the entries in cntnr. More...

None	swap (PropertyContainer cntnr)
	Exchanges the properties of this container with the properties of the container cntnr. More...

Any	__getitem__ (LookupKey key)
	Returns the value of the property specified by key. More...

bool	__contains__ (LookupKey key)
	Returns the result of the membership test operation `key in self`. More...

None	__setitem__ (LookupKey key, Any value)

bool	__delitem__ (LookupKey key)

Public Member Functions inherited from CDPL.Math.FRegularSpatialGrid
None	__init__ (FRegularSpatialGrid grid)
	Initializes a copy of the `FRegularSpatialGrid` instance grid. More...

None	__init__ (FGrid data, float xs, float ys, float zs)
	Constructs the grid with the specified anisotropic per-axis step sizes initialized to the supplied grid data. More...

None	__init__ (FGrid data, float s)
	Constructs the grid with the isotropic step size s and the supplied grid data. More...

None	resize (int m, int n, int o, bool preserve=True, float v=0.0)
	Resizes the grid to m×n×o cells. More...

None	clear (float v=0.0)
	Sets every cell of the grid to the value v. More...

float	getXExtent ()
	Returns the spatial extent of the grid along the x-axis. More...

float	getYExtent ()
	Returns the spatial extent of the grid along the y-axis. More...

float	getZExtent ()
	Returns the spatial extent of the grid along the z-axis. More...

float	getXStepSize ()
	Returns the per-cell step size along the x-axis. More...

float	getYStepSize ()
	Returns the per-cell step size along the y-axis. More...

float	getZStepSize ()
	Returns the per-cell step size along the z-axis. More...

None	setXStepSize (float xs)
	Sets the per-cell step size along the x-axis to xs. More...

None	setYStepSize (float ys)
	Sets the per-cell step size along the y-axis to ys. More...

None	setZStepSize (float zs)
	Sets the per-cell step size along the z-axis to zs. More...

FGrid	getData ()
	Returns a mutable reference to the underlying grid data container. More...

None	setCoordinatesTransform (Matrix4F xform)
	Sets the grid space to world coordinates transformation to xform and caches its calculated inverse. More...

Matrix4F	getCoordinatesTransform ()
	Returns the coordinate transformation mapping grid space to world coordinates. More...

None	getLocalCoordinates (int i, int j, int k, object coords)
	Writes the grid space 3D position of the cell at (i, j, k) into coords. More...

None	getLocalCoordinates (Vector3F world_coords, object local_coords)
	Transforms the world space point world_coords into the grid's local coordinate frame and stores the result in local_coords. More...

bool	containsPoint (Vector3F pos)
	Tells whether the world space point pos lies within the grid bounds. More...

bool	containsPoint (ConstFVectorExpression pos)
	Tells whether the world space point pos lies within the grid bounds. More...

bool	containsPoint (Vector3D pos)
	Tells whether the world space point pos lies within the grid bounds. More...

bool	containsPoint (ConstDVectorExpression pos)
	Tells whether the world space point pos lies within the grid bounds. More...

bool	containsPoint (Vector3L pos)
	Tells whether the world space point pos lies within the grid bounds. More...

bool	containsPoint (ConstLVectorExpression pos)
	Tells whether the world space point pos lies within the grid bounds. More...

bool	containsPoint (Vector3UL pos)
	Tells whether the world space point pos lies within the grid bounds. More...

bool	containsPoint (ConstULVectorExpression pos)
	Tells whether the world space point pos lies within the grid bounds. More...

bool	containsLocalPoint (Vector3F pos)
	Tells whether the grid space point pos lies within the grid bounds. More...

bool	containsLocalPoint (ConstFVectorExpression pos)
	Tells whether the grid space point pos lies within the grid bounds. More...

bool	containsLocalPoint (Vector3D pos)
	Tells whether the grid space point pos lies within the grid bounds. More...

bool	containsLocalPoint (ConstDVectorExpression pos)
	Tells whether the grid space point pos lies within the grid bounds. More...

bool	containsLocalPoint (Vector3L pos)
	Tells whether the grid space point pos lies within the grid bounds. More...

bool	containsLocalPoint (ConstLVectorExpression pos)
	Tells whether the grid space point pos lies within the grid bounds. More...

bool	containsLocalPoint (Vector3UL pos)
	Tells whether the grid space point pos lies within the grid bounds. More...

bool	containsLocalPoint (ConstULVectorExpression pos)
	Tells whether the grid space point pos lies within the grid bounds. More...

None	getContainingCell (Vector3F pos, object indices)
	Writes the (i, j, k) indices of the cell containing the world space point pos into indices. More...

None	getContainingCell (ConstFVectorExpression pos, object indices)
	Writes the (i, j, k) indices of the cell containing the world space point pos into indices. More...

None	getContainingCell (Vector3D pos, object indices)
	Writes the (i, j, k) indices of the cell containing the world space point pos into indices. More...

None	getContainingCell (ConstDVectorExpression pos, object indices)
	Writes the (i, j, k) indices of the cell containing the world space point pos into indices. More...

None	getContainingCell (Vector3L pos, object indices)
	Writes the (i, j, k) indices of the cell containing the world space point pos into indices. More...

None	getContainingCell (ConstLVectorExpression pos, object indices)
	Writes the (i, j, k) indices of the cell containing the world space point pos into indices. More...

None	getContainingCell (Vector3UL pos, object indices)
	Writes the (i, j, k) indices of the cell containing the world space point pos into indices. More...

None	getContainingCell (ConstULVectorExpression pos, object indices)
	Writes the (i, j, k) indices of the cell containing the world space point pos into indices. More...

None	getLocalContainingCell (Vector3F pos, object indices)
	Writes the (i, j, k) indices of the cell containing the grid space point pos into indices. More...

None	getLocalContainingCell (ConstFVectorExpression pos, object indices)
	Writes the (i, j, k) indices of the cell containing the grid space point pos into indices. More...

None	getLocalContainingCell (Vector3D pos, object indices)
	Writes the (i, j, k) indices of the cell containing the grid space point pos into indices. More...

None	getLocalContainingCell (ConstDVectorExpression pos, object indices)
	Writes the (i, j, k) indices of the cell containing the grid space point pos into indices. More...

None	getLocalContainingCell (Vector3L pos, object indices)
	Writes the (i, j, k) indices of the cell containing the grid space point pos into indices. More...

None	getLocalContainingCell (ConstLVectorExpression pos, object indices)
	Writes the (i, j, k) indices of the cell containing the grid space point pos into indices. More...

None	getLocalContainingCell (Vector3UL pos, object indices)
	Writes the (i, j, k) indices of the cell containing the grid space point pos into indices. More...

None	getLocalContainingCell (ConstULVectorExpression pos, object indices)
	Writes the (i, j, k) indices of the cell containing the grid space point pos into indices. More...

int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...

FRegularSpatialGrid	assign (ConstFGridExpression e)
	Assigns the grid expression e to the underlying grid data without intermediate temporary. More...

FRegularSpatialGrid	assign (ConstDGridExpression e)
	Assigns the grid expression e to the underlying grid data without intermediate temporary. More...

FRegularSpatialGrid	assign (FRegularSpatialGrid g)
	Replaces the current state of self with a copy of the state of the `FRegularSpatialGrid` instance g. More...

None	swap (FRegularSpatialGrid g)

bool	__eq__ (FRegularSpatialGrid g)
	Returns the result of the comparison operation `self == g`. More...

bool	__eq__ (ConstFGridExpression e)
	Returns the result of the comparison operation `self == e`. More...

bool	__ne__ (FRegularSpatialGrid g)
	Returns the result of the comparison operation `self != g`. More...

bool	__ne__ (ConstFGridExpression e)
	Returns the result of the comparison operation `self != e`. More...

ConstFGridExpression	__add__ (ConstFGridExpression e)
	Returns the result of the addition operation `self + e`. More...

ConstFGridExpression	__sub__ (ConstFGridExpression e)
	Returns the result of the subtraction operation `self - e`. More...

FRegularSpatialGrid	__iadd__ (FRegularSpatialGrid g)
	Performs the in-place addition operation `self += g`. More...

FRegularSpatialGrid	__iadd__ (ConstFGridExpression e)
	Adds the grid expression e cell-wise to the underlying grid data. More...

FRegularSpatialGrid	__isub__ (FRegularSpatialGrid g)
	Performs the in-place subtraction operation `self -= g`. More...

FRegularSpatialGrid	__isub__ (ConstFGridExpression e)
	Subtracts the grid expression e cell-wise from the underlying grid data. More...

Properties
	size1 = property(getSize1)

	size2 = property(getSize2)

	size3 = property(getSize3)

Properties inherited from CDPL.Grid.AttributedGrid
	numElements = property(getNumElements)

Properties inherited from CDPL.Base.PropertyContainer
	objectID = property(getObjectID)

	propertyKeys = property(getPropertyKeys)

	propertyValues = property(getPropertyValues)

	properties = property(getProperties)

	numProperties = property(getNumProperties)

Properties inherited from CDPL.Math.FRegularSpatialGrid
	data = property(getData)

	coordsTransform = property(getCoordinatesTransform, setCoordinatesTransform)

	xStepSize = property(getXStepSize, setXStepSize)

	yStepSize = property(getYStepSize, setYStepSize)

	zStepSize = property(getZStepSize, setZStepSize)

	xExtent = property(getXExtent)

	yExtent = property(getYExtent)

	zExtent = property(getZExtent)

	objectID = property(getObjectID)

	size1 = property(getSize1)

	size2 = property(getSize2)

	size3 = property(getSize3)

Detailed Description

A regular spatial grid storing single-precision floating-point values.

Constructor & Destructor Documentation

◆ init() [1/5]

None CDPL.Grid.FRegularGrid.__init__ ( FRegularGrid grid )

Initializes a copy of the FRegularGrid instance grid.

Parameters

grid	The `FRegularGrid` instance to copy.

◆ init() [2/5]

None CDPL.Grid.FRegularGrid.__init__	(	Math.FGrid	data,
		float	xs,
		float	ys,
		float	zs
	)

Constructs the grid with the specified anisotropic per-axis step sizes initialized to the supplied grid data.

Parameters

data	The grid data container.
xs	The step size along the x-axis.
ys	The step size along the y-axis.
zs	The step size along the z-axis.

◆ init() [3/5]

None CDPL.Grid.FRegularGrid.__init__	(	Math.FGrid	data,
		float	s
	)

Constructs the grid with the isotropic step size s and the supplied grid data.

Parameters

data	The grid data container.
s	The step size used on every axis.

◆ init() [4/5]

None CDPL.Grid.FRegularGrid.__init__	(	float	xs,
		float	ys,
		float	zs
	)

Constructs an empty grid with the specified anisotropic per-axis step sizes.

Parameters

xs	The step size along the x-axis.
ys	The step size along the y-axis.
zs	The step size along the z-axis.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ init() [5/5]

None CDPL.Grid.FRegularGrid.__init__ ( float s )

Constructs an empty grid with the specified isotropic step size s on all three axes.

Parameters

s	The step size used on every axis.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

Member Function Documentation

◆ getCoordinates() [1/2]

None CDPL.Grid.FRegularGrid.getCoordinates	(	int	i,
		int	j,
		int	k,
		object	coords
	)

Writes the world space 3D position of the cell at (i, j, k) into coords.

Parameters

i	The zero-based cell index along the x-axis.
j	The zero-based cell index along the y-axis.
k	The zero-based cell index along the z-axis.
coords	The output vector receiving the world space 3D position.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ getCoordinates() [2/2]

None CDPL.Grid.FRegularGrid.getCoordinates	(	int	i,
		object	coords
	)

Outputs the world space 3D position of the cell with linear index i into coords.

Parameters

i	The zero-based linear cell index.
coords	The output vector receiving the xyz-coordinates.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ assign() [1/4]

Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.assign ( Math.ConstFGridExpression e )

Assigns the grid expression e to the underlying grid data without intermediate temporary.

Parameters

e	The source grid expression.

Returns: self

◆ assign() [2/4]

Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.assign ( Math.ConstDGridExpression e )

Assigns the grid expression e to the underlying grid data without intermediate temporary.

Parameters

e	The source grid expression.

Returns: self

◆ assign() [3/4]

Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.assign ( object e )

Assigns the grid expression e to the underlying grid data without intermediate temporary.

Parameters

e	The source grid expression.

Returns: self

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ assign() [4/4]

Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.assign ( Math.FRegularSpatialGrid g )

Replaces the current state of self with a copy of the state of the FRegularSpatialGrid instance g.

Parameters

g	The `FRegularSpatialGrid` instance to copy.

Returns: self

◆ getSize1()

int CDPL.Grid.FRegularGrid.getSize1 ( )

Returns the number of cells along the x-axis.

Returns: The number of cells along the x-axis.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ getSize2()

int CDPL.Grid.FRegularGrid.getSize2 ( )

Returns the number of cells along the y-axis.

Returns: The number of cells along the y-axis.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ getSize3()

int CDPL.Grid.FRegularGrid.getSize3 ( )

Returns the number of cells along the z-axis.

Returns: The number of cells along the z-axis.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ isEmpty()

bool CDPL.Grid.FRegularGrid.isEmpty ( )

Tells whether the grid is empty (zero cells along any dimension).

Returns: True if the grid is empty, and False otherwise.

Reimplemented from CDPL.Grid.FSpatialGrid.

◆ getSize()

int CDPL.Grid.FRegularGrid.getSize ( )

Returns the total number of cells of the grid.

Returns: The total cell count.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ contains()

bool CDPL.Grid.FRegularGrid.__contains__ ( Base.LookupKey key )

Returns the result of the membership test operation key in self.

Parameters

key	The value to test for membership.

Returns: The result of the membership test operation.

Reimplemented from CDPL.Grid.FSpatialGrid.

◆ len()

int CDPL.Grid.FRegularGrid.__len__ ( )

Returns the total number of cells of the grid.

Returns: The total cell count.

Reimplemented from CDPL.Grid.FSpatialGrid.

◆ call() [1/2]

float CDPL.Grid.FRegularGrid.__call__	(	int	i,
		int	j,
		int	k
	)

Returns a reference to the value of cell at (i, j, k).

Parameters

i	The zero-based cell index along the x-axis.
j	The zero-based cell index along the y-axis.
k	The zero-based cell index along the z-axis.

Returns: A reference to the cell value.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ call() [2/2]

float CDPL.Grid.FRegularGrid.__call__ ( int i )

Returns a reference to the value of the cell at the linear index i.

Parameters

i	The zero-based linear cell index.

Returns: A reference to the cell value.

Reimplemented from CDPL.Grid.FSpatialGrid.

◆ eq() [1/2]

bool CDPL.Grid.FRegularGrid.__eq__ ( Math.FRegularSpatialGrid g )

Returns the result of the comparison operation self == g.

Parameters

g	The `FRegularSpatialGrid` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Grid.FRegularGrid.__eq__ ( Math.ConstFGridExpression e )

Returns the result of the comparison operation self == e.

Parameters

e	The `ConstFGridExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

bool CDPL.Grid.FRegularGrid.__ne__ ( Math.FRegularSpatialGrid g )

Returns the result of the comparison operation self != g.

Parameters

g	The `FRegularSpatialGrid` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Grid.FRegularGrid.__ne__ ( Math.ConstFGridExpression e )

Returns the result of the comparison operation self != e.

Parameters

e	The `ConstFGridExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Grid.FRegularGrid.__str__ ( )

Returns a string representation of the FRegularGrid instance.

Returns: The generated string representation.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ add()

Math.ConstFGridExpression CDPL.Grid.FRegularGrid.__add__ ( Math.ConstFGridExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns: A Math.ConstFGridExpression instance holding the result of the addition.

◆ sub()

Math.ConstFGridExpression CDPL.Grid.FRegularGrid.__sub__ ( Math.ConstFGridExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns: A FRegularGrid instance holding the result of the subtraction.

◆ mul()

Math.ConstFGridExpression CDPL.Grid.FRegularGrid.__mul__ ( float t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns: A Math.ConstFGridExpression instance holding the result of the multiplication.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ div()

Math.ConstFGridExpression CDPL.Grid.FRegularGrid.__div__ ( float t )

Returns the result of the division operation self // t.

Parameters

t	Specifies the divisor.

Returns: A Math.ConstFGridExpression instance holding the result of the division.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ truediv()

Math.ConstFGridExpression CDPL.Grid.FRegularGrid.__truediv__ ( float t )

Returns the result of the true division operation self / t.

Parameters

t	Specifies the divisor.

Returns: A Math.ConstFGridExpression instance holding the result of the division.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ rmul()

Math.ConstFGridExpression CDPL.Grid.FRegularGrid.__rmul__ ( float t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns: A Math.ConstFGridExpression instance holding the result of the multiplication.

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ iadd() [1/2]

Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__iadd__ ( Math.FRegularSpatialGrid g )

Performs the in-place addition operation self += g.

Parameters

g	Specifies the second addend.

Returns: The updated Math.FRegularSpatialGrid instance self.

◆ iadd() [2/2]

Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__iadd__ ( Math.ConstFGridExpression e )

Adds the grid expression e cell-wise to the underlying grid data.

Parameters

e	The grid expression to add.

Returns: self

◆ isub() [1/2]

Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__isub__ ( Math.FRegularSpatialGrid g )

Performs the in-place subtraction operation self -= g.

Parameters

g	Specifies the subtrahend.

Returns: The updated Math.FRegularSpatialGrid instance self.

◆ isub() [2/2]

Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__isub__ ( Math.ConstFGridExpression e )

Subtracts the grid expression e cell-wise from the underlying grid data.

Parameters

e	The grid expression to subtract.

Returns: self

◆ imul()

Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__imul__ ( float t )

Multiplies every cell value by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self

Reimplemented from CDPL.Math.FRegularSpatialGrid.

◆ idiv()

Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__idiv__ ( float t )

Divides every cell value by the scalar t.

Parameters

t	The scalar divisor.

Returns: self

Reimplemented from CDPL.Math.FRegularSpatialGrid.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/5]

◆ __init__() [2/5]

◆ __init__() [3/5]

◆ __init__() [4/5]

◆ __init__() [5/5]

Member Function Documentation

◆ getCoordinates() [1/2]

◆ getCoordinates() [2/2]

◆ assign() [1/4]

◆ assign() [2/4]

◆ assign() [3/4]

◆ assign() [4/4]

◆ getSize1()

◆ getSize2()

◆ getSize3()

◆ isEmpty()

◆ getSize()

◆ __contains__()

◆ __len__()

◆ __call__() [1/2]

◆ __call__() [2/2]

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __str__()

◆ __add__()

◆ __sub__()

◆ __mul__()

◆ __div__()

◆ __truediv__()

◆ __rmul__()

◆ __iadd__() [1/2]

◆ __iadd__() [2/2]

◆ __isub__() [1/2]

◆ __isub__() [2/2]

◆ __imul__()

◆ __idiv__()

◆ init() [1/5]

◆ init() [2/5]

◆ init() [3/5]

◆ init() [4/5]

◆ init() [5/5]

◆ contains()

◆ len()

◆ call() [1/2]

◆ call() [2/2]

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ str()

◆ add()

◆ sub()

◆ mul()

◆ div()

◆ truediv()

◆ rmul()

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ imul()

◆ idiv()