LUCID Forensic Workbench

Ask an agent to

• Add a sharpen filter to the active chain and tune it
• Go to frame 120 and bookmark it with a note
• Duplicate this chain to try a different enhancement

31 tools

• add_bookmark

  Bookmark a frame of the active chain with a note (bookmarks appear in the report). Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  frame: integer?, note: string?

• add_filter

  Add a filter to a chain (default: the active chain, right after the selected filter) and select it. Unspecified parameters take their defaults (regions default to the Viewer selection). Returns the new filter id and a…

  type: string, params: object?, chain_id: string?, after_filter_id: string?, index: integer?

• ask_user

  Ask the user a question and wait for the answer (offer options when you can). Use it for ambiguous requests or choices that are the examiner's to make. Needs the examiner at the LUCID window (a click in LUCID's AI…

  question: string, options: array?

• delete_chain

  Delete a whole chain (undoable). The evidence file itself is never touched. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  chain_id: string

• duplicate_chain

  Copy a chain (to try alternatives without touching the original); the copy becomes active. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  chain_id: string?, name: string?

• export

  Prepare an export and let the user save it: frames as images, a video, a snapshot, the processing report, or the project file. Uses lossless formats when 'lossless exports only' is on. The user clicks Save. Needs the…

  what: string, format: string?, range: string?, start: integer?, end: integer?, name: string?, chain_id: string?

• get_filter_schemaread-only

  Parameters of a filter type: keys, types, ranges, options, defaults, help. Read it before setting parameters you are not sure about.

  type: string

• get_frame_statsread-only

  Statistics of a rendered frame (exact, from the processing engine): size, MD5, per channel min/max/mean/standard deviation, clipped pixels, a 16-bin luma histogram. Use it to verify changes.

  chain_id: string?, filter_id: string?, frame: integer?

• get_source_inforead-only

  File information of the evidence of a chain: container, codec, size, frames, frame rate, color conversion, decoder, hashes, metadata (EXIF, tags).

  chain_id: string?

• get_stateread-only

  Current project: chains with their filters (ids, types, enabled, parameters of the active chain), active chain, selected filter, current frame, In/Out range, view and playback state. Call it first.

• go_to_frame

  Move the active chain to a frame: absolute frame number, a relative step (delta) or a time in seconds.

  frame: integer?, delta: integer?, seconds: number?

• list_commandsread-only

  Commands of the application menus (File, Edit, Project, Utilities, View, Help) with ids; run_command executes one.

  search: string?

• list_filtersread-only

  Catalogue of the available filters (type id, name, category, description). Optional category or search text.

  category: string?, search: string?

• load_sample_case

  Load the built-in demonstration case (synthetic license plate, periodic noise and resolution chart chains). Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

• move_filter

  Move a filter to another position in its chain (index 1 = right after the loader). Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  filter_id: string, index: integer

• open_media

  Ask the user to open evidence (video, image, image sequence) or a project file — browsers only open files on the user's click. Returns what was loaded. Needs the examiner at the LUCID window (a click in LUCID's AI…

  kind: string?, reason: string?

• playback

  Play, pause or stop the active chain; set the speed (0.01 to 16, 1 = real time; below 1 no frame is skipped), loop, and playing only the In/Out range.

  action: string?, speed: number?, loop: boolean?, in_out_only: boolean?

• redo

  Redo changes undone with undo. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  steps: integer?

• remove_filter

  Remove a filter from its chain (not the loader: use delete_chain for a whole chain). Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  filter_id: string

• rename_chain

  Rename a chain. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  chain_id: string, name: string

• reset_filter

  Reset all parameters of a filter to their defaults. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  filter_id: string

• run_command

  Run an application menu command by id (see list_commands). Commands that open a dialog leave it open for the user. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  id: string

• select

  Show a chain in the Viewer and/or select a filter (the Viewer shows the output of the selected filter, or its input with show_input).

  chain_id: string?, filter_id: string?, show_input: boolean?

• set_case_info

  Fill in the case information printed in the report. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  case_number: string?, exhibit: string?, examiner: string?, agency: string?, notes: string?

• set_filter_enabled

  Enable or disable a filter (a disabled filter passes its input through; it stays in the chain). Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  filter_id: string, enabled: boolean

• set_filter_params

  Change parameters of an existing filter (one undo step). Returns the applied values and a render check. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  filter_id: string, params: object

• set_in_out

  Set or clear (null) the In and Out points of the active chain (frame numbers); used for exports and playback ranges. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  in_frame: integer?, out_frame: integer?

• set_selection

  Set (or clear with null) the selection rectangle on the Viewer — filters added afterwards use it as their region (crop, magnify, stabilization ROI…).

  rect: object?

• set_view

  Viewer: zoom (percent) or fit, and the display scaling (sharp = equal-size pixels, nearest, smooth). Display only — never changes the pixels.

  zoom_percent: number?, fit: boolean?, display: string?

• undo

  Undo the last change(s) to the project (the same as Edit › Undo). Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).

  steps: integer?

• view_frameread-only

  Look at a rendered frame (an image is attached to the result) — only if the user allows frame sharing. Optionally a region, enlarged for detail.

  chain_id: string?, filter_id: string?, frame: integer?, region: object?, max_size: integer?