ROI List CSV File Format

To generate timeseries data for a site we create a list of masks which define a region of interest (ROI). This list contains date/time ranges and the associated ROI mask for that range. The images included in the resulting timeseries will be determined by the date/time ranges in an ROI List file. A simple ROI List file for the 'coweeta' site is shown below:

#
# ROI List for coweeta
#
# Site: coweeta
# Veg Type: DB
# ROI ID Number: 0001
# Owner: mtoomey
# Creation Date: 2012-09-05
# Creation Time: 11:42:00
# Update Date: 2014-12-18
# Update Time: 13:55:20
# Description: Deciduous trees in foreground
#
start_date,start_time,end_date,end_time,maskfile,sample_image
2011-04-08,00:00:00,2012-11-08,14:31:57,coweeta_DB_0001_01.tif,coweeta_2011_04_08_143030.jpg
2012-11-08,15:01:00,9999-12-31,23:59:59,coweeta_DB_0001_02.tif,coweeta_2012_11_09_113132.jpg

For this site there was one shift of the field of view (FOV) so there are two ROI mask entries. Only images in the date/time ranges listed will be included in the timeseries generated from this list. If new shifts occur a new row (mask entry) will be added to the file. If the FOV shift is too large or if there are other changes (e.g. a new camera with significantly different image properties is installed) a new ROI List may need to be started for the site.

The naming convention for the ROI Lists is as follows:

<sitename>_<ROI-type>_<ROI-sequence-no>_roi.csv

The sequence number is just used to create a unique identifier for the list. The ROI-type is chosen from a predefined list of types. The "new" standard ROI types to which we are still transitioning are:

The fields in the file are:

The naming convention for the mask files is:

<sitename>_<ROI-type>_<ROI-sequence-no>_<mask_index>.tif

Here the mask_index should match the entry number in the list. The ROI lists and masks are treated as part of the archive and would be required to reproduce the ROI Timeseries files.

The TIFF image file format includes a lot of flexibility. To work with our processing software the mask must have a single color plane (one 8-bit value per pixel). In addition only the compression types supported but the python PIL library are supported.