/* * Copyright (C) 1998 by Southwest Research Institute (SwRI) * * All rights reserved under U.S. Copyright Law and International Conventions. * * The development of this Software was supported by contracts NAG5-3148, * NAG5-6855, NAS8-36840, NAG5-2323, and NAG5-7043 issued on behalf of * the United States Government by its National Aeronautics and Space * Administration. Southwest Research Institute grants to the Government, * and others acting on its behalf, a paid-up nonexclusive, irrevocable, * worldwide license to reproduce, prepare derivative works, and perform * publicly and display publicly, by or on behalf of the Government. * Other than those rights granted to the United States Government, no part * of this Software may be reproduced in any form or by any means, electronic * or mechanical, including photocopying, without permission in writing from * Southwest Research Institute. All inquiries should be addressed to: * * Director of Contracts * Southwest Research Institute * P. O. Drawer 28510 * San Antonio, Texas 78228-0510 * * * Use of this Software is governed by the terms of the end user license * agreement, if any, which accompanies or is included with the Software * (the "License Agreement"). An end user will be unable to install any * Software that is accompanied by or includes a License Agreement, unless * the end user first agrees to the terms of the License Agreement. Except * as set forth in the applicable License Agreement, any further copying, * reproduction or distribution of this Software is expressly prohibited. * Installation assistance, product support and maintenance, if any, of the * Software is available from SwRI and/or the Third Party Providers, as the * case may be. * * Disclaimer of Warranty * * SOFTWARE IS WARRANTED, IF AT ALL, IN ACCORDANCE WITH THESE TERMS OF THE * LICENSE AGREEMENT. UNLESS OTHERWISE EXPLICITLY STATED, THIS SOFTWARE IS * PROVIDED "AS IS", IS EXPERIMENTAL, AND IS FOR NON-COMMERCIAL USE ONLY, * AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR * PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT * SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. * * Limitation of Liability * * SwRI SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED AS A RESULT OF USING, * MODIFYING, CONTRIBUTING, COPYING, DISTRIBUTING, OR DOWNLOADING THIS * SOFTWARE. IN NO EVENT SHALL SwRI BE LIABLE FOR ANY INDIRECT, PUNITIVE, * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGE (INCLUDING LOSS OF BUSINESS, * REVENUE, PROFITS, USE, DATA OR OTHER ECONOMIC ADVANTAGE) HOWEVER IT ARISES, * WHETHER FOR BREACH OF IN TORT, EVEN IF SwRI HAS BEEN PREVIOUSLY ADVISED OF * THE POSSIBILITY OF SUCH DAMAGE. YOU HAVE SOLE RESPONSIBILITY FOR ADEQUATE * PROTECTION AND BACKUP OF DATA AND/OR EQUIPMENT USED IN CONNECTION WITH THE * SOFTWARE AND WILL NOT MAKE A CLAIM AGAINST SwRI FOR LOST DATA, RE-RUN TIME, * INACCURATE OUTPUT, WORK DELAYS OR LOST PROFITS RESULTING FROM THE USE OF * THIS SOFTWARE. YOU AGREE TO HOLD SwRI HARMLESS FROM, AND YOU COVENANT NOT * TO SUE SwRI FOR, ANY CLAIMS BASED ON USING THE SOFTWARE. * * Local Laws: Export Control * * You acknowledge and agree this Software is subject to the U.S. Export * Administration Laws and Regulations. Diversion of such Software contrary * to U.S. law is prohibited. You agree that none of the Software, nor any * direct product therefrom, is being or will be acquired for, shipped, * transferred, or reexported, directly or indirectly, to proscribed or * embargoed countries or their nationals, nor be used for nuclear activities, * chemical biological weapons, or missile projects unless authorized by U.S. * Government. Proscribed countries are set forth in the U.S. Export * Administration Regulations. Countries subject to U.S embargo are: Cuba, * Iran, Iraq, Libya, North Korea, Syria, and the Sudan. This list is subject * to change without further notice from SwRI, and you must comply with the * list as it exists in fact. You certify that you are not on the U.S. * Department of Commerce's Denied Persons List or affiliated lists or on the * U.S. Department of Treasury's Specially Designated Nationals List. You agree * to comply strictly with all U.S. export laws and assume sole responsibilities * for obtaining licenses to export or reexport as may be required. * * General * * These Terms represent the entire understanding relating to the use of the * Software and prevail over any prior or contemporaneous, conflicting or * additional, communications. SwRI can revise these Terms at any time * without notice by updating this posting. * * Trademarks * * The SwRI logo is a trademark of SwRI in the United States and other countries. * */ #ident "@(#) col_phi.c 1.23 05/08/19 SwRI" #include "gen_defs.h" #include "user_defs.h" #include "libtrec_idfs.h" #include "libIDFSMath.h" /******************************************************************************* * * * IR_COLLAPSE_PHI SUBROUTINE * * * * DESCRIPTION * * This routine is called in order to average data over the phi range * * specified. The data will be collapsed from a matrix indexed by three * * dimensions (phi, theta, sweep) into a matrix indexed by two dimension * * (theta and sweep). This module is called only if there are phi bins * * defined for the virtual instrument in question. The phi matrix may contain* * one column per sensor (theta) or may contain NUM_THETA columns, one for * * each defined theta bin (using initial and final elevation angle constants).* * The phi bins are set up as contiguous bands. A pointer to the memory that * * holds the resultant matrix is passed back to the calling module. This * * routine will work on one of the units or data levels for the current * * data set/extension/version combo being processed. * * * * INPUT VARIABLES * * SDDAS_FLOAT start_val starting phi value to collapse over * * SDDAS_FLOAT stop_val ending phi value to collapse over * * SDDAS_FLOAT **ret_data pointer to the resultant matrix * * SDDAS_CHAR avg_type averaging scheme to use for calculations * * SDDAS_CHAR int_type integration scheme to use for calculations * * SDDAS_SHORT unit_index value specifying which data level is to be * * processed * * SDDAS_CHAR norm_res flag indicating if the result is to be * * normalized * * SDDAS_INT power_sx the power of the extra "x" term or the power * * of the sin term * * SDDAS_INT power_c the power of the cos term * * SDDAS_CHAR cur_buf the buffer being processed (0 - 4) * * * * USAGE * * ir_collapse_phi (start_val, stop_val, avg_type, int_type, unit_index, * * &ret_data, norm_res, power_sx, power_c, cur_buf) * * * * NECESSARY SUBPROGRAMS * * IDFSMath_str_avg_cont () calculates a straight averge using contiguous * * band values * * IDFSMath_str_avg_cphi () calculates a straight averge for PHI values * * (0 to 360 roll-over) * * IDFSMath_trapezoidal_int () calculates a trapezoidal integral using * * contiguous band values * * IDFSMath_str_int_band_cont() calculates a band integral using contiguous* * band values * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * struct experiment_info a pointer to the structure that holds * * *ex specific experiment information * * struct collapse_data pointer to the collapse_data structure * * *cptr being processed * * reg SDDAS_FLOAT *dptr pointer to data matrix being accessed * * reg SDDAS_FLOAT *ret_ptr pointer to resultant data matrix * * reg SDDAS_FLOAT *f1 looping pointer variable * * reg SDDAS_FLOAT *stop_loop loop termination variable * * register SDDAS_SHORT theta looping variable over theta bins * * SDDAS_FLOAT *base_ptr ptr to phi matrix being processed * * SDDAS_FLOAT *base_3d_data ptr to theta matrix where the data is being * * stored * * SDDAS_LONG off_theta_4d offset to get to the theta column being * * processed in the input data matrix * * SDDAS_LONG off_theta_3d offset to get to the theta column being * * processed in the resultant data matrix * * SDDAS_LONG off_unit_4d offset to get to the beginning of the data * * matrix for the data level being processed * * SDDAS_LONG off_unit_3d offset to get to beginning of the resultant * * matrix for the data level being processed * * SDDAS_LONG phi_bins number of phi bins * * SDDAS_LONG num_steps number of sweep bins * * SDDAS_LONG next_theta_block no. of elements to get to next theta group * * SDDAS_SHORT num_theta number of theta bins * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ void ir_collapse_phi (SDDAS_FLOAT start_val, SDDAS_FLOAT stop_val, SDDAS_CHAR avg_type, SDDAS_CHAR int_type, SDDAS_SHORT unit_index, SDDAS_FLOAT **ret_data, SDDAS_CHAR norm_res, SDDAS_INT power_sx, SDDAS_INT power_c, SDDAS_CHAR cur_buf) { extern struct general_info ginfo; struct experiment_info *ex; struct collapse_data *cptr; register SDDAS_FLOAT *dptr, *ret_ptr, *f1, *stop_loop; register SDDAS_SHORT theta; SDDAS_FLOAT *base_ptr, *base_3d_data; SDDAS_LONG off_theta_4d, off_theta_3d, off_unit_4d, off_unit_3d; SDDAS_LONG phi_bins, num_steps, next_theta_block; SDDAS_SHORT num_theta; /************************************************************************/ /* Initialize pointers to the beginning of the input and resultant */ /* data matrices. */ /************************************************************************/ ex = ginfo.expt; cptr = ex->collapse_ptr; num_theta = (cptr->theta_bins <= 0) ? ex->num_sensor : cptr->theta_bins; base_3d_data = (cptr->theta_bins < 0) ? cptr->data_3d_separate : cptr->data_3d_binned; phi_bins = (SDDAS_LONG) cptr->phi_bins; num_steps = (SDDAS_LONG) ex->bin_ptr->num_bins; next_theta_block = num_steps * phi_bins; /**********************************************************************/ /* Process a single unit, one theta bin at a time. */ /**********************************************************************/ off_unit_4d = unit_index * (num_steps * num_theta * phi_bins); off_unit_3d = unit_index * (num_steps * num_theta); base_ptr = *(cptr->data_4d_ptr + cur_buf); off_theta_4d = 0; off_theta_3d = 0; for (theta = 0; theta < num_theta; ++theta, off_theta_3d += num_steps, off_theta_4d += next_theta_block) { dptr = base_ptr + off_unit_4d + off_theta_4d; ret_ptr = base_3d_data + off_unit_3d + off_theta_3d; stop_loop = dptr + num_steps; /******************************************************************/ /* Average over the phi bins one row at a time. */ /* In the called module, skip = number of elements to add to get */ /* to next data element, terms = number of bands. */ /******************************************************************/ if (avg_type == STRAIGHT_AVG) { for (f1 = dptr; f1 < stop_loop; ++ret_ptr, ++f1) *ret_ptr = IDFSMath_str_avg_cont (cptr->phi_bands, f1, num_steps, phi_bins, start_val, stop_val); } else if (avg_type == STRAIGHT_AVG_AZ) { for (f1 = dptr; f1 < stop_loop; ++ret_ptr, ++f1) *ret_ptr = IDFSMath_str_avg_cphi (cptr->phi_bands, f1, num_steps, phi_bins, start_val, stop_val); } /* By process of elimination, avg_type has to be either STRAIGHT_INT, */ /* SPHERICAL_INT, FLUX_INT or MOMENTS_INT so no need to check avg_type.*/ else if (int_type == POINT_INT) { for (f1 = dptr; f1 < stop_loop; ++ret_ptr, ++f1) *ret_ptr = IDFSMath_trapezoidal_int (cptr->phi_bands, f1, cptr->phi_bands_rad, cptr->phi_centers_rad, cptr->phi_sin_centers, cptr->phi_cos_centers, num_steps, phi_bins, start_val, stop_val, PHI_DIMEN, norm_res, power_sx, power_c); } else if (int_type == BAND_INT) { for (f1 = dptr; f1 < stop_loop; ++ret_ptr, ++f1) *ret_ptr = IDFSMath_str_int_band_cont (cptr->phi_bands, f1, num_steps, phi_bins, start_val, stop_val, PHI_DIMEN, norm_res, power_sx, power_c); } /* else if (avg_type == SPHERICAL_INT && int_type == POINT_INT) */ /* for (f1 = dptr; f1 < stop_loop;) */ /* *ret_ptr++ = ir_spherical_int_point_cont (cptr->phi_bands, f1++, */ /* num_steps, phi_bins, start_val, stop_val, */ /* norm_res); */ /* */ /* ir_spherical_int_point_cont () calculates spherical trapezoidal integral */ /* using contiguous band values */ /* module not used because hasn't been verified. */ } *ret_data = cptr->data_3d_binned; }