hdfviewer.viewers package

Submodules

hdfviewer.viewers.MplDataViewer module

MatPlotLib based viewer for 1D, 2D and 3D NumPy data.

class hdfviewer.viewers.MplDataViewer.MplDataViewer(dataset, standAlone=True)

Bases: object

viewer
exception hdfviewer.viewers.MplDataViewer.MplDataViewerError

Bases: Exception

hdfviewer.viewers.MplDataViewer1D module

MatPlotLib based viewer for 1D NumPy data.

class hdfviewer.viewers.MplDataViewer1D._MplDataViewer1D(dataset, **kwargs)

Bases: object

_initLayout()

Initializes layout.

dataset
figure
update()

hdfviewer.viewers.MplDataViewer2D module

MatPlotLib based viewer for 2D NumPy data.

class hdfviewer.viewers.MplDataViewer2D._MplDataViewer2D(dataset, standAlone=True)

Bases: object

_initActions()

Init all the widgets actions.

_initLayout()

Initializes layout. The figure is made of an central image surrounded on top by the column-view of the dataset and on the right by a row-view of the dataset which depending on the plotting mode corresponds to:

  • slices along the row and column of a selected pixel using left-click mouse button when the cross-plot mode is set
  • integrations of the 2D image along the X and Y axis when the integration mode is set
_onChangeAxesLimits(event)

Update the cross plot according to the reduced row and/or column range

_onKeyPress(event)

Add keyboard interaction for navigating through the dataset

_onSelectPixel(event)

Update the cross plot according to the selected pixel of the 2D/3D image.

_updateCrossPlot()

Update the cross plots for 2D/3D dataset. Cross plots are 1D plots which correspond to the reduced view of 2D/3D datasets projected onto X and Y axis

dataset
figure
selectPixel(row, col)

Select a pixel on the image and update the cross plots

setXYIntegrationMode(xyIntegration)

Toggle the integration mode. If True, the top and right 1D plots will be resp. the sum/integral over y and x axis If False, the top and right 1D plots will be resp. the cross plots along corresonding to resp. y and x axis of the selected pixel

update()

hdfviewer.viewers.MplDataViewer3D module

MatPlotLib based viewer for 3D NumPy data.

class hdfviewer.viewers.MplDataViewer3D._MplDataViewer3D(dataset, standAlone=True)

Bases: object

_initActions()

Init all the widgets actions.

_initLayout()

Initializes layout. For 1D the figure will be made of a single plot while for 2D/3D plots the figure is made of an image (top) and two 1D plots which depending on the plotting mode corresponds to:

  • slices along the row and column of a selected pixel using right-click mouse button (aka pixel mode: “c” key pressed)
  • integrations of the 2D image along the X and Y axis depending on the plotting mode (aka integration mode: “i” key pressed)
_onChangeAxesLimits(event)

Update the cross plot according to the reduced row and/or column range

_onKeyPress(event)

Add keyboard interaction for navigating through the dataset

_onLeaveAxes(event)
_onScrollFrame(event)

Scroll through the dataset using the mouse wheel

_onSelectPixel(event)

Update the cross plot according to the selected pixel of the 2D/3D image.

_updateCrossPlot()

Update the cross plots for 2D/3D dataset. Cross plots are 1D plots which correspond to the reduced view of 2D/3D datasets projected onto X and Y axis

dataset
figure
selectPixel(row, col)
setSelectedFrame(selectedFrame)

Change the frame in case 2D/3D data.

setXYIntegrationMode(xyIntegration)

Toggle the integration mode. If True, the top and right 1D plots will be resp. the sum/integral over y and x axis If False, the top and right 1D plots will be resp. the cross plots along corresonding to resp. y and x axis of the selected pixel

update()

Module contents