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

Mosaic two cubes together. More...

#include <ProcessMosaic.h>

Public Types
enum	ImageOverlay { PlaceImagesOnTop, PlaceImagesBeneath, UseBandPlacementCriteria, AverageImageWithMosaic, NumImageOverlayOptions }
	Enumeration for different Mosaic priorities (input, mosaic, band). More...
Public Member Functions
	ProcessMosaic ()
	Constructs a Mosaic object.
	~ProcessMosaic ()
	Destroys the Mosaic object. It will close all opened cubes.
void	StartProcess (const int &piOutSample, const int &piOutLine, const int &piOutBand)
	Line Processing method for one input and output cube.
PvlObject	imagePositions ()
	Accessor for the placed images.
Isis::Cube *	SetInputCube (const QString &parameter, const int ss=1, const int sl=1, const int sb=1, const int ns=-1, const int nl=-1, const int nb=-1)
	Set input cube to specified image name at the starting and count of samples, lines, bands.
Isis::Cube *	SetInputCube (const QString &fname, Isis::CubeAttributeInput &att, const int ss=1, const int sl=1, const int sb=1, const int ns=-1, const int nl=-1, const int nb=-1)
	Set input cube to specified image name with specified attributes at the starting and count of samples, lines, bands.
Isis::Cube *	SetOutputCube (const QString &psParameter)
	Set output cube to specified image name.
void	SetBandBinMatch (bool enforceBandBinMatch)
void	SetMosaicOrigin (int &piIndex)
	This method creates a table if not already created to hold the image file names if the track flag is true.
void	SetBandKeyword (QString bandPriorityKeyName, QString bandPriorityKeyValue)
	Set the keyword/value to use for comparing when using band priority.
void	SetBandNumber (int bandPriorityBandNumber)
	Set the band to use for priorities when using band priority.
void	SetBandUseMaxValue (bool useMax)
	Set whether to take the image with the max or min value when using band priority.
void	SetCreateFlag (bool createOutputMosaic)
	Flag to indicate that the mosaic is being newly created Indication that the new label specific to the mosaic needs to be created.
void	SetHighSaturationFlag (bool placeHighSatPixels)
	When true, high saturation (HRS, HIS) will be considered valid data for the purposes of placing pixels in the output mosaic.
void	SetImageOverlay (ImageOverlay placement)
void	SetLowSaturationFlag (bool placeLowSatPixels)
	When true, low saturation (LRS, LIS) will be considered valid data for the purposes of placing pixels in the output mosaic.
void	SetMatchDEM (bool matchDEM)
void	SetNullFlag (bool placeNullPixels)
	When true, Null pixels will be considered valid data for the purposes of placing pixels in the output mosaic.
void	SetTrackFlag (bool trackingEnabled)
bool	GetHighSaturationFlag () const
ImageOverlay	GetImageOverlay () const
bool	GetLowSaturationFlag () const
bool	GetNullFlag () const
bool	GetTrackFlag () const
int	GetInputStartLineInMosaic () const
	This is the line where the image was placed into the output mosaic.
int	GetInputStartSampleInMosaic () const
	This is the sample where the image was placed into the output mosaic.
int	GetInputStartBandInMosaic () const
	This is the band where the image was placed into the output mosaic.
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.
Isis::Cube *	SetInputCube (const QString &parameter, const int requirements=0)
	Opens an input cube specified by the user and verifies requirements are met.
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.
void	SetInputCube (Isis::Cube *inCube)
	Set the InputCube vector to an opened Cube which was dynamically allocated.
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.
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.
Static Public Member Functions
static QString	OverlayToString (ImageOverlay)
	Convert an ImageOverlay to a QString.
static ImageOverlay	StringToOverlay (QString)
	Convert a QString to an ImageOverlay (case-insensitive).
Static Public Attributes
static const char *	TRACKING_TABLE_NAME = "InputImages"
	This is the name of the table in the Cube which will contain the image file names.
static const int	FLOAT_STORE_INT_PRECISELY_MAX_VALUE = 16777216
static const int	FLOAT_STORE_INT_PRECISELY_MIN_VALUE = -16777215
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

Mosaic two cubes together.

