.. include:: ../include/global.inc

.. _itom-methods:

itom methods
*************

This section shows the spezial itom methods. 

.. currentmodule:: itom

Plotting and camera
======================
Camera plugins have the special method *liveImage*. 

.. automodule:: itom
    :members: liveImage, plot, close

Using algorithms and filters
============================
Algorithms and filters are called by the method *filter*. 
    
.. automodule:: itom
    :members: filter

Methods for getting help and information about filters, plugins, ui-elements, ...
=================================================================================
You can get the help string in the itom command line for plugins, widgets, filters, ...
    
.. automodule:: itom
    :members: pluginHelp, widgetHelp, filterHelp, pluginLoaded, version

Adding elements to the GUI
==========================
You can add buttons and menus to the itom GUI. 
    
.. automodule:: itom
    :members: addButton, removeButton, addMenu, removeMenu

For more information about using these methods, see :ref:`toolbar-start`.

Save and load dataObjects to or from file
=========================================
Dataobject can be save as IDC files. 

.. automodule:: itom
    :members: loadDataObject, saveDataObject, loadMatlabMat, saveMatlabMat, loadIDC, saveIDC
    
Debug-Tools
===========
These are some debug tools. 

.. automodule:: itom
    :members: gcEndTracking, gcStartTracking, getDebugger
    
Request user rights
===================
These are some methods to get user informations. 

.. automodule:: itom
    :members: userIsAdmin, userIsDeveloper, userIsUser, userGetInfo

    
Further commands
================
Some further commands. 

.. automodule:: itom
    :members: scriptEditor, openScript, newScript, setCurrentPath, getAppPath, getCurrentPath, getScreenInfo, checkSignals, getDefaultScaleableUnits, processEvents, scaleValueAndUnit, setApplicationCursor, clc, autoReloader, getPalette, setPalette, getPaletteList, showHelpViewer, getQtToolPath
      

.. Defines
.. automodule:: itom
..    :members: DATA, FILE
    

Another possibility to add methods to this page is to use the auto-summary function.
Since, the default-role property in conf.py  is set to 'autolink' and the auto-summary module is included,
small pages will be automatically created for each method in the following list and a hyperlink to this site is created:

.. currentmodule:: itom

.. With method signature:

.. .. autosummary::
    :toctree: generated
    
    generated/itom.widgetHelp.rst
    generated/itom.pluginHelp.rst
    generated/itom.filterHelp.rst

.. Without method signature:
    
.. .. autosummary::
    :toctree: generated
    :nosignatures:
    
    generated/itom.liveImage.rst
    generated/itom.plot.rstS