.. oe:namespace:: OESystem



.. meta::
   :keywords: OEGaussian, Gaussian


.. _OESystem_OEGaussian:

.. oe:class:: OEGaussian

   .. oe:api::


      class OEGaussian : public OEGaussianBase

   This class represents `OEGaussian`.

   The following methods are publicly inherited from :ref:`OEGaussianBase <OESystem_OEGaussianBase>`:

   =============================================================== =============================================================== ==============================================================
   :oe:meth:`GetCenter<OESystem::OEGaussianBase::GetCenter>`       :oe:meth:`GetY<OESystem::OEGaussianBase::GetY>`                 :oe:meth:`SetWidth<OESystem::OEGaussianBase::SetWidth>`       
   :oe:meth:`GetColor<OESystem::OEGaussianBase::GetColor>`         :oe:meth:`GetZ<OESystem::OEGaussianBase::GetZ>`                 :oe:meth:`SetX<OESystem::OEGaussianBase::SetX>`               
   :oe:meth:`GetDataType<OESystem::OEGaussianBase::GetDataType>`   :oe:meth:`IsDataType<OESystem::OEGaussianBase::IsDataType>`     :oe:meth:`SetY<OESystem::OEGaussianBase::SetY>`               
   :oe:meth:`GetPrefactor<OESystem::OEGaussianBase::GetPrefactor>` :oe:meth:`SetCenter<OESystem::OEGaussianBase::SetCenter>`       :oe:meth:`SetZ<OESystem::OEGaussianBase::SetZ>`               
   :oe:meth:`GetWidth<OESystem::OEGaussianBase::GetWidth>`         :oe:meth:`SetColor<OESystem::OEGaussianBase::SetColor>`                                                                       
   :oe:meth:`GetX<OESystem::OEGaussianBase::GetX>`                 :oe:meth:`SetPrefactor<OESystem::OEGaussianBase::SetPrefactor>`                                                               
   =============================================================== =============================================================== ==============================================================

   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::

            OEGaussian()
            OEGaussian(const OEGaussian& rhs)
            OEGaussian(const OEGaussianBase& rhs)
            OEGaussian(float prefactor, float width, float* xyz = 0,
                       unsigned int color = 0)
            OEGaussian(float prefactor, float width, float x, float y, float z,
                       unsigned int color = 0)

      .. oe:language:: python

         .. oe:api:: python

            OEGaussian() -> OEGaussian
            OEGaussian(prefactor: float, width: float,
                       xyz: OEFloatArray = None, color: int = 0) -> OEGaussian
            OEGaussian(prefactor: float, width: float, x: float, y: float,
                       z: float, color: int = 0) -> OEGaussian
            OEGaussian(rhs: OEGaussian) -> OEGaussian
            OEGaussian(rhs: OEGaussianBase) -> OEGaussian

      Default and copy constructors.

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

      .. oe:api::

         OEGaussian& operator=(const OEGaussian& rhs)
         OEGaussian& operator=(const OEGaussianBase& rhs)

      Assignment operator.


   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEGaussian

   .. oe:method:: GetCenter

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

         .. oe:api::

            void GetCenter(float* xyz) const

      .. oe:language:: python

         .. oe:api:: python

            GetCenter(xyz: OEFloatArray) -> None

   .. oe:method:: GetColor

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

         .. oe:api::

            unsigned int GetColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> int

   .. oe:method:: GetDataType

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

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

   .. oe:method:: GetPrefactor

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

         .. oe:api::

            float GetPrefactor() const

      .. oe:language:: python

         .. oe:api:: python

            GetPrefactor() -> float

   .. oe:method:: GetWidth

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

         .. oe:api::

            float GetWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetWidth() -> float

   .. oe:method:: GetX

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

         .. oe:api::

            float GetX() const

      .. oe:language:: python

         .. oe:api:: python

            GetX() -> float

   .. oe:method:: GetY

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

         .. oe:api::

            float GetY() const

      .. oe:language:: python

         .. oe:api:: python

            GetY() -> float

   .. oe:method:: GetZ

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

         .. oe:api::

            float GetZ() const

      .. oe:language:: python

         .. oe:api:: python

            GetZ() -> float

   .. oe:method:: IsDataType

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

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

   .. oe:method:: SetCenter

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

         .. oe:api::

            void SetCenter(float* xyz)

      .. oe:language:: python

         .. oe:api:: python

            SetCenter(xyz: OEFloatArray) -> None

   .. oe:method:: SetColor

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

         .. oe:api::

            void SetColor(unsigned int color)

      .. oe:language:: python

         .. oe:api:: python

            SetColor(color: int) -> None

   .. oe:method:: SetPrefactor

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

         .. oe:api::

            void SetPrefactor(float prefactor)

      .. oe:language:: python

         .. oe:api:: python

            SetPrefactor(prefactor: float) -> None

   .. oe:method:: SetWidth

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

         .. oe:api::

            void SetWidth(float width)

      .. oe:language:: python

         .. oe:api:: python

            SetWidth(width: float) -> None

   .. oe:method:: SetX

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

         .. oe:api::

            void SetX(float x)

      .. oe:language:: python

         .. oe:api:: python

            SetX(x: float) -> None

   .. oe:method:: SetY

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

         .. oe:api::

            void SetY(float y)

      .. oe:language:: python

         .. oe:api:: python

            SetY(y: float) -> None

   .. oe:method:: SetZ

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

         .. oe:api::

            void SetZ(float z)

      .. oe:language:: python

         .. oe:api:: python

            SetZ(z: float) -> None

