Skip to content

Commit

Permalink
Merge pull request #671 from roboflow/fix/time-in-zone-reset-count
Browse files Browse the repository at this point in the history 
Add option to reset timer when detection falls outside of zone
  • Loading branch information
@grzegorz-roboflow
grzegorz-roboflow authored Sep 24, 2024
2 parents 0d53377 + 247a557 commit 039e525
Show file tree
Hide file tree
Showing 2 changed files with 285 additions and 0 deletions.
12 changes: 12 additions & 0 deletions inference/core/workflows/core_steps/analytics/time_in_zone/v1.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,11 @@ class TimeInZoneManifest(WorkflowBlockManifest):
default=True,
examples=[True, False],
)
reset_out_of_zone_detections: Union[bool, WorkflowParameterSelector(kind=[BOOLEAN_KIND])] = Field( # type: ignore
description=f"If true, detections found outside of zone will have time reset",
default=True,
examples=[True, False],
)

@classmethod
def describe_outputs(cls) -> List[OutputDefinition]:
Expand Down Expand Up @@ -114,6 +119,7 @@ def run(
zone: List[Tuple[int, int]],
triggering_anchor: str,
remove_out_of_zone_detections: bool,
reset_out_of_zone_detections: bool,
) -> BlockResult:
if detections.tracker_id is None:
raise ValueError(
Expand Down Expand Up @@ -157,6 +163,12 @@ def run(
polygon_zone.trigger(detections),
detections.tracker_id,
):
if (
not is_in_zone
and tracker_id in tracked_ids_in_zone
and reset_out_of_zone_detections
):
del tracked_ids_in_zone[tracker_id]
if not is_in_zone and remove_out_of_zone_detections:
continue

Expand Down
273 changes: 273 additions & 0 deletions tests/workflows/unit_tests/core_steps/analytics/test_time_in_zone.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ def test_time_in_zone_keep_out_of_zone_detections() -> None:
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=False,
reset_out_of_zone_detections=False,
)
frame2_result = time_in_zone_block.run(
image=image_data,
Expand All @@ -85,6 +86,7 @@ def test_time_in_zone_keep_out_of_zone_detections() -> None:
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=False,
reset_out_of_zone_detections=False,
)
frame3_result = time_in_zone_block.run(
image=image_data,
Expand All @@ -93,6 +95,7 @@ def test_time_in_zone_keep_out_of_zone_detections() -> None:
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=False,
reset_out_of_zone_detections=False,
)

# then
Expand Down Expand Up @@ -188,6 +191,7 @@ def test_time_in_zone_remove_out_of_zone_detections() -> None:
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=True,
reset_out_of_zone_detections=True,
)
frame2_result = time_in_zone_block.run(
image=image_data,
Expand All @@ -196,6 +200,7 @@ def test_time_in_zone_remove_out_of_zone_detections() -> None:
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=True,
reset_out_of_zone_detections=True,
)
frame3_result = time_in_zone_block.run(
image=image_data,
Expand All @@ -204,6 +209,7 @@ def test_time_in_zone_remove_out_of_zone_detections() -> None:
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=True,
reset_out_of_zone_detections=True,
)

# then
Expand Down Expand Up @@ -232,6 +238,269 @@ def test_time_in_zone_remove_out_of_zone_detections() -> None:
assert (frame3_result["timed_detections"]["time_in_zone"] == np.array([1, 2])).all()


