Public Member Functions
	Stage (object st)

void	SetPosition (double px, double py)

void	SetPositionX (double px)

void	SetPositionY (double py)

double	GetPositionX (bool update)

double	GetPositionY (bool update)

PointD	GetPosition (bool update)

void	MoveUp (double m)

void	MoveDown (double m)

void	MoveRight (double m)

void	MoveLeft (double m)

void	UpdateSWLimit ()
	It gets the software limits of the microscope stage.

void	SetSWLimit (double xmin, double xmax, double ymin, double ymax)

Public Attributes
int	moveWait = 250

Static Public Attributes
static double	minX

static double	maxX

static double	minY

static double	maxY

Properties
double	X `[get]`

double	Y `[get]`

Detailed Description

Definition at line 21 of file Microscope.cs.

Constructor & Destructor Documentation

◆ Stage() [1/2]

BioImager.Stage.Stage ( object st )

Definition at line 28 of file Microscope.cs.

        {
            if (Properties.Settings.Default.LibPath.Contains("MTB"))
            {
                PointD d = GetPosition(true);
                x = d.X;
                y = d.Y;
                UpdateSWLimit();
            }
        }

◆ Stage() [2/2]

BioImager.Stage.Stage ( )

Definition at line 38 of file Microscope.cs.

        {
 
        }

Member Function Documentation

◆ GetPosition()

PointD BioImager.Stage.GetPosition ( bool update )

If the microscope is a Prior, get the position from the Prior SDK. If the microscope is a MTB, get the position from the MTB SDK. If the microscope is a Piezosystem, get the position from the Piezosystem SDK

Parameters

update true if the position should be updated from the microscope, false if the position should be returned from the cache.

Returns: A PointD object.

Definition at line 145 of file Microscope.cs.

        {
            if (Properties.Settings.Default.PMicroscope)
            {
                PointD pd;
                Microscope.pMicroscope.GetPosition(out pd,false);
                return pd;
            }
            else
            if (Properties.Settings.Default.PycroManager)
            {
                PointD pd;
                MicroManager.GetPosition(out pd, false);
                return pd;
            }
            else
            if (Properties.Settings.Default.LibPath.Contains("MTB"))
            {
                BioImager.MicroscopeConsole.Command com = BioImager.MicroscopeConsole.RunCommand
                    (new BioImager.MicroscopeConsole.Command(BioImager.MicroscopeConsole.Command.Type.GetStage,null));
                return new PointD(com.doubles[0], com.doubles[1]);
            }
            else if (Properties.Settings.Default.LibPath.Contains("Prio"))
            {
                return Microscope.sdk.GetPosition();
            }
            return new PointD(x, y);
        }

◆ GetPositionX()

double BioImager.Stage.GetPositionX ( bool update )

This function returns the X position of the mouse cursor

Parameters

update If true, the position will be updated before returning the value.

Returns: The position of the object in the X axis.

Definition at line 120 of file Microscope.cs.

        {
            x = GetPosition(update).X;
            return x;
        }

◆ GetPositionY()

double BioImager.Stage.GetPositionY ( bool update )

GetPositionY() returns the Y coordinate of the current position of the mouse cursor

Parameters

update If true, the position will be updated before returning the value.

Returns: The position of the object in the Y axis.

Definition at line 131 of file Microscope.cs.

        {
            y = GetPosition(update).Y;
            return y;
        }

◆ MoveDown()

void BioImager.Stage.MoveDown ( double m )

Move the stage down by the specified amount of microns

Parameters

m	The amount to move the object by.

Definition at line 186 of file Microscope.cs.

        {
            double y = GetPositionY(true) + m;
            SetPositionY(y);
        }

◆ MoveLeft()

void BioImager.Stage.MoveLeft ( double m )

Move the stage left by the specified amount of microns

Parameters

m	The amount to move the object by.

Definition at line 204 of file Microscope.cs.

        {
            double x = GetPositionX(true) - m;
            SetPositionX(x);
        }

◆ MoveRight()

void BioImager.Stage.MoveRight ( double m )

Move the stage right by the specified amount of microns

Parameters

m	The amount to move the object by.

Definition at line 195 of file Microscope.cs.

        {
            double x = GetPositionX(true) + m;
            SetPositionX(x);
        }

◆ MoveUp()

void BioImager.Stage.MoveUp ( double m )

Move the stage up by the specified amount of microns

Parameters

m	The amount of pixels to move the object up by.

Definition at line 177 of file Microscope.cs.

        {
            double y = GetPositionY(true) - m;
            SetPositionY(y);
        }

◆ SetPosition()

void BioImager.Stage.SetPosition	(	double	px,
		double	py )

