Single image chain class. More...

#include <ossimSingleImageChain.h>

Inheritance diagram for ossimSingleImageChain:

Public Member Functions
	ossimSingleImageChain ()
	default constructor More...

	ossimSingleImageChain (bool addNullPixelFlipFlag, bool addHistogramFlag, bool addResamplerCacheFlag, bool addChainCacheFlag, bool remapToEightBitFlag, bool threeBandFlag, bool threeBandReverseFlag, bool brightnessContrastFlag=false, bool sharpenFlag=false, bool geoPolyCutterFlag=false)
	Constructor that takes flags. More...

virtual	~ossimSingleImageChain ()
	virtual destructor More...

void	reset ()
	reset method This deletes all links in the chain, zero's out all data members, and sets all flags back to default. More...

bool	open (const ossimFilename &file, bool openOverview=true)
	open method that takes an image file. More...

bool	open (const ossimSrcRecord &src)
	open method that takes an ossimSrcRecord. More...

bool	isOpen () const

void	close ()
	close method to delete the image handler. More...

ossimFilename	getFilename () const

void	createRenderedChain ()
	Create a rendered image chain. More...

void	createRenderedChain (const ossimSrcRecord &src)
	Create a rendered image chain that takes an ossimSrcRecord. More...

bool	addImageHandler (const ossimFilename &file, bool openOverview=true)
	Adds an image handler for file. More...

bool	addImageHandler (const ossimSrcRecord &src)
	Adds an image handler from src record. More...

void	addBandSelector ()
	Adds a band selector to the end of the chain. More...

void	addBandSelector (const ossimSrcRecord &src)
	Adds a band selector. More...

void	addHistogramRemapper ()
	Adds histogram remapper to the chain. More...

void	addHistogramRemapper (const ossimSrcRecord &src)
	Adds a band selector. More...

ossimRefPtr< ossimCacheTileSource >	addCache ()
	Adds a new cache to the current end of the chain. More...

void	addResampler ()
	Adds a resampler (a.k.a. More...

void	addRenderer ()
	Adds a resampler (a.k.a. More...

void	addScalarRemapper ()
	Adds scalar remapper either to the left of the resampler cache or at the end of the chain if not present. More...

void	addBrightnessContrast ()
	Adds brightness contrast filter the end of the chain if not present. More...

void	addSharpen ()
	Adds sharpen filter the end of the chain if not present. More...

void	addNullPixelFlip ()
	Adds the null pixel flip just after the band selection. More...

void	addNullPixelFlip (const ossimSrcRecord &src)

void	addGeoPolyCutter ()
	Adds a geo polycutter to allow for cropping imagery or nulling out regions. More...

void	addGeoPolyCutterPolygon (const vector< ossimGpt > &polygon)

void	addGeoPolyCutterPolygon (const ossimGeoPolygon &polygon)

ossimRefPtr< const ossimImageHandler >	getImageHandler () const

ossimRefPtr< ossimImageHandler >	getImageHandler ()

ossimRefPtr< const ossimBandSelector >	getBandSelector () const

ossimRefPtr< const ossimNullPixelFlip >	getNullPixelFlip () const

ossimRefPtr< ossimBandSelector >	getBandSelector ()

ossimRefPtr< const ossimHistogramRemapper >	getHistogramRemapper () const

ossimRefPtr< ossimHistogramRemapper >	getHistogramRemapper ()

ossimRefPtr< const ossimCacheTileSource >	getResamplerCache () const

ossimRefPtr< ossimCacheTileSource >	getResamplerCache ()

ossimRefPtr< const ossimImageRenderer >	getImageRenderer () const

ossimRefPtr< ossimImageRenderer >	getImageRenderer ()

ossimRefPtr< const ossimScalarRemapper >	getScalarRemapper () const

ossimRefPtr< ossimScalarRemapper >	getScalarRemapper ()

ossimRefPtr< const ossimBrightnessContrastSource >	getBrightnessContrast () const

ossimRefPtr< ossimBrightnessContrastSource >	getBrightnessContrast ()

ossimRefPtr< const ossimImageSharpenFilter >	getSharpenFilter () const

ossimRefPtr< ossimImageSharpenFilter >	getSharpenFilter ()

ossimRefPtr< const ossimCacheTileSource >	getChainCache () const

ossimRefPtr< ossimCacheTileSource >	getChainCache ()

void	setAddNullPixelFlipFlag (bool flag)
	If flag is true a null pixel flip will be added to the chain at create time. More...

bool	getNullPixelFlipFlag () const
	Gets the add histogram flag. More...

void	setAddHistogramFlag (bool flag)
	If flag is true a histogram will be added to the chain at create time. More...

bool	getAddHistogramFlag () const
	Gets the add histogram flag. More...

void	setAddResamplerCacheFlag (bool flag)
	If flag is true a resampler cache will be added to the chain at create time. More...

bool	getAddResamplerCacheFlag () const
	Gets the add resampler cache flag. More...

void	setAddChainCacheFlag (bool flag)
	If flag is true a chain cache will be added to the chain at create time. More...

bool	getAddChainCacheFlag () const
	Gets the add chain cache flag. More...

void	setRemapToEightBitFlag (bool flag)
	Sets remap to eigth bit flag. More...

bool	getRemapToEightBitFlag () const
	Get the remap to eight bit flag. More...

void	setThreeBandFlag (bool flag)
	Sets the three band flag. More...

bool	getThreeBandFlag () const
	Get the three band flag. More...

void	setThreeBandReverseFlag (bool flag)
	Sets the three band reverse flag. More...

bool	getThreeBandReverseFlag () const
	Get the three band reverse flag. More...

void	setBrightnessContrastFlag (bool flag)
	Sets the brightness contrast flag. More...

bool	getBrightnessContrastFlag () const
	Get the brightness constrast flag. More...

void	setSharpenFlag (bool flag)
	Sets the sharpenflag. More...

bool	getSharpenFlag () const
	Get the sharpen flag. More...

void	setToThreeBands ()
	Utility method to force 3 band output. More...

void	setToThreeBandsReverse ()
	Utility method to set to 3 bandsand reverse them. More...

void	setBandSelection (const std::vector< ossim_uint32 > &bandList)
	method to set band selector. More...

void	setDefaultBandSelection ()

ossimScalarType	getImageHandlerScalarType () const
	Convenience method to return the scalar type of the image handler. More...

bool	openHistogram (ossimHistogramRemapper::StretchMode mode)
	Convenience method to open the histogram and apply a default stretch. More...

Public Member Functions inherited from ossimImageChain
	ossimImageChain ()

virtual	~ossimImageChain ()

ossimConnectableObject::ConnectableObjectList &	getChainList ()

const ossimConnectableObject::ConnectableObjectList &	getChainList () const

ossimConnectableObject *	operator[] (ossim_uint32 index)

virtual ossimConnectableObject *	getConnectableObject (ossim_uint32 index)
	Same as operator[](ossim_uint32 i) More...

virtual ossim_int32	indexOf (ossimConnectableObject *obj) const

virtual ossimImageSource *	getFirstSource ()
	Return the first source which is the one that first receives the getTile request. More...

virtual const ossimImageSource *	getFirstSource () const

virtual ossimObject *	getFirstObject ()

virtual ossimImageSource *	getLastSource ()
	Return the last source which is the one that last receives the getTile request. More...

virtual const ossimImageSource *	getLastSource () const

virtual ossimObject *	getLastObject ()

bool	addFirst (ossimConnectableObject *obj)
	Adds it to the start of the chain. More...

bool	addLast (ossimConnectableObject *obj)
	Adds it to the end. More...

bool	deleteFirst ()
	Deletes the first object. More...

bool	deleteLast ()
	Deletes the last object. More...

bool	insertRight (ossimConnectableObject newObj, ossimConnectableObject rightOfThisObj)

bool	insertRight (ossimConnectableObject *newObj, const ossimId &id)

bool	insertLeft (ossimConnectableObject *newObj, const ossimId &id)

bool	insertLeft (ossimConnectableObject newObj, ossimConnectableObject leftOfThisObj)

bool	replace (ossimConnectableObject newObj, ossimConnectableObject oldObj)

virtual bool	add (ossimConnectableObject *source)
	Will return true or false if an image source was added to the chain. More...

virtual ossimRefPtr< ossimImageData >	getTile (const ossimIrect &tileRect, ossim_uint32 resLevel=0)
	Within the image chain will pass the head of the list. More...

virtual ossim_uint32	getNumberOfInputBands () const
	this call is passed to the head of the list. More...

virtual ossimScalarType	getOutputScalarType () const
	This call is passed to the head of the list. More...

virtual double	getNullPixelValue (ossim_uint32 band=0) const
	Each band has a null pixel associated with it. More...

virtual double	getMinPixelValue (ossim_uint32 band=0) const
	Returns the min pixel of the band. More...

virtual double	getMaxPixelValue (ossim_uint32 band=0) const
	Returns the max pixel of the band. More...

virtual void	getOutputBandList (std::vector< ossim_uint32 > &bandList) const
	Initializes bandList. More...

virtual ossim_uint32	getTileWidth () const
	This call is passed to the head of the list. More...

virtual ossim_uint32	getTileHeight () const
	This call is passed to the head of the list. More...

virtual ossimIrect	getBoundingRect (ossim_uint32 resLevel=0) const
	Will pass this call to the head of the list. More...

virtual void	getValidImageVertices (vector< ossimIpt > &validVertices, ossimVertexOrdering ordering=OSSIM_CLOCKWISE_ORDER, ossim_uint32 resLevel=0) const

virtual ossimRefPtr< ossimImageGeometry >	getImageGeometry ()
	Returns the image geometry object associated with this tile source or NULL if not defined. More...

virtual void	getDecimationFactor (ossim_uint32 resLevel, ossimDpt &result) const
	Will return the decimation factor for the given resolution level. More...

virtual void	getDecimationFactors (vector< ossimDpt > &decimations) const

virtual ossim_uint32	getNumberOfDecimationLevels () const
	Will return the number of resolution levels. More...

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=NULL) const
	Will save the state of the chain. More...

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=NULL)
	Will load the state. More...

virtual void	initialize ()

virtual void	enableSource ()

virtual void	disableSource ()

