mark-mockett
commented
2 years ago @DeraldDudley I'm not sure about splitting the components of the IncidentFeed between multiple PRs from an implementation point. If you do keep them separate, you should merge the commits from this branch into those so that the IncidentType enumerations are shown in context.
Also, for completeness this PR should add a new schema file for the IncidentFeed and add the IncidentRoadEvent to the RoadEventFeature schema. Let me know if you want any help making these changes - happy to assist as needed.
DeraldDudley
j-d-b
Summary
Add an Incident Road Feed
Motivation
Adding an incident Road Feed enables publishers to inform drivers about events that close or restricts the use of road segments. This is valuable because it reduces driver uncertainty and increases the probability of driver success. It also fulfills use cases identified by WZDx working group members and state transportation officials. These use cases include informing citizens about road closures after a hurricane and informing transportation management centers about road status during emergencies.
Adding incidents will bolster the specifications usefulness. A more useful specification is more likely to be implemented. More implementations inform more drivers about hazards to navigation. Better informed drivers avoid hazards resulting in safer, cleaner, and more efficient transportation.
IncidentRoadEvents vs WorkZoneRoadEvents
IncidentRoadEvents are very similar to WorkZoneRoadEvent. They are different in the following ways:
type_of_workis dropped from the IncidentRoadEvent object.end_dateis optional in IncidentRoadEvent object.type_of_incidentis created for the IncidentRoadEvent object. Incident types are described using incident enumerations.Changes
RoadIncidentFeed Object (GeoJSON FeatureCollection)
The
RoadIncidentFeedobject is the root (highest level) object of a WZDx road incident feed. There is oneRoadIncidentFeedobject per road incident feed GeoJSON document. TheRoadIncidentFeedis a GeoJSON FeatureCollection.The
RoadIncidentFeedinforms drivers about the location of roadway incidents. Incident types are described bytype_of_incidentenumerations.Properties
feed_infotype"FeatureCollection"FeatureCollection.featuresbboxUsed By
Road Restriction GeoJSON document (one
RoadIncidentFeedobject per file).RoadEventFeature Object (GeoJSON Feature)
The
RoadEventFeatureobject is the container object for a WZDx road event (WorkZoneRoadEvent, DetourRoadEvent, RestrictionRoadEvent, RestrictionRoadEvent). TheRoadEventFeatureobject is an instance of a GeoJSON Feature.Properties
idtype"Feature"Feature.propertiesgeometrytypeof LineString or MultiPointtypeproperty MUST be LineString or MultiPoint.LineStringallows specifying the entire road event path and should be preferred.MultiPointshould be used when only the start and end coordinates are known.bbox2nwherenis the number of dimensions represented in thegeometryproperty, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of thegeometry.Used By
featuresfeaturesfeaturesIncidentRoadEvent Object
The
IncidentRoadEventobject locates and describes incidents or events that close or restrict the use of a road segment.The
IncidentRoadEventis a type of road event; it has acore_detailsproperty which contains the RoadEventCoreDetails and exists within a RoadEventFeature.Properties
core_detailstypes_of_incidentstart_date2016-11-03T19:37:00Z.end_date2016-11-03T19:37:00Z.is_start_date_verifiedis_end_date_verifiedis_start_position_verifiedis_end_position_verifiedlocation_methodvehicle_impactlanesbeginning_cross_streetending_cross_streetbeginning_milepostending_milepostworker_presencereduced_speed_limit_kphrestrictionsUsed By
propertiesTypeOfIncident Object
The
TypeOfIncidentobject describes an event that causees disruptions to expected operations.Properties
incident_typeUsed By
incident_typesIncidentType Enumerated Type
Descriptions of the incidents causing disruptions to expected operations.
Values
Used By
incident_typeAdded RoadIncidentFeed.json to Schemas
RoadIncidentFeed.json
{ "$id": "https://raw.githubusercontent.com/usdot-jpo-ode/wzdx/main/schemas/4.1/RoadIncidentFeed.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "WZDx v4.1 RoadIncidentFeed", "description": "The GeoJSON output of a Road Incident Feed data feed (v4.0)", "type": "object", "properties": { "road_event_feed_info": { "$ref": "https://raw.githubusercontent.com/usdot-jpo-ode/wzdx/main/schemas/4.1/FeedInfo.json" }, "type": { "description": "The GeoJSON type", "enum": ["FeatureCollection"] }, "features": { "description": "An array of GeoJSON Feature objects which represent Incident road events", "type": "array", "items": { "allOf": [ { "properties": { "properties": { "properties": { "core_details": { "properties": { "event_type": { "enum": ["incident", "detour"] } }, "required": ["event_type"] } }, "required": ["core_details"] } }, "required": ["properties"] }, { "$ref": "https://raw.githubusercontent.com/usdot-jpo-ode/wzdx/main/schemas/4.0/RoadEventFeature.json" } ] } }, "bbox": { "$ref": "https://raw.githubusercontent.com/usdot-jpo-ode/wzdx/main/schemas/4.0/BoundingBox.json" } }, "required": ["road_event_feed_info", "type", "features"]}