Process cubes using a Filter Object. More...

#include <ProcessByQuickFilter.h>

Inheritance diagram for Isis::ProcessByQuickFilter:

Collaboration diagram for Isis::ProcessByQuickFilter:

Public Member Functions
	ProcessByQuickFilter ()
	Constructs a FilterProcess object.

virtual void	StartProcess (void funct(Isis::Buffer &in, Isis::Buffer &out, Isis::QuickFilter &filter))
	This method invokes the process on a line by line basis.

void	ProcessCube (void funct(Isis::Buffer &in, Isis::Buffer &out, Isis::QuickFilter &filter))

void	SetFilterParameters (int samples, int lines, double low=-DBL_MAX, double high=DBL_MAX, int minimum=0)
	This method allows the programmer to set the filter parameters.

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

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

virtual void	Finalize ()
	Cleans up by closing cubes and freeing memory for owned cubes.

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.

Private Member Functions
void	GetFilterParameters ()
	This method allows the user to input the filter parameters.

Private Attributes
bool	p_getParametersFromUser
	Flag to indicate whether or not to get parameters from the user

int	p_boxcarSamples
	Number of samples in the boxcar.

int	p_boxcarLines
	Number of lines in the boxcar.

int	p_minimum
	Minimum number of valid pixels in the sample-by-line boxcar in order for statistical computations to be valid.

double	p_low
	Minimum valid pixel value to include in statistical computations of the boxcar.

double	p_high
	Maximum valid pixel value to include in statistical computations of the boxcar.

Detailed Description

Process cubes using a Filter Object.

This class processes an entire cube using an Filter object. That is, it walks a Filter object line-by-line over an input cube. This allows for the development of programs which do spatial filters such as highpass, lowpass, and sharpen. Understanding the Filter class is essential in order to utilize this class. This class expects the user to define an NxM boxcar size. Using that information, a Filter object is created and loaded with the proper cube data in order to walk the NxM boxcar through the entire cube in a very efficient manner. Currently it is required that the following parameters be available in the application XML file: LINES - Defines the height of the boxcar to convolve over the cube SAMPLES - Defines the width of the boxcar to convoled over the cube MINIMUM - Defines the minimum number of pixels in the boxcar in order for statistics to be computed (see Filter class) LOW - Defines minimum valid pixel value to be included in statistics (see Filter class) HIGH - Defines maximum valid pixel value to be included in statistics (see Filter class)

If you would like to see ProcessByQuickFilter being used in implementation, see sharpen.cpp

Author: 2003-03-31 Jeff Anderson

History:

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

2003-06-02 Jeff Anderson - Fixed a bug where line unfolding at the bottom of the cube was always using band 1

2003-08-28 Jeff Anderson - Added SetFilterParameters method

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

2006-12-15 Jeff Anderson - Fixed bug for images with 1 line

2011-06-27 Jai Rideout and Steven Lambright - Now uses FilterCachingAlgorithm

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

2012-02-24 Steven Lambright - Added ProcessCube()

2015-01-15 Sasha Brownsberger - Added virtual keyword to StartProcess function to ensure successful inheritance between Process and its child classes. References #2215.

Definition at line 77 of file ProcessByQuickFilter.h.

Constructor & Destructor Documentation

Isis::ProcessByQuickFilter::ProcessByQuickFilter ( )

Constructs a FilterProcess object.

Definition at line 36 of file ProcessByQuickFilter.cpp.

References p_getParametersFromUser, and SetFilterParameters().

Member Function Documentation

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

inlineinherited

Get the vector of Statistics objects for each band separately of a specified input cube.

Parameters

index The index of the input cube in InputCubes

Returns: vector<Statistics*> A list of statistics ordered by band

Definition at line 283 of file Process.h.

References Isis::Process::p_bandStats.

void Isis::Process::CalculateStatistics ( )

inherited

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

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

Definition at line 721 of file Process.cpp.

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

void Isis::Process::ClearCubes ( )

inherited

Close owned cubes from the list and clear the list.

Definition at line 506 of file Process.cpp.

void Isis::Process::ClearInputCubes ( )

inherited

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

Definition at line 516 of file Process.cpp.

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

void Isis::Process::ClearOutputCubes ( )

inherited

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

Definition at line 530 of file Process.cpp.

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

inlineinherited

Get the Statistics object for all bands of a specified input cube.

Parameters

index The index of the input cube in InputCubes

Returns: Statistics* Collections of statistics gathered on all bands

Definition at line 297 of file Process.h.

References Isis::Process::p_cubeStats.

void Isis::Process::EndProcess ( )

virtualinherited

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

Deprecated:: Please use Finalize()

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

Definition at line 480 of file Process.cpp.

Referenced by Isis::ImageExporter::createWorldFile(), Isis::ProcessByBoxcar::EndProcess(), and Isis::FileTool::saveAsEnlargedCube().

void Isis::Process::Finalize ( )

virtualinherited

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.

Definition at line 488 of file Process.cpp.

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

void Isis::ProcessByQuickFilter::GetFilterParameters ( )

private

This method allows the user to input the filter parameters.

