pyobs-flipro 2.0.0.dev4__tar.gz → 2.0.0.dev6__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pyobs_flipro-2.0.0.dev6/.readthedocs.yml +18 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/PKG-INFO +2 -2
- pyobs_flipro-2.0.0.dev6/README.md +61 -0
- pyobs_flipro-2.0.0.dev6/docs/Makefile +31 -0
- pyobs_flipro-2.0.0.dev6/docs/make.bat +36 -0
- pyobs_flipro-2.0.0.dev6/docs/requirements.txt +1 -0
- pyobs_flipro-2.0.0.dev6/docs/source/_static/pyobs.gif +0 -0
- pyobs_flipro-2.0.0.dev6/docs/source/conf.py +117 -0
- pyobs_flipro-2.0.0.dev6/docs/source/index.rst +50 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/pyobs_flipro/fliprocamera.py +177 -64
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/pyproject.toml +2 -4
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/uv.lock +379 -171
- pyobs_flipro-2.0.0.dev4/.readthedocs.yml +0 -14
- pyobs_flipro-2.0.0.dev4/README.md +0 -30
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/.github/workflows/pypi.yml +0 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/.github/workflows/ruff.yml +0 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/.pre-commit-config.yaml +0 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/CMakeLists.txt +0 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/LICENSE +0 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/lib/libflipro.h +0 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/lib/liblibflialgo.so +0 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/lib/liblibflipro.so +0 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/poetry.lock +0 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/pyobs_flipro/__init__.py +0 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/pyobs_flipro/fliprodriver.pyx +0 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/pyobs_flipro/gui.py +0 -0
- {pyobs_flipro-2.0.0.dev4 → pyobs_flipro-2.0.0.dev6}/pyobs_flipro/libflipro.pxd +0 -0
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
version: 2
|
|
2
|
+
|
|
3
|
+
build:
|
|
4
|
+
os: ubuntu-24.04
|
|
5
|
+
tools:
|
|
6
|
+
python: "3.11"
|
|
7
|
+
apt_packages:
|
|
8
|
+
- libcfitsio-dev
|
|
9
|
+
- libusb-1.0-0-dev
|
|
10
|
+
|
|
11
|
+
sphinx:
|
|
12
|
+
configuration: docs/source/conf.py
|
|
13
|
+
|
|
14
|
+
python:
|
|
15
|
+
install:
|
|
16
|
+
- method: pip
|
|
17
|
+
path: .
|
|
18
|
+
- requirements: docs/requirements.txt
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: pyobs-flipro
|
|
3
|
-
Version: 2.0.0.
|
|
3
|
+
Version: 2.0.0.dev6
|
|
4
4
|
Summary: pyobs module for FLIPRO cameras
|
|
5
5
|
Author-Email: Tim-Oliver Husser <thusser@uni-goettingen.de>
|
|
6
6
|
License-Expression: MIT
|
|
@@ -9,6 +9,6 @@ Requires-Dist: astropy<8,>=7.0.1
|
|
|
9
9
|
Requires-Dist: numpy<3,>=2.2.5
|
|
10
10
|
Requires-Dist: pyobs-core<3,>=2.0.0.dev6
|
|
11
11
|
Provides-Extra: gui
|
|
12
|
-
Requires-Dist:
|
|
12
|
+
Requires-Dist: pyobs-core[gui]<3,>=2.0.0.dev6; extra == "gui"
|
|
13
13
|
Requires-Dist: qasync>=0.27; extra == "gui"
|
|
14
14
|
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
FLIPRO module for *pyobs*
|
|
2
|
+
=========================
|
|
3
|
+
|
|
4
|
+
This is a [pyobs](https://www.pyobs.org) module for FLI PRO cameras.
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
System dependencies
|
|
8
|
+
--------------------
|
|
9
|
+
On Debian/Ubuntu:
|
|
10
|
+
|
|
11
|
+
sudo apt-get install libcfitsio-dev libusb-1.0-0-dev
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
Install *pyobs-flipro*
|
|
15
|
+
------------------------
|
|
16
|
+
Clone the repository:
|
|
17
|
+
|
|
18
|
+
git clone https://github.com/pyobs/pyobs-flipro.git
|
|
19
|
+
cd pyobs-flipro
|
|
20
|
+
|
|
21
|
+
Install it with [uv](https://docs.astral.sh/uv/):
|
|
22
|
+
|
|
23
|
+
uv sync
|
|
24
|
+
|
|
25
|
+
Alternatively, with plain `venv`/`pip`:
|
|
26
|
+
|
|
27
|
+
python3 -m venv .venv
|
|
28
|
+
source .venv/bin/activate
|
|
29
|
+
pip install .
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
Configuration
|
|
33
|
+
-------------
|
|
34
|
+
The *FliProCamera* class is derived from *BaseCamera* (see *pyobs* documentation) and adds a single new parameter:
|
|
35
|
+
|
|
36
|
+
setpoint:
|
|
37
|
+
The cooling temperature setpoint in degrees Celsius.
|
|
38
|
+
|
|
39
|
+
A basic module configuration would look like this:
|
|
40
|
+
|
|
41
|
+
class: pyobs_flipro.FliProCamera
|
|
42
|
+
name: FLIPRO camera
|
|
43
|
+
setpoint: -20.0
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
GUI
|
|
47
|
+
---
|
|
48
|
+
For testing a camera without a full *pyobs* setup, install the optional `gui` extra:
|
|
49
|
+
|
|
50
|
+
uv sync --extra gui
|
|
51
|
+
|
|
52
|
+
and run:
|
|
53
|
+
|
|
54
|
+
uv run flipro-gui
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
Dependencies
|
|
58
|
+
------------
|
|
59
|
+
* [pyobs-core](https://github.com/pyobs/pyobs-core) for the core functionality.
|
|
60
|
+
* [Astropy](http://www.astropy.org/) for FITS file handling.
|
|
61
|
+
* [NumPy](http://www.numpy.org/) for array handling.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Minimal makefile for Sphinx documentation
|
|
2
|
+
#
|
|
3
|
+
|
|
4
|
+
# You can set these variables from the command line.
|
|
5
|
+
SPHINXOPTS =
|
|
6
|
+
SPHINXBUILD = sphinx-build
|
|
7
|
+
SPHINXPROJ = pyobs
|
|
8
|
+
SOURCEDIR = source
|
|
9
|
+
BUILDDIR = ../.doc-build
|
|
10
|
+
|
|
11
|
+
#.EXPORT_ALL_VARIABLES:
|
|
12
|
+
|
|
13
|
+
#PYTHONPATH:=../pyobs-core/:../pyobs-sbig/:../pyobs-fli:../pyobs-weather:../pyobs-archive:${PYTHONPATH}
|
|
14
|
+
|
|
15
|
+
# Put it first so that "make" without argument is like "make help".
|
|
16
|
+
help:
|
|
17
|
+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
18
|
+
|
|
19
|
+
.PHONY: help Makefile
|
|
20
|
+
|
|
21
|
+
html:
|
|
22
|
+
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
|
|
23
|
+
|
|
24
|
+
livehtml:
|
|
25
|
+
sphinx-autobuild -b html --watch ../pyobs_flipro $(ALLSPHINXOPTS) "$(SOURCEDIR)/" "$(BUILDDIR)/html/"
|
|
26
|
+
|
|
27
|
+
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
28
|
+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
29
|
+
%: Makefile
|
|
30
|
+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
31
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
@ECHO OFF
|
|
2
|
+
|
|
3
|
+
pushd %~dp0
|
|
4
|
+
|
|
5
|
+
REM Command file for Sphinx documentation
|
|
6
|
+
|
|
7
|
+
if "%SPHINXBUILD%" == "" (
|
|
8
|
+
set SPHINXBUILD=sphinx-build
|
|
9
|
+
)
|
|
10
|
+
set SOURCEDIR=source
|
|
11
|
+
set BUILDDIR=build
|
|
12
|
+
set SPHINXPROJ=pyobs
|
|
13
|
+
|
|
14
|
+
if "%1" == "" goto help
|
|
15
|
+
|
|
16
|
+
%SPHINXBUILD% >NUL 2>NUL
|
|
17
|
+
if errorlevel 9009 (
|
|
18
|
+
echo.
|
|
19
|
+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
|
20
|
+
echo.installed, then set the SPHINXBUILD environment variable to point
|
|
21
|
+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
|
22
|
+
echo.may add the Sphinx directory to PATH.
|
|
23
|
+
echo.
|
|
24
|
+
echo.If you don't have Sphinx installed, grab it from
|
|
25
|
+
echo.http://sphinx-doc.org/
|
|
26
|
+
exit /b 1
|
|
27
|
+
)
|
|
28
|
+
|
|
29
|
+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
|
30
|
+
goto end
|
|
31
|
+
|
|
32
|
+
:help
|
|
33
|
+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
|
34
|
+
|
|
35
|
+
:end
|
|
36
|
+
popd
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
sphinx-rtd-theme
|
|
Binary file
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# Configuration file for the Sphinx documentation builder.
|
|
2
|
+
#
|
|
3
|
+
# This file does only contain a selection of the most common options. For a
|
|
4
|
+
# full list see the documentation:
|
|
5
|
+
# http://www.sphinx-doc.org/en/stable/config
|
|
6
|
+
|
|
7
|
+
# -- Path setup --------------------------------------------------------------
|
|
8
|
+
|
|
9
|
+
# If extensions (or modules to document with autodoc) are in another directory,
|
|
10
|
+
# add these directories to sys.path here. If the directory is relative to the
|
|
11
|
+
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
12
|
+
#
|
|
13
|
+
import os
|
|
14
|
+
import sys
|
|
15
|
+
|
|
16
|
+
sys.path.insert(0, os.path.abspath("../../"))
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
# -- Project information -----------------------------------------------------
|
|
20
|
+
|
|
21
|
+
project = "pyobs-flipro"
|
|
22
|
+
copyright = "2024, Tim-Oliver Husser"
|
|
23
|
+
author = "Tim-Oliver Husser"
|
|
24
|
+
|
|
25
|
+
# The short X.Y version
|
|
26
|
+
# version = "0.16"
|
|
27
|
+
# The full version, including alpha/beta/rc tags
|
|
28
|
+
# release = "0.16.0"
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
# -- General configuration ---------------------------------------------------
|
|
32
|
+
|
|
33
|
+
add_module_names = False
|
|
34
|
+
|
|
35
|
+
# If your documentation needs a minimal Sphinx version, state it here.
|
|
36
|
+
#
|
|
37
|
+
# needs_sphinx = '1.0'
|
|
38
|
+
|
|
39
|
+
# Add any Sphinx extension module names here, as strings. They can be
|
|
40
|
+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
41
|
+
# ones.
|
|
42
|
+
extensions = [
|
|
43
|
+
"sphinx.ext.autodoc",
|
|
44
|
+
"sphinx.ext.githubpages",
|
|
45
|
+
"sphinx.ext.napoleon",
|
|
46
|
+
"sphinx.ext.viewcode",
|
|
47
|
+
"sphinx.ext.autosectionlabel",
|
|
48
|
+
"sphinx.ext.intersphinx",
|
|
49
|
+
#'sphinx_autodoc_typehints'
|
|
50
|
+
]
|
|
51
|
+
|
|
52
|
+
intersphinx_mapping = {"http://docs.python.org/3": None}
|
|
53
|
+
|
|
54
|
+
# napoleon settings
|
|
55
|
+
napoleon_google_docstring = True
|
|
56
|
+
napoleon_numpy_docstring = False
|
|
57
|
+
napoleon_use_param = False
|
|
58
|
+
napoleon_use_ivar = True
|
|
59
|
+
|
|
60
|
+
# typehints
|
|
61
|
+
# set_type_checking_flag = True
|
|
62
|
+
# autodoc_typehints = "description"
|
|
63
|
+
|
|
64
|
+
# show c'tor parameters in class only
|
|
65
|
+
autoclass_content = "both"
|
|
66
|
+
|
|
67
|
+
# Add any paths that contain templates here, relative to this directory.
|
|
68
|
+
templates_path = ["_templates"]
|
|
69
|
+
|
|
70
|
+
# The suffix(es) of source filenames.
|
|
71
|
+
# You can specify multiple suffix as a list of string:
|
|
72
|
+
#
|
|
73
|
+
source_suffix = ".rst"
|
|
74
|
+
|
|
75
|
+
# The master toctree document.
|
|
76
|
+
master_doc = "index"
|
|
77
|
+
|
|
78
|
+
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
79
|
+
# for a list of supported languages.
|
|
80
|
+
#
|
|
81
|
+
# This is also used if you do content translation via gettext catalogs.
|
|
82
|
+
# Usually you set "language" from the command line for these cases.
|
|
83
|
+
language = "en"
|
|
84
|
+
|
|
85
|
+
# List of patterns, relative to source directory, that match files and
|
|
86
|
+
# directories to ignore when looking for source files.
|
|
87
|
+
# This pattern also affects html_static_path and html_extra_path .
|
|
88
|
+
exclude_patterns = []
|
|
89
|
+
|
|
90
|
+
# The name of the Pygments (syntax highlighting) style to use.
|
|
91
|
+
pygments_style = "sphinx"
|
|
92
|
+
|
|
93
|
+
# Be a little nitpicky
|
|
94
|
+
nitpicky = True
|
|
95
|
+
nitpick_ignore = []
|
|
96
|
+
|
|
97
|
+
# intersphinx
|
|
98
|
+
intersphinx_mapping = {
|
|
99
|
+
"pyobs": ("https://pyobs-core.readthedocs.io/en/latest/", None),
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
# -- Options for HTML output -------------------------------------------------
|
|
103
|
+
|
|
104
|
+
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
105
|
+
# a list of builtin themes.
|
|
106
|
+
html_theme = "sphinx_rtd_theme"
|
|
107
|
+
html_theme_options = {
|
|
108
|
+
"collapse_navigation": False,
|
|
109
|
+
"sticky_navigation": True,
|
|
110
|
+
"navigation_depth": 4,
|
|
111
|
+
"display_version": False,
|
|
112
|
+
"logo_only": False,
|
|
113
|
+
"prev_next_buttons_location": "bottom",
|
|
114
|
+
"titles_only": False,
|
|
115
|
+
"style_nav_header_background": "#cccccc",
|
|
116
|
+
}
|
|
117
|
+
html_logo = "_static/pyobs.gif"
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
pyobs-flipro
|
|
2
|
+
############
|
|
3
|
+
|
|
4
|
+
This is a `pyobs <https://www.pyobs.org>`_ (`documentation <https://docs.pyobs.org>`_) module for FLI PRO cameras.
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
Example configuration
|
|
8
|
+
*********************
|
|
9
|
+
|
|
10
|
+
This is an example configuration::
|
|
11
|
+
|
|
12
|
+
class: pyobs_flipro.FliProCamera
|
|
13
|
+
|
|
14
|
+
# filename pattern
|
|
15
|
+
filenames: /cache/pyobs-{DAY-OBS|date:}-{FRAMENUM|string:04d}-{IMAGETYP|type}00.fits
|
|
16
|
+
|
|
17
|
+
# cooling
|
|
18
|
+
setpoint: -20.0
|
|
19
|
+
|
|
20
|
+
# location
|
|
21
|
+
timezone: utc
|
|
22
|
+
location:
|
|
23
|
+
longitude: 9.944333
|
|
24
|
+
latitude: 51.560583
|
|
25
|
+
elevation: 201.
|
|
26
|
+
|
|
27
|
+
# communication
|
|
28
|
+
comm:
|
|
29
|
+
jid: test@example.com
|
|
30
|
+
password: ***
|
|
31
|
+
|
|
32
|
+
# virtual file system
|
|
33
|
+
vfs:
|
|
34
|
+
class: pyobs.vfs.VirtualFileSystem
|
|
35
|
+
roots:
|
|
36
|
+
cache:
|
|
37
|
+
class: pyobs.vfs.HttpFile
|
|
38
|
+
upload: http://localhost:37075/
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
Available classes
|
|
42
|
+
*****************
|
|
43
|
+
|
|
44
|
+
There is one single class for FLI PRO cameras.
|
|
45
|
+
|
|
46
|
+
FliProCamera
|
|
47
|
+
============
|
|
48
|
+
.. autoclass:: pyobs_flipro.FliProCamera
|
|
49
|
+
:members:
|
|
50
|
+
:show-inheritance:
|
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
import asyncio
|
|
2
2
|
import logging
|
|
3
3
|
import math
|
|
4
|
+
import threading
|
|
5
|
+
import time
|
|
6
|
+
from collections.abc import Callable
|
|
4
7
|
from datetime import UTC, datetime
|
|
5
|
-
from typing import Any
|
|
8
|
+
from typing import Any, TypeVar, cast
|
|
6
9
|
|
|
7
10
|
import numpy as np
|
|
8
11
|
from pyobs.images import Image
|
|
@@ -16,6 +19,20 @@ from pyobs.utils.enums import ExposureStatus
|
|
|
16
19
|
|
|
17
20
|
log = logging.getLogger(__name__)
|
|
18
21
|
|
|
22
|
+
_T = TypeVar("_T")
|
|
23
|
+
|
|
24
|
+
# FLIPRO SDK calls are blocking and are made directly on the event loop thread (see
|
|
25
|
+
# _run_blocking). If the camera has gone unresponsive, they can hang indefinitely, so they're
|
|
26
|
+
# bounded with a timeout rather than let a single dead camera freeze the whole module.
|
|
27
|
+
_SDK_CALL_TIMEOUT = 5.0
|
|
28
|
+
|
|
29
|
+
# reading out a frame after exposure can take longer than the other SDK calls above.
|
|
30
|
+
_READOUT_TIMEOUT = 30.0
|
|
31
|
+
|
|
32
|
+
# the exposure-wait loop's own timeout needs to cover the actual exposure time plus some margin
|
|
33
|
+
# for overhead -- exposure_time alone would be too tight.
|
|
34
|
+
_EXPOSURE_WAIT_MARGIN = 30.0
|
|
35
|
+
|
|
19
36
|
|
|
20
37
|
class FliProCamera(BaseCamera, ICamera, IAbortable, IWindow, IBinning, ICooling, ITemperatures):
|
|
21
38
|
"""A pyobs module for FLIPRO cameras."""
|
|
@@ -48,40 +65,96 @@ class FliProCamera(BaseCamera, ICamera, IAbortable, IWindow, IBinning, ICooling,
|
|
|
48
65
|
# background task for polling cooling/temperature
|
|
49
66
|
self.add_background_task(self._poll_cooling)
|
|
50
67
|
|
|
68
|
+
@staticmethod
|
|
69
|
+
async def _run_blocking(func: Callable[[], None], timeout: float = _SDK_CALL_TIMEOUT) -> bool:
|
|
70
|
+
"""Run a blocking FLIPRO SDK call in a daemon thread, so a hung call can't freeze the module.
|
|
71
|
+
|
|
72
|
+
A plain executor isn't used here, since its worker threads are non-daemon and Python joins
|
|
73
|
+
them on interpreter shutdown -- a hung call would then just move the freeze to process exit.
|
|
74
|
+
|
|
75
|
+
Returns:
|
|
76
|
+
True if func completed within timeout, False if it's still running in the background.
|
|
77
|
+
"""
|
|
78
|
+
loop = asyncio.get_running_loop()
|
|
79
|
+
future: asyncio.Future[None] = loop.create_future()
|
|
80
|
+
|
|
81
|
+
def _wrapper() -> None:
|
|
82
|
+
try:
|
|
83
|
+
func()
|
|
84
|
+
finally:
|
|
85
|
+
loop.call_soon_threadsafe(future.set_result, None)
|
|
86
|
+
|
|
87
|
+
threading.Thread(target=_wrapper, daemon=True).start()
|
|
88
|
+
try:
|
|
89
|
+
await asyncio.wait_for(future, timeout=timeout)
|
|
90
|
+
return True
|
|
91
|
+
except TimeoutError:
|
|
92
|
+
return False
|
|
93
|
+
|
|
94
|
+
async def _run_blocking_or_raise(self, func: Callable[[], _T], timeout: float = _SDK_CALL_TIMEOUT) -> _T:
|
|
95
|
+
"""Run a blocking FLIPRO SDK call in a thread, returning its result or re-raising what it raised.
|
|
96
|
+
|
|
97
|
+
Unlike _run_blocking(), this also carries the callable's return value/exception back to the
|
|
98
|
+
caller -- several FLIPRO calls here drive control flow via their return value or a raised
|
|
99
|
+
ValueError (e.g. device lookup, exposure availability), which a bare fire-and-forget thread
|
|
100
|
+
call would otherwise silently lose.
|
|
101
|
+
"""
|
|
102
|
+
outcome: list[Any] = []
|
|
103
|
+
|
|
104
|
+
def _wrapper() -> None:
|
|
105
|
+
try:
|
|
106
|
+
outcome.append(func())
|
|
107
|
+
except BaseException as e:
|
|
108
|
+
outcome.append(e)
|
|
109
|
+
|
|
110
|
+
if not await self._run_blocking(_wrapper, timeout=timeout):
|
|
111
|
+
raise TimeoutError(f"Timed out waiting for FLIPRO SDK call after {timeout}s.")
|
|
112
|
+
value = outcome[0]
|
|
113
|
+
if isinstance(value, BaseException):
|
|
114
|
+
raise value
|
|
115
|
+
return cast(_T, value)
|
|
116
|
+
|
|
51
117
|
async def open(self) -> None:
|
|
52
118
|
"""Open module."""
|
|
53
119
|
await BaseCamera.open(self)
|
|
54
120
|
from .fliprodriver import FliProDriver
|
|
55
121
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
122
|
+
def _connect() -> None:
|
|
123
|
+
# list devices
|
|
124
|
+
devices = FliProDriver.list_devices()
|
|
125
|
+
if len(devices) == 0:
|
|
126
|
+
raise ValueError("No camera found.")
|
|
127
|
+
|
|
128
|
+
# open first one
|
|
129
|
+
self._device = devices[0]
|
|
130
|
+
self._log_device_info()
|
|
131
|
+
log.info('Opening connection to "%s"...', self._device.friendly_name)
|
|
132
|
+
self._driver = FliProDriver(self._device)
|
|
133
|
+
try:
|
|
134
|
+
self._driver.open()
|
|
135
|
+
except ValueError as e:
|
|
136
|
+
raise ValueError(f"Could not open FLIPRO camera: {e}")
|
|
60
137
|
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
log.info('Opening connection to "%s"...', self._device.friendly_name)
|
|
65
|
-
self._driver = FliProDriver(self._device)
|
|
66
|
-
try:
|
|
67
|
-
self._driver.open()
|
|
68
|
-
except ValueError as e:
|
|
69
|
-
raise ValueError(f"Could not open FLIPRO camera: {e}")
|
|
138
|
+
# get caps
|
|
139
|
+
self._caps = self._driver.get_capabilities()
|
|
140
|
+
self._log_capabilities()
|
|
70
141
|
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
self._log_capabilities()
|
|
142
|
+
# store full frame from caps
|
|
143
|
+
self._full_frame = (0, 0, self._caps.uiMaxPixelImageWidth, self._caps.uiMaxPixelImageHeight)
|
|
74
144
|
|
|
75
|
-
|
|
76
|
-
self._full_frame = (0, 0, self._caps.uiMaxPixelImageWidth, self._caps.uiMaxPixelImageHeight)
|
|
145
|
+
await self._run_blocking_or_raise(_connect)
|
|
77
146
|
|
|
78
147
|
# set cooling
|
|
79
148
|
if self._temp_setpoint is not None:
|
|
80
149
|
await self.set_cooling(True, self._temp_setpoint)
|
|
81
150
|
|
|
82
151
|
# get window and binning from driver
|
|
83
|
-
|
|
84
|
-
|
|
152
|
+
def _get_window_binning() -> None:
|
|
153
|
+
assert self._driver is not None
|
|
154
|
+
self._window = self._driver.get_image_area()
|
|
155
|
+
self._binning = self._driver.get_binning()
|
|
156
|
+
|
|
157
|
+
await self._run_blocking_or_raise(_get_window_binning)
|
|
85
158
|
|
|
86
159
|
# publish capabilities and initial states
|
|
87
160
|
await self.comm.set_capabilities(
|
|
@@ -114,8 +187,10 @@ class FliProCamera(BaseCamera, ICamera, IAbortable, IWindow, IBinning, ICooling,
|
|
|
114
187
|
await BaseCamera.close(self)
|
|
115
188
|
|
|
116
189
|
if self._driver is not None:
|
|
117
|
-
self._driver
|
|
190
|
+
driver = self._driver
|
|
118
191
|
self._driver = None
|
|
192
|
+
if not await self._run_blocking(driver.close):
|
|
193
|
+
log.error("Timed out closing FLIPRO camera after %.1fs.", _SDK_CALL_TIMEOUT)
|
|
119
194
|
|
|
120
195
|
def _log_device_info(self) -> None:
|
|
121
196
|
log.info("Device info:")
|
|
@@ -166,30 +241,36 @@ class FliProCamera(BaseCamera, ICamera, IAbortable, IWindow, IBinning, ICooling,
|
|
|
166
241
|
# check driver
|
|
167
242
|
if self._driver is None:
|
|
168
243
|
raise ValueError("No camera driver.")
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
244
|
+
driver = self._driver
|
|
245
|
+
|
|
246
|
+
def _start() -> int:
|
|
247
|
+
# set binning
|
|
248
|
+
log.info("Set binning to %dx%d.", self._binning[0], self._binning[1])
|
|
249
|
+
driver.set_binning(*self._binning)
|
|
250
|
+
|
|
251
|
+
# set window, size is given in unbinned pixels
|
|
252
|
+
width = int(math.floor(self._window[2]) / self._binning[0])
|
|
253
|
+
height = int(math.floor(self._window[3]) / self._binning[1])
|
|
254
|
+
log.info(
|
|
255
|
+
"Set window to %dx%d (binned %dx%d) at %d,%d.",
|
|
256
|
+
self._window[2],
|
|
257
|
+
self._window[3],
|
|
258
|
+
width,
|
|
259
|
+
height,
|
|
260
|
+
self._window[0],
|
|
261
|
+
self._window[1],
|
|
262
|
+
)
|
|
263
|
+
driver.set_image_area(self._window[0], self._window[1], self._window[2], self._window[3])
|
|
264
|
+
|
|
265
|
+
# set exposure time
|
|
266
|
+
driver.set_exposure_time(int(exposure_time * 1e9))
|
|
267
|
+
|
|
268
|
+
# calculate frame size
|
|
269
|
+
frame_size = driver.get_frame_size()
|
|
270
|
+
|
|
271
|
+
# start exposure
|
|
272
|
+
driver.start_exposure()
|
|
273
|
+
return frame_size
|
|
193
274
|
|
|
194
275
|
# get date obs
|
|
195
276
|
log.info(
|
|
@@ -197,8 +278,7 @@ class FliProCamera(BaseCamera, ICamera, IAbortable, IWindow, IBinning, ICooling,
|
|
|
197
278
|
)
|
|
198
279
|
date_obs = datetime.now(UTC).strftime("%Y-%m-%dT%H:%M:%S.%f")
|
|
199
280
|
|
|
200
|
-
|
|
201
|
-
self._driver.start_exposure()
|
|
281
|
+
frame_size = await self._run_blocking_or_raise(_start)
|
|
202
282
|
|
|
203
283
|
# wait exposure
|
|
204
284
|
await self._wait_exposure(abort_event, exposure_time, open_shutter)
|
|
@@ -206,19 +286,27 @@ class FliProCamera(BaseCamera, ICamera, IAbortable, IWindow, IBinning, ICooling,
|
|
|
206
286
|
# readout
|
|
207
287
|
log.info("Exposure finished, reading out...")
|
|
208
288
|
await self._change_exposure_status(ExposureStatus.READOUT)
|
|
209
|
-
|
|
210
|
-
|
|
289
|
+
|
|
290
|
+
def _readout() -> tuple[Any, float, float, float]:
|
|
291
|
+
img = driver.read_exposure(frame_size)
|
|
292
|
+
driver.stop_exposure()
|
|
293
|
+
temp = driver.get_sensor_temperature()
|
|
294
|
+
cooler_duty = driver.get_cooler_duty_cycle()
|
|
295
|
+
temp_set = driver.get_temperature_set_point()
|
|
296
|
+
return img, temp, cooler_duty, temp_set
|
|
297
|
+
|
|
298
|
+
img, temp, cooler_duty, temp_set = await self._run_blocking_or_raise(_readout, timeout=_READOUT_TIMEOUT)
|
|
211
299
|
|
|
212
300
|
# create FITS image and set header
|
|
213
301
|
image = Image(img)
|
|
214
302
|
image.header["DATE-OBS"] = (date_obs, "Date and time of start of exposure")
|
|
215
303
|
image.header["EXPTIME"] = (exposure_time, "Exposure time [s]")
|
|
216
|
-
image.header["DET-TEMP"] = (
|
|
217
|
-
image.header["DET-COOL"] = (
|
|
218
|
-
image.header["DET-TSET"] = (
|
|
304
|
+
image.header["DET-TEMP"] = (temp, "CCD temperature [C]")
|
|
305
|
+
image.header["DET-COOL"] = (cooler_duty, "Cooler power [percent]")
|
|
306
|
+
image.header["DET-TSET"] = (temp_set, "Cooler setpoint [C]")
|
|
219
307
|
|
|
220
308
|
# instrument and detector
|
|
221
|
-
dev =
|
|
309
|
+
dev = driver.device
|
|
222
310
|
image.header["INSTRUME"] = (f"{dev.friendly_name} {dev.serial_number}", "Name of instrument")
|
|
223
311
|
|
|
224
312
|
# binning
|
|
@@ -243,17 +331,30 @@ class FliProCamera(BaseCamera, ICamera, IAbortable, IWindow, IBinning, ICooling,
|
|
|
243
331
|
|
|
244
332
|
async def _wait_exposure(self, abort_event: asyncio.Event, exposure_time: float, open_shutter: bool) -> None:
|
|
245
333
|
"""Wait for exposure to finish."""
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
334
|
+
if self._driver is None:
|
|
335
|
+
raise ValueError("No camera driver.")
|
|
336
|
+
driver = self._driver
|
|
337
|
+
|
|
338
|
+
# run the whole "poll until ready" loop as a single blocking call (see _run_blocking),
|
|
339
|
+
# rather than polling is_available() every 10ms directly on the event loop
|
|
340
|
+
def _wait() -> bool:
|
|
341
|
+
while not driver.is_available():
|
|
342
|
+
if abort_event.is_set():
|
|
343
|
+
return True
|
|
344
|
+
time.sleep(0.01)
|
|
345
|
+
return False
|
|
346
|
+
|
|
347
|
+
exposure_timeout = exposure_time + _EXPOSURE_WAIT_MARGIN
|
|
348
|
+
aborted = await self._run_blocking_or_raise(_wait, timeout=exposure_timeout)
|
|
349
|
+
if aborted:
|
|
350
|
+
await self._change_exposure_status(ExposureStatus.IDLE)
|
|
351
|
+
raise InterruptedError("Aborted exposure.")
|
|
251
352
|
|
|
252
353
|
async def _abort_exposure(self) -> None:
|
|
253
354
|
"""Abort the running exposure."""
|
|
254
355
|
if self._driver is None:
|
|
255
356
|
raise ValueError("No camera driver.")
|
|
256
|
-
self._driver.cancel_exposure
|
|
357
|
+
await self._run_blocking_or_raise(self._driver.cancel_exposure)
|
|
257
358
|
|
|
258
359
|
async def set_window(self, left: int, top: int, width: int, height: int, **kwargs: Any) -> None:
|
|
259
360
|
"""Set the camera window.
|
|
@@ -288,6 +389,7 @@ class FliProCamera(BaseCamera, ICamera, IAbortable, IWindow, IBinning, ICooling,
|
|
|
288
389
|
"""
|
|
289
390
|
if self._driver is None:
|
|
290
391
|
raise ValueError("No camera driver.")
|
|
392
|
+
driver = self._driver
|
|
291
393
|
|
|
292
394
|
if enabled:
|
|
293
395
|
log.info("Enabling cooling with a setpoint of %.2f°C...", setpoint)
|
|
@@ -295,7 +397,11 @@ class FliProCamera(BaseCamera, ICamera, IAbortable, IWindow, IBinning, ICooling,
|
|
|
295
397
|
log.info("Disabling cooling and setting setpoint to 20°C...")
|
|
296
398
|
|
|
297
399
|
actual_setpoint = float(setpoint) if setpoint is not None else 20.0
|
|
298
|
-
|
|
400
|
+
|
|
401
|
+
def _set() -> None:
|
|
402
|
+
driver.set_temperature_set_point(actual_setpoint)
|
|
403
|
+
|
|
404
|
+
await self._run_blocking_or_raise(_set)
|
|
299
405
|
self._cooling_enabled = enabled
|
|
300
406
|
await self.comm.set_state(ICooling, CoolingState(setpoint=actual_setpoint, power=None, enabled=enabled))
|
|
301
407
|
|
|
@@ -304,9 +410,16 @@ class FliProCamera(BaseCamera, ICamera, IAbortable, IWindow, IBinning, ICooling,
|
|
|
304
410
|
while True:
|
|
305
411
|
try:
|
|
306
412
|
if self._driver is not None:
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
413
|
+
driver = self._driver
|
|
414
|
+
|
|
415
|
+
def _poll() -> tuple[float, float, tuple[Any, float, float]]:
|
|
416
|
+
setpoint = driver.get_temperature_set_point()
|
|
417
|
+
duty = driver.get_cooler_duty_cycle()
|
|
418
|
+
temps = driver.get_temperatures()
|
|
419
|
+
return setpoint, duty, temps
|
|
420
|
+
|
|
421
|
+
setpoint, duty, (_, t_base, t_cooler) = await self._run_blocking_or_raise(_poll)
|
|
422
|
+
|
|
310
423
|
await self.comm.set_state(
|
|
311
424
|
ICooling, CoolingState(setpoint=setpoint, power=round(duty), enabled=self._cooling_enabled)
|
|
312
425
|
)
|