BioLib.Microscope Class Reference

Public Types
enum	Actions {   StageUp , StageRight , StageDown , StageLeft ,   StageFieldUp , StageFieldRight , StageFieldDown , StageFieldLeft ,   FocusUp , FocusDown , TL , RL ,   Acquisition , Locate }

Static Public Member Functions
static void	Initialize ()
static Point3D	GetPosition ()
static void	SetPosition (Point3D p)
static void	SetPosition (PointD p)
static void	OpenRL ()
	If the shutter is closed, open it.
static void	OpenTL ()
	If the shutter is closed, open it.
static void	CloseRL ()
	If the shutter is open, then we close it.
static void	CloseTL ()
	If the shutter is open, then we close it.
static void	SetTL (uint tl)
static void	SetRL (uint tr)
static int	GetTL ()
static int	GetRL ()
static void	MoveUp (double d)
static void	MoveRight (double d)
static void	MoveDown (double d)
static void	MoveLeft (double d)
static void	MoveFieldUp ()
	Move the field up by the height of the current objective.
static void	MoveFieldRight ()
	Move the field right by the width of the view.
static void	MoveFieldDown ()
	Move the field down by the height of the objective.
static void	MoveFieldLeft ()
	Move the field left by the width of the view.
static void	SetFocus (double d)
static double	GetFocus ()

Static Public Attributes
static bool	redraw = false
static Focus	Focus = null
static Stage	Stage = null
static Objectives	Objectives = null
static TLShutter	TLShutter = null
static RLShutter	RLShutter = null
static double	UpperLimit
static double	LowerLimit
static double	fInterVal
static object	CmdSetMode = null
static bool	initialized = false
static bool	ArrowKeysEnabled = true
static Point3D	defaultPos = new Point3D(30000, 30000, 23900)
static Assembly	dll = null
static Dictionary< string, Type >	Types = new Dictionary<string, Type>()
static object	root = null

Member Enumeration Documentation

Actions

enum BioLib.Microscope.Actions

Enumerator
StageUp
StageRight
StageDown
StageLeft
StageFieldUp
StageFieldRight
StageFieldDown
StageFieldLeft
FocusUp
FocusDown
TL
RL
Acquisition
Locate

        {
            StageUp,
            StageRight,
            StageDown,
            StageLeft,
            StageFieldUp,
            StageFieldRight,
            StageFieldDown,
            StageFieldLeft,
            FocusUp,
            FocusDown,
            TL,
            RL,
            Acquisition,
            Locate,
        }

Member Function Documentation

CloseRL()

static void BioLib.Microscope.CloseRL ( )

static

If the shutter is open, then we close it.

        {
            //If shutter is open then we close it.
            if (RLShutter.GetPosition() == 0)
                RLShutter.SetPosition(1);
        }

CloseTL()

static void BioLib.Microscope.CloseTL ( )

static

If the shutter is open, then we close it.

        {
            //If shutter is open then we close it.
            if (TLShutter.GetPosition() == 0)
                TLShutter.SetPosition(1);
        }

GetFocus()

static double BioLib.Microscope.GetFocus ( )

static

It returns the current focus of the camera

Returns

The focus of the camera.

        {
            return Focus.GetFocus();
        }

GetPosition()

static Point3D BioLib.Microscope.GetPosition ( )

static

Get the current position of the stage and the current focus position, and return a Point3D object containing the X, Y, and Z coordinates

Returns

A Point3D object.

        {
            if (Stage == null)
                return new Point3D(0,0,0);
            PointD p = Stage.GetPosition();
            double f = Focus.GetFocus();
            return new Point3D(p.X, p.Y, f);
        }

GetRL()

static int BioLib.Microscope.GetRL ( )

static

It returns the position of the RLShutter object

Returns

The position of the RLShutter.

        {
            return RLShutter.GetPosition();
        }

GetTL()

static int BioLib.Microscope.GetTL ( )

static

GetTL() returns the position of the TLShutter object.

Returns

The position of the shutter.

        {
            return TLShutter.GetPosition();
        }

Initialize()

static void BioLib.Microscope.Initialize ( )

static

It sets the limits of the stage and focus, and then creates new instances of the stage, focus, objectives, and shutters

Returns

The return value is the value of the last expression evaluated in the function.

        {
            if (initialized)
                return;
            Point3D.SetLimits(Stage.minX, Stage.maxX, Stage.minY, Stage.maxY, Focus.lowerLimit, Focus.upperLimit);
            PointD.SetLimits(Stage.minX, Stage.maxX, Stage.minY, Stage.maxY);
            Focus = new Focus();
            Stage = new Stage();
            Objectives = new Objectives();
            TLShutter = new TLShutter();
            RLShutter = new RLShutter();
            initialized = true;
        }

MoveDown()

static void BioLib.Microscope.MoveDown ( double d )

static

