Microscope Settings Documentation

Microscope Control Software version 3.0.1.65

Settings folder structure
Microscope: All microscope configurations, one folder each, including settings for the microscope and its components.
Objective: All objective configurations, one folder each, including settings for the objective.
Drivers: All drivers configurations, one folder each, including settings for the drivers.
User: All user configurations, one folder each, including the settings for the user.

Field	Type/Value	Description	Required	Default
Microscope control
ApplicationSettings		Settings of the Microscope Control Software application.
DefaultMicroscope	string	The default folder for microscope settings.	Yes
DefaultObjective	string	The default folder for objective settings.	Yes
DefaultDrivers	string	The default folder for driver settings.	Yes
DefaultUser	string	The default folder for user settings.	Yes
MaxCacheSize	int	The size in bytes allocated for the cache.	Yes
Version	string	The version of the settings.	Yes
MicroscopeSettings		Microscope-specific settings, define the list of components to be utilized by the application.
Components	list of string	The list of components to load.	Yes
Common for all components
ComponentSettings	Component	Represent the configuration settings of an application component.
ComponentLabel	string	The user readable name of the component.	Yes
ComponentType	string	The type of the component to load.	Yes
DriverSettings	Driver	Specify the hardware driver to be used for a device and how to configure it.
DriverType	string	Name of the driver to use and configure.	Yes
UserSettings	User	Represent settings that can be edited by the user while the application is running. Can be exported and imported.
Version	string	The version of the settings.	Yes
IlluminationModule
<name>_Component	Component	Settings of an illumination module component.
Scanner1Offsets	list of double	Voltage offsets applied on scanner 1 at branches 1, 2, 3, etc.	No	[]
Scanner2Offsets	list of double	Voltage offsets applied on scanner 2 at branches 1, 2, 3, etc.	No	[]
BaseOffsets	list of dict	The base offsets of the scanners for each illumination branch. Keys of dict listed below.	No
Branch	int	Unique number of illumination branch (value 1, 2 or 3).	Yes
Scanner1Offset	double	Voltage on scanner 1.	Yes
Scanner2Offset	double	Voltage on scanner 2.	Yes
Scanner3Offset	double	Voltage on scanner 3.	Yes
Scanner4Offset	double	Voltage on scanner 4.	Yes
StageXYZName	string	The name of the stage XYZ component.	Yes
ObjectiveBlockName	string	The name of the objective block component.	Yes
SetMode	enum	Define when the device should be configured during time-lapse. Possible values listed below.	Yes
BeforePosition	string	For the whole experiment, set before every position.	-
BeforeSettings	string	For every settings profile, set before every settings profile.	-
BeforeStack	string	For every channel, set before every stack acquisition.	-
None	string	Not set.	-
SetLabel	string	The label of the illumination module editor.	No	null
SetLinkedDevice	string	The name of the device that will be linked to the illumination module. Same settings will be applied to the linked device.	No	null
PanelLocation	enum	The location of the illumination module panel. Possible values listed below.	Yes
Illumination1	string	Illumination 1 location.	-
Illumination2	string	Illumination 2 location.	-
<name>_Driver: SoftwareIlluminationModule	Driver	Settings of a software illumination module driver.
BranchCount	int	Number of emulated branches.	Yes
Delay	int	Delay in ms to simulate switching time between branches.	Yes
<name>_DeviceSettings	User	User settings of an illumination module device.
IlluminationSettings	string	The default illumination settings to apply on the device.	Yes
<name>_IlluminationSettings	User (list)	The illumination settings.
Branch	int	Selected illumination branch.	Yes
TranslationX	double	Translation X in um to apply.	Yes
RotationX	double	Rotation X in degrees to apply.	Yes
TranslationZ	double	Translation Z in um to apply.	Yes
RotationZ	double	Rotation Z in degrees to apply.	Yes
Name	string	The name of the settings.	Yes
Required	bool	Whether the settings are required (cannot be deleted or renamed).	No	false
CanEdit	bool	Whether the settings can be edited.	No	true
<name>_IlluminationObjectiveSettings	User (list)	The illumination objective-specific settings.
ObjectiveOffsets	dict (string => dict)	Offsets to apply to an objective, keyed by immersion medium.	No	null
Name	string	The name of the settings.	Yes
Required	bool	Whether the settings are required (cannot be deleted or renamed).	No	false
CanEdit	bool	Whether the settings can be edited.	No	true
<name>_PositionAlignmentSettings	User (list)	The position alignment settings.
TranslationZ	double	Translation Z in um to apply on this position.	Yes
Enable	bool	Enable position specific alignment for this position.	Yes
Name	string	The name of the settings.	Yes
Required	bool	Whether the settings are required (cannot be deleted or renamed).	No	false
CanEdit	bool	Whether the settings can be edited.	No	true
Photomanipulation
<name>_Component	Component	Settings of a photomanipulation component.
BaseOffsetsInternal	dict	Offsets to apply on scanners to switch internal lasers to photomanipulation path. Also used for external laser. Keys of dict listed below.	Yes
Scanner1Offset	double	Voltage on scanner 1 (closest to scan lens).	Yes
Scanner2Offset	double	Voltage on scanner 2.	Yes
Scanner3Offset	double	Voltage on scanner 3.	Yes
Scanner4Offset	double	Voltage on scanner 4 (furthest from scan lens).	Yes
StageXYZName	string	The name of the stage XYZ component.	Yes
ExternalLaser	bool	Whether an external photomanipulation laser is connected to the microscope.	No	false
InternalOffsetX	double	Offset X in um of internal lasers to center photomanipulation beam in X.	No	0
InternalOffsetY	double	Offset Y in um of internal lasers to center photomanipulation beam in Y.	No	0
ExternalOffsetX	double	Offset X in um of external laser to center photomanipulation beam in X.	No	0
ExternalOffsetY	double	Offset Y in um of external laser to center photomanipulation beam in Y.	No	0
<name>_RegionSettings	User (list)	The region settings.
Type	enum	The region type. Possible values listed below.	Yes
Point	string	Point region.	-
Line	string	Line region.	-
Width	double	The width of the region in micrometers.	No	10
Height	double	The height of the region in micrometers.	No	0
Rotation	double	The rotation of the region in degrees.	No	0
ExposureTime	int	The exposure time.	No	20
Repetitions	int	The number of time to apply this region.	No	10
Name	string	The name of the settings.	Yes
Required	bool	Whether the settings are required (cannot be deleted or renamed).	No	false
CanEdit	bool	Whether the settings can be edited.	No	true
<name>_PositionCoordinatesSettings	User (list)	The position coordinates settings.
OffsetX	double	The offset from position along X axis in micrometers.	Yes
OffsetY	double	The offset from position along Y axis in micrometers.	Yes
OffsetZ	double	The offset from position along Z axis in micrometers.	Yes
Region	string	The name of the region settings to apply.	Yes
Name	string	The name of the settings.	Yes
Required	bool	Whether the settings are required (cannot be deleted or renamed).	No	false
CanEdit	bool	Whether the settings can be edited.	No	true
FilterWheel
<name>_Component	Component	Settings of a filter wheel component.
SetMode	enum	Define when the device should be configured during time-lapse. Possible values listed below.	Yes
BeforePosition	string	For the whole experiment, set before every position.	-
BeforeSettings	string	For every settings profile, set before every settings profile.	-
BeforeStack	string	For every channel, set before every stack acquisition.	-
None	string	Not set.	-
SetLabel	string	The label of the filter wheel editor.	No	null
SetLinkedDevice	string	The name of the device that will be linked to the filter wheel. Same settings will be applied to the linked device.	No	null
PanelLocation	enum	The location of the filter wheel panel. Possible values listed below.	Yes
Illumination	string	Illumination filter wheel location.	-
Emission1	string	Emission filter wheel 1 location.	-
Emission2	string	Emission filter wheel 2 location.	-
<name>_Driver: MAC6000FilterWheel	Driver	Settings of a MAC6000 filter wheel driver.
IPAddress	string	TCP/IP address of MAC6000 controller.	Yes
FilterWheel	int	Index of filter wheel (one or two).	Yes
<name>_Driver: SerialFilterWheel	Driver	Settings of serial filter wheel driver.
VIDs	list of string	List of USB device VID values to identify filter wheel port.	Yes
PIDs	list of string	List of USB device PID values to identify filter wheel port.	Yes
SNs	list of string	List of USB device serial numbers to identify filter wheel port.	Yes
COM	string	If not null override COM port automatic detection and use specified COM port.	No	null
BaudRate	int	COM port bound rate.	Yes
ReadTimeout	int	Read time out for serial port.	Yes
MoveCommandPrefix	string	Prefix of move to filter position command.	Yes
MoveCommandSuffix	string	Suffix of move to filter position command.	Yes
MoveCommandResponse	string	Response of move command indicating move completed.	Yes
GetPositionCommand	string	Command to get current filter wheel position.	Yes
Echo	bool	Indicates if sent bytes are being sent back (echo on COM port).	Yes
<name>_Driver: SoftwareFilterWheel	Driver	Settings of a software filter wheel driver.
FilterCount	int	Number of filter positions.	Yes
Delay	int	Delay to simulate filter wheel turn.	Yes
CommandErrorPosition	int	Trigger simulated command error when moved to this position.	Yes
DeviceErrorPosition	int	Trigger simulated device error when moved to this position.	Yes
<name>_DeviceSettings	User	User settings of a filter wheel device.
FilterSettings	string	The default filter settings applied on the device.	Yes
<name>_FilterSettings	User (list)	The filter settings.
Position	int	The position in the filter wheel.	Yes
Name	string	The name of the settings.	Yes
Required	bool	Whether the settings are required (cannot be deleted or renamed).	No	false
CanEdit	bool	Whether the settings can be edited.	No	true
AcquisitionController
<name>_Component	Component	Settings of an acquisition controller component.
IlluminNames	list of string	List of unique identifiers of illumination sources.	Yes
IlluminLabels	dict (string => string)	The labels associated to each illumination source.	Yes
IlluminAOChannels	dict (string => int)	The analog modulation AO channels associated to each illumination source.	Yes
IlluminAOMaxVoltage	int	Analog output voltage corresponding to maximum power.	No	5
IlluminDOChannels	dict (string => int)	The digital modulation DO channels associated to each illumination source.	Yes
Camera1DOChannel	int	DO channel for camera 1.	Yes
Camera2DOChannel	int	DO channel for camera 2.	Yes
CameraReadoutTime	int	Readout time of camera full chip in ms.	Yes
FrameDOChannel	int	DO for oscilloscope trigger signal.	Yes
IlluminModule1Name	string	Name of the illumination module component 1.	No
IlluminModule2Name	string	Name of the illumination module component 2.	No
CameraName	string	The name of the camera component.	Yes
ObjectiveBlockName	string	The name of the objective block component.	Yes
Scanner1AO	int	Analog output channel for Viventis Deep scanner 1 (closest to scan lens).	No
Scanner2AO	int	Analog output channel for Viventis Deep scanner 2.	No
Scanner3AO	int	Analog output channel for Viventis Deep scanner 3.	No
Scanner4AO	int	Analog output channel for Viventis Deep scanner 4 (furthest from scan lens).	No
Scanner1Factor	double	Factor to convert micrometer of translation XY to scanner 1 voltage. Measured for water medium with 10X illumination objective of NA=0.2.	No
Scanner2Factor	double	Factor to convert micrometer of translation XY to scanner 2 voltage. Measured for water medium with 10X illumination objective of NA=0.2.	No
Scanner3Factor	double	Factor to convert degrees of rotation Z to scanner 3 voltage. Measured for water medium with 10X illumination objective of NA=0.2.	No
Scanner4Factor	double	Factor to convert degrees of rotation Z to scanner 4 voltage. Measured for water medium with 10X illumination objective of NA=0.2.	No
Scanner2To3Factor	double	Relation factor of scanner 2 rotation to scanner 3 rotation to generate pure beam translation.	No	0
PhotomanName	string	Name of the photomanipulation component.	No
PhotomanShutterDO	int	Digital output channel for internal laser photomanipulation switch.	No
PhotomanExternalDO	int	Digital output channel for external photomanipulation laser shutter.	No
PhotomanExternalAO	int	Analog output channel for external photomanipulation laser analog modulation.	No
PhotomanExternalPercentage	list of double	List of modulation percentages for external photomanipulation laser for which corresponding analog modulation voltages are provided.	No
PhotomanExternalVoltage	list of double	List of analog modulation voltages for external photomanipulation laser for which corresponding modulation percentages are provided.	No
PhotomanScannerFactor	double	Factor to convert micrometer of translation XY to scanner 1 and 2 voltage for photomanipulation light path. Measured with 25X objective.	No
<name>_Objective	Objective	Objective-specific settings of an acquisition controller device.
Illumin1TiltFactor	double	Factor of scanner 1 to tilt the scan plane for illumination 1.	No	0
Illumin2TiltFactor	double	Factor of scanner 1 to tilt the scan plane for illumination 2.	No	0
<name>_Driver: RTC1AcquisitionController	Driver	Settings of a RTC1 acquisition controller driver.
IPAddress	string	TCP/IP address.	Yes
Port	int	TCP/IP port.	Yes
AOCount	int	Number of analog output channels.	Yes
AOVoltages	list of string	Analog output voltage range for each channel ("0to5V", "0to10V", "-5to5V", "-10to10V").	Yes
AOOffsetEncoding	list of bool	Analog output sent in two's complement or offset encoding (according to Analog Devices AD5754 documentation).	Yes
DOCount	int	Number of digital output channels.	Yes
<name>_Driver: SoftwareAcquisitionController	Driver	Settings of a software acquisition controller driver.
Delay	int	Time of filter movement.	Yes
<name>_IlluminationSettings	User (list)	The illumination settings.
IlluminIntensities	dict (string => double)	The intensity (as a percentage of the maximum) for each illumination.	Yes
Name	string	The name of the settings.	Yes
Required	bool	Whether the settings are required (cannot be deleted or renamed).	No	false
CanEdit	bool	Whether the settings can be edited.	No	true
<name>_ExposureSettings	User (list)	The exposure settings.
ExposureTime	int	Exposure time in ms.	Yes
Scans	int	Number of scans, not implemented, value will be ignored.	Yes
IsRangeFullFOV	bool	Whether the range should cover the full field of view. will be ignored if true.	No	true
Range	int	Range of scanning to generate light sheet in um.	Yes
Illumination1	bool	Enable or disable illumination one.	Yes
Illumination2	bool	Enable or disable illumination two.	Yes
Offset1	int	Translation X to apply on illumination one.	Yes
Offset2	int	Translation X to apply on illumination two.	Yes
MLS	bool	Multi-directional light sheet, not implemented.	Yes
Name	string	The name of the settings.	Yes
Required	bool	Whether the settings are required (cannot be deleted or renamed).	No	false
CanEdit	bool	Whether the settings can be edited.	No	true
StageXYZ
<name>_Component	Component	Settings of a stage XYZ component.
ImagingPosition	list of 3 doubles	Imaging position coordinates in micrometer.	Yes
ImagingPositionMoveOrder	string	Order in which axis move to the imaging position ('XYZ', 'XZY' etc.).	Yes
LoadPosition	list of 3 doubles	Load position coordinates in micrometer.	Yes
LoadPositionMoveOrder	string	Order in which axis move to the load position ('XYZ', 'XZY' etc.).	Yes
BlockExchangePosition	list of 3 doubles	Block exchange position coordinates in micrometer.	Yes
<name>_Objective	Objective	Objective-specific settings of a stage XYZ device.
PositionXLimit	list of double	Limit of stage movement in X (min, max) during acquisition.	Yes
PositionYLimit	list of double	Limit of stage movement in Y (min, max) during acquisition.	Yes
PositionZLimit	list of double	Limit of stage movement in Z (min, max) during acquisition.	Yes
StackDirection	int	Direction of stage movement in Z stack (1 or -1).	Yes
<name>_Driver: SmarActMCSStageXYZ	Driver	Settings of SmarAct MCS stage XYZ driver.
IPAddress	string	IP address of the MCS controller.	Yes
Port	int	TCP port of the MCS controller.	Yes
Controller	string	Type of MCS controller.	Yes
ReverseRefDirection	list of bool	List of three values defining if for each positioning axis to reverse referencing direction.	Yes
ReferenceOrder	string	Order in which axis move to the reference position after cold start ('XYZ', 'XZY', etc.).	Yes
HoldTimes	list of 3 integers	Hold times in ms programmed to each positioning axis.	No	[ 100, 100, 100 ]
<name>_Driver: SoftwareStageXYZ	Driver	Settings of software stage XYZ driver.
Delay	int	Latency of communication in ms.	Yes
<name>_DeviceSettings	User	User settings of a stage XYZ device.
MinTileOverlap	double	The minimum overlap between tiles as a percentage of the field of view.	Yes
<name>_PositionSettings	User (list)	The position settings.
PositionX	double	The position along stage X axis.	Yes
PositionY	double	The position along stage Y axis.	Yes
PositionZ	double	The position along stage Z axis.	Yes
RangeXY	list of double	The range along the X and Y axes. May be null if not defined.	No	null
RangeXYMarkers	list of dict	The range XY markers. May be null if not defined. Keys of dict listed below.	No	null
Type	enum	The type of the range XY marker. Possible values listed below.	Yes
MinX	string	Marker with minimum X value.	-
MinXMinY	string	Marker with minimum X and minimum Y value.	-
MinXMaxY	string	Marker with minimum X and maximum Y value.	-
MaxX	string	Marker with maximum X value.	-
MaxXMinY	string	Marker with maximum X and minimum Y value.	-
MaxXMaxY	string	Marker with maximum X and maximum Y value.	-
MinY	string	Marker with minimum Y value.	-
MaxY	string	Marker with maximum Y value.	-
Coordinates	list of 3 doubles or nulls	The coordinates of the marker. Some coordinates may be null if definable from the range XY.	Yes
RangeZ	double?	The range along the Z axis. May be null if not defined.	No	null
MinRangeZMarker	list of double	The X and Y relative coordinates of the range Z marker with minimum Z value.	No	null
MaxRangeZMarker	list of double	The X and Y relative coordinates of the range Z marker with maximum Z value.	No	null
SkipPosition	bool	Whether the acquisition of the position should be skipped.	Yes
Name	string	The name of the settings.	Yes
Required	bool	Whether the settings are required (cannot be deleted or renamed).	No	false
CanEdit	bool	Whether the settings can be edited.	No	true
<name>_ZStackSettings	User (list)	The Z-Stack settings.
Step	double	The step size in micrometer between each plane.	Yes
Planes	int	The number of planes of the stack.	Yes
PlanesFromPosition	bool	Whether the number of planes is determined from the position range Z. If Z range is not available, use the defined number of planes as default.	No	false
Name	string	The name of the settings.	Yes
Required	bool	Whether the settings are required (cannot be deleted or renamed).	No	false
CanEdit	bool	Whether the settings can be edited.	No	true
ObjectiveBlock
<name>_Component	Component	Settings of an objective block component.
StageXYZName	string	The name of the stage XYZ component.	Yes
<name>_Objective	Objective	The user settings of an objective block.
Objective	string	The name of the objective.	Yes
IsMulti	bool	Whether the objective is a multi-immersion objective, otherwise it is assumed to be a water immersion objective.	Yes
CanPhotomanipulate	bool	Whether photomanipulation can be used with this objective block.	No	false
IlluminationMagnification	double	The magnification of the illumination objective at the reference refractive index (if any).	Yes
IlluminationReferenceRI	double?	The reference refractive index for the defined illumination magnification. if illumination magnification are not refractive index dependent.	No	null
DetectionMagnification	double	The magnification of the detection objective at the reference refractive index (if any).	Yes
DetectionNumericalAperture	double	The numerical aperture of the detection objective at the reference refractive index (if any).	Yes
DetectionReferenceRI	double?	The reference refractive index for the defined detection magnification/NA. if detection magnification/NA are not refractive index dependent.	No	null
Views	enum	The available view options for this objective. Possible values listed below.	Yes
View1	string	View 1	-
View2	string	View 2	-
View1And2	string	View 1 and 2	-
<name>_ImmersionMediumSettings	User (list)	The immersion medium settings.
RefractiveIndex	double	The refractive index of the immersion medium.	Yes
ShadingCorrectionFactors	list of dict	The shading correction factors for each view. Keys of dict listed below.	No	null
C	double	The constant term.	Yes
HL	double	The horizontal linear coefficient.	Yes
VL	double	The vertical linear coefficient.	Yes
TQ	double	The tilted quadratic coefficient.	Yes
HQ	double	The horizontal quadratic coefficient.	Yes
VQ	double	The vertical quadratic coefficient.	Yes
ShadingMeasurementDay	dict?	The day when the shading was measured. Keys of dict listed below.	No	null
Year	int		No
Month	int		No
Day	int		No
DayOfWeek	enum	Possible values listed below.	No
Sunday	string		-
Monday	string		-
Tuesday	string		-
Wednesday	string		-
Thursday	string		-
Friday	string		-
Saturday	string		-
DayOfYear	int		No
DayNumber	int		No
Name	string	The name of the settings.	Yes
Required	bool	Whether the settings are required (cannot be deleted or renamed).	No	false
CanEdit	bool	Whether the settings can be edited.	No	true
ImageViewer
<name>_Component	Component	Settings for the image viewer component.
StageXYZName	string	The name of the stage XYZ component.	Yes
PhotomanName	string	The name of the photomanipulation component.	No	null
Illumination1Angle	double	The angle of the illumination 1 in degrees from the horizontal axis.	Yes
Illumination2Angle	double	The angle of the illumination 2 in degrees from the horizontal axis.	Yes
Camera
<name>_Component	Component	Settings of a camera component.
BufferLength	int	Number of images in buffer, maximum number of images per channel and view.	Yes
Channels	int	Number of channels in buffer, maximum number of channels.	Yes
Views	int	Number of views.	No	1
Cameras	int	Number of cameras on view one (single or dual camera system).	No	1
SensorPixelSize	double	The pixel size of the camera sensor in micrometers.	Yes
DarkOffset	int	The average background value of a dark image (zero photons).	Yes
JetrawEnable	bool	Enable jetraw compression integration.	No	false
JetrawLiceseKey	string	Jetraw license key.	No	null
JetrawDevice	string	Jetraw device to use calibration data.	No	null
StageXYZName	string	The name of the stage XYZ component.	Yes
ImageViewerName	string	The name of the image viewer component.	Yes
ObjectiveBlockName	string	The name of the objective block component.	Yes
<name>_Objective	Objective	Objective-specific settings of a camera device.
OffsetX	int	Offset between view 1 and view 2 along X in pixels.	No	0
OffsetY	int	Offset between view 1 and view 2 along Y in pixels.	No	0
<name>_Driver: HamamatsuCamera	Driver	Settings of a Hamamatsu camera driver.
View1Camera1	string	Serial number of camera installed on view one.	Yes
View1Camera1FlipVertically	bool	Flip image of view one vertically.	No	false
View2Camera1	string	Serial number of camera installed on view two.	No	null
View2Camera1FlipVertically	bool	Flip image of view two vertically.	No	false
BufferLength	int	Length of the buffer (in full frames) sent to the camera driver.	Yes
SensorWidth	int	Width of camera sensor in px.	Yes
SensorHeight	int	Height of camera sensor in px.	Yes
Cooling	bool	Enable camera cooling.	No	true
Temperature	string	Requested cooling temperature, not implemented.	No	null
<name>_Driver: K8Camera	Driver	Settings of a K8 camera driver.
View1Camera1	string	The serial number of camera installed on view one.	Yes
View1Camera1FlipVertically	bool	Flip image of view one vertically.	No	false
View2Camera1	string	The serial number of camera installed on view two.	No	null
View2Camera1FlipVertically	bool	Flip image of view two vertically.	No	false
BufferLength	int	Length of the buffer (in full frames) sent to the camera driver.	Yes
SensorWidth	int	Width of camera sensor in px.	Yes
SensorHeight	int	Height of camera sensor in px.	Yes
<name>_Driver: SoftwareCamera	Driver	Settings of a software camera driver.
Width	int	Camera AOI width in px.	Yes
Height	int	Camera AOI height in px.	Yes
Exposure	int	Exposure time in ms used to simulate stream of images.	Yes
SensorWidth	int	Width of camera sensor in px.	Yes
SensorHeight	int	Height of camera sensor in px.	Yes
<name>_DeviceSettings	User	User settings of a camera device.
CameraSettings	string	The default camera settings to apply on the device.	Yes
StorageSettings	string	The default storage settings to apply on the device.	Yes
<name>_CameraSettings	User (list)	The camera settings.
AOIWidth	int	The width of the area of interest in pixels.	Yes
AOIHeight	int	The height of the area of interest in pixels.	Yes
Name	string	The name of the settings.	Yes
Required	bool	Whether the settings are required (cannot be deleted or renamed).	No	false
CanEdit	bool	Whether the settings can be edited.	No	true
<name>_StorageSettings	User (list)	The storage settings.
Path	string	The path of the folder where to store the images.	Yes
Format	enum	The file format of the images. Possible values listed below.	Yes
OMETiffStack	string	OME-TIFF Stack format.	-
AiviaTiff	string	Aivia TIFF format.	-
Compression	enum	The compression method. Possible values listed below.	Yes
None	string	No compression.	-
LZW	string	Lempel-Ziv-Welch compression.	-
Jetraw	string	JetRaw compression.	-
ZSTD_LOW	string	Zstandard compression with low compression level (-7).	-
ZSTD_MEDIUM	string	Zstandard compression with medium compression level (1).	-
ZSTD_HIGH	string	Zstandard compression with high compression level (6).	-
Project	bool	Whether to compute the maximum projection images.	No	false
Autosave	bool	Whether to save the images.	Yes
SavePyramid	bool	Whether to save image pyramid.	No	true
Name	string	The name of the settings.	Yes
Required	bool	Whether the settings are required (cannot be deleted or renamed).	No	false
CanEdit	bool	Whether the settings can be edited.	No	true
TimeLapseController
<name>_Component	Component	Settings of a time lapse controller component.
VerifyCameraImageReceived	bool	Whether to wait for image to be received by camera driver after each camera trigger.	No	false
StageXYZName	string	The name of the stage XYZ component.	Yes
CameraName	string	The name of the camera component.	Yes
AcquisitionControllerName	string	The name of the acquisition controller component.	Yes
ObjectiveBlockName	string	Name of the objective block component.	Yes
SettableDevices	list of string	The names of the settable devices.	No	null
PhotomanName	string	Name of the photomanipulation component.	No	null
IlluminationFilterWheelName	string	Name of the illumination filter wheel component. Required if photomanipulation is set.	No	null
EmissionFilterWheelsName	list of string	Name of emission filter wheel components. Required if photomanipulation is set (at least one).	No	null
PhotomanipulationEmissionFilter	string	Name of the settings to use on emission filter wheels for photomanipulation. Required if photomanipulation is set.	No	null
<name>_AcquisitionSettings	User	Settings of an acquisition.
TimeInterval	double	The time interval in seconds between two time points.	Yes
Repetitions	int	The number of time points to acquire.	Yes
ExperimentName	string	The name of the experiment.	Yes
DeviceSettings	list of dict	Acquisition-related settings for some devices. Keys of dict listed below.	No
Name	string	The name of the device to set.	Yes
Settings	string	The name of the settings to apply.	No
SettingsProfiles	list of dict	The list of settings profiles. Keys of dict listed below.	Yes
Name	string	The name of the settings profile.	Yes
Enabled	bool	Whether the profile should be acquired.	Yes
ZStack	string	The name of the Z-Stack settings to apply, single plane if null.	No	null
Positions	list of string	The list of positions to acquire. If null, all positions are acquired. If empty, no positions are acquired.	No	null
Views	enum	The view(s) to acquire. Possible values listed below.	No	0
View1	string	View 1	-
View2	string	View 2	-
View1And2	string	View 1 and 2	-
DeviceSettings	list of dict	Settings for some devices. Keys of dict listed below.	No
Name	string	The name of the device to set.	Yes
Settings	string	The name of the settings to apply.	No
Channels	list of dict	The list of channel settings. Keys of dict listed below.	Yes
Name	string	The name of the channel.	Yes
Enabled	bool	Whether the channel should be acquired.	Yes
AcquireNthTimePoint	int	Interval at which the channel is acquired. It is acquired at every specified number of time points.	No
Color	enum	The channel default color. Possible values listed below.	Yes
Red	string	Red color.	-
Green	string	Green color.	-
Blue	string	Blue color.	-
Cyan	string	Cyan color.	-
Magenta	string	Magenta color.	-
Yellow	string	Yellow color.	-
White	string	White color.	-
Illumination	string	Name of the illumination settings to apply on acquisition controller device.	No
Exposure	string	Name of the exposure settings to apply on acquisition controller device.	No
Camera	int	The index of the camera to use.	No
DeviceSettings	list of dict	Channel-related settings for some devices. Keys of dict listed below.	Yes
Name	string	The name of the device to set.	Yes
Settings	string	The name of the settings to apply.	No
Photomanipulation	dict	The photomanipulation settings. Keys of dict listed below.	No
Enabled	bool	Whether the photomanipulation should be executed.	No
IlluminationInternal	bool	Whether to use the internal illumination.	No	true
Illumination	string	Name of the illumination settings to apply on acquisition controller device.	No	null
IlluminationFilter	string	Name of the illumination filter settings to apply on the filter wheel.	No	null
IlluminationIntensityExternal	double	The intensity (as a percentage of the maximum) of the external illumination.	No	0
Positions	list of string	The list of positions to photomanipulate. If null, all positions are photomanipulated. If empty, no positions are photomanipulated.	No	null
TimePoints	list of int	The list of time points to photomanipulate. If both and are null, the photomanipulation is executed at every time point. If empty and is null, no time points are photomanipulated.	No	null
AcquireNthTimePoint	int?	Interval at which the channel is acquired. It is acquired at every specified number of time points. If both and are null, the photomanipulation is executed at every time point.	No	null
ChannelPresets	list of dict	The list of channel presets. Keys of dict listed below.	No
Name	string	The name of the channel.	Yes
Enabled	bool	Whether the channel should be acquired.	Yes
AcquireNthTimePoint	int	Interval at which the channel is acquired. It is acquired at every specified number of time points.	No
Color	enum	The channel default color. Possible values listed below.	Yes
Red	string	Red color.	-
Green	string	Green color.	-
Blue	string	Blue color.	-
Cyan	string	Cyan color.	-
Magenta	string	Magenta color.	-
Yellow	string	Yellow color.	-
White	string	White color.	-
Illumination	string	Name of the illumination settings to apply on acquisition controller device.	No
Exposure	string	Name of the exposure settings to apply on acquisition controller device.	No
Camera	int	The index of the camera to use.	No
DeviceSettings	list of dict	Channel-related settings for some devices. Keys of dict listed below.	Yes
Name	string	The name of the device to set.	Yes
Settings	string	The name of the settings to apply.	No
PyMCSLauncher
<name>_Component	Component	The settings of the PyMCS launcher component.
PythonInterpreter	string	The location of the python interpreter.	Yes