Provide image coordinates that map to the push frame detector. More...

#include <PushFrameCameraCcdLayout.h>

Collaboration diagram for Isis::PushFrameCameraCcdLayout:

Classes
struct	FrameletInfo
	Container for the layout of a specific framelet on the detector. More...

Public Member Functions
	PushFrameCameraCcdLayout ()
	Push frame full CCD layout class. More...

	PushFrameCameraCcdLayout (const int ccdId)
	Push frame full CCD layout class for specific Id. More...

virtual	~PushFrameCameraCcdLayout ()
	Destructor. More...

bool	addKernel (const QString &kernel)
	Add a NAIF kernel to the set of kernels that values will be pulled from. More...

int	ccdSamples () const
	Return the number of samples in the CCD. More...

int	ccdLines () const
	Return the number of lines in the CCD. More...

FrameletInfo	getFrameInfo (const int &frameId, const QString &name="") const
	Get the layout information for a framelet. More...

Private Member Functions
int	getSpiceInt (const QString &var, const int index=0) const
	Query the loaded kernels for an integer valued keyword. More...

double	getSpiceDouble (const QString &var, const int index=0) const
	Query the loaded kernels for a double valued keyword. More...

QString	getSpiceString (const QString &var, const int index=0) const
	Query the loaded kernels for a string valued keyword. More...

Private Attributes
int	m_ccdId
	NAIF ID of the CCD. More...

Kernels	m_kernels
	NAIF kernel manager. More...

Detailed Description

Provide image coordinates that map to the push frame detector.

See also: Camera

Author: 2017-08-11 Kris Becker

History:: 2017-08-11 Kris Becker - Original Version

History:: 2017-08-21 Jesse Mapel - Improved documentation.

Definition at line 28 of file PushFrameCameraCcdLayout.h.

Constructor & Destructor Documentation

◆ PushFrameCameraCcdLayout() [1/2]

Isis::PushFrameCameraCcdLayout::PushFrameCameraCcdLayout ( )

Push frame full CCD layout class.

Definition at line 24 of file PushFrameCameraCcdLayout.cpp.

References m_ccdId.

◆ PushFrameCameraCcdLayout() [2/2]

Isis::PushFrameCameraCcdLayout::PushFrameCameraCcdLayout ( const int ccdId )

Push frame full CCD layout class for specific Id.

Parameters

ccId	The NAIF ID of the CCD

Definition at line 34 of file PushFrameCameraCcdLayout.cpp.

References m_ccdId.

◆ ~PushFrameCameraCcdLayout()

Isis::PushFrameCameraCcdLayout::~PushFrameCameraCcdLayout ( )

virtual

Destructor.

Definition at line 42 of file PushFrameCameraCcdLayout.cpp.

Member Function Documentation

◆ addKernel()

bool Isis::PushFrameCameraCcdLayout::addKernel ( const QString & kernel )

Add a NAIF kernel to the set of kernels that values will be pulled from.

Parameters

kernel The path to the kernel file to load. The kernel name can contain a series of ?? characters to indicate version numbers. In this case the highest version numbered file will be added.

Returns: bool If the kernel was successfully loaded.

Definition at line 56 of file PushFrameCameraCcdLayout.cpp.

References Isis::Kernels::Add(), Isis::FileName::expanded(), Isis::FileName::highestVersion(), Isis::FileName::isVersioned(), Isis::Kernels::Load(), and m_kernels.

◆ ccdLines()

int Isis::PushFrameCameraCcdLayout::ccdLines ( ) const

Return the number of lines in the CCD.

Queries the NAIF keyword INS(CCD NAIF ID)_FILTER_LINES from the loaded kernels.

Returns: int The number of lines in the CCD.

Definition at line 85 of file PushFrameCameraCcdLayout.cpp.

References getSpiceInt(), m_ccdId, and Isis::toString().

◆ ccdSamples()

int Isis::PushFrameCameraCcdLayout::ccdSamples ( ) const

Return the number of samples in the CCD.

Queries the NAIF keyword INS(CCD NAIF ID)_FILTER_SAMPLES from the loaded kernels.

