.\

cgmapplots__define.pro

Graphics, Map Projections

This object is a wrapper for the cgPlotS routine in IDL. It provides a simple way to allow lines and symbols to be placed as annotations on map projections created with the cgMap coordinate object. Note that it may be easier and more convenient to use cgPlotS, if you don't need a complete object solution.

Class description for cgMapPlotS

Inheritance

cgContainer

All ancestor classes: cgContainer IDL_OBJECT IDL_CONTAINER

Properties

Properties in cgContainer

UVALUE get set init
NAME get set init
COUNT get
_REF_EXTRA get set

Properties in cgMapPlotS

LATS get set init
_EXTRA set init
ADDCMD set init
CLIP get set init
LONS get set init
LINESTYLE get set init
ZVALUE get set init
_REF_EXTRA get
MAPCOORD get
COLOR get set init
NOCLIP get set init
UVCOORDS get set init
PSYM get set init
SYMSIZE get set init
THICK get set init
T3D get set init

Fields

Fields in cgContainer

_CG_TRASH obj_new()
_CG_NAME ''
_CG_UVALUE ptr_new()

Fields in IDL_OBJECT

IDL_OBJECT_BOTTOM 0LL
__OBJ__ obj_new()
IDL_OBJECT_TOP 0LL

Fields in IDL_CONTAINER

IDLCONTAINERVERSION 0S
IDL_CONTAINER_TOP 0LL
NLIST 0L
PTAIL ptr_new()
PHEAD ptr_new()
IDL_CONTAINER_BOTTOM 0LL

Fields in cgMapPlotS

LATS ptr_new()
CLIP [0.00000000D, 0.00000000D, 0.00000000D, 0.00000000D]
LONS ptr_new()
LINESTYLE 0S
ZVALUE 0.000000
MAPCOORD obj_new()
COLOR ''
NOCLIP 0B
UVCOORDS 0B
SYMSIZE 0.000000
THICK 0S
PSYM 0S
T3D 0B

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 by David W. Fanning, 21 November 2011.
  Never tested, for some reason. Now, several bugs have been fixed and the
     program works as advertised. 17 Sept 2012. DWF.

Routines

result = cgMapPlotS::INIT(mapCoord [, /ADDCMD] [, CLIP=fltarr(4)] [, COLOR=string] [, LATS=float] [, LINESTYLE=integer] [, LONS=float] [, /NOCLIP] [, PSYM=integer] [, SYMSIZE=float] [, /T3D] [, THICK=integer] [, /UVCOORDS] [, ZVALUE=float] [, _EXTRA=_EXTRA]): The initialization method for the object.
cgMapPlotS::AddCmd: Adds the object as a command (the DRAW method is called) in a cgWindow resizeable graphics window.
cgMapPlotS::Draw: Draws the line or symbol on the map projection.
cgMapPlotS::GetProperty [, CLIP=fltarr(4)] [, COLOR=string] [, LATS=float] [, LINESTYLE=integer] [, LONS=float] [, /NOCLIP] [, MAPCOORD=object] [, PSYM=integer] [, SYMSIZE=float] [, /T3D] [, THICK=integer] [, /UVCOORDS] [, ZVALUE=float] [, _REF_EXTRA=_REF_EXTRA]: This method allows the user to get various properties of the object.
cgMapPlotS::SetProperty [, /ADDCMD] [, CLIP=fltarr(4)] [, COLOR=string] [, LATS=float] [, LINESTYLE=integer] [, LONS=float] [, /NOCLIP] [, PSYM=integer] [, SYMSIZE=float] [, /T3D] [, THICK=integer] [, /UVCOORDS] [, ZVALUE=float] [, _EXTRA=_EXTRA]: This method allows the user to set various properties of the object.
cgMapPlotS::CLEANUP: This is the clean-up routine for the object.
cgMapPlotS__DEFINE [, class]: This is the class definition module.

Routine details

