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

Class barAllenApiAtlas

Class representing 'atlas' element that can be found in index of all Allen Institute atlases.

Nested Classes [hide private]

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

Instance Methods [hide private]
 
__init__(self, url, id=None, **kwargs)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 
_get_id(self)
 
_set_id(self, value)
 
_get_version(self)
 
_set_version(self, value)
 
_get_minAppVersion(self)
 
_set_minAppVersion(self, value)
 
_get_name(self)
 
_set_name(self, value)
 
_get_datePublished(self)
 
_set_datePublished(self, value)
 
_get_url(self)
 
_set_url(self, value)
 
_get_size(self)
 
_set_size(self, value)

Inherited from base.barAtlasSlideElement: affineTransform, getXMLelement

Inherited from base.barAtlasSlideElement (private): _getTextNodeXMLelement

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(cls, svgImageElement)
A stub of method.
Static Methods [hide private]

Inherited from base.barObject (private): _getAttributesDict

Class Variables [hide private]
str _elementName = 'atlas'
name of the represented XML element

Inherited from base.barAtlasSlideElement (private): _attributes, _attributesNS

Properties [hide private]
str id
Identifier of given atlas.
str version
Version of given atlas.
str minAppVersion
This property in included only for compatibility purposes and it is not used anywhere in the code.
str name
Full name of the atlas.
str datePublished
Publication date of given atlas.
int size
Size of the zip package with source dataset pointed by url property.
str url
URL pointing to zipfile with the atlas itself.

Inherited from object: __class__

Method Details [hide private]

__init__(self, url, id=None, **kwargs)
(Constructor)

 

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

Parameters:
  • id (int or str) - Identifier of a given atlas. Id is an integer but it is immediately converted to string.
  • url (str) - URL from which given dataset was downloaded
Overrides: object.__init__

fromXML(cls, svgImageElement)
Class Method

 

A stub of method. Raise NotImplementedError.

Parameters:
  • sourceXMLElement - XML representation of the element
Overrides: base.barAtlasSlideElement.fromXML
(inherited documentation)

Property Details [hide private]

id

Identifier of given atlas. Identifier has to be string.

Get Method:
_get_id(self)
Set Method:
_set_id(self, value)

version

Version of given atlas. String value required.

Get Method:
_get_version(self)
Set Method:
_set_version(self, value)

minAppVersion

This property in included only for compatibility purposes and it is not used anywhere in the code. Consult Allen Brain Institute API reference for meaning of 'minAppVersion' field.

Get Method:
_get_minAppVersion(self)
Set Method:
_set_minAppVersion(self, value)

name

Full name of the atlas. String value required

Get Method:
_get_name(self)
Set Method:
_set_name(self, value)

datePublished

Publication date of given atlas. Although is a date, the value is stored as string.

Get Method:
_get_datePublished(self)
Set Method:
_set_datePublished(self, value)

size

Size of the zip package with source dataset pointed by url property. Value of this property may be overriden but what for...

Get Method:
_get_size(self)
Set Method:
_set_size(self, value)

url

URL pointing to zipfile with the atlas itself.

Get Method:
_get_url(self)
Set Method:
_set_url(self, value)

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