File failed to load: https://isis.astrogeology.usgs.gov/6.0.0/Object/assets/jax/output/NativeMML/config.js
 |
Isis Developer Reference
|
Go to the documentation of this file.
16 template <
typename T>
class QSet;
17 template <
typename T>
class QList;
220 const int requirements = 0);
223 int requirements = 0);
229 const int nlines,
const int nbands = 1);
231 const int nlines,
const int nbands = 1,
UserInterface *ui=
nullptr);
234 const int nsamps,
const int nlines,
235 const int nbands = 1);
263 QString
MissionData(
const QString &mission,
const QString &file,
264 bool highestVersion =
false);
280 const unsigned index) {
294 const unsigned index) {
Isis::CubeAttributeOutput & GetOutputAttribute(const QString ¶mName)
Gets the attributes for an output cube.
Definition: IsisAml.cpp:1919
void CalculateStatistics()
Calculates and stores off statistics on every band of every cube added to this process via the SetInp...
Definition: Process.cpp:824
Application * iApp
Definition: Application.cpp:51
std::vector< Isis::Statistics * > p_cubeStats
Holds the calculated statistics for every band together of every input cubei after the CalculateStati...
Definition: Process.h:179
void PropagateTables(const bool prop)
This method allows the programmer to propagate input tables to the output cube (default is true)
Definition: Process.cpp:678
std::vector< Isis::Cube * > InputCubes
A vector of pointers to opened Cube objects.
Definition: Process.h:185
This class is used to accumulate statistics on double arrays.
Definition: Statistics.h:94
PvlGroupIterator findGroup(const QString &name, PvlGroupIterator beg, PvlGroupIterator end)
Find a group with the specified name, within these indexes.
Definition: PvlObject.h:129
virtual QString fileName() const
Returns the opened cube's filename.
Definition: Cube.cpp:1563
PvlGroup & group(const int index)
Return the group at the specified index.
Definition: PvlObject.cpp:452
History readHistory(const QString &name="IsisCube") const
Read the History from the Cube.
Definition: Cube.cpp:847
void AddData(const double *data, const unsigned int count)
Add an array of doubles to the accumulators and counters.
Definition: Statistics.cpp:141
Buffer manager, for moving through a cube in lines.
Definition: LineManager.h:39
void setVirtualBands(const QList< QString > &vbands)
This allows the programmer to specify a subset of bands to work with.
Definition: Cube.cpp:1321
Contains Pvl Groups and Pvl Objects.
Definition: PvlObject.h:61
void CheckStatus()
Checks and updates the status.
Definition: Progress.cpp:105
Process()
Constructs a Process Object.
Definition: Process.cpp:28
void WriteHistory(Cube &cube)
Writes out the History blob to the cube.
Definition: Process.cpp:789
void read(Blob &blob, const std::vector< PvlKeyword > keywords=std::vector< PvlKeyword >()) const
This method will read data from the specified Blob object.
Definition: Cube.cpp:807
File name manipulation and expansion.
Definition: FileName.h:100
This is free and unencumbered software released into the public domain.
Definition: Process.h:16
void SetMaximumSteps(const int steps)
This sets the maximum number of steps in the process.
Definition: Progress.cpp:85
double * DoubleBuffer() const
Returns the value of the shape buffer.
Definition: Buffer.h:138
int groups() const
Returns the number of groups contained.
Definition: PvlObject.h:75
bool p_propagateTables
Flag indicating if tables are be propagated to output cubes.
Definition: Process.h:153
bool fileExists() const
Returns true if the file exists; false otherwise.
Definition: FileName.cpp:449
virtual Isis::Cube * SetOutputCubeStretch(const QString ¶meter, UserInterface *ui=nullptr)
Allocates a user-specified output cube whose size matches the first input cube.
Definition: Process.cpp:193
QString GetFileName(const QString ¶mName, QString extension="") const
Allows the retrieval of a value for a parameter of type "filename".
Definition: IsisAml.cpp:607
void setLabelSize(int labelBytes)
Used prior to the Create method, this will allocate a specific number of bytes in the label area for ...
Definition: Cube.cpp:1291
void PropagatePolygons(const bool prop)
This method allows the programmer to propagate input blobs to the output cube (default is true)
Definition: Process.cpp:727
std::vector< Isis::Cube * > OutputCubes
A vector of pointers to allocated Cube objects.
Definition: Process.h:191
int labelSize(bool actual=false) const
Returns the number of bytes used by the label.
Definition: Cube.cpp:1713
@ UnsignedWord
Definition: PixelType.h:31
Base class for all cube processing derivatives.
Definition: Process.h:143
void close(bool remove=false)
Closes the cube and updates the labels.
Definition: Cube.cpp:260
QString MissionData(const QString &mission, const QString &file, bool highestVersion=false)
This method reads the mission specific data directory from the user preference file,...
Definition: Process.cpp:768
Container for cube-like labels.
Definition: Pvl.h:119
int objects() const
Returns the number of objects.
Definition: PvlObject.h:219
Manipulate and parse attributes of output cube filenames.
Definition: CubeAttribute.h:473
void addObject(const PvlObject &object)
Add a PvlObject.
Definition: PvlObject.h:307
bool p_propagatePolygons
Flag indicating if blobs are be propagated to output cubes.
Definition: Process.h:157
void CheckRequirements(const Cube *cube, const int requirements)
Checks to make sure the input cube meets the inputted requirements.
Definition: Process.cpp:503
@ SignedWord
Definition: PixelType.h:32
PvlObject & object(const int index)
Return the object at the specified index.
Definition: PvlObject.cpp:489
void AddOutputCube(Cube *cube, bool owned=true)
Definition: Process.cpp:472
virtual void StartProcess(void funct())
In the base class, this method will invoked a user-specified function exactly one time.
Definition: Process.h:213
QString toString(bool boolToConvert)
Global function to convert a boolean to a string.
Definition: IString.cpp:211
virtual void EndProcess()
End the processing sequence and cleans up by closing cubes, freeing memory, etc.
Definition: Process.cpp:455
void PropagateOriginalLabel(const bool prop)
This method allows the programmer to propagate original labels to the output cube (default is true)
Definition: Process.cpp:748
std::vector< std::vector< Isis::Statistics * > > p_bandStats
Holds the calculated statistics for each band separately of every input cubei after the CalculateStat...
Definition: Process.h:172
virtual ~Process()
Destroys the Process Object. It will close all opened cubes.
Definition: Process.cpp:43
@ AttachedLabel
The input label is embedded in the image file.
Definition: CubeAttribute.h:32
const int ReadWrite
Definition: Process.h:24
QString expanded() const
Returns a QString of the full file name including the file path, excluding the attributes.
Definition: FileName.cpp:196
Contains multiple PvlContainers.
Definition: PvlGroup.h:41
int lineCount() const
Definition: Cube.cpp:1734
#define _FILEINFO_
Macro for the filename and line number.
Definition: IException.h:24
void ClearInputCubes()
Close owned input cubes from the list and clear the list.
Definition: Process.cpp:603
void setDimensions(int ns, int nl, int nb)
Used prior to the Create method to specify the size of the cube.
Definition: Cube.cpp:1217
void create(const QString &cfile)
This method will create an isis cube for writing.
Definition: Cube.cpp:414
void PropagateHistory(const bool prop)
This method allows the programmer to propagate history to the output cube (default is true)
Definition: Process.cpp:737
bool isNamed(const QString &match) const
Returns whether the given string is equal to the container name or not.
Definition: PvlContainer.h:72
void SetText(const QString &text)
Changes the value of the text string reported just before 0% processed.
Definition: Progress.cpp:61
void ClearOutputCubes()
Close owned output cubes from the list and clear the list.
Definition: Process.cpp:617
void AddInputCube(Cube *cube, bool owned=true)
Definition: Process.cpp:467
PixelType pixelType() const
Return the pixel type as an Isis::PixelType.
Definition: CubeAttribute.cpp:360
virtual Isis::Cube * SetInputCube(const QString ¶meter, const int requirements=0)
Opens an input cube specified by the user and verifies requirements are met.
Definition: Process.cpp:136
PvlObjectIterator findObject(const QString &name, PvlObjectIterator beg, PvlObjectIterator end)
Find the index of object with a specified name, between two indexes.
Definition: PvlObject.h:274
bool propagateMinimumMaximum() const
Return true if the min/max are to be propagated from an input cube.
Definition: CubeAttribute.cpp:177
int sampleCount() const
Definition: Cube.cpp:1807
void PropagateLabels(const bool prop)
This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to...
Definition: Process.cpp:639
void AddEntry()
Adds History PvlObject.
Definition: History.cpp:52
Isis::Progress * Progress()
This method returns a pointer to a Progress object.
Definition: Process.h:259
bool isOpen() const
Test if a cube file has been opened/created.
Definition: Cube.cpp:183
IO Handler for Isis Cubes.
Definition: Cube.h:167
QString name() const
Returns the container name.
Definition: PvlContainer.h:63
Isis exception class.
Definition: IException.h:91
virtual int bandCount() const
Returns the number of virtual bands for the cube.
Definition: Cube.cpp:1410
const int SpatialMatch
Definition: Process.h:21
const int BandMatchOrOne
Definition: Process.h:23
Program progress reporter.
Definition: Progress.h:42
bool p_propagateHistory
Flag indicating if history is to be propagated to output cubes.
Definition: Process.h:161
bool hasObject(const QString &name) const
Returns a boolean value based on whether the object exists in the current PvlObject or not.
Definition: PvlObject.h:323
LabelAttachment labelAttachment() const
Definition: CubeAttribute.cpp:400
void addGroup(const Isis::PvlGroup &group)
Add a group to the object.
Definition: PvlObject.h:186
void setByteOrder(ByteOrder byteOrder)
Used prior to the Create method, this will specify the byte order of pixels, either least or most sig...
Definition: Cube.cpp:1202
virtual Isis::Cube * SetOutputCube(const QString ¶meter)
Allocates a user-specified output cube whose size matches the first input cube.
Definition: Process.cpp:160
@ UnsignedInteger
Definition: PixelType.h:33
bool SetLine(const int line, const int band=1)
Positions the buffer at the requested line and returns a status indicator if the set was succesful or...
Definition: LineManager.cpp:44
const int SizeMatch
Definition: Process.h:20
Namespace for the standard library.
Read and store original labels.
Definition: OriginalLabel.h:35
PixelType pixelType() const
Definition: Cube.cpp:1758
ByteOrder byteOrder() const
Return the byte order as an Isis::ByteOrder.
Definition: CubeAttribute.cpp:455
Command Line and Xml loader, validation, and access.
Definition: UserInterface.h:140
Pvl * label() const
Returns a pointer to the IsisLabel object associated with the cube.
Definition: Cube.cpp:1701
@ SignedInteger
Definition: PixelType.h:34
void write(Blob &blob, bool overwrite=true)
This method will write a blob of data (e.g.
Definition: Cube.cpp:971
Isis::Progress * p_progress
Pointer to a Progress object.
Definition: Process.h:145
double maximum() const
Return the output cube attribute maximum.
Definition: CubeAttribute.cpp:309
int size() const
Returns the total number of pixels in the shape buffer.
Definition: Buffer.h:97
double minimum() const
Return the output cube attribute minimum.
Definition: CubeAttribute.cpp:294
void setFormat(Format format)
Used prior to the Create method, this will specify the format of the cube, either band,...
Definition: Cube.cpp:1266
void setPixelType(PixelType pixelType)
Used prior to the Create method, this will specify the output pixel type.
Definition: Cube.cpp:1304
QSet< Isis::Cube * > * m_ownedCubes
A list of cubes owned by this instant.
Definition: Process.h:199
static Preference & Preferences(bool unitTest=false)
Definition: Preference.cpp:86
FileName highestVersion() const
Searches the directory specified in the file name for the highest version of the file name.
Definition: FileName.cpp:313
Isis::Statistics * CubeStatistics(const unsigned index)
Get the Statistics object for all bands of a specified input cube.
Definition: Process.h:293
void setBaseMultiplier(double base, double mult)
Used prior to the Create method, this will specify the base and multiplier for converting 8-bit/16-bi...
Definition: Cube.cpp:1151
void ClearCubes()
Close owned cubes from the list and clear the list.
Definition: Process.cpp:593
virtual void Finalize()
Cleans up by closing cubes and freeing memory for owned cubes.
Definition: Process.cpp:463
void open(const QString &cfile, QString access="r")
This method will open an isis cube for reading or reading/writing.
Definition: Cube.cpp:627
Cube::Format fileFormat() const
Return the file format an Cube::Format.
Definition: CubeAttribute.cpp:267
@ UnsignedByte
Definition: PixelType.h:29
void setMinMax(double min, double max)
Used prior to the Create method, this will compute a good base and multiplier value given the minimum...
Definition: Cube.cpp:1168
bool propagatePixelType() const
Return true if the pixel type is to be propagated from an input cube.
Definition: CubeAttribute.cpp:165
std::vector< Isis::Statistics * > BandStatistics(const unsigned index)
Get the vector of Statistics objects for each band separately of a specified input cube.
Definition: Process.h:279
bool p_propagateLabels
Flag indicating if labels are be propagated to output cubes.
Definition: Process.h:149
bool p_propagateOriginalLabel
Flag indicating if original lable is to be propagated to output cubes.
Definition: Process.h:165
const int OneBand
Definition: Process.h:22
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16
void setLabelsAttached(bool attached)
Use prior to calling create, this sets whether or not to use separate label and data files.
Definition: Cube.cpp:1278
const int AllMatchOrOne
Definition: Process.h:25
@ Real
Definition: PixelType.h:35