Package bar :: Module atlas_indexer :: Class barIndexerSlideElement
[hide private]
[frames] | no frames]

Class barIndexerSlideElement


Class of objects representing 'slide' elements of CAF dataset index file.

Nested Classes [hide private]
Instance Methods [hide private]
str
__getCoronalCoord(self)
Returns: value of the 'coronalcoord' attribute of the represented element
int
__getSlideNumber(self)
Returns: value of the 'slidenumber' attribute of represented XML element
(float, float, float, float)
__getTransfomarionMatrix(self)
Returns: value of the 'transformationmatrix' attribute of represented XML element
 
__init__(self, coronalcoord, slidenumber, transformationmatrix)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 
__setCoronalCoord(self, newValue)
Set value of the 'coronalcoord' attribute of represented XML element.
 
__setSlideNumber(self, newValue)
Set value of the 'slidenumber' attribute of represented XML element.
 
__setTransformationMatrix(self, newValue)
Set value of the 'transformationmatrix' attribute of represented XML element.
 
getXMLelement(self)
Returns: dom XML object describing the object

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]
cls
fromXML(cls, domXMLElement, indexer=None)
Creates object from its (valid) xml representation.
Static Methods [hide private]

Inherited from base.barObject (private): _getAttributesDict

Class Variables [hide private]
[str, ...] _elementAttributes = ['coronalcoord', 'slidenumber', 'transfor...
names of attributes of the XML element represented by class instances
str _elementName = 'slide'
name of the XML element represented by class instances
Instance Variables [hide private]
str _coronalcoord
value of the 'coronalcoord' attribute of the represented element
int _slidenumber
value of the 'slidenumber' attribute of the represented element
(float, float, float, float) _transformationmatrix
value of the 'transformationmatrix' attribute of the represented element
Properties [hide private]
str coronalcoord
Value of the 'coronalcoord' attribute of represented XML element.
int name
An alias for self.slideNumber
int slideNumber
Value of the 'slidenumber' attribute of represented XML element.
int slidenumber
An alias for self.slideNumber
(float, float, float, float) transformationmatrix
Value of the 'transformationmatrix' attribute of represented XML element.

Inherited from object: __class__

Method Details [hide private]

__getCoronalCoord(self)

 
Returns: str
value of the 'coronalcoord' attribute of the represented element

__getSlideNumber(self)

 
Returns: int
value of the 'slidenumber' attribute of represented XML element

__getTransfomarionMatrix(self)

 
Returns: (float, float, float, float)
value of the 'transformationmatrix' attribute of represented XML element

__init__(self, coronalcoord, slidenumber, transformationmatrix)
(Constructor)

 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Parameters:
  • coronalcoord (str) - value of the 'coronalcoord' attribute of the represented element
  • slidenumber (convertable to int) - value of the 'slidenumber' attribute of the represented element
  • transformationmatrix ((float, float, float, float)) - value of the 'transformationmatrix' attribute of the represented element
Overrides: object.__init__

__setCoronalCoord(self, newValue)

 

Set value of the 'coronalcoord' attribute of represented XML element.

Parameters:
  • newValue (str) - value of the 'coronalcoord' attribute of represented XML element

__setSlideNumber(self, newValue)

 

Set value of the 'slidenumber' attribute of represented XML element.

Parameters:
  • newValue (convertable to int) - value of the 'slidenumber' attribute of represented XML element

__setTransformationMatrix(self, newValue)

 

Set value of the 'transformationmatrix' attribute of represented XML element.

Parameters:
  • newValue ((float, float, float, float)) - value of the 'transformationmatrix' attribute of represented XML element

fromXML(cls, domXMLElement, indexer=None)
Class Method

 

Creates object from its (valid) xml representation.

Parameters:
  • domXMLElement (xml.dom.Node) - XML description of the barIndexerSlideElement object to be created
  • indexer (barIndexer) - the object encapsulating returned class instance
Returns: cls
object based on domXMLElement description
Overrides: barIndexerObject.fromXML

getXMLelement(self)

 

A stub of method. Raise NotImplementedError.

Returns:
dom XML object describing the object
Overrides: base.barObject.getXMLelement
(inherited documentation)

Class Variable Details [hide private]

_elementAttributes

names of attributes of the XML element represented by class instances
Type:
[str, ...]
Value:
['coronalcoord', 'slidenumber', 'transformationmatrix']

Property Details [hide private]

coronalcoord

Value of the 'coronalcoord' attribute of represented XML element.

Get Method:
__getCoronalCoord(self) - Returns: value of the 'coronalcoord' attribute of the represented element
Set Method:
__setCoronalCoord(self, newValue) - Set value of the 'coronalcoord' attribute of represented XML element.
Type:
str

name

An alias for self.slideNumber

Get Method:
__getSlideNumber(self) - Returns: value of the 'slidenumber' attribute of represented XML element
Set Method:
__setSlideNumber(self, newValue) - Set value of the 'slidenumber' attribute of represented XML element.
Type:
int

slideNumber

Value of the 'slidenumber' attribute of represented XML element.

Get Method:
__getSlideNumber(self) - Returns: value of the 'slidenumber' attribute of represented XML element
Set Method:
__setSlideNumber(self, newValue) - Set value of the 'slidenumber' attribute of represented XML element.
Type:
int

slidenumber

An alias for self.slideNumber

Get Method:
__getSlideNumber(self) - Returns: value of the 'slidenumber' attribute of represented XML element
Set Method:
__setSlideNumber(self, newValue) - Set value of the 'slidenumber' attribute of represented XML element.
Type:
int

transformationmatrix

Value of the 'transformationmatrix' attribute of represented XML element.

Get Method:
__getTransfomarionMatrix(self) - Returns: value of the 'transformationmatrix' attribute of represented XML element
Set Method:
__setTransformationMatrix(self, newValue) - Set value of the 'transformationmatrix' attribute of represented XML element.
Type:
(float, float, float, float)