/* * 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 "@(#) band_phi.c 1.17 05/08/19 SwRI" #include "libtrec_idfs.h" /******************************************************************************* * * * IR_BAND_PHI SUBROUTINE * * * * DESCRIPTION * * This routine is called in order to stuff data into the specified phi * * bins according to sweep band covered by each data sample. Each sweep * * band is examined to determine which bin(s) the data sample lies with. * * If the sweep band for the sample is not found within the defined bands, * * the data is ignored. If sweep band is found, the data is placed into * * the appropriate bin(s). The data value is multiplied by fraction of * * the bin covered by the sweep band and by the percentage of the phi bin * * covered by the sample. * * * * INPUT VARIABLES * * SDDAS_FLOAT *dptr pointer to the data array * * SDDAS_FLOAT *tot_frac pointer to normalization factors * * SDDAS_CHAR *bin_stat pointer to the bin status array * * SDDAS_FLOAT *tmp_buf pointer to the converted data levels * * SDDAS_SHORT *pbins starting and stopping phi angle bins * * SDDAS_SHORT *sbins starting and stopping sweep bins * * SDDAS_FLOAT *smnmx lower and upper data cutoff values * * SDDAS_FLOAT *fracs array of fraction bin coverages. There * * are 5 elements: (0) % of data in start phi * * bin; (1) % of data in end phi bin; (2) % * * data in time interval; (3) % data in start * * sweep bin; (4) % data in end sweep bin * * * * USAGE * * ir_band_phi (&dptr, &tot_frac, &bin_stat, &tmp_buf, smnmx, pbins, sbins, * * fracs) * * * * NECESSARY SUBPROGRAMS * * ir_stuff_phi_band () stuffs the data into sweep bins specified * * within the specified phi bins using the * * percentage of phi bin covered, the sweep * * percentage and the time percentage * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure holding information concerning * * the experiment that is being processed * * * * INTERNAL VARIABLES * * struct collapse_data pointer to the collapse_data structure * * *cptr being processed * * struct bin_info *bptr a pointer to the structure holding sweep * * binning information * * register SDDAS_FLOAT *f1 pointer to fracs array * * register SDDAS_FLOAT *f2 pointer to FRAC array * * reg SDDAS_LONG offset_phi offset to get to correct phi bin column * * register SDDAS_LONG end loop terminator * * SDDAS_FLOAT FRAC array of 3 fractions; (0) time_frac times * * phi_frac times swp_sfrac; (1) time_frac * * times phi_frac; (2) time_frac times * * phi_frac times swp_efrac; * * * * SUBSYSTEM * * Display Level * * * * OPTIMAZATION STATUS * * Fully optimized: Note that now this routine assumes the following * * 1) all 5 fractional elements (2 phi, time, 2 sweep) are entered as a * * single array * * 2) both the phi and sweep bin ranges are handled as arrays * * 3) sensor minimum and maximum ranges for data inclusion form an * * array. * * * * The above conditions are now placed on the calling routines * * * * HANDLES * * This routine handles the demand that the phi offsets into * * stuff_phi_band() are offset into the correct phi bin * ******************************************************************************/ void ir_band_phi (SDDAS_FLOAT *dptr, SDDAS_FLOAT *tot_frac, SDDAS_CHAR *bin_stat, SDDAS_FLOAT *tmp_buf, SDDAS_FLOAT *smnmx, SDDAS_SHORT *pbins, SDDAS_SHORT *sbins, SDDAS_FLOAT *fracs) { extern struct general_info ginfo; struct collapse_data *cptr; register struct bin_info *bptr; register SDDAS_FLOAT *f1, *f2; register SDDAS_LONG offset_phi, end; SDDAS_FLOAT FRAC[3]; /********************************************************************/ /* Find the bin the sweep band is associated with. A value of -1 */ /* indicates that the value was not found amongst the calculated */ /* band widths. Set the last parameter to indicate no wrap-around */ /* scenario within a single sweep. This will result in the start */ /* bin being less than the stop bin. */ /********************************************************************/ bptr = ginfo.expt->bin_ptr; cptr = ginfo.expt->collapse_ptr; f1 = fracs; f2 = FRAC; if (pbins[0] == pbins[1]) { *(f2+1) = *f1 * *(f1+2); *f2 = *(f2+1) * *(f1+3); *(f2+2) = *(f2+1) * *(f1+4); offset_phi = pbins[0] * bptr->num_bins; ir_stuff_phi_band (dptr, tot_frac, bin_stat, tmp_buf, smnmx, offset_phi, sbins, f2); } /***************************************************************/ /* Starting aziumthal angle is less than the ending angle. */ /***************************************************************/ else { /**************************************************************/ /* Process the starting phi bin. */ /**************************************************************/ *(f2+1) = *f1 * *(f1+2); *f2 = *(f2+1) * *(f1+3); *(f2+2) = *(f2+1) * *(f1+4); offset_phi = pbins[0] * bptr->num_bins; ir_stuff_phi_band (dptr, tot_frac, bin_stat, tmp_buf, smnmx, offset_phi, sbins, f2); /**************************************************************/ /* 100% of the data goes into the bins between the start and */ /* stop phi bins. */ /**************************************************************/ *(f2+1) = *(f1+2); *f2 = *(f2+1) * *(f1+3); *(f2+2) = *(f2+1) * *(f1+4); if (pbins[0] < pbins[1]) { offset_phi = (pbins[0] + 1) * bptr->num_bins; end = pbins[1] * bptr->num_bins; for ( ; offset_phi < end; offset_phi += bptr->num_bins) ir_stuff_phi_band (dptr, tot_frac, bin_stat, tmp_buf, smnmx, offset_phi, sbins, f2); } /***************************************************************/ /* Starting aziumthal angle is greater than the ending angle */ /* indicating a wrap around scenario. */ /***************************************************************/ else { /**************************************************************/ /* 100% of the data goes into the bins between the start bin */ /* the last defined phi bin. */ /**************************************************************/ offset_phi = (pbins[0] + 1) * bptr->num_bins; end = cptr->phi_bins * bptr->num_bins; for ( ; offset_phi < end; offset_phi += bptr->num_bins) ir_stuff_phi_band (dptr, tot_frac, bin_stat, tmp_buf, smnmx, offset_phi, sbins, f2); /**************************************************************/ /* 100% of the data goes into the bins between the first */ /* defined phi bin and the stop bin location. */ /**************************************************************/ offset_phi = 0; end = pbins[1] * bptr->num_bins; for ( ; offset_phi < end; offset_phi += bptr->num_bins) ir_stuff_phi_band (dptr, tot_frac, bin_stat, tmp_buf, smnmx, offset_phi, sbins, f2); } /**************************************************************/ /* Process the stopping phi bin. */ /**************************************************************/ *(f2+1) = *(f1+2) * *(f1+1); *f2 = *(f2+1) * *(f1+3); *(f2+2) = *(f2+1) * *(f1+4); offset_phi = pbins[1] * bptr->num_bins; ir_stuff_phi_band (dptr, tot_frac, bin_stat, tmp_buf, smnmx, offset_phi, sbins, f2); } }