Isis::Enlarge Class Reference

Enlarge the pixel dimensions of an image. More...

#include <Enlarge.h>

Inheritance diagram for Isis::Enlarge:

Collaboration diagram for Isis::Enlarge:

Public Member Functions
	Enlarge (Cube *pInCube, const double sampleScale, const double lineScale)
	Constructs an Enlarge object. More...
void	SetInputArea (double pdStartSample, double pdEndSample, double pdStartLine, double pdEndLine)
	Sets the sub area dimensions of the input image. More...
	~Enlarge ()
	Destructoys the Enlarge object. More...
bool	Xform (double &inSample, double &inLine, const double outSample, const double outLine)
	Implementations for parent's pure virtual members Convert the requested output samp/line to an input samp/line. More...
PvlGroup	UpdateOutputLabel (Cube *pOutCube)
	Update the Mapping, Instrument, and AlphaCube groups in the output cube label. More...
int	OutputSamples () const
	Return the output number of samples. More...
int	OutputLines () const
	Return the output number of lines. More...

Private Attributes
Cube *	mInCube
	Input image. More...
int	miOutputSamples
	Number of samples for output. More...
int	miOutputLines
	Number of lines for output. More...
double	mdSampleScale
	Sample scale. More...
double	mdLineScale
	Line scale. More...
double	mdStartSample
	Input start sample. More...
double	mdEndSample
	Input end sample. More...
double	mdStartLine
	Input start line. More...
double	mdEndLine
	Input end line. More...

Detailed Description

Enlarge the pixel dimensions of an image.

Enlarge the pixel dimensions of an image. Has the functionality to enlarge only a sub area in input image to output

Author

2002-12-13 Stuart Sides

History:

2011-04-14 Sharmila Prasad - Ported the class from "enlarge" app to base object class with added functionality to enlarge only the sub area within the input image into the output image

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

Definition at line 48 of file Enlarge.h.

Constructor & Destructor Documentation

Enlarge()

Isis::Enlarge::Enlarge	(	Cube *	pInCube,
		const double	sampleScale,
		const double	lineScale
	)

Constructs an Enlarge object.

Parameters

pInCube	- Input cube to be enlarged
sampleScale	- Sample scale
lineScale	- Line scale

Definition at line 40 of file Enlarge.cpp.

References Isis::Cube::sampleCount().

~Enlarge()

Isis::Enlarge::~Enlarge ( )

inline

Destructoys the Enlarge object.

Definition at line 58 of file Enlarge.h.

Member Function Documentation

OutputLines()

int Isis::Enlarge::OutputLines ( ) const

inlinevirtual

Return the output number of lines.

Returns

int - Number of lines in output

Implements Isis::Transform.

Definition at line 80 of file Enlarge.h.

References miOutputLines.

OutputSamples()

int Isis::Enlarge::OutputSamples ( ) const

inlinevirtual

Return the output number of samples.

Returns

int - Number of samples in output

Implements Isis::Transform.

Definition at line 72 of file Enlarge.h.

References miOutputSamples.

SetInputArea()

void Isis::Enlarge::SetInputArea	(	double	pdStartSample,
		double	pdEndSample,
		double	pdStartLine,
		double	pdEndLine
	)

Sets the sub area dimensions of the input image.

Default is the entire image

Author

Sharmila Prasad (4/14/2011)

Parameters

pdStartSample	- Input start sample
pdEndSample	- Input end sample
pdStartLine	- Input start line
pdEndLine	- Input end line

Definition at line 89 of file Enlarge.cpp.

References _FILEINFO_.

Referenced by Isis::FileTool::saveAsEnlargedCube().

UpdateOutputLabel()

PvlGroup Isis::Enlarge::UpdateOutputLabel

(

Cube *

pOutCube

)

Update the Mapping, Instrument, and AlphaCube groups in the output cube label.

Parameters

pOutCube

- Resulting enlarged output cube

Returns

PvlGroup - This is the Results group that will go into the application log file. This group must be created by the calling application. Information will be added to it if the Mapping or Instrument groups are deleted from the output image label

Definition at line 127 of file Enlarge.cpp.

References Isis::SubArea::SetSubArea(), Isis::toString(), and Isis::SubArea::UpdateLabel().

Referenced by Isis::FileTool::saveAsEnlargedCube().

Xform()

bool Isis::Enlarge::Xform ( double &  inSample, double &  inLine, const double  outSample, const double  outLine  )

virtual

Implementations for parent's pure virtual members Convert the requested output samp/line to an input samp/line.

Parameters

inSample	- Calculated input sample corresponding to output sample
inLine	- Calculated input line corresponding to output line
outSample	- Output sample
outLine	- Output line

Returns

bool

Implements Isis::Transform.

Definition at line 70 of file Enlarge.cpp.

Member Data Documentation

mdEndLine

double Isis::Enlarge::mdEndLine

private

Input end line.

Definition at line 93 of file Enlarge.h.

mdEndSample

double Isis::Enlarge::mdEndSample

private

Input end sample.

Definition at line 91 of file Enlarge.h.

mdLineScale

double Isis::Enlarge::mdLineScale

private

Line scale.

Definition at line 89 of file Enlarge.h.

mdSampleScale

double Isis::Enlarge::mdSampleScale

private

Sample scale.

Definition at line 88 of file Enlarge.h.

mdStartLine

double Isis::Enlarge::mdStartLine

private

Input start line.

Definition at line 92 of file Enlarge.h.

mdStartSample

double Isis::Enlarge::mdStartSample

private

Input start sample.

Definition at line 90 of file Enlarge.h.

mInCube

Cube* Isis::Enlarge::mInCube

private

Input image.

Definition at line 85 of file Enlarge.h.

miOutputLines

int Isis::Enlarge::miOutputLines

private

Number of lines for output.

Definition at line 87 of file Enlarge.h.

Referenced by OutputLines().

miOutputSamples

int Isis::Enlarge::miOutputSamples

private

Number of samples for output.

Definition at line 86 of file Enlarge.h.

Referenced by OutputSamples().

---

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

• src/base/objs/Enlarge/Enlarge.h
• src/base/objs/Enlarge/Enlarge.cpp