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

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

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

3# @author Matthew Andrew 

4 

5 

6from .._scipp import core as _cpp 

7from ._cpp_wrapper_util import call_func as _call_cpp_func 

8 

9 

10def counts_to_density( 

11 x: _cpp.DataArray | _cpp.Dataset, dim: str 

12) -> _cpp.DataArray | _cpp.Dataset: 

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

14 

15 Parameters 

16 ---------- 

17 x: 

18 Data as counts. 

19 dim: 

20 Dimension on which to convert. 

21 

22 Returns 

23 ------- 

24 : 

25 Data as count density. 

26 """ 

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

28 

29 

30def density_to_counts( 

31 x: _cpp.DataArray | _cpp.Dataset, dim: str 

32) -> _cpp.DataArray | _cpp.Dataset: 

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

34 

35 Parameters 

36 ---------- 

37 x: 

38 Data as count density. 

39 dim: 

40 Dimension on which to convert. 

41 

42 Returns 

43 ------- 

44 : 

45 Data as counts. 

46 """ 

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