3.9

InstrumentView

This a python binding to the C++ class Mantidplot::InstrumentView.

bases: mantidplot.MDIWindow

class mantidplot.InstrumentView

The InstrumentWindow contains functionality for exploring a 3D model of an instrument. It is a tabbed widget offering rendering, picking, masking and grouping functions. There is also a tree view of the instrument hierarchy.

For further help see the functions defined on each of the following
  • InstrumentWidget
  • InstrumentWidgetRenderTab
  • InstrumentWidgetPickTab
  • InstrumentWidgetMaskTab
Both = 2
Box = 1
class CaptionPolicy
__init__

x.__init__(...) initializes x; see help(type(x)) for signature

bit_length() → int

Number of bits necessary to represent self in binary. >>> bin(37) ‘0b100101’ >>> (37).bit_length() 6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

InstrumentView.DrawChildren = 2
InstrumentView.DrawWindowBackground = 1
InstrumentView.HLine = 4
InstrumentView.IgnoreMask = 4
InstrumentView.Label = 1
InstrumentView.Name = 0
InstrumentView.NoFrame = 0
class InstrumentView.PaintDeviceMetric
__init__

x.__init__(...) initializes x; see help(type(x)) for signature

bit_length() → int

Number of bits necessary to represent self in binary. >>> bin(37) ‘0b100101’ >>> (37).bit_length() 6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

InstrumentView.Panel = 2
InstrumentView.PdmDepth = 6
InstrumentView.PdmDpiX = 7
InstrumentView.PdmDpiY = 8
InstrumentView.PdmHeight = 2
InstrumentView.PdmHeightMM = 4
InstrumentView.PdmNumColors = 5
InstrumentView.PdmPhysicalDpiX = 9
InstrumentView.PdmPhysicalDpiY = 10
InstrumentView.PdmWidth = 1
InstrumentView.PdmWidthMM = 3
InstrumentView.Plain = 16
InstrumentView.Raised = 32
class InstrumentView.RenderFlag
__init__

x.__init__(...) initializes x; see help(type(x)) for signature

bit_length() → int

Number of bits necessary to represent self in binary. >>> bin(37) ‘0b100101’ >>> (37).bit_length() 6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

class InstrumentView.RenderFlags

QWidget.RenderFlags(QWidget.RenderFlags) QWidget.RenderFlags(int) QWidget.RenderFlags()

__init__

x.__init__(...) initializes x; see help(type(x)) for signature

class InstrumentView.Shadow
__init__

x.__init__(...) initializes x; see help(type(x)) for signature

bit_length() → int

Number of bits necessary to represent self in binary. >>> bin(37) ‘0b100101’ >>> (37).bit_length() 6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

InstrumentView.Shadow_Mask = 240
class InstrumentView.Shape
__init__

x.__init__(...) initializes x; see help(type(x)) for signature

bit_length() → int

Number of bits necessary to represent self in binary. >>> bin(37) ‘0b100101’ >>> (37).bit_length() 6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

InstrumentView.Shape_Mask = 15
class InstrumentView.StyleMask
__init__

x.__init__(...) initializes x; see help(type(x)) for signature

bit_length() → int

Number of bits necessary to represent self in binary. >>> bin(37) ‘0b100101’ >>> (37).bit_length() 6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

InstrumentView.StyledPanel = 6
InstrumentView.Sunken = 48
InstrumentView.VLine = 5
InstrumentView.WinPanel = 3
InstrumentView.__init__

x.__init__(...) initializes x; see help(type(x)) for signature

InstrumentView.acceptDrops() → bool
InstrumentView.accessibleDescription() → QString
InstrumentView.accessibleName() → QString
InstrumentView.actionEvent(QActionEvent)
InstrumentView.actions() → list-of-QAction
InstrumentView.activateWindow()
InstrumentView.addAction(QAction)
InstrumentView.addActions(list-of-QAction)
InstrumentView.adjustSize()
InstrumentView.autoFillBackground() → bool
InstrumentView.backgroundRole() → QPalette.ColorRole
InstrumentView.baseSize() → QSize
InstrumentView.blockSignals(bool) → bool
InstrumentView.captionPolicy() → MDIWindow.CaptionPolicy
InstrumentView.changeColormap()

InstrumentView.changeColormap(QString)

InstrumentView.changeEvent(QEvent)
InstrumentView.childAt(QPoint) → QWidget

QWidget.childAt(int, int) -> QWidget

InstrumentView.childEvent(QChildEvent)
InstrumentView.children() → list-of-QObject
InstrumentView.childrenRect() → QRect
InstrumentView.childrenRegion() → QRegion
InstrumentView.clearFocus()
InstrumentView.clearMask()
InstrumentView.close() → bool
InstrumentView.closeEvent(QCloseEvent)
InstrumentView.colorCount() → int
InstrumentView.confirmClose(bool)
InstrumentView.connect(QObject, SIGNAL(), QObject, SLOT(), Qt.ConnectionType=Qt.AutoConnection) → bool

QObject.connect(QObject, SIGNAL(), callable, Qt.ConnectionType=Qt.AutoConnection) -> bool QObject.connect(QObject, SIGNAL(), SLOT(), Qt.ConnectionType=Qt.AutoConnection) -> bool

InstrumentView.connectNotify(SIGNAL())
InstrumentView.contentsMargins() → QMargins
InstrumentView.contentsRect() → QRect
InstrumentView.contextMenuEvent(QContextMenuEvent)
InstrumentView.contextMenuPolicy() → Qt.ContextMenuPolicy
InstrumentView.create(int window=0, bool initializeWindow=True, bool destroyOldWindow=True)
InstrumentView.cursor() → QCursor
InstrumentView.customContextMenuRequested

QWidget.customContextMenuRequested[QPoint] [signal]

InstrumentView.customEvent(QEvent)
InstrumentView.deleteLater()
InstrumentView.depth() → int
InstrumentView.destroy(bool destroyWindow=True, bool destroySubWindows=True)
InstrumentView.destroyed

QObject.destroyed[QObject] [signal] QObject.destroyed [signal]

InstrumentView.devType() → int
InstrumentView.disconnect(QObject, SIGNAL(), QObject, SLOT()) → bool

QObject.disconnect(QObject, SIGNAL(), callable) -> bool

InstrumentView.disconnectNotify(SIGNAL())
InstrumentView.dock()
InstrumentView.dragEnterEvent(QDragEnterEvent)
InstrumentView.dragLeaveEvent(QDragLeaveEvent)
InstrumentView.dragMoveEvent(QDragMoveEvent)
InstrumentView.drawFrame(QPainter)
InstrumentView.dropEvent(QDropEvent)
InstrumentView.dumpObjectInfo()
InstrumentView.dumpObjectTree()
InstrumentView.dynamicPropertyNames() → list-of-QByteArray
InstrumentView.effectiveWinId() → int
InstrumentView.emit(SIGNAL(), ...)
InstrumentView.enabledChange(bool)
InstrumentView.ensurePolished()
InstrumentView.enterEvent(QEvent)
InstrumentView.event(QEvent) → bool
InstrumentView.eventFilter(QObject, QEvent) → bool
InstrumentView.find(int) → QWidget
InstrumentView.findChild(type, QString name=QString()) → QObject

QObject.findChild(tuple, QString name=QString()) -> QObject

InstrumentView.findChildren(type, QString name=QString()) → list-of-QObject

QObject.findChildren(tuple, QString name=QString()) -> list-of-QObject QObject.findChildren(type, QRegExp) -> list-of-QObject QObject.findChildren(tuple, QRegExp) -> list-of-QObject

