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

Enumerations

enum  Tag { None = 0, Ignored }
enum  Type {
  Undefined = 0, Character, VerticalLineSeparator, HorizontalLineSeparator,
  WhitespaceSeparator, Noise, Punctuation, Image,
  DropCapital
}

Functions

std::ostream & operator<< (std::ostream &ostr, const Tag &tag)
std::ostream & operator<< (std::ostream &ostr, const Type &type)
Tag str2tag (const std::string &str)
Type str2type (const std::string &str)

Detailed Description

Namespace of classes related to components.

Enumeration Type Documentation

All possible tags that can be used for components.

component::Tag values can be converted to String using operator<<(std::ostream &ostr, const Tag &tag). String values can be converted to component::Tag using str2tag().

See Also
scribo::component_set scribo::component_info
Enumerator:
None 

No tag set.

Ignored 

To be ignored in further processing.

Definition at line 54 of file component.hh.

All possible types of components.

component::Type values can be converted to String using operator<<(std::ostream &ostr, const Type &type). String values can be converted to component::Type using str2type().

See Also
scribo::component_set scribo::component_info str2type()
Enumerator:
Undefined 

No type defined.

Character 

Character.

VerticalLineSeparator 

Vertical line separator.

HorizontalLineSeparator 

Horizontal line separator.

WhitespaceSeparator 

whitespace separator.

Noise 

Noise.

Punctuation 

Punctuation.

Image 

Image.

DropCapital 

Drop capital.

Definition at line 69 of file component.hh.

Function Documentation

std::ostream& scribo::component::operator<< ( std::ostream &  ostr,
const Tag &  tag 
)

Operator allowing scribo::component::Tag to be printed out.

std::ostream& scribo::component::operator<< ( std::ostream &  ostr,
const Type &  type 
)

Operator allowing scribo::component::Type to be printed out.

Tag scribo::component::str2tag ( const std::string &  str)

Convert a std::string to a scribo::component::Tag.

Type scribo::component::str2type ( const std::string &  str)

Convert a std::string to a scribo::component::Type.