Reprocessing

Experimental API for applying different Settings to an already-captured Frame without re-acquiring from the camera. Useful for offline filter tuning. Resides in Zivid::Experimental and may change without prior notice.

        %%{init: {'themeVariables': {'fontSize': '18px'}, 'flowchart': {'nodeSpacing': 30, 'rankSpacing': 35}}}%%
flowchart LR
  Application
  Frame
  Settings

  reprocessOp(["reprocess()"])

  NewFrame["Frame"]

  Application -.-> reprocessOp --> NewFrame
  Frame -.-> reprocessOp
  Settings -.-> reprocessOp

  classDef zividClass fill:#4A8FA4,stroke:#34323D,color:#FFFFFF
  classDef api fill:#91D2C8,stroke:#4A8FA4,color:#000000
  class Application,Frame,Settings,NewFrame zividClass
  class reprocessOp api

reprocess

Takes an existing Frame and a new set of Settings and returns a new Frame with those settings applied. The original frame must have been captured with the same camera and not have been transformed.

C++

Frame Zivid::Experimental::reprocess(Application &application, const Frame &frame, const Settings &settings)

Re-run processing on the provided frame using the provided settings.

Returns the new frame.

If the acquisition settings in settings does not match the original acquisition in frame, this function will throw an exception.

This function requires that Diagnostics was enabled when capturing the frame. Otherwise, this method will throw an exception.

If the frame was created from a different SDK version than the currently installed SDK version, this function will throw an exception.

C#

See Zivid::NET::Experimental::Reprocessor in the C# API reference.

Python

zivid.experimental.reprocess(application, frame, settings) — see zivid-python.