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

#include <ProcessExportPds4.h>

Inheritance diagram for Isis::ProcessExportPds4:

Collaboration diagram for Isis::ProcessExportPds4:

Public Types
enum	ImageType { StandardImage, BinSetSpectrum, UniformlySampledSpectrum }

enum	ExportFormat { BSQ, BIL, BIP, JP2 }
	Storage order enumeration. More...

Public Member Functions
	ProcessExportPds4 ()
	Default Constructor - Set to default the data members. More...

	~ProcessExportPds4 ()
	Destructor. More...

QDomDocument &	StandardPds4Label ()
	Create a standard PDS4 image label from the input cube. More...

QDomDocument &	SpectralPds4Label ()

void	StandardAllMapping ()
	Create the standard keywords for the IMAGE_MAP_PROJECTION group in a PDS label. More...

void	CreateImageLabel ()
	Creates a PDS4 label. More...

void	StandardImageImage ()

void	OutputLabel (std::ofstream &os)
	Write the XML label to the supplied stream. More...

void	StartProcess (std::ofstream &fout)
	This method fills the image data of the PDS4 file using the parent class ProcessExport::StartProcess. More...

QDomDocument &	GetLabel ()
	Return the internalized PDS4 label. More...

void	WritePds4 (QString outFile)
	This method write out the labels and image data to the specified output file. More...

QDomElement	getElement (QStringList xmlPath, QDomElement parent=QDomElement())
	Convenience method to get an element given a path and its parent. More...

void	addHistory (QString description, QString date="tbd", QString version="1.0")
	Add a modification history instance by adding a Modification_Detail entry to the Modification_History element. More...

void	setLogicalId (QString lid)
	Allows mission specific programs to set logical_identifier required for PDS4 labels. More...

void	setVersionId (QString versionId)
	Allows mission specific programs to set version_id required for PDS4 labels. More...

void	setTitle (QString title)
	Allows mission specific programs to set the title required for PDS4 labels. More...

void	setSchemaLocation (QString schema)
	Allows mission specific programs to use specified versions of dictionaries. More...

void	setImageType (ImageType imageType)
	Create a standard PDS4 image label from the input cube. More...

void	setPixelDescription (QString description)
	Sets the description string which describes the pixel vales in File_Area_Observational. More...

void	reorder ()
	This method reorders the existing m_domDoc to follow PDS4 standards and fixes time formatting if needed. More...

void	addSchema (QString sch, QString xsd, QString xmlns, QString xmlnsURI)
	Adds necessary information to the xml header for a pds4 class. More...

void	addSchema (QString xsd, QString xmlns, QString xmlnsURI)
	Adds necessary information to the xml header for a pds4 class for schema which lack schematron files (.sch) More...

virtual void	StartProcess (void funct(Isis::Buffer &in))
	This method invokes the process operation over a single input cube. More...

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

virtual void	StartProcess (void funct(Isis::Buffer &in))
	This method invokes the process operation over a single input cube. More...

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

virtual void	StartProcess (void funct())
	In the base class, this method will invoked a user-specified function exactly one time. More...

void	SetOutputRange (const double minimum, const double maximum)
	Set output pixel range in Buffer. More...

void	SetOutputNull (const double value)
	Set output special pixel value for NULL. More...

void	SetOutputLis (const double value)
	Set output special pixel value for LIS. More...

void	SetOutputLrs (const double value)
	Set output special pixel value for LRS. More...

void	SetOutputHis (const double value)
	Set output special pixel value for HIS. More...

void	SetOutputHrs (const double value)
	Set output special pixel value for HRS. More...

double	OutputNull ()
	Return the output special pixel value for NULL. More...

double	OutputLis ()
	Return the output special pixel value for LIS. More...

double	OutputLrs ()
	Return the output special pixel value for LRS. More...

double	OutputHis ()
	Return the output special pixel value for HIS. More...

double	OutputHrs ()
	Return the output special pixel value for HRS. More...

bool	HasInputRange () const

void	SetInputRange ()
	Set input pixel range from user. More...

void	SetInputRange (UserInterface &ui)

void	SetInputRange (const double minimum, const double maximum)
	Set input pixel range from to a linear stretch. More...

void	SetInputRange (const double minimum, const double maximum, const int index)
	Set input pixel range from to a linear stretch. More...

void	SetInputRange (const double minimum, const double middle, const double maximum)
	Set input pixel range from to a piecewise linear stretch. More...

void	SetInputRange (const double minimum, const double middle, const double maximum, const int index)
	Set input pixel range from to a piecewise linear stretch. More...

void	CreateWorldFile (const QString &worldFile)
	Create a standard world file for the input cube. More...

void	SetOutputEndian (enum ByteOrder endianness)
	Set byte endianness of the output cube. More...

void	SetOutputType (Isis::PixelType pixelIn)
	Set output pixel bit type in Buffer. More...

void	setCanGenerateChecksum (bool flag)
	@description Set m_canGenerateChecksum which determines if we can generate a MD5 checksum on the image data. More...

bool	canGenerateChecksum ()
	@description Return if we can generate a checksum More...

QString	checksum ()
	@description Generates a file checksum. More...

double	GetInputMinimum (unsigned int n=0) const
	Get the valid minimum pixel value for the Nth input cube. More...

double	GetInputMaximum (unsigned int n=0) const
	Get the valid maximum pixel value for the Nth input cube. More...

double	GetOutputMinimum ()
	Get the valid minimum pixel value to be written to the output file. More...

double	GetOutputMaximum ()
	Get the valid maximum pixel value to be written to the output file. More...

void	setFormat (ExportFormat format)
	Sets the storage order of the output file. More...

template<typename Functor >
void	ProcessCubes (const Functor &functor)

virtual void	EndProcess ()
	End the processing sequence and cleans up by closing cubes, freeing memory, etc. More...

virtual void	Finalize ()
	Cleans up by closing cubes and freeing memory for owned cubes. More...

virtual Isis::Cube *	SetInputCube (const QString &parameter, const int requirements=0)
	Opens an input cube specified by the user and verifies requirements are met. More...

virtual Isis::Cube *	SetInputCube (const QString &fname, const Isis::CubeAttributeInput &att, int requirements=0)
	Opens an input cube specified by the programmer and verifies requirements are met. More...

virtual void	SetInputCube (Isis::Cube *inCube, int requirements=0)
	Set the InputCube vector to an opened Cube which was dynamically allocated. More...

virtual Isis::Cube *	SetOutputCube (const QString &parameter)
	Allocates a user-specified output cube whose size matches the first input cube. More...

