#include <ProcessByBrick.h>

Inheritance diagram for Isis::ProcessByBrick:

Collaboration diagram for Isis::ProcessByBrick:

Classes
class	ProcessCubeFunctor
	Create an output cube given one input cube. More...

class	ProcessCubeInPlaceFunctor
	Process a cube in place (one input/zero output or zero input/one output or one cube that acts both as input and output). More...

class	ProcessCubesFunctor
	Create an arbitrary number of output cubes given an arbitrary number of input cubes (these counts can be zero). More...

class	ProcessIterator
	This class is designed to iterate over all brick positions in a cube. More...

Public Types
enum	ProcessingDirection { LinesFirst, BandsFirst }

Public Member Functions
	ProcessByBrick ()
	Constructs a ProcessByBrick object.

virtual	~ProcessByBrick ()
	Destroys the ProcessByBrick object.

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	SetBrickSize (int ns, int nl, int nb)
	Sets the input and output bricks sizes to the given number of samples, lines, and bands.

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.

virtual Cube *	SetOutputCube (const QString &fname, const CubeAttributeOutput &att)
	Create the output file.

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.

virtual void	StartProcess (void funct(Buffer &in))
	Starts the systematic processing of the input cube by moving an arbitrary shaped brick through the cube.

virtual 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.

virtual 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	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 &functor, bool threaded=true)
	Operate over a single cube (either input or output).

template<typename Functor >
void	ProcessCube (const Functor &functor, bool threaded=true)
	Operate over a single input cube creating a separate output cube.

template<typename Functor >
void	ProcessCubes (const Functor &functor, bool threaded=true)
	Operate over an arbitrary number of input cubes given an arbitrary number of output cubes.

virtual void	StartProcess (void funct())
	In the base class, this method will invoked a user-specified function exactly one time.

virtual void	SetInputCube (Isis::Cube *inCube)
	Set the InputCube vector to an opened Cube which was dynamically allocated.

virtual Isis::Cube *	SetOutputCube (const QString &parameter)
	Allocates a user-specified output cube whose size matches the first input cube.

virtual 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.

virtual 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.

Private Member Functions
template<typename Functor >
void	RunProcess (const Functor &wrapperFunctor, int numSteps, bool threaded)
	This method runs the given wrapper functor numSteps times with or without threading, reporting progress in both cases.

void	BlockingReportProgress (QFuture< void > &future)
	This method blocks until the future reports that it is finished.

std::vector< int >	CalculateMaxDimensions (std::vector< Cube * > cubes) const
	Calculates the maximum dimensions of all the cubes and returns them in a vector where position 0 is the max sample, position 1 is the max line, and position 2 is the max band.

bool	PrepProcessCubeInPlace (Cube cube, Brick bricks)
	Prepare and check to run "function" parameter for StartProcess(void funct(Buffer &in)) and StartProcessInPlace(Functor funct)

int	PrepProcessCube (Brick ibrick, Brick obrick)
	Prepare and check to run "function" parameter for StartProcess(void funct(Buffer &in, Buffer &out)) and StartProcessIO(Functor funct)

int	PrepProcessCubes (std::vector< Buffer * > &ibufs, std::vector< Buffer * > &obufs, std::vector< Brick * > &imgrs, std::vector< Brick * > &omgrs)
	Prepare and check to run "function" parameter for StartProcess(void funct(vector<Buffer > &in, vector<Buffer > &out)), StartProcessIOList(Functor funct)

Private Attributes
bool	p_reverse
	Use the reverse option for constructing the Buffer objects when the Processing Direction is changed from LinesFirst to BandsFirst

bool	p_wrapOption
	Indicates whether the brick manager will wrap.

bool	p_inputBrickSizeSet
	Indicates whether the brick size has been set

bool	p_outputBrickSizeSet
	Indicates whether the brick size has been set

std::vector< int >	p_inputBrickSamples
	Number of samples in the input bricks.

std::vector< int >	p_inputBrickLines
	Number of lines in the input bricks.

std::vector< int >	p_inputBrickBands
	Number of bands in the input bricks.

std::vector< int >	p_outputBrickSamples
	Number of samples in the output bricks.

std::vector< int >	p_outputBrickLines
	Number of lines in the output bricks.

std::vector< int >	p_outputBrickBands
	Number of bands in the output bricks.

Detailed Description

Process cubes by brick.

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

Author: 2006-03-24 Jacob Danton

History:

2005-02-08 Jacob Danton - Original Version

2006-08-08 Debbie A. Cook - Added overloaded method SetInputCube

2007-12-14 Steven Lambright - Same band is now forced on input cubes when there are multiple input cubes

2008-01-09 Steven Lambright - Fixed a memory leak

2008-06-18 Steven Koechle - Fixed Documentation

2011-04-22 Sharmila Prasad - Extended StartProcess functionality to be able to be called from any Object class by using Functors

2011-05-07 Sharmila Prasad - 1. Added API SetInputCube(Cube*) to take opened cube 2. Edited StartProcess using Functors take reference to Functors

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

2011-11-23 Jai Rideout - Modified the two StartProcess() methods that either accept one input and one output cube, or multiple input and output cubes so that the area that the brick traverses is the largest of all of the cubes (including both input and output cubes). This resolves the issue of premature wrapping that would occur when the sizes of the cubes differed. Now, the bricks are filled with nulls if they read past the end of a smaller cube before they have reached the end of the larger one. These changes only take effect when the wrap option is off, otherwise the previous behavior is used.

2012-02-22 Steven Lambright - Refactored functor-based StartProcess() calls. This class now supports multi-threaded functor and function based programs. StartProcess() is now deprecated in favor of ProcessCube(), ProcessCubes(), and ProcessCubeInPlace(). Added Finalize().

2013-03-27 Jeannie Backer - Modified SetBrickSize() code to call existing methods rather than duplicating code. Added SetOutputCube() method.References #1248.

2015-01-15 Sasha Brownsberger - Added virtual keyword to several functions to ensure successful inheritance between Process and its child classes. Also made destructor virtual. Fixes #2215.

Definition at line 93 of file ProcessByBrick.h.

Constructor & Destructor Documentation

Isis::ProcessByBrick::ProcessByBrick ( )

Constructs a ProcessByBrick object.

Definition at line 31 of file ProcessByBrick.cpp.

Isis::ProcessByBrick::~ProcessByBrick ( )

virtual

Destroys the ProcessByBrick object.

Definition at line 47 of file ProcessByBrick.cpp.

Member Function Documentation

std::vector<Isis::Statistics *> Isis::Process::BandStatistics ( const unsigned index )

inlineinherited

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 283 of file Process.h.

References Isis::Process::p_bandStats.

void Isis::ProcessByBrick::BlockingReportProgress ( QFuture< void > & future )

private

This method blocks until the future reports that it is finished.

This monitors the progress of the future and translates it's progress values into Isis progress class calls.

Parameters

future The future to monitor

Definition at line 501 of file ProcessByBrick.cpp.

Referenced by RunProcess().

vector< int > Isis::ProcessByBrick::CalculateMaxDimensions ( std::vector< Cube * > cubes ) const

private

Calculates the maximum dimensions of all the cubes and returns them in a vector where position 0 is the max sample, position 1 is the max line, and position 2 is the max band.

For example, if two cubes were passed in and the first cube had 1 sample, 1 line, and 1 band, and the second cube had 2 samples, 2 lines, and 2 bands, the max dimensions would be 2 samples, 2 lines, and 2 bands.

Parameters

cubes The vector of cubes to calculate the maximum dimensions for.

Returns: A vector of size 3 containing the max sample dimension at position 0, the max line dimension at position 1, and the max band dimension at position 2.

Definition at line 543 of file ProcessByBrick.cpp.

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::Cube::lineCount(), 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.

void Isis::Process::ClearInputCubes ( )

inherited

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

Definition at line 516 of file Process.cpp.

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::FileTool::saveAsReducedCube(), and Isis::ProcessMapMosaic::SetOutputCube().

void Isis::Process::ClearOutputCubes ( )

inherited

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

Definition at line 530 of file Process.cpp.

Isis::Statistics* Isis::Process::CubeStatistics ( const unsigned index )

inlineinherited

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 297 of file Process.h.

References Isis::Process::p_cubeStats.

void Isis::ProcessByBrick::EndProcess ( )

virtual

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

Deprecated:: Please use Finalize()

Reimplemented from Isis::Process.

Reimplemented in Isis::ProcessByTile.

Definition at line 479 of file ProcessByBrick.cpp.

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

void Isis::ProcessByBrick::Finalize ( )

virtual

Cleans up by closing cubes and freeing memory.

Reimplemented from Isis::Process.

Reimplemented in Isis::ProcessByTile.

Definition at line 489 of file ProcessByBrick.cpp.

ProcessByBrick::ProcessingDirection Isis::ProcessByBrick::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).

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

Returns: The selected enumerated processing direction

Definition at line 285 of file ProcessByBrick.cpp.

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_, and Isis::PvlObject::findGroup().

int Isis::ProcessByBrick::PrepProcessCube	(	Brick **	ibrick,
		Brick **	obrick
	)

private

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

Parameters

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

Returns: int

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

Definition at line 649 of file ProcessByBrick.cpp.

References _FILEINFO_.

Referenced by ProcessCube().

bool Isis::ProcessByBrick::PrepProcessCubeInPlace	(	Cube **	cube,
		Brick **	bricks
	)

private

Prepare and check to run "function" parameter for StartProcess(void funct(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(Buffer &in))

Definition at line 585 of file ProcessByBrick.cpp.

References _FILEINFO_.

Referenced by ProcessCubeInPlace().

int Isis::ProcessByBrick::PrepProcessCubes	(	std::vector< Buffer * > &	ibufs,
		std::vector< Buffer * > &	obufs,
		std::vector< Brick * > &	imgrs,
		std::vector< Brick * > &	omgrs
	)

private

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

Parameters

ibufs	- input buffer manager
obufs	- output buffer manager
imgrs	- input brick manager
omgrs	- output brick manager

Returns: int - Number of bricks

History:: 2011-04-22 Sharmila Prasad - Ported from StartProcess (void funct(vector<Buffer *> &in, vector<Buffer *> &out))

Definition at line 741 of file ProcessByBrick.cpp.

References _FILEINFO_, Isis::BufferManager::begin(), and Isis::Brick::Bricks().

Referenced by ProcessCubes().

template<typename Functor >

void Isis::ProcessByBrick::ProcessCube	(	const Functor &	functor,
		bool	threaded = `true`
	)

inline

Operate over a single input cube creating a separate output cube.

The functor you pass in will be called for every position in the cube. If threaded is true, there is no guarantee to the sequence or timing of the functor's calls.

If you are using a function, the prototype should look like: void SomeFunc(Buffer &inputData, Buffer &outputData); If you are using a functor, the () operator should look like: void operator()(Buffer &inputData, Buffer &outputData) const;

When threaded is true, your function (or functor's () operator) must be thread safe. Please document your function appropriately if it is thread safe.

Parameters

functor	The processing function or functor which does your desired calculations.
threaded	True if multi-threading is supported, false otherwise. Sequential calling of the functor is guaranteed if this is false.

Definition at line 203 of file ProcessByBrick.h.

References Isis::Process::InputCubes, Isis::Process::OutputCubes, PrepProcessCube(), and RunProcess().

Referenced by Isis::ProcessBySample::ProcessCube(), Isis::ProcessByTile::ProcessCube(), Isis::ProcessBySpectra::ProcessCube(), and Isis::ProcessByLine::ProcessCube().

template<typename Functor >

void Isis::ProcessByBrick::ProcessCubeInPlace	(	const Functor &	functor,
		bool	threaded = `true`
	)

inline

Operate over a single cube (either input or output).

The functor you pass in will be called for every position in the cube. If threaded is true, there is no guarantee to the sequence or timing of the functor's calls.

If you are using a function, the prototype should look like: void SomeFunc(Buffer &); If you are using a functor, the () operator should look like: void operator()(Buffer &) const;

When threaded is true, your function (or functor's () operator) must be thread safe. Please document your function appropriately if it is thread safe.

Parameters

functor	The processing function or functor which does your desired calculations.
threaded	True if multi-threading is supported, false otherwise. Sequential calling of the functor is guaranteed if this is false.

Definition at line 166 of file ProcessByBrick.h.

References Isis::Brick::Bricks(), Isis::Cube::isReadWrite(), PrepProcessCubeInPlace(), and RunProcess().

Referenced by Isis::ProcessBySample::ProcessCubeInPlace(), Isis::ProcessByTile::ProcessCubeInPlace(), Isis::ProcessBySpectra::ProcessCubeInPlace(), and Isis::ProcessByLine::ProcessCubeInPlace().

template<typename Functor >

void Isis::ProcessByBrick::ProcessCubes	(	const Functor &	functor,
		bool	threaded = `true`
	)

inline

Operate over an arbitrary number of input cubes given an arbitrary number of output cubes.

The functor you pass in will be called for every position in the largest output cube. If threaded is true, there is no guarantee to the sequence or timing of the functor's calls.

If you are using a function, the prototype should look like: void SomeFunc(std::vector<Buffer *> &inputData, std::vector<Buffer *> &outputData); If you are using a functor, the () operator should look like: void operator()(std::vector<Buffer *> &inputData, std::vector<Buffer *> &outputData) const;

When threaded is true, your function (or functor's () operator) must be thread safe. Please document your function appropriately if it is thread safe.

Parameters

functor	The processing function or functor which does your desired calculations.
threaded	True if multi-threading is supported, false otherwise. Sequential calling of the functor is guaranteed if this is false.

Definition at line 242 of file ProcessByBrick.h.

References Isis::Process::InputCubes, Isis::Process::OutputCubes, PrepProcessCubes(), RunProcess(), and Wraps().

Referenced by Isis::ProcessBySample::ProcessCubes(), Isis::ProcessByTile::ProcessCubes(), Isis::ProcessBySpectra::ProcessCubes(), and Isis::ProcessByLine::ProcessCubes().

Isis::Progress* Isis::Process::Progress ( )

inlineinherited

This method returns a pointer to a Progress object.

Returns: Progress*

Definition at line 263 of file Process.h.

References Isis::Process::p_progress.

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

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.

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

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.

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and 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(), Isis::PvlObject::group(), Isis::PvlObject::groups(), and Isis::PvlObject::hasObject().

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.

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and 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.

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and 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.

Definition at line 591 of file Process.cpp.

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and 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(), and Isis::Cube::read().

template<typename Functor >

void Isis::ProcessByBrick::RunProcess	(	const Functor &	wrapperFunctor,
		int	numSteps,
		bool	threaded
	)

inlineprivate

This method runs the given wrapper functor numSteps times with or without threading, reporting progress in both cases.

This method is a blocking call.

Parameters

wrapperFunctor	A functor that does the reading, processing, and writing required given a ProcessIterator position in the cube.
numSteps	The end() value for the process iterator.
threaded	Force threading off when set to false; threading may or may not be used if this is true.

Definition at line 283 of file ProcessByBrick.h.

References BlockingReportProgress(), Isis::Progress::CheckStatus(), Isis::Process::p_progress, and Isis::Progress::SetMaximumSteps().

Referenced by ProcessCube(), ProcessCubeInPlace(), and ProcessCubes().

void Isis::ProcessByBrick::SetBrickSize	(	int	ns,
		int	nl,
		int	nb
	)

Sets the input and output bricks sizes to the given number of samples, lines, and bands.

Parameters

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

Definition at line 117 of file ProcessByBrick.cpp.

void Isis::ProcessByBrick::SetInputBrickSize	(	int	ns,
		int	nl,
		int	nb
	)

Sets the size of all input bricks.

Parameters

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

Definition at line 133 of file ProcessByBrick.cpp.

void Isis::ProcessByBrick::SetInputBrickSize	(	int	ns,
		int	nl,
		int	nb,
		int	cube
	)

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 156 of file ProcessByBrick.cpp.

References _FILEINFO_.

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

virtual

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::ProcessBySpectra, and Isis::ProcessBySample.

Definition at line 70 of file ProcessByBrick.cpp.

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

virtual

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.

void Isis::Process::SetInputCube ( Isis::Cube * inCube )

virtualinherited

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_, and Isis::Cube::isOpen().

void Isis::ProcessByBrick::SetOutputBrickSize	(	int	ns,
		int	nl,
		int	nb
	)

Sets the size of all output bricks.

Parameters

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

Definition at line 192 of file ProcessByBrick.cpp.

void Isis::ProcessByBrick::SetOutputBrickSize	(	int	ns,
		int	nl,
		int	nb,
		int	cube
	)

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 215 of file ProcessByBrick.cpp.

References _FILEINFO_.

Isis::Cube * Isis::ProcessByBrick::SetOutputCube	(	const QString &	fname,
		const CubeAttributeOutput &	att
	)

virtual

Create the output file.

This method assumes that the output cube size matches the input cube size. Therefore, SetInputCube() must be called before this method.

Parameters

parameter	The output file name.
att	An output cube attribute to define the characteristics of the output cube.

Returns: Isis::Cube Output cube.

Exceptions

Isis::iException::Message "File is not in a supported organization."

Definition at line 256 of file ProcessByBrick.cpp.

References Isis::Cube::lineCount().

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::FileTool::saveAsReducedCube(), and Isis::ProcessMapMosaic::SetOutputCube().

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

virtualinherited

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::ProcessMosaic, Isis::ProcessImport, and Isis::ProcessMapMosaic.

Definition at line 266 of file Process.cpp.

References _FILEINFO_.

Referenced by Isis::FileTool::saveAsEnlargedCube(), and Isis::ProcessImport::SetOutputCube().

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

virtualinherited

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

Definition at line 302 of file Process.cpp.

References _FILEINFO_.

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

virtualinherited

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, Isis::CubeAttributeOutput::byteOrder(), Isis::Cube::create(), Isis::CubeAttributeOutput::fileFormat(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), Isis::PvlContainer::isNamed(), Isis::Cube::label(), Isis::Cube::labelSize(), Isis::CubeAttributeOutput::maximum(), Isis::CubeAttributeOutput::minimum(), Isis::PvlContainer::name(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::pixelType(), Isis::CubeAttributeOutput::pixelType(), 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(), and Isis::Cube::write().

void Isis::ProcessByBrick::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).

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

Parameters

direction The new enumerated processing direction

Definition at line 272 of file ProcessByBrick.cpp.

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

void Isis::ProcessByBrick::SetWrap ( bool wrap )

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 301 of file ProcessByBrick.cpp.

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

virtual

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:: Please use ProcessCubeInPlace, ProcessCube, or ProcessCubes

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 329 of file ProcessByBrick.cpp.

References Isis::BufferManager::begin(), Isis::Brick::Bricks(), Isis::BufferManager::end(), Isis::Cube::isReadWrite(), Isis::Cube::read(), and Isis::Cube::write().

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

virtual

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:: Please use ProcessCubeInPlace, ProcessCube, or ProcessCubes

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 371 of file ProcessByBrick.cpp.

References Isis::BufferManager::begin().

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

virtual

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:: Please use ProcessCubeInPlace, ProcessCube, or ProcessCubes

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 411 of file ProcessByBrick.cpp.

virtual void Isis::Process::StartProcess ( void funct() )

inlinevirtualinherited

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 221 of file Process.h.

bool Isis::ProcessByBrick::Wraps ( )

Returns true if the wrapping option is enabled.

See Also: SetWrap()

Returns: The value of the wrapping option

Definition at line 311 of file ProcessByBrick.cpp.

Referenced by ProcessCubes().

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::PvlContainer::isNamed(), Isis::PvlObject::object(), Isis::PvlObject::objects(), and Isis::Cube::write().

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

Member Data Documentation

std::vector<Isis::Cube *> Isis::Process::InputCubes

protectedinherited

A vector of pointers to opened Cube objects.

The pointers are established in the SetInputCube/SetInputWorkCube methods.

Definition at line 193 of file Process.h.

Referenced by Isis::ProcessExport::CreateWorldFile(), Isis::ProcessExport::GetBuffersBIL(), Isis::ProcessExport::GetBuffersBIP(), Isis::ProcessExport::GetBuffersBSQ(), Isis::ProcessExport::InitProcess(), ProcessCube(), ProcessCubes(), Isis::ProcessExport::SetInputRange(), Isis::ProcessByQuickFilter::StartProcess(), and Isis::ProcessExport::StartProcess().

QSet<Isis::Cube *>* Isis::Process::m_ownedCubes

protectedinherited

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 207 of file Process.h.

std::vector<Isis::Cube *> Isis::Process::OutputCubes

protectedinherited

A vector of pointers to allocated Cube objects.

The pointers are established in the SetOutputCube method.

Definition at line 199 of file Process.h.

Referenced by Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), ProcessCube(), ProcessCubes(), Isis::ProcessImport::ProcessJp2(), and Isis::ProcessByQuickFilter::StartProcess().

std::vector< std::vector< Isis::Statistics * > > Isis::Process::p_bandStats

protectedinherited

Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called.

Definition at line 180 of file Process.h.

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

std::vector< Isis::Statistics * > Isis::Process::p_cubeStats

protectedinherited

Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called.

Definition at line 187 of file Process.h.

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

std::vector<int> Isis::ProcessByBrick::p_inputBrickBands

private

Number of bands in the input bricks.

Definition at line 829 of file ProcessByBrick.h.

std::vector<int> Isis::ProcessByBrick::p_inputBrickLines

private

Number of lines in the input bricks.

Definition at line 827 of file ProcessByBrick.h.

std::vector<int> Isis::ProcessByBrick::p_inputBrickSamples

private

Number of samples in the input bricks.

Definition at line 825 of file ProcessByBrick.h.

bool Isis::ProcessByBrick::p_inputBrickSizeSet

private

  Indicates whether the brick size has been

set

Definition at line 821 of file ProcessByBrick.h.

std::vector<int> Isis::ProcessByBrick::p_outputBrickBands

private

Number of bands in the output bricks.

Definition at line 835 of file ProcessByBrick.h.

std::vector<int> Isis::ProcessByBrick::p_outputBrickLines

private

Number of lines in the output bricks.

Definition at line 833 of file ProcessByBrick.h.

std::vector<int> Isis::ProcessByBrick::p_outputBrickSamples

private

Number of samples in the output bricks.

Definition at line 831 of file ProcessByBrick.h.

bool Isis::ProcessByBrick::p_outputBrickSizeSet

private

 Indicates whether the brick size has been

set

Definition at line 823 of file ProcessByBrick.h.

Isis::Progress* Isis::Process::p_progress

protectedinherited

Pointer to a Progress object.

Definition at line 153 of file Process.h.

Referenced by Isis::ProcessExport::InitProcess(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessExport::ProcessExport(), Isis::ProcessImport::ProcessImport(), Isis::ProcessImport::ProcessJp2(), Isis::Process::Progress(), RunProcess(), Isis::ProcessByQuickFilter::StartProcess(), and Isis::ProcessExport::StartProcess().

bool Isis::Process::p_propagateHistory

protectedinherited

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

Definition at line 169 of file Process.h.

bool Isis::Process::p_propagateLabels

protectedinherited

Flag indicating if labels are be propagated to output cubes.

Definition at line 157 of file Process.h.

bool Isis::Process::p_propagateOriginalLabel

protectedinherited

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

Definition at line 173 of file Process.h.

bool Isis::Process::p_propagatePolygons

protectedinherited

Flag indicating if blobs are be propagated to output cubes.

Definition at line 165 of file Process.h.

bool Isis::Process::p_propagateTables

protectedinherited

Flag indicating if tables are be propagated to output cubes.

Definition at line 161 of file Process.h.

bool Isis::ProcessByBrick::p_reverse

private

    Use the reverse option for constructing the Buffer

objects when the Processing Direction is changed from LinesFirst to BandsFirst

Definition at line 817 of file ProcessByBrick.h.

bool Isis::ProcessByBrick::p_wrapOption

private

Indicates whether the brick manager will wrap.

Definition at line 820 of file ProcessByBrick.h.

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

src/base/objs/ProcessByBrick/ProcessByBrick.h
src/base/objs/ProcessByBrick/ProcessByBrick.cpp

Classes

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation