Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Deprecate various car types in favor of new alias TYPE_CAR #787

Merged
merged 2 commits into from
Apr 4, 2024
Merged

Deprecate various car types in favor of new alias TYPE_CAR #787

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c20ed4
Deprecate various car types in favor of new alias TYPE_CAR
pmai Mar 8, 2024
7b38bed
Review feedback rewording
pmai Mar 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions osi_object.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -764,10 +764,12 @@ message MovingObject
// other OpenX standards (in particular, OpenScenario 1.x and 2.x, and OpenLabel).
// This is primarily for historical reasons. Where a single type from a
// different standard can map to multiple OSI types it is left up to the
// discretion of the OSI implementer how that mapping is achieved. For example,
// a simulator may use the dimensions of a provided 3d model of a vehicle with type
// "car" in OpenScenario, to determine whether it should be a TYPE_SMALL_CAR or
// TYPE_MEDIUM_CAR in OSI.
// discretion of the OSI implementer how that mapping is achieved. In previous
// versions, for example, a simulator might have used the dimensions of a provided
// 3d model of a vehicle with type "car" in OpenScenario, to determine whether it
// should be a TYPE_SMALL_CAR or TYPE_MEDIUM_CAR in OSI. As part of the harmonization
// effort, it should now map to TYPE_CAR, which is an alias of the old TYPE_MEDIUM_CAR,
// and all other car type enums have been deprecated in favor of TYPE_CAR.
//
// \note Vehicle type classification is a complex area and there are no
// universally recognized standards. As such, the boundaries between some of the
Expand All @@ -778,6 +780,10 @@ message MovingObject
//
enum Type
{
// Allow aliases in enum
//
option allow_alias = true;

// Type of vehicle is unknown (must not be used in ground truth).
//
TYPE_UNKNOWN = 0;
Expand All @@ -790,24 +796,39 @@ message MovingObject
//
// Definition: Hatchback car with maximum length 4 m.
//
// \note Deprecated differentiation, use TYPE_CAR instead
//
TYPE_SMALL_CAR = 2;

// Vehicle is a compact car.
//
// Definition: Hatchback car with length between 4 and 4.5 m.
//
// \note Deprecated differentiation, use TYPE_CAR instead
//
TYPE_COMPACT_CAR = 3;

// Vehicle is a car.
//
// This is to be used for all car-like vehicles, without any
// further differentiated type available.
//
TYPE_CAR = 4;

// Vehicle is a medium car.
//
// Definition: Hatchback or sedan with length between 4.5 and 5 m.
//
// \note Deprecated differentiation, use the alias TYPE_CAR instead
//
TYPE_MEDIUM_CAR = 4;

// Vehicle is a luxury car.
//
// Definition: Sedan or coupe that is longer then 5 m.
//
// \note Deprecated differentiation, use TYPE_CAR instead
//
TYPE_LUXURY_CAR = 5;

// Vehicle is a delivery van.
Expand Down