dataeval.metrics.stats.datasetstats
===================================

.. py:function:: dataeval.metrics.stats.datasetstats(images, bboxes = None, labels = None)

   Calculates various :term:`statistics<Statistics>` for each image

   This function computes dimension, pixel and visual metrics
   on the images or individual bounding boxes for each image as
   well as label statistics if provided.

   :param images: Images to perform calculations on
   :type images: Iterable[ArrayLike]
   :param bboxes: Bounding boxes in `xyxy` format for each image to perform calculations on
   :type bboxes: Iterable[ArrayLike] or None
   :param labels: Labels of images or boxes to perform calculations on
   :type labels: Iterable[ArrayLike] or None

   :returns: Output class containing the outputs of various stats functions
   :rtype: DatasetStatsOutput

   .. seealso:: :obj:`dimensionstats`, :obj:`labelstats`, :obj:`pixelstats`, :obj:`visualstats`, :obj:`Outliers`

   .. rubric:: Examples

   Calculating the dimension, pixel and visual stats for a dataset with bounding boxes

   >>> stats = datasetstats(stats_images, bboxes)
   >>> print(stats.dimensionstats.aspect_ratio)
   [ 0.864   0.5884 16.      1.143   1.692   0.5835  0.6665  2.555   1.3   ]
   >>> print(stats.visualstats.sharpness)
   [4.04   4.434  0.2778 4.957  5.145  5.22   4.957  3.076  2.855 ]