ossimMapProjectionInfo Class Reference

#include <ossimMapProjectionInfo.h>

Inheritance diagram for ossimMapProjectionInfo:

Public Member Functions
	ossimMapProjectionInfo (const ossimMapProjection *proj, const ossimDrect &output_rect)
virtual	~ossimMapProjectionInfo ()
bool	errorStatus () const
	Returns true on error false if ok. More...
void	getGeom (ossimKeywordlist &kwl, const char *prefix=0) const
	Adds tie point to keyword list. More...
ossimDpt	getMetersPerPixel () const
	Returns the pixel size in meters. More...
ossimDpt	getUsSurveyFeetPerPixel () const
	Returns the pixel size in U.S. More...
ossimDpt	getDecimalDegreesPerPixel () const
	Returns the decimal degrees per pixel. More...
ossimDpt	ulEastingNorthingPt () const
	Returns the upper left easting and northing as a ossimDpt. More...
ossimDpt	urEastingNorthingPt () const
	Returns the upper right easting and northing as a ossimDpt. More...
ossimDpt	lrEastingNorthingPt () const
	Returns the lower right easting and northing as a ossimDpt. More...
ossimDpt	llEastingNorthingPt () const
	Returns the lower left easting and northing as a ossimDpt. More...
ossimDpt	ulEastingNorthingPtInFt () const
	Returns the upper left easting and northing as a ossimDpt. More...
ossimDpt	urEastingNorthingPtInFt () const
	Returns the upper right easting and northing as a ossimDpt. More...
ossimDpt	lrEastingNorthingPtInFt () const
	Returns the lower right easting and northing as a ossimDpt. More...
ossimDpt	llEastingNorthingPtInFt () const
	Returns the lower left easting and northing as a ossimDpt. More...
ossimGpt	ulGroundPt () const
	Returns the upper left ground point. More...
ossimGpt	urGroundPt () const
	Returns the upper right ground point. More...
ossimGpt	lrGroundPt () const
	Returns the lower right ground point. More...
ossimGpt	llGroundPt () const
	Returns the lower left ground point. More...
ossimGpt	centerGroundPt () const
	Returns the center ground point. More...
ossimDpt	centerEastingNorthingPt () const
ossim_int32	linesPerImage () const
ossim_int32	pixelsPerLine () const
std::ostream &	print (std::ostream &os) const
	Formatted print of data members. More...
void	setPixelType (ossimPixelType type)
	Sets the data member "thePixelType". More...
ossimPixelType	getPixelType () const
	Returns data member "thePixelType". More...
void	setOutputFeetFlag (bool flag)
	Sets the data member "theOutputInfoInFeetFlag". More...
bool	unitsInFeet () const
	Returns the data member "theOutputInfoInFeetFlag". More...
ossimString	getImageInfoString () const
	Returns theImageInfoString. More...
void	setImageInfoString (const ossimString &string)
	Used to set data member "theImageInfoString". More...
const ossimMapProjection *	getProjection () const
	Returns reference to "theProjection". More...
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) 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	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

Static Public Attributes
static const char *	README_IMAGE_STRING_KW
static const char *	PIXEL_TYPE_KW = "viewinfo.pixel_type"
static const char *	OUTPUT_US_FT_INFO_KW

Private Member Functions
	ossimMapProjectionInfo ()
ossimMapProjectionInfo &	operator= (const ossimMapProjectionInfo &)
void	initializeMembers (const ossimDrect &output_rect)

Private Attributes
const ossimMapProjection *	theProjection
bool	theErrorStatus
int	theLinesPerImage
int	thePixelsPerLine
ossimGpt	theCornerGroundPt [4]
ossimDpt	theCornerEastingNorthingPt [4]
ossimGpt	theCenterGroundPt
ossimDpt	theCenterEastingNorthingPt
ossimDrect	theBoundingRect
ossimPixelType	thePixelType
	"thePixelType" defines whether the tie point coordinates are relative to the center of the pixel(which is PIXEL_IS_POINT) or the upper left corner of the pixel(PIXEL_IS_AREA). More...
bool	theOutputInfoInFeetFlag
	If "theOutputInfoInFeetFlag" is true the readme file tie point info will be output in both meters and U.S. More...
ossimString	theImageInfoString
	"theImageInfoString" goes in the README file "Image:" field to identify the image. More...

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Definition at line 34 of file ossimMapProjectionInfo.h.

Constructor & Destructor Documentation

ossimMapProjectionInfo() [1/2]

ossimMapProjectionInfo::ossimMapProjectionInfo	(	const ossimMapProjection *	proj,
		const ossimDrect &	output_rect
	)

Definition at line 54 of file ossimMapProjectionInfo.cpp.

References initializeMembers(), ossimNotify(), ossimNotifyLevel_FATAL, theErrorStatus, and theProjection.

   :
      theProjection               (proj),
      theErrorStatus              (false),
      theLinesPerImage            (0),
      thePixelsPerLine            (0),
      theCornerGroundPt           (),
      theCornerEastingNorthingPt  (),
      theCenterGroundPt           (),
      theCenterEastingNorthingPt  (0.0, 0.0),
      thePixelType                (OSSIM_PIXEL_IS_POINT),
      theOutputInfoInFeetFlag     (false),
      theImageInfoString          ()
{
   if (!theProjection)
   {
      theErrorStatus = true;
      ossimNotify(ossimNotifyLevel_FATAL)
         << "FATAL ossimMapProjectionInfo::ossimMapProjectionInfo: "
         << "Null projection pointer passed to constructor!"
         << "\nError status has been set.  Returning..."
         << std::endl;
      return;
   }
   
   initializeMembers(output_rect);

   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "DEBUG ossimMapProjectionInfo::ossimMapProjectionInfo:\n"
         << "output_rect:  " << output_rect << "\n"
         << *this << std::endl;
   }
}

~ossimMapProjectionInfo()

ossimMapProjectionInfo::~ossimMapProjectionInfo ( )

virtual

Definition at line 91 of file ossimMapProjectionInfo.cpp.

{
}

ossimMapProjectionInfo() [2/2]

ossimMapProjectionInfo::ossimMapProjectionInfo ( )

private

Member Function Documentation

centerEastingNorthingPt()

ossimDpt ossimMapProjectionInfo::centerEastingNorthingPt

(

)

const

Returns

The center ground point.

Definition at line 395 of file ossimMapProjectionInfo.cpp.

References theCenterEastingNorthingPt.

{
   return theCenterEastingNorthingPt;
}

centerGroundPt()

ossimGpt ossimMapProjectionInfo::centerGroundPt

(

)

const

Returns the center ground point.

Definition at line 389 of file ossimMapProjectionInfo.cpp.

References theCenterGroundPt.

{
   // Center is simply center, no shift for pixel is area...
   return theCenterGroundPt;
}

errorStatus()

bool ossimMapProjectionInfo::errorStatus

(

)

const

Returns true on error false if ok.

Definition at line 95 of file ossimMapProjectionInfo.cpp.

References theErrorStatus.

{
   return theErrorStatus;
}

getDecimalDegreesPerPixel()

ossimDpt ossimMapProjectionInfo::getDecimalDegreesPerPixel

(

)

const

Returns the decimal degrees per pixel.

x = sample direction y = line direction

Definition at line 544 of file ossimMapProjectionInfo.cpp.

References ossimMapProjection::getDecimalDegreesPerPixel(), and theProjection.

Referenced by llGroundPt(), lrGroundPt(), print(), ulGroundPt(), and urGroundPt().

{
   return theProjection->getDecimalDegreesPerPixel();
}

getGeom()

void ossimMapProjectionInfo::getGeom	(	ossimKeywordlist &	kwl,
		const char *	prefix = 0
	)		const

Adds tie point to keyword list.

This will be latitude, longitude if projection is geographic; else, easting, northing.

Definition at line 145 of file ossimMapProjectionInfo.cpp.

References ossimKeywordlist::add(), ossimString::c_str(), ossimUnitTypeLut::instance(), ossimMapProjection::isGeographic(), OSSIM_DEGREES, OSSIM_METERS, ossimMapProjection::saveState(), theProjection, ossimKeywordNames::TIE_POINT_UNITS_KW, ossimKeywordNames::TIE_POINT_XY_KW, ossimDpt::toString(), ulEastingNorthingPt(), and ulGroundPt().

Referenced by ossimERSFileWriter::writeFile(), and ossimEnviHeaderFileWriter::writeFile().

{
   theProjection->saveState(kwl, prefix);

   if(theProjection->isGeographic())
   {
      ossimGpt gpt = ulGroundPt();
      kwl.add(prefix,
              ossimKeywordNames::TIE_POINT_XY_KW,
              ossimDpt(gpt).toString().c_str(),
              true);
      kwl.add(prefix,
              ossimKeywordNames::TIE_POINT_UNITS_KW,
              ossimUnitTypeLut::instance()->getEntryString(OSSIM_DEGREES),
              true);
   }
   else
   {
      ossimDpt dpt = ulEastingNorthingPt();
      kwl.add(prefix,
              ossimKeywordNames::TIE_POINT_XY_KW,
              dpt.toString().c_str(),
              true);
      kwl.add(prefix,
              ossimKeywordNames::TIE_POINT_UNITS_KW,
              ossimUnitTypeLut::instance()->getEntryString(OSSIM_METERS),
              true);
   }
}

getImageInfoString()

ossimString ossimMapProjectionInfo::getImageInfoString

(

)

const

Returns theImageInfoString.

Definition at line 246 of file ossimMapProjectionInfo.cpp.

References theImageInfoString.

{
   return theImageInfoString;
}

getMetersPerPixel()

ossimDpt ossimMapProjectionInfo::getMetersPerPixel

(

)

const

Returns the pixel size in meters.

x = sample direction y = line direction

Definition at line 529 of file ossimMapProjectionInfo.cpp.

References ossimMapProjection::getMetersPerPixel(), and theProjection.

Referenced by getUsSurveyFeetPerPixel(), llEastingNorthingPt(), lrEastingNorthingPt(), print(), ulEastingNorthingPt(), and urEastingNorthingPt().

{
   return theProjection->getMetersPerPixel();
}

getPixelType()

ossimPixelType ossimMapProjectionInfo::getPixelType

(

)

const

Returns data member "thePixelType".

NOTE: OSSIM_PIXEL_IS_POINT (ennumerated to a "0"): Corner coordinates are relative to the center of pixel. OSSIM_PIXEL_IS_AREA (ennumerated to a "1"): Corner coordinates are relative to the outer of the pixel.

Definition at line 231 of file ossimMapProjectionInfo.cpp.

References thePixelType.

Referenced by ossimNitfWriterBase::addBlockaTag(), llEastingNorthingPt(), llGroundPt(), lrEastingNorthingPt(), lrGroundPt(), print(), ulEastingNorthingPt(), ulGroundPt(), urEastingNorthingPt(), and urGroundPt().

{
   return thePixelType;
}

getProjection()

const ossimMapProjection * ossimMapProjectionInfo::getProjection

(

)

const

Returns reference to "theProjection".

Definition at line 256 of file ossimMapProjectionInfo.cpp.

References theProjection.

Referenced by ossimGeoTiff::writeTags().

{
   return theProjection;
}

getUsSurveyFeetPerPixel()

ossimDpt ossimMapProjectionInfo::getUsSurveyFeetPerPixel

(

)

const

Returns the pixel size in U.S.

Survey feet. x = sample direction y = line direction

NOTE: The US survey feet per meter converion (0.3048006096 feet per meter) is NOT the same as the standard feet per meter conversion (0.3048 feet per meter).

Definition at line 534 of file ossimMapProjectionInfo.cpp.

References getMetersPerPixel(), ossim::mtrs2usft(), ossimDpt::x, and ossimDpt::y.

Referenced by print().

{
   ossimDpt pt = getMetersPerPixel();
   
   pt.x = ossim::mtrs2usft(pt.x);
   pt.y = ossim::mtrs2usft(pt.y);

   return pt;
}

initializeMembers()

void ossimMapProjectionInfo::initializeMembers ( const ossimDrect &  output_rect )

private

Definition at line 100 of file ossimMapProjectionInfo.cpp.

References ossimDrect::height(), ossimMapProjection::inverse(), ossimMapProjection::lineSampleToEastingNorthing(), ossimMapProjection::lineSampleToWorld(), ossimDrect::ll(), ossimDrect::lr(), theBoundingRect, theCenterEastingNorthingPt, theCenterGroundPt, theCornerEastingNorthingPt, theCornerGroundPt, theLinesPerImage, thePixelsPerLine, theProjection, ossimDrect::ul(), ossimDrect::ur(), ossimDrect::width(), ossimDpt::x, and ossimDpt::y.

Referenced by ossimMapProjectionInfo().

{
   theBoundingRect = rect;
   theLinesPerImage  = ossim::round<int>(rect.height());
   thePixelsPerLine  = ossim::round<int>(rect.width());

   theProjection->lineSampleToWorld(rect.ul(),
                                    theCornerGroundPt[0]);
   
   theProjection->lineSampleToWorld(rect.ur(),
                                    theCornerGroundPt[1]);
   
   theProjection->lineSampleToWorld(rect.lr(), 
                                    theCornerGroundPt[2]);
   
   
   theProjection->lineSampleToWorld(rect.ll(), 
                                    theCornerGroundPt[3]);

   theProjection->lineSampleToEastingNorthing(rect.ul(),
                                              theCornerEastingNorthingPt[0]);

   theProjection->lineSampleToEastingNorthing(rect.ur(), 
                                              theCornerEastingNorthingPt[1]);
   
   theProjection->lineSampleToEastingNorthing(rect.lr(),
                                              theCornerEastingNorthingPt[2]);
   
   theProjection->lineSampleToEastingNorthing(rect.ll(), 
                                              theCornerEastingNorthingPt[3]);
   
   theCenterEastingNorthingPt.x = (theCornerEastingNorthingPt[0].x +
                                   theCornerEastingNorthingPt[1].x +
                                   theCornerEastingNorthingPt[2].x +
                                   theCornerEastingNorthingPt[3].x) / 4.0;
   
   theCenterEastingNorthingPt.y = (theCornerEastingNorthingPt[0].y +
                                   theCornerEastingNorthingPt[1].y +
                                   theCornerEastingNorthingPt[2].y +
                                   theCornerEastingNorthingPt[3].y) / 4.0;
   
   theCenterGroundPt = theProjection->inverse(theCenterEastingNorthingPt);
}

