| |
- Boost.Python.instance(__builtin__.object)
-
- Canvas
- CanvasWindow
- CutController
- DataArray
- DataRep
- DataSource
-
- FitsNTuple
- ListTuple
- NTupleInternal
-
- CircularBuffer
- NTuple
- NumArrayTuple
- RootNTuple
- Display
-
- Cut
- FCNBase
-
- StatedFCN
-
- NTupleFCN
- FactoryPointRep
-
- PointRepFactory
- FitsController
- Fitter
- FitterFactory
- Function
- FunctionBase
- FunctionFactory
- HDApp
- NTupleController
- Observable
- Observer
- RepBase
- RootController
class Canvas(Boost.Python.instance) |
|
The HippoDraw canvas.
This class provides an interface to the canvas.
One can take various actions that are also
available from menu items in the canvas window. |
|
- Method resolution order:
- Canvas
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- addDisplay(...)
- addDisplay ( Display ) -> None
Adds a display to the canvas.
- addText(...)
- addText ( Display, string ) -> None
Adds text to display.
- addTextAt(...)
- addTextAt ( Display, string, value, value ) -> None
Adds text to a display at specified position
Position is fraction of width and height.
- addTextAtAbs(...)
- addTextAt ( Display, string, value, value ) -> None
Adds text to a display at specified position
Position is absolute value of the date point.
- addTextRep(...)
- addTextRep ( Display, string ) -> None
Adds textual data representation to display. Use
Canvas.getTextRepTypes() to see available types.
- clear(...)
- clear () -> None
Removes all items from the canvas
- close(...)
- close () -> None
Closes the window.
- getCut(...)
- getCut () -> Cut
Returns the currently selected Cut object.
- getDisplay(...)
- getDisplay () -> Display
Returns the selected Display object.
- getDisplays(...)
- getDisplays () -> tuple
Returns a tuple of all Display objects on the canvas.
- getHeight(...)
- getHeight ( Display ) -> value
Returns the height of the Display.
- getPickTable(...)
- getPickTable ( Display ) -> NTuple
Gets the pick table of the Display.
- getSelPickTable(...)
- getSelPickTable () -> NTuple
Gets the pick table for selected Display.
- getTextRepTypes(...)
- getTextRepTypes () -> tuple
Returns the types of textual data representations available.
- getWidth(...)
- getWidth ( Display ) -> value
Returns the width of the Display.
- getX(...)
- getX ( Display ) -> value
Returns the X coordinate of the Display.
- getY(...)
- getY ( Display ) -> value
Returns the Y coordinate of the Display. Note that Y=0 is
at the top and Y increases downward.
- mouseData(...)
- mouseData () -> tuple
Returns a tuple of picked data.
- printTo(...)
- printTo ( string ) -> None
Prints the canvas to PostScript file.
- removeDisplay(...)
- removeDisplay ( Display ) -> None
Removes the display from the canvas.
- saveAs(...)
- saveAs ( string ) -> None
Save the canvas as a XML file.
- saveAsImage(...)
- saveAsImage ( Display, string ) -> None
Save a display as an image file.
The suffix of the file name controls the image type.
- saveSelectedImages(...)
- saveSelectedImages ( string ) -> None
Save the selected displays as an image file.
The suffix of the file name controls the image type.
- selectAllDisplays(...)
- selectAllDisplays ( Boolean ) -> None
Sets all displays to selected state or not.
- selectDisplay(...)
- selectDisplay ( Display ) -> None
Sets a display to selected state.
- setHeight(...)
- setHeight ( Display, value ) -> None
Sets the height of the Display.
- setPlotMatrix(...)
- setPlotMatrix ( columns, rows ) -> None
Sets the number of columns and rows of plots for each page.
- setWidth(...)
- setWidth ( Display, value ) -> None
Sets the width of the Display.
- setX(...)
- setX ( Display, value ) -> None
Sets the X coordinate of the Display
- setY(...)
- setY ( Display, value ) -> None
Sets the Y coordinate of the Display. Note that Y = 0 is
at the top and Y increases downward.
- show(...)
- show () -> None
Displays the canvas window on the screen. One only needs
to use this method if running HippoDraw in the Python
thread.
- swapOrientation(...)
- swapOrientation ( ) -> None
Swaps the canvas' orientation from portrait to landscape
or vice verse.
Data and other attributes defined here:
- __instance_size__ = 32
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class CanvasWindow(Boost.Python.instance) |
|
The CanvasWindow class contains the Canvas and some controls via
menu items and dialogs. |
|
- Method resolution order:
- CanvasWindow
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- fileNew(...)
- fileNew ( None ) -> None
Creates a new CanvasWindow.
- show(...)
- show ( None ) -> None
Brings the canvas window onto the screen.
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class CircularBuffer(NTupleInternal) |
|
A circular buffer in a NTuple that adds rows up to a defined number,
then starts replacing the oldest rows. |
|
- Method resolution order:
- CircularBuffer
- NTupleInternal
- DataSource
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- CircularBuffer ( None ) -> CircularBuffer
CircularBuffer ( value ) -> CircularBuffer
CircularBuffer ( string ) -> CircularBuffer
CircularBuffer ( sequence ) -> CircularBuffer
CircularBuffer ( CircularBuffer ) -> CircularBuffer
There are five forms of construction of a CircularBuffer. The
first form creates an empty one. The second from creates an empty
one with `value' number of columns. The third from creates an
empty one the number of columns equal to the size of the sequence.
The column labels are taken from the sequence. The final form is
the copy constructor.
- addRow(...)
- addRow ( sequence ) -> None
Append a row at the end of the table until it is full,
then replace the oldest row.
- clear(...)
- clear ( None ) -> None
Clears the contents of the buffer
- reserve(...)
- reserve ( value ) -> None
Sets the maximum size of the buffer
Data descriptors defined here:
- columns
- rows
Data and other attributes defined here:
- __instance_size__ = 124
Methods inherited from NTupleInternal:
- getLabel(...)
- getLabel ( index ) -> string
Returns the label at column index.
- getRow(...)
- getRow ( index ) -> list
Returns the index row as list floats.
- setIntervalCount(...)
- setIntervalCount ( count ) -> None
Sets the interval count between updates to the observers.
- setIntervalEnabled(...)
- setIntervalEnable ( Boolean ) -> None
Sets the interval counting on or off
- setLabels(...)
- setLabels ( sequence ) -> None
Sets the labels of the columns from the list of strings. If the
NTuple is empty, then also sets the number of columns to be the
size of the list. If the number of columns has already been
set, the the size of the list should be the same, otherwise
a RuntimeError exception is thrown.
Methods inherited from DataSource:
- getColumn(...)
- getColumn ( label ) -> list
getColumn ( index ) -> list
Get a column by its label or index. Returns copy of the
contents.
- getLabels(...)
- getLabels () -> list
Returns list of column labels.
- getTitle(...)
- getTitle () -> string
Returns the title of the ntuple.
- replaceColumn(...)
- replaceColumn ( label, list ) -> None
Replaces the column of data by abel.
- setName(...)
- setName ( string ) -> None
Sets the name of the ntuple. The name should be a unique
string withing a running application. It may appear in the
Inspector.
- setTitle(...)
- setTitle ( string ) -> None
Sets the title of the ntuple. The title by default appears at
the top of a Display.
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class Cut(Display) |
|
An object of this class applies a cut or filter on the data that is
used as input to its target displays. |
|
- Method resolution order:
- Cut
- Display
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- Cut ( DataSource, sequence ) -> Cut
Cut ( DataArray, sequence ) -> Cut
Cut ( DataSource, sequence, Display, value, value ) -> Cut
Cut ( DataArray, sequence, Display, value, value ) -> Cut
Creates a Cut bound to DataSource. For each form, the first
argument is the DataSource and the second argument is sequence of
strings specifying the binding. The latter two forms apply the
Cut to a Display with low and high values for the Cut range.
- addTarget(...)
- addTarget ( Display ) -> None
Adds a Display to the list of targets.
- addTargets(...)
- addTargets ( sequence ) -> None
Adds Display objects in the sequence to the list targets
- cutRange(...)
- cutRange () -> tuple
Returns a pair of values of the range of each Cut.
- setCutRange(...)
- setCutRange ( value, value, string ) -> None
Sets the range of the Cut. Arguments are low and high values,
and the axis.
- setEnabled(...)
- setEnabled ( Boolean ) -> None
Sets the cut to be enabled or not
- toggleInverted(...)
- toggleInverted () -> None
Toggles the inversion status
Static methods defined here:
- createFits(...)
- createFits ( sequence, sequence, DataSource, string, string )->None
Create a new FITS file using cut list and column list.
This method is deprecated, use the FitsController instead.
- createNTuple(...)
- createNTuple ( sequence, sequence, DataSource ) -> NTuple
Create a new NTuple using cut list and column list.
- createTnt(...)
- createTnt ( sequence, sequence, DataSource, string, string )-> None
Create a new TNT file using cut list and column list.
Data and other attributes defined here:
- __instance_size__ = 48
Methods inherited from Display:
- addDataRep(...)
- addDataRep ( DataRep ) -> Display
addDataRep ( Function ) -> Display
addDataRep ( string, DataSource, tuple ) -> Display
Adds a DataRep to the display sharing the same Y axis range
The first two methods adds existing DataRep or Function to the
Display. The third method creates and adds DataRep to the
Display. Arguments are same as Display constructor.
- addDataRepStacked(...)
- addDataRepStacked ( string, DataSource, tuple ) -> Display
Creates and adds a DataRep with independent Y axis ranges.
The arguments are the same as Display constructor.
- addFunction(...)
- addFunction ( FunctionBase ) -> None
Adds a FunctionBase object to the display by appropriately
wrapping it with a Function.
- addObserver(...)
- addObserver ( Observer ) -> None
Adds an Observer to the Display object.
- addValues(...)
- addValue ( tuple ) -> None
For static histograms, adds a value to the accumulation.
For 1D histogram, the tuple should contain one or two values,
the second used as a weight. For 2D histogram, the tuple should
contain two or three elements, the third being the weight.
non static Displays do nothing.
- applyCut(...)
- applyCut ( Cut ) -> None
Apply a Cut to the Display
- applyCuts(...)
- applyCuts ( sequence ) -> None
Apply each Cut in the sequence to the Display
- createDataArray(...)
- createDataArray ( ) -> DataArray
Returns a DataArray representation of the Display's contents
(This method available if configured with numarray)
- currentView(...)
- currentView ( ) -> int
Index of the current view.
- deleteView(...)
- deleteView ( int ) -> None
Delete a view by index.
- getBinWidth(...)
- getBinWidth ( string ) -> value
Returns the bin width on axis specified as a string,
e.g., 'x'.
- getDataRep(...)
- getDataRep ( ) -> DataRep
Returns a reference to the active DataRep or if all DataRep objects are
active, returns a reference to the first one.
- getDataReps(...)
- getDataReps ( ) -> list
Returns a list of DataRep objects contained by the Display..
- getLabel(...)
- getLabel ( string ) -> string
Returns the label of the axis specified as a string,
e.g., 'x'.
- getLog(...)
- getLog ( string ) -> value
Returns True if axis specified as a string, e.g. 'x', is being
displayed on a logarithmic scale.
- getRange(...)
- getRange ( string ) -> tuple
Returns the tuple representing the range for the axis specified
as a string, e.g., 'x'.
- getTitle(...)
- getTitle () -> string
Returns the current title. The title will be the title of
the DataSource unless it has been explicitly changed.
- nextView(...)
- nextView ( bool ) -> int
Cycle to the next view in the view buffer. Set the argument to True to cycle for wards, False to cycle back wards.
Returns the index of the new view.
- numViews(...)
- numViews ( ) -> int
Return the number of stored views.
- numberOfEntries(...)
- numberOfEntries ( ) -> value
Returns the number of entries in the Display.
- plotterId(...)
- plotterId () -> value
Returns a unique identifier for the Display.
- reset(...)
- reset () -> None
Resets the contents of all bins. Only applicable to static
histograms.
- resize(...)
- resize () -> None
Resizes the Display to its saved values.
- saveView(...)
- saveView ( ) -> int
Saves the current set of x and y ranges and returns the index of the saved view.
- setAspectRatio(...)
- setAspectRatio ( value ) -> None
Sets the required aspect ratio of the Display to value, the
ratio of the width to the height.
- setAutoRanging(...)
- setAutoRanging ( string, Boolean ) -> None
Sets auto-ranging on axis specified as a string, e.g. 'x',non or off.
- setAutoTicks(...)
- setAutoTicks ( Boolean ) -> None
Set the ticks generation to be automatic (the default) or
manually.
- setBinWidth(...)
- Set the bin width, explicitly saving the value or not.
setBinWidth ( string, value ) -> None
Set the bin width to value on axis specified as a string,
e.g., 'x'.
- setColorMap(...)
- setColorMap ( string ) -> None
Set the value-to-color map to one named by the argument.
- setContourLevels(...)
- setContourLevels ( sequence ) -> None
Sets the contour levels if the Display is using contour point
representation from the values in the sequence.
- setLabel(...)
- setLabel ( string, string ) -> None
Sets the label for the axis specified by first argument to value
of the second argument.
- setLog(...)
- setLog ( string, Boolean ) -> None
Sets the axis specified by the first argument on log scale.
- setNumberOfBins(...)
- setNumberOfBins ( string, value ) -> None
Sets the number of bins on named axis, e.g. 'x' to the given
value.
- setOffset(...)
- setOffset ( string, value ) -> None
Sets the offset of the bins relative to their current width on
specified axis.
- setPointRep(...)
- setPointRep ( RepBase ) -> None
Sets the point representation to be used.
- setRange(...)
- setRange ( string, value, value ) -> None
setRange ( string, value, value, Boolean ) -> None
Set the upper and lower bounds for the specified axis. For the
second form, also save them if the Boolean argument is true.
- setTicks(...)
- setTicks ( string, sequence, sequence ) -> None
Sets the tick locations and labels. The first argument is the
axis, the second argument is a sequence containing the
locations, and the third argument is a sequence of tick labels.
- setTitle(...)
- setTitle ( string ) -> None
Sets the title of the display.
- setTransform(...)
- setTransform ( string ) -> None
Sets the transform object.
- setView(...)
- setView ( int ) -> None
Set the view by its index.
- unlock(...)
- unlock () -> None
Unlock the application thread.
- update(...)
- update () -> None
Updates the display.
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class CutController(Boost.Python.instance) |
|
The CutController class provides interface to Cut functions. |
|
- Method resolution order:
- CutController
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- createIdCut(...)
- createIdCut (source, dest ) -> None
Creates a column in dest that can be used as Cut on it,
for values in source
Static methods defined here:
- instance(...)
- instance () -> CutController
Returns the singleton instance of the controller.
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class DataArray(Boost.Python.instance) |
|
A DataArray wraps a DataSource object so that numerical Python
arrays can be used as both input and output. The numerical array
can be either a numarray.array or Numeric.array depending on
how the hippo module was configured.
Access to the array is done like a Python list or dictionary.
array = my_data_array [ index ] # list form
array = my_data_array [ 'my_label' ] # dict form
Storage to the array is also done like a Python list or dictionary.
my_data_array [ index ] = ... # list form
my_data_array [ 'my_label' ] = ... # dict form |
|
- Method resolution order:
- DataArray
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __getitem__(...)
- __getitem__ ( value ) -> array
Returns a copy of the column as numerical array. 'value' can
be either the column label or its index.
- __init__(...)
- DataArray ( string ) -> DataArray
Creates a DataArray. The string can be one of
ListTuple
NTuple
NumArrayTuple
- __setitem__(...)
- __setitem__ ( label, sequence ) -> None
Copies the contensts of the sequence. If column with label
already exists, replaces it, otherwise add a new column.
__setitem__ ( value, array ) -> None
Copies the contents of array. If `'value' is an index, then
replaces the contents of the existing column. If 'value' is
a label then either replaces existing column with that label
or adds a new column.
- addColumn(...)
- addColumn ( string, list ) -> value
addColumn ( string, array ) -> value
Adds a column. The string will be the label of the column.
A copy of the list or array values will be the contents.
The second form is only available if HippoDraw was configured
with numerical Python support. Returns the new column's index.
- addRow(...)
- addRow ( sequence ) -> None
Adds a row to the held DataSource object if supported, otherwise throws Runtime exception.
- append(...)
- append ( DataArray ) -> None
append ( DataSource ) -> None
Appends contents of DataSource or DataArray to the DataArray.
- dataSource(...)
- dataSource () -> DataSource
Returns reference to underlying DataSource
- getColumn(...)
- getColumn ( value ) -> list
Returns a column as list of floats. 'value' maybe either
the column label or its index.
- getLabels(...)
- getLabels () -> list
Returns the list of string objects of column labels.
- getTitle(...)
- getTitle () -> string
Returns title of the DataSource.
- has_key(...)
- has_key ( string ) -> Boolean
Returns True if column with label exists.
- keys(...)
- keys () -> list
Returns the list of column labels.
- register(...)
- register ( string ) -> None
register ( ) -> string
Register the underlying DataSource with the
DataSourceController. The first form registers it with the
given name, while the second from returns a unique name
generated by the controller.
- replaceColumn(...)
- replaceColumn ( value, list ) -> None
replaceColumn ( value, array ) -> None
Replace column by its label or index. The second form is
only available if HippoDraw was configure with numerical
arrays.
- setName(...)
- setName ( string ) -> None
Sets the name of the DataSource. The name should be unique
with one application and may appear in the Inspector panel.
- setTitle(...)
- setTitle ( string ) -> None
Sets the title of the DataSource. The title is what appears,
by default, at the top of a Display.
Static methods defined here:
- getCurrent(...)
- getCurrent () -> DataArray
Returns a DataArray that wraps the current DataSource.
Data descriptors defined here:
- columns
- rows
Data and other attributes defined here:
- __instance_size__ = 20
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class DataRep(Boost.Python.instance) |
|
A base class for representing data in various ways. For example, a
a histogram is a way to represent a column of data. |
|
- Method resolution order:
- DataRep
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- DataRep ( string ) -> DataRep
DataRep ( string, DataSource, sequence ) -> DataRep
DataRep ( DataRep ) -> DataRep
Constructors for DataRep objects. The first form creates a
static version. The second form creates a dynamic version
bound to a DataSource with bindings taken from the strings in
the sequence. The final version makes a copy of existing
DataRep.
For the names of the types of DataRep classes available
see names().
- addCut(...)
- addCut ( ) -> None
Adds a cut to limit the region given to a fitter.
- applyCut(...)
- applyCut ( Cut ) -> None
Applies a Cut to limit the rows of the DataSource used by
the Display.
- applyCuts(...)
- applyCuts ( sequence ) -> None
Applies a sequence of Cut object to limit the rows of
the DataSource used by the Display.
- colorNames(...)
- colorNames () -> tuple
Returns a list of available color names.
- createNTuple(...)
- createNTuple () -> NTuple
Creates and returns an NTuple representation of the object.
- createNTupleUnderRegion(...)
- createNTupleUnderRegion () -> NTuple
Creates and returns a NTuple contain only rows that pass the
region cuts.
- getBinWidth(...)
- getBinWidth ( string ) -> value
Returns the bin width on specified axis. Only meaningful if
object is histogram type.
- getColumnWithCuts(...)
- getColumnWithCuts ( column ) -> tuple
Creates and returns the named column, with cuts applied.
- getMean(...)
- getMean ( string ) -> value
Returns the mean of the data along specified axis
- getNTupleWithCuts(...)
- getNTupleWithCuts () -> NTuple
Creates and returns to NTuple being used, with cuts applied.
- getRMS(...)
- getRMS ( string ) -> value
Returns root mean squared of data along specified axis
- name(...)
- name ( ) -> string
Returns the type of DataRep.
- normalizeTo(...)
- normalizeTo ( DataRep ) -> None
Sets the object to normalize itself to a target one
- numberOfEntries(...)
- numberOfEntries ( ) -> value
Returns the number of entries.
- set(...)
- set ( ColorValue ) -> None
set ( Line ) -> None
set ( Symbol ) -> None
Sets the color, line style or Symbol of the RepBase object.
Use ColorValue.values, Line.values, or Symbol.values to see
available values.
- setAxisBinding(...)
- setAxisBinding ( string, string ) -> None
Sets an axis binding. The first argument is the axis and the
second is a label of a column in the DataSource.
- setAxisBindings(...)
- setAxisBindings ( string, sequence ) -> None
Sets all the axes bindings. The first argument is the axis and
the sequence contains labels of columns in the DataSource.
- setBinWidth(...)
- setBinWidth ( string, value ) -> None
Sets the width of the bins, if data representation is binned.
- setColor(...)
- setColor ( string ) -> None
Sets the color of the point representation.
See DataRep.colorNames() for list of available colors.
- setCutRange(...)
- setCutRange ( low, high ) -> None
Sets the low and high end of the region highlight
- setErrorDisplay(...)
- setErrorDisplay ( string, boolean ) -> None
Turns on or off display of error bars, if available, on
specified axis.
- setLineStyle(...)
- setLineStyle ( string ) -> None
Sets the line style.
This method is deprecated, use DataRep.set(Line) instead.
- setPointRep(...)
- setPointRep ( RepBase ) -> None
Sets the point representation.
- setSize(...)
- setSize ( value ) -> None
Sets the size of the point representation.
- setSymbol(...)
- setSymbol ( string, value ) -> None
Sets the point symbol and size. This method is deprecated, use
DataRep.set(Symbol) and DataRep.setSize() instead.
- setWeight(...)
- setWeight ( string ) -> None
Sets the weight option if DataRep is a type of histogram.
The string is a label of a column in the DataSource.
Static methods defined here:
- names(...)
- names () -> tuple
Returns a tuple containing the names of the types of DataRep
that are available.
Data and other attributes defined here:
- __instance_size__ = 24
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class DataSource(Boost.Python.instance) |
|
This class is an abstract base class defining the data table,
called an ntuple. That is a table with some number of columns and a
perhaps large number of rows. It implements some of the
but the actual data storage is done in a derived class. |
|
- Method resolution order:
- DataSource
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- clear(...)
- clear () -> None
Clears the data elements of the DataSource. That is, remove
all the rows while keeping the column labels.
- getColumn(...)
- getColumn ( label ) -> list
getColumn ( index ) -> list
Get a column by its label or index. Returns copy of the
contents.
- getLabels(...)
- getLabels () -> list
Returns list of column labels.
- getTitle(...)
- getTitle () -> string
Returns the title of the ntuple.
- replaceColumn(...)
- replaceColumn ( label, list ) -> None
Replaces the column of data by abel.
- setName(...)
- setName ( string ) -> None
Sets the name of the ntuple. The name should be a unique
string withing a running application. It may appear in the
Inspector.
- setTitle(...)
- setTitle ( string ) -> None
Sets the title of the ntuple. The title by default appears at
the top of a Display.
Data descriptors defined here:
- columns
- rows
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class Display(Boost.Python.instance) |
|
A wrapper for the HippoDraw PlotterBase C++ class.
See HippoDraw's QtDisplay documentation for more details. |
|
- Method resolution order:
- Display
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- Display ( string ) -> Display
Display ( string, DataSource, tuple ) -> Display
Display ( string, DataArray, tuple ) - > Display
Display ( string, tuple, tuple ) -> Display
Display ( string, list, tuple ) -> Display
Display ( string, RootNTuple, tuple ) -> Display
Display ( string, RootNTuple, tuple, tuple ) -> Display
This method is used to create a Display object.
The first method is used for creating static version of
Histogram, etc., where the string is the type of DataRep.
The remaining methods are for dynamic versions.
The string argument is the type. The second argument
is the DataSource and the third argument is tuple of
string for the binding to the DataSource.
For the last method, the fourth argument is a tuple
of integers to access a RootNTuple array variable.
For the names of the types of DataRep classes available
call DataRep.names().
- addDataRep(...)
- addDataRep ( DataRep ) -> Display
addDataRep ( Function ) -> Display
addDataRep ( string, DataSource, tuple ) -> Display
Adds a DataRep to the display sharing the same Y axis range
The first two methods adds existing DataRep or Function to the
Display. The third method creates and adds DataRep to the
Display. Arguments are same as Display constructor.
- addDataRepStacked(...)
- addDataRepStacked ( string, DataSource, tuple ) -> Display
Creates and adds a DataRep with independent Y axis ranges.
The arguments are the same as Display constructor.
- addFunction(...)
- addFunction ( FunctionBase ) -> None
Adds a FunctionBase object to the display by appropriately
wrapping it with a Function.
- addObserver(...)
- addObserver ( Observer ) -> None
Adds an Observer to the Display object.
- addValues(...)
- addValue ( tuple ) -> None
For static histograms, adds a value to the accumulation.
For 1D histogram, the tuple should contain one or two values,
the second used as a weight. For 2D histogram, the tuple should
contain two or three elements, the third being the weight.
non static Displays do nothing.
- applyCut(...)
- applyCut ( Cut ) -> None
Apply a Cut to the Display
- applyCuts(...)
- applyCuts ( sequence ) -> None
Apply each Cut in the sequence to the Display
- createDataArray(...)
- createDataArray ( ) -> DataArray
Returns a DataArray representation of the Display's contents
(This method available if configured with numarray)
- createNTuple(...)
- createNTuple ( ) -> NTuple
Returns a NTuple representation of the Display's contents.
- currentView(...)
- currentView ( ) -> int
Index of the current view.
- deleteView(...)
- deleteView ( int ) -> None
Delete a view by index.
- getBinWidth(...)
- getBinWidth ( string ) -> value
Returns the bin width on axis specified as a string,
e.g., 'x'.
- getDataRep(...)
- getDataRep ( ) -> DataRep
Returns a reference to the active DataRep or if all DataRep objects are
active, returns a reference to the first one.
- getDataReps(...)
- getDataReps ( ) -> list
Returns a list of DataRep objects contained by the Display..
- getLabel(...)
- getLabel ( string ) -> string
Returns the label of the axis specified as a string,
e.g., 'x'.
- getLog(...)
- getLog ( string ) -> value
Returns True if axis specified as a string, e.g. 'x', is being
displayed on a logarithmic scale.
- getRange(...)
- getRange ( string ) -> tuple
Returns the tuple representing the range for the axis specified
as a string, e.g., 'x'.
- getTitle(...)
- getTitle () -> string
Returns the current title. The title will be the title of
the DataSource unless it has been explicitly changed.
- nextView(...)
- nextView ( bool ) -> int
Cycle to the next view in the view buffer. Set the argument to True to cycle for wards, False to cycle back wards.
Returns the index of the new view.
- numViews(...)
- numViews ( ) -> int
Return the number of stored views.
- numberOfEntries(...)
- numberOfEntries ( ) -> value
Returns the number of entries in the Display.
- plotterId(...)
- plotterId () -> value
Returns a unique identifier for the Display.
- reset(...)
- reset () -> None
Resets the contents of all bins. Only applicable to static
histograms.
- resize(...)
- resize () -> None
Resizes the Display to its saved values.
- saveView(...)
- saveView ( ) -> int
Saves the current set of x and y ranges and returns the index of the saved view.
- setAspectRatio(...)
- setAspectRatio ( value ) -> None
Sets the required aspect ratio of the Display to value, the
ratio of the width to the height.
- setAutoRanging(...)
- setAutoRanging ( string, Boolean ) -> None
Sets auto-ranging on axis specified as a string, e.g. 'x',non or off.
- setAutoTicks(...)
- setAutoTicks ( Boolean ) -> None
Set the ticks generation to be automatic (the default) or
manually.
- setBinWidth(...)
- Set the bin width, explicitly saving the value or not.
setBinWidth ( string, value ) -> None
Set the bin width to value on axis specified as a string,
e.g., 'x'.
- setColorMap(...)
- setColorMap ( string ) -> None
Set the value-to-color map to one named by the argument.
- setContourLevels(...)
- setContourLevels ( sequence ) -> None
Sets the contour levels if the Display is using contour point
representation from the values in the sequence.
- setLabel(...)
- setLabel ( string, string ) -> None
Sets the label for the axis specified by first argument to value
of the second argument.
- setLog(...)
- setLog ( string, Boolean ) -> None
Sets the axis specified by the first argument on log scale.
- setNumberOfBins(...)
- setNumberOfBins ( string, value ) -> None
Sets the number of bins on named axis, e.g. 'x' to the given
value.
- setOffset(...)
- setOffset ( string, value ) -> None
Sets the offset of the bins relative to their current width on
specified axis.
- setPointRep(...)
- setPointRep ( RepBase ) -> None
Sets the point representation to be used.
- setRange(...)
- setRange ( string, value, value ) -> None
setRange ( string, value, value, Boolean ) -> None
Set the upper and lower bounds for the specified axis. For the
second form, also save them if the Boolean argument is true.
- setTicks(...)
- setTicks ( string, sequence, sequence ) -> None
Sets the tick locations and labels. The first argument is the
axis, the second argument is a sequence containing the
locations, and the third argument is a sequence of tick labels.
- setTitle(...)
- setTitle ( string ) -> None
Sets the title of the display.
- setTransform(...)
- setTransform ( string ) -> None
Sets the transform object.
- setView(...)
- setView ( int ) -> None
Set the view by its index.
- unlock(...)
- unlock () -> None
Unlock the application thread.
- update(...)
- update () -> None
Updates the display.
Data and other attributes defined here:
- __instance_size__ = 48
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class FCNBase(Boost.Python.instance) |
|
The base class for the objective function used in fitting. |
|
- Method resolution order:
- FCNBase
- Boost.Python.instance
- __builtin__.object
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class FactoryPointRep(Boost.Python.instance) |
|
A private base class for PointRepFactory. |
|
- Method resolution order:
- FactoryPointRep
- Boost.Python.instance
- __builtin__.object
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class FitsController(Boost.Python.instance) |
|
A class for creation of DataSource objects from a FITS file. |
|
- Method resolution order:
- FitsController
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- createDataArray(...)
- createDataArray ( string, string ) -> DataArray
Creates DataArray from a file with key name
- createNTuple(...)
- createNTuple ( string, string ) -> FitsNTuple
Creates FitsNTuple from the named file with key name. Python
take possession of it.
- getNTupleNames(...)
- getNTupleNames ( string ) -> sequence
Returns the names of the HDU data source objects in the file.
- writeToFile(...)
- writeToFile ( DataArray, filename ) -> None.
writeToFile ( DataSource, filename ) -> None,
writeToFile ( DataArray, filename, tuple, tuple ) -> None.
writeToFile ( DataSource, filename, tuple, tuple ) -> None,
Writes a DataSource or DataArray to FITS file as binary table.
In the latter two forms, the first tuple is list of Cuts and
and the second is tuple of column labels
Static methods defined here:
- instance(...)
- instance () -> FitsController
Returns the single instance of the controller.
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class FitsNTuple(DataSource) |
|
a derived class of DataSource that references a table or image in a
FITS file. A FitNTuple object must be created by the FitsController.Changes made to this object will not be reflected in the FITS file. |
|
- Method resolution order:
- FitsNTuple
- DataSource
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- addColumn(...)
- addColumn ( string, list or tuple ) -> value
Adds a column to the data source. The string argument is used
for the label of the new column. The length of the new column
must the same as existing columns. The value returns is the
index to the column.
- replaceColumn(...)
- replaceColumn ( index, list ) -> None
replaceColumn ( label, list ) -> None
Replaces the column of data by index or label. Does not
modify the FITS file.
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Methods inherited from DataSource:
- clear(...)
- clear () -> None
Clears the data elements of the DataSource. That is, remove
all the rows while keeping the column labels.
- getColumn(...)
- getColumn ( label ) -> list
getColumn ( index ) -> list
Get a column by its label or index. Returns copy of the
contents.
- getLabels(...)
- getLabels () -> list
Returns list of column labels.
- getTitle(...)
- getTitle () -> string
Returns the title of the ntuple.
- setName(...)
- setName ( string ) -> None
Sets the name of the ntuple. The name should be a unique
string withing a running application. It may appear in the
Inspector.
- setTitle(...)
- setTitle ( string ) -> None
Sets the title of the ntuple. The title by default appears at
the top of a Display.
Data descriptors inherited from DataSource:
- columns
- rows
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class Fitter(Boost.Python.instance) |
|
Provides an interface to objective function minimizers. |
|
- Method resolution order:
- Fitter
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- getFCN(...)
- getFCN () -> FCNBase
Returns the objective function.
- minimize(...)
- minimize () -> Boolean
Attempts to do a minimization, returns True if successful.
- name(...)
- name () -> string
Returns the minimizer name.
- setFixedFlags(...)
- setFixedFlags ( sequence ) -> None
Sets which parameters that should be fixed during a fit. A
`1' in the sequence indicates corresponding parameters is fixed.
- setLimits(...)
- setLimits ( name, low, high ) -> None
setLimits ( index, low, high ) -> None
Sets the limits on a model function parameter. Only minimizers
based on Minuit support this feature, others throw an exception.
- setStepSize(...)
- setStepSize ( name, value ) -> None
setStepSize ( index, value ) -> None
Sets the step size for the model function parameter. Only
minimizers based on Minuit support this function, others
throw an exception.
Data descriptors defined here:
- degreesOfFreedom
- objectiveValue
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class FitterFactory(Boost.Python.instance) |
|
The factory for returning fitters preloaded with objective functions. |
|
- Method resolution order:
- FitterFactory
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- create(...)
- create ( string ) -> Fitter
Returns the newly created fitter object.
- names(...)
- names () -> sequence
Returns the names of the available fitters.
- setDefault(...)
- setDefault ( string ) -> None
Sets the default fitter object. Throws an exception if given
invalid name.
Static methods defined here:
- instance(...)
- instance () -> FitterFactory
Returns the single instance of the FitterFactory
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class Function(Boost.Python.instance) |
|
This class wraps a FunctionBase object with a DataRep. This allows
it to be drawn in a Display. It also provides interface to member
functions of FunctionBase, although the user could obtain a
reference to the FunctionBase itself to do so. |
|
- Method resolution order:
- Function
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- Function ( string, DataRep ) -> Function
Function ( FunctionBase, DataRep ) -> Function
The first form creates a function using the string to find the
FunctionBase in the FunctionFactory. The second form creates a
using an existing FunctionBase object. Both forms use the DataRep
as target for fitting and drawing
- addTo(...)
- addTo ( Display ) -> None
Adds the Function to a Display. taking the Display's selected
DataRep as its target.
- chiSquared(...)
- chiSquare ( None ) -> value
Returns the Chi-Squared.
- createResidualsDisplay(...)
- createResidualsDisplay ( None ) -> Display
Returns residuals Display object. The residuals display is an
XY plot showing the difference between the function values and
the target DataRep values.
- degreesOfFreedom(...)
- degressOfFreedom ( None ) -> value
Returns the number of degrees of freedom a fitter would have.
- errors(...)
- errors ( None ) - > list
Returns the errors on the parameters. The errors are calculated
by a fitter, thus the values returned are only valid after
having done a fit.
- fit(...)
- fit ( None ) -> boolean
Attempts to fit the the function to the target DataRep.
Uses the currently selected fitter, unless one was explicitly
set. Note the fit is always done to linear sum if more than one
function is on the data.
- getFitterName(...)
- getFitterName ( None ) -> string
Returns the current fitter name.
- objectiveValue(...)
- objectiveValue ( None ) -> value
Returns the objective Value that the fitter minimizes.
Typically it is the Chi-Squared.
- parameters(...)
- parameters ( None ) -> list
Returns a list of the function's parameter values.
- parmNames(...)
- parmNames ( None ) -> list
Returns a list of parameter names.
- principleErrors(...)
- principleErrors ( None ) -> list
Returns the errors on the parameters.
- setFitRange(...)
- setFitRange ( low, high ) -> None
Sets the range of the coordinate axis that is used for fitting.
- setFitRangeEnabled(...)
- setFitRange ( boolean ) -> None
Enabled use of the fit range
- setFitter(...)
- setFitter ( string ) -> None
Sets the fitter by name from fitter factory.
- setFixedFlags(...)
- setFixedFlags ( list ) -> None
Set which parameters should be held fixed during fitting.
- setParameters(...)
- setParameters ( list ) -> None
Sets the function's parameter values.
- valueAt(...)
- valueAt ( x ) -> value
Returns the function's value at given coordinate.
Data and other attributes defined here:
- __instance_size__ = 16
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class FunctionBase(Boost.Python.instance) |
|
The base class for raw functions. FunctionBase objects need to
wrapped with Function objects to be displayed. FunctionBase
can be derived from and cloned so they can be added to the
FunctionFactory. |
|
- Method resolution order:
- FunctionBase
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- FunctionBase () -> FunctionBase
FunctionBase ( FunctionBase ) -> FunctionBase
Constructors of the FunctionBase object.
- getParameters(...)
- getParameters () -> sequence
Returns the current function parameter values.
- initialize(...)
- initialize () -> None
Initializes the function parameter values and the names.
The number of parameters is taken from the number of names.
- name(...)
- name () -> string
Returns the name of the function.
- parmNames(...)
- parmNames () -> sequence
Returns the names of the parameters
- setName(...)
- setName ( string ) -> None
Sets the name of the function.
- setParameters(...)
- setParameters ( sequence ) -> None
Sets the values of the parameters.
- setParmNames(...)
- setParmNames ( sequence ) -> None
Sets the parameter names and re-sizes the parameters
Data and other attributes defined here:
- __instance_size__ = 12
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class FunctionFactory(Boost.Python.instance) |
|
The factory for creating derived classes of FunctionBase. |
|
- Method resolution order:
- FunctionFactory
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- add(...)
- add ( FunctionBase ) -> None
Adds the function to the factory.
- create(...)
- create ( string ) -> FunctionBase
Returns the newly created object derived from FunctionBase.
- names(...)
- names () -> sequence
Returns the names of the available FunctinBase derived classes.
Static methods defined here:
- instance(...)
- instance () -> FunctionFactory
Returns the single instance of the FunctionFactory.
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class HDApp(Boost.Python.instance) |
|
The HippoDraw application class. |
|
- Method resolution order:
- HDApp
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- HDApp () -> HDApp
HDApp ( value ) -> HDApp
Using the constructor with no arguments creates
a HippoDraw application that runs in a separate
thread.
Using the constructor with one argument creates
a HippoDraw application in same thread. Use
app.exec_loop() to start it.
HDapp ( string ) -> HDapp
- canvas(...)
- canvas () -> Canvas
Returns the current canvas window.
- exec_loop(...)
- exec_loop () -> value
Starts the application object. Returns the value returned
by the application object upon exiting.
- hasTerminated(...)
- hasTerminated () -> Boolean
Returns True if the application has terminated.
- lock(...)
- lock () -> None
Lock the Qt library Mutex. Will not return until no
other thread has the lock.
- openDocument(...)
- openDocument ( string ) -> None
Opens new canvas window from saved document file.
- quit(...)
- quit () -> None
Closes all Canvas windows and Terminates the application.
- quitOnLastWindowClose(...)
- quitOnLastWindowClose ( Boolean ) -> None
If argument is True, allows application to quit when last
Canvas is closed.
- unlock(...)
- unlock () -> None
Unlocks the application thread.
Static methods defined here:
- instance(...)
- instance () -> HDApp
Returns a singleton instance of the HippoDraw
application object
Data and other attributes defined here:
- __instance_size__ = 12
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class ListTuple(DataSource) |
|
A derived class from DataSource containing columns as references to
Python list objects. This allows the data to be used without making
a copy of it. However, access to the data is slower than for most
of the other classes derived from DataSource |
|
- Method resolution order:
- ListTuple
- DataSource
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- ListTuple ( None ) -> ListTuple
Creates an empty ListTuple
- addColumn(...)
- addColumn ( string, list ) -> value
Adds the array as a new column with label from the string.
Returns the index of the new column.
- getLabel(...)
- getLabel ( index ) -> string
Returns label of column.
- notifyObservers(...)
- notifyObservers ( None ) -> None
Sends update message to all observers. Use this member if the
contents of the reference Python list has changed and Display
objects bound to it require updating.
- replaceColumn(...)
- replaceColumn ( index, list ) -> None
Replaces existing column with list
replaceColumn ( string, list ) -> None
Replaces existing column with new array
- setLabels(...)
- setLabels ( list or tuple ) -> None
Sets the labels of the columns from list of string objects.
For an empty ListTuple object, implicitly sets the number of
columns.
Data and other attributes defined here:
- __instance_size__ = 100
Methods inherited from DataSource:
- clear(...)
- clear () -> None
Clears the data elements of the DataSource. That is, remove
all the rows while keeping the column labels.
- getColumn(...)
- getColumn ( label ) -> list
getColumn ( index ) -> list
Get a column by its label or index. Returns copy of the
contents.
- getLabels(...)
- getLabels () -> list
Returns list of column labels.
- getTitle(...)
- getTitle () -> string
Returns the title of the ntuple.
- setName(...)
- setName ( string ) -> None
Sets the name of the ntuple. The name should be a unique
string withing a running application. It may appear in the
Inspector.
- setTitle(...)
- setTitle ( string ) -> None
Sets the title of the ntuple. The title by default appears at
the top of a Display.
Data descriptors inherited from DataSource:
- columns
- rows
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class NTuple(NTupleInternal) |
|
A derived class of DataSource that stores its tabular data vectors of
double precision numbers in C++. An NTuple object can be created in
a number of ways including reading from a file using the
NTupleController |
|
- Method resolution order:
- NTuple
- NTupleInternal
- DataSource
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- NTuple ( None ) -> NTuple
NTuple ( value ) -> NTuple
NTuple ( sequence ) -> NTuple
NTuple ( NTuple ) -> NTuple
The form with no arguments creates an empty NTuple with no rows
or columns. The form with one value argument creates an empty
NTuple with `value' number of columns. The form with a sequence
argument creates an empty NTuple with the number of columns equal
to size of the sequence. The sequence should contain string which
are used as the column labels. The last form form creates an
NTuple
whose contents is a copy of an existing one.
- addColumn(...)
- addColumn ( label, sequence ) -> index
Adds a new column with label.
- addRow(...)
- addRow ( sequence ) -> None
Append a row at the end.
- append(...)
- append ( DataSource ) -> None
Appends the contents of the DataSource to the NTuple.
- clear(...)
- clear () -> None
Clears the data elements of the DataSource. That is, remove
all the rows while keeping the column labels.
- replaceColumn(...)
- replaceColumn ( index, sequence ) -> None
Replaces the indexed column.
replaceColumn ( label, sequence ) -> None
Replaces the labeled column.
- setTitle(...)
- setTitle ( string ) -> None
Sets the title of the ntuple. The title by default appears at
the top of a Display.
Data and other attributes defined here:
- __instance_size__ = 112
Methods inherited from NTupleInternal:
- getLabel(...)
- getLabel ( index ) -> string
Returns the label at column index.
- getRow(...)
- getRow ( index ) -> list
Returns the index row as list floats.
- setIntervalCount(...)
- setIntervalCount ( count ) -> None
Sets the interval count between updates to the observers.
- setIntervalEnabled(...)
- setIntervalEnable ( Boolean ) -> None
Sets the interval counting on or off
- setLabels(...)
- setLabels ( sequence ) -> None
Sets the labels of the columns from the list of strings. If the
NTuple is empty, then also sets the number of columns to be the
size of the list. If the number of columns has already been
set, the the size of the list should be the same, otherwise
a RuntimeError exception is thrown.
Methods inherited from DataSource:
- getColumn(...)
- getColumn ( label ) -> list
getColumn ( index ) -> list
Get a column by its label or index. Returns copy of the
contents.
- getLabels(...)
- getLabels () -> list
Returns list of column labels.
- getTitle(...)
- getTitle () -> string
Returns the title of the ntuple.
- setName(...)
- setName ( string ) -> None
Sets the name of the ntuple. The name should be a unique
string withing a running application. It may appear in the
Inspector.
Data descriptors inherited from DataSource:
- columns
- rows
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class NTupleController(Boost.Python.instance) |
|
A singleton object to manage NTuple objects. |
|
- Method resolution order:
- NTupleController
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- changeName(...)
- changeName ( DataSource, string ) -> None
Change the name of an NTuple.
This method is deprecated, there's not need to do this
- createCircularBuffer(...)
- createCircularBuffer ( value ) -> CircularBuffer
Creates and registers a CircularBuffer object with set number of
columns.
- createDataArray(...)
- createDataArray ( filename ) -> DataArray
Creates a DataArray from file.
- createNTuple(...)
- Creates an empty NTuple
createNTuple () -> NTuple
createNTuple ( string ) -> NTuple
Creates and registers an NTuple. The first method creates an
empty NTuple object. The second method creates one from a
file. Both methods return ownership of the created object to
Python.
- findNTuple(...)
- findNTuple ( string ) -> DataSource
Find an registered NTuple by its name and returns a reference to
it. If the DataSource can not be found, an exception is thrown.
Warning: if more than one DataSource has the same name,
the first one found is returned.
- registerNTuple(...)
- Register an NTuple to make it visible to the application
registerNTuple ( DataSource ) -> None
registerNTuple ( string, DataSource ) -> None
Register an NTuple to make it visible to the application. The
first form takes the name from the DataSource object, if it has
one, otherwise generates a unique name. The second form takes
string argument for the name.
- writeToFile(...)
- writeToFile ( DataSource, string ) -> value
Writes the NTuple to a file as ASCII text. Returns 0 if
successful.
Static methods defined here:
- instance(...)
- instance () -> NTupleController
Returns the single instance of the controller
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class NTupleFCN(StatedFCN) |
|
A objective function class used in fitting that uses a DataSource to
access the data |
|
- Method resolution order:
- NTupleFCN
- StatedFCN
- FCNBase
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- setDataSource(...)
- setDataSource ( DataSource ) -> None
setDataSource ( DataSource, value, sequence ) -> None
The first form sets the data source with default indexes. The
second form takes in addition the dimensionality of the
coordinate and a column indexes from the sequence.
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Methods inherited from StatedFCN:
- degreesOfFreedom(...)
- degreesOfFreedom () -> value
Returns the degrees of freedom as integer.
- objectiveValue(...)
- objectiveValue () -> value
Returns the objective value. For example, the objective
might be the Chi-Squared when derived class returns it as
its objective value.
- setFunction(...)
- setFunction ( FunctionBase ) -> None
Sets the model function.
- setUseErrors(...)
- setUseErrors ( Boolean ) -> None
Sets the FCN to use errors on the data source if they exist.
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class NTupleInternal(DataSource) |
|
A derived class of DataSource that stores its tabular data vectors of
double precision numbers in C++. An NTuple object can be created in
a number of ways including reading from a file using the
NTupleController |
|
- Method resolution order:
- NTupleInternal
- DataSource
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- NTuple ( None ) -> NTuple
NTuple ( value ) -> NTuple
NTuple ( sequence ) -> NTuple
NTuple ( NTuple ) -> NTuple
The form with no arguments creates an empty NTuple with no rows
or columns. The form with one value argument creates an empty
NTuple with `value' number of columns. The form with a sequence
argument creates an empty NTuple with the number of columns equal
to size of the sequence. The sequence should contain string which
are used as the column labels. The last form form creates an
NTuple
whose contents is a copy of an existing one.
- getLabel(...)
- getLabel ( index ) -> string
Returns the label at column index.
- getRow(...)
- getRow ( index ) -> list
Returns the index row as list floats.
- setIntervalCount(...)
- setIntervalCount ( count ) -> None
Sets the interval count between updates to the observers.
- setIntervalEnabled(...)
- setIntervalEnable ( Boolean ) -> None
Sets the interval counting on or off
- setLabels(...)
- setLabels ( sequence ) -> None
Sets the labels of the columns from the list of strings. If the
NTuple is empty, then also sets the number of columns to be the
size of the list. If the number of columns has already been
set, the the size of the list should be the same, otherwise
a RuntimeError exception is thrown.
Data and other attributes defined here:
- __instance_size__ = 112
Methods inherited from DataSource:
- clear(...)
- clear () -> None
Clears the data elements of the DataSource. That is, remove
all the rows while keeping the column labels.
- getColumn(...)
- getColumn ( label ) -> list
getColumn ( index ) -> list
Get a column by its label or index. Returns copy of the
contents.
- getLabels(...)
- getLabels () -> list
Returns list of column labels.
- getTitle(...)
- getTitle () -> string
Returns the title of the ntuple.
- replaceColumn(...)
- replaceColumn ( label, list ) -> None
Replaces the column of data by abel.
- setName(...)
- setName ( string ) -> None
Sets the name of the ntuple. The name should be a unique
string withing a running application. It may appear in the
Inspector.
- setTitle(...)
- setTitle ( string ) -> None
Sets the title of the ntuple. The title by default appears at
the top of a Display.
Data descriptors inherited from DataSource:
- columns
- rows
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class NumArrayTuple(DataSource) |
|
Interface to numarray Python extension module. |
|
- Method resolution order:
- NumArrayTuple
- DataSource
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- Creates an empty NumArrayTuple
- addColumn(...)
- Adds the array as a new column with label
- getLabel(...)
- notifyObservers(...)
- Sends update message to all observers.
- replaceColumn(...)
- Replaces existing column with new array
Args:
index
numarray
Replaces existing column with new array
Args:
label
numarray
- setLabels(...)
- Sets the labels of the columns.
Data and other attributes defined here:
- __instance_size__ = 100
Methods inherited from DataSource:
- clear(...)
- clear () -> None
Clears the data elements of the DataSource. That is, remove
all the rows while keeping the column labels.
- getColumn(...)
- getColumn ( label ) -> list
getColumn ( index ) -> list
Get a column by its label or index. Returns copy of the
contents.
- getLabels(...)
- getLabels () -> list
Returns list of column labels.
- getTitle(...)
- getTitle () -> string
Returns the title of the ntuple.
- setName(...)
- setName ( string ) -> None
Sets the name of the ntuple. The name should be a unique
string withing a running application. It may appear in the
Inspector.
- setTitle(...)
- setTitle ( string ) -> None
Sets the title of the ntuple. The title by default appears at
the top of a Display.
Data descriptors inherited from DataSource:
- columns
- rows
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class Observable(Boost.Python.instance) |
|
The base class for classes that can be target of an Observer
object. |
|
- Method resolution order:
- Observable
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
Data and other attributes defined here:
- __instance_size__ = 16
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class Observer(Boost.Python.instance) |
|
The base class for classes that can be targets of Observable
update messages. |
|
- Method resolution order:
- Observer
- Boost.Python.instance
- __builtin__.object
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class PointRepFactory(FactoryPointRep) |
|
A factory for creating object whose class derive from PointRep. |
|
- Method resolution order:
- PointRepFactory
- FactoryPointRep
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- create(...)
- create ( string ) -> PointRep
Returns a PointRep object of type named in string.
- names(...)
- names () -> sequence
Returns the names of available PointRep classes.
Static methods defined here:
- instance(...)
- instance () -> PointRepFactory
Returns the instance of the PointRepFactory.
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class RepBase(Boost.Python.instance) |
|
The base class for point and text representations.
See PointRepFactory for creating objects of this type. |
|
- Method resolution order:
- RepBase
- Boost.Python.instance
- __builtin__.object
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class RootController(Boost.Python.instance) |
|
The RootController class provides interface to ROOT ntuple files. |
|
- Method resolution order:
- RootController
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- createDataArray(...)
- createDataArray ( filename, treename ) -> DataArray
Creates a DataArray object containing a RootNTuple from the
named ROOT file and named tree. Returns a reference to it.
- createNTuple(...)
- createNTuple ( filename, treename ) -> RootNTuple
Creates a RootNTuple from the named file and named tree. Python
take possession of the object.
Consider createDataArray() instead, if the hippo module was
configured with numerical array support.
- getNTupleNames(...)
- getNTupleNames ( filename ) -> list
Returns a list of names of the possible DataSource objects in
the ROOT file. That is, the top level TTree names.
Static methods defined here:
- instance(...)
- instance () -> RootController
Returns the singleton instance of the controller.
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class RootNTuple(DataSource) |
|
The RootNTuple class provides access to data in a ROOT file.
A ROOT TTree is taken as an ntuple and a ROOT TBranch is taken as a
column, the TBranch name as the column label.
If the hippo module was configured with numeric array support,
consider using DataArray to wrap an object of this class. |
|
- Method resolution order:
- RootNTuple
- DataSource
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- addColumn(...)
- addColumn ( label, list ) -> value
Adds a column to the ntuple. Adds a column to the ntuple by
copying the contents of the list. The new column will take its
label from the first argument. Returns the index of the newly
created column.
Note: The column is not added to the ROOT file, just logically
to it for the current session.
- getColumn(...)
- getColumn ( index ) -> list
getColumn ( label ) -> list
getColumn ( label, indices ) -> list
Returns a copy of the column as a list. In the first form the
the column is specified by its index. In the second form it
is specified by its label which could be a simple variable or
an array variable. If an array variable, the indices should be
part of the label. The third form, the column is specified by
an array variables name and list of indices.
- getLabels(...)
- getLabels () -> list
Returns the column labels. Note: if a column is an array the
shape does not appear as part of the label.
- getRow(...)
- getRow ( index ) -> tuple
Returns a row from the ROOT file.
- isMultiDimensional(...)
- isMultiDimensional ( label ) -> Boolean
Returns True if the column specified by label is an array.
- replaceColumn(...)
- replaceColumn ( index, list ) -> None
replaceColumn ( label, list ) -> None
Replaces the column of data by index or label. Does not
modify the ROOT file.
- rowDataDimSize(...)
- rowDataDimSize ( label )
Returns a tuple of the dimensions (shape) of the array elements
for the column specified by label.
- valueAt(...)
- valueAt ( index, label ) -> array
Returns the numerical array for the array variable in column
specified by label, for the row index. Note: this method is
only available if the hippo module was configured for numerical
array support.
Data descriptors defined here:
- columns
- rows
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Methods inherited from DataSource:
- clear(...)
- clear () -> None
Clears the data elements of the DataSource. That is, remove
all the rows while keeping the column labels.
- getTitle(...)
- getTitle () -> string
Returns the title of the ntuple.
- setName(...)
- setName ( string ) -> None
Sets the name of the ntuple. The name should be a unique
string withing a running application. It may appear in the
Inspector.
- setTitle(...)
- setTitle ( string ) -> None
Sets the title of the ntuple. The title by default appears at
the top of a Display.
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class StatedFCN(FCNBase) |
|
This a base class for objective function used in fitting that
maintains the state of the function's parameters. |
|
- Method resolution order:
- StatedFCN
- FCNBase
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- degreesOfFreedom(...)
- degreesOfFreedom () -> value
Returns the degrees of freedom as integer.
- objectiveValue(...)
- objectiveValue () -> value
Returns the objective value. For example, the objective
might be the Chi-Squared when derived class returns it as
its objective value.
- setDataSource(...)
- setDataSource ( DataSource ) -> None
setDataSource ( DataSource, value, sequence ) -> None
The first form sets the data source with default indexes. The
second form takes in addition the dimensionality of the
coordinate and a column indexes from the sequence.
- setFunction(...)
- setFunction ( FunctionBase ) -> None
Sets the model function.
- setUseErrors(...)
- setUseErrors ( Boolean ) -> None
Sets the FCN to use errors on the data source if they exist.
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data descriptors inherited from Boost.Python.instance:
- __dict__
- __weakref__
Data and other attributes inherited from Boost.Python.instance:
- __new__ = <built-in method __new__ of Boost.Python.class object at 0x37e1a0>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
| |