Move the stage down by the specified distance

Parameters

d	The distance to move down.

        {
            Stage.MoveDown(d);
        }

MoveFieldDown()

static void BioLib.Microscope.MoveFieldDown ( )

static

Move the field down by the height of the objective.

        {
            Stage.MoveDown(Objectives.GetObjective().ViewHeight);
        }

MoveFieldLeft()

static void BioLib.Microscope.MoveFieldLeft ( )

static

Move the field left by the width of the view.

        {
            Stage.MoveLeft(Objectives.GetObjective().ViewWidth);
        }

MoveFieldRight()

static void BioLib.Microscope.MoveFieldRight ( )

static

Move the field right by the width of the view.

        {
            Stage.MoveRight(Objectives.GetObjective().ViewWidth);
        }

MoveFieldUp()

static void BioLib.Microscope.MoveFieldUp ( )

static

Move the field up by the height of the current objective.

        {
            Stage.MoveUp(Objectives.GetObjective().ViewHeight);
        }

MoveLeft()

static void BioLib.Microscope.MoveLeft ( double d )

static

Move the stage left by the specified distance

Parameters

d	The distance to move the stage in mm.

        {
            Stage.MoveLeft(d);
        }

MoveRight()

static void BioLib.Microscope.MoveRight ( double d )

static

MoveRight(double d) moves the stage right by d

Parameters

d	The distance to move the stage in millimeters.

        {
            Stage.MoveRight(d);
        }

MoveUp()

static void BioLib.Microscope.MoveUp ( double d )

static

Move the stage up by a distance d

Parameters

d	The distance to move the stage up.

        {
            Stage.MoveUp(d);
        }

OpenRL()

static void BioLib.Microscope.OpenRL ( )

static

If the shutter is closed, open it.

        {
            //If shutter is closed we open it.
            if (RLShutter.GetPosition() == 0)
                RLShutter.SetPosition(1);
        }

OpenTL()

static void BioLib.Microscope.OpenTL ( )

static

If the shutter is closed, open it.

        {
            //If shutter is closed we open it.
            if (TLShutter.GetPosition() == 0)
                TLShutter.SetPosition(1);
        }

SetFocus()

static void BioLib.Microscope.SetFocus ( double d )

static

It sets the focus of the camera to the distance specified by the parameter

Parameters

d	The control to focus on.

        {
            Focus.SetFocus(d);
        }

SetPosition() [1/2]

static void BioLib.Microscope.SetPosition ( Point3D p )

static

It sets the position of the stage and focus to the values in the Point3D object

Parameters

Point3D

a class that contains 3 doubles, X, Y, and Z.

        {
            Stage.SetPosition(p.X,p.Y);
            Focus.SetFocus(p.Z);
            Microscope.redraw = true;
        }

SetPosition() [2/2]

static void BioLib.Microscope.SetPosition ( PointD p )

static

The function SetPosition() takes a PointD object as an argument and sets the position of the stage to the X and Y coordinates of the PointD object

Parameters

PointD

        {
            Stage.SetPosition(p.X, p.Y);
            Microscope.redraw = true;
        }

SetRL()

static void BioLib.Microscope.SetRL ( uint tr )

static

The function takes a uint (unsigned integer) as an argument and sets the position of the RLShutter to the value of the argument

Parameters

tr	the position of the shutter

        {
            RLShutter.SetPosition((short)tr);
        }

SetTL()

static void BioLib.Microscope.SetTL ( uint tl )

static

Set the position of the shutter to the value of the variable tl

Parameters

tl	The position of the shutter.

        {
            TLShutter.SetPosition((short)tl);
        }

Member Data Documentation

ArrowKeysEnabled

bool BioLib.Microscope.ArrowKeysEnabled = true

static

CmdSetMode

object BioLib.Microscope.CmdSetMode = null

static

defaultPos

Point3D BioLib.Microscope.defaultPos = new Point3D(30000, 30000, 23900)

static

dll

Assembly BioLib.Microscope.dll = null

static

fInterVal

double BioLib.Microscope.fInterVal

static

Focus

Focus BioLib.Microscope.Focus = null

static

initialized

bool BioLib.Microscope.initialized = false

static

LowerLimit

double BioLib.Microscope.LowerLimit

static

Objectives

Objectives BioLib.Microscope.Objectives = null

static

redraw

bool BioLib.Microscope.redraw = false

static

RLShutter

RLShutter BioLib.Microscope.RLShutter = null

static

root

object BioLib.Microscope.root = null

static

Stage

Stage BioLib.Microscope.Stage = null

static

TLShutter

TLShutter BioLib.Microscope.TLShutter = null

static

Types

Dictionary<string, Type> BioLib.Microscope.Types = new Dictionary<string, Type>()

static

UpperLimit

double BioLib.Microscope.UpperLimit

static

---

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

• BioLib/Source/Microscope.cs