ARTS 2.5.11 (git: 725533f0)
|
OEM log output. More...
#include <oem.h>
Public Member Functions | |
ArtsLog (unsigned int v, ::Vector &g, bool l=false) | |
Create log. | |
~ArtsLog () | |
Finalizes log output if necessary. | |
template<typename... Params> | |
void | init (Params &... params) |
Initialize log output. | |
template<typename... Params> | |
void | step (const Params &... params) |
Print step to command line. | |
template<typename... Params> | |
void | finalize (const Params &... params) |
Finalize log output. | |
template<typename... Params> | |
void | time (const Params &... params) |
Print timing information to command line. | |
Private Attributes | |
int | verbosity_ |
Verbosity level of logger. | |
Vector | gamma_history_ |
Reference to ARTS vector holding the LM gamma history. | |
Numeric | scaling_factor_ = 0.0 |
Scaling factor for the cost. | |
Numeric | start_cost_ = 0.0 |
Start cost (not computed by invlib) | |
bool | linear_ = false |
Flag indicating whether forward model is linear. | |
bool | finalized_ = false |
Flag indicating whether output has been finalized. | |
OEM log output.
This class takes care of formatting the OEM iteration information and displaying in the command line.
The | invlib log type defining which type of logging to perform. |
|
inline |
|
inline |
Finalizes log output if necessary.
Definition at line 256 of file oem.h.
References oem::ArtsLog< type >::finalized_, and oem::ArtsLog< type >::verbosity_.
|
inline |
Finalize log output.
This function is called from within invlib to finalize the log output.
Definition at line 350 of file oem.h.
References oem::ArtsLog< type >::finalized_, oem::ArtsLog< type >::linear_, oem::ArtsLog< type >::scaling_factor_, and oem::ArtsLog< type >::verbosity_.
|
inline |
Initialize log output.
This function is called from within invlib to initialize the log output. Prints general information on the OEM settings.
Definition at line 272 of file oem.h.
References oem::ArtsLog< type >::scaling_factor_, and oem::ArtsLog< type >::verbosity_.
|
inline |
Print step to command line.
This function is called from invlib to log a new step to the command line.
Definition at line 318 of file oem.h.
References oem::ArtsLog< type >::gamma_history_, oem::ArtsLog< type >::start_cost_, and oem::ArtsLog< type >::verbosity_.
|
inline |
Print timing information to command line.
Definition at line 377 of file oem.h.
References oem::ArtsLog< type >::verbosity_.
|
private |
Flag indicating whether output has been finalized.
Definition at line 406 of file oem.h.
Referenced by oem::ArtsLog< type >::finalize(), and oem::ArtsLog< type >::~ArtsLog().
|
private |
Reference to ARTS vector holding the LM gamma history.
Definition at line 398 of file oem.h.
Referenced by oem::ArtsLog< type >::step().
|
private |
Flag indicating whether forward model is linear.
Definition at line 404 of file oem.h.
Referenced by oem::ArtsLog< type >::finalize().
|
private |
Scaling factor for the cost.
Definition at line 400 of file oem.h.
Referenced by oem::ArtsLog< type >::finalize(), and oem::ArtsLog< type >::init().
|
private |
Start cost (not computed by invlib)
Definition at line 402 of file oem.h.
Referenced by oem::ArtsLog< type >::step().
|
private |
Verbosity level of logger.
Definition at line 396 of file oem.h.
Referenced by oem::ArtsLog< type >::finalize(), oem::ArtsLog< type >::init(), oem::ArtsLog< type >::step(), oem::ArtsLog< type >::time(), and oem::ArtsLog< type >::~ArtsLog().