Package qubx :: Module notebook

Module notebook

Base classes and registry for notebook figure export.

QUB Express is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

QUB Express is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License, named LICENSE.txt, in the QUB Express program directory. If not, see <http://www.gnu.org/licenses/>.

Classes

[hide private]

NbItem
The simplest type of notebook item; this class has the minimal properties and methods to implement the notebook protocol:

NbItems
A bundle of related notebook items; e.g.

NbText
A simple notebook item with static text.

NbDynText
A simple notebook item with text that's recomputed by the get_msg function whenever it's needed.

NbTable
A notebook item with tabular data.

NbStaticTable
A notebook item representing a specific array.

NbStaticArray
A notebook item representing a specific 1d or 2d numpy.ndarray.

NbChartSeries
Properties of one series in a chart item:

NbChart
Notebook item representing a 2D plot.

NbTrace
Notebook item representing sampled data from one or more signals.

NbTarget
Base class for objects which receive notebook items.

NbTargetRec
Info about one registered notebook target:

NbAutoRec
Info about one automatic notebook item:

NbController
The global instance of this type, qubx.notebook.Notebook, is created by qubx.notebook.Init(), and keeps registries of the various output methods (NbTargets) and automatically-triggered NbItems.

NbTarget_Stdout
Basic type of notebook output which prints everything to the stdout console.

Functions

[hide private]

NbSubTable(name='SubTable', fields=[])
Returns a function(qubx.table.Table), which returns an NbTable with only the specified columns. source code

c2h(c)

source code

rgb_to_hex(rgb)

source code

Init()
Sets up qubx.notebook.Notebook as the global NbController object.

source code

RegisterTargets()
Registers the target types defined in this module.

source code

Variables

[hide private]

DOTS = 0

LINES = 1

HISTOGRAM = 2

__package__ = 'qubx'