Chemical Data Processing Library Python API - Version 1.1.1
|
An unbounded dense regular grid in 3D space holding floating point values of type float
.
More...
Classes | |
class | DataMode |
Public Member Functions | |
None | __init__ (FRegularSpatialGrid grid) |
Initializes a copy of the FRegularSpatialGrid instance grid. More... | |
None | __init__ (FGrid data, float xs, float ys, float zs) |
Initializes the FRegularSpatialGrid instance. More... | |
None | __init__ (FGrid data, float s) |
Initializes the FRegularSpatialGrid instance. More... | |
None | __init__ (float xs, float ys, float zs) |
Initializes the FRegularSpatialGrid instance. More... | |
None | __init__ (float s) |
Initializes the FRegularSpatialGrid instance. More... | |
None | resize (int m, int n, int o, bool preserve=True, float v=0.0) |
None | clear (float v=0.0) |
DataMode | getDataMode () |
None | setDataMode (DataMode mode) |
float | getXExtent () |
float | getYExtent () |
float | getZExtent () |
float | getXStepSize () |
float | getYStepSize () |
float | getZStepSize () |
None | setXStepSize (float xs) |
None | setYStepSize (float ys) |
None | setZStepSize (float zs) |
FGrid | getData () |
None | setCoordinatesTransform (Matrix4F xform) |
Matrix4F | getCoordinatesTransform () |
None | getCoordinates (int i, int j, int k, object coords) |
None | getCoordinates (int i, object coords) |
None | getLocalCoordinates (int i, int j, int k, object coords) |
None | getLocalCoordinates (Vector3F world_coords, object local_coords) |
bool | containsPoint (Vector3F pos) |
bool | containsPoint (ConstFVectorExpression pos) |
bool | containsPoint (Vector3D pos) |
bool | containsPoint (ConstDVectorExpression pos) |
bool | containsPoint (Vector3L pos) |
bool | containsPoint (ConstLVectorExpression pos) |
bool | containsPoint (Vector3UL pos) |
bool | containsPoint (ConstULVectorExpression pos) |
bool | containsLocalPoint (Vector3F pos) |
bool | containsLocalPoint (ConstFVectorExpression pos) |
bool | containsLocalPoint (Vector3D pos) |
bool | containsLocalPoint (ConstDVectorExpression pos) |
bool | containsLocalPoint (Vector3L pos) |
bool | containsLocalPoint (ConstLVectorExpression pos) |
bool | containsLocalPoint (Vector3UL pos) |
bool | containsLocalPoint (ConstULVectorExpression pos) |
None | getContainingCell (Vector3F pos, object indices) |
None | getContainingCell (ConstFVectorExpression pos, object indices) |
None | getContainingCell (Vector3D pos, object indices) |
None | getContainingCell (ConstDVectorExpression pos, object indices) |
None | getContainingCell (Vector3L pos, object indices) |
None | getContainingCell (ConstLVectorExpression pos, object indices) |
None | getContainingCell (Vector3UL pos, object indices) |
None | getContainingCell (ConstULVectorExpression pos, object indices) |
None | getLocalContainingCell (Vector3F pos, object indices) |
None | getLocalContainingCell (ConstFVectorExpression pos, object indices) |
None | getLocalContainingCell (Vector3D pos, object indices) |
None | getLocalContainingCell (ConstDVectorExpression pos, object indices) |
None | getLocalContainingCell (Vector3L pos, object indices) |
None | getLocalContainingCell (ConstLVectorExpression pos, object indices) |
None | getLocalContainingCell (Vector3UL pos, object indices) |
None | getLocalContainingCell (ConstULVectorExpression pos, object indices) |
int | getObjectID () |
Returns the numeric identifier (ID) of the wrapped C++ class instance. More... | |
FRegularSpatialGrid | assign (ConstFGridExpression e) |
Replaces the current state of self with a copy of the state of the ConstFGridExpression instance e. More... | |
FRegularSpatialGrid | assign (ConstDGridExpression e) |
Replaces the current state of self with a copy of the state of the ConstDGridExpression instance e. More... | |
FRegularSpatialGrid | assign (object e) |
Replaces the current state of self with a copy of the state of the object instance e. More... | |
FRegularSpatialGrid | assign (FRegularSpatialGrid g) |
Replaces the current state of self with a copy of the state of the FRegularSpatialGrid instance g. More... | |
int | getSize1 () |
int | getSize2 () |
int | getSize3 () |
bool | isEmpty () |
float | getElement (int i, int j, int k) |
float | getElement (int i) |
object | toArray () |
int | getSize () |
None | swap (FRegularSpatialGrid g) |
None | setElement (int i, int j, int k, float v) |
None | setElement (int i, float v) |
float | __call__ (int i, int j, int k) |
float | __call__ (int i) |
float | __getitem__ (tuple ijk) |
float | __getitem__ (int i) |
int | __len__ () |
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... | |
str | __str__ () |
Returns a string representation of the FRegularSpatialGrid instance. More... | |
FRegularSpatialGrid | __pos__ () |
ConstFGridExpression | __neg__ () |
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... | |
ConstFGridExpression | __mul__ (float t) |
Returns the result of the multiplication operation self * t . More... | |
ConstFGridExpression | __div__ (float t) |
Returns the result of the division operation self / t . More... | |
ConstFGridExpression | __truediv__ (float t) |
ConstFGridExpression | __rmul__ (float t) |
None | __setitem__ (tuple ijk, float v) |
None | __setitem__ (int i, float v) |
FRegularSpatialGrid | __iadd__ (FRegularSpatialGrid g) |
Performs the in-place addition operation self += g . More... | |
FRegularSpatialGrid | __iadd__ (ConstFGridExpression e) |
Performs the in-place addition operation self += e . More... | |
FRegularSpatialGrid | __isub__ (FRegularSpatialGrid g) |
Performs the in-place subtraction operation self -= g . More... | |
FRegularSpatialGrid | __isub__ (ConstFGridExpression e) |
Performs the in-place subtraction operation self -= e . More... | |
FRegularSpatialGrid | __imul__ (float t) |
Performs the in-place multiplication operation self *= t . More... | |
FRegularSpatialGrid | __idiv__ (float t) |
Performs the in-place division operation self /= t . More... | |
FRegularSpatialGrid | __itruediv__ (float t) |
Properties | |
data = property(getData) | |
coordsTransform = property(getCoordinatesTransform, setCoordinatesTransform) | |
dataMode = property(getDataMode, setDataMode) | |
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) | |
An unbounded dense regular grid in 3D space holding floating point values of type float
.
None CDPL.Math.FRegularSpatialGrid.__init__ | ( | FRegularSpatialGrid | grid | ) |
Initializes a copy of the FRegularSpatialGrid instance grid.
grid | The FRegularSpatialGrid instance to copy. |
None CDPL.Math.FRegularSpatialGrid.__init__ | ( | FGrid | data, |
float | xs, | ||
float | ys, | ||
float | zs | ||
) |
Initializes the FRegularSpatialGrid instance.
data | |
xs | |
ys | |
zs |
None CDPL.Math.FRegularSpatialGrid.__init__ | ( | FGrid | data, |
float | s | ||
) |
Initializes the FRegularSpatialGrid instance.
data | |
s |
None CDPL.Math.FRegularSpatialGrid.__init__ | ( | float | xs, |
float | ys, | ||
float | zs | ||
) |
Initializes the FRegularSpatialGrid instance.
xs | |
ys | |
zs |
Reimplemented in CDPL.Grid.FRegularGrid.
None CDPL.Math.FRegularSpatialGrid.__init__ | ( | float | s | ) |
None CDPL.Math.FRegularSpatialGrid.resize | ( | int | m, |
int | n, | ||
int | o, | ||
bool | preserve = True , |
||
float | v = 0.0 |
||
) |
m | |
n | |
o | |
preserve | |
v |
None CDPL.Math.FRegularSpatialGrid.clear | ( | float | v = 0.0 | ) |
v |
DataMode CDPL.Math.FRegularSpatialGrid.getDataMode | ( | ) |
None CDPL.Math.FRegularSpatialGrid.setDataMode | ( | DataMode | mode | ) |
mode |
float CDPL.Math.FRegularSpatialGrid.getXExtent | ( | ) |
float CDPL.Math.FRegularSpatialGrid.getYExtent | ( | ) |
float CDPL.Math.FRegularSpatialGrid.getZExtent | ( | ) |
float CDPL.Math.FRegularSpatialGrid.getXStepSize | ( | ) |
float CDPL.Math.FRegularSpatialGrid.getYStepSize | ( | ) |
float CDPL.Math.FRegularSpatialGrid.getZStepSize | ( | ) |
None CDPL.Math.FRegularSpatialGrid.setXStepSize | ( | float | xs | ) |
xs |
None CDPL.Math.FRegularSpatialGrid.setYStepSize | ( | float | ys | ) |
ys |
None CDPL.Math.FRegularSpatialGrid.setZStepSize | ( | float | zs | ) |
zs |
FGrid CDPL.Math.FRegularSpatialGrid.getData | ( | ) |
None CDPL.Math.FRegularSpatialGrid.setCoordinatesTransform | ( | Matrix4F | xform | ) |
xform |
Matrix4F CDPL.Math.FRegularSpatialGrid.getCoordinatesTransform | ( | ) |
None CDPL.Math.FRegularSpatialGrid.getCoordinates | ( | int | i, |
int | j, | ||
int | k, | ||
object | coords | ||
) |
i | |
j | |
k | |
coords |
Reimplemented in CDPL.Grid.FRegularGrid.
None CDPL.Math.FRegularSpatialGrid.getCoordinates | ( | int | i, |
object | coords | ||
) |
i | |
coords |
Reimplemented in CDPL.Grid.FRegularGrid.
None CDPL.Math.FRegularSpatialGrid.getLocalCoordinates | ( | int | i, |
int | j, | ||
int | k, | ||
object | coords | ||
) |
i | |
j | |
k | |
coords |
None CDPL.Math.FRegularSpatialGrid.getLocalCoordinates | ( | Vector3F | world_coords, |
object | local_coords | ||
) |
world_coords | |
local_coords |
bool CDPL.Math.FRegularSpatialGrid.containsPoint | ( | Vector3F | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsPoint | ( | ConstFVectorExpression | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsPoint | ( | Vector3D | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsPoint | ( | ConstDVectorExpression | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsPoint | ( | Vector3L | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsPoint | ( | ConstLVectorExpression | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsPoint | ( | Vector3UL | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsPoint | ( | ConstULVectorExpression | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint | ( | Vector3F | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint | ( | ConstFVectorExpression | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint | ( | Vector3D | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint | ( | ConstDVectorExpression | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint | ( | Vector3L | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint | ( | ConstLVectorExpression | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint | ( | Vector3UL | pos | ) |
pos |
bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint | ( | ConstULVectorExpression | pos | ) |
pos |
None CDPL.Math.FRegularSpatialGrid.getContainingCell | ( | Vector3F | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getContainingCell | ( | ConstFVectorExpression | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getContainingCell | ( | Vector3D | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getContainingCell | ( | ConstDVectorExpression | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getContainingCell | ( | Vector3L | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getContainingCell | ( | ConstLVectorExpression | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getContainingCell | ( | Vector3UL | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getContainingCell | ( | ConstULVectorExpression | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell | ( | Vector3F | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell | ( | ConstFVectorExpression | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell | ( | Vector3D | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell | ( | ConstDVectorExpression | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell | ( | Vector3L | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell | ( | ConstLVectorExpression | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell | ( | Vector3UL | pos, |
object | indices | ||
) |
pos | |
indices |
None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell | ( | ConstULVectorExpression | pos, |
object | indices | ||
) |
pos | |
indices |
int CDPL.Math.FRegularSpatialGrid.getObjectID | ( | ) |
Returns the numeric identifier (ID) of the wrapped C++ class instance.
Different Python FRegularSpatialGrid instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b
thus cannot tell reliably whether the two FRegularSpatialGrid instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID()
.
FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.assign | ( | ConstFGridExpression | e | ) |
Replaces the current state of self with a copy of the state of the ConstFGridExpression instance e.
e | The ConstFGridExpression instance to copy. |
FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.assign | ( | ConstDGridExpression | e | ) |
Replaces the current state of self with a copy of the state of the ConstDGridExpression instance e.
e | The ConstDGridExpression instance to copy. |
FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.assign | ( | object | e | ) |
Replaces the current state of self with a copy of the state of the object instance e.
e | The object instance to copy. |
Reimplemented in CDPL.Grid.FRegularGrid.
FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.assign | ( | FRegularSpatialGrid | g | ) |
Replaces the current state of self with a copy of the state of the FRegularSpatialGrid instance g.
g | The FRegularSpatialGrid instance to copy. |
int CDPL.Math.FRegularSpatialGrid.getSize1 | ( | ) |
Reimplemented in CDPL.Grid.FRegularGrid.
int CDPL.Math.FRegularSpatialGrid.getSize2 | ( | ) |
Reimplemented in CDPL.Grid.FRegularGrid.
int CDPL.Math.FRegularSpatialGrid.getSize3 | ( | ) |
Reimplemented in CDPL.Grid.FRegularGrid.
bool CDPL.Math.FRegularSpatialGrid.isEmpty | ( | ) |
Reimplemented in CDPL.Grid.FRegularGrid.
float CDPL.Math.FRegularSpatialGrid.getElement | ( | int | i, |
int | j, | ||
int | k | ||
) |
float CDPL.Math.FRegularSpatialGrid.getElement | ( | int | i | ) |
object CDPL.Math.FRegularSpatialGrid.toArray | ( | ) |
Reimplemented in CDPL.Grid.FRegularGrid.
int CDPL.Math.FRegularSpatialGrid.getSize | ( | ) |
Reimplemented in CDPL.Grid.FRegularGrid.
None CDPL.Math.FRegularSpatialGrid.swap | ( | FRegularSpatialGrid | g | ) |
g |
None CDPL.Math.FRegularSpatialGrid.setElement | ( | int | i, |
int | j, | ||
int | k, | ||
float | v | ||
) |
i | |
j | |
k | |
v |
Reimplemented in CDPL.Grid.FRegularGrid.
None CDPL.Math.FRegularSpatialGrid.setElement | ( | int | i, |
float | v | ||
) |
i | |
v |
Reimplemented in CDPL.Grid.FRegularGrid.
float CDPL.Math.FRegularSpatialGrid.__call__ | ( | int | i, |
int | j, | ||
int | k | ||
) |
float CDPL.Math.FRegularSpatialGrid.__call__ | ( | int | i | ) |
float CDPL.Math.FRegularSpatialGrid.__getitem__ | ( | tuple | ijk | ) |
float CDPL.Math.FRegularSpatialGrid.__getitem__ | ( | int | i | ) |
int CDPL.Math.FRegularSpatialGrid.__len__ | ( | ) |
Reimplemented in CDPL.Grid.FRegularGrid.
bool CDPL.Math.FRegularSpatialGrid.__eq__ | ( | FRegularSpatialGrid | g | ) |
Returns the result of the comparison operation self == g
.
g | The FRegularSpatialGrid instance to be compared with. |
bool CDPL.Math.FRegularSpatialGrid.__eq__ | ( | ConstFGridExpression | e | ) |
Returns the result of the comparison operation self == e
.
e | The ConstFGridExpression instance to be compared with. |
bool CDPL.Math.FRegularSpatialGrid.__ne__ | ( | FRegularSpatialGrid | g | ) |
Returns the result of the comparison operation self != g
.
g | The FRegularSpatialGrid instance to be compared with. |
bool CDPL.Math.FRegularSpatialGrid.__ne__ | ( | ConstFGridExpression | e | ) |
Returns the result of the comparison operation self != e
.
e | The ConstFGridExpression instance to be compared with. |
str CDPL.Math.FRegularSpatialGrid.__str__ | ( | ) |
Returns a string representation of the FRegularSpatialGrid instance.
Reimplemented in CDPL.Grid.FRegularGrid.
FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.__pos__ | ( | ) |
Reimplemented in CDPL.Grid.FRegularGrid.
ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__neg__ | ( | ) |
Reimplemented in CDPL.Grid.FRegularGrid.
ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__add__ | ( | ConstFGridExpression | e | ) |
Returns the result of the addition operation self + e
.
e | Specifies the second addend. |
ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__sub__ | ( | ConstFGridExpression | e | ) |
Returns the result of the subtraction operation self - e
.
e | Specifies the subtrahend. |
ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__mul__ | ( | float | t | ) |
Returns the result of the multiplication operation self * t
.
t | Specifies the multiplier. |
Reimplemented in CDPL.Grid.FRegularGrid.
ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__div__ | ( | float | t | ) |
Returns the result of the division operation self / t
.
t | Specifies the divisor. |
Reimplemented in CDPL.Grid.FRegularGrid.
ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__truediv__ | ( | float | t | ) |
ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__rmul__ | ( | float | t | ) |
None CDPL.Math.FRegularSpatialGrid.__setitem__ | ( | tuple | ijk, |
float | v | ||
) |
ijk | |
v |
Reimplemented in CDPL.Grid.FRegularGrid.
None CDPL.Math.FRegularSpatialGrid.__setitem__ | ( | int | i, |
float | v | ||
) |
i | |
v |
Reimplemented in CDPL.Grid.FRegularGrid.
FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.__iadd__ | ( | FRegularSpatialGrid | g | ) |
Performs the in-place addition operation self += g
.
g | Specifies the second addend. |
FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.__iadd__ | ( | ConstFGridExpression | e | ) |
Performs the in-place addition operation self += e
.
e | Specifies the second addend. |
FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.__isub__ | ( | FRegularSpatialGrid | g | ) |
Performs the in-place subtraction operation self -= g
.
g | Specifies the subtrahend. |
FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.__isub__ | ( | ConstFGridExpression | e | ) |
Performs the in-place subtraction operation self -= e
.
e | Specifies the subtrahend. |
FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.__imul__ | ( | float | t | ) |
Performs the in-place multiplication operation self *= t
.
t | Specifies the multiplier. |
Reimplemented in CDPL.Grid.FRegularGrid.
FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.__idiv__ | ( | float | t | ) |
Performs the in-place division operation self /= t
.
t | Specifies the divisor. |
Reimplemented in CDPL.Grid.FRegularGrid.
FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.__itruediv__ | ( | float | t | ) |