Regions of Interest (ROIs)

Each region of interest is an area of data that the user is interested in examining. This can include things such as where the car starts on the track, when the car hits a traffic jam, when the car hits construction, etc.

Pydre uses csv files to define three types of ROIS: temporal, spatial, and rectangular.

Time ROI

Time ROIs are used to define groups of data according to given time ranges. Any of the three time data columns can be used: DatTime, SimTime, or MediaTime. If no column name is given, then DatTime is used by default.

General Time ROIS

The time ROI file .csv is formatted as below:

ROI	time_start	time_end
ROI name 1	start time 1	end time 1
ROI name 2	start time 2	end time 2
...	...	...
ROI name N	start time N	end time N

By default, every time ROIs is applied to every data file given.

Note

Start and end times are formatted as either hh:mm:ss-hh:mm:ss or mm:ss-mm:ss.

Specific Time ROIs

Time ROIs can also be specified to match any metadata value and only apply ROIs to certain data files. Multiple metadata values can be used to filter the ROIs. The specific time ROI format is below:

ROI	time_start	time_end	metadata_col 1	metadata_col 2
ROI name 1	start time 1	end time 1	metadata 1 value 1	metadata 2 value 1
ROI name 2	start time 2	end time 2	metadata 1 value 2	metadata 2 value 2
...	...	...	...	...
ROI name N	start time N	end time N	metadata 1 value 2	metadata 2 value 3

Space ROI

ROI	X1	Y1	X2	Y2
ROI name	min x	min y	max x	max y
ROI name	min x	min y	max x	max y
...	...	...	...	...
ROI name	min x	min y	max x	max y

Note

-Z corresponds to positive X, and if Y is 0 in the WRL file, set Y1 = -100, Y2 = 100.

The ROI will consist of the area inside the max_y - min_y and the max_x - min_x.

For an example file, look at spatial_rois.csv in the main pydre folder. Once the ROI csv file has been generated, reference it in the project file to perform the function calculations only on the regions of interest specified by the x and y coordinates in this csv file.

Column ROI

Column ROIS are used to define groups of data according to given column values. They are defined in the project file using the following format:

[rois.roi1]
type = "column"
columnname = "CriticalEventNum"

In the above example, the ROI is defined by the values in the column "CriticalEventNum". Each ROI will consist of all the rows in the data that have the same value in the "CriticalEventNum" column. These rows do not need to be contiguous in the data file.