virtual Isis::Cube *	SetOutputCube (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. More...

virtual Isis::Cube *	SetOutputCube (const QString &fname, const Isis::CubeAttributeOutput &att, const int nsamps, const int nlines, const int nbands=1)
	Allocates a output cube whose name and size is specified by the programmer. More...

virtual Isis::Cube *	SetOutputCubeStretch (const QString &parameter, UserInterface *ui=nullptr)
	Allocates a user-specified output cube whose size matches the first input cube. More...

virtual Isis::Cube *	SetOutputCubeStretch (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. More...

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

void	ClearCubes ()
	Close owned cubes from the list and clear the list. More...

void	ClearInputCubes ()
	Close owned input cubes from the list and clear the list. More...

void	ClearOutputCubes ()
	Close owned output cubes from the list and clear the list. More...

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

void	PropagateLabels (const QString &cube)
	This method allows the programmer to propagate labels from a specific secondary cube. More...

void	PropagateTables (const bool prop)
	This method allows the programmer to propagate input tables to the output cube (default is true) More...

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

void	PropagatePolygons (const bool prop)
	This method allows the programmer to propagate input blobs to the output cube (default is true) More...

void	PropagateHistory (const bool prop)
	This method allows the programmer to propagate history to the output cube (default is true) More...

void	PropagateOriginalLabel (const bool prop)
	This method allows the programmer to propagate original labels to the output cube (default is true) More...

Isis::Progress *	Progress ()
	This method returns a pointer to a Progress object. More...

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

void	WriteHistory (Cube &cube)
	Writes out the History blob to the cube. More...

void	CalculateStatistics ()
	Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method. More...

std::vector< Isis::Statistics * >	BandStatistics (const unsigned index)
	Get the vector of Statistics objects for each band separately of a specified input cube. More...

Isis::Statistics *	CubeStatistics (const unsigned index)
	Get the Statistics object for all bands of a specified input cube. More...

Static Public Member Functions
static void	translateUnits (QDomDocument &label, QString transMapFile="$ISISROOT/appdata/translations/pds4ExportUnits.pvl")
	This function will go through an XML document and attempt to convert all "units" attributes to the appropriate PDS4 units format. More...

Protected Member Functions
void	identificationArea ()
	This method writes the identification information to the PDS4 labels. More...

void	standardInstrument ()
	This method translates the information from the ISIS Instrument group to the PDS4 labels. More...

void	standardBandBin ()
	Export bandbin group to sp:Spectral Characteristics. More...

void	displaySettings ()
	This method writes the display direction information to the PDS4 labels. More...

void	fileAreaObservational ()
	Create and internalize an image output label from the input image. More...

QString	PDS4PixelType (PixelType pixelType, ByteOrder endianType)
	Helper function for converting ISIS pixel type and byte order to a PDS4 data_type value. More...

void	translateBandBinImage (Pvl &inputLabel)
	Export BandBin group for 2D or 3D Image format. More...

void	translateBandBinSpectrumUniform (Pvl &inputLabel)
	Export BandBin group for uniformly spaced 3D Spectral data format. More...

void	translateBandBinSpectrumBinSet (Pvl &inputLabel)
	Export BandBin group for non-uniformly spaced 3D Spectral data format. More...

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

std::vector< BufferManager * >	GetBuffersBIL ()
	A single line of input data from each input cube will be passed to the line processing function. More...

std::vector< BufferManager * >	GetBuffersBIP ()
	A single band of input data from each input cube will be passed to the band processing function. More...

Static Protected Member Functions
static QMap< QString, QString >	createUnitMap (Pvl configPvl)
	Helper function for creating the unit translation map from a PVL object. More...

static void	translateChildUnits (QDomElement parent, QMap< QString, QString > transMap)
	Recursive method that will translate the "unit" attribute of any child elements of a given element. More...

Protected Attributes
QDomDocument *	m_domDoc
	XML label. More...

QString	m_schemaLocation
	QString with all schema locations required. More...

QString	m_lid
	QString with specified logical identifier. More...

QString	m_versionId
	QString with specified version id. More...

QString	m_title
	QString with specified title. More...

ImageType	m_imageType
	Type of image data to be written. More...

QString	m_pixelDescription
	Description of pixel values. More...

ExportFormat	p_format
	Current storage order. More...

double	p_outputMinimum
	Desired minimum pixel value in the Buffer. More...

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

double	p_outputMaximum
	Desired maximum pixel value in the Buffer. More...

std::vector< double >	p_inputMinimum
	Minimum pixel value in the input cube to be mapped to the minimum value in the Buffer. More...

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

std::vector< double >	p_inputMaximum
	Maximum pixel value in the input cube to be mapped to the maximum value in the Buffer. More...

EndianSwapper *	p_endianSwap
	Object to swap the endianness of the raw output to either MSB or LSB. More...

ByteOrder	p_endianType
	The byte order of the output file. More...

PixelType	p_pixelType
	The bits per pixel of the output image. More...

std::vector< Stretch * >	p_str
	Stretch object to ensure a reasonable range of pixel values in the output data. More...

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

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

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

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

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

bool	p_Null_Set
	Indicates whether p_Null has been set (i.e. More...

bool	p_Lis_Set
	Indicates whether p_Lis has been set (i.e. More...

bool	p_Lrs_Set
	Indicates whether p_Lrs has been set (i.e. More...

bool	p_His_Set
	Indicates whether p_His has been set (i.e. More...

bool	p_Hrs_Set
	Indicates whether p_Hrs has been set (i.e. More...

QCryptographicHash *	m_cryptographicHash
	A cryptographic hash that will generate an MD5 checksum of the image data. More...

bool	m_canGenerateChecksum
	Flag to determine if a file checksum will be generated. More...

Isis::Progress *	p_progress
	Pointer to a Progress object. More...

bool	p_propagateLabels
	Flag indicating if labels are be propagated to output cubes. More...

bool	p_propagateTables
	Flag indicating if tables are be propagated to output cubes. More...

bool	p_propagatePolygons
	Flag indicating if blobs are be propagated to output cubes. More...

bool	p_propagateHistory
	Flag indicating if history is to be propagated to output cubes. More...

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

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

std::vector< Isis::Statistics * >	p_cubeStats
	Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called. More...

std::vector< Isis::Cube * >	InputCubes
	A vector of pointers to opened Cube objects. More...

std::vector< Isis::Cube * >	OutputCubes
	A vector of pointers to allocated Cube objects. More...

QSet< Isis::Cube * > *	m_ownedCubes
	A list of cubes owned by this instant. More...

Private Member Functions
void	isisOut8 (Buffer &in, std::ofstream &fout)
	Method for writing 8-bit unsigned pixel data to a file stream. More...

void	isisOut16s (Buffer &in, std::ofstream &fout)
	Method for writing 16-bit signed pixel data to a file stream. More...

void	isisOut16u (Buffer &in, std::ofstream &fout)
	Method for writing 16-bit unsigned pixel data to a file stream. More...

void	isisOut32 (Buffer &in, std::ofstream &fout)
	Method for writing 32-bit signed floating point pixels data to a file stream. More...

void	isisOut64 (Buffer &in, std::ofstream &fout)
	Method for writing 64-bit signed double precision floating point pixels data to a file stream. More...

void	InitProcess ()
	Convenience method that checks to make sure the user is only using valid input to the StartProcess method. More...

Detailed Description

Process class for exporting cubes to PDS4 standards.

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

Author: 2017-05-25 Marjorie Hahn and Makayla Shepherd

History:: 2017-05-31 Ian Humphrey - Added check in StandardPds4Label to thrown an exception if there is no input cube set.

History:: 2017-06-01 Ian Humphrey - Added XML declaration and updated attributes for Product_Observational tag.

History:: 2017-06-02 Marjorie Hahn - Added global hash seed to force a consistent output (XML attribute order).

History:: 2017-06-02 Adam Paquette - Updated call to translation file to use a translation file in the isis data area.

History:: 2017-06-02 Makayla Shepherd - Added CreateImageLabel, FixedImageRoot, and StandardImageImage to add hardcoded values to the xml label.

History:: 2017-06-04 Adam Paquette - Added GetLabel function and updated StandardPds4Label.

History:: 2017-06-08 Marjorie Hahn - Added WritePds4 method to write out the .img and .xml Pds4 data.

History:: 2017-09-26 Jesse Mapel - Improved test coverage and documentation. Fixes #5167.

History:: 2017-10-18 Jeannie Backer & Makayla Shepherd - Added convenience method getElement and StandardAllMapping method to translate mapping information. See #5202.

History:: 2017-10-31 Jeannie Backer - Added standardInstrument() and displaySettings() translations.

History:: 2017-11-06 Kristin Berry - Added standardBandBin()

History:: 2017-11-07 Jeannie Backer - Added code to search for target in the Mapping group if no instrument group is found. Added Identification Area tranlations. Added sanity checks to getElement().

History:: 2017-11-07 Jeannie Backer - Added code to write data file info into label file. Added code to translate time format and add nil tag if empty.

History:: 2017-11-15 Jesse Mapel - Added translateUnits method to convert units to PDS4 standard format.

History:: 2017-11-16 Kristin Berry - Updated WritePds4 to put the File information first in the output File_Area_Observational.

History:: 2017-11-17 Jesse Mapel - Removed empty FixedImageRoot method.

History:: 2017-11-20 Jeannie Backer - Updated StandardImageImage() to re-order the Array_3D_Image values properly.

History:: 2017-11-21 Kristin Berry - Updated the constructor to add the xml version and encoding to the beginning of the XML file.

History:: 2018-02-05 Kristin Berry - Updated WritePds4 to remove the .xml and add a .img if the user inputs something of the form filename.xml as the image output name.

History:: 2018-05-16 Christopher Combs - Fixed typo in xml namespaces and changed History attributes to elements. Matches pds validate tool specifations.

History:: 2018-06-12 Kristin Berry - Added schema associated with the img class when it is used.

History:: 2019-03-01 Kristin Berry - Added ability to set version_id and title, added Special_Constants to define ISIS special pixel values, fixed east/west bounding coordinates swap bug. Fixes git issue #2635.

History:: 2019-06-15 Kristin Berry - Added a new addSchema() function for cases in which a schematron file is not available and added setPixelDescription to set a pixel description for the output image.

Definition at line 74 of file ProcessExportPds4.h.

Member Enumeration Documentation

◆ ExportFormat

enum Isis::ProcessExport::ExportFormat

inherited

Storage order enumeration.

Enumerator
BSQ	Band sequential.
BIL	Band interleaved by line.
BIP	Band interleaved by pixel.
JP2	Compressed JPEG2000.

Definition at line 116 of file ProcessExport.h.

Constructor & Destructor Documentation

◆ ProcessExportPds4()

Isis::ProcessExportPds4::ProcessExportPds4 ( )

Default Constructor - Set to default the data members.

Definition at line 35 of file ProcessExportPds4.cpp.

◆ ~ProcessExportPds4()

Isis::ProcessExportPds4::~ProcessExportPds4 ( )

Destructor.

Definition at line 71 of file ProcessExportPds4.cpp.

Member Function Documentation

◆ addHistory()

void Isis::ProcessExportPds4::addHistory	(	QString	description,
		QString	date = `"tbd"`,
		QString	version = `"1.0"`
	)

Add a modification history instance by adding a Modification_Detail entry to the Modification_History element.

If there are no existing entries, this will create a Modification_History element also.

Parameters

description	The description of the modification.
date	The date of the modification. Expected format is "YYYY-MM-DD". Defaults to "tbd".
version	The product version. Expected format is "m.n". Defaults to "tbd".

Definition at line 1399 of file ProcessExportPds4.cpp.

◆ addSchema() [1/2]

void Isis::ProcessExportPds4::addSchema	(	QString	sch,
		QString	xsd,
		QString	xmlns,
		QString	xmlnsURI
	)

Adds necessary information to the xml header for a pds4 class.

Parameters

sch	Schematron filename without path
xsd	Schema filename without path
xmlns	The xml namespace used
xmlnsURI	Full URL to the xml namespace URI. Also used as the location of the sch and xsd

Definition at line 1044 of file ProcessExportPds4.cpp.

◆ addSchema() [2/2]

void Isis::ProcessExportPds4::addSchema	(	QString	xsd,
		QString	xmlns,
		QString	xmlnsURI
	)

Adds necessary information to the xml header for a pds4 class for schema which lack schematron files (.sch)

Parameters

xsd	Schema filename without path
xmlns	The xml namespace used
xmlnsURI	Full URL to the xml namespace URI. Also used as the location of the sch and xsd

Definition at line 1020 of file ProcessExportPds4.cpp.

◆ 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

index The index of the input cube in InputCubes

Returns: vector<Statistics*> A list of statistics ordered by band

Definition at line 279 of file Process.h.

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.

Definition at line 824 of file Process.cpp.

References Isis::Statistics::AddData(), Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), Isis::Cube::lineCount(), Isis::Cube::read(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), and Isis::toString().

◆ canGenerateChecksum()

bool Isis::ProcessExport::canGenerateChecksum ( )

inherited

@description Return if we can generate a checksum

Returns: Boolean to generate the checksum or not

Definition at line 684 of file ProcessExport.cpp.

References Isis::ProcessExport::m_canGenerateChecksum.

◆ CheckRequirements()

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

inherited

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

Parameters

cube Cube to check

requirements Use 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

Definition at line 503 of file Process.cpp.

References Isis::Cube::bandCount(), Isis::Cube::fileName(), Isis::Cube::lineCount(), and Isis::Cube::sampleCount().

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

Definition at line 694 of file ProcessExport.cpp.

References Isis::ProcessExport::m_canGenerateChecksum, Isis::ProcessExport::m_cryptographicHash, and Isis::IException::Programmer.

◆ ClearCubes()

void Isis::Process::ClearCubes ( )

inherited

Close owned cubes from the list and clear the list.

Definition at line 593 of file Process.cpp.

◆ ClearInputCubes()

void Isis::Process::ClearInputCubes ( )

inherited

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

Definition at line 603 of file Process.cpp.

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::FileTool::saveAsReducedCube(), and Isis::ProcessMapMosaic::SetOutputCube().

◆ ClearOutputCubes()

void Isis::Process::ClearOutputCubes ( )

inherited

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

Definition at line 617 of file Process.cpp.

◆ CreateImageLabel()

void Isis::ProcessExportPds4::CreateImageLabel ( )

Creates a PDS4 label.

The image label will be stored internally in the class.

This method has a similar function to ProcessExportPds::CreateImageLabel. However, it will create images of object type Array_3D_Image, Array_2D_Image, or Array_3D_Spectrum.

Definition at line 108 of file ProcessExportPds4.cpp.

◆ createUnitMap()

QMap< QString, QString > Isis::ProcessExportPds4::createUnitMap ( Pvl configPvl )

staticprotected

Helper function for creating the unit translation map from a PVL object.

Parameters

configPvl The config PVL that defines the map.

Returns: QMap<QString,QString> The map that converts lower case ISIS units to PDS4 units.

See also: ProcessExportPds4::translateUnits

Definition at line 1505 of file ProcessExportPds4.cpp.

References Isis::PvlObject::group(), Isis::PvlObject::groups(), Isis::PvlContainer::hasKeyword(), Isis::PvlContainer::name(), Isis::PvlObject::object(), Isis::PvlObject::objects(), and Isis::PvlKeyword::size().

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

Definition at line 1255 of file ProcessExport.cpp.

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

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

◆ CubeStatistics()

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

inlineinherited

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

Parameters

index The index of the input cube in InputCubes

Returns: Statistics* Collections of statistics gathered on all bands

Definition at line 293 of file Process.h.

References Isis::Process::p_cubeStats.

◆ displaySettings()

void Isis::ProcessExportPds4::displaySettings ( )

protected

This method writes the display direction information to the PDS4 labels.

Definition at line 521 of file ProcessExportPds4.cpp.

References Isis::PvlToXmlTranslationManager::Auto(), and Isis::FileName::expanded().

◆ EndProcess()

void Isis::Process::EndProcess ( )

virtualinherited

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

Deprecated:: Please use Finalize()

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

Definition at line 455 of file Process.cpp.

Referenced by Isis::ImageExporter::createWorldFile(), Isis::ProcessByBoxcar::EndProcess(), and Isis::FileTool::saveAsEnlargedCube().

◆ fileAreaObservational()

void Isis::ProcessExportPds4::fileAreaObservational ( )

protected

Create and internalize an image output label from the input image.

This method has a similar function to ProcessExportPds::StandardImageImage.

Definition at line 802 of file ProcessExportPds4.cpp.

References Isis::PvlToXmlTranslationManager::Auto(), Isis::FileName::expanded(), Isis::PvlObject::findObject(), and Isis::toString().

◆ Finalize()

void Isis::Process::Finalize ( )

virtualinherited

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

Clears the lists for all cubes.

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

Definition at line 463 of file Process.cpp.

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

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

Definition at line 944 of file ProcessExport.cpp.

References Isis::BufferManager::begin(), Isis::Process::InputCubes, and Isis::IException::Programmer.

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

Definition at line 982 of file ProcessExport.cpp.

References Isis::BufferManager::begin(), Isis::Process::InputCubes, and Isis::IException::Programmer.

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

Definition at line 905 of file ProcessExport.cpp.

References Isis::BufferManager::begin(), Isis::Process::InputCubes, and Isis::IException::Programmer.

◆ getElement()

QDomElement Isis::ProcessExportPds4::getElement	(	QStringList	xmlPath,
		QDomElement	parent = `QDomElement()`
	)

Convenience method to get an element given a path and its parent.

Parameters

xmlPath	The XML path to the element to retrieve, starting at the parent element. Note: The first element of this path must be the same as the parent element passed in, unless the parent element is NULL. If the parent element passed in is NULL, then we assume that the parent is the root and a full path has been given.
parent	The parent QDomElement of the given path. Defaults to the root element of the document.

Returns: QDomElement

Definition at line 1327 of file ProcessExportPds4.cpp.

◆ GetInputMaximum()

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

inherited

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

Definition at line 429 of file ProcessExport.cpp.

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

◆ GetInputMinimum()

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

inherited

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

Definition at line 418 of file ProcessExport.cpp.

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

◆ GetLabel()

QDomDocument & Isis::ProcessExportPds4::GetLabel ( )

Return the internalized PDS4 label.

If no label is internalized yet, an empty label will be returned.

Returns: QDomDocument The PDS4 Xml label

Definition at line 1089 of file ProcessExportPds4.cpp.

◆ GetOutputMaximum()

double Isis::ProcessExport::GetOutputMaximum ( )

inlineinherited

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

Definition at line 165 of file ProcessExport.h.

References Isis::ProcessExport::p_outputMaximum.

◆ GetOutputMinimum()

double Isis::ProcessExport::GetOutputMinimum ( )

inlineinherited

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

Definition at line 161 of file ProcessExport.h.

References Isis::ProcessExport::p_outputMinimum.

◆ identificationArea()

void Isis::ProcessExportPds4::identificationArea ( )

protected

This method writes the identification information to the PDS4 labels.

Definition at line 462 of file ProcessExportPds4.cpp.

References Isis::PvlToXmlTranslationManager::Auto(), Isis::FileName::baseName(), and Isis::FileName::expanded().

◆ InitProcess()

void Isis::ProcessExport::InitProcess ( )

privateinherited

Convenience method that checks to make sure the user is only using valid input to the StartProcess method.

Set cube up for processing.

Also sets the cube up to be processed by performing the necessary stretches.

This method is called from startProcess() to validate the input cube before processing and to ready the input cube for reading line by line in the cases of BSQ and BIL, or reading band by band in the case of BIP.

Exceptions

Isis::iException::Message - No input cube was specified

Definition at line 726 of file ProcessExport.cpp.

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

◆ isisOut16s()

void Isis::ProcessExport::isisOut16s	(	Buffer &	in,
		std::ofstream &	fout
	)

privateinherited

Method for writing 16-bit signed pixel data to a file stream.

Write a buffer of 16-bit signed pixel data to a stream.

This method takes a buffer of data and assumes that it is 16-bit signed pixel data. It will apply the necessary endian swap to the data and write it out to the output file buffer that the user specifies. The user can only expect to access this method indirectly by calling the StartProcess method.

Parameters

&in	Reference to a single buffer of pixel data. Note that this buffer will already have had the necessary stretching operations, though it will have the native endianness of the system.
&fout	Name of the file stream to which the buffer of pixel data will be written.

Definition at line 1136 of file ProcessExport.cpp.

References Isis::ProcessExport::p_endianSwap, Isis::EndianSwapper::ShortInt(), and Isis::Buffer::size().

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

◆ isisOut16u()

void Isis::ProcessExport::isisOut16u	(	Buffer &	in,
		std::ofstream &	fout
	)

privateinherited

Method for writing 16-bit unsigned pixel data to a file stream.

Write a bufferof 16-bit unsigned pixel data to a stream.

This method takes a buffer of data and assumes that it is 16-bit unsigned pixel data. It will apply the necessary endian swap to the data and write it out to the output file buffer that the user specifies. The user can only expect to access this method indirectly by calling the StartProcess method.

Parameters

&in	Reference to a single buffer of pixel data. Note that this buffer will already have had the necessary stretching operations, though it will have the native endianness of the system.
&fout	Name of the file stream to which the buffer of pixel data will be written.

Definition at line 1183 of file ProcessExport.cpp.

References Isis::ProcessExport::p_endianSwap, Isis::Buffer::size(), and Isis::EndianSwapper::UnsignedShortInt().

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

◆ isisOut32()

void Isis::ProcessExport::isisOut32	(	Buffer &	in,
		std::ofstream &	fout
	)

privateinherited

Method for writing 32-bit signed floating point pixels data to a file stream.

Write a buffer of 32-bit floating point pixel data to a stream.

This method takes a buffer of data and assumes that it is 32-bit floating point pixel data. It will apply the necessary endian swap to the data and write it out to the output file buffer that the user specifies. The user can only expect to access this method indirectly by calling the StartProcess method.

Parameters

&in	Reference to a single buffer of pixel data. Note that this buffer will already have had the necessary stretching operations, though it will have the native endianness of the system.
&fout	Name of the file stream to which the buffer of pixel data will be written.

Definition at line 1223 of file ProcessExport.cpp.

References Isis::EndianSwapper::ExportFloat(), Isis::ProcessExport::p_endianSwap, and Isis::Buffer::size().

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

◆ isisOut64()

void Isis::ProcessExport::isisOut64	(	Buffer &	in,
		std::ofstream &	fout
	)

privateinherited

Method for writing 64-bit signed double precision floating point pixels data to a file stream.

◆ isisOut8()

void Isis::ProcessExport::isisOut8	(	Buffer &	in,
		std::ofstream &	fout
	)

privateinherited

Method for writing 8-bit unsigned pixel data to a file stream.

Write a buffer of 8-bit pixel data to a stream.

This method takes a buffer of data and assumes that it is 8 bit pixel data. It will apply the necessary endian swap to the data and write it out to the output file buffer that the user specifies. The user can only expect to access this method indirectly by calling the StartProcess method

Parameters

&in	Reference to a single buffer of pixel data. Note that this buffer will already have had the necessary stretching operations, though it will have the native endianness of the system.
&fout	Name of the file stream to which the buffer of pixel data will be written.

Definition at line 1099 of file ProcessExport.cpp.

References Isis::Buffer::size().

Referenced by Isis::ProcessExport::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

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

Definition at line 768 of file Process.cpp.

References Isis::FileName::expanded(), Isis::FileName::fileExists(), Isis::PvlObject::findGroup(), and Isis::FileName::highestVersion().

◆ OutputHis()

double Isis::ProcessExport::OutputHis ( )

inherited

Return the output special pixel value for HIS.

Definition at line 569 of file ProcessExport.cpp.

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

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

◆ OutputHrs()

double Isis::ProcessExport::OutputHrs ( )

inherited

Return the output special pixel value for HRS.

Definition at line 577 of file ProcessExport.cpp.

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

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

◆ OutputLabel()

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

Write the XML label to the supplied stream.

Parameters

[out] os file stream to which the XML label will be written.

Definition at line 1066 of file ProcessExportPds4.cpp.

◆ OutputLis()

double Isis::ProcessExport::OutputLis ( )

inherited

Return the output special pixel value for LIS.

Definition at line 553 of file ProcessExport.cpp.

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

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

◆ OutputLrs()

double Isis::ProcessExport::OutputLrs ( )

inherited

Return the output special pixel value for LRS.

Definition at line 561 of file ProcessExport.cpp.

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

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

◆ OutputNull()

double Isis::ProcessExport::OutputNull ( )

inherited

Return the output special pixel value for NULL.

Definition at line 545 of file ProcessExport.cpp.

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

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

◆ PDS4PixelType()

QString Isis::ProcessExportPds4::PDS4PixelType	(	PixelType	pixelType,
		ByteOrder	endianType
	)

protected

Helper function for converting ISIS pixel type and byte order to a PDS4 data_type value.

Parameters

pixelType	The ISIS pixel type of the data
endianType	The byte order of the data

Returns: QString The PDS4 data_type value for the given pixel type and byte order.

Definition at line 1359 of file ProcessExportPds4.cpp.

◆ Progress()

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

inlineinherited

This method returns a pointer to a Progress object.

Returns: Progress*

Definition at line 259 of file Process.h.

References Isis::Process::p_progress.

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

◆ 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

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

Definition at line 737 of file Process.cpp.

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().

◆ 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

prop	Flag indicating if labels are be propagated to output cubes.

Definition at line 639 of file Process.cpp.

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().

◆ 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

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

Definition at line 650 of file Process.cpp.

References Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), and Isis::PvlObject::hasObject().

◆ 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

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

Definition at line 748 of file Process.cpp.

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().

◆ 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

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

Definition at line 727 of file Process.cpp.

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().

◆ 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

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

Definition at line 678 of file Process.cpp.

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().

◆ 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

fromName	QString of the name of the cube containing the tables to propagate.
tableNames	List of QStrings of the names of the tables to propagate; default is empty, which indicates that all tables will be propagated.

History:: 2016-11-30 Ian Humphrey - Added tableNames parameter so that only specified tables will be propagated when calling this method. Note that a default of an empty QList is used to propagate all tables. References #4433.

Definition at line 698 of file Process.cpp.

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

◆ reorder()

void Isis::ProcessExportPds4::reorder ( )

This method reorders the existing m_domDoc to follow PDS4 standards and fixes time formatting if needed.

Definition at line 284 of file ProcessExportPds4.cpp.

◆ 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

flag	boolean to generate the checksum or not

Definition at line 673 of file ProcessExport.cpp.

References Isis::ProcessExport::m_canGenerateChecksum.

◆ setFormat()

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

inlineinherited

Sets the storage order of the output file.

Definition at line 170 of file ProcessExport.h.

References Isis::ProcessExport::p_format.

Referenced by Isis::ImageExporter::initializeProcess(), and Isis::ProcessExport::ProcessExport().

◆ setImageType()

void Isis::ProcessExportPds4::setImageType ( ImageType imageType )

Create a standard PDS4 image label from the input cube.

Returns: QDomDocument The output PDS4 label.

Definition at line 94 of file ProcessExportPds4.cpp.

◆ 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

fname	Programmer specified work file. For example, "myfile.cub".
att	The cube attributes to use when opening the input cube.
requirements	Requirements to check that the input cube meets. See CheckRequirements().

Returns: Cube*

Exceptions

Isis::iException::Message

Reimplemented in Isis::ProcessByBrick.

Definition at line 66 of file Process.cpp.

References Isis::CubeAttributeInput::bands(), Isis::Cube::open(), 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

parameter	User parameter to obtain file to open. Typically, the value is "FROM". For example, the user can specify on the command line FROM=myfile.cub and this method will attempt to open the cube "myfile.cub" if the parameter was set to "FROM".
requirements	Requirements to check that the input cube meets. See CheckRequirements().

Exceptions

Isis::iException::Message

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

Definition at line 136 of file Process.cpp.

Referenced by Isis::ImageExporter::addChannel(), Isis::JigsawRunWidget::on_JigsawAcceptButton_clicked(), Isis::FileTool::saveAsEnlargedCube(), 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
requirements	Requirements to check that the input cube meets. See CheckRequirements().

Definition at line 107 of file Process.cpp.

References Isis::Cube::isOpen().

◆ SetInputRange() [1/5]

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>

Definition at line 359 of file ProcessExport.cpp.

References Isis::Application::GetUserInterface().

Referenced by Isis::ImageExporter::addChannel(), Isis::ProcessExport::SetInputRange(), and Isis::ImageExporter::write().

◆ SetInputRange() [2/5]

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

minimum	Minimum pixel value in the input cube to be mapped to the minimum value in the Buffer
maximum	Maximum pixel value in the input cube to be mapped to the maximum value in the Buffer

Exceptions

Isis::iException::Message

Definition at line 93 of file ProcessExport.cpp.

References Isis::ProcessExport::SetInputRange().

◆ SetInputRange() [3/5]

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

minimum	Minimum pixel value in the input cube to be mapped to the minimum value in the Buffer
maximum	Maximum pixel value in the input cube to be mapped to the maximum value in the Buffer
index	The index of the channel you are setting

Exceptions

Isis::iException::Message

Definition at line 122 of file ProcessExport.cpp.

References Isis::ProcessExport::SetInputRange().

◆ SetInputRange() [4/5]

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

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

Exceptions

Isis::IException::Message

Definition at line 153 of file ProcessExport.cpp.

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

◆ SetInputRange() [5/5]

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

minimum	Minimum pixel value in the input cube to be mapped to the minimum value in the Buffer
middle	Middle pixel value in the input cube to be mapped to the (minimum+maximum)/2.0 value in the Buffer
maximum	Maximum pixel value in the input cube to be mapped to the maximum value in the Buffer
index	The index of the channel you are setting

Exceptions

Isis::iException::Message

Definition at line 201 of file ProcessExport.cpp.

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

◆ setLogicalId()

void Isis::ProcessExportPds4::setLogicalId ( QString lid )

Allows mission specific programs to set logical_identifier required for PDS4 labels.

This value is added to the xml file by the identificationArea() method.

The input value will be converted to all-lowercase if not already in line with PDS4 requirements.

The input string should be colon separated string with 6 identifiers:

urn
space_agency (ususally nasa)
archiving_organization (usually pds)
bundle_id
collection_id
product_id

Example: urn:esa:psa:em16_tgo_frd:data_raw:frd_raw_sc_d_20150625T133700-20150625T135700

Author: 2018-05-21 Jeannie Backer

Parameters

lid	The logical identifier value required for PDS4 compliant labels.

Definition at line 407 of file ProcessExportPds4.cpp.

◆ 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

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

Returns: Cube*

Parameters

fname	Name of the output cube to allocate
att	The cube attributes to use when creating the output cube.
ns	Number of samples to allocate
nl	Number of lines to allocate
nb	Number of bands to allocate

Exceptions

Isis::iException::Message

Definition at line 309 of file Process.cpp.

References Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::AttachedLabel, Isis::CubeAttributeOutput::byteOrder(), Isis::Cube::create(), Isis::CubeAttributeOutput::fileFormat(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), Isis::PvlContainer::isNamed(), Isis::Cube::label(), Isis::Cube::labelSize(), Isis::CubeAttributeOutput::maximum(), Isis::CubeAttributeOutput::minimum(), Isis::PvlContainer::name(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::pixelType(), Isis::CubeAttributeOutput::pixelType(), Isis::CubeAttributeOutput::propagateMinimumMaximum(), Isis::CubeAttributeOutput::propagatePixelType(), Isis::Cube::setBaseMultiplier(), Isis::Cube::setByteOrder(), Isis::Cube::setDimensions(), Isis::Cube::setFormat(), Isis::Cube::setLabelsAttached(), Isis::Cube::setLabelSize(), Isis::Cube::setMinMax(), Isis::Cube::setPixelType(), and Isis::Cube::write().

◆ 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

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

Exceptions

Isis::iException::Message

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

Definition at line 160 of file Process.cpp.

Referenced by Isis::FileTool::saveAsEnlargedCube(), and Isis::ProcessImport::SetOutputCube().

◆ 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

parameter	User specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType.
ns	Number of samples to allocate
nl	Number of lines to allocate
nb	Number of bands to allocate

Exceptions

Isis::iException::Message

Definition at line 229 of file Process.cpp.

◆ 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

parameter	User specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType.
ns	Number of samples to allocate
nl	Number of lines to allocate
nb	Number of bands to allocate
ui	A user interface used to get the attributes needed. If null, the user interface will be obtained from the application.

Exceptions

Isis::iException::Message

Definition at line 270 of file Process.cpp.

References IsisAml::GetFileName(), and IsisAml::GetOutputAttribute().

◆ 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

parameter	User specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType.
ui	A user interface used to get the attributes needed for SetOutputCube.

Exceptions

Isis::iException::Message

Definition at line 193 of file Process.cpp.

◆ 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

byteOrderIn enumeration of the endianness (MSB or LSB)

Definition at line 649 of file ProcessExport.cpp.

References 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

value The output pixel value for all HIS pixels

Definition at line 521 of file ProcessExport.cpp.

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

value The output pixel value for all HRS pixels

Definition at line 536 of file ProcessExport.cpp.

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

value The output pixel value for all LIS pixels

Definition at line 491 of file ProcessExport.cpp.

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

value The output pixel value for all LRS pixels

Definition at line 506 of file ProcessExport.cpp.

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

value The output pixel value for all NULL pixels

Definition at line 476 of file ProcessExport.cpp.

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

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

◆ 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

minimum	Desired minimum pixel value in the Buffer
maximum	Desired maximum pixel value in the Buffer

Exceptions

Isis::iException::Message

Definition at line 454 of file ProcessExport.cpp.

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

Referenced by Isis::ImageExporter::initializeProcess(), and 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

pixelIn this 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

Definition at line 608 of file ProcessExport.cpp.

References Isis::ProcessExport::JP2, Isis::ProcessExport::p_format, Isis::ProcessExport::p_pixelType, Isis::IException::Programmer, and Isis::ProcessExport::SetOutputRange().

Referenced by Isis::ImageExporter::initializeProcess(), and Isis::ProcessExport::ProcessExport().

◆ setPixelDescription()

void Isis::ProcessExportPds4::setPixelDescription ( QString description )

Sets the description string which describes the pixel vales in File_Area_Observational.

Parameters

description Description of pixel values to use.

Definition at line 793 of file ProcessExportPds4.cpp.

◆ setSchemaLocation()

void Isis::ProcessExportPds4::setSchemaLocation ( QString schema )

Allows mission specific programs to use specified versions of dictionaries.

Author: 2018-05-21 Jeannie Backer

Parameters

schema The string of schema to be set.

Definition at line 453 of file ProcessExportPds4.cpp.

◆ setTitle()

void Isis::ProcessExportPds4::setTitle ( QString title )

Allows mission specific programs to set the title required for PDS4 labels.

This value is added to the xml file by the identificationArea() method.

Author: 2019-03-01 Kristin Berry

Parameters

title The title value required for PDS4 compliant labels.

Definition at line 440 of file ProcessExportPds4.cpp.

◆ setVersionId()

void Isis::ProcessExportPds4::setVersionId ( QString versionId )

Allows mission specific programs to set version_id required for PDS4 labels.

This value is added to the xml file by the identificationArea() method.

The input string should be colon separated string with 6 identifiers:

Author: 2019-03-01 Kristin Berry

Parameters

versiondId The version_id value required for PDS4 compliant labels.

Definition at line 425 of file ProcessExportPds4.cpp.

◆ StandardAllMapping()

void Isis::ProcessExportPds4::StandardAllMapping ( )

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

Exceptions

IException::User "Unable to export projection [" + projName + "] to PDS4 product. " + "This projection is not supported in ISIS."

Definition at line 1164 of file ProcessExportPds4.cpp.

References Isis::PvlToXmlTranslationManager::Auto(), Isis::PvlObject::findGroup(), Isis::PvlContainer::findKeyword(), Isis::PvlObject::findObject(), Isis::PvlObject::hasObject(), Isis::Projection::Name(), Isis::toDouble(), and Isis::toString().

◆ standardBandBin()

void Isis::ProcessExportPds4::standardBandBin ( )

protected

Export bandbin group to sp:Spectral Characteristics.

Definition at line 540 of file ProcessExportPds4.cpp.

References Isis::PvlObject::findObject().

◆ standardInstrument()

void Isis::ProcessExportPds4::standardInstrument ( )

protected

This method translates the information from the ISIS Instrument group to the PDS4 labels.

Definition at line 191 of file ProcessExportPds4.cpp.

References Isis::PvlToXmlTranslationManager::Auto(), Isis::FileName::expanded(), and Isis::PvlObject::findObject().

◆ StandardPds4Label()

QDomDocument & Isis::ProcessExportPds4::StandardPds4Label ( )

Create a standard PDS4 image label from the input cube.

Returns: QDomDocument The output PDS4 label.

Definition at line 82 of file ProcessExportPds4.cpp.

◆ StartProcess() [1/5]

void Isis::ProcessExport::StartProcess

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

&fout An 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.

Definition at line 128 of file ProcessExport.cpp.

◆ StartProcess() [2/5]

void Isis::ProcessExportPds4::StartProcess ( std::ofstream & fout )

virtual

This method fills the image data of the PDS4 file using the parent class ProcessExport::StartProcess.

Parameters

[out] fout Output file stream to be filled with the PDS4 data.

Reimplemented from Isis::ProcessExport.

Definition at line 1078 of file ProcessExportPds4.cpp.

◆ 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

Definition at line 213 of file Process.h.

◆ StartProcess() [4/5]

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

virtualinherited

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

Definition at line 790 of file ProcessExport.cpp.

References Isis::BufferManager::begin(), Isis::ProcessExport::BIL, Isis::ProcessExport::BIP, Isis::ProcessExport::BSQ, Isis::Progress::CheckStatus(), Isis::BufferManager::end(), Isis::ProcessExport::InitProcess(), Isis::Process::InputCubes, Isis::ProcessExport::JP2, Isis::BufferManager::next(), Isis::ProcessExport::p_format, Isis::Process::p_progress, Isis::ProcessExport::p_str, Isis::IException::Programmer, and Isis::Buffer::size().

◆ StartProcess() [5/5]

void Isis::ProcessExport::StartProcess

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

Definition at line 126 of file ProcessExport.cpp.

◆ translateBandBinImage()

void Isis::ProcessExportPds4::translateBandBinImage ( Pvl & inputLabel )

protected

Export BandBin group for 2D or 3D Image format.

Definition at line 572 of file ProcessExportPds4.cpp.

References Isis::PvlToXmlTranslationManager::Auto(), and Isis::FileName::expanded().

◆ translateBandBinSpectrumBinSet()

void Isis::ProcessExportPds4::translateBandBinSpectrumBinSet ( Pvl & inputLabel )

protected

Export BandBin group for non-uniformly spaced 3D Spectral data format.

Definition at line 726 of file ProcessExportPds4.cpp.

References Isis::PvlToXmlTranslationManager::Auto(), Isis::FileName::expanded(), Isis::PvlObject::findObject(), Isis::PvlContainer::hasKeyword(), and Isis::PvlKeyword::size().

◆ translateBandBinSpectrumUniform()

void Isis::ProcessExportPds4::translateBandBinSpectrumUniform ( Pvl & inputLabel )

protected

Export BandBin group for uniformly spaced 3D Spectral data format.

Definition at line 584 of file ProcessExportPds4.cpp.

References Isis::PvlToXmlTranslationManager::Auto(), Isis::FileName::expanded(), Isis::PvlObject::findObject(), Isis::PvlContainer::hasKeyword(), Isis::PvlKeyword::size(), Isis::toString(), and Isis::PvlKeyword::unit().

◆ translateChildUnits()

void Isis::ProcessExportPds4::translateChildUnits	(	QDomElement	parent,
		QMap< QString, QString >	transMap
	)

staticprotected

Recursive method that will translate the "unit" attribute of any child elements of a given element.

Returns void if the given element has no children.

Parameters

parent	The element whose children's units will be translated. This method will be recursively called on all child elements.
transMap	The translation map with lowercase ISIS units as keys and PDS4 units as values.

See also: ProcessExportPds4::translateUnits

Definition at line 1545 of file ProcessExportPds4.cpp.

◆ translateUnits()

void Isis::ProcessExportPds4::translateUnits	(	QDomDocument &	label,
		QString	transMapFile = `"$ISISROOT/appdata/translations/pds4ExportUnits.pvl"`
	)

static

This function will go through an XML document and attempt to convert all "units" attributes to the appropriate PDS4 units format.

This method uses a pvl config file to determine what the proper PDS4 format is and what potential input formats are. The file is converted to a map which is then used to convert all of the input units. See $ISISROOT/appdata/translations/pds4ExportUnits.pvl for more information on this file.

This method is automatically called in StandardPds4Label(), but may need to be called again if the label is changed afterwards.

Parameters

[in,out]	label	A reference to the label that the units will be translated in.
	transMapFile	The path to the config file that will be used to determine unit translations.

Definition at line 1464 of file ProcessExportPds4.cpp.

References Isis::Pvl::read().

◆ WriteHistory()

void Isis::Process::WriteHistory ( Cube & cube )

inherited

Writes out the History blob to the cube.

Definition at line 789 of file Process.cpp.

References Isis::History::AddEntry(), Isis::PvlContainer::isNamed(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::readHistory(), and Isis::Cube::write().

Referenced by Isis::ImageImporter::import().

◆ WritePds4()

void Isis::ProcessExportPds4::WritePds4 ( QString outFile )

This method write out the labels and image data to the specified output file.

Creates an IMG and XML file.

Parameters

outFile QString of the name of the output image file. Will create an XML and an IMG file with the output file name.

Definition at line 1110 of file ProcessExportPds4.cpp.

References Isis::FileName::baseName(), Isis::FileName::expanded(), Isis::FileName::extension(), Isis::FileName::name(), and Isis::FileName::originalPath().

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.

Definition at line 185 of file Process.h.

Referenced by Isis::ProcessExport::CreateWorldFile(), Isis::ProcessExport::GetBuffersBIL(), Isis::ProcessExport::GetBuffersBIP(), Isis::ProcessExport::GetBuffersBSQ(), Isis::ProcessExport::InitProcess(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessExport::SetInputRange(), Isis::ProcessExport::StartProcess(), and Isis::ProcessByQuickFilter::StartProcess().

◆ m_canGenerateChecksum

bool Isis::ProcessExport::m_canGenerateChecksum

protectedinherited

Flag to determine if a file checksum will be generated.

Definition at line 270 of file ProcessExport.h.

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

◆ m_cryptographicHash

QCryptographicHash* Isis::ProcessExport::m_cryptographicHash

protectedinherited

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

Definition at line 268 of file ProcessExport.h.

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

◆ m_domDoc

QDomDocument* Isis::ProcessExportPds4::m_domDoc

protected

XML label.

Definition at line 129 of file ProcessExportPds4.h.

◆ m_imageType

ImageType Isis::ProcessExportPds4::m_imageType

protected

Type of image data to be written.

Definition at line 134 of file ProcessExportPds4.h.

◆ m_lid

QString Isis::ProcessExportPds4::m_lid

protected

QString with specified logical identifier.

Definition at line 131 of file ProcessExportPds4.h.

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

Definition at line 199 of file Process.h.

◆ m_pixelDescription

QString Isis::ProcessExportPds4::m_pixelDescription

protected

Description of pixel values.

Definition at line 135 of file ProcessExportPds4.h.

◆ m_schemaLocation

QString Isis::ProcessExportPds4::m_schemaLocation

protected

QString with all schema locations required.

Definition at line 130 of file ProcessExportPds4.h.

◆ m_title

QString Isis::ProcessExportPds4::m_title

protected

QString with specified title.

Definition at line 133 of file ProcessExportPds4.h.

◆ m_versionId

QString Isis::ProcessExportPds4::m_versionId

protected

QString with specified version id.

Definition at line 132 of file ProcessExportPds4.h.

◆ OutputCubes

std::vector<Isis::Cube *> Isis::Process::OutputCubes

protectedinherited

A vector of pointers to allocated Cube objects.

The pointers are established in the SetOutputCube method.

Definition at line 191 of file Process.h.

Referenced by Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessImport::ProcessJp2(), and Isis::ProcessByQuickFilter::StartProcess().

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

Definition at line 172 of file Process.h.

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

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

Definition at line 179 of file Process.h.

Referenced by 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.

Definition at line 237 of file ProcessExport.h.

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

◆ p_endianType

ByteOrder Isis::ProcessExport::p_endianType

protectedinherited

The byte order of the output file.

Definition at line 239 of file ProcessExport.h.

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

◆ p_format

ExportFormat Isis::ProcessExport::p_format

protectedinherited

Current storage order.

Definition at line 215 of file ProcessExport.h.

Referenced by Isis::ProcessExport::InitProcess(), Isis::ProcessExport::setFormat(), Isis::ProcessExport::SetOutputType(), and Isis::ProcessExport::StartProcess().

◆ p_His

double Isis::ProcessExport::p_His

protectedinherited

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

Definition at line 252 of file ProcessExport.h.

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

Definition at line 263 of file ProcessExport.h.

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.

Definition at line 254 of file ProcessExport.h.

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

Definition at line 265 of file ProcessExport.h.

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

◆ p_inputMaximum

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

protectedinherited

Maximum pixel value in the input cube to be mapped to the maximum value in the Buffer.

Definition at line 234 of file ProcessExport.h.

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

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

Definition at line 230 of file ProcessExport.h.

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

◆ p_inputMinimum

std::vector<double> Isis::ProcessExport::p_inputMinimum

protectedinherited

Minimum pixel value in the input cube to be mapped to the minimum value in the Buffer.

Definition at line 227 of file ProcessExport.h.

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

◆ p_Lis

double Isis::ProcessExport::p_Lis

protectedinherited

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

Definition at line 248 of file ProcessExport.h.

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

Definition at line 259 of file ProcessExport.h.

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.

Definition at line 250 of file ProcessExport.h.

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

Definition at line 261 of file ProcessExport.h.

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.

Definition at line 247 of file ProcessExport.h.

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

Definition at line 257 of file ProcessExport.h.

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

◆ p_outputMaximum

double Isis::ProcessExport::p_outputMaximum

protectedinherited

Desired maximum pixel value in the Buffer.

Definition at line 225 of file ProcessExport.h.

Referenced by Isis::ProcessExport::GetOutputMaximum(), Isis::ProcessExport::InitProcess(), Isis::ProcessExport::OutputHis(), Isis::ProcessExport::OutputHrs(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputRange().

◆ p_outputMiddle

double Isis::ProcessExport::p_outputMiddle

protectedinherited

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

Definition at line 223 of file ProcessExport.h.

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

◆ p_outputMinimum

double Isis::ProcessExport::p_outputMinimum

protectedinherited

Desired minimum pixel value in the Buffer.

Definition at line 222 of file ProcessExport.h.

Referenced by Isis::ProcessExport::GetOutputMinimum(), Isis::ProcessExport::InitProcess(), Isis::ProcessExport::OutputLis(), Isis::ProcessExport::OutputLrs(), Isis::ProcessExport::OutputNull(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputRange().

◆ p_pixelType

PixelType Isis::ProcessExport::p_pixelType

protectedinherited

The bits per pixel of the output image.

Definition at line 241 of file ProcessExport.h.

Referenced by Isis::ProcessExport::SetOutputType(), and Isis::ProcessExport::StartProcess().

◆ p_progress

Isis::Progress* Isis::Process::p_progress

protectedinherited

Pointer to a Progress object.

Definition at line 145 of file Process.h.

Referenced by Isis::ProcessExport::InitProcess(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessExport::ProcessExport(), Isis::ProcessImport::ProcessImport(), Isis::ProcessImport::ProcessJp2(), Isis::Process::Progress(), Isis::ProcessByBrick::RunProcess(), Isis::ProcessExport::StartProcess(), and Isis::ProcessByQuickFilter::StartProcess().

◆ p_propagateHistory

bool Isis::Process::p_propagateHistory

protectedinherited

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

Definition at line 161 of file Process.h.

◆ p_propagateLabels

bool Isis::Process::p_propagateLabels

protectedinherited

Flag indicating if labels are be propagated to output cubes.

Definition at line 149 of file Process.h.

◆ p_propagateOriginalLabel

bool Isis::Process::p_propagateOriginalLabel

protectedinherited

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

Definition at line 165 of file Process.h.

◆ p_propagatePolygons

bool Isis::Process::p_propagatePolygons

protectedinherited

Flag indicating if blobs are be propagated to output cubes.

Definition at line 157 of file Process.h.

◆ p_propagateTables

bool Isis::Process::p_propagateTables

protectedinherited

Flag indicating if tables are be propagated to output cubes.

Definition at line 153 of file Process.h.

◆ p_str

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

protectedinherited

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

Definition at line 243 of file ProcessExport.h.

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

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

src/base/objs/ProcessExportPds4/ProcessExportPds4.h
src/base/objs/ProcessExportPds4/ProcessExportPds4.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ ExportFormat

Constructor & Destructor Documentation

◆ ProcessExportPds4()

◆ ~ProcessExportPds4()

Member Function Documentation

◆ addHistory()

◆ addSchema() [1/2]

◆ addSchema() [2/2]

◆ BandStatistics()

◆ CalculateStatistics()

◆ canGenerateChecksum()

◆ CheckRequirements()

◆ checksum()

◆ ClearCubes()

◆ ClearInputCubes()

◆ ClearOutputCubes()

◆ CreateImageLabel()

◆ createUnitMap()

◆ CreateWorldFile()

◆ CubeStatistics()

◆ displaySettings()

◆ EndProcess()

◆ fileAreaObservational()

◆ Finalize()

◆ GetBuffersBIL()

◆ GetBuffersBIP()

◆ GetBuffersBSQ()

◆ getElement()

◆ GetInputMaximum()

◆ GetInputMinimum()

◆ GetLabel()

◆ GetOutputMaximum()

◆ GetOutputMinimum()

◆ identificationArea()

◆ InitProcess()

◆ isisOut16s()

◆ isisOut16u()

◆ isisOut32()

◆ isisOut64()

◆ isisOut8()

◆ MissionData()

◆ OutputHis()

◆ OutputHrs()

◆ OutputLabel()

◆ OutputLis()

◆ OutputLrs()

◆ OutputNull()

◆ PDS4PixelType()

◆ Progress()

◆ PropagateHistory()

◆ PropagateLabels() [1/2]

◆ PropagateLabels() [2/2]

◆ PropagateOriginalLabel()

◆ PropagatePolygons()

◆ PropagateTables() [1/2]

◆ PropagateTables() [2/2]

◆ reorder()

◆ setCanGenerateChecksum()

◆ setFormat()

◆ setImageType()

◆ SetInputCube() [1/3]

◆ SetInputCube() [2/3]

◆ SetInputCube() [3/3]

◆ SetInputRange() [1/5]

◆ SetInputRange() [2/5]

◆ SetInputRange() [3/5]

◆ SetInputRange() [4/5]

◆ SetInputRange() [5/5]

◆ setLogicalId()

◆ SetOutputCube() [1/3]

◆ SetOutputCube() [2/3]