Isis 3 Developer Reference
Public Member Functions | Protected Attributes | List of all members
Isis::Average Class Reference

Functor for reduce using average functionality. More...

#include <Reduce.h>

Inheritance diagram for Isis::Average:
Inheritance graph
Collaboration diagram for Isis::Average:
Collaboration graph

Public Member Functions

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

Protected Attributes

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

Detailed Description

Functor for reduce using average functionality.

Author
2011-04-15 Sharmila Prasad

Constructor & Destructor Documentation

◆ Average()

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

Constructor.

Member Function Documentation

◆ operator()()

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

◆ setInputBoundary()

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

◆ UpdateOutputLabel()

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

◆ m_iPortal

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

Input portal.

◆ mdLine

double Isis::Reduce::mdLine
mutableprotectedinherited

Line index.

◆ mdLineScale

double Isis::Reduce::mdLineScale
protectedinherited

Line scale.

◆ mdSampleScale

double Isis::Reduce::mdSampleScale
protectedinherited

Sample scale.

◆ miBandIndex

int Isis::Reduce::miBandIndex
mutableprotectedinherited

Band Index.

◆ miEndLine

int Isis::Reduce::miEndLine
protectedinherited

Input end line.

◆ miEndSample

int Isis::Reduce::miEndSample
protectedinherited

Input end sample.

◆ miInputBands

int Isis::Reduce::miInputBands
protectedinherited

Input Bands.

◆ miInputLines

int Isis::Reduce::miInputLines
protectedinherited

Input Lines.

◆ miInputSamples

int Isis::Reduce::miInputSamples
protectedinherited

Input Samples.

◆ mInCube

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

Input image.

◆ miOutputLines

int Isis::Reduce::miOutputLines
protectedinherited

Output Lines.

◆ miOutputSamples

int Isis::Reduce::miOutputSamples
protectedinherited

Output Samples.

◆ miStartLine

int Isis::Reduce::miStartLine
protectedinherited

Input start line.

◆ miStartSample

int Isis::Reduce::miStartSample
protectedinherited

Input start sample.

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