ossim::Image Class Reference

Class representing an Image as used by ossim-msp services. More...

#include <Image.h>

Inheritance diagram for ossim::Image:

Public Member Functions
	Image (const std::string &imageId, const std::string &filename, const std::string &modelName="", unsigned int entryIndex=0, unsigned int band=1)
	Image (const Json::Value &image_json_node)
	~Image ()
std::string	getImageId () const
std::string	getFilename () const
std::string	getModelName () const
unsigned int	getEntryIndex () const
unsigned int	getActiveBand () const
void	setImageId (const std::string &id)
void	setFilename (const std::string &f)
void	setEntryIndex (unsigned int i)
virtual void	getAvailableModels (std::vector< pair< std::string, std::string > > &availableModels) const
	Returns all available sensor model plugins and model names for this image: More...
virtual void	loadJSON (const Json::Value &json)
	Refer to 3DISA API document for JSON format used. More...
virtual void	saveJSON (Json::Value &json) const
	Refer to 3DISA API document for JSON format used. More...
Public Member Functions inherited from ossim::JsonInterface
	JsonInterface ()
virtual	~JsonInterface ()

Static Public Attributes
static unsigned int	UNASSIGNED_PHOTOBLOCK_INDEX

Protected Attributes
std::string	m_imageId
ossimFilename	m_filename
unsigned int	m_entryIndex
unsigned int	m_activeBand
std::string	m_modelName
std::vector< pair< std::string, std::string > >	m_availableModel
ossimRefPtr< ossimSensorModel >	m_sensorModel

Detailed Description

Class representing an Image as used by ossim-msp services.

Definition at line 27 of file Image.h.

Constructor & Destructor Documentation

Image() [1/2]

ossim::Image::Image	(	const std::string &	imageId,
		const std::string &	filename,
		const std::string &	modelName = "",
		unsigned int	entryIndex = 0,
		unsigned int	band = 1
	)

Definition at line 18 of file Image.cpp.

:  m_imageId (imageId),
   m_filename (filename),
   m_entryIndex (entryIndex),
   m_activeBand (band),
   m_modelName (modelName)
{

}

Image() [2/2]

ossim::Image::Image

(

const Json::Value &

image_json_node

)

Definition at line 32 of file Image.cpp.

References loadJSON().

:  m_entryIndex (0),
   m_activeBand (1)
{
   loadJSON(json_node);
}

~Image()

ossim::Image::~Image

(

)

Definition at line 39 of file Image.cpp.

{
   //m_handler.reset();
}

Member Function Documentation

getActiveBand()

unsigned int ossim::Image::getActiveBand ( ) const

inline

Definition at line 47 of file Image.h.

{ return m_activeBand; }

getAvailableModels()

void ossim::Image::getAvailableModels ( std::vector< pair< std::string, std::string > > &  availableModels ) const

virtual

Returns all available sensor model plugins and model names for this image:

Parameters

availableModels

List of <plugin-name, model-name> pairs.

Definition at line 44 of file Image.cpp.

References ossimObject::getLongName(), ossimProjectionFactoryRegistry::instance(), m_entryIndex, m_filename, and ossimString::string().

{
   ossimProjection* proj = ossimProjectionFactoryRegistry::instance()->
         createProjection(m_filename, m_entryIndex);
   if (proj)
   {
      availableModels.push_back(pair<string, string>("OSSIM", proj->getLongName().string()));
      delete proj;
   }
}

getEntryIndex()

unsigned int ossim::Image::getEntryIndex ( ) const

inline

Definition at line 46 of file Image.h.

{ return m_entryIndex; }

getFilename()

std::string ossim::Image::getFilename ( ) const

inline

Definition at line 44 of file Image.h.

{ return m_filename; }

getImageId()

std::string ossim::Image::getImageId ( ) const

inline

Definition at line 43 of file Image.h.

{ return m_imageId; }

getModelName()

std::string ossim::Image::getModelName ( ) const

inline

Definition at line 45 of file Image.h.

{ return m_modelName; }

loadJSON()

void ossim::Image::loadJSON ( const Json::Value &  json )

virtual

Refer to 3DISA API document for JSON format used.

Implements ossim::JsonInterface.

Definition at line 55 of file Image.cpp.

References ossimProjectionFactoryRegistry::createProjection(), ossimFilename::expand(), ossimProjectionFactoryRegistry::instance(), m_activeBand, m_entryIndex, m_filename, m_imageId, m_modelName, m_sensorModel, and ossimKeywordlist::parseString().