linesPerImage()

ossim_int32 ossimMapProjectionInfo::linesPerImage

(

)

const

Returns

The lines per image.

Definition at line 400 of file ossimMapProjectionInfo.cpp.

References theLinesPerImage.

Referenced by ossimNitfWriterBase::addBlockaTag().

{
   return theLinesPerImage;
}

llEastingNorthingPt()

ossimDpt ossimMapProjectionInfo::llEastingNorthingPt

(

)

const

Returns the lower left easting and northing as a ossimDpt.

The easting is "u" and the northing is "v". Units are in meters.

Definition at line 309 of file ossimMapProjectionInfo.cpp.

References getMetersPerPixel(), getPixelType(), OSSIM_PIXEL_IS_AREA, theCornerEastingNorthingPt, ossimDpt::x, and ossimDpt::y.

Referenced by llEastingNorthingPtInFt(), and ossimNitfWriterBase::writeGeometry().

{
   if (getPixelType() == OSSIM_PIXEL_IS_AREA)
   {
      ossimDpt mpp = getMetersPerPixel();
      ossimDpt pt;
      pt.x = theCornerEastingNorthingPt[3].x - (mpp.x / 2.0);
      pt.y = theCornerEastingNorthingPt[3].y - (mpp.y / 2.0);
      return pt;      
   }
   else
   {
      return theCornerEastingNorthingPt[3];
   }
}

llEastingNorthingPtInFt()

ossimDpt ossimMapProjectionInfo::llEastingNorthingPtInFt

(

)

const

Returns the lower left easting and northing as a ossimDpt.

The easting is "u" and the northing is "v". Units are in U.S. Survey feet.

Definition at line 521 of file ossimMapProjectionInfo.cpp.

References llEastingNorthingPt(), ossim::mtrs2usft(), ossimDpt::x, and ossimDpt::y.

{
   ossimDpt pt = llEastingNorthingPt();
   pt.x = ossim::mtrs2usft(pt.x);
   pt.y = ossim::mtrs2usft(pt.y);
   return pt;
}

llGroundPt()

ossimGpt ossimMapProjectionInfo::llGroundPt

(

)

const

Returns the lower left ground point.

Definition at line 373 of file ossimMapProjectionInfo.cpp.

References getDecimalDegreesPerPixel(), getPixelType(), ossimGpt::latd(), ossimGpt::lond(), OSSIM_PIXEL_IS_AREA, theCornerGroundPt, ossimDpt::x, and ossimDpt::y.

Referenced by ossimNitfWriterBase::addBlockaTag(), and ossimNitfWriterBase::writeGeometry().

{
   if (getPixelType() == OSSIM_PIXEL_IS_AREA)
   {
      ossimDpt ddpp = getDecimalDegreesPerPixel();
      ossimGpt gpt;
      gpt.latd(theCornerGroundPt[3].latd() - (ddpp.y / 2.0));
      gpt.lond(theCornerGroundPt[3].lond() - (ddpp.x / 2.0));
      return gpt;
   }
   else
   {
      return theCornerGroundPt[3];
   }   
}

loadState()

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

virtual

Method to the load (recreate) the state of the object from a keyword list. Return true if ok or false on error.

Reimplemented from ossimObject.

Definition at line 410 of file ossimMapProjectionInfo.cpp.

References ossimString::contains(), ossimString::downcase(), ossimKeywordlist::find(), OSSIM_PIXEL_IS_AREA, OSSIM_PIXEL_IS_POINT, OUTPUT_US_FT_INFO_KW, ossimKeywordNames::PIXEL_TYPE_KW, README_IMAGE_STRING_KW, theImageInfoString, theOutputInfoInFeetFlag, and thePixelType.

{
   const char* lookupReturn = kwl.find(README_IMAGE_STRING_KW);

   //***
   // "theImageInfoString" goes in the README file "Image:" field and can
   // be used to identify the image.
   //***
   if (lookupReturn) theImageInfoString = lookupReturn;
   
   lookupReturn = kwl.find(ossimKeywordNames::PIXEL_TYPE_KW);

   if (lookupReturn)
   {
      ossimString tmp = lookupReturn;

      tmp.downcase();

      if (tmp.contains("area"))
      {
         thePixelType = OSSIM_PIXEL_IS_AREA;
      }
      else
      {
         thePixelType = OSSIM_PIXEL_IS_POINT;
      }
   }

   lookupReturn = kwl.find(OUTPUT_US_FT_INFO_KW);

   if (lookupReturn)
   {
      int tmp = atoi(lookupReturn);

      if (tmp)
      {
         theOutputInfoInFeetFlag = true;
      }
      else
      {
         theOutputInfoInFeetFlag = false;
      }
   }

   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "DEBUG ossimMapProjectionInfo::loadState:"
         << "\ntheImageInfoString:       " << theImageInfoString
         << "\nthePixelType:             " << int(thePixelType)
         << "\ntheOutputInfoInFeetFlag:  " << theOutputInfoInFeetFlag
         << endl;
   }

   return true;
}

