UVES Pipeline Reference Manual  5.4.0
Macros | Functions
Messaging

Macros

#define uves_msg_error(...)   cpl_msg_error(__func__, __VA_ARGS__)
 Print an error message.
#define uves_msg_progress(i, iter,...)   cpl_msg_progress(__func__, (i), (iter), __VA_ARGS__)
 Print a progress message.
#define uves_msg_warning(...)   uves_msg_warning_macro(__func__, __VA_ARGS__)
 Print an warning message.
#define uves_msg_debug(...)   cpl_msg_debug(__func__, __VA_ARGS__)
 Print a debug message.
#define uves_msg_low(...)
 Print a message on a lower message level.
#define uves_msg(...)   uves_msg_macro(__func__, __VA_ARGS__)
 Print a message on 'info' or 'debug' level.
#define uves_msg_softer()   uves_msg_softer_macro(__func__)
 Decrease message volume.
#define uves_msg_louder()   uves_msg_louder_macro(__func__)
 Increase message volume.

Functions

void uves_msg_init (int olevel, const char *dom)
 Initialize messaging.
void uves_msg_set_level (int olevel)
 Set output level.
void uves_msg_softer_macro (const char *fct)
 Decrease message volume.
void uves_msg_louder_macro (const char *fct)
 Increase message volume.
void uves_msg_macro (const char *fct, const char *format,...)
 Print a message on 'info' or 'debug' level.
int uves_msg_get_warnings (void)
 Get number of warnings printed so far.
void uves_msg_add_warnings (int n)
 Accumulate warnings.
void uves_msg_warning_macro (const char *fct, const char *format,...)
 Print a warning message.
const char * uves_msg_get_domain (void)
 Get current message domain.
void uves_msg_set_domain (const char *d)
 Set message domain.

Detailed Description

CPL's info message level is expanded to a set of relative message level. The functions uves_msg_louder() and uves_msg_softer() are used to turn up/down the message volume level (instead of setting the verbosity to an absolute level using cpl_msg_info() or cpl_msg_debug()). These two functions should be used consistently, so that the volume level is always the same on function exit as it was on function entry.

These messaging functions never fail, but might print warnings if called inconsistently.


Macro Definition Documentation

#define uves_msg_error (   ...)    cpl_msg_error(__func__, __VA_ARGS__)

Print an error message.

Parameters:
...Message to print

This function is used instead of cpl_msg_error(), and saves the user from typing the calling function name.

Definition at line 64 of file uves_msg.h.

Referenced by flames_midas_fail_macro(), flames_midas_sctput(), flames_utl_unpack(), opt_measure_profile_order(), uves_gen_lowpass(), uves_paf_print_header(), uves_pfits_put_qc(), uves_physmod_regress_echelle(), uves_reduce_mflat_combine(), uves_save_paf(), uves_utl_ima_arith(), uves_utl_physmod(), uves_utl_rcosmic(), and uves_utl_remove_crh_single().

#define uves_msg_progress (   i,
  iter,
  ... 
)    cpl_msg_progress(__func__, (i), (iter), __VA_ARGS__)

Print a progress message.

Parameters:
iSee cpl_msg_progress()
iterSee cpl_msg_progress()
...Message to print

This function is used instead of cpl_msg_progress(), and saves the user from typing the calling function name.

Definition at line 77 of file uves_msg.h.

#define uves_msg_warning (   ...)    uves_msg_warning_macro(__func__, __VA_ARGS__)
#define uves_msg_debug (   ...)    cpl_msg_debug(__func__, __VA_ARGS__)

Print a debug message.

Parameters:
...Message to print

This function is used instead of cpl_msg_debug(), and saves the user from typing the calling function name.

Definition at line 97 of file uves_msg.h.

Referenced by calculate_spacing(), calibrate_global(), compute_lambda(), convert_to_history(), create_descr(), detect_lines(), detect_ripples(), estimate_sn(), estimate_threshold(), extract_ff_rebin_merge(), find_centroid(), fit_order_linear(), flames_midas_error_macro(), flames_midas_fail_macro(), flames_midas_sccfnd(), flames_midas_sccget(), flames_midas_scdfnd(), flames_midas_scdprs(), flames_midas_scdrdr(), flames_midas_scdwri(), flames_midas_scdwrr(), flames_midas_scfcre(), flames_midas_scfinf(), flames_midas_scfopn(), flames_midas_scfput(), flames_midas_sckwrc(), flames_midas_sckwrd(), flames_midas_sckwri(), flames_midas_scsepi(), flames_midas_scspro(), flames_midas_tccini(), flames_midas_tctopn(), frame_close(), get_descr_info(), identify_lines(), interpolate_wave(), load_frame(), load_frame_header(), opt_extract(), opt_get_order_width(), opt_measure_profile(), opt_measure_profile_order(), opt_reject_outlier(), repeat_orderdef(), scdcop(), scdrd(), scdwr(), sckfnd(), subtract_sky_row(), test_gaussian_fitting(), test_load_3dtable(), trace_order(), update_max(), uves_align(), uves_baryvel(), uves_combine_flats(), uves_cosrout(), uves_define_noise(), uves_draw_lines(), uves_extract(), uves_filter_image_average(), uves_hough(), uves_initialize(), uves_locate_orders(), uves_merge_orders(), uves_mflat_at_ypos(), uves_physmod_calmap(), uves_physmod_center_gauss(), uves_physmod_chop_otab(), uves_physmod_create_table(), uves_physmod_msrawxy(), uves_physmod_necregr(), uves_physmod_qc1pmtbl(), uves_physmod_regress_echelle(), uves_polynomial_convert_from_table(), uves_polynomial_regression_1d(), uves_polynomial_regression_2d(), uves_polynomial_regression_2d_autodegree(), uves_print_cpl_frame(), uves_qclog_add_sci(), uves_qclog_init(), uves_rebin(), uves_reduce_scired(), uves_remove_crh_single(), uves_response_efficiency(), uves_wavecal_identify(), uves_wavecal_identify_lines_ppm(), uves_wavecal_search(), and xcenter().

