Package bar :: Module barImageUnderlays :: Class barBackgroundImageSlide
[hide private]
[frames] | no frames]

Class barBackgroundImageSlide


Extenstion of the regular bar.barTracedSlideIndexer allowing the user to load a number of different image underlays in addition to the annotation layer. This class preserves its patent's ability to handle all annotation features.

Nested Classes [hide private]
Instance Methods [hide private]
 
__init__(self, **kwargs)
Class requires providing following properties in order to work properly:
xml.dom.minidom.Document
getXMLelement(self)
Returns: XML representation of the slide

Inherited from base.barTracedSlideRenderer: contourize, generateLabels, getMask, getSlideMassCenter, getStructuresSubset, renderPath, renderStructureList

Inherited from base.barTracedSlide: __add__, __delitem__, __getitem__, __len__, __setitem__, addPath, addStructures, affineTransform, findDuplicatedRegions, has_key, items, keys, recolor, values

Inherited from base.barTracedSlide (private): _getPaths, _getStructures

Inherited from base.barSlideRenderer: renderSlide

Inherited from base.barVectorSlide: Show, addLabel, alignToRefMatrix, deleteLabelByCaption, deleteLabelByID, getCommentLabels, getLabelByName, getRegularLabels, getSpotLabels, renameLabelByCaption, retypeLabelByCaption, srs2svg, svg2srs, updateMetadata

Inherited from base.barObject: __str__, getElementById, writeXMLtoFile

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Methods [hide private]
 
_fromXML_BeforeCleanUpHook(cls, slide, svgdom)
Customization hook allowing the developers implementing additional methods or features during parsing of XML document.
 
_fromXML_AfterCleanUpHook(cls, slide, svgdom)
Customization hook allowing the developers implementing additional methods or features during parsing of XML document.

Inherited from base.barTracedSlide: fromXML

Static Methods [hide private]

Inherited from base.barObject (private): _getAttributesDict

Instance Variables [hide private]

Inherited from base.barVectorSlide: slideNumber, slideTemplate

Inherited from base.barVectorSlide (private): _labels, _metadata

Properties [hide private]

Inherited from base.barTracedSlide: crispEdges, pathIndex, paths, structures, svgDocument

Inherited from base.barSlideRenderer: bitmapSize, size

Inherited from base.barVectorSlide: labelIndex, labels, metadata

Inherited from object: __class__

Method Details [hide private]

__init__(self, **kwargs)
(Constructor)

 

Class requires providing following properties in order to work properly:

  • rendererConfiguration['ReferenceWidth']: (int) width of SVG drawing
  • rendererConfiguration['ReferenceHeight']: (int) height of SVG drawing
  • rendererConfiguration['imageSize'] : ((int, int)) size (width, height) of resulting bitmap image
Parameters:
  • slideTemplate - SVG slide template
  • rendererConfiguration - renderer configuration (see module description for details)
  • tracingConfiguration - tracing configuration (see module description for details)
  • slideNumber - slide number
Overrides: object.__init__
(inherited documentation)

_fromXML_BeforeCleanUpHook(cls, slide, svgdom)
Class Method

 

Customization hook allowing the developers implementing additional methods or features during parsing of XML document. This hook is executed after parsing whole slide, just before cleaning all unnecessary elements and extracting slide template.

Overrides: base.barVectorSlide._fromXML_BeforeCleanUpHook
(inherited documentation)

_fromXML_AfterCleanUpHook(cls, slide, svgdom)
Class Method

 

Customization hook allowing the developers implementing additional methods or features during parsing of XML document. This hook is executed just after removing all unnecessary elements and before assigning slide's template.

Overrides: base.barVectorSlide._fromXML_AfterCleanUpHook
(inherited documentation)

getXMLelement(self)

 

A stub of method. Raise NotImplementedError.

Returns: xml.dom.minidom.Document
XML representation of the slide
Overrides: base.barObject.getXMLelement
(inherited documentation)