Referenced by Image().

{
   ostringstream xmsg;
   xmsg<<__FILE__<<": loadJSON(JSON) -- ";

   // Parse JSON. Filename is required:
   if (json_node.isMember("filename"))
   {
      ossimFilename imageFile = json_node["filename"].asString();
      m_filename = imageFile.expand(); // allow embedded environment variables
   }
   else
   {
      xmsg<<"JSON node missing required field: \"filename\".";
      throw ossimException(xmsg.str());
   }

   // Entry index defaults to 0 if not present:
   if (json_node["entryIndex"].isUInt())
      m_entryIndex = json_node["entryIndex"].asUInt();

   // Band defaults to 1 if not present:
   if (json_node["band"].isUInt())
      m_activeBand = json_node["band"].asUInt();

   // Sensor model defaults to most accurate available if not provided (indicated by blank name):
   if (json_node.isMember("sensorModel"))
      m_modelName = json_node["sensorModel"].asString();

   // Sensor model defaults to most accurate available if not provided (indicated by blank name):
   if (json_node.isMember("imageId"))
      m_imageId = json_node["imageId"].asString();

   // Establish the sensor model. This also sets the official image ID, which will be overwritten
   // if JSON field provided
   string modelState = json_node["modelState"].asString();
   ossimKeywordlist kwl;
   kwl.parseString(modelState);
   ossimProjection* proj =  ossimProjectionFactoryRegistry::instance()->createProjection(kwl);
   m_sensorModel = dynamic_cast<ossimSensorModel*>(proj);
}

saveJSON()

void ossim::Image::saveJSON ( Json::Value &  json ) const

virtual

Refer to 3DISA API document for JSON format used.

Implements ossim::JsonInterface.

Definition at line 97 of file Image.cpp.

References m_entryIndex, m_filename, m_imageId, m_modelName, m_sensorModel, ossimSensorModel::saveState(), ossimString::string(), ossimKeywordlist::toString(), and ossimRefPtr< T >::valid().

{
   json_node.clear();
   json_node["imageId"] = m_imageId;
   json_node["filename"] = m_filename.string();
   json_node["entryIndex"] = m_entryIndex;

   if (m_modelName.size())
      json_node["sensorModel"] = m_modelName;

   if (m_sensorModel.valid())
   {
      ossimKeywordlist kwl;
      m_sensorModel->saveState(kwl);
      json_node["modelState"] = kwl.toString().string();
   }
}

setEntryIndex()

void ossim::Image::setEntryIndex ( unsigned int  i )

inline

Definition at line 51 of file Image.h.

{ m_entryIndex = i; }

setFilename()

void ossim::Image::setFilename ( const std::string &  f )

inline

Definition at line 50 of file Image.h.

{ m_filename = f; }

setImageId()

void ossim::Image::setImageId ( const std::string &  id )

inline

Definition at line 49 of file Image.h.

{ m_imageId = id; }

Member Data Documentation

m_activeBand

unsigned int ossim::Image::m_activeBand

protected

Definition at line 75 of file Image.h.

Referenced by loadJSON().

m_availableModel

std::vector< pair<std::string, std::string> > ossim::Image::m_availableModel

protected

Definition at line 77 of file Image.h.

m_entryIndex

unsigned int ossim::Image::m_entryIndex

protected

Definition at line 74 of file Image.h.

Referenced by getAvailableModels(), loadJSON(), and saveJSON().

m_filename

ossimFilename ossim::Image::m_filename

protected

Definition at line 73 of file Image.h.

Referenced by getAvailableModels(), loadJSON(), and saveJSON().

m_imageId

std::string ossim::Image::m_imageId

protected

Definition at line 72 of file Image.h.

Referenced by loadJSON(), and saveJSON().

m_modelName

std::string ossim::Image::m_modelName

protected

Definition at line 76 of file Image.h.

Referenced by loadJSON(), and saveJSON().

m_sensorModel

ossimRefPtr<ossimSensorModel> ossim::Image::m_sensorModel

protected

Definition at line 78 of file Image.h.

Referenced by loadJSON(), and saveJSON().

UNASSIGNED_PHOTOBLOCK_INDEX

unsigned int ossim::Image::UNASSIGNED_PHOTOBLOCK_INDEX

static

Definition at line 31 of file Image.h.

---

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

• Image.h
• Image.cpp