Dlib C++ Library

Dlib is principally a C++ library, however, you can use a number of its tools from python applications. This page documents the python API for working with these dlib tools. If you haven’t done so already, you should probably look at the python example programs first before consulting this reference. These example programs are little mini-tutorials for using dlib from python. They are listed on the left of the main dlib web page.

Classes

  • dlib.array
  • dlib.cca_outputs
  • dlib.chip_details
  • dlib.chip_dims
  • dlib.cnn_face_detection_model_v1
  • dlib.correlation_tracker
  • dlib.dpoint
  • dlib.dpoints
  • dlib.drectangle
  • dlib.face_recognition_model_v1
  • dlib.fhog_object_detector
  • dlib.full_object_detection
  • dlib.full_object_detections
  • dlib.function_evaluation
  • dlib.function_evaluation_request
  • dlib.function_spec
  • dlib.global_function_search
  • dlib.hough_transform
  • dlib.image_gradients
  • dlib.image_window
  • dlib.keyboard_mod_keys
  • dlib.line
  • dlib.matrix
  • dlib.mmod_rectangle
  • dlib.mmod_rectangles
  • dlib.mmod_rectangless
  • dlib.no_convex_quadrilateral
  • dlib.non_printable_keyboard_keys
  • dlib.pair
  • dlib.point
  • dlib.point_transform_projective
  • dlib.points
  • dlib.pyramid_down
  • dlib.range
  • dlib.ranges
  • dlib.rangess
  • dlib.ranking_pair
  • dlib.ranking_pairs
  • dlib.rect_filter
  • dlib.rectangle
  • dlib.rectangles
  • dlib.rectangless
  • dlib.rgb_pixel
  • dlib.rvm_trainer_histogram_intersection
  • dlib.rvm_trainer_linear
  • dlib.rvm_trainer_radial_basis
  • dlib.rvm_trainer_sparse_histogram_intersection
  • dlib.rvm_trainer_sparse_linear
  • dlib.rvm_trainer_sparse_radial_basis
  • dlib.segmenter_params
  • dlib.segmenter_test
  • dlib.segmenter_type
  • dlib.shape_predictor
  • dlib.shape_predictor_training_options
  • dlib.simple_object_detector
  • dlib.simple_object_detector_training_options
  • dlib.simple_test_results
  • dlib.sparse_ranking_pair
  • dlib.sparse_ranking_pairs
  • dlib.sparse_vector
  • dlib.sparse_vectors
  • dlib.sparse_vectorss
  • dlib.svm_c_trainer_histogram_intersection
  • dlib.svm_c_trainer_linear
  • dlib.svm_c_trainer_radial_basis
  • dlib.svm_c_trainer_sparse_histogram_intersection
  • dlib.svm_c_trainer_sparse_linear
  • dlib.svm_c_trainer_sparse_radial_basis
  • dlib.svm_rank_trainer
  • dlib.svm_rank_trainer_sparse
  • dlib.vector
  • dlib.vectors
  • dlib.vectorss
  • dlib.image_dataset_metadata.box
  • dlib.image_dataset_metadata.boxes
  • dlib.image_dataset_metadata.dataset
  • dlib.image_dataset_metadata.image
  • dlib.image_dataset_metadata.images
  • dlib.image_dataset_metadata.parts

Functions

  • dlib.DLIB_USE_BLAS()
  • dlib.DLIB_USE_CUDA()
  • dlib.DLIB_USE_LAPACK()
  • dlib.KBD_MOD_ALT()
  • dlib.KBD_MOD_CAPS_LOCK()
  • dlib.KBD_MOD_CONTROL()
  • dlib.KBD_MOD_META()
  • dlib.KBD_MOD_NONE()
  • dlib.KBD_MOD_NUM_LOCK()
  • dlib.KBD_MOD_SCROLL_LOCK()
  • dlib.KBD_MOD_SHIFT()
  • dlib.KEY_ALT()
  • dlib.KEY_BACKSPACE()
  • dlib.KEY_CAPS_LOCK()
  • dlib.KEY_CTRL()
  • dlib.KEY_DELETE()
  • dlib.KEY_DOWN()
  • dlib.KEY_END()
  • dlib.KEY_ESC()
  • dlib.KEY_F1()
  • dlib.KEY_F10()
  • dlib.KEY_F11()
  • dlib.KEY_F12()
  • dlib.KEY_F2()
  • dlib.KEY_F3()
  • dlib.KEY_F4()
  • dlib.KEY_F5()
  • dlib.KEY_F6()
  • dlib.KEY_F7()
  • dlib.KEY_F8()
  • dlib.KEY_F9()
  • dlib.KEY_HOME()
  • dlib.KEY_INSERT()
  • dlib.KEY_LEFT()
  • dlib.KEY_PAGE_DOWN()
  • dlib.KEY_PAGE_UP()
  • dlib.KEY_PAUSE()
  • dlib.KEY_RIGHT()
  • dlib.KEY_SCROLL_LOCK()
  • dlib.KEY_SHIFT()
  • dlib.KEY_UP()
  • dlib.USE_AVX_INSTRUCTIONS()
  • dlib.USE_NEON_INSTRUCTIONS()
  • dlib.add_lib_to_dll_path()
  • dlib.angle_between_lines()
  • dlib.apply_cca_transform()
  • dlib.as_grayscale()
  • dlib.assignment_cost()
  • dlib.auto_train_rbf_classifier()
  • dlib.cca()
  • dlib.center()
  • dlib.centered_rect()
  • dlib.centered_rects()
  • dlib.chinese_whispers()
  • dlib.chinese_whispers_clustering()
  • dlib.convert_image()
  • dlib.convert_image_scaled()
  • dlib.count_points_between_lines()
  • dlib.count_points_on_side_of_line()
  • dlib.count_steps_without_decrease()
  • dlib.count_steps_without_decrease_robust()
  • dlib.cross_validate_ranking_trainer()
  • dlib.cross_validate_sequence_segmenter()
  • dlib.cross_validate_trainer()
  • dlib.cross_validate_trainer_threaded()
  • dlib.distance_to_line()
  • dlib.dot()
  • dlib.equalize_histogram()
  • dlib.extract_image_4points()
  • dlib.extract_image_chip()
  • dlib.extract_image_chips()
  • dlib.find_bright_keypoints()
  • dlib.find_bright_lines()
  • dlib.find_candidate_object_locations()
  • dlib.find_dark_keypoints()
  • dlib.find_dark_lines()
  • dlib.find_line_endpoints()
  • dlib.find_max_global()
  • dlib.find_min_global()
  • dlib.find_optimal_rect_filter()
  • dlib.find_peaks()
  • dlib.find_projective_transform()
  • dlib.gaussian_blur()
  • dlib.get_face_chip()
  • dlib.get_face_chips()
  • dlib.get_frontal_face_detector()
  • dlib.get_histogram()
  • dlib.get_rect()
  • dlib.grow_rect()
  • dlib.hit_enter_to_continue()
  • dlib.hysteresis_threshold()
  • dlib.intersect()
  • dlib.inv()
  • dlib.jet()
  • dlib.jitter_image()
  • dlib.label_connected_blobs()
  • dlib.label_connected_blobs_watershed()
  • dlib.length()
  • dlib.load_grayscale_image()
  • dlib.load_libsvm_formatted_data()
  • dlib.load_rgb_image()
  • dlib.make_bounding_box_regression_training_data()
  • dlib.make_sparse_vector()
  • dlib.max_cost_assignment()
  • dlib.max_index_plus_one()
  • dlib.max_point()
  • dlib.max_point_interpolated()
  • dlib.min_barrier_distance()
  • dlib.normalize_image_gradients()
  • dlib.num_separable_filters()
  • dlib.partition_pixels()
  • dlib.polygon_area()
  • dlib.probability_that_sequence_is_increasing()
  • dlib.randomly_color_image()
  • dlib.reduce()
  • dlib.remove_incoherent_edge_pixels()
  • dlib.resize_image()
  • dlib.reverse()
  • dlib.save_face_chip()
  • dlib.save_face_chips()
  • dlib.save_image()
  • dlib.save_libsvm_formatted_data()
  • dlib.scale_rect()
  • dlib.set_dnn_prefer_smallest_algorithms()
  • dlib.shrink_rect()
  • dlib.signed_distance_to_line()
  • dlib.skeleton()
  • dlib.sobel_edge_detector()
  • dlib.solve_structural_svm_problem()
  • dlib.spatially_filter_image()
  • dlib.spatially_filter_image_separable()
  • dlib.sub_image()
  • dlib.suppress_non_maximum_edges()
  • dlib.test_binary_decision_function()
  • dlib.test_ranking_function()
  • dlib.test_regression_function()
  • dlib.test_sequence_segmenter()
  • dlib.test_shape_predictor()
  • dlib.test_simple_object_detector()
  • dlib.threshold_filter_singular_values()
  • dlib.threshold_image()
  • dlib.tile_images()
  • dlib.train_sequence_segmenter()
  • dlib.train_shape_predictor()
  • dlib.train_simple_object_detector()
  • dlib.transform_image()
  • dlib.translate_rect()
  • dlib.zero_border_pixels()
  • dlib.cuda.get_device()
  • dlib.cuda.get_num_devices()
  • dlib.cuda.set_device()
  • dlib.image_dataset_metadata.load_image_dataset_metadata()
  • dlib.image_dataset_metadata.save_image_dataset_metadata()

Detailed API Listing

dlib.add_lib_to_dll_path(path)

On windows you must call os.add_dll_directory() to allow linking to external DLLs. See https://docs.python.org/3.8/whatsnew/3.8.html#bpo-36085-whatsnew. This function adds the folder containing path to the dll search path.