lrEastingNorthingPt()

ossimDpt ossimMapProjectionInfo::lrEastingNorthingPt

(

)

const

Returns the lower right easting and northing as a ossimDpt.

The easting is "u" and the northing is "v". Units are in meters.

Definition at line 293 of file ossimMapProjectionInfo.cpp.

References getMetersPerPixel(), getPixelType(), OSSIM_PIXEL_IS_AREA, theCornerEastingNorthingPt, ossimDpt::x, and ossimDpt::y.

Referenced by lrEastingNorthingPtInFt(), and ossimNitfWriterBase::writeGeometry().

{
   if (getPixelType() == OSSIM_PIXEL_IS_AREA)
   {
      ossimDpt mpp = getMetersPerPixel();
      ossimDpt pt;
      pt.x = theCornerEastingNorthingPt[2].x + (mpp.x / 2.0);
      pt.y = theCornerEastingNorthingPt[2].y - (mpp.y / 2.0);
      return pt;      
   }
   else
   {
      return theCornerEastingNorthingPt[2];
   }
}

lrEastingNorthingPtInFt()

ossimDpt ossimMapProjectionInfo::lrEastingNorthingPtInFt

(

)

const

Returns the lower right easting and northing as a ossimDpt.

The easting is "u" and the northing is "v". Units are in U.S. Survey feet.

Definition at line 513 of file ossimMapProjectionInfo.cpp.

References lrEastingNorthingPt(), ossim::mtrs2usft(), ossimDpt::x, and ossimDpt::y.

{
   ossimDpt pt = lrEastingNorthingPt();
   pt.x = ossim::mtrs2usft(pt.x);
   pt.y = ossim::mtrs2usft(pt.y);
   return pt;
}

lrGroundPt()

ossimGpt ossimMapProjectionInfo::lrGroundPt

(

)

const

Returns the lower right ground point.

Definition at line 357 of file ossimMapProjectionInfo.cpp.

References getDecimalDegreesPerPixel(), getPixelType(), ossimGpt::latd(), ossimGpt::lond(), OSSIM_PIXEL_IS_AREA, theCornerGroundPt, ossimDpt::x, and ossimDpt::y.

Referenced by ossimNitfWriterBase::addBlockaTag(), and ossimNitfWriterBase::writeGeometry().

{
   if (getPixelType() == OSSIM_PIXEL_IS_AREA)
   {
      ossimDpt ddpp = getDecimalDegreesPerPixel();
      ossimGpt gpt;
      gpt.latd(theCornerGroundPt[2].latd() - (ddpp.y / 2.0));
      gpt.lond(theCornerGroundPt[2].lond() + (ddpp.x / 2.0));
      return gpt;
   }
   else
   {
      return theCornerGroundPt[2];
   }
}

operator=()

ossimMapProjectionInfo& ossimMapProjectionInfo::operator= ( const ossimMapProjectionInfo &  )

private

pixelsPerLine()

ossim_int32 ossimMapProjectionInfo::pixelsPerLine

(

)

const

Returns

The pixels per line (samples).

Definition at line 405 of file ossimMapProjectionInfo.cpp.

References thePixelsPerLine.

{
   return thePixelsPerLine;
}

print()

std::ostream & ossimMapProjectionInfo::print ( std::ostream &  os ) const

virtual

Formatted print of data members.

Used by operator <<.

Reimplemented from ossimObject.

Definition at line 176 of file ossimMapProjectionInfo.cpp.

References getDecimalDegreesPerPixel(), getMetersPerPixel(), getPixelType(), ossimMapProjection::getProjectionName(), getUsSurveyFeetPerPixel(), OSSIM_PIXEL_IS_POINT, ossimMapProjection::print(), theCenterEastingNorthingPt, theCenterGroundPt, theCornerEastingNorthingPt, theCornerGroundPt, theLinesPerImage, thePixelsPerLine, and theProjection.