bool	canConnectMyInputTo (ossim_int32 myInputIndex, const ossimConnectableObject *object) const
	required to be overriden by derived classes More...

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject::ConnectableObjectList findAllObjectsOfType(const RTTItypeid &typeInfo, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject::ConnectableObjectList findAllObjectsOfType(const ossimString &className, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findFirstObjectOfType(const RTTItypeid &typeInfo, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findFirstObjectOfType(const ossimString &className, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObject(const ossimId &id, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject findObject(const ossimConnectableObject obj, bool recurse=true))

virtual void	makeUniqueIds ()
	Will cycle through all sources setting their ids. More...

virtual ossim_uint32	getNumberOfObjects (bool recurse=true) const
	Returns the number of objects within this container and all child containers. More...

virtual ossim_uint32	getNumberOfSources () const
	Deprecated! Please use getNumberOfObjects(false). More...

virtual bool	addChild (ossimConnectableObject *attachableObject)
	Will add an object to the container and then set the added objects owner to this. More...

virtual bool	removeChild (ossimConnectableObject *object)
	Will remove the child from the container. More...

virtual ossimConnectableObject *	removeChild (const ossimId &id)

virtual void	getChildren (vector< ossimConnectableObject *> &children, bool immediateChildrenOnlyFlag)

virtual void	disconnectInputEvent (ossimConnectionEvent &event)

virtual void	disconnectOutputEvent (ossimConnectionEvent &event)

virtual void	connectInputEvent (ossimConnectionEvent &event)

virtual void	connectOutputEvent (ossimConnectionEvent &event)

virtual void	objectDestructingEvent (ossimObjectDestructingEvent &event)

virtual void	propagateEventToOutputs (ossimEvent &event)

virtual void	propagateEventToInputs (ossimEvent &event)

virtual void	processEvent (ossimEvent &event)
	ProcessEvent. More...

virtual void	accept (ossimVisitor &visitor)
	We will add a visitor interface for all connectable objects. More...

void	deleteList ()

virtual ossimConnectableObject::ConnectableObjectList &	imageChainList ()
	These access methods greatly facilitate the implementation of an image chain adaptor class. More...

virtual const ossimConnectableObject::ConnectableObjectList &	imageChainList () const

Public Member Functions inherited from ossimImageSource
	ossimImageSource (ossimObject *owner=0)

	ossimImageSource (ossimObject *owner, ossim_uint32 inputListSize, ossim_uint32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)

virtual	~ossimImageSource ()

virtual ossimRefPtr< ossimImageData >	getTile (const ossimIpt &origin, ossim_uint32 resLevel=0)

virtual bool	getTile (ossimImageData *result, ossim_uint32 resLevel=0)
	Method to get a tile. More...

virtual ossimObject *	getObject ()
	For RTTI support. More...

virtual const ossimObject *	getObject () const
	For RTTI support. More...

virtual void	getDecimationFactors (std::vector< ossimDpt > &decimations) const
	Will return an array of all decimations for each resolution level. More...

virtual ossim_uint32	getNumberOfOutputBands () const
	Returns the number of bands in a tile returned from this TileSource. More...

virtual void	getBoundingRect (ossimIrect &rect, ossim_uint32 resLevel=0) const
	Gets the bounding rectangle of the source. More...

virtual void	getValidImageVertices (std::vector< ossimIpt > &validVertices, ossimVertexOrdering ordering=OSSIM_CLOCKWISE_ORDER, ossim_uint32 resLevel=0) const
	ordering specifies how the vertices should be arranged. More...

virtual void	setImageGeometry (const ossimImageGeometry *geom)
	Default implementation sets geometry of the first input to the geometry specified. More...

virtual void	saveImageGeometry () const
	Default method to call input's saveImageGeometry. More...

virtual void	saveImageGeometry (const ossimFilename &geometry_file) const
	Default method to call input's saveImageGeometry. More...

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

virtual void	setProperty (ossimRefPtr< ossimProperty > property)

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

virtual bool	isIndexedData () const

Public Member Functions inherited from ossimSource
	ossimSource (ossimObject *owner=0)

	ossimSource (ossimObject *owner, ossim_uint32 inputListSize, ossim_uint32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)

virtual	~ossimSource ()

virtual bool	isSourceEnabled () const

virtual bool	getEnableFlag () const

virtual void	setEnableFlag (bool flag)

virtual bool	isInitialized () const

virtual void	setInitializedFlag (bool flag)

virtual std::ostream &	print (std::ostream &out) const
	Outputs theErrorStatus as an ossimErrorCode and an ossimString. More...

Public Member Functions inherited from ossimConnectableObject
	ossimConnectableObject (ossimObject *owner=0)
	Base constructor of this object. More...

	ossimConnectableObject (ossimObject *owner, ossim_int32 inputListSize, ossim_int32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)

virtual	~ossimConnectableObject ()

void	setId (const ossimId &id)
	All connectable objects will have id's. More...

const ossimId &	getId () const
	Will allow us to get this object's id. More...

const ossimObject *	getOwner () const
	Fetches the current owner, most likely a container but not limited to one. More...

virtual void	changeOwner (ossimObject *owner)
	Permits changing the object's owner. More...

virtual void	setDescription (const ossimString &description)

virtual ossimString	getDescription () const

virtual bool	isConnected (ossimConnectableObjectDirectionType direction=CONNECTABLE_DIRECTION_INPUT) const
	will check the direction specified to see if all slots are full. More...

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findConnectableObject(const ossimId &id))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(RTTItypeid typeId, ossimConnectableObjectDirectionType directionType, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(const ossimString &obj, ossimConnectableObjectDirectionType directionType, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findInputObjectOfType(const ossimString &className))

virtual ossim_int32	findInputIndex (const ossimConnectableObject *object)
	Return a valid index of the input list if the passed in object is found else return -1. More...

virtual ossim_int32	findInputIndex (const ossimId &id)
	Return a valid index of the input list if the passed id is found else return -1. More...

virtual ossim_int32	findOutputIndex (const ossimConnectableObject *object)
	Return a valid index of the output list if the passed in object is found else return -1. More...

virtual ossim_int32	findOutputIndex (const ossimId &id)
	Return a valid index of the output list if the passed in object is found else return -1. More...

virtual ossim_int32	getMyInputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...

virtual ossim_int32	getMyOutputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...

virtual bool	canConnectMyOutputTo (ossim_int32 myOutputIndex, const ossimConnectableObject *object) const
	default implementation is to allow anyone to connect to us. More...

virtual void	disconnect (ossimConnectableObject *object=0)
	Will disconnect the object passed in. More...

virtual void	disconnect (const ossimId &id)
	Will disconnect the object passed in. More...

virtual ossimRefPtr< ossimConnectableObject >	disconnectMyInput (ossim_int32 inputIndex, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given input index and generate a connection event. More...

virtual void	disconnectMyInput (ossimConnectableObject *input, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Finds the index of the passed in input and calls disconnectMyInput(inputIndex, disconnectOutputFlag, createEventFlag);. More...

virtual void	disconnectMyInputs (ConnectableObjectList &inputList, bool disconnectOutputFlag=true, bool createEventFlag=true)

virtual ossimRefPtr< ossimConnectableObject >	disconnectMyOutput (ossim_int32 outputIndex, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given output index and generate a connection event. More...

virtual void	disconnectMyOutput (ossimConnectableObject *output, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the output object. More...

virtual void	disconnectMyOutputs (ConnectableObjectList &outputList, bool disconnectOutputFlag=true, bool createEventFlag=true)

virtual void	disconnectAllInputs ()
	Will disconnect all of the input objects. More...

virtual void	disconnectAllOutputs ()
	Will disconnect all of the output objects. More...

virtual ossim_int32	connectMyInputTo (ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will try to connect this objects input to the passed in object. More...

virtual ossim_int32	connectMyInputTo (ossim_int32 inputIndex, ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will connect the specified input to the passed in object. More...

virtual bool	connectMyInputTo (ConnectableObjectList &inputList, bool makeOutputConnection=true, bool createEventFlag=true)

virtual ossim_int32	connectMyOutputTo (ossimConnectableObject *outputObject, bool makeInputConnection=true, bool createEventFlag=true)
	Will try to connect this objects output to the passed in object. More...

virtual bool	connectMyOutputTo (ConnectableObjectList &outputList, bool makeInputConnection=true, bool createEventFlag=true)

virtual bool	connectInputList (ConnectableObjectList &inputList)
	Will disconnect itself from all inputs and reset to the passed in input list. More...

virtual bool	connectOutputList (ConnectableObjectList &outputList)
	Will disconnect itself from all outputs and reset to the passed in output list. More...

virtual ossim_uint32	getNumberOfInputs () const
	Returns the number of input objects. More...

virtual ossim_uint32	getNumberOfOutputs () const
	Return the number of output objects. More...

ossimConnectableObject *	getInput (ossim_uint32 index=0)
	returns the object at the specified index. More...

const ossimConnectableObject *	getInput (ossim_uint32 index=0) const
	returns the object at the specified index. More...

ossimConnectableObject *	getOutput (ossim_uint32 index=0)
	returns the object at the specified index. More...

const ossimConnectableObject *	getOutput (ossim_uint32 index=0) const
	returns the object at the specified index. More...

virtual void	setNumberOfInputs (ossim_int32 numberOfInputs)
	Will set the number of inputs. More...

virtual bool	getInputListIsFixedFlag () const

virtual bool	getOutputListIsFixedFlag () const

virtual void	setNumberOfOutputs (ossim_int32 numberOfInputs)
	Will set the number of outputs. More...

const ConnectableObjectList &	getInputList () const

const ConnectableObjectList &	getOutputList () const

ConnectableObjectList &	getInputList ()

ConnectableObjectList &	getOutputList ()

	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const RTTItypeid &typeInfo, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const ossimString &className, bool recurse=true))

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

virtual ossim_uint32	saveStateOfAllInputs (ossimKeywordlist &kwl, bool saveThisStateFlag=true, ossim_uint32 objectIndex=1, const char *prefix=0) const
	Save the state of all inputs to a keyword list. More...

virtual bool	fillContainer (ossimConnectableContainer &container)
	Inserts this object and all of its children and inputs into the container provided. More...

bool	moveInputUp (const ossimId &id)
	Moves the input connection matching id up one in the connection list. More...

bool	moveInputDown (const ossimId &id)
	Moves the input connection matching id down one in the connection list. More...

bool	moveInputToTop (const ossimId &id)
	Moves the input connection matching id to the top of the connection list. More...

bool	moveInputToBottom (const ossimId &id)
	Moves the input connection matching id to the bottom of the connection list. More...

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimObject *	dup () const

virtual ossimString	getShortName () const

virtual ossimString	getLongName () 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

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 ossimListenerManager
	ossimListenerManager ()

virtual	~ossimListenerManager ()

virtual void	fireEvent (ossimEvent &event)

virtual bool	addListener (ossimListener *listener)

virtual bool	removeListener (ossimListener *listener)

virtual bool	findListener (ossimListener *listener)

Public Member Functions inherited from ossimPropertyInterface
	ossimPropertyInterface ()

virtual	~ossimPropertyInterface ()

virtual ossimString	getPropertyValueAsString (const ossimString &name) const

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

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

Public Member Functions inherited from ossimErrorStatusInterface
	ossimErrorStatusInterface ()

virtual	~ossimErrorStatusInterface ()

virtual ossimErrorCode	getErrorStatus () const

virtual ossimString	getErrorStatusString () const

virtual void	setErrorStatus (ossimErrorCode error_status) const

virtual void	setErrorStatus () const

virtual void	clearErrorStatus () const

bool	hasError () const

Public Member Functions inherited from ossimConnectableObjectListener
	ossimConnectableObjectListener ()

virtual	~ossimConnectableObjectListener ()

virtual void	connectionEvent (ossimConnectionEvent &)

virtual void	propertyEvent (ossimPropertyEvent &)

virtual void	addObjectEvent (ossimContainerEvent &)

virtual void	removeObjectEvent (ossimContainerEvent &)

virtual void	containerEvent (ossimContainerEvent &)

virtual void	refreshEvent (ossimRefreshEvent &)

Public Member Functions inherited from ossimListener
	ossimListener ()

virtual	~ossimListener ()

void	enableListener ()

void	disableListener ()

void	setListenerEnableFlag (bool flag)

bool	isListenerEnabled () const

bool	getListenerEnableFlag () const

Public Member Functions inherited from ossimConnectableContainerInterface
	ossimConnectableContainerInterface (ossimObject *obj)

virtual	~ossimConnectableContainerInterface ()

virtual ossimConnectableObject::ConnectableObjectList	findAllObjectsOfType (const RTTItypeid &typeInfo, bool recurse=true)=0

virtual ossimConnectableObject::ConnectableObjectList	findAllObjectsOfType (const ossimString &className, bool recurse=true)=0

virtual ossimConnectableObject *	findFirstObjectOfType (const RTTItypeid &typeInfo, bool recurse=true)=0

virtual ossimConnectableObject *	findFirstObjectOfType (const ossimString &className, bool recurse=true)=0

virtual ossimConnectableObject *	findObject (const ossimId &id, bool recurse=true)=0

virtual ossimConnectableObject *	findObject (const ossimConnectableObject *obj, bool recurse=true)=0

ossimObject *	getObject ()

const ossimObject *	getObject () const

void	deleteAllChildren ()

virtual void	getChildren (std::vector< ossimConnectableObject *> &children, bool immediateChildrenOnlyFlag)=0

Private Attributes
ossimRefPtr< ossimImageHandler >	m_handler
	Pointers to links in chain. More...

ossimRefPtr< ossimBandSelector >	m_bandSelector

ossimRefPtr< ossimNullPixelFlip >	m_nullPixelFlip

ossimRefPtr< ossimHistogramRemapper >	m_histogramRemapper

ossimRefPtr< ossimBrightnessContrastSource >	m_brightnessContrast

ossimRefPtr< ossimImageSharpenFilter >	m_sharpen

ossimRefPtr< ossimScalarRemapper >	m_scalarRemapper

ossimRefPtr< ossimCacheTileSource >	m_resamplerCache

ossimRefPtr< ossimImageRenderer >	m_resampler

ossimRefPtr< ossimGeoPolyCutter >	m_geoPolyCutter

ossimRefPtr< ossimCacheTileSource >	m_chainCache

bool	m_addNullPixelFlipFlag
	control flags More...

bool	m_addHistogramFlag

bool	m_addResamplerCacheFlag

bool	m_addChainCacheFlag

bool	m_remapToEightBitFlag

bool	m_threeBandFlag

bool	m_threeBandReverseFlag

bool	m_brightnessContrastFlag

bool	m_sharpenFlag

bool	m_geoPolyCutterFlag

Additional Inherited Members
Public Types inherited from ossimConnectableObject
enum	ossimConnectableObjectDirectionType { CONNECTABLE_DIRECTION_NONE = 0, CONNECTABLE_DIRECTION_INPUT = 1, CONNECTABLE_DIRECTION_OUTPUT = 2 }

typedef std::vector< ossimRefPtr< ossimConnectableObject > >	ConnectableObjectList

Protected Member Functions inherited from ossimImageChain
void	prepareForRemoval (ossimConnectableObject *connectableObject)
	Inserts all of this object's children and inputs into the container provided. More...

bool	addAllSources (map< ossimId, vector< ossimId > > &idMapping, const ossimKeywordlist &kwl, const char *prefix=NULL)
	For dynamic loading to take place we must allocate all objects first and then assign id's later. More...

void	findInputConnectionIds (vector< ossimId > &result, const ossimKeywordlist &kwl, const char *prefix=NULL)

bool	connectAllSources (const map< ossimId, vector< ossimId > > &idMapping)

Protected Member Functions inherited from ossimImageSource
	ossimImageSource (const ossimImageSource &rhs)

const ossimImageSource &	operator= (const ossimImageSource &)

Protected Member Functions inherited from ossimSource
	ossimSource (const ossimSource &rhs)

const ossimSource &	operator= (const ossimSource &rhs)

Protected Member Functions inherited from ossimConnectableObject
ossimConnectableObject *	findObjectOfType (ConnectableObjectList *connectableList, ossimVisitor &visitor)

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Member Functions inherited from ossimListenerManager
	ossimListenerManager (const ossimListenerManager &rhs)

Protected Attributes inherited from ossimImageChain
ossimConnectableObject::ConnectableObjectList	theImageChainList
	This will hold a sequence of image sources. More...

ossimRefPtr< ossimImageData >	theBlankTile

bool	theLoadStateFlag

Protected Attributes inherited from ossimSource
bool	theEnableFlag

bool	theInitializedFlag

Protected Attributes inherited from ossimConnectableObject
ossimId	theId

ossimString	theDescription

ossimObject *	theOwner

bool	theInputListIsFixedFlag
	Indicates whether the theInputObjectList is fixed. More...

bool	theOutputListIsFixedFlag
	Indicates whether the theOutputObjectList is fixed. More...

ConnectableObjectList	theInputObjectList
	Holds a list of input objects. More...

ConnectableObjectList	theOutputObjectList
	Holds a list of output objects. More...

Protected Attributes inherited from ossimListenerManager
std::list< ossimListener * >	theListenerList

bool	theEnabledFlag

std::list< ossimListener * >	theDelayedAdd

std::list< ossimListener * >	theDelayedRemove

bool	theFireEventFlag

Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Protected Attributes inherited from ossimListener
bool	theListenerEnableFlag

Protected Attributes inherited from ossimConnectableContainerInterface
ossimObject *	theBaseObject

Detailed Description

Single image chain class.

Convenience class for a single image chain.

For code example see: ossim/src/test/ossim-single-image-chain-test.cpp
Just a clarification on "start of chain" versus "end of chain" in this file.

Given chain of: 1) image handler 2) band selector (optional) 3) histogram remapper(optional) 4) scalar remapper (optional) 5) resampler cache 6) resampler 7) band selector (optional when going one band to three) 8) chain cache

