Main Page   Modules   Alphabetical List   Compound List   Compound Members  

Frames


Defines

#define CPL_FRAME_GROUP_RAW_ID   "RAW"
 Frame group tag for unprocessed data. More...

#define CPL_FRAME_GROUP_CALIB_ID   "CALIB"
 Frame group tag for calibration data. More...

#define CPL_FRAME_GROUP_PRODUCT_ID   "PRODUCT"
 Frame group tag for processed data. More...


Typedefs

typedef _cpl_frame_ cpl_frame
 The frame data type. More...

typedef enum _cpl_frame_type_ cpl_frame_type
 The frame type data type. More...

typedef enum _cpl_frame_group_ cpl_frame_group
 The frame group data type. More...

typedef enum _cpl_frame_level_ cpl_frame_level
 The frame level data type. More...


Enumerations

enum  _cpl_frame_type_ {
  CPL_FRAME_TYPE_NONE,
  CPL_FRAME_TYPE_IMAGE,
  CPL_FRAME_TYPE_MATRIX,
  CPL_FRAME_TYPE_TABLE,
  CPL_FRAME_TYPE_PAF
}
 Supported frame types. More...

enum  _cpl_frame_group_ {
  CPL_FRAME_GROUP_NONE,
  CPL_FRAME_GROUP_RAW,
  CPL_FRAME_GROUP_CALIB,
  CPL_FRAME_GROUP_PRODUCT
}
 Supported frame groups. More...

enum  _cpl_frame_level_ {
  CPL_FRAME_LEVEL_NONE,
  CPL_FRAME_LEVEL_TEMPORARY,
  CPL_FRAME_LEVEL_INTERMEDIATE,
  CPL_FRAME_LEVEL_FINAL
}
 Supported frame processing levels. More...


Functions

cpl_frame * cpl_frame_new (void)
 Create a new, empty frame. More...

cpl_frame * cpl_frame_duplicate (const cpl_frame *frame)
 Create a copy of a frame. More...

void cpl_frame_delete (cpl_frame *frame)
 Destroy a frame. More...

const char * cpl_frame_get_filename (const cpl_frame *frame)
 Get the file name to which a frame refers. More...

const char * cpl_frame_get_tag (const cpl_frame *frame)
 Get the category tag of a frame. More...

cpl_frame_type cpl_frame_get_type (const cpl_frame *frame)
 Get the type of a frame. More...

cpl_frame_group cpl_frame_get_group (const cpl_frame *frame)
 Get the current group of a frame. More...

cpl_frame_level cpl_frame_get_level (const cpl_frame *frame)
 Get the current level of a frame. More...

int cpl_frame_set_filename (cpl_frame *frame, const char *filename)
 Set the file name to which a frame refers. More...

int cpl_frame_set_tag (cpl_frame *frame, const char *tag)
 Set a frame's category tag. More...

int cpl_frame_set_type (cpl_frame *frame, cpl_frame_type type)
 Set the type of a frame. More...

int cpl_frame_set_group (cpl_frame *frame, cpl_frame_group group)
 Set the group attribute of a frame. More...

int cpl_frame_set_level (cpl_frame *frame, cpl_frame_level level)
 Set the level attribute of a frame. More...


Detailed Description

This module implements the cpl_frame type. A frame is a container for descriptive attributes related to a data file. The attributes are related to a data file through the file name member of the frame type. Among the attributes which may be assigned to a data file is an attribute identifying the type of the data stored in the file (image or table data), a classification tag indicating the kind of data the file contains and an attribute denoting to which group the data file belongs (raw, processed or calibration file). For processed data a processing level indicates whether the product is an temporary, intermediate or final product.
Synopsis:
   #include <cpl_frame.h>

Define Documentation

#define CPL_FRAME_GROUP_CALIB_ID   "CALIB"
 

Frame group tag for calibration data.

#define CPL_FRAME_GROUP_PRODUCT_ID   "PRODUCT"
 

Frame group tag for processed data.

#define CPL_FRAME_GROUP_RAW_ID   "RAW"
 

Frame group tag for unprocessed data.


Typedef Documentation

typedef struct _cpl_frame_ cpl_frame
 

The frame data type.

typedef enum _cpl_frame_group_ cpl_frame_group
 

The frame group data type.

typedef enum _cpl_frame_level_ cpl_frame_level
 

The frame level data type.

typedef enum _cpl_frame_type_ cpl_frame_type
 

The frame type data type.


Enumeration Type Documentation

enum _cpl_frame_group_
 

Supported frame groups.

Defines the possible values for the frame's group attribute.

Enumeration values:
CPL_FRAME_GROUP_NONE  The frame does not belong to any supported group.
CPL_FRAME_GROUP_RAW  The frame is associated to unprocessed data.
CPL_FRAME_GROUP_CALIB  The frame is associated to calibration data.
CPL_FRAME_GROUP_PRODUCT  The frame is associated to processed data.

enum _cpl_frame_level_
 

Supported frame processing levels.

