Skip to content

settings

ExtractProductResourcesModel

Bases: BaseSettingsModel

Extract Product Resources.

Source code in server/settings.py
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
class ExtractProductResourcesModel(BaseSettingsModel):
    """Extract Product Resources.
    """
    profiles: list[ProductResourcesPresetModel] = SettingsField(
        default_factory=list,
        title="Profiles",
        description=(
            "Additional product resources profiles to be used in product "
            "resource extraction."
        )
    )

    @validator("profiles")
    def validate_unique_outputs(cls, value):
        ensure_unique_names(value)
        return value

MetadataMappingModel

Bases: BaseSettingsModel

Metadata mapping

Representation document context data are used for formatting of anatomy tokens. Following are supported: - version - task - asset

Source code in server/settings.py
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
class MetadataMappingModel(BaseSettingsModel):
    """Metadata mapping

    Representation document context data are used for formatting of
    anatomy tokens. Following are supported:
    - version
    - task
    - asset

    """
    name: str = SettingsField(
        "",
        title="Metadata property name"
    )
    value: str = SettingsField(
        "",
        title="Metadata value template"
    )

ProductResourcesPresetModel

Bases: BaseSettingsModel

Product Resources Preset.

Source code in server/settings.py
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
class ProductResourcesPresetModel(BaseSettingsModel):
    """Product Resources Preset."""
    name: str = SettingsField(
        "",
        title="Name"
    )
    task_types: list[str] = SettingsField(
        default_factory=list,
        title="Task types",
        enum_resolver=task_types_enum,
        section="Profile filtering",
    )
    task_names: list[str] = SettingsField(
        default_factory=list,
        title="Task names"
    )
    product_base_type: str = SettingsField(
        "editorial_pkg",
        title="Product base type",
        enum_resolver=_product_base_types_enum,
        conditional_enum=True
    )
    editorial_pkg: TimelineIntermediateFormatModel = SettingsField(
        default_factory=TimelineIntermediateFormatModel,
        title="Timeline Attributes",
    )
    plate: PlateFormatModel = SettingsField(
        default_factory=PlateFormatModel,
        title="Plate Attributes",
    )
    tags: list[str] = SettingsField(
        default_factory=list,
        title="Tags",
        enum_resolver=representation_tags_enum,
        description="Currently only partly supporting reviewable workflow.",
        section="Representation attributes",
    )
    custom_tags: list[str] = SettingsField(
        default_factory=list,
        title="Custom Tags",
        description=(
            "Ideal for additional filtering under Extract Review plugin.")
    )
    colorspace: str = SettingsField(
        "",
        title="Colorspace",
        description="The colorspace to be added to colorspace metadata."
    )