ossimNitfImageHeaderV2_1.h

Go to the documentation of this file.

//*******************************************************************
// Copyright (C) 2000 ImageLinks Inc. 
//
// LICENSE: MIT
// 
// Author: Garrett Potts
// 
// Description: Nitf support class
// 
//********************************************************************
// $Id$

#ifndef ossimNitfImageHeaderV2_1_HEADER
#define ossimNitfImageHeaderV2_1_HEADER 1

#include <ossim/support_data/ossimNitfImageHeaderV2_X.h>
#include <ossim/support_data/ossimNitfImageBandV2_1.h>

class ossimNitfFileHeaderV2_1;
class OSSIMDLLEXPORT ossimNitfImageHeaderV2_1 : public ossimNitfImageHeaderV2_X
{
public:
   ossimNitfImageHeaderV2_1();
   virtual ~ossimNitfImageHeaderV2_1();

   virtual void parseStream(std::istream &in, const ossimNitfFileHeaderV2_1 *file);
   virtual void parseStream(std::istream &in);
   virtual void writeStream(std::ostream &out);
   virtual bool isValid()const;

   virtual std::ostream& print(std::ostream& out,
                               const std::string& prefix) const;
   
   virtual ossimIrect  getImageRect()const;   
   virtual ossimIrect  getBlockImageRect()const;   
   virtual bool        isCompressed()const;
   virtual bool        isEncrypted()const;

   virtual ossim_int32 getNumberOfBands()const;
   virtual ossim_int32 getNumberOfRows()const;
   virtual ossim_int32 getNumberOfCols()const;
   virtual ossim_int32 getNumberOfBlocksPerRow()const;
   virtual ossim_int32 getNumberOfBlocksPerCol()const;
   virtual ossim_int32 getNumberOfPixelsPerBlockHoriz()const;
   virtual ossim_int32 getNumberOfPixelsPerBlockVert()const;
   virtual ossimString getImageId()const;
   virtual ossim_int32 getBitsPerPixelPerBand()const;
   virtual ossim_int32 getActualBitsPerPixelPerBand()const;
   virtual ossimString getIMode()const;

   virtual ossimString  getImageDateAndTime() const;
   
   virtual ossimString getAcquisitionDateMonthDayYear(ossim_uint8 separationChar='-')const;
   virtual ossimString getSecurityClassification()const;
   virtual ossimString getCategory()const;
   virtual ossimString getRepresentation()const;
   virtual ossimString getCoordinateSystem()const;
   virtual ossimString getGeographicLocation()const;
   virtual ossimString getPixelValueType()const;

  virtual bool takeOverflowTags(std::vector<ossimNitfTagInformation> &overflowTags,
      ossim_uint32 potentialDesIndex, bool userDefinedTags = false);

   virtual bool hasBlockMaskRecords()const;
   virtual bool hasPadPixelMaskRecords()const;
   virtual bool hasTransparentCode()const;
   virtual ossim_uint32 getTransparentCode()const;
   virtual ossim_uint32 getBlockMaskRecordOffset(ossim_uint32 blockNumber,
                                                 ossim_uint32 bandNumber)const;
   virtual ossim_uint32 getPadPixelMaskRecordOffset(ossim_uint32 blockNumber,
                                                    ossim_uint32 bandNumber)const;
   
   virtual void setNumberOfBands(ossim_uint32 nbands);
   virtual void setBandInfo(ossim_uint32 idx,
                            const ossimNitfImageBandV2_1& info);
   
   virtual void setNumberOfRows(ossim_uint32 rows);
   virtual void setNumberOfCols(ossim_uint32 cols);

   virtual void setGeographicLocationDms(const ossimDpt& ul,
                                         const ossimDpt& ur,
                                         const ossimDpt& lr,
                                         const ossimDpt& ll);
   
   virtual void setGeographicLocationDecimalDegrees(const ossimDpt& ul,
                                                    const ossimDpt& ur,
                                                    const ossimDpt& lr,
                                                    const ossimDpt& ll);
   virtual void setUtmNorth(ossim_uint32 zone,
                            const ossimDpt& ul,
                            const ossimDpt& ur,
                            const ossimDpt& lr,
                            const ossimDpt& ll);
   virtual void setUtmSouth(ossim_uint32 zone,
                            const ossimDpt& ul,
                            const ossimDpt& ur,
                            const ossimDpt& lr,
                            const ossimDpt& ll);

   virtual void setSecurityClassificationSystem(const ossimString& value);
   virtual void setCodewords(const ossimString& value);
   virtual void setControlAndHandling(const ossimString& value);
   virtual void setReleasingInstructions(const ossimString& value);
   virtual void setDeclassificationType(const ossimString& value);
   virtual void setDeclassificationDate(const ossimString& value);
   virtual void setDeclassificationExempt(const ossimString& value);
   virtual void setDowngrade(const ossimString& value);
   virtual void setDowngradeDate(const ossimString& value);
   virtual void setClassificationText(const ossimString& value);
   virtual void setClassificationAuthorityType(const ossimString& value);
   virtual void setClassificationAuthority(const ossimString& value);
   virtual void setClassificationReason(const ossimString& value);
   virtual void setSecuritySourceDate(const ossimString& value);
   virtual void setSecurityControlNumber(const ossimString& value);
   virtual void setImageMagnification(const ossimString& value);
   
   virtual ossimString getImageSource()const; 
   
   virtual const ossimRefPtr<ossimNitfCompressionHeader> getCompressionHeader()const;
   virtual const ossimRefPtr<ossimNitfImageBand> getBandInformation(ossim_uint32 idx)const;
   
   virtual void setProperty(ossimRefPtr<ossimProperty> property);
   virtual ossimRefPtr<ossimProperty> getProperty(const ossimString& name)const;
   virtual void getPropertyNames(std::vector<ossimString>& propertyNames)const;

   virtual bool saveState(ossimKeywordlist& kwl, const ossimString& prefix="")const;

   virtual bool loadState(const ossimKeywordlist& kwl,
                          const char* prefix=0);
   
   static const ossimString ISCLSY_KW;
   static const ossimString ISCODE_KW;
   static const ossimString ISCTLH_KW;
   static const ossimString ISREL_KW;
   static const ossimString ISDCTP_KW;
   static const ossimString ISDCDT_KW;
   static const ossimString ISDCXM_KW;
   static const ossimString ISDG_KW;
   static const ossimString ISDGDT_KW;
   static const ossimString ISCLTX_KW;
   static const ossimString ISCATP_KW;
   static const ossimString ISCAUT_KW;
   static const ossimString ISCRSN_KW;
   static const ossimString ISSRDT_KW;
   static const ossimString ISCTLN_KW;
   static const ossimString XBANDS_KW;

private:
   void clearFields();

   ossimString encodeUtm(ossim_uint32 zone,
                         const ossimDpt& ul,
                         const ossimDpt& ur,
                         const ossimDpt& lr,
                         const ossimDpt& ll)const;

   char theSecurityClassificationSys[3];

   char theCodewords[12];

   char theControlAndHandling[3];

   char theReleasingInstructions[21];


   char theDeclassificationType[3];
   

   char theDeclassificationDate[9];

   char theDeclassificationExempt[5];
   
   char theDowngrade[2];

   char theDowngradeDate[9];

   char theClassificationText[44];

   char theClassificationAuthType[2];

   char theClassificationAuthority[41];

   char theClassificationReason[2];

   char theSecuritySourceDate[9];

   char theSecurityControlNumber[16];

  
   char theNumberOfMultispectralBands[6];

   std::vector<ossimRefPtr<ossimNitfImageBandV2_1> > theImageBands;

TYPE_DATA   
};

#endif