Definition at line 206 of file ProcessByQuickFilter.cpp.

References IsisAml::GetDouble(), IsisAml::GetInteger(), Isis::Application::GetUserInterface(), p_boxcarLines, p_boxcarSamples, p_high, p_low, and p_minimum.

Referenced by StartProcess().

QString Isis::Process::MissionData	(	const QString &	mission,
		const QString &	file,
		bool	highestVersion = `false`
	)

inherited

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

Parameters

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

Definition at line 666 of file Process.cpp.

References _FILEINFO_, and Isis::PvlObject::findGroup().

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

inlineinherited

This method returns a pointer to a Progress object.

Returns: Progress*

Definition at line 263 of file Process.h.

References Isis::Process::p_progress.

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

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

inherited

This method allows the programmer to propagate history to the output cube (default is true)

Parameters

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

Definition at line 635 of file Process.cpp.

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

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

inherited

This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes.

By default, propagation occurs automatically in the Process class when a call to either of the SetOutputCube methods is invoked. If the program * requires no propagation then utilize this method. This method can be invoked between successive calls of SetOutputCube so that some cube will have labels propagated while others will not.

Parameters

prop	Flag indicating if labels are be propagated to output cubes.

Definition at line 552 of file Process.cpp.

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

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

inherited

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

Parameters

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

Definition at line 563 of file Process.cpp.

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

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

inherited

This method allows the programmer to propagate original labels to the output cube (default is true)

Parameters

prop	Flag indicating if original labels is to be propagated to output cubes.

Definition at line 646 of file Process.cpp.

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

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

inherited

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

Parameters

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

Definition at line 625 of file Process.cpp.

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

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

inherited

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

Parameters

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

Definition at line 591 of file Process.cpp.

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

void Isis::Process::PropagateTables ( const QString & fromName )

inherited

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

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

Definition at line 600 of file Process.cpp.

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

void Isis::ProcessByQuickFilter::SetFilterParameters	(	int	samples,
		int	lines,
		double	low = `-DBL_MAX`,
		double	high = `DBL_MAX`,
		int	minimum = `0`
	)

This method allows the programmer to set the filter parameters.

If this method is not invoked then the parameters will be obtained from the user via the XML parameters indicate in the class description.

Parameters

samples	Number of samples in the boxcar. Must be odd.
lines	Number of lines in the boxcar. Must be odd.
low	Minimum valid pixel value to include in statistical computations of the boxcar. Defaults to -DBL_MAX
high	Maximum valid pixel value to include in statistical computations of the boxcar. Defaults to DBL_MAX
minimum	Minimum number of valid pixels in the sample-by-line boxcar in order for statistical computations to be valid. Defaults to 0

Definition at line 195 of file ProcessByQuickFilter.cpp.

References p_boxcarLines, p_boxcarSamples, p_getParametersFromUser, p_high, p_low, and p_minimum.

Referenced by ProcessByQuickFilter().

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

virtualinherited

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::ProcessBySpectra, and Isis::ProcessBySample.

Definition at line 243 of file Process.cpp.

Referenced by Isis::ImageExporter::addChannel(), Isis::FileTool::saveAsEnlargedCube(), and Isis::ProcessGroundPolygons::SetStatCubes().

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

virtualinherited

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.

Definition at line 82 of file Process.cpp.

References _FILEINFO_, Isis::Cube::bandCount(), Isis::CubeAttributeInput::bands(), Isis::Cube::lineCount(), Isis::Cube::open(), Isis::Cube::sampleCount(), and Isis::Cube::setVirtualBands().

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

virtualinherited

Set the InputCube vector to an opened Cube which was dynamically allocated.

This is used if there already exists a valid opened cube

Author: Sharmila Prasad (5/7/2011)

Parameters

inCube - Pointer to input Cube

Reimplemented in Isis::ProcessByLine.

Definition at line 201 of file Process.cpp.

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

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

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

virtualinherited

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

Returns: Cube*

Parameters

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

Exceptions

Isis::iException::Message

Definition at line 302 of file Process.cpp.

References _FILEINFO_.

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

virtualinherited

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

Returns: Cube*

Parameters

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

Exceptions

Isis::iException::Message

Definition at line 334 of file Process.cpp.

