/* * 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 "@(#) stuff_phi.c 1.17 05/08/19 SwRI" #include "user_defs.h" #include "libtrec_idfs.h" /**************************************************************************** * * * IR_STUFF_PHI SUBROUTINE * * * * DESCRIPTION * * This routine is called in order to stuff the data into the specified * * phi bin. The data value is multiplied by the total fraction of the * * sweep bin, phi bin and and time covered by the data value. This * * fraction is computed external to this routine. The data is included * * only if it lies within the lower and upper cutoff range. If the data * * is external to this range, the bin status value is left alone and the * * data value is set as a signal to the collapsing routine to indicate * * that the bin was returned. A check is made of the bin status array to * * determine if the data is be stored "=" or summed "+=". The bin status * * value is 0 if no previous data has been placed into the bin element * * or can be set to a negative value by the collapsing routine to indicate * * that the data has been used. In these two cases, the bin should be * * replaced. If the bin status value is greater than zero, the current * * data should be added to the data that exists in the phi bin. * * * * INPUT VARIABLES * * reg SDDAS_FLOAT *dptr pointer to the data array * * reg SDDAS_FLOAT *tot_frac pointer to normalization factors * * reg SDDAS_CHAR *bin_stat pointer to the bin status array * * SDDAS_FLOAT *tmp_buf pointer to the converted data levels * * SDDAS_FLOAT *smnmx lower and upper data cutoff values * * register SDDAS_LONG offset offset to get to correct phi bin column * * includes sweep bin offset * * register SDDAS_FLOAT FRAC percentage of the time resolution times * * fraction of phi bin covered times the * * fraction of the sweep bin covered * * * * USAGE * * ir_stuff_phi (&dptr, &tot_frac, &bin_stat, &tmp_buf, smnmx, offset, * * FRAC) * * * * NECESSARY SUBPROGRAMS * * None * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * None * * * * SUBSYSTEM * * Display Level * * * * OPTIMAZATION STATUS * * Fully optimized: Note that now this routine assumes the following * * 1) total fraction data needs to be computed externally * * 2) offset into arrays is the combination of phi and sweep offsets * * 3) offsets into tmp_buf are handled externally * * 4) sensor minimum and maximum ranges for data inclusion form an * * array. * * * * The above conditions are now placed on the calling routines * ***************************************************************************/ void ir_stuff_phi (register SDDAS_FLOAT *dptr, register SDDAS_FLOAT *tot_frac, register SDDAS_CHAR *bin_stat, SDDAS_FLOAT *tmp_buf, SDDAS_FLOAT *smnmx, register SDDAS_LONG offset, register SDDAS_FLOAT FRAC) { /*******************************************************************/ /* Include only data values that fall within the cutoff range. */ /* TMP_BUF holds the data in converted units. */ /*******************************************************************/ if (*tmp_buf >= *smnmx && *tmp_buf <= *(smnmx+1)) { /************************************************************/ /* The bin status value will be 0 if no previous data has */ /* been placed into the bin element or will be set to a */ /* negative value by the collapsing routine to indicate */ /* that the data has been used so replace the bin. */ /************************************************************/ if (*(bin_stat + offset) <= 0) { *(dptr + offset) = *tmp_buf * FRAC; *(bin_stat + offset) = 1; *(tot_frac + offset) = FRAC; } else { *(dptr + offset) += *tmp_buf * FRAC; *(tot_frac + offset) += FRAC; } } /**************************************************/ /* Value is a "fill" value? Simply ignore. */ /**************************************************/ else if (*tmp_buf < VALID_MIN) return; /*********************************************************************/ /* If the data was excluded because of cutoff values, set the data */ /* value to a flagged value to indicate that the bin was returned */ /* (not missing). This is done if NO previous data has been placed */ /* into this bin. */ /*********************************************************************/ else if (*(bin_stat + offset) <= 0) *(dptr + offset) = OUTSIDE_MAX; }