📄 swarm.analysis.ezbin.protocol.html
字号:
<HTML><HEAD><TITLE>EZBin</TITLE><METANAME="GENERATOR"CONTENT="Modular DocBook HTML Stylesheet Version 1.53"><LINKREL="HOME"TITLE="Documentation Set for Swarm 2.1.1"HREF="set.html"><LINKREL="UP"TITLE="Analysis Library"HREF="swarm.analysis.sgml.reference.html"><LINKREL="PREVIOUS"TITLE="EZAverageSequence"HREF="swarm.analysis.ezaveragesequence.protocol.html"><LINKREL="NEXT"TITLE="EZDistribution"HREF="swarm.analysis.ezdistribution.protocol.html"></HEAD><BODYCLASS="REFENTRY"BGCOLOR="#FFFFFF"TEXT="#000000"LINK="#0000FF"VLINK="#840084"ALINK="#0000FF"><DIVCLASS="NAVHEADER"><TABLEWIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><THCOLSPAN="3"ALIGN="center">Documentation Set for Swarm 2.1.1</TH></TR><TR><TDWIDTH="10%"ALIGN="left"VALIGN="bottom"><AHREF="swarm.analysis.ezaveragesequence.protocol.html">Prev</A></TD><TDWIDTH="80%"ALIGN="center"VALIGN="bottom">Reference IX. Analysis Library</TD><TDWIDTH="10%"ALIGN="right"VALIGN="bottom"><AHREF="swarm.analysis.ezdistribution.protocol.html">Next</A></TD></TR></TABLE><HRALIGN="LEFT"WIDTH="100%"></DIV><H1><ANAME="SWARM.ANALYSIS.EZBIN.PROTOCOL">EZBin</A></H1><DIVCLASS="REFNAMEDIV"><ANAME="AEN21640"></A><H2>Name</H2>EZBin -- An easy to use histogram interface.</DIV><DIVCLASS="REFSECT1"><ANAME="AEN21643"></A><H2>Description</H2><P> 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.</P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN21646"></A><H2>Protocols adopted by EZBin</H2><P> <AHREF="swarm.objectbase.swarmobject.protocol.html">SwarmObject</A> <AHREF="swarm.simtoolsgui.guicomposite.protocol.html">GUIComposite</A> <AHREF="swarm.defobj.creatable.protocol.html">CREATABLE</A></P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN21652"></A><H2>Methods</H2><DIVCLASS="REFSECT2"><ANAME="AEN21654"></A><H3>Phase: Creating</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M51"></A><P></P>+ <BCLASS="FUNCPROTOTYPE">createBegin:</B> (id <Zone>)<VARCLASS="PDPARAM">aZone</VAR> <BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M767"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setGraphics:</B> (BOOL)<VARCLASS="PDPARAM">state</VAR> <BR> 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. <P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M704"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setCollection:</B> <VARCLASS="PDPARAM">aCollection</VAR> <BR> The setCollection method sets the collection of target objects which will be requested to generate the dataset for the histogram.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M834"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setProbedSelector:</B> (SEL)<VARCLASS="PDPARAM">aSel</VAR> <BR> 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.)<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M757"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setFileOutput:</B> (BOOL)<VARCLASS="PDPARAM">state</VAR> <BR> 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.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M883"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setTitle:</B> (const char *)<VARCLASS="PDPARAM">title</VAR> <BR> 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.)<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M755"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setFileName:</B> (const char *)<VARCLASS="PDPARAM">fileName</VAR> <BR> 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.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M678"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setAxisLabelsX:</B> (const char *)<VARCLASS="PDPARAM">xl</VAR> <BCLASS="FUNCPROTOTYPE">Y:</B> (const char *)<VARCLASS="PDPARAM">yl</VAR> <BR> 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.)<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M802"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setMonoColorBars:</B> (BOOL)<VARCLASS="PDPARAM">mcb</VAR> <BR> The setMonoColorBars method specifies whether all bars should be shown in a single color (blue). The default is differently colored bars.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M685"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setBinCount:</B> (unsigned)<VARCLASS="PDPARAM">theBinCount</VAR> <BR> The setBinCount method sets the number of bins the histogram will have.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M794"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setLowerBound:</B> (double)<VARCLASS="PDPARAM">theMin</VAR> <BR> The setLowerBound method sets the inclusive lower bound on the histogram range. <P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M887"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setUpperBound:</B> (double)<VARCLASS="PDPARAM">theMax</VAR> <BR> The setUpperBound method sets the non-inclusive upper bound on the histogram range.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M710"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setColors:</B> (const char * const *)<VARCLASS="PDPARAM">colors</VAR> <BCLASS="FUNCPROTOTYPE">count:</B> (unsigned)<VARCLASS="PDPARAM">nc</VAR> <BR> Set a custom vector of colors for the histogram bars<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PC.M228"></A><P></P>- <BCLASS="FUNCPROTOTYPE">createEnd</B><BR><P></P></DIV></LI></UL></DIV><DIVCLASS="REFSECT2"><ANAME="AEN21786"></A><H3>Phase: Using</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M826"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setPrecision:</B> (unsigned)<VARCLASS="PDPARAM">precision</VAR> <BR> Sets the number of significant figures shown for major-tick labels.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M645"></A><P></P>- <BCLASS="FUNCPROTOTYPE">reset</B><BR> The reset method resets the histogram.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M935"></A><P></P>- <BCLASS="FUNCPROTOTYPE">update</B><BR> 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.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M590"></A><P></P>- <BCLASS="FUNCPROTOTYPE">outputGraph</B><BR> 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.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M591"></A><P></P>- <BCLASS="FUNCPROTOTYPE">outputToFile</B><BR> 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.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M589"></A><P></P>- <BCLASS="FUNCPROTOTYPE">output</B><BR> 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.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M367"></A><P></P>- (unsigned *)<BCLASS="FUNCPROTOTYPE">getDistribution</B><BR> The getDistribution method returns an array of integers containing the number of entries which landed in each bin of the histogram.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M348"></A><P></P>- (unsigned)<BCLASS="FUNCPROTOTYPE">getCount</B><BR> The getCount method gets the number of entries which landed within the bounds of the histogram.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M446"></A><P></P>- (unsigned)<BCLASS="FUNCPROTOTYPE">getOutliers</B><BR> 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.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M323"></A><P></P>- (unsigned)<BCLASS="FUNCPROTOTYPE">getBinCount</B><BR> The getBinCount method gets the number of bins in the histogram.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M322"></A><P></P>- (unsigned)<BCLASS="FUNCPROTOTYPE">getBinColorCount</B><BR> The getBinColorCount method gets the number of distinct bin colors allocated (by default, or by the user).<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M419"></A><P></P>- (double)<BCLASS="FUNCPROTOTYPE">getLowerBound</B><BR> The getLowerBound method gets the lower bound on the histogram range.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M519"></A><P></P>- (double)<BCLASS="FUNCPROTOTYPE">getUpperBound</B><BR> The getUpperBound method gets the upper bound on the histogram range.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M429"></A><P></P>- (double)<BCLASS="FUNCPROTOTYPE">getMin</B><BR> The getMin method gets the minimum value in the dataset.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M422"></A><P></P>- (double)<BCLASS="FUNCPROTOTYPE">getMax</B><BR> The getMax method gets the maximum value in the dataset.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M318"></A><P></P>- (double)<BCLASS="FUNCPROTOTYPE">getAverage</B><BR> 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.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M495"></A><P></P>- (double)<BCLASS="FUNCPROTOTYPE">getStd</B><BR> 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.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M393"></A><P></P>- (id <Histogram>)<BCLASS="FUNCPROTOTYPE">getHistogram</B><BR> Return the histogram widget.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M506"></A><P></P>- (const char *)<BCLASS="FUNCPROTOTYPE">getTitle</B><BR> Return the title string.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZBIN.METHOD.PU.M381"></A><P></P>- (const char *)<BCLASS="FUNCPROTOTYPE">getFileName</B><BR> Return the filename string.<P></P></DIV></LI></UL></DIV></DIV><DIVCLASS="NAVFOOTER"><HRALIGN="LEFT"WIDTH="100%"><TABLEWIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top"><AHREF="swarm.analysis.ezaveragesequence.protocol.html">Prev</A></TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="set.html">Home</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top"><AHREF="swarm.analysis.ezdistribution.protocol.html">Next</A></TD></TR><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top">EZAverageSequence</TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="swarm.analysis.sgml.reference.html">Up</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top">EZDistribution</TD></TR></TABLE></DIV></BODY></HTML>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -