.. SPDX-FileCopyrightText: 2021 Intel Corporation
..
.. SPDX-License-Identifier: CC-BY-4.0

.. _image-image-class:

Image_Image Class
==================


.. rubric:: Description
  :class: sectiontitle

The ``image_image`` class is an image implementation using image memory with
:ref:`ROI<image-regions-of-interest>` support.
It must be the base class for the :ref:`Image class<image-class>` 
with ``oneapi::ipl::formats::rgba`` format.
This class is not recommended for use as a parameter in oneIPL image processing functions, 
use :ref:`Image class<image-class>` instead.

.. rubric:: Include Files
  :class: sectiontitle

``oneapi/ipl.hpp``


.. rubric:: Domain Dependencies
  :class: sectiontitle

Headers: ``oneapi/ipl.hpp``

Libraries: ``oneipl.lib``


.. rubric:: Syntax
   :class: sectiontitle

.. doxygenclass:: oneapi::ipl::image_image
  :project: oneIPL
  :members:


Supported values for Format:

.. list-table::
    :header-rows: 0

    * -     ``rgba``


Supported values for DataT:

.. list-table::
    :header-rows: 0

    * -     ``std::int8_t``
    * -     ``std::uint8_t``
    * -     ``std::int16_t``
    * -     ``std::uint16_t``
    * -     ``std::int32_t``
    * -     ``std::uint32_t``
    * -     ``float``