Package fabio :: Module file_series :: Class file_series
[hide private]
[frames] | no frames]

Class file_series

source code

object --+    
         |    
      list --+
             |
            file_series
Known Subclasses:


Represents a series of files to iterate
has an idea of a current position to do next and prev

You also get from the list python superclass:
   append
   count
   extend
   insert
   pop
   remove
   reverse
   sort

Instance Methods [hide private]
new empty list
__init__(self, list_of_strings)
Constructor:
source code
 
first(self)
First image in series
source code
 
last(self)
Last in series
source code
 
previous(self)
Prev in a sequence
source code
 
current(self)
Current position in a sequence
source code
 
next(self)
Next in a sequence
source code
 
jump(self, num)
Goto a position in sequence
source code
 
len(self)
Number of files
source code
 
first_image(self)
First image in a sequence
source code
 
last_image(self)
Last image in a sequence
source code
 
next_image(self)
Return the next image
source code
 
previous_image(self)
Return the previous image
source code
 
jump_image(self, num)
Jump to and read image
source code
 
current_image(self)
Current image in sequence
source code
 
first_object(self)
First image in a sequence
source code
 
last_object(self)
Last image in a sequence
source code
 
next_object(self)
Return the next image
source code
 
previous_object(self)
Return the previous image
source code
 
jump_object(self, num)
Jump to and read image
source code
 
current_object(self)
Current image in sequence
source code

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

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

Class Variables [hide private]

Inherited from list: __hash__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, list_of_strings)
(Constructor)

source code 

Constructor:

Parameters:
  • list_of_strings - arg should be a list of strings which are filenames
Returns: new empty list
Overrides: object.__init__

first_image(self)

source code 

First image in a sequence

Returns:
fabioimage

last_image(self)

source code 

Last image in a sequence

Returns:
fabioimage

next_image(self)

source code 

Return the next image

Returns:
fabioimage

previous_image(self)

source code 

Return the previous image

Returns:
fabioimage

jump_image(self, num)

source code 

Jump to and read image

Returns:
fabioimage

current_image(self)

source code 

Current image in sequence

Returns:
fabioimage

first_object(self)

source code 

First image in a sequence

Returns:
file_object

last_object(self)

source code 

Last image in a sequence

Returns:
file_object

next_object(self)

source code 

Return the next image

Returns:
file_object

previous_object(self)

source code 

Return the previous image

Returns:
file_object

jump_object(self, num)

source code 

Jump to and read image

Returns:
file_object

current_object(self)

source code 

Current image in sequence

Returns:
file_object