|
Isis 3.0 Object Programmers' Reference |
Home |
Process cubes by boxcar. More...
#include <ProcessByBoxcar.h>
Public Member Functions | |
| ProcessByBoxcar () | |
| Constructs a ProcessByBoxcar object. | |
| virtual | ~ProcessByBoxcar () |
| Destroys the ProcessByBoxcar object. | |
| void | SetBoxcarSize (const int ns, const int nl) |
| Sets the boxcar size. | |
| virtual void | StartProcess (void funct(Isis::Buffer &in, double &out)) |
| Starts the systematic processing of the input cube by moving a boxcar, p_boxSamples by p_boxLines, through the cube one pixel at a time. | |
| void | ProcessCube (void funct(Isis::Buffer &in, double &out)) |
| void | EndProcess () |
| End the boxcar processing sequence and cleans up by closing cubes, freeing memory, etc. | |
| void | Finalize () |
| End the boxcar processing sequence and cleans up by closing cubes, freeing memory, etc. | |
| virtual void | StartProcess (void funct()) |
| In the base class, this method will invoked a user-specified function exactly one time. | |
| virtual Isis::Cube * | SetInputCube (const QString ¶meter, const int requirements=0) |
| Opens an input cube specified by the user and verifies requirements are met. | |
| virtual Isis::Cube * | SetInputCube (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) |
| Set the InputCube vector to an opened Cube which was dynamically allocated. | |
| virtual Isis::Cube * | SetOutputCube (const QString ¶meter) |
| Allocates a user-specified output cube whose size matches the first input cube. | |
| virtual Isis::Cube * | SetOutputCube (const QString ¶meter, 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::Cube * | SetOutputCube (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::Progress * | Progress () |
| 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::Statistics * | CubeStatistics (const unsigned index) |
| Get the Statistics object for all bands of a specified input cube. | |
Protected Attributes | |
| Isis::Progress * | p_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. | |
Private Attributes | |
| bool | p_boxsizeSet |
| Indicates whether the boxcar size has been set. | |
| int | p_boxSamples |
| Number of samples in boxcar. | |
| int | p_boxLines |
| Number of lines in boxcar. | |
Process cubes by boxcar.
This is the processing class used to move a boxcar through cube data. This class allows only one input cube and one output cube.
Definition at line 55 of file ProcessByBoxcar.h.
|
inline |
Constructs a ProcessByBoxcar object.
Definition at line 66 of file ProcessByBoxcar.h.
References p_boxsizeSet.
|
inlinevirtual |
Destroys the ProcessByBoxcar object.
Definition at line 71 of file ProcessByBoxcar.h.
|
inlineinherited |
Get the vector of Statistics objects for each band separately of a specified input cube.
| index | The index of the input cube in InputCubes |
Definition at line 283 of file Process.h.
References Isis::Process::p_bandStats.
|
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.
Definition at line 721 of file Process.cpp.
References Isis::Statistics::AddData(), Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), Isis::Cube::lineCount(), Isis::Cube::read(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), and Isis::toString().
|
inherited |
Close owned cubes from the list and clear the list.
Definition at line 506 of file Process.cpp.
|
inherited |
Close owned input cubes from the list and clear the list.
Definition at line 516 of file Process.cpp.
Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::FileTool::saveAsReducedCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
inherited |
Close owned output cubes from the list and clear the list.
Definition at line 530 of file Process.cpp.
|
inlineinherited |
Get the Statistics object for all bands of a specified input cube.
| index | The index of the input cube in InputCubes |
Definition at line 297 of file Process.h.
References Isis::Process::p_cubeStats.
|
virtual |
End the boxcar processing sequence and cleans up by closing cubes, freeing memory, etc.
Reimplemented from Isis::Process.
Definition at line 128 of file ProcessByBoxcar.cpp.
References Isis::Process::EndProcess().
|
virtual |
End the boxcar processing sequence and cleans up by closing cubes, freeing memory, etc.
Reimplemented from Isis::Process.
Definition at line 139 of file ProcessByBoxcar.cpp.
References Isis::Process::Finalize().
|
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.
| 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. |
Definition at line 666 of file Process.cpp.
References _FILEINFO_, and Isis::PvlObject::findGroup().
|
inlineinherited |
This method returns a pointer to a Progress object.
Definition at line 263 of file Process.h.
References Isis::Process::p_progress.
Referenced by Isis::Equalization::calculateStatistics(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::ProcessMapMosaic::SetOutputCube(), and Isis::SpectralDefinition2D::SpectralDefinition2D().
|
inherited |
This method allows the programmer to propagate history to the output cube (default is true)
| prop | Flag indicating if history is to be propagated to output cubes. |
Definition at line 635 of file Process.cpp.
Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
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.
| prop | Flag indicating if labels are be propagated to output cubes. |
Definition at line 552 of file Process.cpp.
Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
inherited |
This method allows the programmer to propagate labels from a specific secondary cube.
| cube | IString containing the name of the cube containing the labels to propagate. |
Definition at line 563 of file Process.cpp.
References Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), and Isis::PvlObject::hasObject().
|
inherited |
This method allows the programmer to propagate original labels to the output cube (default is true)
| prop | Flag indicating if original labels is to be propagated to output cubes. |
Definition at line 646 of file Process.cpp.
Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
inherited |
This method allows the programmer to propagate input blobs to the output cube (default is true)
| prop | Flag indicating if input blobs are to be propagated to output cubes. |
Definition at line 625 of file Process.cpp.
Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
inherited |
This method allows the programmer to propagate input tables to the output cube (default is true)
| prop | Flag indicating if input tables are to be propagated to output cubes. |
Definition at line 591 of file Process.cpp.
Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
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.
Definition at line 600 of file Process.cpp.
References Isis::Cube::label(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::open(), and Isis::Cube::read().
| void Isis::ProcessByBoxcar::SetBoxcarSize | ( | const int | ns, |
| const int | nl | ||
| ) |
Sets the boxcar size.
| ns | Number of samples |
| nl | Number of lines |
Definition at line 40 of file ProcessByBoxcar.cpp.
|
virtualinherited |
Opens an input cube specified by the user and verifies requirements are met.
| 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 |
| Isis::iException::Message |
Reimplemented in Isis::ProcessByBrick, Isis::ProcessByLine, Isis::ProcessBySpectra, and Isis::ProcessBySample.
Definition at line 243 of file Process.cpp.
Referenced by Isis::ImageExporter::addChannel(), Isis::FileTool::saveAsEnlargedCube(), and Isis::ProcessGroundPolygons::SetStatCubes().
|
virtualinherited |
Opens an input cube specified by the programmer and verifies requirements are met.
| 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 |
| Isis::iException::Message |
Reimplemented in Isis::ProcessByBrick.
Definition at line 82 of file Process.cpp.
References _FILEINFO_, Isis::Cube::bandCount(), Isis::CubeAttributeInput::bands(), Isis::Cube::lineCount(), Isis::Cube::open(), Isis::Cube::sampleCount(), and Isis::Cube::setVirtualBands().
|
virtualinherited |
Set the InputCube vector to an opened Cube which was dynamically allocated.
This is used if there already exists a valid opened cube
| inCube | - Pointer to input Cube |
Reimplemented in Isis::ProcessByLine.
Definition at line 201 of file Process.cpp.
References _FILEINFO_, and Isis::Cube::isOpen().
|
virtualinherited |
Allocates a user-specified output cube whose size matches the first input cube.
| 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. |
| Isis::iException::Message |
Reimplemented in Isis::ProcessMosaic, Isis::ProcessImport, and Isis::ProcessMapMosaic.
Definition at line 266 of file Process.cpp.
References _FILEINFO_.
Referenced by Isis::FileTool::saveAsEnlargedCube().
|
virtualinherited |
Allocates a user specified output cube whose size is specified by the programmer.
| 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 |
| Isis::iException::Message |
Definition at line 302 of file Process.cpp.
References _FILEINFO_.
|
virtualinherited |
Allocates a output cube whose name and size is specified by the programmer.
| 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 |
| Isis::iException::Message |
Definition at line 334 of file Process.cpp.
References _FILEINFO_, Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::AttachedLabel, Isis::CubeAttributeOutput::byteOrder(), Isis::Cube::create(), Isis::CubeAttributeOutput::fileFormat(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), Isis::PvlContainer::isNamed(), Isis::Cube::label(), Isis::Cube::labelSize(), Isis::CubeAttributeOutput::maximum(), Isis::CubeAttributeOutput::minimum(), Isis::PvlContainer::name(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::pixelType(), Isis::CubeAttributeOutput::pixelType(), Isis::CubeAttributeOutput::propagateMinimumMaximum(), Isis::CubeAttributeOutput::propagatePixelType(), Isis::Cube::setBaseMultiplier(), Isis::Cube::setByteOrder(), Isis::Cube::setDimensions(), Isis::Cube::setFormat(), Isis::Cube::setLabelsAttached(), Isis::Cube::setLabelSize(), Isis::Cube::setMinMax(), Isis::Cube::setPixelType(), and Isis::Cube::write().
|
virtual |
Starts the systematic processing of the input cube by moving a boxcar, p_boxSamples by p_boxLines, through the cube one pixel at a time.
The input and output buffers contain a Boxcar of the size indicated in p_boxSamples and p_boxLines. The input and output cube must be initialized prior to calling this method.
| funct | (Isis::Buffer &in, double &out) Name of your processing function |
| Isis::IException::Programmer |
Definition at line 58 of file ProcessByBoxcar.cpp.
References _FILEINFO_, Isis::BufferManager::begin(), Isis::BufferManager::end(), Isis::BufferManager::next(), and Isis::Buffer::size().
|
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.
| funct() | Name of your processing function |
|
inherited |
Writes out the History blob to the cube.
Definition at line 687 of file Process.cpp.
References Isis::History::AddEntry(), Isis::PvlContainer::isNamed(), Isis::PvlObject::object(), Isis::PvlObject::objects(), and Isis::Cube::write().
Referenced by Isis::ImageImporter::import().
|
protectedinherited |
A vector of pointers to opened Cube objects.
The pointers are established in the SetInputCube/SetInputWorkCube methods.
Definition at line 193 of file Process.h.
Referenced by Isis::ProcessExport::CreateWorldFile(), Isis::ProcessExport::GetBuffersBIL(), Isis::ProcessExport::GetBuffersBIP(), Isis::ProcessExport::GetBuffersBSQ(), Isis::ProcessExport::InitProcess(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessExport::SetInputRange(), Isis::ProcessByQuickFilter::StartProcess(), and Isis::ProcessExport::StartProcess().
|
protectedinherited |
|
protectedinherited |
A vector of pointers to allocated Cube objects.
The pointers are established in the SetOutputCube method.
Definition at line 199 of file Process.h.
Referenced by Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessImport::ProcessJp2(), and Isis::ProcessByQuickFilter::StartProcess().
|
protectedinherited |
Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called.
Definition at line 180 of file Process.h.
Referenced by Isis::Process::BandStatistics().
|
private |
Number of lines in boxcar.
Definition at line 60 of file ProcessByBoxcar.h.
|
private |
Number of samples in boxcar.
Definition at line 59 of file ProcessByBoxcar.h.
|
private |
Indicates whether the boxcar size has been set.
Definition at line 58 of file ProcessByBoxcar.h.
Referenced by ProcessByBoxcar().
|
protectedinherited |
Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called.
Definition at line 187 of file Process.h.
Referenced by Isis::Process::CubeStatistics().
|
protectedinherited |
Pointer to a Progress object.
Definition at line 153 of file Process.h.
Referenced by Isis::ProcessExport::InitProcess(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessExport::ProcessExport(), Isis::ProcessImport::ProcessImport(), Isis::ProcessImport::ProcessJp2(), Isis::Process::Progress(), Isis::ProcessByBrick::RunProcess(), Isis::ProcessByQuickFilter::StartProcess(), and Isis::ProcessExport::StartProcess().
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |