module documentation

Utilities for working with the Cityscapes dataset.

Copyright 2017-2025, Voxel51, Inc.

Function parse_cityscapes_dataset Parses the Cityscapes archive(s) in the specified directory and writes the requested splits in subdirectories of dataset_dir in fiftyone.types.FiftyOneDataset format.
Variable logger Undocumented
Function _export_split Undocumented
Function _extract_coarse_annos Undocumented
Function _extract_fine_annos Undocumented
Function _extract_images Undocumented
Function _extract_person_annos Undocumented
Function _parse_bbox_file Undocumented
Function _parse_coarse_annos Undocumented
Function _parse_fine_annos Undocumented
Function _parse_images Undocumented
Function _parse_person_annos Undocumented
Function _parse_polygon_annos Undocumented
Function _parse_polygons_file Undocumented
Function _parse_source_dir Undocumented
Function _parse_split Undocumented
Function _raise_cityscapes_error Undocumented
Constant _COARSE_ANNOS_ZIP Undocumented
Constant _FINE_ANNOS_ZIP Undocumented
Constant _IMAGES_ZIP Undocumented
Constant _PERSON_ANNOS_ZIP Undocumented
def parse_cityscapes_dataset(source_dir, dataset_dir, scratch_dir, splits, fine_annos=None, coarse_annos=None, person_annos=None): (source)

Parses the Cityscapes archive(s) in the specified directory and writes the requested splits in subdirectories of dataset_dir in fiftyone.types.FiftyOneDataset format.

The archives must have been manually downloaded into the directory before this method is called.

The source_dir should contain the following files:

source_dir/
    leftImg8bit_trainvaltest.zip
    gtFine_trainvaltest.zip             # optional
    gtCoarse.zip                        # optional
    gtBbox_cityPersons_trainval.zip     # optional
Parameters
source_dirthe directory continaining the manually downloaded Cityscapes files
dataset_dirthe directory in which to build the output dataset
scratch_dira scratch directory to use for temporary files
splitsa list of splits to parse. Supported values are (train, test, validation)
fine_annos:Nonewhether to load the fine annotations (True), or not (False), or only if the ZIP file exists (None)
coarse_annos:Nonewhether to load the coarse annotations (True), or not (False), or only if the ZIP file exists (None)
person_annos:Nonewhether to load the personn detections (True), or not (False), or only if the ZIP file exists (None)
Raises
OSErrorif any required source files are not present

Undocumented

def _export_split(split, split_dir, images_dir, fine_annos_dir, coarse_annos_dir, person_annos_dir): (source)

Undocumented

def _extract_coarse_annos(coarse_annos_zip_path, scratch_dir): (source)

Undocumented

def _extract_fine_annos(fine_annos_zip_path, scratch_dir): (source)

Undocumented

def _extract_images(images_zip_path, scratch_dir): (source)

Undocumented

def _extract_person_annos(person_annos_zip_path, scratch_dir): (source)

Undocumented

def _parse_bbox_file(json_path): (source)

Undocumented

def _parse_coarse_annos(coarse_annos_dir, split): (source)

Undocumented

def _parse_fine_annos(fine_annos_dir, split): (source)

Undocumented

def _parse_images(images_dir, split): (source)

Undocumented

def _parse_person_annos(person_annos_dir, split): (source)

Undocumented

def _parse_polygon_annos(glob_patt, split, anno_type, suffix): (source)

Undocumented

def _parse_polygons_file(json_path): (source)

Undocumented

def _parse_source_dir(source_dir, fine_annos, coarse_annos, person_annos): (source)

Undocumented

def _parse_split(split): (source)

Undocumented

def _raise_cityscapes_error(msg): (source)

Undocumented

_COARSE_ANNOS_ZIP: str = (source)

Undocumented

Value
'gtCoarse.zip'
_FINE_ANNOS_ZIP: str = (source)

Undocumented

Value
'gtFine_trainvaltest.zip'
_IMAGES_ZIP: str = (source)

Undocumented

Value
'leftImg8bit_trainvaltest.zip'
_PERSON_ANNOS_ZIP: str = (source)

Undocumented

Value
'gtBbox_cityPersons_trainval.zip'