Variable Group Variable Name Variable Type Read Write
Image Image.ActivePlane Number Yes Yes
Image.ActiveRegion Number Yes Yes
Image.Annotation String Yes Yes
Image.C02PressureStatus Number Yes Yes
Image.CameraX Number Yes Yes
Image.CameraY Number Yes Yes
Image.Depth Number Yes No
Image.FileDir String Yes Yes
Image.FileDrive String Yes Yes
Image.FileName String Yes Yes
Image.FilePath String Yes Yes
Image.Gamma Number Yes Yes
Image.Height Number Yes No
Image.IllumSetting String Yes Yes
Image.MagSetting String Yes Yes
Image.MouseClick.Flags Number Yes No
Image.MouseClick.Plane Number Yes No
Image.MouseClick.X Number Yes No
Image.MouseClick.Y Number Yes No
Image.NA Number Yes Yes
Image.Name String Yes Yes
Image.NumPlanes Number Yes No
Image.NumRegions Number Yes No
Image.Pixel.BlueValue Number Yes Yes
Image.Pixel.GreenValue Number Yes Yes
Image.Pixel.Intensity Number Yes Yes
Image.Pixel.RedValue Number Yes Yes
Image.Pixel.X Number Yes Yes
Image.Pixel.Y Number Yes Yes
Image.PlaneFileDir String Yes No
Image.PlaneFileDrive String Yes No
Image.PlaneFileIndex Number Yes No
Image.PlaneFileName String Yes No
Image.PlaneFilePath String Yes No
Image.RefractiveIndex Number Yes Yes
Image.ScaleAutoScale Number Yes Yes
Image.ScalePercentHigh Number Yes Yes
Image.ScalePercentLow Number Yes Yes
Image.ScaleValueHigh Number Yes Yes
Image.ScaleValueLow Number Yes Yes
Image.StageLabel String Yes Yes
Image.StageX Number Yes Yes
Image.StageY Number Yes Yes
Image.Temperature Number Yes Yes
Image.ThreshMax Number Yes Yes
Image.ThreshMin Number Yes Yes
Image.ThreshState Number Yes Yes
Image.Time.Create.Date Number Yes No
Image.Time.Create.String String Yes No
Image.Time.Create.Time Number Yes No
Image.Wavelength Number Yes Yes
Image.Width Number Yes No
Image.XCalibration Number Yes Yes
Image.YCalibration Number Yes Yes
Image.ZAbsolute Number Yes Yes
Image.ZDistance Number Yes Yes
Image.Zoom Number Yes Yes
Executable
Yes
Yes
No
No
No
No
No
No
No
No
No
Yes
No
No
No
No
No
No
No
No
Yes
No
No
Yes
Yes
Yes
Yes
Yes
Yes
No
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
No
No
No
No
Yes
Yes
Yes
No
No
No
No
No
No
No
No
No
Yes
Definition
Specifies the active plane of the current image. When changed it will set the active plane to the designated
number in the active image. It can be used as the For variable in a For/Next loop to loop for all planes. i.e. For
Imgane.ActivePlane = 1 to Image.NumPlanes step 1.
Specifies the active region on the current image. When changed it will set the active region to the designated
number on the active image. It can be used as the For variable in a For/Next loop to loop for all regions. i.e. For
Imgane.ActiveRegion = 1 to Image.NumRegions step 1.
Information stored with the image as configured in the Annotation tab of the Acquire dialog. To add additional
information to what is present use an Assign to Variable statement where Image.Annotation = Image.Annotation
+ "Your additional information"
Current Hardware settings at time image was acquired. If there is no device configure the value will be blank.
This value is the current CO2 Pressure from an incubation chamber on the microscope stage.
Upper left X pixel location on the chip of the camera that the image was acquired. Value will be 0 if used full chip,
but will be different if used center quadrant or active region to designate the chip area used for acquisition.
Upper left Y pixel location on the chip of the camera that the image was acquired. Value will be 0 if used full chip,
but will be different if used center quadrant or active region to designate the chip area used for acquisition.
Image Bit-Depth of the active image. Value is set at image window creation. Determined by camera settings at
acquisition, or result image setting for certain dialogs in MetaMorph, i.e. New Image dialog, Arithmetic dialog,
Color Combine dialog, etc..
Last directory that image was saved into. Value will be blank if image has not been saved.
Last drive that image was saved into. Value will be blank if image has not been saved.
File name File Path including was last saved.the image was blank ifinto. Value not been saved.
Complete used when image extension that Value will be saved image has will be blank if image has not been
saved. Variable can be built by combining File Drive, File Directory, File Name and an extension. i.e.
Image.FilePath = Image.FileDrive + Image.FileDir + Image.FileName + ".tif" will save out a tiff image in the path
created.
Current Gamma setting for active image. Changing this value will adjust the gamma of the image.
The Height in pixels of the active image. Can be used as an End Value variable in a nested For/Next loop to
cycle through every pixel in an image. i.e. FOR Image.Pixel.X = 1 TO Image.Width, FOR Image.Pixel.Y = 1 TO
Image.Height STEP 1, NEXT, NEXT.
Current Hardware settings at time image was acquired. If there is no device configure the value will be blank.
This value is the current Illumination Setting at the time the image was acquired.
Current Hardware settings at time image was acquired. If there is no device configure the value will be blank.
This value is the current Magnification Setting selected at the time the image was acquired.
Records the plane number of the last left mouse button click in the active image.
Records the X pixel location of the last left mouse button click in the active image.
Records the Y pixel location of the last left mouse button click in the active image.
Current Hardware settings at time image was acquired. If there is no device configure the value will be blank.
This value is based on the current Magnification Setting used at the time the image was acquired. It is set in the
Meta Imaging Series Administrator's Configure Hardware>>> Objectives Settings for the microscope.
Image name displayed on the image window title bar. Ideally used with a custom variable to store a specific
image name that can be later recalled to assure the correct image is being used for specific steps of the journal.
i.e. ImgNam = Image.Name… later: Select Image function>>> Specified option is set to %ImgNam%.
Indicates the number of plane in the active image window. For a single plane image this value is 1 for a
multiplaned image it is the total number of planes in the stack. Typically used to either verify that a stack is open
(If Image.NumPlanes > 1) or to do a loop for all planes (For Image.ActivePlane = 1 to Image.NumPlanes step 1).
Indicates the number of regions on the active image window. Typically used to do a loop for all regions (For
Image.ActiveRegion = 1 to Image.NumRegions step 1).
Intensity value of the blue channel of a 24-bit image at the specified Pixel.X and Pixel.Y position of the image.
Must set the Pixel.X and Pixel.Y values first. This intensity value can be change through a simple variable whole
number assignment or though a formula calculation in the expression of a variable assignment.
Intensity value of the green channel of a 24-bit image at the specified Pixel.X and Pixel.Y position of the image.
Must set the Pixel.X and Pixel.Y values first. This intensity value can be change through a simple variable whole
number assignment or though a formula calculation in the expression of a variable assignment.
Intensity value at the specified Pixel.X and Pixel.Y position of a monochrome image. Must set the Pixel.X and
Pixel.Y values first. This intensity value can be change through a simple variable whole number assignment or
though a formula calculation in the expression of a variable assignment.
Intensity value of the red channel of a 24-bit image at the specified Pixel.X and Pixel.Y position of the image.
Must set the Pixel.X and Pixel.Y values first. This intensity value can be change through a simple variable whole
number assignment or though a formula calculation in the expression of a variable assignment.
Sets the X pixel position in the image to allow changing the Image.Pixel.Intensity value (as well as the .BlueValue,
GreenValue, and RedValue of 24-bit images) Can be placed in a nested For/Next loop to loop through every
pixel in an image. i.e. For Image.Pixel.X = 1 to Image.Width step 1 with For Image.Pixel.Y = 1 to Image.Height
step 1 between the For and the Next.
Sets the X pixel position in the image to allow changing the Image.Pixel.Intensity value (as well as the .BlueValue,
GreenValue, and RedValue of 24-bit images) Can be placed in a nested For/Next loop to loop through every
pixel in an image. i.e. For Image.Pixel.X = 1 to Image.Width step 1 with For Image.Pixel.Y = 1 to Image.Height
step 1 between the For and the Next.
File directory of active plane the image was saved. Can be different in each plane if stack was built in MetaMorph
by adding images to a stack. For a single plane image same as Image.FileDir
File drive of active plane the image was saved. Can be different in each plane if stack was built in MetaMorph by
adding images to a stack. For a single plane image same as Image.FileDrive
Plane number. May be 0 if stack was just built and has not been saved.
File Name of active plane the image was saved. Can be different in each plane if stack was built in MetaMorph
by adding images to a stack. For a single plane image same as Image.FileName.
File Path of active plane the image was saved. Can be different in each plane if stack was built in MetaMorph by
adding images to a stack. For a single plane image same as Image.FilePath
Current Hardware settings at time image was acquired. If there is no device configure the value will be blank.
This value is based on the current Magnification Setting used at the time the image was acquired. It is set in the
Meta Imaging Series Administrator's Configure Hardware>>> Objectives Settings for the microscope.
Turns AutoScale on or off. If value =1, AutoScale is on, if value = 0, AutoScale is off.
Sets High % value used in AutoScale
Sets Low % value used is AutoScale
Sets High value used in non-AutoScale mode
Sets Low value used in non-AutoScale mode
Current Stage Label settings at time image was acquired. If there is no device configure the value will be blank.
Used with Stage Memory List, an MDA stage list, or a Scan Multi-Well Plate (Well number) before image
Current X value of stage at time image was acquired.
Current Y value of stage at time image was acquired.
Current Hardware settings at time image was acquired. These values can be read or written to. If there is no
device configure the value will be blank.
Sets the maximum intensity value for the threshold range.
Sets the minimum intensity value for the threshold range.
Sets Threshold state. Value = 0, threshold is off. Value = 1, threshold is set to inclusive. Value = 2, threshold is
set to exclusive.
Numeric value of date image was created. Cannot be changed.
Text string of time and date image was created. Cannot be changed.
Numeric value of time image was created. Cannot be changed.
Current Hardware settings at time image was acquired. If there is no device configure the value will be blank.
Value is based on the current Illumination Setting at the time the image was acquired. Is set in the Configure
Illumination dialog, Wavelength box.
The width in pixels for the active image. Can be used as an End Value variable in a nested For/Next loop to cycle
through every pixel in an image. i.e. FOR Image.Pixel.X = 1 TO Image.Width, FOR Image.Pixel.Y = 1 TO
Image.Height STEP 1, NEXT, NEXT.
X pixel calibration value. Can be applied through the Calibrate Distance dialog post acquisition, or at acquisition if
a calibration setting is linked to a Magnification setting.
Y pixel calibration value. Can be applied through the Calibrate Distance dialog post acquisition, or at acquisition if
a calibration setting is linked to a Magnification setting.
Current Hardware settings at time image was acquired. These values can be read or written to. If there is no
device configure the value will be blank.
Current Hardware settings at time image was acquired. These values can be read or written to. If there is no
device configure the value will be blank.
Current image zoom setting. Changing this value will adjust the zoom setting on the image.
Variable Group Variable Name Variable Type Read Write
Program Acquire.ErrorCode Number
Acquire.FPS Number
Acquire.Save.LastName String
Acquire.Save.LastPath String
Acquire.Save.NextName String
Acquire.Save.NextPath String
AdjustXYPosition.X Number
AdjustXYPosition.Y Number
Camera.Digital.Exposure Number Yes Yes
Component.XXXX_XXX Number or String Yes Yes
CopyFile.ErrorCode String
CreateDirectory.ErrorCode String
DeleteFile.ErrorCode String
Device.ActiveShutter.State Number Yes Yes
Device.Focus.Bottom Number
Device.Focus.CurPos Number
Device.Focus.Home Number
Device.Focus.Top Number
Device.Illumination.Setting String
Device.Magnification.Setting String
Device.Stage.XPosition Number
Device.Stage.Yposition Number
DoesFileExist.ErrorCode String
EnterVariable.LastResponse String
File.LastOpenedFile String
IMAObjectData.AverageGrayValue Number
IMAObjectData.TotalGrayValue Number
Journal.RunJournalLastDirectory String
MDA.BaseName String
MDA.Exposure Number
MDA.Gain Number
MDA.IntensifierGain Number
MDA.IntervalnSec Number
MDA.NumTimePoints Number
MDA.Path String
MDA.Stage.AFOffset Number
MDA.Stage.X Number
MDA.Stage.Y Number
MDA.Stage.Z Number
MDA.Stage.Z2 Number
MDA.Stage.ZTravelOffset Number
MDA.Status.StagePosName String
MDA.Status.StagePosNum Number
MDA.Status.TimePointNum Number
MDA.Status.WaveName String
MDA.Status.WaveNum Number
MDA.Status.ZStepNum Number
MDA.StreamExposure Number
MDA.StreamGain Number
MDA.StreamIntensifierGain Number
Morphometry.OD.HighBoundary Number
Morphometry.OD.LowABoundary Number
Morphometry.StdArea Number
MoveFile.ErrorCode String
PickPoint.Success Number
PickPoint.X Number
PickPoint.Y Number
ScanSlide.BaseName String
ScanSlide.Directory String
ScanSlide.RegionLowerRight.StageX Number
ScanSlide.RegionLowerRight.StageY Number
ScanSlide.RegionUpperLeft.StageX Number
ScanSlide.RegionUpperLeft.StageY Number
ScanSlide.ScanLowerRight.X Number
ScanSlide.ScanLowerRight.Y Number
ScanSlide.ScanUpperLeft.X Number
ScanSlide.ScanUpperLeft.Y Number
ScanSlide.Status.WaveNum String
ScanSlide.Status.XStep Number
ScanSLide.Status.Ystep Number
SelectDirectory.Path String
SelectDirectory.Success Number
SelectRegion.Success Number
SerialData.Success Number
UserName ?????
Executable
???
Yes
Yes
Definition
Frames Per Second value from camera durning live mode
Name of last saved acquired image
Directory path of last saved acquired image
If using save w/ Sequence, this is the next Acquired image name that will be used.
If using save w/ Sequence, this is the directory path that will be used.
New X stage position calculated in the Sample Reload Adjustment using the Single Position option of the Update
Stage Position(s) tab
New Y stage position calculated in the Sample Reload Adjustment using the Single Position option of the Update
Stage Position(s) tab
Current Camera Exposure time that is set in the Acquire dialog
Specific device compontents current position. This list will depend on what hardware is install with the system.
The variables will be listed as Component.(Manufacture Name).(Component Name).
Designates the current shutter state. Value=1 open, Value = 0 closed
Current Bottom position value set in the Focus dialog
Current Position of the active z motor
Current Home position value set in the Focus dialog
Current Top positoin value set in the Focus dialog
Current Illumination setting selected. Changing this will change the selected Illumination setting. Value must
match the names in the Configure Illumination list. If not the setting does not change.
Current Magnigication setting selected. Changing this will change the selected Magnification setting. Value must
match the names in the Configure Magnification list. If not the setting does not change.
Current X stage position
Current Y stage position
The last response value used in the Enter Variable dialog from journal playback.
Records the resopnse to Yes, No or Yes, No Cancel buttion selections from either Enter Variable or Prompt User
durning journal playback.
Legacy variable. In the IMA, the parameter Average Gray Value got change to Average Intensity. This variable is
needed for legacy support of older journals that may be using it. After measuring and logging in the IMA, it has
the same value as IMAObjectData.AverageIntensity variable in the Measurements variables list.
Legacy variable. In the IMA the parameter Total Gray Value got change to Total Intensity. This variable is
needed for legacy support of older journals that may be using it. After measuring and logging in the IMA, it has
the same value as IMAObjectData.TotalIntensity variable in the Measurements variables list.
Records the directory that the last run journal was stored.
Base name in the Saving tab of the MDA
Exposure Time of the current wavelength being acquired in an MDA experiment.
Gain setting of the current wavelength being acquired in an MDA experiment.
Intensifier Gain setting of the current wavelength being acquired in an MDA experiment. Option only available if
camera has an Intensifuer.
Interval value in seconds of the Time Interval setting on the Timelapse tab of the MDA
Number of time points currently configured in the Timelapse tab of the MDA.
The directory path that the experiment will be saved into as chosen with the Select Directory on the Saving tab of
the MDA.
This is the offset postion value for a z motor that has a hardware based autofocus device attached to the scope
from the current stage position being acquired in an MDA experiment.
The current X stage position being acqured in an MDA experiment.
The current Y stage position being acqured in an MDA experiment.
The current Z stage position being acqured in an MDA experiment. Value is used if only one z motor configure or
is the position of the first z motor if dual z motors are being used.
The current Z2 stage position being acqured in an MDA experiment. Value is not used if only one z motor
configure or is the position of the second z motor if dual z motors are being used.
The current Z travel offset configured for the stage position being acqured in an MDA experiment.
Current Stage position name being acquired in an MDA experiment. The stage postion name is configure on the
stage tab of the MDA dialog.
Current Stage position number being acquired in an MDA experiment. Based on the list created on the Stage tab
of the MDA dialog. Value could be monitored and trigger something to happen once a specific Stage postion is
being acquired. i.e. If MDA.Status.StagePosNum = 1 then ... end if. will execute what ever actions are placed
after the then everytime Stage Positon 1 is being acquired.
Current time point number being acquired in an MDA experiment. Value could be monitored and trigger
something to happen once a specific Time Point is being acquired. i.e. If MDA.Status.TimePointNum = 3 then ...
, will execute what ever actions are placed after the then everytime Time Point 3 is being acquired.
Current Wavelength Name being acquired in an MDA experiment. Value could be monitored and trigger
something to happen once a specific Time Point is being acquired. i.e. If MDA.Status.WaveName = "Blue" then
... , will execute what ever actions are placed after the then everytime Wavelength "Blue" is being acquired.
Current Wavelength number being acquired in an MDA experiment. Value could be monitored and trigger
something to happen once a specific Time Point is being acquired. i.e. If MDA.Status.WaveNum = 3 then ... , will
execute what ever actions are placed after the then everytime Wavelength 3 is being acquired.
Current Z position number being acquired in an MDA experiment. Value could be monitored and trigger
something to happen once a specific Time Point is being acquired. i.e. If MDA.Status.ZStepNumNum = 3 then ...
, will execute what ever actions are placed after the then everytime Z positoin 3 is being acquired.
Stream Exposure time being acquired in an MDA experiment, as configured in the Stream tab of the MDA dialog
Stream Gain Setting being acquired in an MDA experiment, as configured in the Stream tab of the MDA dialog
Stream Intensifier Gain setting being acquired in an MDA experiment, as configured in the Stream tab of the MDA
dialog. Option is only available if the camera has an intensifier.
Optical Density High boundary value set in the Preferences tab of the IMA dialog
Optical Density Low boundary value set in the Preferences tab of the IMA dialog
Standard Area value set in the Preferences tab of the IMA dialog
Indicates whether a left mouse click has be done to the active image when usign the Pick Point function in a
journal. Value = 0 click has not happened, Value = 1 click has happened.
X pixel location clicked on the image using the Pick Point function in a journal
Y pixel location clicked on the image using the Pick Point function in a journal
Base File name configured on the Main tab of the Scan Slide dialog. Changing this value will override the current
setting
Directory that current Scan Slide will be saved, configured on the Main tab of the Scan Slide dialog. Changing
this value will override the current setting
X stage position of the Lower Right X location of the active region on the low res tiled image of the corrent scan
or a previously acquired scan.
Y stage position of the Lower Right Y location of the active region on the low res tiled image of the corrent scan
or a previously acquired scan.
X stage position of the Upper Leftt X location of the active region on the low res tiled image of the corrent scan or
a previously acquired scan.
Y stage position of the Upper Right Y location of the active region on the low res tiled image of the corrent scan or
a previously acquired scan.
Lower Right X stage position configured on the Slide Area tab of the Scan Slide dialog.
Lower Right Y stage position configured on the Slide Area tab of the Scan Slide dialog.
Upper Left X stage position configured on the Slide Area Tab fo the Scan Slide dialog.
Upper Left Y stage position configured on the Slide Area Tab fo the Scan Slide dialog.
Current Wavelength number bing acquired in a Scan Slide.
Select Directory function. Displays the path of the selected directory
Select Directory function. 1= Directory selected by user
Select Region function 1= region exists and is selected. 0= not selected.
Wait for serial Data. 0= time out. 1=Serial Data returned.
Variable Group Variable Name Variable Type Read Write
Region Region.ColorBlue Number Yes Yes
Region.ColorGreen Number Yes Yes
Region.ColorRed Number Yes Yes
Region.Height Number Yes Yes
Region.Label String Yes Yes
Region.Left Number Yes Yes
Region.Top Number Yes Yes
Region.Type String Yes No
Region.Width Number Yes Yes
Executable
Yes
Yes
Yes
Yes
Yes
Yes
Yes
No
Yes
Definition
Blue RGB component value of Region Color of active region
Green RGB component value of Region Color of active region
Red RGB component value of Region Color of active region
Distance in the Y direction down from the Region.Top position of active region. Changes to overall size of the region
String value of region label.
Top Left X coordinate position of the active region. Changes the region location
Top Left Y coordinate position of the active region. Changes the region location
Indicates the type of region active. Region Types include: Rectangle, Ellipse, Line, Polyline and Polygon
Distance in the X direction to the right from the Region.Left position of active region. Changes to overall size of the region
ze of the region
all size of the region