Documentation for pp_lib

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

./

pp_ocircle.pro


Routines

top source pp_ocircle

result = pp_ocircle( [sz] [, np=np] [, _ref_extra=_ref_extra])

Returns a filled/open/dotted circle object to use as a symbol in an itool. Object is an IDLgrPolygon. If the object is edited even after the call to the itool, the itool symbol will change (it may take clicking on the itool window to cause it to refresh).

Parameters

sz in optional default=1.0

Symbol size.

Keywords

np in optional default=21

The number of points used in making the circle (defaults to 21), since it is actually a polygon (similar to IDL's orb, which is a polyhedron "sphere").

_ref_extra in out optional

Passed to IDLgrPolygon init routine. Commonly useful keywords are:

style: determines the type of circle (2 for filled, 1 for the contour only, 0 for points at the vertices only.

thick: determines the thickness of the line to draw the contour.

color: 3 element RGB color vector.

Examples

To create a plot using filled red circles of size 5:

oc=pp_ocircle(5.0,color=[255,0,0]) iplot,indgen(10),sym_object=oc
To change the color, style and thickness of the symbols in the existing plot:
oc->setproperty,color=[0,0,255],style=1,thick=1.5
The object will keep exisiting even after the itool is closed. To get rid of it, it has to be destroyed afterwards (if destroyed while the itool still exists, it will cause a lot of errors):
obj_destroy,oc

Author information

Author:

Paulo Penteado (pp.penteado@gmail.com), Sep/2009

Statistics

Lines:
11 lines
Cyclomatic complexity:
2
Modified cyclomatic complexity:
2

File attributes

Modification date: Wed Jun 29 22:15:28 2016
Lines: 11
Docformat: rst rst