cngi.image.statistics

statistics(xds, dv='IMAGE', name='statistics', compute=False)[source]

Generate statistics on specified image data contents

Resulting data is placed in the attributes section of the dataset

Parameters
  • xds (xarray.core.dataset.Dataset) – input Image Dataset

  • dv (str) – name of data_var in xds to compute statistics on. Default is ‘IMAGE’

  • name (str) – name of the attribute in xds to hold statistics dictionary. Default is ‘statistics’

  • compute (bool) – execute the DAG to compute the statistics. Default False returns lazy DAG (statistics can then be retrieved via xds.<name>.<key>.values)

Returns

output Image

Return type

xarray.core.dataset.Dataset