#define uves_msg_low (   ...)
Value:
do { \
uves_msg_softer(); \
uves_msg(__VA_ARGS__); \
uves_msg_louder(); \
} while (false)

Print a message on a lower message level.

Parameters:
...Message to print

Definition at line 105 of file uves_msg.h.

Referenced by extract_ff_rebin_merge(), flames_midas_sctput(), opt_extract_sky(), opt_measure_profile(), subtract_sky_row(), uves_extract(), uves_initialize(), uves_locate_orders(), uves_polynomial_regression_2d_autodegree(), uves_reduce(), uves_reduce_mflat(), and uves_reduce_scired().

#define uves_msg (   ...)    uves_msg_macro(__func__, __VA_ARGS__)

Function Documentation

void uves_msg_init ( int  olevel,
const char *  dom 
)

Initialize messaging.

Parameters:
olevelThe output level
domThe message domain

Only messages at levels 0 (most important) to outlevel are printed as 'info'. Messages at levels above outlevel are printed as 'debug'.

Therefore, set outlevel = 0 to print fewest messages. Increase outlevel to increase verbosity.

To print all messages as 'info' set outlevel to the special value -1 (which substitutes for infinity).

Definition at line 153 of file uves_msg.c.

References uves_msg_set_domain().

void uves_msg_set_level ( int  olevel)

Set output level.

Parameters:
olevelThe output level

See uves_msg_init() .

Definition at line 202 of file uves_msg.c.

Referenced by uves_initialize().

void uves_msg_softer_macro ( const char *  fct)

Decrease message volume.

Parameters:
fctIdentity of calling function

Don't call this function directly, use uves_msg_softer().

Definition at line 216 of file uves_msg.c.

void uves_msg_louder_macro ( const char *  fct)

Increase message volume.

Parameters:
fctIdentity of calling function

Don't call this function directly, use uves_msg_louder().

Definition at line 239 of file uves_msg.c.

References uves_msg_warning.

void uves_msg_macro ( const char *  fct,
const char *  format,
  ... 
)

Print a message on 'info' or 'debug' level.

Parameters:
fctIdentity of calling function
formatA printf()-like format string

Don't call this function directly, use uves_msg().

If the current level (which is often equal to the current depth of the function call-tree) is less than the output level, the message printed on the 'info' level, otherwise it is printed on the 'debug' level.

Definition at line 281 of file uves_msg.c.

int uves_msg_get_warnings ( void  )

Get number of warnings printed so far.

Returns:
Number of warnings since initialization of messaging

Definition at line 309 of file uves_msg.c.

Referenced by uves_end().

void uves_msg_add_warnings ( int  n)

Accumulate warnings.

Parameters:
nNumber of warnings to add

The (internal) number of warnings (returned by uves_msg_get_warnings()) is increased by n, but without actually printing any warnings.

Definition at line 324 of file uves_msg.c.

void uves_msg_warning_macro ( const char *  fct,
const char *  format,
  ... 
)

Print a warning message.

Parameters:
fctIdentity of calling function
formatA printf()-like format string

Don't call this function directly, use uves_msg_warning().

This function is used instead of cpl_msg_warning(), and saves the user from typing the calling function name.

Additionally, record is kept on the total number of warnings printed (see uves_msg_get_warnings()).

This function does not read or write the cpl_error_code

Definition at line 347 of file uves_msg.c.

const char * uves_msg_get_domain ( void  )

Get current message domain.

Returns:
The current message domain set by uves_msg_init() or uves_msg_set_domain().

Definition at line 368 of file uves_msg.c.

void uves_msg_set_domain ( const char *  d)

Set message domain.

Parameters:
dThe new message domain

Definition at line 379 of file uves_msg.c.

Referenced by uves_msg_init().