class documentation
Sampling volume class.
Method | __init__ |
Initializes an empty sampling volume, with zero bounds and no constraints. |
Method | recalculate |
Recalculates the sampling volume points, permeabilities, labels and neighborhoods according to the constraints. |
Method | set |
Sets the parameters. |
Method | set |
Adjusts this volume's bounding box to fully enclose a 3D wire curve. This expands the bounding box to the next integer grid coordinates. |
Method | set |
Shrinks or enlarges this volume's bounding box by some amount, in each direction, symmetrically. This shrinks or expands the bounding box to the next integer grid coordinates. |
Instance Variable | resolution |
Undocumented |
Property | bounds |
Returns this volume's bounding box. |
Property | dimension |
Sampling volume dimension if it is valid, None otherwise. |
Property | extent |
Returns this volume's extent. |
Property | labeled |
Returns this sampling volume's labeled indices. |
Property | labels |
Returns this sampling volume's label count. |
Property | neighbor |
Returns this sampling volume's neighborhood indices. |
Property | permeabilities |
Returns this sampling volume's relative permeabilities µ_r. |
Property | points |
Returns this sampling volume's points. |
Property | points |
Returns this sampling volume's point count. |
Method | _i |
Convert 1D index to 3D indices. Note: "Fortran" indexing (column-major order). |
Method | _xyz |
Convert 3D indices to 1D index. Note: "Fortran" indexing (column-major order). |
Instance Variable | _bounds |
Undocumented |
Instance Variable | _bounds |
Undocumented |
Instance Variable | _constraints |
Undocumented |
Instance Variable | _dimension |
Undocumented |
Instance Variable | _label |
Undocumented |
Instance Variable | _labeled |
Undocumented |
Instance Variable | _neighbor |
Undocumented |
Instance Variable | _permeabilities |
Undocumented |
Instance Variable | _points |
Undocumented |
Inherited from Validatable
:
Method | valid |
No summary |
Property | valid |
True if valid, False if invalid |
Instance Variable | _valid |
Undocumented |
Recalculates the sampling volume points, permeabilities, labels and neighborhoods according to the constraints.
Parameters | |
progressCallable | Progress callback |
Returns | |
bool | True if successful, False if interrupted |
Sets the parameters.
Parameters | |
resolution:float | Resolution |
labelfloat | Label resolution |
constraints:list[ | List of constraints |
Adjusts this volume's bounding box to fully enclose a 3D wire curve. This expands the bounding box to the next integer grid coordinates.
Note: This will not automatically invalidate the sampling volume.
Parameters | |
bounds:np.ndarray | Bounding box (minimum bounds, maximum bounds) |
Returns | |
Rounded (_bounds_min, _bounds_max) |
Shrinks or enlarges this volume's bounding box by some amount, in each direction, symmetrically. This shrinks or expands the bounding box to the next integer grid coordinates.
Note: This will not automatically invalidate the sampling volume.
Parameters | |
padding:np.ndarray | Amount of padding (3D point) |
Convert 1D index to 3D indices. Note: "Fortran" indexing (column-major order).
Parameters | |
_i:int | 1D index |
Returns | |
list | 3D indices |