InstrumentView.focusInEvent(QFocusEvent)
InstrumentView.focusNextChild() → bool
InstrumentView.focusNextPrevChild(bool) → bool
InstrumentView.focusOutEvent(QFocusEvent)
InstrumentView.focusPolicy() → Qt.FocusPolicy
InstrumentView.focusPreviousChild() → bool
InstrumentView.focusProxy() → QWidget
InstrumentView.focusWidget() → QWidget
InstrumentView.font() → QFont
InstrumentView.fontChange(QFont)
InstrumentView.fontInfo() → QFontInfo
InstrumentView.fontMetrics() → QFontMetrics
InstrumentView.foregroundRole() → QPalette.ColorRole
InstrumentView.frameGeometry() → QRect
InstrumentView.frameRect() → QRect
InstrumentView.frameShadow() → QFrame.Shadow
InstrumentView.frameShape() → QFrame.Shape
InstrumentView.frameSize() → QSize
InstrumentView.frameStyle() → int
InstrumentView.frameWidth() → int
InstrumentView.geometry() → QRect
InstrumentView.getContentsMargins() -> (int, int, int, int)
InstrumentView.getTab()

Returns a handler to the requested tab

Args:

title The full title of a tab in the window
Returns:
a pointer to the requested tab widget

Returns a handler to the requested tab

Args:
tab One of the Tab enumeration types:
InstrumentWidget.RENDER,InstrumentWidget.PICK, InstrumentWidget.MASK,InstrumentWidget.TREE
Returns:
a pointer to the requested tab widget
InstrumentView.grabGesture(Qt.GestureType, Qt.GestureFlags flags=Qt.GestureFlags(0))
InstrumentView.grabKeyboard()
InstrumentView.grabMouse()

QWidget.grabMouse(QCursor)

InstrumentView.grabShortcut(QKeySequence, Qt.ShortcutContext context=Qt.WindowShortcut) → int
InstrumentView.graphicsEffect() → QGraphicsEffect
InstrumentView.graphicsProxyWidget() → QGraphicsProxyWidget
InstrumentView.handle() → int
InstrumentView.hasFocus() → bool
InstrumentView.hasMouseTracking() → bool
InstrumentView.height() → int
InstrumentView.heightForWidth(int) → int
InstrumentView.heightMM() → int
InstrumentView.hide()
InstrumentView.hideEvent(QHideEvent)
InstrumentView.inherits(str) → bool
InstrumentView.inputContext() → QInputContext
InstrumentView.inputMethodEvent(QInputMethodEvent)
InstrumentView.inputMethodHints() → Qt.InputMethodHints
InstrumentView.inputMethodQuery(Qt.InputMethodQuery) → QVariant
InstrumentView.insertAction(QAction, QAction)
InstrumentView.insertActions(QAction, list-of-QAction)
InstrumentView.installEventFilter(QObject)
InstrumentView.isActiveWindow() → bool
InstrumentView.isAncestorOf(QWidget) → bool
InstrumentView.isDocked() → bool
InstrumentView.isEnabled() → bool
InstrumentView.isEnabledTo(QWidget) → bool
InstrumentView.isEnabledToTLW() → bool
InstrumentView.isFloating() → bool
InstrumentView.isFullScreen() → bool
InstrumentView.isHidden() → bool
InstrumentView.isLeftToRight() → bool
InstrumentView.isMaximized() → bool
InstrumentView.isMinimized() → bool
InstrumentView.isModal() → bool
InstrumentView.isRightToLeft() → bool
InstrumentView.isTopLevel() → bool
InstrumentView.isVisible() → bool
InstrumentView.isVisibleTo(QWidget) → bool
InstrumentView.isWidgetType() → bool
InstrumentView.isWindow() → bool
InstrumentView.isWindowModified() → bool
InstrumentView.keyPressEvent(QKeyEvent)
InstrumentView.keyReleaseEvent(QKeyEvent)
InstrumentView.keyboardGrabber() → QWidget
InstrumentView.killTimer(int)
InstrumentView.languageChange()
InstrumentView.layout() → QLayout
InstrumentView.layoutDirection() → Qt.LayoutDirection
InstrumentView.leaveEvent(QEvent)
InstrumentView.lineWidth() → int
InstrumentView.locale() → QLocale
InstrumentView.logicalDpiX() → int
InstrumentView.logicalDpiY() → int
InstrumentView.lower()
InstrumentView.mapFrom(QWidget, QPoint) → QPoint
InstrumentView.mapFromGlobal(QPoint) → QPoint
InstrumentView.mapFromParent(QPoint) → QPoint
InstrumentView.mapTo(QWidget, QPoint) → QPoint
InstrumentView.mapToGlobal(QPoint) → QPoint
InstrumentView.mapToParent(QPoint) → QPoint
InstrumentView.mask() → QRegion
InstrumentView.maximumHeight() → int
InstrumentView.maximumSize() → QSize
InstrumentView.maximumWidth() → int
InstrumentView.metaObject() → QMetaObject
InstrumentView.metric(QPaintDevice.PaintDeviceMetric) → int
InstrumentView.midLineWidth() → int
InstrumentView.minimumHeight() → int
InstrumentView.minimumSize() → QSize
InstrumentView.minimumSizeHint() → QSize
InstrumentView.minimumWidth() → int
InstrumentView.mouseDoubleClickEvent(QMouseEvent)
InstrumentView.mouseGrabber() → QWidget
InstrumentView.mouseMoveEvent(QMouseEvent)
InstrumentView.mousePressEvent(QMouseEvent)
InstrumentView.mouseReleaseEvent(QMouseEvent)
InstrumentView.move(QPoint)

