CLASS imseq_matlab

  IMSEQ_MATLAB - turn image files that can be read by Matlab's IMREAD into an IMSEQ object

  See the reference page.

  Examples:
    ims = imseq_matlab('ngc6543a.jpg')
    ims.imsize
    ims.numframes
    d = ims.frame(1,1);
    figure; 
    image(d);

    % suppose you have a multi-frame TIFF in myfile.tif
    ims = imseq_matlab('myfile.tif');
    ims.imsize, % show size
    ims.numframes, % show frames
    data = ims.frame(1,1:3); % read frames 1, 2, 3

Superclasses

imseq, handle

Properties

Property	Description
filename	The (full path) filename to be accessed
info	The file information
currentchannel

Methods

Method	Description
addlistener	ADDLISTENER Add listener for event.
delete	DELETE Delete a handle object.
eq	== (EQ) Test handle equality.
findobj	FINDOBJ Find objects matching specified conditions.
findprop	FINDPROP Find property of MATLAB handle object.
frame	return a frame from an IMSEQ object
ge	>= (GE) Greater than or equal relation for handles.
gt	> (GT) Greater than relation for handles.
imseq_matlab	creator an image sequence object from a Matlab-readable image file
imsize	return the size of images that are delivered by an IMSEQ_MATLAB object
isvalid	ISVALID Test handle validity.
le	<= (LE) Less than or equal relation for handles.
listener	LISTENER Add listener for event without binding the listener to the source object.
lt	< (LT) Less than relation for handles.
ne	~= (NE) Not equal relation for handles.
notify	NOTIFY Notify listeners of event.
numepochs	number of sequence epochs available for IMSEQ_MATLAB object
numframes	number of frames in a given image sequence epoch
setfilename	Set or reset the filename of an IMSEQ_MATLAB_OBJ
setselectedchannel	set a selected channel for reading from an image sequence object
update	re-read parameters of the image file with IMFINFO

Methods help

addlistener - ADDLISTENER Add listener for event.

el = ADDLISTENER(hSource, Eventname, callbackFcn) creates a listener
    for the event named Eventname.  The source of the event is the handle 
    object hSource.  If hSource is an array of source handles, the listener
    responds to the named event on any handle in the array.  callbackFcn
    is a function handle that is invoked when the event is triggered.

    el = ADDLISTENER(hSource, PropName, Eventname, Callback) adds a 
    listener for a property event.  Eventname must be one of
    'PreGet', 'PostGet', 'PreSet', or 'PostSet'. Eventname can be
    a string scalar or character vector.  PropName must be a single 
    property name specified as string scalar or character vector, or a 
    collection of property names specified as a cell array of character 
    vectors or a string array, or as an array of one or more 
    meta.property objects.  The properties must belong to the class of 
    hSource.  If hSource is scalar, PropName can include dynamic 
    properties.

    For all forms, addlistener returns an event.listener.  To remove a
    listener, delete the object returned by addlistener.  For example,
    delete(el) calls the handle class delete method to remove the listener
    and delete it from the workspace.

    ADDLISTENER binds the listener's lifecycle to the object that is the 
    source of the event.  Unless you explicitly delete the listener, it is
    destroyed only when the source object is destroyed.  To control the
    lifecycle of the listener independently from the event source object, 
    use listener or the event.listener constructor to create the listener.

    See also LISTENER, EVENT.LISTENER, IMSEQ_MATLAB, NOTIFY, DELETE, META.PROPERTY, EVENTS

Help for imseq_matlab/addlistener is inherited from superclass handle

---

delete - DELETE Delete a handle object.

DELETE(H) deletes all handle objects in array H. After the delete 
    function call, H is an array of invalid objects.

    See also IMSEQ_MATLAB, IMSEQ_MATLAB/ISVALID, CLEAR

Help for imseq_matlab/delete is inherited from superclass handle

---

eq - == (EQ) Test handle equality.

