#include <ossimNitfImageHeader.h>

Inheritance diagram for ossimNitfImageHeader:

Public Member Functions
	ossimNitfImageHeader ()

virtual	~ossimNitfImageHeader ()

virtual bool	getTagInformation (ossimNitfTagInformation &tagInfo, ossim_uint32 idx) const

virtual std::vector< ossimNitfTagInformation >	getAllTags ()

virtual void	setAllTags (std::vector< ossimNitfTagInformation > tagList)

virtual bool	getTagInformation (ossimNitfTagInformation &tagInfo, const ossimString &tagName) const

ossimRefPtr< ossimNitfRegisteredTag >	getTagData (const ossimString &tagName)

const ossimRefPtr< ossimNitfRegisteredTag >	getTagData (const ossimString &tagName) const

void	getTagData (const ossimString &tagName, std::vector< const ossimNitfRegisteredTag *> &tags) const
	Returns all tags of type tagName. More...

virtual ossim_uint32	getNumberOfTags () const

virtual void	addTag (const ossimNitfTagInformation &tag, bool unique=true)

virtual void	removeTag (const ossimString &tagName)

virtual void	parseStream (ossim::istream &in)=0

virtual void	writeStream (ossim::ostream &out)=0

virtual bool	isCompressed () const =0

virtual bool	isEncrypted () const =0

virtual bool	isValid () const =0
	isValid will test if the fields are valid and will return true or false. More...

virtual ossimString	getCompressionCode () const =0

virtual ossimString	getCompressionRateCode () const =0

virtual ossim_uint32	getDisplayLevel () const =0

virtual ossim_uint32	getAttachmentLevel () const =0

virtual ossim_int32	getNumberOfRows () const =0

virtual ossim_int32	getNumberOfBands () const =0

virtual ossim_int32	getNumberOfCols () const =0

virtual ossim_int32	getNumberOfBlocksPerRow () const =0

virtual ossim_int32	getNumberOfBlocksPerCol () const =0

virtual ossim_int32	getNumberOfPixelsPerBlockHoriz () const =0

virtual ossim_int32	getNumberOfPixelsPerBlockVert () const =0

virtual ossimString	getImageId () const =0

virtual ossimString	getTitle () const =0

virtual ossim_int32	getActualBitsPerPixelPerBand () const =0

virtual ossim_int32	getBitsPerPixelPerBand () const =0

virtual ossimIrect	getImageRect () const =0

virtual ossimIrect	getBlockImageRect () const =0
	Blocks might not be the same size as the significant rows and cols used by the getImageRect. More...

virtual ossimString	getIMode () const =0

virtual ossim_uint64	getDataLocation () const =0

virtual ossimString	getImageDateAndTime () const =0

virtual ossimString	getAcquisitionDateMonthDayYear (ossim_uint8 separationChar='-') const =0

virtual ossimString	getSecurityClassification () const =0

virtual ossimString	getCategory () const =0

virtual ossimString	getImageSource () const =0

virtual ossimString	getRepresentation () const =0

virtual ossimString	getCoordinateSystem () const =0

virtual ossimString	getGeographicLocation () const =0

virtual ossimString	getPixelValueType () const =0

virtual ossimString	getImageMagnification () const =0

virtual void	getImageLocation (ossimIpt &loc) const =0
	Gets the ILOC field as an ossimIpt. More...

virtual void	getDecimationFactor (ossim_float64 &result) const
	Convenience method to get the decimation factor as a double from the string returned be the getImageMagnification() method. More...

virtual bool	hasBlockMaskRecords () const =0

virtual bool	hasPadPixelMaskRecords () const =0

virtual bool	hasTransparentCode () const =0

virtual ossim_uint32	getTransparentCode () const =0

virtual ossim_uint32	getBlockMaskRecordOffset (ossim_uint32 blockNumber, ossim_uint32 bandNumber) const =0

virtual ossim_uint32	getPadPixelMaskRecordOffset (ossim_uint32 blockNumber, ossim_uint32 bandNumber) const =0

virtual const ossimRefPtr< ossimNitfCompressionHeader >	getCompressionHeader () const =0

virtual const ossimRefPtr< ossimNitfImageBand >	getBandInformation (ossim_uint32 idx) const =0

bool	hasLut () const

ossimRefPtr< ossimNBandLutDataObject >	createLut (ossim_uint32 bandIdx) const

virtual bool	isSameAs (const ossimNitfImageHeader *hdr) const

virtual void	setProperty (ossimRefPtr< ossimProperty > property)

virtual ossimRefPtr< ossimProperty >	getProperty (const ossimString &name) const

virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const

virtual ossim_uint32	getTotalTagLength () const

virtual std::ostream &	printTags (std::ostream &out, const std::string &prefix=std::string()) const
	print method that outputs a key/value type format adding prefix to keys. More...

virtual void	getMetadata (ossimKeywordlist &kwl, const char *prefix=0) const
	Populates keyword list with metadata. More...

virtual std::ostream &	print (std::ostream &out, const std::string &prefix) const =0
	pure virtual print method that outputs a key/value type format adding prefix to keys. More...

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

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimObject *	dup () const

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getDescription () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

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

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

virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...

virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const

virtual void	accept (ossimVisitor &visitor)

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Public Member Functions inherited from ossimPropertyInterface
	ossimPropertyInterface ()

virtual	~ossimPropertyInterface ()

virtual void	setProperty (const ossimString &name, const ossimString &value)

virtual ossimString	getPropertyValueAsString (const ossimString &name) const

void	getPropertyList (std::vector< ossimRefPtr< ossimProperty > > &propertyList) const

void	setProperties (std::vector< ossimRefPtr< ossimProperty > > &propertyList)

Protected Member Functions
void	checkForGeographicTiePointTruncation (const ossimDpt &tie) const
	Method to check tie point to see if it will be truncated in field IGEOLO which has only arc second resolution. More...

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
std::vector< ossimNitfTagInformation >	theTagList

Detailed Description

Definition at line 31 of file ossimNitfImageHeader.h.

Constructor & Destructor Documentation

◆ ossimNitfImageHeader()

ossimNitfImageHeader::ossimNitfImageHeader ( )

Definition at line 32 of file ossimNitfImageHeader.cpp.

33 {

34 }

◆ ~ossimNitfImageHeader()

ossimNitfImageHeader::~ossimNitfImageHeader ( )

virtual

Definition at line 36 of file ossimNitfImageHeader.cpp.

37 {

38 }

Member Function Documentation

◆ addTag()

void ossimNitfImageHeader::addTag	(	const ossimNitfTagInformation &	tag,
		bool	unique = `true`
	)

virtual

Definition at line 128 of file ossimNitfImageHeader.cpp.

References ossimNitfTagInformation::getTagName(), removeTag(), and theTagList.

Referenced by ossimNitfWriterBase::addGeolobTag(), ossimNitf20Writer::addRegisteredTag(), ossimNitfWriter::addRegisteredTag(), and ossimNitfWriterBase::addRpcbTag().

 {
    if(unique)
    {
       removeTag(tag.getTagName());
    }
    theTagList.push_back(tag);
 }

◆ checkForGeographicTiePointTruncation()

void ossimNitfImageHeader::checkForGeographicTiePointTruncation ( const ossimDpt & tie ) const

protected

Method to check tie point to see if it will be truncated in field IGEOLO which has only arc second resolution.

Spits out warning if tie does not evenly divide by an arc second.

Parameters

tie	Tie point to check.

Definition at line 332 of file ossimNitfImageHeader.cpp.

References ossimNotify(), ossimNotifyLevel_WARN, ossimDpt::x, x, ossimDpt::y, and y.

 {
    // One arc second in decimal degrees.
    const ossim_float64 ARC_SECOND = 1.0/3600.0;
 
    // Very small number.
    const ossim_float64 FUDGE_FACTOR = 0.000000001;
 
    // Remainder portion of latitude divided by an arc second.
    ossim_float64 y = std::fmod(tie.y, ARC_SECOND);
 
    // Remainder portion of longitue divided by an arc second.
    ossim_float64 x = std::fmod(tie.x, ARC_SECOND);
 
    if ( (std::fabs(y) > FUDGE_FACTOR) || (std::fabs(x) > FUDGE_FACTOR) )
    {
       ossimNotify(ossimNotifyLevel_WARN)
          << "ossimNitfImageHeader WARNING:\n"
          << "Tie point will be truncated in image header:  "
          << tie
          << std::endl;
    }
 }

◆ createLut()

ossimRefPtr< ossimNBandLutDataObject > ossimNitfImageHeader::createLut ( ossim_uint32 bandIdx ) const

Definition at line 290 of file ossimNitfImageHeader.cpp.

References ossimNBandLutDataObject::create(), getBandInformation(), ossimNitfImageBand::getLut(), getNumberOfBands(), ossimNitfImageBand::getNumberOfLuts(), ossimNitfImageLut::getValue(), and ossimRefPtr< T >::valid().

 {
    ossimRefPtr<ossimNBandLutDataObject> result;
    
    if(bandIdx < (ossim_uint32)getNumberOfBands())
    {
       const ossimRefPtr<ossimNitfImageBand> band = getBandInformation(bandIdx);
       if(band.valid())
       {
          ossim_uint32 bands = band->getNumberOfLuts();
          if(bands > 0)
          {
             if(band->getLut(0).valid())
             {
                ossim_uint32 entries = band->getLut(0)->getNumberOfEntries();
                
                result = new ossimNBandLutDataObject();
                result->create(entries, band->getNumberOfLuts());
                ossim_uint32 bIdx;
                ossim_uint32 entryIdx;
 
                for(bIdx = 0; bIdx < bands; ++bIdx)
                {
                   const ossimRefPtr<ossimNitfImageLut> lut = band->getLut(bIdx);
                   if(lut.valid())
                   {
                      for(entryIdx = 0; entryIdx < entries; ++entryIdx)
                      {
                         (*result)[entryIdx][bIdx] = (ossimNBandLutDataObject::LUT_ENTRY_TYPE)(lut->getValue(entryIdx));
                      }
                   }
                }
             }
          }
       }
    }
 
    return result;
 }

◆ getAcquisitionDateMonthDayYear()

