Isis Developer Reference
Isis::ProcessByBrick Class Reference

Process cubes by brick. More...

#include <ProcessByBrick.h>

Inheritance diagram for Isis::ProcessByBrick:
Inheritance graph
Collaboration diagram for Isis::ProcessByBrick:
Collaboration graph

Public Types

enum  IOCubes { InPlace , InputOutput , InputOutputList }
 
enum  ProcessingDirection { LinesFirst , BandsFirst }
 

Public Member Functions

 ProcessByBrick ()
 Constructs a ProcessByBrick object.
 
virtual ~ProcessByBrick ()
 Destroys the ProcessByBrick object.
 
CubeSetInputCube (const QString &parameter, int requirements=0)
 Opens an input cube specified by the user and verifies requirements are met.
 
CubeSetInputCube (const QString &fname, const CubeAttributeInput &att, int requirements=0)
 Opens an input cube specified by the user, sets the attributes, and verifies requirements are met.
 
virtual void SetBricks (IOCubes cn)
 
void VerifyCubes (IOCubes cn)
 Verifies the dimensions of the input/output cubes.
 
void SetBrickSize (int ns, int nl, int nb)
 Sets the input and output bricks sizes to the given number of samples, lines, and bands.
 
void SetInputBrickSize (int ns, int nl, int nb)
 Sets the size of all input bricks.
 
void SetInputBrickSize (int ns, int nl, int nb, int cube)
 Sets the brick size of the specified cube.
 
void SetOutputBrickSize (int ns, int nl, int nb)
 Sets the size of all output bricks.
 
void SetOutputBrickSize (int ns, int nl, int nb, int cube)
 Sets the brick size of the specified output cube.
 
virtual CubeSetOutputCube (const QString &fname, const CubeAttributeOutput &att)
 Create the output file.
 
void SetProcessingDirection (ProcessingDirection direction)
 Set the direction the data will be read, either all lines in a single band proceeding to the next band (LinesFirst), or every band for every line proceeding to the next line (BandsFirst).
 
ProcessingDirection GetProcessingDirection ()
 Returns the direction the data will be read, either all lines in a single band proceeding to the next band (LinesFirst), or every band for every line proceeding to the next line (BandsFirst).
 
void SetOutputRequirements (int outputRequirements)
 
void SetWrap (bool wrap)
 This wrapping option only applys when there are two or more input cubes.
 
bool Wraps ()
 Returns true if the wrapping option is enabled.
 
virtual void StartProcess (void funct(Buffer &in))
 Starts the systematic processing of the input cube by moving an arbitrarily-shaped brick through the cube.
 
virtual void StartProcess (std::function< void(Buffer &in)> funct)
 Starts the systematic processing of the input cube by moving an arbitrarily-shaped brick through the cube.
 
virtual void StartProcess (void funct(Buffer &in, Buffer &out))
 Starts the systematic processing of the input cube by moving an arbitrarily-shaped brick through the cube.
 
virtual void StartProcess (std::function< void(Buffer &in, Buffer &out)> funct)
 Starts the systematic processing of the input cube by moving an arbitrarily-shaped brick through the cube.
 
virtual void StartProcess (void funct(std::vector< Buffer * > &in, std::vector< Buffer * > &out))
 Starts the systematic processing of the input cube by moving an arbitrarily-shaped brick through the cube.
 
virtual void StartProcess (std::function< void(std::vector< Buffer * > &in, std::vector< Buffer * > &out)> funct)
 Starts the systematic processing of the input cube by moving an arbitrarily-shaped brick through the cube.
 
void EndProcess ()
 End the processing sequence and cleans up by closing cubes, freeing memory, etc.
 
void Finalize ()
 Cleans up by closing cubes and freeing memory.
 
template<typename Functor >
void ProcessCubeInPlace (const Functor &functor, bool threaded=true)
 Operate over a single cube (either input or output).
 
template<typename Functor >
void ProcessCube (const Functor &functor, bool threaded=true)
 Operate over a single input cube creating a separate output cube.
 
template<typename Functor >
void ProcessCubes (const Functor &functor, bool threaded=true)
 Operate over an arbitrary number of input cubes given an arbitrary number of output cubes.
 
virtual Isis::CubeSetInputCube (const QString &parameter, const int requirements=0)
 Opens an input cube specified by the user and verifies requirements are met.
 
virtual Isis::CubeSetInputCube (const QString &fname, const Isis::CubeAttributeInput &att, int requirements=0)
 Opens an input cube specified by the programmer and verifies requirements are met.
 
virtual void SetInputCube (Isis::Cube *inCube, int requirements=0)
 Set the InputCube vector to an opened Cube which was dynamically allocated.
 
virtual void StartProcess (void funct())
 In the base class, this method will invoked a user-specified function exactly one time.
 
virtual Isis::CubeSetOutputCube (const QString &parameter)
 Allocates a user-specified output cube whose size matches the first input cube.
 
virtual Isis::CubeSetOutputCube (const QString &parameter, const int nsamps, const int nlines, const int nbands=1)
 Allocates a user specified output cube whose size is specified by the programmer.
 
virtual Isis::CubeSetOutputCube (const QString &fname, const Isis::CubeAttributeOutput &att, const int nsamps, const int nlines, const int nbands=1)
 Allocates a output cube whose name and size is specified by the programmer.
 
virtual Isis::CubeSetOutputCubeStretch (const QString &parameter, UserInterface *ui=nullptr)
 Allocates a user-specified output cube whose size matches the first input cube.
 
virtual Isis::CubeSetOutputCubeStretch (const QString &parameter, const int nsamps, const int nlines, const int nbands=1, UserInterface *ui=nullptr)
 Allocates a user specified output cube whose size is specified by the programmer.
 