{
   if (!os)
   {
      return os;
   }

   os << setiosflags(ios::left)
      << setiosflags(ios::fixed)
      << "ossimMapProjectionInfo Data Members:\n"
      << "Projection name:  " << theProjection->getProjectionName()
      << setw(30) << "\nOutput pixel type:"
      << ((getPixelType() == OSSIM_PIXEL_IS_POINT) ? "pixel is point" :
          "pixel is area")
      << setw(30) << "\nMeters per pixel:"
      << getMetersPerPixel()
      << setw(30) << "\nUS survey feet per pixel:"
      << getUsSurveyFeetPerPixel()
      << setw(30) << "\nDecimal degrees per pixel:"
      << getDecimalDegreesPerPixel()
      << setw(30) << "\nNumber of lines:"
      << theLinesPerImage
      << setw(30) << "\nNumber of pixels:"
      << thePixelsPerLine
      << setw(30) << "\nUpper left ground point:"
      << theCornerGroundPt[0]
      << setw(30) << "\nUpper right ground point:"
      << theCornerGroundPt[1]
      << setw(30) << "\nLower right ground point:"
      << theCornerGroundPt[2]
      << setw(30) << "\nLower left ground point:"
      << theCornerGroundPt[3]
      << setw(30) << "\nUpper left easting_northing:"
      << theCornerEastingNorthingPt[0]
      << setw(30) << "\nUpper right easting_northing:"
      << theCornerEastingNorthingPt[1]
      << setw(30) << "\nLower right easting_northing:"
      << theCornerEastingNorthingPt[2]
      << setw(30) << "\nLower left easting_northing:"
      << theCornerEastingNorthingPt[3]
      << setw(30) << "\nCenter ground point:"
      << theCenterGroundPt
      << setw(30) << "\nCenter easting_northing:"
      << theCenterEastingNorthingPt
      << "\nMap Projection dump:";
   theProjection->print(os);

   return os;
}

saveState()

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

virtual

Method to save the state of the object to a keyword list. Return true if ok or false on error.

Reimplemented from ossimObject.

Definition at line 468 of file ossimMapProjectionInfo.cpp.

References ossimKeywordlist::add(), ossimString::chars(), OSSIM_PIXEL_IS_POINT, OUTPUT_US_FT_INFO_KW, PIXEL_TYPE_KW, README_IMAGE_STRING_KW, theImageInfoString, theOutputInfoInFeetFlag, and thePixelType.

{
   kwl.add(README_IMAGE_STRING_KW,
           theImageInfoString.chars());
   
   ossimString tmp;
   
   if (thePixelType == OSSIM_PIXEL_IS_POINT)
   {
      tmp = "point";
   }
   else
   {
      tmp = "area";
   }
   
   kwl.add(PIXEL_TYPE_KW,
           tmp.chars());

   kwl.add(OUTPUT_US_FT_INFO_KW,
           int(theOutputInfoInFeetFlag));
   
   return true;
}

setImageInfoString()

void ossimMapProjectionInfo::setImageInfoString

(

const ossimString &

string

)

Used to set data member "theImageInfoString".

This will be output in the "Image: " field of the README file.

Definition at line 251 of file ossimMapProjectionInfo.cpp.

References theImageInfoString.

{
   theImageInfoString = string;
}

setOutputFeetFlag()

void ossimMapProjectionInfo::setOutputFeetFlag

(

bool

flag

)

Sets the data member "theOutputInfoInFeetFlag".

Definition at line 236 of file ossimMapProjectionInfo.cpp.

References theOutputInfoInFeetFlag.

{
   theOutputInfoInFeetFlag = flag;
}

setPixelType()

void ossimMapProjectionInfo::setPixelType

(

ossimPixelType

type

)

Sets the data member "thePixelType".

NOTE: PIXEL_IS_POINT (ennumerated to a "0"): Corner coordinates are relative to the center of pixel. PIXEL_IS_AREA (ennumerated to a "1"): Corner coordinates are relative to the outer edge of the pixel.

Definition at line 226 of file ossimMapProjectionInfo.cpp.

References thePixelType.

Referenced by ossimNitfWriterBase::addBlockaTag(), ossimNitfWriterBase::writeGeometry(), and ossimGeoTiff::writeJp2GeotiffBox().

{
   thePixelType = type;
}

ulEastingNorthingPt()

ossimDpt ossimMapProjectionInfo::ulEastingNorthingPt

(

)

const

Returns the upper left easting and northing as a ossimDpt.

The easting is "u" and the northing is "v". Units are in meters.

Definition at line 261 of file ossimMapProjectionInfo.cpp.

References getMetersPerPixel(), getPixelType(), OSSIM_PIXEL_IS_AREA, theCornerEastingNorthingPt, ossimDpt::x, and ossimDpt::y.

Referenced by getGeom(), ulEastingNorthingPtInFt(), and ossimNitfWriterBase::writeGeometry().

{
   if (getPixelType() == OSSIM_PIXEL_IS_AREA)
   {
      ossimDpt mpp = getMetersPerPixel();
      ossimDpt pt;
      pt.x = theCornerEastingNorthingPt[0].x - (mpp.x / 2.0);
      pt.y = theCornerEastingNorthingPt[0].y + (mpp.y / 2.0);
      return pt;
   }
   else
   {
      return theCornerEastingNorthingPt[0];
   }
}

