ito Namespace Reference

Classes
class	AbstractAddInConfigDialog
	abstract base class for configuration dialogs of plugins More...
class	AbstractAddInConfigDialogPrivate
class	AbstractAddInDockWidget
	abstract base class for dock widgets (toolboxes) of plugins More...
class	AbstractAddInDockWidgetPrivate
class	AbstractApiWidget
class	AbstractApiWidgetPrivate
class	AbstractCodeEditorWidget
class	AbstractDObjFigure
class	AbstractDObjPclFigure
class	AbstractDockWidget
	abstract dock widget class which inherits QDockWidget. The content of QDockWidget consists of an instance of QMainWindow. The real widget is then placed as central widget of this QMainWindow. QMainWindow has the ability to show a menubar as well as a toolbar, which is used in different versions depending on docked state. Inherit AbstractDockWidget in order to realize content of QMainWindow. More...
class	AbstractFigure
class	AbstractFigurePrivate
class	AbstractFilterDialog
class	AbstractItomDesignerPlugin
class	AbstractNode
	Every plot designer plugin in itom, that should be able to open dependent sub-plots (e.g. a 1d line cut is a subplot of its 2d parent plot), must be inherited from this class AbstractNode. However, AbstractNode is no widget class of Qt. Therefore it is also possible to create non-visible classes derived from AbstractNode. This allows creating a directed net of nodes where changes of some input parameters are propagated through all relevant sub-nodes. More...
class	AbstractNodePrivate
class	AbstractParamPropertyManager
class	AbstractParamPropertyManagerPrivate
class	AbstractPropertyPageWidget
class	ActuatorThreadCtrl
	Helper class to give plugin developers an easy access to actuators in other threads. More...
class	AddInActuator
	base class for all actuator plugin classes More...
class	AddInActuatorPrivate
class	AddInAlgo
	base class for all "algorithm" plugin classes More...
class	AddInAlgoPrivate
class	AddInBase
	Base class for all plugins. More...
class	AddInBasePrivate
class	AddInDataIO
	base class for all dataIO plugin classes More...
class	AddInDataIOPrivate
class	AddInGrabber
	Inherit from AddInGrabber if you write a camera/grabber plugin. Please call the constructor of AddInGrabber within your plugin constructor. More...
class	AddInGrabberPrivate
class	AddInInterfaceBase
	forward declaration to private container class of AddInAlog More...
class	AddInInterfaceBasePrivate
class	AddInManager
	class for AddIn management More...
class	AddInManagerPrivate
class	AIManagerWidget
class	AlgoInterfaceValidator
	The class AlgoInterfaceValidator provides validators and checks in order to verify that a certain filter or algoWidget that pretends to implement a certain interface really fits to the requirements and conditions of this interface. More...
class	AlgoInterfaceValidatorPrivate
class	ApiFunctions
class	apiFunctionsGraph
class	AppManagement
	< AppManagement (in order to provide access to basic organizers, managers and other main components to every instance More...
class	AutoIndentMode
class	AutoInterval
	class for a interval type containing a min-max-range and an auto-flag. More...
class	AutoIntervalProperty
class	BookmarkDockWidget
	Provides the bookmark toolbox which is mainly a view of the BookmarkModel. More...
struct	BookmarkItem
	item of BookmarkModel More...
class	BreakPointDockWidget
struct	BreakPointItem
	item of BreakPointModel More...
class	BreakpointPanel
class	ByteArray
	This is a Qt-free class for byte arrays (strings) without specific encoding information. More...
class	CallStackDockWidget
	docking More...
class	CalltipRunnable
	< runnable that executes a calltip call to Jedi by the thread pool of Python Jedi Runner. More...
class	CaretLineHighlighterMode
class	Channel
	A channel defines a propagation pipline between two parameters of two nodes. The nodes are instances of the class AbstractNode, which is for instance a base class of AbstractFigure, and therefore each plot designer plugin in itom. More...
class	ChannelPrivate
class	CharArrayMeta
	Meta-information for Param of type CharArrayMeta. More...
class	CharBasedFoldDetector
class	CharBasedFoldDetectorPrivate
class	CharMeta
	meta-information for Param of type Char. More...
class	CheckerBookmarkPanel
struct	ClassInfoContainer
class	CodeCheckerItem
class	CodeCompletionMode
class	CodeEditor
class	CodeEditorStyle
class	ColCurve
	forward declaration More...
class	CompletionRunnable
	< runnable that executes a completion call to Jedi by the thread pool of Python Jedi Runner. More...
struct	complex128_
	wrapper class for a complex128 value. This class is used, since the std::complex stl class is not exported over DLLs More...
class	ConsoleWidget
class	DataIOThreadCtrl
	Helper class to give plugin developers an easy access to cameras in other threads. More...
class	DataObject
	dataObject contains a n-dimensional matrix More...
class	DataObjectTagsPrivate
class	DataObjectTagType
	Variant storage class for either a double or a string value. More...
class	DelayJobRunner
class	DelayJobRunnerArgTextBlock
class	DelayJobRunnerArgTextCursor
class	DelayJobRunnerBase
class	DelayJobRunnerGenericArg
class	DelayJobRunnerNoArgs
class	DequeCommandList
class	DesignerWidgetOrganizer
class	DialogAboutQItom
class	DialogCloseItom
class	DialogEditBreakpoint
class	DialogGoto
class	DialogIconBrowser
class	DialogLoadedPlugins
class	DialogNewPluginInstance
class	DialogOpenFileWithFilter
class	DialogOpenNewGui
class	DialogPipManager
class	DialogPipManagerInstall
struct	DialogPipManagerInstallDefaults
class	DialogPluginPicker
class	DialogProperties
class	DialogReloadModule
class	DialogReplace
class	DialogSaveFileWithFilter
class	DialogSelectUser
class	DialogSnapshot
class	DialogTimerManager
class	DialogUserManagement
class	DialogUserManagementEdit
class	DialogVariableDetail
class	DObjConstIterator
	constant iterator through data object More...
class	DObjIterator
	iterator through data object More...
class	DObjMeta
	Meta-information for Param of type DObjPtr. More...
class	DoubleArrayMeta
	Meta-information for Param of type DoubleArrayMeta. More...
class	DoubleIntervalMeta
	Meta-information for Param of type DoubleIntervalMeta. More...
class	DoubleMeta
	Meta-information for ito::Param of type Double. More...
class	ErrorLineHighlighterMode
struct	ExecFuncParams
class	FctCallParamContainer
	each instance of this class contains the parameters (including return parameter) for any function call, which is parsed by the Qt-signal-slot system. This class is especially used for wrapping function calls between C++ and any python method. The convention for the main member variables corresponds to the usual Qt-way to wrap such function calls. More...
struct	FigureCategory
struct	FigurePlugin
class	FigurePluginDelegate
class	FigureWidget
class	FileSystemDockWidget
struct	FilterParams
class	FoldDetector
class	FoldDetectorPrivate
class	FoldingPanel
class	FoldScope
class	FunctionCancellationAndObserver
	This class can be passed to a long running method (e.g. as QSharedPointer instance) for two reasons: More...
class	FunctionCancellationAndObserverPrivate
class	FuncWeakRef
class	GetHelpRunnable
	< runnable that executes a calltip call to Jedi by the thread pool of Python Jedi Runner. More...
struct	GoBackNavigationItem
class	GoToAssignmentRunnable
	< runnable that executes a goto definition / assignment call to Jedi by the thread pool of Python Jedi Runner. More...
class	GuiHelper
class	HelpDockWidget
class	HelpSystem
class	HelpTreeDockWidget
class	HWMeta
	Meta-information for Param of type HWPtr. More...
class	IndenterMode
class	IndentFoldDetector
class	IntArrayMeta
class	IntervalMeta
	Meta-information for Param of type IntArrayMeta that represent an interval [minimum, maximum). More...
class	IntMeta
	Meta-information for Param of type Int. More...
class	IOHelper
	This class contains several static methods to load or save various file formats. More...
class	ItomEditorFactoryPrivate
class	ItomFileSystemModel
	Instead of the default QFileSystemModel, this model is able to provide a more flexible support for drop or paste operations if the destination file already exists. If the file should be duplicated (from one folder to the same folder), a (copy)-suffix is appended to the base-filename. If the source is another directory, but the file has the same name, the user is prompted if he wants to overwrite the source file or not. More...
struct	ItomPalette
class	ItomPaletteBase
struct	ItomParamHelper
struct	ItomParamHelper< char >
struct	ItomParamHelper< complex128 >
struct	ItomParamHelper< float64 >
struct	ItomParamHelper< int32 >
struct	ItomParamHelper< unsigned char >
class	ItomPlotHandle
	class for a interval type containing the plot handle / unique id and name. More...
class	ItomSpinBox
struct	JediAssignment
struct	JediAssignmentRequest
struct	JediCalltip
struct	JediCalltipRequest
struct	JediCompletion
struct	JediCompletionRequest
struct	JediGetHelp
struct	JediGetHelpRequest
class	JediRunnable
	< base class for all runnables, that are executed with PythonJediRunner More...
class	LastCommandDockWidget
class	LastCommandTreeWidget
class	LeafFilterProxyModel
	This class provides a special search function to the help model. The normal filtermodel hides nodes if they don't contain the searched term, even though the children contain it. More...
class	LineBackgroundMarkerMode
class	LineEditDelegate
class	LineNumberPanel
class	MainApplication
	The MainApplication class is the basic management class for the entire application. More...
class	MainWindow
class	Manager
class	MenuOnlyForEnter
class	MethodDescription
	Small wrapper class with all necessary information for any method, signal or slot of class which should be inherited from QObject*. More...
class	Mode
class	ModesManager
class	OccurrencesHighlighterMode
class	OutlineItem
class	OutlineSelectorWidget
	framless dialog, shown as popup over a script editor, to display the outline. More...
class	PaletteOrganizer
class	Panel
class	PanelsManager
class	Param
	class for parameter handling e.g. to pass paramters to plugins More...
class	ParamBase
class	ParamCharArrayPropertyManager
class	ParamCharArrayPropertyManagerPrivate
class	ParamCharPropertyFactory
class	ParamCharPropertyFactoryPrivate
class	ParamCharPropertyManager
class	ParamCharWidget
class	ParamCharWidgetPrivate
class	ParamDoubleArrayPropertyManager
class	ParamDoubleArrayPropertyManagerPrivate
class	ParamDoublePropertyFactory
	The ParamDoublePropertyFactory class provides QSpinBox widgets for properties created by QtIntPropertyManager objects. More...
class	ParamDoublePropertyFactoryPrivate
class	ParamDoublePropertyManager
class	ParamDoubleWidget
class	ParamDoubleWidgetPrivate
class	ParamHelper
class	ParamInputDialog
class	ParamInputParser
class	ParamIntArrayPropertyManager
class	ParamIntArrayPropertyManagerPrivate
class	ParamIntervalPropertyFactory
	The ParamIntervalPropertyFactory class provides RangeWidget widgets for properties created by ParamIntervalPropertyManager objects. More...
class	ParamIntervalPropertyFactoryPrivate
class	ParamIntervalPropertyManager
class	ParamIntPropertyFactory
class	ParamIntPropertyFactoryPrivate
class	ParamIntPropertyManager
class	ParamIntWidget
class	ParamIntWidgetPrivate
class	ParamMeta
	Base class for all meta-information classes. More...
class	ParamOtherPropertyManager
class	ParamRectPropertyManager
class	ParamRectPropertyManagerPrivate
class	ParamStringPropertyFactory
	The ParamStringPropertyFactory class provides QLineEdit widgets for properties created by ParamStringPropertyManager objects. More...
class	ParamStringPropertyFactoryPrivate
class	ParamStringPropertyManager
class	ParamStringWidget
class	ParamStringWidgetPrivate
class	PCLPoint
	generic class that covers one single point of different possible types provided by the Point Cloud Library (PCL). More...
class	PCLPointCloud
	generic class that covers one single point cloud of different possible types provided by the Point Cloud Library (PCL). More...
class	PCLPolygonMesh
	generic class that covers a shared pointer to pcl::PolygonMesh that is a class for a polygonal mesh provided by the point cloud library (PCL) More...
class	PickerSortFilterProxyModel
struct	PipGeneralOptions
struct	PipInstall
class	PipManager
class	PluginInfo
class	PluginLoadStatus
	This struct provides a structure for saving the load status of any plugins or designerWidgets. More...
class	PlugInModel
	class for visualizing the available (loaded) plugins More...
class	PlugInModelPrivate
class	PluginThreadCtrl
	Base class for DataIOThreadCtrl and ActuatorThreadCtrl. More...
class	ProcessOrganizer
struct	PyAssignment
class	PyAutoIndentMode
class	PyCalltipsMode
struct	PyCMap
	< the following map translates Qt/C++ datatypes into their Python representations. This is for instance used in the info()-method in Python to show the user the Python syntax. More...
class	PyCodeFormatter
class	PyDocstringGeneratorMode
class	PyGotoAssignmentMode
class	PyStream
	static class which implements a new python type. The members cout and cerr of the python system are set to variables of this type PyStream in order to observe the python's cout and cerr stream and to transmit the stream's content to the main application. More...
class	PythonAutoInterval
class	PythonCommon
class	PythonDataObject
class	PythonEngine
class	PythonFigure
class	PythonFont
class	PythonItom
class	PythonJediRunner
	< Thread-safe helper class for PythonEngine to manage calls to the Python Jedi package. More...
class	PythonMessageDockWidget
class	PythonMessageTreeWidget
class	PythonNone
	empty class that is the QVariant registered type for None in Python. Nothing more than this. More...
class	PythonNumeric
struct	PythonPackage
class	PythonParamConversion
class	PythonPlotItem
class	PythonPlugins
	class summing up the functionality of itom - hardware python plugins More...
class	PythonProgressObserver
class	PythonProxy
struct	PythonQObjectMarshal
class	PythonQtConversion
	Conversion class with mainly static methods, which convert values between Qt and standard C++ data types and PyObject* values. More...
class	PythonQtSignalMapper
	This class provides the possibility to redirect any signal emitted in an user-defined GUI to different python methods. More...
class	PythonQtSignalMapperBase
	base class for PythonQtSignalMapper More...
class	PythonQtSignalTarget
class	PythonRegion
class	PythonRgba
class	PythonShape
class	PythonSharedPointerGuard
class	PythonStatePublisher
	One instance of this class is created by MainApplication::setupApplication and runs in the main thread of itom. Its onPythonStateChanged slot is connected to the pythonStateChanged signal of PythonEngine. Other widgets should rather connect to pythonStateChanged of this class than to the direct signal of PythonEngine. This is mainly for one reason: Whenever a short script is run in Python (not debug), it might be that the execution is so short, that it is a waste of computing resources to switch the GUI to a busy state during this short exeuction. Therefore, the transition to the run state is signalled by this class with a short delay. Whenever, the 'idle' state is signalled by the PythonEngine before the delay exceeds, nothing is signalled by this class. This only holds for this transition. All other python state transitions are immediately reported to all connected classes. More...
class	PythonSyntaxHighlighter
class	PythonTimer
class	PythonUi
class	PyWorkspaceContainer
class	PyWorkspaceItem
	every item in the workspace is represented by one PyWorkspaceItem More...
class	QDebugStream
class	QListViewItom
class	QPropertyHelper
class	QTableViewItom
class	QTabWidgetItom
class	QTreeViewItom
class	QVector2DProperty
class	QVector3DProperty
class	QVector4DProperty
struct	RamerDouglasPeuckerData
class	Range
	each range value has a start and end point. Optionally range can be marked as Range::all(), which indicates a full range More...
class	RangeMeta
	Meta-information for Param of type IntArrayMeta that represent a range [minVal, maxVal]. More...
class	RectMeta
	Meta-information for Param of type IntArrayMeta that represent a rectangle (left, top, width, height). More...
class	RetVal
	Class for managing status values (like errors or warning) More...
class	Rgba32
	This class implements basic functionality for color handling in itom. This class implements ARGB32 into itom. In openCV-mat this will be represented by an 4channel uint8-plane. The functions of this class are inspired by http://virjo.googlecode.com/svn/trunk/SFML_Windows/src/SFML/Graphics/Color.cpp, written by Laurent Gomila (laure.nosp@m.nt.g.nosp@m.om@gm.nosp@m.ail..nosp@m.com) More...
class	RgbaBase32
class	RGBChannel
class	ScriptDockWidget
	widget containing one or multiple script editors (tabbed). This widget can either be a docking widget, docked in a docking area in the main window or it can be a floatable window which has a standard window behaviour. More...
struct	ScriptEditorActions
	this struct can hold common actions for all script editor and script dock widgets More...
class	ScriptEditorOrganizer
	organizes script editors, independent on their appearance (docked or window-style) More...
class	ScriptEditorPrinter
struct	ScriptEditorStorage
class	SelectorDelegate
class	SemVerVersion
	provides version string parsing and comparison based on semantic versioning More...
class	Shape
class	ShapeDObject
class	ShapePrivate
class	ShortcutAction
class	StringMeta
	Meta-information for Param of type String. More...
class	StringMetaPrivate
class	StyleItem
class	SubsequenceCompleter
class	SubsequenceSortFilterProxyModel
class	SymbolMatcherMode
class	SyntaxHighlighterBase
class	TabSwitcherWidget
	Show tabs in mru order and change between them. More...
class	TextBlockUserData
struct	TextDecoration
class	TextDecorationsManager
class	TextDecorationsSignals
class	TimerCallback
class	TimerModel
	model for management of all timer objects. This model will be is used as model for the view in the timer manager. More...
class	UiContainer
	Every instance of this class contains information about one user interface (main window, dialog, dock widget...) which is organized by UiOrganizer. More...
struct	UiContainerItem
class	UiDataContainer
class	UiOrganizer
	The UiOrganizer is started as singleton instance within itom and organizes all main windows, dialogs, widgets,... which are currently loaded at runtime from any ui-file or from a widget, provided by any algorithm plugin. More...
struct	UserInfoStruct
class	UserInteractionWatcher
class	UserModel
	class for for visualizing the available users More...
class	UserOrganizer
	class handling users and their rights More...
class	UserUiDialog
struct	VisibleBlock
class	WidgetFindWord
class	WidgetInfoBox
class	WidgetPropConsoleGeneral
class	WidgetPropConsoleLastCommand
class	WidgetPropConsoleWrap
class	WidgetPropEditorAutoCodeFormat
class	WidgetPropEditorAutoCompletion
class	WidgetPropEditorCalltips
class	WidgetPropEditorCodeCheckers
class	WidgetPropEditorDocstringGenerator
class	WidgetPropEditorGeneral
class	WidgetPropEditorGotoAssignment
class	WidgetPropEditorScripts
class	WidgetPropEditorStyles
class	WidgetPropFigurePlugins
class	WidgetPropGeneralApplication
class	WidgetPropGeneralLanguage
class	WidgetPropGeneralPlotSettings
class	WidgetPropGeneralStyles
class	WidgetPropHelpDock
class	WidgetPropPalettes
class	WidgetPropPluginsActuators
class	WidgetPropPluginsAlgorithms
class	WidgetPropPythonGeneral
class	WidgetPropPythonStartup
class	WidgetPropWorkspaceUnpack
class	WidgetWrapper
	One instance of this class acts as wrapper for several import public methods of classes, derived from QObject, which should be made available by the call-method in python. More...
class	WordClickMode
class	WordHoverTooltipMode
class	WorkspaceDockWidget
	docking widget for contents of type workspace widget More...
class	WorkspaceTreeItem
	tiny derivative of QTreeWidgetItem, that overwrites the comparison operator More...
class	WorkspaceWidget
	major class WorkspaceWidget to show a tree widget for the global and local workspace toolbox More...

Typedefs
typedef QList< MethodDescription >	MethodDescriptionList
typedef RetVal(*	tFreeFunc) (DataObject *dObj)
typedef RetVal(*	tSecureFreeFunc) (DataObject *dObj)
typedef RetVal(*	tCreateFunc) (DataObject *dObj, const unsigned char dimensions, const int *sizes, const unsigned char continuous, const uchar *continuousDataPtr, const int *steps)
typedef RetVal(*	tCreateFuncWithCVPlanes) (DataObject *dObj, const unsigned char dimensions, const int *sizes, const cv::Mat *planes, const unsigned int nrOfPlanes)
typedef RetVal(*	tCopyToFunc) (const DataObject &lhs, DataObject &rhs, unsigned char regionOnly)
typedef RetVal(*	tDeepCopyPartialFunc) (const DataObject &lhs, DataObject &rhs)
typedef RetVal(*	tZerosFunc) (const int sizeY, const int sizeX, uchar **dstMat)
typedef RetVal(*	tOnesFunc) (const int sizeY, const int sizeX, uchar **dstMat)
typedef RetVal(*	tNansFunc) (const int sizeY, const int sizeX, uchar **dstMat)
typedef RetVal(*	tRandFunc) (const int sizeY, const int sizeX, const double value1, const double value2, const bool randMode, uchar **dstMat)
typedef RetVal(*	tCopyMatFunc) (const uchar **src, uchar **&dst, bool transposed, const int sizeofs)
typedef RetVal(*	tAssignScalarFunc) (DataObject *src, const ito::tDataType type, const void *scalar)
typedef RetVal(*	tAssignScalarMaskFunc) (DataObject *src, const DataObject *mask, const ito::tDataType type, const void *scalar)
typedef RetVal(*	tAddFunc) (const DataObject *src1, const DataObject *src2, DataObject *dst)
typedef RetVal(*	tAddScalarFunc) (const DataObject *dObjIn, ito::float64 scalar, DataObject *dObjOut)
typedef RetVal(*	tAddComplexScalarFunc) (const DataObject *dObjIn, ito::complex128 scalar, DataObject *dObjOut)
typedef RetVal(*	tSubFunc) (const DataObject *src1, const DataObject *src2, DataObject *dst)
typedef RetVal(*	tOpMulFunc) (const DataObject *src1, const DataObject *src2, DataObject *dst)
typedef RetVal(*	tOpScalarMulFunc) (DataObject *src, const float64 &factor)
typedef RetVal(*	tOpScalarComplexMulFunc) (DataObject *src, const complex128 &factor)
typedef RetVal(*	tCmpFunc) (const DataObject *src1, const DataObject *src2, DataObject *dst, int cmpOp)
typedef RetVal(*	tCmpFuncScalar) (const DataObject *src, const float64 &value, DataObject *dst, int cmpOp)
typedef RetVal(*	tShiftLFunc) (DataObject *src, const unsigned char shiftbit)
typedef RetVal(*	tShiftRFunc) (DataObject *src, const unsigned char shiftbit)
typedef RetVal(*	tBitAndFunc) (const DataObject *src1, const DataObject *src2, DataObject *dst)
typedef RetVal(*	tBitOrFunc) (const DataObject *src1, const DataObject *src2, DataObject *dst)
typedef RetVal(*	tBitXorFunc) (const DataObject *src1, const DataObject *src2, DataObject *dst)
typedef RetVal(*	tGetRangeFunc) (DataObject *dObj, const int dtop, const int dbottom, const int dleft, const int dright)
typedef RetVal(*	tAdjustROIFunc) (DataObject *dObj, int dtop, int dbottom, int dleft, int dright)
typedef RetVal(*	tEyeFunc) (const int size, uchar **dstMat)
typedef RetVal(*	tConjFunc) (DataObject *dObj)
typedef RetVal(*	tMulFunc) (const DataObject *src1, const DataObject *src2, DataObject *res, const double scale)
typedef RetVal(*	tDivFunc) (const DataObject *src1, const DataObject *src2, DataObject *res)
typedef RetVal(*	tplaneStackFunc) (const DataObject *mats, const int &num, const unsigned int &axis, DataObject *res)
typedef RetVal(*	tlineCutFunc) (const DataObject *src, const int *coordinates, const int &len, DataObject *res)
typedef RetVal(*	tConvertToFunc) (const DataObject &lhs, DataObject &rhs, const int dest_type, const double alpha, const double beta)
typedef RetVal(*	tAbsFunc) (const DataObject *dObj, DataObject *resObj)
typedef RetVal(*	tArgFunc) (const DataObject *dObj, DataObject *resObj)
typedef RetVal(*	tRealFunc) (const DataObject *dObj, DataObject *resObj)
typedef RetVal(*	tImagFunc) (const DataObject *dObj, DataObject *resObj)
typedef RetVal(*	tMakeContinuousFunc) (const DataObject &dObj, DataObject &resDObj)
typedef std::ostream &(*	tCoutFunc) (std::ostream &out, const DataObject &dObj)
typedef bool(*	tIsOrganizedFunc) (const ito::PCLPointCloud *pc)
typedef void(*	tSetWidthFunc) (ito::PCLPointCloud *pc, uint32_t width)
typedef uint32_t(*	tGetWidthFunc) (const ito::PCLPointCloud *pc)
typedef size_t(*	tGetSizeFunc) (const ito::PCLPointCloud *pc)
typedef uint32_t(*	tGetHeightFunc) (const ito::PCLPointCloud *pc)
typedef void(*	tSetHeightFunc) (ito::PCLPointCloud *pc, uint32_t height)
typedef bool(*	tGetDenseFunc) (const ito::PCLPointCloud *pc)
typedef void(*	tSetDenseFunc) (ito::PCLPointCloud *pc, bool dense)
typedef void(*	tScaleXYZFunc) (ito::PCLPointCloud *pc, ito::float32 scaleX, ito::float32 scaleY, ito::float32 scaleZ)
typedef void(*	tMoveXYZFunc) (ito::PCLPointCloud *pc, ito::float32 dX, ito::float32 dY, ito::float32 dZ)
typedef std_msgs::Header(*	tGetHeaderFunc) (const ito::PCLPointCloud *pc)
typedef std::string(*	tGetFieldsListFunc) (const ito::PCLPointCloud *pc)
typedef std::vector< sensor_msgs::PointField >(*	tGetFieldsInfoFunc) (const ito::PCLPointCloud *pc)
typedef unsigned char *(*	tGenericPointAccessFunc) (const ito::PCLPointCloud *pc, size_t &strideBytes)
typedef void(*	tPcAddFunc) (ito::PCLPointCloud *pc1, const ito::PCLPointCloud *pc2, ito::PCLPointCloud *pcRes)
typedef const ito::PCLPoint(*	tGetItemFunc) (const ito::PCLPointCloud *pc, size_t n)
typedef void(*	tSetItemFunc) (ito::PCLPointCloud *pc, size_t n, ito::PCLPoint &point)
typedef void(*	tPushBackFunc) (ito::PCLPointCloud *pc, const ito::PCLPoint &point)
typedef bool(*	tEmptyFunc) (const ito::PCLPointCloud *pc)
typedef void(*	tReserveResizeFunc) (ito::PCLPointCloud *pc, size_t n, bool reserveNotResize)
typedef void(*	tClearFunc) (ito::PCLPointCloud *pc)
typedef void(*	tEraseFunc) (ito::PCLPointCloud *pc, uint32_t startIndex, uint32_t endIndex)
typedef void(*	tInsertFunc) (ito::PCLPointCloud *pc, uint32_t index, const ito::PCLPoint &point)
typedef RGBChannel< Rgba32::RGBA_A >	AlphaChannel
typedef RGBChannel< Rgba32::RGBA_R >	RedChannel
typedef RGBChannel< Rgba32::RGBA_G >	GreenChannel
typedef RGBChannel< Rgba32::RGBA_B >	BlueChannel
typedef int8_t	int8
typedef int16_t	int16
typedef int32_t	int32
typedef uint8_t	uint8
typedef uint16_t	uint16
typedef uint32_t	uint32
typedef float	float32
typedef double	float64
typedef std::complex< ito::float32 >	complex64
typedef std::complex< ito::float64 >	complex128

Enumerations
enum	tMsgType {   msgReturnInfo, msgReturnWarning, msgReturnError, msgTextInfo,   msgTextWarning, msgTextError }
enum	tPythonDbgCmd {   pyDbgNone =0, pyDbgContinue =1, pyDbgStep =2, pyDbgStepOut =4,   pyDbgStepOver =8, pyDbgQuit =16 }
enum	tPythonTransitions {   pyTransBeginRun = 1, pyTransEndRun = 2, pyTransBeginDebug = 4, pyTransEndDebug = 8,   pyTransDebugWaiting = 16, pyTransDebugContinue = 32, pyTransDebugExecCmdBegin = 64, pyTransDebugExecCmdEnd = 128 }
enum	tPythonState {   pyStateIdle = 1, pyStateRunning = 2, pyStateDebugging = 4, pyStateDebuggingWaiting = 8,   pyStateDebuggingWaitingButBusy = 16 }
enum	UserRole { userRoleBasic = 0, userRoleDeveloper = 1, userRoleAdministrator = 2 }
	Enumeration that defines some user roles.
enum	UserFeature {   featDeveloper = 0x01, featFileSystem = 0x02, featUserManagement = 0x04, featPlugins = 0x08,   featConsoleRead = 0x10, featConsoleReadWrite = 0x20, featProperties = 0x40 }
	Enumeration that defines some feature permissions for a user.
enum	tParamType { none = 0x0, intArray = 0x1, doubleArray = 0x2, charArray = 0x4 }
enum	tPluginLoadStatusFlag {   plsfOk = 0x001, plsfWarning = 0x002, plsfError = 0x004, plsfIgnored = 0x008,   plsfRelDbg = 0x100, plsfIncompatible = 0x200 }
enum	tPluginType {   typeDataIO = 0x1, typeActuator = 0x2, typeAlgo = 0x4, typeGrabber = 0x80,   typeADDA = 0x100, typeRawIO = 0x200 }
	tPluginType enumeration More...
enum	tActuatorStatus {   actuatorUnknown = 0x0001, actuatorInterrupted = 0x0002, actuatorMoving = 0x0004, actuatorAtTarget = 0x0008,   actuatorTimeout = 0x0010, actuatorEndSwitch = 0x0100, actuatorLeftEndSwitch = 0x0200, actuatorRightEndSwitch = 0x0400,   actuatorEndSwitch1 = 0x0200, actuatorEndSwitch2 = 0x0400, actuatorRefSwitch = 0x0800, actuatorLeftRefSwitch = 0x1000,   actuatorRightRefSwitch = 0x2000, actuatorRefSwitch1 = 0x1000, actuatorRefSwitch2 = 0x2000, actuatorAvailable = 0x4000,   actuatorEnabled = 0x8000, actuatorError = 0x10000, actMovingMask = actuatorUnknown | actuatorInterrupted | actuatorMoving | actuatorAtTarget | actuatorTimeout, actEndSwitchMask,   actRefSwitchMask, actSwitchesMask = actEndSwitchMask | actRefSwitchMask, actStatusMask = actuatorAvailable | actuatorEnabled | actuatorError }
	tActuatorStatus enumeration More...
enum	tAutoLoadPolicy { autoLoadAlways = 0x1, autoLoadNever = 0x2, autoLoadKeywordDefined = 0x4 }
enum	tAutoSavePolicy { autoSaveAlways = 0x1, autoSaveNever = 0x2 }
enum	PlotDataType {   DataObjLine = 0x0001, DataObjPlane = 0x0002, DataObjPlaneStack = 0x0004, PointCloud = 0x0008,   PolygonMesh = 0x0010 }
	enumeration that describes the type of input data that a designer plot widget accepts More...
enum	PlotDataFormat {   Format_Gray8 = 0x0001, Format_Gray16 = 0x0002, Format_Gray32 = 0x0004, Format_RGB32 = 0x0008,   Format_ARGB32 = 0x0010, Format_CMYK32 = 0x0020, Format_Float32 = 0x0040, Format_Float64 = 0x0080,   Format_Complex = 0x0100 }
	allowed data formats
enum	PlotFeature {   Static = 0x0001, Live = 0x0002, Cartesian = 0x0004, Polar = 0x0008,   Cylindrical = 0x0010, OpenGl = 0x0020, Cuda = 0x0040, X3D = 0x0080,   PlotLine = 0x0100, PlotImage = 0x0200, PlotISO = 0x0400, Plot3D = 0x0800 }
	this enumeration describe the features a designer plot widget provides concerning the visualization of data objects, point clouds or polygonal meshes
enum	tPalette {   tPaletteNoType = 0x00, tPaletteGray = 0x01, tPaletteRGB = 0x02, tPaletteFC = 0x04,   tPaletteIndexed = 0x08, tPaletteLinear = 0x10, tPaletteReadOnly = 0x20 }
enum	tRetValue { retOk = 0x0, retWarning = 0x1, retError = 0x2 }
enum	tCompareResult { tCmpEqual, tCmpCompatible, tCmpFailed }
enum	tStreamMessageType { msgStreamOut = 1, msgStreamErr = 2, msgStreamIn = 3 }
enum	tDataType {   tInt8 = 0, tUInt8 = 1, tInt16 = 2, tUInt16 = 3,   tInt32 = 4, tUInt32 = 5, tFloat32 = 6, tFloat64 = 7,   tComplex64 = 8, tComplex128 = 9, tRGBA32 = 10 }
enum	tPCLPointType {   pclInvalid = 0x0000, pclXYZ = 0x0001, pclXYZI = 0x0002, pclXYZRGBA = 0x0004,   pclXYZNormal = 0x0008, pclXYZINormal = 0x0010, pclXYZRGBNormal = 0x0020 }
enum	rttiNodeType {   rttiUnknown = 0x0000, rttiPlotNode = 0x1000, rttiFilterNode = 0x2000, rttiPlotNodeDObj = 0x0100,   rttiPlotNodePCL = 0x0200, rttiPlotNode1D = 0x0001, rttiPlotNode2D = 0x0002, rttiPlotNode25D = 0x0003,   rttiPlotNode3D = 0x0004 }

Functions
bool	cmpPanelByOrderInZoneReverse (const std::pair< Panel::Ptr, int > &a, const std::pair< Panel::Ptr, int > &b)
bool	sortDecorationsByDrawOrder (const TextDecoration::Ptr &a, const TextDecoration::Ptr &b)
bool	cmpParenthesisByPosReversed (const Utils::ParenthesisInfo &a, const Utils::ParenthesisInfo &b)
QString	parseCalltip (const ito::JediCalltip &tip)
QColor	mergedColor (const QColor &colorA, const QColor &colorB, float factor)
QList< QPair< QRegularExpressionMatch, QStringList > >::const_iterator	hasNextMatch (const QList< QPair< QRegularExpressionMatch, QStringList > > &matches, QString &captureGroup)
QString	any (const QString &name, const QStringList &alternates)
QString	enumValuesText (const QMetaEnum &enumerator)
	< returns a help string that contains all possible keys of the enumerator in the form key1 (value1), key2 (value2) ...
QMap< QString, QString >	getItomVersionMap ()
	This function is called to get all version numbers that itom contains. More...
QDataStream &	operator<< (QDataStream &out, const BookmarkItem &obj)
QDataStream &	operator>> (QDataStream &in, BookmarkItem &obj)
QDataStream &	operator<< (QDataStream &out, const BreakPointItem &obj)
QDataStream &	operator>> (QDataStream &in, BreakPointItem &obj)
QDataStream &	operator<< (QDataStream &out, const ito::ScriptEditorStorage &obj)
QDataStream &	operator>> (QDataStream &in, ito::ScriptEditorStorage &obj)
RetVal	getObjectChildrenInfoRecursive (const QObject *obj, bool recursive, QSharedPointer< QStringList > &objectNames, QSharedPointer< QStringList > &classNames)
void	removeAndDeleteLayoutItem (QLayout *layout, QLayoutItem *item)
	PyDoc_STRVAR (autoIntervalInit_doc,"autoInterval(min = -math.inf, max = math.inf, auto = True) -> autoInterval \n\ \n\ Creates a new (auto) interval object.\n\ \n\ \n\ Properties and slots of :class:`uiItem` objects (e.g. plots) sometimes have parameters \n\ of type :class:`autoInterval`. It is either possible to pass an :class:`autoInterval` \n\ instance, the string ``auto`` or a list or tuple with the two limit values ``[min, max]``. \n\ \n\ Example:: \n\ \n\ [i,h] = plot(dataObject.randN([100, 100], 'int8'))\n\ h['xAxisInterval'] = autoInterval(20, 80)\n\ h['yAxisInterval'] = 'auto' \n\ h['zAxisInterval'] = [-90, 90] \n\ \n\ Parameters \n\ ----------- \n\ min : float, optional \n\ minimum value of interval (default: -:obj:`math.inf`). \n\ max : float, optional \n\ maximum value of interval (default: :obj:`math.inf`). \n\ auto : bool, optional \n\ ``False`` if interval is fixed, ``True`` if the interval can be scaled \n\ automatically (default).")
	PyDoc_STRVAR (autoInterval_name_doc,"name() -> str \n\ \n\ Returns the name of this object. \n\ \n\ Returns \n\ ------- \n\ str \n\ name of this object ``autoInterval``.")
	PyDoc_STRVAR (autoInterval_min_doc,"float : Gets or sets the minimum value of the interval.")
	PyDoc_STRVAR (autoInterval_max_doc,"float : Gets or sets the maximum value of the interval.")
	PyDoc_STRVAR (autoInterval_auto_doc,"bool : Gets or sets if this interval has an automatic range.")
ito::RetVal	checkAndSetParamVal (PyObject *tempObj, ito::Param *param, int *set)
ito::RetVal	checkAndSetParamVal (PyObject *pyObj, const ito::Param *defaultParam, ito::ParamBase &outParam, int *set)
	This function is used to print out parameters to a dictionary and the itom-console.
PyObject *	printOutParams (const QVector< ito::Param > *params, bool asErr, bool addInfos, const int num, bool printToStdStream)
void	errOutInitParams (const QVector< ito::Param > *params, const int num, const char *reason)
ito::RetVal	parseInitParams (const QVector< ito::Param > *defaultParamListMand, const QVector< ito::Param > *defaultParamListOpt, PyObject *args, PyObject *kwds, QVector< ito::ParamBase > &paramListMandOut, QVector< ito::ParamBase > &paramListOptOut)
ito::RetVal	copyParamVector (const QVector< ito::ParamBase > *paramVecIn, QVector< ito::ParamBase > &paramVecOut)
ito::RetVal	copyParamVector (const QVector< ito::Param > *paramVecIn, QVector< ito::Param > &paramVecOut)
ito::RetVal	copyParamVector (const QVector< ito::Param > *paramVecIn, QVector< ito::ParamBase > &paramVecOut)
ito::RetVal	findAndDeleteReservedInitKeyWords (PyObject *kwds, bool *enableAutoLoadParams)
PyObject *	buildFilterOutputValues (QVector< QVariant > *outVals, ito::RetVal &retValue)
PyObject *	parseParamMetaAsDict (const ito::ParamMeta *meta)
ito::RetVal	createEmptyParamBaseFromParamVector (const QVector< ito::Param > *paramVecIn, QVector< ito::ParamBase > &paramVecOut)
	This function searches for reserves Keywords (e.g. autoLoadParams) sets the corresponding bool parameter to the right value and than deletes the keyword.
	PyDoc_STRVAR (dataObjectInit_doc,"dataObject(dims = [], dtype = \"uint8\", continuous = 0, data = None) -> dataObject \n\ \n\ Creates a new n-dimensional dataObject array. \n\ \n\ The :class:`dataObject` represents a multidimensional array of fixed-size items \n\ (integer, floating-point or complex values) and contains further, optional, meta \n\ information, like units, axis descriptions, scalings, general tags, ... \n\ Recently the following data types (dtype) are supported: \n\ \n\ * Integer (int8, uint8, int16, uint16, int32),\n\ * Floating point (float32, float64 (=> double)),\n\ * Complex (complex64 (2x float32), complex128 (2x float64)).\n\ * Color (rgba32 (uint32 or uint[4] containing the four 8bit values [R, G, B, Alpha])).\n\ \n\ Arrays can also be constructed using some of the static pre-initialization methods \n\ :meth:`zeros`, :meth:`ones`, :meth:`rand` or :meth:`randN` \n\ (refer to the See Also section below). \n\ \n\ Parameters \n\ ----------- \n\ dims : sequence of int, optional \n\ ``dims`` is a list or tuple indicating the size of each dimension. The length \n\ of this sequence defines the dimension of this dataObject. As an example, \n\ ``dims = [2, 3]`` creates a two-dimensional dataObject with two rows and three columns. \n\ If ``dims`` is not given, an empty data object is created. \n\ dtype : str, optional \n\ Data type of each element in the array. Possible values are: \n\ 'int8', 'uint8', 'int16', 'uint16', 'int32', 'float32', 'float64', 'complex64', \n\ 'complex128', 'rgba32'. \n\ continuous : int, optional \n\ The last two dimensions of a dataObject are always stored as continuous junk of memory, \n\ denoted as plane. If ``continuous`` is set to ``1``, even a dataObject with a dimension \n\ ``n > 2`` will allocate one big block of memory and continuously stores the matrix data \n\ there. \n\ If ``continuous`` is 0, different junks of memory are allocated for each plane, the planes \n\ are referenced by means of an index vector. This is recommended for large arrays, since \n\ the operating system might get trouble allocated one very big continuous junk of memory, \n\ instead of multiple smaller ones. \n\ data : int or float or complex or rgba or sequence of int or sequence of float or sequence of complex or dataObject or np.ndarray, optional \n\ If ``data`` is a single value, all values in the dataObject are set to this single value. \n\ Else, the sequence or array-like object must have the same number of values than \n\ the data object. These values will then be assigned to the new data object (filled row by row).\n\ \n\ Notes \n\ ------ \n\ The :class:`itom.dataObject` is a direct wrapper for the underlying C++ class *dataObject*. \n\ This array class mainly is based on the class *Mat* of the computer vision library (OpenCV). \n\ \n\ In order to handle huge matrices, the data object can divide one array into chunks in memory.\n\ Each subpart (called matrix-plane) is two-dimensional and covers data of the last two dimensions.\n\ In C++-context each of these matrix-planes is of type cv::Mat_<type> and can be used with \n\ every operator given by the openCV-framework (version 2.3.1 or higher).\n\ \n\ The dimensions of the matrix are structured descending. So if we assume to have a n-dimensional \n\ matrix ``A``, where each dimension has its size s_i, the dimensions order is n, .., z, y, x and \n\ the corresponding sizes of ``A`` are [s_n, s_(n-1), s_(n-2), ..., s_y, s_x].\n\ \n\ In order to make the data object compatible to continuously organized data structures, like \n\ numpy-arrays, it is also possible to have all matrix-planes in one data-block in memory \n\ (not recommended for huge matrices). Nevertheless, the indicated data structure with the \n\ two-dimensional sub-matrix-planes is still existing. The data organization is equal to the \n\ one of openCV, hence, two-dimensional matrices are stored row-by-row (C-style)...\n\ \n\ In addition to OpenCV, itom.dataObject supports complex valued data types for all operators and methods. \n\ \n\ Warning 'uint32' is currently not available, since it is not fully supported by the underlying OpenCV matrices.\n\ \n\ **Deep Copy, Shallow Copy and ROI** \n\ \n\ It is possible to set a n-dimensional region of interest (ROI) to each matrix, the virtual dimensions,\n\ which will be delivered if the user asks for the matrix size.\n\ To avoid copy operations where possible a simple =_Operator will also make a shallow copy of the object.\n\ Shallow copies share the same data (elements and meta data) with the original object, hence manipulations of one object will affect the\n\ original object and all shallow copies.\n\ \n\ The opposite a deep copy of a dataObject (by sourceObject.copy()) creates a complete mew matrix with own meta data object.\n\ \n\ Example::\n\ \n\ #Create an object \n\ dObj = dataObject([5, 10, 10], 'int8')\n\ \n\ # Make a shallow copy \n\ dObjShallow = dObj \n\ \n\ # Make a shallow copy on ROI\n\ dObjROI = dObj[1, :, :] \n\ \n\ # Set the value of element [1, 0, 0] to 0\n\ dObj[1, 0, 0] = 0\n\ \n\ # Make a deep copy of the dObjROI\n\ dObjROICopy = dObjROI.copy()\n\ \n\ # Set the value of dObjROICopy element [0, 0, 0] to 127 without effecting other objects\n\ dObjROICopy[0, 0, 0] = 127\n\ \n\ **Constructor** \n\ \n\ The function dataObject([dims [, dtype='uint8'[, continuous = 0][, data = valueOrSequence]]])\n\ creates a new itom-dataObject filled with undefined data.\n\ If no parameters are given, an uninitilized DataObject (dims = 0, no sizes) is created.\n\ \n\ As second possibility you can also use the copy-constructor 'dataObject(anyArray : Union[dataObject, np.ndarray], dtype : str = '', continuous : int = 0)', \n\ where 'anyArray' must be any array-like structure which is parsable by the numpy-interface. If a dtype is given or if continuous is 1, \n\ the new data object will be a type-casted (and / or continuous) copy of 'anyArray'.\n\ \n\ See Also \n\ ---------- \n\ ones : Static method to construct a data object filled with ones. \n\ zeros : Static method to construct a data object filled with zeros. \n\ nans : Static method to construct a data object (float or complex only) with NaNs. \n\ rand : Static method to construct a randomly filled data object (uniform distribution). \n\ randN : Static method to construct a randomly filled data object (gaussian distribution).")
	brief description More...
	PyDoc_STRVAR (dataObjectAttrDims_doc,"int : Gets the number of dimensions of this data object.")
	PyDoc_STRVAR (dataObjectAttrType_doc,"str : Gets the data type name of the values in this dataObject. \n\ \n\ This type string has one of these values: ``uint8``, ``int8``, ``uint16``, \n\ ``int16``, ``int32``, ``float32``, ``float64``, ``complex64``, ``complex128``, \n\ ``rgba32``.")
	PyDoc_STRVAR (dataObjectAttrContinuous_doc,"bool : Returns ``True`` if this dataObject is continuous, otherwise ``False``. \n\ \n\ If ``True``, the whole matrix is allocated in one huge block in memory, hence, \n\ this data object can be transformed into a numpy representation \n\ without reallocating memory.")
	PyDoc_STRVAR (dataObjectAttrShape_doc,"tuple of int : Gets the shape of this data object. \n\ \n\ The shape is a tuple where each element is the size of one dimension of this \n\ dataObject. As an example ``shape = [2, 3]`` corresponds to a ``2 x 3`` dataObject. \n\ \n\ Notes\n\ ------\n\ In difference to the shape attribute of :class:`numpy.ndarray`, this attribute cannot \n\ be set. \n\ \n\ See Also \n\ --------- \n\ size : Alternative method to return the size of all or any specific axis")
	PyDoc_STRVAR (dataObjectAttrTags_doc,"types.MappingProxyType : Gets or sets a dictionary with tags of this data object. \n\ \n\ This attribute returns a :obj:`dict_proxy` object of the tag dictionary of this \n\ data object. This object is read-only. However you can assign an entire new \n\ dictionary to this attribute that fully replaces the old tag dictionary. \n\ The tag dictionary can contain arbitrary pairs of key -> value where value is either \n\ a :class:`str` or a :class:`float` value. \n\ \n\ Special tags are the key ``protocol`` that contains the newline-separated protocol \n\ string of the data object (see: :meth:`addToProtocol`) or the key ``title`` that \n\ can for instance be used as title in any plots. \n\ \n\ You can add single elements using the method :meth:`setTag` or you can delete tags \n\ using :meth:`deleteTag`.\n\ \n\ Do NOT use **special character** within the tag key because they are not XML-save.")
	PyDoc_STRVAR (dataObjectAttrAxisScales_doc,"tuple of float : Gets or sets the optional scale values for each axis [unit/px]. \n\ \n\ This attribute gives access to the internal axis scales [unit/px] expressed as \n\ a :class:`tuple` of :class:`float` values. The i-th value in the tuple corresponds \n\ to the scaling factor of the i-th axis. Either assign a new tuple with the same \n\ length than the number of dimensions or change single values using tuple indexing. \n\ \n\ Definition: ``Physical unit = (px-Coordinate - offset)* scale`` \n\ \n\ If the data object is plot with scalings != 1, the scaled (physical) units are \n\ displayed in the plot. \n\ \n\ See Also \n\ --------- \n\ setAxisScale : Alternative method to set the scale value of one single axis")
	PyDoc_STRVAR (dataObjectAttrAxisOffsets_doc,"tuple of float : Gets or sets the optional offset values for each axis [px]. \n\ \n\ This attribute gives access to the internal axis offsets [px] expressed as \n\ a :class:`tuple` of :class:`float` values. The i-th value in the tuple corresponds \n\ to the pixel-offset of the i-th axis. Either assign a new tuple with the same length \n\ than the number of dimensions or change single values using tuple indexing. \n\ \n\ Definition: ``Physical unit = (px-Coordinate - offset)* scale`` \n\ \n\ If the data object is plot with offsets != 0, the scaled (physical) units are \n\ displayed in the plot. \n\ \n\ See Also \n\ --------- \n\ setAxisOffset : Alternative method to set the offset value of one single axis")
	PyDoc_STRVAR (dataObjectAttrAxisDescriptions_doc,"tuple of str : Gets or sets the optional description of each axis. \n\ \n\ This tuple contains the description of each axis. The length of this tuple \n\ is equal to the number of dimensions of the dataObject. \n\ \n\ You can either assign a new tuple with the same length or change single values using \n\ tuple indexing. \n\ \n\ The axis descriptions are considered if the data object is plotted. \n\ \n\ See Also \n\ --------- \n\ setAxisDescriptions : alternative method to change the description string of one single axis.")
	PyDoc_STRVAR (dataObjectAttrAxisUnits_doc,"tuple of str : Gets or sets the optional unit value of each axis. \n\ \n\ This tuple contains the unit value of each axis. The length of this tuple \n\ is equal to the number of dimensions of the dataObject. \n\ \n\ You can either assign a new tuple with the same length or change single values using \n\ tuple indexing. \n\ \n\ The axis units are considered if the data object is plotted. \n\ \n\ See Also \n\ --------- \n\ setAxisDescriptions : alternative method to change the description string of one single axis.")
	PyDoc_STRVAR (dataObjectAttrValueUnit_doc,"str : Gets or sets the unit of the values of the dataObject. \n\ \n\ The value unit is considered if the dataObject is plotted.")
	PyDoc_STRVAR (dataObjectAttrValueDescription_doc,"str : Gets or sets the description of the values of the dataObject. \n\ \n\ The value description is considered if the dataObject is plotted.")
	PyDoc_STRVAR (dataObjectAttrValueScale_doc,"float : Gets the scaling factor for the values. This value is always 1.0.")
	PyDoc_STRVAR (dataObjectAttrValueOffset_doc,"float : Gets the offset value for the values. This value is always 0.0.")
	PyDoc_STRVAR (dataObjectAttrValue_doc,"tuple : Gets or sets the values of this dataObject, defined as flattened tuple \n\ \n\ If this attribute is called by means of a getter, a tuple is returned which is \n\ created by iterating through the values of the data object (row-wise). The values \n\ in the tuple depend on the :attr:`dtype` of this dataObject and can be :class:`int`, \n\ :class:`float`, :class:`complex` or :class:`rgba`. Analog to this, pass a new tuple \n\ of number values and the correct size to change the values of this dataObject. The \n\ size and shape of the object cannot be changed. \n\ \n\ Example: ::\n\ \n\ b = dataObject[1, 1:10, 1, 1].value\n\ # or for the first value \n\ b = dataObject[1, 1:10, 1, 1].value[0]\n\ # The elements of the tuple are adressed with b[idx].")
	PyDoc_STRVAR (dataObjectAttrRotationalMatrix_doc,"list of list of float : Gets or sets the 3x3 rotation matrix of this dataObject. \n\ \n\ This rotation matrix is part of the meta information section and is not used \n\ for any other purposes. \n\ \n\ The rotation matrix is given as nested list of three elements. Each element is \n\ another list of three float values and correspond to one row in the ``3 x 3`` \n\ rotation matrix.")
	PyDoc_STRVAR (pyDataObjectSetAxisOffset_doc,"setAxisOffset(axisNum, axisOffset) \n\ \n\ Sets the offset value of one specific axis of this dataObject. \n\ \n\ Each axis in the data object can get a specific offset value, given in pixels. \n\ The offset value for one axis can be set by this method. Getting or setting \n\ single or all offset values for all axis can also be achieved by the attribute \n\ :attr:`axisOffsets`. \n\ \n\ The conversion between physical and pixel units is: \n\ \n\ ``physical_value = (pixel_value - axisOffset) * axisScale`` \n\ \n\ Parameters \n\ ------------\n\ axisNum : int\n\ The axis index in the range [0, n), where ``n`` is the dimension of this dataObject. \n\ axisOffset : float\n\ New axis offset value in pixels. \n\ \n\ Raises \n\ ------- \n\ RuntimeError \n\ if the given ``axisNum`` is out of range. \n\ \n\ See Also \n\ --------- \n\ axisOffsets : this attribute can directly be used to get or set the axis offset(s) of single or all axes")
	PyDoc_STRVAR (pyDataObjectSetAxisScale_doc,"setAxisScale(axisNum, axisScale) \n\ \n\ Sets the scaling value of one specific axis of this dataObject. \n\ \n\ Each axis in the data object can get a specific scale value, given in ``axisUnits`` \n\ per pixels. The scale value for one axis can be set by this method. Getting or setting \n\ single or all scaling values for all axis can also be achieved by the attribute \n\ :attr:`axisScales`. \n\ \n\ The conversion between physical and pixel units is: \n\ \n\ ``physical_value = (pixel_value - axisOffset) * axisScale`` \n\ \n\ Parameters \n\ ----------\n\ axisNum : int\n\ The axis index in the range [0, n), where ``n`` is the dimension of this dataObject. \n\ axisScale : float\n\ New scale value for this axis in [unit/px]. \n\ \n\ Raises \n\ ------- \n\ RuntimeError \n\ if the given ``axisNum`` is out of range. \n\ \n\ See Also \n\ --------- \n\ axisScales : this attribute can directly be used to get or set the axis scale(s) of single or all axes")
	PyDoc_STRVAR (pyDataObjectSetAxisDescription_doc,"setAxisDescription(axisNum, axisDescription) \n\ \n\ Sets the axis description of one axis. \n\ \n\ Each axis in the data object can get a specific description string (e.g. 'x-axis'). \n\ \n\ Parameters \n\ ------------\n\ axisNum : int\n\ The axis index in the range [0, n), where ``n`` is the dimension of this dataObject. \n\ axisDescription : str\n\ New axis description.\n\ \n\ Raises \n\ ------- \n\ RuntimeError \n\ if the given ``axisNum`` is out of range \n\ \n\ See Also \n\ --------- \n\ axisDescriptions : this attribute can directly be used to get or set the axis description(s) of single or all axes")
	PyDoc_STRVAR (pyDataObjectSetAxisUnit_doc,"setAxisUnit(axisNum, axisUnit) \n\ \n\ Sets the unit of the specified axis. \n\ \n\ Each axis in the data object can get a specific unit string (e.g. 'mm'). \n\ \n\ Parameters \n\ ------------\n\ axisNum : int\n\ The axis index in the range [0, n), where ``n`` is the dimension of this dataObject. \n\ axisUnit : str\n\ New axis unit.\n\ \n\ Raises \n\ ------- \n\ RuntimeError \n\ if the given ``axisNum`` is out of range. \n\ \n\ See Also \n\ --------- \n\ axisUnits : this attribute can directly be used to get or set the axis unit(s) of single or all axes")
	PyDoc_STRVAR (pyDataObjectPhysToPix_doc,"physToPix(values, axes = 0) -> Union[float, Tuple[float]] \n\ \n\ Returns transformed values from physical to pixel coordinates. \n\ \n\ This method transforms a physical axis coordinate into its corresponding pixel \n\ coordinate. The transformation is defined by the current offset and scale value of \n\ the specific axis: \n\ \n\ ``phys = (pix - offset) * scaling`` \n\ \n\ If no axes parameter is given, the values are assumed to belong the the ascending axis \n\ list (0, 1, 2, 3...). The returned pixel value is clipped by the real size of the data \n\ object in the requested dimension ``[0, shape[axis] - 1]``. \n\ \n\ Parameters \n\ ------------\n\ values : float or sequence of float\n\ One single physical coordinate or a tuple of physical coordinates.\n\ axes : int or sequence of int, optional \n\ If ``values`` is a single value, axes must be ``None`` or one integer, that defines \n\ the axis for which the transformation should be calculated. \n\ If ``values`` is a tuple of float values, axes can be one single value (all values \n\ are transformed with respect to the same axis), or a tuple of int, whose size must be \n\ equal to the size of the ``axes`` tuple. Each value is then transformed with the \n\ corresponding value in ``axes``. \n\ If ``None`` is given, ``axes`` is assumed to be an ascending list of values ``0, 1, 2, ...``. \n\ \n\ Returns \n\ -------- \n\ float or tuple of float \n\ The transformed physical coordinates for the given axes to pixel coordinates. \n\ \n\ Raises \n\ ------- \n\ ValueError \n\ if the given axes is out of range \n\ RuntimeWarning \n\ if requested physical unit is outside of the range of the requested axis. \n\ The returned pixel value is clipped to the closest boundary value.")
	PyDoc_STRVAR (pyDataObjectPixToPhys_doc,"pixToPhys(values, axes = 0) -> Union[float, Tuple[float]] \n\ \n\ Returns transformed values from pixel to physical coordinates. \n\ \n\ This method transforms a pixel axis coordinate into its corresponding physical \n\ coordinate. The transformation is defined by the current offset and scale value of \n\ the specific axis: \n\ \n\ ``pix = (phys / scaling) + offset`` \n\ \n\ If no axes parameter is given, the values are assumed to belong the the ascending axis \n\ list (0, 1, 2, 3...). The returned pixel value is clipped by the real size of the data \n\ object in the requested dimension ``[0, shape[axis] - 1]``. \n\ \n\ Parameters \n\ ------------\n\ values : float or sequence of float\n\ One single pixel coordinate or a tuple of pixel coordinates.\n\ axes : int or sequence of int, optional \n\ If ``values`` is a single value, axes must be ``None`` or one integer, that defines \n\ the axis for which the transformation should be calculated. \n\ If ``values`` is a tuple of float values, axes can be one single value (all values \n\ are transformed with respect to the same axis), or a tuple of int, whose size must be \n\ equal to the size of the ``axes`` tuple. Each value is then transformed with the \n\ corresponding value in ``axes``. \n\ If ``None`` is given, ``axes`` is assumed to be an ascending list of values ``0, 1, 2, ...``. \n\ \n\ Returns \n\ -------- \n\ float or tuple of float \n\ The transformed pixel coordinates for the given axes to physical coordinates. \n\ \n\ Raises \n\ ------- \n\ ValueError \n\ if the given axes is out of range.")
	PyDoc_STRVAR (pyDataObjectSetTag_doc,"setTag(key, value) \n\ \n\ Set the ``value`` of a tag with the given ``key`` name. \n\ \n\ If a tag with the given ``key`` exists, its value is overwritten. Else, a tag with \n\ that ``key`` is added to the tags. \n\ \n\ Parameters \n\ ----------\n\ key : str\n\ the name of the tag.\n\ tagvalue : str or float\n\ The new value of the tag. Must be a :obj:`str` or a :obj:`float` value. \n\ \n\ Notes \n\ ----- \n\ Do NOT use 'special character' within the tag key because they are not XML-save.")
	PyDoc_STRVAR (pyDataObjectDeleteTag_doc,"deleteTag(key) -> bool \n\ \n\ Deletes a tag specified by ``key`` from the tag dictionary. \n\ \n\ Parameters \n\ ------------\n\ key : str\n\ the name of the tag to be deleted.\n\ \n\ Returns \n\ -------- \n\ success : bool \n\ ``True`` if tag with given key existed and could be deleted, otherwise ``False``.")
	PyDoc_STRVAR (pyDataObjectTagExists_doc,"existTag(key) -> bool \n\ \n\ Checks if a certain tag key exists. \n\ \n\ Checks whether a tag with the given ``key`` exists in tag dictionary of this \n\ data object and returns ``True`` if such a tag exists, else ``False``. \n\ \n\ Parameters \n\ ------------\n\ key : str\n\ the key of the tag.\n\ \n\ Returns \n\ -------- \n\ bool\n\ ``True`` if tag exists, else ``False``")
	PyDoc_STRVAR (pyDataObjectGetTagListSize_doc,"getTagListSize() -> int \n\ \n\ Returns the number of tags in the tag dictionary.\n\ \n\ Every data object can have an arbitrary number of tags stored in the tag dictionary. \n\ This method returns the number of different tags, where the protocol is also one \n\ tag with the key ``protocol``. \n\ \n\ Returns \n\ ------- \n\ length : int \n\ Size of the tag dictionary. The optional protocol also counts as one item.")
	PyDoc_STRVAR (pyDataObjectAddToProtocol_doc,"addToProtocol(newLine) \n\ \n\ Appends one string entry to the protocol list. \n\ \n\ Appends a line of text to the protocol string of this data object. \n\ If this data object has got a region of interest defined, the rectangle of the ROI is \n\ automatically appended to ``newLine``. The protocol string ends with a newline character. \n\ \n\ Address the content of the protocol by ``obj.tags[\"protocol\"]``. The protocol is \n\ contained in the ordinary tag dictionary of this data object under the key ``protocol``. \n\ \n\ Parameters \n\ ------------\n\ newLine : str\n\ The text to be added to the protocol.")
	PyDoc_STRVAR (pyDataObjectName_doc,"name() -> str \n\ \n\ Returns the name of this object \n\ \n\ Returns \n\ ------- \n\ str \n\ the name of this object (``dataObject``)")
	PyDoc_STRVAR (pyDataObjectData_doc,"data() \n\ \n\ Prints the content of the dataObject to the command line in a readable form.")
	PyDoc_STRVAR (pyDataObjectConj_doc,"conj() \n\ \n\ Converts this dataObject into its complex-conjugate (inline). \n\ \n\ Every value of this :class:`dataObject` is replaced by its complex-conjugate value. \n\ \n\ Raises \n\ ------- \n\ TypeError \n\ if the data type of this data object is not complex.\n\ \n\ See Also \n\ --------- \n\ conjugate : does the same operation but returns a complex-conjugated copy of this data object")
	PyDoc_STRVAR (pyDataObjectConjugate_doc,"conjugate() -> dataObject \n\ \n\ Returns a copy of this dataObject where every element is complex-conjugated. \n\ \n\ Returns \n\ ------- \n\ dataObject \n\ element-wise complex conjugate of this data object \n\ \n\ Raises \n\ ------- \n\ TypeError \n\ if the data type of this data object is not complex.\n\ \n\ See Also \n\ --------- \n\ conj : does the same operation but manipulates this object inline.")
	PyDoc_STRVAR (pyDataObjectAdj_doc,"adj() \n\ \n\ Adjugates this dataObject (plane-by-plane). \n\ \n\ Every plane (spanned by the last two axes) is transposed and every element is \n\ replaced by its complex conjugate value. This is done in-line. \n\ \n\ Raises \n\ ------- \n\ TypeError \n\ if the data type of this data object is not complex.\n\ \n\ See Also \n\ --------- \n\ adjugate : does the same operation but returns the resulting data object")
	PyDoc_STRVAR (pyDataObjectAdjugate_doc,"adjugate() -> dataObject \n\ \n\ Returns the plane-wise adjugated array of this dataObject. \n\ \n\ If this data object has a complex type, the tranposed data object is returned where \n\ every element is complex conjugated. For data objects with more than two dimensions \n\ the tranposition is done plane-wise, hence, only the last two dimensions are permuted. \n\ \n\ Returns \n\ ------- \n\ dataObject \n\ adjugate of this dataObject. \n\ \n\ Raises \n\ ------- \n\ TypeError \n\ if the data type of this data object is not complex.\n\ \n\ See Also \n\ --------- \n\ adj : does the same operation but manipulates this object inline.")
	PyDoc_STRVAR (pyDataObjectTrans_doc,"trans() -> dataObject \n\ \n\ Returns the (plane-wise) transposed dataObject. \n\ \n\ Return a new data object with the same data type than this object and where every \n\ plane (data spanned by the last two dimensions) is transposed respectively \n\ such that the last two axes are permuted. The :attr:`shape` of the returned \n\ dataObject is then equal to the :attr:`shape` of this dataObject, but the last two \n\ values in the shape tuple are swapped. \n\ \n\ Returns \n\ -------- \n\ dataObject \n\ A copy of this dataObject is returned where every plane is its transposed plane.")
	PyDoc_STRVAR (pyDataObjectMakeContinuous_doc,"makeContinuous() -> dataObject \n\ \n\ Returns a continuous representation of this dataObject.\n\ \n\ Per default a dataObject with more than two dimensions allocates separated chunks of \n\ memory for every plane, where a plane is always the matrix given by the last two \n\ dimensions. This separated storage usually allows allocating more memory for huge for \n\ instance three dimensional matrices. However, in order to generate a dataObject that is \n\ directly compatible to Numpy or other C-style matrix structures, the entire allocated \n\ memory must be in one block, that is called continuous. If you create a Numpy array \n\ from a dataObject that is not continuous, this function is implicitely called in order \n\ to firstly make the dataObject continuous before passing to Numpy. \n\ \n\ Returns \n\ -------- \n\ dataObject \n\ If this dataObject is not continuous, its continuous representation is returned \n\ as deep copy. A deep copy is also returned if this object is already :attr:`continuous`.")
	PyDoc_STRVAR (pyDataObjectSize_doc,"size(axisIndex = None) -> Union[int, Tuple[int]] \n\ \n\ Returns the size of the selected axis of this dataObject or the entire shape tuple, if no specific axis is given. \n\ \n\ Parameters \n\ ------------\n\ axisIndex : int, optional\n\ If ``axisIndex`` is given, only the size of the indicated axis is returned as \n\ single number. \n\ \n\ Returns \n\ -------- \n\ int or tuple of int \n\ A tuple containing the sizes of all dimensions or one single size value \n\ if ``axisIndex`` is given. \n\ \n\ Raises \n\ ------ \n\ DeprecatedWarning \n\ This method is deprecated. For a more consistent syntax with \n\ :class:`numpy.ndarray` objects, use :attr:`shape` instead. \n\ \n\ See Also \n\ --------- \n\ shape : the read-only attribute shape is equal to ``size()``.")
	PyDoc_STRVAR (pyDataObjectCopy_doc,"copy(regionOnly = False) -> dataObject \n\ \n\ Returns a deep copy of this dataObject\n\ \n\ Parameters \n\ ----------- \n\ regionOnly : bool, optional \n\ If ``regionOnly`` is ``True``, only the current region of interest of this \n\ dataObject is copied, else the entire dataObject including the shaded areas outside \n\ of the current region of interest are copied, including the ROI settings [default].\n\ \n\ Returns \n\ ------- \n\ dataObject \n\ Deep copy of this dataObject. \n\ \n\ See Also \n\ -------- \n\ locateROI")
	PyDoc_STRVAR (pyDataObjectMul_doc,"mul(otherObj) -> dataObject \n\ \n\ Returns the result of the element-wise multiplication of this dataObject with otherObj. \n\ \n\ This :class:`dataObject` and ``otherObj`` must have the same :attr:`shape` and \n\ :attr:`dtype` for the element-wise multiplication. \n\ \n\ All meta information (axis scales, offsets, descriptions, units, tags...) of the \n\ resulting object are copied from this data object. \n\ \n\ Parameters \n\ ------------\n\ otherObj : dataObject \n\ The returned :class:`dataObject` contains the result of the element-wise \n\ multiplication of all values in this object and ``otherObj``. Must have the \n\ same shape and data type than this object. \n\ \n\ Returns \n\ -------- \n\ result : dataObject \n\ Resulting multiplied data object. Values, that exceed the range of the current \n\ data type, will be set to the ``result modulo max(dtype)``. \n\ \n\ Notes \n\ ------ \n\ For a mathematical multiplication see the @-operator.")
	PyDoc_STRVAR (pyDataObjectDiv_doc,"div(otherObj) -> dataObject \n\ \n\ Returns the result of the element-wise division of this dataObject by otherObj. \n\ \n\ This :class:`dataObject` and ``otherObj`` must have the same :attr:`shape` and \n\ :attr:`dtype` for the element-wise division. \n\ \n\ All meta information (axis scales, offsets, descriptions, units, tags...) of the \n\ resulting object are copied from this data object. \n\ \n\ Parameters \n\ ------------\n\ otherObj : dataObject \n\ The returned :class:`dataObject` contains the result of the element-wise \n\ division of all values in this object by ``otherObj``. Must have the \n\ same shape and data type than this object. \n\ \n\ Returns \n\ -------- \n\ result : dataObject \n\ Resulting divided data object. Values, that exceed the range of the current \n\ data type, will be set to the ``result modulo max(dtype)``. \n\ \n\ Raises \n\ ------ \n\ RuntimeError \n\ if a **division by zero** occurs for integer or complex data types.")
	PyDoc_STRVAR (pyDataObjectReshape_doc,"reshape(shape) -> dataObject \n\ \n\ Returns a reshaped (shallow) copy of this dataObject. \n\ \n\ Reshaping means, that the shape (and optionally number of dimensions) of a \n\ :class:`dataObject` might be changed, unless the total number of elements is \n\ not changed. The reshaped and returned :class:`dataObject` has the same data type and \n\ data than this :class:`dataObject`. \n\ \n\ The shape of the returned object corresponds to the parameter ``shape``. \n\ If the last two dimensions of ``shape`` and of this object are equal and if the \n\ data is not continously organized, a shallow copy can be returned, else a deep \n\ copy has to be created. \n\ \n\ Tags and the rotation matrix are copied. The axis tags are only copied for all axes \n\ whose size will not change beginning from the last axis (``x``). Copying the axis \n\ meta information is stopped after the first axis with a differing new size. \n\ \n\ Parameters \n\ ----------- \n\ shape : sequence of int \n\ New shape of the returned object. A minimal size of this list or tuple is two. \n\ \n\ Returns \n\ -------- \n\ reshaped : dataObject \n\ The reshaped data object. \n\ \n\ Notes \n\ ----- \n\ This method is similar to :meth:`numpy.reshape`.")
	PyDoc_STRVAR (pyDataObjectAstype_doc,"astype(typestring) -> dataObject \n\ \n\ Converts this dataObject to another data type.\n\ \n\ Converts this :class:`dataObject` to a new dataObject with another data type, given by \n\ the string ``typestring`` (e.g. 'uint8'). The converted dataObject is a deep copy of \n\ this object if the new type does not correspond to the current type, else a shallow \n\ copy of this object is returned. \n\ \n\ Parameters \n\ ----------- \n\ typestring : str \n\ Type string indicating the new type (``uint8``, ..., ``float32``, ..., \n\ ``complex128``). \n\ \n\ Returns \n\ -------- \n\ dataObject \n\ The converted :class:`dataObject`.")
	PyDoc_STRVAR (pyDataObjectNormalize_doc,"normalize(minValue = 0.0, maxValue = 1.0, typestring = \"\") -> dataObject \n\ \n\ Returns a normalized version of this dataObject. \n\ \n\ All values in the returned :class:`dataObject` are normalized with respect to the given \n\ range ``[minValue, maxValue]``. Additionally it is also possible to convert the \n\ resulting data object to another data type (given by the parameter ``typestring``). \n\ Per default, no such a type conversion is done (empty ``typestring`` argument). \n\ \n\ For the normalization, the current minimum and maximum value of this object is \n\ determined: \n\ \n\ .. math:: \n\ \n\ min_{cur} = min(thisObj) \n\ max_{cur} = max(thisObj) \n\ \n\ Each value `v` is then normalized by: \n\ \n\ .. math:: v_{norm} = minValue + (v - min_{cur}) * (maxValue - minValue) / (max_{cur} - min_{cur}) \n\ \n\ Parameters \n\ ----------- \n\ minValue : float \n\ minimum value of the normalized range. \n\ maxValue : float \n\ maximum value of the normalized range. \n\ typestring : str \n\ Data type for an optional type conversion. If an empty :obj:`str` is given, \n\ no such a conversion is done. Else possible values are (among others): \n\ (``uint8``, ..., ``float32``, ..., ``complex128``). \n\ \n\ Returns \n\ -------- \n\ normalized : dataObject \n\ normalized data object \n\ \n\ Notes \n\ ----- \n\ For complex data types, the current minimum and maximum values are calculated \n\ based on the absolute value of the complex values. Therefore, the normalization \n\ can have a different result, than maybe expected.")
	PyDoc_STRVAR (pyDataObjectLocateROI_doc,"locateROI() -> Tuple[List[int], List[int]] \n\ \n\ Returns information about the current region of interest of this dataObject. \n\ \n\ In Python, it is common to use slices of other objects, like lists, tuples, \n\ :class:`numpy.ndarray` among others. This slice represents a subpart of the original \n\ object, however the values within the slice are still the same than in the original \n\ object. \n\ \n\ The same holds for :class:`dataObject`, where a slice will return a shallow \n\ copy of the original object with a maybe reduced size. This is denoted as region \n\ of interest (ROI). Here an example:: \n\ \n\ org = dataObject.ones([100, 200], 'float32') \n\ roi = org[10:20, 5:9] # slicing \n\ \n\ roi[0, 0] = 100 # change one value in roi \n\ print(org[10, 5]) # returns 100 \n\ \n\ Although the first value in ``roi`` is changed, its corresponding value in ``org`` \n\ is changed, too. This is the principle of shallow copies and slicing / region of \n\ interests. \n\ \n\ This method returns information about the exact **position** of the region of \n\ interest within its original :class:`dataObject`. This is defined by two values \n\ for each axis. The first value indicates the distance between the left, top, etc. border \n\ of the original object and the border of this object. If no region of interest is set, \n\ these values are ``0`` everywhere. \n\ \n\ The second values define the distances between the right, bottom, ... margins of this \n\ object and its original object (or ``0`` everywhere, too). \n\ \n\ This method returns a tuple with two elements: The first is a list with the original \n\ sizes of this data object (if no ROI would have been set), the second is a list with \n\ the offsets from the original data object to the first value in the current region of \n\ interest. \n\ \n\ If no region of interest is set (hence: full region of interest), the first list \n\ corresponds to the one returned by :attr:`shape`, the 2nd list contains ``0`` everyhwere. \n\ \n\ The output of the example above would be:: \n\ \n\ print(roi.locateROI()) \n\ # >>> ([100, 200], [10, 5]) \n\ \n\ Returns \n\ ------- \n\ orgSize : list of int \n\ The original sizes of this object (without ROI). This is equal to :attr:`shape` \n\ of the original object. \n\ offsets : list of int \n\ A list with ``N`` values, where ``N`` is the number of dimensions of this object. \n\ Each value ``n = 1 .. N`` is the offset of the first value of axis ``n`` in this \n\ object with respect to the original object. \n\ \n\ See Also \n\ -------- \n\ adjustROI : method to change the current region of interest")
	PyDoc_STRVAR (pyDataObjectAdjustROI_doc,"adjustROI(offsets) \n\ \n\ Adjusts the size and position of the region of interest of this object.\n\ \n\ In Python, it is common to use slices of other objects, like lists, tuples, \n\ :class:`numpy.ndarray` among others. This slice represents a subpart of the original \n\ object, however the values within the slice are still the same than in the original \n\ object. \n\ \n\ The same holds for :class:`dataObject`, where a slice will return a shallow \n\ copy of the original object with a maybe reduced size. This is denoted as region \n\ of interest (ROI). Here an example:: \n\ \n\ org = dataObject.ones([100, 200], 'float32') \n\ roi = org[10:20, 5:9] # slicing \n\ \n\ roi[0, 0] = 100 # change one value in roi \n\ print(org[10, 5]) # returns 100 \n\ \n\ Although the first value in ``roi`` is changed, its corresponding value in ``org`` \n\ is changed, too. This is the principle of shallow copies and slicing / region of \n\ interests. \n\ \n\ This method is used to change to offset and / or size of the current ROI of this \n\ object. Of course, this ROI can never be bigger than the original array data. \n\ In order to change the position and / or size of the current region of interest, \n\ pass a sequence (list or tuple) of integer values. The length of this sequence \n\ must be ``2 * ndim``, where ``ndim`` is the number of dimensions of this object. \n\ Always two adjacent values in this sequence refer to one axis, starting with \n\ the first axis index and ending with the last one. The first value of such a pair \n\ of two values indicate the offset of the region of interest with respect to one \n\ border of this axis (e.g. the left or top border), the 2nd value is the offset \n\ with respect to the other side of this axis (e.g. the right or bottom border). \n\ Negative values decrease the size of the ROI towards the center, positive values \n\ will increase its current size. \n\ \n\ Example: :: \n\ \n\ d = dataObject([5, 4]) \n\ droi = dataObject(d) # make a shallow copy \n\ droi.adjustROI([-2, 0, -1, -1]) \n\ \n\ Now, ``droi`` has a ROI, whose first value is equal to ``d[2, 1]`` and its shape \n\ is ``(3, 2)``. \n\ \n\ Parameters \n\ ----------- \n\ offsets : list of int or tuple of int \n\ This sequence must have twice as many values than the number of dimensions of \n\ this :class:`dataObject`. A pair of numbers indicates the shift of the \n\ current boundaries of the region of interest in every dimension. The first value \n\ of each pair is the offset of the **left** boundary, the second the shift of the \n\ **right** boundary. A positive value means a growth of the region of interest, \n\ a negative one let the region of interest shrink towards the center. \n\ \n\ Raises \n\ ------ \n\ RuntimeError \n\ if desired, new ROI exceeds the original shape of this :class:`dataObject`. \n\ \n\ See Also \n\ --------- \n\ locateROI : method to get the borders of the current ROI")
	PyDoc_STRVAR (pyDataObjectSqueeze_doc,"squeeze() -> dataObject \n\ \n\ Returns a squeezed shallow copy (if possible) of this dataObject. \n\ \n\ This method removes every dimension with size equal to ``1``. A shallow copy is only \n\ returned, if the sub-arrays, spanned by the last two dimensions (denoted as planes), \n\ are not affected by the squeeze operation and if the data block in the \n\ :class:`dataObject` is not continuous. Else a deep copy has to be returned due to an \n\ overall re-alignment of the matrix. The returned object can never have less than \n\ two dimensions. If this is the case, the last or second to last dimensions with a size \n\ of ``1`` is not deleted. If :this method returns a shallow copy, a change in a \n\ value will change the same value in the original object, too. \n\ \n\ Returns \n\ -------- \n\ squeezed : dataObject \n\ The squeezed data object. \n\ \n\ Notes \n\ ----- \n\ This method is similar to :meth:`numpy.squeeze`.")
	PyDoc_STRVAR (dataObjectAttrReal_doc,"dataObject : Gets or sets the `real` part of this ``complex64`` or ``complex128`` object. \n\ \n\ The real part object has the same shape than this :class:`dataObject`. If the data type \n\ of this object is ``complex64``, the real part object has the data type ``float32``. \n\ For a ``complex128`` object, the real part is ``float64``. \n\ \n\ If a real part object is set to this attribute, it can be either a :class:`numpy.ndarray` \n\ or a :class:`dataObject` with the same shape than this object and the appropriate data type. \n\ However, it is also possible to pass an :obj:`int` or :obj:`float` value. This value is \n\ then assigned to the real part of all complex values. \n\ \n\ Raises \n\ ------ \n\ TypeError \n\ if this :class:`dataObject` has no complex data type.")
	PyDoc_STRVAR (dataObjectAttrImag_doc,"dataObject : Gets or sets the `imag` part of this ``complex64`` or ``complex128`` object. \n\ \n\ The imaginary part object has the same shape than this :class:`dataObject`. If the data type \n\ of this object is ``complex64``, the imag part object has the data type ``float32``. \n\ For a ``complex128`` object, the imag part is ``float64``. \n\ \n\ If an imaginary part object is set to this attribute, it can be either a :class:`numpy.ndarray` \n\ or a :class:`dataObject` with the same shape than this object and the appropriate data type. \n\ However, it is also possible to pass an :obj:`int` or :obj:`float` value. This value is \n\ then assigned to the imaginary part of all complex values. \n\ \n\ Raises \n\ ------ \n\ TypeError \n\ if this :class:`dataObject` has no complex data type.")
	PyDoc_STRVAR (pyDataObjectAbs_doc,"abs() -> dataObject \n\ \n\ Returns a new dataObject with the absolute values of this object. \n\ \n\ The absolute values in the resulting :class:`dataObject` are determined for \n\ both real (integer and floating point) and complex data types of this object. \n\ This method raises a ``TypeError`` for a ``rgba32`` data type. \n\ \n\ Raises \n\ ------ \n\ TypeError \n\ if this method is called for a dataObject of data type ``rgba32``. \n\ \n\ Returns \n\ ------- \n\ absObj : dataObject \n\ Array with the same size than this object, that contains the absolute values \n\ of this object. If the data type of this object is complex, the returned \n\ object has the corresponding floating point data type. Else, the data type \n\ is unchanged. If this :class:`dataObject` has an unsigned integer data type, \n\ its shallow copy is returned without any changes.")
	PyDoc_STRVAR (pyDataObjectArg_doc,"arg() -> dataObject \n\ \n\ Returns a new data object with the argument values of this complex type dataObject. \n\ \n\ This method calculates the argument value of each element in this :class:`dataObject`\n\ and returns these values as new dataObject with the same shape than this object. \n\ This object must be of complex data type (``complex128`` or ``complex64``). \n\ The output data type will be float then (``float64`` or ``float32``).\n\ \n\ Returns \n\ ------- \n\ argObj : dataObject \n\ is the argument function applied to all values of this dataObject.")
	PyDoc_STRVAR (dataObjectAttrTagDict_doc,"dict : Gets or sets a dictionary with all meta information of this dataObject. \n\ \n\ The dictionary contains the following key-value-pairs. If a new dictionary \n\ is set to this attribute, all these values must be contained in the dict: \n\ \n\ * axisOffsets : List with offsets of each axis. \n\ * axisScales : List with the scales of each axis. \n\ * axisUnits : List with the unit strings of each axis. \n\ * axisDescriptions : List with the description strings of each axis. \n\ * tags : Dictionary with all tags including the tag **protocol** if at least \n\ one protocol entry has been added using :meth:`addToProtocol`. \n\ * valueOffset : Offset of each value (0.0). \n\ * valueScale : Scale of each value (1.0). \n\ * valueDescription : Description of the values. \n\ * valueUnit : The unit string of the values. \n\ \n\ This attribute was read-only until itom 4.0. It is settable from itom 4.1 on. \n\ \n\ See Also \n\ -------- \n\ addToProtocol, axisOffsets, axisScales, axisUnits, axisDescriptions, \n\ valueUnit, valueDescription, tags")
	PyDoc_STRVAR (dataObjectArray_StructGet_doc,"Any : General python-array interface (do not call this directly) \n\ \n\ This interface makes the data object compatible to every array structure in Python \n\ which does equally implement the array interface (e.g. NumPy). This method is \n\ therefore a helper method for the array interface.")
	PyDoc_STRVAR (dataObjectArray_Interface_doc,"dict : General python-array interface (do not call this directly). \n\ \n\ This interface makes the data object compatible to every array structure in python \n\ which does equally implement the array interface (e.g. NumPy).")
	PyDoc_STRVAR (dataObject_Array__doc,"__array__(dtype = None) -> np.ndarray \n\ \n\ Returns a numpy.ndarray from this dataObject. If possible a shallow copy is returned. \n\ \n\ If no ``dtype`` is given and if the this :class:`dataObject` is continuous, \n\ a :class:`numpy.ndarray` that shares its memory with this dataObject is returned. \n\ If the desired ``dtype`` does not fit to the type of this :class:`dataObject`, \n\ a casted deep copy is returned. This is also the case if this dataObject is not \n\ continuous. Then a continuous dataObject is created that is the base object of \n\ the returned :class:`numpy.ndarray`. \n\ \n\ Parameters \n\ ---------- \n\ dtype : numpy.dtype, optional \n\ A :class:`numpy.dtype` object that describes the data type, data alignment etc. \n\ for the returned :class:`numpy.ndarray`. \n\ \n\ Returns \n\ ------- \n\ arr : numpy.ndarray \n\ The converted :class:`numpy.ndarray`")
	PyDoc_STRVAR (pyDataObj_ToGray_doc,"toGray(destinationType = \"uint8\") -> dataObject \n\ \n\ Converts this ``rgba32`` coloured dataObject into a gray-scale dataObject. \n\ \n\ The returned :class:`dataObject` has the same size than this :class:`dataObject` \n\ and the real-value data type, that is given by ``destinationType``. The pixel-wise \n\ conversion is done using the formula: \n\ \n\ .. math: gray = 0.299 * red + 0.587 * green + 0.114 * blue.\n\ \n\ Parameters \n\ ----------- \n\ destinationType : {\"uint8\", \"int8\", \"uint16\", \"int16\", \"int32\", \"float32\", \"float64\"}, optional \n\ Desired data type of the returned dataObject (only real value data types allowed). \n\ \n\ Returns \n\ ------- \n\ gray : dataObject \n\ converted gray-scale data object of desired type. \n\ \n\ Raises \n\ ------ \n\ TypeError \n\ if this dataObject is no ``rgba32`` object or if the ``destinationType`` is invalid.")
	PyDoc_STRVAR (pyDataObj_SplitColor_doc,"splitColor(color, destinationType = \"uint8\") -> dataObject \n\ \n\ Splits selected color channels from this coloured ``rgba32`` dataObject. \n\ \n\ A ``rgba32`` coloured :class:`dataObject` contains color values for each item. \n\ Each color value contains a red, green, blue and alpha (transparancy) component (uint8 \n\ each). This method allows extracting one or several of these components from this \n\ dataObject. These components are then returned in single slices of a new, first axis \n\ of the returned dataObject. \n\ \n\ The returned :class:`dataObject` has one axis more than this object. This new axis \n\ is prepended to the existing axes, that have the same shape than this object. The data \n\ type of the returned object is ``destinationType``. \n\ \n\ The size of the first, new axis is equal to the number of letters in ``color``. \n\ Each letter must be one of the characters ``b``, ``r``, ``g`` or ``a``, that stand \n\ for the available channels of the color, that can be extracted. \n\ \n\ Example: :: \n\ \n\ color = dataObject.zeros([20, 10], 'rgba32') \n\ split_colors = color.splitColor(\"rgb\") \n\ print(split_colors.shape, split_colors.dtype) \n\ # printout: [3, 20, 10], \"uint8\" \n\ \n\ In this example, the :attr:`shape` of ``split_colors`` is ``[3, 20, 10]``, since \n\ three channels (red, green and blue) should have been splitted, such that \n\ ``split_colors[0, :, :]`` contains the red component, etc. \n\ \n\ Parameters \n\ ----------- \n\ color : str \n\ Desired color string, that indicates the type and order of extracted color \n\ components. This string can consist of the following letters: ``('b', 'r', 'g', 'a')``. \n\ It is possible to combine different channels, like ``\"arg\"`` which extracts the \n\ alpha channel, followed by red and gree. \n\ destinationType : {\"uint8\", \"int8\", \"uint16\", \"int16\", \"int32\", \"float32\", \"float64\"}, optional \n\ Desired data type of the returned dataObject (only real value data types allowed). \n\ \n\ Returns \n\ ------- \n\ dataObject \n\ containing the selected channel values \n\ \n\ Raises \n\ ------ \n\ TypeError \n\ if this :class:`dataObject` is no ``rgba32`` object or if ``destinationType`` \n\ is no real data type.")
	PyDoc_STRVAR (pyDataObj_ToNumpyColor_doc,"toNumpyColor(addAlphaChannel = 0) -> np.ndarray \n\ \n\ Converts a 2D dataObject of type ``rgba32`` to a 3D numpy.ndarray of type ``uint8``. \n\ \n\ Many Python packages, e.g. OpenCV (cv2) or PIL store coloured array such that the color \n\ components are stored in an additional axis, which is the last axis of all axes. \n\ Hence, there is no specific ``rgba2`` data type for :class:`numpy.ndarray`, like it \n\ is the case for :class:`dataObject`. \n\ \n\ This method converts a coloured :class:`dataObject` of dtype ``rgba32`` to a compatible \n\ :class:`numpy.ndarray`, where the color components are stored in an additional last axis. \n\ The size of this last axis is either ``3`` if ``addAlphaChannel = 0`` or ``4`` otherwise. \n\ The order of this last axis is ``blue``, ``green``, ``red`` and optional ``alpha``. \n\ The remaining first axes of the returned object have the same shape than this dataObject. \n\ \n\ Parameters \n\ ----------- \n\ addAlphaChannel : int, optional \n\ If ``0``, the last dimension of the returned :class:`numpy.ndarray` has a size of ``3`` \n\ and contains the blue, green and red value, whereas ``1`` adds the alpha value as \n\ fourth value. \n\ \n\ Returns \n\ ------- \n\ arr : numpy.ndarray \n\ The 3D :class:`numpy.ndarray` of dtype ``uint8``. The shape is ``[*obj.shape, 3]`` or \n\ ``[*obj.shape, 4]``, depending on ``addAlphaChannel``, where ``obj`` is this \n\ :class:`dataObject`.")
	PyDoc_STRVAR (pyDataObjectToList_doc,"tolist() -> list \n\ \n\ Returns a nested list with all values of this dataObject. \n\ \n\ An empty :class:`dataObject` with zero dimensions will return an empty list. \n\ Else, the depth of the nested list corresponds to the number of dimensions \n\ of this :class:`dataObject`. The innermost level corresponds to one ``row`` \n\ of this dataObject, or in general, to one set of values along the last \n\ axis of this object. This innermost list contains all these values. \n\ \n\ Returns \n\ ------- \n\ list \n\ Nested list with values of data object. The data types depend on the ``dtype`` \n\ of this dataObject and can be :obj:`int`, :obj:`float`, :obj:`complex` or \n\ :class:`rgba`.")
	PyDoc_STRVAR (pyDataObjectCreateMask_doc,"createMask(shapes, inverse = False) -> dataObject \n\ \n\ Returns an ``uint8`` mask dataObject where all pixels of this object that are contained in any shape are masked. \n\ \n\ The returned :class:`dataObject` has the same shape than this object and the data type \n\ ``uint8``. All pixels in this object, that are contained in any of the given :class:`shape` \n\ will be set to ``255`` in the returned array, otherwise ``0``. \n\ \n\ Parameters \n\ ----------- \n\ shapes : shape or list of shape or tuple of shape \n\ The union of all given shapes (polygons, rectangles, squares, circles and ellipes \n\ are considered, only) is used to determine if any pixel should be masked in the \n\ returned mask (value ``255``) or not. \n\ inverse : bool \n\ If ``True``, masked values are set to ``0`` (instead of ``255``) and all other \n\ values are set to ``255`` (instead of ``0``). The default is ``False`` (masked = ``255``). \n\ \n\ Returns \n\ ------- \n\ mask : dataObject \n\ uint8 :class:`dataObject` as mask with the same shape, :attr:`axisScales`, \n\ :attr:`axisOffsets`, :attr:`axisDescriptions` and :attr:`axisUnits` than this \n\ object.")
	PyDoc_STRVAR (pyDataObjectDstack_doc,"dstack(objects) -> dataObject \n\ \n\ Returns a 3D dataObject with the stacked dataObjects in the objects sequence. \n\ \n\ The given dataObjects must all have the same type as well as the same size of both \n\ last axes / dimensions. This method then returns a 3d :class:`dataObject` of the same \n\ type, whose size of the two last axes correspond to those of the input ``objects``. \n\ The returned 3D :class:`dataObject` contains then a stacked representation of all \n\ given input dataObjects depth wise (along first axis). \n\ \n\ If any of the input dataObjects has more than two dimensions, all contained planes \n\ (x,y-matrices) are also stacked in the resulting object.\n\ \n\ Parameters \n\ ----------- \n\ objects : list of dataObject or tuple of dataObject \n\ Sequence (list) of dataObjects containing planes that will be stacked together. \n\ All dataObjects must be of the same type and have the same shape of planes \n\ (last two dimensions).\n\ \n\ Returns \n\ ------- \n\ stack : dataObject \n\ If ``objects`` is an empty list or tuple, an empty :class:`dataObject` is returned. \n\ Else if ``objects`` only contains one array, this array is returned. Otherwise, \n\ all dataObjects (2D or 3D) in ``objects`` are vertically stacked along the first \n\ axis, which is prepended to the existing axes before.")
	PyDoc_STRVAR (pyDataObjectLineCut_doc,"lineCut(coordinates) -> dataObject \n\ \n\ Returns a dataObject with the values of this object along a line with the given coordinates. \n\ \n\ This method uses the **Bresenham** algorithm to get the nearest values along \n\ a line, whose start- and end-point is given by ``coordinates``. These values \n\ are returned in a new :class:`dataObject` with the same data type than this \n\ object. \n\ \n\ This method can be applied to 2D and 3D dataObjects. In the case of a 3D object, \n\ the line cut is defined plane-by-plane and the values are put in one row \n\ for each plane of this object. \n\ \n\ Parameters \n\ ----------- \n\ coordinates : list of float or tuple of float \n\ A sequence of 4 :class:`float` values, that define the physical coordinates \n\ of the start- and end point of the desired line along which the nearest values \n\ should be gathered. The values are: ``[x0, y0, x1, y1]``. \n\ \n\ Returns \n\ ------- \n\ lineCut : dataObject \n\ An array of the same data type than this object and shape ``P x N``, that \n\ contains the nearest values along the given line coordinates. If this \n\ :class:`dataObject` has two dimensions, ``P = 1``, else ``P`` is equal \n\ to the size of the first dimension (``shape[0]``). ``N`` corresponds to \n\ the number of points along the line, defined by the used **Bresenham** \n\ algorithm. \n\ \n\ Raises \n\ ------ \n\ RuntimeError \n\ if this dataObject has more than three dimensions.")
	PyDoc_STRVAR (pyDataObjectStaticZeros_doc,"dims, dtype= \"uint8\", continuous = 0) -> dataObject \n\ \n\ Creates a dataObject filled with zeros. \n\ \n\ Parameters \n\ ----------- \n\ dims : tuple of int or list of int \n\ ``dims`` is the shape of the new :class:`dataObject`. The length of this list \n\ or tuple defines the number of dimensions, e.g. ``[2, 3]`` creates a 2D dataObject\n\ with two rows and three columns. \n\ dtype : str, optional \n\ The desired data type for the elements in the returned :class:`dataObject`. \n\ Possible values are: ``int8``, ``uint8``, ..., ``int32``, ``float32``, \n\ ``float64``, ``complex64``, ``complex128``, ``rgba32``. \n\ continuous : int, optional \n\ This value defines if the planes (each sub-array of the last two dimensions) \n\ are continuously allocated in memory (``1``) or distributed in various smaller \n\ junks (``0``, default). The latter is recommended for huge, n-dimensional matrices. \n\ This argument is only considered for ``len(dims) > 2``. \n\ \n\ Returns \n\ ------- \n\ array : dataObject \n\ The newly created dataObject of shape ``dims`` and data type ``dtype``, filled with \n\ zeros. \n\ \n\ See Also \n\ --------- \n\ eye : method for creating an eye matrix \n\ ones : method for creating a matrix filled with ones \n\ \n\ Notes \n\ ------ \n\ For the color data type ``rgba32``, every value will be black and transparent: \n\ ``(r=0, g=0, b=0, alpha=0)``.")
	PyDoc_STRVAR (pyDataObjectStaticOnes_doc,"ones(dims, dtype= \"uint8\", continuous = 0) -> dataObject \n\ \n\ Creates a dataObject filled ones. \n\ \n\ Parameters \n\ ----------- \n\ dims : tuple of int or list of int \n\ ``dims`` is the shape of the new :class:`dataObject`. The length of this list \n\ or tuple defines the number of dimensions, e.g. ``[2, 3]`` creates a 2D dataObject\n\ with two rows and three columns. \n\ dtype : str, optional \n\ The desired data type for the elements in the returned :class:`dataObject`. \n\ Possible values are: ``int8``, ``uint8``, ..., ``int32``, ``float32``, \n\ ``float64``, ``complex64``, ``complex128``, ``rgba32``. \n\ continuous : int, optional \n\ This value defines if the planes (each sub-array of the last two dimensions) \n\ are continuously allocated in memory (``1``) or distributed in various smaller \n\ junks (``0``, default). The latter is recommended for huge, n-dimensional matrices. \n\ This argument is only considered for ``len(dims) > 2``. \n\ \n\ Returns \n\ ------- \n\ array : dataObject \n\ The newly created dataObject of shape ``dims`` and data type ``dtype``, filled with \n\ ones. \n\ \n\ See Also \n\ --------- \n\ eye : method for creating an eye matrix \n\ zeros : method for creating a matrix filled with zeros \n\ \n\ Notes \n\ ------ \n\ For the color data type ``rgba32``, every value will be white: \n\ ``(r=255, g=255, b=255, alpha=255)``.")
	PyDoc_STRVAR (pyDataObjectStaticNans_doc,"nans(dims, dtype= \"float32\", continuous = 0) -> dataObject \n\ \n\ Creates a floating-point dataObject filled with ``NaN`` values. \n\ \n\ Parameters \n\ ----------- \n\ dims : tuple of int or list of int \n\ ``dims`` is the shape of the new :class:`dataObject`. The length of this list \n\ or tuple defines the number of dimensions, e.g. ``[2, 3]`` creates a 2D dataObject\n\ with two rows and three columns. \n\ dtype : str, optional \n\ The desired data type for the elements in the returned :class:`dataObject`. \n\ Possible values are: ``float32``, ``float64``, ``complex64``, ``complex128``. \n\ continuous : int, optional \n\ This value defines if the planes (each sub-array of the last two dimensions) \n\ are continuously allocated in memory (``1``) or distributed in various smaller \n\ junks (``0``, default). The latter is recommended for huge, n-dimensional matrices. \n\ This argument is only considered for ``len(dims) > 2``. \n\ \n\ Returns \n\ ------- \n\ array : dataObject \n\ The newly created dataObject of shape ``dims`` and data type ``dtype``, filled with \n\ ``NaN``. \n\ \n\ See Also \n\ --------- \n\ eye : method for creating an eye matrix \n\ zeros : method for creating a matrix filled with zeros \n\ ones : method for creating a matrix filled with ones.")
	PyDoc_STRVAR (pyDataObjectStaticRand_doc,"rand(dims, dtype= \"uint8\", continuous = 0) -> dataObject \n\ \n\ Creates a dataObject filled with uniformly distributed random values. \n\ \n\ The value range of the random numbers depend on the desired data type ``dtype``: \n\ \n\ 1. **integer types**: The random values are in the range ``[min(dtype), max(dtype)]``. \n\ 2. **floating point types**: The random values are in the range ``[0, 1)``. \n\ 3. **rgba32**: All colours as well as the alpha value is independently distributed in \n\ the range ``[0, 255]``. \n\ 4. **complex types**: Both the real as well as imaginary part is independently \n\ distributed in the range ``[0, 1)``. \n\ \n\ Parameters \n\ ----------- \n\ dims : tuple of int or list of int \n\ ``dims`` is the shape of the new :class:`dataObject`. The length of this list \n\ or tuple defines the number of dimensions, e.g. ``[2, 3]`` creates a 2D dataObject\n\ with two rows and three columns. \n\ dtype : str, optional \n\ The desired data type for the elements in the returned :class:`dataObject`. \n\ Possible values are: ``int8``, ``uint8``, ..., ``int32``, ``float32``, \n\ ``float64``, ``complex64``, ``complex128``, ``rgba32``. \n\ continuous : int, optional \n\ This value defines if the planes (each sub-array of the last two dimensions) \n\ are continuously allocated in memory (``1``) or distributed in various smaller \n\ junks (``0``, default). The latter is recommended for huge, n-dimensional matrices. \n\ This argument is only considered for ``len(dims) > 2``. \n\ \n\ Returns \n\ ------- \n\ array : dataObject \n\ The newly created dataObject of shape ``dims`` and data type ``dtype``, filled with \n\ random numbers. \n\ \n\ See Also \n\ --------- \n\ randN : method for creating a matrix filled with gaussian distributed values")
	PyDoc_STRVAR (pyDataObjectStaticRandN_doc,"randN(dims, dtype= \"uint8\", continuous = 0) -> dataObject \n\ \n\ Creates a dataObject filled with Gaussian distributed random values. \n\ \n\ The value range of the random numbers depend on the desired data type ``dtype``: \n\ \n\ 1. **integer types**: The random values are in the range ``[min(dtype), max(dtype)]``. \n\ 2. **floating point types**: The random values are in the range ``[0, 1)``. \n\ 3. **rgba32**: All colours as well as the alpha value is independently distributed in \n\ the range ``[0, 255]``. \n\ 4. **complex types**: Both the real as well as imaginary part is independently \n\ distributed in the range ``[0, 1)``. \n\ \n\ The mean ``m`` and standard deviation ``s`` of the Gaussian distribution is as follows: \n\ \n\ * For **integer** and **rgba32** types holds: ``m = (min + max) / 2.0`` and \n\ ``s = (max - min) / 6.0``. \n\ * For all **floating point** types holds: ``m = 0.0`` and ``s = 1/3``. \n\ \n\ Parameters \n\ ----------- \n\ dims : tuple of int or list of int \n\ ``dims`` is the shape of the new :class:`dataObject`. The length of this list \n\ or tuple defines the number of dimensions, e.g. ``[2, 3]`` creates a 2D dataObject\n\ with two rows and three columns. \n\ dtype : str, optional \n\ The desired data type for the elements in the returned :class:`dataObject`. \n\ Possible values are: ``int8``, ``uint8``, ..., ``int32``, ``float32``, \n\ ``float64``, ``complex64``, ``complex128``, ``rgba32``. \n\ continuous : int, optional \n\ This value defines if the planes (each sub-array of the last two dimensions) \n\ are continuously allocated in memory (``1``) or distributed in various smaller \n\ junks (``0``, default). The latter is recommended for huge, n-dimensional matrices. \n\ This argument is only considered for ``len(dims) > 2``. \n\ \n\ Returns \n\ ------- \n\ array : dataObject \n\ The newly created dataObject of shape ``dims`` and data type ``dtype``, filled with \n\ random numbers. \n\ \n\ See Also \n\ --------- \n\ rand : method for creating a matrix filled with unformly distributed values")
	PyDoc_STRVAR (pyDataObjectStaticEye_doc,"eye(size, dtype= \"uint8\") -> dataObject \n\ \n\ Creates a two-dimensional, squared ``eye`` matrix.\n\ \n\ An eye matrix is an array where all elements are equal to zero, except for \n\ the diagonal values which are set to ``1``. For ``dtype == rgba32``, the \n\ diagonal values are ``r = 0, g = 0, b = 1, alpha = 0``. \n\ \n\ Parameters \n\ ----------- \n\ size : int \n\ The size of the squared matrix (single integer value).\n\ dtype : str, optional \n\ The desired data type for the elements in the returned :class:`dataObject`. \n\ Possible values are: ``int8``, ``uint8``, ..., ``int32``, ``float32``, \n\ ``float64``, ``complex64``, ``complex128``, ``rgba32``. \n\ \n\ Returns \n\ ------- \n\ eyeMatrix : dataObject \n\ The created eye-matrix as ``size x size`` :class:`dataObject`. \n\ \n\ See Also \n\ --------- \n\ ones : method for creating a matrix filled with ones \n\ zeros : method for creating a matrix filled with zeros")
	PyDoc_STRVAR (pyDataObjectStaticFromNumpyColor_doc,"fromNumpyColor(array) -> dataObject \n\ \n\ Creates a ``rgba32`` dataObject from a three-dimensional numpy.ndarray. \n\ \n\ Static method for creating a 2D ``M x N`` :class:`dataObject` of data type ``rgba32`` \n\ from a three-dimensional, ``uint8`` :class:`numpy.ndarray``. This ``array`` must have \n\ the shape ``M x N x 3`` or ``M x N x 4``. Each vector ``array[i, j, :]`` is then \n\ used to create one ``rgba32`` value in the returned :class:`dataObject`. The meaning \n\ of this vector is: \n\ \n\ 1. (blue, green, red) if ``array`` consists of three channels (last dimension). \n\ The ``rgba32`` value then gets an alpha value set to 255 everywhere. \n\ 2. (blue, green, red, alpha) if ``array`` consists of four channels (last dimension). \n\ \n\ This method can especially be used to convert numpy.arrays that are obtained by methods \n\ from packages like ``OpenCV (cv2)`` or ``PIL`` to dataObjects. \n\ \n\ Parameters \n\ ----------- \n\ array : numpy.ndarray \n\ ``M x N x 3`` or ``M x N x 4``, uint8 :class:`numpy.ndarray` \n\ \n\ Returns \n\ ------- \n\ dataObject \n\ Coloured dataObject of shape ``M x N`` and data type ``rgba32``.")
	PyDoc_STRVAR (pyDataObjectCopyMetaInfo_doc,"copyMetaInfo(sourceObj, copyAxisInfo = True, copyTags = False) \n\ \n\ Copies meta information of another dataObject to this object. \n\ \n\ This method can be used to copy all or parts of meta information of the \n\ :class:`dataObject` ``sourceObj`` to this object. The following things \n\ are copied, depending on the arguments of this method: \n\ \n\ Axis meta information: \n\ \n\ * axis scaling and offset (see :attr:`axisScales` and :attr:`axisOffsets`) \n\ * axis descriptions and units (see :attr:`axisDescriptions` and :attr:`axisUnits`) \n\ \n\ Tags: \n\ \n\ * the entire tag map (string key vs. string or float value), including the protocol \n\ string. The existing tag map in this object is deleted first. \n\ \n\ Parameters \n\ ------------\n\ sourceObj : dataObject \n\ source object, where meta information is copied from. \n\ copyAxisInfo : bool, optional \n\ If ``True``, all axis meta information is copied. \n\ copyTags : bool, optional \n\ If ``True``, the tags of this data object are cleared and then set to a copy \n\ of the tags of ``sourceObj``. \n\ \n\ \n\ See Also \n\ --------- \n\ metaDict : this attribute can directly be used to print meta information of a dataObject.")
	PyDoc_STRVAR (pyDataObject_base_doc,"None or dataObject or np.ndarray : Optional base object, this object shares its memory with (read-only).")
	PyDoc_STRVAR (pyDataObjectIterLen_doc,"Private method returning an estimate of len(list(it)).")
	PyDoc_STRVAR (pyFigureInit_doc,"figure(handle = -1, rows = 1, cols = 1, x0 = -1, y0 = -1, width = -1, height = -1) -> figure \n\ \n\ Creates a new figure window.\n\ \n\ The class :class:`figure` represents a standalone figure window, that can have \n\ various subplots. If an instance of this class is created without further parameters, \n\ a new figure is created and opened having one subplot area (currently empty) and the \n\ integer handle to this figure is returned:: \n\ \n\ h: int = figure() \n\ \n\ Subplots are arranged in a regular grid whose size is defined by the optional \n\ parameters ``rows`` and ``cols``. If you create a figure instance with a given handle, \n\ the instance is either a reference to an existing figure that has got this handle or if \n\ it does not exist, a new figure with the desired handle is opened and the handle is \n\ returned, too. \n\ \n\ Using the parameters ``width`` and ``height``, it is possible to control the size of the figure. \n\ If one of both parameters are not set or <= 0 (default), no size adjustment is done at all. \n\ \n\ The size and position control can afterwards done using the property ``geometry`` of \n\ the figure. \n\ \n\ Parameters \n\ ------------- \n\ handle : int \n\ integer handle of the desired figure. \n\ rows : int, optional \n\ number of rows this figure should have (defines the size of the subplot-grid) \n\ cols : int, optional \n\ number of columns this figure should have (defines the size of the subplot-grid) \n\ x0 : int, optional \n\ If ``x0`` is != -1, its left position is set to this value. \n\ y0 : int, optional \n\ If ``y0`` is != -1, its top position is set to this value. \n\ width : int, optional \n\ If ``width`` is != -1, the width of the figure window is set to this value. \n\ height : int, optional \n\ If ``height`` is != -1, the height of the figure window is set to this value. \n\ \n\ Returns \n\ ------- \n\ figure \n\ is the reference to the newly created figure object.")
	PyDoc_STRVAR (pyFigurePlot_doc,"plot(data, areaIndex = currentAreaIndex, className = \"\", properties = {}) -> plotItem \n\ \n\ Plots a dataObject, pointCloud or polygonMesh in the current or given area of this figure.\n\ \n\ Plots an existing :class:`dataObject`, :class:`pointCloud` or :class:`polygonMesh` in \n\ the newly created plot. The style of the plot depends on the object dimensions.\n\ \n\ If no ``className`` is given, the type of the plot is chosen depending on the type and \n\ the size of the object. The defaults for several plot classes can be adjusted in the \n\ property dialog of itom. \n\ \n\ You can also set a class name of your preferred plot plugin (see also property dialog of itom). \n\ If your preferred plot is not able to display the given object, a warning is returned and the \n\ default plot type is used again. For :class:`dataObject`, it is also possible to simply set \n\ ``className`` to ``1D``, ``2D`` or ``2.5D`` in order to choose the default plot type depending \n\ on these aliases. For :class:`pointCloud` and :class:`polygonMesh` only the alias ``2.5D`` is valid. \n\ \n\ Every plot has several properties that can be configured in the Qt Designer (if the \n\ plot is embedded in a GUI), or by the property toolbox in the plot itself or by using \n\ the :meth:`~itom.uiItem.info` method of the corresponding :class:`itom.uiItem` instance. \n\ \n\ Use the ``properties`` argument to pass a dictionary with properties you want to set \n\ to certain values. \n\ \n\ Parameters\n\ -----------\n\ data : dataObject or pointCloud or polygonMesh \n\ Is the data object whose region of interest will be plotted.\n\ areaIndex : int, optional \n\ Area index where the plot canvas should be created (if subplots exists). \n\ The default ``areaIndex`` is the current subplot area, hence, ``0`` if \n\ only one plot area exists in the figure. \n\ className : str, optional \n\ class name of desired plot (if not indicated or if the ``className`` can not be found, \n\ the default plot will be used (see application settings) \n\ properties : dict, optional \n\ Optional dictionary of properties that will be directly applied to the \n\ plot widget.\n\ \n\ Returns \n\ -------- \n\ plotHandle : plotItem \n\ Handle of the subplot. This handle is used to control the properties of the plot, \n\ connect signals to it or call slots of the plot.")
	PyDoc_STRVAR (pyFigurePlot1_doc,"plot1(data, xData = None, areaIndex = currentAreaIndex, className = \"\", properties = {}) -> plotItem \n\ \n\ Creates a 1D plot of a dataObject ``data`` in the current or given area of this figure.\n\ \n\ If ``xData`` is given, the plot uses this vector for the values of the ``x-axis`` of \n\ the plot.\n\ \n\ The plot type of this function is ``1D`` (see method :meth:`figure.plot`). If a \n\ ``className`` is given, that does not support the given type of ``data`` (or ``xData``) \n\ a warning is returned and the default plot class for the given data is used again. \n\ \n\ Every plot has several properties that can be configured in the Qt Designer (if the plot is \n\ embedded in a GUI), or by the property toolbox in the plot itself or by using the \n\ :meth:`~uiItem.info` method of the corresponding :class:`uiItem` instance. \n\ \n\ Use the ``properties`` argument to pass a dictionary with properties you want to set. \n\ \n\ Parameters\n\ -----------\n\ data : dataObject \n\ Is the data object whose region of interest will be plotted.\n\ xData : dataObject, optional \n\ 1D plots can optionally accept this :class:`dataObject`. If given, the \n\ values are not displayed on an equally distributed x-scale but with \n\ the values given by ``xData``. \n\ areaIndex : int, optional \n\ Area index where the plot canvas should be created (if subplots exists). \n\ The default ``areaIndex`` is the current subplot area, hence, ``0`` if \n\ only one plot area exists in the figure. \n\ className : str, optional \n\ class name of desired plot (if not indicated or if the ``className`` can not be found, \n\ the default plot will be used (see application settings) \n\ properties : dict, optional \n\ Optional dictionary of properties that will be directly applied to the \n\ plot widget.\n\ \n\ Returns \n\ -------- \n\ plotHandle : plotItem \n\ Handle of the subplot. This handle is used to control the properties of the plot, \n\ connect signals to it or call slots of the plot.")
	PyDoc_STRVAR (pyFigurePlot2_doc,"plot2(data, areaIndex = currentAreaIndex, className = \"\", properties = {}) -> plotItem \n\ \n\ Creates a 2D plot of a dataObject ``data`` in the current or given area of this figure.\n\ \n\ This method plots an existing :class:`dataObject` in the new 2D plot. \n\ The style of the plot depends on the object dimensions. The plot type of this function \n\ is ``2D`` (see method :meth:`figure.plot`).\n\ \n\ If the 2D plot is not able to display the given object, a warning is returned and the \n\ default plot type is used again.\n\ \n\ Every plot has several properties that can be configured in the Qt Designer (if the plot is \n\ embedded in a GUI), or by the property toolbox in the plot itself or by using the \n\ :meth:`~uiItem.info` method of the corresponding :class:`uiItem` instance. \n\ \n\ Use the ``properties`` argument to pass a dictionary with properties you want to set. \n\ \n\ Parameters\n\ -----------\n\ data : dataObject \n\ is the data, that should be plotted. If a ``className`` it must support dataObjects \n\ as accepted data type. Else, the default ``className`` for 2D :class:`dataObject` \n\ is chosen (see itom application settings for default plot types. \n\ areaIndex : int, optional \n\ Area index where the plot canvas should be created (if subplots exists). \n\ The default ``areaIndex`` is the current subplot area, hence, ``0`` if \n\ only one plot area exists in the figure. \n\ className : str, optional \n\ class name of desired plot (if not indicated or if the ``className`` can not be found, \n\ the default plot will be used (see application settings) \n\ properties : dict, optional \n\ Optional dictionary of properties that will be directly applied to the \n\ plot widget.\n\ \n\ Returns \n\ -------- \n\ plotHandle : plotItem \n\ Handle of the subplot. This handle is used to control the properties of the plot, \n\ connect signals to it or call slots of the plot.")
	PyDoc_STRVAR (pyFigurePlot25_doc,"plot25(data, areaIndex = currentAreaIndex, className = \"\", properties = {}) -> plotItem \n\ \n\ Creates a 2.5D plot of a dataObject, pointCloud or polygonMesh in the current or given area of this figure.\n\ \n\ This method plots ``data`` object in the new plot. The style of the plot depends on \n\ the object dimensions, its plot type is ``2.5D`` (see method :meth:`figure.plot`).\n\ \n\ If the 2.5D plot is not able to display the given object, a warning is returned and \n\ the default plot type is used again.\n\ \n\ Every plot has several properties that can be configured in the Qt Designer (if the plot is \n\ embedded in a GUI), or by the property toolbox in the plot itself or by using the \n\ :meth:`~uiItem.info` method of the corresponding :class:`uiItem` instance. \n\ \n\ Use the ``properties`` argument to pass a dictionary with properties you want to set. \n\ \n\ Parameters\n\ -----------\n\ data : dataObject or pointCloud or polygonMesh \n\ is the data, that should be plotted. If a ``className`` is given, only the \n\ type of data, supported by this class, can be displayed. Else, the default \n\ ``className`` for the kind of data is chosen (see itom application settings \n\ for default plot types. \n\ areaIndex : int, optional \n\ Area index where the plot canvas should be created (if subplots exists). \n\ The default ``areaIndex`` is the current subplot area, hence, ``0`` if \n\ only one plot area exists in the figure. \n\ className : str, optional \n\ class name of desired plot (if not indicated or if the ``className`` can not be found, \n\ the default plot will be used (see application settings) \n\ properties : dict, optional \n\ Optional dictionary of properties that will be directly applied to the \n\ plot widget.\n\ \n\ Returns \n\ -------- \n\ plotHandle : plotItem \n\ Handle of the subplot. This handle is used to control the properties of the plot, \n\ connect signals to it or call slots of the plot.")
	PyDoc_STRVAR (pyFigureLiveImage_doc,"liveImage(cam, areaIndex = currentAreaIndex, className = \"\", properties = {}) -> plotItem \n\ \n\ Shows a camera live image in the current or given area of this figure. \n\ \n\ If no ``className`` is given, the type of the plot is chosen depending on the type \n\ and the size of the object. The defaults for several plot classes can be adjusted in \n\ the property dialog of itom. \n\ \n\ You can also set a class name of your preferred plot plugin (see also property dialog \n\ of itom). If your preferred plot is not able to display the given object, a warning is \n\ returned and the default plot type is used again. For dataObjects, it is also possible \n\ to simply set ``className`` to `1D` or `2D` in order to choose the default plot type \n\ depending on these aliases. \n\ \n\ Every plot has several properties that can be configured in the Qt Designer (if the \n\ plot is embedded in a GUI), or by the property toolbox in the plot itself or by using \n\ the :meth:`~itom.uiItem.info` method of the corresponding :class:`itom.uiItem` instance. \n\ \n\ Use the ``properties`` argument to pass a dictionary with properties you want to set to \n\ certain values. \n\ \n\ Parameters\n\ -----------\n\ cam : dataIO \n\ Camera grabber device from which images are acquired.\n\ areaIndex : int, optional \n\ Area index where the plot canvas should be created (if subplots exists). \n\ The default ``areaIndex`` is the current subplot area, hence, ``0`` if \n\ only one plot area exists in the figure. \n\ className : str, optional \n\ class name of desired plot (if not indicated or if the ``className`` can not be found, \n\ the default plot will be used (see application settings) \n\ properties : dict, optional \n\ Optional dictionary of properties that will be directly applied to the \n\ plot widget.\n\ \n\ Returns \n\ -------- \n\ plotHandle : plotItem \n\ Handle of the subplot. This handle is used to control the properties of the plot, \n\ connect signals to it or call slots of the plot.")
	PyDoc_STRVAR (pyFigureMatplotlib_doc,"matplotlibFigure(areaIndex = currentAreaIndex, properties = {}) -> plotItem \n\ \n\ Creates a matplotlib canvas at the given area in the figure. \n\ \n\ Creates and returns a matplotlib canvas at the given area or returns an existing one. \n\ This canvas can be used as canvas argument for :class:`matplotlib.pyplot.figure` of \n\ matplotlib and is internally used by the itom backend of matplotlib. \n\ \n\ Parameters\n\ -----------\n\ areaIndex : int, optional \n\ Area index where the plot canvas should be created (if subplots exists). \n\ The default ``areaIndex`` is the current subplot area, hence, ``0`` if \n\ only one plot area exists in the figure. \n\ properties : dict, optional \n\ Optional dictionary of properties that will be directly applied to the \n\ plot widget.\n\ \n\ Returns \n\ -------- \n\ plotHandle : plotItem \n\ Handle of the subplot. This handle is used to control the properties of the plot, connect to \n\ its signals or call slots of the plot.")
	PyDoc_STRVAR (pyFigureShow_doc,"show() \n\ \n\ Shows the figure if it is currently hidden.")
	PyDoc_STRVAR (pyFigureHide_doc,"hide() \n\ \n\ Hides the figure, but does not delete it.")
	PyDoc_STRVAR (pyFigureSubplot_doc,"subplot(index) -> plotItem \n\ \n\ Returns :class:`plotItem` of desired subplot.\n\ \n\ Parameters \n\ ----------- \n\ index : int \n\ index to desired subplot in the range ``[0, n)``, where n is the number of subplots. \n\ The subplot at the top, left position has the index 0 and the index is \n\ incremented row-wise. \n\ \n\ Returns \n\ ------- \n\ plotItem \n\ The plot item of the desired subplot.")
	PyDoc_STRVAR (pyFigure_handle_doc,"int : gets the handle of this figure.")
	PyDoc_STRVAR (pyFigure_docked_doc,"bool : gets or sets the docked status of this figure. \n\ \n\ This attribute controls the dock appearance of this figure. If it is docked, the \n\ figure is integrated into the main window of itom, else it is a independent window. \n\ ")
	PyDoc_STRVAR (pyFigure_Close_doc,"close(handle) -> None \\\n\ close(all = \"all\") -> None \n\ \n\ Closes a specific or all opened figures. \n\ \n\ This method closes and deletes either one specific figure (if ``handle`` is given \n\ and valid), or all opened figures (if the string argument ``\"all\"`` is given). \n\ All figure can only be closed, if no other figure references this figure (e.g. \n\ line cut of an image plot (2D). \n\ \n\ Parameters \n\ ----------- \n\ handle : int \n\ a valid figure handle, whose reference figure should be closed. \n\ This figure handle is for instance obtained by the first value of the \n\ returned tuple of :meth:`plot`, :meth:`plot1`, :meth:`plot2` among others. \n\ all : {\"all\"} \n\ Pass the string ``\"all\"`` if all closeable opened figures should be closed. \n\ \n\ Notes \n\ ------- \n\ If a :class:`figure` instance still keeps a reference to any figure, it is only closed \n\ and will be deleted after that the last referencing instance has been deleted. \n\ \n\ See Also \n\ --------- \n\ itom.close")
	PyDoc_STRVAR (PyFont_doc,"font(family, pointSize = 0, weight = -1, italic = False) -> font \n\ \n\ Creates a font object. \n\ \n\ This class is a wrapper for the class `QFont` of the Qt framework. \n\ It provides possibilities for creating a font type. \n\ \n\ Parameters \n\ ----------- \n\ family : str \n\ The family name may optionally also include a foundry name, e.g. \"Helvetica [Cronyx]\". \n\ If the family is available from more than one foundry and the foundry isn't specified, \n\ an arbitrary foundry is chosen. If the family isn't available a family will be set \n\ using a best-matching algorithm. \n\ pointSize : int, optional \n\ If pointSize is zero or negative, the point size of the font is set to a \n\ system-dependent default value. Generally, this is 12 points. \n\ weight : int, optional \n\ Weighting scale from 0 to 99, e.g. ``font.Light``, ``font.Normal`` (default), \n\ ``font.DemiBold``, ``font.Bold``, ``font.Black``. \n\ italic : bool, optional \n\ Defines if font is italic or not (default)")
	PyDoc_STRVAR (font_getFamily_doc,"str : gets / sets the family name of the font. \n\ \n\ The name is case insensitive. It may optionally also include a foundry name, \n\ e.g. \"Helvetica [Cronyx]\". If the family is available from more than one \n\ foundry and the foundry isn't specified, an arbitrary foundry is chosen. If \n\ the family isn't available a family will be set using a font matching algorithm.")
	PyDoc_STRVAR (font_getWeight_doc,"int : gets or sets the weight of the font. \n\ \n\ This should be one of the constant values ``font.Light``, ``font.Normal``, \n\ ``font.DemiBold``, ``font.Bold``, ``font.Black`` enumeration or any value \n\ in the range [0, 99].")
	PyDoc_STRVAR (font_getPointSize_doc,"int : gets or sets the point size (> 0) of the font.")
	PyDoc_STRVAR (font_getItalic_doc,"bool : gets or sets the italic attribute of the font.")
	PyDoc_STRVAR (font_getStrikeOut_doc,"bool : gets or sets the strikeout attribute of the font.")
	PyDoc_STRVAR (font_getUnderline_doc,"bool : gets or sets the underline attribute of the font.")
	PyDoc_STRVAR (pyFont_isFamilyInstalled_DOC,"isFamilyInstalled(family) -> bool \n\ \n\ Checks if the given font family is installed on this computer. \n\ \n\ Parameters \n\ ----------- \n\ family : str \n\ The name of the font family that should be checked \n\ \n\ Returns \n\ --------- \n\ installed : bool \n\ ``True`` if family is installed, else ``False``.")
	PyDoc_STRVAR (pyFont_installedFontFamilies_DOC,"installedFontFamilies() -> List[str] \n\ \n\ Returns a list of all installed font families. \n\ \n\ Returns \n\ ------- \n\ list of str : \n\ list of the names of all installed font families")
	PyDoc_STRVAR (pyOpenEmptyScriptEditor_doc,"scriptEditor()\n\ \n\ Opens new, empty script editor window (undocked).\n\ \n\ Raises \n\ ------ \n\ RuntimeError \n\ if the current user has no permission to open a new script.")
	PyDoc_STRVAR (pyNewScript_doc,"newScript()\n\ \n\ Opens an empty, new script in the current script window.\n\ \n\ Raises \n\ ------ \n\ RuntimeError \n\ if the current user has no permission to open a new script.")
	PyDoc_STRVAR (pyOpenScript_doc,"openScript(filename) \n\ \n\ Open the given script in current script window.\n\ \n\ Open the python script indicated by *filename* in a new tab in the current, \n\ latest opened editor window. Filename can be either a string with a relative \n\ or absolute filename to the script to open or any object with a ``__file__`` \n\ attribute. This attribute is then read and used as path. \n\ \n\ The relative filename is relative with respect to the current directory. \n\ \n\ Parameters \n\ ----------- \n\ filename : str or Any \n\ Relative or absolute filename to a python script that is then opened \n\ (in the current editor window). Alternatively an object with a \n\ ``__file__`` attribute is allowed. \n\ \n\ Raises \n\ ------ \n\ RuntimeError \n\ if the current user has no permission to open a script.")
	PyDoc_STRVAR (pyShowHelpViewer_doc,"showHelpViewer(collectionFile = \"\") \n\ \n\ Opens the itom help viewer and displays the itom user documentation or another desired documentation. \n\ \n\ The user documentation is shown in the help viewer window. If ``collectionFile`` \n\ is given, this user-defined collection file is displayed in this help viewer.\n\ \n\ Parameters \n\ ----------- \n\ collectionFile : str, optional \n\ If given, the indicated Qt collection file (.qch) will be loaded in the help viewer.\n\ Per default, the user documentation is loaded (pass an empty string or nothing).")
	PyDoc_STRVAR (pyClearCommandLine_doc,"clc() \n\ \n\ Clears the itom command line (if available).")
	PyDoc_STRVAR (pyPlotImage_doc,"plot(data, className = \"\", properties = {}) -> Tuple[int, plotItem] \n\ \n\ Plots a dataObject, pointCloud or polygonMesh in a new figure window \n\ \n\ Plots an existing :class:`dataObject`, :class:`pointCloud` or :class:`polygonMesh` in a \n\ dockable, not blocking window. The style of the plot depends on the object dimensions.\n\ \n\ If no ``className`` is given, the type of the plot is chosen depending on the type and \n\ the size of the object. The defaults for several plot classes can be adjusted in the \n\ property dialog of itom. \n\ \n\ You can also set a class name of your preferred plot plugin (see also property dialog of itom). \n\ If your preferred plot is not able to display the given object, a warning is returned and the \n\ default plot type is used again. For :class:`dataObject`, it is also possible to simply set \n\ ``className`` to ``1D``, ``2D`` or ``2.5D`` in order to choose the default plot type depending \n\ on these aliases. For :class:`pointCloud` and :class:`polygonMesh` only the alias ``2.5D`` is valid. \n\ \n\ Every plot has several properties that can be configured in the Qt Designer (if the plot is \n\ embedded in a GUI), or by the property toolbox in the plot itself or by using the info() method \n\ of the corresponding :class:`~itom.uiItem` instance. \n\ \n\ Use the ``properties`` argument to pass a :obj:`dict` with properties you want to set. \n\ \n\ Parameters \n\ ----------- \n\ data : dataObject or pointCloud or polygonMesh \n\ Is the data object, point cloud or polygonal mesh, that will be plotted.\n\ className : str, optional \n\ class name of desired plot (if not indicated or if the className can not be found, the default \n\ plot will be used (see application settings)). Depending on the object, you can also set ``className`` \n\ to ``1D``, ``2D`` or ``2.5D`` for displaying the object in the default plot of \n\ the indicated categories. If nothing is given, the plot category is guessed from ``data``.\n\ properties : dict, optional \n\ optional dictionary of properties that will be directly applied to the plot widget. \n\ \n\ Returns \n\ -------- \n\ index : int \n\ This index is the figure index of the plot figure that is opened by this command. Use \n\ ``figure(index)`` to get a reference to the figure window of this plot. The plot can \n\ be closed by ``close(index)``. \n\ plotHandle : plotItem \n\ Handle of the plot. This handle is used to control the properties of the plot, connect to \n\ its signals or call slots of the plot. \n\ \n\ See Also \n\ --------- \n\ liveImage, plotItem, plot1, plot2, plot25")
	PyDoc_STRVAR (pyPlot1d_doc,"plot1(data, xData = None, className = \"\", properties = {}) -> Tuple[int, plotItem] \n\ \n\ Plots a dataObject as an 1d plot in a new figure window. \n\ \n\ This method plots an existing :class:`dataObject` ``data`` in a dockable, not blocking \n\ window. \n\ \n\ If ``xData`` is given, the plot uses this vector for the values of the x axis of the plot.\n\ \n\ The plot type of this function is ``1D`` (see method :meth:`plot`).\n\ \n\ Every plot has several properties that can be configured in the Qt Designer (if the plot is \n\ embedded in a GUI), or by the property toolbox in the plot itself or by using the \n\ :meth:`~uiItem.info` method of the corresponding :class:`uiItem` instance. \n\ \n\ Use the ``properties`` argument to pass a dictionary with properties you want to set. \n\ \n\ Parameters \n\ ----------- \n\ data : dataObject \n\ Is the :class:`dataObject` whose region of interest will be plotted.\n\ xData : dataObject, optional \n\ Is the :class:`dataObject` whose values are used for the axis.\n\ className : str, optional \n\ class name of the desired 1D plot (if not indicated, the default 1D plot will be used, \n\ see application settings) \n\ properties : dict, optional \n\ optional dictionary of properties that will be directly applied to the plot widget. \n\ \n\ Returns \n\ -------- \n\ index : int \n\ This index is the figure index of the plot figure that is opened by this command. \n\ Use ``figure(index)`` to get a reference to the figure window of this plot. The \n\ plot can be closed by ``close(index)``. \n\ plotHandle : plotItem \n\ Handle of the plot. This handle is used to control the properties of the plot, \n\ connect signals to it or call slots of the plot. \n\ \n\ See Also \n\ ---------- \n\ liveImage, plotItem, plot, plot2, plot25")
	PyDoc_STRVAR (pyPlot2d_doc,"plot2(data, properties = {}) -> Tuple[int, plotItem] \n\ \n\ Plots a dataObject in a new figure window.\n\ \n\ This method plots an existing :class:`dataObject` in a dockable, not blocking window. \n\ The style of the plot depends on the object dimensions. The plot type of this function \n\ is ``2D``.\n\ \n\ Every plot has several properties that can be configured in the Qt Designer (if the \n\ plot is embedded in a GUI), or by the property toolbox in the plot itself or by using \n\ the :meth:`~itom.uiItem.info` method of the corresponding :class:`itom.uiItem` instance. \n\ \n\ Use the ``properties`` argument to pass a dictionary with properties you want to set \n\ to certain values. \n\ \n\ Parameters \n\ ----------- \n\ data : dataObject \n\ Is the :class:`dataObject` whose region of interest will be plotted.\n\ className : str, optional \n\ class name of the desired `2D` plot (if not indicated default plot will be used, \n\ see application settings) \n\ properties : dict, optional \n\ optional dictionary of properties that will be directly applied to the plot widget. \n\ \n\ Returns \n\ -------- \n\ index : int \n\ This index is the figure index of the plot figure that is opened by this command. \n\ Use ``figure(index)`` to get a reference to the figure window of this plot. The \n\ plot can be closed by ``close(index)``. \n\ plotHandle : plotItem \n\ Handle of the plot. This handle is used to control the properties of the plot, \n\ connect signals to it or call slots of the plot. \n\ \n\ See Also \n\ ---------- \n\ liveImage, plotItem, plot, plot1, plot25")
	PyDoc_STRVAR (pyPlot25d_doc,"plot25(data, className = \"\", properties = {}) -> Tuple[int, plotItem] \n\ \n\ Plots a dataObject, pointCloud or polygonMesh in a new figure window. \n\ \n\ This method plots the ``data`` object in a dockable, not blocking window. \n\ The style of the plot depends on the object dimensions, its plot type is ``2.5D``.\n\ \n\ Every plot has several properties that can be configured in the Qt Designer (if the \n\ plot is embedded in a GUI), or by the property toolbox in the plot itself or by using \n\ the :meth:`~itom.uiItem.info` method of the corresponding :class:`itom.uiItem` instance. \n\ \n\ Use the ``properties`` argument to pass a dictionary with properties you want to set to \n\ desired values. \n\ \n\ Parameters \n\ ----------- \n\ data : dataObject or pointCloud or polygonMesh \n\ is the object, that is plotted.\n\ className : str, optional \n\ class name of the desired `2.5D` plot (if not indicated default plot will be used, \n\ see application settings) \n\ properties : dict, optional \n\ optional dictionary of properties that will be directly applied to the plot widget. \n\ \n\ Returns \n\ -------- \n\ index : int \n\ This index is the figure index of the plot figure that is opened by this command. \n\ Use ``figure(index)`` to get a reference to the figure window of this plot. The \n\ plot can be closed by ``close(index)``. \n\ plotHandle : plotItem \n\ Handle of the plot. This handle is used to control the properties of the plot, \n\ connect signals to it or call slots of the plot. \n\ \n\ See Also \n\ ---------- \n\ liveImage, plotItem, plot, plot1, plot2")
	PyDoc_STRVAR (pyLiveImage_doc,"liveImage(cam, className = \"\", properties = {}) -> Tuple[int, plotItem] \n\ \n\ Shows a camera live image in a new figure window. \n\ \n\ This method creates a plot-image (2D) and automatically grabs images into this window.\n\ \n\ If no ``className`` is given, the type of the plot is chosen depending on the type \n\ and the size of the object. The defaults for several plot classes can be adjusted in \n\ the property dialog of itom. \n\ \n\ You can also set a class name of your preferred plot plugin (see also property dialog \n\ of itom). If your preferred plot is not able to display the given object, a warning is \n\ returned and the default plot type is used again. For dataObjects, it is also possible \n\ to simply set ``className`` to `1D` or `2D` in order to choose the default plot type \n\ depending on these aliases. \n\ \n\ Every plot has several properties that can be configured in the Qt Designer (if the \n\ plot is embedded in a GUI), or by the property toolbox in the plot itself or by using \n\ the :meth:`~itom.uiItem.info` method of the corresponding :class:`itom.uiItem` instance. \n\ \n\ Use the ``properties`` argument to pass a dictionary with properties you want to set to \n\ certain values. \n\ \n\ Parameters \n\ ----------- \n\ cam : dataIO \n\ Camera grabber device from which images are acquired.\n\ className : str, optional \n\ class name of desired plot (if not indicated or if the ``className`` can not be found, \n\ the default plot will be used (see application settings) \n\ properties : dict, optional \n\ optional dictionary of properties that will be directly applied to the plot widget. \n\ \n\ Returns \n\ -------- \n\ index : int \n\ This index is the figure index of the plot figure that is opened by this command. \n\ Use ``figure(index)`` to get a reference to the figure window of this plot. The \n\ plot can be closed by ``close(index)``. \n\ plotHandle : plotItem \n\ Handle of the plot. This handle is used to control the properties of the plot, \n\ connect signals to it or call slots of the plot. \n\ \n\ See Also \n\ --------- \n\ plot, plotItem, plot1, plot2, plot25")
PyObject *	PyWidgetOrFilterHelp (bool getWidgetHelp, PyObject *pArgs, PyObject *pKwds)
	PyDoc_STRVAR (pyFilterHelp_doc,"filterHelp(filterName = \"\", dictionary = 0, furtherInfos = 0) -> Optional[dict] \n\ \n\ Print outs an online help for the given filter(s) or return help information as dictionary. \n\ \n\ This method prints information about one specific filter (algorithm) or a list of \n\ filters to the console output. If one specific filter, defined in an algorithm plugin, \n\ can be found that case-sensitively fits the given ``filterName``, its full documentation \n\ is printed or returned. Else, a list of filters is printed whose name contains the \n\ given ``filterName``.\n\ \n\ Parameters \n\ ----------- \n\ filterName : str, optional \n\ is the fullname or a part of any filter name which should be displayed. \n\ If ``filterName`` is empty or no filter matches ``filterName`` (case sensitive) \n\ a list with all suitable filters is given. \n\ dictionary : int, optional \n\ if ``1``, a dictionary with all relevant information about the documentation of \n\ this filter is returned as dictionary and nothing is printed to the command line \n\ (default: 0). \n\ furtherInfos : int, optional \n\ Usually, filters or algorithms whose name only contains the given ``filterName`` \n\ are only listed at the end of the information text. If this parameter is set \n\ to ``1`` (default: ``0``), the full information for all these filters is printed \n\ as well. \n\ \n\ Returns \n\ ------- \n\ info : dict \n\ This dictionary is only returned, if ``dictionary`` is set to ``1``. Else ``None`` \n\ is returned. The dictionary contains relevant information about the desired ``filterName``.")
	PyDoc_STRVAR (pyWidgetHelp_doc,"widgetHelp(widgetName = \"\", dictionary = 0, furtherInfos = 0) -> Optional[dict] \n\ \n\ Print outs an online help for the given widget(s) or return help information as dictionary. \n\ \n\ This method prints information about one specific widget (defined in an algorithm plugin) \n\ or a list of widgets to the console output. If one specific widget \n\ can be found that case-sensitively fits the given ``widgetName``, its full documentation \n\ is printed or returned. Else, a list of widgets is printed whose name contains the \n\ given ``widgetName``.\n\ \n\ Parameters \n\ ----------- \n\ widgetName : str, optional \n\ is the fullname or a part of any widget name which should be displayed. \n\ If ``widgetName`` is empty or no widget matches ``widgetName`` (case sensitive) \n\ a list with all suitable widgets is given. \n\ dictionary : int, optional \n\ if ``1``, a dictionary with all relevant information about the documentation of \n\ this widget is returned as dictionary and nothing is printed to the command line \n\ (default: 0). \n\ furtherInfos : int, optional \n\ Usually, widgets whose name only contains the given ``widgetName`` \n\ are only listed at the end of the information text. If this parameter is set \n\ to ``1`` (default: ``0``), the full information for all these widgets is printed \n\ as well. \n\ \n\ Returns \n\ ------- \n\ info : dict \n\ This dictionary is only returned, if ``dictionary`` is set to ``1``. Else ``None`` \n\ is returned. The dictionary contains relevant information about the desired ``widgetName``.")
	PyDoc_STRVAR (pyPluginLoaded_doc,"pluginLoaded(pluginName) -> bool \n\ \n\ Checks if a certain plugin could be successfully loaded.\n\ \n\ This method checks if a specified plugin is loaded and returns ``True`` if \n\ this is the case, otherwise ``False``. \n\ \n\ Parameters \n\ ----------- \n\ pluginName : str \n\ The name of a specified plugin as usually displayed in the plugin window.\n\ \n\ Returns \n\ ------- \n\ bool \n\ ``True``, if the plugin has been loaded and can be used, else ``False``.")
	PyDoc_STRVAR (pyPlotLoaded_doc,"plotLoaded(plotName) -> bool \n\ \n\ Checks if a certain plot widget is available and loaded.\n\ \n\ This method checks if a specified plot widget is available and loaded and \n\ returns ``True`` in case of success, otherwise ``False``. \n\ \n\ Parameters \n\ ----------- \n\ plotName : str \n\ The name of a specified plot widget as displayed in the itom property dialog. \n\ \n\ Returns \n\ ------- \n\ bool \n\ ``True``, if the plot has been loaded and can be used, else ``False``.")
	PyDoc_STRVAR (pyPlotHelp_doc,"plotHelp(plotName = \"\", dictionary = False) -> Optional[Union[List[str], dict]] \n\ \n\ Generates an online help for a desired plot class.\n\ \n\ The output of this method depend on the content of the argument ``plotName``: \n\ \n\ * If it is empty or a star (``*``), a list of all available and loaded plot classes is print to \n\ the command line (``dictionary=False``) or returned as ``List[str]``. \n\ * If it is a valid plot class name, all relevant information of this plot widget \n\ (Qt designer plugin), like supported data types, all properties, signals or slots... \n\ are printed to the command line or returned as nested dictionary structure. \n\ \n\ Parameters \n\ ----------- \n\ plotName : str \n\ See the description above. This value can either be an empty string or a star (``*``) \n\ or the name of a plot designer plugin class. \n\ dictionary : bool, optional \n\ if ``True``, this methods returns its output either as :class:`list` of :class:`str` or \n\ a :class:`dict` with information like slots, signals and properties of the desired plot \n\ classes (default: ``False``). \n\ \n\ Returns \n\ ------- \n\ None or list of str or dict \n\ Returns ``None``, a list of available plot class names or a nested dictionary with various \n\ information about the plot class (depending on the arguments).")
	PyDoc_STRVAR (pyPluginHelp_doc,"pluginHelp(pluginName, dictionary = False) -> Optional[dict] \n\ \n\ Generates an online help for the specific plugin.\n\ \n\ Information about an itom plugin library (actuator, dataIO or algorithm), gathered \n\ by this method, are the name of the plugin, its version, its type, contained filters \n\ (in case of an algorithm) or the description and initialization parameters (otherwise). \n\ \n\ Parameters \n\ ----------- \n\ pluginName : str \n\ is the fullname of a plugin library as specified in the plugin toolbox.\n\ dictionary : bool, optional \n\ if ``True``, this method returns a :class:`dict` with all gathered information \n\ about the plugin. Else (default), this information is printed to the command line. \n\ \n\ Returns \n\ ------- \n\ None or dict \n\ Returns None or a dict depending on the value of parameter ``dictionary``.")
	PyDoc_STRVAR (pyAboutInfo_doc,"aboutInfo(pluginName) -> str \n\ \n\ Returns the `about` information for the given plugin as string.\n\ \n\ Parameters \n\ ----------- \n\ pluginName : str \n\ is the name of a plugin library as specified in the plugin toolbox.\n\ \n\ Returns \n\ ------- \n\ str \n\ Returns a string containing the about information. \n\ \n\ Raises \n\ ------- \n\ RuntimeError \n\ if ``pluginName`` is an unknown plugin.")
	PyDoc_STRVAR (pyItomVersion_doc,"version(dictionary = False, addPluginInfo = False) -> Optional[dict] \n\ \n\ Retrieves, prints out or returns complete version information of itom (and optionally plugins). \n\ \n\ Parameters \n\ ----------- \n\ dictionary : bool, optional \n\ If ``True``, all information is returned as nested :class:`dict`. \n\ Otherwise (default), this information is printed to the command line. \n\ addPluginInfo : bool, optional \n\ If ``True``, version information about all loaded plugins are added, too. \n\ Default: ``False``. \n\ \n\ Returns \n\ ------- \n\ None or dict \n\ version information as nested dict, if ``dictionary`` is ``True``.")
	PyDoc_STRVAR (pyAddButton_doc,"addButton(toolbarName, buttonName, code, icon = \"\", argtuple = []) -> int \n\ \n\ Adds a button to a toolbar in the main window of itom. \n\ \n\ This function adds a button to a toolbar in the main window of itom. If the button is \n\ pressed the given code, function or method is executed. If the toolbar specified by \n\ ``toolbarName`` does not exist, it is created. The button will display an optional \n\ icon, or - if not given / not loadable - the ``buttonName`` is displayed as text. \n\ \n\ Itom comes with basic icons addressable by ``:/../iconname.png``, e.g.\n\ ``:/gui/icons/close.png``. These natively available icons are listed in the icon \n\ browser in the menu **edit >> icon browser** of any script window. Furthermore you \n\ can give a relative or absolute path to any allowed icon file (the preferred file \n\ format is png). \n\ \n\ For more information see also the section :ref:`toolbar-addtoolbar` of the documentation. \n\ \n\ **New in itom 4.1**: The ``code`` argument accepts all kind of callable objects, not \n\ only Python methods and functions. \n\ \n\ Parameters \n\ ----------- \n\ toolbarName : str \n\ The name of the toolbar.\n\ buttonName : str \n\ The name and identifier of the button to create.\n\ code : str or callable \n\ The code or callable to be executed if the button is pressed.\n\ If the code is a callable method, it can either be an unbounded function \n\ (including lambda functions) or a bounded member method of a class instance. \n\ In the latter case, the button does not keep a reference to the class \n\ instance, such that a ``RuntimeError`` is raised if the instance is not \n\ available any more if the button is triggered. \n\ icon : str, optional \n\ The filename of an icon file. This can also be relative to the application \n\ directory of **itom**.\n\ argtuple : tuple, optional \n\ Arguments, which will be passed to the method (in order to avoid cyclic \n\ references try to only use basic element types). \n\ \n\ Returns \n\ ------- \n\ handle : int \n\ handle to the newly created button (pass it to :meth:`removeButton` to delete \n\ exactly this button) \n\ \n\ Raises \n\ ------- \n\ RuntimeError \n\ if the main window is not available \n\ \n\ See Also \n\ --------- \n\ removeButton")
	PyDoc_STRVAR (pyRemoveButton_doc,"removeButton(handle) -> None \\\n\ removeButton(toolbarName, buttonName = \"\") -> None \n\ \n\ Removes one or all buttons from a given toolbar in the itom main window. \n\ \n\ This method removes an existing button from a toolbar in the main window of \n\ **itom**. This button must have been created by the method :meth:`addButton` before. \n\ If the toolbar is empty after the removal, it is finally deleted. \n\ \n\ A button can be identified by two different ways: \n\ \n\ 1. Either pass the ``handle`` of the button, as returned by :meth:`addButton`. \n\ This can also be used, if multiple buttons should have the same name. \n\ 2. Identify the button by its ``toolbarName`` and ``buttonName``. If more than \n\ one button is available in the toolbar with the given ``buttonName``, all \n\ matched buttons are removed. If ``buttonName`` is an empty string (default) \n\ all buttons that are contained in the toolbar are removed (including the toolbar). \n\ \n\ For more information see also the section :ref:`toolbar-addtoolbar` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ handle : int \n\ The handle returned by :meth:`addButton`. \n\ toolbarName : str \n\ The name of the toolbar.\n\ buttonName : str \n\ The name (str, identifier) of the button to remove (only necessary, \n\ if ``toolbarName`` is given instead of ``handle``). If an empty string \n\ all buttons of the given toolbar are removed (including the toolbar itself). \n\ \n\ Raises \n\ ------- \n\ RuntimeError \n\ if the main window is not available or the addressed button could not be found. \n\ \n\ See Also \n\ --------- \n\ addButton")
	PyDoc_STRVAR (pyAddMenu_doc,"addMenu(type, key, name = \"\", code = \"\", icon = \"\", argtuple = []) -> int \n\ \n\ This function adds an element to the main window menu bar. \n\ \n\ The root element of every menu list must be of type :attr:`~itom.MENU`. Such a \n\ :attr:`~itom.MENU` element can contain sub-elements. These sub-elements can be either \n\ another :attr:`~itom.MENU`, a :attr:`~itom.SEPARATOR` or a :attr:`~itom.BUTTON`. Only \n\ the :attr:`~itom.BUTTON` itself triggers a signal, which then executes the code, given \n\ by a string or a reference to a callable python method or function. Remember, that this \n\ reference is only stored as a weak pointer. \n\ \n\ If you want to directly add a sub-element, you can give a slash-separated string as ``key`` \n\ argument. Every component of this string then represents the menu element in its specific \n\ level. Only the element in the last can be something else than of type \n\ :attr:`~itom.MENU`.\n\ \n\ Itom comes with basic icons addressable by ``:/../iconname.png``, e.g.\n\ ``:/gui/icons/close.png``. These natively available icons are listed in the icon \n\ browser in the menu **edit >> icon browser** of any script window. Furthermore you \n\ can give a relative or absolute path to any allowed icon file (the preferred file \n\ format is png). \n\ \n\ For more information see also the section :ref:`toolbar-createmenu` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ type : int \n\ The type of the menu-element (:attr:`~itom.BUTTON` : 0 [default], \n\ :attr:`~itom.SEPARATOR` : 1, :attr:`~itom.MENU` : 2). Use the corresponding \n\ constans in module :mod:`itom`.\n\ key : str \n\ A slash-separated string where every sub-element is the key-name for the menu-element \n\ in the specific level.\n\ name : str, optional \n\ The text of the menu-element. If it is an empty string, the last component of the \n\ slash separated ``key`` is used as name. For instance if key is equal to ``item1/item2`` \n\ the name will be ``item2``. \n\ code : str or callable, optional \n\ The code to be executed if menu element is pressed.\n\ icon : str, optional \n\ The filename of an icon-file. This can also be relative to the application directory of \n\ **itom**.\n\ argtuple : tuple, optional \n\ Arguments, which will be passed to method (in order to avoid cyclic references try \n\ to only use basic element types).\n\ \n\ Returns \n\ ------- \n\ handle : int \n\ Handle to the recently added leaf node (action, separator or menu item). Use this \n\ handle to delete the item including its child items (for type 'menu'). \n\ \n\ Raises \n\ ------- \n\ RuntimeError \n\ if the main window is not available or the given button could not be found. \n\ \n\ See Also \n\ --------- \n\ removeMenu")
	PyDoc_STRVAR (pyRemoveMenu_doc,"removeMenu(key) -> None \\\n\ removeMenu(menuHandle) -> None \n\ \n\ Remove a menu element with the given key or handle. \n\ \n\ This function remove a menu element with the given ``key`` or ``menuHandle``. \n\ key is a slash separated list. The sub-components then \n\ lead the way to the final element, which should be removed. \n\ \n\ Alternatively, it is possible to pass the handle obtained from :meth:`addMenu`. \n\ \n\ For more information see also the section :ref:`toolbar-createmenu` of the \n\ documentation.\n\ \n\ Parameters \n\ ----------- \n\ key : str\n\ The key (can be a slash-separated list) of the menu entry to remove. If it \n\ is a slash-separated list, the menu entry is searched down the path, \n\ indicated by the components of the list respectively. \n\ If the desired menu item has further child items, they are removed, too. \n\ menuHandle : int \n\ The handle of the menu entry that should be removed (including its \n\ possible child items). This handle is usually returned by :meth:`addMenu`.\n\ \n\ Raises \n\ ------- \n\ RuntimeError \n\ if the main window is not available or the given button could not be found. \n\ \n\ See Also \n\ --------- \n\ addMenu")
	PyDoc_STRVAR (pyDumpButtonsAndMenus_doc,"dumpButtonsAndMenus() -> dict \n\ \n\ Gets all user-defined toolbars, menus and its buttons. \n\ \n\ Returns \n\ -------- \n\ dict \n\ Dictionary with two top-level entries:: \n\ \n\ {'toolbars': {}, 'menus': []} \n\ \n\ ``toolbars`` contains a dict of all customized toolbars, where each \n\ item contains all buttons (actions) of this toolbar. ``menus`` contains \n\ a list of nested dictionaries for each top level menu.")
	PyDoc_STRVAR (pyCheckSignals_doc,"checkSignals() -> int \n\ \n\ Verifies if a Python interrupt request is currently queued. \n\ \n\ Returns \n\ -------- \n\ int \n\ Returns 1 if an interrupt is currently queued, else 0.")
	PyDoc_STRVAR (pyProcessEvents_doc,"processEvents() \n\ \n\ This method processes posted events for the Python thread. \n\ \n\ Please use this method with care.")
	PyDoc_STRVAR (pyGetDebugger_doc,"getDebugger() -> itoDebugger.itoDebugger \n\ \n\ Returns the ``itoDebugger`` object of this itom session. \n\ \n\ It is usually not recommended and necessary to use this method or the returned \n\ debugger. This method is available for development and debugging purposes. \n\ \n\ Returns \n\ ------- \n\ debugger : itoDebugger.itoDebugger \n\ is the debugger instance of this itom session.")
	PyDoc_STRVAR (pyGCStartTracking_doc,"gcStartTracking() \n\ \n\ Starts a monitoring session for objects in the garbage collector. \n\ \n\ This method makes a snapshot of all objects currently guarded by \n\ the garbage collector (:mod:`gc`). Before this, ``gc.collect()`` \n\ was called to clear all unnecessary objects. \n\ \n\ Later, call :meth:`gcEndTracking` to get a print out of the \n\ differences between the snapshot at the end and the beginning \n\ of the tracking. \n\ \n\ This methods are usually available for development purposes. \n\ \n\ See Also \n\ -------- \n\ gcEndTracking")
	PyDoc_STRVAR (pyGCEndTracking_doc,"gcEndTracking() \n\ \n\ Finishes a monitoring session for objects in the garbage collector. \n\ \n\ This method makes a snapshot of all objects currently guarded by \n\ the garbage collector (:mod:`gc`) and compares the list of objects\n\ with the one collected during the last call of :meth:`gcStartTracking`. \n\ \n\ The difference of both lists of printed to the command line. \n\ \n\ This methods are usually available for development purposes. \n\ \n\ Raises \n\ ------ \n\ RuntimeError \n\ if :meth:`gcStartTracking` was not called before. \n\ \n\ See Also \n\ -------- \n\ gcStartTracking")
	PyDoc_STRVAR (autoReloader_doc,"autoReloader(enabled, checkFileExec = True, checkCmdExec = True, checkFctExec = False) \n\ \n\ dis-/enables the module to automatically reload changed modules. \n\ \n\ Use this method to enable or disable (and configure) a tool that automatically tries to \n\ reload imported modules and their submodules if they have changed since the last run. \n\ \n\ Parameters \n\ ---------- \n\ enable : bool \n\ The auto-reload tool is loaded if it is enabled for the first time. If it is disabled, \n\ it does not check changes of any imported modules. \n\ checkFileExec : bool \n\ If ``True`` (default) and auto-reload enabled, a check for modifications is executed \n\ whenever a script is executed \n\ checkCmdExec : bool \n\ If ``True`` (default) and auto-reload enabled, a check for modifications is executed \n\ whenever a command in the command line is executed \n\ checkFctExec : bool \n\ If ``True`` and auto-reload enabled, a check for modifications is executed whenever a \n\ function or method is run (e.g. by an event or button click) (default: ``False``)\n\ \n\ Notes \n\ ------- \n\ This tool is inspired by and based on the IPython extension `autoreload`. \n\ \n\ Reloading Python modules in a reliable way is in general difficult, \n\ and unexpected things may occur. ``autoReloader`` tries to work around \n\ common pitfalls by replacing function code objects and parts of \n\ classes previously in the module with new versions. This makes the \n\ following things to work: \n\ \n\ - Functions and classes imported via 'from xxx import foo' are upgraded \n\ to new versions when 'xxx' is reloaded. \n\ \n\ - Methods and properties of classes are upgraded on reload, so that \n\ calling 'c.foo()' on an object 'c' created before the reload causes \n\ the new code for 'foo' to be executed. \n\ \n\ Some of the known remaining caveats are: \n\ \n\ - Replacing code objects does not always succeed: changing a @property \n\ in a class to an ordinary method or a method to a member variable \n\ can cause problems (but in old objects only). \n\ \n\ - Functions that are removed (eg. via monkey-patching) from a module \n\ before it is reloaded are not upgraded. \n\ \n\ - C extension modules cannot be reloaded, and so cannot be autoreloaded.")
	PyDoc_STRVAR (getScreenInfo_doc,"getScreenInfo() -> Dict[str, Any] \n\ \n\ Returns dictionary with information about all available screens. \n\ \n\ This method returns a dictionary with information about the current screen \n\ configuration of this computer. \n\ \n\ Returns \n\ ------- \n\ dict \n\ dictionary with the following content is returned: \n\ \n\ * screenCount (int): number of available screens \n\ * primaryScreen (int): index (0-based) of primary screen \n\ * geometry (tuple): tuple with dictionaries for each screen containing data for \n\ width (w), height (h) and its top-left-position (x, y)")
	PyDoc_STRVAR (pySaveMatlabMat_doc,"saveMatlabMat(filename, values, matrixName = \"matrix\") \n\ \n\ Save strings, numbers, arrays or combinations into a Matlab mat file. \n\ \n\ Save one or multiple objects (strings, numbers, arrays, :class:`dataObject`, \n\ :class:`numpy.ndarray`...) to a Matlab *mat* file. There are the following \n\ possibilites for saving, depending on the type of ``values``: \n\ \n\ * ``values`` is a :class:`dict`: All values in the dictionary are stored under their \n\ corresponding key. \n\ * If ``values`` contains one item only, it is saved under the given ``matrixName``. \n\ * If ``value`` is a :class:`list` or :class:`tuple` of objects, ``matrixName`` must \n\ either be a sequence with the same length than ``value``. Then, each item in ``values`` \n\ is stored with the respective name in ``matrixName``. Or ``matrixName`` can be omitted. \n\ Then, the items are stored under the self-incremented keys ``matrix1``, ``matrix2``, ... \n\ \n\ Parameters \n\ ----------- \n\ filename : str \n\ Filename under which the file should be saved (.mat will be appended if not available)\n\ values : dict or list or tuple or Any \n\ The value(s) to be stored. Can be either a single object (number, string, \n\ :class:`dataObject`, :class:`numpy.ndarray` among others, or a :class:`list`, \n\ :class:`tuple` or :class:`dict` of these single objects. \n\ matrixName : str or list or tuple, optional \n\ If ``values`` is a single value, this parameter must be one single :class:`str`. \n\ Else if ``values`` is a sequence it must be a sequence of strings with the same \n\ length or it can be omitted. If ``values`` is a dictionary, this argument is ignored. \n\ \n\ Raises \n\ ------ \n\ ImportError \n\ if :mod:`scipy` and its module :mod:`scipy.io` could not be imported. \n\ \n\ Notes \n\ ----- \n\ This method requires the package :mod:`scipy` and its module :mod:`scipy.io`. \n\ \n\ See Also \n\ -------- \n\ loadMatlabMat")
	PyDoc_STRVAR (pyLoadMatlabMat_doc,"loadMatlabMat(filename) -> dict \n\ \n\ Loads Matlab mat-file by using :mod:`scipy` methods and returns the loaded dictionary. \n\ \n\ Parameters \n\ ----------- \n\ filename : str \n\ Filename from which the data will be imported (.mat will be added if not available)\n\ \n\ Returns \n\ ------- \n\ mat : dict \n\ dictionary with content of file \n\ \n\ Raises \n\ ------ \n\ ImportError \n\ if :mod:`scipy` and its module :mod:`scipy.io` could not be imported. \n\ \n\ Notes \n\ ----- \n\ This method requires the package :mod:`scipy` and its module :mod:`scipy.io`. \n\ \n\ See Also \n\ --------- \n\ saveMatlabMat")
	PyDoc_STRVAR (pyFilter_doc,"filter(name : str, *args, _observer = None, **kwds) -> Any \n\ \n\ Invokes a filter (or algorithm) function from an algorithm-plugin. \n\ \n\ This function is used to invoke itom filter-functions or algorithms, declared within \n\ itom-algorithm plugins. The parameters (arguments) depends on the specific filter \n\ function. Call :meth:`filterHelp` to get a list of available filter functions.\n\ \n\ Pass all mandatory or optional arguments of the filter as positional or keyword-based \n\ parameters. Some filters, that implement the additional observer interface, can accept \n\ another :class:`progressObserver` object, that allows monitoring the progress of the \n\ filter and / or interrupting the execution. If such an observer is given, you have to \n\ pass it as keyword-based argument ``_observer``!. \n\ \n\ During the execution of the filter, the python GIL (general interpreter lock) is \n\ released (e.g. for further asynchronous processes. \n\ \n\ Parameters \n\ ----------- \n\ name : str \n\ The name of the filter\n\ *args : Any \n\ positional arguments for the specific filter-method \n\ _observer : progressObserver, optional \n\ if the called filter implements the extended interface with progress and status \n\ information, an optional :class:`progressObserver` object can be given (only as \n\ keyword-based parameter) which is then used as observer for the current progress of \n\ the filter execution. It is then also possible to interrupt the execution earlier \n\ (depending on the implementation of the filter). The observer object is \n\ reset before passed to the called filter function (using the slot \n\ :meth:`~progressObserver.reset`). \n\ **kwds : Any \n\ keyword-based arguments for the specific filter-method. The argument name \n\ ``_observer`` is reserved for special use. \n\ \n\ Returns \n\ -------- \n\ out : obj \n\ The returned values depend on the definition of each filter. In general it is a \n\ tuple of all output parameters that are defined by the filter function.\n\ \n\ See Also \n\ --------- \n\ filterHelp")
	PyDoc_STRVAR (pySaveDataObject_doc,"saveDataObject(filename, dataObject, tagsAsBinary = False) \n\ \n\ Saves a dataObject to the harddrive in a xml-based file format (ido). \n\ \n\ This method writes a :class:`dataObject` into the file specified by ``filename``. \n\ The data is stored in a binary format within a xml-based structure. \n\ All string-tags of the dataObject are encoded in order to avoid xml-errors, \n\ the value of numerical tags are either converted to strings with 15 significant digits \n\ (>32bit) or stored as base64 encoded values. \n\ \n\ Parameters \n\ ----------- \n\ filename : str \n\ absolute or relative file path to the destination file (.ido will be added if \n\ no valid suffix is given)\n\ dataObject : dataObject \n\ The `n`-dimensional dataObject to be serialized to the file.\n\ tagsAsBinary : bool, optional \n\ If ``True`` all number tags are stored as base64 encoded number values in the `ido` \n\ file. Else (default), they are stored as readable strings. \n\ \n\ Notes \n\ ----- \n\ Tagnames which contains special characters might lead to XML-conflics. \n\ \n\ See Also \n\ --------- \n\ loadDataObject")
	PyDoc_STRVAR (pyLoadDataObject_doc,"loadDataObject(filename, dataObject, doNotAppendIDO = False) \n\ \n\ Loads a dataObject from an IDO file. \n\ \n\ This function reads a `dataObject` from the file specified by filename. \n\ MetaData saveType (string, binary) are extracted from the file and restored within the object.\n\ \n\ Parameters \n\ ----------- \n\ filename : str \n\ absolute or relative ido file path to the target file \n\ dataObject : dataObject \n\ an allocated, e.g. empty :class:`dataObject`, that is filled with the loaded \n\ object afterwards. \n\ doNotAppendIDO : bool, optional \n\ If ``True`` (default: ``False``), the file suffix **ido** is appended to ``filename``. \n\ \n\ Notes \n\ ----- \n\ \n\ The value of string tags must be encoded to avoid XML-conflics.\n\ Tag names which contains special characters might lead to XML-conflics.")
	PyDoc_STRVAR (pySetCentralWidgetsSizes_doc,"setCentralWidgetsSizes(sizes) \n\ \n\ Sets the sizes of the central widgets of itom (including command line) from top to bottom. \n\ \n\ This method can be important if at least one widget has been added from :class:`itom.ui`, \n\ type :attr:`ui.TYPECENTRALWIDGET`. These user defined widgets are then added on top \n\ of the central area of itom and stacked above the command line. The list of sizes \n\ indicates the desired heights of all widgets in the center in pixel (from top to bottom). \n\ \n\ If the list contains too much items, all extra values are ignored. If the list contains \n\ too few values, the result is undefined, but the program will still be well-behaved. \n\ \n\ The overall size of the central area will not be affected. Instead, any additional/missing \n\ space is distributed amongst the widgets according to the relative weight of the sizes. \n\ \n\ If you speciy a size of 0, the widget will be invisible and can be made visible again \n\ using this method or by increasing its size again with the mouse. \n\ \n\ Parameters \n\ ----------- \n\ sizes : sequence of int \n\ Sizes in pixel for each central widget from top to bottom (including the command line). \n\ ")
	PyDoc_STRVAR (getDefaultScaleableUnits_doc,"getDefaultScaleableUnits() -> List[str] \n\ \n\ Gets a list with the strings of the standard scalable units. \n\ \n\ The unit strings returned as a list by this method can be transformed into each \n\ other using :meth:`scaleValueAndUnit`. \n\ \n\ Returns \n\ ------- \n\ units : list of str \n\ List with strings containing all scaleable units \n\ \n\ See Also \n\ -------- \n\ scaleValueAndUnit")
	PyDoc_STRVAR (scaleValueAndUnit_doc,"scaleValueAndUnit(scaleableUnits, value, valueUnit) -> Tuple[float, str] \n\ \n\ Rescales a ``value`` and its unit to the next matching SI unit. \n\ \n\ At first, it is checked if the given ''valueUnit'' is contained in the list \n\ of the base units ``scaleableUnits``. If this is the case, \n\ the given ``value`` is scaled such that the returned value is greater or equal \n\ than 1. The scaled value and the new unit is returned then. \n\ \n\ Use the method :meth:`getDefaultScaleableUnits` to obtain a suitable list of SI \\n\ base units. \n\ \n\ Parameters \n\ ----------- \n\ scaleableUnits : list of str \n\ A list of str with all base units that should be considered for scaling. \n\ If the given ''valueUnit'' is not contained in this list of base units, \n\ no scaling is done and the returned values are equal to ``[value, valueUnit]``. \n\ value : float \n\ The value to be scaled\n\ valueUnit : str \n\ The value unit to be scaled\n\ \n\ Returns \n\ ------- \n\ tuple \n\ The returned tuple has the format ``[newValue, newUnit]``, where ``newValue`` is \n\ a float and ``newUnit`` is a string. \n\ \n\ Examples \n\ --------- \n\ >>> baseUnits = getDefaultScaleableUnits() \n\ >>> print(scaleValueAndUnit(baseUnits, 0.001, 'm')) \n\ [1, 'mm']")
	PyDoc_STRVAR (getAppPath_doc,"getAppPath() -> str\n\ \n\ Returns the absolute path of the base directory of this application.\n\ \n\ The returned value is independent of the current working directory. \n\ \n\ Returns \n\ ------- \n\ path : str\n\ absolute path of this application's base directory")
	PyDoc_STRVAR (getQtToolPath_doc,"getQtToolPath(toolname) -> str \n\ \n\ Gets the absolute path of the given Qt tool \n\ \n\ Parameters \n\ ----------- \n\ toolname : str \n\ The filename of the tool that should be searched \n\ (e.g. ``qcollectiongenerator``; suffix is not required)\n\ \n\ Returns \n\ ------- \n\ path : str \n\ Absolute path to the given Qt tool. \n\ \n\ Raises \n\ ------- \n\ FileExistsError \n\ if the given toolname could not be found")
	PyDoc_STRVAR (getCurrentPath_doc,"getCurrentPath() -> str \n\ \n\ Returns the absolute path of the current working directory.\n\ \n\ The current working directory is also displayed on the right side \n\ of the status bar of the main window of itom. \n\ \n\ Returns \n\ ------- \n\ str\n\ the absolute path of the current working directory \n\ \n\ See Also \n\ --------- \n\ setCurrentPath")
	PyDoc_STRVAR (setCurrentPath_doc,"setCurrentPath(newPath) -> bool \n\ \n\ Set current working directory to a new absolute path. \n\ \n\ sets the absolute path of the current working directory to 'newPath'. \n\ The current working directory is the base directory for all subsequent relative \n\ pathes of icon-files, script-files, ui-files, relative import statements... \n\ \n\ The current directory is always indicated in the right corner of the status \n\ bar of the main window. \n\ \n\ Parameters \n\ ----------- \n\ newPath : str \n\ The new path for the current working directory.\n\ \n\ Returns \n\ ------- \n\ success : bool \n\ ``True`` in case of success else ``False``. \n\ \n\ See Also \n\ --------- \n\ getCurrentPath")
	PyDoc_STRVAR (pyCompressData_doc,"compressData(text) -> bytes \n\ \n\ Compresses a given string text, using zlib. \n\ \n\ The compression is done using the zlib library and the command \n\ `qCompress` of the Qt framework. \n\ \n\ Parameters \n\ ----------- \n\ text : str \n\ The string that should be compressed. \n\ level : int \n\ The compression level: -1 selects the default compression level of `zlib`, else \n\ a level in the range [0, 9]. \n\ \n\ Returns \n\ ------- \n\ compressed_text : bytes \n\ The compressed version of ``text``. \n\ \n\ See Also \n\ --------- \n\ uncompressData")
	PyDoc_STRVAR (pyUncompressData_doc,"uncompressData(compressed_text) -> bytes \n\ \n\ Uncompresses a given compressed text, using zlib. \n\ \n\ The uncompression is done using the zlib library and the command \n\ `qUncompress` of the Qt framework. \n\ \n\ Parameters \n\ ----------- \n\ compressed_text : bytes \n\ The compressed bytes string. \n\ \n\ Returns \n\ ------- \n\ uncompressed_text : bytes \n\ The uncompressed ``compressed_text``. \n\ \n\ See Also \n\ --------- \n\ compressData")
	PyDoc_STRVAR (pyRegisterResources_doc,"registerResource(rccFileName, mapRoot = \"\") -> bool \n\ \n\ Registers a resource file with the given rccFileName. \n\ \n\ This method opens a given Qt rcc resource file and registers its content at the location \n\ in the resource tree specified by ``mapRoot``. This ``mapRoot`` must usually be a slash separated \n\ path, starting with a slash. \n\\n\ \n\ To generate a rcc file, create an index of all files, that should be added to the resource file, \n\ in a qrc file and uses the rcc binary from Qt to compile the rcc file. \n\ \n\ This method is new in itom > 4.0.0. \n\ \n\ Parameters \n\ ----------- \n\ rccFileName : str\n\ filepath to the rcc resource file \n\ mapRoot : str, optional \n\ root key, where the resources should be registered below (default: empty string) \n\ \n\ Returns \n\ ---------- \n\ bool \n\ ``True`` if the file could be successfully opened, else ``False``.\n\ \n\ See Also \n\ --------- \n\ unregisterResource")
	PyDoc_STRVAR (pyUnregisterResources_doc,"unregisterResource(rccFileName, mapRoot = \"\") -> bool \n\ \n\ Unregisters the resource with the given rccFileName. \n\ \n\ This method tries to unload all resources in the given rcc resource file from the location \n\ in the resource tree specified by ``mapRoot``. The ``mapRoot`` must usually be a slash separated \n\ path, starting with a slash. \n\ \n\ This method is new in itom > 4.0.0. \n\ \n\ Parameters \n\ ----------- \n\ rccFileName : str\n\ filepath to the rcc resource file \n\ mapRoot : str, optional \n\ root key, where the resources should be unloaded from (default: empty string). \n\ \n\ Returns \n\ ---------- \n\ bool \n\ ``True`` if the file could be successfully opened, else ``False``.\n\ \n\ See Also \n\ --------- \n\ registerResource")
	PyDoc_STRVAR (setApplicationCursor_doc,"setApplicationCursor(cursorIndex = -1) \n\ \n\ Changes the itom cursor or restores the previously set cursor if -1. \n\ \n\ This methods changes the overall cursor icon of itom where ``cursorIndex`` \n\ corresponds to the Qt enumeration ``Qt::CursorShape``. e.g.:\n\ \n\ * 0: Arrow \n\ * 2: Cross Cursor \n\ * 3: Wait Curson \n\ * 13: Pointing Hand Cursor \n\ * 14: Forbidden Cursor \n\ * 16: Busy Cursor \n\ \n\ Every change of the cursor is put on a stack. The previous cursor type is \n\ restored, if ``cursorIndex`` is set to ``-1``. \n\ \n\ Parameters \n\ ----------- \n\ cursorIndex : int, optional\n\ The cursor enumeration value of the desired cursor shape (``Qt::CursorShape``) \n\ or ``-1`` if the previous cursor should be restored (default)")
	PyDoc_STRVAR (pyLoadIDC_doc,"loadIDC(filename) -> dict \n\ \n\ loads a pickled idc-file and returns the content as dictionary. \n\ \n\ This methods loads the given idc file using the method :meth:`pickle.load` from the \n\ Python buildin module :mod:`pickle` and returns the loaded dictionary. \n\ \n\ Parameters \n\ ----------- \n\ filename : str \n\ Filename to the `idc`-file, that should be loaded. Can be an absolute \n\ path, or relative with respect to the current working directory. \n\ \n\ Returns \n\ -------- \n\ content : dict \n\ dictionary with loaded content. \n\ \n\ See Also \n\ --------- \n\ pickle.load, saveIDC")
	PyDoc_STRVAR (pySaveIDC_doc,"saveIDC(filename, dict, overwriteIfExists = True) \n\ \n\ Saves the given dictionary as pickled idc-file.\n\ \n\ This method saves the given dictionary ``dict`` as pickled idc-file using the method \n\ :meth:`pickle.dump` from the builtin module :mod:`pickle`.\n\ The file will be saved with the pickle protocol version 3 (default for Python 3).\n\ \n\ Parameters \n\ ----------- \n\ filename : str \n\ Filename of the destination `idc` file. Can be an absolute filename \n\ or relative with respect to the current working directory. \n\ dict : dict \n\ dictionary which should be pickled. All values in the dictionary must be able \n\ to be pickled (e.g. all Python base types, dataObjects, numpy.ndarrays...). \n\ overwriteIfExists : bool, optional \n\ If ``True``, an existing file will be overwritten. \n\ \n\ Raises \n\ ------ \n\ RuntimeError \n\ if the file cannot be overwritten or if it exists, but ``overwriteIfExists`` \n\ is ``False``. \n\ \n\ See Also \n\ --------- \n\ pickle.dump, loadIDC")
	PyDoc_STRVAR (pyCheckIsAdmin_doc,"userIsAdmin() -> bool \n\ \n\ Returns ``True`` if the current user has administrator rights.\n\ \n\ For more information about the user management of itom, see :ref:`gui-user-management`. \n\ \n\ Returns \n\ ------- \n\ bool \n\ ``True`` if current user has administrator rights, otherwise ``False``.\n\ \n\ See Also \n\ -------- \n\ userIsUser, userIsDeveloper, userGetInfo")
	PyDoc_STRVAR (pyCheckIsDeveloper_doc,"userIsDeveloper() -> bool \n\ \n\ Returns ``True`` if the current user has developer rights.\n\ \n\ This method only returns ``True``, if the current user has developer rights, not if \n\ he has higher rights, like adminstrator. \n\ For more information about the user management of itom, see :ref:`gui-user-management`. \n\ \n\ Returns \n\ ------- \n\ bool \n\ ``True`` if current user has developer rights, otherwise ``False``. \n\ \n\ See Also \n\ -------- \n\ userIsUser, userIsAdministrator, userGetInfo")
	PyDoc_STRVAR (pyCheckIsUser_doc,"userIsUser() -> bool \n\ \n\ Returns ``True`` if the current user has user rights.\n\ \n\ This method only returns ``True``, if the current user has user rights, not if \n\ he has higher rights, like developer or adminstrator. \n\ For more information about the user management of itom, see :ref:`gui-user-management`. \n\ \n\ Returns \n\ ------- \n\ bool \n\ ``True`` if current user has user rights, otherwise ``False``.\n\ \n\ See Also \n\ -------- \n\ userIsDeveloper, userIsAdministrator, userGetInfo")
	PyDoc_STRVAR (pyGetUserInfo_doc,"userGetInfo() -> Dict[str, str] \n\ \n\ Returns a dictionary with relevant information about the current user. \n\ \n\ Returns \n\ ------- \n\ dict \n\ dictionary with the following content is returned: \n\ \n\ * Name: The name of the current user \n\ * Type: The user right type of the current user [user, administrator, developer] \n\ * ID: The user ID \n\ * File: The location and name of the corresponding setting file (ini).")
	PyDoc_STRVAR (pyItom_FigureClose_doc,"close(handle) -> None \\\n\ close(all = \"all\") -> None \n\ \n\ Closes a specific or all opened figures. \n\ \n\ This method closes and deletes either one specific figure (if ``handle`` is given \n\ and valid), or all opened figures (if the string argument ``\"all\"`` is given). \n\ All figure can only be closed, if no other figure references this figure (e.g. \n\ line cut of an image plot (2D). \n\ \n\ This method is a redirect of the staticmethod :meth:`figure.close`. \n\ \n\ Parameters \n\ ----------- \n\ handle : int \n\ a valid figure handle, whose reference figure should be closed. \n\ This figure handle is for instance obtained by the first value of the \n\ returned tuple of :meth:`plot`, :meth:`plot1`, :meth:`plot2` among others. \n\ all : {\"all\"} \n\ Pass the string ``\"all\"`` if all closeable opened figures should be closed. \n\ \n\ Notes \n\ ------- \n\ If a :class:`figure` instance still keeps a reference to any figure, it is only closed \n\ and will be deleted after that the last referencing instance has been deleted. \n\ \n\ See Also \n\ --------- \n\ figure.close")
	try to convert object to PyRgba or to None.
int	PyRgbaOptional_Converter (PyObject *object, PythonRgba::PyRgba **address)
	PyDoc_STRVAR (setPalette_doc,"setPalette(name, colorStops, inverseColor1 = None, inverseColor2 = None, invalidColor = None) \n\ \n\ Changes a given color palette or creates a new one with the given arguments. \n\ \n\ This methods modifies an existing color palette (if a palette with ``name`` \n\ already exists) or creates a new color palette with the given ``name``. An existing \n\ color palette can only be modified, if it has no write protection, which is the case \n\ for all pre-defined color palettes of itom (see color palette editor in itom property \n\ editor). If any of the optional values are not given, default values (from the ``gray`` \n\ color palette) are used, or, if the color palette ``name`` already exists, \n\ these values are left unchanged\n\ \n\ To obtain the parameters of an existing color palette, that can be used as arguments \n\ of this method, unpack the returned dictionary of :meth:`getPalette`. \n\ \n\ It is also possible to modify or create color palettes in the color palette editor of \n\ the itom property dialog. For more information see :ref:`gui-color-palette-editor`. \n\ \n\ Parameters \n\ ----------- \n\ name : str \n\ Name of the color palette. \n\ colorStops : tuple \n\ Tuple with all color stops of this color palette. Each item of this tuple is \n\ another tuple with two values. The first value is the float position of the \n\ color stop in the range [0.0, 1.0]. The 2nd value is the :class:`rgba32` color \n\ at this position. Colors between two adjacent color stops are linearly interpolated. \n\ \n\ The position of the first color stop has to be 0.0, the one of the last stop 1.0.\n\ There must be at least two colorStops.\n\ inverseColor1 : rgba, optional \n\ First inverse color, used for instance for line cuts, markers etc. of a 2D plot. \n\ inverseColor2 : rgba, optional \n\ second inverse color, used for instance for line cuts, markers etc. of a 2D plot. \n\ invalidColor : rgba, optional \n\ color used for ``NaN`` or ``Inf`` values in plots. If the invalid color is not given \n\ and an existing color palette also has no invalid color, the color of the first color \n\ stop is taken. \n\ \n\ See Also \n\ --------- \n\ getPalette, getPaletteList")
	PyDoc_STRVAR (getPalette_doc,"getPalette(name) -> dict \n\ \n\ Returns all relevant data of an existing color palette. \n\ \n\ If a color palette with this ``name`` exists, its relevant data is returned \n\ as dictionary. The values in this dictionary can also be used to call the \n\ method :meth:`setPalette`. \n\ \n\ Parameters \n\ ----------- \n\ name : str \n\ name of the new palette. \n\ \n\ Returns \n\ -------- \n\ palette : dict \n\ Dictionary with the following entries: \n\ \n\ name : str \n\ name of the color palette. \n\ colorStops : tuple \n\ tuple with all color stops, each element is another tuple whose first value is \n\ the float position of the stop in the range [0.0, 1.0]. The 2nd value is the \n\ corresponding :class:`rgba` color. The first color stop is always at \n\ position 0.0, the last one at position 1.0. \n\ inverseColor1 : rgba \n\ first inverse color. \n\ inverseColor2 : rgba \n\ 2nd inverse color. \n\ invalidColor : rgba \n\ color used for ``NaN`` or ``Inf`` values. \n\ \n\ Raises \n\ ----------- \n\ RuntimeError \n\ if no color palette with the given name is available. \n\ \n\ See Also \n\ --------- \n\ setPalette, getPaletteList")
	PyDoc_STRVAR (getPaletteList_doc,"getPaletteList(type = 0) -> Tuple[str] \n\ \n\ Returns a tuple with the names of all currently available color palettes. \n\ \n\ Parameters \n\ ----------- \n\ type : int, optional \n\ Unused parameter. \n\ \n\ Returns \n\ ------- \n\ tuple of str \n\ Tuple with the names of all available color palettes. \n\ \n\ See Also \n\ --------- \n\ setPalette, getPalette")
	PyDoc_STRVAR (pyClearAll_doc,"clearAll() \n\ \n\ Clears all variables in the global workspace. \n\ \n\ This method clears all variables in the global workspace, that have been \n\ added after the startup process of itom. This only affects variables, that \n\ are also displayed in the workspace toolbox. Variables, like methods, functions, \n\ classes etc. are filtered out, and will therefore not be deleted.\n\ \n\ Variables, that have been created by any startup script will also not be deleted.")
	PyDoc_STRVAR (pyAMax_doc,"amax(dataObject) -> returns the maximum value of the data object.")
	PyDoc_STRVAR (pyPlotItemInit_doc,"plotItem(figure, subplotIdx = 0) -> plotItem \\\n\ plotItem(uiItem) -> plotItem \\\n\ plotItem(figure, objectID = 0) -> plotItem \n\ \n\ The plotItem is a special :class:`uiItem` and represents itom plot designer widgets. \n\ \n\ This constructor can be used to get a reference of a plot in a :class:`figure`. \n\ The plot can also be in a subplot area of a figure. There are two main uses cases \n\ for the direct usage of this constructor: \n\ \n\ 1. If a reference to a general :class:`uiItem` is available, but the referenced \n\ widget / item is a plot, the :class:`uiItem` can be cast to :class:`plotItem` \n\ such that additional methods like :meth:`pickPoints` or :meth:`drawAndPickElements` \n\ become available. \n\ 2. If a reference to a :class:`figure` is available, that contains one or more \n\ plots, the reference to one of these plots can be obtained. The ``subplotIdx`` \n\ indicates the specific plot, that should be referenced. The default is ``0``. \n\ If the figure consists of more than one subplot, the index counts the subplots \n\ row-by-row. \n\ \n\ The 3rd variant of this contructor, using the keyword-based argument ``objectID`` \n\ is only internally used and has no further meaning for a high-level usage. However, \n\ if it is used, ``objectID`` must be used as keyword argument, else ``subplotIdx`` is \n\ assumed to be initialized. \n\ \n\ Parameters \n\ ------------ \n\ figure : figure \n\ The :class:`figure` window, that contains an itom plot. \n\ subplotIdx : int, optional \n\ The area index of the (sub)plot, that should be referenced. This index is \n\ considered to be row-wise, such that the center plot in the 2nd row with \n\ three plots in each row has the index ``4``. The first, left, plot in the \n\ first row has the index ``0``, which is the default. \n\ objectID : int, optional \n\ If the internal ``objectID`` of a :class:`uiItem` is available, it can be \n\ tried to be casted to ``plotItem``. \n\ uiItem : uiItem \n\ Try to cast this :class:`uiItem` to its inherited class :class:`plotItem`. \n\ A :obj:`RuntimeError` is raised if this cast is not possible. \n\ \n\ Returns \n\ ------- \n\ plotItem \n\ The initialized :class:`plotItem`.")
	PyDoc_STRVAR (pyPlotItem_pickPoints_doc,"pickPoints(points, maxNrPoints = -1) \n\ \n\ -> method to let the user pick points on a plot (only if plot supports this) \n\ \n\ This method lets the user select one or multiple points (up to ``maxNrPoints``) in \n\ the canvas of the current plot (if the plot supports this). The operation can be \n\ aborted by pressing the ``Esc`` key. Then a ``RuntimeError` is raised. It can also \n\ be quit earlier by pressing the ``Space`` key. This is also required if an unlimited \n\ number of points can be selected (``maxNrPoints = -1``). \n\ \n\ A pick-points operation is not supported by all plot classes. It is for instance \n\ available for the classes ``itom1dqwtplot`` (see section :ref:`plot-line`) or \n\ ``itom2dqwtplot`` (see section :ref:`plot-image`). \n\ \n\ Parameters\n\ -----------\n\ points : dataObject \n\ This object will be a ``2 x nrOfSelectedPoints`` :class:`dataObject` of dtype \n\ ``float64`` after the successful call of this method. The first row contains \n\ the ``x`` coordinates of the selected points, the 2nd row the ``y`` coordinates. \n\ maxNrPoints : int, optional \n\ Let the user select up to this number of points. The selection \n\ can be stopped by pressing Space or Esc. ``maxNrPoints`` must be -1 \n\ for an unlimited number of picked points (default) or a number >= 1. \n\ \n\ Raises \n\ ------ \n\ RuntimeError \n\ if the specific plot class does not provide the necessary methods to support \n\ this operation. \n\ RuntimeError \n\ if the operation has been interrupted by the user. ``points`` is an empty \n\ :class:`dataObject` then. An interruption can occur if the plot is closed \n\ or if the user pressed the escape key during the operation.")
	PyDoc_STRVAR (pyPlotItem_drawAndPickElements_doc,"drawAndPickElements(elementType, maxNrElements = 1) -> Tuple[shape] \n\ \n\ This method forces the user to draw specific shapes on the canvas of the plot. \n\ \n\ If this method is called, the script execution in paused until the requested \n\ ``maxNrElements`` of shapes of the given type ``elementType`` are drawn by the \n\ user on the canvas of the plot. The coordinates of the shapes is then returned \n\ by this method. If the script execution is aborted during the interactive operation \n\ or if the user presses the ``Esc`` key in the plot, this operation is stopped by \n\ a ``RuntimeError``. \n\ \n\ Parameters\n\ -----------\n\ elementType : int \n\ The element type that the user should interactively draw on the canvas of the plot. \n\ Allowed types are: \n\ \n\ * ``plotItem.PrimitivePoint`` \n\ * ``plotItem.PrimitiveLine`` \n\ * ``plotItem.PrimitiveRectangle`` \n\ * ``plotItem.PrimitiveSquare`` \n\ * ``plotItem.PrimitiveEllipse`` \n\ * ``plotItem.PrimitiveCircle`` \n\ * ``plotItem.PrimitivePolygon`` \n\ \n\ maxNrElements : int, optional \n\ Number of elements of the given type, the user has to draw. \n\ The operation can be aborted by clicking the ``Esc`` key. If this is the \n\ case, a ``RuntimeError`` is raised. \n\ \n\ Raises \n\ ------ \n\ RuntimeError \n\ if the user interrupts the selection (by pressing the Esc key). \n\ \n\ Returns \n\ -------- \n\ tuple of shape \n\ A tuple with all drawn elements, represented as :class:`shape` objects is returned.")
int	parseParams (PyObject *args, int length, char **&cargs, char *&cargt)
int	freeParams (int length, char *&cargt, char **&cargs)
PyObject *	getParamList (ito::AddInBase *aib)
PyObject *	getParamListInfo (ito::AddInBase *aib, PyObject *args)
PyObject *	getParamInfo (ito::AddInBase *aib, PyObject *args)
PyObject *	plugin_showConfiguration (ito::AddInBase *aib)
PyObject *	plugin_showToolbox (ito::AddInBase *aib)
PyObject *	plugin_hideToolbox (ito::AddInBase *aib)
PyObject *	plugin_userMutexLock (ito::AddInBase *aib, PyObject *args, PyObject *kwds, bool &userMutexLocked)
PyObject *	plugin_userMutexUnlock (ito::AddInBase *aib, bool &userMutexLocked)
PyObject *	getExecFuncsList (ito::AddInBase *aib)
PyObject *	getExecFuncsInfo (ito::AddInBase *aib, PyObject *args, PyObject *kwds)
PyObject *	getName (ito::AddInBase *addInObj)
PyObject *	execFunc (ito::AddInBase *aib, PyObject *args, PyObject *kwds)
PyObject *	getParam (ito::AddInBase *addInObj, PyObject *args)
	PyDoc_STRVAR (pyPluginName_doc,"name() -> str \n\ \n\ Returns the name of this plugin object.\n\ \n\ Returns \n\ -------- \n\ name : str \n\ name of the plugin, which corresponds to ``getParam(\"name\")`` \n\ \n\ See Also \n\ --------- \n\ getParam")
	PyDoc_STRVAR (pyPluginGetExecFuncsList_doc,"getExecFuncsList() -> List[str] \n\ \n\ Gets a list of the names of additional callable functions of this plugin.\n\ \n\ Each plugin may define a set of functions, extending the standard interface. \n\ These functions are not common to plugins of the same type. They are \n\ executed using:: \n\ \n\ instance.exec(\"funcname\", arg1, arg2, ...)\n\ \n\ To get more information about one specific function, call \n\ :meth:`getExecFuncsInfo`. \n\ \n\ Returns \n\ ------- \n\ list of str \n\ is a list of additional, callable function names of this plugin object.")
	PyDoc_STRVAR (pyPluginGetParamList_doc,"getParamList() -> List[str] \n\ \n\ Returns a list of the names of all available parameters of this plugin object.\n\ \n\ Each plugin defines a set of parameters. Each of these parameters maps its ``name`` \n\ to a certain ``value``. The value is represented by the C++ class \n\ :class:`ito::ParamBase` and can have one of the following types \n\ (Python equivalent in brackets): \n\ \n\ * String (str) \n\ * Char (int, [-127, 128]) \n\ * Integer, (int) \n\ * Double (float) \n\ * CharArray (sequence of int) \n\ * IntegerArray (sequence of int) \n\ * DoubleArray (sequence of float) \n\ * DataObject (:class:`dataObject`) \n\ * PolygonMesh (:class:`polygonMesh`) \n\ * PointCloud (:class:`pointCloud`) \n\ * Another plugin instance (:class:`dataIO` or :class:`actuator`) \n\ \n\ Using one of the parameter names, its current value can be obtained by \n\ ``getParam(\"name\")`` and can be set by ``setParam(\"name\", newValue)`` \n\ (if not read-only). \n\ \n\ Usually, every plugin object can define its own set of parameters. However, there are \n\ conventions about certain parameters, that must be available and have a specific \n\ meaning for a type of plugin object. \n\ \n\ Returns \n\ ------- \n\ list of str \n\ list of available parameter names in this plugin. \n\ \n\ See Also \n\ --------- \n\ getParam, setParam, getParamListInfo")
	PyDoc_STRVAR (pyPluginGetParamListInfo_doc,"getParamListInfo(detailLevel = 1) -> Optional[dict] \n\ \n\ Prints or returns detailed information about all parameters of this plugin object. \n\ \n\ Each plugin defines a set of parameters. Each of these parameters maps its ``name`` \n\ to a certain ``value``. The value is represented by the C++ class \n\ :class:`ito::ParamBase` and can have one of the following types \n\ (Python equivalent in brackets): \n\ \n\ * String (str) \n\ * Char (int, [-127, 128]) \n\ * Integer, (int) \n\ * Double (float) \n\ * CharArray (sequence of int) \n\ * IntegerArray (sequence of int) \n\ * DoubleArray (sequence of float) \n\ * DataObject (:class:`dataObject`) \n\ * PolygonMesh (:class:`polygonMesh`) \n\ * PointCloud (:class:`pointCloud`) \n\ * Another plugin instance (:class:`dataIO` or :class:`actuator`) \n\ \n\ Using one of the parameter names, its current value can be obtained by \n\ ``getParam(\"name\")`` and can be set by ``setParam(\"name\", newValue)`` \n\ (if not read-only). \n\ \n\ This method prints a detailed listing with the `name`, `current value`, \n\ `description string` and further `meta information` of every plugin parameter. \n\ Additionally, the column ``R/W`` indicates if this parameter is writable or read-only. \n\ \n\ Dependin`g on ``detailLevel``, this method will not print the listing to the command line \n\ but returns it using a nested :class:`dict`. \n\ \n\ Parameters \n\ ----------- \n\ detailLevel : dict, optional \n\ if ``detailLevel`` is set to ``1``, this method returns a nested dictionary with all \n\ information about all parameters of this plugin. Otherwise ``None`` is returned and \n\ the listing is printed in a readable form to the command line (default). \n\ \n\ Returns \n\ ------- \n\ None or dict \n\ See the parameter ``detailLevel`` for the difference in returned values. \n\ \n\ See Also \n\ ---------- \n\ getParam, setParam, getParamInfo, getParamList, getParamInfo")
	PyDoc_STRVAR (pyPluginGetParamInfo_doc,"getParamInfo(name) -> dict \n\ \n\ Returns a nested dictionary with meta information of the desired parameter. \n\ \n\ Plugin parameters in itom not only hold a value, but they can also be equipped \n\ with further meta information, like the minimum or maximum value range, a certain \n\ step size, allowed string values etc. \n\ \n\ These values are returned as nested dictionary (if available, else the dict is \n\ more or less empty). \n\ \n\ Parameters \n\ ----------- \n\ name : str \n\ Name of the plugin parameter. \n\ \n\ Returns \n\ ------- \n\ dict \n\ nested dictionary with meta information assigned to the plugin parameter ``name``.")
	PyDoc_STRVAR (pyPluginGetParam_doc,"getParam(name) -> Union[int, float, str, Tuple[int], Tuple[float], dataObject, polygonMesh, pointCloud, dataIO, actuator] \n\ \n\ Returns the current value of the plugin parameter ``name``. \n\ \n\ The type of the returned value depends on the real type of the internal plugin, \n\ which can be: \n\ \n\ * String -> :obj:`str` \n\ * Char, Integer -> :obj:`int` \n\ * Double -> :obj:`float` \n\ * CharArray, IntegerArray -> :obj:`tuple` of :obj:`int` \n\ * DoubleArray -> :obj:`tuple` of :obj:`float` \n\ * DataObject -> :class:`dataObject` \n\ * PolygonMesh -> :class:`polygonMesh` \n\ * PointCloud -> :class:`pointCloud` \n\ * Another plugin instance -> :class:`dataIO` or :class:`actuator` \n\ \n\ The ``name`` of the parameter must have the following form: \n\ \n\ * **name** \n\ * **name:additionalTag** (``additionalTag`` can be a special feature of some plugins) \n\ * **name[index]** (only possible if parameter is an array type and you only want to get \n\ one single value, specified by the integer index ``[0, len(array) - 1]``) \n\ * **name[index]:additionalTag** (a combination of the two possibilies above) \n\ \n\ Parameters \n\ ----------- \n\ name : str\n\ Name of the requested parameter.\n\ \n\ Returns \n\ ------- \n\ int or float or str or tuple of int or tuple of float or dataObject or polygonMesh or pointCloud or dataIO or actuator\n\ Current value of the parameter ``name``. \n\ \n\ Raises \n\ ------- \n\ ValueError \n\ if parameter does not exist \n\ \n\ See Also \n\ --------- \n\ setParam, getParamList, getParamListInfo")
	PyDoc_STRVAR (pyPluginSetParam_doc,"setParam(name, value) \n\ \n\ Sets a writeable parameter ``name`` of this plugin object to ``value``. \n\ \n\ Sets the internal plugin parameter with 'name' to a new value. The plugin itsself \n\ can decide whether the given value is accepted as new value. This may depend on the \n\ type of the given value, but also on the allowed value range indicated by further \n\ meta information of the internal parameter. Parameters that are (currently) set to \n\ read-only cannot be set. \n\ \n\ The ``name`` of the parameter must have the following form: \n\ \n\ * **name** \n\ * **name:additionalTag** (additionalTag can be a special feature of some plugins) \n\ * **name[index]** (only possible if parameter is an array type and you only want to get \n\ one single value, specified by the integer index [0,nrOfArrayItems-1]) \n\ * **name[index]:additionalTag** (a combination of the two possibilies above) \n\ \n\ Parameters \n\ ----------- \n\ name : str\n\ Name of the parameter. \n\ value : int or float or str or tuple of int or tuple of float or dataObject or polygonMesh or pointCloud or dataIO or actuator\n\ The ``value`` that will be set. The plugin will check if this ``value`` fits \n\ to possible constraints, given by the parameters's meta information or further \n\ limitations. \n\ \n\ Raises \n\ ------ \n\ RuntimeError \n\ if the new ``value`` is (currently) not accepted. \n\ \n\ See Also \n\ --------- \n\ getParam, getParamList, getParamListInfo")
	PyDoc_STRVAR (pyPluginShowToolbox_doc,"showToolbox() \n\ \n\ Opens the (optional) toolbox of this plugin object in the itom main window. \n\ \n\ Raises \n\ ------ \n\ RuntimeError \n\ if this plugin does not provide a toolbox. \n\ \n\ See Also \n\ --------- \n\ hideToolbox")
	PyDoc_STRVAR (pyPluginHideToolbox_doc,"hideToolbox() \n\ \n\ Hides the visible toolbox of this plugin object. \n\ \n\ Raises \n\ ------ \n\ RuntimeError \n\ if this plugin does not provide a toolbox. \n\ \n\ See Also \n\ --------- \n\ showToolbox")
	PyDoc_STRVAR (pyPluginShowConfiguration_doc,"showConfiguration() \n\ \n\ Shows the (optional) configuration dialog of this plugin as modal dialog. \n\ \n\ Raises \n\ ------- \n\ RuntimeError \n\ if this plugin does not provide a configuration dialog.")
	PyDoc_STRVAR (pyPlugInGetExecFuncsInfo_doc,"getExecFuncsInfo(funcName = \"\", detailLevel = 0) -> Optional[dict] \n\ \n\ Lists all available additional functions of this plugin or gives a detailed description of one specific ``funcName``. \n\ \n\ Every plugin can define further functions, that are called by the method :meth:`exec`. \n\ This can for instance be used in order to call specific calibration routines of \n\ cameras or actuators. \n\ \n\ This method either prints requested information in a readable form to the command line \n\ or returns this information as nested dictionary. \n\ \n\ Parameters \n\ ----------- \n\ funcName : str, optional \n\ is the fullname or a part of any name of such an additional plugin function. \n\ If ``funcName`` is an empty string or does not match any plugin function \n\ (case sensitive), a list of all suitable additional plugin function names is given. \n\ Else, detailed information about the desired ``funcName`` is given, like its description \n\ or (optional) arguments that are needed to execute this function. \n\ detailLevel : dict, optional \n\ if ``detailLevel == 1``, this returns a nested dictionary with detailed information, else \n\ it is printed to the command line in a readable form (default). \n\ \n\ Returns \n\ ------- \n\ None or dict\n\ The return value depends on the argument ``detailLevel``. \n\ \n\ See Also \n\ -------- \n\ exec")
	PyDoc_STRVAR (PyPlugin_execFunc_doc,"exec(funcName, *args, **kwds) -> Union[Any, Tuple[Any]] \n\ \n\ Calls the additional function ``funcName`` of this plugin. \n\ \n\ Every plugin can define special, additional functions (denoted as ``exec functions``) \n\ that can for instance be used in order to call specific calibration routines \n\ of cameras or actuators. This generic method is used to call one of these specific \n\ functions, that has to be registered in the plugin under the name ``funcName``. \n\ \n\ Every function can define a set of mandatory and / or optional parameters. See \n\ :meth:`getExecFuncsInfo` or the plugin help viewer of itom for more information. \n\ Pass the mandatory and optional parameters as arguments ``param1``, ``param2`` ... to \n\ this method. \n\ \n\ Additionally, every function can return one or multiple values. Either the single value \n\ or a tuple of all returned values is returned by this method. \n\ \n\ Parameters \n\ ----------- \n\ funcName : str \n\ The name of the additional function.\n\ *args : Any \n\ Further positional arguments, that are assigned first to all mandatory parameters, \n\ followed by the optional ones. The mandatory or optional parameters of the called \n\ function can also given as keyword arguments (see ``**kwds``). \n\ **kwds : Any, optional \n\ Keyword-based arguments, see ``*args`` above. \n\ \n\ Returns \n\ ------- \n\ any or tuple of any \n\ The returned values depend on the function itself.\n\ \n\ See Also \n\ -------- \n\ getExecFuncsInfo")
	PyDoc_STRVAR (PyPlugin_userMutex_tryLock_doc,"tryLock(timeout = 3000) -> bool \n\ \n\ Tries to lock the user mutex of this plugin. \n\ \n\ Every plugin contains a user mutex, that can be used for arbitrary purposes. \n\ It is not used for any official purposes. You can for instance use this mutex \n\ both from Python and other C++ threads to protect a series of calls to this \n\ plugin to not to be interrupted by other participants. However, it is the \n\ full responsibility of the programmer to carefully use this mutex. \n\ \n\ Please be careful, that this method can lead to a deadlock if ``timeout`` is \n\ set to a negative value (inifinite wait) and if the mutex is not released \n\ by any other thread. Hint: A Python thread is no `real` thread, it must be \n\ a real C++ thread. If you want to use the mutex within two or more Python \n\ threads, it is recommended, to call this method with a defined ``timeout`` \n\ within a loop and wait for this method to return ``True``. This allows \n\ unlocking the mutex by another thread. \n\ \n\ This method is new for plugins that implement the AddInInterface >= 4.2. \n\ \n\ Parameters \n\ ---------- \n\ timeout : int \n\ This method will wait for at most ``timeout`` milliseconds for the \n\ mutex to become available. If this value is negative, it will wait forever \n\ until the mutex become available.\n\ \n\ Returns \n\ ------- \n\ bool \n\ ``True`` if the user defined mutex could be locked, else ``False``. \n\ \n\ See Also \n\ -------- \n\ unlock")
	PyDoc_STRVAR (PyPlugin_userMutex_unlock_doc,"unlock() \n\ \n\ Tries to unlock the user mutex of this plugin. \n\ \n\ Every plugin contains a user mutex, that can be used for arbitrary purposes. \n\ It is not used for any official purposes. You can for instance use this mutex \n\ both from Python and other C++ threads to protect a series of calls to this \n\ plugin to not to be interrupted by other participants. However, it is the \n\ full responsibility of the programmer to carefully use this mutex. \n\ fu\n\ This method is new for plugins that implement the AddInInterface >= 4.2. \n\ \n\ See Also \n\ -------- \n\ lock")
PyObject *	setParam (ito::AddInBase *addInObj, PyObject *args)
	PyDoc_STRVAR (pyActuatorInit_doc,"actuator(name, *args, **kwds) -> actuator \n\ \n\ Creates a new instance of the actuator plugin ``name``. \n\ \n\ This is the constructor for an :class:`actuator` plugin. It initialises an new \n\ instance of the plugin with the given ``name``. The initialisation parameters are \n\ parsed and unnamed parameters are used in their incoming order to fill first \n\ mandatory parameters and afterwards optional parameters. Parameters may be passed \n\ with their name as keyword, too. However, as usual, no positional parameters are \n\ allowed after a keyword-based one.\n\ \n\ See :meth:`pluginHelp` for detailed information about the specific initialisation \n\ parameters.\n\ \n\ Parameters \n\ ----------- \n\ name : str \n\ is the fullname (case sensitive) of an :class:`actuator`-plugin. \n\ *args : Any \n\ Every ``actuator`` plugin defines a list of mandatory and optional initialization \n\ parameters. Pass these arguments either as positional (``*args``) or keyword \n\ based (``**kwds``) arguments, where the mandatory parameters must be given first, \n\ followed by the optional ones. Not every optional initialization argument must be \n\ given, else its default value is used. \n\ **kwds : Any \n\ Further keyword based parameters. See also ``*args``. \n\ \n\ Returns \n\ -------- \n\ actuator \n\ new instance of the desired actuator plugin.")
	PyDoc_STRVAR (pyActuatorCalib_doc,"calib(axisIndex1, *args) \n\ \n\ Starts a calibration or homing routine of one or multiple axes. \n\ \n\ Most actuators have the possibility to calibrate or home certain axes. \n\ Use this command to start the calibration. \n\ \n\ Parameters \n\ ----------- \n\ axisIndex1 : int\n\ Index of the first axis to be calibrated or homed (e.g. 0 for first axis). \n\ *args : int \n\ Pass further axis indices as 2nd, 3rd, etc. parameter to this function \n\ if more than one axis should be calibrated or homed. \n\ \n\ Raises \n\ ---------- \n\ NotImplemented \n\ if calibration routine not available in this plugin.")
	PyDoc_STRVAR (pyActuatorSetOrigin_doc,"setOrigin(axisIndex1, *args) \n\ \n\ Defines the current position of the given axes to have the value ``0``. \n\ \n\ The current positions of all indicated axes (``axisIndex1``, ``*args``) are considered \n\ to be ``0`` such that future positioning commands are relative with respect to this \n\ current position. \n\ \n\ Parameters \n\ ----------- \n\ axisIndex1 : int\n\ index of the first axis (e.g. 0 for first axis) \n\ *args : int \n\ Pass further axis indices as 2nd, 3rd, etc. parameter to this function \n\ if more than one axis should be origined. \n\ \n\ Raises \n\ ---------- \n\ NotImplemented \n\ if actuator does not support this feature")
	PyDoc_STRVAR (pyActuatorGetStatus_doc,"getStatus(axis = -1) -> Union[int, List[int]] \n\ \n\ Returns the status for one single axis or all axes of the actuator object. \n\ \n\ Each axis of an actuator plugin has got a status value that is used for informing \n\ about the current status of the axis. \n\ \n\ The status value is a bitmask (flag), that might contain a combination of the \n\ following values: \n\ \n\ Moving flags: \n\ \n\ * actuatorUnknown = 0x0001 : unknown current moving status \n\ * actuatorInterrupted = 0x0002 : movement has been interrupted by the user or another \n\ error during the movement occurred \n\ * actuatorMoving = 0x0004 : axis is currently moving \n\ * actuatorAtTarget = 0x0008 : axis reached the target position \n\ * actuatorTimeout = 0x0010 : timout during movement. Unknown status of the movement \n\ \n\ Switches flags: \n\ \n\ * actuatorEndSwitch = 0x0100 : axis reached any end switch (e.g. if only one end switch \n\ is available) \n\ * actuatorEndSwitch1 = 0x0200 : axis reached the specified left end switch (if set, also \n\ set actuatorEndSwitch)\n\ * actuatorEndSwitch2 = 0x0400 : axis reached the specified left end switch (if set, also \n\ set actuatorEndSwitch)\n\ * actuatorRefSwitch = 0x0800 : axis reached any reference switch (e.g. for calibration...) \n\ * actuatorRefSwitch1 = 0x1000 : axis reached the specified right reference switch \n\ (if set, also set actuatorRefSwitch)\n\ * actuatorRefSwitch2 = 0x2000 : axis reached the specified right reference switch \n\ (if set, also set actuatorRefSwitch)\n\ \n\ Status flags: \n\ \n\ * actuatorAvailable = 0x4000 : the axis is available \n\ * actuatorEnabled = 0x8000 : the axis is currently enabled and can be moved \n\ * actuatorError = 0x10000 : axis has encountered error/reports error\n\ \n\ Parameters \n\ ----------- \n\ axis : int, optional\n\ If an index >= 0 is passed, the status of this specific axis is returned. \n\ Else, a list of status values for all axes is returned (default). \n\ \n\ Returns \n\ ------- \n\ int or list of int \n\ Single status value or a list of status values as combination of the \n\ possible flag values, given above.")
	PyDoc_STRVAR (pyActuatorGetPos_doc,"getPos(axisIndex1, *args) -> Union[float, Tuple[float]] \n\ \n\ Returns the current position(s) of the given axis or axes (in mm or degree).\n\ \n\ This method requests the current position(s) of the given axes and returns it or them. \n\ \n\ Parameters \n\ ----------- \n\ axisIndex1 : int\n\ index of the first axis (e.g. 0 for first axis) \n\ *args : int\n\ Pass further indices of more axes as additional parameters. \n\ \n\ Returns \n\ ------- \n\ positions : float or tuple of float \n\ Current position as float value if only one axis is given or a tuple of floats \n\ if multiple axis indices are given. The unit is **mm** or **degree**. \n\ \n\ See Also \n\ --------- \n\ setPosRel, setPosAbs")
	PyDoc_STRVAR (PyActuatorPlugin_getType_doc,"getType() -> int \n\ \n\ Returns the type value of this actuator plugin (always: 0x2). \n\ \n\ Returns \n\ ------- \n\ int \n\ actuator type value (``0x2``).")
	PyDoc_STRVAR (pyActuatorSetInterrupt_doc,"setInterrupt() \n\ \n\ Request the interruption of the movement of this actuator. \n\ \n\ Sets the interrupt flag of the :class:`actuator`. The actuator interrupts \n\ the movement of all running axes as soon as this flag is checked and handled again.")
	PyDoc_STRVAR (pyActuatorConnect_doc,"connect(signalSignature, callableMethod, minRepeatInterval = 0) \n\ \n\ Connects a signal of this actuator with the given callable Python method. \n\ \n\ Every :class:`actuator` object can emit different signals whenever a certain event \n\ occurs. Use the method :meth:`info` to get a print-out of a list of possible signals \n\ of the actuator. This method is used to connect a certain callable Python callback \n\ method or function to a specific signal. The callable function can be bounded as well \n\ as unbounded. \n\ \n\ The connection is described by the string signature of the signal (hence the source of \n\ the connection). Such a signature is the name of the signal, followed by the types of \n\ its arguments (the original C++ types). An example is ``targetChanged(QVector<double>)``, \n\ emitted whenever the target position of one or multiple axes changed. This signal can \n\ be connected to a callback function, that accepts one argument (in case of a bounded method, \n\ the ``self`` argument must be an additional first parameter. \n\ \n\ The C++ datatype ``QVector<double>`` will be transformed to ``tuple of float``, for \n\ more type conversions see the table in section :ref:`qtdesigner-datatypes`. In general, \n\ a ``callableMethod`` must be a method or function with the same number of parameters than \n\ the signal has (besides the ``self`` argument). The types are converted based on the itom \n\ C++ <-> Python conversion table (:ref:`qtdesigner-datatypes`). \n\ \n\ If a signal is emitted very often, it can be necessary to limit the call of the callback \n\ function to a certain minimum time interval. This can be given by the ``minRepeatInterval`` \n\ parameter. \n\ \n\ Parameters \n\ ----------- \n\ signalSignature : str \n\ This must be the valid signature, known from the Qt-method *connect* \n\ (e.g. ``targetChanged(QVector<double>)``) \n\ callableMethod : callable \n\ valid method or function that is called if the signal is emitted. \n\ minRepeatInterval : int, optional \n\ If > 0, the same signal only invokes a slot once within the given interval (in ms). \n\ Default: 0 (all signals will invoke the callable python method. \n\ \n\ See Also \n\ --------- \n\ disconnect, info")
	PyDoc_STRVAR (pyActuatorDisconnect_doc,"disconnect(signalSignature, callableMethod) \n\ \n\ Disconnects a connection which must have been established before with exactly the same parameters.\n\ \n\ Parameters \n\ ----------- \n\ signalSignature : str \n\ This must be the valid signature, known from the Qt-method *connect* \n\ (e.g. ``clicked(bool)``) \n\ callableMethod : callable \n\ valid method or function, that should not be called any more if the \n\ given signal is emitted. \n\ \n\ See Also \n\ --------- \n\ connect, info")
	PyDoc_STRVAR (pyActuatorInfo_doc,"info(verbose = 0) \n\ \n\ Prints out information about signal and callable slots of this actuator.\n\ \n\ Parameters \n\ ----------- \n\ verbose : int \n\ 0: only slots and signals from the plugin class are printed (default) \n\ 1: all slots and signals from all inherited classes are printed\n\ \n\ See Also \n\ -------- \n\ connect, disconnect")
ito::RetVal	parsePosParams (PyObject *args, char **&cargs, char *&cargt, QVector< int > &axisVec, QVector< double > &posVec)
	PyDoc_STRVAR (pyActuatorSetPosAbs_doc,"setPosAbs(axisIndex1, pos1, *args) \n\ \n\ Moves the given axis or axes to the indicated absolute position(s) (in mm or degree).\n\ \n\ The parameters of this function are always alternating between the index of one axis \n\ and its new absolute target position as following parameter. As an example, moving \n\ the first three axes would look like:: \n\ \n\ myMotor.setPosAbs(0, 10.0, 1, -5.2, 2, 0.7) # axes 0, 1 and 2 are absolutely moved \n\ \n\ This method starts the absolute positioning of all given axes. If the ``async`` parameter \n\ (see :meth:`getParam` and :meth:`setParam`) of the plugin is ``0`` (usually default), \n\ a synchronous positioning is started, hence, this method returns after that all \n\ axes reached their target positions or a timeout occurred. Else, (``async = 1``) this \n\ method immediately returns and the actuator continuous its movement. \n\ \n\ Parameters \n\ ----------- \n\ axisIndex1 : int \n\ index of the first axis, that should be moved. \n\ pos1 : float \n\ absolute target position for this first axis ``axisIndex1`` (in mm or degree) \n\ *args \n\ Pass more arguments of the form ``axisIndexX, posX`` to move more than one axis. \n\ \n\ See Also \n\ --------- \n\ getPos, setPosRel")
	PyDoc_STRVAR (pyActuatorSetPosRel_doc,"setPosRel(axisIndex1, offset1, *args) \n\ \n\ Moves the given axis or axes to the indicated relative position(s) (in mm or degree).\n\ \n\ The parameters of this function are always alternating between the index of one axis \n\ and its new absolute target position as following parameter. As an example, moving \n\ the first three axes would look like:: \n\ \n\ myMotor.setPosAbs(0, 10.0, 1, -5.2, 2, 0.7) # axes 0, 1 and 2 are absolutely moved \n\ \n\ This method starts the relative positioning of all given axes. If the ``async`` parameter \n\ (see :meth:`getParam` and :meth:`setParam`) of the plugin is ``0`` (usually default), \n\ a synchronous positioning is started, hence, this method returns after that all \n\ axes reached their target positions or a timeout occurred. Else, (``async = 1``) this \n\ method immediately returns and the actuator continuous its movement. \n\ \n\ Parameters \n\ ----------- \n\ axisIndex1 : int \n\ index of the first axis, that should be moved. \n\ offset1 : float \n\ The new target position for the first axis ``axisIndex1`` is given by the current \n\ position of this axis plus this ``offset1`` value (in mm or degree) \n\ *args \n\ Pass more arguments of the form ``axisIndexX, offsetX`` to move more than one axis. \n\ \n\ See Also \n\ --------- \n\ getPos, setPosAbs")
	PyDoc_STRVAR (pyActuatorGetCurrentStatus_doc,"tuple of int : Gets the current status (flag mask, see :py:meth:`~itom.actuator.getStatus`) of all axes \n\ \n\ This property returns a tuple whose size corresponds to the number of axes of this \n\ actuator. The returned tuple contains the current positions of all axes (in mm or degree). \n\ This property is always updated if the plugin signals a change of any current position \n\ via the signal 'actuatorStatusChanged'. Instead of reading this property, you can also \n\ connect to this signal in order to get instantly informed about new current positions. \n\ \n\ The difference between this property and the method :py:meth:`~itom.actuator.getStatus` \n\ is that `getStatus` will only return if the actuator plugin is currently idle. This \n\ property always returns immediately, however it only contains the last reported values \n\ which can slightly differ from the real current positions (if the plugin rarely emits its \n\ current states for instance due to performance reasons).")
	PyDoc_STRVAR (pyActuatorGetCurrentPositions_doc,"tuple of float : Gets the current positions (in mm or degree) of all axes. \n\ \n\ This property returns a tuple whose size corresponds to the number of axes of this \n\ actuator. The returned tuple contains the current positions of all axes (in mm or degree). \n\ This property is always updated if the plugin signals a change of any current position \n\ via the signal ``actuatorStatusChanged``. Instead of reading this property, you can also \n\ connect to this signal in order to get instantly informed about new current positions. \n\ \n\ This property always returns immediately, however it \n\ only contains the last reported values which can slightly differ from the real current \n\ positions (if the plugin rarely emits its current states for instance due to performance \n\ reasons).")
	PyDoc_STRVAR (pyActuatorGetTargetPositions_doc,"tuple of float : Gets the target positions (in mm or degree) of all axes. \n\ \n\ This property returns a tuple whose size corresponds to the number of axes of this \n\ actuator. The returned tuple contains the current target positions of all axes \n\ (in mm or degree). This property is always updated if the plugin signals a change of \n\ any target position via the signal ``targetChanged``. Instead of reading this property, \n\ you can also connect to this signal in order to get instantly informed about new \n\ target positions. \n\ \n\ This property always returns immediately, however it only contains the last reported \n\ values which can slightly differ from the real target positions (if the plugin rarely \n\ emits its current states for instance due to performance reasons).")
	PyDoc_STRVAR (pyDataIOInit_doc,"dataIO(name, *args, **kwds) -> dataIO \n\ \n\ Creates a new instance of the dataIO plugin ``name``. \n\ \n\ This is the constructor for an :class:`dataIO` plugin. It initialises an new \n\ instance of the plugin with the given ``name``. The initialisation parameters are \n\ parsed and unnamed parameters are used in their incoming order to fill first \n\ mandatory parameters and afterwards optional parameters. Parameters may be passed \n\ with their name as keyword, too. However, as usual, no positional parameters are \n\ allowed after a keyword-based one.\n\ \n\ See :meth:`pluginHelp` for detailed information about the specific initialisation \n\ parameters.\n\ \n\ Parameters \n\ ----------- \n\ name : str \n\ is the fullname (case sensitive) of an :class:`dataIO`-plugin. \n\ *args : Any \n\ Every ``actuator`` plugin defines a list of mandatory and optional initialization \n\ parameters. Pass these arguments either as positional (``*args``) or keyword \n\ based (``**kwds``) arguments, where the mandatory parameters must be given first, \n\ followed by the optional ones. Not every optional initialization argument must be \n\ given, else its default value is used. \n\ **kwds : Any \n\ Further keyword based parameters. See also ``*args``. \n\ \n\ Returns \n\ -------- \n\ actuator \n\ new instance of the desired dataIO plugin.")
	PyDoc_STRVAR (PyDataIOPlugin_startDevice_doc,"startDevice(count = 1) \n\ \n\ Starts the given dataIO plugin object. \n\ \n\ This command starts the dataIO plugin such that it is ready for data acquisition. \n\ Call this method before you start using commands like :meth:`acquire`, :meth:`getVal` \n\ or :meth:`copyVal`. If the device already is started, an internal start-counter is \n\ incremented by the parameter ``count``. The corresponding :meth:`stopDevice` method \n\ then decrements this counter and finally stops the device once the counter drops to \n\ zero again. \n\ \n\ The counter is necessary, since every connected live image needs to start the device \n\ without knownledge about any previous start. No acquisition is possible, if the device \n\ has not been started, hence the counter is 0. \n\ \n\ Parameters \n\ ----------- \n\ count : int, optional \n\ Number of increments to the internal start-counter (default: 1). \n\ \n\ See Also \n\ --------- \n\ stopDevice")
	PyDoc_STRVAR (PyDataIOPlugin_stopDevice_doc,"stopDevice(count = 1) -> Optional[int] \n\ \n\ Stops the given dataIO plugin object. \n\ \n\ If this method is called as many times as he corresponding :meth:`startDevice` method \n\ (or if the ``counts`` are equal), the :class:`dataIO` device is stopped (not deleted) \n\ and it is not possible to acquire further data. \n\ \n\ Once a live image is connected to a camera, :meth:`startDevice` is automatically called \n\ at start of the live acquisition and :meth:`stopDevice` at shutdown. \n\ \n\ Parameters \n\ ----------- \n\ count : int, optional\n\ if ``count`` > 1, :meth:`stopDevice` is executed ``count`` times, in order to \n\ decrement the grabber internal start counter. You can also set ``count = -1``, \n\ then :meth:`stopDevice` is called in a loop until the internal start counter \n\ drops to 0. The number of effective counts is then returned.\n\ \n\ Returns \n\ -------- \n\ counts : None or int \n\ If ``count = -1`` the number of required calls to ``stopDevice`` to finally \n\ stop the device is returned. For ``count >= 0``, ``None`` is returned. \n\ \n\ See Also \n\ --------- \n\ startDevice")
	PyDoc_STRVAR (PyDataIOPlugin_acquire_doc,"acquire(trigger = dataIO.TRIGGER_SOFTWARE) \n\ \n\ Triggers a new camera acquisition. \n\ \n\ This method triggers a new data acquisition. This method immediately returns even if \n\ the acquisition is not finished yet. Use :meth:`getVal` or :meth:`copyVal` to get the \n\ acquired data. Both methods will then block until the data is available or a timeout \n\ occurred. \n\ \n\ Before calling :meth:`acquire`, the device must have been started using \n\ :meth:`startDevice`. \n\ \n\ Parameters \n\ ----------- \n\ trigger : int, optional\n\ Type of the trigger: \n\ \n\ * ``dataIO.TRIGGER_SOFTWARE = 0`` : a software trigger is started, hence, the \n\ acquisition is immediately started when calling this method.\n\ * others : depending on your camera, this parameter can be used to set other \n\ triggers, like hardware trigger with raising or falling edges... Please consider \n\ the documentation of the specific device for possible values.")
	PyDoc_STRVAR (PyDataIOPlugin_stop_doc,"stop() \n\ \n\ Stops a started, continuous acquisition. \n\ \n\ This method stops a previously started, continuous data acquisition. This method is not \n\ implemented in every plugin. A common example for its implementation is to stop an \n\ infinite, continuous acquisition job of an AD-converter plugin. \n\ \n\ See also\n\ ---------\n\ acquire")
	PyDoc_STRVAR (PyDataIOPlugin_getVal_doc,"getVal(dataObj) -> None \\\n\ getVal(buffer, length = INT_MAX) -> int \n\ \n\ Gets shallow copy of internal camera image if `dataObj` is provided. Else values from the plugins are copied to given buffer. \n\ \n\ Returns a reference (shallow copy) of the recently acquired image (located in the \n\ internal memory if the plugin) if the plugin is a grabber or camera and the buffer is a \n\ :class:`dataObject`. Please consider that the values of the :class:`dataObject` might \n\ change if a new image is acquired since it is only a reference. Therefore consider copying \n\ the :class:`dataObject` or directly use :meth:`copyVal`. \n\ \n\ If no acquisition has been triggered, this method raises a :obj`RuntimeError`. If the \n\ acquisition is not finished yet, this method blocks and waits until the end of the \n\ acquisition. \n\ \n\ If the plugin is another type than a grabber or camera (e.g. serialIO), this method \n\ requires any :obj:`buffer` object that is preallocated with a reasonable size (e.g. \n\ :obj:`bytearray`, :obj:`bytes` or unicode :obj:`str`. Then, the currently available \n\ data is copied into this buffer object and the size of the copied data is returned. If \n\ the buffer is too small, only the data that fits into the buffer is copied. Another \n\ call to :meth:`getVal` will copy the rest. \n\ \n\ Parameters \n\ ----------- \n\ dataObj : dataObject \n\ Usually for cameras and grabber: A reference (shallow copy) to the internal memory \n\ of the camera plugin is set to the given data object. Therefore its content may \n\ change if a new image is being acquired by the camera. Consider taking a deep copy \n\ if the image (:meth:`dataObject.copy`) or use the method :meth:`copyVal`. \n\ buffer : bytearray or bytes or str \n\ Usually for all other IO devices or AD-converters: The buffer must be an object \n\ of type :obj:`bytearray`, :obj:`bytes` or unicode :obj:`str`. The ``length`` \n\ parameter is then set to the size of the allocated buffer. This buffer is then \n\ filled with data and the filled size is returned (max: ``length``). \n\ length : int, optional \n\ Size of the given buffer. This value is usually automatically determined and \n\ must not be given. \n\ \n\ Returns \n\ -------- \n\ None or int \n\ ``None`` if ``dataObj`` is given, else the size of the values filled into the given \n\ ``buffer``. \n\ \n\ See Also \n\ --------- \n\ copyVal")
	PyDoc_STRVAR (PyDataIOPlugin_copyVal_doc,"copyVal(destObject) \n\ \n\ Gets deep copy of data of this plugin, stored in the given data object. \n\ \n\ Returns a deep copy of the recently acquired data (for grabber and ADDA only) of the \n\ camera or AD-converter device. The deep copy sometimes requires one copy operation \n\ more than the similar command :meth:`getVal`. However, :meth:`getVal` only returns \n\ a reference to the plugin internal data structure whose values might be changed if \n\ another data acquisition is started. \n\ \n\ If no acquisition has been triggered, this method raises a RuntimeError. If the \n\ acquisition is not finished yet, this method blocks and waits until the end of the \n\ acquisition. \n\ \n\ Parameters \n\ ----------- \n\ destObject : dataObject\n\ `dataObject` where the plugin data is copied to. Either provide an empty \n\ :class:`dataObject` or a :class:`dataObject` whose shape exactly fits to the \n\ shape of the available data of the plugin. Therefore you can allocate a \n\ 3D data object, set a region of interest to one plane such that the data from \n\ the plugin is copied into this plane. \n\ \n\ Raises \n\ ------- \n\ RuntimeError \n\ if the dataIO plugin is anything else than ADDA or grabber\n\ or if no acquisition has been triggered \n\ \n\ See Also \n\ --------- \n\ getVal")
	PyDoc_STRVAR (PyDataIOPlugin_setVal_doc,"setVal(dataObj) -> None \\\n\ setVal(buffer, length = 1) -> None \n\ \n\ Transfers a dataObject to an ADDA plugin for write, or a bytearray to other dataIO plugins for general purposes. \n\ \n\ If the :class:`dataIO` plugin has the subtype ``ADDA`` (analog-digital converter), \n\ this method is used to send data to one or more analog outputs of the device. \n\ In this case a :class:`dataObject` must be given as first and only argument. \n\ and the second argument ``length`` must be 1. \n\ \n\ For other dataIO plugins, the first argument must be any buffer object, like \n\ a :obj:`bytearray`, :obj:`bytes` or unicode :obj:`str`. The ``length`` is then extracted \n\ from this value. However it is also possible to define a user-defined size using the \n\ ``length`` argument. \n\ \n\ Parameters \n\ ----------- \n\ dataObj : dataObject \n\ The array, that should be transmitted to the output of an analog-digital converter. \n\ Usually, the shape of this array is ``M x N``, where ``M`` channels will obtain up \n\ to ``N`` new values. This argument is used for ``ADDA`` :class:`dataIO` devices.\n\ buffer : bytearray or bytes or str \n\ Other :class:`dataIO` devices than ``ADDA`` need to pass a buffer object, \n\ like a :obj:`bytearray`, :obj:`bytes` or unicode :obj:`str`. \n\ length : int, optional \n\ Usually, this value is not required, since the length of the ``buffer`` is \n\ automatically extracted from the given object.")
	PyDoc_STRVAR (PyDataIOPlugin_enableAutoGrabbing_doc,"enableAutoGrabbing() \n\ \n\ Enables auto grabbing for the grabber (camera...). \n\ \n\ If the auto grabbing flag is set, the camera acquisition is continuously triggered \n\ if at least one live image is connected to the camera. The default and minimum interval \n\ between two grabs is 20 ms. It can be changed via :meth:`setAutoGrabbingInterval`. \n\ If the grabbing process is slower, the camera tries to acquire new images as fast \n\ as possible. \n\ \n\ Enabling this auto grabbing mechanism can be undesired behaviour for instance if a \n\ measurement is started where the acquisition should be controlled by a specific \n\ script or something similar. In this case, disable the auto grabbing property. \n\ All connected live images will then get new images only if :meth:`getVal` or \n\ :meth:`copyVal` is called. \n\ \n\ This method enables the auto grabbing timer. \n\ \n\ See Also \n\ --------- \n\ setAutoGrabbing, disableAutoGrabbing, getAutoGrabbing, setAutoGrabbingInterval")
	PyDoc_STRVAR (PyDataIOPlugin_disableAutoGrabbing_doc,"disableAutoGrabbing() \n\ \n\ Disables auto grabbing for this grabber (camera...). \n\ \n\ If the auto grabbing flag is set, the camera acquisition is continuously triggered \n\ if at least one live image is connected to the camera. The default and minimum interval \n\ between two grabs is 20 ms. It can be changed via :meth:`setAutoGrabbingInterval`. \n\ If the grabbing process is slower, the camera tries to acquire new images as fast \n\ as possible. \n\ \n\ Enabling this auto grabbing mechanism can be undesired behaviour for instance if a \n\ measurement is started where the acquisition should be controlled by a specific \n\ script or something similar. In this case, disable the auto grabbing property. \n\ All connected live images will then get new images only if :meth:`getVal` or \n\ :meth:`copyVal` is called. \n\ \n\ This method disables the auto grabbing timer. \n\ \n\ See Also \n\ --------- \n\ setAutoGrabbing, enableAutoGrabbing, getAutoGrabbing, setAutoGrabbingInterval")
	PyDoc_STRVAR (PyDataIOPlugin_setAutoGrabbing_doc,"setAutoGrabbing(enable) \n\ \n\ Enables or disables the auto grabbing property of this grabber device. \n\ \n\ If the auto grabbing flag is set, the camera acquisition is continuously triggered \n\ if at least one live image is connected to the camera. \n\ \n\ Enabling this auto grabbing mechanism can be undesired behaviour for instance if a \n\ measurement is started where the acquisition should be controlled by a specific \n\ script or something similar. In this case, disable the auto grabbing property. \n\ All connected live images will then get new images only if :meth:`getVal` or \n\ :meth:`copyVal` is called. \n\ \n\ Parameters \n\ ----------- \n\ enable : bool \n\ ``True`` will enable the auto grabbing timer, ``False`` disables it. \n\ \n\ See Also \n\ --------- \n\ enableAutoGrabbing, disableAutoGrabbing, getAutoGrabbing")
	PyDoc_STRVAR (PyDataIOPlugin_getAutoGrabbing_doc,"getAutoGrabbing() -> bool \n\ \n\ Returns if the auto grabbing property of this grabber device is enabled or disabled. \n\ \n\ If the auto grabbing flag is set, the camera acquisition is continuously triggered \n\ if at least one live image is connected to the camera. \n\ \n\ Enabling this auto grabbing mechanism can be undesired behaviour for instance if a \n\ measurement is started where the acquisition should be controlled by a specific \n\ script or something similar. In this case, disable the auto grabbing property. \n\ All connected live images will then get new images only if :meth:`getVal` or \n\ :meth:`copyVal` is called. \n\ \n\ Returns \n\ ------- \n\ bool \n\ ``True`` if the auto grabbing timer is currently active, otherwise ``False``. \n\ \n\ See Also \n\ --------- \n\ enableAutoGrabbing, disableAutoGrabbing, setAutoGrabbing")
	PyDoc_STRVAR (PyDataIOPlugin_setAutoGrabbingInterval_doc,"setAutoGrabbingInterval() \n\ \n\ Changes the minimum auto grabbing interval (in ms) between two auto-grabbed datasets. \n\ \n\ If auto grabbing is enabled for a grabber device, a timer is set that continuously \n\ acquires data or images from the devices and sends it to all connected plots or \n\ other listeners. The timer event will occur with a certain interval (in ms). However, \n\ if the image acquisition requires more time than the interval, several timer events \n\ will be automatically omitted, such that the next image is only acquired if the \n\ grabber device is in an idle state again. Hence, the interval is considered to be a \n\ minimum value. \n\ \n\ The default interval of newly started grabber devices in 20 ms. It is possible to \n\ change this interval even if auto grabbing is currently disabled. The new interval \n\ will be considered from the next activation on. \n\ \n\ Parameters \n\ ----------- \n\ interval : int\n\ New minimum auto grabbing timer interval in `ms`. \n\ \n\ See Also \n\ --------- \n\ enableAutoGrabbing, disableAutoGrabbing, getAutoGrabbing, setAutoGrabbing, getAutoGrabbingInterval")
	PyDoc_STRVAR (PyDataIOPlugin_getAutoGrabbingInterval_doc,"getAutoGrabbingInterval() -> int \n\ \n\ Returns the current auto grabbing interval (in ms), even if auto grabbing is disabled. \n\ \n\ If auto grabbing is enabled for a grabber device, a timer is set that continuously \n\ acquires data or images from the devices and sends it to all connected plots or \n\ other listeners. The timer event will occur with a certain interval (in ms). However, \n\ if the image acquisition requires more time than the interval, several timer events \n\ will be automatically omitted, such that the next image is only acquired if the \n\ grabber device is in an idle state again. Hence, the interval is considered to be a \n\ minimum value. \n\ \n\ The default interval of newly started grabber devices in 20 ms. \n\ \n\ Returns \n\ ------- \n\ int \n\ the current auto grabbing timer interval in `ms`. \n\ \n\ See Also \n\ --------- \n\ enableAutoGrabbing, disableAutoGrabbing, getAutoGrabbing, setAutoGrabbing, setAutoGrabbingInterval")
	PyDoc_STRVAR (PyDataIOPlugin_connect_doc,"connect(signalSignature, callableMethod, minRepeatInterval = 0) \n\ \n\ Connects a signal of this dataIO device with the given callable Python method. \n\ \n\ Every :class:`dataIO` object can emit different signals whenever a certain event \n\ occurs. Use the method :meth:`info` to get a print-out of a list of possible signals \n\ of the dataIO device. This method is used to connect a certain callable Python callback \n\ method or function to a specific signal. The callable function can be bounded as well \n\ as unbounded. \n\ \n\ The connection is described by the string signature of the signal (hence the source of \n\ the connection). Such a signature is the name of the signal, followed by the types of \n\ its arguments (the original C++ types). An example is ``destroyed()``, \n\ emitted if this device is internally deleted. This signal can \n\ be connected to a callback function with no arguments, since the signal has no arguments, \n\ too. In case of a bounded method, the ``self`` argument must be given in any case. \n\ \n\ If the signal should have further arguments with specific datatypes, they are transformed \n\ into corresponding Python data types. A table of supported conversions is given in section \n\ :ref:`qtdesigner-datatypes`. In general, a ``callableMethod`` must be a method or \n\ function with the same number of parameters than the signal has (besides the \n\ ``self`` argument). \n\ \n\ If a signal is emitted very often, it can be necessary to limit the call of the callback \n\ function to a certain minimum time interval. This can be given by the ``minRepeatInterval`` \n\ parameter. \n\ \n\ Parameters \n\ ----------- \n\ signalSignature : str \n\ This must be the valid signature, known from the Qt-method *connect* \n\ (e.g. ``targetChanged(QVector<double>)``) \n\ callableMethod : callable \n\ valid method or function that is called if the signal is emitted. \n\ minRepeatInterval : int, optional \n\ If > 0, the same signal only invokes a slot once within the given interval (in ms). \n\ Default: 0 (all signals will invoke the callable python method. \n\ \n\ See Also \n\ --------- \n\ disconnect, info")
	PyDoc_STRVAR (PyDataIOPlugin_disconnect_doc,"disconnect(signalSignature, callableMethod) \n\ \n\ Disconnects a connection which must have been established before with exactly the same parameters.\n\ \n\ Parameters \n\ ----------- \n\ signalSignature : str \n\ This must be the valid signature, known from the Qt-method *connect* \n\ (e.g. ``clicked(bool)``) \n\ callableMethod : callable \n\ valid method or function, that should not be called any more if the \n\ given signal is emitted. \n\ \n\ See Also \n\ --------- \n\ connect, info")
	PyDoc_STRVAR (PyDataIOPlugin_getType_doc,"getType() -> int \n\ \n\ Returns the type value of this specific dataIO plugin. \n\ \n\ Possible values are: \n\ \n\ * ``0x081``: a camera or general grabber device \n\ * ``0x101``: a analog-digital converter device \n\ * ``0x201``: any other kind of device (e.g. data transfer, like serial ports, \n\ USB ports, ... but also other devices like a power supply...). \n\ \n\ Returns \n\ ------- \n\ int \n\ dataIO type indentifier.")
	PyDoc_STRVAR (PyDataIOPlugin_info_doc,"info(verbose = 0) \n\ \n\ Prints out information about signal and callable slots of this actuator.\n\ \n\ Parameters \n\ ----------- \n\ verbose : int \n\ 0: only slots and signals from the plugin class are printed (default) \n\ 1: all slots and signals from all inherited classes are printed\n\ \n\ See Also \n\ -------- \n\ connect, disconnect")
	PyDoc_STRVAR (PyProgressObserver_doc,"progressObserver(progressBar = None, label = None, progressMinimum = 0, progressMaximum = 100) -> progressObserver \n\ \n\ Creates a progressObserver object. \n\ \n\ A :class:`progressObserver` object can be passed to functions, that might need some \n\ time to be finished, such that these functions can regularily report their current \n\ progress (as number as well as text) via this progress observer. These reported progress \n\ values are then displayed in the passed ``progressBar`` and / or ``label``. \n\ For more information see also this section: :ref:`filter_interruptible`. \n\ \n\ Target functions, that can make use of this :class:`progressObserver` can be contained in \n\ itom algorithm plugins. However these functions must implement the **FilterDefExt** \n\ interface, which is available from itom 3.3 on. Check the method :py:meth:`itom.filterHelp` \n\ or the help widget of itom in order to find out whether a filter \n\ in an algorithm plugin has this ability. \n\ \n\ If a filter accepts a :class:`progressObserver`, pass this object to the keyword \n\ argument ``_observe`` of the method :py:meth:`itom.filter`. Algorithms, that accept \n\ this kind of observer can also use the same observer to interrupt the algorithm once \n\ the additional interrupt flag of the observer is set. This flag is either set whenever \n\ a Python script execution is interrupted or if a signal of a widget has been emitted that \n\ was previously connected to this interrupt flag using the method \n\ :py:meth:`~itom.uiItem.invokeProgressObserverCancellation`. \n\ \n\ Parameters \n\ ----------- \n\ progressBar : uiItem, optional \n\ This is an optional handle to a progress bar in any user interface. The minimum \n\ requirement is that the given widget has at least a slot 'setValue(int)', which \n\ is called once this progress observer reports a new progress value (bound between \n\ ``progressMinimum`` and ``progressMaximum``. \n\ label : uiItem, optional \n\ This argument is very similar to ``progressBar``, however it requires a handle to a label \n\ widget or any other widget that has a slot ``setText(QString)``. This slot is called \n\ whenever the target algorithm for this observer reports a new progress text. \n\ progressMinimum : int, optional \n\ Minimum progress value that should be used and reported by the target of this observer. \n\ progressMaximum : int, optional \n\ Maximum progress value that should be used and reported by the target of this observer. \n\ \n\ Notes \n\ -------- \n\ This class wraps the C++ class `ito::FunctionCancellationAndObserver`.")
	PyDoc_STRVAR (progressObserver_getProgressMinimum_doc,"int : Gets the minimum value of the progress. \n\ \n\ The minimum progress value is the minimum scalar value that the observed \n\ function or algorithm should set as its lowest progress value.")
	PyDoc_STRVAR (progressObserver_getProgressMaximum_doc,"int : Gets the maximum value of the progress. \n\ \n\ The maximum progress value is the maximum scalar value that the observed \n\ function or algorithm should set as its highest progress value.")
	PyDoc_STRVAR (progressObserver_progressValue_doc,"int : gets or sets the current progress value.\n\ \n\ If the current progress value is set, the signal ``progressValueChanged(int)`` \n\ is emitted. It can for instance be connected to a ``setValue`` slot of a \n\ `QProgressBar`. The ``progressValue`` will be clipped to ``progressMinimum`` \n\ and ``progressMaximum``.")
	PyDoc_STRVAR (progressObserver_progressText_doc,"str : the current progress text\n\ \n\ This attribute gives access to the current progress text.\n\ When set, the signal ``progressTextChanged`` is emitted. It can for instance be\n\ connected to a ``setText`` slot of a `QLabel`. The text should inform about \n\ the step, the long-running method is currently executing.")
	PyDoc_STRVAR (progressObserver_isCancelled_doc,"bool : returns ``True`` if a cancellation request has been signalled, otherwise ``False``.")
	PyDoc_STRVAR (progressObserver_requestCancellation_doc,"requestCancellation() \n\ \n\ Requests the cancellation of the filter.\n\ \n\ If this :class:`progressObserver` is currently passed to an object, filter or \n\ algorithm, that can be cancelled, a cancellation request is sent to this object. \n\ Calling this method will emit the ``cancellationRequested()`` signal.")
	PyDoc_STRVAR (progressObserver_reset_doc,"reset() \n\ \n\ Resets this object. \n\ \n\ Resets this object and empties the current progress text, resets the current \n\ progress value to its minimum and resets the cancellation request. \n\ Emits the ``resetDone`` signal.")
	PyDoc_STRVAR (progressObserver_connect_doc,"connect(signalSignature, callableMethod, minRepeatInterval = 0)\n\ \n\ Connects the signal of the progressObserver with the given callable Python method. \n\ \n\ This object of :class:`progressObserver` wraps an underlying object of the C++ class \n\ ``ito::FunctionCancellationAndObserver``, which can emit various signals. Use this \n\ method to connect any signal to any callable python method (bounded or unbounded). This \n\ method must have the same number of arguments than the signal and the types of the \n\ signal definition must be convertable into a python object. \n\ \n\ Possible signals are (among others): \n\ \n\ * progressTextChanged(QString) -> emitted when the observed function reports a new progress text, \n\ * progressValueChanged(int) -> emitted whenever the observed function reports a new progress value, \n\ * cancellationRequested() -> emitted if a cancellation of the observed function has been requested, \n\ * resetDone() -> emitted if the progressObserver has been reset. \n\ \n\ New in itom 4.1. \n\ \n\ Parameters \n\ ----------- \n\ signalSignature : str \n\ This must be the valid signature. Possible signatures are: \n\ ``progressTextChanged(QString)`` or ``progressValueChanged(int)``\n\ callableMethod : callable \n\ Valid method or function that is called if the signal is emitted. The method must \n\ provide one parameter for the string or number argument of the signal. \n\ minRepeatInterval : int, optional \n\ If > 0, the same signal only invokes a slot once within the given interval (in ms). \n\ Default: 0 (all signals will invoke the callable Python method. \n\ \n\ See Also \n\ --------- \n\ disconnect")
	PyDoc_STRVAR (progressObserver_disconnect_doc,"disconnect(signalSignature, callableMethod) \n\ \n\ Disconnects a connection which must have been established with exactly the same parameters.\n\ \n\ New in itom 4.1. \n\ \n\ Parameters \n\ ----------- \n\ signalSignature : str \n\ This must be the valid signature (``progressTextChanged(QString)`` or ``progressValueChanged(int)``)\n\ callableMethod : callable \n\ valid method or function, that should not be called any more, if the given signal is \n\ emitted. \n\ \n\ See Also \n\ --------- \n\ connect")
	PyDoc_STRVAR (progressObserver_info_doc,"info(verbose = 0) \n\ \n\ Prints information about possible signals to the command line.\n\ \n\ Parameters \n\ ----------- \n\ verbose : int \n\ 0: only signals from the plugin class are printed (default) \n\ 1: all signals from all inherited classes are printed")
void	safeDecrefPyObject (PyObject *obj)
	PyDoc_STRVAR (pyRegion_doc,"region() -> region \\\n\ region(otherRegion) -> region \\\n\ region(x, y, w, h, type = region.RECTANGLE) -> region \n\ \n\ Creates a rectangular or elliptical region. \n\ \n\ This class is a wrapper for the class ``QRegion`` of `Qt`. It provides possibilities for \n\ creating pixel-based regions. Furtherone you can calculate new regions based on the \n\ intersection, union or subtraction of other regions. Based on the region it is \n\ possible to get a uint8 masked dataObject, where every point within the entire \n\ region has the value 255 and all other values 0 \n\ \n\ If the constructor is called without argument, an empty region is created. \n\ \n\ Parameters \n\ ----------- \n\ otherRegion : region \n\ Pass this object of :class:`region` to create a copied object of it. \n\ x : int\n\ x-coordinate of the reference corner of the region \n\ y : int\n\ y-coordinate of the reference corner of the region \n\ w : int\n\ width of the region \n\ h : int\n\ height of the region \n\ type : int, optional \n\ ``region.RECTANGLE`` creates a rectangular region (default). \n\ ``region.ELLIPSE`` creates an elliptical region, which is placed inside of the \n\ given boundaries.")
	PyDoc_STRVAR (pyRegionContains_doc,"contains(x, y, w = -1, h = -1) -> bool \n\ \n\ This method returns True, if the given point (x,y) or rectangle (x,y,w,h) is fully \n\ contained in this region. Otherwise returns False.\n\ \n\ Parameters \n\ ----------- \n\ x : int \n\ x-coordinate of one corner of the new rectangular region \n\ y : int \n\ y-coordinate of one corner of the new rectangular region \n\ w : int, optional \n\ width of the new rectangular region. If not given, point is assumed. \n\ h : int, optional \n\ height of the new rectangular region. If not given, point is assumed.\n\ \n\ Returns \n\ -------- \n\ bool \n\ True if point or rectangle is contained in region, otherwise False.")
	PyDoc_STRVAR (pyRegionIntersected_doc,"intersected(x, y, w, h) -> region \\\n\ intersected(region) -> region \n\ \n\ Returns a new region which is the intersection of the given region and this region. \n\ \n\ The intersection only contains points that are part of both regions. \n\ The given region can either by a :class:`region` object or a rectangular \n\ region, defined by its corner points (``x``, ``y``) and its width ``w`` \n\ and height ``h``. \n\ \n\ Parameters \n\ ----------- \n\ x : int \n\ x-coordinate of one corner of the new rectangular region \n\ y : int \n\ y-coordinate of one corner of the new rectangular region \n\ w : int \n\ width of the new rectangular region \n\ h : int \n\ height of the new rectangular region \n\ region : region \n\ another instance of region \n\ \n\ Returns \n\ ------- \n\ region \n\ new intersected region.")
	PyDoc_STRVAR (pyRegionIntersects_doc,"intersects(x, y, w, h) -> bool \\\n\ intersects(region) -> bool \n\ \n\ Returns True if this region intersects with the given region, otherwise False. \n\ \n\ The given region can either by a :class:`region` object or a rectangular \n\ region, defined by its corner points (``x``, ``y``) and its width ``w`` \n\ and height ``h``. \n\ \n\ Parameters \n\ ----------- \n\ x : int \n\ x-coordinate of one corner of the new rectangular region \n\ y : int \n\ y-coordinate of one corner of the new rectangular region \n\ w : int \n\ width of the new rectangular region \n\ h : int \n\ height of the new rectangular region \n\ region : region \n\ another instance of region \n\ \n\ Returns \n\ ------- \n\ bool \n\ True if both regions intersect, otherwise False.")
	PyDoc_STRVAR (pyRegionSubtracted_doc,"subtracted(x, y, w, h) -> region \\\n\ subtracted(region) -> region \n\ \n\ This method returns a new region, which is the given, new region subtracted from this region. \n\ \n\ The given region can either by a :class:`region` object or a rectangular \n\ region, defined by its corner points (``x``, ``y``) and its width ``w`` \n\ and height ``h``. \n\ \n\ Parameters \n\ ----------- \n\ x : int \n\ x-coordinate of one corner of the new rectangular region \n\ y : int \n\ y-coordinate of one corner of the new rectangular region \n\ w : int \n\ width of the new rectangular region \n\ h : int \n\ height of the new rectangular region \n\ region : region \n\ another instance of region \n\ \n\ Returns \n\ ------- \n\ region \n\ new, subtraced region.")
	PyDoc_STRVAR (pyRegionTranslate_doc,"translate(x, y)\n\ \n\ This method translates this region by the given translation values. \n\ \n\ Parameters \n\ ----------- \n\ x : int \n\ translation in x-direction \n\ y : int \n\ translation in y-direction \n\ \n\ See Also \n\ --------- \n\ translated")
	PyDoc_STRVAR (pyRegionTranslated_doc,"translated(x, y) -> region\n\ \n\ This method returns a new region, which is translated by the given distances in x and y direction. \n\ \n\ Parameters \n\ ----------- \n\ x : int \n\ translation in x-direction \n\ y : int \n\ translation in y-direction \n\ \n\ Returns \n\ ------- \n\ region \n\ new translated region.\n\ \n\ See Also \n\ --------- \n\ translate")
	PyDoc_STRVAR (pyRegionUnited_doc,"united(x, y, w, h) -> region \\\n\ united(region) -> region \n\ \n\ returns a region which is the union of the given region with this region. \n\ \n\ This method returns a new region, which is the union of this region with the given region. \n\ The union contains all areas, that are contained in any of both regions. \n\ \n\ The given region can either by a :class:`region` object or a rectangular \n\ region, defined by its corner points (``x``, ``y``) and its width ``w`` \n\ and height ``h``. \n\ \n\ Parameters \n\ ----------- \n\ x : int \n\ x-coordinate of one corner of a rectangular region \n\ y : int \n\ y-coordinate of one corner of a rectangular region \n\ w : int \n\ width of the new rectangular region \n\ h : int \n\ height of the new rectangular region \n\ region : region \n\ another instance of region \n\ \n\ Returns \n\ ------- \n\ region \n\ new united region.")
	PyDoc_STRVAR (pyRegionXored_doc,"xored(x, y, w, h) -> region \\\n\ xored(region) -> region \n\ \n\ returns a region which is an xor combination of the given region with this region. \n\ \n\ This method returns a new region, which is defined by an xor-combination of this \n\ region with the given region. \n\ \n\ The given region can either by a :class:`region` object or a rectangular \n\ region, defined by its corner points (``x``, ``y``) and its width ``w`` \n\ and height ``h``. \n\ \n\ Parameters \n\ ----------- \n\ x : int \n\ x-coordinate of one corner of a rectangular region \n\ y : int \n\ y-coordinate of one corner of a rectangular region \n\ w : int \n\ width of the new rectangular region \n\ h : int \n\ height of the new rectangular region \n\ region : region \n\ another instance of region \n\ \n\ Returns \n\ ------- \n\ region \n\ new xored region.")
	PyDoc_STRVAR (pyRegion_getEmpty_doc,"bool: Returns True if this region is empty, otherwise False")
	PyDoc_STRVAR (pyRegion_getRectCount_doc,"int: Returns the number of rectangles in this region")
	PyDoc_STRVAR (pyRegion_getRects_doc,"list of list of int: Returns list of rectangles, whose union defines this region. \n\ \n\ Each rectangle is given by a list of (x, y, width, height).")
	PyDoc_STRVAR (pyRegion_getBoundingRect_doc,"list of int or None: Returns the bounding rectangle of this region or None if it is empty. \n\ \n\ The bounding rectangle is given by a list (x, y, width, height).")
	PyDoc_STRVAR (pyRegionCreateMask_doc,"createMask(boundingRegion = None) -> dataObject \n\ \n\ Returns a :class:`~itom.dataObject` with dtype ``uint8`` whose shape corresponds to the \n\ width and height of the bounding rectangle. All pixels contained in the region have a \n\ value of ``255`` while the rest is set to ``0``. The offset value of the dataObject is \n\ set such that it fits to the real position of the region, since the first element \n\ in the dataObject corresponds to the left upper corner of the bounding rectangle.\n\ \n\ Indicate a ``boundingRegion`` in order to increase the size of the returned data object. \n\ Its size will have the size of the union between the boundingRegion and the region.\n\ \n\ Parameters \n\ ----------- \n\ boundingRegion : region, optional\n\ If a :class:`region` object is given, the shape of the returned :class:`dataObject`\n\ is the maximum (union) between this ``boundingRegion`` and this region. \n\ \n\ Returns \n\ ------- \n\ mask : dataObject")
	PyDoc_STRVAR (rgbaInit_doc,"rgba(r, g, b, alpha=255) -> rgba \n\ \n\ Color value object (RGB + optional alpha channel). \n\ \n\ Creates a new color value from red, green, blue and optional alpha. \n\ If any value > 255 is passed as argument, its modulo with ``256`` is taken instead. \n\ \n\ The :class:`rgba` object implements many methods of the number protocol, \n\ such that it becomes possible to add, subtract, multiply... two colors. In most \n\ cases these operations are executed for each color component independently. \n\ \n\ Parameters \n\ ----------- \n\ r : int \n\ red component [0,255]. \n\ g : int \n\ green component [0,255]. \n\ b : int \n\ blue component [0,255]. \n\ alpha : int, optional \n\ alpha component [0,255], default: 255 (opaque). \n\ \n\ Notes \n\ ------ \n\ \n\ For a gray value set all colors to the same value.")
	PyDoc_STRVAR (PyRgba_name_doc,"name() -> str \n\ \n\ Returns the name of this object (``rgba``).")
	PyDoc_STRVAR (PyRgba_toGray_doc,"toGray() -> float \n\ \n\ returns the gray value from the color (alpha is not considered) \n\ \n\ Returns \n\ ------- \n\ float : \n\ The returned gray value is a float value and calculated by \n\ ``0.299 * r + 0.587 * g + 0.114 * b`` ")
	PyDoc_STRVAR (PyRgba_red_doc,"int : red component of this color [0, 255].")
	PyDoc_STRVAR (PyRgba_green_doc,"int : red component of this color [0, 255].")
	PyDoc_STRVAR (PyRgba_blue_doc,"int : blue component of this color [0, 255].")
	PyDoc_STRVAR (PyRgba_alpha_doc,"int : alpha (transparency) component of this color [0, 255].")
	PyDoc_STRVAR (PyShape_doc,"shape(type = shape.Invalid, param1 = None, param2 = None, index = -1, name = \"\") -> shape \n\ \n\ Creates a shape object of a specific type. \n\ \n\ A shape object is used to describe a vectorized object, that can for instance be displayed \n\ in plots or might also be passed to different methods, e.g. in order to define a masked \n\ area etc. A :class:`shape` object can also be converted into a :class:`region` object, \n\ however the vector information is then projected onto a raster with a given resolution. \n\ \n\ Depending on the ``type``, the following arguments are allowed, where the first \n\ argument must be given to ``param1`` and the 2nd one to ``param2``: \n\ \n\ * ``shape.Invalid``: - \n\ * ``shape.Point``: point \n\ * ``shape.Line``: start-point, end-point \n\ * ``shape.Rectangle``: top left point, bottom right point \n\ * ``shape.Square``: center point, side-length \n\ * ``shape.Ellipse``: top left point, bottom right point of bounding box \n\ * ``shape.Circle``: center point, radius \n\ * ``shape.Polygon``: 2xM float64 array with M points of polygon \n\ \n\ The parameters ``point``, ``start-point``, ... can be all array-like types (e.g. :class:`dataObject`,\n\ :obj:`list`, :obj:`tuple`, :obj:`np.ndarray`) that can be mapped to float64 and have two elements. \n\ \n\ Another possibility to create a :class:`shape` object for a certain type is to use \n\ one of the following static creation functions: \n\ \n\ * :meth:`createPoint` \n\ * :meth:`createLine` \n\ * :meth:`createCircle` \n\ * :meth:`createEllipse` \n\ * :meth:`createSquare` \n\ * :meth:`createRectangle` \n\ * :meth:`createPolygon` \n\ \n\ During construction, all shapes are aligned with respect to the x- and y-axis. Set a \n\ 2d transformation (attribute :attr:`transform`) to rotate and move it. \n\ \n\ Parameters \n\ ---------- \n\ type : int \n\ Type of the shape (see list above). \n\ param1 : list of float or tuple of float or dataObject or numpy.ndarray, optional \n\ 1st initialization argument. This argument is depending on the ``type`` (see list above). \n\ param2 : list of float or tuple of float or dataObject or numpy.ndarray, optional \n\ 2nd initialization argument. This argument is depending on the ``type`` (see list above). \n\ index : int \n\ index of the shape, or ``-1`` if not further specified (default). \n\ name : str \n\ name of the shape, can for instance be displayed next to shapes in plots \n\ (depending on the parameterization of the plot).")
	PyDoc_STRVAR (shape_staticPoint_doc,"createPoint(point, index = -1, name = '', flags = 0) -> shape \n\ \n\ Returns a new shape object of type ``shape.Point``.\n\ \n\ This static method is equal to the command:: \n\ \n\ myShape = shape(shape.Point, point, index, name)\n\ myShape.flags = flags # optional\n\ \n\ Parameters \n\ -----------\n\ point : sequence of float or dataObject or numpy.ndarray \n\ (x,y) coordinate of the point, given as any type that can be interpreted as \n\ array with two float64 values. \n\ index : int, optional \n\ index of this shape or -1 (default) if not further specified. \n\ name : str, optional \n\ optional name of this shape (default: \"\"). This name can for instance be \n\ displayed in a plot. \n\ flags : int, optional \n\ if the user should not be able to rotate, resize and / or move this shape in any \n\ plot canvas, then pass an or-combination of the restricitive flag values \n\ ``shape.ResizeLock``, ``shape.RotateLock`` or ``shape.MoveLock``. \n\ \n\ Returns \n\ ------- \n\ shape \n\ The new shape object.")
	PyDoc_STRVAR (shape_staticLine_doc,"createLine(point1, point2, index = -1, name = \"\", flags = 0) -> shape \n\ \n\ Returns a new shape object of type ``shape.Line``.\n\ \n\ This static method is equal to the command:: \n\ \n\ myShape = shape(shape.Line, point1, point2, index, name)\n\ myShape.flags = flags #optional\n\ \n\ Parameters \n\ -----------\n\ point1 : sequence of float or dataObject or numpy.ndarray \n\ (x,y) coordinate of the first point, given as any type that can be interpreted as \n\ array with two values \n\ point2 : sequence of float or dataObject or numpy.ndarray \n\ (x,y) coordinate of the 2nd point, given as any type that can be interpreted as \n\ array with two values \n\ index : int, optional \n\ index of this shape or -1 (default) if not further specified. \n\ name : str, optional \n\ optional name of this shape (default: \"\"). This name can for instance be \n\ displayed in a plot. \n\ flags : int, optional \n\ if the user should not be able to rotate, resize and / or move this shape in any \n\ plot canvas, then pass an or-combination of the restricitive flag values \n\ ``shape.ResizeLock``, ``shape.RotateLock`` or ``shape.MoveLock``. \n\ \n\ Returns \n\ ------- \n\ shape \n\ The new shape object.")
	PyDoc_STRVAR (shape_staticCircle_doc,"createCircle(center, radius, index = -1, name = '', flags = 0) -> shape \n\ \n\ Returns a new shape object of type ``shape.Circle``.\n\ \n\ This static method is equal to the command:: \n\ \n\ myShape = shape(shape.Circle, center, radius, index, name)\n\ myShape.flags = flags #optional\n\ \n\ Parameters \n\ -----------\n\ center : sequence of float or dataObject or numpy.ndarray \n\ (x,y) coordinate of the center point, given as any type that can be interpreted \n\ as array with two values \n\ radius : float \n\ radius of the circle \n\ index : int, optional \n\ index of this shape or -1 (default) if not further specified. \n\ name : str, optional \n\ optional name of this shape (default: \"\"). This name can for instance be \n\ displayed in a plot. \n\ flags : int, optional \n\ if the user should not be able to rotate, resize and / or move this shape in any \n\ plot canvas, then pass an or-combination of the restricitive flag values \n\ ``shape.ResizeLock``, ``shape.RotateLock`` or ``shape.MoveLock``. \n\ \n\ Returns \n\ ------- \n\ shape \n\ The new shape object.")
	PyDoc_STRVAR (shape_staticEllipse_doc,"createEllipse(corner1 = None, corner2 = None, center = None, size = None, index = -1, name = \"\", flags = 0) -> shape \n\ \n\ Returns a new shape object of type ``shape.Ellipse``.\n\ \n\ Basically, there are two different ways to construct the ellipse: \n\ Either by the top left and bottom right corner points of the outer bounding box (``corner1`` \n\ and ``corner2``), or by the ``center`` point (x,y) and the ``size``, as array of (width, height). \n\ \n\ Furthermore, you can indicate a ``size`` together with ``corner1`` OR ``corner2``, \n\ where corner1.x + width = corner2.x and corner1.y + height = corner2.y. \n\ \n\ This static method is equal to the command:: \n\ \n\ myShape = shape(shape.Ellipse, corner1, corner2, index, name)\n\ myShape.flags = flags #optional\n\ \n\ Parameters \n\ -----------\n\ corner1 : sequence of float or dataObject or numpy.ndarray, optional \n\ (x,y) coordinate of the top, left corner point of the bounding box, given as \n\ any type that can be interpreted as array with two values \n\ corner2 : sequence of float or dataObject or numpy.ndarray, optional \n\ (x,y) coordinate of the bottom, right corner point of the bounding box, given as \n\ any type that can be interpreted as array with two values \n\ center : sequence of float or dataObject or numpy.ndarray, optional \n\ (x,y) coordinate of the center point, given as any type that can be interpreted \n\ as array with two values \n\ size : sequence of float or dataObject or numpy.ndarray, optional \n\ (width, height) of the rectangle, given as any type that can be interpreted as array \n\ with two values \n\ index : int, optional \n\ index of this shape or -1 (default) if not further specified. \n\ name : str, optional \n\ optional name of this shape (default: \"\"). This name can for instance be \n\ displayed in a plot. \n\ flags : int, optional \n\ if the user should not be able to rotate, resize and / or move this shape in any \n\ plot canvas, then pass an or-combination of the restricitive flag values \n\ ``shape.ResizeLock``, ``shape.RotateLock`` or ``shape.MoveLock``. \n\ \n\ Returns \n\ ------- \n\ shape \n\ The new shape object.")
	PyDoc_STRVAR (shape_staticSquare_doc,"createSquare(center, sideLength, index = -1, name = \"\", flags = 0) -> shape \n\ \n\ Returns a new shape object of type ``shape.Square``.\n\ \n\ This static method is equal to the command:: \n\ \n\ myShape = shape(shape.Square, center, sideLength, index, name)\n\ myShape.flags = flags #optional\n\ \n\ Parameters \n\ -----------\n\ center : sequence of float or dataObject or numpy.ndarray \n\ (x,y) coordinate of the center point, given as any type that can be interpreted \n\ as array with two values \n\ sideLength : float \n\ side length of the square \n\ index : int, optional \n\ index of this shape or -1 (default) if not further specified. \n\ name : str, optional \n\ optional name of this shape (default: \"\"). This name can for instance be \n\ displayed in a plot. \n\ flags : int, optional \n\ if the user should not be able to rotate, resize and / or move this shape in any \n\ plot canvas, then pass an or-combination of the restricitive flag values \n\ ``shape.ResizeLock``, ``shape.RotateLock`` or ``shape.MoveLock``. \n\ \n\ Returns \n\ ------- \n\ shape \n\ The new shape object.")
	PyDoc_STRVAR (shape_staticRectangle_doc,"createRectangle(corner1 = None, corner2 = None, center = None, size = None, index = -1, name = \"\", flags = 0) -> shape \n\ \n\ Returns a new shape object of type ``shape.Rectangle``.\n\ \n\ Basically, there are two different ways to construct a rectangle: \n\ Either by the top left and bottom right corner points (``corner1`` and ``corner2``), \n\ or by the ``center`` point (x, y) and the ``size``, as array of (width, height). \n\ \n\ Furthermore, you can indicate a ``size`` together with ``corner1`` OR ``corner2``, \n\ where corner1.x + width = corner2.x and corner1.y + height = corner2.y. \n\ \n\ This static method is equal to the command:: \n\ \n\ myShape = shape(shape.Rectangle, corner1, corner2, index, name)\n\ myShape.flags = flags #optional\n\ \n\ Parameters \n\ -----------\n\ corner1 : sequence of float or dataObject or numpy.ndarray, optional \n\ (x,y) coordinate of the top, left corner point, given as any type that can be \n\ interpreted as array with two values \n\ corner2 : sequence of float or dataObject or numpy.ndarray, optional \n\ (x,y) coordinate of the bottom, right corner point, given as any type that can be \n\ interpreted as array with two values \n\ center : sequence of float or dataObject or numpy.ndarray, optional \n\ (x,y) coordinate of the center point, given as any type that can be interpreted \n\ as array with two values \n\ size : sequence of float or dataObject or numpy.ndarray, optional \n\ (width, height) of the rectangle, given as any type that can be interpreted as array \n\ with two values \n\ index : int, optional \n\ index of this shape or -1 (default) if not further specified. \n\ name : str, optional \n\ optional name of this shape (default: \"\"). This name can for instance be \n\ displayed in a plot. \n\ flags : int, optional \n\ if the user should not be able to rotate, resize and / or move this shape in any \n\ plot canvas, then pass an or-combination of the restricitive flag values \n\ ``shape.ResizeLock``, ``shape.RotateLock`` or ``shape.MoveLock``. \n\ \n\ Returns \n\ ------- \n\ shape \n\ The new shape object.")
	PyDoc_STRVAR (shape_staticPolygon_doc,"createPolygon(points, index = -1, name = \"\", flags = 0) -> shape \n\ \n\ Returns a new shape object of type ``shape.Polygon``.\n\ \n\ This static method is equal to the command:: \n\ \n\ myShape = shape(shape.Polygon, points, index, name)\n\ myShape.flags = flags #optional\n\ \n\ Parameters \n\ -----------\n\ points : sequence of sequence of float or dataObject or numpy.ndarray \n\ An array-like object of shape ``2 x M`` (with M > 2), that can be converted \n\ to float64. This object defines ``M`` points for the polygon (order: x, y). \n\ If a sequence is given, it must look like this:: \n\ \n\ points = ((1, 2, 3), (4, 5, 6)) \n\ \n\ where the first inner tuple defines the x-coordinates, and the 2nd tuple \n\ the y-coordinates. \n\ index : int, optional \n\ index of this shape or -1 (default) if not further specified. \n\ name : str, optional \n\ optional name of this shape (default: \"\"). This name can for instance be \n\ displayed in a plot. \n\ flags : int, optional \n\ if the user should not be able to rotate, resize and / or move this shape in any \n\ plot canvas, then pass an or-combination of the restricitive flag values \n\ ``shape.ResizeLock``, ``shape.RotateLock`` or ``shape.MoveLock``. \n\ \n\ Returns \n\ ------- \n\ shape \n\ The new shape object.")
	PyDoc_STRVAR (shape_getType_doc,"int : Get the type of this shape. \n\ \n\ Possible types are: \n\ \n\ * ``shape.Line`` \n\ * ``shape.Point`` \n\ * ``shape.Rectangle`` \n\ * ``shape.Ellipse`` \n\ * ``shape.Circle`` \n\ * ``shape.Square``")
	PyDoc_STRVAR (shape_getValid_doc,"bool : Returns True if this shape is valid, otherwise False. \n\ \n\ An invalid shape is the one constructed with the type ``shape.Invalid``. All other \n\ shapes are valid.")
	PyDoc_STRVAR (shape_getFlags_doc,"int : Gets or sets a flag (bitmask) that define denied manipulation of this shape. \n\ \n\ It is possible to deny the following manipulations: \n\ \n\ * ``shape.MoveLock`` \n\ * `` shape.RotateLock`` \n\ * `` shape.ResizeLock``")
	PyDoc_STRVAR (shape_point1_doc,"tuple of float : Gets or sets the 1st point of the bounding box of this shape. \n\ \n\ The first point is the first point of a ``shape.Point`` or ``shape.Line`` or \n\ the upper left point of the bounding box of a ``shape.Rectangle``, ``shape.Square`` \n\ ``shape.Ellipse`` or ``shape.Circle``. The point always considers a possible 2D \n\ coordinate transformation matrix.\n\ \n\ For setting this value, it is also possible to pass any other array-like object \n\ with two elements, that can be converted to float64. \n\ \n\ Raises \n\ ------ \n\ TypeError \n\ if this attribute is read or assigned for a type, that has no 2nd point defined.")
	PyDoc_STRVAR (shape_point2_doc,"tuple of float : Gets or sets the second point of the bounding box of this shape. \n\ \n\ The second point is the 2nd point of a ``shape.Line`` or the bottom right point of \n\ the bounding box (types: ``shape.Rectangle``, ``shape.Square``, ``shape.Ellipse`` or \n\ ``shape.Circle``). The point always considers a possible 2D coordinate \n\ transformation matrix.\n\ \n\ For setting this value, it is also possible to pass any other array-like object \n\ with two elements, that can be converted to float64. \n\ \n\ Raises \n\ ------ \n\ TypeError \n\ if this attribute is read or assigned for a type, that has no 2nd point defined.")
	PyDoc_STRVAR (shape_center_doc,"tuple of float : Gets or sets the center point of this shape. \n\ \n\ The center point is defined for all types of shapes, beside ``shape.Polygon``. \n\ Changing the center point will directly influence the base points of the shape. \n\ \n\ If the value is set, it is also possible to pass any other array-like object with \n\ two values that can be converted to float64. \n\ \n\ Raises \n\ ------ \n\ TypeError \n\ if this attribute is read or assigned for a type, that has no center defined.")
	PyDoc_STRVAR (shape_angleDeg_doc,"float : Gets or sets the current angle of rotation of the transformation matrix in degree. \n\ \n\ A rotation is always defined counter-clockwise.")
	PyDoc_STRVAR (shape_angleRad_doc,"float : Gets or sets the current angle of rotation of the transformation matrix in Radians. \n\ \n\ A rotation is always defined counter-clockwise.")
	PyDoc_STRVAR (shape_radius_doc,"float or tuple of float : Gets or sets the radius of this shape. \n\ \n\ A radius can only be set for shapes of type ``shape.Circle`` or ``shape.Ellipse``. \n\ For a circle, the radius is a scalar float value. For an ellipse, a tuple of \n\ two values ``(a, b)`` define the half side-length in x- and y-direction of \n\ the base coordinate system.\n\ \n\ Raises \n\ ------ \n\ TypeError \n\ if this attribute is read or assigned for a type, that has no radius defined.")
	PyDoc_STRVAR (shape_width_doc,"float : Gets or sets the width of this shape. \n\ \n\ A width can only be set or read for shapes of type ``shape.Square`` and \n\ ``shape.Rectangle``. \n\ \n\ Raises \n\ ------ \n\ TypeError \n\ if this attribute is read or assigned for a type, that has no width defined.")
	PyDoc_STRVAR (shape_height_doc,"float : Gets or sets the height of this shape. \n\ \n\ A height can only be set or read for shapes of type ``shape.Square`` and \n\ ``shape.Rectangle``. \n\ \n\ Raises \n\ ------ \n\ TypeError \n\ if this attribute is read or assigned for a type, that has no height defined.")
	PyDoc_STRVAR (shape_getIndex_doc,"int : Gets or sets the index of this shape. \n\ \n\ The default is -1, however if the shape is a geometric shape of a plot, an \n\ auto-incremented index is assigned once the shape is drawn or set. \n\ If >= 0 it is possible to modify an existing shape with the same index.")
	PyDoc_STRVAR (shape_getName_doc,"str : Gets or sets the name (label) of this shape.")
	PyDoc_STRVAR (shape_getColor_doc,"None or rgba : Gets or sets color of this shape. \n\ \n\ The default color is an invalid color, given by the ``None`` value. \n\ The color of shapes is for instance be used for visualization purposes in plots.")
	PyDoc_STRVAR (shape_getTransform_doc,"dataObject : gets or sets the affine, non scaled 2D transformation matrix as dataObject. \n\ \n\ The returned matrix is a ``2 x 3``, float64 :class:`dataObject`, where the left \n\ ``2 x 2`` matrix describes a rotation matrix, and the right ``2 x 1`` part is the \n\ translation vector.")
	PyDoc_STRVAR (shape_getArea_doc,"float : Get area of this shape \n\ \n\ Shapes of type ``shape.Line`` and ``shape.Point`` will always return 0.0.")
	PyDoc_STRVAR (shape_rotateDeg_doc,"rotateDeg(angle) \n\ \n\ Rotate shape by given angle in radians around the center point of this shape \n\ (counterclockwise). This method only affects the :attr:`transform` matrix, not the \n\ base points themselfs. \n\ \n\ Parameters \n\ ----------- \n\ angle : float \n\ is the rotation angle (in radians) by which the shape is rotated by its center. \n\ \n\ See Also \n\ --------- \n\ translate, rotateRad")
	PyDoc_STRVAR (shape_rotateRad_doc,"rotateRad(angle) \n\ \n\ Rotate shape by given angle in radians around the center point of this shape \n\ (counterclockwise). This method only affects the :attr:`transform` matrix, not the \n\ base points themselfs. \n\ \n\ Parameters \n\ ----------- \n\ angle : float \n\ is the rotation angle (in radians) by which the shape is rotated by its center. \n\ \n\ See Also \n\ --------- \n\ translate, rotateDeg")
	PyDoc_STRVAR (shape_translate_doc,"translate(dxy) \n\ \n\ Translate shape by given (dx, dy) value. \n\ \n\ Moves the shape by dx and dy along the x- and y-axis of the base coordinate system. \n\ This means, that dx and dy are added to the existing tx and ty values of the current \n\ transformation matrix. \n\ \n\ Parameters \n\ ----------- \n\ dxy : sequence of float or dataObject or numpy.ndarray \n\ array-like object with two elements, that define the desired ``dx`` and ``dy`` \n\ component. \n\ \n\ See Also \n\ --------- \n\ rotateRad, rotateDeg")
	PyDoc_STRVAR (shape_basePoints_doc,"dataObject : base points of this shape, given as ``2 x M``, float64 dataObject. \n\ \n\ The ``M`` base points are untransformed points that describe the shape \n\ dependent on its type: \n\ \n\ * ``shape.Point``: one point \n\ * ``shape.Line`` : start point, end point \n\ * ``shape.Rectangle``, ``shape.Square`` : top left point, bottom right point \n\ * ``shape.Ellipse``, ``shape.Circle`` : top left point, bottom right point of bounding box \n\ * ``shape.Polygon`` : points of polygon, the last and first point are connected, too.")
	PyDoc_STRVAR (shape_region_doc,"region() -> region \n\ \n\ Returns a region object from this shape. \n\ \n\ The :class:`region` object only contains valid regions if the shape has an area > 0. \n\ A region object is an integer based object (pixel raster), therefore the shapes \n\ are rounded to the nearest fixed-point coordinate. \n\ \n\ Returns \n\ ------- \n\ region \n\ The region, whose contour approximates this shape. The inner of \n\ this shaped is part of the region.")
	PyDoc_STRVAR (shape_contour_doc,"contour(applyTrafo = True, tol = -1.0) -> dataObject \n\ \n\ Returns the contour points of this shape as ``2 x N``, float64 :class:`dataObject`. \n\ \n\ For most shapes, the contour is exactly given by its corner points. However for \n\ circles or ellipses, the contour has to be approximated by line segments. Use the \n\ argument ``tol`` to set the maximum distance between each line segment and the \n\ real contour of the shape. If ``tol`` is set to -1.0, ``tol`` is assumed to be `1 %` \n\ of the smalles diameter. \n\ \n\ Shapes can have a transformation matrix (attribute :attr:`transform`). If ``applyTrafo`` \n\ is ``True``, the returned contour points correspond to the transformed base shape, else \n\ the contour with respect to the base points is returned. \n\ \n\ Parameters \n\ ----------- \n\ applyTrafo : bool \n\ Define if the transformation matrix (default: unity matrix, attribute :attr:`transform`) \n\ should be considered for the returned contour points (``True``) or not (``False``). \n\ tol : float \n\ Maximum tolerance to determine the approximated contour in the case of circular \n\ or elliptical shapes. The approximated contour consists of line segments, that \n\ can differ from the real contour by a maximum of ``tol``. If -1.0, the tolerance \n\ is assumed to be one percent of the smallest diameter.")
	PyDoc_STRVAR (shape_contains_doc,"contains(points) -> Union[bool, dataObject] \n\ \n\ Checks if one or multiple ``points`` are contained in this shape. \n\ \n\ Tests if one or multiple ``points`` lie within the contour of the given shape. If the \n\ shape has an empty area (e.g. points, line...) the test will always return ``False``.\n\ \n\ Parameters \n\ ------------\n\ points : sequence of float or dataObject or numpy.ndarray \n\ The coordinates ``(x, y)`` of the point to be tested as sequence or an array-like \n\ object (shape ``2 x N``), where the first row contains the x-coordinates and the \n\ 2nd-row the y-coordinates of ``N`` points to be tested. The array-like object \n\ must be convertible to ``float64``, which is internally done before testing. \n\ \n\ Returns \n\ -------- \n\ result : bool or dataObject \n\ If one point is passed as sequence, ``True`` is returned if this point is within \n\ the contour of this shape, otherwise ``False``. If ``points`` is given as array-like \n\ object, a ``1 x N`` :class:`dataObject` with dtype ``uint8`` is returned, where \n\ the value ``255`` indicates, that the corresponding point is inside of the \n\ shape's contour and ``0`` outside.")
	PyDoc_STRVAR (shape_normalized_doc,"normalized() -> shape \n\ \n\ Returns the normalized version of this shape. \n\ \n\ The normalized shape guarantees that the bounding box of the shape never has a \n\ non-negative width or height. Therefore, the order or position of the two corner points \n\ (base points) is switched or changed, if necessary. Shapes different than \n\ rectangles, squares, circles or ellipses are not affected by this such that the \n\ original shape object is returned as it is. \n\ \n\ Returns \n\ ------- \n\ normalized : shape \n\ The normalized shape of this object (for types ``shape.Rectange``, ``shape.Square`` \n\ ``shape.Circle`` or ``shape.Ellipse``) or this object (for all other types).")
	PyDoc_STRVAR (shape_copy_doc,"copy() -> shape\n\ \n\ Returns a deep copy of this shape. \n\ \n\ Returns \n\ ------- \n\ copy : shape \n\ deep copy of this shape.")
void	safeDecrefPyObject2 (PyObject *obj)
	PyDoc_STRVAR (PyUiItemInit_doc,"uiItem(objectID, objName, widgetClassName, parentObj = None) -> uiItem \\\n\ uiItem(parentObj, objName) -> uiItem \n\ \n\ Base class that represents any widget or layout of an user interface. \n\ \n\ This class represents any widget (graphical, interactive element like a button or \n\ checkbox) on a graphical user interface. An object of this class provides many \n\ functionalities given by the underlying Qt system. For instance, it is posible to \n\ call a public slot of the corresponding widget, connect signals to specific python \n\ methods or functions or change properties of the widget represeted by this object. \n\ \n\ The overall dialog or window as main element of a graphical user interface itself are \n\ instances of the class :class:`ui`. However, they are derived from :class:`uiItem`, \n\ since dialogs or windows internally are widgets as well. \n\ \n\ Widgets, placed at a user interface using the Qt Designer, can be referenced by an \n\ :class:`uiItem` object by their specific ``objectName``, assigned in the Qt Designer \n\ as well. As an example, a simple dialog with one button is created and the text of \n\ the button (objectName: btn) is set to OK: :: \n\ \n\ dialog = ui('filename.ui', type=ui.TYPEDIALOG) \n\ button = dialog.btn #here the reference to the button is obtained \n\ button[\"text\"] = \"OK\" #set the property text of the button \n\ \n\ Information about available properties, signals and slots can be obtained using the \n\ method :meth:`uiItem.info`. For more information about creating customized user \n\ interfaces, reference widgets and layouts etc, see the section :ref:`qtdesigner`. \n\ \n\ Parameters \n\ ---------- \n\ objectID : int \n\ is the itom internal identifier number for the widget or layout to be wrapped. \n\ objName : str \n\ is the ``objectName`` property of the wrapped widget or layout. \n\ widgetClassName : str \n\ is the Qt class name of the wrapped widget or layout (see :meth:`getClassName`). \n\ parentObj : uiItem \n\ is the parent :class:`uiItem` of this wrapped widget or layout. \n\ \n\ Returns \n\ ------- \n\ uiItem \n\ is the new :class:`uiItem` object that wraps the indicated widget or layout. \n\ \n\ Notes \n\ ------ \n\ It is not intended to directly instantiate this class. Either create a user interface \n\ using the class :class:`ui` or obtain a reference to an existing widget (this is then \n\ an instance of :class:`uiItem`) using the dot-operator of a parent widget or the entire \n\ user interface.")
	PyDoc_STRVAR (PyUiItemGetClassName_doc,"getClassName() -> str \n\ \n\ Returns the Qt class name of this uiItem (widget or layout). \n\ \n\ Every :class:`uiItem` wraps a widget or layout of the user interface. \n\ This method returns the class name of this item, as it is given by the \n\ Qt framework. \n\ \n\ New in itom 4.1. \n\ \n\ Returns \n\ ----------- \n\ className : str \n\ The class name of this :class:`uiItem`.")
	PyDoc_STRVAR (PyUiItemCall_doc,"call(publicSlotName, *args) \n\ \n\ Calls any public slot or other accessible public method of the widget or layout, referenced by this uiItem. \n\ \n\ This method calls a public or a 'wrapped' slot (see section :ref:`qtdesigner-wrappedslots`) \n\ of the widget or layout, that is referenced by this :class:`uiItem`. \n\ \n\ If only one slot with the given ``publicSlotName`` is available, all arguments ``*args`` \n\ are tried to be cast to the requested types and the slot is called then. If the \n\ designated slot has multiple possible overloads, at first, it is intended to find the \n\ overload where all arguments can be strictly cast from Python types to the indicated \n\ C-types. If this fails, the next overload with a successful, non-strict conversion is \n\ chosen. \n\ \n\ Information about all possible slots of this :class:`uiItem` can be obtained by the \n\ official Qt help or the method :meth:`uiItem.info`. \n\ \n\ Parameters \n\ ----------- \n\ publicSlotName : str \n\ name of the public slot or a specially wrapped slot of the widget or layout. \n\ *args : Any, optional\n\ Variable length argument list, that is passed to the called slot. The type of each \n\ value must be convertible to the requested C++ based argument type of the slot \n\ (see section :ref:`qtdesigner-datatypes`).\n\ \n\ See Also \n\ --------- \n\ info")
	PyDoc_STRVAR (PyUiItemConnect_doc,"connect(signalSignature, callableMethod, minRepeatInterval = 0) \n\ \n\ Connects a signal of this widget or layout with the given Python callback method. \n\ \n\ The widget or layout class, referenced by an :class:`uiItem` object, can emit \n\ different signals whenever a certain event occurs. See the official Qt help \n\ about a list of all possible signals or use the method :meth:`info` to get a \n\ print-out of a list of possible signals. This method is used to connect a certain \n\ callable Python callback method or function to a specific signal. The callable \n\ function can be bounded as well as unbounded. \n\ \n\ The connection is described by the string signature of the signal (hence the source of \n\ the connection). Such a signature is the name of the signal, followed by the types of \n\ its arguments (the original C++ types). An example is ``clicked(bool)``, \n\ emitted if a button has been clicked. This signal can be connected to a callback function \n\ with one argument, that will then contain the boolean click state of this signal. \n\ In case of a bounded method, the ``self`` argument must be given in any case. \n\ \n\ If the signal should have further arguments with specific datatypes, they are transformed \n\ into corresponding Python data types. A table of supported conversions is given in section \n\ :ref:`qtdesigner-datatypes`. In general, a ``callableMethod`` must be a method or \n\ function with the same number of parameters than the signal has (besides the \n\ ``self`` argument). \n\ \n\ If a signal is emitted very often, it can be necessary to limit the call of the callback \n\ function to a certain minimum time interval. This can be given by the ``minRepeatInterval`` \n\ parameter. \n\ \n\ Parameters \n\ ----------- \n\ signalSignature : str \n\ This must be the valid signature, known from the Qt-method *connect* \n\ (e.g. ``targetChanged(QVector<double>)``) \n\ callableMethod : callable \n\ valid method or function that is called if the signal is emitted. \n\ minRepeatInterval : int, optional \n\ If > 0, the same signal only invokes a slot once within the given interval (in ms). \n\ Default: 0 (all signals will invoke the callable python method. \n\ \n\ Notes \n\ ----- \n\ The Python callback method can only be executed if Python is in an idle state. Else, \n\ the trigger is postponed to the next possible time. However, if you want for instance \n\ to have a button that interrupts a long Python operation, it is not possible to use \n\ this :meth:`connect` method to bind the click signal of this button with any \n\ Python script interruption, since the callback method will only be called if the long \n\ operation has finished. For these cases it is recommenden to connect the triggering \n\ signal (e.g. `clicked()`) by the :meth:`invokeKeyboardInterrupt` method. \n\ \n\ See Also \n\ --------- \n\ disconnect, info, invokeKeyboardInterrupt")
	PyDoc_STRVAR (PyUiItemConnectKeyboardInterrupt_doc,"invokeKeyboardInterrupt(signalSignature) \n\ \n\ Connects the given signal with the immediate invokation of a Python interrupt signal. \n\ \n\ If you use the connect method to link a signal with a python method or function, this \n\ method can only be executed if Python is in an idle status. However, if you want to \n\ immediately raise the Python interrupt signal, use this method to establish the \n\ connection instead of the :meth:`uiItem.connect` command. \n\ \n\ Parameters \n\ ----------- \n\ signalSignature : str \n\ This must be the valid signature, known from the Qt-method *connect* \n\ (e.g. 'clicked(bool)') \n\ \n\ See Also \n\ --------- \n\ connect, invokeProgressObserverCancellation")
	PyDoc_STRVAR (PyUiItemConnectProgressObserverInterrupt_doc,"invokeProgressObserverCancellation(signalSignature, observer) \n\ \n\ Connects the given signal to a slot immediately setting the cancellation flag of this object. \n\ \n\ This method immediately calls the ``requestCancellation`` slot of the given observer \n\ if the signal with the ``signalSignature`` is emitted (independent on the current \n\ state of the Python script execution). \n\ \n\ For more information about the class :class:`requestCancellation`, see also this \n\ section: :ref:`filter_interruptible`. \n\ \n\ Parameters \n\ ----------- \n\ signalSignature : str \n\ This must be the valid signature, known from the Qt-method *connect* \n\ (e.g. 'clicked(bool)') \n\ observer : progressObserver \n\ This must be a :class:`progressObserver` object. The given signal is connected \n\ to the slot ``requestCancellation`` of this progressObserver.\n\ \n\ See Also \n\ --------- \n\ connect, invokeKeyboardInterrupt")
	PyDoc_STRVAR (PyUiItemDisconnect_doc,"disconnect(signalSignature, callableMethod) \n\ \n\ Disconnects a connection which must have been established before with exactly the same parameters.\n\ \n\ Parameters \n\ ----------- \n\ signalSignature : str \n\ This must be the valid signature, known from the Qt-method *connect* \n\ (e.g. ``clicked(bool)``) \n\ callableMethod : callable \n\ valid method or function, that should not be called any more if the \n\ given signal is emitted. \n\ \n\ See Also \n\ --------- \n\ connect, info")
	PyDoc_STRVAR (PyUiItemGetProperty_doc,"getProperty(propertyName) -> Union[Any, List[Any]] \n\ n\ Returns the requested property or a list of values for a sequence of requested properties. \n\ \n\ Use this method or the operator [] in order to get the value of one specific property \n\ of this widget or layout or of multiple properties. \n\ \n\ Multiple properties are given by a tuple or list of property names. For one single \n\ property, its value is returned as it is. If the property names are passed as sequence, \n\ a list of same size is returned with the corresponding values. \n\ \n\ Parameters \n\ ----------- \n\ propertyName : str or list of str or tuple of str \n\ Name of one property or sequence (tuple, list...) of property names. \n\ \n\ Returns \n\ ------- \n\ value : Any or list of Any \n\ the value of one single property of a list of values, if a sequence of ``propertyNames`` \n\ is given as parameter. \n\ \n\ See Also \n\ --------- \n\ setProperty")
	PyDoc_STRVAR (PyUiItemSetProperty_doc,"setProperty(propertyDict) \n\ \n\ Each property in the ``propertyDict`` is set to the dictionaries value. \n\ \n\ As an alternative, a single property can also be set using the operator []. \n\ \n\ Parameters \n\ ----------- \n\ propertyDict : dict\n\ Dictionary with properties (the keys are the property names) and the values \n\ that should be set.\n\ \n\ See Also \n\ --------- \n\ getProperty")
	PyDoc_STRVAR (PyUiItemGetPropertyInfo_doc,"getPropertyInfo(propertyName = None) -> Union[dict, List[str]] \n\ \n\ Returns a list of all available property names or a dict of meta information of one given ``propertyName``. \n\ \n\ if ``propertyName`` is ``None``, a list of all property names is returned. Else, \n\ a ``Dict[str, Any]`` is returned with meta information about this property. \n\ The structure of this dictionary is as follows: \n\ \n\ * **name**: Name of the property (str). \n\ * **valid**: ``True`` if this property is valid (readable), otherwise ``False``. \n\ * **readable**: ``True`` if this property is readable, otherwise ``False``. \n\ * **writable**: ``True`` if this property can be set to another value, otherwise ``False``. \n\ * **resettable**: ``True`` if this property can be reset to a default value; otherwise returns ``False``. \n\ * **final**: ``True`` if this property is final and cannot be overwritten in derived classes, otherwise ``False``.\n\ * **constant**: ``True`` if this property is constant, otherwise ``False``.\n\ \n\ Parameters \n\ ----------- \n\ propertyName : str, optional \n\ The name of the property whose detailed information should be returned or \n\ ``None``, if a list of all property names should be returned. \n\ \n\ Returns \n\ ------- \n\ names : list of str \n\ A list of all available property names. \n\ information : dict \n\ The dictionary with meta information about this property (see above).")
	PyDoc_STRVAR (PyUiItemGetAttribute_doc,"getAttribute(attributeNumber) -> bool \n\ \n\ Returns if a specific WidgetAttribute is set for the referenced widget. \n\ \n\ Widgets have specific attributes that influence their behaviour. These attributes \n\ are contained in the Qt-enumeration ``Qt::WidgetAttribute``. Use this method to \n\ query if the requested ``attributeNumber`` is set / enabled for the referenced widget. \n\ \n\ Important attributes are: \n\ \n\ * Qt::WA_DeleteOnClose (55) -> deletes the widget when it is closed, else it is only \n\ hidden [default] \n\ * Qt::WA_MouseTracking (2) -> indicates that the widget has mouse tracking enabled \n\ \n\ Parameters \n\ ----------- \n\ attributeNumber : int \n\ Number of the attribute of the widget to query (see Qt enumeration \n\ ``Qt::WidgetAttribute``) \n\ \n\ Returns \n\ ------- \n\ bool \n\ ``True`` if attribute is set (enabled), otherwise ``False``. \n\ \n\ See Also \n\ --------- \n\ setAttribute")
	PyDoc_STRVAR (PyUiItemSetAttribute_doc,"setAttribute(attributeNumber, value) \n\ \n\ Enables or disables the attribute of the referenced widget.\n\ \n\ Widgets have specific attributes that influence their behaviour. These attributes \n\ are contained in the Qt-enumeration ``Qt::WidgetAttribute``. Use this method to \n\ enable or disable the requested widget attribute, given by its ``attributeNumber``. \n\ \n\ Important attributes are: \n\ \n\ * Qt::WA_DeleteOnClose (55) -> deletes the widget when it is closed, else it is \n\ only hidden [default]. \n\ * Qt::WA_MouseTracking (2) -> indicates that the widget has mouse tracking enabled. \n\ \n\ Parameters \n\ ----------- \n\ attributeNumber : int \n\ Number of the attribute of the widget to set (enum ``Qt::WidgetAttribute``). \n\ value : bool \n\ ``True`` if attribute should be enabled, else ``False``. \n\ \n\ See Also \n\ --------- \n\ getAttribute")
	PyDoc_STRVAR (PyUiItemSetWindowFlags_doc,"setWindowFlags(flags) \n\ \n\ Set the window flags of the referenced widget.\n\ \n\ The window flags are used to set the type of a widget, dialog or window including \n\ further hints to the window system. This method is used to set the entire \n\ or-combination of all ``flags``, contained in the Qt-enumeration ``Qt::WindowType``. \n\ \n\ Please consider, that you have to set all values in ``flags``, that should be \n\ active in the referenced widget. It is possible to get the current flags value of \n\ this widget using :meth:`getWindowFlags``, set or unset some enum values (bits) \n\ and set it again using this method. \n\ \n\ The most important types are: \n\ \n\ * Qt::Widget (0) -> default type for widgets \n\ * Qt::Window (1) -> the widget looks and behaves like a windows (title bar, window \n\ frame...) \n\ * Qt::Dialog (3) -> window decorated as dialog (no minimize or maximize button...) \n\ \n\ Further hints can be (among others): \n\ \n\ * Qt::FramelessWindowHint (0x00000800) -> borderless window (user cannot move or \n\ resize the window) \n\ * Qt::WindowTitleBar (0x00001000) -> gives the window a title bar \n\ * Qt::WindowMinimizeButtonHint (0x00004000) -> adds a minimize button to the \n\ title bar \n\ * Qt::WindowMaximizeButtonHint (0x00008000) -> adds a maximize button to the \n\ title bar \n\ * Qt::WindowCloseButtonHint (0x00010000) -> adds a close button. \n\ * Qt::WindowStaysOnTopHint (0x00040000) -> this ui element always stays on top of \n\ other windows \n\ * Qt::WindowCloseButtonHint (0x08000000) -> remove this flag in order to disable the \n\ close button \n\ \n\ Parameters \n\ ----------- \n\ flags : int \n\ window flags to set (or-combination, see ``Qt::WindowFlags``). \n\ \n\ See Also \n\ ---------- \n\ getWindowFlags")
	PyDoc_STRVAR (PyUiItemGetWindowFlags_doc,"getWindowFlags() -> int \n\ \n\ Gets the window flags of the referenced widget. \n\ \n\ The returned ``flags`` value is an or-combination, hence bitmask, of enumeration \n\ values of the Qt enumeration ``Qt::WindowType``. \n\ \n\ Returns \n\ -------- \n\ flags : int \n\ or-combination of ``Qt::WindowType`` describing the type and further hints \n\ of the referenced widget. \n\ \n\ See Also \n\ --------- \n\ setWindowFlags")
	PyDoc_STRVAR (PyUiItemInfo_doc,"info(verbose = 0) \n\ \n\ Prints information about properties, public accessible slots and signals of the wrapped widget. \n\ \n\ Parameters \n\ ----------- \n\ verbose : int \n\ * ``0``: only properties, slots and signals that do not come from Qt-classes are \n\ printed (default) \n\ * ``1``: properties, slots and signals are printed up to Qt GUI base classes \n\ * ``2``: all properties, slots and signals are printed")
	PyDoc_STRVAR (PyUiItemExists_doc,"exists() -> bool \n\ \n\ Returns True if the widget or layout still exists, otherwise False. \n\ \n\ Returns \n\ ------- \n\ bool \n\ ``True`` if the referenced widget or layout still exists, otherwise ``False``.")
	PyDoc_STRVAR (PyUiItemChildren_doc,"children(recursive = False) -> Dict[str, str] \n\ \n\ Returns a dict with all child items of the referenced widget. \n\ \n\ Each widget in an user interface can have multiple child items, like radio buttons \n\ within a group box or widgets within a layout. This method returns information about \n\ all child items of this :class:`uiItem`. A dictionary is returned with key-value \n\ pairs, where the key is the ``objectName`` of the child item, and the value its \n\ Qt class name (see :meth:`getClassName`). \n\ \n\ Child items without valid ``objectName`` are not contained in the returned dict. \n\ \n\ Parameters \n\ ----------- \n\ recursive : bool \n\ ``True``: all objects including sub-widgets of widgets are returned, \n\ ``False``: only children of this :class:`uiItem` are returned (default). \n\ \n\ Returns \n\ ------- \n\ dict \n\ All child items of this item are returned.")
	PyDoc_STRVAR (PyUiItemGetChild_doc,"getChild(widgetName) -> uiItem \n\ \n\ Returns the uiItem of the child widget with the given ``widgetName``. \n\ \n\ This call is equal to ``self.widgetName``, where ``self`` is this :class:`uiItem`. \n\ \n\ Parameters \n\ ----------- \n\ widgetName : str \n\ ``objectName`` of the requested child widget or layout. \n\ \n\ Returns \n\ ------- \n\ item : uiItem \n\ The reference to the searched sub-widget (or layout).\n\ \n\ Raises \n\ ------ \n\ AttributeError \n\ if no widget / layout with ``widgetName`` as ``objectName`` exists.")
	PyDoc_STRVAR (PyUiItemGetLayout_doc,"getLayout() -> Optional[uiItem] \n\ \n\ Returns the uiItem of the layout item of this widget (or None). \n\ \n\ Container widgets, like group boxes, tab widgets etc. as well as top level widgets \n\ of a custom user interface can have layouts, that are responsible to arrange \n\ possible child widgets. \n\ \n\ If this uiItem has such a layout, its reference is returned as :class:`uiItem`, too. \n\ Else ``None`` is returned. \n\ \n\ Returns \n\ ------- \n\ layout : None or uiItem \n\ The reference to the searched layout, or ``None`` if no such a layout exists.")
	PyDoc_STRVAR (pyUiInit_doc,"ui(filename, type = ui.TYPEDIALOG, dialogButtonBar = ui.BUTTONBAR_NO, dialogButtons = {}, childOfMainWindow = True, deleteOnClose = False, dockWidgetArea = ui.TOPDOCKWIDGETAREA) -> ui \n\ \n\ Loads a user interface file (`ui`) and references this loaded interface by the new ui object. \n\ \n\ If the ui file is created in the `QtDesigner`, you can choose from which base type \n\ you would like to create the user interface (e.g. from a dialog, a window or a widget). \n\ This together with the argument ``type`` will mainly define the kind of user interface \n\ that is actually displayed in `itom`. \n\ \n\ If you want to add a customized user interface as toolbox or into the central part of \n\ the main window of `itom`, it is either recommended to design the interface from a \n\ widget or a main window. The latter has the advantage, that an individual menu or toolbar \n\ can be added. \n\ \n\ If you want to create a standalone window, it is recommended to already design the \n\ user interface from a main window, such that menus, toolbars as well as access to \n\ the statusbar is possible (if desired). \n\ \n\ For the creation of (modal) dialogs, where the user should configure settings or pass \n\ some inputs, it is recommended to either design the interface from a dialog on, or \n\ it is also possible to create a simple widget. In the latter case, itom will put \n\ this interface into a dialog (for ``type = ui.TYPEDIALOG``) and add optional buttons \n\ (like the ``OK`` and ``Cancel`` button). These buttons are then already configured \n\ to work. If you design a dialog from a dialog as base element, you have to connect \n\ buttons for instance with the ``accept()`` or ``reject()`` slot of the dialog by hand. \n\ \n\ For more information see also the section :ref:`qtdesigner` of the user documentation. \n\ \n\ Parameters \n\ ----------- \n\ filename : str \n\ path to the user interface file (.ui), absolute or relative to current directory. \n\ type : int, optional \n\ This ``type`` defines how the loaded user interface is displayed: \n\ \n\ * ``ui.TYPEDIALOG`` (0): The ui-file is the content of a dialog window or, if the \n\ file already defines a `QDialog`, this dialog is shown as it is. \n\ This is recommended for the creation of modal dialogs, like settings... \n\ * ``ui.TYPEWINDOW`` (1): The ui-file must be a `QMainWindow` or its outer widget \n\ is turned into a main window. This window is then shown. This is recommended \n\ for \"standalone\" windows, that should be able to be minimized, maximized, contain \n\ menus or toolbars etc. \n\ * ``ui.TYPEDOCKWIDGET`` (2): The loaded widget is the content of a dock widget (toolbox) \n\ and is added to the indicated ``dockWidgetArea`` of the main window of `itom`. \n\ * ``ui.TYPECENTRALWIDGET`` (3): The loaded ui-file must define a `QWidget` or \n\ `QMainWindow` and is then added to the central area of `itom`, above the command line. \n\ It is not allowed to choose this type if the user interface is created from \n\ a `QDialog`. \n\ \n\ dialogButtonBar : int, optional \n\ This argument is only used if ``type == ui.TYPEDIALOG`` and defines if a button bar \n\ with buttons, given by ``dialogButtons`` should be automatically added to the dialog. \n\ If this is the case, the role of the buttons is considered, such that clicking the \n\ ``OK`` or ``Cancel`` button will automatically close the dialog and return the \n\ role to the :meth:`show` method (if the dialog is displayed modal). Allowed values: \n\ \n\ * ``ui.BUTTONBAR_NO`` (0): do not add any button bar and buttons (default), \n\ * ``ui.BUTTONBAR_HORIZONTAL`` (1): add a horizontal button bar at the bottom, \n\ * ``ui.BUTTONBAR_VERTICAL`` (2): add vertical button bar on the right side. \n\ \n\ dialogButtons : dict, optional \n\ Only relevant if ``dialogButtonBar`` is not ``ui.BUTTONBAR_NO``: This dictionary \n\ contains all buttons, that should be added to the button bar. For every entry, \n\ the key is the role name of the button (enum ``QDialogButtonBox::ButtonRole``, \n\ e.g. 'AcceptRole', 'RejectRole', 'ApplyRole', 'YesRole', 'NoRole'). The value is \n\ the text of the button. \n\ childOfMainWindow : bool, optional \n\ For type ``ui.TYPEDIALOG`` and ``ui.TYPEWINDOW`` only: Indicates if the window \n\ should be a child of the itom main window. If ``False``, this window has its own \n\ icon in the taskbar of the operating system. \n\ deleteOnClose : bool, optional \n\ Indicates if the widget / window / dialog should be deleted if the user closes it \n\ or if it is hidden. If it is hidden, it can be shown again using :meth:`show`. \n\ dockWidgetArea : int, optional \n\ Only for ``type == ui.TYPEDOCKWIDGET (2)``. Indicates the position where the \n\ dock widget should be placed: \n\ \n\ * 1 : ``ui.LEFTDOCKWIDGETAREA`` \n\ * 2 : ``ui.RIGHTDOCKWIDGETAREA`` \n\ * 4 : ``ui.TOPDOCKWIDGETAREA`` \n\ * 8 : ``ui.BOTTOMDOCKWIDGETAREA`` \n\ \n\ Returns \n\ ------- \n\ window : ui \n\ A :class:`ui` object, that references the loaded ui-file.")
	PyDoc_STRVAR (pyUiShow_doc,"show(modal = 0) -> Optional[int] \n\ \n\ Shows the window or dialog. \n\ \n\ Parameters \n\ ----------- \n\ modal : int, optional \n\ * 0: non-modal, the opened GUI does not block other windows of itom (default)\n\ * 1: modal (python waits until dialog is hidden)\n\ * 2: modal (python returns immediately)\n\ \n\ Returns \n\ ---------- \n\ None or int \n\ Usually the value -1 is returned. Only if a dialog is shown with ``modal = 1``, \n\ the exit code of the shown dialog is returned, once this dialog is closed again. \n\ This code is: ``1`` if the dialog has been accepted (e.g. by closing it by an OK button \n\ or ``0`` if the dialog has been rejected (Cancel button or directly closing the dialog \n\ via the close icon in its title bar. \n\ \n\ See Also \n\ --------- \n\ hide")
	PyDoc_STRVAR (pyUiHide_doc,"hide() \n\ \n\ Hides the user interface reference by this ui object. \n\ \n\ A hidden window or dialog can be shown again via the method :py:meth:`show`.\n\ \n\ See Also \n\ --------- \n\ show")
	PyDoc_STRVAR (pyUiIsVisible_doc,"isVisible() -> bool \n\ \n\ Returns ``True`` if the referenced window or dialog is still visible. \n\ \n\ Returns \n\ ------- \n\ visible : bool \n\ ``True`` if user interface is visible, ``False`` if it is hidden.")
int	PyUiItem_Converter (PyObject *object, PythonUi::PyUiItem **address)
	PyDoc_STRVAR (pyUiGetDouble_doc,"getDouble(title, label, defaultValue, min = -2147483647.0, max = 2147483647.0, decimals = 1, parent = None) -> Tuple[float, bool] \n\ \n\ Shows a dialog to get a float value from the user. \n\ \n\ For more information, see also the section :ref:`msgInputBoxes` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ title : str\n\ is the title of the dialog. \n\ label : str \n\ is the label above the input box. \n\ defaultValue : float \n\ is the default value in the input box. \n\ min : float, optional \n\ is the allowed minimal value. \n\ max : float, optional \n\ is the allowed maximal value. \n\ decimals : int, optional \n\ the maximum number of decimal places. \n\ parent : uiItem, optional \n\ the dialog is modal with respect to ``parent`` or with respect to the \n\ main window of `itom`, if ``None``. \n\ \n\ Returns \n\ ------- \n\ value : float \n\ The entered float value. \n\ success : bool \n\ ``True`` if the dialog has been accepted, otherwise ``False``. \n\ \n\ See Also \n\ --------- \n\ getInt, getText, getItem")
	PyDoc_STRVAR (pyUiGetInt_doc,"getInt(title, label, defaultValue, min = -2147483647, max = 2147483647, step = 1, parent = None) -> Tuple[int, bool] \n\ \n\ Shows a dialog to get an integer value from the user. \n\ \n\ For more information, see also the section :ref:`msgInputBoxes` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ title : str\n\ is the title of the dialog. \n\ label : str\n\ is the label above the input box. \n\ defaultValue : int\n\ is the default value in the input box. \n\ min : int, optional\n\ is the allowed minimal value. \n\ max : int, optional\n\ is the allowed maximal value. \n\ step : int, optional\n\ is the step size if user presses the up/down arrow. \n\ parent : uiItem, optional \n\ the dialog is modal with respect to ``parent`` or with respect to the \n\ main window of `itom`, if ``None``. \n\ \n\ Returns \n\ ------- \n\ value : int \n\ The entered integer value. \n\ success : bool \n\ ``True`` if the dialog has been accepted, otherwise ``False``. \n\ \n\ See Also \n\ --------- \n\ getDouble, getText, getItem")
	PyDoc_STRVAR (pyUiGetItem_doc,"getItem(title, label, stringList, currentIndex = 0, editable = False, parent = None) -> Tuple[str, bool] \n\ \n\ Shows a dialog to let the user select an item from a string list. \n\ \n\ For more information, see also the section :ref:`msgInputBoxes` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ title : str \n\ is the title of the dialog.\n\ label : str \n\ is the label above the text box. \n\ stringList : list of str or tuple of str \n\ is a list or tuple of possible string values. \n\ currentIndex : int, optional\n\ defines the pre-selected value index from ``stringList``. \n\ editable : bool, optional\n\ defines whether new entries can be added (``True``) or not (``False``) \n\ parent : uiItem, optional\n\ the dialog is modal with respect to ``parent`` or with respect to the \n\ main window of `itom`, if ``None``. \n\ \n\ Returns \n\ ------- \n\ value : str \n\ The currently selected or entered string value. \n\ success : bool \n\ ``True`` if the dialog has been accepted, otherwise ``False``. \n\ \n\ See Also \n\ --------- \n\ getInt, getDouble, getText")
	PyDoc_STRVAR (pyUiGetText_doc,"getText(title, label, defaultString, parent = None) -> Tuple[str, bool] \n\ \n\ Opens a dialog to ask the user for a string value. \n\ \n\ For more information, see also the section :ref:`msgInputBoxes` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ title : str \n\ is the title of the dialog. \n\ label : str \n\ is the label above the text box. \n\ defaultString : str \n\ is the default string in the text box. \n\ parent : uiItem, optional \n\ the dialog is modal with respect to ``parent`` or with respect to the \n\ main window of `itom`, if ``None``. \n\ \n\ Returns \n\ ------- \n\ value : str \n\ The entered string value. \n\ success : bool \n\ ``True`` if dialog has been accepted, otherwise ``False``. \n\ \n\ See Also \n\ --------- \n\ getInt, getDouble, getItem")
	PyDoc_STRVAR (pyUiMsgInformation_doc,"msgInformation(title, text, buttons = ui.MsgBoxOk, defaultButton = 0, parent = None) -> Tuple[int, str] \n\ \n\ Opens an information message box. \n\ \n\ For more information, see also the section :ref:`msgInputBoxes` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ title : str \n\ is the title of the message box. \n\ text : str \n\ is the message text \n\ buttons : int, optional \n\ is a flag value (bitmask) of the constants ``ui.MsgBoxXYZ``, where ``XYZ`` is \n\ a placeholder for different values. Each selected constant indicates the \n\ corresponding button to display (combine values be the | operator). \n\ defaultButton : int, optional \n\ is the button constant (see ``buttons``, that should be set as default. \n\ parent : uiItem, optional \n\ If not ``None``, the dialog will be shown modal to this ``parent`` window. \n\ Else, it is modal with respect to the main window of `itom`. \n\ \n\ Returns \n\ ------- \n\ buttonID : int \n\ constant of the button that has been clicked to close the message box. \n\ buttonText : str \n\ caption of the button that has been clicked to close the message box. \n\ \n\ See Also \n\ --------- \n\ msgCritical, msgQuestion, msgWarning")
	PyDoc_STRVAR (pyUiMsgQuestion_doc,"msgQuestion(title, text, buttons = ui.MsgBoxOk, defaultButton = 0, parent = None) -> Tuple[int, str] \n\ \n\ Opens a question message box. \n\ \n\ For more information, see also the section :ref:`msgInputBoxes` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ title : str \n\ is the title of the message box. \n\ text : str \n\ is the message text \n\ buttons : int, optional \n\ is a flag value (bitmask) of the constants ``ui.MsgBoxXYZ``, where ``XYZ`` is \n\ a placeholder for different values. Each selected constant indicates the \n\ corresponding button to display (combine values be the | operator). \n\ defaultButton : int, optional \n\ is the button constant (see ``buttons``, that should be set as default. \n\ parent : uiItem, optional \n\ If not ``None``, the dialog will be shown modal to this ``parent`` window. \n\ Else, it is modal with respect to the main window of `itom`. \n\ \n\ Returns \n\ ------- \n\ buttonID : int \n\ constant of the button that has been clicked to close the message box. \n\ buttonText : str \n\ caption of the button that has been clicked to close the message box. \n\ \n\ See Also \n\ --------- \n\ msgCritical, msgWarning, msgInformation")
	PyDoc_STRVAR (pyUiMsgWarning_doc,"msgWarning(title, text, buttons = ui.MsgBoxOk, defaultButton = 0, parent = None) -> Tuple[int, str] \n\ \n\ Opens a warning message box. \n\ \n\ For more information, see also the section :ref:`msgInputBoxes` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ title : str \n\ is the title of the message box. \n\ text : str \n\ is the message text \n\ buttons : int, optional \n\ is a flag value (bitmask) of the constants ``ui.MsgBoxXYZ``, where ``XYZ`` is \n\ a placeholder for different values. Each selected constant indicates the \n\ corresponding button to display (combine values be the | operator). \n\ defaultButton : int, optional \n\ is the button constant (see ``buttons``, that should be set as default. \n\ parent : uiItem, optional \n\ If not ``None``, the dialog will be shown modal to this ``parent`` window. \n\ Else, it is modal with respect to the main window of `itom`. \n\ \n\ Returns \n\ ------- \n\ buttonID : int \n\ constant of the button that has been clicked to close the message box. \n\ buttonText : str \n\ caption of the button that has been clicked to close the message box. \n\ \n\ See Also \n\ --------- \n\ msgCritical, msgQuestion, msgInformation")
	PyDoc_STRVAR (pyUiMsgCritical_doc,"msgCritical(title, text, buttons = ui.MsgBoxOk, defaultButton = 0, parent = None) -> Tuple[int, str] \n\ \n\ Opens a critical message box. \n\ \n\ For more information, see also the section :ref:`msgInputBoxes` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ title : str \n\ is the title of the message box. \n\ text : str \n\ is the message text \n\ buttons : int, optional \n\ is a flag value (bitmask) of the constants ``ui.MsgBoxXYZ``, where ``XYZ`` is \n\ a placeholder for different values. Each selected constant indicates the \n\ corresponding button to display (combine values be the | operator). \n\ defaultButton : int, optional \n\ is the button constant (see ``buttons``, that should be set as default. \n\ parent : uiItem, optional \n\ If not ``None``, the dialog will be shown modal to this ``parent`` window. \n\ Else, it is modal with respect to the main window of `itom`. \n\ \n\ Returns \n\ ------- \n\ buttonID : int \n\ constant of the button that has been clicked to close the message box. \n\ buttonText : str \n\ caption of the button that has been clicked to close the message box. \n\ \n\ See Also \n\ --------- \n\ msgWarning, msgQuestion, msgInformation")
	PyDoc_STRVAR (pyUiGetExistingDirectory_doc,"getExistingDirectory(caption, startDirectory, options = 0, parent = None) -> Optional[str] \n\ \n\ Opens a dialog to choose an existing directory. \n\ \n\ For more information, see also the section :ref:`msgInputBoxes` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ caption : str \n\ is the caption of this dialog. \n\ startDirectory : str \n\ is the start directory, visible in the dialog. \n\ options : int, optional\n\ is a flag value (bitmask) of the following options (see ``QFileDialog::Option``): \n\ \n\ * 1: ShowDirsOnly [default] \n\ * 2: DontResolveSymlinks \n\ * ... (for others see Qt-Help) \n\ \n\ parent : uiItem, optional \n\ If not ``None``, the dialog will be shown modal to this ``parent`` window. \n\ Else, it is modal with respect to the main window of `itom`. \n\ \n\ Returns \n\ ------- \n\ directory : None or str \n\ The absolute path of the selected directory is returned or ``None`` if the dialog \n\ has been rejected. \n\ \n\ See Also \n\ --------- \n\ getSaveFileName, getOpenFileName")
	PyDoc_STRVAR (pyUiGetOpenFileNames_doc,"getOpenFileNames(caption = \"\", startDirectory = \"\", filters = \"\", selectedFilterIndex = 0, options = 0, parent = None) -> Optional[List[str]] \n\ \n\ Shows a dialog for chosing one or multiple file names. The selected file(s) must exist. \n\ \n\ This method creates a modal file dialog to let the user select one or multiple file \n\ names used for opening these files. \n\ \n\ For more information, see also the section :ref:`msgInputBoxes` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ caption : str, optional \n\ This is the title of the dialog. \n\ startDirectory : str, optional \n\ The intial directory, shown in the dialog. If an empty string, the current working \n\ directory will be taken. \n\ filters : str, optional \n\ Possible filter list or allowed file types / suffixes etc. The entries should be \n\ separated by ``;;``, for example ``Images (*.png *.jpg);;Text files (*.txt)``. \n\ selectedFilterIndex : int, optional \n\ The index of the currently selected filter from ``filters``. \n\ options : int, optional\n\ This corresponds to the Qt flag ``QFileDialog::Options``. \n\ parent : uiItem, optional \n\ If not ``None``, the dialog will be shown modal to this ``parent`` window. \n\ Else, it is modal with respect to the main window of `itom`. \n\ \n\ Returns \n\ ------- \n\ selectedFileNames : None or list of str \n\ The selected file pathes or ``None`` if the dialog has been aborted. \n\ \n\ See Also \n\ --------- \n\ getOpenFileName, getSaveFileName")
	PyDoc_STRVAR (pyUiGetOpenFileName_doc,"getOpenFileName(caption = \"\", startDirectory = \"\", filters = \"\", selectedFilterIndex = 0, options = 0, parent = None) -> Optional[str] \n\ \n\ Shows a dialog for chosing a file name. The selected file must exist. \n\ \n\ This method creates a modal file dialog to let the user select a file name used for opening a file. \n\ \n\ For more information, see also the section :ref:`msgInputBoxes` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ caption : str, optional \n\ This is the title of the dialog. \n\ startDirectory : str, optional \n\ The intial directory, shown in the dialog. If an empty string, the current working \n\ directory will be taken. \n\ filters : str, optional \n\ Possible filter list or allowed file types / suffixes etc. The entries should be \n\ separated by ``;;``, for example ``Images (*.png *.jpg);;Text files (*.txt)``. \n\ selectedFilterIndex : int, optional \n\ The index of the currently selected filter from ``filters``. \n\ options : int, optional\n\ This corresponds to the Qt flag ``QFileDialog::Options``. \n\ parent : uiItem, optional \n\ If not ``None``, the dialog will be shown modal to this ``parent`` window. \n\ Else, it is modal with respect to the main window of `itom`. \n\ \n\ Returns \n\ ------- \n\ selectedFileName : None or str \n\ The selected file path or ``None`` if the dialog has been aborted. \n\ \n\ See Also \n\ --------- \n\ getOpenFileNames, getSaveFileName")
	PyDoc_STRVAR (pyUiGetSaveFileName_doc,"getSaveFileName(caption = \"\", startDirectory = \"\", filters = \"\", selectedFilterIndex = 0, options = 0, parent = None) -> Optional[str] \n\ \n\ Shows a dialog for chosing a file name. The selected file must not exist. \n\ \n\ This method creates a modal file dialog to let the user select a file name used for saving a file. \n\ \n\ For more information, see also the section :ref:`msgInputBoxes` of the documentation. \n\ \n\ Parameters \n\ ----------- \n\ caption : str, optional \n\ This is the title of the dialog. \n\ startDirectory : str, optional \n\ The intial directory, shown in the dialog. If an empty string, the current working \n\ directory will be taken. \n\ filters : str, optional \n\ Possible filter list or allowed file types / suffixes etc. The entries should be \n\ separated by ``;;``, for example ``Images (*.png *.jpg);;Text files (*.txt)``. \n\ selectedFilterIndex : int, optional \n\ The index of the currently selected filter from ``filters``. \n\ options : int, optional\n\ This corresponds to the Qt flag ``QFileDialog::Options``. \n\ parent : uiItem, optional \n\ If not ``None``, the dialog will be shown modal to this ``parent`` window. \n\ Else, it is modal with respect to the main window of `itom`. \n\ \n\ Returns \n\ ------- \n\ selectedFileName : None or str \n\ The selected file path or ``None`` if the dialog has been aborted. \n\ \n\ See Also \n\ --------- \n\ getOpenFileName")
	PyDoc_STRVAR (pyUiCreateNewPluginWidget_doc,"createNewPluginWidget(widgetName, *args, **kwds) -> ui \n\ \n\ Loads a widget, defined in an itom algorithm plugin, and returns the :class:`ui` object, that references this widget. \n\ \n\ Itom algorithm plugins cannot only contain algorithms, callable by Python, but also \n\ methods, that return a customized user-interface, widget etc. Use this method to \n\ initialize such an user-interface and returns its corresponding :class:`ui` object. \n\ \n\ For a list of available widget methods, see :meth:`widgetHelp`. Compared to the more \n\ detailed method :meth:`createNewPluginWidget2`, this method uses the following defaults \n\ for the windows appearance: \n\ \n\ * The ``type`` of the widget is derived from the widget itself and cannot be adjusted, \n\ * ``deleteOnClose = False``: The widget or windows will only be hidden if the user \n\ clicks the close button, \n\ * ``childOfMainWindow = True``: The widget or windows is a child of the main window \n\ without own symbol in the taskbar, \n\ * ``dockWidgetArea = ui.TOPDOCKWIDGETAREA``: If the widget is derived from `QDockWidget`, \n\ the dock widget is docked at that location \n\ * ``buttonBarType = ui.BUTTONBAR_NO``, if a dialog is created (if the plugin delivers a \n\ widget and no windows, dialog or dock widget), the dialog has no automatically \n\ generated ``OK``, ``Cancel``, ``...`` buttons \n\ \n\ If you want to have other default parameters than these ones, call :meth:`createNewPluginWidget2`. \n\ \n\ Parameters \n\ ----------- \n\ widgetName : str \n\ Name of algorithm widget method. \n\ *args \n\ Further positional arguments, that are parsed and passed to the widget creation method. \n\ These arguments are used first to initialize all mandatory parameters, followed by \n\ the optional ones. \n\ **kwds \n\ Keyword-based arguments, that are parsed and passed together with the positional \n\ arguments to the widget creation method. If one argument is given by its keyword, \n\ no further positional arguments can follow. For this, the mandatory and optional \n\ parameters of the widget creation method can be considered to be in one list, where \n\ the optional parameters follow after the mandatory ones. \n\ \n\ Returns \n\ ------- \n\ ui \n\ :class:`ui` object, that represents the loaded widget, dialog or window. The type of \n\ the ui is mainly defined by the type of the widget. If it is derived from `QMainWindow`, \n\ a window is opened; if it is derived from `QDockWidget` a dock widget is created, in \n\ all other cases a dialog is created. \n\ \n\ Notes \n\ ----- \n\ Unlike it is the case at the creation of ui's from ui files, you can not directly \n\ parameterize behaviours like the ``deleteOnClose`` flag. This can however be done using \n\ :meth:`setAttribute`. \n\ \n\ See Also \n\ --------- \n\ createNewPluginWidget2, widgetHelp")
	PyDoc_STRVAR (pyUiCreateNewPluginWidget2_doc,"createNewPluginWidget2(widgetName, paramsArgs = [], paramsDict = {}, type = 0xFF, dialogButtonBar = ui.BUTTONBAR_NO, dialogButtons = {}, childOfMainWindow = True, deleteOnClose = False, dockWidgetArea = ui.TOPDOCKWIDGETAREA) -> ui \n\ \n\ Loads a widget, defined in an itom algorithm plugin, and returns the :class:`ui` object, that references this widget. \n\ \n\ Itom algorithm plugins cannot only contain algorithms, callable by Python, but also \n\ methods, that return a customized user-interface, widget etc. Use this method to \n\ initialize such an user-interface and returns its corresponding :class:`ui` object. \n\ \n\ For a list of available widget methods, see :meth:`widgetHelp`. \n\ \n\ Parameters \n\ ----------- \n\ widgetName : str \n\ Name of algorithm widget method. \n\ paramsArgs : tuple \n\ See ``paramsDict``. \n\ paramsDict : dict \n\ The widget creation method in the algorithm plugin can depend on several mandatory \n\ and / or optional parameters. For their initialization, the mandatory and optional \n\ parameters are considered to be stacked together. At first, the ``paramsArgs`` \n\ sequence is used to assign a certain number of parameters beginning with the \n\ mandatory ones. If all ``paramsArgs`` values are assigned, the keyword-based \n\ values in ``paramsDict`` are tried to be assigned to not yet used mandatory or \n\ optional parameters. All mandatory parameters must be given (see \n\ ``widgetHelp(widgetName)`` to obtain information about all required parameters. \n\ type : int, optional \n\ Desired type of the newly created widget (a widget can also be a standalone dialog, \n\ dockwidget or window): \n\ \n\ * 255 (default) : the type is derived from the original type of the widget, \n\ * 0 (``ui.TYPEDIALOG``): the ui-file is embedded in auto-created dialog, \n\ * 1 (``ui.TYPEWINDOW``): the ui-file is handled as main window, \n\ * 2 (``ui.TYPEDOCKWIDGET``): the ui-file is handled as dock-widget and appended \n\ to the main-window dock area, \n\ * 3 (``ui.TYPECENTRALWIDGET``): the ui-file must be a widget or main window \n\ and is included in the central area of itom, above the command line. \n\ \n\ dialogButtonBar : int, optional \n\ Only for ``type`` ``ui.TYPEDIALOG (0)``: Indicates if buttons should be automatically \n\ added to the dialog: \n\ \n\ * 0 (``ui.BUTTONBAR_NO``): do not add any buttons (default), \n\ * 1 (``ui.BUTTONBAR_HORIZONTAL``): add a horizontal button bar, \n\ * 2 (``ui.BUTTONBAR_VERTICAL``): add a vertical button bar. \n\ \n\ dialogButtons : dict, optional \n\ Only relevant if ``dialogButtonBar`` is not ``ui.BUTTONBAR_NO``: This dictionary \n\ contains all buttons, that should be added to the button bar. For every entry, \n\ the key is the role name of the button (enum ``QDialogButtonBox::ButtonRole``, \n\ e.g. 'AcceptRole', 'RejectRole', 'ApplyRole', 'YesRole', 'NoRole'). The value is \n\ the text of the button. \n\ childOfMainWindow : bool, optional \n\ For type ``ui.TYPEDIALOG`` and ``ui.TYPEWINDOW`` only: Indicates if the window \n\ should be a child of the itom main window. If ``False``, this window has its own \n\ icon in the taskbar of the operating system. \n\ deleteOnClose : bool, optional \n\ Indicates if the widget / window / dialog should be deleted if the user closes it \n\ or if it is hidden. If it is hidden, it can be shown again using :meth:`show`. \n\ dockWidgetArea : int, optional \n\ Only for ``type`` ``ui.TYPEDOCKWIDGET (2)``. Indicates the position where the \n\ dock widget should be placed: \n\ \n\ * 1 : ``ui.LEFTDOCKWIDGETAREA`` \n\ * 2 : ``ui.RIGHTDOCKWIDGETAREA`` \n\ * 4 : ``ui.TOPDOCKWIDGETAREA`` \n\ * 8 : ``ui.BOTTOMDOCKWIDGETAREA`` \n\ \n\ Returns \n\ ------- \n\ ui \n\ :class:`ui` object, that represents the loaded widget, dialog or window. The type of \n\ the ui is mainly defined by the type of the widget. If it is derived from `QMainWindow`, \n\ a window is opened; if it is derived from `QDockWidget` a dock widget is created, in \n\ all other cases a dialog is created. \n\ \n\ Notes \n\ ----- \n\ Unlike it is the case at the creation of ui's from ui files, you can not directly \n\ parameterize behaviours like the ``deleteOnClose`` flag. This can however be done using \n\ :meth:`setAttribute`. \n\ \n\ See Also \n\ --------- \n\ createNewPluginWidget, widgetHelp")
	PyDoc_STRVAR (pyUiAvailableWidgets_doc,"availableWidgets() -> List[str] \n\ \n\ List of class names of all available widgets that can be directly loaded in an ui-file at runtime. \n\ \n\ Returns \n\ ------- \n\ list of str \n\ A list of the class names of all widgets, that can be directly loaded in an \n\ user interface at runtime. These widgets can be built-in widgets of Qt as well \n\ as additional widgets from designer plugins (like itom plots or other itom widgets.")
	PyDoc_STRVAR (PyTimerInit_doc,"timer(interval, callbackFunc, argTuple = (), singleShot = False, name = \"\", startAfterInit = True) -> timer \n\ \n\ Creates a new timer object for (continously) triggering a callback function \n\ \n\ Creates a timer object that (continuously) calls a python callback function or method. \n\ The timer is active right from the beginning, hence, after creating this object. \n\ If ``singleShot`` is ``True``, the callback function is triggered once after the \n\ interval is passed (denoted as timeout). Else, the callback is continuously triggered \n\ with the given interval. \n\ \n\ Please note, that the timer objects may time out later than expected if Python is \n\ currently busy or the operating system is unable to provide the requested accuracy. \n\ In such a case of timeout overrun, the callback function is only triggered once, \n\ even if multiple timeouts have expired, and then will resume the original interval. \n\ \n\ An active timer can be stopped by the :meth:`stop` method, or if this object is \n\ deleted. Furthermore, itom provides the :ref:`gui-timermanager` dialog, where \n\ all or selected timers can be started or stopped. \n\ \n\ **New in itom 4.1**: Added optional ``startAfterInit`` argument. \n\ \n\ Parameters \n\ ----------- \n\ interval : int \n\ Time out interval in ms. \n\ callbackFunc : callable \n\ Python method (bounded) or function (unbounded) that should be called whenever \n\ the timer event raises. \n\ argTuple : tuple, optional \n\ Tuple of parameters passed as arguments to the callback function. \n\ singleShot : bool, optional \n\ Defines if this timer only fires one time after its start (``True``) or \n\ continuously (``False``, default). \n\ name : str, optional \n\ Is the optional name of this timer. This name is displayed in the timer \n\ manager dialog (instead of the timer ID, if no name is given. \n\ startAfterInit : bool, optional \n\ If this optional boolean is set to False the timer will not start after initialization. \n\ The timer can be started later by using timer.start(). \n\ \n\ Examples \n\ -------- \n\ >>> import time \n\ ... \n\ ... def callbackFunc(startTime: float, a: int): \n\ ... print(\"%.2f sec elapsed: %i\" % (time.time() - startTime, a)) \n\ ... \n\ ... myTimer = timer(1000, callbackFunc, argTuple = (time.time(), 25)) \n\ \n\ 1.00 sec elapsed: 25 \n\ 2.01 sec elapsed : 25 \n\ 3.01 sec elapsed : 25 \n\ 4.01 sec elapsed : 25")
	PyDoc_STRVAR (PyTimerStart_doc,"start() \n\ \n\ Starts the timer. \n\ \n\ This method starts or restarts the timer with its timeout interval. \n\ If the timer is already running, it will be stopped and restarted. \n\ \n\ See Also \n\ --------- \n\ isActive, stop")
	PyDoc_STRVAR (PyTimerStop_doc,"stop() \n\ \n\ Stops the timer. \n\ \n\ This method stop the timer (if currently active). \n\ \n\ See Also \n\ --------- \n\ isActive, start")
	PyDoc_STRVAR (PyTimerIsActive_doc,"isActive() -> bool \n\ \n\ Indicates if the timer is currently active. \n\ \n\ Returns \n\ ------- \n\ bool \n\ ``True`` if the timer is running, otherwise ``False``.")
	PyDoc_STRVAR (PyTimerSetInterval_doc,"setInterval(interval) \n\ \n\ Sets the timer interval in ms. \n\ \n\ This method sets the timeout interval in milliseconds. If the timer is started, \n\ the callback function is tried to be continously triggered whenever the interval \n\ expired. \n\ \n\ Parameters \n\ ----------- \n\ interval : int \n\ Timeout interval in milliseconds. \n\ \n\ Notes \n\ ------ \n\ If Python is currently busy, a timer event can also be triggered at a later time, \n\ if the same trigger event is not already in the execution queue.")
bool	cmpStringIntPair (const QPair< QString, int > &a, const QPair< QString, int > &b)
void	setColorButton (const QColor &color, ColorPickerButton *btn, QLabel *lbl, QLabel *ico)
QString	dumpChildMenus (const QString &baseKey, const QAction *parent)
QString	argsWordWrap (QString text, int width)
void	methodBoxAddItem (QComboBox *methodBox, const QIcon &icon, const QString &methPre, const QString &methArgs, const QString &methPost, const QVariant &userData)
void	doDeleteLater (QObject *obj)
ito::RetVal	apiFCheckAndSetParamVal (QVariant *tempParam, ito::ParamBase *param, int *set)
ito::RetVal	apiFParseInitParams (QVector< ito::ParamBase > *initParamListMand, QVector< ito::ParamBase > *initParamListOpt, QVector< QVariant > *params)
template<typename _Tp >
RetVal	FreeFunc (DataObject *dObj)
	low-level, templated method for freeing allocated data blocks More...
	MAKEFUNCLIST (FreeFunc)
template<typename _Tp >
RetVal	SecureFreeFunc (DataObject *dObj)
	MAKEFUNCLIST (SecureFreeFunc)
template<typename _Tp >
RetVal	CreateFunc (DataObject *dObj, const unsigned char dimensions, const int *sizes, const unsigned char continuous, const uchar *continuousDataPtr, const int *steps)
	templated method for create More...
template<typename _Tp >
RetVal	CreateFuncWithCVPlanes (DataObject *dObj, const unsigned char dimensions, const int *sizes, const cv::Mat *planes, const unsigned int nrOfPlanes)
	templated method for creation with given vector of cv::Mat-planes More...
template<typename _Tp >
RetVal	CopyToFunc (const DataObject &lhs, DataObject &rhs, unsigned char regionOnly)
	low-level, templated method for deeply copying the data of one matrix to another given matrix More...
	MAKEFUNCLIST (CopyToFunc)
template<typename _Tp >
RetVal	DeepCopyPartialFunc (const DataObject &lhs, DataObject &rhs)
	low-level, templated method to copy the values of the ROI of matrix lhs to the ROI of matrix rhs. More...
	MAKEFUNCLIST (DeepCopyPartialFunc)
template<typename _Tp >
RetVal	ZerosFunc (const int sizeY, const int sizeX, uchar **dstMat)
	low-level, templated method for creation of zero-valued matrix-plane More...
	MAKEFUNCLIST (ZerosFunc)
template<typename _Tp >
RetVal	OnesFunc (const int sizeY, const int sizeX, uchar **dstMat)
	low-level, templated method for creation of one-valued matrix-plane More...
template<>
RetVal	OnesFunc< ito::Rgba32 > (const int sizeY, const int sizeX, uchar **dstMat)
	low-level, overloaded template method for creation of one-valued matrix-plane of RGBA32 More...
	MAKEFUNCLIST (OnesFunc)
template<typename _Tp >
RetVal	NansFunc (const int sizeY, const int sizeX, uchar **dstMat)
	low-level, templated method for creation of one-valued matrix-plane More...
template<>
RetVal	NansFunc< ito::complex64 > (const int sizeY, const int sizeX, uchar **dstMat)
	low-level, overloaded template method for creation of one-valued matrix-plane of complex64, complex128 More...
template<>
RetVal	NansFunc< ito::complex128 > (const int sizeY, const int sizeX, uchar **dstMat)
	MAKEFUNCLIST (NansFunc)
template<typename _Tp >
RetVal	RandFunc (const int sizeY, const int sizeX, const double value1, const double value2, const bool randMode, uchar **dstMat)
	low-level, templated method for creation of random-valued matrix-plane More...
template<>
RetVal	RandFunc< ito::complex128 > (const int sizeY, const int sizeX, const double value1, const double value2, const bool randMode, uchar **dstMat)
	template specialisation for low-level, templated method for creation of random-valued matrix-plane of type complex128 More...
template<>
RetVal	RandFunc< ito::Rgba32 > (const int sizeY, const int sizeX, const double value1, const double value2, const bool randMode, uchar **dstMat)
	template specialisation for low-level, templated method for creation of random-valued matrix-plane of type rgba32 More...
	MAKEFUNCLIST (RandFunc)
template<typename _Tp >
RetVal	CopyMatFunc (const uchar **src, uchar **&dst, bool transposed, const int sizeofs)
	low-level, templated method that executes a shallow-copy of every matrix-plane in the source-vector and stores the copies in the destination-vector More...
template<typename _Tp >
RetVal	AssignScalarFunc (DataObject *src, const ito::tDataType type, const void *scalar)
	low-level, templated helper method to assign the given scalar to every element within its ROI in DataObject src. More...
	MAKEFUNCLIST (AssignScalarFunc)
template<typename _Tp >
RetVal	AssignScalarMaskFunc (DataObject *src, const DataObject *mask, const ito::tDataType type, const void *scalar)
	low-level, templated helper method to assign the given scalar to every element within its ROI in DataObject src. More...
	MAKEFUNCLIST (AssignScalarMaskFunc)
template<typename _Tp >
RetVal	AddFunc (const DataObject *dObj1, const DataObject *dObj2, DataObject *dObjRes)
	Sets all or some of the array elements to the specific value. More...
	MAKEFUNCLIST (AddFunc)
template<typename _Tp >
RetVal	AddScalarFunc (const DataObject *dObjIn, ito::float64 scalar, DataObject *dObjOut)
template<>
RetVal	AddScalarFunc< ito::Rgba32 > (const DataObject *dObjIn, ito::float64 scalar, DataObject *dObjOut)
	MAKEFUNCLIST (AddScalarFunc)
template<typename _Tp >
RetVal	AddComplexScalarFunc (const DataObject *dObjIn, ito::complex128 scalar, DataObject *dObjOut)
template<>
RetVal	AddComplexScalarFunc< ito::complex64 > (const DataObject *dObjIn, ito::complex128 scalar, DataObject *dObjOut)
template<>
RetVal	AddComplexScalarFunc< ito::complex128 > (const DataObject *dObjIn, ito::complex128 scalar, DataObject *dObjOut)
template<>
RetVal	AddComplexScalarFunc< ito::Rgba32 > (const DataObject *dObjIn, ito::complex128 scalar, DataObject *dObjOut)
	MAKEFUNCLIST (AddComplexScalarFunc)
template<typename _Tp >
RetVal	SubFunc (const DataObject *dObj1, const DataObject *dObj2, DataObject *dObjRes)
	low-level, templated method for element-wise subtraction of values from second data object from values of first data object More...
	MAKEFUNCLIST (SubFunc)
template<typename _Tp >
RetVal	OpMulFunc (const DataObject *dObj1, const DataObject *dObj2, DataObject *dObjRes)
	brief description More...
	MAKEFUNCLIST (OpMulFunc)
template<typename _Tp >
RetVal	OpScalarMulFunc (DataObject *src, const float64 &factor)
	low-level, templated method which multiplies every element of Data Object with a factor More...
template<>
RetVal	OpScalarMulFunc< ito::complex64 > (DataObject *src, const float64 &factor)
template<>
RetVal	OpScalarMulFunc< ito::complex128 > (DataObject *src, const float64 &factor)
template<>
RetVal	OpScalarMulFunc< ito::Rgba32 > (DataObject *src, const float64 &factor)
	MAKEFUNCLIST (OpScalarMulFunc)
template<typename _Tp >
RetVal	OpScalarComplexMulFunc (DataObject *src, const complex128 &factor)
	low-level, templated method which multiplies every element of Data Object with a factor More...
template<>
RetVal	OpScalarComplexMulFunc< ito::complex64 > (DataObject *src, const complex128 &factor)
template<>
RetVal	OpScalarComplexMulFunc< ito::complex128 > (DataObject *src, const complex128 &factor)
template<>
RetVal	OpScalarComplexMulFunc< ito::Rgba32 > (DataObject *src, const complex128 &factor)
	MAKEFUNCLIST (OpScalarComplexMulFunc)
template<typename _Tp >
RetVal	CmpFunc (const DataObject *src1, const DataObject *src2, DataObject *dst, int cmpOp)
	low-level, templated method which compares each element in source-matrix1 with its corresponding element in source-matrix2 and saves the result in a destionation matrix More...
template<>
RetVal	CmpFunc< ito::complex64 > (const DataObject *src1, const DataObject *src2, DataObject *dst, int cmpOp)
	template specialisation for compare function of type complex64 More...
template<>
RetVal	CmpFunc< ito::complex128 > (const DataObject *src1, const DataObject *src2, DataObject *dst, int cmpOp)
	template specialisation for compare function of type complex128 More...
	MAKEFUNCLIST (CmpFunc)
template<typename _Tp >
RetVal	CmpFuncScalar (const DataObject *src, const float64 &value, DataObject *dst, int cmpOp)
	low-level, templated method which compares each element in source-matrix1 with its corresponding element in source-matrix2 and saves the result in a destionation matrix More...
RetVal	CmpFuncScalar (const DataObject *src, const ito::complex64 &value, DataObject *dst, int cmpOp)
	template specialisation for compare function of type complex64 More...
RetVal	CmpFuncScalar (const DataObject *src, const ito::complex128 &value, DataObject *dst, int cmpOp)
	template specialisation for compare function of type complex128 More...
	MAKEFUNCLIST (CmpFuncScalar)
template<typename _Tp >
RetVal	ShiftLFunc (DataObject *src, const unsigned char shiftbit)
	low-level, templated method which element-wisely shifts the values of the source matrix by a certain value to the left More...
template<>
RetVal	ShiftLFunc< ito::float32 > (DataObject *, const unsigned char)
	template specialisation for shift function of type float32 More...
template<>
RetVal	ShiftLFunc< ito::float64 > (DataObject *, const unsigned char)
	template specialisation for shift function of type float64 More...
template<>
RetVal	ShiftLFunc< ito::complex64 > (DataObject *, const unsigned char)
	template specialisation for shift function of type complex64 More...
template<>
RetVal	ShiftLFunc< ito::complex128 > (DataObject *, const unsigned char)
	template specialisation for shift function of type complex128 More...
template<>
RetVal	ShiftLFunc< ito::Rgba32 > (DataObject *, const unsigned char)
	template specialisation for shift function of type rgba32 More...
	MAKEFUNCLIST (ShiftLFunc)
template<typename _Tp >
RetVal	ShiftRFunc (DataObject *src, const unsigned char shiftbit)
	low-level, templated method which element-wisely shifts the values of the source matrix by a certain value to the right More...
template<>
RetVal	ShiftRFunc< ito::float32 > (DataObject *, const unsigned char)
	template specialisation for shift function of type float32 More...
template<>
RetVal	ShiftRFunc< ito::float64 > (DataObject *, const unsigned char)
	template specialisation for shift function of type float64 More...
template<>
RetVal	ShiftRFunc< ito::complex64 > (DataObject *, const unsigned char)
	template specialisation for shift function of type complex64 More...
template<>
RetVal	ShiftRFunc< ito::complex128 > (DataObject *, const unsigned char)
	template specialisation for shift function of type complex128 More...
template<>
RetVal	ShiftRFunc< ito::Rgba32 > (DataObject *, const unsigned char)
	template specialisation for shift function of type rgba32 More...
template<typename _Tp >
RetVal	BitAndFunc (const DataObject *dObj1, const DataObject *dObj2, DataObject *dObjRes)
	low-level, templated method which element-wisely executes a bitwise 'and' comparison between values of two dataObjects. More...
template<>
RetVal	BitAndFunc< ito::float32 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise and function of type float32 More...
template<>
RetVal	BitAndFunc< ito::float64 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise and function of type float64 More...
template<>
RetVal	BitAndFunc< ito::complex64 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise and function of type complex64 More...
template<>
RetVal	BitAndFunc< ito::complex128 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise and function of type complex128 More...
template<>
RetVal	BitAndFunc< ito::Rgba32 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise and function of type rgba32 More...
template<typename _Tp >
RetVal	BitOrFunc (const DataObject *dObj1, const DataObject *dObj2, DataObject *dObjRes)
	low-level, templated method which element-wisely executes a bitwise 'or' comparison between values of two dataObjects. More...
template<>
RetVal	BitOrFunc< ito::float32 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise or function of type float32 More...
template<>
RetVal	BitOrFunc< ito::float64 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise or function of type float64 More...
template<>
RetVal	BitOrFunc< ito::complex64 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise or function of type complex64 More...
template<>
RetVal	BitOrFunc< ito::complex128 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise or function of type complex128 More...
template<>
RetVal	BitOrFunc< ito::Rgba32 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise or function of type rgba32 More...
template<typename _Tp >
RetVal	BitXorFunc (const DataObject *dObj1, const DataObject *dObj2, DataObject *dObjRes)
	low-level, templated method which element-wisely executes a bitwise 'xor' comparison between values of two dataObjects. More...
template<>
RetVal	BitXorFunc< ito::float32 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise xor function of type float32 More...
template<>
RetVal	BitXorFunc< ito::float64 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise xor function of type float64 More...
template<>
RetVal	BitXorFunc< ito::complex64 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise xor function of type complex64 More...
template<>
RetVal	BitXorFunc< ito::complex128 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise xor function of type complex128 More...
template<>
RetVal	BitXorFunc< ito::Rgba32 > (const DataObject *, const DataObject *, DataObject *)
	template specialisation for bitwise xor function of type complex128 More...
template<typename _Tp >
RetVal	GetRangeFunc (DataObject *dObj, const int dtop, const int dbottom, const int dleft, const int dright)
	low-level, templated method for saving a shallow copy of a source cv::Mat_ to a destination cv::Mat_ with respect to given row- and col-ranges More...
template<typename _Tp >
RetVal	AdjustROIFunc (DataObject *dObj, int dtop, int dbottom, int dleft, int dright)
	low-level, templated method for adjusting the ROI of a data object by the given incremental values More...
template<typename _Tp >
RetVal	EyeFunc (const int size, uchar **dstMat)
	low-level, templated method for creating an eye-matrix More...
template<typename _Tp >
RetVal	ConjFunc (DataObject *dObj)
	low-level, templated method for calculating the conjugated value of each element within the ROI of this data object More...
template<>
RetVal	ConjFunc< int8 > (DataObject *)
	template specialization for data object of type int8. throws cv::Exception, since the data type is not complex.
template<>
RetVal	ConjFunc< uint8 > (DataObject *)
	template specialization for data object of type uint8. throws cv::Exception, since the data type is not complex.
template<>
RetVal	ConjFunc< int16 > (DataObject *)
	template specialization for data object of type int16. throws cv::Exception, since the data type is not complex.
template<>
RetVal	ConjFunc< uint16 > (DataObject *)
	template specialization for data object of type uint16. throws cv::Exception, since the data type is not complex.
template<>
RetVal	ConjFunc< int32 > (DataObject *)
	template specialization for data object of type int32. throws cv::Exception, since the data type is not complex.
template<>
RetVal	ConjFunc< uint32 > (DataObject *)
	template specialization for data object of type uint32. throws cv::Exception, since the data type is not complex.
template<>
RetVal	ConjFunc< ito::float32 > (DataObject *)
	template specialization for data object of type float32. throws cv::Exception, since the data type is not complex.
template<>
RetVal	ConjFunc< ito::float64 > (DataObject *)
	template specialization for data object of type float64. throws cv::Exception, since the data type is not complex.
template<>
RetVal	ConjFunc< ito::Rgba32 > (DataObject *)
	template specialization for data object of type float64. throws cv::Exception, since the data type is not complex.
template<>
RetVal	ConjFunc< int64 > (DataObject *)
	template specialization for data object of type int64. throws cv::Exception, since the data type is not complex.
template<typename _Tp >
RetVal	MulFunc (const DataObject *src1, const DataObject *src2, DataObject *res, const double)
template<typename _Tp >
RetVal	DivFunc (const DataObject *src1, const DataObject *src2, DataObject *res)
	low-level, templated method which does a element-wise division of elements in first source matrix by elements in second source matrix. More...
template<>
RetVal	DivFunc< Rgba32 > (const DataObject *src1, const DataObject *src2, DataObject *res)
	low-level, templated method which does a element-wise division of elements in first source matrix by elements in second source matrix. More...
template<typename _Tp >
RetVal	planeStackFunc (const DataObject *mats, const int &num, const unsigned int &axis, DataObject *res)
	low-level, templated method which stacks a sequence of dataObjects horizontally or vertically together . More...
template<typename _Tp >
RetVal	GrayScaleCastFunc (const DataObject *dObj, DataObject *resObj, double alpha=1.0)
template<typename _Tp >
void	extractColor (const DataObject *dObj, DataObject &resObj, const char *color, const int &type)
template<typename _Tp >
RetVal	lineCutFunc (const DataObject *src, const int *coordinates, const int &len, DataObject *res)
	low-level, templated method to take a line cut across the planes of a dataObject. More...
template<typename _TSrc , typename _TDest >
RetVal	CastFunc (const DataObject *srcObj, DataObject *resObj, double alpha, double beta)
	low-level templated method to cast each element of source matrix to another type. More...
template<typename _TDest >
RetVal	CastFuncFromComplex64 (const DataObject *srcObj, DataObject *resObj, double alpha, double beta)
template<typename _TDest >
RetVal	CastFuncFromComplex128 (const DataObject *srcObj, DataObject *resObj, double alpha, double beta)
template<typename _TDest >
RetVal	CastFuncFromRgba32 (const DataObject *srcObj, DataObject *resObj, double alpha, double beta)
template<typename _Tp >
RetVal	ConvertToFunc (const DataObject &lhs, DataObject &rhs, const int dest_type, const double alpha, const double beta)
	converts data in DataObject lhs to DataObject rhs with a given type More...
template<>
RetVal	ConvertToFunc< ito::complex64 > (const DataObject &lhs, DataObject &rhs, const int dest_type, const double alpha, const double beta)
template<>
RetVal	ConvertToFunc< ito::complex128 > (const DataObject &lhs, DataObject &rhs, const int dest_type, const double alpha, const double beta)
template<>
RetVal	ConvertToFunc< ito::Rgba32 > (const DataObject &lhs, DataObject &rhs, const int dest_type, const double alpha, const double beta)
	MAKEFUNCLIST (ConvertToFunc)
template<typename _CmplxTp , typename _Tp >
RetVal	AbsFunc (const DataObject *dObj, DataObject *resObj)
	low-level, double templated method to save the element-wise absolute value of each element in source matrix to result matrix More...
template<typename _Tp >
RetVal	AbsFuncReal (const DataObject *dObj, DataObject *resObj)
	low-level, templated method to save the element-wise absolute value of each element in source matrix to result matrix More...
DataObject	abs (const DataObject &dObj)
	high-level value which calculates the absolute value of each element of the input source data object and returns the resulting data object More...
template<typename _CmplxTp , typename _Tp >
RetVal	ArgFunc (const DataObject *dObj, DataObject *resObj)
	low-level, double templated method to save the element-wise argument of each element in source matrix to result matrix More...
DataObject	arg (const DataObject &dObj)
	high-level value which calculates the argument value of each element of the input source data object and returns the resulting data object More...
template<typename _CmplxTp , typename _Tp >
RetVal	RealFunc (const DataObject *dObj, DataObject *resObj)
	low-level, double templated method to save the element-wise real value of each element in source matrix to result matrix More...
DataObject	real (const DataObject &dObj)
	high-level value which calculates the real value of each element of the input source data object and returns the resulting data object More...
template<typename _CmplxTp , typename _Tp >
RetVal	SetRealFunc (DataObject *dObj, DataObject *valueObj)
	low-level, double templated method to save the element-wise real value of each element in source matrix to result matrix More...
template<typename _CmplxTp , typename _Tp >
RetVal	SetImagFunc (DataObject *dObj, DataObject *valueObj)
	low-level, double templated method to save the element-wise real value of each element in source matrix to result matrix More...
template<typename _CmplxTp , typename _Tp >
RetVal	ImagFunc (const DataObject *dObj, DataObject *resObj)
	low-level, double templated method to save the element-wise imaginary value of each element in source matrix to result matrix More...
DataObject	imag (const DataObject &dObj)
	high-level value which calculates the imaginary value of each element of the input source data object and returns the resulting data object More...
template<typename _Tp >
RetVal	MakeContinuousFunc (const DataObject &dObj, DataObject &resDObj)
	low-level, templated method which copies an incontinuously organized data object to a continuously organized resulting data object More...
DataObject	makeContinuous (const DataObject &dObj)
	high-level method which copies an incontinuously organized data object to a continuously organized resulting data object, which is returned More...
template<typename _Tp >
void	coutValue (const _Tp *val, char *buf)
template<>
void	coutValue (const ito::uint8 *val, char *buf)
template<>
void	coutValue (const ito::int8 *val, char *buf)
template<>
void	coutValue (const ito::uint16 *val, char *buf)
template<>
void	coutValue (const ito::int16 *val, char *buf)
template<>
void	coutValue (const ito::uint32 *val, char *buf)
template<>
void	coutValue (const ito::int32 *val, char *buf)
template<>
void	coutValue (const ito::float32 *val, char *buf)
template<>
void	coutValue (const ito::float64 *val, char *buf)
template<>
void	coutValue (const ito::complex64 *val, char *buf)
template<>
void	coutValue (const ito::complex128 *val, char *buf)
template<>
void	coutValue (const ito::Rgba32 *val, char *buf)
template<typename _Tp >
std::ostream &	coutPlane (std::ostream &out, const cv::Mat *plane, int firstLineIndent, int otherIndent)
template<typename _Tp >
std::ostream &	coutFunc (std::ostream &out, const DataObject &dObj)
std::ostream &	operator<< (std::ostream &out, const DataObject &dObj)
	streaming operator to stream the representation or contant of a data object
template<typename _Tp >
_Tp	numberConversion (ito::tDataType fromType, const void *scalar)
	templated method for converting a given scalar value to the data type, indicated by the template parameter More...
ito::tDataType	convertCmplxTypeToRealType (ito::tDataType cmplxType)
	method which returns the real data type of any given data type More...
ito::tDataType	guessDataTypeFromCVMat (const cv::Mat *mat, ito::RetVal &retval)
	method which guesses the dataObject type from a given cv::Mat* More...
template<typename _Tp >
ito::tDataType	getDataType (const _Tp *)
	method which returns the value of enumeration ito::tDataType, which corresponds to the type of the given pointer parameter. More...
template<>
ito::tDataType	getDataType (const uint8 *)
template<>
ito::tDataType	getDataType (const int8 *)
template<>
ito::tDataType	getDataType (const uint16 *)
template<>
ito::tDataType	getDataType (const int16 *)
template<>
ito::tDataType	getDataType (const uint32 *)
template<>
ito::tDataType	getDataType (const int32 *)
template<>
ito::tDataType	getDataType (const float32 *)
template<>
ito::tDataType	getDataType (const float64 *)
template<>
ito::tDataType	getDataType (const complex64 *)
template<>
ito::tDataType	getDataType (const complex128 *)
template<>
ito::tDataType	getDataType (const Rgba32 *)
template<typename _Tp >
ito::tDataType	getDataType2 ()
	method which returns the value of enumeration ito::tDataType, which corresponds to the template parameter (must be a pointer). More...
template<>
ito::tDataType	getDataType2< uint8 * > ()
template<>
ito::tDataType	getDataType2< int8 * > ()
template<>
ito::tDataType	getDataType2< uint16 * > ()
template<>
ito::tDataType	getDataType2< int16 * > ()
template<>
ito::tDataType	getDataType2< uint32 * > ()
template<>
ito::tDataType	getDataType2< int32 * > ()
template<>
ito::tDataType	getDataType2< float32 * > ()
template<>
ito::tDataType	getDataType2< float64 * > ()
template<>
ito::tDataType	getDataType2< complex64 * > ()
template<>
ito::tDataType	getDataType2< complex128 * > ()
template<>
ito::tDataType	getDataType2< Rgba32 * > ()
template<typename _Tp >
pcl::PointCloud< _Tp > *	getPointCloudPtrInternal (ito::PCLPointCloud &pc)
template<>
pcl::PointCloud< pcl::PointXYZ > *	getPointCloudPtrInternal (ito::PCLPointCloud &pc)
template<>
pcl::PointCloud< pcl::PointXYZI > *	getPointCloudPtrInternal (ito::PCLPointCloud &pc)
template<>
pcl::PointCloud< pcl::PointXYZRGBA > *	getPointCloudPtrInternal (ito::PCLPointCloud &pc)
template<>
pcl::PointCloud< pcl::PointNormal > *	getPointCloudPtrInternal (ito::PCLPointCloud &pc)
template<>
pcl::PointCloud< pcl::PointXYZINormal > *	getPointCloudPtrInternal (ito::PCLPointCloud &pc)
template<>
pcl::PointCloud< pcl::PointXYZRGBNormal > *	getPointCloudPtrInternal (ito::PCLPointCloud &pc)
template<typename _Tp >
const pcl::PointCloud< _Tp > *	getPointCloudPtrInternal (const ito::PCLPointCloud &pc)
template<>
const pcl::PointCloud< pcl::PointXYZ > *	getPointCloudPtrInternal (const ito::PCLPointCloud &pc)
template<>
const pcl::PointCloud< pcl::PointXYZI > *	getPointCloudPtrInternal (const ito::PCLPointCloud &pc)
template<>
const pcl::PointCloud< pcl::PointXYZRGBA > *	getPointCloudPtrInternal (const ito::PCLPointCloud &pc)
template<>
const pcl::PointCloud< pcl::PointNormal > *	getPointCloudPtrInternal (const ito::PCLPointCloud &pc)
template<>
const pcl::PointCloud< pcl::PointXYZINormal > *	getPointCloudPtrInternal (const ito::PCLPointCloud &pc)
template<>
const pcl::PointCloud< pcl::PointXYZRGBNormal > *	getPointCloudPtrInternal (const ito::PCLPointCloud &pc)
template<typename _Tp >
_Tp *	getPointPtrInternal (ito::PCLPoint &point)
template<>
pcl::PointXYZ *	getPointPtrInternal (ito::PCLPoint &point)
template<>
pcl::PointXYZI *	getPointPtrInternal (ito::PCLPoint &point)
template<>
pcl::PointXYZRGBA *	getPointPtrInternal (ito::PCLPoint &point)
template<>
pcl::PointNormal *	getPointPtrInternal (ito::PCLPoint &point)
template<>
pcl::PointXYZINormal *	getPointPtrInternal (ito::PCLPoint &point)
template<>
pcl::PointXYZRGBNormal *	getPointPtrInternal (ito::PCLPoint &point)
template<typename _Tp >
const _Tp *	getPointPtrInternal (const ito::PCLPoint &point)
template<>
const pcl::PointXYZ *	getPointPtrInternal (const ito::PCLPoint &point)
template<>
const pcl::PointXYZI *	getPointPtrInternal (const ito::PCLPoint &point)
template<>
const pcl::PointXYZRGBA *	getPointPtrInternal (const ito::PCLPoint &point)
template<>
const pcl::PointNormal *	getPointPtrInternal (const ito::PCLPoint &point)
template<>
const pcl::PointXYZINormal *	getPointPtrInternal (const ito::PCLPoint &point)
template<>
const pcl::PointXYZRGBNormal *	getPointPtrInternal (const ito::PCLPoint &point)
template<typename _Tp >
bool	IsOrganizedFunc (const ito::PCLPointCloud *pc)
template<typename _Tp >
void	SetWidthFunc (ito::PCLPointCloud *pc, uint32_t width)
template<typename _Tp >
uint32_t	GetWidthFunc (const ito::PCLPointCloud *pc)
template<typename _Tp >
size_t	GetSizeFunc (const ito::PCLPointCloud *pc)
template<typename _Tp >
uint32_t	GetHeightFunc (const ito::PCLPointCloud *pc)
template<typename _Tp >
void	SetHeightFunc (ito::PCLPointCloud *pc, uint32_t height)
template<typename _Tp >
bool	GetDenseFunc (const ito::PCLPointCloud *pc)
template<typename _Tp >
void	SetDenseFunc (ito::PCLPointCloud *pc, bool dense)
template<typename _Tp >
void	ScaleXYZFunc (ito::PCLPointCloud *pc, ito::float32 scaleX, ito::float32 scaleY, ito::float32 scaleZ)
template<typename _Tp >
void	MoveXYZFunc (ito::PCLPointCloud *pc, ito::float32 dX, ito::float32 dY, ito::float32 dZ)
template<typename _Tp >
std_msgs::Header	GetHeaderFunc (const ito::PCLPointCloud *pc)
template<typename _Tp >
std::string	GetFieldsListFunc (const ito::PCLPointCloud *pc)
template<typename _Tp >
std::vector< sensor_msgs::PointField >	GetFieldsInfoFunc (const ito::PCLPointCloud *pc)
template<typename _Tp >
unsigned char *	GenericPointAccessFunc (const ito::PCLPointCloud *pc, size_t &strideBytes)
template<typename _Tp >
void	PcAddFunc (ito::PCLPointCloud *pc1, const ito::PCLPointCloud *pc2, ito::PCLPointCloud *pcRes)
template<typename _Tp >
const ito::PCLPoint	GetItemFunc (const ito::PCLPointCloud *pc, size_t n)
template<typename _Tp >
void	SetItemFunc (ito::PCLPointCloud *, size_t, ito::PCLPoint &)
template<>
void	SetItemFunc< pcl::PointXYZ > (ito::PCLPointCloud *pc, size_t n, ito::PCLPoint &point)
template<>
void	SetItemFunc< pcl::PointXYZI > (ito::PCLPointCloud *pc, size_t n, ito::PCLPoint &point)
template<>
void	SetItemFunc< pcl::PointXYZRGBA > (ito::PCLPointCloud *pc, size_t n, ito::PCLPoint &point)
template<>
void	SetItemFunc< pcl::PointNormal > (ito::PCLPointCloud *pc, size_t n, ito::PCLPoint &point)
template<>
void	SetItemFunc< pcl::PointXYZINormal > (ito::PCLPointCloud *pc, size_t n, ito::PCLPoint &point)
template<>
void	SetItemFunc< pcl::PointXYZRGBNormal > (ito::PCLPointCloud *pc, size_t n, ito::PCLPoint &point)
template<typename _Tp >
void	PushBackFunc (ito::PCLPointCloud *, const ito::PCLPoint &)
template<>
void	PushBackFunc< pcl::PointXYZ > (ito::PCLPointCloud *pc, const ito::PCLPoint &point)
template<>
void	PushBackFunc< pcl::PointXYZI > (ito::PCLPointCloud *pc, const ito::PCLPoint &point)
template<>
void	PushBackFunc< pcl::PointXYZRGBA > (ito::PCLPointCloud *pc, const ito::PCLPoint &point)
template<>
void	PushBackFunc< pcl::PointNormal > (ito::PCLPointCloud *pc, const ito::PCLPoint &point)
template<>
void	PushBackFunc< pcl::PointXYZINormal > (ito::PCLPointCloud *pc, const ito::PCLPoint &point)
template<>
void	PushBackFunc< pcl::PointXYZRGBNormal > (ito::PCLPointCloud *pc, const ito::PCLPoint &point)
template<typename _Tp >
bool	EmptyFunc (const ito::PCLPointCloud *pc)
template<typename _Tp >
void	ReserveResizeFunc (ito::PCLPointCloud *pc, size_t n, bool reserveNotResize)
template<typename _Tp >
void	ClearFunc (ito::PCLPointCloud *pc)
template<typename _Tp >
void	EraseFunc (ito::PCLPointCloud *pc, uint32_t startIndex, uint32_t endIndex)
template<typename _Tp >
void	InsertFunc (ito::PCLPointCloud *, uint32_t, const ito::PCLPoint &)
template<>
void	InsertFunc< pcl::PointXYZ > (ito::PCLPointCloud *pc, uint32_t index, const ito::PCLPoint &point)
template<>
void	InsertFunc< pcl::PointXYZI > (ito::PCLPointCloud *pc, uint32_t index, const ito::PCLPoint &point)
template<>
void	InsertFunc< pcl::PointXYZRGBA > (ito::PCLPointCloud *pc, uint32_t index, const ito::PCLPoint &point)
template<>
void	InsertFunc< pcl::PointNormal > (ito::PCLPointCloud *pc, uint32_t index, const ito::PCLPoint &point)
template<>
void	InsertFunc< pcl::PointXYZINormal > (ito::PCLPointCloud *pc, uint32_t index, const ito::PCLPoint &point)
template<>
void	InsertFunc< pcl::PointXYZRGBNormal > (ito::PCLPointCloud *pc, uint32_t index, const ito::PCLPoint &point)
bool	operator== (const ByteArray &a1, const char *a2)
	comparison operator that returns true if the content of a1 is equal to the given zero-terminated string a2.
bool	operator== (const char *a1, const ByteArray &a2)
	comparison operator that returns true if the content of a2 is equal to the given zero-terminated string a1.
bool	operator!= (const ByteArray &a1, const char *a2)
	comparison operator that returns true if the content of a1 is not equal to the given zero-terminated string a2.
bool	operator!= (const char *a1, const ByteArray &a2)
	comparison operator that returns true if the content of a2 is not equal to the given zero-terminated string a1.
ito::int8	getInt8 (const uchar **ppval)
ito::uint8	getUInt8 (const uchar **ppval)
ito::int16	getInt16LE (const uchar **ppval)
ito::int16	getInt16BE (const uchar **ppval)
ito::uint16	getUInt16LE (const uchar **ppval)
ito::uint16	getUInt16BE (const uchar **ppval)
ito::int32	getInt32LE (const uchar **ppval)
ito::uint32	getUInt32LE (const uchar **ppval)
ito::uint32	getUInt32BE (const uchar **ppval)
qint64	getInt64LE (const uchar **ppval)
qint64	getInt64BE (const uchar **ppval)
quint64	getUInt64LE (const uchar **ppval)
quint64	getUInt64BE (const uchar **ppval)
ito::float32	getFloat32LE (const uchar **ppval)
ito::float32	getFloat32BE (const uchar **ppval)
ito::float64	getFloat64LE (const uchar **ppval)
ito::float64	getFloat64BE (const uchar **ppval)
ito::int16	swapInt16 (ito::int16 val)
ito::uint16	swapUInt16 (ito::uint16 val)
ito::int32	swapInt32 (ito::int32 val)
ito::uint32	swapUInt32 (ito::uint32 val)
ito::float32	swapFloat32 (ito::float32 val)
ito::float64	swapFloat64 (ito::float64 val)
	reads exactly numBytes from device into data and returns an error if less or no data is available
ito::RetVal ITOMCOMMONQT_EXPORT	readFromDevice (QIODevice *device, char *data, qint64 numBytes)
ito::int32	getInt32BE (const uchar **ppval)
ito::RetVal ITOMCOMMONQT_EXPORT	checkParamVector (QVector< ito::Param > *params)
	checks param vector More...
ito::RetVal ITOMCOMMONQT_EXPORT	checkParamVectors (QVector< ito::Param > *paramsMand, QVector< ito::Param > *paramsOpt, QVector< ito::Param > *paramsOut)
	verifies that the three param vectors are not NULL More...
ITOMCOMMONQT_EXPORT ito::Param *	getParamByName (QVector< ito::Param > *paramVec, const char *name, ito::RetVal *retval)
	brief returns a parameter from the parameter-vector, that fits to a specific name More...
ITOMCOMMONQT_EXPORT ito::ParamBase *	getParamByName (QVector< ito::ParamBase > *paramVec, const char *name, ito::RetVal *retval=NULL)
ITOMCOMMONQT_EXPORT QHash< QString, ito::Param * >	createParamHashTable (QVector< ito::Param > *paramVec)
bool ITOMCOMMONQT_EXPORT	checkNumericParamRange (const ito::Param &param, double &value, bool *ok=NULL)
ito::RetVal ITOMCOMMONQT_EXPORT	parseParamName (const QString &name, QString &paramName, bool &hasIndex, int &index, QString &additionalTag)
	parses parameter name with respect to regular expression, assigned for parameter-communcation with plugins More...
ito::RetVal ITOMCOMMONQT_EXPORT	getParamValue (const QMap< QString, Param > *m_params, const QString &key, ito::Param &value, QString &pkey, int &index)
ito::RetVal ITOMCOMMONQT_EXPORT	setParamValue (const QMap< QString, Param > *m_params, const QString &key, const ito::ParamBase &value, QString &pkey, int &index)
template<typename _Tp >
bool	isNotZero (_Tp value)
	method returns whether a given variable is not equal to zero. More...
template<>
bool	isNotZero< float32 > (float32 value)
	Check if a value is equal to zero for float32.
template<>
bool	isNotZero< float64 > (float64 value)
	Check if a value is equal to zero for float64.
template<typename _Tp >
bool	isFinite (_Tp)
	method returns whether a given variable is finite. More...
template<>
bool	isFinite< float32 > (float32 value)
	Check if a value is finite float32 values.
template<>
bool	isFinite< float64 > (float64 value)
	Check if a value is finite float64 values.
template<>
bool	isFinite< complex64 > (complex64 value)
	Check if both components of complex64 value are finite.
template<>
bool	isFinite< complex128 > (complex128 value)
	Check if both components of complex128 value are finite.
template<typename _Tp >
bool	isNaN (_Tp value)
	method returns whether a given variable is NaN / not a Number but maybe Inf. More...
template<>
bool	isNaN< float32 > (float32 value)
	Check if a value is isNaN float32 values.
template<>
bool	isNaN< float64 > (float64 value)
	Check if a value is isNaN float64 values.
template<>
bool	isNaN< complex64 > (complex64 value)
	Check if one of the components of complex64 values are not a number.
template<>
bool	isNaN< complex128 > (complex128 value)
	Check if one of the components of complex128 values are not a number.
template<typename _Tp >
bool	isInf (_Tp)
	method returns whether a given variable is Inf / not may be NaN. More...
template<>
bool	isInf< float32 > (float32 value)
	Check if a value is infinite float32 values.
template<>
bool	isInf< float64 > (float64 value)
	Check if a value is infinite float64 values.
template<>
bool	isInf< complex64 > (complex64 value)
	Check if one of the components of complex64 values are infinite.
template<>
bool	isInf< complex128 > (complex128 value)
	Check if one of the components of complex128 values are infinite.
template<typename _Tp >
bool	isZeroValue (_Tp v, _Tp)
	method returns whether a given variable is equal to zero. More...
template<>
bool	isZeroValue (Rgba32 v, Rgba32)
template<>
bool	isZeroValue (float32 v, float32 epsilon)
template<>
bool	isZeroValue (float64 v, float64 epsilon)
template<>
bool	isZeroValue (std::complex< ito::float32 > v, std::complex< ito::float32 > epsilon)
template<>
bool	isZeroValue (std::complex< ito::float64 > v, std::complex< ito::float64 > epsilon)
template<typename _Tp >
bool	areEqual (_Tp a, _Tp b)
	method returns whether two given numbers of the same type are equal.
template<>
bool	areEqual (float32 a, float32 b)
template<>
bool	areEqual (float64 a, float64 b)
template<>
bool	areEqual (complex64 a, complex64 b)
template<>
bool	areEqual (complex128 a, complex128 b)
QDataStream ITOMSHAPE_EXPORT &	operator<< (QDataStream &out, const ito::Shape &shape)
QDataStream ITOMSHAPE_EXPORT &	operator>> (QDataStream &in, ito::Shape &shape)
ITOMCOMMONQT_EXPORT ito::RetVal	formatDoubleWithUnit (QStringList scaleThisUnitsOnly, QString unitIn, double dVal, double &dValOut, QString &unitOut)
	< Function to convert double values with unit to scaled values with scaled units (0.01m -> 10mm) More...
ITOMCOMMONQT_EXPORT ito::RetVal	generateAutoSaveParamFile (QString plugInName, QFile &paramFile)
	loadXML2QLIST loads parameters from an XML-File and saves them to paramList More...
ITOMCOMMONQT_EXPORT ito::RetVal	loadXML2QLIST (QMap< QString, ito::Param > *paramList, QString id, QFile &paramFile)
	saveQLIST2XML writes parameters from paramList to an XML-File
ITOMCOMMONQT_EXPORT ito::RetVal	saveQLIST2XML (QMap< QString, ito::Param > *paramList, QString id, QFile &paramFile)
	mergeQLists copies parameters from newList to oldList and performs some checks
ITOMCOMMONQT_EXPORT ito::RetVal	mergeQLists (QMap< QString, ito::Param > *oldList, QMap< QString, ito::Param > *newList, bool checkAutoSave, bool deleteUnchangedParams=false)
	Save a dataObject to harddrive in a readable ITO-XML-Format (.ido or .idh)
ITOMCOMMONQT_EXPORT ito::RetVal	saveDOBJ2XML (ito::DataObject *dObjOut, QString folderFileName, bool onlyHeaderObjectFile=false, bool doubleAsBinary=false)
	Import a dataObject from harddrive, saved in the ITO-XML-Format (.ido or .idh) More...
ITOMCOMMONQT_EXPORT ito::RetVal	loadXML2DOBJ (ito::DataObject *dObjIn, QString folderFileName, bool onlyHeaderObjectFile=false, bool appendEnding=true)
void	paramHelperSetValue (ito::Param &param, ito::ParamBase value, const int pos)
QPolygonF	circle2Polygon (const QPointF &center, qreal radius, qreal tol)
int	ramerDouglasPeuckerIter (RamerDouglasPeuckerData &data, int current_index)
RetVal	loadXML2QLIST (QMap< QString, Param > *paramList, QString id, QFile &paramFile)
RetVal	saveQLIST2XML (QMap< QString, Param > *paramList, QString id, QFile &paramFile)
RetVal	mergeQLists (QMap< QString, Param > *oldList, QMap< QString, Param > *newList, bool checkAutoSave, bool deleteUnchangedParams)
RetVal	writeObjectHeaderToFileV1 (QXmlStreamWriter &stream, DataObject *dObjOut, bool doubleAsBinary, int &elementsize)
	This helper function writes the header of the Object to the xml stream. This helper function writes the header (dims, sizes, type) of an object and the metaData (complete DataObjectTags without tagsMap) from the Object to the xml stream. The values of the header are stored as string. The values of each axis-tag / value-tag / rotation matrix are in case of string-type directly written to the stream or in case of double converted to either strings directly (15 significat digits, >32Bit) or stored as lostfree binary (QByteArray::toBase64() to avoid XML-conflict). WARNING: Do not change the header (dims, sizes, type) information or the value of tags exported as binary (d2b). More...
RetVal	writeObjectTagsToFileV1 (QXmlStreamWriter &stream, DataObject *dObjOut, bool doubleAsBinary)
	This helper function writes the tags defined in the tagMap (DataObjectTags) from the Object to the xml stream. This helper function writes the tags defined in the tagMap (DataObjectTags) from the Object to the xml stream. Therefore the values of each tag are in case of string-type directly written to the stream or in case of double converted to either strings directly (15 significat digits, >32Bit) or stored as lostfree binary (QByteArray::toBase64() to avoid XML-conflict). WARNING: Do not change information or the value of tags exported as binary (d2b). More...
RetVal	writeObjectDataToFileV1 (QXmlStreamWriter &stream, DataObject *dObjOut, int elementsize)
	This helper function writes the data(cv::mats) from the Object to the xml stream. This helper function writes the data(cv::mats) from the Object to the xml stream. Therefore the data is converted using QByteArray::toBase64() to avoid XML-conflict with the binary data. More...
bool	readTillNext (QXmlStreamReader &stream, int &times, int maxtimes)
	This helper function reads the stream till the next startElement. The Qt-Function readNextStartElement sometimes stops at the end-element (:P). So the function tries to read until it reaches the next startelement but only for maxtimes trys the Function checks if the attribute exists and than tries to convert to the value of the attribute either from binary or with string to double functions. More...
RetVal	readDoubleFromXML (QXmlStreamAttributes &attrStream, QString &Element, QString &Attrib, double &val, bool isBinary)
	This helper function extracts a double from the xml-Attributes of the Stream This helper function extracts a double from the xml-Attributes of the Stream copied by the caller with the attrStream = attrStream = stream.attributes();. the Function checks if the attribute exists and than tries to convert to the value of the attribute either from binary or with string to double functions. More...
RetVal	readStdStringFromXML (QXmlStreamAttributes &attrStream, QString &Element, QString &Attrib, std::string &val)
	This helper function extracts a std::string from the xml-Attributes of the Stream This helper function extracts a std::string from the xml-Attributes of the Stream copied by the caller with the attrStream = attrStream = stream.attributes();. the Function checks if the attribute exists and than tries to convert to the value of the attribute from QString to std::string. More...
RetVal	createObjectFromXMLV1 (QXmlStreamReader &stream, DataObject &dObjIn, int &elementsize)
	This function creates an dataObject from the header of the xml-file This function creates an dataObject from the header of the xml-file by parsing the XML-stream. The first start element, already read by the calling function must contain the attributes dims, dataType and dim0..dimn-2, dimX, dimY. More...
RetVal	loadObjectHeaderFromXMLV1 (QXmlStreamReader &stream, DataObject &dObjIn)
	This function fills the MetaData (DataObjectTags) of an allocated dataObject from the values of an xml-file This function fills the MetaData (DataObjectTags) of an allocated dataObject from the values of an xml-file. This includes the axis-Tags (offset, scale, unit, description), value-Tags ((offset), (scale), unit, description) and the rotation matrix. It does not include the tag-Space (std::map<std::string, DataObjectTagType> m_tags) (e.g. protocol ...) More...
RetVal	loadTagSpaceFromXMLV1 (QXmlStreamReader &stream, DataObject &dObjIn)
	This function fills the tagsSpace (DataObjectTags) of an allocated dataObject from the values of an xml-file This function fills the tagsSpace (DataObjectTags) of an allocated dataObject from the values of an xml-file. This onlye includes the tag-Space (std::map<std::string, DataObjectTagType> m_tags) (e.g. protocol ...) and does not include the axis-Tags (offset, scale, unit, description), value-Tags ((offset), (scale), unit, description) and the rotation matrix. More...
RetVal	loadDataFromXMLV1 (QXmlStreamReader &stream, DataObject &dObjIn, int elementsize)
	This function copies the CDATA from the xml-file to the allocated dataObject. This function copies the CDATA from the xml-file to the allocated dataObject. The data was before packed (substitution of xml-registered characters) during saving and is unpacked here. The data is stored plane-wise. The function checks if the plane-size if the object is equal to the imported size. More...
static QIcon	drawCheckBox (bool value)
void	dumpChannels (const QList< QSharedPointer< Channel > > &channels, AbstractNode *an, const QString &prefix)

Variables
void **	ITOM_API_FUNCS_GRAPH
void *	ITOM_API_FUNCS_GRAPH_ARR []
struct ito::PyCMap	pyCMap []
const int	PAPERCOLOR = 1
const int	WHITESPACECOLOR = 4
const int	UNMATCHEDBRACECOLOR = 5
const int	MATCHEDBRACECOLOR = 6
const int	MARKERERRORCOLOR = 7
const int	MARKERCURRENTCOLOR = 8
const int	MARKERINPUTCOLOR = 9
const int	CARETCOLOR = 10
const int	SELECTIONCOLOR = 11
const int	MARKERSAMESTRINGCOLOR = 12
const int	MARKERSCRIPTERRORCOLOR = 13
void **	ITOM_API_FUNCS
void *	ITOM_API_FUNCS_ARR []
tCoutFunc	fListCout []
const uint32	paramFlagMask = 0xFFFF0000
	bits of type lying within this mask are flags (e.g. typeNoAutosave, typeReadonly...)
const uint32	paramTypeMask = 0x0000FFFF
	bits of param type lying withing this mask describe the type (typeNoAutosave must be included there)

Detailed Description

< this is for the plugin param save / load

< this is for the dataobject save / load

Enumeration Type Documentation

enum ito::PlotDataType

enumeration that describes the type of input data that a designer plot widget accepts

Enumerator
DataObjLine	1xN or Nx1 data object
DataObjPlane	2D data object
DataObjPlaneStack	data object with more than one plane
PointCloud	point cloud
PolygonMesh	polygon mesh

enum ito::tActuatorStatus

tActuatorStatus enumeration

flags used for describing the status of one axis of an actuator plugin.

These flags are intended to be combined in the status bitmask. Usually the bitmask for each mask is saved in the vector ito::AddInActuator::m_currentStatus of an actuator plugin.

The bitmask is divided into different topical areas (moving flags, switches, general status).

Enumerator
actuatorUnknown	moving status of axis is unknown
actuatorInterrupted	movement has been interrupted by the user, axis is immediately stopped
actuatorMoving	axis is currently moving
actuatorAtTarget	axis reached target
actuatorTimeout	no signal from axis, timeout
actuatorEndSwitch	axis reached an undefined end switch
actuatorLeftEndSwitch	axis reached the specified left end switch (if set, also set actuatorEndSwitch), deprecated
actuatorRightEndSwitch	axis reached the specified right end switch (if set, also set actuatorEndSwitch), deprecated
actuatorEndSwitch1	axis reached the specified left end switch (if set, also set actuatorEndSwitch)
actuatorEndSwitch2	axis reached the specified left end switch (if set, also set actuatorEndSwitch)
actuatorRefSwitch	axis reached an undefined reference switch
actuatorLeftRefSwitch	axis reached the specified left reference switch (if set, also set actuatorRefSwitch), deprecated
actuatorRightRefSwitch	axis reached the specified right reference switch (if set, also set actuatorRefSwitch), deprecated
actuatorRefSwitch1	axis reached the specified right reference switch (if set, also set actuatorRefSwitch)
actuatorRefSwitch2	axis reached the specified right reference switch (if set, also set actuatorRefSwitch)
actuatorAvailable	axis is generally available
actuatorEnabled	axis is enabled for movements
actMovingMask	bitmask that marks all bits related to the movement
actEndSwitchMask	bitmask that marks all bits related to end switches
actRefSwitchMask	bitmask that marks all bits related to reference switches
actSwitchesMask	bitmask that marks all bits related to reference and end switches
actStatusMask	bitmask that marks all status flags

enum ito::tAutoLoadPolicy

Enumerator
autoLoadAlways	always loads xml file by addInManager
autoLoadNever	never automatically loads parameters from xml-file (default)
autoLoadKeywordDefined	only loads parameters if keyword autoLoadParams=1 exists in python-constructor

enum ito::tAutoSavePolicy

Enumerator
autoSaveAlways	always saves parameters to xml-file at shutdown
autoSaveNever	never saves parameters to xml-file at shutdown (default)

enum ito::tCompareResult

enumeration to describe the result of a parameter comparison (e.g. apiCompareParam)

enum ito::tDataType

DataType enumeration This enum holds the possible values for DataObject matrices.

Enumerator
tInt8	integer, 8bit
tUInt8	unsigned integer, 8bit
tInt16	integer, 16bit
tUInt16	unsigned integer, 16bit
tInt32	integer, 32bit
tUInt32	unsigned integer, 32bit (not fully supported)
tFloat32	float, 32bit
tFloat64	double (64bit)
tComplex64	complex value with real and imaginary part of type float32
tComplex128	complex value with real and imaginary part of type float64
tRGBA32	a uint32 / vec4u value coded as 0xAARRGGBB

enum ito::tMsgType

MsgType enumeration This enum holds the possible values for any message type (for qDebugStream e.g.)

This enumeration is deprecated and will be removed in future versions. It is currently unused. Don't use it again.

enum ito::tPCLPointType

PCLPointType enumeration This enum holds the possible values for point types supported by the wrapper of the point-cloud library in itom.

Enumerator
pclInvalid	invalid point
pclXYZ	point with x,y,z-value
pclXYZI	point with x,y,z and intensity value
pclXYZRGBA	point with x,y,z and r,g,b,a
pclXYZNormal	point with x,y,z value, its normal vector nx,ny,nz and a curvature value
pclXYZINormal	point with the same values than pclXYZNormal and an additional intensity value
pclXYZRGBNormal	point with x,y,z and r,g,b and normal vector (including curvature)

enum ito::tPluginLoadStatusFlag

PluginLoadStatusFlag enumeration This enum holds the four possible return states for loaded DLLs Ok, Warning, Error and Ignored

Enumerator
plsfOk	ok
plsfWarning	warning
plsfError	error
plsfIgnored	ignored
plsfRelDbg	is Dbg version
plsfIncompatible	incompatible to this itom version

enum ito::tPluginType

tPluginType enumeration

used to describe the plugin type and subtype (in case of DataIO main type) e.g. typeDataIO|typeGrabber for a frame grabber

Enumerator
typeDataIO	base type for data input and output (cameras, AD-converter, display windows...)
typeActuator	base type for actuators and motors
typeAlgo	base type for algorithm plugin
typeGrabber	subtype of dataIO for cameras (grabbers), use this type in combination with typeDataIO (OR-combination)
typeADDA	subtype of dataIO for AD and DA-converters, use this type in combination with typeDataIO (OR-combination)
typeRawIO	subtype of dataIO for further input-output-devices (like display windows), use this type in combination with typeDataIO (OR-combination)

enum ito::tRetValue

RetValue enumeration This enum holds the three possible return states Ok, Warning and Error

Enumerator
retOk	ok
retWarning	warning
retError	error

enum ito::tStreamMessageType

enumeration of stream (std::cout, std::cerr, std::cin) message type

Function Documentation

DATAOBJ_EXPORT DataObject ito::abs

(

const DataObject &

dObj

)

high-level value which calculates the absolute value of each element of the input source data object and returns the resulting data object

Parameters

&dObj

Returns

new data object with absolute values

Exceptions

cv::Exception

if unknown data type

See also

AbsFunc, AbsFuncReal

calculates the absolute values of each element in the given data object and returns the result as new data object

template<typename _CmplxTp , typename _Tp >

RetVal ito::AbsFunc	(	const DataObject *	dObj,
		DataObject *	resObj
	)

low-level, double templated method to save the element-wise absolute value of each element in source matrix to result matrix

This method takes the absolute value of a complex valued input matrix and stores it in the equivalent real typed result matrix

Parameters

*dObj	is source matrix, must have complex type
*resObj	is the resulting data object, which has the real data type which corresponds to the complex type

Returns

retOk

See also

std::abs

template<typename _Tp >

RetVal ito::AbsFuncReal	(	const DataObject *	dObj,
		DataObject *	resObj
	)

low-level, templated method to save the element-wise absolute value of each element in source matrix to result matrix

This method takes the absolute value of a real typed input matrix and stores it in the equivalent real typed result matrix

Parameters

*dObj	is source matrix, must have real value
*resObj	is the resulting data object

Returns

retOk

See also

std::abs

template<typename _Tp >

RetVal ito::AddFunc	(	const DataObject *	dObj1,
		const DataObject *	dObj2,
		DataObject *	dObjRes
	)

Sets all or some of the array elements to the specific value.

Parameters

assigned	scalar converted to the actual array type
mask	Operation mask of the same size as *this and type uint8 or empty data object if no mask should be considered (default)

Returns

retError in case of error

See also

AssignScalarValuelow-level, templated method for element-wise addition of two given data objects.

dObjRes = dObj1 + dObj2

Parameters

*dObj1	is the first data object
*dObj2	is the second data object
*dObjRes	is the pointer to the data object, where the values will be written to. This data object must already be allocated.

Remarks

The size check for all data objects must be done before.

Returns

retOk

See also

operator +=, operator +

template<typename _Tp >

RetVal ito::AdjustROIFunc	(	DataObject *	dObj,
		int	dtop,
		int	dbottom,
		int	dleft,
		int	dright
	)

low-level, templated method for adjusting the ROI of a data object by the given incremental values

Parameters

*dObj	is the data object, whose boundaries should be adjusted
dtop	- The shift of the top submatrix boundary upwards (positive value means upwards)
dbottom	- The shift of the bottom submatrix boundary downwards (positive value means downwards)
dleft	- The shift of the left submatrix boundary to the left (positive value means to the left)
dright	- The shift of the right submatrix boundary to the right (positive value means to the right)

Remarks

for any n-dimensional data object, the ROI of every matrix-plane is adjusted, even if any specific matrix-plane is temporarily not inside of the ROI

Returns

retOk

ito::RetVal ito::apiFCheckAndSetParamVal	(	QVariant *	tempParam,
		ito::ParamBase *	param,
		int *	set
	)

Helper function to check and set initialisation parameters in the initialisation parameter list

Parameters

[in]	tempParam	QVariant holding the value to set
[in,out]	param	the param in the parameter list, that is set
[out]	set	indicator whether the parameter was set or not

Returns

retOk on success, retError otherwise

The function checks if the types of the passed python parameter and the parameter are compatible and sets the parameter value if it is possible. If the paramter cannot be set an error is returned.

ito::RetVal ito::apiFParseInitParams	(	QVector< ito::ParamBase > *	initParamListMand,
		QVector< ito::ParamBase > *	initParamListOpt,
		QVector< QVariant > *	params
	)

Function to read mandatory and optional parameter lists from a given python parameter list according to the plugins definition

Parameters

[in,out]	initParamListMand	vector holding the mandatory initialisation parameters (filled with default values), the default values are overwritten with the passed values
[in,out]	initParamListOpt	vector holding the optional initialisation parameters (filled with default values), the default values are overwritten with the passed values
[in]	args	list with python arguments
[in]	kwds	list with named python arguments

Returns

returns ito::retOk if the number and type of parameters was correct, ito::retError otherwise

The function takes as input the vectors with the madatory and optional input parameters used for the plugin initialisation. These vectors must be previously be read using the function getInitParams. The default values of the parameters are overwritten with the values given by python. In case the number or parameters or a parameter type is incorrect the function will abort with an error.

DATAOBJ_EXPORT DataObject ito::arg

(

const DataObject &

dObj

)

high-level value which calculates the argument value of each element of the input source data object and returns the resulting data object

Parameters

&dObj

Returns

new data object with argument values

Exceptions

cv::Exception

if undefined data type

See also

ArgFunc

calculates the argument of each element in the given data object and returns the result as new data object

template<typename _CmplxTp , typename _Tp >

RetVal ito::ArgFunc	(	const DataObject *	dObj,
		DataObject *	resObj
	)

low-level, double templated method to save the element-wise argument of each element in source matrix to result matrix

This method takes the element-wise argument of a complex valued input matrix and stores it in the equivalent real typed result matrix

Parameters

*dObj	is source matrix, must have complex type
*resObj	is the resulting data object, which has the real data type which corresponds to the complex type

Returns

retOk

See also

std::abs

template<typename _Tp >

RetVal ito::AssignScalarFunc	(	DataObject *	src,
		const ito::tDataType	type,
		const void *	scalar
	)

low-level, templated helper method to assign the given scalar to every element within its ROI in DataObject src.

The scalar value is converted to the type of the source data object

Parameters

*src	is the source data object whose elements will be modified
type	is the data type of the scalar value
*scalar	is a void pointer to the scalar value

Returns

retOk

Exceptions

cv::exception

if conversion of scalar to dataObject's type is not possible

See also

numberConcversion

template<typename _Tp >

RetVal ito::AssignScalarMaskFunc	(	DataObject *	src,
		const DataObject *	mask,
		const ito::tDataType	type,
		const void *	scalar
	)

low-level, templated helper method to assign the given scalar to every element within its ROI in DataObject src.

The scalar value is converted to the type of the source data object

Parameters

*src	is the source data object whose elements will be modified
type	is the data type of the scalar value
*scalar	is a void pointer to the scalar value

Returns

retOk

Exceptions

cv::exception

if conversion of scalar to dataObject's type is not possible

See also

numberConcversion

template<typename _Tp >

RetVal ito::BitAndFunc	(	const DataObject *	dObj1,
		const DataObject *	dObj2,
		DataObject *	dObjRes
	)

low-level, templated method which element-wisely executes a bitwise 'and' comparison between values of two dataObjects.

Parameters

*dObj1	is the first data object
*dObj2	is the second data object
*dObjRes	is the data object, where the result is stored

Exceptions

cv::Exception

for unsupported data types (template specialization)

Returns

retOk

template<>

RetVal ito::BitAndFunc< ito::complex128 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise and function of type complex128

Exceptions

cv::Exception

since this operation is not defined for that input type

template<>

RetVal ito::BitAndFunc< ito::complex64 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise and function of type complex64

Exceptions

cv::Exception

since this operation is not defined for that input type

template<>

RetVal ito::BitAndFunc< ito::float32 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise and function of type float32

Exceptions

cv::Exception

since this operation is not defined for that input type

template<>

RetVal ito::BitAndFunc< ito::float64 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise and function of type float64

Exceptions

cv::Exception

since this operation is not defined for that input type

template<>

RetVal ito::BitAndFunc< ito::Rgba32 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise and function of type rgba32

Exceptions

cv::Exception

since this operation is not defined for that input type

template<typename _Tp >

RetVal ito::BitOrFunc	(	const DataObject *	dObj1,
		const DataObject *	dObj2,
		DataObject *	dObjRes
	)

low-level, templated method which element-wisely executes a bitwise 'or' comparison between values of two dataObjects.

Parameters

*dObj1	is the first data object
*dObj2	is the second data object
*dObjRes	is the data object, where the result is stored

Exceptions

cv::Exception

for unsupported data types (template specialization)

Returns

retOk

template<>

RetVal ito::BitOrFunc< ito::complex128 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise or function of type complex128

Exceptions

cv::Exception

since this operation is not defined for that input type

template<>

RetVal ito::BitOrFunc< ito::complex64 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise or function of type complex64

Exceptions

cv::Exception

since this operation is not defined for that input type

template<>

RetVal ito::BitOrFunc< ito::float32 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise or function of type float32

Exceptions

cv::Exception

since this operation is not defined for that input type

template<>

RetVal ito::BitOrFunc< ito::float64 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise or function of type float64

Exceptions

cv::Exception

since this operation is not defined for that input type

template<>

RetVal ito::BitOrFunc< ito::Rgba32 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise or function of type rgba32

Exceptions

cv::Exception

since this operation is not defined for that input type

template<typename _Tp >

RetVal ito::BitXorFunc	(	const DataObject *	dObj1,
		const DataObject *	dObj2,
		DataObject *	dObjRes
	)

low-level, templated method which element-wisely executes a bitwise 'xor' comparison between values of two dataObjects.

Parameters

*dObj1	is the first data object
*dObj2	is the second data object
*dObjRes	is the data object, where the result is stored

Exceptions

cv::Exception

for unsupported data types (template specialization)

Returns

retOk

template<>

RetVal ito::BitXorFunc< ito::complex128 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise xor function of type complex128

Exceptions

cv::Exception

since this operation is not defined for that input type

template<>

RetVal ito::BitXorFunc< ito::complex64 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise xor function of type complex64

Exceptions

cv::Exception

since this operation is not defined for that input type

template<>

RetVal ito::BitXorFunc< ito::float32 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise xor function of type float32

Exceptions

cv::Exception

since this operation is not defined for that input type

template<>

RetVal ito::BitXorFunc< ito::float64 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise xor function of type float64

Exceptions

cv::Exception

since this operation is not defined for that input type

template<>

RetVal ito::BitXorFunc< ito::Rgba32 >	(	const DataObject *	,
		const DataObject *	,
		DataObject *
	)

template specialisation for bitwise xor function of type complex128

Exceptions

cv::Exception

since this operation is not defined for that input type

template<typename _TSrc , typename _TDest >

RetVal ito::CastFunc	(	const DataObject *	srcObj,
		DataObject *	resObj,
		double	alpha,
		double	beta
	)

low-level templated method to cast each element of source matrix to another type.

The result is stored in the result matrix. Optionally a scaling and offsetting is possible.

Parameters

*srcObj	is the source data object
*resObj	is the result data object
alpha	is the scaling factor (default 1.0)
beta	is the offset value (default 0.0)

Returns

0

Exceptions

cv::Exception

if cast failed

See also

cv::saturate_cast

ito::RetVal ito::checkAndSetParamVal	(	PyObject *	tempObj,
		ito::Param *	param,
		int *	set
	)

Helper function to check and set initialisation parameters in the initialisation parameter list

Parameters

[in]	tempObj	python object holding the value to set
[in,out]	param	the param in the parameter list, that is set
[out]	set	indicator whether the parameter was set or not

Returns

retOk on success, retError otherwise

The function checks if the types of the passed python parameter and the parameter are compatible and sets the parameter value if it is possible. If the paramter cannot be set an error is returned.

ito::RetVal ito::checkParamVector

(

QVector< ito::Param > *

params

)

checks param vector

Parameters

[in]

params

is a pointer to QVector<ito::Param>. This pointer is checked.

Returns

ito::RetVal, that contains an error if params is NULL

ito::RetVal ito::checkParamVectors	(	QVector< ito::Param > *	paramsMand,
		QVector< ito::Param > *	paramsOpt,
		QVector< ito::Param > *	paramsOut
	)

verifies that the three param vectors are not NULL

If any of the given input parameters of type QVector<ito::Param>* are NULL, a ito::RetVal is returned, that contains an error. Use this method in any algorithm-method in order to check the given input.

Parameters

[in]	paramsMand	is the first parameter vector
[in]	paramsOpt	is the second parameter vector
[in]	paramsOut	is the third parameter vector

Returns

ito::RetVal, that contains an error if params is NULL

See also

checkParamVector

template<typename _Tp >

RetVal ito::CmpFunc	(	const DataObject *	src1,
		const DataObject *	src2,
		DataObject *	dst,
		int	cmpOp
	)

low-level, templated method which compares each element in source-matrix1 with its corresponding element in source-matrix2 and saves the result in a destionation matrix

Parameters

*src1	is the first source matrix
*src2	is the second source matrix
*dst	is the destination matrix, which must have the same ROI than src1 and src2 and must be of type uint8
cmpOp	is the compare operator (cv::CMP_EQ, cv::CMP_GT, cv::CMP_GE, cv::CMP_LT, cv::CMP_LE, cv::CMP_NE)

Remarks

no comparison is possible for source matrices of type int8 (due to openCV-problems)

Exceptions

cv::Exception

if source matrix is of type int8

Returns

retOk

template<>

RetVal ito::CmpFunc< ito::complex128 >	(	const DataObject *	src1,
		const DataObject *	src2,
		DataObject *	dst,
		int	cmpOp
	)

template specialisation for compare function of type complex128

Exceptions

cv::Exception

since comparison is not defined for complex input types

template<>

RetVal ito::CmpFunc< ito::complex64 >	(	const DataObject *	src1,
		const DataObject *	src2,
		DataObject *	dst,
		int	cmpOp
	)

template specialisation for compare function of type complex64

Exceptions

cv::Exception

since comparison is not defined for complex input types

template<typename _Tp >

RetVal ito::CmpFuncScalar	(	const DataObject *	src,
		const float64 &	value,
		DataObject *	dst,
		int	cmpOp
	)

low-level, templated method which compares each element in source-matrix1 with its corresponding element in source-matrix2 and saves the result in a destionation matrix

Parameters

*src1	is the first source matrix
*src2	is the second source matrix
*dst	is the destination matrix, which must have the same ROI than src1 and src2 and must be of type uint8
cmpOp	is the compare operator (cv::CMP_EQ, cv::CMP_GT, cv::CMP_GE, cv::CMP_LT, cv::CMP_LE, cv::CMP_NE)

Remarks

no comparison is possible for source matrices of type int8 (due to openCV-problems)

Exceptions

cv::Exception

if source matrix is of type int8

Returns

retOk

RetVal ito::CmpFuncScalar	(	const DataObject *	src,
		const ito::complex64 &	value,
		DataObject *	dst,
		int	cmpOp
	)

template specialisation for compare function of type complex64

Exceptions

cv::Exception

since comparison is not defined for complex input types

RetVal ito::CmpFuncScalar	(	const DataObject *	src,
		const ito::complex128 &	value,
		DataObject *	dst,
		int	cmpOp
	)

template specialisation for compare function of type complex128

Exceptions

cv::Exception

since comparison is not defined for complex input types

template<typename _Tp >

RetVal ito::ConjFunc

(

DataObject *

dObj

)

low-level, templated method for calculating the conjugated value of each element within the ROI of this data object

This method is only valid for complex data types.

Todo:

avoid MatIterator

Parameters

*dObj

Exceptions

cv::Exception

if data type is not complex. This is done by template specialization.

Returns

retOk

See also

std::conj

ito::tDataType ito::convertCmplxTypeToRealType ( ito::tDataType  cmplxType )

inline

method which returns the real data type of any given data type

If the given data type is already real, the same type is returned. Else the type of the real argument of the given complex type is returned.

Parameters

cmplxType

is the input data type

Returns

see method's description

Exceptions

cv::Exception

if the input data type is unknown

template<typename _Tp >

RetVal ito::ConvertToFunc	(	const DataObject &	lhs,
		DataObject &	rhs,
		const int	dest_type,
		const double	alpha,
		const double	beta
	)

converts data in DataObject lhs to DataObject rhs with a given type

Every element of the source data object is copied to the destionation data object by using this transformation
elem_destination = static_cast<newType>(elem_source * alpha + beta)

Parameters

&lhs	is the left-hand sided data object, whose data should be converted
&rhs	is the destination data object, whose memory is firstly deleted, then newly allocated
dest_type	is the type-number of the destination element
alpha	scaling factor (default: 1.0)
beta	offset value (default: 0.0)

Returns

retOk

Exceptions

cv::Exception(CV_StsAssert)

if conversion type is unknown

See also

convertTo, CastFunc

template<typename _Tp >

RetVal ito::CopyMatFunc	(	const uchar **	src,
		uchar **&	dst,
		bool	transposed,
		const int	sizeofs
	)

low-level, templated method that executes a shallow-copy of every matrix-plane in the source-vector and stores the copies in the destination-vector

Parameters

&src	is the source vector which contains matrix-planes of type cv::Mat_<_Tp>
&dst	is the destination vector, where the shallow-copies are stored. dst should be empty at the beginning

Returns

retOk

See also

operator =, DataObject::DataObject(const DataObject& copyConstr)

ito::RetVal ito::copyParamVector	(	const QVector< ito::ParamBase > *	paramVecIn,
		QVector< ito::ParamBase > &	paramVecOut
	)

makes a deep copy of a vector with values of type ParamBase

Parameters

[in]	paramVecIn	is a pointer to a vector of ParamBase-values
[out]	paramVecOut	is a reference to a vector which is first cleared and then filled with a deep copy of every element of paramVecIn

ito::RetVal ito::copyParamVector	(	const QVector< ito::Param > *	paramVecIn,
		QVector< ito::Param > &	paramVecOut
	)

makes a deep copy of a vector with values of type Param

Parameters

[in]	paramVecIn	is a pointer to a vector of Param-values
[out]	paramVecOut	is a reference to a vector which is first cleared and then filled with a deep copy of every element of paramVecIn

ito::RetVal ito::copyParamVector	(	const QVector< ito::Param > *	paramVecIn,
		QVector< ito::ParamBase > &	paramVecOut
	)

makes a deep copy of a vector with values of type Param

Parameters

[in]	paramVecIn	is a pointer to a vector of Param-values
[out]	paramVecOut	is a reference to a vector which is first cleared and then filled with a deep copy of every element of paramVecIn (casted to ito::ParamBase)

template<typename _Tp >

RetVal ito::CopyToFunc	(	const DataObject &	lhs,
		DataObject &	rhs,
		unsigned char	regionOnly
	)

low-level, templated method for deeply copying the data of one matrix to another given matrix

In case of 'regionOnly' == false, the destination dataObject 'rhs' is always newly allocated before copying data and the tags as well as the axis descriptions etc. are also copied from the source object. If the source object has a ROI set, the entire object with all data outside of the ROI is copied and the ROI is applied to the destination object, too.

If 'regionOnly' == true, only data within a current ROI is copied to the destination object. In this case, the destination is only newly allocated if its current dimension, size or type do not fit to the source object. Else, data is copied into the existing memory. Tags and axis descriptions etc. are always copied to the destination object.

Parameters

&lhs	is the matrix whose data is copied
&rhs	is the matrix where the data is copied to. The old data of rhs is deleted first
regionOnly,if	true, only the data of the ROI in lhs is copied, hence, the org-size of rhs corresponds to the ROI-size of lhs, else the whole data block is copied and the ROI of rhs is set to the ROI of lhs

Returns

retOk

See also

copyTo, CreateFunc

template<typename _Tp >

RetVal ito::CreateFunc	(	DataObject *	dObj,
		const unsigned char	dimensions,
		const int *	sizes,
		const unsigned char	continuous,
		const uchar *	continuousDataPtr,
		const int *	steps
	)

templated method for create

creates or initializes matrix with given parameters

Parameters

dObj	DataObject, whose matrix is created here
dimensions	total number of dimensions (>=1), if dimensions == 1, dimensions will be set to two and a matrix with dimension [1 x orginial dimension] is created
*sizes	vector with size of dimensions, each element gives the size of elements in each dimension
continuous,indicates	whether the data stored in this data object is stored in one continuous data block or not. if dimension <= 2, matrix is always continuous be careful, continuous has not the same meaning than the continuous flag in opencv or numpy.
continuousDataPtr	if this pointer is NULL, new data will be allocated. Else the given data indicates data which will be used by this data object. only possible if continuous is true. m_ownflag will be set to 0 if this pointer is set
*steps	vector with size of dimensions, indicates how many bytes one has to move in order to get to the next element in the same dimension, the step-size for the last element must be equal to element-size (in byte)

Returns

retOk

See also

create

continuous

template<typename _Tp >

RetVal ito::CreateFuncWithCVPlanes	(	DataObject *	dObj,
		const unsigned char	dimensions,
		const int *	sizes,
		const cv::Mat *	planes,
		const unsigned int	nrOfPlanes
	)

templated method for creation with given vector of cv::Mat-planes

Parameters

[in]	dimensions	is the total number of dimensions
[in]	*sizes	is a vector whose length is equal to dimensions. Each entry indicates the size of the specific dimension. Each matrix-plane is allocated with the size of the last two sizes
[in]	type	is the desired element data type (see tDataType)
[in]	*planes	is an array of cv::Mat-planes which will be used as matrices for every single 2D-plane. Every Mat must have the same size and type. The type must correspond to the param type, the size must fit to the last two given sizes.
[in]	nrOfPlanes	is the length of the planes-array. This value must be the same than (sizes[0]*sizes[1]*...*sizes[dimensions-2])

Returns

retOk

See also

create

RetVal ito::createObjectFromXMLV1	(	QXmlStreamReader &	stream,
		DataObject &	dObjIn,
		int &	elementsize
	)

This function creates an dataObject from the header of the xml-file This function creates an dataObject from the header of the xml-file by parsing the XML-stream. The first start element, already read by the calling function must contain the attributes dims, dataType and dim0..dimn-2, dimX, dimY.

Parameters

	[in|out]	stream The xml-Stream from the xml-file
[out]	dObjIn	Destination dataContainter of type dataObject with size / dims / type speficied in the input xml
[out]	elementsize	Byte-Size of the current dataObjekt

See also

loadXML2DOBJ, loadXML2EmptyDOBJ

< Sizes of the new dataObject. Will be freed at end:

template<typename _Tp >

RetVal ito::DeepCopyPartialFunc	(	const DataObject &	lhs,
		DataObject &	rhs
	)

low-level, templated method to copy the values of the ROI of matrix lhs to the ROI of matrix rhs.

the ROI of rhs must already correspond to the ROI of lhs, hence, rhs must have allocated data.

Parameters

&lhs	is the original data object
&rhs	is the data object, where the values are copied to.

Returns

retOk

See also

deepCopyPartial

Todo:

avoid DObjIterator for speed-up

template<typename _Tp >

RetVal ito::DivFunc	(	const DataObject *	src1,
		const DataObject *	src2,
		DataObject *	res
	)

low-level, templated method which does a element-wise division of elements in first source matrix by elements in second source matrix.

The result is stored in a result matrix, optionally the division can be scaled by a scaling factor, which is set to one by default. For fixed point numbers or complex values, a division by zero will throw an error. For floating-point values the following (matlab-like) implementation is used:

1.0/0.0 = Inf, 0.0/0.0 = Nan

Parameters

*src1	is the first source matrix
*src2	is the second source matrix
*res	is the result matrix, which must have the same size than the source matrices

Returns

retOk

template<>

RetVal ito::DivFunc< Rgba32 >	(	const DataObject *	src1,
		const DataObject *	src2,
		DataObject *	res
	)

low-level, templated method which does a element-wise division of elements in first source matrix by elements in second source matrix.

The result is stored in a result matrix, optionally the division can be scaled by a scaling factor, which is set to one by default. For fixed point numbers or complex values, a division by zero will throw an error. For floating-point values the following (matlab-like) implementation is used:

1.0/0.0 = Inf, 0.0/0.0 = Nan

Parameters

*src1	is the first source matrix
*src2	is the second source matrix
*res	is the result matrix, which must have the same size than the source matrices

Returns

retOk

void ito::errOutInitParams	(	const QVector< ito::Param > *	params,
		const int	num,
		const char *	reason
	)

Helper function for error output

Parameters

[in]	params	parameters expected by the plugin
[in]	num	parameter where the error occured
[in]	reason	the reason for the error (e.g. parameter missing, wrong type, ...)

Function used for writing error messages occured during the parsing of the parameters passed for the initialisation of a plugin. The function uses the cerr stream to "post" the error message. If possible the parameter where the error occured is marked with an arrow. Except the error all parameters necessary and optional including their type are written to the console.

template<typename _Tp >

RetVal ito::EyeFunc	(	const int	size,
		uchar **	dstMat
	)

low-level, templated method for creating an eye-matrix

Parameters

size	indicates the size of the square matrix
**dstMat	is a pointer to which the eye-matrix is assigned to. The eye matrix is of type cv::Mat_<_Tp>

Returns

retOk

ito::RetVal ito::findAndDeleteReservedInitKeyWords	(	PyObject *	kwds,
		bool *	enableAutoLoadParams
	)

Parameters

	[in|out]	kwds list with named python arguments
[out]	enableAutoLoadParams	if keyword autoLoadParams is found, value of this is set to kwds-item value else false it is set to false.

RetVal ito::formatDoubleWithUnit	(	QStringList	scaleThisUnitsOnly,
		QString	unitIn,
		double	dVal,
		double &	dValOut,
		QString &	unitOut
	)

< Function to convert double values with unit to scaled values with scaled units (0.01m -> 10mm)

Function generates the auto save filename from the plugin name and the dll-folder

Compared the abs(dValue) with the 10^(3N) and according to the results mu p M ... are added to the unit Allowed units are SI-Unit except kg and mm. If % is given as input unit, values are multiplied by 100

Parameters

[in]	scaleThisUnitsOnly	List with scaleable units (e.g. mm, m)
[in]	unitIn	Old unit (e.g. mm, m, %)
[in]	dVal	Double value (e.g. mm, m, %)
[out]	dValOut	Scaled value
[out]	unitOut	Scaled unit m -> mm or m

template<typename _Tp >

RetVal ito::FreeFunc

(

DataObject *

dObj

)

low-level, templated method for freeing allocated data blocks

First, the header information of the corresponding data block is deleted. Then the reference counter of the data block is decremented. In the same way, the reference counter for every matrix-plane is incremented by calling the corresponding release-method. If the ref-counter is lower than zero no other instance needs this data block and it is deallocated if the m_owndata-flag is true.

Parameters

*dObj

whose data block should be freed

Returns

retOk

See also

freeData

int ito::freeParams	(	int	length,
		char *&	cargt,
		char **&	cargs
	)

frees parameter and parameter type arrays generated by the parseParams function

Parameters

[in]	length	number of parameters
[in]	cargt	array with parameter types
[in]	cargs	array with the parameter pointers / values

Returns

0

The function frees the arrays generated by the parseParams function, i.e. the array with the parsed parameter values and the array with their types.

RetVal ito::generateAutoSaveParamFile	(	QString	plugInName,
		QFile &	paramFile
	)

loadXML2QLIST loads parameters from an XML-File and saves them to paramList

function for generates the plugin xml file handle

Parameters

[in]	fName	filename (is needed e.g. to get filename)
[out]	paramFile	reference to unopened parameter file

The function generates the xml parameter file name and returns the a QFile handle. The name has the same name as the plugin in the plugins directory.

See also

loadXML2QLIST, saveQLIST2XML

template<typename _Tp >

ito::tDataType ito::getDataType ( const _Tp *  )

inline

method which returns the value of enumeration ito::tDataType, which corresponds to the type of the given pointer parameter.

If the parameter type cannot be transformed into a value of ito::tDataType, an exception is thrown.

Parameters

any	pointer, whose type should be transformed

Returns

ito::tDataType

Exceptions

cv::Exception

if the input data type is unknown

See also

getDataType2

template<typename _Tp >

ito::tDataType ito::getDataType2 ( )

inline

method which returns the value of enumeration ito::tDataType, which corresponds to the template parameter (must be a pointer).

If the template parameter cannot be transformed into a value of ito::tDataType, an exception is thrown.

Call is ito::tDataType result = getDataType2<uint8*>().

Returns

ito::tDataType

Exceptions

cv::Exception

if the template parameter is unknown (e.g. no pointer).

See also

getDataType

PyObject* ito::getExecFuncsInfo	(	ito::AddInBase *	aib,
		PyObject *	args,
		PyObject *	kwds
	)

returns a list of execFunction available in a plugin similar to filterHelp

Parameters

[in]	aib	the plugin for which the execFuncs names are requested
[in]	args	2 Item-Vector with integer request for additional dictionary return

Returns

python dictionary with list of functions or specific dictionary for one execFunc with the parameters' names, min, max, current value, (infostring)

PyObject* ito::getExecFuncsList

(

ito::AddInBase *

aib

)

returns the names of extended Functionality available in a plugin

Parameters

[in]

aib

the plugin for which the parameter names are requested

Returns

python object with a string list with the execFuncs' names

QMap< QString, QString > ito::getItomVersionMap

(

)

This function is called to get all version numbers that itom contains.

Use this function to get a map of all parts of itom that are used with their corresponding version.

Returns

returns a QMap<QString,QString> containing the module and the version of a module.

PyObject* ito::getName

(

ito::AddInBase *

addInObj

)

returns the name of a python plugin

Parameters

[in]

addInObj

the plugin whoes name should be returned

Returns

the plugin name

PyObject* ito::getParam	(	ito::AddInBase *	addInObj,
		PyObject *	args
	)

return a parameter value

Parameters

[in]	addInObj	the addIn whoes parameter is requested
[in]	args	the parameter name

Returns

python object with the parameter value on success (parameter exists), NULL otherwise

The function tries to retrieve the value of the parameter with the name given in args. If the parameter does not exist NULL is returned. To actually retrieve the value the getParam function of the plugin is invoked.

ito::Param * ito::getParamByName	(	QVector< ito::Param > *	paramVec,
		const char *	name,
		ito::RetVal *	retval
	)

brief returns a parameter from the parameter-vector, that fits to a specific name

Parameters

name	description

Returns

PyObject* ito::getParamInfo	(	ito::AddInBase *	aib,
		PyObject *	args
	)

returns a dictionary with all meta information of one parameter

Parameters

[in]	aib	the plugin for which the parameter names are requested
[in]	args	1 Item-Vector with bool request for additional dictionary return

Returns

python list of python tuple with the parameters' names, min, max, current value, (infostring)

PyObject* ito::getParamList

(

ito::AddInBase *

aib

)

returns the names of the parameters available in a plugin

Parameters

[in]

aib

the plugin for which the parameter names are requested

Returns

python object with a string list with the parameters' names

PyObject* ito::getParamListInfo	(	ito::AddInBase *	aib,
		PyObject *	args
	)

returns the all informations of the parameters available in a plugin

Parameters

[in]	aib	the plugin for which the parameter names are requested
[in]	args	1 Item-Vector with bool request for additional dictionary return

Returns

python list of python tuple with the parameters' names, min, max, current value, (infostring)

template<typename _Tp >

RetVal ito::GetRangeFunc	(	DataObject *	dObj,
		const int	dtop,
		const int	dbottom,
		const int	dleft,
		const int	dright
	)

low-level, templated method for saving a shallow copy of a source cv::Mat_ to a destination cv::Mat_ with respect to given row- and col-ranges

Parameters

<em>SrcMat	is the source matrix which is firstly cast to cv::Mat_<_Tp>
rowRange	is the desired row-range
colRange	is the desired col-range
**dstMat	is the pointer to a destination matrix which is also cast to cv::Mat_<_Tp>*

Returns

retOk

ito::tDataType ito::guessDataTypeFromCVMat ( const cv::Mat *  mat, ito::RetVal &  retval  )

inline

method which guesses the dataObject type from a given cv::Mat*

If the given data type is already real, the same type is returned. Else the type of the real argument of the given complex type is returned.

Parameters

mat	is the OpenCV matrix.
retval	an error value will be added if the type cannot be converted.

Returns

ito::DataObject type that fits to the given matrix

DATAOBJ_EXPORT DataObject ito::imag

(

const DataObject &

dObj

)

high-level value which calculates the imaginary value of each element of the input source data object and returns the resulting data object

Parameters

&dObj

Returns

new data object with imaginary values

Exceptions

cv::Exception

if undefined data type (e.g. real data types)

See also

ArgFunc

calculates the imaginary part of each element in the given data object and returns the result as new data object

template<typename _CmplxTp , typename _Tp >

RetVal ito::ImagFunc	(	const DataObject *	dObj,
		DataObject *	resObj
	)

low-level, double templated method to save the element-wise imaginary value of each element in source matrix to result matrix

This method takes the imaginary value of a complex valued input matrix and stores it in the equivalent real typed result matrix

Parameters

*dObj	is source matrix, must have complex type
*resObj	is the resulting data object, which has the real data type which corresponds to the complex type

Returns

retOk

See also

std::abs

template<typename _Tp >

bool ito::isFinite ( _Tp  )

inline

method returns whether a given variable is finite.

For floating point variables, this method considers a variable to be finite if the bitmask is neither NaN nor Inf. For floating point values only parameters of type float32, float64, complex64 or complex128 are treated in the desired way. For integer types –> always true

Parameters

value

is value to check

Returns

true if value is neither Inf nor NaN, else false

template<typename _Tp >

bool ito::isInf ( _Tp  )

inline

method returns whether a given variable is Inf / not may be NaN.

For floating point variables, this method considers a variable to be Inf if the bitmask is Inf. For floating point values only parameters of type float32, float64, complex64 or complex128 are treated in the desired way. For integer types –> always false

Parameters

value

is value to check

Returns

true if value is Inf else false

template<typename _Tp >

bool ito::isNaN ( _Tp  value )

inline

method returns whether a given variable is NaN / not a Number but maybe Inf.

For floating point variables, this method considers a variable to be NaN if the bitmask is NaN. For floating point values only parameters of type float32, float64, complex64 or complex128 are treated in the desired way. For integer types –> always false

Parameters

value

is value to check

Returns

true if value is NaN else false

template<typename _Tp >

bool ito::isNotZero ( _Tp  value )

inline

method returns whether a given variable is not equal to zero.

For floating point variables, this method considers a variable not to be zero, if its value lie without the boundaries (-epsilon,epsilon). Epsilon is retrieved from std::numeric_limits<_Tp>::epsilon(). For floating point values only parameters of type float32, float64, complex64 or complex128 are treated in the desired way.

Parameters

value

is value to check

Returns

true if value is zero or within the epsilon boundaries, else false

template<typename _Tp >

bool ito::isZeroValue ( _Tp  v, _Tp    )

inline

method returns whether a given variable is equal to zero.

For floating point variables, this method considers a variable to be zero, if its value lie within the boundaries (-epsilon,epsilon). Epsilon can for example be obtained by std::numeric_limits<_Tp>::epsilon(). For floating point values only parameters of type float32, float64, complex64 or complex128 are treated in the desired way.

Parameters

v	is value to check
epsilon	is epsilon boundary, for fixed-point values this value is ignored.

Returns

true if value is zero or within the epsilon boundaries, else false

template<typename _Tp >

RetVal ito::lineCutFunc	(	const DataObject *	src,
		const int *	coordinates,
		const int &	len,
		DataObject *	res
	)

low-level, templated method to take a line cut across the planes of a dataObject.

This method takes a line cut across the planes of a 2d or 3d dataObject. The result is stored in a result matrix. The list containing coordinates of the start and endpoint is interpretated as followed: [x0,y0,x1,y1]

Parameters

*src	is source matrix
*coordinates	points to a int arrray containing len elements
*len	length of coordinates list
*res	result dataObject of the right shape

Returns

retOk

RetVal ito::loadDataFromXMLV1 ( QXmlStreamReader &  stream, DataObject &  dObjIn, int  elementsize  )

inline

This function copies the CDATA from the xml-file to the allocated dataObject. This function copies the CDATA from the xml-file to the allocated dataObject. The data was before packed (substitution of xml-registered characters) during saving and is unpacked here. The data is stored plane-wise. The function checks if the plane-size if the object is equal to the imported size.

Parameters

	[in|out]	stream The xml-Stream from the xml-file
	[in|out]	dObjIn allocated dataObject
[in]	elementsize	Size of the each matrix-element

See also

loadXML2DOBJ, loadXML2EmptyDOBJ, DataObjectTags, DataObject

RetVal ito::loadObjectHeaderFromXMLV1 ( QXmlStreamReader &  stream, DataObject &  dObjIn  )

inline

This function fills the MetaData (DataObjectTags) of an allocated dataObject from the values of an xml-file This function fills the MetaData (DataObjectTags) of an allocated dataObject from the values of an xml-file. This includes the axis-Tags (offset, scale, unit, description), value-Tags ((offset), (scale), unit, description) and the rotation matrix. It does not include the tag-Space (std::map<std::string, DataObjectTagType> m_tags) (e.g. protocol ...)

Parameters

[in|out]	stream The xml-Stream from the xml-file
[in|out]	dObjIn allocated dataObject

See also

loadXML2DOBJ, loadXML2EmptyDOBJ, DataObjectTags, DataObject

RetVal ito::loadTagSpaceFromXMLV1 ( QXmlStreamReader &  stream, DataObject &  dObjIn  )

inline

This function fills the tagsSpace (DataObjectTags) of an allocated dataObject from the values of an xml-file This function fills the tagsSpace (DataObjectTags) of an allocated dataObject from the values of an xml-file. This onlye includes the tag-Space (std::map<std::string, DataObjectTagType> m_tags) (e.g. protocol ...) and does not include the axis-Tags (offset, scale, unit, description), value-Tags ((offset), (scale), unit, description) and the rotation matrix.

Parameters

[in|out]	stream The xml-Stream from the xml-file
[in|out]	dObjIn allocated dataObject

See also

loadXML2DOBJ, loadXML2EmptyDOBJ, DataObjectTags, DataObject

RetVal ito::loadXML2DOBJ	(	DataObject *	dObjIn,
		QString	folderFileName,
		bool	onlyHeaderObjectFile,
		bool	appendEnding
	)

Parameters

	[Out]	dObjIn Destination dataContainter of type dataObject
[in]	folderFileName	Folder and Filename of the Sourcefile

This function loads data from a xml-file to a dataObject. The file must be compatible to the file-format describted before. There are to possilbe import methods:

1. onlyHeaderObjectFile == false tries to import a ido file with a itoDataObject-note/startelement.

1. onlyHeaderObjectFile == true tries to import a idh file with a itoDataObjectHeader-note/startelement. The dataSpace will be ignored

See also

createObjectFromXMLV1, loadObjectHeaderFromXMLV1, loadTagSpaceFromXMLV1, loadDataFromXMLV1

< Returnvalue for the complete function

< Handle to the source data

< Returnvalue for the complete function

< Handle to the source data

RetVal ito::loadXML2QLIST	(	QMap< QString, Param > *	paramList,
		QString	id,
		QFile &	paramFile
	)

Parameters

[out]	paramList	Empty List of Type QMap. If not empty this function will clear the list before reading
[in]	id	Identifier of the plugin. Currently implemented as integer number only
[in]	paramFile	Filename of the file. The file will be opened/closed in this function

This function reads the parameters for a plugin specified with id from an XML file. During initialisation an xml file with the same name as the plugin library in the plugin directory is used to load the plugin parameters. The xml file is checked for the current plugin-file version and type when opened. The parameters have in the calling function afterwards.

DATAOBJ_EXPORT DataObject ito::makeContinuous

(

const DataObject &

dObj

)

high-level method which copies an incontinuously organized data object to a continuously organized resulting data object, which is returned

If the given data object already is in a continuous form (e.g. 2D object or continuous representation for higher dimensions), a shallow copy to the given object is returned. In any other cases, a deep copy of the given object is returned, where the entire data block is continuously aligned in memory. Additionally, only values within the current region of interest are copied to the new, continous object (in order to safe memory).

Parameters

&dObj

is the source data object

Returns

resulting data object

See also

MakeContinuousFunc

if the given data object is not continuously organized, copies the content to a new continuous data object

template<typename _Tp >

RetVal ito::MakeContinuousFunc	(	const DataObject &	dObj,
		DataObject &	resDObj
	)

low-level, templated method which copies an incontinuously organized data object to a continuously organized resulting data object

this templated helper function should only be called if dObj is non-continuous. This is already checked by the calling function makeContinuous The hidden data which is out of a possible roi will not be part of the new continuous matrix.

Parameters

&dObj	is the source data object
&resDObj	is the resulting data object

Returns

retOk

RetVal ito::mergeQLists	(	QMap< QString, Param > *	oldList,
		QMap< QString, Param > *	newList,
		bool	checkAutoSave,
		bool	deleteUnchangedParams
	)

Parameters

	[in/out]	oldList Paramlist with all plugin-parameters, which will contain the merged parameters in the end
	[in/out]	newList New parameter values to set
[in]	checkAutoSave	Flag to enable / disable autosave control to avoid obsolet parameters to overwrite exisiting parameters.

This function compares the new list with the old list. If new list contains parameters which do not exist in the existing list, the paremeter is ignored and a warning is added to the errormessage stack. If the checkAutoSave parameter is true, parameters in oldList are not altered of the autosave is disabled. In this case a warning is returned. In case the paremters Type is not equal, a warning is returned and the paremeter is not altered. At the moment only parameters of numeric values and strings are merged.

template<typename _Tp >

RetVal ito::NansFunc	(	const int	sizeY,
		const int	sizeX,
		uchar **	dstMat
	)

low-level, templated method for creation of one-valued matrix-plane

Parameters

sizeY	are the number of rows
sizeX	are the number of columns
**dstMat	is the pointer to the already allocated cv::Mat_<type>-matrix-plane

Returns

retOk

See also

zeros

template<>

RetVal ito::NansFunc< ito::complex64 >	(	const int	sizeY,
		const int	sizeX,
		uchar **	dstMat
	)

low-level, overloaded template method for creation of one-valued matrix-plane of complex64, complex128

Parameters

sizeY	are the number of rows
sizeX	are the number of columns
**dstMat	is the pointer to the already allocated cv::Mat_<type>-matrix-plane

Returns

retOk

See also

zeros

template<typename _Tp >

_Tp ito::numberConversion ( ito::tDataType  fromType, const void *  scalar  )

inline

templated method for converting a given scalar value to the data type, indicated by the template parameter

Parameters

fromType	is the data type of the given scalar
<em>scalar	is the pointer to the scalar value, casted to void

Returns

the converted scalar value

Exceptions

cv::Exception

if the input data type is unknown or if the conversion failed

See also

saturate_cast

template<typename _Tp >

RetVal ito::OnesFunc	(	const int	sizeY,
		const int	sizeX,
		uchar **	dstMat
	)

low-level, templated method for creation of one-valued matrix-plane

Parameters

sizeY	are the number of rows
sizeX	are the number of columns
**dstMat	is the pointer to the already allocated cv::Mat_<type>-matrix-plane

Returns

retOk

See also

zeros

template<>

RetVal ito::OnesFunc< ito::Rgba32 >	(	const int	sizeY,
		const int	sizeX,
		uchar **	dstMat
	)

low-level, overloaded template method for creation of one-valued matrix-plane of RGBA32

Parameters

sizeY	are the number of rows
sizeX	are the number of columns
**dstMat	is the pointer to the already allocated cv::Mat_<type>-matrix-plane

Returns

retOk

See also

zeros

template<typename _Tp >

RetVal ito::OpMulFunc	(	const DataObject *	dObj1,
		const DataObject *	dObj2,
		DataObject *	dObjRes
	)

brief description

Todo:

check for right definition of multiplication

template<typename _Tp >

RetVal ito::OpScalarComplexMulFunc	(	DataObject *	src,
		const complex128 &	factor
	)

low-level, templated method which multiplies every element of Data Object with a factor

Parameters

*src
factor

Returns

retOk

template<typename _Tp >

RetVal ito::OpScalarMulFunc	(	DataObject *	src,
		const float64 &	factor
	)

low-level, templated method which multiplies every element of Data Object with a factor

Parameters

*src
factor

Returns

retOk

ito::RetVal ito::parseParamName	(	const QString &	name,
		QString &	paramName,
		bool &	hasIndex,
		int &	index,
		QString &	additionalTag
	)

parses parameter name with respect to regular expression, assigned for parameter-communcation with plugins

This method parses any parameter-name with respect to the rules defined for possible names of plugin-parameters.

The regular expression used for the check is "^([a-zA-Z]+\\w*)(\\[(\\d+)\\]){0,1}(:(.*)){0,1}$"

Then the components are:

[0] full string [1] PARAMNAME [2] [INDEX] or empty-string if no index is given [3] INDEX or empty-string if no index is given [4] :ADDITIONALTAG or empty-string if no tag is given [5] ADDITIONALTAG or empty-string if no tag is given

Parameters

[in]	name	is the raw parameter name
[out]	paramName	is the real parameter name (first part of name; part before the first opening bracket ('[') or if not available the first colon (':'))
[out]	hasIndex	indicates whether the name contains an index part (defined by a number within two brackets (e.g. '[NUMBER]'), which has to be appended to the paramName
[out]	index	is the fixed-point index value or -1 if hasIndex is false
[out]	additionalTag	is the remaining string of name which is the part after the first colon (':'). If an index part exists, the first colon after the index part is taken.

int ito::parseParams	(	PyObject *	args,
		int	length,
		char **&	cargs,
		char *&	cargt
	)

Helper function that accepts a python parameter list and returns pointers to the parameters' values and a list with their types

Parameters

[in]	args	list with python parameters
[in]	length	number of parameters passed
[out]	cargs	pointers to the parsed parameters
[out]	cargt	list with the parameter's types

Returns

return 0 if all parameters passed could be parsed to a known type, -1 otherwise

The function accepts a list of python parameters and tries to parse them to make them available to c/c++ functions. The found parameters pointers are given back in the cargs array ant the parameters' types in the cargt array. To free the generated lists use the freeParams function.

ito::RetVal ito::parsePosParams	(	PyObject *	args,
		char **&	cargs,
		char *&	cargt,
		QVector< int > &	axisVec,
		QVector< double > &	posVec
	)

helper function to parse the positioning parameters for an actuator

Parameters

[in]	args	arguments passed to the function (in python)
	[in/out]	cargs parsed argument values
	[in/out]	cargt parsed argument types
[out]	axisVec	Vector with axes numbers
[out]	posVec	Vector with position values

Returns

retOk of parameters could be parsed, retError otherwise

Parses the parameters passed to a setPos command in python. For each axis that should be positioned an axis number and a position value are expected.

template<typename _Tp >

RetVal ito::planeStackFunc	(	const DataObject *	mats,
		const int &	num,
		const unsigned int &	axis,
		DataObject *	res
	)

low-level, templated method which stacks a sequence of dataObjects horizontally or vertically together .

The result is stored in a result matrix.

Parameters

*mats	the source sequence of dataObjects. All objects must be of the same type and contain the same number of planes. Also the shape of the axis along which is not stacked must be equal to all objects.
&num	the number of dataObjects inclluded in mats
&axis	defines the axis along the dataObjects will be stacked in the res dataObject. The parameter has to be one or two.
*res	is the result matrix (3d DataObject), which must have a size that fits to the corresponding stack axis. Furthermore the cv::Mats must be continous

Returns

retOk

PyObject* ito::plugin_hideToolbox

(

ito::AddInBase *

aib

)

returns the list of available parameters

Parameters

[in]

self

the actuator object (python)

This method simply close the widget

PyObject* ito::plugin_showToolbox

(

ito::AddInBase *

aib

)

returns the list of available parameters

Parameters

[in]

self

the actuator object (python)

This method simply open the widget

ito::PyDoc_STRVAR	(	dataObjectInit_doc	,
		"dataObject(dims = [], dtype = \"uint8\", continuous = 0, data = None) -> dataObject \n\\n\Creates a new n-dimensional dataObject array. \n\\n\The :class:`dataObject` represents a multidimensional array of fixed-size items \n\(integer, floating-point or complex values) and contains	further,
		optional	,
		meta\n\	information,
		like	units,
		axis	descriptions,
		scalings	,
		general	tags,
		...\n\Recently the following data	typesdtype) are supported:\n\\n\*Integer(int8, uint8, int16, uint16, int32,
		\n\*Floating	pointfloat32, float64(=> double),
		\n\*Complex(complex64(2x float32), complex128(2x float64)).\n\*Color(rgba32(uint32 or uint[4] containing the four 8bit values[R, G, B, Alpha])).\n\\n\Arrays can also be constructed using some of the static pre-initialization methods\n\:meth:`zeros`	,
		:meth:`ones`	,
		:meth:`rand`or:meth:`randN`\n\(refer to the See Also section below).\n\\n\Parameters\n\-----------\n\dims:sequence of	int,
		optional\n\``dims``is a list or tuple indicating the size of each dimension.The length\n\of this sequence defines the dimension of this dataObject.As an	example,
		\n\``	dims = [2,
		3]``creates a two-dimensional dataObject with two rows and three columns.\n\If``dims``is not	given,
		an empty data object is created.\n\dtype:str	,
		optional\n\Data type of each element in the array.Possible values are:\n\ 'int8'	,
		'uint8'	,
		'int16'	,
		'uint16'	,
		'int32'	,
		'float32'	,
		'float64'	,
		'complex64'	,
		\n\ 'complex128'	,
		'rgba32'.\n\continuous:int	,
		optional\n\The last two dimensions of a dataObject are always stored as continuous junk of	memory,
		\n\denoted as plane.If``continuous``is set to``1``	,
		even a dataObject with a dimension\n\``	n,
		2``will allocate one big block of memory and continuously stores the matrix data\n\there.\n\If``continuous``is	0,
		different junks of memory are allocated for each	plane,
		the planes\n\are referenced by means of an index vector.This is recommended for large	arrays,
		since\n\the operating system might get trouble allocated one very big continuous junk of	memory,
		\n\instead of multiple smaller ones.\n\data:int or float or complex or rgba or sequence of int or sequence of float or sequence of complex or dataObject or np.	ndarray,
		optional\n\If``data``is a single	value,
		all values in the dataObject are set to this single value.\n\	Else,
		the sequence or array-like object must have the same number of values than\n\the data object.These values will then be assigned to the new data object(filled row by row).\n\\n\Notes\n\------\n\The:class:`itom.dataObject`is a direct wrapper for the underlying C++class *dataObject *.\n\This array class mainly is based on the class *Mat *of the computer vision library(OpenCV).\n\\n\In order to handle huge	matrices,
		the data object can divide one array into chunks in memory.\n\Each subpart(called matrix-plane) is two-dimensional and covers data of the last two dimensions.\n\In C++-context each of these matrix-planes is of type cv::Mat_< type > and can be used with\n\every operator given by the openCV-framework(version 2.3.1 or higher).\n\\n\The dimensions of the matrix are structured descending.So if we assume to have a n-dimensional\n\matrix``A``	,
		where each dimension has its size	s_i,
		the dimensions order is	n,
		..	,
		z	,
		y	,
		x and\n\the corresponding sizes of``A``are.\n\\n\In order to make the data object compatible to continuously organized data	structures[s_n, s_(n-1),s_(n-2),..., s_y, s_x],
		like\n\numpy-	arrays,
		it is also possible to have all matrix-planes in one data-block in memory\n\(not recommended for huge matrices).	Nevertheless,
		the indicated data structure with the\n\two-dimensional sub-matrix-planes is still existing.The data organization is equal to the\n\one of	openCV,
		hence	,
		two-dimensional matrices are stored row-by-row(C-style)...\n\\n\In addition to	OpenCV,
		itom.dataObject supports complex valued data types for all operators and methods.\n\\n\Warning 'uint32'is currently not	available,
		since it is not fully supported by the underlying OpenCV matrices.\n\\n\**Deep	Copy,
		Shallow Copy and ROI **\n\\n\It is possible to set a n-dimensional region of interest(ROI) to each	matrix,
		the virtual	dimensions,
		\n\which will be delivered if the user asks for the matrix size.\n\To avoid copy operations where possible a	simple = _Operator will also make a shallow copy of the object.\n\Shallow copies share the same data (elements and meta data) with the original object,
		hence manipulations of one object will affect the\n\original object and all shallow copies.\n\\n\The opposite a deep copy of a dataObject(by sourceObject.copy()) creates a complete mew matrix with own meta data object.\n\\n\Example::\n\\n\#Create an object\n\	dObj = dataObject([5, 10, 10], 'int8')\n\    \n\    # Make a shallow copy \n\    dObjShallow = dObj \n\    \n\    # Make a shallow copy on ROI\n\    dObjROI = dObj[1,
		:	,
		:]\n\\n\#Set the value of elementto 0\n\	dObj[1, 0, 0][1, 0, 0] = 0\n\    \n\    # Make a deep copy of the dObjROI\n\    dObjROICopy = dObjROI.copy()\n\    \n\    # Set the value of dObjROICopy element [0,
		0	,
		0] to 127 without effecting other objects\n\	dObjROICopy[0, 0, 0] = 127\n\\n\**Constructor** \n\\n\The function dataObject([dims [, dtype='uint8'[, continuous = 0][, data = valueOrSequence]]])\n\creates a new itom-dataObject filled with undefined data.\n\If no parameters are given,
		an uninitilized DataObject(dims=0, no sizes) is created.\n\\n\As second possibility you can also use the copy-constructor 'dataObject(anyArray:Union[dataObject, np.ndarray], dtype:str= '', continuous:int=0)'	,
		\n\where 'anyArray'must be any array-like structure which is parsable by the numpy-interface.If a dtype is given or if continuous is	1,
		\n\the new data object will be a type-casted(and/or continuous) copy of 'anyArray'.\n\\n\See Also\n\----------\n\ones:Static method to construct a data object filled with ones.\n\zeros:Static method to construct a data object filled with zeros.\n\nans:Static method to construct a data object(float or complex only) with NaNs.\n\rand:Static method to construct a randomly filled data object(uniform distribution).\n\randN:Static method to construct a randomly filled data object(gaussian distribution)."
	)

brief description

long description

Parameters

name	description

Returns

description

See also

(see also) keywords (comma-separated)

PyObject* ito::PyWidgetOrFilterHelp	(	bool	getWidgetHelp,
		PyObject *	pArgs,
		PyObject *	pKwds
	)

first try to catch a perfect match with existing filters

Now get the complete filterlist

template<typename _Tp >

RetVal ito::RandFunc	(	const int	sizeY,
		const int	sizeX,
		const double	value1,
		const double	value2,
		const bool	randMode,
		uchar **	dstMat
	)

low-level, templated method for creation of random-valued matrix-plane

Parameters

sizeY	are the number of rows
sizeX	are the number of columns
type	is the desired data-element-type
randMode	switch mode between uniform distributed(false) and normal distributed noise(true)
**dstMat	is the pointer to the already allocated cv::Mat_<type>-matrix-plane

Returns

retOk

See also

zeros

template<>

RetVal ito::RandFunc< ito::complex128 >	(	const int	sizeY,
		const int	sizeX,
		const double	value1,
		const double	value2,
		const bool	randMode,
		uchar **	dstMat
	)

template specialisation for low-level, templated method for creation of random-valued matrix-plane of type complex128

Returns

retOk

See also

RandFunc, zeros, ones

template<>

RetVal ito::RandFunc< ito::Rgba32 >	(	const int	sizeY,
		const int	sizeX,
		const double	value1,
		const double	value2,
		const bool	randMode,
		uchar **	dstMat
	)

template specialisation for low-level, templated method for creation of random-valued matrix-plane of type rgba32

Returns

retOk

See also

RandFunc, zeros, ones

RetVal ito::readDoubleFromXML ( QXmlStreamAttributes &  attrStream, QString &  Element, QString &  Attrib, double &  val, bool  isBinary  )

inline

This helper function extracts a double from the xml-Attributes of the Stream This helper function extracts a double from the xml-Attributes of the Stream copied by the caller with the attrStream = attrStream = stream.attributes();. the Function checks if the attribute exists and than tries to convert to the value of the attribute either from binary or with string to double functions.

Parameters

[in]	attrStream	incomming attribute-stream
[in]	Element	name of the element (only for error msg)
[in]	Attrib	name of the attribute to extract
	[in|out]	val Must be filled with default value and is filled with value from the XML-Stream
[in]	isBinary	Must be true if attribute value was stored as binary else false

See also

loadXML2DOBJ, loadXML2EmptyDOBJ, loadObjectHeaderFromXMLV1

RetVal ito::readStdStringFromXML ( QXmlStreamAttributes &  attrStream, QString &  Element, QString &  Attrib, std::string &  val  )

inline

This helper function extracts a std::string from the xml-Attributes of the Stream This helper function extracts a std::string from the xml-Attributes of the Stream copied by the caller with the attrStream = attrStream = stream.attributes();. the Function checks if the attribute exists and than tries to convert to the value of the attribute from QString to std::string.

Parameters

[in]	attrStream	incomming attribute-stream
[in]	Element	name of the element (only for error msg)
[in]	Attrib	name of the attribute to extract
	[in|out]	val Must be filled with default value and is filled with value from the XML-Stream

See also

loadXML2DOBJ, loadXML2EmptyDOBJ, loadObjectHeaderFromXMLV1

bool ito::readTillNext ( QXmlStreamReader &  stream, int &  times, int  maxtimes  )

inline

This helper function reads the stream till the next startElement. The Qt-Function readNextStartElement sometimes stops at the end-element (:P). So the function tries to read until it reaches the next startelement but only for maxtimes trys the Function checks if the attribute exists and than tries to convert to the value of the attribute either from binary or with string to double functions.

Parameters

[in]	stream	incomming xml-stream
	[in|out]	times Counts of iterations
[in]	maxtimes	maximal number of iterations to perform

See also

loadXML2DOBJ, loadXML2EmptyDOBJ

DATAOBJ_EXPORT DataObject ito::real

(

const DataObject &

dObj

)

high-level value which calculates the real value of each element of the input source data object and returns the resulting data object

Parameters

&dObj

Returns

new data object with real values

Exceptions

cv::Exception

if undefined data type (e.g. real data types)

See also

ArgFunc

calculates the real part of each element in the given data object and returns the result as new data object

template<typename _CmplxTp , typename _Tp >

RetVal ito::RealFunc	(	const DataObject *	dObj,
		DataObject *	resObj
	)

low-level, double templated method to save the element-wise real value of each element in source matrix to result matrix

This method takes the real value of a complex valued input matrix and stores it in the equivalent real typed result matrix

Parameters

*dObj	is source matrix, must have complex type
*resObj	is the resulting data object, which has the real data type which corresponds to the complex type

Returns

retOk

See also

std::abs

RetVal ito::saveDOBJ2XML	(	DataObject *	dObjOut,
		QString	folderFileName,
		bool	onlyHeaderObjectFile,
		bool	doubleAsBinary
	)

Import a dataObject from harddrive, saved in the ITO-XML-Format (.ido or .idh)

Parameters

[in]	dObjOut	DataObject to save
[in]	folderFileName	Name of the folder and the filename e.g. c:\bla.xml or c://bla.xml
[in]	doubleAsBinary	If true, double are exported as binary, by defaults they are saved as strings

This function writes data and meta data of a dataObject to the harddrive. The file format is based on xml. The data of the dataObject are converted to binary without XML-registed signs by QByteArray::toBase64()). The metaData and tagSpace are either saved as binary (QByteArray::toBase64()) or saves as strings with 15 signifiant digits (more than 32-Bit). So for most applications doubleAsBinary==false is enough.

Lyda

Date

04.2012

See also

writeObjectHeaderToFileV1, writeObjectTagsToFileV1, writeObjectDataToFileV1

RetVal ito::saveQLIST2XML	(	QMap< QString, Param > *	paramList,
		QString	id,
		QFile &	paramFile
	)

Parameters

	[in/out]	paramList List of Type QMap with the parameters to save. The parameters are deleted during writing.
[in]	id	Identifier of the plugin. Currently implemented as integer number only
[in]	paramFile	Filename of the file. The file will be opened/closed in this function

This function writes the parameters of a plugin to an XML file. During plugin closing this function is executed with a file name with same name as the plugin library in the plugin directory The xml file is checked for the current plugin-file version and type when opened. In case of a type conflict the parameter is currently not saved.

< passed all elements without success, so add new one

template<typename _CmplxTp , typename _Tp >

RetVal ito::SetImagFunc	(	DataObject *	dObj,
		DataObject *	valueObj
	)

low-level, double templated method to save the element-wise real value of each element in source matrix to result matrix

This method takes the real value of a complex valued input matrix and stores it in the equivalent real typed result matrix

Parameters

*dObj	is source matrix, must have complex type
*resObj	is the resulting data object, which has the real data type which corresponds to the complex type

Returns

retOk

See also

std::abs

PyObject* ito::setParam	(	ito::AddInBase *	addInObj,
		PyObject *	args
	)

set a parameter value

Parameters

[in]	addInObj	the addIn whoes parameter is requested
[in]	args	the parameter name and value in a python object

Returns

Py_Return_None on success, NULL otherwise

The function tries to set the value of the parameter with the name given in args. If the parameter does not exist or is incompatible with the value passed, NULL is returned. To actually set the value the setParam function of the plugin is invoked.

template<typename _CmplxTp , typename _Tp >

RetVal ito::SetRealFunc	(	DataObject *	dObj,
		DataObject *	valueObj
	)

low-level, double templated method to save the element-wise real value of each element in source matrix to result matrix

This method takes the real value of a complex valued input matrix and stores it in the equivalent real typed result matrix

Parameters

*dObj	is source matrix, must have complex type
*resObj	is the resulting data object, which has the real data type which corresponds to the complex type

Returns

retOk

See also

std::abs

template<typename _Tp >

RetVal ito::ShiftLFunc	(	DataObject *	src,
		const unsigned char	shiftbit
	)

low-level, templated method which element-wisely shifts the values of the source matrix by a certain value to the left

Parameters

*src
shiftbit	are the number bits the values are shifted

Exceptions

cv::Exception

for unsupported data types (template specialization)

Returns

retOk

template<>

RetVal ito::ShiftLFunc< ito::complex128 >	(	DataObject *	,
		const unsigned	char
	)

template specialisation for shift function of type complex128

Exceptions

cv::Exception

since shifting is not defined for that input type

template<>

RetVal ito::ShiftLFunc< ito::complex64 >	(	DataObject *	,
		const unsigned	char
	)

template specialisation for shift function of type complex64

Exceptions

cv::Exception

since shifting is not defined for that input type

template<>

RetVal ito::ShiftLFunc< ito::float32 >	(	DataObject *	,
		const unsigned	char
	)

template specialisation for shift function of type float32

Exceptions

cv::Exception

since shifting is not defined for that input type

template<>

RetVal ito::ShiftLFunc< ito::float64 >	(	DataObject *	,
		const unsigned	char
	)

template specialisation for shift function of type float64

Exceptions

cv::Exception

since shifting is not defined for that input type

template<>

RetVal ito::ShiftLFunc< ito::Rgba32 >	(	DataObject *	,
		const unsigned	char
	)

template specialisation for shift function of type rgba32

Exceptions

cv::Exception

since shifting is not defined for that input type

template<typename _Tp >

RetVal ito::ShiftRFunc	(	DataObject *	src,
		const unsigned char	shiftbit
	)

low-level, templated method which element-wisely shifts the values of the source matrix by a certain value to the right

Parameters

*src
shiftbit	are the number bits the values are shifted

Exceptions

cv::Exception

for unsupported data types (template specialization)

Returns

retOk

template<>

RetVal ito::ShiftRFunc< ito::complex128 >	(	DataObject *	,
		const unsigned	char
	)

template specialisation for shift function of type complex128

Exceptions

cv::Exception

since shifting is not defined for that input type

template<>

RetVal ito::ShiftRFunc< ito::complex64 >	(	DataObject *	,
		const unsigned	char
	)

template specialisation for shift function of type complex64

Exceptions

cv::Exception

since shifting is not defined for that input type

template<>

RetVal ito::ShiftRFunc< ito::float32 >	(	DataObject *	,
		const unsigned	char
	)

template specialisation for shift function of type float32

Exceptions

cv::Exception

since shifting is not defined for that input type

template<>

RetVal ito::ShiftRFunc< ito::float64 >	(	DataObject *	,
		const unsigned	char
	)

template specialisation for shift function of type float64

Exceptions

cv::Exception

since shifting is not defined for that input type

template<>

RetVal ito::ShiftRFunc< ito::Rgba32 >	(	DataObject *	,
		const unsigned	char
	)

template specialisation for shift function of type rgba32

Exceptions

cv::Exception

since shifting is not defined for that input type

template<typename _Tp >

RetVal ito::SubFunc	(	const DataObject *	dObj1,
		const DataObject *	dObj2,
		DataObject *	dObjRes
	)

low-level, templated method for element-wise subtraction of values from second data object from values of first data object

dObjRes = dObj1 - dObj2

Parameters

*dObj1	is the first data object
*dObj2	is the second data object
*dObjRes	is the pointer to the data object, where the values will be written to. This data object must already be allocated.

Remarks

The size check for all data objects must be done before.

Returns

retOk

See also

operator -=, operator -

RetVal ito::writeObjectDataToFileV1 ( QXmlStreamWriter &  stream, DataObject *  dObjOut, int  elementsize  )

inline

This helper function writes the data(cv::mats) from the Object to the xml stream. This helper function writes the data(cv::mats) from the Object to the xml stream. Therefore the data is converted using QByteArray::toBase64() to avoid XML-conflict with the binary data.

Parameters

	[in|out]	stream outgoing xml-stream
[in]	dObjOut	The allocated src-Object
[in]	elementsize	Size of each matrix element in bytes

See also

saveDOBJ2XML, saveDOBJSpecificData2XML

RetVal ito::writeObjectHeaderToFileV1 ( QXmlStreamWriter &  stream, DataObject *  dObjOut, bool  doubleAsBinary, int &  elementsize  )

inline

This helper function writes the header of the Object to the xml stream. This helper function writes the header (dims, sizes, type) of an object and the metaData (complete DataObjectTags without tagsMap) from the Object to the xml stream. The values of the header are stored as string. The values of each axis-tag / value-tag / rotation matrix are in case of string-type directly written to the stream or in case of double converted to either strings directly (15 significat digits, >32Bit) or stored as lostfree binary (QByteArray::toBase64() to avoid XML-conflict). WARNING: Do not change the header (dims, sizes, type) information or the value of tags exported as binary (d2b).

Parameters

	[in|out]	stream outgoing xml-stream
[in]	dObjOut	The allocated src-Object
[in]	doubleAsBinary	Toggle binary export for double

See also

saveDOBJ2XML, saveDOBJSpecificData2XML, DataObjectTags

RetVal ito::writeObjectTagsToFileV1 ( QXmlStreamWriter &  stream, DataObject *  dObjOut, bool  doubleAsBinary  )

inline

This helper function writes the tags defined in the tagMap (DataObjectTags) from the Object to the xml stream. This helper function writes the tags defined in the tagMap (DataObjectTags) from the Object to the xml stream. Therefore the values of each tag are in case of string-type directly written to the stream or in case of double converted to either strings directly (15 significat digits, >32Bit) or stored as lostfree binary (QByteArray::toBase64() to avoid XML-conflict). WARNING: Do not change information or the value of tags exported as binary (d2b).

Parameters

	[in|out]	stream outgoing xml-stream
[in]	dObjOut	The allocated src-Object
[in]	doubleAsBinary	Toggle binary export for double

See also

saveDOBJ2XML, saveDOBJSpecificData2XML, DataObjectTags

template<typename _Tp >

RetVal ito::ZerosFunc	(	const int	sizeY,
		const int	sizeX,
		uchar **	dstMat
	)

low-level, templated method for creation of zero-valued matrix-plane

Parameters

sizeY	are the number of rows
sizeX	are the number of columns
**dstMat	is the pointer to the already allocated cv::Mat_<type>-matrix-plane

Returns

retOk

See also

zeros

Variable Documentation

tCoutFunc ito::fListCout[]

Initial value:

=
{
   coutFunc<int8>,
   coutFunc<uint8>,
   coutFunc<int16>,
   coutFunc<uint16>,
   coutFunc<int32>,
   coutFunc<uint32>,
   coutFunc<ito::float32>,
   coutFunc<ito::float64>,
   coutFunc<ito::complex64>,
   coutFunc<ito::complex128>,
   coutFunc<ito::Rgba32>
}

void* ito::ITOM_API_FUNCS_GRAPH_ARR[]

Initial value:

= {
        (void*)&singleApiFunctionsGraph.mnumberOfColorBars,     
        (void*)&singleApiFunctionsGraph.mgetColorBarName,       
        (void*)&singleApiFunctionsGraph.mgetColorBarIdx,        
        (void*)&singleApiFunctionsGraph.mgetFigure,             
        (void*)&singleApiFunctionsGraph.mgetPluginList,         
        (void*)&singleApiFunctionsGraph.mstartLiveData,         
        (void*)&singleApiFunctionsGraph.mstopLiveData,          
        (void*)&singleApiFunctionsGraph.mconnectLiveData,       
        (void*)&singleApiFunctionsGraph.mdisconnectLiveData,    
        (void*)&singleApiFunctionsGraph.mgetColorBarIdxFromName,
        (void*)&singleApiFunctionsGraph.mgetFigureSetting,      
        (void*)&singleApiFunctionsGraph.mgetPluginWidget,       
        (void*)&singleApiFunctionsGraph.mgetFigureUIDByHandle,  
        (void*)&singleApiFunctionsGraph.mgetPlotHandleByID,     
        (void*)&singleApiFunctionsGraph.sendParamToPyWorkspaceThreadSafe,       
        (void*)&singleApiFunctionsGraph.sendParamsToPyWorkspaceThreadSafe,      
        (void*)&QPropertyHelper::readProperty,                                  
        (void*)&QPropertyHelper::writeProperty,                                 
        (void*)&singleApiFunctionsGraph.mConnectToOutputAndErrorStream,         
        (void*)&singleApiFunctionsGraph.mDisconnectFromOutputAndErrorStream,    
        NULL
    }

struct ito::PyCMap ito::pyCMap[]

Initial value:

= {
    { "QString", "str" },
    { "QByteArray", "bytearray" },
    { "ito::Shape", "shape" },
    { "QVector<ito::Shape>", "seq. of shape" },
    { "QSharedPointer<ito::DataObject>", "dataObject" },
    { "QVector<double>", "seq. of float" },
    { "double", "float" },
    { "QVector<float>", "seq. of float" },
    { "QFont", "font" },
    { "QColor", "color str, rgba or hex" },
    { "QPointer<ito::AddInDataIO>", "dataIO" },
    { "QPointer<ito::AddInActuator>", "actuator" },
    { "QPointer<ito::AddInBase>", "dataIO or actuator" },
    { "QStringList", "seq. of str" },
    { "ito::AutoInterval", "autoInterval" },
    { "ito::ItomPlotHandle", "uiItem" },
    { "QRegion", "region" },
    { "QTime", "datetime.time" },
    { "QDate", "datetime.date" },
    { "QDateTime", "datetime.datetime" },
    { "QVector<int>", "seq. of int" },
    { "QVector3D", "seq. of 3 floats" },
    { 0, 0 }
}