Creating Curb Objects #126

jacobmalleau · 2023-11-20T01:20:16Z

Explain pull request

First commit / defining Curb Object

Is this a breaking change

No, not breaking

Impacted Spec

Which API(s) will this pull request impact?

Curbs
Events
Metrics

Additional context

Add any other context or screenshots about the feature request here.

First commit / defining Curb Object

CLAassistant · 2023-11-20T01:20:22Z

All committers have signed the CLA.

- Note centroid of object - Note positive and negative distances - Start to populate type specific attributes

Updated language around Object Type Attributes based on latest discussions. It omits details on specific attributes for future versions of the spec.

curbs/README.md

schnuerle · 2024-11-05T19:01:52Z

curbs/README.md

+| ------ | ------ | ------------------- | ------------- |
+| `curb_object_id` | [UUID][uuid] | Required | The ID of the curb object. |
+| `geometry` | [Point][point] | Required |The spatial location of this curb object location. This can represent the approximate center of the object, or the centroid location of the object, depending on its size and shape. |
+| `curb_zone_id` | [UUID][uuid] | Conditionally Required | The ID of the Curb Zone this object is related to. The geometry of the specified Curb Zone does not need to directly relate to the geometry of this object. Either a Zone or Space ID is required for an Object. |


The curb_zone_id description should reflect the idea that the object's physical location is nearest to this zone. Similarly with curb_space_id below.

Added in latest commit

It would be great to also be able to relate the object to a policy id for signs.

To @felixir's point, INRIX has a specific implementation underway that relates sign assets to policies

Ah so adding a policy_id to the curb object defintion? I guess that makes some sense, if the object at a curb zone is a sign that has one description on it and that aligns to just one policy. But most curb zone policies are not defined by just one sign? I'm not sure it's needed to do this, since the zone is connected to a policy already, and this would apply just one type of object, signage. Could you give us some use cases and reasons why you would need the policy_id field in an Object?

Yeah, I know we thought that you could relate the object to the policy through the curb zone. Similar to how events can be related to policies through the curb zone.

See the new curb_policy_id field @felixir @Mu-yi-Zhou @alexdemisch @mschwartzie and give feedback on this

See meeting notes for additional context.

jacobmalleau

Left comments throughout with items addressed in my latest commit

felixir · 2024-11-09T01:34:04Z

curbs/README.md

+| Name   | Type   | Required/Optional   | Description   |
+| ------ | ------ | ------------------- | ------------- |
+| `curb_object_id` | [UUID][uuid] | Required | The ID of the curb object. |
+| `geometry` | [Point][point] | Required |The spatial location of this curb object location. This can represent the approximate center of the object, or the centroid location of the object, depending on its size and shape. |


It would be great to have this be more flexible and allow line and polygon for objects like bike racks and bus stops. This would simplify the need for linear distance, max length, and object shape.

This point represents a required field.

We also have an optional object_shape field below which is for polygons.

I don't think lines work in the context of defining where objects area (though you could argue they do with curb zones, but that's not the scope of this).

See the new object_line field @felixir @Mu-yi-Zhou @alexdemisch and give feedback on this

Mu-yi-Zhou · 2024-11-14T16:08:49Z

Is Object Type Enum or free-form? If Enum, will be good to keep custom attributes or even a comment/description fields. Example user case - some assets in our database are owned by other city department or private developer, we need a filed to note that.

schnuerle · 2024-11-19T02:56:52Z

curbs/README.md

