OSSIM - Open Source Software Image Map  Version 1.9.0 (20180803)
Public Types | Public Member Functions | Protected Attributes | List of all members
ossimNitfCsccgaTag Class Reference

All comments in this document were taken from the online resource found at: More...

#include <ossimNitfCsccgaTag.h>

Inheritance diagram for ossimNitfCsccgaTag:
ossimNitfRegisteredTag ossimObject ossimPropertyInterface ossimReferenced

Public Types

enum  {
  CCG_SOURCE_SIZE = 18, REG_SENSOR_SIZE = 6, ORIGIN_LINE_SIZE = 7, ORIGIN_SAMPLE_SIZE = 5,
  AS_CELL_SIZE_SIZE = 7, CS_CELL_SIZE_SIZE = 5, CCG_MAX_LINE_SIZE = 7, CCG_MAX_SAMPLE_SIZE = 5,
  CEL_SIZE = 60
}
 

Public Member Functions

 ossimNitfCsccgaTag ()
 
virtual void parseStream (ossim::istream &in)
 This will allow the user defined data to parse the stream. More...
 
virtual void writeStream (ossim::ostream &out)
 
virtual std::ostream & print (std::ostream &out, const std::string &prefix=std::string()) const
 Pure virtual print method that outputs a key/value type format adding prefix to keys. More...
 
virtual void clearFields ()
 
- 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 getSizeInBytes () const
 Returns the length in bytes of the tag from the CEL or REL field. More...
 
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 setProperty (ossimRefPtr< ossimProperty > property)
 
virtual ossimRefPtr< ossimPropertygetProperty (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 ossimObjectdup () 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 &)
 
ossimReferencedoperator= (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 m_ccgSource [CCG_SOURCE_SIZE+1]
 Field: CCG_SOURCE. More...
 
char m_regSensor [REG_SENSOR_SIZE+1]
 
Field: REG_SENSOR More...
 
char m_originLine [ORIGIN_LINE_SIZE+1]
 Field: ORIGIN_LINE. More...
 
char m_originSample [ORIGIN_SAMPLE_SIZE+1]
 Field: ORIGIN_SAMPLE. More...
 
char m_asCellSize [AS_CELL_SIZE_SIZE+1]
 Field: AS_CELL_SIZE. More...
 
char m_csCellSize [CS_CELL_SIZE_SIZE+1]
 Field: CS_CELL_SIZE. More...
 
char m_ccgMaxLine [CCG_MAX_LINE_SIZE+1]
 Field: CCG_MAX_LINE. More...
 
char m_ccgMaxSample [CCG_MAX_SAMPLE_SIZE+1]
 Field: CCG_MAX_SAMPLE. 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

All comments in this document were taken from the online resource found at:

http://jitc.fhu.disa.mil/nitf/tag_reg

The Cloud Cover Grid Data TRE (CSCCGA) provides support data that identifies which image segment and sensors were used to create the cloud grid. CSCCGA also geometrically registers the cloud grid to the pixel grid of one of the image segments.

  1. The format and content of the CSCCGA TRE shall be as detailed in Table 3.1-1.
  2. When cloud cover information is included in the dataset (see Section 2.1.4.2 for an exception) both the CSCCGA TRE and the Cloud Cover Shapefile DES (Section 2.6.2) shall be included in each dataset even though they both express similar information.

Definition at line 27 of file ossimNitfCsccgaTag.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Constructor & Destructor Documentation

◆ ossimNitfCsccgaTag()

ossimNitfCsccgaTag::ossimNitfCsccgaTag ( )

Definition at line 15 of file ossimNitfCsccgaTag.cpp.

References clearFields().

16  : ossimNitfRegisteredTag(std::string("CSCCGA"), CEL_SIZE)
17 {
18  clearFields();
19 }
ossimNitfRegisteredTag()
default constructor
virtual void clearFields()

Member Function Documentation

◆ clearFields()

void ossimNitfCsccgaTag::clearFields ( )
virtual

Definition at line 67 of file ossimNitfCsccgaTag.cpp.

References AS_CELL_SIZE_SIZE, CCG_MAX_LINE_SIZE, CCG_MAX_SAMPLE_SIZE, CCG_SOURCE_SIZE, CS_CELL_SIZE_SIZE, m_asCellSize, m_ccgMaxLine, m_ccgMaxSample, m_ccgSource, m_csCellSize, m_originLine, m_originSample, m_regSensor, ORIGIN_LINE_SIZE, ORIGIN_SAMPLE_SIZE, and REG_SENSOR_SIZE.

Referenced by ossimNitfCsccgaTag().

68 {
69  memset(m_ccgSource,' ', CCG_SOURCE_SIZE);
70  memset(m_regSensor, ' ', REG_SENSOR_SIZE);
71  memset(m_originLine, 0, ORIGIN_LINE_SIZE);
73  memset(m_asCellSize, 0, AS_CELL_SIZE_SIZE);
74  memset(m_csCellSize, 0, CS_CELL_SIZE_SIZE);
75  memset(m_ccgMaxLine, 0, CCG_MAX_LINE_SIZE);
77 
86 }
char m_originLine[ORIGIN_LINE_SIZE+1]
Field: ORIGIN_LINE.
char m_ccgMaxSample[CCG_MAX_SAMPLE_SIZE+1]
Field: CCG_MAX_SAMPLE.
char m_regSensor[REG_SENSOR_SIZE+1]
Field: REG_SENSOR
char m_asCellSize[AS_CELL_SIZE_SIZE+1]
Field: AS_CELL_SIZE.
char m_originSample[ORIGIN_SAMPLE_SIZE+1]
Field: ORIGIN_SAMPLE.
char m_csCellSize[CS_CELL_SIZE_SIZE+1]
Field: CS_CELL_SIZE.
char m_ccgMaxLine[CCG_MAX_LINE_SIZE+1]
Field: CCG_MAX_LINE.
char m_ccgSource[CCG_SOURCE_SIZE+1]
Field: CCG_SOURCE.

◆ parseStream()

void ossimNitfCsccgaTag::parseStream ( ossim::istream in)
virtual

This will allow the user defined data to parse the stream.

Implements ossimNitfRegisteredTag.

Definition at line 21 of file ossimNitfCsccgaTag.cpp.

References AS_CELL_SIZE_SIZE, CCG_MAX_LINE_SIZE, CCG_MAX_SAMPLE_SIZE, CCG_SOURCE_SIZE, CS_CELL_SIZE_SIZE, m_asCellSize, m_ccgMaxLine, m_ccgMaxSample, m_ccgSource, m_csCellSize, m_originLine, m_originSample, m_regSensor, ORIGIN_LINE_SIZE, ORIGIN_SAMPLE_SIZE, and REG_SENSOR_SIZE.

22 {
23  in.read(m_ccgSource, CCG_SOURCE_SIZE);
24  in.read(m_regSensor, REG_SENSOR_SIZE);
31 }
char m_originLine[ORIGIN_LINE_SIZE+1]
Field: ORIGIN_LINE.
char m_ccgMaxSample[CCG_MAX_SAMPLE_SIZE+1]
Field: CCG_MAX_SAMPLE.
char m_regSensor[REG_SENSOR_SIZE+1]
Field: REG_SENSOR
char m_asCellSize[AS_CELL_SIZE_SIZE+1]
Field: AS_CELL_SIZE.
char m_originSample[ORIGIN_SAMPLE_SIZE+1]
Field: ORIGIN_SAMPLE.
char m_csCellSize[CS_CELL_SIZE_SIZE+1]
Field: CS_CELL_SIZE.
char m_ccgMaxLine[CCG_MAX_LINE_SIZE+1]
Field: CCG_MAX_LINE.
char m_ccgSource[CCG_SOURCE_SIZE+1]
Field: CCG_SOURCE.

◆ print()

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

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

Reimplemented from ossimNitfRegisteredTag.

Definition at line 45 of file ossimNitfCsccgaTag.cpp.

References ossimNitfRegisteredTag::getTagLength(), ossimNitfRegisteredTag::getTagName(), m_asCellSize, m_ccgMaxLine, m_ccgMaxSample, m_ccgSource, m_csCellSize, m_originLine, m_originSample, and m_regSensor.

47 {
48  std::string pfx = prefix;
49  pfx += getTagName();
50  pfx += ".";
51  out << setiosflags(ios::left)
52  << pfx << std::setw(24) << "CETAG:" << getTagName() << "\n"
53  << pfx << std::setw(24) << "CEL:" << getTagLength() << "\n"
54  << pfx << std::setw(24) << "CCG_SOURCE:" << m_ccgSource << "\n"
55  << pfx << std::setw(24) << "CCG_SOURCE:" << m_regSensor << "\n"
56  << pfx << std::setw(24) << "ORIGIN_LINE:" << m_originLine << "\n"
57  << pfx << std::setw(24) << "ORIGIN_SAMPLE:" << m_originSample << "\n"
58  << pfx << std::setw(24) << "AS_CELL_SIZE:" << m_asCellSize << "\n"
59  << pfx << std::setw(24) << "CS_CELL_SIZE:" << m_csCellSize << "\n"
60  << pfx << std::setw(24) << "CCG_MAX_LINE:" << m_ccgMaxLine << "\n"
61  << pfx << std::setw(24) << "CCG_MAX_SAMPLE:" << m_ccgMaxSample << "\n";
62 
63 
64  return out;
65 }
virtual const std::string & getTagName() const
This will return the name of the registered tag for this user defined header.
char m_originLine[ORIGIN_LINE_SIZE+1]
Field: ORIGIN_LINE.
char m_ccgMaxSample[CCG_MAX_SAMPLE_SIZE+1]
Field: CCG_MAX_SAMPLE.
char m_regSensor[REG_SENSOR_SIZE+1]
Field: REG_SENSOR
virtual ossim_uint32 getTagLength() const
Returns the length in bytes of the tag from the CEL or REL field.
char m_asCellSize[AS_CELL_SIZE_SIZE+1]
Field: AS_CELL_SIZE.
char m_originSample[ORIGIN_SAMPLE_SIZE+1]
Field: ORIGIN_SAMPLE.
char m_csCellSize[CS_CELL_SIZE_SIZE+1]
Field: CS_CELL_SIZE.
char m_ccgMaxLine[CCG_MAX_LINE_SIZE+1]
Field: CCG_MAX_LINE.
char m_ccgSource[CCG_SOURCE_SIZE+1]
Field: CCG_SOURCE.

◆ writeStream()

void ossimNitfCsccgaTag::writeStream ( ossim::ostream out)
virtual

Implements ossimNitfRegisteredTag.

Definition at line 33 of file ossimNitfCsccgaTag.cpp.

References AS_CELL_SIZE_SIZE, CCG_MAX_LINE_SIZE, CCG_MAX_SAMPLE_SIZE, CCG_SOURCE_SIZE, CS_CELL_SIZE_SIZE, m_asCellSize, m_ccgMaxLine, m_ccgMaxSample, m_ccgSource, m_csCellSize, m_originLine, m_originSample, m_regSensor, ORIGIN_LINE_SIZE, ORIGIN_SAMPLE_SIZE, and REG_SENSOR_SIZE.

34 {
35  out.write(m_ccgSource, CCG_SOURCE_SIZE);
36  out.write(m_regSensor, REG_SENSOR_SIZE);
37  out.write(m_originLine, ORIGIN_LINE_SIZE);
39  out.write(m_asCellSize, AS_CELL_SIZE_SIZE);
40  out.write(m_csCellSize, CS_CELL_SIZE_SIZE);
41  out.write(m_ccgMaxLine, CCG_MAX_LINE_SIZE);
43 }
char m_originLine[ORIGIN_LINE_SIZE+1]
Field: ORIGIN_LINE.
char m_ccgMaxSample[CCG_MAX_SAMPLE_SIZE+1]
Field: CCG_MAX_SAMPLE.
char m_regSensor[REG_SENSOR_SIZE+1]
Field: REG_SENSOR
char m_asCellSize[AS_CELL_SIZE_SIZE+1]
Field: AS_CELL_SIZE.
char m_originSample[ORIGIN_SAMPLE_SIZE+1]
Field: ORIGIN_SAMPLE.
char m_csCellSize[CS_CELL_SIZE_SIZE+1]
Field: CS_CELL_SIZE.
char m_ccgMaxLine[CCG_MAX_LINE_SIZE+1]
Field: CCG_MAX_LINE.
char m_ccgSource[CCG_SOURCE_SIZE+1]
Field: CCG_SOURCE.

Member Data Documentation

◆ m_asCellSize

char ossimNitfCsccgaTag::m_asCellSize[AS_CELL_SIZE_SIZE+1]
protected

Field: AS_CELL_SIZE.

BCS-N 7 bytes

Value Range: 0000001 - 9999999

Along Scan Cell Size – Lines (Cloud Cover Grid spacing in registered image segment lines)

Definition at line 111 of file ossimNitfCsccgaTag.h.

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

◆ m_ccgMaxLine

char ossimNitfCsccgaTag::m_ccgMaxLine[CCG_MAX_LINE_SIZE+1]
protected

Field: CCG_MAX_LINE.

BCS-N 7 bytes

Value Range: 0000001 - 9999999

Number of Rows in CC Grid (Number of Cells in "lines" direction)

Definition at line 134 of file ossimNitfCsccgaTag.h.

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

◆ m_ccgMaxSample

char ossimNitfCsccgaTag::m_ccgMaxSample[CCG_MAX_SAMPLE_SIZE+1]
protected

Field: CCG_MAX_SAMPLE.

BCS-N 5 bytes

Value Range: 00001 - 99999

Number of Columns in CC Grid (Number of Cells in "sample" direction)

Definition at line 145 of file ossimNitfCsccgaTag.h.

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

◆ m_ccgSource

char ossimNitfCsccgaTag::m_ccgSource[CCG_SOURCE_SIZE+1]
protected

Field: CCG_SOURCE.

BCS-A 18 byte field.

Values: PAN or MS or PAN, MS

Source of Grid Concatenation of all sensors used to create cloud cover grid separated by commas

Definition at line 63 of file ossimNitfCsccgaTag.h.

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

◆ m_csCellSize

char ossimNitfCsccgaTag::m_csCellSize[CS_CELL_SIZE_SIZE+1]
protected

Field: CS_CELL_SIZE.

BCS-N 5 bytes

Value Range: 00001 - 99999

Cross Scan Cell Size – Samples (Cloud Cover Grid spacing in registered image segment samples)

Definition at line 123 of file ossimNitfCsccgaTag.h.

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

◆ m_originLine

char ossimNitfCsccgaTag::m_originLine[ORIGIN_LINE_SIZE+1]
protected

Field: ORIGIN_LINE.

BCS-N 7 bytes.

Values: 0000001

Cloud Cover Grid Origin – Line (Corresponding line in registered image segment)

Definition at line 87 of file ossimNitfCsccgaTag.h.

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

◆ m_originSample

char ossimNitfCsccgaTag::m_originSample[ORIGIN_SAMPLE_SIZE+1]
protected

Field: ORIGIN_SAMPLE.

BCS-N 5 bytes

Values: 00001

Cloud Cover Grid Origin – Sample (Corresponding sample in registered image segment)

Definition at line 99 of file ossimNitfCsccgaTag.h.

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

◆ m_regSensor

char ossimNitfCsccgaTag::m_regSensor[REG_SENSOR_SIZE+1]
protected


Field: REG_SENSOR

BCS-A 6 bytes.

Values: PAN or MS

Image Segment Sensor to which Cloud Cover Grid is registered (CCG is always registered to the synthetic array)

Definition at line 75 of file ossimNitfCsccgaTag.h.

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


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