USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::Process Class Reference
[High Level Cube I/O]

Base class for all cube processing derivatives. More...

#include <Process.h>

Inherited by Isis::ProcessByBoxcar, Isis::ProcessByBrick, Isis::ProcessByQuickFilter, Isis::ProcessExport, Isis::ProcessImport, Isis::ProcessMosaic, Isis::ProcessPolygons, and Isis::ProcessRubberSheet.

List of all members.

Public Member Functions

 Process ()
 Constructs a Process Object.
virtual ~Process ()
 Destroys the Process Object. It will close all opened cubes.
void StartProcess (void funct())
 In the base class, this method will invoked a user-specified function exactly one time.
virtual void EndProcess ()
 End the processing sequence and cleans up by closing cubes, freeing memory, etc.
virtual void Finalize ()
 Cleans up by closing cubes and freeing memory for owned cubes.
Isis::CubeSetInputCube (const QString &parameter, const int requirements=0)
 Opens an input cube specified by the user and verifies requirements are met.
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.
void SetInputCube (Isis::Cube *inCube)
 Set the InputCube vector to an opened Cube which was dynamically allocated.
Isis::CubeSetOutputCube (const QString &parameter)
 Allocates a user-specified output cube whose size matches the first input cube.
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.
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.
void AddInputCube (Cube *cube, bool owned=true)
void AddOutputCube (Cube *cube, bool owned=true)
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)
 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

Base class for all cube processing derivatives.

This is the core of the Isis system. Process, a very important base class is often used to derive new classes which process cubes in a systematic manner. Some of these derived classes include ProcessByLine, FilterProcess, RubberSheet, and Export. For history buffs, the Process class equates to DOCUBE in Isis 2.0 and DOIO in PICS. Essentially, this class manages much of the tedious programming work for cube i/o, user interaction, history, etc.

If you would like to see Process being used in implementation, see stats.cpp. For classes that inherit from Process, see ProcessByLine, FilterProcess, ProcessByBoxcar, RubberSheet, Export, or Import

A working application example of Process can be found in the stats class.

Author:
2002-06-21 Jeff Anderson

Constructor & Destructor Documentation

Isis::Process::Process (  ) 
Isis::Process::~Process (  )  [virtual]

Destroys the Process Object. It will close all opened cubes.

References EndProcess(), m_ownedCubes, and p_progress.


Member Function Documentation

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

References InputCubes, and m_ownedCubes.

Referenced by SetInputCube().

void Isis::Process::AddOutputCube ( Cube cube,
bool  owned = true 
)
std::vector<Isis::Statistics *> Isis::Process::BandStatistics ( const unsigned  index  )  [inline]

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

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

References p_bandStats.

void Isis::Process::CalculateStatistics (  ) 

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::Statistics::AddData(), Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), cube, Isis::Buffer::DoubleBuffer(), InputCubes, line, Isis::Cube::lineCount(), p_bandStats, p_cubeStats, Isis::Cube::read(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), and Isis::toString().

void Isis::Process::ClearCubes (  ) 

Close owned cubes from the list and clear the list.

References ClearInputCubes(), ClearOutputCubes(), and m_ownedCubes.

Referenced by Finalize().

void Isis::Process::ClearInputCubes (  ) 

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

References InputCubes, and m_ownedCubes.