This class allows a programmer to develop a program which merges two cubes together. The application sets the position where input (child) cube will be placed in the mosaic (parent) cube and priority. The Mosaic object will merge the overlapping area.

The process has four priorities (input, mosaic, band, average) for how the input image has to be placed on the mosaic. Priority "input" will place the input image on top of the mosaic. Priority "mosaic" will place the input image beneath the mosaic. Priority "band" will place the input image on the mosaic based on the "Lessser" or "Greater" criteria between user defined band in the input and the mosaic images. Priority Average will average of valid pixels in the input and mosaic images. Choosing this priority will cause the mosaic to have twice the number of bands of the input image,with a count band for each band. The count band keeps track of number of images involved in the dn value of the mosaic. In case of special pixels and the special pixel flags being enabled, the details for each priority is described below.

This class also has the ability to track the origin of the pixel by storing the input image names in a table and assigning an index to each unique image in the order they were placed on the mosaic. If the priority is input or mosaic then tracking is done only for single band input image. Band priority can track the origin for multiple bands based on a specified band based on the criteria (Lesser or Greater). The specified band can be a number or any keyword in the label.

There are also options to copy High and Low Saturation both for Instrument and Representation and Null DN values from the input to the mosaic. These options are valid for only input(top) and band priorities.

Following are the values for the origin band depending on the pixel type -------------------------------------------------------------- Pixel Type Default Start Value Max Value Total Images (Bits) (No Origin) Supported -------------------------------------------------------------- 32 -16777216 -16777215 16777216 33549932 16 -32768 -32767 32767 65535 8 0 1 255 255

Tags: F(FALSE), T(TRUE), V(VALID), S(SPECIAL PIXEL HS, LS, NULL), N(NULL), I(INPUT), M(MOSAIC), HL(HS,LS)

For priority=mosaic (beneath), the input is placed beneath the mosaic i.e. the input pixel will be copied to the mosaic only if the mosaic pixel is NULL. ------------------------ Input Mosaic Output ------------------------ V N I S,V HL,V M

For priority=input(on top), following is the criteria for pixel assignment: ------------------------------------- ---Options--- ---Images---- HS LS NULL Input Mosaic Output ------------------------------------- F F F V S,V I F F F S S,V M T OR T OR T V S,V I T OR T OR T S S,V I(H,L,N)

For priority=band, following is the criteria for pixel assignment: ----------------------------------------------------- ---Options--- ---Images---- HS LS NULL Input Mosaic Output ----------------------------------------------------- F F F V V Criteria based F F F V S I F F F S S,V M T OR T OR T S S,V I(H,L,N) T OR T OR T V V Criteria based T OR T OR T V S I

For priority=average, following is the criteria for pixel assignment: ----------------------------------------------------- ---Options--- ---Images---- HS LS NULL Input Mosaic Output Count ----------------------------------------------------- F F F V V Average count++ F F F V S I 1 F F F S S M 0 F F F S V M count T OR T OR T S S,V I(H,L,N) 0 T OR T OR T V V Average count++ T OR T OR T V S I 1

Author:: 2003-04-28 Stuart Sides

Member Enumeration Documentation

enum Isis::ProcessMosaic::ImageOverlay

Enumeration for different Mosaic priorities (input, mosaic, band).

Enumerator:

PlaceImagesOnTop	ontop priority
PlaceImagesBeneath	beneath priority
UseBandPlacementCriteria	band priority
AverageImageWithMosaic	average priority
NumImageOverlayOptions

Constructor & Destructor Documentation

Isis::ProcessMosaic::ProcessMosaic ( )

Constructs a Mosaic object.

ProcessMosaic Contructor.

Initialize the class members to default

References PlaceImagesOnTop, and SetBandBinMatch().

Isis::ProcessMosaic::~ProcessMosaic ( )

Destroys the Mosaic object. It will close all opened cubes.

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(), 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(), cube, Isis::Buffer::DoubleBuffer(), Isis::Process::InputCubes, line, 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::SetOutputCube(), Isis::ProcessGroundPolygons::SetOutputCube(), 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::Process::EndProcess ( ) [virtual, inherited]

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

Deprecated:: Please use Finalize()

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

References Isis::Process::Finalize().

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

void Isis::Process::Finalize ( ) [virtual, inherited]

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

Clears the lists for all cubes.

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

References Isis::Process::ClearCubes().

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

bool Isis::ProcessMosaic::GetHighSaturationFlag ( ) const

See also:: SetHighSaturationFlag()

ProcessMosaic::ImageOverlay Isis::ProcessMosaic::GetImageOverlay ( ) const

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

int Isis::ProcessMosaic::GetInputStartBandInMosaic ( ) const

This is the band where the image was placed into the output mosaic.

int Isis::ProcessMosaic::GetInputStartLineInMosaic ( ) const

This is the line where the image was placed into the output mosaic.

int Isis::ProcessMosaic::GetInputStartSampleInMosaic ( ) const

This is the sample where the image was placed into the output mosaic.

bool Isis::ProcessMosaic::GetLowSaturationFlag ( ) const

See also:: SetLowSaturationFlag()

bool Isis::ProcessMosaic::GetNullFlag ( ) const

See also:: SetNullFlag()

bool Isis::ProcessMosaic::GetTrackFlag ( ) const

See also:: SetTrackFlag()

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

PvlObject Isis::ProcessMosaic::imagePositions ( )

Accessor for the placed images.

Accessor for the placed images and their locations.

Returns:: The list of placed images

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

QString Isis::ProcessMosaic::OverlayToString ( ImageOverlay imageOverlay ) [static]

Convert an ImageOverlay to a QString.

This is used to translate between mapmos, handmos, and automos' interfaces into an ImageOverlay.

References _FILEINFO_, AverageImageWithMosaic, NumImageOverlayOptions, PlaceImagesBeneath, PlaceImagesOnTop, Isis::toString(), Isis::IException::Unknown, and UseBandPlacementCriteria.

Referenced by StringToOverlay().

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::SetOutputCube(), and Isis::ProcessMapMosaic::StartProcess().

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

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

Parameters:

prop

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

References Isis::Process::p_propagateHistory.

Referenced by 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(), g, 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::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::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::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::SetOutputCube().

void Isis::ProcessMosaic::SetBandBinMatch ( bool enforceBandBinMatch )

Referenced by ProcessMosaic().

void Isis::ProcessMosaic::SetBandKeyword	(	QString	bandPriorityKeyName,
		QString	bandPriorityKeyValue
	)

Set the keyword/value to use for comparing when using band priority.

void Isis::ProcessMosaic::SetBandNumber ( int bandPriorityBandNumber )

Set the band to use for priorities when using band priority.

void Isis::ProcessMosaic::SetBandUseMaxValue ( bool useMax )

Set whether to take the image with the max or min value when using band priority.

void Isis::ProcessMosaic::SetCreateFlag ( bool createOutputMosaic )

Flag to indicate that the mosaic is being newly created Indication that the new label specific to the mosaic needs to be created.

Author:: Sharmila Prasad (1/19/2011)

Parameters:

createOutputMosaic

- Set Create Flag True/False

void Isis::ProcessMosaic::SetHighSaturationFlag ( bool placeHighSatPixels )

When true, high saturation (HRS, HIS) will be considered valid data for the purposes of placing pixels in the output mosaic.

void Isis::ProcessMosaic::SetImageOverlay ( ImageOverlay placement )