The function sets the position of the stage to the given coordinates

Parameters

px	x position in microns
py	y-coordinate

Definition at line 69 of file Microscope.cs.

        {
            if (Recorder.recordMicroscope)
                Recorder.AddLine("Microscope.Stage.SetPosition(" + px + "," + py + ");");
            x = px;
            y = py;
            if(Properties.Settings.Default.PMicroscope)
            {
                Microscope.pMicroscope.SetPosition(new PointD(px, py));
            }
            else
            if (Properties.Settings.Default.PycroManager)
            {
                MicroManager.SetPosition(new PointD(px, py));
            }
            else
            if (Properties.Settings.Default.LibPath.Contains("MTB"))
            {
                BioImager.MicroscopeConsole.RunCommand(new BioImager.MicroscopeConsole.Command(BioImager.MicroscopeConsole.Command.Type.SetStage, new double[]{px,py }));
            }
            else if (Properties.Settings.Default.LibPath.Contains("Prio"))
            {
                Microscope.sdk.SetPosition(new PointD(px, py));
            }
            if (App.viewer != null)
                App.viewer.UpdateView(true);
        }

◆ SetPositionX()

void BioImager.Stage.SetPositionX ( double px )

This function sets the position of the object to the given x and y coordinates

Parameters

px	The new x position of the object

Definition at line 100 of file Microscope.cs.

        {
            x = px;
            SetPosition(px, y);
        }

◆ SetPositionY()

void BioImager.Stage.SetPositionY ( double py )

This function sets the position of the object to the given x and y coordinates

Parameters

py	The y position of the object

Definition at line 109 of file Microscope.cs.

        {
            y = py;
            SetPosition(x, py);
        }

◆ SetSWLimit()

void BioImager.Stage.SetSWLimit	(	double	xmin,
		double	xmax,
		double	ymin,
		double	ymax )

It sets the limits of the stage movement

Parameters

xmin	minimum x value
xmax	the maximum x value
ymin	-0.0025
ymax	-0.0015

Definition at line 230 of file Microscope.cs.

        {
            if (Properties.Settings.Default.LibPath.Contains("MTB"))
            {
                BioImager.MicroscopeConsole.RunCommand(
                    new BioImager.MicroscopeConsole.Command(BioImager.MicroscopeConsole.Command.Type.SetStageSWLimit, 
                    new double[] {xmin,xmax,ymin,ymax}));
            }
            if (Recorder.recordMicroscope)
                Recorder.AddLine("Microscope.Focus.SetSWLimit(" + xmin + "," + xmax + "," + ymin + "," + ymax + ");");
        }

◆ UpdateSWLimit()

void BioImager.Stage.UpdateSWLimit ( )

It gets the software limits of the microscope stage.

Definition at line 211 of file Microscope.cs.

        {
            if (Properties.Settings.Default.LibPath.Contains("MTB"))
            {
                BioImager.MicroscopeConsole.Command com = BioImager.MicroscopeConsole.RunCommand(
                    new BioImager.MicroscopeConsole.Command(BioImager.MicroscopeConsole.Command.Type.GetStageSWLimit, null));
                minX = com.doubles[0];
                minY = com.doubles[1];
                maxX = com.doubles[2];
                maxY = com.doubles[3];
            }
        }

Member Data Documentation

◆ maxX

double BioImager.Stage.maxX

static

Definition at line 24 of file Microscope.cs.

◆ maxY

double BioImager.Stage.maxY

static

Definition at line 26 of file Microscope.cs.

◆ minX

double BioImager.Stage.minX

static

Definition at line 23 of file Microscope.cs.

◆ minY

double BioImager.Stage.minY

static

Definition at line 25 of file Microscope.cs.

◆ moveWait

int BioImager.Stage.moveWait = 250

Definition at line 59 of file Microscope.cs.

Property Documentation

◆ X

double BioImager.Stage.X

get

Definition at line 45 of file Microscope.cs.

◆ Y

double BioImager.Stage.Y

get

Definition at line 52 of file Microscope.cs.

The documentation for this class was generated from the following file:

BioImager/Source/Microscope.cs

Public Member Functions

Public Attributes

Static Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Stage() [1/2]

◆ Stage() [2/2]

Member Function Documentation

◆ GetPosition()

◆ GetPositionX()

◆ GetPositionY()

◆ MoveDown()

◆ MoveLeft()

◆ MoveRight()

◆ MoveUp()

◆ SetPosition()

◆ SetPositionX()

◆ SetPositionY()

◆ SetSWLimit()

◆ UpdateSWLimit()

Member Data Documentation

◆ maxX

◆ maxY

◆ minX

◆ minY

◆ moveWait

Property Documentation

◆ X

◆ Y