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

Process cubes by spectra. More...

#include <ProcessBySpectra.h>

Inheritance diagram for Isis::ProcessBySpectra:

[legend]

Collaboration diagram for Isis::ProcessBySpectra:

[legend]

List of all members.

Public Types
enum	ProcessingDirection { LinesFirst, BandsFirst }
Public Member Functions
	ProcessBySpectra (const int type=PerPixel)
	Constructs ProcessBySpectra object using specified spectra type.
Isis::Cube *	SetInputCube (const QString &parameter, const int requirements=0)
	Opens an input cube specified by the user and verifies requirements are met.
Isis::Cube *	SetInputCube (const QString &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))
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.
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 &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(Buffer &in))
	Starts the systematic processing of the input cube by moving an arbitrary shaped brick through the cube.
void	StartProcess (void funct(Buffer &in, 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< Buffer * > &in, std::vector< Buffer * > &out))
	Starts the systematic processing of the input cube by moving an arbitrary shaped brick through the cube.
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.
void	Finalize ()
	Cleans up by closing cubes and freeing memory.
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.
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.
QSet< Isis::Cube * > *	m_ownedCubes
	A list of cubes owned by this instant.
Private Member Functions
void	SetBrickSizesForProcessCubeInPlace ()
	This is a helper method for StartProcess() and ProcessCubeInPlace().
void	SetBrickSizesForProcessCube ()
	This is a helper method for StartProcess() and ProcessCube().
void	SetBrickSizesForProcessCubes ()
	This is a helper method for StartProcess() and ProcessCubes().
Private Attributes
int	p_spectraType
	Spectra type: valid values are 0 (PerPixel), 1 (ByLine), or 2 (BySample).

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

For internal use only.

History:: 2006-03-27 Jacob Danton - Original Version

History:: 2006-08-07 Tracie Sucharski, Fixed bug in StartProcess with a single input buffer. Error checks and set-up of brick was not being done correctly.

History:: 2011-08-19 Jeannie Backer - Modified unitTest to use $temporary variable instead of /tmp directory. Added some documentation to methods.

Definition at line 54 of file ProcessBySpectra.h.

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)

Definition at line 71 of file ProcessBySpectra.h.

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

Definition at line 279 of file Process.h.

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.

Definition at line 721 of file Process.cpp.

References Isis::Statistics::AddData(), Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), 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.

Definition at line 506 of file Process.cpp.

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.

Definition at line 516 of file Process.cpp.

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

Referenced by Isis::Process::ClearCubes(), Isis::FileTool::saveAsReducedCube(), 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.

Definition at line 530 of file Process.cpp.

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

Definition at line 293 of file Process.h.

References Isis::Process::p_cubeStats.

void Isis::ProcessByBrick::EndProcess ( ) [virtual, inherited]

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

Deprecated:

Reimplemented from Isis::Process.

Reimplemented in Isis::ProcessByTile.

Definition at line 469 of file ProcessByBrick.cpp.

References Isis::ProcessByBrick::p_inputBrickSizeSet, and Isis::ProcessByBrick::p_outputBrickSizeSet.

Referenced by Isis::Equalization::calculateStatistics(), Isis::ProcessByBrick::Finalize(), Isis::ImageImporter::import(), Isis::FileTool::saveAsReducedCube(), and Isis::ProcessMapMosaic::SetOutputCube().

void Isis::ProcessByBrick::Finalize ( ) [virtual, inherited]

Cleans up by closing cubes and freeing memory.

Reimplemented from Isis::Process.

Reimplemented in Isis::ProcessByTile.

Definition at line 479 of file ProcessByBrick.cpp.

References Isis::ProcessByBrick::EndProcess().

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

Definition at line 276 of file ProcessByBrick.cpp.

References Isis::ProcessByBrick::p_reverse.

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.

Definition at line 666 of file Process.cpp.

References _FILEINFO_, Isis::PvlObject::FindGroup(), and Isis::IException::Io.

template<typename Functor >

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

See also:: ProcessByBrick::ProcessCube()

Parameters:

	funct
	threaded

Reimplemented from Isis::ProcessByBrick.

Definition at line 121 of file ProcessBySpectra.h.

References SetBrickSizesForProcessCube().

template<typename Functor >

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

See also:: ProcessByBrick::ProcessCubeInPlace()

Parameters:

	funct
	threaded

Reimplemented from Isis::ProcessByBrick.

Definition at line 110 of file ProcessBySpectra.h.

References SetBrickSizesForProcessCubeInPlace().

template<typename Functor >

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

See also:: ProcessByBrick::ProcessCubes()

Parameters:

	funct
	threaded

Reimplemented from Isis::ProcessByBrick.

Definition at line 132 of file ProcessBySpectra.h.

References SetBrickSizesForProcessCubes().

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

This method returns a pointer to a Progress object.

Returns:: Progress*

Definition at line 259 of file Process.h.

References Isis::Process::p_progress.

Referenced by 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.

Definition at line 635 of file Process.cpp.

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.

Definition at line 563 of file Process.cpp.

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.

Definition at line 552 of file Process.cpp.

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.

Definition at line 646 of file Process.cpp.

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.

Definition at line 625 of file Process.cpp.

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.

Definition at line 600 of file Process.cpp.

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.

Definition at line 591 of file Process.cpp.

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

Definition at line 116 of file ProcessByBrick.cpp.

References Isis::Process::InputCubes, Isis::Process::OutputCubes, Isis::ProcessByBrick::p_inputBrickBands, Isis::ProcessByBrick::p_inputBrickLines, Isis::ProcessByBrick::p_inputBrickSamples, Isis::ProcessByBrick::p_inputBrickSizeSet, Isis::ProcessByBrick::p_outputBrickBands, Isis::ProcessByBrick::p_outputBrickLines, Isis::ProcessByBrick::p_outputBrickSamples, and Isis::ProcessByBrick::p_outputBrickSizeSet.

Referenced by Isis::ProcessByTile::SetBrickSizesForProcessCube(), Isis::ProcessByTile::SetBrickSizesForProcessCubeInPlace(), SetBrickSizesForProcessCubeInPlace(), Isis::ProcessBySample::SetBrickSizesForProcessCubeInPlace(), Isis::ProcessByTile::SetBrickSizesForProcessCubes(), and Isis::ProcessByLine::VerifyCubeInPlace().

void Isis::ProcessBySpectra::SetBrickSizesForProcessCube ( ) [private]

This is a helper method for StartProcess() and ProcessCube().

Definition at line 187 of file ProcessBySpectra.cpp.

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

Referenced by ProcessCube().

void Isis::ProcessBySpectra::SetBrickSizesForProcessCubeInPlace ( ) [private]

This is a helper method for StartProcess() and ProcessCubeInPlace().

Definition at line 156 of file ProcessBySpectra.cpp.

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

Referenced by ProcessCubeInPlace(), and StartProcess().

void Isis::ProcessBySpectra::SetBrickSizesForProcessCubes ( ) [private]

This is a helper method for StartProcess() and ProcessCubes().

Definition at line 220 of file ProcessBySpectra.cpp.

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

Referenced by ProcessCubes(), and StartProcess().

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

Definition at line 168 of file ProcessByBrick.cpp.

References _FILEINFO_, Isis::Process::InputCubes, Isis::ProcessByBrick::p_inputBrickBands, Isis::ProcessByBrick::p_inputBrickLines, Isis::ProcessByBrick::p_inputBrickSamples, Isis::ProcessByBrick::p_inputBrickSizeSet, 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

Definition at line 145 of file ProcessByBrick.cpp.

References Isis::Process::InputCubes, Isis::ProcessByBrick::p_inputBrickBands, Isis::ProcessByBrick::p_inputBrickLines, Isis::ProcessByBrick::p_inputBrickSamples, and Isis::ProcessByBrick::p_inputBrickSizeSet.

Referenced by Isis::ProcessByBrick::PrepProcessCube(), Isis::ProcessByBrick::PrepProcessCubeInPlace(), SetBrickSizesForProcessCube(), Isis::ProcessBySample::SetBrickSizesForProcessCube(), SetBrickSizesForProcessCubes(), Isis::ProcessBySample::SetBrickSizesForProcessCubes(), 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.

Definition at line 201 of file Process.cpp.

References _FILEINFO_, 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.

Definition at line 98 of file ProcessByBrick.cpp.

References Isis::ProcessByBrick::SetInputCube().

Isis::Cube * Isis::ProcessBySpectra::SetInputCube	(	const QString &	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

Definition at line 74 of file ProcessBySpectra.cpp.

References SetInputCube().

Isis::Cube * Isis::ProcessBySpectra::SetInputCube	(	const QString &	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.

Definition at line 56 of file ProcessBySpectra.cpp.

Referenced by 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

Definition at line 227 of file ProcessByBrick.cpp.

References _FILEINFO_, Isis::Process::OutputCubes, Isis::ProcessByBrick::p_outputBrickBands, Isis::ProcessByBrick::p_outputBrickLines, Isis::ProcessByBrick::p_outputBrickSamples, Isis::ProcessByBrick::p_outputBrickSizeSet, 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

Definition at line 204 of file ProcessByBrick.cpp.

References Isis::Process::OutputCubes, Isis::ProcessByBrick::p_outputBrickBands, Isis::ProcessByBrick::p_outputBrickLines, Isis::ProcessByBrick::p_outputBrickSamples, and Isis::ProcessByBrick::p_outputBrickSizeSet.

Referenced by Isis::ProcessByBrick::PrepProcessCube(), Isis::ProcessByBrick::PrepProcessCubeInPlace(), SetBrickSizesForProcessCube(), Isis::ProcessBySample::SetBrickSizesForProcessCube(), SetBrickSizesForProcessCubes(), Isis::ProcessBySample::SetBrickSizesForProcessCubes(), 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

Definition at line 334 of file Process.cpp.

References _FILEINFO_, Isis::PvlObject::AddGroup(), Isis::PvlObject::AddObject(), Isis::AttachedLabel, base, Isis::CubeAttributeOutput::byteOrder(), Isis::Cube::create(), cube, Isis::CubeAttributeOutput::fileFormat(), Isis::PvlObject::FindObject(), Isis::PvlObject::Group(), Isis::PvlObject::Groups(), incube, Isis::Process::InputCubes, Isis::PvlContainer::IsNamed(), Isis::Cube::label(), Isis::Cube::labelSize(), Isis::CubeAttributeOutput::maximum(), Isis::CubeAttributeOutput::minimum(), mult, Isis::PvlContainer::Name(), Isis::PvlObject::Object(), Isis::PvlObject::Objects(), Isis::Process::p_propagateLabels, Isis::Process::p_propagateOriginalLabel, Isis::Process::p_propagatePolygons, Isis::Process::p_propagateTables, Isis::Cube::pixelType(), Isis::CubeAttributeOutput::pixelType(), Isis::IException::Programmer, Isis::CubeAttributeOutput::propagateMinimumMaximum(), Isis::CubeAttributeOutput::propagatePixelType(), Isis::Cube::setBaseMultiplier(), Isis::Cube::setByteOrder(), Isis::Cube::setDimensions(), Isis::Cube::setFormat(), Isis::Cube::setLabelsAttached(), Isis::Cube::setLabelSize(), Isis::Cube::setMinMax(), Isis::Cube::setPixelType(), Isis::IException::User, Isis::Cube::write(), and Isis::Process::WriteHistory().

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.

Definition at line 302 of file Process.cpp.

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.

Definition at line 266 of file Process.cpp.

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

Referenced by Isis::FileTool::saveAsEnlargedCube(), Isis::FileTool::saveAsReducedCube(), 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

Definition at line 263 of file ProcessByBrick.cpp.

References Isis::ProcessByBrick::p_reverse.

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

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.

Definition at line 144 of file ProcessBySpectra.cpp.

References _FILEINFO_, ByLine, BySample, p_spectraType, PerPixel, and Isis::IException::Programmer.

Referenced by ProcessBySpectra().

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

Definition at line 292 of file ProcessByBrick.cpp.

References Isis::ProcessByBrick::p_wrapOption.

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

Definition at line 217 of file Process.h.

void Isis::ProcessByBrick::StartProcess ( void functstd::vector< Buffer * > &in,std::vector< Buffer * > &out ) [inherited]

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

This method allows multiple input and output cubes.

Deprecated:

Parameters:

funct

(vector<Buffer *> &in, vector<Buffer *> &out) Receive an nxm brick 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 in Isis::ProcessByTile.

Definition at line 401 of file ProcessByBrick.cpp.

References Isis::Progress::CheckStatus(), Isis::Process::InputCubes, Isis::Process::OutputCubes, Isis::Process::p_progress, Isis::Progress::SetMaximumSteps(), and Isis::ProcessByBrick::Wraps().

void Isis::ProcessByBrick::StartProcess ( void functBuffer &in, Buffer &out ) [inherited]

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.

Deprecated:

Parameters:

funct

(Buffer &in, 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:

iException::Programmer

Reimplemented in Isis::ProcessByTile.

Definition at line 361 of file ProcessByBrick.cpp.

References Isis::BufferManager::begin(), Isis::Progress::CheckStatus(), Isis::Process::InputCubes, Isis::Process::OutputCubes, Isis::Process::p_progress, Isis::ProcessByBrick::PrepProcessCube(), and Isis::Progress::SetMaximumSteps().

void Isis::ProcessByBrick::StartProcess ( void functBuffer &in ) [inherited]

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 be loaded. No output cubes are produced.

Deprecated:

Parameters:

funct

(Buffer &in) Receive an nxm brick 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 in Isis::ProcessByTile.

Definition at line 320 of file ProcessByBrick.cpp.

References Isis::BufferManager::begin(), Isis::Brick::Bricks(), Isis::Progress::CheckStatus(), cube, Isis::BufferManager::end(), Isis::Cube::isReadWrite(), Isis::Process::p_progress, Isis::ProcessByBrick::PrepProcessCubeInPlace(), Isis::Cube::read(), Isis::Progress::SetMaximumSteps(), and Isis::Cube::write().

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.

Deprecated:: Please use ProcessCubes()

Parameters:

funct

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

Exceptions:

Isis::iException::Message

Definition at line 129 of file ProcessBySpectra.cpp.

References SetBrickSizesForProcessCubes(), and StartProcess().

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.

Deprecated:: Please use ProcessCubeInPlace()

Parameters:

funct

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

Exceptions:

Isis::iException::Message

Definition at line 94 of file ProcessBySpectra.cpp.

References SetBrickSizesForProcessCubeInPlace().

Referenced by StartProcess().

int Isis::ProcessBySpectra::Type ( ) [inline]

Returns the spectra type:.

0 = PerPixel
1 = ByLine
2 = BySample

Returns:: int Integer value representing the spectra type.

Definition at line 92 of file ProcessBySpectra.h.

References p_spectraType.

Referenced by SetBrickSizesForProcessCube(), SetBrickSizesForProcessCubeInPlace(), and SetBrickSizesForProcessCubes().

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

Returns true if the wrapping option is enabled.

See also:: SetWrap()

Returns:: The value of the wrapping option

Definition at line 302 of file ProcessByBrick.cpp.

References Isis::ProcessByBrick::p_wrapOption.

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

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

Writes out the History blob to the cube.

Definition at line 687 of file Process.cpp.

References Isis::History::AddEntry(), 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

const int Isis::ProcessBySpectra::ByLine = 1 [static]

ByLine spectra type (equal to 1).

Definition at line 138 of file ProcessBySpectra.h.

Referenced by SetBrickSizesForProcessCube(), SetBrickSizesForProcessCubeInPlace(), SetBrickSizesForProcessCubes(), and SetType().

const int Isis::ProcessBySpectra::BySample = 2 [static]

BySample spectra type (equal to 2).

Definition at line 139 of file ProcessBySpectra.h.

Referenced by SetType().

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.

Definition at line 189 of file Process.h.

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.

Definition at line 203 of file Process.h.

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