nd2.structures

ExpLoop = Union[TimeLoop, NETimeLoop, XYPosLoop, ZStackLoop, CustomLoop] module-attribute

LoopParams = Union[TimeLoopParams, NETimeLoopParams, XYPosLoopParams, ZStackLoopParams] module-attribute

ModalityFlags = Literal['aux', 'brightfield', 'camera', 'diContrast', 'dsdConfocal', 'fluorescence', 'gaasp', 'iSIM', 'laserScanConfocal', 'liveSR', 'multiphoton', 'nonDescannedDetector', 'phaseContrast', 'pmt', 'RCM', 'remainder', 'SIM', 'sora', 'spectral', 'spinningDiskConfocal', 'sweptFieldConfocalPinhole', 'sweptFieldConfocalSlit', 'TIRF', 'transmitDetector', 'vaasIF', 'vaasNF', 'VCS', 'virtualFilter'] module-attribute

AnimParam dataclass

Parameters of ROI position/shape.

boxShape: BoxShape = field(default_factory=BoxShape) class-attribute instance-attribute

center: XYZPoint property

Center point as a named tuple (x, y, z).

centerX: float = 0 class-attribute instance-attribute

centerY: float = 0 class-attribute instance-attribute

centerZ: float = 0 class-attribute instance-attribute

enabled: bool = True class-attribute instance-attribute

extrudedShape: ExtrudedShape = field(default_factory=ExtrudedShape) class-attribute instance-attribute

rotationZ: float = 0 class-attribute instance-attribute

timeMs: float = 0 class-attribute instance-attribute

Attributes

bitsPerComponentInMemory: int instance-attribute

bitsPerComponentSignificant: int instance-attribute

channelCount: int | None = None class-attribute instance-attribute

componentCount: int instance-attribute

compressionLevel: float | None = None class-attribute instance-attribute

compressionType: Literal['lossless', 'lossy', 'none'] | None = None class-attribute instance-attribute

heightPx: int instance-attribute

pixelDataType: Literal['float', 'unsigned'] instance-attribute

sequenceCount: int instance-attribute

tileHeightPx: int | None = None class-attribute instance-attribute

tileWidthPx: int | None = None class-attribute instance-attribute

widthBytes: int | None = None class-attribute instance-attribute

widthPx: int | None = None class-attribute instance-attribute

BoxShape

sizeX: float = 0 class-attribute instance-attribute

sizeY: float = 0 class-attribute instance-attribute

sizeZ: float = 0 class-attribute instance-attribute

Channel dataclass

channel: ChannelMeta instance-attribute

loops: LoopIndices | None instance-attribute

microscope: Microscope instance-attribute

volume: Volume instance-attribute

ChannelMeta dataclass

color: Color instance-attribute

colorRGBA: int property

Return color as unsigned 4-byte (32-bit) integer in ABGR format.

emissionLambdaNm: float | None = None class-attribute instance-attribute

excitationLambdaNm: float | None = None class-attribute instance-attribute

index: int instance-attribute

name: str instance-attribute

Color

a: float = 1.0 class-attribute instance-attribute

b: int instance-attribute

g: int instance-attribute

r: int instance-attribute

as_abgr_u4() -> int

Return color as an unsigned 4-byte (32-bit) integer in ABGR format.

This is the native format of NIS Elements.

as_hex() -> str

Return color as a hex string.

from_abgr_u4(val: int) -> Color classmethod

Create a color from an unsigned 4-byte (32-bit) integer in ABGR format.

Contents dataclass

channelCount: int instance-attribute

frameCount: int instance-attribute

Coordinate

index: int instance-attribute

size: int instance-attribute

type: str instance-attribute

CustomLoop dataclass

count: int instance-attribute

nestingLevel: int = 0 class-attribute instance-attribute

parameters: None = None class-attribute instance-attribute

type: Literal['CustomLoop'] = 'CustomLoop' class-attribute instance-attribute

ExperimentEvent dataclass

data: str = '' class-attribute instance-attribute

description: str = '' class-attribute instance-attribute

id: int = 0 class-attribute instance-attribute

meaning: EventMeaning = EventMeaning.Unspecified class-attribute instance-attribute

stimulation: StimulationEvent | None = None class-attribute instance-attribute

time: float = 0.0 class-attribute instance-attribute

time2: float = 0.0 class-attribute instance-attribute

