ERIS Pipeline Reference Manual 1.8.14
Functions
Debugging functions

Functions

cpl_error_code eris_ifu_debug_header (const cpl_propertylist *header)
 All properties contained in header are printed as pairs of keyword and data for debugging purposes.
 
cpl_error_code eris_ifu_debug_frameset (const cpl_frameset *frameset)
 All frames contained in frameset are printed for debugging purposes.
 
cpl_error_code eris_ifu_debug_parameterlist (const cpl_parameterlist *plist)
 All parameters contained in plist are printed for debugging purposes.
 
cpl_error_code eris_ifu_debug_propertylist (const cpl_propertylist *plist)
 All properties contained in plist are printed for debugging purposes.
 
cpl_error_code eris_ifu_debug_frame (const cpl_frame *frame)
 The CPL_FRAME_TYPE, CPL_FRAME_LEVEL and CPL_FRAME_GROUP of frame are printed for debugging purposes.
 
cpl_error_code eris_ifu_debug_cube (const cpl_imagelist *imglist)
 All images contained in imglist are printed for debugging purposes.
 
cpl_error_code eris_ifu_debug_image (const cpl_image *img)
 All values contained in img are printed for debugging purposes.
 
cpl_error_code eris_ifu_debug_vector (const cpl_vector *vec)
 All values contained in vec are printed for debugging purposes.
 
cpl_error_code eris_ifu_debug_array (const cpl_array *arr)
 All values contained in arr are printed for debugging purposes.
 
cpl_error_code eris_ifu_debug_table (const cpl_table *table)
 All values contained in table are printed for debugging purposes.
 
cpl_error_code eris_ifu_plot_vector (const char *pre, const char *opt, const cpl_vector *vector)
 Plots a vector only if message level is CPL_MSG_DEBUG.
 
cpl_error_code eris_ifu_plot_vectors_xy (const char *pre, const char *opt, const cpl_vector *x, const cpl_vector *y)
 Plots vector y against vector x.
 
cpl_error_code eris_ifu_plot_vectors2 (const char *pre, const char **opt, const cpl_vector *x, const cpl_vector *y1, const cpl_vector *y2)
 Plots 2 vectors against vector x.
 
cpl_error_code eris_ifu_plot_image (const char *pre, const char *opt, const cpl_image *img)
 Plots an image only if message level is CPL_MSG_DEBUG.
 

Detailed Description

Function Documentation

◆ eris_ifu_debug_array()

cpl_error_code eris_ifu_debug_array ( const cpl_array *  arr)

All values contained in arr are printed for debugging purposes.

Parameters
arrThe array to print.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function:

  • CPL_ERROR_NULL_INPUT if arr is NULL.

Definition at line 530 of file eris_ifu_debug.c.

References CATCH, CATCH_MSG, CHECK_ERROR_STATE, and TRY.

◆ eris_ifu_debug_cube()

cpl_error_code eris_ifu_debug_cube ( const cpl_imagelist *  imglist)

All images contained in imglist are printed for debugging purposes.

Parameters
imglistThe imagelist to print.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function:

  • CPL_ERROR_NULL_INPUT if imglist is NULL.

Definition at line 388 of file eris_ifu_debug.c.

References BRK_IF_ERROR, CATCH, CATCH_MSG, CHECK_ERROR_STATE, eris_ifu_debug_image(), and TRY.

◆ eris_ifu_debug_frame()

cpl_error_code eris_ifu_debug_frame ( const cpl_frame *  frame)

The CPL_FRAME_TYPE, CPL_FRAME_LEVEL and CPL_FRAME_GROUP of frame are printed for debugging purposes.

Parameters
frameThe frame to print.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function:

  • CPL_ERROR_NULL_INPUT if frame is NULL.

Definition at line 275 of file eris_ifu_debug.c.

References CATCH, CATCH_MSG, CHECK_ERROR_STATE, GET_NEW_ERROR, RECOVER, and TRY.

Referenced by eris_ifu_debug_frameset().

◆ eris_ifu_debug_frameset()

cpl_error_code eris_ifu_debug_frameset ( const cpl_frameset *  frameset)

All frames contained in frameset are printed for debugging purposes.

Parameters
framesetThe frameset to print.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function:

  • CPL_ERROR_NULL_INPUT if frameset is NULL.

Definition at line 104 of file eris_ifu_debug.c.

References BRK_IF_NULL, CATCH, CATCH_MSG, CHECK_ERROR_STATE, eris_ifu_debug_frame(), GET_NEW_ERROR, RECOVER, and TRY.

◆ eris_ifu_debug_header()

cpl_error_code eris_ifu_debug_header ( const cpl_propertylist *  header)

All properties contained in header are printed as pairs of keyword and data for debugging purposes.

Parameters
headerThe propertylist to print.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function:

  • CPL_ERROR_NULL_INPUT if header is NULL.

Definition at line 33 of file eris_ifu_debug.c.

