Isis::ProcessByTile Class Reference
[High Level Cube I/O]

#include <ProcessByTile.h>

Public Types
enum	ProcessingDirection { LinesFirst, BandsFirst }
Public Member Functions
	ProcessByTile ()
	Constructs a ProcessByTile object.
	~ProcessByTile ()
	Destroys the ProcessByTile object.
void	SetTileSize (const int ns, const int nl)
	Sets the tile size.
void	StartProcess (void funct(Buffer &in))
	Starts the systematic processing of the input cube by moving an arbitrary shaped tile through the cube.
void	StartProcess (void funct(Buffer &in, Buffer &out))
	Starts the systematic processing of the input cube by moving an arbitrary shaped tile through the cube.
void	StartProcess (void funct(std::vector< Buffer * > &in, std::vector< Buffer * > &out))
	Starts the systematic processing of the input cube by moving an arbitrary shaped tile through the cube.
void	EndProcess ()
	End the processing sequence and cleans up by closing cubes, freeing memory, etc.
void	Finalize ()
	Cleans up by closing cubes and freeing memory.
template<typename Functor >
void	ProcessCubeInPlace (const Functor &funct, bool threaded=true)
template<typename Functor >
void	ProcessCube (const Functor &funct, bool threaded=true)
template<typename Functor >
void	ProcessCubes (const Functor &funct, bool threaded=true)
Cube *	SetInputCube (const QString &parameter, int requirements=0)
	Opens an input cube specified by the user and verifies requirements are met.
Cube *	SetInputCube (const QString &fname, const CubeAttributeInput &att, int requirements=0)
	Opens an input cube specified by the user, sets the attributes, and verifies requirements are met.
void	SetInputCube (Isis::Cube *inCube)
	Set the InputCube vector to an opened Cube which was dynamically allocated.
void	SetBrickSize (int ns, int nl, int nb)
	Sets the brick size.
void	SetInputBrickSize (int ns, int nl, int nb)
	Sets the size of all input bricks.
void	SetInputBrickSize (int ns, int nl, int nb, int cube)
	Sets the brick size of the specified cube.
void	SetOutputBrickSize (int ns, int nl, int nb)
	Sets the size of all output bricks.
void	SetOutputBrickSize (int ns, int nl, int nb, int cube)
	Sets the brick size of the specified output cube.
void	SetProcessingDirection (ProcessingDirection direction)
	Set the direction the data will be read, either all lines in a single band proceeding to the next band (LinesFirst), or every band for every line proceeding to the next line (BandsFirst).
ProcessingDirection	GetProcessingDirection ()
	Returns the direction the data will be read, either all lines in a single band proceeding to the next band (LinesFirst), or every band for every line proceeding to the next line (BandsFirst).
void	SetWrap (bool wrap)
	This wrapping option only applys when there are two or more input cubes.
bool	Wraps ()
	Returns true if the wrapping option is enabled.
void	StartProcess (void funct())
	In the base class, this method will invoked a user-specified function exactly one time.
Isis::Cube *	SetOutputCube (const QString &parameter)
	Allocates a user-specified output cube whose size matches the first input cube.
Isis::Cube *	SetOutputCube (const QString &parameter, const int nsamps, const int nlines, const int nbands=1)
	Allocates a user specified output cube whose size is specified by the programmer.
Isis::Cube *	SetOutputCube (const QString &fname, const Isis::CubeAttributeOutput &att, const int nsamps, const int nlines, const int nbands=1)
	Allocates a output cube whose name and size is specified by the programmer.
void	AddInputCube (Cube *cube, bool owned=true)
void	AddOutputCube (Cube *cube, bool owned=true)
void	ClearCubes ()
	Close owned cubes from the list and clear the list.
void	ClearInputCubes ()
	Close owned input cubes from the list and clear the list.
void	ClearOutputCubes ()
	Close owned output cubes from the list and clear the list.
void	PropagateLabels (const bool prop)
	This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes.
void	PropagateLabels (const QString &cube)
	This method allows the programmer to propagate labels from a specific secondary cube.
