/* * 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 "@(#) fill_bins.c 1.18 05/08/19 SwRI" #include #include "user_defs.h" #include "libtrec_idfs.h" /******************************************************************************* * * * IR_FILL_BIN_ELEMENTS SUBROUTINE * * * * DESCRIPTION * * This routine is called in order to fill in any missing bins using the * * method requested by the user. The user may choose not to fill in the bins,* * that is, to leave the holes in the data which will possibly result in * * erroneous integration calculations. The user may chose to use a least * * square's fit algorithm or may choose to fill in the missing data values * * first by row and then by column or visa-versa using a linear or constant * * fit scheme. * * * * INPUT VARIABLES * * SDDAS_CHAR cyclic flag indicating if the data is cyclic * * SDDAS_CHAR project flag indicating if the data is to be * * projected to the end of the bins * * SDDAS_SHORT order the order of the fit (1, 2, 3, etc) * * SDDAS_LONG need_filled number of filled bins needed to perform the * * calculations to determine the missing value * * SDDAS_FLOAT tension the weighting of the data * * SDDAS_CHAR cur_buf the buffer being processed (0 - 4) * * * * USAGE * * ir_fill_bin_elements (cyclic, order, need_filled, tension, project, * * cur_buf) * * * * NECESSARY SUBPROGRAMS * * ir_least_fit_phi () performs a least square's fit on the phi * * data matrix (4D) * * ir_least_fit_theta () performs a least square's fit on the theta * * data matrix (3D) * * ir_constant_linear_phi () fills in the missing bins using a constant * * or linear interpolation of the rows and * * columns on the phi data matrix (4D) * * ir_constant_linear_theta () fills in the missing bins using a constant * * or linear interpolation of the rows and * * columns on the theta data matrix (3D) * * abs() returns the absolute value of a number * * * * 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 that holds * * *ex specific experiment information * * struct bin_info *bptr a pointer to the structure holding sweep * * binning information * * struct collapse_data pointer to the collapse_data structure * * *cptr being processed * * SDDAS_CHAR fill_method the fill missing bins method to be used * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ void ir_fill_bin_elements (SDDAS_CHAR cyclic, SDDAS_SHORT order, SDDAS_LONG need_filled, SDDAS_FLOAT tension, SDDAS_CHAR project, SDDAS_CHAR cur_buf) { extern struct general_info ginfo; struct experiment_info *ex; struct bin_info *bptr; struct collapse_data *cptr; SDDAS_CHAR fill_method; ex = ginfo.expt; bptr = ex->bin_ptr; cptr = ex->collapse_ptr; cptr->filled_phi_matrix[(SDDAS_SHORT)cur_buf] = 1; fill_method = bptr->bin_fill; /*********************************************************************/ /* If no phi dimension is being processed, reset the parameter to */ /* use non-cyclic calls. In addition, if there is no phi, the user */ /* can select a least squares fit only if averaging over theta and */ /* there are more than 5 bins. */ /*********************************************************************/ if (cptr->phi_bins == 1) cyclic = 0; if (fill_method == LEAST_SQ_FIT && cptr->phi_bins == 1) { if (abs(cptr->theta_bins) < 5) fill_method = LIN_COL_ROW; } /*********************************************************************/ /* The missing bins are to be filled using a least squares fit. */ /*********************************************************************/ if (fill_method == LEAST_SQ_FIT) { if (cptr->phi_bins != 1) ir_least_fit_phi (cyclic, order, need_filled, tension, cur_buf); else ir_least_fit_theta (order, need_filled, tension); } /*********************************************************************/ /* The missing bins are to be filled using either a constant or */ /* linear interpolation of the rows and columns. */ /*********************************************************************/ else if (fill_method == CON_ROW_COL || fill_method == CON_COL_ROW || fill_method == LIN_ROW_COL || fill_method == LIN_COL_ROW) { if (cptr->phi_bins != 1) ir_constant_linear_phi (cyclic, need_filled, fill_method, project, cur_buf); else ir_constant_linear_theta (need_filled, fill_method, project); } }