![[attach.png]](../../../idldoc-resources/attach.png)
external/spdfcdas/spdf_cdawlib/
spdf_virtual_funcs.pro
NAME: Function ALTERNATE_VIEW PURPOSE: Find virtual variables and replace their data w/ the component0 data CALLING SEQUENCE: new_buf = alternate_view(buf,org_names) VARIABLES: Input: buf - an IDL structure built w/in spdf_read_mycdf org_names - list of original variables input to spdf_read_mycdf. Any variables in this list will remain tagged as VAR_TYPE= data otherwise VAR_TYPE = support_data. Output: new_buf - an IDL structure containing the populated virtual variable Keyword Parameters: REQUIRED PROCEDURES: none
NAME: Function CROP_IMAGE PURPOSE: Crop [60,20,*] images into [20,20,*] CALLING SEQUENCE: new_buf = crop_image(buf,org_names,index) VARIABLES: Input: buf - an IDL structure built w/in spdf_read_mycdf org_names - list of original variables input to spdf_read_mycdf. Any variables in this list will remain tagged as VAR_TYPE= data otherwise VAR_TYPE = support_data. index - variable index, so we deal with one variable at a time. Output: new_buf - an IDL structure containing the populated virtual variable History: Written by RCJ 12/00, based on alternate_view
NAME: Function CONV_MAP_IMAGE PURPOSE: Convert provided idl structure to structure containing neccesary variables for an auroral image map. Use variables pointed to by COMPONENT variable attributes to compute geodetic latitude and longitude. Populate GEOD_LAT & GEOD_LONG variables w/ the computed values. Return the modifiy idl structure. NEED TO REMOVE UVI DEPENDANCIES....... CALLING SEQUENCE: new_buf = conv_map_image(buf,org_names) VARIABLES: Input: buf - an IDL structure built w/in spdf_read_mycdf org_names - list of original variables input to spdf_read_mycdf. Any variables in this list will remain tagged as VAR_TYPE= data otherwise VAR_TYPE = support_data. Output: new_buf - an IDL structure containing the populated virtual variable Keyword Parameters: REQUIRED PROCEDURES: none
NAME: Function HEIGHT_ISIS PURPOSE: Retrieve only height from vector geo_coord: (lat1, lon1, height1, lat2, lon2, height2, lat3, lon3, height3, .....) CALLING SEQUENCE: new_buf = height_isis(buf,org_names,index) VARIABLES: Input: buf - an IDL structure built w/in spdf_read_mycdf org_names - list of original variables input to spdf_read_mycdf. Any variables in this list will remain tagged as VAR_TYPE= data otherwise VAR_TYPE = support_data. index - variable index, so we deal with one variable at a time. Output: new_buf - an IDL structure containing the populated virtual variable History: Written by RCJ 09/01, based on crop_image
NAME: Function FLIP_IMAGE PURPOSE: Flip_image [*,*] CALLING SEQUENCE: new_buf = flip_image(buf,org_names,index) VARIABLES: Input: buf - an IDL structure built w/in spdf_read_mycdf org_names - list of original variables input to spdf_read_mycdf. Any variables in this list will remain tagged as VAR_TYPE= data otherwise VAR_TYPE = support_data. index - variable index, so we deal with one variable at a time. Output: new_buf - an IDL structure containing the populated virtual variable History: Written by TJK 01/03 for use w/ IDL RPI data
NAME: Function make_stack_array PURPOSE: take the array of data specified by component_0 and apply the array reduction specified in the display_type place the result in the return buffer. CALLING SEQUENCE: new_buf = make_stack_array(buf,org_names) VARIABLES: Input: astruct - an IDL structure built w/in spdf_read_mycdf org_names - list of original variables input to spdf_read_mycdf. Any variables in this list will remain tagged as VAR_TYPE= data otherwise VAR_TYPE = support_data. index - keyword - if set use this index value to find the virtual variable, otherwise, find the 1st vv in the structure. Output: new_buf - an IDL structure containing the populated virtual variable Keyword Parameters: REQUIRED PROCEDURES: none
Routines
Routines from spdf_virtual_funcs.pro
result = vtype_names(buf, vtype, NAMES=NAMES)NAME: Function VTYPE_NAMES PURPOSE: Returns array of names or index numbers where the var_type is equal to vtype (eg."data").
result = buf_trap(a)NAME: Function Trap PURPOSE: Trap malformed idl structures or invalid arguments.
result = vv_names(buf, NAMES=NAMES)NAME: Function VV_NAMES PURPOSE: Returns array of virtual variable names or index numbers.
result = check_myvartype(nbuf, org_names)NAME: Function CHECK_MYVARTYPE PURPOSE: Check that all variables in the original variable list are declared as data otherwise set to ignore_data Find variables w/ var_type == data CALLING SEQUENCE: status = check_myvartype(buf,org_names) VARIABLES: Input: buf - an IDL structure built w/in spdf_read_mycdf org_names - list of original variables input to spdf_read_mycdf.
result = alternate_view(buf, org_names)result = crop_image(buf, org_names, index=index)result = clean_data(data, FILLVAL=FILLVAL)NAME: Function clean_data pURPOSE: Remove data 3*sigma from mean INPUT: data simple data array KEYWORDS: FILLVAL the fill value to be used to replace outlying data.
result = conv_pos(buf, org_names, COORD=COORD, TSTART=TSTART, TSTOP=TSTOP, DEBUG=DEBUG, INDEX=INDEX)NAME: Function CONV_POS PURPOSE: Find virtual variables and compute their data w/ the component0, component1,...
result = dtand(x)result = datand(x)result = fgeodeP(a, b, v1x, v1y, v1z, v2x, v2y, v2z)vector_to_ra_decP, x, y, z, ra, decdrtollP, x, y, z, lat, lon, rget_scalarP, Ox, Oy, Oz, Lx, Ly, Lz, emis_hgt, ncols, nrows, s, fptg_new, orb, LpixX, LpixY, LpixZ, emis_hgt, gclat, gclon, r, epoch=epochptg, system, time, l0, att, orb, emis_hgt, gclat, gclon, geodetic=geodetic, getra=getra, ra=ra, dec=dec, s=s, LpixX=LpixX, LpixY=LpixY, LpixZ=LpixZ, posX=posX, posY=posY, posZ=posZ, epoch=epoch, versStr=versStr, help=helpresult = conv_map_image(buf, org_names, DEBUG=DEBUG)result = calc_p(buf, org_names, INDEX=INDEX, DEBUG=DEBUG)result = Add_51s(buf, org_names, INDEX=INDEX, DEBUG=DEBUG)result = Add_seconds(buf, org_names, seconds=seconds, INDEX=INDEX, DEBUG=DEBUG)result = compute_magnitude(buf, org_names, INDEX=INDEX, DEBUG=DEBUG)result = extract_array(buf, org_names, INDEX=INDEX, DEBUG=DEBUG)result = height_isis(buf, org_names, index=index)result = flip_image(buf, org_names, index=index)result = wind_plot(buf, org_names, index=index)result = comp_epoch(buf, org_names, index=index, DEBUG=DEBUG)result = comp_themis_epoch(buf, org_names, index=index, DEBUG=DEBUG, sixteen=sixteen)result = error_bar_array(buf, index=index, value=value)result = convert_toev(buf, org_names, index=index, DEBUG=DEBUG)result = convert_Ni(buf, org_names, index=index, DEBUG=DEBUG)result = conv_pos_hungarian(buf, org_names, INDEX=INDEX)NAME: Function CONV_POS_HUNGARIAN PURPOSE: Convert cl_sp_aux positions x,y,z from GSE to GEI (GCI).
result = correct_FAST_By(buf, org_names, INDEX=INDEX, DEBUG=DEBUG)result = compute_cadence(buf, org_names, INDEX=INDEX)NAME: Function compute_cadence PURPOSE: Determine the resolution between epoch values so that one can easily see where the "burst" data is located.
result = apply_rtn_qflag(astruct, orig_names, index=index)result = apply_rtn_cadence(astruct, orig_names, index=index)result = expand_wave_data(astruct, org_names, INDEX=INDEX, DEBUG=DEBUG)result = make_stack_array(astruct, org_names, index=index)spdf_virtual_funcs
Routine details
top source vtype_names
result = vtype_names(buf, vtype, NAMES=NAMES)
NAME: Function VTYPE_NAMES PURPOSE: Returns array of names or index numbers where the var_type is equal to vtype (eg."data").
Parameters
- buf
- vtype
Keywords
- NAMES
top source buf_trap
result = buf_trap(a)
NAME: Function Trap PURPOSE: Trap malformed idl structures or invalid arguments. INPUT; a an idl structure
Parameters
- a
top source vv_names
result = vv_names(buf, NAMES=NAMES)
NAME: Function VV_NAMES PURPOSE: Returns array of virtual variable names or index numbers.
Parameters
- buf
Keywords
- NAMES
top source check_myvartype
result = check_myvartype(nbuf, org_names)
NAME: Function CHECK_MYVARTYPE PURPOSE: Check that all variables in the original variable list are declared as data otherwise set to ignore_data Find variables w/ var_type == data CALLING SEQUENCE: status = check_myvartype(buf,org_names) VARIABLES: Input: buf - an IDL structure built w/in spdf_read_mycdf org_names - list of original variables input to spdf_read_mycdf. Any variables in this list will remain tagged as VAR_TYPE= data otherwise VAR_TYPE = metadata. Output: buf - an IDL structure containing the populated virtual variables status - 0 ok else failed Keyword Parameters: REQUIRED PROCEDURES:
Parameters
- nbuf
- org_names
top source crop_image
result = crop_image(buf, org_names, index=index)
Parameters
- buf
- org_names
Keywords
- index
top source clean_data
result = clean_data(data, FILLVAL=FILLVAL)
NAME: Function clean_data pURPOSE: Remove data 3*sigma from mean INPUT: data simple data array KEYWORDS: FILLVAL the fill value to be used to replace outlying data. CALLING SEQUENCE: data = clean_data(data,keywords...)
Parameters
- data
Keywords
- FILLVAL
top source conv_pos
result = conv_pos(buf, org_names, COORD=COORD, TSTART=TSTART, TSTOP=TSTOP, DEBUG=DEBUG, INDEX=INDEX)
NAME: Function CONV_POS PURPOSE: Find virtual variables and compute their data w/ the component0, component1,... data. This function specifically converts position information from 1 coordinate system into another. INPUT: buf an IDL structure org_names an array of original variables sent to spdf_read_mycdf KEYWORDS: COORD string corresponding to coordinate transformation default(SYN-GCI) (ANG-GSE) TSTART start time for synthetic data TSTOP start time for synthetic data CALLING SEQUENCE: newbuf = conv_pos(buf,org_names,keywords...)
Parameters
- buf
- org_names
Keywords
- COORD
- TSTART
- TSTOP
- DEBUG
- INDEX
top source fgeodeP
result = fgeodeP(a, b, v1x, v1y, v1z, v2x, v2y, v2z)
Parameters
- a
- b
- v1x
- v1y
- v1z
- v2x
- v2y
- v2z
top source get_scalarP
get_scalarP, Ox, Oy, Oz, Lx, Ly, Lz, emis_hgt, ncols, nrows, s, f
Parameters
- Ox
- Oy
- Oz
- Lx
- Ly
- Lz
- emis_hgt
- ncols
- nrows
- s
- f
top source ptg_new
ptg_new, orb, LpixX, LpixY, LpixZ, emis_hgt, gclat, gclon, r, epoch=epoch
Parameters
- orb
- LpixX
- LpixY
- LpixZ
- emis_hgt
- gclat
- gclon
- r
Keywords
- epoch
top source ptg
ptg, system, time, l0, att, orb, emis_hgt, gclat, gclon, geodetic=geodetic, getra=getra, ra=ra, dec=dec, s=s, LpixX=LpixX, LpixY=LpixY, LpixZ=LpixZ, posX=posX, posY=posY, posZ=posZ, epoch=epoch, versStr=versStr, help=help
Parameters
- system
- time
- l0
- att
- orb
- emis_hgt
- gclat
- gclon
Keywords
- geodetic
- getra
- ra
- dec
- s
- LpixX
- LpixY
- LpixZ
- posX
- posY
- posZ
- epoch
- versStr
- help
top source conv_map_image
result = conv_map_image(buf, org_names, DEBUG=DEBUG)
Parameters
- buf
- org_names
Keywords
- DEBUG
top source calc_p
result = calc_p(buf, org_names, INDEX=INDEX, DEBUG=DEBUG)
Parameters
- buf
- org_names
Keywords
- INDEX
- DEBUG
top source Add_51s
result = Add_51s(buf, org_names, INDEX=INDEX, DEBUG=DEBUG)
Parameters
- buf
- org_names
Keywords
- INDEX
- DEBUG
top source Add_seconds
result = Add_seconds(buf, org_names, seconds=seconds, INDEX=INDEX, DEBUG=DEBUG)
Parameters
- buf
- org_names
Keywords
- seconds
- INDEX
- DEBUG
top source compute_magnitude
result = compute_magnitude(buf, org_names, INDEX=INDEX, DEBUG=DEBUG)
Parameters
- buf
- org_names
Keywords
- INDEX
- DEBUG
top source extract_array
result = extract_array(buf, org_names, INDEX=INDEX, DEBUG=DEBUG)
Parameters
- buf
- org_names
Keywords
- INDEX
- DEBUG
top source height_isis
result = height_isis(buf, org_names, index=index)
Parameters
- buf
- org_names
Keywords
- index
top source flip_image
result = flip_image(buf, org_names, index=index)
Parameters
- buf
- org_names
Keywords
- index
top source wind_plot
result = wind_plot(buf, org_names, index=index)
Parameters
- buf
- org_names
Keywords
- index
top source comp_epoch
result = comp_epoch(buf, org_names, index=index, DEBUG=DEBUG)
Parameters
- buf
- org_names
Keywords
- index
- DEBUG
top source comp_themis_epoch
result = comp_themis_epoch(buf, org_names, index=index, DEBUG=DEBUG, sixteen=sixteen)
Parameters
- buf
- org_names
Keywords
- index
- DEBUG
- sixteen
top source error_bar_array
result = error_bar_array(buf, index=index, value=value)
Parameters
- buf
Keywords
- index
- value
top source convert_toev
result = convert_toev(buf, org_names, index=index, DEBUG=DEBUG)
Parameters
- buf
- org_names
Keywords
- index
- DEBUG
top source convert_Ni
result = convert_Ni(buf, org_names, index=index, DEBUG=DEBUG)
Parameters
- buf
- org_names
Keywords
- index
- DEBUG
top source conv_pos_hungarian
result = conv_pos_hungarian(buf, org_names, INDEX=INDEX)
NAME: Function CONV_POS_HUNGARIAN PURPOSE: Convert cl_sp_aux positions x,y,z from GSE to GEI (GCI). It could be confusing to the user that the GSE positions are given in 'reference s/c position' and 'delta s/c positions' while all GEI positions will be their real positions, ie, no reference s/c and no deltas. INPUT: buf an IDL structure org_names an array of original variables sent to spdf_read_mycdf index variable position in buf CALLING SEQUENCE: newbuf = conv_pos_hungarian(buf,org_names,index=index)
Parameters
- buf
- org_names
Keywords
- INDEX
top source correct_FAST_By
result = correct_FAST_By(buf, org_names, INDEX=INDEX, DEBUG=DEBUG)
Parameters
- buf
- org_names
Keywords
- INDEX
- DEBUG
top source compute_cadence
result = compute_cadence(buf, org_names, INDEX=INDEX)
NAME: Function compute_cadence PURPOSE: Determine the resolution between epoch values so that one can easily see where the "burst" data is located. Originally implemented for the messenger_mag_rtn dataset. INPUT: buf an IDL structure org_names an array of original variables sent to spdf_read_mycdf index variable position in buf CALLING SEQUENCE: newbuf = compute_cadence(buf,org_names,index=index)
Parameters
- buf
- org_names
Keywords
- INDEX
top source apply_rtn_qflag
result = apply_rtn_qflag(astruct, orig_names, index=index)
Parameters
- astruct
- orig_names
Keywords
- index
top source apply_rtn_cadence
result = apply_rtn_cadence(astruct, orig_names, index=index)
Parameters
- astruct
- orig_names
Keywords
- index
top source expand_wave_data
result = expand_wave_data(astruct, org_names, INDEX=INDEX, DEBUG=DEBUG)
Parameters
- astruct
- org_names
Keywords
- INDEX
- DEBUG
File attributes
| Modification date: | Tue Oct 21 13:53:49 2014 |
| Lines: | 1,836 |