def test_time_in_zone_remove_and_reset_out_of_zone_detections() -> None:
# given
zone = [[10, 10], [10, 20], [20, 20], [20, 10]]
frame1_detections = sv.Detections(
xyxy=np.array([[8, 8, 9, 9], [11, 11, 12, 12], [14, 14, 15, 15]]),
tracker_id=np.array([1, 2, 3]),
)
frame2_detections = sv.Detections(
xyxy=np.array([[8, 8, 9, 9], [11, 11, 12, 12], [14, 14, 15, 15]]),
tracker_id=np.array([1, 2, 3]),
)
frame3_detections = sv.Detections(
xyxy=np.array([[8, 8, 9, 9], [1, 1, 2, 2], [14, 14, 15, 15]]),
tracker_id=np.array([1, 2, 3]),
)
frame4_detections = sv.Detections(
xyxy=np.array([[8, 8, 9, 9], [11, 11, 12, 12], [14, 14, 15, 15]]),
tracker_id=np.array([1, 2, 3]),
)
frame1_metadata = VideoMetadata(
video_identifier="vid_1",
frame_number=10,
fps=1,
frame_timestamp=datetime.datetime.fromtimestamp(1726570875).astimezone(
tz=datetime.timezone.utc
),
comes_from_video_file=True,
)
frame2_metadata = VideoMetadata(
video_identifier="vid_1",
frame_number=11,
fps=1,
frame_timestamp=datetime.datetime.fromtimestamp(1726570876).astimezone(
tz=datetime.timezone.utc
),
comes_from_video_file=True,
)
frame3_metadata = VideoMetadata(
video_identifier="vid_1",
frame_number=12,
fps=1,
frame_timestamp=datetime.datetime.fromtimestamp(1726570877).astimezone(
tz=datetime.timezone.utc
),
comes_from_video_file=True,
)
frame4_metadata = VideoMetadata(
video_identifier="vid_1",
frame_number=13,
fps=1,
frame_timestamp=datetime.datetime.fromtimestamp(1726570878).astimezone(
tz=datetime.timezone.utc
),
comes_from_video_file=True,
)
time_in_zone_block = TimeInZoneBlockV1()

parent_metadata = ImageParentMetadata(parent_id="img1")
image = np.zeros((720, 1280, 3))
image_data = WorkflowImageData(
parent_metadata=parent_metadata,
numpy_image=image,
)

# when
frame1_result = time_in_zone_block.run(
image=image_data,
detections=frame1_detections,
metadata=frame1_metadata,
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=True,
reset_out_of_zone_detections=True,
)
frame2_result = time_in_zone_block.run(
image=image_data,
detections=frame2_detections,
metadata=frame2_metadata,
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=True,
reset_out_of_zone_detections=True,
)
frame3_result = time_in_zone_block.run(
image=image_data,
detections=frame3_detections,
metadata=frame3_metadata,
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=True,
reset_out_of_zone_detections=True,
)
frame4_result = time_in_zone_block.run(
image=image_data,
detections=frame4_detections,
metadata=frame4_metadata,
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=True,
reset_out_of_zone_detections=True,
)

# then
assert (
frame1_result["timed_detections"].xyxy
== np.array([[11, 11, 12, 12], [14, 14, 15, 15]])
).all()
assert (frame1_result["timed_detections"]["time_in_zone"] == np.array([0, 0])).all()

assert (
frame2_result["timed_detections"].xyxy
== np.array([[11, 11, 12, 12], [14, 14, 15, 15]])
).all()
assert (frame2_result["timed_detections"]["time_in_zone"] == np.array([1, 1])).all()

assert (
frame3_result["timed_detections"].xyxy == np.array([[14, 14, 15, 15]])
).all()
assert (frame3_result["timed_detections"]["time_in_zone"] == np.array([2])).all()

assert (
frame4_result["timed_detections"].xyxy
== np.array([[11, 11, 12, 12], [14, 14, 15, 15]])
).all()
assert (frame4_result["timed_detections"]["time_in_zone"] == np.array([0, 3])).all()


