IO Handler for Isis Cubes. More...

#include <Cube.h>

Collaboration diagram for Isis::Cube:

Public Types
enum	Format { Bsq, Tile }
	These are the possible storage formats of Isis3 cubes. More...

Public Member Functions
	Cube ()
	Constructs a Cube object.

	Cube (const FileName &fileName, QString access="r")
	Construct a cube and open it for reading or reading/writing.

virtual	~Cube ()
	Destroys the Cube object.

bool	isOpen () const
	Test if a cube file has been opened/created.

bool	isProjected () const
	Returns true if the labels of the cube appear to have a valid mapping group.

bool	isReadOnly () const
	Test if the opened cube is read-only, that is write operations will fail if this is true.

bool	isReadWrite () const
	Test if the opened cube is read-write, that is read and write operations should succeed if this is true.

bool	labelsAttached () const
	Test if labels are attached.

void	close (bool remove=false)
	Closes the cube and updates the labels.

Cube *	copy (FileName newFile, const CubeAttributeOutput &newFileAttributes)

void	create (const QString &cfile)
	This method will create an isis cube for writing.

void	create (const QString &cfile, const CubeAttributeOutput &att)

void	open (const QString &cfile, QString access="r")
	This method will open an isis sube for reading or reading/writing.

void	reopen (QString access="r")
	This method will reopen an isis sube for reading or reading/writing.

void	read (Blob &blob) const
	This method will read data from the specified Blob object.

void	read (Buffer &rbuf) const
	This method will read a buffer of data from the cube as specified by the contents of the Buffer object.