The "image handle" is the "start of chain". The "chain cache" is the "end of chain".

Definition at line 58 of file ossimSingleImageChain.h.

Constructor & Destructor Documentation

◆ ossimSingleImageChain() [1/2]

ossimSingleImageChain::ossimSingleImageChain ( )

default constructor

Definition at line 22 of file ossimSingleImageChain.cpp.

    :
    ossimImageChain(),
    m_handler(0),
    m_bandSelector(0),
    m_histogramRemapper(0),
    m_brightnessContrast(0),
    m_sharpen(0),
    m_scalarRemapper(0),
    m_resamplerCache(0),
    m_resampler(0),
    m_chainCache(0),
    m_addNullPixelFlipFlag(false),
    m_addHistogramFlag(false),
    m_addResamplerCacheFlag(false),
    m_addChainCacheFlag(false),
    m_remapToEightBitFlag(false),
    m_threeBandFlag(false),
    m_threeBandReverseFlag(false),
    m_brightnessContrastFlag(false),
    m_sharpenFlag(false),
    m_geoPolyCutterFlag(false)
 {
 }

◆ ossimSingleImageChain() [2/2]

ossimSingleImageChain::ossimSingleImageChain	(	bool	addNullPixelFlipFlag,
		bool	addHistogramFlag,
		bool	addResamplerCacheFlag,
		bool	addChainCacheFlag,
		bool	remapToEightBitFlag,
		bool	threeBandFlag,
		bool	threeBandReverseFlag,
		bool	brightnessContrastFlag = `false`,
		bool	sharpenFlag = `false`,
		bool	geoPolyCutterFlag = `false`
	)

Constructor that takes flags.

Definition at line 47 of file ossimSingleImageChain.cpp.

    :
    ossimImageChain(),
    m_handler(0),
    m_bandSelector(0),
    m_histogramRemapper(0),
    m_brightnessContrast(0),
    m_sharpen(0),
    m_scalarRemapper(0),
    m_resamplerCache(0),
    m_resampler(0),
    m_chainCache(0),
    m_addNullPixelFlipFlag(addNullPixelFlipFlag),
    m_addHistogramFlag(addHistogramFlag),
    m_addResamplerCacheFlag(addResamplerCacheFlag),
    m_addChainCacheFlag(addChainCacheFlag),
    m_remapToEightBitFlag(remapToEightBitFlag),
    m_threeBandFlag(threeBandFlag),
    m_threeBandReverseFlag(threeBandReverseFlag),
    m_brightnessContrastFlag(brightnessContrastFlag),
    m_sharpenFlag(sharpenFlag),
    m_geoPolyCutterFlag(geoPolyCutterFlag)
 {
 }

◆ ~ossimSingleImageChain()

ossimSingleImageChain::~ossimSingleImageChain ( )

virtual

virtual destructor

Definition at line 81 of file ossimSingleImageChain.cpp.

References m_bandSelector, m_brightnessContrast, m_chainCache, m_geoPolyCutter, m_handler, m_histogramRemapper, m_nullPixelFlip, m_resampler, m_resamplerCache, m_scalarRemapper, and m_sharpen.

 {
    m_handler            = 0;
    m_nullPixelFlip      = 0;
    m_bandSelector       = 0;
    m_histogramRemapper  = 0;
    m_brightnessContrast = 0;
    m_sharpen            = 0;
    m_scalarRemapper     = 0;
    m_resamplerCache     = 0;
    m_resampler          = 0;
    m_chainCache         = 0;
    m_geoPolyCutter      = 0;
 
 }

Member Function Documentation

◆ addBandSelector() [1/2]

void ossimSingleImageChain::addBandSelector ( )

Adds a band selector to the end of the chain.

Definition at line 526 of file ossimSingleImageChain.cpp.

References ossimImageChain::addFirst(), ossimRefPtr< T >::get(), and m_bandSelector.

Referenced by createRenderedChain(), setBandSelection(), setDefaultBandSelection(), and setToThreeBands().

 {
    if (!m_bandSelector)
    {
       m_bandSelector = new ossimBandSelector();
 
       // Add to the end of the chain.
       addFirst(m_bandSelector.get());
    }
 }

◆ addBandSelector() [2/2]

void ossimSingleImageChain::addBandSelector ( const ossimSrcRecord & src )

Adds a band selector.

This takes an ossimSrcRecord which can contain a band selection list.

Parameters

src	Record to initialize band selector from.

Definition at line 537 of file ossimSingleImageChain.cpp.

References ossimImageChain::addFirst(), ossimRefPtr< T >::get(), ossimSrcRecord::getBands(), m_bandSelector, and ossimBandSelector::setOutputBandList().

 {
    if (!m_bandSelector)
    {
       m_bandSelector = new ossimBandSelector();
       
       // Add to the end of the chain.
       addFirst(m_bandSelector.get());
    }
    if ( src.getBands().size() )
    {
       m_bandSelector->setOutputBandList( src.getBands() );
    }
 }

◆ addBrightnessContrast()

void ossimSingleImageChain::addBrightnessContrast ( )

Adds brightness contrast filter the end of the chain if not present.

Definition at line 702 of file ossimSingleImageChain.cpp.

References ossimImageChain::addFirst(), ossimRefPtr< T >::get(), and m_brightnessContrast.

Referenced by createRenderedChain().

 {
    if ( !m_brightnessContrast )
    {
       m_brightnessContrast = new ossimBrightnessContrastSource();
 
       // Add to the end of the chain.
       addFirst( m_brightnessContrast.get() );
    }
 }

◆ addCache()

ossimRefPtr< ossimCacheTileSource > ossimSingleImageChain::addCache ( )

Adds a new cache to the current end of the chain.

Returns: Pointer to cache.

Definition at line 658 of file ossimSingleImageChain.cpp.

References ossimImageChain::addFirst(), and ossimRefPtr< T >::get().

Referenced by ossimChipProcTool::createInputChain(), and createRenderedChain().

 {
    ossimRefPtr<ossimCacheTileSource> cache = new ossimCacheTileSource();
 
    // Add to the end of the chain.
    addFirst(cache.get());
 
    return cache;
 }

◆ addGeoPolyCutter()

void ossimSingleImageChain::addGeoPolyCutter ( )

Adds a geo polycutter to allow for cropping imagery or nulling out regions.

This has no affect on modification of the bounds

Definition at line 724 of file ossimSingleImageChain.cpp.

References ossimImageChain::addFirst(), ossimRefPtr< T >::get(), ossimImageChain::getImageGeometry(), m_geoPolyCutter, ossimGeoPolyCutter::setView(), and ossimRefPtr< T >::valid().

