overlay module¶

stsci.numdisplay.overlay.circle(**kwargs)¶

Draw a circle.

Parameters:	x (int) – image X coordinate of center y (int) – image Y coordinate of center center (tuple) – (x,y) coordinates of center radius (int) – radius of circle color (int) – color code to use; if not specified, use default undo (bool) – if specified [default=True], keep track of overlays for undo()

Examples

Samples illustrating the syntax include:

overlay.circle (x=x0, y=y0, radius=r)
overlay.circle (center=(x0,y0), radius=r)
overlay.circle (x=x0, y=y0, radius=r, color=overlay.C_<color>)

stsci.numdisplay.overlay.close_display(frame=1)¶: Close the device.

stsci.numdisplay.overlay.marker(**kwargs)¶

Draw a character.

Parameters:	x (int) – image X coordinate of point y (int) – image Y coordinate of point mark (str) – character to be drawn size (int) – magnification to be used in drawing the character color (int) – color code to use; if not specified, use default undo (bool) – if specified [default=True], keep track of overlays for undo()

Examples

Samples illustrating the syntax include:

overlay.marker (x=x0, y=y0, mark='+')
overlay.marker (x=x0, y=y0, mark='+', size=2)
overlay.marker (x=x0, y=y0, mark='+', color=overlay.C_<color>)

stsci.numdisplay.overlay.point(**kwargs)¶

Draw a point.

Parameters:	x (int) – image X coordinate of point y (int) – image Y coordinate of point center (tuple) – (x,y) coordinates of point color (int) – color code to use; if not specified, use default undo (bool) – if specified [default=True], keep track of overlays for undo()

Examples

Samples illustrating the syntax include:

overlay.point (x=x0, y=y0)
overlay.point (center=(x0,y0))
overlay.point (x=x0, y=y0, color=overlay.C_<color>)

stsci.numdisplay.overlay.polyline(**kwargs)¶

Draw a series of connected line segments.

Parameters:	points (list of tuples) – (x,y) points to connect with line segments vertices (list of tuples) – (x,y) points to connect with line segments color (int) – color code to use; if not specified, use default undo (bool) – if specified [default=True], keep track of overlays for undo()

Examples

Samples illustrating the syntax include:

overlay.polyline (points=[(x1,y1), (x2,y2), (x3,y3)])
overlay.polyline (vertices=[(x1,y1), (x2,y2), (x3,y3)])
overlay.polyline (points=[(x1,y1), (x2,y2), (x3,y3)],
                  color=overlay.C_<color>)

stsci.numdisplay.overlay.rectangle(**kwargs)¶

Draw a rectangle.

Parameters:

left (int) – image X coordinate of left edge
right (int) – image X coordinate of right edge
lower (int) – image Y coordinate of lower edge
upper (int) – image Y coordinate of upper edge
center (tuple) – (x,y) coordinates of middle of rectangle
width (int) – width of rectangle (X direction)
height (int) – height of rectangle (Y direction)
color (int) – color code to use; if not specified, use default
undo (bool) – if specified [default=True], keep track of overlays for undo()

Examples

Samples illustrating the syntax include:

overlay.rectangle (left=x1, right=x2, lower=y1, upper=y2)
overlay.rectangle (center=(x0,y0), width=w, height=h)
overlay.rectangle (left=x1, lower=y1, center=(x0,y0))
overlay.rectangle (left=x1, lower=y1, width=w, height=h)
overlay.rectangle (right=x2, upper=y2, width=w, height=h)
overlay.rectangle (right=x2, upper=y2, center=(x0,y0))
overlay.rectangle (left=x1, right=x2, lower=y1, upper=y2, color=overlay.C_<color>)

stsci.numdisplay.overlay.set(color=None, radius=None)¶

Specify the color or the radius.

Parameters:	color (int) – color code to use for graphic overlays; the allowed values (202..217) are: C_BLACK, C_WHITE, C_RED, C_GREEN, C_BLUE, C_YELLOW, C_CYAN, C_MAGENTA, C_CORAL, C_MAROON, C_ORANGE, C_KHAKI, C_ORCHID, C_TURQUOISE, C_VIOLET, C_WHEAT radius (int) – radius to use when drawing circles

stsci.numdisplay.overlay.undo()¶: Restore the values before the last overlay was written.