def test_time_in_zone_keep_and_reset_out_of_zone_detections() -> None:
# given
zone = [[10, 10], [10, 20], [20, 20], [20, 10]]
frame1_detections = sv.Detections(
xyxy=np.array([[8, 8, 9, 9], [11, 11, 12, 12], [14, 14, 15, 15]]),
tracker_id=np.array([1, 2, 3]),
)
frame2_detections = sv.Detections(
xyxy=np.array([[8, 8, 9, 9], [11, 11, 12, 12], [14, 14, 15, 15]]),
tracker_id=np.array([1, 2, 3]),
)
frame3_detections = sv.Detections(
xyxy=np.array([[8, 8, 9, 9], [1, 1, 2, 2], [14, 14, 15, 15]]),
tracker_id=np.array([1, 2, 3]),
)
frame4_detections = sv.Detections(
xyxy=np.array([[8, 8, 9, 9], [11, 11, 12, 12], [14, 14, 15, 15]]),
tracker_id=np.array([1, 2, 3]),
)
frame1_metadata = VideoMetadata(
video_identifier="vid_1",
frame_number=10,
fps=1,
frame_timestamp=datetime.datetime.fromtimestamp(1726570875).astimezone(
tz=datetime.timezone.utc
),
comes_from_video_file=True,
)
frame2_metadata = VideoMetadata(
video_identifier="vid_1",
frame_number=11,
fps=1,
frame_timestamp=datetime.datetime.fromtimestamp(1726570876).astimezone(
tz=datetime.timezone.utc
),
comes_from_video_file=True,
)
frame3_metadata = VideoMetadata(
video_identifier="vid_1",
frame_number=12,
fps=1,
frame_timestamp=datetime.datetime.fromtimestamp(1726570877).astimezone(
tz=datetime.timezone.utc
),
comes_from_video_file=True,
)
frame4_metadata = VideoMetadata(
video_identifier="vid_1",
frame_number=13,
fps=1,
frame_timestamp=datetime.datetime.fromtimestamp(1726570878).astimezone(
tz=datetime.timezone.utc
),
comes_from_video_file=True,
)
time_in_zone_block = TimeInZoneBlockV1()

parent_metadata = ImageParentMetadata(parent_id="img1")
image = np.zeros((720, 1280, 3))
image_data = WorkflowImageData(
parent_metadata=parent_metadata,
numpy_image=image,
)

# when
frame1_result = time_in_zone_block.run(
image=image_data,
detections=frame1_detections,
metadata=frame1_metadata,
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=False,
reset_out_of_zone_detections=True,
)
frame2_result = time_in_zone_block.run(
image=image_data,
detections=frame2_detections,
metadata=frame2_metadata,
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=False,
reset_out_of_zone_detections=True,
)
frame3_result = time_in_zone_block.run(
image=image_data,
detections=frame3_detections,
metadata=frame3_metadata,
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=False,
reset_out_of_zone_detections=True,
)
frame4_result = time_in_zone_block.run(
image=image_data,
detections=frame4_detections,
metadata=frame4_metadata,
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=False,
reset_out_of_zone_detections=True,
)

# then
assert (
frame1_result["timed_detections"].xyxy
== np.array([[8, 8, 9, 9], [11, 11, 12, 12], [14, 14, 15, 15]])
).all()
assert (
frame1_result["timed_detections"]["time_in_zone"] == np.array([0, 0, 0])
).all()

assert (
frame2_result["timed_detections"].xyxy
== np.array([[8, 8, 9, 9], [11, 11, 12, 12], [14, 14, 15, 15]])
).all()
assert (
frame2_result["timed_detections"]["time_in_zone"] == np.array([0, 1, 1])
).all()

assert (
frame3_result["timed_detections"].xyxy
== np.array([[8, 8, 9, 9], [1, 1, 2, 2], [14, 14, 15, 15]])
).all()
assert (
frame3_result["timed_detections"]["time_in_zone"] == np.array([0, 0, 2])
).all()

assert (
frame4_result["timed_detections"].xyxy
== np.array([[8, 8, 9, 9], [11, 11, 12, 12], [14, 14, 15, 15]])
).all()
assert (
frame4_result["timed_detections"]["time_in_zone"] == np.array([0, 0, 3])
).all()


def test_time_in_zone_no_trackers() -> None:
# given
zone = [[15, 0], [15, 1000], [3, 3]]
Expand Down Expand Up @@ -266,6 +535,7 @@ def test_time_in_zone_no_trackers() -> None:
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=True,
reset_out_of_zone_detections=True,
)


Expand Down Expand Up @@ -304,6 +574,7 @@ def test_time_in_zone_list_of_points_too_short() -> None:
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=True,
reset_out_of_zone_detections=True,
)


Expand Down Expand Up @@ -342,6 +613,7 @@ def test_time_in_zone_elements_not_points() -> None:
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=True,
reset_out_of_zone_detections=True,
)


Expand Down Expand Up @@ -380,4 +652,5 @@ def test_time_in_zone_coordianates_not_numeric() -> None:
zone=zone,
triggering_anchor="TOP_LEFT",
remove_out_of_zone_detections=True,
reset_out_of_zone_detections=True,
)

0 comments on commit 039e525

Please sign in to comment.