LogoLogo
  • Seahaven
    • Seahaven Documentation
      • Setup Your Account
      • Getting Started
        • Prepare Your Models
          • Name Objects
          • Add Camera Curve to a scene
        • Import 3D Assets
        • Colormap Editor
        • Relationship Editor
          • Start Workflow
            • Workflow
            • Relationship
              • Relationship (Array)
          • Relationships
            • Placements
            • Locate
            • Rotate
            • Neighbour
            • Drop
            • Center
            • Scale
            • Align
            • Attach
            • Put
        • Simulation Editor
          • Workflow
            • Category Visibility Threshold
          • 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
            • Pose Objects
              • Pose Set
              • Pose Pair
            • Constrain Object
            • Add Particle System
            • Load Object Along Curve
            • Replace
              • View settings
              • Load child object
          • Output
            • Additional Annotation Settings
            • Color Map
            • Camera Ex/Intrinsics
            • Keypoints
            • Normal Map
            • Depth Map
          • Post-Processing
            • Visualize COCO Annotations
            • Shot Noise
            • Glare
            • Disable shadows
        • Running Simulation
        • Save and Import
    • Seahaven Tutorials
    • Errors and Alerts
  • Simulation Manager
    • Simulation Manager
  • Simulation API
    • Simulation Structure
      • Sample Configuration
    • Modules
      • Structure Modules
        • Generator Class
          • generator.Room
            • Submodule: RoomTextureLoader
            • Submodule: RoomLightLoader
            • How To Query Room Properties
            • Sample Room Configuration
        • Loader Class
          • loader.ObjectLoader
      • Placement Modules
        • Placement Class
          • placement.PlacementHandler
            • Placement Rules
              • Settings
      • Lighting Modules
        • Lighting Class
          • lighting.HdriLoader
          • lighting.LightLoader
      • Camera Modules
        • Camera Class
          • camera.CameraSampler
          • camera.RoomCamera
            • Submodule: proximity_checks
            • Submodule: default_cam_param
      • Output Modules
        • Renderer Class
          • renderer.MultiRenderer
            • Submodule: RgbRenderer
            • Submodule: InstanceRenderer
            • Submodule: SemanticRenderer
            • Submodule: DepthRenderer
            • Submodule: BoundingBoxWriter
  • Management API
    • RESTful API
    • Python API
      • Example
    • Python API (V4 - BETA)
      • 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
  • Overview
  • Initialization
  • setSimulation_id
  • setOrganization_id
Export as PDF
  1. Management API
  2. Python API (V4 - BETA)

Installation

To install the Lexset package, you can use the pip package manager. Open your command prompt or terminal and run the following command: Most recent version #:

4.2.9
pip install lexset

Overview

The simulation class is part of the Lexset package and is used to manage and interact with simulations. It has the following attributes:

  • user_id (str): The user ID.

  • token (str): The user's access token.

  • organization_id (int, optional): The organization ID. Defaults to None.

Initialization

To initialize the simulation class, first import it from the Lexset package:

from lexset import simulation

Then, provide a user ID and access token, and optionally an organization ID. If the organization ID is not provided, the default value will be 0, and a warning message will be displayed.

Example

token = "your_access_token"
userID = "your_user_id"
organizationID = 12345


sim = simulation(token, userID, organizationID)

Error Messages and Warnings

Warning message:

Organization ID not provided.
To set an organization ID, use the setOrganization_id method.

This warning occurs when the organizationID is not provided during the initialization of the simulation class. You can resolve this warning by either providing the organizationID during initialization or using the setOrganization_id method after the object is created.

setSimulation_id

This method sets the simulation ID for the simulation object.

Arguments

  • simulationID (int): The simulation ID.

Example

simulationID = 67890
sim.setSimulation_id(simulationID)

setOrganization_id

This method sets the organization ID for the simulation object.

Arguments

  • organizationID (int): The organization ID.

Example

new_organizationID = 54321
sim.setOrganization_id(new_organizationID)

By following the above examples and explanations, you can successfully install the Lexset package, initialize the simulation class, and set important information using the last two functions. Be aware of the possible warning messages, as they may indicate that certain inputs were not provided or need to be updated.

PreviousPython API (V4 - BETA)NextMerge Datasets

Last updated 11 months ago