MtkGenericMapInfo.c

Go to the documentation of this file.

/*===========================================================================
=                                                                           =
=                          MtkGenericMapInfo                                =
=                                                                           =
=============================================================================

                         Jet Propulsion Laboratory
                                   MISR
                               MISR Toolkit

            Copyright 2008, California Institute of Technology.
                           ALL RIGHTS RESERVED.
                 U.S. Government Sponsorship acknowledged.

============================================================================*/

#include "MisrMapQuery.h"
#include "MisrUtil.h"
#include <stdlib.h>
#include <math.h>

MTKt_status MtkGenericMapInfo(
  double Min_x,  
  double Min_y,  
  double Resolution_x,  
  double Resolution_y,  
  int Number_pixel_x,   
  int Number_pixel_y,   
  MTKt_OriginCode Origin_code,  
  MTKt_PixRegCode Pix_reg_code, 
  MTKt_GenericMapInfo *Map_info 
)
{
  MTKt_status status_code;      /* Return status of this function */
  MTKt_GenericMapInfo map_info_tmp = MTKT_GENERICMAPINFO_INIT;
                /* Map information */

  /* ------------------------------------------------------------------ */
  /* Argument check: Resolution_x <= 0.0                                */
  /*                 Resolution_y <= 0.0                                */
  /* ------------------------------------------------------------------ */

  if (Resolution_x <= 0.0) {
    MTK_ERR_CODE_MSG_JUMP(MTK_OUTBOUNDS,"Resolution_x <= 0.0");
  }
  if (Resolution_y <= 0.0) {
    MTK_ERR_CODE_MSG_JUMP(MTK_OUTBOUNDS,"Resolution_y <= 0.0");
  }

  /* ------------------------------------------------------------------ */
  /* Argument check: Number_pixel_x < 1                                 */
  /*                 Number_pixel_y < 1                                 */
  /* ------------------------------------------------------------------ */

  if (Number_pixel_x < 1) {
    MTK_ERR_CODE_MSG_JUMP(MTK_OUTBOUNDS,"Number_pixel_x < 1");
  }
  if (Number_pixel_y < 1) {
    MTK_ERR_CODE_MSG_JUMP(MTK_OUTBOUNDS,"Number_pixel_y < 1");
  }

  /* ------------------------------------------------------------------ */
  /* Argument check: Map_info == NULL                                  */
  /* ------------------------------------------------------------------ */

  if (Map_info == NULL) {
    MTK_ERR_CODE_MSG_JUMP(MTK_NULLPTR,"Map_info == NULL");
  }

  /* ------------------------------------------------------------------ */
  /* Initialize map information.                                        */
  /* ------------------------------------------------------------------ */

  map_info_tmp.min_x = Min_x;
  map_info_tmp.min_y = Min_y;
  map_info_tmp.max_x = Min_x + Number_pixel_x * Resolution_x;
  map_info_tmp.max_y = Min_y + Number_pixel_y * Resolution_y;
  map_info_tmp.resolution_x = Resolution_x;
  map_info_tmp.resolution_y = Resolution_y;
  map_info_tmp.pix_reg_code = Pix_reg_code;
  map_info_tmp.origin_code = Origin_code;

  /* ------------------------------------------------------------------ */
  /* Setup transform coefficients for converting between map            */
  /* coordinates and pixel coordinates.                                 */
  /*                                                                    */
  /* Argument_check: Unsupported Origin_code                            */
  /* Argument_check: Unsupported Pix_reg_code                           */
  /* ------------------------------------------------------------------ */

  switch(Origin_code) {
  case MTKe_ORIGIN_UL: 
    map_info_tmp.size_line = Number_pixel_y;
    map_info_tmp.size_sample = Number_pixel_x;
    map_info_tmp.tsample[0] = 1; 
    map_info_tmp.tsample[1] = -map_info_tmp.min_x;
    map_info_tmp.tline[0] = -1;
    map_info_tmp.tline[1] = map_info_tmp.max_y;
    map_info_tmp.tline[3] = map_info_tmp.resolution_y;
    map_info_tmp.tsample[3] = map_info_tmp.resolution_x;
    break;
  case MTKe_ORIGIN_UR:
    map_info_tmp.size_line = Number_pixel_x;
    map_info_tmp.size_sample = Number_pixel_y;
    map_info_tmp.tline[0] = -1; 
    map_info_tmp.tline[1] = map_info_tmp.max_x;
    map_info_tmp.tsample[0] = -1;
    map_info_tmp.tsample[1] = map_info_tmp.max_y;
    map_info_tmp.tline[3] = map_info_tmp.resolution_x;
    map_info_tmp.tsample[3] = map_info_tmp.resolution_y;
    break;
  case MTKe_ORIGIN_LL:
    map_info_tmp.size_line = Number_pixel_x;
    map_info_tmp.size_sample = Number_pixel_y;
    map_info_tmp.tline[0] = 1; 
    map_info_tmp.tline[1] = -map_info_tmp.min_x;
    map_info_tmp.tsample[0] = 1;
    map_info_tmp.tsample[1] = -map_info_tmp.min_y;
    map_info_tmp.tline[3] = map_info_tmp.resolution_x;
    map_info_tmp.tsample[3] = map_info_tmp.resolution_y;
    break;
  case MTKe_ORIGIN_LR:
    map_info_tmp.size_line = Number_pixel_y;
    map_info_tmp.size_sample = Number_pixel_x;
    map_info_tmp.tsample[0] = -1; 
    map_info_tmp.tsample[1] = map_info_tmp.max_x;
    map_info_tmp.tline[0] = 1;
    map_info_tmp.tline[1] = -map_info_tmp.min_y;
    map_info_tmp.tline[3] = map_info_tmp.resolution_y;
    map_info_tmp.tsample[3] = map_info_tmp.resolution_x;
    break;
  default:
    MTK_ERR_CODE_MSG_JUMP(MTK_OUTBOUNDS,"Unsupported Origin_code");
  }

  switch(Pix_reg_code) {
  case MTKe_PIX_REG_CORNER: 
    map_info_tmp.tline[2] = map_info_tmp.tsample[2] = 0.0;
    break;
  case MTKe_PIX_REG_CENTER:
    map_info_tmp.tline[2] = map_info_tmp.tsample[2] = -0.5;
    break;
  default:
    MTK_ERR_CODE_MSG_JUMP(MTK_OUTBOUNDS,"Unsupported Pix_reg_code");
  }

  /* ------------------------------------------------------------------ */
  /* Return.                                                            */
  /* ------------------------------------------------------------------ */

  *Map_info = map_info_tmp;
  return MTK_SUCCESS;

ERROR_HANDLE:
  return status_code;
}