openflexure_microscope_server.things.camera.simulation.SimulatedCamera

class documentation

class SimulatedCamera(BaseCamera): (source)

Constructor: SimulatedCamera(thing_server_interface, shape, canvas_shape, frame_interval)

View In Hierarchy

A Thing that simulates a camera for testing.

Method __enter__ Start the capture thread when the Thing context manager is opened.
Method __exit__ Close the capture thread when the Thing context manager is closed.
Method __init__ Initialise the simulated with settings for how images are generated.
Method blob_density.setter Undocumented
Method capture_as_array Acquire one image from the camera and return as an array.
Method colour.setter Undocumented
Method discard_frames Discard frames so that the next frame captured is fresh.
Method draw_sprite_on_canvas Place one sprite on canvas at given centre coordinates.
Method full_auto_calibrate Perform a full auto-calibration.
Method generate_blobs Generate coordinates of blobs and their sizes, centered around (0,0).
Method generate_canvas Generate a canvas with generated blobs centered at the middle.
Method generate_frame Generate a frame with blobs based on the stage coordinates.
Method generate_image Generate an image with blobs based on supplied coordinates.
Method generate_sprites Generate sprites to populate the image.
Method load_sample Show the simulated sample.
Method objective.setter Undocumented
Method remove_sample Show the simulated background with no sample.
Method set_led Set the simulated LED to on or off.
Class Variable noise_level Undocumented
Class Variable repeating Undocumented
Instance Variable blank_canvas Undocumented
Instance Variable blank_canvas_low_mag Undocumented
Instance Variable blobs Undocumented
Instance Variable canvas Undocumented
Instance Variable canvas_low_mag Undocumented
Instance Variable canvas_shape Undocumented
Instance Variable frame_interval Undocumented
Instance Variable glyph_size Undocumented
Instance Variable led_on Undocumented
Instance Variable low_mag_canvas_shape Undocumented
Instance Variable shape Undocumented
Instance Variable sprites Undocumented
Instance Variable streaming_mode Undocumented
Property blob_density The number of blobs per million pixels.
Property calibration_required Whether the camera needs calibrating.
Property colour The colour of the blobs as a HTML hex string.
Property manual_camera_settings The camera settings to expose as property controls in the settings panel.
Property objective Objective magnification (e.g. 4, 10, 20, 40, 60, 100).
Property primary_calibration_actions The calibration actions for both calibration wizard and settings panel.
Property secondary_calibration_actions The calibration actions that appear only in settings panel.
Property stream_active Whether the MJPEG stream is active.
Method _capture_frames Undocumented
Method _capture_image Capture to a PIL image. This is not exposed as a ThingAction.
Method _start_streaming Start the live stream.
Class Variable _stage Undocumented
Instance Variable _blob_density Undocumented
Instance Variable _capture_enabled Undocumented
Instance Variable _capture_thread Undocumented
Instance Variable _colour Undocumented
Instance Variable _objective Undocumented
Instance Variable _show_sample Undocumented

Inherited from BaseCamera:

Method background_detector_name The name of the active background selector.
Method background_detector_name.setter Validate and set background_detector_name.
Method capture Acquire one image from the camera.
Method capture_and_save_to_path Capture an image and save it to disk.
Method capture_downsampled_array Acquire one image from the camera, downsample, and return as an array.
Method capture_to_memory Capture an image to memory. This can be saved later with save_from_memory.
Method change_streaming_mode Change the mode the camera is streaming in.
Method clear_buffers Clear all images in memory.
Method grab_as_array Acquire one image from the preview stream and return as an array.
Method grab_jpeg Acquire one image from the preview stream and return as blob of JPEG data.
Method grab_jpeg_size Acquire one image from the preview stream and return its size.
Method image_is_sample Label the current image as either background or sample.
Method kill_mjpeg_streams Kill the streams now as the server is shutting down.
Method record_framerate Record MJPEG stream framerate statistics.
Method save_from_memory Save an image that has been captured to memory.
Method set_background Grab an image, and use its statistics to set the background.
Method settle Sleep for the settling time, ready to provide a fresh frame.
Async Method snapshot Return a snapshot from the microscope.
Class Variable downsampled_array_factor The downsampling factor when calling capture_downsampled_array.
Class Variable lores_mjpeg_stream Undocumented
Class Variable mjpeg_stream Undocumented
Class Variable settling_time The settling time when calling the settle() method.
Class Variable supported_image_formats Undocumented
Class Variable supports_focus_fom Undocumented
Property background_detector The active background detector instance.
Property capture_modes Modes the camera can use for capturing.
Property focus_fom Return the focus figure of merit.
Property streaming_modes Modes the camera can stream in.
Property thing_state Return camera-specific metadata.
Method _add_metadata_to_capture Add the EXIF metadata for a JPEG image.
Method _collect_ofm_metadata Return the metadata for a capture.
Async Method _monitor_framerate Asynchronously monitor the timing on incoming frames.
Method _validate_capture_mode Check input capture mode exists, always returns a valid mode.
Class Variable _all_background_detectors Undocumented
Class Variable _class_settings Undocumented
Class Variable _memory_buffer Undocumented
Instance Variable _background_detector_name Undocumented
Instance Variable _default_background_detector Undocumented
Instance Variable _framerate_monitor_running Undocumented

Inherited from OFMThing (via BaseCamera):

Method create_data_path Create a RelativeDataPath object with this Thing set as the saving Thing.
Property data_dir The data directory for this thing.
Property show_data_in_gallery Whether to show in the Gallery.
Class Variable _show_data_in_gallery Undocumented
Instance Variable _data_dir Undocumented
def __enter__(self) -> Self: (source)
overrides openflexure_microscope_server.things.camera.BaseCamera.__enter__

Start the capture thread when the Thing context manager is opened.

def __exit__(self, exc_type: type[BaseException], exc_value: BaseException | None, traceback: TracebackType | None): (source)
overrides openflexure_microscope_server.things.camera.BaseCamera.__exit__

Close the capture thread when the Thing context manager is closed.

def __init__(self, thing_server_interface: lt.ThingServerInterface, shape: tuple[int, int, int] = (616, 820, 3), canvas_shape: tuple[int, int, int] = (1500, 2000, 3), frame_interval: float = 0.1): (source)
overrides openflexure_microscope_server.things.camera.BaseCamera.__init__

Initialise the simulated with settings for how images are generated.

Parameters
thing_server_interface:lt.ThingServerInterfaceUndocumented
shape:tuple[int, int, int]The shape (size) of the generated image.
canvas_shape:tuple[int, int, int]The shape (size) of the canvas generated on initialisation that images are cropped from. If this is too large the it uses resources, but its size limits the range of motion of the simulation.
frame_interval:floatNominally the time between frames on the MJPEG stream, however the rate may be slower due to calculation time for focus.
def blob_density(self, value: int): (source)

Undocumented

@lt.action
def capture_as_array(self, capture_mode: str = 'standard', raw: bool = False) -> NDArray: (source)
overrides openflexure_microscope_server.things.camera.BaseCamera.capture_as_array

Acquire one image from the camera and return as an array.

This function will produce a nested list containing an uncompressed RGB image. It's likely to be highly inefficient - raw and/or uncompressed captures using binary image formats will be added in due course.

Parameters
capture_mode:str(Optional) The name of the capture mode as defined by the camera.
raw:boolRaw Capture is not implemented for the simulation microscope. Setting this to True will result in an error.
Returns
NDArrayUndocumented
def colour(self, colour_value: str): (source)

Undocumented

@lt.action
def discard_frames(self): (source)
overrides openflexure_microscope_server.things.camera.BaseCamera.discard_frames

Discard frames so that the next frame captured is fresh.

There is nothing to do as this is a simulation!

def draw_sprite_on_canvas(self, canvas: np.ndarray, sprite: np.ndarray, centre_y: int, centre_x: int): (source)

Place one sprite on canvas at given centre coordinates.

Note that self.canvas is modified in place.

Parameters
canvas:np.ndarrayUndocumented
sprite:np.ndarrayThe sprite array to place on the canvas.
centre_y:intThe y coordinate to place the centre of the sprite.
centre_x:intThe x coordinate to place the centre of the sprite.
@lt.action
def full_auto_calibrate(self): (source)

Perform a full auto-calibration.

For the simulation microscope the process is:

  • remove_sample
  • set_background
  • load_sample
def generate_blobs(self, n_blobs: int = 1000): (source)

Generate coordinates of blobs and their sizes, centered around (0,0).

Note that blob density is determined by sample size and n_blobs, and for larger samples n_blobs will need increasing to keep a high level of sample coverage per field of view.

Parameters
n_blobs:intThe number of blobs to generate.
def generate_canvas(self): (source)

Generate a canvas with generated blobs centered at the middle.

Canvas is int16 so that random noise can be added to simulation image before changing to unit8 to stop wrapping.

def generate_frame(self) -> Image.Image: (source)

Generate a frame with blobs based on the stage coordinates.

def generate_image(self, pos: tuple[int, int, int]) -> Image.Image: (source)

Generate an image with blobs based on supplied coordinates.

Parameters
pos:tuple[int, int, int]a 3-item tuple containing the x,y,z coordinates of the 'stage'
Returns
Image.ImageUndocumented
def generate_sprites(self): (source)

Generate sprites to populate the image.

@lt.action
def load_sample(self): (source)

Show the simulated sample.

def objective(self, value: int): (source)

Undocumented

@lt.action
def remove_sample(self): (source)

Show the simulated background with no sample.

def set_led(self, led_on: bool = True): (source)

Set the simulated LED to on or off.

noise_level: float = (source)

Undocumented

repeating: bool = (source)

Undocumented

blank_canvas = (source)

Undocumented

blank_canvas_low_mag = (source)

Undocumented

blobs = (source)

Undocumented

canvas = (source)

Undocumented

canvas_low_mag = (source)

Undocumented

canvas_shape = (source)

Undocumented

frame_interval = (source)

Undocumented

glyph_size = (source)

Undocumented

led_on = (source)

Undocumented

low_mag_canvas_shape = (source)

Undocumented

shape = (source)

Undocumented

sprites: list = (source)

Undocumented

streaming_mode = (source)
overrides openflexure_microscope_server.things.camera.BaseCamera.streaming_mode

Undocumented

@lt.property
blob_density: int = (source)

The number of blobs per million pixels.

@lt.property
calibration_required: bool = (source)
overrides openflexure_microscope_server.things.camera.BaseCamera.calibration_required

Whether the camera needs calibrating.

@lt.property
colour: str = (source)

The colour of the blobs as a HTML hex string.

The string can either be a single colour (e.g. "#c5247f") or a list of colours separated by semicolons (e.g. "#c5247f; #b937b9"). Additional spaces are allowed between colours.

@lt.property
manual_camera_settings: list[PropertyControl] = (source)
overrides openflexure_microscope_server.things.camera.BaseCamera.manual_camera_settings

The camera settings to expose as property controls in the settings panel.

@lt.property
objective: int = (source)

Objective magnification (e.g. 4, 10, 20, 40, 60, 100).

@lt.property
primary_calibration_actions: list[ActionButton] = (source)
overrides openflexure_microscope_server.things.camera.BaseCamera.primary_calibration_actions

The calibration actions for both calibration wizard and settings panel.

@lt.property
secondary_calibration_actions: list[ActionButton] = (source)
overrides openflexure_microscope_server.things.camera.BaseCamera.secondary_calibration_actions

The calibration actions that appear only in settings panel.

@lt.property
stream_active: bool = (source)
overrides openflexure_microscope_server.things.camera.BaseCamera.stream_active

Whether the MJPEG stream is active.

def _capture_frames(self): (source)

Undocumented

def _capture_image(self, capture_mode: str = 'standard') -> Image.Image: (source)
overrides openflexure_microscope_server.things.camera.BaseCamera._capture_image

Capture to a PIL image. This is not exposed as a ThingAction.

It is used for capture to memory.

def _start_streaming(self, mode: str = 'default'): (source)
overrides openflexure_microscope_server.things.camera.BaseCamera._start_streaming

Start the live stream.

The _start_streaming method is used a camera Thing to begin streaming images or to adjust the stream resolution if streaming is already active.

The simulation camera does not currently support the resolution argument. It will always issue a warning that the resolution is not respected. If called while already streaming, the warning will be emitted and no other action will be taken.

Parameters
mode:strThe name of the streaming mode to use.
_stage: DummyStage = (source)

Undocumented

_blob_density: int = (source)

Undocumented

_capture_enabled: bool = (source)

Undocumented

_capture_thread: Thread | None = (source)

Undocumented

_colour: str = (source)

Undocumented

_objective: int = (source)

Undocumented

_show_sample: bool = (source)

Undocumented