Referenced by addGeoPolyCutterPolygon(), and createRenderedChain().

 {
    if(!m_geoPolyCutter.valid())
    {
       m_geoPolyCutter = new ossimGeoPolyCutter();
 
       //---
       // ossimGeoPolyCutter requires a view geometry to transform the points.
       // So set prior to adding to end of chain if valid.  If not, user is
       // responsible for setting.
       //---
       ossimRefPtr<ossimImageGeometry> geom = getImageGeometry();
       if ( geom.valid() )
       {
          m_geoPolyCutter->setView( geom.get() );
       }
       
       addFirst( m_geoPolyCutter.get() );
    }
 }

◆ addGeoPolyCutterPolygon() [1/2]

void ossimSingleImageChain::addGeoPolyCutterPolygon ( const vector< ossimGpt > & polygon )

Definition at line 745 of file ossimSingleImageChain.cpp.

References addGeoPolyCutter(), ossimGeoPolyCutter::addPolygon(), m_geoPolyCutter, and ossimRefPtr< T >::valid().

Referenced by ossimHdf5Tool::loadImageFiles().

 {
    if(!m_geoPolyCutter.valid())
    {
       addGeoPolyCutter();
    }
    
    // sanity check to verify that the add did not fail
    if(m_geoPolyCutter.valid())
    {
       m_geoPolyCutter->addPolygon(polygon);   
    }
 }

◆ addGeoPolyCutterPolygon() [2/2]

void ossimSingleImageChain::addGeoPolyCutterPolygon ( const ossimGeoPolygon & polygon )

Definition at line 759 of file ossimSingleImageChain.cpp.

References addGeoPolyCutter(), ossimGeoPolyCutter::addPolygon(), m_geoPolyCutter, and ossimRefPtr< T >::valid().

 {
    if(!m_geoPolyCutter.valid())
    {
       addGeoPolyCutter();
    }
    
    // sanity check to verify that the add did not fail
    if(m_geoPolyCutter.valid())
    {
       m_geoPolyCutter->addPolygon(polygon);
    }
 }

◆ addHistogramRemapper() [1/2]

void ossimSingleImageChain::addHistogramRemapper ( )

Adds histogram remapper to the chain.

Definition at line 569 of file ossimSingleImageChain.cpp.

References ossimImageChain::addFirst(), ossimRefPtr< T >::get(), m_histogramRemapper, and ossimSource::setEnableFlag().

Referenced by createRenderedChain().

 {
    if (!m_histogramRemapper)
    {
       m_histogramRemapper = new ossimHistogramRemapper();
       
       m_histogramRemapper->setEnableFlag(false);
 
       // Add to the end of the chain.
       addFirst(m_histogramRemapper.get());
    } 
 }

◆ addHistogramRemapper() [2/2]

void ossimSingleImageChain::addHistogramRemapper ( const ossimSrcRecord & src )

Adds a band selector.

This takes an ossimSrcRecord which can contain a histogram operation to be performed.

Parameters

src	Record to initialize band selector from.

Definition at line 582 of file ossimSingleImageChain.cpp.

References ossimImageChain::addFirst(), ossimFilename::dirCat(), ossimString::downcase(), ossimFilename::fileNoExtension(), ossimRefPtr< T >::get(), ossimImageHandler::getFilename(), ossimImageHandler::getFilenameWithThisExtension(), ossimHistogramRemapper::getHistogramFile(), ossimSrcRecord::getHistogramOp(), ossimSrcRecord::getSupportDir(), ossimHistogramRemapper::LINEAR_1STD_FROM_MEAN, ossimHistogramRemapper::LINEAR_2STD_FROM_MEAN, ossimHistogramRemapper::LINEAR_3STD_FROM_MEAN, ossimHistogramRemapper::LINEAR_AUTO_MIN_MAX, m_handler, m_histogramRemapper, ossimFilename::NIL, ossimHistogramRemapper::openHistogram(), ossimNotify(), ossimNotifyLevel_WARN, ossimSource::setEnableFlag(), ossimFilename::setExtension(), ossimHistogramRemapper::setStretchMode(), ossimString::size(), and ossimRefPtr< T >::valid().

 {
    static const char MODULE[] =
       "ossimSingleImageChain::addHistogramRemapper(const ossimSrcRecord&)";
    
    if (!m_histogramRemapper)
    {
       m_histogramRemapper = new ossimHistogramRemapper();
       
       m_histogramRemapper->setEnableFlag(false);
 
       // Add to the end of the chain.
       addFirst(m_histogramRemapper.get());
    }
 
    if ( src.getHistogramOp().size() && m_handler.valid() )
    {
       // Create histogram code here???
       
       // Open the histogram if needed.
       if ( m_histogramRemapper->getHistogramFile() == ossimFilename::NIL )
       {
          ossimFilename f;
          if ( src.getSupportDir().size() )
          {
             f = src.getSupportDir();
             f.dirCat( m_handler->getFilename().fileNoExtension() );
             f.setExtension(".his");
          }
          else
          {
             f = m_handler->getFilenameWithThisExtension( ossimString("his") );
          }
          if ( m_histogramRemapper->openHistogram( f ) == false )
          {
             ossimNotify(ossimNotifyLevel_WARN)
                << MODULE << "\nCould not open:  " << f << "\n";
          }
       }
 
       // Set the histogram strech mode.
       if ( src.getHistogramOp().size() )
       {
          // Enable.
          m_histogramRemapper->setEnableFlag(true);
          
          // Set the histo mode:
          ossimString op = src.getHistogramOp();
          op.downcase();
          if ( op == "auto-minmax" )
          {
             m_histogramRemapper->setStretchMode( ossimHistogramRemapper::LINEAR_AUTO_MIN_MAX );
          }
          else if ( (op == "std-stretch-1") || (op == "std-stretch 1") )
          {
             m_histogramRemapper->setStretchMode( ossimHistogramRemapper::LINEAR_1STD_FROM_MEAN );
          } 
          else if ( (op == "std-stretch-2") || (op == "std-stretch 2") )
          {
             m_histogramRemapper->setStretchMode( ossimHistogramRemapper::LINEAR_2STD_FROM_MEAN );
          } 
          else if ( (op == "std-stretch-3") || (op == "std-stretch 3") )
          {
             m_histogramRemapper->setStretchMode( ossimHistogramRemapper::LINEAR_3STD_FROM_MEAN );
          }
          else
          {
             m_histogramRemapper->setEnableFlag(false);
             ossimNotify(ossimNotifyLevel_WARN)
                << MODULE << "\nUnhandled operation: " << op << "\n";
          }
       }
       
    } // End: if ( src.setHistogramOp().size() && m_handler.valid() )
 }

◆ addImageHandler() [1/2]

bool ossimSingleImageChain::addImageHandler	(	const ossimFilename &	file,
		bool	openOverview = `true`
	)

Adds an image handler for file.

Parameters

file	File to open.
openOverview	If true image handler will attempt to open overview. Note that if you are planning on doing a rendered chain or want to go between res levels you should set this to true. default = true

Returns: true on success, false on error.

Definition at line 413 of file ossimSingleImageChain.cpp.

References ossimImageChain::addLast(), close(), ossimRefPtr< T >::get(), ossimImageHandlerRegistry::instance(), m_handler, ossimImageHandlerRegistry::openConnection(), and ossimRefPtr< T >::valid().

Referenced by open().

 {
    bool result = false;
 
    close();
    
    // m_handler = ossimImageHandlerRegistry::instance()->open(file, true, openOverview);
    m_handler = ossimImageHandlerRegistry::instance()->openConnection(file, openOverview);
    
    if ( m_handler.valid() )
    {
       // Add to the chain.  Note: last is really first.
       addLast( m_handler.get() );
       
       result = true;
    }
 
    return result;
 }

◆ addImageHandler() [2/2]

bool ossimSingleImageChain::addImageHandler ( const ossimSrcRecord & src )

Adds an image handler from src record.

This take an ossimSrcRecord which can contain a supplemental directory to look for overviews.

Parameters

rec	Record to open.

Returns: true on success, false on error.

Definition at line 433 of file ossimSingleImageChain.cpp.

References ossimImageChain::addLast(), close(), ossimString::empty(), ossimRefPtr< T >::get(), ossimSrcRecord::getAttributesKwl(), ossimSrcRecord::getEntryIndex(), ossimSrcRecord::getFilename(), ossimImageHandler::getFilenameWithThisExtension(), ossimSrcRecord::getHistogramPath(), ossimSrcRecord::getMaskPath(), ossimImageHandler::getOverview(), ossimSrcRecord::getOverviewPath(), ossimSrcRecord::getSupportDir(), ossimImageHandlerRegistry::instance(), ossimFilename::isDir(), m_handler, ossimImageHandlerRegistry::open(), ossimImageHandler::openOverview(), ossimFilename::path(), ossimImageHandler::setCurrentEntry(), ossimImageHandler::setSupplementaryDirectory(), ossimString::size(), and ossimRefPtr< T >::valid().

 {
    bool result = false;
 
    close();
    
    // m_handler = ossimImageHandlerRegistry::instance()->open(file, true, openOverview);
    m_handler = ossimImageHandlerRegistry::instance()->open(src.getAttributesKwl());
    
    if ( m_handler.valid() )
    {
       // Add to the chain.  Note: last is really first.
       addLast( m_handler.get() );
       
       result = true;
    }
 
    return result;
 
 //   bool result = addImageHandler( src.getFilename() );
 #if 0  
    if (result)
    {
       //---
       // When loading from ossimSrcRecord typically the overview/histograms are
       // not in the same directory and the "support" keyword is not set.  For
       // the ossimImageHandler::getFilenameWithThisExtension to work correctly
       // the ossimImageHandler::theSupplementaryDirectory must be set.
       // So if the ossimSrcRecord::getSupportDir() is empty and the overview
       // or histogram is not co-located with the image we will set it here.
       //---
       ossimFilename supportDir = src.getSupportDir();
       if ( supportDir.empty() )
       {
          if ( src.getOverviewPath().size() )
          {
             if ( src.getOverviewPath().isDir() )
             {
                supportDir = src.getOverviewPath();
             }
             else
             {
                supportDir = src.getOverviewPath().path();
             }
          }
          else if ( src.getHistogramPath().size() )
          {
             if ( src.getHistogramPath().isDir() )
             {
                supportDir = src.getHistogramPath();
             }
             else
             {
                supportDir = src.getHistogramPath().path();
             }
          }
          else if ( src.getMaskPath().size() )
          {
             if ( src.getMaskPath().isDir() )
             {
                supportDir = src.getMaskPath();
             }
             else
             {
                supportDir = src.getMaskPath().path();
             }
          }
       }
       if ( supportDir.size() && (src.getFilename().path() != supportDir) )
       {
          m_handler->setSupplementaryDirectory( supportDir );
       }
       if ( src.getEntryIndex() > 0 ) // defaulted to -1.
       {
          m_handler->setCurrentEntry( static_cast<ossim_uint32>( src.getEntryIndex() ) );
       }
       if ( m_handler->getOverview() == 0 )
       {
          if ( src.getOverviewPath().size() )
          {
             m_handler->openOverview( src.getOverviewPath() );
          }
          else
          {
             ossimFilename ovrFile = m_handler->getFilenameWithThisExtension(ossimString(".ovr"));
             m_handler->openOverview( ovrFile ); 
          }
       }
    }
    #endif
    return result;
 }

◆ addNullPixelFlip() [1/2]

void ossimSingleImageChain::addNullPixelFlip ( )

Adds the null pixel flip just after the band selection.

Definition at line 552 of file ossimSingleImageChain.cpp.

References ossimImageChain::addFirst(), ossimRefPtr< T >::get(), and m_nullPixelFlip.

Referenced by createRenderedChain().

 {
    if(!m_nullPixelFlip)
    {
       m_nullPixelFlip = new ossimNullPixelFlip();
       addFirst(m_nullPixelFlip.get());
    }
 }

