.\

cgoverplot__define.pro

Graphics

The purpose of this program is to create a data object that can be plotted or drawn on a set of axes set up by another plotting command.

Examples

Use, for example, with the cgPlot command:

  oplotObj1 = Obj_New('cgOverPlot', cgDemoData(17), Color='red', PSYM=-1, LINESTYLE=2)
  oplotObj2 = Obj_New('cgOverPlot', cgDemoData(17), Color='blue', PSYM=-2, LINESTYLE=4)
  cgPlot, cgDemoData(17), Color='purple', PSYM=-4, OPLOTS=[oplotObj1, oplotObj2]
  Obj_Destroy, [oplotObj1, oplotObj2]

Class description for cgOverPlot

Inheritance

IDL_OBJECT

Properties

Properties in cgOverPlot

SKIP get set init
ADDCMD init
SYMCOLOR get set init
SYMTHICK get set init
INDEP get set
DRAW get set init
XRANGE get
DEP get set
YRANGE get
LINESTYLE get set init
VISIBLE get set init
COLOR get set init
PSYM get set init
SYMSIZE get set init
THICK get set init

Fields

Fields in IDL_OBJECT

IDL_OBJECT_BOTTOM 0LL
__OBJ__ obj_new()
IDL_OBJECT_TOP 0LL

Fields in cgOverPlot

SKIP 0L
SYMCOLOR ''
SYMTHICK 0L
INDEP ptr_new()
XRANGE [0.000000, 0.000000]
DEP ptr_new()
YRANGE [0.000000, 0.000000]
LINESTYLE 0L
VISIBLE 0L
COLOR ''
PSYM 0L
SYMSIZE 0L
THICK 0L

Author information

Author

FANNING SOFTWARE CONSULTING:

   David W. Fanning
   1645 Sheely Drive
   Fort Collins, CO 80526 USA
   Phone: 970-221-0438
   E-mail: david@idlcoyote.com
   Coyote's Guide to IDL Programming: http://www.idlcoyote.com

Copyright

History

Change History:

  Written, 18 July  2012. DWF.
  The THICK keyword was not being set in the INIT method. Fixed. 2 Nov 2012. DWF.

Routines

result = cgOverPlot::INIT(x [, y] [, /ADDCMD] [, COLOR=string] [, /DRAW] [, LINESTYLE=integer] [, PSYM=integer] [, SKIP=integer] [, SYMCOLOR=string] [, SYMSIZE=float] [, SYMTHICK=float] [, THICK=float] [, /VISIBLE]): The initialization method of the object.
cgOverPlot::CLEANUP: The clean-up routine for the object.
cgOverPlot::Draw [, SKIP=integer]: This method draws the overplot object.
cgOverPlot::GetProperty [, COLOR=string] [, DEP=varies] [, /DRAW] [, INDEP=varies] [, LINESTYLE=integer] [, PSYM=integer] [, SKIP=integer] [, SYMCOLOR=string] [, SYMSIZE=float] [, SYMTHICK=float] [, THICK=float] [, XRANGE=fltarr] [, YRANGE=fltarr] [, /VISIBLE]: This method obtains the current properties of the object.
cgOverPlot::SetProperty [, COLOR=string] [, DEP=varies] [, /DRAW] [, INDEP=varies] [, LINESTYLE=integer] [, PSYM=integer] [, SKIP=integer] [, SYMCOLOR=string] [, SYMSIZE=float] [, SYMTHICK=float] [, THICK=float] [, /VISIBLE]: This method sets the properties of the object.
cgOverPlot__Define [, class]: The class definition module for the object.

Routine details

top cgOverPlot::INIT

result = cgOverPlot::INIT(x [, y] [, /ADDCMD] [, COLOR=string] [, /DRAW] [, LINESTYLE=integer] [, PSYM=integer] [, SKIP=integer] [, SYMCOLOR=string] [, SYMSIZE=float] [, SYMTHICK=float] [, THICK=float] [, /VISIBLE])

The initialization method of the object. Called automatically when the object is created.

Parameters

x in required type=any

If X is provided without Y, a vector representing the dependent values to be plotted If both X and Y are provided, X is the independent parameter and Y is the dependent parameter to be plotted.

y in optional type=any

A vector representing the dependent values to be plotted.

Keywords

ADDCMD in optional type=boolean default=0: Set this keyword to add the command to the resizeable graphics window cgWindow.
COLOR in optional type=string default=opposite: The name of the data color. This is the color of the data line.
DRAW in optional type=boolean default=0: If this keyword is set, the data is drawn as soon as the object is created.
LINESTYLE in optional type=integer default=0: The line style for drawing the line.
PSYM in optional type=integer: Any normal IDL PSYM values, plus any value supported by the Coyote Library routine cgSYMCAT. An integer between 0 and 46.
SKIP in optional type=integer default=1: The number of data points to skip when the line is drawn. The default is to not skip any data points, but to plot them all.
SYMCOLOR in optional type=string: The name of the symbol color. By default, the same as the COLOR keyword.
SYMSIZE in optional type=float default=1.0: The symbol size.
SYMTHICK in optional type=float default=1.0: The thickness of the symbol.
THICK in optional type=float default= 1.0: The thickness of the line.
VISIBLE in optional type=boolean default=1: Set this keyword to determine in the line should be drawn (visible=1), or if the line should not be drawn (visible=0).

