$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
scribo::debug Namespace Reference

Classes

struct  arg_data
struct  opt_data
class  option_parser
struct  toggle_data

Enumerations

enum  Level {
  None = 0, Special, Results, AuxiliaryResults,
  All, InvalidLevel
}
enum  VerboseMode {
  Mute = 0, UserDebug, Time, Low,
  Medium, Full, Invalid
}

Functions

template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
alignment_decision_image (const Image< I > &input, const object_links< L > &links, const object_links< L > &filtered_links, const anchor::Type &anchor)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
bboxes_enlarged_image (const Image< I > &input, const line_set< L > &lines, const value::rgb8 &text_value, const value::rgb8 &non_text_value)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
bboxes_enlarged_image (const Image< I > &input, const line_set< L > &lines)
template<typename I >
mln::trait::ch_value< I,
value::rgb8 >::ret 
bboxes_image (const Image< I > &input, const mln::util::array< box< typename I::site > > &bboxes, const value::rgb8 &value)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
bboxes_image (const Image< I > &input, const line_set< L > &lines, const value::rgb8 &value)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
bboxes_image (const Image< I > &input, const line_set< L > &lines)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
bboxes_image (const Image< I > &input, const component_set< L > &comps, const value::rgb8 &value)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
char_space_image (const Image< I > &input, const line_set< L > &line, const value::rgb8 &v=literal::cyan)
bool check_ocr_lang (const std::vector< const char * > &args)
bool check_sauvola_first_subsampling (const std::vector< const char * > &args)
bool check_sauvola_split_ntrue (const std::vector< const char * > &args)
bool check_verbose_mode (const std::vector< const char * > &args)
bool check_xml_format (const std::vector< const char * > &args)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
decision_image (const Image< I > &input, const object_groups< L > &groups, const object_groups< L > &filtered_groups, anchor::Type anchor)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
decision_image (const Image< I > &input, const object_links< L > &links, const object_links< L > &filtered_links, anchor::Type anchor)
template<typename I >
mln::trait::ch_value< I,
value::rgb8 >::ret 
highlight_text_area (const Image< I > &input, const mln::util::array< box< typename I::site > > &bbox)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
highlight_text_area (const Image< I > &input, const line_set< L > &lines)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
highlight_text_area (const Image< I > &input, const scribo::component_set< L > &components)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
line_info_image (const Image< I > &input, const line_set< L > &line)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
linked_bboxes_image (const Image< I > &input, const object_links< L > &array, const value::rgb8 &box_value, const value::rgb8 &link_value, anchor::Type anchor)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
linked_bboxes_image (const Image< I > &input, const object_links< L > &array, const value::rgb8 &box_value, const value::rgb8 &link_value)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
linked_bboxes_image (const Image< I > &input, const object_links< L > &left_link, const object_links< L > &right_link, const value::rgb8 &box_value, const value::rgb8 &link_value, anchor::Type anchor)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
linked_bboxes_image (const Image< I > &input, const object_links< L > &left_link, const object_links< L > &right_link, const value::rgb8 &box_value, const value::rgb8 &left_link_value, const value::rgb8 &right_link_value, const value::rgb8 &validated_link_value, anchor::Type anchor)
template<typename I , typename L , typename G >
mln::trait::ch_value< I,
value::rgb8 >::ret 
linked_bboxes_image (const Image< I > &input, const Graph< G > &g, const value::rgb8 &box_value, const value::rgb8 &link_value, anchor::Type anchor)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
links_decision_image (const Image< I > &input_, const object_links< L > &links, const object_links< L > &filtered_links)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
links_image (const Image< I > &input_, const object_links< L > &links, anchor::Type anchor, bool draw_bboxes=true)
scribo::debug::internal::logger_logger ()
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
looks_like_a_text_line_image (const Image< I > &input, const line_set< L > &lines, const value::rgb8 &text_value, const value::rgb8 &non_text_value)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
looks_like_a_text_line_image (const Image< I > &input, const line_set< L > &lines)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
mean_and_base_lines_image (const Image< I > &input, const line_set< L > &lines, const value::rgb8 &bbox_value, const value::rgb8 &meanline_value, const value::rgb8 &baseline_value)
template<typename I , typename L >
mln::trait::ch_value< I,
value::rgb8 >::ret 
mean_and_base_lines_image (const Image< I > &input, const line_set< L > &lines)
template<typename L , typename L2 >
void save_comp_diff (const component_set< L > &comps_ref, const component_set< L2 > &comps_new, const std::string &filename)
template<typename I >
void save_label_image (const Image< I > &lbl, const typename I::value &nlabels, const char *filename)
template<typename I >
void save_table_image (const Image< I > &input_, mln::util::couple< mln::util::array< box< typename I::site > >, mln::util::array< box< typename I::site > > > tableboxes, const value::rgb8 &bbox_color, const std::string &filename)
template<typename S >
void save_table_image (const Site_Set< S > &input_domain, mln::util::couple< mln::util::array< box< typename S::site > >, mln::util::array< box< typename S::site > > > tableboxes, const value::rgb8 &bg_color, const value::rgb8 &bbox_color, const std::string &filename)
template<typename I , typename L >
mln::trait::concrete< I >::ret text_areas_image (const Image< I > &input_rgb, const scribo::component_set< L > &comps)
template<typename L >
image2d< value::rgb8text_color_image (const document< L > &doc)
VerboseMode txt_to_verbose_mode (const std::string &name)
int usage (char *argv[], const char *desc, const char *args, const char *args_desc[][2])

Detailed Description

Namespace of debug routines.

Enumeration Type Documentation

Enum defining different level of image logging.

According to the debug level set in scribo::debug::logger_ the image may be saved or not.

Definition at line 57 of file logger.hh.

Enum defining different modes of text logging.

According to the verbose mode set in scribo::debug::logger_ the text may be logged or not.

Definition at line 72 of file logger.hh.

Function Documentation

VerboseMode scribo::debug::txt_to_verbose_mode ( const std::string &  name)

returns the corresponding verboseMode from its name.

int scribo::debug::usage ( char *  argv[],
const char *  desc,
const char *  args,
const char *  args_desc[][2] 
)

Format a standard usage output.

Parameters
[in]argvArguments passed to the program.
[in]descDescription of the program.
[in]argsThe expected arguments.
[in]args_descThe description of the expected arguments.
Returns
Return 1.