BioCore.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 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 current 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

Detailed Description

Definition at line 302 of file Microscope.cs.

Member Enumeration Documentation

Actions

enum BioCore.Microscope.Actions

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

Definition at line 304 of file Microscope.cs.

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

Member Function Documentation

CloseRL()

static void BioCore.Microscope.CloseRL ( )

static

If the shutter is open, then close it.

Definition at line 403 of file Microscope.cs.

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

CloseTL()

static void BioCore.Microscope.CloseTL ( )

static

If the shutter is open, then we close it.

Definition at line 411 of file Microscope.cs.

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

GetFocus()

static double BioCore.Microscope.GetFocus ( )

static

It returns the current focus of the camera

Returns

The focus of the camera.

Definition at line 516 of file Microscope.cs.

        {
            return Focus.GetFocus();
        }

GetPosition()

static Point3D BioCore.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.

Definition at line 356 of file Microscope.cs.

        {
            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 BioCore.Microscope.GetRL ( )

static

It returns the position of the RLShutter object

Returns

The position of the RLShutter.

Definition at line 445 of file Microscope.cs.

        {
            return RLShutter.GetPosition();
        }

GetTL()

static int BioCore.Microscope.GetTL ( )

static

This function returns the position of the TL shutter

Returns

The position of the shutter.

Definition at line 437 of file Microscope.cs.

        {
            return TLShutter.GetPosition();
        }

Initialize()

static void BioCore.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.

Definition at line 339 of file Microscope.cs.

        {
            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 BioCore.Microscope.MoveDown ( double d )

static

Move the stage down by the specified amount

Parameters

d	The distance to move the stage down.

Definition at line 469 of file Microscope.cs.

        {
            Stage.MoveDown(d);
        }

MoveFieldDown()

static void BioCore.Microscope.MoveFieldDown ( )

static

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

Definition at line 494 of file Microscope.cs.

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

MoveFieldLeft()

static void BioCore.Microscope.MoveFieldLeft ( )

static

Move the field left by the width of the view.

Definition at line 500 of file Microscope.cs.

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

MoveFieldRight()

static void BioCore.Microscope.MoveFieldRight ( )

static

Move the field right by the width of the view.

Definition at line 488 of file Microscope.cs.

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

MoveFieldUp()

static void BioCore.Microscope.MoveFieldUp ( )

static

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

Definition at line 482 of file Microscope.cs.

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

MoveLeft()

static void BioCore.Microscope.MoveLeft ( double d )

static

Move the stage left by the specified distance

Parameters

d	The distance to move the stage in mm.

Definition at line 477 of file Microscope.cs.

        {
            Stage.MoveLeft(d);
        }

MoveRight()

static void BioCore.Microscope.MoveRight ( double d )

static

MoveRight(double d) moves the stage right by d

Parameters

d	The distance to move the stage in millimeters.

Definition at line 461 of file Microscope.cs.

        {
            Stage.MoveRight(d);
        }

MoveUp()

static void BioCore.Microscope.MoveUp ( double d )

static

Move the stage up by a distance d

Parameters

d	The distance to move the stage up.

Definition at line 453 of file Microscope.cs.

        {
            Stage.MoveUp(d);
        }

OpenRL()

static void BioCore.Microscope.OpenRL ( )

static

If the shutter is closed, open it.

Definition at line 387 of file Microscope.cs.

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

OpenTL()

static void BioCore.Microscope.OpenTL ( )

static

If the shutter is closed, open it.

Definition at line 395 of file Microscope.cs.

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

SetFocus()

static void BioCore.Microscope.SetFocus ( double d )

static

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

Parameters

d	The distance to focus on.

Definition at line 508 of file Microscope.cs.

        {
            Focus.SetFocus(d);
        }

SetPosition() [1/2]

static void BioCore.Microscope.SetPosition ( Point3D p )

static

Set the position of the stage and focus to the values in the Point3D object

Parameters

Point3D

A class that contains 3D coordinates.

Definition at line 368 of file Microscope.cs.

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

SetPosition() [2/2]

static void BioCore.Microscope.SetPosition ( PointD p )

static

The function SetPosition() is a public static function that takes a PointD object as an argument. The function then calls the SetPosition() function of the Stage class, passing the X and Y coordinates of the PointD object as arguments. The function then sets the redraw variable of the Microscope class to true

Parameters

PointD

Definition at line 381 of file Microscope.cs.

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

SetRL()

static void BioCore.Microscope.SetRL ( uint tr )

static

This function sets the position of the RLShutter to the value of tr

Parameters

tr	the position of the shutter

Definition at line 429 of file Microscope.cs.

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

SetTL()

static void BioCore.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.

Definition at line 421 of file Microscope.cs.

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

Member Data Documentation

ArrowKeysEnabled

bool BioCore.Microscope.ArrowKeysEnabled = true

static

Definition at line 330 of file Microscope.cs.

CmdSetMode

object BioCore.Microscope.CmdSetMode = null

static

Definition at line 328 of file Microscope.cs.

defaultPos

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

static

Definition at line 331 of file Microscope.cs.

dll

Assembly BioCore.Microscope.dll = null

static

Definition at line 332 of file Microscope.cs.

fInterVal

double BioCore.Microscope.fInterVal

static

Definition at line 327 of file Microscope.cs.

Focus

Focus BioCore.Microscope.Focus = null

static

Definition at line 322 of file Microscope.cs.

initialized

bool BioCore.Microscope.initialized = false

static

Definition at line 329 of file Microscope.cs.

LowerLimit

double BioCore.Microscope.LowerLimit

static

Definition at line 327 of file Microscope.cs.

Objectives

Objectives BioCore.Microscope.Objectives = null

static

Definition at line 324 of file Microscope.cs.

redraw

bool BioCore.Microscope.redraw = false

static

Definition at line 321 of file Microscope.cs.

RLShutter

RLShutter BioCore.Microscope.RLShutter = null

static

Definition at line 326 of file Microscope.cs.

root

object BioCore.Microscope.root = null

static

Definition at line 334 of file Microscope.cs.

Stage

Stage BioCore.Microscope.Stage = null

static

Definition at line 323 of file Microscope.cs.

TLShutter

TLShutter BioCore.Microscope.TLShutter = null

static

Definition at line 325 of file Microscope.cs.

Types

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

static

Definition at line 333 of file Microscope.cs.

UpperLimit

double BioCore.Microscope.UpperLimit

static

Definition at line 327 of file Microscope.cs.

---

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

• BioCore/BioCore/Source/Microscope.cs