No starting docstrings with This
This commit is contained in:
parent
f51dae7b3a
commit
be6a6ca6fe
13 changed files with 46 additions and 68 deletions
|
|
@ -1,9 +1,4 @@
|
|||
"""
|
||||
This submodule contains functionality for interacting with scan directories.
|
||||
|
||||
Currently it handles scan getting information from a information from a scan directory,
|
||||
eventually is should handle all the file system operation for smart_scan.
|
||||
"""
|
||||
"""Functionality to manage file system operations for scan directories."""
|
||||
|
||||
from typing import Optional
|
||||
import os
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
"""
|
||||
This module contains functionality for planning a scan route
|
||||
"""Functionality for planning scan routes.
|
||||
|
||||
A scan route can be planned by a ScanPlanner class currently there
|
||||
is only one type the SmartSpiral. More can be added using by
|
||||
|
|
@ -242,14 +241,14 @@ class ScanPlanner:
|
|||
|
||||
|
||||
class SmartSpiral(ScanPlanner):
|
||||
"""
|
||||
This is a smart spiral scan that spirals out from the centre, but prioritises
|
||||
short moves over rigidly sticking to minimising radius from the centre of the
|
||||
scan.
|
||||
"""A scan planner that spirals outward from the centre, prioritising short moves.
|
||||
|
||||
This planner spirals out from the centre, but prioritises short moves over rigidly
|
||||
sticking to minimising radius from the centre of the scan.
|
||||
|
||||
Each time and image is taken the four neighbouring images are added
|
||||
to the list of poisitions to image (unless they are already listed or
|
||||
tried). However if a location is not imaged due no sample being detected
|
||||
to the list of positions to image (unless they are already listed or
|
||||
tried). However, if a location is not imaged due no sample being detected
|
||||
then neibouring positions are not imaged.
|
||||
|
||||
The next image taken is the closes to the centre (considering the largest
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
"""
|
||||
This SubModule interacts with a Raspberry Pi camera using the Picamera2 library.
|
||||
"""Submodule for interacting with a Raspberry Pi camera using the Picamera2 library.
|
||||
|
||||
The Picamera2 library uses LibCamera as the underlying camera stack. This gives us
|
||||
some control of the GPU pipeline for the image.
|
||||
|
|
|
|||
|
|
@ -1,14 +1,12 @@
|
|||
"""
|
||||
This module contains some utility functions and classes
|
||||
"""
|
||||
"""Utility functions and classes."""
|
||||
|
||||
from threading import Thread
|
||||
|
||||
|
||||
class ErrorCapturingThread(Thread):
|
||||
"""
|
||||
This is a a subclass or Thread. It wraps the target function in a
|
||||
try-except block.
|
||||
"""Subclass of Thread that captures exceptions from the target function.
|
||||
|
||||
It wraps the target function in a try-except block.
|
||||
|
||||
Execution will stop with an unhandled exception, but the exception will not be raised
|
||||
until the join method is called. When the join method is called, the exception is
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue