Open-Taxonomy-SUNRGBD Profile#

This document describes how to author a USD asset that conforms to the Open-Taxonomy-SUNRGBD profile.

Open-Taxonomy-SUNRGBD is an example profile that demonstrates labeling assets with the SUN RGB-D taxonomy instead of NVIDIA’s Wikidata Q-codes. It pairs the Core feature with one closed-vocabulary taxonomy feature (SUN.001). See Adding a custom taxonomy to build your own.

Profile definition#

The Open-Taxonomy-SUNRGBD profile includes the following feature set (see open_taxonomy_profiles.toml). Each feature’s requirements and dependencies are defined in the feature specifications.

[Open-Taxonomy-SUNRGBD]
"0.1.0" = {features = [
    {"FET_000_STANDARD" = {version = "0.1.0"}}, # Core
    {"FET_044_STANDARD" = {version = "0.1.0"}}, # SUN RGB-D Labels
]}

Required USD properties and schemas#

Stage metadata (required)#

  • defaultPrim must be set.

  • upAxis and metersPerUnit must be set on the stage.

Semantic labels (SUN RGB-D)#

  • Apply SemanticsLabelsAPI:sunrgbd to prims you want labeled with this taxonomy.

  • Author token[] semantics:labels:sunrgbd using SUN RGB-D class names (SUN.001).

  • Values are matched case-insensitively and tolerate _/- spacing and display-name/alias forms; a value that matches only after normalization passes with a warning suggesting the canonical name.

def Xform "Object" (
    prepend apiSchemas = ["SemanticsLabelsAPI:sunrgbd"]
)
{
    token[] semantics:labels:sunrgbd = ["bed", "chair"]
}

Validation metadata#

When validation is stamped into the asset, the validator records the result under customLayerData["SimReady_Metadata"]["validation"]. Search for validated_features to inspect the dated validation result and the feature IDs and versions that were checked.

The result has this general shape:

customLayerData = {
    "SimReady_Metadata" = {
        "validation" = {
            "validated_features" = {
                "<YYYY-MM-DD>" = {
                    "FET_044_STANDARD" = {
                        "version" = "0.1.0"
                        "passed" = true
                    }
                }
            }
        }
    }
}

References#

  • docs/profiles/open_taxonomy_profiles.toml

  • docs/features/FET_044_STANDARD.md

  • docs/capabilities/dataset_taxonomies/capability-dataset_taxonomies.md

  • docs/guides/adding_a_custom_taxonomy.md