dogecoin87.github.io

{
  "name": "get_state",
  "kind": "answer",
  "impl": "imperative",
  "description": "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.",
  "inputSchema": {
    "type": "object",
    "properties": {}
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "list_filters",
  "kind": "answer",
  "impl": "imperative",
  "description": "Catalogue of the available filters (type id, name, category, description). Optional category or search text.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "category": {
        "type": "string",
        "description": "e.g. Adjust, Sharpen, Denoise, Deblurring, Stabilization, Edit, Integrate, Measure, Presentation"
      },
      "search": {
        "type": "string",
        "description": "words to look for"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "get_filter_schema",
  "kind": "answer",
  "impl": "imperative",
  "description": "Parameters of a filter type: keys, types, ranges, options, defaults, help. Read it before setting parameters you are not sure about.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "type": {
        "type": "string",
        "description": "filter type id or name, e.g. levels, unsharp_masking, crop"
      }
    },
    "required": [
      "type"
    ]
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "get_source_info",
  "kind": "answer",
  "impl": "imperative",
  "description": "File information of the evidence of a chain: container, codec, size, frames, frame rate, color conversion, decoder, hashes, metadata (EXIF, tags).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "chain_id": {
        "type": "string",
        "description": "chain id (default: active chain)"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "get_frame_stats",
  "kind": "answer",
  "impl": "imperative",
  "description": "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.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "chain_id": {
        "type": "string",
        "description": "default: active chain"
      },
      "filter_id": {
        "type": "string",
        "description": "output of this filter (default: end of the chain)"
      },
      "frame": {
        "type": "integer",
        "description": "default: current frame"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "view_frame",
  "kind": "act",
  "impl": "imperative",
  "description": "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.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "chain_id": {
        "type": "string",
        "description": "default: active chain"
      },
      "filter_id": {
        "type": "string",
        "description": "default: end of the chain"
      },
      "frame": {
        "type": "integer",
        "description": "default: current frame"
      },
      "region": {
        "type": "object",
        "properties": {
          "x": {
            "type": "number",
            "description": "left, pixels"
          },
          "y": {
            "type": "number",
            "description": "top, pixels"
          },
          "w": {
            "type": "number",
            "description": "width, pixels"
          },
          "h": {
            "type": "number",
            "description": "height, pixels"
          }
        },
        "required": [
          "x",
          "y",
          "w",
          "h"
        ]
      },
      "max_size": {
        "type": "integer",
        "description": "longest side of the image you receive, 256–1536 (default 1024)"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "list_commands",
  "kind": "answer",
  "impl": "imperative",
  "description": "Commands of the application menus (File, Edit, Project, Utilities, View, Help) with ids; run_command executes one.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "search": {
        "type": "string",
        "description": "words to look for"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "select",
  "kind": "act",
  "impl": "imperative",
  "description": "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).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "chain_id": {
        "type": "string",
        "description": "chain id or name"
      },
      "filter_id": {
        "type": "string",
        "description": "filter to select"
      },
      "show_input": {
        "type": "boolean",
        "description": "show the input instead of the output of the selected filter"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "go_to_frame",
  "kind": "act",
  "impl": "imperative",
  "description": "Move the active chain to a frame: absolute frame number, a relative step (delta) or a time in seconds.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "frame": {
        "type": "integer",
        "description": "frame number (0-based)"
      },
      "delta": {
        "type": "integer",
        "description": "frames to move forward (negative: back)"
      },
      "seconds": {
        "type": "number",
        "description": "time from the start, in seconds"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "playback",
  "kind": "act",
  "impl": "imperative",
  "description": "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.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "action": {
        "type": "string",
        "enum": [
          "play",
          "pause",
          "stop"
        ],
        "description": "what to do (omit to only change settings)"
      },
      "speed": {
        "type": "number",
        "description": "0.01 – 16"
      },
      "loop": {
        "type": "boolean",
        "description": "loop playback"
      },
      "in_out_only": {
        "type": "boolean",
        "description": "play only the In/Out range"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "set_view",
  "kind": "act",
  "impl": "imperative",
  "description": "Viewer: zoom (percent) or fit, and the display scaling (sharp = equal-size pixels, nearest, smooth). Display only — never changes the pixels.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "zoom_percent": {
        "type": "number",
        "description": "e.g. 100, 200, 400"
      },
      "fit": {
        "type": "boolean",
        "description": "fit the frame in the window"
      },
      "display": {
        "type": "string",
        "enum": [
          "sharp",
          "nearest",
          "smooth"
        ],
        "description": "display scaling"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "set_selection",
  "kind": "act",
  "impl": "imperative",
  "description": "Set (or clear with null) the selection rectangle on the Viewer — filters added afterwards use it as their region (crop, magnify, stabilization ROI…).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "rect": {
        "type": "object",
        "properties": {
          "x": {
            "type": "number",
            "description": "left, pixels"
          },
          "y": {
            "type": "number",
            "description": "top, pixels"
          },
          "w": {
            "type": "number",
            "description": "width, pixels"
          },
          "h": {
            "type": "number",
            "description": "height, pixels"
          }
        },
        "required": [
          "x",
          "y",
          "w",
          "h"
        ]
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "add_filter",
  "kind": "act",
  "impl": "imperative",
  "description": "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 render check. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "type": {
        "type": "string",
        "description": "filter type id or name (see list_filters)"
      },
      "params": {
        "type": "object",
        "description": "parameter values by key (see get_filter_schema)"
      },
      "chain_id": {
        "type": "string",
        "description": "chain id (default: active chain)"
      },
      "after_filter_id": {
        "type": "string",
        "description": "insert after this filter (default: after the selected filter)"
      },
      "index": {
        "type": "integer",
        "description": "insert at this position (1 = right after the loader)"
      }
    },
    "required": [
      "type"
    ]
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "set_filter_params",
  "kind": "act",
  "impl": "imperative",
  "description": "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).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "filter_id": {
        "type": "string",
        "description": "filter id (see get_state)"
      },
      "params": {
        "type": "object",
        "description": "parameter values by key"
      }
    },
    "required": [
      "filter_id",
      "params"
    ]
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "remove_filter",
  "kind": "act",
  "impl": "imperative",
  "description": "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).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "filter_id": {
        "type": "string",
        "description": "filter id"
      }
    },
    "required": [
      "filter_id"
    ]
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "move_filter",
  "kind": "act",
  "impl": "imperative",
  "description": "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).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "filter_id": {
        "type": "string",
        "description": "filter id"
      },
      "index": {
        "type": "integer",
        "description": "new position (≥ 1)"
      }
    },
    "required": [
      "filter_id",
      "index"
    ]
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "set_filter_enabled",
  "kind": "act",
  "impl": "imperative",
  "description": "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).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "filter_id": {
        "type": "string",
        "description": "filter id"
      },
      "enabled": {
        "type": "boolean",
        "description": "true to enable"
      }
    },
    "required": [
      "filter_id",
      "enabled"
    ]
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "reset_filter",
  "kind": "act",
  "impl": "imperative",
  "description": "Reset all parameters of a filter to their defaults. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "filter_id": {
        "type": "string",
        "description": "filter id"
      }
    },
    "required": [
      "filter_id"
    ]
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "duplicate_chain",
  "kind": "act",
  "impl": "imperative",
  "description": "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).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "chain_id": {
        "type": "string",
        "description": "default: active chain"
      },
      "name": {
        "type": "string",
        "description": "name of the copy"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "rename_chain",
  "kind": "act",
  "impl": "imperative",
  "description": "Rename a chain. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "chain_id": {
        "type": "string",
        "description": "chain id"
      },
      "name": {
        "type": "string",
        "description": "new name"
      }
    },
    "required": [
      "chain_id",
      "name"
    ]
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "delete_chain",
  "kind": "transact",
  "impl": "imperative",
  "description": "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).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "chain_id": {
        "type": "string",
        "description": "chain id"
      }
    },
    "required": [
      "chain_id"
    ]
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "set_in_out",
  "kind": "act",
  "impl": "imperative",
  "description": "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).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "in_frame": {
        "type": "integer",
        "description": "In point (null clears)"
      },
      "out_frame": {
        "type": "integer",
        "description": "Out point (null clears)"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "add_bookmark",
  "kind": "act",
  "impl": "imperative",
  "description": "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).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "frame": {
        "type": "integer",
        "description": "default: current frame"
      },
      "note": {
        "type": "string",
        "description": "what the frame shows"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "set_case_info",
  "kind": "act",
  "impl": "imperative",
  "description": "Fill in the case information printed in the report. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "case_number": {
        "type": "string",
        "description": ""
      },
      "exhibit": {
        "type": "string",
        "description": "exhibit / item"
      },
      "examiner": {
        "type": "string",
        "description": ""
      },
      "agency": {
        "type": "string",
        "description": "agency / laboratory"
      },
      "notes": {
        "type": "string",
        "description": ""
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "undo",
  "kind": "act",
  "impl": "imperative",
  "description": "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).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "steps": {
        "type": "integer",
        "description": "how many changes (default 1)"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "redo",
  "kind": "act",
  "impl": "imperative",
  "description": "Redo changes undone with undo. Changes the LUCID project (undoable; the examiner may have to approve it in LUCID).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "steps": {
        "type": "integer",
        "description": "how many (default 1)"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "load_sample_case",
  "kind": "act",
  "impl": "imperative",
  "description": "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).",
  "inputSchema": {
    "type": "object",
    "properties": {}
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "run_command",
  "kind": "act",
  "impl": "imperative",
  "description": "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).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "command id from list_commands"
      }
    },
    "required": [
      "id"
    ]
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "open_media",
  "kind": "act",
  "impl": "imperative",
  "description": "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 panel).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "kind": {
        "type": "string",
        "enum": [
          "media",
          "sequence",
          "project"
        ],
        "description": "media (default): a video or image; sequence: several images as frames; project: a saved project"
      },
      "reason": {
        "type": "string",
        "description": "why, in one sentence, shown to the user"
      }
    }
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "export",
  "kind": "act",
  "impl": "imperative",
  "description": "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 examiner at the LUCID window (a click in LUCID's AI panel).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "what": {
        "type": "string",
        "enum": [
          "images",
          "video",
          "snapshot",
          "report",
          "project"
        ],
        "description": "what to produce"
      },
      "format": {
        "type": "string",
        "description": "images/video only: tiff16 (default for images), tiff, tiff32f, png16, png, bmp, avi-raw (default for video), …"
      },
      "range": {
        "type": "string",
        "enum": [
          "current",
          "all",
          "inout"
        ],
        "description": "images/video: which frames (default: current frame for images, all for video)"
      },
      "start": {
        "type": "integer",
        "description": "first frame (overrides range)"
      },
      "end": {
        "type": "integer",
        "description": "last frame (overrides range)"
      },
      "name": {
        "type": "string",
        "description": "file name without extension"
      },
      "chain_id": {
        "type": "string",
        "description": "default: active chain"
      }
    },
    "required": [
      "what"
    ]
  },
  "page": "/ClearUFO-Forensics-Tool/"
}

{
  "name": "ask_user",
  "kind": "act",
  "impl": "imperative",
  "description": "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 panel).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "question": {
        "type": "string",
        "description": "the question"
      },
      "options": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "suggested answers (buttons); the user can also type"
      }
    },
    "required": [
      "question"
    ]
  },
  "page": "/ClearUFO-Forensics-Tool/"
}