![]() |
Chemical Data Processing Library Python API - Version 1.4.0
|
A regular 3D 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 a RegularGrid initialized from data, with the given grid spacing in x, y and z direction. More... | |
| None | __init__ (Math.FGrid data, float s) |
Constructs a RegularGrid initialized from data with isotropic grid spacing. More... | |
| None | __init__ (float xs, float ys, float zs) |
Constructs an empty RegularGrid with the given grid spacing in x, y and z direction. More... | |
| None | __init__ (float s) |
Constructs an empty RegularGrid with isotropic grid spacing. More... | |
| None | getCoordinates (int i, int j, int k, object coords) |
| None | getCoordinates (int i, object coords) |
| Returns the 3D coordinates of the grid element at linear index i. More... | |
| Math.FRegularSpatialGrid | assign (Math.ConstFGridExpression e) |
Replaces the current state of self with a copy of the state of the ConstFGridExpression instance e. More... | |
| Math.FRegularSpatialGrid | assign (Math.ConstDGridExpression e) |
Replaces the current state of self with a copy of the state of the ConstDGridExpression instance e. More... | |
| Math.FRegularSpatialGrid | assign (object e) |
Replaces the current state of self with a copy of the state of the object instance e. 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 () |
| int | getSize2 () |
| int | getSize3 () |
| bool | isEmpty () |
| Tells whether the grid is empty. More... | |
| float | getElement (int i, int j, int k) |
| float | getElement (int i) |
| object | toArray () |
| int | getSize () |
| 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__ () |
| float | __call__ (int i, int j, int k) |
| float | __call__ (int i) |
| Returns a reference to the grid element at 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) |
Performs the in-place addition operation self += e. More... | |
| Math.FRegularSpatialGrid | __isub__ (Math.FRegularSpatialGrid g) |
Performs the in-place subtraction operation self -= g. More... | |
| Math.FRegularSpatialGrid | __isub__ (Math.ConstFGridExpression e) |
Performs the in-place subtraction operation self -= e. More... | |
| Math.FRegularSpatialGrid | __imul__ (float t) |
Performs the in-place multiplication operation self *= t. More... | |
| Math.FRegularSpatialGrid | __idiv__ (float t) |
Performs the in-place division operation self /= t. More... | |
| Math.FRegularSpatialGrid | __itruediv__ (float t) |
Public Member Functions inherited from CDPL.Grid.FSpatialGrid | |
| None | __init__ () |
Initializes the FSpatialGrid instance. | |
| int | getNumElements () |
| None | getCoordinates (int i, Math.Vector3F coords) |
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) |
| 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) |
Initializes the FRegularSpatialGrid instance. More... | |
| None | __init__ (FGrid data, 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) |
| 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 | 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 (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) |
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... | |
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) | |
A regular 3D spatial grid storing single-precision floating-point values.
| None CDPL.Grid.FRegularGrid.__init__ | ( | FRegularGrid | grid | ) |
Initializes a copy of the FRegularGrid instance grid.
| grid | The FRegularGrid instance to copy. |
| None CDPL.Grid.FRegularGrid.__init__ | ( | Math.FGrid | data, |
| float | xs, | ||
| float | ys, | ||
| float | zs | ||
| ) |
Constructs a RegularGrid initialized from data, with the given grid spacing in x, y and z direction.
| data | The initial grid data. |
| xs | The grid spacing in the x direction. |
| ys | The grid spacing in the y direction. |
| zs | The grid spacing in the z direction. |
| None CDPL.Grid.FRegularGrid.__init__ | ( | Math.FGrid | data, |
| float | s | ||
| ) |
Constructs a RegularGrid initialized from data with isotropic grid spacing.
| data | The initial grid data. |
| s | The isotropic grid spacing applied to all three spatial dimensions. |
| None CDPL.Grid.FRegularGrid.__init__ | ( | float | xs, |
| float | ys, | ||
| float | zs | ||
| ) |
Constructs an empty RegularGrid with the given grid spacing in x, y and z direction.
| xs | The grid spacing in the x direction. |
| ys | The grid spacing in the y direction. |
| zs | The grid spacing in the z direction. |
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| None CDPL.Grid.FRegularGrid.__init__ | ( | float | s | ) |
Constructs an empty RegularGrid with isotropic grid spacing.
| s | The isotropic grid spacing applied to all three spatial dimensions. |
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| None CDPL.Grid.FRegularGrid.getCoordinates | ( | int | i, |
| int | j, | ||
| int | k, | ||
| object | coords | ||
| ) |
| i | |
| j | |
| k | |
| coords |
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| None CDPL.Grid.FRegularGrid.getCoordinates | ( | int | i, |
| object | coords | ||
| ) |
Returns the 3D coordinates of the grid element at linear index i.
| i | The linear element index. |
| coords | The output coordinates. |
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.assign | ( | Math.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. |
| Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.assign | ( | Math.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. |
| Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.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 from CDPL.Math.FRegularSpatialGrid.
| 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.
| g | The FRegularSpatialGrid instance to copy. |
| int CDPL.Grid.FRegularGrid.getSize1 | ( | ) |
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| int CDPL.Grid.FRegularGrid.getSize2 | ( | ) |
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| int CDPL.Grid.FRegularGrid.getSize3 | ( | ) |
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| bool CDPL.Grid.FRegularGrid.isEmpty | ( | ) |
Tells whether the grid is empty.
True if the grid is empty, and False otherwise. Reimplemented from CDPL.Grid.FSpatialGrid.
| float CDPL.Grid.FRegularGrid.getElement | ( | int | i, |
| int | j, | ||
| int | k | ||
| ) |
| float CDPL.Grid.FRegularGrid.getElement | ( | int | i | ) |
| object CDPL.Grid.FRegularGrid.toArray | ( | ) |
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| int CDPL.Grid.FRegularGrid.getSize | ( | ) |
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| None CDPL.Grid.FRegularGrid.swap | ( | Math.FRegularSpatialGrid | g | ) |
| g |
| None CDPL.Grid.FRegularGrid.setElement | ( | int | i, |
| int | j, | ||
| int | k, | ||
| float | v | ||
| ) |
| i | |
| j | |
| k | |
| v |
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| None CDPL.Grid.FRegularGrid.setElement | ( | int | i, |
| float | v | ||
| ) |
| i | |
| v |
Reimplemented from CDPL.Grid.FSpatialGrid.
| Base.Any CDPL.Grid.FRegularGrid.__getitem__ | ( | Base.LookupKey | key | ) |
| float CDPL.Grid.FRegularGrid.__getitem__ | ( | tuple | ijk | ) |
| float CDPL.Grid.FRegularGrid.__getitem__ | ( | int | i | ) |
| bool CDPL.Grid.FRegularGrid.__contains__ | ( | Base.LookupKey | key | ) |
Returns the result of the membership test operation key in self.
| key | The value to test for membership. |
Reimplemented from CDPL.Grid.FSpatialGrid.
| None CDPL.Grid.FRegularGrid.__setitem__ | ( | Base.LookupKey | key, |
| Base.Any | value | ||
| ) |
| key | |
| value |
Reimplemented from CDPL.Grid.FSpatialGrid.
| None CDPL.Grid.FRegularGrid.__setitem__ | ( | tuple | ijk, |
| float | v | ||
| ) |
| ijk | |
| v |
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| None CDPL.Grid.FRegularGrid.__setitem__ | ( | int | i, |
| float | v | ||
| ) |
| i | |
| v |
Reimplemented from CDPL.Grid.FSpatialGrid.
| bool CDPL.Grid.FRegularGrid.__delitem__ | ( | Base.LookupKey | key | ) |
| int CDPL.Grid.FRegularGrid.__len__ | ( | ) |
Reimplemented from CDPL.Grid.FSpatialGrid.
| float CDPL.Grid.FRegularGrid.__call__ | ( | int | i, |
| int | j, | ||
| int | k | ||
| ) |
| float CDPL.Grid.FRegularGrid.__call__ | ( | int | i | ) |
Returns a reference to the grid element at linear index i.
| i | The linear element index. |
Reimplemented from CDPL.Grid.FSpatialGrid.
| bool CDPL.Grid.FRegularGrid.__eq__ | ( | Math.FRegularSpatialGrid | g | ) |
Returns the result of the comparison operation self == g.
| g | The FRegularSpatialGrid instance to be compared with. |
| bool CDPL.Grid.FRegularGrid.__eq__ | ( | Math.ConstFGridExpression | e | ) |
Returns the result of the comparison operation self == e.
| e | The ConstFGridExpression instance to be compared with. |
| bool CDPL.Grid.FRegularGrid.__ne__ | ( | Math.FRegularSpatialGrid | g | ) |
Returns the result of the comparison operation self != g.
| g | The FRegularSpatialGrid instance to be compared with. |
| bool CDPL.Grid.FRegularGrid.__ne__ | ( | Math.ConstFGridExpression | e | ) |
Returns the result of the comparison operation self != e.
| e | The ConstFGridExpression instance to be compared with. |
| str CDPL.Grid.FRegularGrid.__str__ | ( | ) |
Returns a string representation of the FRegularGrid instance.
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__pos__ | ( | ) |
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| Math.ConstFGridExpression CDPL.Grid.FRegularGrid.__neg__ | ( | ) |
Reimplemented from CDPL.Math.FRegularSpatialGrid.
| Math.ConstFGridExpression CDPL.Grid.FRegularGrid.__add__ | ( | Math.ConstFGridExpression | e | ) |
Returns the result of the addition operation self + e.
| e | Specifies the second addend. |
Math.ConstFGridExpression instance holding the result of the addition. | Math.ConstFGridExpression CDPL.Grid.FRegularGrid.__sub__ | ( | Math.ConstFGridExpression | e | ) |
Returns the result of the subtraction operation self - e.
| e | Specifies the subtrahend. |
FRegularGrid instance holding the result of the subtraction. | Math.ConstFGridExpression CDPL.Grid.FRegularGrid.__mul__ | ( | float | t | ) |
Returns the result of the multiplication operation self * t.
| t | Specifies the multiplier. |
Math.ConstFGridExpression instance holding the result of the multiplication. Reimplemented from CDPL.Math.FRegularSpatialGrid.
| Math.ConstFGridExpression CDPL.Grid.FRegularGrid.__div__ | ( | float | t | ) |
Returns the result of the division operation self // t.
| t | Specifies the divisor. |
Math.ConstFGridExpression instance holding the result of the division. Reimplemented from CDPL.Math.FRegularSpatialGrid.
| Math.ConstFGridExpression CDPL.Grid.FRegularGrid.__truediv__ | ( | float | t | ) |
Returns the result of the true division operation self / t.
| t | Specifies the divisor. |
Math.ConstFGridExpression instance holding the result of the division. Reimplemented from CDPL.Math.FRegularSpatialGrid.
| Math.ConstFGridExpression CDPL.Grid.FRegularGrid.__rmul__ | ( | float | t | ) |
Returns the result of the multiplication operation t * self.
| t | Specifies the multiplicand. |
Math.ConstFGridExpression instance holding the result of the multiplication. Reimplemented from CDPL.Math.FRegularSpatialGrid.
| Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__iadd__ | ( | Math.FRegularSpatialGrid | g | ) |
Performs the in-place addition operation self += g.
| g | Specifies the second addend. |
Math.FRegularSpatialGrid instance self. | Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__iadd__ | ( | Math.ConstFGridExpression | e | ) |
Performs the in-place addition operation self += e.
| e | Specifies the second addend. |
Math.FRegularSpatialGrid instance self. | Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__isub__ | ( | Math.FRegularSpatialGrid | g | ) |
Performs the in-place subtraction operation self -= g.
| g | Specifies the subtrahend. |
Math.FRegularSpatialGrid instance self. | Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__isub__ | ( | Math.ConstFGridExpression | e | ) |
Performs the in-place subtraction operation self -= e.
| e | Specifies the subtrahend. |
Math.FRegularSpatialGrid instance self. | Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__imul__ | ( | float | t | ) |
Performs the in-place multiplication operation self *= t.
| t | Specifies the multiplier. |
Math.FRegularSpatialGrid instance self. Reimplemented from CDPL.Math.FRegularSpatialGrid.
| Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__idiv__ | ( | float | t | ) |
Performs the in-place division operation self /= t.
| t | Specifies the divisor. |
Math.FRegularSpatialGrid instance self. Reimplemented from CDPL.Math.FRegularSpatialGrid.
| Math.FRegularSpatialGrid CDPL.Grid.FRegularGrid.__itruediv__ | ( | float | t | ) |