integer coordinate More...

#include <points.h>

Inheritance diagram for ICOORD:

Public Member Functions
	ICOORD ()
	empty constructor More...

	ICOORD (int16_t xin, int16_t yin)

	~ICOORD ()=default
	destructor More...

int16_t	x () const
	access function More...

int16_t	y () const
	access_function More...

void	set_x (int16_t xin)
	rewrite function More...

void	set_y (int16_t yin)
	rewrite function More...

void	set_with_shrink (int x, int y)
	Set from the given x,y, shrinking the vector to fit if needed. More...

float	sqlength () const
	find sq length More...

float	length () const
	find length More...

float	pt_to_pt_sqdist (const ICOORD &pt) const
	sq dist between pts More...

float	pt_to_pt_dist (const ICOORD &pt) const
	Distance between pts. More...

float	angle () const
	find angle More...

bool	operator== (const ICOORD &other) const
	test equality More...

bool	operator!= (const ICOORD &other) const
	test inequality More...

void	rotate (const FCOORD &vec)

void	setup_render (ICOORD major_step, ICOORD minor_step, int major, int minor) const

bool	Serialize (FILE *fp) const

bool	DeSerialize (bool swap, FILE *fp)

Protected Attributes
int16_t	xcoord
	x value More...

int16_t	ycoord
	y value More...

Friends
class	FCOORD

ICOORD	operator! (const ICOORD &)
	rotate 90 deg anti More...

ICOORD	operator- (const ICOORD &)
	unary minus More...

ICOORD	operator+ (const ICOORD &, const ICOORD &)
	add More...

ICOORD &	operator+= (ICOORD &, const ICOORD &)
	add More...

ICOORD	operator- (const ICOORD &, const ICOORD &)
	subtract More...

ICOORD &	operator-= (ICOORD &, const ICOORD &)
	subtract More...

int32_t	operator% (const ICOORD &, const ICOORD &)
	scalar product More...

int32_t	operator* (const ICOORD &, const ICOORD &)
	cross product More...

ICOORD	operator* (const ICOORD &, int16_t)
	multiply More...

ICOORD	operator* (int16_t, const ICOORD &)
	multiply More...

ICOORD &	operator*= (ICOORD &, int16_t)
	multiply More...

ICOORD	operator/ (const ICOORD &, int16_t)
	divide More...

ICOORD &	operator/= (ICOORD &, int16_t)
	divide More...

Detailed Description

integer coordinate

Definition at line 30 of file points.h.

Constructor & Destructor Documentation

◆ ICOORD() [1/2]

ICOORD::ICOORD ( )

inline

empty constructor

Definition at line 36 of file points.h.