ExtrudedShape

basePoints: list[XYPoint] = field(default_factory=list) class-attribute instance-attribute

sizeZ: float = 0 class-attribute instance-attribute

FrameChannel dataclass

position: Position instance-attribute

time: TimeStamp instance-attribute

FrameMetadata dataclass

channels: list[FrameChannel] instance-attribute

contents: Contents instance-attribute

ImageInfo

bits_per_pixel: int instance-attribute

components: int instance-attribute

height: int instance-attribute

width: int instance-attribute

InterpType

The role that the ROI plays.

AnyROI = 0 class-attribute instance-attribute

BackgroundROI = 2 class-attribute instance-attribute

ReferenceROI = 3 class-attribute instance-attribute

StandardROI = 1 class-attribute instance-attribute

StimulationROI = 4 class-attribute instance-attribute

LoopIndices dataclass

CustomLoop: int | None = field(default=None, repr=False, compare=False) class-attribute instance-attribute

NETimeLoop: int | None = None class-attribute instance-attribute

TimeLoop: int | None = None class-attribute instance-attribute

XYPosLoop: int | None = None class-attribute instance-attribute

ZStackLoop: int | None = None class-attribute instance-attribute

LoopType

CustomLoop = 7 class-attribute instance-attribute

ManTimeLoop = 9 class-attribute instance-attribute

NETimeLoop = 8 class-attribute instance-attribute

PolarLoop = 5 class-attribute instance-attribute

SpectLoop = 6 class-attribute instance-attribute

TimeLoop = 1 class-attribute instance-attribute

Unknown = 0 class-attribute instance-attribute

XYDiscrLoop = 3 class-attribute instance-attribute

XYPosLoop = 2 class-attribute instance-attribute

ZStackLoop = 4 class-attribute instance-attribute

ZStackLoopAccurate = 10 class-attribute instance-attribute

Metadata dataclass

channels: list[Channel] | None = None class-attribute instance-attribute

contents: Contents | None = None class-attribute instance-attribute

Microscope dataclass

immersionRefractiveIndex: float | None = None class-attribute instance-attribute

modalityFlags: list[ModalityFlags] = field(default_factory=list) class-attribute instance-attribute

objectiveMagnification: float | None = None class-attribute instance-attribute

objectiveName: str | None = None class-attribute instance-attribute

objectiveNumericalAperture: float | None = None class-attribute instance-attribute

pinholeDiameterUm: float | None = None class-attribute instance-attribute

projectiveMagnification: float | None = None class-attribute instance-attribute

zoomMagnification: float | None = None class-attribute instance-attribute

NETimeLoop dataclass

The time dimension of an nD experiment.

parameters: NETimeLoopParams instance-attribute

type: Literal['NETimeLoop'] = 'NETimeLoop' class-attribute instance-attribute

NETimeLoopParams dataclass

periods: list[Period] instance-attribute

Period dataclass

count: int instance-attribute

PeriodDiff dataclass

avg: float = 0 class-attribute instance-attribute

max: float = 0 class-attribute instance-attribute

min: float = 0 class-attribute instance-attribute

Position dataclass

name: str | None = None class-attribute instance-attribute

pfsOffset: float | None = None class-attribute instance-attribute

stagePositionUm: StagePosition instance-attribute

ROI dataclass

ROI object from NIS Elements.

animParams: list[AnimParam] = field(default_factory=list) class-attribute instance-attribute

guid: str instance-attribute

id: int instance-attribute

info: RoiInfo instance-attribute

RoiInfo dataclass

Info associated with an ROI.

appData: int = 0 class-attribute instance-attribute

autodetected: bool = False class-attribute instance-attribute

bpc: int = 16 class-attribute instance-attribute

color: int = 255 class-attribute instance-attribute

compCount: int = 2 class-attribute instance-attribute

cookie: int = 0 class-attribute instance-attribute

gradientStimulation: bool = False class-attribute instance-attribute

gradientStimulationBitDepth: int = 0 class-attribute instance-attribute

gradientStimulationHi: float = 0.0 class-attribute instance-attribute

gradientStimulationLo: float = 0.0 class-attribute instance-attribute

interpType: InterpType instance-attribute

label: str = '' class-attribute instance-attribute

locked: bool = False class-attribute instance-attribute

multiFrame: bool = False class-attribute instance-attribute

