cherab.phix.observer.fast_camera.RGBPipeline2D#

class cherab.phix.observer.fast_camera.RGBPipeline2D#

Bases: Pipeline2D

2D pipeline of sRGB colour values.

Converts the measured spectrum from each pixel into PhantomRGB colour space values. See the colour module for more information. The RGBPipeline2D class is the workhorse pipeline for visualisation of scenes with Raysect and the default pipeline for most 2D observers.

Parameters:

  • display_progress (bool) – Toggles the display of live render progress (default=True).

  • display_update_time (float) – Time in seconds between preview display updates (default=15 seconds).

  • accumulate (bool) – Whether to accumulate samples with subsequent calls to observe() (default=True).

  • exposure_time (float) – Phantom camera’s sexposure time (default=1.0).

  • auto_normalize (bool) – if True, Display values will be scaled to satisfy the maximum pixel value is equal to 4095 (default=True).

  • name (str) – User friendly name for this pipeline.

Methods

display()

Plot the RGB frame.

finalise()

Finalises the results when rendering has finished.

initialise(pixels, pixel_samples, ...)

Initialises containers for the pipeline's processing output.

pixel_processor(x, y, slice_id)

Initialise and return a pixel processor for this pipeline and pixel coordinate.

save(filename)

Saves the display image to a png file.

update(x, y, slice_id, packed_result)

Updates the internal results array with packed results from the pixel processor.

Attributes

accumulate

auto_normalize

whether pixels are normalized or not.

display_persist_figure

display_progress

display_update_time

Time in seconds between preview display updates.

exposure_time

The exposure time of the Phantom camera.

rgb_frame