QWidget.move(int, int)

InstrumentView.moveEvent(QMoveEvent)
InstrumentView.moveToThread(QThread)
InstrumentView.name() → QString
InstrumentView.nativeParentWidget() → QWidget
InstrumentView.nextInFocusChain() → QWidget
InstrumentView.normalGeometry() → QRect
InstrumentView.numColors() → int
InstrumentView.objectName() → QString
InstrumentView.overlay()

Overlays a workspace onto an unwrapped surface on the instrument view. Raises a dialog box if the current surface is not unwrapped.

Args:
wsName The name of the workspace
Returns:
A boolean indicating if the overlay was successful or not
InstrumentView.overrideWindowFlags(Qt.WindowFlags)
InstrumentView.overrideWindowState(Qt.WindowStates)
InstrumentView.paintEngine() → QPaintEngine
InstrumentView.paintEvent(QPaintEvent)
InstrumentView.paintingActive() → bool
InstrumentView.palette() → QPalette
InstrumentView.paletteChange(QPalette)
InstrumentView.parent() → QObject
InstrumentView.parentWidget() → QWidget
InstrumentView.physicalDpiX() → int
InstrumentView.physicalDpiY() → int
InstrumentView.pos() → QPoint
InstrumentView.previousInFocusChain() → QWidget
InstrumentView.property(str) → QVariant
InstrumentView.pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

InstrumentView.raise_()
InstrumentView.receivers(SIGNAL()) → int
InstrumentView.rect() → QRect
InstrumentView.releaseKeyboard()
InstrumentView.releaseMouse()
InstrumentView.releaseShortcut(int)
InstrumentView.removeAction(QAction)
InstrumentView.removeEventFilter(QObject)
InstrumentView.render(QPaintDevice, QPoint targetOffset=QPoint(), QRegion sourceRegion=QRegion(), QWidget.RenderFlags flags=QWidget.DrawWindowBackground|QWidget.DrawChildren)

QWidget.render(QPainter, QPoint targetOffset=QPoint(), QRegion sourceRegion=QRegion(), QWidget.RenderFlags flags=QWidget.DrawWindowBackground|QWidget.DrawChildren)

InstrumentView.repaint()

QWidget.repaint(int, int, int, int) QWidget.repaint(QRect) QWidget.repaint(QRegion)

InstrumentView.resetInputContext()
InstrumentView.resize(QSize)

QWidget.resize(int, int)

