Page History

 -- pyami module --

connect(Server_Group, CDS_interface, FEZ_interface)
    Connects the module to the group of monitoring servers.
    The input parameters are specific to the hutch.
    If the last two parameters are omitted, they will be learned from the
    available network interfaces on the host.
    This must be called before any of the following class methods.

class pyami.Entry(name,'Scalar')
    Monitors data from the scalar variable 'name'.  A dictionary of
    ('Scalar', n_events, mean, rms) is accumulated.

class pyami.Entry(name,'TH1F',nbins,xlo,xhi)
    Monitors data from the scalar variable 'name'.  A dictionary of
    (type='TH1F', uflow, oflow, data=( n_bin0, n_bin1, ...)) is accumulated.

class pyami.Entry(name,'Scan',xvariable,nbins)
    Monitors data from the scalar variable 'name'.  A dictionary of
    (type='Scan', nbins, current, xbins=( x0, x1, ...), yentries=( n0, n1, ...),
     ysum=( y0, y1, ...), y2sum=( y2_0, y2_1, ...)) is accumulated; where
    'current' is the bin with the most recent entry, 'xbins' is a list of unique x-variable values,
    'yentries' is a list of the number of summed entries with that x-variable value,
    'sum' is a list of the sum of y-variables values in each bin, 'y2sum' is a list of the sum
    of y-variable values squared in each bin.  The lists are of length 'nbins' with only the most
    recent entries retained.

class pyami.Entry(det_identifier) or
class pyami.Entry(det_identifier,channel)
    Monitors the data from the detector associated with 'det_identifier' and
    'channel'.  A dictionary of data averaged over events is accumulated.  The
    dimensions and binning of the data are determined from the detector.
    The dictionary format is
    (type='Waveform', entries=events, xlow, xhigh, data=(y0, y1, ...)) or
    (type='Image', entries=events, offset=dark_level, ppxbin, ppybin,
        data=((row0col0,row0col1,...),(row1col0,row1col1,...))) or
    (type='ImageArray', entries=events, offset=dark_level, ppxbin, ppybin,
        data=( ((row0col0,row0col1,...),(row1col0,row1col1,...))_0,
               ((row0col0,row0col1,...),(row1col0,row1col1,...))_1,
               ... ))

    Each of the above methods also takes an optional final string argument that
    defines an event filter.  The string must take the form:
    
        _lo_value_<_scalar_name_<_hi_value_  or
        (_expr1_)&(_expr2_)                  or
        (_expr1_)|(_expr2_)

    where _expr1_ and _expr2_ also take one of the forms.

Members:

    Entry.get()
        Returns the data accumulated since the object was created.
    Entry.clear()
        Resets the data accumulation.