Creating data mapping documents: Quick Reference — Data Exchange (NVIDIA-Certified Professional: OpenUSD Development)

Creating Data Mapping Documents — Quick Reference

Data mapping documents are essential tools in the OpenUSD data exchange process, enabling clear and structured translation between source data formats and USD schemas. This quick reference summarizes the key facts, definitions, and rules for creating effective data mapping documents within the scope of NVIDIA-Certified Professional: OpenUSD Development.

Key Definitions

• Data Mapping Document: A structured specification that defines how data fields from an external format correspond to USD schema attributes and prims.
• Source Format: The original data format or pipeline stage from which data is imported or to which data is exported.
• USD Schema: The standardized set of classes and attributes defined by OpenUSD to represent 3D scene data.
• Importer: A tool or script that reads source data and converts it into USD format using the mapping document.
• Exporter: A tool or script that writes USD data back into a target format based on the mapping document.

Core Components of a Data Mapping Document

• Field Mapping: Defines the correspondence between source fields and USD attributes/prims.
• Data Type Conversion: Specifies conversions needed between source data types and USD attribute types (e.g., float to double, string to token).
• Hierarchy Mapping: Describes how source data hierarchy maps to USD scenegraph hierarchy (parent-child relationships).
• Metadata Handling: Details how to map source metadata to USD metadata fields.
• Default Values and Fallbacks: Defines defaults for missing or optional source data fields.

Rules for Creating Effective Data Mapping Documents

1. Clarity and Precision: Use unambiguous field names and USD schema references to avoid confusion.
2. Consistency: Maintain uniform naming conventions and data type usage throughout the document.
3. Completeness: Cover all relevant source fields and USD attributes necessary for the pipeline stage.
4. Extensibility: Design mappings to accommodate future schema updates or source format changes.
5. Validation: Include examples or test cases to verify the correctness of mappings.

Typical Structure of a Data Mapping Document

• Header: Document title, version, author, and date.
• Source Format Description: Summary of the source data format and its key elements.
• USD Schema Reference: List of USD prim types and attributes involved.
• Field Mappings Table: Tabular or structured list showing source field, USD target, data type conversions, and notes.
• Hierarchy Mapping: Diagram or description of scenegraph structure mapping.
• Metadata Mappings: Details on metadata translation.
• Examples: Sample data snippets illustrating mapping usage.

Best Practices

• Use standardized formats such as JSON or YAML for machine-readable mapping documents.
• Document assumptions and limitations explicitly.
• Collaborate with pipeline engineers and artists to ensure practical applicability.
• Keep mapping documents version-controlled alongside importer/exporter code.

Additional Resources

• Pixar USD Documentation – Official USD schema and API reference.
• NVIDIA OpenUSD Developer Resources – Tools and guides for OpenUSD development.

More in this topic

Creating data mapping documents: Practice Questions — Data Exchange (NVIDIA-Certified Professional: OpenUSD Development)Scripting OpenUSD data interchange — Data Exchange (NVIDIA-Certified Professional: OpenUSD Development)Building custom importers and exporters — Data Exchange (NVIDIA-Certified Professional: OpenUSD Development)Data Exchange — NVIDIA-Certified Professional: OpenUSD DevelopmentCreating data mapping documents: Worked Example — Data Exchange (NVIDIA-Certified Professional: OpenUSD Development)Creating data mapping documents: Common Mistakes — Data Exchange (NVIDIA-Certified Professional: OpenUSD Development)Creating data mapping documents — Data Exchange (NVIDIA-Certified Professional: OpenUSD Development)