#include <ProcessByLine.h>

Inheritance diagram for Isis::ProcessByLine:

Collaboration diagram for Isis::ProcessByLine:

Public Types
enum	IOCubes { InPlace, InputOutput, InputOutputList }

enum	ProcessingDirection { LinesFirst, BandsFirst }

Public Member Functions
Isis::Cube *	SetInputCube (const QString &parameter, const int requirements=0)
	Opens an input cube specified by the user and verifies requirements are met. More...

Isis::Cube *	SetInputCube (const QString &file, Isis::CubeAttributeInput &att, const int requirements=0)
	Opens an input cube file specified by the user with cube attributes and requirements. More...

void	SetInputCube (Isis::Cube *inCube)
	Set the InputCube vector to an opened Cube. More...

void	StartProcess (void funct(Isis::Buffer &inout))
	This method invokes the process by line operation over a single input or output cube. More...

virtual void	StartProcess (std::function< void(Isis::Buffer &in)> funct)
	This method invokes the process by line operation over a single input or output cube. More...

void	StartProcess (void funct(Isis::Buffer &in, Isis::Buffer &out))
	This method invokes the process by line operation over exactly one input and one output cube. More...

void	StartProcess (void funct(std::vector< Isis::Buffer > &in, std::vector< Isis::Buffer > &out))
	This method invokes the process by line operation over multiple input and output cubes. More...

void	SetBricks (IOCubes cn)

template<typename Functor >
void	ProcessCubeInPlace (const Functor &funct, bool threaded=true)
	Same functionality as StartProcess(void funct(Isis::Buffer &inout)) using Functors. More...

template<typename Functor >
void	ProcessCube (const Functor &funct, bool threaded=true)
	Same functionality as StartProcess(void funct(Isis::Buffer &in, Isis::Buffer &out)) using Functors. More...

template<typename Functor >
void	ProcessCubes (const Functor &funct, bool threaded=true)
	Same functionality as StartProcess(std::vector<Isis::Buffer > &in, std::vector<Isis::Buffer > &out) using Functors. More...

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

virtual Isis::Cube *	SetInputCube (const QString &parameter, const int requirements=0)
	Opens an input cube specified by the user and verifies requirements are met. More...

void	VerifyCubes (IOCubes cn)
	Verifies the dimensions of the input/output cubes. More...

void	SetBrickSize (int ns, int nl, int nb)
	Sets the input and output bricks sizes to the given number of samples, lines, and bands. More...

void	SetInputBrickSize (int ns, int nl, int nb)
	Sets the size of all input bricks. More...

void	SetInputBrickSize (int ns, int nl, int nb, int cube)
	Sets the brick size of the specified cube. More...

void	SetOutputBrickSize (int ns, int nl, int nb)
	Sets the size of all output bricks. More...

void	SetOutputBrickSize (int ns, int nl, int nb, int cube)
	Sets the brick size of the specified output cube. More...

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

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

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

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

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

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

void	SetOutputRequirements (int outputRequirements)

void	SetWrap (bool wrap)
	This wrapping option only applys when there are two or more input cubes. More...

bool	Wraps ()
	Returns true if the wrapping option is enabled. More...

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

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

virtual void	StartProcess (std::function< void(Buffer &in, Buffer &out)> funct)
	Starts the systematic processing of the input cube by moving an arbitrary shaped brick through the cube. More...

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

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

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

void	EndProcess ()
	End the processing sequence and cleans up by closing cubes, freeing memory, etc. More...

void	Finalize ()
	Cleans up by closing cubes and freeing memory. More...

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

void	ClearInputCubes ()
	Close owned input cubes from the list and clear the list. More...

void	ClearOutputCubes ()
	Close owned output cubes from the list and clear the list. More...

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

void	PropagateLabels (const QString &cube)
	This method allows the programmer to propagate labels from a specific secondary cube. More...

void	PropagateTables (const bool prop)
	This method allows the programmer to propagate input tables to the output cube (default is true) More...

void	PropagateTables (const QString &fromName, const QList< QString > &tableNames=QList< QString >())
	Propagate the tables from the cube with the given filename to the output cube. More...

void	PropagatePolygons (const bool prop)
	This method allows the programmer to propagate input blobs to the output cube (default is true) More...

void	PropagateHistory (const bool prop)
	This method allows the programmer to propagate history to the output cube (default is true) More...

void	PropagateOriginalLabel (const bool prop)
	This method allows the programmer to propagate original labels to the output cube (default is true) More...

