Isis::ProcessByBoxcar Class Reference
[High Level Cube I/O]

#include <ProcessByBoxcar.h>

Public Member Functions
	ProcessByBoxcar ()
	Constructs a ProcessByBoxcar object.
virtual	~ProcessByBoxcar ()
	Destroys the ProcessByBoxcar object.
void	SetBoxcarSize (const int ns, const int nl)
	Sets the boxcar size.
virtual void	StartProcess (void funct(Isis::Buffer &in, double &out))
	Starts the systematic processing of the input cube by moving a boxcar, p_boxSamples by p_boxLines, through the cube one pixel at a time.
void	ProcessCube (void funct(Isis::Buffer &in, double &out))
void	EndProcess ()
	End the boxcar processing sequence and cleans up by closing cubes, freeing memory, etc.
void	Finalize ()
	End the boxcar processing sequence and cleans up by closing cubes, freeing memory, etc.
virtual void	StartProcess (void funct())
	In the base class, this method will invoked a user-specified function exactly one time.
virtual Isis::Cube *	SetInputCube (const QString &parameter, const int requirements=0)
	Opens an input cube specified by the user and verifies requirements are met.
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.
virtual void	SetInputCube (Isis::Cube *inCube)
	Set the InputCube vector to an opened Cube which was dynamically allocated.
virtual Isis::Cube *	SetOutputCube (const QString &parameter)
	Allocates a user-specified output cube whose size matches the first input cube.
virtual Isis::Cube *	SetOutputCube (const QString &parameter, const int nsamps, const int nlines, const int nbands=1)
	Allocates a user specified output cube whose size is specified by the programmer.
virtual Isis::Cube *	SetOutputCube (const QString &fname, const Isis::CubeAttributeOutput &att, const int nsamps, const int nlines, const int nbands=1)
	Allocates a output cube whose name and size is specified by the programmer.
void	AddInputCube (Cube *cube, bool owned=true)
void	AddOutputCube (Cube *cube, bool owned=true)
void	ClearCubes ()
	Close owned cubes from the list and clear the list.
void	ClearInputCubes ()
	Close owned input cubes from the list and clear the list.
void	ClearOutputCubes ()
	Close owned output cubes from the list and clear the list.
void	PropagateLabels (const bool prop)
	This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes.
void	PropagateLabels (const QString &cube)
	This method allows the programmer to propagate labels from a specific secondary cube.
void	PropagateTables (const bool prop)
	This method allows the programmer to propagate input tables to the output cube (default is true).
void	PropagateTables (const QString &fromName)
	Propagate the tables from the cube with the given filename to the output cube.
void	PropagatePolygons (const bool prop)
	This method allows the programmer to propagate input blobs to the output cube (default is true).
void	PropagateHistory (const bool prop)
	This method allows the programmer to propagate history to the output cube (default is true).
void	PropagateOriginalLabel (const bool prop)
	This method allows the programmer to propagate original labels to the output cube (default is true).
Isis::Progress *	Progress ()
	This method returns a pointer to a Progress object.
QString	MissionData (const QString &mission, const QString &file, bool highestVersion=false)
	This method reads the mission specific data directory from the user preference file, makes sure that mission is available in the Isis installation, and the attaches the provided input file to the directory in order to create a full file specification.
void	WriteHistory (Cube &cube)
	Writes out the History blob to the cube.
void	CalculateStatistics ()
	Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method.
std::vector< Isis::Statistics * >	BandStatistics (const unsigned index)
	Get the vector of Statistics objects for each band separately of a specified input cube.
Isis::Statistics *	CubeStatistics (const unsigned index)
	Get the Statistics object for all bands of a specified input cube.
Protected Attributes
Isis::Progress *	p_progress
	Pointer to a Progress object.
bool	p_propagateLabels
	Flag indicating if labels are be propagated to output cubes.
bool	p_propagateTables
	Flag indicating if tables are be propagated to output cubes.
bool	p_propagatePolygons
	Flag indicating if blobs are be propagated to output cubes.
