API Documentation
#################

Core functions
==============

Collection of functions to explore and select system devices (e.g. GPUs) and initialize a device to work with.

.. automodule:: pyclesperanto._core
    :members:
    :undoc-members:

Memory operations
=================

Collection of functions to manage memory on the device, e.g. to allocate and free memory. And to send or retrieve data from the device.

.. automodule:: pyclesperanto._memory
    :members:
    :undoc-members:

Array class
===========

The main data structure in pyclesperanto is the `Array` class which behave similar to numpy arrays, but point to a memory location on the device.
Here is a collection of class functions, operators, and methods to work with `Array` objects. Mainly to create, manipulate, and transfer them, as well
as to apply arythmetic and logical operations on them.

.. automodule:: pyclesperanto._array
    :members:
    :undoc-members:

.. automodule:: pyclesperanto._operators
    :members:
    :undoc-members:

Functionalities
===============

Collection of operations aiming to help in displaying and analyzing results, e.g. to visualize images.

.. automodule:: pyclesperanto._functionalities
    :members:
    :undoc-members:

Filters
=======

Complete list of all available filters in pyclesperanto.

.. automodule:: pyclesperanto._tier1
    :members:
    :undoc-members:

.. automodule:: pyclesperanto._tier2
    :members:
    :undoc-members:

.. automodule:: pyclesperanto._tier3
    :members:
    :undoc-members:

.. automodule:: pyclesperanto._tier4
    :members:
    :undoc-members:

.. automodule:: pyclesperanto._tier5
    :members:
    :undoc-members:

.. automodule:: pyclesperanto._tier6
    :members:
    :undoc-members:

.. automodule:: pyclesperanto._tier7
    :members:
    :undoc-members: