USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::Enlarge Class Reference
[Geometry]

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

#include <Enlarge.h>

Inherits Isis::Transform.

List of all members.

Public Member Functions

 Enlarge (Cube *pInCube, const double sampleScale, const double lineScale)
 Constructs an Enlarge object.
void SetInputArea (double pdStartSample, double pdEndSample, double pdStartLine, double pdEndLine)
 Sets the sub area dimensions of the input image.
 ~Enlarge ()
 Destructoys the Enlarge object.
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.
PvlGroup UpdateOutputLabel (Cube *pOutCube)
 Update the Mapping, Instrument, and AlphaCube groups in the output cube label.
int OutputSamples () const
 Return the output number of samples.
int OutputLines () const
 Return the output number of lines.

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

Constructor & Destructor Documentation

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

References Isis::Cube::getLineCount(), and Isis::Cube::getSampleCount().

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

Destructoys the Enlarge object.


Member Function Documentation

int Isis::Enlarge::OutputLines (  )  const [inline, virtual]

Return the output number of lines.

Returns:
int - Number of lines in output

Implements Isis::Transform.

int Isis::Enlarge::OutputSamples (  )  const [inline, virtual]

Return the output number of samples.

Returns:
int - Number of samples in output

Implements Isis::Transform.

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

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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

References Isis::Cube::getLineCount(), Isis::Cube::getSampleCount(), iNumSamples, Isis::SubArea::SetSubArea(), and Isis::SubArea::UpdateLabel().

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.


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