Isis 3 Programmer Reference
Isis::BundleImage Class Reference

This class hold image information that BundleAdjust needs to run correctly.Definition for a BundleImageQsp, a shared pointer to a BundleImage. More...

#include <BundleImage.h>

Collaboration diagram for Isis::BundleImage:
Collaboration graph

Public Member Functions

 BundleImage (Camera *camera, QString serialNumber, QString fileName)
 Constructs a BundleImage with the given camera pointer, serial number, and filename. More...
 
 BundleImage (const BundleImage &other)
 Constructs a BundleImage from another BundleImage object. More...
 
 ~BundleImage ()
 Destroys a BundleImage object. More...
 
BundleImageoperator= (const BundleImage &other)
 An assignment operator to set this BundleImage to another BundleImage object. More...
 
void setParentObservation (QSharedPointer< BundleObservation > parentObservation)
 Sets the parent BundleObservation object. More...
 
Cameracamera ()
 Returns the camera model used for the BundleImage. More...
 
QSharedPointer< BundleObservationparentObservation ()
 Returns the parent BundleObservation object. More...
 
QString serialNumber ()
 Returns the serial number for the BundleImage. More...
 
QString fileName ()
 Returns the file name for the BundleImage. More...
 

Private Attributes

Cameram_camera
 The camera model for the image. More...
 
QSharedPointer< BundleObservationm_parentObservation
 parent BundleObservation More...
 
QString m_serialNumber
 The serial number for the image. More...
 
QString m_fileName
 The file name of the image. More...
 

Detailed Description

This class hold image information that BundleAdjust needs to run correctly.Definition for a BundleImageQsp, a shared pointer to a BundleImage.

Author
2014-05-22 Ken Edmundson
History:

2014-05-22 Ken Edmundson - Original Version

2014-07-17 Kimberly Oyama - Updated to better meet coding standards.

2014-02-20 Jeannie Backer - Added assignment operator. Updated to better meet coding standards.

2016-06-27 Jesse Mapel - Updated documentation in preparation for merging from IPCE to ISIS. Fixes #4076.

2016-08-03 Jesse Mapel - Changed parent observation to a QSharedPointer. Fixes #4150.

2016-08-18 Jesse Mapel - Changed to no longer inherit from QObject. Fixes #4192.

Definition at line 51 of file BundleImage.h.

Constructor & Destructor Documentation

◆ BundleImage() [1/2]

Isis::BundleImage::BundleImage ( Camera camera,
QString  serialNumber,
QString  fileName 
)

Constructs a BundleImage with the given camera pointer, serial number, and filename.

Parent observation defaults to NULL.

Parameters
cameraThe camera model for the BundleImage
serialNumberThe serial number for the BundleImage
fileNameThe file name for the BundleImage

Definition at line 17 of file BundleImage.cpp.

References camera(), fileName(), m_camera, m_fileName, m_serialNumber, and serialNumber().

◆ BundleImage() [2/2]

Isis::BundleImage::BundleImage ( const BundleImage other)

Constructs a BundleImage from another BundleImage object.

Parameters
otherThe BundleImage to copy from.

Definition at line 29 of file BundleImage.cpp.

References m_camera, m_fileName, m_parentObservation, and m_serialNumber.

◆ ~BundleImage()

Isis::BundleImage::~BundleImage ( )

Destroys a BundleImage object.

Definition at line 40 of file BundleImage.cpp.

Member Function Documentation

◆ camera()

Camera * Isis::BundleImage::camera ( )

Returns the camera model used for the BundleImage.

Returns
Camera* A pointer to the camera model.

Definition at line 81 of file BundleImage.cpp.

References m_camera.

Referenced by BundleImage().

◆ fileName()

QString Isis::BundleImage::fileName ( )

Returns the file name for the BundleImage.

Returns
QString The image's file name.

Definition at line 111 of file BundleImage.cpp.

References m_fileName.

Referenced by BundleImage().

◆ operator=()

BundleImage & Isis::BundleImage::operator= ( const BundleImage other)

An assignment operator to set this BundleImage to another BundleImage object.

Parameters
otherThe BundleImage to copy from.
Returns
BundleImage& A reference to this BundleImage after being assigned to.

Definition at line 51 of file BundleImage.cpp.

References m_camera, m_fileName, m_parentObservation, and m_serialNumber.

◆ parentObservation()

QSharedPointer< BundleObservation > Isis::BundleImage::parentObservation ( )

Returns the parent BundleObservation object.

Returns
QSharedPointer<BundleObservation> A pointer to the parent BundleObservation.

Definition at line 91 of file BundleImage.cpp.

References m_parentObservation.

Referenced by setParentObservation().

◆ serialNumber()

QString Isis::BundleImage::serialNumber ( )

Returns the serial number for the BundleImage.

Returns
QString The image's serial number.

Definition at line 101 of file BundleImage.cpp.

References m_serialNumber.

Referenced by BundleImage().

◆ setParentObservation()

void Isis::BundleImage::setParentObservation ( QSharedPointer< BundleObservation parentObservation)

Sets the parent BundleObservation object.

Parameters
parentObservationThe parent BundleObservation.

Definition at line 67 of file BundleImage.cpp.

References m_parentObservation, and parentObservation().

Member Data Documentation

◆ m_camera

Camera* Isis::BundleImage::m_camera
private

The camera model for the image.

Definition at line 75 of file BundleImage.h.

Referenced by BundleImage(), camera(), and operator=().

◆ m_fileName

QString Isis::BundleImage::m_fileName
private

The file name of the image.

Definition at line 78 of file BundleImage.h.

Referenced by BundleImage(), fileName(), and operator=().

◆ m_parentObservation

QSharedPointer<BundleObservation> Isis::BundleImage::m_parentObservation
private

parent BundleObservation

Definition at line 76 of file BundleImage.h.

Referenced by BundleImage(), operator=(), parentObservation(), and setParentObservation().

◆ m_serialNumber

QString Isis::BundleImage::m_serialNumber
private

The serial number for the image.

Definition at line 77 of file BundleImage.h.

Referenced by BundleImage(), operator=(), and serialNumber().


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