Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

spedas/gui/display/draw_object/

spd_ui_draw_object__yclip.pro


Routines

top source spd_ui_draw_object::yclip

spd_ui_draw_object::yclip, xPtr, yPtr, zPtr, range, scale, mirrorptr=mirrorptr, fail=fail

spd_ui_draw_object method: yclip This routine, performs prepocessing with respect to the y-axis 1. translates data from linear to log space, if necessary 2. Removes invalid values or marks with NaNs depending on whether trace in spectrographic and spec geometry. Reasons for marking/removing a. non-finite. b. out of range c. le 0 on log axis 3. Performs analogous removals on z/mirror data Inputs: xPtr(array of pointers to arrays): A list of the data quantities for all x-values used in the panel. The number of pointers should match the number of pointers in y and z. If an x/y has no z(ie line plot), the corresponding element should be a null pointer yPtr(array of pointers to arrays) : A list of the data quantities for all y-values used in the panel. The number of pointers should match the number of pointers in x and z. If an x/y has no z(ie line plot), the corresponding element should be a null pointer zPtr(array of pointers to arrays) : A list of the data quantities for all z-values used in the panel. The number of pointers should match the number of pointers in x and y. If an x/y has no z(ie line plot), the corresponding element should be a null pointer range(2-element double) : The min and max y-range that the data should be clipped to. scale(long) : The scaling method to be used on this axis(0: linear,1:log10,2:logN) mirrorPtr(array of pointers to arrays) : A list of the data quantities for all mirror-values used in the panel. The number of pointers should match the number of pointers in x,y, z If an x/y has no mirror the corresponding element should be a null pointer Outputs: xPtr(array of pointers to arrays): Input data replaced with clipped data. Format is the same yPtr(array of pointers to arrays): Input data replaced with clipped data. Format is the same zPtr(array of pointers to arrays): Input data replaced with clipped data. Format is the same fail(named variable keyword): Will store 1 if routine fails, 0 otherwise NOTES: This routine is a partial replacement for spd_ui_xyclip, which became unwieldy to maintain as the reponsibilities of the routine diverged. $LastChangedBy: jimm $ $LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $ $LastChangedRevision: 14326 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/display/draw_object/spd_ui_draw_object__yclip.pro $

Parameters

xPtr
yPtr
zPtr
range
scale

Keywords

mirrorptr
fail

File attributes

Modification date: Thu Feb 13 16:41:35 2014
Lines: 120