USGS Astrogeology Isis API

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.

Definition at line 52 of file ProcessByTile.h.


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(Isis::Buffer &in))
	Starts the systematic processing of the input cube by moving an arbitrary shaped tile through the cube.
void	StartProcess (void funct(Isis::Buffer &in, Isis::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< Isis::Buffer * > &in, std::vector< Isis::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.
Isis::Cube *	SetInputCube (const std::string &parameter, const int requirements=0)
	Opens an input cube specified by the user and verifies requirements are met.
Isis::Cube *	SetInputCube (const std::string &fname, const Isis::CubeAttributeInput &att, const int requirements=0)
	Opens an input cube specified by the user, sets the attributes, and verifies requirements are met.
void	SetBrickSize (const int ns, const int nl, const int nb)
	Sets the brick size.
void	SetInputBrickSize (const int ns, const int nl, const int nb)
	Sets the size of all input bricks.
void	SetInputBrickSize (const int ns, const int nl, const int nb, const int tile)
	Sets the brick size of the specified cube.
void	SetOutputBrickSize (const int ns, const int nl, const int nb)
	Sets the size of all output bricks.
void	SetOutputBrickSize (const int ns, const int nl, const int nb, const int tile)
	Sets the brick size of the specified output cube.
void	SetWrap (bool wrap)
	This wrapping option only applys when there are two or more input cubes.
bool	Wraps ()
	Return the wrap option.
void	StartProcess (void funct())
	In the base class, this method will invoked a user-specified function exactly one time.
void	ClearInputCubes ()
	This method clears the input cube list.
Isis::Cube *	SetOutputCube (const std::string &parameter)
	Allocates a user-specified output cube whose size matches the first input cube.
Isis::Cube *	SetOutputCube (const std::string &parameter, const int nsamps, const int nlines, const int nbands=1)
	Allocates a user specified output cube whose size is specified by the programmer.
Isis::Cube *	SetOutputCube (const std::string &fname, const Isis::CubeAttributeOutput &att, const int nsamps, const int nlines, const int nbands=1)
	Allocates a output cube whose name and size is specified by the programmer.
void	PropagateLabels (const bool prop)
	This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes.
void	PropagateLabels (const std::string &cube)
	This method allows the programmer to propagate labels from a specific secondary cube.
void	PropagateTables (const bool prop)
	This method allows the programmer to propagate input tables to the output cube (default is true).
void	PropagatePolygons (const bool prop)
	This method allows the programmer to propagate input blobs to the output cube (default is true).
void	PropagateHistory (const bool prop)
	This method allows the programmer to propagate history to the output cube (default is true).
void	PropagateOriginalLabel (const bool prop)
	This method allows the programmer to propagate original labels to the output cube (default is true).
Isis::Progress *	Progress ()
	This method returns a pointer to a Progress object.
std::string	MissionData (const std::string &mission, const std::string &file, bool highestVersion=false)
	This method reads the mission specific data directory from the user preference file, makes sure that mission is available in the Isis installation, and the attaches the provided input file to the directory in order to create a full file specification.
void	WriteHistory (Cube &cube)
	Writes out the History blob to the cube.
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< Isis::Cube * >	InputCubes
	A vector of pointers to opened Cube objects.
std::vector< Isis::Cube * >	OutputCubes
	A vector of pointers to allocated Cube objects.
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.

Constructor & Destructor Documentation

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

Constructs a ProcessByTile object.

Definition at line 62 of file ProcessByTile.h.

References p_tileSizeSet.

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

Destroys the ProcessByTile object.

Definition at line 65 of file ProcessByTile.h.

Member Function Documentation

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

This method clears the input cube list.

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

Definition at line 579 of file Process.cpp.

References Isis::Process::InputCubes.

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

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

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

Reimplemented from Isis::ProcessByBrick.

Definition at line 156 of file ProcessByTile.cpp.

References Isis::ProcessByBrick::EndProcess(), and p_tileSizeSet.

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

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

Parameters:

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

Definition at line 555 of file Process.cpp.

References _FILEINFO_, Isis::Filename::Exists(), Isis::Filename::Expanded(), Isis::PvlObject::FindGroup(), Isis::Filename::HighestVersion(), Isis::iException::Message(), and Isis::Preference::Preferences().

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

This method returns a pointer to a Progress object.

Returns:: Progress*

Definition at line 211 of file Process.h.

References Isis::Process::p_progress.

Referenced by 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 524 of file Process.cpp.

References Isis::Process::p_propagateHistory.

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

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

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

Parameters:

cube

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

Definition at line 482 of file Process.cpp.

References Isis::PvlObject::AddGroup(), g, incube, Isis::Process::OutputCubes, and pvl().

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 471 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 535 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 514 of file Process.cpp.

References Isis::Process::p_propagatePolygons.

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

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

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

Parameters:

prop

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

Definition at line 503 of file Process.cpp.

References Isis::Process::p_propagateTables.

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

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

Sets the brick size.

Parameters:

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

Definition at line 108 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 StartProcess(), Isis::ProcessBySpectra::StartProcess(), Isis::ProcessBySample::StartProcess(), and Isis::ProcessByLine::StartProcess().

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

Sets the brick size of the specified cube.

Parameters:

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

Definition at line 158 of file ProcessByBrick.cpp.

References _FILEINFO_, Isis::Process::InputCubes, Isis::iException::Message(), Isis::ProcessByBrick::p_inputBrickBands, Isis::ProcessByBrick::p_inputBrickLines, Isis::ProcessByBrick::p_inputBrickSamples, and Isis::ProcessByBrick::p_inputBrickSizeSet.

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

Sets the size of all input bricks.

Parameters:

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

Definition at line 136 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::ProcessBySpectra::StartProcess(), Isis::ProcessBySample::StartProcess(), Isis::ProcessByLine::StartProcess(), and Isis::ProcessByBrick::StartProcess().

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

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

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

Returns:: Cube*

Parameters:

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

Exceptions:

Isis::iException::Message

Reimplemented from Isis::Process.

Definition at line 90 of file ProcessByBrick.cpp.

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

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

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

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::Process.

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

Definition at line 62 of file ProcessByBrick.cpp.

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

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

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

Sets the brick size of the specified output cube.

Parameters:

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

Definition at line 215 of file ProcessByBrick.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::Process::OutputCubes, Isis::ProcessByBrick::p_outputBrickBands, Isis::ProcessByBrick::p_outputBrickLines, Isis::ProcessByBrick::p_outputBrickSamples, and Isis::ProcessByBrick::p_outputBrickSizeSet.

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

Sets the size of all output bricks.

Parameters:

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

Definition at line 193 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::ProcessBySpectra::StartProcess(), Isis::ProcessBySample::StartProcess(), Isis::ProcessByLine::StartProcess(), and Isis::ProcessByBrick::StartProcess().

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

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

Returns:: Cube*

Parameters:

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

Exceptions:

Isis::iException::Message

Definition at line 305 of file Process.cpp.

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

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

Returns:: Cube*

Parameters:

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

Exceptions:

Isis::iException::Message

Reimplemented in Isis::ProcessPolygons.

Definition at line 273 of file Process.cpp.

References _FILEINFO_, IsisAml::GetFilename(), IsisAml::GetOutputAttribute(), Isis::Application::GetUserInterface(), Isis::iException::Message(), and Isis::Process::SetOutputCube().

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

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

Returns:: Cube*

Parameters:

parameter

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

Exceptions:

Isis::iException::Message

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

Definition at line 237 of file Process.cpp.

References _FILEINFO_, Isis::Process::InputCubes, Isis::iException::Message(), nb, nl, and ns.

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

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.

References p_tileLines, p_tileSamples, and p_tileSizeSet.

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

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

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

Parameters:

wrap

Specifies whether or not to wrap

Definition at line 98 of file ProcessByBrick.h.

References Isis::ProcessByBrick::p_wrapOption.

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

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

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

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

Parameters:

funct()

Name of your processing function

Definition at line 180 of file Process.h.

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

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

This method allows multiple input and output cubes.

Parameters:

funct

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

Isis::iException::Programmer

Reimplemented from Isis::ProcessByBrick.

Definition at line 130 of file ProcessByTile.cpp.

References _FILEINFO_, Isis::Process::InputCubes, Isis::iException::Message(), Isis::Process::OutputCubes, p_tileLines, p_tileSamples, Isis::ProcessByBrick::SetBrickSize(), and Isis::ProcessByBrick::StartProcess().

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

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

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

Parameters:

funct

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

Isis::iException::Programmer

Reimplemented from Isis::ProcessByBrick.

Definition at line 55 of file ProcessByTile.cpp.

References _FILEINFO_, Isis::Process::InputCubes, Isis::iException::Message(), Isis::Process::OutputCubes, p_tileLines, p_tileSamples, p_tileSizeSet, Isis::ProcessByBrick::SetBrickSize(), and Isis::ProcessByBrick::StartProcess().

void Isis::ProcessByTile::StartProcess ( void funct(Isis::Buffer &in) )

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

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

Parameters:

funct

(Isis::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:

Isis::iException::Programmer

Reimplemented from Isis::ProcessByBrick.

Definition at line 100 of file ProcessByTile.cpp.

References _FILEINFO_, Isis::Process::InputCubes, Isis::iException::Message(), p_tileLines, p_tileSamples, p_tileSizeSet, Isis::ProcessByBrick::SetBrickSize(), and Isis::ProcessByBrick::StartProcess().