ulEastingNorthingPtInFt()

ossimDpt ossimMapProjectionInfo::ulEastingNorthingPtInFt

(

)

const

Returns the upper left easting and northing as a ossimDpt.

The easting is "u" and the northing is "v". Units are in U.S. Survey feet.

Definition at line 494 of file ossimMapProjectionInfo.cpp.

References ossim::mtrs2usft(), ulEastingNorthingPt(), ossimDpt::x, and ossimDpt::y.

{
   ossimDpt pt = ulEastingNorthingPt();
   
   pt.x = ossim::mtrs2usft(pt.x);
   
   pt.y = ossim::mtrs2usft(pt.y);
   
   return pt;
}

ulGroundPt()

ossimGpt ossimMapProjectionInfo::ulGroundPt

(

)

const

Returns the upper left ground point.

Definition at line 325 of file ossimMapProjectionInfo.cpp.

References getDecimalDegreesPerPixel(), getPixelType(), ossimGpt::latd(), ossimGpt::lond(), OSSIM_PIXEL_IS_AREA, theCornerGroundPt, ossimDpt::x, and ossimDpt::y.

Referenced by ossimNitfWriterBase::addBlockaTag(), getGeom(), and ossimNitfWriterBase::writeGeometry().

{
   if (getPixelType() == OSSIM_PIXEL_IS_AREA)
   {
      ossimDpt ddpp = getDecimalDegreesPerPixel();
      ossimGpt gpt;
      gpt.latd(theCornerGroundPt[0].latd() + (ddpp.y / 2.0));
      gpt.lond(theCornerGroundPt[0].lond() - (ddpp.x / 2.0));
      return gpt;
   }
   else
   {
      return theCornerGroundPt[0];
   } 
}

unitsInFeet()

bool ossimMapProjectionInfo::unitsInFeet

(

)

const

Returns the data member "theOutputInfoInFeetFlag".

True = feet, false = meters.

Definition at line 241 of file ossimMapProjectionInfo.cpp.

References theOutputInfoInFeetFlag.

{
   return theOutputInfoInFeetFlag;
}

urEastingNorthingPt()

ossimDpt ossimMapProjectionInfo::urEastingNorthingPt

(

)

const

Returns the upper right easting and northing as a ossimDpt.

The easting is "u" and the northing is "v". Units are in meters.

Definition at line 277 of file ossimMapProjectionInfo.cpp.

References getMetersPerPixel(), getPixelType(), OSSIM_PIXEL_IS_AREA, theCornerEastingNorthingPt, ossimDpt::x, and ossimDpt::y.

Referenced by urEastingNorthingPtInFt(), and ossimNitfWriterBase::writeGeometry().

{
   if (getPixelType() == OSSIM_PIXEL_IS_AREA)
   {
      ossimDpt mpp = getMetersPerPixel();
      ossimDpt pt;
      pt.x = theCornerEastingNorthingPt[1].x + (mpp.x / 2.0);
      pt.y = theCornerEastingNorthingPt[1].y + (mpp.y / 2.0);
      return pt;      
   }
   else
   {
      return theCornerEastingNorthingPt[1];
   }
}

urEastingNorthingPtInFt()

ossimDpt ossimMapProjectionInfo::urEastingNorthingPtInFt

(

)

const

Returns the upper right easting and northing as a ossimDpt.

The easting is "u" and the northing is "v". Units are in U.S. Survey feet.

Definition at line 505 of file ossimMapProjectionInfo.cpp.

References ossim::mtrs2usft(), urEastingNorthingPt(), ossimDpt::x, and ossimDpt::y.

{
   ossimDpt pt = urEastingNorthingPt();
   pt.x = ossim::mtrs2usft(pt.x);
   pt.y = ossim::mtrs2usft(pt.y);
   return pt;
}

urGroundPt()

ossimGpt ossimMapProjectionInfo::urGroundPt

(

)

const

Returns the upper right ground point.

Definition at line 341 of file ossimMapProjectionInfo.cpp.

References getDecimalDegreesPerPixel(), getPixelType(), ossimGpt::latd(), ossimGpt::lond(), OSSIM_PIXEL_IS_AREA, theCornerGroundPt, ossimDpt::x, and ossimDpt::y.

Referenced by ossimNitfWriterBase::addBlockaTag(), and ossimNitfWriterBase::writeGeometry().

{
   if (getPixelType() == OSSIM_PIXEL_IS_AREA)
   {
      ossimDpt ddpp = getDecimalDegreesPerPixel();
      ossimGpt gpt;
      gpt.latd(theCornerGroundPt[1].latd() + (ddpp.y / 2.0));
      gpt.lond(theCornerGroundPt[1].lond() + (ddpp.x / 2.0));
      return gpt;
   }
   else
   {
      return theCornerGroundPt[1];
   }
}

