qudi.util.widgets.plotting.roi.RectangleROI
===========================================

.. currentmodule:: qudi.util.widgets.plotting.roi

.. autoclass:: RectangleROI
   :no-members:
   :no-inherited-members:
   :no-special-members:
   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
   
      ~RectangleROI.__init__
   
   
      ~RectangleROI.acceptDrops
   
   
      ~RectangleROI.acceptHoverEvents
   
   
      ~RectangleROI.acceptTouchEvents
   
   
      ~RectangleROI.acceptedMouseButtons
   
   
      ~RectangleROI.addFreeHandle
   
   
      ~RectangleROI.addHandle
   
   
      ~RectangleROI.addRotateFreeHandle
   
   
      ~RectangleROI.addRotateHandle
   
   
      ~RectangleROI.addScaleHandle
   
   
      ~RectangleROI.addScaleRotateHandle
   
   
      ~RectangleROI.addToIndex
   
   
      ~RectangleROI.addTranslateHandle
   
   
      ~RectangleROI.advance
   
   
      ~RectangleROI.allChildItems
   
   
      ~RectangleROI.angle
   
   
      ~RectangleROI.applyGlobalTransform
   
   
      ~RectangleROI.blockSignals
   
   
      ~RectangleROI.boundingRect
   
   
      ~RectangleROI.boundingRegion
   
   
      ~RectangleROI.boundingRegionGranularity
   
   
      ~RectangleROI.cacheMode
   
   
      ~RectangleROI.cancelMove
   
   
      ~RectangleROI.changeParent
   
   
      ~RectangleROI.checkPointMove
   
   
      ~RectangleROI.checkRemoveHandle
   
   
      ~RectangleROI.childEvent
   
   
      ~RectangleROI.childItems
   
   
      ~RectangleROI.children
   
   
      ~RectangleROI.childrenBoundingRect
   
   
      ~RectangleROI.childrenShape
   
   
      ~RectangleROI.clearFocus
   
   
      ~RectangleROI.clipPath
   
   
      ~RectangleROI.collidesWithItem
   
   
      ~RectangleROI.collidesWithPath
   
   
      ~RectangleROI.collidingItems
   
   
      ~RectangleROI.commonAncestorItem
   
   
      ~RectangleROI.connect
   
   
      ~RectangleROI.connectNotify
   
   
      ~RectangleROI.contains
   
   
      ~RectangleROI.contextMenuEnabled
   
   
      ~RectangleROI.contextMenuEvent
   
   
      ~RectangleROI.cursor
   
   
      ~RectangleROI.customEvent
   
   
      ~RectangleROI.data
   
   
      ~RectangleROI.deleteLater
   
   
      ~RectangleROI.deviceTransform
   
   
      ~RectangleROI.disconnect
   
   
      ~RectangleROI.disconnectNotify
   
   
      ~RectangleROI.dragEnterEvent
   
   
      ~RectangleROI.dragLeaveEvent
   
   
      ~RectangleROI.dragMoveEvent
   
   
      ~RectangleROI.dropEvent
   
   
      ~RectangleROI.dumpObjectInfo
   
   
      ~RectangleROI.dumpObjectTree
   
   
      ~RectangleROI.dynamicPropertyNames
   
   
      ~RectangleROI.effectiveOpacity
   
   
      ~RectangleROI.emit
   
   
      ~RectangleROI.ensureVisible
   
   
      ~RectangleROI.event
   
   
      ~RectangleROI.eventFilter
   
   
      ~RectangleROI.extension
   
   
      ~RectangleROI.filtersChildEvents
   
   
      ~RectangleROI.findChild
   
   
      ~RectangleROI.findChildren
   
   
      ~RectangleROI.flags
   
   
      ~RectangleROI.focusInEvent
   
   
      ~RectangleROI.focusItem
   
   
      ~RectangleROI.focusOutEvent
   
   
      ~RectangleROI.focusProxy
   
   
      ~RectangleROI.focusScopeItem
   
   
      ~RectangleROI.forgetViewBox
   
   
      ~RectangleROI.forgetViewWidget
   
   
      ~RectangleROI.generateSvg
   
   
      ~RectangleROI.getAffineSliceParams
   
   
      ~RectangleROI.getArrayRegion
   
   
      ~RectangleROI.getArraySlice
   
   
      ~RectangleROI.getBoundingParents
   
   
      ~RectangleROI.getContextMenus
   
   
      ~RectangleROI.getGlobalTransform
   
   
      ~RectangleROI.getHandles
   
   
      ~RectangleROI.getLocalHandlePositions
   
   
      ~RectangleROI.getMenu
   
   
      ~RectangleROI.getSceneHandlePositions
   
   
      ~RectangleROI.getSnapPosition
   
   
      ~RectangleROI.getState
   
   
      ~RectangleROI.getViewBox
   
   
      ~RectangleROI.getViewWidget
   
   
      ~RectangleROI.grabGesture
   
   
      ~RectangleROI.grabKeyboard
   
   
      ~RectangleROI.grabMouse
   
   
      ~RectangleROI.graphicsEffect
   
   
      ~RectangleROI.group
   
   
      ~RectangleROI.handleMoveStarted
   
   
      ~RectangleROI.handlesChildEvents
   
   
      ~RectangleROI.hasCursor
   
   
      ~RectangleROI.hasFocus
   
   
      ~RectangleROI.hide
   
   
      ~RectangleROI.hoverEnterEvent
   
   
      ~RectangleROI.hoverEvent
   
   
      ~RectangleROI.hoverLeaveEvent
   
   
      ~RectangleROI.hoverMoveEvent
   
   
      ~RectangleROI.indexOfHandle
   
   
      ~RectangleROI.informViewBoundsChanged
   
   
      ~RectangleROI.inherits
   
   
      ~RectangleROI.inputMethodEvent
   
   
      ~RectangleROI.inputMethodHints
   
   
      ~RectangleROI.inputMethodQuery
   
   
      ~RectangleROI.installEventFilter
   
   
      ~RectangleROI.installSceneEventFilter
   
   
      ~RectangleROI.isActive
   
   
      ~RectangleROI.isAncestorOf
   
   
      ~RectangleROI.isBlockedByModalPanel
   
   
      ~RectangleROI.isClipped
   
   
      ~RectangleROI.isEnabled
   
   
      ~RectangleROI.isObscured
   
   
      ~RectangleROI.isObscuredBy
   
   
      ~RectangleROI.isPanel
   
   
      ~RectangleROI.isSelected
   
   
      ~RectangleROI.isSignalConnected
   
   
      ~RectangleROI.isUnderMouse
   
   
      ~RectangleROI.isVisible
   
   
      ~RectangleROI.isVisibleTo
   
   
      ~RectangleROI.isWidget
   
   
      ~RectangleROI.isWidgetType
   
   
      ~RectangleROI.isWindow
   
   
      ~RectangleROI.isWindowType
   
   
      ~RectangleROI.itemChange
   
   
      ~RectangleROI.itemTransform
   
   
      ~RectangleROI.keyPressEvent
   
   
      ~RectangleROI.keyReleaseEvent
   
   
      ~RectangleROI.killTimer
   
   
      ~RectangleROI.mapFromDevice
   
   
      ~RectangleROI.mapFromItem
   
   
      ~RectangleROI.mapFromParent
   
   
      ~RectangleROI.mapFromScene
   
   
      ~RectangleROI.mapFromView
   
   
      ~RectangleROI.mapRectFromDevice
   
   
      ~RectangleROI.mapRectFromItem
   
   
      ~RectangleROI.mapRectFromParent
   
   
      ~RectangleROI.mapRectFromScene
   
   
      ~RectangleROI.mapRectFromView
   
   
      ~RectangleROI.mapRectToDevice
   
   
      ~RectangleROI.mapRectToItem
   
   
      ~RectangleROI.mapRectToParent
   
   
      ~RectangleROI.mapRectToScene
   
   
      ~RectangleROI.mapRectToView
   
   
      ~RectangleROI.mapSceneToParent
   
   
      ~RectangleROI.mapToDevice
   
   
      ~RectangleROI.mapToItem
   
   
      ~RectangleROI.mapToParent
   
   
      ~RectangleROI.mapToScene
   
   
      ~RectangleROI.mapToView
   
   
      ~RectangleROI.matrix
   
   
      ~RectangleROI.metaObject
   
   
      ~RectangleROI.mouseClickEvent
   
   
      ~RectangleROI.mouseDoubleClickEvent
   
   
      ~RectangleROI.mouseDragEvent
   
   
      ~RectangleROI.mouseMoveEvent
   
   
      ~RectangleROI.mousePressEvent
   
   
      ~RectangleROI.mouseReleaseEvent
   
   
      ~RectangleROI.moveBy
   
   
      ~RectangleROI.movePoint
   
   
      ~RectangleROI.moveToThread
   
   
      ~RectangleROI.normalize_bounds
   
   
      ~RectangleROI.objectName
   
   
      ~RectangleROI.opacity
   
   
      ~RectangleROI.opaqueArea
   
   
      ~RectangleROI.paint
   
   
      ~RectangleROI.panel
   
   
      ~RectangleROI.panelModality
   
   
      ~RectangleROI.parent
   
   
      ~RectangleROI.parentBounds
   
   
      ~RectangleROI.parentChanged
   
   
      ~RectangleROI.parentItem
   
   
      ~RectangleROI.parentObject
   
   
      ~RectangleROI.parentWidget
   
   
      ~RectangleROI.pixelHeight
   
   
      ~RectangleROI.pixelLength
   
   
      ~RectangleROI.pixelSize
   
   
      ~RectangleROI.pixelVectors
   
   
      ~RectangleROI.pixelWidth
   
   
      ~RectangleROI.pos
   
   
      ~RectangleROI.prepareGeometryChange
   
   
      ~RectangleROI.property
   
   
      ~RectangleROI.raiseContextMenu
   
   
      ~RectangleROI.receivers
   
   
      ~RectangleROI.registerUserData
   
   
      ~RectangleROI.removeClicked
   
   
      ~RectangleROI.removeEventFilter
   
   
      ~RectangleROI.removeFromIndex
   
   
      ~RectangleROI.removeHandle
   
   
      ~RectangleROI.removeSceneEventFilter
   
   
      ~RectangleROI.renderShapeMask
   
   
      ~RectangleROI.replaceHandle
   
   
      ~RectangleROI.resetMatrix
   
   
      ~RectangleROI.resetTransform
   
   
      ~RectangleROI.rotate
   
   
      ~RectangleROI.rotation
   
   
      ~RectangleROI.saveState
   
   
      ~RectangleROI.scale
   
   
      ~RectangleROI.scene
   
   
      ~RectangleROI.sceneBoundingRect
   
   
      ~RectangleROI.sceneEvent
   
   
      ~RectangleROI.sceneEventFilter
   
   
      ~RectangleROI.sceneMatrix
   
   
      ~RectangleROI.scenePos
   
   
      ~RectangleROI.sceneTransform
   
   
      ~RectangleROI.scroll
   
   
      ~RectangleROI.sender
   
   
      ~RectangleROI.senderSignalIndex
   
   
      ~RectangleROI.setAcceptDrops
   
   
      ~RectangleROI.setAcceptHoverEvents
   
   
      ~RectangleROI.setAcceptTouchEvents
   
   
      ~RectangleROI.setAcceptedMouseButtons
   
   
      ~RectangleROI.setActive
   
   
      ~RectangleROI.setAngle
   
   
      ~RectangleROI.setBoundingRegionGranularity
   
   
      ~RectangleROI.setCacheMode
   
   
      ~RectangleROI.setCursor
   
   
      ~RectangleROI.setData
   
   
      ~RectangleROI.setEnabled
   
   
      ~RectangleROI.setExportMode
   
   
      ~RectangleROI.setFiltersChildEvents
   
   
      ~RectangleROI.setFlag
   
   
      ~RectangleROI.setFlags
   
   
      ~RectangleROI.setFocus
   
   
      ~RectangleROI.setFocusProxy
   
   
      ~RectangleROI.setGraphicsEffect
   
   
      ~RectangleROI.setGroup
   
   
      ~RectangleROI.setHandlesChildEvents
   
   
      ~RectangleROI.setInputMethodHints
   
   
      ~RectangleROI.setMatrix
   
   
      ~RectangleROI.setMouseHover
   
   
      ~RectangleROI.setObjectName
   
   
      ~RectangleROI.setOpacity
   
   
      ~RectangleROI.setPanelModality
   
   
      ~RectangleROI.setParent
   
   
      ~RectangleROI.setParentItem
   
   
      ~RectangleROI.setPen
   
   
      ~RectangleROI.setPos
   
   
      ~RectangleROI.setProperty
   
   
      ~RectangleROI.setRotation
   
   
      ~RectangleROI.setScale
   
   
      ~RectangleROI.setSelected
   
   
      ~RectangleROI.setSize
   
   
      ~RectangleROI.setState
   
   
      ~RectangleROI.setToolTip
   
   
      ~RectangleROI.setTransform
   
   
      ~RectangleROI.setTransformOriginPoint
   
   
      ~RectangleROI.setTransformations
   
   
      ~RectangleROI.setVisible
   
   
      ~RectangleROI.setX
   
   
      ~RectangleROI.setY
   
   
      ~RectangleROI.setZValue
   
   
      ~RectangleROI.set_area
   
   
      ~RectangleROI.set_bounds
   
   
      ~RectangleROI.set_min_size
   
   
      ~RectangleROI.shape
   
   
      ~RectangleROI.show
   
   
      ~RectangleROI.signalsBlocked
   
   
      ~RectangleROI.size
   
   
      ~RectangleROI.stackBefore
   
   
      ~RectangleROI.startTimer
   
   
      ~RectangleROI.stateChangeFinished
   
   
      ~RectangleROI.stateChanged
   
   
      ~RectangleROI.stateCopy
   
   
      ~RectangleROI.stateRect
   
   
      ~RectangleROI.thread
   
   
      ~RectangleROI.timerEvent
   
   
      ~RectangleROI.toGraphicsObject
   
   
      ~RectangleROI.toolTip
   
   
      ~RectangleROI.topLevelItem
   
   
      ~RectangleROI.topLevelWidget
   
   
      ~RectangleROI.tr
   
   
      ~RectangleROI.transform
   
   
      ~RectangleROI.transformAngle
   
   
      ~RectangleROI.transformOriginPoint
   
   
      ~RectangleROI.transformations
   
   
      ~RectangleROI.translate
   
   
      ~RectangleROI.type
   
   
      ~RectangleROI.ungrabGesture
   
   
      ~RectangleROI.ungrabKeyboard
   
   
      ~RectangleROI.ungrabMouse
   
   
      ~RectangleROI.unsetCursor
   
   
      ~RectangleROI.update
   
   
      ~RectangleROI.updateMicroFocus
   
   
      ~RectangleROI.viewChanged
   
   
      ~RectangleROI.viewPos
   
   
      ~RectangleROI.viewRangeChanged
   
   
      ~RectangleROI.viewRect
   
   
      ~RectangleROI.viewTransform
   
   
      ~RectangleROI.viewTransformChanged
   
   
      ~RectangleROI.wheelEvent
   
   
      ~RectangleROI.window
   
   
      ~RectangleROI.x
   
   
      ~RectangleROI.y
   
   
      ~RectangleROI.zValue
   
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
   
      ~RectangleROI.DeviceCoordinateCache
   
   
      ~RectangleROI.ItemAcceptsInputMethod
   
   
      ~RectangleROI.ItemChildAddedChange
   
   
      ~RectangleROI.ItemChildRemovedChange
   
   
      ~RectangleROI.ItemClipsChildrenToShape
   
   
      ~RectangleROI.ItemClipsToShape
   
   
      ~RectangleROI.ItemContainsChildrenInShape
   
   
      ~RectangleROI.ItemCoordinateCache
   
   
      ~RectangleROI.ItemCursorChange
   
   
      ~RectangleROI.ItemCursorHasChanged
   
   
      ~RectangleROI.ItemDoesntPropagateOpacityToChildren
   
   
      ~RectangleROI.ItemEnabledChange
   
   
      ~RectangleROI.ItemEnabledHasChanged
   
   
      ~RectangleROI.ItemFlagsChange
   
   
      ~RectangleROI.ItemFlagsHaveChanged
   
   
      ~RectangleROI.ItemHasNoContents
   
   
      ~RectangleROI.ItemIgnoresParentOpacity
   
   
      ~RectangleROI.ItemIgnoresTransformations
   
   
      ~RectangleROI.ItemIsFocusScope
   
   
      ~RectangleROI.ItemIsFocusable
   
   
      ~RectangleROI.ItemIsMovable
   
   
      ~RectangleROI.ItemIsPanel
   
   
      ~RectangleROI.ItemIsSelectable
   
   
      ~RectangleROI.ItemMatrixChange
   
   
      ~RectangleROI.ItemNegativeZStacksBehindParent
   
   
      ~RectangleROI.ItemOpacityChange
   
   
      ~RectangleROI.ItemOpacityHasChanged
   
   
      ~RectangleROI.ItemParentChange
   
   
      ~RectangleROI.ItemParentHasChanged
   
   
      ~RectangleROI.ItemPositionChange
   
   
      ~RectangleROI.ItemPositionHasChanged
   
   
      ~RectangleROI.ItemRotationChange
   
   
      ~RectangleROI.ItemRotationHasChanged
   
   
      ~RectangleROI.ItemScaleChange
   
   
      ~RectangleROI.ItemScaleHasChanged
   
   
      ~RectangleROI.ItemSceneChange
   
   
      ~RectangleROI.ItemSceneHasChanged
   
   
      ~RectangleROI.ItemScenePositionHasChanged
   
   
      ~RectangleROI.ItemSelectedChange
   
   
      ~RectangleROI.ItemSelectedHasChanged
   
   
      ~RectangleROI.ItemSendsGeometryChanges
   
   
      ~RectangleROI.ItemSendsScenePositionChanges
   
   
      ~RectangleROI.ItemStacksBehindParent
   
   
      ~RectangleROI.ItemStopsClickFocusPropagation
   
   
      ~RectangleROI.ItemStopsFocusHandling
   
   
      ~RectangleROI.ItemToolTipChange
   
   
      ~RectangleROI.ItemToolTipHasChanged
   
   
      ~RectangleROI.ItemTransformChange
   
   
      ~RectangleROI.ItemTransformHasChanged
   
   
      ~RectangleROI.ItemTransformOriginPointChange
   
   
      ~RectangleROI.ItemTransformOriginPointHasChanged
   
   
      ~RectangleROI.ItemUsesExtendedStyleOption
   
   
      ~RectangleROI.ItemVisibleChange
   
   
      ~RectangleROI.ItemVisibleHasChanged
   
   
      ~RectangleROI.ItemZValueChange
   
   
      ~RectangleROI.ItemZValueHasChanged
   
   
      ~RectangleROI.NoCache
   
   
      ~RectangleROI.NonModal
   
   
      ~RectangleROI.PanelModal
   
   
      ~RectangleROI.SceneModal
   
   
      ~RectangleROI.UserExtension
   
   
      ~RectangleROI.UserType
   
   
      ~RectangleROI.area
   
   
      ~RectangleROI.bounds
   
   
      ~RectangleROI.childrenChanged
   
   
      ~RectangleROI.destroyed
   
   
      ~RectangleROI.enabledChanged
   
   
      ~RectangleROI.heightChanged
   
   
      ~RectangleROI.min_size
   
   
      ~RectangleROI.objectNameChanged
   
   
      ~RectangleROI.opacityChanged
   
   
      ~RectangleROI.rotationChanged
   
   
      ~RectangleROI.scaleChanged
   
   
      ~RectangleROI.sigClicked
   
   
      ~RectangleROI.sigHoverEvent
   
   
      ~RectangleROI.sigRegionChangeFinished
   
   
      ~RectangleROI.sigRegionChangeStarted
   
   
      ~RectangleROI.sigRegionChanged
   
   
      ~RectangleROI.sigRemoveRequested
   
   
      ~RectangleROI.staticMetaObject
   
   
      ~RectangleROI.visibleChanged
   
   
      ~RectangleROI.widthChanged
   
   
      ~RectangleROI.xChanged
   
   
      ~RectangleROI.yChanged
   
   
      ~RectangleROI.zChanged