/* * 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 "@(#) set_cinfo.c 1.23 05/08/19 SwRI" #include #include "ret_codes.h" #include "gen_defs.h" #include "libtrec_idfs.h" /******************************************************************************* * * * SET_COLLAPSE_INFO SUBROUTINE * * * * DESCRIPTION * * This routine is called to allocate the space that is needed to hold * * information that is pertinent to the collapsing of the data over multiple * * dimensions. This routine should be called once for each unique data set * * that will collapse data over data dimensions. If memory for the data set * * has already been allocated, no action is taken. For each unique data set, * * the number of unique theta bins and the start/stop theta angles for each * * bin are determined. In addition, for each sensor, there is one short * * allocated to hold an index value that indicates which theta bin the data * * should be stored in when averaging over a theta range. * * * * INPUT VARIABLES * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_CHAR *exten filename extension for the data to be used * * SDDAS_USHORT vnum version number to be associated with this * * combination (allows for multiple opens) * * SDDAS_SHORT num_units the total number of units or data levels to * * be returned for all sensors (should be the * * same for all sensors) * * SDDAS_FLOAT delta_phi the requested resolution for the phi angle * * averaging (determines no. of bins) * * SDDAS_FLOAT *actual_phi the actual resolution used to bin the data * * for the phi angles * * SDDAS_CHAR interleave flag indicating if the data is to be inter- * * leaved (data not cleared out if missing on * * next sweep) * * * * USAGE * * x = set_collapse_info (data_key, exten, vnum, num_units, delta_phi, * * &actual_phi, interleave) * * * * NECESSARY SUBPROGRAMS * * malloc() allocates memory * * sizeof () the size of the specified object in bytes * * ir_locate_ex() determines if the requested combination has * * already been processed and points to the * * correct structure allocated for the combo * * ir_init_collapse_data() initializes a newly allocated collapse_data * * structure * * ir_calc_theta_bins() retrieves the start/stop theta angle for * * each uniquely defined theta bin * * ir_alloc_collapse_data () allocates the data matrices to be used to * * collapse the data over multiple dimensions * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure that holds 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 collapse_data pointer to the collapse_data structure being* * *cptr processed * * size_t bytes the number of bytes to allocate * * SDDAS_SHORT ret_val the value returned by the called routine * * SDDAS_SHORT phi_bins the number of phi bins to create * * void *tmp_ptr pointer which holds address passed back by * * the call to the MALLOC routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT set_collapse_info (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, SDDAS_SHORT num_units, SDDAS_FLOAT delta_phi, SDDAS_FLOAT *actual_phi, SDDAS_CHAR interleave) { extern struct general_info ginfo; struct experiment_info *ex; struct collapse_data *cptr; size_t bytes; SDDAS_SHORT ret_val, phi_bins; void *tmp_ptr; /***************************************************************************/ /* Check to see if the requested combination exists. Since a 0 is passed */ /* for the last parameter, the only possible error is that the combo was */ /* not found. */ /***************************************************************************/ if (!ginfo.called_locate) { ret_val = ir_locate_ex (data_key, exten, vnum, 0); if (ret_val != ALL_OKAY) return (COLLAPSE_NOT_FOUND); } /***********************************************************************/ /* If no previous collapse_data structure has been allocated, do so. */ /***********************************************************************/ ex = ginfo.expt; if (ex->bmem.base_collapse == NO_MEMORY) { bytes = sizeof (struct collapse_data); if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (COLLAPSE_MALLOC); ex->bmem.base_collapse = tmp_ptr; ex->collapse_ptr = (struct collapse_data *) ex->bmem.base_collapse; cptr = ex->collapse_ptr; /***********************************************************************/ /* The number of phi bins are determined. If no phi averaging is to */ /* performed, the user should pass in delta_phi as 360.00. */ /* Initialize the elements of the newly allocated structure. */ /***********************************************************************/ phi_bins = (SDDAS_SHORT) (360.000 / delta_phi + 0.5); *actual_phi = 360.00 / phi_bins; ir_init_collapse_data (num_units, phi_bins, *actual_phi, interleave); /**********************************************************************/ /* Allocate the space to hold the sensor specific index values. */ /**********************************************************************/ bytes = ex->num_sensor * sizeof (SDDAS_SHORT); if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (COLLAPSE_SEN_MALLOC); cptr->base_sen = tmp_ptr; cptr->sensor_bin = (SDDAS_SHORT *) cptr->base_sen; /**********************************************************************/ /* Determine the number of theta bins and the start/stop angles for */ /* each bin. */ /**********************************************************************/ ret_val = ir_calc_theta_bins (); if (ret_val != ALL_OKAY) return (ret_val); /**********************************************************************/ /* Allocate the space to hold the data matrices for the collapsing. */ /**********************************************************************/ ret_val = ir_alloc_collapse_data (); if (ret_val != ALL_OKAY) return (ret_val); } return (ALL_OKAY); }