/* * 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 "@(#) sum_disc.c 1.1 05/08/19 SwRI" #include "user_defs.h" #include "libtrec_idfs.h" /***************************************************************************** * * * IR_SUMMATION_DISC SUBROUTINE * * * * DESCRIPTION * * This routine is called to calculate a summation using non-contiguous * * bin values. This module will only be used for the charge and mass * * dimensions when the data is collapsed IF the bins are defined as non- * * contiguous bins. In this case, like theta, the range of each "bin" or * * "bucket" will be defined for each sensor in the constants section of the * * VIDF file so the assumption is that the buckets are non-contiguous. * * Since a summation is being performed, there is no need for a * * normalization factor to see how much each bin contributed. In other * * words, it does not matter if all sensors map to the same bucket or if * * the sensors mapped to separate unique buckets, the summation will yield * * the total of all contributors. Code works for both increasing bin pairs * * and decreasing bin pairs, e.g. {[0, 4], [5, 9], [10, 14]} or * * {[10,14], [5, 9], [0, 4]}. * * * * INPUT VARIABLES * * SDDAS_FLOAT *low_edge pointer to lower edges of bins * * SDDAS_FLOAT *high_edge pointer to upper edges of bins * * SDDAS_FLOAT *data_ptr pointer to the data values * * SDDAS_LONG skip number of elements to add to get to next * * data element * * SDDAS_LONG terms number of elements in the bins * * SDDAS_FLOAT start starting value to sum over * * SDDAS_FLOAT stop ending value to sum over * * * * USAGE * * x = ir_summation_disc (low_edge, high_edge, data_ptr, skip, terms, * * start, stop) * * * * NECESSARY SUBPROGRAMS * * None * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * reg SDDAS_FLOAT *low_bin pointer to lower bin values * * reg SDDAS_FLOAT *high_bin pointer to upper bin values * * reg SDDAS_FLOAT *dptr pointer to data values * * reg SDDAS_FLOAT *dptr_end loop termination variable * * SDDAS_FLOAT suma summation value * * SDDAS_FLOAT t_stop value used to terminate summation * * SDDAS_LONG count counter for number of values processed * * * * SUBSYSTEM * * Display Level * * * ****************************************************************************/ SDDAS_FLOAT ir_summation_disc (SDDAS_FLOAT *low_edge, SDDAS_FLOAT *high_edge, SDDAS_FLOAT *data_ptr, SDDAS_LONG skip, SDDAS_LONG terms, SDDAS_FLOAT start, SDDAS_FLOAT stop) { register SDDAS_FLOAT *low_bin, *high_bin, *dptr, *dptr_end; SDDAS_FLOAT suma, t_stop; SDDAS_LONG count; /************************************************************************/ /* This code was cloned off ir_str_avg_disc() with some minor changes: */ /* (1) sums was replaced by an integer counter called COUNT. */ /* (2) normalization before return to calling module was removed. */ /* (3) variable names were renamed to be more meaningful. */ /************************************************************************/ suma = 0.0; count = 0; if (high_edge[0] > low_edge[0]) { low_bin = low_edge; high_bin = high_edge; } else { low_bin = high_edge; high_bin = low_edge; } /***********************************************************************/ /* If the user-requested start value is greater than the stop value */ /* (e.g. 355 - 5), modify values so that summation is broken up into */ /* two parts: (1) start value to high_bin[N-1] and (2) low_bin[0] to */ /* stop value. */ /***********************************************************************/ dptr = data_ptr; t_stop = (start > stop) ? *(high_bin + terms - 1) : stop; dptr_end = data_ptr + terms * skip; while (dptr < dptr_end) { if ((start < *high_bin) && (t_stop > *low_bin) && (*dptr >= VALID_MIN)) { suma += *dptr; count += 1; } ++low_bin; ++high_bin; dptr += skip; } /***********************************************************************/ /* This part of the code handles second part of summation (low_bin[0] */ /* to stop value) for case where the user-requested start value is */ /* greater than the stop value (e.g. 355 - 5). */ /***********************************************************************/ if (start > stop) { if (high_edge[0] > low_edge[0]) { low_bin = low_edge; high_bin = high_edge; } else { low_bin = high_edge; high_bin = low_edge; } dptr = data_ptr; start = *low_bin; while (dptr < dptr_end) { if ((start < *high_bin) && (stop > *low_bin) && (*dptr >= VALID_MIN)) { suma += *dptr; count += 1; } ++low_bin; ++high_bin; dptr += skip; } } /***********************************************************************/ /* If no value included in summation range, flag as "no data". */ /***********************************************************************/ if (count == 0) suma = OUTSIDE_MIN; return (suma); }