dataset_object
DatasetObject
Bases: USDObject
DatasetObjects are instantiated from a USD file. It is an object that is assumed to come from an iG-supported dataset. These objects should contain additional metadata, including aggregate statistics across the object's category, e.g., avg dims, bounding boxes, masses, etc.
Source code in omnigibson/objects/dataset_object.py
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 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 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 |
|
avg_obj_dims
property
Get the average object dimensions for this object, based on its category
Returns:
Type | Description |
---|---|
None or dict: Average object information based on its category |
base_link_offset
property
Get this object's native base link offset
Returns:
Type | Description |
---|---|
3-array: (x,y,z) base link offset if it exists |
bddl_object_scope
property
writable
Returns:
Type | Description |
---|---|
None or str: If specified, BDDL object scope name (e.g. chip.n.04_2) to assign to this object |
heights_per_link
property
Gets this object's heights per link information, if it exists
Returns:
Type | Description |
---|---|
None or dict: Nested dictionary of object's height per link information if it exists, else None |
in_rooms
property
writable
Returns:
Type | Description |
---|---|
None or list of str: If specified, room(s) that this object should belong to |
metadata
property
Gets this object's metadata, if it exists
Returns:
Type | Description |
---|---|
None or dict: Nested dictionary of object's metadata if it exists, else None |
native_bbox
property
Get this object's native bounding box
Returns:
Type | Description |
---|---|
3-array: (x,y,z) bounding box |
native_link_bboxes
property
Returns:
Name | Type | Description |
---|---|---|
dict | Keyword-mapped native bounding boxes for each link of this object |
orientations
property
Returns:
Type | Description |
---|---|
None or dict: Possible orientation information for this object, if it exists. Otherwise, returns None |
scaled_bbox_center_in_base_frame
property
where the base_link origin is wrt. the bounding box center. This allows us to place the model correctly since the joint transformations given in the scene USD are wrt. the bounding box center. We need to scale this offset as well.
Returns:
Type | Description |
---|---|
3-array: (x,y,z) location of bounding box, with respet to the base link's coordinate frame |
scales_in_link_frame
property
dict: Keyword-mapped relative scales for each link of this object
__init__(name, usd_path=None, prim_path=None, category='object', model=None, class_id=None, uuid=None, scale=None, visible=True, fixed_base=False, visual_only=False, self_collisions=False, prim_type=PrimType.RIGID, load_config=None, abilities=None, include_default_states=True, bounding_box=None, fit_avg_dim_volume=False, in_rooms=None, bddl_object_scope=None, **kwargs)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
Name for the object. Names need to be unique per scene |
required |
usd_path |
None or str
|
If specified, global path to the USD file to load. Note that this will override @category + @model! |
None
|
prim_path |
None or str
|
global path in the stage to this object. If not specified, will automatically be
created at /World/ |
None
|
category |
str
|
Category for the object. Defaults to "object". |
'object'
|
model |
None or str
|
if @usd_path is not specified, then this must be specified in conjunction with @category to infer the usd filepath to load for this object, which evaluates to the following:
|
None
|
class_id |
None or int
|
What class ID the object should be assigned in semantic segmentation rendering mode. If None, the ID will be inferred from this object's category. |
None
|
uuid |
None or int
|
Unique unsigned-integer identifier to assign to this object (max 8-numbers). If None is specified, then it will be auto-generated |
None
|
scale |
None or float or 3-array
|
if specified, sets either the uniform (float) or x,y,z (3-array) scale for this object. A single number corresponds to uniform scaling along the x,y,z axes, whereas a 3-array specifies per-axis scaling. |
None
|
visible |
bool
|
whether to render this object or not in the stage |
True
|
fixed_base |
bool
|
whether to fix the base of this object or not |
False
|
visual_only |
bool
|
Whether this object should be visual only (and not collide with any other objects) |
False
|
self_collisions |
bool
|
Whether to enable self collisions for this object |
False
|
prim_type |
PrimType
|
Which type of prim the object is, Valid options are: {PrimType.RIGID, PrimType.CLOTH} |
PrimType.RIGID
|
load_config |
None or dict
|
If specified, should contain keyword-mapped values that are relevant for loading this prim at runtime. |
None
|
abilities |
None or dict
|
If specified, manually adds specific object states to this object. It should be a dict in the form of {ability: {param: value}} containing object abilities and parameters to pass to the object state instance constructor. |
None
|
include_default_states |
bool
|
whether to include the default object states from @get_default_states |
True
|
bounding_box |
None or 3-array
|
If specified, will scale this object such that it fits in the desired (x,y,z) object-aligned bounding box. Note that EITHER @bounding_box or @scale may be specified -- not both! |
None
|
fit_avg_dim_volume |
bool
|
whether to fit the object to have the same volume as the average dimension while keeping the aspect ratio. Note that if this is set, it will override both @scale and @bounding_box |
False
|
in_rooms |
None or list
|
If specified, sets the rooms that this object should belong to |
None
|
bddl_object_scope |
None or str
|
If specified, should set the BDDL object scope name, e.g. chip.n.04_2 |
None
|
kwargs |
dict
|
Additional keyword arguments that are used for other super() calls from subclasses, allowing for flexible compositions of various object subclasses (e.g.: Robot is USDObject + ControllableObject). |
{}
|
Source code in omnigibson/objects/dataset_object.py
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
|
get_base_aligned_bbox(link_name=None, visual=False, xy_aligned=False, fallback_to_aabb=False, link_bbox_type='axis_aligned')
Get a bounding box for this object that's axis-aligned in the object's base frame.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
link_name |
None or str
|
If specified, only get the bbox for the given link |
None
|
visual |
bool
|
Whether to aggregate the bounding boxes from the visual meshes. Otherwise, will use collision meshes |
False
|
xy_aligned |
bool
|
Whether to align the bounding box to the global XY-plane |
False
|
fallback_to_aabb |
bool
|
If set and a link's info is not found, the (global-frame) AABB will be dynamically computed directly from omniverse |
False
|
link_bbox_type |
str
|
Which type of link bbox to use, "axis_aligned" means the bounding box is axis-aligned to the link frame, "oriented" means the bounding box has the minimum volume |
'axis_aligned'
|
Returns:
Type | Description |
---|---|
4-tuple: - 3-array: (x,y,z) bbox center position in world frame - 3-array: (x,y,z,w) bbox quaternion orientation in world frame - 3-array: (x,y,z) bbox extent in world frame - 3-array: (x,y,z) bbox center in desired frame |
Source code in omnigibson/objects/dataset_object.py
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
|
sample_orientation()
Samples an orientation in quaternion (x,y,z,w) form
Returns:
Type | Description |
---|---|
4-array: (x,y,z,w) sampled quaternion orientation for this object, based on self.orientations |
Source code in omnigibson/objects/dataset_object.py
set_bbox_center_position_orientation(position=None, orientation=None)
Sets the center of the object's bounding box with respect to the world's frame.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
position |
None or 3-array
|
The desired global (x,y,z) position. None means it will not be changed |
None
|
orientation |
None or 4-array
|
The desired global (x,y,z,w) quaternion orientation. None means it will not be changed |
None
|