Functor for reduce using average functionality. More...

#include <Reduce.h>

Inheritance diagram for Isis::Average:

Collaboration diagram for Isis::Average:

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

Private Attributes
double	mdValidPer
	Valid Percentage. More...

QString	msReplaceMode
	Replace Mode (scale/total) More...

double *	mdIncTab

double *	mdSum

double *	mdNpts

double *	mdSum2

double *	mdNpts2

Detailed Description

Functor for reduce using average functionality.

Author: 2011-04-15 Sharmila Prasad

Definition at line 107 of file Reduce.h.

Constructor & Destructor Documentation

◆ Average()

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

inline

Constructor.

Definition at line 110 of file Reduce.h.

References mdValidPer, and msReplaceMode.

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

Definition at line 172 of file Reduce.cpp.

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

History:: 2013-01-16 Tracie Sucharski - Use rounding instead of ceil function to prevent errors that were caused by round off. The reduce application would get ons, onl from the user, calculate scale and pass the scale in to this class, which would calculate ons, onl, which could be different from the user entered values.

Definition at line 87 of file Reduce.cpp.

Referenced by Isis::FileTool::saveAsReducedCube().

◆ 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

Definition at line 112 of file Reduce.cpp.

References Isis::SubArea::SetSubArea(), Isis::toString(), and Isis::SubArea::UpdateLabel().

Referenced by Isis::FileTool::saveAsReducedCube().

Member Data Documentation

◆ m_iPortal

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

protectedinherited

Input portal.

Definition at line 77 of file Reduce.h.

◆ mdLine

double Isis::Reduce::mdLine

mutableprotectedinherited

Line index.

Definition at line 70 of file Reduce.h.

◆ mdLineScale

double Isis::Reduce::mdLineScale

protectedinherited

Line scale.

Definition at line 65 of file Reduce.h.

◆ mdSampleScale

double Isis::Reduce::mdSampleScale

protectedinherited

Sample scale.

Definition at line 64 of file Reduce.h.

◆ mdValidPer

double Isis::Average::mdValidPer

mutableprivate

Valid Percentage.

Definition at line 121 of file Reduce.h.

Referenced by Average().

◆ miBandIndex

int Isis::Reduce::miBandIndex

mutableprotectedinherited

Band Index.

Definition at line 76 of file Reduce.h.

◆ miEndLine

int Isis::Reduce::miEndLine

protectedinherited

Input end line.

Definition at line 69 of file Reduce.h.

◆ miEndSample

int Isis::Reduce::miEndSample

protectedinherited

Input end sample.

Definition at line 67 of file Reduce.h.

◆ miInputBands

int Isis::Reduce::miInputBands

protectedinherited

Input Bands.

Definition at line 75 of file Reduce.h.

◆ miInputLines

int Isis::Reduce::miInputLines

protectedinherited

Input Lines.

Definition at line 74 of file Reduce.h.

◆ miInputSamples

int Isis::Reduce::miInputSamples

protectedinherited

Input Samples.

Definition at line 73 of file Reduce.h.

◆ mInCube

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

protectedinherited

Input image.

Definition at line 63 of file Reduce.h.

◆ miOutputLines

int Isis::Reduce::miOutputLines

protectedinherited

Output Lines.

Definition at line 72 of file Reduce.h.

◆ miOutputSamples

int Isis::Reduce::miOutputSamples

protectedinherited

Output Samples.

Definition at line 71 of file Reduce.h.

◆ miStartLine

int Isis::Reduce::miStartLine

protectedinherited

Input start line.

Definition at line 68 of file Reduce.h.

◆ miStartSample

int Isis::Reduce::miStartSample

protectedinherited

Input start sample.

Definition at line 66 of file Reduce.h.

◆ msReplaceMode

QString Isis::Average::msReplaceMode

private

Replace Mode (scale/total)

Definition at line 122 of file Reduce.h.

Referenced by Average().

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

src/base/objs/Reduce/Reduce.h
src/base/objs/Reduce/Reduce.cpp

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Average()

Member Function Documentation

◆ operator()()

◆ setInputBoundary()

◆ UpdateOutputLabel()

Member Data Documentation

◆ m_iPortal

◆ mdLine

◆ mdLineScale

◆ mdSampleScale

◆ mdValidPer

◆ miBandIndex

◆ miEndLine

◆ miEndSample

◆ miInputBands

◆ miInputLines

◆ miInputSamples

◆ mInCube

◆ miOutputLines

◆ miOutputSamples

◆ miStartLine

◆ miStartSample

◆ msReplaceMode