USGS Astrogeology Isis API

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 the Mosaic object will merge the overlapping area.

Definition at line 65 of file ProcessMosaic.h.


Public Member Functions
	ProcessMosaic ()
	Constructs a Mosaic object.
	~ProcessMosaic ()
	Destroys the Mosaic object. It will close all opened cubes.
void	StartProcess (const int &outputSample, const int &outputLine, const int &outputBand, const MosaicPriority &priority)
	This method invokes the process by mosaic operation over a single input cube and single output cube.
Isis::Cube *	SetInputCube (const std::string &parameter, const int ss=1, const int sl=1, const int sb=1, const int ns=0, const int nl=0, const int nb=0)
	Opens an input cube specified by the user.
Isis::Cube *	SetInputCube (const std::string &fname, Isis::CubeAttributeInput &att, const int ss=1, const int sl=1, const int sb=1, const int ns=0, const int nl=0, const int nb=0)
	Opens an input cube specified by the user.
Isis::Cube *	SetOutputCube (const std::string &parameter)
	Opens an output cube specified by the user.
void	SetBandBinMatch (bool b)
	Sets the bandbin match parameter to the input boolean value.
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.
Isis::Cube *	SetInputCube (const std::string &parameter, const int requirements=0)
	Opens an input cube specified by the user and verifies requirements are met.
Isis::Cube *	SetInputCube (const std::string &fname, const Isis::CubeAttributeInput &att, int requirements=0)
	Opens an input cube specified by the programmer and verifies requirements are met.
void	ClearInputCubes ()
	This method clears the input cube list.
Isis::Cube *	SetOutputCube (const std::string &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 std::string &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	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 std::string &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	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.
std::string	MissionData (const std::string &mission, const std::string &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.
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< Isis::Cube * >	InputCubes
	A vector of pointers to opened Cube objects.
std::vector< Isis::Cube * >	OutputCubes
	A vector of pointers to allocated Cube objects.
Private Attributes
int	p_iss
	The starting sample within the input cube.
int	p_isl
	The starting line within the input cube.
int	p_isb
	The starting band within the input cube.
int	p_ins
	The number of samples from the input cube.
int	p_inl
	The number of lines from the input cube.
int	p_inb
	The number of bands from the input cube.
bool	p_bandbinMatch
	True/False value to determine whether to enforce the input cube bandbin matches the mosaic bandbin group.

Constructor & Destructor Documentation

Isis::ProcessMosaic::ProcessMosaic ( ) [inline]

Constructs a Mosaic object.

Definition at line 70 of file ProcessMosaic.h.

References SetBandBinMatch().

Isis::ProcessMosaic::~ProcessMosaic ( ) [inline]

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

Definition at line 73 of file ProcessMosaic.h.

Member Function Documentation

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

This method clears the input cube list.

It is most commonly used in applications which need to generate an output cube without an input cube, however, propogation of input characteristics are known. For example, creating the initial cube for a mosaic.

Definition at line 579 of file Process.cpp.

References Isis::Process::InputCubes.

Referenced by Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessGroundPolygons::SetOutputCube(), and Isis::ProcessMapMosaic::StartProcess().

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

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

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

Definition at line 444 of file Process.cpp.

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

Referenced by Isis::ProcessPolygons::EndProcess(), Isis::ProcessImportPds::EndProcess(), Isis::ProcessByBrick::EndProcess(), Isis::ProcessByBoxcar::EndProcess(), and Isis::Process::~Process().

string Isis::Process::MissionData	(	const std::string &	mission,
		const std::string &	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 555 of file Process.cpp.

References _FILEINFO_, Isis::Filename::Exists(), Isis::Filename::Expanded(), Isis::PvlObject::FindGroup(), Isis::Filename::HighestVersion(), Isis::iException::Message(), and Isis::Preference::Preferences().

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

This method returns a pointer to a Progress object.

Returns:: Progress*

Definition at line 211 of file Process.h.

References Isis::Process::p_progress.

Referenced by 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.

Definition at line 524 of file Process.cpp.

References Isis::Process::p_propagateHistory.

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

void Isis::Process::PropagateLabels ( const std::string & 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 482 of file Process.cpp.

References Isis::PvlObject::AddGroup(), g, incube, Isis::Process::OutputCubes, and pvl().

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

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.

Definition at line 535 of file Process.cpp.

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.

Definition at line 514 of file Process.cpp.

References Isis::Process::p_propagatePolygons.

Referenced by 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 503 of file Process.cpp.

References Isis::Process::p_propagateTables.

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

void Isis::ProcessMosaic::SetBandBinMatch ( bool b ) [inline]

Sets the bandbin match parameter to the input boolean value.

Parameters:

The boolean value to set the bandbin match parameter to

Definition at line 98 of file ProcessMosaic.h.

References p_bandbinMatch.

Referenced by ProcessMosaic().

Isis::Cube * Isis::Process::SetInputCube	(	const std::string &	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.

Definition at line 72 of file Process.cpp.

References _FILEINFO_, Isis::AllMatchOrOne, Isis::BandMatchOrOne, Isis::Cube::Bands(), Isis::CubeAttributeInput::Bands(), cube, e, Isis::Process::InputCubes, Isis::Cube::Lines(), Isis::iException::Message(), Isis::OneBand, Isis::Cube::Open(), Isis::ReadWrite, Isis::Cube::Samples(), Isis::Cube::SetVirtualBands(), Isis::SizeMatch, and Isis::SpatialMatch.

Isis::Cube * Isis::Process::SetInputCube	(	const std::string &	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.

Definition at line 214 of file Process.cpp.

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

Referenced by SetInputCube(), Isis::ProcessBySample::SetInputCube(), Isis::ProcessByLine::SetInputCube(), Isis::ProcessByBrick::SetInputCube(), and Isis::ProcessGroundPolygons::SetOutputCube().

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

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:

Isis::iException::Message

Definition at line 291 of file ProcessMosaic.cpp.

References _FILEINFO_, Isis::Process::InputCubes, Isis::iException::Message(), p_inb, p_inl, p_ins, p_isb, p_isl, p_iss, and Isis::Process::SetInputCube().

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

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:

Isis::iException::Message

Definition at line 234 of file ProcessMosaic.cpp.

References _FILEINFO_, Isis::Process::InputCubes, Isis::iException::Message(), p_inb, p_inl, p_ins, p_isb, p_isl, p_iss, and Isis::Process::SetInputCube().

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

Isis::Cube * Isis::Process::SetOutputCube	(	const std::string &	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

Definition at line 305 of file Process.cpp.

Isis::Cube * Isis::Process::SetOutputCube	(	const std::string &	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.

Definition at line 273 of file Process.cpp.

References _FILEINFO_, IsisAml::GetFilename(), IsisAml::GetOutputAttribute(), Isis::Application::GetUserInterface(), Isis::iException::Message(), and Isis::Process::SetOutputCube().

Isis::Cube * Isis::ProcessMosaic::SetOutputCube ( const std::string & parameter )

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:

parameter

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:

Isis::iException::Message

Reimplemented from Isis::Process.

Reimplemented in Isis::ProcessMapMosaic.

Definition at line 326 of file ProcessMosaic.cpp.

References _FILEINFO_, cube, e, IsisAml::GetFilename(), Isis::Application::GetUserInterface(), Isis::iException::Message(), Isis::Cube::Open(), and Isis::Process::OutputCubes.

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

Definition at line 180 of file Process.h.

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

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 and no errors are thrown.

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.
	priority	This parameter determines which cube takes priority when both the input and output cubes contain non null data. There ara two possible values (input and mosaic). When this parameter is set to input all non null pixels will be transfered to the mosaic. Null pixels will not be transfered. When this parameter is set to mosaic input pixel values will only be transfered to the mosaic when the mosaic contains a null value.