This represents a cube in a project-based GUI interface. More...

#include <Image.h>

Inheritance diagram for Isis::Image:

Collaboration diagram for Isis::Image:

Classes
class	XmlHandler
	Process XML in a stack-oriented fashion. More...

Public Slots
void	updateFileName (Project *)
	Change the on-disk file name for this cube to be where the image ought to be in the given project. More...

Public Member Functions
	Image (QString imageFileName, QObject *parent=0)
	Create an image from a cube file on disk. More...

	Image (Cube imageCube, QObject parent=0)
	Create an image from a cube file on disk. More...

	Image (Cube imageCube, geos::geom::MultiPolygon footprint, QString id, QObject *parent=0)
	Create an image from a cube file on disk including the footprint. More...

	Image (FileName imageFolder, XmlStackedHandlerReader xmlReader, QObject parent=0)
	Construct this image from XML. More...

	~Image ()
	Clean up this image. More...

void	fromPvl (const PvlObject &pvl)
	Read the image settings from a Pvl. More...

PvlObject	toPvl () const
	Convert this Image to PVL. More...

bool	isFootprintable () const
	Test to see if it's possible to create a footprint from this image. More...

Cube *	cube ()
	Get the Cube pointer associated with this display property. More...

void	closeCube ()
	Cleans up the Cube pointer. More...

ImageDisplayProperties *	displayProperties ()
	Get the display (GUI) properties (information) associated with this image. More...

const ImageDisplayProperties *	displayProperties () const
	Get a non-mutable (const) the display (GUI) properties (information) associated with this image. More...

QString	fileName () const
	Get the file name of the cube that this image represents. More...

QString	observationNumber ()
	Returns the observation number of the Cube. More...

QString	serialNumber ()
	Returns the serial number of the Cube. More...

geos::geom::MultiPolygon *	footprint ()
	Get the footprint of this image (if available). More...

const geos::geom::MultiPolygon *	footprint () const
	Get the non-mutable (const) footprint of this image (if available). More...

void	setId (QString id)
	Override the automatically generated ID with the given ID. More...

bool	initFootprint (QMutex *cameraMutex)
	Calculate a footprint for this image. More...

double	aspectRatio () const
	Get the aspect ratio of this image, as calculated and attached by camstats. More...

QString	id () const
	Get a unique, identifying string associated with this image. More...

double	resolution () const
	Get the resolution of this image, as calculated and attached by camstats. More...

Angle	emissionAngle () const
	Get the emission angle of this image, as calculated and attached by camstats. More...

Angle	incidenceAngle () const
	Get the incidence angle of this image, as calculated and attached by camstats. More...

double	lineResolution () const
	Get the line resolution of this image, as calculated and attached by camstats. More...

Distance	localRadius () const
	Get the local radius of this image, as calculated and attached by camstats. More...

Angle	northAzimuth () const
	Get the north azimuth of this image, as calculated and attached by camstats. More...

Angle	phaseAngle () const
	Get the phase angle of this image, as calculated and attached by camstats. More...

double	sampleResolution () const
	Get the sample resolution of this image, as calculated and attached by camstats. More...

void	copyToNewProjectRoot (const Project *project, FileName newProjectRoot)
	Copy the cub/ecub files associated with this image into the new project. More...

void	deleteFromDisk ()
	Delete the image data from disk. More...

void	save (QXmlStreamWriter &stream, const Project *project, FileName newProjectRoot) const
	Write the Image properties out to an XML file. More...

Private Member Functions
geos::geom::MultiPolygon *	createFootprint (QMutex *cameraMutex)
	Calculates a footprint for an Image using the camera or projection information. More...

void	initCamStats ()
	Checks to see if the Cube label contains Camera Statistics. More...

void	initQuickFootprint ()
	Creates a default ImagePolygon option which is read into the Cube. More...

	Image (const Image &other)

Image &	operator= (const Image &rhs)

Private Attributes
SpiceInt *	m_bodyCode
	The NaifBodyCode value, if it exists in the labels. More...

Cube *	m_cube
	The cube associated with this Image. More...