@@ -263,6 +308,7 @@ A Curb Zone is represented as a JSON object, whose fields are as follows:
 | `entire_roadway`| Boolean | Optional | If "true", this curb location takes up the entire width of the roadway (which may be impassible for through traffic when the Curb Zone is being used for parking or loading). This is a common condition for alleyways. If `entire_roadway` is `true`, `street_side` MUST NOT be present. |
 | `curb_area_ids`| Array of [UUID][uuid] | Optional | The ID(s) of the [Curb Areas](#curb-area) that this Curb Zone is a part of. If specified, the areas identified MUST be retrievable through the Curb API and its geographical area MUST contain that of the Curb Zone. |
 | `curb_space_ids`| Array of [UUID][uuid] | Optional | The ID(s) of the [Curb Spaces](#curb-space) that this Curb Zone contains. If specified, the spaces identified MUST be retrievable through the Curb API and its geographical area MUST be contained in this Curb Zone. |
+| `curb_object_ids` | Array of [UUID][uuid] | Optional | The ID(s) of the [Curb Objects](#curb-object) that this Curb Zone is related to, in particular what Objects are in the Zone's areas of influence. For example, a pay station being used for multiple paid parking zones, a locker for a commercial loading zone, or a camera monitoring several zones. If specified, the objects identified MUST be retrievable through the Curb API. Curb Objects can be related to a Curb Space or a Curb Zone. |


Flagging this update for review

schnuerle · 2024-11-19T02:57:12Z

curbs/README.md

@@ -317,6 +363,7 @@ A Curb Space is represented as a JSON object whose fields are as follows:
 | `published_date` | [Timestamp][ts] | Required | The date/time that this curb area was first published in this data feed. |
 | `last_updated_date` | [Timestamp][ts] | Required | The date/time that the properties of ths curb area were last updated. This helps consumers know that some fields may have changed. |
 | `curb_zone_id` | [UUID][uuid] | Required | The ID of the Curb Zone this space is within. The geometry of the specified Curb Zone MUST contain the geometry of this space. |
+| `curb_object_ids` | Array of [UUID][uuid] | Conditionally Required | The ID(s) of the [Curb Objects](#curb-object) that this Curb Space is related to, in particular what Objects are in the Space's areas of influence. For example, a meter being used for two paid parking spcaes, a locker for a commercial loading space, or a camera monitoring several spaces. If specified, the objects identified MUST be retrievable through the Curb API. Curb Objects can be related to a Curb Space or a Curb Zone.|


Flagging this update for review and comment.

schnuerle · 2024-11-19T03:04:11Z

Is Object Type Enum or free-form? If Enum, will be good to keep custom attributes or even a comment/description fields. Example user case - some assets in our database are owned by other city department or private developer, we need a filed to note that.

Hi @Mu-yi-Zhou - The Curb Object object has lots of these freeform fields now as you can see here: name, description, owner, operator, external object id, external URL. I think these cover your use case.

schnuerle · 2024-11-19T03:09:04Z

Hi everyone, please take a look at the latest unresolved comments and things for review and leave your thoughts.

schnuerle · 2024-11-20T21:41:31Z

The only things open for final consensus are now:

Do we need an optional polyline for objects, and what is the use case for this?
Should we add a policy_id field to objects, or does its connection to Zones and therefore policy_ids that way sufficient?
Review of the updated language clarifying how curb_object_ids are defined

alexdemisch · 2024-11-20T22:04:46Z

Re: (1), a polyline would be helpful to represent curb paint, which we are planning to store as an asset/curb object, and represent as a line feature.

Mu-yi-Zhou · 2024-11-21T01:20:19Z

Should we add a policy_id field to objects, or does its connection to Zones and therefore policy_ids that way sufficient? Having policy_id in Curb Object is useful. Although we can link a object with curb_zone then with policy, a curb zone can be associated with several policies.

schnuerle · 2024-11-21T16:56:59Z

curbs/README.md

+| `geometry` | [Point][point] | Required |The spatial location of this curb object location. This can represent the approximate center of the object, or the centroid location of the object, depending on its size and shape. |
+| `curb_zone_id` | [UUID][uuid] | Conditionally Required | The ID of the Curb Zone this object is physically in or closest to. The geometry of the specified Curb Zone does not need to directly relate to the geometry of this object. Either a Zone or Space ID is required for an Object. |
+| `curb_space_id` | [UUID][uuid] | Conditionally Required | The ID of the Curb Space this object is physically in or closest to. The geometry of the specified Curb Space does not need to directly relate to the geometry of this object. Either a Zone or Space ID is required for an Object. |
+| `curb_policy_id` | [UUID][uuid] | Optional | ID of [Policy object](#policy) that is directly associcated with this curb object. For example, `signage` or `paint` that relates to a single policy. |


See the new curb_policy_id field @felixir @Mu-yi-Zhou @alexdemisch and give feedback on this

bhamlinSDOT · 2024-11-26T21:10:53Z

Re: (1), a polyline would be helpful to represent curb paint, which we are planning to store as an asset/curb object, and represent as a line feature.

@alexdemisch Can you explain more of the use cases for why you want curb paint represented in CDS? SDOT also has several curb paint colors associated with our regulations but I've never thought about listing the colors in CDS until I read your comment. Seems like important to have noted in asset mgmt. system but feels different than say a sign object listed in CDS. Curious your thoughts.

alexdemisch · 2024-12-03T00:41:12Z

@bhamlinSDOT We plan to link regulations to the assets that define them to help maintain the data. In some cases, we only define regulations through curb paint, so having a line feature would help us do that.

Your comment just made me realize that we don't have anywhere to store the actual color of the curb paint in CDS. I suppose that's fine for now as we'll have the linkage to the internal asset_id via the external_object_id field. If we decide to expand on object attributes, it could go there. Admittedly, the asset/regulation linkage might only be useful for internal purposes, but not sure.

jacobmalleau · 2024-12-09T14:07:03Z

The main issue I see with adding a polyline option is that your Curb Objects dataset would then have both point and linear data which would make the data not compatible in GIS software unless separated out.
A work around would be to have an additional polyline attribute to store the line geometry, but still having a point represent the object.

schnuerle · 2024-12-09T19:44:54Z

The main issue I see with adding a polyline option is that your Curb Objects dataset would then have both point and linear data which would make the data not compatible in GIS software unless separated out. A work around would be to have an additional polyline attribute to store the line geometry, but still having a point represent the object.

@jacobmalleau It seems like this PR supports your workaround idea. Can you explain why it's a workaround in your estimation? It seems as written there is a required point for every object, and there is an optional polyline field. So it is separated out. How does that create compatibility issues with GIS software?

schnuerle · 2024-12-10T02:56:41Z

Pushed to dev branch as is. Please continue the conversation here.

If needed we can make a new Issue or PR now to address suggested changes to dev before the 1.1 release starts the OMF approval process, at a later date.

Update README.md

bb4b9e1

First commit / defining Curb Object

jacobmalleau requested a review from a team as a code owner November 20, 2023 01:20

schnuerle added enhancement New feature or request Curbs API Events API Metrics API schema Implications for the OpenAPI Schema labels Nov 20, 2023

schnuerle changed the base branch from feature-curb-objects to dev November 20, 2023 15:56

schnuerle marked this pull request as draft November 20, 2023 15:59

schnuerle linked an issue Nov 20, 2023 that may be closed by this pull request

Add Curb Objects #123

Closed

schnuerle mentioned this pull request Nov 20, 2023

Add Curb Objects #123

Closed

jacobmalleau and others added 18 commits November 20, 2023 16:47

Update Curb Object Attributes

b33b523

Added object basic properties, well known types, TOC

6adbdbb

Add Objects to Zones and Spaces

5041899

Added more and sorted object types

117e43b

Add objects to events

c43e9de

Adding Objects to Metrics

dbf8bdf

Address Some Comments from Working Group Meeting

864dbe3

- Note centroid of object - Note positive and negative distances - Start to populate type specific attributes

Adding Point GeoJSON

7bb63d1

Add object owner, external id/URL

bed2a3d

Added object endpoints

0f054ff

Added Object Type Attributes

5be93ae

Add operator field & space/zone endpoint parameters

56cf45a

Merged object attributes to types

baacbda

Rearranged required object fields

bc18f7a

Added object shape

0f540e0

Removed duplicate geometry field

399956b

Update README.md

3df4f23

Updated language around Object Type Attributes based on latest discussions. It omits details on specific attributes for future versions of the spec.

Added Objects to Event Endpoints

dce17a8

schnuerle reviewed Nov 5, 2024

View reviewed changes

curbs/README.md Outdated Show resolved Hide resolved

schnuerle reviewed Nov 5, 2024

View reviewed changes

curbs/README.md Outdated Show resolved Hide resolved

schnuerle reviewed Nov 5, 2024

View reviewed changes

This was referenced Nov 5, 2024

Relational Curb Object, Curb Zone, and Curb Policy (1-to-1 or 1-to-many) #152

Open

Need to add a "Device" attribute to the Curbs API to define devices used in CDS. #147

Open

Updates to Curb Objects Based on October 29th CDS Meeting

c8f5dc0

See meeting notes for additional context.

jacobmalleau commented Nov 7, 2024

View reviewed changes

felixir reviewed Nov 9, 2024

View reviewed changes

schnuerle reviewed Nov 19, 2024

View reviewed changes

schnuerle marked this pull request as ready for review November 20, 2024 21:47

schnuerle added 4 commits November 21, 2024 11:44

Adding policy id and polyline options for Objects

cac00a3

Added LineString geometry type

c5cc192

Updated polyline to linestring for spec consistency

61f0436

Typo in curb_policy_id type

710719b

schnuerle reviewed Nov 21, 2024

View reviewed changes

Updated the curb object <-> policy relationship description

bd922a4

schnuerle added the SMART Collaborative Idea coming from the OMF USDOT SMART grant collaborative. label Nov 21, 2024

schnuerle merged commit 6e5ed1d into dev Dec 10, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Creating Curb Objects #126

Creating Curb Objects #126

jacobmalleau commented Nov 20, 2023 •

edited by schnuerle

Loading

CLAassistant commented Nov 20, 2023 •

edited

Loading

schnuerle Nov 5, 2024

jacobmalleau Nov 7, 2024

felixir Nov 9, 2024

mschwartzie Nov 12, 2024

schnuerle Nov 19, 2024

jacobmalleau Nov 19, 2024 •

edited

Loading

schnuerle Nov 21, 2024

jacobmalleau left a comment

felixir Nov 9, 2024 •

edited

Loading

schnuerle Nov 19, 2024

schnuerle Nov 21, 2024 •

edited

Loading

Mu-yi-Zhou commented Nov 14, 2024

schnuerle Nov 19, 2024

schnuerle Nov 19, 2024

schnuerle commented Nov 19, 2024

schnuerle commented Nov 19, 2024

schnuerle commented Nov 20, 2024

alexdemisch commented Nov 20, 2024

Mu-yi-Zhou commented Nov 21, 2024

schnuerle Nov 21, 2024

bhamlinSDOT commented Nov 26, 2024

alexdemisch commented Dec 3, 2024

jacobmalleau commented Dec 9, 2024

schnuerle commented Dec 9, 2024

schnuerle commented Dec 10, 2024

Creating Curb Objects #126

Creating Curb Objects #126

Conversation

jacobmalleau commented Nov 20, 2023 • edited by schnuerle Loading

Explain pull request

Is this a breaking change

Impacted Spec

Additional context

CLAassistant commented Nov 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jacobmalleau Nov 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jacobmalleau left a comment

Choose a reason for hiding this comment

felixir Nov 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

schnuerle Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Mu-yi-Zhou commented Nov 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

schnuerle commented Nov 19, 2024

schnuerle commented Nov 19, 2024

schnuerle commented Nov 20, 2024

alexdemisch commented Nov 20, 2024

Mu-yi-Zhou commented Nov 21, 2024

Choose a reason for hiding this comment

bhamlinSDOT commented Nov 26, 2024

alexdemisch commented Dec 3, 2024

jacobmalleau commented Dec 9, 2024

schnuerle commented Dec 9, 2024

schnuerle commented Dec 10, 2024

jacobmalleau commented Nov 20, 2023 •

edited by schnuerle

Loading

CLAassistant commented Nov 20, 2023 •

edited

Loading

jacobmalleau Nov 19, 2024 •

edited

Loading

felixir Nov 9, 2024 •

edited

Loading

schnuerle Nov 21, 2024 •

edited

Loading