LogoLogo
  • Seahaven
    • Seahaven Documentation
      • Set Up Your Account
      • Getting Started
        • Prepare Your Models
          • Name Objects
          • Add Camera Curve to a scene
        • Import 3D Assets
        • Relationship Editor
          • Workflow
          • Relationship
          • Relationship (Array)
          • Relationships
            • Placements
            • Locate
            • Rotate
            • Neighbour
            • Drop
            • Center
            • Scale
            • Align
            • Attach
            • Put
        • Simulation Editor
          • Workflow
          • Scene
            • 3D Asset
            • HDRI Lighting
            • Physical Sun/Sky
            • Ground Plane
            • Interior Scene
            • Room Type
          • Relationships
            • Load Relationships
          • Camera
            • Camera Configuration
            • Animated Track Camera
            • Curve-Based Camera
            • Room-Perimeter Camera
              • Category
            • Room-Based Camera
              • Additional Cameras
            • Position Camera
              • Conical
              • Spherical
              • Cubic
            • Orientation
              • Calculate Area of Interest
              • Point
            • Perspectival Camera Properties
            • Fisheye Camera Properties
          • Manipulators
            • Camera Manipulators
              • Override Camera Target
              • Override Camera Position
              • Near IR (Approximation)
              • Track Camera to Object
                • Camera Path Settings
            • Light Manipulators
              • Randomize HDRI Background
              • Modify Light Strength
              • Place Lights
                • Light Object (Bbox)
                • Light Object (Polar)
            • Material Manipulators
              • Randomize Material Color
              • Randomize Material Properties
              • Swap Materials
                • Import Material
                • Replace Material
                • Weighted Material
            • Delete Objects by Name
            • Filter Objects/Annotations
            • Pose Objects
              • Pose Set
              • Pose Pair
            • Constrain Object
            • Add Particle System
            • Load Object Along Curve
            • Replace
              • View settings
              • Load child object
          • Render Passes
            • RGB Image
              • Compositing
                • Blur
                • Shot Noise
                • Glare
                • Thermal
            • RGB Image (No Shadow)
            • RGB Image (Isolated Foreground)
            • Segmentation Map
            • Thermal Image
            • Depth Pass
            • Normals
            • Binary Segmentation
              • Material-Based Segmentation
              • Compositing-Based Segmentation
          • Output Files
            • COCO Annotations
            • Keypoints
            • Camera Ex/Intrinsics
        • Running Simulation
        • Save and Import
    • Seahaven Tutorials
    • Errors and Alerts
  • Simulation Manager
    • Simulation Manager
  • Simulation API
    • Simulation Structure
      • YAML Export
      • Sample Configuration
  • Management API
    • Python Package
      • Installation
      • Merge Datasets
      • Methods
      • Dataset Analysis
      • Compression Artifacts
      • Domain Matching
      • Credentials
  • API Tutorials
    • Residential Interior Simulation
      • Upload Your Placement Rules
      • Modifying Your Camera
      • Modify Placement Rules
      • Run your Simulation
      • Tutorial Materials
        • Pipeline Configuration
        • Placement Rules
          • bedroom1.yaml
          • bedroom2.yaml
          • livingroom.yaml
          • floorPlan.yaml
Powered by GitBook
On this page
Export as PDF
  1. API Tutorials
  2. Residential Interior Simulation

Upload Your Placement Rules

PreviousResidential Interior SimulationNextModifying Your Camera

Last updated 3 years ago

CtrlK

To successfully complete this tutorial we will need to upload the placement rules that our simulation will reference. In the section of this documentation titled "Simulation Structure," we review all the various components of your simulation in detail.

Upload placement rules with python

Lexset maintains a python package that is designed to help you manage your simulations and integrate synthetic data into your existing data pipeline.

Install the lexsetAPI python package with pip.

pip install lexsetAPI==1.2.5

Then you will locate the local folder where your placement rules are stored.

placementRulePath = "./placement_rules/"
placementRule = "livingroom_coreweave.yaml"

Next, you will upload the placement rules to the Lexset cloud.

lexset.addRules(<YOUR USER ID>,placementRule,placementRulePath)

This is what your python script should look like.

Note: Your user ID is available on your account page. See "Setup Your Account" for more information.

import lexsetAPI as lexset

placementRulePath = "./placement_rules/"
placementRule = "livingroom_coreweave.yaml"

lexset.addRules(<YOUR USER ID>,placementRule,placementRulePath)

If successful the function will print the file path on our cloud for you to use in your pipeline configuration.

{"filepaths":["/general/lexset/Seahaven3/Users/3/PlacementRules/livingroom_coreweave.yaml"]}

Try to repeat this for each of the placement rules.