void AddInputCube (Cube *cube, bool owned=true)
 
void AddOutputCube (Cube *cube, bool owned=true)
 
void CheckRequirements (const Cube *cube, const int requirements)
 Checks to make sure the input cube meets the inputted requirements.
 
void ClearCubes ()
 Close owned cubes from the list and clear the list.
 
void ClearInputCubes ()
 Close owned input cubes from the list and clear the list.
 
void ClearOutputCubes ()
 Close owned output cubes from the list and clear the list.
 
void PropagateLabels (const bool prop)
 This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes.
 
void PropagateLabels (const QString &cube)
 This method allows the programmer to propagate labels from a specific secondary cube.
 
void PropagateTables (const bool prop)
 This method allows the programmer to propagate input tables to the output cube (default is true)
 
void PropagateTables (const QString &fromName, const QList< QString > &tableNames=QList< QString >())
 Propagate the tables from the cube with the given filename to the output cube.
 
void PropagatePolygons (const bool prop)
 This method allows the programmer to propagate input blobs to the output cube (default is true)
 
void PropagateHistory (const bool prop)
 This method allows the programmer to propagate history to the output cube (default is true)
 
void PropagateOriginalLabel (const bool prop)
 This method allows the programmer to propagate original labels to the output cube (default is true)
 
Isis::ProgressProgress ()
 This method returns a pointer to a Progress object.
 
QString MissionData (const QString &mission, const QString &file, bool highestVersion=false)
 This method reads the mission specific data directory from the user preference file, makes sure that mission is available in the Isis installation, and the attaches the provided input file to the directory in order to create a full file specification.
 
void WriteHistory (Cube &cube)
 Writes out the History blob to the cube.
 
void CalculateStatistics ()
 Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method.
 
std::vector< Isis::Statistics * > BandStatistics (const unsigned index)
 Get the vector of Statistics objects for each band separately of a specified input cube.
 
Isis::StatisticsCubeStatistics (const unsigned index)
 Get the Statistics object for all bands of a specified input cube.
 

Protected Attributes

Isis::Progressp_progress
 Pointer to a Progress object.
 
bool p_propagateLabels
 Flag indicating if labels are be propagated to output cubes.
 
bool p_propagateTables
 Flag indicating if tables are be propagated to output cubes.
 
bool p_propagatePolygons
 Flag indicating if blobs are be propagated to output cubes.
 
bool p_propagateHistory
 Flag indicating if history is to be propagated to output cubes.
 
bool p_propagateOriginalLabel
 Flag indicating if original lable is to be propagated to output cubes.
 
std::vector< std::vector< Isis::Statistics * > > p_bandStats
 Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called.
 
std::vector< Isis::Statistics * > p_cubeStats
 Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called.
 
std::vector< Isis::Cube * > InputCubes
 A vector of pointers to opened Cube objects.
 
std::vector< Isis::Cube * > OutputCubes
 A vector of pointers to allocated Cube objects.
 
QSet< Isis::Cube * > * m_ownedCubes
 A list of cubes owned by this instant.
 

Detailed Description

Process cubes by brick.

This is the processing class used to move a brick through cube data. This class allows only one input cube and one output cube or one input cube. If the brick size does not evenly divide into the image the brick will be padded with Null pixels as it falls off the right and/or bottom edge of the image. The brick shape is only spatial-oriented with one band of data.

Author
2006-03-24 Jacob Danton

Member Enumeration Documentation

◆ IOCubes

Enumerator
InPlace 
InputOutput 
InputOutputList 

◆ ProcessingDirection

Enumerator
LinesFirst 
BandsFirst 

Constructor & Destructor Documentation

◆ ProcessByBrick()

Isis::ProcessByBrick::ProcessByBrick ( )

Constructs a ProcessByBrick object.

◆ ~ProcessByBrick()

Isis::ProcessByBrick::~ProcessByBrick ( )
virtual

Destroys the ProcessByBrick object.

Member Function Documentation

◆ AddInputCube()

void Isis::Process::AddInputCube ( Cube * cube,
bool owned = true )
inherited

◆ AddOutputCube()

◆ BandStatistics()

std::vector< Isis::Statistics * > Isis::Process::BandStatistics ( const unsigned index)
inlineinherited

Get the vector of Statistics objects for each band separately of a specified input cube.

Parameters
indexThe index of the input cube in InputCubes
Returns
vector<Statistics*> A list of statistics ordered by band

References Isis::Process::p_bandStats.

◆ CalculateStatistics()

void Isis::Process::CalculateStatistics ( )
inherited

Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method.

The newly calculated statistics are stored in two ways: as a vector where each entry is a single Statistics object for every band of a particular input cube, and as a vector where each entry is a vector of Statistics objects, for each band separately, of a particular input cube.

References Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), Isis::Process::InputCubes, Isis::Cube::lineCount(), Isis::Process::p_bandStats, Isis::Process::p_cubeStats, Isis::Cube::read(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), and Isis::toString().

◆ CheckRequirements()

void Isis::Process::CheckRequirements ( const Cube * cube,
const int requirements )
inherited

Checks to make sure the input cube meets the inputted requirements.

