Skip to content

deeplabcut.create_project.add

Functions:

Name Description
add_new_videos

Add new videos to the config file at any stage of the project.

add_new_videos 

add_new_videos(config, videos, copy_videos=False, coords=None, extract_frames=False)

Add new videos to the config file at any stage of the project.

Parameters

config : string String containing the full path of the config file in the project.

list

A list of strings containing the full paths of the videos to include in the project.

bool, optional

If this is set to True, the videos will be copied to your project/videos directory. If False, the symlink of the videos will be copied instead. The default is False; if provided it must be either True or False.

list, optional

A list containing the list of cropping coordinates of the video. The default is set to None.

bool, optional

if this is set to True extract_frames will be run on the new videos

Examples

Video will be added, with cropping dimensions according to the frame dimensions of mouse5.avi

deeplabcut.add_new_videos( '/home/project/reaching-task-Tanmay-2018-08-23/config.yaml',['/data/videos/mouse5.avi'] )

Video will be added, with cropping dimensions [0,100,0,200]

deeplabcut.add_new_videos( '/home/project/reaching-task-Tanmay-2018-08-23/config.yaml', ['/data/videos/mouse5.avi'],copy_videos=False,coords=[[0,100,0,200]] )

Two videos will be added, with cropping dimensions [0,100,0,200] and [0,100,0,250], respectively.

deeplabcut.add_new_videos( '/home/project/reaching-task-Tanmay-2018-08-23/config.yaml', ['/data/videos/mouse5.avi','/data/videos/mouse6.avi'], copy_videos=False,coords=[[0,100,0,200],[0,100,0,250]])

Source code in deeplabcut/create_project/add.py 
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def add_new_videos(config, videos, copy_videos=False, coords=None, extract_frames=False):
    """Add new videos to the config file at any stage of the project.

    Parameters
    ----------
    config : string
        String containing the full path of the config file in the project.

    videos : list
        A list of strings containing the full paths of the videos to include in the project.

    copy_videos : bool, optional
        If this is set to True, the videos will be copied to your project/videos directory. If False, the symlink of the
        videos will be copied instead. The default is
        ``False``; if provided it must be either ``True`` or ``False``.

    coords: list, optional
        A list containing the list of cropping coordinates of the video. The default is set to None.

    extract_frames: bool, optional
        if this is set to True extract_frames will be run on the new videos

    Examples
    --------
    Video will be added, with cropping dimensions according to the frame dimensions of mouse5.avi
    >>> deeplabcut.add_new_videos(
        '/home/project/reaching-task-Tanmay-2018-08-23/config.yaml',['/data/videos/mouse5.avi']
        )

    Video will be added, with cropping dimensions [0,100,0,200]
    >>> deeplabcut.add_new_videos(
        '/home/project/reaching-task-Tanmay-2018-08-23/config.yaml',
        ['/data/videos/mouse5.avi'],copy_videos=False,coords=[[0,100,0,200]]
        )

    Two videos will be added, with cropping dimensions [0,100,0,200] and [0,100,0,250], respectively.
    >>> deeplabcut.add_new_videos(
        '/home/project/reaching-task-Tanmay-2018-08-23/config.yaml',
        ['/data/videos/mouse5.avi','/data/videos/mouse6.avi'],
        copy_videos=False,coords=[[0,100,0,200],[0,100,0,250]])
    """
    import os
    import shutil
    from pathlib import Path

    from ..generate_training_dataset import frame_extraction
    from ..utils import auxiliaryfunctions
    from ..utils.auxfun_videos import VideoReader

    # Read the config file
    cfg = auxiliaryfunctions.read_config(config)

    # deal with user passing a single video to add
    if isinstance(videos, str):
        videos = [videos]

    video_path = Path(config).parents[0] / "videos"
    data_path = Path(config).parents[0] / "labeled-data"
    videos = [Path(vp) for vp in videos]

    dirs = [data_path / Path(i.stem) for i in videos]

    for p in dirs:
        """Creates directory under data & perhaps copies videos (to /video)"""
        p.mkdir(parents=True, exist_ok=True)

    destinations = [video_path.joinpath(vp.name) for vp in videos]
    if copy_videos:
        for src, dst in zip(videos, destinations, strict=False):
            if dst.exists():
                pass
            else:
                print("Copying the videos")
                shutil.copy(os.fspath(src), os.fspath(dst))

    else:
        # creates the symlinks of the video and puts it in the videos directory.
        print("Attempting to create a symbolic link of the video ...")
        for src, dst in zip(videos, destinations, strict=False):
            if dst.exists():
                print(f"Video {dst} already exists. Skipping...")
                continue
            try:
                src = str(src)
                dst = str(dst)
                os.symlink(src, dst)
                print(f"Created the symlink of {src} to {dst}")
            except OSError:
                try:
                    import subprocess

                    subprocess.check_call(f"mklink {dst} {src}", shell=True)
                except (OSError, subprocess.CalledProcessError):
                    print("Symlink creation impossible (exFat architecture?): copying the video instead.")
                    shutil.copy(os.fspath(src), os.fspath(dst))
                    print(f"{src} copied to {dst}")
            videos = destinations

    if copy_videos:
        videos = destinations  # in this case the *new* location should be added to the config file
    # adds the video list to the config.yaml file
    for idx, video in enumerate(videos):
        try:
            # For windows os.path.realpath does not work and does not link to the real video.
            video_path = str(Path.resolve(Path(video)))
        #           video_path = os.path.realpath(video)
        except Exception:
            video_path = os.readlink(video)

        vid = VideoReader(video_path)
        if coords is not None:
            c = coords[idx]
        else:
            c = vid.get_bbox()
        params = {video_path: {"crop": ", ".join(map(str, c))}}
        if "video_sets_original" not in cfg:
            cfg["video_sets"].update(params)
        else:
            cfg["video_sets_original"].update(params)
    videos_str = [str(video) for video in videos]
    auxiliaryfunctions.write_config(config, cfg)
    if extract_frames:
        frame_extraction.extract_frames(config, userfeedback=False, videos_list=videos_str)
        print("New videos were added to the project and frames have been extracted for labeling!")
    else:
        print("New videos were added to the project! Use the function 'extract_frames' to select frames for labeling.")