Documentation Set for Swarm 2.2
Prev | Reference IX. Analysis Library | Next

# EZBin

## Name

EZBin -- An easy to use histogram interface.

## Description

This class allows the user to easily histogram data generated by a collection of objects. In addition the class will generate some standard statistics over the resulting dataset.

## Protocols adopted by EZBin

SwarmObject GUIComposite CREATABLE

## Methods

### Phase: Creating

- - setColors: (const char * const *)colors count: (unsigned)count
  Set a custom vector of colors for the histogram bars

- - setUpperBound: (double)theMax
  The setUpperBound method sets the non-inclusive upper bound on the histogram range.

- - setLowerBound: (double)theMin
  The setLowerBound method sets the inclusive lower bound on the histogram range.

- - setBinCount: (unsigned)theBinCount
  The setBinCount method sets the number of bins the histogram will have.

- - setMonoColorBars: (BOOL)mcb
  The setMonoColorBars method specifies whether all bars should be shown in a single color (blue). The default is differently colored bars.

- - setAxisLabelsX: (const char *)xl Y: (const char *)yl
  The setAxisLabels:X:Y method sets the horizontal and vertical labels on the histogram in the graphical version of EZBin. (Only relevant if the state of setGraphics is set to 1.)

- - setFileName: (const char *)fileName
  The setFileName method sets the name used for disk file data output. (Only relevant if the state of seFileOutput is set to 1.) If not set, the filename defaults to be the same as the graph title.

- - setTitle: (const char *)title
  The setTitle method uses a title string to label a graph window in the graphical version of EZBin. The label appears at the top of the graph window. (Only relevant if the state of setGraphics is set to 1.)

- - setFileOutput: (BOOL)state
  The setFileOutput method sets the state of file I/O. Set the state to 1 if data for the sequences is to be sent to a file. The default state is 0 meaning that by default no file I/O is carried out by the EZBin class.

- - setProbedSelector: (SEL)aSel
  The setProbedSelector method sets the selector that will be applied to the objects in the specified collection in order to generate the dataset (inherited from MessageProbe.)

- - setCollection: aCollection
  The setCollection method sets the collection of target objects which will be requested to generate the dataset for the histogram.

- - setGraphics: (BOOL)state
  The setGraphics method sets the state of the display. Set the state to 0 if a graphical display of the graph is not required. The default state is 1 meaning that by default the data appears graphically in a window.

### Phase: Using

- - (const char *)getFileName
  Return the filename string.

- - (const char *)getTitle
  Return the title string.

- - (id <Histogram>)getHistogram
  Return the histogram widget.

- - (double)getStdDev
  The getStd method gets the standard deviation in the dataset. The value is read out of the object, not computed everytime it is asked for.

- - (double)getAverage
  The getAverage method gets the average value in the dataset. The value is read out of the object, not computed everytime it is asked for.

- - (double)getMax
  The getMax method gets the maximum value in the dataset.

- - (double)getMin
  The getMin method gets the minimum value in the dataset.

- - (double)getUpperBound
  The getUpperBound method gets the upper bound on the histogram range.

- - (double)getLowerBound
  The getLowerBound method gets the lower bound on the histogram range.

- - (unsigned)getBinColorCount
  The getBinColorCount method gets the number of distinct bin colors allocated (by default, or by the user).

- - (unsigned)getBinCount
  The getBinCount method gets the number of bins in the histogram.

- - (unsigned)getOutliers
  The getOutliers method gets the number of entries which landed out of the bounds of the histogram. Pressing the "o" key on the graphical representation of the histogram will display this value both as an integer and as a percentage of the total number of attempted entries.

- - (unsigned)getCount
  The getCount method gets the number of entries which landed within the bounds of the histogram.

- - (unsigned *)getDistribution
  The getDistribution method returns an array of integers containing the number of entries which landed in each bin of the histogram.

- - (void)output
  The output: method combines the actions of -outputGraph and -outputToFile. If graph updates and file output need to happen at different frequencies, schedule calls to -outputGraph and -outputToFile instead of -output.

- - (void)outputToFile
  The outputToFile method causes the number of entries per bin to be sent to the output file, using the data extracted by the previous call to update. If setFileOutput==0, nothing is done.

- - (void)outputGraph
  The ouputGraph method causes the graphical display to be updated with the information extracted by the previous call to update. If setGraphics==0, nothing is done.

- - (void)update
  The update method polls the collection of objects and adds the data to the final data set. It is possible to poll the same collection of objects repeatedly, thus increasing the amount of data included in the final dataset, before generating output.

- - (void)reset
  The reset method resets the histogram.

- - (void)setPrecision: (unsigned)precision
  Sets the number of significant figures shown for major-tick labels.

Prev | Home | Next
EZAverageSequence | Up | EZDistribution