Method get_metrics

scenedetect/stats_manager.py:126–135

Return the requested statistics/metrics for a given timecode. Returns: A list containing the requested frame metrics for the given frame number, ordered as they are in `metric_keys`.

(
        self, timecode: int | FrameTimecode, metric_keys: ty.Iterable[str]
    )

    # TODO(https://scenedetect.com/issues/507): We should support the dictionary protocol instead
    # of using this bespoke interface. It would be useful for Pandas compatibility as well.
    def get_metrics(
        self, timecode: int | FrameTimecode, metric_keys: ty.Iterable[str]
    ) -> list[ty.Any]:
        """Return the requested statistics/metrics for a given timecode.

        Returns:
            A list containing the requested frame metrics for the given frame number, ordered as
            they are in `metric_keys`.
        """
        return [self._get_metric(timecode, metric_key) for metric_key in metric_keys]

    def set_metrics(self, timecode: int | FrameTimecode, metric_kv_dict: dict[str, ty.Any]) -> None:
        """Set Metrics: Sets the provided statistics/metrics for a given frame.