Public Member Functions
def	__init__ (self, x0, y0, x1, y1, step_size=1.0)

def	isValid (self)

def	advance (self)

def	getX (self)

def	getY (self)

def	getX0 (self)

def	getY0 (self)

def	getX1 (self)

def	getY1 (self)

def	get_line_length (self)

def	clamp (self, n, min_n, max_n)

Public Attributes
	x0_

	y0_

	x1_

	y1_

	x_

	y_

	step_size_

	valid_

	m_

	b_

Detailed Description

LineIterator.

LineIterator Python3 API for iterating along the points of a given line

Definition at line 27 of file line_iterator.py.

Constructor & Destructor Documentation

◆ init()

def nav2_simple_commander.line_iterator.LineIterator.__init__	(	self,
		x0,
		y0,
		x1,
		y1,
		step_size = `1.0`
	)

Initialize the LineIterator.

Args
----
    x0 (float): Abscissa of the initial point
    y0 (float): Ordinate of the initial point
    x1 (float): Abscissa of the final point
    y1 (float): Ordinate of the final point
    step_size (float): Optional, Increments' resolution, defaults to 1

Raises
------
    TypeError: When one (or more) of the inputs is not a number
    ValueError: When step_size is not a positive number

Definition at line 34 of file line_iterator.py.

References nav2_simple_commander.line_iterator.LineIterator.b_, nav2_simple_commander.line_iterator.LineIterator.m_, nav2_simple_commander.line_iterator.LineIterator.step_size_, nav2_simple_commander.line_iterator.LineIterator.valid_, nav2_costmap_2d::Costmap2DPublisher.x0_, dwb_critics::LineIterator.x0_, nav2_simple_commander.line_iterator.LineIterator.x0_, nav2_util::LineIterator.x0_, dwb_critics::LineIterator.x1_, nav2_simple_commander.line_iterator.LineIterator.x1_, nav2_util::LineIterator.x1_, nav2_costmap_2d::CellData.x_, nav2_costmap_2d::StaticLayer.x_, costmap_queue::CellData.x_, dwb_critics::LineIterator.x_, nav2_simple_commander.line_iterator.LineIterator.x_, nav2_util::LineIterator.x_, nav2_costmap_2d::Costmap2DPublisher.y0_, dwb_critics::LineIterator.y0_, nav2_simple_commander.line_iterator.LineIterator.y0_, nav2_util::LineIterator.y0_, dwb_critics::LineIterator.y1_, nav2_simple_commander.line_iterator.LineIterator.y1_, nav2_util::LineIterator.y1_, nav2_costmap_2d::CellData.y_, nav2_costmap_2d::StaticLayer.y_, costmap_queue::CellData.y_, dwb_critics::LineIterator.y_, nav2_simple_commander.line_iterator.LineIterator.y_, and nav2_util::LineIterator.y_.

Member Function Documentation

◆ advance()

def nav2_simple_commander.line_iterator.LineIterator.advance ( self )

Advance to the next point in the line.

Definition at line 98 of file line_iterator.py.

Here is the call graph for this function:

◆ clamp()

def nav2_simple_commander.line_iterator.LineIterator.clamp	(	self,
		n,
		min_n,
		max_n
	)

Clamp n to be between min_n and max_n.

Args
----
    n (float): input value
    min_n (float): minimum value
    max_n (float): maximum value

Returns
-------
    n (float): input value clamped between given min and max

Definition at line 162 of file line_iterator.py.

Referenced by nav2_simple_commander.line_iterator.LineIterator.advance().

Here is the caller graph for this function: