.. oe:namespace:: OESystem



.. meta::
   :keywords: OEScalarGrid, ScalarGrid


.. _OESystem_OEScalarGrid:

.. oe:class:: OEScalarGrid

   .. oe:api::


      class OEScalarGrid : public OEGrid<float>

   This class represents `OEScalarGrid`.

   An :ref:`OEScalarGrid <OESystem_OEScalarGrid>` represents a cubic grid with regular intervals in Cartesian space.


   The following methods are publicly inherited from :ref:`OEGrid <OESystem_OEGrid>`:

   ===================================================== ==================================================== ====================================================
   :oe:meth:`operator=<OESystem::OEGrid::operator=>`     :oe:meth:`SetAll<OESystem::OEGrid::SetAll>`          :oe:meth:`SetXMid<OESystem::OEGrid::SetXMid>`       
   :oe:meth:`Clear<OESystem::OEGrid::Clear>`             :oe:meth:`SetDim<OESystem::OEGrid::SetDim>`          :oe:meth:`SetYDim<OESystem::OEGrid::SetYDim>`       
   :oe:meth:`CreateCopy<OESystem::OEGrid::CreateCopy>`   :oe:meth:`SetMid<OESystem::OEGrid::SetMid>`          :oe:meth:`SetYMid<OESystem::OEGrid::SetYMid>`       
   :oe:meth:`GetDataType<OESystem::OEGrid::GetDataType>` :oe:meth:`SetSpacing<OESystem::OEGrid::SetSpacing>`  :oe:meth:`SetZDim<OESystem::OEGrid::SetZDim>`       
   :oe:meth:`IsDataType<OESystem::OEGrid::IsDataType>`   :oe:meth:`SetXDim<OESystem::OEGrid::SetXDim>`        :oe:meth:`SetZMid<OESystem::OEGrid::SetZMid>`       
   ===================================================== ==================================================== ====================================================

   The following methods are publicly inherited from :ref:`OEFixedGrid <OESystem_OEFixedGrid>`:

   ========================================================= ========================================================== =========================================================
   :oe:meth:`operator()<OESystem::OEFixedGrid::operator()>`  :oe:meth:`GetDataType<OESystem::OEFixedGrid::GetDataType>` :oe:meth:`SetValues<OESystem::OEFixedGrid::SetValues>`   
   :oe:meth:`operator[]<OESystem::OEFixedGrid::operator[]>`  :oe:meth:`GetValues<OESystem::OEFixedGrid::GetValues>`                                                              
   :oe:meth:`CreateCopy<OESystem::OEFixedGrid::CreateCopy>`  :oe:meth:`IsDataType<OESystem::OEFixedGrid::IsDataType>`                                                            
   ========================================================= ========================================================== =========================================================

   The following methods are publicly inherited from :ref:`OEGridBase <OESystem_OEGridBase>`:

   ============================================================================= ============================================================================ =============================================================================
   :oe:meth:`Clear<OESystem::OEGridBase::Clear>`                                 :oe:meth:`GetXMid<OESystem::OEGridBase::GetXMid>`                            :oe:meth:`GetZMin<OESystem::OEGridBase::GetZMin>`                            
   :oe:meth:`CreateCopy<OESystem::OEGridBase::CreateCopy>`                       :oe:meth:`GetXMin<OESystem::OEGridBase::GetXMin>`                            :oe:meth:`GridIdxToElement<OESystem::OEGridBase::GridIdxToElement>`          
   :oe:meth:`ElementToGridIdx<OESystem::OEGridBase::ElementToGridIdx>`           :oe:meth:`GetY<OESystem::OEGridBase::GetY>`                                  :oe:meth:`GridIdxToSpatialCoord<OESystem::OEGridBase::GridIdxToSpatialCoord>`
   :oe:meth:`ElementToSpatialCoord<OESystem::OEGridBase::ElementToSpatialCoord>` :oe:meth:`GetYDim<OESystem::OEGridBase::GetYDim>`                            :oe:meth:`IsDataType<OESystem::OEGridBase::IsDataType>`                      
   :oe:meth:`GetDataType<OESystem::OEGridBase::GetDataType>`                     :oe:meth:`GetYIdx<OESystem::OEGridBase::GetYIdx>`                            :oe:meth:`IsInGrid<OESystem::OEGridBase::IsInGrid>`                          
   :oe:meth:`GetDim<OESystem::OEGridBase::GetDim>`                               :oe:meth:`GetYInc<OESystem::OEGridBase::GetYInc>`                            :oe:meth:`IsSpacingSet<OESystem::OEGridBase::IsSpacingSet>`                  
   :oe:meth:`GetMid<OESystem::OEGridBase::GetMid>`                               :oe:meth:`GetYMax<OESystem::OEGridBase::GetYMax>`                            :oe:meth:`IsTitleSet<OESystem::OEGridBase::IsTitleSet>`                      
   :oe:meth:`GetSize<OESystem::OEGridBase::GetSize>`                             :oe:meth:`GetYMid<OESystem::OEGridBase::GetYMid>`                            :oe:meth:`IsXMidSet<OESystem::OEGridBase::IsXMidSet>`                        
   :oe:meth:`GetSpacing<OESystem::OEGridBase::GetSpacing>`                       :oe:meth:`GetYMin<OESystem::OEGridBase::GetYMin>`                            :oe:meth:`IsYMidSet<OESystem::OEGridBase::IsYMidSet>`                        
   :oe:meth:`GetTitle<OESystem::OEGridBase::GetTitle>`                           :oe:meth:`GetZ<OESystem::OEGridBase::GetZ>`                                  :oe:meth:`IsZMidSet<OESystem::OEGridBase::IsZMidSet>`                        
   :oe:meth:`GetX<OESystem::OEGridBase::GetX>`                                   :oe:meth:`GetZDim<OESystem::OEGridBase::GetZDim>`                            :oe:meth:`SetTitle<OESystem::OEGridBase::SetTitle>`                          
   :oe:meth:`GetXDim<OESystem::OEGridBase::GetXDim>`                             :oe:meth:`GetZIdx<OESystem::OEGridBase::GetZIdx>`                            :oe:meth:`SpatialCoordToElement<OESystem::OEGridBase::SpatialCoordToElement>`
   :oe:meth:`GetXIdx<OESystem::OEGridBase::GetXIdx>`                             :oe:meth:`GetZInc<OESystem::OEGridBase::GetZInc>`                            :oe:meth:`SpatialCoordToGridIdx<OESystem::OEGridBase::SpatialCoordToGridIdx>`
   :oe:meth:`GetXInc<OESystem::OEGridBase::GetXInc>`                             :oe:meth:`GetZMax<OESystem::OEGridBase::GetZMax>`                                                                                                         
   :oe:meth:`GetXMax<OESystem::OEGridBase::GetXMax>`                             :oe:meth:`GetZMid<OESystem::OEGridBase::GetZMid>`                                                                                                         
   ============================================================================= ============================================================================ =============================================================================

   The following methods are publicly inherited from :ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>`:

   ================================================================== ================================================================== ===================================================================
   :oe:meth:`Clear<OESystem::OEGridAbstractBase::Clear>`              :oe:meth:`GetTitle<OESystem::OEGridAbstractBase::GetTitle>`        :oe:meth:`GetZMid<OESystem::OEGridAbstractBase::GetZMid>`          
   :oe:meth:`GetDataType<OESystem::OEGridAbstractBase::GetDataType>`  :oe:meth:`GetXDim<OESystem::OEGridAbstractBase::GetXDim>`          :oe:meth:`IsDataType<OESystem::OEGridAbstractBase::IsDataType>`    
   :oe:meth:`GetDim<OESystem::OEGridAbstractBase::GetDim>`            :oe:meth:`GetXMid<OESystem::OEGridAbstractBase::GetXMid>`          :oe:meth:`IsSpacingSet<OESystem::OEGridAbstractBase::IsSpacingSet>`
   :oe:meth:`GetMid<OESystem::OEGridAbstractBase::GetMid>`            :oe:meth:`GetYDim<OESystem::OEGridAbstractBase::GetYDim>`          :oe:meth:`SetTitle<OESystem::OEGridAbstractBase::SetTitle>`        
   :oe:meth:`GetSize<OESystem::OEGridAbstractBase::GetSize>`          :oe:meth:`GetYMid<OESystem::OEGridAbstractBase::GetYMid>`                                                                             
   :oe:meth:`GetSpacing<OESystem::OEGridAbstractBase::GetSpacing>`    :oe:meth:`GetZDim<OESystem::OEGridAbstractBase::GetZDim>`                                                                             
   ================================================================== ================================================================== ===================================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEScalarGrid()

      .. oe:language:: python

         .. oe:api:: python

            OEScalarGrid() -> OEScalarGrid

      Creates a one point :ref:`OEScalarGrid <OESystem_OEScalarGrid>` grid object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEScalarGrid(const OEScalarGrid& rhs)
            OEScalarGrid(const OEFixedGrid<float>& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEScalarGrid(rhs: OEScalarGrid) -> OEScalarGrid
            OEScalarGrid(rhs: OEFixedFloatGrid) -> OEScalarGrid

      Creates a :ref:`OEScalarGrid <OESystem_OEScalarGrid>` object and copies the entire contents of the 'rhs' grid.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEScalarGrid(float minmax[6], float spacing, const char* title = "")
            OEScalarGrid(double minmax[6], double spacing,
                         const char* title = "")

      .. oe:language:: python

         .. oe:api:: python

            OEScalarGrid(minmax: OEFloatArray, spacing: float, title: str = "") -> OEScalarGrid
            OEScalarGrid(minmax: OEDoubleArray, spacing: float, title: str = "") -> OEScalarGrid

      Creates a :ref:`OEScalarGrid <OESystem_OEScalarGrid>` object from a minimum bounding box ('minmax').
      The size of each length between grid points is determined by the 'spacing' parameter. 
      The 'title' parameter is provided as a convenience for setting the title upon construction. 
      It can later be retrieved with the :oe:meth:`OESystem::OEGridBase::GetTitle` method.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEScalarGrid(int xdim, int ydim, int zdim, float midx, float midy,
                         float midz, float spacing, std::string title = "",
                         float* dataptr = 0)

      .. oe:language:: python

         .. oe:api:: python

            OEScalarGrid(xdim: int, ydim: int, zdim: int, midx: float,
                         midy: float, midz: float, spacing: float,
                         title: str = "", dataptr: OEFloatArray = None) -> OEScalarGrid

      Creates and initializes a :ref:`OEScalarGrid <OESystem_OEScalarGrid>` object. The
      grid data can be copied from the optional parameter
      'dataptr'. The pointer should be an array of size
      ``xdim*ydim*zdim*sizeof(float)``.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEScalarGrid& operator=(const OEScalarGrid& rhs)
         OEScalarGrid& operator=(const OEFixedGrid<float>& rhs)

      Copies the contents of 'rhs' grid.

      Assignment operator.


   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Reallocates memory for the grid, effectively clearing all the grid values. 
      Calls through to :oe:meth:`OESystem::OEBase::Clear`.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEScalarGrid

      Makes a copy of the grid instance.

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

      Returns the data type of the grid.

   .. oe:method:: GetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetType() const

      .. oe:language:: python

         .. oe:api:: python

            GetType() -> int

      Returns the data type tag for the grid.

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void* type) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(type: void) -> bool

      Returns whether type is the same as the instance this method is called on
      (*i.e.* :ref:`OEScalarGrid <OESystem_OEScalarGrid>`).

   .. oe:method:: SetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetType(unsigned int t)

      .. oe:language:: python

         .. oe:api:: python

            SetType(t: int) -> bool

      Sets the tag associated with this grid.

