Skip to content

Latest commit

 

History

History
98 lines (75 loc) · 3.51 KB

Readme.md

File metadata and controls

98 lines (75 loc) · 3.51 KB

mic.NanoMax Class

Description

The mic.NanoMax class integrates control for the NanoMax stage system, encompassing both piezo elements and stepper motors for precise multi-dimensional positioning. This class allows for seamless integration and control of the stage's complex movements during microscopy experiments.

Features

  • Combined control of piezo and stepper motor stages for fine and coarse positioning.
  • Initialization and centering of all axes upon instantiation.
  • Easy-to-use graphical user interface for real-time control and adjustments.

Requirements

  • mic.abstract.m
  • mic.linearstage.TCubePiezo.m
  • mic.StepperMotor.m
  • MATLAB software version R2016b or later

Installation Notes

Ensure that all required classes (mic.linearstage.TCubePiezo for piezo control and mic.StepperMotor for stepper motor control) are in the MATLAB path. The system should also be connected to the respective hardware components before initializing this class.

Class Properties

Public Properties

  • StartGUI:

  • Description: Flag to control the start of the graphical user interface (GUI).

  • Type: Variable

  • SerialN:

  • Description: Serial number of the SEQ controller for identification. Example serial: 70850323.

  • Type: Variable

  • GuiFigureStage:

  • Description: Handle for the stage's GUI figure.

  • Type: Variable

Protected Properties

  • InstrumentName:

  • Description: The name of the instrument.

  • Type: String

  • Default: 'NanoMax'

  • Stage_Piezo_X:

  • Description: Linear piezo stage object for controlling movement in the X direction.

  • Type: Object

  • Stage_Piezo_Y:

  • Description: Linear piezo stage object for controlling movement in the Y direction.

  • Type: Object

  • Stage_Piezo_Z:

  • Description: Linear piezo stage object for controlling movement in the Z direction.

  • Type: Object

  • Stage_Stepper:

  • Description: Represents the state of the stepper motor stage.

  • Type: Object or State

  • StepperLargeStep:

  • Description: Step size for large movements of the stepper motor in millimeters.

  • Type: Numeric

  • Default: 0.05 mm

  • StepperSmallStep:

  • Description: Step size for small movements of the stepper motor in millimeters.

  • Type: Numeric

  • Default: 0.002 mm

  • PiezoStep:

  • Description: Step size for piezo movements in microns.

  • Type: Numeric

  • Default: 0.1 µm

Key Methods

  • Constructor (mic.NanoMax()): Instantiates the NanoMax system, setting up both the piezo and stepper stages and initializing the GUI.
  • setup_Stage_Piezo(): Configures the piezo stages for X, Y, and Z movement, centers them upon setup.
  • setup_Stage_Stepper(): Initializes and centers the stepper motors.
  • exportState(): Exports the current state of all stages, providing a snapshot of current settings and positions.
  • funcTest(): Tests the functionality of the class methods to ensure correct operation and communication with the hardware.

Usage Example

Instantiate the NanoMax system
nanoStage = mic.NanoMax();

Move the piezo stage in the X direction
nanoStage.Stage_Piezo_X.setPosition(10); % Moves to 10 microns

Adjust the stepper motor in the Y direction
nanoStage.Stage_Stepper.moveToPosition(1, 5); % Moves to 5 mm

Export the current state of the system
state = nanoStage.exportState();
disp(state);

Clean up and close the system
delete(nanoStage);

CITATION: Sandeep Pallikuth, Lidkelab, 2017 & Sajjad Khan, Lidkelab, 2021.