Coverage for install/scipp/core/counts.py: 29%

1# SPDX-License-Identifier: BSD-3-Clause 

2# Copyright (c) 2023 Scipp contributors (https://github.com/scipp) 

3# @author Matthew Andrew 

4 

5from typing import Union 

6 

7from .._scipp import core as _cpp 

8from ._cpp_wrapper_util import call_func as _call_cpp_func 

9 

10 

11def counts_to_density( 

12 x: Union[_cpp.DataArray, _cpp.Dataset], dim: str 

13) -> Union[_cpp.DataArray, _cpp.Dataset]: 

14 """Converts counts to count density on a given dimension. 

15 

16 Parameters 

17 ---------- 

18 x: 

19 Data as counts. 

20 dim: 

21 Dimension on which to convert. 

22 

23 Returns 

24 ------- 

25 : 

26 Data as count density. 

27 """ 

28 return _call_cpp_func(_cpp.counts_to_density, x, dim) 

29 

30 

31def density_to_counts( 

32 x: Union[_cpp.DataArray, _cpp.Dataset], dim: str 

33) -> Union[_cpp.DataArray, _cpp.Dataset]: 

34 """Converts counts to count density on a given dimension. 

35 

36 Parameters 

37 ---------- 

38 x: 

39 Data as count density. 

40 dim: 

41 Dimension on which to convert. 

42 

43 Returns 

44 ------- 

45 : 

46 Data as counts. 

47 """ 

48 return _call_cpp_func(_cpp.density_to_counts, x, dim)