virtual ossimString ossimNitfImageHeader::getAcquisitionDateMonthDayYear ( ossim_uint8 separationChar = '-' ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by getMetadata(), and ossimNitfImageHeaderV2_X::getProperty().

◆ getActualBitsPerPixelPerBand()

virtual ossim_int32 ossimNitfImageHeader::getActualBitsPerPixelPerBand ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimNitfTileSource::getMaxPixelValue(), and ossimNitfTileSource::initializeScalarType().

◆ getAllTags()

virtual std::vector<ossimNitfTagInformation> ossimNitfImageHeader::getAllTags ( )

inlinevirtual

Definition at line 41 of file ossimNitfImageHeader.h.

41 { return theTagList; }

ossimNitfImageHeader::theTagList

std::vector< ossimNitfTagInformation > theTagList

Definition: ossimNitfImageHeader.h:199

◆ getAttachmentLevel()

virtual ossim_uint32 ossimNitfImageHeader::getAttachmentLevel ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_X.

◆ getBandInformation()

virtual const ossimRefPtr<ossimNitfImageBand> ossimNitfImageHeader::getBandInformation ( ossim_uint32 idx ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_1, and ossimNitfImageHeaderV2_0.

Referenced by createLut(), ossimNitfTileSource::getRgbBandList(), hasLut(), ossimNitfTileSource::initializeBandCount(), ossimNitfTileSource::vqUncompressC4(), and ossimNitfTileSource::vqUncompressM4().

◆ getBitsPerPixelPerBand()

virtual ossim_int32 ossimNitfImageHeader::getBitsPerPixelPerBand ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimJpeg12NitfReader::canUncompress(), ossimNitfTileSource::canUncompress(), ossimNitfTileSource::explodePackedBits(), ossimNitfTileSource::getMaxPixelValue(), ossimNitfTileSource::getPartialReadSize(), ossimNitfTileSource::initializeScalarType(), and isSameAs().

◆ getBlockImageRect()

virtual ossimIrect ossimNitfImageHeader::getBlockImageRect ( ) const

pure virtual

Blocks might not be the same size as the significant rows and cols used by the getImageRect.

Implemented in ossimNitfImageHeaderV2_1, and ossimNitfImageHeaderV2_X.

Referenced by ossimNitfTileSource::initializeImageRect().

◆ getBlockMaskRecordOffset()

virtual ossim_uint32 ossimNitfImageHeader::getBlockMaskRecordOffset	(	ossim_uint32	blockNumber,
		ossim_uint32	bandNumber
	)		const

pure virtual

Implemented in ossimNitfImageHeaderV2_1, and ossimNitfImageHeaderV2_0.

Referenced by ossimNitfTileSource::getPosition().

◆ getCategory()

virtual ossimString ossimNitfImageHeader::getCategory ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_X, ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimNitfFile::print(), and ossimNitfFile::saveState().

◆ getCompressionCode()

virtual ossimString ossimNitfImageHeader::getCompressionCode ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_X.

Referenced by ossimOpjNitfReader::canUncompress(), ossimJpeg12NitfReader::canUncompress(), ossimKakaduNitfReader::canUncompress(), ossimNitfTileSource::canUncompress(), ossimNitfCodecFactory::createCodec(), ossimNitfTileSource::initializeBandCount(), ossimNitfTileSource::initializeBlockSize(), ossimNitfTileSource::initializeCompressedBuf(), ossimOpjNitfReader::initializeReadMode(), ossimKakaduNitfReader::initializeReadMode(), ossimNitfTileSource::initializeReadMode(), and ossimKakaduNitfReader::isEntryJ2k().

◆ getCompressionHeader()

virtual const ossimRefPtr<ossimNitfCompressionHeader> ossimNitfImageHeader::getCompressionHeader ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_1, and ossimNitfImageHeaderV2_0.

Referenced by ossimNitfTileSource::vqUncompressC4(), and ossimNitfTileSource::vqUncompressM4().

◆ getCompressionRateCode()

virtual ossimString ossimNitfImageHeader::getCompressionRateCode ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_X.

Referenced by ossimJpeg12NitfReader::loadJpeg12QuantizationTables(), and ossimNitfTileSource::loadJpegQuantizationTables().

◆ getCoordinateSystem()

virtual ossimString ossimNitfImageHeader::getCoordinateSystem ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, ossimNitfImageHeaderV2_1, and ossimNitfImageHeaderV2_X.

Referenced by ossimNitfProjectionFactory::createProjectionFromHeaders(), and isSameAs().

◆ getDataLocation()

virtual ossim_uint64 ossimNitfImageHeader::getDataLocation ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_X.

Referenced by ossimKakaduNitfReader::checkJp2Signature(), ossimNitfTileSource::getPosition(), ossimOpjNitfReader::scanForJpegBlockOffsets(), ossimKakaduNitfReader::scanForJpegBlockOffsets(), and ossimNitfTileSource::scanForJpegBlockOffsets().

◆ getDecimationFactor()

void ossimNitfImageHeader::getDecimationFactor ( ossim_float64 & result ) const

virtual

Convenience method to get the decimation factor as a double from the string returned be the getImageMagnification() method.

Parameters

result Initialized with the decimation factor as a double. Will return an ossim::nan() if something bad happens like the string is empty so callers should check result with ossim::isnan(result).

Definition at line 357 of file ossimNitfImageHeader.cpp.

References ossimString::after(), ossimString::contains(), getImageMagnification(), ossim::nan(), ossimString::size(), ossimString::toFloat64(), and ossimString::trim().

Referenced by ossimNitfTileSource::establishDecimationFactors(), and ossimNitfFile::print().

 {
    //---
    // Look for string like:
    // 
    // "/2" = 1/2
    // "/4  = 1/4
    // ...
    // "/16 = 1/16
    // 
    // If it is full resolution it should be "1.0"
    //
    // or
    //
    // "0.5" which is the same as "/2"
    // "0.25" which is the same as "/4"
    //---
    ossimString os = getImageMagnification();
 
    // Spec says to fill with spaces so strip them.
    os.trim(ossimString(" "));
 
    if (os.size())
    {
       if ( os.contains("/") )
       {
          os = os.after("/");
          result = os.toFloat64();
          if (result)
          {
             result = 1.0 / result;
          }
       }
       else
       {
          result = os.toFloat64();
       }
    }
    else
    {
       result = ossim::nan();
    }
 }

◆ getDisplayLevel()

virtual ossim_uint32 ossimNitfImageHeader::getDisplayLevel ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_X.

Referenced by ossimNitfFileHeaderV2_0::initializeDisplayLevels().

◆ getGeographicLocation()

virtual ossimString ossimNitfImageHeader::getGeographicLocation ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_1, and ossimNitfImageHeaderV2_X.

Referenced by isSameAs(), ossimNitfProjectionFactory::makeGeographic(), and ossimNitfProjectionFactory::makeUtm().

◆ getImageDateAndTime()

virtual ossimString ossimNitfImageHeader::getImageDateAndTime ( ) const

pure virtual

Returns: The IDATIM field unparsed.

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

◆ getImageId()

virtual ossimString ossimNitfImageHeader::getImageId ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, ossimNitfImageHeaderV2_1, and ossimNitfImageHeaderV2_X.

◆ getImageLocation()

virtual void ossimNitfImageHeader::getImageLocation ( ossimIpt & loc ) const

pure virtual

Gets the ILOC field as an ossimIpt.

Parameters

loc	Initialized with the field.

Note: : Do not confuse with "data location".

Implemented in ossimNitfImageHeaderV2_X.

◆ getImageMagnification()

virtual ossimString ossimNitfImageHeader::getImageMagnification ( ) const

pure virtual

Returns: IMAG field

Implemented in ossimNitfImageHeaderV2_X.

Referenced by getDecimationFactor().

◆ getImageRect()

virtual ossimIrect ossimNitfImageHeader::getImageRect ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_1, and ossimNitfImageHeaderV2_X.

Referenced by ossimNitfProjectionFactory::computeScaleInDecimalDegrees(), ossimNitfProjectionFactory::computeScaleInMeters(), ossimNitfFileHeaderV2_0::initializeDisplayLevels(), ossimNitfTileSource::initializeImageRect(), isSameAs(), and ossimQuickbirdRpcModel::parseNitfFile().

◆ getImageSource()

virtual ossimString ossimNitfImageHeader::getImageSource ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_1, ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_X.

Referenced by getMetadata().

◆ getIMode()

virtual ossimString ossimNitfImageHeader::getIMode ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimImageGeometryFactory::createTransformFromNitf(), ossimOpjNitfReader::initializeReadMode(), ossimKakaduNitfReader::initializeReadMode(), ossimNitfTileSource::initializeReadMode(), and isSameAs().

◆ getMetadata()

void ossimNitfImageHeader::getMetadata	(	ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

Populates keyword list with metadata.

expample: country_code: US

Parameters

kwl	Keywordlist to populate with metadata.
prefix	Optional prefix to put in front of key, like: "image1.".

Definition at line 249 of file ossimNitfImageHeader.cpp.

References ossimKeywordlist::add(), getAcquisitionDateMonthDayYear(), getImageSource(), and getTitle().

 {
    kwl.add(prefix, "source",
            getImageSource().c_str(),
            false);
    kwl.add(prefix,
            "image_date",
            getAcquisitionDateMonthDayYear().c_str(),
            false);
    kwl.add(prefix,
            "image_title",
            getTitle().c_str(),
            false);
 }

◆ getNumberOfBands()

virtual ossim_int32 ossimNitfImageHeader::getNumberOfBands ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by createLut(), hasLut(), ossimNitfTileSource::initializeBandCount(), and isSameAs().

◆ getNumberOfBlocksPerCol()

virtual ossim_int32 ossimNitfImageHeader::getNumberOfBlocksPerCol ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimKakaduNitfReader::dumpTiles(), ossimNitfImageHeaderV2_X::getBlockImageRect(), ossimNitfTileSource::getNumberOfBlocks(), isSameAs(), ossimOpjNitfReader::scanForJpegBlockOffsets(), and ossimNitfTileSource::scanForJpegBlockOffsets().

◆ getNumberOfBlocksPerRow()

virtual ossim_int32 ossimNitfImageHeader::getNumberOfBlocksPerRow ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimKakaduNitfReader::dumpTiles(), ossimNitfImageHeaderV2_X::getBlockImageRect(), ossimNitfTileSource::getBlockNumber(), ossimNitfTileSource::getNumberOfBlocks(), isSameAs(), ossimOpjNitfReader::scanForJpegBlockOffsets(), and ossimNitfTileSource::scanForJpegBlockOffsets().

◆ getNumberOfCols()

virtual ossim_int32 ossimNitfImageHeader::getNumberOfCols ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimNitfImageHeaderV2_X::getImageRect(), ossimNitfTileSource::getNumberOfSamples(), isSameAs(), and ossimNitfProjectionFactory::makeBilinear().

◆ getNumberOfPixelsPerBlockHoriz()

virtual ossim_int32 ossimNitfImageHeader::getNumberOfPixelsPerBlockHoriz ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimImageGeometryFactory::createTransformFromNitf(), ossimNitfImageHeaderV2_X::getBlockImageRect(), ossimNitfTileSource::getImageTileWidth(), ossimNitfTileSource::initializeCacheSize(), and isSameAs().

◆ getNumberOfPixelsPerBlockVert()

virtual ossim_int32 ossimNitfImageHeader::getNumberOfPixelsPerBlockVert ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimImageGeometryFactory::createTransformFromNitf(), ossimNitfImageHeaderV2_X::getBlockImageRect(), ossimNitfTileSource::getImageTileHeight(), ossimNitfTileSource::initializeCacheSize(), and isSameAs().

◆ getNumberOfRows()

virtual ossim_int32 ossimNitfImageHeader::getNumberOfRows ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimNitfImageHeaderV2_X::getImageRect(), ossimNitfTileSource::getNumberOfLines(), isSameAs(), and ossimNitfProjectionFactory::makeBilinear().

◆ getNumberOfTags()

ossim_uint32 ossimNitfImageHeader::getNumberOfTags ( ) const

virtual

Definition at line 123 of file ossimNitfImageHeader.cpp.

References theTagList.

 {
    return static_cast<ossim_uint32>(theTagList.size());
 }

◆ getPadPixelMaskRecordOffset()

virtual ossim_uint32 ossimNitfImageHeader::getPadPixelMaskRecordOffset	(	ossim_uint32	blockNumber,
		ossim_uint32	bandNumber
	)		const

pure virtual

Implemented in ossimNitfImageHeaderV2_1, and ossimNitfImageHeaderV2_0.

Referenced by ossimNitfTileSource::convertTransparentToNull().

◆ getPixelValueType()

virtual ossimString ossimNitfImageHeader::getPixelValueType ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimNitfTileSource::initializeScalarType().

◆ getProperty()

ossimRefPtr< ossimProperty > ossimNitfImageHeader::getProperty ( const ossimString & name ) const

virtual

Reimplemented from ossimPropertyInterface.

Reimplemented in ossimNitfImageHeaderV2_1, ossimNitfImageHeaderV2_X, and ossimNitfImageHeaderV2_0.

Definition at line 176 of file ossimNitfImageHeader.cpp.

Referenced by ossimNitfImageHeaderV2_X::getProperty(), and ossimNitfTileSource::getProperty().

 {
    ossimProperty* result = 0;
 
    if(name == TAGS_KW)
    {
       ossim_uint32 idxMax = getNumberOfTags();
       if(idxMax > 0)
       {
          ossimContainerProperty* containerProperty = new ossimContainerProperty;
          containerProperty->setName(name);
          ossim_uint32 idx = 0;
 
          result = containerProperty;
          for(idx = 0; idx < idxMax; ++idx)
          {
             ossimNitfTagInformation tagInfo;
             getTagInformation(tagInfo, idx);
             
             const ossimRefPtr<ossimNitfRegisteredTag> tagData = tagInfo.getTagData();
             if(tagData.valid())
             {
                ossimContainerProperty* containerPropertyTag = new ossimContainerProperty;
                containerPropertyTag->setName(tagInfo.getTagName());
                std::vector<ossimRefPtr<ossimProperty> > propertyList;
                tagData->getPropertyList(propertyList);
                
                containerPropertyTag->addChildren(propertyList);
                containerProperty->addChild(containerPropertyTag);
             }
             else
             {
                containerProperty->addStringProperty(tagInfo.getTagName(), "", true);
             }
          }
       }
    }
    
    return result;
 }

◆ getPropertyNames()

void ossimNitfImageHeader::getPropertyNames ( std::vector< ossimString > & propertyNames ) const

virtual

Reimplemented from ossimPropertyInterface.

Reimplemented in ossimNitfImageHeaderV2_1, ossimNitfImageHeaderV2_X, and ossimNitfImageHeaderV2_0.

Definition at line 217 of file ossimNitfImageHeader.cpp.

Referenced by ossimNitfImageHeaderV2_X::getPropertyNames(), and ossimNitfTileSource::getPropertyNames().

 {
    propertyNames.push_back(TAGS_KW);
   
 }

◆ getRepresentation()

virtual ossimString ossimNitfImageHeader::getRepresentation ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_X, ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimNitfTileSource::initializeBandCount(), ossimNitfTileSource::initializeCompressedBuf(), ossimNitfFile::print(), and ossimNitfFile::saveState().

◆ getSecurityClassification()

virtual ossimString ossimNitfImageHeader::getSecurityClassification ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_1, ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_X.

Referenced by ossimNitfTileSource::getSecurityClassification().

◆ getTagData() [1/3]

ossimRefPtr< ossimNitfRegisteredTag > ossimNitfImageHeader::getTagData ( const ossimString & tagName )

Definition at line 72 of file ossimNitfImageHeader.cpp.

References theTagList.

Referenced by ossimImageGeometryFactory::createTransformFromNitf(), ossimNitfProjectionFactory::getBlockaPoints(), ossimNitfRpcModel::getGsd(), ossimNitfRpcModel::getRpcData(), ossimNitfRpcModel::getSensorID(), and ossimQuickbirdRpcModel::parseNitfFile().

 {
    if(theTagList.size())
    {
       for(ossim_uint32 idx = 0; idx < theTagList.size(); ++idx)
       {
          if(theTagList[idx].getTagName() == tagName)
          {
             return theTagList[idx].getTagData();
          }
       }
    }
 
    return ossimRefPtr<ossimNitfRegisteredTag>();
 }

◆ getTagData() [2/3]

const ossimRefPtr< ossimNitfRegisteredTag > ossimNitfImageHeader::getTagData ( const ossimString & tagName ) const

Definition at line 89 of file ossimNitfImageHeader.cpp.

References theTagList.

 {
    if(theTagList.size())
    {
       for(ossim_uint32 idx = 0; idx < theTagList.size(); ++idx)
       {
          if(theTagList[idx].getTagName() == tagName)
          {
             return theTagList[idx].getTagData();
          }
       }
    }
    
    return ossimRefPtr<ossimNitfRegisteredTag>();
 }

◆ getTagData() [3/3]

void ossimNitfImageHeader::getTagData	(	const ossimString &	tagName,
		std::vector< const ossimNitfRegisteredTag *> &	tags
	)		const

Returns all tags of type tagName.

Vector passed in "tags" is cleared, then initialized with all tags found of "tagName". Size of vector is returned.

Parameters

tagName	E.g. "RSMPCA"
tags	Initialized by this.

◆ getTagInformation() [1/2]

bool ossimNitfImageHeader::getTagInformation	(	ossimNitfTagInformation &	tagInfo,
		ossim_uint32	idx
	)		const

virtual

Definition at line 58 of file ossimNitfImageHeader.cpp.

References theTagList.

 {
    bool result = false;
    
    if(idx < theTagList.size())
    {
       tagInfo = theTagList[idx];
       result = true;
    }
    
    return result;
 }

◆ getTagInformation() [2/2]

bool ossimNitfImageHeader::getTagInformation	(	ossimNitfTagInformation &	tagInfo,
		const ossimString &	tagName
	)		const

virtual

Definition at line 40 of file ossimNitfImageHeader.cpp.

References theTagList.

 {
    if(theTagList.size())
    {
       for(ossim_uint32 idx = 0; idx < theTagList.size(); ++idx)
       {
          if(theTagList[idx].getTagName() == tagName)
          {
             tagInfo = theTagList[idx];
             return true;
          }
       }
    }
    
    return false;
 }

◆ getTitle()

virtual ossimString ossimNitfImageHeader::getTitle ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_X.

Referenced by getMetadata().

◆ getTotalTagLength()

ossim_uint32 ossimNitfImageHeader::getTotalTagLength ( ) const

virtual

Definition at line 223 of file ossimNitfImageHeader.cpp.

References theTagList.

Referenced by ossimNitfImageHeaderV2_1::writeStream(), and ossimNitfImageHeaderV2_0::writeStream().

 {
    ossim_uint32 tagLength = 0;
    
    for(ossim_uint32 i = 0; i < theTagList.size(); ++i)
    {
       tagLength += theTagList[i].getTotalTagLength();
    }
 
    return tagLength;
 }

◆ getTransparentCode()

virtual ossim_uint32 ossimNitfImageHeader::getTransparentCode ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_1, and ossimNitfImageHeaderV2_0.

Referenced by ossimNitfTileSource::convertTransparentToNull().

◆ hasBlockMaskRecords()

virtual bool ossimNitfImageHeader::hasBlockMaskRecords ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_1, and ossimNitfImageHeaderV2_0.

Referenced by ossimNitfTileSource::getPosition().

◆ hasLut()

bool ossimNitfImageHeader::hasLut ( ) const

Definition at line 265 of file ossimNitfImageHeader.cpp.

References getBandInformation(), ossimNitfImageBand::getLut(), getNumberOfBands(), ossimNitfImageBand::getNumberOfLuts(), and ossimRefPtr< T >::valid().

Referenced by ossimNitfTileSource::initializeLut().

 {
    bool result = false;
 
    const ossim_uint32 BANDS = static_cast<ossim_uint32>(getNumberOfBands());
    for (ossim_uint32 band = 0; band < BANDS; ++band)
    {
       const ossimRefPtr<ossimNitfImageBand> imgBand = getBandInformation(band);
       if(imgBand.valid())
       {
          ossim_uint32 luts = imgBand->getNumberOfLuts();
          if(luts > 0)
          {
             if(imgBand->getLut(0).valid())
             {
                result = true;
                break;
             }
          }
       }
    }
    
    return result;
 }

◆ hasPadPixelMaskRecords()

virtual bool ossimNitfImageHeader::hasPadPixelMaskRecords ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_1, and ossimNitfImageHeaderV2_0.

Referenced by ossimNitfTileSource::convertTransparentToNull().

◆ hasTransparentCode()

virtual bool ossimNitfImageHeader::hasTransparentCode ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_1, and ossimNitfImageHeaderV2_0.

Referenced by ossimNitfTileSource::convertTransparentToNull().

◆ isCompressed()

virtual bool ossimNitfImageHeader::isCompressed ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimNitfCodecFactory::createCodec(), ossimNitfTileSource::initializeScalarType(), and isSameAs().

◆ isEncrypted()

virtual bool ossimNitfImageHeader::isEncrypted ( ) const

pure virtual

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

◆ isSameAs()

bool ossimNitfImageHeader::isSameAs ( const ossimNitfImageHeader * hdr ) const

virtual

Definition at line 150 of file ossimNitfImageHeader.cpp.

References getBitsPerPixelPerBand(), getCoordinateSystem(), getGeographicLocation(), getImageRect(), getIMode(), getNumberOfBands(), getNumberOfBlocksPerCol(), getNumberOfBlocksPerRow(), getNumberOfCols(), getNumberOfPixelsPerBlockHoriz(), getNumberOfPixelsPerBlockVert(), getNumberOfRows(), and isCompressed().

 {
    if (!hdr) return false;
    
    return ( (isCompressed() == hdr->isCompressed()) &&
             (getNumberOfRows() == hdr->getNumberOfRows()) &&
             (getNumberOfBands() == hdr->getNumberOfBands()) &&
             (getNumberOfCols() == hdr->getNumberOfCols()) &&
             (getNumberOfBlocksPerRow() == hdr->getNumberOfBlocksPerRow()) &&
             (getNumberOfBlocksPerCol() == hdr->getNumberOfBlocksPerCol()) &&
             (getNumberOfPixelsPerBlockHoriz() ==
              hdr->getNumberOfPixelsPerBlockHoriz()) &&
             (getNumberOfPixelsPerBlockVert() ==
              hdr->getNumberOfPixelsPerBlockVert()) &&
             (getBitsPerPixelPerBand() == hdr->getBitsPerPixelPerBand()) &&
             (getImageRect() == hdr->getImageRect()) &&
             (getIMode() == hdr->getIMode()) &&
             (getCoordinateSystem() == hdr->getCoordinateSystem()) &&
             (getGeographicLocation() == hdr->getGeographicLocation()) );
 }

◆ isValid()

virtual bool ossimNitfImageHeader::isValid ( ) const

pure virtual

isValid will test if the fields are valid and will return true or false.

Implemented in ossimNitfImageHeaderV2_0, ossimNitfImageHeaderV2_X, and ossimNitfImageHeaderV2_1.

◆ parseStream()

virtual void ossimNitfImageHeader::parseStream ( ossim::istream & in )

pure virtual

Implemented in ossimNitfImageHeaderV2_0.

Referenced by ossimNitfFileHeaderV2_0::getNewImageHeader(), and ossimNitfFileHeaderV2_0::initializeDisplayLevels().

◆ print()

virtual std::ostream& ossimNitfImageHeader::print	(	std::ostream &	out,
		const std::string &	prefix
	)		const

pure virtual

pure virtual print method that outputs a key/value type format adding prefix to keys.

Implemented in ossimNitfImageHeaderV2_0, and ossimNitfImageHeaderV2_1.

Referenced by ossimNitfFile::print().

◆ printTags()

std::ostream & ossimNitfImageHeader::printTags	(	std::ostream &	out,
		const std::string &	prefix = `std::string()`
	)		const

virtual

print method that outputs a key/value type format adding prefix to keys.

Definition at line 235 of file ossimNitfImageHeader.cpp.

References ossimNitfRegisteredTag::print(), theTagList, and ossimRefPtr< T >::valid().

 {
    for(ossim_uint32 i = 0; i < theTagList.size(); ++i)
    {
       ossimRefPtr<ossimNitfRegisteredTag> tag = theTagList[i].getTagData();
       if (tag.valid())
       {
          tag->print(out, prefix);
       }
    }
    return out;
 }

◆ removeTag()

void ossimNitfImageHeader::removeTag ( const ossimString & tagName )

virtual

Definition at line 137 of file ossimNitfImageHeader.cpp.

References theTagList.

Referenced by addTag(), and ossimNitfImageHeaderV2_1::takeOverflowTags().

 {
    ossim_uint32 idx = 0;
    for(idx = 0; idx < theTagList.size(); ++idx)
    {
       if(theTagList[idx].getTagName() == tagName)
       {
          theTagList.erase(theTagList.begin() + idx);
          return;
       }
    }
 }

◆ saveState()

bool ossimNitfImageHeader::saveState	(	ossimKeywordlist &	kwl,
		const ossimString &	prefix = `""`
	)		const

virtual

Reimplemented in ossimNitfImageHeaderV2_1, ossimNitfImageHeaderV2_X, and ossimNitfImageHeaderV2_0.

Definition at line 402 of file ossimNitfImageHeader.cpp.

References ossimObject::saveState(), ossimNitfRegisteredTag::saveState(), theTagList, and ossimRefPtr< T >::valid().

Referenced by ossimNitfCodecFactory::createCodec(), ossimNitfImageHeaderV2_X::saveState(), and ossimNitfFile::saveState().

 {
    if(!ossimObject::saveState(kwl, prefix)) return false;
    ossimString tagsPrefix = prefix;
    
    for(ossim_uint32 i = 0; i < theTagList.size(); ++i)
    {
       ossimRefPtr<ossimNitfRegisteredTag> tag = theTagList[i].getTagData();
       if (tag.valid())
       {
          if(!tag->saveState(kwl, tagsPrefix))
          {
             return false;
          }
       }
    }
    return true;
 }

◆ setAllTags()

virtual void ossimNitfImageHeader::setAllTags ( std::vector< ossimNitfTagInformation > tagList )

inlinevirtual

Definition at line 43 of file ossimNitfImageHeader.h.

43 { theTagList = tagList; }

ossimNitfImageHeader::theTagList

std::vector< ossimNitfTagInformation > theTagList

Definition: ossimNitfImageHeader.h:199

◆ setProperty()

void ossimNitfImageHeader::setProperty ( ossimRefPtr< ossimProperty > property )

virtual

Reimplemented from ossimPropertyInterface.

Reimplemented in ossimNitfImageHeaderV2_1, ossimNitfImageHeaderV2_X, and ossimNitfImageHeaderV2_0.

Definition at line 172 of file ossimNitfImageHeader.cpp.

Referenced by ossimNitfImageHeaderV2_X::setProperty().

173 {

174 }

◆ writeStream()

virtual void ossimNitfImageHeader::writeStream ( ossim::ostream & out )

pure virtual

Implemented in ossimNitfImageHeaderV2_0.

Member Data Documentation

◆ theTagList

std::vector<ossimNitfTagInformation> ossimNitfImageHeader::theTagList

protected

Definition at line 199 of file ossimNitfImageHeader.h.

Referenced by addTag(), ossimNitfImageHeaderV2_0::clearFields(), getNumberOfTags(), getTagData(), getTagInformation(), getTotalTagLength(), ossimNitfImageHeaderV2_0::parseStream(), printTags(), removeTag(), saveState(), ossimNitfImageHeaderV2_1::takeOverflowTags(), ossimNitfImageHeaderV2_1::writeStream(), and ossimNitfImageHeaderV2_0::writeStream().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ossimNitfImageHeader()

◆ ~ossimNitfImageHeader()

Member Function Documentation

◆ addTag()

◆ checkForGeographicTiePointTruncation()

◆ createLut()

◆ getAcquisitionDateMonthDayYear()

◆ getActualBitsPerPixelPerBand()

◆ getAllTags()

◆ getAttachmentLevel()

◆ getBandInformation()

◆ getBitsPerPixelPerBand()

◆ getBlockImageRect()

◆ getBlockMaskRecordOffset()

◆ getCategory()

◆ getCompressionCode()

◆ getCompressionHeader()

◆ getCompressionRateCode()

◆ getCoordinateSystem()

◆ getDataLocation()

◆ getDecimationFactor()

◆ getDisplayLevel()

◆ getGeographicLocation()

◆ getImageDateAndTime()

◆ getImageId()

◆ getImageLocation()

◆ getImageMagnification()

◆ getImageRect()

◆ getImageSource()

◆ getIMode()

◆ getMetadata()

◆ getNumberOfBands()

◆ getNumberOfBlocksPerCol()

◆ getNumberOfBlocksPerRow()

◆ getNumberOfCols()

◆ getNumberOfPixelsPerBlockHoriz()

◆ getNumberOfPixelsPerBlockVert()

◆ getNumberOfRows()

◆ getNumberOfTags()

◆ getPadPixelMaskRecordOffset()

◆ getPixelValueType()

◆ getProperty()

◆ getPropertyNames()

◆ getRepresentation()

◆ getSecurityClassification()

◆ getTagData() [1/3]

◆ getTagData() [2/3]

◆ getTagData() [3/3]

◆ getTagInformation() [1/2]

◆ getTagInformation() [2/2]

◆ getTitle()

◆ getTotalTagLength()

◆ getTransparentCode()

◆ hasBlockMaskRecords()

◆ hasLut()

◆ hasPadPixelMaskRecords()

◆ hasTransparentCode()

◆ isCompressed()

◆ isEncrypted()

◆ isSameAs()

◆ isValid()

◆ parseStream()

◆ print()

◆ printTags()

◆ removeTag()

◆ saveState()

◆ setAllTags()

◆ setProperty()

◆ writeStream()

Member Data Documentation

◆ theTagList