◆ addNullPixelFlip() [2/2]

void ossimSingleImageChain::addNullPixelFlip ( const ossimSrcRecord & src )

Definition at line 560 of file ossimSingleImageChain.cpp.

References ossimImageChain::addFirst(), ossimRefPtr< T >::get(), and m_nullPixelFlip.

 {
    if(!m_nullPixelFlip)
    {
       m_nullPixelFlip = new ossimNullPixelFlip();
       addFirst(m_nullPixelFlip.get());
    }
 }

◆ addRenderer()

void ossimSingleImageChain::addRenderer ( )

Adds a resampler (a.k.a.

"renderer") to the end of the chain. This method in turn calls "addResampler()".

Definition at line 678 of file ossimSingleImageChain.cpp.

References addResampler().

 {
    addResampler();
 }

◆ addResampler()

void ossimSingleImageChain::addResampler ( )

Adds a resampler (a.k.a.

"renderer") to the end of the chain.

Definition at line 668 of file ossimSingleImageChain.cpp.

References ossimImageChain::addFirst(), ossimRefPtr< T >::get(), and m_resampler.

Referenced by addRenderer(), ossimChipProcTool::createInputChain(), and createRenderedChain().

 {
    if ( !m_resampler )
    {
       m_resampler = new ossimImageRenderer();
 
       // Add to the end of the chain.
       addFirst(m_resampler.get());
    }
 }

◆ addScalarRemapper()

void ossimSingleImageChain::addScalarRemapper ( )

Adds scalar remapper either to the left of the resampler cache or at the end of the chain if not present.

Definition at line 683 of file ossimSingleImageChain.cpp.

References ossimImageChain::addFirst(), ossimRefPtr< T >::get(), ossimImageChain::insertLeft(), m_resamplerCache, m_scalarRemapper, and ossimRefPtr< T >::valid().

Referenced by createRenderedChain().

 {
    if ( !m_scalarRemapper )
    {
       m_scalarRemapper = new ossimScalarRemapper();
 
       if ( m_resamplerCache.valid() )
       {
          // Add to the left of the resampler cache.
          insertLeft(m_scalarRemapper.get(), m_resamplerCache.get());
       }
       else
       {
          // Add to the end of the chain.
          addFirst(m_scalarRemapper.get());
       }
    }
 }

◆ addSharpen()

void ossimSingleImageChain::addSharpen ( )

Adds sharpen filter the end of the chain if not present.

Definition at line 713 of file ossimSingleImageChain.cpp.

References ossimImageChain::addFirst(), ossimRefPtr< T >::get(), and m_sharpen.

Referenced by createRenderedChain().

 {
    if ( !m_sharpen )
    {
       m_sharpen = new ossimImageSharpenFilter();
 
       // Add to the end of the chain.
       addFirst( m_sharpen.get() );
    }
 }

◆ close()

void ossimSingleImageChain::close ( )

close method to delete the image handler.

Definition at line 129 of file ossimSingleImageChain.cpp.

References ossimRefPtr< T >::get(), m_handler, ossimImageChain::removeChild(), and ossimRefPtr< T >::valid().

Referenced by addImageHandler().

 {
    if ( m_handler.valid() )
    {
       if ( removeChild(m_handler.get()) )
       {
          m_handler = 0;
       }
    }
 }

◆ createRenderedChain() [1/2]

void ossimSingleImageChain::createRenderedChain ( )

Create a rendered image chain.

Typical usage is to call this after "open" method returns true like: if ( myChain->open(myFile) == true ) { myChain->createRenderedChain(); code-goes-here(); }

Typical chain is:

1) image handler 2) band selector (optional) 3) histogram remapper(optional) 4) scalar remapper (optional) 5) resampler cache 6) resampler 7) band selector (optional when going one band to three) 8) chain cache

NOTES: 1) Cache on left hand side of resampler is critical to speed if you have the ossimImageRender enabled.

2) If doing a sequential write where tiles to the right of the resampler will not be revisited the chain cache could be disabled to save memory.

Definition at line 165 of file ossimSingleImageChain.cpp.

References addBandSelector(), addBrightnessContrast(), addCache(), ossimImageChain::addFirst(), addGeoPolyCutter(), addHistogramRemapper(), addNullPixelFlip(), addResampler(), addScalarRemapper(), addSharpen(), ossimRefPtr< T >::get(), ossimImageHandler::getImageTileHeight(), ossimImageHandler::getImageTileWidth(), ossimImageSource::getNumberOfOutputBands(), ossimImageSource::getOutputScalarType(), ossimImageChain::initialize(), ossimImageHandler::isImageTiled(), m_addChainCacheFlag, m_addHistogramFlag, m_addNullPixelFlipFlag, m_addResamplerCacheFlag, m_bandSelector, m_brightnessContrastFlag, m_chainCache, m_geoPolyCutterFlag, m_handler, m_remapToEightBitFlag, m_resamplerCache, m_sharpenFlag, m_threeBandFlag, m_threeBandReverseFlag, OSSIM_UINT8, ossimTiledImagePatch::setInputTileSize(), ossimCacheTileSource::setTileSize(), setToThreeBands(), setToThreeBandsReverse(), ossimRefPtr< T >::valid(), ossimIpt::x, and ossimIpt::y.

 {
    // Band selector after image handler only if needed.
    if ( m_handler.valid() )
    {
       // Only add if multiple bands.
       if ( m_handler->getNumberOfOutputBands() != 1 )
       {
          addBandSelector();
          if ( m_threeBandReverseFlag )
          {
             setToThreeBandsReverse();
          }
       }
    }
    else // No image handler so just add it.
    {
       addBandSelector();
    }
 
    // will do this here.  Not sure if we want flipped just before the resampler or if we want to do it here.
    // I think this is a better place for you can now manipulate the flipped pixel   
    if (m_addNullPixelFlipFlag)
    {
          addNullPixelFlip();
    }
 
    // histogram:
    if ( m_addHistogramFlag )
    {
       addHistogramRemapper();
    }
 
    // brightness contrast:
    if ( m_brightnessContrastFlag )
    {
       addBrightnessContrast();
    }
 
    // sharpen filter:
    if ( m_sharpenFlag )
    {
       addSharpen();
    }
 
    // scalar remapper
    if ( m_remapToEightBitFlag )
    {
       if ( m_handler.valid() )
       {
          // See if it's eight bit.
          if (m_handler->getOutputScalarType() != OSSIM_UINT8)
          {
             addScalarRemapper();
          }
       }
       else
       {
          // Just add...
          addScalarRemapper(); 
       }
    }
 
    // resampler cache
    if ( m_addResamplerCacheFlag )
    {
       m_resamplerCache = addCache();
 
       // If input image is tiled set the cache input tile size to that.
       if ( m_handler.valid() )
       {
          if ( m_handler->isImageTiled() )
          {
             ossimIpt inputImageTileSize;
             inputImageTileSize.x = (ossim_int32)m_handler->getImageTileWidth();
             inputImageTileSize.y = (ossim_int32)m_handler->getImageTileHeight();
             if ( m_resamplerCache.valid() )
             {
                m_resamplerCache->setTileSize( inputImageTileSize );
             }
          }
       }
    }
 
 #if 0 /* test code - drb */
    ossimRefPtr<ossimTiledImagePatch> tp = new ossimTiledImagePatch();
    if ( m_handler.valid() )
    {
       if ( m_handler->isImageTiled() )
       {
          ossimIpt inputImageTileSize;
          inputImageTileSize.x = (ossim_int32)m_handler->getImageTileWidth();
          inputImageTileSize.y = (ossim_int32)m_handler->getImageTileHeight();
          tp->setInputTileSize( inputImageTileSize );
       }
    }
    addFirst( tp.get() );
 #endif   
    
    // resampler
    addResampler();
 
 #if 0 /* test code - drb */
    ossimRefPtr<ossimTiledImagePatch> tp2 = new ossimTiledImagePatch();
    ossimIpt inputImageTileSize(64, 64);
    tp2->setInputTileSize( inputImageTileSize );
    addFirst( tp2.get() );
 #endif   
 
    //---
    // Do this here so that if a band selector is added to the end of the
    // chain it will go in before the end of chain cache.
    //---
    if (m_threeBandFlag)
    {
       if (!m_bandSelector)
       {
          addBandSelector();
       }
       setToThreeBands();
    }
 
    //---
    // Ditto...
    //---
    if ( m_threeBandReverseFlag && !m_bandSelector )
    {
       addBandSelector();
       setToThreeBandsReverse();
    }
 
    // Put the geo cutter just before the cache.
    if(m_geoPolyCutterFlag)
    {
       addGeoPolyCutter();
    }
 
    // End of chain cache.
    if ( m_addChainCacheFlag )
    {
       m_chainCache = addCache();
    }
 
    initialize();
 
 }

◆ createRenderedChain() [2/2]

void ossimSingleImageChain::createRenderedChain ( const ossimSrcRecord & src )

Create a rendered image chain that takes an ossimSrcRecord.

Definition at line 312 of file ossimSingleImageChain.cpp.

References addBandSelector(), addBrightnessContrast(), addCache(), addHistogramRemapper(), addNullPixelFlip(), addResampler(), addScalarRemapper(), addSharpen(), ossimSrcRecord::getBands(), ossimSrcRecord::getHistogramOp(), ossimImageSource::getNumberOfOutputBands(), ossimImageSource::getOutputScalarType(), ossimImageChain::initialize(), m_addChainCacheFlag, m_addHistogramFlag, m_addNullPixelFlipFlag, m_addResamplerCacheFlag, m_bandSelector, m_brightnessContrastFlag, m_chainCache, m_handler, m_remapToEightBitFlag, m_resamplerCache, m_sharpenFlag, m_threeBandFlag, m_threeBandReverseFlag, OSSIM_UINT8, setToThreeBands(), setToThreeBandsReverse(), ossimString::size(), and ossimRefPtr< T >::valid().

 {
    // Band selector after image handler only if needed.
    if ( m_handler.valid() )
    {
       // Only add if needed.
       if ( ( m_handler->getNumberOfOutputBands() != 1 ) || src.getBands().size() )
       {
          addBandSelector(src);
          if ( m_threeBandReverseFlag )
          {
             setToThreeBandsReverse();
          }
       }
    }
    else // No image handler so just add it.
    {
       addBandSelector(src);
    }
    
    if(m_addNullPixelFlipFlag)
    {
       addNullPixelFlip();
    }
    // histogram
    if ( m_addHistogramFlag || src.getHistogramOp().size() )
    {
       addHistogramRemapper(src);
    }
 
    // brightness contrast:
    if ( m_brightnessContrastFlag )
    {
       addBrightnessContrast();
    }
 
    // sharpen filter:
    if ( m_sharpenFlag )
    {
       addSharpen();
    }
 
    // scalar remapper
    if ( m_remapToEightBitFlag )
    {
       if ( m_handler.valid() )
       {
          // See if it's eight bit.
          if (m_handler->getOutputScalarType() != OSSIM_UINT8)
          {
             addScalarRemapper();
          }
       }
       else
       {
          // Just add...
          addScalarRemapper(); 
       }
    }
 
    // resampler cache
    if ( m_addResamplerCacheFlag )
    {
       m_resamplerCache = addCache();
    }
    
    // resampler
    addResampler();
 
    //---
    // Do this here so that if a band selector is added to the end of the
    // chain it will go in before the end of chain cache.
    //---
    if (m_threeBandFlag)
    {
       if (!m_bandSelector) // Input must be one band.
       {
          addBandSelector(src);
       }
       setToThreeBands();
    }
 
    //---
    // Ditto...
    //---
    if ( m_threeBandReverseFlag && !m_bandSelector )
    {
       addBandSelector();
       setToThreeBandsReverse();
    }
 
    // End of chain cache.
    if ( m_addChainCacheFlag )
    {
       m_chainCache = addCache();
    }
 
    initialize();
 
 }

