class documentation

A Thing that provides and interface to the Raspberry Pi Camera V2.

Property capture_modes Modes the camera can use for capturing.
Property streaming_modes Modes the camera can stream in.
Class Variable _camera_board Undocumented

Inherited from StreamingPiCamera2:

Method __enter__ Start streaming when the Thing context manager is opened.
Method __exit__ Close the picamera connection when the Thing context manager is closed.
Method __init__ Initialise the camera with the given camera number.
Method analogue_gain The Analogue gain applied by the camera sensor.
Method analogue_gain.setter Undocumented
Method auto_expose_from_minimum Adjust exposure until a the target white level is reached.
Method calibrate_lens_shading Take an image and use it for flat-field correction.
Method capture_as_array Acquire one image from the camera and return as an array.
Method colour_correction_matrix.setter Undocumented
Method colour_gains The red and blue colour gains, must be between 0.0 and 32.0.
Method colour_gains.setter Undocumented
Method discard_frames Discard frames so that the next frame captured is fresh.
Method exposure_time The camera exposure time in microseconds.
Method exposure_time.setter Undocumented
Method flat_lens_shading Disable flat-field correction.
Method flat_lens_shading_chrominance Disable flat-field correction for colour only.
Method full_auto_calibrate Perform a full auto-calibration.
Method reset_ccm Overwrite the colour correction matrix in camera tuning with default values.
Method reset_lens_shading Revert to default lens shading settings.
Method save_settings Override save_settings to ensure that camera properties don't recurse.
Method set_ce_enable_to_off Set the contrast enhancement to disabled.
Method set_static_green_equalisation Set the green equalisation to a static value.
Class Variable mjpeg_bitrate Bitrate for MJPEG stream (None for default).
Class Variable supports_focus_fom Undocumented
Instance Variable default_tuning Undocumented
Instance Variable stream_active Whether the MJPEG stream is active.
Instance Variable streaming_mode Undocumented
Instance Variable tuning The Raspberry PiCamera Tuning File JSON.
Property calibration_required Whether the camera needs calibrating.
Property camera_configuration The "configuration" dictionary of the picamera2 object.
Property capture_metadata Return the metadata from the camera.
Property colour_correction_matrix The colour_correction_matrix from the tuning file.
Property focus_fom Return the focus figure of merit.
Property gamma_correction Return the gamma correction curve from the tuning file.
Property lens_shading_tables The current lens shading (i.e. flat-field correction).
Property manual_camera_settings The camera settings to expose as property controls in the settings panel.
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 sensor_resolution The native resolution of the camera's sensor.
Property streaming True if the camera is streaming.
Property thing_state Update generic camera metadata with Picamera-specific data.
Method _capture_image Acquire one image from the camera and return it as a PIL Image.
Method _create_picam_config_from_mode_info Create the dictionary to pass to Picamera2.configure.
Method _ensure_mode_for_capture Ensure in correct mode for capture.
Method _get_persistent_controls Undocumented
Method _initialise_picamera Acquire the picamera device and store it as self._picamera.
Method _on_frame_complete Undocumented
Method _start_streaming Start the MJPEG stream. This is where persistent controls are sent to camera.
Method _stop_streaming Stop the MJPEG stream.
Method _streaming_picamera Lock access to picamera and return the underlying Picamera2 instance.
Class Variable _sensor_info Undocumented
Instance Variable _analogue_gain Undocumented
Instance Variable _camera_num Undocumented
Instance Variable _colour_gains Undocumented
Instance Variable _exposure_time Undocumented
Instance Variable _focus_fom Undocumented
Instance Variable _picamera Undocumented
Instance Variable _picamera_lock Undocumented
Instance Variable _setting_save_in_progress Undocumented

Inherited from BaseCamera (via StreamingPiCamera2):

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
Property background_detector The active background detector instance.
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 StreamingPiCamera2, 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