pymmcore_nano#
Module API
pymmcore_nano #
Classes:
-
ActionType– -
CMMCore–The main MMCore object.
-
CMMError– -
Configuration–Encapsulation of configuration information.
-
DeviceDetectionStatus– -
DeviceInitializationState– -
DeviceNotification– -
DeviceType– -
FocusDirection– -
MMEventCallback–Interface for receiving events from MMCore.
-
Metadata– -
MetadataArrayTag– -
MetadataIndexError– -
MetadataKeyError– -
MetadataSingleTag– -
MetadataTag– -
PortType– -
PropertySetting– -
PropertyType–
Functions:
-
patch_pymmcore–Add a meta path hook to redirect imports of
pymmcoretopymmcore_nano.
Attributes:
-
DEVICE_BUFFER_OVERFLOW(int) – -
DEVICE_CAMERA_BUSY_ACQUIRING(int) – -
DEVICE_CAN_NOT_SET_PROPERTY(int) – -
DEVICE_COMM_HUB_MISSING(int) – -
DEVICE_CORE_CHANNEL_PRESETS_FAILED(int) – -
DEVICE_CORE_CONFIG_FAILED(int) – -
DEVICE_CORE_EXPOSURE_FAILED(int) – -
DEVICE_CORE_FOCUS_STAGE_UNDEF(int) – -
DEVICE_DUPLICATE_LABEL(int) – -
DEVICE_DUPLICATE_LIBRARY(int) – -
DEVICE_DUPLICATE_PROPERTY(int) – -
DEVICE_ERR(int) – -
DEVICE_IMAGE_PARAMS_FAILED(int) – -
DEVICE_INCOMPATIBLE_IMAGE(int) – -
DEVICE_INTERFACE_VERSION(int) – -
DEVICE_INTERNAL_INCONSISTENCY(int) – -
DEVICE_INVALID_INPUT_PARAM(int) – -
DEVICE_INVALID_PROPERTY(int) – -
DEVICE_INVALID_PROPERTY_LIMITS(int) – -
DEVICE_INVALID_PROPERTY_LIMTS(int) – -
DEVICE_INVALID_PROPERTY_TYPE(int) – -
DEVICE_INVALID_PROPERTY_VALUE(int) – -
DEVICE_LOCALLY_DEFINED_ERROR(int) – -
DEVICE_NATIVE_MODULE_FAILED(int) – -
DEVICE_NONEXISTENT_CHANNEL(int) – -
DEVICE_NOT_CONNECTED(int) – -
DEVICE_NOT_SUPPORTED(int) – -
DEVICE_NOT_YET_IMPLEMENTED(int) – -
DEVICE_NO_CALLBACK_REGISTERED(int) – -
DEVICE_NO_PROPERTY_DATA(int) – -
DEVICE_OK(int) – -
DEVICE_OUT_OF_MEMORY(int) – -
DEVICE_PROPERTY_NOT_SEQUENCEABLE(int) – -
DEVICE_PUMP_IS_RUNNING(int) – -
DEVICE_SELF_REFERENCE(int) – -
DEVICE_SEQUENCE_TOO_LARGE(int) – -
DEVICE_SERIAL_BUFFER_OVERRUN(int) – -
DEVICE_SERIAL_COMMAND_FAILED(int) – -
DEVICE_SERIAL_INVALID_RESPONSE(int) – -
DEVICE_SERIAL_TIMEOUT(int) – -
DEVICE_SNAP_IMAGE_FAILED(int) – -
DEVICE_UNKNOWN_LABEL(int) – -
DEVICE_UNKNOWN_POSITION(int) – -
DEVICE_UNSUPPORTED_COMMAND(int) – -
DEVICE_UNSUPPORTED_DATA_FORMAT(int) – -
MMCore_version(str) – -
MMCore_version_info(tuple) – -
MM_CODE_ERR(int) – -
MM_CODE_OK(int) – -
MODULE_INTERFACE_VERSION(int) – -
PYMMCORE_NANO_VERSION(str) – -
g_CFGCommand_ConfigGroup(str) – -
g_CFGCommand_ConfigPixelSize(str) – -
g_CFGCommand_Configuration(str) – -
g_CFGCommand_Delay(str) – -
g_CFGCommand_Device(str) – -
g_CFGCommand_Equipment(str) – -
g_CFGCommand_FocusDirection(str) – -
g_CFGCommand_ImageSynchro(str) – -
g_CFGCommand_Label(str) – -
g_CFGCommand_ParentID(str) – -
g_CFGCommand_PixelSizeAffine(str) – -
g_CFGCommand_PixelSizeOptimalZUm(str) – -
g_CFGCommand_PixelSize_um(str) – -
g_CFGCommand_PixelSizedxdz(str) – -
g_CFGCommand_PixelSizedydz(str) – -
g_CFGCommand_Property(str) – -
g_CFGGroup_PixelSizeUm(str) – -
g_CFGGroup_System(str) – -
g_CFGGroup_System_Shutdown(str) – -
g_CFGGroup_System_Startup(str) – -
g_FieldDelimiters(str) – -
g_Keyword_ActualExposure(str) – -
g_Keyword_ActualInterval_ms(str) – -
g_Keyword_AnswerTimeout(str) – -
g_Keyword_BaudRate(str) – -
g_Keyword_Binning(str) – -
g_Keyword_CCDTemperature(str) – -
g_Keyword_CCDTemperatureSetPoint(str) – -
g_Keyword_CameraChannelIndex(str) – -
g_Keyword_CameraChannelName(str) – -
g_Keyword_CameraID(str) – -
g_Keyword_CameraName(str) – -
g_Keyword_Channel(str) – -
g_Keyword_Closed_Position(str) – -
g_Keyword_ColorMode(str) – -
g_Keyword_CoreAutoFocus(str) – -
g_Keyword_CoreAutoShutter(str) – -
g_Keyword_CoreCamera(str) – -
g_Keyword_CoreChannelGroup(str) – -
g_Keyword_CoreDevice(str) – -
g_Keyword_CoreFocus(str) – -
g_Keyword_CoreGalvo(str) – -
g_Keyword_CoreImageProcessor(str) – -
g_Keyword_CoreInitialize(str) – -
g_Keyword_CorePressurePump(str) – -
g_Keyword_CoreSLM(str) – -
g_Keyword_CoreShutter(str) – -
g_Keyword_CoreTimeoutMs(str) – -
g_Keyword_CoreVolumetricPump(str) – -
g_Keyword_CoreXYStage(str) – -
g_Keyword_Current_Volume(str) – -
g_Keyword_DataBits(str) – -
g_Keyword_Delay(str) – -
g_Keyword_DelayBetweenCharsMs(str) – -
g_Keyword_Description(str) – -
g_Keyword_EMGain(str) – -
g_Keyword_Elapsed_Time_ms(str) – -
g_Keyword_Exposure(str) – -
g_Keyword_Flowrate(str) – -
g_Keyword_Gain(str) – -
g_Keyword_Handshaking(str) – -
g_Keyword_HubID(str) – -
g_Keyword_Interval_ms(str) – -
g_Keyword_Label(str) – -
g_Keyword_Max_Volume(str) – -
g_Keyword_Metadata_CameraLabel(str) – -
g_Keyword_Metadata_Exposure(str) – -
g_Keyword_Metadata_Height(str) – -
g_Keyword_Metadata_ImageNumber(str) – -
g_Keyword_Metadata_ROI_X(str) – -
g_Keyword_Metadata_ROI_Y(str) – -
g_Keyword_Metadata_Score(str) – -
g_Keyword_Metadata_TimeInCore(str) – -
g_Keyword_Metadata_Width(str) – -
g_Keyword_Min_Volume(str) – -
g_Keyword_Name(str) – -
g_Keyword_Offset(str) – -
g_Keyword_Parity(str) – -
g_Keyword_PixelType(str) – -
g_Keyword_PixelType_GRAY16(str) – -
g_Keyword_PixelType_GRAY32(str) – -
g_Keyword_PixelType_GRAY8(str) – -
g_Keyword_PixelType_RGB32(str) – -
g_Keyword_PixelType_RGB64(str) – -
g_Keyword_PixelType_Unknown(str) – -
g_Keyword_Port(str) – -
g_Keyword_Position(str) – -
g_Keyword_Pressure_Imposed(str) – -
g_Keyword_Pressure_Measured(str) – -
g_Keyword_ReadoutMode(str) – -
g_Keyword_ReadoutTime(str) – -
g_Keyword_Speed(str) – -
g_Keyword_State(str) – -
g_Keyword_StopBits(str) – -
g_Keyword_Transpose_Correction(str) – -
g_Keyword_Transpose_MirrorX(str) – -
g_Keyword_Transpose_MirrorY(str) – -
g_Keyword_Transpose_SwapXY(str) – -
g_Keyword_Type(str) – -
g_Keyword_Version(str) –
g_CFGCommand_ConfigPixelSize module-attribute #
g_CFGCommand_ConfigPixelSize: str = 'ConfigPixelSize'
g_CFGCommand_PixelSizeAffine module-attribute #
g_CFGCommand_PixelSizeAffine: str = 'PixelSizeAffine'
g_CFGCommand_PixelSizeOptimalZUm module-attribute #
g_CFGCommand_PixelSizeOptimalZUm: str = (
"PixelSizeOptimalZ_Um"
)
g_CFGCommand_PixelSizedxdz module-attribute #
g_CFGCommand_PixelSizedxdz: str = 'PixelSizeAngle_dxdz'
g_CFGCommand_PixelSizedydz module-attribute #
g_CFGCommand_PixelSizedydz: str = 'PixelSizeAngle_dydz'
g_Keyword_ActualInterval_ms module-attribute #
g_Keyword_ActualInterval_ms: str = 'ActualInterval-ms'
g_Keyword_CCDTemperatureSetPoint module-attribute #
g_Keyword_CCDTemperatureSetPoint: str = (
"CCDTemperatureSetPoint"
)
g_Keyword_CameraChannelIndex module-attribute #
g_Keyword_CameraChannelIndex: str = 'CameraChannelIndex'
g_Keyword_CameraChannelName module-attribute #
g_Keyword_CameraChannelName: str = 'CameraChannelName'
g_Keyword_CoreImageProcessor module-attribute #
g_Keyword_CoreImageProcessor: str = 'ImageProcessor'
g_Keyword_CoreVolumetricPump module-attribute #
g_Keyword_CoreVolumetricPump: str = 'VolumetricPump'
g_Keyword_DelayBetweenCharsMs module-attribute #
g_Keyword_DelayBetweenCharsMs: str = 'DelayBetweenCharsMs'
g_Keyword_Metadata_ImageNumber module-attribute #
g_Keyword_Metadata_ImageNumber: str = 'ImageNumber'
g_Keyword_Metadata_TimeInCore module-attribute #
g_Keyword_Metadata_TimeInCore: str = 'TimeReceivedByCore'
g_Keyword_Pressure_Measured module-attribute #
g_Keyword_Pressure_Measured: str = 'Pressure Measured'
g_Keyword_Transpose_Correction module-attribute #
g_Keyword_Transpose_Correction: str = 'TransposeCorrection'
g_Keyword_Transpose_MirrorX module-attribute #
g_Keyword_Transpose_MirrorX: str = 'TransposeMirrorX'
g_Keyword_Transpose_MirrorY module-attribute #
g_Keyword_Transpose_MirrorY: str = 'TransposeMirrorY'
ActionType #
Bases: IntEnum
Attributes:
-
AfterLoadSequence– -
AfterSet– -
BeforeGet– -
IsSequenceable– -
NoAction– -
StartSequence– -
StopSequence–
CMMCore #
CMMCore()
The main MMCore object.
Manages multiple device adapters. Provides a device-independent interface for hardware control. Additionally, provides some facilities (such as configuration groups) for application programming.
Methods:
-
addGalvoPolygonVertex–Add a vertex to a galvo polygon.
-
clearCircularBuffer– -
clearROI– -
debugLogEnabled– -
defineConfigGroup– -
defineStateLabel– -
deleteConfigGroup– -
deleteGalvoPolygons– -
deletePixelSizeConfig– -
detectDevice– -
deviceBusy– -
deviceTypeBusy– -
displaySLMImage– -
enableContinuousFocus– -
enableDebugLog– -
enableFeature– -
enableStderrLog– -
fullFocus– -
getAPIVersionInfo– -
getAllowedPropertyValues– -
getAutoFocusDevice– -
getAutoFocusOffset– -
getAutoShutter– -
getAvailableConfigGroups– -
getAvailableConfigs– -
getAvailableDeviceDescriptions– -
getAvailableDeviceTypes– -
getAvailableDevices– -
getAvailablePixelSizeConfigs– -
getBufferFreeCapacity– -
getBufferTotalCapacity– -
getBytesPerPixel– -
getCameraChannelName– -
getCameraDevice– -
getChannelGroup– -
getCircularBufferMemoryFootprint– -
getConfigData– -
getConfigGroupState– -
getConfigGroupStateFromCache– -
getConfigState– -
getCoreErrorText– -
getCurrentConfig– -
getCurrentConfigFromCache– -
getCurrentFocusScore– -
getDeviceAdapterNames– -
getDeviceAdapterSearchPaths– -
getDeviceDelayMs– -
getDeviceDescription– -
getDeviceInitializationState– -
getDeviceLibrary– -
getDeviceName– -
getDevicePropertyNames– -
getDeviceType– -
getExposureSequenceMaxLength– -
getFocusDevice– -
getFocusDirection– -
getGalvoChannel– -
getGalvoDevice– -
getGalvoPosition– -
getGalvoXMinimum– -
getGalvoXRange– -
getGalvoYMinimum– -
getGalvoYRange– -
getImageBitDepth– -
getImageBufferSize– -
getImageHeight– -
getImageProcessorDevice– -
getImageWidth– -
getInstalledDeviceDescription– -
getInstalledDevices– -
getLastFocusScore– -
getLastImage– -
getLoadedDevices– -
getLoadedDevicesOfType– -
getLoadedPeripheralDevices– -
getMMCoreVersionMajor– -
getMMCoreVersionMinor– -
getMMCoreVersionPatch– -
getMMDeviceDeviceInterfaceVersion– -
getMMDeviceModuleInterfaceVersion– -
getMagnificationFactor– -
getMultiROI– -
getNumberOfCameraChannels– -
getNumberOfComponents– -
getNumberOfStates– -
getParentLabel– -
getPixelSizeAffineByID– -
getPixelSizeConfigData– -
getPixelSizeUmByID– -
getPrimaryLogFile– -
getProperty– -
getPropertyFromCache– -
getPropertyLowerLimit– -
getPropertySequenceMaxLength– -
getPropertyType– -
getPropertyUpperLimit– -
getPumpFlowrate– -
getPumpMaxVolume– -
getPumpPressureKPa– -
getPumpVolume– -
getRemainingImageCount– -
getSLMBytesPerPixel– -
getSLMDevice– -
getSLMExposure– -
getSLMHeight– -
getSLMNumberOfComponents– -
getSLMSequenceMaxLength– -
getSLMWidth– -
getSerialPortAnswer– -
getShutterDevice– -
getStageSequenceMaxLength– -
getState– -
getStateFromLabel– -
getStateLabel– -
getStateLabels– -
getSystemState– -
getSystemStateCache– -
getTimeoutMs– -
getVersionInfo– -
getXYStageDevice– -
getXYStageSequenceMaxLength– -
hasProperty– -
hasPropertyLimits– -
home– -
incrementalFocus– -
initializeAllDevices– -
initializeCircularBuffer– -
initializeDevice– -
invertPumpDirection– -
isBufferOverflowed– -
isConfigDefined– -
isContinuousFocusDrive– -
isContinuousFocusEnabled– -
isContinuousFocusLocked– -
isExposureSequenceable– -
isFeatureEnabled– -
isGroupDefined– -
isMultiROIEnabled– -
isMultiROISupported– -
isPixelSizeConfigDefined– -
isPropertyPreInit– -
isPropertyReadOnly– -
isPropertySequenceable– -
isPumpDirectionInverted– -
isStageLinearSequenceable– -
isStageSequenceable– -
isXYStageSequenceable– -
loadDevice– -
loadExposureSequence– -
loadGalvoPolygons– -
loadPropertySequence– -
loadSLMSequence– -
loadStageSequence– -
loadSystemConfiguration–Loads a system configuration from a file.
-
loadSystemState– -
loadXYStageSequence– -
pointGalvoAndFire– -
popNextImage– -
prepareSequenceAcquisition– -
pressurePumpCalibrate– -
pressurePumpRequiresCalibration– -
pressurePumpStop– -
pumpDispenseDurationSeconds– -
pumpDispenseVolumeUl– -
pumpStart– -
readFromSerialPort– -
registerCallback–Register a callback (listener class).
-
renameConfig– -
renameConfigGroup– -
renamePixelSizeConfig– -
reset– -
runGalvoPolygons– -
runGalvoSequence– -
saveSystemConfiguration– -
saveSystemState– -
setAutoFocusDevice– -
setAutoFocusOffset– -
setAutoShutter– -
setCameraDevice– -
setChannelGroup– -
setCircularBufferMemoryFootprint– -
setConfig– -
setDeviceAdapterSearchPaths– -
setDeviceDelayMs– -
setFocusDevice– -
setFocusDirection– -
setGalvoDevice– -
setGalvoIlluminationState– -
setGalvoPolygonRepetitions– -
setGalvoPosition– -
setGalvoSpotInterval– -
setImageProcessorDevice– -
setMultiROI– -
setParentLabel– -
setPixelSizeAffine– -
setPixelSizeConfig– -
setPixelSizeOptimalZUm– -
setPixelSizeUm– -
setPixelSizedxdz– -
setPixelSizedydz– -
setPrimaryLogFile– -
setPumpFlowrate– -
setPumpMaxVolume– -
setPumpPressureKPa– -
setPumpVolume– -
setSLMDevice– -
setSLMExposure– -
setSLMImage– -
setSerialPortCommand– -
setSerialProperties– -
setShutterDevice– -
setStageLinearSequence– -
setState– -
setStateLabel– -
setSystemState– -
setTimeoutMs– -
setXYStageDevice– -
sleep– -
snapImage– -
startContinuousSequenceAcquisition– -
startExposureSequence– -
startPropertySequence– -
startSLMSequence– -
startSecondaryLogFile– -
startStageSequence– -
startXYStageSequence– -
stderrLogEnabled– -
stop– -
stopExposureSequence– -
stopPropertySequence– -
stopSLMSequence– -
stopSecondaryLogFile– -
stopStageSequence– -
stopXYStageSequence– -
supportsDeviceDetection– -
systemBusy– -
unloadAllDevices– -
unloadDevice– -
unloadLibrary– -
updateCoreProperties– -
updateSystemStateCache– -
usesDeviceDelay– -
volumetricPumpHome– -
volumetricPumpRequiresHoming– -
volumetricPumpStop– -
waitForConfig– -
waitForDevice– -
waitForDeviceType– -
waitForSystem– -
writeToSerialPort–
addGalvoPolygonVertex #
Add a vertex to a galvo polygon.
getDeviceInitializationState #
getDeviceInitializationState(
label: str,
) -> DeviceInitializationState
getInstalledDeviceDescription #
loadExposureSequence #
loadPropertySequence #
loadSystemConfiguration #
loadSystemConfiguration(fileName: object) -> None
Loads a system configuration from a file.
loadXYStageSequence #
loadXYStageSequence(
xyStageLabel: str,
xSequence: Sequence[float],
ySequence: Sequence[float],
) -> None
pointGalvoAndFire #
registerCallback #
registerCallback(cb: MMEventCallback | None) -> None
Register a callback (listener class).
MMCore will send notifications on internal events using this interface
setGalvoPolygonRepetitions #
setMultiROI #
setMultiROI(
xs: Sequence[int],
ys: Sequence[int],
widths: Sequence[int],
heights: Sequence[int],
) -> None
setSerialProperties #
setSerialProperties(
portName: str,
answerTimeout: str,
baudRate: str,
delayBetweenCharsMs: str,
handshaking: str,
parity: str,
stopBits: str,
) -> None
setStageLinearSequence #
startContinuousSequenceAcquisition #
startContinuousSequenceAcquisition(
intervalMs: float,
) -> None
CMMError #
Bases: RuntimeError
Configuration #
Configuration()
Encapsulation of configuration information.
A configuration is a collection of device property settings.
Methods:
-
addSetting– -
deleteSetting– -
getVerbose– -
isConfigurationIncluded– -
isPropertyIncluded– -
isSettingIncluded– -
size–
DeviceNotification #
DeviceType #
Bases: IntEnum
Attributes:
-
AnyType– -
AutoFocusDevice– -
CameraDevice– -
CoreDevice– -
GalvoDevice– -
GenericDevice– -
HubDevice– -
ImageProcessorDevice– -
MagnifierDevice– -
PressurePumpDevice– -
SLMDevice– -
SerialDevice– -
ShutterDevice– -
SignalIODevice– -
StageDevice– -
StateDevice– -
UnknownType– -
VolumetricPumpDevice– -
XYStageDevice–
MMEventCallback #
MMEventCallback()
Interface for receiving events from MMCore.
Use by passing an instance to CMMCore.registerCallback.
Methods:
-
onChannelGroupChanged–Called when the channel group changes
-
onConfigGroupChanged–Called when a configuration group changes
-
onExposureChanged– -
onImageSnapped–Called when an image is snapped
-
onPixelSizeAffineChanged–Called when the pixel size affine transformation changes
-
onPixelSizeChanged–Called when the pixel size changes
-
onPropertiesChanged–Called when properties are changed
-
onPropertyChanged–Called when a specific property is changed
-
onSLMExposureChanged– -
onSequenceAcquisitionStarted–Called when sequence acquisition starts
-
onSequenceAcquisitionStopped–Called when sequence acquisition stops
-
onShutterOpenChanged–Called when the shutter is opened
-
onStagePositionChanged– -
onSystemConfigurationLoaded–Called when the system configuration is loaded
-
onXYStagePositionChanged–
onChannelGroupChanged #
onChannelGroupChanged(newChannelGroupName: str) -> None
Called when the channel group changes
onConfigGroupChanged #
Called when a configuration group changes
onPixelSizeAffineChanged #
onPixelSizeAffineChanged(
v0: float,
v1: float,
v2: float,
v3: float,
v4: float,
v5: float,
) -> None
Called when the pixel size affine transformation changes
onPixelSizeChanged #
onPixelSizeChanged(newPixelSizeUm: float) -> None
Called when the pixel size changes
onPropertyChanged #
Called when a specific property is changed
onSequenceAcquisitionStarted #
onSequenceAcquisitionStarted(cameraLabel: str) -> None
Called when sequence acquisition starts
onSequenceAcquisitionStopped #
onSequenceAcquisitionStopped(cameraLabel: str) -> None
Called when sequence acquisition stops
onShutterOpenChanged #
Called when the shutter is opened
onSystemConfigurationLoaded #
onSystemConfigurationLoaded() -> None
Called when the system configuration is loaded
Metadata #
Methods:
-
Clear–Clears all tags
-
Dump–Dumps metadata in human-readable format
-
GetArrayTag–Gets an array tag by key
-
GetKeys–Returns all tag keys
-
GetSingleTag–Gets a single tag by key
-
HasTag–Checks if a tag exists for the given key
-
Merge–Merges new tags into the metadata
-
PutImageTag–Adds an image tag
-
PutTag–Adds a MetadataSingleTag
-
RemoveTag–Removes a tag by key
-
Restore–Restores metadata from a serialized string
-
Serialize–Serializes the metadata
-
SetTag–Sets a tag
MetadataArrayTag #
Bases: MetadataTag
Methods:
-
AddValue–Adds a value to the array
-
Clone–Clones this tag
-
GetDevice–Returns the device label
-
GetName–Returns the name of the tag
-
GetQualifiedName–Returns the qualified name
-
GetSize–Returns the size of the array
-
GetValue–Gets a value at a specific index
-
IsReadOnly–Checks if the tag is read-only
-
Restore–Restores from a serialized string
-
Serialize–Serializes this tag to a string
-
SetDevice–Sets the device label
-
SetName–Sets the name of the tag
-
SetReadOnly–Sets the read-only status
-
SetValue–Sets a value at a specific index
-
ToArrayTag–Returns this object as MetadataArrayTag
-
ToSingleTag–Converts to MetadataSingleTag if applicable
MetadataIndexError #
Bases: IndexError
MetadataSingleTag #
Bases: MetadataTag
Methods:
-
Clone–Clones this tag
-
GetDevice–Returns the device label
-
GetName–Returns the name of the tag
-
GetQualifiedName–Returns the qualified name
-
GetValue–Returns the value
-
IsReadOnly–Checks if the tag is read-only
-
Restore–Restores from a serialized string
-
Serialize–Serializes this tag to a string
-
SetDevice–Sets the device label
-
SetName–Sets the name of the tag
-
SetReadOnly–Sets the read-only status
-
SetValue–Sets the value
-
ToArrayTag–Converts to MetadataArrayTag if applicable
-
ToSingleTag–Returns this object as MetadataSingleTag
MetadataTag #
Methods:
-
Clone–Creates a clone of the MetadataTag
-
GetDevice–Returns the device label
-
GetName–Returns the name of the tag
-
GetQualifiedName–Returns the qualified name
-
IsReadOnly–Checks if the tag is read-only
-
Restore–Restores from a serialized string
-
Serialize–Serializes the MetadataTag to a string
-
SetDevice–Sets the device label
-
SetName–Sets the name of the tag
-
SetReadOnly–Sets the read-only status
-
ToArrayTag–Converts to MetadataArrayTag if applicable
-
ToSingleTag–Converts to MetadataSingleTag if applicable
PortType #
PropertySetting #
Methods:
-
generateKey–Generates a unique key based on device and property
-
getDeviceLabel–Returns the device label
-
getKey–Returns the unique key
-
getPropertyName–Returns the property name
-
getPropertyValue–Returns the property value
-
getReadOnly–Returns the read-only status
-
getVerbose–Returns a verbose description
-
isEqualTo–Checks if this property setting is equal to another
generateKey staticmethod #
Generates a unique key based on device and property
isEqualTo #
isEqualTo(other: PropertySetting) -> bool
Checks if this property setting is equal to another
PropertyType #
patch_pymmcore #
patch_pymmcore()
Add a meta path hook to redirect imports of pymmcore to pymmcore_nano.