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.

List of all members.

Public Member Functions

 Average (Isis::Cube *pInCube, vector< string > psBands, double pdSampleScale, double pdLineScale, double pdValidPer, string psReplaceMode)
 Constructor.
void operator() (Isis::Buffer &out)
 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.
vector< stringmsBands
 Bands list.
Isis::Portalm_iPortal
 Input portal.

Detailed Description

Functor for reduce using average functionality.

Author:
????-??-?? Unknown

Constructor & Destructor Documentation

Isis::Average::Average ( Isis::Cube pInCube,
vector< string psBands,
double  pdSampleScale,
double  pdLineScale,
double  pdValidPer,
string  psReplaceMode 
) [inline]

Constructor.


Member Function Documentation

void Isis::Average::operator() ( Isis::Buffer out  ) 
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

References Isis::Reduce::mdLine, Isis::Reduce::mdLineScale, Isis::Reduce::mdSampleScale, Isis::Reduce::miEndLine, Isis::Reduce::miEndSample, Isis::Reduce::miInputLines, Isis::Reduce::miInputSamples, Isis::Reduce::miOutputLines, Isis::Reduce::miOutputSamples, Isis::Reduce::miStartLine, and Isis::Reduce::miStartSample.

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::Cube::getLineCount(), Isis::Cube::getSampleCount(), Isis::Reduce::mdLineScale, Isis::Reduce::mdSampleScale, Isis::Reduce::miEndLine, Isis::Reduce::miEndSample, Isis::Reduce::miInputLines, Isis::Reduce::miInputSamples, Isis::Reduce::mInCube, Isis::Reduce::miOutputLines, Isis::Reduce::miOutputSamples, Isis::Reduce::miStartLine, Isis::Reduce::miStartSample, Isis::SubArea::SetSubArea(), and Isis::SubArea::UpdateLabel().


Member Data Documentation

Isis::Portal* Isis::Reduce::m_iPortal [protected, inherited]
double Isis::Reduce::mdLine [protected, inherited]
double Isis::Reduce::mdLineScale [protected, inherited]
double Isis::Reduce::mdSampleScale [protected, inherited]
int Isis::Reduce::miBandIndex [protected, inherited]
int Isis::Reduce::miEndLine [protected, inherited]
int Isis::Reduce::miEndSample [protected, inherited]
int Isis::Reduce::miInputBands [protected, inherited]

Input Bands.

Referenced by operator()(), and Isis::Reduce::Reduce().

int Isis::Reduce::miInputLines [protected, inherited]
int Isis::Reduce::miInputSamples [protected, inherited]
Isis::Cube* Isis::Reduce::mInCube [protected, inherited]
int Isis::Reduce::miOutputLines [protected, inherited]
int Isis::Reduce::miOutputSamples [protected, inherited]
int Isis::Reduce::miStartLine [protected, inherited]
int Isis::Reduce::miStartSample [protected, inherited]
vector<string> Isis::Reduce::msBands [protected, inherited]

Bands list.

Referenced by Isis::Reduce::Reduce().


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