NIPY logo

Site Navigation

NIPY Community

Table Of Contents

This Page

core.image.image_list

Module: core.image.image_list

Inheritance diagram for nipy.core.image.image_list:

ImageList

class nipy.core.image.image_list.ImageList(images=None)

Bases: object

Class to contain ND image as list of (N-1)D images

Methods

from_image
next
__init__(images=None)

An implementation of a list of images.

Parameters :

images : iterable

an iterable object whose items are meant to be images; this is checked by asserting that each has a coordmap attribute and a get_data method. Note that Image objects are not iterable by default; use the from_image classmethod or iter_axis function to convert images to image lists - see examples below for the latter.

Examples

>>> from nipy.testing import funcfile
>>> from nipy.core.api import Image, ImageList, iter_axis
>>> from nipy.io.api import load_image
>>> funcim = load_image(funcfile)
>>> iterable_img = iter_axis(funcim, 't')
>>> ilist = ImageList(iterable_img)
>>> sublist = ilist[2:5]

Slicing an ImageList returns a new ImageList

>>> isinstance(sublist, ImageList)
True

Indexing an ImageList returns a new Image

>>> newimg = ilist[2]
>>> isinstance(newimg, Image)
True
>>> isinstance(newimg, ImageList)
False
>>> np.asarray(sublist).shape
(3, 17, 21, 3)
>>> np.asarray(newimg).shape
(17, 21, 3)
classmethod from_image(klass, image, axis=None)

Create an image list from an image by slicing over axis

Parameters :

image : object

object with coordmap attribute

axis : str or int

axis of image that should become the axis indexed by the image list.

Returns :

ilist : ImageList instance

next()