Instrument

Bases: NBOBaseClass

Represents the XML element Instrument.

This element describes the Instrument used to capture the Image. It is primarily a container referring to the list of hardware components included in a given Microscope. The list consists of the Microscope Stand, Microscope Table, Light Source, Light Source Coupling, Sample Holder, Focusing, Objective, Filter, Dichroic, Additional Lens (including a commonly used Magnification Changer, also known as Optovar), Additional Mirroring Device, Polarization Optics, Prism, Optical Aperture, Optical Device, Detector and Calibration Tool. The Filter element can be either composed of separate Excitation, Emission filters, and Dichroic mirrors or a single Filter Set. An Instrument might have multiple Light Sources, Detectors, Objectives, and Filters, etc. Each of these has its own ID attribute, which can be referred to from the Image, Plane or more commonly Channel elements associated with a given Image Acquisition session. It is understood that the Light Path configuration can be different for each Channel, but cannot be different for each timepoint or each Plane of an XYZ stack.

fromBase(base) staticmethod

getTypeName()

getXMLName()

getNBOType()

getChildren()

getSubElements()

fromJsonFile(path, validate=True)

fromMicroMetaAppJsonFile(path, validate=True)

fromJsonString(json_string, validate=True)

fromXmlFile(path, validate=True)

fromXmlString(xml_string, validate=True)

toXmlFile(filename, validate=True)

toXmlString(validate=True)

setID(value, validate=True)

getID()

resetID()

hasID()

setName(value, validate=True)

getName()

resetName()

hasName()

setMicroscopeStandGroup_List(value, validate=True)

getMicroscopeStandGroup_List()

addToMicroscopeStandGroup_List(value, validate=True)

clearMicroscopeStandGroup_List()

setMicroscopeTable_List(value, validate=True)

getMicroscopeTable_List()

addToMicroscopeTable_List(value, validate=True)

clearMicroscopeTable_List()

setSoftwareGroup_List(value, validate=True)

getSoftwareGroup_List()

addToSoftwareGroup_List(value, validate=True)

clearSoftwareGroup_List()

setEnvironmentalControlDevice_List(value, validate=True)

getEnvironmentalControlDevice_List()

addToEnvironmentalControlDevice_List(value, validate=True)

clearEnvironmentalControlDevice_List()

setLightSourceGroup_List(value, validate=True)

getLightSourceGroup_List()

addToLightSourceGroup_List(value, validate=True)

clearLightSourceGroup_List()

setLightSourceCouplingGroup_List(value, validate=True)

getLightSourceCouplingGroup_List()

addToLightSourceCouplingGroup_List(value, validate=True)

clearLightSourceCouplingGroup_List()

setObjective_List(value, validate=True)

getObjective_List()

addToObjective_List(value, validate=True)

clearObjective_List()

setOpticalAssemblyGroup_List(value, validate=True)

getOpticalAssemblyGroup_List()

addToOpticalAssemblyGroup_List(value, validate=True)

clearOpticalAssemblyGroup_List()

setOpticalApertureGroup_List(value, validate=True)

getOpticalApertureGroup_List()

addToOpticalApertureGroup_List(value, validate=True)

clearOpticalApertureGroup_List()

setStageInsert_List(value, validate=True)

getStageInsert_List()

addToStageInsert_List(value, validate=True)

clearStageInsert_List()

setSamplePositioningGroup_List(value, validate=True)

getSamplePositioningGroup_List()

addToSamplePositioningGroup_List(value, validate=True)

clearSamplePositioningGroup_List()

setFocusStabilizationDevice_List(value, validate=True)

getFocusStabilizationDevice_List()

addToFocusStabilizationDevice_List(value, validate=True)

clearFocusStabilizationDevice_List()

setOpticsHolderGroup_List(value, validate=True)

getOpticsHolderGroup_List()

addToOpticsHolderGroup_List(value, validate=True)

clearOpticsHolderGroup_List()

setFilterGroup_List(value, validate=True)

getFilterGroup_List()

addToFilterGroup_List(value, validate=True)

clearFilterGroup_List()

setMirroringDeviceGroup_List(value, validate=True)

getMirroringDeviceGroup_List()

addToMirroringDeviceGroup_List(value, validate=True)

clearMirroringDeviceGroup_List()

setLensGroup_List(value, validate=True)

getLensGroup_List()

addToLensGroup_List(value, validate=True)

clearLensGroup_List()

setPrism_List(value, validate=True)

getPrism_List()

addToPrism_List(value, validate=True)

clearPrism_List()

setPolarizationOptics_List(value, validate=True)

getPolarizationOptics_List()

addToPolarizationOptics_List(value, validate=True)

clearPolarizationOptics_List()

setDetectorGroup_List(value, validate=True)

getDetectorGroup_List()

addToDetectorGroup_List(value, validate=True)

clearDetectorGroup_List()

setTIRFHardwareModule_List(value, validate=True)

getTIRFHardwareModule_List()

addToTIRFHardwareModule_List(value, validate=True)

clearTIRFHardwareModule_List()

setConfocalScannerGroup_List(value, validate=True)

getConfocalScannerGroup_List()

addToConfocalScannerGroup_List(value, validate=True)

clearConfocalScannerGroup_List()

setAcoustoOpticalDeviceGroup_List(value, validate=True)

getAcoustoOpticalDeviceGroup_List()

addToAcoustoOpticalDeviceGroup_List(value, validate=True)

clearAcoustoOpticalDeviceGroup_List()

setElectroOpticalDeviceGroup_List(value, validate=True)

getElectroOpticalDeviceGroup_List()

addToElectroOpticalDeviceGroup_List(value, validate=True)

clearElectroOpticalDeviceGroup_List()

setMicrolensArray_List(value, validate=True)

getMicrolensArray_List()

addToMicrolensArray_List(value, validate=True)

clearMicrolensArray_List()

setIntensityCalibrationTool_List(value, validate=True)

getIntensityCalibrationTool_List()

addToIntensityCalibrationTool_List(value, validate=True)

clearIntensityCalibrationTool_List()

setAnnotationRef(value, validate=True)

getAnnotationRef()

resetAnnotationRef()

hasAnnotationRef()