Defines | |
#define | CPL_FRAME_GROUP_RAW_ID "RAW" |
Frame group tag for unprocessed data. | |
#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. | |
Typedefs | |
typedef _cpl_frame_ | cpl_frame |
The frame data type. | |
typedef enum _cpl_frame_type_ | cpl_frame_type |
The frame type 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. | |
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, CPL_FRAME_TYPE_ANY } |
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. | |
cpl_frame * | cpl_frame_duplicate (const cpl_frame *other) |
Create a copy of a frame. | |
void | cpl_frame_delete (cpl_frame *self) |
Destroy a frame. | |
const char * | cpl_frame_get_filename (const cpl_frame *self) |
Get the file name to which a frame refers. | |
const char * | cpl_frame_get_tag (const cpl_frame *self) |
Get the category tag of a frame. | |
cpl_frame_type | cpl_frame_get_type (const cpl_frame *self) |
Get the type of a frame. | |
cpl_frame_group | cpl_frame_get_group (const cpl_frame *self) |
Get the current group of a frame. | |
cpl_frame_level | cpl_frame_get_level (const cpl_frame *self) |
Get the current level of a frame. | |
cpl_error_code | cpl_frame_set_filename (cpl_frame *self, const char *filename) |
Set the file name to which a frame refers. | |
cpl_error_code | cpl_frame_set_tag (cpl_frame *self, const char *tag) |
Set a frame's category tag. | |
cpl_error_code | cpl_frame_set_type (cpl_frame *self, cpl_frame_type type) |
Set the type of a frame. | |
cpl_error_code | cpl_frame_set_group (cpl_frame *self, cpl_frame_group group) |
Set the group attribute of a frame. | |
cpl_error_code | cpl_frame_set_level (cpl_frame *self, cpl_frame_level level) |
Set the level attribute of a frame. | |
int | cpl_frame_get_nextensions (const cpl_frame *self) |
Get the number of extensions of this frame. |
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.
#include <cpl_frame.h>
|
Frame group tag for calibration data.
|
|
Frame group tag for processed data.
|
|
Frame group tag for unprocessed data.
|
|
The frame data type.
|
|
The frame group data type.
|
|
The frame level data type.
|
|
The frame type data type.
|
|
Supported frame groups. Defines the possible values for the frame's group attribute. |
|
|
Supported frame types. Defines the possible values for the frame's type attribute.
|
|
Destroy a frame.
|
|
Create a copy of a frame.
The function creates a clone of the input frame other. All members of the input frame are copied. |
|
Get the file name to which a frame refers.
The function returns the name of a file associated to self. A file is associated to self by calling cpl_frame_set_filename() for self. If self is not associated to a file this function returns |
|
Get the current group of a frame.
The function returns the group attribute of the frame self. |
|
Get the current level of a frame.
The function returns the level attribute of the frame self. |
|
Get the number of extensions of this frame.
|
|
Get the category tag of a frame.
The function returns the frame's category tag. If a tag has not yet been set a |
|
Get the type of a frame.
The function returns the type of the data object to which it currently refers. |
|
Create a new, empty frame.
CPL_FRAME_TYPE_NONE , CPL_FRAME_GROUP_NONE , and CPL_FRAME_LEVEL_NONE , resepctively. |
|
Set the file name to which a frame refers.
The function sets the name of the file, to which the frame self refers. 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. |
|
Set the group attribute of a frame.
The function sets the group attribute of the frame self to group. |
|
Set the level attribute of a frame.
The function sets the level attribute of the frame self to level. |
|
Set a frame's category tag.
The function sets the category tag of self, replacing any previously set tag. If the frame does not yet have a tag is is created and initialised to tag. |
|
Set the type of a frame.
The function sets the type of the frame self to type. |