bool	p_propagateHistory
	Flag indicating if history is to be propagated to output cubes.
bool	p_propagateOriginalLabel
	Flag indicating if original lable is to be propagated to output cubes.
std::vector< std::vector < Isis::Statistics * > >	p_bandStats
	Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called.
std::vector< Isis::Statistics * >	p_cubeStats
	Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called.
std::vector< Isis::Cube * >	InputCubes
	A vector of pointers to opened Cube objects.
std::vector< Isis::Cube * >	OutputCubes
	A vector of pointers to allocated Cube objects.
QSet< Isis::Cube * > *	m_ownedCubes
	A list of cubes owned by this instant.

Detailed Description

Process cubes by boxcar.

This is the processing class used to move a boxcar through cube data. This class allows only one input cube and one output cube.

Author:: 2003-01-03 Tracie Sucharski

Constructor & Destructor Documentation

Isis::ProcessByBoxcar::ProcessByBoxcar ( ) [inline]

Constructs a ProcessByBoxcar object.

virtual Isis::ProcessByBoxcar::~ProcessByBoxcar ( ) [inline, virtual]

Destroys the ProcessByBoxcar object.

Member Function Documentation

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

References Isis::Process::InputCubes, and Isis::Process::m_ownedCubes.

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

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

References Isis::Process::m_ownedCubes, and Isis::Process::OutputCubes.

Referenced by Isis::ProcessPolygons::AppendOutputCube(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::ProcessMosaic::SetOutputCube(), Isis::ProcessMapMosaic::SetOutputCube(), and Isis::Process::SetOutputCube().

std::vector<Isis::Statistics *> Isis::Process::BandStatistics ( const unsigned index ) [inline, inherited]

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

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

Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method.

The newly calculated statistics are stored in two ways: as a vector where each entry is a single Statistics object for every band of a particular input cube, and as a vector where each entry is a vector of Statistics objects, for each band separately, of a particular input cube.

References Isis::Statistics::AddData(), Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), Isis::Process::InputCubes, Isis::Cube::lineCount(), Isis::Process::p_bandStats, Isis::Process::p_cubeStats, Isis::Cube::read(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), and Isis::toString().

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

Close owned cubes from the list and clear the list.

References Isis::Process::ClearInputCubes(), Isis::Process::ClearOutputCubes(), and Isis::Process::m_ownedCubes.

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

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

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

References Isis::Process::InputCubes, and Isis::Process::m_ownedCubes.