void	PropagateTables (const bool prop)
	This method allows the programmer to propagate input tables to the output cube (default is true).
void	PropagateTables (const QString &fromName)
	Propagate the tables from the cube with the given filename to the output cube.
void	PropagatePolygons (const bool prop)
	This method allows the programmer to propagate input blobs to the output cube (default is true).
void	PropagateHistory (const bool prop)
	This method allows the programmer to propagate history to the output cube (default is true).
void	PropagateOriginalLabel (const bool prop)
	This method allows the programmer to propagate original labels to the output cube (default is true).
Isis::Progress *	Progress ()
	This method returns a pointer to a Progress object.
QString	MissionData (const QString &mission, const QString &file, bool highestVersion=false)
	This method reads the mission specific data directory from the user preference file, makes sure that mission is available in the Isis installation, and the attaches the provided input file to the directory in order to create a full file specification.
void	WriteHistory (Cube &cube)
	Writes out the History blob to the cube.
void	CalculateStatistics ()
	Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method.
std::vector< Isis::Statistics * >	BandStatistics (const unsigned index)
	Get the vector of Statistics objects for each band separately of a specified input cube.
Isis::Statistics *	CubeStatistics (const unsigned index)
	Get the Statistics object for all bands of a specified input cube.
Protected Attributes
Isis::Progress *	p_progress
	Pointer to a Progress object.
bool	p_propagateLabels
	Flag indicating if labels are be propagated to output cubes.
bool	p_propagateTables
	Flag indicating if tables are be propagated to output cubes.
bool	p_propagatePolygons
	Flag indicating if blobs are be propagated to output cubes.
bool	p_propagateHistory
	Flag indicating if history is to be propagated to output cubes.
bool	p_propagateOriginalLabel
	Flag indicating if original lable is to be propagated to output cubes.
std::vector< std::vector < Isis::Statistics * > >	p_bandStats
	Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called.
std::vector< Isis::Statistics * >	p_cubeStats
	Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called.
std::vector< Isis::Cube * >	InputCubes
	A vector of pointers to opened Cube objects.
std::vector< Isis::Cube * >	OutputCubes
	A vector of pointers to allocated Cube objects.
QSet< Isis::Cube * > *	m_ownedCubes
	A list of cubes owned by this instant.

Detailed Description

Process cubes by tile.

This is the processing class used to move a tile through cube data. This class allows only one input cube and one output cube or one input cube. If the tile size does not evenly divide into the image the tile will be padded with Null pixels as it falls off the right and/or bottom edge of the image. The tile shape is only spatial-oriented with one band of data.

Author:: 2004-05-14 Jeff Anderson

Member Enumeration Documentation

enum Isis::ProcessByBrick::ProcessingDirection [inherited]

Enumerator:

LinesFirst
BandsFirst

Constructor & Destructor Documentation

Isis::ProcessByTile::ProcessByTile ( ) [inline]

Constructs a ProcessByTile object.

Isis::ProcessByTile::~ProcessByTile ( ) [inline]

Destroys the ProcessByTile object.

Member Function Documentation

void Isis::Process::AddInputCube	(	Cube *	cube,
		bool	owned = `true`
	)			`[inherited]`

References Isis::Process::InputCubes, and Isis::Process::m_ownedCubes.

Referenced by Isis::Process::SetInputCube().

void Isis::Process::AddOutputCube	(	Cube *	cube,
		bool	owned = `true`
	)			`[inherited]`

References Isis::Process::m_ownedCubes, and Isis::Process::OutputCubes.

Referenced by Isis::ProcessPolygons::AppendOutputCube(), Isis::ProcessMosaic::SetOutputCube(), Isis::ProcessMapMosaic::SetOutputCube(), and Isis::Process::SetOutputCube().

std::vector<Isis::Statistics *> Isis::Process::BandStatistics ( const unsigned index ) [inline, inherited]

Get the vector of Statistics objects for each band separately of a specified input cube.

Parameters:

index

The index of the input cube in InputCubes

Returns:: vector<Statistics*> A list of statistics ordered by band

References Isis::Process::p_bandStats.

void Isis::Process::CalculateStatistics ( ) [inherited]

Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method.

The newly calculated statistics are stored in two ways: as a vector where each entry is a single Statistics object for every band of a particular input cube, and as a vector where each entry is a vector of Statistics objects, for each band separately, of a particular input cube.

References Isis::Statistics::AddData(), Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), cube, Isis::Buffer::DoubleBuffer(), Isis::Process::InputCubes, line, Isis::Cube::lineCount(), Isis::Process::p_bandStats, Isis::Process::p_cubeStats, Isis::Cube::read(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), and Isis::toString().

void Isis::Process::ClearCubes ( ) [inherited]

Close owned cubes from the list and clear the list.

References Isis::Process::ClearInputCubes(), Isis::Process::ClearOutputCubes(), and Isis::Process::m_ownedCubes.

Referenced by Isis::Process::Finalize().

void Isis::Process::ClearInputCubes ( ) [inherited]

Close owned input cubes from the list and clear the list.

References Isis::Process::InputCubes, and Isis::Process::m_ownedCubes.

Referenced by Isis::Process::ClearCubes(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessGroundPolygons::SetOutputCube(), and Isis::ProcessMapMosaic::StartProcess().

void Isis::Process::ClearOutputCubes ( ) [inherited]

Close owned output cubes from the list and clear the list.

References Isis::Process::m_ownedCubes, and Isis::Process::OutputCubes.

Referenced by Isis::Process::ClearCubes().

Isis::Statistics* Isis::Process::CubeStatistics ( const unsigned index ) [inline, inherited]

Get the Statistics object for all bands of a specified input cube.

Parameters:

index

The index of the input cube in InputCubes

Returns:: Statistics* Collections of statistics gathered on all bands

References Isis::Process::p_cubeStats.

void Isis::ProcessByTile::EndProcess ( ) [virtual]

End the processing sequence and cleans up by closing cubes, freeing memory, etc.

Deprecated:: Please use Finalize()

Reimplemented from Isis::ProcessByBrick.

void Isis::ProcessByTile::Finalize ( ) [virtual]

Cleans up by closing cubes and freeing memory.

Reimplemented from Isis::ProcessByBrick.

ProcessByBrick::ProcessingDirection Isis::ProcessByBrick::GetProcessingDirection ( ) [inherited]

Returns the direction the data will be read, either all lines in a single band proceeding to the next band (LinesFirst), or every band for every line proceeding to the next line (BandsFirst).

The default is to process all lines of a band first.

Returns:: The selected enumerated processing direction

References Isis::ProcessByBrick::BandsFirst, and Isis::ProcessByBrick::LinesFirst.

QString Isis::Process::MissionData	(	const QString &	mission,
		const QString &	file,
		bool	highestVersion = `false`
	)			`[inherited]`

This method reads the mission specific data directory from the user preference file, makes sure that mission is available in the Isis installation, and the attaches the provided input file to the directory in order to create a full file specification.

Parameters:

	mission	Name of the mission data directory
	file	Name of the file to attach to the end of the directory
	highestVersion	If set to true the method will return the highest version number of the given file. Therefore, file must contain question marks such as "file???.dat". See the FileName class for more information on versioned files. Defaults to false.

References _FILEINFO_, Isis::FileName::expanded(), Isis::FileName::fileExists(), Isis::PvlObject::FindGroup(), Isis::FileName::highestVersion(), Isis::IException::Io, and Isis::Preference::Preferences().

template<typename Functor >

void Isis::ProcessByTile::ProcessCube	(	const Functor &	funct,
		bool	threaded = `true`
	)			`[inline]`

See also:: ProcessByBrick::ProcessCube()

Parameters:

	funct
	threaded

Reimplemented from Isis::ProcessByBrick.

template<typename Functor >

void Isis::ProcessByTile::ProcessCubeInPlace	(	const Functor &	funct,
		bool	threaded = `true`
	)			`[inline]`

See also:: ProcessByBrick::ProcessCubeInPlace()

Parameters:

	funct
	threaded

Reimplemented from Isis::ProcessByBrick.

template<typename Functor >

void Isis::ProcessByTile::ProcessCubes	(	const Functor &	funct,
		bool	threaded = `true`
	)			`[inline]`

See also:: ProcessByBrick::ProcessCubes()

Parameters:

	funct
	threaded

Reimplemented from Isis::ProcessByBrick.

Isis::Progress* Isis::Process::Progress ( ) [inline, inherited]

This method returns a pointer to a Progress object.

Returns:: Progress*

References Isis::Process::p_progress.

Referenced by Isis::Equalization::applyCorrection(), Isis::HiEqualization::calculateStatistics(), Isis::Equalization::calculateStatistics(), Isis::Process::Process(), Isis::ProcessMapMosaic::SetOutputCube(), and Isis::ProcessMapMosaic::StartProcess().

void Isis::Process::PropagateHistory ( const bool prop ) [inherited]

This method allows the programmer to propagate history to the output cube (default is true).

Parameters:

prop

Flag indicating if history is to be propagated to output cubes.

References Isis::Process::p_propagateHistory.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

void Isis::Process::PropagateLabels ( const QString & cube ) [inherited]

This method allows the programmer to propagate labels from a specific secondary cube.

Parameters:

cube

IString containing the name of the cube containing the labels to propagate.

References Isis::PvlObject::AddGroup(), Isis::PvlObject::AddObject(), Isis::PvlObject::FindObject(), g, Isis::PvlObject::Group(), Isis::PvlObject::Groups(), Isis::PvlObject::HasObject(), and Isis::Process::OutputCubes.

void Isis::Process::PropagateLabels ( const bool prop ) [inherited]

This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes.

By default, propagation occurs automatically in the Process class when a call to either of the SetOutputCube methods is invoked. If the program * requires no propagation then utilize this method. This method can be invoked between successive calls of SetOutputCube so that some cube will have labels propagated while others will not.

Parameters:

prop

Flag indicating if labels are be propagated to output cubes.

References Isis::Process::p_propagateLabels.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

void Isis::Process::PropagateOriginalLabel ( const bool prop ) [inherited]

This method allows the programmer to propagate original labels to the output cube (default is true).

Parameters:

prop

Flag indicating if original labels is to be propagated to output cubes.

References Isis::Process::p_propagateOriginalLabel.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

void Isis::Process::PropagatePolygons ( const bool prop ) [inherited]

This method allows the programmer to propagate input blobs to the output cube (default is true).

Parameters:

prop

Flag indicating if input blobs are to be propagated to output cubes.

References Isis::Process::p_propagatePolygons.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

void Isis::Process::PropagateTables ( const QString & fromName ) [inherited]

Propagate the tables from the cube with the given filename to the output cube.

This is done at the time this method is called, not during normal processing.

References Isis::Cube::label(), Isis::PvlObject::Object(), Isis::PvlObject::Objects(), Isis::Cube::open(), Isis::Process::OutputCubes, and Isis::Cube::read().

void Isis::Process::PropagateTables ( const bool prop ) [inherited]

This method allows the programmer to propagate input tables to the output cube (default is true).

Parameters:

prop

Flag indicating if input tables are to be propagated to output cubes.

References Isis::Process::p_propagateTables.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

void Isis::ProcessByBrick::SetBrickSize	(	int	ns,
		int	nl,
		int	nb
	)			`[inherited]`

Sets the brick size.

Parameters:

	ns	Number of samples
	nl	Number of lines
	nb	Number of bands

References Isis::Process::InputCubes, and Isis::Process::OutputCubes.

Referenced by Isis::ProcessByLine::VerifyCubeInPlace().

void Isis::ProcessByBrick::SetInputBrickSize	(	int	ns,
		int	nl,
		int	nb,
		int	cube
	)			`[inherited]`

Sets the brick size of the specified cube.

Parameters:

	ns	Number of samples
	nl	Number of lines
	nb	Number of bands
	cube	The index of the cube

References _FILEINFO_, Isis::Process::InputCubes, and Isis::IException::Programmer.

void Isis::ProcessByBrick::SetInputBrickSize	(	int	ns,
		int	nl,
		int	nb
	)			`[inherited]`

Sets the size of all input bricks.

Parameters:

	ns	Number of samples
	nl	Number of lines
	nb	Number of bands

References Isis::Process::InputCubes.

Referenced by Isis::ProcessByLine::VerifyCubeIO(), and Isis::ProcessByLine::VerifyCubeIOList().

void Isis::Process::SetInputCube ( Isis::Cube * inCube ) [inherited]

Set the InputCube vector to an opened Cube which was dynamically allocated.

This is used if there already exists a valid opened cube

Author:: Sharmila Prasad (5/7/2011)

Parameters:

inCube

- Pointer to input Cube

Reimplemented in Isis::ProcessByLine.

References _FILEINFO_, Isis::Process::AddInputCube(), Isis::Cube::isOpen(), and Isis::IException::User.

Cube * Isis::ProcessByBrick::SetInputCube	(	const QString &	file,
		const CubeAttributeInput &	att,
		int	requirements = `0`
	)			`[inherited]`

Opens an input cube specified by the user, sets the attributes, and verifies requirements are met.

This method is overloaded and adds the requirements of ISIS::SpatialMatch which requires all input cubes to have the same dimensions or be exactly be exactly one. For more information see Process::SetInputCube

Returns:: Cube*

Parameters:

	file	User parameter to obtain file to open. Typically, the value is "FROM". For example, the user can specify on the command line FROM=myfile.cub and this method will attempt to open the cube "myfile.cub" if the parameter was set to "FROM".
	att	See Process::SetInputCube for more information.
	requirements	See Process::SetInputCube for more information. Defaults to 0

Exceptions:

iException::Message

Reimplemented from Isis::Process.

References Isis::AllMatchOrOne, and Isis::ProcessByBrick::SetInputCube().

Cube * Isis::ProcessByBrick::SetInputCube	(	const QString &	parameter,
		int	requirements = `0`
	)			`[inherited]`

Opens an input cube specified by the user and verifies requirements are met.

This method is overloaded and adds the requirements of ISIS::SpatialMatch which requires all input cubes to have the same dimensions or be exactly be exactly one. For more information see Process::SetInputCube

Returns:: Cube*

Parameters:

	parameter	User parameter to obtain file to open. Typically, the value is "FROM". For example, the user can specify on the command line FROM=myfile.cub and this method will attempt to open the cube "myfile.cub" if the parameter was set to "FROM".
	requirements	See Process::SetInputCube for more information. Defaults to 0

Exceptions:

iException::Message

Reimplemented from Isis::Process.

Reimplemented in Isis::ProcessByLine, Isis::ProcessBySample, and Isis::ProcessBySpectra.

References Isis::AllMatchOrOne.

Referenced by Isis::ProcessByBrick::SetInputCube().

void Isis::ProcessByBrick::SetOutputBrickSize	(	int	ns,
		int	nl,
		int	nb,
		int	cube
	)			`[inherited]`

Sets the brick size of the specified output cube.

Parameters:

	ns	Number of samples
	nl	Number of lines
	nb	Number of bands
	cube	The index of the cube

References _FILEINFO_, Isis::Process::OutputCubes, and Isis::IException::Programmer.

void Isis::ProcessByBrick::SetOutputBrickSize	(	int	ns,
		int	nl,
		int	nb
	)			`[inherited]`

Sets the size of all output bricks.

Parameters:

	ns	Number of samples
	nl	Number of lines
	nb	Number of bands

References Isis::Process::OutputCubes.

Referenced by Isis::ProcessByLine::VerifyCubeIO(), and Isis::ProcessByLine::VerifyCubeIOList().

Isis::Cube * Isis::Process::SetOutputCube	(	const QString &	fname,
		const Isis::CubeAttributeOutput &	att,
		const int	ns,
		const int	nl,
		const int	nb = `1`
	)			`[inherited]`

Allocates a output cube whose name and size is specified by the programmer.

Returns:: Cube*

Parameters:

	fname	Name of the output cube to allocate
	att	The cube attributes to use when creating the output cube.
	ns	Number of samples to allocate
	nl	Number of lines to allocate
	nb	Number of bands to allocate

Exceptions:

Isis::iException::Message

Isis::Cube * Isis::Process::SetOutputCube	(	const QString &	parameter,
		const int	ns,
		const int	nl,
		const int	nb = `1`
	)			`[inherited]`

Allocates a user specified output cube whose size is specified by the programmer.

Returns:: Cube*

Parameters:

	parameter	User specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType.
	ns	Number of samples to allocate
	nl	Number of lines to allocate
	nb	Number of bands to allocate

Exceptions:

Isis::iException::Message

Reimplemented in Isis::ProcessPolygons.

References _FILEINFO_, IsisAml::GetFileName(), IsisAml::GetOutputAttribute(), Isis::Application::GetUserInterface(), Isis::IException::Programmer, and Isis::Process::SetOutputCube().

Isis::Cube * Isis::Process::SetOutputCube ( const QString & parameter ) [inherited]

Allocates a user-specified output cube whose size matches the first input cube.

Returns:: Cube*

Parameters:

parameter

User specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType.

Exceptions:

Isis::iException::Message

Reimplemented in Isis::ProcessImport, Isis::ProcessMapMosaic, and Isis::ProcessMosaic.

References _FILEINFO_, Isis::Process::InputCubes, nb, nl, ns, and Isis::IException::Programmer.

Referenced by Isis::Equalization::applyCorrection(), Isis::ProcessMapMosaic::SetOutputCube(), and Isis::Process::SetOutputCube().

void Isis::ProcessByBrick::SetProcessingDirection ( ProcessingDirection direction ) [inherited]

Set the direction the data will be read, either all lines in a single band proceeding to the next band (LinesFirst), or every band for every line proceeding to the next line (BandsFirst).

The default is to process all lines of a band first.

Parameters:

direction

The new enumerated processing direction

References Isis::ProcessByBrick::BandsFirst.

Referenced by Isis::ImageImporter::import().

void Isis::ProcessByTile::SetTileSize	(	const int	ns,
		const int	nl
	)

Sets the tile size.

Parameters:

	ns	Number of samples
	nl	Number of lines

void Isis::ProcessByBrick::SetWrap ( bool wrap ) [inherited]

This wrapping option only applys when there are two or more input cubes.

If wrapping is enabled and the second cube is smaller than the first The brick will be wrapped back to the beginning of the second cube once brick movement reaches the end of the cube. For example, if the brick shape was a single line and the second cube only had one line then function passed into StartProcess will receive the same contents in the 2nd input buffer every time.

Parameters:

wrap

Specifies whether or not to wrap

Referenced by Isis::ProcessByLine::ProcessByLine(), and Isis::ProcessBySample::ProcessBySample().

void Isis::Process::StartProcess ( void funct() ) [inline, inherited]

In the base class, this method will invoked a user-specified function exactly one time.

In derived classes such as ProcessByLine, the StartProcess will invoke a user-specified function for every line in a cube.

Parameters:

funct()

Name of your processing function

void Isis::ProcessByTile::StartProcess ( void functstd::vector< Buffer * > &in,std::vector< Buffer * > &out )

Starts the systematic processing of the input cube by moving an arbitrary shaped tile through the cube.

This method allows multiple input and output cubes.

Deprecated:: Please use ProcessCubes()

Parameters:

funct

(vector<Buffer *> &in, vector<Buffer *> &out) Receive an nxm tile in the input buffer. If n=1 and m=lines this will process by columns. Likewise if n=samples and m=1 this will process by lines.

Exceptions:

iException::Programmer

Reimplemented from Isis::ProcessByBrick.

References StartProcess().

void Isis::ProcessByTile::StartProcess ( void functBuffer &in, Buffer &out )

Starts the systematic processing of the input cube by moving an arbitrary shaped tile through the cube.

This method requires that exactly one input cube and one output cube be loaded using the SetInputCube and SetOutputCube methods.

Deprecated:: Please use ProcessCube()

Parameters:

funct

(Buffer &in, Buffer &out) Receive an nxm tile in the input buffer and output the an nxm tile. If n=1 and m=lines this will process by columns. Likewise if n=samples and m=1 this will process by lines.

Exceptions:

iException::Programmer

Reimplemented from Isis::ProcessByBrick.

References StartProcess().

void Isis::ProcessByTile::StartProcess ( void functBuffer &in )

Starts the systematic processing of the input cube by moving an arbitrary shaped tile through the cube.

This method requires that exactly one input cube be loaded. No output cubes are produced.

Deprecated:: Please use ProcessCubeInPlace()

Parameters:

funct

(Buffer &in) Receive an nxm tile in the input buffer. If n=1 and m=lines this will process by columns. Likewise if n=samples and m=1 this will process by lines.

Exceptions:

iException::Programmer

Reimplemented from Isis::ProcessByBrick.

Referenced by StartProcess().

bool Isis::ProcessByBrick::Wraps ( ) [inherited]

Returns true if the wrapping option is enabled.

See also:: SetWrap()

Returns:: The value of the wrapping option

Referenced by Isis::ProcessByBrick::ProcessCubes(), and Isis::ProcessByBrick::StartProcess().

void Isis::Process::WriteHistory ( Cube & cube ) [inherited]

Writes out the History blob to the cube.

References Isis::History::AddEntry(), Isis::iApp, Isis::Process::InputCubes, Isis::PvlContainer::IsNamed(), Isis::PvlObject::Object(), Isis::PvlObject::Objects(), Isis::Process::p_propagateHistory, and Isis::Cube::write().

Referenced by Isis::Process::SetOutputCube(), and Isis::ProcessMapMosaic::StartProcess().

Member Data Documentation

std::vector<Isis::Cube *> Isis::Process::InputCubes [protected, inherited]

A vector of pointers to opened Cube objects.

The pointers are established in the SetInputCube/SetInputWorkCube methods.

Referenced by Isis::Process::AddInputCube(), Isis::Process::CalculateStatistics(), Isis::Process::ClearInputCubes(), Isis::ProcessExport::CreateWorldFile(), Isis::ProcessExport::GetBuffersBIL(), Isis::ProcessExport::GetBuffersBIP(), Isis::ProcessExport::GetBuffersBSQ(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessExport::ProcessCubes(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessRubberSheet::processPatchTransform(), Isis::ProcessByBrick::SetBrickSize(), Isis::ProcessByBrick::SetInputBrickSize(), Isis::ProcessMosaic::SetInputCube(), Isis::Process::SetInputCube(), Isis::ProcessExport::SetInputRange(), Isis::ProcessMosaic::SetMosaicOrigin(), Isis::ProcessGroundPolygons::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::ProcessRubberSheet::StartProcess(), Isis::ProcessMosaic::StartProcess(), Isis::ProcessMapMosaic::StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBoxcar::StartProcess(), Isis::ProcessByLine::VerifyCubeInPlace(), Isis::ProcessByLine::VerifyCubeIO(), Isis::ProcessByLine::VerifyCubeIOList(), and Isis::Process::WriteHistory().

QSet<Isis::Cube *>* Isis::Process::m_ownedCubes [protected, inherited]

A list of cubes owned by this instant.

These cubes will be deleted on finalization. Process will not take ownership of cubes allocated outside of Process. It is the caller's responsibility to delete such cubes.

Referenced by Isis::Process::AddInputCube(), Isis::Process::AddOutputCube(), Isis::Process::ClearCubes(), Isis::Process::ClearInputCubes(), Isis::Process::ClearOutputCubes(), Isis::Process::Process(), and Isis::Process::~Process().