Reads user Apollos from a data file. More...

#include <Apollo.h>

Collaboration diagram for Isis::Apollo:

Public Member Functions
	Apollo (QString spacecraft, QString instrument)
	Constructor. More...

	Apollo (QString filename)
	Constructor. More...

	~Apollo ()
	Destroys the Apollo object. More...

bool	IsMetric ()
	Checks if the instrument is an Apollo Metric camera. More...

bool	IsPanoramic ()
	Checks if the instrument is an Apollo Panoramic camera. More...

bool	IsHasselblad ()
	Checks if the instrument is an Apollo Hasselblad camera. More...

bool	IsApollo15 ()
	Checks if the spacecraft is Apollo 15. More...

bool	IsApollo16 ()
	Checks if the spacecraft is Apollo 16. More...

bool	IsApollo17 ()
	Checks if the spacecraft is Apollo 17. More...

int	Width ()
	Returns the width of the image. More...

int	Height ()
	Returns the height of the image. More...

int	Bands ()
	Returns number of bands in the image. More...

int	ReseauDimension ()
	Returns the reseau dimension of the image. More...

double	PixelPitch ()
	Returns pixel pitch for the image. More...

QString	SpacecraftName ()
	Returns the spacecraft name. More...

QString	InstrumentId ()
	Returns the instrument ID. More...

QString	NaifFrameCode ()
	Returns the NAIF frame code. More...

QString	TargetName ()
	Returns the target name which is always the Moon. More...

iTime	LaunchDate ()
	Returns the launch date of the mission. More...

Private Member Functions
void	initialize (QString spacecraft, QString instrument)
	Sets variables based on the spacecraft name and instrument. More...

Private Attributes
int	p_imageWidth
	Image width. More...

int	p_imageHeight
	Image height. More...

int	p_imageBands
	Number of bands in the image. More...

int	p_reseauDimension
	Dimensions of the reseaus. More...

double	p_imagePixelPitch
	Pixel pitch. More...

QString	p_spacecraftName
	Spacecraft name. More...

QString	p_instrumentId
	Instrument ID. More...

QString	p_naifFrameCode
	NAIF frame code. More...

iTime	p_launchDate
	Mission launch date. More...

Detailed Description

Reads user Apollos from a data file.

This class is used to

Author: 2007-02-07 Jacob Danton

History:: 2007-02-07 Jacob Danton - Original version

History:: 2017-06-28 Makayla Shepherd - Updated documentation. References #4807.

Definition at line 29 of file Apollo.h.

Constructor & Destructor Documentation

◆ Apollo() [1/2]

Isis::Apollo::Apollo	(	QString	spacecraft,
		QString	instrument
	)

inline

Constructor.

Calls initialize() to set variables based on the QStrings passed in.

Parameters

spacecraft	The name of the spacecraft
instrument	The name of the instrument

See also: initialize(QString spacecraft, QString instrument)

Definition at line 40 of file Apollo.h.

References initialize().

◆ Apollo() [2/2]

Isis::Apollo::Apollo ( QString filename )

inline

Constructor.

Parses the filename passed in and sets the spacecraft name and instrument. Calls initialize() to set variables based on the spacecraft and instrument.

Parameters

filename The image filename that will be parsed to get the spacecraft and instrument

See also: initialize(QString spacecraft, QString instrument)

Definition at line 53 of file Apollo.h.

References initialize(), and Isis::IException::User.

◆ ~Apollo()

Isis::Apollo::~Apollo ( )

inline

Destroys the Apollo object.

Definition at line 78 of file Apollo.h.

Member Function Documentation

◆ Bands()

int Isis::Apollo::Bands ( )

inline

Returns number of bands in the image.

The number of bands is set in initialize() based on the instrument.

See also: initialize(QString spacecraft, QString instrument)

Returns: int Bands of the image.

Definition at line 158 of file Apollo.h.

References p_imageBands.

◆ Height()

