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.

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

Documentation #24

Open
wants to merge 58 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
13df03d
Update BehaviorTagView
srishtisripada Mar 21, 2024
231495d
tried to add scrollbar
AmeliaY07 Mar 21, 2024
59cd1df
unsuccessful scrollbar implementation
taoruihuang Mar 21, 2024
0116647
added scrollbar to behavior tag view
taoruihuang Apr 2, 2024
8b4985b
need fixed sizing for canvas
taoruihuang Apr 3, 2024
61e2ab2
added pedgrid docs for test
taoruihuang Apr 8, 2024
a8153c1
added pedgrid docs for test
taoruihuang Apr 8, 2024
86ad5e3
Merge branch 'taorui-huang' of https://github.com/adhocmaster/ped-beh…
taoruihuang Apr 8, 2024
72a8586
Revert "added pedgrid docs for test"
taoruihuang Apr 8, 2024
0f775cd
Revert "Revert "added pedgrid docs for test""
taoruihuang Apr 8, 2024
0040017
updated docs
taoruihuang Apr 8, 2024
f097d7c
Update index.rst
taoruihuang Apr 8, 2024
3031868
Delete .readthedocs.yaml
taoruihuang Apr 8, 2024
04a97e2
ped tags
adhocmaster Apr 15, 2024
c390268
Update index.rst
adhocmaster Apr 15, 2024
301270c
Update user-guide
srishtisripada Apr 15, 2024
a5fd9ce
Merge branch 'documentation' of https://github.com/adhocmaster/ped-be…
srishtisripada Apr 15, 2024
bd4fb99
updated tags
adhocmaster Apr 18, 2024
9b91ffe
Pedestrian Behavior Tags Update
srishtisripada Apr 18, 2024
73b30fb
added vehicle tag documentation
AmeliaY07 Apr 19, 2024
ed7699b
Merge branch 'documentation' of https://github.com/adhocmaster/ped-be…
srishtisripada Apr 22, 2024
b98d5ca
Revert "Merge branch 'documentation' of https://github.com/adhocmaste…
srishtisripada Apr 22, 2024
24cd19d
Reapply "Merge branch 'documentation' of https://github.com/adhocmast…
taoruihuang Apr 22, 2024
e7a1865
should be fixed
taoruihuang Apr 22, 2024
0a9cf89
Update vehicle-behavior-tags.md
AmeliaY07 Apr 22, 2024
f8152f8
Update vehicle-behavior-tags.md
AmeliaY07 Apr 22, 2024
86ee53f
Update vehicle-behavior-tags.md
AmeliaY07 Apr 22, 2024
b0590c6
Create environment-condition-tags.md
AmeliaY07 Apr 22, 2024
8ce298e
user guide structure
adhocmaster Apr 22, 2024
b2ca71b
Merge branch 'documentation' of https://github.com/adhocmaster/ped-be…
adhocmaster Apr 22, 2024
60439fb
fix documentation
taoruihuang May 18, 2024
46e5d32
Update index.rst
taoruihuang May 18, 2024
c1603c9
fixing doc
taoruihuang May 18, 2024
48e5ec9
update
taoruihuang May 18, 2024
4e9bee7
Update index.rst
taoruihuang May 18, 2024
733a169
Update index.rst
taoruihuang May 18, 2024
787bb85
Merge branch 'documentation' of https://github.com/adhocmaster/ped-be…
taoruihuang May 18, 2024
16d8d60
Update index.rst
taoruihuang May 18, 2024
cf3b976
Adding visuals
srishtisripada May 19, 2024
6d5e12e
Update UI.pptx
taoruihuang May 19, 2024
96937dd
Merge branch 'documentation' of https://github.com/adhocmaster/ped-be…
taoruihuang May 19, 2024
b004693
Update UI.pptx
taoruihuang May 19, 2024
5601f98
Update environment-condition-tags.md
AmeliaY07 May 19, 2024
fc5551c
Merge branch 'documentation' of https://github.com/adhocmaster/ped-be…
AmeliaY07 May 19, 2024
c934ab5
added predefined tags and public video
AmeliaY07 May 19, 2024
8bab18a
add key concepts
taoruihuang May 19, 2024
d1b0203
Update key-concepts.md
taoruihuang May 20, 2024
9ebd9c5
change to UI picture
taoruihuang May 20, 2024
b5de005
update to doc
taoruihuang May 20, 2024
6c26980
Update installation.md
taoruihuang May 20, 2024
cf8c414
fixed bugs
taoruihuang May 20, 2024
7cff0ac
Update key concepts
srishtisripada May 21, 2024
f540b3c
Update key concepts
srishtisripada May 21, 2024
3b4e2ff
Merge branch 'documentation' of https://github.com/adhocmaster/ped-be…
srishtisripada May 21, 2024
bd9fa29
Update installation.md
taoruihuang Jul 9, 2024
56ad63e
Update installation.md
taoruihuang Jul 9, 2024
8a184cb
Update installation.md
taoruihuang Jul 10, 2024
b27f4b6
Update pedestrian-behavior-tags.md
taoruihuang Jul 16, 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
Binary file modified .DS_Store
Binary file not shown.
Binary file added Dataset/.DS_Store
Binary file not shown.
200 changes: 200 additions & 0 deletions amelia.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
{
"name": "proj 1",
"fps": 30,
"annotation_path": "/Users/ameliayuan/Documents/ped-behavior-annotator/amelia.json",
"video_path": "https://www.youtube.com/watch?v=eu4QqwsfXFE",
"multiFrameAnnotations": [
{
"frameStart": 5225,
"frameEnd": 5447,
"pedTags": [],
"egoTags": [
"Distracted driving"
],
"sceneTags": [
"No traffic lights"
],
"additionalNotes": "Vehicle stopped but started to pull forward right as pedestrian walked towards its path"
},
{
"frameStart": 4980,
"frameEnd": 5128,
"pedTags": [
"Jaywalking"
],
"egoTags": [],
"sceneTags": [],
"additionalNotes": "Vehicle swerves to avoid person, person is hidden behind vehicle by curb as they begin crossing the street"
},
{
"frameStart": 8518,
"frameEnd": 8778,
"pedTags": [
"Flinch",
"No Looking"
],
"egoTags": [],
"sceneTags": [],
"additionalNotes": "Pedestrian almost walked into path of incoming light rail train"
},
{
"frameStart": 8901,
"frameEnd": 8923,
"pedTags": [
"Jaywalking"
],
"egoTags": [],
"sceneTags": [],
"additionalNotes": "Pedestrian in middle of road, very dark, vehicle swerved to avoid"
},
{
"frameStart": 7571,
"frameEnd": 7727,
"pedTags": [
"Flinch",
"Distracted"
],
"egoTags": [
"Speeding"
],
"sceneTags": [
"No stop signs",
"No traffic lights"
],
"additionalNotes": "Vehicle did not stop at crosswalk for already crossing pedestrian, pedestrian jumped back to avoid getting hit"
},
{
"frameStart": 5588,
"frameEnd": 5654,
"pedTags": [
"Crash"
],
"egoTags": [
"Distracted driving"
],
"sceneTags": [
"No stop signs",
"No traffic lights"
],
"additionalNotes": "The car did not stop at the crosswalk even though there were pedestrians clearly there"
},
{
"frameStart": 4771,
"frameEnd": 4907,
"pedTags": [
"Jaywalking",
"No Looking"
],
"egoTags": [
"Brake"
],
"sceneTags": [
"No stop signs",
"No traffic lights"
],
"additionalNotes": ""
},
{
"frameStart": 9002,
"frameEnd": 12480,
"pedTags": [
"Flinch"
],
"egoTags": [
"Distracted driving",
"Speeding"
],
"sceneTags": [],
"additionalNotes": "Vehicle did not stop at crosswalk, person flinched back to avoid"
},
{
"frameStart": 5793,
"frameEnd": 5902,
"pedTags": [
"Crash"
],
"egoTags": [
"Distracted driving"
],
"sceneTags": [
"No stop signs",
"No traffic lights"
],
"additionalNotes": "Vehicle did not stop at crosswalk, pedestrian was already crossing"
},
{
"frameStart": 6848,
"frameEnd": 7029,
"pedTags": [],
"egoTags": [],
"sceneTags": [
"No traffic lights",
"No stop signs"
],
"additionalNotes": "Pedestrian attempted to cross road, cars on half of the road did not stop for the pedestrian, so they retreated back to the sidewalk and waited"
},
{
"frameStart": 6612,
"frameEnd": 6720,
"pedTags": [
"Crash"
],
"egoTags": [],
"sceneTags": [],
"additionalNotes": "vehicle did not stop at crosswalk, pedestrian was already walking"
},
{
"frameStart": 6428,
"frameEnd": 6534,
"pedTags": [],
"egoTags": [
"Speeding"
],
"sceneTags": [],
"additionalNotes": "Vehicle hit from behind by a vehicle speeding that didn't brake for the crosswalk"
},
{
"frameStart": 7303,
"frameEnd": 7427,
"pedTags": [],
"egoTags": [],
"sceneTags": [
"No stop signs",
"No traffic lights"
],
"additionalNotes": "Vehicle did not stop at crosswalk for already crossing pedestrians, pedestrians waited in the middle of the road to let vehicle through"
},
{
"frameStart": 7895,
"frameEnd": 14408,
"pedTags": [
"Flinch"
],
"egoTags": [
"Brake"
],
"sceneTags": [
"No stop signs",
"No traffic lights"
],
"additionalNotes": "Cars braked last-minute at crosswalk, pedestrian retreated back onto sidewalk before crossing again"
},
{
"frameStart": 8305,
"frameEnd": 8448,
"pedTags": [
"Crash",
"Flinch"
],
"egoTags": [
"Brake"
],
"sceneTags": [
"No stop signs",
"No traffic lights"
],
"additionalNotes": "Vehicle paused, then appeared to get lurch forward from behind perhaps from another car crashing, then hit the pedestrians"
}
],
"singleFrameAnnotations": []
}
11 changes: 7 additions & 4 deletions app.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,13 @@ def makeEditor(self):

