Template Class Reference

Public Member Functions
def	__init__ (self, PuzzleTemplate y=None, r=(0, 0), id=None, theta=0, pieceStatus=PieceStatus.UNKNOWN)
def	display (self, fh=None)
def	getMask (self, theMask, offset=[0, 0])
def	placeInImage (self, theImage, offset=[0, 0], CONTOUR_DISPLAY=True)
def	placeInImageAt (self, theImage, rc, theta=None, isCenter=False, CONTOUR_DISPLAY=True)
def	rotatePiece (self, theta)
def	setPlacement (self, r, offset=False, isCenter=False)
def	size (self)
def	toImage (self)

Static Public Member Functions
def	buildFromMaskAndImage (theMask, theImage, rLoc=None, pieceStatus=PieceStatus.MEASURED)
def	buildSphere (radius, color, rLoc=None)
def	buildSquare (size, color, rLoc=None)
def	getEig (img)

Public Attributes
	cluster_id
	id
	rLoc
	status
	theta
	tracking_life
	y

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
		PuzzleTemplate	y = None,
			r = (0, 0),
			id = None,
			theta = 0,
			pieceStatus = PieceStatus.UNKNOWN
	)

@brief  Constructor for template class.

Args:
    y: The puzzle piece template source data, if given. It is a class instance, see puzzleTemplate.
    r: The puzzle piece location in the whole image.
    id: The puzzle piece id in the measured board. Be set up by the board.
    theta: The puzzle piece aligned angle.
    pieceStatus: The status of the puzzle pieces, including UNKNOWN, MEASURED, TRACKED, and INHAND.

Member Function Documentation

buildFromMaskAndImage()

def buildFromMaskAndImage (   theMask,   theImage,   rLoc = None,   pieceStatus = PieceStatus.MEASURED  )

static

@brief  Given a mask (individual) and an image of same base dimensions, use to
instantiate a puzzle piece template.

Args:
    theMask: The individual mask.
    theImage: The source image.
    rLoc: The puzzle piece location in the whole image.

Returns:
    thePiece: The puzzle piece instance.

buildSphere()

def buildSphere (   radius,   color,   rLoc = None  )

static

@brief  Build a sphere piece.

Args:
    radius: The radius of the sphere.
    color: (3,). The RGB color.
    rLoc: (x, y). The puzzle piece location in the whole image. x: left-to-right. y:top-to-down
    The puzzle piece instance.

Returns:
    thePiece: The puzzle piece instance.

buildSquare()

def buildSquare (   size,   color,   rLoc = None  )

static

@brief  Build a square piece.

Args:
    size: The side length of the square
    color: (3,). The RGB color.
    rLoc: (x, y). The puzzle piece location in the whole image. x: left-to-right. y:top-to-down

Returns:
    thePiece: The puzzle piece instance.

display()

def display	(		self,
			fh = None
	)

@brief  Display the puzzle piece contents in an image window.

Args:
    fh: The figure label/handle if available. (optional)

Returns:
    fh: The handle of the image.

getEig()

def getEig (   img )

static

@brief  To find the major and minor axes of a blob and then return the aligned rotation.
See https://alyssaq.github.io/2015/computing-the-axes-or-orientation-of-a-blob/ for details.
PCA is our default method which does not perform very well.

Args:
    img: A contour image.

Returns:
    theta: The aligned angle (degree).

getMask()

def getMask	(		self,
			theMask,
			offset = [0, 0]
	)

@brief Get an updated mask of the target.

Args:
    theMask: The original mask of the target.
    offset: The movement.

Returns:
    theMask: The updated mask of the target.

placeInImage()

def placeInImage	(		self,
			theImage,
			offset = [0, 0],
			CONTOUR_DISPLAY = True
	)

@brief  Insert the puzzle piece into the image in the original location.

Args:
    theImage: The source image to put puzzle piece into.
    offset: The offset list.
    CONTOUR_DISPLAY: The flag indicating whether to display the contours.

placeInImageAt()

def placeInImageAt	(		self,
			theImage,
			rc,
			theta = None,
			isCenter = False,
			CONTOUR_DISPLAY = True
	)

@brief  Insert the puzzle piece into the image at the given location.

Args:
    theImage: The source image to put puzzle piece into.
    rc: The coordinate location.
    theta: The orientation of the puzzle piece (default = 0).
    isCenter: The flag indicating whether the given location is for the center.
    CONTOUR_DISPLAY: The flag indicating whether to display the contours.

rotatePiece()

def rotatePiece	(		self,
			theta
	)

@brief Rotate the puzzle template instance by the given angle.

Args:
    theta: The rotated angle.

Returns:
    thePiece: A new puzzle template instance.

setPlacement()

def setPlacement	(		self,
			r,
			offset = False,
			isCenter = False
	)

@brief  Provide pixel placement location information.

Args:
    r: Location of its frame origin.
    offset: Boolean indicating whether it sets the offset or not.
    isCenter: Boolean indicating r is center or not.

size()

def size

(

self

)

@brief  Return the dimensions of the puzzle piece image.

Returns:
    Dimensions of the puzzle piece image

toImage()

def toImage

(

self

)

@brief  Return the puzzle piece image (cropped).

Returns:
    theImage: The puzzle piece image (cropped).

Member Data Documentation

cluster_id

cluster_id

id

id

rLoc

rLoc

status

status

theta

theta

tracking_life

tracking_life

y

y

---

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

• /home/pvela/python/puzzle_solver/puzzle/old_template.py