top cgMapPlotS::INIT

result = cgMapPlotS::INIT(mapCoord [, /ADDCMD] [, CLIP=fltarr(4)] [, COLOR=string] [, LATS=float] [, LINESTYLE=integer] [, LONS=float] [, /NOCLIP] [, PSYM=integer] [, SYMSIZE=float] [, /T3D] [, THICK=integer] [, /UVCOORDS] [, ZVALUE=float] [, _EXTRA=_EXTRA])

The initialization method for the object.

Parameters

mapCoord in required type=object

A map coordinate object that will set up a map coordinate data space. Required to convert lat/lon values to projected meter space. A cgMap object.

Keywords

ADDCMD in optional type=boolean default=0: If this keyword is set, the object is added to the resizeable graphics window, cgWindow. The DRAW method of the object is called in cgWindow.
CLIP in optional type=fltarr(4): The coordinates of a rectangle used to clip the graphics output. The rectangle is specified as a vector of the form [X0, Y0, X1, Y1], giving coordinates of the lower left and upper right corners, respectively. The default clipping rectangle is the plot window set up by the cgMap object.
COLOR in optional type=string default=opposite: The name of the color to draw the grid lines in.
LATS in optional type=float: The latitude values to draw.
LINESTYLE out optional type=integer default=1: Set this keyword to the type of linestyle desired. See Graphics Keywords in the on-line help for additional information.
LONS in optional type=float: The longitude values to draw.
NOCLIP in optional type=boolean default=0: Set this keyword to supress clipping of the plot.
PSYM in optional type=integer default=0: The plotting symbol to use for the plot. Can use any symbol available in the Coyote Library routine SYMCAT.
SYMSIZE in optional type=float default=1.0: Set this keyword to the size of symbols.
T3D in optional type=boolean default=0: Set this graphics keyword if you wish to draw using the T3D transformation matrix.
THICK in optional type=integer default=1: Set this keyword to the thickness of the line used to draw the grid.
UVCOORDS in optional type=boolean default=0: Set this keyword if the LONS and LATS are specified in UV (XY) coordinates, rather than longitude and latitude coordinates.
ZVALUE in optional type=float default=0.0: Set this keyword to the ZVALUE where the output should be drawn.
_EXTRA in optional: Any keywords appropriate for superclass objects are also permitted.

top cgMapPlotS::AddCmd

cgMapPlotS::AddCmd

Adds the object as a command (the DRAW method is called) in a cgWindow resizeable graphics window.

top cgMapPlotS::Draw

cgMapPlotS::Draw

Draws the line or symbol on the map projection.

top cgMapPlotS::GetProperty

cgMapPlotS::GetProperty [, CLIP=fltarr(4)] [, COLOR=string] [, LATS=float] [, LINESTYLE=integer] [, LONS=float] [, /NOCLIP] [, MAPCOORD=object] [, PSYM=integer] [, SYMSIZE=float] [, /T3D] [, THICK=integer] [, /UVCOORDS] [, ZVALUE=float] [, _REF_EXTRA=_REF_EXTRA]

This method allows the user to get various properties of the object. The same keywords that are used for the INIT method can be used here.

Keywords

CLIP out optional type=fltarr(4)

The coordinates of a rectangle used to clip the graphics output. The rectangle is specified as a vector of the form [X0, Y0, X1, Y1], giving coordinates of the lower left and upper right corners, respectively. The default clipping rectangle is the plot window set up by the cgMap object.

COLOR out optional type=string default=opposite

The name of the color to draw the grid lines in.

LATS out optional type=float

The latitude values to draw.

LINESTYLE out optional type=integer default=1

Set this keyword to the type of linestyle desired. See Graphics Keywords in the on-line help for additional information.

LONS out optional type=float

The longitude values to draw.

NOCLIP out optional type=boolean default=0

Set this keyword to supress clipping of the plot.

MAPCOORD out optional type=object