# self.videoFrame.Text("Video")
# self.leftFrame.Seperator()
self.annotationFrame = self.leftFrame.addLabelFrame("Annotation Edit View", padx=(0,0), pady=(10,0))
self.annotationEditView = self.viewManager.getAnnotationEditView(self.recordingController)
#self.context["controllers"]["recording"])
self.annotationEditView.render(self.annotationFrame)
# self.annotationFrame = self.leftFrame.addLabelFrame("Annotation Edit View", padx=(0,0), pady=(10,0))
# self.annotationEditView = self.viewManager.getAnnotationEditView(self.recordingController)
# #self.context["controllers"]["recording"])
# self.annotationEditView.render(self.annotationFrame)
self.behaviorTagFrame = self.leftFrame.addLabelFrame("Behavior Tag Frame", padx=(0,0), pady=(10,0))
self.behaviorTagView = self.viewManager.getBehaviorTagView()
self.behaviorTagView.render(self.behaviorTagFrame)

self.recordingFrame = self.rightFrame.addFrame("Recording", padx=(0,0), pady=(10,0))
self.recordingView = self.viewManager.getRecordingView(self.recordingController)
Expand Down
Binary file added docs/.DS_Store
Binary file not shown.
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Binary file removed docs/UI.pptx
Binary file not shown.
35 changes: 35 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)