Handles are equal if they are handles for the same object.

    H1 == H2 performs element-wise comparisons between handle arrays H1 and
    H2.  H1 and H2 must be of the same dimensions unless one is a scalar.
    The result is a logical array of the same dimensions, where each
    element is an element-wise equality result.

    If one of H1 or H2 is scalar, scalar expansion is performed and the 
    result will match the dimensions of the array that is not scalar.

    TF = EQ(H1, H2) stores the result in a logical array of the same 
    dimensions.

    See also IMSEQ_MATLAB, IMSEQ_MATLAB/GE, IMSEQ_MATLAB/GT, IMSEQ_MATLAB/LE, IMSEQ_MATLAB/LT, IMSEQ_MATLAB/NE

Help for imseq_matlab/eq is inherited from superclass handle

---

findobj - FINDOBJ Find objects matching specified conditions.

The FINDOBJ method of the HANDLE class follows the same syntax as the 
    MATLAB FINDOBJ command, except that the first argument must be an array
    of handles to objects.

    HM = FINDOBJ(H, <conditions>) searches the handle object array H and 
    returns an array of handle objects matching the specified conditions.
    Only the public members of the objects of H are considered when 
    evaluating the conditions.

    See also FINDOBJ, IMSEQ_MATLAB

Help for imseq_matlab/findobj is inherited from superclass handle

---

findprop - FINDPROP Find property of MATLAB handle object.

p = FINDPROP(H,PROPNAME) finds and returns the META.PROPERTY object
    associated with property name PROPNAME of scalar handle object H.
    PROPNAME can be a string scalar or character vector.  It can be the 
    name of a property defined by the class of H or a dynamic property 
    added to scalar object H.

    If no property named PROPNAME exists for object H, an empty 
    META.PROPERTY array is returned.

    See also IMSEQ_MATLAB, IMSEQ_MATLAB/FINDOBJ, DYNAMICPROPS, META.PROPERTY

Help for imseq_matlab/findprop is inherited from superclass handle

---

frame - return a frame from an IMSEQ object

F = FRAME(IMSEQ_MATLAB_OBJ, EPOCH, FRAMENUMBER)

  Return the image at frame FRAMENUMBER from epoch EPOCH from the IMSEQ object
  IMSEQ_MATLAB_OBJ. FRAME will have dimensions [NX NY NZ C] where NX is the number of pixels of
  each image in the X dimension, NY is the number of pixels of each image in the Y dimension,
  NZ is the number of pixels of each image in the Z dimension, and C is the number of channels.

  FRAMENUMBER may also be an array of frames (e.g., [1 2 3]). Frames will be concatenated on the
  3rd dimension if the channel dimension is 1; otherwise frames will be concatenated on the 4th dimension.

---

ge - >= (GE) Greater than or equal relation for handles.

H1 >= H2 performs element-wise comparisons between handle arrays H1 and
    H2.  H1 and H2 must be of the same dimensions unless one is a scalar.
    The result is a logical array of the same dimensions, where each
    element is an element-wise >= result.

    If one of H1 or H2 is scalar, scalar expansion is performed and the 
    result will match the dimensions of the array that is not scalar.

    TF = GE(H1, H2) stores the result in a logical array of the same 
    dimensions.

    See also IMSEQ_MATLAB, IMSEQ_MATLAB/EQ, IMSEQ_MATLAB/GT, IMSEQ_MATLAB/LE, IMSEQ_MATLAB/LT, IMSEQ_MATLAB/NE

Help for imseq_matlab/ge is inherited from superclass handle

---

gt - > (GT) Greater than relation for handles.

H1 > H2 performs element-wise comparisons between handle arrays H1 and 
    H2.  H1 and H2 must be of the same dimensions unless one is a scalar.  
    The result is a logical array of the same dimensions, where each
    element is an element-wise > result.

    If one of H1 or H2 is scalar, scalar expansion is performed and the 
    result will match the dimensions of the array that is not scalar.

    TF = GT(H1, H2) stores the result in a logical array of the same 
    dimensions.

    See also IMSEQ_MATLAB, IMSEQ_MATLAB/EQ, IMSEQ_MATLAB/GE, IMSEQ_MATLAB/LE, IMSEQ_MATLAB/LT, IMSEQ_MATLAB/NE

Help for imseq_matlab/gt is inherited from superclass handle

---

imseq_matlab - creator an image sequence object from a Matlab-readable image file

