* * custom.F * * Jonathan Callahan * Feb 19th 1998 * * Returns A with its T axis replaced by a frequency axis. * * * In this subroutine we provide information about * the function. The user configurable information * consists of the following: * * descr Text description of the function * * num_args Required number of arguments * * axis_inheritance Type of axis for the result * ( CUSTOM, IMPLIED_BY_ARGS, NORMAL, ABSTRACT ) * CUSTOM - user defined axis * IMPLIED_BY_ARGS - same axis as the incoming argument * NORMAL - the result is normal to this axis * ABSTRACT - an axis which only has index values * * piecemeal_ok For memory optimization: * axes where calculation may be performed piecemeal * ( YES, NO ) SUBROUTINE custom_init(id) INCLUDE 'ferret_cmn/EF_Util.cmn' INTEGER id, arg * ********************************************************************** * USER CONFIGURABLE PORTION | * | * V CALL ef_set_desc(id,'multiply by 2 (test routine)' ) CALL ef_set_num_args(id, 1) CALL ef_set_axis_inheritance(id, IMPLIED_BY_ARGS, . IMPLIED_BY_ARGS, IMPLIED_BY_ARGS, CUSTOM) CALL ef_set_piecemeal_ok(id, YES, YES, YES, YES) arg = 1 CALL ef_set_arg_name(id, arg, 'X') CALL ef_set_arg_unit(id, arg, ' ') CALL ef_set_arg_desc(id, arg, ' ') CALL ef_set_axis_influence(id, arg, YES, YES, YES, NO) * ^ * | * USER CONFIGURABLE PORTION | * ********************************************************************** RETURN END SUBROUTINE custom_custom_axes(id) INCLUDE 'ferret_cmn/EF_Util.cmn' INTEGER id * ********************************************************************** * USER CONFIGURABLE PORTION | * | * * You could use utility functions at this point to get * grid information about the other arguments. This info * could be used to determine the custom axis lo/hi/del * information. CALL ef_set_custom_axis(id, T_AXIS, 0.0, 1000.0, 25.0, . 'Hertz', NO) * ^ * | * USER CONFIGURABLE PORTION | * ********************************************************************** RETURN END SUBROUTINE custom_result_limits(id) INCLUDE 'ferret_cmn/EF_Util.cmn' INTEGER id * ********************************************************************** * USER CONFIGURABLE PORTION | * | * V * You could use utility functions at this point to get * context information about the other arguments. This info * could be used to update the custom or abstract axis lo and hi * indices. * call ef_set_axis_limits(id, T_AXIS, 1, 40) * ^ * | * USER CONFIGURABLE PORTION | * ********************************************************************** RETURN END * In this subroutine we compute the result * SUBROUTINE custom_compute(id, arg_1, result) INCLUDE 'ferret_cmn/EF_Util.cmn' INCLUDE 'ferret_cmn/EF_mem_subsc.cmn' INTEGER id REAL bad_flag(EF_MAX_ARGS), bad_flag_result REAL arg_1(mem1lox:mem1hix, mem1loy:mem1hiy, . mem1loz:mem1hiz, mem1lot:mem1hit) REAL result(memreslox:memreshix, memresloy:memreshiy, . memresloz:memreshiz, memreslot:memreshit) * After initialization, the 'res_' arrays contain indexing information * for the result axes. The 'arg_' arrays will contain the indexing * information for each variable's axes. INTEGER res_lo_ss(4), res_hi_ss(4), res_incr(4) INTEGER arg_lo_ss(4,EF_MAX_ARGS), arg_hi_ss(4,EF_MAX_ARGS), . arg_incr(4,EF_MAX_ARGS) * ********************************************************************** * USER CONFIGURABLE PORTION | * | * V INTEGER i, j, k, l INTEGER i1, j1, k1, l1 CALL ef_get_res_subscripts(id, res_lo_ss, res_hi_ss, res_incr) CALL ef_get_arg_subscripts(id, arg_lo_ss, arg_hi_ss, arg_incr) CALL ef_get_bad_flags(id, bad_flag, bad_flag_result) i1 = arg_lo_ss(X_AXIS,ARG1) DO 400 i=res_lo_ss(X_AXIS), res_hi_ss(X_AXIS) j1 = arg_lo_ss(Y_AXIS,ARG1) DO 300 j=res_lo_ss(Y_AXIS), res_hi_ss(Y_AXIS) k1 = arg_lo_ss(Z_AXIS,ARG1) DO 200 k=res_lo_ss(Z_AXIS), res_hi_ss(Z_AXIS) l1 = arg_lo_ss(T_AXIS,ARG1) DO 100 l=res_lo_ss(T_AXIS), res_hi_ss(T_AXIS) IF ( arg_1(i1,j1,k1,l1) .EQ. bad_flag(1) ) THEN result(i,j,k,l) = bad_flag_result ELSE result(i,j,k,l) = arg_1(i1,j1,k1,l1) END IF l1 = l1 + arg_incr(T_AXIS,ARG1) 100 CONTINUE k1 = k1 + arg_incr(Z_AXIS,ARG1) 200 CONTINUE j1 = j1 + arg_incr(Y_AXIS,ARG1) 300 CONTINUE i1 = i1 + arg_incr(X_AXIS,ARG1) 400 CONTINUE * ^ * | * USER CONFIGURABLE PORTION | * ********************************************************************** RETURN END