int Isis::Apollo::Height ( )

inline

Returns the height of the image.

The image height is set in initialize() based on the instrument.

See also: initialize(QString spacecraft, QString instrument)

Returns: int Height of the image.

Definition at line 147 of file Apollo.h.

References p_imageHeight.

◆ initialize()

void Isis::Apollo::initialize	(	QString	spacecraft,
		QString	instrument
	)

inlineprivate

Sets variables based on the spacecraft name and instrument.

Parameters

spacecraft	Spacecraft name
instrument	Instrument ID

Exceptions

IException::Unknown	"Unknown instrument"
IException::Unknown	"Unknown spacecraft"

Returns: void

Definition at line 241 of file Apollo.h.

References IsMetric(), IsPanoramic(), p_imageBands, p_imageHeight, p_imagePixelPitch, p_imageWidth, p_instrumentId, p_launchDate, p_naifFrameCode, p_reseauDimension, p_spacecraftName, and Isis::IException::Unknown.

Referenced by Apollo().

◆ InstrumentId()

QString Isis::Apollo::InstrumentId ( )

inline

Returns the instrument ID.

Returns: QString Instrument ID.

Definition at line 196 of file Apollo.h.

References p_instrumentId.

◆ IsApollo15()

bool Isis::Apollo::IsApollo15 ( )

inline

Checks if the spacecraft is Apollo 15.

Returns: bool True if the spacecraft is Apollo 15

Definition at line 109 of file Apollo.h.

References p_spacecraftName.

◆ IsApollo16()

bool Isis::Apollo::IsApollo16 ( )

inline

Checks if the spacecraft is Apollo 16.

Returns: bool True if the spacecraft is Apollo 16

Definition at line 117 of file Apollo.h.

References p_spacecraftName.

◆ IsApollo17()

bool Isis::Apollo::IsApollo17 ( )

inline

Checks if the spacecraft is Apollo 17.

Returns: bool True if the spacecraft is Apollo 17

Definition at line 125 of file Apollo.h.

References p_spacecraftName.

◆ IsHasselblad()

bool Isis::Apollo::IsHasselblad ( )

inline

Checks if the instrument is an Apollo Hasselblad camera.

Returns: bool True if the instrument is Hasselblad

Definition at line 101 of file Apollo.h.

References p_instrumentId.

◆ IsMetric()

bool Isis::Apollo::IsMetric ( )

inline

Checks if the instrument is an Apollo Metric camera.

Returns: bool True if the instrument is Metric

Definition at line 85 of file Apollo.h.

References p_instrumentId.

Referenced by initialize().

◆ IsPanoramic()

bool Isis::Apollo::IsPanoramic ( )

inline

Checks if the instrument is an Apollo Panoramic camera.

Returns: bool True if the instrument is Panoramic

Definition at line 93 of file Apollo.h.

References p_instrumentId.

Referenced by initialize().

◆ LaunchDate()

iTime Isis::Apollo::LaunchDate ( )

inline

Returns the launch date of the mission.

The launch date is set in initialize() based on the spacecraft and instrument.

See also: initialize(QString spacecraft, QString instrument)

Returns: QString Launch date of mission

Definition at line 226 of file Apollo.h.

References p_launchDate.

◆ NaifFrameCode()

QString Isis::Apollo::NaifFrameCode ( )

inline

Returns the NAIF frame code.

The NAIF frame code is set in initialize() based on the spacecraft and instrument.

See also: initialize(QString spacecraft, QString instrument)

Returns: QString NAIF frame code of the image.

Definition at line 207 of file Apollo.h.

References p_naifFrameCode.

◆ PixelPitch()

double Isis::Apollo::PixelPitch ( )

inline

Returns pixel pitch for the image.

The pixel patch is set in initialize() based on the instrument.

See also: initialize(QString spacecraft, QString instrument)

Returns: double Pixel pitch of the image.

Definition at line 180 of file Apollo.h.

