{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Class: VoxelGridData","description":"Accelerate E&P application development and protect your innovation by consuming our Data and Domain APIs / Platform APIs.","lang":"en-US","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":false}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/readme"},"children":["API"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d"},"children":["geotoolkit3d"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8"},"children":["data"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#reservoir"},"children":["reservoir"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#hexahedral"},"children":["hexahedral"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#voxel"},"children":["voxel"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#voxelgriddata"},"children":["VoxelGridData"]}," / VoxelGridData"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"class-voxelgriddata","__idx":0},"children":["Class: VoxelGridData"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#voxel"},"children":["voxel"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#voxelgriddata"},"children":["VoxelGridData"]},".VoxelGridData"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This class host the VoxelGrid data using hexahedral vector cell structure. Each cell has the same shape within the grid, defined by 3 vectors.<br>"," ","One value per cell can be added for both filtering and render coloration purpose.<br>"," ","Additionally, multiple additional data can be defined per cell to be used along user-defined filters,"," ","allowing for very customizable cell filtering.<br>"," ","The cell data format expected by the VoxelGridData constructor:<ul>"," ","<li>The voxel cell data format require 3 vectors to define the general cell shape.</li>"," ","<li>Cells do not need to be cubes, but opposite faces must be parallel.</li>"," ","<li>Cell values need to be passed as a contiguous 3D array, but it is possible to define empty cells by setting its value to NaN or a defined nullvalue.</li>"," ","</ul>"," ","The cells values are expected in the IJK order, see example<br>"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"ts","header":{"controls":{"copy":{}}},"source":"I |------&gt;\n\nA ------- B            __\n|\\        |\\            \\\n| \\       | \\            \\  J\n|  C ------- D     _      v\nE -|----- F  |     |\n\\ |       \\ |     | K\n\\|        \\|     |\nG ------- H     v\n","lang":"ts"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"hierarchy","__idx":1},"children":["Hierarchy"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.abstractreservoirdata.abstractreservoirdata"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AbstractReservoirData"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["↳ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VoxelGridData"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"table-of-contents","__idx":2},"children":["Table of contents"]},{"$$mdtype":"Tag","name":"details","attributes":{"open":"true"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"fontSize":"1.25em","fontWeight":"bold"}},"children":["Constructors"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["[new VoxelGridData(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.voxelgriddata.voxelgriddata.md#new voxelgriddata(options))"]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{"open":"true"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"fontSize":"1.25em","fontWeight":"bold"}},"children":["Methods"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"dispose"},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.voxelgriddata.voxelgriddata#dispose"},"children":["dispose"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"getCellIJKIterator"},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.voxelgriddata.voxelgriddata#getcellijkiterator"},"children":["getCellIJKIterator"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"getCellIJKbyIndex"},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.voxelgriddata.voxelgriddata#getcellijkbyindex"},"children":["getCellIJKbyIndex"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.voxelgriddata.voxelgriddata#getclassname"},"children":["getClassName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.voxelgriddata.voxelgriddata#getgridfullvolume"},"children":["getGridFullVolume"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.voxelgriddata.voxelgriddata#getijkcount"},"children":["getIJKCount"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.voxelgriddata.voxelgriddata#getindexforcell"},"children":["getIndexForCell"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.voxelgriddata.voxelgriddata#getmetadata"},"children":["getMetaData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.voxelgriddata.voxelgriddata#getnumberofcells"},"children":["getNumberOfCells"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.voxelgriddata.voxelgriddata#iscellindexvalid"},"children":["isCellIndexValid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.voxelgriddata.voxelgriddata#getclassname-1"},"children":["getClassName"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"contents","__idx":3},"children":["Contents"]},{"$$mdtype":"Tag","name":"details","attributes":{"open":"true"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"fontSize":"1.25em","fontWeight":"bold"}},"children":["Constructors"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"new-voxelgriddataoptions","__idx":4},"children":["new VoxelGridData(options)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["new VoxelGridData"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options"]},")"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"parameters","__idx":5},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"65%","data-label":"Name"},"children":["Name "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"35%","data-label":"Type"},"children":["Type "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#voxelgriddata#volumedata"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VolumeData"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"overrides","__idx":6},"children":["Overrides"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AbstractReservoirData.constructor"]}]},{"$$mdtype":"Tag","name":"details","attributes":{"open":"true"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"fontSize":"1.25em","fontWeight":"bold"}},"children":["Methods"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"dispose","__idx":7},"children":["dispose"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["dispose"]},"(): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["void"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Dispose this grid data to allow for garbage collection."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns","__idx":8},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["void"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getcellijkiterator","__idx":9},"children":["getCellIJKIterator"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getCellIJKIterator"]},"(): ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.cellijkiterator.cellijkiterator"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CellIJKIterator"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Return a cell iterator for this grid structure, conveniently iterating over each cell index and providing the relevant I,J & K indices."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-1","__idx":10},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.cellijkiterator.cellijkiterator"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CellIJKIterator"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["the Cell iterator"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getcellijkbyindex","__idx":11},"children":["getCellIJKbyIndex"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getCellIJKbyIndex"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["index"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["targetIJK?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[]"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Return the IJK index of the cell identified by the given position in the grid, in the format [i, j, k]."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"parameters-1","__idx":12},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"30%","data-label":"Name"},"children":["Name "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"20%","data-label":"Type"},"children":["Type "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%","data-label":"Description"},"children":["Description "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["index"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["the cell index in the grid. Index start at 0, and must be inferior to the total number of cells."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["targetIJK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["the optional array to contain the resulting i, j, k indices, to avoid new object creation."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-2","__idx":13},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[]"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getclassname","__idx":14},"children":["getClassName"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getClassName"]},"(): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-3","__idx":15},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"inherited-from","__idx":16},"children":["Inherited from"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.abstractreservoirdata.abstractreservoirdata"},"children":["AbstractReservoirData"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.abstractreservoirdata.abstractreservoirdata#getclassname"},"children":["getClassName"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getgridfullvolume","__idx":17},"children":["getGridFullVolume"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getGridFullVolume"]},"(): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the total volume measure of this grid.<br>"," ","Computed by the sum of the volume of every valid cells, ignoring current user filters.<br>"," ","The unit of the volume measurement is based on the unit used in cells coordinates, to user discretion."," ","(ex: if cells coordinates are in meters, then the volume will be in cubic meters. If feet, then cubic feet, and so on.)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-4","__idx":18},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getijkcount","__idx":19},"children":["getIJKCount"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getIJKCount"]},"(): ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.reservoir-2.ijkindex.ijkindex"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IJKIndex"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the ijk count for this VoxelGridData."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-5","__idx":20},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.reservoir-2.ijkindex.ijkindex"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IJKIndex"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getindexforcell","__idx":21},"children":["getIndexForCell"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getIndexForCell"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["i"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["j"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["k"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the index for the cell based on the given i j k index"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"parameters-2","__idx":22},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"65%","data-label":"Name"},"children":["Name "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"35%","data-label":"Type"},"children":["Type "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["i"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["j"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["k"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-6","__idx":23},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["index for this i j k cell (null if the cell doesn't exist)"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getmetadata","__idx":24},"children":["getMetaData"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getMetaData"]},"(): ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#voxelgriddata#gridmetadata"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GridMetaData"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Return this VoxelGrid's metadata"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-7","__idx":25},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#voxelgriddata#gridmetadata"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GridMetaData"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"overrides-1","__idx":26},"children":["Overrides"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.abstractreservoirdata.abstractreservoirdata"},"children":["AbstractReservoirData"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.abstractreservoirdata.abstractreservoirdata#getmetadata"},"children":["getMetaData"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getnumberofcells","__idx":27},"children":["getNumberOfCells"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getNumberOfCells"]},"(): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the number of cells in the data object. This also includes cells with NaN and nullvalues."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-8","__idx":28},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["number of cells"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"overrides-2","__idx":29},"children":["Overrides"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.abstractreservoirdata.abstractreservoirdata"},"children":["AbstractReservoirData"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.abstractreservoirdata.abstractreservoirdata#getnumberofcells"},"children":["getNumberOfCells"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"iscellindexvalid","__idx":30},"children":["isCellIndexValid"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["isCellIndexValid"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["index"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Return true if the given cell index match an existing cell with a valid value, false if not. Ignore user filters.<br>"," ","The cell must belong in the grid ijk bounds, and must be a valid value (must be a finite number different from the user-defined nullvalue)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"parameters-3","__idx":31},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"30%","data-label":"Name"},"children":["Name "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"20%","data-label":"Type"},"children":["Type "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%","data-label":"Description"},"children":["Description "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["index"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["the cell index to check the validity of."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-9","__idx":32},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["true if the cell index is valid, false if not."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getclassname-1","__idx":33},"children":["getClassName"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Static"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getClassName"]},"(): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-10","__idx":34},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"inherited-from-1","__idx":35},"children":["Inherited from"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.abstractreservoirdata.abstractreservoirdata"},"children":["AbstractReservoirData"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.abstractreservoirdata.abstractreservoirdata#getclassname-1"},"children":["getClassName"]}]}]}]},"headings":[{"value":"Class: VoxelGridData","id":"class-voxelgriddata","depth":1},{"value":"Hierarchy","id":"hierarchy","depth":2},{"value":"Table of contents","id":"table-of-contents","depth":2},{"value":"Contents","id":"contents","depth":2},{"value":"new VoxelGridData(options)","id":"new-voxelgriddataoptions","depth":4},{"value":"Parameters","id":"parameters","depth":4},{"value":"Overrides","id":"overrides","depth":4},{"value":"dispose","id":"dispose","depth":4},{"value":"Returns","id":"returns","depth":4},{"value":"getCellIJKIterator","id":"getcellijkiterator","depth":4},{"value":"Returns","id":"returns-1","depth":4},{"value":"getCellIJKbyIndex","id":"getcellijkbyindex","depth":4},{"value":"Parameters","id":"parameters-1","depth":4},{"value":"Returns","id":"returns-2","depth":4},{"value":"getClassName","id":"getclassname","depth":4},{"value":"Returns","id":"returns-3","depth":4},{"value":"Inherited from","id":"inherited-from","depth":4},{"value":"getGridFullVolume","id":"getgridfullvolume","depth":4},{"value":"Returns","id":"returns-4","depth":4},{"value":"getIJKCount","id":"getijkcount","depth":4},{"value":"Returns","id":"returns-5","depth":4},{"value":"getIndexForCell","id":"getindexforcell","depth":4},{"value":"Parameters","id":"parameters-2","depth":4},{"value":"Returns","id":"returns-6","depth":4},{"value":"getMetaData","id":"getmetadata","depth":4},{"value":"Returns","id":"returns-7","depth":4},{"value":"Overrides","id":"overrides-1","depth":4},{"value":"getNumberOfCells","id":"getnumberofcells","depth":4},{"value":"Returns","id":"returns-8","depth":4},{"value":"Overrides","id":"overrides-2","depth":4},{"value":"isCellIndexValid","id":"iscellindexvalid","depth":4},{"value":"Parameters","id":"parameters-3","depth":4},{"value":"Returns","id":"returns-9","depth":4},{"value":"getClassName","id":"getclassname-1","depth":4},{"value":"Returns","id":"returns-10","depth":4},{"value":"Inherited from","id":"inherited-from-1","depth":4}],"frontmatter":{"seo":{"title":"Class: VoxelGridData"}},"lastModified":"2026-10-22T14:32:05.425Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.voxelgriddata.voxelgriddata","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}