InstrumentView.resizeEvent(QResizeEvent)
InstrumentView.restore(QStringList)
InstrumentView.restoreGeometry(QByteArray) → bool
InstrumentView.saveGeometry() → QByteArray
InstrumentView.scroll(int, int)

QWidget.scroll(int, int, QRect)

InstrumentView.selectComponent(QString)
InstrumentView.sender() → QObject
InstrumentView.senderSignalIndex() → int
InstrumentView.setAcceptDrops(bool)
InstrumentView.setAccessibleDescription(QString)
InstrumentView.setAccessibleName(QString)
InstrumentView.setAttribute(Qt.WidgetAttribute, bool on=True)
InstrumentView.setAutoFillBackground(bool)
InstrumentView.setBackgroundRole(QPalette.ColorRole)
InstrumentView.setBaseSize(int, int)

QWidget.setBaseSize(QSize)

InstrumentView.setBinRange()

Updates the integration range over which the colours are calculated

Args:
min_value The minimum value over which the data is integrated max_value The maximum value over which the data is integrated
InstrumentView.setCaptionPolicy(MDIWindow.CaptionPolicy)
InstrumentView.setColorMapMaxValue(float)
InstrumentView.setColorMapMinValue(float)
InstrumentView.setColorMapRange(float, float)
InstrumentView.setContentsMargins(int, int, int, int)

QWidget.setContentsMargins(QMargins)

InstrumentView.setContextMenuPolicy(Qt.ContextMenuPolicy)
InstrumentView.setCursor(QCursor)
InstrumentView.setDisabled(bool)
InstrumentView.setEnabled(bool)
InstrumentView.setFixedHeight(int)
InstrumentView.setFixedSize(QSize)

QWidget.setFixedSize(int, int)

InstrumentView.setFixedWidth(int)
InstrumentView.setFocus()
InstrumentView.setFocusPolicy(Qt.FocusPolicy)
InstrumentView.setFocusProxy(QWidget)
InstrumentView.setFont(QFont)
InstrumentView.setForegroundRole(QPalette.ColorRole)
InstrumentView.setFrameRect(QRect)
InstrumentView.setFrameShadow(QFrame.Shadow)
InstrumentView.setFrameShape(QFrame.Shape)
InstrumentView.setFrameStyle(int)
InstrumentView.setGeometry(QRect)

QWidget.setGeometry(int, int, int, int)

InstrumentView.setGraphicsEffect(QGraphicsEffect)
InstrumentView.setHidden(bool)
InstrumentView.setInputContext(QInputContext)
InstrumentView.setInputMethodHints(Qt.InputMethodHints)
InstrumentView.setLayout(QLayout)
InstrumentView.setLayoutDirection(Qt.LayoutDirection)
InstrumentView.setLineWidth(int)
InstrumentView.setLocale(QLocale)
InstrumentView.setMask(QBitmap)

QWidget.setMask(QRegion)

InstrumentView.setMaximumHeight(int)
InstrumentView.setMaximumSize(int, int)

QWidget.setMaximumSize(QSize)

InstrumentView.setMaximumWidth(int)
InstrumentView.setMidLineWidth(int)
InstrumentView.setMinimumHeight(int)
InstrumentView.setMinimumSize(int, int)

QWidget.setMinimumSize(QSize)

InstrumentView.setMinimumWidth(int)
InstrumentView.setMouseTracking(bool)
InstrumentView.setObjectName(QString)
InstrumentView.setPalette(QPalette)
InstrumentView.setParent(QWidget)

QWidget.setParent(QWidget, Qt.WindowFlags)

InstrumentView.setProperty(str, QVariant) → bool
InstrumentView.setScaleType(GraphOptions.ScaleType)
InstrumentView.setShortcutAutoRepeat(int, bool enabled=True)
InstrumentView.setShortcutEnabled(int, bool enabled=True)
InstrumentView.setShown(bool)
InstrumentView.setSizeIncrement(int, int)

QWidget.setSizeIncrement(QSize)

