OpenFlexure Microscope Server API Documentation Modules Classes Names
Clear Help

For more information on the search, visit the help page.

Class Hierarchy

  • ChildProcessError
    • openflexure_microscope_server.stitching.ExternalSigkillError - Exception called when stitch is killed by an external process calling Sigkill.
  • fastapi.HTTPException
    • openflexure_microscope_server.things.camera_stage_mapping.CSMUncalibratedError - An HTTP Exception raised if camera stage mapping data is needed but unavailable.
  • IOError
    • openflexure_microscope_server.scan_directories.NotEnoughFreeSpaceError - An exception raised if there is not enough free space on disk to scan.
  • labthings_fastapi.blob.Blob
    • openflexure_microscope_server.things.camera.JPEGBlob - A class representing a JPEG image as a LabThings FastAPI Blob.
    • openflexure_microscope_server.things.camera.PNGBlob - A class representing a PNG image as a LabThings FastAPI Blob.
  • labthings_fastapi.Thing
    • openflexure_microscope_server.things.autofocus.AutofocusThing - The Thing concerned with combinations of z axis movements and the camera.
    • openflexure_microscope_server.things.camera.BaseCamera - The base class for all cameras. All cameras must directly inherit from this class.
      • openflexure_microscope_server.things.camera.opencv.OpenCVCamera - A Thing that provides and interface to an OpenCV Camera.
      • openflexure_microscope_server.things.camera.picamera.StreamingPiCamera2 - A Thing that provides and interface to the Raspberry Pi Camera.
      • openflexure_microscope_server.things.camera.simulation.SimulatedCamera - A Thing that simulates a camera for testing.
    • openflexure_microscope_server.things.camera_stage_mapping.CameraStageMapper - A Thing to manage mapping between image and stage coordinates.
    • openflexure_microscope_server.things.smart_scan.SmartScanThing - A Thing for scanning samples and interacting with past scans.
    • openflexure_microscope_server.things.stage.BaseStage - A base stage class for OpenFlexure translation stages.
      • openflexure_microscope_server.things.stage.dummy.DummyStage - A dummy stage for testing purposes.
      • openflexure_microscope_server.things.stage.sangaboard.SangaboardThing - A Thing to manage a Sangaboard motor controller.
    • openflexure_microscope_server.things.system.OpenFlexureSystem - Describe and control the OpenFlexure system.
  • logging.Filter
    • openflexure_microscope_server.logging.UvicornAccessFilter - A logging filter to filter out "uvicorn.access" messages.
  • logging.Handler
    • openflexure_microscope_server.logging.OFMHandler - A logging.Handler that stores the most recent logs for access by the server.
  • openflexure_microscope_server.background_detect.BackgroundDetectAlgorithm - The base class for defining background detect algorithms.
    • openflexure_microscope_server.background_detect.ColourChannelDetectLUV - Compare images with a known background in LUV colourspace.
  • openflexure_microscope_server.scan_directories.ScanDirectory - A class for handling interactions with scan directories.
  • openflexure_microscope_server.scan_directories.ScanDirectoryManager - A class for managing interactions with scan directories.
  • openflexure_microscope_server.scan_planners.ScanPlanner - A base class for a scan planner.
    • openflexure_microscope_server.scan_planners.SmartSpiral - A scan planner that spirals outward from the centre, prioritising short moves.
  • openflexure_microscope_server.stitching.BaseStitcher - A base stitching class for all stitchers. Don't initialise this directly.
    • openflexure_microscope_server.stitching.FinalStitcher - A class to handle the final stitch for a scan.
    • openflexure_microscope_server.stitching.PreviewStitcher - A stitcher for stitching an ongoing scan in preview mode.
  • openflexure_microscope_server.things.autofocus.CaptureInfo - The information from a capture in a z_stack.
  • openflexure_microscope_server.things.autofocus.JPEGSharpnessMonitor - A class with direct access to the CameraThing for monitoring the MJPEG stream.
  • openflexure_microscope_server.things.autofocus.StackParams - A class for holding for stack parameters, and returning computed ones.
  • openflexure_microscope_server.things.camera.CameraMemoryBuffer - A class that holds images in memory. The images are by default PIL images.
  • openflexure_microscope_server.things.camera_stage_mapping.RecordedMove - Call stage movement and maintain a record of position and time.
  • picamera2.outputs.Output
    • openflexure_microscope_server.things.camera.picamera.PicameraStreamOutput - An Output class that sends frames to a stream.
  • pydantic.BaseModel
    • openflexure_microscope_server.background_detect.BackgroundDetectorStatus - The status information about a background detector instance needed for the GUI.
    • openflexure_microscope_server.background_detect.ChannelDistributions - A BaseModel for storing the channel distribution of a background image.
    • openflexure_microscope_server.background_detect.ColourChannelDetectSettings - A BaseModel for storing the settings for colour channel detectors.
    • openflexure_microscope_server.scan_directories.ScanData - Data about a scan to be saved to a JSON file in the directory.
    • openflexure_microscope_server.scan_directories.ScanInfo - Summary information about a scan folder.
    • openflexure_microscope_server.things.autofocus.SharpnessDataArrays - A BaseModel with the position and sharpness data from JPEGSharpnessMonitor.
    • openflexure_microscope_server.things.camera.picamera.LensShading - A Pydantic model holding the lens shading tables.
    • openflexure_microscope_server.things.camera.picamera.SensorMode - A Pydantic model holding all the information about a specific sensor mode.
    • openflexure_microscope_server.things.camera.picamera.SensorModeSelector - A Pydantic model holding the two values needed to select a PiCamera Sensor mode.
    • openflexure_microscope_server.things.camera.picamera_recalibrate_utils.ExposureTest - Record the results of testing the camera's current exposure settings.
    • openflexure_microscope_server.things.system.CommandOutput - A pydantic model passing the STDOUT and STDERR from a subprocess over HTTP.
    • openflexure_microscope_server.ui.ActionButton - The data required for creating an actionButton in Vue.
    • openflexure_microscope_server.ui.PropertyControl - The data required for creating an actionButton in Vue.
    • openflexure_microscope_server.utilities.VersionData - A BaseModel containing the information about the server version.
  • pydantic.RootModel
    • openflexure_microscope_server.things.camera.ArrayModel - A model for an array.
  • RuntimeError
    • openflexure_microscope_server.background_detect.MissingBackgroundDataError - An error raised if checking for sample without background data set.
    • openflexure_microscope_server.stitching.StitcherValidationError - The stitcher received values that it deems unsafe to create a command from.
    • openflexure_microscope_server.things.camera.CaptureError - An error trying to capture from a CameraThing.
    • openflexure_microscope_server.things.camera.NoImageInMemoryError - An error called if no image is in memory when accessed.
    • openflexure_microscope_server.things.camera.picamera.MissingCalibrationError - Picamera tuning file is missing or doesn't contain the requested algorithm.
    • openflexure_microscope_server.things.smart_scan.ScanNotRunningError - Exception called when scan not running that requires a scan to be running.
    • openflexure_microscope_server.things.stage.RedefinedBaseMovementError - The subclass of BaseStage has overridden move_relative or move_absolute.
  • threading.Thread
    • openflexure_microscope_server.utilities.ErrorCapturingThread - Subclass of Thread that captures exceptions from the target function.
  • typing.NamedTuple
    • openflexure_microscope_server.things.camera_stage_mapping.MoveHistory - A named tuple containing the position over time for a single move.

API Documentation for OpenFlexure Microscope Server, generated by pydoctor 25.4.0 at 2025-08-22 13:33:59.