dataeval.metrics.stats.dimensionstats
=====================================

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

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

   This function computes various dimensional metrics (e.g., width, height, channels)
   on the images or individual bounding boxes for each image.

   :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

   :returns: A dictionary-like object containing the computed dimension statistics for each image or bounding
             box. The keys correspond to the names of the statistics (e.g., 'width', 'height'), and the values
             are lists of results for each image or :term:NumPy` arrays when the results are multi-dimensional.
   :rtype: DimensionStatsOutput

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

   .. rubric:: Examples

   Calculating the dimension statistics on the images, whose shape is (C, H, W)

   >>> results = dimensionstats(stats_images)
   >>> print(results.aspect_ratio)
   [1.     1.     1.333  1.     0.6665]
   >>> print(results.channels)
   [3 3 1 3 1]