ossimNitfProjectionParameterTag Class Reference

#include <ossimNitfProjectionParameterTag.h>

Inheritance diagram for ossimNitfProjectionParameterTag:

Public Member Functions
	ossimNitfProjectionParameterTag ()
virtual	~ossimNitfProjectionParameterTag ()
virtual void	parseStream (std::istream &in)
virtual void	writeStream (std::ostream &out)
virtual std::ostream &	print (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 ossim_uint32	getSizeInBytes () const
	Returns the length in bytes of the tag from the CEL or REL field. More...
virtual void	clearFields ()
virtual void	clearParameters ()
virtual void	addParameter (const ossimString &param)
virtual void	addParameter (const ossim_float64 &param)
void	setName (const ossimString &name)
void	setCode (const ossimString &code)
ossimString	getName () const
ossimString	getCode () const
void	setFalseX (double falseX)
void	setFalseY (double falseY)
double	getFalseX () const
double	getFalseY () const
Public Member Functions inherited from ossimNitfRegisteredTag
	ossimNitfRegisteredTag ()
	default constructor More...
	ossimNitfRegisteredTag (const std::string &tagName, ossim_uint32 tagLength)
	Constructor that takes name and size. More...
virtual	~ossimNitfRegisteredTag ()
	destructor More...
virtual std::string	getRegisterTagName () const
	This will return the name of the registered tag for this user defined header. More...
virtual const std::string &	getTagName () const
	This will return the name of the registered tag for this user defined header. More...
virtual void	setTagName (const std::string &tagName)
virtual ossim_uint32	getTagLength () const
	Returns the length in bytes of the tag from the CEL or REL field. More...
virtual void	setTagLength (ossim_uint32 length)
	Set the tag length. More...
virtual void	parseStream (ossim::istream &in)=0
	This will allow the user defined data to parse the stream. More...
virtual void	writeStream (ossim::ostream &out)=0
virtual void	setProperty (ossimRefPtr< ossimProperty > property)
virtual ossimRefPtr< ossimProperty >	getProperty (const ossimString &name) const
virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const
virtual void	getMetadata (ossimKeywordlist &kwl, const char *prefix=0) const
	Default interface to populate keyword list with metadata. 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 Attributes
char	theProjectionName [81]
	FIELD: PRN. More...
char	theProjectionCode [3]
	FIELD: PCO. More...
char	theNumberOfParameters [2]
	FIELD: NUM_PRJ. More...
std::vector< ossimString >	theProjectionParameters
	FIELD(S): PRJn. More...
char	theFalseXOrigin [16]
	FIELD: XOR. More...
char	theFalseYOrigin [16]
	FIELD: YOR. More...
Protected Attributes inherited from ossimNitfRegisteredTag
std::string	m_tagName
ossim_uint32	m_tagLength

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

Detailed Description

Definition at line 18 of file ossimNitfProjectionParameterTag.h.

Constructor & Destructor Documentation

ossimNitfProjectionParameterTag()

ossimNitfProjectionParameterTag::ossimNitfProjectionParameterTag

(

)

Definition at line 16 of file ossimNitfProjectionParameterTag.cpp.

References clearFields().

   :ossimNitfRegisteredTag(std::string("PRJPSB"), 0 )
{
   clearFields();
}

~ossimNitfProjectionParameterTag()

ossimNitfProjectionParameterTag::~ossimNitfProjectionParameterTag ( )

virtual

Definition at line 22 of file ossimNitfProjectionParameterTag.cpp.

{
}

Member Function Documentation

addParameter() [1/2]

void ossimNitfProjectionParameterTag::addParameter ( const ossimString &  param )

virtual

Definition at line 134 of file ossimNitfProjectionParameterTag.cpp.

References ossimString::c_str(), and theProjectionParameters.

Referenced by addParameter().

{
   std::ostringstream out;

   out << std::setw(15)
       << std::setfill('0')
       << param.c_str();

   theProjectionParameters.push_back(out.str());
}

addParameter() [2/2]

void ossimNitfProjectionParameterTag::addParameter ( const ossim_float64 &  param )

virtual

Definition at line 145 of file ossimNitfProjectionParameterTag.cpp.

References addParameter(), and ossimString::toString().

{
   addParameter(ossimString::toString(param));
}

clearFields()

void ossimNitfProjectionParameterTag::clearFields ( )

virtual

Definition at line 108 of file ossimNitfProjectionParameterTag.cpp.

References ossimNitfRegisteredTag::setTagLength(), theFalseXOrigin, theFalseYOrigin, theNumberOfParameters, theProjectionCode, theProjectionName, and theProjectionParameters.

Referenced by ossimNitfProjectionParameterTag(), and parseStream().

{
   theProjectionParameters.clear();
   
   memset(theProjectionName, ' ', 80);
   memset(theProjectionCode, ' ', 2);
   memset(theNumberOfParameters, '0', 1);
   memset(theFalseXOrigin, '0', 15);
   memset(theFalseYOrigin, '0', 15);

   theProjectionName[80] = '\0';
   theProjectionCode[2] = '\0';
   theNumberOfParameters[1] = '\0';
   theFalseXOrigin[15] = '\0';
   theFalseYOrigin[15] = '\0';

   // Set the base tag length.
   setTagLength( 0 );
}

clearParameters()

void ossimNitfProjectionParameterTag::clearParameters ( )

virtual

Definition at line 128 of file ossimNitfProjectionParameterTag.cpp.

References theNumberOfParameters, and theProjectionParameters.

{
   theProjectionParameters.clear();
   theNumberOfParameters[0] = '0';
}

getCode()

ossimString ossimNitfProjectionParameterTag::getCode

(

)

const

Definition at line 177 of file ossimNitfProjectionParameterTag.cpp.

References theProjectionCode, and ossimString::trim().

{
   return ossimString(theProjectionCode).trim();
}

getFalseX()

double ossimNitfProjectionParameterTag::getFalseX

(

)

const

Definition at line 204 of file ossimNitfProjectionParameterTag.cpp.

References theFalseXOrigin, and ossimString::toDouble().

{
   return ossimString(theFalseXOrigin).toDouble();
}

getFalseY()

double ossimNitfProjectionParameterTag::getFalseY

(

)

const

Definition at line 209 of file ossimNitfProjectionParameterTag.cpp.

References theFalseYOrigin, and ossimString::toDouble().

{
   return ossimString(theFalseYOrigin).toDouble();
}

getName()

ossimString ossimNitfProjectionParameterTag::getName

(

)

const

Definition at line 172 of file ossimNitfProjectionParameterTag.cpp.

References theProjectionName, and ossimString::trim().

{
   return ossimString(theProjectionName).trim();
}

getSizeInBytes()

ossim_uint32 ossimNitfProjectionParameterTag::getSizeInBytes ( ) const

virtual

Returns the length in bytes of the tag from the CEL or REL field.

Note

Depricated use: getTagLength()

The entire TRE length is 11 plus this(the size of the CEL or REL field).

Returns

Length of REDATA or CEDATA.

Reimplemented from ossimNitfRegisteredTag.

Definition at line 74 of file ossimNitfProjectionParameterTag.cpp.

References theProjectionParameters.

Referenced by parseStream().

{
   return (113 + (ossim_uint32)theProjectionParameters.size()*15);
}

parseStream()

void ossimNitfProjectionParameterTag::parseStream ( std::istream &  in )

virtual

Definition at line 26 of file ossimNitfProjectionParameterTag.cpp.

References clearFields(), getSizeInBytes(), ossimNitfRegisteredTag::setTagLength(), theFalseXOrigin, theFalseYOrigin, theNumberOfParameters, theProjectionCode, theProjectionName, theProjectionParameters, and ossimString::toUInt32().

{
   clearFields();
   
   in.read(theProjectionName, 80);
   in.read(theProjectionCode, 2);
   in.read(theNumberOfParameters, 1);

   ossim_uint32 numberOfParameters = ossimString(theNumberOfParameters).toUInt32();

   for(ossim_uint32 i = 0; i < numberOfParameters; ++i)
   {
      char param[15];

      in.read(param, 15);
      theProjectionParameters.push_back(ossimString(param,
                                                    param + 15));
   }
   in.read(theFalseXOrigin, 15);
   in.read(theFalseYOrigin, 15);

   // Set the base tag length.
   setTagLength( getSizeInBytes() );
}

print()

std::ostream & ossimNitfProjectionParameterTag::print ( std::ostream &  out, const std::string &  prefix = std::string()  ) const

virtual

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

Parameters

out	Stream to output to.
prefix	Prefix added to key like "image0.";

Reimplemented from ossimNitfRegisteredTag.

Definition at line 79 of file ossimNitfProjectionParameterTag.cpp.

References ossimNitfRegisteredTag::getRegisterTagName(), ossimNitfRegisteredTag::getTagLength(), theFalseXOrigin, theFalseYOrigin, theNumberOfParameters, theProjectionCode, theProjectionName, theProjectionParameters, and ossimString::toString().

{
   std::string pfx = prefix;
   pfx += getRegisterTagName();
   pfx += ".";

   out << setiosflags(std::ios::left)
       << pfx << std::setw(24) << "CETAG:" << getRegisterTagName() << "\n"
       << pfx << std::setw(24) << "CEL:"   << getTagLength() << "\n"
       << pfx << std::setw(24) << "PRN:"   << theProjectionName << "\n"
       << pfx << std::setw(24) << "PCO:"   << theProjectionCode << "\n"
       << pfx << std::setw(24) << "NUM_PRJ:" << theNumberOfParameters << "\n";

   for (ossim_uint32 i = 0; i < theProjectionParameters.size(); ++i)
   {
      ossimString s = "PRJ";
      s += ossimString::toString(i);
      s += ":";
      out << pfx << std::setw(24) << s
          << theProjectionParameters[i] << "\n";
   }

   out << pfx << std::setw(24) << "XOR:"   <<theFalseXOrigin << "\n"
       << pfx << std::setw(24) << "YOR:"   <<theFalseYOrigin << std::endl;
   
   return out;   
}

setCode()

void ossimNitfProjectionParameterTag::setCode

(

const ossimString &

code

)

Definition at line 161 of file ossimNitfProjectionParameterTag.cpp.

References ossimString::c_str(), and theProjectionCode.

{
   std::ostringstream out;

   out << std::setw(2)
       << std::setfill(' ')
       << code.c_str();

   memcpy(theProjectionCode, out.str().c_str(), 2);
}

setFalseX()

void ossimNitfProjectionParameterTag::setFalseX

(

double

falseX

)

Definition at line 182 of file ossimNitfProjectionParameterTag.cpp.

References theFalseXOrigin.

{
   std::ostringstream out;
   out << std::setw(15)
       << std::setprecision(15)
       << std::setfill('0')
       << falseX;
   
   memcpy(theFalseXOrigin, out.str().c_str(), 15);
}

setFalseY()

void ossimNitfProjectionParameterTag::setFalseY

(

double

falseY

)

Definition at line 193 of file ossimNitfProjectionParameterTag.cpp.

References theFalseYOrigin.

{
   std::ostringstream out;
   out << std::setw(15)
       << std::setprecision(15)
       << std::setfill('0')
       << falseY;
   
   memcpy(theFalseYOrigin, out.str().c_str(), 15);
}

setName()

void ossimNitfProjectionParameterTag::setName

(

const ossimString &

name

)

Definition at line 150 of file ossimNitfProjectionParameterTag.cpp.

References ossimString::c_str(), and theProjectionName.

{
   std::ostringstream out;

   out << std::setw(80)
       << std::setfill(' ')
       << name.c_str();

   memcpy(theProjectionName, out.str().c_str(), 80);
}

writeStream()

void ossimNitfProjectionParameterTag::writeStream ( std::ostream &  out )

virtual

Definition at line 51 of file ossimNitfProjectionParameterTag.cpp.

References theFalseXOrigin, theFalseYOrigin, theNumberOfParameters, theProjectionCode, theProjectionName, theProjectionParameters, and ossimString::toUInt32().

{
   out.write(theProjectionName, 80);
   out.write(theProjectionCode, 2);

   {
      std::ostringstream tempOut;

      tempOut << std::setw(1)
              << theProjectionParameters.size();
      theNumberOfParameters[0] = *(tempOut.str().c_str());
   }
   out.write(theNumberOfParameters, 1);
   ossim_uint32 numberOfParameters = ossimString(theNumberOfParameters).toUInt32();

   for(ossim_uint32 i = 0; i < numberOfParameters; ++i)
   {
      out.write(theProjectionParameters[i].c_str(), 15);
   }
   out.write(theFalseXOrigin, 15);
   out.write(theFalseYOrigin, 15);
}

Member Data Documentation

theFalseXOrigin

char ossimNitfProjectionParameterTag::theFalseXOrigin[16]

protected

FIELD: XOR.

required 15 byte field.

Projection False X (Easting) Origin

This field shall contain the projection false X (easting) origin. The default value is 000000000000000, which implies that there is no projection false X origin.

Definition at line 314 of file ossimNitfProjectionParameterTag.h.

Referenced by clearFields(), getFalseX(), parseStream(), print(), setFalseX(), and writeStream().

theFalseYOrigin

char ossimNitfProjectionParameterTag::theFalseYOrigin[16]

protected

FIELD: YOR.

required 15 byte field.

Projection False Y (Northing) Origin

This field shall contain the projection false Y (northing) origin. The default value is 000000000000000, which implies that there is no projection false Y origin.

Definition at line 329 of file ossimNitfProjectionParameterTag.h.

Referenced by clearFields(), getFalseY(), parseStream(), print(), setFalseY(), and writeStream().

theNumberOfParameters

char ossimNitfProjectionParameterTag::theNumberOfParameters[2]

protected

FIELD: NUM_PRJ.

required 1 byte field ranging from 0-9

Number of Projection Parameters

This field shall contain the number of projection parameters. The PRJ Field should be repeated as necessary depending on the projection code (see Part 3-6). If the number of projection parameters provided is lower than specified in Part 3-6, the missing parameters value is 0.

Definition at line 290 of file ossimNitfProjectionParameterTag.h.

Referenced by clearFields(), clearParameters(), parseStream(), print(), and writeStream().

theProjectionCode

char ossimNitfProjectionParameterTag::theProjectionCode[3]

protected

FIELD: PCO.

required 2 byte field.

Projection Code

This field shall contain the code of the projection to which the Image Segment refers. The default value is TC.

Code values:

AC Albers Equal-Area Conic Parameters:

1. Longitude of origin
2. std. parallel nearer to equator
3. std parallel farther from equator
4. latitude of origin

AK (Lambert) Azimuthal Equal-Area Parameters:

1. Longitude of origin
2. Latitude of origin

AL Azimuthal Equidistant Parameters:

1. Longitude of origin
2. Latitude of origin

BF Bonne Parameters:

1. Longitude of origin
2. Latitude of origin
3. Scale factor at projection origin

CC Equidistant Conic with 1 Standard Parallel Parameters:

1. Longitude of origin
2. Latitude of origin
3. Latitude of Std. Parallel

CP Equirectangular Parameters:

1. Longitude of central meridian
2. Latitude of true scale
3. Radius of sphere

CS Cassini-Soldner Parameters:

1. Longitude of origin
2. Latitude of origin

ED Eckert VI Parameters:

1. Longitude of origin
2. Radius of sphere

EF Eckert IV Parameters:

1. Longitude of origin
2. Radius of sphere

GN Gnomonic Parameters:

1. Longitude of origin
2. Latitude of origin

HX Hotine Oblique Mercator based on 2 Points Parameters:

1. Scale factor at projection origin
2. latitude of projection origin
3. longitude of first point defining center line
4. latitude of fist point defining center line

KA Equidistant Conic with 2 Standard Parallels Parameters:

1. Longitude of central meridian
2. Latitude of origin
3. Latitude of standard parallel Nearer to equator
4. Latitude of standard parallel farther from equator

LA Laborde Parameters:

1. Longitude of origin
2. Latitude of origin
3. Scale factor at proj origin
4. Azimuth at origin of axis of constant scale

LE Lambert Conformal Conic Parameters:

1. Longitude of origin
2. std. parallel nearer to equator
3. std. parallel farther from equator
4. Latitude of origin

LI Cylindrical Equal Area Parameters:

1. Longitude of central meridian
2. Latitude of origin

LJ Lambert Equal-Area Meridional Parameters:

1. Longitude of central meridian
2. Latitude of origin

MC Mercator Parameters:

1. Longitude of origin
2. Latitude of true scale
3. Latitude of reference origin

MH Miller Cylindrical Parameters:

1. Longitude of central meridian
2. Radius of sphere

MJ French Lambert Parameters:

1. Longitude of origin
2. Latitude of origin
3. Scale factor at proj origin

MP Mollweide Parameters:

1. Longitude of origin
2. Radius of sphere

NT New Zealand Map Grid Parameters:

1. Longitude of origin
2. Latitude of origin

OC Oblique Mercator Parameters:

1. Longitude of origin
2. Latitude of origin
3. Azimuth
4. radius of sphere

OD Orthographic Parameters:

1. Longitude of origin
2. Latitude of origin
3. Radius of sphere

PG Polar Stereographic Parameters:

1. Latitude of true scale

PH Polyconic Parameters:

1. Longitude of central meridian
2. Latitude of origin

RS or RB Hotine Oblique Mercator (Rectified Skew Orthomorphic) Parameters:

1. Longitude of origin
2. Latitude of origin
3. Azimuth East of North for Central Line (Skew X-Axis at Proj. origin)
4. Scale factor at proj origin

RX Robinson Parameters:

1. Longitude of origin
2. Radius of sphere

SA Sinusoidal Parameters:

1. Longitude of origin
2. Radius of sphere

SD Oblique Stereographic Parameters:

1. Longitude of origin
2. Latitude of origin
3. Scale factor at origin

SX Space Oblique Mercator Parameters:

1. Application code: 1 = Landsat, USGS equations 2 = Landsat, EOSAT equations
2. Vehicle number
3. Orbital path number

TC Transverse Mercator Parameters:

1. Longitude of central meridian
2. Central Scale Factor
3. Latitude of origin

TX Transverse Cylindrical Equal Area Parameters:

1. Longitude of central meridian
2. Latitude of origin
3. Scale factor along central meridian

VA Van der Grinten Parameters:

1. Longitude of central meridian
2. Radius of sphere

VX General Vertical NearSide Perspective Parameters:

1. Longitude of origin
2. Latitude of origin
3. Heigh of perspective map above surface

ZY Other Known Projection

Definition at line 274 of file ossimNitfProjectionParameterTag.h.

Referenced by clearFields(), getCode(), parseStream(), print(), setCode(), and writeStream().

theProjectionName

char ossimNitfProjectionParameterTag::theProjectionName[81]

protected

FIELD: PRN.

required 80 byte field.

Projection Name

This field shall contain the name of the projection to which the Image Segment refers. The default value is Transverse Mercator.

Definition at line 61 of file ossimNitfProjectionParameterTag.h.

Referenced by clearFields(), getName(), parseStream(), print(), setName(), and writeStream().

theProjectionParameters

std::vector<ossimString> ossimNitfProjectionParameterTag::theProjectionParameters

protected

FIELD(S): PRJn.

Conditional 15 byte field each.

Projection Parameter Each occurrence of this field provides an appropriate parameter to accurately describe the projection. See Part 3-6 to know the kind of parameters needed for each projection code. 15 BCS-N C

Definition at line 301 of file ossimNitfProjectionParameterTag.h.

Referenced by addParameter(), clearFields(), clearParameters(), getSizeInBytes(), parseStream(), print(), and writeStream().

---

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

• ossimNitfProjectionParameterTag.h
• ossimNitfProjectionParameterTag.cpp