Base class for all cube processing derivatives. More...

#include <Process.h>

Inheritance diagram for Isis::Process:

Collaboration diagram for Isis::Process:

Public Member Functions
	Process ()
	Constructs a Process Object. More...

virtual	~Process ()
	Destroys the Process Object. It will close all opened cubes. More...

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

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

virtual void	Finalize ()
	Cleans up by closing cubes and freeing memory for owned cubes. 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...

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

virtual void	SetInputCube (Isis::Cube *inCube)
	Set the InputCube vector to an opened Cube which was dynamically allocated. 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	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

Base class for all cube processing derivatives.

This is the core of the Isis system. Process, a very important base class is often used to derive new classes which process cubes in a systematic manner. Some of these derived classes include ProcessByLine, FilterProcess, RubberSheet, and Export. For history buffs, the Process class equates to DOCUBE in Isis 2.0 and DOIO in PICS. Essentially, this class manages much of the tedious programming work for cube i/o, user interaction, history, etc.

If you would like to see Process being used in implementation, see stats.cpp. For classes that inherit from Process, see ProcessByLine, FilterProcess, ProcessByBoxcar, RubberSheet, Export, or Import

A working application example of Process can be found in the stats class.

Author: 2002-06-21 Jeff Anderson

Constructor & Destructor Documentation

◆ Process()

Isis::Process::Process ( )

Constructs a Process Object.

◆ ~Process()

Isis::Process::~Process ( )

virtual

Destroys the Process Object. It will close all opened cubes.

Member Function Documentation

◆ AddInputCube()

void Isis::Process::AddInputCube	(	Cube *	cube,
		bool	owned = `true`
	)

◆ AddOutputCube()

void Isis::Process::AddOutputCube	(	Cube *	cube,
		bool	owned = `true`
	)

◆ BandStatistics()

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

inline

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

References p_bandStats.

◆ CalculateStatistics()

void Isis::Process::CalculateStatistics ( )

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.

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

Close owned cubes from the list and clear the list.

◆ ClearInputCubes()

void Isis::Process::ClearInputCubes ( )

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

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

◆ ClearOutputCubes()

void Isis::Process::ClearOutputCubes ( )

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

◆ CubeStatistics()

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

inline

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

References p_cubeStats.

◆ EndProcess()

void Isis::Process::EndProcess ( )

virtual

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

Deprecated:: Please use Finalize()

Reimplemented in Isis::ProcessImportPds, Isis::ProcessMosaic, Isis::ProcessByBrick, Isis::ProcessByBoxcar, Isis::ProcessByTile, Isis::ProcessGroundPolygons, and Isis::ProcessPolygons.

Referenced by Isis::ProcessByBoxcar::EndProcess().

◆ Finalize()

void Isis::Process::Finalize ( )

virtual

Cleans up by closing cubes and freeing memory for owned cubes.

Clears the lists for all cubes.

Reimplemented in Isis::ProcessImportPds, Isis::ProcessByBrick, Isis::ProcessByBoxcar, Isis::ProcessByTile, Isis::ProcessGroundPolygons, and Isis::ProcessPolygons.

Referenced by Isis::ProcessByBoxcar::Finalize().

◆ MissionData()

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

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.

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

◆ Progress()

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

inline

This method returns a pointer to a Progress object.

Returns: Progress*

References p_progress.

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

◆ PropagateHistory()

void Isis::Process::PropagateHistory ( const bool prop )

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.

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

◆ PropagateLabels() [1/2]

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

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.

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

◆ PropagateLabels() [2/2]

void Isis::Process::PropagateLabels ( const QString & cube )

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.

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 )

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.

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

◆ PropagatePolygons()

void Isis::Process::PropagatePolygons ( const bool prop )

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.

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

◆ PropagateTables() [1/2]

void Isis::Process::PropagateTables ( const bool prop )

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.

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

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.

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

◆ SetInputCube() [1/3]

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

virtual

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

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

Referenced by Isis::ProcessGroundPolygons::SetStatCubes().

◆ SetInputCube() [2/3]

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

virtual

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

Parameters

fname	Programmer specified work file. For example, "myfile.cub".
att	The cube attributes to use when opening the input cube.
requirements	Same as requirements on SetInputCube. See that method for more details. Defaults to 0

Returns: Cube*

Exceptions

Isis::iException::Message

Reimplemented in Isis::ProcessByBrick.

References _FILEINFO_, Isis::AllMatchOrOne, Isis::Cube::bandCount(), Isis::BandMatchOrOne, Isis::CubeAttributeInput::bands(), Isis::Cube::lineCount(), Isis::OneBand, Isis::Cube::open(), Isis::ReadWrite, Isis::Cube::sampleCount(), Isis::Cube::setVirtualBands(), Isis::SizeMatch, and Isis::SpatialMatch.

◆ SetInputCube() [3/3]

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

virtual

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.

References _FILEINFO_, and Isis::Cube::isOpen().

◆ SetOutputCube() [1/3]

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

virtual

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.

References _FILEINFO_.

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

◆ SetOutputCube() [2/3]

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

virtual

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

References _FILEINFO_.

◆ SetOutputCube() [3/3]

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

virtual

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

◆ StartProcess()

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

inlinevirtual

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

◆ WriteHistory()

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

Writes out the History blob to the cube.

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

protected

A vector of pointers to opened Cube objects.

The pointers are established in the SetInputCube/SetInputWorkCube methods.

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

◆ m_ownedCubes

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

protected

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.

◆ OutputCubes

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

protected

A vector of pointers to allocated Cube objects.

The pointers are established in the SetOutputCube method.

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

protected

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

Referenced by BandStatistics().

◆ p_cubeStats

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

protected

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

Referenced by CubeStatistics().

◆ p_progress

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

protected

Pointer to a Progress object.

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

◆ p_propagateHistory

bool Isis::Process::p_propagateHistory

protected

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

◆ p_propagateLabels

bool Isis::Process::p_propagateLabels

protected

Flag indicating if labels are be propagated to output cubes.

◆ p_propagateOriginalLabel

bool Isis::Process::p_propagateOriginalLabel

protected

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

◆ p_propagatePolygons

bool Isis::Process::p_propagatePolygons

protected

Flag indicating if blobs are be propagated to output cubes.

◆ p_propagateTables

bool Isis::Process::p_propagateTables

protected

Flag indicating if tables are be propagated to output cubes.

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

/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/base/objs/Process/Process.h
/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/base/objs/Process/Process.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Process()

◆ ~Process()

Member Function Documentation

◆ AddInputCube()

◆ AddOutputCube()

◆ BandStatistics()

◆ CalculateStatistics()

◆ ClearCubes()

◆ ClearInputCubes()

◆ ClearOutputCubes()

◆ CubeStatistics()

◆ EndProcess()

◆ Finalize()

◆ MissionData()

◆ Progress()

◆ PropagateHistory()

◆ PropagateLabels() [1/2]

◆ PropagateLabels() [2/2]

◆ PropagateOriginalLabel()

◆ PropagatePolygons()

◆ PropagateTables() [1/2]

◆ PropagateTables() [2/2]

◆ SetInputCube() [1/3]

◆ SetInputCube() [2/3]

◆ SetInputCube() [3/3]

◆ SetOutputCube() [1/3]

◆ SetOutputCube() [2/3]

◆ SetOutputCube() [3/3]

◆ StartProcess()

◆ WriteHistory()

Member Data Documentation

◆ InputCubes

◆ m_ownedCubes

◆ OutputCubes

◆ p_bandStats

◆ p_cubeStats

◆ p_progress

◆ p_propagateHistory

◆ p_propagateLabels

◆ p_propagateOriginalLabel

◆ p_propagatePolygons

◆ p_propagateTables