IMSEQ_MATLAB_OBJ = IMSEQ_MATLAB(FILENAME)

  Create an image sequence object using a filename that can be read by Matlab's IMREAD
  function. FILENAME should be the full path to the image file name. The file should have an
  extension that is interpretable to IMREAD.

  See also: IMREAD

    Documentation for imseq_matlab/imseq_matlab
       doc imseq_matlab

---

imsize - return the size of images that are delivered by an IMSEQ_MATLAB object

SZ = IMSIZE(IMSEQ_MATLAB_OBJ)

  Returns the size of the image g. SZ = [ NX NY NZ NC ]
  where
    NX - number of pixels in first dimension
    NY - number of pixels in second dimension
    NZ - number of pixels in third dimension (will always be 1)
    NC - number of 'channels' in each image (will comprise 3rd dimension)

---

isvalid - ISVALID Test handle validity.

TF = ISVALID(H) performs an element-wise check for validity on the 
    handle elements of H.  The result is a logical array of the same 
    dimensions as H, where each element is the element-wise validity 
    result.

    A handle is invalid if it has been deleted or if it is an element
    of a handle array and has not yet been initialized.

    See also IMSEQ_MATLAB, IMSEQ_MATLAB/DELETE

Help for imseq_matlab/isvalid is inherited from superclass handle

---

le - <= (LE) Less than or equal relation for handles.

Handles are equal if they are handles for the same object.  All 
    comparisons use a number associated with each handle object.  Nothing
    can be assumed about the result of a handle comparison except that the
    repeated comparison of two handles in the same MATLAB session will 
    yield the same result.  The order of handle values is purely arbitrary 
    and has no connection to the state of the handle objects being 
    compared.

    H1 <= H2 performs element-wise comparisons between handle arrays H1 and
    H2.  H1 and H2 must be of the same dimensions unless one is a scalar.
    The result is a logical array of the same dimensions, where each
    element is an element-wise >= result.

    If one of H1 or H2 is scalar, scalar expansion is performed and the 
    result will match the dimensions of the array that is not scalar.

    TF = LE(H1, H2) stores the result in a logical array of the same 
    dimensions.

    See also IMSEQ_MATLAB, IMSEQ_MATLAB/EQ, IMSEQ_MATLAB/GE, IMSEQ_MATLAB/GT, IMSEQ_MATLAB/LT, IMSEQ_MATLAB/NE

Help for imseq_matlab/le is inherited from superclass handle

---

listener - LISTENER Add listener for event without binding the listener to the source object.

el = LISTENER(hSource, Eventname, callbackFcn) creates a listener
    for the event named Eventname.  The source of the event is the handle  
    object hSource.  If hSource is an array of source handles, the listener
    responds to the named event on any handle in the array.  callbackFcn
    is a function handle that is invoked when the event is triggered.

    el = LISTENER(hSource, PropName, Eventname, callback) adds a 
    listener for a property event.  Eventname must be one of  
    'PreGet', 'PostGet', 'PreSet', or 'PostSet'. Eventname can be a 
    string sclar or character vector.  PropName must be either a single 
    property name specified as a string scalar or character vector, or 
    a collection of property names specified as a cell array of character 
    vectors or a string array, or as an array of one ore more 
    meta.property objects. The properties must belong to the class of 
    hSource.  If hSource is scalar, PropName can include dynamic 
    properties.

    For all forms, listener returns an event.listener.  To remove a
    listener, delete the object returned by listener.  For example,
    delete(el) calls the handle class delete method to remove the listener
    and delete it from the workspace.  Calling delete(el) on the listener
    object deletes the listener, which means the event no longer causes
    the callback function to execute. 

    LISTENER does not bind the listener's lifecycle to the object that is
    the source of the event.  Destroying the source object does not impact
    the lifecycle of the listener object.  A listener created with LISTENER
    must be destroyed independently of the source object.  Calling 
    delete(el) explicitly destroys the listener. Redefining or clearing 
    the variable containing the listener can delete the listener if no 
    other references to it exist.  To tie the lifecycle of the listener to 
    the lifecycle of the source object, use addlistener.

    See also ADDLISTENER, EVENT.LISTENER, IMSEQ_MATLAB, NOTIFY, DELETE, META.PROPERTY, EVENTS

Help for imseq_matlab/listener is inherited from superclass handle

---

lt - < (LT) Less than relation for handles.

H1 < H2 performs element-wise comparisons between handle arrays H1 and
    H2.  H1 and H2 must be of the same dimensions unless one is a scalar.
    The result is a logical array of the same dimensions, where each
    element is an element-wise < result.

    If one of H1 or H2 is scalar, scalar expansion is performed and the 
    result will match the dimensions of the array that is not scalar.

    TF = LT(H1, H2) stores the result in a logical array of the same 
    dimensions.

    See also IMSEQ_MATLAB, IMSEQ_MATLAB/EQ, IMSEQ_MATLAB/GE, IMSEQ_MATLAB/GT, IMSEQ_MATLAB/LE, IMSEQ_MATLAB/NE

Help for imseq_matlab/lt is inherited from superclass handle

---

ne - ~= (NE) Not equal relation for handles.

Handles are equal if they are handles for the same object and are 
    unequal otherwise.

    H1 ~= H2 performs element-wise comparisons between handle arrays H1 
    and H2.  H1 and H2 must be of the same dimensions unless one is a 
    scalar.  The result is a logical array of the same dimensions, where 
    each element is an element-wise equality result.

    If one of H1 or H2 is scalar, scalar expansion is performed and the 
    result will match the dimensions of the array that is not scalar.

    TF = NE(H1, H2) stores the result in a logical array of the same
    dimensions.

    See also IMSEQ_MATLAB, IMSEQ_MATLAB/EQ, IMSEQ_MATLAB/GE, IMSEQ_MATLAB/GT, IMSEQ_MATLAB/LE, IMSEQ_MATLAB/LT

Help for imseq_matlab/ne is inherited from superclass handle

---

notify - NOTIFY Notify listeners of event.

NOTIFY(H, eventname) notifies listeners added to the event named 
    eventname for handle object array H that the event is taking place. 
    eventname can be a string scalar or character vector.  
    H is the array of handles to the event source objects, and 'eventname'
    must be a character vector.

    NOTIFY(H,eventname,ed) provides a way of encapsulating information 
    about an event which can then be accessed by each registered listener.
    ed must belong to the EVENT.EVENTDATA class.

    See also IMSEQ_MATLAB, IMSEQ_MATLAB/ADDLISTENER, IMSEQ_MATLAB/LISTENER, EVENT.EVENTDATA, EVENTS

Help for imseq_matlab/notify is inherited from superclass handle

---

numepochs - number of sequence epochs available for IMSEQ_MATLAB object

E = NUMEPOCHS(IMSEQ_MATLAB_OBJ)

  Returns the number of recording epoch sequences for an IMSEQ_MATLAB object.

  An epoch is a complete recording of a sequence of images.

  In the filename-based class IMSEQ_MATLAB, this always returns 1 (a single epoch).

---

numframes - number of frames in a given image sequence epoch

NF = NUMFRAMES(IMSEQ_MATLAB_OBJ, EPOCH)

  Returns the number of image frames NF in the image sequence IMSEQ_MATLAB_OBJ
  recording epoch EPOCH.  In this class, EPOCH is always taken to be 1.

---

setfilename - Set or reset the filename of an IMSEQ_MATLAB_OBJ

IMSEQ_MATLAB_OBJ = SETFILENAME(IMSEQ_MATLAB_OBJ, FILENAME)

  Sets the filename.

---

setselectedchannel - set a selected channel for reading from an image sequence object

IMSEQ_MATLAB_OBJ = SETSELECTEDCHANNEL(IMSEQ_MATLAB_OBJ, CHANNEL)

  Sets the selected channel to be returned by FRAME. Use CHANNEL=[] to return all channels.

---

update - re-read parameters of the image file with IMFINFO

IMSEQ_MATLAB_OBJ = UPDATE(IMSEQ_MATLAB_OBJ)

  Updates the internal variables of the IMSEQ_MATLAB_OBJ.
  Calls IMFINFO.

---