/* * 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 "@(#) $Id: str_avg_cont.c 18621 2007-09-27 14:28:46Z carrie $ SwRI" #include "user_defs.h" #include "libIDFSMath.h" /***************************************************************************** * * * IDFSMATH_STR_AVG_CONT SUBROUTINE * * * * DESCRIPTION * * This routine is called to calculate a straight averge using contiguous * * band values. If the user-requested range is out of bounds, the value * * OUTSIDE_MIN is returned to indicate that no average was performed. * * * * INPUT VARIABLES * * SDDAS_FLOAT *band_val pointer to the band values * * SDDAS_FLOAT *data_val pointer to the data values * * SDDAS_LONG skip number of elements to add to get to next * * data element * * SDDAS_LONG terms number of bands * * SDDAS_FLOAT start starting value to average over * * SDDAS_FLOAT stop ending value to average over * * * * USAGE * * x = IDFSMath_str_avg_cont (band_val,data_val,skip,terms,start,stop) * * * * NECESSARY SUBPROGRAMS * * None * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * reg SDDAS_FLOAT *band_ptr pointer to band values * * reg SDDAS_FLOAT *data_ptr pointer to data values * * register SDDAS_FLOAT sum summation value of straight average * * register SDDAS_FLOAT norm normalization factor * * reg SDDAS_FLOAT *ptr_end loop termination variable * * SDDAS_LONG last_index index for last bin processed * * * * SUBSYSTEM * * Display Level * * * ****************************************************************************/ /*** STRAIGHT AVERAGE, CONTIGUOUS BAND VALUES ***/ SDDAS_FLOAT IDFSMath_str_avg_cont (SDDAS_FLOAT *band_val, SDDAS_FLOAT *data_val, SDDAS_LONG skip, SDDAS_LONG terms, SDDAS_FLOAT start, SDDAS_FLOAT stop) { register SDDAS_FLOAT *band_ptr, *data_ptr, sum, norm, *ptr_end; SDDAS_LONG last_index; sum = 0.0; norm = 0.0; ptr_end = band_val + terms; /* Increasing array of values? Look at first and last instead of first */ /* 2 values. Indexing by terms is okay since the array of band values */ /* are used and there is always one more element at the end. */ if (band_val[terms] > band_val[0]) { if (start >= band_val[terms]) return (OUTSIDE_MIN); band_ptr = band_val + 1; last_index = 0; /* keep index constant with last examined data */ data_ptr = data_val; /*** get to the beginning ***/ if (start > *band_val) { /* Guaranteed that this while loop will end before band_val[terms] */ /* due to earlier check of start against band_val[terms]. */ while ((band_ptr <= ptr_end) && (start >= *band_ptr)) { ++band_ptr; data_ptr += skip; ++last_index; } if (*data_ptr >= VALID_MIN) { sum = *data_ptr; norm = 1.0; } ++band_ptr; ++last_index; data_ptr += skip; } /* Since bands are increasing, wrap around scenario if start > stop */ /* so get the rest of the values from where the start value was found. */ if (stop < start) { while (band_ptr <= ptr_end) { if (*data_ptr >= VALID_MIN) { sum += *data_ptr; norm += 1.0; } ++band_ptr; ++last_index; data_ptr += skip; } band_ptr = band_val + 1; last_index = 0; /* keep index constant with last examined data */ data_ptr = data_val; } /* This comparison uses the upper edge of the band range associated */ /* with the data value as the inclusion / exclusion test, not whether */ /* the stop value falls within the band range. */ while ((band_ptr <= ptr_end) && (stop >= *band_ptr)) { if (*data_ptr >= VALID_MIN) { sum += *data_ptr; norm += 1.0; } ++band_ptr; ++last_index; data_ptr += skip; } /************************************************************************/ /* Do not include the current data value being examined if the stop */ /* value is a bin boundary value since the boundary has already been */ /* accounted for in the while above with the >= test. Since bins are */ /* back to back, the stop of the previous bin ends up being the start */ /* of the current bin so boundary value would be picked up twice. */ /************************************************************************/ if (stop < band_val[terms] && stop != band_val[last_index]) { /* Need to check conditional above 1st to ensure not past end of */ /* data array due to earlier while loop. */ if (*data_ptr >= VALID_MIN) { sum += *data_ptr; norm += 1.0; } } } else { if (start >= band_val[0]) return (OUTSIDE_MIN); band_ptr = band_val + terms - 1; data_ptr = data_val + (terms - 1) * skip; last_index = terms - 1; /* keep index constant with last examined data */ if (start > *(band_val + terms)) { while ((band_ptr >= band_val) && (start >= *band_ptr)) { --band_ptr; --last_index; data_ptr -= skip; } if (*data_ptr >= VALID_MIN) { sum = *data_ptr; norm = 1.0; } --band_ptr; --last_index; data_ptr -= skip; } if (stop < start) { while (band_ptr >= band_val) { if (*data_ptr >= VALID_MIN) { sum += *data_ptr; norm += 1.0; } --band_ptr; --last_index; data_ptr -= skip; } band_ptr = band_val + terms - 1; last_index = terms - 1; /* keep index constant with last examined data */ data_ptr = data_val + (terms - 1) * skip; } while ((band_ptr >= band_val) && (stop >= *band_ptr)) { if (*data_ptr >= VALID_MIN) { sum += *data_ptr; norm += 1.0; } --band_ptr; --last_index; data_ptr -= skip; } if (stop < band_val[0] && stop != band_val[last_index]) { /* Need to check conditional above 1st to ensure not past end of */ /* data array due to earlier while loop. */ if (*data_ptr >= VALID_MIN) { sum += *data_ptr; norm += 1.0; } } } if (norm < 1.0) { norm = 1.0; sum = OUTSIDE_MIN; } sum /= norm; return (sum); }