mvpa2.base.collections.SampleAttribute

class mvpa2.base.collections.SampleAttribute(value=None, name=None, doc='Sequence attribute', length=None)

Per sample attribute in a dataset

Methods

set_length_check(value)

Set a target length of the value in this collectable.

Parameters:

value : arbitrary (see derived implementations)

The actual value of this attribute.

name : str

Name of the attribute under which it should be available in its respective collection.

doc : str

Documentation about the purpose of this attribute.

length : int

If not None, enforce any array assigned as value of this collectable to be of this length. If an array does not match this requirement it is not modified, but a ValueError is raised.

Methods

set_length_check(value)

Set a target length of the value in this collectable.