◆ getAddChainCacheFlag()

bool ossimSingleImageChain::getAddChainCacheFlag ( ) const

Gets the add chain cache flag.

Returns: true or false.

Definition at line 907 of file ossimSingleImageChain.cpp.

References m_addChainCacheFlag.

 {
    return m_addChainCacheFlag;
 }

◆ getAddHistogramFlag()

bool ossimSingleImageChain::getAddHistogramFlag ( ) const

Gets the add histogram flag.

Returns: true or false.

Definition at line 887 of file ossimSingleImageChain.cpp.

References m_addHistogramFlag.

 {
    return m_addHistogramFlag;
 }

◆ getAddResamplerCacheFlag()

bool ossimSingleImageChain::getAddResamplerCacheFlag ( ) const

Gets the add resampler cache flag.

Returns: true or false.

Definition at line 897 of file ossimSingleImageChain.cpp.

References m_addResamplerCacheFlag.

 {
    return m_addResamplerCacheFlag;
 }

◆ getBandSelector() [1/2]

ossimRefPtr< const ossimBandSelector > ossimSingleImageChain::getBandSelector ( ) const

Returns: ossimRefPtr containing the band selector.

Note: Can contain a null pointer so callers should validate.

Definition at line 783 of file ossimSingleImageChain.cpp.

References ossimRefPtr< T >::get(), and m_bandSelector.

 {
    return ossimRefPtr<const ossimBandSelector>( m_bandSelector.get() );
 }

◆ getBandSelector() [2/2]

ossimRefPtr< ossimBandSelector > ossimSingleImageChain::getBandSelector ( )

Returns: ossimRefPtr containing the band selector.

Note: Can contain a null pointer so callers should validate.

Definition at line 794 of file ossimSingleImageChain.cpp.

References m_bandSelector.

 {
    return m_bandSelector;
 }

◆ getBrightnessContrast() [1/2]

ossimRefPtr< const ossimBrightnessContrastSource > ossimSingleImageChain::getBrightnessContrast ( ) const

Returns: ossimRefPtr containing the brightness contrast filter.

Note: Can contain a null pointer so callers should validate.

Definition at line 840 of file ossimSingleImageChain.cpp.

References ossimRefPtr< T >::get(), and m_brightnessContrast.

 {
    return ossimRefPtr<const ossimBrightnessContrastSource>( m_brightnessContrast.get() );
 }

◆ getBrightnessContrast() [2/2]

ossimRefPtr< ossimBrightnessContrastSource > ossimSingleImageChain::getBrightnessContrast ( )

Returns: ossimRefPtr containing the brightness contrast filter.

Note: Can contain a null pointer so callers should validate.

Definition at line 845 of file ossimSingleImageChain.cpp.

References m_brightnessContrast.

 {
    return m_brightnessContrast;
 }

◆ getBrightnessContrastFlag()

bool ossimSingleImageChain::getBrightnessContrastFlag ( ) const

Get the brightness constrast flag.

Returns: true or false.

Definition at line 947 of file ossimSingleImageChain.cpp.

References m_brightnessContrastFlag.

 {
    return m_brightnessContrastFlag;
 }

◆ getChainCache() [1/2]

ossimRefPtr< const ossimCacheTileSource > ossimSingleImageChain::getChainCache ( ) const

Returns: ossimRefPtr containing the chain cache.

Note: Can contain a null pointer so callers should validate.

Definition at line 861 of file ossimSingleImageChain.cpp.

References ossimRefPtr< T >::get(), and m_chainCache.

 {
    return ossimRefPtr<const ossimCacheTileSource>( m_chainCache.get() );
 }

◆ getChainCache() [2/2]

ossimRefPtr< ossimCacheTileSource > ossimSingleImageChain::getChainCache ( )

Returns: ossimRefPtr containing the chain cache.

Note: Can contain a null pointer so callers should validate.

Definition at line 866 of file ossimSingleImageChain.cpp.

References m_chainCache.

 {
    return m_chainCache;
 }

◆ getFilename()

ossimFilename ossimSingleImageChain::getFilename ( ) const

Returns: The filename of the image.

Definition at line 140 of file ossimSingleImageChain.cpp.

References ossimImageHandler::getFilename(), m_handler, and ossimRefPtr< T >::valid().

Referenced by ossimTiledElevationDatabase::addEntry().

 {
    ossimFilename result;
    if ( m_handler.valid() )
    {
       result = m_handler->getFilename();
    }
    return result;
 }

◆ getHistogramRemapper() [1/2]

ossimRefPtr< const ossimHistogramRemapper > ossimSingleImageChain::getHistogramRemapper ( ) const

Returns: ossimRefPtr containing the histogram remapper.

Note: Can contain a null pointer so callers should validate.

Definition at line 799 of file ossimSingleImageChain.cpp.

References ossimRefPtr< T >::get(), and m_histogramRemapper.

Referenced by openHistogram().

 {
    return ossimRefPtr<const ossimHistogramRemapper>( m_histogramRemapper.get() );
 }

◆ getHistogramRemapper() [2/2]

ossimRefPtr< ossimHistogramRemapper > ossimSingleImageChain::getHistogramRemapper ( )

Returns: ossimRefPtr containing the histogram remapper.

Note: Can contain a null pointer so callers should validate.

Definition at line 804 of file ossimSingleImageChain.cpp.

References m_histogramRemapper.

 {
    return m_histogramRemapper;
 }

◆ getImageHandler() [1/2]

ossimRefPtr< const ossimImageHandler > ossimSingleImageChain::getImageHandler ( ) const

Returns: ossimRefPtr containing the image handler.

Note: Can contain a null pointer so callers should validate.

Definition at line 773 of file ossimSingleImageChain.cpp.

References ossimRefPtr< T >::get(), and m_handler.

Referenced by ossimChipProcTool::createInputChain(), ossimChipperUtil::getIrect(), ossimBandMergeTool::initHistogramStretch(), ossimChipProcTool::mosaicDemSources(), ossimChipProcTool::newIdentityProjection(), openHistogram(), ossimAutRegUtil::setChainEntry(), and ossimChipperUtil::setChainEntry().

 {
    return ossimRefPtr<const ossimImageHandler>( m_handler.get() );
 }

◆ getImageHandler() [2/2]

ossimRefPtr< ossimImageHandler > ossimSingleImageChain::getImageHandler ( )

Returns: ossimRefPtr containing the image handler.

Note: Can contain a null pointer so callers should validate.

Definition at line 778 of file ossimSingleImageChain.cpp.

References m_handler.

 {
    return m_handler;
 }

◆ getImageHandlerScalarType()

ossimScalarType ossimSingleImageChain::getImageHandlerScalarType ( ) const

Convenience method to return the scalar type of the image handler.

Returns: Scalar type of the image handler.

This can return OSSIM_SCALAR_UNKNOWN if the image handler has not been set yet. Also, this is NOT the same as calling getOutputScalarType which could have a different scalar type than the image if the m_remapToEightBitFlag has been set.

Definition at line 1060 of file ossimSingleImageChain.cpp.

References ossimImageSource::getOutputScalarType(), m_handler, OSSIM_SCALAR_UNKNOWN, and ossimRefPtr< T >::valid().

 {
    ossimScalarType result = OSSIM_SCALAR_UNKNOWN;
    if ( m_handler.valid() )
    {
       result = m_handler->getOutputScalarType();
    }
    return result;
 }

◆ getImageRenderer() [1/2]

ossimRefPtr< const ossimImageRenderer > ossimSingleImageChain::getImageRenderer ( ) const

Returns: ossimRefPtr containing the resampler (a.k.a. "renderer").

Note: Can contain a null pointer so callers should validate.

Definition at line 819 of file ossimSingleImageChain.cpp.

References ossimRefPtr< T >::get(), and m_resampler.

Referenced by ossimChipProcTool::mosaicDemSources().

 {
    return ossimRefPtr<const ossimImageRenderer>( m_resampler.get() );
 }

◆ getImageRenderer() [2/2]

ossimRefPtr< ossimImageRenderer > ossimSingleImageChain::getImageRenderer ( )

Returns: ossimRefPtr containing the resampler (a.k.a. "renderer").

Note: Can contain a null pointer so callers should validate.

Definition at line 824 of file ossimSingleImageChain.cpp.

References m_resampler.

 {
    return m_resampler;
 }

◆ getNullPixelFlip()

ossimRefPtr< const ossimNullPixelFlip > ossimSingleImageChain::getNullPixelFlip ( ) const

Returns: the null pixel flip

Definition at line 788 of file ossimSingleImageChain.cpp.

References ossimRefPtr< T >::get(), and m_nullPixelFlip.

 {
    return ossimRefPtr<const ossimNullPixelFlip>( m_nullPixelFlip.get() );
 }

◆ getNullPixelFlipFlag()

bool ossimSingleImageChain::getNullPixelFlipFlag ( ) const

Gets the add histogram flag.

Returns: true or false.

Definition at line 877 of file ossimSingleImageChain.cpp.

References m_addNullPixelFlipFlag.

 {
    return m_addNullPixelFlipFlag;
 }

◆ getRemapToEightBitFlag()

bool ossimSingleImageChain::getRemapToEightBitFlag ( ) const

Get the remap to eight bit flag.

Returns: true or false.

Definition at line 917 of file ossimSingleImageChain.cpp.

References m_remapToEightBitFlag.

 {
    return m_remapToEightBitFlag;
 }

◆ getResamplerCache() [1/2]

ossimRefPtr< const ossimCacheTileSource > ossimSingleImageChain::getResamplerCache ( ) const

Returns: ossimRefPtr containing the resampler cache.

Note: Can contain a null pointer so callers should validate.

Definition at line 809 of file ossimSingleImageChain.cpp.

References ossimRefPtr< T >::get(), and m_resamplerCache.

 {
    return ossimRefPtr<const ossimCacheTileSource>( m_resamplerCache.get() );
 }

◆ getResamplerCache() [2/2]

ossimRefPtr< ossimCacheTileSource > ossimSingleImageChain::getResamplerCache ( )

Returns: ossimRefPtr containing the resampler cache.

Note: Can contain a null pointer so callers should validate.

Definition at line 814 of file ossimSingleImageChain.cpp.

References m_resamplerCache.

 {
    return m_resamplerCache;
 }

◆ getScalarRemapper() [1/2]

ossimRefPtr< const ossimScalarRemapper > ossimSingleImageChain::getScalarRemapper ( ) const

Returns: ossimRefPtr containing the scalar remapper.

Note: Can contain a null pointer so callers should validate.

Definition at line 829 of file ossimSingleImageChain.cpp.

References ossimRefPtr< T >::get(), and m_scalarRemapper.

 {
    return ossimRefPtr<const ossimScalarRemapper>( m_scalarRemapper.get() );
 }

◆ getScalarRemapper() [2/2]

ossimRefPtr< ossimScalarRemapper > ossimSingleImageChain::getScalarRemapper ( )

Returns: ossimRefPtr containing the scalar remapper.

Note: Can contain a null pointer so callers should validate.

Definition at line 834 of file ossimSingleImageChain.cpp.

References m_scalarRemapper.

 {
    return m_scalarRemapper;
 }

◆ getSharpenFilter() [1/2]

ossimRefPtr< const ossimImageSharpenFilter > ossimSingleImageChain::getSharpenFilter ( ) const

Returns: ossimRefPtr containing the sharpen filter.

Note: Can contain a null pointer so callers should validate.

