AHELP for CIAO 4.13

# grpGetGroupSum

Context: group

## Synopsis

Apply the supplied grouping to an array.

## Syntax

```PyArray_Type grpdata = grpGetGroupSum( PyArray_Type dataArray,
PyArray_Type grouping )```

## Description

This function applies the grouping information from the grouping parameter to the dataArray parameter. The return value is an array whose length equals that of the input data (the dataArray argument) and each element within a group contains the same value. As an example,

`grpGetGroupSum( [1,2,3,4,5,6], [1,-1,1,-1,1,1] )`

will return the array

`[3,3,7,7,5,6]`

since the groups consist of the first two elements, then the next two elements, with the last two elements being un-grouped.

The group module is not available by default; to use it in a Python program, it must be loaded using the Python import function:

`  from group import *, or import group`

## Examples

### Example 1

`>>> ysum = grpGetGroupSum( y, grp );`

The ysum array will contain the data from the y array after the grouping scheme stored in the grp array is applied to it. The ysum array will have the same size as the y array. The following code shows you how you can convert ysum into an array in which each element corresponds to one group.

```>>> i = numpy.where( grp == 1 )
>>> ygrp = ysum[i];```

Here we created an array i whose elements correspond to those elements in the grp array with a value of 1 (this marks the start of a group). The ygrp array is then created by using this array to extract the corresponding elements from the ysum array. It could have been written in one line as:

`>>> ygrp = ysum[ numpy.where( grp == 1 ) ]`

### Example 2

```>>> x = numpy.arange(0.5, 6.0, 0.05)
>>> y = 3 + 30 * numpy.exp( - (x-2.0)**2 / 0.1 )
>>> ( grp, qual ) = grpNumCounts( y, 15 )
>>> ysum = grpGetGroupSum( y, grp )
>>> nchan = grpGetChansPerGroup( grp )
>>> i = numpy.where( grp == 1, qual, grp )
>>> j = numpy.where(i == 0)
>>> xstart = x[j]
>>> yavg = ysum[j] / nchan[j]```

Here we take the function

`y = 3 + 30 * exp( -(x-2)^2 / 0.1 )`

and group it by 15 counts per group. We then filter the summed array (ysum) so that it corresponds to only those elements at the start of a group - the

`grp == 1`

condition - and for which the quality flag is "good" - which is given by

`qual == 1`

This array is divided by the number of elements in each group to calculate the average value in the group. Note that the xstart array gives the start position of each group.

### Example 3

To see more examples of optional parameters and keywords in the parameter list, please see ahelp grpadaptive

## Bugs

See the bugs page for the group library on the CIAO website for an up-to-date listing of known bugs.

Refer to the CIAO bug pages for an up-to-date listing of known issues.