Returns: int The number of samples in the CCD.

Definition at line 73 of file PushFrameCameraCcdLayout.cpp.

References getSpiceInt(), m_ccdId, and Isis::toString().

◆ getFrameInfo()

PushFrameCameraCcdLayout::FrameletInfo Isis::PushFrameCameraCcdLayout::getFrameInfo	(	const int &	frameId,
		const QString &	name = `""`
	)		const

Get the layout information for a framelet.

Parameters

frameId	The NAIF ID of the framelet.
name	The name of the framelet. If empty, the loaded kernels will be queried for the name associated with the NAIF ID.

Returns: FrameletInfo The location and size of the framelet on the CCD.

Definition at line 100 of file PushFrameCameraCcdLayout.cpp.

References getSpiceInt(), getSpiceString(), Isis::IException::Io, Isis::PushFrameCameraCcdLayout::FrameletInfo::m_filterName, Isis::PushFrameCameraCcdLayout::FrameletInfo::m_lines, Isis::PushFrameCameraCcdLayout::FrameletInfo::m_samples, Isis::PushFrameCameraCcdLayout::FrameletInfo::m_startLine, Isis::PushFrameCameraCcdLayout::FrameletInfo::m_startSample, and Isis::toString().

◆ getSpiceDouble()

double Isis::PushFrameCameraCcdLayout::getSpiceDouble	(	const QString &	var,
		const int	index = `0`
	)		const

private

Query the loaded kernels for a double valued keyword.

Parameters

var	The keyword to find.
index	The index of the value to take from the keyword.

Returns: double The keyword value

See also: gdpool_c

Definition at line 170 of file PushFrameCameraCcdLayout.cpp.

References Isis::NaifStatus::CheckErrors(), and Isis::IException::Io.

◆ getSpiceInt()

int Isis::PushFrameCameraCcdLayout::getSpiceInt	(	const QString &	var,
		const int	index = `0`
	)		const

private

Query the loaded kernels for an integer valued keyword.

Parameters

var	The keyword to find.
index	The index of the value to take from the keyword.

Returns: int The keyword value

See also: gipool_c

Definition at line 141 of file PushFrameCameraCcdLayout.cpp.

References Isis::NaifStatus::CheckErrors(), and Isis::IException::Io.

Referenced by ccdLines(), ccdSamples(), and getFrameInfo().

◆ getSpiceString()

QString Isis::PushFrameCameraCcdLayout::getSpiceString	(	const QString &	var,
		const int	index = `0`
	)		const

private

Query the loaded kernels for a string valued keyword.

Parameters

var	The keyword to find.
index	The index of the value to take from the keyword.

Returns: QString The keyword value

See also: gcpool_c

Definition at line 199 of file PushFrameCameraCcdLayout.cpp.

References Isis::NaifStatus::CheckErrors(), and Isis::IException::Io.

Referenced by getFrameInfo().

Member Data Documentation

◆ m_ccdId

int Isis::PushFrameCameraCcdLayout::m_ccdId

private

NAIF ID of the CCD.

Definition at line 79 of file PushFrameCameraCcdLayout.h.

Referenced by ccdLines(), ccdSamples(), and PushFrameCameraCcdLayout().

◆ m_kernels

Kernels Isis::PushFrameCameraCcdLayout::m_kernels

private

NAIF kernel manager.

Definition at line 80 of file PushFrameCameraCcdLayout.h.

Referenced by addKernel().

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

src/base/objs/PushFrameCameraCcdLayout/PushFrameCameraCcdLayout.h
src/base/objs/PushFrameCameraCcdLayout/PushFrameCameraCcdLayout.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PushFrameCameraCcdLayout() [1/2]

◆ PushFrameCameraCcdLayout() [2/2]

◆ ~PushFrameCameraCcdLayout()

Member Function Documentation

◆ addKernel()

◆ ccdLines()

◆ ccdSamples()

◆ getFrameInfo()

◆ getSpiceDouble()

◆ getSpiceInt()

◆ getSpiceString()

Member Data Documentation

◆ m_ccdId

◆ m_kernels