Definition at line 851 of file ossimSingleImageChain.cpp.

References ossimRefPtr< T >::get(), and m_sharpen.

 {
    return ossimRefPtr<const ossimImageSharpenFilter>( m_sharpen.get() );
 }

◆ getSharpenFilter() [2/2]

ossimRefPtr< ossimImageSharpenFilter > ossimSingleImageChain::getSharpenFilter ( )

Returns: ossimRefPtr containing the sharpen.

Note: Can contain a null pointer so callers should validate.

Definition at line 856 of file ossimSingleImageChain.cpp.

References m_sharpen.

 {
    return m_sharpen;
 }

◆ getSharpenFlag()

bool ossimSingleImageChain::getSharpenFlag ( ) const

Get the sharpen flag.

Returns: true or false.

Definition at line 957 of file ossimSingleImageChain.cpp.

References m_sharpenFlag.

 {
    return m_sharpenFlag;
 }

◆ getThreeBandFlag()

bool ossimSingleImageChain::getThreeBandFlag ( ) const

Get the three band flag.

Returns: true or false.

Definition at line 927 of file ossimSingleImageChain.cpp.

References m_threeBandFlag.

 {
    return m_threeBandFlag;
 }

◆ getThreeBandReverseFlag()

bool ossimSingleImageChain::getThreeBandReverseFlag ( ) const

Get the three band reverse flag.

Returns: true or false.

Definition at line 937 of file ossimSingleImageChain.cpp.

References m_threeBandReverseFlag.

 {
    return m_threeBandReverseFlag;
 }

◆ isOpen()

bool ossimSingleImageChain::isOpen ( ) const

Returns: true if image handler is opened.

Definition at line 155 of file ossimSingleImageChain.cpp.

References m_handler, and ossimRefPtr< T >::valid().

 {
    return m_handler.valid();
 }

◆ open() [1/2]

bool ossimSingleImageChain::open	(	const ossimFilename &	file,
		bool	openOverview = `true`
	)

open method that takes an image file.

Opens file and creates a simple chain with ossimImageHandler.

Parameters

file	File to open.
openOverview	If true image handler will attempt to open overview. Note that if you are planning on doing a rendered chain or want to go between res levels you should set this to true. default = true

Returns: true on success, false on error.

Note: This will close previous chain if one was opened.

Definition at line 150 of file ossimSingleImageChain.cpp.

References addImageHandler().

Referenced by ossimChipProcTool::createInputChain().

 {
    return addImageHandler(file, openOverview);
 }

◆ open() [2/2]

bool ossimSingleImageChain::open ( const ossimSrcRecord & src )

open method that takes an ossimSrcRecord.

Opens file and creates a simple chain with ossimImageHandler.

Returns: true on success, false on error.

Note: This will close previous chain if one was opened.

Definition at line 160 of file ossimSingleImageChain.cpp.

References addImageHandler().

 {
    return addImageHandler(src);
 }

◆ openHistogram()

bool ossimSingleImageChain::openHistogram ( ossimHistogramRemapper::StretchMode mode )

Convenience method to open the histogram and apply a default stretch.

This will only work if the image is open, there is a histogram remapper in the chain, and there was a histogram created.

Valid stretches (from ossimHistogramRemapper.h):

  ossimHistogramRemapper::LINEAR_ONE_PIECE
  ossimHistogramRemapper::LINEAR_1STD_FROM_MEAN
  ossimHistogramRemapper::LINEAR_2STD_FROM_MEAN
  ossimHistogramRemapper::LINEAR_3STD_FROM_MEAN
  ossimHistogramRemapper::LINEAR_AUTO_MIN_MAX

Returns: true on success, false on error.

Definition at line 1070 of file ossimSingleImageChain.cpp.

References ossimImageHandler::getFilenameWithThisExtension(), getHistogramRemapper(), getImageHandler(), ossimHistogramRemapper::openHistogram(), ossimSource::setEnableFlag(), ossimHistogramRemapper::setStretchMode(), true, and ossimRefPtr< T >::valid().

 {
    bool result = false;
    ossimRefPtr<ossimImageHandler> ih = getImageHandler();
    if ( ih.valid() )
    {
       ossimRefPtr<ossimHistogramRemapper> hr = getHistogramRemapper();
       if ( hr.valid() )
       {
          ossimFilename f = ih->getFilenameWithThisExtension( ossimString("his") );
          if ( hr->openHistogram( f ) == true )
          {
             // Enable:
             hr->setEnableFlag(true);
 
             // Set the mode:
             hr->setStretchMode( mode );
 
             result = true;
          }
       }
    }
    return result;
 }

◆ reset()

void ossimSingleImageChain::reset ( void )

reset method This deletes all links in the chain, zero's out all data members, and sets all flags back to default.

Definition at line 97 of file ossimSingleImageChain.cpp.

References ossimImageChain::deleteLast(), m_addChainCacheFlag, m_addHistogramFlag, m_addNullPixelFlipFlag, m_addResamplerCacheFlag, m_bandSelector, m_brightnessContrast, m_brightnessContrastFlag, m_chainCache, m_geoPolyCutter, m_geoPolyCutterFlag, m_handler, m_histogramRemapper, m_nullPixelFlip, m_remapToEightBitFlag, m_resampler, m_resamplerCache, m_scalarRemapper, m_sharpen, m_sharpenFlag, m_threeBandFlag, and m_threeBandReverseFlag.

 {
    bool result = true;
    do
    {
       result = deleteLast();
    } while (result);
 
    m_handler                = 0;
    m_bandSelector           = 0;
    m_nullPixelFlip          = 0;
    m_histogramRemapper      = 0;
    m_brightnessContrast     = 0;
    m_sharpen                = 0;
    m_scalarRemapper         = 0;
    m_resamplerCache         = 0;
    m_resampler              = 0;
    m_geoPolyCutter          = 0;
    m_chainCache             = 0;
 
    m_addHistogramFlag       = false;
    m_addNullPixelFlipFlag   = false;
    m_addResamplerCacheFlag  = false;
    m_addChainCacheFlag      = false;
    m_remapToEightBitFlag    = false;
    m_threeBandFlag          = false;
    m_threeBandReverseFlag   = false;
    m_brightnessContrastFlag = false;
    m_sharpenFlag            = false;
    m_geoPolyCutterFlag      = false;
 }

◆ setAddChainCacheFlag()

void ossimSingleImageChain::setAddChainCacheFlag ( bool flag )

If flag is true a chain cache will be added to the chain at create time.

This is a cache at the end of the chain.

Parameters

flag

Definition at line 902 of file ossimSingleImageChain.cpp.

References m_addChainCacheFlag.

 {
    m_addChainCacheFlag = flag;
 }

◆ setAddHistogramFlag()

void ossimSingleImageChain::setAddHistogramFlag ( bool flag )

If flag is true a histogram will be added to the chain at create time.

Parameters

flag

Definition at line 882 of file ossimSingleImageChain.cpp.

References m_addHistogramFlag.

 {
    m_addHistogramFlag = flag;
 }

◆ setAddNullPixelFlipFlag()

void ossimSingleImageChain::setAddNullPixelFlipFlag ( bool flag )

If flag is true a null pixel flip will be added to the chain at create time.

Parameters

flag

Definition at line 872 of file ossimSingleImageChain.cpp.

References m_addNullPixelFlipFlag.

 {
    m_addNullPixelFlipFlag = true;
 }

◆ setAddResamplerCacheFlag()

void ossimSingleImageChain::setAddResamplerCacheFlag ( bool flag )

If flag is true a resampler cache will be added to the chain at create time.

This is a cache to the left of the resampler.

Parameters

flag

Definition at line 892 of file ossimSingleImageChain.cpp.

References m_addResamplerCacheFlag.

 {
    m_addResamplerCacheFlag = flag;
 }

◆ setBandSelection()

void ossimSingleImageChain::setBandSelection ( const std::vector< ossim_uint32 > & bandList )

method to set band selector.

This will set the band selection to bandList. If a band selector is not in the chain yet it will be added.

Parameters

bandList The list of bands.

Definition at line 1031 of file ossimSingleImageChain.cpp.

References addBandSelector(), ossimHistogramRemapper::initialize(), m_bandSelector, m_histogramRemapper, ossimSource::setEnableFlag(), ossimBandSelector::setOutputBandList(), and ossimRefPtr< T >::valid().

Referenced by ossimChipperUtil::initializePsmChain(), ossimChipProcTool::loadImageFiles(), setToThreeBands(), and setToThreeBandsReverse().

 {
    if (!m_bandSelector)
    {
       addBandSelector();
    }
    m_bandSelector->setEnableFlag(true);
    m_bandSelector->setOutputBandList(bandList);
    if ( m_histogramRemapper.valid() )
    {
       m_histogramRemapper->initialize();
    }
 }

◆ setBrightnessContrastFlag()

void ossimSingleImageChain::setBrightnessContrastFlag ( bool flag )

Sets the brightness contrast flag.

Parameters

flag

Definition at line 942 of file ossimSingleImageChain.cpp.

References m_brightnessContrastFlag.

 {
    m_brightnessContrastFlag = flag;
 }

◆ setDefaultBandSelection()

void ossimSingleImageChain::setDefaultBandSelection ( )

Definition at line 1046 of file ossimSingleImageChain.cpp.

References addBandSelector(), m_bandSelector, ossimSource::setEnableFlag(), ossimBandSelector::setThreeBandRgb(), and ossimRefPtr< T >::valid().

 {
    if(!m_bandSelector)
    {
       addBandSelector();
    }
    m_bandSelector->setEnableFlag(true);
 
    if(m_bandSelector.valid())
    {
       m_bandSelector->setThreeBandRgb();
    }
 }

◆ setRemapToEightBitFlag()

void ossimSingleImageChain::setRemapToEightBitFlag ( bool flag )

Sets remap to eigth bit flag.

Parameters

flag

Definition at line 912 of file ossimSingleImageChain.cpp.

References m_remapToEightBitFlag.

 {
    m_remapToEightBitFlag = flag;
 }

◆ setSharpenFlag()

void ossimSingleImageChain::setSharpenFlag ( bool flag )

Sets the sharpenflag.

Parameters

flag

Definition at line 952 of file ossimSingleImageChain.cpp.

References m_sharpenFlag.

 {
    m_sharpenFlag = flag;
 }

◆ setThreeBandFlag()

void ossimSingleImageChain::setThreeBandFlag ( bool flag )

Sets the three band flag.

If set will for a three band output. So if one band it will duplicate so that rgb = b1,b1,b1. An attempt is made to derive rgb bands from the image handler.

Parameters

flag

Definition at line 922 of file ossimSingleImageChain.cpp.

References m_threeBandFlag.

 {
    m_threeBandFlag = flag;
 }

◆ setThreeBandReverseFlag()

void ossimSingleImageChain::setThreeBandReverseFlag ( bool flag )

Sets the three band reverse flag.

Parameters

flag

Definition at line 932 of file ossimSingleImageChain.cpp.

References m_threeBandReverseFlag.

 {
    m_threeBandReverseFlag = flag;
 }

◆ setToThreeBands()

void ossimSingleImageChain::setToThreeBands ( )

Utility method to force 3 band output.

Set band selector to a three band (rgb) output. If image has less than three bands it will set to rgb = b1,b1,b1. If image has three or more bands the band selector will be see to rgb = b1, b2, b3.

Note: This will not work unless the image handler is initialized.

Definition at line 962 of file ossimSingleImageChain.cpp.

References addBandSelector(), ossimImageSource::getNumberOfInputBands(), ossimBandSelector::getNumberOfOutputBands(), ossimImageHandler::getRgbBandList(), ossimHistogramRemapper::initialize(), m_bandSelector, m_handler, m_histogramRemapper, setBandSelection(), ossimSource::setEnableFlag(), ossimBandSelector::setThreeBandRgb(), and ossimRefPtr< T >::valid().

Referenced by createRenderedChain().

 {
    if (!m_bandSelector)
    {
       addBandSelector();
    }
 
    m_bandSelector->setEnableFlag(true);
    m_bandSelector->setThreeBandRgb();
 
    if ( m_histogramRemapper.valid() )
    {
       m_histogramRemapper->initialize();
    } 
 
 #if 0
    if ( m_handler.valid() )
    {
       // Only do if not three bands already so the band list order is not wiped out.
       if ( !m_bandSelector.valid() ||
            ( m_bandSelector.valid() &&
              ( m_bandSelector->getNumberOfOutputBands() != 3 ) ) )
       {
          std::vector<ossim_uint32> bandList(3);
 
          if ( m_handler->getRgbBandList( bandList ) == false )
          {
             const ossim_uint32 BANDS = m_handler->getNumberOfInputBands();
             if(BANDS >= 3)
             {
                bandList[0] = 0;
                bandList[1] = 1;
                bandList[2] = 2;
             }
             else
             {
                bandList[0] = 0;
                bandList[1] = 0;
                bandList[2] = 0;
             }
          }
          setBandSelection(bandList);
       }
    }
 #endif
 }

◆ setToThreeBandsReverse()

void ossimSingleImageChain::setToThreeBandsReverse ( )

Utility method to set to 3 bandsand reverse them.

This is mainly used by NITF and Lndsat color data where the bands are in bgr format and you want it in rgb combination. If image has less than three bands it will set to rgb = b1,b1,b1. If image has three or more bands the band selector will be see to rgb = b3, b2, b1.

Note: This will not work unless the image handler is initialized.

Definition at line 1009 of file ossimSingleImageChain.cpp.

References ossimImageSource::getNumberOfInputBands(), m_handler, setBandSelection(), and ossimRefPtr< T >::valid().

Referenced by createRenderedChain().

 {
    if ( m_handler.valid() )
    {
       std::vector<ossim_uint32> bandList(3);
       const ossim_uint32 BANDS = m_handler->getNumberOfInputBands();
       if(BANDS >= 3)
       {
          bandList[0] = 2;
          bandList[1] = 1;
          bandList[2] = 0;
       }
       else
       {
          bandList[0] = 0;
          bandList[1] = 0;
          bandList[2] = 0;
       }
       setBandSelection(bandList);
    }
 }

Member Data Documentation

◆ m_addChainCacheFlag

bool ossimSingleImageChain::m_addChainCacheFlag

private

Definition at line 579 of file ossimSingleImageChain.h.

Referenced by createRenderedChain(), getAddChainCacheFlag(), reset(), and setAddChainCacheFlag().

◆ m_addHistogramFlag

bool ossimSingleImageChain::m_addHistogramFlag

private

Definition at line 577 of file ossimSingleImageChain.h.

Referenced by createRenderedChain(), getAddHistogramFlag(), reset(), and setAddHistogramFlag().

◆ m_addNullPixelFlipFlag

bool ossimSingleImageChain::m_addNullPixelFlipFlag

private

control flags

Definition at line 576 of file ossimSingleImageChain.h.

Referenced by createRenderedChain(), getNullPixelFlipFlag(), reset(), and setAddNullPixelFlipFlag().

◆ m_addResamplerCacheFlag

bool ossimSingleImageChain::m_addResamplerCacheFlag

private

Definition at line 578 of file ossimSingleImageChain.h.

Referenced by createRenderedChain(), getAddResamplerCacheFlag(), reset(), and setAddResamplerCacheFlag().

◆ m_bandSelector

ossimRefPtr<ossimBandSelector> ossimSingleImageChain::m_bandSelector

private

Definition at line 565 of file ossimSingleImageChain.h.

Referenced by addBandSelector(), createRenderedChain(), getBandSelector(), reset(), setBandSelection(), setDefaultBandSelection(), setToThreeBands(), and ~ossimSingleImageChain().

◆ m_brightnessContrast

ossimRefPtr<ossimBrightnessContrastSource> ossimSingleImageChain::m_brightnessContrast

private

Definition at line 568 of file ossimSingleImageChain.h.

Referenced by addBrightnessContrast(), getBrightnessContrast(), reset(), and ~ossimSingleImageChain().

◆ m_brightnessContrastFlag

bool ossimSingleImageChain::m_brightnessContrastFlag

private

Definition at line 583 of file ossimSingleImageChain.h.

Referenced by createRenderedChain(), getBrightnessContrastFlag(), reset(), and setBrightnessContrastFlag().

◆ m_chainCache

ossimRefPtr<ossimCacheTileSource> ossimSingleImageChain::m_chainCache

private

Definition at line 574 of file ossimSingleImageChain.h.

Referenced by createRenderedChain(), getChainCache(), reset(), and ~ossimSingleImageChain().

◆ m_geoPolyCutter

ossimRefPtr<ossimGeoPolyCutter> ossimSingleImageChain::m_geoPolyCutter

private

Definition at line 573 of file ossimSingleImageChain.h.

Referenced by addGeoPolyCutter(), addGeoPolyCutterPolygon(), reset(), and ~ossimSingleImageChain().

◆ m_geoPolyCutterFlag

bool ossimSingleImageChain::m_geoPolyCutterFlag

private

Definition at line 585 of file ossimSingleImageChain.h.

Referenced by createRenderedChain(), and reset().

◆ m_handler

ossimRefPtr<ossimImageHandler> ossimSingleImageChain::m_handler

private

Pointers to links in chain.

Definition at line 564 of file ossimSingleImageChain.h.

Referenced by addHistogramRemapper(), addImageHandler(), close(), createRenderedChain(), getFilename(), getImageHandler(), getImageHandlerScalarType(), isOpen(), reset(), setToThreeBands(), setToThreeBandsReverse(), and ~ossimSingleImageChain().

◆ m_histogramRemapper

ossimRefPtr<ossimHistogramRemapper> ossimSingleImageChain::m_histogramRemapper

private

Definition at line 567 of file ossimSingleImageChain.h.

Referenced by addHistogramRemapper(), getHistogramRemapper(), reset(), setBandSelection(), setToThreeBands(), and ~ossimSingleImageChain().

◆ m_nullPixelFlip

ossimRefPtr<ossimNullPixelFlip> ossimSingleImageChain::m_nullPixelFlip

private

Definition at line 566 of file ossimSingleImageChain.h.

Referenced by addNullPixelFlip(), getNullPixelFlip(), reset(), and ~ossimSingleImageChain().

◆ m_remapToEightBitFlag

bool ossimSingleImageChain::m_remapToEightBitFlag

private

Definition at line 580 of file ossimSingleImageChain.h.

Referenced by createRenderedChain(), getRemapToEightBitFlag(), reset(), and setRemapToEightBitFlag().

◆ m_resampler

ossimRefPtr<ossimImageRenderer> ossimSingleImageChain::m_resampler

private

Definition at line 572 of file ossimSingleImageChain.h.

Referenced by addResampler(), getImageRenderer(), reset(), and ~ossimSingleImageChain().

◆ m_resamplerCache

ossimRefPtr<ossimCacheTileSource> ossimSingleImageChain::m_resamplerCache

private

Definition at line 571 of file ossimSingleImageChain.h.

Referenced by addScalarRemapper(), createRenderedChain(), getResamplerCache(), reset(), and ~ossimSingleImageChain().

◆ m_scalarRemapper

ossimRefPtr<ossimScalarRemapper> ossimSingleImageChain::m_scalarRemapper

private

Definition at line 570 of file ossimSingleImageChain.h.

Referenced by addScalarRemapper(), getScalarRemapper(), reset(), and ~ossimSingleImageChain().

◆ m_sharpen

ossimRefPtr<ossimImageSharpenFilter> ossimSingleImageChain::m_sharpen

private

Definition at line 569 of file ossimSingleImageChain.h.

Referenced by addSharpen(), getSharpenFilter(), reset(), and ~ossimSingleImageChain().

◆ m_sharpenFlag

bool ossimSingleImageChain::m_sharpenFlag

private

Definition at line 584 of file ossimSingleImageChain.h.

Referenced by createRenderedChain(), getSharpenFlag(), reset(), and setSharpenFlag().

◆ m_threeBandFlag

bool ossimSingleImageChain::m_threeBandFlag

private

Definition at line 581 of file ossimSingleImageChain.h.

Referenced by createRenderedChain(), getThreeBandFlag(), reset(), and setThreeBandFlag().

◆ m_threeBandReverseFlag

bool ossimSingleImageChain::m_threeBandReverseFlag

private

Definition at line 582 of file ossimSingleImageChain.h.

Referenced by createRenderedChain(), getThreeBandReverseFlag(), reset(), and setThreeBandReverseFlag().

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimSingleImageChain() [1/2]

◆ ossimSingleImageChain() [2/2]

◆ ~ossimSingleImageChain()

Member Function Documentation

◆ addBandSelector() [1/2]

◆ addBandSelector() [2/2]

◆ addBrightnessContrast()

◆ addCache()

◆ addGeoPolyCutter()

◆ addGeoPolyCutterPolygon() [1/2]

◆ addGeoPolyCutterPolygon() [2/2]

◆ addHistogramRemapper() [1/2]

◆ addHistogramRemapper() [2/2]

◆ addImageHandler() [1/2]

◆ addImageHandler() [2/2]

◆ addNullPixelFlip() [1/2]

◆ addNullPixelFlip() [2/2]

◆ addRenderer()

◆ addResampler()

◆ addScalarRemapper()

◆ addSharpen()

◆ close()

◆ createRenderedChain() [1/2]

◆ createRenderedChain() [2/2]

◆ getAddChainCacheFlag()

◆ getAddHistogramFlag()

◆ getAddResamplerCacheFlag()

◆ getBandSelector() [1/2]

◆ getBandSelector() [2/2]

◆ getBrightnessContrast() [1/2]

◆ getBrightnessContrast() [2/2]

◆ getBrightnessContrastFlag()

◆ getChainCache() [1/2]

◆ getChainCache() [2/2]

◆ getFilename()

◆ getHistogramRemapper() [1/2]

◆ getHistogramRemapper() [2/2]

◆ getImageHandler() [1/2]

◆ getImageHandler() [2/2]

◆ getImageHandlerScalarType()

◆ getImageRenderer() [1/2]

◆ getImageRenderer() [2/2]

◆ getNullPixelFlip()

◆ getNullPixelFlipFlag()

◆ getRemapToEightBitFlag()

◆ getResamplerCache() [1/2]

◆ getResamplerCache() [2/2]

◆ getScalarRemapper() [1/2]

◆ getScalarRemapper() [2/2]

◆ getSharpenFilter() [1/2]

◆ getSharpenFilter() [2/2]

◆ getSharpenFlag()

◆ getThreeBandFlag()

◆ getThreeBandReverseFlag()

◆ isOpen()

◆ open() [1/2]

◆ open() [2/2]

◆ openHistogram()

◆ reset()

◆ setAddChainCacheFlag()

◆ setAddHistogramFlag()

◆ setAddNullPixelFlipFlag()

◆ setAddResamplerCacheFlag()

◆ setBandSelection()

◆ setBrightnessContrastFlag()

◆ setDefaultBandSelection()

◆ setRemapToEightBitFlag()

◆ setSharpenFlag()

◆ setThreeBandFlag()

◆ setThreeBandReverseFlag()

◆ setToThreeBands()

◆ setToThreeBandsReverse()

Member Data Documentation

◆ m_addChainCacheFlag

◆ m_addHistogramFlag