comp.lang.idl-pvwave archive: archive

Home » Public Forums » archive » IDLdoc 3.0 released

Show: Today's Messages :: Show Polls :: Message Navigator
E-mail to friend

Re: IDLdoc 3.0 released [message #58245 is a reply to message #58156]

Wed, 23 January 2008 07:28

David Fanning
Messages: 11724
Registered: August 2001

Senior Member

Brian Larsen writes:

> I decided to go through my library last night and see what could
> be done "out of the box" and it worked great.

I tried this "out of the box" thing, too. But my results
were not so great. :-(

I tried documenting this file, which uses a fairly
routine IDL doc template:

http://www.dfanning.com/programs/aspect.pro

And the result looked like this:

NAME: ASPECT PURPOSE: This function calculates and returns the
normalized position coordinates necessary to put a plot with a specified
aspect ratio into the currently active graphics window. It works on the
display output window as well as in a PostScript output window.CATEGORY:
Graphics CALLING SEQUENCE: position = ASPECT(aspectRatio) INPUTS:
aspectRatio: A floating point value that is the desired aspect ratio
(ratio of heigth to width) of the plot in the current graphics output
window. If this parameter is missing, an aspect ratio of 1.0 (a square
plot) is assumed. KEYWORDS: MARGIN: The margin around the edges of the
plot. The value must be a floating point value between 0.0 and 0.5. It
is expressed in normalized coordinate units. The default margin is 0.15.
WINDOWASPECT: The aspect ratio of the target window. If not provided,
the value is obtained from the current graphics window. OUTPUTS:
position: A four-element floating array of normalized coordinates. The
order of the elements is [x0, y0, x1, y1], similar to the !P.POSITION
system variable or the POSITION keyword on any IDL graphic command.
EXAMPLE: To create a plot with an aspect ratio of 1:2 and a margin of
0.10 around the edge of the output window, do this: plotPosition =
ASPECT(0.5, Margin=0.10) PLOT, Findgen(11), POSITION=plotPosition Notice
this can be done in a single IDL command, like this: PLOT, Findgen(11),
POSITION=ASPECT(0.5, Margin=0.10) MODIFICATION HISTORY: Written by:
David Fanning, November 1996. Added better error checking, 18 Feb 1997,
DWF. Added WindowAspect keyword. 10 Feb 2000. DWF Added double precision
tolerance for aspectRatio. 9 NOV 2001 BT

Not really what I had in mind. :-(

What would I have to do to fix this?

Cheers,

David
--
David Fanning, Ph.D.
Fanning Software Consulting, Inc.
Coyote's Guide to IDL Programming: http://www.dfanning.com/
Sepore ma de ni thui. ("Perhaps thou speakest truth.")

Report message to a moderator

[Message index]

		IDLdoc 3.0 released By: Michael Galloy on Mon, 21 January 2008 21:47
		Re: IDLdoc 3.0 released By: Michael Galloy on Wed, 23 January 2008 11:27
		Re: IDLdoc 3.0 released By: Michael Galloy on Wed, 23 January 2008 10:50
		Re: IDLdoc 3.0 released By: David Fanning on Wed, 23 January 2008 08:01
		Re: IDLdoc 3.0 released By: Michael Galloy on Wed, 23 January 2008 07:49
		Re: IDLdoc 3.0 released By: David Fanning on Wed, 23 January 2008 07:28
		Re: IDLdoc 3.0 released By: Ingo von Borstel on Wed, 23 January 2008 04:28
		Re: IDLdoc 3.0 released By: Foldy Lajos on Wed, 23 January 2008 02:50
		Re: IDLdoc 3.0 released By: Ingo von Borstel on Wed, 23 January 2008 01:00
		Re: IDLdoc 3.0 released By: Michael Galloy on Sun, 27 January 2008 18:07

Previous Topic:	Re: SURFACE layout details
Next Topic:	Re: Resampling from cumulative probability distribution

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Fri Oct 10 23:19:24 PDT 2025

Total time taken to generate the page: 0.39982 seconds