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

#include <ProcessBySpectra.h>

Public Member Functions
	ProcessBySpectra (const int type=PerPixel)
	Constructs ProcessBySpectra object using specified spectra type.
Isis::Cube *	SetInputCube (const std::string &parameter, const int requirements=0)
	Opens an input cube specified by the user and verifies requirements are met.
Isis::Cube *	SetInputCube (const std::string &file, Isis::CubeAttributeInput &att, const int requirements=0)
	Opens an input cube specified by the user with cube attributes and requirements.
void	SetType (const int type)
	Sets the spectra type to one of the following:.
int	Type ()
	Returns the spectra type:.
void	StartProcess (void funct(Isis::Buffer &in))
	This method invokes the process by spectra operation over a single input or output cube.
void	StartProcess (void funct(Isis::Buffer &in, Isis::Buffer &out))
	Starts the systematic processing of the input cube by moving an arbitrary shaped brick through the cube.
void	StartProcess (void funct(std::vector< Isis::Buffer * > &in, std::vector< Isis::Buffer * > &out))
	This method invokes the process by spectra operation over multiple input and output cubes.
Isis::Cube *	SetInputCube (const std::string &fname, const Isis::CubeAttributeInput &att, const 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 (const int ns, const int nl, const int nb)
	Sets the brick size.
void	SetInputBrickSize (const int ns, const int nl, const int nb)
	Sets the size of all input bricks.
void	SetInputBrickSize (const int ns, const int nl, const int nb, const int tile)
	Sets the brick size of the specified cube.
void	SetOutputBrickSize (const int ns, const int nl, const int nb)
	Sets the size of all output bricks.
void	SetOutputBrickSize (const int ns, const int nl, const int nb, const int tile)
	Sets the brick size of the specified output cube.
void	SetWrap (bool wrap)
	This wrapping option only applys when there are two or more input cubes.
bool	Wraps ()
	Return the wrap option.
void	StartProcess (void funct())
	In the base class, this method will invoked a user-specified function exactly one time.
void	EndProcess ()
	End the processing sequence and cleans up by closing cubes, freeing memory, etc.
bool	ProcessInPlace (Isis::Cube cube, Isis::Brick bricks)
	Prepare and check to run "function" parameter for StartProcess(void funct(Isis::Buffer &in)) and StartProcessInPlace(Functor funct).
template<typename Functor >
void	StartProcessInPlace (Functor &funct)
	Same functionality as StartProcess(void funct(Isis::Buffer &inout)) using Functors.
int	ProcessIO (Isis::Brick ibrick, Isis::Brick obrick)
	Prepare and check to run "function" parameter for StartProcess(void funct(Isis::Buffer &in, Isis::Buffer &out)) and StartProcessIO(Functor funct).
template<typename FunctorIO >
void	StartProcessIO (FunctorIO &funct)
	Same functionality as StartProcess(void funct(Isis::Buffer &in, Isis::Buffer &out)) using Functors.The Functor operator(), takes the parameter (Isis::Buffer &, Isis::Buffer &).
int	ProcessIOList (std::vector< Isis::Buffer * > &ibufs, std::vector< Isis::Buffer * > &obufs, std::vector< Isis::Brick * > &imgrs, std::vector< Isis::Brick * > &omgrs)
	Prepare and check to run "function" parameter for StartProcess(void funct(vector<Isis::Buffer > &in, vector<Isis::Buffer > &out)), StartProcessIOList(Functor funct).
template<typename FunctorIOList >
void	StartProcessIOList (FunctorIOList &funct)
	Same functionality as StartProcess(void funct(vector<Isis::Buffer > &in, vector<Isis::Buffer > &out)) using Functors.
void	ClearInputCubes ()
	This method clears the input cube list.
Isis::Cube *	SetOutputCube (const std::string &parameter)
	Allocates a user-specified output cube whose size matches the first input cube.
Isis::Cube *	SetOutputCube (const std::string &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 std::string &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	ClearOutputCubes ()
	Close 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 std::string &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	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.
std::string	MissionData (const std::string &mission, const std::string &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.
Static Public Attributes
static const int	PerPixel = 0
	PerPixel spectra type (equal to 0).
static const int	ByLine = 1
	ByLine spectra type (equal to 1).
static const int	BySample = 2
	BySample spectra type (equal to 2).
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.

Detailed Description

Process cubes by spectra.

This class allows a programmer to develop a program which process input and output cubes sequentially by spectra. That is, receive the input data for spectra one, manipulate the data, and pass back the data for output spectra one. Then proceed to the spectra two and so one. This class is derived from the ProcessByBrick class which give many functions for setting up input and output cubes.

Author:: 2006-03-27 Jacob Danton

Constructor & Destructor Documentation

Isis::ProcessBySpectra::ProcessBySpectra ( const int type = PerPixel ) [inline]

Constructs ProcessBySpectra object using specified spectra type.

0 = PerPixel
1 = ByLine
2 = BySample

Parameters:

type

Spectra type to be given the object. Defaults to PerPixel (0)

References SetType().

Member Function Documentation

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::Progress::CheckStatus(), cube, Isis::Cube::getBandCount(), Isis::Cube::getLineCount(), Isis::Process::InputCubes, line, Isis::Process::p_bandStats, Isis::Process::p_cubeStats, Isis::Cube::read(), Isis::Progress::SetMaximumSteps(), and Isis::Progress::SetText().

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

This method clears the input cube list.

It is most commonly used in applications which need to generate an output cube without an input cube, however, propogation of input characteristics are known. For example, creating the initial cube for a mosaic.

References Isis::Process::InputCubes.

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

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

Close output cubes from the list and clear the list.

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

References Isis::Process::OutputCubes.

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

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::ProcessByBrick::EndProcess ( ) [virtual, inherited]

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

Reimplemented from Isis::Process.

Reimplemented in Isis::ProcessByTile.

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

string Isis::Process::MissionData	(	const std::string &	mission,
		const std::string &	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::Exists(), Isis::Filename::Expanded(), Isis::PvlObject::FindGroup(), Isis::Filename::HighestVersion(), Isis::iException::Io, Isis::iException::Message(), and Isis::Preference::Preferences().

bool Isis::ProcessByBrick::ProcessInPlace	(	Isis::Cube **	cube,
		Isis::Brick **	bricks
	)			`[inherited]`

Prepare and check to run "function" parameter for StartProcess(void funct(Isis::Buffer &in)) and StartProcessInPlace(Functor funct).

Parameters:

	cube	- Pointer to input or output cube depending if the input cube is available
	bricks	- Pointer to first cube brick to be processed

Returns:: bool - If input cube is available(true/false)

History:: 2011-04-22 Sharmila Prasad - Ported from StartProcess (void funct(Isis::Buffer &in))

References _FILEINFO_, Isis::Process::InputCubes, Isis::iException::Message(), Isis::Process::OutputCubes, Isis::iException::Programmer, Isis::ProcessByBrick::SetInputBrickSize(), and Isis::ProcessByBrick::SetOutputBrickSize().

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

int Isis::ProcessByBrick::ProcessIO	(	Isis::Brick **	ibrick,
		Isis::Brick **	obrick
	)			`[inherited]`

Prepare and check to run "function" parameter for StartProcess(void funct(Isis::Buffer &in, Isis::Buffer &out)) and StartProcessIO(Functor funct).

Parameters:

	ibrick	- Pointer to first input cube brick
	obrick	- Pointer to first output cube brick

Returns:: int

References _FILEINFO_, Isis::Process::InputCubes, Isis::iException::Message(), Isis::Process::OutputCubes, Isis::iException::Programmer, Isis::ProcessByBrick::SetInputBrickSize(), Isis::ProcessByBrick::SetOutputBrickSize(), and Isis::ProcessByBrick::Wraps().

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

int Isis::ProcessByBrick::ProcessIOList	(	std::vector< Isis::Buffer * > &	ibufs,
		std::vector< Isis::Buffer * > &	obufs,
		std::vector< Isis::Brick * > &	imgrs,
		std::vector< Isis::Brick * > &	omgrs
	)			`[inherited]`

Prepare and check to run "function" parameter for StartProcess(void funct(vector<Isis::Buffer *> &in, vector<Isis::Buffer *> &out)), StartProcessIOList(Functor funct).

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

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::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 std::string & 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 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	(	const int	ns,
		const int	nl,
		const 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::ProcessByTile::StartProcess(), StartProcess(), Isis::ProcessBySample::StartProcess(), and Isis::ProcessByLine::VerifyCubeInPlace().

void Isis::ProcessByBrick::SetInputBrickSize	(	const int	ns,
		const int	nl,
		const int	nb,
		const 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, Isis::iException::Message(), and Isis::iException::Programmer.

void Isis::ProcessByBrick::SetInputBrickSize	(	const int	ns,
		const int	nl,
		const 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::ProcessByBrick::ProcessInPlace(), Isis::ProcessByBrick::ProcessIO(), StartProcess(), Isis::ProcessBySample::StartProcess(), 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

Note: This requires that the cube was dynamically allocated because ClearInputCubes deletes the cube.

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

Parameters:

inCube

- Pointer to input Cube

Reimplemented in Isis::ProcessByLine.

References _FILEINFO_, Isis::Process::InputCubes, Isis::Cube::isOpen(), Isis::iException::Message(), and Isis::iException::User.

Isis::Cube * Isis::ProcessByBrick::SetInputCube	(	const std::string &	file,
		const Isis::CubeAttributeInput &	att,
		const 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:

Isis::iException::Message

Reimplemented from Isis::Process.

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

Isis::Cube * Isis::ProcessBySpectra::SetInputCube	(	const std::string &	file,
		Isis::CubeAttributeInput &	att,
		const int	requirements = `0`
	)

Opens an input cube specified by the user with cube attributes and requirements.

For more information see Process::SetInputCube

Returns:: Cube*

Parameters:

	file	Name of cube file
	att	Cube attributes
	requirements	See Process::SetInputCube for more information. Defaults to 0

References SetInputCube(), and Isis::SpatialMatch.

Isis::Cube * Isis::ProcessBySpectra::SetInputCube	(	const std::string &	parameter,
		const int	requirements = `0`
	)

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

This method is overloaded and adds the requirements of ic_base::SpatialMatch which requires all input cubes to have the same number of samples and lines. It also added the requirement ic_base::BandMatchOrOne which forces 2nd, 3rd, 4th, etc input cubes to match the number of bands in the 1st input cube or to have exactly one band. 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:

Isis::iException::Message

Reimplemented from Isis::ProcessByBrick.

References Isis::SpatialMatch.

Referenced by SetInputCube().

void Isis::ProcessByBrick::SetOutputBrickSize	(	const int	ns,
		const int	nl,
		const int	nb,
		const 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::iException::Message(), Isis::Process::OutputCubes, and Isis::iException::Programmer.

void Isis::ProcessByBrick::SetOutputBrickSize	(	const int	ns,
		const int	nl,
		const 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::ProcessByBrick::ProcessInPlace(), Isis::ProcessByBrick::ProcessIO(), StartProcess(), Isis::ProcessBySample::StartProcess(), Isis::ProcessByLine::VerifyCubeIO(), and Isis::ProcessByLine::VerifyCubeIOList().

Isis::Cube * Isis::Process::SetOutputCube	(	const std::string &	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 std::string &	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_, Isis::iException::Message(), Isis::iException::Programmer, and Isis::Process::SetOutputCube().

Isis::Cube * Isis::Process::SetOutputCube ( const std::string & 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, Isis::iException::Message(), nb, nl, ns, and Isis::iException::Programmer.

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

void Isis::ProcessBySpectra::SetType ( const int type )

Sets the spectra type to one of the following:.

0 = PerPixel
1 = ByLine
2 = BySample

Parameters:

type

Integer value representing the spectra type.

References _FILEINFO_, ByLine, BySample, Isis::iException::Message(), PerPixel, and Isis::iException::Programmer.

Referenced by ProcessBySpectra().

void Isis::ProcessByBrick::SetWrap ( bool wrap ) [inline, 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::ProcessBySpectra::StartProcess ( void functstd::vector< Isis::Buffer * > &in,std::vector< Isis::Buffer * > &out )

This method invokes the process by spectra operation over multiple input and output cubes.

Typically, this method is used when two input cubes are required for operations like ratios, differences, masking, etc.

Parameters:

funct

(vector<Isis::Buffer *> &in, vector<Isis::Buffer *> &out) Name of your processing function

Exceptions:

Isis::iException::Message

Reimplemented from Isis::ProcessByBrick.

References ByLine, Isis::Process::InputCubes, Isis::Process::OutputCubes, PerPixel, Isis::ProcessByBrick::SetInputBrickSize(), Isis::ProcessByBrick::SetOutputBrickSize(), StartProcess(), and Type().

void Isis::ProcessBySpectra::StartProcess ( void functIsis::Buffer &in, Isis::Buffer &out )

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

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

Parameters:

funct

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

Exceptions:

Isis::iException::Programmer

Reimplemented from Isis::ProcessByBrick.

void Isis::ProcessBySpectra::StartProcess ( void functIsis::Buffer &in )

This method invokes the process by spectra operation over a single input or output cube.

It will be an input cube if the method SetInputCube was invoked exactly one time before calling StartProcess. It will be an output cube if the SetOutputCube method was invoked exactly one time. Typically this method can be used to obtain statistics, histograms, or other information from an input cube.

Parameters:

funct

(Isis::Buffer &b) Name of your processing function

Exceptions:

Isis::iException::Message

Reimplemented from Isis::ProcessByBrick.

References _FILEINFO_, ByLine, Isis::Process::InputCubes, Isis::iException::Message(), nb, nl, ns, Isis::Process::OutputCubes, PerPixel, Isis::iException::Programmer, Isis::ProcessByBrick::SetBrickSize(), and Type().

Referenced by StartProcess().

template<typename Functor >

void Isis::ProcessByBrick::StartProcessInPlace ( Functor & funct ) [inline, inherited]

Same functionality as StartProcess(void funct(Isis::Buffer &inout)) using Functors.

The Functor operator(), takes the parameter (Isis::Buffer &)

Author:: 2011-04-22 Sharmila Prasad

Parameters:

funct

- Functor with overloaded operator()(Isis::Buffer &)

Reimplemented in Isis::ProcessByLine.

References Isis::Progress::CheckStatus(), cube, Isis::Cube::isReadWrite(), Isis::Process::p_progress, Isis::ProcessByBrick::ProcessInPlace(), Isis::Cube::read(), Isis::Progress::SetMaximumSteps(), and Isis::Cube::write().

template<typename FunctorIO >

void Isis::ProcessByBrick::StartProcessIO ( FunctorIO & funct ) [inline, inherited]

Same functionality as StartProcess(void funct(Isis::Buffer &in, Isis::Buffer &out)) using Functors.The Functor operator(), takes the parameter (Isis::Buffer &, Isis::Buffer &).