.. _griddef:
.. public

Grid Definitions
################

GridDef Class
=============
.. autoclass:: pygeostat.data.grid_definition.GridDef

Copy
++++
.. automethod:: pygeostat.data.grid_definition.GridDef.copy

Block Volume
++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.blockvolume

Cell Count
++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.count

Change Block Number
+++++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.changeblocknum

Change Block Size
+++++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.changeblocksize

Convert To 2D
+++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.convert_to_2d

Convert Index: 3D to 1D
+++++++++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.index3d_to_index1d

Convert Index: 1D to 3D
+++++++++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.index1d_to_index3d

Coordinate(s) to 1D Index
+++++++++++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.coord_to_index1d

Coordinate(s) to 3D Index
+++++++++++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.coord_to_index3d

Pad Grid
++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.padgrid

Extents
+++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.extents

Extract Subgrid Around Points
+++++++++++++++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.extractsubgrid

Generate Grid Point Array
+++++++++++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.gridcoord

Iterate Through Grid XYZ
++++++++++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.iterxyz

Get Slice Index
+++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.get_sliceindex

Get 1D Start-End Index for Realization #
++++++++++++++++++++++++++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.get_rindex_start_end

Get Realization Index
+++++++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.get_realization_index

Grid String
+++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.__str__

Grid Array
++++++++++
.. automethod:: pygeostat.data.GridDef.gridarray

Origin
++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.origin

Outline Points
++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.outline_pts

Plot Grid Lines
+++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.plotgridlines

Random Points from Grid
+++++++++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.random_points

Random Indices from Grid
++++++++++++++++++++++++
.. automethod:: pygeostat.data.GridDef.random_indices

Set Axis Extents
++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.setaxisextents

Slice Coordinate
++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.get_slicecord

Slice Index
+++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.get_sliceindex

Vertical Indices
++++++++++++++++
.. automethod:: pygeostat.data.grid_definition.GridDef.xycoord_to_index1


Griddef from Centroid
=====================
.. autofunction:: pygeostat.data.grid_definition.griddef_from_centroid

Indexes Between Griddefs
========================
.. autofunction:: pygeostat.data.gridtools.grid_diff_idx