InstrumentView.setSizePolicy(QSizePolicy)

QWidget.setSizePolicy(QSizePolicy.Policy, QSizePolicy.Policy)

InstrumentView.setStatusTip(QString)
InstrumentView.setStyle(QStyle)
InstrumentView.setStyleSheet(QString)
InstrumentView.setTabOrder(QWidget, QWidget)
InstrumentView.setToolTip(QString)
InstrumentView.setUpdatesEnabled(bool)
InstrumentView.setViewType(QString)
InstrumentView.setVisible(bool)
InstrumentView.setWhatsThis(QString)
InstrumentView.setWindowFilePath(QString)
InstrumentView.setWindowFlags(Qt.WindowFlags)
InstrumentView.setWindowIcon(QIcon)
InstrumentView.setWindowIconText(QString)
InstrumentView.setWindowLabel(QString)
InstrumentView.setWindowModality(Qt.WindowModality)
InstrumentView.setWindowModified(bool)
InstrumentView.setWindowOpacity(float)
InstrumentView.setWindowRole(QString)
InstrumentView.setWindowState(Qt.WindowStates)
InstrumentView.setWindowTitle(QString)
InstrumentView.show()
InstrumentView.showEvent(QShowEvent)
InstrumentView.showFullScreen()
InstrumentView.showMaximized()
InstrumentView.showMinimized()
InstrumentView.showNormal()
InstrumentView.signalsBlocked() → bool
InstrumentView.size() → QSize
InstrumentView.sizeHint() → QSize
InstrumentView.sizeIncrement() → QSize
InstrumentView.sizePolicy() → QSizePolicy
InstrumentView.stackUnder(QWidget)
InstrumentView.startTimer(int) → int
InstrumentView.staticMetaObject = <PyQt4.QtCore.QMetaObject object at 0xc986c90>
InstrumentView.statusTip() → QString
InstrumentView.style() → QStyle
InstrumentView.styleSheet() → QString
InstrumentView.tabletEvent(QTabletEvent)
InstrumentView.testAttribute(Qt.WidgetAttribute) → bool
InstrumentView.thread() → QThread
InstrumentView.timerEvent(QTimerEvent)
InstrumentView.toolTip() → QString
InstrumentView.topLevelWidget() → QWidget
InstrumentView.tr(str, str disambiguation=None, int n=-1) → QString
InstrumentView.trUtf8(str, str disambiguation=None, int n=-1) → QString
InstrumentView.underMouse() → bool
InstrumentView.undock()
InstrumentView.ungrabGesture(Qt.GestureType)
InstrumentView.unsetCursor()
InstrumentView.unsetLayoutDirection()
InstrumentView.unsetLocale()
InstrumentView.update()

QWidget.update(QRect) QWidget.update(QRegion) QWidget.update(int, int, int, int)

InstrumentView.updateGeometry()
InstrumentView.updateMicroFocus()
InstrumentView.updatesEnabled() → bool
InstrumentView.visibleRegion() → QRegion
InstrumentView.whatsThis() → QString
InstrumentView.wheelEvent(QWheelEvent)
InstrumentView.width() → int
InstrumentView.widthMM() → int
InstrumentView.winId() → int
InstrumentView.window() → QWidget
InstrumentView.windowActivationChange(bool)
InstrumentView.windowFilePath() → QString
InstrumentView.windowFlags() → Qt.WindowFlags
InstrumentView.windowIcon() → QIcon
InstrumentView.windowIconText() → QString
InstrumentView.windowLabel() → object
InstrumentView.windowModality() → Qt.WindowModality
InstrumentView.windowOpacity() → float
InstrumentView.windowRole() → QString
InstrumentView.windowState() → Qt.WindowStates
InstrumentView.windowTitle() → QString
InstrumentView.windowType() → Qt.WindowType
InstrumentView.x() → int
InstrumentView.x11Info() → QX11Info
InstrumentView.x11PictureHandle() → int
InstrumentView.y() → int