Note:
The processing levels are just flags and it is left to the application to trigger the appropriate action for the different levels.
Enumeration values:
CPL_FRAME_LEVEL_NONE  Undefined processing level
CPL_FRAME_LEVEL_TEMPORARY  Temporary product. The corresponding file will be deleted when the processing chain is completed.
CPL_FRAME_LEVEL_INTERMEDIATE  Intermediate product. The corresponding file is only kept on request. The default is to delete these products at the end of the processing chain.
CPL_FRAME_LEVEL_FINAL  Final data product, which is always written to a file at the end of the processing chain.

enum _cpl_frame_type_
 

Supported frame types.

Defines the possible values for the frame's type attribute.

Enumeration values:
CPL_FRAME_TYPE_NONE  Undefined frame type
CPL_FRAME_TYPE_IMAGE  Image frame type identifier
CPL_FRAME_TYPE_MATRIX  Matrix frame type identifier
CPL_FRAME_TYPE_TABLE  Table frame type identifier
CPL_FRAME_TYPE_PAF  PAF frame type identifier


Function Documentation

void cpl_frame_delete cpl_frame   frame
 

Destroy a frame.

Parameters:
frame  A frame.
Returns:
Nothing.
The function deallocates the memory used by the frame frame. Note that a possibly referenced property list and/or data object is not deallocated.

cpl_frame* cpl_frame_duplicate const cpl_frame   frame
 

Create a copy of a frame.

Parameters:
frame  The frame to copy.
Returns:
A handle for the created copy.
The function creates a copy of the input frame frame. All members of the input frame are copied, but not the possibly referenced property list and data object. For the latter two, only the reference is copied, i.e. the copy of frame and frame point to the same property list and data object and any modification done to these entities is seen by both frames.

const char* cpl_frame_get_filename const cpl_frame   frame
 

Get the file name to which a frame refers.

Parameters:
frame  A frame.
Returns:
The file name to which the frame refers, or NULL if a file name has not been set.
The function returns the name of a file associated to frame. Such a file does not necessarily exist and in this case NULL is retured. If a file name has been set using cpl_frame_set_filename(), the corresponding file will be used for load and save operations.

cpl_frame_group cpl_frame_get_group const cpl_frame   frame
 

Get the current group of a frame.

Parameters:
frame  A frame.
Returns:
The frame's current group.
The function returns the group attribute of the frame frame.

cpl_frame_level cpl_frame_get_level const cpl_frame   frame
 

Get the current level of a frame.

Parameters:
frame  A frame.
Returns:
The frame's current level.
The function returns the level attribute of the frame frame.

const char* cpl_frame_get_tag const cpl_frame   frame
 

Get the category tag of a frame.

Parameters:
frame  A frame.
Returns:
Reference to the frame's category tag or NULL if the tag is not set.
The function returns the frame's category tag. If a tag has not yet been set a NULL pointer is returned.

cpl_frame_type cpl_frame_get_type const cpl_frame   frame
 

Get the type of a frame.

Parameters:
frame  A frame.
Returns:
The frame's type.
The function returns the type of the data object to which it currently refers.

cpl_frame* cpl_frame_new void   
 

Create a new, empty frame.

Returns:
A handle for the newly created frame.
The function allocates the memory for the new frame and initialises it to an empty frame, i.e. it is created without tag and file information, and the type, group and level set to CPL_FRAME_TYPE_NONE, CPL_FRAME_GROUP_NONE, and CPL_FRAME_LEVEL_NONE, resepctively.

int cpl_frame_set_filename cpl_frame   frame,
const char *    filename
 

Set the file name to which a frame refers.

Parameters:
frame  A frame.
filename  The new file name.
Returns:
The function returns 0 on success or 1 otherwise.
The function sets the name of the file, to which the frame frame refers, for subsequent load and save operations. Any file name which was previously set by a call to this function is replaced. If no file name is present yet it is created and initialised to filename.

int cpl_frame_set_group cpl_frame   frame,
cpl_frame_group    group
 

Set the group attribute of a frame.

Parameters:
frame  A frame.
group  New group attribute.
Returns:
The function returns 0 on success or 1 otherwise.
The function sets the group attribute of the frame frame to group.

int cpl_frame_set_level cpl_frame   frame,
cpl_frame_level    level
 

Set the level attribute of a frame.

Parameters:
frame  A frame.
level  New level attribute.
Returns:
The function returns 0 on success or 1 otherwise.
The function sets the level attribute of the frame frame to level.

int cpl_frame_set_tag cpl_frame   frame,
const char *    tag
 

Set a frame's category tag.

Parameters:
frame  A frame.
tag  The new category tag.
Returns:
The function returns 0 on success or 1 otherwise.
The function sets the category tag of frame, replacing any previously set tag. If the frame does not yet have a tag is is created and initialised to tag.

int cpl_frame_set_type cpl_frame   frame,
cpl_frame_type    type
 

Set the type of a frame.

Parameters:
frame  A frame.
type  New frame type.
Returns:
The function returns 0 on success or 1 otherwise.
The function sets the type of the frame frame to type.


Generated on Mon May 24 14:58:06 2004 for Common Pipeline Library Reference Manual by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002