Home       Trees       Indices       Help   
Package bar :: Package rec :: Module pipeline :: Class barPipeline
[hide private]
[frames] | no frames]

Class barPipeline

VTK pipeline class.

Nested Classes [hide private]

Inherited from base.barObject (private): _clsBoundingBox, _clsBregmaMetadataElement, _clsCommentLabel, _clsGenericStructure, _clsMetadataElement, _clsPath, _clsRegularLabel, _clsSpotLabel, _clsStructureLabel, _clsTransfMatrixMetadataElement

Instance Methods [hide private]
 
__generateorder(self)
Set the order attribute for every pipeline element.
[barPipeElem, ...]
displayable(self)
Returns: displayable pipeline elements (in pipeline order)
[barPipeElem, ...]
nondisplayable(self)
Returns: nondisplayable pipeline elements (in pipeline order)
 
execute(self, imImport)
Apply the pipeline to imImport.
cls
__fromXML(cls, sourceXMLElement)
Create a pipeline based on the sourceXMLElement.
xml.dom.minidom.Element
getXMLelement(self)
Returns: DOM XML representation of the object
{'str':(int,int),...}
getOutputDataTypes(self)
Returns: Dictionary mapping fioter data output type to span of list elements that return given output data type.
 
__setElements(self, val)
Replace pipeline elements with val content.
[barPipeElem, ...]
__getElements(self)
Returns: elements of the pipeline.

Inherited from base.barObject: __str__, getElementById, writeXMLtoFile

Inherited from list: __add__, __contains__, __delitem__, __delslice__, __eq__, __ge__, __getattribute__, __gt__, __iadd__, __imul__, __init__, __iter__, __le__, __len__, __lt__, __mul__, __ne__, __new__, __repr__, __reversed__, __rmul__, __setitem__, __setslice__, __sizeof__, append, count, extend, insert, pop, reverse, sort

Inherited from object: __delattr__, __format__, __reduce__, __reduce_ex__, __setattr__, __subclasshook__

    overrided list methods
 
__getslice__(self, i, j)
x[i:j]
 
__getitem__(self, key)
x[y]
 
index(self, x)
L.index(value, [start, [stop]]) -> integer -- return first index of value.
 
remove(self, x)
remove first occurrence of value.
Class Methods [hide private]
cls
fromXML(cls, sourceXMLElement)
Create a pipeline based on the sourceXMLElement.
Static Methods [hide private]
 
__executeElement(vtksource, vtkAlgorithmObj)
Apply the pipeline element vtkAlgorithmObj to vtksource.
cls
_fromXML(cls, sourceXMLElement)
Create a pipeline based on the sourceXMLElement.

Inherited from barPipelineXML (private): _getSingle, _getSingleNested

Inherited from base.barObject (private): _getAttributesDict

Class Variables [hide private]
str _elementName = 'pipeline'
name of the XML element related to the class object.
[str, ...] _listelements = ['elements']
a list of the multiple children XML elements' names

Inherited from barPipelineXML (private): _attributes, _singleelements

Inherited from list: __hash__

Properties [hide private]
[barPipeElem, ...] elements

Inherited from object: __class__

Method Details [hide private]

__getslice__(self, i, j)
(Slicling operator)

 

x[i:j]

Use of negative indices is not supported.

Overrides: list.__getslice__
(inherited documentation)

__getitem__(self, key)
(Indexing operator)

 

x[y]

Overrides: list.__getitem__
(inherited documentation)

index(self, x)

 

L.index(value, [start, [stop]]) -> integer -- return first index of value. Raises ValueError if the value is not present.

Overrides: list.index
(inherited documentation)

remove(self, x)

 

remove first occurrence of value. Raises ValueError if the value is not present.

Overrides: list.remove
(inherited documentation)

displayable(self)

 
Returns: [barPipeElem, ...]
displayable pipeline elements (in pipeline order)

nondisplayable(self)

 
Returns: [barPipeElem, ...]
nondisplayable pipeline elements (in pipeline order)

__executeElement(vtksource, vtkAlgorithmObj)
Static Method

 

Apply the pipeline element vtkAlgorithmObj to vtksource.

Parameters:
  • vtksource - VTK data source
  • vtkAlgorithmObj - pipeline element
Returns:
vtkAlgorithmObj object

execute(self, imImport)

 

Apply the pipeline to imImport.

Parameters:
  • imImport - VTK data source
Returns:
result of application of the pipeline to imImport

__fromXML(cls, sourceXMLElement)

 

Create a pipeline based on the sourceXMLElement.

Parameters:
  • sourceXMLElement (xml.dom.minidom.Element or str) - the source DOM XML element or a path to the XML document.
Returns: cls
the pipeline

getXMLelement(self)

 

A stub of method. Raise NotImplementedError.

Parameters:
  • domDocument - DOM XML document for creation of the XML element (if not given, a new DOM XML document object is created)
Returns: xml.dom.minidom.Element
DOM XML representation of the object
Overrides: base.barObject.getXMLelement
(inherited documentation)

getOutputDataTypes(self)

 
Returns: {'str':(int,int),...}
Dictionary mapping fioter data output type to span of list elements that return given output data type.

__setElements(self, val)

 

Replace pipeline elements with val content.

Parameters:
  • val ([barPipeElem, ...]) - pipeline elements

__getElements(self)

 
Returns: [barPipeElem, ...]
elements of the pipeline.

fromXML(cls, sourceXMLElement)
Class Method

 

Create a pipeline based on the sourceXMLElement.

Parameters:
  • sourceXMLElement (xml.dom.minidom.Element or str) - the source DOM XML element or a path to the XML document.
Returns: cls
the pipeline

_fromXML(cls, sourceXMLElement)
Static Method

 

Create a pipeline based on the sourceXMLElement.

Parameters:
  • sourceXMLElement (xml.dom.minidom.Element or str) - the source DOM XML element or a path to the XML document.
Returns: cls
the pipeline

Property Details [hide private]

elements

Get Method:
__getElements(self) - Returns: elements of the pipeline.
Set Method:
__setElements(self, val) - Replace pipeline elements with val content.
Type:
[barPipeElem, ...]

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Wed Mar 20 14:31:40 2013 http://epydoc.sourceforge.net