ImageDisplayProperties *	m_displayProperties
	The GUI information for how this Image ought to be displayed. More...

QString	m_fileName
	The on-disk file name of the cube associated with this Image. More...

QString	m_instrumentId
	Instrument id associated with this Image. More...

QString	m_observationNumber
	The observation number for this image. More...

QString	m_serialNumber
	The serial number for this image. More...

QString	m_spacecraftName
	Spacecraft name associated with this Image. More...

geos::geom::MultiPolygon *	m_footprint
	A 0-360 ocentric lon,lat degrees footprint of this Image. More...

QUuid *	m_id
	A unique ID for this Image (useful for others to reference this Image when saving to disk). More...

double	m_aspectRatio
	Aspect ratio of the image. More...

double	m_resolution
	Resolution of the image. More...

Angle	m_emissionAngle
	Emmission angle of the image. More...

Angle	m_incidenceAngle
	Incidence angle of the image. More...

double	m_lineResolution
	Line resolution of the image. More...

double	m_sampleResolution
	Sample resolution of the image. More...

Distance	m_localRadius
	Local radius of the image. More...

Angle	m_northAzimuth
	North Azimuth for the image. More...

Angle	m_phaseAngle
	Phase angle for the image. More...

Detailed Description

This represents a cube in a project-based GUI interface.

The actual cube doesn't have to be open. This encapsulates ideas about an image such as it's footprint, it's cube, how it should be viewed, where it is on disk, etc. This class is designed to be semi-light weight - we should be able to have tens of thousands of these in memory without any issues (provided the Cube files aren't open - see closeCube()).

Author: 2012-07-23 ???

History:

2011-05-11 Steven Lambright - Added accessors for data that is complicated to get or expensive (i.e. Camera statistics and the footprint).

2011-05-18 Steven Lambright - Fixed the second constructor

2012-10-02 Steven Lambright - Added support for camera statistics information that used to be in CubeDisplayProperties (a class that no longer exists).

2012-10-04 Jeannie Backer Changed references to TableField methods to lower camel case. Fixed history entry indentation. Added padding to control statements. References #1169.

2015-10-14 Jeffrey Covington - Declared Image * as a Qt metatype for use with QVariant.

2014-09-05 Kimberly Oyama - Added the serialNumber() function which returns the cube's serial number.

