Main Page | Modules | Alphabetical List | Class List | Directories | Class Members

Frame Sets IO functions


Functions

cpl_imagelist * cpl_imagelist_load_frameset (const cpl_frameset *fset, cpl_type itype, int pnum, int extnum)
 Load an imagelist from a frameset.

Detailed Description

Synopsis:
   #include <cpl_frameset_io.h>

Function Documentation

cpl_imagelist* cpl_imagelist_load_frameset const cpl_frameset fset,
cpl_type  itype,
int  pnum,
int  extnum
 

Load an imagelist from a frameset.

Parameters:
fset The frames set
itype The required image type
pnum The plane number
extnum The required extension
Returns:
the loaded list of images or NULL in error case.
extnum = -1 is for all extensions. extnum = 0 is for the primary unit. extnum = n in for extension number n.

pnum = 0 is for all planes. pnum = n is for plane number n.

The returned cpl_imagelist must be deallocated using cpl_imagelist_delete()

Possible _cpl_error_code_ set in this function:

  • CPL_ERROR_NULL_INPUT if fset is NULL
  • CPL_ERROR_ILLEGAL_INPUT if pnum is negative, extnum is lower than -1 or one image cannot be loaded as specified


Generated on Mon Sep 26 14:38:18 2005 for Common Pipeline Library Reference Manual by  doxygen 1.4.1