Member Data Documentation

OUTPUT_US_FT_INFO_KW

const char * ossimMapProjectionInfo::OUTPUT_US_FT_INFO_KW

static

Initial value:

=
"viewinfo.output_readme_in_us_ft_flag"

Definition at line 223 of file ossimMapProjectionInfo.h.

Referenced by loadState(), and saveState().

PIXEL_TYPE_KW

const char * ossimMapProjectionInfo::PIXEL_TYPE_KW = "viewinfo.pixel_type"

static

Definition at line 222 of file ossimMapProjectionInfo.h.

Referenced by saveState().

README_IMAGE_STRING_KW

const char * ossimMapProjectionInfo::README_IMAGE_STRING_KW

static

Initial value:

=
"viewinfo.readme_image_string"

Definition at line 221 of file ossimMapProjectionInfo.h.

Referenced by loadState(), and saveState().

theBoundingRect

ossimDrect ossimMapProjectionInfo::theBoundingRect

private

Definition at line 247 of file ossimMapProjectionInfo.h.

Referenced by initializeMembers().

theCenterEastingNorthingPt

ossimDpt ossimMapProjectionInfo::theCenterEastingNorthingPt

private

Definition at line 246 of file ossimMapProjectionInfo.h.

Referenced by centerEastingNorthingPt(), initializeMembers(), and print().

theCenterGroundPt

ossimGpt ossimMapProjectionInfo::theCenterGroundPt

private

Definition at line 245 of file ossimMapProjectionInfo.h.

Referenced by centerGroundPt(), initializeMembers(), and print().

theCornerEastingNorthingPt

ossimDpt ossimMapProjectionInfo::theCornerEastingNorthingPt[4]

private

Definition at line 244 of file ossimMapProjectionInfo.h.

Referenced by initializeMembers(), llEastingNorthingPt(), lrEastingNorthingPt(), print(), ulEastingNorthingPt(), and urEastingNorthingPt().

theCornerGroundPt

ossimGpt ossimMapProjectionInfo::theCornerGroundPt[4]

private

Definition at line 243 of file ossimMapProjectionInfo.h.

Referenced by initializeMembers(), llGroundPt(), lrGroundPt(), print(), ulGroundPt(), and urGroundPt().

theErrorStatus

bool ossimMapProjectionInfo::theErrorStatus

mutableprivate

Definition at line 240 of file ossimMapProjectionInfo.h.

Referenced by errorStatus(), and ossimMapProjectionInfo().

theImageInfoString

ossimString ossimMapProjectionInfo::theImageInfoString

private

"theImageInfoString" goes in the README file "Image:" field to identify the image.

Definition at line 273 of file ossimMapProjectionInfo.h.

Referenced by getImageInfoString(), loadState(), saveState(), and setImageInfoString().

theLinesPerImage

int ossimMapProjectionInfo::theLinesPerImage

private

Definition at line 241 of file ossimMapProjectionInfo.h.

Referenced by initializeMembers(), linesPerImage(), and print().

theOutputInfoInFeetFlag

bool ossimMapProjectionInfo::theOutputInfoInFeetFlag

private

If "theOutputInfoInFeetFlag" is true the readme file tie point info will be output in both meters and U.S.

feet. NOTE: U.S. feet conversion is "meters/0.3048006096" not the standard "meters/0.3048". Reference for U.S. feet value: U.S.G.S. "Map Projections - A Working Manual" USGS Professional paper 1395 page 51.

Definition at line 267 of file ossimMapProjectionInfo.h.

Referenced by loadState(), saveState(), setOutputFeetFlag(), and unitsInFeet().

thePixelsPerLine

int ossimMapProjectionInfo::thePixelsPerLine

private

Definition at line 242 of file ossimMapProjectionInfo.h.

Referenced by initializeMembers(), pixelsPerLine(), and print().

thePixelType

ossimPixelType ossimMapProjectionInfo::thePixelType

private

"thePixelType" defines whether the tie point coordinates are relative to the center of the pixel(which is PIXEL_IS_POINT) or the upper left corner of the pixel(PIXEL_IS_AREA).

The default pixle type is PIXEL_IS_POINT.

Definition at line 255 of file ossimMapProjectionInfo.h.

Referenced by getPixelType(), loadState(), saveState(), and setPixelType().

theProjection

const ossimMapProjection* ossimMapProjectionInfo::theProjection

private

Definition at line 239 of file ossimMapProjectionInfo.h.

Referenced by getDecimalDegreesPerPixel(), getGeom(), getMetersPerPixel(), getProjection(), initializeMembers(), ossimMapProjectionInfo(), and print().

---

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

• ossimMapProjectionInfo.h
• ossimMapProjectionInfo.cpp