37 {

38 xcoord = ycoord = 0; //default zero

◆ ICOORD() [2/2]

ICOORD::ICOORD	(	int16_t	xin,
		int16_t	yin
	)

inline

constructor

Parameters

xin	x value
yin	y value

Definition at line 42 of file points.h.

                         {
       xcoord = xin;
       ycoord = yin;

◆ ~ICOORD()

ICOORD::~ICOORD ( )

default

destructor

Member Function Documentation

◆ angle()

float ICOORD::angle ( ) const

inline

find angle

Definition at line 96 of file points.h.

97 {

98 return std::atan2(ycoord, xcoord);

◆ DeSerialize()

bool ICOORD::DeSerialize	(	bool	swap,
		FILE *	fp
	)

Definition at line 66 of file points.cpp.

                                             {
   if (!tesseract::DeSerialize(fp, &xcoord)) return false;
   if (!tesseract::DeSerialize(fp, &ycoord)) return false;
   if (swap) {
     ReverseN(&xcoord, sizeof(xcoord));
     ReverseN(&ycoord, sizeof(ycoord));
   }
   return true;

◆ length()

float ICOORD::length ( ) const

inline

find length

Definition at line 77 of file points.h.

78 {

79 return std::sqrt(sqlength());

◆ operator!=()

bool ICOORD::operator!= ( const ICOORD & other ) const

inline

test inequality

Definition at line 105 of file points.h.

106 {

107 return xcoord != other.xcoord || ycoord != other.ycoord;

◆ operator==()

bool ICOORD::operator== ( const ICOORD & other ) const

inline

test equality

Definition at line 101 of file points.h.

102 {

103 return xcoord == other.xcoord && ycoord == other.ycoord;

◆ pt_to_pt_dist()

float ICOORD::pt_to_pt_dist ( const ICOORD & pt ) const

inline

Distance between pts.

Definition at line 91 of file points.h.

92 {

93 return std::sqrt(pt_to_pt_sqdist(pt));

◆ pt_to_pt_sqdist()

float ICOORD::pt_to_pt_sqdist ( const ICOORD & pt ) const

inline

sq dist between pts

Definition at line 82 of file points.h.

                                                   {
       ICOORD gap;
  
       gap.xcoord = xcoord - pt.xcoord;
       gap.ycoord = ycoord - pt.ycoord;
       return gap.sqlength ();

◆ rotate()

void ICOORD::rotate ( const FCOORD & vec )

inline

rotate

Parameters

vec by vector

Definition at line 522 of file points.h.

                {
   op1.xcoord /= scale;
   op1.ycoord /= scale;
   return op1;
 }
  
  

◆ Serialize()

bool ICOORD::Serialize ( FILE * fp ) const

Definition at line 60 of file points.cpp.

                                      {
   return tesseract::Serialize(fp, &xcoord) &&
          tesseract::Serialize(fp, &ycoord);

◆ set_with_shrink()

void ICOORD::set_with_shrink	(	int	x,
		int	y
	)

Set from the given x,y, shrinking the vector to fit if needed.

Definition at line 40 of file points.cpp.

                                          {
   // Fit the vector into an ICOORD, which is 16 bit.
   int factor = 1;
   int max_extent = std::max(abs(x), abs(y));
   if (max_extent > INT16_MAX)
     factor = max_extent / INT16_MAX + 1;
   xcoord = x / factor;
   ycoord = y / factor;

◆ set_x()

void ICOORD::set_x ( int16_t xin )

inline

rewrite function

Definition at line 60 of file points.h.

61 {

62 xcoord = xin; //write new value

◆ set_y()

void ICOORD::set_y ( int16_t yin )

inline

rewrite function

Definition at line 64 of file points.h.

65 { //value to set

66 ycoord = yin;

◆ setup_render()

void ICOORD::setup_render	(	ICOORD *	major_step,
		ICOORD *	minor_step,
		int *	major,
		int *	minor
	)		const

Setup for iterating over the pixels in a vector by the well-known Bresenham rendering algorithm. Starting with major/2 in the accumulator, on each step move by major_step, and then add minor to the accumulator. When accumulator >= major subtract major and also move by minor_step.

Definition at line 82 of file points.cpp.

                                                         {
   int abs_x = abs(xcoord);
   int abs_y = abs(ycoord);
   if (abs_x >= abs_y) {
     // X-direction is major.
     major_step->xcoord = sign(xcoord);
     major_step->ycoord = 0;
     minor_step->xcoord = 0;
     minor_step->ycoord = sign(ycoord);
     *major = abs_x;
     *minor = abs_y;
   } else {
     // Y-direction is major.
     major_step->xcoord = 0;
     major_step->ycoord = sign(ycoord);
     minor_step->xcoord = sign(xcoord);
     minor_step->ycoord = 0;
     *major = abs_y;
     *minor = abs_x;
   }

◆ sqlength()

float ICOORD::sqlength ( ) const

inline

find sq length

Definition at line 72 of file points.h.

73 {

74 return xcoord * xcoord + ycoord * ycoord;

◆ x()

int16_t ICOORD::x ( ) const

inline

access function

Definition at line 51 of file points.h.

52 {

53 return xcoord;

◆ y()

int16_t ICOORD::y ( ) const

inline

access_function

Definition at line 55 of file points.h.

56 {

57 return ycoord;

Friends And Related Function Documentation

◆ FCOORD

friend class FCOORD

friend

Definition at line 32 of file points.h.

◆ operator!

ICOORD operator! ( const ICOORD & src )

friend

rotate 90 deg anti

Definition at line 325 of file points.h.

   {
   ICOORD result;                 //output
  
   result.xcoord = -src.ycoord;
   result.ycoord = src.xcoord;

◆ operator%

int32_t operator%	(	const ICOORD &	op1,
		const ICOORD &	op2
	)

friend

scalar product

Definition at line 423 of file points.h.

433 {

◆ operator* [1/3]

int32_t operator*	(	const ICOORD &	op1,
		const ICOORD &	op2
	)

friend

cross product

Definition at line 435 of file points.h.

446 {

◆ operator* [2/3]

ICOORD operator*	(	const ICOORD &	op1,
		int16_t	scale
	)

friend

multiply

Definition at line 447 of file points.h.

459 {

◆ operator* [3/3]

ICOORD operator*	(	int16_t	scale,
		const ICOORD &	op1
	)

friend

multiply

Definition at line 458 of file points.h.

                                         {
   ICOORD result;                 //output
  
   result.xcoord = op1.xcoord * scale;
   result.ycoord = op1.ycoord * scale;
   return result;
 }
  
  

◆ operator*=

ICOORD& operator*=	(	ICOORD &	op1,
		int16_t	scale
	)

friend

multiply

Definition at line 476 of file points.h.

489 {

◆ operator+

ICOORD operator+	(	const ICOORD &	op1,
		const ICOORD &	op2
	)

friend

add

Definition at line 359 of file points.h.

                     {
   ICOORD sum;                    //result
  

◆ operator+=

ICOORD& operator+=	(	ICOORD &	op1,
		const ICOORD &	op2
	)

friend

add

Definition at line 376 of file points.h.

383 {

◆ operator- [1/2]

ICOORD operator- ( const ICOORD & src )

friend

unary minus

Definition at line 342 of file points.h.

   {
   ICOORD result;                 //output
  
   result.xcoord = -src.xcoord;

◆ operator- [2/2]

ICOORD operator-	(	const ICOORD &	op1,
		const ICOORD &	op2
	)

friend

subtract

Definition at line 391 of file points.h.

399 {

◆ operator-=

ICOORD& operator-=	(	ICOORD &	op1,
		const ICOORD &	op2
	)

friend

subtract

Definition at line 408 of file points.h.

417 {

◆ operator/

ICOORD operator/	(	const ICOORD &	op1,
		int16_t	scale
	)

friend

divide

Definition at line 491 of file points.h.

505 {

◆ operator/=

ICOORD& operator/=	(	ICOORD &	op1,
		int16_t	scale
	)

friend

divide

Definition at line 508 of file points.h.

523 {

Member Data Documentation

◆ xcoord

int16_t ICOORD::xcoord

protected

x value

Definition at line 156 of file points.h.

◆ ycoord

int16_t ICOORD::ycoord

protected

y value

Definition at line 157 of file points.h.

The documentation for this class was generated from the following files:

/tesseract/src/ccstruct/points.h
/tesseract/src/ccstruct/points.cpp

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ICOORD() [1/2]

◆ ICOORD() [2/2]

◆ ~ICOORD()

Member Function Documentation

◆ angle()

◆ DeSerialize()

◆ length()

◆ operator!=()

◆ operator==()

◆ pt_to_pt_dist()

◆ pt_to_pt_sqdist()

◆ rotate()

◆ Serialize()

◆ set_with_shrink()

◆ set_x()

◆ set_y()

◆ setup_render()

◆ sqlength()

◆ x()

◆ y()

Friends And Related Function Documentation

◆ FCOORD

◆ operator!

◆ operator%

◆ operator* [1/3]

◆ operator* [2/3]

◆ operator* [3/3]

◆ operator*=

◆ operator+

◆ operator+=

◆ operator- [1/2]

◆ operator- [2/2]

◆ operator-=

◆ operator/

◆ operator/=

Member Data Documentation

◆ xcoord

◆ ycoord