References p_imagePixelPitch.

◆ ReseauDimension()

int Isis::Apollo::ReseauDimension ( )

inline

Returns the reseau dimension of the image.

The reseau dimenstion is set in initialize() based on the instrument.

See also: initialize(QString spacecraft, QString instrument)

Returns: int Reseau dimension of the image.

Definition at line 169 of file Apollo.h.

References p_reseauDimension.

◆ SpacecraftName()

QString Isis::Apollo::SpacecraftName ( )

inline

Returns the spacecraft name.

Returns: QString Spacecraft name.

Definition at line 188 of file Apollo.h.

References p_spacecraftName.

◆ TargetName()

QString Isis::Apollo::TargetName ( )

inline

Returns the target name which is always the Moon.

Returns: QString Moon.

Definition at line 215 of file Apollo.h.

◆ Width()

int Isis::Apollo::Width ( )

inline

Returns the width of the image.

The image width is set in initialize() based on the instrument.

See also: initialize(QString spacecraft, QString instrument)

Returns: int Width of the image.

Definition at line 136 of file Apollo.h.

References p_imageWidth.

Member Data Documentation

◆ p_imageBands

int Isis::Apollo::p_imageBands

private

Number of bands in the image.

Definition at line 301 of file Apollo.h.

Referenced by Bands(), and initialize().

◆ p_imageHeight

int Isis::Apollo::p_imageHeight

private

Image height.

Definition at line 300 of file Apollo.h.

Referenced by Height(), and initialize().

◆ p_imagePixelPitch

double Isis::Apollo::p_imagePixelPitch

private

Pixel pitch.

Definition at line 303 of file Apollo.h.

Referenced by initialize(), and PixelPitch().

◆ p_imageWidth

int Isis::Apollo::p_imageWidth

private

Image width.

Definition at line 299 of file Apollo.h.

Referenced by initialize(), and Width().

◆ p_instrumentId

QString Isis::Apollo::p_instrumentId

private

Instrument ID.

Definition at line 305 of file Apollo.h.

Referenced by initialize(), InstrumentId(), IsHasselblad(), IsMetric(), and IsPanoramic().

◆ p_launchDate

iTime Isis::Apollo::p_launchDate

private

Mission launch date.

Definition at line 307 of file Apollo.h.

Referenced by initialize(), and LaunchDate().

◆ p_naifFrameCode

QString Isis::Apollo::p_naifFrameCode

private

NAIF frame code.

Definition at line 306 of file Apollo.h.

Referenced by initialize(), and NaifFrameCode().

◆ p_reseauDimension

int Isis::Apollo::p_reseauDimension

private

Dimensions of the reseaus.

Definition at line 302 of file Apollo.h.

Referenced by initialize(), and ReseauDimension().

◆ p_spacecraftName

QString Isis::Apollo::p_spacecraftName

private

Spacecraft name.

Definition at line 304 of file Apollo.h.

Referenced by initialize(), IsApollo15(), IsApollo16(), IsApollo17(), and SpacecraftName().

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

src/apollo/objs/Apollo/Apollo.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Apollo() [1/2]

◆ Apollo() [2/2]

◆ ~Apollo()

Member Function Documentation

◆ Bands()

◆ Height()

◆ initialize()

◆ InstrumentId()

◆ IsApollo15()

◆ IsApollo16()

◆ IsApollo17()

◆ IsHasselblad()

◆ IsMetric()

◆ IsPanoramic()

◆ LaunchDate()

◆ NaifFrameCode()

◆ PixelPitch()

◆ ReseauDimension()

◆ SpacecraftName()

◆ TargetName()

◆ Width()

Member Data Documentation

◆ p_imageBands

◆ p_imageHeight

◆ p_imagePixelPitch

◆ p_imageWidth

◆ p_instrumentId

◆ p_launchDate

◆ p_naifFrameCode

◆ p_reseauDimension

◆ p_spacecraftName