/* * 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 "@(#) col_scalar.c 1.17 05/08/19 SwRI" #include "user_defs.h" #include "libtrec_idfs.h" #include "libIDFSMath.h" /******************************************************************************* * * * IR_COLLAPSE_SCALAR SUBROUTINE * * * * DESCRIPTION * * This routine is called to average together sensor data from scalar * * instruments. The sensors must be continuous, but they may be cyclic. In * * other words the user may ask to average from sensor 4 to 1, which would * * average together sensors 4 - NUM_SEN and 0 to 1, with NUM_SEN being the * * number of defined sensors for the virtual instrument in question. A * * straight average is to the only type of averaging scheme to be utilized * * and the bins are set up to be contiguous bands, from 0 to NUM_SEN. A * * pointer to the memory that holds the result is passed back to the calling * * module. This routine will work on one of the units or data levels for the * * current project/mission/experiment/virtual/extension/version combo being * * processed. * * * * INPUT VARIABLES * * SDDAS_SHORT unit_index value specifying which data level is to be * * processed * * SDDAS_FLOAT start_val starting sensor value to collapse over * * SDDAS_FLOAT stop_val ending sensor value to collapse over * * SDDAS_FLOAT **ret_data pointer to the result * * * * USAGE * * ir_collapse_scalar (start_val, stop_val, unit_index, &ret_data) * * * * NECESSARY SUBPROGRAMS * * IDFSMath_str_avg_cont () calculates a straight averge using contiguous * * band values * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure that holds information concerning * * the experiment that is being processed * * SDDAS_FLOAT ir_conv_fill[] temporary array that holds the bin values * * * * INTERNAL VARIABLES * * struct experiment_info a pointer to the structure that holds * * *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 that holds sweep * * binning information * * register SDDAS_FLOAT *dptr pointer to data being accessed * * SDDAS_FLOAT *theta_data pointer to correct theta bins * * register SDDAS_SHORT step looping variable to create the band values * * SDDAS_LONG offset_unit offset to get to the beginning of the data * * matrix for the data level being processed * * SDDAS_SHORT num_theta number of theta bins * * SDDAS_SHORT num_bins number of sweep bins * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ void ir_collapse_scalar (SDDAS_FLOAT start_val, SDDAS_FLOAT stop_val, SDDAS_SHORT unit_index, SDDAS_FLOAT **ret_data) { extern struct general_info ginfo; extern SDDAS_FLOAT ir_conv_fill[]; struct experiment_info *ex; struct collapse_data *cptr; struct bin_info *bptr; register SDDAS_FLOAT *dptr; register SDDAS_SHORT step; SDDAS_FLOAT *theta_data; SDDAS_LONG offset_unit; SDDAS_SHORT num_theta, num_bins; /************************************************************************/ /* Initialize pointers to the correct unit being processed. */ /************************************************************************/ ex = ginfo.expt; bptr = ex->bin_ptr; cptr = ex->collapse_ptr; num_bins = bptr->num_bins; num_theta = (cptr->theta_bins <= 0) ? ex->num_sensor : cptr->theta_bins; offset_unit = unit_index * (num_bins * num_theta); /***********************************************************************/ /* Is there a "duplicate theta" issue? If so, data / bin status is */ /* separated per sensor, not per theta bin. */ /***********************************************************************/ if (cptr->theta_bins < 0) theta_data = cptr->data_3d_separate; else theta_data = cptr->data_3d_binned; dptr = theta_data + offset_unit; /**********************************************************************/ /* Set up contiguous bands from 0 to N_SEN, inclusive, and always */ /* use a straight average calculation. */ /**********************************************************************/ for (step = 0; step <= ex->num_sensor; ++step) ir_conv_fill[step] = step; cptr->data_1d = IDFSMath_str_avg_cont (ir_conv_fill, dptr, (SDDAS_LONG) 1, num_theta, start_val, stop_val); *ret_data = &cptr->data_1d; }