Create an output cube given one input cube. More...

Inheritance diagram for Isis::ProcessByBrick::ProcessCubeFunctor< T >:

Collaboration diagram for Isis::ProcessByBrick::ProcessCubeFunctor< T >:

Public Member Functions
	ProcessCubeFunctor (Cube inputCube, const Brick inputTemplateBrick, Cube outputCube, const Brick outputTemplateBrick, const T &processingFunctor)
	Construct a ProcessCubeFunctor.

	ProcessCubeFunctor (const ProcessCubeFunctor &other)
	Copy construction of these objects is fully supported.

virtual	~ProcessCubeFunctor ()
	Destructor.

void *	operator() (const int &brickPosition) const
	Do the work for one position in a cube.

ProcessCubeFunctor &	operator= (const ProcessCubeFunctor &rhs)
	Assignment of these objects is fully supported.

Private Attributes
Cube *	m_inputCube
	The cube to read from for the input brick data.

const Brick *	m_inputTemplateBrick
	An example brick for the input parameter to m_processingFunctor.

Cube *	m_outputCube
	The cube to write to with the output of m_processingFunctor.

const Brick *	m_outputTemplateBrick
	An example brick for the output parameter to m_processingFunctor.

const T &	m_processingFunctor
	The functor which does the work/arbitrary calculations.

Detailed Description

template<typename T>
class Isis::ProcessByBrick::ProcessCubeFunctor< T >

Create an output cube given one input cube.

Given a ProcessIterator position, this runs the functor passed into ProcessCube with the appropriate data.

This functor is a helper for the ProcessCube() public method. This is designed to be passed into QtConcurrent::mapped to operate over a cube.

Author: 2012-02-22 Steven Lambright

Definition at line 447 of file ProcessByBrick.h.

Constructor & Destructor Documentation

◆ ProcessCubeFunctor() [1/2]

template<typename T >

Isis::ProcessByBrick::ProcessCubeFunctor< T >::ProcessCubeFunctor	(	Cube *	inputCube,
		const Brick *	inputTemplateBrick,
		Cube *	outputCube,
		const Brick *	outputTemplateBrick,
		const T &	processingFunctor )

inline

Construct a ProcessCubeFunctor.

This doesn't take ownership of the passed in pointers but expects them to not be deleted.

Parameters

inputCube	The cube to read from for input data
inputTemplateBrick	A brick initialized for use with the processingFunctor's input parameter
outputCube	The cube to write to after running the processingFunctor
outputTemplateBrick	A brick initialized for use with the processingFunctor's output parameter
processingFunctor	The functor supplied to ProcessCube() which actually does the work/ calculations.

Definition at line 465 of file ProcessByBrick.h.

◆ ProcessCubeFunctor() [2/2]

template<typename T >

Isis::ProcessByBrick::ProcessCubeFunctor< T >::ProcessCubeFunctor ( const ProcessCubeFunctor< T > & other )

inline

Copy construction of these objects is fully supported.

Parameters

other The functor to copy

Definition at line 483 of file ProcessByBrick.h.

◆ ~ProcessCubeFunctor()

template<typename T >

virtual Isis::ProcessByBrick::ProcessCubeFunctor< T >::~ProcessCubeFunctor ( )

inlinevirtual

Destructor.

Definition at line 495 of file ProcessByBrick.h.

References Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_inputTemplateBrick, and Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_outputTemplateBrick.

Member Function Documentation

◆ operator()()

template<typename T >

void * Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator() ( const int & brickPosition ) const

inline

Do the work for one position in a cube.

Parameters

brickPosition The position we're calculating values for currently.

Definition at line 507 of file ProcessByBrick.h.

References Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_inputCube, Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_inputTemplateBrick, Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_outputCube, Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_outputTemplateBrick, Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_processingFunctor, Isis::Cube::read(), and Isis::Cube::write().

◆ operator=()

template<typename T >

ProcessCubeFunctor & Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator= ( const ProcessCubeFunctor< T > & rhs )

inline

Assignment of these objects is fully supported.

Parameters

rhs	The ProcessCubeFunctor on the right-hand side of the assignment.

Returns: *this

Definition at line 531 of file ProcessByBrick.h.

References Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_inputCube, Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_inputTemplateBrick, Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_outputCube, Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_outputTemplateBrick, and Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_processingFunctor.

Member Data Documentation

◆ m_inputCube

template<typename T >

Cube* Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_inputCube

private

The cube to read from for the input brick data.

Definition at line 545 of file ProcessByBrick.h.

Referenced by Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator()(), and Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator=().

◆ m_inputTemplateBrick

template<typename T >

const Brick* Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_inputTemplateBrick

private

An example brick for the input parameter to m_processingFunctor.

Definition at line 547 of file ProcessByBrick.h.

Referenced by Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator()(), Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator=(), and Isis::ProcessByBrick::ProcessCubeFunctor< T >::~ProcessCubeFunctor().

◆ m_outputCube

template<typename T >

Cube* Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_outputCube

private

The cube to write to with the output of m_processingFunctor.

Definition at line 550 of file ProcessByBrick.h.

Referenced by Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator()(), and Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator=().

◆ m_outputTemplateBrick

template<typename T >

const Brick* Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_outputTemplateBrick

private

An example brick for the output parameter to m_processingFunctor.

Definition at line 552 of file ProcessByBrick.h.

Referenced by Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator()(), Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator=(), and Isis::ProcessByBrick::ProcessCubeFunctor< T >::~ProcessCubeFunctor().

◆ m_processingFunctor

template<typename T >

const T& Isis::ProcessByBrick::ProcessCubeFunctor< T >::m_processingFunctor

private

The functor which does the work/arbitrary calculations.

Definition at line 555 of file ProcessByBrick.h.

Referenced by Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator()(), and Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator=().

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

src/base/objs/ProcessByBrick/ProcessByBrick.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ProcessCubeFunctor() [1/2]

◆ ProcessCubeFunctor() [2/2]

◆ ~ProcessCubeFunctor()

Member Function Documentation

◆ operator()()

◆ operator=()

Member Data Documentation

◆ m_inputCube

◆ m_inputTemplateBrick

◆ m_outputCube

◆ m_outputTemplateBrick

◆ m_processingFunctor