References _FILEINFO_, Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::AttachedLabel, Isis::CubeAttributeOutput::byteOrder(), Isis::Cube::create(), Isis::CubeAttributeOutput::fileFormat(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), Isis::PvlContainer::isNamed(), Isis::Cube::label(), Isis::Cube::labelSize(), Isis::CubeAttributeOutput::maximum(), Isis::CubeAttributeOutput::minimum(), Isis::PvlContainer::name(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::pixelType(), Isis::CubeAttributeOutput::pixelType(), Isis::CubeAttributeOutput::propagateMinimumMaximum(), Isis::CubeAttributeOutput::propagatePixelType(), Isis::Cube::setBaseMultiplier(), Isis::Cube::setByteOrder(), Isis::Cube::setDimensions(), Isis::Cube::setFormat(), Isis::Cube::setLabelsAttached(), Isis::Cube::setLabelSize(), Isis::Cube::setMinMax(), Isis::Cube::setPixelType(), and Isis::Cube::write().

void Isis::ProcessByQuickFilter::StartProcess ( void functIsis::Buffer &in, Isis::Buffer &out,Isis::QuickFilter &filter )

virtual

This method invokes the process on a line by line basis.

Parameters

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

Exceptions

Isis::IException::Programmer

Definition at line 49 of file ProcessByQuickFilter.cpp.

References _FILEINFO_, Isis::QuickFilter::AddLine(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), GetFilterParameters(), Isis::QuickFilter::HalfHeight(), Isis::Process::InputCubes, Isis::Process::OutputCubes, p_boxcarLines, p_boxcarSamples, p_getParametersFromUser, p_high, p_low, p_minimum, Isis::Process::p_progress, Isis::IException::Programmer, Isis::QuickFilter::RemoveLine(), Isis::QuickFilter::Reset(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::QuickFilter::SetMinimumPixels(), Isis::QuickFilter::SetMinMax(), and Isis::IException::User.

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

inlinevirtualinherited

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

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

Parameters

funct() Name of your processing function

Definition at line 221 of file Process.h.

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

inherited

Writes out the History blob to the cube.

Definition at line 687 of file Process.cpp.

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

Referenced by Isis::ImageImporter::import().

Member Data Documentation

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

protectedinherited

A vector of pointers to opened Cube objects.

The pointers are established in the SetInputCube/SetInputWorkCube methods.

Definition at line 193 of file Process.h.

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

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

protectedinherited

A list of cubes owned by this instant.

These cubes will be deleted on finalization. Process will not take ownership of cubes allocated outside of Process. It is the caller's responsibility to delete such cubes.

Definition at line 207 of file Process.h.

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

protectedinherited

A vector of pointers to allocated Cube objects.

The pointers are established in the SetOutputCube method.

Definition at line 199 of file Process.h.

Referenced by Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessImport::ProcessJp2(), and StartProcess().

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

protectedinherited

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

Definition at line 180 of file Process.h.

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

int Isis::ProcessByQuickFilter::p_boxcarLines

private

Number of lines in the boxcar.

Must be odd.

Definition at line 97 of file ProcessByQuickFilter.h.

Referenced by GetFilterParameters(), SetFilterParameters(), and StartProcess().

int Isis::ProcessByQuickFilter::p_boxcarSamples

private

Number of samples in the boxcar.

Must be odd.

Definition at line 95 of file ProcessByQuickFilter.h.

Referenced by GetFilterParameters(), SetFilterParameters(), and StartProcess().

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

protectedinherited

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

Definition at line 187 of file Process.h.

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

bool Isis::ProcessByQuickFilter::p_getParametersFromUser

private

 Flag to indicate whether or not to get

parameters from the user

Definition at line 93 of file ProcessByQuickFilter.h.

Referenced by ProcessByQuickFilter(), SetFilterParameters(), and StartProcess().

double Isis::ProcessByQuickFilter::p_high

private

                Maximum valid pixel value to include in

statistical computations of the boxcar.

Defaults to DBL_MAX

Definition at line 106 of file ProcessByQuickFilter.h.

Referenced by GetFilterParameters(), SetFilterParameters(), and StartProcess().

double Isis::ProcessByQuickFilter::p_low

private

                 Minimum valid pixel value to include in

statistical computations of the boxcar.

Defaults to DBL_MAX

Definition at line 103 of file ProcessByQuickFilter.h.

Referenced by GetFilterParameters(), SetFilterParameters(), and StartProcess().

int Isis::ProcessByQuickFilter::p_minimum

private

                Minimum number of valid pixels in the

sample-by-line boxcar in order for statistical computations to be valid.

Defaults to 0

Definition at line 99 of file ProcessByQuickFilter.h.

Referenced by GetFilterParameters(), SetFilterParameters(), and StartProcess().

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

protectedinherited

Pointer to a Progress object.

Definition at line 153 of file Process.h.

Referenced by Isis::ProcessExport::InitProcess(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessExport::ProcessExport(), Isis::ProcessImport::ProcessImport(), Isis::ProcessImport::ProcessJp2(), Isis::Process::Progress(), Isis::ProcessByBrick::RunProcess(), StartProcess(), and Isis::ProcessExport::StartProcess().

bool Isis::Process::p_propagateHistory

protectedinherited

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

Definition at line 169 of file Process.h.

bool Isis::Process::p_propagateLabels

protectedinherited

Flag indicating if labels are be propagated to output cubes.

Definition at line 157 of file Process.h.

bool Isis::Process::p_propagateOriginalLabel

protectedinherited

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

Definition at line 173 of file Process.h.

bool Isis::Process::p_propagatePolygons

protectedinherited

Flag indicating if blobs are be propagated to output cubes.

Definition at line 165 of file Process.h.

bool Isis::Process::p_propagateTables

protectedinherited

Flag indicating if tables are be propagated to output cubes.

Definition at line 161 of file Process.h.

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

src/base/objs/ProcessByQuickFilter/ProcessByQuickFilter.h
src/base/objs/ProcessByQuickFilter/ProcessByQuickFilter.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation