/* * 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_vwidth.c 1.15 05/08/19 SwRI" #include #include "ret_codes.h" #include "gen_defs.h" #include "user_defs.h" #include "libtrec_idfs.h" /******************************************************************************* * * * IR_SET_VWIDTH_INFO SUBROUTINE * * * * DESCRIPTION * * This routine is called in order to set up the information for variable * * width scan bins. If the user is not requested variable width bins, the * * user should pass in a zero for num_center, num_calc_band and num_upper_band* * arguments and should use char and short dummy pointers for placeholders. * * * * INPUT VARIABLES * * SDDAS_CHAR num_center number of tables to apply to get center values* * for variable width scan bins * * SDDAS_CHAR *center_tbls array of tables to be applied to get center * * values for variable width scan bins * * SDDAS_LONG *center_opers array of operations to be applied to tables * * for variable width scan bins * * SDDAS_CHAR num_calc_band number of tables to apply to get band values * * for variable width scan bins * * SDDAS_CHAR *band_tbls array of tables to be applied to get band * * values for variable width scan bins * * SDDAS_LONG *band_opers array of operations to be applied to tables * * for variable width scan bins * * SDDAS_CHAR num_upper_band number of tables to apply to get upper edge * * band values for variable width scan bins that * * specify the actual (fmt = 'A') values * * SDDAS_CHAR *upper_band_tbls array of tables to be applied to get band * * values for variable width scan bins that * * specify the actual (fmt = 'A') values * * SDDAS_LONG *upper_band_opers array of operations to be applied to * * tables for variable width scan bins that * * specify the actual (fmt = 'A') values * * SDDAS_CHAR vfmt the format flag for variable width band values* * * * USAGE * * x = ir_set_vwidth_info (num_center, center_tbls, center_opers, * * num_calc_band, band_tbls, band_opers, * * num_upper_band, upper_band_tbls, upper_band_opers,* * vfmt) * * * * NECESSARY SUBPROGRAMS * * sizeof () the size of the specified object in bytes * * malloc() allocates memory * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo 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 that holds sweep * * binning information * * register SDDAS_SHORT i looping variable * * size_t bytes the number of bytes to allocate * * size_t num_bytes_slong the number of bytes needed for a SDDAS_LONG * * size_t num_bytes_schar the number of bytes needed for a SDDAS_CHAR * * SDDAS_LONG offset offset into the allocated memory * * void *tmp_ptr pointer which holds address passed back by * * the call to the MALLOC routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_set_vwidth_info (SDDAS_CHAR num_center, SDDAS_CHAR *center_tbls, SDDAS_LONG *center_opers, SDDAS_CHAR num_calc_band, SDDAS_CHAR *band_tbls, SDDAS_LONG *band_opers, SDDAS_CHAR num_upper_band, SDDAS_CHAR *upper_band_tbls, SDDAS_LONG *upper_band_opers, SDDAS_CHAR vfmt) { extern struct general_info ginfo; struct experiment_info *ex; struct bin_info *bptr; register SDDAS_SHORT i; size_t bytes, num_bytes_slong, num_bytes_schar; SDDAS_LONG offset; void *tmp_ptr; ex = ginfo.expt; bptr = ex->bin_ptr; bptr->base_vcenter = NO_MEMORY; bptr->base_vband = NO_MEMORY; bptr->base_vupper_band = NO_MEMORY; bptr->center_tbls = NO_MEMORY; bptr->center_opers = NO_MEMORY; bptr->band_tbls = NO_MEMORY; bptr->band_opers = NO_MEMORY; bptr->upper_band_tbls = NO_MEMORY; bptr->upper_band_opers = NO_MEMORY; bptr->num_center = num_center; bptr->num_calc_bands = num_calc_band; bptr->num_upper_band = num_upper_band; bptr->vfmt = vfmt; num_bytes_slong = sizeof (SDDAS_LONG); num_bytes_schar = sizeof (SDDAS_CHAR); /************************************************************************/ /* Tables are specified to create the center values (used for variable */ /* width scan bins only). */ /************************************************************************/ if (num_center != 0) { bytes = (num_bytes_slong + num_bytes_schar) * num_center; if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (SET_VWIDTH_CENTER_MALLOC); bptr->base_vcenter = tmp_ptr; /* Cast base_vcenter to char * since void * and offset is in bytes. */ bptr->center_opers = (SDDAS_LONG *) bptr->base_vcenter; offset = num_center * num_bytes_slong; bptr->center_tbls = (SDDAS_CHAR *) ((SDDAS_CHAR *) bptr->base_vcenter + offset); for (i = 0; i < num_center; ++i) { *(bptr->center_tbls + i) = *(center_tbls + i); *(bptr->center_opers + i) = *(center_opers + i); } } /************************************************************************/ /* Tables are specified to create the band width values (used for */ /* variable width scan bins only). These values are offsets (deltas) */ /* to use from the computed center values. If the format is 'A' or */ /* 'a', then the tables return the actual values to use for the lower */ /* edge values (no computations off the center values). */ /************************************************************************/ if (num_calc_band != 0) { bytes = (num_bytes_slong + num_bytes_schar) * num_calc_band; if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (SET_VWIDTH_BAND_MALLOC); bptr->base_vband = tmp_ptr; /* Cast base_vband to char * since void * and offset is in bytes. */ bptr->band_opers = (SDDAS_LONG *) bptr->base_vband; offset = num_calc_band * num_bytes_slong; bptr->band_tbls = (SDDAS_CHAR *) ((SDDAS_CHAR *) bptr->base_vband + offset); for (i = 0; i < num_calc_band; ++i) { *(bptr->band_tbls + i) = *(band_tbls + i); *(bptr->band_opers + i) = *(band_opers + i); } } /************************************************************************/ /* When variable width scan bins specify the actual scan values */ /* (fmt = 'A'), there is the need to hold information for the upper */ /* scan edge values. This information specifies which tables are used */ /* to return the upper edge values (no computations off center values).*/ /* This specification is ONLY applicable to fmt = 'A' or 'a'. */ /************************************************************************/ if (num_upper_band != 0) { bytes = (num_bytes_slong + num_bytes_schar) * num_upper_band; if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (SET_VWIDTH_UPPER_BAND_MALLOC); bptr->base_vupper_band = tmp_ptr; /* Cast base_vupper_band to char * since void * and offset is in bytes. */ bptr->upper_band_opers = (SDDAS_LONG *) bptr->base_vupper_band; offset = num_upper_band * num_bytes_slong; bptr->upper_band_tbls = (SDDAS_CHAR *) ((SDDAS_CHAR *) bptr->base_vupper_band + offset); for (i = 0; i < num_upper_band; ++i) { *(bptr->upper_band_tbls + i) = *(upper_band_tbls + i); *(bptr->upper_band_opers + i) = *(upper_band_opers + i); } } return (ALL_OKAY); }