Get the map coordinate object.

PSYM out optional type=integer default=0

The plotting symbol to use for the plot. Can use any symbol available in the Coyote Library routine SYMCAT.

SYMSIZE out optional type=float default=1.0

Set this keyword to the size of symbols.

T3D out optional type=boolean default=0

Set this graphics keyword if you wish to draw using the T3D transformation matrix.

THICK out optional type=integer default=1

Set this keyword to the thickness of the line used to draw the grid.

UVCOORDS out optional type=boolean default=0

Set this keyword if the LONS and LATS are specified in UV (XY) coordinates, rather than longitude and latitude coordinates.

ZVALUE out optional type=float default=0.0

Set this keyword to the ZVALUE where the output should be drawn.

_REF_EXTRA in optional

Any keywords appropriate for superclass objects are also permitted.

top cgMapPlotS::SetProperty

cgMapPlotS::SetProperty [, /ADDCMD] [, CLIP=fltarr(4)] [, COLOR=string] [, LATS=float] [, LINESTYLE=integer] [, LONS=float] [, /NOCLIP] [, PSYM=integer] [, SYMSIZE=float] [, /T3D] [, THICK=integer] [, /UVCOORDS] [, ZVALUE=float] [, _EXTRA=_EXTRA]

This method allows the user to set various properties of the object. The same keywords that are used for the INIT method can be used here.

Keywords

ADDCMD in optional type=boolean default=0

If this keyword is set, the object is added to the resizeable graphics window, cgWindow. The DRAW method of the object is called in cgWindow.

CLIP in optional type=fltarr(4)

COLOR in optional type=string default=opposite

The name of the color to draw the grid lines in.

LATS in optional type=float

The latitude values to draw.

LINESTYLE out optional type=integer default=1

Set this keyword to the type of linestyle desired. See Graphics Keywords in the on-line help for additional information.

LONS in optional type=float

The longitude values to draw.

NOCLIP in optional type=boolean default=0

Set this keyword to supress clipping of the plot.

PSYM in optional type=integer default=0

The plotting symbol to use for the plot. Can use any symbol available in the Coyote Library routine SYMCAT.

SYMSIZE in optional type=float default=1.0

Set this keyword to the size of symbols.

T3D in optional type=boolean default=0

Set this graphics keyword if you wish to draw using the T3D transformation matrix.

THICK in optional type=integer default=1

Set this keyword to the thickness of the line used to draw the grid.

UVCOORDS in optional type=boolean default=0

Set this keyword if the LONS and LATS are specified in UV (XY) coordinates, rather than longitude and latitude coordinates.

ZVALUE in optional type=float default=0.0

Set this keyword to the ZVALUE where the output should be drawn.

_EXTRA in optional

Any keywords appropriate for superclass objects are also permitted.

top cgMapPlotS::CLEANUP

cgMapPlotS::CLEANUP

This is the clean-up routine for the object.

top cgMapPlotS__DEFINE

cgMapPlotS__DEFINE [, class]

This is the class definition module.

Parameters

class out optional type=structure: Occasionally, it is useful to have an object class definition as a structure variable. Using this output keyword will allow that.

File attributes

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

Coyote Graphics Routines

Date: Fri Mar 27 12:14:20 2015

.\

cgmapplots__define.pro

Class description for cgMapPlotS

Inheritance

Properties

Properties in cgContainer

Properties in cgMapPlotS

Fields

Fields in cgContainer

Fields in IDL_OBJECT

Fields in IDL_CONTAINER

Fields in cgMapPlotS

Author information

Routines

Routine details

top cgMapPlotS::INIT

Parameters

Keywords

top cgMapPlotS::AddCmd

top cgMapPlotS::Draw

top cgMapPlotS::GetProperty

Keywords

top cgMapPlotS::SetProperty

Keywords

top cgMapPlotS::CLEANUP

top cgMapPlotS__DEFINE

Parameters

File attributes