/* * 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 "@(#) discrete_phi.c 1.16 05/08/19 SwRI" #include "libtrec_idfs.h" /**************************************************************************** * * * IR_DISCRETE_PHI SUBROUTINE * * * * DESCRIPTION * * This routine is called in order to stuff data into the specified phi * * bins according to PPS step associated with each data sample. The PPS * * step is determined by the SAMP_INDEX value returned with each sample. * * 100% is the fraction used for bin percentage since data is stored by * * PPS. The data must further be multiplied by the percentage of the phi * * bin covered by the sample. * * * * INPUT VARIABLES * * SDDAS_FLOAT *dptr pointer to the data array * * SDDAS_FLOAT *tfrac pointer to the 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 * * register SDDAS_SHORT step starting = stopping sweep bins * * SDDAS_FLOAT *smnmx lower and upper data cutoff values * * SDDAS_FLOAT *fracs array of fraction bin coverages. There * * are 3 elements: (0) % of data in start phi * * bin; (1) % of data in end phi bin; (2) % * * data in time interval; * * * * USAGE * * ir_discrete_phi (&dptr, &tfrac, &bin_stat, &tmp_buf, smnmx, pbins, * * step, fracs) * * * * NECESSARY SUBPROGRAMS * * ir_stuff_phi () stuffs the data into specified bin within * * specified phi bin using the percentage of * * phi bin covered, the sweep percentage and * * time percentage * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure holding information concerning * * the experiment that is being processed * * * * INTERNAL VARIABLES * * struct experiment_info a pointer to the structure holding * * *ex specific experiment information * * 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 fast pointer to fracs array * * register SDDAS_FLOAT FRAC fraction of bin taken by data * * register SDDAS_LONG offset holds various offsets into arrays * * register SDDAS_LONG end loop terminator * * register SDDAS_SHORT *s1 fast pointer to pbins array * * * * SUBSYSTEM * * Display Level * * * * OPTIMAZATION STATUS * * Fully optimized: Note that now this routine assumes the following * * 1) phi band indicators are passed in as an array * * 2) data low and high limits are passed in as an array * * * * The above conditions are now placed on the calling routines * ***************************************************************************/ void ir_discrete_phi (SDDAS_FLOAT *dptr, SDDAS_FLOAT *tfrac, SDDAS_CHAR *bin_stat, SDDAS_FLOAT *tmp_buf, SDDAS_FLOAT *smnmx, SDDAS_SHORT *pbins, register SDDAS_SHORT step, SDDAS_FLOAT *fracs) { extern struct general_info ginfo; struct experiment_info *ex; struct collapse_data *cptr; struct bin_info *bptr; register SDDAS_FLOAT *f1, FRAC; register SDDAS_LONG offset, end; register SDDAS_SHORT *s1; /**********************************************************************/ /* Initialize pointers, determine the sweep bin to fill and set the */ /* sweep bin percentage to reflect that the entire bin is covered. */ /**********************************************************************/ ex = ginfo.expt; bptr = ex->bin_ptr; cptr = ex->collapse_ptr; f1 = fracs; s1 = pbins; /*********************************************************************/ /* The data value is contained within a single phi bin. */ /*********************************************************************/ if (*s1 == *(s1+1)) { offset = *s1 * bptr->num_bins + step; FRAC = *f1 * *(f1+2); ir_stuff_phi (dptr, tfrac, bin_stat, tmp_buf, smnmx, offset, FRAC); } /***************************************************************/ /* Starting aziumthal angle is less than the ending angle. */ /***************************************************************/ else { /**************************************************************/ /* Process the starting phi bin. */ /**************************************************************/ FRAC = *f1 * *(f1+2); offset = *s1 * bptr->num_bins + step; ir_stuff_phi (dptr, tfrac, bin_stat, tmp_buf, smnmx, offset, FRAC); /**************************************************************/ /* 100% of the data goes into the bins between the start and */ /* stop phi bins. */ /**************************************************************/ if (*s1 < *(s1+1)) { offset = (*s1 + 1) * bptr->num_bins + step; end = *(s1+1) * bptr->num_bins + step; for ( ; offset < end; offset += bptr->num_bins) ir_stuff_phi (dptr, tfrac, bin_stat, tmp_buf, smnmx, offset, *(f1+2)); } /***************************************************************/ /* 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 = (*s1 + 1) * bptr->num_bins + step; end = cptr->phi_bins * bptr->num_bins + step; for ( ; offset < end; offset += bptr->num_bins) ir_stuff_phi (dptr, tfrac, bin_stat, tmp_buf, smnmx, offset, *(f1+2)); /**************************************************************/ /* 100% of the data goes into the bins between the first */ /* defined phi bin and the stop bin location. */ /**************************************************************/ offset = step; end = *(s1+1) * bptr->num_bins + step; for ( ; offset < end; offset += bptr->num_bins) ir_stuff_phi (dptr, tfrac, bin_stat, tmp_buf, smnmx, offset, *(f1+2)); } /**************************************************************/ /* Process the stopping phi bin. */ /**************************************************************/ offset = *(s1+1) * bptr->num_bins + step; FRAC = *(f1+2) * *(f1+1); ir_stuff_phi (dptr, tfrac, bin_stat, tmp_buf, smnmx, offset, FRAC); } }