PDS_Converter.hh

Go to the documentation of this file.

/*  PDS_Converter

HiROC CVS ID: PDS_Converter.hh,v 1.16 2012/01/24 03:08:13 castalia 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_Converter_
#define _PDS_Converter_

#include    "PDS_Data.hh"
#include    "Image_Data_Block.hh"
#include    "Dimensions.hh"

namespace UA
{
namespace HiRISE
{
class PDS_Converter
:   public PDS_Data
{
public:
/*==============================================================================
    Constants:
*/
static const char* const
    ID;

static const char
    *DEFAULT_PRODUCT_TYPE;

static const char
    *UNCOMPRESSED_FILE_PARAMETERS_GROUP;

static const char
    *COMPRESSED_FILE_PARAMETERS_GROUP;

//  Common additional parameters:

static const char
    *GeoTIFF_PARAMETER_NAME;
static const char
    *GML_PARAMETER_NAME;
static const char
    *NO_VERSION_CHANGE_PARAMETER_NAME;

/*==============================================================================
    Constructors:
*/
PDS_Converter ();

explicit PDS_Converter (const std::string& pathname,
    const char** excluded_names = NULL, const char** image_names = NULL);

PDS_Converter (const PDS_Converter& converter);

virtual PDS_Converter& operator= (const PDS_Converter& converter);

virtual ~PDS_Converter ();

/*==============================================================================
    Manipulators:
*/
virtual void write_PDS_JP2_label
    (
    const std::string&  PDS_label_pathname,
    const std::string&  JP2_pathname,
    const char**        removed_parameter_names = NULL,
    PDS_Data*           additional_parameters = NULL
    ) = 0;

virtual void write_PDS_label
    (
    const std::string&  PDS_label_pathname,
    const Rectangle*    image_region = NULL,
    unsigned int        resolution_level = 1,
    const char**        removed_parameter_names = NULL,
    PDS_Data*           additional_parameters = NULL
    ) = 0;

/*==============================================================================
    Accessors:
*/
virtual std::string product_names () const;

virtual bool label_recognized () const = 0;

PDS_Converter& label_size (unsigned int size)
    {Label_Size = size; return *this;}

unsigned int label_size () const
    {return Label_Size;}

PDS_Data::PDS_Data_Block_List* data_blocks () const
    {return Data_Blocks;}

void refresh_data_blocks ();

Image_Data_Block* image_data ();

PDS_Converter& excluded_data_block_names (const char** names);

const char** excluded_data_block_names () const
    {return Excluded_Data_Block_Names;}

PDS_Converter& image_data_block_names (const char** names);

const char** image_data_block_names () const
    {return Image_Data_Block_Names;}

/*==============================================================================
    Helpers:
*/
idaeim::PVL::Aggregate* PDS_JP2_image_parameters
    (const std::string& JP2_pathname);

unsigned int
write_label
    (
    const std::string&      pathname,
    PDS_Data&               label,
    idaeim::PVL::Lister*    lister = NULL,
    bool                    pad_label = false
    );


protected:

void clear_data_blocks ();

/*==============================================================================
    Data Members:
*/
protected:

const char**
    Excluded_Data_Block_Names;

PDS_Data::PDS_Data_Block_List
    *Data_Blocks;

const char**
    Image_Data_Block_Names;

Image_Data_Block
    *IMAGE_Data_Block;

unsigned int
    Label_Size;

};  //  End class PDS_Converter

}   //  namespace HiRISE
}   //  namespace UA
#endif