Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Micromanager adapter #1

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/developer_documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# how might this work?

```
from microscopegym.micromanager import .... ?
```

long term: installable packages

`pip install microscope-gym-micromanager`

## 1st approach

```python
from microscope_gym_micromanager import microscope_factory
required_components = ['camera', 'stage', 'laser_cutter', 'objectives', 'lasers', 'filters']
my_microscope = microscope_factory(required_components)

```
*then* factory initializes components as below in 2nd approach and returns a Microscope object
components are attributes of microscope object
or...???

## 2nd approach:

```python
from microscope_gym.interface import Objective, Microscope, Axis, Camera, CameraSettings, Stage, microscope_handler_factory
my_handler = microscope_handler_factory()
my_objective = Objective(my_handler)
my_stage = Stage(my_handler)
my...etc
```
if 2nd option, how we initialize the components (Objective, Stage, Camera, etc) becomes part of api init fxn signature becomes part of api
if 1st (microscope factory creates microscope object) then only the microscope is part of public interfacee (and some public methods of components -- objectve, stage, etc).

Loading