cityscapesScripts2.2.4
Published
Scripts for the Cityscapes Dataset
pip install cityscapesscripts
Package Downloads
Authors
Project URLs
Requires Python
The Cityscapes Dataset
This repository contains scripts for inspection, preparation, and evaluation of the Cityscapes dataset. This large-scale dataset contains a diverse set of stereo video sequences recorded in street scenes from 50 different cities, with high quality pixel-level annotations of 5 000 frames in addition to a larger set of 20 000 weakly annotated frames.
Details and download are available at: www.cityscapes-dataset.com
Dataset Structure
The folder structure of the Cityscapes dataset is as follows:
{root}/{type}{video}/{split}/{city}/{city}_{seq:0>6}_{frame:0>6}_{type}{ext}
The meaning of the individual elements is:
root
the root folder of the Cityscapes dataset. Many of our scripts check if an environment variableCITYSCAPES_DATASET
pointing to this folder exists and use this as the default choice.type
the type/modality of data, e.g.gtFine
for fine ground truth, orleftImg8bit
for left 8-bit images.split
the split, i.e. train/val/test/train_extra/demoVideo. Note that not all kinds of data exist for all splits. Thus, do not be surprised to occasionally find empty folders.city
the city in which this part of the dataset was recorded.seq
the sequence number using 6 digits.frame
the frame number using 6 digits. Note that in some cities very few, albeit very long sequences were recorded, while in some cities many short sequences were recorded, of which only the 19th frame is annotated.ext
the extension of the file and optionally a suffix, e.g._polygons.json
for ground truth files
Possible values of type
gtFine
the fine annotations, 2975 training, 500 validation, and 1525 testing. This type of annotations is used for validation, testing, and optionally for training. Annotations are encoded usingjson
files containing the individual polygons. Additionally, we providepng
images, where pixel values encode labels. Please refer tohelpers/labels.py
and the scripts inpreparation
for details.gtCoarse
the coarse annotations, available for all training and validation images and for another set of 19998 training images (train_extra
). These annotations can be used for training, either together with gtFine or alone in a weakly supervised setup.gtBbox3d
3D bounding box annotations of vehicles. Please refer to Cityscapes 3D (Gählert et al., CVPRW '20) for details.gtBboxCityPersons
pedestrian bounding box annotations, available for all training and validation images. Please refer tohelpers/labels_cityPersons.py
as well as CityPersons (Zhang et al., CVPR '17) for more details. The four values of a bounding box are (x, y, w, h), where (x, y) is its top-left corner and (w, h) its width and height.leftImg8bit
the left images in 8-bit LDR format. These are the standard annotated images.leftImg8bit_blurred
the left images in 8-bit LDR format with faces and license plates blurred. Please compute results on the original images but use the blurred ones for visualization. We thank Mapillary for blurring the images.leftImg16bit
the left images in 16-bit HDR format. These images offer 16 bits per pixel of color depth and contain more information, especially in very dark or bright parts of the scene. Warning: The images are stored as 16-bit pngs, which is non-standard and not supported by all libraries.rightImg8bit
the right stereo views in 8-bit LDR format.rightImg16bit
the right stereo views in 16-bit HDR format.timestamp
the time of recording in ns. The first frame of each sequence always has a timestamp of 0.disparity
precomputed disparity depth maps. To obtain the disparity values, compute for each pixel p with p > 0: d = ( float(p) - 1. ) / 256., while a value p = 0 is an invalid measurement. Warning: the images are stored as 16-bit pngs, which is non-standard and not supported by all libraries.camera
internal and external camera calibration. For details, please refer to csCalibration.pdfvehicle
vehicle odometry, GPS coordinates, and outside temperature. For details, please refer to csCalibration.pdf
More types might be added over time and also not all types are initially available. Please let us know if you need any other meta-data to run your approach.
Possible values of split
train
usually used for training, contains 2975 images with fine and coarse annotationsval
should be used for validation of hyper-parameters, contains 500 image with fine and coarse annotations. Can also be used for training.test
used for testing on our evaluation server. The annotations are not public, but we include annotations of ego-vehicle and rectification border for convenience.train_extra
can be optionally used for training, contains 19998 images with coarse annotationsdemoVideo
video sequences that could be used for qualitative evaluation, no annotations are available for these videos
Scripts
Installation
Install cityscapesscripts
with pip
python -m pip install cityscapesscripts
Graphical tools (viewer and label tool) are based on Qt5 and can be installed via
python -m pip install cityscapesscripts[gui]
Usage
The installation installs the cityscapes scripts as a python module named cityscapesscripts
and exposes the following tools
csDownload
: Download the cityscapes packages via command line.csViewer
: View the images and overlay the annotations.csLabelTool
: Tool that we used for labeling.csEvalPixelLevelSemanticLabeling
: Evaluate pixel-level semantic labeling results on the validation set. This tool is also used to evaluate the results on the test set.csEvalInstanceLevelSemanticLabeling
: Evaluate instance-level semantic labeling results on the validation set. This tool is also used to evaluate the results on the test set.csEvalPanopticSemanticLabeling
: Evaluate panoptic segmentation results on the validation set. This tool is also used to evaluate the results on the test set.csEvalObjectDetection3d
: Evaluate 3D object detection on the validation set. This tool is also used to evaluate the results on the test set.csCreateTrainIdLabelImgs
: Convert annotations in polygonal format to png images with label IDs, where pixels encode "train IDs" that you can define inlabels.py
.csCreateTrainIdInstanceImgs
: Convert annotations in polygonal format to png images with instance IDs, where pixels encode instance IDs composed of "train IDs".csCreatePanopticImgs
: Convert annotations in standard png format to COCO panoptic segmentation format.csPlot3dDetectionResults
: Visualize 3D object detection evaluation results stored in .json format.
Package Content
The package is structured as follows
helpers
: helper files that are included by other scriptsviewer
: view the images and the annotationspreparation
: convert the ground truth annotations into a format suitable for your approachevaluation
: validate your approachannotation
: the annotation tool used for labeling the datasetdownload
: downloader for Cityscapes packages
Note that all files have a small documentation at the top. Most important files
helpers/labels.py
: central file defining the IDs of all semantic classes and providing mapping between various class properties.helpers/labels_cityPersons.py
: file defining the IDs of all CityPersons pedestrian classes and providing mapping between various class properties.setup.py
: runCYTHONIZE_EVAL= python setup.py build_ext --inplace
to enable cython plugin for faster evaluation. Only tested for Ubuntu.
Evaluation
Once you want to test your method on the test set, please run your approach on the provided test images and submit your results: Submission Page
The result format is described at the top of our evaluation scripts:
- Pixel Level Semantic Labeling
- Instance Level Semantic Labeling
- Panoptic Semantic Labeling
- 3D Object Detection
Note that our evaluation scripts are included in the scripts folder and can be used to test your approach on the validation set. For further details regarding the submission process, please consult our website.
License
The dataset itself is released under custom terms and conditions.
The Cityscapes Scripts are released under MIT license as found in the license file.
Contact
Please feel free to contact us with any questions, suggestions or comments:
- Marius Cordts, Mohamed Omran
- [email protected]
- www.cityscapes-dataset.com