Referenced by Isis::Process::ClearCubes(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessGroundPolygons::SetStatCubes(), and Isis::ProcessMapMosaic::StartProcess().

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

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

References Isis::Process::m_ownedCubes, and Isis::Process::OutputCubes.

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

Isis::Statistics* Isis::Process::CubeStatistics ( const unsigned index ) [inline, inherited]

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

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

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

Deprecated:: Please use Finalize()

Reimplemented from Isis::Process.

void Isis::ProcessByBoxcar::Finalize ( ) [virtual]

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

Reimplemented from Isis::Process.

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.

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

void Isis::ProcessByBoxcar::ProcessCube ( void functIsis::Buffer &in, double &out ) [inline]

References StartProcess().

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

This method returns a pointer to a Progress object.

Returns:: Progress*

References Isis::Process::p_progress.

Referenced by Isis::Equalization::applyCorrection(), Isis::HiEqualization::calculateStatistics(), Isis::Equalization::calculateStatistics(), Isis::Process::Process(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::SpectralDefinition2D::SpectralDefinition2D(), 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.

References Isis::Process::p_propagateHistory.

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

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

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

Parameters:

cube

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

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

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.

References Isis::Process::p_propagateLabels.

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

References Isis::Process::p_propagateOriginalLabel.

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

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

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

Parameters:

prop

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

References Isis::Process::p_propagatePolygons.

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

void Isis::Process::PropagateTables ( const QString & fromName ) [inherited]

Propagate the tables from the cube with the given filename to the output cube.

This is done at the time this method is called, not during normal processing.

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

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.

References Isis::Process::p_propagateTables.

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

void Isis::ProcessByBoxcar::SetBoxcarSize	(	const int	ns,
		const int	nl
	)

Sets the boxcar size.

Parameters:

	ns	Number of samples
	nl	Number of lines

void Isis::Process::SetInputCube ( Isis::Cube * inCube ) [virtual, inherited]

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

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

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::Process::AddInputCube(), Isis::AllMatchOrOne, Isis::Cube::bandCount(), Isis::BandMatchOrOne, Isis::CubeAttributeInput::bands(), Isis::Process::InputCubes, Isis::Cube::lineCount(), Isis::OneBand, Isis::Cube::open(), Isis::ReadWrite, Isis::Cube::sampleCount(), Isis::Cube::setVirtualBands(), Isis::SizeMatch, Isis::SpatialMatch, and Isis::IException::User.

Isis::Cube * Isis::Process::SetInputCube	(	const QString &	parameter,
		const int	requirements = `0`
	)			`[virtual, 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

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

References IsisAml::GetFileName(), IsisAml::GetInputAttribute(), and Isis::Application::GetUserInterface().

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

Isis::Cube * Isis::Process::SetOutputCube	(	const QString &	fname,
		const Isis::CubeAttributeOutput &	att,
		const int	ns,
		const int	nl,
		const int	nb = `1`
	)			`[virtual, 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

Isis::Cube * Isis::Process::SetOutputCube	(	const QString &	parameter,
		const int	ns,
		const int	nl,
		const int	nb = `1`
	)			`[virtual, 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

References _FILEINFO_, IsisAml::GetFileName(), IsisAml::GetOutputAttribute(), Isis::Application::GetUserInterface(), Isis::IException::Programmer, and Isis::Process::SetOutputCube().

Isis::Cube * Isis::Process::SetOutputCube ( const QString & parameter ) [virtual, 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.

References _FILEINFO_, Isis::Process::InputCubes, and Isis::IException::Programmer.

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

virtual void Isis::Process::StartProcess ( void funct() ) [inline, virtual, 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

void Isis::ProcessByBoxcar::StartProcess ( void functIsis::Buffer &in, double &out ) [virtual]

Starts the systematic processing of the input cube by moving a boxcar, p_boxSamples by p_boxLines, through the cube one pixel at a time.

The input and output buffers contain a Boxcar of the size indicated in p_boxSamples and p_boxLines. The input and output cube must be initialized prior to calling this method.

Parameters:

funct

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

Exceptions:

Isis::IException::Programmer

References _FILEINFO_, Isis::BufferManager::begin(), Isis::Progress::CheckStatus(), Isis::BufferManager::end(), Isis::Process::InputCubes, Isis::BufferManager::next(), Isis::Process::OutputCubes, Isis::Process::p_progress, Isis::IException::Programmer, Isis::Progress::SetMaximumSteps(), and Isis::Buffer::size().

Referenced by ProcessCube().

void Isis::Process::WriteHistory ( Cube & cube ) [inherited]

Writes out the History blob to the cube.

References Isis::History::AddEntry(), Isis::iApp, Isis::Process::InputCubes, Isis::PvlContainer::isNamed(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Process::p_propagateHistory, and Isis::Cube::write().

Referenced by Isis::ImageImporter::import(), Isis::Process::SetOutputCube(), and Isis::ProcessMapMosaic::StartProcess().

Member Data Documentation

std::vector<Isis::Cube *> Isis::Process::InputCubes [protected, inherited]

A vector of pointers to opened Cube objects.

The pointers are established in the SetInputCube/SetInputWorkCube methods.

QSet<Isis::Cube *>* Isis::Process::m_ownedCubes [protected, inherited]

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.

Referenced by Isis::Process::AddInputCube(), Isis::Process::AddOutputCube(), Isis::Process::ClearCubes(), Isis::Process::ClearInputCubes(), Isis::Process::ClearOutputCubes(), Isis::Process::Process(), and Isis::Process::~Process().