Skip to main content

vame.analysis.videowriter

Variational Animal Motion Embedding 1.0-alpha Toolbox © K. Luxem & P. Bauer, Department of Cellular Neuroscience Leibniz Institute for Neurobiology, Magdeburg, Germany

https://github.com/LINCellularNeuroscience/VAME Licensed under GNU General Public License v3.0

get_cluster_vid​

def get_cluster_vid(cfg: dict,
                    path_to_file: str,
                    file: str,
                    n_cluster: int,
                    videoType: str,
                    flag: str,
                    param: Parametrizations,
                    output_video_type: str = ".mp4",
                    tqdm_logger_stream: TqdmToLogger | None = None) -> None

Generate cluster videos.

Arguments:

  • cfg dict - Configuration parameters.
  • path_to_file str - Path to the file.
  • file str - Name of the file.
  • n_cluster int - Number of clusters.
  • videoType str - Type of input video.
  • flag str - Flag indicating the type of video (motif or community).

Returns:

None - Generate cluster videos and save them to fs on project folder.

motif_videos​

@save_state(model=MotifVideosFunctionSchema)
def motif_videos(config: Union[str, Path],
                 parametrization: Parametrizations,
                 videoType: str = '.mp4',
                 output_video_type: str = '.mp4',
                 save_logs: bool = False) -> None

Generate motif videos.

Arguments:

  • config Union[str, Path] - Path to the configuration file.
  • videoType str, optional - Type of video. Default is '.mp4'.
  • output_video_type str, optional - Type of output video. Default is '.mp4'.

Returns:

None - Generate motif videos and save them to filesystem on project cluster_videos folder.

community_videos​

@save_state(model=CommunityVideosFunctionSchema)
def community_videos(config: Union[str, Path],
                     parametrization: Parametrizations,
                     videoType: str = '.mp4',
                     save_logs: bool = False,
                     output_video_type: str = '.mp4') -> None

Generate community videos.

Arguments:

  • config Union[str, Path] - Path to the configuration file.
  • videoType str, optional - Type of video. Default is '.mp4'.

Returns:

None - Generate community videos and save them to filesystem on project community_videos folder.