Isis Developer Reference: Isis::Average Class Reference

Isis Developer 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.

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::Cube *	mInCube
	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::Portal *	m_iPortal
	Input portal.

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::IsValidPixel(), Isis::Reduce::m_iPortal, Isis::Reduce::mdLine, Isis::Reduce::mdLineScale, Isis::Reduce::mdSampleScale, Isis::Reduce::miBandIndex, Isis::Reduce::miInputBands, Isis::Reduce::miInputLines, Isis::Reduce::miInputSamples, Isis::Reduce::mInCube, Isis::Reduce::miOutputLines, Isis::Reduce::miOutputSamples, Isis::Reduce::miStartSample, Isis::Null, Isis::Cube::read(), and Isis::Portal::SetPosition().

◆ 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

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.

◆ 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::Cube::lineCount(), 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::Cube::sampleCount(), Isis::SubArea::SetSubArea(), and Isis::toString().

Member Data Documentation

◆ m_iPortal

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

protectedinherited

Input portal.

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

◆ mdLine

double Isis::Reduce::mdLine

mutableprotectedinherited

Line index.

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

◆ mdLineScale

double Isis::Reduce::mdLineScale

protectedinherited

Line scale.

Referenced by Isis::Nearest::operator()(), operator()(), Isis::Reduce::Reduce(), Isis::Reduce::setInputBoundary(), and Isis::Reduce::UpdateOutputLabel().

◆ mdSampleScale

double Isis::Reduce::mdSampleScale

protectedinherited

Sample scale.

Referenced by Isis::Nearest::operator()(), operator()(), Isis::Reduce::Reduce(), Isis::Reduce::setInputBoundary(), and Isis::Reduce::UpdateOutputLabel().

◆ miBandIndex

int Isis::Reduce::miBandIndex

mutableprotectedinherited

Band Index.

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

◆ miEndLine

int Isis::Reduce::miEndLine

protectedinherited

Input end line.

Referenced by Isis::Reduce::Reduce(), Isis::Reduce::setInputBoundary(), and Isis::Reduce::UpdateOutputLabel().

◆ miEndSample

int Isis::Reduce::miEndSample

protectedinherited

Input end sample.

Referenced by Isis::Reduce::Reduce(), Isis::Reduce::setInputBoundary(), and Isis::Reduce::UpdateOutputLabel().

◆ miInputBands

int Isis::Reduce::miInputBands

protectedinherited

Input Bands.

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

◆ miInputLines

int Isis::Reduce::miInputLines

protectedinherited

Input Lines.

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

◆ miInputSamples

int Isis::Reduce::miInputSamples

protectedinherited

Input Samples.

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

◆ mInCube

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

protectedinherited

Input image.

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

◆ miOutputLines

int Isis::Reduce::miOutputLines

protectedinherited

Output Lines.

Referenced by Isis::Nearest::operator()(), operator()(), Isis::Reduce::Reduce(), Isis::Reduce::setInputBoundary(), and Isis::Reduce::UpdateOutputLabel().

◆ miOutputSamples

int Isis::Reduce::miOutputSamples

protectedinherited

Output Samples.

Referenced by Isis::Nearest::operator()(), operator()(), Isis::Reduce::Reduce(), Isis::Reduce::setInputBoundary(), and Isis::Reduce::UpdateOutputLabel().

◆ miStartLine

int Isis::Reduce::miStartLine

protectedinherited

Input start line.

Referenced by Isis::Reduce::Reduce(), Isis::Reduce::setInputBoundary(), and Isis::Reduce::UpdateOutputLabel().

◆ miStartSample

int Isis::Reduce::miStartSample

protectedinherited

Input start sample.

Referenced by Isis::Nearest::operator()(), operator()(), Isis::Reduce::Reduce(), Isis::Reduce::setInputBoundary(), and Isis::Reduce::UpdateOutputLabel().

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

/Users/astamile/ISIS3/isis/src/base/objs/Reduce/Reduce.h
/Users/astamile/ISIS3/isis/src/base/objs/Reduce/Reduce.cpp