$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
scribo::line_info< L > Class Template Reference

Public Types

typedef Object< void > category
typedef line_info< L > exact_t

Public Member Functions

int a_height () const
void accept (const SerializeVisitor< E2 > &visitor) const
int ascent () const
int baseline () const
const mln::box2dbbox () const
float boldness () const
float boldness_reliability () const
unsigned card () const
unsigned char_space () const
unsigned char_width () const
bool chars_same_width () const
const mln::value::rgb8color () const
float color_reliability () const
const mln::util::array
< component_id_t > & 
component_ids () const
int d_height () const
int delta_of_line () const
int descent () const
const mln::box2debbox () const
void force_stats_update ()
unsigned get_first_char_height () const
bool has_text () const
const std::string & html_text () const
line_id_t id () const
bool indented () const
bool is_textline () const
bool is_valid () const
int meanline () const
line_info< L > & operator= (const line_info< L > &other)
float orientation () const
unsigned pixel_area () const
line::ReadingDirection reading_direction () const
float reading_orientation () const
bool reverse_video () const
line::Tag tag () const
const std::string & text () const
float text_confidence () const
line::Type type () const
void update_ebbox ()
void update_tag (line::Tag tag)
void update_text (const std::string &str, float confidence=100.0f)
void update_type (line::Type type)
unsigned word_space () const
unsigned x_height () const
 line_info ()
 line_info (const line_id_t &id, data_t *data)
 line_info (const line_set< L > &holder, const line_id_t &id, const group_info &group)
 line_info (const line_info< L > &other)
bool is_hidden () const
void set_hidden (bool b)
void fast_merge (line_info< L > &other, bool hide=true)
void precise_merge (line_info< L > &other, bool hide=true)

Detailed Description

template<typename L>
class scribo::line_info< L >

Definition at line 160 of file line_info.hh.

Constructor & Destructor Documentation

template<typename L>
scribo::line_info< L >::line_info ( )

Constructors.

template<typename L>
scribo::line_info< L >::line_info ( const line_id_t id,
data_t data 
)

Constructors.

template<typename L>
scribo::line_info< L >::line_info ( const line_set< L > &  holder,
const line_id_t id,
const group_info group 
)

Constructors.

template<typename L>
scribo::line_info< L >::line_info ( const line_info< L > &  other)

The line id of the target instance is preserved if it is valid.

Member Function Documentation

void scribo::Serializable< line_info< L > >::accept ( const SerializeVisitor< E2 > &  visitor) const
inherited

Allow this object to be serialized by visitor.

template<typename L>
int scribo::line_info< L >::delta_of_line ( ) const

Returns the delta used to compute the extended bbox.

template<typename L>
const mln::box2d& scribo::line_info< L >::ebbox ( ) const

Extended bounding box.

The width is extended with char_width() + char_space() on each side. The height is adjusted to max(a_height, - d_height) on each side.

template<typename L>
void scribo::line_info< L >::fast_merge ( line_info< L > &  other,
bool  hide = true 
)

Merge related routines.

This merge only updates the component list and the bounding box.

After this merge, the line is tagged with line::Needs_Precise_Stats_Update.

The other line is tagged with line::Merged and if hide is set to 'True', it is set as hidden as well.

template<typename L>
void scribo::line_info< L >::force_stats_update ( )

Force a new computation of statistics.

template<typename L>
line_id_t scribo::line_info< L >::id ( ) const

If the line info is valid, the line id never changes for a given instance.

template<typename L>
bool scribo::line_info< L >::is_hidden ( ) const

Hidden status.

When a line is hidden, it should not be used in routines computing data over lines.

template<typename L>
line_info<L>& scribo::line_info< L >::operator= ( const line_info< L > &  other)

The line id of the target instance is preserved if it is valid.

template<typename L>
void scribo::line_info< L >::precise_merge ( line_info< L > &  other,
bool  hide = true 
)

This merge updates the component list and recompute from scratch statistics, bounding box and other line attributes.

After this merge, the line is tagged with line::None.

template<typename L>
void scribo::line_info< L >::set_hidden ( bool  b)

Hidden status.

When a line is hidden, it should not be used in routines computing data over lines.

template<typename L>
void scribo::line_info< L >::update_ebbox ( )

Update the extended bbox.