if "%1" == "" goto help

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:end
popd
Binary file added docs/requirements.txt
Binary file not shown.
Binary file added docs/source/.DS_Store
Binary file not shown.
18 changes: 18 additions & 0 deletions docs/source/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
@import 'theme.css';

ol {
list-style: decimal;
}

ol.simple {
list-style: decimal;
margin-left: 2em;
}

ul.simple {
margin-left: 1em;
}

ol.simple > li {
list-style: decimal;
}
8 changes: 8 additions & 0 deletions docs/source/advanced-user-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Advanced User Guide

## Editing annoations

## Merging annotations

## Adding a new Behavior Tag

76 changes: 76 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'PedAnalyze'
copyright = '2024, Taorui Huang, Golam Md Muktadir, Srishti Sripada, Rishi Saravanan, Amelia Yuan, Jim Whitehead'
author = 'Taorui Huang, Golam Md Muktadir, Srishti Sripada, Rishi Saravanan, Amelia Yuan, Jim Whitehead'
release = '1.0.0'

# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.

extensions = [
'myst_parser',
'sphinx.ext.autosectionlabel',
'sphinx_rtd_theme',
'sphinx.ext.autodoc',
'sphinx.ext.coverage',
'sphinx.ext.napoleon'
]
autosectionlabel_prefix_document = True

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# html_css_files = [
# 'css/custom.css',
# ]
html_style = 'css/custom.css'

myst_enable_extensions = [
"amsmath",
"colon_fence",
"deflist",
"dollarmath",
"html_admonition",
"html_image",
"linkify",
"replacements",
"smartquotes",
"substitution",
"tasklist",
]



language = "en"
myst_html_meta = {
"description lang=en": "PedAnalyze",
"keywords": "Pedestrian Behavior Annotation",
"property=og:locale": "en_US"
}
7 changes: 7 additions & 0 deletions docs/source/dev-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Developer Guide

<!-- ## Developing New Objects
All objects, static and dynamic, derive from the BaseObject class. When creating a new object, you may either inherit directly from the BaseObject class or from an existing child class such as PedAgent or Vehicle.

### Color Visualization
The ObjectColors class defines all object colors for visualization when rendering in the grid. As desired, object colors can be changed or added. -->
Loading