#include <ProcessByTile.h>

Inheritance diagram for Isis::ProcessByTile:

Collaboration diagram for Isis::ProcessByTile:

Public Types
enum	ProcessingDirection { LinesFirst, BandsFirst }

Public Member Functions
	ProcessByTile ()
	Constructs a ProcessByTile object.
	~ProcessByTile ()
	Destroys the ProcessByTile object.
void	SetTileSize (const int ns, const int nl)
	Sets the tile size.
void	StartProcess (void funct(Buffer &in))
	Starts the systematic processing of the input cube by moving an arbitrary shaped tile through the cube.
void	StartProcess (void funct(Buffer &in, Buffer &out))
	Starts the systematic processing of the input cube by moving an arbitrary shaped tile through the cube.
void	StartProcess (void funct(std::vector< Buffer * > &in, std::vector< Buffer * > &out))
	Starts the systematic processing of the input cube by moving an arbitrary shaped tile through the cube.
void	EndProcess ()
	End the processing sequence and cleans up by closing cubes, freeing memory, etc.
void	Finalize ()
	Cleans up by closing cubes and freeing memory.
template<typename Functor >
void	ProcessCubeInPlace (const Functor &funct, bool threaded=true)
template<typename Functor >
void	ProcessCube (const Functor &funct, bool threaded=true)
template<typename Functor >
void	ProcessCubes (const Functor &funct, bool threaded=true)
Cube *	SetInputCube (const QString &parameter, int requirements=0)
	Opens an input cube specified by the user and verifies requirements are met.
Cube *	SetInputCube (const QString &fname, const CubeAttributeInput &att, int requirements=0)
	Opens an input cube specified by the user, sets the attributes, and verifies requirements are met.
virtual 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 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.
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	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())
	In the base class, this method will invoked a user-specified function exactly one time.
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
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
bool	p_tileSizeSet
	Indicates whether the tile size has been set.
int	p_tileSamples
	Number of samples in the tile.
int	p_tileLines
	Number of lines in the tile.

Detailed Description

Process cubes by tile.

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

Author: 2004-05-14 Jeff Anderson

History:: 2005-02-08 Elizabeth Ribelin - Modified file to support Doxygen documentation

History:: 2005-11-28 Jacob Danton - Modified file to allow processing with multiple input and output cubes.

History:: 2006-04-03 Jacob Danton - Rewrote the code to extend ProcessByBrick class

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

Todo:: 2005-02-08 Jeff Anderson - add coded example, and implementation example to class documentation

Definition at line 56 of file ProcessByTile.h.

Constructor & Destructor Documentation

Isis::ProcessByTile::ProcessByTile ( )

inline

Constructs a ProcessByTile object.

Definition at line 66 of file ProcessByTile.h.

References p_tileSizeSet.

Isis::ProcessByTile::~ProcessByTile ( )

inline

Destroys the ProcessByTile object.

Definition at line 71 of file ProcessByTile.h.

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::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::ProcessByTile::EndProcess ( )

virtual

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

Deprecated:: Please use Finalize()

Reimplemented from Isis::ProcessByBrick.

Definition at line 109 of file ProcessByTile.cpp.

void Isis::ProcessByTile::Finalize ( )

virtual

Cleans up by closing cubes and freeing memory.

Reimplemented from Isis::ProcessByBrick.

Definition at line 118 of file ProcessByTile.cpp.

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 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().

template<typename Functor >

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

inline

See Also: ProcessByBrick::ProcessCube()

Parameters

funct
threaded

Reimplemented from Isis::ProcessByBrick.

Definition at line 100 of file ProcessByTile.h.

References SetBrickSizesForProcessCube().

template<typename Functor >

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

inline

See Also: ProcessByBrick::ProcessCubeInPlace()

Parameters

funct
threaded

Reimplemented from Isis::ProcessByBrick.

Definition at line 89 of file ProcessByTile.h.

References SetBrickSizesForProcessCubeInPlace().

template<typename Functor >

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

inline

See Also: ProcessByBrick::ProcessCubes()

Parameters

funct
threaded

Reimplemented from Isis::ProcessByBrick.

Definition at line 111 of file ProcessByTile.h.

References SetBrickSizesForProcessCubes().

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(), Isis::ProcessMapMosaic::SetOutputCube(), and Isis::SpectralDefinition2D::SpectralDefinition2D().

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().

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

inherited

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::ProcessByTile::SetBrickSizesForProcessCube ( )

private

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

Definition at line 147 of file ProcessByTile.cpp.

References _FILEINFO_.

Referenced by ProcessCube().

void Isis::ProcessByTile::SetBrickSizesForProcessCubeInPlace ( )

private

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

Definition at line 127 of file ProcessByTile.cpp.

References _FILEINFO_.

Referenced by ProcessCubeInPlace().

void Isis::ProcessByTile::SetBrickSizesForProcessCubes ( )

private

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

Definition at line 182 of file ProcessByTile.cpp.

References _FILEINFO_.

Referenced by ProcessCubes().

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

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

References _FILEINFO_.

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

virtualinherited

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`
	)

virtualinherited

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
	)

inherited

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
	)

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

References _FILEINFO_.

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

virtualinherited

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().

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 )

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

Referenced by Isis::ImageImporter::import(), and Isis::SpectralDefinition2D::SpectralDefinition2D().

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

Sets the tile size.

Parameters

ns	Number of samples
nl	Number of lines

Definition at line 36 of file ProcessByTile.cpp.

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

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

virtual

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

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

Deprecated:: Please use ProcessCubeInPlace()

Parameters

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

Exceptions

iException::Programmer

Reimplemented from Isis::ProcessByBrick.

Definition at line 76 of file ProcessByTile.cpp.

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

virtual

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

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

Deprecated:: Please use ProcessCube()

Parameters

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

Exceptions

iException::Programmer

Reimplemented from Isis::ProcessByBrick.

Definition at line 56 of file ProcessByTile.cpp.

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

virtual

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

This method allows multiple input and output cubes.

Deprecated:: Please use ProcessCubes()

Parameters

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

Exceptions

iException::Programmer

Reimplemented from Isis::ProcessByBrick.

Definition at line 96 of file ProcessByTile.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 ( )

inherited

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 Isis::ProcessByBrick::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(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::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(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::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().

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

int Isis::ProcessByTile::p_tileLines

private

Number of lines in the tile.

Definition at line 61 of file ProcessByTile.h.

int Isis::ProcessByTile::p_tileSamples

private

Number of samples in the tile.

Definition at line 60 of file ProcessByTile.h.

bool Isis::ProcessByTile::p_tileSizeSet

private

Indicates whether the tile size has been set.

Definition at line 59 of file ProcessByTile.h.

Referenced by ProcessByTile().

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

src/base/objs/ProcessByTile/ProcessByTile.h
src/base/objs/ProcessByTile/ProcessByTile.cpp

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation