USGS Astrogeology Isis API

This is the processing class for geometric transformations of cube data. Objects of this class can be used to apply rubber sheet transformations from one space to another, such as converting from one map projection to another or from instrument space to ground space. Each pixel position in the output cube will be processed by querying a transformer to find what input pixel should be used and an interpolator to find the value of the pixel. Any application using this class must supply a Transform object and an Interpolator object. This class allows only one input cube and one output cube.

Definition at line 94 of file ProcessRubberSheet.h.


Public Member Functions
	ProcessRubberSheet (int startSize=128, int endSize=8)
	Constructs a RubberSheet object.
	~ProcessRubberSheet ()
	Destroys the RubberSheet object.
void	StartProcess (Isis::Transform &trans, Isis::Interpolator &interp)
	Applies a Transform and an Interpolator to every pixel in the output cube.
void	BandChange (void(*funct)(const int band))
	Registers a function to be called when the current output cube band number changes.
void	ForceTile (double Samp, double Line)
void	SetTiling (int start, int end)
	This sets the start and end tile sizes for the rubber sheet; numbers are inclusive and must be powers of 2.
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)
	Allocates a user-specified output cube whose size matches the first input cube.
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 Member Functions
void	ProcessQuad (std::vector< Quad * > &quadTree, Isis::Transform &trans, std::vector< std::vector< double > > &lineMap, std::vector< std::vector< double > > &sampMap)
void	SplitQuad (std::vector< Quad * > &quadTree)
void	SlowQuad (std::vector< Quad * > &quadTree, Isis::Transform &trans, std::vector< std::vector< double > > &lineMap, std::vector< std::vector< double > > &sampMap)
double	Det4x4 (double m[4][4])
double	Det3x3 (double m[3][3])
void	SlowGeom (Isis::TileManager &otile, Isis::Portal &iportal, Isis::Transform &trans, Isis::Interpolator &interp)
void	QuadTree (Isis::TileManager &otile, Isis::Portal &iportal, Isis::Transform &trans, Isis::Interpolator &interp, bool useLastTileMap)
bool	TestLine (Isis::Transform &trans, int ssamp, int esamp, int sline, int eline, int increment)
	This function walks a line (or rectangle) and tests a point every increment pixels.
Private Attributes
void(*	p_bandChangeFunct )(const int band)
std::vector< std::vector< double > >	p_sampMap
std::vector< std::vector< double > >	p_lineMap
double	p_forceSamp
double	p_forceLine
int	p_startQuadSize
int	p_endQuadSize
Classes
class	Quad

Constructor & Destructor Documentation

Isis::ProcessRubberSheet::ProcessRubberSheet	(	int	startSize = `128`,
		int	endSize = `8`
	)			`[inline]`

Constructs a RubberSheet object.

Definition at line 97 of file ProcessRubberSheet.h.

References Isis::Null, p_endQuadSize, p_forceLine, p_forceSamp, and p_startQuadSize.

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

Destroys the RubberSheet object.

Definition at line 106 of file ProcessRubberSheet.h.

Member Function Documentation

void Isis::ProcessRubberSheet::BandChange ( void(*)(const int band) funct )

Registers a function to be called when the current output cube band number changes.

This includes the first time. If and application does NOT need to be notified when the processing is about to proceed to the next band there is no need to call this member. The application function will not be called.

Parameters:

funct

(const int band) An application defined function which will be called every time the current band number changes.

Definition at line 142 of file ProcessRubberSheet.cpp.

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

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 Isis::ProcessMosaic::SetInputCube(), Isis::ProcessBySample::SetInputCube(), Isis::ProcessByLine::SetInputCube(), Isis::ProcessByBrick::SetInputCube(), and Isis::ProcessGroundPolygons::SetOutputCube().

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::Process::SetOutputCube ( const std::string & parameter ) [inherited]

Allocates a user-specified output cube whose size matches the first input cube.

Returns:: Cube*

Parameters:

parameter

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

Exceptions:

Isis::iException::Message

Reimplemented in Isis::ProcessImport, Isis::ProcessMapMosaic, and Isis::ProcessMosaic.

Definition at line 237 of file Process.cpp.

References _FILEINFO_, Isis::Process::InputCubes, Isis::iException::Message(), nb, nl, and ns.

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

void Isis::ProcessRubberSheet::SetTiling	(	int	start,
		int	end
	)			`[inline]`

This sets the start and end tile sizes for the rubber sheet; numbers are inclusive and must be powers of 2.

Parameters:

	start	Start position; must be at least 4 and a power of 2
	end	End position; must be at least 4, a power of 2 and less than start

Definition at line 126 of file ProcessRubberSheet.h.

References p_endQuadSize, and p_startQuadSize.

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::ProcessRubberSheet::StartProcess	(	Isis::Transform &	trans,
		Isis::Interpolator &	interp
	)

Applies a Transform and an Interpolator to every pixel in the output cube.

The output cube is written using an Tile and the input cube is read using a Portal. The input cube and output cube must be initialized prior to calling this method. Output pixels which come from outside the input cube are set to NULL8.

Parameters:

	trans	A fully initialized Transform object. The Transform member of this object is used to calculate what input pixel location should be used to interpolate the output pixel value.
	interp	A fully initialized Interpolator object. The Interpolate member of this object is used to calculate output pixel values.

Exceptions:

Isis::iException::Message

Definition at line 51 of file ProcessRubberSheet.cpp.

References _FILEINFO_, Isis::Buffer::Band(), band, Isis::BufferManager::begin(), Isis::Progress::CheckStatus(), Isis::BufferManager::end(), Isis::Interpolator::HotLine(), Isis::Interpolator::HotSample(), Isis::Process::InputCubes, interp, Isis::Interpolator::Lines(), Isis::iException::Message(), Isis::Process::OutputCubes, p_lineMap, Isis::Process::p_progress, p_sampMap, p_startQuadSize, pos, QuadTree(), Isis::Interpolator::Samples(), Isis::Progress::SetMaximumSteps(), Isis::TileManager::SetTile(), SlowGeom(), and Isis::TileManager::Tiles().

bool Isis::ProcessRubberSheet::TestLine	(	Isis::Transform &	trans,
		int	ssamp,
		int	esamp,
		int	sline,
		int	eline,
		int	increment
	)			`[private]`

This function walks a line (or rectangle) and tests a point every increment pixels.

If any of these points can transform, then this method will return true. Otherwise, this returns false.

Parameters:

	trans	The Transform object to test on
	ssamp	Starting Sample
	esamp	Ending Sample
	sline	Starting Line
	eline	Ending Line
	increment	The increment to step by while walking this line/rectangle

Definition at line 232 of file ProcessRubberSheet.cpp.

References line, and sample.

Referenced by ProcessQuad().

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

Writes out the History blob to the cube.

Definition at line 591 of file Process.cpp.

References Isis::History::AddEntry(), cube, Isis::Process::InputCubes, Isis::Process::p_propagateHistory, and Isis::Cube::Write().

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

Member Data Documentation

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

A vector of pointers to opened Cube objects.

The pointers are established in the SetInputCube/SetInputWorkCube methods.

Definition at line 160 of file Process.h.

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

A vector of pointers to allocated Cube objects.

The pointers are established in the SetOutputCube method.

Definition at line 166 of file Process.h.

Isis::Progress* Isis::Process::p_progress [protected, inherited]

bool Isis::Process::p_propagateHistory [protected, inherited]

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

Definition at line 150 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagateHistory(), Isis::ProcessMapMosaic::StartProcess(), and Isis::Process::WriteHistory().

bool Isis::Process::p_propagateLabels [protected, inherited]

Flag indicating if labels are be propagated to output cubes.

Definition at line 138 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagateLabels(), and Isis::Process::SetOutputCube().

bool Isis::Process::p_propagateOriginalLabel [protected, inherited]

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

Definition at line 154 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagateOriginalLabel(), and Isis::Process::SetOutputCube().

bool Isis::Process::p_propagatePolygons [protected, inherited]

Flag indicating if blobs are be propagated to output cubes.

Definition at line 146 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagatePolygons(), and Isis::Process::SetOutputCube().

bool Isis::Process::p_propagateTables [protected, inherited]

Flag indicating if tables are be propagated to output cubes.

Definition at line 142 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagateTables(), and Isis::Process::SetOutputCube().

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

Detailed Description

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Classes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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

Detailed Description

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Classes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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