ossimNitfImageHeaderV2_X.h

Go to the documentation of this file.

#ifndef ossimNitfImageHeaderV2_X_HEADER
#define ossimNitfImageHeaderV2_X_HEADER 1
#include <ossim/base/ossimConstants.h>
#include <ossim/support_data/ossimNitfImageHeader.h>
#include <string>

class OSSIM_DLL ossimNitfImageHeaderV2_X : public ossimNitfImageHeader
{
public:
   ossimNitfImageHeaderV2_X();

   virtual ossimIrect  getImageRect()const;

   virtual ossimIrect  getBlockImageRect()const;
   
   void setImageId(const ossimString& value);
   void setAquisitionDateTime(const ossimString& value);
   void setTargetId(const ossimString& value);
   void setTitle(const ossimString& value);
   void setSecurityClassification(const ossimString& value);
   void setEncryption(const ossimString& value);
   void setImageSource(const ossimString& value);
   void setJustification(const ossimString& value);
   void setCoordinateSystem(const ossimString& value);
   void setGeographicLocation(const ossimString& value);
   void setNumberOfComments(const ossimString& value);
   void setCompression(const ossimString& value);
   void setCompressionRateCode(const ossimString& value);
   void setDisplayLevel(const ossimString& value);
   void setAttachmentLevel(const ossimString& value);
   void setPixelType(const ossimString& pixelType = ossimString("INT"));
   void setBitsPerPixel(ossim_uint32 bitsPerPixel);
   void setActualBitsPerPixel(ossim_uint32 bitsPerPixel);
   void setImageMode(char mode);
   void setCategory(const ossimString& category);
   void setRepresentation(const ossimString& rep);
   void setBlocksPerRow(ossim_uint32 blocks);
   void setBlocksPerCol(ossim_uint32 blocks);
   void setNumberOfPixelsPerBlockRow(ossim_uint32 pixels);
   void setNumberOfPixelsPerBlockCol(ossim_uint32 pixels);

   ossim_uint64 getDataLocation()const;
   ossimString getImageId()const;
   ossimString getAquisitionDateTime()const;
   ossimString getTargetId()const;
   ossimString getTitle()const;
   ossimString getSecurityClassification()const;
   ossimString getEncryption()const;
   ossimString getImageSource()const;
   ossimString getJustification()const;
   ossimString getCoordinateSystem()const;
   ossimString getGeographicLocation()const;

   
   ossimString getNumberOfComments()const;
   ossimString getCompressionCode()const;
   ossimString getCompressionRateCode()const;
   ossim_uint32 getDisplayLevel()const;
   ossim_uint32 getAttachmentLevel()const;
   ossimString getPixelType()const;
   ossim_uint32 getBitsPerPixel()const;
   ossim_uint32 getActualBitsPerPixel()const;
   char getImageMode()const;
   ossimString getCategory()const;
   ossimString getRepresentation()const;
   ossim_uint32 getBlocksPerRow()const;
   ossim_uint32 getBlocksPerCol()const;
   ossim_uint32 getNumberOfPixelsPerBlockRow()const;
   ossim_uint32 getNumberOfPixelsPerBlockCol()const;
   virtual bool isValid()const;

   virtual void setProperty(ossimRefPtr<ossimProperty> property);
   virtual ossimRefPtr<ossimProperty> getProperty(const ossimString& name)const;
   virtual void getPropertyNames(std::vector<ossimString>& propertyNames)const;

   virtual ossimString  getImageMagnification()const;

   virtual void getImageLocation(ossimIpt& loc)const;
   
   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 bool saveState(ossimKeywordlist& kwl, const ossimString& prefix="")const;

   virtual bool loadState(const ossimKeywordlist& kwl,
                          const char* prefix=0);

   static const ossimString IM_KW;
   static const ossimString IID1_KW;
   static const ossimString IDATIM_KW;
   static const ossimString TGTID_KW;
   static const ossimString IID2_KW;
   static const ossimString ITITLE_KW; // also IID2 in 2.1 spec and ITITLE in 2.0 spec
   static const ossimString ISCLAS_KW;
   static const ossimString ENCRYP_KW;
   static const ossimString ISORCE_KW;
   static const ossimString NROWS_KW;
   static const ossimString NCOLS_KW;
   static const ossimString PVTYPE_KW;
   static const ossimString IREP_KW;
   static const ossimString ICAT_KW;
   static const ossimString ABPP_KW;
   static const ossimString PJUST_KW;
   static const ossimString ICORDS_KW;
   static const ossimString IGEOLO_KW;
   static const ossimString NICOM_KW;
   static const ossimString ICOM_KW;
   static const ossimString IC_KW;
   static const ossimString COMRAT_KW;
   static const ossimString NBANDS_KW;
   static const ossimString ISYNC_KW;
   static const ossimString IMODE_KW;
   static const ossimString NBPR_KW;
   static const ossimString NBPC_KW;
   static const ossimString NPPBH_KW;
   static const ossimString NPPBV_KW;
   static const ossimString NBPP_KW;
   static const ossimString IDLVL_KW;
   static const ossimString IALVL_KW;
   static const ossimString ILOC_KW;
   static const ossimString IMAG_KW;
   static const ossimString UDIDL_KW;
   static const ossimString UDOFL_KW;
   static const ossimString IXSHDL_KW;
   static const ossimString IXSOFL_KW;
   static const ossimString IMDATOFF_KW;
   static const ossimString BMRLNTH_KW;
   
protected:
   char theType[3];

   char theImageId[11];

   char theDateTime[15];

   char theTargetId[18];

   char theTitle[81];

   char theSecurityClassification[2];

   char theEncryption[2];

   char theImageSource[43];

   char theSignificantRows[9];

   char theSignificantCols[9];

   char thePixelValueType[4];

   char theRepresentation[9];

   char theActualBitsPerPixelPerBand[3];

   char theCategory[9];

   char theJustification[2];

   char theCoordinateSystem[2];

   char theNumberOfComments[2];

   std::vector<ossimString> theImageComments;

   char theGeographicLocation[61];

   char theCompression[3];

   char theCompressionRateCode[5];

   char theNumberOfBands[2];

   char theImageSyncCode[2];

   char theImageMode[2];

   char theNumberOfBlocksPerRow[5];
   
   char theNumberOfBlocksPerCol[5];

   char theNumberOfPixelsPerBlockHoriz[5];

   char theNumberOfPixelsPerBlockVert[5];

   char theNumberOfBitsPerPixelPerBand[3];

   char theDisplayLevel[4];

   char theAttachmentLevel[4];

   char theImageLocation[11];

   char theImageMagnification[5];

   char theUserDefinedImageDataLength[6];

   char theUserDefinedOverflow[4];

   char theExtendedSubheaderDataLen[6];

   char theExtendedSubheaderOverflow[4];

   /**************************************************************************
    *                    THIS IS THE MASK TABLE IF PRESENT
    */
   
   ossim_uint32 theBlockedImageDataOffset;

   ossim_uint16 theBlockMaskRecordLength;

   ossim_uint16 thePadPixelMaskRecordLength;
   
   ossim_uint16 theTransparentOutputPixelCodeLength;

   ossim_uint16 thePadOutputPixelCode;

   std::vector<ossim_uint32> theBlockMaskRecords;
   std::vector<ossim_uint32> thePadPixelMaskRecords;
   ossimRefPtr<ossimNitfCompressionHeader> theCompressionHeader;
   ossim_uint64 theDataLocation;

TYPE_DATA
   
};

#endif