Parameters
cubeCube to check
requirementsUse to specify requirements for the input file. The following requirments are checked against 1) ic_base::SizeMatch checks to make sure the input cube has the same bands, samples, and lines as the first input cube open using this method, 2) ic_base::SpatialMatch checks to make sure the input cube has the same samples and lines as the first input cube, 3) ic_base::Georeferenced checks to make sure latitude/longitudes can be obtained from the input cube, 4) ic_base::FullyGeoreferenced checks to make sure latitude/longitude, phase/incidence/emission, and other geometric parameters can be obtained from the input cube, 5) ic_base::OneBand checks to make sure the input cube has exactly one band. Note, that these requirements can be logically or'ed. For example, ic_base::SpatialMatch | ic_base::georeferenced. Defaults to 0
Exceptions
Isis::iException::Message

References _FILEINFO_, Isis::AllMatchOrOne, Isis::Cube::bandCount(), Isis::BandMatchOrOne, Isis::Cube::fileName(), Isis::Process::InputCubes, Isis::Cube::lineCount(), Isis::OneBand, Isis::Cube::sampleCount(), Isis::SizeMatch, Isis::SpatialMatch, and Isis::IException::User.

Referenced by Isis::Process::SetInputCube(), and Isis::Process::SetInputCube().

◆ ClearCubes()

void Isis::Process::ClearCubes ( )
inherited

Close owned cubes from the list and clear the list.

References Isis::Process::ClearInputCubes(), Isis::Process::ClearOutputCubes(), and Isis::Process::m_ownedCubes.

Referenced by Isis::Process::Finalize().

◆ ClearInputCubes()

void Isis::Process::ClearInputCubes ( )
inherited

◆ ClearOutputCubes()

void Isis::Process::ClearOutputCubes ( )
inherited

Close owned output cubes from the list and clear the list.

References Isis::Process::m_ownedCubes, and Isis::Process::OutputCubes.

Referenced by Isis::Process::ClearCubes().

◆ CubeStatistics()

Isis::Statistics * Isis::Process::CubeStatistics ( const unsigned index)
inlineinherited

Get the Statistics object for all bands of a specified input cube.

Parameters
indexThe index of the input cube in InputCubes
Returns
Statistics* Collections of statistics gathered on all bands

References Isis::Process::p_cubeStats.

◆ EndProcess()

void Isis::ProcessByBrick::EndProcess ( )
virtual

End the processing sequence and cleans up by closing cubes, freeing memory, etc.

Deprecated
Please use Finalize()

Reimplemented from Isis::Process.

Reimplemented in Isis::ProcessByTile.

References Isis::Process::EndProcess().

Referenced by Isis::ProcessByTile::EndProcess(), and Finalize().

◆ Finalize()

void Isis::ProcessByBrick::Finalize ( )
virtual

Cleans up by closing cubes and freeing memory.

Reimplemented from Isis::Process.

Reimplemented in Isis::ProcessByTile.

References EndProcess().

Referenced by Isis::ProcessByTile::Finalize().

◆ GetProcessingDirection()

ProcessByBrick::ProcessingDirection Isis::ProcessByBrick::GetProcessingDirection ( )

Returns the direction the data will be read, either all lines in a single band proceeding to the next band (LinesFirst), or every band for every line proceeding to the next line (BandsFirst).

The default is to process all lines of a band first.

Returns
The selected enumerated processing direction

References BandsFirst, and LinesFirst.

◆ MissionData()

QString Isis::Process::MissionData ( const QString & mission,
const QString & file,
bool highestVersion = false )
inherited

This method reads the mission specific data directory from the user preference file, makes sure that mission is available in the Isis installation, and the attaches the provided input file to the directory in order to create a full file specification.

Parameters
missionName of the mission data directory
fileName of the file to attach to the end of the directory
highestVersionIf set to true the method will return the highest version number of the given file. Therefore, file must contain question marks such as "file???.dat". See the FileName class for more information on versioned files. Defaults to false.

References _FILEINFO_, Isis::FileName::expanded(), Isis::FileName::fileExists(), Isis::FileName::highestVersion(), Isis::IException::Io, Isis::FileName::original(), and Isis::Preference::Preferences().

◆ ProcessCube()

template<typename Functor >
void Isis::ProcessByBrick::ProcessCube ( const Functor & functor,
bool threaded = true )
inline

Operate over a single input cube creating a separate output cube.

The functor you pass in will be called for every position in the cube. If threaded is true, there is no guarantee to the sequence or timing of the functor's calls.

If you are using a function, the prototype should look like: void SomeFunc(Buffer &inputData, Buffer &outputData); If you are using a functor, the () operator should look like: void operator()(Buffer &inputData, Buffer &outputData) const;

When threaded is true, your function (or functor's () operator) must be thread safe. Please document your function appropriately if it is thread safe.

Parameters
functorThe processing function or functor which does your desired calculations.
threadedTrue if multi-threading is supported, false otherwise. Sequential calling of the functor is guaranteed if this is false.

References Isis::Process::InputCubes, and Isis::Process::OutputCubes.

Referenced by Isis::ProcessByLine::ProcessCube(), Isis::ProcessBySample::ProcessCube(), Isis::ProcessBySpectra::ProcessCube(), and Isis::ProcessByTile::ProcessCube().

◆ ProcessCubeInPlace()

template<typename Functor >
void Isis::ProcessByBrick::ProcessCubeInPlace ( const Functor & functor,
bool threaded = true )
inline

Operate over a single cube (either input or output).

The functor you pass in will be called for every position in the cube. If threaded is true, there is no guarantee to the sequence or timing of the functor's calls.

If you are using a function, the prototype should look like: void SomeFunc(Buffer &); If you are using a functor, the () operator should look like: void operator()(Buffer &) const;

When threaded is true, your function (or functor's () operator) must be thread safe. Please document your function appropriately if it is thread safe.

Parameters
functorThe processing function or functor which does your desired calculations.
threadedTrue if multi-threading is supported, false otherwise. Sequential calling of the functor is guaranteed if this is false.

References Isis::Cube::isReadWrite().

Referenced by Isis::ProcessByLine::ProcessCubeInPlace(), Isis::ProcessBySample::ProcessCubeInPlace(), Isis::ProcessBySpectra::ProcessCubeInPlace(), and Isis::ProcessByTile::ProcessCubeInPlace().

◆ ProcessCubes()

template<typename Functor >
void Isis::ProcessByBrick::ProcessCubes ( const Functor & functor,
bool threaded = true )
inline

Operate over an arbitrary number of input cubes given an arbitrary number of output cubes.

The functor you pass in will be called for every position in the largest output cube. If threaded is true, there is no guarantee to the sequence or timing of the functor's calls.

If you are using a function, the prototype should look like: void SomeFunc(std::vector<Buffer *> &inputData, std::vector<Buffer *> &outputData); If you are using a functor, the () operator should look like: void operator()(std::vector<Buffer *> &inputData, std::vector<Buffer *> &outputData) const;

When threaded is true, your function (or functor's () operator) must be thread safe. Please document your function appropriately if it is thread safe.

Parameters
functorThe processing function or functor which does your desired calculations.
threadedTrue if multi-threading is supported, false otherwise. Sequential calling of the functor is guaranteed if this is false.

References Isis::Process::InputCubes, Isis::Process::OutputCubes, and Wraps().

Referenced by Isis::ProcessByLine::ProcessCubes(), Isis::ProcessBySample::ProcessCubes(), Isis::ProcessBySpectra::ProcessCubes(), and Isis::ProcessByTile::ProcessCubes().

◆ Progress()

Isis::Progress * Isis::Process::Progress ( )
inlineinherited

◆ PropagateHistory()

void Isis::Process::PropagateHistory ( const bool prop)
inherited

This method allows the programmer to propagate history to the output cube (default is true)

Parameters
propFlag indicating if history is to be propagated to output cubes.

References Isis::Process::p_propagateHistory.

◆ PropagateLabels() [1/2]

void Isis::Process::PropagateLabels ( const bool prop)
inherited

This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes.

By default, propagation occurs automatically in the Process class when a call to either of the SetOutputCube methods is invoked. If the program * requires no propagation then utilize this method. This method can be invoked between successive calls of SetOutputCube so that some cube will have labels propagated while others will not.

Parameters
propFlag indicating if labels are be propagated to output cubes.

References Isis::Process::p_propagateLabels.

◆ PropagateLabels() [2/2]

void Isis::Process::PropagateLabels ( const QString & cube)
inherited

This method allows the programmer to propagate labels from a specific secondary cube.

Parameters
cubeIString containing the name of the cube containing the labels to propagate.

References Isis::PvlObject::findObject(), and Isis::Process::OutputCubes.

◆ PropagateOriginalLabel()

void Isis::Process::PropagateOriginalLabel ( const bool prop)
inherited

This method allows the programmer to propagate original labels to the output cube (default is true)

Parameters
propFlag indicating if original labels is to be propagated to output cubes.

References Isis::Process::p_propagateOriginalLabel.

◆ PropagatePolygons()

void Isis::Process::PropagatePolygons ( const bool prop)
inherited

This method allows the programmer to propagate input blobs to the output cube (default is true)

Parameters
propFlag indicating if input blobs are to be propagated to output cubes.

References Isis::Process::p_propagatePolygons.

◆ PropagateTables() [1/2]

void Isis::Process::PropagateTables ( const bool prop)
inherited

This method allows the programmer to propagate input tables to the output cube (default is true)

Parameters
propFlag indicating if input tables are to be propagated to output cubes.

References Isis::Process::p_propagateTables.

◆ PropagateTables() [2/2]

void Isis::Process::PropagateTables ( const QString & fromName,
const QList< QString > & tableNames = QList<QString>() )
inherited

Propagate the tables from the cube with the given filename to the output cube.

This is done at the time this method is called, not during normal processing. The names of the tables to propagate can be provided through the second paramter, by specifing a list of table names. Not providing any list (or providing an empty list) will propagate all tables.

Parameters
fromNameQString of the name of the cube containing the tables to propagate.
tableNamesList of QStrings of the names of the tables to propagate; default is empty, which indicates that all tables will be propagated.

References Isis::Cube::close(), Isis::Cube::label(), Isis::PvlObject::object(), Isis::Cube::open(), Isis::Process::OutputCubes, and Isis::Cube::read().

◆ SetBricks()

void Isis::ProcessByBrick::SetBricks ( IOCubes cn)
virtual

Reimplemented in Isis::ProcessByLine.

◆ SetBrickSize()

void Isis::ProcessByBrick::SetBrickSize ( int ns,
int nl,
int nb )

Sets the input and output bricks sizes to the given number of samples, lines, and bands.

Parameters
nsNumber of samples
nlNumber of lines
nbNumber of bands

References SetInputBrickSize(), and SetOutputBrickSize().

Referenced by Isis::ProcessByLine::SetBricks().

◆ SetInputBrickSize() [1/2]

void Isis::ProcessByBrick::SetInputBrickSize ( int ns,
int nl,
int nb )

Sets the size of all input bricks.

Parameters
nsNumber of samples
nlNumber of lines
nbNumber of bands

References Isis::Process::InputCubes.

Referenced by Isis::ProcessByLine::SetBricks(), and SetBrickSize().

◆ SetInputBrickSize() [2/2]

void Isis::ProcessByBrick::SetInputBrickSize ( int ns,
int nl,
int nb,
int cube )

Sets the brick size of the specified cube.

Parameters
nsNumber of samples
nlNumber of lines
nbNumber of bands
cubeThe index of the cube

References _FILEINFO_, Isis::Process::InputCubes, and Isis::IException::Programmer.

◆ SetInputCube() [1/5]

Cube * Isis::ProcessByBrick::SetInputCube ( const QString & file,
const CubeAttributeInput & att,
int requirements = 0 )
virtual

Opens an input cube specified by the user, sets the attributes, and verifies requirements are met.

This method is overloaded and adds the requirements of ISIS::SpatialMatch which requires all input cubes to have the same dimensions or be exactly be exactly one. For more information see Process::SetInputCube

Returns
Cube*
Parameters
fileUser parameter to obtain file to open. Typically, the value is "FROM". For example, the user can specify on the command line FROM=myfile.cub and this method will attempt to open the cube "myfile.cub" if the parameter was set to "FROM".
attSee Process::SetInputCube for more information.
requirementsSee Process::SetInputCube for more information. Defaults to 0
Exceptions
iException::Message

Reimplemented from Isis::Process.

References Isis::AllMatchOrOne, and Isis::Process::SetInputCube().

◆ SetInputCube() [2/5]

Isis::Cube * Isis::Process::SetInputCube ( const QString & fname,
const Isis::CubeAttributeInput & att,
int requirements = 0 )
virtual

Opens an input cube specified by the programmer and verifies requirements are met.

Parameters
fnameProgrammer specified work file. For example, "myfile.cub".
attThe cube attributes to use when opening the input cube.
requirementsRequirements to check that the input cube meets. See CheckRequirements().
Returns
Cube*
Exceptions
Isis::iException::Message

Reimplemented from Isis::Process.

◆ SetInputCube() [3/5]

Isis::Cube * Isis::Process::SetInputCube ( const QString & parameter,
const int requirements = 0 )
virtual

Opens an input cube specified by the user and verifies requirements are met.

Returns
Cube*
Parameters
parameterUser parameter to obtain file to open. Typically, the value is "FROM". For example, the user can specify on the command line FROM=myfile.cub and this method will attempt to open the cube "myfile.cub" if the parameter was set to "FROM".
requirementsRequirements to check that the input cube meets. See CheckRequirements().
Exceptions
Isis::iException::Message

Reimplemented from Isis::Process.

Reimplemented in Isis::ProcessByLine, Isis::ProcessBySpectra, and Isis::ProcessBySample.

◆ SetInputCube() [4/5]

Cube * Isis::ProcessByBrick::SetInputCube ( const QString & parameter,
int requirements = 0 )
virtual

Opens an input cube specified by the user and verifies requirements are met.

This method is overloaded and adds the requirements of ISIS::SpatialMatch which requires all input cubes to have the same dimensions or be exactly be exactly one. For more information see Process::SetInputCube

Returns
Cube*
Parameters
parameterUser parameter to obtain file to open. Typically, the value is "FROM". For example, the user can specify on the command line FROM=myfile.cub and this method will attempt to open the cube "myfile.cub" if the parameter was set to "FROM".
requirementsSee Process::SetInputCube for more information. Defaults to 0
Exceptions
iException::Message

Reimplemented from Isis::Process.

Reimplemented in Isis::ProcessByLine, Isis::ProcessBySpectra, and Isis::ProcessBySample.

References Isis::AllMatchOrOne, and Isis::Process::SetInputCube().

Referenced by Isis::ProcessBySpectra::SetInputCube(), and Isis::ProcessBySpectra::SetInputCube().

◆ SetInputCube() [5/5]

void Isis::Process::SetInputCube ( Isis::Cube * inCube,
int requirements = 0 )
virtual

Set the InputCube vector to an opened Cube which was dynamically allocated.

This is used if there already exists a valid opened cube

Author
Sharmila Prasad (5/7/2011)
Parameters
inCube- Pointer to input Cube
requirementsRequirements to check that the input cube meets. See CheckRequirements().

Reimplemented from Isis::Process.

◆ SetOutputBrickSize() [1/2]

void Isis::ProcessByBrick::SetOutputBrickSize ( int ns,
int nl,
int nb )

Sets the size of all output bricks.

Parameters
nsNumber of samples
nlNumber of lines
nbNumber of bands

References Isis::Process::OutputCubes.

Referenced by Isis::ProcessByLine::SetBricks(), and SetBrickSize().

◆ SetOutputBrickSize() [2/2]

void Isis::ProcessByBrick::SetOutputBrickSize ( int ns,
int nl,
int nb,
int cube )

Sets the brick size of the specified output cube.

Parameters
nsNumber of samples
nlNumber of lines
nbNumber of bands
cubeThe index of the cube

References _FILEINFO_, Isis::Process::OutputCubes, and Isis::IException::Programmer.

◆ SetOutputCube() [1/4]

Isis::Cube * Isis::ProcessByBrick::SetOutputCube ( const QString & fname,
const CubeAttributeOutput & att )
virtual

Create the output file.

This method assumes that the output cube size matches the input cube size. Therefore, SetInputCube() must be called before this method.

Parameters
parameterThe output file name.
attAn output cube attribute to define the characteristics of the output cube.
Returns
Isis::Cube Output cube.
Exceptions
Isis::iException::Message"File is not in a supported organization."

References Isis::Process::InputCubes, and Isis::Process::SetOutputCube().

◆ SetOutputCube() [2/4]

Isis::Cube * Isis::Process::SetOutputCube ( const QString & fname,
const Isis::CubeAttributeOutput & att,
const int ns,
const int nl,
const int nb = 1 )
virtualinherited

◆ SetOutputCube() [3/4]

Isis::Cube * Isis::Process::SetOutputCube ( const QString & parameter)
virtualinherited

Allocates a user-specified output cube whose size matches the first input cube.

Returns
Cube*
Parameters
parameterUser specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType.
Exceptions
Isis::iException::Message

Reimplemented in Isis::ProcessMapMosaic, Isis::ProcessImport, and Isis::ProcessMosaic.

References _FILEINFO_, Isis::Process::InputCubes, Isis::IException::Programmer, and Isis::Process::SetOutputCube().

Referenced by SetOutputCube(), Isis::ProcessImport::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::ProcessImport::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::ProcessImport::SetOutputCube(), Isis::Process::SetOutputCubeStretch(), Isis::ProcessPolygons::SetStatCubes(), and Isis::ProcessGroundPolygons::SetStatCubes().

◆ SetOutputCube() [4/4]

Isis::Cube * Isis::Process::SetOutputCube ( const QString & parameter,
const int ns,
const int nl,
const int nb = 1 )
virtualinherited

Allocates a user specified output cube whose size is specified by the programmer.

Returns
Cube*
Parameters
parameterUser specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType.
nsNumber of samples to allocate
nlNumber of lines to allocate
nbNumber of bands to allocate
Exceptions
Isis::iException::Message

References _FILEINFO_, Isis::Application::GetUserInterface(), Isis::IException::Programmer, and Isis::Process::SetOutputCube().

◆ SetOutputCubeStretch() [1/2]

Isis::Cube * Isis::Process::SetOutputCubeStretch ( const QString & parameter,
const int ns,
const int nl,
const int nb = 1,
UserInterface * ui = nullptr )
virtualinherited

Allocates a user specified output cube whose size is specified by the programmer.

Returns
Cube*
Parameters
parameterUser specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType.
nsNumber of samples to allocate
nlNumber of lines to allocate
nbNumber of bands to allocate
uiA user interface used to get the attributes needed. If null, the user interface will be obtained from the application.
Exceptions
Isis::iException::Message

References _FILEINFO_, Isis::Application::GetUserInterface(), Isis::IException::Programmer, and Isis::Process::SetOutputCube().

◆ SetOutputCubeStretch() [2/2]

Isis::Cube * Isis::Process::SetOutputCubeStretch ( const QString & parameter,
UserInterface * ui = nullptr )
virtualinherited

Allocates a user-specified output cube whose size matches the first input cube.

Returns
Cube*
Parameters
parameterUser specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType.
uiA user interface used to get the attributes needed for SetOutputCube.
Exceptions
Isis::iException::Message

References _FILEINFO_, Isis::Process::InputCubes, Isis::IException::Programmer, and Isis::Process::SetOutputCubeStretch().

Referenced by Isis::Process::SetOutputCubeStretch().

◆ SetOutputRequirements()

void Isis::ProcessByBrick::SetOutputRequirements ( int outputRequirements)

◆ SetProcessingDirection()

void Isis::ProcessByBrick::SetProcessingDirection ( ProcessingDirection direction)

Set the direction the data will be read, either all lines in a single band proceeding to the next band (LinesFirst), or every band for every line proceeding to the next line (BandsFirst).

The default is to process all lines of a band first.

Parameters
directionThe new enumerated processing direction

References BandsFirst.

◆ SetWrap()

void Isis::ProcessByBrick::SetWrap ( bool wrap)

This wrapping option only applys when there are two or more input cubes.

If wrapping is enabled and the second cube is smaller than the first The brick will be wrapped back to the beginning of the second cube once brick movement reaches the end of the cube. For example, if the brick shape was a single line and the second cube only had one line then function passed into StartProcess will receive the same contents in the 2nd input buffer every time.

Parameters
wrapSpecifies whether or not to wrap

Referenced by Isis::ProcessByLine::ProcessByLine(), and Isis::ProcessBySample::ProcessBySample().

◆ StartProcess() [1/7]

void Isis::ProcessByBrick::StartProcess ( std::function< void(Buffer &in)> funct)
virtual

Starts the systematic processing of the input cube by moving an arbitrarily-shaped brick through the cube.

This method requires that exactly one input cube be loaded. No output cubes are produced.

Parameters
funct(Buffer &in) Receive an nxm brick in the input buffer. If n=1 and m=lines this will process by columns. Likewise if n=samples and m=1 this will process by lines.
Exceptions
iException::Programmer

Reimplemented in Isis::ProcessByLine.

References Isis::Progress::CheckStatus(), Isis::Cube::isReadWrite(), Isis::Process::p_progress, Isis::Cube::read(), Isis::Progress::SetMaximumSteps(), and Isis::Cube::write().

◆ StartProcess() [2/7]

void Isis::ProcessByBrick::StartProcess ( std::function< void(Buffer &in, Buffer &out)> funct)
virtual

Starts the systematic processing of the input cube by moving an arbitrarily-shaped brick through the cube.

This method requires that exactly one input cube and one output cube be loaded using the SetInputCube and SetOutputCube methods.

Parameters
funct(Buffer &in, Buffer &out) Receive an nxm brick in the input buffer and output the an nxm brick. If n=1 and m=lines this will process by columns. Likewise if n=samples and m=1 this will process by lines.
Exceptions
iException::Programmer

Reimplemented in Isis::ProcessByLine.

References Isis::Progress::CheckStatus(), Isis::Process::InputCubes, Isis::Process::OutputCubes, Isis::Process::p_progress, and Isis::Progress::SetMaximumSteps().

◆ StartProcess() [3/7]

void Isis::ProcessByBrick::StartProcess ( std::function< void(std::vector< Buffer * > &in, std::vector< Buffer * > &out)> funct)
virtual

Starts the systematic processing of the input cube by moving an arbitrarily-shaped brick through the cube.

This method allows multiple input and output cubes.

Parameters
funct(vector<Buffer *> &in, vector<Buffer *> &out) Receive an nxm brick in the input buffer. If n=1 and m=lines this will process by columns. Likewise if n=samples and m=1 this will process by lines.
Exceptions
iException::Programmer

References Isis::Progress::CheckStatus(), Isis::Process::InputCubes, Isis::Process::OutputCubes, Isis::Process::p_progress, Isis::Progress::SetMaximumSteps(), and Wraps().

◆ StartProcess() [4/7]

virtual void Isis::Process::StartProcess ( void funct())
inlinevirtualinherited

In the base class, this method will invoked a user-specified function exactly one time.

In derived classes such as ProcessByLine, the StartProcess will invoke a user-specified function for every line in a cube.

Parameters
funct()Name of your processing function

◆ StartProcess() [5/7]

void Isis::ProcessByBrick::StartProcess ( void functBuffer &in)
virtual

Starts the systematic processing of the input cube by moving an arbitrarily-shaped brick through the cube.

This method requires that exactly one input cube be loaded. No output cubes are produced.

Parameters
funct(Buffer &in) Receive an nxm brick in the input buffer. If n=1 and m=lines this will process by columns. Likewise if n=samples and m=1 this will process by lines.
Exceptions
iException::Programmer

Reimplemented in Isis::ProcessByTile.

References Isis::Progress::CheckStatus(), Isis::Cube::isReadWrite(), Isis::Process::p_progress, Isis::Cube::read(), Isis::Progress::SetMaximumSteps(), and Isis::Cube::write().

Referenced by Isis::ProcessByLine::StartProcess(), Isis::ProcessByLine::StartProcess(), Isis::ProcessByTile::StartProcess(), Isis::ProcessByTile::StartProcess(), Isis::ProcessBySpectra::StartProcess(), Isis::ProcessByLine::StartProcess(), Isis::ProcessBySample::StartProcess(), Isis::ProcessBySpectra::StartProcess(), Isis::ProcessByLine::StartProcess(), Isis::ProcessBySample::StartProcess(), Isis::ProcessByTile::StartProcess(), Isis::ProcessByLine::StartProcess(), Isis::ProcessBySample::StartProcess(), and Isis::ProcessBySpectra::StartProcess().

◆ StartProcess() [6/7]

void Isis::ProcessByBrick::StartProcess ( void functBuffer &in, Buffer &out)
virtual

Starts the systematic processing of the input cube by moving an arbitrarily-shaped brick through the cube.

This method requires that exactly one input cube and one output cube be loaded using the SetInputCube and SetOutputCube methods.

Parameters
funct(Buffer &in, Buffer &out) Receive an nxm brick in the input buffer and output the an nxm brick. If n=1 and m=lines this will process by columns. Likewise if n=samples and m=1 this will process by lines.
Exceptions
iException::Programmer

Reimplemented in Isis::ProcessByTile.

References Isis::Progress::CheckStatus(), Isis::Process::InputCubes, Isis::Process::OutputCubes, Isis::Process::p_progress, and Isis::Progress::SetMaximumSteps().

◆ StartProcess() [7/7]

void Isis::ProcessByBrick::StartProcess ( void functstd::vector< Buffer * > &in, std::vector< Buffer * > &out)
virtual

Starts the systematic processing of the input cube by moving an arbitrarily-shaped brick through the cube.

This method allows multiple input and output cubes.

Parameters
funct(vector<Buffer *> &in, vector<Buffer *> &out) Receive an nxm brick in the input buffer. If n=1 and m=lines this will process by columns. Likewise if n=samples and m=1 this will process by lines.
Exceptions
iException::Programmer

Reimplemented in Isis::ProcessByTile.

References Isis::Progress::CheckStatus(), Isis::Process::InputCubes, Isis::Process::OutputCubes, Isis::Process::p_progress, Isis::Progress::SetMaximumSteps(), and Wraps().

◆ VerifyCubes()

void Isis::ProcessByBrick::VerifyCubes ( IOCubes cn)

Verifies the dimensions of the input/output cubes.

Parameters
cnAn IOCubes enumeration for one of three possible Input/Output situations: InPlace: The input cube is the output cube InputOutput: One input cube and one output cube InputOutputList: A vector of input and output cubes. The input vector is not necessarily the same length as the output vector
Exceptions
iException::Message

References _FILEINFO_, InPlace, Isis::Process::InputCubes, InputOutput, InputOutputList, Isis::Process::OutputCubes, Isis::IException::Programmer, and Isis::SpatialMatch.

Referenced by Isis::ProcessByLine::ProcessCube(), Isis::ProcessBySample::ProcessCube(), Isis::ProcessBySpectra::ProcessCube(), Isis::ProcessByTile::ProcessCube(), Isis::ProcessByLine::ProcessCubeInPlace(), Isis::ProcessBySample::ProcessCubeInPlace(), Isis::ProcessBySpectra::ProcessCubeInPlace(), Isis::ProcessByTile::ProcessCubeInPlace(), Isis::ProcessByLine::ProcessCubes(), Isis::ProcessBySample::ProcessCubes(), Isis::ProcessBySpectra::ProcessCubes(), Isis::ProcessByTile::ProcessCubes(), Isis::ProcessByLine::StartProcess(), Isis::ProcessByLine::StartProcess(), Isis::ProcessByTile::StartProcess(), Isis::ProcessByTile::StartProcess(), Isis::ProcessBySpectra::StartProcess(), Isis::ProcessByLine::StartProcess(), Isis::ProcessBySample::StartProcess(), Isis::ProcessBySpectra::StartProcess(), Isis::ProcessByLine::StartProcess(), Isis::ProcessBySample::StartProcess(), Isis::ProcessByTile::StartProcess(), Isis::ProcessByLine::StartProcess(), Isis::ProcessBySample::StartProcess(), and Isis::ProcessBySpectra::StartProcess().

◆ Wraps()

bool Isis::ProcessByBrick::Wraps ( )

Returns true if the wrapping option is enabled.

See also
SetWrap()
Returns
The value of the wrapping option

Referenced by ProcessCubes(), StartProcess(), and StartProcess().

◆ WriteHistory()

Member Data Documentation

◆ InputCubes

std::vector<Isis::Cube *> Isis::Process::InputCubes
protectedinherited

A vector of pointers to opened Cube objects.

The pointers are established in the SetInputCube/SetInputWorkCube methods.

Referenced by Isis::Process::AddInputCube(), Isis::Process::CalculateStatistics(), Isis::Process::CheckRequirements(), Isis::Process::ClearInputCubes(), Isis::ProcessExportPds4::CreateImageLabel(), Isis::ProcessExport::CreateWorldFile(), Isis::ProcessExportPds4::displaySettings(), Isis::ProcessExportPds::ExportTable(), Isis::ProcessExportPds4::fileAreaObservational(), Isis::ProcessExportPds::FixedJP2ImageRoot(), Isis::ProcessExport::GetBuffersBIL(), Isis::ProcessExport::GetBuffersBIP(), Isis::ProcessExport::GetBuffersBSQ(), Isis::ProcessExportPds4::identificationArea(), Isis::ProcessExportPds::LineBytes(), Isis::ProcessExportPds::OutputLabel(), ProcessCube(), Isis::ProcessExport::ProcessCubes(), ProcessCubes(), Isis::ProcessRubberSheet::processPatchTransform(), Isis::ProcessByLine::SetBricks(), SetInputBrickSize(), SetInputBrickSize(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessExport::SetInputRange(), Isis::ProcessExport::SetInputRange(), Isis::ProcessExport::SetInputRange(), SetOutputCube(), Isis::Process::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::Process::SetOutputCubeStretch(), Isis::ProcessGroundPolygons::SetStatCubes(), Isis::ProcessExportPds4::StandardAllMapping(), Isis::ProcessExportPds::StandardAllMapping(), Isis::ProcessExportPds4::standardBandBin(), Isis::ProcessExportPds::StandardImageImage(), Isis::ProcessExportPds4::standardInstrument(), Isis::ProcessExportPds::StandardJP2Image(), Isis::ProcessMosaic::StartProcess(), Isis::ProcessMapMosaic::StartProcess(), StartProcess(), StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessRubberSheet::StartProcess(), StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessByBoxcar::StartProcess(), Isis::ProcessByQuickFilter::StartProcess(), StartProcess(), Isis::ProcessExportPds::StreamJP2ImageRoot(), VerifyCubes(), and Isis::Process::WriteHistory().

◆ m_ownedCubes

QSet<Isis::Cube *>* Isis::Process::m_ownedCubes
protectedinherited

A list of cubes owned by this instant.

These cubes will be deleted on finalization. Process will not take ownership of cubes allocated outside of Process. It is the caller's responsibility to delete such cubes.

Referenced by Isis::Process::AddInputCube(), Isis::Process::AddOutputCube(), Isis::Process::ClearCubes(), Isis::Process::ClearInputCubes(), Isis::Process::ClearOutputCubes(), Isis::Process::Process(), and Isis::Process::~Process().

◆ OutputCubes

◆ p_bandStats

std::vector< std::vector< Isis::Statistics * > > Isis::Process::p_bandStats
protectedinherited

Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called.

Referenced by Isis::Process::BandStatistics(), and Isis::Process::CalculateStatistics().

◆ p_cubeStats

std::vector< Isis::Statistics * > Isis::Process::p_cubeStats
protectedinherited

Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called.

Referenced by Isis::Process::CalculateStatistics(), and Isis::Process::CubeStatistics().

◆ p_progress

◆ p_propagateHistory

bool Isis::Process::p_propagateHistory
protectedinherited

Flag indicating if history is to be propagated to output cubes.

Referenced by Isis::Process::Process(), Isis::Process::PropagateHistory(), Isis::ProcessMapMosaic::StartProcess(), and Isis::Process::WriteHistory().

◆ p_propagateLabels

bool Isis::Process::p_propagateLabels
protectedinherited

Flag indicating if labels are be propagated to output cubes.

Referenced by Isis::Process::Process(), Isis::Process::PropagateLabels(), and Isis::Process::SetOutputCube().

◆ p_propagateOriginalLabel

bool Isis::Process::p_propagateOriginalLabel
protectedinherited

Flag indicating if original lable is to be propagated to output cubes.

Referenced by Isis::Process::Process(), Isis::Process::PropagateOriginalLabel(), and Isis::Process::SetOutputCube().

◆ p_propagatePolygons

bool Isis::Process::p_propagatePolygons
protectedinherited

Flag indicating if blobs are be propagated to output cubes.

Referenced by Isis::Process::Process(), Isis::Process::PropagatePolygons(), and Isis::Process::SetOutputCube().

◆ p_propagateTables

bool Isis::Process::p_propagateTables
protectedinherited

Flag indicating if tables are be propagated to output cubes.

Referenced by Isis::Process::Process(), Isis::Process::PropagateTables(), and Isis::Process::SetOutputCube().


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