PDS_Projection_Data.hh

Go to the documentation of this file.

/*  PDS_Projection_Data
 
HiROC CVS ID: PDS_Projection_Data.hh,v 1.13 2020/05/22 20:59:29 guym Exp
 
Copyright (C) 2007  Arizona Board of Regents on behalf of the
Planetary Image Research Laboratory, Lunar and Planetary Laboratory at
the University of Arizona.
 
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License, version 2.1,
as published by the Free Software Foundation.
 
This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 
*******************************************************************************/
 
#ifndef _PDS_Projection_Data_
#define _PDS_Projection_Data_
 
#include    "PDS_Data.hh"
 
#include    "JP2_Box.hh"
#include    "Dimensions.hh"
 
//  GDAL/OGR
#include    <ogr_spatialref.h>
#include <gdal.h>
 
 
namespace UA
{
namespace HiRISE
{

class PDS_Projection_Data
:   public PDS_Data
{
public:
/*==============================================================================
    Constants:
*/
static const char* const
    ID;

static const char
    *PLANET_PARAMETER_NAME;
static const char
    *IMAGE_MAP_PROJECTION_GROUP_NAME;
static const char
    *PROJECTION_TYPE_PARAMETER_NAME;
static const char
    *COORDINATE_SYSTEM_PARAMETER_NAME;
static const char
    *LATITUDE_TYPE_PARAMETER_NAME;
static const char
    *HORIZONATAL_OFFSET_PARAMETER_NAME;
static const char
    *VERTICAL_OFFSET_PARAMETER_NAME;
static const char
    *IMAGE_HEIGHT_PARAMETER_NAME;
static const char
    *IMAGE_WIDTH_PARAMETER_NAME;
static const char
    *PIXELS_PER_DEGREE_PARAMETER_NAME;
static const char
    *PIXEL_SIZE_PARAMETER_NAME;
static const char
    *SEMI_MAJOR_RADIUS_PARAMETER_NAME;
static const char
    *SEMI_MINOR_RADIUS_PARAMETER_NAME;
static const char
    *FIRST_STANDARD_PARALLEL_PARAMETER_NAME;
static const char
    *SECOND_STANDARD_PARALLEL_PARAMETER_NAME; 
static const char
    *CENTER_LONGITUDE_PARAMETER_NAME;
static const char
    *CENTER_LATITUDE_PARAMETER_NAME;
static const char
    *MINIMUM_LATITUDE_PARAMETER_NAME;
static const char
    *MAXIMUM_LATITUDE_PARAMETER_NAME;
static const char
    *MINIMUM_LONGITUDE_PARAMETER_NAME;
static const char
    *MAXIMUM_LONGITUDE_PARAMETER_NAME;
static const char
    *PROJECTION_ROTATION_PARAMETER_NAME;
static const char
    *MISSING_CONSTANT_PARAMETER_NAME;
static const char
    *GDAL_NODATA_PARAMETER_NAME;

enum Projection_Type
    {
    UNKNOWN_PROJECTION  = -1,
    /*
        Well known projections are placed first in the list.
    */
    EQUIRECTANGULAR     = 0,
    POLAR_STEREOGRAPHIC,
    /*
        The remaining projections are listed alphabetically.
    */
    ALBERS,
    BONNE,
    CYLINDRICAL_EQUAL_AREA,
    GNOMONIC,
    LAMBERT_AZIMUTHAL_EQUAL_AREA,
    LAMBERT_CONFORMAL_CONIC,
    MERCATOR,
    MOLLWEIDE,
    OBLIQUE_CYLINDRICAL,
    ORTHOGRAPHIC,
    SINUSOIDAL,
    STEREOGRAPHIC,
    TRANSVERSE_MERCATOR,
    VANDERGRINTEN,
 
    TOTAL_PROJECTION_TYPES
    };

struct Projection_Definition
    {
    Projection_Type
        Code;

    static const int
        MAX_ARRAY_ENTRIES   = 8;
        
    const char*
        Aliases[MAX_ARRAY_ENTRIES];

    struct Required_Projection_Parameter
        {
        const char*
            SRS_Parameter_Name;
        const char*
            PDS_Parameter_Name;
        }
        Required_Parameters[MAX_ARRAY_ENTRIES];

    struct Default_Projection_Parameter
        {
        const char*
            SRS_Parameter_Name;
        double
            Value;
        }
        Default_Parameters[MAX_ARRAY_ENTRIES];
    };

static const Projection_Definition
    Projection_Definitions[TOTAL_PROJECTION_TYPES];

static const double
    DEFAULT_GEO_TIFF_TRANSFORM[6];

static const unsigned char
    GEO_TIFF_UUID[16];
 
/*==============================================================================
    Constructors:
*/
PDS_Projection_Data ();

PDS_Projection_Data (const PDS_Data& PDS_data);

PDS_Projection_Data (const std::string& pathname);

virtual ~PDS_Projection_Data ();
 
/*==============================================================================
    Accessors
*/
virtual PDS_Data& parameters (const std::string& pathname);

virtual PDS_Data& parameters (const idaeim::PVL::Aggregate& parameters);

const double* geo_transform () const
    {return Geo_Transform;}

OGRSpatialReference* spatial_reference () const
    {return Spatial_Reference ? Spatial_Reference->Clone () : NULL;}

Projection_Type projection_type () const
    {return Projection_Type_Code;}


    definitions} and use the first entry in the Aliases array:
 
<pre>
    string
        formal_projection_name;
    if (projection_type () != UNKNOWN_PROJECTION)
        formal_projection_name =
            Projection_Definitions[projection_type ()].Aliases[0];
</pre>
 
    @return A string having the formal name of the applicable projection.
        If a projection could not be {@link
        initialize_spatial_reference() initialized} this will be an empty
        string.
*/
std::string projection_name () const
    {return Projection_Name;}
 
/*==============================================================================
    Manipulators
*/
PDS_Projection_Data& initialize_geo_transform ();

PDS_Projection_Data& initialize_spatial_reference ();
 
/*==============================================================================
    JP2 Boxes
*/
JP2_Box* JP2_GeoTIFF () const;

JP2_Box* JP2_GML
    (unsigned int image_width = 0, unsigned int image_height = 0) const;
 
/*==============================================================================
    Helpers
*/
static bool named_in_list (std::string name, const char* const* aliases);

static Projection_Type projection_type (const std::string& projection_name);
 
/*==============================================================================
    Data Members:
*/
protected:

std::string
    Projection_Name;

Projection_Type
    Projection_Type_Code;

OGRSpatialReference
    *Spatial_Reference;

double
    Geo_Transform[6];
 
};  //  End class PDS_Projection_Data
 
}   //  namespace HiRISE
}   //  namespace UA
#endif