integer coordinate More...

#include <points.h>

Inheritance diagram for tesseract::ICOORD:

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

	ICOORD (TDimension xin, TDimension yin)

	~ICOORD ()=default
	destructor More...

bool	DeSerialize (TFile *f)

bool	Serialize (TFile *f) const

TDimension	x () const
	access function More...

TDimension	y () const
	access_function More...

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

void	set_y (TDimension 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
TDimension	xcoord
	x value More...

TDimension	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 &, TDimension)
	multiply More...

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

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

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

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

Detailed Description

integer coordinate

Definition at line 36 of file points.h.

Constructor & Destructor Documentation

◆ ICOORD() [1/2]

tesseract::ICOORD::ICOORD ( )

inline

empty constructor

Definition at line 41 of file points.h.

           {
    xcoord = ycoord = 0; // default zero
  }

◆ ICOORD() [2/2]

tesseract::ICOORD::ICOORD	(	TDimension	xin,
		TDimension	yin
	)

inline

constructor

Parameters

xin	x value
yin	y value

Definition at line 47 of file points.h.

                                         {
    xcoord = xin;
    ycoord = yin;
  }

◆ ~ICOORD()

tesseract::ICOORD::~ICOORD ( )

default

destructor

Member Function Documentation

◆ angle()

float tesseract::ICOORD::angle ( ) const

inline

find angle

Definition at line 103 of file points.h.

                      {
    return (float)std::atan2(ycoord, xcoord);
  }

◆ DeSerialize() [1/2]

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

Definition at line 79 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;
}

◆ DeSerialize() [2/2]

bool tesseract::ICOORD::DeSerialize ( TFile * f )

Definition at line 43 of file points.cpp.

                                 {
  return f->DeSerialize(&xcoord) && f->DeSerialize(&ycoord);
}

◆ length()

float tesseract::ICOORD::length ( ) const

inline

find length

Definition at line 84 of file points.h.

                       {
    return std::sqrt(sqlength());
  }

◆ operator!=()

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

inline

test inequality

Definition at line 112 of file points.h.

                                             {
    return xcoord != other.xcoord || ycoord != other.ycoord;
  }

◆ operator==()

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

inline

test equality

Definition at line 108 of file points.h.

                                             {
    return xcoord == other.xcoord && ycoord == other.ycoord;
  }

◆ pt_to_pt_dist()

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

inline

Distance between pts.

Definition at line 98 of file points.h.

                                              {
    return std::sqrt(pt_to_pt_sqdist(pt));
  }

◆ pt_to_pt_sqdist()

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

inline

sq dist between pts

Definition at line 89 of file points.h.

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

◆ rotate()

void tesseract::ICOORD::rotate ( const FCOORD & vec )

inline

rotate

Parameters

vec by vector

Definition at line 511 of file points.h.

                       {
  auto tmp = static_cast<TDimension>(std::floor(xcoord * vec.x() - ycoord * vec.y() + 0.5f));
  ycoord = static_cast<TDimension>(std::floor(ycoord * vec.x() + xcoord * vec.y() + 0.5f));
  xcoord = tmp;
}

◆ Serialize() [1/2]

bool tesseract::ICOORD::Serialize ( FILE * fp ) const

Definition at line 74 of file points.cpp.

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

◆ Serialize() [2/2]

bool tesseract::ICOORD::Serialize ( TFile * f ) const

Definition at line 47 of file points.cpp.

                                     {
  return f->Serialize(&xcoord) && f->Serialize(&ycoord);
}

◆ set_with_shrink()

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

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

Definition at line 52 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 tesseract::ICOORD::set_x ( TDimension xin )

inline

rewrite function

Definition at line 67 of file points.h.

                             {
    xcoord = xin; // write new value
  }

◆ set_y()

void tesseract::ICOORD::set_y ( TDimension yin )

inline

rewrite function

Definition at line 71 of file points.h.

                             { // value to set
    ycoord = yin;
  }

◆ setup_render()

void tesseract::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 99 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 tesseract::ICOORD::sqlength ( ) const

inline

find sq length

Definition at line 79 of file points.h.

                         {
    return (float)(xcoord * xcoord + ycoord * ycoord);
  }

◆ x()

TDimension tesseract::ICOORD::x ( ) const

inline

access function

Definition at line 58 of file points.h.

                       {
    return xcoord;
  }

◆ y()

TDimension tesseract::ICOORD::y ( ) const

inline

access_function

Definition at line 62 of file points.h.

                       {
    return ycoord;
  }

Friends And Related Function Documentation

◆ FCOORD

friend class FCOORD

friend

Definition at line 37 of file points.h.

◆ operator!

ICOORD operator! ( const ICOORD & src )

friend

rotate 90 deg anti

Definition at line 324 of file points.h.

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

◆ operator%

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

friend

scalar product

Definition at line 416 of file points.h.

                       {
  return op1.xcoord * op2.xcoord + op1.ycoord * op2.ycoord;
}

◆ operator* [1/3]

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

friend

cross product

Definition at line 428 of file points.h.

                       {
  return op1.xcoord * op2.ycoord - op1.ycoord * op2.xcoord;
}

◆ operator* [2/3]

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

friend

multiply

Definition at line 440 of file points.h.

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

◆ operator* [3/3]

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

friend

multiply

Definition at line 450 of file points.h.

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

◆ operator*=

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

friend

multiply

Definition at line 467 of file points.h.

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

◆ operator+

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

friend

add

Definition at line 356 of file points.h.

                       {
  ICOORD sum; // result
 
  sum.xcoord = op1.xcoord + op2.xcoord;
  sum.ycoord = op1.ycoord + op2.ycoord;
  return sum;
}

◆ operator+=

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

friend

add

Definition at line 372 of file points.h.

                       {
  op1.xcoord += op2.xcoord;
  op1.ycoord += op2.ycoord;
  return op1;
}

◆ operator- [1/2]

ICOORD operator- ( const ICOORD & src )

friend

unary minus

Definition at line 340 of file points.h.

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

◆ operator- [2/2]

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

friend

subtract

Definition at line 386 of file points.h.

                       {
  ICOORD sum; // result
 
  sum.xcoord = op1.xcoord - op2.xcoord;
  sum.ycoord = op1.ycoord - op2.ycoord;
  return sum;
}

◆ operator-=

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

friend

subtract

Definition at line 402 of file points.h.

                       {
  op1.xcoord -= op2.xcoord;
  op1.ycoord -= op2.ycoord;
  return op1;
}

◆ operator/

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

friend

divide

Definition at line 481 of file points.h.

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

◆ operator/=

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

friend

divide

Definition at line 497 of file points.h.

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

Member Data Documentation

◆ xcoord

TDimension tesseract::ICOORD::xcoord

protected

x value

Definition at line 159 of file points.h.

◆ ycoord

TDimension tesseract::ICOORD::ycoord

protected

y value

Definition at line 160 of file points.h.

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

/media/home/debian/src/github/tesseract-ocr/tesseract/src/ccstruct/points.h
/media/home/debian/src/github/tesseract-ocr/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() [1/2]

◆ DeSerialize() [2/2]

◆ length()

◆ operator!=()

◆ operator==()

◆ pt_to_pt_dist()

◆ pt_to_pt_sqdist()

◆ rotate()

◆ Serialize() [1/2]

◆ Serialize() [2/2]

◆ 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