ALBULA  4.0.1
 All Classes Namespaces Functions Variables Pages
dectris.albula.DMainFrame Class Reference

class DMainFrame represents a graphical unit that contains DSubFrames Open a DMainFrame via openMainFrame(). More...

Inheritance diagram for dectris.albula.DMainFrame:
dectris.albula.DFrame

Public Member Functions

def __init__
 
def openSubFrame
 Open a DSubFrame within the DMainFrame. More...
 
def showToolBar
 Show ToolBar. More...
 
def hideToolBar
 Hide ToolBar. More...
 
def enableClose
 If called, clicking exit button closes DMainFrame. More...
 
def disableClose
 If called, clicking exit button does not close DMainFrame. More...
 
def enableKeyboardShortcuts
 Enable keyboard shortcuts. More...
 
def disableKeyboardShortcuts
 Disable keyboard shortcuts. More...
 
def subFrames
 Returns a list of open DSubFrames within that DMainFrame. More...
 
def synchronizeViewport
 Toggles viewport synchronization between DSubFrames. More...
 
def synchronizeContrast
 Toggles contrast synchronization between DSubFrames. More...
 
def synchronizeStatistics
 Toggles statistics synchronization between DSubFrames. More...
 
- Public Member Functions inherited from dectris.albula.DFrame
def __init__
 
def viewerClient
 
def objID
 
def close
 Closes the Frame. More...
 
def waitForClose
 Blocks until object is closed by user. More...
 
def sendCommand
 

Detailed Description

class DMainFrame represents a graphical unit that contains DSubFrames Open a DMainFrame via openMainFrame().

Constructor & Destructor Documentation

def dectris.albula.DMainFrame.__init__ (   self,
  viewerClient,
  objID 
)

Member Function Documentation

def dectris.albula.DMainFrame.disableClose (   self)

If called, clicking exit button does not close DMainFrame.

DFrame.close() is not affected. See DMainFrame.enableClose().

def dectris.albula.DMainFrame.disableKeyboardShortcuts (   self)

Disable keyboard shortcuts.

When keyboard shortcuts are enabled the user may set the contrast, go through the image series and resize the image via shortcuts

def dectris.albula.DMainFrame.enableClose (   self)

If called, clicking exit button closes DMainFrame.

This is default. See disableClose().

def dectris.albula.DMainFrame.enableKeyboardShortcuts (   self)

Enable keyboard shortcuts.

When keyboard shortcuts are enabled the user may set the contrast, go through the image series and resize the image via shortcuts. See also disableKeybordShort

def dectris.albula.DMainFrame.hideToolBar (   self)

Hide ToolBar.

Beamline scientists may want to prevent users from changing the settings in the Albula ToolBar.

def dectris.albula.DMainFrame.openSubFrame (   self,
  hideToolButtons = False,
  title = None 
)

Open a DSubFrame within the DMainFrame.

Parameters
hideToolButtonsIf set, hide the tool buttons of the DSubFrame. See DSubFrame.showToolButtons and DSubFrame.hideToolButtons.
titleString that will be displayed in the title bar. If title is set, the DSubFrame does no longer show the file path to the loaded image. Restore the default behaviour by calling unsetTitle(). See also DSubFrame.setTitle() and DSubFrame.unsetTitle().
def dectris.albula.DMainFrame.showToolBar (   self)

Show ToolBar.

See hideToolBar().

def dectris.albula.DMainFrame.subFrames (   self)

Returns a list of open DSubFrames within that DMainFrame.

Note these DSubFrames are not necessarily identical to those explicitely opened by openSubFrame(), because the user may open and close DSubFrames himself.

def dectris.albula.DMainFrame.synchronizeContrast (   self,
  flag 
)

Toggles contrast synchronization between DSubFrames.

Parameters
flagEiter True or False
def dectris.albula.DMainFrame.synchronizeStatistics (   self,
  flag 
)

Toggles statistics synchronization between DSubFrames.

Parameters
flagEiter True or False
def dectris.albula.DMainFrame.synchronizeViewport (   self,
  flag 
)

Toggles viewport synchronization between DSubFrames.

Parameters
flagEiter True or False