USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::Average Class Reference

Functor for reduce using average functionality. More...

#include <Reduce.h>

Inherits Isis::Reduce.

Public Member Functions

 Average (Isis::Cube *pInCube, double pdSampleScale, double pdLineScale, double pdValidPer, QString psReplaceMode)
 Constructor.
 
void operator() (Isis::Buffer &out) const
 Operator () overload.
 
Isis::PvlGroup UpdateOutputLabel (Isis::Cube *pOutCube)
 Create label for the reduced output image.
 
void setInputBoundary (int startSample, int endSample, int startLine, int endLine)
 Parameters to input image sub area.
 

Protected Attributes

Isis::CubemInCube
 Input image.
 
double mdSampleScale
 Sample scale.
 
double mdLineScale
 Line scale.
 
int miStartSample
 Input start sample.
 
int miEndSample
 Input end sample.
 
int miStartLine
 Input start line.
 
int miEndLine
 Input end line.
 
double mdLine
 Line index.
 
int miOutputSamples
 Output Samples.
 
int miOutputLines
 Output Lines.
 
int miInputSamples
 Input Samples.
 
int miInputLines
 Input Lines.
 
int miInputBands
 Input Bands.
 
int miBandIndex
 Band Index.
 
Isis::Portalm_iPortal
 Input portal.
 

Detailed Description

Functor for reduce using average functionality.

Author
2011-04-15 Sharmila Prasad

Constructor & Destructor Documentation

Isis::Average::Average ( Isis::Cube pInCube,
double  pdSampleScale,
double  pdLineScale,
double  pdValidPer,
QString  psReplaceMode 
)
inline

Constructor.

Member Function Documentation

void Isis::Average::operator() ( Isis::Buffer out) const

Operator () overload.

Average Operator () overload, parameter for StartProcessInPlace refer ProcessByLine, ProcessByBrick.

Parameters
out- output buffer

References Isis::Buffer::Band(), Isis::IsValidPixel(), Isis::Buffer::Line(), Isis::Null, and Isis::Buffer::size().

void Isis::Reduce::setInputBoundary ( int  startSample,
int  endSample,
int  startLine,
int  endLine 
)
inherited

Parameters to input image sub area.

Parameters to input image sub area to be reduced.

Author
Sharmila Prasad (5/11/2011)
Parameters
startSample- input image start sample
endSample- input image end sample
startLine- input image start line
endLine- input image end line
Isis::PvlGroup Isis::Reduce::UpdateOutputLabel ( Isis::Cube pOutCube)
inherited

Create label for the reduced output image.

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

Parameters
pOutCube- Resulting reduced output cube
pResultsGrp- 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::SubArea::SetSubArea(), Isis::toString(), and Isis::SubArea::UpdateLabel().

Member Data Documentation

Isis::Portal* Isis::Reduce::m_iPortal
protectedinherited

Input portal.

double Isis::Reduce::mdLine
mutableprotectedinherited

Line index.

double Isis::Reduce::mdLineScale
protectedinherited

Line scale.

double Isis::Reduce::mdSampleScale
protectedinherited

Sample scale.

int Isis::Reduce::miBandIndex
mutableprotectedinherited

Band Index.

int Isis::Reduce::miEndLine
protectedinherited

Input end line.

int Isis::Reduce::miEndSample
protectedinherited

Input end sample.

int Isis::Reduce::miInputBands
protectedinherited

Input Bands.

int Isis::Reduce::miInputLines
protectedinherited

Input Lines.

int Isis::Reduce::miInputSamples
protectedinherited

Input Samples.

Isis::Cube* Isis::Reduce::mInCube
protectedinherited

Input image.

int Isis::Reduce::miOutputLines
protectedinherited

Output Lines.

int Isis::Reduce::miOutputSamples
protectedinherited

Output Samples.

int Isis::Reduce::miStartLine
protectedinherited

Input start line.

int Isis::Reduce::miStartSample
protectedinherited

Input start sample.


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