void Isis::Process::SetInputCube ( Isis::Cube * inCube ) [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`
	)			`[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(), cube, 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`
	)			`[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::SetOutputCube().

Cube * Isis::ProcessMosaic::SetInputCube	(	const QString &	fname,
		Isis::CubeAttributeInput &	att,
		const int	ss = `1`,
		const int	sl = `1`,
		const int	sb = `1`,
		const int	ns = `-1`,
		const int	nl = `-1`,
		const int	nb = `-1`
	)

Set input cube to specified image name with specified attributes at the starting and count of samples, lines, bands.

Opens an input cube specified by the user.

This method is overloaded and adds the requirement that only one input cube can be specified.

Returns:: Cube*

Parameters:

	fname
	att
	ss	The starting sample within the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to 1
	sl	The starting line within the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to 1
	sb	The starting band within the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to 1
	ns	The number of samples from the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to number of samples in the cube
	nl	The number of lines from the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to number of lines in the cube
	nb	The number of bands from the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to number of bands in the cube

Exceptions:

IException

References _FILEINFO_, Isis::PvlObject::FindGroup(), Isis::Process::InputCubes, Isis::IException::Programmer, SetInputCube(), Isis::toInt(), and Isis::PvlObject::Traverse.

Cube * Isis::ProcessMosaic::SetInputCube	(	const QString &	parameter,
		const int	ss = `1`,
		const int	sl = `1`,
		const int	sb = `1`,
		const int	ns = `-1`,
		const int	nl = `-1`,
		const int	nb = `-1`
	)

Set input cube to specified image name at the starting and count of samples, lines, bands.

Opens an input cube specified by the user.

This method is overloaded and adds the requirement that only one input cube can be specified.

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".
	ss	The starting sample within the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to 1
	sl	The starting line within the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to 1
	sb	The starting band within the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to 1
	ns	The number of samples from the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to number of samples in the cube
	nl	The number of lines from the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to number of lines in the cube
	nb	The number of bands from the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to number of bands in the cube

Exceptions:

IException::Message

References _FILEINFO_, Isis::PvlObject::FindGroup(), Isis::Process::InputCubes, Isis::IException::Programmer, Isis::toInt(), and Isis::PvlObject::Traverse.

Referenced by SetInputCube().

void Isis::ProcessMosaic::SetLowSaturationFlag ( bool placeLowSatPixels )

When true, low saturation (LRS, LIS) will be considered valid data for the purposes of placing pixels in the output mosaic.

void Isis::ProcessMosaic::SetMatchDEM ( bool matchDEM )

void Isis::ProcessMosaic::SetMosaicOrigin ( int & index )

This method creates a table if not already created to hold the image file names if the track flag is true.

If table exists, checks if the image already exists and if it does not, then adds the new image file name. If the field size is smaller than the new image name, then it resizes all the records to new file size. When the table is newly created,it resets the origin band to default based on pixel type.

Parameters:

index

- the input file index

Returns:: none

Exceptions:

	an	exception if the number of images exceeds the pixel size.
	iException::Message

Author:: Sharmila Prasad (8/28/2009)

References _FILEINFO_, Isis::SerialNumber::Compose(), Isis::PvlObject::FindGroup(), Isis::PvlObject::FindKeyword(), FLOAT_STORE_INT_PRECISELY_MAX_VALUE, FLOAT_STORE_INT_PRECISELY_MIN_VALUE, Isis::PvlObject::HasKeyword(), Isis::PvlObject::HasObject(), Isis::Process::InputCubes, Isis::PvlObject::Object(), Isis::PvlObject::Objects(), Isis::Process::OutputCubes, Isis::IException::Programmer, Isis::Table::Records(), Isis::TableField::Text, Isis::toInt(), TRACKING_TABLE_NAME, Isis::PvlObject::Traverse, Isis::VALID_MAX1, Isis::VALID_MAX2, and Isis::VALID_MIN2.

Referenced by StartProcess().

void Isis::ProcessMosaic::SetNullFlag ( bool placeNullPixels )

When true, Null pixels will be considered valid data for the purposes of placing pixels in the output mosaic.

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

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

Returns:: Cube*

Parameters:

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

Exceptions:

Isis::iException::Message

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

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

Returns:: Cube*

Parameters:

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

Exceptions:

Isis::iException::Message

Reimplemented in Isis::ProcessPolygons.

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

Cube * Isis::ProcessMosaic::SetOutputCube ( const QString & psParameter )

Set output cube to specified image name.

Opens an output cube specified by the user.

This method is overloaded and adds the requirement that only one output cube can be specified. The output cube must exist before calling SetOutputCube.

Returns:: Cube*

Parameters:

psParameter

User parameter to obtain file to open. Typically, the value is "TO". For example, the user can specify on the command line TO=mosaic.cub and this method will attempt to open the cube "mosaic.cub" if the parameter was set to "TO". .

Exceptions:

IException::Message

Reimplemented from Isis::Process.

Reimplemented in Isis::ProcessMapMosaic.

References _FILEINFO_, Isis::Process::AddOutputCube(), cube, Isis::PvlObject::FindObject(), IsisAml::GetFileName(), Isis::Application::GetUserInterface(), Isis::Cube::label(), Isis::Cube::open(), Isis::Process::OutputCubes, and Isis::IException::Programmer.

void Isis::ProcessMosaic::SetTrackFlag ( bool trackingEnabled )

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

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

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

Parameters:

funct()

Name of your processing function

void Isis::ProcessMosaic::StartProcess	(	const int &	os,
		const int &	ol,
		const int &	ob
	)

Line Processing method for one input and output cube.

This method invokes the process by mosaic operation over a single input cube and single output cube.

Unlike other Isis process objects, no application . function will be called. The processing is handled entirely within the mosaic object. The input cube must be pixel aligned with the output cube before mosaiking. If the input cube does not overlay any of the output cube, no processing takes place. There are 3 priorities input, mosaic and band. Has the ability to track the origin of the mosaic if the flag is set. Some conditions apply like tracking turned off for multiband input with input or mosaic priority.

Parameters:

	os	The sample position of input cube starting sample relative to the output cube. The cordinate is in output cube space and may be any integer value negative or positive.
	ol	The line position of input cube starting line relative to the output cube. The cordinate is in output cube space and may be any integer value negative or positive.
	ob	The band position of input cube starting band relative to the output cube. The cordinate is in output cube space and must be a legal band number within the output cube.

Exceptions:

IException::Message

Author:: Sharmila Prasad (8/25/2009)

References _FILEINFO_, AverageImageWithMosaic, Isis::Progress::CheckStatus(), Isis::PvlObject::FindObject(), inl, Isis::Process::InputCubes, Isis::IsHighPixel(), Isis::IsLowPixel(), Isis::IsNullPixel(), Isis::IsValidPixel(), Isis::Process::OutputCubes, Isis::Process::p_progress, PlaceImagesBeneath, PlaceImagesOnTop, Isis::IException::Programmer, Isis::Progress::SetMaximumSteps(), SetMosaicOrigin(), Isis::Portal::SetPosition(), Isis::Buffer::size(), Isis::toString(), UseBandPlacementCriteria, and Isis::IException::User.

ProcessMosaic::ImageOverlay Isis::ProcessMosaic::StringToOverlay ( QString imageOverlayString ) [static]

Convert a QString to an ImageOverlay (case-insensitive).

This is used to translate between mapmos, handmos, and automos' interfaces into an ImageOverlay.

References _FILEINFO_, NumImageOverlayOptions, OverlayToString(), and Isis::IException::Unknown.

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::Process::SetOutputCube(), and Isis::ProcessMapMosaic::StartProcess().

Member Data Documentation

const int Isis::ProcessMosaic::FLOAT_STORE_INT_PRECISELY_MAX_VALUE = 16777216 [static]

Referenced by SetMosaicOrigin().

const int Isis::ProcessMosaic::FLOAT_STORE_INT_PRECISELY_MIN_VALUE = -16777215 [static]

Referenced by SetMosaicOrigin().

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.

Referenced by Isis::Process::AddInputCube(), Isis::Process::CalculateStatistics(), Isis::Process::ClearInputCubes(), Isis::ProcessExport::CreateWorldFile(), Isis::ProcessExport::GetBuffersBIL(), Isis::ProcessExport::GetBuffersBIP(), Isis::ProcessExport::GetBuffersBSQ(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessExport::ProcessCubes(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessRubberSheet::processPatchTransform(), Isis::ProcessByBrick::SetBrickSize(), Isis::ProcessByBrick::SetInputBrickSize(), SetInputCube(), Isis::Process::SetInputCube(), Isis::ProcessExport::SetInputRange(), SetMosaicOrigin(), Isis::ProcessGroundPolygons::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::ProcessRubberSheet::StartProcess(), StartProcess(), Isis::ProcessMapMosaic::StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBoxcar::StartProcess(), Isis::ProcessByLine::VerifyCubeInPlace(), Isis::ProcessByLine::VerifyCubeIO(), Isis::ProcessByLine::VerifyCubeIOList(), and Isis::Process::WriteHistory().

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