Isis Developer Reference
Isis::ProcessExportPds Class Reference

Process class for exporting cubes to PDS standards. More...

#include <ProcessExportPds.h>

Inheritance diagram for Isis::ProcessExportPds:
Inheritance graph
Collaboration diagram for Isis::ProcessExportPds:
Collaboration graph

Public Types

enum  PdsFileType { Image , Qube , SpectralQube , JP2Image }
 File type to be exported. More...
 
enum  PdsResolution { Meter , Kilometer }
 Resolution units per pixel of the exported PDS file. More...
 
enum  PdsExportType { Stream , Fixed }
 Record format type of exported PDS file. More...
 
enum  ExportFormat { BSQ , BIL , BIP , JP2 }
 Storage order enumeration. More...
 

Public Member Functions

 ProcessExportPds ()
 Default Constructor - Set to default the data members.
 
 ~ProcessExportPds ()
 Destructor.
 
void StandardAllMapping (Pvl &mainPvl)
 Create the standard keywords for the IMAGE_MAP_PROJECTION group in a PDS label.
 
void StreamImageRoot (Pvl &mainPvl)
 Create the standard keywords for the ROOT object in a PDS IMAGE file.
 
void FixedImageRoot (Pvl &mainPvl)
 Create the fixed keywords for the ROOT object in a PDS IMAGE file.
 
void StreamJP2ImageRoot (Pvl &mainPvl)
 Create the standard keywords for the ROOT object in a PDS JP2 IMAGE file.
 
void FixedJP2ImageRoot (Pvl &mainPvl)
 Create the fixed keywords for the ROOT object in a PDS JP2 IMAGE file.
 
void StandardImageImage (Pvl &mainPvl)
 Create the standard keywords for an IMAGE object in a PDS IMAGE file.
 
void StandardJP2Image (Pvl &mainPvl)
 Create the standard keywords for an IMAGE object in a PDS JP2 IMAGE file.
 
void SetPdsResolution (PdsResolution resolutionUnits)
 Mutator method to set the output PDS image resolution to meters per pixel or kilometers per pixel.
 
void SetExportType (PdsExportType recordFormat)
 Mutator method to set the output PDS image record type to stream or fixed.
 
virtual PvlStandardPdsLabel (ProcessExportPds::PdsFileType type)
 Create a standard PDS label of the type specified.
 
void OutputLabel (std::ofstream &pdsFileStream)
 Write the PDS label to the supplied stream.
 
void updateChecksumInLabel (std::ofstream &pdsFileStream)
 Updates the CHECKSUM value on the label and rewrites to the output file.
 
void OutputDetachedLabel ()
 Write the PDS label to the a detached file.
 
void ExportTable (Isis::Table isisTable, QString detachedPdsTableFileName="")
 This method will add a table to be exported to PDS.
 
void StartProcess (std::ofstream &fout)
 This method fills the image data of the PDS file using the parent class ProcessExport::StartProcess, then appends any attached tables.
 
bool Detached ()
 Accessor function returns true if the output PDS file is set to detached.
 
bool Attached ()
 Accessor function returns true if the output PDS file is set to attached.
 
void SetDetached (QString detachedLabelFile)
 Mutator method to set the output PDS file to detached.
 
void SetAttached ()
 Mutator method to set the output PDS file to attached.
 
void ForceBands (bool force)
 Mutator method to set how the the BANDS keyword will be handled.
 
void ForceBandName (bool force)
 Mutator method to set how the BAND_NAME keyword will be handled.
 
void ForceCenterFilterWavelength (bool force)
 Mutator method to set how the CENTER_FILTER_WAVELENGTH keyword will be handled.
 
void ForceBandwidth (bool force)
 Mutator method to set how the BANDWIDTH keyword will be handled.
 
void ForceBandStorageType (bool force)
 Mutator method to set how the BAND_STORAGE_TYPE keyword will be handled.
 
void ForceOffset (bool force)
 Mutator method to set how the OFFSET keyword will be handled.
 
void ForceScalingFactor (bool force)
 Mutator method to set how the SCALING_FACTOR keyword will be handled.
 
void ForceSampleBits (bool force)
 Mutator method to set how the SAMPLE_BITS keyword will be handled.
 
void ForceSampleBitMask (bool force)
 Mutator method to set how the SAMPLE_BIT_MASK keyword will be handled.
 
void ForceSampleType (bool force)
 Mutator method to set how the SAMPLE_TYPE keyword will be handled.
 
void ForceCoreNull (bool force)
 Mutator method to set how the CORE_NULL keyword will be handled.
 
void ForceCoreLrs (bool force)
 Mutator method to set how the CORE_LOW_REPR_SATURATION keyword will be handled.
 
void ForceCoreLis (bool force)
 Mutator method to set how the CORE_LOW_INSTR_SATURATION keyword will be handled.
 
void ForceCoreHrs (bool force)
 Mutator method to set how the CORE_HIGH_REPR_SATURATION keyword will be handled.
 
void ForceCoreHis (bool force)
 Mutator method to set how the CORE_HIGH_INSTR_SATURATION keyword will be handled.
 
virtual void StartProcess (void funct(Isis::Buffer &in))
 This method invokes the process operation over a single input cube.
 
virtual void StartProcess (void funct(std::vector< Isis::Buffer * > &in))
 
virtual void StartProcess (std::ofstream &fout)
 Write an entire cube to an output file stream.
 
virtual void StartProcess (void funct())
 In the base class, this method will invoked a user-specified function exactly one time.
 
void SetOutputRange (const double minimum, const double maximum)
 Set output pixel range in Buffer.
 
void SetOutputNull (const double value)
 Set output special pixel value for NULL.
 
void SetOutputLis (const double value)
 Set output special pixel value for LIS.
 
void SetOutputLrs (const double value)
 Set output special pixel value for LRS.
 
void SetOutputHis (const double value)
 Set output special pixel value for HIS.
 
void SetOutputHrs (const double value)
 Set output special pixel value for HRS.
 
double OutputNull ()
 Return the output special pixel value for NULL.
 
double OutputLis ()
 Return the output special pixel value for LIS.
 
double OutputLrs ()
 Return the output special pixel value for LRS.
 
double OutputHis ()
 Return the output special pixel value for HIS.
 
double OutputHrs ()
 Return the output special pixel value for HRS.
 
bool HasInputRange () const
 
void SetInputRange ()
 Set input pixel range from user.
 
void SetInputRange (UserInterface &ui)
 
void SetInputRange (const double minimum, const double maximum)
 Set input pixel range from to a linear stretch.
 
void SetInputRange (const double minimum, const double maximum, const int index)
 Set input pixel range from to a linear stretch.
 
void SetInputRange (const double minimum, const double middle, const double maximum)
 Set input pixel range from to a piecewise linear stretch.
 
void SetInputRange (const double minimum, const double middle, const double maximum, const int index)
 Set input pixel range from to a piecewise linear stretch.
 
void CreateWorldFile (const QString &worldFile)
 Create a standard world file for the input cube.
 
void SetOutputEndian (enum ByteOrder endianness)
 Set byte endianness of the output cube.
 
void SetOutputType (Isis::PixelType pixelIn)
 Set output pixel bit type in Buffer.
 
void setCanGenerateChecksum (bool flag)
 @description Set m_canGenerateChecksum which determines if we can generate a MD5 checksum on the image data.
 
bool canGenerateChecksum ()
 @description Return if we can generate a checksum
 
QString checksum ()
 @description Generates a file checksum.
 
double GetInputMinimum (unsigned int n=0) const
 Get the valid minimum pixel value for the Nth input cube.
 
double GetInputMaximum (unsigned int n=0) const
 Get the valid maximum pixel value for the Nth input cube.
 
double GetOutputMinimum ()
 Get the valid minimum pixel value to be written to the output file.
 
double GetOutputMaximum ()
 Get the valid maximum pixel value to be written to the output file.
 
void setFormat (ExportFormat format)
 Sets the storage order of the output file.
 
template<typename Functor >
void ProcessCubes (const Functor &functor)
 
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.
 
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 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 Member Functions

int LineBytes ()
 Return the line bytes (record size) for the input cube, at present this is based on the number of samples and the bytes per pixel.
 
int LabelSize ()
 Return the size of the output PDS label.
 
virtual void CreateImageLabel ()
 Create a standard PDS label for type IMAGE.
 
void CreateQubeLabel ()
 Create a standard PDS label for type QUBE.
 
void CreateSpectralQubeLabel ()
 Create a standard PDS label for type SPECTRAL_QUBE.
 
QString ProjectionName (Pvl &inputLabel)
 Return a projection name.
 
std::vector< BufferManager * > GetBuffers ()
 
std::vector< BufferManager * > GetBuffersBSQ ()
 A single line of input data from each input cube will be passed to the line processing function.
 
std::vector< BufferManager * > GetBuffersBIL ()
 A single line of input data from each input cube will be passed to the line processing function.
 
std::vector< BufferManager * > GetBuffersBIP ()
 A single band of input data from each input cube will be passed to the band processing function.
 

Protected Attributes

PvlFormatPdsm_formatter
 Used to determine how to format the keyword values in the PDS file.
 
Pvlm_label
 Exported PDS label.
 
PdsExportType m_exportType
 Stream or Fixed.
 
ExportFormat p_format
 Current storage order.
 
double p_outputMinimum
 Desired minimum pixel value in the Buffer.
 
double p_outputMiddle
 Middle pixel value (minimum+maximun)/2.0 in the Buffer.
 
double p_outputMaximum
 Desired maximum pixel value in the Buffer.
 
std::vector< double > p_inputMinimum
 Minimum pixel value in the input cube to be mapped to the minimum value in the Buffer.
 
std::vector< double > p_inputMiddle
 Middle pixel value in the input cube to be mapped to the (minimum+maximum)/2.0 value in the Buffer.
 
std::vector< double > p_inputMaximum
 Maximum pixel value in the input cube to be mapped to the maximum value in the Buffer.
 
EndianSwapperp_endianSwap
 Object to swap the endianness of the raw output to either MSB or LSB.
 
ByteOrder p_endianType
 The byte order of the output file.
 
PixelType p_pixelType
 The bits per pixel of the output image.
 
std::vector< Stretch * > p_str
 Stretch object to ensure a reasonable range of pixel values in the output data.
 
double p_Null
 The output value for pixels whose input DNs are Null values.
 
double p_Lis
 The output value for pixels whose input DNs are Low Instrument Saturation values.
 
double p_Lrs
 The output value for pixels whose input DNs are Low Representation Saturation values.
 
double p_His
 The output value for pixels whose input DNs are High Instrument Saturation values.
 
double p_Hrs
 The output value for pixels whose input DNs are High Representation Saturation values.
 
bool p_Null_Set
 Indicates whether p_Null has been set (i.e.
 
bool p_Lis_Set
 Indicates whether p_Lis has been set (i.e.
 
bool p_Lrs_Set
 Indicates whether p_Lrs has been set (i.e.
 
bool p_His_Set
 Indicates whether p_His has been set (i.e.
 
bool p_Hrs_Set
 Indicates whether p_Hrs has been set (i.e.
 
QCryptographicHash * m_cryptographicHash
 A cryptographic hash that will generate an MD5 checksum of the image data.
 
bool m_canGenerateChecksum
 Flag to determine if a file checksum will be generated.
 
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 class for exporting cubes to PDS standards.

This class extends the ProcessExport class to allow the user to export cubes to PDS format.

Tables from the cube may also be exported. These exported PDS tables may be attached or detached. This should correspond to whether the labels of the exported PDS file are attached or detached. NOTE: If attached, the labels of the table should not be altered in the export program unless functionality is added to deal with the new start byte values for the tables.

Author
2006-09-05 Stuart Sides

Member Enumeration Documentation

◆ ExportFormat

Storage order enumeration.

Enumerator
BSQ 

Band sequential.

BIL 

Band interleaved by line.

BIP 

Band interleaved by pixel.

JP2 

Compressed JPEG2000.

◆ PdsExportType

Record format type of exported PDS file.

See also
http://pds.nasa.gov/documents/sr/Chapter15.pdf
Enumerator
Stream 

Stream Records. This type is generally used for ASCII files.

Fixed 

Fixed length records.

PDS recommends that FIXED_LENGTH records are used whenever possible.

◆ PdsFileType

File type to be exported.

See also
http://pds.nasa.gov/documents/sr/AppendixA.pdf
Enumerator
Image 

Two dimensional array of line/sample values.

These files generallly have the extension *.img or *.imq

Qube 

Multi-dimensional array (1-3 dimensional) whose axes may be interpreted as line/sample/band.

These files generally have the extension *.qub

SpectralQube 

Three dimensional objects with two spatial dimensions and one spectral dimension.

These files generally have the extension *.qub

JP2Image 

Image coding system JPEG 2000 formatted image.

These files generally have the extension *.jp2

◆ PdsResolution

Resolution units per pixel of the exported PDS file.

Enumerator
Meter 

Meters per pixel.

Kilometer 

Kilometers per pixel.

Constructor & Destructor Documentation

◆ ProcessExportPds()

Isis::ProcessExportPds::ProcessExportPds ( )

Default Constructor - Set to default the data members.

References Image, m_exportType, m_formatter, m_label, Meter, and Stream.

◆ ~ProcessExportPds()

Isis::ProcessExportPds::~ProcessExportPds ( )

Destructor.

References m_formatter, and m_label.

Member Function Documentation

◆ AddInputCube()

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

◆ AddOutputCube()

◆ Attached()

bool Isis::ProcessExportPds::Attached ( )

Accessor function returns true if the output PDS file is set to attached.

Returns
bool Indicates whether the PDS file is attached.

Referenced by ExportTable().

◆ 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().

◆ canGenerateChecksum()

bool Isis::ProcessExport::canGenerateChecksum ( )
inherited

@description Return if we can generate a checksum

Returns
Boolean to generate the checksum or not

References Isis::ProcessExport::m_canGenerateChecksum.

Referenced by FixedImageRoot(), and StreamImageRoot().

◆ 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().

◆ checksum()

QString Isis::ProcessExport::checksum ( )
inherited

@description Generates a file checksum.

This must be called after StartProcess.

Returns
QString Returns a QString of the checksum.

References _FILEINFO_, Isis::ProcessExport::checksum(), Isis::ProcessExport::m_canGenerateChecksum, Isis::ProcessExport::m_cryptographicHash, and Isis::IException::Programmer.

Referenced by Isis::ProcessExport::checksum(), and updateChecksumInLabel().

◆ 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().

◆ CreateImageLabel()

void Isis::ProcessExportPds::CreateImageLabel ( )
protectedvirtual

◆ CreateQubeLabel()

void Isis::ProcessExportPds::CreateQubeLabel ( )
protected

Create a standard PDS label for type QUBE.

References m_label, and StandardAllMapping().

◆ CreateSpectralQubeLabel()

void Isis::ProcessExportPds::CreateSpectralQubeLabel ( )
protected

Create a standard PDS label for type SPECTRAL_QUBE.

References m_label, and StandardAllMapping().

◆ CreateWorldFile()

void Isis::ProcessExport::CreateWorldFile ( const QString & worldFile)
inherited

Create a standard world file for the input cube.

This method creates a standard world file from the mapping group of the input cube.

Parameters
worldFile[in] Reference to a string containing the name of a file to write the world information to.

References Isis::Process::InputCubes, and Isis::Projection::SetWorld().

◆ 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.

◆ Detached()

bool Isis::ProcessExportPds::Detached ( )

Accessor function returns true if the output PDS file is set to detached.

Returns
bool Indicates whether the PDS file is detached.

Referenced by ExportTable().

◆ EndProcess()

◆ ExportTable()

void Isis::ProcessExportPds::ExportTable ( Isis::Table isisTable,
QString detachedPdsTableFileName = "" )

This method will add a table to be exported to PDS.

If the output PDS labels are set to detached, the PDS table will be written to a detached file in this method. If the output PDS product is set to attached, the table will be added to a buffer and written to the PDS file when the StartProcess() method is called. Attached tables are written to the file after the image data.

Warning: If attached tables are exported and the labels of these tables are modified, the start byte value of the labels will need to be updated. There is no existing method (UpdateAttachedTableLabels) to do this in ProcessExportPds. If this functionality is needed, this class will need to be modified accordingly.

Exceptions
IException::Unknown- "The output PDS file has been set to attached and a detached PDS table file name has been given. If detached is preferred, set the process to detached SetDetached() and call StandardPdsLabel() before calling ExportTable()."
IException::Unknown- "The output PDS file has been set to detached. A file name for the detached ouput PDS table file is required. If an attached output file is prefered, use the method ProcessExportPds::SetAttached() before calling ExportTable()."
Parameters
isisTableThe ISIS Table object to be exported to PDS.
detachedPdsTableFileNameThe name of the exported PDS table file, if detached. This value should not include a path. The path from the label file will be used.

References _FILEINFO_, Attached(), Isis::ByteOrderName(), Detached(), Isis::Process::InputCubes, LabelSize(), LineBytes(), m_label, Isis::ProcessExport::p_endianType, Isis::toString(), and Isis::IException::Unknown.

◆ Finalize()

void Isis::Process::Finalize ( )
virtualinherited

◆ FixedImageRoot()

void Isis::ProcessExportPds::FixedImageRoot ( Pvl & mainPvl)

Create the fixed keywords for the ROOT object in a PDS IMAGE file.

Parameters
mainPvl

References Isis::ProcessExport::canGenerateChecksum().

Referenced by CreateImageLabel().

◆ FixedJP2ImageRoot()

void Isis::ProcessExportPds::FixedJP2ImageRoot ( Pvl & mainPvl)

Create the fixed keywords for the ROOT object in a PDS JP2 IMAGE file.

Parameters
mainPvl

References _FILEINFO_, Isis::Process::InputCubes, Isis::ProcessExport::p_pixelType, Isis::IException::Programmer, Isis::Real, Isis::SignedWord, Isis::toString(), and Isis::UnsignedWord.

Referenced by CreateImageLabel().

◆ ForceBandName()

void Isis::ProcessExportPds::ForceBandName ( bool force)

Mutator method to set how the BAND_NAME keyword will be handled.

If false and the BAND_NAME keyword exists in the IMAGE object of the PDS labels, the keyword will be removed. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to keep the BAND_NAME keyword in the PDS image labels.

◆ ForceBands()

void Isis::ProcessExportPds::ForceBands ( bool force)

Mutator method to set how the the BANDS keyword will be handled.

If false, the BANDS keyword will be removed from the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to keep the BANDS keyword in the PDS image labels.

◆ ForceBandStorageType()

void Isis::ProcessExportPds::ForceBandStorageType ( bool force)

Mutator method to set how the BAND_STORAGE_TYPE keyword will be handled.

If true, the BAND_STORAGE_TYPE keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to add the BAND_STORAGE_TYPE keyword in the PDS image labels.

◆ ForceBandwidth()

void Isis::ProcessExportPds::ForceBandwidth ( bool force)

Mutator method to set how the BANDWIDTH keyword will be handled.

If false and the BANDWIDTH keyword exists in the IMAGE object of the PDS labels, the keyword will be removed. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to keep the BANDWIDTH keyword in the PDS image labels.

◆ ForceCenterFilterWavelength()

void Isis::ProcessExportPds::ForceCenterFilterWavelength ( bool force)

Mutator method to set how the CENTER_FILTER_WAVELENGTH keyword will be handled.

If false and the CENTER_FILTER_WAVELENGTH keyword exists in the IMAGE object of the PDS labels, the keyword will be removed. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to keep the CENTER_FILTER_WAVELENGTH keyword in the PDS image labels.

◆ ForceCoreHis()

void Isis::ProcessExportPds::ForceCoreHis ( bool force)

Mutator method to set how the CORE_HIGH_INSTR_SATURATION keyword will be handled.

If true, the CORE_HIGH_INSTR_SATURATION keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to add the CORE_HIGH_INSTR_SATURATION keyword in the PDS image labels.

◆ ForceCoreHrs()

void Isis::ProcessExportPds::ForceCoreHrs ( bool force)

Mutator method to set how the CORE_HIGH_REPR_SATURATION keyword will be handled.

If true, the CORE_HIGH_REPR_SATURATION keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to add the CORE_HIGH_REPR_SATURATION keyword in the PDS image labels.

◆ ForceCoreLis()

void Isis::ProcessExportPds::ForceCoreLis ( bool force)

Mutator method to set how the CORE_LOW_INSTR_SATURATION keyword will be handled.

If true, the CORE_LOW_INSTR_SATURATION keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to add the CORE_LOW_INSTR_SATURATION keyword in the PDS image labels.

◆ ForceCoreLrs()

void Isis::ProcessExportPds::ForceCoreLrs ( bool force)

Mutator method to set how the CORE_LOW_REPR_SATURATION keyword will be handled.

If true, the CORE_LOW_REPR_SATURATION keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to add the CORE_LOW_REPR_SATURATION keyword in the PDS image labels.

◆ ForceCoreNull()

void Isis::ProcessExportPds::ForceCoreNull ( bool force)

Mutator method to set how the CORE_NULL keyword will be handled.

If true, the CORE_NULL keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to add the CORE_NULL keyword in the PDS image labels.

◆ ForceOffset()

void Isis::ProcessExportPds::ForceOffset ( bool force)

Mutator method to set how the OFFSET keyword will be handled.

If true, the OFFSET keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to add the OFFSET keyword in the PDS image labels.

◆ ForceSampleBitMask()

void Isis::ProcessExportPds::ForceSampleBitMask ( bool force)

Mutator method to set how the SAMPLE_BIT_MASK keyword will be handled.

If true, the SAMPLE_BIT_MASK keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to add the SAMPLE_BIT_MASK keyword in the PDS image labels.

◆ ForceSampleBits()

void Isis::ProcessExportPds::ForceSampleBits ( bool force)

Mutator method to set how the SAMPLE_BITS keyword will be handled.

If true, the SAMPLE_BITS keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to add the SAMPLE_BITS keyword in the PDS image labels.

◆ ForceSampleType()

void Isis::ProcessExportPds::ForceSampleType ( bool force)

Mutator method to set how the SAMPLE_TYPE keyword will be handled.

If true, the SAMPLE_TYPE keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to add the SAMPLE_TYPE keyword in the PDS image labels.

◆ ForceScalingFactor()

void Isis::ProcessExportPds::ForceScalingFactor ( bool force)

Mutator method to set how the SCALING_FACTOR keyword will be handled.

If true, the SCALING_FACTOR keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.

Parameters
forceIndicates whether to force the process to add the SCALING_FACTOR keyword in the PDS image labels.

◆ GetBuffers()

◆ GetBuffersBIL()

vector< BufferManager * > Isis::ProcessExport::GetBuffersBIL ( )
protectedinherited

A single line of input data from each input cube will be passed to the line processing function.

Note the data will be stretched based on the invocations of the SetInputRange and SetOutputRange methods.

Parameters
funct(Isis::Buffer &b) Name of your line processing function. The buffer in will contain stretched input cube pixels for an entire line of each input cube. These pixels must be written to the foreign output file (e.g, jpg, tif, etc).

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

Referenced by Isis::ProcessExport::GetBuffers().

◆ GetBuffersBIP()

vector< BufferManager * > Isis::ProcessExport::GetBuffersBIP ( )
protectedinherited

A single band of input data from each input cube will be passed to the band processing function.

Note the data will be stretched based on the invocations of the SetInputRange and SetOutputRange methods.

Parameters
funct(Isis::Buffer &b) Name of your band processing function. The buffer in will contain stretched input cube pixels for an entire line of each input cube. These pixels must be written to the foreign output file (e.g, jpg, tif, etc).

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

Referenced by Isis::ProcessExport::GetBuffers().

◆ GetBuffersBSQ()

vector< BufferManager * > Isis::ProcessExport::GetBuffersBSQ ( )
protectedinherited

A single line of input data from each input cube will be passed to the line processing function.

Note the data will be stretched based on the invocations of the SetInputRange and SetOutputRange methods.

Parameters
funct(Isis::Buffer &b) Name of your line processing function. The buffer in will contain stretched input cube pixels for an entire line of each input cube. These pixels must be written to the foreign output file (e.g, jpg, tif, etc).

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

Referenced by Isis::ProcessExport::GetBuffers().

◆ GetInputMaximum()

double Isis::ProcessExport::GetInputMaximum ( unsigned int n = 0) const
inherited

Get the valid maximum pixel value for the Nth input cube.

References _FILEINFO_, Isis::ProcessExport::p_inputMaximum, and Isis::IException::Programmer.

Referenced by Isis::ImageExporter::inputMaximum().

◆ GetInputMinimum()

double Isis::ProcessExport::GetInputMinimum ( unsigned int n = 0) const
inherited

Get the valid minimum pixel value for the Nth input cube.

References _FILEINFO_, Isis::ProcessExport::p_inputMinimum, and Isis::IException::Programmer.

Referenced by Isis::ImageExporter::inputMinimum().

◆ GetOutputMaximum()

double Isis::ProcessExport::GetOutputMaximum ( )
inlineinherited

Get the valid maximum pixel value to be written to the output file.

References Isis::ProcessExport::p_outputMaximum.

◆ GetOutputMinimum()

double Isis::ProcessExport::GetOutputMinimum ( )
inlineinherited

Get the valid minimum pixel value to be written to the output file.

References Isis::ProcessExport::p_outputMinimum.

◆ HasInputRange()

bool Isis::ProcessExport::HasInputRange ( ) const
inherited

◆ LabelSize()

int Isis::ProcessExportPds::LabelSize ( )
protected

Return the size of the output PDS label.

Returns
Number of bytes in the label.

References Isis::PvlContainer::format(), Isis::PvlFormat::formatEOL(), and m_label.

Referenced by ExportTable(), and OutputLabel().

◆ LineBytes()

int Isis::ProcessExportPds::LineBytes ( )
protected

Return the line bytes (record size) for the input cube, at present this is based on the number of samples and the bytes per pixel.

Returns
Total number of bytes per line.

References Isis::Process::InputCubes, Isis::ProcessExport::p_pixelType, Isis::Cube::sampleCount(), and Isis::SizeOf().

Referenced by ExportTable(), OutputLabel(), and StartProcess().

◆ 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().

◆ OutputDetachedLabel()

void Isis::ProcessExportPds::OutputDetachedLabel ( )

Write the PDS label to the a detached file.

The PDS keywords that have place holder "?" for their values (such as LABEL_RECORDS and ^IMAGE) will be updated to their correct values before they are written.

References _FILEINFO_, OutputLabel(), and Isis::IException::Unknown.

◆ OutputHis()

double Isis::ProcessExport::OutputHis ( )
inherited

Return the output special pixel value for HIS.

References Isis::ProcessExport::p_His, Isis::ProcessExport::p_His_Set, and Isis::ProcessExport::p_outputMaximum.

Referenced by StandardImageImage(), and StandardJP2Image().

◆ OutputHrs()

double Isis::ProcessExport::OutputHrs ( )
inherited

Return the output special pixel value for HRS.

References Isis::ProcessExport::p_Hrs, Isis::ProcessExport::p_Hrs_Set, and Isis::ProcessExport::p_outputMaximum.

Referenced by StandardImageImage(), and StandardJP2Image().

◆ OutputLabel()

void Isis::ProcessExportPds::OutputLabel ( std::ofstream & os)

Write the PDS label to the supplied stream.

The PDS keywords that have place holder "?" for their values (such as LABEL_RECORDS and ^IMAGE) will be updated to their correct values before they are written.

Parameters
Outputfile stream to which the pds label will be written.

References Fixed, Isis::PvlContainer::format(), Isis::PvlFormat::formatEOL(), Isis::PvlObject::hasKeyword(), Isis::Process::InputCubes, JP2Image, LabelSize(), LineBytes(), m_exportType, m_label, Stream, and Isis::toString().

Referenced by OutputDetachedLabel().

◆ OutputLis()

double Isis::ProcessExport::OutputLis ( )
inherited

Return the output special pixel value for LIS.

References Isis::ProcessExport::p_Lis, Isis::ProcessExport::p_Lis_Set, and Isis::ProcessExport::p_outputMinimum.

Referenced by StandardImageImage(), and StandardJP2Image().

◆ OutputLrs()

double Isis::ProcessExport::OutputLrs ( )
inherited

Return the output special pixel value for LRS.

References Isis::ProcessExport::p_Lrs, Isis::ProcessExport::p_Lrs_Set, and Isis::ProcessExport::p_outputMinimum.

Referenced by StandardImageImage(), and StandardJP2Image().

◆ OutputNull()

double Isis::ProcessExport::OutputNull ( )
inherited

Return the output special pixel value for NULL.

References Isis::ProcessExport::p_Null, Isis::ProcessExport::p_Null_Set, and Isis::ProcessExport::p_outputMinimum.

Referenced by StandardImageImage(), and StandardJP2Image().

◆ ProcessCubes()

template<typename Functor >
void Isis::ProcessExport::ProcessCubes ( const Functor & functor)
inlineinherited

◆ Progress()

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

◆ ProjectionName()

QString Isis::ProcessExportPds::ProjectionName ( Pvl & inputLabel)
protected

Return a projection name.

Parameters
inputLabel
Returns
String containing the name of the projection

References Isis::ProjectionFactory::Create().

Referenced by StandardAllMapping().

◆ 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().

◆ SetAttached()

void Isis::ProcessExportPds::SetAttached ( )

Mutator method to set the output PDS file to attached.

In this case, there will be a single output file containing the PDS label, image data, and any PDS tables that are added.

◆ setCanGenerateChecksum()

void Isis::ProcessExport::setCanGenerateChecksum ( bool flag)
inherited

@description Set m_canGenerateChecksum which determines if we can generate a MD5 checksum on the image data.

Parameters
flagboolean to generate the checksum or not

References Isis::ProcessExport::m_canGenerateChecksum.

◆ SetDetached()

void Isis::ProcessExportPds::SetDetached ( QString detachedLabelFile)

Mutator method to set the output PDS file to detached.

In this case, there will be separate output files containing the PDS label, image data, and any PDS tables that are added.

Parameters
detachedLabelFileA string containing the name of the detached PDS label file

◆ SetExportType()

void Isis::ProcessExportPds::SetExportType ( PdsExportType recordFormat)

Mutator method to set the output PDS image record type to stream or fixed.

Parameters
recordFormatEnumerated value for the record type of the exported PDS file.

References m_exportType.

◆ setFormat()

void Isis::ProcessExport::setFormat ( ExportFormat format)
inlineinherited

Sets the storage order of the output file.

References Isis::ProcessExport::p_format.

Referenced by Isis::ProcessExport::ProcessExport(), and StandardPdsLabel().

◆ SetInputCube() [1/3]

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

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 in Isis::ProcessByBrick, Isis::ProcessByBrick, and Isis::ProcessMosaic.

References Isis::Process::AddInputCube(), Isis::Process::CheckRequirements(), Isis::Cube::open(), Isis::ReadWrite, and Isis::Cube::setVirtualBands().

◆ SetInputCube() [2/3]

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

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 in Isis::ProcessByBrick, Isis::ProcessByLine, Isis::ProcessBySpectra, Isis::ProcessMosaic, Isis::ProcessByBrick, and Isis::ProcessBySample.

References Isis::Application::GetUserInterface(), and Isis::Process::SetInputCube().

Referenced by Isis::ProcessByLine::SetInputCube(), Isis::ProcessBySample::SetInputCube(), Isis::ProcessByBrick::SetInputCube(), Isis::ProcessMosaic::SetInputCube(), Isis::Process::SetInputCube(), Isis::ProcessByLine::SetInputCube(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessByBrick::SetInputCube(), Isis::ProcessBySample::SetInputCube(), and Isis::ProcessGroundPolygons::SetStatCubes().

◆ SetInputCube() [3/3]

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

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 in Isis::ProcessByBrick, and Isis::ProcessMosaic.

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

◆ SetInputRange() [1/6]

void Isis::ProcessExport::SetInputRange ( )
inherited

Set input pixel range from user.

This method performs the same function as SetInputRange(min,max) and SetInputRange(min,mid,max). However, the information for min/mid/max is obtained from the user via the command line. Therefore you must include the following parameter group in your application XML file:

<group name="Stretch Options">
<parameter name="STRETCH">
<type>string</type>
<default>
<item>LINEAR</item>
</default>
<brief>Type of stretch</brief>
<description>
This parameter is used to select one of three ways to stretch
(or map) output pixels. They are LINEAR, PIECEWISE, or MANUAL.
</description>
<list>
<option value="LINEAR">
<brief> Linear stretch </brief>
<description>
A minimum and maximum are automatically computed based on
the statistics of the selected band. A histogram of the
band is used to pick the minimum at 0.5% of the data and
the maximum at 99.5% of the data. Input pixels less than
or equal to the minimum are stretched to black while
pixels greater than the or equal to the maximum are
stretched to white. A linear mapping occurs between the
minimum and maximum.
</description>
<inclusions>
<item>MINPERCENT</item>
<item>MAXPERCENT</item>
</inclusions>
<exclusions>
<item>MINIMUM</item>
<item>MAXIMUM</item>
</exclusions>
</option>
<option value="PIECEWISE">
<brief> Piecewise-linear stretch </brief>
<description>
This option is similar to the LINEAR option. A minimum and
maximum are automatically computed. Additionally, the
median is computed and it is mapped to the middle gray
value (halfway between white and black). Therefore, it is
a piecewise-linear stretch with input pixels mapped
linearly between either 1) the minimum/median or 2) the
median/maximum. This option is useful for contrast
stretching cubes with skewed histograms to ensure a
balanced contrast.
</description>
<inclusions>
<item>MINPERCENT</item>
<item>MAXPERCENT</item>
</inclusions>
<exclusions>
<item>MINIMUM</item>
<item>MAXIMUM</item>
</exclusions>
</option>
<option value="MANUAL">
<brief> Manual stretch </brief>
<description>
This option allows you to pick your own stretch. You must
enter a value for MINIMUM and MAXIMUM
</description>
<inclusions>
<item>MINIMUM</item>
<item>MAXIMUM</item>
</inclusions>
<exclusions>
<item>MINPERCENT</item>
<item>MAXPERCENT</item>
</exclusions>
</option>
</list>
</parameter>
<parameter name="MINIMUM">
<type>double</type>
<brief>Minimum pixel value</brief>
<description>
The minimum input pixel value which will be mapped to black.
</description>
<lessThan>
<item>MAXIMUM</item>
</lessThan>
</parameter>
<parameter name="MAXIMUM">
<type>double</type>
<brief>Maximum pixel value</brief>
<description>
The maximum input pixel value which will be mapped to white.
</description>
<greaterThan>
<item>MINIMUM</item>
</greaterThan>
</parameter>
<parameter name="MINPERCENT">
<type>double</type>
<brief>Minimum Percent</brief>
<description>
The percentage of data in the histogram used to compute
the minimum pixel value in the stretch.
</description>
<default><item>0.5</item></default>
<lessThan>
<item>MAXPERCENT</item>
</lessThan>
</parameter>
<parameter name="MAXPERCENT">
<type>double</type>
<brief>Maximum Percent</brief>
<description>
The percentage of data in the histogram used to compute
the maximum pixel value in the stretch.
</description>
<default><item>99.5</item></default>
<greaterThan>
<item>MINPERCENT</item>
</greaterThan>
</parameter>
</group>

References Isis::Application::GetUserInterface(), and Isis::ProcessExport::SetInputRange().

Referenced by Isis::ProcessExport::SetInputRange(), Isis::ProcessExport::SetInputRange(), and Isis::ProcessExport::SetInputRange().

◆ SetInputRange() [2/6]

void Isis::ProcessExport::SetInputRange ( const double minimum,
const double maximum )
inherited

Set input pixel range from to a linear stretch.

This method allows the programmer to define what range of input pixels in the input cube get mapped to the output range in the Buffer. By default the output range is 0.0 to 1.0 (can be overridden using the SetOutputRange method). This version of SetInputRange allows the programmer to perform a simple linear stretch. That is, "minimum:0.0 maximum:1.0" or minimum is mapped to 0.0, maximum is mapped to 1.0 everything inbetween is mapped linearly (e.g., (minimum+maximum)/2.0:0.5). Also, everything less than the minimum is mapped to 0.0 and everything more than the maximum is mapped to 1.0. If you are uncertain about how stretches operate see the Stretch object. If the input range is never set, no stretch will occur.

Parameters
minimumMinimum pixel value in the input cube to be mapped to the minimum value in the Buffer
maximumMaximum pixel value in the input cube to be mapped to the maximum value in the Buffer
Exceptions
Isis::iException::Message

References Isis::ProcessExport::SetInputRange().

◆ SetInputRange() [3/6]

void Isis::ProcessExport::SetInputRange ( const double minimum,
const double maximum,
const int index )
inherited

Set input pixel range from to a linear stretch.

This method allows the programmer to define what range of input pixels in the input cube get mapped to the output range in the Buffer. By default the output range is 0.0 to 1.0 (can be overridden using the SetOutputRange method). This version of SetInputRange allows the programmer to perform a simple linear stretch. That is, "minimum:0.0 maximum:1.0" or minimum is mapped to 0.0, maximum is mapped to 1.0 everything inbetween is mapped linearly (e.g., (minimum+maximum)/2.0:0.5). Also, everything less than the minimum is mapped to 0.0 and everything more than the maximum is mapped to 1.0. If you are uncertain about how stretches operate see the Stretch object. If the input range is never set, no stretch will occur.

Parameters
minimumMinimum pixel value in the input cube to be mapped to the minimum value in the Buffer
maximumMaximum pixel value in the input cube to be mapped to the maximum value in the Buffer
indexThe index of the channel you are setting
Exceptions
Isis::iException::Message

References Isis::ProcessExport::SetInputRange().

◆ SetInputRange() [4/6]

void Isis::ProcessExport::SetInputRange ( const double minimum,
const double middle,
const double maximum )
inherited

Set input pixel range from to a piecewise linear stretch.

This method allows the programmer to define what range of input pixels in the input cube get mapped to the output range in the Buffer. By default the output range is 0.0 to 1.0 (can be overridden using the SetOutputRange method). This version of SetInputRange allows the programmer to perform a piecewise linear stretch. That is,"minimum:0.0 middle:0.5 maximum:1.0". The pixels from the input cube between minimum and middle are mapped to 0.0 and 0.5 linearly, while pixels between middle and maximum are mapped to 0.5 and 1.0 linearly. Those outside the range of minimum and maximum are mapped to 0.0 and 1.0 respectively. If you are uncertain about how stretches operate see the Stretch object. If the input range is never set, no stretch will occur.

Parameters
minimumMinimum pixel value in the input cube to be mapped to the minimum value in the Buffer
middleMiddle pixel value in the input cube to be mapped to the (minimum+maximum)/2.0 value in the Buffer
maximumMaximum pixel value in the input cube to be mapped to the maximum value in the Buffer
Exceptions
Isis::IException::Message

References _FILEINFO_, Isis::Process::InputCubes, Isis::ProcessExport::p_inputMaximum, Isis::ProcessExport::p_inputMiddle, Isis::ProcessExport::p_inputMinimum, and Isis::IException::Programmer.

◆ SetInputRange() [5/6]

void Isis::ProcessExport::SetInputRange ( const double minimum,
const double middle,
const double maximum,
const int index )
inherited

Set input pixel range from to a piecewise linear stretch.

This method allows the programmer to define what range of input pixels in the input cube get mapped to the output range in the Buffer. By default the output range is 0.0 to 1.0 (can be overridden using the SetOutputRange method). This version of SetInputRange allows the programmer to perform a piecewise linear stretch. That is,"minimum:0.0 middle:0.5 maximum:1.0". The pixels from the input cube between minimum and middle are mapped to 0.0 and 0.5 linearly, while pixels between middle and maximum are mapped to 0.5 and 1.0 linearly. Those outside the range of minimum and maximum are mapped to 0.0 and 1.0 respectively. If you are uncertain about how stretches operate see the Stretch object. If the input range is never set, no stretch will occur.

Parameters
minimumMinimum pixel value in the input cube to be mapped to the minimum value in the Buffer
middleMiddle pixel value in the input cube to be mapped to the (minimum+maximum)/2.0 value in the Buffer
maximumMaximum pixel value in the input cube to be mapped to the maximum value in the Buffer
indexThe index of the channel you are setting
Exceptions
Isis::iException::Message

References _FILEINFO_, Isis::Process::InputCubes, Isis::ProcessExport::p_inputMaximum, Isis::ProcessExport::p_inputMiddle, Isis::ProcessExport::p_inputMinimum, and Isis::IException::Programmer.

◆ SetInputRange() [6/6]

◆ SetOutputCube() [1/3]

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

◆ SetOutputCube() [2/3]

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 Isis::ProcessByBrick::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() [3/3]

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().

◆ SetOutputEndian()

void Isis::ProcessExport::SetOutputEndian ( enum ByteOrder byteOrderIn)
inherited

Set byte endianness of the output cube.

This method allows the programmer to specify whether the first byte of data output from the ProcessExport will be the most significant byte or the least significant byte. If the user does not explicitly set the endianness, it will default to that of the current system architecture

Parameters
byteOrderInenumeration of the endianness (MSB or LSB)

References Isis::Lsb, Isis::Msb, Isis::NoByteOrder, Isis::ProcessExport::p_endianSwap, and Isis::ProcessExport::p_endianType.

Referenced by Isis::ProcessExport::ProcessExport().

◆ SetOutputHis()

void Isis::ProcessExport::SetOutputHis ( const double value)
inherited

Set output special pixel value for HIS.

Sets the value for output special pixel HISs. HIS pixels values from the input cube will be set to this value. Be default this value will be set to the maximum out value set with SetOutputRange

Parameters
valueThe output pixel value for all HIS pixels

References Isis::ProcessExport::p_His, and Isis::ProcessExport::p_His_Set.

◆ SetOutputHrs()

void Isis::ProcessExport::SetOutputHrs ( const double value)
inherited

Set output special pixel value for HRS.

Sets the value for output special pixel HRSs. HRS pixels values from the input cube will be set to this value. Be default this value will be set to the maximum out value set with SetOutputRange

Parameters
valueThe output pixel value for all HRS pixels

References Isis::ProcessExport::p_Hrs, and Isis::ProcessExport::p_Hrs_Set.

◆ SetOutputLis()

void Isis::ProcessExport::SetOutputLis ( const double value)
inherited

Set output special pixel value for LIS.

Sets the value for output special pixel LISs. LIS pixels values from the input cube will be set to this value. Be default this value will be set to the minimum out value set with SetOutputRange

Parameters
valueThe output pixel value for all LIS pixels

References Isis::ProcessExport::p_Lis, and Isis::ProcessExport::p_Lis_Set.

◆ SetOutputLrs()

void Isis::ProcessExport::SetOutputLrs ( const double value)
inherited

Set output special pixel value for LRS.

Sets the value for output special pixel LRSs. LRS8 pixels values from the input cube will be set to this value. Be default this value will be set to the minimum out value set with SetOutputRange

Parameters
valueThe output pixel value for all LRS pixels

References Isis::ProcessExport::p_Lrs, and Isis::ProcessExport::p_Lrs_Set.

◆ SetOutputNull()

void Isis::ProcessExport::SetOutputNull ( const double value)
inherited

Set output special pixel value for NULL.

Sets the value for output special pixel NULLs. NULL pixels values from the input cube will be set to this value. Be default this value will be set to the minimum out value set with SetOutputRange

Parameters
valueThe output pixel value for all NULL pixels

References Isis::ProcessExport::p_Null, and Isis::ProcessExport::p_Null_Set.

◆ SetOutputRange()

void Isis::ProcessExport::SetOutputRange ( const double minimum,
const double maximum )
inherited

Set output pixel range in Buffer.

This method allows the programmer to specify the acceptable range of values contained in the Buffer. If this method is never invoked, all pixel values received in the Buffer of the export function will be in the range of 0.0 to 1.0. However, this can be overridden, for example, to 0.0 and 255.0, by invoking this method.

Parameters
minimumDesired minimum pixel value in the Buffer
maximumDesired maximum pixel value in the Buffer
Exceptions
Isis::iException::Message

References _FILEINFO_, Isis::ProcessExport::p_outputMaximum, Isis::ProcessExport::p_outputMiddle, Isis::ProcessExport::p_outputMinimum, and Isis::IException::Programmer.

Referenced by Isis::ProcessExport::SetOutputType().

◆ SetOutputType()

void Isis::ProcessExport::SetOutputType ( Isis::PixelType pixelIn)
inherited

Set output pixel bit type in Buffer.

This method specifies the type of pixel data that is going to be output. Essentially, it is a convenience method that will automatically calculate the necessary output range based on the minimum and maximum values of the bit type that is specified. Currently, the method only supported data types are Isis::UnsignedByte (Range of 0 to 255), Isis::SignedWord (Range of -32768 to 32767), Isis::UnsignedWord (Range of 0 to 65535), and Isis::Real (Range from the minimum floating-point value to the maximum floating-point value supported in C++; -FLT_MAX to FLT_MAX), since these are the only formats that can be output by ProcessExport. If neither this method nor the SetOutputRange method is invoked, all pixel values received in the Buffer of the export function will be in the range of 0.0 to 1.0.

NOTE: You must set the format type of the output data with SetFormat before calling this method. Otherwise, you will get an error.

Parameters
pixelInthis is an enumeration of the different pixel types. The only values that are recognized as valid are Isis::UnsignedByte, Isis::SignedWord, Isis::UnsignedWord, and Isis::Real.
Exceptions
Isis::iException::Message

References _FILEINFO_, Isis::ProcessExport::JP2, Isis::ProcessExport::p_format, Isis::ProcessExport::p_pixelType, Isis::IException::Programmer, Isis::Real, Isis::ProcessExport::SetOutputRange(), Isis::SignedWord, Isis::UnsignedByte, Isis::UnsignedWord, Isis::VALID_MAX1, Isis::VALID_MAX2, Isis::VALID_MAXU2, Isis::VALID_MIN1, Isis::VALID_MIN2, and Isis::VALID_MINU2.

Referenced by Isis::ProcessExport::ProcessExport().

◆ SetPdsResolution()

void Isis::ProcessExportPds::SetPdsResolution ( PdsResolution resolutionUnits)

Mutator method to set the output PDS image resolution to meters per pixel or kilometers per pixel.

Parameters
resolutionUnitsEnumerated value for the units type to be set.

◆ StandardAllMapping()

void Isis::ProcessExportPds::StandardAllMapping ( Pvl & outputPvl)

Create the standard keywords for the IMAGE_MAP_PROJECTION group in a PDS label.

Parameters
mainPvl
Exceptions
Isis::IException::Message

References Isis::PvlObject::findObject(), Isis::Process::InputCubes, Kilometer, ProjectionName(), Isis::PvlKeyword::setValue(), Isis::toString(), Isis::PvlObject::Traverse, and Isis::PvlKeyword::unit().

Referenced by CreateImageLabel(), CreateQubeLabel(), and CreateSpectralQubeLabel().

◆ StandardImageImage()

◆ StandardJP2Image()

◆ StandardPdsLabel()

Pvl & Isis::ProcessExportPds::StandardPdsLabel ( ProcessExportPds::PdsFileType type)
virtual

Create a standard PDS label of the type specified.

Create a standard PDS label of the type specified. The type must be Image. Qube and SpectralQube are not supported.

NOTE: This method should not be called until all setting have been finished. For example ProcessExport::SetOutputEndian

Parameters
typeThe type of PDS label to be created.
Returns
Pvl containing label information
Exceptions
Isis::iException::Message

References _FILEINFO_, CreateImageLabel(), Image, Isis::ProcessExport::JP2, JP2Image, m_formatter, m_label, Isis::ProcessExport::setFormat(), Isis::PvlContainer::setFormat(), Isis::Pvl::setTerminator(), and Isis::IException::User.

◆ StartProcess() [1/5]

void Isis::ProcessExport::StartProcess ( std::ofstream & fout)
virtual

Write an entire cube to an output file stream.

Just as with the other invocation of the StartProcess method, this will process an input cube buffer by buffer. Unlike the other invocation, this method takes care of writing the input data to an output file stream specified by the user instead of relying on an external function.

Parameters
&foutAn open stream to which the pixel data will be written. After calling this method once, the stream will contain all of the pixel data from the input cube.

Reimplemented from Isis::ProcessExport.

◆ StartProcess() [2/5]

void Isis::ProcessExportPds::StartProcess ( std::ofstream & fout)
virtual

This method fills the image data of the PDS file using the parent class ProcessExport::StartProcess, then appends any attached tables.

Parameters
foutOutput file stream to be filled with the PDS data.

Reimplemented from Isis::ProcessExport.

References _FILEINFO_, LineBytes(), Isis::ProcessExport::StartProcess(), and Isis::IException::Unknown.

◆ StartProcess() [3/5]

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() [4/5]

void Isis::ProcessExport::StartProcess ( void functIsis::Buffer &in)
virtual

This method invokes the process operation over a single input cube.

In the cases of BSQ and BIL this is a process by line. In the case of BIP, this is a process by band. A single buffer of input data will be padd to the buffer processing function. Note the data will be stretched based on the invocations of the SetInputRange and SetpOutputRange methods.

Parameters
funct(Isis::Buffer &b) Name of your buffer processing function. The buffer in will contain stretched input cube pixels for an entire buffer. These pixels must be written to the foreign output file (e.g, jpg, tif, etc).

Reimplemented from Isis::ProcessExport.

◆ StartProcess() [5/5]

virtual void Isis::ProcessExport::StartProcess ( void functstd::vector< Isis::Buffer * > &in)
virtual

Reimplemented from Isis::ProcessExport.

◆ StreamImageRoot()

void Isis::ProcessExportPds::StreamImageRoot ( Pvl & mainPvl)

Create the standard keywords for the ROOT object in a PDS IMAGE file.

Parameters
mainPvl

References Isis::ProcessExport::canGenerateChecksum().

Referenced by CreateImageLabel().

◆ StreamJP2ImageRoot()

void Isis::ProcessExportPds::StreamJP2ImageRoot ( Pvl & mainPvl)

Create the standard keywords for the ROOT object in a PDS JP2 IMAGE file.

Parameters
mainPvl

References _FILEINFO_, Isis::Process::InputCubes, Isis::ProcessExport::p_pixelType, Isis::IException::Programmer, Isis::Real, Isis::SignedWord, Isis::toString(), and Isis::UnsignedWord.

Referenced by CreateImageLabel().

◆ updateChecksumInLabel()

void Isis::ProcessExportPds::updateChecksumInLabel ( std::ofstream & pdsFileStream)

Updates the CHECKSUM value on the label and rewrites to the output file.

Parameters
std::ofstream&pdsFileStream Output file to write the label to.

References Isis::ProcessExport::checksum(), and m_label.

◆ 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(), ExportTable(), Isis::ProcessExportPds4::fileAreaObservational(), FixedJP2ImageRoot(), Isis::ProcessExport::GetBuffersBIL(), Isis::ProcessExport::GetBuffersBIP(), Isis::ProcessExport::GetBuffersBSQ(), Isis::ProcessExportPds4::identificationArea(), LineBytes(), OutputLabel(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessExport::ProcessCubes(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessRubberSheet::processPatchTransform(), Isis::ProcessByLine::SetBricks(), Isis::ProcessByBrick::SetInputBrickSize(), Isis::ProcessByBrick::SetInputBrickSize(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessExport::SetInputRange(), Isis::ProcessExport::SetInputRange(), Isis::ProcessExport::SetInputRange(), Isis::ProcessByBrick::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::Process::SetOutputCubeStretch(), Isis::ProcessGroundPolygons::SetStatCubes(), Isis::ProcessExportPds4::StandardAllMapping(), StandardAllMapping(), Isis::ProcessExportPds4::standardBandBin(), StandardImageImage(), Isis::ProcessExportPds4::standardInstrument(), StandardJP2Image(), Isis::ProcessMosaic::StartProcess(), Isis::ProcessMapMosaic::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessRubberSheet::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessByBoxcar::StartProcess(), Isis::ProcessByQuickFilter::StartProcess(), Isis::ProcessByBrick::StartProcess(), StreamJP2ImageRoot(), Isis::ProcessByBrick::VerifyCubes(), and Isis::Process::WriteHistory().

◆ m_canGenerateChecksum

bool Isis::ProcessExport::m_canGenerateChecksum
protectedinherited

◆ m_cryptographicHash

QCryptographicHash* Isis::ProcessExport::m_cryptographicHash
protectedinherited

A cryptographic hash that will generate an MD5 checksum of the image data.

Referenced by Isis::ProcessExport::checksum(), Isis::ProcessExport::ProcessExport(), Isis::ProcessExport::StartProcess(), and Isis::ProcessExport::~ProcessExport().

◆ m_exportType

PdsExportType Isis::ProcessExportPds::m_exportType
protected

Stream or Fixed.

Referenced by CreateImageLabel(), OutputLabel(), ProcessExportPds(), and SetExportType().

◆ m_formatter

PvlFormatPds* Isis::ProcessExportPds::m_formatter
protected

Used to determine how to format the keyword values in the PDS file.

Referenced by ProcessExportPds(), StandardPdsLabel(), and ~ProcessExportPds().

◆ m_label

◆ 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_endianSwap

EndianSwapper* Isis::ProcessExport::p_endianSwap
protectedinherited

Object to swap the endianness of the raw output to either MSB or LSB.

Referenced by Isis::ProcessExport::ProcessExport(), Isis::ProcessExport::SetOutputEndian(), and Isis::ProcessExport::~ProcessExport().

◆ p_endianType

◆ p_format

◆ p_His

double Isis::ProcessExport::p_His
protectedinherited

The output value for pixels whose input DNs are High Instrument Saturation values.

Referenced by Isis::ProcessExport::OutputHis(), and Isis::ProcessExport::SetOutputHis().

◆ p_His_Set

bool Isis::ProcessExport::p_His_Set
protectedinherited

Indicates whether p_His has been set (i.e.

if setHis() has been called).

Referenced by Isis::ProcessExport::OutputHis(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputHis().

◆ p_Hrs

double Isis::ProcessExport::p_Hrs
protectedinherited

The output value for pixels whose input DNs are High Representation Saturation values.

Referenced by Isis::ProcessExport::OutputHrs(), and Isis::ProcessExport::SetOutputHrs().

◆ p_Hrs_Set

bool Isis::ProcessExport::p_Hrs_Set
protectedinherited

Indicates whether p_Hrs has been set (i.e.

if setHrs() has been called).

Referenced by Isis::ProcessExport::OutputHrs(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputHrs().

◆ p_inputMaximum

std::vector<double> Isis::ProcessExport::p_inputMaximum
protectedinherited

◆ p_inputMiddle

std::vector<double> Isis::ProcessExport::p_inputMiddle
protectedinherited

Middle pixel value in the input cube to be mapped to the (minimum+maximum)/2.0 value in the Buffer.

Referenced by Isis::ProcessExport::ProcessExport(), Isis::ProcessExport::SetInputRange(), Isis::ProcessExport::SetInputRange(), and Isis::ProcessExport::SetInputRange().

◆ p_inputMinimum

◆ p_Lis

double Isis::ProcessExport::p_Lis
protectedinherited

The output value for pixels whose input DNs are Low Instrument Saturation values.

Referenced by Isis::ProcessExport::OutputLis(), and Isis::ProcessExport::SetOutputLis().

◆ p_Lis_Set

bool Isis::ProcessExport::p_Lis_Set
protectedinherited

Indicates whether p_Lis has been set (i.e.

if setLis() has been called).

Referenced by Isis::ProcessExport::OutputLis(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputLis().

◆ p_Lrs

double Isis::ProcessExport::p_Lrs
protectedinherited

The output value for pixels whose input DNs are Low Representation Saturation values.

Referenced by Isis::ProcessExport::OutputLrs(), and Isis::ProcessExport::SetOutputLrs().

◆ p_Lrs_Set

bool Isis::ProcessExport::p_Lrs_Set
protectedinherited

Indicates whether p_Lrs has been set (i.e.

if setLrs() has been called).

Referenced by Isis::ProcessExport::OutputLrs(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputLrs().

◆ p_Null

double Isis::ProcessExport::p_Null
protectedinherited

The output value for pixels whose input DNs are Null values.

Referenced by Isis::ProcessExport::OutputNull(), and Isis::ProcessExport::SetOutputNull().

◆ p_Null_Set

bool Isis::ProcessExport::p_Null_Set
protectedinherited

Indicates whether p_Null has been set (i.e.

if setNull() has been called).

Referenced by Isis::ProcessExport::OutputNull(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputNull().

◆ p_outputMaximum

◆ p_outputMiddle

double Isis::ProcessExport::p_outputMiddle
protectedinherited

Middle pixel value (minimum+maximun)/2.0 in the Buffer.

Referenced by Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputRange().

◆ p_outputMinimum

◆ p_pixelType

◆ 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().

◆ p_str

std::vector<Stretch *> Isis::ProcessExport::p_str
protectedinherited

Stretch object to ensure a reasonable range of pixel values in the output data.

Referenced by Isis::ProcessExport::ProcessCubes(), Isis::ProcessExport::StartProcess(), Isis::ProcessExport::StartProcess(), and Isis::ProcessExport::~ProcessExport().


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