2015-09-05 Kenneth Edmundson - Added preliminary target body information (re: the member variables QString m_instrumentId (the instrument ID of the image), SpiceInt * m_bodyCode (the NaifBodyCode value if it exists in the labels), and QString m_spacecraftName (the Spacecraft name associated with this image).

2016-06-22 Tyler Wilson - Added documentation to member functions/variables. Fixes #3950.

2017-10-11 Summer Stapleton - Removed path to instrumentId and spacecraftName in the startElement method. Fixes #5179.

2017-11-01 Tracie Sucharski - Changed copyToNewProjectRoot to handle Images that are located outside of the import image directories such as the updated Images from a bundle run. To improve efficiency, return from method if the project root has not changed. Fixes #4849.

2018-06-30 Ian Humphrey - Added observationNumber() method so anything that grabs an Image ProjectItem can easily get both the serial number and observation number now. References #497.

2018-07-02 Ian Humphrey - Changed serialNumber() implementation to follow how observationNumber() is implemented. This ensures that any calls after the first call to these methods are O(1) and are not bottlenecekd by any file I/O that occurs in the Compose() methods. References #497.

2018-10-03 Tracie Sucharski - Added constructor which takes cube and a calculated footprint. This was done for ipce imported shapes which do not contain a footprint. References #5504.

Definition at line 107 of file Image.h.

Constructor & Destructor Documentation

◆ Image() [1/4]

Isis::Image::Image	(	QString	imageFileName,
		QObject *	parent = `0`
	)

explicit

Create an image from a cube file on disk.

Parameters

imageFileName	The name of a cube on disk - /work/users/.../blah.cub
parent	The Qt-relationship parent

Definition at line 42 of file Image.cpp.

References cube(), initCamStats(), initQuickFootprint(), m_aspectRatio, m_bodyCode, m_cube, m_displayProperties, m_fileName, m_footprint, m_id, m_lineResolution, m_resolution, m_sampleResolution, and Isis::Null.

◆ Image() [2/4]

Isis::Image::Image	(	Cube *	imageCube,
		QObject *	parent = `0`
	)

explicit

Create an image from a cube file on disk.

Parameters

imageFileName	The name of a cube on disk - /work/users/.../blah.cub
parent	The Qt-relationship parent

Definition at line 77 of file Image.cpp.

References Isis::Cube::fileName(), initCamStats(), initQuickFootprint(), m_aspectRatio, m_bodyCode, m_cube, m_displayProperties, m_fileName, m_footprint, m_id, m_lineResolution, m_resolution, m_sampleResolution, and Isis::Null.

◆ Image() [3/4]

Isis::Image::Image	(	Cube *	imageCube,
		geos::geom::MultiPolygon *	footprint,
		QString	id,
		QObject *	parent = `0`
	)

explicit

Create an image from a cube file on disk including the footprint.

Parameters

imageFileName	The name of a cube on disk - /work/users/.../blah.cub
footprint	The calculated footprint
parent	The Qt-relationship parent

Definition at line 111 of file Image.cpp.

References Isis::Cube::fileName(), footprint(), initCamStats(), m_aspectRatio, m_bodyCode, m_cube, m_displayProperties, m_fileName, m_footprint, m_id, m_lineResolution, m_resolution, m_sampleResolution, Isis::Null, and setId().

◆ Image() [4/4]

Isis::Image::Image	(	FileName	imageFolder,
		XmlStackedHandlerReader *	xmlReader,
		QObject *	parent = `0`
	)

Construct this image from XML.

Parameters

imageFolder	Where this image XML resides - /work/.../projectRoot/images/import1
xmlReader	An XML reader that's up to an <image> tag.
parent	The Qt-relationship parent

Definition at line 141 of file Image.cpp.

References m_aspectRatio, m_bodyCode, m_cube, m_displayProperties, m_footprint, m_id, m_lineResolution, m_resolution, m_sampleResolution, Isis::Null, and Isis::XmlStackedHandlerReader::pushContentHandler().

◆ ~Image()

Isis::Image::~Image ( )

Clean up this image.

If you haven't saved this image, all of its settings will be lost.

Definition at line 161 of file Image.cpp.

References m_bodyCode, m_cube, m_displayProperties, m_footprint, and m_id.

Member Function Documentation

◆ aspectRatio()

double Isis::Image::aspectRatio ( ) const

Get the aspect ratio of this image, as calculated and attached by camstats.

Returns: double The aspect ratio if available, otherwise Null is returned.

Definition at line 436 of file Image.cpp.

References m_aspectRatio.

Referenced by Isis::ImageTreeWidgetItem::ImageTreeWidgetItem().

◆ closeCube()

void Isis::Image::closeCube ( )

Cleans up the Cube pointer.

You want to call this once you are sure you are done with the Cube because the OS will limit how many of these we have open.

Definition at line 307 of file Image.cpp.

References m_cube.

Referenced by deleteFromDisk(), Isis::ImageList::ImageList(), Isis::BundleAdjust::imageLists(), Isis::Project::imagesReady(), Isis::ImportImagesWorkOrder::importConfirmedImages(), Isis::JigsawRunWidget::on_JigsawAcceptButton_clicked(), Isis::ExportImagesWorkOrder::ProjectImageExportFunctor::operator()(), and updateFileName().

◆ copyToNewProjectRoot()

void Isis::Image::copyToNewProjectRoot	(	const Project *	project,
		FileName	newProjectRoot
	)

Copy the cub/ecub files associated with this image into the new project.

Parameters

newProjectRoot The root directory where the project is stored.

Definition at line 534 of file Image.cpp.

References Isis::Cube::copy(), Isis::FileName::dir(), Isis::Cube::externalCubeFileName(), Isis::Project::imageDataRoot(), m_fileName, Isis::FileName::name(), Isis::Project::newProjectRoot(), Isis::FileName::path(), Isis::Project::projectRoot(), Isis::FileName::setExtension(), Isis::Cube::storesDnData(), and Isis::FileName::toString().

Referenced by Isis::ImageList::CopyImageDataFunctor::operator()().

◆ createFootprint()

geos::geom::MultiPolygon * Isis::Image::createFootprint ( QMutex * cameraMutex )

private

Calculates a footprint for an Image using the camera or projection information.

Parameters

cameraMutex A mutex that guarantees us serial access to the camera/projection classes

Returns: (geos::geom::MultiPolygon *) The resulting footprint.

Definition at line 706 of file Image.cpp.

References _FILEINFO_, Isis::ImagePolygon::Create(), cube(), displayProperties(), Isis::Cube::lineCount(), Isis::PolygonTools::MakeMultiPolygon(), Isis::ImagePolygon::Polys(), Isis::IException::print(), Isis::Cube::sampleCount(), and Isis::IException::User.

Referenced by initFootprint().

◆ cube()

Cube * Isis::Image::cube ( )

Get the Cube pointer associated with this display property.

This will allocate the Cube pointer if one is not already present.

Exceptions

IException::Programmer "Cube cannot be created"

Returns: (Cube *) A pointer to the image cube.

Definition at line 287 of file Image.cpp.

References _FILEINFO_, m_cube, m_fileName, and Isis::IException::Programmer.

Referenced by Isis::Workspace::addImages(), createFootprint(), deleteFromDisk(), Isis::MosaicSceneItem::drawImage(), Isis::MosaicSceneItem::getPixelValue(), Isis::MosaicSceneItem::getStretch(), Image(), initCamStats(), initQuickFootprint(), observationNumber(), Isis::CubeDnView::onItemAdded(), Isis::ExportImagesWorkOrder::ProjectImageExportFunctor::operator()(), serialNumber(), and Isis::CubeDnView::setWorkspaceActiveCube().

◆ deleteFromDisk()

void Isis::Image::deleteFromDisk ( )

Delete the image data from disk.

The cube() will no longer be accessible until you call updateFileName().

Exceptions

IException::Io "Could not remove file [$filename]"

Definition at line 586 of file Image.cpp.

References _FILEINFO_, closeCube(), cube(), Isis::FileName::expanded(), Isis::Cube::externalCubeFileName(), Isis::IException::Io, m_fileName, Isis::FileName::path(), and Isis::FileName::setExtension().

Referenced by Isis::ImageList::deleteFromDisk().

◆ displayProperties() [1/2]

ImageDisplayProperties * Isis::Image::displayProperties ( )

Get the display (GUI) properties (information) associated with this image.

Returns: (ImageDisplayProperties *) Returns a poniter to an ImageDisplayProperties that describes how to view this image.

Definition at line 320 of file Image.cpp.

References m_displayProperties.

◆ displayProperties() [2/2]

const ImageDisplayProperties * Isis::Image::displayProperties ( ) const

Get a non-mutable (const) the display (GUI) properties (information) associated with this image.

Returns: (ImageDisplayProperties *) A pointer to a non-mutable ImageDisplayProperties object that describes how to view this image.

Definition at line 331 of file Image.cpp.

References m_displayProperties.

◆ emissionAngle()

Angle Isis::Image::emissionAngle ( ) const

Get the emission angle of this image, as calculated and attached by camstats.

This is the image-wide average.

Returns: Angle The emission angle if available, otherwise an invalid angle is returned.

Definition at line 465 of file Image.cpp.

References m_emissionAngle.

Referenced by Isis::ImageTreeWidgetItem::ImageTreeWidgetItem().

◆ fileName()

QString Isis::Image::fileName ( ) const

Get the file name of the cube that this image represents.

Returns: QString A string containing the path to the cube data associated with this image.

Definition at line 340 of file Image.cpp.

References m_fileName.

Referenced by Isis::BundleAdjust::BundleAdjust(), Isis::JigsawRunWidget::on_JigsawAcceptButton_clicked(), Isis::ExportImagesWorkOrder::ProjectImageExportFunctor::operator()(), Isis::ImageFileListWidget::saveList(), Isis::ProjectItem::setImage(), and Isis::Image::XmlHandler::startElement().

◆ footprint() [1/2]

geos::geom::MultiPolygon * Isis::Image::footprint ( )

Get the footprint of this image (if available).

Returns: (geos::geom::MultiPolygon *) A pointer to a lat/lon footprint of this image, or NULL if unavailable.

Definition at line 374 of file Image.cpp.

References m_footprint.

Referenced by Image().

◆ footprint() [2/2]

const geos::geom::MultiPolygon * Isis::Image::footprint ( ) const

Get the non-mutable (const) footprint of this image (if available).

Returns: geos::geom::MultiPolygon A non-mutable (const) lat/lon footprint of this image, or NULL if unavailable.

Definition at line 393 of file Image.cpp.

References m_footprint.

◆ fromPvl()

void Isis::Image::fromPvl ( const PvlObject & pvl )

Read the image settings from a Pvl.

The Pvl file looks like this:

  Object = Image
    FileName = ...
    ID = ...
  EndObject

Parameters

pvl	The PvlObject that contains image information.

Exceptions

IException::Unknown "Tried to load Image with properties/information"

Definition at line 194 of file Image.cpp.

References _FILEINFO_, displayProperties(), Isis::PvlObject::findObject(), Isis::PvlObject::hasKeyword(), m_fileName, m_id, and Isis::IException::Unknown.

Referenced by Isis::ImageReader::VariantToImageFunctor::operator()().

◆ id()

QString Isis::Image::id ( ) const

Get a unique, identifying string associated with this image.

Returns: QString A unique ID for this image.

Definition at line 445 of file Image.cpp.

References m_id.

Referenced by Isis::Project::addImagesToIdMap(), Isis::ImageFileListWidget::find(), Isis::Project::imagesReady(), Isis::ImportImagesWorkOrder::importConfirmedImages(), Isis::WorkOrder::listenForImageDestruction(), Isis::ImageFileListWidget::save(), and Isis::ImageFileListWidget::toPvl().

◆ incidenceAngle()

Angle Isis::Image::incidenceAngle ( ) const

Get the incidence angle of this image, as calculated and attached by camstats.

This is the image-wide average.

Returns: Angle The incidence angle if available, otherwise an invalid angle is returned.

Definition at line 475 of file Image.cpp.

References m_incidenceAngle.

Referenced by Isis::ImageTreeWidgetItem::ImageTreeWidgetItem().

◆ initCamStats()

void Isis::Image::initCamStats ( )

private

Checks to see if the Cube label contains Camera Statistics.

If it does, then we attempt to grab data from the label to populate the private members variables.

Definition at line 734 of file Image.cpp.

References cube(), Isis::Angle::Degrees, Isis::PvlObject::findGroup(), Isis::PvlObject::hasGroup(), Isis::PvlContainer::hasKeyword(), Isis::Cube::label(), m_aspectRatio, m_emissionAngle, m_fileName, m_incidenceAngle, m_instrumentId, m_lineResolution, m_localRadius, m_northAzimuth, m_phaseAngle, m_resolution, m_sampleResolution, m_spacecraftName, Isis::Distance::Meters, Isis::PvlContainer::name(), Isis::PvlObject::object(), Isis::PvlObject::objects(), and Isis::Table::Records().

Referenced by Image().

◆ initFootprint()

bool Isis::Image::initFootprint ( QMutex * cameraMutex )

Calculate a footprint for this image.

If the footprint is already stored inside the cube, that will be used instead. If no footprint can be found, this throws an exception.

Parameters

cameraMutex A pointer to the camera mutex to lock the camera resource while a footprint is created.

Exceptions

IException::Io "Could not read the footprint from cube [$cube]. Please make sure footprintinit has been run"

Returns: bool Returns True if there is a footprint stored in the Cube, False otherwise.

Definition at line 409 of file Image.cpp.

References _FILEINFO_, createFootprint(), Isis::DisplayProperties::displayName(), displayProperties(), initQuickFootprint(), Isis::IException::Io, and m_footprint.

Referenced by Isis::ImageReader::VariantToImageFunctor::operator()().

◆ initQuickFootprint()

void Isis::Image::initQuickFootprint ( )

private

Creates a default ImagePolygon option which is read into the Cube.

See also: Isis::ImagePolygon

Definition at line 817 of file Image.cpp.

References cube(), m_footprint, Isis::PolygonTools::MakeMultiPolygon(), Isis::ImagePolygon::Polys(), and Isis::Cube::read().

Referenced by Image(), and initFootprint().

◆ isFootprintable()

bool Isis::Image::isFootprintable ( ) const

Test to see if it's possible to create a footprint from this image.

This may not give an accurate answer if the cube isn't open.

Returns: bool Returns True if it is possible, False if it is not.

Definition at line 253 of file Image.cpp.

References Isis::PvlObject::hasKeyword(), Isis::PvlContainer::isNamed(), Isis::Cube::label(), m_cube, m_footprint, Isis::Blob::Name(), Isis::PvlObject::object(), Isis::PvlObject::objects(), and Isis::Blob::Type().

Referenced by Isis::Footprint2DViewWorkOrder::isExecutable().

◆ lineResolution()

double Isis::Image::lineResolution ( ) const

Get the line resolution of this image, as calculated and attached by camstats.

This is the image-wide average.

Returns: double The line resolution if available, otherwise Null.

Definition at line 485 of file Image.cpp.

References m_lineResolution.

Referenced by Isis::ImageTreeWidgetItem::ImageTreeWidgetItem().

◆ localRadius()

Distance Isis::Image::localRadius ( ) const

Get the local radius of this image, as calculated and attached by camstats.

This is the image-wide average.

Returns: The local radius if available, otherwise an invalid Distance.

Definition at line 495 of file Image.cpp.

References m_localRadius.

◆ northAzimuth()

Angle Isis::Image::northAzimuth ( ) const

Get the north azimuth of this image, as calculated and attached by camstats.

This is the image-wide average.

Returns: Angle The north azimuth if available, otherwise an invalid angle

Definition at line 505 of file Image.cpp.

References m_northAzimuth.

Referenced by Isis::ImageTreeWidgetItem::ImageTreeWidgetItem().

◆ observationNumber()

QString Isis::Image::observationNumber ( )

Returns the observation number of the Cube.

Returns: QString A string representation of the observation number of the cube.

Definition at line 349 of file Image.cpp.

References Isis::ObservationNumber::Compose(), cube(), and m_observationNumber.

Referenced by Isis::JigsawSetupDialog::on_applySettingsPushButton_clicked(), and Isis::JigsawSetupDialog::updateBundleObservationSolveSettings().

◆ phaseAngle()

Angle Isis::Image::phaseAngle ( ) const

Get the phase angle of this image, as calculated and attached by camstats.

This is the image-wide average.

Returns: Angle The phase angle if available, otherwise an invalid angle is returned.

Definition at line 515 of file Image.cpp.

References m_phaseAngle.

Referenced by Isis::ImageTreeWidgetItem::ImageTreeWidgetItem().

◆ resolution()

double Isis::Image::resolution ( ) const

Get the resolution of this image, as calculated and attached by camstats.

This is the image-wide average.

Returns: double The resolution if available, otherwise Null is returned.

Definition at line 455 of file Image.cpp.

References m_resolution.

Referenced by Isis::ImageTreeWidgetItem::ImageTreeWidgetItem().

◆ sampleResolution()

double Isis::Image::sampleResolution ( ) const

Get the sample resolution of this image, as calculated and attached by camstats.

This is the image-wide average.

Returns: double The sample resolution if available, otherwise Null is returned.

Definition at line 525 of file Image.cpp.

References m_sampleResolution.

Referenced by Isis::ImageTreeWidgetItem::ImageTreeWidgetItem().

◆ save()

void Isis::Image::save	(	QXmlStreamWriter &	stream,
		const Project *	project,
		FileName	newProjectRoot
	)		const

Write the Image properties out to an XML file.

Parameters

stream	The output data stream.
project	The project this image is contained within.
newProjectRoot	The path/filename we are writing to.

Output format:

(fileName attribute is just the base name)

Definition at line 626 of file Image.cpp.

References Isis::IsSpecial(), Isis::Angle::isValid(), Isis::Distance::isValid(), m_aspectRatio, m_displayProperties, m_emissionAngle, m_fileName, m_footprint, m_id, m_incidenceAngle, m_instrumentId, m_lineResolution, m_localRadius, m_northAzimuth, m_phaseAngle, m_resolution, m_sampleResolution, m_spacecraftName, Isis::Distance::meters(), Isis::Angle::radians(), and Isis::DisplayProperties::save().

◆ serialNumber()

QString Isis::Image::serialNumber ( )

Returns the serial number of the Cube.

Returns: QString A string representation of the serial number of the cube.

Definition at line 361 of file Image.cpp.

References Isis::SerialNumber::Compose(), cube(), and m_serialNumber.

Referenced by Isis::ControlHealthMonitorView::openImageEditor().

◆ setId()

void Isis::Image::setId ( QString id )

Override the automatically generated ID with the given ID.

Parameters

id	The id tjat overrides the automatically generated id.

Definition at line 383 of file Image.cpp.

References m_id.

Referenced by Image(), and Isis::ImportImagesWorkOrder::importConfirmedImages().

◆ toPvl()

PvlObject Isis::Image::toPvl ( ) const

Convert this Image to PVL.

The output looks like this:

  Object = Image
    FileName = ...
    ID = ...
  EndObject

Returns: PvlObject A PvlObject that contains image information.

Definition at line 226 of file Image.cpp.

References m_fileName.

◆ updateFileName

void Isis::Image::updateFileName ( Project * project )

slot

Change the on-disk file name for this cube to be where the image ought to be in the given project.

Parameters

project The project that this image is stored in.

Definition at line 691 of file Image.cpp.

References closeCube(), Isis::FileName::dir(), Isis::Project::imageDataRoot(), m_fileName, and Isis::FileName::name().

Member Data Documentation

◆ m_aspectRatio

double Isis::Image::m_aspectRatio

private

Aspect ratio of the image.

Definition at line 247 of file Image.h.

Referenced by aspectRatio(), Image(), initCamStats(), and save().

◆ m_bodyCode

SpiceInt* Isis::Image::m_bodyCode

private

The NaifBodyCode value, if it exists in the labels.

Otherwise, if the target is sky, it's the SPK code and if not sky then it's calculated by the NaifBodyCode() method.

Definition at line 195 of file Image.h.

Referenced by Image(), and ~Image().

◆ m_cube

Cube* Isis::Image::m_cube

private

The cube associated with this Image.

This is usually NULL once the image is done initializing because no more than a thousand of these should ever be open at once.

Definition at line 206 of file Image.h.

Referenced by closeCube(), cube(), Image(), isFootprintable(), and ~Image().

◆ m_displayProperties

ImageDisplayProperties* Isis::Image::m_displayProperties

private

The GUI information for how this Image ought to be displayed.

Definition at line 211 of file Image.h.

Referenced by displayProperties(), Image(), save(), and ~Image().

◆ m_emissionAngle

Angle Isis::Image::m_emissionAngle

private

Emmission angle of the image.

Definition at line 249 of file Image.h.

Referenced by emissionAngle(), initCamStats(), and save().

◆ m_fileName

QString Isis::Image::m_fileName

private

The on-disk file name of the cube associated with this Image.

Definition at line 216 of file Image.h.

Referenced by copyToNewProjectRoot(), cube(), deleteFromDisk(), fileName(), fromPvl(), Image(), initCamStats(), save(), toPvl(), and updateFileName().

◆ m_footprint

geos::geom::MultiPolygon* Isis::Image::m_footprint

private

A 0-360 ocentric lon,lat degrees footprint of this Image.

Definition at line 241 of file Image.h.

Referenced by footprint(), Image(), initFootprint(), initQuickFootprint(), isFootprintable(), save(), and ~Image().

◆ m_id

QUuid* Isis::Image::m_id

private

A unique ID for this Image (useful for others to reference this Image when saving to disk).

Definition at line 245 of file Image.h.

Referenced by fromPvl(), id(), Image(), save(), setId(), and ~Image().

◆ m_incidenceAngle

Angle Isis::Image::m_incidenceAngle

private

Incidence angle of the image.

Definition at line 250 of file Image.h.

Referenced by incidenceAngle(), initCamStats(), and save().

◆ m_instrumentId

QString Isis::Image::m_instrumentId

private

Instrument id associated with this Image.

Definition at line 221 of file Image.h.

Referenced by initCamStats(), and save().

◆ m_lineResolution

double Isis::Image::m_lineResolution

private

Line resolution of the image.

Definition at line 251 of file Image.h.

Referenced by Image(), initCamStats(), lineResolution(), and save().

◆ m_localRadius

Distance Isis::Image::m_localRadius

private

Local radius of the image.

Definition at line 253 of file Image.h.

Referenced by initCamStats(), localRadius(), and save().

◆ m_northAzimuth

Angle Isis::Image::m_northAzimuth

private

North Azimuth for the image.

Definition at line 254 of file Image.h.

Referenced by initCamStats(), northAzimuth(), and save().

◆ m_observationNumber

QString Isis::Image::m_observationNumber

private

The observation number for this image.

Definition at line 226 of file Image.h.

Referenced by observationNumber().

◆ m_phaseAngle

Angle Isis::Image::m_phaseAngle

private

Phase angle for the image.

Definition at line 255 of file Image.h.

Referenced by initCamStats(), phaseAngle(), and save().

◆ m_resolution

double Isis::Image::m_resolution

private

Resolution of the image.

Definition at line 248 of file Image.h.

Referenced by Image(), initCamStats(), resolution(), and save().

◆ m_sampleResolution

double Isis::Image::m_sampleResolution

private

Sample resolution of the image.

Definition at line 252 of file Image.h.

Referenced by Image(), initCamStats(), sampleResolution(), and save().

◆ m_serialNumber

QString Isis::Image::m_serialNumber

private

The serial number for this image.

Definition at line 231 of file Image.h.

Referenced by serialNumber().

◆ m_spacecraftName

QString Isis::Image::m_spacecraftName

private

Spacecraft name associated with this Image.

Definition at line 236 of file Image.h.

Referenced by initCamStats(), and save().

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

src/qisis/objs/Image/Image.h
src/qisis/objs/Image/Image.cpp

Classes

Public Slots

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Image() [1/4]

◆ Image() [2/4]

◆ Image() [3/4]

◆ Image() [4/4]

◆ ~Image()

Member Function Documentation

◆ aspectRatio()

◆ closeCube()

◆ copyToNewProjectRoot()

◆ createFootprint()

◆ cube()

◆ deleteFromDisk()

◆ displayProperties() [1/2]

◆ displayProperties() [2/2]

◆ emissionAngle()

◆ fileName()

◆ footprint() [1/2]

◆ footprint() [2/2]

◆ fromPvl()

◆ id()

◆ incidenceAngle()

◆ initCamStats()

◆ initFootprint()

◆ initQuickFootprint()

◆ isFootprintable()

◆ lineResolution()

◆ localRadius()

◆ northAzimuth()

◆ observationNumber()

◆ phaseAngle()

◆ resolution()

◆ sampleResolution()

◆ save()

◆ serialNumber()

◆ setId()

◆ toPvl()

◆ updateFileName

Member Data Documentation

◆ m_aspectRatio

◆ m_bodyCode

◆ m_cube

◆ m_displayProperties

◆ m_emissionAngle

◆ m_fileName

◆ m_footprint

◆ m_id

◆ m_incidenceAngle

◆ m_instrumentId

◆ m_lineResolution

◆ m_localRadius

◆ m_northAzimuth

◆ m_observationNumber

◆ m_phaseAngle

◆ m_resolution

◆ m_sampleResolution

◆ m_serialNumber

◆ m_spacecraftName