Isis::Progress *	Progress ()
	This method returns a pointer to a Progress object. More...

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

void	WriteHistory (Cube &cube)
	Writes out the History blob to the cube. More...

void	CalculateStatistics ()
	Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method. More...

std::vector< Isis::Statistics * >	BandStatistics (const unsigned index)
	Get the vector of Statistics objects for each band separately of a specified input cube. More...

Isis::Statistics *	CubeStatistics (const unsigned index)
	Get the Statistics object for all bands of a specified input cube. More...

Protected Attributes
Isis::Progress *	p_progress
	Pointer to a Progress object. More...

bool	p_propagateLabels
	Flag indicating if labels are be propagated to output cubes. More...

bool	p_propagateTables
	Flag indicating if tables are be propagated to output cubes. More...

bool	p_propagatePolygons
	Flag indicating if blobs are be propagated to output cubes. More...

bool	p_propagateHistory
	Flag indicating if history is to be propagated to output cubes. More...

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

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

std::vector< Isis::Statistics *>	p_cubeStats
	Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called. More...

std::vector< Isis::Cube * >	InputCubes
	A vector of pointers to opened Cube objects. More...

std::vector< Isis::Cube * >	OutputCubes
	A vector of pointers to allocated Cube objects. More...

QSet< Isis::Cube * > *	m_ownedCubes
	A list of cubes owned by this instant. More...

Detailed Description

Process cubes by line.

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

Here is an example of how to use ProcessByLine

using namespace std;
#include "Isis.h"
#include "ProcessByLine.h"
#include "SpecialPixel.h"
void mirror (Buffer &in, Buffer &out);
void IsisMain() {
  // We will be processing by line
  ProcessByLine p; // Setup the input and output cubes
  p.SetInputCube("FROM");
  p.SetOutputCube ("TO");
  // Start the processing
  p.StartProcess(mirror);
  p.EndProcess();
} .
// Line processing routine
void mirror (Buffer &in, Buffer &out) {
  // Loop and flip pixels in the line.
  int index = in.size() - 1;
  for (int i=0; i<in.size(); i++) {
    out[i] = in[index - i];
  }
}

If you would like to see ProcessByLine being used in implementation with multiple input cubes, see ratio.cpp

Author: 2003-02-13 Jeff Anderson

History:

2003-05-16 Stuart Sides - Modified schema from astrogeology... isis.astrogeology...

2003-08-29 Jeff Anderson - Fixed bug in StartProcess method for multiple inputs/outputs which require cubes to have the same number of lines and samples.

2004-07-15 Jeff Anderson - Modified to allow for a different number of samples in the output cube(s) than are in the input cube(s). This facilitates the ability to scale or concatenate in the sample direction.

2005-02-08 Elizabeth Ribelin - Modified file to support Doxygen 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

2006-03-29 Jacob Danton Rewrote code to extend ProcessByBrick class.

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

2015-09-25 Tyler Wilson - Combined SetBrickSizesForProcessCube, SetBrickSizesForProcessCubeInPlace, and SetBrickSizesForProcessCubes into one function:SetBricks(CubeNum) which takes in the enumerated date type enum as an argument (CubeNum = {InPlace, InputOutput, InputOutputList}). Also moved the verification of cubes out of the SetBrick functions and into ProcessByBrick:: VerifyCubes(CubeNum) in parent class.

2017-04-13 Kaj Williams - Fixed a minor typo in the API documentation. Fixed a few source code formatting issues.

Definition at line 113 of file ProcessByLine.h.

Member Function Documentation

◆ BandStatistics()

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

References Isis::Process::p_bandStats.

◆ CalculateStatistics()

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

◆ ClearCubes()

void Isis::Process::ClearCubes ( )

inherited

Close owned cubes from the list and clear the list.

Definition at line 509 of file Process.cpp.

◆ ClearInputCubes()

void Isis::Process::ClearInputCubes ( )

inherited

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

Definition at line 519 of file Process.cpp.

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

◆ ClearOutputCubes()

void Isis::Process::ClearOutputCubes ( )

inherited

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

Definition at line 533 of file Process.cpp.

◆ CubeStatistics()

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

References Isis::Process::p_cubeStats.

◆ EndProcess()

void Isis::ProcessByBrick::EndProcess ( )

virtualinherited

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

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

◆ Finalize()

void Isis::ProcessByBrick::Finalize ( )

virtualinherited

Cleans up by closing cubes and freeing memory.

Reimplemented from Isis::Process.

Reimplemented in Isis::ProcessByTile.