References BRK_IF_NULL, CATCH, CATCH_MSG, CHECK_ERROR_STATE, and TRY.

◆ eris_ifu_debug_image()

cpl_error_code eris_ifu_debug_image ( const cpl_image *  img)

All values contained in img are printed for debugging purposes.

Parameters
imgThe image to print.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function:

  • CPL_ERROR_NULL_INPUT if img is NULL.

Definition at line 430 of file eris_ifu_debug.c.

References CATCH, CATCH_MSG, CHECK_ERROR_STATE, and TRY.

Referenced by eris_ifu_debug_cube().

◆ eris_ifu_debug_parameterlist()

cpl_error_code eris_ifu_debug_parameterlist ( const cpl_parameterlist *  plist)

All parameters contained in plist are printed for debugging purposes.

Parameters
plistThe parameterlist to print.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function:

  • CPL_ERROR_NULL_INPUT if plist is NULL.

Definition at line 157 of file eris_ifu_debug.c.

References BRK_WITH_ERROR, CATCH, CATCH_MSG, CHECK_ERROR_STATE, and TRY.

◆ eris_ifu_debug_propertylist()

cpl_error_code eris_ifu_debug_propertylist ( const cpl_propertylist *  plist)

All properties contained in plist are printed for debugging purposes.

Parameters
plistThe propertylist to print.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function:

  • CPL_ERROR_NULL_INPUT if plist is NULL.

Definition at line 234 of file eris_ifu_debug.c.

References CATCH, CATCH_MSG, CHECK_ERROR_STATE, and TRY.

◆ eris_ifu_debug_table()

cpl_error_code eris_ifu_debug_table ( const cpl_table *  table)

All values contained in table are printed for debugging purposes.

Parameters
tableThe table to print.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function:

  • CPL_ERROR_NULL_INPUT if table is NULL.

Definition at line 604 of file eris_ifu_debug.c.

References CATCH, CATCH_MSG, CHECK_ERROR_STATE, and TRY.

◆ eris_ifu_debug_vector()

cpl_error_code eris_ifu_debug_vector ( const cpl_vector *  vec)

All values contained in vec are printed for debugging purposes.

Parameters
vecThe vector to print.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function:

  • CPL_ERROR_NULL_INPUT if vec is NULL.

Definition at line 482 of file eris_ifu_debug.c.

References BRK_IF_NULL, CATCH, CATCH_MSG, CHECK_ERROR_STATE, and TRY.

◆ eris_ifu_plot_image()

cpl_error_code eris_ifu_plot_image ( const char *  pre,
const char *  opt,
const cpl_image *  img 
)

Plots an image only if message level is CPL_MSG_DEBUG.

Parameters
preAn optional string with pre-plot commands
optAn optional string with plotting options
imgThe image to plot.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function: Any possibly set error from cpl_plot_image()

Definition at line 845 of file eris_ifu_debug.c.

References BRK_IF_ERROR, CATCH, CATCH_MSG, and TRY.

◆ eris_ifu_plot_vector()

cpl_error_code eris_ifu_plot_vector ( const char *  pre,
const char *  opt,
const cpl_vector *  vector 
)

Plots a vector only if message level is CPL_MSG_DEBUG.

Parameters
preAn optional string with pre-plot commands
optAn optional string with plotting options
vectorThe vector to plot.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function: Any possibly set error from cpl_plot_vector()

Definition at line 643 of file eris_ifu_debug.c.

References BRK_IF_ERROR, CATCH, CATCH_MSG, and TRY.

◆ eris_ifu_plot_vectors2()

cpl_error_code eris_ifu_plot_vectors2 ( const char *  pre,
const char **  opt,
const cpl_vector *  x,
const cpl_vector *  y1,
const cpl_vector *  y2 
)

Plots 2 vectors against vector x.

Parameters
preAn optional string with pre-plot commands
optAn optional string with plotting options
xThe vector to plot.
y1The 1st vector to plot.
y2The 2nd vector to plot.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function: Any possibly set error from cpl_plot_vector()

Definition at line 763 of file eris_ifu_debug.c.

References BRK_IF_ERROR, BRK_IF_NULL, CATCH, CATCH_MSG, CHECK_ERROR_STATE, and TRY.

◆ eris_ifu_plot_vectors_xy()

cpl_error_code eris_ifu_plot_vectors_xy ( const char *  pre,
const char *  opt,
const cpl_vector *  x,
const cpl_vector *  y 
)

Plots vector y against vector x.

Parameters
preAn optional string with pre-plot commands
optAn optional string with plotting options
xThe vector to plot.
yThe vector to plot.
Returns
The function returns CPL_ERROR_NONE on success or a CPL error code otherwise.

Possible cpl_error_code set in this function: Any possibly set error from cpl_plot_vector()

Definition at line 694 of file eris_ifu_debug.c.

References BRK_IF_ERROR, BRK_IF_NULL, CATCH, CATCH_MSG, and TRY.