top cgOverPlot::CLEANUP

cgOverPlot::CLEANUP

The clean-up routine for the object. Destroy pointers, etc.

top cgOverPlot::Draw

cgOverPlot::Draw [, SKIP=integer]

This method draws the overplot object. It assumes a set of axes has been established by some other graphics command.

Keywords

SKIP in optional type=integer: Set this keyword to the number of data points to skip when drawing the data vectors. Similar to the SKIP parameter, but this keyword gives you the opportunity to temporarily over-ride the value of the SKIP parameter.

top cgOverPlot::GetProperty

cgOverPlot::GetProperty [, COLOR=string] [, DEP=varies] [, /DRAW] [, INDEP=varies] [, LINESTYLE=integer] [, PSYM=integer] [, SKIP=integer] [, SYMCOLOR=string] [, SYMSIZE=float] [, SYMTHICK=float] [, THICK=float] [, XRANGE=fltarr] [, YRANGE=fltarr] [, /VISIBLE]

This method obtains the current properties of the object.

Keywords

COLOR out optional type=string: The name of the data color. This is the color of the data line.
DEP out optional type=varies: The current dependent data of the object.
DRAW out optional type=boolean: If this keyword is set, the data is drawn as soon as the object is created.
INDEP out optional type=varies: The current independent data of the object.
LINESTYLE out optional type=integer: The line style for drawing the line.
PSYM out optional type=integer: Any normal IDL PSYM values, plus any value supported by the Coyote Library routine cgSYMCAT. An integer between 0 and 46.
SKIP out optional type=integer default=1: The number of data points to skip when the line is drawn.
SYMCOLOR out optional type=string: The name of the symbol color.
SYMSIZE out optional type=float: The symbol size.
SYMTHICK out optional type=float: The thickness of the symbol.
THICK out optional type=float: The thickness of the line.
XRANGE out optional type=fltarr: The range of the dependent data.
YRANGE out optional type=fltarr: The range of the independent data.
VISIBLE out optional type=boolean: The visibility of the objects plot line.

top cgOverPlot::SetProperty

cgOverPlot::SetProperty [, COLOR=string] [, DEP=varies] [, /DRAW] [, INDEP=varies] [, LINESTYLE=integer] [, PSYM=integer] [, SKIP=integer] [, SYMCOLOR=string] [, SYMSIZE=float] [, SYMTHICK=float] [, THICK=float] [, /VISIBLE]

This method sets the properties of the object.

Keywords

COLOR in optional type=string: The name of the data color. This is the color of the data line.
DEP in optional type=varies: A vector of dependent data.
DRAW in optional type=boolean default=0: If this keyword is set, the data is drawn as soon as the properties are set.
INDEP in optional type=varies: A vector of independent data.
LINESTYLE in optional type=integer: The line style for drawing the line.
PSYM in optional type=integer: Any normal IDL PSYM values, plus any value supported by the Coyote Library routine cgSYMCAT. An integer between 0 and 46.
SKIP in optional type=integer default=1: The number of data points to skip when the line is drawn. The default is to not skip any data points, but to plot them all.
SYMCOLOR in optional type=string: The name of the symbol color. By default, the same as the COLOR keyword.
SYMSIZE in optional type=float default=1.0: The symbol size.
SYMTHICK in optional type=float default=1.0: The thickness of the symbol.
THICK in optional type=float default= 1.0: The thickness of the line.
VISIBLE in optional type=boolean default=1: Set this keyword to determine in the line should be drawn (visible=1), or if the line should not be drawn (visible=0).

top cgOverPlot__Define

cgOverPlot__Define [, class]

The class definition module for the object.

Parameters

class out optional type=struct: The class definition as a structure variable. Occasionally useful.

File attributes

Modification date:	Fri Mar 27 11:07:37 2015
Lines:	436
Docformat:	rst rst

Coyote Graphics Routines

Date: Fri Mar 27 12:14:20 2015

.\

cgoverplot__define.pro

Examples

Class description for cgOverPlot

Inheritance

Properties

Properties in cgOverPlot

Fields

Fields in IDL_OBJECT

Fields in cgOverPlot

Author information

Routines

Routine details

top cgOverPlot::INIT

Parameters

Keywords

top cgOverPlot::CLEANUP

top cgOverPlot::Draw

Keywords

top cgOverPlot::GetProperty

Keywords

top cgOverPlot::SetProperty

Keywords

top cgOverPlot__Define

Parameters

File attributes