Definition at line 695 of file ProcessByBrick.cpp.

Referenced by Isis::SpectralDefinition2D::SpectralDefinition2D().

◆ GetProcessingDirection()

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

◆ MissionData()

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 682 of file Process.cpp.

References _FILEINFO_, Isis::FileName::expanded(), Isis::FileName::fileExists(), Isis::PvlObject::findGroup(), and Isis::FileName::highestVersion().

◆ ProcessCube()

template<typename Functor >

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

inline

Same functionality as StartProcess(void funct(Isis::Buffer &in, Isis::Buffer &out)) using Functors.

The Functor operator(), takes parameters (Isis::Buffer &, Isis::Buffer &)

Author: 2011-04-22 Sharmila Prasad

Parameters

funct	- Functor with overloaded operator()(Isis::Buffer &, Isis::Buffer &)
threaded

See also: ProcessByBrick::ProcessCube()

Definition at line 170 of file ProcessByLine.h.

References Isis::ProcessByBrick::ProcessCube(), and Isis::ProcessByBrick::VerifyCubes().

Referenced by Isis::Equalization::applyCorrection().

◆ ProcessCubeInPlace()

template<typename Functor >

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

inline

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

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

Author: 2011-04-22 Sharmila Prasad

Parameters

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

See also: ProcessByBrick::ProcessCubeInPlace()

Definition at line 150 of file ProcessByLine.h.

References Isis::ProcessByBrick::ProcessCubeInPlace(), and Isis::ProcessByBrick::VerifyCubes().

Referenced by Isis::Equalization::calculateBandStatistics(), Isis::ImageImporter::import(), and Isis::FileTool::saveAsReducedCube().

◆ ProcessCubes()

template<typename Functor >

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

inline

Same functionality as StartProcess(std::vector<Isis::Buffer *> &in, std::vector<Isis::Buffer *> &out) using Functors.

The Functor operator(), takes parameters (std::vector<Isis::Buffer *> &, std::vector<Isis::Buffer *> &)

Author: 2011-04-22 Sharmila Prasad

Parameters

funct	- Functor with overloaded operator() (Istd::vector<Isis::Buffer > &, std::vector<Isis::Buffer > &)
threaded

See also: ProcessByBrick::ProcessCubes()

Definition at line 191 of file ProcessByLine.h.

References Isis::ProcessByBrick::ProcessCubes(), and Isis::ProcessByBrick::VerifyCubes().

◆ Progress()

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

inlineinherited

This method returns a pointer to a Progress object.

Returns: Progress*

Definition at line 270 of file Process.h.

References Isis::Process::p_progress.

Referenced by Isis::Equalization::applyCorrection(), Isis::Equalization::calculateBandStatistics(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::ProcessMapMosaic::SetOutputCube(), and Isis::SpectralDefinition2D::SpectralDefinition2D().

◆ PropagateHistory()

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 651 of file Process.cpp.

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

◆ PropagateLabels() [1/2]

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 555 of file Process.cpp.

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

◆ PropagateLabels() [2/2]

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 566 of file Process.cpp.

References Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), and Isis::PvlObject::hasObject().

◆ PropagateOriginalLabel()

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 662 of file Process.cpp.

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

◆ PropagatePolygons()

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 641 of file Process.cpp.

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

◆ PropagateTables() [1/2]

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 594 of file Process.cpp.

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

◆ PropagateTables() [2/2]

void Isis::Process::PropagateTables	(	const QString &	fromName,
		const QList< QString > &	tableNames = `QList<QString>()`
	)

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. The names of the tables to propagate can be provided through the second paramter, by specifing a list of table names. Not providing any list (or providing an empty list) will propagate all tables.

Parameters

fromName	QString of the name of the cube containing the tables to propagate.
tableNames	List of QStrings of the names of the tables to propagate; default is empty, which indicates that all tables will be propagated.

History:: 2016-11-30 Ian Humphrey - Added tableNames parameter so that only specified tables will be propagated when calling this method. Note that a default of an empty QList is used to propagate all tables. References #4433.

Definition at line 614 of file Process.cpp.

References Isis::Cube::label(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::open(), and Isis::Cube::read().

◆ SetBrickSize()

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

◆ SetInputBrickSize() [1/2]

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

◆ SetInputBrickSize() [2/2]

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

References _FILEINFO_.

◆ SetInputCube() [1/5]

Isis::Cube * Isis::Process::SetInputCube

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 Use to specify requirements for the input file. The following are requirments are checked against 1) ic_base::SizeMatch checks to make sure the input cube has the same bands, samples, and lines as the first input cube open using this method, 2) ic_base::SpatialMatch checks to make sure the input cube has the same samples and lines as the first input cube, 3) ic_base::Georeferenced checks to make sure latitude/longitudes can be obtained from the input cube, 4) ic_base::FullyGeoreferenced checks to make sure latitude/longitude, phase/incidence/emission, and other geometric parameters can be obtained from the input cube, 5) ic_base::OneBand checks to make sure the input cube has exactly one band. Note, that these requirements can be logically or'ed. For example, ic_base::SpatialMatch | ic_base::georeferenced. Defaults to 0

Exceptions

Isis::iException::Message

Definition at line 243 of file Process.cpp.

◆ SetInputCube() [2/5]

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

◆ SetInputCube() [3/5]

Isis::Cube * Isis::ProcessByLine::SetInputCube	(	const QString &	parameter,
		const 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 ic_base::SpatialMatch which requires all input cubes to have the same number of samples and lines. It also added the requirement ic_base::BandMatchOrOne which forces 2nd, 3rd, 4th, etc input cubes to match the number of bands in the 1st input cube or to have exactly one band. For more information see Process::SetInputCube

Returns: Cube*

Parameters

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

Exceptions

Isis::iException::Message

Reimplemented from Isis::ProcessByBrick.

Definition at line 57 of file ProcessByLine.cpp.

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

◆ SetInputCube() [4/5]

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

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

For more information see Process::SetInputCube

Returns: Cube*

Parameters

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

Exceptions

Isis::iException::Message

Definition at line 80 of file ProcessByLine.cpp.

◆ SetInputCube() [5/5]

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

virtual

Set the InputCube vector to an opened Cube.

This is used if there already exists a valid opened cube

Author: 2011-05-07 Sharmila Prasad

Parameters

inCube - Pointer to input Cube

Reimplemented from Isis::Process.

Definition at line 97 of file ProcessByLine.cpp.

◆ SetOutputBrickSize() [1/2]

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

◆ SetOutputBrickSize() [2/2]

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

References _FILEINFO_.

◆ SetOutputCube() [1/4]

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

References Isis::Cube::lineCount().

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

◆ SetOutputCube() [2/4]

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

◆ SetOutputCube() [3/4]

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

◆ SetOutputCube() [4/4]

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

◆ SetProcessingDirection()

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

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

◆ SetWrap()

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

◆ StartProcess() [1/10]

void Isis::ProcessByLine::StartProcess ( void functIsis::Buffer &inout )

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

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

Deprecated:: Please use ProcessCubeInPlace()

Parameters

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

Exceptions

Isis::IException::Message

History:: 2005-02-28 Stuart Sides - Modified so cube that are opended ReadWrite will be written. Before only cube opened Write would be written.

Definition at line 159 of file ProcessByLine.cpp.

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

◆ StartProcess() [2/10]

void Isis::ProcessByLine::StartProcess ( std::function< void(Isis::Buffer &in)> funct )

virtual

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

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

Deprecated:: Please use ProcessCubeInPlace()

Parameters

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

Exceptions

Isis::IException::Message

History:: 2005-02-28 Stuart Sides - Modified so cube that are opended ReadWrite will be written. Before only cube opened Write would be written.

Definition at line 185 of file ProcessByLine.cpp.

◆ StartProcess() [3/10]

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

This method invokes the process by line operation over exactly one input and one output cube.

Typically, this method is used for simple operations such as stretching a cube or applying various operators to a cube (add constant, multiply by constant, etc).

Deprecated:: Please use ProcessCube()

Parameters

funct (Isis::Buffer &in, Isis::Buffer &out) Name of your processing function

Exceptions

Isis::IException::Message

Definition at line 204 of file ProcessByLine.cpp.

◆ StartProcess() [4/10]

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

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

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

Deprecated:: Please use ProcessCubes()

Parameters

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

Exceptions

Isis::iException::Message

Definition at line 222 of file ProcessByLine.cpp.

◆ StartProcess() [5/10]

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

virtualinherited

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

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

◆ StartProcess() [6/10]

void Isis::ProcessByBrick::StartProcess ( std::function< void(Buffer &in)> funct )

virtualinherited

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

Definition at line 494 of file ProcessByBrick.cpp.

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

◆ StartProcess() [7/10]

void Isis::ProcessByBrick::StartProcess ( std::function< void(Buffer &in, Buffer &out)> funct )

virtualinherited

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

Definition at line 577 of file ProcessByBrick.cpp.

References Isis::BufferManager::begin().

◆ StartProcess() [8/10]

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

virtualinherited

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

References Isis::BufferManager::begin().

◆ StartProcess() [9/10]

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

virtualinherited

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

◆ StartProcess() [10/10]

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

◆ VerifyCubes()

void Isis::ProcessByBrick::VerifyCubes ( IOCubes cn )

inherited

Verifies the dimensions of the input/output cubes.

Parameters

cn	An IOCubes enumeration for one of three possible Input/Output situations: InPlace: The input cube is the output cube InputOutput: One input cube and one output cube InputOutputList: A vector of input and output cubes. The input vector is not necessarily the same length as the output vector

Exceptions

iException::Message

Definition at line 136 of file ProcessByBrick.cpp.

References _FILEINFO_.

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

◆ Wraps()

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

Referenced by Isis::ProcessByBrick::ProcessCubes().

◆ WriteHistory()

void Isis::Process::WriteHistory ( Cube & cube )

inherited

Writes out the History blob to the cube.

Definition at line 703 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

◆ InputCubes

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

◆ m_ownedCubes

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

◆ OutputCubes

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

◆ p_bandStats

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

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

◆ p_cubeStats

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

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

◆ p_progress

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

protectedinherited

Pointer to a Progress object.

Definition at line 160 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().

◆ p_propagateHistory

bool Isis::Process::p_propagateHistory

protectedinherited

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

Definition at line 176 of file Process.h.

◆ p_propagateLabels

bool Isis::Process::p_propagateLabels

protectedinherited

Flag indicating if labels are be propagated to output cubes.

Definition at line 164 of file Process.h.

◆ p_propagateOriginalLabel

bool Isis::Process::p_propagateOriginalLabel

protectedinherited

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

Definition at line 180 of file Process.h.

◆ p_propagatePolygons

bool Isis::Process::p_propagatePolygons

protectedinherited

Flag indicating if blobs are be propagated to output cubes.

Definition at line 172 of file Process.h.

◆ p_propagateTables

bool Isis::Process::p_propagateTables

protectedinherited

Flag indicating if tables are be propagated to output cubes.

Definition at line 168 of file Process.h.

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

src/base/objs/ProcessByLine/ProcessByLine.h
src/base/objs/ProcessByLine/ProcessByLine.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ BandStatistics()

◆ CalculateStatistics()

◆ ClearCubes()

◆ ClearInputCubes()

◆ ClearOutputCubes()

◆ CubeStatistics()

◆ EndProcess()

◆ Finalize()

◆ GetProcessingDirection()

◆ MissionData()

◆ ProcessCube()

◆ ProcessCubeInPlace()

◆ ProcessCubes()

◆ Progress()

◆ PropagateHistory()

◆ PropagateLabels() [1/2]

◆ PropagateLabels() [2/2]

◆ PropagateOriginalLabel()

◆ PropagatePolygons()

◆ PropagateTables() [1/2]

◆ PropagateTables() [2/2]

◆ SetBrickSize()

◆ SetInputBrickSize() [1/2]

◆ SetInputBrickSize() [2/2]

◆ SetInputCube() [1/5]

◆ SetInputCube() [2/5]

◆ SetInputCube() [3/5]

◆ SetInputCube() [4/5]

◆ SetInputCube() [5/5]

◆ SetOutputBrickSize() [1/2]

◆ SetOutputBrickSize() [2/2]

◆ SetOutputCube() [1/4]

◆ SetOutputCube() [2/4]

◆ SetOutputCube() [3/4]

◆ SetOutputCube() [4/4]

◆ SetProcessingDirection()

◆ SetWrap()

◆ StartProcess() [1/10]

◆ StartProcess() [2/10]

◆ StartProcess() [3/10]

◆ StartProcess() [4/10]

◆ StartProcess() [5/10]

◆ StartProcess() [6/10]

◆ StartProcess() [7/10]

◆ StartProcess() [8/10]

◆ StartProcess() [9/10]

◆ StartProcess() [10/10]

◆ VerifyCubes()

◆ Wraps()

◆ WriteHistory()

Member Data Documentation

◆ InputCubes

◆ m_ownedCubes

◆ OutputCubes

◆ p_bandStats

◆ p_cubeStats

◆ p_progress

◆ p_propagateHistory

◆ p_propagateLabels

◆ p_propagateOriginalLabel

◆ p_propagatePolygons

◆ p_propagateTables