void	write (Blob &blob)
	This method will write a blob of data (e.g.

void	write (Buffer &wbuf)
	This method will write a buffer of data from the cube as specified by the contents of the Buffer object.

void	setBaseMultiplier (double base, double mult)
	Used prior to the Create method, this will specify the base and multiplier for converting 8-bit/16-bit back and forth between 32-bit: $32-bit pixel = 8-bit/16-bit pixel * multiplier + base$ .

void	setMinMax (double min, double max)
	Used prior to the Create method, this will compute a good base and multiplier value given the minimum/maximum range of the 32bit data.

void	setByteOrder (ByteOrder byteOrder)
	Used prior to the Create method, this will specify the byte order of pixels, either least or most significant byte.

void	setDimensions (int ns, int nl, int nb)
	Used prior to the Create method to specify the size of the cube.

void	setExternalDnData (FileName cubeFileWithDnData)

void	setFormat (Format format)
	Used prior to the Create method, this will specify the format of the cube, either band, sequential or tiled.

void	setLabelsAttached (bool attached)
	Use prior to calling create, this sets whether or not to use separate label and data files.

void	setLabelSize (int labelBytes)
	Used prior to the Create method, this will allocate a specific number of bytes in the label area for attached files.

void	setPixelType (PixelType pixelType)
	Used prior to the Create method, this will specify the output pixel type.

void	setVirtualBands (const QList< QString > &vbands)
	This allows the programmer to specify a subset of bands to work with.

void	setVirtualBands (const std::vector< QString > &vbands)
	This is a deprecated version of setVirtualBands(const QList<QString> &).

void	relocateDnData (FileName dnDataFile)

int	bandCount () const
	Returns the number of virtual bands for the cube.

double	base () const
	Returns the base value for converting 8-bit/16-bit pixels to 32-bit.

ByteOrder	byteOrder () const
	Returns the byte order/endian-ness of the cube file.

Camera *	camera ()
	Return a camera associated with the cube.

FileName	externalCubeFileName () const
	If this is an external cube label file, this will give you the cube dn file that this label references.

QString	fileName () const
	Returns the opened cube's filename.

Format	format () const

Histogram *	histogram (const int &band=1, QString msg="Gathering histogram")
	This method returns a pointer to a Histogram object which allows the program to obtain and use various statistics and histogram information from the cube.

Histogram *	histogram (const int &band, const double &validMin, const double &validMax, QString msg="Gathering histogram")
	This method returns a pointer to a Histogram object which allows the program to obtain and use various statistics and histogram information from the cube.

Pvl *	label () const
	Returns a pointer to the IsisLabel object associated with the cube.

int	labelSize (bool actual=false) const
	Returns the number of bytes used by the label.

int	lineCount () const

double	multiplier () const
	Returns the multiplier value for converting 8-bit/16-bit pixels to 32-bit.

PixelType	pixelType () const

int	physicalBand (const int &virtualBand) const
	This method will return the physical band number given a virtual band number.

Projection *	projection ()

int	sampleCount () const

Statistics *	statistics (const int &band=1, QString msg="Gathering statistics")
	This method returns a pointer to a Statistics object which allows the program to obtain and use various statistics from the cube.

Statistics *	statistics (const int &band, const double &validMin, const double &validMax, QString msg="Gathering statistics")
	This method returns a pointer to a Statistics object which allows the program to obtain and use various statistics from the cube.

bool	storesDnData () const

void	addCachingAlgorithm (CubeCachingAlgorithm *)
	This will add the given caching algorithm to the list of attempted caching algorithms.

void	clearIoCache ()
	This will clear excess RAM used for quicker IO in the cube.

bool	deleteBlob (QString BlobType, QString BlobName)
	This method will delete a blob label object from the cube as specified by the Blob type and name.

void	deleteGroup (const QString &group)
	Deletes a group from the cube labels.

PvlGroup &	group (const QString &group) const
	Read a group from the cube into a Label.

bool	hasGroup (const QString &group) const
	Return if the cube has a specified group in the labels.

bool	hasTable (const QString &name)
	Check to see if the cube contains a pvl table by the provided name.

void	putGroup (const PvlGroup &group)
	Adds a group in a Label to the cube.

Private Member Functions
void	applyVirtualBandsToLabel ()

void	cleanUp (bool remove)
	This clears all of the allocated memory associated with an open cube.

void	construct ()
	Initialize members from their initial undefined states.

QFile *	dataFile () const
	This returns the QFile with cube DN data in it.

FileName	realDataFileName () const
	This gets the file name of the file which actually contains the DN data.

void	initialize ()
	This sets Cube to its default state: Native byte order Format = Tile PixelType = Real (4 bytes per pixel) Attached labels Label size = 65536 bytes samples, lines, bands unset Base = 0 Multiplier = 1.0.

void	initCoreFromLabel (const Pvl &label)

void	initLabelFromFile (FileName labelFileName, bool readWrite)

void	openCheck ()
	Throw an exception if the cube is not open.

Pvl	realDataFileLabel () const

void	reformatOldIsisLabel (const QString &oldCube)
	This is a helper, used by open(...), that handles opening Isis 2 cubes as if they were Isis 3 cubes.

void	writeLabels ()
	Write the Pvl labels to the cube's label file.

Private Attributes
QFile *	m_labelFile
	This is the file that contains the labels always; if labels are attached then this contains the file data also.

QFile *	m_dataFile
	This is only sometimes allocated.

CubeIoHandler *	m_ioHandler
	This does the heavy lifting for cube DN IO and is always allocated when isOpen() is true.

ByteOrder	m_byteOrder
	The byte order of the opened cube; if there is no open cube then this is the byte order that will be used when a new cube is created.

Format	m_format
	If isOpen() then this is the IO format that the cube uses.

PixelType	m_pixelType
	This is the pixel type on disk.

QMutex *	m_mutex
	Basic thread-safety mutex; this class is not optimized for threads.

Camera *	m_camera
	Camera allocated from the camera() method.

Projection *	m_projection
	Projection allocated from the projection() method.

FileName *	m_labelFileName
	The full filename of the label file (.lbl or .cub)

FileName *	m_dataFileName
	The full filename of the data file (.cub)

FileName *	m_tempCube
	If open was called with an Isis 2 cube, then this will be the name of the imported Isis3 cube.

FileName *	m_formatTemplateFile
	Label pvl format template file (describes how to format labels)

bool	m_attached
	True if labels are attached.

bool	m_storesDnData
	True (most common case) when the cube DN data is inside the file we're writing to.

Pvl *	m_label
	The label if IsOpen(), otherwise NULL.

int	m_labelBytes
	The maximum allowed size of the label; the allocated space.

int	m_samples
	The sample count of the open cube or the cube that will be created.

int	m_lines
	The line count of the open cube or the cube that will be created.

int	m_bands
	The band count of the open cube or the cube that will be created.

double	m_base
	The base of the open cube or the cube that will be created; does not apply if m_pixelType is Real.

double	m_multiplier
	The multiplier of the open cube or the cube that will be created; does not apply if m_pixelType is Real.

QList< int > *	m_virtualBandList
	If allocated, converts from physical on-disk band # to virtual band #.

Detailed Description

IO Handler for Isis Cubes.

This class is used to open, create, read, and write data from Isis cube files.

Author: 2003-02-14 Jeff Anderson

Todo:: There are undocumented methods and private variables in the Cube class. Also, it needs an example.

History:

2003-03-31 Jeff Anderson - updated unitTest truth file.

2003-05-16 Stuart Sides - modified schema from astrogeology...isis.astrogeology

2003-05-21 Jeff Anderson - added read/write methods to improve speed for IsisLine buffer managers. Also added error checks on reads, writes, and seeks.

2003-05-30 Jeff Anderson - added PhysicalBand method and updated unitTest.

2003-10-06 Jeff Anderson - added PVL to create method to allow for propagation of Pixel specifications.

2003-10-15 Jeff Anderson - fixed bad error check in PhysicalBand method.

2004-01-30 Jeff Anderson - added many Set methods. Major refractor of the class.

2004-02-12 Jeff Anderson - added pruning of the band bin group given the virtual band list.

2004-02-17 Jeff Anderson - modified the number of bands in the label if a virtual band list was given.

2004-03-01 Jeff Anderson - added ability to read Isis 2.1 cube format.

2004-04-01 Jeff Anderson - fixed bug swapping NULL cache tile for non-native cubes in move method.

2005-03-24 Jeff Anderson - Added methods to return a camera or projection associated with the cube.

2005-07-18 Elizabeth Ribelin - Fixed bug in method that returns a projection associated with the cube

2005-10-03 Elizabeth Miller - Added error check to Write(blob)

2006-02-24 Kris Becker - Made the destructor virtual to properly allow the class to be inherited.

2006-04-21 Jacob Danton - Modified the WriteLabel method to use the Pvl's format template abilities.

2006-05-17 Elizabeth Miller - Depricated CameraManger to CameraFactory

2006-07-10 Elizabeth Miller - Added max size preference

2006-11-28 Jeff Anderson - Fixed detached blob bug

2007-01-05 Jeff Anderson - Fixed bug when reading/writing outside cube

2007-02-07 Tracie Sucharski - Added ReOpen method

2008-05-09 Steven Lambright - Added Statistics, Histogram, PutGroup, GetGroup, DeleteGroup, HasGroup conveinience methods. Removed excess references to CubeInfo.

2008-05-27 Jeff Anderson - Fixed bug in open method where virtual bands were not handled correctly if a BandBin group did not exist

2008-06-09 Christopher Austin - Improved maximum cube size error message.

2008-06-11 Steven Lambright - Changed prototype for SetVirtualBands

2008-06-18 Christopher Austin - Fixed documentation errors

2008-08-11 Steven Lambright - Added another Statistics method which accepts a valid range – also added another Histogram method which accepts a bin/valid range (applies both).

2008-08-11 Steven Lambright - Fixed definition of IsisCubeDef, problem pointed out by "novas0x2a" (Support Board Member)

2008-12-15 Steven Koechle - Added a method to delete blobs from a cube

2008-12-17 Steven Koechle - BlobDelete method was broken, fixed

2009-06-30 Steven Lambright - Added "HasProjection" for uniform projection existance test

2010-03-22 Steven Lambright - Added a mutex for reading and writing, which makes these methods thread safe.

2011-03-23 Steven Lambright - Added ClearCache method.

2011-06-01 Jai Rideout and Steven Lambright - Updated API to conform to new Isis standards, re-implemented IO handler and implemented new caching algorithms that can automatically apply themselves when the behavior of the caller changes.

2011-06-27 Steven Lambright - Added addCachingAlgorithm

2011-07-08 Steven Lambright - projection() and camera() will now return NULL if the cube is not open, instead of crashing, references #161

2012-02-17 Steven Lambright - Made the read() method const. Added mutex lock calls around data file accesses.

2012-04-05 Stuart Sides and Steven Lambright - Added new constructor which immediately open the cube.

2012-07-02 Steven Lambright and Stuart Sides - Added copy() and added support for external cube label files (.ecub). This was done so that cubes can be imported into projects without copying the DN data. Also, multiple versions of SPICE will be save-able for one cube (multiple ecubs... again, not copying DN data). Fixes #961.

2012-09-06 Steven Lambright - Improved parsing of ^DnFile in the ecub format and simplified/optimized writeLabels().

2012-09-17 Steven Lambright - Fixed ASSERT in getRealDataFileName() to be in the correct place.

2012-10-26 Steven Lambright and Stuard Sides - Externel cube label files no longer allocate disk space for DN data when writing out blobs.

2012-11-06 Steven Lambright and Mathew Eis - Fixed (the lack of) deletion of temporary files in the unit test. Fixes #1009.

2012-12-31 Steven Lambright - Removed 'get' prefix from accessors. Fixes #1356.

2014-06-20 Ian Humphrey - Added checks to statistics() and histogram() to throw an error if the cube is unopened. Fixes #2085.

2014-10-06 Ian Humphrey - Added case to unittest when chunk dimensions are the same as the buffer shape to ensure virtual bands accessed correctly. Added cases to test creating bsq and large bsq cubes. References #1689.

2015-01-30 Ian Humphrey - Deallocated copied cubes in unittest. References #2082.

Definition at line 151 of file Cube.h.

Member Enumeration Documentation

enum Isis::Cube::Format

These are the possible storage formats of Isis3 cubes.

There is an internal IO handler for each one of these.

Enumerator

Bsq

Cubes are stored in band-sequential format, that is the order of the pixels in the file (on disk) is:

    S1,L1,B1
    S2,L1,B1
    and so on until ...
    SN,L1,B1
    S1,L2,B1
    and so on until ...
    S1,LN,B1
    S1,L1,B2
    S2,L1,B2
    and so on until ...
    S1,L1,BN

The idea is the cubes are stored left-to-right, top-to-bottom, then front-to-back.

Tile

Cubes are stored in tile format, that is the order of the pixels in the file (on disk) is BSQ within a given sub-area defined by the Tile IO handler.

Typically these tiles are around 1MB for efficiency.

The idea is the cubes are stored left-to-right, top-to-bottom inside the tiles (which have 1 band). The tiles are themselves in BSQ order also. Please note that this can cause cubes to be larger on disk due to the tile size not being evenly divisible into the cube size.

Cube:

------------------------------
|Tile *Tile *Tile *Tile *Tile|*
|  0  *  1  *  2  *  3  *  4 |*
|     *     *     *     *    |*
|****************************|*
|Tile *Tile *Tile *Tile *Tile|*
|  5  *  6  *  7  *  8  *  9 |*
|     *     *     *     *    |*
|****************************|*
|Tile *Tile *Tile *Tile *Tile|*
------------------------------*
* 10  * 11  * 12  * 13  * 14  *
*******************************

The symbol '*' denotes tile boundaries. The symbols '-' and '|' denote cube boundaries.

Definition at line 161 of file Cube.h.

Constructor & Destructor Documentation

Isis::Cube::Cube ( )

Constructs a Cube object.

Definition at line 56 of file Cube.cpp.

Isis::Cube::Cube	(	const FileName &	fileName,
		QString	access = `"r"`
	)

Construct a cube and open it for reading or reading/writing.

Parameters

fileName	Name of the cube file to open. Environment variables in the filename will be automatically expanded.
access	Defines how the cube will be opened. Either read-only "r" or read-write "rw".

Definition at line 68 of file Cube.cpp.

Isis::Cube::~Cube ( )

virtual

Destroys the Cube object.

Definition at line 75 of file Cube.cpp.

Member Function Documentation

void Isis::Cube::addCachingAlgorithm ( CubeCachingAlgorithm * algorithm )

This will add the given caching algorithm to the list of attempted caching algorithms.

The algorithms are tried in the opposite order that they were added - the first algorithm added is the last algorithm tried.

RegionalCachingAlgorithm is the only initial caching algorithm and works well for most cases. The caching algorithm only apply to the opened Cube and is reset by any changes to the open status of the Cube.

This method takes ownership of algorithm.

Parameters

algorithm The caching algorithm to add to the Cube for I/O

Definition at line 1505 of file Cube.cpp.

References _FILEINFO_.

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

int Isis::Cube::bandCount ( ) const

Returns the number of virtual bands for the cube.

Returns: int The number of bands in the cube.

Definition at line 1069 of file Cube.cpp.

Referenced by Isis::Process::CalculateStatistics(), Isis::Camera::Camera(), Isis::CubeViewport::cubeBands(), Isis::CubeViewport::CubeViewport(), Isis::CubeViewport::getAllWhatsThisInfo(), Isis::SpectralPlotTool::getSpectralStatistics(), Isis::Histogram::Histogram(), Isis::OverlapStatistics::OverlapStatistics(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::FileTool::saveAs_FullResolution(), Isis::FileTool::saveAsCubeByOption(), Isis::FileTool::saveAsEnlargedCube(), Isis::FileTool::saveAsReducedCube(), Isis::BandTool::setBandBin(), Isis::Process::SetInputCube(), Isis::ProcessMapMosaic::SetOutputCube(), and Isis::SpectralPlotTool::updateTool().

double Isis::Cube::base ( ) const

Returns the base value for converting 8-bit/16-bit pixels to 32-bit.

$out = in * multiplier + base$

Returns: double The base value for converting 8-bit/16-bit pixels to 32-bit.

Definition at line 1086 of file Cube.cpp.

Referenced by Isis::FileTool::copyCubeDetails().

ByteOrder Isis::Cube::byteOrder ( ) const

Returns the byte order/endian-ness of the cube file.

Cubes in a native byte order are quicker to read/write than those who must correct their byte order.

Returns: The byte order/endian-ness of the cube file

Definition at line 1098 of file Cube.cpp.

Camera * Isis::Cube::camera ( )

Return a camera associated with the cube.

The generation of the camera can throw an exception, so you might want to catch errors if that interests you.

Returns: A camera based on the open cube

Definition at line 1110 of file Cube.cpp.

Referenced by Isis::StereoTool::calculateElevation(), Isis::CameraStatistics::CameraStatistics(), Isis::InterestOperator::FindCnetRef(), Isis::ImagePolygon::initCube(), Isis::InterestOperator::InterestByMeasure(), Isis::Chip::Load(), Isis::ControlNetValidMeasure::MetersFromEdge(), Isis::SunShadowTool::mouseButtonPress(), Isis::SunShadowTool::recalculateShadowHeight(), Isis::SunShadowTool::updateTool(), and Isis::ControlNetValidMeasure::ValidStandardOptions().

void Isis::Cube::cleanUp ( bool removeIt )

private

This clears all of the allocated memory associated with an open cube.

Parameters

removeIt If true, the input cube will be removed from disk

Definition at line 1665 of file Cube.cpp.

void Isis::Cube::clearIoCache ( )

This will clear excess RAM used for quicker IO in the cube.

This should only be called if you need hundreds of cubes opened simultaneously. The IO cache will start growing again on future IO's.

Definition at line 1521 of file Cube.cpp.

void Isis::Cube::close ( bool removeIt = false )

Closes the cube and updates the labels.

Optionally, it deletes the cube if requested.

Parameters

removeIt (Default value = false) Indicates if the file should be removed/deleted.

Definition at line 174 of file Cube.cpp.

Referenced by Isis::ImageOverlapSet::FindImageOverlaps(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::FileTool::saveAsCubeByOption(), Isis::FileTool::saveAsReducedCube(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::GuiCubeParameter::ViewCube(), Isis::GuiCubeParameter::ViewLabel(), and Isis::Chip::Write().

void Isis::Cube::construct ( )

private

Initialize members from their initial undefined states.

Definition at line 1713 of file Cube.cpp.

void Isis::Cube::create ( const QString & cubeFileName )

This method will create an isis cube for writing.

The programmer should make appropriate calls to Set methods before invoking Create. If none are made there are internal defaults which are:

Dimensions     512x512x1
PixelType      Real
ByteOrder      Matches architecture of host machine
Attached       From user preference file
Label Size     65536 bytes
Format         Tiled
Base           0.0
Multiplier     1.0

Parameters

cubeFileName Name of the cube file to open. If the extenstion ".cub" is not given it will be appended (i.e., the extension of .cub is forced). Environment variables in the filename will be automatically expanded as well.

Definition at line 320 of file Cube.cpp.

References _FILEINFO_, Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::PixelTypeName(), Isis::SizeOf(), and Isis::toString().

Referenced by Isis::FileTool::copyCubeDetails(), Isis::Process::SetOutputCube(), and Isis::Chip::Write().

QFile * Isis::Cube::dataFile ( ) const

private

This returns the QFile with cube DN data in it.

NULL will be returned if no files are opened.

Returns: A file for cube pixel data I/O

Definition at line 1744 of file Cube.cpp.

bool Isis::Cube::deleteBlob	(	QString	BlobType,
		QString	BlobName
	)

This method will delete a blob label object from the cube as specified by the Blob type and name.

If blob does not exist it will do nothing and return false.

Parameters

BlobType	type of blob to search for (Polygon, Table, etc)
BlobName	blob to be deleted

Returns: boolean if it found the blob and deleted it.

Definition at line 1538 of file Cube.cpp.

References Isis::PvlObject::deleteObject(), Isis::PvlObject::findKeyword(), Isis::PvlContainer::name(), and Isis::PvlObject::object().

void Isis::Cube::deleteGroup ( const QString & group )

Deletes a group from the cube labels.

If the group does not exist nothing happens; otherwise the group is removed. This will only work on output cubes, therefore, input cubes will not be updated.

Parameters

[out] group Name of the group to delete.

Definition at line 1560 of file Cube.cpp.

References Isis::PvlObject::deleteGroup(), Isis::PvlObject::findObject(), and Isis::PvlObject::hasGroup().

Referenced by Isis::SubArea::UpdateLabel().

FileName Isis::Cube::externalCubeFileName ( ) const

If this is an external cube label file, this will give you the cube dn file that this label references.

Returns: The cube that this external label file references

Definition at line 1124 of file Cube.cpp.

References _FILEINFO_, and Isis::PvlObject::findObject().

Referenced by Isis::Image::copyToNewProjectRoot(), and Isis::Image::deleteFromDisk().

QString Isis::Cube::fileName ( ) const

Returns the opened cube's filename.

This is the name of the file which contains the labels of the cube and not necessarily the cube data.

Returns: The opened cube's filename

Definition at line 1152 of file Cube.cpp.

Referenced by Isis::Workspace::addCubeViewport(), Isis::ImagePolygon::Create(), Isis::StereoTool::createPoint(), Isis::MatchTool::createPoint(), Isis::CubeViewport::CubeViewport(), Isis::FeatureNomenclatureTool::featuresForViewportFound(), Isis::CubeViewport::getAllWhatsThisInfo(), Isis::Image::Image(), Isis::ImagePolygon::initCube(), Isis::Chip::Load(), Isis::ControlNetValidMeasure::MetersFromEdge(), Isis::MatchTool::mouseButtonRelease(), Isis::QnetTool::mouseButtonRelease(), Isis::QnetTool::openGround(), Isis::InterestOperator::Operate(), Isis::OverlapStatistics::OverlapStatistics(), Isis::CubePlotCurve::paint(), Isis::ScatterPlotConfigDialog::refreshWidgetStates(), Isis::AbstractPlotTool::repaintViewports(), Isis::FileTool::saveAsCubeByOption(), Isis::FileTool::saveAsReducedCube(), Isis::ScatterPlotWindow::ScatterPlotWindow(), Isis::MatchTool::serialNumberList(), Isis::CubeViewport::setCaption(), Isis::StereoTool::setFiles(), Isis::UniversalGroundMap::UniversalGroundMap(), Isis::MeasureTool::updateDist(), Isis::AdvancedTrackTool::updateRow(), and Isis::ControlNetValidMeasure::ValidStandardOptions().

Cube::Format Isis::Cube::format ( ) const

Returns: the cube's storage format. If no cube is opened yet, then this is the storage format that will be used if create(...) is called.

Definition at line 1164 of file Cube.cpp.

PvlGroup & Isis::Cube::group ( const QString & group ) const

Read a group from the cube into a Label.

If the group does not exist an exception will be thrown.

Parameters

[out] group Name of the group to get

Returns: (PvlGroup) Label which will contain the requested group.

Definition at line 1574 of file Cube.cpp.

References Isis::PvlObject::findGroup(), and Isis::PvlObject::findObject().

Referenced by Isis::HiLab::HiLab().

bool Isis::Cube::hasGroup ( const QString & group ) const

Return if the cube has a specified group in the labels.

Parameters

[out] group Name of the group to check.

Returns: (bool) True if the cube has the specified group, false if not.

Definition at line 1587 of file Cube.cpp.

References Isis::PvlObject::findObject(), and Isis::PvlObject::hasGroup().

Referenced by Isis::SubArea::UpdateLabel().

bool Isis::Cube::hasTable ( const QString & name )

Check to see if the cube contains a pvl table by the provided name.

Parameters

name	The name of the pvl table to search for

Returns: bool True if the pvl table was found

Definition at line 1601 of file Cube.cpp.

References Isis::PvlObject::hasKeyword(), Isis::PvlContainer::isNamed(), and Isis::PvlObject::object().

Referenced by Isis::AdvancedTrackTool::TrackMosaicOrigin().

Histogram * Isis::Cube::histogram	(	const int &	band = `1`,
		QString	msg = `"Gathering histogram"`
	)

This method returns a pointer to a Histogram object which allows the program to obtain and use various statistics and histogram information from the cube.

Cube does not retain ownership of the returned pointer - please delete it when you are done with it.

Parameters

[in]	band	(Default value is 1) Returns the histogram for the specified band.If the user specifies 0 for this parameter, the method will loop through every band in the cube and accumulate a histogram from all of them
	msg	The message to display with the percent process while gathering histogram data

Returns: (Histogram) A pointer to a Histogram object.

Exceptions

IsisProgrammerError Band was less than zero or more than the number of bands in the cube.

Definition at line 1188 of file Cube.cpp.

References Isis::ValidMaximum, and Isis::ValidMinimum.

Histogram * Isis::Cube::histogram	(	const int &	band,
		const double &	validMin,
		const double &	validMax,
		QString	msg = `"Gathering histogram"`
	)

This method returns a pointer to a Histogram object which allows the program to obtain and use various statistics and histogram information from the cube.

Cube does not retain ownership of the returned pointer - please delete it when you are done with it.

Parameters

[in]	band	Returns the histogram for the specified band. If the user specifies 0 for this parameter, the method will loop through every band in the cube and accumulate a histogram from all of them
	validMin	The start of the bin range and valid data range for the histogram
	validMax	The end of the bin range and valid data range for the histogram
	msg	The message to display with the percent process while gathering histogram data

Returns: (Histogram) A pointer to a Histogram object.

Exceptions

ProgrammerError Band was less than zero or more than the number of bands in the cube.

Definition at line 1218 of file Cube.cpp.

References _FILEINFO_, Isis::Histogram::AddData(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), Isis::ValidMaximum, and Isis::ValidMinimum.

void Isis::Cube::initialize ( )

private

This sets Cube to its default state: Native byte order Format = Tile PixelType = Real (4 bytes per pixel) Attached labels Label size = 65536 bytes

samples, lines, bands unset

Base = 0 Multiplier = 1.0.

Definition at line 1813 of file Cube.cpp.

References Isis::IsBigEndian().

bool Isis::Cube::isOpen ( ) const

Test if a cube file has been opened/created.

Returns: True if a cube has been opened and I/O operations are allowed

Definition at line 97 of file Cube.cpp.

Referenced by Isis::CubeViewport::CubeViewport(), and Isis::Process::SetInputCube().

bool Isis::Cube::isProjected ( ) const

Returns true if the labels of the cube appear to have a valid mapping group.

This returning true does not guarantee that the cube can project or that the Projection() method will succeed.

Returns: bool True if the file should have a valid projection

Definition at line 116 of file Cube.cpp.

bool Isis::Cube::isReadOnly ( ) const

Test if the opened cube is read-only, that is write operations will fail if this is true.

A cube must be opened in order to call this method.

Returns: True if the cube is opened read-only

Definition at line 127 of file Cube.cpp.

References _FILEINFO_.

Referenced by Isis::EditTool::mouseButtonRelease(), Isis::EditTool::redoEdit(), Isis::EditTool::rubberBandComplete(), Isis::EditTool::undoAll(), and Isis::EditTool::undoEdit().

bool Isis::Cube::isReadWrite ( ) const

Test if the opened cube is read-write, that is read and write operations should succeed if this is true.

A cube must be opened in order to call this method.

Returns: True if the cube is opened read-write

Definition at line 149 of file Cube.cpp.

Referenced by Isis::ProcessByBrick::ProcessCubeInPlace(), and Isis::ProcessByBrick::StartProcess().

Pvl * Isis::Cube::label ( ) const

Returns a pointer to the IsisLabel object associated with the cube.

Modifications made to the label will be written when the file is closed if it was opened read-write or created. Take care not to mangle the Core Object as this can produce unexpected results when a new attempt is made to open the file. This pointer is invalid as soon as the cube is closed.

Returns: Pvl Pointer to the Label object associated with the cube.

Definition at line 1289 of file Cube.cpp.

Referenced by Isis::AlphaCube::AlphaCube(), Isis::AmicaCamera::AmicaCamera(), Isis::ApolloMetricCamera::ApolloMetricCamera(), Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::Camera::Camera(), Isis::CameraFactory::CameraVersion(), Isis::Chandrayaan1M3Camera::Chandrayaan1M3Camera(), Isis::ObservationNumber::Compose(), Isis::SerialNumber::Compose(), Isis::FileTool::copyCubeDetails(), Isis::CameraFactory::Create(), Isis::ProjectionFactory::CreateFromCube(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::DemShape::DemShape(), Isis::SpectralPlotWindow::drawBandMarkers(), Isis::CubeViewport::getBandFilterName(), Isis::SpectralPlotTool::getSpectralStatistics(), Isis::HiresCamera::HiresCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::HrscCamera::HrscCamera(), Isis::IdealCamera::IdealCamera(), Isis::ImageImporter::import(), Isis::Image::isFootprintable(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::KaguyaMiCamera::KaguyaMiCamera(), Isis::Kernels::Kernels(), Isis::LoHighCamera::LoHighCamera(), Isis::LoMediumCamera::LoMediumCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::LwirCamera::LwirCamera(), Isis::MarciCamera::MarciCamera(), Isis::Mariner10Camera::Mariner10Camera(), Isis::MdisCamera::MdisCamera(), Isis::MiniRF::MiniRF(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::MsiCamera::MsiCamera(), Isis::NewHorizonsLeisaCamera::NewHorizonsLeisaCamera(), Isis::NewHorizonsLorriCamera::NewHorizonsLorriCamera(), Isis::NewHorizonsMvicFrameCamera::NewHorizonsMvicFrameCamera(), Isis::NewHorizonsMvicTdiCamera::NewHorizonsMvicTdiCamera(), Isis::NirCamera::NirCamera(), Isis::Process::PropagateTables(), Isis::MocLabels::ReadLabels(), Isis::ProjectionFactory::RingsCreateFromCube(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::BandTool::setBandBin(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::ProcessMosaic::SetOutputCube(), Isis::Spice::Spice(), Isis::SsiCamera::SsiCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::ThemisVisCamera::ThemisVisCamera(), Isis::AdvancedTrackTool::TrackMosaicOrigin(), Isis::UniversalGroundMap::UniversalGroundMap(), Isis::AlphaCube::UpdateGroup(), Isis::SubArea::UpdateLabel(), Isis::SpectralPlotTool::updateTool(), Isis::UvvisCamera::UvvisCamera(), Isis::GuiCubeParameter::ViewLabel(), Isis::VikingCamera::VikingCamera(), Isis::VimsCamera::VimsCamera(), and Isis::VoyagerCamera::VoyagerCamera().

bool Isis::Cube::labelsAttached ( ) const

Test if labels are attached.

If a cube is open, then this indicates whether or not the opened cube's labels are attached. If a cube is not open, then this indicates whether or not a cube will be created with attached labels if create(...) is called.

Returns: True for attached labels, false for detached

Definition at line 162 of file Cube.cpp.

int Isis::Cube::labelSize ( bool actual = false ) const

Returns the number of bytes used by the label.

Parameters

actual True for consumed size, false for allocated size (i.e. the number of bytes in the cube set aside for the label).

Returns: int the number of bytes used by the label.

Definition at line 1301 of file Cube.cpp.

Referenced by Isis::FileTool::copyCubeDetails(), and Isis::Process::SetOutputCube().

int Isis::Cube::lineCount ( ) const

Returns: the number of lines (y axis/height) in the cube. If no cube is open yet, this is the number of lines that will be written if create(...) is called.

Definition at line 1322 of file Cube.cpp.

Referenced by Isis::AlphaCube::AlphaCube(), Isis::ImagePolygon::calcImageBorderCoordinates(), Isis::Process::CalculateStatistics(), Isis::Camera::Camera(), Isis::Image::createFootprint(), Isis::StereoTool::createPoint(), Isis::CubeViewport::cubeContentsChanged(), Isis::CubeViewport::cubeDataChanged(), Isis::CubeViewport::cubeLines(), Isis::CubeViewport::CubeViewport(), Isis::ControlNetStatistics::GenerateImageStats(), Isis::CubeViewport::getAllWhatsThisInfo(), Isis::UniversalGroundMap::GroundRange(), Isis::StretchTool::histFromCube(), Isis::ImagePolygon::initCube(), Isis::ImageExporter::initializeProcess(), Isis::ControlNetValidMeasure::MetersFromEdge(), Isis::EditTool::mouseButtonRelease(), Isis::OverlapStatistics::OverlapStatistics(), Isis::ControlNetValidMeasure::PixelsFromEdge(), Isis::Chip::Read(), Isis::ScatterPlotConfigDialog::refreshWidgetStates(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::FileTool::saveAs_FullResolution(), Isis::FileTool::saveAsCubeByOption(), Isis::ScatterPlotData::ScatterPlotData(), Isis::Process::SetInputCube(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessByBrick::SetOutputCube(), Isis::ProcessMapMosaic::StartProcess(), Isis::StretchTool::statsFromCube(), Isis::TileManager::TileManager(), and Isis::SubArea::UpdateLabel().

double Isis::Cube::multiplier ( ) const

Returns the multiplier value for converting 8-bit/16-bit pixels to 32-bit.

$out = in * multiplier + base$

Returns: double The multiplier value for converting 8-bit/16-bit pixels to 32-bit.

Definition at line 1336 of file Cube.cpp.

Referenced by Isis::FileTool::copyCubeDetails().

void Isis::Cube::open	(	const QString &	cubeFileName,
		QString	access = `"r"`
	)

This method will open an isis sube for reading or reading/writing.

Parameters

[in]	cubeFileName	Name of the cube file to open. Environment variables in the filename will be automatically expanded.
[in]	access	(Default value of "r") Defines how the cube will be accessed. Either read-only "r" or read-write "rw".

Definition at line 508 of file Cube.cpp.

References _FILEINFO_, Isis::PvlObject::findObject(), and Isis::PvlObject::hasKeyword().

Referenced by Isis::CubeDataThread::AddCube(), Isis::Workspace::addCubeViewport(), Isis::ProcessPolygons::AppendOutputCube(), Isis::Equalization::calculateStatistics(), Isis::CameraStatistics::CameraStatistics(), Isis::ImageOverlapSet::FindImageOverlaps(), Isis::Blobber::load(), Isis::Process::PropagateTables(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::FileTool::saveAsCubeByOption(), Isis::FileTool::saveAsReducedCube(), Isis::MatchTool::selectLeftMeasure(), Isis::MatchTool::selectRightMeasure(), Isis::Process::SetInputCube(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessMosaic::SetOutputCube(), Isis::GuiCubeParameter::ViewCube(), and Isis::GuiCubeParameter::ViewLabel().

void Isis::Cube::openCheck ( )

private

Throw an exception if the cube is not open.

Definition at line 1976 of file Cube.cpp.

References _FILEINFO_.

int Isis::Cube::physicalBand ( const int & virtualBand ) const

This method will return the physical band number given a virtual band number.

Physical and virtual bands always match unless the programmer made a call to SetVirtualBand prior to opening the cube.

Parameters

virtualBand Virtual band to translate to physical band.

Returns: int The physical band number.

Definition at line 1361 of file Cube.cpp.

References _FILEINFO_, and Isis::toString().

Referenced by Isis::CubeViewport::getAllWhatsThisInfo(), and Isis::CubeViewport::updateWhatsThis().

PixelType Isis::Cube::pixelType ( ) const

Returns: the accuracy of pixels in the file. If no cube is opened yet, then this is the accuracy/number of bytes per pixel that will be used if create(...) is called.

Definition at line 1346 of file Cube.cpp.

Referenced by Isis::FileTool::copyCubeDetails(), Isis::CubeViewport::CubeViewport(), Isis::DemShape::DemShape(), Isis::MosaicSceneItem::getPixelValue(), Isis::SpatialPlotTool::getSpatialStatistics(), Isis::StatisticsTool::getStatistics(), Isis::StretchTool::histFromCube(), Isis::Histogram::Histogram(), Isis::ImagePolygon::initCube(), Isis::InterestOperator::InterestByMeasure(), Isis::EditTool::mouseButtonRelease(), Isis::OverlapStatistics::OverlapStatistics(), Isis::ScatterPlotWindow::paint(), Isis::Chip::Read(), Isis::EditTool::redoEdit(), Isis::FileTool::saveAs_FullResolution(), Isis::ScatterPlotData::ScatterPlotData(), Isis::ScatterPlotWindow::setMousePosition(), Isis::Process::SetOutputCube(), Isis::StretchTool::statsFromCube(), Isis::AdvancedTrackTool::TrackMosaicOrigin(), Isis::EditTool::undoEdit(), and Isis::EditTool::writeToCube().

Projection * Isis::Cube::projection ( )

Returns: a projection associated with the cube. The generation of the projection can throw an exception, so you might want to catch errors if that interests you.

Definition at line 1382 of file Cube.cpp.

Referenced by Isis::CubeViewport::CubeViewport(), Isis::DemShape::DemShape(), Isis::ImagePolygon::initCube(), Isis::Chip::Load(), Isis::OverlapStatistics::OverlapStatistics(), Isis::ProcessMapMosaic::StartProcess(), and Isis::SubArea::UpdateLabel().

void Isis::Cube::putGroup ( const PvlGroup & group )

Adds a group in a Label to the cube.

If the group already exists in the cube it will be completely overwritten. This will only work on output cubes, therefore, input cubes will not be updated.

Parameters

[in] group Label containing the group to put.

Definition at line 1626 of file Cube.cpp.

References Isis::PvlObject::addGroup(), Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::PvlObject::hasGroup(), and Isis::PvlContainer::name().

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

void Isis::Cube::read ( Blob & blob ) const

This method will read data from the specified Blob object.

Parameters

[in] blob The Blob data to be loaded

Returns: (type)return description

Definition at line 684 of file Cube.cpp.

References _FILEINFO_, and Isis::Blob::Read().

Referenced by Isis::CubeViewport::bluePixel(), Isis::Process::CalculateStatistics(), Isis::FileTool::copyCubeDetails(), Isis::ImageOverlapSet::FindImageOverlaps(), Isis::InterestOperator::FindOverlapByImageFootPrint(), Isis::MosaicSceneItem::getPixelValue(), Isis::SpatialPlotTool::getSpatialStatistics(), Isis::SpectralPlotTool::getSpectralStatistics(), Isis::StatisticsTool::getStatistics(), Isis::MosaicSceneItem::getStretch(), Isis::CubeViewport::grayPixel(), Isis::CubeViewport::greenPixel(), Isis::UniversalGroundMap::GroundRange(), Isis::StretchTool::histFromCube(), Isis::Histogram::Histogram(), Isis::InterestOperator::InterestByMeasure(), Isis::Blobber::load(), Isis::DemShape::localRadius(), Isis::EditTool::mouseButtonRelease(), Isis::ProcessByBrick::ProcessCubeInPlaceFunctor< T >::operator()(), Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator()(), Isis::OverlapStatistics::OverlapStatistics(), Isis::ScatterPlotWindow::paint(), Isis::Process::PropagateTables(), Isis::Chip::Read(), Isis::EditTool::redoEdit(), Isis::CubeViewport::redPixel(), Isis::HistogramTool::refreshPlot(), Isis::FileTool::saveAs_FullResolution(), Isis::FileTool::saveAsFullImage(), Isis::ScatterPlotData::ScatterPlotData(), Isis::ImagePolygon::SetImage(), Isis::ScatterPlotWindow::setMousePosition(), Isis::ProcessByBrick::StartProcess(), Isis::StretchTool::statsFromCube(), Isis::AdvancedTrackTool::TrackMosaicOrigin(), Isis::EditTool::undoEdit(), and Isis::EditTool::writeToCube().

void Isis::Cube::read ( Buffer & bufferToFill ) const

This method will read a buffer of data from the cube as specified by the contents of the Buffer object.

Parameters

bufferToFill Buffer to be loaded

Definition at line 706 of file Cube.cpp.

References _FILEINFO_.

FileName Isis::Cube::realDataFileName ( ) const

private

This gets the file name of the file which actually contains the DN data.

With ecub's, our data file name could be another ecub or a detached label, so using m_dataFileName is unreasonable.

Definition at line 1757 of file Cube.cpp.

References Isis::PvlObject::findObject(), and Isis::FileName::path().

void Isis::Cube::reformatOldIsisLabel ( const QString & oldCube )

private

This is a helper, used by open(...), that handles opening Isis 2 cubes as if they were Isis 3 cubes.

Parameters

oldCube The filename of the Isis 2 cube

Definition at line 2013 of file Cube.cpp.

void Isis::Cube::reopen ( QString access = "r" )

This method will reopen an isis sube for reading or reading/writing.

If access requested is read/write and the open fails, open as read only and throw error.

Parameters

[in] access (QString) Type of access needed (read or read/write

Definition at line 651 of file Cube.cpp.

References _FILEINFO_.

Referenced by Isis::EditTool::mouseButtonRelease(), Isis::EditTool::rubberBandComplete(), and Isis::FileTool::save().

int Isis::Cube::sampleCount ( ) const

Returns: the number of samples (x axis/width) in the cube. If no cube is open yet, this is the number of samples that will be written if create(...) is called.

Definition at line 1395 of file Cube.cpp.

Referenced by Isis::AlphaCube::AlphaCube(), Isis::Camera::Camera(), Isis::Image::createFootprint(), Isis::StereoTool::createPoint(), Isis::CubeViewport::cubeContentsChanged(), Isis::CubeViewport::cubeDataChanged(), Isis::CubeViewport::cubeSamples(), Isis::CubeViewport::CubeViewport(), Isis::Enlarge::Enlarge(), Isis::ControlNetStatistics::GenerateImageStats(), Isis::CubeViewport::getAllWhatsThisInfo(), Isis::UniversalGroundMap::GroundRange(), Isis::StretchTool::histFromCube(), Isis::ImagePolygon::initCube(), Isis::ImageExporter::initializeProcess(), Isis::ProcessExportPds::LineBytes(), Isis::ControlNetValidMeasure::MetersFromEdge(), Isis::EditTool::mouseButtonRelease(), Isis::OverlapStatistics::OverlapStatistics(), Isis::ControlNetValidMeasure::PixelsFromEdge(), Isis::CubeCalculator::prepareCalculations(), Isis::Chip::Read(), Isis::Reduce::Reduce(), Isis::ScatterPlotConfigDialog::refreshWidgetStates(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::FileTool::saveAs_FullResolution(), Isis::FileTool::saveAsCubeByOption(), Isis::FileTool::saveAsFullImage(), Isis::ScatterPlotData::ScatterPlotData(), Isis::Process::SetInputCube(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessMapMosaic::StartProcess(), Isis::StretchTool::statsFromCube(), Isis::TileManager::TileManager(), Isis::AdvancedTrackTool::TrackMosaicOrigin(), and Isis::SubArea::UpdateLabel().

void Isis::Cube::setBaseMultiplier	(	double	base,
		double	mult
	)

Used prior to the Create method, this will specify the base and multiplier for converting 8-bit/16-bit back and forth between 32-bit:

$32-bit pixel = 8-bit/16-bit pixel * multiplier + base$

.

Parameters

base	Additive constant.
mult	Multiplicative constant.

Definition at line 826 of file Cube.cpp.

Referenced by Isis::FileTool::copyCubeDetails(), and Isis::Process::SetOutputCube().

void Isis::Cube::setByteOrder ( ByteOrder byteOrder )

Used prior to the Create method, this will specify the byte order of pixels, either least or most significant byte.

Parameters

byteOrder An enumeration of either Msb or Lsb.

Definition at line 871 of file Cube.cpp.

Referenced by Isis::FileTool::copyCubeDetails(), and Isis::Process::SetOutputCube().

void Isis::Cube::setDimensions	(	int	ns,
		int	nl,
		int	nb
	)

Used prior to the Create method to specify the size of the cube.

If not invoked, a 512 x 512 x 1 cube will be created.

Parameters

ns	Number of samples
nl	Number of lines
nb	Number of bands

Definition at line 886 of file Cube.cpp.

References _FILEINFO_.

Referenced by Isis::FileTool::copyCubeDetails(), Isis::ImageImporter::createOutput(), Isis::Process::SetOutputCube(), and Isis::Chip::Write().

void Isis::Cube::setFormat ( Format format )

Used prior to the Create method, this will specify the format of the cube, either band, sequential or tiled.

If not invoked, a tiled file will be created.

Parameters

format An enumeration of either Bsq or Tile.

Definition at line 930 of file Cube.cpp.

Referenced by Isis::FileTool::copyCubeDetails(), and Isis::Process::SetOutputCube().

void Isis::Cube::setLabelsAttached ( bool attach )

Use prior to calling create, this sets whether or not to use separate label and data files.

Parameters

attach If false, the labels and data will be in separate files.

Definition at line 942 of file Cube.cpp.

Referenced by Isis::FileTool::copyCubeDetails(), and Isis::Process::SetOutputCube().

void Isis::Cube::setLabelSize ( int labelBytes )

Used prior to the Create method, this will allocate a specific number of bytes in the label area for attached files.

If not invoked, 65536 bytes will be reserved by default.

Parameters

[in] labelBytes Number of bytes to reserve for label space.

Definition at line 955 of file Cube.cpp.

Referenced by Isis::FileTool::copyCubeDetails(), and Isis::Process::SetOutputCube().

void Isis::Cube::setMinMax	(	double	min,
		double	max
	)

Used prior to the Create method, this will compute a good base and multiplier value given the minimum/maximum range of the 32bit data.

For example, min=0.0 and max=1.0 of 32-bit pixels will ensure the base and multiplier will cause the data to be spread out fully in the 8=bit or 16-bit range.

Parameters

min	Minimum 32-bit pixel.
max	Maximum 32-bit pixel.

Definition at line 843 of file Cube.cpp.

Referenced by Isis::FileTool::copyCubeDetails(), and Isis::Process::SetOutputCube().

void Isis::Cube::setPixelType ( PixelType pixelType )

Used prior to the Create method, this will specify the output pixel type.

If not invoked, the pixel type will be Real.

Parameters

pixelType An enumeration of the pixelType desired in the output cube. See PixelType documentation for more information.

Definition at line 968 of file Cube.cpp.

Referenced by Isis::FileTool::copyCubeDetails(), and Isis::Process::SetOutputCube().

void Isis::Cube::setVirtualBands ( const QList< QString > & vbands )

This allows the programmer to specify a subset of bands to work with.

This works with both read and write operations, but is typically only used for reading. This is helpful because users can specify which bands from an input cube they want to work with. For example, if the user only wants to work with band 5 out of a 10 band cube, this can be accommodated.

Parameters

[in] vbands A vector of strings containing the virtual bands. The vector must contain integers in string form (e.g., "5", "10", "1").

Definition at line 985 of file Cube.cpp.

References Isis::toInt().

Referenced by Isis::Workspace::addCubeViewport(), and Isis::Process::SetInputCube().

void Isis::Cube::setVirtualBands ( const std::vector< QString > & vbands )

This is a deprecated version of setVirtualBands(const QList<QString> &).

Parameters

[in] vbands A vector of strings containing the virtual bands. The vector must contain integers in string form (e.g., "5", "10", "1").

Definition at line 1015 of file Cube.cpp.

Statistics * Isis::Cube::statistics	(	const int &	band = `1`,
		QString	msg = `"Gathering statistics"`
	)

This method returns a pointer to a Statistics object which allows the program to obtain and use various statistics from the cube.

Cube does not retain ownership of the returned pointer - please delete it when you are done with it.

Parameters

[in]	band	(Default value is 1) Returns the statistics for the specified band.If the user specifies 0 for this parameter, the method will loop through every band in the cube and accumulate statistics from each band seperately
	msg	The message to display with the percent process while gathering statistics

Returns: (Histogram) A pointer to a Statistics object containing details such as the minimum and maximum pixel values for the input cube on the band specified, or all bands as the case may be.

Definition at line 1418 of file Cube.cpp.

References Isis::ValidMaximum, and Isis::ValidMinimum.

Statistics * Isis::Cube::statistics	(	const int &	band,
		const double &	validMin,
		const double &	validMax,
		QString	msg = `"Gathering statistics"`
	)

This method returns a pointer to a Statistics object which allows the program to obtain and use various statistics from the cube.

Cube does not retain ownership of the returned pointer - please delete it when you are done with it.

Parameters

band	Returns the statistics for the specified band. If the user specifies 0 for this parameter, the method will loop through every band in the cube and accumulate statistics from each band seperately
validMin
validMax
msg

Returns: Statistics*

Definition at line 1439 of file Cube.cpp.

References _FILEINFO_, Isis::Statistics::AddData(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), and Isis::Buffer::size().

void Isis::Cube::write ( Blob & blob )

This method will write a blob of data (e.g.

History, Table, etc) to the cube as specified by the contents of the Blob object.

Parameters

blob	data to be written

Definition at line 723 of file Cube.cpp.

References _FILEINFO_, Isis::Blob::Name(), Isis::Blob::Type(), and Isis::Blob::Write().

Referenced by Isis::FileTool::copyCubeDetails(), Isis::ProcessByBrick::ProcessCubeInPlaceFunctor< T >::operator()(), Isis::ProcessByBrick::ProcessCubeFunctor< T >::operator()(), Isis::EditTool::redoEdit(), Isis::FileTool::saveAs_FullResolution(), Isis::FileTool::saveAsFullImage(), Isis::Process::SetOutputCube(), Isis::ProcessByBrick::StartProcess(), Isis::EditTool::undoAll(), Isis::EditTool::undoEdit(), Isis::Chip::Write(), Isis::Process::WriteHistory(), and Isis::EditTool::writeToCube().

void Isis::Cube::write ( Buffer & bufferToWrite )

This method will write a buffer of data from the cube as specified by the contents of the Buffer object.

Parameters

bufferToWrite Buffer to be written.

Definition at line 793 of file Cube.cpp.

References _FILEINFO_.

void Isis::Cube::writeLabels ( )

private

Write the Pvl labels to the cube's label file.

Excess data in the attached labels is set to 0.

Definition at line 2038 of file Cube.cpp.

References _FILEINFO_.

Member Data Documentation

bool Isis::Cube::m_attached

private

True if labels are attached.

Definition at line 373 of file Cube.h.

int Isis::Cube::m_bands

private

The band count of the open cube or the cube that will be created.

Definition at line 395 of file Cube.h.

double Isis::Cube::m_base

private

The base of the open cube or the cube that will be created; does not apply if m_pixelType is Real.

Definition at line 401 of file Cube.h.

ByteOrder Isis::Cube::m_byteOrder

private

The byte order of the opened cube; if there is no open cube then this is the byte order that will be used when a new cube is created.

Defaults to the OS's byte order.

Definition at line 331 of file Cube.h.

Camera* Isis::Cube::m_camera

private

Camera allocated from the camera() method.

Definition at line 351 of file Cube.h.

QFile* Isis::Cube::m_dataFile

private

This is only sometimes allocated.

This is used for when IsOpen is true and labels are detached so the QFile for the labels does not give us cube data.

Definition at line 318 of file Cube.h.

FileName* Isis::Cube::m_dataFileName

private

The full filename of the data file (.cub)

Definition at line 360 of file Cube.h.

Format Isis::Cube::m_format

private

If isOpen() then this is the IO format that the cube uses.

If there is no file opened then this is the IO format that will be used if a cube is created (using create(...)). This defaults to Tile.

Definition at line 338 of file Cube.h.

FileName* Isis::Cube::m_formatTemplateFile

private

Label pvl format template file (describes how to format labels)

Definition at line 370 of file Cube.h.

CubeIoHandler* Isis::Cube::m_ioHandler

private

This does the heavy lifting for cube DN IO and is always allocated when isOpen() is true.

Definition at line 324 of file Cube.h.

Pvl* Isis::Cube::m_label

private

The label if IsOpen(), otherwise NULL.

Definition at line 383 of file Cube.h.

int Isis::Cube::m_labelBytes

private

The maximum allowed size of the label; the allocated space.

Definition at line 386 of file Cube.h.

QFile* Isis::Cube::m_labelFile

private

This is the file that contains the labels always; if labels are attached then this contains the file data also.

The method dataFile() will always give you the appropriate QFile member for reading cube data; this should always be used for the labels.

If isOpen() is true, then this is allocated.

Definition at line 312 of file Cube.h.

FileName* Isis::Cube::m_labelFileName

private

The full filename of the label file (.lbl or .cub)

Definition at line 357 of file Cube.h.

int Isis::Cube::m_lines

private

The line count of the open cube or the cube that will be created.

Definition at line 392 of file Cube.h.

double Isis::Cube::m_multiplier

private

The multiplier of the open cube or the cube that will be created; does not apply if m_pixelType is Real.

Definition at line 407 of file Cube.h.

QMutex* Isis::Cube::m_mutex

private

Basic thread-safety mutex; this class is not optimized for threads.

Definition at line 348 of file Cube.h.

PixelType Isis::Cube::m_pixelType

private

This is the pixel type on disk.

If a cube is open, then this will be the opened cube's pixel type. Otherwise, if a cube is created with create(...) then this pixel type will be used. The default is Real.

Definition at line 345 of file Cube.h.

Projection* Isis::Cube::m_projection

private

Projection allocated from the projection() method.

Definition at line 354 of file Cube.h.

int Isis::Cube::m_samples

private

The sample count of the open cube or the cube that will be created.

Definition at line 389 of file Cube.h.

bool Isis::Cube::m_storesDnData

private

True (most common case) when the cube DN data is inside the file we're writing to.

False means we're referencing another cube's internal DN data for reading, and writing buffers is disallowed.

Definition at line 380 of file Cube.h.

FileName* Isis::Cube::m_tempCube

private

If open was called with an Isis 2 cube, then this will be the name of the imported Isis3 cube.

m_labelFileName and m_dataFileName will store the Isis 2 cube's information.

Definition at line 367 of file Cube.h.

QList<int>* Isis::Cube::m_virtualBandList

private

If allocated, converts from physical on-disk band # to virtual band #.

Definition at line 410 of file Cube.h.

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

src/base/objs/Cube/Cube.h
src/base/objs/Cube/Cube.cpp

Public Types

Public Member Functions

Private Member Functions

samples, lines, bands unset

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

samples, lines, bands unset

Member Data Documentation