libpysal.cg.Rectangle

class libpysal.cg.Rectangle(left, lower, right, upper)

Geometric representation of rectangle objects.

Examples

>>> r = Rectangle(-4, 3, 10, 17)
>>> r.left #minx
-4.0

>>> r.lower #miny
3.0

>>> r.right #maxx
10.0

>>> r.upper #maxy
17.0

Attributes

leftpython:float

Minimum x-value of the rectangle.

lowerpython:float

Minimum y-value of the rectangle.

rightpython:float

Maximum x-value of the rectangle.

upperpython:float

Maximum y-value of the rectangle.

__init__(self, left, lower, right, upper)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self, left, lower, right, upper)	Initialize self.
set_centroid(self, new_center)	Moves the rectangle center to a new specified point.
set_scale(self, scale)	Rescales the rectangle around its center.

Attributes

area	Returns the area of the Rectangle.
height	Returns the height of the Rectangle.
width	Returns the width of the Rectangle.

property area

Returns the area of the Rectangle.

Examples

>>> r = Rectangle(0, 0, 4, 4)
>>> r.area
16.0

property height

Returns the height of the Rectangle.

Examples

>>> r = Rectangle(0, 0, 4, 4)
>>> r.height
4.0

set_centroid(self, new_center)

Moves the rectangle center to a new specified point.

Parameters

new_centerlibpysal.cg.Point

The new location of the centroid of the polygon.

Examples

>>> r = Rectangle(0, 0, 4, 4)
>>> r.set_centroid(Point((4, 4)))
>>> r.left
2.0

>>> r.right
6.0

>>> r.lower
2.0

>>> r.upper
6.0

set_scale(self, scale)

Rescales the rectangle around its center.

Parameters

scalepython:int, python:float

The ratio of the new scale to the old scale (e.g. 1.0 is current size).

Examples

>>> r = Rectangle(0, 0, 4, 4)
>>> r.set_scale(2)
>>> r.left
-2.0
>>> r.right
6.0
>>> r.lower
-2.0
>>> r.upper
6.0

property width

Returns the width of the Rectangle.

Examples

>>> r = Rectangle(0, 0, 4, 4)
>>> r.width
4.0