Referenced by ClearCubes(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessGroundPolygons::SetOutputCube(), and Isis::ProcessMapMosaic::StartProcess().

void Isis::Process::ClearOutputCubes (  ) 

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

References m_ownedCubes, and OutputCubes.

Referenced by ClearCubes().

Isis::Statistics* Isis::Process::CubeStatistics ( const unsigned  index  )  [inline]

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

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

References p_cubeStats.

void Isis::Process::EndProcess (  )  [virtual]

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

Deprecated:
Please use Finalize()

Reimplemented in Isis::ProcessByBoxcar, Isis::ProcessByBrick, Isis::ProcessByTile, Isis::ProcessGroundPolygons, Isis::ProcessImportPds, and Isis::ProcessPolygons.

References Finalize().

Referenced by ~Process().

void Isis::Process::Finalize (  )  [virtual]

Cleans up by closing cubes and freeing memory for owned cubes.

Clears the lists for all cubes.

Reimplemented in Isis::ProcessByBoxcar, Isis::ProcessByBrick, Isis::ProcessByTile, Isis::ProcessGroundPolygons, and Isis::ProcessPolygons.

References ClearCubes().

Referenced by EndProcess().

QString Isis::Process::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.

Parameters:
mission Name of the mission data directory
file Name of the file to attach to the end of the directory
highestVersion If 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::PvlObject::FindGroup(), Isis::FileName::highestVersion(), Isis::IException::Io, and Isis::Preference::Preferences().

Isis::Progress* Isis::Process::Progress (  )  [inline]
void Isis::Process::PropagateHistory ( const bool  prop  ) 

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

Parameters:
prop Flag indicating if history is to be propagated to output cubes.

References p_propagateHistory.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

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

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

Parameters:
cube IString containing the name of the cube containing the labels to propagate.

References Isis::PvlObject::AddGroup(), Isis::PvlObject::AddObject(), Isis::PvlObject::FindObject(), g, Isis::PvlObject::Group(), Isis::PvlObject::Groups(), Isis::PvlObject::HasObject(), and OutputCubes.

void Isis::Process::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.

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:
prop Flag indicating if labels are be propagated to output cubes.

References p_propagateLabels.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

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

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

Parameters:
prop Flag indicating if original labels is to be propagated to output cubes.

References p_propagateOriginalLabel.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

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

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

Parameters:
prop Flag indicating if input blobs are to be propagated to output cubes.

References p_propagatePolygons.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

void Isis::Process::PropagateTables ( const QString &  fromName  ) 

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.

References Isis::Cube::label(), Isis::PvlObject::Object(), Isis::PvlObject::Objects(), Isis::Cube::open(), OutputCubes, and Isis::Cube::read().

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

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

Parameters:
prop Flag indicating if input tables are to be propagated to output cubes.

References p_propagateTables.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

void Isis::Process::SetInputCube ( Isis::Cube inCube  ) 

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

Reimplemented in Isis::ProcessByLine.

References _FILEINFO_, AddInputCube(), Isis::Cube::isOpen(), and Isis::IException::User.

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

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

Parameters:
fname Programmer specified work file. For example, "myfile.cub".
att The cube attributes to use when opening the input cube.
requirements Same as requirements on SetInputCube. See that method for more details. Defaults to 0
Returns:
Cube*
Exceptions:
Isis::iException::Message 

Reimplemented in Isis::ProcessByBrick.

References _FILEINFO_, AddInputCube(), Isis::AllMatchOrOne, Isis::Cube::bandCount(), Isis::BandMatchOrOne, Isis::CubeAttributeInput::bands(), cube, InputCubes, Isis::Cube::lineCount(), Isis::OneBand, Isis::Cube::open(), Isis::ReadWrite, Isis::Cube::sampleCount(), Isis::Cube::setVirtualBands(), Isis::SizeMatch, Isis::SpatialMatch, and Isis::IException::User.

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

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

Returns:
Cube*
Parameters:
parameter User 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".
requirements Use to specify requirements for the input file. The following are 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 

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

References IsisAml::GetFileName(), IsisAml::GetInputAttribute(), and Isis::Application::GetUserInterface().

Referenced by Isis::ProcessGroundPolygons::SetOutputCube().

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

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

Returns:
Cube*
Parameters:
fname Name of the output cube to allocate
att The cube attributes to use when creating the output cube.
ns Number of samples to allocate
nl Number of lines to allocate
nb Number of bands to allocate
Exceptions:
Isis::iException::Message 

References _FILEINFO_, Isis::PvlObject::AddGroup(), Isis::PvlObject::AddObject(), AddOutputCube(), Isis::AttachedLabel, base, Isis::CubeAttributeOutput::byteOrder(), Isis::Cube::create(), cube, Isis::CubeAttributeOutput::fileFormat(), Isis::PvlObject::FindObject(), Isis::PvlObject::Group(), Isis::PvlObject::Groups(), incube, InputCubes, Isis::PvlContainer::IsNamed(), Isis::Cube::label(), Isis::CubeAttributeOutput::labelAttachment(), Isis::Cube::labelSize(), Isis::CubeAttributeOutput::maximum(), Isis::CubeAttributeOutput::minimum(), mult, Isis::PvlContainer::Name(), Isis::PvlObject::Object(), Isis::PvlObject::Objects(), p_propagateLabels, p_propagateOriginalLabel, p_propagatePolygons, p_propagateTables, Isis::Cube::pixelType(), Isis::CubeAttributeOutput::pixelType(), Isis::IException::Programmer, Isis::CubeAttributeOutput::propagateMinimumMaximum(), Isis::CubeAttributeOutput::propagatePixelType(), Isis::Real, Isis::Cube::setBaseMultiplier(), Isis::Cube::setByteOrder(), Isis::Cube::setDimensions(), Isis::Cube::setFormat(), Isis::Cube::setLabelsAttached(), Isis::Cube::setLabelSize(), Isis::Cube::setMinMax(), Isis::Cube::setPixelType(), Isis::SignedWord, Isis::UnsignedByte, Isis::IException::User, Isis::Cube::write(), and WriteHistory().

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

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

Returns:
Cube*
Parameters:
parameter User 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.
ns Number of samples to allocate
nl Number of lines to allocate
nb Number of bands to allocate
Exceptions:
Isis::iException::Message 

Reimplemented in Isis::ProcessPolygons.

References _FILEINFO_, IsisAml::GetFileName(), IsisAml::GetOutputAttribute(), Isis::Application::GetUserInterface(), Isis::IException::Programmer, and SetOutputCube().

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

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

Returns:
Cube*
Parameters:
parameter User 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::ProcessImport, Isis::ProcessMapMosaic, and Isis::ProcessMosaic.

References _FILEINFO_, InputCubes, nb, nl, ns, and Isis::IException::Programmer.

Referenced by Isis::Equalization::applyCorrection(), Isis::ProcessMapMosaic::SetOutputCube(), and SetOutputCube().

void Isis::Process::StartProcess ( void   funct()  )  [inline]

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
void Isis::Process::WriteHistory ( Cube cube  ) 

Member Data Documentation

std::vector<Isis::Cube *> Isis::Process::InputCubes [protected]

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 AddInputCube(), AddOutputCube(), ClearCubes(), ClearInputCubes(), ClearOutputCubes(), Process(), and ~Process().

std::vector<Isis::Cube *> Isis::Process::OutputCubes [protected]
std::vector< std::vector< Isis::Statistics * > > Isis::Process::p_bandStats [protected]

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

Referenced by BandStatistics(), and CalculateStatistics().

std::vector< Isis::Statistics * > Isis::Process::p_cubeStats [protected]

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

Referenced by CalculateStatistics(), and CubeStatistics().

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

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

Flag indicating if labels are be propagated to output cubes.

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

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

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

Flag indicating if blobs are be propagated to output cubes.

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

Flag indicating if tables are be propagated to output cubes.

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


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