SPATMOD::IMAGE::TARGET Class Reference

Base for pipeline target. More...

#include <spatmod/imagetarget.h>

Inheritance diagram for SPATMOD::IMAGE::TARGET:

[legend]

Public Member Functions
	TARGET (STAGE *pInputStage)
virtual	~TARGET ()
ERRVALUE	Initialize ()
ERRVALUE	Process (const SECTION_ITERATOR &iterator, bool ShowMsg=true)
ERRVALUE	Process (const SECTION &section, bool ShowMsg=true)
ERRVALUE	Process (bool ShowMsg=true)
ERRVALUE	PushBegin (const SECTION_ITERATOR &iterator)
ERRVALUE	PushEnd ()
ERRVALUE	PushSubSection (const SECTION &SubSection, const BUFFER &buffer)
ERRVALUE	SetupIterator (const SECTION &section, SECTION_ITERATOR &iterator) const
ERRVALUE	SetupIterator (SECTION_ITERATOR &iterator) const
void	SetZeroInvalidSamples (bool ZeroInvalidSamples)
Protected Member Functions
IMAGE::STAGE *	GetInputStage () const
void	SetStripSizeY (double StripSizeY)
virtual const PIXELTABLE *	v_GetPixelLookupTable () const
virtual bool	v_QueryCapability (CAPABILITY capability) const
Private Member Functions
virtual ERRVALUE	v_Initialize ()=0
virtual ERRVALUE	v_PushBegin (const SECTION_ITERATOR &iterator)=0
virtual ERRVALUE	v_PushEnd ()=0
virtual ERRVALUE	v_PushSubSection (const SECTION &SubSection, const BUFFER &buffer)=0
virtual ERRVALUE	v_SetTotalSection (const SECTION &TotalSection)

Detailed Description

Base for pipeline target.

Constructor & Destructor Documentation

SPATMOD::IMAGE::TARGET::TARGET ( STAGE * pInputStage )

Standard constructor.

Target does not take ownership of input stage.

Parameters:

pInputStage

Stage in pipeline to obtain image data from

virtual SPATMOD::IMAGE::TARGET::~TARGET ( ) [virtual]

Destructor.

Member Function Documentation

IMAGE::STAGE* SPATMOD::IMAGE::TARGET::GetInputStage ( ) const [inline, protected]

Get pointer to input stage.

ERRVALUE SPATMOD::IMAGE::TARGET::Initialize ( )

Initialize target.

Must be called after construction and before Process().

ERRVALUE SPATMOD::IMAGE::TARGET::Process	(	const SECTION_ITERATOR &	iterator,
		bool	ShowMsg = `true`
	)

Process using specified iterator.

Iterator does not need to be at beginning of section, this is useful for continuing partially complete jobs.

Parameters:

	iterator	Iterator
	ShowMsg	Show "processing" message at appropriate time

ERRVALUE SPATMOD::IMAGE::TARGET::Process	(	const SECTION &	section,
		bool	ShowMsg = `true`
	)

Process section of image.

Parameters:

	section	Section to process
	ShowMsg	Show "processing" message at appropriate time

ERRVALUE SPATMOD::IMAGE::TARGET::Process ( bool ShowMsg = true )

Process entire image.

Parameters:

ShowMsg

Show "processing" message at appropriate time

ERRVALUE SPATMOD::IMAGE::TARGET::PushBegin ( const SECTION_ITERATOR & iterator ) [inline]

Begin push into target.

Called by Process, not usually called directly.

ERRVALUE SPATMOD::IMAGE::TARGET::PushEnd ( ) [inline]

End push into target.

Called by Process, not usually called directly.

ERRVALUE SPATMOD::IMAGE::TARGET::PushSubSection	(	const SECTION &	SubSection,
		const BUFFER &	buffer
	)			`[inline]`

Push subsection to target.

Called by Process, not usually called directly.

void SPATMOD::IMAGE::TARGET::SetStripSizeY ( double StripSizeY ) [protected]

Set Y size of strip to process.

If not set will use default determined by tile size and processing order capabilities.

Parameters:

StripSizeY

Size of strip in rows

ERRVALUE SPATMOD::IMAGE::TARGET::SetupIterator	(	const SECTION &	section,
		SECTION_ITERATOR &	iterator
	)			const

Setup iterator for specified section.

If section extends outside image extent, only portion inside will be used.

Parameters:

	section	Section
	iterator	Iterator returned

ERRVALUE SPATMOD::IMAGE::TARGET::SetupIterator ( SECTION_ITERATOR & iterator ) const

Setup iterator for entire image.

Parameters:

iterator

Iterator returned

void SPATMOD::IMAGE::TARGET::SetZeroInvalidSamples ( bool ZeroInvalidSamples ) [inline]

Set whether to zero invalid samples before writing.

Default is to not do so.

virtual const PIXELTABLE* SPATMOD::IMAGE::TARGET::v_GetPixelLookupTable ( ) const [protected, virtual]

Get pixel lookup table.

Default implementation returns lookup table from input stage if any

Reimplemented from SPATMOD::IMAGE::BASE.

virtual ERRVALUE SPATMOD::IMAGE::TARGET::v_Initialize ( ) [private, pure virtual]

Initialize target.

Must do the following (in order), checking for error after each call. Validate all class-specific settings. Open any files if required.

Implemented in SPATMOD::IMAGE::TARGET_BIL, SPATMOD::IMAGE::TARGET_MGD, and SPATMOD::IMAGE::TARGET_TILESET.

virtual ERRVALUE SPATMOD::IMAGE::TARGET::v_PushBegin ( const SECTION_ITERATOR & iterator ) [private, pure virtual]

Begin push of a specific section.

Usually only called once at start of Process() operation.

Parameters:

iterator

SubSection iterator to be used

Implemented in SPATMOD::IMAGE::TARGET_BIL, and SPATMOD::IMAGE::TARGET_RVC_BASE.

virtual ERRVALUE SPATMOD::IMAGE::TARGET::v_PushEnd ( ) [private, pure virtual]

Finish pushing subsections.

Usually only called once at end of Process() operation. If any extra processing is done it should be done the first time this is called.

Implemented in SPATMOD::IMAGE::TARGET_BIL, and SPATMOD::IMAGE::TARGET_RVC_BASE.

virtual ERRVALUE SPATMOD::IMAGE::TARGET::v_PushSubSection	(	const SECTION &	SubSection,
		const BUFFER &	buffer
	)			`[private, pure virtual]`

Push data for specified subsection from buffer.

Parameters:

	SubSection	Current subsection to write
	buffer	Buffer to write from

Implemented in SPATMOD::IMAGE::TARGET_BIL, and SPATMOD::IMAGE::TARGET_FILE.

virtual bool SPATMOD::IMAGE::TARGET::v_QueryCapability ( CAPABILITY capability ) const [protected, virtual]

Query image for specified capability.

Default returns true for CAPABILITY_Push and false for all others.

Parameters:

capability

Capability to query

Reimplemented from SPATMOD::IMAGE::BASE.

virtual ERRVALUE SPATMOD::IMAGE::TARGET::v_SetTotalSection ( const SECTION & TotalSection ) [private, virtual]

Set total section of image to process for job.

Default implementation does nothing.

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

spatmod/imagetarget.h

SPATMOD::IMAGE::TARGET Class Reference

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation