GetGroup

Top  Previous  Next

GetGroup (GroupID, Treatment)

 

The GetGroup indicator combines data from all of the SendGroup indicators in open charts with the same GroupID. The GetGroup indicator compresses the multiple data streams into a single stream by a user specified function such as summing, minimum or maximum value or averaging; therefore the data streams should be in the same numeric range and have a similar logical function.

 

Where:

GroupID identifies the set of data streams that are transmitted, either from one or multiple charts.  The number is a user-supplied integer from 0 to 32000.  Each Group can have several Members, which means that you can combine data from multiple charts into a single data stream.

 

Note: GroupID = 0 is special and will automatically reference all groups regardless of GroupID number.

 

Treatment is a number which signifies which of four mathematical functions is applied to compress all of the data streams included in the SendGroup indicators into a single data stream.

 

     0 - Sum of all streams in the group

     1 - Minimum of the stream entries in the group

     2 - Maximum of the stream entries in the group

     3 - Average of the stream entries in the group

 

Note:  None of the data on the chart which displays the GetGroup indicator is included in the calculation.

During an active NeuroShell session, the SendGroup GroupId/MemberId combination must be unique. These unique numbers are arbitrary, chosen by the user, and serve only to relate the send data to the get function. If duplicates are allowed to run then data will be lost; results will not be as expected. GroupIds are not unique and serve to relate streams, which are of similar numeric range and similar logical function.

 

Date: defaults to a value the user should not change

 

getgroup