NeuXtalViz.views package#
Submodules#
- class NeuXtalVizWidget(parent=None)[source]#
Bases:
QWidgetBase widget for all NeuXtalViz views, providing shared functionality and interface for user-facing widgets.
- Attributes:
paintersushort
Methods
acceptDrops(self, /)accessibleDescription(self, /)accessibleIdentifier(self, /)accessibleName(self, /)actionEvent(self, event, /)actions(self, /)activateWindow(self, /)addAction(...)addActions(self, actions, /)adjustSize(self, /)autoFillBackground(self, /)auto_scale_dropdown(combo)Autoscale a combobox width to fit text plus any icons/checks.
State of axes.
backgroundRole(self, /)backingStore(self, /)baseSize(self, /)blockSignals(self, b, /)changeEvent(self, event, /)Enable or disable parallel projection.
childAt(...)childEvent(self, event, /)children(self, /)childrenRect(self, /)childrenRegion(self, /)clearFocus(self, /)clearMask(self, /)close(self, /)closeEvent(self, event, /)colorCount(self, /)connect(...)connectNotify(self, signal, /)connect_az(left, right)Connect Azimuth to presenter handler.
connect_elev(up, down)Connect Elevate to presenter handler.
connect_manual_axis(view_manual)Manual axis view connection.
connect_manual_up_axis(view_manual)Manual axis upv iew connection.
connect_real_axes(view_a, view_b, view_c)Real axes view connections.
connect_reciprocal_axes(view_a_star, ...)Reciprocal axes view connections.
connect_reciprocal_real_compass(change_lattice)Reciprocal/real axis compass
connect_rotate(cww, cw)Connect Roll to presenter handler.
connect_save_screenshot(save_screenshot)Screenshot connection.
connect_stop(stop)Connect stop button to presenter callback.
contentsMargins(self, /)contentsRect(self, /)contextMenuEvent(self, event, /)contextMenuPolicy(self, /)create(self, /[, arg__1, initializeWindow, ...])createWinId(self, /)createWindowContainer(window, /[, parent, flags])cursor(self, /)customEvent(self, event, /)deleteLater(self, /)depth(self, /)destroy(self, /[, destroyWindow, ...])devType(self, /)devicePixelRatio(self, /)devicePixelRatioF(self, /)devicePixelRatioFScale()disconnect(...)disconnectNotify(self, signal, /)dragEnterEvent(self, event, /)dragLeaveEvent(self, event, /)dragMoveEvent(self, event, /)dropEvent(self, event, /)dumpObjectInfo(self, /)dumpObjectTree(self, /)dynamicPropertyNames(self, /)effectiveWinId(self, /)emit(self, signal, /, *args)encodeMetricF(metric, value, /)ensurePolished(self, /)enterEvent(self, event, /)event(self, event, /)eventFilter(self, watched, event, /)find(arg__1, /)findChild(self, type, /[, name, options])findChildren() -> List[~PlaceholderType] ))focusInEvent(self, event, /)focusNextChild(self, /)focusNextPrevChild(self, next, /)focusOutEvent(self, event, /)focusPolicy(self, /)focusPreviousChild(self, /)focusProxy(self, /)focusWidget(self, /)font(self, /)fontInfo(self, /)fontMetrics(self, /)foregroundRole(self, /)frameGeometry(self, /)frameSize(self, /)geometry(self, /)Return the current camera position, focal point, and up vectors.
Indices of manually entered direction components.
Indices of manually entered direction up components.
Return the rotation step in degrees from the rotate tab.
grab(self, /[, rectangle])grabGesture(self, type, /[, flags])grabKeyboard(self, /)grabMouse(-> None)grabShortcut(self, key, /[, context])graphicsEffect(self, /)graphicsProxyWidget(self, /)hasFocus(self, /)hasHeightForWidth(self, /)hasMouseTracking(self, /)hasTabletTracking(self, /)height(self, /)heightForWidth(self, arg__1, /)heightMM(self, /)hide(self, /)hideEvent(self, event, /)inherits(self, classname, /)initPainter(self, painter, /)inputMethodEvent(self, event, /)inputMethodHints(self, /)inputMethodQuery(self, arg__1, /)insertAction(self, before, action, /)insertActions(self, before, actions, /)installEventFilter(self, filterObj, /)internalWinId(self, /)isActiveWindow(self, /)isAncestorOf(self, child, /)isEnabled(self, /)isEnabledTo(self, arg__1, /)isFullScreen(self, /)isHidden(self, /)isLeftToRight(self, /)isMaximized(self, /)isMinimized(self, /)isModal(self, /)isQmlExposed(self, /)isQuickItemType(self, /)isRightToLeft(self, /)isSignalConnected(self, signal, /)isTopLevel(self, /)isVisible(self, /)isVisibleTo(self, arg__1, /)isWidgetType(self, /)isWindow(self, /)isWindowModified(self, /)isWindowType(self, /)keyPressEvent(self, event, /)keyReleaseEvent(self, event, /)keyboardGrabber()killTimer(-> None)layout(self, /)layoutDirection(self, /)leaveEvent(self, event, /)locale(self, /)logicalDpiX(self, /)logicalDpiY(self, /)lower(self, /)mapFrom(-> PySide6.QtCore.QPoint)mapFromGlobal(-> PySide6.QtCore.QPoint)mapFromParent(-> PySide6.QtCore.QPoint)mapTo(-> PySide6.QtCore.QPoint)mapToGlobal(-> PySide6.QtCore.QPoint)mapToParent(-> PySide6.QtCore.QPoint)mask(self, /)maximumHeight(self, /)maximumSize(self, /)maximumWidth(self, /)metaObject(self, /)metric(self, arg__1, /)minimumHeight(self, /)minimumSize(self, /)minimumSizeHint(self, /)minimumWidth(self, /)mouseDoubleClickEvent(self, event, /)mouseGrabber()mouseMoveEvent(self, event, /)mousePressEvent(self, event, /)mouseReleaseEvent(self, event, /)move(-> None)moveEvent(self, event, /)moveToThread(self, thread, /)nativeEvent(self, eventType, message, /)nativeParentWidget(self, /)nextInFocusChain(self, /)normalGeometry(self, /)objectName(self, /)overrideWindowFlags(self, type, /)overrideWindowState(self, state, /)paintEngine(self, /)paintEvent(self, event, /)paintingActive(self, /)palette(self, /)parent(self, /)parentWidget(self, /)physicalDpiX(self, /)physicalDpiY(self, /)pos(self, /)previousInFocusChain(self, /)property(self, name, /)raise_(self, /)receivers(self, signal, /)State of reciprocal lattice vectors.
rect(self, /)redirected(self, offset, /)releaseKeyboard(self, /)releaseMouse(self, /)releaseShortcut(self, id, /)removeAction(self, action, /)removeEventFilter(self, obj, /)render(, sourceRegion, renderFlags, renderFlags)repaint(-> None -> None -> None)Reset the camera.
reset_view([negative])Reset the view.
resize(-> None)resizeEvent(self, event, /)restoreGeometry(self, geometry, /)saveGeometry(self, /)save_screenshot(filename)Save plotter screenshot.
screen(self, /)scroll(-> None)sender(self, /)senderSignalIndex(self, /)setAcceptDrops(self, on, /)setAccessibleDescription(self, description, /)setAccessibleIdentifier(self, identifier, /)setAccessibleName(self, name, /)setAttribute(self, arg__1, /[, on])setAutoFillBackground(self, enabled, /)setBackgroundRole(self, arg__1, /)setBaseSize(-> None)setContentsMargins(-> None)setContextMenuPolicy(self, policy, /)setCursor(self, arg__1, /)setDisabled(self, arg__1, /)setEnabled(self, arg__1, /)setFixedHeight(self, h, /)setFixedSize(-> None)setFixedWidth(self, w, /)setFocus(-> None)setFocusPolicy(self, policy, /)setFocusProxy(self, arg__1, /)setFont(self, arg__1, /)setForegroundRole(self, arg__1, /)setGeometry(-> None)setGraphicsEffect(self, effect, /)setHidden(self, hidden, /)setInputMethodHints(self, hints, /)setLayout(self, arg__1, /)setLayoutDirection(self, direction, /)setLocale(self, locale, /)setMask(-> None)setMaximumHeight(self, maxh, /)setMaximumSize(-> None)setMaximumWidth(self, maxw, /)setMinimumHeight(self, minh, /)setMinimumSize(-> None)setMinimumWidth(self, minw, /)setMouseTracking(self, enable, /)setObjectName(self, name, /)setPalette(self, arg__1, /)setParent(-> None)setProperty(self, name, value, /)setScreen(self, arg__1, /)setShortcutAutoRepeat(self, id, /[, enable])setShortcutEnabled(self, id, /[, enable])setSizeIncrement(-> None)setSizePolicy(-> None)setStatusTip(self, arg__1, /)setStyle(self, arg__1, /)setStyleSheet(self, styleSheet, /)setTabOrder(arg__1, arg__2, /)setTabletTracking(self, enable, /)setToolTip(self, arg__1, /)setToolTipDuration(self, msec, /)setUpdatesEnabled(self, enable, /)setVisible(self, visible, /)setWhatsThis(self, arg__1, /)setWindowFilePath(self, filePath, /)setWindowFlag(self, arg__1, /[, on])setWindowFlags(self, type, /)setWindowIcon(self, icon, /)setWindowIconText(self, arg__1, /)setWindowModality(self, windowModality, /)setWindowModified(self, arg__1, /)setWindowOpacity(self, level, /)setWindowRole(self, arg__1, /)setWindowState(self, state, /)setWindowTitle(self, arg__1, /)set_camera_state(position, focal_point, up)Apply a new camera state to the underlying plotter and refresh.
set_info(status)Update status information.
set_oriented_lattice_parameters(a, b, c, ...)Update the oriented lattice paramters.
set_position(pos)Set the position.
set_step(progress)Update progress step.
Apply a transform to the axes.
sharedPainter(self, /)show(self, /)showEvent(self, event, /)showFullScreen(self, /)showMaximized(self, /)showMinimized(self, /)showNormal(self, /)signalsBlocked(self, /)size(self, /)sizeHint(self, /)sizeIncrement(self, /)sizePolicy(self, /)stackUnder(self, arg__1, /)startTimer(self, interval, /[, timerType])start_worker_pool(worker)Create a worker pool and connect output to console.
statusTip(self, /)Stop all running worker processes.
stop_processing(stop_event)Check if a stop has been requested.
style(self, /)styleSheet(self, /)tabletEvent(self, event, /)testAttribute(self, arg__1, /)thread(self, /)timerEvent(self, event, /)toolTip(self, /)toolTipDuration(self, /)topLevelWidget(self, /)tr(self, sourceText, /[, disambiguation, n])underMouse(self, /)ungrabGesture(self, type, /)unsetCursor(self, /)unsetLayoutDirection(self, /)unsetLocale(self, /)update(-> None -> None -> None)updateGeometry(self, /)updateMicroFocus(self, /[, query])update_camera_display(roll, elevation, azimuth)Update the read-only camera orientation display, if present.
Change the axes labels between Miller and fractional notation.
updatesEnabled(self, /)view_up_vector(vec)Set the camera according to given vector(s).
view_vector(vecs)Set the camera according to given vector(s).
view_xy()View \(xy\)-plane.
view_xz()View \(xz\)-plane.
view_yx()View \(yx\)-plane.
view_yz()View \(yz\)-plane.
view_zx()View \(zx\)-plane.
view_zy()View \(zy\)-plane.
visibleRegion(self, /)whatsThis(self, /)wheelEvent(self, event, /)width(self, /)widthMM(self, /)winId(self, /)window(self, /)windowFilePath(self, /)windowFlags(self, /)windowHandle(self, /)windowIcon(self, /)windowIconText(self, /)windowModality(self, /)windowOpacity(self, /)windowRole(self, /)windowState(self, /)windowTitle(self, /)windowType(self, /)worker(task)Worker task.
x(self, /)y(self, /)PaintDeviceMetric
RenderFlag
append_to_console
cam_ready
clear_scene
connect_camera_ready
customContextMenuRequested
destroyed
get_camera_roll_direction
log_output
objectNameChanged
reset_scene
save_screenshot_file_dialog
show_axes
toggle_console
update_theme
windowIconChanged
windowIconTextChanged
windowTitleChanged
- auto_scale_dropdown(combo)[source]#
Autoscale a combobox width to fit text plus any icons/checks.
This keeps the drop-down (and closed state) wide enough for the longest item label while leaving extra room for icons or check indicators drawn on the left-hand side.
- connect_manual_axis(view_manual)[source]#
Manual axis view connection.
- Parameters:
- view_manualfunction
Manual axis view handler.
- connect_manual_up_axis(view_manual)[source]#
Manual axis upv iew connection.
- Parameters:
- view_manualfunction
Manual axis up view handler.
- connect_real_axes(view_a, view_b, view_c)[source]#
Real axes view connections.
- Parameters:
- view_afunction
\(a\)-axis view handler.
- view_bfunction
\(b\)-axis view handler.
- view_cfunction
\(c\)-axis view handler.
- connect_reciprocal_axes(view_a_star, view_b_star, view_c_star)[source]#
Reciprocal axes view connections.
- Parameters:
- view_a_starfunction
\(a^st\)-axis view handler.
- view_b_starfunction
\(b^st\)-axis view handler.
- view_c_starfunction
\(c^st\)-axis view handler.
- connect_reciprocal_real_compass(change_lattice)[source]#
Reciprocal/real axis compass
- Parameters:
- change_latticefunction
Lattice handler.
- connect_save_screenshot(save_screenshot)[source]#
Screenshot connection.
- Parameters:
- save_screenshotfunction
Screenshot handler.
- connect_stop(stop)[source]#
Connect stop button to presenter callback.
- Parameters:
- stopcallable
Callback function to handle stop requests.
- get_manual_axis_indices()[source]#
Indices of manually entered direction components.
- Returns:
- axes_typestr, [hkl] or [uvw]
Miller index or fractional coordinate.
- ind3-element 1d array-like
Indices.
- get_manual_axis_up_indices()[source]#
Indices of manually entered direction up components.
- Returns:
- axes_typestr, [hkl] or [uvw]
Miller index or fractional coordinate.
- ind3-element 1d array-like
Indices.
- save_screenshot(filename)[source]#
Save plotter screenshot.
- Parameters:
- filenamestr
Filename with *.png extension.
- set_camera_state(position, focal_point, up)[source]#
Apply a new camera state to the underlying plotter and refresh.
- set_oriented_lattice_parameters(a, b, c, alpha, beta, gamma, u, v)[source]#
Update the oriented lattice paramters.
- Parameters:
- a, b, cfloat
Lattice constants.
- alpha, beta, gammafloat
Lattice angles.
- set_position(pos)[source]#
Set the position.
- Parameters:
- pos3-element 1d array-like
Coordinate position.
- set_transform(T)[source]#
Apply a transform to the axes.
- Parameters:
- T3x3 2d array
Trasformation matrix.
- static stop_processing(stop_event)[source]#
Check if a stop has been requested.
Convenience method for worker tasks to check if they should terminate early.
- Parameters:
- stop_eventthreading.Event or None
The stop event to check.
- Returns:
- stopbool
True if stop was requested, False otherwise.
- update_camera_display(roll, elevation, azimuth)[source]#
Update the read-only camera orientation display, if present.
This shows the camera’s roll, elevation, azimuth in degrees.
- view_up_vector(vec)[source]#
Set the camera according to given vector(s).
- Parameters:
- vec3 element 1d array-like
Camera up direction.
- class CrystalStructureView(parent=None)[source]#
Bases:
NeuXtalVizWidgetView for visualizing and editing crystal structures in NeuXtalViz.
Provides user interface elements for entering lattice parameters, selecting crystal system and space group, loading/saving structure files, and visualizing atomic positions and structure factors.
- Attributes:
paintersushort
Methods
acceptDrops(self, /)accessibleDescription(self, /)accessibleIdentifier(self, /)accessibleName(self, /)actionEvent(self, event, /)actions(self, /)activateWindow(self, /)addAction(...)addActions(self, actions, /)adjustSize(self, /)autoFillBackground(self, /)auto_scale_dropdown(combo)Autoscale a combobox width to fit text plus any icons/checks.
axes_show()State of axes.
backgroundRole(self, /)backingStore(self, /)baseSize(self, /)blockSignals(self, b, /)changeEvent(self, event, /)change_projection()Enable or disable parallel projection.
childAt(...)childEvent(self, event, /)children(self, /)childrenRect(self, /)childrenRegion(self, /)clearFocus(self, /)clearMask(self, /)close(self, /)closeEvent(self, event, /)colorCount(self, /)connect(...)connectNotify(self, signal, /)connect_az(left, right)Connect Azimuth to presenter handler.
connect_elev(up, down)Connect Elevate to presenter handler.
connect_manual_axis(view_manual)Manual axis view connection.
connect_manual_up_axis(view_manual)Manual axis upv iew connection.
connect_real_axes(view_a, view_b, view_c)Real axes view connections.
connect_reciprocal_axes(view_a_star, ...)Reciprocal axes view connections.
connect_reciprocal_real_compass(change_lattice)Reciprocal/real axis compass
connect_rotate(cww, cw)Connect Roll to presenter handler.
connect_save_screenshot(save_screenshot)Screenshot connection.
connect_stop(stop)Connect stop button to presenter callback.
contentsMargins(self, /)contentsRect(self, /)contextMenuEvent(self, event, /)contextMenuPolicy(self, /)create(self, /[, arg__1, initializeWindow, ...])createWinId(self, /)createWindowContainer(window, /[, parent, flags])cursor(self, /)customEvent(self, event, /)deleteLater(self, /)depth(self, /)destroy(self, /[, destroyWindow, ...])devType(self, /)devicePixelRatio(self, /)devicePixelRatioF(self, /)devicePixelRatioFScale()disconnect(...)disconnectNotify(self, signal, /)dragEnterEvent(self, event, /)dragLeaveEvent(self, event, /)dragMoveEvent(self, event, /)dropEvent(self, event, /)dumpObjectInfo(self, /)dumpObjectTree(self, /)dynamicPropertyNames(self, /)effectiveWinId(self, /)emit(self, signal, /, *args)encodeMetricF(metric, value, /)ensurePolished(self, /)enterEvent(self, event, /)event(self, event, /)eventFilter(self, watched, event, /)find(arg__1, /)findChild(self, type, /[, name, options])findChildren() -> List[~PlaceholderType] ))focusInEvent(self, event, /)focusNextChild(self, /)focusNextPrevChild(self, next, /)focusOutEvent(self, event, /)focusPolicy(self, /)focusPreviousChild(self, /)focusProxy(self, /)focusWidget(self, /)font(self, /)fontInfo(self, /)fontMetrics(self, /)foregroundRole(self, /)frameGeometry(self, /)frameSize(self, /)geometry(self, /)get_camera_state()Return the current camera position, focal point, and up vectors.
get_manual_axis_indices()Indices of manually entered direction components.
get_manual_axis_up_indices()Indices of manually entered direction up components.
get_rotate_step()Return the rotation step in degrees from the rotate tab.
grab(self, /[, rectangle])grabGesture(self, type, /[, flags])grabKeyboard(self, /)grabMouse(-> None)grabShortcut(self, key, /[, context])graphicsEffect(self, /)graphicsProxyWidget(self, /)hasFocus(self, /)hasHeightForWidth(self, /)hasMouseTracking(self, /)hasTabletTracking(self, /)height(self, /)heightForWidth(self, arg__1, /)heightMM(self, /)hide(self, /)hideEvent(self, event, /)highlight(index, dataset)Toggle highlight color while preserving original atom color.
inherits(self, classname, /)initPainter(self, painter, /)inputMethodEvent(self, event, /)inputMethodHints(self, /)inputMethodQuery(self, arg__1, /)insertAction(self, before, action, /)insertActions(self, before, actions, /)installEventFilter(self, filterObj, /)internalWinId(self, /)isActiveWindow(self, /)isAncestorOf(self, child, /)isEnabled(self, /)isEnabledTo(self, arg__1, /)isFullScreen(self, /)isHidden(self, /)isLeftToRight(self, /)isMaximized(self, /)isMinimized(self, /)isModal(self, /)isQmlExposed(self, /)isQuickItemType(self, /)isRightToLeft(self, /)isSignalConnected(self, signal, /)isTopLevel(self, /)isVisible(self, /)isVisibleTo(self, arg__1, /)isWidgetType(self, /)isWindow(self, /)isWindowModified(self, /)isWindowType(self, /)keyPressEvent(self, event, /)keyReleaseEvent(self, event, /)keyboardGrabber()killTimer(-> None)layout(self, /)layoutDirection(self, /)leaveEvent(self, event, /)locale(self, /)logicalDpiX(self, /)logicalDpiY(self, /)lower(self, /)mapFrom(-> PySide6.QtCore.QPoint)mapFromGlobal(-> PySide6.QtCore.QPoint)mapFromParent(-> PySide6.QtCore.QPoint)mapTo(-> PySide6.QtCore.QPoint)mapToGlobal(-> PySide6.QtCore.QPoint)mapToParent(-> PySide6.QtCore.QPoint)mask(self, /)maximumHeight(self, /)maximumSize(self, /)maximumWidth(self, /)metaObject(self, /)metric(self, arg__1, /)minimumHeight(self, /)minimumSize(self, /)minimumSizeHint(self, /)minimumWidth(self, /)mouseDoubleClickEvent(self, event, /)mouseGrabber()mouseMoveEvent(self, event, /)mousePressEvent(self, event, /)mouseReleaseEvent(self, event, /)move(-> None)moveEvent(self, event, /)moveToThread(self, thread, /)nativeEvent(self, eventType, message, /)nativeParentWidget(self, /)nextInFocusChain(self, /)normalGeometry(self, /)objectName(self, /)overrideWindowFlags(self, type, /)overrideWindowState(self, state, /)paintEngine(self, /)paintEvent(self, event, /)paintingActive(self, /)palette(self, /)parent(self, /)parentWidget(self, /)physicalDpiX(self, /)physicalDpiY(self, /)pos(self, /)previousInFocusChain(self, /)property(self, name, /)raise_(self, /)receivers(self, signal, /)reciprocal_lattice()State of reciprocal lattice vectors.
rect(self, /)redirected(self, offset, /)releaseKeyboard(self, /)releaseMouse(self, /)releaseShortcut(self, id, /)removeAction(self, action, /)removeEventFilter(self, obj, /)render(, sourceRegion, renderFlags, renderFlags)repaint(-> None -> None -> None)reset_camera()Reset the camera.
reset_view([negative])Reset the view.
resize(-> None)resizeEvent(self, event, /)restoreGeometry(self, geometry, /)saveGeometry(self, /)save_screenshot(filename)Save plotter screenshot.
screen(self, /)scroll(-> None)sender(self, /)senderSignalIndex(self, /)setAcceptDrops(self, on, /)setAccessibleDescription(self, description, /)setAccessibleIdentifier(self, identifier, /)setAccessibleName(self, name, /)setAttribute(self, arg__1, /[, on])setAutoFillBackground(self, enabled, /)setBackgroundRole(self, arg__1, /)setBaseSize(-> None)setContentsMargins(-> None)setContextMenuPolicy(self, policy, /)setCursor(self, arg__1, /)setDisabled(self, arg__1, /)setEnabled(self, arg__1, /)setFixedHeight(self, h, /)setFixedSize(-> None)setFixedWidth(self, w, /)setFocus(-> None)setFocusPolicy(self, policy, /)setFocusProxy(self, arg__1, /)setFont(self, arg__1, /)setForegroundRole(self, arg__1, /)setGeometry(-> None)setGraphicsEffect(self, effect, /)setHidden(self, hidden, /)setInputMethodHints(self, hints, /)setLayout(self, arg__1, /)setLayoutDirection(self, direction, /)setLocale(self, locale, /)setMask(-> None)setMaximumHeight(self, maxh, /)setMaximumSize(-> None)setMaximumWidth(self, maxw, /)setMinimumHeight(self, minh, /)setMinimumSize(-> None)setMinimumWidth(self, minw, /)setMouseTracking(self, enable, /)setObjectName(self, name, /)setPalette(self, arg__1, /)setParent(-> None)setProperty(self, name, value, /)setScreen(self, arg__1, /)setShortcutAutoRepeat(self, id, /[, enable])setShortcutEnabled(self, id, /[, enable])setSizeIncrement(-> None)setSizePolicy(-> None)setStatusTip(self, arg__1, /)setStyle(self, arg__1, /)setStyleSheet(self, styleSheet, /)setTabOrder(arg__1, arg__2, /)setTabletTracking(self, enable, /)setToolTip(self, arg__1, /)setToolTipDuration(self, msec, /)setUpdatesEnabled(self, enable, /)setVisible(self, visible, /)setWhatsThis(self, arg__1, /)setWindowFilePath(self, filePath, /)setWindowFlag(self, arg__1, /[, on])setWindowFlags(self, type, /)setWindowIcon(self, icon, /)setWindowIconText(self, arg__1, /)setWindowModality(self, windowModality, /)setWindowModified(self, arg__1, /)setWindowOpacity(self, level, /)setWindowRole(self, arg__1, /)setWindowState(self, state, /)setWindowTitle(self, arg__1, /)set_camera_state(position, focal_point, up)Apply a new camera state to the underlying plotter and refresh.
set_info(status)Update status information.
set_oriented_lattice_parameters(a, b, c, ...)Update the oriented lattice paramters.
set_position(pos)Set the position.
set_step(progress)Update progress step.
set_transform(T)Apply a transform to the axes.
sharedPainter(self, /)show(self, /)showEvent(self, event, /)showFullScreen(self, /)showMaximized(self, /)showMinimized(self, /)showNormal(self, /)signalsBlocked(self, /)size(self, /)sizeHint(self, /)sizeIncrement(self, /)sizePolicy(self, /)stackUnder(self, arg__1, /)startTimer(self, interval, /[, timerType])start_worker_pool(worker)Create a worker pool and connect output to console.
statusTip(self, /)stop_processes()Stop all running worker processes.
stop_processing(stop_event)Check if a stop has been requested.
style(self, /)styleSheet(self, /)tabletEvent(self, event, /)testAttribute(self, arg__1, /)thread(self, /)timerEvent(self, event, /)toolTip(self, /)toolTipDuration(self, /)topLevelWidget(self, /)tr(self, sourceText, /[, disambiguation, n])underMouse(self, /)ungrabGesture(self, type, /)unsetCursor(self, /)unsetLayoutDirection(self, /)unsetLocale(self, /)update(-> None -> None -> None)updateGeometry(self, /)updateMicroFocus(self, /[, query])update_camera_display(roll, elevation, azimuth)Update the read-only camera orientation display, if present.
update_labels()Change the axes labels between Miller and fractional notation.
updatesEnabled(self, /)view_up_vector(vec)Set the camera according to given vector(s).
view_vector(vecs)Set the camera according to given vector(s).
view_xy()View \(xy\)-plane.
view_xz()View \(xz\)-plane.
view_yx()View \(yx\)-plane.
view_yz()View \(yz\)-plane.
view_zx()View \(zx\)-plane.
view_zy()View \(zy\)-plane.
visibleRegion(self, /)whatsThis(self, /)wheelEvent(self, event, /)width(self, /)widthMM(self, /)winId(self, /)window(self, /)windowFilePath(self, /)windowFlags(self, /)windowHandle(self, /)windowIcon(self, /)windowIconText(self, /)windowModality(self, /)windowOpacity(self, /)windowRole(self, /)windowState(self, /)windowTitle(self, /)windowType(self, /)worker(task)Worker task.
x(self, /)y(self, /)PaintDeviceMetric
RenderFlag
add_atoms
append_to_console
cam_ready
clear_scene
connect_F2_calculator
connect_atom_table
connect_camera_ready
connect_group_generator
connect_hkl_calculator
connect_lattice_parameters
connect_load_CIF
connect_row_highligter
connect_save_INS
connect_select_isotope
connect_setting_generator
constrain_parameters
customContextMenuRequested
destroyed
draw_cell
factors_tab
get_atom_site
get_camera_roll_direction
get_crystal_system
get_hkl
get_isotope
get_lattice_constants
get_minimum_d_spacing
get_periodic_table
get_scatterer
get_scatterers
get_setting
get_space_group
load_CIF_file_dialog
log_output
objectNameChanged
reset_scene
save_INS_file_dialog
save_screenshot_file_dialog
set_atom
set_atom_table
set_crystal_system
set_equivalents
set_factors
set_formula_z
set_isotope
set_lattice_constants
set_scatterer
set_scatterers
set_setting
set_space_group
set_unit_cell_volume
show_axes
structure_tab
toggle_console
update_settings
update_space_groups
update_theme
windowIconChanged
windowIconTextChanged
windowTitleChanged
- class ExperimentView(parent=None)[source]#
Bases:
NeuXtalVizWidgetView for experiment planning and peak visualization in NeuXtalViz.
Provides user interface elements for experiment setup, coverage analysis, peak calculation, and plan management.
- Attributes:
paintersushort
Methods
acceptDrops(self, /)accessibleDescription(self, /)accessibleIdentifier(self, /)accessibleName(self, /)actionEvent(self, event, /)actions(self, /)activateWindow(self, /)addAction(...)addActions(self, actions, /)adjustSize(self, /)autoFillBackground(self, /)auto_scale_dropdown(combo)Autoscale a combobox width to fit text plus any icons/checks.
axes_show()State of axes.
backgroundRole(self, /)backingStore(self, /)baseSize(self, /)blockSignals(self, b, /)calculate_mesh_step(item)Automatically calculate step size based on min, max, and angle.
changeEvent(self, event, /)change_projection()Enable or disable parallel projection.
childAt(...)childEvent(self, event, /)children(self, /)childrenRect(self, /)childrenRegion(self, /)clearFocus(self, /)clearMask(self, /)close(self, /)closeEvent(self, event, /)colorCount(self, /)connect(...)connectNotify(self, signal, /)connect_az(left, right)Connect Azimuth to presenter handler.
connect_elev(up, down)Connect Elevate to presenter handler.
connect_manual_axis(view_manual)Manual axis view connection.
connect_manual_up_axis(view_manual)Manual axis upv iew connection.
connect_real_axes(view_a, view_b, view_c)Real axes view connections.
connect_reciprocal_axes(view_a_star, ...)Reciprocal axes view connections.
connect_reciprocal_real_compass(change_lattice)Reciprocal/real axis compass
connect_rotate(cww, cw)Connect Roll to presenter handler.
connect_save_screenshot(save_screenshot)Screenshot connection.
connect_stop(stop)Connect stop button to presenter callback.
contentsMargins(self, /)contentsRect(self, /)contextMenuEvent(self, event, /)contextMenuPolicy(self, /)create(self, /[, arg__1, initializeWindow, ...])createWinId(self, /)createWindowContainer(window, /[, parent, flags])cursor(self, /)customEvent(self, event, /)deleteLater(self, /)depth(self, /)destroy(self, /[, destroyWindow, ...])devType(self, /)devicePixelRatio(self, /)devicePixelRatioF(self, /)devicePixelRatioFScale()disconnect(...)disconnectNotify(self, signal, /)dragEnterEvent(self, event, /)dragLeaveEvent(self, event, /)dragMoveEvent(self, event, /)dropEvent(self, event, /)dumpObjectInfo(self, /)dumpObjectTree(self, /)dynamicPropertyNames(self, /)effectiveWinId(self, /)emit(self, signal, /, *args)encodeMetricF(metric, value, /)ensurePolished(self, /)enterEvent(self, event, /)event(self, event, /)eventFilter(self, watched, event, /)find(arg__1, /)findChild(self, type, /[, name, options])findChildren() -> List[~PlaceholderType] ))focusInEvent(self, event, /)focusNextChild(self, /)focusNextPrevChild(self, next, /)focusOutEvent(self, event, /)focusPolicy(self, /)focusPreviousChild(self, /)focusProxy(self, /)focusWidget(self, /)font(self, /)fontInfo(self, /)fontMetrics(self, /)foregroundRole(self, /)frameGeometry(self, /)frameSize(self, /)geometry(self, /)get_camera_state()Return the current camera position, focal point, and up vectors.
get_manual_axis_indices()Indices of manually entered direction components.
get_manual_axis_up_indices()Indices of manually entered direction up components.
get_rotate_step()Return the rotation step in degrees from the rotate tab.
grab(self, /[, rectangle])grabGesture(self, type, /[, flags])grabKeyboard(self, /)grabMouse(-> None)grabShortcut(self, key, /[, context])graphicsEffect(self, /)graphicsProxyWidget(self, /)hasFocus(self, /)hasHeightForWidth(self, /)hasMouseTracking(self, /)hasTabletTracking(self, /)height(self, /)heightForWidth(self, arg__1, /)heightMM(self, /)hide(self, /)hideEvent(self, event, /)inherits(self, classname, /)initPainter(self, painter, /)inputMethodEvent(self, event, /)inputMethodHints(self, /)inputMethodQuery(self, arg__1, /)insertAction(self, before, action, /)insertActions(self, before, actions, /)installEventFilter(self, filterObj, /)internalWinId(self, /)isActiveWindow(self, /)isAncestorOf(self, child, /)isEnabled(self, /)isEnabledTo(self, arg__1, /)isFullScreen(self, /)isHidden(self, /)isLeftToRight(self, /)isMaximized(self, /)isMinimized(self, /)isModal(self, /)isQmlExposed(self, /)isQuickItemType(self, /)isRightToLeft(self, /)isSignalConnected(self, signal, /)isTopLevel(self, /)isVisible(self, /)isVisibleTo(self, arg__1, /)isWidgetType(self, /)isWindow(self, /)isWindowModified(self, /)isWindowType(self, /)keyPressEvent(self, event, /)keyReleaseEvent(self, event, /)keyboardGrabber()killTimer(-> None)layout(self, /)layoutDirection(self, /)leaveEvent(self, event, /)locale(self, /)logicalDpiX(self, /)logicalDpiY(self, /)lower(self, /)mapFrom(-> PySide6.QtCore.QPoint)mapFromGlobal(-> PySide6.QtCore.QPoint)mapFromParent(-> PySide6.QtCore.QPoint)mapTo(-> PySide6.QtCore.QPoint)mapToGlobal(-> PySide6.QtCore.QPoint)mapToParent(-> PySide6.QtCore.QPoint)mask(self, /)maximumHeight(self, /)maximumSize(self, /)maximumWidth(self, /)metaObject(self, /)metric(self, arg__1, /)minimumHeight(self, /)minimumSize(self, /)minimumSizeHint(self, /)minimumWidth(self, /)mouseDoubleClickEvent(self, event, /)mouseGrabber()mouseMoveEvent(self, event, /)mousePressEvent(self, event, /)mouseReleaseEvent(self, event, /)move(-> None)moveEvent(self, event, /)moveToThread(self, thread, /)nativeEvent(self, eventType, message, /)nativeParentWidget(self, /)nextInFocusChain(self, /)normalGeometry(self, /)objectName(self, /)overrideWindowFlags(self, type, /)overrideWindowState(self, state, /)paintEngine(self, /)paintEvent(self, event, /)paintingActive(self, /)palette(self, /)parent(self, /)parentWidget(self, /)physicalDpiX(self, /)physicalDpiY(self, /)pos(self, /)previousInFocusChain(self, /)property(self, name, /)raise_(self, /)receivers(self, signal, /)reciprocal_lattice()State of reciprocal lattice vectors.
rect(self, /)redirected(self, offset, /)releaseKeyboard(self, /)releaseMouse(self, /)releaseShortcut(self, id, /)removeAction(self, action, /)removeEventFilter(self, obj, /)render(, sourceRegion, renderFlags, renderFlags)repaint(-> None -> None -> None)reset_camera()Reset the camera.
reset_view([negative])Reset the view.
resize(-> None)resizeEvent(self, event, /)restoreGeometry(self, geometry, /)saveGeometry(self, /)save_screenshot(filename)Save plotter screenshot.
screen(self, /)scroll(-> None)sender(self, /)senderSignalIndex(self, /)setAcceptDrops(self, on, /)setAccessibleDescription(self, description, /)setAccessibleIdentifier(self, identifier, /)setAccessibleName(self, name, /)setAttribute(self, arg__1, /[, on])setAutoFillBackground(self, enabled, /)setBackgroundRole(self, arg__1, /)setBaseSize(-> None)setContentsMargins(-> None)setContextMenuPolicy(self, policy, /)setCursor(self, arg__1, /)setDisabled(self, arg__1, /)setEnabled(self, arg__1, /)setFixedHeight(self, h, /)setFixedSize(-> None)setFixedWidth(self, w, /)setFocus(-> None)setFocusPolicy(self, policy, /)setFocusProxy(self, arg__1, /)setFont(self, arg__1, /)setForegroundRole(self, arg__1, /)setGeometry(-> None)setGraphicsEffect(self, effect, /)setHidden(self, hidden, /)setInputMethodHints(self, hints, /)setLayout(self, arg__1, /)setLayoutDirection(self, direction, /)setLocale(self, locale, /)setMask(-> None)setMaximumHeight(self, maxh, /)setMaximumSize(-> None)setMaximumWidth(self, maxw, /)setMinimumHeight(self, minh, /)setMinimumSize(-> None)setMinimumWidth(self, minw, /)setMouseTracking(self, enable, /)setObjectName(self, name, /)setPalette(self, arg__1, /)setParent(-> None)setProperty(self, name, value, /)setScreen(self, arg__1, /)setShortcutAutoRepeat(self, id, /[, enable])setShortcutEnabled(self, id, /[, enable])setSizeIncrement(-> None)setSizePolicy(-> None)setStatusTip(self, arg__1, /)setStyle(self, arg__1, /)setStyleSheet(self, styleSheet, /)setTabOrder(arg__1, arg__2, /)setTabletTracking(self, enable, /)setToolTip(self, arg__1, /)setToolTipDuration(self, msec, /)setUpdatesEnabled(self, enable, /)setVisible(self, visible, /)setWhatsThis(self, arg__1, /)setWindowFilePath(self, filePath, /)setWindowFlag(self, arg__1, /[, on])setWindowFlags(self, type, /)setWindowIcon(self, icon, /)setWindowIconText(self, arg__1, /)setWindowModality(self, windowModality, /)setWindowModified(self, arg__1, /)setWindowOpacity(self, level, /)setWindowRole(self, arg__1, /)setWindowState(self, state, /)setWindowTitle(self, arg__1, /)set_camera_state(position, focal_point, up)Apply a new camera state to the underlying plotter and refresh.
set_info(status)Update status information.
set_oriented_lattice_parameters(a, b, c, ...)Update the oriented lattice paramters.
set_position(pos)Set the position.
set_step(progress)Update progress step.
set_transform(T)Apply a transform to the axes.
sharedPainter(self, /)show(self, /)showEvent(self, event, /)showFullScreen(self, /)showMaximized(self, /)showMinimized(self, /)showNormal(self, /)signalsBlocked(self, /)size(self, /)sizeHint(self, /)sizeIncrement(self, /)sizePolicy(self, /)stackUnder(self, arg__1, /)startTimer(self, interval, /[, timerType])start_worker_pool(worker)Create a worker pool and connect output to console.
statusTip(self, /)stop_processes()Stop all running worker processes.
stop_processing(stop_event)Check if a stop has been requested.
style(self, /)styleSheet(self, /)tabletEvent(self, event, /)testAttribute(self, arg__1, /)thread(self, /)timerEvent(self, event, /)toolTip(self, /)toolTipDuration(self, /)topLevelWidget(self, /)tr(self, sourceText, /[, disambiguation, n])underMouse(self, /)ungrabGesture(self, type, /)unsetCursor(self, /)unsetLayoutDirection(self, /)unsetLocale(self, /)update(-> None -> None -> None)updateGeometry(self, /)updateMicroFocus(self, /[, query])update_camera_display(roll, elevation, azimuth)Update the read-only camera orientation display, if present.
update_labels()Change the axes labels between Miller and fractional notation.
updatesEnabled(self, /)view_up_vector(vec)Set the camera according to given vector(s).
view_vector(vecs)Set the camera according to given vector(s).
view_xy()View \(xy\)-plane.
view_xz()View \(xz\)-plane.
view_yx()View \(yx\)-plane.
view_yz()View \(yz\)-plane.
view_zx()View \(zx\)-plane.
view_zy()View \(zy\)-plane.
visibleRegion(self, /)whatsThis(self, /)wheelEvent(self, event, /)width(self, /)widthMM(self, /)winId(self, /)window(self, /)windowFilePath(self, /)windowFlags(self, /)windowHandle(self, /)windowIcon(self, /)windowIconText(self, /)windowModality(self, /)windowOpacity(self, /)windowRole(self, /)windowState(self, /)windowTitle(self, /)windowType(self, /)worker(task)Worker task.
x(self, /)y(self, /)PaintDeviceMetric
RenderFlag
add_instrument
add_orientations
add_peaks
add_settings
append_to_console
cam_ready
clear_scene
connect_add_orientation
connect_add_plane
connect_calculate_double
connect_calculate_plane
connect_calculate_single
connect_calculate_single_alt
connect_camera_ready
connect_color_scheme
connect_combined
connect_convert_mesh_to_hkl
connect_convert_plan_to_hkl
connect_delete_angles
connect_harmonic_ready
connect_highlight_angles
connect_hkl_limits
connect_load_UB
connect_load_detector
connect_load_experiment
connect_load_goniometer
connect_load_mask
connect_mesh
connect_move_down
connect_move_up
connect_optimize
connect_peak_row_highlighter
connect_peak_table
connect_reset
connect_roi_ready
connect_save_CSV
connect_save_experiment
connect_selection_ready
connect_show_instrument
connect_slice_combo
connect_slice_line
connect_slice_thickness_line
connect_switch_crystal
connect_switch_instrument
connect_switch_lattice_centering
connect_switch_point_group
connect_update
connect_update_goniometer
connect_visualization_ready
connect_wavelength
coverage_tab
customContextMenuRequested
delete_angles
destroyed
draw_all
get_all_angles
get_all_comments
get_all_countings
get_all_settings
get_all_titles
get_all_values
get_angle_setting
get_angles
get_angles_to_delete
get_camera_roll_direction
get_color_scheme
get_comment
get_count_value
get_counting_index
get_counting_options
get_crystal_system
get_d
get_d_alternate
get_d_min
get_detector_calibration
get_free_angles
get_goniometer_calibration
get_goniometer_limits
get_horizontal
get_horizontal_alternate
get_input_hkls
get_instrument
get_intersect
get_intersect_alternate
get_lattice_centering
get_mask
get_mesh_angles
get_mode
get_motors
get_number_of_orientations
get_optimized_settings
get_orientations_to_use
get_peak
get_peak_list
get_plan_angles
get_plane_hkl_1
get_plane_hkl_2
get_plane_max_angle
get_plane_n_steps
get_point_group
get_projection_matrix
get_selected_angle
get_selected_plan_rows
get_settings
get_slice
get_slice_thickness
get_slice_value
get_title
get_vertical
get_vertical_alternate
get_wavelength
handle_item_changed
harm_ready
highlight_angles
highlight_peak
load_UB_file_dialog
load_detector_cal_dialog
load_experiment_file_dialog
load_goniometer_cal_dialog
load_mask_dialog
log_output
mesh_tab
objectNameChanged
on_press_inst
on_press_laue
peak_tab
plot_harmonics
plot_harmonics_alternate
plot_instrument
plot_instrument_alternate
plot_laue
plot_statistics
reset_scene
roi_ready
save_CSV_file_dialog
save_experiment_file_dialog
save_screenshot_file_dialog
sel_ready
set_angles
set_comment
set_counting_options
set_crystal_system
set_d
set_d_alternate
set_d_min
set_default_symmetry
set_detector_calibration
set_goniometer_calibration
set_goniometer_limits
set_hkl_limits
set_horizontal
set_horizontal_alternate
set_instrument
set_intersect
set_intersect_alternate
set_item_value
set_lattice_centering
set_lattice_centerings
set_mask
set_mode
set_modes
set_motors
set_peak
set_peak_list
set_point_group
set_point_groups
set_vertical
set_vertical_alternate
set_wavelength
show_axes
swap_angles
toggle_console
update_counting
update_inst
update_laue
update_limits
update_peaks_table
update_slice
update_tables
update_theme
update_wavelength
use_equivalents
use_symmetry
use_symmetry_mesh
viz_ready
windowIconChanged
windowIconTextChanged
windowTitleChanged
- class AtomView[source]#
Bases:
QWidget- Attributes:
paintersushort
Methods
acceptDrops(self, /)accessibleDescription(self, /)accessibleIdentifier(self, /)accessibleName(self, /)actionEvent(self, event, /)actions(self, /)activateWindow(self, /)addAction(...)addActions(self, actions, /)adjustSize(self, /)autoFillBackground(self, /)backgroundRole(self, /)backingStore(self, /)baseSize(self, /)blockSignals(self, b, /)changeEvent(self, event, /)childAt(...)childEvent(self, event, /)children(self, /)childrenRect(self, /)childrenRegion(self, /)clearFocus(self, /)clearMask(self, /)close(self, /)closeEvent(self, event, /)colorCount(self, /)connect(...)connectNotify(self, signal, /)contentsMargins(self, /)contentsRect(self, /)contextMenuEvent(self, event, /)contextMenuPolicy(self, /)create(self, /[, arg__1, initializeWindow, ...])createWinId(self, /)createWindowContainer(window, /[, parent, flags])cursor(self, /)customEvent(self, event, /)deleteLater(self, /)depth(self, /)destroy(self, /[, destroyWindow, ...])devType(self, /)devicePixelRatio(self, /)devicePixelRatioF(self, /)devicePixelRatioFScale()disconnect(...)disconnectNotify(self, signal, /)dragEnterEvent(self, event, /)dragLeaveEvent(self, event, /)dragMoveEvent(self, event, /)dropEvent(self, event, /)dumpObjectInfo(self, /)dumpObjectTree(self, /)dynamicPropertyNames(self, /)effectiveWinId(self, /)emit(self, signal, /, *args)encodeMetricF(metric, value, /)ensurePolished(self, /)enterEvent(self, event, /)event(self, event, /)eventFilter(self, watched, event, /)find(arg__1, /)findChild(self, type, /[, name, options])findChildren() -> List[~PlaceholderType] ))focusInEvent(self, event, /)focusNextChild(self, /)focusNextPrevChild(self, next, /)focusOutEvent(self, event, /)focusPolicy(self, /)focusPreviousChild(self, /)focusProxy(self, /)focusWidget(self, /)font(self, /)fontInfo(self, /)fontMetrics(self, /)foregroundRole(self, /)frameGeometry(self, /)frameSize(self, /)geometry(self, /)grab(self, /[, rectangle])grabGesture(self, type, /[, flags])grabKeyboard(self, /)grabMouse(-> None)grabShortcut(self, key, /[, context])graphicsEffect(self, /)graphicsProxyWidget(self, /)hasFocus(self, /)hasHeightForWidth(self, /)hasMouseTracking(self, /)hasTabletTracking(self, /)height(self, /)heightForWidth(self, arg__1, /)heightMM(self, /)hide(self, /)hideEvent(self, event, /)inherits(self, classname, /)initPainter(self, painter, /)inputMethodEvent(self, event, /)inputMethodHints(self, /)inputMethodQuery(self, arg__1, /)insertAction(self, before, action, /)insertActions(self, before, actions, /)installEventFilter(self, filterObj, /)internalWinId(self, /)isActiveWindow(self, /)isAncestorOf(self, child, /)isEnabled(self, /)isEnabledTo(self, arg__1, /)isFullScreen(self, /)isHidden(self, /)isLeftToRight(self, /)isMaximized(self, /)isMinimized(self, /)isModal(self, /)isQmlExposed(self, /)isQuickItemType(self, /)isRightToLeft(self, /)isSignalConnected(self, signal, /)isTopLevel(self, /)isVisible(self, /)isVisibleTo(self, arg__1, /)isWidgetType(self, /)isWindow(self, /)isWindowModified(self, /)isWindowType(self, /)keyPressEvent(self, event, /)keyReleaseEvent(self, event, /)keyboardGrabber()killTimer(-> None)layout(self, /)layoutDirection(self, /)leaveEvent(self, event, /)locale(self, /)logicalDpiX(self, /)logicalDpiY(self, /)lower(self, /)mapFrom(-> PySide6.QtCore.QPoint)mapFromGlobal(-> PySide6.QtCore.QPoint)mapFromParent(-> PySide6.QtCore.QPoint)mapTo(-> PySide6.QtCore.QPoint)mapToGlobal(-> PySide6.QtCore.QPoint)mapToParent(-> PySide6.QtCore.QPoint)mask(self, /)maximumHeight(self, /)maximumSize(self, /)maximumWidth(self, /)metaObject(self, /)metric(self, arg__1, /)minimumHeight(self, /)minimumSize(self, /)minimumSizeHint(self, /)minimumWidth(self, /)mouseDoubleClickEvent(self, event, /)mouseGrabber()mouseMoveEvent(self, event, /)mousePressEvent(self, event, /)mouseReleaseEvent(self, event, /)move(-> None)moveEvent(self, event, /)moveToThread(self, thread, /)nativeEvent(self, eventType, message, /)nativeParentWidget(self, /)nextInFocusChain(self, /)normalGeometry(self, /)objectName(self, /)overrideWindowFlags(self, type, /)overrideWindowState(self, state, /)paintEngine(self, /)paintEvent(self, event, /)paintingActive(self, /)palette(self, /)parent(self, /)parentWidget(self, /)physicalDpiX(self, /)physicalDpiY(self, /)pos(self, /)previousInFocusChain(self, /)property(self, name, /)raise_(self, /)receivers(self, signal, /)rect(self, /)redirected(self, offset, /)releaseKeyboard(self, /)releaseMouse(self, /)releaseShortcut(self, id, /)removeAction(self, action, /)removeEventFilter(self, obj, /)render(, sourceRegion, renderFlags, renderFlags)repaint(-> None -> None -> None)resize(-> None)resizeEvent(self, event, /)restoreGeometry(self, geometry, /)saveGeometry(self, /)screen(self, /)scroll(-> None)sender(self, /)senderSignalIndex(self, /)setAcceptDrops(self, on, /)setAccessibleDescription(self, description, /)setAccessibleIdentifier(self, identifier, /)setAccessibleName(self, name, /)setAttribute(self, arg__1, /[, on])setAutoFillBackground(self, enabled, /)setBackgroundRole(self, arg__1, /)setBaseSize(-> None)setContentsMargins(-> None)setContextMenuPolicy(self, policy, /)setCursor(self, arg__1, /)setDisabled(self, arg__1, /)setEnabled(self, arg__1, /)setFixedHeight(self, h, /)setFixedSize(-> None)setFixedWidth(self, w, /)setFocus(-> None)setFocusPolicy(self, policy, /)setFocusProxy(self, arg__1, /)setFont(self, arg__1, /)setForegroundRole(self, arg__1, /)setGeometry(-> None)setGraphicsEffect(self, effect, /)setHidden(self, hidden, /)setInputMethodHints(self, hints, /)setLayout(self, arg__1, /)setLayoutDirection(self, direction, /)setLocale(self, locale, /)setMask(-> None)setMaximumHeight(self, maxh, /)setMaximumSize(-> None)setMaximumWidth(self, maxw, /)setMinimumHeight(self, minh, /)setMinimumSize(-> None)setMinimumWidth(self, minw, /)setMouseTracking(self, enable, /)setObjectName(self, name, /)setPalette(self, arg__1, /)setParent(-> None)setProperty(self, name, value, /)setScreen(self, arg__1, /)setShortcutAutoRepeat(self, id, /[, enable])setShortcutEnabled(self, id, /[, enable])setSizeIncrement(-> None)setSizePolicy(-> None)setStatusTip(self, arg__1, /)setStyle(self, arg__1, /)setStyleSheet(self, styleSheet, /)setTabOrder(arg__1, arg__2, /)setTabletTracking(self, enable, /)setToolTip(self, arg__1, /)setToolTipDuration(self, msec, /)setUpdatesEnabled(self, enable, /)setVisible(self, visible, /)setWhatsThis(self, arg__1, /)setWindowFilePath(self, filePath, /)setWindowFlag(self, arg__1, /[, on])setWindowFlags(self, type, /)setWindowIcon(self, icon, /)setWindowIconText(self, arg__1, /)setWindowModality(self, windowModality, /)setWindowModified(self, arg__1, /)setWindowOpacity(self, level, /)setWindowRole(self, arg__1, /)setWindowState(self, state, /)setWindowTitle(self, arg__1, /)sharedPainter(self, /)show(self, /)showEvent(self, event, /)showFullScreen(self, /)showMaximized(self, /)showMinimized(self, /)showNormal(self, /)signalsBlocked(self, /)size(self, /)sizeHint(self, /)sizeIncrement(self, /)sizePolicy(self, /)stackUnder(self, arg__1, /)startTimer(self, interval, /[, timerType])statusTip(self, /)style(self, /)styleSheet(self, /)tabletEvent(self, event, /)testAttribute(self, arg__1, /)thread(self, /)timerEvent(self, event, /)toolTip(self, /)toolTipDuration(self, /)topLevelWidget(self, /)tr(self, sourceText, /[, disambiguation, n])underMouse(self, /)ungrabGesture(self, type, /)unsetCursor(self, /)unsetLayoutDirection(self, /)unsetLocale(self, /)update(-> None -> None -> None)updateGeometry(self, /)updateMicroFocus(self, /[, query])updatesEnabled(self, /)visibleRegion(self, /)whatsThis(self, /)wheelEvent(self, event, /)width(self, /)widthMM(self, /)winId(self, /)window(self, /)windowFilePath(self, /)windowFlags(self, /)windowHandle(self, /)windowIcon(self, /)windowIconText(self, /)windowModality(self, /)windowOpacity(self, /)windowRole(self, /)windowState(self, /)windowTitle(self, /)windowType(self, /)x(self, /)y(self, /)PaintDeviceMetric
RenderFlag
connect_isotopes
connect_selected
connect_selection
customContextMenuRequested
destroyed
get_isotope
get_selection
objectNameChanged
selection
set_atom_parameters
set_isotope_numbers
set_symbol_name
windowIconChanged
windowIconTextChanged
windowTitleChanged
- class PeriodicTableView(parent=None)[source]#
Bases:
QWidgetView for displaying and selecting elements from the periodic table in NeuXtalViz.
Provides a user interface for element selection, highlighting, and displaying element properties.
- Attributes:
paintersushort
Methods
acceptDrops(self, /)accessibleDescription(self, /)accessibleIdentifier(self, /)accessibleName(self, /)actionEvent(self, event, /)actions(self, /)activateWindow(self, /)addAction(...)addActions(self, actions, /)adjustSize(self, /)autoFillBackground(self, /)backgroundRole(self, /)backingStore(self, /)baseSize(self, /)blockSignals(self, b, /)changeEvent(self, event, /)childAt(...)childEvent(self, event, /)children(self, /)childrenRect(self, /)childrenRegion(self, /)clearFocus(self, /)clearMask(self, /)close(self, /)closeEvent(self, event, /)colorCount(self, /)connect(...)connectNotify(self, signal, /)contentsMargins(self, /)contentsRect(self, /)contextMenuEvent(self, event, /)contextMenuPolicy(self, /)create(self, /[, arg__1, initializeWindow, ...])createWinId(self, /)createWindowContainer(window, /[, parent, flags])cursor(self, /)customEvent(self, event, /)deleteLater(self, /)depth(self, /)destroy(self, /[, destroyWindow, ...])devType(self, /)devicePixelRatio(self, /)devicePixelRatioF(self, /)devicePixelRatioFScale()disconnect(...)disconnectNotify(self, signal, /)dragEnterEvent(self, event, /)dragLeaveEvent(self, event, /)dragMoveEvent(self, event, /)dropEvent(self, event, /)dumpObjectInfo(self, /)dumpObjectTree(self, /)dynamicPropertyNames(self, /)effectiveWinId(self, /)emit(self, signal, /, *args)encodeMetricF(metric, value, /)ensurePolished(self, /)enterEvent(self, event, /)event(self, event, /)eventFilter(self, watched, event, /)find(arg__1, /)findChild(self, type, /[, name, options])findChildren() -> List[~PlaceholderType] ))focusInEvent(self, event, /)focusNextChild(self, /)focusNextPrevChild(self, next, /)focusOutEvent(self, event, /)focusPolicy(self, /)focusPreviousChild(self, /)focusProxy(self, /)focusWidget(self, /)font(self, /)fontInfo(self, /)fontMetrics(self, /)foregroundRole(self, /)frameGeometry(self, /)frameSize(self, /)geometry(self, /)grab(self, /[, rectangle])grabGesture(self, type, /[, flags])grabKeyboard(self, /)grabMouse(-> None)grabShortcut(self, key, /[, context])graphicsEffect(self, /)graphicsProxyWidget(self, /)hasFocus(self, /)hasHeightForWidth(self, /)hasMouseTracking(self, /)hasTabletTracking(self, /)height(self, /)heightForWidth(self, arg__1, /)heightMM(self, /)hide(self, /)hideEvent(self, event, /)inherits(self, classname, /)initPainter(self, painter, /)inputMethodEvent(self, event, /)inputMethodHints(self, /)inputMethodQuery(self, arg__1, /)insertAction(self, before, action, /)insertActions(self, before, actions, /)installEventFilter(self, filterObj, /)internalWinId(self, /)isActiveWindow(self, /)isAncestorOf(self, child, /)isEnabled(self, /)isEnabledTo(self, arg__1, /)isFullScreen(self, /)isHidden(self, /)isLeftToRight(self, /)isMaximized(self, /)isMinimized(self, /)isModal(self, /)isQmlExposed(self, /)isQuickItemType(self, /)isRightToLeft(self, /)isSignalConnected(self, signal, /)isTopLevel(self, /)isVisible(self, /)isVisibleTo(self, arg__1, /)isWidgetType(self, /)isWindow(self, /)isWindowModified(self, /)isWindowType(self, /)keyPressEvent(self, event, /)keyReleaseEvent(self, event, /)keyboardGrabber()killTimer(-> None)layout(self, /)layoutDirection(self, /)leaveEvent(self, event, /)locale(self, /)logicalDpiX(self, /)logicalDpiY(self, /)lower(self, /)mapFrom(-> PySide6.QtCore.QPoint)mapFromGlobal(-> PySide6.QtCore.QPoint)mapFromParent(-> PySide6.QtCore.QPoint)mapTo(-> PySide6.QtCore.QPoint)mapToGlobal(-> PySide6.QtCore.QPoint)mapToParent(-> PySide6.QtCore.QPoint)mask(self, /)maximumHeight(self, /)maximumSize(self, /)maximumWidth(self, /)metaObject(self, /)metric(self, arg__1, /)minimumHeight(self, /)minimumSize(self, /)minimumSizeHint(self, /)minimumWidth(self, /)mouseDoubleClickEvent(self, event, /)mouseGrabber()mouseMoveEvent(self, event, /)mousePressEvent(self, event, /)mouseReleaseEvent(self, event, /)move(-> None)moveEvent(self, event, /)moveToThread(self, thread, /)nativeEvent(self, eventType, message, /)nativeParentWidget(self, /)nextInFocusChain(self, /)normalGeometry(self, /)objectName(self, /)overrideWindowFlags(self, type, /)overrideWindowState(self, state, /)paintEngine(self, /)paintEvent(self, event, /)paintingActive(self, /)palette(self, /)parent(self, /)parentWidget(self, /)physicalDpiX(self, /)physicalDpiY(self, /)pos(self, /)previousInFocusChain(self, /)property(self, name, /)raise_(self, /)receivers(self, signal, /)rect(self, /)redirected(self, offset, /)releaseKeyboard(self, /)releaseMouse(self, /)releaseShortcut(self, id, /)removeAction(self, action, /)removeEventFilter(self, obj, /)render(, sourceRegion, renderFlags, renderFlags)repaint(-> None -> None -> None)resize(-> None)resizeEvent(self, event, /)restoreGeometry(self, geometry, /)saveGeometry(self, /)screen(self, /)scroll(-> None)sender(self, /)senderSignalIndex(self, /)setAcceptDrops(self, on, /)setAccessibleDescription(self, description, /)setAccessibleIdentifier(self, identifier, /)setAccessibleName(self, name, /)setAttribute(self, arg__1, /[, on])setAutoFillBackground(self, enabled, /)setBackgroundRole(self, arg__1, /)setBaseSize(-> None)setContentsMargins(-> None)setContextMenuPolicy(self, policy, /)setCursor(self, arg__1, /)setDisabled(self, arg__1, /)setEnabled(self, arg__1, /)setFixedHeight(self, h, /)setFixedSize(-> None)setFixedWidth(self, w, /)setFocus(-> None)setFocusPolicy(self, policy, /)setFocusProxy(self, arg__1, /)setFont(self, arg__1, /)setForegroundRole(self, arg__1, /)setGeometry(-> None)setGraphicsEffect(self, effect, /)setHidden(self, hidden, /)setInputMethodHints(self, hints, /)setLayout(self, arg__1, /)setLayoutDirection(self, direction, /)setLocale(self, locale, /)setMask(-> None)setMaximumHeight(self, maxh, /)setMaximumSize(-> None)setMaximumWidth(self, maxw, /)setMinimumHeight(self, minh, /)setMinimumSize(-> None)setMinimumWidth(self, minw, /)setMouseTracking(self, enable, /)setObjectName(self, name, /)setPalette(self, arg__1, /)setParent(-> None)setProperty(self, name, value, /)setScreen(self, arg__1, /)setShortcutAutoRepeat(self, id, /[, enable])setShortcutEnabled(self, id, /[, enable])setSizeIncrement(-> None)setSizePolicy(-> None)setStatusTip(self, arg__1, /)setStyle(self, arg__1, /)setStyleSheet(self, styleSheet, /)setTabOrder(arg__1, arg__2, /)setTabletTracking(self, enable, /)setToolTip(self, arg__1, /)setToolTipDuration(self, msec, /)setUpdatesEnabled(self, enable, /)setVisible(self, visible, /)setWhatsThis(self, arg__1, /)setWindowFilePath(self, filePath, /)setWindowFlag(self, arg__1, /[, on])setWindowFlags(self, type, /)setWindowIcon(self, icon, /)setWindowIconText(self, arg__1, /)setWindowModality(self, windowModality, /)setWindowModified(self, arg__1, /)setWindowOpacity(self, level, /)setWindowRole(self, arg__1, /)setWindowState(self, state, /)setWindowTitle(self, arg__1, /)sharedPainter(self, /)show(self, /)showEvent(self, event, /)showFullScreen(self, /)showMaximized(self, /)showMinimized(self, /)showNormal(self, /)signalsBlocked(self, /)size(self, /)sizeHint(self, /)sizeIncrement(self, /)sizePolicy(self, /)stackUnder(self, arg__1, /)startTimer(self, interval, /[, timerType])statusTip(self, /)style(self, /)styleSheet(self, /)tabletEvent(self, event, /)testAttribute(self, arg__1, /)thread(self, /)timerEvent(self, event, /)toolTip(self, /)toolTipDuration(self, /)topLevelWidget(self, /)tr(self, sourceText, /[, disambiguation, n])underMouse(self, /)ungrabGesture(self, type, /)unsetCursor(self, /)unsetLayoutDirection(self, /)unsetLocale(self, /)update(-> None -> None -> None)updateGeometry(self, /)updateMicroFocus(self, /[, query])updatesEnabled(self, /)visibleRegion(self, /)whatsThis(self, /)wheelEvent(self, event, /)width(self, /)widthMM(self, /)winId(self, /)window(self, /)windowFilePath(self, /)windowFlags(self, /)windowHandle(self, /)windowIcon(self, /)windowIconText(self, /)windowModality(self, /)windowOpacity(self, /)windowRole(self, /)windowState(self, /)windowTitle(self, /)windowType(self, /)x(self, /)y(self, /)PaintDeviceMetric
RenderFlag
connect_atoms
connect_selected
customContextMenuRequested
destroyed
get_atom_view
objectNameChanged
selection
show_atom_dialog
windowIconChanged
windowIconTextChanged
windowTitleChanged
- class SampleView(parent=None)[source]#
Bases:
NeuXtalVizWidgetView for managing and visualizing sample tools in NeuXtalViz.
Provides user interface elements for sample selection, loading, and manipulation.
- Attributes:
paintersushort
Methods
acceptDrops(self, /)accessibleDescription(self, /)accessibleIdentifier(self, /)accessibleName(self, /)actionEvent(self, event, /)actions(self, /)activateWindow(self, /)addAction(...)addActions(self, actions, /)adjustSize(self, /)autoFillBackground(self, /)auto_scale_dropdown(combo)Autoscale a combobox width to fit text plus any icons/checks.
axes_show()State of axes.
backgroundRole(self, /)backingStore(self, /)baseSize(self, /)blockSignals(self, b, /)changeEvent(self, event, /)change_projection()Enable or disable parallel projection.
childAt(...)childEvent(self, event, /)children(self, /)childrenRect(self, /)childrenRegion(self, /)clearFocus(self, /)clearMask(self, /)close(self, /)closeEvent(self, event, /)colorCount(self, /)connect(...)connectNotify(self, signal, /)connect_az(left, right)Connect Azimuth to presenter handler.
connect_elev(up, down)Connect Elevate to presenter handler.
connect_manual_axis(view_manual)Manual axis view connection.
connect_manual_up_axis(view_manual)Manual axis upv iew connection.
connect_real_axes(view_a, view_b, view_c)Real axes view connections.
connect_reciprocal_axes(view_a_star, ...)Reciprocal axes view connections.
connect_reciprocal_real_compass(change_lattice)Reciprocal/real axis compass
connect_rotate(cww, cw)Connect Roll to presenter handler.
connect_save_screenshot(save_screenshot)Screenshot connection.
connect_stop(stop)Connect stop button to presenter callback.
contentsMargins(self, /)contentsRect(self, /)contextMenuEvent(self, event, /)contextMenuPolicy(self, /)create(self, /[, arg__1, initializeWindow, ...])createWinId(self, /)createWindowContainer(window, /[, parent, flags])cursor(self, /)customEvent(self, event, /)deleteLater(self, /)depth(self, /)destroy(self, /[, destroyWindow, ...])devType(self, /)devicePixelRatio(self, /)devicePixelRatioF(self, /)devicePixelRatioFScale()disconnect(...)disconnectNotify(self, signal, /)dragEnterEvent(self, event, /)dragLeaveEvent(self, event, /)dragMoveEvent(self, event, /)dropEvent(self, event, /)dumpObjectInfo(self, /)dumpObjectTree(self, /)dynamicPropertyNames(self, /)effectiveWinId(self, /)emit(self, signal, /, *args)encodeMetricF(metric, value, /)ensurePolished(self, /)enterEvent(self, event, /)event(self, event, /)eventFilter(self, watched, event, /)find(arg__1, /)findChild(self, type, /[, name, options])findChildren() -> List[~PlaceholderType] ))focusInEvent(self, event, /)focusNextChild(self, /)focusNextPrevChild(self, next, /)focusOutEvent(self, event, /)focusPolicy(self, /)focusPreviousChild(self, /)focusProxy(self, /)focusWidget(self, /)font(self, /)fontInfo(self, /)fontMetrics(self, /)foregroundRole(self, /)frameGeometry(self, /)frameSize(self, /)geometry(self, /)get_camera_state()Return the current camera position, focal point, and up vectors.
get_manual_axis_indices()Indices of manually entered direction components.
get_manual_axis_up_indices()Indices of manually entered direction up components.
get_rotate_step()Return the rotation step in degrees from the rotate tab.
grab(self, /[, rectangle])grabGesture(self, type, /[, flags])grabKeyboard(self, /)grabMouse(-> None)grabShortcut(self, key, /[, context])graphicsEffect(self, /)graphicsProxyWidget(self, /)hasFocus(self, /)hasHeightForWidth(self, /)hasMouseTracking(self, /)hasTabletTracking(self, /)height(self, /)heightForWidth(self, arg__1, /)heightMM(self, /)hide(self, /)hideEvent(self, event, /)inherits(self, classname, /)initPainter(self, painter, /)inputMethodEvent(self, event, /)inputMethodHints(self, /)inputMethodQuery(self, arg__1, /)insertAction(self, before, action, /)insertActions(self, before, actions, /)installEventFilter(self, filterObj, /)internalWinId(self, /)isActiveWindow(self, /)isAncestorOf(self, child, /)isEnabled(self, /)isEnabledTo(self, arg__1, /)isFullScreen(self, /)isHidden(self, /)isLeftToRight(self, /)isMaximized(self, /)isMinimized(self, /)isModal(self, /)isQmlExposed(self, /)isQuickItemType(self, /)isRightToLeft(self, /)isSignalConnected(self, signal, /)isTopLevel(self, /)isVisible(self, /)isVisibleTo(self, arg__1, /)isWidgetType(self, /)isWindow(self, /)isWindowModified(self, /)isWindowType(self, /)keyPressEvent(self, event, /)keyReleaseEvent(self, event, /)keyboardGrabber()killTimer(-> None)layout(self, /)layoutDirection(self, /)leaveEvent(self, event, /)locale(self, /)logicalDpiX(self, /)logicalDpiY(self, /)lower(self, /)mapFrom(-> PySide6.QtCore.QPoint)mapFromGlobal(-> PySide6.QtCore.QPoint)mapFromParent(-> PySide6.QtCore.QPoint)mapTo(-> PySide6.QtCore.QPoint)mapToGlobal(-> PySide6.QtCore.QPoint)mapToParent(-> PySide6.QtCore.QPoint)mask(self, /)maximumHeight(self, /)maximumSize(self, /)maximumWidth(self, /)metaObject(self, /)metric(self, arg__1, /)minimumHeight(self, /)minimumSize(self, /)minimumSizeHint(self, /)minimumWidth(self, /)mouseDoubleClickEvent(self, event, /)mouseGrabber()mouseMoveEvent(self, event, /)mousePressEvent(self, event, /)mouseReleaseEvent(self, event, /)move(-> None)moveEvent(self, event, /)moveToThread(self, thread, /)nativeEvent(self, eventType, message, /)nativeParentWidget(self, /)nextInFocusChain(self, /)normalGeometry(self, /)objectName(self, /)overrideWindowFlags(self, type, /)overrideWindowState(self, state, /)paintEngine(self, /)paintEvent(self, event, /)paintingActive(self, /)palette(self, /)parent(self, /)parentWidget(self, /)physicalDpiX(self, /)physicalDpiY(self, /)pos(self, /)previousInFocusChain(self, /)property(self, name, /)raise_(self, /)receivers(self, signal, /)reciprocal_lattice()State of reciprocal lattice vectors.
rect(self, /)redirected(self, offset, /)releaseKeyboard(self, /)releaseMouse(self, /)releaseShortcut(self, id, /)removeAction(self, action, /)removeEventFilter(self, obj, /)render(, sourceRegion, renderFlags, renderFlags)repaint(-> None -> None -> None)reset_camera()Reset the camera.
reset_view([negative])Reset the view.
resize(-> None)resizeEvent(self, event, /)restoreGeometry(self, geometry, /)saveGeometry(self, /)save_screenshot(filename)Save plotter screenshot.
screen(self, /)scroll(-> None)sender(self, /)senderSignalIndex(self, /)setAcceptDrops(self, on, /)setAccessibleDescription(self, description, /)setAccessibleIdentifier(self, identifier, /)setAccessibleName(self, name, /)setAttribute(self, arg__1, /[, on])setAutoFillBackground(self, enabled, /)setBackgroundRole(self, arg__1, /)setBaseSize(-> None)setContentsMargins(-> None)setContextMenuPolicy(self, policy, /)setCursor(self, arg__1, /)setDisabled(self, arg__1, /)setEnabled(self, arg__1, /)setFixedHeight(self, h, /)setFixedSize(-> None)setFixedWidth(self, w, /)setFocus(-> None)setFocusPolicy(self, policy, /)setFocusProxy(self, arg__1, /)setFont(self, arg__1, /)setForegroundRole(self, arg__1, /)setGeometry(-> None)setGraphicsEffect(self, effect, /)setHidden(self, hidden, /)setInputMethodHints(self, hints, /)setLayout(self, arg__1, /)setLayoutDirection(self, direction, /)setLocale(self, locale, /)setMask(-> None)setMaximumHeight(self, maxh, /)setMaximumSize(-> None)setMaximumWidth(self, maxw, /)setMinimumHeight(self, minh, /)setMinimumSize(-> None)setMinimumWidth(self, minw, /)setMouseTracking(self, enable, /)setObjectName(self, name, /)setPalette(self, arg__1, /)setParent(-> None)setProperty(self, name, value, /)setScreen(self, arg__1, /)setShortcutAutoRepeat(self, id, /[, enable])setShortcutEnabled(self, id, /[, enable])setSizeIncrement(-> None)setSizePolicy(-> None)setStatusTip(self, arg__1, /)setStyle(self, arg__1, /)setStyleSheet(self, styleSheet, /)setTabOrder(arg__1, arg__2, /)setTabletTracking(self, enable, /)setToolTip(self, arg__1, /)setToolTipDuration(self, msec, /)setUpdatesEnabled(self, enable, /)setVisible(self, visible, /)setWhatsThis(self, arg__1, /)setWindowFilePath(self, filePath, /)setWindowFlag(self, arg__1, /[, on])setWindowFlags(self, type, /)setWindowIcon(self, icon, /)setWindowIconText(self, arg__1, /)setWindowModality(self, windowModality, /)setWindowModified(self, arg__1, /)setWindowOpacity(self, level, /)setWindowRole(self, arg__1, /)setWindowState(self, state, /)setWindowTitle(self, arg__1, /)set_camera_state(position, focal_point, up)Apply a new camera state to the underlying plotter and refresh.
set_info(status)Update status information.
set_oriented_lattice_parameters(a, b, c, ...)Update the oriented lattice paramters.
set_position(pos)Set the position.
set_step(progress)Update progress step.
set_transform(T)Apply a transform to the axes.
sharedPainter(self, /)show(self, /)showEvent(self, event, /)showFullScreen(self, /)showMaximized(self, /)showMinimized(self, /)showNormal(self, /)signalsBlocked(self, /)size(self, /)sizeHint(self, /)sizeIncrement(self, /)sizePolicy(self, /)stackUnder(self, arg__1, /)startTimer(self, interval, /[, timerType])start_worker_pool(worker)Create a worker pool and connect output to console.
statusTip(self, /)stop_processes()Stop all running worker processes.
stop_processing(stop_event)Check if a stop has been requested.
style(self, /)styleSheet(self, /)tabletEvent(self, event, /)testAttribute(self, arg__1, /)thread(self, /)timerEvent(self, event, /)toolTip(self, /)toolTipDuration(self, /)topLevelWidget(self, /)tr(self, sourceText, /[, disambiguation, n])underMouse(self, /)ungrabGesture(self, type, /)unsetCursor(self, /)unsetLayoutDirection(self, /)unsetLocale(self, /)update(-> None -> None -> None)updateGeometry(self, /)updateMicroFocus(self, /[, query])update_camera_display(roll, elevation, azimuth)Update the read-only camera orientation display, if present.
update_labels()Change the axes labels between Miller and fractional notation.
updatesEnabled(self, /)view_up_vector(vec)Set the camera according to given vector(s).
view_vector(vecs)Set the camera according to given vector(s).
view_xy()View \(xy\)-plane.
view_xz()View \(xz\)-plane.
view_yx()View \(yx\)-plane.
view_yz()View \(yz\)-plane.
view_zx()View \(zx\)-plane.
view_zy()View \(zy\)-plane.
visibleRegion(self, /)whatsThis(self, /)wheelEvent(self, event, /)width(self, /)widthMM(self, /)winId(self, /)window(self, /)windowFilePath(self, /)windowFlags(self, /)windowHandle(self, /)windowIcon(self, /)windowIconText(self, /)windowModality(self, /)windowOpacity(self, /)windowRole(self, /)windowState(self, /)windowTitle(self, /)windowType(self, /)worker(task)Worker task.
x(self, /)y(self, /)PaintDeviceMetric
RenderFlag
add_sample
append_to_console
cam_ready
clear_scene
connect_add_sample
connect_camera_ready
connect_goniometer_table
connect_load_UB
connect_row_highligter
connect_sample_parameters
constrain_size
customContextMenuRequested
destroyed
get_camera_roll_direction
get_face_indexing
get_goniometer
get_goniometer_angle
get_goniometers
get_material_paremters
get_sample_constants
get_sample_shape
load_UB_file_dialog
log_output
objectNameChanged
reset_scene
sample_tab
save_screenshot_file_dialog
set_absortion_parameters
set_angle
set_goniometer
set_goniometer_table
set_sample_constants
set_unit_cell_volume
show_axes
toggle_console
update_theme
windowIconChanged
windowIconTextChanged
windowTitleChanged
- class UBView(parent=None)[source]#
Bases:
NeuXtalVizWidgetView for UB matrix and peak indexing tools in NeuXtalViz.
Provides user interface elements for UB calculation, peak finding, indexing, prediction, integration, and filtering. Tool tips are added to all major widgets and controls for improved usability.
- Attributes:
paintersushort
Methods
acceptDrops(self, /)accessibleDescription(self, /)accessibleIdentifier(self, /)accessibleName(self, /)actionEvent(self, event, /)actions(self, /)activateWindow(self, /)addAction(...)addActions(self, actions, /)adjustSize(self, /)autoFillBackground(self, /)auto_scale_dropdown(combo)Autoscale a combobox width to fit text plus any icons/checks.
axes_show()State of axes.
backgroundRole(self, /)backingStore(self, /)baseSize(self, /)blockSignals(self, b, /)changeEvent(self, event, /)change_projection()Enable or disable parallel projection.
childAt(...)childEvent(self, event, /)children(self, /)childrenRect(self, /)childrenRegion(self, /)clearFocus(self, /)clearMask(self, /)close(self, /)closeEvent(self, event, /)colorCount(self, /)connect(...)connectNotify(self, signal, /)connect_az(left, right)Connect Azimuth to presenter handler.
connect_elev(up, down)Connect Elevate to presenter handler.
connect_manual_axis(view_manual)Manual axis view connection.
connect_manual_up_axis(view_manual)Manual axis upv iew connection.
connect_real_axes(view_a, view_b, view_c)Real axes view connections.
connect_reciprocal_axes(view_a_star, ...)Reciprocal axes view connections.
connect_reciprocal_real_compass(change_lattice)Reciprocal/real axis compass
connect_rotate(cww, cw)Connect Roll to presenter handler.
connect_save_screenshot(save_screenshot)Screenshot connection.
connect_stop(stop)Connect stop button to presenter callback.
contentsMargins(self, /)contentsRect(self, /)contextMenuEvent(self, event, /)contextMenuPolicy(self, /)create(self, /[, arg__1, initializeWindow, ...])createWinId(self, /)createWindowContainer(window, /[, parent, flags])cursor(self, /)customEvent(self, event, /)deleteLater(self, /)depth(self, /)destroy(self, /[, destroyWindow, ...])devType(self, /)devicePixelRatio(self, /)devicePixelRatioF(self, /)devicePixelRatioFScale()disconnect(...)disconnectNotify(self, signal, /)dragEnterEvent(self, event, /)dragLeaveEvent(self, event, /)dragMoveEvent(self, event, /)dropEvent(self, event, /)dumpObjectInfo(self, /)dumpObjectTree(self, /)dynamicPropertyNames(self, /)effectiveWinId(self, /)emit(self, signal, /, *args)encodeMetricF(metric, value, /)ensurePolished(self, /)enterEvent(self, event, /)event(self, event, /)eventFilter(self, watched, event, /)find(arg__1, /)findChild(self, type, /[, name, options])findChildren() -> List[~PlaceholderType] ))focusInEvent(self, event, /)focusNextChild(self, /)focusNextPrevChild(self, next, /)focusOutEvent(self, event, /)focusPolicy(self, /)focusPreviousChild(self, /)focusProxy(self, /)focusWidget(self, /)font(self, /)fontInfo(self, /)fontMetrics(self, /)foregroundRole(self, /)frameGeometry(self, /)frameSize(self, /)geometry(self, /)get_camera_state()Return the current camera position, focal point, and up vectors.
get_manual_axis_indices()Indices of manually entered direction components.
get_manual_axis_up_indices()Indices of manually entered direction up components.
get_rotate_step()Return the rotation step in degrees from the rotate tab.
grab(self, /[, rectangle])grabGesture(self, type, /[, flags])grabKeyboard(self, /)grabMouse(-> None)grabShortcut(self, key, /[, context])graphicsEffect(self, /)graphicsProxyWidget(self, /)hasFocus(self, /)hasHeightForWidth(self, /)hasMouseTracking(self, /)hasTabletTracking(self, /)height(self, /)heightForWidth(self, arg__1, /)heightMM(self, /)hide(self, /)hideEvent(self, event, /)highlight(index, dataset)Select a peak in the table from a 3D view click.
highlight_peak(index)Highlight a peak given its block index (from table/logic).
highlight_peaks(indices)Highlight multiple peaks given their block indices.
inherits(self, classname, /)initPainter(self, painter, /)inputMethodEvent(self, event, /)inputMethodHints(self, /)inputMethodQuery(self, arg__1, /)insertAction(self, before, action, /)insertActions(self, before, actions, /)installEventFilter(self, filterObj, /)internalWinId(self, /)isActiveWindow(self, /)isAncestorOf(self, child, /)isEnabled(self, /)isEnabledTo(self, arg__1, /)isFullScreen(self, /)isHidden(self, /)isLeftToRight(self, /)isMaximized(self, /)isMinimized(self, /)isModal(self, /)isQmlExposed(self, /)isQuickItemType(self, /)isRightToLeft(self, /)isSignalConnected(self, signal, /)isTopLevel(self, /)isVisible(self, /)isVisibleTo(self, arg__1, /)isWidgetType(self, /)isWindow(self, /)isWindowModified(self, /)isWindowType(self, /)keyPressEvent(self, event, /)keyReleaseEvent(self, event, /)keyboardGrabber()killTimer(-> None)layout(self, /)layoutDirection(self, /)leaveEvent(self, event, /)locale(self, /)logicalDpiX(self, /)logicalDpiY(self, /)lower(self, /)mapFrom(-> PySide6.QtCore.QPoint)mapFromGlobal(-> PySide6.QtCore.QPoint)mapFromParent(-> PySide6.QtCore.QPoint)mapTo(-> PySide6.QtCore.QPoint)mapToGlobal(-> PySide6.QtCore.QPoint)mapToParent(-> PySide6.QtCore.QPoint)mask(self, /)maximumHeight(self, /)maximumSize(self, /)maximumWidth(self, /)metaObject(self, /)metric(self, arg__1, /)minimumHeight(self, /)minimumSize(self, /)minimumSizeHint(self, /)minimumWidth(self, /)mouseDoubleClickEvent(self, event, /)mouseGrabber()mouseMoveEvent(self, event, /)mousePressEvent(self, event, /)mouseReleaseEvent(self, event, /)move(-> None)moveEvent(self, event, /)moveToThread(self, thread, /)nativeEvent(self, eventType, message, /)nativeParentWidget(self, /)nextInFocusChain(self, /)normalGeometry(self, /)objectName(self, /)overrideWindowFlags(self, type, /)overrideWindowState(self, state, /)paintEngine(self, /)paintEvent(self, event, /)paintingActive(self, /)palette(self, /)parent(self, /)parentWidget(self, /)physicalDpiX(self, /)physicalDpiY(self, /)pos(self, /)previousInFocusChain(self, /)property(self, name, /)raise_(self, /)receivers(self, signal, /)reciprocal_lattice()State of reciprocal lattice vectors.
rect(self, /)redirected(self, offset, /)releaseKeyboard(self, /)releaseMouse(self, /)releaseShortcut(self, id, /)removeAction(self, action, /)removeEventFilter(self, obj, /)render(, sourceRegion, renderFlags, renderFlags)repaint(-> None -> None -> None)reset_camera()Reset the camera.
reset_view([negative])Reset the view.
resize(-> None)resizeEvent(self, event, /)restoreGeometry(self, geometry, /)runs_string_to_list(runs_str)Convert runs string to list using regex validation.
saveGeometry(self, /)save_screenshot(filename)Save plotter screenshot.
screen(self, /)scroll(-> None)sender(self, /)senderSignalIndex(self, /)setAcceptDrops(self, on, /)setAccessibleDescription(self, description, /)setAccessibleIdentifier(self, identifier, /)setAccessibleName(self, name, /)setAttribute(self, arg__1, /[, on])setAutoFillBackground(self, enabled, /)setBackgroundRole(self, arg__1, /)setBaseSize(-> None)setContentsMargins(-> None)setContextMenuPolicy(self, policy, /)setCursor(self, arg__1, /)setDisabled(self, arg__1, /)setEnabled(self, arg__1, /)setFixedHeight(self, h, /)setFixedSize(-> None)setFixedWidth(self, w, /)setFocus(-> None)setFocusPolicy(self, policy, /)setFocusProxy(self, arg__1, /)setFont(self, arg__1, /)setForegroundRole(self, arg__1, /)setGeometry(-> None)setGraphicsEffect(self, effect, /)setHidden(self, hidden, /)setInputMethodHints(self, hints, /)setLayout(self, arg__1, /)setLayoutDirection(self, direction, /)setLocale(self, locale, /)setMask(-> None)setMaximumHeight(self, maxh, /)setMaximumSize(-> None)setMaximumWidth(self, maxw, /)setMinimumHeight(self, minh, /)setMinimumSize(-> None)setMinimumWidth(self, minw, /)setMouseTracking(self, enable, /)setObjectName(self, name, /)setPalette(self, arg__1, /)setParent(-> None)setProperty(self, name, value, /)setScreen(self, arg__1, /)setShortcutAutoRepeat(self, id, /[, enable])setShortcutEnabled(self, id, /[, enable])setSizeIncrement(-> None)setSizePolicy(-> None)setStatusTip(self, arg__1, /)setStyle(self, arg__1, /)setStyleSheet(self, styleSheet, /)setTabOrder(arg__1, arg__2, /)setTabletTracking(self, enable, /)setToolTip(self, arg__1, /)setToolTipDuration(self, msec, /)setUpdatesEnabled(self, enable, /)setVisible(self, visible, /)setWhatsThis(self, arg__1, /)setWindowFilePath(self, filePath, /)setWindowFlag(self, arg__1, /[, on])setWindowFlags(self, type, /)setWindowIcon(self, icon, /)setWindowIconText(self, arg__1, /)setWindowModality(self, windowModality, /)setWindowModified(self, arg__1, /)setWindowOpacity(self, level, /)setWindowRole(self, arg__1, /)setWindowState(self, state, /)setWindowTitle(self, arg__1, /)set_camera_state(position, focal_point, up)Apply a new camera state to the underlying plotter and refresh.
set_info(status)Update status information.
set_oriented_lattice_parameters(a, b, c, ...)Update the oriented lattice paramters.
set_position(pos)Set the position.
set_step(progress)Update progress step.
set_transform(T)Apply a transform to the axes.
sharedPainter(self, /)show(self, /)showEvent(self, event, /)showFullScreen(self, /)showMaximized(self, /)showMinimized(self, /)showNormal(self, /)signalsBlocked(self, /)size(self, /)sizeHint(self, /)sizeIncrement(self, /)sizePolicy(self, /)stackUnder(self, arg__1, /)startTimer(self, interval, /[, timerType])start_worker_pool(worker)Create a worker pool and connect output to console.
statusTip(self, /)stop_processes()Stop all running worker processes.
stop_processing(stop_event)Check if a stop has been requested.
style(self, /)styleSheet(self, /)tabletEvent(self, event, /)testAttribute(self, arg__1, /)thread(self, /)timerEvent(self, event, /)toolTip(self, /)toolTipDuration(self, /)topLevelWidget(self, /)tr(self, sourceText, /[, disambiguation, n])underMouse(self, /)ungrabGesture(self, type, /)unsetCursor(self, /)unsetLayoutDirection(self, /)unsetLocale(self, /)update(-> None -> None -> None)updateGeometry(self, /)updateMicroFocus(self, /[, query])update_camera_display(roll, elevation, azimuth)Update the read-only camera orientation display, if present.
update_labels()Change the axes labels between Miller and fractional notation.
updatesEnabled(self, /)view_up_vector(vec)Set the camera according to given vector(s).
view_vector(vecs)Set the camera according to given vector(s).
view_xy()View \(xy\)-plane.
view_xz()View \(xz\)-plane.
view_yx()View \(yx\)-plane.
view_yz()View \(yz\)-plane.
view_zx()View \(zx\)-plane.
view_zy()View \(zy\)-plane.
visibleRegion(self, /)whatsThis(self, /)wheelEvent(self, event, /)width(self, /)widthMM(self, /)winId(self, /)window(self, /)windowFilePath(self, /)windowFlags(self, /)windowHandle(self, /)windowIcon(self, /)windowIconText(self, /)windowModality(self, /)windowOpacity(self, /)windowRole(self, /)windowState(self, /)windowTitle(self, /)windowType(self, /)worker(task)Worker task.
x(self, /)y(self, /)PaintDeviceMetric
RenderFlag
add_Q_viz
add_alignment_peaks
add_cluster_peaks
add_highlight_1
add_highlight_2
alignment_tab
append_to_console
cam_ready
clear_alignment_plot
clear_inst_vlims
clear_niggli_info
clear_peak_selection
clear_run_info
clear_scene
connect_add_peak
connect_browse_calibration
connect_browse_goniometer
connect_browse_tube
connect_calculate_alignment
connect_calculate_highlight
connect_calculate_peaks
connect_camera_ready
connect_cbar_combo
connect_cell_row_highligter
connect_check_hkl
connect_clim_combo
connect_cluster
connect_convert_HKL
connect_convert_Q
connect_convert_to_hkl
connect_d_max
connect_d_min
connect_data_combo
connect_delete_peak
connect_diffraction
connect_filter_peaks
connect_find_conventional
connect_find_distance
connect_find_niggli
connect_find_peaks
connect_find_spacing
connect_h_index
connect_hand_index_peak
connect_highlight_1
connect_highlight_2
connect_horizontal
connect_horizontal_roi
connect_index_peaks
connect_inst_vmax_line
connect_inst_vmin_line
connect_instrument_auto_limits
connect_instrument_scale_combo
connect_integer_h_index
connect_integer_k_index
connect_integer_l_index
connect_integer_m_index
connect_integer_n_index
connect_integer_p_index
connect_integrate_peaks
connect_k_index
connect_l_index
connect_lattice_transform
connect_load_Q
connect_load_UB
connect_load_peaks
connect_optimize_UB
connect_peak_row_highligter
connect_predict_peaks
connect_reload_convert_Q
connect_roi_ready
connect_save_Q
connect_save_UB
connect_save_peaks
connect_save_roi_mask
connect_scan_ready
connect_select_cell
connect_select_form
connect_set_UB
connect_set_UB_from_scattering_plane
connect_slice_auto_limits
connect_slice_combo
connect_slice_line
connect_slice_ready
connect_slice_scale_combo
connect_slice_slider
connect_slice_thickness_line
connect_slice_width_line
connect_switch_instrument
connect_symmetry_transform
connect_transform_UB
connect_undo_filter_peaks
connect_vbar_combo
connect_vertical
connect_vertical_roi
connect_vlim_combo
connect_vmax_line
connect_vmin_line
connect_wavelength
customContextMenuRequested
destroyed
enable_slice_peak_add
format_with_error
get_IPTS
get_alignment_run
get_alignment_tilts
get_avoid_aluminum
get_avoid_copper
get_avoid_iron
get_calculate_UB_tol
get_camera_roll_direction
get_centroid
get_check_hkl
get_clim_clip_type
get_cluster_parameters
get_color_bar_values
get_colormap
get_convert_min_d
get_d_max
get_d_min
get_data_list
get_detector_calibration
get_diffraction
get_ellipsoid
get_experiment
get_filter_comparison
get_filter_value
get_filter_variable
get_find_peaks_distance
get_find_peaks_edge
get_find_peaks_parameters
get_find_peaks_spacing
get_form
get_form_number
get_goniometer_calibration
get_highlight
get_horizontal
get_horizontal_roi
get_index_peaks_parameters
get_index_peaks_round
get_index_satellite_peaks
get_indices
get_input_hkls
get_inst_vmax_value
get_inst_vmin_value
get_instrument
get_instrument_auto_limits
get_instrument_auto_zoom
get_instrument_colormap
get_instrument_scale
get_integrate_peaks_parameters
get_lattice_constants
get_lattice_transform
get_lorentz
get_max_order_cross_terms
get_max_scalar_error
get_min_max_constants
get_modulatation_offsets
get_peak
get_peak_width
get_peaks
get_predict_peaks_centering
get_predict_peaks_edge
get_predict_peaks_parameters
get_predict_satellite_peaks
get_projection_matrix
get_refine_UB_option
get_refine_UB_tol
get_runs
get_sample_directions
get_slice
get_slice_auto_limits
get_slice_auto_zoom
get_slice_scale
get_slice_thickness
get_slice_value
get_slice_width
get_symmetry_symbol
get_time_stop
get_transform_UB_tol
get_transform_matrix
get_tube_calibration
get_vertical
get_vertical_roi
get_vlim_clip_type
get_vmax_value
get_vmin_value
get_wavelength
index_ready
load_Q_file_dialog
load_UB_file_dialog
load_detector_cal_dialog
load_goniometer_cal_dialog
load_peaks_file_dialog
load_tube_cal_dialog
log_output
modulation_tab
objectNameChanged
on_press_inst
on_press_scan
on_press_slice
parameters_tab
reset_scene
roi_ready
save_Q_file_dialog
save_UB_file_dialog
save_mask_file_dialog
save_peaks_file_dialog
save_screenshot_file_dialog
scan_ready
set_Q_status
set_UB_status
set_cell
set_cell_form
set_check_hkl
set_convert_min_d
set_d_min
set_d_phi
set_data_list
set_detector_calibration
set_diffraction
set_find_peaks_distance
set_find_peaks_spacing
set_goniometer_axes
set_goniometer_calibration
set_goniometer_setting
set_highlight_phi
set_horizontal
set_indices
set_inst_vmax_value
set_inst_vmin_value
set_instrument_goniometer_axes
set_instrument_goniometer_setting
set_item_value
set_lattice_constants
set_modulatation_offsets
set_peak
set_peak_goniometer_axes
set_peak_goniometer_setting
set_peak_info
set_peaks_status
set_sample_directions
set_transform_matrix
set_tube_calibration
set_undo_filter_enabled
set_vertical
set_vmax_value
set_vmin_value
set_wavelength
setup_slice_slider
show_axes
slice_ready
table_tab
toggle_console
update_alignment_runs
update_cell_table
update_cluster_table
update_colorbar_vlims
update_diffraction_label
update_filter_description_label
update_instrument_colorbar_vlims
update_instrument_display
update_instrument_view
update_peaks_table
update_refine_constraint_label
update_roi_view
update_scan_view
update_slice
update_slice_color
update_slice_display
update_symmetry_symbols
update_table_index
update_theme
update_wavelength
verify_tab
windowIconChanged
windowIconTextChanged
windowTitleChanged
- class VolumeSlicerView(parent=None)[source]#
Bases:
NeuXtalVizWidget- Attributes:
paintersushort
Methods
acceptDrops(self, /)accessibleDescription(self, /)accessibleIdentifier(self, /)accessibleName(self, /)actionEvent(self, event, /)actions(self, /)activateWindow(self, /)addAction(...)addActions(self, actions, /)adjustSize(self, /)autoFillBackground(self, /)auto_scale_dropdown(combo)Autoscale a combobox width to fit text plus any icons/checks.
axes_show()State of axes.
backgroundRole(self, /)backingStore(self, /)baseSize(self, /)blockSignals(self, b, /)changeEvent(self, event, /)change_projection()Enable or disable parallel projection.
childAt(...)childEvent(self, event, /)children(self, /)childrenRect(self, /)childrenRegion(self, /)clearFocus(self, /)clearMask(self, /)close(self, /)closeEvent(self, event, /)colorCount(self, /)connect(...)connectNotify(self, signal, /)connect_az(left, right)Connect Azimuth to presenter handler.
connect_elev(up, down)Connect Elevate to presenter handler.
connect_manual_axis(view_manual)Manual axis view connection.
connect_manual_up_axis(view_manual)Manual axis upv iew connection.
connect_real_axes(view_a, view_b, view_c)Real axes view connections.
connect_reciprocal_axes(view_a_star, ...)Reciprocal axes view connections.
connect_reciprocal_real_compass(change_lattice)Reciprocal/real axis compass
connect_rotate(cww, cw)Connect Roll to presenter handler.
connect_save_screenshot(save_screenshot)Screenshot connection.
connect_stop(stop)Connect stop button to presenter callback.
contentsMargins(self, /)contentsRect(self, /)contextMenuEvent(self, event, /)contextMenuPolicy(self, /)create(self, /[, arg__1, initializeWindow, ...])createWinId(self, /)createWindowContainer(window, /[, parent, flags])cursor(self, /)customEvent(self, event, /)deleteLater(self, /)depth(self, /)destroy(self, /[, destroyWindow, ...])devType(self, /)devicePixelRatio(self, /)devicePixelRatioF(self, /)devicePixelRatioFScale()disconnect(...)disconnectNotify(self, signal, /)dragEnterEvent(self, event, /)dragLeaveEvent(self, event, /)dragMoveEvent(self, event, /)dropEvent(self, event, /)dumpObjectInfo(self, /)dumpObjectTree(self, /)dynamicPropertyNames(self, /)effectiveWinId(self, /)emit(self, signal, /, *args)encodeMetricF(metric, value, /)ensurePolished(self, /)enterEvent(self, event, /)event(self, event, /)eventFilter(self, watched, event, /)find(arg__1, /)findChild(self, type, /[, name, options])findChildren() -> List[~PlaceholderType] ))focusInEvent(self, event, /)focusNextChild(self, /)focusNextPrevChild(self, next, /)focusOutEvent(self, event, /)focusPolicy(self, /)focusPreviousChild(self, /)focusProxy(self, /)focusWidget(self, /)font(self, /)fontInfo(self, /)fontMetrics(self, /)foregroundRole(self, /)frameGeometry(self, /)frameSize(self, /)geometry(self, /)get_camera_state()Return the current camera position, focal point, and up vectors.
get_manual_axis_indices()Indices of manually entered direction components.
get_manual_axis_up_indices()Indices of manually entered direction up components.
get_rotate_step()Return the rotation step in degrees from the rotate tab.
grab(self, /[, rectangle])grabGesture(self, type, /[, flags])grabKeyboard(self, /)grabMouse(-> None)grabShortcut(self, key, /[, context])graphicsEffect(self, /)graphicsProxyWidget(self, /)hasFocus(self, /)hasHeightForWidth(self, /)hasMouseTracking(self, /)hasTabletTracking(self, /)height(self, /)heightForWidth(self, arg__1, /)heightMM(self, /)hide(self, /)hideEvent(self, event, /)inherits(self, classname, /)initPainter(self, painter, /)inputMethodEvent(self, event, /)inputMethodHints(self, /)inputMethodQuery(self, arg__1, /)insertAction(self, before, action, /)insertActions(self, before, actions, /)installEventFilter(self, filterObj, /)internalWinId(self, /)isActiveWindow(self, /)isAncestorOf(self, child, /)isEnabled(self, /)isEnabledTo(self, arg__1, /)isFullScreen(self, /)isHidden(self, /)isLeftToRight(self, /)isMaximized(self, /)isMinimized(self, /)isModal(self, /)isQmlExposed(self, /)isQuickItemType(self, /)isRightToLeft(self, /)isSignalConnected(self, signal, /)isTopLevel(self, /)isVisible(self, /)isVisibleTo(self, arg__1, /)isWidgetType(self, /)isWindow(self, /)isWindowModified(self, /)isWindowType(self, /)keyPressEvent(self, event, /)keyReleaseEvent(self, event, /)keyboardGrabber()killTimer(-> None)layout(self, /)layoutDirection(self, /)leaveEvent(self, event, /)locale(self, /)logicalDpiX(self, /)logicalDpiY(self, /)lower(self, /)mapFrom(-> PySide6.QtCore.QPoint)mapFromGlobal(-> PySide6.QtCore.QPoint)mapFromParent(-> PySide6.QtCore.QPoint)mapTo(-> PySide6.QtCore.QPoint)mapToGlobal(-> PySide6.QtCore.QPoint)mapToParent(-> PySide6.QtCore.QPoint)mask(self, /)maximumHeight(self, /)maximumSize(self, /)maximumWidth(self, /)metaObject(self, /)metric(self, arg__1, /)minimumHeight(self, /)minimumSize(self, /)minimumSizeHint(self, /)minimumWidth(self, /)mouseDoubleClickEvent(self, event, /)mouseGrabber()mouseMoveEvent(self, event, /)mousePressEvent(self, event, /)mouseReleaseEvent(self, event, /)move(-> None)moveEvent(self, event, /)moveToThread(self, thread, /)nativeEvent(self, eventType, message, /)nativeParentWidget(self, /)nextInFocusChain(self, /)normalGeometry(self, /)objectName(self, /)overrideWindowFlags(self, type, /)overrideWindowState(self, state, /)paintEngine(self, /)paintEvent(self, event, /)paintingActive(self, /)palette(self, /)parent(self, /)parentWidget(self, /)physicalDpiX(self, /)physicalDpiY(self, /)pos(self, /)previousInFocusChain(self, /)property(self, name, /)raise_(self, /)receivers(self, signal, /)reciprocal_lattice()State of reciprocal lattice vectors.
rect(self, /)redirected(self, offset, /)releaseKeyboard(self, /)releaseMouse(self, /)releaseShortcut(self, id, /)removeAction(self, action, /)removeEventFilter(self, obj, /)render(, sourceRegion, renderFlags, renderFlags)repaint(-> None -> None -> None)reset_camera()Reset the camera.
reset_view([negative])Reset the view.
resize(-> None)resizeEvent(self, event, /)restoreGeometry(self, geometry, /)saveGeometry(self, /)save_screenshot(filename)Save plotter screenshot.
screen(self, /)scroll(-> None)sender(self, /)senderSignalIndex(self, /)setAcceptDrops(self, on, /)setAccessibleDescription(self, description, /)setAccessibleIdentifier(self, identifier, /)setAccessibleName(self, name, /)setAttribute(self, arg__1, /[, on])setAutoFillBackground(self, enabled, /)setBackgroundRole(self, arg__1, /)setBaseSize(-> None)setContentsMargins(-> None)setContextMenuPolicy(self, policy, /)setCursor(self, arg__1, /)setDisabled(self, arg__1, /)setEnabled(self, arg__1, /)setFixedHeight(self, h, /)setFixedSize(-> None)setFixedWidth(self, w, /)setFocus(-> None)setFocusPolicy(self, policy, /)setFocusProxy(self, arg__1, /)setFont(self, arg__1, /)setForegroundRole(self, arg__1, /)setGeometry(-> None)setGraphicsEffect(self, effect, /)setHidden(self, hidden, /)setInputMethodHints(self, hints, /)setLayout(self, arg__1, /)setLayoutDirection(self, direction, /)setLocale(self, locale, /)setMask(-> None)setMaximumHeight(self, maxh, /)setMaximumSize(-> None)setMaximumWidth(self, maxw, /)setMinimumHeight(self, minh, /)setMinimumSize(-> None)setMinimumWidth(self, minw, /)setMouseTracking(self, enable, /)setObjectName(self, name, /)setPalette(self, arg__1, /)setParent(-> None)setProperty(self, name, value, /)setScreen(self, arg__1, /)setShortcutAutoRepeat(self, id, /[, enable])setShortcutEnabled(self, id, /[, enable])setSizeIncrement(-> None)setSizePolicy(-> None)setStatusTip(self, arg__1, /)setStyle(self, arg__1, /)setStyleSheet(self, styleSheet, /)setTabOrder(arg__1, arg__2, /)setTabletTracking(self, enable, /)setToolTip(self, arg__1, /)setToolTipDuration(self, msec, /)setUpdatesEnabled(self, enable, /)setVisible(self, visible, /)setWhatsThis(self, arg__1, /)setWindowFilePath(self, filePath, /)setWindowFlag(self, arg__1, /[, on])setWindowFlags(self, type, /)setWindowIcon(self, icon, /)setWindowIconText(self, arg__1, /)setWindowModality(self, windowModality, /)setWindowModified(self, arg__1, /)setWindowOpacity(self, level, /)setWindowRole(self, arg__1, /)setWindowState(self, state, /)setWindowTitle(self, arg__1, /)set_camera_state(position, focal_point, up)Apply a new camera state to the underlying plotter and refresh.
set_info(status)Update status information.
set_oriented_lattice_parameters(a, b, c, ...)Update the oriented lattice paramters.
set_position(pos)Set the position.
set_step(progress)Update progress step.
set_transform(T)Apply a transform to the axes.
sharedPainter(self, /)show(self, /)showEvent(self, event, /)showFullScreen(self, /)showMaximized(self, /)showMinimized(self, /)showNormal(self, /)signalsBlocked(self, /)size(self, /)sizeHint(self, /)sizeIncrement(self, /)sizePolicy(self, /)stackUnder(self, arg__1, /)startTimer(self, interval, /[, timerType])start_worker_pool(worker)Create a worker pool and connect output to console.
statusTip(self, /)stop_processes()Stop all running worker processes.
stop_processing(stop_event)Check if a stop has been requested.
style(self, /)styleSheet(self, /)tabletEvent(self, event, /)testAttribute(self, arg__1, /)thread(self, /)timerEvent(self, event, /)toolTip(self, /)toolTipDuration(self, /)topLevelWidget(self, /)tr(self, sourceText, /[, disambiguation, n])underMouse(self, /)ungrabGesture(self, type, /)unsetCursor(self, /)unsetLayoutDirection(self, /)unsetLocale(self, /)update(-> None -> None -> None)updateGeometry(self, /)updateMicroFocus(self, /[, query])update_camera_display(roll, elevation, azimuth)Update the read-only camera orientation display, if present.
update_labels()Change the axes labels between Miller and fractional notation.
updatesEnabled(self, /)view_up_vector(vec)Set the camera according to given vector(s).
view_vector(vecs)Set the camera according to given vector(s).
view_xy()View \(xy\)-plane.
view_xz()View \(xz\)-plane.
view_yx()View \(yx\)-plane.
view_yz()View \(yz\)-plane.
view_zx()View \(zx\)-plane.
view_zy()View \(zy\)-plane.
visibleRegion(self, /)whatsThis(self, /)wheelEvent(self, event, /)width(self, /)widthMM(self, /)winId(self, /)window(self, /)windowFilePath(self, /)windowFlags(self, /)windowHandle(self, /)windowIcon(self, /)windowIconText(self, /)windowModality(self, /)windowOpacity(self, /)windowRole(self, /)windowState(self, /)windowTitle(self, /)windowType(self, /)worker(task)Worker task.
x(self, /)y(self, /)PaintDeviceMetric
RenderFlag
add_cut
add_histo
add_slice
append_to_console
cam_ready
clear_scene
connect_auto_limits
connect_auto_zoom
connect_camera_ready
connect_cbar_combo
connect_clim_combo
connect_cut_combo
connect_cut_line
connect_cut_ready
connect_cut_scale_combo
connect_cut_thickness_line
connect_load_NXS
connect_max_slider
connect_min_slider
connect_opacity_combo
connect_range_combo
connect_save_cut
connect_save_slice
connect_slice_combo
connect_slice_line
connect_slice_ready
connect_slice_scale_combo
connect_slice_thickness_line
connect_vlim_combo
connect_vmax_line
connect_vmin_line
connect_vol_scale_combo
connect_xmax_line
connect_xmin_line
connect_ymax_line
connect_ymin_line
customContextMenuRequested
cut_limits
cut_ready
destroyed
get_auto_limits
get_auto_zoom
get_camera_roll_direction
get_clim_clip_type
get_color_bar_values
get_colormap
get_cut
get_cut_scale
get_cut_thickness
get_cut_value
get_opacity
get_range
get_slice
get_slice_scale
get_slice_thickness
get_slice_value
get_vlim_clip_type
get_vmax_value
get_vmin_value
get_vol_scale
get_xmax_value
get_xmin_value
get_ymax_value
get_ymin_value
interaction_callback
load_NXS_file_dialog
log_output
objectNameChanged
on_motion
on_press
on_release
reset_scene
reset_slice_cut
reset_slider
save_file_dialog
save_screenshot_file_dialog
set_cut_lim
set_cut_thickness
set_cut_value
set_slice_lim
set_slice_thickness
set_slice_value
set_vmax_value
set_vmin_value
set_xmax_value
set_xmin_value
set_ymax_value
set_ymin_value
show_axes
slice_limits
slice_ready
slicer_tab
toggle_console
toggle_container
update_clip
update_colorbar_max
update_colorbar_min
update_colorbar_vlims
update_lines
update_slice_color
update_slice_display
update_theme
windowIconChanged
windowIconTextChanged
windowTitleChanged
- class CommandBrowser[source]#
Bases:
QMainWindowView for browsing and executing commands in NeuXtalViz.
Provides user interface elements for searching, selecting, and running available commands, as well as viewing command details.
- Attributes:
paintersushort
Methods
acceptDrops(self, /)accessibleDescription(self, /)accessibleIdentifier(self, /)accessibleName(self, /)actionEvent(self, event, /)actions(self, /)activateWindow(self, /)addAction(...)addActions(self, actions, /)addDockWidget(-> None)addToolBar(-> None -> None)addToolBarBreak(self, /[, area])adjustSize(self, /)autoFillBackground(self, /)backgroundRole(self, /)backingStore(self, /)baseSize(self, /)blockSignals(self, b, /)centralWidget(self, /)changeEvent(self, event, /)childAt(...)childEvent(self, event, /)children(self, /)childrenRect(self, /)childrenRegion(self, /)clearFocus(self, /)clearMask(self, /)close(self, /)closeEvent(self, event, /)colorCount(self, /)connect(...)connectNotify(self, signal, /)contentsMargins(self, /)contentsRect(self, /)contextMenuEvent(self, event, /)contextMenuPolicy(self, /)corner(self, corner, /)create(self, /[, arg__1, initializeWindow, ...])createPopupMenu(self, /)createWinId(self, /)createWindowContainer(window, /[, parent, flags])cursor(self, /)customEvent(self, event, /)deleteLater(self, /)depth(self, /)destroy(self, /[, destroyWindow, ...])devType(self, /)devicePixelRatio(self, /)devicePixelRatioF(self, /)devicePixelRatioFScale()disconnect(...)disconnectNotify(self, signal, /)dockOptions(self, /)dockWidgetArea(self, dockwidget, /)documentMode(self, /)dragEnterEvent(self, event, /)dragLeaveEvent(self, event, /)dragMoveEvent(self, event, /)dropEvent(self, event, /)dumpObjectInfo(self, /)dumpObjectTree(self, /)dynamicPropertyNames(self, /)effectiveWinId(self, /)emit(self, signal, /, *args)encodeMetricF(metric, value, /)ensurePolished(self, /)enterEvent(self, event, /)event(self, event, /)eventFilter(self, watched, event, /)find(arg__1, /)findChild(self, type, /[, name, options])findChildren() -> List[~PlaceholderType] ))focusInEvent(self, event, /)focusNextChild(self, /)focusNextPrevChild(self, next, /)focusOutEvent(self, event, /)focusPolicy(self, /)focusPreviousChild(self, /)focusProxy(self, /)focusWidget(self, /)font(self, /)fontInfo(self, /)fontMetrics(self, /)foregroundRole(self, /)frameGeometry(self, /)frameSize(self, /)geometry(self, /)grab(self, /[, rectangle])grabGesture(self, type, /[, flags])grabKeyboard(self, /)grabMouse(-> None)grabShortcut(self, key, /[, context])graphicsEffect(self, /)graphicsProxyWidget(self, /)hasFocus(self, /)hasHeightForWidth(self, /)hasMouseTracking(self, /)hasTabletTracking(self, /)height(self, /)heightForWidth(self, arg__1, /)heightMM(self, /)hide(self, /)hideEvent(self, event, /)iconSize(self, /)inherits(self, classname, /)initPainter(self, painter, /)inputMethodEvent(self, event, /)inputMethodHints(self, /)inputMethodQuery(self, arg__1, /)insertAction(self, before, action, /)insertActions(self, before, actions, /)insertToolBar(self, before, toolbar, /)insertToolBarBreak(self, before, /)installEventFilter(self, filterObj, /)internalWinId(self, /)isActiveWindow(self, /)isAncestorOf(self, child, /)isAnimated(self, /)isDockNestingEnabled(self, /)isEnabled(self, /)isEnabledTo(self, arg__1, /)isFullScreen(self, /)isHidden(self, /)isLeftToRight(self, /)isMaximized(self, /)isMinimized(self, /)isModal(self, /)isQmlExposed(self, /)isQuickItemType(self, /)isRightToLeft(self, /)isSeparator(self, pos, /)isSignalConnected(self, signal, /)isTopLevel(self, /)isVisible(self, /)isVisibleTo(self, arg__1, /)isWidgetType(self, /)isWindow(self, /)isWindowModified(self, /)isWindowType(self, /)keyPressEvent(self, event, /)keyReleaseEvent(self, event, /)keyboardGrabber()killTimer(-> None)layout(self, /)layoutDirection(self, /)leaveEvent(self, event, /)locale(self, /)logicalDpiX(self, /)logicalDpiY(self, /)lower(self, /)mapFrom(-> PySide6.QtCore.QPoint)mapFromGlobal(-> PySide6.QtCore.QPoint)mapFromParent(-> PySide6.QtCore.QPoint)mapTo(-> PySide6.QtCore.QPoint)mapToGlobal(-> PySide6.QtCore.QPoint)mapToParent(-> PySide6.QtCore.QPoint)mask(self, /)maximumHeight(self, /)maximumSize(self, /)maximumWidth(self, /)menuBar(self, /)menuWidget(self, /)metaObject(self, /)metric(self, arg__1, /)minimumHeight(self, /)minimumSize(self, /)minimumSizeHint(self, /)minimumWidth(self, /)mouseDoubleClickEvent(self, event, /)mouseGrabber()mouseMoveEvent(self, event, /)mousePressEvent(self, event, /)mouseReleaseEvent(self, event, /)move(-> None)moveEvent(self, event, /)moveToThread(self, thread, /)nativeEvent(self, eventType, message, /)nativeParentWidget(self, /)nextInFocusChain(self, /)normalGeometry(self, /)objectName(self, /)overrideWindowFlags(self, type, /)overrideWindowState(self, state, /)paintEngine(self, /)paintEvent(self, event, /)paintingActive(self, /)palette(self, /)parent(self, /)parentWidget(self, /)physicalDpiX(self, /)physicalDpiY(self, /)pos(self, /)previousInFocusChain(self, /)property(self, name, /)raise_(self, /)receivers(self, signal, /)rect(self, /)redirected(self, offset, /)releaseKeyboard(self, /)releaseMouse(self, /)releaseShortcut(self, id, /)removeAction(self, action, /)removeDockWidget(self, dockwidget, /)removeEventFilter(self, obj, /)removeToolBar(self, toolbar, /)removeToolBarBreak(self, before, /)render(, sourceRegion, renderFlags, renderFlags)repaint(-> None -> None -> None)resize(-> None)resizeDocks(self, docks, sizes, orientation, /)resizeEvent(self, event, /)restoreDockWidget(self, dockwidget, /)restoreGeometry(self, geometry, /)restoreState(self, state, /[, version])saveGeometry(self, /)saveState(self, /[, version])screen(self, /)scroll(-> None)sender(self, /)senderSignalIndex(self, /)setAcceptDrops(self, on, /)setAccessibleDescription(self, description, /)setAccessibleIdentifier(self, identifier, /)setAccessibleName(self, name, /)setAnimated(self, enabled, /)setAttribute(self, arg__1, /[, on])setAutoFillBackground(self, enabled, /)setBackgroundRole(self, arg__1, /)setBaseSize(-> None)setCentralWidget(self, widget, /)setContentsMargins(-> None)setContextMenuPolicy(self, policy, /)setCorner(self, corner, area, /)setCursor(self, arg__1, /)setDisabled(self, arg__1, /)setDockNestingEnabled(self, enabled, /)setDockOptions(self, options, /)setDocumentMode(self, enabled, /)setEnabled(self, arg__1, /)setFixedHeight(self, h, /)setFixedSize(-> None)setFixedWidth(self, w, /)setFocus(-> None)setFocusPolicy(self, policy, /)setFocusProxy(self, arg__1, /)setFont(self, arg__1, /)setForegroundRole(self, arg__1, /)setGeometry(-> None)setGraphicsEffect(self, effect, /)setHidden(self, hidden, /)setIconSize(self, iconSize, /)setInputMethodHints(self, hints, /)setLayout(self, arg__1, /)setLayoutDirection(self, direction, /)setLocale(self, locale, /)setMask(-> None)setMaximumHeight(self, maxh, /)setMaximumSize(-> None)setMaximumWidth(self, maxw, /)setMenuBar(self, menubar, /)setMenuWidget(self, menubar, /)setMinimumHeight(self, minh, /)setMinimumSize(-> None)setMinimumWidth(self, minw, /)setMouseTracking(self, enable, /)setObjectName(self, name, /)setPalette(self, arg__1, /)setParent(-> None)setProperty(self, name, value, /)setScreen(self, arg__1, /)setShortcutAutoRepeat(self, id, /[, enable])setShortcutEnabled(self, id, /[, enable])setSizeIncrement(-> None)setSizePolicy(-> None)setStatusBar(self, statusbar, /)setStatusTip(self, arg__1, /)setStyle(self, arg__1, /)setStyleSheet(self, styleSheet, /)setTabOrder(arg__1, arg__2, /)setTabPosition(self, areas, tabPosition, /)setTabShape(self, tabShape, /)setTabletTracking(self, enable, /)setToolButtonStyle(self, toolButtonStyle, /)setToolTip(self, arg__1, /)setToolTipDuration(self, msec, /)setUnifiedTitleAndToolBarOnMac(self, set, /)setUpdatesEnabled(self, enable, /)setVisible(self, visible, /)setWhatsThis(self, arg__1, /)setWindowFilePath(self, filePath, /)setWindowFlag(self, arg__1, /[, on])setWindowFlags(self, type, /)setWindowIcon(self, icon, /)setWindowIconText(self, arg__1, /)setWindowModality(self, windowModality, /)setWindowModified(self, arg__1, /)setWindowOpacity(self, level, /)setWindowRole(self, arg__1, /)setWindowState(self, state, /)setWindowTitle(self, arg__1, /)sharedPainter(self, /)show(self, /)showEvent(self, event, /)showFullScreen(self, /)showMaximized(self, /)showMinimized(self, /)showNormal(self, /)signalsBlocked(self, /)size(self, /)sizeHint(self, /)sizeIncrement(self, /)sizePolicy(self, /)splitDockWidget(self, after, dockwidget, ...)stackUnder(self, arg__1, /)startTimer(self, interval, /[, timerType])statusBar(self, /)statusTip(self, /)style(self, /)styleSheet(self, /)tabPosition(self, area, /)tabShape(self, /)tabifiedDockWidgets(self, dockwidget, /)tabifyDockWidget(self, first, second, /)tabletEvent(self, event, /)takeCentralWidget(self, /)testAttribute(self, arg__1, /)thread(self, /)timerEvent(self, event, /)toolBarArea(self, toolbar, /)toolBarBreak(self, toolbar, /)toolButtonStyle(self, /)toolTip(self, /)toolTipDuration(self, /)topLevelWidget(self, /)tr(self, sourceText, /[, disambiguation, n])underMouse(self, /)ungrabGesture(self, type, /)unifiedTitleAndToolBarOnMac(self, /)unsetCursor(self, /)unsetLayoutDirection(self, /)unsetLocale(self, /)update(-> None -> None -> None)updateGeometry(self, /)updateMicroFocus(self, /[, query])updatesEnabled(self, /)visibleRegion(self, /)whatsThis(self, /)wheelEvent(self, event, /)width(self, /)widthMM(self, /)winId(self, /)window(self, /)windowFilePath(self, /)windowFlags(self, /)windowHandle(self, /)windowIcon(self, /)windowIconText(self, /)windowModality(self, /)windowOpacity(self, /)windowRole(self, /)windowState(self, /)windowTitle(self, /)windowType(self, /)x(self, /)y(self, /)DockOption
PaintDeviceMetric
RenderFlag
customContextMenuRequested
destroyed
iconSizeChanged
init_ui
load_file
load_files_in_directory
objectNameChanged
open_directory
run_command
save_file
switch_command
switch_discus
switch_shelxl
switch_shelxt
switch_xprep
tabifiedDockWidgetActivated
toolButtonStyleChanged
windowIconChanged
windowIconTextChanged
windowTitleChanged
- class EmittingStream(emit_func, *args, **kwargs)[source]#
Bases:
StringIO- Attributes:
- closed
encodingEncoding of the text stream.
errorsThe error setting of the decoder or encoder.
- line_buffering
newlinesLine endings translated so far.
Methods
close(/)Close the IO object.
detach(/)Separate the underlying buffer from the TextIOBase and return it.
fileno(/)Return underlying file descriptor if one exists.
flush()Flush write buffers, if applicable.
getvalue(/)Retrieve the entire contents of the object.
isatty(/)Return whether this is an 'interactive' stream.
read([size])Read at most size characters, returned as a string.
readable(/)Returns True if the IO object can be read.
readline([size])Read until newline or EOF.
readlines([hint])Return a list of lines from the stream.
seek(pos[, whence])Change stream position.
seekable(/)Returns True if the IO object can be seeked.
tell(/)Tell the current file position.
truncate([pos])Truncate size to pos.
writable(/)Returns True if the IO object can be written.
write(s)Write string to file.
writelines(lines, /)Write a list of lines to stream.
- class SignalLogHandler(emit_func)[source]#
Bases:
Handler- Attributes:
- name
Methods
acquire()Acquire the I/O thread lock.
addFilter(filter)Add the specified filter to this handler.
close()Tidy up any resources used by the handler.
createLock()Acquire a thread lock for serializing access to the underlying I/O.
emit(record)Do whatever it takes to actually log the specified logging record.
filter(record)Determine if a record is loggable by consulting all the filters.
flush()Ensure all logging output has been flushed.
format(record)Format the specified record.
handle(record)Conditionally emit the specified logging record.
handleError(record)Handle errors which occur during an emit() call.
release()Release the I/O thread lock.
removeFilter(filter)Remove the specified filter from this handler.
setFormatter(fmt)Set the formatter for this handler.
setLevel(level)Set the logging level of this handler.
get_name
set_name
- class ThreadPool[source]#
Bases:
QThreadPoolThread pool for managing worker threads.
Tracks active workers and provides functionality to stop all running processes.
Methods
activeThreadCount(self, /)blockSignals(self, b, /)childEvent(self, event, /)children(self, /)clear(self, /)connect(...)connectNotify(self, signal, /)contains(self, thread, /)customEvent(self, event, /)deleteLater(self, /)disconnect(...)disconnectNotify(self, signal, /)dumpObjectInfo(self, /)dumpObjectTree(self, /)dynamicPropertyNames(self, /)emit(self, signal, /, *args)event(self, event, /)eventFilter(self, watched, event, /)expiryTimeout(self, /)findChild(self, type, /[, name, options])findChildren() -> List[~PlaceholderType] ))globalInstance()inherits(self, classname, /)installEventFilter(self, filterObj, /)isQmlExposed(self, /)isQuickItemType(self, /)isSignalConnected(self, signal, /)isWidgetType(self, /)isWindowType(self, /)killTimer(-> None)maxThreadCount(self, /)metaObject(self, /)moveToThread(self, thread, /)objectName(self, /)parent(self, /)property(self, name, /)receivers(self, signal, /)releaseThread(self, /)removeEventFilter(self, obj, /)remove_worker(worker)Remove worker from active list when finished.
reserveThread(self, /)sender(self, /)senderSignalIndex(self, /)serviceLevel(self, /)setExpiryTimeout(self, expiryTimeout, /)setMaxThreadCount(self, maxThreadCount, /)setObjectName(self, name, /)setParent(self, parent, /)setProperty(self, name, value, /)setServiceLevel(self, serviceLevel, /)setStackSize(self, stackSize, /)setThreadPriority(self, priority, /)signalsBlocked(self, /)stackSize(self, /)start(-> None)startOnReservedThread(self, runnable, /)startTimer(self, interval, /[, timerType])start_worker_pool(worker)Start a worker and track it in the active workers list.
Stop all active workers by setting their stop events.
thread(self, /)threadPriority(self, /)timerEvent(self, event, /)tr(self, sourceText, /[, disambiguation, n])tryStart(-> bool)tryTake(self, runnable, /)waitForDone(-> bool)destroyed
objectNameChanged
- class Worker(task, *args, **kwargs)[source]#
Bases:
QRunnableWorker thread for running tasks in the background.
The worker automatically passes ‘progress’ and ‘stop_event’ to the task function.
Example task function that can be stopped:
- def my_task(progress=None, stop_event=None, **kwargs):
- for i in range(100):
# Check if stop was requested if stop_event and stop_event.is_set():
print(“Task stopped by user”) return None
# Do work… time.sleep(0.1)
# Report progress if progress:
progress(f”Processing step {i+1}”, (i+1))
return result
Methods
autoDelete(self, /)create(functionToRun, /)Check if stop has been requested.
run(self, /)setAutoDelete(self, autoDelete, /)stop()Request the worker to stop by setting the stop event.
connect_finished
connect_progress
connect_result
emit_progress
- class WorkerSignals[source]#
Bases:
QObjectMethods
blockSignals(self, b, /)childEvent(self, event, /)children(self, /)connect(...)connectNotify(self, signal, /)customEvent(self, event, /)deleteLater(self, /)disconnect(...)disconnectNotify(self, signal, /)dumpObjectInfo(self, /)dumpObjectTree(self, /)dynamicPropertyNames(self, /)emit(self, signal, /, *args)event(self, event, /)eventFilter(self, watched, event, /)findChild(self, type, /[, name, options])findChildren() -> List[~PlaceholderType] ))inherits(self, classname, /)installEventFilter(self, filterObj, /)isQmlExposed(self, /)isQuickItemType(self, /)isSignalConnected(self, signal, /)isWidgetType(self, /)isWindowType(self, /)killTimer(-> None)metaObject(self, /)moveToThread(self, thread, /)objectName(self, /)parent(self, /)property(self, name, /)receivers(self, signal, /)removeEventFilter(self, obj, /)sender(self, /)senderSignalIndex(self, /)setObjectName(self, name, /)setParent(self, parent, /)setProperty(self, name, value, /)signalsBlocked(self, /)startTimer(self, interval, /[, timerType])thread(self, /)timerEvent(self, event, /)tr(self, sourceText, /[, disambiguation, n])destroyed
error
finished
objectNameChanged
output
progress
result