Skip to content

Reference overlay

ReferenceOverlaySetting #

ReferenceOverlaySetting(value: bool = True)

Bases: RapidataSetting

Shows a single reference image over both image options, then reveals the edits. Annotators can toggle between the reference and edits. Use with compare tasks that have two image options and one image reference.

Supported task types: Compare.

Parameters:

Name Type Description Default
value bool

Whether to show the reference overlay. Defaults to True.

 True
Source code in src/rapidata/rapidata_client/settings/reference_overlay.py 
26
27
28
29
30
def __init__(self, value: bool = True):
    if not isinstance(value, bool):
        raise ValueError("The value must be a boolean.")

    super().__init__(key="reference_overlay", value=value)