scope: ScopeType = ScopeType.Global class-attribute instance-attribute

shapeType: RoiShapeType instance-attribute

stimulationGroup: int = 0 class-attribute instance-attribute

RoiShapeType

The type of ROI shape.

Any = 0 class-attribute instance-attribute

Bezier = 6 class-attribute instance-attribute

Circle = 9 class-attribute instance-attribute

Ellipse = 4 class-attribute instance-attribute

Line = 7 class-attribute instance-attribute

Point = 2 class-attribute instance-attribute

PolyLine = 8 class-attribute instance-attribute

Polygon = 5 class-attribute instance-attribute

Raster = 1 class-attribute instance-attribute

Rectangle = 3 class-attribute instance-attribute

Ring = 11 class-attribute instance-attribute

Spiral = 12 class-attribute instance-attribute

Square = 10 class-attribute instance-attribute

ScopeType

Any = 0 class-attribute instance-attribute

Global = 1 class-attribute instance-attribute

MPoint = 2 class-attribute instance-attribute

SpectLoop dataclass

count: int instance-attribute

type: Literal['SpectLoop'] = 'SpectLoop' class-attribute instance-attribute

StagePosition

x: float instance-attribute

y: float instance-attribute

z: float instance-attribute

StimulationEvent dataclass

description: str = '' class-attribute instance-attribute

loop_index: int = 0 class-attribute instance-attribute

position: int = 0 class-attribute instance-attribute

type: StimulationType = StimulationType.NoStimulation class-attribute instance-attribute

T

AnimParams_Size: int instance-attribute

GUID: str instance-attribute

Id: int instance-attribute

Info: dict instance-attribute

TextInfo

appVersion: str instance-attribute

author: str instance-attribute

capturing: str instance-attribute

conclusion: str instance-attribute

date: str instance-attribute

description: str instance-attribute

group: str instance-attribute

imageId: str instance-attribute

info1: str instance-attribute

info2: str instance-attribute

location: str instance-attribute

optics: str instance-attribute

sampleId: str instance-attribute

sampling: str instance-attribute

type: str instance-attribute

TimeLoop dataclass

The time dimension of an experiment.

parameters: TimeLoopParams instance-attribute

type: Literal['TimeLoop'] = 'TimeLoop' class-attribute instance-attribute

TimeLoopParams dataclass

durationMs: float instance-attribute

periodDiff: PeriodDiff instance-attribute

periodMs: float instance-attribute

startMs: float instance-attribute

TimeStamp dataclass

absoluteJulianDayNumber: float instance-attribute

relativeTimeMs: float instance-attribute

Volume dataclass

axesCalibrated: tuple[bool, bool, bool] instance-attribute

axesCalibration: tuple[float, float, float] instance-attribute

axesInterpretation: tuple[AxisInterpretation, AxisInterpretation, AxisInterpretation] instance-attribute

bitsPerComponentInMemory: int instance-attribute

bitsPerComponentSignificant: int instance-attribute

cameraTransformationMatrix: tuple[float, float, float, float] instance-attribute

componentCount: int instance-attribute

componentDataType: Literal['unsigned', 'float'] instance-attribute

componentMaxima: list[float] | None = None class-attribute instance-attribute

componentMinima: list[float] | None = None class-attribute instance-attribute

pixelToStageTransformationMatrix: tuple[float, float, float, float, float, float] | None = None class-attribute instance-attribute

voxelCount: tuple[int, int, int] instance-attribute

XYPoint

x: float = 0 class-attribute instance-attribute

y: float = 0 class-attribute instance-attribute

XYPosLoop dataclass

parameters: XYPosLoopParams instance-attribute

type: Literal['XYPosLoop'] = 'XYPosLoop' class-attribute instance-attribute

XYPosLoopParams dataclass

isSettingZ: bool instance-attribute

points: list[Position] instance-attribute

XYZPoint

x: float = 0 class-attribute instance-attribute

y: float = 0 class-attribute instance-attribute

z: float = 0 class-attribute instance-attribute

ZStackLoop dataclass

parameters: ZStackLoopParams instance-attribute

type: Literal['ZStackLoop'] = 'ZStackLoop' class-attribute instance-attribute

ZStackLoopParams dataclass

bottomToTop: bool instance-attribute

deviceName: str | None = None class-attribute instance-attribute

homeIndex: int instance-attribute

stepUm: float instance-attribute