Skip to content

imageio

ImageIOSettings

Bases: BaseSettingsModel

Hiero color management project settings.

Source code in server/settings/imageio.py
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
class ImageIOSettings(BaseSettingsModel):
    """Hiero color management project settings. """
    _isGroup: bool = True
    activate_host_color_management: bool = SettingsField(
        True, title="Enable Color Management"
    )
    file_rules: ImageIOFileRulesModel = SettingsField(
        default_factory=ImageIOFileRulesModel,
        title="File Rules"
    )
    workfile: WorkfileColorspaceSettings = SettingsField(
        default_factory=WorkfileColorspaceSettings,
        title="Workfile"
    )
    """# TODO: enhance settings with host api:
    - old settings are using `regexInputs` key but we
      need to rename to `regex_inputs`
    - no need for `inputs` middle part. It can stay
      directly on `regex_inputs`
    """
    regexInputs: RegexInputsModel = SettingsField(
        default_factory=RegexInputsModel,
        title="Assign colorspace to clips via rules"
    )

workfile = SettingsField(default_factory=WorkfileColorspaceSettings, title='Workfile') class-attribute instance-attribute

TODO: enhance settings with host api:

  • old settings are using regexInputs key but we need to rename to regex_inputs
  • no need for inputs middle part. It can stay directly on regex_inputs

WorkfileColorspaceSettings

Bases: BaseSettingsModel

Hiero workfile colorspace preset.

Source code in server/settings/imageio.py
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
class WorkfileColorspaceSettings(BaseSettingsModel):
    """Hiero workfile colorspace preset. """
    """# TODO: enhance settings with host api:
    we need to add mapping to resolve properly keys.
    Hiero is excpecting camel case key names,
    but for better code consistency we are using snake_case:

    ocio_config = ocioConfigName
    working_space_name = workingSpace
    int_16_name = sixteenBitLut
    int_8_name = eightBitLut
    float_name = floatLut
    log_name = logLut
    viewer_name = viewerLut
    thumbnail_name = thumbnailLut
    """

    ocioConfigName: str = SettingsField(
        title="OpenColorIO Config",
        description="Switch between OCIO configs",
        enum_resolver=ocio_configs_switcher_enum,
        conditionalEnum=True
    )
    workingSpace: str = SettingsField(
        title="Working Space"
    )
    viewerLut: str = SettingsField(
        title="Viewer"
    )
    eightBitLut: str = SettingsField(
        title="8-bit files"
    )
    sixteenBitLut: str = SettingsField(
        title="16-bit files"
    )
    logLut: str = SettingsField(
        title="Log files"
    )
    floatLut: str = SettingsField(
        title="Float files"
    )
    thumbnailLut: str = SettingsField(
        title="Thumnails"
    )
    monitorOutLut: str = SettingsField(
        title="Monitor"
    )