Image_Data_Block.hh

Go to the documentation of this file.

/*  Image_Data_Block
 
HiROC CVS ID: Image_Data_Block.hh,v 1.13 2013/03/14 21:00:43 guym Exp
 
Copyright (C) 2006-2007 Arizona Board of Regents on behalf of the
Planetary Image Research Laboratory, Lunar and Planetary Laboratory at
the University of Arizona.
 
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License, version 2, as
published by the Free Software Foundation.
 
This program 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
General Public License for more details.
 
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
 
#ifndef _Image_Data_Block_
#define _Image_Data_Block_
 
#include    "PDS_Data_Block.hh"
 
#include <string>
 
namespace UA
{
namespace HiRISE
{
class Image_Data_Block
:   public PDS_Data_Block
{
public:
/*==============================================================================
    Constants:
*/
static const char* const ID;

static const char* const
    IMAGE_BANDS_PARAMETER_NAME;

static const char* const
    IMAGE_WIDTH_PARAMETER_NAME;

static const char* const
    IMAGE_HEIGHT_PARAMETER_NAME;

static const char* const
    PIXEL_BYTES_PARAMETER_NAME;

static const char* const
    PIXEL_BITS_PARAMETER_NAME;

static const char* const
    PIXEL_DATA_TYPE_PARAMETER_NAME;

static const char* const
    UNSIGNED_PIXEL_TYPE_IDENTIFIER;

static const char* const
    SIGNED_PIXEL_TYPE_IDENTIFIER;

static const char* const
    LSB_PIXEL_TYPE_IDENTIFIER;

static const char* const
    MSB_PIXEL_TYPE_IDENTIFIER;

static const char* const
    LINE_PREFIX_BYTES_PARAMETER_NAME;

static const char* const
    LINE_SUFFIX_BYTES_PARAMETER_NAME;
 
/*==============================================================================
    Constructors
*/
Image_Data_Block ();

Image_Data_Block
    (
    const idaeim::PVL::Aggregate&   parameters,
    std::ios::off_type              file_offset
    );

Image_Data_Block
   (
   const idaeim::PVL::Aggregate& parameters,
   const std::string& filename
   );
 
 
/*==============================================================================
    Accessors:
*/
unsigned int image_bands ()
{return Image_Bands;}

unsigned int image_width ()
{return Image_Width;}

unsigned int image_height ()
{return Image_Height;}

unsigned int pixel_bytes ()
{return Pixel_Bytes;}

unsigned int pixel_bits ()
{return Pixel_Bits;}

int signed_data ()
{return Signed_Data;}

int MSB_data ()
{return MSB_Data;}

unsigned int line_prefix_bytes ()
{return Line_Prefix_Bytes;}

unsigned int line_suffix_bytes ()
{return Line_Suffix_Bytes;}
 
std::string source_filename();
 
/*------------------------------------------------------------------------------
 * Manipulators
 */
std::string source_filename(std::string& pathname);
 
/*==============================================================================
    Data Members:
*/
protected:
 
 
virtual unsigned long long data_block_size ();
 
private:
 
std::string
    Source_Filename;
    
unsigned int
    Image_Bands,
    Image_Width,
    Image_Height,
    Pixel_Bytes,
    Pixel_Bits,
    Line_Prefix_Bytes,
    Line_Suffix_Bytes;

int
    Signed_Data,
    MSB_Data;
};
 
}   //  namespace HiRISE
}   //  namespace UA
#endif