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

#include <Shape.h>

Inheritance diagram for Isis::Shape:

Collaboration diagram for Isis::Shape:

Classes
class	XmlHandler

Public Types
enum	ShapeType { Dem, Basemap, Unprojected, Unknown }

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

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

	Shape (Cube shapeCube, QObject parent=0)
	Create an shape from a cube file on disk. More...

	Shape (FileName shapeFolder, XmlStackedHandlerReader xmlReader, QObject parent=0)
	Construct this shape from XML. More...

	~Shape ()
	Clean up this shape. More...

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

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

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

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

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

ControlPoint::SurfacePointSource::Source	surfacePointSource ()

ControlPoint::RadiusSource::Source	radiusSource ()

ShapeDisplayProperties *	displayProperties ()
	Get the display (GUI) properties (information) associated with this shape. More...

ShapeType	shapeType ()

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

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

QString	serialNumber ()
	Get the serial number. More...

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

const geos::geom::MultiPolygon *	footprint () const
	Get the non-mutable (const) footprint of this shape (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 shape. More...

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

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

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

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

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

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

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

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

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

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

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

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

void	save (QXmlStreamWriter &stream, const Project *project, FileName newProjectRoot) const
	Output format: More...

Private Member Functions
	Shape (const Shape &other)

Shape &	operator= (const Shape &rhs)

void	initMemberData ()

void	initShape ()

void	initCamStats ()
	TODO. More...

void	initMapStats ()

void	initDemStats ()

geos::geom::MultiPolygon *	createFootprint (QMutex *cameraMutex)
	Calculate a footprint for an Shape using the camera or projection information. More...

void	initQuickFootprint ()

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

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

ControlPoint::SurfacePointSource::Source	m_surfacePointSource

ControlPoint::RadiusSource::Source	m_radiusSource

ShapeType	m_shapeType

ShapeDisplayProperties *	m_displayProperties
	The GUI information for how this Shape ought to be displayed. More...

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

QString	m_serialNumber
	This will always be simply the filename and is created on construction. More...

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

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

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

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

double	m_aspectRatio

double	m_resolution

Angle	m_emissionAngle

Angle	m_incidenceAngle

double	m_lineResolution

Distance	m_localRadius

Angle	m_northAzimuth

Angle	m_phaseAngle

double	m_sampleResolution

QString	m_targetName

QString	m_projectionName

Longitude	m_centerLongitude

Latitude	m_centerLatitude

Latitude	m_minimumLatitude

Latitude	m_maximumLatitude

Longitude	m_minimumLongitude

Longitude	m_maximumLongitude

double	m_pixelResolution

double	m_scale

Distance	m_minimumRadius

Distance	m_maximumRadius

Detailed Description

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

The actual cube doesn't have to be open. This encapsulates ideas about an shape 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: 2016-07-25 Tracie Sucharski

History:

2016-10-21 Tracie Sucharski - Add Image to the Shape class. This was done because the qmos class expect Images, and we want to display a footprint of a Shape.

2018-09-10 Tracie Sucharski - Added surface point source and radius source along with access methods.

2018-09-21 Tracie Sucharski - Serial number is composed on construction and is always the filename.

2018-10-03 Tracie Sucharski - Fixed problem in constructor with cube being set before member data was initialized. Fixed the computation for surfacePointSource and radiusSource. References #5504.

Definition at line 78 of file Shape.h.

Constructor & Destructor Documentation

◆ Shape() [1/3]

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

explicit

Create an Shape from a cube file on disk.

Parameters

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

Definition at line 45 of file Shape.cpp.

References cube(), and m_fileName.

◆ Shape() [2/3]

Isis::Shape::Shape	(	Cube *	shapeCube,
		QObject *	parent = `0`
	)

explicit

Create an shape from a cube file on disk.

Parameters

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

Definition at line 61 of file Shape.cpp.

References Isis::Cube::fileName(), m_cube, and m_fileName.

◆ Shape() [3/3]

Isis::Shape::Shape	(	FileName	shapeFolder,
		XmlStackedHandlerReader *	xmlReader,
		QObject *	parent = `0`
	)

Construct this shape from XML.

Parameters

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

Definition at line 78 of file Shape.cpp.

References Isis::XmlStackedHandlerReader::pushContentHandler().

◆ ~Shape()

Isis::Shape::~Shape ( )

Clean up this shape.

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

Definition at line 89 of file Shape.cpp.

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

Member Function Documentation

◆ aspectRatio()

double Isis::Shape::aspectRatio ( ) const

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

Returns: The aspect ratio if available, otherwise Null

Definition at line 450 of file Shape.cpp.

◆ closeCube()

void Isis::Shape::closeCube ( )

Cleans up the Cube *.

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

Definition at line 343 of file Shape.cpp.

References m_cube.

Referenced by deleteFromDisk(), Isis::ImportShapesWorkOrder::importConfirmedShapes(), and updateFileName().

◆ copyToNewProjectRoot()

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

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

Definition at line 556 of file Shape.cpp.

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

Referenced by Isis::ShapeList::CopyShapeDataFunctor::operator()().

◆ createFootprint()

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

private

Calculate a footprint for an Shape using the camera or projection information.

Parameters

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

Returns: The resulting footprint

Definition at line 639 of file Shape.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::Shape::cube ( )

Get the Cube * associated with this display property.

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

Definition at line 325 of file Shape.cpp.

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

Referenced by Isis::ControlPointEditWidget::createControlPoint(), createFootprint(), deleteFromDisk(), Isis::ControlNetTool::drawAllMeasurements(), initCamStats(), Isis::CubeDnView::onItemAdded(), Isis::Footprint2DView::onItemAdded(), Isis::ControlPointEditWidget::setShapesForPoint(), Shape(), and Isis::ImageFileListWidget::XmlHandler::startElement().

◆ deleteFromDisk()

void Isis::Shape::deleteFromDisk ( )

Delete the shape data from disk.

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

Definition at line 592 of file Shape.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::ShapeList::deleteFromDisk().

◆ displayProperties() [1/2]

ShapeDisplayProperties * Isis::Shape::displayProperties ( )

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

Returns: An ShapeDisplayProperties that describes how to view this shape.

Definition at line 356 of file Shape.cpp.

References m_displayProperties.

Referenced by createFootprint(), fromPvl(), Isis::ImportShapesWorkOrder::importConfirmedShapes(), and initFootprint().

◆ displayProperties() [2/2]

const ShapeDisplayProperties * Isis::Shape::displayProperties ( ) const

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

Returns: A non-mutable ShapeDisplayProperties that describes how to view this shape.

Definition at line 367 of file Shape.cpp.

References m_displayProperties.

◆ emissionAngle()

Angle Isis::Shape::emissionAngle ( ) const

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

This is the shape-wide average.

Returns: The emission angle if available, otherwise an invalid angle

Definition at line 482 of file Shape.cpp.

◆ fileName()

QString Isis::Shape::fileName ( ) const

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

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

Definition at line 377 of file Shape.cpp.

References m_fileName.

Referenced by Isis::ControlPointEditWidget::createControlPoint(), Isis::ControlPointEditWidget::loadPoint(), Isis::ControlPointEditWidget::setGroundSourceInfo(), Isis::ProjectItem::setShape(), Isis::ControlPointEditWidget::setShapesForPoint(), and Isis::Shape::XmlHandler::startElement().

◆ footprint() [1/2]

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

Get the footprint of this shape (if available).

Returns: A lat/lon footprint of this shape, or NULL if unavailable.

Definition at line 395 of file Shape.cpp.

References m_footprint.

Referenced by Isis::Footprint2DView::onItemAdded(), and Isis::ImageFileListWidget::XmlHandler::startElement().

◆ footprint() [2/2]

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

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

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

Definition at line 413 of file Shape.cpp.

References m_footprint.

◆ fromPvl()

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

Read the shape settings from a Pvl.

  Object = Shape
    FileName = ...
    ID = ...
  EndObject

Parameters

pvl	The PvlObject that contains shape information.

Definition at line 236 of file Shape.cpp.

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

Referenced by Isis::ShapeReader::VariantToShapeFunctor::operator()().

◆ id()

QString Isis::Shape::id ( ) const

Get a unique, identifying string associated with this shape.

Returns: A unique ID for this shape

Definition at line 460 of file Shape.cpp.

References m_id.

Referenced by Isis::ImportShapesWorkOrder::importConfirmedShapes(), Isis::WorkOrder::listenForShapeDestruction(), and Isis::Footprint2DView::onItemAdded().

◆ incidenceAngle()

Angle Isis::Shape::incidenceAngle ( ) const

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

This is the shape-wide average.

Returns: The incidence angle if available, otherwise an invalid angle

Definition at line 493 of file Shape.cpp.

◆ initCamStats()

void Isis::Shape::initCamStats ( )

private

TODO.

Definition at line 666 of file Shape.cpp.

References cube(), Isis::Angle::Degrees, Isis::PvlObject::findGroup(), Isis::PvlObject::hasGroup(), Isis::PvlContainer::hasKeyword(), Isis::Cube::label(), m_fileName, m_instrumentId, m_spacecraftName, Isis::Distance::Meters, Isis::PvlContainer::name(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::IException::print(), and Isis::Table::Records().

◆ initFootprint()

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

Calculate a footprint for this shape.

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

Definition at line 422 of file Shape.cpp.

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

Referenced by Isis::ShapeReader::VariantToShapeFunctor::operator()().

◆ isFootprintable()

bool Isis::Shape::isFootprintable ( ) const

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

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

Definition at line 294 of file Shape.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::Shape::lineResolution ( ) const

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

This is the shape-wide average.

Returns: The line resolution if available, otherwise Null

Definition at line 504 of file Shape.cpp.

◆ localRadius()

Distance Isis::Shape::localRadius ( ) const

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

This is the shape-wide average.

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

Definition at line 515 of file Shape.cpp.

◆ northAzimuth()

Angle Isis::Shape::northAzimuth ( ) const

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

This is the shape-wide average.

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

Definition at line 526 of file Shape.cpp.

◆ phaseAngle()

Angle Isis::Shape::phaseAngle ( ) const

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

This is the shape-wide average.

Returns: The phase angle if available, otherwise an invalid angle

Definition at line 537 of file Shape.cpp.

◆ resolution()

double Isis::Shape::resolution ( ) const

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

This is the shape-wide average.

Returns: The resolution if available, otherwise Null

Definition at line 471 of file Shape.cpp.

◆ sampleResolution()

double Isis::Shape::sampleResolution ( ) const

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

This is the shape-wide average.

Returns: The sample resolution if available, otherwise Null

Definition at line 548 of file Shape.cpp.

◆ save()

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

Output format:

(fileName attribute is just the base name)

Definition at line 846 of file Shape.cpp.

References Isis::IsSpecial(), Isis::Angle::isValid(), Isis::Distance::isValid(), m_displayProperties, m_fileName, m_footprint, m_id, m_instrumentId, m_serialNumber, m_spacecraftName, Isis::Distance::meters(), Isis::Angle::radians(), Isis::ControlPoint::RadiusSourceToString(), Isis::ShapeDisplayProperties::save(), and Isis::ControlPoint::SurfacePointSourceToString().

◆ serialNumber()

QString Isis::Shape::serialNumber ( )

Get the serial number.

Returns: SerialNumber The cube's serial number.

Definition at line 386 of file Shape.cpp.

References m_serialNumber.

Referenced by Isis::ControlNetTool::drawAllMeasurements().

◆ setId()

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

Override the automatically generated ID with the given ID.

Definition at line 403 of file Shape.cpp.

References m_id.

Referenced by Isis::ImportShapesWorkOrder::importConfirmedShapes().

◆ toPvl()

PvlObject Isis::Shape::toPvl ( ) const

Convert this Shape to PVL.

The output looks like this:

  Object = Shape
    FileName = ...
    ID = ...
  EndObject

Returns: A PvlObject that contains shape information.

Definition at line 268 of file Shape.cpp.

References m_fileName.

◆ updateFileName

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

slot

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

Parameters

project The project that this shape is stored in

Definition at line 623 of file Shape.cpp.

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

Member Data Documentation

◆ m_bodyCode

SpiceInt* Isis::Shape::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 167 of file Shape.h.

Referenced by ~Shape().

◆ m_cube

Cube* Isis::Shape::m_cube

private

The cube associated with this Shape.

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

Definition at line 178 of file Shape.h.

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

◆ m_displayProperties

ShapeDisplayProperties* Isis::Shape::m_displayProperties

private

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

Definition at line 186 of file Shape.h.

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

◆ m_fileName

QString Isis::Shape::m_fileName

private

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

Definition at line 190 of file Shape.h.

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

◆ m_footprint

geos::geom::MultiPolygon* Isis::Shape::m_footprint

private

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

Definition at line 206 of file Shape.h.

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

◆ m_id

QUuid* Isis::Shape::m_id

private

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

Definition at line 210 of file Shape.h.

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

◆ m_instrumentId

QString Isis::Shape::m_instrumentId

private

Instrument id associated with this Shape.

Definition at line 198 of file Shape.h.

Referenced by initCamStats(), and save().

◆ m_serialNumber

QString Isis::Shape::m_serialNumber

private

This will always be simply the filename and is created on construction.

Definition at line 194 of file Shape.h.

Referenced by save(), and serialNumber().

◆ m_spacecraftName

QString Isis::Shape::m_spacecraftName

private

Spacecraft name associated with this Shape.

Definition at line 202 of file Shape.h.

Referenced by initCamStats(), and save().

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

src/qisis/objs/Shape/Shape.h
src/qisis/objs/Shape/Shape.cpp

Classes

Public Types

Public Slots

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Shape() [1/3]

◆ Shape() [2/3]

◆ Shape() [3/3]

◆ ~Shape()

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

◆ isFootprintable()

◆ lineResolution()

◆ localRadius()

◆ northAzimuth()

◆ phaseAngle()

◆ resolution()

◆ sampleResolution()

◆ save()

◆ serialNumber()

◆ setId()

◆ toPvl()

◆ updateFileName

Member Data Documentation

◆ m_bodyCode

◆ m_cube

◆ m_displayProperties

◆ m_fileName

◆ m_footprint

◆ m_id

◆ m_instrumentId

◆ m_serialNumber

◆ m_spacecraftName