Common Pipeline Library Reference Manual  7.1.2
Modules
Here is a list of all modules:
[detail level 12]
 ArraysThis module provides functions to create, destroy and use a cpl_array
 Auxiliary Frame DataAuxiliary frame data for recipe configurations
 Bi-vector objectThis module provides functions to handle cpl_bivector
 DFS related functions
 Error handlingThis module provides functions to maintain the cpl_error_code set by any CPL function, similarly to what is done with the errno variable of the standard C library. The following guidelines are respected:
 FFTW wrappersThis module provides FFTW wrappers
 FITS related basic routinesThis module provides functions to get basic information on FITS files
 FiltersThis module provides definitions for filtering of a cpl_image and a cpl_mask. The actual filtering functions are defined in the cpl_image and cpl_mask modules
 Frame SetsThe module implements a container type for frames. Frames can be stored in a frame set and retrieved, either by searching for a particular frame tag or by sequential access. Frame sets can be created, filled and saved to a so called ‘set of frames’ file or loaded from such a file
 Frame Set IteratorsIterator support for frame sets
 Frame Sets IO functions
 FramesThis 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
 Fundamental math functionalityThis module provides fundamental math constants
 Handling of multiple CPL errorsThis module provides functions for error detection and recovery and for producing an error traceback
 High level functions for geometric transformationsThis module contains functions to compute the shift-and-add operation on an image list
 High level functions to handle aperturesThe aperture object contains a list of zones in an image. It is typically used to contain the results of an objects detection, or if one wants to work on a very specific zone in an image
 High-level functions for non-linear fittingThis module provides a routine for non-linear fitting
 High-level functions that are photometry related
 High-level functions to compute detector features
 I/OThis module provides definitions related to I/O. The actual I/O functions are defined in the respective CPL modules
 ImagelistsThis module provides functions to create, use, and destroy a cpl_imagelist. A cpl_imagelist is an ordered list of cpl_images. All images in a list must have the same pixel-type and the same dimensions. It is allowed to insert the same image into different positions in the list. Different images in the list are allowed to share the same bad pixel map
 ImagesThis module provides functions to create, use, and destroy a cpl_image. A cpl_image is a 2-dimensional data structure with a pixel type (one of CPL_TYPE_INT, CPL_TYPE_FLOAT, CPL_TYPE_DOUBLE, CPL_TYPE_FLOAT_COMPLEX or CPL_TYPE_DOUBLE_COMPLEX) and an optional bad pixel map
 Library InitializationThe module provides the CPL library startup routine. The startup routine initialises CPL internal data structures. For this reason, any application using functions from the CPL libraries must call the startup routine prior to calling any other CPL function
 Library Version InformationThis module provides functions to access the library's version information
 Masks of pixelsThis module provides functions to handle masks of pixels
 MatricesThis module provides functions to create, destroy and use a cpl_matrix. The elements of a cpl_matrix with M rows and N columns are counted from 0,0 to M-1,N-1. The matrix element 0,0 is the one at the upper left corner of a matrix. The CPL matrix functions work properly only in the case the matrices elements do not contain garbage (such as NaN or infinity)
 Memory Management UtilitiesThis module provides the CPL memory management utilities
 MessagesThis module provides functions to display and log messages. The following operations are supported:
 Multi FramesThis module implements the cpl_multiframe container type. A multi frame contains references to datasets (FITS extensions) which may be distributed across several physical files. These references can then be merged into a new product file
 Regular Expression Filter
 Parameter ListsThe module implements a parameter list data type, a container for the cpl_parameter type. It provides a convenient way to pass a set of parameters, as a whole, to a function
 ParametersThis module implements a class of data types which can be used to manage context specific, named parameters. They provide a standard way to pass, for instance, command line information to different components of an application
 Plotting of CPL objectsThis module provides functions to plot basic CPL objects
 Plugin InterfaceThe basic plugin interface definition
 Plugin ListThis module implements a list container for plugin objects and provides the facilities to query, to traverse and to update the container. The purpose of this container is to be able to store references to available plugins and to handle sets of plugins as a whole
 Point pattern matching module
 PolynomialsThis module provides functions to handle uni- and multivariate polynomials
 PropertiesThis module implements the property type. The type cpl_property is basically a variable container which consists of a name, a type identifier and a specific value of that type. The type identifier always determines the type of the associated value. A property is similar to an ordinary variable and its current value can be set or retrieved through its name. In addition a property may have a descriptive comment associated. A property can be created for the basic types char, bool (int), int, long, float and double. Also C strings are supported. Support for arrays in general is currently not available
 Property ListsThis module implements a container for properties (see Properties) which can be used to store auxiliary values related to another data object, an image or a table for instance. The property values can be set and retrieved by their associated name and properties can be added and removed from the list. The property list container is an ordered sequence of properties
 Recipe ConfigurationsThis module implements the support for recipe configurations. A recipe configuration stores information about the input data frames a recipe can process, which other input frame are needed in addition, and which output frames may be created by the recipe
 Recipe DefinitionThis module implements the support for recipe defition
 RecipesRecipe plugin interface definition
 StatisticsThis module provides functions to handle the cpl_stats object. This object can contain the statistics that have been computed from different CPL objects. Currently, only the function that computes statistics on images (or images windows) is provided
 TablesThis module provides functions to create, use, and destroy a cpl_table. A cpl_table is made of columns, and a column consists of an array of elements of a given type. Currently three numerical types are supported, CPL_TYPE_INT, CPL_TYPE_FLOAT, and CPL_TYPE_DOUBLE, plus a type indicating columns containing character strings, CPL_TYPE_STRING. Moreover, it is possible to define columns of arrays, i.e. columns whose elements are arrays of all the basic types listed above. Within the same column all arrays must have the same type and the same length
 Type codesThis module provides codes for the basic types (including char, int, float, etc.) used in CPL. These type codes may be used to indicate the type of a value stored in another object, the value of a property or the pixel of an image for instance. In addition, a utility function is provided to compute the size, which is required to store a value of the type indicated by a given type code
 Unit testing functionsThis module provides various functions for unit testing
 VectorThis module provides functions to handle cpl_vector
 Wavelength calibrationThis module contains functions to perform 1D-wavelength calibration, typically of long-slit spectroscopy data
 World Coordinate SystemThis module provides functions to manipulate FITS World Coordinate Systems